EmailDocument.py 21.5 KB
Newer Older
1 2 3 4 5 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
##############################################################################
#
# Copyright (c) 2007 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# 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.
#
##############################################################################

import re, types
from DateTime import DateTime
from Globals import get_request
Yusei Tahara's avatar
Yusei Tahara committed
32
from AccessControl import ClassSecurityInfo, Unauthorized
33
from Products.ERP5Type.Base import WorkflowMethod
Yusei Tahara's avatar
Yusei Tahara committed
34
from Products.CMFCore.utils import getToolByName, _checkPermission
35
from Products.CMFCore.utils import _setCacheHeaders, _ViewEmulator
36
from Products.CMFDefault.utils import isHTMLSafe
37 38 39
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5.Document.TextDocument import TextDocument
from Products.ERP5.Document.File import File
Yusei Tahara's avatar
Yusei Tahara committed
40
from Products.ERP5.Document.Document import ConversionError
41 42
from Products.ERP5.Tool.NotificationTool import buildEmailMessage

43 44 45 46 47 48 49 50
try:
  from Products.MimetypesRegistry.common import MimeTypeException
except ImportError:
  class MimeTypeException(Exception):
    """
    A dummy exception class which is used when MimetypesRegistry product is
    not installed yet.
    """
51 52 53 54 55 56
try:
  import libxml2
  import libxslt
  import_libxml2 = 1
except ImportError:
  import_libxml2 = 0
57 58

from email import message_from_string
59
from email.Header import decode_header
60
from email.Utils import parsedate_tz, mktime_tz
61 62 63 64 65

DEFAULT_TEXT_FORMAT = 'text/html'
COMMASPACE = ', '
_MARKER = []

66 67
file_name_regexp = 'name="([^"]*)"'

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
class EmailDocument(File, TextDocument):
  """
    EmailDocument is a File which stores its metadata in a form which
    is similar to a TextDocument.
    A Text Document which stores raw HTML and can 
    convert it to various formats.
  """

  meta_type = 'ERP5 Email Document'
  portal_type = 'Email Document'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  isDocument = 1
  isDelivery = 1 # XXX must be removed later - only event is a delivery

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

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Version
                    , PropertySheet.Document
                    , PropertySheet.Snapshot
                    , PropertySheet.ExternalDocument
                    , PropertySheet.Url
                    , PropertySheet.TextDocument
                    , PropertySheet.Arrow
                    , PropertySheet.Task
                    , PropertySheet.ItemAggregation
                    )

  # Declarative interfaces
  __implements__ = ()

107 108 109 110
  # Searchable Text - at least search the body message
  #                 - later: search attachments too
  searchable_property_list = TextDocument.searchable_property_list

111 112 113 114 115 116 117 118 119 120 121 122 123
  # Mail processing API
  def _getMessage(self):
    result = getattr(self, '_v_message', None)
    if result is None:
      result = message_from_string(str(self.getData()))
      self._v_message = result
    return result

  security.declareProtected(Permissions.AccessContentsInformation, 'getContentInformation')
  def getContentInformation(self):
    """
    Returns the content information from the header information.
    This is used by the metadata discovery system.
124 125 126

    Header information is converted in UTF-8 since this is the standard
    way of representing strings in ERP5.
127 128 129
    """
    result = {}
    for (name, value) in self._getMessage().items():
130 131
      for text, encoding in decode_header(value):
        if encoding is not None:
132 133 134
          text = text.decode(encoding).encode('utf-8')
        if name in result:
          result[name] = '%s %s' % (result[name], text)
135
        else:
136
          result[name] = text
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
    return result

  security.declareProtected(Permissions.AccessContentsInformation, 'getAttachmentInformationList')
  def getAttachmentInformationList(self, **kw):
    """
    Returns a list of dictionnaries for every attachment. Each dictionnary
    represents the metadata of the attachment.
    
    **kw - support for listbox (TODO: improve it)
    """
    result = []
    i = 0
    for part in self._getMessage().walk():
      if not part.is_multipart():
        kw = dict(part.items())
        kw['uid'] = 'part_%s' % i
        kw['index'] = i
        if kw.has_key('Content-Disposition'):
          content_disposition = kw['Content-Disposition']
          if content_disposition.split(';')[0] == 'attachment':
157 158 159 160 161
            file_name = re.findall(file_name_regexp, content_disposition, re.MULTILINE)
            if file_name:
              kw['file_name'] = file_name[0]
            else:
              kw['file_name'] = 'attachment_%s' % i
162
          elif content_disposition.split(';')[0] == 'inline':
163 164 165 166 167
            file_name = re.findall(file_name_regexp, content_disposition, re.MULTILINE)
            if file_name:
              kw['file_name'] = file_name[0]
            else:
              kw['file_name'] = 'inline_%s' % i
168 169
          else:
            kw['file_name'] = 'part_%s' % i
170 171 172 173 174
        if kw.has_key('Content-Type'):
          content_type = kw['Content-Type']
          file_name = re.findall(file_name_regexp, content_type, re.MULTILINE)
          if file_name: kw['file_name'] = file_name[0]
          kw['content_type'] = content_type.split(';')[0]
175 176 177 178 179
        result.append(kw)
      i += 1
    return result

  security.declareProtected(Permissions.AccessContentsInformation, 'getAttachmentData')
180
  def getAttachmentData(self, index, REQUEST=None):
181 182 183 184 185 186
    """
    Returns the decoded data of an attachment.
    """
    i = 0
    for part in self._getMessage().walk():
      if index == i:
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
        # This part should be handled in skin script
        # but it was a bit easier to access items here
        if REQUEST is not None:
          kw = dict(part.items())
          RESPONSE = REQUEST.RESPONSE
          RESPONSE.setHeader('Accept-Ranges', 'bytes')
          if kw.has_key('Content-Type'):
            RESPONSE.setHeader('Content-Type', kw['Content-Type'])
            content_type = kw['Content-Type']
          elif kw.has_key('Content-type'):
            RESPONSE.setHeader('Content-Type', kw['Content-type'])
            content_type = kw['Content-type']
          else:
            content_type = None
          if kw.has_key('Content-Disposition'):
            content_disposition = kw['Content-Disposition']
          elif kw.has_key('Content-disposition'):
            content_disposition = kw['Content-disposition']
          else:
            content_disposition = None
          file_name = None
          if content_type:
            file_name = re.findall(file_name_regexp, content_type, re.MULTILINE)
          if content_disposition:
            if not file_name:
              file_name = re.findall(file_name_regexp, content_disposition, re.MULTILINE)
          if file_name:
            file_name = file_name[0]
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
215
            RESPONSE.setHeader('Content-disposition', 'attachment; filename="%s"' % file_name)
216 217 218 219 220 221 222 223
        return part.get_payload(decode=1)
      i += 1
    return KeyError, "No attachment with index %s" % index

  # Overriden methods
  security.declareProtected(Permissions.AccessContentsInformation, 'getTitle')
  def getTitle(self, default=_MARKER):
    """
224
    Returns the title from the mail subject
225 226 227 228 229 230 231
    """
    if not self.hasFile():
      # Return the standard text content if no file was provided
      if default is _MARKER:
        return self._baseGetTitle()
      else:
        return self._baseGetTitle(default)
Yusei Tahara's avatar
Yusei Tahara committed
232 233 234 235 236 237 238
    subject = self.getContentInformation().get('Subject', '')
    # Remove all newlines
    if '\r' in subject:
      subject = ''.join(subject.split('\r'))
    if '\n' in subject:
      subject = ''.join(subject.split('\n'))
    return subject
239 240 241 242 243
  
  def title_or_id(self):
    """Return the title if it is not blank and the id otherwise.
    """
    return self.getTitleOrId()
244 245 246 247

  security.declareProtected(Permissions.AccessContentsInformation, 'getStartDate')
  def getStartDate(self, default=_MARKER):
    """
248
    Returns the date from the mail date
249 250 251 252 253 254 255 256 257
    """
    if not self.hasFile():
      # Return the standard start date if no file was provided
      if default is _MARKER:
        return self._baseGetStartDate()
      else:
        return self._baseGetStartDate(default)
    date_string = self.getContentInformation().get('Date', None)
    if date_string:
258
      parsed_date_string = parsedate_tz(date_string)
259
      if parsed_date_string is not None:
260
        time = mktime_tz(parsed_date_string)
261 262
        if time:
          return DateTime(time)
263 264 265 266 267 268 269 270 271 272
    return self.getCreationDate()

  security.declareProtected(Permissions.AccessContentsInformation, 'getTextContent')
  def getTextContent(self, default=_MARKER):
    """
    Returns the content of the email as text. This is useful
    to display the content of an email.
    
    TODO: add support for legacy objects
    """
273
    if not self.hasFile() or self._baseGetTextContent() is not None:
274
      # Return the standard text content if no file was provided
275
      # Or standard text content is not empty.
276 277 278 279
      if default is _MARKER:
        return self._baseGetTextContent()
      else:
        return self._baseGetTextContent(default)
280 281

    # find from mail message
282 283 284 285
    text_result = None
    html_result = None
    for part in self._getMessage().walk():
      if part.get_content_type() == 'text/plain' and not text_result and not part.is_multipart():
286
        part_encoding = part.get_content_charset()
287
        if part_encoding not in (None, 'utf-8',):
288 289
          try:
            text_result = part.get_payload(decode=1).decode(part_encoding).encode('utf-8')
Nicolas Delaby's avatar
Nicolas Delaby committed
290
          except (UnicodeDecodeError, LookupError):
291
            text_result = part.get_payload(decode=1)
292 293
        else:
          text_result = part.get_payload(decode=1)
294
      elif part.get_content_type() == 'text/html' and not html_result and not part.is_multipart():
295
        part_encoding = part.get_content_charset()
296
        if part_encoding not in (None, 'utf-8',):
297 298
          try:
            return part.get_payload(decode=1).decode(part_encoding).encode('utf-8')
Nicolas Delaby's avatar
Nicolas Delaby committed
299
          except (UnicodeDecodeError, LookupError):
300
            return part.get_payload(decode=1)
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
        return part.get_payload(decode=1)
    return text_result

  security.declareProtected(Permissions.AccessContentsInformation, 'getTextFormat')
  def getTextFormat(self, default=_MARKER):
    """
    Returns the format of the email (text or html).
    
    TODO: add support for legacy objects
    """
    if not self.hasFile():
      # Return the standard text format if no file was provided
      if default is _MARKER:
        return self._baseGetTextFormat()
      else:
        return self._baseGetTextFormat(default)
    for part in self._getMessage().walk():
      if part.get_content_type() == 'text/html' and not part.is_multipart():
        return 'text/html'
    return 'text/plain'

  # Conversion API
  def _convertToBaseFormat(self):
    """
      Build a structure which can be later used
      to extract content information from this mail
      message.
    """
    pass

  index_html = TextDocument.index_html

333
  convert = TextDocument.convert
334 335 336

  security.declareProtected(Permissions.AccessContentsInformation, 'hasBaseData')
  def hasBaseData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
337
    """
338
      Since there is no need to convert to a base format, we consider that 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
339 340
      we always have the base format data if and only is we have
      some text defined or a file.
341 342 343 344 345 346 347 348 349 350
    """
    return self.hasFile() or self.hasTextContent()

  # Methods which can be useful to prepare a reply by email to an event
  security.declareProtected(Permissions.AccessContentsInformation, 'getReplyBody')
  def getReplyBody(self):
    """
      This is used in order to respond to a mail,
      this put a '> ' before each line of the body
    """
351 352 353 354 355
    if self.getTextFormat() == 'text/plain':
      body = self.asText()
      if body:
        return '> ' + str(body).replace('\n', '\n> ')
    elif self.getTextFormat() == 'text/html':
356 357
      return '<br/><blockquote type="cite">\n%s\n</blockquote>' %\
                                self.serializeAndCleanHtmlContentForFCKEditor()
358 359
    return ''

360 361 362 363 364 365 366 367 368
  security.declareProtected(Permissions.AccessContentsInformation,
                            'serializeAndCleanHtmlContentForFCKEditor')
  def serializeAndCleanHtmlContentForFCKEditor(self, html_text=None):
    """
    For FCKEditor Compatibility, we should remove DTD,
    blank lines and some tags in html document
    """
    if html_text is None:
      html_text = self.getTextContent()
369 370
    if html_text is None:
      return None
371 372
    if not import_libxml2:
      return html_text
373 374
    #Null char. is not allowed by parser
    html_text = html_text.replace(chr(0), '')
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
    exclude_tag_list = ('html', 'head', 'body',)
    xsl_as_string = """<?xml version="1.0" ?>
<xsl:stylesheet version="1.0"
                xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output omit-xml-declaration="yes" indent="no"/>
  <xsl:template match="/">
    <xsl:apply-templates select="*|@*|text()|comment()|processing-instruction()"/>
  </xsl:template>

  <xsl:template match="*|@*|text()|comment()|processing-instruction()">
    <xsl:copy select=".">
      <xsl:apply-templates select="*|@*|text()|comment()|processing-instruction()"/>
    </xsl:copy>
  </xsl:template>

  <xsl:template match="%s">
    <xsl:apply-templates select="*|text()|comment()|processing-instruction()"/>
  </xsl:template>

</xsl:stylesheet>
  """ % ('|'.join(exclude_tag_list))
    html_doc = libxml2.htmlParseDoc(html_text, None)
    stylesheet_doc = libxml2.parseDoc(xsl_as_string)
    stylesheet = libxslt.parseStylesheetDoc(stylesheet_doc)
    result_doc = stylesheet.applyStylesheet(html_doc, None)
    clean_text = result_doc.serialize('utf-8', 0)
    html_doc.freeDoc()
    result_doc.freeDoc()
    stylesheet.freeStylesheet()
    #Remove All xml declarations
    clean_text = re.sub('<\?xml.*\?>', '', clean_text).strip()
    #Remove blank and new Lines
    new_text_list = []
    for line in clean_text.split('\n'):
      line = line.strip()
      if line:
        new_text_list.append(line)
412
    clean_text = '\n'.join(new_text_list)
413 414
    return clean_text

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
  security.declareProtected(Permissions.AccessContentsInformation, 'getReplySubject')
  def getReplySubject(self):
    """
      This is used in order to respond to a mail,
      this put a 'Re: ' before the orignal subject
    """
    reply_subject = self.getTitle()
    if reply_subject.find('Re: ') != 0:
      reply_subject = 'Re: ' + reply_subject
    return reply_subject

  security.declareProtected(Permissions.AccessContentsInformation, 'getReplyTo')
  def getReplyTo(self):
    """
      Returns the send of this message based on getContentInformation
    """
    content_information = self.getContentInformation()
    return content_information.get('Return-Path', content_information.get('From'))

  security.declareProtected(Permissions.UseMailhostServices, 'send')
  def send(self, from_url=None, to_url=None, reply_url=None, subject=None,
Yusei Tahara's avatar
Yusei Tahara committed
436
           body=None, attachment_format=None, attachment_list=None, download=False):
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    """
      Sends the current event content by email. If documents are
      attached through the aggregate category, enclose them.

      from_url - the sender of this email. If not provided
                 we will use source to find a valid
                 email address

      to_url   - the recipients of this email. If not provided
                 we will use destination category to 
                 find a list of valid email addresses

      reply_url - the email address to reply to. If nothing
                 is provided, use the email defined in 
                 preferences.

      subject  - a custom title. If not provided, we will use
                 getTitle

      body     - a body message If not provided, we will
                 use the text representation of the event
458
                 as body (UTF-8)
459

Yusei Tahara's avatar
Yusei Tahara committed
460 461 462 463
      attachment_list -- list of dictionary which contains raw data and
                         name and mimetype for attachment.
                         See NotificationTool.buildEmailMessage.

464 465 466 467 468 469 470 471 472 473 474 475
      attachment_format - defines an option format
                 to convet attachments to (ex. application/pdf)

      download - if set to True returns, the message online
                rather than sending it.

      TODO: support conversion to base format and use
      base format rather than original format

      TODO2: consider turning this method into a general method for
      any ERP5 document.
    """
Yusei Tahara's avatar
Yusei Tahara committed
476 477 478
    if not _checkPermission(Permissions.View, self):
      raise Unauthorized

479
    #
480
    # Build mail message
481
    # This part will be replaced with MailTemplate soon.
482
    #
483 484
    if body is None:
      body = self.asText()
485 486

    # Subject
487 488
    if subject is None:
      subject = self.getTitle()
489 490

    # From
491
    if from_url is None:
492 493 494 495 496 497
      sender = self.getSourceValue()
      if sender.getTitle():
        from_url = '"%s" <%s>' % (sender.getTitle(),
                                sender.getDefaultEmailText())
      else:
        from_url = sender.getDefaultEmailText()
498 499

    # Return-Path
500 501
    if reply_url is None:
      reply_url = self.portal_preferences.getPreferredEventSenderEmail()
502 503 504 505 506 507
    additional_headers = None
    if reply_url:
      additional_headers = {'Return-Path':reply_url}

    # To (multiple)
    to_url_list = []
508 509 510 511
    if to_url is None:
      for recipient in self.getDestinationValueList():
        email = recipient.getDefaultEmailText()
        if email:
512
          if recipient.getTitle():
513
            to_url_list.append('"%s" <%s>' % (recipient.getTitle(), email))
514
          else:
515
            to_url_list.append(email)
516 517 518
        else:
          raise ValueError, 'Recipient %s has no defined email' % recipient
    elif type(to_url) in types.StringTypes:
519 520 521
      to_url_list.append(to_url)

    # Attachments
Yusei Tahara's avatar
Yusei Tahara committed
522 523
    if attachment_list is None:
      attachment_list = []
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
    document_type_list = self.getPortalDocumentTypeList()
    for attachment in self.getAggregateValueList():
      mime_type = None
      content = None
      name = None
      if not attachment.getPortalType() in document_type_list:
        mime_type = 'application/pdf'
        content = attachment.asPDF() # XXX - Not implemented yet
      else:
        #
        # Document type attachment
        #

        # WARNING - this could fail since getContentType
        # is not (yet) part of Document API
        if getattr(attachment, 'getContentType', None) is not None:
          mime_type = attachment.getContentType()
        elif getattr(attachment, 'getTextFormat', None) is not None:
          mime_type = attachment.getTextFormat()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
543
        else:
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
          raise ValueError, "Cannot find mimetype of the document."

        if mime_type is not None:
          try:
            mime_type, content = attachment.convert(mime_type)
          except ConversionError:
            mime_type = attachment.getBaseContentType()
            content = attachment.getBaseData()
          except (NotImplementedError, MimeTypeException):
            pass

        if content is None:
          if getattr(attachment, 'getTextContent', None) is not None:
            content = attachment.getTextContent()
          elif getattr(attachment, 'getData', None) is not None:
            content = attachment.getData()
          elif getattr(attachment, 'getBaseData', None) is not None:
            content = attachment.getBaseData()

      if not isinstance(content, str):
        content = str(content)

      attachment_list.append({'mime_type':mime_type,
                              'content':content,
                              'name':attachment.getReference()}
                             )

571 572 573 574 575 576
    for to_url in to_url_list:
      mime_message = buildEmailMessage(from_url=from_url, to_url=to_url,
                                       msg=body, subject=subject,
                                       attachment_list=attachment_list,
                                       additional_headers=additional_headers)
      mail_message = mime_message.as_string()
577
      self.activate(activity='SQLQueue').sendMailHostMessage(mail_message)
578

579 580 581
    # Save one of mail messages.
    self.setData(mail_message)

582 583
    # Only for debugging purpose
    if download:
584
      return mail_message
585 586 587 588 589 590 591

  security.declareProtected(Permissions.UseMailhostServices, 'sendMailHostMessage')
  def sendMailHostMessage(self, message):
    """
      Send one by one
    """
    self.MailHost.send(message)
592 593 594

## Compatibility layer
#from Products.ERP5Type import Document
595
#Document.MailMessage = EmailDocument