Blame view

product/ERP5/Tool/NotificationTool.py 17.5 KB
Nicolas Delaby committed
1
# -*- coding: utf-8 -*-
Jean-Paul Smets committed
2 3
##############################################################################
#
Łukasz Nowak committed
4
# Copyright (c) 2004-2009 Nexedi SA and Contributors. All Rights Reserved.
Jean-Paul Smets committed
5 6 7
#                    Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
Łukasz Nowak committed
8
# programmers who take the whole responsibility of assessing all potential
Jean-Paul Smets committed
9 10
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
Łukasz Nowak committed
11
# guarantees and support are strongly advised to contract a Free Software
Jean-Paul Smets committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# 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 AccessControl import ClassSecurityInfo
30
from Products.ERP5Type.Globals import DTMLFile
Jean-Paul Smets committed
31 32 33
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
Nicolas Delaby committed
34
from AccessControl import ModuleSecurityInfo
Jean-Paul Smets committed
35 36
from Products.ERP5 import _dtmldir

Jean-Paul Smets committed
37
from mimetypes import guess_type
Julien Muchembled committed
38 39 40 41 42 43 44
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
from email.mime.base import MIMEBase
from email.mime.audio import MIMEAudio
from email.mime.image import MIMEImage
from email.header import make_header
from email import encoders
Jean-Paul Smets committed
45

Kazuhiko Shiozaki committed
46 47
class ConversionError(Exception): pass
class MimeTypeException(Exception): pass
Jean-Paul Smets committed
48

Nicolas Delaby committed
49 50 51
security = ModuleSecurityInfo('Products.ERP5.Tool.NotificationTool')
security.declarePublic('buildEmailMessage',)

Yusei Tahara committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 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
def buildAttachmentDictList(document_list, document_type_list=()):
  """return a list of dictionary which will be used by buildEmailMessage"""
  attachment_list = []
  for attachment in document_list:
    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()
      else:
        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,
Nicolas Delaby committed
96
                            'name':attachment.getStandardFilename()}
Yusei Tahara committed
97 98 99 100
                           )
  return attachment_list


Jean-Paul Smets committed
101 102
def buildEmailMessage(from_url, to_url, msg=None,
                      subject=None, attachment_list=None,
Yusei Tahara committed
103 104
                      extra_headers=None,
                      additional_headers=None):
Jean-Paul Smets committed
105 106 107 108
  """
    Builds a mail message which is ready to be
    sent by Zope MailHost.

Łukasz Nowak committed
109
    * attachment_list is a list of dictionaries with those keys:
Jean-Paul Smets committed
110 111 112
     - name : name of the attachment,
     - content: data of the attachment
     - mime_type: mime-type corresponding to the attachment
Łukasz Nowak committed
113
    * extra_headers is a dictionary of custom headers to add to the email.
Jean-Paul Smets committed
114
      "X-" prefix is automatically added to those headers.
Yusei Tahara committed
115
    * additional_headers is similar to extra_headers, but no prefix is added.
Jean-Paul Smets committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129
  """

  if attachment_list == None:
    # Create non multi-part MIME message.
    message = MIMEText(msg, _charset='utf-8')
    attachment_list = []
  else:
    # Create multi-part MIME message.
    message = MIMEMultipart()
    message.preamble = "If you can read this, your mailreader\n" \
                        "can not handle multi-part messages!\n"
    message.attach(MIMEText(msg, _charset='utf-8'))

  if extra_headers:
Yusei Tahara committed
130 131 132 133 134 135
    for key, value in extra_headers.items():
      message.add_header('X-%s' % key, value)

  if additional_headers:
    for key, value in additional_headers.items():
      message.add_header(key, value)
Jean-Paul Smets committed
136

Julien Muchembled committed
137 138 139 140 141 142 143
  if subject:
    message.add_header('Subject',
                        make_header([(subject, 'utf-8')]).encode())
  if from_url:
    message.add_header('From', from_url)
  if to_url:
    message.add_header('To', to_url)
Jean-Paul Smets committed
144 145

  for attachment in attachment_list:
Julien Muchembled committed
146 147
    attachment_name = attachment.get('name', '')

Jean-Paul Smets committed
148 149
    # try to guess the mime type
    if not attachment.has_key('mime_type'):
Jérome Perrin committed
150 151 152
      mime_type, encoding = guess_type( attachment_name )
      if mime_type is not None:
        attachment['mime_type'] = mime_type
Jean-Paul Smets committed
153 154 155 156 157 158 159
      else:
        attachment['mime_type'] = 'application/octet-stream'

    # attach it
    if attachment['mime_type'] == 'text/plain':
      part = MIMEText(attachment['content'], _charset='utf-8')
    else:
Yusei Tahara committed
160 161 162 163 164 165 166 167 168 169 170
      major, minor = attachment['mime_type'].split('/', 1)
      if major == 'text':
        part = MIMEText(attachment['content'], _subtype=minor)
      elif major == 'image':
        part = MIMEImage(attachment['content'], _subtype=minor)
      elif major == 'audio':
        part = MIMEAudio(attachment['content'], _subtype=minor)
      else:
        #  encode non-plaintext attachment in base64      
        part = MIMEBase(major, minor)
        part.set_payload(attachment['content'])
Julien Muchembled committed
171
        encoders.encode_base64(part)
Jean-Paul Smets committed
172

Julien Muchembled committed
173 174
    part.add_header('Content-Disposition', 'attachment',
                    filename=attachment_name)
Romain Courteaud committed
175 176
    part.add_header('Content-ID', '<%s>' % \
                    ''.join(['%s' % ord(i) for i in attachment_name]))
Jean-Paul Smets committed
177 178 179 180
    message.attach(part)

  return message

Yusei Tahara committed
181

Jean-Paul Smets committed
182 183 184 185 186 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
class NotificationTool(BaseTool):
  """
    This tool manages notifications.

    It is used as a central point to send messages from one
    user to one or many users. The purpose of the tool
    is to provide an API for sending messages which is
    independent on how messages are actually going to be
    sent and when.

    It is also useful to send messages without having to
    write always the same piece of code (eg. lookup the user,
    lookup its mail, etc.).

    This early implementation only provides asynchronous
    email sending.

    Future implementations may be able to lookup user preferences
    to decide how and when to send a message to each user.
  """
  id = 'portal_notifications'
  meta_type = 'ERP5 Notification Tool'
  portal_type = 'Notification Tool'

  # Declarative Security
  security = ClassSecurityInfo()

  security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
  manage_overview = DTMLFile( 'explainNotificationTool', _dtmldir )

Yusei Tahara committed
212
  # low-level interface
Yusei Tahara committed
213
  def _sendEmailMessage(self, from_url, to_url, body=None, subject=None,
Yusei Tahara committed
214 215
                        attachment_list=None, extra_headers=None,
                        additional_headers=None, debug=False):
Yusei Tahara committed
216 217 218 219 220 221 222 223 224 225 226 227 228
    portal = self.getPortalObject()
    mailhost = getattr(portal, 'MailHost', None)
    if mailhost is None:
      raise ValueError, "Can't find MailHost."
    message = buildEmailMessage(from_url, to_url, msg=body, subject=subject,
                                attachment_list=attachment_list, extra_headers=extra_headers,
                                additional_headers=additional_headers)

    if debug:
      return message.as_string()

    mailhost.send(messageText=message.as_string(), mto=to_url, mfrom=from_url)

Yusei Tahara committed
229
  # high-level interface
Jean-Paul Smets committed
230
  security.declareProtected(Permissions.UseMailhostServices, 'sendMessage')
Yusei Tahara committed
231
  def sendMessage(self, sender=None, recipient=None, subject=None,
Yusei Tahara committed
232 233
                  message=None,
                  attachment_list=None, attachment_document_list=None,
Yusei Tahara committed
234 235 236
                  notifier_list=None, priority_level=None,
                  store_as_event=False,
                  message_text_format='text/plain',
Nicolas Delaby committed
237 238
                  event_keyword_argument_dict=None,
                  portal_type_list=None):
Jean-Paul Smets committed
239
    """
Yusei Tahara committed
240
      This method provides a common API to send messages to erp5 users
Łukasz Nowak committed
241
      from object actions of workflow scripts.
Jean-Paul Smets committed
242

Yusei Tahara committed
243
      Note that you can't send message to person who don't have his own Person document.
Yusei Tahara committed
244 245
      This method provides only high-level functionality so that you can't use email address
      for sender and recipient, or raw data for attachments.
Jean-Paul Smets committed
246

Yusei Tahara committed
247 248 249
      sender -- a login name(reference of Person document) or a Person document

      recipient -- a login name(reference of Person document) or a Person document,
Jean-Paul Smets committed
250 251 252 253 254 255
                   a list of thereof

      subject -- the subject of the message

      message -- the text of the message (already translated)

Yusei Tahara committed
256 257 258 259
      attachment_list -- list of dictionary which contains raw data and
                         name and mimetype for attachment.
                         See buildEmailMessage.

Yusei Tahara committed
260 261
      attachment_document_list -- list of document (optional)
                                  which will be attachment.
Jean-Paul Smets committed
262

Jean-Paul Smets committed
263 264 265
      priority_level -- a priority level which is used to
                        lookup user preferences and decide
                        which notifier to use
Yusei Tahara committed
266
                        XXX Not implemented yet!!
Jean-Paul Smets committed
267 268 269 270

      notifier_list -- a list of portal type names to use
                       to send the event

Yusei Tahara committed
271 272 273 274 275
      store_as_event -- whenever CRM is available, store
                        notifications as events

      event_keyword_argument_dict -- additional keyword arguments which is used for
                                     constructor of event document.
Jean-Paul Smets committed
276

Nicolas Delaby committed
277 278
      portal_type_list -- Portal Type of Users

Jean-Paul Smets committed
279
    TODO: support default notification email
Jean-Paul Smets committed
280
    """
Yusei Tahara committed
281
    portal = self.getPortalObject()
Jean-Paul Smets committed
282
    catalog_tool = getToolByName(self, 'portal_catalog')
Nicolas Delaby committed
283 284
    if portal_type_list is None:
      portal_type_list = ('Person',)
Yusei Tahara committed
285 286
    # Find "From" Person
    from_person = None
Jean-Paul Smets committed
287
    if isinstance(sender, basestring):
Nicolas Delaby committed
288 289
      sender = catalog_tool.getResultValue(portal_type=portal_type_list,
                                           reference=sender)
Jean-Paul Smets committed
290 291
    if sender is not None:
      email_value = sender.getDefaultEmailValue()
Yusei Tahara committed
292 293 294 295 296 297
      if email_value is not None and email_value.asText():
        from_person = sender

    # Find "To" Person list
    to_person_list = []
    if recipient:
Yusei Tahara committed
298 299
      if not isinstance(recipient, (list, tuple)):
        recipient = (recipient,)
Nicolas Delaby committed
300 301 302 303 304
      for person in recipient:
        if isinstance(person, basestring):
          person_value = catalog_tool.getResultValue(portal_type=portal_type_list,
                                                     reference=person)
          if person_value is None:
Yusei Tahara committed
305
            # For backward compatibility. I recommend to use ValueError.(yusei)
Nicolas Delaby committed
306 307 308
            raise IndexError, "Can't find person document which reference is '%s'" % person
          else:
            person = person_value
Yusei Tahara committed
309 310 311 312
        email_value = person.getDefaultEmailValue()
        if email_value is None:
          # For backward compatibility. I recommend to use ValueError.(yusei)
          raise AttributeError, "Can't find default email address of %s" % person.getRelativeUrl()
Yusei Tahara committed
313 314 315 316
        if not email_value.asText():
          raise AttributeError, "Default email address of %s is empty" % person.getRelativeUrl()
        to_person_list.append(person)

Yusei Tahara committed
317 318 319 320 321
    # prepare low-level arguments if needed.
    low_level_kw = {}
    default_from_email = portal.email_from_address
    default_to_email = getattr(portal, 'email_to_address',
                               default_from_email)
Łukasz Nowak committed
322 323
    default_from_name = portal.title
    default_from_name = getattr(portal, 'email_from_name', default_from_name)
Yusei Tahara committed
324
    if from_person is None:
Łukasz Nowak committed
325 326 327
      # when sending without sender defined compose identifiable From header
      low_level_kw['from_url'] = '%s <%s>' % (default_from_name,
          default_from_email)
Yusei Tahara committed
328
    if not to_person_list:
Yusei Tahara committed
329
      low_level_kw['to_url'] = default_to_email
Yusei Tahara committed
330 331
    if attachment_list is not None:
      low_level_kw['attachment_list'] = attachment_list
Yusei Tahara committed
332 333 334 335 336 337

    # Make event
    available_notifier_list = self.getNotifierList()
    event_list = []
    if notifier_list is None:
      # XXX TODO: Use priority_level. Need to implement default notifier query system.
Łukasz Nowak committed
338
      # XXX       For now, we use 'Mail Message'.
Yusei Tahara committed
339 340 341 342
      notifier_list = ['Mail Message']
    if event_keyword_argument_dict is None:
      event_keyword_argument_dict = {}
    for notifier in notifier_list:
Jérome Perrin committed
343
      if notifier in available_notifier_list:
Yusei Tahara committed
344
        event = self.getDefaultModule(notifier).newContent(portal_type=notifier,
Jérome Perrin committed
345
                                                           temp_object=not store_as_event,
Yusei Tahara committed
346 347 348
                                                           **event_keyword_argument_dict)
      else:
        from Products.ERP5Type.Document import newTempEvent
Yusei Tahara committed
349
        event = newTempEvent(self, '_',
Yusei Tahara committed
350 351 352 353
                             **event_keyword_argument_dict)
      event.setSourceValue(from_person)
      event.setDestinationValueList(to_person_list)
      event.setTitle(subject)
Nicolas Delaby committed
354
      event.setContentType(message_text_format)
Yusei Tahara committed
355 356 357
      event.setTextContent(message)
      event.setAggregateValueList(attachment_document_list)
      event_list.append(event)
Yusei Tahara committed
358

Yusei Tahara committed
359
    for event in event_list:
Ivan Tyagov committed
360 361
      # XXX: this uses too low level API, instead event_workflow should be used in case 
      # of persistent ERP5 objects
Yusei Tahara committed
362
      event.send(**low_level_kw)
Yusei Tahara committed
363

Jean-Paul Smets committed
364
    return
Łukasz Nowak committed
365
    # Future implementation could consist in implementing
Jean-Paul Smets committed
366 367
    # policies such as grouped notification (per hour, per day,
    # per week, etc.) depending on user preferences. It
Jean-Paul Smets committed
368
    # also add some priority and selection of notification
Ivan Tyagov committed
369
    # tool (ex SMS vs. email)
Jean-Paul Smets committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

    # Here is a sample code of how this implementation could look like
    # (pseudo code)
    # NOTE: this implementation should also make sure that the current
    # buildEmailMessage method defined here and the Event.send method
    # are merged once for all

    if self.getNotifierList():
      # CRM is installed - so we can lookup notification preferences
      if notifier_list is None:
        # Find which notifier to use on preferences
        if priority_level not in ('low', 'medium', 'high'): # XXX Better naming required here
          priority_level = 'high'
        notifier_list = self.preferences.getPreference(
              'preferred_%s_priority_nofitier_list' % priority_level)
      event_list = []
      for notifier in notifier_list:
        event_module = self.getDefaultModule(notifier)
Yusei Tahara committed
388
        new_event = event_module.newContent(portal_type=notifier, temp_object=store_as_event)
Jean-Paul Smets committed
389 390 391 392 393
        event_list.append(new_event)
    else:
      # CRM is not installed - only notification by email is possible
      # So create a temp object directly
      from Products.ERP5Type.Document import newTempEvent
Jérome Perrin committed
394
      new_event = newTempEvent(self, '_')
Jean-Paul Smets committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
      event_list = [new_event]

    if event in event_list:
      # We try to build events using the same parameters as the one
      # we were provided for notification.
      # The handling of attachment is still an open question:
      # either use relation (to prevent duplication) or keep
      # a copy inside. It is probably a good idea to
      # make attachment_list polymorphic in order to be able
      # to provide different kinds of attachments can be provided
      # Either document references or binary data.
      event.build(sender=sender, recipient=recipient, subject=subject, 
                  message=message, attachment_list=attachment_list,) # Rename here and add whatever
                                                                     # parameter makes sense such
                                                                     # as text format
      event.send() # Make sure workflow transition is invoked if this is
                   # a persistent notification

Jean-Paul Smets committed
413 414 415 416 417 418 419
      # Aggregation could be handled by appending the notification
      # to an existing message rather than creating a new one.
      # Sending the message should be handled by the alarm based
      # on a date value stored on the event. This probably required
      # a new workflow state to represent events which are waiting
      # for being sent automatically. (ie. scheduled sending)

Jean-Paul Smets committed
420 421 422 423 424 425 426
  security.declareProtected(Permissions.AccessContentsInformation, 'getNotifierList')
  def getNotifierList(self):
    """
      Returns the list of available notifiers. For now
      we consider that any event is a potential notifier.
      This could change though.
    """
Yusei Tahara committed
427
    return self.getPortalEventTypeList()
Nicolas Delaby committed
428

Nicolas Delaby committed
429
  security.declareProtected(Permissions.AccessContentsInformation, 'getDocumentValue')
Nicolas Delaby committed
430 431 432 433 434 435 436 437 438
  def getDocumentValue(self, **kw):
    """
      Returns the last version of a Notification Document in selected Language.
    """
    method = self._getTypeBasedMethod('getDocumentValue')
    return method(**kw)

  def __call__(self, *args, **kw):
    return self.sendMessage(*args, **kw)