odoo/addons/mail/mail_alias.py

# -*- 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/>.
#
##############################################################################

from openerp.osv import fields, osv
from tools.translate import _

class mail_alias(osv.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
       a Mail Alias, the message will be either processed following the rules
       of that alias. If the message is a reply it will be attached to the
       existing discussion on the corresponding record, otherwise a new
       record of the corresponding model will be created.
       
       This is meant to be used in combination with a catch-all email configuration
       on the company's mail server, so that as soon as a new mail.alias is
       created, it becomes immediately usable and OpenERP will accept email for it.
     """
    _name = 'mail.alias'
    _description = "Mail Alias"
    _rec_name = 'alias_name'

    def _get_alias_domain(self, cr, uid, ids, name, args, context=None):
        res = {}
        config_parameter_pool = self.pool.get("ir.config_parameter")
        domain = config_parameter_pool.get_param(cr, uid, "mail.catchall.domain", context=context)   
        for alias in self.browse(cr, uid, ids, context=context):
            res[alias.id] = domain or ""
        return res

    _columns = {
        'alias_name': fields.char('Mailbox Alias', size=255, required=True,
                            help="The name of the mailbox alias, e.g. 'jobs' "
                                 "if you want to catch emails for <jobs@example.my.openerp.com>",),
        'alias_model_id': fields.many2one('ir.model', 'Aliased Model', required=True,
                                          help="The model (OpenERP 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)",
                                          # only allow selecting mail_thread models!
                                          #TODO kept doamin temporarily in comment, need to redefine domain
                                          #domain="[('field_id', 'in', '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 kept empty 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="The representation of a Python dictionary that will be evaluated to provide "
                                           "default values when creating new records."),
        'alias_force_thread_id': fields.integer('Record Thread ID',
                                      help="Optional ID of the thread (record) to which all "
                                           "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 Doamin", type='char', size=None),
    }
    _defaults = {
        'alias_defaults': '{}',
        'alias_user_id': lambda self,cr,uid, context: uid
    }
    _sql_constraints = [
        ('mailbox_uniq', 'UNIQUE(alias_name)', 'Unfortunately this mail alias is already used, please choose a unique one')
    ]

    def _check_alias_defaults(self, cr, uid, ids, context=None):
        """
        Strick constraints checking for the alias defaults values.
        it must follow the python dict format. So message_catachall
        will not face any issue.
        """
        for record in self.browse(cr, uid, ids, context=context):
            try:
                dict(eval(record.alias_defaults))
            except:
                return False
            return True

    _constraints = [
        (_check_alias_defaults, "Default Values are in wrong format.\nIt must be in python dictionary format e.g.{'field_name': 'value' or {}}", ['alias_defaults']),
    ]

    def name_get(self, cr, uid, ids, context=None):
        """
        Return the mail alias display alias_name, inclusing the Implicit and dynamic
        Email Alias Domain from config.
        e.g. `jobs@openerp.my.openerp.com` or `sales@openerp.my.openerp.com`
        """
        res = []
        for record in self.read(cr, uid, ids, ['alias_name', 'alias_domain'], context=context):
            domain_alias = "%s@%s"%(record['alias_name'], record['alias_domain'])
            res.append((record['id'], domain_alias))
        return res

    def create_unique_alias(self, cr, uid, values, sequence=1 ,context=None):
        if sequence:
            prob_alias = "%s%s"%(values['alias_name'], sequence)
            search_alias = self.search(cr, uid, [('alias_name', '=', prob_alias)])
            if search_alias:    
                values = self.create_unique_alias(cr, uid, values, sequence+1, context)
            else:
                values.update({'alias_name': prob_alias})
                return values
        else:
            return values.update({'alias_name': "%s"%(values['alias_name'])})