Wrap all close() calls in "ensure" blocks and simplify DB connection-making.
[mailshears.git] / lib / common / agendav_plugin.rb
index cb445bed817d853c3b91c3e3c75c2735330614cc..49e7087d996ce2de850a01ec3c6d0a785b0ecd06 100644 (file)
@@ -1,73 +1,54 @@
 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.
-  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
-  end
 
-
-  def describe_domain(domain)
-    # AgenDAV doesn't have a concept of domains.
-    return domain
-  end
+  # We implement the Plugin "interface."
+  include Plugin
 
 
-  def describe_account(account)
-    if self.user_exists(account)
-      return "Username: #{account}"
-    else
-      return 'User not found'
-    end
+  # 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
 
 
-  protected;
-
-  def user_exists(account)
-    ad_users = list_users()
-    return ad_users.include?(account)
-  end
-
+  # Return a list of Agendav users.
+  #
+  # @return [Array<User>] a list of users contained in the
+  #   Agendav database.
+  #
   def list_users()
-    usernames = []
+    users = []
 
-    # Just assume PostgreSQL for now.
-    begin
-      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);'
+    sql_query  = '(SELECT username FROM prefs)'
+    sql_query += 'UNION'
+    sql_query += '(SELECT user_from FROM shared);'
 
+    begin
       connection.query(sql_query) do |result|
-        usernames = result.field_values('username')
+        users = result.field_values('username')
       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 users.map{ |u| User.new(u) }
   end
 
 end