From 6a172f997768b49c5e56cecdfcc4f67a5f11d793 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Sun, 26 Dec 2010 15:08:24 -0500 Subject: [PATCH] Convert DovecotMailstore to a plugin, and generalize the main mailshears script to execute a series of plugins in succession. --- bin/mailshears | 114 ++++++++++++++++++--------------------- src/dovecot_mailstore.rb | 42 ++++++++++++++- 2 files changed, 92 insertions(+), 64 deletions(-) diff --git a/bin/mailshears b/bin/mailshears index d2894cd..6e84751 100755 --- a/bin/mailshears +++ b/bin/mailshears @@ -37,8 +37,6 @@ require 'src/exit_codes.rb' require 'src/dovecot_mailstore' require 'src/postfixadmin_db' -dms = DovecotMailstore.new(Configuration::MAIL_ROOT) - pgadb = PostfixadminDb.new(Configuration::DBHOST, Configuration::DBPORT, Configuration::DBOPTS, @@ -48,91 +46,81 @@ 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 +Configuration::PLUGINS.each do |plugin_name| + # Convert a string into a class. + plugin_class = Kernel.const_get(plugin_name) + plugin = plugin_class.new() -# 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 - -# 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}, " + 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 - 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_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 - puts header - puts '-' * header.size # Underline the header. + 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 - dom_difference.each do |domain| - puts "Found: #{domain} (#{dms.get_domain_path(domain)})" - end + header += 'Plugin: ' + plugin_name + "\n" + puts header + puts '-' * header.size # Underline the header. - acct_difference.each do |account| - puts "Found: #{account} (#{dms.get_account_path(account)})" - end + leftover_domains.each do |domain| + puts "Found: #{domain} (#{plugin.describe_domain(domain)})" + end - if Configuration::I_MEAN_BUSINESS - dom_difference.each do |domain| - domain_path = dms.get_domain_path(domain) - FileUtils.rm_rf(domain_path) - puts "Removed: #{domain_path}" + leftover_accounts.each do |account| + puts "Found: #{account} (#{plugin.describe_account(account)})" end - acct_difference.each do |account| - account_path = dms.get_account_path(account) - FileUtils.rm_rf(account_path) - puts "Removed: #{account_path}" + 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 - puts "" end diff --git a/src/dovecot_mailstore.rb b/src/dovecot_mailstore.rb index d675efc..ee12da9 100644 --- a/src/dovecot_mailstore.rb +++ b/src/dovecot_mailstore.rb @@ -4,11 +4,51 @@ require 'src/mailstore' class DovecotMailstore < Mailstore + def initialize + @domain_root = Configuration::MAIL_ROOT + end + + def describe_domain(domain) + return get_domain_path(domain) + end + + def describe_account(account) + return get_account_path(account) + end + + def delete_domain(domain) + domain_path = self.get_domain_path(domain) + FileUtils.rm_rf(domain_path) + end + + def delete_account(account) + account_path = self.get_account_path(account) + FileUtils.rm_rf(account_path) + end + + def get_leftover_domains(db_domains) + # Get the list of domains according to the filesystem. + fs_domains = self.get_domains_from_filesystem() + + # Return the list of domains on the filesystem that aren't in the DB. + return (fs_domains - db_domains) + end + + def get_leftover_accounts(db_accounts) + # Get the list of accounts according to the filesystem. + fs_domains = self.get_domains_from_filesystem() + fs_accounts = self.get_accounts_from_filesystem(fs_domains) + + # And return the accounts on the filesystem that aren't in the DB. + return (fs_accounts - db_accounts) + end + + protected; + def get_domains_from_filesystem() return Filesystem.get_subdirs(@domain_root) end - def get_accounts_from_filesystem(domains) accounts = [] -- 2.43.2