slidge-whatsapp 0.3.0b0__tar.gz → 0.3.1__tar.gz

slidge_whatsapp-0.3.1/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: slidge-whatsapp
+Version: 0.3.1
+Summary: A WhatsApp/XMPP gateway
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE
+Keywords: xmpp,gateway,bridge,instant messaging,chat,whatsapp
+Author: deuill
+Author-email: alex@deuill.org
+Requires-Python: >= 3.11
+Classifier: Topic :: Internet :: XMPP
+Requires-Dist: linkpreview (>=0.11.0)
+Requires-Dist: slidge (>=0.3.0beta2,<0.4)
+Project-URL: Chat room, https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr
+Project-URL: Documentation, https://slidge.im/docs/slidge-whatsapp/main
+Project-URL: Homepage, https://codeberg.org/slidge/slidge-whatsapp
+Project-URL: Issues, https://codeberg.org/slidge/slidge-whatsapp/issues
+Project-URL: Repository, https://codeberg.org/slidge/slidge-whatsapp
+Project-URL: changelog, https://codeberg.org/slidge/slidge-whatsapp/releases
+Description-Content-Type: text/markdown
+
+# slidge-whatsapp
+
+A
+[feature-rich](https://slidge.im/docs/slidge-whatsapp/main/user/features.html)
+[WhatsApp](https://whatsapp.com) to
+[XMPP](https://xmpp.org/) puppeteering
+[gateway](https://xmpp.org/extensions/xep-0100.html), based on
+[slidge](https://slidge.im) and
+[whatsmeow](https://github.com/tulir/whatsmeow).
+
+[![CI pipeline status](https://ci.codeberg.org/api/badges/14066/status.svg)](https://ci.codeberg.org/repos/14066)
+[![Chat](https://conference.nicoco.fr:5281/muc_badge/slidge@conference.nicoco.fr)](https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr)
+[![PyPI package version](https://badge.fury.io/py/slidge-whatsapp.svg)](https://pypi.org/project/slidge-whatsapp/)
+
+
+
+
+slidge-whatsapp lets you chat with users of WhatsApp without leaving your favorite XMPP client.
+
+## Quickstart
+
+```sh
+docker run codeberg.org/slidge/slidge-whatsapp \  # works with podman too
+    --jid whatsapp.example.org \  # can be whatever you want it to be
+    --secret some-secret \  # must match your XMPP server config
+    --home-dir /somewhere/writeable  # for data persistence
+```
+
+Use the `:latest-amd64` tag for the latest release, `:vX.X.X-amd64` for release X.X.X, and `:main-amd64`
+for the bleeding edge.`-arm64` images are also available.
+
+If you do not like containers, other installation methods are detailed
+[in the docs](https://slidge.im/docs/slidge-whatsapp/main/admin/install.html).
+
+## Documentation
+
+Hosted on [codeberg pages](https://slidge.im/docs/slidge-whatsapp/main/).
+
+## Contributing
+
+Contributions are **very** welcome, and we tried our best to make it easy
+to start hacking on slidge-whatsapp. See [CONTRIBUTING.md](./CONTRIBUTING.md).
+

slidge_whatsapp-0.3.1/pyproject.toml

@@ -0,0 +1,178 @@
+# DO NOT EDIT
+# This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
+[project]
+name = "slidge-whatsapp"
+description = "A WhatsApp/XMPP gateway"
+authors = [
+    {name = "deuill", email = "alex@deuill.org"},
+    {name = "nicoco", email = "nicoco@nicoco.fr"},
+]
+readme = "README.md"
+license = "AGPL-3.0-or-later"
+classifiers = [
+    "Topic :: Internet :: XMPP",
+]
+requires-python = ">= 3.11"
+keywords = ["xmpp", "gateway", "bridge", "instant messaging", "chat", "whatsapp"]
+dynamic = []
+dependencies = [
+    "linkpreview>=0.11.0",
+    "slidge>=0.3.0beta2,<0.4",
+]
+version = "0.3.1"
+
+[project.urls]
+Homepage = "https://codeberg.org/slidge/slidge-whatsapp"
+Issues = "https://codeberg.org/slidge/slidge-whatsapp/issues"
+Repository = "https://codeberg.org/slidge/slidge-whatsapp"
+"Chat room" = "https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr"
+Documentation = "https://slidge.im/docs/slidge-whatsapp/main"
+changelog = "https://codeberg.org/slidge/slidge-whatsapp/releases"
+
+[project.scripts]
+slidge-whatsapp = "slidge_whatsapp:main"
+
+[dependency-groups]
+dev = [
+    "furo>=2024.8.6",
+    "mypy>=1.14.1",
+    "pytest>=8.3.4",
+    "pytest-asyncio>=0.25.3",
+    "ruff>=0.9.1",
+    "slidge-sphinx-extensions>=0.1.0",
+    "sphinx-autoapi>=3.4.0",
+    "sphinx-mdinclude>=0.6.2",
+    "pybindgen",
+]
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "session"
+
+[tool.poetry]
+
+[[tool.poetry.include]]
+path = "slidge_whatsapp"
+
+[[tool.poetry.include]]
+path = "slidge_whatsapp/generated/*.py"
+format = ["wheel"]
+
+[[tool.poetry.include]]
+path = "slidge_whatsapp/generated/*.so"
+format = ["wheel"]
+
+[tool.poetry.build]
+script = "build.py"
+
+[build-system]
+requires = ["poetry-core", "pybindgen", "packaging", "poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
+
+[tool.poetry.requires-plugins]
+poetry-dynamic-versioning = { version = ">=1.0.0,<2.0.0", extras = ["plugin"] }
+
+[tool.poetry-dynamic-versioning]
+enable = false
+[tool.poetry-dynamic-versioning.substitution]
+files = []
+
+# this should not be any problem and fixes compatibility with pycharm
+# when installing anything (such as slidge core) in editable mode
+[tool.uv]
+config-settings = { editable_mode = "compat" }
+
+[tool.uv.sources]
+slidge-sphinx-extensions = { index = "codeberg" }
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple"
+
+[[tool.uv.index]]
+name = "codeberg"
+url = "https://codeberg.org/api/packages/slidge/pypi/simple"
+publish-url = "https://codeberg.org/api/packages/slidge/pypi"
+
+[tool.mypy]
+files = ["slidge_whatsapp"]
+exclude = [
+    "tests",
+    "slidge_whatsapp/generated",
+]
+check_untyped_defs = true
+strict = false
+
+[[tool.mypy.overrides]]
+module = [
+    "slidge_style_parser.*",
+    "linkpreview",
+    "slidge_whatsapp.generated",
+]
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 88
+exclude = [
+    "tests",
+]
+
+[tool.ruff.lint]
+select = ["I"]
+
+[tool.git-cliff.remote.gitea]
+owner = "slidge"
+repo = "slidge-whatsapp"
+
+[tool.git-cliff.changelog]
+header = """
+<!-- write something cool about the release here! -->
+
+# Changes
+"""
+body = """
+{% for group, all_commits in commits | group_by(attribute="group") %}
+    {%- if group == "cfix" %}{% continue %}{%- endif %}
+    ## {{ group | striptags | trim | upper_first }}
+    {% for commit in all_commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | split(pat="\n") | first | upper_first | trim }} \
+            ([`{{ commit.id | truncate(length=7, end="") }}`](./commit/{{ commit.id -}})\
+            {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
+            {%- for cfix_commit in commits | filter(attribute="group", value="cfix") -%}
+                {%- if cfix_commit.scope and commit.id is starting_with(cfix_commit.scope) -%}
+                    , [`{{ cfix_commit.id | truncate(length=7, end="") }}`](./commit/{{ cfix_commit.id }}){% if cfix_commit.remote.username %} by @{{ cfix_commit.remote.username }}{%- endif -%}
+                {%- endif -%}
+            {%- endfor -%})\
+    {% endfor %}
+{% endfor %}\n
+"""
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[tool.git-cliff.git]
+conventional_commits = true
+filter_unconventional = false
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^imprv", group = "<!-- 01 -->✨ Improvements" },
+  { message = "^fix", group = "<!-- 02 -->🐛 Bug Fixes" },
+  { message = "^compat", group = "<!-- 03 -->💑 Compatibility" },
+  { message = "^refactor", group = "<!-- 04 -->🚜 Refactor" },
+  { message = "^doc", group = "<!-- 05 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 06 -->⚡ Performance" },
+  { message = "^style", group = "<!-- 07 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 08 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^build\\(lockfile\\)", skip = true },
+  { message = "^chore\\(lockfile\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 09 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 10 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 11 -->◀️ Revert" },
+  { message = "^cfix", group = "cfix" },
+  { message = ".*", group = "<!-- 13 -->💼 Other" },
+]

slidge_whatsapp-0.3.1/slidge_whatsapp/contact.py

@@ -0,0 +1,89 @@
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING
+
+from slidge import LegacyContact, LegacyRoster
+from slidge.util.types import Avatar
+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)
+
+    async def update_info(self) -> None:
+        if whatsapp.IsAnonymousJID(self.legacy_id):
+            self.log.error(
+                "Contact for anonymous participant added: %s", self.legacy_id
+            )
+
+
+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:
+            unique_id = ""
+            if contact.avatar is not None:
+                unique_id = contact.avatar.unique_id or ""
+            avatar = self.session.whatsapp.GetAvatar(data.JID, unique_id)
+            if avatar.URL and unique_id != avatar.ID:
+                await contact.set_avatar(Avatar(url=avatar.URL, unique_id=avatar.ID))
+            elif avatar.URL == "" and avatar.ID == "":
+                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:
+        if not "@" in legacy_id:
+            raise XMPPError("item-not-found", "Invalid contact ID, not a JID")
+        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