lib,test: replace connection query() method with sync_exec{,_params}.
[mailshears.git] / lib / mv / plugins / davical.rb
index 860abdc3765a2e0b47dd08c244ca0a8b3fa1f38a..1a8a18aa70e8d27cef54ad867a230890587e6932 100644 (file)
 require 'pg'
 
-require 'common/plugin'
+require 'common/davical_plugin'
 require 'rm/rm_plugin'
 
+# Handle moving (renaming) DAViCal users in its database. DAViCal has
+# no concept of domains.
+#
 class DavicalMv
-  #
-  # DAViCal only supports Postgres, so even if we ever are
-  # database-agnostic, this plugin can't be.
-  #
-  include Plugin
+  include DavicalPlugin
   include MvPlugin
 
-  def initialize()
-    cfg = Configuration.new()
-    @db_host = cfg.davical_dbhost
-    @db_port = cfg.davical_dbport
-    @db_opts = cfg.davical_dbopts
-    @db_tty  = cfg.davical_dbtty
-    @db_name = cfg.davical_dbname
-    @db_user = cfg.davical_dbuser
-    @db_pass = cfg.davical_dbpass
-  end
-
-
-  def describe_domain(domain)
-    # DAViCal doesn't have a concept of domains.
-    return 'N/A'
-  end
-
-
-  def describe_account(account)
-    principal_id = self.get_principal_id(account)
-
-    if principal_id.nil?
-      return 'User not found'
-    else
-      return "Principal ID: #{principal_id}"
-    end
-  end
-
-
-  def mv_domain(from, to)
-    # DAViCal doesn't have a concept of domains.
-  end
-
-
-  def mv_account(from, to)
-    # Delete the given username. DAViCal uses foreign keys properly
-    # and only supports postgres, so we let the ON UPDATE CASCADE
-    # trigger handle most of the work.
-    sql_queries = ['UPDATE usr 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, [to, from])
-      end
-
-      connection.close()
-
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
-    end
-
-  end
-
-
-  protected;
+  # Move the user *src* to *dst* within the DAViCal database. This
+  # should "rename" him in _every_ table where he is referenced.
+  # DAViCal 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 DAViCal 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)
+    raise NonexistentUserError.new(src.to_s()) if not user_exists(src)
+    raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
-  def get_principal_id(account)
-    principal_id = nil
+    sql_query = 'UPDATE usr SET username = $1 WHERE username = $2;'
 
+    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_query =  "SELECT principal.principal_id "
-      sql_query += "FROM (principal INNER JOIN usr "
-      sql_query += "      ON principal.user_no = usr.user_no) "
-      sql_query += "WHERE usr.username = $1;"
-
-      connection.query(sql_query, [account]) do |result|
-        if result.num_tuples > 0
-          principal_id = result[0]['principal_id']
-        end
-      end
-
+      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()
-
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
     end
-
-    return principal_id
   end
 
 end