-
Notifications
You must be signed in to change notification settings - Fork 27
/
distribution_list.py
453 lines (407 loc) · 17.5 KB
/
distribution_list.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
# -*- coding: utf-8 -*-
##############################################################################
#
# This file is part of mass_mailing_distribution_list, an Odoo module.
#
# Copyright (c) 2015 ACSONE SA/NV (<http://acsone.eu>)
#
# mass_mailing_distribution_list 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.
#
# mass_mailing_distribution_list 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 mass_mailing_distribution_list.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import logging
import base64
import re
import openerp
from openerp.osv import orm, fields
from openerp.tools import SUPERUSER_ID
from openerp.tools.translate import _
_logger = logging.getLogger(__name__)
MODE = ['in', 'out']
TEST_MSG = openerp.tools.ustr('TEST')
MATCH_EMAIL = re.compile('<(.*)>', re.IGNORECASE)
class DistributionList(orm.Model):
_name = 'distribution.list'
_inherit = ['distribution.list', 'mail.thread']
_inherits = {'mail.alias': 'alias_id'}
def _build_alias_name(self, cr, uid, name, context=None):
"""
:type name: char
:param name: name of a distribution list
:rtype: char
:rparam: unique alias name from the given distribution list
:raise: orm_except if no `catchall alias` defined
"""
ir_cfg_obj = self.pool['ir.config_parameter']
catchall_alias = ir_cfg_obj.get_param(
cr, uid, 'mail.catchall.alias', context=context)
if not catchall_alias:
raise orm.except_orm(
_('Error'),
_('Please contact your Administrator '
'to configure a "catchall" mail alias'))
alias_name = self.pool['mail.alias']._clean_and_make_unique(
cr, uid, '%s+%s' % (catchall_alias, name), context=context)
return alias_name
def _set_active_ids(self, cr, uid, dl_id, msg, context):
"""
Verify that email_from identifies uniquely a document
in the target model of the distribution list
If True:
* Set `dl_computed` to True together with `active_ids` indicating
the distribution should not be computed, this is only a test message
to forward to the sender, in this case the "TEST" prefix of
the subject is also removed
* Set `dl_computed` to False indicating the distribution
must be computed, the mail will be sent to all distribution list
recipients
:type dl_id: integer
:param dl_id: distribution list id
:type msg: {}
:param msg: mail unicode values email_from, subject...
:type context: {}
:param context: context in which to set `active_ids` and `dl_computed`
"""
res_ids = self._get_mailing_object(
cr, uid, dl_id, msg['email_from'], context=context)
if len(res_ids) != 1:
_logger.warning(
'An unknown or ambiguous email (%s) '
'tries to forward a mail through a distribution list' %
msg['email_from'])
elif msg['subject'][0:4].upper() == TEST_MSG:
# do not send to all recipients: this is just a test
msg['subject'] = msg['subject'][4:]
context['active_ids'] = res_ids
context['dl_computed'] = True
else:
context['dl_computed'] = False
def _get_mailing_object(
self, cr, uid, dl_id, email_from, mailing_model=False,
email_field='email', context=None):
"""
:type email_from: char
:param email_from: email to find
:type mailing_model: char
:param mailing_model: a given model name to search on
:type email_field: char
:param email_field: name of the columns that possibly contains the
email to search
:rtype: integer or boolean
:rparam: id of the object that contains `email_from` or False
"""
res = re.findall(MATCH_EMAIL, email_from)
email_from = res and res[0] or email_from
if not mailing_model:
dl = self.browse(cr, uid, dl_id, context=context)
mailing_model = dl.dst_model_id.model
mailing_object = self.pool[mailing_model]
domain = [(email_field, '=', email_from)]
mailing_ids = mailing_object.search(
cr, uid, domain, context=context)
return mailing_ids
def _get_attachment_id(self, cr, uid, datas, context=None):
ir_attach_vals = {
'name': datas[0],
'datas_fname': datas[0],
'datas': base64.encodestring(datas[1]),
'res_model': 'mail.compose.message',
}
return self.pool['ir.attachment'].create(
cr, uid, ir_attach_vals, context=context)
def _get_mail_compose_message_vals(
self, cr, uid, msg, dl_id, mailing_model=False, context=None):
dl = self.browse(cr, uid, dl_id, context=context)
if not mailing_model:
mailing_model = dl.dst_model_id.model
attachment_ids = []
if msg.get('attachments', False):
for attachment in msg['attachments']:
attachment_ids.append(self._get_attachment_id(
cr, uid, attachment, context=context))
return {
'email_from': msg.get('from', False),
'composition_mode': 'mass_mail',
'subject': msg.get('subject', False),
'body': msg.get('body', False),
'distribution_list_id': dl_id,
'mass_mailing_name': 'Mass Mailing %s' % dl.name,
'model': mailing_model,
'attachment_ids': [[6, 0, attachment_ids]],
}
def _get_opt_res_ids(
self, cr, uid, model_name, domain, in_mode, context=None):
"""
:param model_name: model of the reasearch
:type model_name: string
:param domain: domain to be searched
:type domain: [(,)]
:param in_mode: True if opt_in are concerned otherwise False
:type: in_mode: boolean
:rparam: resulting ids
:rtype: []
"""
dl_obj = self.pool[model_name]
opt_ids = dl_obj.search(cr, uid, domain, context=context)
return opt_ids
_columns = {
'mail_forwarding': fields.boolean('Mail Forwarding'),
'alias_id': fields.many2one(
'mail.alias', string='Email Alias',
ondelete='restrict', required=True, copy=False,
help="Internal email associated with this distribution list. "
"Incoming emails will be automatically forwarded "
"to all recipients of the distribution list."),
'newsletter': fields.boolean('Newsletter'),
'partner_path': fields.char('Partner Path'),
'opt_out_ids': fields.many2many('res.partner',
'distribution_list_res_partner_out',
id1='distribution_list_id',
id2='partner_id', string='Opt-Out'),
'opt_in_ids': fields.many2many('res.partner',
'distribution_list_res_partner_in',
id1='distribution_list_id',
id2='partner_id', string='Opt-In'),
}
_defaults = {
# default model is partner
'partner_path': 'id',
'mail_forwarding': False,
'newsletter': False,
}
def _check_forwarding(self, cr, uid, ids, context=None):
"""
:rparam: False if alias_name and mail_forwarding are incompatible
True otherwise
:rtype: Boolean
"""
for dl in self.browse(cr, uid, ids, context=context):
if dl.mail_forwarding != bool(dl.alias_name):
return False
return True
_constraints = [
(_check_forwarding,
'An alias is mandatory for mail forwarding, forbidden otherwise',
['mail_forwarding', 'alias_name']),
]
def _auto_init(self, cr, context=None):
"""
Installation hook to create aliases for all distribution lists
avoiding constraint errors
"""
return self.pool['mail.alias'].migrate_to_alias(
cr, self._name, self._table,
super(DistributionList, self)._auto_init,
self._name, self._columns['alias_id'], 'name',
alias_defaults={'distribution_list_id': 'id'}, context=context)
def create(self, cr, uid, vals, context=None):
create_context = dict(
context or {},
alias_model_name=self._name, alias_parent_model_name=self._name)
if not vals.get('mail_forwarding'):
vals.pop('alias_name', False)
dl_id = super(DistributionList, self).create(
cr, uid, vals, context=create_context)
dl = self.browse(cr, uid, dl_id, context=context)
self.pool['mail.alias'].write(
cr, uid, [dl.alias_id.id], {
'alias_parent_thread_id': dl_id,
'alias_defaults': {'distribution_list_id': dl_id}
}, context=context)
return dl_id
def copy(self, cr, uid, dl_id, default=None, context=None):
if default is None:
default = {}
dl = self.browse(cr, uid, dl_id, context=context)
if not default.get('alias_name') and dl.mail_forwarding:
alias_name = self._build_alias_name(
cr, uid, _("%s+copy") % dl.name, context=context)
default['alias_name'] = alias_name
elif not dl.mail_forwarding:
default['alias_name'] = False
res = super(DistributionList, self).copy(
cr, uid, dl_id, default, context=context)
return res
def write(self, cr, uid, ids, vals, context=None):
if 'mail_forwarding' in vals and not vals.get('mail_forwarding'):
vals['alias_name'] = False
return super(DistributionList, self).write(
cr, uid, ids, vals, context=context)
def unlink(self, cr, uid, ids, context=None):
mail_alias = self.pool['mail.alias']
alias_ids = [
dl.alias_id.id
for dl in self.browse(cr, uid, ids, context=context)
if dl.alias_id
]
res = super(DistributionList, self).unlink(
cr, uid, ids, context=context)
mail_alias.unlink(cr, uid, alias_ids, context=context)
return res
def message_new(self, cr, uid, msg_dict, custom_values=None, context=None):
"""
Override the native mail.thread method to not create a document anymore
for distribution list object.
New Behavior is to forward the current message `msg_dict` to all
recipients of the distribution list
:type custom_values: {}
:param custom_values: contains the distribution list id into key 'id'
:type msg_dict: {}
:param msg_dict: message to forward to all resulting ids of
distribution list
"""
if custom_values is None:
custom_values = {}
dl_id = custom_values.get('distribution_list_id') or None
if not dl_id:
_logger.warning(
'Mail Forwarding not available: '
'no distribution list specified%s' % (
msg_dict.get('to') and
' for alias %s' % msg_dict['to'] or ''))
else:
if self.allow_forwarding(cr, uid, dl_id, context=context):
self.distribution_list_forwarding(
cr, uid, msg_dict, dl_id, context=context)
else:
_logger.warning(
'Mail Forwarding not allowed for distribution list %s: '
'Email "%s" send however a message to it' %
(dl_id, msg_dict.get('email_from', '??')))
return dl_id
def message_update(
self, cr, uid, ids, msg_dict, update_vals=None, context=None):
"""
Do not allow update case of mail forwarding
"""
return True
def _register_hook(self, cr):
"""
Call `_get_mailing_model` of `mail.mass_mailing` to set a `domain` on
`dst_model_id` to keep consistency between resulting ids
"""
super(DistributionList, self)._register_hook(cr)
res = self.pool['mail.mass_mailing']._get_mailing_model(
cr, SUPERUSER_ID)
mass_mailing_models = []
for model in res:
mass_mailing_models.append(model[0])
type(self).dst_model_id.domain = [('model', 'in', mass_mailing_models)]
def get_ids_from_distribution_list(
self, cr, uid, ids, safe_mode=True, context=None):
'''
manage opt in/out.
If the distribution list are newsletter and also have a parther_path
then
* remove all res_ids that contains a partner id into the opt_out_ids
* add to res_ids all partner id into the opt_in_ids
'''
res_ids = super(DistributionList, self).\
get_ids_from_distribution_list(cr, uid, ids, safe_mode=safe_mode,
context=context)
for dl in self.browse(cr, uid, ids, context=context):
if dl.newsletter and dl.partner_path:
partner_path = dl.partner_path
# manage opt result
# opt in
partner_ids = [p.id for p in dl.opt_in_ids]
domain = [(partner_path, 'in', partner_ids)]
opt_in_ids = self._get_opt_res_ids(
cr, uid, dl.dst_model_id.model, domain, True,
context=context)
res_ids += opt_in_ids
# opt out
partner_ids = [p.id for p in dl.opt_out_ids]
domain = [(partner_path, 'in', partner_ids)]
opt_out_ids = self._get_opt_res_ids(
cr, uid, dl.dst_model_id.model, domain, False,
context=context)
res_ids = list(set(res_ids) - set(opt_out_ids))
return res_ids
def update_opt(
self, cr, uid, dl_id, partner_ids, mode='out', context=None):
'''
update the list of opt out/in
:type dl_id: integer
:param dl_id: id of distribution list
:type partner_ids: list of integer
:param partner_ids: list of partner's id
:type mode: char
:param mode: in or out depending if we want to add or remove partner
from the list
:rtype: boolean
:rparam: True if distribution list is well updated. Otherwise False
:except: except_orm if mode is not into the MODE list
'''
if mode not in MODE:
raise orm.except_orm(
_('Error'), _('Mode "%s" is not a valid mode'))
opt_val = []
if partner_ids:
if len(partner_ids) == 1:
opt_val = [(4, partner_ids[0])]
else:
p_ids = []
dl_rec = self.browse(cr, uid, dl_id, context=context)
for l in eval('dl_rec.opt_%s_ids' % mode, {'dl_rec': dl_rec}):
p_ids.append(l.id)
opt_val = [(6, 0, list(set(partner_ids + p_ids)))]
vals = {
'opt_%s_ids' % mode: opt_val,
}
return self.write(cr, uid, dl_id, vals, context=context)
return False
def distribution_list_forwarding(self, cr, uid, msg, dl_id, context=None):
'''
Create a `mail.compose.message` depending of the message msg and then
send a mail with this composer to the resulting ids of the
distribution list `dl_id`
'''
if context is None:
context = {}
ctx = context.copy()
# update ctx['active_ids']
self._set_active_ids(cr, uid, dl_id, msg, ctx)
if ctx.get('active_ids') or not ctx.get('dl_computed', True):
mail_composer_obj = self.pool['mail.compose.message']
# get composer values to create wizard
mail_composer_vals = self._get_mail_compose_message_vals(
cr, uid, msg, dl_id, context=ctx)
mail_composer_id = mail_composer_obj.create(
cr, uid, mail_composer_vals, context=ctx)
mail_composer_obj.send_mail(
cr, uid, [mail_composer_id], context=ctx)
def allow_forwarding(self, cr, uid, dl_id, context=None):
"""
Define if the distribution list is allowed to make forwarding
:type dl_id: integer
:param dl_id: a distribution_list id
:rtype: boolean
:rparam: True if distribution is allowed otherwise False
"""
return self.read(
cr, uid, dl_id, ['mail_forwarding'],
context=context)['mail_forwarding']
def onchange_mail_forwarding(
self, cr, uid, ids,
mail_forwarding, name, alias_name, context=None):
vals = {}
if mail_forwarding and not alias_name and name:
vals['alias_name'] = self._build_alias_name(cr, uid, name, context)
return {
'value': vals,
}