X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=bin%2Fmailshears;h=2c91f17de15408283de45cf48fad6f79cd95dfc7;hp=37d660175dff6b1f055c73d3320b3031a04a2e06;hb=a66e4a7e39518629981fa134456dc2ae6c461faf;hpb=51f027b01e242737956c3ab5aecdd322d6ceeeed diff --git a/bin/mailshears b/bin/mailshears index 37d6601..2c91f17 100755 --- a/bin/mailshears +++ b/bin/mailshears @@ -1,17 +1,7 @@ -#!/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. -# # Define a usage string using the program name. exe = File.basename($PROGRAM_NAME) @@ -40,16 +30,27 @@ end 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." +# 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 + cfg = Configuration.new() # Load each of the plugins that we'll need. @@ -57,15 +58,12 @@ cfg.plugins.each do |plugin_file| require "#{mode_name}/plugins/#{plugin_file}" end -# Always enabled, for now. -require "#{mode_name}/plugins/postfixadmin_db" - # And the runners. require "#{mode_name}/#{mode_name}_runner" require "#{mode_name}/#{mode_name}_dummy_runner" def make_header(plugin_name) - # The header that we output before the list of domains/accounts. + # 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}, " @@ -86,114 +84,54 @@ def make_header(plugin_name) end -plugin_class = nil -runner_class = nil -dummy_runner_class = nil +plugin_module = nil if mode == :rm then - plugin_class = RmPlugin - runner_class = RmRunner - dummy_runner_class = RmDummyRunner + plugin_module = RmPlugin elsif mode == :mv then - plugin_class = MvPlugin - runner_class = MvRunner - dummy_runner_class = MvDummyRunner + plugin_module = MvPlugin else # Safe, catch-all default - plugin_class = PrunePlugin - runner_class = PruneRunner - dummy_runner_class = PruneDummyRunner + plugin_module = PrunePlugin end -puts make_header(plugin_class.to_s()) - -plugin_class.includers.each do |plugin_class_includer| - plugin = plugin_class_includer.new() +# 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 - if cfg.i_mean_business then - runner = runner_class.new() - else - runner = dummy_runner_class.new() +# 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 - - # 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) - - 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 - - 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 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 - - 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 "" + 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