Begin building the framework to rename accounts. A pile of crap right now.

[mailshears.git] / lib / rm / plugins / roundcube_db.rb

diff --git a/lib/rm/plugins/roundcube_db.rb b/lib/rm/plugins/roundcube_db.rb
new file mode 100644 (file)
index 0000000..e8165d1
--- /dev/null
+++ b/lib/rm/plugins/roundcube_db.rb
@@ -0,0 +1,155 @@
+require 'pg'
+
+require 'common/plugin'
+require 'rm/rm_plugin'
+
+class RoundcubeDb
+
+  include Plugin
+  include RmPlugin
+
+  def initialize()
+    cfg = Configuration.new()
+    @db_host = cfg.roundcube_dbhost
+    @db_port = cfg.roundcube_dbport
+    @db_opts = cfg.roundcube_dbopts
+    @db_tty  = cfg.roundcube_dbtty
+    @db_name = cfg.roundcube_dbname
+    @db_user = cfg.roundcube_dbuser
+    @db_pass = cfg.roundcube_dbpass
+  end
+
+
+  def describe_domain(domain)
+    # Roundcube doesn't have a concept of domains.
+    return 'N/A'
+  end
+
+  def describe_account(account)
+    user_id = self.get_user_id(account)
+
+    if user_id.nil?
+      return 'User not found'
+    else
+      return "User ID: #{user_id}"
+    end
+  end
+
+  def delete_domain(domain)
+    # Roundcube doesn't have a concept of domains.
+  end
+
+  def delete_account(account)
+    # Delete the given username and any records in other tables
+    # belonging to it.
+    user_id = self.get_user_id(account)
+
+    # The Roundcube developers were nice enough to include
+    # DBMS-specific install and upgrade scripts, so Postgres can take
+    # advantage of ON DELETE triggers. Here's an example:
+    #
+    #  ...
+    #  user_id integer NOT NULL
+    #    REFERENCES users (user_id) ON DELETE CASCADE ON UPDATE CASCADE
+    #
+    # This query is of course necessary with any DBMS:
+    sql_queries = ['DELETE FROM users WHERE user_id = $1::int;']
+
+    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, [user_id])
+      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)
+    # Roundcube 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 Roundcube.
+    rc_accounts = self.get_roundcube_usernames()
+    return rc_accounts - db_accounts
+  end
+
+
+  protected;
+
+  def get_user_id(account)
+    user_id = nil
+
+    begin
+      connection = PGconn.connect(@db_host,
+                                  @db_port,
+                                  @db_opts,
+                                  @db_tty,
+                                  @db_name,
+                                  @db_user,
+                                  @db_pass)
+
+      sql_query = "SELECT user_id FROM users WHERE username = $1;"
+
+      connection.query(sql_query, [account]) do |result|
+        if result.num_tuples > 0
+          user_id = result[0]['user_id']
+        end
+      end
+
+      connection.close()
+
+    rescue PGError => e
+      # Pretend like we're database-agnostic in case we ever are.
+      raise DatabaseError.new(e)
+    end
+
+    return user_id
+  end
+
+
+
+  def get_roundcube_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 users;"
+      connection.query(sql_query) do |result|
+        usernames = result.field_values('username')
+      end
+
+      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