MailMessage.py 9.99 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3 4 5
# Copyright (c) 2002-2006 Nexedi SARL and Contributors. All Rights Reserved.
#                         Jean-Paul Smets-Solanes <jp@nexedi.com>
#                         Kevin Deldycke          <kevin@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Globals import InitializeClass
from AccessControl import ClassSecurityInfo

33
from Products.CMFMailIn.MailMessage import MailMessage as CMFMailInMessage
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35 36 37
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.XMLObject import XMLObject
from Products.CMFCore.WorkflowCore import WorkflowMethod

38
from Products.ERP5.Document.Event import Event
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40 41 42
import smtplib

from zLOG import LOG

43 44 45 46
# TODO: support "from"/"to" field header QP decoding

# Support mail decoding in both python v2.3 and v2.4.
# See http://www.freesoft.org/CIE/RFC/1521/5.htm for 'content-transfer-encoding' explaination.
47
import base64
48 49
global supported_decoding
supported_decoding = {}
50 51
try:
  # python v2.4 API
52 53 54 55 56 57 58 59 60 61 62
  supported_decoding = {
      'base64'          : base64.b64decode
    , 'base32'          : base64.b32decode
    , 'base16'          : base64.b16decode
#    , 'quoted-printable': None
#    , 'uuencode'        : None
    # "8bit", "7bit", and "binary" values all mean that NO encoding has been performed
    , '8bit'            : None
    , '7bit'            : None
    , 'binary'          : None
    }
63 64
except AttributeError:
  # python v2.3 API
65 66 67 68 69 70 71 72 73 74
  import binascii
  supported_decoding = {
      'base64'          : base64.decodestring
    , 'quoted-printable': binascii.a2b_qp
#    , 'uuencode'        : None
    # "8bit", "7bit", and "binary" values all mean that NO encoding has been performed
    , '8bit'            : None
    , '7bit'            : None
    , 'binary'          : None
    }
75 76


77
class MailMessage(XMLObject, Event, CMFMailInMessage):
78 79 80 81
  """
    MailMessage subclasses Event objects to implement Email Events.
  """

82 83 84
  meta_type       = 'ERP5 Mail Message'
  portal_type     = 'Mail Message'
  add_permission  = Permissions.AddPortalContent
85
  isPortalContent = 1
86
  isRADContent    = 1
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.DublinCore
                    , PropertySheet.Task
                    , PropertySheet.Arrow
                    , PropertySheet.MailMessage
                    )

  def __init__(self, *args, **kw):
    XMLObject.__init__(self, *args, **kw)
103 104 105 106 107 108 109
    # Save attachments in a special variable
    attachments = kw.get('attachments', {})
    if kw.has_key('attachments'):
      del kw['attachments']
    self.attachments = attachments
    # Clean up the the message data that came from the portal_mailin tool.
    self.cleanMessage(**kw)
110 111 112

  def _edit(self, *args, **kw):
    XMLObject._edit(self, *args, **kw)
113 114
    # Input body is already clean because it came from ERP5 GUI
    self.cleanMessage(clean_body=True, **kw)
115

116
  def cleanMessage(self, clean_body=False, **kw):
117
    """
118
      Clean up the the message data to have UTF-8 encoded body and a clean header.
119
    """
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
    # Get a decoded body in UTF-8
    if clean_body == True:
      # Assume that the inputted charset is always UTF-8 and decoded
      new_body = kw['body']
    else:
      # Autodetect the charset encoding via header and get a clean body
      new_body = self.getBody()
    # Update the body to the clean one
    self.body = new_body
    # Update the charset and the encoding since the body is known has 'cleaned'
    header = self.getHeader()
    if header != None:
      header = self.setBodyCharsetFromDict(header, charset="utf-8")
      header['content-transfer-encoding'] = "binary"
    self.header = header
135

136
  def getDecodedBody(self, raw_body, encoding):
137
    """
138 139 140
      This method return a decoded body according the given parameter.
      This method use the global "supported_decoding" dict which contain decoded
        methods supported by the current python environnment.
141
    """
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    decoded_body = raw_body
    if encoding in supported_decoding.keys():
      method = supported_decoding[encoding]
      # Is the body encoded ?
      if method != None:
        decoded_body = method(raw_body)
    elif encoding not in (None, ''):
      raise 'MailMessage Body Decoding Error', "Body encoding '%s' is not supported" % (encoding)
    return decoded_body

  def getEncodedBody(self, body, output_charset="utf-8"):
    """
      Return the entire body message encoded in the given charset.
    """
    header       = self.getHeader()
    body_charset = self.getBodyCharsetFromDict(header)
    if body_charset != None and body_charset.lower() != output_charset.lower():
      unicode_body = unicode(body, body_charset)
      return unicode_body.encode(output_charset)
    return body

  def getBodyEncodingFromDict(self, header={}):
    """
      Extract the encoding of the body from header metadatas.
    """
    encoding = None
    if type(header) == type({}) and header.has_key('content-transfer-encoding'):
      encoding = header['content-transfer-encoding']
    return encoding

  def getBodyCharsetFromDict(self, header):
    """
      Extract the charset from the header.
    """
    charset = "utf-8"
177 178 179 180 181 182 183 184 185 186 187 188 189
    if header != None and header.has_key('content-type'):
      content_type = header['content-type'].replace('\n', ' ')
      content_type_info = content_type.split(';')
      for ct_info in content_type_info:
        info = ct_info.strip().lower()
        if info.startswith('charset='):
          charset = info[len('charset='):]
          # Some charset statements are quoted
          if charset.startswith('"') or charset.startswith("'"): charset = charset[1:]
          if charset.endswith(  '"') or charset.endswith(  "'"): charset = charset[:-1]
          break
    return charset

190
  def setBodyCharsetFromDict(self, header, charset):
191
    """
192
      This method update charset info of the body.
193
    """
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
    if header != None:
      # Update content-type where charset is stored
      content_type_info = []
      if header.has_key('content-type'):
        content_type = header['content-type'].replace('\n', ' ')
        content_type_info = content_type.split(';')
      # Force content-type charset to UTF-8
      new_content_type_metadata = []
      # Get previous info
      for ct_info in content_type_info:
        info = ct_info.strip().lower()
        # Bypass previous charset info
        if not info.startswith('charset='):
          new_content_type_metadata.append(ct_info.strip())
      # Add a new charset info consistent with the actual body charset encoding
      new_content_type_metadata.append("charset='%s'" % (charset))
      # Inject new content-type in the header
      header['content-type'] = ";\n ".join(new_content_type_metadata)
    return header

  def updateCharset(self, charset="utf-8"):
    """
      This method update charset info stored in the header.
      Usefull to manually debug bad emails.
    """
    header = self.getHeader()
    self.header = self.setBodyCharsetFromDict(header, charset)
221 222 223 224 225 226 227 228 229

  def getHeader(self):
    """
      Get the header dict of the message.
    """
    header = self.header
    if header == None or type(header) == type({}):
      return header
    elif type(header) == type(''):
230
      # Must do an 'eval' because the header is a dict stored as a text (see ERP5/PropertySheet/MailMessage.py)
231 232
      return eval(header)
    else:
233
      raise 'TypeError', "Type of 'header' property can't be guessed."
234

235
  def getBody(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
236
    """
237
      Get a clean decoded body.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
238
    """
239 240 241
    encoding = self.getBodyEncodingFromDict(self.getHeader())
    body_string = self.getDecodedBody(self.body, encoding)
    return self.getEncodedBody(body_string, output_charset="utf-8")
Jean-Paul Smets's avatar
Jean-Paul Smets committed
242

243 244
  def getReplyBody(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
245 246
      This is used in order to respond to a mail,
      this put a '> ' before each line of the body
247 248
    """
    reply_body = ''
249 250 251
    body = self.getBody()
    if type(body) is type('a'):
      reply_body = '> ' + body.replace('\n', '\n> ')
252 253 254 255
    return reply_body

  def getReplySubject(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
256
      This is used in order to respond to a mail,
257
      this put a 'Re: ' before the orignal subject
258 259
    """
    reply_subject = self.getTitle()
260
    if reply_subject.find('Re: ') != 0:
261 262
      reply_subject = 'Re: ' + reply_subject
    return reply_subject
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279

  def send(self, from_url=None, to_url=None, msg=None, subject=None):
    """
      Sends a reply to this mail message.
    """
    # We assume by default that we are replying to the sender
    if from_url == None:
      from_url = self.getUrlString()
    if to_url == None:
      to_url = self.getSender()
    if msg is not None and subject is not None:
      header  = "From: %s\n"    % from_url
      header += "To: %s\n\n"    % to_url
      header += "Subject: %s\n" % subject
      header += "\n"
      msg = header + msg
      self.MailHost.send( msg )