Factor out plugin running into the Plugin module (along with the includers() handling).
[mailshears.git] / bin / mailshears
index 37d660175dff6b1f055c73d3320b3031a04a2e06..f7d5afa5b10c75264e92f275f4bfeb24724bb74e 100755 (executable)
@@ -2,14 +2,14 @@
 #
 # mailshears, to prune unused mail directories.
 #
-# Mail accounts for virtual hosts are stored in SQL, and managed by
+# Mail users 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
+# This program compares the list of filesystem users with the ones
+# in the database. It outputs any users that exist in the
 # filesystem, but not the database.
 #
 
@@ -57,15 +57,12 @@ cfg.plugins.each do |plugin_file|
   require "#{mode_name}/plugins/#{plugin_file}"
 end
 
-# Always enabled, for now.
-require "#{mode_name}/plugins/postfixadmin_db"
-
 # 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/accounts.
+  # 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}, "
@@ -86,114 +83,31 @@ def make_header(plugin_name)
 end
 
 
-plugin_class = nil
-runner_class = nil
-dummy_runner_class = nil
+plugin_module = nil
 
 if mode == :rm then
-  plugin_class = RmPlugin
-  runner_class = RmRunner
-  dummy_runner_class = RmDummyRunner
+  plugin_module = RmPlugin
 elsif mode == :mv then
-  plugin_class = MvPlugin
-  runner_class = MvRunner
-  dummy_runner_class = MvDummyRunner
+  plugin_module = MvPlugin
 else
   # Safe, catch-all default
-  plugin_class = PrunePlugin
-  runner_class = PruneRunner
-  dummy_runner_class = PruneDummyRunner
-end
-
-puts make_header(plugin_class.to_s())
-
-plugin_class.includers.each do |plugin_class_includer|
-  plugin = plugin_class_includer.new()
-
-  if cfg.i_mean_business then
-    runner = runner_class.new()
-  else
-    runner = dummy_runner_class.new()
-  end
-
-  # The splat passes the correct (we hope) number of arguments to the
-  # appropriate runner. The Rm(Dummy)Runner have splats on their
-  # *target arguments as well, to turn ARGV back into an array.
-  runner.run(plugin, *ARGV)
-
-  puts ""
-end
-
-
-
-Kernel.exit(0)
-
-
-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)
-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)
+  plugin_module = PrunePlugin
 end
 
 
-Plugin.includers.each do |plugin_class_includer|
-  plugin = plugin_class_includer.new()
+# 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
-    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
-
-  if leftover_domains.size > 0 or leftover_accounts.size > 0
-    puts make_header(plugin_class.to_s())
-
-    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 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
-
-    puts ""
-  end
+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