Wrap all close() calls in "ensure" blocks and simplify DB connection-making.
[mailshears.git] / lib / mv / plugins / postfixadmin.rb
index 338be052f63affe1bb8deab2041cd994994cfbb6..f8f86c6ba45236b570e16f9b5c15fa2647aa77b1 100644 (file)
@@ -3,22 +3,34 @@ require 'pg'
 require 'common/postfixadmin_plugin'
 require 'mv/mv_plugin'
 
+
+# Handle moving (renaming) of users in the Postfixadmin database.
+#
 class PostfixadminMv
 
   include PostfixadminPlugin
   include MvPlugin
 
+
+  # Move the user *src* to *dst* within the Postfixadmin
+  # database. This should "rename" him in _every_ table where he is
+  # referenced. Unfortunately that must be done manually.
+  #
+  # This can fail is *src* does not exist, or if *dst* already exists
+  # before the move. It will also fail if the domain associated with
+  # the user *dst* does not exist.
+  #
+  # @param src [User] the source user to be moved.
+  #
+  # @param dst [User] the destination user being moved to.
+  #
   def mv_user(src, dst)
-    # It's obviously an error if the source user does not exist.
     raise NonexistentUserError.new(src.to_s()) if not user_exists(src)
 
-    # And if the destination domain does not exist.
     if not domain_exists(dst.domain())
       raise NonexistentDomainError.new(dst.domain.to_s())
     end
 
-    # But the destination *user* should *not* exist.
-    # And it's an error if the destination user exists already.
     raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
     mailbox_query  = 'UPDATE mailbox SET '
@@ -39,31 +51,20 @@ class PostfixadminMv
 
     sql_queries = [mailbox_query, alias_query1, alias_query2]
 
+    connection = PG::Connection.new(@db_hash)
     begin
-      connection = PGconn.connect(@db_host,
-                                  @db_port,
-                                  @db_opts,
-                                  @db_tty,
-                                  @db_name,
-                                  @db_user,
-                                  @db_pass)
-
       sql_queries.each do |sql_query|
-          varchar = 1043 # from pg_type.h
-          params = [{:value => dst.to_s(), :type => varchar},
-                    {:value => dst.domainpart(), :type => varchar},
-                    {:value => dst.localpart(), :type => varchar},
-                    {:value => src.to_s(), :type => varchar}]
+        varchar = 1043 # from pg_type.h
+        params = [{:value => dst.to_s(), :type => varchar},
+                  {:value => dst.domainpart(), :type => varchar},
+                  {:value => dst.localpart(), :type => varchar},
+                  {:value => src.to_s(), :type => varchar}]
         connection.query(sql_query, params)
       end
-
+    ensure
+      # Make sure the connection gets closed even if a query explodes.
       connection.close()
-
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
     end
   end
 
-
 end