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 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
|
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import base64
from collections import defaultdict
import hashlib
import hmac
import io
import logging
import lxml
import random
import re
import requests
import threading
import werkzeug.urls
from ast import literal_eval
from dateutil.relativedelta import relativedelta
from markupsafe import Markup
from werkzeug.urls import url_join
from PIL import Image, UnidentifiedImageError
from odoo import api, fields, models, tools, _
from odoo.addons.base_import.models.base_import import ImportValidationError
from odoo.exceptions import UserError, ValidationError
from odoo.osv import expression
from odoo.tools.float_utils import float_round
from odoo.tools.image import ImageProcess
_logger = logging.getLogger(__name__)
# Syntax of the data URL Scheme: https://tools.ietf.org/html/rfc2397#section-3
# Used to find inline images
image_re = re.compile(r"data:(image/[A-Za-z]+);base64,(.*)")
DEFAULT_IMAGE_TIMEOUT = 3
DEFAULT_IMAGE_MAXBYTES = 10 * 1024 * 1024 # 10MB
DEFAULT_IMAGE_CHUNK_SIZE = 32768
mso_re = re.compile(r"\[if mso\]>[\s\S]*<!\[endif\]")
class MassMailing(models.Model):
""" Mass Mailing models the sending of emails to a list of recipients for a mass mailing campaign."""
_name = 'mailing.mailing'
_description = 'Mass Mailing'
_inherit = ['mail.thread',
'mail.activity.mixin',
'mail.render.mixin',
'utm.source.mixin'
]
_order = 'calendar_date DESC'
_rec_name = "subject"
_systray_view = 'list'
@api.model
def default_get(self, fields_list):
vals = super(MassMailing, self).default_get(fields_list)
# field sent by the calendar view when clicking on a date block
# we use it to setup the scheduled date of the created mailing.mailing
default_calendar_date = self.env.context.get('default_calendar_date')
if default_calendar_date and ('schedule_type' in fields_list and 'schedule_date' in fields_list) \
and fields.Datetime.from_string(default_calendar_date) > fields.Datetime.now():
vals.update({
'schedule_type': 'scheduled',
'schedule_date': default_calendar_date
})
if 'contact_list_ids' in fields_list and not vals.get('contact_list_ids') and vals.get('mailing_model_id'):
if vals.get('mailing_model_id') == self.env['ir.model']._get_id('mailing.list'):
mailing_list = self.env['mailing.list'].search([], limit=2)
if len(mailing_list) == 1:
vals['contact_list_ids'] = [(6, 0, [mailing_list.id])]
return vals
@api.model
def _get_default_mail_server_id(self):
server_id = self.env['ir.config_parameter'].sudo().get_param('mass_mailing.mail_server_id')
try:
server_id = literal_eval(server_id) if server_id else False
return self.env['ir.mail_server'].search([('id', '=', server_id)]).id
except ValueError:
return False
active = fields.Boolean(default=True, tracking=True)
subject = fields.Char(
'Subject', required=True, translate=False)
preview = fields.Char(
'Preview', translate=False,
render_engine='inline_template', render_options={'post_process': True},
help='Catchy preview sentence that encourages recipients to open this email.\n'
'In most inboxes, this is displayed next to the subject.\n'
'Keep it empty if you prefer the first characters of your email content to appear instead.')
email_from = fields.Char(
string='Send From',
compute='_compute_email_from', readonly=False, required=True, store=True, precompute=True)
favorite = fields.Boolean('Favorite', copy=False, tracking=True)
favorite_date = fields.Datetime(
'Favorite Date',
compute='_compute_favorite_date', store=True,
copy=False,
help='When this mailing was added in the favorites')
sent_date = fields.Datetime(string='Sent Date', copy=False)
schedule_type = fields.Selection(
[('now', 'Send now'), ('scheduled', 'Send on')],
string='Schedule', default='now',
readonly=False, required=True)
schedule_date = fields.Datetime(
string='Scheduled for',
compute='_compute_schedule_date', readonly=False, store=True,
copy=True, tracking=True)
calendar_date = fields.Datetime(
'Calendar Date',
compute='_compute_calendar_date', store=True,
copy=False,
help="Date at which the mailing was or will be sent.")
# don't translate 'body_arch', the translations are only on 'body_html'
body_arch = fields.Html(string='Body', translate=False, sanitize='email_outgoing', sanitize_output_method="html")
body_html = fields.Html(
string='Body converted to be sent by mail', sanitize='email_outgoing',
render_engine='qweb', render_options={'post_process': True})
is_body_empty = fields.Boolean(compute="_compute_is_body_empty")
attachment_ids = fields.Many2many(
'ir.attachment', 'mass_mailing_ir_attachments_rel',
'mass_mailing_id', 'attachment_id', string='Attachments')
keep_archives = fields.Boolean(string='Keep Archives')
campaign_id = fields.Many2one('utm.campaign', string='UTM Campaign', index=True, ondelete='set null')
medium_id = fields.Many2one(
'utm.medium', string='Medium',
compute='_compute_medium_id', readonly=False, store=True,
ondelete='restrict',
help="UTM Medium: delivery method (email, sms, ...)")
state = fields.Selection(
[('draft', 'Draft'), ('in_queue', 'In Queue'),
('sending', 'Sending'), ('done', 'Sent')],
string='Status',
default='draft', required=True,
copy=False, tracking=True,
group_expand=True)
color = fields.Integer(string='Color Index')
user_id = fields.Many2one(
'res.users', string='Responsible',
tracking=True,
default=lambda self: self.env.user)
# mailing options
mailing_type = fields.Selection([('mail', 'Email')], string="Mailing Type", default="mail", required=True)
mailing_type_description = fields.Char('Mailing Type Description', compute="_compute_mailing_type_description")
reply_to_mode = fields.Selection(
[('update', 'Recipient Followers'), ('new', 'Specified Email Address')],
string='Reply-To Mode',
compute='_compute_reply_to_mode', readonly=False, store=True,
help='Thread: replies go to target document. Email: replies are routed to a given email.')
reply_to = fields.Char(
string='Reply To',
compute='_compute_reply_to', readonly=False, store=True,
help='Preferred Reply-To Address')
# recipients
mailing_model_real = fields.Char(
string='Recipients Real Model', compute='_compute_mailing_model_real')
mailing_model_id = fields.Many2one(
'ir.model', string='Recipients Model',
ondelete='cascade', required=True,
domain=[('is_mailing_enabled', '=', True)],
default=lambda self: self.env.ref('mass_mailing.model_mailing_list').id)
mailing_model_name = fields.Char(
string='Recipients Model Name',
related='mailing_model_id.model', readonly=True, related_sudo=True)
mailing_on_mailing_list = fields.Boolean(
string='Based on Mailing Lists',
compute='_compute_mailing_on_mailing_list')
mailing_domain = fields.Char(
string='Domain',
compute='_compute_mailing_domain', readonly=False, store=True)
mail_server_available = fields.Boolean(
compute='_compute_mail_server_available',
help="Technical field used to know if the user has activated the outgoing mail server option in the settings")
mail_server_id = fields.Many2one('ir.mail_server', string='Mail Server',
default=_get_default_mail_server_id,
help="Use a specific mail server in priority. Otherwise Odoo relies on the first outgoing mail server available (based on their sequencing) as it does for normal mails.")
contact_list_ids = fields.Many2many('mailing.list', 'mail_mass_mailing_list_rel', string='Mailing Lists')
# Mailing Filter
mailing_filter_id = fields.Many2one(
'mailing.filter', string='Favorite Filter',
compute='_compute_mailing_filter_id', readonly=False, store=True,
domain="[('mailing_model_name', '=', mailing_model_name)]")
mailing_filter_domain = fields.Char('Favorite filter domain', related='mailing_filter_id.mailing_domain')
mailing_filter_count = fields.Integer('# Favorite Filters', compute='_compute_mailing_filter_count')
# A/B Testing
ab_testing_completed = fields.Boolean(related='campaign_id.ab_testing_completed')
ab_testing_description = fields.Html('A/B Testing Description', compute="_compute_ab_testing_description")
ab_testing_enabled = fields.Boolean(
string='Allow A/B Testing', default=False,
help='If checked, recipients will be mailed only once for the whole campaign. '
'This lets you send different mailings to randomly selected recipients and test '
'the effectiveness of the mailings, without causing duplicate messages.')
ab_testing_is_winner_mailing = fields.Boolean('Is the Winner of its Campaign', compute='_compute_ab_testing_is_winner_mailing')
ab_testing_mailings_count = fields.Integer(related="campaign_id.ab_testing_mailings_count")
ab_testing_pc = fields.Integer(
string='A/B Testing percentage',
default=10,
help='Percentage of the contacts that will be mailed. Recipients will be chosen randomly.')
ab_testing_schedule_datetime = fields.Datetime(
related="campaign_id.ab_testing_schedule_datetime", readonly=False,
default=lambda self: fields.Datetime.now() + relativedelta(days=1))
ab_testing_winner_selection = fields.Selection(
related="campaign_id.ab_testing_winner_selection", readonly=False,
default="opened_ratio",
copy=True)
is_ab_test_sent = fields.Boolean(compute="_compute_is_ab_test_sent")
kpi_mail_required = fields.Boolean('KPI mail required', copy=False)
# statistics data
mailing_trace_ids = fields.One2many('mailing.trace', 'mass_mailing_id', string='Emails Statistics')
total = fields.Integer(compute="_compute_total")
scheduled = fields.Integer(compute="_compute_statistics")
expected = fields.Integer(compute="_compute_statistics")
canceled = fields.Integer(compute="_compute_statistics")
sent = fields.Integer(compute="_compute_statistics")
process = fields.Integer(compute="_compute_statistics")
pending = fields.Integer(compute="_compute_statistics") # used with SMS when not yet 'delivered'
delivered = fields.Integer(compute="_compute_statistics")
opened = fields.Integer(compute="_compute_statistics")
clicked = fields.Integer(compute="_compute_statistics")
replied = fields.Integer(compute="_compute_statistics")
bounced = fields.Integer(compute="_compute_statistics")
failed = fields.Integer(compute="_compute_statistics")
received_ratio = fields.Float(compute="_compute_statistics", string='Received Ratio')
opened_ratio = fields.Float(compute="_compute_statistics", string='Opened Ratio')
replied_ratio = fields.Float(compute="_compute_statistics", string='Replied Ratio')
bounced_ratio = fields.Float(compute="_compute_statistics", string='Bounced Ratio')
clicks_ratio = fields.Float(compute="_compute_clicks_ratio", string="Number of Clicks")
link_trackers_count = fields.Integer(compute="_compute_link_trackers_count", string="Link Trackers Count")
next_departure = fields.Datetime(compute="_compute_next_departure", string='Scheduled date')
# UX
next_departure_is_past = fields.Boolean(compute="_compute_next_departure")
warning_message = fields.Char(
'Warning Message', compute='_compute_warning_message',
help='Warning message displayed in the mailing form view')
_sql_constraints = [(
'percentage_valid',
'CHECK(ab_testing_pc >= 0 AND ab_testing_pc <= 100)',
'The A/B Testing Percentage needs to be between 0 and 100%'
)]
@api.constrains('mailing_model_id', 'mailing_filter_id')
def _check_mailing_filter_model(self):
"""Check that if the favorite filter is set, it must contain the same recipient model as mailing"""
for mailing in self:
if mailing.mailing_filter_id and mailing.mailing_model_id != mailing.mailing_filter_id.mailing_model_id:
raise ValidationError(
_("The saved filter targets different recipients and is incompatible with this mailing.")
)
@api.depends('campaign_id.ab_testing_winner_mailing_id')
def _compute_ab_testing_is_winner_mailing(self):
for mailing in self:
mailing.ab_testing_is_winner_mailing = mailing.campaign_id.ab_testing_winner_mailing_id == mailing
@api.depends('mail_server_id', 'create_uid')
def _compute_email_from(self):
notification_email = self.env['ir.mail_server']._get_default_from_address()
for mailing in self:
user_email = mailing.create_uid.email_formatted or self.env.user.email_formatted
server = mailing.mail_server_id
if not server:
mailing.email_from = mailing.email_from or user_email
elif mailing.email_from and server._match_from_filter(mailing.email_from, server.from_filter):
mailing.email_from = mailing.email_from
elif server._match_from_filter(user_email, server.from_filter):
mailing.email_from = user_email
elif server._match_from_filter(notification_email, server.from_filter):
mailing.email_from = notification_email
else:
mailing.email_from = mailing.email_from or user_email
@api.depends('favorite')
def _compute_favorite_date(self):
favorited = self.filtered('favorite')
(self - favorited).favorite_date = False
favorited.filtered(lambda mailing: not mailing.favorite_date).favorite_date = fields.Datetime.now()
def _compute_total(self):
for mass_mailing in self:
total = self.env[mass_mailing.mailing_model_real].search_count(mass_mailing._get_recipients_domain())
if total and mass_mailing.ab_testing_enabled and mass_mailing.ab_testing_pc < 100:
total = max(int(total / 100.0 * mass_mailing.ab_testing_pc), 1)
mass_mailing.total = total
def _compute_clicks_ratio(self):
self.env.cr.execute("""
SELECT COUNT(DISTINCT(stats.id)) AS nb_mails, COUNT(DISTINCT(clicks.mailing_trace_id)) AS nb_clicks, stats.mass_mailing_id AS id
FROM mailing_trace AS stats
LEFT OUTER JOIN link_tracker_click AS clicks ON clicks.mailing_trace_id = stats.id
WHERE stats.mass_mailing_id IN %s
AND stats.trace_status not in ('bounce', 'cancel', 'error')
GROUP BY stats.mass_mailing_id
""", [tuple(self.ids) or (None,)])
mass_mailing_data = self.env.cr.dictfetchall()
mapped_data = dict([(m['id'], float_round(100 * m['nb_clicks'] / m['nb_mails'], precision_digits=2)) for m in mass_mailing_data])
for mass_mailing in self:
mass_mailing.clicks_ratio = mapped_data.get(mass_mailing.id, 0)
def _compute_statistics(self):
""" Compute statistics of the mass mailing """
for key in (
'scheduled', 'expected', 'canceled', 'sent', 'pending', 'delivered', 'opened',
'process', 'clicked', 'replied', 'bounced', 'failed', 'received_ratio',
'opened_ratio', 'replied_ratio', 'bounced_ratio',
):
self[key] = False
result = self.env["mailing.trace"].sudo()._read_group(
[("mass_mailing_id", "in", self.ids)],
['mass_mailing_id', 'trace_status'],
['__count', 'links_click_datetime:count', 'sent_datetime:count'])
result_per_mailing = defaultdict(lambda: defaultdict(int))
for mailing, trace_status, count, links_click_datetime, sent_datetime in result:
result_per_mailing[mailing][trace_status] = count
result_per_mailing[mailing]['links_click_datetime'] += links_click_datetime
result_per_mailing[mailing]['sent_datetime'] += sent_datetime
for mailing in self:
line = result_per_mailing[mailing]
values = {
'scheduled': line['outgoing'],
'expected': sum(v for k, v in line.items() if k not in ('links_click_datetime', 'sent_datetime')),
'canceled': line['cancel'],
'pending': line['pending'],
'delivered': line['sent'] + line['open'] + line['reply'],
'opened': line['open'] + line['reply'],
'replied': line['reply'],
'bounced': line['bounce'],
'failed': line['error'],
'clicked': line['links_click_datetime'],
'sent': line['sent_datetime'],
}
total = (values['expected'] - values['canceled']) or 1
total_no_error = (values['expected'] - values['canceled'] - values['bounced'] - values['failed']) or 1
values['received_ratio'] = float_round(100.0 * values['delivered'] / total, precision_digits=2)
values['opened_ratio'] = float_round(100.0 * values['opened'] / total_no_error, precision_digits=2)
values['replied_ratio'] = float_round(100.0 * values['replied'] / total_no_error, precision_digits=2)
values['bounced_ratio'] = float_round(100.0 * values['bounced'] / total, precision_digits=2)
mailing.update(values)
@api.depends('schedule_date', 'state')
def _compute_next_departure(self):
# Schedule_date should only be False if schedule_type = "now" or
# mass_mailing is canceled.
# A cron.trigger is created when mailing is put "in queue"
# so we can reasonably expect that the cron worker will
# execute this based on the cron.trigger's call_at which should
# be now() when clicking "Send" or schedule_date if scheduled
# If the departure time has passed but mailing is still in queue, this compute field
# will be used to display warning with reload button on a mailing form view.
for mass_mailing in self:
if mass_mailing.schedule_date:
# max in case the user schedules a date in the past
mass_mailing.next_departure = max(mass_mailing.schedule_date, fields.datetime.now())
else:
mass_mailing.next_departure = fields.datetime.now()
past = self.filtered(
lambda mailing: mailing.state == 'in_queue' and mailing.next_departure < fields.Datetime.now()
)
past.next_departure_is_past = True
(self - past).next_departure_is_past = False
def _compute_link_trackers_count(self):
result = self.env["link.tracker"].sudo()._read_group(
domain=[("mass_mailing_id", "in", self.ids)],
groupby=["mass_mailing_id"],
aggregates=["id:count"],
)
self.link_trackers_count = 0
for mailing, count in result:
mailing.link_trackers_count = count
@api.depends('email_from', 'mail_server_id')
def _compute_warning_message(self):
for mailing in self:
mail_server = mailing.mail_server_id
if mail_server and not mail_server._match_from_filter(mailing.email_from, mail_server.from_filter):
mailing.warning_message = _(
'This email from can not be used with this mail server.\n'
'Your emails might be marked as spam on the mail clients.'
)
else:
mailing.warning_message = False
@api.depends('mailing_type')
def _compute_medium_id(self):
for mailing in self:
if mailing.mailing_type == 'mail' and not mailing.medium_id:
mailing.medium_id = self.env['utm.medium']._fetch_or_create_utm_medium('email').id
@api.depends('mailing_model_id')
def _compute_reply_to_mode(self):
""" For main models not really using chatter to gather answers (contacts
and mailing contacts), set reply-to as email-based. Otherwise answers
by default go on the original discussion thread (business document). Note
that mailing_model being mailing.list means contacting mailing.contact
(see mailing_model_name versus mailing_model_real). """
for mailing in self:
if mailing.mailing_model_id.model in ['res.partner', 'mailing.list', 'mailing.contact']:
mailing.reply_to_mode = 'new'
else:
mailing.reply_to_mode = 'update'
@api.depends('reply_to_mode')
def _compute_reply_to(self):
for mailing in self:
if mailing.reply_to_mode == 'new' and not mailing.reply_to:
mailing.reply_to = self.env.user.email_formatted
elif mailing.reply_to_mode == 'update':
mailing.reply_to = False
@api.depends('mailing_model_id', 'mailing_domain')
def _compute_mailing_filter_count(self):
filter_data = self.env['mailing.filter']._read_group([
('mailing_model_id', 'in', self.mailing_model_id.ids)
], ['mailing_model_id'], ['__count'])
mapped_data = {mailing_model.id: count for mailing_model, count in filter_data}
for mailing in self:
mailing.mailing_filter_count = mapped_data.get(mailing.mailing_model_id.id, 0)
@api.depends('mailing_model_id')
def _compute_mailing_model_real(self):
for mailing in self:
mailing.mailing_model_real = 'mailing.contact' if mailing.mailing_model_id.model == 'mailing.list' else mailing.mailing_model_id.model
@api.depends('mailing_model_id')
def _compute_mailing_on_mailing_list(self):
mailing_list_model_id = self.env['ir.model']._get('mailing.list')
self.mailing_on_mailing_list = False
self.filtered(lambda m: m.mailing_model_id == mailing_list_model_id).mailing_on_mailing_list = True
@api.depends('mailing_model_id', 'contact_list_ids', 'mailing_type', 'mailing_filter_id')
def _compute_mailing_domain(self):
for mailing in self:
if not mailing.mailing_model_id:
mailing.mailing_domain = ''
elif mailing.mailing_filter_id:
mailing.mailing_domain = mailing.mailing_filter_id.mailing_domain
else:
mailing.mailing_domain = repr(mailing._get_default_mailing_domain())
@api.depends('mailing_model_name')
def _compute_mailing_filter_id(self):
for mailing in self:
mailing.mailing_filter_id = False
@api.depends('schedule_type')
def _compute_schedule_date(self):
for mailing in self:
if mailing.schedule_type == 'now' or not mailing.schedule_date:
mailing.schedule_date = False
@api.depends('state', 'schedule_date', 'sent_date', 'next_departure')
def _compute_calendar_date(self):
for mailing in self:
if mailing.state == 'done':
mailing.calendar_date = mailing.sent_date
elif mailing.state == 'in_queue':
mailing.calendar_date = mailing.next_departure
elif mailing.state == 'sending':
mailing.calendar_date = fields.Datetime.now()
else:
mailing.calendar_date = False
@api.depends('body_arch')
def _compute_is_body_empty(self):
for mailing in self:
mailing.is_body_empty = tools.is_html_empty(mailing.body_arch)
def _compute_mail_server_available(self):
self.mail_server_available = self.env['ir.config_parameter'].sudo().get_param('mass_mailing.outgoing_mail_server')
# Overrides of mail.render.mixin
@api.depends('mailing_model_real')
def _compute_render_model(self):
for mailing in self:
mailing.render_model = mailing.mailing_model_real
@api.depends('mailing_type')
def _compute_mailing_type_description(self):
for mailing in self:
mailing.mailing_type_description = dict(self._fields.get('mailing_type').selection).get(mailing.mailing_type)
@api.depends(lambda self: self._get_ab_testing_description_modifying_fields())
def _compute_ab_testing_description(self):
mailing_ab_test = self.filtered('ab_testing_enabled')
(self - mailing_ab_test).ab_testing_description = False
for mailing in mailing_ab_test:
mailing.ab_testing_description = self.env['ir.qweb']._render(
'mass_mailing.ab_testing_description',
mailing._get_ab_testing_description_values()
)
@api.depends('campaign_id.mailing_mail_ids.state')
def _compute_is_ab_test_sent(self):
for rec in self:
ab_testing_mailings = rec._get_ab_testing_siblings_mailings()
selected_mailings = ab_testing_mailings.filtered(lambda m: m.state == 'done')
rec.is_ab_test_sent = bool(selected_mailings)
def _get_ab_testing_description_modifying_fields(self):
return ['ab_testing_enabled', 'ab_testing_pc', 'ab_testing_schedule_datetime', 'ab_testing_winner_selection', 'campaign_id']
# ------------------------------------------------------
# ORM
# ------------------------------------------------------
@api.model_create_multi
def create(self, vals_list):
ab_testing_cron = self.env.ref('mass_mailing.ir_cron_mass_mailing_ab_testing').sudo()
for values in vals_list:
if values.get('ab_testing_schedule_datetime'):
at = fields.Datetime.from_string(values['ab_testing_schedule_datetime'])
ab_testing_cron._trigger(at=at)
mailings = super().create(vals_list)
mailings._create_ab_testing_utm_campaigns()
mailings._fix_attachment_ownership()
for values, mailing in zip(vals_list, mailings):
if values.get('body_arch'):
mailing.body_arch = mailing._convert_inline_images_to_urls(mailing.body_arch)
if values.get('body_html'):
mailing.body_html = mailing._convert_inline_images_to_urls(mailing.body_html)
return mailings
def write(self, values):
if values.get('body_arch'):
values['body_arch'] = self._convert_inline_images_to_urls(values['body_arch'])
if values.get('body_html'):
values['body_html'] = self._convert_inline_images_to_urls(values['body_html'])
# If ab_testing is already enabled on a mailing and the campaign is removed, we raise a ValidationError
if values.get('campaign_id') is False and any(mailing.ab_testing_enabled for mailing in self) and 'ab_testing_enabled' not in values:
raise ValidationError(_("A campaign should be set when A/B test is enabled"))
result = super(MassMailing, self).write(values)
if values.get('ab_testing_enabled'):
self._create_ab_testing_utm_campaigns()
self._fix_attachment_ownership()
if any(self.mapped('ab_testing_schedule_datetime')):
schedule_date = min(m.ab_testing_schedule_datetime for m in self if m.ab_testing_schedule_datetime)
ab_testing_cron = self.env.ref('mass_mailing.ir_cron_mass_mailing_ab_testing').sudo()
ab_testing_cron._trigger(at=schedule_date)
return result
def _create_ab_testing_utm_campaigns(self):
""" Creates the A/B test campaigns for the mailings that do not have campaign set already """
campaign_vals = [
mailing._get_default_ab_testing_campaign_values()
for mailing in self.filtered(lambda mailing: mailing.ab_testing_enabled and not mailing.campaign_id)
]
return self.env['utm.campaign'].create(campaign_vals)
def _fix_attachment_ownership(self):
for record in self:
record.attachment_ids.write({'res_model': record._name, 'res_id': record.id})
return self
def copy_data(self, default=None):
vals_list = super().copy_data(default)
for mailing, vals in zip(self, vals_list):
vals['contact_list_ids'] = mailing.contact_list_ids.ids
if mailing.mail_server_id and not mailing.mail_server_id.active:
vals['mail_server_id'] = self._get_default_mail_server_id()
if mailing.ab_testing_enabled:
vals['ab_testing_schedule_datetime'] = mailing.ab_testing_schedule_datetime
return vals_list
# ------------------------------------------------------
# ACTIONS
# ------------------------------------------------------
def action_set_favorite(self):
"""Add the current mailing in the favorites list."""
self.favorite = True
return {
'type': 'ir.actions.client',
'tag': 'display_notification',
'params': {
'message': _(
'Design added to the %s Templates!',
', '.join(self.mapped('mailing_model_id.name')),
),
'next': {'type': 'ir.actions.act_window_close'},
'sticky': False,
'type': 'info',
}
}
def action_remove_favorite(self):
"""Remove the current mailing from the favorites list."""
self.favorite = False
return {
'type': 'ir.actions.client',
'tag': 'display_notification',
'params': {
'message': _(
'Design removed from the %s Templates!',
', '.join(self.mapped('mailing_model_id.name')),
),
'next': {'type': 'ir.actions.act_window_close'},
'sticky': False,
'type': 'info',
}
}
def action_duplicate(self):
self.ensure_one()
if mass_mailing_copy := self.copy():
return {
'type': 'ir.actions.act_window',
'view_mode': 'form',
'res_model': 'mailing.mailing',
'res_id': mass_mailing_copy.id,
'context': dict(self.env.context),
}
return False
def action_test(self):
self.ensure_one()
ctx = dict(self.env.context, default_mass_mailing_id=self.id, dialog_size='medium')
return {
'name': _('Test Mailing'),
'type': 'ir.actions.act_window',
'view_mode': 'form',
'res_model': 'mailing.mailing.test',
'target': 'new',
'context': ctx,
}
def action_launch(self):
self.write({'schedule_type': 'now'})
return self.action_put_in_queue()
def action_reload(self):
pass
def action_schedule(self):
self.ensure_one()
if self.schedule_date and self.schedule_date > fields.Datetime.now():
return self.action_put_in_queue()
action = self.env["ir.actions.actions"]._for_xml_id("mass_mailing.mailing_mailing_schedule_date_action")
action['context'] = dict(self.env.context, default_mass_mailing_id=self.id, dialog_size='medium')
return action
def action_put_in_queue(self):
self.write({'state': 'in_queue'})
cron = self.env.ref('mass_mailing.ir_cron_mass_mailing_queue')
cron._trigger(
schedule_date or fields.Datetime.now()
for schedule_date in self.mapped('schedule_date')
)
def action_cancel(self):
self.write({'state': 'draft', 'schedule_date': False, 'schedule_type': 'now', 'next_departure': False})
def action_retry_failed(self):
failed_mails = self.env['mail.mail'].sudo().search([
('mailing_id', 'in', self.ids),
('state', '=', 'exception')
])
failed_mails.mapped('mailing_trace_ids').unlink()
failed_mails.unlink()
self.action_put_in_queue()
def action_view_link_trackers(self):
model_name = self.env['ir.model']._get('link.tracker').display_name
recipient = self.env['ir.model']._get(self.mailing_model_real).display_name
helper_header = _("No Link Tracker for that mailing!")
helper_message = _("Link Trackers will measure how many times each link is clicked as well as "
"the proportion of %s who clicked at least once in your mailing.", recipient)
return {
'name': model_name,
'type': 'ir.actions.act_window',
'view_mode': 'list,form',
'res_model': 'link.tracker',
'domain': [('mass_mailing_id', '=', self.id)],
'help': Markup('<p class="o_view_nocontent_smiling_face">%s</p><p>%s</p>') % (
helper_header, helper_message,
),
'context': dict(self._context, create=False)
}
def action_view_traces_scheduled(self):
return self._action_view_traces_filtered('scheduled')
def action_view_traces_canceled(self):
return self._action_view_traces_filtered('canceled')
def action_view_traces_failed(self):
return self._action_view_traces_filtered('failed')
def action_view_traces_process(self):
return self._action_view_traces_filtered('process')
def action_view_traces_sent(self):
return self._action_view_traces_filtered('sent')
def _action_view_traces_filtered(self, view_filter):
action = self.env["ir.actions.actions"]._for_xml_id("mass_mailing.mailing_trace_action")
action['name'] = _('Sent Mailings')
action['context'] = {'search_default_mass_mailing_id': self.id,}
filter_key = 'search_default_filter_%s' % (view_filter)
action['context'][filter_key] = True
action['views'] = [
(self.env.ref('mass_mailing.mailing_trace_view_tree_mail').id, 'list'),
(self.env.ref('mass_mailing.mailing_trace_view_form').id, 'form')
]
return action
def action_view_clicked(self):
return self._action_view_documents_filtered('clicked')
def action_view_opened(self):
return self._action_view_documents_filtered('open')
def action_view_replied(self):
return self._action_view_documents_filtered('reply')
def action_view_bounced(self):
return self._action_view_documents_filtered('bounce')
def action_view_delivered(self):
return self._action_view_documents_filtered('delivered')
def _action_view_documents_filtered(self, view_filter):
def _fetch_trace_res_ids(trace_domain):
trace_domain = expression.AND([
trace_domain,
[('mass_mailing_id', '=', self.id)],
])
result = self.env['mailing.trace'].search_read(domain=trace_domain, fields=['res_id'])
return [line['res_id'] for line in result]
model_name = self.env['ir.model']._get(self.mailing_model_real).display_name
helper_header = None
helper_message = None
if view_filter == 'reply':
res_ids = _fetch_trace_res_ids([('trace_status', '=', 'reply')])
helper_header = _("No %s replied to your mailing yet!", model_name)
helper_message = _("To track how many replies this mailing gets, make sure "
"its reply-to address belongs to this database.")
elif view_filter == 'bounce':
res_ids = _fetch_trace_res_ids([('trace_status', '=', 'bounce')])
helper_header = _("No %s address bounced yet!", model_name)
helper_message = _("Bounce happens when a mailing cannot be delivered (fake address, "
"server issues, ...). Check each record to see what went wrong.")
elif view_filter == 'clicked':
res_ids = _fetch_trace_res_ids([('links_click_ids', '!=', False)])
helper_header = _("No %s clicked your mailing yet!", model_name)
helper_message = _(
"Come back once your mailing has been sent to track who clicked on the embedded links.")
elif view_filter == 'open':
res_ids = _fetch_trace_res_ids([('trace_status', 'in', ('open', 'reply'))])
helper_header = _("No %s opened your mailing yet!", model_name)
helper_message = _("Come back once your mailing has been sent to track who opened your mailing.")
elif view_filter == 'delivered':
res_ids = _fetch_trace_res_ids([('trace_status', 'in', ('sent', 'open', 'reply'))])
helper_header = _("No %s received your mailing yet!", model_name)
helper_message = _("Wait until your mailing has been sent to check how many recipients you managed to reach.")
elif view_filter == 'sent':
res_ids = _fetch_trace_res_ids([('sent_datetime', '!=', False)])
else:
res_ids = []
action = {
'name': model_name,
'type': 'ir.actions.act_window',
'view_mode': 'list,form',
'res_model': self.mailing_model_real,
'domain': [('id', 'in', res_ids)],
'context': dict(self._context, create=False),
}
if helper_header and helper_message:
action['help'] = Markup('<p class="o_view_nocontent_smiling_face">%s</p><p>%s</p>') % (
helper_header, helper_message,
),
return action
def action_view_mailing_contacts(self):
"""Show the mailing contacts who are in a mailing list selected for this mailing."""
self.ensure_one()
action = self.env['ir.actions.actions']._for_xml_id('mass_mailing.action_view_mass_mailing_contacts')
if self.contact_list_ids:
action['context'] = {
'default_mailing_list_ids': self.contact_list_ids[0].ids,
'default_subscription_ids': [(0, 0, {'list_id': self.contact_list_ids[0].id})],
}
action['domain'] = [('list_ids', 'in', self.contact_list_ids.ids)]
return action
@api.model
def action_fetch_favorites(self, extra_domain=None):
"""Return all mailings set as favorite and skip mailings with empty body.
Return archived mailing templates as well, so the user can archive the templates
while keeping using it, without cluttering the Kanban view if they're a lot of
templates.
"""
domain = [('favorite', '=', True)]
if extra_domain:
domain = expression.AND([domain, extra_domain])
values_list = self.with_context(active_test=False).search_read(
domain=domain,
fields=['id', 'subject', 'body_arch', 'user_id', 'mailing_model_id'],
order='favorite_date DESC',
)
values_list = [
values for values in values_list
if not tools.is_html_empty(values['body_arch'])
]
# You see first the mailings without responsible, then your mailings and then the others
values_list.sort(
key=lambda values:
values['user_id'][0] != self.env.user.id if values['user_id'] else -1
)
return values_list
# ------------------------------------------------------
# A/B Test
# ------------------------------------------------------
def action_compare_versions(self):
self.ensure_one()
if not self.campaign_id:
raise ValueError(_("No mailing campaign has been found"))
return {
'name': _('A/B Tests'),
'type': 'ir.actions.act_window',
'view_mode': 'list,kanban,form,calendar,graph',
'res_model': 'mailing.mailing',
'domain': expression.AND([
[('campaign_id', '=', self.campaign_id.id)],
[('ab_testing_enabled', '=', True)],
[('mailing_type', '=', self.mailing_type)]
]),
}
def action_send_winner_mailing(self):
"""Send the winner mailing based on the winner selection field.
This action is used in 2 cases:
- When the user clicks on a button to send the winner mailing. There is only one mailing in self
- When the cron is executed to send winner mailing based on the A/B testing schedule datetime. In this
case 'self' contains all the mailing for the campaigns so we just need to take the first to determine the
winner.
If the winner mailing is computed automatically, we sudo the mailings of the campaign in order to sort correctly
the mailings based on the selection that can be used with sub-modules like CRM and Sales
"""
if len(self.campaign_id) != 1:
raise ValueError(_("To send the winner mailing the same campaign should be used by the mailings"))
if any(mailing.ab_testing_completed for mailing in self):
raise ValueError(_("To send the winner mailing the campaign should not have been completed."))
final_mailing = self[0]
sorted_by = final_mailing._get_ab_testing_winner_selection()['value']
if sorted_by != 'manual':
ab_testing_mailings = final_mailing._get_ab_testing_siblings_mailings().sudo()
selected_mailings = ab_testing_mailings.filtered(lambda m: m.state == 'done').sorted(sorted_by, reverse=True)
if selected_mailings:
final_mailing = selected_mailings[0]
else:
raise ValidationError(_("No mailing for this A/B testing campaign has been sent yet! Send one first and try again later."))
return final_mailing.action_select_as_winner()
def action_select_as_winner(self):
self.ensure_one()
if not self.ab_testing_enabled:
raise ValueError(_("A/B test option has not been enabled"))
final_mailing = self.copy({
'ab_testing_pc': 100,
'name': _(" %(subject)s (final)", subject=self.name) # Add suffix on name to show it's the final mailing
})
self.campaign_id.ab_testing_winner_mailing_id = final_mailing
final_mailing.action_launch()
action = self.env['ir.actions.act_window']._for_xml_id('mass_mailing.action_ab_testing_open_winner_mailing')
action['res_id'] = final_mailing.id
return action
def _get_ab_testing_description_values(self):
self.ensure_one()
return {
'mailing': self,
'ab_testing_count': self.ab_testing_mailings_count,
'ab_testing_winner_selection_description': self._get_ab_testing_winner_selection()['description'],
'total_ab_testing_pc': sum([
mailing.ab_testing_pc for mailing in self._get_ab_testing_siblings_mailings()
]),
}
def _get_ab_testing_siblings_mailings(self):
return self.campaign_id.mailing_mail_ids.filtered(lambda m: m.ab_testing_enabled)
def _get_ab_testing_winner_selection(self):
ab_testing_winner_selection_description = dict(
self._fields.get('ab_testing_winner_selection').related_field.selection
).get(self.ab_testing_winner_selection)
return {
'value': self.ab_testing_winner_selection,
'description': ab_testing_winner_selection_description,
}
def _get_default_ab_testing_campaign_values(self, values=None):
values = values or dict()
return {
'ab_testing_schedule_datetime': values.get('ab_testing_schedule_datetime') or self.ab_testing_schedule_datetime,
'ab_testing_winner_selection': values.get('ab_testing_winner_selection') or self.ab_testing_winner_selection,
'mailing_mail_ids': self.ids,
'name': _('A/B Test: %s', values.get('subject') or self.subject or fields.Datetime.now()),
'user_id': values.get('user_id') or self.user_id.id or self.env.user.id,
}
# ------------------------------------------------------
# Email Sending
# ------------------------------------------------------
def _get_opt_out_list(self):
""" Give list of opt-outed emails, depending on specific model-based
computation if available.
:return list: opt-outed emails, preferably normalized (aka not records)
"""
self.ensure_one()
opt_out = {}
target = self.env[self.mailing_model_real]
if hasattr(self.env[self.mailing_model_name], '_mailing_get_opt_out_list'):
opt_out = self.env[self.mailing_model_name]._mailing_get_opt_out_list(self)
_logger.info(
"Mass-mailing %s targets %s, blacklist: %s emails",
self, target._name, len(opt_out))
else:
_logger.info("Mass-mailing %s targets %s, no opt out list available", self, target._name)
return opt_out
def _get_link_tracker_values(self):
self.ensure_one()
vals = {'mass_mailing_id': self.id}
if self.campaign_id:
vals['campaign_id'] = self.campaign_id.id
if self.source_id:
vals['source_id'] = self.source_id.id
if self.medium_id:
vals['medium_id'] = self.medium_id.id
return vals
def _get_seen_list(self):
"""Returns a set of emails already targeted by current mailing/campaign (no duplicates)"""
self.ensure_one()
target = self.env[self.mailing_model_real]
query = """
SELECT s.email
FROM mailing_trace s
JOIN %(target)s t ON (s.res_id = t.id)
%(join_domain)s
WHERE s.email IS NOT NULL
%(where_domain)s
"""
if self.ab_testing_enabled:
query += """
AND s.campaign_id = %%(mailing_campaign_id)s;
"""
else:
query += """
AND s.mass_mailing_id = %%(mailing_id)s
AND s.model = %%(target_model)s;
"""
join_domain, where_domain = self._get_seen_list_extra()
query = query % {'target': target._table, 'join_domain': join_domain, 'where_domain': where_domain}
params = {'mailing_id': self.id, 'mailing_campaign_id': self.campaign_id.id, 'target_model': self.mailing_model_real}
self._cr.execute(query, params)
seen_list = set(m[0] for m in self._cr.fetchall())
_logger.info(
"Mass-mailing %s has already reached %s %s emails", self, len(seen_list), target._name)
return seen_list
def _get_seen_list_extra(self):
return ('', '')
def _get_mass_mailing_context(self):
"""Returns extra context items with pre-filled blacklist and seen list for massmailing"""
return {
'post_convert_links': self._get_link_tracker_values(),
}
def _get_recipients(self):
mailing_domain = self._get_recipients_domain()
res_ids = self.env[self.mailing_model_real].search(mailing_domain).ids
# randomly choose a fragment
if self.ab_testing_enabled and not self.ab_testing_is_winner_mailing:
contact_nbr = self.env[self.mailing_model_real].search_count(mailing_domain)
topick = 0
if contact_nbr:
topick = max(int(contact_nbr / 100.0 * self.ab_testing_pc), 1)
if self.campaign_id and self.ab_testing_enabled:
already_mailed = self.campaign_id._get_mailing_recipients()[self.campaign_id.id]
else:
already_mailed = set([])
remaining = set(res_ids).difference(already_mailed)
if topick > len(remaining) or (len(remaining) > 0 and topick == 0):
topick = len(remaining)
res_ids = random.sample(sorted(remaining), topick)
return res_ids
def _get_recipients_domain(self):
"""Overridable getter used to get the domain of the recipients at the time of sending."""
return self._parse_mailing_domain()
def _get_remaining_recipients(self):
res_ids = self._get_recipients()
trace_domain = [('model', '=', self.mailing_model_real)]
if self.ab_testing_enabled and self.ab_testing_is_winner_mailing:
trace_domain = expression.AND([trace_domain, [('mass_mailing_id', 'in', self._get_ab_testing_siblings_mailings().ids)]])
else:
trace_domain = expression.AND([trace_domain, [
('res_id', 'in', res_ids),
('mass_mailing_id', '=', self.id),
]])
already_mailed = self.env['mailing.trace'].search_read(trace_domain, ['res_id'])
done_res_ids = {record['res_id'] for record in already_mailed}
return [rid for rid in res_ids if rid not in done_res_ids]
def _get_unsubscribe_oneclick_url(self, email_to, res_id):
url = werkzeug.urls.url_join(
self.get_base_url(), 'mailing/%(mailing_id)s/unsubscribe_oneclick?%(params)s' % {
'mailing_id': self.id,
'params': werkzeug.urls.url_encode({
'document_id': res_id,
'email': email_to,
'hash_token': self._generate_mailing_recipient_token(res_id, email_to),
}),
}
)
return url
def _get_unsubscribe_url(self, email_to, res_id):
url = werkzeug.urls.url_join(
self.get_base_url(), 'mailing/%(mailing_id)s/unsubscribe?%(params)s' % {
'mailing_id': self.id,
'params': werkzeug.urls.url_encode({
'document_id': res_id,
'email': email_to,
'hash_token': self._generate_mailing_recipient_token(res_id, email_to),
}),
}
)
return url
def _get_view_url(self, email_to, res_id):
url = werkzeug.urls.url_join(
self.get_base_url(), 'mailing/%(mailing_id)s/view?%(params)s' % {
'mailing_id': self.id,
'params': werkzeug.urls.url_encode({
'document_id': res_id,
'email': email_to,
'hash_token': self._generate_mailing_recipient_token(res_id, email_to),
}),
}
)
return url
def action_send_mail(self, res_ids=None):
return self._action_send_mail(res_ids)
def _action_send_mail(self, res_ids=None):
author_id = self.env.user.partner_id.id
for mailing in self:
context_user = mailing.user_id or mailing.write_uid or self.env.user
mailing = mailing.with_context(
**self.env['res.users'].with_user(context_user).context_get()
)
mailing_res_ids = res_ids or mailing._get_remaining_recipients()
if not mailing_res_ids:
raise UserError(_('There are no recipients selected.'))
composer_values = {
'auto_delete': not mailing.keep_archives,
# email-mode: keep original message for routing
'auto_delete_keep_log': mailing.reply_to_mode == 'update',
'author_id': author_id,
'attachment_ids': [(4, attachment.id) for attachment in mailing.attachment_ids],
'body': mailing._prepend_preview(mailing.body_html, mailing.preview),
'composition_mode': 'mass_mail',
'email_from': mailing.email_from,
'mail_server_id': mailing.mail_server_id.id,
'mailing_list_ids': [(4, l.id) for l in mailing.contact_list_ids],
'mass_mailing_id': mailing.id,
'model': mailing.mailing_model_real,
'record_name': False,
'reply_to_force_new': mailing.reply_to_mode == 'new',
'subject': mailing.subject,
'template_id': False,
}
if mailing.reply_to_mode == 'new':
composer_values['reply_to'] = mailing.reply_to
composer = self.env['mail.compose.message'].with_context(
active_ids=mailing_res_ids,
default_composition_mode='mass_mail',
**mailing._get_mass_mailing_context()
).create(composer_values)
# auto-commit except in testing mode
composer._action_send_mail(
auto_commit=not getattr(threading.current_thread(), 'testing', False)
)
mailing.write({
'state': 'done',
'sent_date': fields.Datetime.now(),
# send the KPI mail only if it's the first sending
'kpi_mail_required': not mailing.sent_date,
})
return True
def convert_links(self):
res = {}
for mass_mailing in self:
html = mass_mailing.body_html if mass_mailing.body_html else ''
vals = {'mass_mailing_id': mass_mailing.id}
if mass_mailing.campaign_id:
vals['campaign_id'] = mass_mailing.campaign_id.id
if mass_mailing.source_id:
vals['source_id'] = mass_mailing.source_id.id
if mass_mailing.medium_id:
vals['medium_id'] = mass_mailing.medium_id.id
res[mass_mailing.id] = mass_mailing._shorten_links(html, vals, blacklist=['/unsubscribe_from_list', '/view', '/cards/'])
return res
@api.model
def _process_mass_mailing_queue(self):
mass_mailings = self.search([('state', 'in', ('in_queue', 'sending')), '|', ('schedule_date', '<', fields.Datetime.now()), ('schedule_date', '=', False)])
count_total = len(mass_mailings)
for count_done, mass_mailing in enumerate(mass_mailings, start=1):
context_user = mass_mailing.user_id or mass_mailing.write_uid or self.env.user
mass_mailing = mass_mailing.with_context(
**self.env['res.users'].with_user(context_user).context_get()
)
if len(mass_mailing._get_remaining_recipients()) > 0:
mass_mailing.state = 'sending'
mass_mailing._action_send_mail()
else:
mass_mailing.write({
'state': 'done',
'sent_date': fields.Datetime.now(),
# send the KPI mail only if it's the first sending
'kpi_mail_required': not mass_mailing.sent_date,
})
self.env['ir.cron']._notify_progress(done=count_done, remaining=count_total - count_done)
if self.env['ir.config_parameter'].sudo().get_param('mass_mailing.mass_mailing_reports'):
mailings = self.env['mailing.mailing'].search([
('kpi_mail_required', '=', True),
('state', '=', 'done'),
('sent_date', '<=', fields.Datetime.now() - relativedelta(days=1)),
('sent_date', '>=', fields.Datetime.now() - relativedelta(days=5)),
])
if mailings:
mailings._action_send_statistics()
# ------------------------------------------------------
# STATISTICS
# ------------------------------------------------------
def _action_send_statistics(self):
"""Send an email to the responsible of each finished mailing with the statistics."""
self.kpi_mail_required = False
mails_sudo = self.env['mail.mail'].sudo()
for mailing in self:
if mailing.user_id:
mailing = mailing.with_user(mailing.user_id).with_context(
lang=mailing.user_id.lang or self._context.get('lang')
)
mailing_type = mailing._get_pretty_mailing_type()
mail_user = mailing.user_id or self.env.user
mail_company = mail_user.company_id
link_trackers = self.env['link.tracker'].search(
[('mass_mailing_id', '=', mailing.id)]
).sorted('count', reverse=True)
link_trackers_body = self.env['ir.qweb']._render(
'mass_mailing.mass_mailing_kpi_link_trackers',
{
'company': self.env.user.company_id,
'object': mailing,
'link_trackers': link_trackers,
'mailing_type': mailing_type,
},
)
rendering_data = {
'body': tools.html_sanitize(link_trackers_body),
'company': mail_company,
'user': mail_user,
'display_mobile_banner': True,
** mailing._prepare_statistics_email_values(),
}
if mail_user.has_group('mass_mailing.group_mass_mailing_user'):
rendering_data['mailing_report_token'] = self._generate_mailing_report_token(mail_user.id)
rendering_data['user_id'] = mail_user.id
rendered_body = self.env['ir.qweb']._render(
'digest.digest_mail_main',
rendering_data
)
full_mail = self.env['mail.render.mixin']._render_encapsulate(
'digest.digest_mail_layout',
rendered_body,
)
mail_values = {
'auto_delete': True,
'author_id': mail_user.partner_id.id,
'email_from': mail_user.email_formatted,
'email_to': mail_user.email_formatted,
'body_html': full_mail,
'reply_to': mail_company.email_formatted or mail_user.email_formatted,
'state': 'outgoing',
'subject': _('24H Stats of %(mailing_type)s "%(mailing_name)s"',
mailing_type=mailing._get_pretty_mailing_type(),
mailing_name=mailing.subject
),
}
mails_sudo += self.env['mail.mail'].sudo().create(mail_values)
return mails_sudo
def _prepare_statistics_email_values(self):
"""Return some statistics that will be displayed in the mailing statistics email.
Each item in the returned list will be displayed as a table, with a title and
1, 2 or 3 columns.
"""
self.ensure_one()
mailing_type = self._get_pretty_mailing_type()
kpi = {}
if self.mailing_type == 'mail':
kpi = {
'kpi_fullname': _('Engagement on %(expected)i %(mailing_type)s Sent',
expected=self.expected,
mailing_type=mailing_type
),
'kpi_col1': {
'value': f'{self.received_ratio}%',
'col_subtitle': _('RECEIVED (%i)', self.delivered),
},
'kpi_col2': {
'value': f'{self.opened_ratio}%',
'col_subtitle': _('OPENED (%i)', self.opened),
},
'kpi_col3': {
'value': f'{self.replied_ratio}%',
'col_subtitle': _('REPLIED (%i)', self.replied),
},
'kpi_action': None,
'kpi_name': self.mailing_type,
}
random_tip = self.env['digest.tip'].search(
[('group_id.category_id', '=', self.env.ref('base.module_category_marketing_email_marketing').id)]
)
if random_tip:
random_tip = random.choice(random_tip).tip_description
formatted_date = tools.format_datetime(
self.env, self.sent_date, self.user_id.tz, 'MMM dd, YYYY', self.user_id.lang
) if self.sent_date else False
web_base_url = self.get_base_url()
return {
'title': _('24H Stats of %(mailing_type)s "%(mailing_name)s"',
mailing_type=mailing_type,
mailing_name=self.subject
),
'top_button_label': _('More Info'),
'top_button_url': url_join(web_base_url, f'/odoo/mailing.mailing/{self.id}'),
'kpi_data': [
kpi,
{
'kpi_fullname': _('Business Benefits on %(expected)i %(mailing_type)s Sent',
expected=self.expected,
mailing_type=mailing_type
),
'kpi_action': None,
'kpi_col1': {},
'kpi_col2': {},
'kpi_col3': {},
'kpi_name': 'trace',
},
],
'tips': [random_tip] if random_tip else False,
'formatted_date': formatted_date,
}
def _get_pretty_mailing_type(self):
return _('Emails')
def _generate_mailing_report_token(self, user_id):
"""Generate a secure token for this user. It allows to opt out from
mailing reports while keeping some security in that process. """
return tools.hmac(self.env(su=True), 'mailing-report-deactivated', user_id)
# ------------------------------------------------------
# TOOLS
# ------------------------------------------------------
def _convert_inline_images_to_urls(self, html_content):
"""
Find inline base64 encoded images, make an attachement out of
them and replace the inline image with an url to the attachement.
Find VML v:image elements, crop their source images, make an attachement
out of them and replace their source with an url to the attachement.
"""
root = lxml.html.fromstring(html_content)
did_modify_body = False
conversion_info = [] # list of tuples (image: base64 image, node: lxml node, old_url: string or None, original_id))
with requests.Session() as session:
for node in root.iter(lxml.etree.Element, lxml.etree.Comment):
if node.tag == 'img':
# Convert base64 images in img tags to attachments.
match = image_re.match(node.attrib.get('src', ''))
if match:
image = match.group(2).encode() # base64 image as bytes
conversion_info.append((image, node, None, int(node.attrib.get('data-original-id') or "0")))
elif 'base64' in (node.attrib.get('style') or ''):
# Convert base64 images in inline styles to attachments.
for match in re.findall(r'data:image/[A-Za-z]+;base64,.+?(?=&\#34;|\"|\'|"|\))', node.attrib.get('style')):
image = re.sub(r'data:image/[A-Za-z]+;base64,', '', match).encode() # base64 image as bytes
conversion_info.append((image, node, match, int(node.attrib.get('data-original-id') or "0")))
elif mso_re.match(node.text or ''):
# Convert base64 images (in img tags or inline styles) in mso comments to attachments.
base64_in_element_regex = re.compile(r"""
(?:(?!^)|<)[^<>]*?(data:image/[A-Za-z]+;base64,[^<]+?)(?=&\#34;|\"|'|"|\))(?=[^<]+>)
""", re.VERBOSE)
for match in re.findall(base64_in_element_regex, node.text):
image = re.sub(r'data:image/[A-Za-z]+;base64,', '', match).encode() # base64 image as bytes
conversion_info.append((image, node, match, int(node.attrib.get('data-original-id') or "0")))
# Crop VML images.
for match in re.findall(r'<v:image[^>]*>', node.text):
url = re.search(r'src=\s*\"([^\"]+)\"', match)[1]
# Make sure we have an absolute URL by adding a scheme and host if needed.
absolute_url = url if '//' in url else f"{self.get_base_url()}{url if url.startswith('/') else f'/{url}'}"
target_width_match = re.search(r'width:\s*([0-9\.]+)\s*px', match)
target_height_match = re.search(r'height:\s*([0-9\.]+)\s*px', match)
if target_width_match and target_height_match:
target_width = float(target_width_match[1])
target_height = float(target_height_match[1])
try:
image = self._get_image_by_url(absolute_url, session)
except (ImportValidationError, UnidentifiedImageError):
# Url invalid or doesn't resolve to a valid image.
# Note: We choose to ignore errors so as not to
# break the entire process just for one image's
# responsive cropping behavior).
pass
else:
image_processor = ImageProcess(image)
image = image_processor.crop_resize(target_width, target_height, 0, 0)
conversion_info.append((base64.b64encode(image.source), node, url, int(node.attrib.get('data-original-id') or "0")))
# Apply the changes.
urls = self._create_attachments_from_inline_images([(image, original_id) for (image, _, _, original_id) in conversion_info])
for ((image, node, old_url, original_id), new_url) in zip(conversion_info, urls):
did_modify_body = True
if node.tag == 'img':
node.attrib['src'] = new_url
elif 'base64' in (node.attrib.get('style') or ''):
node.attrib['style'] = node.attrib['style'].replace(old_url, new_url)
else:
node.text = node.text.replace(old_url, new_url)
if did_modify_body:
return lxml.html.tostring(root, encoding='unicode')
return html_content
def _create_attachments_from_inline_images(self, b64images):
if not b64images:
return []
IrAttachment = self.env['ir.attachment']
existing_attachments = dict(IrAttachment.search([
('res_model', '=', 'mailing.mailing'),
('res_id', '=', self.id),
]).mapped(lambda record: (record.checksum, record)))
attachments, vals_for_attachs, checksums = [], [], []
checksums_set, checksum_original_id, new_attachment_by_checksum = set(), {}, {}
next_img_id = len(existing_attachments)
for (b64image, original_id) in b64images:
checksum = IrAttachment._compute_checksum(base64.b64decode(b64image))
checksums.append(checksum)
existing_attach = existing_attachments.get(checksum)
# Existing_attach can be None, in which case it acts as placeholder
# for attachment to be created.
attachments.append(existing_attach)
if original_id:
checksum_original_id[checksum] = original_id
if not existing_attach and not checksum in checksums_set:
# We create only one attachment per checksum
vals_for_attachs.append({
'datas': b64image,
'name': f"image_mailing_{self.id}_{next_img_id}",
'type': 'binary',
'res_id': self.id,
'res_model': 'mailing.mailing',
'checksum': checksum,
})
checksums_set.add(checksum)
next_img_id += 1
for vals in vals_for_attachs:
if vals['checksum'] in checksum_original_id:
vals['original_id'] = checksum_original_id[vals['checksum']]
del vals['checksum']
new_attachments = iter(IrAttachment.create(vals_for_attachs))
checksum_iter = iter(checksums)
# Replace None entries by newly created attachments.
for i in range(len(attachments)):
checksum = next(checksum_iter)
if attachments[i]:
continue
if checksum in new_attachment_by_checksum:
attachments[i] = new_attachment_by_checksum[checksum]
else:
attachments[i] = next(new_attachments)
new_attachment_by_checksum[checksum] = attachments[i]
urls = []
for attachment in attachments:
attachment.generate_access_token()
urls.append('/web/image/%s?access_token=%s' % (attachment.id, attachment.access_token))
return urls
def _get_default_mailing_domain(self):
mailing_domain = []
if hasattr(self.env[self.mailing_model_name], '_mailing_get_default_domain'):
mailing_domain = self.env[self.mailing_model_name]._mailing_get_default_domain(self)
if self.mailing_type == 'mail' and 'is_blacklisted' in self.env[self.mailing_model_name]._fields:
mailing_domain = expression.AND([[('is_blacklisted', '=', False)], mailing_domain])
return mailing_domain
def _get_image_by_url(self, url, session):
maxsize = int(tools.config.get("import_image_maxbytes", DEFAULT_IMAGE_MAXBYTES))
_logger.debug("Trying to import image from URL: %s", url)
try:
response = session.get(url, timeout=int(tools.config.get("import_image_timeout", DEFAULT_IMAGE_TIMEOUT)))
response.raise_for_status()
if response.headers.get('Content-Length') and int(response.headers['Content-Length']) > maxsize:
raise ImportValidationError(
_("File size exceeds configured maximum (%s bytes)", maxsize)
)
content = bytearray()
for chunk in response.iter_content(DEFAULT_IMAGE_CHUNK_SIZE):
content += chunk
if len(content) > maxsize:
raise ImportValidationError(
_("File size exceeds configured maximum (%s bytes)", maxsize)
)
image = Image.open(io.BytesIO(content))
w, h = image.size
if w * h > 42e6:
raise ImportValidationError(
_("Image size excessive, imported images must be smaller than 42 million pixel")
)
return content
except UnidentifiedImageError:
_logger.warning('This file could not be decoded as an image file.', exc_info=True)
raise
except Exception as e:
_logger.exception(e)
raise ImportValidationError(_("Could not retrieve URL: %s", url)) from e
def _parse_mailing_domain(self):
self.ensure_one()
try:
mailing_domain = literal_eval(self.mailing_domain)
except Exception:
mailing_domain = [('id', 'in', [])]
return mailing_domain
def _generate_mailing_recipient_token(self, document_id, email):
"""Generate a secure token for a given mailing and recipient (based on
their email). This allows notably to unsubscribe from the mailing or
to blacklist their email entirely without need of a user account.
:param int document_id: ID of the business document on which mailing
is performed;
:param str email: recipient email, used to unsubscribe / blacklist;
"""
self.ensure_one()
assert isinstance(email, str)
secret = self.env["ir.config_parameter"].sudo().get_param("database.secret")
token = (self.env.cr.dbname, self.id, int(document_id), email)
return hmac.new(secret.encode('utf-8'), repr(token).encode('utf-8'), hashlib.sha512).hexdigest()
|