X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=bin%2Fmailshears;h=2c91f17de15408283de45cf48fad6f79cd95dfc7;hp=f8211b1cf33727f8d5b0a59ce560b153b3f951f0;hb=a66e4a7e39518629981fa134456dc2ae6c461faf;hpb=75b0a08d381f74911ed64f14a4944e44c9a5c031

diff --git a/bin/mailshears b/bin/mailshears
index f8211b1..2c91f17 100755
--- a/bin/mailshears
+++ b/bin/mailshears
@@ -1,77 +1,73 @@
-#!/usr/bin/ruby -wKU
+#!/usr/bin/ruby -wU
 #
 # mailshears, to prune unused mail directories.
 #
-# 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 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)
+# Define a usage string using the program name.
+exe = File.basename($PROGRAM_NAME)
+usage = "#{exe} [prune | rm <target> | mv <src> <dst>]"
 
-begin
-  # Get the list of accounts according to the filesystem.
-  fs_accts = dms.get_accounts_from_filesystem()
-rescue StandardError => e
-  puts "There was an error retrieving accounts from the filesystem: #{e.to_s}"
-  Kernel.exit(ExitCodes::FILESYSTEM_ERROR)
+# 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_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)
+if mode_name == 'rm' then
+  mode = :rm
+elsif mode_name == 'mv' then
+  mode = :mv
+end
+
+# 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.
+# Figure out if we have the wrong number of arguments, and store the
+# associated error message in args_error_message if we do.
+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
+
+# If we got the wrong number of arguments, we'll have some error
+# message. Report it and quit.
+if not args_error_message.nil? then
+  STDERR.puts args_error_message
+  puts "Usage: #{usage}"
+  Kernel.exit(ExitCodes::BAD_COMMAND_LINE)
 end
 
 
-# Figure out which addresses are in the filesystem, but not in the
-# database.
-difference = [fs_accts - db_accts]
+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
+
+# 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 difference.size > 0
+def make_header(plugin_name)
+  # The header that we output before the list of domains/users.
+  # Just the path of this script, the current time, and the plugin name.
+  exe = File.basename($PROGRAM_NAME)
+  header = "#{exe}, "
 
-  # 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.
@@ -80,9 +76,62 @@ if difference.size > 0
     # Fall back to whatever this looks like.
     header += current_time.to_s
   end
-  
-  puts header
-  puts '-' * header.size # Underline the header.
-  puts difference
-  puts ""
+
+  header += ' (Plugin: ' + plugin_name + ")\n"
+  header += '-' * header.size # Underline the header.
+
+  return header
+end
+
+
+plugin_module = nil
+
+if mode == :rm then
+  plugin_module = RmPlugin
+elsif mode == :mv then
+  plugin_module = MvPlugin
+else
+  # Safe, catch-all default
+  plugin_module = PrunePlugin
+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
+
+# 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
+
+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 make_header(plugin_module.to_s())
+    puts output_buffer.string()
+  end
 end