NotificationTool.py 11.6 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
##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#                    Sebastien Robin <seb@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.
#
##############################################################################
from AccessControl import ClassSecurityInfo
Yusei Tahara's avatar
Yusei Tahara committed
29
from Globals import DTMLFile
30 31 32 33 34
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from Products.ERP5 import _dtmldir

35 36 37 38 39 40 41
from mimetypes import guess_type
from email.MIMEMultipart import MIMEMultipart
from email.MIMEText import MIMEText
from email.MIMEBase import MIMEBase
from email.Header import make_header
from email import Encoders

42

43 44 45 46 47 48 49 50 51 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 96 97 98 99 100 101 102 103 104 105
def buildEmailMessage(from_url, to_url, msg=None,
                      subject=None, attachment_list=None,
                      extra_headers=None):
  """
    Builds a mail message which is ready to be
    sent by Zope MailHost.

    * attachment_list is a list of dictionnaries with those keys:
     - name : name of the attachment,
     - content: data of the attachment
     - mime_type: mime-type corresponding to the attachment
    * extra_headers is a dictionnary of custom headers to add to the email.
      "X-" prefix is automatically added to those headers.
  """

  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:
    for k, v in extra_headers.items():
      message.add_header('X-%s' % k, v)

  message.add_header('Subject',
                      make_header([(subject, 'utf-8')]).encode())
  message.add_header('From', from_url)
  message.add_header('To', to_url)

  for attachment in attachment_list:
    if attachment.has_key('name'):
      attachment_name = attachment['name']
    else:
      attachment_name = ''
    # try to guess the mime type
    if not attachment.has_key('mime_type'):
      type, encoding = guess_type( attachment_name )
      if type != None:
        attachment['mime_type'] = type
      else:
        attachment['mime_type'] = 'application/octet-stream'

    # attach it
    if attachment['mime_type'] == 'text/plain':
      part = MIMEText(attachment['content'], _charset='utf-8')
    else:
      #  encode non-plaintext attachment in base64
      part = MIMEBase(*attachment['mime_type'].split('/', 1))
      part.set_payload(attachment['content'])
      Encoders.encode_base64(part)

    part.add_header('Content-Disposition',
                    'attachment; filename=%s' % attachment_name)
    message.attach(part)

  return message

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
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 )

  security.declareProtected(Permissions.UseMailhostServices, 'sendMessage')
137
  def sendMessage(self, sender=None, recipient=None, subject=None, 
138 139 140
                        message=None, attachment_list=None,
                        notifier_list=None, priority_level=None,
                        is_persistent=False):
141
    """
Yusei Tahara's avatar
Yusei Tahara committed
142
      This method provides a common API to send messages to erp5 users
143 144
      from object actions of worflow scripts.

Yusei Tahara's avatar
Yusei Tahara committed
145
      Note that you can't send message to person who don't have his own Person document.
146

Yusei Tahara's avatar
Yusei Tahara committed
147 148 149
      sender -- a login name(reference of Person document) or a Person document

      recipient -- a login name(reference of Person document) or a Person document,
150 151 152 153 154 155
                   a list of thereof

      subject -- the subject of the message

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

Yusei Tahara's avatar
Yusei Tahara committed
156 157 158
      attachment_list -- list of dictionary (optional)
                         keys are: name, content, mime_type
                         See buildEmailMessage function above.
159

160 161 162 163 164 165 166 167 168 169
      priority_level -- a priority level which is used to
                        lookup user preferences and decide
                        which notifier to use

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

      is_persistent -- whenever CRM is available, store
                       notifications as events

170
    TODO: support default notification email
171
    """
Yusei Tahara's avatar
Yusei Tahara committed
172
    portal = self.getPortalObject()
173
    catalog_tool = getToolByName(self, 'portal_catalog')
Yusei Tahara's avatar
Yusei Tahara committed
174 175 176
    mailhost = getattr(portal, 'MailHost', None)
    if mailhost is None:
      raise ValueError, "Can't find MailHost."
177

Yusei Tahara's avatar
Yusei Tahara committed
178
    # Find Default Values
179
    default_from_email = portal.email_from_address
180 181
    default_to_email = getattr(portal, 'email_to_address',
                               default_from_email)
182

Yusei Tahara's avatar
Yusei Tahara committed
183 184
    # Find "From" address
    from_address = None
185
    if isinstance(sender, basestring):
Yusei Tahara's avatar
Yusei Tahara committed
186
      sender = catalog_tool.getResultValue(portal_type='Person', reference=sender)
187 188 189
    if sender is not None:
      email_value = sender.getDefaultEmailValue()
      if email_value is not None:
Yusei Tahara's avatar
Yusei Tahara committed
190 191
        from_address = email_value.asText()
    if not from_address:
192
      # If we can not find a from address then
193
      # we fallback to default values
Yusei Tahara's avatar
Yusei Tahara committed
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 221 222 223 224
      from_address = default_from_email

    # Find "To" addresses
    to_address_list = []
    if not recipient:
      to_address_list.append(default_to_email)
    else:
      if not isinstance(recipient, (list, tuple)):
        recipient = (recipient,)
      for person in recipient:
        if isinstance(person, basestring):
          person = catalog_tool.getResultValue(portal_type='Person', reference=person)
          if person is None:
            # For backward compatibility. I recommend to use ValueError.(yusei)
            raise IndexError, "Can't find person document which reference is '%s'" % person
        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()
        to_address_list.append(email_value.asText())

    # Build and Send Messages
    for to_address in to_address_list:
      mail_message = buildEmailMessage(from_url=from_address,
                                       to_url=to_address,
                                       msg=message,
                                       subject=subject,
                                       attachment_list=attachment_list
                                       )
      mailhost.send(mail_message.as_string(), to_address, from_address)

225

226
    return
227 228 229
    # Future implemetation could consist in implementing
    # policies such as grouped notification (per hour, per day,
    # per week, etc.) depending on user preferences. It
230
    # also add some priority and selection of notification
231
    # tool (ex SMS vs. email)
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274

    # 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)
        new_event = event_module.newContent(portal_type=notifier, temp_object=is_persistent)
        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
      new_event = newTempEvent(context, '_')
      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's avatar
Jean-Paul Smets committed
275 276 277 278 279 280 281
      # 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)

282 283 284 285 286 287 288
  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's avatar
Yusei Tahara committed
289
    return self.getPortalEventTypeList()