git.cworth.org Git - sup/blob - lib/sup/mbox/loader.rb

   1 require 'rmail'
   2 require 'uri'
   3
   4 module Redwood
   5 module MBox
   6
   7 class Loader < Source
   8   yaml_properties :uri, :cur_offset, :usual, :archived, :id, :labels
   9   attr_accessor :labels
  10
  11   ## uri_or_fp is horrific. need to refactor.
  12   def initialize uri_or_fp, start_offset=nil, usual=true, archived=false, id=nil, labels=[]
  13     @mutex = Mutex.new
  14     @labels = ((labels || []) - LabelManager::RESERVED_LABELS).uniq.freeze
  15
  16     case uri_or_fp
  17     when String
  18       uri = URI(Source.expand_filesystem_uri(uri_or_fp))
  19       raise ArgumentError, "not an mbox uri" unless uri.scheme == "mbox"
  20       raise ArgumentError, "mbox URI ('#{uri}') cannot have a host: #{uri.host}" if uri.host
  21       raise ArgumentError, "mbox URI must have a path component" unless uri.path
  22       @f = File.open uri.path
  23       @path = uri.path
  24     else
  25       @f = uri_or_fp
  26       @path = uri_or_fp.path
  27     end
  28
  29     super uri_or_fp, start_offset, usual, archived, id
  30   end
  31
  32   def file_path; @path end
  33   def is_source_for? uri; super || (self.uri.is_a?(String) && (URI(Source.expand_filesystem_uri(uri)) == URI(Source.expand_filesystem_uri(self.uri)))) end
  34
  35   def self.suggest_labels_for path
  36     ## heuristic: use the filename as a label, unless the file
  37     ## has a path that probably represents an inbox.
  38     if File.dirname(path) =~ /\b(var|usr|spool)\b/
  39       []
  40     else
  41       [File.basename(path).downcase.intern]
  42     end
  43   end
  44
  45   def check
  46     if (cur_offset ||= start_offset) > end_offset
  47       raise OutOfSyncSourceError, "mbox file is smaller than last recorded message offset. Messages have probably been deleted by another client."
  48     end
  49   end
  50
  51   def start_offset; 0; end
  52   def end_offset; File.size @f; end
  53
  54   def load_header offset
  55     header = nil
  56     @mutex.synchronize do
  57       @f.seek offset
  58       l = @f.gets
  59       unless l =~ BREAK_RE
  60         raise OutOfSyncSourceError, "mismatch in mbox file offset #{offset.inspect}: #{l.inspect}."
  61       end
  62       header = MBox::read_header @f
  63     end
  64     header
  65   end
  66
  67   def load_message offset
  68     @mutex.synchronize do
  69       @f.seek offset
  70       begin
  71         ## don't use RMail::Mailbox::MBoxReader because it doesn't properly ignore
  72         ## "From" at the start of a message body line.
  73         string = ""
  74         l = @f.gets
  75         string << l until @f.eof? || (l = @f.gets) =~ BREAK_RE
  76         RMail::Parser.read string
  77       rescue RMail::Parser::Error => e
  78         raise FatalSourceError, "error parsing mbox file: #{e.message}"
  79       end
  80     end
  81   end
  82
  83   def raw_header offset
  84     ret = ""
  85     @mutex.synchronize do
  86       @f.seek offset
  87       until @f.eof? || (l = @f.gets) =~ /^\r*$/
  88         ret += l
  89       end
  90     end
  91     ret
  92   end
  93
  94   def raw_message offset
  95     ret = ""
  96     each_raw_message_line(offset) { |l| ret << l }
  97     ret
  98   end
  99
 100   ## apparently it's a million times faster to call this directly if
 101   ## we're just moving messages around on disk, than reading things
 102   ## into memory with raw_message.
 103   ##
 104   ## i hoped never to have to move shit around on disk but
 105   ## sup-sync-back has to do it.
 106   def each_raw_message_line offset
 107     @mutex.synchronize do
 108       @f.seek offset
 109       yield @f.gets
 110       until @f.eof? || (l = @f.gets) =~ BREAK_RE
 111         yield l
 112       end
 113     end
 114   end
 115
 116   def next
 117     returned_offset = nil
 118     next_offset = cur_offset
 119
 120     begin
 121       @mutex.synchronize do
 122         @f.seek cur_offset
 123
 124         ## cur_offset could be at one of two places here:
 125
 126         ## 1. before a \n and a mbox separator, if it was previously at
 127         ##    EOF and a new message was added; or,
 128         ## 2. at the beginning of an mbox separator (in all other
 129         ##    cases).
 130
 131         l = @f.gets or return nil
 132         if l =~ /^\s*$/ # case 1
 133           returned_offset = @f.tell
 134           @f.gets # now we're at a BREAK_RE, so skip past it
 135         else # case 2
 136           returned_offset = cur_offset
 137           ## we've already skipped past the BREAK_RE, so just go
 138         end
 139
 140         while(line = @f.gets)
 141           break if line =~ BREAK_RE
 142           next_offset = @f.tell
 143         end
 144       end
 145     rescue SystemCallError, IOError => e
 146       raise FatalSourceError, "Error reading #{@f.path}: #{e.message}"
 147     end
 148
 149     self.cur_offset = next_offset
 150     [returned_offset, (self.labels + [:unread]).uniq]
 151   end
 152 end
 153
 154 end
 155 end