#!/usr/bin/ruby -wU # # mailshears, to prune unused mail directories. # # Define a usage string using the program name. exe = File.basename($PROGRAM_NAME) usage = "#{exe} [prune | rm | mv ]" # 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 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 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" 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}, " 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 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