Goffin Simon
0fd773a486
Unify and refactor exception handling in framework and addons. The generic `except_osv` is now deprecated, and replaced by more specialized exception subtypes: - `UserError` (renamed from Warning, as it conflicts with the built-in `Warning`) raised when a non-technical error occurs during a business operation. It could be a missing information in the data provided by the user, or a misconfiguration. - `AccessError`: raised when any operation is denied because the user conducting it does not have the required access rights. - `AccessDenied`: raised when an operation that requires authenticated access is attempted via an unauthenticated request. - `MissingError`: raised when an operation is attempted on a record that does not exist. - `ValidationError`: raised when an operation violates a SQL or Python constraint. - All other exceptions are internal errors due to a system problem or bug, and raised untouched to the client-side, which should display a traceback. All exceptions take a single message argument. The `test_exceptions` module has been updated to showcase both new and old (deprecated) exceptions. A great many old `except_osv` had a useless title with "Error!" or "Warning", those have been removed, as this is handled by the client-side widget that displays the messages. This commit introduces a more consistent policy for logging errors and warnings: - All messages that do not require administrator attention should be logged at INFO level or lower. This includes all errors that are notified to the user in a friendly manner, even for access right problems or validation errors during business operations. - All messages that indicate a likely misconfiguration or malicious use by the users should be logged at WARNING level, as they typically require administrator attention. - All other unhandled internal errors cannot typically be handled by the user and should be logged at ERROR or higher level, as they require immediate administrator attention.
352 lines
18 KiB
Python
352 lines
18 KiB
Python
# -*- coding: utf-8 -*-
|
|
##############################################################################
|
|
#
|
|
# OpenERP, Open Source Management Solution
|
|
# Copyright (C) 2010-today OpenERP SA (<http://www.openerp.com>)
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
#
|
|
##############################################################################
|
|
|
|
import base64
|
|
import logging
|
|
from email.utils import formataddr
|
|
from urlparse import urljoin
|
|
|
|
from openerp import api, tools
|
|
from openerp import SUPERUSER_ID
|
|
from openerp.addons.base.ir.ir_mail_server import MailDeliveryException
|
|
from openerp.osv import fields, osv
|
|
from openerp.tools.safe_eval import safe_eval as eval
|
|
from openerp.tools.translate import _
|
|
import openerp.tools as tools
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
class mail_mail(osv.Model):
|
|
""" Model holding RFC2822 email messages to send. This model also provides
|
|
facilities to queue and send new email messages. """
|
|
_name = 'mail.mail'
|
|
_description = 'Outgoing Mails'
|
|
_inherits = {'mail.message': 'mail_message_id'}
|
|
_order = 'id desc'
|
|
_rec_name = 'subject'
|
|
|
|
_columns = {
|
|
'mail_message_id': fields.many2one('mail.message', 'Message', required=True, ondelete='cascade', auto_join=True),
|
|
'state': fields.selection([
|
|
('outgoing', 'Outgoing'),
|
|
('sent', 'Sent'),
|
|
('received', 'Received'),
|
|
('exception', 'Delivery Failed'),
|
|
('cancel', 'Cancelled'),
|
|
], 'Status', readonly=True, copy=False),
|
|
'auto_delete': fields.boolean('Auto Delete',
|
|
help="Permanently delete this email after sending it, to save space"),
|
|
'references': fields.text('References', help='Message references, such as identifiers of previous messages', readonly=1),
|
|
'email_to': fields.text('To', help='Message recipients (emails)'),
|
|
'recipient_ids': fields.many2many('res.partner', string='To (Partners)'),
|
|
'email_cc': fields.char('Cc', help='Carbon copy message recipients'),
|
|
'body_html': fields.text('Rich-text Contents', help="Rich-text/HTML message"),
|
|
'headers': fields.text('Headers', copy=False),
|
|
'failure_reason': fields.text('Failure Reason', help="Failure reason. This is usually the exception thrown by the email server, stored to ease the debugging of mailing issues.", readonly=1),
|
|
# Auto-detected based on create() - if 'mail_message_id' was passed then this mail is a notification
|
|
# and during unlink() we will not cascade delete the parent and its attachments
|
|
'notification': fields.boolean('Is Notification',
|
|
help='Mail has been created to notify people of an existing mail.message'),
|
|
}
|
|
|
|
_defaults = {
|
|
'state': 'outgoing',
|
|
}
|
|
|
|
def default_get(self, cr, uid, fields, context=None):
|
|
# protection for `default_type` values leaking from menu action context (e.g. for invoices)
|
|
# To remove when automatic context propagation is removed in web client
|
|
if context and context.get('default_type') and context.get('default_type') not in self._all_columns['type'].column.selection:
|
|
context = dict(context, default_type=None)
|
|
return super(mail_mail, self).default_get(cr, uid, fields, context=context)
|
|
|
|
def create(self, cr, uid, values, context=None):
|
|
# notification field: if not set, set if mail comes from an existing mail.message
|
|
if 'notification' not in values and values.get('mail_message_id'):
|
|
values['notification'] = True
|
|
return super(mail_mail, self).create(cr, uid, values, context=context)
|
|
|
|
def unlink(self, cr, uid, ids, context=None):
|
|
# cascade-delete the parent message for all mails that are not created for a notification
|
|
ids_to_cascade = self.search(cr, uid, [('notification', '=', False), ('id', 'in', ids)])
|
|
parent_msg_ids = [m.mail_message_id.id for m in self.browse(cr, uid, ids_to_cascade, context=context)]
|
|
res = super(mail_mail, self).unlink(cr, uid, ids, context=context)
|
|
self.pool.get('mail.message').unlink(cr, uid, parent_msg_ids, context=context)
|
|
return res
|
|
|
|
def mark_outgoing(self, cr, uid, ids, context=None):
|
|
return self.write(cr, uid, ids, {'state': 'outgoing'}, context=context)
|
|
|
|
def cancel(self, cr, uid, ids, context=None):
|
|
return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
|
|
|
|
@api.cr_uid
|
|
def process_email_queue(self, cr, uid, ids=None, context=None):
|
|
"""Send immediately queued messages, committing after each
|
|
message is sent - this is not transactional and should
|
|
not be called during another transaction!
|
|
|
|
:param list ids: optional list of emails ids to send. If passed
|
|
no search is performed, and these ids are used
|
|
instead.
|
|
:param dict context: if a 'filters' key is present in context,
|
|
this value will be used as an additional
|
|
filter to further restrict the outgoing
|
|
messages to send (by default all 'outgoing'
|
|
messages are sent).
|
|
"""
|
|
if context is None:
|
|
context = {}
|
|
if not ids:
|
|
filters = [('state', '=', 'outgoing')]
|
|
if 'filters' in context:
|
|
filters.extend(context['filters'])
|
|
ids = self.search(cr, uid, filters, context=context)
|
|
res = None
|
|
try:
|
|
# Force auto-commit - this is meant to be called by
|
|
# the scheduler, and we can't allow rolling back the status
|
|
# of previously sent emails!
|
|
res = self.send(cr, uid, ids, auto_commit=True, context=context)
|
|
except Exception:
|
|
_logger.exception("Failed processing mail queue")
|
|
return res
|
|
|
|
def _postprocess_sent_message(self, cr, uid, mail, context=None, mail_sent=True):
|
|
"""Perform any post-processing necessary after sending ``mail``
|
|
successfully, including deleting it completely along with its
|
|
attachment if the ``auto_delete`` flag of the mail was set.
|
|
Overridden by subclasses for extra post-processing behaviors.
|
|
|
|
:param browse_record mail: the mail that was just sent
|
|
:return: True
|
|
"""
|
|
if mail_sent and mail.auto_delete:
|
|
# done with SUPERUSER_ID to avoid giving large unlink access rights
|
|
self.unlink(cr, SUPERUSER_ID, [mail.id], context=context)
|
|
return True
|
|
|
|
#------------------------------------------------------
|
|
# mail_mail formatting, tools and send mechanism
|
|
#------------------------------------------------------
|
|
|
|
def _get_partner_access_link(self, cr, uid, mail, partner=None, context=None):
|
|
"""Generate URLs for links in mails: partner has access (is user):
|
|
link to action_mail_redirect action that will redirect to doc or Inbox """
|
|
if context is None:
|
|
context = {}
|
|
if partner and partner.user_ids:
|
|
base_url = self.pool.get('ir.config_parameter').get_param(cr, SUPERUSER_ID, 'web.base.url')
|
|
mail_model = mail.model or 'mail.thread'
|
|
url = urljoin(base_url, self.pool[mail_model]._get_access_link(cr, uid, mail, partner, context=context))
|
|
return "<span class='oe_mail_footer_access'><small>%(access_msg)s <a style='color:inherit' href='%(portal_link)s'>%(portal_msg)s</a></small></span>" % {
|
|
'access_msg': _('about') if mail.record_name else _('access'),
|
|
'portal_link': url,
|
|
'portal_msg': '%s %s' % (context.get('model_name', ''), mail.record_name) if mail.record_name else _('your messages'),
|
|
}
|
|
else:
|
|
return None
|
|
|
|
def send_get_mail_subject(self, cr, uid, mail, force=False, partner=None, context=None):
|
|
"""If subject is void, set the subject as 'Re: <Resource>' or
|
|
'Re: <mail.parent_id.subject>'
|
|
|
|
:param boolean force: force the subject replacement
|
|
"""
|
|
if (force or not mail.subject) and mail.record_name:
|
|
return 'Re: %s' % (mail.record_name)
|
|
elif (force or not mail.subject) and mail.parent_id and mail.parent_id.subject:
|
|
return 'Re: %s' % (mail.parent_id.subject)
|
|
return mail.subject
|
|
|
|
def send_get_mail_body(self, cr, uid, mail, partner=None, context=None):
|
|
"""Return a specific ir_email body. The main purpose of this method
|
|
is to be inherited to add custom content depending on some module."""
|
|
body = mail.body_html or ''
|
|
|
|
# generate access links for notifications or emails linked to a specific document with auto threading
|
|
link = None
|
|
if mail.notification or (mail.model and mail.res_id and not mail.no_auto_thread):
|
|
link = self._get_partner_access_link(cr, uid, mail, partner, context=context)
|
|
if link:
|
|
body = tools.append_content_to_html(body, link, plaintext=False, container_tag='div')
|
|
return body
|
|
|
|
def send_get_mail_to(self, cr, uid, mail, partner=None, context=None):
|
|
"""Forge the email_to with the following heuristic:
|
|
- if 'partner', recipient specific (Partner Name <email>)
|
|
- else fallback on mail.email_to splitting """
|
|
if partner:
|
|
email_to = [formataddr((partner.name, partner.email))]
|
|
else:
|
|
email_to = tools.email_split(mail.email_to)
|
|
return email_to
|
|
|
|
def send_get_email_dict(self, cr, uid, mail, partner=None, context=None):
|
|
"""Return a dictionary for specific email values, depending on a
|
|
partner, or generic to the whole recipients given by mail.email_to.
|
|
|
|
:param browse_record mail: mail.mail browse_record
|
|
:param browse_record partner: specific recipient partner
|
|
"""
|
|
body = self.send_get_mail_body(cr, uid, mail, partner=partner, context=context)
|
|
body_alternative = tools.html2plaintext(body)
|
|
res = {
|
|
'body': body,
|
|
'body_alternative': body_alternative,
|
|
'subject': self.send_get_mail_subject(cr, uid, mail, partner=partner, context=context),
|
|
'email_to': self.send_get_mail_to(cr, uid, mail, partner=partner, context=context),
|
|
}
|
|
return res
|
|
|
|
def send(self, cr, uid, ids, auto_commit=False, raise_exception=False, context=None):
|
|
""" Sends the selected emails immediately, ignoring their current
|
|
state (mails that have already been sent should not be passed
|
|
unless they should actually be re-sent).
|
|
Emails successfully delivered are marked as 'sent', and those
|
|
that fail to be deliver are marked as 'exception', and the
|
|
corresponding error mail is output in the server logs.
|
|
|
|
:param bool auto_commit: whether to force a commit of the mail status
|
|
after sending each mail (meant only for scheduler processing);
|
|
should never be True during normal transactions (default: False)
|
|
:param bool raise_exception: whether to raise an exception if the
|
|
email sending process has failed
|
|
:return: True
|
|
"""
|
|
context = dict(context or {})
|
|
ir_mail_server = self.pool.get('ir.mail_server')
|
|
ir_attachment = self.pool['ir.attachment']
|
|
for mail in self.browse(cr, SUPERUSER_ID, ids, context=context):
|
|
try:
|
|
# TDE note: remove me when model_id field is present on mail.message - done here to avoid doing it multiple times in the sub method
|
|
if mail.model:
|
|
model_id = self.pool['ir.model'].search(cr, SUPERUSER_ID, [('model', '=', mail.model)], context=context)[0]
|
|
model = self.pool['ir.model'].browse(cr, SUPERUSER_ID, model_id, context=context)
|
|
else:
|
|
model = None
|
|
if model:
|
|
context['model_name'] = model.name
|
|
|
|
# load attachment binary data with a separate read(), as prefetching all
|
|
# `datas` (binary field) could bloat the browse cache, triggerring
|
|
# soft/hard mem limits with temporary data.
|
|
attachment_ids = [a.id for a in mail.attachment_ids]
|
|
attachments = [(a['datas_fname'], base64.b64decode(a['datas']))
|
|
for a in ir_attachment.read(cr, SUPERUSER_ID, attachment_ids,
|
|
['datas_fname', 'datas'])]
|
|
|
|
# specific behavior to customize the send email for notified partners
|
|
email_list = []
|
|
if mail.email_to:
|
|
email_list.append(self.send_get_email_dict(cr, uid, mail, context=context))
|
|
for partner in mail.recipient_ids:
|
|
email_list.append(self.send_get_email_dict(cr, uid, mail, partner=partner, context=context))
|
|
# headers
|
|
headers = {}
|
|
bounce_alias = self.pool['ir.config_parameter'].get_param(cr, uid, "mail.bounce.alias", context=context)
|
|
catchall_domain = self.pool['ir.config_parameter'].get_param(cr, uid, "mail.catchall.domain", context=context)
|
|
if bounce_alias and catchall_domain:
|
|
if mail.model and mail.res_id:
|
|
headers['Return-Path'] = '%s-%d-%s-%d@%s' % (bounce_alias, mail.id, mail.model, mail.res_id, catchall_domain)
|
|
else:
|
|
headers['Return-Path'] = '%s-%d@%s' % (bounce_alias, mail.id, catchall_domain)
|
|
if mail.headers:
|
|
try:
|
|
headers.update(eval(mail.headers))
|
|
except Exception:
|
|
pass
|
|
|
|
# Writing on the mail object may fail (e.g. lock on user) which
|
|
# would trigger a rollback *after* actually sending the email.
|
|
# To avoid sending twice the same email, provoke the failure earlier
|
|
mail.write({
|
|
'state': 'exception',
|
|
'failure_reason': _('Error without exception. Probably due do sending an email without computed recipients.'),
|
|
})
|
|
mail_sent = False
|
|
|
|
# build an RFC2822 email.message.Message object and send it without queuing
|
|
res = None
|
|
for email in email_list:
|
|
msg = ir_mail_server.build_email(
|
|
email_from=mail.email_from,
|
|
email_to=email.get('email_to'),
|
|
subject=email.get('subject'),
|
|
body=email.get('body'),
|
|
body_alternative=email.get('body_alternative'),
|
|
email_cc=tools.email_split(mail.email_cc),
|
|
reply_to=mail.reply_to,
|
|
attachments=attachments,
|
|
message_id=mail.message_id,
|
|
references=mail.references,
|
|
object_id=mail.res_id and ('%s-%s' % (mail.res_id, mail.model)),
|
|
subtype='html',
|
|
subtype_alternative='plain',
|
|
headers=headers)
|
|
try:
|
|
res = ir_mail_server.send_email(cr, uid, msg,
|
|
mail_server_id=mail.mail_server_id.id,
|
|
context=context)
|
|
except AssertionError as error:
|
|
if error.message == ir_mail_server.NO_VALID_RECIPIENT:
|
|
# No valid recipient found for this particular
|
|
# mail item -> ignore error to avoid blocking
|
|
# delivery to next recipients, if any. If this is
|
|
# the only recipient, the mail will show as failed.
|
|
_logger.info("Ignoring invalid recipients for mail.mail %s: %s",
|
|
mail.message_id, email.get('email_to'))
|
|
else:
|
|
raise
|
|
if res:
|
|
mail.write({'state': 'sent', 'message_id': res, 'failure_reason': False})
|
|
mail_sent = True
|
|
|
|
# /!\ can't use mail.state here, as mail.refresh() will cause an error
|
|
# see revid:odo@openerp.com-20120622152536-42b2s28lvdv3odyr in 6.1
|
|
if mail_sent:
|
|
_logger.info('Mail with ID %r and Message-Id %r successfully sent', mail.id, mail.message_id)
|
|
self._postprocess_sent_message(cr, uid, mail, context=context, mail_sent=mail_sent)
|
|
except MemoryError:
|
|
# prevent catching transient MemoryErrors, bubble up to notify user or abort cron job
|
|
# instead of marking the mail as failed
|
|
_logger.exception('MemoryError while processing mail with ID %r and Msg-Id %r. '\
|
|
'Consider raising the --limit-memory-hard startup option',
|
|
mail.id, mail.message_id)
|
|
raise
|
|
except Exception as e:
|
|
failure_reason = tools.ustr(e)
|
|
_logger.exception('failed sending mail (id: %s) due to %s', mail.id, failure_reason)
|
|
mail.write({'state': 'exception', 'failure_reason': failure_reason})
|
|
self._postprocess_sent_message(cr, uid, mail, context=context, mail_sent=False)
|
|
if raise_exception:
|
|
if isinstance(e, AssertionError):
|
|
# get the args of the original error, wrap into a value and throw a MailDeliveryException
|
|
# that is an except_orm, with name and value as arguments
|
|
value = '. '.join(e.args)
|
|
raise MailDeliveryException(_("Mail Delivery Failed"), value)
|
|
raise
|
|
|
|
if auto_commit is True:
|
|
cr.commit()
|
|
return True
|