X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=bin%2Fmailshears;h=cb8ee4122d33b1cd4d5ee8c07625dab9dbe333d8;hp=d2894cd13db31ae86fb72758096f4a9cd1762533;hb=7f8654ed6582062a295e1be75ae70e99de41b323;hpb=955476ab737e8462bec7d87967db60a0995757ba

diff --git a/bin/mailshears b/bin/mailshears
index d2894cd..cb8ee41 100755
--- a/bin/mailshears
+++ b/bin/mailshears
@@ -13,92 +13,59 @@
 # filesystem, but not the database.
 #
 
-# 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).
-require 'pathname'
-
-# This bit of magic adds the parent directory (the
-# project root) to the list of ruby load paths.
-# Thus, our require statements will work regardless of
-# how or from where the script was run.
-executable = Pathname.new(__FILE__).realpath.to_s
-$: << File.dirname(executable) + '/../'
-
-# Needed for rm_rf.
-require 'fileutils'
-
-# Load our config file.
-require 'bin/configuration'
-
-# And the necessary classes.
-require 'src/errors.rb'
-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,
-                           Configuration::DBTTY,
-                           Configuration::DBNAME,
-                           Configuration::DBUSER,
-                           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)
+# Define a usage string using the program name.
+exe = File.basename($PROGRAM_NAME)
+usage = "#{exe} [prune | rm <target> | mv <src> <dst>]"
+
+# Defaults
+mode_name = 'prune'
+mode = :prune
+
+# Now, if a mode was supplied, it should be in ARGV[0].
+if ARGV.length() > 0
+  mode_names = ['prune', 'rm', 'mv']
+  if mode_names.include?(ARGV.first().downcase()) then
+    # Peel the mode name off the head of the list.
+    mode_name = ARGV.shift()
+  end
 end
 
-begin
-  # ...and according to 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)
+if mode_name == 'rm' then
+  mode = :rm
+elsif mode_name == 'mv' then
+  mode = :mv
 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)
+# Need this before referencing ExitCodes.
+require 'mailshears'
+
+# Since we removed both the executable name and the mode name (if it
+# existed) from ARGV, what remains should be the required
+# arguments.
+if (mode == :prune and (ARGV.length() != 0)) or
+    (mode == :rm and (ARGV.length() < 1))   or
+    (mode == :mv and (ARGV.length() != 2))   then
+  puts "ERROR: missing (or extra) command-line arguments."
+  puts "Usage: #{usage}"
+  Kernel.exit(ExitCodes::BAD_COMMAND_LINE)
 end
 
-begin
-  # ...and according to the Postfixadmin database.
-  db_accts = 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
+cfg = Configuration.new()
 
+# Load each of the plugins that we'll need.
+cfg.plugins.each do |plugin_file|
+  require "#{mode_name}/plugins/#{plugin_file}"
+end
 
-# The list of domains on the filesystem that aren't in the DB.
-dom_difference = fs_domains - db_domains
-
-# 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
+# And the runners.
+require "#{mode_name}/#{mode_name}_runner"
+require "#{mode_name}/#{mode_name}_dummy_runner"
 
-# Don't output any unnecessary junk. Cron might mail it to someone.
-if dom_difference.size > 0 or acct_difference.size > 0
-  # The header that we output before the list of accounts.
-  # Just the path of this script, and the current time.
-  header = "#{$0}, "
+def make_header(plugin_name)
+  # The header that we output before the list of domains/accounts.
+  # Just the path of this script, the current time, and the plugin name.
+  exe = File.basename($PROGRAM_NAME)
+  header = "#{exe}, "
 
   current_time = Time.now()
   if current_time.respond_to?(:iso8601)
@@ -109,30 +76,121 @@ if dom_difference.size > 0 or acct_difference.size > 0
     header += current_time.to_s
   end
 
-  puts header
-  puts '-' * header.size # Underline the header.
+  header += ' (Plugin: ' + plugin_name + ")\n"
+  header += '-' * header.size # Underline the header.
+
+  return header
+end
+
+
+plugin_class = nil
+runner_class = nil
+dummy_runner_class = nil
+
+if mode == :rm then
+  plugin_class = RmPlugin
+  runner_class = RmRunner
+  dummy_runner_class = RmDummyRunner
+elsif mode == :mv then
+  plugin_class = MvPlugin
+  runner_class = MvRunner
+  dummy_runner_class = MvDummyRunner
+else
+  # Safe, catch-all default
+  plugin_class = PrunePlugin
+  runner_class = PruneRunner
+  dummy_runner_class = PruneDummyRunner
+end
+
+puts make_header(plugin_class.to_s())
+
+plugin_class.includers.each do |plugin_class_includer|
+  plugin = plugin_class_includer.new()
+
+  if cfg.i_mean_business then
+    runner = runner_class.new()
+  else
+    runner = dummy_runner_class.new()
+  end
+
+  # The splat passes the correct (we hope) number of arguments to the
+  # appropriate runner. The Rm(Dummy)Runner have splats on their
+  # *target arguments as well, to turn ARGV back into an array.
+  runner.run(plugin, *ARGV)
 
-  dom_difference.each do |domain|
-    puts "Found: #{domain} (#{dms.get_domain_path(domain)})"
+  puts ""
+end
+
+
+
+Kernel.exit(0)
+
+
+begin
+  # 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
+
+begin
+  # 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
+
+
+Plugin.includers.each do |plugin_class_includer|
+  plugin = plugin_class_includer.new()
+
+  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
 
-  acct_difference.each do |account|
-    puts "Found: #{account} (#{dms.get_account_path(account)})"
+  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
 
-  if Configuration::I_MEAN_BUSINESS
-    dom_difference.each do |domain|
-      domain_path = dms.get_domain_path(domain)
-      FileUtils.rm_rf(domain_path)
-      puts "Removed: #{domain_path}"
+  if leftover_domains.size > 0 or leftover_accounts.size > 0
+    puts make_header(plugin_class.to_s())
+
+    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
 
-    acct_difference.each do |account|
-      account_path = dms.get_account_path(account)
-      FileUtils.rm_rf(account_path)
-      puts "Removed: #{account_path}"
+    if cfg.i_mean_business
+      # We have to delete the accounts before the domain,
+      # otherwise they'd already be gone.
+      leftover_accounts.each do |account|
+        # Get the description before we delete the domain.
+        # This can still fail if the account's domain is gone.
+        account_description = plugin.describe_account(account)
+        plugin.delete_account(account)
+        puts "Removed: #{account} (#{account_description})"
+      end
+
+      leftover_domains.each do |domain|
+        # Get the description before we delete the domain.
+        domain_description = plugin.describe_domain(domain)
+        plugin.delete_domain(domain)
+        puts "Removed: #{domain} (#{domain_description})"
+      end
     end
+
+    puts ""
   end
 
-  puts ""
 end