catfriend 0.1 → 0.10

data/bin/catfriend

@@ -6,10 +6,13 @@
 # Author:: James Pike (mailto:catfriend@chilon.net)
 # Copyright:: Copyright (c) 2011 James Pike
 # License:: MIT
+require 'catfriend/filetokenstack'
+require 'catfriend/imap'
+require 'net/imap'
+
 module Catfriend
 
-require 'imap'
-require 'net/imap'
+APP_NAME = "catfriend"
 
 # xdg is optional. it outputs to stderr, so i redirect it for a while.
 stderr_bak = $stderr.dup
@@ -23,9 +26,9 @@ $stderr = stderr_bak # restore stderr
 def self.parse_config
     # xdg is optional
     begin
-        config_file = XDG['CONFIG'].find 'catfriend'
+        config_file = XDG['CONFIG'].find APP_NAME
     rescue NameError ; end
-    config_file ||= "#{ENV['HOME']}/.config/catfriend"
+    config_file ||= "#{ENV['HOME']}/.config/#{APP_NAME}"
 
     # for location of certificate file
     Dir.chdir File.dirname(config_file)
@@ -34,58 +37,54 @@ def self.parse_config
     current = {}
     defaults = {}
 
-    File.foreach(config_file) do |line|
-        tokens = line.sub(/#.*/, '').scan(/\S+/)
-
-        # parse tokens so use ugly loop instead of functional loop
-        until tokens.empty?
-            field = tokens.shift
-
-            # 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? then
-                    raise ConfigError,
-                        "field #{field} requires parameter"
-                end
-                return tokens.shift
+    tokens = FileTokenStack.new config_file
+    until tokens.empty?
+        field = tokens.shift
+
+        # 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
+            return tokens.shift
+        end
 
-            case field
-            when "host","imap"
-                # host is deprecated
-                if not current.empty? then
-                    servers << ImapServer.new(current)
-                    current = {}
-                end
-                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}" }
-                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)}/"
-                end
-                current[:cert_file] = cert_file
-            when "mailbox", "id", "user", "password"
-                current[field] = shift_tokens.call
-            when "nossl"
-                current[:no_ssl] = true
-            else
+        case field
+        when "host","imap"
+            # host is deprecated
+            if not current.empty?
+                servers << ImapServer.new(current)
+                current = {}
+            end
+            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}" }
+            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,
-                    "invalid config parameter '#{field}': #{line}"
+                      "non-existant SSL certificate `#{cert_file}'" +
+                      ", search path: #{File.dirname(config_file)}/"
             end
+            current[:cert_file] = cert_file
+        when "mailbox", "id", "user", "password"
+            current[field] = shift_tokens.call
+        when "nossl"
+            current[:no_ssl] = true
+        else
+            raise ConfigError,
+                "invalid config parameter '#{field}': #{line}"
         end
     end
 
     servers << ImapServer.new(current) unless current.empty?
+    @@notification_timeout = (defaults["notification_timeout"] or 60).to_i
 
     servers
 end
@@ -96,10 +95,18 @@ end
 def self.main
     begin
         servers = parse_config
+    rescue ConfigError => e
+        puts "misconfiguration: #{e.message}"
+    end
+
+    begin
+        # todo: daemonize here unless certain command line argument given
         servers.each { |s| s.start }
         servers.each { |s| s.join }
-    rescue ConfigError => e
-        puts "misconfiguration: " + e.message
+    rescue Interrupt
+        servers.each { |s| s.kill }
+    rescue => e
+        puts "unknown error #{e.message}\n#{e.backtrace.join("\n")}"
     end
 end
 

data/catfriend.example

@@ -0,0 +1,16 @@
+host secure.work.com
+    user      bossman@work.com
+    password  secure
+    nossl # turn off ssl, it is on by default
+
+host imap.gmail.com
+    id        fun  # used instead of host in nofifications when available
+    user      friend@gmail.com
+    password  faptap
+    cert_file server.pem  # path relative to config file
+
+# 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/filetokenstack.rb

@@ -0,0 +1,41 @@
+module Catfriend
+
+# Adapt a file to a stack of tokens.
+class FileTokenStack
+    # Initialize the token stack with the path of the file, the given token
+    # match and comment skipping regexs.
+    def initialize file, token_match = /\S+/, comment_match = /#.*/
+        @token_match   = token_match
+        @comment_match = comment_match
+        @stream = File.new file, "r"
+        @tokens = []
+        get_next_tokens
+    end
+
+    def get_next_tokens
+        # Never let the token stack get empty so that empty? can always
+        # work ahead of time.. this wouldn't be good for a network stream as
+        # it would block before delivering the last token.
+        while @tokens.empty?
+            @line = @stream.gets
+            return unless @line
+            @tokens = @line.sub(@comment_match, '').scan(@token_match) if @line
+        end
+    end
+
+    # Shift the next token from the current stream position.
+    def shift
+        ret = @tokens.shift
+        get_next_tokens
+        ret
+    end
+
+    # Report if any tokens remain
+    def empty?
+        @stream.eof and @tokens.empty?
+    end
+
+    private :get_next_tokens
+end
+
+end # end module

data/lib/{imap.rb → catfriend/imap.rb}

@@ -1,4 +1,7 @@
-require 'server'
+require 'catfriend/server'
+require 'catfriend/notify'
+
+module Catfriend
 
 # This class represents a thread capable of checking and creating
 # notifications for a single mailbox on a single IMAP server.
@@ -46,9 +49,12 @@ class ImapServer
     # runs #check_loop to do the e-mail checking if the connection
     # succeeds.
     def run
-        # connect and go
         begin
             connect
+            # :body => nil means summary only
+            @notification =
+                Libnotify.new :body => nil,
+                              :timeout => Catfriend.notification_timeout
         rescue OpenSSL::SSL::SSLError
             error "try providing ssl certificate"
         rescue Net::IMAP::NoResponseError
@@ -62,14 +68,34 @@ class ImapServer
     # e-mail arrives or when error conditions happen. This methods only exits
     # on an unrecoverable error.
     def check_loop
-        #
+        req = @imap.fetch('*', 'UID').first
+        notify_n_messages req.seqno
+
+        @imap.idle do |r|
+            next if r.instance_of? Net::IMAP::ContinuationRequest
+
+            if r.instance_of? Net::IMAP::UntaggedResponse and r.name == 'EXISTS'
+                notify_n_messages r.data
+            end
+        end
+    end
+
+    def notify_n_messages n_messages
+        @notification.update do |n|
+            n.summary = "#{id}: #{n_messages}"
+        end
+    end
+
+    def kill
+        disconnect
+        super
     end
 
     # Connect to the configured IMAP server.
     def connect
         args = nil
-        if not @no_ssl then
-            if @cert_file then
+        if not @no_ssl
+            if @cert_file
                 args = { :ssl => { :ca_file => @cert_file } }
             else
                 args = { :ssl => true }
@@ -77,10 +103,13 @@ class ImapServer
         end
         @imap = Net::IMAP.new(@host, args)
         @imap.login(@user, @password)
-        puts @imap.select(@mailbox || "INBOX")
+        @imap.select(@mailbox || "INBOX")
     end
 
-    private :connect, :check_loop, :run, :error
+    def disconnect ; @imap.disconnect ; end
+
+    private :connect, :disconnect, :check_loop, :run, :error, :notify_n_messages
     attr_writer :host, :password, :id, :user, :no_ssl, :cert_file, :mailbox
 end
 
+end # end module

data/lib/catfriend/notify.rb

@@ -0,0 +1,50 @@
+require 'libnotify'
+
+# Patch libnotify to add notification updating support. I have pushed
+# this patch to the libnotify project and it should drop with 0.7
+module Libnotify
+  # Re-open to import notification update.
+  module FFI
+    class << self
+        alias_method :orig_attach_functions!, :attach_functions!
+    end
+    def self.attach_functions!
+      attach_function :notify_notification_update,
+                      [:pointer, :string, :string, :string, :pointer],
+                      :pointer
+      orig_attach_functions!
+    end
+  end
+
+  # Re-open and add update method.
+  class API
+    # Rewrite show to store notification in an instance variable.
+    def show!
+      notify_init(self.class.to_s) or raise "notify_init failed"
+      @notification = notify_notification_new(summary, body, icon_path, nil)
+      notify_notification_set_urgency(@notification, lookup_urgency(urgency))
+      notify_notification_set_timeout(@notification, timeout || -1)
+      if append
+        notify_notification_set_hint_string(@notification, "x-canonical-append", "")
+        notify_notification_set_hint_string(@notification, "append", "")
+      end
+      if transient
+        notify_notification_set_hint_uint32(@notification, "transient", 1)
+      end
+      notify_notification_show(@notification, nil)
+    ensure
+      notify_notification_clear_hints(@notification) if (append || transient)
+    end
+
+    # Updates a previously shown notification.
+    def update(&block)
+      yield(self) if block_given?
+      if @notification
+        notify_notification_update(@notification, summary, body, icon_path, nil)
+        notify_notification_show(@notification, nil)
+      else
+        show!
+      end
+    end
+  end
+end

data/lib/{server.rb → catfriend/server.rb}

@@ -1,10 +1,19 @@
+module Catfriend
+
+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 started with start.
-    def join ; @thread.join ; 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
@@ -22,3 +31,5 @@ end
 
 # This class is used to signal the user made an error in their configuration.
 class ConfigError < Exception ; end
+
+end # end module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catfriend
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.10'
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-30 00:00:00.000000000 Z
+date: 2012-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-libnotify
-  requirement: &9103360 !ruby/object:Gem::Requirement
+  name: libnotify
+  requirement: &14394100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *9103360
-- !ruby/object:Gem::Dependency
-  name: xdg
-  requirement: &9102900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: *9102900
+  version_requirements: *14394100
 description: E-mail checker with libnotify desktop notifications.
 email:
 - catfriend@chilon.net
@@ -42,8 +31,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- lib/imap.rb
-- lib/server.rb
+- catfriend.example
+- lib/catfriend/server.rb
+- lib/catfriend/notify.rb
+- lib/catfriend/filetokenstack.rb
+- lib/catfriend/imap.rb
 - bin/catfriend
 homepage: https://github.com/nuisanceofcats/catfriend
 licenses: