99836513b9
Before this patch, the module was designed after the [deprecated Mailgun webhooks][3]. However Mailgun had the [events API][2] which was quite different. Modern Mailgun has deprecated those webhooks and instead uses new ones that include the same payload as the events API, so you can reuse code.
However, this was incorrectly reusing the code inversely: trying to process the events API through the same code prepared for the deprecated webhooks.
Besides, both `failed` and `rejected` mailgun events were mapped to `error` state, but that was also wrong because [`mail_tracking` doesn't have an `error` state][1].
So the logic of the whole module is changed, adapting it to process the events API payload, both through controllers (prepared for the new webhooks) and manual updates that directly call the events API.
Also, `rejected` is now translated into `reject`, and `failed` is translated into `hard_bounce` or `soft_bounce` depending on the severity, as specified by [mailgun docs][2]. Also, `bounced` and `dropped` mailgun states are removed because they don't exist, and instead `failed` and `rejected` properly get their metadata.
Of course, to know the severity, now the method to obtain that info must change, it' can't be a simple dict anymore.
Added more parameters because for example modern Mailgun uses different keys for signing payload than for accessing the API. As there are so many parameters, configuration is now possible through `res.config.settings`. Go there to autoregister webhooks too.
Since the new webhooks are completely incompatible with the old supposedly-abstract webhooks controllers (that were never really that abstract), support for old webhooks is removed, and it will be removed in the future from `mail_tracking` directly. There is a migration script that attempts to unregister old webhooks and register new ones automatically.
[1]: f73de421e2/mail_tracking/models/mail_tracking_event.py (L31-L42)
[2]: https://documentation.mailgun.com/en/latest/api-events.html#event-types
[3]: https://documentation.mailgun.com/en/latest/api-webhooks-deprecated.html
122 lines
4.3 KiB
Python
122 lines
4.3 KiB
Python
# Copyright 2021 Tecnativa - Jairo Llopis
|
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
|
|
|
import logging
|
|
from urllib.parse import urljoin
|
|
|
|
import requests
|
|
|
|
from odoo import fields, models
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
WEBHOOK_EVENTS = (
|
|
"clicked",
|
|
"complained",
|
|
"delivered",
|
|
"opened",
|
|
"permanent_fail",
|
|
"temporary_fail",
|
|
"unsubscribed",
|
|
)
|
|
|
|
|
|
class ResConfigSettings(models.TransientModel):
|
|
_inherit = "res.config.settings"
|
|
|
|
mail_tracking_mailgun_enabled = fields.Boolean(
|
|
string="Enable mail tracking with Mailgun",
|
|
help="Enable to enhance mail tracking with Mailgun",
|
|
)
|
|
mail_tracking_mailgun_api_key = fields.Char(
|
|
string="Mailgun API key",
|
|
config_parameter="mailgun.apikey",
|
|
help="Secret API key used to authenticate with Mailgun.",
|
|
)
|
|
mail_tracking_mailgun_webhook_signing_key = fields.Char(
|
|
string="Mailgun webhook signing key",
|
|
config_parameter="mailgun.webhook_signing_key",
|
|
help="Secret key used to validate incoming webhooks payload.",
|
|
)
|
|
mail_tracking_mailgun_validation_key = fields.Char(
|
|
string="Mailgun validation key",
|
|
config_parameter="mailgun.validation_key",
|
|
help="Key used to validate emails.",
|
|
)
|
|
mail_tracking_mailgun_api_url = fields.Char(
|
|
string="Mailgun API endpoint",
|
|
config_parameter="mailgun.api_url",
|
|
help=(
|
|
"Leave this empty if your API endpoint is the default "
|
|
"(https://api.mailgun.net/)."
|
|
),
|
|
)
|
|
mail_tracking_mailgun_domain = fields.Char(
|
|
string="Mailgun domain",
|
|
config_parameter="mailgun.domain",
|
|
help="Leave empty to use the catch-all domain.",
|
|
)
|
|
mail_tracking_mailgun_webhooks_domain = fields.Char(
|
|
string="Mailgun webhooks domain",
|
|
config_parameter="mailgun.webhooks_domain",
|
|
help="Leave empty to use the base Odoo URL.",
|
|
)
|
|
mail_tracking_mailgun_auto_check_partner_emails = fields.Boolean(
|
|
string="Check partner emails automatically",
|
|
config_parameter="mailgun.auto_check_partner_email",
|
|
help="Attempt to check partner emails always. This may cost money.",
|
|
)
|
|
|
|
def get_values(self):
|
|
"""Is Mailgun enabled?"""
|
|
result = super().get_values()
|
|
result["mail_tracking_mailgun_enabled"] = bool(
|
|
self.env["ir.config_parameter"].get_param("mailgun.apikey")
|
|
)
|
|
return result
|
|
|
|
def mail_tracking_mailgun_unregister_webhooks(self):
|
|
"""Remove existing Mailgun webhooks."""
|
|
params = self.env["mail.tracking.email"]._mailgun_values()
|
|
_logger.info("Getting current webhooks")
|
|
webhooks = requests.get(
|
|
urljoin(params.api_url, "/v3/domains/%s/webhooks" % params.domain),
|
|
auth=("api", params.api_key),
|
|
)
|
|
webhooks.raise_for_status()
|
|
for event, data in webhooks.json()["webhooks"].items():
|
|
# Modern webhooks return a list of URLs; old ones just one
|
|
urls = []
|
|
if "urls" in data:
|
|
urls.extend(data["urls"])
|
|
elif "url" in data:
|
|
urls.append(data["url"])
|
|
_logger.info(
|
|
"Deleting webhooks. Event: %s. URLs: %s", event, ", ".join(urls)
|
|
)
|
|
response = requests.delete(
|
|
urljoin(
|
|
params.api_url,
|
|
"/v3/domains/%s/webhooks/%s" % (params.domain, event),
|
|
),
|
|
auth=("api", params.api_key),
|
|
)
|
|
response.raise_for_status()
|
|
|
|
def mail_tracking_mailgun_register_webhooks(self):
|
|
"""Register Mailgun webhooks to get mail statuses automatically."""
|
|
params = self.env["mail.tracking.email"]._mailgun_values()
|
|
for event in WEBHOOK_EVENTS:
|
|
odoo_webhook = urljoin(
|
|
params.webhooks_domain,
|
|
"/mail/tracking/mailgun/all?db=%s" % self.env.cr.dbname,
|
|
)
|
|
_logger.info("Registering webhook. Event: %s. URL: %s", event, odoo_webhook)
|
|
response = requests.post(
|
|
urljoin(params.api_url, "/v3/domains/%s/webhooks" % params.domain),
|
|
auth=("api", params.api_key),
|
|
data={"id": event, "url": [odoo_webhook]},
|
|
)
|
|
# Assert correct registration
|
|
response.raise_for_status()
|