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

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

diff --git a/lib/mv/plugins/agendav.rb b/lib/mv/plugins/agendav.rb
index 15bf3de2ae65a96199a72dc5306c99948e4cf9c6..80ab1b6013c4096395ff0ec33a96a02dc023ddb0 100644 (file)
--- a/lib/mv/plugins/agendav.rb
+++ b/lib/mv/plugins/agendav.rb
@@ -1,106 +1,45 @@
 require 'pg'
 
-require 'common/plugin'
+require 'common/agendav_plugin'
 require 'mv/mv_plugin'
 
+
+# Handle moving (renaming) Agendav users in its database. Agendav has
+# no concept of domains.
+#
 class AgendavMv
 
-  include Plugin
+  include AgendavPlugin
   include MvPlugin
 
-  def initialize()
-    cfg = Configuration.new()
-    @db_host = cfg.agendav_dbhost
-    @db_port = cfg.agendav_dbport
-    @db_opts = cfg.agendav_dbopts
-    @db_tty  = cfg.agendav_dbtty
-    @db_name = cfg.agendav_dbname
-    @db_user = cfg.agendav_dbuser
-    @db_pass = cfg.agendav_dbpass
-  end
-
-
-  def describe_domain(domain)
-    # AgenDAV doesn't have a concept of domains.
-    return 'N/A'
-  end
-
-  def describe_account(account)
-    if self.user_exists(account)
-      return "Username: #{account}"
-    else
-      return 'User not found'
-    end
-  end
-
-  def mv_domain(from, to)
-    # AgenDAV doesn't have a concept of domains.
-  end
-
-  def mv_account(from, to)
-    sql_queries = ['UPDATE prefs SET username = $1 WHERE username $2;']
+  # Move the user *src* to *dst* within the Agendav database. This
+  # should "rename" him in _every_ table where he is referenced.
+  #
+  # 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 Agendav 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)
+
+    sql_queries = ['UPDATE prefs SET username = $1 WHERE username = $2;']
     sql_queries << 'UPDATE shared SET user_from = $1 WHERE user_from = $2;'
     sql_queries << 'UPDATE shared SET user_which = $1 WHERE user_which = $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;
-
-  def user_exists(account)
-    ad_users = get_agendav_usernames()
-    return ad_users.include?(account)
-  end
-
-  def get_agendav_usernames()
-    usernames = []
-
-    # Just assume PostgreSQL for now.
-    begin
-      connection = PGconn.connect(@db_host,
-                                  @db_port,
-                                  @db_opts,
-                                  @db_tty,
-                                  @db_name,
-                                  @db_user,
-                                  @db_pass)
-
-      sql_query  = '(SELECT username FROM prefs)'
-      sql_query += 'UNION'
-      sql_query += '(SELECT user_from FROM shared);'
-
-      connection.query(sql_query) do |result|
-        usernames = result.field_values('username')
-      end
+    connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+                                @db_name, @db_user, @db_pass)
 
-      connection.close()
-    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
 
-    return usernames
+    connection.close()
   end
 
 end