lib,test: replace connection query() method with sync_exec{,_params}.
[mailshears.git] / lib / rm / plugins / agendav.rb
index 7a594425816bcb894778cd42434fe7be5041db23..2c7709011ca3a421ced83d7d58e2f1aa3c6c2faf 100644 (file)
 require 'pg'
 
-require 'common/plugin'
+require 'common/agendav_plugin'
 require 'rm/rm_plugin'
 
-class AgendavDb
 
-  include Plugin
-  include RmPlugin
-
-  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
+# Handle the removal of Agendav users from its database. Agendav has
+# no concept of domains.
+#
+class AgendavRm
 
-  def delete_domain(domain)
-    # AgenDAV doesn't have a concept of domains.
-  end
+  include AgendavPlugin
+  include RmPlugin
 
-  def delete_account(account)
-    # Delete the given username and any records in other tables
-    # belonging to it.
 
+  # Remove *user* from the Agendav database. This should remove him
+  # from _every_ table in which he is referenced.
+  #
+  # We do not raise an error if the user doesn't exist. This is due to
+  # an unfortunate problem with the "user exists" check in AgenDAV.
+  # The AgenDAV "shares" table is not tied directly to a username, so
+  # we are forced to use a regexp match to decide what rows to delete
+  # from that table. We do so regardless of whether or not the username
+  # exists in the "prefs" table, because that table stores only non-
+  # default preferences -- not all users' preferences.
+  #
+  # @param user [User] the user to remove.
+  #
+  def remove_user(user)
     sql_queries = ['DELETE FROM prefs WHERE username = $1;']
-    sql_queries << 'DELETE FROM shared WHERE user_from = $1;'
 
+    # The "shares" table contains principal URLs, and the "@" symbol
+    # is usually encoded to "%40". These queries do a regex match on
+    # the username after replacing the "%40" with a "@".
+    #
+    # As a precaution, I haven chosen not to delete based on the
+    # "calendar" field here. Nobody should have a calendar named
+    # "user%40example.com", but it's not impossible -- and we don't
+    # want to delete that calendar when the not-necessarily-related
+    # "user@example.com" account is removed. And the usual appearance
+    # of the user's email address in the "calendar" field happens when
+    # he is also the owner, so the calendar does get deleted in the
+    # normal situation.
+    sql_queries << "DELETE FROM shares WHERE REPLACE(owner,'%40','@')    ~ $1;"
+    sql_queries << "DELETE FROM shares WHERE REPLACE(\"with\",'%40','@') ~ $1;"
+
+    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_queries.each do |sql_query|
-        connection.query(sql_query, [account])
-      end
-
-      connection.close()
-
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
-    end
-
-  end
-
-
-  def get_leftover_domains(db_domains)
-    # AgenDAV doesn't have a concept of domains.
-    return []
-  end
-
-
-  def get_leftover_accounts(db_accounts)
-    # Get a list of all users who have logged in to AgenDAV.
-    ad_accounts = self.get_agendav_usernames()
-    return ad_accounts - db_accounts
-  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')
+        connection.sync_exec_params(sql_query, [user.to_s()])
       end
-
+    ensure
+      # Make sure the connection gets closed even if a query explodes.
       connection.close()
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
     end
-
-    return usernames
   end
 
 end