-#!/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'
+# Define a usage string using the program name.
+exe = File.basename($PROGRAM_NAME)
+usage = "#{exe} [prune | rm <target> | mv <src> <dst>]"
-# 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) + '/../'
+# Defaults
+mode_name = 'prune'
+mode = :prune
-# Needed for rm_rf.
-require 'fileutils'
-
-# Load our config file.
-require 'bin/configuration'
+# 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
-# And the necessary classes.
-require 'src/errors.rb'
-require 'src/exit_codes.rb'
-require 'src/postfixadmin_db'
+if mode_name == 'rm' then
+ mode = :rm
+elsif mode_name == 'mv' then
+ mode = :mv
+end
-Configuration::PLUGINS.each do |plugin_file|
- require "src/plugins/#{plugin_file}"
+# 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.
+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."
+ puts "Usage: #{usage}"
+ Kernel.exit(ExitCodes::BAD_COMMAND_LINE)
end
-pgadb = PostfixadminDb.new(Configuration::DBHOST,
- Configuration::DBPORT,
- Configuration::DBOPTS,
- Configuration::DBTTY,
- Configuration::DBNAME,
- Configuration::DBUSER,
- Configuration::DBPASS)
-
-
-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)
+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
-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)
+# 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.includers.each do |plugin_class|
- plugin = plugin_class.new()
+plugin_module = nil
- 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
+if mode == :rm then
+ plugin_module = RmPlugin
+elsif mode == :mv then
+ plugin_module = MvPlugin
+else
+ # Safe, catch-all default
+ plugin_module = PrunePlugin
+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
- # 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 + "\n"
- end
-
- header += 'Plugin: ' + plugin_name + "\n"
- puts header
- puts '-' * header.size # Underline the header.
-
- 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 Configuration::I_MEAN_BUSINESS
- leftover_domains.each do |domain|
- plugin.delete_domain(domain)
- puts "Removed: #{domain} (#{plugin.describe_domain(domain)})"
- end
-
- leftover_accounts.each do |account|
- plugin.delete_account(account)
- puts "Removed: #{account} (#{plugin.describe_account(account)})"
- end
- end
-
- puts ""
- 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
+
+plugin_module.run(cfg, *ARGV)
+# Restore stdout, and print the header plus whatever the plugins
+# produced if they produced anything. If they didn't, we avoid
+# printing the header.
+$stdout = STDOUT
+if output_buffer.size > 0 then
+ puts make_header(plugin_module.to_s())
+ puts output_buffer.string()
end