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.osv import fields, osv
  31 from openerp.osv.orm import except_orm
  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         'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing mail server', readonly=1),
  48         'state': fields.selection([
  49             ('outgoing', 'Outgoing'),
  50             ('sent', 'Sent'),
  51             ('received', 'Received'),
  52             ('exception', 'Delivery Failed'),
  53             ('cancel', 'Cancelled'),
  54         ], 'Status', readonly=True),
  55         'auto_delete': fields.boolean('Auto Delete',
  56             help="Permanently delete this email after sending it, to save space"),
  57         'references': fields.text('References', help='Message references, such as identifiers of previous messages', readonly=1),
  58         'email_from': fields.char('From', help='Message sender, taken from user preferences.'),
  59         'email_to': fields.text('To', help='Message recipients (emails)'),
  60         'recipient_ids': fields.many2many('res.partner', string='To (Partners)'),
  61         'email_cc': fields.char('Cc', help='Carbon copy message recipients'),
  62         'body_html': fields.text('Rich-text Contents', help="Rich-text/HTML message"),
  63         # If not set in create values, auto-detected based on create values (res_id, model, email_from)
  64         'reply_to': fields.char('Reply-To',
  65             help='Preferred response address for the message'),
  66         # Auto-detected based on create() - if 'mail_message_id' was passed then this mail is a notification
  67         # and during unlink() we will not cascade delete the parent and its attachments
  68         'notification': fields.boolean('Is Notification',
  69             help='Mail has been created to notify people of an existing mail.message')
  70     }
  71
  72     def _get_default_from(self, cr, uid, context=None):
  73         this = self.pool.get('res.users').browse(cr, SUPERUSER_ID, uid, context=context)
  74         if this.alias_domain:
  75             return '%s <%s@%s>' % (this.name, this.alias_name, this.alias_domain)
  76         elif this.email:
  77             return '%s <%s>' % (this.name, this.email)
  78         raise osv.except_osv(_('Invalid Action!'), _("Unable to send email, please configure the sender's email address or alias."))
  79
  80     _defaults = {
  81         'state': 'outgoing',
  82         'email_from': lambda self, cr, uid, ctx=None: self._get_default_from(cr, uid, ctx),
  83     }
  84
  85     def default_get(self, cr, uid, fields, context=None):
  86         # protection for `default_type` values leaking from menu action context (e.g. for invoices)
  87         # To remove when automatic context propagation is removed in web client
  88         if context and context.get('default_type') and context.get('default_type') not in self._all_columns['type'].column.selection:
  89             context = dict(context, default_type=None)
  90         return super(mail_mail, self).default_get(cr, uid, fields, context=context)
  91
  92     def _get_reply_to(self, cr, uid, values, context=None):
  93         """ Return a specific reply_to: alias of the document through message_get_reply_to
  94             or take the email_from
  95         """
  96         if values.get('reply_to'):
  97             return values.get('reply_to')
  98         email_reply_to = False
  99
 100         # model, res_id: comes from values OR related message
 101         model = values.get('model')
 102         res_id = values.get('res_id')
 103         if values.get('mail_message_id') and (not model or not res_id):
 104             message = self.pool.get('mail.message').browse(cr, uid, values.get('mail_message_id'), context=context)
 105             if not model:
 106                 model = message.model
 107             if not res_id:
 108                 res_id = message.res_id
 109
 110         # if model and res_id: try to use ``message_get_reply_to`` that returns the document alias
 111         if model and res_id and hasattr(self.pool.get(model), 'message_get_reply_to'):
 112             email_reply_to = self.pool.get(model).message_get_reply_to(cr, uid, [res_id], context=context)[0]
 113         # no alias reply_to -> reply_to will be the email_from, only the email part
 114         if not email_reply_to and values.get('email_from'):
 115             emails = tools.email_split(values.get('email_from'))
 116             if emails:
 117                 email_reply_to = emails[0]
 118
 119         # format 'Document name <email_address>'
 120         if email_reply_to and model and res_id:
 121             document_name = self.pool.get(model).name_get(cr, SUPERUSER_ID, [res_id], context=context)[0]
 122             if document_name:
 123                 # sanitize document name
 124                 sanitized_doc_name = re.sub(r'[^\w+.]+', '-', document_name[1])
 125                 # generate reply to
 126                 email_reply_to = _('"Followers of %s" <%s>') % (sanitized_doc_name, email_reply_to)
 127
 128         return email_reply_to
 129
 130     def create(self, cr, uid, values, context=None):
 131         # notification field: if not set, set if mail comes from an existing mail.message
 132         if 'notification' not in values and values.get('mail_message_id'):
 133             values['notification'] = True
 134         # reply_to: if not set, set with default values that require creation values
 135         if not values.get('reply_to'):
 136             values['reply_to'] = self._get_reply_to(cr, uid, values, context=context)
 137         return super(mail_mail, self).create(cr, uid, values, context=context)
 138
 139     def unlink(self, cr, uid, ids, context=None):
 140         # cascade-delete the parent message for all mails that are not created for a notification
 141         ids_to_cascade = self.search(cr, uid, [('notification', '=', False), ('id', 'in', ids)])
 142         parent_msg_ids = [m.mail_message_id.id for m in self.browse(cr, uid, ids_to_cascade, context=context)]
 143         res = super(mail_mail, self).unlink(cr, uid, ids, context=context)
 144         self.pool.get('mail.message').unlink(cr, uid, parent_msg_ids, context=context)
 145         return res
 146
 147     def mark_outgoing(self, cr, uid, ids, context=None):
 148         return self.write(cr, uid, ids, {'state': 'outgoing'}, context=context)
 149
 150     def cancel(self, cr, uid, ids, context=None):
 151         return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
 152
 153     def process_email_queue(self, cr, uid, ids=None, context=None):
 154         """Send immediately queued messages, committing after each
 155            message is sent - this is not transactional and should
 156            not be called during another transaction!
 157
 158            :param list ids: optional list of emails ids to send. If passed
 159                             no search is performed, and these ids are used
 160                             instead.
 161            :param dict context: if a 'filters' key is present in context,
 162                                 this value will be used as an additional
 163                                 filter to further restrict the outgoing
 164                                 messages to send (by default all 'outgoing'
 165                                 messages are sent).
 166         """
 167         if context is None:
 168             context = {}
 169         if not ids:
 170             filters = ['&', ('state', '=', 'outgoing'), ('type', '=', 'email')]
 171             if 'filters' in context:
 172                 filters.extend(context['filters'])
 173             ids = self.search(cr, uid, filters, context=context)
 174         res = None
 175         try:
 176             # Force auto-commit - this is meant to be called by
 177             # the scheduler, and we can't allow rolling back the status
 178             # of previously sent emails!
 179             res = self.send(cr, uid, ids, auto_commit=True, context=context)
 180         except Exception:
 181             _logger.exception("Failed processing mail queue")
 182         return res
 183
 184     def _postprocess_sent_message(self, cr, uid, mail, context=None):
 185         """Perform any post-processing necessary after sending ``mail``
 186         successfully, including deleting it completely along with its
 187         attachment if the ``auto_delete`` flag of the mail was set.
 188         Overridden by subclasses for extra post-processing behaviors.
 189
 190         :param browse_record mail: the mail that was just sent
 191         :return: True
 192         """
 193         if mail.auto_delete:
 194             # done with SUPERUSER_ID to avoid giving large unlink access rights
 195             self.unlink(cr, SUPERUSER_ID, [mail.id], context=context)
 196         return True
 197
 198     def send_get_mail_subject(self, cr, uid, mail, force=False, partner=None, context=None):
 199         """ If subject is void and record_name defined: '<Author> posted on <Resource>'
 200
 201             :param boolean force: force the subject replacement
 202             :param browse_record mail: mail.mail browse_record
 203             :param browse_record partner: specific recipient partner
 204         """
 205         if force or (not mail.subject and mail.model and mail.res_id):
 206             return 'Re: %s' % (mail.record_name)
 207         return mail.subject
 208
 209     def send_get_mail_body_footer(self, cr, uid, mail, partner=None, context=None):
 210         """ Return a specific footer for the ir_email body.  The main purpose of this method
 211             is to be inherited by Portal, to add modify the link for signing in, in
 212             each notification email a partner receives.
 213         """
 214         body_footer = ""
 215         # partner is a user, link to a related document (incentive to install portal)
 216         if partner and partner.user_ids and mail.model and mail.res_id \
 217                 and self.check_access_rights(cr, partner.user_ids[0].id, 'read', raise_exception=False):
 218             related_user = partner.user_ids[0]
 219             try:
 220                 self.pool.get(mail.model).check_access_rule(cr, related_user.id, [mail.res_id], 'read', context=context)
 221                 base_url = self.pool.get('ir.config_parameter').get_param(cr, uid, 'web.base.url')
 222                 # the parameters to encode for the query and fragment part of url
 223                 query = {'db': cr.dbname}
 224                 fragment = {
 225                     'login': related_user.login,
 226                     'model': mail.model,
 227                     'id': mail.res_id,
 228                 }
 229                 url = urljoin(base_url, "?%s#%s" % (urlencode(query), urlencode(fragment)))
 230                 body_footer = _("""<small>Access this document <a style='color:inherit' href="%s">directly in OpenERP</a></small>""") % url
 231             except except_orm, e:
 232                 pass
 233         return body_footer
 234
 235     def send_get_mail_body(self, cr, uid, mail, partner=None, context=None):
 236         """ Return a specific ir_email body. The main purpose of this method
 237             is to be inherited to add custom content depending on some module.
 238
 239             :param browse_record mail: mail.mail browse_record
 240             :param browse_record partner: specific recipient partner
 241         """
 242         body = mail.body_html
 243
 244         # add footer
 245         body_footer = self.send_get_mail_body_footer(cr, uid, mail, partner=partner, context=context)
 246         body = tools.append_content_to_html(body, body_footer, plaintext=False, container_tag='div')
 247         return body
 248
 249     def send_get_email_dict(self, cr, uid, mail, partner=None, context=None):
 250         """ Return a dictionary for specific email values, depending on a
 251             partner, or generic to the whole recipients given by mail.email_to.
 252
 253             :param browse_record mail: mail.mail browse_record
 254             :param browse_record partner: specific recipient partner
 255         """
 256         body = self.send_get_mail_body(cr, uid, mail, partner=partner, context=context)
 257         subject = self.send_get_mail_subject(cr, uid, mail, partner=partner, context=context)
 258         body_alternative = tools.html2plaintext(body)
 259         email_to = ['%s <%s>' % (partner.name, partner.email)] if partner else tools.email_split(mail.email_to)
 260         return {
 261             'body': body,
 262             'body_alternative': body_alternative,
 263             'subject': subject,
 264             'email_to': email_to,
 265         }
 266
 267     def send(self, cr, uid, ids, auto_commit=False, context=None):
 268         """ Sends the selected emails immediately, ignoring their current
 269             state (mails that have already been sent should not be passed
 270             unless they should actually be re-sent).
 271             Emails successfully delivered are marked as 'sent', and those
 272             that fail to be deliver are marked as 'exception', and the
 273             corresponding error mail is output in the server logs.
 274
 275             :param bool auto_commit: whether to force a commit of the mail status
 276                 after sending each mail (meant only for scheduler processing);
 277                 should never be True during normal transactions (default: False)
 278             :return: True
 279         """
 280         ir_mail_server = self.pool.get('ir.mail_server')
 281         for mail in self.browse(cr, SUPERUSER_ID, ids, context=context):
 282             try:
 283                 # handle attachments
 284                 attachments = []
 285                 for attach in mail.attachment_ids:
 286                     attachments.append((attach.datas_fname, base64.b64decode(attach.datas)))
 287                 # specific behavior to customize the send email for notified partners
 288                 email_list = []
 289                 if mail.email_to:
 290                     email_list.append(self.send_get_email_dict(cr, uid, mail, context=context))
 291                 for partner in mail.recipient_ids:
 292                     email_list.append(self.send_get_email_dict(cr, uid, mail, partner=partner, context=context))
 293
 294                 # build an RFC2822 email.message.Message object and send it without queuing
 295                 for email in email_list:
 296                     msg = ir_mail_server.build_email(
 297                         email_from = mail.email_from,
 298                         email_to = email.get('email_to'),
 299                         subject = email.get('subject'),
 300                         body = email.get('body'),
 301                         body_alternative = email.get('body_alternative'),
 302                         email_cc = tools.email_split(mail.email_cc),
 303                         reply_to = mail.reply_to,
 304                         attachments = attachments,
 305                         message_id = mail.message_id,
 306                         references = mail.references,
 307                         object_id = mail.res_id and ('%s-%s' % (mail.res_id, mail.model)),
 308                         subtype = 'html',
 309                         subtype_alternative = 'plain')
 310                     res = ir_mail_server.send_email(cr, uid, msg,
 311                         mail_server_id=mail.mail_server_id.id, context=context)
 312                 if res:
 313                     mail.write({'state': 'sent', 'message_id': res})
 314                     mail_sent = True
 315                 else:
 316                     mail.write({'state': 'exception'})
 317                     mail_sent = False
 318
 319                 # /!\ can't use mail.state here, as mail.refresh() will cause an error
 320                 # see revid:odo@openerp.com-20120622152536-42b2s28lvdv3odyr in 6.1
 321                 if mail_sent:
 322                     self._postprocess_sent_message(cr, uid, mail, context=context)
 323             except Exception:
 324                 _logger.exception('failed sending mail.mail %s', mail.id)
 325                 mail.write({'state': 'exception'})
 326
 327             if auto_commit == True:
 328                 cr.commit()
 329         return True