Convert DovecotMailstore to a plugin, and generalize the main mailshears script to...

[mailshears.git] / bin / mailshears

diff --git a/bin/mailshears b/bin/mailshears
index d12bbbd6fc27ee7e2b2503f70b56349f6f3ab691..6e84751161ae0566387a8a5e34b0f4876fdb9bfb 100755 (executable)
--- a/bin/mailshears
+++ b/bin/mailshears
@@ -15,7 +15,7 @@
 
 # We need Pathname to get the real filesystem path
 # of this script (and not, for example, the path of
-# a symlink which points to it.
+# a symlink which points to it).
 require 'pathname'
 
 # This bit of magic adds the parent directory (the
@@ -25,6 +25,9 @@ require 'pathname'
 executable = Pathname.new(__FILE__).realpath.to_s
 $: << File.dirname(executable) + '/../'
 
+# Needed for rm_rf.
+require 'fileutils'
+
 # Load our config file.
 require 'bin/configuration'
 
@@ -34,8 +37,6 @@ require 'src/exit_codes.rb'
 require 'src/dovecot_mailstore'
 require 'src/postfixadmin_db'
 
-dms = DovecotMailstore.new(Configuration::MAIL_ROOT)
-
 pgadb = PostfixadminDb.new(Configuration::DBHOST,
                            Configuration::DBPORT,
                            Configuration::DBOPTS,
@@ -45,71 +46,81 @@ pgadb = PostfixadminDb.new(Configuration::DBHOST,
                            Configuration::DBPASS)
 
 
-# First, we find out if any domains have been removed from the
-# database but not from the filesystem.
-begin
-  # Get the list of domains according to the filesystem.
-  fs_domains = dms.get_domains_from_filesystem()
-rescue StandardError => e
-  puts "There was an error retrieving domains from the filesystem: #{e.to_s}"
-  Kernel.exit(ExitCodes::FILESYSTEM_ERROR)
-end
-
 begin
-  # ...and according to the Postfixadmin database.
+  # Get a list of domains from the Postfixadmin database.
   db_domains = pgadb.get_domains_from_db()
 rescue DatabaseError => e
   puts "There was an error connecting to the database: #{e.to_s}"
   Kernel.exit(ExitCodes::DATABASE_ERROR)
 end
 
-
-# Then, we get the list of accounts that have been removed. We did
-# the domains first so that, if a domain was removed, we can avoid
-# reporting each of its accounts individually.
-begin
-  # Get the list of accounts according to the filesystem.
-  fs_accts = dms.get_accounts_from_filesystem(db_domains)
-rescue StandardError => e
-  puts "There was an error retrieving accounts from the filesystem: #{e.to_s}"
-  Kernel.exit(ExitCodes::FILESYSTEM_ERROR)
-end
-
 begin
-  # ...and according to the Postfixadmin database.
-  db_accts = pgadb.get_accounts_from_db()
+  # And the accounts.
+  db_accounts = pgadb.get_accounts_from_db()
 rescue DatabaseError => e
   puts "There was an error connecting to the database: #{e.to_s}"
   Kernel.exit(ExitCodes::DATABASE_ERROR)
 end
 
 
-# The list of domains on the filesystem that aren't in the DB.
-dom_difference = fs_domains - db_domains
+Configuration::PLUGINS.each do |plugin_name|
+  # Convert a string into a class.
+  plugin_class = Kernel.const_get(plugin_name)
+  plugin = plugin_class.new()
 
-# And accounts on the filesystem that aren't in the DB and don't
-# belong to a domain that was removed.
-acct_difference = fs_accts - db_accts
-
-# Don't output any unnecessary junk. Cron might mail it to someone.
-if dom_difference.size > 0 or acct_difference.size > 0
+  begin
+    leftover_domains = plugin.get_leftover_domains(db_domains)
+  rescue StandardError => e
+    puts "There was an error retrieving domains from the filesystem: #{e.to_s}"
+    Kernel.exit(ExitCodes::FILESYSTEM_ERROR)
+  end
 
-  # The header that we output before the list of accounts.
-  # Just the path of this script, and the current time.
-  header = "#{$0}, "
+  begin
+    leftover_accounts = plugin.get_leftover_accounts(db_accounts)
+  rescue StandardError => e
+    puts "There was an error retrieving accounts from the filesystem: #{e.to_s}"
+    Kernel.exit(ExitCodes::FILESYSTEM_ERROR)
+  end
 
-  current_time = Time.now()
-  if current_time.respond_to?(:iso8601)
-    # Somehow this method is missing on some machines.
-    header += current_time.iso8601.to_s
-  else
-    # Fall back to whatever this looks like.
-    header += current_time.to_s
+  if leftover_domains.size > 0 or leftover_accounts.size > 0
+    # The header that we output before the list of domains/accounts.
+    # Just the path of this script, the current time, and the plugin name.
+    header = "#{$0}, "
+
+    current_time = Time.now()
+    if current_time.respond_to?(:iso8601)
+      # Somehow this method is missing on some machines.
+      header += current_time.iso8601.to_s
+    else
+      # Fall back to whatever this looks like.
+      header += current_time.to_s + "\n"
+    end
+
+    header += 'Plugin: ' + plugin_name + "\n"
+    puts header
+    puts '-' * header.size # Underline the header.
+
+    leftover_domains.each do |domain|
+      puts "Found: #{domain} (#{plugin.describe_domain(domain)})"
+    end
+
+    leftover_accounts.each do |account|
+      puts "Found: #{account} (#{plugin.describe_account(account)})"
+    end
+
+    if Configuration::I_MEAN_BUSINESS
+      leftover_domains.each do |domain|
+        plugin.delete_domain(domain)
+        puts "Removed: #{domain} (#{plugin.describe_domain(domain)})"
+      end
+
+      leftover_accounts.each do |account|
+        plugin.delete_account(account)
+        puts "Removed: #{account} (#{plugin.describe_account(account)})"
+      end
+    end
+
+    puts ""
   end
 
-  puts header
-  puts '-' * header.size # Underline the header.
-  puts dom_difference
-  puts acct_difference
-  puts ""
 end