[MIG] mail_tracking: migration to 16.0

mail_tracking/README.rst

@@ -0,0 +1,198 @@
+==============
+Email tracking
+==============
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
+    :target: https://github.com/OCA/social/tree/15.0/mail_tracking
+    :alt: OCA/social
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/social-15-0/social-15-0-mail_tracking
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/205/15.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module shows email notification tracking status for any messages in
+mail thread (chatter). Each notified partner will have an intuitive icon just
+right to his name.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+If you're using a multi-database installation (with or without dbfilter option)
+where /web/databse/selector returns a list of more than one database, then
+you need to add ``mail_tracking`` addon to wide load addons list
+(by default, only ``web`` addon), setting ``--load`` option.
+For example, ``--load=web,mail_tracking``
+
+Configuration
+=============
+
+As there can be scenarios where sending a tracking img in the email body is
+not desired, there is a global system parameter
+"mail_tracking.tracking_img_disabled" that can be set to True to remove
+the tracking img from all outgoing emails. Note that the **Opened** status
+will not be available in this case.
+
+Usage
+=====
+
+When user sends a message in mail_thread (chatter), for instance in partner
+form, then an email tracking is created for each email notification. Then a
+status icon will appear just right to name of notified partner.
+
+These are all available status icons:
+
+.. |sent| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/sent.png
+   :width: 10px
+
+.. |delivered| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/delivered.png
+   :width: 15px
+
+.. |opened| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/opened.png
+   :width: 15px
+
+.. |error| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/error.png
+   :width: 10px
+
+.. |waiting| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/waiting.png
+   :width: 10px
+
+.. |unknown| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/unknown.png
+   :width: 10px
+
+.. |cc| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/cc.png
+   :width: 10px
+
+.. |noemail| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/no_email.png
+   :width: 10px
+
+.. |anonuser| image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/src/img/anon_user.png
+   :width: 10px
+
+|unknown|  **Unknown**: No email tracking info available. Maybe this notified partner has 'Receive Inbox Notifications by Email' == 'Never'
+
+|waiting|    **Waiting**: Waiting to be sent
+
+|error|    **Error**: Error while sending
+
+|sent|    **Sent**: Sent to SMTP server configured
+
+|delivered|    **Delivered**: Delivered to final MX server
+
+|opened|  **Opened**: Opened by partner
+
+|cc|  **Cc**: It's a Carbon-Copy recipient. Can't know the status so is 'Unknown'
+
+|noemail|  **No Email**: The partner doesn't have a defined email
+
+|anonuser|  **No Partner**: The recipient doesn't have a defined partner
+
+
+If you want to see all tracking emails and events you can go to
+
+* Settings > Technical > Email > Tracking emails
+* Settings > Technical > Email > Tracking events
+
+When the message generates an 'error' status, it will apear on discuss 'Failed'
+channel. Any view with chatter can show the failed messages
+too.
+
+* Discuss
+
+  .. image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/img/failed_message_discuss.png
+
+* Chatter
+
+  .. image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/img/failed_message_widget.png
+
+You can use "Failed sent messages" filter present in all views to show records
+with messages in failed status and that needs an user action.
+
+* Filter
+
+  .. image:: https://raw.githubusercontent.com/OCA/social/15.0/mail_tracking/static/img/failed_message_filter.png
+
+Known issues / Roadmap
+======================
+
+* Add pivot for tracking events and mail trackings
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_tracking%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Tecnativa
+
+Contributors
+~~~~~~~~~~~~
+
+* `Tecnativa <https://www.tecnativa.com>`_:
+
+  * Pedro M. Baeza
+  * Antonio Espinosa
+  * David Vidal
+  * Ernesto Tejeda
+  * Rafael Blasco
+  * Alexandre Díaz
+
+* `Eezee-IT <https://www.eezee-it.com>`_:
+  * Asma Elferkhsi
+
+Other credits
+~~~~~~~~~~~~~
+
+Images
+------
+
+* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
+* Thanks to `LlubNek <https://openclipart.org/user-detail/LlubNek>`_ and `Openclipart
+  <https://openclipart.org>`_ for `the icon
+  <https://openclipart.org/detail/19342/open-envelope>`_.
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/social <https://github.com/OCA/social/tree/15.0/mail_tracking>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_tracking/__init__.py

@@ -0,0 +1,4 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from . import models
+from . import controllers

mail_tracking/__manifest__.py

@@ -0,0 +1,36 @@
+# Copyright 2016 Antonio Espinosa - <antonio.espinosa@tecnativa.com>
+# Copyright 2018 David Vidal - <david.vidal@tecnativa.com>
+# Copyright 2018 Tecnativa - Ernesto Tejeda
+# Copyright 2019 Tecnativa - Pedro M. Baeza
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "Email tracking",
+    "summary": "Email tracking system for all mails sent",
+    "version": "16.0.1.0.0",
+    "category": "Social Network",
+    "website": "https://github.com/OCA/social",
+    "author": ("Tecnativa, " "Odoo Community Association (OCA)"),
+    "license": "AGPL-3",
+    "application": False,
+    "installable": True,
+    "depends": ["mail", "im_livechat"],
+    "data": [
+        "data/tracking_data.xml",
+        "security/mail_tracking_email_security.xml",
+        "security/ir.model.access.csv",
+        "views/mail_tracking_email_view.xml",
+        "views/mail_tracking_event_view.xml",
+        "views/mail_message_view.xml",
+        "views/res_partner_view.xml",
+    ],
+    "assets": {
+        "web.assets_backend": [
+            "mail_tracking/static/src/css/*.scss",
+            "mail_tracking/static/src/js/models/*.esm.js",
+            "mail_tracking/static/src/js/*.esm.js",
+            "mail_tracking/static/src/components/*.xml",
+        ],
+    },
+    "demo": ["demo/demo.xml"],
+}

mail_tracking/controllers/__init__.py

@@ -0,0 +1,4 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from . import main
+from . import discuss

mail_tracking/controllers/discuss.py

@@ -0,0 +1,24 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+from odoo import http
+
+from odoo.addons.mail.controllers.discuss import DiscussController
+
+
+class MailTrackingDiscussController(DiscussController):
+    @http.route()
+    def mail_init_messaging(self):
+        """Route used to initial values of Discuss app"""
+        values = super().mail_init_messaging()
+        values.update(
+            {"failed_counter": http.request.env["mail.message"].get_failed_count()}
+        )
+        return values
+
+    @http.route("/mail/failed/messages", methods=["POST"], type="json", auth="user")
+    def discuss_failed_messages(self, max_id=None, min_id=None, limit=30, **kwargs):
+        return http.request.env["mail.message"]._message_fetch(
+            domain=[("is_failed_message", "=", True)],
+            max_id=max_id,
+            min_id=min_id,
+            limit=limit,
+        ).message_format()

mail_tracking/controllers/main.py

@@ -0,0 +1,101 @@
+# Copyright 2016 Antonio Espinosa - <antonio.espinosa@tecnativa.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+import base64
+import logging
+from contextlib import contextmanager
+
+import werkzeug
+
+import odoo
+from odoo import SUPERUSER_ID, api, http
+
+from odoo.addons.mail.controllers.mail import MailController
+
+_logger = logging.getLogger(__name__)
+
+BLANK = "R0lGODlhAQABAIAAANvf7wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
+
+
+@contextmanager
+def db_env(dbname):
+    if not http.db_filter([dbname]):
+        raise werkzeug.exceptions.BadRequest()
+    cr = None
+    if dbname == http.request.db:
+        cr = http.request.cr
+    if not cr:
+        cr = odoo.sql_db.db_connect(dbname).cursor()
+    yield api.Environment(cr, SUPERUSER_ID, {})
+
+
+class MailTrackingController(MailController):
+    def _request_metadata(self):
+        """Prepare remote info metadata"""
+        request = http.request.httprequest
+        return {
+            "ip": request.remote_addr or False,
+            "user_agent": request.user_agent or False,
+            "os_family": request.user_agent.platform or False,
+            "ua_family": request.user_agent.browser or False,
+        }
+
+    # TODO Remove useless controller
+    @http.route(
+        [
+            "/mail/tracking/all/<string:db>",
+            "/mail/tracking/event/<string:db>/<string:event_type>",
+        ],
+        type="http",
+        auth="none",
+        csrf=False,
+    )
+    def mail_tracking_event(self, db, event_type=None, **kw):
+        """Route used by external mail service"""
+        metadata = self._request_metadata()
+        res = None
+        with db_env(db) as env:
+            try:
+                res = env["mail.tracking.email"].event_process(
+                    http.request, kw, metadata, event_type=event_type
+                )
+            except Exception as e:
+                _logger.warning(e)
+        if not res or res == "NOT FOUND":
+            return werkzeug.exceptions.NotAcceptable()
+        return res
+
+    @http.route(
+        [
+            "/mail/tracking/open/<string:db>" "/<int:tracking_email_id>/blank.gif",
+            "/mail/tracking/open/<string:db>"
+            "/<int:tracking_email_id>/<string:token>/blank.gif",
+        ],
+        type="http",
+        auth="none",
+        methods=["GET"],
+    )
+    def mail_tracking_open(self, db, tracking_email_id, token=False, **kw):
+        """Route used to track mail openned (With & Without Token)"""
+        metadata = self._request_metadata()
+        with db_env(db) as env:
+            try:
+                tracking_email = (
+                    env["mail.tracking.email"]
+                    .sudo()
+                    .search([("id", "=", tracking_email_id), ("token", "=", token)])
+                )
+                if not tracking_email:
+                    _logger.warning(
+                        "MailTracking email '%s' not found", tracking_email_id
+                    )
+                elif tracking_email.state in ("sent", "delivered"):
+                    tracking_email.event_create("open", metadata)
+            except Exception as e:
+                _logger.warning(e)
+
+        # Always return GIF blank image
+        response = werkzeug.wrappers.Response()
+        response.mimetype = "image/gif"
+        response.data = base64.b64decode(BLANK)
+        return response

mail_tracking/data/tracking_data.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2016 Antonio Espinosa - <antonio.espinosa@tecnativa.com>
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). -->
+<odoo>
+    <record
+        forcecreate="True"
+        id="decimal_tracking_timestamp"
+        model="decimal.precision"
+    >
+        <field name="name">MailTracking Timestamp</field>
+        <field name="digits">6</field>
+    </record>
+</odoo>