Wrap all close() calls in "ensure" blocks and simplify DB connection-making.

[mailshears.git] / lib / common / agendav_plugin.rb

diff --git a/lib/common/agendav_plugin.rb b/lib/common/agendav_plugin.rb
index 9af7b01519b40aca2870176948ed4f0ac6f950cb..49e7087d996ce2de850a01ec3c6d0a785b0ecd06 100644 (file)
--- a/lib/common/agendav_plugin.rb
+++ b/lib/common/agendav_plugin.rb
@@ -1,43 +1,53 @@
 require 'common/plugin'
 require 'common/user'
 
 require 'common/plugin'
 require 'common/user'
 

+# Code that all Agendav plugins ({AgendavPrune}, {AgendavRm},
+# {AgendavMv}) share.

 module AgendavPlugin
 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
 
 
   include Plugin
 
 

+  # Initialize this Agendav {Plugin} with values in *cfg*.
+  #
+  # @param cfg [Configuration] the configuration for this plugin.
+  #

   def initialize(cfg)
   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,
+      :tty      => cfg.agendav_dbtty,
+      :dbname   => cfg.agendav_dbname,
+      :user     => cfg.agendav_dbuser,
+      :password => cfg.agendav_dbpass }

   end
 
 
   end
 
 

+  # Return a list of Agendav users.
+  #
+  # @return [Array<User>] a list of users contained in the
+  #   Agendav database.
+  #

   def list_users()
   def list_users()

-    #
-    # Produce a list of AgenDAV users. This is public because it's
-    # useful in testing.
-    #

     users = []
 
     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);'
 
 
     sql_query  = '(SELECT username FROM prefs)'
     sql_query += 'UNION'
     sql_query += '(SELECT user_from FROM shared);'
 

-    connection.query(sql_query) do |result|
-      users = result.field_values('username')
+    begin
+      connection.query(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
 
     end
 

-    connection.close()
-

     return users.map{ |u| User.new(u) }
   end
 
     return users.map{ |u| User.new(u) }
   end