Merge pull request mailman#35 from phildarnowsky/master

Added "graceful death" flag

Author: titanous

USER_GUIDE.md

@@ -242,3 +242,10 @@ loading will be disabled.
 interfere with running Mailman with cron or as a daemon.
 
 **Default**: `false`
+
+### Graceful death
+
+`Mailman.config.graceful_death`, if set, will catch SIGINTs 
+(Control-C) and allow the mail receiver to finish its current
+iteration before exiting. Note that this currently only works
+with POP3 receivers.

lib/mailman/application.rb

@@ -15,6 +15,8 @@ def self.run(&block)
     attr_reader :processor
 
     # Creates a new router, and sets up any routes passed in the block.
+    # @param [Hash] options the application options
+    # @option options [true,false] :graceful_death catch interrupt signal and don't die until end of poll
     # @param [Proc] block a block with routes
     def initialize(&block)
       @router = Mailman::Router.new
@@ -52,6 +54,11 @@ def run
         end
 
         connection = Receiver::POP3.new(options)
+
+        if Mailman.config.graceful_death
+          Signal.trap("INT") {polling = false}
+        end
+
         loop do
           begin
             connection.connect

lib/mailman/configuration.rb

@@ -21,7 +21,12 @@ class Configuration
     # @return [boolean] whether or not to ignore stdin.  Setting this to true 
     #   stops Mailman from entering stdin processing mode.
     attr_accessor :ignore_stdin
-    
+
+    # @return [boolean] catch SIGINT and allow current iteration to finish
+    # rather than dropping dead immediately. Currently only works with POP3 
+    # connections.
+    attr_accessor :graceful_death
+
     def logger
       @logger ||= Logger.new(STDOUT)
     end

spec/mailman/application_spec.rb

@@ -18,4 +18,25 @@
 
   end
 
+  describe "#run" do
+    describe "when graceful_death flag is set" do
+      before do
+        Mailman.config.graceful_death = true
+        @app = Mailman::Application.new {}
+      end
+
+      it "should catch interrupt signal and let a POP3 receiver finish its poll before exiting" do
+        @mock_receiver = double("Receiver::POP3")
+        @mock_receiver.stub(:connect)
+        @mock_receiver.stub(:get_messages) {Process.kill("INT", $$)}
+        @mock_receiver.should_receive(:disconnect)
+        Mailman::Receiver::POP3.stub(:new) {@mock_receiver}
+
+        Mailman.config.pop3 = {}
+
+        Signal.trap("INT") {raise "Application didn't catch SIGINT"}
+        @app.run
+      end
+    end
+  end
 end

spec/mailman/configuration_spec.rb

@@ -55,4 +55,9 @@
     config.ignore_stdin = true
     config.ignore_stdin.should == true
   end
+
+  it "should store graceful_death flag" do
+    config.graceful_death = true
+    config.graceful_death.should == true
+  end
 end