addons/mail/mail_mail.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2010-today OpenERP SA (<http://www.openerp.com>)
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>
  19 #
  20 ##############################################################################
  21
  22 import base64
  23 import logging
  24 import re
  25 from urllib import urlencode
  26 from urlparse import urljoin
  27
  28 from openerp import tools
  29 from openerp import SUPERUSER_ID
  30 from openerp.addons.base.ir.ir_mail_server import MailDeliveryException
  31 from openerp.osv import fields, osv
  32 from openerp.tools.translate import _
  33
  34 _logger = logging.getLogger(__name__)
  35
  36
  37 class mail_mail(osv.Model):
  38     """ Model holding RFC2822 email messages to send. This model also provides
  39         facilities to queue and send new email messages.  """
  40     _name = 'mail.mail'
  41     _description = 'Outgoing Mails'
  42     _inherits = {'mail.message': 'mail_message_id'}
  43     _order = 'id desc'
  44
  45     _columns = {
  46         'mail_message_id': fields.many2one('mail.message', 'Message', required=True, ondelete='cascade'),
  47         'state': fields.selection([
  48             ('outgoing', 'Outgoing'),
  49             ('sent', 'Sent'),
  50             ('received', 'Received'),
  51             ('exception', 'Delivery Failed'),
  52             ('cancel', 'Cancelled'),
  53         ], 'Status', readonly=True),
  54         'auto_delete': fields.boolean('Auto Delete',
  55             help="Permanently delete this email after sending it, to save space"),
  56         'references': fields.text('References', help='Message references, such as identifiers of previous messages', readonly=1),
  57         'email_to': fields.text('To', help='Message recipients (emails)'),
  58         'recipient_ids': fields.many2many('res.partner', string='To (Partners)'),
  59         'email_cc': fields.char('Cc', help='Carbon copy message recipients'),
  60         'body_html': fields.text('Rich-text Contents', help="Rich-text/HTML message"),
  61         # Auto-detected based on create() - if 'mail_message_id' was passed then this mail is a notification
  62         # and during unlink() we will not cascade delete the parent and its attachments
  63         'notification': fields.boolean('Is Notification',
  64             help='Mail has been created to notify people of an existing mail.message'),
  65     }
  66
  67     _defaults = {
  68         'state': 'outgoing',
  69     }
  70
  71     def default_get(self, cr, uid, fields, context=None):
  72         # protection for `default_type` values leaking from menu action context (e.g. for invoices)
  73         # To remove when automatic context propagation is removed in web client
  74         if context and context.get('default_type') and context.get('default_type') not in self._all_columns['type'].column.selection:
  75             context = dict(context, default_type=None)
  76         return super(mail_mail, self).default_get(cr, uid, fields, context=context)
  77
  78     def create(self, cr, uid, values, context=None):
  79         # notification field: if not set, set if mail comes from an existing mail.message
  80         if 'notification' not in values and values.get('mail_message_id'):
  81             values['notification'] = True
  82         return super(mail_mail, self).create(cr, uid, values, context=context)
  83
  84     def unlink(self, cr, uid, ids, context=None):
  85         # cascade-delete the parent message for all mails that are not created for a notification
  86         ids_to_cascade = self.search(cr, uid, [('notification', '=', False), ('id', 'in', ids)])
  87         parent_msg_ids = [m.mail_message_id.id for m in self.browse(cr, uid, ids_to_cascade, context=context)]
  88         res = super(mail_mail, self).unlink(cr, uid, ids, context=context)
  89         self.pool.get('mail.message').unlink(cr, uid, parent_msg_ids, context=context)
  90         return res
  91
  92     def mark_outgoing(self, cr, uid, ids, context=None):
  93         return self.write(cr, uid, ids, {'state': 'outgoing'}, context=context)
  94
  95     def cancel(self, cr, uid, ids, context=None):
  96         return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
  97
  98     def process_email_queue(self, cr, uid, ids=None, context=None):
  99         """Send immediately queued messages, committing after each
 100            message is sent - this is not transactional and should
 101            not be called during another transaction!
 102
 103            :param list ids: optional list of emails ids to send. If passed
 104                             no search is performed, and these ids are used
 105                             instead.
 106            :param dict context: if a 'filters' key is present in context,
 107                                 this value will be used as an additional
 108                                 filter to further restrict the outgoing
 109                                 messages to send (by default all 'outgoing'
 110                                 messages are sent).
 111         """
 112         if context is None:
 113             context = {}
 114         if not ids:
 115             filters = [('state', '=', 'outgoing')]
 116             if 'filters' in context:
 117                 filters.extend(context['filters'])
 118             ids = self.search(cr, uid, filters, context=context)
 119         res = None
 120         try:
 121             # Force auto-commit - this is meant to be called by
 122             # the scheduler, and we can't allow rolling back the status
 123             # of previously sent emails!
 124             res = self.send(cr, uid, ids, auto_commit=True, context=context)
 125         except Exception:
 126             _logger.exception("Failed processing mail queue")
 127         return res
 128
 129     def _postprocess_sent_message(self, cr, uid, mail, context=None):
 130         """Perform any post-processing necessary after sending ``mail``
 131         successfully, including deleting it completely along with its
 132         attachment if the ``auto_delete`` flag of the mail was set.
 133         Overridden by subclasses for extra post-processing behaviors.
 134
 135         :param browse_record mail: the mail that was just sent
 136         :return: True
 137         """
 138         if mail.auto_delete:
 139             # done with SUPERUSER_ID to avoid giving large unlink access rights
 140             self.unlink(cr, SUPERUSER_ID, [mail.id], context=context)
 141         return True
 142
 143     #------------------------------------------------------
 144     # mail_mail formatting, tools and send mechanism
 145     #------------------------------------------------------
 146
 147     def _get_partner_access_link(self, cr, uid, mail, partner=None, context=None):
 148         """ Generate URLs for links in mails:
 149             - partner is an user and has read access to the document: direct link to document with model, res_id
 150         """
 151         if partner and partner.user_ids:
 152             base_url = self.pool.get('ir.config_parameter').get_param(cr, uid, 'web.base.url')
 153             # the parameters to encode for the query and fragment part of url
 154             query = {'db': cr.dbname}
 155             fragment = {
 156                 'login': partner.user_ids[0].login,
 157                 'action': 'mail.action_mail_redirect',
 158             }
 159             if mail.notification:
 160                 fragment['message_id'] = mail.mail_message_id.id
 161             elif mail.model and mail.res_id:
 162                 fragment.update(model=mail.model, res_id=mail.res_id)
 163             url = urljoin(base_url, "?%s#%s" % (urlencode(query), urlencode(fragment)))
 164             return _("""<small>Access your messages and documents <a style='color:inherit' href="%s">in OpenERP</a></small>""") % url
 165         else:
 166             return None
 167
 168     def send_get_mail_subject(self, cr, uid, mail, force=False, partner=None, context=None):
 169         """ If subject is void and record_name defined: '<Author> posted on <Resource>'
 170
 171             :param boolean force: force the subject replacement
 172             :param browse_record mail: mail.mail browse_record
 173             :param browse_record partner: specific recipient partner
 174         """
 175         if (force or not mail.subject) and mail.record_name:
 176             return 'Re: %s' % (mail.record_name)
 177         elif (force or not mail.subject) and mail.parent_id and mail.parent_id.subject:
 178             return 'Re: %s' % (mail.parent_id.subject)
 179         return mail.subject
 180
 181     def send_get_mail_body(self, cr, uid, mail, partner=None, context=None):
 182         """ Return a specific ir_email body. The main purpose of this method
 183             is to be inherited to add custom content depending on some module.
 184
 185             :param browse_record mail: mail.mail browse_record
 186             :param browse_record partner: specific recipient partner
 187         """
 188         body = mail.body_html
 189
 190         # generate footer
 191         link = self._get_partner_access_link(cr, uid, mail, partner, context=context)
 192         if link:
 193             body = tools.append_content_to_html(body, link, plaintext=False, container_tag='div')
 194         return body
 195
 196     def send_get_email_dict(self, cr, uid, mail, partner=None, context=None):
 197         """ Return a dictionary for specific email values, depending on a
 198             partner, or generic to the whole recipients given by mail.email_to.
 199
 200             :param browse_record mail: mail.mail browse_record
 201             :param browse_record partner: specific recipient partner
 202         """
 203         body = self.send_get_mail_body(cr, uid, mail, partner=partner, context=context)
 204         subject = self.send_get_mail_subject(cr, uid, mail, partner=partner, context=context)
 205         body_alternative = tools.html2plaintext(body)
 206
 207         # generate email_to, heuristic:
 208         # 1. if 'partner' is specified and there is a related document: Followers of 'Doc' <email>
 209         # 2. if 'partner' is specified, but no related document: Partner Name <email>
 210         # 3; fallback on mail.email_to that we split to have an email addresses list
 211         if partner and mail.record_name:
 212             sanitized_record_name = re.sub(r'[^\w+.]+', '-', mail.record_name)
 213             email_to = [_('"Followers of %s" <%s>') % (sanitized_record_name, partner.email)]
 214         elif partner:
 215             email_to = ['%s <%s>' % (partner.name, partner.email)]
 216         else:
 217             email_to = tools.email_split(mail.email_to)
 218
 219         return {
 220             'body': body,
 221             'body_alternative': body_alternative,
 222             'subject': subject,
 223             'email_to': email_to,
 224         }
 225
 226     def send(self, cr, uid, ids, auto_commit=False, raise_exception=False, context=None):
 227         """ Sends the selected emails immediately, ignoring their current
 228             state (mails that have already been sent should not be passed
 229             unless they should actually be re-sent).
 230             Emails successfully delivered are marked as 'sent', and those
 231             that fail to be deliver are marked as 'exception', and the
 232             corresponding error mail is output in the server logs.
 233
 234             :param bool auto_commit: whether to force a commit of the mail status
 235                 after sending each mail (meant only for scheduler processing);
 236                 should never be True during normal transactions (default: False)
 237             :param bool raise_exception: whether to raise an exception if the
 238                 email sending process has failed
 239             :return: True
 240         """
 241         ir_mail_server = self.pool.get('ir.mail_server')
 242         for mail in self.browse(cr, SUPERUSER_ID, ids, context=context):
 243             try:
 244                 # handle attachments
 245                 attachments = []
 246                 for attach in mail.attachment_ids:
 247                     attachments.append((attach.datas_fname, base64.b64decode(attach.datas)))
 248                 # specific behavior to customize the send email for notified partners
 249                 email_list = []
 250                 if mail.email_to:
 251                     email_list.append(self.send_get_email_dict(cr, uid, mail, context=context))
 252                 for partner in mail.recipient_ids:
 253                     email_list.append(self.send_get_email_dict(cr, uid, mail, partner=partner, context=context))
 254                 # headers
 255                 headers = {}
 256                 bounce_alias = self.pool['ir.config_parameter'].get_param(cr, uid, "mail.bounce.alias", context=context)
 257                 catchall_domain = self.pool['ir.config_parameter'].get_param(cr, uid, "mail.catchall.domain", context=context)
 258                 if bounce_alias and catchall_domain:
 259                     if mail.model and mail.res_id:
 260                         headers['Return-Path'] = '%s-%d-%s-%d@%s' % (bounce_alias, mail.id, mail.model, mail.res_id, catchall_domain)
 261                     else:
 262                         headers['Return-Path'] = '%s-%d@%s' % (bounce_alias, mail.id, catchall_domain)
 263
 264                 # build an RFC2822 email.message.Message object and send it without queuing
 265                 res = None
 266                 for email in email_list:
 267                     msg = ir_mail_server.build_email(
 268                         email_from=mail.email_from,
 269                         email_to=email.get('email_to'),
 270                         subject=email.get('subject'),
 271                         body=email.get('body'),
 272                         body_alternative=email.get('body_alternative'),
 273                         email_cc=tools.email_split(mail.email_cc),
 274                         reply_to=mail.reply_to,
 275                         attachments=attachments,
 276                         message_id=mail.message_id,
 277                         references=mail.references,
 278                         object_id=mail.res_id and ('%s-%s' % (mail.res_id, mail.model)),
 279                         subtype='html',
 280                         subtype_alternative='plain',
 281                         headers=headers)
 282                     res = ir_mail_server.send_email(cr, uid, msg,
 283                                                     mail_server_id=mail.mail_server_id.id,
 284                                                     context=context)
 285                 if res:
 286                     mail.write({'state': 'sent', 'message_id': res})
 287                     mail_sent = True
 288                 else:
 289                     mail.write({'state': 'exception'})
 290                     mail_sent = False
 291
 292                 # /!\ can't use mail.state here, as mail.refresh() will cause an error
 293                 # see revid:odo@openerp.com-20120622152536-42b2s28lvdv3odyr in 6.1
 294                 if mail_sent:
 295                     self._postprocess_sent_message(cr, uid, mail, context=context)
 296             except Exception as e:
 297                 _logger.exception('failed sending mail.mail %s', mail.id)
 298                 mail.write({'state': 'exception'})
 299                 if raise_exception:
 300                     if isinstance(e, AssertionError):
 301                         # get the args of the original error, wrap into a value and throw a MailDeliveryException
 302                         # that is an except_orm, with name and value as arguments
 303                         value = '. '.join(e.args)
 304                         raise MailDeliveryException(_("Mail Delivery Failed"), value)
 305                     raise
 306
 307             if auto_commit == True:
 308                 cr.commit()
 309         return True