larch 1.0.0

data/LICENSE

@@ -0,0 +1,280 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS

data/bin/larch

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'highline/import' # optional dep: termios
+require 'trollop'
+
+require 'larch'
+
+module Larch
+
+  # Parse command-line options.
+  options = Trollop.options do
+    version "Larch #{APP_VERSION}\n" << APP_COPYRIGHT
+    banner <<EOS
+Larch syncs messages from one IMAP server to another. Awesomely.
+
+Usage:
+  larch --from <uri> --to <uri> [options]
+
+Required:
+EOS
+    opt :from, "URI of the source IMAP server.", :short => '-f', :type => :string, :required => true
+    opt :to,   "URI of the destination IMAP server.", :short => '-t', :type => :string, :required => true
+
+    text "\nOptions:"
+
+    # opt :dry_run,          "Don't actually do anything.", :short => '-n'
+    opt :fast_scan,        "Use a faster (but less accurate) method to scan mailboxes. This may result in messages being re-copied.", :short => :none
+    opt :from_folder,      "Source folder to copy from", :short => :none, :default => 'INBOX'
+    opt :from_pass,        "Source server password (Default: prompt)", :short => :none, :type => :string
+    opt :from_user,        "Source server username (Default: prompt)", :short => :none, :type => :string
+    opt :max_retries,      "Maximum number of times to retry after a recoverable error", :short => :none, :default => 3
+    opt :no_create_folder, "Don't create destination folders that don't already exist", :short => :none
+    opt :to_folder,        "Destination folder to copy to", :short => :none, :default => 'INBOX'
+    opt :to_pass,          "Destination server password (Default: prompt)", :short => :none, :type => :string
+    opt :to_user,          "Destination server username (Default: prompt)", :short => :none, :type => :string
+    opt :verbosity,        "Output verbosity: debug, info, warn, error, or fatal", :short => '-V', :default => 'info'
+  end
+
+  # Validate command-line options.
+  [:from, :to].each do |sym|
+    unless options[sym] =~ IMAP::REGEX_URI
+      Trollop.die sym, "must be a valid IMAP URI (e.g. imap://example.com)"
+    end
+  end
+
+  unless Logger::LEVELS.has_key?(options[:verbosity].to_sym)
+    Trollop.die :verbosity, "must be one of: #{Logger::LEVELS.keys.join(', ')}"
+  end
+
+  # Create URIs.
+  options[:from]      = URI(options[:from])
+  options[:to]        = URI(options[:to])
+  options[:from].path = '/' + CGI.escape(options[:from_folder].gsub(/^\//, ''))
+  options[:to].path   = '/' + CGI.escape(options[:to_folder].gsub(/^\//, ''))
+
+  # Prompt for usernames and passwords if necessary.
+  unless options[:from_user]
+    options[:from_user] = ask("Source username (#{options[:from].host}): ")
+  end
+
+  unless options[:from_pass]
+    options[:from_pass] = ask("Source password (#{options[:from].host}): ") {|q| q.echo = false }
+  end
+
+  unless options[:to_user]
+    options[:to_user] = ask("Destination username (#{options[:to].host}): ")
+  end
+
+  unless options[:to_pass]
+    options[:to_pass] = ask("Destination password (#{options[:to].host}): ") {|q| q.echo = false }
+  end
+
+  # Go go go!
+  init(options[:verbosity])
+
+  source = IMAP.new(options[:from], options[:from_user], options[:from_pass],
+      :fast_scan   => options[:fast_scan],
+      :max_retries => options[:max_retries])
+
+  dest = IMAP.new(options[:to], options[:to_user], options[:to_pass],
+      :create_mailbox => !options[:no_create_folder],
+      :fast_scan      => options[:fast_scan],
+      :max_retries    => options[:max_retries])
+
+  for sig in [:SIGINT, :SIGQUIT, :SIGTERM]
+    trap(sig) { @log.fatal "Interrupted (#{sig})"; summary; exit }
+  end
+
+  copy(source, dest)
+end

data/lib/larch.rb

@@ -0,0 +1,123 @@
+# Append this file's directory to the include path if it's not there already.
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
+$:.uniq!
+
+require 'cgi'
+require 'digest/md5'
+require 'net/imap'
+require 'thread'
+require 'time'
+require 'uri'
+
+require 'larch/util'
+require 'larch/errors'
+require 'larch/imap'
+require 'larch/logger'
+require 'larch/version'
+
+module Larch
+
+  class << self
+    attr_reader :log
+
+    def init(log_level = :info)
+      @log = Logger.new(log_level)
+
+      @copied    = 0
+      @failed    = 0
+      @total     = 0
+    end
+
+    # Copies messages from _source_ to _dest_ if they don't already exist in
+    # _dest_. Both _source_ and _dest_ must be instances of Larch::IMAP.
+    def copy(source, dest)
+      raise ArgumentError, "source must be a Larch::IMAP instance" unless source.is_a?(IMAP)
+      raise ArgumentError, "dest must be a Larch::IMAP instance" unless dest.is_a?(IMAP)
+
+      msgq  = SizedQueue.new(8)
+      mutex = Mutex.new
+
+      @copied    = 0
+      @failed    = 0
+      @total     = 0
+
+      @log.info "copying messages from #{source.uri} to #{dest.uri}"
+
+      source_scan = Thread.new do
+        source.scan_mailbox
+      end
+
+      dest_scan = Thread.new do
+        dest.scan_mailbox
+      end
+
+      source_scan.join
+      dest_scan.join
+
+      source_copy = Thread.new do
+        begin
+          mutex.synchronize { @total = source.length }
+
+          source.each do |id|
+            next if dest.has_message?(id)
+
+            begin
+              msgq << source.peek(id)
+            rescue Larch::IMAP::Error => e
+              # TODO: Keep failed message envelopes in a buffer for later output?
+              mutex.synchronize { @failed += 1 }
+              @log.error e.message
+              next
+            end
+          end
+
+        rescue => e
+          @log.fatal e.message
+
+        ensure
+          msgq << :finished
+        end
+      end
+
+      dest_copy = Thread.new do
+        begin
+          while msg = msgq.pop do
+            break if msg == :finished
+
+            if msg.envelope.from
+              env_from = msg.envelope.from.first
+              from = "#{env_from.mailbox}@#{env_from.host}"
+            else
+              from = '?'
+            end
+
+            @log.info "copying message: #{from} - #{msg.envelope.subject}"
+            dest << msg
+
+            mutex.synchronize { @copied += 1 }
+          end
+
+        rescue IMAP::FatalError => e
+          @log.fatal e.message
+
+        rescue => e
+          mutex.synchronize { @failed += 1 }
+          @log.error e.message
+          retry
+        end
+      end
+
+      dest_copy.join
+
+      source.disconnect
+      dest.disconnect
+
+      summary
+    end
+
+    def summary
+      @log.info "#{@copied} message(s) copied, #{@failed} failed, #{@total - @copied - @failed} untouched out of #{@total} total"
+    end
+  end
+
+end

data/lib/larch/errors.rb

@@ -0,0 +1,9 @@
+module Larch
+  class Error < StandardError; end
+
+  class IMAP
+    class Error < Larch::Error; end
+    class FatalError < Error; end
+    class NotFoundError < Error; end
+  end
+end

data/lib/larch/imap.rb

@@ -0,0 +1,418 @@
+module Larch
+
+# Manages a connection to an IMAP server and all the glorious fun that entails.
+#
+# This class borrows heavily from Sup, the source code of which should be
+# required reading if you're doing anything with IMAP in Ruby:
+# http://sup.rubyforge.org
+class IMAP
+
+  # Recoverable connection errors.
+  RECOVERABLE_ERRORS = [
+    Errno::EPIPE,
+    Errno::ETIMEDOUT,
+    Net::IMAP::NoResponseError,
+    OpenSSL::SSL::SSLError
+  ]
+
+  # Regex to capture the individual fields in an IMAP fetch command.
+  REGEX_FIELDS = /([0-9A-Z\.]+\[[^\]]+\](?:<[0-9\.]+>)?|[0-9A-Z\.]+)/
+
+  # Regex to capture a Message-Id header.
+  REGEX_MESSAGE_ID = /message-id\s*:\s*(\S+)/i
+
+  # URI format validation regex.
+  REGEX_URI = URI.regexp(['imap', 'imaps'])
+
+  # Minimum time (in seconds) allowed between mailbox scans.
+  SCAN_INTERVAL = 60
+
+  # Larch::IMAP::Message represents a transferable IMAP message which can be
+  # passed between Larch::IMAP instances.
+  Message = Struct.new(:id, :envelope, :rfc822, :flags, :internaldate)
+
+  # Initializes a new Larch::IMAP instance that will connect to the specified
+  # IMAP URI and authenticate using the specified _username_ and _password_.
+  #
+  # The following options may also be specified:
+  #
+  # [:create_mailbox]
+  #   If +true+, the specified mailbox will be created if necessary.
+  #
+  # [:fast_scan]
+  #   If +true+, a faster but less accurate method will be used to scan
+  #   mailboxes. This will speed up the initial mailbox scan, but will also
+  #   reduce the effectiveness of the message unique id generator. This is
+  #   probably acceptable when copying a very large mailbox to an empty mailbox,
+  #   but if the destination already contains messages, using this option is not
+  #   advised.
+  #
+  # [:max_retries]
+  #   After a recoverable error occurs, retry the operation up to this many
+  #   times. Default is 3.
+  #
+  def initialize(uri, username, password, options = {})
+    raise ArgumentError, "not an IMAP URI: #{uri}" unless uri.is_a?(URI) || uri =~ REGEX_URI
+    raise ArgumentError, "must provide a username and password" unless username && password
+    raise ArgumentError, "options must be a Hash" unless options.is_a?(Hash)
+
+    @uri      = uri.is_a?(URI) ? uri : URI(uri)
+    @username = username
+    @password = password
+    @options  = {:max_retries => 3}.merge(options)
+
+    @ids         = {}
+    @imap        = nil
+    @last_id     = 0
+    @last_scan   = nil
+    @message_ids = nil
+    @mutex       = Mutex.new
+
+    # Create private convenience methods (debug, info, warn, etc.) to make
+    # logging easier.
+    Logger::LEVELS.each_key do |level|
+      IMAP.class_eval do
+        define_method(level) do |msg|
+          Larch.log.log(level, "#{@username}@#{host}: #{msg}")
+        end
+
+        private level
+      end
+    end
+  end
+
+  # Appends the specified Larch::IMAP::Message to this mailbox if it doesn't
+  # already exist. Returns +true+ if the message was appended successfully,
+  # +false+ if the message already exists in the mailbox.
+  def append(message)
+    raise ArgumentError, "must provide a Larch::IMAP::Message object" unless message.is_a?(Message)
+    return false if has_message?(message)
+
+    safely do
+      @mutex.synchronize do
+        begin
+          @imap.select(mailbox)
+        rescue Net::IMAP::NoResponseError => e
+          if @options[:create_mailbox]
+            info "creating mailbox: #{mailbox}"
+            @imap.create(mailbox)
+            retry
+          end
+
+          raise
+        end
+      end
+
+      debug "appending message: #{message.id}"
+      @imap.append(mailbox, message.rfc822, message.flags, message.internaldate)
+    end
+
+    true
+  end
+  alias << append
+
+  # Connects to the IMAP server and logs in if a connection hasn't already been
+  # established.
+  def connect
+    return if @imap
+    safely {} # connect, but do nothing else
+  end
+
+  # Closes the IMAP connection if one is currently open.
+  def disconnect
+    return unless @imap
+
+    @imap.disconnect
+    @imap = nil
+
+    info "disconnected"
+  end
+  synchronized :disconnect
+
+  # Iterates through Larch message ids in this mailbox, yielding each one to the
+  # provided block.
+  def each
+    ids = @mutex.synchronize do
+      unsync_scan_mailbox
+      @ids
+    end
+
+    ids.each_key {|id| yield id }
+  end
+
+  # Gets a Net::IMAP::Envelope for the specified message id.
+  def envelope(message_id)
+    scan_mailbox
+    uid = @ids[message_id]
+
+    raise NotFoundError, "message not found: #{message_id}" if uid.nil?
+
+    debug "fetching envelope: #{message_id}"
+    imap_uid_fetch([uid], 'ENVELOPE').first.attr['ENVELOPE']
+  end
+
+  # Fetches a Larch::IMAP::Message struct representing the message with the
+  # specified Larch message id.
+  def fetch(message_id, peek = false)
+    scan_mailbox
+    uid = @ids[message_id]
+
+    raise NotFoundError, "message not found: #{message_id}" if uid.nil?
+
+    debug "#{peek ? 'peeking at' : 'fetching'} message: #{message_id}"
+    data = imap_uid_fetch([uid], [(peek ? 'BODY.PEEK[]' : 'BODY[]'), 'FLAGS', 'INTERNALDATE', 'ENVELOPE']).first
+
+    Message.new(message_id, data.attr['ENVELOPE'], data.attr['BODY[]'],
+        data.attr['FLAGS'], Time.parse(data.attr['INTERNALDATE']))
+  end
+  alias [] fetch
+
+  # Returns +true+ if a message with the specified Larch <em>message_id</em>
+  # exists in this mailbox, +false+ otherwise.
+  def has_message?(message_id)
+    scan_mailbox
+    @ids.has_key?(message_id)
+  end
+
+  # Gets the IMAP hostname.
+  def host
+    @uri.host
+  end
+
+  # Gets the number of messages in this mailbox.
+  def length
+    scan_mailbox
+    @ids.length
+  end
+  alias size length
+
+  # Gets the IMAP mailbox.
+  def mailbox
+    mb = @uri.path[1..-1]
+    mb.nil? || mb.empty? ? 'INBOX' : CGI.unescape(mb)
+  end
+
+  # Same as fetch, but doesn't mark the message as seen.
+  def peek(message_id)
+    fetch(message_id, true)
+  end
+
+  # Gets the IMAP port number.
+  def port
+    @uri.port || (ssl? ? 993 : 143)
+  end
+
+  # Fetches message headers from the current mailbox.
+  def scan_mailbox
+    return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
+
+    last_id = safely do
+      begin
+        @imap.examine(mailbox)
+      rescue Net::IMAP::NoResponseError => e
+        return if @options[:create_mailbox]
+        raise FatalError, "unable to open mailbox: #{e.message}"
+      end
+
+      @imap.responses['EXISTS'].last
+    end
+
+    @last_scan = Time.now
+    return if last_id == @last_id
+
+    range    = (@last_id + 1)..last_id
+    @last_id = last_id
+
+    info "fetching message headers #{range}" <<
+        (@options[:fast_scan] ? ' (fast scan)' : '')
+
+    fields = if @options[:fast_scan]
+      ['UID', 'RFC822.SIZE', 'INTERNALDATE']
+    else
+      "(UID BODY.PEEK[HEADER.FIELDS (MESSAGE-ID)] RFC822.SIZE INTERNALDATE)"
+    end
+
+    imap_fetch(range, fields).each do |data|
+      id = create_id(data)
+
+      unless uid = data.attr['UID']
+        error "UID not in IMAP response for message: #{id}"
+        next
+      end
+
+      if @ids.has_key?(id) && Larch.log.level == :debug
+        envelope = imap_uid_fetch([uid], 'ENVELOPE').first.attr['ENVELOPE']
+        debug "duplicate message? #{id} (Subject: #{envelope.subject})"
+      end
+
+      @ids[id] = uid
+    end
+  end
+  synchronized :scan_mailbox
+
+  # Gets the SSL status.
+  def ssl?
+    @uri.scheme == 'imaps'
+  end
+
+  # Gets the IMAP URI.
+  def uri
+    @uri.to_s
+  end
+
+  private
+
+  # Creates an id suitable for uniquely identifying a specific message across
+  # servers (we hope).
+  #
+  # If the given message data includes a valid Message-Id header, then that will
+  # be used to generate an MD5 hash. Otherwise, the hash will be generated based
+  # on the message's RFC822.SIZE and INTERNALDATE.
+  def create_id(data)
+    ['RFC822.SIZE', 'INTERNALDATE'].each do |a|
+      raise FatalError, "requested data not in IMAP response: #{a}" unless data.attr[a]
+    end
+
+    if data.attr['BODY[HEADER.FIELDS (MESSAGE-ID)]'] =~ REGEX_MESSAGE_ID
+      Digest::MD5.hexdigest($1)
+    else
+      Digest::MD5.hexdigest(sprintf('%d%d', data.attr['RFC822.SIZE'],
+          Time.parse(data.attr['INTERNALDATE']).to_i))
+    end
+  end
+
+  # Fetches the specified _fields_ for the specified message sequence id(s) from
+  # the IMAP server.
+  def imap_fetch(ids, fields)
+    data = safely { @imap.fetch(ids, fields) }
+
+    # If fields isn't an array, make it one.
+    fields = REGEX_FIELDS.match(fields).captures unless fields.is_a?(Array)
+
+    # Translate BODY.PEEK to BODY in fields, since that's how it'll come back in
+    # the response.
+    fields.map! {|f| f.sub(/^BODY\.PEEK\[/, 'BODY[') }
+
+    good_results = ids.respond_to?(:member?) ?
+        data.find_all {|i| ids.member?(i.seqno) && fields.all? {|f| i.attr.member?(f) }} :
+        data.find_all {|i| ids == i.seqno && fields.all? {|f| i.attr.member?(f) }}
+
+    if good_results.empty?
+      raise FatalError, "0 out of #{data.length} items in IMAP response for message(s) #{ids} contained all requested fields: #{fields.join(', ')}"
+    elsif good_results.length < data.length
+      error "IMAP server sent #{good_results.length} results in response to a request for #{data.length} messages"
+    end
+
+    good_results
+  end
+
+  # Fetches the specified _fields_ for the specified UID(s) from the IMAP
+  # server.
+  def imap_uid_fetch(uids, fields)
+    data = safely { @imap.uid_fetch(uids, fields) }
+
+    # If fields isn't an array, make it one.
+    fields = REGEX_FIELDS.match(fields).captures unless fields.is_a?(Array)
+
+    # Translate BODY.PEEK to BODY in fields, since that's how it'll come back in
+    # the response.
+    fields.map! {|f| f.sub(/^BODY\.PEEK\[/, 'BODY[') }
+
+    good_results = data.find_all do |i|
+      i.attr.member?('UID') && uids.member?(i.attr['UID']) &&
+          fields.all? {|f| i.attr.member?(f) }
+    end
+
+    if good_results.empty?
+      raise FatalError, "0 out of #{data.length} items in IMAP response for message UID(s) #{uids.join(', ')} contained all requested fields: #{fields.join(', ')}"
+    elsif good_results.length < data.length
+      error "IMAP server sent #{good_results.length} results in response to a request for #{data.length} messages"
+    end
+
+    good_results
+  end
+
+  # Connect if necessary, execute the given block, retry up to 3 times if a
+  # recoverable error occurs, die if an unrecoverable error occurs.
+  def safely
+    retries = 0
+
+    begin
+      unsafe_connect unless @imap
+    rescue *RECOVERABLE_ERRORS => e
+      info "#{e.class.name}: #{e.message} (will retry)"
+      raise unless (retries += 1) <= @options[:max_retries]
+
+      @imap = nil
+      sleep 1 * retries
+      retry
+    end
+
+    retries = 0
+
+    begin
+      yield
+    rescue *RECOVERABLE_ERRORS => e
+      info "#{e.class.name}: #{e.message} (will retry)"
+      raise unless (retries += 1) <= @options[:max_retries]
+
+      sleep 1 * retries
+      retry
+    end
+
+  rescue Net::IMAP::NoResponseError => e
+    raise Error, "#{e.class.name}: #{e.message} (giving up)"
+
+  rescue IOError, Net::IMAP::Error, OpenSSL::SSL::SSLError, SocketError, SystemCallError => e
+    raise FatalError, "#{e.class.name}: #{e.message} (giving up)"
+  end
+
+  def unsafe_connect
+    info "connecting..."
+
+    exception = nil
+
+    Thread.new do
+      begin
+        @imap = Net::IMAP.new(host, port, ssl?)
+
+        info "connected on port #{port}" << (ssl? ? ' using SSL' : '')
+
+        auth_methods = ['PLAIN']
+        tried        = []
+
+        ['LOGIN', 'CRAM-MD5'].each do |method|
+          auth_methods << method if @imap.capability.include?("AUTH=#{method}")
+        end
+
+        begin
+          tried << method = auth_methods.pop
+
+          debug "authenticating using #{method}"
+
+          if method == 'PLAIN'
+            @imap.login(@username, @password)
+          else
+            @imap.authenticate(method, @username, @password)
+          end
+
+          info "authenticated using #{method}"
+
+        rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
+          debug "#{method} auth failed: #{e.message}"
+          retry unless auth_methods.empty?
+
+          raise e, "#{e.message} (tried #{tried.join(', ')})"
+        end
+
+      rescue => e
+        exception = e
+        error e.message
+      end
+    end.join
+
+    raise exception if exception
+  end
+end
+
+end

data/lib/larch/logger.rb

@@ -0,0 +1,49 @@
+module Larch
+
+class Logger
+  attr_reader :level, :output
+
+  LEVELS = {
+    :fatal => 0,
+    :error => 1,
+    :warn  => 2,
+    :info  => 3,
+    :debug => 4
+  }
+
+  def initialize(level = :info, output = $stdout)
+    self.level  = level.to_sym
+    self.output = output
+  end
+
+  def const_missing(name)
+    return LEVELS[name] if LEVELS.key?(name)
+    raise NameError, "uninitialized constant: #{name}"
+  end
+
+  def method_missing(name, *args)
+    return log(name, *args) if LEVELS.key?(name)
+    raise NoMethodError, "undefined method: #{name}"
+  end
+
+  def level=(level)
+    raise ArgumentError, "invalid log level: #{level}" unless LEVELS.key?(level)
+    @level = level
+  end
+
+  def log(level, msg)
+    return true if LEVELS[level] > LEVELS[@level] || msg.nil? || msg.empty?
+    @output.puts "[#{Time.new.strftime('%b %d %H:%M:%S')}] [#{level}] #{msg}"
+    true
+
+  rescue => e
+    false
+  end
+
+  def output=(output)
+    raise ArgumentError, "output must be an instance of class IO" unless output.is_a?(IO)
+    @output = output
+  end
+end
+
+end

data/lib/larch/util.rb

@@ -0,0 +1,17 @@
+class Module
+
+  # Java-style whole-method synchronization, shamelessly stolen from Sup:
+  # http://sup.rubyforge.org. Assumes the existence of a <tt>@mutex</tt>
+  # variable.
+  def synchronized(*methods)
+    methods.each do |method|
+      class_eval <<-EOF
+        alias unsync_#{method} #{method}
+        def #{method}(*a, &b)
+          @mutex.synchronize { unsync_#{method}(*a, &b) }
+        end
+      EOF
+    end
+  end
+
+end

data/lib/larch/version.rb

@@ -0,0 +1,9 @@
+module Larch
+  APP_NAME      = 'Larch'
+  APP_VERSION   = '1.0.0'
+  APP_AUTHOR    = 'Ryan Grove'
+  APP_EMAIL     = 'ryan@wonko.com'
+  APP_URL       = 'http://github.com/rgrove/larch/'
+  APP_COPYRIGHT = 'Copyright (c) 2009 Ryan Grove <ryan@wonko.com>. All ' <<
+                  'rights reserved.'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: larch
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Grove
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.13"
+    version: 
+description: 
+email: ryan@wonko.com
+executables: 
+- larch
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- bin/larch
+- lib/larch.rb
+- lib/larch/errors.rb
+- lib/larch/imap.rb
+- lib/larch/logger.rb
+- lib/larch/util.rb
+- lib/larch/version.rb
+has_rdoc: false
+homepage: http://github.com/rgrove/larch/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Larch syncs messages from one IMAP server to another. Awesomely.
+test_files: []
+