Replace 'account' with 'user' everywhere.
[mailshears.git] / bin / mailshears
index 06534d887c9125dabde3ab43e6371253f0bda122..f7b1963cc8bde0a49cfc388fa29d963cf8e3db55 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.
 #
 
@@ -43,7 +43,7 @@ require 'mailshears'
 # 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 == :rm and (ARGV.length() < 1))   or
     (mode == :mv and (ARGV.length() != 2))   then
   puts "ERROR: missing (or extra) command-line arguments."
   puts "Usage: #{usage}"
@@ -62,7 +62,7 @@ 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}, "
@@ -83,102 +83,52 @@ def make_header(plugin_name)
 end
 
 
-if mode == :rm then
-  RmPlugin.includers.each do |plugin_class|
-    plugin = plugin_class.new()
-    puts make_header(plugin_class.to_s())
-
-    if cfg.i_mean_business then
-      runner = RmRunner.new()
-    else
-      runner = RmDummyRunner.new()
-    end
-
-    runner.run(plugin, ARGV)
-
-    puts ""
-  end
-end
-
-
-
-Kernel.exit(0)
-pgadb = PostfixadminDb.new(cfg.dbhost,
-                           cfg.dbport,
-                           cfg.dbopts,
-                           cfg.dbtty,
-                           cfg.dbname,
-                           cfg.dbuser,
-                           cfg.dbpass)
-
+plugin_class = nil
+runner_class = nil
+dummy_runner_class = nil
 
-
-
-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)
+if mode == :rm then
+  plugin_class = RmPlugin
+  runner_class = RmRunner
+  dummy_runner_class = RmDummyRunner
+elsif mode == :mv then
+  plugin_class = MvPlugin
+  runner_class = MvRunner
+  dummy_runner_class = MvDummyRunner
+else
+  # Safe, catch-all default
+  plugin_class = PrunePlugin
+  runner_class = PruneRunner
+  dummy_runner_class = PruneDummyRunner
 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)
-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.includers.each do |plugin_class|
-  plugin = plugin_class.new()
+plugin_class.includers.each do |plugin_class_includer|
+  plugin = plugin_class_includer.new(cfg)
 
-  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)
+  if cfg.i_mean_business then
+    runner = runner_class.new()
+  else
+    runner = dummy_runner_class.new()
   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
+  # 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)
+end
 
+# 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_class.to_s())
+  puts output_buffer.string()
 end