In the middle of refactoring the binary to accept three modes of execution. Does...
authorMichael Orlitzky <michael@orlitzky.com>
Thu, 29 Aug 2013 18:32:51 +0000 (14:32 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Thu, 29 Aug 2013 18:32:51 +0000 (14:32 -0400)
bin/mailshears
lib/common/exit_codes.rb
lib/common/runner.rb [new file with mode: 0644]
lib/mailshears.rb
lib/mv/mv_plugin.rb
lib/rm/rm_dummy_runner.rb [new file with mode: 0644]
lib/rm/rm_plugin.rb
lib/rm/rm_runner.rb [new file with mode: 0644]

index 5d1c7982dd6978939fce3edbeb9480d68c4e19f8..06534d887c9125dabde3ab43e6371253f0bda122 100755 (executable)
 # filesystem, but not the database.
 #
 
+# Define a usage string using the program name.
+exe = File.basename($PROGRAM_NAME)
+usage = "#{exe} [prune | rm <target> | mv <src> <dst>]"
+
+# Defaults
+mode_name = 'prune'
+mode = :prune
+
+# 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
+
+if mode_name == 'rm' then
+  mode = :rm
+elsif mode_name == 'mv' then
+  mode = :mv
+end
+
+# 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
+
 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
+
+# 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.
+  # 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
+
+
+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,
@@ -25,6 +112,8 @@ pgadb = PostfixadminDb.new(cfg.dbhost,
                            cfg.dbpass)
 
 
+
+
 begin
   # Get a list of domains from the Postfixadmin database.
   db_domains = pgadb.get_domains_from_db()
@@ -60,22 +149,7 @@ Plugin.includers.each do |plugin_class|
   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
-    end
-
-    header += ' (Plugin: ' + plugin_class.to_s + ")\n"
-    puts header
-    puts '-' * header.size # Underline the header.
+    puts make_header(plugin_class.to_s())
 
     leftover_domains.each do |domain|
       puts "Found: #{domain} (#{plugin.describe_domain(domain)})"
index 8f70919fc457d5500a0d52c468419a7b2a4b5ca5..f632b25982cb26d17f28060862f3ee08be5a4d5e 100644 (file)
@@ -3,5 +3,5 @@ module ExitCodes
   SUCCESS = 0
   FILESYSTEM_ERROR = 1
   DATABASE_ERROR = 2
-
+  BAD_COMMAND_LINE = 3
 end
diff --git a/lib/common/runner.rb b/lib/common/runner.rb
new file mode 100644 (file)
index 0000000..c48f89a
--- /dev/null
@@ -0,0 +1,5 @@
+module Runner
+  def run(plugin, targets)
+    raise NotImplementedError
+  end
+end
index 1c8c042632430735c8ea0f38957faee57335bcff..5eff52169061579975d6cb0ab0b3e4754f8ff37c 100644 (file)
@@ -6,13 +6,4 @@ require 'common/configuration'
 require 'common/errors'
 require 'common/exit_codes'
 require 'common/postfixadmin_db'
-
-cfg = Configuration.new()
-
-cfg.plugins.each do |plugin_file|
-  require "rm/plugins/#{plugin_file}"
-end
-
-cfg.plugins.each do |plugin_file|
-  require "mv/plugins/#{plugin_file}"
-end
+require 'common/runner'
index 76fad8395cf6454666d3caf1b3ed3e7401dce0cb..2ccb9a388572acedcb3dbb67bc36120f06381347 100644 (file)
@@ -3,6 +3,18 @@ module MvPlugin
   # Plugins for moving (renaming) accounts.
   #
 
+  def MvPlugin.included(c)
+    # Callback, called whenever another class or module includes this
+    # one. The parameter given is the name of the class or module
+    # that included us.
+    @includers ||= []
+    @includers << c
+  end
+
+  def MvPlugin.includers
+    return @includers
+  end
+
   def mv_domain(from, to)
     # Rename the given domain.
     raise NotImplementedError
diff --git a/lib/rm/rm_dummy_runner.rb b/lib/rm/rm_dummy_runner.rb
new file mode 100644 (file)
index 0000000..c79e046
--- /dev/null
@@ -0,0 +1,16 @@
+class RmDummyRunner
+  include Runner
+
+  def run(plugin, targets)
+    targets.each do |target|
+      if target.include?('@') then
+        puts "Would remove account: #{target}"
+      else
+        puts "Would remove domain: #{target}"
+      end
+    end
+
+    # TODO: remove from postfixadmin as well.
+  end
+
+end
index 0c155a18f9441521d1ee3a6c9445927c19bd022a..e2f2cfe413278bba00a1f0a572451b32fd6936a7 100644 (file)
@@ -3,6 +3,18 @@ module RmPlugin
   # Plugins for the removal of accounts.
   #
 
+  def RmPlugin.included(c)
+    # Callback, called whenever another class or module includes this
+    # one. The parameter given is the name of the class or module
+    # that included us.
+    @includers ||= []
+    @includers << c
+  end
+
+  def RmPlugin.includers
+    return @includers
+  end
+
   def delete_domain(domain)
     # Delete the given domain.
     raise NotImplementedError
diff --git a/lib/rm/rm_runner.rb b/lib/rm/rm_runner.rb
new file mode 100644 (file)
index 0000000..039ae61
--- /dev/null
@@ -0,0 +1,32 @@
+class RmRunner
+  include Runner
+
+  def run(plugin, targets)
+    targets.each do |target|
+      # Why think too hard? An account has an @, a domain doesn't.
+      if target.include?('@') then
+        begin
+          account_description = plugin.describe_account(target)
+          plugin.delete_account(target)
+          puts "Removed account: #{target} (#{account_description})"
+        rescue StandardError => e
+          puts "There was an error removing the account: #{e.to_s}"
+          Kernel.exit(ExitCodes::DATABASE_ERROR)
+        end
+      else
+        begin
+          # TODO: Delete all accounts first.
+          domain_description = plugin.describe_domain(target)
+          plugin.delete_domain(target)
+          puts "Removed domain: #{target} (#{domain_description})"
+        rescue StandardError => e
+          puts "There was an error removing the domain: #{e.to_s}"
+          Kernel.exit(ExitCodes::DATABASE_ERROR)
+        end
+      end
+    end
+
+    # TODO: remove from postfixadmin as well.
+  end
+
+end