X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=lib%2Fcommon%2Fagendav_plugin.rb;h=3b3389dcd074ea4c8b3e666ebf0874b5ec7dfc99;hp=fad869f95235964884d58635a465d670cde7b455;hb=refs%2Ftags%2F0.0.4;hpb=e3826d8926e11763837a591986d453e9ef5d9dec diff --git a/lib/common/agendav_plugin.rb b/lib/common/agendav_plugin.rb index fad869f..3b3389d 100644 --- a/lib/common/agendav_plugin.rb +++ b/lib/common/agendav_plugin.rb @@ -1,73 +1,79 @@ require 'common/plugin' +require 'common/user' +# Code that all Agendav plugins ({AgendavPrune}, {AgendavRm}, +# {AgendavMv}) share. module AgendavPlugin - # Code that all Agendav plugins (Prune, Rm, Mv...) will - # share. That is, we implement the Plugin interface. + + # We implement the Plugin "interface." include Plugin - def initialize() - cfg = Configuration.new() - @db_host = cfg.agendav_dbhost - @db_port = cfg.agendav_dbport - @db_opts = cfg.agendav_dbopts - @db_tty = cfg.agendav_dbtty - @db_name = cfg.agendav_dbname - @db_user = cfg.agendav_dbuser - @db_pass = cfg.agendav_dbpass + # Initialize this Agendav {Plugin} with values in *cfg*. + # + # @param cfg [Configuration] the configuration for this plugin. + # + def initialize(cfg) + @db_hash = { + :host => cfg.agendav_dbhost, + :port => cfg.agendav_dbport, + :options => cfg.agendav_dbopts, + :tty => cfg.agendav_dbtty, + :dbname => cfg.agendav_dbname, + :user => cfg.agendav_dbuser, + :password => cfg.agendav_dbpass } end - def describe_domain(domain) - # AgenDAV doesn't have a concept of domains. - return 'N/A' - end + # Return a list of Agendav users. + # + # @return [Array] a list of users contained in the + # Agendav database. + # + def list_users() + users = [] + connection = PG::Connection.new(@db_hash) - def describe_account(account) - if self.user_exists(account) - return "Username: #{account}" - else - return 'User not found' - end - end + # There are also "owner" and "with" fields in the "shares" table, + # but they contains principal URLs and not a bare username. Thus + # their format depends on the CalDAV server configuration, and + # isn't predictable. + sql_query = 'SELECT username FROM prefs;' + begin + connection.sync_exec(sql_query) do |result| + users = result.field_values('username') + end + ensure + # Make sure the connection gets closed even if the query explodes. + connection.close() + end - protected; - - def user_exists(account) - ad_users = get_agendav_usernames() - return ad_users.include?(account) + return users.map{ |u| User.new(u) } end - def get_agendav_usernames() - usernames = [] - - # Just assume PostgreSQL for now. - begin - connection = PGconn.connect(@db_host, - @db_port, - @db_opts, - @db_tty, - @db_name, - @db_user, - @db_pass) - sql_query = '(SELECT username FROM prefs)' - sql_query += 'UNION' - sql_query += '(SELECT user_from FROM shared);' + # Count the number of rows in the "shares" table. Used only for + # testing. + # + # @return [Fixnum] the number of rows in the "shares" table. + # + def count_shares() + count = nil + connection = PG::Connection.new(@db_hash) - connection.query(sql_query) do |result| - usernames = result.field_values('username') + sql_query = 'SELECT count(*) FROM shares;' + begin + connection.sync_exec(sql_query) do |result| + count = result.getvalue(0,0).to_i() end - + ensure + # Make sure the connection gets closed even if the query explodes. connection.close() - rescue PGError => e - # Pretend like we're database-agnostic in case we ever are. - raise DatabaseError.new(e) end - return usernames + return count end end