X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=bin%2Fmailshears;h=5a8ee0a6752064292274d585e16dc38c4bb39d51;hp=06347fb9eafced5b8a3f5d16f331140d444ecc8a;hb=fd60e4e45d24c7efe5bc2710ae23f60bbb6b7be1;hpb=1511b1d4bec6c53bcdb74fe60ee3b0fc4551b104 diff --git a/bin/mailshears b/bin/mailshears index 06347fb..5a8ee0a 100755 --- a/bin/mailshears +++ b/bin/mailshears @@ -13,28 +13,20 @@ # 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) + '/../' +# Needed for rm_rf. +require 'fileutils' # Load our config file. -require 'bin/configuration' +require 'configuration' # And the necessary classes. -require 'src/errors.rb' -require 'src/exit_codes.rb' -require 'src/dovecot_mailstore' -require 'src/postfixadmin_db' +require 'errors.rb' +require 'exit_codes.rb' +require 'postfixadmin_db' -dms = DovecotMailstore.new(Configuration::MAIL_ROOT) +Configuration::PLUGINS.each do |plugin_file| + require "plugins/#{plugin_file}" +end pgadb = PostfixadminDb.new(Configuration::DBHOST, Configuration::DBPORT, @@ -45,77 +37,86 @@ pgadb = PostfixadminDb.new(Configuration::DBHOST, Configuration::DBPASS) -# First, we find out if any domains have been removed from the -# database but not from the filesystem. -begin - # Get the list of domains according to the filesystem. - fs_domains = dms.get_domains_from_filesystem() -rescue StandardError => e - puts "There was an error retrieving domains from the filesystem: #{e.to_s}" - Kernel.exit(ExitCodes::FILESYSTEM_ERROR) -end - begin - # ...and according to the Postfixadmin database. + # 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 - -# Then, we get the list of accounts that have been removed. We did -# the domains first so that, if a domain was removed, we can avoid -# reporting each of its accounts individually. begin - # Get the list of accounts according to the filesystem. - fs_accts = dms.get_accounts_from_filesystem(db_domains) -rescue StandardError => e - puts "There was an error retrieving accounts from the filesystem: #{e.to_s}" - Kernel.exit(ExitCodes::FILESYSTEM_ERROR) -end - -begin - # ...and according to the Postfixadmin database. - db_accts = pgadb.get_accounts_from_db() + # 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 -# The list of domains on the filesystem that aren't in the DB. -dom_difference = fs_domains - db_domains - -# And accounts on the filesystem that aren't in the DB and don't -# belong to a domain that was removed. -acct_difference = fs_accts - db_accts +Plugin.includers.each do |plugin_class| + plugin = plugin_class.new() -# Don't output any unnecessary junk. Cron might mail it to someone. -if dom_difference.size > 0 or acct_difference.size > 0 - # 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. - header += current_time.iso8601.to_s - else - # Fall back to whatever this looks like. - header += current_time.to_s + 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 - puts header - puts '-' * header.size # Underline the header. - - dom_difference.each do |domain| - puts domain + " (#{dms.get_domain_path(domain)})" + 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 - acct_difference.each do |account| - puts account + " (#{dms.get_account_path(account)})" + 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_class.to_s + "\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 + # 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 "" end - puts "" end