catfriend 0.11 → 0.12

data/lib/catfriend/imap.rb

@@ -1,12 +1,13 @@
 require 'catfriend/server'
 require 'catfriend/notify'
+require 'catfriend/thread'
 
 module Catfriend
 
 # This class represents a thread capable of checking and creating
 # notifications for a single mailbox on a single IMAP server.
 class ImapServer
-    include ThreadMixin
+    include Thread
     include AccessorsFromHash
 
     # Create new IMAP server with optional full configuration hash.
@@ -30,8 +31,6 @@ class ImapServer
         if not @password
             raise ConfigError, "imap password not set"
         end
-
-        @id = @host unless @id
     end
 
     # The id is a token which represents this server when displaying
@@ -50,20 +49,21 @@ class ImapServer
     # succeeds.
     def run
         begin
-            connect
-            # :body => nil means summary only
             @notification =
                 Libnotify.new :body => nil,
                               :timeout => Catfriend.notification_timeout
+            @message_count = connect
+            notify_message @message_count
+            # :body => nil means summary only
         rescue OpenSSL::SSL::SSLError
             error "try providing ssl certificate"
         rescue Net::IMAP::NoResponseError
             error "no response to connect, try ssl"
         else
-            @message_count = @imap.fetch('*', 'UID').first.seqno
-            notify_message @message_count
-
-            loop { check_loop }
+            loop {
+                check_loop
+                break if stopped?
+            }
         end
     end
 
@@ -72,26 +72,34 @@ class ImapServer
     # on an unrecoverable error.
     def check_loop
         @imap.idle do |r|
+            # puts "#{id}: #{r}" # debug code
             next if r.instance_of? Net::IMAP::ContinuationRequest
 
             if r.instance_of? Net::IMAP::UntaggedResponse
-                if r.name == 'EXISTS'
+                case r.name
+                when 'EXISTS'
                     # some servers send this even when the message count
                     # hasn't increased so suspiciously double-check
-                    if r.data > @message_count
+                    if r.data != @message_count
+                        notify_message(r.data) if r.data > @message_count
                         @message_count = r.data
-                        notify_message @message_count
                     end
-                elsif r.name == 'EXPUNGE'
+                when 'EXPUNGE'
                     @message_count -= 1
                 end
             end
         end
 
-        notify_message "error - server cancelled idle"
+        # puts "idle loop over" # debug code
+    rescue Net::IMAP::Error, IOError
+        # reconnect and carry on
+        reconnect unless stopped?
     rescue => e
-        # todo: see if we have to re-open socket
-        notify_message "error - #{e.message}"
+        unless stopped?
+            # todo: see if we have to re-open socket
+            notify_message "error - #{e.message}"
+            puts e.backtrace.join "\n"
+        end
     end
 
     def notify_message message
@@ -104,7 +112,7 @@ class ImapServer
         super
     end
 
-    # Connect to the configured IMAP server.
+    # Connect to the configured IMAP server and return message count.
     def connect
         args = nil
         if not @no_ssl
@@ -117,11 +125,21 @@ class ImapServer
         @imap = Net::IMAP.new(@host, args)
         @imap.login(@user, @password)
         @imap.select(@mailbox || "INBOX")
+        return @imap.fetch('*', 'UID').first.seqno
+    end
+
+    def reconnect
+        # todo: log an error unless this completes within a short time
+        # puts "#{id}: reconnecting" # debug code
+        new_count = connect
+        notify_message(new_count) if new_count != @message_count
+        @message_count = new_count
     end
 
     def disconnect ; @imap.disconnect ; end
 
-    private :connect, :disconnect, :check_loop, :run, :error, :notify_message
+    private :connect, :disconnect, :reconnect,
+            :check_loop, :run, :error, :notify_message
     attr_writer :host, :password, :id, :user, :no_ssl, :cert_file, :mailbox
 end
 

data/lib/catfriend/server.rb

@@ -4,18 +4,6 @@ def self.notification_timeout
     @@notification_timeout
 end
 
-# Mixin this module and define "run" for a simple runnable/joinable thread
-module ThreadMixin
-    # Call to start a thread running via the start method.
-    def start ; @thread = Thread.new { run } ; end
-
-    # Join thread if it has started.
-    def join ; @thread.join if @thread ; end
-
-    # Kill thread if it has started.
-    def kill ; @thread.kill if @thread ; end
-end
-
 # Mixin to provide #configure which allows all instance variables with write
 # accessors declared to be set from a hash.
 module AccessorsFromHash
@@ -32,4 +20,4 @@ end
 # This class is used to signal the user made an error in their configuration.
 class ConfigError < Exception ; end
 
-end # end module
+end # end Catfriend module

data/lib/catfriend/thread.rb

@@ -0,0 +1,29 @@
+module Catfriend
+
+# Mixin this module and define "run" for a simple runnable/joinable thread
+module Thread
+    # Call to start a thread running via the start method.
+    def start ; @thread = ::Thread.new { run } ; end
+
+    # Test whether thread is currently stopped or closing down.
+    def stopped? ; @thread.nil? ; end
+
+    # Join thread if it has started.
+    def join
+        unless stopped?
+            @thread.join
+            @thread = nil
+        end
+    end
+
+
+    # Kill thread if it has started.
+    def kill
+        unless stopped?
+            @thread.kill
+            @thread = nil
+        end
+    end
+end
+
+end # end Catfriend module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catfriend
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-01 00:00:00.000000000 Z
+date: 2012-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &10589720 !ruby/object:Gem::Requirement
+  requirement: &10675900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *10589720
+  version_requirements: *10675900
 description: E-mail checker with libnotify desktop notifications.
 email:
 - catfriend@chilon.net
@@ -35,6 +35,7 @@ files:
 - lib/catfriend/server.rb
 - lib/catfriend/notify.rb
 - lib/catfriend/filetokenstack.rb
+- lib/catfriend/thread.rb
 - lib/catfriend/imap.rb
 - bin/catfriend
 homepage: https://github.com/nuisanceofcats/catfriend