]> git.cworth.org Git - sup/blobdiff - lib/sup/message.rb
minor mime fix: detect filenames without quotes around them in content-disposition
[sup] / lib / sup / message.rb
index 6c3b96bdb82468892b7d7ca16d02b8138c7ce1f5..f9693dd19cb2fad18df3767e9acba91c72f1bc0c 100644 (file)
@@ -1,5 +1,6 @@
 require 'tempfile'
 require 'time'
+require 'iconv'
 
 module Redwood
 
@@ -12,11 +13,9 @@ class MessageFormatError < StandardError; end
 ## i would like, for example, to be able to add in a ruby-talk
 ## specific module that would detect and link to /ruby-talk:\d+/
 ## sequences in the text of an email. (how sweet would that be?)
-##
-## TODO: integrate with user's addressbook to render names
-## appropriately.
 class Message
   SNIPPET_LEN = 80
+  WRAP_LEN = 80 # wrap at this width
   RE_PATTERN = /^((re|re[\[\(]\d[\]\)]):\s*)+/i
     
   ## some utility methods
@@ -27,34 +26,37 @@ class Message
   end
 
   class Attachment
-    attr_reader :content_type, :desc, :filename
-    def initialize content_type, desc, part
+    attr_reader :content_type, :filename, :content, :lines
+    def initialize content_type, filename, content
       @content_type = content_type
-      @desc = desc
-      @part = part
-      @file = nil
-      desc =~ /filename="(.*?)"/ && @filename = $1
+      @filename = filename
+      @content = content
+
+      if inlineable?
+        @lines = to_s.split("\n")
+      end
     end
 
     def view!
-      unless @file
-        @file = Tempfile.new "redwood.attachment"
-        @file.print self
-        @file.close
-      end
+      file = Tempfile.new "redwood.attachment"
+      file.print raw_content
+      file.close
 
-      ## TODO: handle unknown mime-types
-      system "/usr/bin/run-mailcap --action=view #{@content_type}:#{@file.path}"
+      system "/usr/bin/run-mailcap --action=view #{@content_type}:#{file.path} >& /dev/null"
+      $? == 0
     end
 
-    def to_s; @part.decode; end
+    def to_s; Message.decode_and_convert @content; end
+    def raw_content; @content.decode end
+
+    def inlineable?; @content_type =~ /^text\/plain/ end
   end
 
   class Text
     attr_reader :lines
     def initialize lines
       ## do some wrapping
-      @lines = lines.map { |l| l.chomp.wrap 80 }.flatten
+      @lines = lines.map { |l| l.chomp.wrap WRAP_LEN }.flatten
     end
   end
 
@@ -72,19 +74,21 @@ class Message
     end
   end
 
+
   QUOTE_PATTERN = /^\s{0,4}[>|\}]/
   BLOCK_QUOTE_PATTERN = /^-----\s*Original Message\s*----+$/
   QUOTE_START_PATTERN = /(^\s*Excerpts from)|(^\s*In message )|(^\s*In article )|(^\s*Quoting )|((wrote|writes|said|says)\s*:\s*$)/
-  SIG_PATTERN = /(^-- ?$)|(^\s*----------+\s*$)|(^\s*_________+\s*$)/
+  SIG_PATTERN = /(^-- ?$)|(^\s*----------+\s*$)|(^\s*_________+\s*$)|(^\s*--~--~-)/
+
   MAX_SIG_DISTANCE = 15 # lines from the end
   DEFAULT_SUBJECT = "(missing subject)"
   DEFAULT_SENDER = "(missing sender)"
 
   attr_reader :id, :date, :from, :subj, :refs, :replytos, :to, :source,
               :cc, :bcc, :labels, :list_address, :recipient_email, :replyto,
-              :source_info, :status
+              :source_info, :chunks
 
-  bool_reader :dirty
+  bool_reader :dirty, :source_marked_read
 
   ## if you specify a :header, will use values from that. otherwise, will try and
   ## load the header from the source.
@@ -92,8 +96,10 @@ class Message
     @source = opts[:source] or raise ArgumentError, "source can't be nil"
     @source_info = opts[:source_info] or raise ArgumentError, "source_info can't be nil"
     @snippet = opts[:snippet] || ""
-    @labels = opts[:labels] || []
+    @have_snippet = !opts[:snippet].nil?
+    @labels = [] + (opts[:labels] || [])
     @dirty = false
+    @chunks = nil
 
     read_header(opts[:header] || @source.load_header(@source_info))
   end
@@ -114,38 +120,36 @@ class Message
     end
 
     @subj = header.member?("subject") ? header["subject"].gsub(/\s+/, " ").gsub(/\s+$/, "") : DEFAULT_SUBJECT
-    @from = Person.for header["from"]
-    @to = Person.for_several header["to"]
-    @cc = Person.for_several header["cc"]
-    @bcc = Person.for_several header["bcc"]
+    @from = PersonManager.person_for header["from"]
+    @to = PersonManager.people_for header["to"]
+    @cc = PersonManager.people_for header["cc"]
+    @bcc = PersonManager.people_for header["bcc"]
     @id = header["message-id"]
     @refs = (header["references"] || "").gsub(/[<>]/, "").split(/\s+/).flatten
     @replytos = (header["in-reply-to"] || "").scan(/<(.*?)>/).flatten
-    @replyto = Person.for header["reply-to"]
+    @replyto = PersonManager.person_for header["reply-to"]
     @list_address =
       if header["list-post"]
-        @list_address = Person.for header["list-post"].gsub(/^<mailto:|>$/, "")
+        @list_address = PersonManager.person_for header["list-post"].gsub(/^<mailto:|>$/, "")
       else
         nil
       end
 
-    @recipient_email = header["delivered-to"]
-    @status = header["status"]
+    @recipient_email = header["envelope-to"] || header["x-original-to"] || header["delivered-to"]
+    @source_marked_read = header["status"] == "RO"
   end
   private :read_header
 
-  def broken?; @source.broken?; end
-  def snippet; @snippet || to_chunks && @snippet; end
+  def snippet; @snippet || chunks && @snippet; end
   def is_list_message?; !@list_address.nil?; end
-  def is_draft?; DraftLoader === @source; end
+  def is_draft?; @source.is_a? DraftLoader; end
   def draft_filename
     raise "not a draft" unless is_draft?
     @source.fn_for_offset @source_info
   end
 
   def save index
-    return if broken?
-    index.update_message self if @dirty
+    index.sync_message self if @dirty
     @dirty = false
   end
 
@@ -171,15 +175,27 @@ class Message
   end
 
   ## this is called when the message body needs to actually be loaded.
-  def to_chunks
+  def load_from_source!
     @chunks ||=
-      if @source.broken?
-        [Text.new(error_message(@source.broken_msg.split("\n")))]
+      if @source.has_errors?
+        [Text.new(error_message(@source.error.message.split("\n")))]
       else
         begin
+          ## we need to re-read the header because it contains information
+          ## that we don't store in the index. actually i think it's just
+          ## the mailing list address (if any), so this is kinda overkill.
+          ## i could just store that in the index, but i think there might
+          ## be other things like that in the future, and i'd rather not
+          ## bloat the index.
+          ## actually, it's also the differentiation between to/cc/bcc,
+          ## so i will keep this.
           read_header @source.load_header(@source_info)
           message_to_chunks @source.load_message(@source_info)
-        rescue SourceError => e
+        rescue SourceError, SocketError, MessageFormatError => e
+          Redwood::log "problem getting messages from #{@source}: #{e.message}"
+          ## we need force_to_top here otherwise this window will cover
+          ## up the error message one
+          Redwood::report_broken_sources :force_to_top => true
           [Text.new(error_message(e.message))]
         end
       end
@@ -189,12 +205,15 @@ class Message
     <<EOS
 #@snippet...
 
-***********
-** ERROR **
-***********
+***********************************************************************
+ An error occurred while loading this message. It is possible that
+ the source has changed, or (in the case of remote sources) is down.
+ You can check the log for errors, though hopefully an error window
+ should have popped up at some point.
 
-An error occurred while loading this message. It is possible that the source
-has changed, or (in the case of remote sources) is down.
+ The message location was:
+ #@source##@source_info
+***********************************************************************
 
 The error message was:
   #{msg}
@@ -205,6 +224,7 @@ EOS
     begin
       @source.raw_header @source_info
     rescue SourceError => e
+      Redwood::log "problem getting messages from #{@source}: #{e.message}"
       error_message e.message
     end
   end
@@ -213,23 +233,25 @@ EOS
     begin
       @source.raw_full_message @source_info
     rescue SourceError => e
+      Redwood::log "problem getting messages from #{@source}: #{e.message}"
       error_message(e.message)
     end
   end
 
   def content
+    load_from_source!
     [
       from && "#{from.name} #{from.email}",
       to.map { |p| "#{p.name} #{p.email}" },
       cc.map { |p| "#{p.name} #{p.email}" },
       bcc.map { |p| "#{p.name} #{p.email}" },
-      to_chunks.select { |c| c.is_a? Text }.map { |c| c.lines },
+      chunks.select { |c| c.is_a? Text }.map { |c| c.lines },
       Message.normalize_subj(subj),
     ].flatten.compact.join " "
   end
 
   def basic_body_lines
-    to_chunks.find_all { |c| c.is_a?(Text) || c.is_a?(Quote) }.map { |c| c.lines }.flatten
+    chunks.find_all { |c| c.is_a?(Text) || c.is_a?(Quote) }.map { |c| c.lines }.flatten
   end
 
   def basic_header_lines
@@ -243,24 +265,71 @@ EOS
 
 private
 
-  ## everything RubyMail-specific goes here.
+  ## here's where we handle decoding mime attachments. unfortunately
+  ## but unsurprisingly, the world of mime attachments is a bit of a
+  ## mess. as an empiricist, i'm basing the following behavior on
+  ## observed mail rather than on interpretations of rfcs, so probably
+  ## this will have to be tweaked.
+  ##
+  ## the general behavior i want is: ignore content-disposition, at
+  ## least in so far as it suggests something being inline vs being an
+  ## attachment. (because really, that should be the recipient's
+  ## decision to make.) if a mime part is text/plain, then decode it
+  ## and display it inline. if it has associated filename, then make
+  ## it collapsable and individually saveable; otherwise, treat it as
+  ## regular body text.
+  ##
+  ## so, in contrast to mutt, the user is not exposed to the workings
+  ## of the gruesome slaughterhouse and sausage factory that is a
+  ## mime-encoded message, but need only see the delicious end
+  ## product.
   def message_to_chunks m
-    ret = [] <<
-      case m.header.content_type
-      when "text/plain", nil
-        raise MessageFormatError, "no message body before decode (source #@source info #@source_info)" unless
-          m.body
-        body = m.decode or raise MessageFormatError, "no message body"
-        text_to_chunks body.normalize_whitespace.split("\n")
-      when /^multipart\//
-        nil
+    if m.multipart?
+      m.body.map { |p| message_to_chunks p }.flatten.compact # recurse
+    else
+      filename =
+        ## first, paw through the headers looking for a filename
+        if m.header["Content-Disposition"] &&
+            m.header["Content-Disposition"] =~ /filename="?(.*?[^\\])("|;|$)/
+          $1
+        elsif m.header["Content-Type"] &&
+            m.header["Content-Type"] =~ /name=(.*?)(;|$)/
+          $1
+
+        ## haven't found one, but it's a non-text message. fake
+        ## it.
+        elsif m.header["Content-Type"] && m.header["Content-Type"] !~ /^text\/plain/
+          "sup-attachment-#{Time.now.to_i}-#{rand 10000}"
+        end
+
+      ## if there's a filename, we'll treat it as an attachment.
+      if filename
+        [Attachment.new(m.header.content_type, filename, m)]
+
+      ## otherwise, it's body text
       else
-        disp = m.header["Content-Disposition"] || ""
-        Attachment.new m.header.content_type, disp.gsub(/[\s\n]+/, " "), m
+        body = Message.decode_and_convert m
+        text_to_chunks body.normalize_whitespace.split("\n")
       end
-    
-    m.each_part { |p| ret << message_to_chunks(p) } if m.multipart?
-    ret.compact.flatten
+    end
+  end
+
+  def self.decode_and_convert m
+    charset =
+      if m.header.field?("content-type") && m.header.fetch("content-type") =~ /charset=(.*?)(;|$)/
+        $1
+      end
+
+    m.body && body = m.decode or raise MessageFormatError, "For some bizarre reason, RubyMail was unable to parse this message."
+
+    if charset
+      begin
+        body = Iconv.iconv($encoding, charset, body).join
+      rescue Errno::EINVAL, Iconv::InvalidEncoding, Iconv::IllegalSequence => e
+        Redwood::log "warning: error decoding message body from #{charset}: #{e.message}"
+      end
+    end
+    body
   end
 
   ## parse the lines of text into chunk objects.  the heuristics here
@@ -297,7 +366,7 @@ private
       when :quote
         newstate = nil
 
-        if line =~ QUOTE_PATTERN || line =~ QUOTE_START_PATTERN || line =~ /^\s*$/
+        if line =~ QUOTE_PATTERN || line =~ QUOTE_START_PATTERN #|| line =~ /^\s*$/
           chunk_lines << line
         elsif line =~ SIG_PATTERN && (lines.length - i) < MAX_SIG_DISTANCE
           newstate = :sig
@@ -308,8 +377,6 @@ private
         if newstate
           if chunk_lines.empty?
             # nothing
-          elsif chunk_lines.size == 1
-            chunks << Text.new(chunk_lines) # forget about one-line quotes
           else
             chunks << Quote.new(chunk_lines)
           end
@@ -317,15 +384,11 @@ private
           state = newstate
         end
 
-      when :block_quote
-        chunk_lines << line
-
-      when :sig
+      when :block_quote, :sig
         chunk_lines << line
       end
  
-      if state == :text && (@snippet.nil? || @snippet.length < SNIPPET_LEN) &&
-          line !~ /[=\*#_-]{3,}/ && line !~ /^\s*$/
+      if !@have_snippet && state == :text && (@snippet.nil? || @snippet.length < SNIPPET_LEN) && line !~ /[=\*#_-]{3,}/ && line !~ /^\s*$/
         @snippet += " " unless @snippet.empty?
         @snippet += line.gsub(/^\s+/, "").gsub(/[\r\n]/, "").gsub(/\s+/, " ")
         @snippet = @snippet[0 ... SNIPPET_LEN].chomp