[MIG] mail_broker_whatsapp: Migration to 16.0

mail_gateway_whatsapp/README.rst

@@ -1,13 +1,13 @@
-====================
-Mail Whatsapp Broker
-====================
+=====================
+Mail Whatsapp Gateway
+=====================
 
 .. 
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:62e72978be98394211d7612773690a175256ed28ca39a6a93dbe936787083685
+   !! source digest: sha256:3544b6e49e8dc700d840809a985b4ee86c9fb3d0a9dbc76b49c956dc94211aed
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -17,10 +17,10 @@ Mail Whatsapp Broker
     :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/16.0/mail_broker_whatsapp
+    :target: https://github.com/OCA/social/tree/16.0/mail_gateway_whatsapp
     :alt: OCA/social
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_broker_whatsapp
+    :target: https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_gateway_whatsapp
     :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/social&target_branch=16.0
@@ -51,14 +51,14 @@ If you create a test Business Account, passwords will change every 24 hours.
 
 In order to make the webhook accessible, the system must be public.
 
-Configure the broker
-~~~~~~~~~~~~~~~~~~~~
+Configure the gateway
+~~~~~~~~~~~~~~~~~~~~~
 
-Once you have created the Meta App, you need to add the broker and webhook.
+Once you have created the Meta App, you need to add the gateway and webhook.
 In order to make it you must follow this steps:
 
-*  Access `Settings > Emails > Mail Broker`
-*  Create a Broker of type `WhatsApp`
+*  Access `Settings > Emails > Mail Gateway`
+*  Create a Gateway of type `WhatsApp`
 
   *  Use the Meta App authentication key as `Token` field
   *  Use the Meta App Phone Number ID as `Whatsapp from Phone` field
@@ -75,7 +75,7 @@ In order to make it you must follow this steps:
 Usage
 =====
 
-1. Access `Broker`
+1. Access `Gateway`
 2. Wait until someone starts a conversation.
 3. Now you will be able to respond and receive messages to this person.
 
@@ -85,7 +85,7 @@ 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 to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_broker_whatsapp%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_gateway_whatsapp%0Aversion:%2016.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.
 
@@ -96,6 +96,7 @@ Authors
 ~~~~~~~
 
 * Creu Blanca
+* Dixmit
 
 Contributors
 ~~~~~~~~~~~~
@@ -103,6 +104,11 @@ Contributors
 * Olga Marco <olga.marco@creublanca.es>
 * Enric Tobella <etobella@creublanca.es>
 
+Other credits
+~~~~~~~~~~~~~
+
+This work has been funded by AEOdoo (Asociación Española de Odoo - https://www.aeodoo.org)
+
 Maintainers
 ~~~~~~~~~~~
 
@@ -116,6 +122,6 @@ 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/16.0/mail_broker_whatsapp>`_ project on GitHub.
+This module is part of the `OCA/social <https://github.com/OCA/social/tree/16.0/mail_gateway_whatsapp>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_gateway_whatsapp/__init__.py

@@ -1,3 +1,4 @@
 from . import models
-from . import services
+
+# from . import services
 from . import wizards

mail_gateway_whatsapp/__manifest__.py

@@ -2,19 +2,27 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 {
-    "name": "Mail Whatsapp Broker",
+    "name": "Mail Whatsapp Gateway",
     "summary": """
-        Set a broker for whatsapp""",
-    "version": "13.0.1.0.0",
+        Set a gateway for whatsapp""",
+    "version": "16.0.1.0.0",
     "license": "AGPL-3",
-    "author": "Creu Blanca, Odoo Community Association (OCA)",
+    "author": "Creu Blanca, Dixmit, Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/social",
-    "depends": ["mail_broker", "phone_validation"],
+    "depends": ["mail_gateway", "phone_validation"],
     "external_dependencies": {"python": ["requests_toolbelt"]},
     "data": [
+        "security/ir.model.access.csv",
         "wizards/whatsapp_composer.xml",
-        "views/mail_broker.xml",
-        "templates/assets.xml",
+        "views/mail_gateway.xml",
     ],
-    "qweb": ["static/src/xml/thread.xml"],
+    "assets": {
+        "mail.assets_messaging": [
+            "mail_gateway_whatsapp/static/src/models/**/*.js",
+        ],
+        "web.assets_backend": [
+            "mail_gateway_whatsapp/static/src/components/**/*.xml",
+            "mail_gateway_whatsapp/static/src/components/**/*.js",
+        ],
+    },
 }

mail_gateway_whatsapp/models/__init__.py

@@ -1,2 +1,5 @@
-from . import mail_broker
+from . import mail_gateway
 from . import mail_thread
+from . import mail_gateway_whatsapp
+from . import mail_channel
+from . import res_partner

mail_gateway_whatsapp/models/mail_channel.py

@@ -0,0 +1,25 @@
+# Copyright 2024 Dixmit
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import models
+from odoo.modules.module import get_resource_path
+
+from odoo.addons.base.models.avatar_mixin import get_hsl_from_seed
+
+
+class MailChannel(models.Model):
+
+    _inherit = "mail.channel"
+
+    def _generate_avatar_gateway(self):
+        if self.gateway_id.gateway_type == "whatsapp":
+            path = get_resource_path(
+                "mail_gateway_whatsapp", "static/description", "icon.svg"
+            )
+            with open(path, "r") as f:
+                avatar = f.read()
+
+            bgcolor = get_hsl_from_seed(self.uuid)
+            avatar = avatar.replace("fill:#875a7b", f"fill:{bgcolor}")
+            return avatar
+        return super()._generate_avatar_gateway()

mail_gateway_whatsapp/models/mail_gateway.py

@@ -4,10 +4,12 @@
 from odoo import fields, models
 
 
-class MailBroker(models.Model):
-    _inherit = "mail.broker"
+class MailGateway(models.Model):
+    _inherit = "mail.gateway"
 
     whatsapp_security_key = fields.Char()
-    broker_type = fields.Selection(selection_add=[("whatsapp", "WhatsApp")])
+    gateway_type = fields.Selection(
+        selection_add=[("whatsapp", "WhatsApp")], ondelete={"whatsapp": "cascade"}
+    )
     whatsapp_from_phone = fields.Char()
     whatsapp_version = fields.Char(default="15.0")

mail_gateway_whatsapp/models/mail_gateway_whatsapp.py

@@ -0,0 +1,383 @@
+# Copyright 2024 Dixmit
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+import hashlib
+import hmac
+import logging
+import mimetypes
+import traceback
+from datetime import datetime
+from io import StringIO
+
+import requests
+import requests_toolbelt
+
+from odoo import _, models
+from odoo.exceptions import UserError
+from odoo.http import request
+from odoo.tools import html2plaintext
+
+from odoo.addons.base.models.ir_mail_server import MailDeliveryException
+
+_logger = logging.getLogger(__name__)
+
+
+class MailGatewayWhatsappService(models.AbstractModel):
+    _inherit = "mail.gateway.abstract"
+    _name = "mail.gateway.whatsapp"
+    _description = "Whatsapp Gateway services"
+
+    def _receive_get_update(self, bot_data, req, **kwargs):
+        self._verify_update(bot_data, {})
+        gateway = self.env["mail.gateway"].browse(bot_data["id"])
+        if kwargs.get("hub.verify_token") != gateway.whatsapp_security_key:
+            return None
+        gateway.sudo().integrated_webhook_state = "integrated"
+        response = request.make_response(kwargs.get("hub.challenge"))
+        response.status_code = 200
+        return response
+
+    def _set_webhook(self, gateway):
+        gateway.integrated_webhook_state = "pending"
+
+    def _verify_update(self, bot_data, kwargs):
+        signature = request.httprequest.headers.get("x-hub-signature-256")
+        if not signature:
+            return False
+        if (
+            "sha256=%s"
+            % hmac.new(
+                bot_data["webhook_secret"].encode(),
+                request.httprequest.data,
+                hashlib.sha256,
+            ).hexdigest()
+            != signature
+        ):
+            return False
+        return True
+
+    def _get_channel_vals(self, gateway, token, update):
+        result = super()._get_channel_vals(gateway, token, update)
+        for contact in update.get("contacts", []):
+            if contact["wa_id"] == token:
+                result["name"] = contact["profile"]["name"]
+                continue
+        return result
+
+    def _receive_update(self, gateway, update):
+        if update:
+            for entry in update["entry"]:
+                for change in entry["changes"]:
+                    if change["field"] != "messages":
+                        continue
+                    for message in change["value"].get("messages", []):
+                        chat = self._get_channel(
+                            gateway, message["from"], change["value"], force_create=True
+                        )
+                        if not chat:
+                            continue
+                        self._process_update(chat, message, change["value"])
+
+    def _process_update(self, chat, message, value):
+        chat.ensure_one()
+        body = ""
+        attachments = []
+        if message.get("text"):
+            body = message.get("text").get("body")
+        for key in ["image", "audio", "video", "document", "sticker"]:
+            if message.get(key):
+                image_id = message.get(key).get("id")
+                if image_id:
+                    image_info_request = requests.get(
+                        "https://graph.facebook.com/v%s/%s"
+                        % (
+                            chat.gateway_id.whatsapp_version,
+                            image_id,
+                        ),
+                        headers={
+                            "Authorization": "Bearer %s" % chat.gateway_id.token,
+                        },
+                        timeout=10,
+                        proxies=self._get_proxies(),
+                    )
+                    image_info_request.raise_for_status()
+                    image_info = image_info_request.json()
+                    image_url = image_info["url"]
+                else:
+                    image_url = message.get(key).get("url")
+                if not image_url:
+                    continue
+                image_request = requests.get(
+                    image_url,
+                    headers={
+                        "Authorization": "Bearer %s" % chat.gateway_id.token,
+                    },
+                    timeout=10,
+                    proxies=self._get_proxies(),
+                )
+                image_request.raise_for_status()
+                attachments.append(
+                    (
+                        "{}{}".format(
+                            image_id,
+                            mimetypes.guess_extension(image_info["mime_type"]),
+                        ),
+                        image_request.content,
+                    )
+                )
+        if message.get("location"):
+            body += (
+                '<a target="_blank" href="https://www.google.com/'
+                'maps/search/?api=1&query=%s,%s">Location</a>'
+                % (
+                    message["location"]["latitude"],
+                    message["location"]["longitude"],
+                )
+            )
+        if message.get("contacts"):
+            pass
+        if len(body) > 0 or attachments:
+            author = self._get_author(chat.gateway_id, value)
+            new_message = chat.message_post(
+                body=body,
+                author_id=author and author._name == "res.partner" and author.id,
+                gateway_type="whatsapp",
+                date=datetime.fromtimestamp(int(message["timestamp"])),
+                # message_id=update.message.message_id,
+                subtype_xmlid="mail.mt_comment",
+                message_type="comment",
+                attachments=attachments,
+            )
+            self._post_process_message(new_message, chat)
+            related_message_id = message.get("context", {}).get("id", False)
+            if related_message_id:
+                related_message = (
+                    self.env["mail.notification"]
+                    .search(
+                        [
+                            ("gateway_channel_id", "=", chat.id),
+                            ("gateway_message_id", "=", related_message_id),
+                        ]
+                    )
+                    .mail_message_id
+                )
+                if related_message and related_message.gateway_message_id:
+                    new_related_message = (
+                        self.env[related_message.gateway_message_id.model]
+                        .browse(related_message.gateway_message_id.res_id)
+                        .message_post(
+                            body=body,
+                            author_id=author
+                            and author._name == "res.partner"
+                            and author.id,
+                            gateway_type="whatsapp",
+                            date=datetime.fromtimestamp(int(message["timestamp"])),
+                            # message_id=update.message.message_id,
+                            subtype_xmlid="mail.mt_comment",
+                            message_type="comment",
+                            attachments=attachments,
+                        )
+                    )
+                    self._post_process_reply(related_message)
+                    new_message.gateway_message_id = new_related_message
+
+    def _send(
+        self,
+        gateway,
+        record,
+        auto_commit=False,
+        raise_exception=False,
+        parse_mode=False,
+    ):
+        message = False
+        try:
+            attachment_mimetype_map = self._get_whatsapp_mimetype_kind()
+            for attachment in record.mail_message_id.attachment_ids:
+                if attachment.mimetype not in attachment_mimetype_map:
+                    raise UserError(_("Mimetype is not valid"))
+                attachment_type = attachment_mimetype_map[attachment.mimetype]
+                m = requests_toolbelt.multipart.encoder.MultipartEncoder(
+                    fields={
+                        "file": (
+                            attachment.name,
+                            attachment.raw,
+                            attachment.mimetype,
+                        ),
+                        "messaging_product": "whatsapp",
+                        # "type": attachment_type
+                    },
+                )
+
+                response = requests.post(
+                    "https://graph.facebook.com/v%s/%s/media"
+                    % (
+                        gateway.whatsapp_version,
+                        gateway.whatsapp_from_phone,
+                    ),
+                    headers={
+                        "Authorization": "Bearer %s" % gateway.token,
+                        "content-type": m.content_type,
+                    },
+                    data=m,
+                    timeout=10,
+                    proxies=self._get_proxies(),
+                )
+                response.raise_for_status()
+                response = requests.post(
+                    "https://graph.facebook.com/v%s/%s/messages"
+                    % (
+                        gateway.whatsapp_version,
+                        gateway.whatsapp_from_phone,
+                    ),
+                    headers={"Authorization": "Bearer %s" % gateway.token},
+                    json=self._send_payload(
+                        record.gateway_channel_id,
+                        media_id=response.json()["id"],
+                        media_type=attachment_type,
+                        media_name=attachment.name,
+                    ),
+                    timeout=10,
+                    proxies=self._get_proxies(),
+                )
+                response.raise_for_status()
+                message = response.json()
+            body = self._get_message_body(record)
+            if body:
+                response = requests.post(
+                    "https://graph.facebook.com/v%s/%s/messages"
+                    % (
+                        gateway.whatsapp_version,
+                        gateway.whatsapp_from_phone,
+                    ),
+                    headers={"Authorization": "Bearer %s" % gateway.token},
+                    json=self._send_payload(record.gateway_channel_id, body=body),
+                    timeout=10,
+                    proxies=self._get_proxies(),
+                )
+                response.raise_for_status()
+                message = response.json()
+        except Exception as exc:
+            buff = StringIO()
+            traceback.print_exc(file=buff)
+            _logger.error(buff.getvalue())
+            if raise_exception:
+                raise MailDeliveryException(
+                    _("Unable to send the whatsapp message")
+                ) from exc
+            else:
+                _logger.warning(
+                    "Issue sending message with id {}: {}".format(record.id, exc)
+                )
+                record.sudo().write(
+                    {"notification_status": "exception", "failure_reason": exc}
+                )
+        if message:
+            record.sudo().write(
+                {
+                    "notification_status": "sent",
+                    "failure_reason": False,
+                    "gateway_message_id": message["messages"][0]["id"],
+                }
+            )
+        if auto_commit is True:
+            # pylint: disable=invalid-commit
+            self.env.cr.commit()
+
+    def _send_payload(
+        self, channel, body=False, media_id=False, media_type=False, media_name=False
+    ):
+        if body:
+            return {
+                "messaging_product": "whatsapp",
+                "recipient_type": "individual",
+                "to": channel.gateway_channel_token,
+                "type": "text",
+                "text": {"preview_url": False, "body": html2plaintext(body)},
+            }
+        if media_id:
+            media_data = {"id": media_id}
+            if media_type == "document":
+                media_data["filename"] = media_name
+            return {
+                "messaging_product": "whatsapp",
+                "recipient_type": "individual",
+                "to": channel.gateway_channel_token,
+                "type": media_type,
+                media_type: media_data,
+            }
+
+    def _get_whatsapp_mimetype_kind(self):
+        return {
+            "text/plain": "document",
+            "application/pdf": "document",
+            "application/vnd.ms-powerpoint": "document",
+            "application/msword": "document",
+            "application/vnd.ms-excel": "document",
+            "application/vnd.openxmlformats-officedocument."
+            "wordprocessingml.document": "document",
+            "application/vnd.openxmlformats-officedocument."
+            "presentationml.presentation": "document",
+            "application/vnd.openxmlformats-officedocument."
+            "spreadsheetml.sheet": "document",
+            "audio/aac": "audio",
+            "audio/mp4": "audio",
+            "audio/mpeg": "audio",
+            "audio/amr": "audio",
+            "audio/ogg": "audio",
+            "image/jpeg": "image",
+            "image/png": "image",
+            "video/mp4": "video",
+            "video/3gp": "video",
+            "image/webp": "sticker",
+        }
+
+    def _get_author(self, gateway, update):
+        author_id = update.get("messages")[0].get("from")
+        if author_id:
+            gateway_partner = self.env["res.partner.gateway.channel"].search(
+                [
+                    ("gateway_id", "=", gateway.id),
+                    ("gateway_token", "=", str(author_id)),
+                ]
+            )
+            if gateway_partner:
+                return gateway_partner.partner_id
+            partner = self.env["res.partner"].search(
+                [("phone_sanitized", "=", "+" + str(author_id))]
+            )
+            if partner:
+                self.env["res.partner.gateway.channel"].create(
+                    {
+                        "name": gateway.name,
+                        "partner_id": partner.id,
+                        "gateway_id": gateway.id,
+                        "gateway_token": str(author_id),
+                    }
+                )
+                return partner
+            guest = self.env["mail.guest"].search(
+                [
+                    ("gateway_id", "=", gateway.id),
+                    ("gateway_token", "=", str(author_id)),
+                ]
+            )
+            if guest:
+                return guest
+            author_vals = self._get_author_vals(gateway, author_id, update)
+            if author_vals:
+                return self.env["mail.guest"].create(author_vals)
+
+        return False
+
+    def _get_author_vals(self, gateway, author_id, update):
+        for contact in update.get("contacts", []):
+            if contact["wa_id"] == author_id:
+                return {
+                    "name": contact.get("profile", {}).get("name", "Anonymous"),
+                    "gateway_id": gateway.id,
+                    "gateway_token": str(author_id),
+                }
+
+    def _get_proxies(self):
+        # This hook has been created in order to add a proxy if needed.
+        # By default, it does nothing.
+        return {}

mail_gateway_whatsapp/models/mail_thread.py

@@ -11,38 +11,55 @@ class MailThread(models.AbstractModel):
 
     _inherit = "mail.thread"
 
-    def _get_whatsapp_channel_vals(self, token, broker, partner):
+    def _get_whatsapp_channel_vals(self, token, gateway, partner):
         result = {
-            "token": token,
-            "broker_id": broker.id,
-            "show_on_app": broker.show_on_app,
+            "gateway_channel_token": token,
+            "gateway_id": gateway.id,
         }
         if partner:
             result["partner_id"] = partner.id
             result["name"] = partner.display_name
         return result
 
-    def _whatsapp_get_channel(self, field_name, broker):
+    def _whatsapp_get_channel(self, field_name, gateway):
         phone = self[field_name]
         sanitize_res = phone_validation.phone_sanitize_numbers_w_record([phone], self)
         sanitized_number = sanitize_res[phone].get("sanitized")
         if not sanitized_number:
             raise UserError(_("Phone cannot be sanitized"))
         sanitized_number = sanitized_number[1:]
-        channel = broker._get_channel_id(sanitized_number)
-        partner = self._whastapp_get_partner()
-        if not channel:
-            channel = self.env["mail.broker.channel"].create(
-                self._get_whatsapp_channel_vals(sanitized_number, broker, partner)
+        partner = self._whatsapp_get_partner()
+        if not self.env["res.partner.gateway.channel"].search(
+            [
+                ("partner_id", "=", partner.id),
+                ("gateway_id", "=", gateway.id),
+                ("gateway_token", "=", sanitized_number),
+            ]
+        ):
+            self.env["res.partner.gateway.channel"].create(
+                {
+                    "name": gateway.name,
+                    "partner_id": partner.id,
+                    "gateway_id": gateway.id,
+                    "gateway_token": sanitized_number,
+                }
             )
-        else:
-            channel = self.env["mail.broker.channel"].browse(channel)
-        if not channel.partner_id and partner:
-            channel.partner_id = partner
-        return channel
+        return self.env["mail.gateway.whatsapp"]._get_channel(
+            gateway,
+            sanitized_number,
+            {
+                "contacts": [
+                    {
+                        "wa_id": sanitized_number,
+                        "profile": {"name": partner.display_name},
+                    }
+                ],
+                "messages": [{"from": sanitized_number}],
+            },
+            force_create=True,
+        )
 
-    def _whastapp_get_partner(self):
-        if self._name == "res.partner":
-            return self
+    def _whatsapp_get_partner(self):
         if "partner_id" in self._fields:
             return self.partner_id
+        return None

mail_gateway_whatsapp/models/res_partner.py

@@ -0,0 +1,20 @@
+# Copyright 2024 Dixmit
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import models
+
+
+class ResPartner(models.Model):
+    _name = "res.partner"
+    _inherit = ["mail.thread.phone", "res.partner"]
+
+    def _whatsapp_get_partner(self):
+        return self
+
+    def _phone_get_number_fields(self):
+        """This method returns the fields to use to find the number to use to
+        send an SMS on a record."""
+        result = set(super()._phone_get_number_fields())
+        result.add("mobile")
+        result.add("phone")
+        return list(result)

mail_gateway_whatsapp/readme/CONFIGURE.rst

@@ -8,14 +8,14 @@ If you create a test Business Account, passwords will change every 24 hours.
 
 In order to make the webhook accessible, the system must be public.
 
-Configure the broker
-~~~~~~~~~~~~~~~~~~~~
+Configure the gateway
+~~~~~~~~~~~~~~~~~~~~~
 
-Once you have created the Meta App, you need to add the broker and webhook.
+Once you have created the Meta App, you need to add the gateway and webhook.
 In order to make it you must follow this steps:
 
-*  Access `Settings > Emails > Mail Broker`
-*  Create a Broker of type `WhatsApp`
+*  Access `Settings > Emails > Mail Gateway`
+*  Create a Gateway of type `WhatsApp`
 
   *  Use the Meta App authentication key as `Token` field
   *  Use the Meta App Phone Number ID as `Whatsapp from Phone` field

mail_gateway_whatsapp/readme/CREDITS.rst

@@ -0,0 +1 @@
+This work has been funded by AEOdoo (Asociación Española de Odoo - https://www.aeodoo.org)

mail_gateway_whatsapp/readme/USAGE.rst

@@ -1,3 +1,3 @@
-1. Access `Broker`
+1. Access `Gateway`
 2. Wait until someone starts a conversation.
 3. Now you will be able to respond and receive messages to this person.

mail_gateway_whatsapp/security/ir.model.access.csv

@@ -0,0 +1,2 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_whatsapp_composer,access.whatsapp.composer,model_whatsapp_composer,base.group_user,1,1,1,0

mail_gateway_whatsapp/services/__init__.py

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

mail_gateway_whatsapp/services/mail_broker_service.py

@@ -1,300 +0,0 @@
-# Copyright 2018 ACSONE SA/NV
-# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
-import base64
-import hashlib
-import hmac
-import logging
-import mimetypes
-import traceback
-from datetime import datetime
-from io import StringIO
-
-import requests
-import requests_toolbelt
-
-from odoo import _
-from odoo.exceptions import UserError
-from odoo.http import request
-from odoo.tools import html2plaintext
-
-from odoo.addons.base.models.ir_mail_server import MailDeliveryException
-from odoo.addons.base_rest import restapi
-from odoo.addons.component.core import Component
-from odoo.addons.mail_broker.services.mail_broker_service import BrokerMethodParams
-
-_logger = logging.getLogger(__name__)
-
-
-class MailBrokerWhatsappService(Component):
-    _inherit = "mail.broker.base.service"
-    _name = "mail.broker.whastapp.service"
-    _usage = "whatsapp"
-    _description = "Whatsapp Broker services"
-
-    @restapi.method(
-        [(["/<string:bot_key>/update"], "GET")],
-        input_param=BrokerMethodParams(),
-        auth="none",
-    )
-    def get_update(self, token, **kwargs):
-        """Verification of the service from an external service"""
-        bot_data = self.env["mail.broker"]._get_broker(
-            token, state="pending", broker_type=self._usage, **kwargs
-        )
-        if not bot_data:
-            return None
-        self.collection.env = self.env(user=bot_data["webhook_user_id"])
-        broker = self.env["mail.broker"].browse(bot_data["id"])
-        if kwargs.get("hub").get("verify_token") != broker.whatsapp_security_key:
-            return None
-        broker.sudo().integrated_webhook_state = "integrated"
-        response = request.make_response(kwargs.get("hub").get("challenge"))
-        response.status_code = 200
-        return response
-
-    def _set_webhook(self):
-        self.collection.integrated_webhook_state = "pending"
-
-    def _verify_update(self, bot_data, kwargs):
-        signature = request.httprequest.headers.get("x-hub-signature-256")
-        if not signature:
-            return False
-        if (
-            "sha256=%s"
-            % hmac.new(
-                bot_data["webhook_secret"].encode(),
-                request.httprequest.data,
-                hashlib.sha256,
-            ).hexdigest()
-            != signature
-        ):
-            return False
-        return True
-
-    def _receive_update(self, broker, update):
-        if update:
-            for entry in update["entry"]:
-                for change in entry["changes"]:
-                    if change["field"] != "messages":
-                        continue
-                    for message in change["value"].get("messages", []):
-                        chat = self._get_channel(
-                            broker, message["from"], change["value"], force_create=True
-                        )
-        if not chat:
-            return
-        return self._process_update(chat, update)
-
-    def _get_channel_vals(self, broker, token, update):
-        result = super()._get_channel_vals(broker, token, update)
-        for contact in update.get("contacts"):
-            if contact["wa_id"] == token:
-                result["name"] = contact["profile"]["name"]
-                continue
-        return result
-
-    def _process_update(self, chat, updates):
-        chat.ensure_one()
-        body = ""
-        attachments = []
-        for entry in updates["entry"]:
-            for change in entry["changes"]:
-                if change["field"] != "messages":
-                    continue
-                for message in change["value"]["messages"]:
-                    if message.get("text"):
-                        body = message.get("text").get("body")
-                    for key in ["image", "audio", "video"]:
-                        if message.get(key):
-                            image_id = message.get(key).get("id")
-                            if image_id:
-                                image_info_request = requests.get(
-                                    "https://graph.facebook.com/v%s/%s"
-                                    % (self.collection.whatsapp_version, image_id,),
-                                    headers={
-                                        "Authorization": "Bearer %s"
-                                        % self.broker_id.token,
-                                    },
-                                )
-                                image_info_request.raise_for_status()
-                                image_info = image_info_request.json()
-                                image_url = image_info["url"]
-                            else:
-                                image_url = message.get(key).get("url")
-                            if not image_url:
-                                continue
-                            image_request = requests.get(
-                                image_url,
-                                headers={
-                                    "Authorization": "Bearer %s" % self.broker_id.token,
-                                },
-                            )
-                            image_request.raise_for_status()
-                            attachments.append(
-                                (
-                                    "{}{}".format(
-                                        image_id,
-                                        mimetypes.guess_extension(
-                                            image_info["mime_type"]
-                                        ),
-                                    ),
-                                    base64.b64encode(image_request.content).decode(
-                                        "utf-8"
-                                    ),
-                                    image_info["mime_type"],
-                                )
-                            )
-                    if message.get("location"):
-                        body += (
-                            '<a target="_blank" href="https://www.google.com/'
-                            'maps/search/?api=1&query=%s,%s">Location</a>'
-                            % (
-                                message["location"]["latitude"],
-                                message["location"]["longitude"],
-                            )
-                        )
-                    if message.get("contacts"):
-                        pass
-                    if len(body) > 0 or attachments:
-                        chat.message_post_broker(
-                            body=body,
-                            broker_type=self._usage,
-                            date=datetime.fromtimestamp(int(message["timestamp"])),
-                            message_id=message.get("id"),
-                            subtype="mt_comment",
-                            attachments=attachments,
-                        )
-
-    def _send_payload(
-        self, channel, body=False, media_id=False, media_type=False, media_name=False
-    ):
-        if body:
-            return {
-                "messaging_product": "whatsapp",
-                "recipient_type": "individual",
-                "to": channel.token,
-                "type": "text",
-                "text": {"preview_url": False, "body": html2plaintext(body)},
-            }
-        if media_id:
-            media_data = {"id": media_id}
-            if media_type == "document":
-                media_data["filename"] = media_name
-            return {
-                "messaging_product": "whatsapp",
-                "recipient_type": "individual",
-                "to": channel.token,
-                "type": media_type,
-                media_type: media_data,
-            }
-
-    def _get_whatsapp_mimetype_kind(self):
-        return {
-            "text/plain": "document",
-            "application/pdf": "document",
-            "application/vnd.ms-powerpoint": "document",
-            "application/msword": "document",
-            "application/vnd.ms-excel": "document",
-            "application/vnd.openxmlformats-officedocument."
-            "wordprocessingml.document": "document",
-            "application/vnd.openxmlformats-officedocument."
-            "presentationml.presentation": "document",
-            "application/vnd.openxmlformats-officedocument."
-            "spreadsheetml.sheet": "document",
-            "audio/aac": "audio",
-            "audio/mp4": "audio",
-            "audio/mpeg": "audio",
-            "audio/amr": "audio",
-            "audio/ogg": "audio",
-            "image/jpeg": "image",
-            "image/png": "image",
-            "video/mp4": "video",
-            "video/3gp": "video",
-            "image/webp": "sticker",
-        }
-
-    def _send(self, record, auto_commit=False, raise_exception=False, parse_mode=False):
-        message = False
-        try:
-            if record.body:
-                response = requests.post(
-                    "https://graph.facebook.com/v%s/%s/messages"
-                    % (
-                        self.collection.whatsapp_version,
-                        self.collection.whatsapp_from_phone,
-                    ),
-                    headers={"Authorization": "Bearer %s" % self.collection.token},
-                    json=self._send_payload(record.channel_id, body=record.body),
-                )
-                response.raise_for_status()
-                message = response.json()
-            attachment_mimetype_map = self._get_whatsapp_mimetype_kind()
-            for attachment in record.attachment_ids:
-                if attachment.mimetype not in attachment_mimetype_map:
-                    raise UserError(_("Mimetype is not valid"))
-                attachment_type = attachment_mimetype_map[attachment.mimetype]
-                m = requests_toolbelt.multipart.encoder.MultipartEncoder(
-                    fields={
-                        "file": (
-                            attachment.name,
-                            base64.b64decode(attachment.datas),
-                            attachment.mimetype,
-                        ),
-                        "messaging_product": "whatsapp",
-                        # "type": attachment_type
-                    },
-                )
-
-                response = requests.post(
-                    "https://graph.facebook.com/v%s/%s/media"
-                    % (
-                        self.collection.whatsapp_version,
-                        self.collection.whatsapp_from_phone,
-                    ),
-                    headers={
-                        "Authorization": "Bearer %s" % self.collection.token,
-                        "content-type": m.content_type,
-                    },
-                    data=m,
-                )
-                response.raise_for_status()
-                response = requests.post(
-                    "https://graph.facebook.com/v%s/%s/messages"
-                    % (
-                        self.collection.whatsapp_version,
-                        self.collection.whatsapp_from_phone,
-                    ),
-                    headers={"Authorization": "Bearer %s" % self.collection.token},
-                    json=self._send_payload(
-                        record.channel_id,
-                        media_id=response.json()["id"],
-                        media_type=attachment_type,
-                        media_name=attachment.name,
-                    ),
-                )
-                response.raise_for_status()
-                message = response.json()
-        except Exception as exc:
-            buff = StringIO()
-            traceback.print_exc(file=buff)
-            _logger.error(buff.getvalue())
-            if raise_exception:
-                raise MailDeliveryException(
-                    _("Unable to send the whatsapp message"), exc
-                )
-            else:
-                _logger.warning(
-                    "Issue sending message with id {}: {}".format(record.id, exc)
-                )
-                record.write({"state": "exception", "failure_reason": exc})
-        if message:
-            record.write(
-                {
-                    "state": "sent",
-                    "message_id": message["messages"][0]["id"],
-                    "failure_reason": False,
-                }
-            )
-        if auto_commit is True:
-            # pylint: disable=invalid-commit
-            self.env.cr.commit()

mail_gateway_whatsapp/static/description/icon.svg

@@ -1,160 +1,48 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   id="Capa_1"
-   data-name="Capa 1"
-   viewBox="0 0 200.33 200"
+   viewBox="0 0 240 240"
    version="1.1"
-   sodipodi:docname="icon.svg"
-   inkscape:version="0.92.3 (2405546, 2018-03-11)"
-   inkscape:export-filename="/home/operador/pyworkspace12/social/mail_telegram_broker/static/description/icon.png"
-   inkscape:export-xdpi="95.841858"
-   inkscape:export-ydpi="95.841858">
-  <metadata
-     id="metadata24">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title>icon</dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
+   id="svg4"
+   sodipodi:docname="whatsapp.svg"
+   inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)"
+   width="240"
+   height="240"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <defs
+     id="defs8" />
   <sodipodi:namedview
+     id="namedview6"
      pagecolor="#ffffff"
      bordercolor="#666666"
-     borderopacity="1"
-     objecttolerance="10"
-     gridtolerance="10"
-     guidetolerance="10"
-     inkscape:pageopacity="0"
+     borderopacity="1.0"
      inkscape:pageshadow="2"
-     inkscape:window-width="1853"
-     inkscape:window-height="1025"
-     id="namedview22"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
      showgrid="false"
-     showguides="true"
-     inkscape:guide-bbox="true"
-     inkscape:snap-text-baseline="true"
-     inkscape:zoom="1.668772"
-     inkscape:cx="32.080636"
-     inkscape:cy="54.692004"
-     inkscape:window-x="67"
-     inkscape:window-y="27"
+     inkscape:zoom="2.8085937"
+     inkscape:cx="103.25452"
+     inkscape:cy="127.2879"
+     inkscape:window-width="1858"
+     inkscape:window-height="1016"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
      inkscape:window-maximized="1"
-     inkscape:current-layer="layer2">
-    <sodipodi:guide
-       position="51.271186,126.37712"
-       orientation="-0.70710678,0.70710678"
-       id="guide40"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="118.65012,168.08767"
-       orientation="-0.70710678,0.70710678"
-       id="guide42"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="138.02966,143.00847"
-       orientation="-0.70710678,0.70710678"
-       id="guide46"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="137.92373,118.22034"
-       orientation="-0.70710678,0.70710678"
-       id="guide48"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="156.99152,93.008474"
-       orientation="-0.70710678,0.70710678"
-       id="guide50"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="139.19491,46.822034"
-       orientation="-0.70710678,0.70710678"
-       id="guide52"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="33.070725,104.38065"
-       orientation="-0.70710678,0.70710678"
-       id="guide839"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-    <sodipodi:guide
-       position="136.62741,46.516241"
-       orientation="-0.70710678,0.70710678"
-       id="guide841"
-       inkscape:locked="false"
-       inkscape:label=""
-       inkscape:color="rgb(0,0,255)" />
-  </sodipodi:namedview>
-  <defs
-     id="defs4">
-    <style
-       id="style2">.cls-1{fill:none;}.cls-2{fill:#3b588f;}.cls-3{fill:#070308;opacity:0.4;}.cls-4{fill:#fff;}</style>
-  </defs>
-  <title
-     id="title6">icon</title>
+     inkscape:current-layer="svg4"
+     units="px"
+     width="240px" />
+  <!--!Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2024 Fonticons, Inc.-->
   <rect
-     id="_Sector_"
-     data-name="&lt;Sector&gt;"
-     class="cls-1"
-     width="200"
-     height="200" />
-  <rect
-     class="cls-2"
-     x="0.33000001"
-     width="200"
-     height="200"
-     id="rect9"
-     ry="5.6928086"
-     y="0"
-     style="fill:#179cde;fill-opacity:1" />
-  <g
-     inkscape:groupmode="layer"
-     id="layer1"
-     inkscape:label="Layer 1"
-     style="display:inline" />
-  <g
-     inkscape:groupmode="layer"
-     id="layer2"
-     inkscape:label="Layer 3">
-    <path
-       style="fill:#000000;fill-opacity:0.29051986;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
-       d="M 34.149962,94.540113 0.33939645,128.35068 c 0,22.04621 -0.005125,-37.02851 -0.005125,66.40594 0,1.19849 0.87634879,2.80824 1.47559179,3.40749 0,0 1.6732367,1.97005 4.5570938,1.85769 l 83.7317707,-0.009 47.844652,-47.84466 4.88661,-95.023805 z"
-       id="path843"
-       inkscape:connector-curvature="0"
-       sodipodi:nodetypes="ccccccccc" />
-  </g>
-  <g
-     inkscape:groupmode="layer"
-     id="layer4"
-     inkscape:label="Layer 2"
-     style="display:inline">
-    <path
-       id="path828"
-       d="m 158.96325,57.709612 -19.05983,89.885658 c -1.43794,6.34387 -5.18788,7.92279 -10.51673,4.93412 l -29.04085,-21.4 -14.012923,13.47721 c -1.550725,1.55072 -2.84769,2.84769 -5.836362,2.84769 l 2.086431,-29.57656 53.824254,-48.636368 c 2.34019,-2.08643 -0.50751,-3.24242 -3.63715,-1.15599 L 66.229882,109.98314 37.583764,101.01713 c -6.23109,-1.945458 -6.34388,-6.231088 1.29697,-9.219758 L 150.92767,48.63082 c 5.18788,-1.945453 9.72728,1.155997 8.03558,9.078792 z"
-       inkscape:connector-curvature="0"
-       style="display:inline;fill:#ffffff;fill-opacity:1;stroke-width:0.28195" />
-  </g>
+     style="fill:#875a7b"
+     id="rect965"
+     width="240"
+     height="240"
+     x="0"
+     y="0" />
+  <path
+     d="M 176.0428,63.25121 C 161.07774,48.25043 141.14813,40 119.96845,40 76.25189,40 40.6786,75.57328 40.6786,119.28985 c 0,13.96501 3.64306,27.60858 10.57199,39.64492 L 40,200.00834 82.0379,188.97205 c 11.572034,6.32176 24.60843,9.64336 37.89484,9.64336 h 0.0357 c 43.68085,0 80.03989,-35.57328 80.03989,-79.28985 0,-21.17967 -9.00047,-41.07357 -23.96554,-56.07435 z m -56.07435,122.00636 c -11.85776,0 -23.465496,-3.17873 -33.573176,-9.17905 l -2.392984,-1.42864 -24.92987,6.53605 6.64321,-24.3227 -1.57151,-2.50012 c -6.60749,-10.50055 -10.07196,-22.60832 -10.07196,-35.07326 0,-36.32332 29.57297,-65.89629 65.93201,-65.89629 17.60806,0 34.14464,6.8575 46.57385,19.32243 12.42923,12.46494 20.07248,29.00151 20.03677,46.60957 0,36.35904 -30.32301,65.93201 -66.64634,65.93201 z m 36.14474,-49.35971 c -1.96438,-1.00005 -11.71489,-5.78602 -13.53641,-6.42891 -1.82153,-0.67861 -3.14303,-1.00005 -4.46453,1.00005 -1.32149,2.00011 -5.1074,6.42891 -6.28603,7.78612 -1.14292,1.3215 -2.32155,1.50008 -4.28594,0.50003 -11.64347,-5.82173 -19.28673,-10.3934 -26.9657,-23.57266 -2.03582,-3.50018 2.03583,-3.25017 5.82174,-10.82199 0.64289,-1.3215 0.32144,-2.46441 -0.17858,-3.46447 -0.50003,-1.00005 -4.46452,-10.75056 -6.10747,-14.71505 -1.60722,-3.85734 -3.25016,-3.3216 -4.464506,-3.39304 -1.14292,-0.0714 -2.46442,-0.0714 -3.78592,-0.0714 -1.32149,0 -3.46446,0.50003 -5.28598,2.46442 -1.821534,2.0001 -6.928944,6.78607 -6.928944,16.53657 0,9.75051 7.107514,19.17957 8.071854,20.50107 1.00005,1.3215 13.965006,21.32254 33.858906,29.93014 12.57209,5.42885 17.50091,5.89316 23.78695,4.96454 3.82163,-0.57146 11.7149,-4.78597 13.35784,-9.42907 1.64294,-4.6431 1.64294,-8.60758 1.14292,-9.42906 -0.46431,-0.8929 -1.78581,-1.39293 -3.7502,-2.35726 z"
+     id="path2"
+     style="fill:#ffffff;fill-opacity:1;stroke-width:0.357162" />
 </svg>

mail_gateway_whatsapp/static/description/index.html

@@ -1,10 +1,9 @@
-<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
-<title>Mail Whatsapp Broker</title>
+<title>Mail Whatsapp Gateway</title>
 <style type="text/css">
 
 /*
@@ -360,16 +359,16 @@ ul.auto-toc {
 </style>
 </head>
 <body>
-<div class="document" id="mail-whatsapp-broker">
-<h1 class="title">Mail Whatsapp Broker</h1>
+<div class="document" id="mail-whatsapp-gateway">
+<h1 class="title">Mail Whatsapp Gateway</h1>
 
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:62e72978be98394211d7612773690a175256ed28ca39a6a93dbe936787083685
+!! source digest: sha256:3544b6e49e8dc700d840809a985b4ee86c9fb3d0a9dbc76b49c956dc94211aed
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/social/tree/16.0/mail_broker_whatsapp"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_broker_whatsapp"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/social&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/social/tree/16.0/mail_gateway_whatsapp"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_gateway_whatsapp"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/social&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module allows to respond whatsapp chats.</p>
 <p>This way, a group of users can respond customers or any other set
 of partners in an integrated way.</p>
@@ -378,7 +377,7 @@ of partners in an integrated way.</p>
 <ul class="simple">
 <li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a><ul>
 <li><a class="reference internal" href="#first-steps" id="toc-entry-2">First steps</a></li>
-<li><a class="reference internal" href="#configure-the-broker" id="toc-entry-3">Configure the broker</a></li>
+<li><a class="reference internal" href="#configure-the-gateway" id="toc-entry-3">Configure the gateway</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#usage" id="toc-entry-4">Usage</a></li>
@@ -386,7 +385,8 @@ of partners in an integrated way.</p>
 <li><a class="reference internal" href="#credits" id="toc-entry-6">Credits</a><ul>
 <li><a class="reference internal" href="#authors" id="toc-entry-7">Authors</a></li>
 <li><a class="reference internal" href="#contributors" id="toc-entry-8">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-9">Maintainers</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-9">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-10">Maintainers</a></li>
 </ul>
 </li>
 </ul>
@@ -400,13 +400,13 @@ You can follow this <a class="reference external" href="https://developers.faceb
 <p>If you create a test Business Account, passwords will change every 24 hours.</p>
 <p>In order to make the webhook accessible, the system must be public.</p>
 </div>
-<div class="section" id="configure-the-broker">
-<h2><a class="toc-backref" href="#toc-entry-3">Configure the broker</a></h2>
-<p>Once you have created the Meta App, you need to add the broker and webhook.
+<div class="section" id="configure-the-gateway">
+<h2><a class="toc-backref" href="#toc-entry-3">Configure the gateway</a></h2>
+<p>Once you have created the Meta App, you need to add the gateway and webhook.
 In order to make it you must follow this steps:</p>
 <ul class="simple">
-<li>Access <cite>Settings &gt; Emails &gt; Mail Broker</cite></li>
-<li>Create a Broker of type <cite>WhatsApp</cite></li>
+<li>Access <cite>Settings &gt; Emails &gt; Mail Gateway</cite></li>
+<li>Create a Gateway of type <cite>WhatsApp</cite></li>
 </ul>
 <blockquote>
 <ul class="simple">
@@ -429,7 +429,7 @@ In order to make it you must follow this steps:</p>
 <div class="section" id="usage">
 <h1><a class="toc-backref" href="#toc-entry-4">Usage</a></h1>
 <ol class="arabic simple">
-<li>Access <cite>Broker</cite></li>
+<li>Access <cite>Gateway</cite></li>
 <li>Wait until someone starts a conversation.</li>
 <li>Now you will be able to respond and receive messages to this person.</li>
 </ol>
@@ -439,7 +439,7 @@ In order to make it you must follow this steps:</p>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
 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
-<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_broker_whatsapp%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_gateway_whatsapp%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -448,6 +448,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
 <h2><a class="toc-backref" href="#toc-entry-7">Authors</a></h2>
 <ul class="simple">
 <li>Creu Blanca</li>
+<li>Dixmit</li>
 </ul>
 </div>
 <div class="section" id="contributors">
@@ -457,14 +458,18 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
 <li>Enric Tobella &lt;<a class="reference external" href="mailto:etobella&#64;creublanca.es">etobella&#64;creublanca.es</a>&gt;</li>
 </ul>
 </div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-9">Other credits</a></h2>
+<p>This work has been funded by AEOdoo (Asociación Española de Odoo - <a class="reference external" href="https://www.aeodoo.org">https://www.aeodoo.org</a>)</p>
+</div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-10">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <p>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.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/16.0/mail_broker_whatsapp">OCA/social</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/16.0/mail_gateway_whatsapp">OCA/social</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>

mail_gateway_whatsapp/static/src/components/message/message.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-inherit="mail.MessageViewNotification" t-inherit-mode="extension">
+        <xpath expr="//div" position="after">
+            <i
+                class="fa fa-whatsapp text-info"
+                t-if="messageView.message.gateway_type == 'whatsapp' and messageView.message.notifications.length == 0"
+            />
+        </xpath>
+    </t>
+</templates>

mail_gateway_whatsapp/static/src/components/phone_field/phone_field.esm.js

@@ -0,0 +1,25 @@
+/** @odoo-module **/
+
+import {PhoneField} from "@web/views/fields/phone/phone_field";
+import {SendWhatsappButton} from "@mail_gateway_whatsapp/components/send_whatsapp_button/send_whatsapp_button.esm";
+import {patch} from "@web/core/utils/patch";
+patch(PhoneField, "mail_gateway_whatsapp.PhoneField", {
+    components: {
+        ...PhoneField.components,
+        SendWhatsappButton,
+    },
+    defaultProps: {
+        ...PhoneField.defaultProps,
+        enableButton: true,
+    },
+    props: {
+        ...PhoneField.props,
+        enableButton: {type: Boolean, optional: true},
+    },
+    extractProps: ({attrs}) => {
+        return {
+            enableButton: attrs.options.enable_sms,
+            placeholder: attrs.placeholder,
+        };
+    },
+});

mail_gateway_whatsapp/static/src/components/phone_field/phone_field.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-inherit="web.PhoneField" t-inherit-mode="extension">
+        <xpath expr="//div[hasclass('o_phone_content')]//a" position="after">
+            <t t-if="props.enableButton and props.value.length > 0">
+                <SendWhatsappButton t-props="props" />
+            </t>
+        </xpath>
+    </t>
+
+    <t t-inherit="web.FormPhoneField" t-inherit-mode="extension">
+        <xpath expr="//div[hasclass('o_phone_content')]" position="inside">
+            <t t-if="props.enableButton and props.value.length > 0">
+                <SendWhatsappButton t-props="props" />
+            </t>
+        </xpath>
+    </t>
+
+</templates>

mail_gateway_whatsapp/static/src/components/send_whatsapp_button/send_whatsapp_button.esm.js

@@ -0,0 +1,44 @@
+/** @odoo-module **/
+
+import {useService} from "@web/core/utils/hooks";
+
+const {Component, status} = owl;
+
+export class SendWhatsappButton extends Component {
+    setup() {
+        this.action = useService("action");
+        this.user = useService("user");
+        this.title = this.env._t("Send Whatsapp Message");
+    }
+    get phoneHref() {
+        return "sms:" + this.props.value.replace(/\s+/g, "");
+    }
+    async onClick() {
+        await this.props.record.save();
+        this.action.doAction(
+            {
+                type: "ir.actions.act_window",
+                target: "new",
+                name: this.title,
+                res_model: "whatsapp.composer",
+                views: [[false, "form"]],
+                context: {
+                    ...this.user.context,
+                    default_res_model: this.props.record.resModel,
+                    default_res_id: this.props.record.resId,
+                    default_number_field_name: this.props.name,
+                    default_composition_mode: "comment",
+                },
+            },
+            {
+                onClose: () => {
+                    if (status(this) !== "destroyed") {
+                        this.props.record.load();
+                        this.props.record.model.notify();
+                    }
+                },
+            }
+        );
+    }
+}
+SendWhatsappButton.template = "mail_gateway_whatsapp.SendWhatsappButton";

mail_gateway_whatsapp/static/src/components/send_whatsapp_button/send_whatsapp_button.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="mail_gateway_whatsapp.SendWhatsappButton" owl="1">
+        <a
+            t-att-title="title"
+            t-att-href="phoneHref"
+            t-on-click.prevent.stop="onClick"
+            class="ms-3 d-inline-flex align-items-center o_field_phone_whatsapp"
+        ><i class="fa fa-whatsapp" /><small class="fw-bold ms-1">Whatsapp</small></a>
+    </t>
+
+</templates>

mail_gateway_whatsapp/static/src/js/phone_widget.js

@@ -1,63 +0,0 @@
-/** ********************************************************************************
-    Copyright 2022 Creu Blanca
-    License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
- **********************************************************************************/
-
-odoo.define("mail_broker_whatsapp.phone_widget", function(require) {
-    "use strict";
-    var basic_fields = require("web.basic_fields");
-    var core = require("web.core");
-    var session = require("web.session");
-
-    var _t = core._t;
-    basic_fields.FieldPhone.include({
-        /**
-         * Add a button to call the composer wizard
-         *
-         * @override
-         * @private
-         */
-        _renderReadonly: function() {
-            var def = this._super.apply(this, arguments);
-            if (this.nodeOptions.enable_sms) {
-                var $composerButton = $("<a>", {
-                    title: _t("Send Whatsapp Message"),
-                    href: "",
-                    class: "ml-3 d-inline-flex align-items-center o_field_phone_sms",
-                });
-                $composerButton.prepend($("<i>", {class: "fa fa-whatsapp"}));
-                $composerButton.on("click", this._onClickWhatsapp.bind(this));
-                this.$el.append($composerButton);
-            }
-
-            return def;
-        },
-        _onClickWhatsapp: function(ev) {
-            ev.preventDefault();
-
-            var context = session.user_context;
-            context = _.extend({}, context, {
-                default_res_model: this.model,
-                default_res_id: parseInt(this.res_id, 10),
-                default_number_field_name: this.name,
-                default_composition_mode: "comment",
-            });
-            var self = this;
-            return this.do_action(
-                {
-                    title: _t("Send Whatsapp Message"),
-                    type: "ir.actions.act_window",
-                    res_model: "whatsapp.composer",
-                    target: "new",
-                    views: [[false, "form"]],
-                    context: context,
-                },
-                {
-                    on_close: function() {
-                        self.trigger_up("reload");
-                    },
-                }
-            );
-        },
-    });
-});

mail_gateway_whatsapp/static/src/models/message.esm.js

@@ -0,0 +1,21 @@
+/** @odoo-module **/
+
+import {registerPatch} from "@mail/model/model_core";
+
+registerPatch({
+    name: "Message",
+    fields: {
+        avatarUrl: {
+            compute() {
+                if (
+                    !this.author &&
+                    !this.guestAuthor &&
+                    this.gateway_type === "whatsapp"
+                ) {
+                    return "/mail_gateway_whatsapp/static/description/icon.png";
+                }
+                return this._super();
+            },
+        },
+    },
+});

mail_gateway_whatsapp/static/src/models/message_view.esm.js

@@ -0,0 +1,25 @@
+/** @odoo-module **/
+
+import {registerPatch} from "@mail/model/model_core";
+
+registerPatch({
+    name: "MessageView",
+    fields: {
+        notificationIconClassName: {
+            compute() {
+                if (this.message && this.message.gateway_type === "whatsapp") {
+                    return "fa fa-whatsapp";
+                }
+                return this._super();
+            },
+        },
+        failureNotificationIconClassName: {
+            compute() {
+                if (this.message && this.message.gateway_type === "whatsapp") {
+                    return "fa fa-whatsapp";
+                }
+                return this._super();
+            },
+        },
+    },
+});

mail_gateway_whatsapp/static/src/models/notification.esm.js

@@ -0,0 +1,25 @@
+/** @odoo-module **/
+
+import {registerPatch} from "@mail/model/model_core";
+
+registerPatch({
+    name: "Notification",
+    fields: {
+        iconClass: {
+            compute() {
+                if (
+                    this.notification_type === "gateway" &&
+                    this.gateway_type === "whatsapp"
+                ) {
+                    switch (this.notification_status) {
+                        case "sent":
+                            return "fa fa-whatsapp";
+                        case "exception":
+                            return "fa fa-whatsapp text-danger";
+                    }
+                }
+                return this._super();
+            },
+        },
+    },
+});

mail_gateway_whatsapp/static/src/xml/thread.xml

@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<templates xml:space="preserve">
-    <t t-extend="mail.widget.Thread.Message">
-        <t t-jquery=".o_thread_tooltip_broker_container" t-operation="append">
-            <i
-                t-att-class="'o_thread_message_broker_' + message.customer_status + ' fa fa-whatsapp fa-lg'"
-                t-if="message.broker_type == 'whatsapp'"
-            />
-        </t>
-    </t>
-</templates>

mail_gateway_whatsapp/templates/assets.xml

@@ -1,21 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<!--
-
-    Copyright 2022 CreuBlanca
-    License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
-
-  -->
-<odoo>
-    <template
-        id="assets_backend"
-        name="mail_broker_whatsapp_base_assets"
-        inherit_id="web.assets_backend"
-    >
-        <xpath expr="//script[last()]" position="after">
-            <script
-                type="text/javascript"
-                src="/mail_broker_whatsapp/static/src/js/phone_widget.js"
-            />
-        </xpath>
-    </template>
-</odoo>

mail_gateway_whatsapp/tests/__init__.py

@@ -1 +1 @@
-from . import test_mail_broker_whatsapp
+from . import test_mail_gateway_whatsapp

mail_gateway_whatsapp/tests/test_mail_broker_whatsapp.py

@@ -1,197 +0,0 @@
-# Copyright 2022 CreuBlanca
-# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
-
-import hashlib
-import hmac
-
-from mock import MagicMock, patch
-from werkzeug.test import EnvironBuilder
-
-from odoo import http
-from odoo.exceptions import UserError
-from odoo.http import HttpRequest, root
-
-from odoo.addons.mail_broker.tests.common import MailBrokerComponentRegistryTestCase
-
-
-class TestMailBrokerTelegram(MailBrokerComponentRegistryTestCase):
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()
-        cls._load_module_components(cls, "mail_broker_whatsapp")
-        cls.webhook = "demo_hook"
-        cls.broker = cls.env["mail.broker"].create(
-            {
-                "name": "broker",
-                "broker_type": "whatsapp",
-                "token": "token",
-                "whatsapp_security_key": "key",
-                "webhook_secret": "MY-SECRET",
-            }
-        )
-        cls.partner = cls.env["res.partner"].create(
-            {"name": "Partner", "mobile": "+34 600 000 000"}
-        )
-        cls.password = "my_new_password"
-        cls.message_01 = {
-            "object": "whatsapp_business_account",
-            "entry": [
-                {
-                    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
-                    "changes": [
-                        {
-                            "value": {
-                                "messaging_product": "whatsapp",
-                                "metadata": {
-                                    "display_phone_number": "1234",
-                                    "phone_number_id": "1234",
-                                },
-                                "contacts": [
-                                    {"profile": {"name": "NAME"}, "wa_id": "1234"}
-                                ],
-                                "messages": [
-                                    {
-                                        "from": "1234",
-                                        "id": "wamid.ID",
-                                        "timestamp": "1234",
-                                        "text": {"body": "MESSAGE_BODY"},
-                                        "type": "text",
-                                    }
-                                ],
-                            },
-                            "field": "messages",
-                        }
-                    ],
-                }
-            ],
-        }
-
-    def test_webhook_management(self):
-        self.broker.webhook_key = self.webhook
-        self.broker.flush()
-        self.assertTrue(self.broker.can_set_webhook)
-        self.broker.set_webhook()
-        self.assertEqual(self.broker.integrated_webhook_state, "pending")
-        self.broker.remove_webhook()
-        self.assertFalse(self.broker.integrated_webhook_state)
-        self.broker.set_webhook()
-        self.assertEqual(self.broker.integrated_webhook_state, "pending")
-        req = EnvironBuilder().get_request()
-        root.setup_session(req)
-        http._request_stack.push(HttpRequest(req))
-        with self.broker.work_on(self.broker._name) as work:
-            work.component(usage=self.broker.broker_type).get_update(
-                self.webhook,
-                **{
-                    "hub": {
-                        "verify_token": self.broker.whatsapp_security_key + "12",
-                        "challenge": "22",
-                    }
-                }
-            )
-        http._request_stack.pop()
-        self.assertEqual(self.broker.integrated_webhook_state, "pending")
-        self.integrate_webhook()
-        self.assertEqual(self.broker.integrated_webhook_state, "integrated")
-        self.broker.remove_webhook()
-        self.assertFalse(self.broker.integrated_webhook_state)
-
-    def integrate_webhook(self):
-        req = EnvironBuilder().get_request()
-        root.setup_session(req)
-        http._request_stack.push(HttpRequest(req))
-        with self.broker.work_on(self.broker._name) as work:
-            work.component(usage=self.broker.broker_type).get_update(
-                self.webhook,
-                **{
-                    "hub": {
-                        "verify_token": self.broker.whatsapp_security_key,
-                        "challenge": "22",
-                    }
-                }
-            )
-        http._request_stack.pop()
-
-    def set_message(self, message, webhook, headers=True):
-        req = EnvironBuilder().get_request()
-        root.setup_session(req)
-        if headers:
-            req.headers = {
-                "x-hub-signature-256": "sha256=%s"
-                % hmac.new(
-                    self.broker.webhook_secret.encode(), req.data, hashlib.sha256,
-                ).hexdigest()
-            }
-        http._request_stack.push(HttpRequest(req))
-        with self.broker.work_on(self.broker._name) as work:
-            work.component(usage=self.broker.broker_type).post_update(
-                webhook, **message
-            )
-        http._request_stack.pop()
-
-    def test_post_message(self):
-        self.broker.webhook_key = self.webhook
-        self.broker.set_webhook()
-        self.integrate_webhook()
-        self.set_message(self.message_01, self.webhook)
-        self.assertTrue(
-            self.env["mail.broker.channel"].search([("broker_id", "=", self.broker.id)])
-        )
-
-    def test_post_no_signature_no_message(self):
-        self.broker.webhook_key = self.webhook
-        self.broker.set_webhook()
-        self.integrate_webhook()
-        self.set_message(self.message_01, self.webhook, False)
-        self.assertFalse(
-            self.env["mail.broker.channel"].search([("broker_id", "=", self.broker.id)])
-        )
-
-    def test_post_wrong_signature_no_message(self):
-        self.broker.webhook_key = self.webhook
-        self.broker.set_webhook()
-        self.integrate_webhook()
-        req = EnvironBuilder().get_request()
-        root.setup_session(req)
-        req.headers = {
-            "x-hub-signature-256": "sha256=1234%s"
-            % hmac.new(
-                self.broker.webhook_secret.encode(), req.data, hashlib.sha256,
-            ).hexdigest()
-        }
-        http._request_stack.push(HttpRequest(req))
-        with self.broker.work_on(self.broker._name) as work:
-            work.component(usage=self.broker.broker_type).post_update(
-                self.webhook, **self.message_01
-            )
-        http._request_stack.pop()
-        self.assertFalse(
-            self.env["mail.broker.channel"].search([("broker_id", "=", self.broker.id)])
-        )
-
-    def test_compose(self):
-        self.broker.webhook_key = self.webhook
-        self.broker.set_webhook()
-        self.integrate_webhook()
-        composer = self.env["whatsapp.composer"].create(
-            {
-                "res_model": self.partner._name,
-                "res_id": self.partner.id,
-                "number_field_name": "mobile",
-            }
-        )
-        composer.action_view_whatsapp()
-        channel = self.env["mail.broker.channel"].search(
-            [("broker_id", "=", self.broker.id)]
-        )
-        self.assertTrue(channel)
-        self.assertFalse(channel.message_ids)
-        with self.assertRaises(UserError):
-            composer.action_send_whatsapp()
-        composer.body = "DEMO"
-        with patch("requests.post") as post_mock:
-            post_mock.return_value = MagicMock()
-            composer.action_send_whatsapp()
-            post_mock.assert_called()
-        channel.refresh()
-        self.assertTrue(channel.message_ids)

mail_gateway_whatsapp/tests/test_mail_gateway_whatsapp.py

@@ -0,0 +1,308 @@
+# Copyright 2022 CreuBlanca
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import hashlib
+import hmac
+import json
+from unittest.mock import MagicMock, patch
+
+from odoo.exceptions import UserError
+from odoo.tests.common import tagged
+from odoo.tools import mute_logger
+
+from odoo.addons.mail_gateway.tests.common import MailGatewayTestCase
+
+
+@tagged("-at_install", "post_install")
+class TestMailGatewayTelegram(MailGatewayTestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.webhook = "demo_hook"
+        cls.gateway = cls.env["mail.gateway"].create(
+            {
+                "name": "gateway",
+                "gateway_type": "whatsapp",
+                "token": "token",
+                "whatsapp_security_key": "key",
+                "webhook_secret": "MY-SECRET",
+            }
+        )
+        cls.partner = cls.env["res.partner"].create(
+            {"name": "Partner", "mobile": "+34 600 000 000"}
+        )
+        cls.password = "my_new_password"
+        cls.message_01 = {
+            "object": "whatsapp_business_account",
+            "entry": [
+                {
+                    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
+                    "changes": [
+                        {
+                            "value": {
+                                "messaging_product": "whatsapp",
+                                "metadata": {
+                                    "display_phone_number": "1234",
+                                    "phone_number_id": "34699999999",
+                                },
+                                "contacts": [
+                                    {
+                                        "profile": {"name": "NAME"},
+                                        "wa_id": "34699999999",
+                                    }
+                                ],
+                                "messages": [
+                                    {
+                                        "from": "34699999999",
+                                        "id": "wamid.ID",
+                                        "timestamp": "1234",
+                                        "text": {"body": "MESSAGE_BODY"},
+                                        "type": "text",
+                                    }
+                                ],
+                            },
+                            "field": "messages",
+                        }
+                    ],
+                }
+            ],
+        }
+        cls.message_02 = {
+            "object": "whatsapp_business_account",
+            "entry": [
+                {
+                    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
+                    "changes": [
+                        {
+                            "value": {
+                                "messaging_product": "whatsapp",
+                                "metadata": {
+                                    "display_phone_number": "1234",
+                                    "phone_number_id": "1234",
+                                },
+                                "contacts": [
+                                    {"profile": {"name": "NAME"}, "wa_id": "1234"}
+                                ],
+                                "messages": [
+                                    {
+                                        "from": "1234",
+                                        "id": "wamid.ID",
+                                        "timestamp": "1234",
+                                        "type": "image",
+                                        "image": {
+                                            "caption": "CAPTION",
+                                            "mime_type": "image/jpeg",
+                                            "sha256": "IMAGE_HASH",
+                                            "id": "12356",
+                                        },
+                                    }
+                                ],
+                            },
+                            "field": "messages",
+                        }
+                    ],
+                }
+            ],
+        }
+
+    def test_webhook_management(self):
+        self.gateway.webhook_key = self.webhook
+        self.assertTrue(self.gateway.can_set_webhook)
+        self.gateway.set_webhook()
+        self.assertEqual(self.gateway.integrated_webhook_state, "pending")
+        self.gateway.remove_webhook()
+        self.assertFalse(self.gateway.integrated_webhook_state)
+        self.gateway.set_webhook()
+        self.assertEqual(self.gateway.integrated_webhook_state, "pending")
+        self.url_open(
+            "/gateway/{}/{}/update?hub.verify_token={}&hub.challenge={}".format(
+                self.gateway.gateway_type,
+                self.webhook,
+                self.gateway.whatsapp_security_key + "12",
+                "22",
+            ),
+        )
+        self.assertEqual(self.gateway.integrated_webhook_state, "pending")
+        self.integrate_webhook()
+        self.assertEqual(self.gateway.integrated_webhook_state, "integrated")
+        self.gateway.remove_webhook()
+        self.assertFalse(self.gateway.integrated_webhook_state)
+
+    def integrate_webhook(self):
+        self.url_open(
+            "/gateway/{}/{}/update?hub.verify_token={}&hub.challenge={}".format(
+                self.gateway.gateway_type,
+                self.webhook,
+                self.gateway.whatsapp_security_key,
+                "22",
+            ),
+        )
+
+    def set_message(self, message, webhook, headers=True):
+        data = json.dumps(message)
+        headers_dict = {"Content-Type": "application/json"}
+        if headers:
+            headers_dict["x-hub-signature-256"] = (
+                "sha256=%s"
+                % hmac.new(
+                    self.gateway.webhook_secret.encode(),
+                    data.encode(),
+                    hashlib.sha256,
+                ).hexdigest()
+            )
+        self.url_open(
+            "/gateway/{}/{}/update".format(self.gateway.gateway_type, webhook),
+            data=data,
+            headers=headers_dict,
+        )
+
+    def receive_message(self, message):
+        self.gateway.webhook_key = self.webhook
+        self.gateway.set_webhook()
+        self.integrate_webhook()
+        self.set_message(message, self.webhook)
+        chat = self.env["mail.channel"].search([("gateway_id", "=", self.gateway.id)])
+        self.assertTrue(chat)
+        self.assertTrue(chat.message_ids)
+        return chat.message_ids
+
+    def test_receive_message_01(self):
+        message = self.receive_message(self.message_01)
+        self.assertFalse(message.author_id)
+
+    def test_receive_message_02(self):
+        # Check that the partner is assigned automatically
+        partner = self.env["res.partner"].create(
+            {"name": "DEMO", "phone": "+34699999999"}
+        )
+        message = self.receive_message(self.message_01)
+        self.assertEqual(message.author_id, partner)
+
+    def test_receive_message_03(self):
+        class GetImageResponse:
+            def raise_for_status(self):
+                pass
+
+            def json(self):
+                return {"url": "http://demo.url", "mime_type": "image/png"}
+
+            content = b"binary_data"
+
+        with patch("requests.get") as get_mock:
+            get_mock.return_value = GetImageResponse()
+            self.receive_message(self.message_02)
+
+    def test_post_no_signature_no_message(self):
+        self.gateway.webhook_key = self.webhook
+        self.gateway.set_webhook()
+        self.integrate_webhook()
+        self.set_message(self.message_01, self.webhook, False)
+        self.assertFalse(
+            self.env["mail.channel"].search([("gateway_id", "=", self.gateway.id)])
+        )
+
+    def test_post_wrong_signature_no_message(self):
+        self.gateway.webhook_key = self.webhook
+        self.gateway.set_webhook()
+        self.integrate_webhook()
+        data = json.dumps(self.message_01)
+        headers = {
+            "Content-Type": "application/json",
+            "x-hub-signature-256": (
+                "sha256=1234%s"
+                % hmac.new(
+                    self.gateway.webhook_secret.encode(),
+                    data.encode(),
+                    hashlib.sha256,
+                ).hexdigest()
+            ),
+        }
+        self.url_open(
+            "/gateway/{}/{}/update".format(self.gateway.gateway_type, self.webhook),
+            data=data,
+            headers=headers,
+        )
+        self.assertFalse(
+            self.env["mail.channel"].search([("gateway_id", "=", self.gateway.id)])
+        )
+
+    def test_send_image(self):
+        self.gateway.webhook_key = self.webhook
+        self.gateway.set_webhook()
+        self.integrate_webhook()
+        composer = self.env["whatsapp.composer"].create(
+            {
+                "res_model": self.partner._name,
+                "res_id": self.partner.id,
+                "number_field_name": "mobile",
+                "gateway_id": self.gateway.id,
+            }
+        )
+        composer.action_view_whatsapp()
+        channel = self.env["mail.channel"].search(
+            [("gateway_id", "=", self.gateway.id)]
+        )
+
+        with patch("requests.post") as post_mock:
+            post_mock.return_value = MagicMock()
+            channel.message_post(
+                attachments=[("demo.png", b"IMAGE")],
+                subtype_xmlid="mail.mt_comment",
+                message_type="comment",
+            )
+            post_mock.assert_called()
+            self.assertEqual(post_mock.call_count, 2)
+
+    def test_send_document_error(self):
+        self.gateway.webhook_key = self.webhook
+        self.gateway.set_webhook()
+        self.integrate_webhook()
+        composer = self.env["whatsapp.composer"].create(
+            {
+                "res_model": self.partner._name,
+                "res_id": self.partner.id,
+                "number_field_name": "mobile",
+                "gateway_id": self.gateway.id,
+            }
+        )
+        composer.action_view_whatsapp()
+        channel = self.env["mail.channel"].search(
+            [("gateway_id", "=", self.gateway.id)]
+        )
+        with mute_logger(
+            "odoo.addons.mail_gateway_whatsapp.models.mail_gateway_whatsapp"
+        ):
+            message = channel.message_post(
+                attachments=[("demo.xml", b"IMAGE")],
+                subtype_xmlid="mail.mt_comment",
+                message_type="comment",
+            )
+        self.assertEqual(message.notification_ids.notification_status, "exception")
+
+    def test_compose(self):
+        self.gateway.webhook_key = self.webhook
+        self.gateway.set_webhook()
+        self.integrate_webhook()
+        composer = self.env["whatsapp.composer"].create(
+            {
+                "res_model": self.partner._name,
+                "res_id": self.partner.id,
+                "number_field_name": "mobile",
+                "gateway_id": self.gateway.id,
+            }
+        )
+        composer.action_view_whatsapp()
+        channel = self.env["mail.channel"].search(
+            [("gateway_id", "=", self.gateway.id)]
+        )
+        self.assertTrue(channel)
+        self.assertFalse(channel.message_ids)
+        with self.assertRaises(UserError):
+            composer.action_send_whatsapp()
+        composer.body = "DEMO"
+        with patch("requests.post") as post_mock:
+            post_mock.return_value = MagicMock()
+            composer.action_send_whatsapp()
+            post_mock.assert_called()
+        channel.invalidate_recordset()
+        self.assertTrue(channel.message_ids)

mail_gateway_whatsapp/views/mail_broker.xml

@@ -1,26 +0,0 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!-- Copyright 2022 Creu Blanca
-     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
-<odoo>
-    <record model="ir.ui.view" id="mail_broker_form_view">
-        <field name="name">mail.broker.form (in mail_broker_telegram)</field>
-        <field name="model">mail.broker</field>
-        <field name="inherit_id" ref="mail_broker.mail_broker_form_view" />
-        <field name="arch" type="xml">
-            <field name="webhook_user_id" position="after">
-                <field
-                    name="whatsapp_security_key"
-                    attrs="{'invisible': [('broker_type', '!=', 'whatsapp')]}"
-                />
-                <field
-                    name="whatsapp_from_phone"
-                    attrs="{'invisible': [('broker_type', '!=', 'whatsapp')]}"
-                />
-                <field
-                    name="whatsapp_version"
-                    attrs="{'invisible': [('broker_type', '!=', 'whatsapp')]}"
-                />
-            </field>
-        </field>
-    </record>
-</odoo>

mail_gateway_whatsapp/views/mail_gateway.xml

@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2022 Creu Blanca
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo>
+    <record model="ir.ui.view" id="mail_gateway_form_view">
+        <field name="name">mail.gateway.form (in mail_gateway_telegram)</field>
+        <field name="model">mail.gateway</field>
+        <field name="inherit_id" ref="mail_gateway.mail_gateway_form_view" />
+        <field name="arch" type="xml">
+            <field name="webhook_user_id" position="after">
+                <field
+                    name="whatsapp_security_key"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                />
+                <field
+                    name="whatsapp_from_phone"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                />
+                <field
+                    name="whatsapp_version"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                />
+            </field>
+            <notebook position="inside">
+                <page
+                    name="whatsapp"
+                    string="Whatsapp configuration info"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                >
+                    <div>
+                        <h2>First steps</h2>
+                        <span>Define the values of the fields <b>Webhook Key</b> and <b
+                            >Whatsapp Security Key</b>.
+                            You should set some random value of your choice for this fields.
+                            Ensure that facebook will be able to comunicate with your server.</span>
+                        <h2>Creating the Application from meta developer</h2>
+                        <ol>
+                            <li>Access
+                                <a
+                                    href="https://developers.facebook.com/apps/?show_reminder=true"
+                                    target="_blank"
+                                    rel="noopener noreferrer"
+                                >
+                                    Meta developer platform</a>.</li>
+                            <li>Create a new application.</li>
+                            <li>Select the <b>Other</b> option, then <b
+                                >Business</b> in order to create Whatsapp manager</li>
+                            <li>Select a name and create it</li>
+                            <li
+                            >Select the Whatsapp API on the products of the application</li>
+                            <li>Select the business that you will use</li>
+                            <li>Go to <b>Whatsapp / API Configuration</b> menú.</li>
+                            <li>Add a new number.</li>
+                            <li>Copy the phone identification number to the field <b
+                                >Whastapp From phone</b> field.</li>
+                                <li>Access the menu <b
+                                >Configuration / Basic information</b>.</li>
+                                <li
+                            >Show the secret key of the application and copy it to the <b
+                                >Webhook secret</b> field.</li>
+                                <li>Access the menu <b
+                                >Configuration / Advanced Options</b>.</li>
+                                <li>Copy the API Version on the <b
+                                >Whastapp Version</b> field.</li>
+                        </ol>
+                        <h2>Creating a permanent token</h2>
+                        <ol>
+                            <li>Access your <a
+                                    href="https://business.facebook.com/"
+                                    target="_blank"
+                                    rel="noopener noreferrer"
+                                >meta business site.</a></li>
+                            <li>Access your business settings menu</li>
+                            <li>Go to <b
+                                >Users / System Users</b> and create a new one with administrator</li>
+                            <li
+                            >Once it is created, Generate a new token related to the created app with no expiry and give access to all whatsapp permissions.</li>
+                            <li>Copy the token value to token field in this page.</li>
+                        </ol>
+                        <h2>Setting webhook and version</h2>
+                        <ol>
+                            <li>Save this record. All the values have been filled</li>
+                            <li>Press the button Integrate webhook.</li>
+                            <li
+                            >On Facebook Develpment, return to the app menu and go to <b
+                                >Whatsapp / Configuration</b>.</li>
+                            <li>Click on <b>Edit Button</b> on the webhook area.</li>
+                            <li>On the wizard, fill the URL field with <b
+                                >Webhook URL</b> field of the gateway. For the verification identifier, use the <b
+                                >Whatsapp Security Key</b> field.</li>
+                            <li>Verify and save the wizard.</li>
+                            <li
+                            >If no error is raised, refresh this gateway data, and you should see that it is integrated.
+                                You should be able to receive and send messages.
+                                If an error is raised, check that the fields are filled properly and that facebook server is able to access your server.</li>
+                        </ol>
+                    </div>
+
+                </page>
+            </notebook>
+        </field>
+    </record>
+</odoo>

mail_gateway_whatsapp/wizards/whatsapp_composer.py

@@ -8,44 +8,46 @@ from odoo.exceptions import UserError
 class WhatsappComposer(models.TransientModel):
 
     _name = "whatsapp.composer"
+    _description = "Compose a whatsapp message"
 
     res_model = fields.Char("Document Model Name")
     res_id = fields.Integer("Document ID")
     number_field_name = fields.Char()
-    find_broker = fields.Boolean()
-    broker_id = fields.Many2one(
-        "mail.broker", domain=[("broker_type", "=", "whatsapp")], required=True
+    find_gateway = fields.Boolean()
+    gateway_id = fields.Many2one(
+        "mail.gateway", domain=[("gateway_type", "=", "whatsapp")], required=True
     )
     body = fields.Text("Message")
 
     @api.model
     def default_get(self, fields):
         result = super().default_get(fields)
-        brokers = self.env["mail.broker"].search([("broker_type", "=", "whatsapp")])
-        result["find_broker"] = len(brokers) != 1
-        if not result["find_broker"]:
-            result["broker_id"] = brokers.id
+        gateways = self.env["mail.gateway"].search([("gateway_type", "=", "whatsapp")])
+        result["find_gateway"] = len(gateways) != 1
+        if not result["find_gateway"]:
+            result["gateway_id"] = gateways.id
         return result
 
     def _action_send_whatsapp(self):
         record = self.env[self.res_model].browse(self.res_id)
         if not record:
             return
-        channel = record._whatsapp_get_channel(self.number_field_name, self.broker_id)
-        channel.broker_message_post(body=self.body)
+        channel = record._whatsapp_get_channel(self.number_field_name, self.gateway_id)
+        channel.message_post(
+            body=self.body, subtype_xmlid="mail.mt_comment", message_type="comment"
+        )
 
     def action_view_whatsapp(self):
         self.ensure_one()
         record = self.env[self.res_model].browse(self.res_id)
         if not record:
             return
-        channel = record._whatsapp_get_channel(self.number_field_name, self.broker_id)
+        channel = record._whatsapp_get_channel(self.number_field_name, self.gateway_id)
         if channel:
             return {
                 "type": "ir.actions.client",
-                "tag": "mail.broker",
-                "res_model": channel._name,
-                "context": {"active_id": "broker_thread_%s" % channel.id},
+                "tag": "mail.action_discuss",
+                "params": {"active_id": "{}_{}".format(channel._name, channel.id)},
             }
         return False
 

mail_gateway_whatsapp/wizards/whatsapp_composer.xml

@@ -4,16 +4,16 @@
 <odoo>
 
     <record model="ir.ui.view" id="whatsapp_composer_form_view">
-        <field name="name">whatsapp.composer.form (in mail_broker_whatsapp)</field>
+        <field name="name">whatsapp.composer.form (in mail_gateway_whatsapp)</field>
         <field name="model">whatsapp.composer</field>
         <field name="arch" type="xml">
             <form string="Whatsapp Composer">
                 <group>
                     <field
-                        name="broker_id"
-                        attrs="{'invisible': [('find_broker', '=', False)]}"
+                        name="gateway_id"
+                        attrs="{'invisible': [('find_gateway', '=', False)]}"
                     />
-                    <field name="find_broker" invisible="1" />
+                    <field name="find_gateway" invisible="1" />
                     <field name="res_model" invisible="1" />
                     <field name="res_id" invisible="1" />
                     <field name="number_field_name" invisible="1" />
@@ -29,7 +29,7 @@
                     />
                     <button
                         name="action_view_whatsapp"
-                        string="Show log"
+                        string="Show Chat"
                         type="object"
                     />
                     <button string="Cancel" class="btn-default" special="cancel" />

requirements.txt

@@ -5,3 +5,4 @@ extract_msg
 lottie
 premailer
 python-telegram-bot
+requests_toolbelt

setup/mail_gateway_whatsapp/odoo/addons/mail_gateway_whatsapp

@@ -0,0 +1 @@
+../../../../mail_gateway_whatsapp

setup/mail_gateway_whatsapp/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)