Merge PR #421 into 11.0

Signed-off-by pedrobaeza

mail_tracking/__manifest__.py

@@ -5,7 +5,7 @@
 {
     "name": "Email tracking",
     "summary": "Email tracking system for all mails sent",
-    "version": "11.0.2.0.2",
+    "version": "11.0.2.1.0",
     "category": "Social Network",
     "website": "http://github.com/OCA/social",
     "author": "Tecnativa, "

mail_tracking/i18n/mail_tracking.pot

@@ -121,10 +121,12 @@ msgid "Deferred"
 msgstr ""
 
 #. module: mail_tracking
+#: code:addons/mail_tracking/models/mail_message.py:41
 #: model:ir.ui.view,arch_db:mail_tracking.view_mail_tracking_email_search
 #: model:ir.ui.view,arch_db:mail_tracking.view_mail_tracking_event_search
 #: selection:mail.tracking.email,state:0
 #: selection:mail.tracking.event,event_type:0
+#, python-format
 msgid "Delivered"
 msgstr ""
 
@@ -167,8 +169,10 @@ msgid "Email bounced"
 msgstr ""
 
 #. module: mail_tracking
+#: code:addons/mail_tracking/models/mail_message.py:40
 #: model:ir.ui.view,arch_db:mail_tracking.view_mail_tracking_event_form
 #: selection:mail.tracking.email,state:0
+#, python-format
 msgid "Error"
 msgstr ""
 
@@ -294,7 +298,7 @@ msgstr ""
 
 #. module: mail_tracking
 #. openerp-web
-#: code:addons/mail_tracking/static/src/js/mail_tracking.js:61
+#: code:addons/mail_tracking/static/src/js/mail_tracking.js:59
 #, python-format
 msgid "Message tracking"
 msgstr ""
@@ -319,7 +323,9 @@ msgid "Open"
 msgstr ""
 
 #. module: mail_tracking
+#: code:addons/mail_tracking/models/mail_message.py:42
 #: selection:mail.tracking.email,state:0
+#, python-format
 msgid "Opened"
 msgstr ""
 
@@ -380,10 +386,12 @@ msgid "Sender email"
 msgstr ""
 
 #. module: mail_tracking
+#: code:addons/mail_tracking/models/mail_message.py:41
 #: model:ir.ui.view,arch_db:mail_tracking.view_mail_tracking_email_search
 #: model:ir.ui.view,arch_db:mail_tracking.view_mail_tracking_event_search
 #: selection:mail.tracking.email,state:0
 #: selection:mail.tracking.event,event_type:0
+#, python-format
 msgid "Sent"
 msgstr ""
 
@@ -410,10 +418,9 @@ msgid "State"
 msgstr ""
 
 #. module: mail_tracking
-#. openerp-web
+#: code:addons/mail_tracking/models/mail_message.py:43
-#: code:addons/mail_tracking/static/src/xml/mail_tracking.xml:98
 #, python-format
-msgid "Status: unknown"
+msgid "Status: %s"
 msgstr ""
 
 #. module: mail_tracking
@@ -458,7 +465,7 @@ msgstr ""
 
 #. module: mail_tracking
 #. openerp-web
-#: code:addons/mail_tracking/static/src/js/mail_tracking.js:41
+#: code:addons/mail_tracking/static/src/js/mail_tracking.js:39
 #, python-format
 msgid "Tracking partner"
 msgstr ""
@@ -479,6 +486,12 @@ msgstr ""
 msgid "UTC timestamp"
 msgstr ""
 
+#. module: mail_tracking
+#: code:addons/mail_tracking/models/mail_message.py:42
+#, python-format
+msgid "Unknown"
+msgstr ""
+
 #. module: mail_tracking
 #: model:ir.ui.view,arch_db:mail_tracking.view_mail_tracking_event_search
 msgid "Unsubscribe"
@@ -520,6 +533,12 @@ msgstr ""
 msgid "User country"
 msgstr ""
 
+#. module: mail_tracking
+#: code:addons/mail_tracking/models/mail_message.py:40
+#, python-format
+msgid "Waiting"
+msgstr ""
+
 #. module: mail_tracking
 #: model:ir.model,name:mail_tracking.model_ir_mail_server
 msgid "ir.mail_server"

mail_tracking/models/mail_message.py

@@ -2,7 +2,7 @@
 # Copyright 2019 Alexandre Díaz
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
 
-from odoo import models, api, fields
+from odoo import _, models, api, fields
 from odoo.tools import email_split
 
 
@@ -36,6 +36,12 @@ class MailMessage(models.Model):
             status = tracking_status_map.get(tracking_email_status, 'unknown')
         return status
 
+    def _partner_tracking_status_human_get(self, status):
+        statuses = {'waiting': _('Waiting'), 'error': _('Error'),
+                    'sent': _('Sent'), 'delivered': _('Delivered'),
+                    'opened': _('Opened'), 'unknown': _('Unknown')}
+        return _("Status: %s") % statuses[status]
+
     def tracking_status(self):
         res = {}
         for message in self:
@@ -45,14 +51,27 @@ class MailMessage(models.Model):
             trackings = self.env['mail.tracking.email'].sudo().search([
                 ('mail_message_id', '=', message.id),
             ])
+            # Get Cc recipients
+            email_cc_list = email_split(message.email_cc)
+            if any(email_cc_list):
+                partners |= partners.search([('email', 'in', email_cc_list)])
+            email_cc_list = set(email_cc_list)
             # Search all trackings for this message
             for tracking in trackings:
                 status = self._partner_tracking_status_get(tracking)
                 recipient = (
                     tracking.partner_id.name or tracking.recipient)
-                partner_trackings.append((
+                partner_trackings.append({
-                    status, tracking.id, recipient, tracking.partner_id.id))
+                    'status': status,
+                    'status_human':
+                        self._partner_tracking_status_human_get(status),
+                    'tracking_id': tracking.id,
+                    'recipient': recipient,
+                    'partner_id': tracking.partner_id.id,
+                    'isCc': False,
+                })
                 if tracking.partner_id:
+                    email_cc_list.discard(tracking.partner_id.email)
                     partners_already |= tracking.partner_id
             # Search all recipients for this message
             if message.partner_ids:
@@ -63,36 +82,32 @@ class MailMessage(models.Model):
             partners -= partners_already
             for partner in partners:
                 # If there is partners not included, then status is 'unknown'
-                partner_trackings.append((
+                # Because can be an Cc recipient
-                    'unknown', False, partner.name, partner.id, partner.email))
+                isCc = False
-            res[message.id] = partner_trackings
+                if partner.email in email_cc_list:
-        return res
-
-    @api.multi
-    def _get_email_cc(self):
-        """This method gets all Cc mails and the associated partner if exist.
-            The result is a dictionary by 'message id' with a list of tuples
-            (str:email_cc, list:[partner id, partner display_name] or False)
-        """
-        res = {}
-        ResPartnerObj = self.env['res.partner']
-        for message in self:
-            email_cc_list = email_split(message.email_cc)
-            email_cc_list_checked = []
-            if any(email_cc_list):
-                partners = ResPartnerObj.search([
-                    ('email', 'in', email_cc_list)
-                ])
-                email_cc_list = set(email_cc_list)
-                for partner in partners:
                     email_cc_list.discard(partner.email)
-                    email_cc_list_checked.append(
+                    isCc = True
-                        (partner.email, [partner.id, partner.display_name]))
+                partner_trackings.append({
-                for email in email_cc_list:
+                    'status': 'unknown',
-                    email_cc_list_checked.append((email, False))
+                    'status_human':
-            res.update({
+                        self._partner_tracking_status_human_get('unknown'),
-                message.id: email_cc_list_checked
+                    'tracking_id': False,
-            })
+                    'recipient': partner.name,
+                    'partner_id': partner.id,
+                    'isCc': isCc,
+                })
+            for email in email_cc_list:
+                # If there is Cc without partner
+                partner_trackings.append({
+                    'status': 'unknown',
+                    'status_human':
+                        self._partner_tracking_status_human_get('unknown'),
+                    'tracking_id': False,
+                    'recipient': email,
+                    'partner_id': False,
+                    'isCc': True,
+                })
+            res[message.id] = partner_trackings
         return res
 
     @api.model
@@ -102,11 +117,9 @@ class MailMessage(models.Model):
         mail_message_ids = {m.get('id') for m in messages if m.get('id')}
         mail_messages = self.browse(mail_message_ids)
         partner_trackings = mail_messages.tracking_status()
-        email_cc = mail_messages._get_email_cc()
         for message_dict in messages:
             mail_message_id = message_dict.get('id', False)
             if mail_message_id:
                 message_dict['partner_trackings'] = \
                     partner_trackings[mail_message_id]
-                message_dict['email_cc'] = email_cc[mail_message_id]
         return res

mail_tracking/static/src/js/mail_tracking.js

@@ -17,7 +17,6 @@ odoo.define('mail_tracking.partner_tracking', function (require) {
     chat_manager.make_message = function (data) {
         var msg = this._make_message_super(data);
         msg.partner_trackings = data.partner_trackings || [];
-        msg.email_cc = data.email_cc || [];
         return msg;
     };
 
@@ -30,7 +29,6 @@ odoo.define('mail_tracking.partner_tracking', function (require) {
         _preprocess_message: function () {
             var msg = this._super.apply(this, arguments);
             msg.partner_trackings = msg.partner_trackings || [];
-            msg.email_cc = msg.email_cc || [];
             return msg;
         },
         on_tracking_partner_click: function (event) {

mail_tracking/static/src/xml/mail_tracking.xml

@@ -5,39 +5,39 @@
 <template>
 
 <t t-name="mail.tracking.status">
-    <t t-if="isCc">
+    <t t-if="tracking['isCc']">
         <span class="mail_tracking_cc">
             <i class="fa fa-cc"></i>
         </span>
     </t>
-    <t t-elif="tracking[0] == 'unknown'">
+    <t t-elif="tracking['status'] === 'unknown'">
         <span class="mail_tracking_unknown">
             <i class="fa fa-ban"></i>
         </span>
     </t>
-    <t t-elif="tracking[0] == 'waiting'">
+    <t t-elif="tracking['status'] === 'waiting'">
         <span class="mail_tracking_waiting mail_tracking_pointer">
             <i class="fa fa-clock-o"></i>
         </span>
     </t>
-    <t t-elif="tracking[0] == 'error'">
+    <t t-elif="tracking['status'] === 'error'">
         <span class="mail_tracking_error mail_tracking_pointer">
             <i class="fa fa-remove"></i>
         </span>
     </t>
-    <t t-elif="tracking[0] == 'sent'">
+    <t t-elif="tracking['status'] === 'sent'">
         <span class="mail_tracking_sent mail_tracking_pointer">
             <i class="fa fa-check"></i>
         </span>
     </t>
-    <t t-elif="tracking[0] == 'delivered'">
+    <t t-elif="tracking['status'] === 'delivered'">
         <span class="fa-stack mail_tracking_delivered mail_tracking_pointer">
             <i class="fa fa-check fa-stack-1x" style="margin-left:1px"></i>
             <i class="fa fa-check fa-inverse fa-stack-1x" style="margin-left:-2px;"></i>
             <i class="fa fa-check fa-stack-1x" style="margin-left:-3px"></i>
         </span>
     </t>
-    <t t-elif="tracking[0] == 'opened'">
+    <t t-elif="tracking['status'] === 'opened'">
         <span class="fa-stack mail_tracking_opened mail_tracking_pointer">
             <i class="fa fa-check fa-stack-1x" style="margin-left:1px"></i>
             <i class="fa fa-check fa-inverse fa-stack-1x" style="margin-left:-2px;"></i>
@@ -50,55 +50,25 @@
     <t t-jquery="p[class='o_mail_info']" t-operation="after">
         <p class="o_mail_tracking">
             <strong>To:</strong>
-            <t t-set="first_tracking" t-value="true"/>
             <t t-foreach="message.partner_trackings" t-as="tracking">
-                <t t-set="isCc" t-value="false" />
+                <t t-if="!tracking_first">
-                <t t-foreach="message.email_cc" t-as="cc">
-                    <t t-if="cc[0] == tracking[4]" t-set="isCc" t-value="true" />
-                </t>
-                <t t-if="!first_tracking">
                       -
                 </t>
-                <t t-if="tracking[3]">
+                <t t-if="tracking['partner_id']">
-                    <a t-attf-class="o_mail_action_tracking_partner #{isCc ? 'o_mail_cc' : ''}"
+                    <a t-attf-class="o_mail_action_tracking_partner #{tracking['isCc'] ? 'o_mail_cc' : ''}"
-                       t-att-data-partner="tracking[3]"
+                       t-att-data-partner="tracking['partner_id']"
-                       t-attf-href="#model=res.partner&amp;id=#{tracking[3]}">
+                       t-attf-href="#model=res.partner&amp;id=#{tracking['partner_id']}">
-                        <t t-esc="tracking[2]"/>
+                        <t t-esc="tracking['recipient']"/>
                     </a>
                 </t>
-                <t t-if="!tracking[3]">
+                <t t-else="">
-                    <span><t t-esc="tracking[2]"/></span>
+                    <span t-attf-class="#{tracking['isCc'] ? 'o_mail_cc' : ''}"><t t-esc="tracking['recipient']"/></span>
                 </t>
                 <span class="mail_tracking o_mail_action_tracking_status"
-                      t-att-data-tracking="tracking[1]"
+                      t-att-data-tracking="tracking['tracking_id']"
-                      t-attf-title="Status: #{tracking[0]}">
+                      t-att-title="tracking['status_human']">
                     <t t-call="mail.tracking.status"/>
                 </span>
-                <t t-set="first_tracking" t-value="false"/>
-            </t>
-
-            <t t-foreach="message.email_cc" t-as="cc">
-                <t t-set="needPrint" t-value="true" />
-                <t t-foreach="message.partner_trackings" t-as="tracking">
-                    <t t-if="cc[0] == tracking[4]" t-set="needPrint" t-value="false" />
-                </t>
-                <t t-if="needPrint">
-                    <t t-set="isCc" t-value="true" />
-                    <t t-if="cc[1]">
-                        <a t-attf-class="o_mail_action_tracking_partner o_mail_cc"
-                           t-att-data-partner="cc[1][0]"
-                           t-attf-href="#model=res.partner&amp;id=#{cc[1][0]}">
-                            <t t-esc="cc[1][1]"/>
-                        </a>
-                    </t>
-                    <t t-else="">
-                        <span class="o_mail_cc"><t t-esc="cc[0]" /></span>
-                    </t>
-                    <span class="mail_tracking"
-                          title="Status: unknown">
-                          <t t-call="mail.tracking.status"/>
-                    </span>
-                </t>
             </t>
         </p>
     </t>

mail_tracking/tests/test_mail_tracking.py

@@ -99,10 +99,11 @@ class TestMailTracking(TransactionCase):
         status = message_dict['partner_trackings'][0]
         # Tracking status must be sent and
         # mail tracking must be the one search before
-        self.assertEqual(status[0], 'sent')
+        self.assertEqual(status['status'], 'sent')
-        self.assertEqual(status[1], tracking_email.id)
+        self.assertEqual(status['tracking_id'], tracking_email.id)
-        self.assertEqual(status[2], self.recipient.display_name)
+        self.assertEqual(status['recipient'], self.recipient.display_name)
-        self.assertEqual(status[3], self.recipient.id)
+        self.assertEqual(status['partner_id'], self.recipient.id)
+        self.assertEqual(status['isCc'], False)
         # And now open the email
         metadata = {
             'ip': '127.0.0.1',
@@ -113,6 +114,25 @@ class TestMailTracking(TransactionCase):
         tracking_email.event_create('open', metadata)
         self.assertEqual(tracking_email.state, 'opened')
 
+    def _check_partner_trackings(self, message):
+        message_dict = message.message_format()[0]
+        self.assertEqual(len(message_dict['partner_trackings']), 3)
+        # mail cc
+        foundPartner = False
+        foundNoPartner = False
+        for tracking in message_dict['partner_trackings']:
+            if tracking['partner_id'] == self.sender.id:
+                foundPartner = True
+                self.assertTrue(tracking['isCc'])
+            elif tracking['recipient'] == 'unnamed@test.com':
+                foundNoPartner = True
+                self.assertFalse(tracking['partner_id'])
+                self.assertTrue(tracking['isCc'])
+            elif tracking['partner_id'] == self.recipient.id:
+                self.assertFalse(tracking['isCc'])
+        self.assertTrue(foundPartner)
+        self.assertTrue(foundNoPartner)
+
     def test_email_cc(self):
         message = self.env['mail.message'].create({
             'subject': 'Message test',
@@ -125,17 +145,7 @@ class TestMailTracking(TransactionCase):
             'email_cc': 'unnamed@test.com, sender@example.com',
             'body': '<p>This is a test message</p>',
         })
-
+        self._check_partner_trackings(message)
-        message_dict = message.message_format()[0]
-        self.assertEqual(len(message_dict['email_cc']), 2)
-        # mail cc
-        # 'mail.message' First check Cc with res.partner
-        email_cc = message_dict['email_cc'][0]
-        self.assertEqual(email_cc[0], 'sender@example.com')
-        self.assertTrue(email_cc[1])
-        email_cc = message_dict['email_cc'][1]
-        self.assertEqual(email_cc[0], 'unnamed@test.com')
-        self.assertFalse(email_cc[1])
         # suggested recipients
         recipients = self.recipient.message_get_suggested_recipients()
         suggested_mails = {
@@ -152,11 +162,13 @@ class TestMailTracking(TransactionCase):
             'model': 'res.partner',
             'res_id': self.recipient.id,
             'partner_ids': [(4, self.recipient.id)],
-            'email_cc': 'unnamed@test.com, sender@example.com',
+            'email_cc': 'unnamed@test.com, sender@example.com'
+                        ', recipient@example.com',
             'body': '<p>This is another test message</p>',
         })
         recipients = self.recipient.message_get_suggested_recipients()
         self.assertEqual(len(recipients[self.recipient.id][0]), 3)
+        self._check_partner_trackings(message)
 
     def mail_send(self, recipient):
         mail = self.env['mail.mail'].create({