X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=lib%2Fcommon%2Froundcube_plugin.rb;h=031e3f9ddd725e6b2bc427a323e567c1291300e3;hp=b1c74a6d7494420ea9908389317c9d03e39d64f9;hb=df4e02ebf6a4e28a58abcb298a4442a245ad0b15;hpb=f819b178c5c1cb8adda0182c610e5c52fad8bea7

diff --git a/lib/common/roundcube_plugin.rb b/lib/common/roundcube_plugin.rb
index b1c74a6..031e3f9 100644
--- a/lib/common/roundcube_plugin.rb
+++ b/lib/common/roundcube_plugin.rb
@@ -1,11 +1,19 @@
 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
@@ -17,80 +25,65 @@ module RoundcubePlugin
   end
 
 
-  def describe_domain(domain)
-    # Roundcube doesn't have a concept of domains.
-    return domain.to_s()
-  end
-
+  # 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)
-
-    if user_id.nil?
-      return 'User not found'
-    else
-      return "User ID: #{user_id}"
-    end
+    return "User ID: #{user_id}"
   end
 
 
+  # Return a list of Roundcube users.
+  #
+  # @return [Array<User>] a list of users contained in the
+  #   Roundcube database.
+  #
   def list_users()
-    # Produce a list of Roundcube users. This is used in prune/rm, and
-    # is public because it is useful in testing.
     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 users;"
-      connection.query(sql_query) do |result|
-        usernames = result.field_values('username')
-      end
+    connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+                                @db_name, @db_user, @db_pass)
 
-      connection.close()
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
+    sql_query = 'SELECT username FROM users;'
+    connection.query(sql_query) do |result|
+      usernames = result.field_values('username')
     end
 
+    connection.close()
+
     return usernames.map{ |u| User.new(u) }
   end
 
   protected;
 
+
+  # 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
 
-    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, [user.to_s()]) do |result|
-        if result.num_tuples > 0
-          user_id = result[0]['user_id']
-        end
-      end
+    connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+                                @db_name, @db_user, @db_pass)
 
-      connection.close()
+    sql_query = 'SELECT user_id FROM users WHERE username = $1;'
 
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
+    connection.query(sql_query, [user.to_s()]) do |result|
+      if result.num_tuples > 0
+        user_id = result[0]['user_id']
+      end
     end
 
+    connection.close()
+
     return user_id
   end