Update comments in the executable and factor out the make_header() function.
authorMichael Orlitzky <michael@orlitzky.com>
Fri, 6 Nov 2015 02:18:20 +0000 (21:18 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Fri, 6 Nov 2015 02:18:20 +0000 (21:18 -0500)
bin/mailshears
lib/common/user_interface.rb [new file with mode: 0644]
lib/mailshears.rb

index 2c91f17de15408283de45cf48fad6f79cd95dfc7..c5efabb32b5b1be125275c7f17279421d23b5f58 100755 (executable)
@@ -1,8 +1,11 @@
 #!/usr/bin/ruby -wU
 #
-# mailshears, to prune unused mail directories.
+# mailshears, to prune unused mail directories (and more).
 #
 
+# Load all of our lib/ code.
+require 'mailshears'
+
 # Define a usage string using the program name.
 exe = File.basename($PROGRAM_NAME)
 usage = "#{exe} [prune | rm <target> | mv <src> <dst>]"
@@ -11,7 +14,7 @@ usage = "#{exe} [prune | rm <target> | mv <src> <dst>]"
 mode_name = 'prune'
 mode = :prune
 
-# Now, if a mode was supplied, it should be in ARGV[0].
+# 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
@@ -20,20 +23,19 @@ if ARGV.length() > 0
   end
 end
 
+# Determine the mode from its name.
 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.
-# Figure out if we have the wrong number of arguments, and store the
-# associated error message in args_error_message if we do.
+# Since we removed the mode name (if it existed) from ARGV, what
+# remains should be the required arguments. Figure out if we have the
+# wrong number of arguments, and store the associated error message in
+# args_error_message if necessary.
 args_error_message = nil
+
 if mode == :prune and ARGV.length() != 0 then
   args_error_message = "ERROR: prune mode takes no additional arguments."
 elsif mode == :rm and ARGV.length() < 1 then
@@ -42,8 +44,8 @@ elsif mode == :mv and ARGV.length() != 2 then
   args_error_message = "ERROR: mv mode takes exactly two user arguments."
 end
 
-# If we got the wrong number of arguments, we'll have some error
-# message. Report it and quit.
+# If we got the wrong number of arguments, we'll have an error message
+# here. Report it and exit with a failure code.
 if not args_error_message.nil? then
   STDERR.puts args_error_message
   puts "Usage: #{usage}"
@@ -51,9 +53,9 @@ if not args_error_message.nil? then
 end
 
 
+# Load each of the plugins that we'll need.
 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
@@ -62,28 +64,7 @@ end
 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/users.
-  # 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
-
-
+# Now we figure out which plugin module to use based on our mode.
 plugin_module = nil
 
 if mode == :rm then
@@ -95,15 +76,10 @@ else
   plugin_module = PrunePlugin
 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
-
 # Parse the remaining arguments as User/Domain objects. If we get some
 # other argument that isn't one of those, it's an error.
 parsed_args = []
+
 ARGV.each do |arg|
   begin
     u = User.new(arg)
@@ -119,19 +95,31 @@ ARGV.each do |arg|
   end
 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
+
 begin
   plugin_module.run(cfg, *parsed_args)
 ensure
   # Now restore stdout, and print the header plus whatever the plugins
-  # produced if they produced anything. If they didn't produce any
+  # produced (if they produced anything). If they didn't produce any
   # output, then we avoid printing the header.
   #
   # This gets wrapped in an "ensure" block because otherwise, if
   # plugin_module.run() crashes, the traceback will get stored in
   # output_buffer and never get printed.
   $stdout = STDOUT
+
   if output_buffer.size > 0 then
-    puts make_header(plugin_module.to_s())
+    puts make_header(exe, plugin_module.to_s())
     puts output_buffer.string()
   end
 end
+
+# If we made it here without crashing, well that sounds pretty
+# successful to me.
+Kernel.exit(ExitCodes::SUCCESS)
diff --git a/lib/common/user_interface.rb b/lib/common/user_interface.rb
new file mode 100644 (file)
index 0000000..6a60d04
--- /dev/null
@@ -0,0 +1,19 @@
+def make_header(program_name, plugin_name)
+  # The header that we output before the list of domains/users.
+  # Just the path of this script, the current time, and the plugin name.
+  header = "#{program_name}, "
+
+  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
index bda9f0dd46b0dd20ac5d8b3d3ca243f234b88038..e5f2e6e706750d5d4011d48e15cf538172f0baf9 100644 (file)
@@ -1,8 +1,8 @@
-# Load the rest of the code we'll use. This loads what we'll need in
-# the executables; the library files are supposed to require what they
-# need.
+# Load the rest of the code we'll use. This loads only what we'll need
+# in the executable. The library files are supposed to require what
+# they need.
 
 require 'common/configuration'
 require 'common/errors'
 require 'common/exit_codes'
-
+require 'common/user_interface'