Document everything with YARD and fix some bugs along the way.

[mailshears.git] / lib / mv / plugins / roundcube.rb

diff --git a/lib/mv/plugins/roundcube.rb b/lib/mv/plugins/roundcube.rb
index 4b3ebcb5d20084d8c342445d2b5566a98324d6d5..4d8196461ca570a8e51a5aa0880365dda8d950f5 100644 (file)
--- a/lib/mv/plugins/roundcube.rb
+++ b/lib/mv/plugins/roundcube.rb
@@ -3,43 +3,43 @@ require 'pg'
 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
 
 
+  # 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)
-    # 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)
-
-    # And it's an error if the destination user exists already.
     raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
     sql_queries = ['UPDATE users SET username = $1 WHERE username = $2;']
 
-    begin
-      connection = PGconn.connect(@db_host,
-                                  @db_port,
-                                  @db_opts,
-                                  @db_tty,
-                                  @db_name,
-                                  @db_user,
-                                  @db_pass)
-
-      sql_queries.each do |sql_query|
-        connection.query(sql_query, [dst.to_s(), src.to_s()])
-      end
-
-      connection.close()
+    connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+                                @db_name, @db_user, @db_pass)
 
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
+    sql_queries.each do |sql_query|
+      connection.query(sql_query, [dst.to_s(), src.to_s()])
     end
 
+    connection.close()
   end
 
 end