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 ##############################################################################
23 from openerp import tools
24 from openerp import SUPERUSER_ID
25 from openerp.osv import osv
26 from openerp.osv import fields
27 from openerp.tools.safe_eval import safe_eval as eval
28 from openerp.tools.translate import _
30 # main mako-like expression pattern
31 EXPRESSION_PATTERN = re.compile('(\$\{.+?\})')
34 class mail_compose_message(osv.TransientModel):
35 """ Generic message composition wizard. You may inherit from this wizard
36 at model and view levels to provide specific features.
38 The behavior of the wizard depends on the composition_mode field:
39 - 'reply': reply to a previous message. The wizard is pre-populated
40 via ``get_message_data``.
41 - 'comment': new post on a record. The wizard is pre-populated via
43 - 'mass_mail': wizard in mass mailing mode where the mail details can
44 contain template placeholders that will be merged with actual data
45 before being sent to each recipient.
47 _name = 'mail.compose.message'
48 _inherit = 'mail.message'
49 _description = 'Email composition wizard'
52 def default_get(self, cr, uid, fields, context=None):
53 """ Handle composition mode. Some details about context keys:
54 - comment: default mode, model and ID of a record the user comments
55 - default_model or active_model
56 - default_res_id or active_id
57 - reply: active_id of a message the user replies to
58 - default_parent_id or message_id or active_id: ID of the
59 mail.message we reply to
60 - message.res_model or default_model
61 - message.res_id or default_res_id
62 - mass_mail: model and IDs of records the user mass-mails
63 - active_ids: record IDs
64 - default_model or active_model
68 result = super(mail_compose_message, self).default_get(cr, uid, fields, context=context)
69 # get some important values from context
70 composition_mode = context.get('default_composition_mode', context.get('mail.compose.message.mode'))
71 model = context.get('default_model', context.get('active_model'))
72 res_id = context.get('default_res_id', context.get('active_id'))
73 message_id = context.get('default_parent_id', context.get('message_id', context.get('active_id')))
74 active_ids = context.get('active_ids')
75 if 'active_domain' in context: # not context.get() because we want to keep global [] domains
76 result['use_active_domain'] = True
77 result['active_domain'] = '%s' % context.get('active_domain')
79 result['active_domain'] = ''
80 # get default values according to the composition mode
81 if composition_mode == 'reply':
82 vals = self.get_message_data(cr, uid, message_id, context=context)
83 elif composition_mode == 'comment' and model and res_id:
84 vals = self.get_record_data(cr, uid, model, res_id, context=context)
85 elif composition_mode == 'mass_mail' and model and active_ids:
86 vals = {'model': model, 'res_id': res_id}
88 vals = {'model': model, 'res_id': res_id}
90 vals['composition_mode'] = composition_mode
94 result[field] = vals[field]
96 # TDE HACK: as mailboxes used default_model='res.users' and default_res_id=uid
97 # (because of lack of an accessible pid), creating a message on its own
98 # profile may crash (res_users does not allow writing on it)
99 # Posting on its own profile works (res_users redirect to res_partner)
100 # but when creating the mail.message to create the mail.compose.message
101 # access rights issues may rise
102 # We therefore directly change the model and res_id
103 if result.get('model') == 'res.users' and result.get('res_id') == uid:
104 result['model'] = 'res.partner'
105 result['res_id'] = self.pool.get('res.users').browse(cr, uid, uid).partner_id.id
108 def _get_composition_mode_selection(self, cr, uid, context=None):
109 return [('comment', 'Comment a document'), ('reply', 'Reply to a message'), ('mass_mail', 'Mass mailing')]
112 'composition_mode': fields.selection(
113 lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
114 string='Composition mode'),
115 'partner_ids': fields.many2many('res.partner',
116 'mail_compose_message_res_partner_rel',
117 'wizard_id', 'partner_id', 'Additional contacts'),
118 'use_active_domain': fields.boolean('Use active domain'),
119 'active_domain': fields.char('Active domain', readonly=True),
120 'post': fields.boolean('Post a copy in the document',
121 help='Post a copy of the message on the document communication history.'),
122 'notify': fields.boolean('Notify followers',
123 help='Notify followers of the document'),
124 'same_thread': fields.boolean('Replies in the document',
125 help='Replies to the messages will go into the selected document.'),
126 'attachment_ids': fields.many2many('ir.attachment',
127 'mail_compose_message_ir_attachments_rel',
128 'wizard_id', 'attachment_id', 'Attachments'),
129 'filter_id': fields.many2one('ir.filters', 'Filters'),
133 'composition_mode': 'comment',
134 'body': lambda self, cr, uid, ctx={}: '',
135 'subject': lambda self, cr, uid, ctx={}: False,
136 'partner_ids': lambda self, cr, uid, ctx={}: [],
142 def check_access_rule(self, cr, uid, ids, operation, context=None):
143 """ Access rules of mail.compose.message:
145 - model, no res_id, I create a message in mass mail mode
146 - then: fall back on mail.message acces rules
148 if isinstance(ids, (int, long)):
151 # Author condition (CREATE (mass_mail))
152 if operation == 'create' and uid != SUPERUSER_ID:
153 # read mail_compose_message.ids to have their values
155 cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
156 for id, rmod, rid in cr.fetchall():
157 message_values[id] = {'model': rmod, 'res_id': rid}
158 # remove from the set to check the ids that mail_compose_message accepts
159 author_ids = [mid for mid, message in message_values.iteritems()
160 if message.get('model') and not message.get('res_id')]
161 ids = list(set(ids) - set(author_ids))
163 return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
165 def _notify(self, cr, uid, newid, context=None, force_send=False, user_signature=True):
166 """ Override specific notify method of mail.message, because we do
167 not want that feature in the wizard. """
170 def get_record_data(self, cr, uid, model, res_id, context=None):
171 """ Returns a defaults-like dict with initial values for the composition
172 wizard when sending an email related to the document record
173 identified by ``model`` and ``res_id``.
175 :param str model: model name of the document record this mail is
177 :param int res_id: id of the document record this mail is related to
179 doc_name_get = self.pool[model].name_get(cr, uid, [res_id], context=context)
182 record_name = doc_name_get[0][1]
186 'record_name': record_name,
189 values['subject'] = 'Re: %s' % record_name
192 def get_message_data(self, cr, uid, message_id, context=None):
193 """ Returns a defaults-like dict with initial values for the composition
194 wizard when replying to the given message (e.g. including the quote
195 of the initial message, and the correct recipients).
197 :param int message_id: id of the mail.message to which the user
204 message_data = self.pool.get('mail.message').browse(cr, uid, message_id, context=context)
208 reply_subject = tools.ustr(message_data.subject or message_data.record_name or '')
209 if not (reply_subject.startswith('Re:') or reply_subject.startswith(re_prefix)) and message_data.subject:
210 reply_subject = "%s %s" % (re_prefix, reply_subject)
211 # get partner_ids from original message
212 partner_ids = [partner.id for partner in message_data.partner_ids] if message_data.partner_ids else []
213 partner_ids += context.get('default_partner_ids', [])
214 if context.get('is_private',False) and message_data.author_id : #check message is private then add author also in partner list.
215 partner_ids += [message_data.author_id.id]
218 'record_name': message_data.record_name,
219 'model': message_data.model,
220 'res_id': message_data.res_id,
221 'parent_id': message_data.id,
222 'subject': reply_subject,
223 'partner_ids': partner_ids,
227 #------------------------------------------------------
228 # Wizard validation and send
229 #------------------------------------------------------
231 def send_mail(self, cr, uid, ids, context=None):
232 """ Process the wizard content and proceed with sending the related
233 email(s), rendering any template patterns on the fly if needed. """
236 # clean the context (hint: mass mailing sets some default values that
237 # could be wrongly interpreted by mail_mail)
238 context.pop('default_email_to', None)
239 context.pop('default_partner_ids', None)
241 active_ids = context.get('active_ids')
242 is_log = context.get('mail_compose_log', False)
244 for wizard in self.browse(cr, uid, ids, context=context):
245 mass_mail_mode = wizard.composition_mode == 'mass_mail'
246 active_model_pool = self.pool[wizard.model if wizard.model else 'mail.thread']
247 if not hasattr(active_model_pool, 'message_post'):
248 context['thread_model'] = wizard.model
249 active_model_pool = self.pool['mail.thread']
251 # wizard works in batch mode: [res_id] or active_ids or active_domain
252 if mass_mail_mode and wizard.use_active_domain and wizard.model:
253 res_ids = self.pool[wizard.model].search(cr, uid, eval(wizard.active_domain), context=context)
254 elif mass_mail_mode and wizard.model and active_ids:
257 res_ids = [wizard.res_id]
259 all_mail_values = self.get_mail_values(cr, uid, wizard, res_ids, context=context)
261 for res_id, mail_values in all_mail_values.iteritems():
262 if mass_mail_mode and not wizard.post:
263 self.pool.get('mail.mail').create(cr, uid, mail_values, context=context)
265 subtype = 'mail.mt_comment'
266 if is_log: # log a note: subtype is False
268 elif mass_mail_mode: # mass mail: is a log pushed to recipients unless specified, author not added
269 if not wizard.notify:
271 context = dict(context,
272 mail_notify_force_send=False, # do not send emails directly but use the queue instead
273 mail_create_nosubscribe=True) # add context key to avoid subscribing the author
274 active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **mail_values)
276 return {'type': 'ir.actions.act_window_close'}
278 def get_mail_values(self, cr, uid, wizard, res_ids, context=None):
279 """Generate the values that will be used by send_mail to create mail_messages
281 results = dict.fromkeys(res_ids, False)
282 mass_mail_mode = wizard.composition_mode == 'mass_mail'
284 # render all template-based value at once
285 if mass_mail_mode and wizard.model:
286 rendered_values = self.render_message_batch(cr, uid, wizard, res_ids, context=context)
288 for res_id in res_ids:
289 # static wizard (mail.message) values
291 'subject': wizard.subject,
293 'parent_id': wizard.parent_id and wizard.parent_id.id,
294 'partner_ids': [partner.id for partner in wizard.partner_ids],
295 'attachment_ids': [attach.id for attach in wizard.attachment_ids],
297 # mass mailing: rendering override wizard static values
298 if mass_mail_mode and wizard.model:
299 email_dict = rendered_values[res_id]
300 mail_values['partner_ids'] += email_dict.pop('partner_ids', [])
301 mail_values['attachments'] = email_dict.pop('attachments', [])
303 for attach_id in mail_values.pop('attachment_ids'):
304 new_attach_id = self.pool.get('ir.attachment').copy(cr, uid, attach_id, {'res_model': self._name, 'res_id': wizard.id}, context=context)
305 attachment_ids.append(new_attach_id)
306 mail_values['attachment_ids'] = attachment_ids
307 # email_from: mass mailing only can specify another email_from
308 if email_dict.get('email_from'):
309 mail_values['email_from'] = email_dict.pop('email_from')
310 # replies redirection: mass mailing only
311 if not wizard.same_thread:
312 mail_values['reply_to'] = email_dict.pop('reply_to')
314 email_dict.pop('reply_to')
315 mail_values.update(email_dict)
316 # mass mailing without post: mail_mail values
317 if mass_mail_mode and not wizard.post:
318 if 'mail_auto_delete' in context:
319 mail_values['auto_delete'] = context.get('mail_auto_delete')
320 mail_values['body_html'] = mail_values.get('body', '')
321 mail_values['recipient_ids'] = [(4, id) for id in mail_values.pop('partner_ids', [])]
322 results[res_id] = mail_values
325 def render_message_batch(self, cr, uid, wizard, res_ids, context=None):
326 """Generate template-based values of wizard, for the document records given
327 by res_ids. This method is meant to be inherited by email_template that
328 will produce a more complete dictionary, using Jinja2 templates.
330 Each template is generated for all res_ids, allowing to parse the template
331 once, and render it multiple times. This is useful for mass mailing where
332 template rendering represent a significant part of the process.
334 :param browse wizard: current mail.compose.message browse record
335 :param list res_ids: list of record ids
337 :return dict results: for each res_id, the generated template values for
338 subject, body, email_from and reply_to
340 subjects = self.render_template_batch(cr, uid, wizard.subject, wizard.model, res_ids, context)
341 bodies = self.render_template_batch(cr, uid, wizard.body, wizard.model, res_ids, context)
342 emails_from = self.render_template_batch(cr, uid, wizard.email_from, wizard.model, res_ids, context)
343 replies_to = self.render_template_batch(cr, uid, wizard.reply_to, wizard.model, res_ids, context)
345 results = dict.fromkeys(res_ids, False)
346 for res_id in res_ids:
348 'subject': subjects[res_id],
349 'body': bodies[res_id],
350 'email_from': emails_from[res_id],
351 'reply_to': replies_to[res_id],
355 def render_template_batch(self, cr, uid, template, model, res_ids, context=None):
356 """ Render the given template text, replace mako-like expressions ``${expr}``
357 with the result of evaluating these expressions with an evaluation context
360 * ``user``: browse_record of the current user
361 * ``object``: browse_record of the document record this mail is
363 * ``context``: the context passed to the mail composition wizard
365 :param str template: the template text to render
366 :param str model: model name of the document record this mail is related to
367 :param list res_ids: list of record ids
371 results = dict.fromkeys(res_ids, False)
373 for res_id in res_ids:
375 exp = str(match.group()[2:-1]).strip()
377 'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
378 'object': self.pool[model].browse(cr, uid, res_id, context=context),
379 'context': dict(context), # copy context to prevent side-effects of eval
381 return result and tools.ustr(result) or ''
382 results[res_id] = template and EXPRESSION_PATTERN.sub(merge, template)
385 # Compatibility methods
386 def render_template(self, cr, uid, template, model, res_id, context=None):
387 return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
389 def render_message(self, cr, uid, wizard, res_id, context=None):
390 return self.render_message_batch(cr, uid, wizard, [res_id], context)[res_id]