X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=bin%2Fmailshears;h=d9d16253cee734bba0428d64c0cbf07d036de669;hp=d12bbbd6fc27ee7e2b2503f70b56349f6f3ab691;hb=cc120c717cc6edb0291cc0cfbb8f2404daa57dbb;hpb=80dbad4600f1f19f21773fd199c895423712049c

diff --git a/bin/mailshears b/bin/mailshears
index d12bbbd..d9d1625 100755
--- a/bin/mailshears
+++ b/bin/mailshears
@@ -1,115 +1,124 @@
-#!/usr/bin/ruby -wKU
+#!/usr/bin/ruby -wU
 #
-# mailshears, to prune unused mail directories.
+# mailshears, to mangle your mail garden
 #
-# Mail accounts for virtual hosts are stored in SQL, and managed by
-# Postfixadmin. However, the physical directories are handled by
-# Postfix/Dovecot and are left untouched by Postfixadmin. This is good
-# for security, but comes at a cost: Postfixadmin can't remove a
-# user's mail directory when his or her account is deleted.
-#
-# This program compares the list of filesystem accounts with the ones
-# in the database. It outputs any accounts that exist in the
-# 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) + '/../'
+# Load all of our lib/ code.
+require 'mailshears'
 
-# Load our config file.
-require 'bin/configuration'
+# Define a usage string using the program name.
+program_name = File.basename($PROGRAM_NAME)
 
-# And the necessary classes.
-require 'src/errors.rb'
-require 'src/exit_codes.rb'
-require 'src/dovecot_mailstore'
-require 'src/postfixadmin_db'
+# Defaults
+mode_name = 'prune'
+mode = :prune
 
-dms = DovecotMailstore.new(Configuration::MAIL_ROOT)
-
-pgadb = PostfixadminDb.new(Configuration::DBHOST,
-                           Configuration::DBPORT,
-                           Configuration::DBOPTS,
-                           Configuration::DBTTY,
-                           Configuration::DBNAME,
-                           Configuration::DBUSER,
-                           Configuration::DBPASS)
+# 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
 
+# Determine the mode from its name.
+if mode_name == 'rm' then
+  mode = :rm
+elsif mode_name == 'mv' then
+  mode = :mv
+end
 
-# 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)
+# Since we removed the mode name (if it existed) from ARGV, what
+# remains should be the required arguments. Figure out if we have the
+# wrong number of arguments, and store the associated error message in
+# args_error_message if necessary.
+args_error_message = nil
+
+if mode == :prune and ARGV.length() != 0 then
+  args_error_message = "ERROR: prune mode takes no additional arguments."
+elsif mode == :rm and ARGV.length() < 1 then
+  args_error_message = "ERROR: rm mode takes two or more user arguments."
+elsif mode == :mv and ARGV.length() != 2 then
+  args_error_message = "ERROR: mv mode takes exactly two user arguments."
 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 we got the wrong number of arguments, we'll have an error message
+# here. Report it and exit with a failure code.
+if not args_error_message.nil? then
+  STDERR.puts args_error_message
+  puts "Usage: #{UserInterface.usage(program_name)}"
+  Kernel.exit(ExitCodes::BAD_COMMAND_LINE)
 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
+# Load each of the plugins that we'll need.
+cfg = Configuration.new()
 
-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)
+cfg.plugins.each do |plugin_file|
+  require "#{mode_name}/plugins/#{plugin_file}"
 end
 
+# And the runners.
+require "#{mode_name}/#{mode_name}_runner"
+require "#{mode_name}/#{mode_name}_dummy_runner"
 
-# The list of domains on the filesystem that aren't in the DB.
-dom_difference = fs_domains - db_domains
+# Now we figure out which plugin module to use based on our mode.
+plugin_module = nil
 
-# 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
+if mode == :rm then
+  plugin_module = RmPlugin
+elsif mode == :mv then
+  plugin_module = MvPlugin
+else
+  # Safe, catch-all default
+  plugin_module = PrunePlugin
+end
 
-# Don't output any unnecessary junk. Cron might mail it to someone.
-if dom_difference.size > 0 or acct_difference.size > 0
+# Parse the remaining arguments as User/Domain objects. If we get some
+# other argument that isn't one of those, it's an error.
+parsed_args = []
+
+ARGV.each do |arg|
+  begin
+    u = User.new(arg)
+    parsed_args << u
+  rescue InvalidUserError
+    begin
+      d = Domain.new(arg)
+      parsed_args << d
+    rescue InvalidDomainError
+      STDERR.puts "ERROR: invalid user/domain argument #{arg}"
+      Kernel.exit(ExitCodes::BAD_COMMAND_LINE)
+    end
+  end
+end
 
-  # The header that we output before the list of accounts.
-  # Just the path of this script, and the current time.
-  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
-  end
+# Buffer the output so that we can avoid printing the informational
+# header when no plugins produce output.
+require 'stringio'
+output_buffer = StringIO.new()
+$stdout = output_buffer
 
-  puts header
-  puts '-' * header.size # Underline the header.
-  puts dom_difference
-  puts acct_difference
-  puts ""
+begin
+  plugin_module.run(cfg, *parsed_args)
+ensure
+  # Now restore stdout, and print the header plus whatever the plugins
+  # produced (if they produced anything). If they didn't produce any
+  # output, then we avoid printing the header.
+  #
+  # This gets wrapped in an "ensure" block because otherwise, if
+  # plugin_module.run() crashes, the traceback will get stored in
+  # output_buffer and never get printed.
+  $stdout = STDOUT
+
+  if output_buffer.size > 0 then
+    puts UserInterface.make_header(program_name, plugin_module.to_s())
+    puts output_buffer.string()
+  end
 end
+
+# If we made it here without crashing, well that sounds pretty
+# successful to me.
+Kernel.exit(ExitCodes::SUCCESS)