catfriend 0.17 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3298ab27969cad7ca4f284d27fdfe153f83bbfb
-  data.tar.gz: dced1579477fff11e1acf0252908539893f6ca6f
+  metadata.gz: bf790e35894bdf6de7a9450951dca7930b8601fa
+  data.tar.gz: 81180fcbf3e255cf107e66c7971b0804fc30bc19
 SHA512:
-  metadata.gz: c16e9adb4de53431a43c83d1b681f1a9ed59e350f4f1885d9d13203b825185c644ea4177a790bfdb8bf39f7b3afd0c0ec43b574d3c7b2c1a56fde2a6c633da8c
-  data.tar.gz: 46f30291ee03d29ae6ecd795fc207f8b78c760dacc638c4b30e7a3161df86dd42399172201d9ef8baf676eb75473f5de0d1b30122aa280ecee09a28cb3fa64ee
+  metadata.gz: f43f0bc6d274435e575efdc2f5ccf5611ea375c29e539253be4cb1282026c842613e49d857296bfffe3497fa49a707723eea31ba2a573aea687c32b7f5109dc3
+  data.tar.gz: 32d5d40171b60f2dbff8e9a9210de7e48d9586d0e65351721c22729a02678f494e3a53baa41f028cd2019322742468d1144e210f33cdff83c0989d8584fdb291

data/bin/catfriend

@@ -7,7 +7,7 @@
 # Copyright:: Copyright (c) 2011-2014 James Pike
 # License:: MIT
 
-$LOAD_PATH << 'lib' if File.exists? 'lib/catfriend'
+$LOAD_PATH.unshift('lib') if File.exists? 'lib/catfriend'
 
 require 'catfriend/filetokenstack'
 require 'catfriend/imap'
@@ -47,10 +47,8 @@ def self.parse_config
 
     # obviously assigning it in a loop like this is slow but hey it's
     # only run-once config and ruby people say DRY a lot.
-    shift_tokens = lambda do
-      if tokens.empty?
-        raise ConfigError, "field #{field} requires parameter"
-      end
+    shift_tokens = -> do
+      raise ConfigError, "field #{field} requires parameter" if tokens.empty?
       return tokens.shift
     end
 
@@ -64,17 +62,15 @@ def self.parse_config
       current[:host] = shift_tokens.call
     when "notificationTimeout", "errorTimeout", "socketTimeout"
       # convert from camelCase to camel_case
-      clean_field =
-        field.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2.downcase}" }
+      clean_field = field.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2.downcase}" }
       defaults[clean_field] = shift_tokens.call
     when "checkInterval"
       shift_tokens.call # deprecated, ignore parameter
     when "cert_file"
       cert_file = shift_tokens.call
       unless File.exists? cert_file
-        raise ConfigError,
-          "non-existant SSL certificate `#{cert_file}'" +
-          ", search path: #{File.dirname(config_file)}/"
+        raise ConfigError, "non-existant SSL certificate `#{cert_file}', "
+                         + "search path: #{File.dirname(config_file)}/"
       end
       current[:cert_file] = cert_file
     when "mailbox", "id", "user", "password"
@@ -84,8 +80,7 @@ def self.parse_config
     when "work"
       current[:work_account] = true
     else
-      raise ConfigError,
-        "invalid config parameter '#{field}'"
+      raise ConfigError, "invalid config parameter '#{field}'"
     end
   end
 
@@ -96,8 +91,8 @@ def self.parse_config
 end
 
 # Main interface to the application. Reads all servers from config then runs
-# each one in a thread. The program exits when all threads encounter an
-# unrecoverable error. Perhaps I should make it exit if any thread exits.
+# each one in a thread. If the ImapServer or Dbus threads raise an error then
+# this causes the program to exit.
 def self.main args
   work_accounts = false
   foreground = false
@@ -133,21 +128,19 @@ def self.main args
     Catfriend.verbose = false unless foreground
 
     servers = parse_config
-    servers.reject! { |s| s.work_account } unless work_accounts
+    servers.reject! &:work_account unless work_accounts
     raise ConfigError, "no servers to check" if servers.empty?
 
     if foreground
       main_loop servers
     else
-      pid = fork do
-        main_loop servers
-      end
+      pid = fork { main_loop servers }
       Process.detach pid
     end
   rescue ConfigError => e
     puts "misconfiguration: #{e.message}"
   rescue Interrupt
-    servers.each { |s| s.kill }
+    servers.each &:kill
   rescue => e
     puts "unknown error #{e.message}\n#{e.backtrace.join("\n")}"
   else
@@ -158,10 +151,36 @@ def self.main args
 end
 
 def self.main_loop servers
-  dbus = DBus.new servers
+  mutex = Mutex.new
+  error_condition = ConditionVariable.new
+  dbus = DBus.new
+
+  on_error = proc do
+    mutex.synchronize { error_condition.signal }
+  end
+
+  dbus.on :disconnect, on_error
+
+  servers.each do |server|
+    server.on(:error) do |message|
+      $stderr.puts "#{server.id}: #{message}"
+      on_error
+    end
+  end
+
+  # start all child threads
   dbus.start
-  servers.each { |s| s.start }
-  servers.each { |s| s.join }
+  servers.each &:start
+
+  # then wait for an error
+  mutex.synchronize { error_condition.wait(mutex) }
+
+  # clean up and exit
+  Catfriend.whisper 'caught error condition, disconnecting from servers'
+  servers.each &:disconnect
+
+  Catfriend.whisper 'joining child threads'
+  servers.each &:join
   dbus.join
 end
 

data/catfriend.example

@@ -15,5 +15,3 @@ host insecure.work.com
 # time notification remains on screen in milliseconds
 notificationTimeout    10000
 errorTimeout           60000  # as above but for error notifications
-socketTimeout          60     # server socket timeout in seconds
-checkInterval          60     # how often to wait between checks in seconds

data/lib/catfriend/dbus.rb

@@ -1,6 +1,8 @@
-require 'catfriend/thread'
-require 'catfriend/server'
 require 'dbus'
+require 'events'
+
+require_relative 'thread'
+require_relative 'server'
 
 module Catfriend
 
@@ -8,13 +10,17 @@ SERVICE   = "org.freedesktop.Catfriend"
 PATH      = "/org/freedesktop/Catfriend"
 INTERFACE = "org.freedesktop.Catfriend.System"
 
+# Represent a DBUS server interface and includes an associated thread
+# in which to run the dbus methods.
 class DBus
   include Thread
+  include Events::Emitter
 
+  # This child class fulfils the DBus::Object interface
   class DBusObject < ::DBus::Object
-    def initialize(main, servers)
+    def initialize(main, emitter)
       @main    = main
-      @servers = servers
+      @emitter = emitter
       super PATH
     end
 
@@ -22,19 +28,17 @@ class DBus
       dbus_method :stop do
         Catfriend.whisper "received shutdown request"
         @main.quit  # this must be run from within method handler
-        @servers.each { |s| s.disconnect }
+        @emitter.emit :disconnect
       end
     end
   end
 
-  def initialize(servers = nil)
-    @servers = servers
-  end
-
+  # Start the DBus interface
   def init
     @bus = ::DBus::SessionBus.instance unless @bus
   end
 
+  # Attempt to shutdown another application listening on catfriend's address.
   def send_shutdown
     init
     service = @bus.service(SERVICE)
@@ -47,12 +51,14 @@ class DBus
     false
   end
 
+  # Call send_shutdown then start the DBus interface.
   def start_service
-    object = DBusObject.new(@main, @servers)
+    object = DBusObject.new(@main, self)
     service = @bus.request_service(SERVICE)
     service.export object
   end
 
+  # Thread mixin interface: Run the DBus server in a virtual thread
   def run
     init
     if send_shutdown

data/lib/catfriend/imap.rb

@@ -1,9 +1,11 @@
 require 'libnotify'
-require 'catfriend/server'
-require 'catfriend/thread'
-
+require 'events'
 require 'net/imap'
 
+require_relative 'server'
+require_relative 'thread'
+require_relative 'net_imap_exchange_patch'
+
 # unless I do this I get random errors from Libnotify on startup 90% of the
 # time... this could be a bug in autoload or ruby 1.9 rather than libnotify
 module Libnotify
@@ -12,13 +14,12 @@ end
 
 module Catfriend
 
-require_relative 'net_imap_exchange_patch'
-
 # This class represents a thread capable of checking and creating
 # notifications for a single mailbox on a single IMAP server.
 class ImapServer
   include Thread
   include AccessorsFromHash
+  include Events::Emitter
 
   # Create new IMAP server with optional full configuration hash.
   # If the hash is not supplied at construction a further call must be
@@ -32,15 +33,9 @@ class ImapServer
   def configure args
     super args
 
-    if not @user
-      raise ConfigError, "imap user not set"
-    end
-    if not @host
-      raise ConfigError, "imap host not set"
-    end
-    if not @password
-      raise ConfigError, "imap password not set"
-    end
+    raise ConfigError, "imap user not set" unless @user
+    raise ConfigError, "imap host not set" unless @host
+    raise ConfigError, "imap password not set" unless @password
   end
 
   # The id is a token which represents this server when displaying
@@ -50,18 +45,16 @@ class ImapServer
 
   # Raise an error related to this particular server.
   def error message
-    # consider raising notification instead?
-    puts "#{id}: #{message}"
+    emit :error, message
   end
 
   # ThreadMixin interface. This connects to the mailserver and then
-  # runs #check_loop to do the e-mail checking if the connection
+  # runs #sleep_until_change to do the e-mail checking if the connection
   # succeeds.
   def run
     begin
       @notification =
-        Libnotify.new :body => nil,
-        :timeout => Catfriend.notification_timeout
+        Libnotify.new :body => nil, :timeout => Catfriend.notification_timeout
       @message_count = connect
       notify_message @message_count
       # :body => nil means summary only
@@ -71,25 +64,27 @@ class ImapServer
       error "no response to connect, try ssl"
     else
       loop {
-        check_loop
+        sleep_until_change
         break if stopping?
       }
     end
   end
 
-  # Continually waits for new e-mail raising notifications when new
-  # e-mail arrives or when error conditions happen. This methods only exits
-  # on an unrecoverable error.
-  def check_loop
+  # Waits until an event occurs which could change the message count.
+  def sleep_until_change
     @imap.idle do |r|
-      Catfriend.whisper "#{id}: #{r}"
-      next if r.instance_of? Net::IMAP::ContinuationRequest
-
-      if r.instance_of? Net::IMAP::UntaggedResponse
-        case r.name
-        when 'EXISTS', 'EXPUNGE'
-          @imap.idle_done
+      begin
+        Catfriend.whisper "#{id}: #{r}"
+        next if r.instance_of? Net::IMAP::ContinuationRequest
+
+        if r.instance_of? Net::IMAP::UntaggedResponse
+          case r.name
+          when 'EXISTS', 'EXPUNGE'
+            @imap.idle_done
+          end
         end
+      rescue => e
+        error e.message
       end
     end
 
@@ -110,20 +105,25 @@ class ImapServer
     end
   end
 
+  # Update the associated notification with message and show it if it is not
+  # already displayed.
   def notify_message message
     @notification.update :summary => "#{id}: #{message}"
     Catfriend.whisper @notification.summary
   end
 
+  # Returns false until kill/disconnect have been called.
   def stopping?
     stopped? or @stopping
   end
 
+  # Disconnect from the imap server and stop the associated thread.
   def kill
     disconnect
     super
   end
 
+  # Ask IMAP server for count of unseen messages.
   def get_unseen_count
     begin
       # fetch raises an exception when the mailbox is empty
@@ -137,7 +137,7 @@ class ImapServer
   # Connect to the configured IMAP server and return message count.
   def connect
     args = nil
-    if not @no_ssl
+    unless @no_ssl
       if @cert_file
         args = { :ssl => { :ca_file => @cert_file } }
       else
@@ -151,6 +151,9 @@ class ImapServer
     get_unseen_count
   end
 
+  # Reconnect to the server showing a "[reconnecting]" message. After
+  # reconnection then show the message count if it has changed from
+  # what was remembered before the disconnect.
   def reconnect
     notify_message "#{@message_count} [reconnecting]"
     new_count = connect
@@ -168,7 +171,7 @@ class ImapServer
     @imap.disconnect
   end
 
-  private :connect, :reconnect, :check_loop, :run, :error, :notify_message
+  private :connect, :reconnect, :sleep_until_change, :run, :error, :notify_message
 
   attr_writer :host, :password, :id, :user, :no_ssl, :cert_file, :mailbox
   attr_accessor :work_account

data/lib/catfriend/net_imap_exchange_patch.rb

@@ -1,5 +1,8 @@
 require 'net/imap'
 
+# This patch is needed because microsoft exchange servers do not correctly implement
+# the IMAP specification. Specifially Net::IMAP#status will not work without it.
+#
 # source:
 # http://claudiofloreani.blogspot.co.uk/2012/01/monkeypatching-ruby-imap-class-to-build.html
 # thank you!

data/lib/catfriend/thread.rb

@@ -16,7 +16,6 @@ module Thread
     end
   end
 
-
   # Kill thread if it has started.
   def kill
     unless stopped?

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: catfriend
 version: !ruby/object:Gem::Version
-  version: '0.17'
+  version: '0.18'
 platform: ruby
 authors:
 - James Pike
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libnotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: events
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: E-mail checker with libnotify desktop notifications.
 email:
 - catfriend@chilon.net
@@ -59,14 +73,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- bin/catfriend
 - catfriend.example
-- lib/catfriend/server.rb
 - lib/catfriend/dbus.rb
-- lib/catfriend/thread.rb
-- lib/catfriend/net_imap_exchange_patch.rb
-- lib/catfriend/imap.rb
 - lib/catfriend/filetokenstack.rb
-- bin/catfriend
+- lib/catfriend/imap.rb
+- lib/catfriend/net_imap_exchange_patch.rb
+- lib/catfriend/server.rb
+- lib/catfriend/thread.rb
 homepage: https://github.com/nuisanceofcats/catfriend
 licenses:
 - Expat
@@ -77,17 +91,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.3'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: E-mail checker with desktop notifications.