X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=bin%2Fmailshears;h=d9d16253cee734bba0428d64c0cbf07d036de669;hp=5d1c7982dd6978939fce3edbeb9480d68c4e19f8;hb=cc120c717cc6edb0291cc0cfbb8f2404daa57dbb;hpb=566f5fe84f82bb26e86b0902d65fc89693e9d813 diff --git a/bin/mailshears b/bin/mailshears index 5d1c798..d9d1625 100755 --- a/bin/mailshears +++ b/bin/mailshears @@ -1,110 +1,124 @@ -#!/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. +# mailshears, to mangle your mail garden # +# Load all of our lib/ code. require 'mailshears' -cfg = Configuration.new() -pgadb = PostfixadminDb.new(cfg.dbhost, - cfg.dbport, - cfg.dbopts, - cfg.dbtty, - cfg.dbname, - cfg.dbuser, - cfg.dbpass) +# Define a usage string using the program name. +program_name = File.basename($PROGRAM_NAME) +# Defaults +mode_name = 'prune' +mode = :prune -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) +# 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 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) +# Determine the mode from its name. +if mode_name == 'rm' then + mode = :rm +elsif mode_name == 'mv' then + mode = :mv end +# 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 -Plugin.includers.each do |plugin_class| - plugin = plugin_class.new() +# 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 - 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 +# Load each of the plugins that we'll need. +cfg = Configuration.new() - 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 - end +cfg.plugins.each do |plugin_file| + require "#{mode_name}/plugins/#{plugin_file}" +end - header += ' (Plugin: ' + plugin_class.to_s + ")\n" - puts header - puts '-' * header.size # Underline the header. +# And the runners. +require "#{mode_name}/#{mode_name}_runner" +require "#{mode_name}/#{mode_name}_dummy_runner" - leftover_domains.each do |domain| - puts "Found: #{domain} (#{plugin.describe_domain(domain)})" - end +# Now we figure out which plugin module to use based on our mode. +plugin_module = nil - leftover_accounts.each do |account| - puts "Found: #{account} (#{plugin.describe_account(account)})" - end +if mode == :rm then + plugin_module = RmPlugin +elsif mode == :mv then + plugin_module = MvPlugin +else + # Safe, catch-all default + plugin_module = PrunePlugin +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 +# 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 = [] - puts "" +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 + + +# 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 +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)