require 'common/plugin'
+require 'common/user'
+# Code that all Roundcube plugins ({RoundcubePrune}, {RoundcubeRm},
+# {RoundcubeMv}) share.
+#
module RoundcubePlugin
- # Code that all Roundcube plugins (Prune, Rm, Mv...) will share.
- # That is, we implement the Plugin interface.
+
+ # We implement the Plugin "interface."
include Plugin
+
+ # Initialize this Roundcube {Plugin} with values in *cfg*.
+ #
+ # @param cfg [Configuration] the configuration for this plugin.
+ #
def initialize(cfg)
@db_host = cfg.roundcube_dbhost
@db_port = cfg.roundcube_dbport
end
- def describe_domain(domain)
- # Roundcube doesn't have a concept of domains.
- return domain
+ # Describe the given Roundcube *user*.
+ #
+ # @param user [User] the user whose description we want.
+ #
+ # @return [String] a string containing the Roundcube "User ID"
+ # associated with *user*.
+ #
+ def describe_user(user)
+ user_id = self.get_user_id(user)
+ return "User ID: #{user_id}"
end
- def describe_account(account)
- user_id = self.get_user_id(account)
- if user_id.nil?
- return 'User not found'
- else
- return "User ID: #{user_id}"
- end
- end
+ # Return a list of Roundcube users.
+ #
+ # @return [Array<User>] a list of users contained in the
+ # Roundcube database.
+ #
+ def list_users()
+ usernames = []
+ connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+ @db_name, @db_user, @db_pass)
- protected;
+ sql_query = 'SELECT username FROM users;'
+ connection.query(sql_query) do |result|
+ usernames = result.field_values('username')
+ end
- def get_user_id(account)
- user_id = nil
+ connection.close()
- begin
- connection = PGconn.connect(@db_host,
- @db_port,
- @db_opts,
- @db_tty,
- @db_name,
- @db_user,
- @db_pass)
-
- sql_query = "SELECT user_id FROM users WHERE username = $1;"
-
- connection.query(sql_query, [account]) do |result|
- if result.num_tuples > 0
- user_id = result[0]['user_id']
- end
- end
+ return usernames.map{ |u| User.new(u) }
+ end
- connection.close()
+ protected;
- rescue PGError => e
- # Pretend like we're database-agnostic in case we ever are.
- raise DatabaseError.new(e)
- end
- return user_id
- end
+ # Find the Roundcube "User ID" associated with the given *user*.
+ #
+ # @param user [User] the user whose Roundcube "User ID" we want.
+ #
+ # @return [Fixnum] the Roundcube "User ID" for *user*.
+ #
+ def get_user_id(user)
+ user_id = nil
+ connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+ @db_name, @db_user, @db_pass)
- # Used in both prune/rm.
- def list_users()
- usernames = []
+ sql_query = 'SELECT user_id FROM users WHERE username = $1;'
- # 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 users;"
- connection.query(sql_query) do |result|
- usernames = result.field_values('username')
+ connection.query(sql_query, [user.to_s()]) do |result|
+ if result.num_tuples > 0
+ user_id = result[0]['user_id']
end
-
- connection.close()
- rescue PGError => e
- # Pretend like we're database-agnostic in case we ever are.
- raise DatabaseError.new(e)
end
- return usernames
+ connection.close()
+
+ return user_id
end
+
end