[19.0][MIG] mail_tracking_mailgun

mail_tracking_mailgun/README.rst

@@ -0,0 +1,164 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+=========================
+Mail tracking for Mailgun
+=========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:baa0b4cccd7ccebd5e3197b70a46ebb3d4c454734f06fb190cf74775b5bce75f
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/license-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%2Fmail-lightgray.png?logo=github
+    :target: https://github.com/OCA/mail/tree/19.0/mail_tracking_mailgun
+    :alt: OCA/mail
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/mail-19-0/mail-19-0-mail_tracking_mailgun
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/mail&target_branch=19.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module integrates mail_tracking events with Mailgun webhooks.
+
+`Mailgun <https://www.mailgun.com>`__ is a service that provides an
+e-mail sending infrastructure through an SMTP server or via API. You can
+also query that API for seeing statistics of your sent e-mails, or
+provide hooks that processes the status changes in real time, which is
+the function used here.
+
+**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_mailgun`` addon to wide
+load addons list (by default, only ``web`` addon), setting ``--load``
+option.
+
+Example: ``--load=web,mail_tracking,mail_tracking_mailgun``
+
+Configuration
+=============
+
+To configure this module, you need to:
+
+1. Go to Mailgun, create an account and validate your sending domain.
+2. Go back to Odoo.
+3. Go to *Settings > General Settings > Discuss > Enable mail tracking
+   with Mailgun*.
+4. Fill all the values. The only one required is the API key.
+5. Optionally click *Unregister Mailgun webhooks* and accept.
+6. Click *Register Mailgun webhooks*.
+
+You can also config timeout for mailgun with this system parameter:
+
+- ``mailgun.timeout``: Set it to a number of seconds.
+
+Usage
+=====
+
+In your mail tracking status screens (explained on module
+*mail_tracking*), you will see a more accurate information, like the
+'Received' or 'Bounced' status, which are not usually detected by normal
+SMTP servers.
+
+It's also possible to make some checks to the partner's email addresses
+against the Mailgun API:
+
+- Check if the partner's email is in Mailgun's bounced list.
+- Check the validity of the partner's mailbox.
+- Force the partner's email into Mailgun's bounced list or delete from
+  it.
+
+It's also possible to manually check a message mailgun tracking when the
+webhook couldn't be captured. For that, go to that message tracking
+form, press the button *Check Mailgun*. It's important to note that
+tracking events have quite a short lifespan, so after 24h they won't be
+recoverable.
+
+Known issues / Roadmap
+======================
+
+- There's no support for more than one Mailgun mail server.
+- Automate more webhook registration. It would be nice to not have to
+  click the "Unregister Mailgun webhooks" and "Register Mailgun
+  webhooks" when setting up Mailgun in Odoo. However, it doesn't come
+  without its `conceptual
+  complexities <https://github.com/OCA/social/pull/787#discussion_r734275262>`__.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/mail/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/mail/issues/new?body=module:%20mail_tracking_mailgun%0Aversion:%2019.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>`__:
+
+  - Antonio Espinosa
+  - Carlos Dauden
+  - Pedro M. Baeza
+  - David Vidal
+  - Rafael Blasco
+  - Ernesto Tejeda
+  - Jairo Llopis
+  - Carlos Roca
+
+Other credits
+-------------
+
+Images
+~~~~~~
+
+- Mailgun logo: `SVG
+  Icon <http://seeklogo.com/mailgun-logo-273630.html>`__.
+
+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/mail <https://github.com/OCA/mail/tree/19.0/mail_tracking_mailgun>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_tracking_mailgun/__init__.py

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

mail_tracking_mailgun/__manifest__.py

@@ -0,0 +1,22 @@
+# Copyright 2016 Tecnativa - Antonio Espinosa
+# Copyright 2016 Tecnativa - Carlos Dauden
+# Copyright 2017 Tecnativa - David Vidal
+# Copyright 2017,2025 Tecnativa - Pedro M. Baeza
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+{
+    "name": "Mail tracking for Mailgun",
+    "summary": "Mail tracking and Mailgun webhooks integration",
+    "version": "19.0.1.0.0",
+    "category": "Social Network",
+    "website": "https://github.com/OCA/mail",
+    "author": "Tecnativa, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "application": False,
+    "installable": True,
+    "depends": ["mail_tracking"],
+    "data": [
+        "views/res_partner.xml",
+        "views/mail_tracking_email.xml",
+        "wizards/res_config_settings_views.xml",
+    ],
+}

mail_tracking_mailgun/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

mail_tracking_mailgun/controllers/main.py

@@ -0,0 +1,75 @@
+# Copyright 2021 Tecnativa - Jairo Llopis
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import hashlib
+import hmac
+import logging
+from datetime import datetime, timedelta
+
+from werkzeug.exceptions import NotAcceptable
+
+from odoo.exceptions import ValidationError
+from odoo.http import request, route
+
+from odoo.addons.web.controllers.utils import ensure_db
+
+from ...mail_tracking.controllers import main
+
+_logger = logging.getLogger(__name__)
+
+
+class MailTrackingController(main.MailTrackingController):
+    def _mail_tracking_mailgun_webhook_verify(self, timestamp, token, signature):
+        """Avoid mailgun webhook attacks.
+
+        See https://documentation.mailgun.com/en/latest/user_manual.html#securing-webhooks
+        """  # noqa: E501
+        # Request cannot be old
+        processing_time = datetime.utcnow() - datetime.utcfromtimestamp(int(timestamp))
+        if not timedelta() < processing_time < timedelta(minutes=10):
+            raise ValidationError(request.env._("Request is too old"))
+        # Avoid replay attacks
+        try:
+            processed_tokens = (
+                request.env.registry._mail_tracking_mailgun_processed_tokens
+            )
+        except AttributeError:
+            processed_tokens = (
+                request.env.registry._mail_tracking_mailgun_processed_tokens
+            ) = set()
+        if token in processed_tokens:
+            raise ValidationError(request.env._("Request was already processed"))
+        processed_tokens.add(token)
+        params = request.env["mail.tracking.email"]._mailgun_values()
+        # Assert signature
+        if not params.webhook_signing_key:
+            _logger.warning(
+                "Skipping webhook payload verification. "
+                "Set `mailgun.webhook_signing_key` config parameter to enable"
+            )
+            return
+        hmac_digest = hmac.new(
+            key=params.webhook_signing_key.encode(),
+            msg=(f"{timestamp}{token}").encode(),
+            digestmod=hashlib.sha256,
+        ).hexdigest()
+        if not hmac.compare_digest(str(signature), str(hmac_digest)):
+            raise ValidationError(request.env._("Wrong signature"))
+
+    @route(["/mail/tracking/mailgun/all"], auth="none", type="jsonrpc", csrf=False)
+    def mail_tracking_mailgun_webhook(self):
+        """Process webhooks from Mailgun."""
+        ensure_db()
+        # Verify and return 406 in case of failure, to avoid retries
+        # See https://documentation.mailgun.com/en/latest/user_manual.html#routes
+        try:
+            self._mail_tracking_mailgun_webhook_verify(
+                **request.dispatcher.jsonrequest["signature"]
+            )
+        except ValidationError as error:
+            raise NotAcceptable from error
+        # Process event
+        request.env["mail.tracking.email"].sudo()._mailgun_event_process(
+            request.dispatcher.jsonrequest["event-data"],
+            self._request_metadata(),
+        )