class Redwood::EditMessageMode

Constants

DECORATION_LINES
FORCE_HEADERS
MULTI_HEADERS
NON_EDITABLE_HEADERS
RE_ADDRESS

Attributes

body[RW]
header[RW]
status[R]

Public Class Methods

new(opts={}) click to toggle source
Calls superclass method
# File lib/sup/modes/edit-message-mode.rb, line 61
def initialize opts={}
  @header = opts.delete(:header) || {} 
  @header_lines = []

  @body = opts.delete(:body) || []
  @body += sig_lines if $config[:edit_signature] && !opts.delete(:have_signature)

  if opts[:attachments]
    @attachments = opts[:attachments].values
    @attachment_names = opts[:attachments].keys
  else
    @attachments = []
    @attachment_names = []
  end

  begin
    hostname = File.open("/etc/mailname", "r").gets.chomp
  rescue
      nil
  end
  hostname = Socket.gethostname if hostname.nil? or hostname.empty?

  @message_id = "<#{Time.now.to_i}-sup-#{rand 10000}@#{hostname}>"
  @edited = false
  @selectors = []
  @selector_label_width = 0

  @crypto_selector =
    if CryptoManager.have_crypto?
      HorizontalSelector.new "Crypto:", [:none] + CryptoManager::OUTGOING_MESSAGE_OPERATIONS.keys, ["None"] + CryptoManager::OUTGOING_MESSAGE_OPERATIONS.values
    end
  add_selector @crypto_selector if @crypto_selector
  
  HookManager.run "before-edit", :header => @header, :body => @body

  super opts
  regen_text
end

Public Instance Methods

[](i) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 102
def [] i
  if @selectors.empty?
    @text[i]
  elsif i < @selectors.length
    @selectors[i].line @selector_label_width
  elsif i == @selectors.length
    ""
  else
    @text[i - @selectors.length - DECORATION_LINES]
  end
end
attach_file() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 161
def attach_file
  fn = BufferManager.ask_for_filename :attachment, "File name (enter for browser): "
  return unless fn
  begin
    Dir[fn].each do |f|
      @attachments << RMail::Message.make_file_attachment(f)
      @attachment_names << f
    end
    update
  rescue SystemCallError => e
    BufferManager.flash "Can't read #{fn}: #{e.message}"
  end
end
delete_attachment() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 175
def delete_attachment
  i = curpos - @attachment_lines_offset - DECORATION_LINES - 1
  if i >= 0 && i < @attachments.size && BufferManager.ask_yes_or_no("Delete attachment #{@attachment_names[i]}?")
    @attachments.delete_at i
    @attachment_names.delete_at i
    update
  end
end
edit_cc() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 129
def edit_cc; edit_field "Cc" end
edit_message() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 132
def edit_message
  @file = Tempfile.new "sup.#{self.class.name.gsub(/.*::/, '').camel_to_hyphy}"
  @file.puts format_headers(@header - NON_EDITABLE_HEADERS).first
  @file.puts
  @file.puts @body.join("\n")
  @file.close

  editor = $config[:editor] || ENV['EDITOR'] || "/usr/bin/vi"

  mtime = File.mtime @file.path
  BufferManager.shell_out "#{editor} #{@file.path}"
  @edited = true if File.mtime(@file.path) > mtime

  return @edited unless @edited

  header, @body = parse_file @file.path
  @header = header - NON_EDITABLE_HEADERS
  handle_new_text @header, @body
  update

  @edited
end
edit_message_or_field() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 117
def edit_message_or_field
  lines = DECORATION_LINES + @selectors.size
  if lines > curpos
    return
  elsif (curpos - lines) >= @header_lines.length
    edit_message
  else
    edit_field @header_lines[curpos - lines]
  end
end
edit_subject() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 130
def edit_subject; edit_field "Subject" end
edit_to() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 128
def edit_to; edit_field "To" end
handle_new_text(header, body;) click to toggle source

hook for subclasses. i hate this style of programming.

# File lib/sup/modes/edit-message-mode.rb, line 115
def handle_new_text header, body; end
killable?() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 155
def killable?
  !edited? || BufferManager.ask_yes_or_no("Discard message?")
end
lines() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 100
def lines; @text.length + (@selectors.empty? ? 0 : (@selectors.length + DECORATION_LINES)) end
unsaved?() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 159
def unsaved?; edited? end

Protected Instance Methods

add_selector(s) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 227
def add_selector s
  @selectors << s
  @selector_label_width = [@selector_label_width, s.label.length].max
end
build_message(date) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 342
def build_message date
  m = RMail::Message.new
  m.header["Content-Type"] = "text/plain; charset=#{$encoding}"
  m.body = @body.join("\n")
  m.body += sig_lines.join("\n") unless $config[:edit_signature]
  ## body must end in a newline or GPG signatures will be WRONG!
  m.body += "\n" unless m.body =~ /\n\Z/

  ## there are attachments, so wrap body in an attachment of its own
  unless @attachments.empty?
    body_m = m
    body_m.header["Content-Disposition"] = "inline"
    m = RMail::Message.new
    
    m.add_part body_m
    @attachments.each { |a| m.add_part a }
  end

  ## do whatever crypto transformation is necessary
  if @crypto_selector && @crypto_selector.val != :none
    from_email = Person.from_address(@header["From"]).email
    to_email = [@header["To"], @header["Cc"], @header["Bcc"]].flatten.compact.map { |p| Person.from_address(p).email }

    m = CryptoManager.send @crypto_selector.val, from_email, to_email, m
  end

  ## finally, set the top-level headers
  @header.each do |k, v|
    next if v.nil? || v.empty?
    m.header[k] = 
      case v
      when String
        k.match(/subject/i) ? mime_encode_subject(v) : mime_encode_address(v)
      when Array
        v.map { |v| mime_encode_address v }.join ", "
      end
  end

  m.header["Date"] = date.rfc2822
  m.header["Message-Id"] = @message_id
  m.header["User-Agent"] = "Sup/#{Redwood::VERSION}"
  m.header["Content-Transfer-Encoding"] = '8bit'
  m
end
edit_field(field) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 414
def edit_field field
  case field
  when "Subject"
    text = BufferManager.ask :subject, "Subject: ", @header[field]
     if text
       @header[field] = parse_header field, text
       update
     end
  else
    default = case field
      when *MULTI_HEADERS
        @header[field] ||= []
        @header[field].join(", ")
      else
        @header[field]
      end

    contacts = BufferManager.ask_for_contacts :people, "#{field}: ", default
    if contacts
      text = contacts.map { |s| s.full_address }.join(", ")
      @header[field] = parse_header field, text
      update
    end
  end
end
format_headers(header) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 273
def format_headers header
  header_lines = []
  headers = (FORCE_HEADERS + (header.keys - FORCE_HEADERS)).map do |h|
    lines = make_lines "#{h}:", header[h]
    lines.length.times { header_lines << h }
    lines
  end.flatten.compact
  [headers, header_lines]
end
make_lines(header, things) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 283
def make_lines header, things
  case things
  when nil, []
    [header + " "]
  when String
    [header + " " + things]
  else
    if things.empty?
      [header]
    else
      things.map_with_index do |name, i|
        raise "an array: #{name.inspect} (things #{things.inspect})" if Array === name
        if i == 0
          header + " " + name
        else
          (" " * (header.display_length + 1)) + name
        end + (i == things.length - 1 ? "" : ",")
      end
    end
  end
end
mime_encode(string) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 186
def mime_encode string
  string = [string].pack('M') # basic quoted-printable
  string.gsub!(/=\n/,'')      # .. remove trailing newline
  string.gsub!(/_/,'=96')     # .. encode underscores
  string.gsub!(/\?/,'=3F')    # .. encode question marks
  string.gsub!(/ /,'_')       # .. translate space to underscores
  "=?utf-8?q?#{string}?="
end
mime_encode_address(string) click to toggle source

Encode “bælammet mitt <user@example.com>” into “=?utf-8?q?b=C3=A6lammet_mitt?= <user@example.com>

# File lib/sup/modes/edit-message-mode.rb, line 204
def mime_encode_address string
  return string unless string.match(RE_UTF8)
  string.sub(RE_ADDRESS) { |match| mime_encode($1) + $2 }
end
mime_encode_subject(string) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 195
def mime_encode_subject string
  return string unless string.match(RE_UTF8)
  mime_encode string
end
move_cursor_left() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 209
def move_cursor_left
  if curpos < @selectors.length
    @selectors[curpos].roll_left
    buffer.mark_dirty
  else
    col_left
  end
end
move_cursor_right() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 218
def move_cursor_right
  if curpos < @selectors.length
    @selectors[curpos].roll_right
    buffer.mark_dirty
  else
    col_right
  end
end
parse_file(fn) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 251
def parse_file fn
  File.open(fn) do |f|
    header = Source.parse_raw_email_header(f).inject({}) { |h, (k, v)| h[k.capitalize] = v; h } # lousy HACK
    body = f.readlines.map { |l| l.chomp }

    header.delete_if { |k, v| NON_EDITABLE_HEADERS.member? k }
    header.each { |k, v| header[k] = parse_header k, v }

    [header, body]
  end
end
parse_header(k, v) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 263
def parse_header k, v
  if MULTI_HEADERS.include?(k)
    v.split_on_commas.map do |name|
      (p = ContactManager.contact_for(name)) && p.full_address || name
    end
  else
    v
  end
end
regen_text() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 237
def regen_text
  header, @header_lines = format_headers(@header - NON_EDITABLE_HEADERS) + [""]
  @text = header + [""] + @body
  @text += sig_lines unless $config[:edit_signature]
  
  @attachment_lines_offset = 0

  unless @attachments.empty?
    @text += [""]
    @attachment_lines_offset = @text.length
    @text += (0 ... @attachments.size).map { |i| [[:attachment_color, "+ Attachment: #{@attachment_names[i]} (#{@attachments[i].body.size.to_human_size})"]] }
  end
end
save_as_draft() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 336
def save_as_draft
  DraftManager.write_draft { |f| write_message f, false }
  BufferManager.kill_buffer buffer
  BufferManager.flash "Saved for later editing."
end
send_message() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 305
def send_message
  return false if !edited? && !BufferManager.ask_yes_or_no("Message unedited. Really send?")
  return false if $config[:confirm_no_attachments] && mentions_attachments? && @attachments.size == 0 && !BufferManager.ask_yes_or_no("You haven't added any attachments. Really send?")#" stupid ruby-mode
  return false if $config[:confirm_top_posting] && top_posting? && !BufferManager.ask_yes_or_no("You're top-posting. That makes you a bad person. Really send?") #" stupid ruby-mode

  from_email = 
    if @header["From"] =~ /<?(\S+@(\S+?))>?$/
      $1
    else
      AccountManager.default_account.email
    end

  acct = AccountManager.account_for(from_email) || AccountManager.default_account
  BufferManager.flash "Sending..."

  begin
    date = Time.now
    m = build_message date
    IO.popen(acct.sendmail, "w") { |p| p.puts m }
    raise SendmailCommandFailed, "Couldn't execute #{acct.sendmail}" unless $? == 0
    SentManager.write_sent_message(date, from_email) { |f| f.puts sanitize_body(m.to_s) }
    BufferManager.kill_buffer buffer
    BufferManager.flash "Message sent!"
    true
  rescue SystemCallError, SendmailCommandFailed, CryptoManager::Error => e
    warn "Problem sending mail: #{e.message}"
    BufferManager.flash "Problem sending mail: #{e.message}"
    false
  end
end
update() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 232
def update
  regen_text
  buffer.mark_dirty if buffer
end
write_message(f, full=true, date=Time.now) click to toggle source

TODO: remove this. redundant with write_full_message_to.

this is going to change soon: draft messages (currently written with full=false) will be output as yaml.

# File lib/sup/modes/edit-message-mode.rb, line 391
  def write_message f, full=true, date=Time.now
    raise ArgumentError, "no pre-defined date: header allowed" if @header["Date"]
    f.puts format_headers(@header).first
    f.puts <<EOS
Date: #{date.rfc2822}
Message-Id: #{@message_id}
EOS
    if full
      f.puts <<EOS
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Redwood/#{Redwood::VERSION}
EOS
    end

    f.puts
    f.puts sanitize_body(@body.join("\n"))
    f.puts sig_lines if full unless $config[:edit_signature]
  end

Private Instance Methods

mentions_attachments?() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 446
def mentions_attachments?
  @body.any? { |l| l =~ /^[^>]/ && l =~ /\battach(ment|ed|ing|)\b/i }
end
sanitize_body(body) click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 442
def sanitize_body body
  body.gsub(/^From /, ">From ")
end
sig_lines() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 454
def sig_lines
  p = Person.from_address(@header["From"])
  from_email = p && p.email

  ## first run the hook
  hook_sig = HookManager.run "signature", :header => @header, :from_email => from_email

  return [] if hook_sig == :none
  return ["", "-- "] + hook_sig.split("\n") if hook_sig

  ## no hook, do default signature generation based on config.yaml
  return [] unless from_email
  sigfn = (AccountManager.account_for(from_email) || 
           AccountManager.default_account).signature

  if sigfn && File.exists?(sigfn)
    ["", "-- "] + File.readlines(sigfn).map { |l| l.chomp }
  else
    []
  end
end
top_posting?() click to toggle source
# File lib/sup/modes/edit-message-mode.rb, line 450
def top_posting?
  @body.join("\n") =~ /(\S+)\s*Excerpts from.*\n(>.*\n)+\s*\Z/
end