lib,test: replace connection query() method with sync_exec{,_params}.
[mailshears.git] / lib / mv / plugins / roundcube.rb
index 7f345a4a70bb73094d02110ce8f6ff05d6a315e5..e2126f75f244bd5288647ec41ff7610917b90b42 100644 (file)
@@ -3,31 +3,42 @@ require 'pg'
 require 'common/roundcube_plugin'
 require 'mv/mv_plugin'
 
 require 'common/roundcube_plugin'
 require 'mv/mv_plugin'
 
+# Handle moving (renaming) of users in the Roundcube
+# database. Roundcube has no concept of domains.
+#
 class RoundcubeMv
 
   include RoundcubePlugin
   include MvPlugin
 
 
 class RoundcubeMv
 
   include RoundcubePlugin
   include MvPlugin
 
 
+  # Move the user *src* to *dst* within the Roundcube database. This
+  # should "rename" him in _every_ table where he is referenced.
+  # Roundcube uses foreign keys properly, so we let the ON UPDATE
+  # CASCADE trigger handle most of the work.
+  #
+  # This can fail is *src* does not exist, or if *dst* already exists
+  # before the move. It should also be an error if the destination
+  # domain doesn't exist. But Roundcube doesn't know about domains, so
+  # we let that slide.
+  #
+  # @param src [User] the source user to be moved.
+  #
+  # @param dst [User] the destination user being moved to.
+  #
   def mv_user(src, dst)
   def mv_user(src, dst)
-    # It's obviously an error if the source user does not exist. It
-    # would also be an error if the destination domain didn't exist;
-    # however, Roundcube doesn't know about domains, so we let that slide.
     raise NonexistentUserError.new(src.to_s()) if not user_exists(src)
     raise NonexistentUserError.new(src.to_s()) if not user_exists(src)
-
-    # And it's an error if the destination user exists already.
     raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
     raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
-    sql_queries = ['UPDATE users SET username = $1 WHERE username = $2;']
-
-    connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
-                                @db_name, @db_user, @db_pass)
+    sql_query = 'UPDATE users SET username = $1 WHERE username = $2;'
 
 
-    sql_queries.each do |sql_query|
-      connection.query(sql_query, [dst.to_s(), src.to_s()])
+    connection = PG::Connection.new(@db_hash)
+    begin
+      connection.sync_exec_params(sql_query, [dst.to_s(), src.to_s()])
+    ensure
+      # Make sure the connection gets closed even if the query explodes.
+      connection.close()
     end
     end
-
-    connection.close()
   end
 
 end
   end
 
 end