diff options
Diffstat (limited to 'addons/mail/mail_alias.py')
| -rw-r--r-- | addons/mail/mail_alias.py | 231 |
1 files changed, 100 insertions, 131 deletions
diff --git a/addons/mail/mail_alias.py b/addons/mail/mail_alias.py index 32d27985442..3136174a657 100644 --- a/addons/mail/mail_alias.py +++ b/addons/mail/mail_alias.py @@ -1,36 +1,17 @@ # -*- coding: utf-8 -*- -############################################################################## -# -# OpenERP, Open Source Business Applications -# Copyright (C) 2012 OpenERP S.A. (<http://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 logging import re import unicodedata -from openerp.osv import fields, osv -from openerp.tools import ustr +from openerp import _, api, fields, models, SUPERUSER_ID +from openerp.exceptions import UserError from openerp.modules.registry import RegistryManager -from openerp import SUPERUSER_ID -from openerp.tools.translate import _ +from openerp.tools import ustr _logger = logging.getLogger(__name__) + # Inspired by http://stackoverflow.com/questions/517923 def remove_accents(input_str): """Suboptimal-but-better-than-nothing way to replace accented @@ -41,7 +22,7 @@ def remove_accents(input_str): return u''.join([c for c in nkfd_form if not unicodedata.combining(c)]) -class mail_alias(osv.Model): +class Alias(models.Model): """A Mail Alias is a mapping of an email address with a given OpenERP Document model. It is used by OpenERP's mail gateway when processing incoming emails sent to the system. If the recipient address (To) of the message matches @@ -59,83 +40,97 @@ class mail_alias(osv.Model): _rec_name = 'alias_name' _order = 'alias_model_id, alias_name' - def _get_alias_domain(self, cr, uid, ids, name, args, context=None): - ir_config_parameter = self.pool.get("ir.config_parameter") - domain = ir_config_parameter.get_param(cr, uid, "mail.catchall.domain", context=context) - return dict.fromkeys(ids, domain or "") - - _columns = { - 'alias_name': fields.char('Alias Name', - help="The name of the email alias, e.g. 'jobs' if you want to catch emails for <jobs@example.odoo.com>",), - 'alias_model_id': fields.many2one('ir.model', 'Aliased Model', required=True, ondelete="cascade", - help="The model (Odoo Document Kind) to which this alias " - "corresponds. Any incoming email that does not reply to an " - "existing record will cause the creation of a new record " - "of this model (e.g. a Project Task)", - # hack to only allow selecting mail_thread models (we might - # (have a few false positives, though) - domain="[('field_id.name', '=', 'message_ids')]"), - 'alias_user_id': fields.many2one('res.users', 'Owner', - help="The owner of records created upon receiving emails on this alias. " - "If this field is not set the system will attempt to find the right owner " - "based on the sender (From) address, or will use the Administrator account " - "if no system user is found for that address."), - 'alias_defaults': fields.text('Default Values', required=True, - help="A Python dictionary that will be evaluated to provide " - "default values when creating new records for this alias."), - 'alias_force_thread_id': fields.integer('Record Thread ID', - help="Optional ID of a thread (record) to which all incoming " - "messages will be attached, even if they did not reply to it. " - "If set, this will disable the creation of new records completely."), - 'alias_domain': fields.function(_get_alias_domain, string="Alias domain", type='char'), - 'alias_parent_model_id': fields.many2one('ir.model', 'Parent Model', - help="Parent model holding the alias. The model holding the alias reference\n" - "is not necessarily the model given by alias_model_id\n" - "(example: project (parent_model) and task (model))"), - 'alias_parent_thread_id': fields.integer('Parent Record Thread ID', - help="ID of the parent record holding the alias (example: project holding the task creation alias)"), - 'alias_contact': fields.selection([ - ('everyone', 'Everyone'), - ('partners', 'Authenticated Partners'), - ('followers', 'Followers only'), - ], string='Alias Contact Security', required=True, - help="Policy to post a message on the document using the mailgateway.\n" - "- everyone: everyone can post\n" - "- partners: only authenticated partners\n" - "- followers: only followers of the related document\n"), - } - - _defaults = { - 'alias_defaults': '{}', - 'alias_user_id': lambda self, cr, uid, context: uid, - # looks better when creating new aliases - even if the field is informative only - 'alias_domain': lambda self, cr, uid, context: self._get_alias_domain(cr, SUPERUSER_ID, [1], None, None)[1], - 'alias_contact': 'everyone', - } + alias_name = fields.Char('Alias Name', help="The name of the email alias, e.g. 'jobs' if you want to catch emails for <jobs@example.odoo.com>") + alias_model_id = fields.Many2one('ir.model', 'Aliased Model', required=True, ondelete="cascade", + help="The model (Odoo Document Kind) to which this alias " + "corresponds. Any incoming email that does not reply to an " + "existing record will cause the creation of a new record " + "of this model (e.g. a Project Task)", + # hack to only allow selecting mail_thread models (we might + # (have a few false positives, though) + domain="[('field_id.name', '=', 'message_ids')]") + alias_user_id = fields.Many2one('res.users', 'Owner', defaults=lambda self: self.env.user, + help="The owner of records created upon receiving emails on this alias. " + "If this field is not set the system will attempt to find the right owner " + "based on the sender (From) address, or will use the Administrator account " + "if no system user is found for that address.") + alias_defaults = fields.Text('Default Values', required=True, default='{}', + help="A Python dictionary that will be evaluated to provide " + "default values when creating new records for this alias.") + alias_force_thread_id = fields.Integer( + 'Record Thread ID', + help="Optional ID of a thread (record) to which all incoming messages will be attached, even " + "if they did not reply to it. If set, this will disable the creation of new records completely.") + alias_domain = fields.Char('Alias domain', compute='_get_alias_domain') + alias_parent_model_id = fields.Many2one( + 'ir.model', 'Parent Model', + help="Parent model holding the alias. The model holding the alias reference" + "is not necessarily the model given by alias_model_id" + "(example: project (parent_model) and task (model))") + alias_parent_thread_id = fields.Integer('Parent Record Thread ID', help="ID of the parent record holding the alias (example: project holding the task creation alias)") + alias_contact = fields.Selection([ + ('everyone', 'Everyone'), + ('partners', 'Authenticated Partners'), + ('followers', 'Followers only')], default='everyone', + string='Alias Contact Security', required=True, + help="Policy to post a message on the document using the mailgateway.\n" + "- everyone: everyone can post\n" + "- partners: only authenticated partners\n" + "- followers: only followers of the related document\n") _sql_constraints = [ ('alias_unique', 'UNIQUE(alias_name)', 'Unfortunately this email alias is already used, please choose a unique one') ] - def _check_alias_defaults(self, cr, uid, ids, context=None): + @api.multi + def _get_alias_domain(self): + alias_domain = self.env["ir.config_parameter"].get_param("mail.catchall.domain") + for record in self: + record.alias_domain = alias_domain + + @api.one + @api.constrains('alias_defaults') + def _check_alias_defaults(self): try: - for record in self.browse(cr, uid, ids, context=context): - dict(eval(record.alias_defaults)) + dict(eval(self.alias_defaults)) except Exception: - return False - return True + raise UserError(_('Invalid expression, it must be a literal python dictionary definition e.g. "{\'field\': \'value\'}"')) - _constraints = [ - (_check_alias_defaults, '''Invalid expression, it must be a literal python dictionary definition e.g. "{'field': 'value'}"''', ['alias_defaults']), - ] + @api.model + def create(self, vals): + """ Creates an email.alias record according to the values provided in ``vals``, + with 2 alterations: the ``alias_name`` value may be suffixed in order to + make it unique (and certain unsafe characters replaced), and + he ``alias_model_id`` value will set to the model ID of the ``model_name`` + context value, if provided. + """ + model_name = self._context.get('alias_model_name') + parent_model_name = self._context.get('alias_parent_model_name') + if vals.get('alias_name'): + vals['alias_name'] = self._clean_and_make_unique(vals.get('alias_name')) + if model_name: + model = self.env['ir.model'].search([('model', '=', model_name)]) + vals['alias_model_id'] = model.id + if parent_model_name: + model = self.env['ir.model'].search([('model', '=', parent_model_name)]) + vals['alias_parent_model_id'] = model.id + return super(Alias, self).create(vals) - def name_get(self, cr, uid, ids, context=None): + @api.multi + def write(self, vals): + """"give a unique alias name if given alias name is already assigned""" + if vals.get('alias_name') and self.ids: + vals['alias_name'] = self._clean_and_make_unique(vals.get('alias_name'), alias_ids=self.ids) + return super(Alias, self).write(vals) + + @api.multi + def name_get(self): """Return the mail alias display alias_name, including the implicit mail catchall domain if exists from config otherwise "New Alias". e.g. `jobs@mail.odoo.com` or `jobs` or 'New Alias' """ res = [] - for record in self.browse(cr, uid, ids, context=context): + for record in self: if record.alias_name and record.alias_domain: res.append((record['id'], "%s@%s" % (record.alias_name, record.alias_domain))) elif record.alias_name: @@ -144,7 +139,8 @@ class mail_alias(osv.Model): res.append((record['id'], _("Inactive Alias"))) return res - def _find_unique(self, cr, uid, name, alias_id=False, context=None): + @api.model + def _find_unique(self, name, alias_ids=False): """Find a unique alias name similar to ``name``. If ``name`` is already taken, make a variant by adding an integer suffix until an unused alias is found. @@ -153,18 +149,19 @@ class mail_alias(osv.Model): while True: new_name = "%s%s" % (name, sequence) if sequence is not None else name domain = [('alias_name', '=', new_name)] - if alias_id: - domain += [('id', '!=', alias_id)] - if not self.search(cr, uid, domain): + if alias_ids: + domain += [('id', 'not in', alias_ids)] + if not self.search(domain): break sequence = (sequence + 1) if sequence else 2 return new_name - def _clean_and_make_unique(self, cr, uid, name, alias_id=False, context=None): + @api.model + def _clean_and_make_unique(self, name, alias_ids=False): # when an alias name appears to already be an email, we keep the local part only name = remove_accents(name).lower().split('@')[0] name = re.sub(r'[^\w+.]+', '-', name) - return self._find_unique(cr, uid, name, alias_id=alias_id, context=context) + return self._find_unique(name, alias_ids=alias_ids) def migrate_to_alias(self, cr, child_model_name, child_table_name, child_model_auto_init_fct, alias_model_name, alias_id_column, alias_key, alias_prefix='', alias_force_key='', alias_defaults={}, @@ -227,54 +224,26 @@ class mail_alias(osv.Model): alias_id_column.required = True return res - def create(self, cr, uid, vals, context=None): - """ Creates an email.alias record according to the values provided in ``vals``, - with 2 alterations: the ``alias_name`` value may be suffixed in order to - make it unique (and certain unsafe characters replaced), and - he ``alias_model_id`` value will set to the model ID of the ``model_name`` - context value, if provided. - """ - if context is None: - context = {} - model_name = context.get('alias_model_name') - parent_model_name = context.get('alias_parent_model_name') - if vals.get('alias_name'): - vals['alias_name'] = self._clean_and_make_unique(cr, uid, vals.get('alias_name'), context=context) - if model_name: - model_id = self.pool.get('ir.model').search(cr, uid, [('model', '=', model_name)], context=context)[0] - vals['alias_model_id'] = model_id - if parent_model_name: - model_id = self.pool.get('ir.model').search(cr, uid, [('model', '=', parent_model_name)], context=context)[0] - vals['alias_parent_model_id'] = model_id - return super(mail_alias, self).create(cr, uid, vals, context=context) - - def write(self, cr, uid, ids, vals, context=None): - """"give a unique alias name if given alias name is already assigned""" - ids = ids if isinstance(ids, (tuple, list)) else [ids] - if vals.get('alias_name') and ids: - vals['alias_name'] = self._clean_and_make_unique(cr, uid, vals.get('alias_name'), alias_id=ids[0], context=context) - return super(mail_alias, self).write(cr, uid, ids, vals, context=context) - - def open_document(self, cr, uid, ids, context=None): - alias = self.browse(cr, uid, ids, context=context)[0] - if not alias.alias_model_id or not alias.alias_force_thread_id: + @api.multi + def open_document(self): + if not self.alias_model_id or not self.alias_force_thread_id: return False return { 'view_type': 'form', 'view_mode': 'form', - 'res_model': alias.alias_model_id.model, - 'res_id': alias.alias_force_thread_id, + 'res_model': self.alias_model_id.model, + 'res_id': self.alias_force_thread_id, 'type': 'ir.actions.act_window', } - def open_parent_document(self, cr, uid, ids, context=None): - alias = self.browse(cr, uid, ids, context=context)[0] - if not alias.alias_parent_model_id or not alias.alias_parent_thread_id: + @api.multi + def open_parent_document(self): + if not self.alias_parent_model_id or not self.alias_parent_thread_id: return False return { 'view_type': 'form', 'view_mode': 'form', - 'res_model': alias.alias_parent_model_id.model, - 'res_id': alias.alias_parent_thread_id, + 'res_model': self.alias_parent_model_id.model, + 'res_id': self.alias_parent_thread_id, 'type': 'ir.actions.act_window', } |