1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2010-Today OpenERP SA (<http://www.openerp.com>)
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
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 General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>
20 ##############################################################################
24 from openerp import tools
26 from openerp.osv import osv
27 from openerp.osv import fields
28 from openerp.tools.safe_eval import safe_eval as eval
29 from openerp.tools.translate import _
31 # main mako-like expression pattern
32 EXPRESSION_PATTERN = re.compile('(\$\{.+?\})')
35 class mail_compose_message(osv.TransientModel):
36 """ Generic message composition wizard. You may inherit from this wizard
37 at model and view levels to provide specific features.
39 The behavior of the wizard depends on the composition_mode field:
40 - 'reply': reply to a previous message. The wizard is pre-populated
41 via ``get_message_data``.
42 - 'comment': new post on a record. The wizard is pre-populated via
44 - 'mass_mail': wizard in mass mailing mode where the mail details can
45 contain template placeholders that will be merged with actual data
46 before being sent to each recipient.
48 _name = 'mail.compose.message'
49 _inherit = 'mail.message'
50 _description = 'Email composition wizard'
53 def default_get(self, cr, uid, fields, context=None):
54 """ Handle composition mode. Some details about context keys:
55 - comment: default mode, model and ID of a record the user comments
56 - default_model or active_model
57 - default_res_id or active_id
58 - reply: active_id of a message the user replies to
59 - default_parent_id or message_id or active_id: ID of the
60 mail.message we reply to
61 - message.res_model or default_model
62 - message.res_id or default_res_id
63 - mass_mail: model and IDs of records the user mass-mails
64 - active_ids: record IDs
65 - default_model or active_model
69 result = super(mail_compose_message, self).default_get(cr, uid, fields, context=context)
71 # get some important values from context
72 composition_mode = context.get('default_composition_mode', context.get('mail.compose.message.mode'))
73 model = context.get('default_model', context.get('active_model'))
74 res_id = context.get('default_res_id', context.get('active_id'))
75 message_id = context.get('default_parent_id', context.get('message_id', context.get('active_id')))
76 active_ids = context.get('active_ids')
78 # get default values according to the composition mode
79 if composition_mode == 'reply':
80 vals = self.get_message_data(cr, uid, message_id, context=context)
81 elif composition_mode == 'comment' and model and res_id:
82 vals = self.get_record_data(cr, uid, model, res_id, context=context)
83 elif composition_mode == 'mass_mail' and model and active_ids:
84 vals = {'model': model, 'res_id': res_id}
86 vals = {'model': model, 'res_id': res_id}
88 vals['composition_mode'] = composition_mode
92 result[field] = vals[field]
94 # TDE HACK: as mailboxes used default_model='res.users' and default_res_id=uid
95 # (because of lack of an accessible pid), creating a message on its own
96 # profile may crash (res_users does not allow writing on it)
97 # Posting on its own profile works (res_users redirect to res_partner)
98 # but when creating the mail.message to create the mail.compose.message
99 # access rights issues may rise
100 # We therefore directly change the model and res_id
101 if result.get('model') == 'res.users' and result.get('res_id') == uid:
102 result['model'] = 'res.partner'
103 result['res_id'] = self.pool.get('res.users').browse(cr, uid, uid).partner_id.id
106 def _get_composition_mode_selection(self, cr, uid, context=None):
107 return [('comment', 'Comment a document'), ('reply', 'Reply to a message'), ('mass_mail', 'Mass mailing')]
110 'composition_mode': fields.selection(
111 lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
112 string='Composition mode'),
113 'partner_ids': fields.many2many('res.partner',
114 'mail_compose_message_res_partner_rel',
115 'wizard_id', 'partner_id', 'Additional contacts'),
116 'attachment_ids': fields.many2many('ir.attachment',
117 'mail_compose_message_ir_attachments_rel',
118 'wizard_id', 'attachment_id', 'Attachments'),
119 'filter_id': fields.many2one('ir.filters', 'Filters'),
123 'composition_mode': 'comment',
124 'body': lambda self, cr, uid, ctx={}: '',
125 'subject': lambda self, cr, uid, ctx={}: False,
126 'partner_ids': lambda self, cr, uid, ctx={}: [],
129 def _notify(self, cr, uid, newid, context=None):
130 """ Override specific notify method of mail.message, because we do
131 not want that feature in the wizard. """
134 def get_record_data(self, cr, uid, model, res_id, context=None):
135 """ Returns a defaults-like dict with initial values for the composition
136 wizard when sending an email related to the document record
137 identified by ``model`` and ``res_id``.
139 :param str model: model name of the document record this mail is
141 :param int res_id: id of the document record this mail is related to
143 doc_name_get = self.pool.get(model).name_get(cr, uid, [res_id], context=context)
145 record_name = doc_name_get[0][1]
148 return {'model': model, 'res_id': res_id, 'record_name': record_name}
150 def get_message_data(self, cr, uid, message_id, context=None):
151 """ Returns a defaults-like dict with initial values for the composition
152 wizard when replying to the given message (e.g. including the quote
153 of the initial message, and the correct recipients).
155 :param int message_id: id of the mail.message to which the user
162 message_data = self.pool.get('mail.message').browse(cr, uid, message_id, context=context)
166 reply_subject = tools.ustr(message_data.subject or '')
167 if not (reply_subject.startswith('Re:') or reply_subject.startswith(re_prefix)) and message_data.subject:
168 reply_subject = "%s %s" % (re_prefix, reply_subject)
169 # get partner_ids from original message
170 partner_ids = [partner.id for partner in message_data.partner_ids] if message_data.partner_ids else []
171 partner_ids += context.get('default_partner_ids', [])
175 'record_name': message_data.record_name,
176 'model': message_data.model,
177 'res_id': message_data.res_id,
178 'parent_id': message_data.id,
179 'subject': reply_subject,
180 'partner_ids': partner_ids,
184 #------------------------------------------------------
185 # Wizard validation and send
186 #------------------------------------------------------
188 def send_mail(self, cr, uid, ids, context=None):
189 """ Process the wizard content and proceed with sending the related
190 email(s), rendering any template patterns on the fly if needed. """
193 active_ids = context.get('active_ids')
194 is_log = context.get('mail_compose_log', False)
196 for wizard in self.browse(cr, uid, ids, context=context):
197 mass_mail_mode = wizard.composition_mode == 'mass_mail'
198 active_model_pool = self.pool.get(wizard.model if wizard.model else 'mail.thread')
200 # wizard works in batch mode: [res_id] or active_ids
201 res_ids = active_ids if mass_mail_mode and wizard.model and active_ids else [wizard.res_id]
202 for res_id in res_ids:
203 # default values, according to the wizard options
205 'subject': wizard.subject,
207 'parent_id': wizard.parent_id and wizard.parent_id.id,
208 'partner_ids': [partner.id for partner in wizard.partner_ids],
209 'attachments': [(attach.datas_fname or attach.name, base64.b64decode(attach.datas)) for attach in wizard.attachment_ids],
211 # mass mailing: render and override default values
212 if mass_mail_mode and wizard.model:
213 email_dict = self.render_message(cr, uid, wizard, res_id, context=context)
214 new_partner_ids = email_dict.pop('partner_ids', [])
215 post_values['partner_ids'] += new_partner_ids
216 new_attachments = email_dict.pop('attachments', [])
217 post_values['attachments'] += new_attachments
218 post_values.update(email_dict)
220 subtype = 'mail.mt_comment'
221 if is_log or mass_mail_mode:
223 msg_id = active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **post_values)
224 # mass_mailing: notify specific partners, because subtype was False, and no-one was notified
225 if mass_mail_mode and post_values['partner_ids']:
226 self.pool.get('mail.notification')._notify(cr, uid, msg_id, post_values['partner_ids'], context=context)
228 return {'type': 'ir.actions.act_window_close'}
230 def render_message(self, cr, uid, wizard, res_id, context=None):
231 """ Generate an email from the template for given (wizard.model, res_id)
232 pair. This method is meant to be inherited by email_template that
233 will produce a more complete dictionary. """
235 'subject': self.render_template(cr, uid, wizard.subject, wizard.model, res_id, context),
236 'body': self.render_template(cr, uid, wizard.body, wizard.model, res_id, context),
239 def render_template(self, cr, uid, template, model, res_id, context=None):
240 """ Render the given template text, replace mako-like expressions ``${expr}``
241 with the result of evaluating these expressions with an evaluation context
244 * ``user``: browse_record of the current user
245 * ``object``: browse_record of the document record this mail is
247 * ``context``: the context passed to the mail composition wizard
249 :param str template: the template text to render
250 :param str model: model name of the document record this mail is related to.
251 :param int res_id: id of the document record this mail is related to.
257 exp = str(match.group()[2:-1]).strip()
259 'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
260 'object': self.pool.get(model).browse(cr, uid, res_id, context=context),
261 'context': dict(context), # copy context to prevent side-effects of eval
263 return result and tools.ustr(result) or ''
264 return template and EXPRESSION_PATTERN.sub(merge, template)