slidge 0.2.8__tar.gz → 0.2.9__tar.gz

{slidge-0.2.8 → slidge-0.2.9}/.gitignore

@@ -42,3 +42,4 @@ htmlcov
 /dev/slidge.sqlite
 
 .python-version
+slidge/__version__.py

{slidge-0.2.8 → slidge-0.2.9}/.woodpecker/container-ci.yaml

@@ -1,9 +1,12 @@
 # Build a container with a virtualenv that can be used for tests and to build docs.
 
 when:
-  event: [ manual, cron ]
-
-depends_on: [ container-cache ]
+  event: [ push ]
+  branch: main
+  path:
+    - Dockerfile
+    - pyproject.toml
+    - uv.lock
 
 matrix:
   PYTHON_VERSION:
@@ -11,19 +14,20 @@ matrix:
     - "3.12"
     - "3.13"
 
+labels:
+  platform: linux/amd64
+
 steps:
   build-and-push:
     image: woodpeckerci/plugin-docker-buildx
     settings:
-      repo: codeberg.org/${CI_REPO_OWNER}/woodpecker-${CI_REPO_NAME}
+      repo: codeberg.org/slidge/slidge
       registry: codeberg.org
       build_args:
         PYTHONVER: "${PYTHON_VERSION}"
-      tag: ${PYTHON_VERSION}
-      target: woodpecker-${CI_REPO_NAME}
+      tag: ci-${PYTHON_VERSION}
+      target: ci
       username: slidge
       password:
         from_secret: CODEBERG_TOKEN
-      cache_from: codeberg.org/slidge/slidge-builder:buildcache-base-amd64
-      cache_images:
-        - codeberg.org/slidge/woodpecker-slidge:buildcache-${PYTHON_VERSION}
+      cache_from: codeberg.org/slidge/slidge:buildcache

slidge-0.2.9/.woodpecker/docs.yaml

@@ -0,0 +1,22 @@
+when:
+  event: [ push, tag ]
+  path: [ "slidge/**/*.py", "superduper/**/*.py", "docs/**/*" ]
+
+labels:
+  platform: linux/amd64
+
+steps:
+  build:
+    image: codeberg.org/slidge/slidge:ci-3.13
+    pull: true
+    commands:
+      - uv sync --all-groups --all-extras
+      - cd docs
+      - make html
+
+  publish:
+    image: codeberg.org/slidge/woodpecker-publish-pages
+    pull: true
+    settings:
+      token:
+        from_secret: CODEBERG_TOKEN

{slidge-0.2.8 → slidge-0.2.9}/.woodpecker/package.yaml

@@ -1,18 +1,19 @@
 # Build a source dist and a wheel.
 
 when:
-  event: [ push, tag, pull_request ]
+  event: [ push, tag ]
   path: [ "slidge/**/*", "pyproject.toml", "uv.lock", "README.md" ]
+  branch: main
+
+labels:
+  platform: linux/amd64
 
 # We do not need to build several packages for several python versions
 # since slidge is pure python.
 variables:
-  - &image codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:3.13
+  - &image codeberg.org/slidge/slidge:ci-3.13
 
 steps:
-  version:
-    image: codeberg.org/slidge/woodpecker-version
-
   changelog:
     image: codeberg.org/slidge/woodpecker-generate-changelog
     pull: true
@@ -23,8 +24,6 @@ steps:
       - uv build
 
   codeberg-pypi:
-    when:
-      event: [ push, tag ]
     image: *image
     environment:
       CODEBERG_TOKEN:
@@ -34,7 +33,6 @@ steps:
 
   pypi:
     when:
-      branch: main
       event: tag
     image: *image
     environment:
@@ -45,7 +43,6 @@ steps:
 
   codeberg-release:
     when:
-      branch: main
       event: tag
     image: woodpeckerci/plugin-release
     settings:

{slidge-0.2.8 → slidge-0.2.9}/.woodpecker/test.yaml

@@ -8,7 +8,11 @@ matrix:
     - "3.12"
     - "3.13"
 
+labels:
+  platform: linux/amd64
+
 variables:
+  - &ci-image codeberg.org/slidge/slidge:ci-${PYTHON_VERSION}
   - &only-once
     when:
       matrix:
@@ -16,44 +20,39 @@ variables:
       event: push
 
 steps:
-  # This is often a no-op, but since we manually build the woodpecker-slidge:3.x images,
-  # their venv may be out of date, even if uv.lock is not modified.
   update-venv:
-    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    image: *ci-image
     pull: true
     commands:
-      - cp -r /venv .venv
-      - uv venv --allow-existing .venv
-      - uv export > req.txt
-      - uv pip install --requirements req.txt
+      - uv sync --all-groups --all-extras
 
   ruff:
-    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    image: *ci-image
     commands:
       - ruff check
       - ruff format --check
 
   mypy:
-    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    image: *ci-image
     commands:
       - mypy
 
   test:
-    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    image: *ci-image
     commands:
       - coverage run -m pytest tests
       - coverage report | tee coverage.txt
       - coverage html
 
-  badge:
-    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+  coverage-badge:
+    image: *ci-image
     commands:
       - uv pip install pybadges
       - COVERAGE=$(tail -n1 coverage.txt | awk 'NF>1{print $NF}')
       - python -m pybadges --left-text=coverage --right-text=$COVERAGE --right-color=green > htmlcov/coverage.svg || true
     <<: *only-once
 
-  publish:
+  coverage-publish:
     image: codeberg.org/slidge/woodpecker-publish-pages
     pull: true
     settings:

slidge-0.2.9/Dockerfile

@@ -0,0 +1,43 @@
+ARG PYTHONVER=3.13
+ARG DISTRO=bookworm-slim
+
+## Install dependencies in a virtual env
+FROM ghcr.io/astral-sh/uv:python$PYTHONVER-$DISTRO AS builder
+ENV UV_PROJECT_ENVIRONMENT=/venv
+RUN uv venv $UV_PROJECT_ENVIRONMENT
+COPY uv.lock pyproject.toml .
+RUN uv sync --all-groups --all-extras --no-install-project
+
+## CI environment for slidge, where we move /venv to .venv
+FROM ghcr.io/astral-sh/uv:python$PYTHONVER-$DISTRO AS ci
+ENV UV_LINK_MODE=copy
+ENV UV_PROJECT_ENVIRONMENT=/woodpecker/src/codeberg.org/slidge/slidge/.venv
+ENV PATH="$UV_PROJECT_ENVIRONMENT/bin:$PATH"
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends \
+        git \
+        make \
+    && rm -rf /var/lib/apt/lists/*
+COPY --from=builder /root/.cache /root/.cache
+
+## Dev container
+FROM builder AS dev
+ENV PATH="/venv/bin:$PATH"
+ENV PYTHONUNBUFFERED=1
+# libmagic1: to guess mime type from files
+# media-types: to determine file name suffix based on file type
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends \
+        libmagic1 \
+        media-types \
+        shared-mime-info \
+    && rm -rf /var/lib/apt/lists/*
+# prosody certificate for localhost
+COPY --from=codeberg.org/slidge/prosody-slidge-dev:latest \
+  /etc/prosody/certs/localhost.crt \
+  /usr/local/share/ca-certificates/
+RUN update-ca-certificates
+RUN pip install watchdog[watchmedo]
+WORKDIR /io
+COPY ./dev/hot-reload.sh .
+ENTRYPOINT ["./hot-reload.sh"]

slidge-0.2.9/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: slidge
+Version: 0.2.9
+Summary: XMPP bridging framework
+Author-email: Nicolas Cedilnik <nicoco@nicoco.fr>
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://codeberg.org/slidge/
+Project-URL: Issues, https://codeberg.org/slidge/slidge/issues
+Project-URL: Repository, https://codeberg.org/slidge/slidge/
+Project-URL: Chat room, https://conference.nicoco.fr:5281/muc_log/slidge/
+Project-URL: Documentation, https://slidge.im/docs/slidge/main
+Project-URL: changelog, https://codeberg.org/slidge/slidge/releases
+Keywords: xmpp,gateway,bridge,instant messaging
+Classifier: Topic :: Internet :: XMPP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp[speedups]<4,>=3.11.11
+Requires-Dist: alembic<2,>=1.14.0
+Requires-Dist: configargparse<2,>=1.7
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: pillow<12,>=11.0.0
+Requires-Dist: python-magic<0.5,>=0.4.27
+Requires-Dist: qrcode<9,>=8.0
+Requires-Dist: slixmpp<2,>=1.9.0
+Requires-Dist: sqlalchemy<3,>=2
+Requires-Dist: thumbhash>=0.1.2
+Dynamic: license-file
+
+![Slidge logo](https://codeberg.org/slidge/slidge/raw/branch/main/dev/assets/slidge-color-small.png)
+
+[![Chat](https://conference.nicoco.fr:5281/muc_badge/slidge@conference.nicoco.fr)](https://conference.nicoco.fr:5281/muc_log/slidge/)
+
+
+[![woodpecker CI status](https://ci.codeberg.org/api/badges/14027/status.svg)](https://ci.codeberg.org/repos/14027)
+[![coverage](https://slidge.im/coverage/main/coverage.svg)](https://slidge.im/coverage/main)
+
+[![pypi version](https://badge.fury.io/py/slidge.svg)](https://pypi.org/project/slidge/)
+[![debian unstable version](https://badges.debian.net/badges/debian/unstable/python3-slidge/version.svg)](https://packages.debian.org/unstable/python3-slidge)
+
+Slidge is an XMPP (puppeteer) gateway library in python.
+It makes
+[writing gateways to other chat networks](https://slidge.im/docs/slidge/main/dev/tutorial.html)
+(*legacy modules*) as frictionless as possible.
+It supports fancy IM features, such as
+[(emoji) reactions](https://xmpp.org/extensions/xep-0444.html),
+[replies](https://xmpp.org/extensions/xep-0461.html), and
+[retractions](https://xmpp.org/extensions/xep-0424.html).
+The full list of supported XEPs in on [xmpp.org](https://xmpp.org/software/slidge/).
+
+Status
+------
+
+Slidge is **beta**-grade software. It support groups and 1:1 chats.
+Try slidge and give us some
+feedback, through the [MUC](xmpp:slidge@conference.nicoco.fr?join) or the
+[issue tracker](https://codeberg.org/slidge/slidge/issues).
+Don't be shy!
+
+Usage
+-----
+
+A minimal (and fictional!) slidge-powered "legacy module" looks like this:
+
+```python
+from cool_chat_lib import CoolClient
+from slidge import BaseGateway, BaseSession
+from slidge.contact import LegacyContact
+from slidge.group import LegacyMUC
+from slidge.db import GatewayUser
+
+
+class Gateway(BaseGateway):
+    # Various aspects of the gateway component are configured as class
+    # attributes of the concrete Gateway class
+    COMPONENT_NAME = "Gateway to the super duper chat network"
+
+
+class Session(BaseSession):
+    def __init__(self, user: GatewayUser):
+        super().__init__(user)
+        self.legacy_client = CoolClient(
+            login=user.legacy_module_data["username"],
+            password=user.legacy_module_data["password"],
+        )
+
+    async def on_text(self, chat: LegacyContact | LegacyMUC, text: str, **kwargs):
+        """
+        Triggered when the slidge user sends an XMPP message through the gateway
+        """
+        self.legacy_client.send_message(text=text, destination=chat.legacy_id)
+```
+
+There's more in [the tutorial](https://slidge.im/docs/slidge/main/dev/tutorial.html)!
+
+Installation
+------------
+
+⚠️  Slidge is a lib for gateway developers, if you are an XMPP server admin and
+want to install gateways on your server, you are looking for a
+[slidge-based gateway](https://codeberg.org/explore/repos?q=slidge&topic=1).
+or the
+[slidge-debian](https://git.sr.ht/~nicoco/slidge-debian)
+bundle.
+
+Slidge is available on
+[codeberg](https://codeberg.org/slidge/-/packages) (python packages and containers)
+and [pypi](https://pypi.org/project/slidge/).
+Refer to [the docs](https://slidge.im/docs/slidge/main/admin/install.html) for details.
+
+About privacy
+-------------
+
+Slidge (and most if not all XMPP gateway that I know of) will break
+end-to-end encryption, or more precisely one of the 'ends' become the
+gateway itself. If privacy is a major concern for you, my advice would
+be to:
+
+-   use XMPP + OMEMO
+-   self-host your gateways
+-   have your gateways hosted by someone you know AFK and trust
+
+Related projects
+----------------
+
+-   [Spectrum](https://www.spectrum.im/)
+-   [telegabber](https://dev.narayana.im/narayana/telegabber)
+-   [biboumi](https://biboumi.louiz.org/)
+-   [Bifröst](https://github.com/matrix-org/matrix-bifrost)
+-   [Mautrix](https://github.com/mautrix)
+-   [matterbridge](https://github.com/42wim/matterbridge)
+
+Thank you, [Trung](https://trung.fun/), for the slidge logo!

slidge-0.2.9/dev/confs/slidge-dev.ini

@@ -0,0 +1,8 @@
+legacy-module=superduper
+jid=slidge.localhost
+secret=secret
+server=localhost
+upload-service=upload.localhost
+admins=test@localhost
+debug=true
+dev-mode=true

slidge-0.2.9/dev/hot-reload.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+watchmedo auto-restart \
+  --pattern *.py \
+  --directory /io/superduper \
+  --directory /io/slidge \
+  --recursive \
+  python -- -m slidge -c /etc/slidge/slidge.ini

slidge-0.2.9/docker-compose.yml

@@ -0,0 +1,20 @@
+services:
+  superduper:
+    build:
+      context: .
+      target: dev
+    network_mode: service:prosody
+    volumes:
+      - ./slidge:/io/slidge
+      - ./superduper:/io/superduper
+      - ./dev/assets:/io/superduper/assets
+      - ./persistent:/var/lib/slidge/slidge.localhost
+      - ./dev/confs/slidge-dev.ini:/etc/slidge/slidge.ini
+    depends_on:
+      - prosody
+
+  prosody:
+    image: codeberg.org/slidge/prosody-slidge-dev:latest
+    ports:
+      - "127.0.0.1:5281:5281"  # prosody's https://...
+      - "127.0.0.1:5222:5222"  # XMPP

{slidge-0.2.8 → slidge-0.2.9}/docs/source/admin/attachments.rst

@@ -88,7 +88,7 @@ Cons:
 Example 1: prosody's mod_http_file_share
 ----------------------------------------
 
-In slidge's config: ``upload-service=example.org``
+In slidge's config: ``upload-service=upload.example.org``
 
 .. code-block:: lua
 

{slidge-0.2.8 → slidge-0.2.9}/docs/source/admin/config/index.rst

@@ -4,7 +4,7 @@ Configuration
 .. include:: ../note.rst
 
 .. note::
-  For the debian package, just edit the ``/etc/slidge/conf.d/common.conf`` and
+  For the debian unofficial package, just edit the ``/etc/slidge/conf.d/common.conf`` and
   ``/etc/slidge/*.conf`` files, and use :ref:`Debian packages (systemd)` to
   launch slidge.
 

{slidge-0.2.8 → slidge-0.2.9}/docs/source/admin/daemon.rst

@@ -76,10 +76,10 @@ Give permission for this user to use subuids and subgids (as root, required for
 
 .. code-block:: bash
 
-    usermod --add-subuids 200000-201000 --add-subgids 200000-201000 slidge
+    usermod --add-subuids 200000-210000 --add-subgids 200000-210000 slidge
 
 .. warning::
-    Check that the 200000-201000 range does not overlap with any other user's range
+    Check that the 200000-210000 range does not overlap with any other user's range
     in ``/etc/subuid`` and ``/etc/subgid``
 
 Enable lingering for this user so that its systemd user services start on startup (as root):

{slidge-0.2.8 → slidge-0.2.9}/docs/source/user/register.rst

@@ -45,3 +45,7 @@ Other clients
 
 Other clients might have different UIs, but you can always fall back to the
 "register" :term:`Chatbot Command`.
+
+In your XMPP client, start a new conversation with
+JID ``superduper.example.org``.
+Type "register" and follow the instructions.

{slidge-0.2.8 → slidge-0.2.9}/pyproject.toml

@@ -17,22 +17,24 @@ dependencies = [
 authors = [
   {name = "Nicolas Cedilnik", email = "nicoco@nicoco.fr"},
 ]
-license = {file = "LICENSE"}
+license = "AGPL-3.0-or-later"
 classifiers = [
     "Topic :: Internet :: XMPP",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 keywords = ["xmpp", "gateway", "bridge", "instant messaging"]
-version = "v0.2.8"
+dynamic = ["version"]
 readme = "README.md"
 
 [build-system]
-requires = ["setuptools", "setuptools-scm"]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
 include = ["slidge*"]
 
+[tool.setuptools_scm]
+
 [project.scripts]
 slidge = 'slidge.main:main'
 
@@ -111,12 +113,6 @@ name = "codeberg"
 url = "https://codeberg.org/api/packages/slidge/pypi/simple"
 publish-url = "https://codeberg.org/api/packages/slidge/pypi"
 
-[tool.setuptools]
-# FIXME: remove this when the setuptools upstream bug is fixed
-# https://github.com/astral-sh/uv/issues/9513#issuecomment-2519527822
-license-files = []
-
-
 [tool.git-cliff.remote.gitea]
 owner = "slidge"
 repo = "slidge"

{slidge-0.2.8 → slidge-0.2.9}/slidge/__init__.py

@@ -6,6 +6,7 @@ Contains importable classes for a minimal function :term:`Legacy Module`.
 
 import sys
 import warnings
+from importlib.metadata import PackageNotFoundError, version
 
 from . import slixfix  # noqa: F401
 from .command import FormField, SearchResult  # noqa: F401
@@ -37,8 +38,15 @@ def formatwarning(message, category, filename, lineno, line=""):
 
 warnings.formatwarning = formatwarning
 
+try:
+    __version__ = version("slidge")
+except PackageNotFoundError:
+    # package is not installed
+    __version__ = "dev"
+
 
 __all__ = [
+    "__version__",
     "BaseGateway",
     "BaseSession",
     # For backwards compatibility, these names are still importable from the

{slidge-0.2.8 → slidge-0.2.9}/slidge/command/admin.py

@@ -60,8 +60,6 @@ class SlidgeInfo(AdminCommand):
     ACCESS = CommandAccess.ANY
 
     async def run(self, _session, _ifrom, *_):
-        from slidge.__version__ import __version__
-
         start = self.xmpp.datetime_started  # type:ignore
         uptime = datetime.now() - start
 
@@ -100,8 +98,10 @@ class SlidgeInfo(AdminCommand):
         legacy_module = importlib.import_module(config.LEGACY_MODULE)
         version = getattr(legacy_module, "__version__", "No version")
 
+        import slidge
+
         return (
-            f"{self.xmpp.COMPONENT_NAME} (slidge core {__version__},"
+            f"{self.xmpp.COMPONENT_NAME} (slidge core {slidge.__version__},"
             f" {config.LEGACY_MODULE} {version})\n"
             f"Up since {start:%Y-%m-%d %H:%M} ({ago} ago)"
         )

{slidge-0.2.8 → slidge-0.2.9}/slidge/core/gateway.py

@@ -526,6 +526,7 @@ class BaseGateway(
                 "You are not connected to this gateway! "
                 f"Maybe this message will tell you why: {e}"
             )
+            session.logged = False
             return
 
         log.info("Login success for %s", session.user_jid)

{slidge-0.2.8 → slidge-0.2.9}/slidge/group/room.py

@@ -1016,8 +1016,11 @@ class LegacyMUC(
             item = ans["pubsub"]["items"]["item"]
             item["id"] = self.jid
             return item
-        except (IqError, IqTimeout) as exc:
-            warnings.warn(f"Cannot fetch bookmark: {exc}")
+        except IqTimeout as exc:
+            warnings.warn(f"Cannot fetch bookmark for {self.user_jid}: timeout")
+            return None
+        except IqError as exc:
+            warnings.warn(f"Cannot fetch bookmark for {self.user_jid}: {exc}")
             return None
         except PermissionError:
             warnings.warn(

{slidge-0.2.8 → slidge-0.2.9}/slidge/main.py

@@ -24,8 +24,8 @@ from pathlib import Path
 
 import configargparse
 
+import slidge
 from slidge import BaseGateway
-from slidge.__version__ import __version__
 from slidge.core import config
 from slidge.core.pubsub import PepAvatar, PepNick
 from slidge.db import SlidgeStore
@@ -96,7 +96,7 @@ def get_configurator():
     p.add_argument(
         "--version",
         action="version",
-        version=f"%(prog)s {__version__}",
+        version=f"%(prog)s {slidge.__version__}",
     )
     configurator = MainConfig(config, p)
     return configurator
@@ -128,7 +128,7 @@ def main():
     signal.signal(signal.SIGTERM, handle_sigterm)
 
     unknown_argv = configure()
-    logging.info("Starting slidge version %s", __version__)
+    logging.info("Starting slidge version %s", slidge.__version__)
 
     legacy_module = importlib.import_module(config.LEGACY_MODULE)
     logging.debug("Legacy module: %s", dir(legacy_module))

{slidge-0.2.8 → slidge-0.2.9}/slidge/util/types.py

@@ -21,7 +21,7 @@ from typing import (
 )
 
 from slixmpp import Message, Presence
-from slixmpp.types import PresenceShows, PresenceTypes
+from slixmpp.types import PresenceShows, PresenceTypes, ResourceDict
 
 if TYPE_CHECKING:
     from ..contact import LegacyContact
@@ -155,12 +155,6 @@ class MucType(IntEnum):
 PseudoPresenceShow = Union[PresenceShows, Literal[""]]
 
 
-class ResourceDict(TypedDict):
-    show: PseudoPresenceShow
-    status: str
-    priority: int
-
-
 MessageOrPresenceTypeVar = TypeVar(
     "MessageOrPresenceTypeVar", bound=Union[Message, Presence]
 )

{slidge-0.2.8 → slidge-0.2.9}/slidge/util/util.py

@@ -218,19 +218,6 @@ class SlidgeLogger(logging.Logger):
 log = logging.getLogger(__name__)
 
 
-def get_version() -> str:
-    try:
-        git = subprocess.check_output(
-            ["git", "rev-parse", "HEAD"],
-            stderr=subprocess.DEVNULL,
-            cwd=Path(__file__).parent,
-        ).decode()
-    except (FileNotFoundError, subprocess.CalledProcessError):
-        return "NO_VERSION"
-    else:
-        return "git-" + git[:10]
-
-
 def merge_resources(resources: dict[str, ResourceDict]) -> Optional[ResourceDict]:
     if len(resources) == 0:
         return None