require 'common/plugin'
+require 'common/user'
+# Code that all DAViCal plugins ({DavicalPrune}, {DavicalRm}, and
+# {DavicalMv}) will share.
+#
module DavicalPlugin
- # Code that all Davical plugins (Prune, Rm, Mv...) will share. That
- # is, we implement the Plugin interface.
+
+ # We implement the Plugin "interface."
include Plugin
+ # Initialize this DAViCal {Plugin} with values in *cfg*.
+ #
+ # @param cfg [Configuration] the configuration for this plugin.
+ #
def initialize(cfg)
- @db_host = cfg.davical_dbhost
- @db_port = cfg.davical_dbport
- @db_opts = cfg.davical_dbopts
- @db_tty = cfg.davical_dbtty
- @db_name = cfg.davical_dbname
- @db_user = cfg.davical_dbuser
- @db_pass = cfg.davical_dbpass
+ @db_hash = {
+ :host => cfg.davical_dbhost,
+ :port => cfg.davical_dbport,
+ :options => cfg.davical_dbopts,
+ :dbname => cfg.davical_dbname,
+ :user => cfg.davical_dbuser,
+ :password => cfg.davical_dbpass }
end
- def describe_domain(domain)
- # DAViCal doesn't have a concept of domains.
- return domain
+ # Describe the given DAViCal user who is assumed to exist.
+ #
+ # @param user [User] the {User} object whose description we want.
+ #
+ # @return [String] a String describing the given *user* in terms
+ # of his DAViCal "Principal ID".
+ #
+ def describe_user(user)
+ principal_id = self.get_principal_id(user)
+ return "Principal ID: #{principal_id}"
end
- def describe_account(account)
- principal_id = self.get_principal_id(account)
+ #
+ # Produce a list of DAViCal users.
+ #
+ # This method remains public for use in testing.
+ #
+ # @return [Array<User>] an array of {User} objects, one for each
+ # user found in the DAViCal database.
+ #
+ def list_users()
+ usernames = []
+
+ connection = PG::Connection.new(@db_hash)
- if principal_id.nil?
- return 'User not found'
- else
- return "Principal ID: #{principal_id}"
+ # User #1 is the super-user, and not tied to an email address.
+ sql_query = 'SELECT username FROM usr WHERE user_no > 1;'
+
+ begin
+ connection.sync_exec(sql_query) do |result|
+ usernames = result.field_values('username')
+ end
+ ensure
+ # Make sure the connection gets closed even if the query explodes.
+ connection.close()
end
+
+ return usernames.map{ |u| User.new(u) }
end
protected;
- def get_principal_id(account)
+
+ # Find the "Principal ID" of the given user.
+ #
+ # @param user [User] the user whose Principal ID we want.
+ #
+ # @return [Fixnum] an integer representing the user's Principal ID
+ # that we obtained from the DAViCal database.
+ #
+ def get_principal_id(user)
principal_id = nil
+ connection = PG::Connection.new(@db_hash)
+
+ sql_query = 'SELECT principal.principal_id '
+ sql_query += 'FROM (principal INNER JOIN usr '
+ sql_query += ' ON principal.user_no = usr.user_no) '
+ sql_query += 'WHERE usr.username = $1;'
+
begin
- connection = PGconn.connect(@db_host,
- @db_port,
- @db_opts,
- @db_tty,
- @db_name,
- @db_user,
- @db_pass)
-
- sql_query = "SELECT principal.principal_id "
- sql_query += "FROM (principal INNER JOIN usr "
- sql_query += " ON principal.user_no = usr.user_no) "
- sql_query += "WHERE usr.username = $1;"
-
- connection.query(sql_query, [account]) do |result|
+ connection.sync_exec_params(sql_query, [user.to_s()]) do |result|
if result.num_tuples > 0
principal_id = result[0]['principal_id']
end
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 principal_id
end
-
- def list_users()
- usernames = []
-
- begin
- connection = PGconn.connect(@db_host,
- @db_port,
- @db_opts,
- @db_tty,
- @db_name,
- @db_user,
- @db_pass)
-
- # User #1 is the super-user, and not tied to an email address.
- sql_query = "SELECT username FROM usr WHERE user_no > 1"
-
- connection.query(sql_query) do |result|
- usernames = result.field_values('username')
- end
-
- connection.close()
- rescue PGError => e
- # Pretend like we're database-agnostic in case we ever are.
- raise DatabaseError.new(e)
- end
-
- return usernames
- end
-
end