slidge-whatsapp 0.2.2__cp313-cp313-manylinux_2_36_aarch64.whl

slidge_whatsapp/__init__.py

@@ -0,0 +1,17 @@
+"""
+WhatsApp gateway using the multi-device API.
+"""
+
+from slidge import entrypoint
+from slidge.util.util import get_version  # noqa: F401
+
+from . import command, config, contact, group, session
+from .gateway import Gateway
+
+
+def main():
+    entrypoint("slidge_whatsapp")
+
+
+__version__ = "v0.2.2"
+__all__ = "Gateway", "session", "command", "contact", "config", "group", "main"

slidge_whatsapp/__main__.py

@@ -0,0 +1,3 @@
+from slidge_whatsapp import main
+
+main()

slidge_whatsapp/command.py

@@ -0,0 +1,143 @@
+from typing import TYPE_CHECKING, Optional
+
+from slidge.command import Command, CommandAccess, Form, FormField
+from slidge.util import is_valid_phone_number
+from slixmpp import JID
+from slixmpp.exceptions import XMPPError
+
+from .generated import whatsapp
+
+if TYPE_CHECKING:
+    from .session import Session
+
+
+class Logout(Command):
+    NAME = "🔓 Disconnect from WhatsApp"
+    HELP = (
+        "Disconnects active WhatsApp session without removing any linked device credentials. "
+        "To re-connect, use the 're-login' command."
+    )
+    NODE = "wa_logout"
+    CHAT_COMMAND = "logout"
+    ACCESS = CommandAccess.USER_LOGGED
+
+    async def run(
+        self,
+        session: Optional["Session"],  # type:ignore
+        ifrom: JID,
+        *args,
+    ) -> str:
+        assert session is not None
+        try:
+            session.shutdown()
+        except Exception as e:
+            session.send_gateway_status(f"Logout failed: {e}", show="dnd")
+            raise XMPPError(
+                "internal-server-error",
+                etype="wait",
+                text=f"Could not logout WhatsApp session: {e}",
+            )
+        session.send_gateway_status("Logged out", show="away")
+        return "Logged out successfully"
+
+
+class PairPhone(Command):
+    NAME = "📱 Complete registration via phone number"
+    HELP = (
+        "As an alternative to QR code verification, this allows you to complete registration "
+        "by inputing a one-time code into the official WhatsApp client; this requires that you "
+        "provide the phone number used for the main device, in international format "
+        "(e.g. +447700900000). See more information here: https://faq.whatsapp.com/1324084875126592"
+    )
+    NODE = "wa_pair_phone"
+    CHAT_COMMAND = "pair-phone"
+    ACCESS = CommandAccess.USER_NON_LOGGED
+
+    async def run(
+        self,
+        session: Optional["Session"],  # type:ignore
+        ifrom: JID,
+        *args,
+    ) -> Form:
+        return Form(
+            title="Pair to WhatsApp via phone number",
+            instructions="Enter your phone number in international format (e.g. +447700900000)",
+            fields=[FormField(var="phone", label="Phone number", required=True)],
+            handler=self.finish,  # type:ignore
+        )
+
+    @staticmethod
+    async def finish(form_values: dict, session: "Session", _ifrom: JID):
+        p = form_values.get("phone")
+        if not is_valid_phone_number(p):
+            raise ValueError("Not a valid phone number", p)
+        code = session.whatsapp.PairPhone(p)
+        return f"Please open the official WhatsApp client and input the following code: {code}"
+
+
+class ChangePresence(Command):
+    NAME = "📴 Set WhatsApp web presence"
+    HELP = (
+        "If you want to receive notifications in the WhatsApp official client,"
+        "you need to set your presence to unavailable. As a side effect, you "
+        "won't receive receipts and presences from your contacts."
+    )
+    NODE = "wa_presence"
+    CHAT_COMMAND = "presence"
+    ACCESS = CommandAccess.USER_LOGGED
+
+    async def run(
+        self,
+        session: Optional["Session"],  # type:ignore
+        ifrom: JID,
+        *args,
+    ) -> Form:
+        return Form(
+            title="Set WhatsApp web presence",
+            instructions="Choose what type of presence you want to set",
+            fields=[
+                FormField(
+                    var="presence",
+                    value="available",
+                    type="list-single",
+                    options=[
+                        {"label": "Available", "value": "available"},
+                        {"label": "Unavailable", "value": "unavailable"},
+                    ],
+                )
+            ],
+            handler=self.finish,  # type:ignore
+        )
+
+    @staticmethod
+    async def finish(form_values: dict, session: "Session", _ifrom: JID):
+        p = form_values.get("presence")
+        if p == "available":
+            session.whatsapp.SendPresence(whatsapp.PresenceAvailable, "")
+        elif p == "unavailable":
+            session.whatsapp.SendPresence(whatsapp.PresenceUnavailable, "")
+        else:
+            raise ValueError("Not a valid presence kind.", p)
+        return f"Presence succesfully set to {p}"
+
+
+class SubscribeToPresences(Command):
+    NAME = "🔔 Subscribe to contacts' presences"
+    HELP = (
+        "Subscribes to and refreshes contacts' presences; typically this is "
+        "done automatically, but re-subscribing might be useful in case contact "
+        "presences are stuck or otherwise not updating."
+    )
+    NODE = "wa_subscribe"
+    CHAT_COMMAND = "subscribe"
+    ACCESS = CommandAccess.USER_LOGGED
+
+    async def run(
+        self,
+        session: Optional["Session"],  # type:ignore
+        ifrom: JID,
+        *args,
+    ) -> str:
+        assert session is not None
+        session.whatsapp.GetContacts(False)
+        return "Looks like no exception was raised. Success, I guess?"

slidge_whatsapp/config.py

@@ -0,0 +1,32 @@
+"""
+Config contains plugin-specific configuration for WhatsApp, and is loaded automatically by the
+core configuration framework.
+"""
+
+from pathlib import Path
+from typing import Optional
+
+from slidge import global_config
+
+# workaround because global_config.HOME_DIR is not defined unless
+# called by slidge's main(), which is a problem for tests, docs and the
+# dedicated slidge-whatsapp setuptools entrypoint
+try:
+    DB_PATH: Optional[Path] = global_config.HOME_DIR / "whatsapp" / "whatsapp.db"
+except AttributeError:
+    DB_PATH: Optional[Path] = None  # type:ignore
+
+DB_PATH__DOC = (
+    "The path to the database used for the WhatsApp plugin. Default to "
+    "${SLIDGE_HOME_DIR}/whatsapp/whatsapp.db"
+)
+
+ALWAYS_SYNC_ROSTER = False
+ALWAYS_SYNC_ROSTER__DOC = (
+    "Whether or not to perform a full sync of the WhatsApp roster on startup."
+)
+
+ENABLE_LINK_PREVIEWS = True
+ENABLE_LINK_PREVIEWS__DOC = (
+    "Whether or not previews for links (URLs) should be generated on outgoing messages"
+)

slidge_whatsapp/contact.py

@@ -0,0 +1,77 @@
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING
+
+from slidge import LegacyContact, LegacyRoster
+from slixmpp.exceptions import XMPPError
+
+from . import config
+from .generated import whatsapp
+
+if TYPE_CHECKING:
+    from .session import Session
+
+
+class Contact(LegacyContact[str]):
+    CORRECTION = True
+    REACTIONS_SINGLE_EMOJI = True
+
+    async def update_presence(
+        self, presence: whatsapp.PresenceKind, last_seen_timestamp: int
+    ):
+        last_seen = (
+            datetime.fromtimestamp(last_seen_timestamp, tz=timezone.utc)
+            if last_seen_timestamp > 0
+            else None
+        )
+        if presence == whatsapp.PresenceUnavailable:
+            self.away(last_seen=last_seen)
+        else:
+            self.online(last_seen=last_seen)
+
+
+class Roster(LegacyRoster[str, Contact]):
+    session: "Session"
+
+    async def fill(self):
+        """
+        Retrieve contacts from remote WhatsApp service, subscribing to their presence and adding to
+        local roster.
+        """
+        contacts = self.session.whatsapp.GetContacts(refresh=config.ALWAYS_SYNC_ROSTER)
+        for contact in contacts:
+            c = await self.add_whatsapp_contact(contact)
+            if c is not None:
+                yield c
+
+    async def add_whatsapp_contact(self, data: whatsapp.Contact) -> Contact | None:
+        """
+        Adds a WhatsApp contact to local roster, filling all required and optional information.
+        """
+        # Don't attempt to add ourselves to the roster.
+        if data.JID == self.user_legacy_id:
+            return None
+        contact = await self.by_legacy_id(data.JID)
+        contact.name = data.Name
+        contact.is_friend = True
+        try:
+            avatar = self.session.whatsapp.GetAvatar(data.JID, contact.avatar or "")
+            if avatar.URL and contact.avatar != avatar.ID:
+                await contact.set_avatar(avatar.URL, avatar.ID)
+            elif avatar.URL == "":
+                await contact.set_avatar(None)
+        except RuntimeError as err:
+            self.session.log.error(
+                "Failed getting avatar for contact %s: %s", data.JID, err
+            )
+        contact.set_vcard(full_name=contact.name, phone=str(contact.jid.local))
+        return contact
+
+    async def legacy_id_to_jid_username(self, legacy_id: str) -> str:
+        return "+" + legacy_id[: legacy_id.find("@")]
+
+    async def jid_username_to_legacy_id(self, jid_username: str) -> str:
+        if jid_username.startswith("#"):
+            raise XMPPError("item-not-found", "Invalid contact ID: group ID given")
+        if not jid_username.startswith("+"):
+            raise XMPPError("item-not-found", "Invalid contact ID, expected '+' prefix")
+        return jid_username.removeprefix("+") + "@" + whatsapp.DefaultUserServer