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
+ # Initialize this Agendav {Plugin} with values in *cfg*.
+ #
+ # @param cfg [Configuration] the configuration for this plugin.
+ #
def initialize(cfg)
- @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
+ @db_hash = {
+ :host => cfg.agendav_dbhost,
+ :port => cfg.agendav_dbport,
+ :options => cfg.agendav_dbopts,
+ :dbname => cfg.agendav_dbname,
+ :user => cfg.agendav_dbuser,
+ :password => cfg.agendav_dbpass }
end
+ # Return a list of Agendav users.
+ #
+ # @return [Array<User>] a list of users contained in the
+ # Agendav database.
+ #
def list_users()
- #
- # Produce a list of AgenDAV users. This is public because it's
- # useful in testing.
- #
users = []
- connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
- @db_name, @db_user, @db_pass)
+ connection = PG::Connection.new(@db_hash)
- sql_query = '(SELECT username FROM prefs)'
- sql_query += 'UNION'
- sql_query += '(SELECT user_from FROM shared);'
+ # 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;'
- connection.query(sql_query) do |result|
- users = result.field_values('username')
+ 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
- connection.close()
-
return users.map{ |u| User.new(u) }
end
+
+ # 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)
+
+ 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()
+ end
+
+ return count
+ end
+
end