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;']
-
- 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 = PG::Connection.new(@db_hash)
+ begin
connection.query(sql_query, [dst.to_s(), src.to_s()])
+ ensure
+ # Make sure the connection gets closed even if the query explodes.
+ connection.close()
end
-
- connection.close()
end
end