slidge 0.1.0rc1__tar.gz → 0.1.1__tar.gz

slidge-0.1.1/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: slidge
+Version: 0.1.1
+Summary: XMPP bridging framework
+Home-page: https://sr.ht/~nicoco/slidge/
+License: AGPL-3.0-or-later
+Author: Nicolas Cedilnik
+Author-email: nicoco@nicoco.fr
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: ConfigArgParse (>=1.5.3,<2.0.0)
+Requires-Dist: Pillow (>=10,<11)
+Requires-Dist: aiohttp[speedups] (>=3.8.3,<4.0.0)
+Requires-Dist: blurhash-python (>=1.2.1,<2.0.0)
+Requires-Dist: pickle-secure (>=0.99.9,<0.100.0)
+Requires-Dist: python-magic (>=0.4.27,<0.5.0)
+Requires-Dist: qrcode (>=7.4.1,<8.0.0)
+Requires-Dist: slixmpp (>=1.8.5,<2.0.0)
+Description-Content-Type: text/markdown
+
+![Slidge logo](./dev/assets/slidge-color-small.png)
+
+[Home](https://sr.ht/~nicoco/slidge) |
+[Docs](https://slidge.im/core) |
+[Source](https://sr.ht/~nicoco/slidge/sources) |
+[Issues](https://sr.ht/~nicoco/slidge/trackers) |
+[Patches](https://lists.sr.ht/~nicoco/public-inbox) |
+[Chat](xmpp:slidge@conference.nicoco.fr?join)
+
+[![builds.sr.ht status](https://builds.sr.ht/~nicoco/slidge/commits/master/ci.yml.svg)](https://builds.sr.ht/~nicoco/slidge/commits/master/ci.yml?)
+[![coverage](https://slidge.im/coverage.svg)](https://slidge.im/coverage)
+[![pypi](https://badge.fury.io/py/slidge.svg)](https://pypi.org/project/slidge/)
+
+Slidge is an XMPP (puppeteer) gateway library in python.
+It makes
+[writing gateways to other chat networks](https://slidge.im/core/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/).
+
+Slidge is meant for gateway developers, if you are an XMPP server admin and
+want to install gateways on your server, you are looking for one of these projects:
+
+- [slidgnal](https://git.sr.ht/~nicoco/slidgnal) ([Signal](https://signal.org))
+- [slidge-whatsapp](https://git.sr.ht/~nicoco/slidge-whatsapp) ([Whatsapp](https://whatsapp.com))
+- [slidgram](https://git.sr.ht/~nicoco/slidgram) ([Telegram](https://telegram.org))
+- [slidcord](https://git.sr.ht/~nicoco/slidcord) ([Discord](https://discord.com))
+- [matteridge](https://git.sr.ht/~nicoco/matteridge) ([Mattermost](https://mattermost.com))
+- [sleamdge](https://git.sr.ht/~nicoco/sleamdge) ([Steam](https://steamcommunity.com/))
+- [skidge](https://git.sr.ht/~nicoco/skidge) ([Skype](https://skype.com/))
+- [messlidger](https://git.sr.ht/~nicoco/messlidger) ([Facebook Messenger](https://messenger.com/))
+- [matridge](https://git.sr.ht/~nicoco/matridge) ([Matrix](https://matrix.org/))
+- [slidgevoipms](https://codeberg.org/boxedtoast/slidgevoipms) ([voip.ms](https://voip.ms/))
+
+If you use debian, you might also be interested in the
+[slidge-debian](https://git.sr.ht/~nicoco/slidge-debian)
+bundle.
+
+Status
+------
+
+Slidge is **beta**-grade software for 1:1 chats.
+Group chat support is **experimental**.
+
+Try slidge and give us some
+feedback, through the [MUC](xmpp:slidge@conference.nicoco.fr?join), the
+[issue tracker](https://todo.sr.ht/~nicoco/slidge) or in the
+[public inbox](https://lists.sr.ht/~nicoco/public-inbox).
+Don't be shy!
+
+Installation
+------------
+
+Slidge is available on
+[docker.io](https://hub.docker.com/u/nicocool84),
+[pypi](https://pypi.org/project/slidge/) and as
+[debian packages](https://slidge.im/core/admin/install.html#debian).
+Refer to [the docs](https://slidge.im/core/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.1.1/README.md

@@ -0,0 +1,85 @@
+![Slidge logo](./dev/assets/slidge-color-small.png)
+
+[Home](https://sr.ht/~nicoco/slidge) |
+[Docs](https://slidge.im/core) |
+[Source](https://sr.ht/~nicoco/slidge/sources) |
+[Issues](https://sr.ht/~nicoco/slidge/trackers) |
+[Patches](https://lists.sr.ht/~nicoco/public-inbox) |
+[Chat](xmpp:slidge@conference.nicoco.fr?join)
+
+[![builds.sr.ht status](https://builds.sr.ht/~nicoco/slidge/commits/master/ci.yml.svg)](https://builds.sr.ht/~nicoco/slidge/commits/master/ci.yml?)
+[![coverage](https://slidge.im/coverage.svg)](https://slidge.im/coverage)
+[![pypi](https://badge.fury.io/py/slidge.svg)](https://pypi.org/project/slidge/)
+
+Slidge is an XMPP (puppeteer) gateway library in python.
+It makes
+[writing gateways to other chat networks](https://slidge.im/core/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/).
+
+Slidge is meant for gateway developers, if you are an XMPP server admin and
+want to install gateways on your server, you are looking for one of these projects:
+
+- [slidgnal](https://git.sr.ht/~nicoco/slidgnal) ([Signal](https://signal.org))
+- [slidge-whatsapp](https://git.sr.ht/~nicoco/slidge-whatsapp) ([Whatsapp](https://whatsapp.com))
+- [slidgram](https://git.sr.ht/~nicoco/slidgram) ([Telegram](https://telegram.org))
+- [slidcord](https://git.sr.ht/~nicoco/slidcord) ([Discord](https://discord.com))
+- [matteridge](https://git.sr.ht/~nicoco/matteridge) ([Mattermost](https://mattermost.com))
+- [sleamdge](https://git.sr.ht/~nicoco/sleamdge) ([Steam](https://steamcommunity.com/))
+- [skidge](https://git.sr.ht/~nicoco/skidge) ([Skype](https://skype.com/))
+- [messlidger](https://git.sr.ht/~nicoco/messlidger) ([Facebook Messenger](https://messenger.com/))
+- [matridge](https://git.sr.ht/~nicoco/matridge) ([Matrix](https://matrix.org/))
+- [slidgevoipms](https://codeberg.org/boxedtoast/slidgevoipms) ([voip.ms](https://voip.ms/))
+
+If you use debian, you might also be interested in the
+[slidge-debian](https://git.sr.ht/~nicoco/slidge-debian)
+bundle.
+
+Status
+------
+
+Slidge is **beta**-grade software for 1:1 chats.
+Group chat support is **experimental**.
+
+Try slidge and give us some
+feedback, through the [MUC](xmpp:slidge@conference.nicoco.fr?join), the
+[issue tracker](https://todo.sr.ht/~nicoco/slidge) or in the
+[public inbox](https://lists.sr.ht/~nicoco/public-inbox).
+Don't be shy!
+
+Installation
+------------
+
+Slidge is available on
+[docker.io](https://hub.docker.com/u/nicocool84),
+[pypi](https://pypi.org/project/slidge/) and as
+[debian packages](https://slidge.im/core/admin/install.html#debian).
+Refer to [the docs](https://slidge.im/core/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.1.1/pyproject.toml

@@ -0,0 +1,88 @@
+[tool.poetry]
+name = "slidge"
+version = "0.1.1"
+description = "XMPP bridging framework"
+authors = ["Nicolas Cedilnik <nicoco@nicoco.fr>"]
+readme = "README.md"
+license = "AGPL-3.0-or-later"
+homepage = "https://sr.ht/~nicoco/slidge/"
+include = ["slidge/util/schema.sql"]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+qrcode = "^7.4.1"
+Pillow = "^10"
+aiohttp = {version = "^3.8.3", extras = ["speedups"]}
+ConfigArgParse = "^1.5.3"
+pickle-secure = "^0.99.9"
+python-magic = "^0.4.27"
+slixmpp = "^1.8.5"
+blurhash-python = "^1.2.1"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.2.0"
+pytest-asyncio = "*"
+black = { version = "*", extras = ["d"] }
+Sphinx = "^7"
+Pygments = "^2.8.0"
+sphinx-argparse = "^0.4.0"
+sphinx-autoapi = "^3.0.0"
+furo = "^2023.03.27"
+mypy = "^1.2"
+isort = "^5.11.4"
+ruff = "^0.0.259"
+xmldiff = "^2.5"
+types-pillow = "^9.5.0.0"
+pre-commit = "^3.3.0"
+coverage = "^7.2.7"
+
+[tool.poetry.group.dev.dependencies.slidge-dev-helpers]
+git = "https://git.sr.ht/~nicoco/slidge-dev-helpers"
+branch = "master"
+
+[tool.poetry.scripts]
+slidge = 'slidge.__main__:main'
+
+[tool.mypy]
+check_untyped_defs = true
+files = ["slidge", "superduper"]
+exclude = ["tests", "slidge.slixfix.*"]
+
+[[tool.mypy.overrides]]
+module = [
+    "blurhash",
+    "configargparse",
+    "qrcode",
+]
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 120
+exclude = ["xep_*", "tests"]
+
+[tool.isort]
+profile = "black"
+
+[tool.coverage.run]
+source = ["slidge"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "if .*TYPE_CHECKING:",
+    "raise NotImplementedError"
+]
+
+[tool.pytest.ini_options]
+log_cli = true
+log_level = "DEBUG"
+asyncio_mode = "strict"
+filterwarnings = [
+    "ignore:The object should be created within an async function:DeprecationWarning:aiohttp",
+    "ignore:.*pkg_resources.*:DeprecationWarning",
+    "ignore::UserWarning:slidge",
+    "ignore:coroutine 'XMLStream._end_stream_wait' was never awaited.*:RuntimeWarning"
+]

slidge-0.1.1/slidge/__init__.py

@@ -0,0 +1,61 @@
+"""
+The main slidge package.
+
+Contains importable classes for a minimal function :term:`Legacy Module`.
+"""
+
+import sys
+import warnings
+
+from . import slixfix  # noqa: F401
+from .command import FormField, SearchResult  # noqa: F401
+from .contact import LegacyContact, LegacyRoster  # noqa: F401
+from .core import config as global_config  # noqa: F401
+from .core.gateway import BaseGateway  # noqa: F401
+from .core.session import BaseSession  # noqa: F401
+from .group import LegacyBookmarks, LegacyMUC, LegacyParticipant  # noqa: F401
+from .util.db import GatewayUser, user_store  # noqa: F401
+from .util.types import MucType  # noqa: F401
+from .util.util import addLoggingLevel
+
+from .__main__ import main  # isort: skip
+
+
+def entrypoint(module_name: str) -> None:
+    """
+    Entrypoint to be used in ``__main__.py`` of
+    :term:`legacy modules <Legacy Module>`.
+
+    :param module_name: An importable :term:`Legacy Module`.
+    """
+    sys.argv.extend(["--legacy", module_name])
+    main()
+
+
+def formatwarning(message, category, filename, lineno, line=""):
+    return f"{filename}:{lineno}:{category.__name__}:{message}\n"
+
+
+warnings.formatwarning = formatwarning
+
+
+__all__ = [
+    "BaseGateway",
+    "BaseSession",
+    # For backwards compatibility, these names are still importable from the
+    # top-level slidge module, but this is deprecated.
+    # "GatewayUser",
+    # "LegacyBookmarks",
+    # "LegacyMUC",
+    # "LegacyContact",
+    # "LegacyParticipant",
+    # "LegacyRoster",
+    # "MucType",
+    # "FormField",
+    # "SearchResult",
+    "entrypoint",
+    "user_store",
+    "global_config",
+]
+
+addLoggingLevel()

{slidge-0.1.0rc1 → slidge-0.1.1}/slidge/__main__.py

@@ -1,9 +1,22 @@
 """
 Slidge can be configured via CLI args, environment variables and/or INI files.
+
 To use env vars, use this convention: ``--home-dir`` becomes ``HOME_DIR``.
+
+Everything in ``/etc/slidge/conf.d/*`` is automatically used.
+To use a plugin-specific INI file, put it in another dir,
+and launch slidge with ``-c /path/to/plugin-specific.conf``.
+Use the long version of the CLI arg without the double dash prefix inside this
+INI file, eg ``debug=true``.
+
+An example configuration file is available at
+https://git.sr.ht/~nicoco/slidge/tree/master/item/dev/confs/slidge-example.ini
 """
+
+import asyncio
 import importlib
 import logging
+import os
 import signal
 from pathlib import Path
 
@@ -12,13 +25,22 @@ import configargparse
 from slidge import BaseGateway
 from slidge.core import config
 from slidge.core.cache import avatar_cache
+from slidge.migration import migrate
 from slidge.util.conf import ConfigModule
 from slidge.util.db import user_store
+from slidge.util.util import get_version  # noqa: F401
 
 
 class MainConfig(ConfigModule):
     def update_dynamic_defaults(self, args):
-        logging.basicConfig(level=args.loglevel)
+        # force=True is needed in case we call a logger before this is reached,
+        # or basicConfig has no effect
+        logging.basicConfig(
+            level=args.loglevel,
+            filename=args.log_file,
+            force=True,
+            format=args.log_format,
+        )
 
         if args.home_dir is None:
             args.home_dir = Path("/var/lib/slidge") / str(args.jid)
@@ -33,7 +55,10 @@ class SigTermInterrupt(Exception):
 
 def get_configurator():
     p = configargparse.ArgumentParser(
-        default_config_files=["/etc/slidge/conf.d/*.conf"], description=__doc__
+        default_config_files=os.getenv(
+            "SLIDGE_CONF_DIR", "/etc/slidge/conf.d/*.conf"
+        ).split(":"),
+        description=__doc__,
     )
     p.add_argument(
         "-c",
@@ -61,6 +86,11 @@ def get_configurator():
         const=logging.DEBUG,
         env_var="SLIDGE_DEBUG",
     )
+    p.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
     configurator = MainConfig(config, p)
     return configurator
 
@@ -80,7 +110,7 @@ def configure():
     db_file = config.HOME_DIR / "slidge.db"
     user_store.set_file(db_file, args.secret_key)
 
-    avatar_cache.set_dir(h / "slidge_avatars")
+    avatar_cache.set_dir(h / "slidge_avatars_v2")
 
     config.UPLOAD_REQUESTER = config.UPLOAD_REQUESTER or config.JID.bare
 
@@ -96,8 +126,15 @@ def main():
     signal.signal(signal.SIGTERM, handle_sigterm)
 
     unknown_argv = configure()
+    logging.info("Starting slidge version %s", __version__)
 
     legacy_module = importlib.import_module(config.LEGACY_MODULE)
+    logging.debug("Legacy module: %s", dir(legacy_module))
+    logging.info(
+        "Starting legacy module: '%s' version %s",
+        config.LEGACY_MODULE,
+        getattr(legacy_module, "__version__", "No version"),
+    )
 
     if plugin_config_obj := getattr(
         legacy_module, "config", getattr(legacy_module, "Config", None)
@@ -112,7 +149,10 @@ def main():
         if unknown_argv:
             raise RuntimeError("Some arguments have not been recognized", unknown_argv)
 
-    gateway = BaseGateway.get_unique_subclass()()
+    migrate()
+
+    gateway: BaseGateway = BaseGateway.get_unique_subclass()()
+    avatar_cache.http = gateway.http
     gateway.connect()
 
     return_code = 0
@@ -136,17 +176,23 @@ def main():
             return_code = 3
         if gateway.is_connected():
             logging.debug("Gateway is connected, cleaning up")
-            gateway.shutdown()
+            gateway.loop.run_until_complete(asyncio.gather(*gateway.shutdown()))
             gateway.disconnect()
             gateway.loop.run_until_complete(gateway.disconnected)
         else:
             logging.debug("Gateway is not connected, no need to clean up")
         user_store.close()
         avatar_cache.close()
+        gateway.loop.run_until_complete(gateway.http.close())
         logging.info("Successful clean shut down")
     logging.debug("Exiting with code %s", return_code)
     exit(return_code)
 
 
+# this should be modified before publish, but if someone cloned from the repo,
+# it can help
+__version__ = get_version()
+
+
 if __name__ == "__main__":
     main()

slidge-0.1.1/slidge/command/__init__.py

@@ -0,0 +1,28 @@
+"""
+This module implements an unified API to define :term:`adhoc <Ad-hoc Command>`
+or :term:`chatbot <Chatbot Command>` commands. Just subclass a :class:`Command`,
+and make sures it is imported in your legacy module's ``__init__.py``.
+"""
+
+from . import admin, register, user  # noqa: F401
+from .base import (
+    Command,
+    CommandAccess,
+    CommandResponseType,
+    Confirmation,
+    Form,
+    FormField,
+    SearchResult,
+    TableResult,
+)
+
+__all__ = (
+    "Command",
+    "CommandAccess",
+    "CommandResponseType",
+    "Confirmation",
+    "Form",
+    "FormField",
+    "SearchResult",
+    "TableResult",
+)