gurgitate-mail 1.9.1 → 1.10.0

data/lib/gurgitate-mail.rb

@@ -87,10 +87,20 @@ module Gurgitate
                     spooldir homedir
                     spoolfile File.join(spooldir,"Maildir")
                     maildir spoolfile
+                elsif style[0] == MH then
+                    mh_profile_path = File.join(ENV["HOME"],".mh_profile")
+                    if File.exists?(mh_profile_path) then
+                        mh_profile = YAML.load(File.read(mh_profile_path))
+                        maildir mh_profile["Path"]
+                    else
+                        maildir File.join(ENV["HOME"],"Mail")
+                    end
+                    spoolfile File.join(maildir,"inbox")
                 else
                     spooldir "/var/spool/mail"
                     spoolfile File.join(spooldir, @passwd.name)
                 end
+
                 @folderstyle = style[0]
             else
                 raise ArgumentError, "wrong number of arguments "+

data/lib/gurgitate/deliver.rb

@@ -7,6 +7,7 @@
 
 require "gurgitate/deliver/mbox"
 require "gurgitate/deliver/maildir"
+require "gurgitate/deliver/mh"
 
 module Gurgitate
     module Deliver
@@ -38,7 +39,7 @@ module Gurgitate
             end
 
             begin
-                [MBox,Maildir].each do |mod|
+                [MBox,Maildir,MH].each do |mod|
                     if mod::check_mailbox(mailbox) then
                         extend mod
                         raise MailboxFound

data/lib/gurgitate/deliver/mh.rb

@@ -0,0 +1,137 @@
+#!/opt/bin/ruby -w
+
+require "yaml"
+
+#------------------------------------------------------------------------
+# Delivers a message to an mbox (also includes mbox detector)
+#------------------------------------------------------------------------
+
+module Gurgitate
+    module Deliver
+        module MH
+            # Checks to see if +mailbox+ is an mbox mailbox
+            # mailbox::
+            #   A string containing the path of the mailbox to save
+            #   the message to.  If it is of the form "=mailbox", it
+            #   saves the message to +Maildir+/+mailbox+.  Otherwise,
+            #   it simply saves the message to the file +mailbox+.
+            def self::check_mailbox(mailbox)
+                begin
+                    # Rather annoyingly, pretty well any directory can
+                    # be a MH mailbox, but this just checks to make sure
+                    # it's not actually a Maildir by mistake.
+                    #
+                    # I could put in a check for the path given in
+                    # $HOME/.mh_profile, but Claws-Mail uses MH mailboxes and
+                    # disregards $HOME/.mh_profile.
+                    if File.stat(mailbox).directory? and 
+                        not ( File.exists?(File.join(mailbox, "cur")) or 
+                              File.exists?(File.join(mailbox, "tmp")) or 
+                              File.exists?(File.join(mailbox, "new"))) then 
+                        return MH
+                    end
+                rescue Errno::ENOENT
+                    return nil
+                end
+            end
+
+            # Delivers the message to +mailbox+
+            # mailbox::
+            #   A string containing the path of the mailbox to save
+            #   the message to.  If it is of the form "=mailbox", it
+            #   saves the message to +Maildir+/+mailbox+.  Otherwise,
+            #   it simply saves the message to the file +mailbox+.
+            def deliver_message(mailbox) 
+                if ! File.exists? mailbox then
+                    Dir.mkdir(mailbox)
+                end
+
+                if File.exists? mailbox and not File.directory? mailbox then
+                    raise SystemError, "not a directory"
+                end
+
+                new_msgnum = next_message(mailbox) do |filehandle|
+                    filehandle.print self.to_s
+                end
+
+                update_sequences(mailbox, new_msgnum)
+            end
+
+            private
+
+            def update_sequences(mailbox, msgnum)
+                sequences = File.join(mailbox, ".mh_sequences")
+                lockfile = sequences + ".lock" # how quaint
+                loop do
+                    begin
+                        File.open(lockfile, 
+                                  File::WRONLY | 
+                                  File::CREAT | 
+                                  File::EXCL ) do |lock|
+                            File.open(sequences, 
+                                      File::RDWR | File::CREAT) do |seq|
+
+                                seq.flock(File::LOCK_EX)
+                                metadata = YAML.load(seq.read) || Hash.new
+
+                                metadata["unseen"] = update_unseen \
+                                    metadata["unseen"], msgnum
+
+                                seq.rewind
+                                metadata.each do |key, val|
+                                    seq.puts "#{key}: #{val}"
+                                end
+                                seq.truncate seq.tell
+                                seq.flock(File::LOCK_UN)
+                            end
+                        end
+
+                        File.unlink(lockfile)
+                        break
+                    rescue Errno::EEXIST
+                        # some other process is doing something, so wait a few
+                        # milliseconds until it's done
+                        sleep(0.01) 
+                    end
+                end
+            end
+
+            def update_unseen unseen, msgnum
+                prevmsg = msgnum - 1
+                if unseen
+                    unseenstring = unseen.to_s
+
+                    if unseenstring =~ /-#{prevmsg}/ then
+                        return unseenstring.sub(/\b#{prevmsg}\b/, msgnum.to_s)
+                    end
+
+                    if unseenstring.match(/\b#{prevmsg}\b/) then
+                        return "#{unseenstring}-#{msgnum}"
+                    end
+
+                    return "#{unseenstring} #{msgnum}"
+                else
+                    return msgnum
+                end
+            end
+
+            def next_message(mailbox)
+                next_msgnum = Dir.open(mailbox).map { |ent| ent.to_i }.max + 1
+                loop do
+                    begin
+                        File.open(File.join(mailbox, next_msgnum.to_s),
+                                  File::WRONLY | 
+                                  File::CREAT | 
+                                  File::EXCL ) do |filehandle|
+                            yield filehandle
+                        end
+                        break
+                    rescue Errno::EEXIST
+                        next_msgnum += 1
+                    end
+                end
+                return next_msgnum
+            end
+        end
+    end
+end

data/test/gurgitate-test.rb

@@ -31,13 +31,17 @@ class GurgitateTest < Test::Unit::TestCase
         @spoolfile = File.join(testdir, "default")
 	end
 
-    def maildirmake mailbox # per the command
+    def maildirmake mailbox # per the UNIX command
         FileUtils.mkdir mailbox
         %w/cur tmp new/.each do |subdir|
             FileUtils.mkdir File.join(mailbox, subdir)
         end
     end
 
+    def mhdirmake mailbox # per "maildirmake"
+        FileUtils.mkdir mailbox
+    end
+
     def teardown
         FileUtils.rmtree @testdir
     end

data/test/test_deliver.rb

@@ -73,4 +73,21 @@ class TC_Deliver < Test::Unit::TestCase
         assert File.exists?(contents[0])
         assert_equal File.read(contents[0]), @deliver_test.to_s
     end
+
+    def test_basic_delivery_mh
+        @deliver_test.folderstyle = Gurgitate::Deliver::MH
+        assert_nothing_raised do
+            @deliver_test.save(@spoolfile)
+        end
+
+        assert File.exists?(@spoolfile)
+        assert File.directory?(@spoolfile)
+        
+        mess = File.join(@spoolfile,"1")
+        seq  = File.join(@spoolfile,".mh_sequences")
+        assert File.exists?(mess)
+        assert File.exists?(seq)
+        assert_equal File.read(mess), @deliver_test.to_s
+        assert_equal File.read(seq), "unseen: 1\n"
+    end
 end

data/test/test_delivery.rb

@@ -4,8 +4,8 @@ require 'stringio'
 require 'fileutils'
 require 'pathname'
 require 'irb'
-require "./gurgitate-mail"
 require "test/gurgitate-test"
+require "gurgitate-mail"
 
 class TC_Delivery < GurgitateTest
     #************************************************************************

data/test/test_gurgitate_delivery.rb

@@ -4,8 +4,8 @@ require 'stringio'
 require 'fileutils'
 require 'pathname'
 require 'irb'
-require "./gurgitate-mail"
 require "test/gurgitate-test"
+require "gurgitate-mail"
 
 class TC_Gurgitate_delivery < GurgitateTest
     #************************************************************************
@@ -46,6 +46,23 @@ class TC_Gurgitate_delivery < GurgitateTest
         setup
     end
 
+    def test_detect_mhdir
+        mhdirmake @spoolfile
+
+        assert_nothing_raised do
+            @gurgitate.process { nil }
+        end
+
+        assert File.exists?(@spoolfile)
+        assert File.directory?(@spoolfile)
+        assert File.exists?(File.join(@spoolfile,"1"))
+        assert File.exists?(File.join(@spoolfile,".mh_sequences"))
+        FileUtils.rmtree @spoolfile
+        teardown
+        test_detect_mbox
+        setup
+    end
+
     def test_save_folders
         assert_nothing_raised do
             @gurgitate.process do
@@ -83,6 +100,31 @@ class TC_Gurgitate_delivery < GurgitateTest
         assert_equal 1, Dir[File.join(@folders, "test", "new", "*")].length
     end
 
+    def test_save_guess_mh
+        mhdirmake File.join(@folders,"test")
+
+        assert File.exists?(File.join(@folders, "test"))
+        assert File.stat(File.join(@folders, "test")).directory?
+
+        assert_equal 0, Dir[File.join(@folders, "test", "*")].length
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test"
+                break
+            end
+        end
+
+        assert File.exists?(File.join(@folders, "test"))
+        assert File.stat(File.join(@folders, "test")).directory?
+        assert File.exists?(File.join(@folders, "test", "1"))
+        assert File.stat(File.join(@folders, "test","1")).file?
+        assert File.exists?(File.join(@folders, "test", ".mh_sequences"))
+        assert File.stat(File.join(@folders, "test", ".mh_sequences")).file?
+        assert_equal "unseen: 1\n", 
+            File.read(File.join(@folders, "test", ".mh_sequences"))
+    end
+
     def test_save_maildir_collision
         maildirmake File.join(@folders,"test")
 
@@ -109,6 +151,33 @@ class TC_Gurgitate_delivery < GurgitateTest
         assert_equal 2, Dir[File.join(@folders, "test", "new", "*")].length
     end
 
+    def test_save_mh_collision
+        mhdirmake File.join(@folders,"test")
+
+        assert File.exists?(File.join(@folders, "test"))
+        assert File.stat(File.join(@folders, "test")).directory?
+        assert_equal 0, Dir[File.join(@folders, "test", "*")].length
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test"
+                save "=test"
+                break
+            end
+        end
+
+        assert File.exists?(File.join(@folders, "test"))
+        assert File.stat(File.join(@folders, "test")).directory?
+        assert File.exists?(File.join(@folders, "test", "1"))
+        assert File.stat(File.join(@folders, "test","1")).file?
+        assert File.exists?(File.join(@folders, "test", "2"))
+        assert File.stat(File.join(@folders, "test","2")).file?
+        assert File.exists?(File.join(@folders, "test", ".mh_sequences"))
+        assert File.stat(File.join(@folders, "test", ".mh_sequences")).file?
+        assert_equal "unseen: 1-2\n", 
+            File.read(File.join(@folders, "test", ".mh_sequences"))
+    end
+
     def test_save_create_maildir
         maildirmake @spoolfile
 
@@ -129,6 +198,26 @@ class TC_Gurgitate_delivery < GurgitateTest
         assert_equal 1, Dir[File.join(@spoolfile, ".test", "new", "*")].length
     end
 
+    def test_save_create_mh
+        maildirmake @spoolfile
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                @folderstyle = Gurgitate::Deliver::MH
+                @maildir = @spoolfile
+                save "=test"
+                break
+            end
+        end
+
+        assert File.exists?(File.join(@spoolfile, "test"))
+        assert File.stat(File.join(@spoolfile, "test")).directory?
+        assert File.exists?(File.join(@spoolfile, "test", ".mh_sequences"))
+        assert File.stat(File.join(@spoolfile, "test",".mh_sequences")).file?
+        assert File.exists?(File.join(@spoolfile, "test", "1"))
+        assert File.stat(File.join(@spoolfile, "test", "1")).file?
+    end
+
     def test_save_bad_filename
         assert_nothing_raised do
             @gurgitate.process do
@@ -209,4 +298,3 @@ class TC_Gurgitate_delivery < GurgitateTest
         assert_equal("Subject: test", mess.header("Subject"), "Subject header wrong")
     end
 end
-

data/test/test_header.rb

@@ -4,6 +4,11 @@
 # 
 #------------------------------------------------------------------------
 
+builddir = File.join(File.dirname(__FILE__),"..")
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'
@@ -11,12 +16,9 @@ require 'stringio'
 class TC_Header < Test::Unit::TestCase
 
     def setup
-        require './gurgitate-mail'
+        require 'gurgitate-mail'
     end
 
-    # def teardown
-    # end
-
     def test_simple_header
         h=Gurgitate::Header.new("From: fromheader@example.com")
         assert_equal(h.name,"From", "Simple header name is From")

data/test/test_headers.rb

@@ -40,6 +40,7 @@ EOF
         assert_equal(1,h["From"].length)
         assert_equal("From",h["From"][0].name)
         assert_equal("fromheader@example.com",h["From"][0].contents)
+        assert_equal nil, h["To"]
     end
 
     def test_changing_headers

data/test/test_process.rb

@@ -1,10 +1,16 @@
+builddir = File.join(File.dirname(__FILE__),"..")
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'
 require 'fileutils'
 require 'pathname'
 require 'irb'
-require "./gurgitate-mail"
+require "gurgitate-mail"
+require "test/gurgitate-test"
 
 class TC_Process < GurgitateTest
     #************************************************************************

data/test/test_writing.rb

@@ -1,10 +1,19 @@
 #/opt/bin/ruby -w
 
+builddir = File.join(File.dirname(__FILE__),"..")
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'
 
 class TC_Writing < Test::Unit::TestCase
+    def setup
+        require 'gurgitate-mail'
+    end
+
     def test_null_message
         assert_nothing_raised do
             Gurgitate::Mailmessage.new
@@ -102,7 +111,7 @@ class TC_Writing < Test::Unit::TestCase
         assert_equal "sender@test", mess.from
         assert_equal "recipient@test", mess.to
         assert_equal "This is a test", mess.body
-        assert_equal "From: from@test", mess.headers["From"].to_s
-        assert_equal "To: to@test", mess.headers["To"].to_s
+        assert_equal "From: from@test", (mess.headers["From"]).to_s
+        assert_equal "To: to@test", (mess.headers["To"]).to_s
     end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
+rubygems_version: 0.9.2
 specification_version: 1
 name: gurgitate-mail
 version: !ruby/object:Gem::Version 
-  version: 1.9.1
-date: 2007-12-27 00:00:00 +09:00
+  version: 1.10.0
+date: 2008-01-30 00:00:00 +09:00
 summary: gurgitate-mail is a mail filter (and a mail-delivery agent)
 require_paths: 
 - lib
@@ -30,23 +30,24 @@ authors:
 - Dave Brown
 files: 
 - lib/gurgitate-mail.rb
+- lib/gurgitate/deliver.rb
 - lib/gurgitate/headers.rb
+- lib/gurgitate/header.rb
 - lib/gurgitate/mailmessage.rb
 - lib/gurgitate/deliver/maildir.rb
 - lib/gurgitate/deliver/mbox.rb
-- lib/gurgitate/deliver.rb
-- lib/gurgitate/header.rb
+- lib/gurgitate/deliver/mh.rb
+- test/gurgitate-test.rb
+- test/runtests.rb
 - test/test_configuration.rb
-- test/test_headers.rb
-- test/test_gurgitate_delivery.rb
+- test/test_deliver.rb
 - test/test_delivery.rb
+- test/test_header.rb
 - test/test_process.rb
-- test/runtests.rb
-- test/gurgitate-test.rb
-- test/test_deliver.rb
 - test/test_rules.rb
 - test/test_writing.rb
-- test/test_header.rb
+- test/test_gurgitate_delivery.rb
+- test/test_headers.rb
 test_files: 
 - test/runtests.rb
 rdoc_options: []