slidge 0.2.8__py3-none-any.whl → 0.2.9__py3-none-any.whl

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/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/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/core/session.py

@@ -543,10 +543,10 @@ class BaseSession(
         return f"<Session of {self.user_jid}>"
 
     def shutdown(self, logout=True) -> asyncio.Task:
-        for c in self.contacts:
-            c.offline()
         for m in self.bookmarks:
             m.shutdown()
+        for c in self.contacts:
+            c.offline()
         if logout:
             return self.xmpp.loop.create_task(self.logout())
         else:

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/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/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/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

slidge-0.2.9.dist-info/METADATA

@@ -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.8.dist-info → slidge-0.2.9.dist-info}/RECORD

@@ -1,12 +1,11 @@
-slidge/__init__.py,sha256=S0tUjqpZlzsr8G4Y_1Xt-KCYB07qaknTB0OwHU8k29U,1587
+slidge/__init__.py,sha256=36BNw5mWk_MWxlPMzNCJpspoou05hFaL-eQp-JwE3JU,1793
 slidge/__main__.py,sha256=ydjUklOoavS4YlGfjRX_8BQN2DaSbaXPMi47RkOgcFI,37
-slidge/__version__.py,sha256=Zirtlo5Bp-7eCiwh-NWenCh2s-v0fenKkV8OFlv_O1Y,165
-slidge/main.py,sha256=vMJzhvUxbeuIXuHxXXs6lm_ShBjXiS9B5Li5Ge4vWPo,6238
+slidge/main.py,sha256=kusTX-W9cYo1I1TLqHEag20-TPsjFeF5BO2jC8y2Mt4,6223
 slidge/migration.py,sha256=4BJmPIRB56_WIhRTqBFIIBXuvnhhBjjOMl4CE7jY6oc,1541
 slidge/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 slidge/command/__init__.py,sha256=UYf1mjCYbZ5G7PIgaFTWSQRAzEJkQ6dTH8Fu_e_XnO0,613
 slidge/command/adhoc.py,sha256=bYLXcYJjbqPE9nBhrEQevqYFh9AS7Ei3m1vTZBIggrc,10557
-slidge/command/admin.py,sha256=TYrzgCIhjcTIwl1IUaFlUd3D98SPyao10gB20zo8b3Q,6187
+slidge/command/admin.py,sha256=DYN9yADZo2hKV0t20K2qnFPJHU98eKsaZTOqi1zdMys,6165
 slidge/command/base.py,sha256=EDcEl5dJcooSmLarXI2fmBq6QtU7h-7MOM3DDsxXmTU,13447
 slidge/command/categories.py,sha256=vF0KGDV9sEn8TNkcMoDRw-u3gEyNHSXghOU2JRHQtKs,351
 slidge/command/chat_command.py,sha256=z-4qp03rK7kCh3_kEozDViwkDg_hVjHvRCiYYJxedBQ,11153
@@ -17,9 +16,9 @@ slidge/contact/contact.py,sha256=CLWuNLvWuODi1mlT6MFGx9s3y8yGPM8ZEsH-Ih6QEn8,229
 slidge/contact/roster.py,sha256=19EYyX-usuevMob9AgnQmSt6APdE5MxMroHOYmVYt-w,10205
 slidge/core/__init__.py,sha256=RG7Jj5JCJERjhqJ31lOLYV-7bH_oblClQD1KF9LsTXo,68
 slidge/core/config.py,sha256=OjJfpXJaDhMxRB-vYA0cqkSf0fwMt-HMThM8GS1htCg,7964
-slidge/core/gateway.py,sha256=6qu3Ca5e3Kxtfm343zz43Iqjpw7cxZ1A7LC3bUdkDLo,37457
+slidge/core/gateway.py,sha256=tBaI8ZTGEOeojgSny1rfec9w8MF24Buce8KL5oes984,37492
 slidge/core/pubsub.py,sha256=BoeYE__ptmRAn4x55Hn_6JWRA4nM-XJgDemG5Cy5kN4,11959
-slidge/core/session.py,sha256=Y6psOKm_lv4q7yXARiLuijvSebuS64NjqSNF1WARtHM,28439
+slidge/core/session.py,sha256=Ie1a6bpUCC_HFvm98S-t03WG5JlOFG0SwbmGB2l9ZTc,28439
 slidge/core/dispatcher/__init__.py,sha256=1EXcjXietUKlxEqdrCWCV3xZ3q_DSsjHoqWrPMbtYao,84
 slidge/core/dispatcher/caps.py,sha256=vzCAXo_bhALuLEpJWtyJTzVfWx96g1AsWD8_wkoDl0Y,2028
 slidge/core/dispatcher/disco.py,sha256=j56VY9NIFzwPEWFKQQZ7YIqS9GdD-ZaF_K8a2L-JvRk,2006
@@ -81,7 +80,7 @@ slidge/group/__init__.py,sha256=yFt7cHqeaKIMN6f9ZyhhspOcJJvBtLedGv-iICG7lto,258
 slidge/group/archive.py,sha256=AUzVtXlHiCreyY3jp1XMt0G7LDNm-qOU-4CEPQ89ics,5445
 slidge/group/bookmarks.py,sha256=uGw_XtF0nloZ7rhNLdKM0nNZZb5C6SBfTsLyZryxjxY,6592
 slidge/group/participant.py,sha256=h9Cz4liCWzCaysvDk4wr8-zHvLOyIoM3vvQWzHCdpFE,17690
-slidge/group/room.py,sha256=UlmgIwZDjCyxXtAjQGVHo1xZoU9lq2WR7blwC9BAriY,49019
+slidge/group/room.py,sha256=C0CYhn3EuqjQnGLia9A3_mmkGfc_gDmd-PMESggupFo,49164
 slidge/slixfix/__init__.py,sha256=opamnCRI89KtCY2jfUrzij423hROgMF_Jw8Rrv1i0pw,2515
 slidge/slixfix/delivery_receipt.py,sha256=3bWdZH3-X3CZJXmnI_TpjkTUUK-EY4Ktm78lW0-40fc,1366
 slidge/slixfix/roster.py,sha256=KvDjh9q7pqaZf69H93okfib13cc95uVZUJ6rzpqmDaU,1704
@@ -103,10 +102,11 @@ slidge/util/archive_msg.py,sha256=xXAR0BI5r3d6KKWjae9594izCOv6iI03z2WLuTecNw8,17
 slidge/util/conf.py,sha256=1j2OnOsCBar1tOObErhXR5RC3Vl3faliOZ1U8J3My58,6613
 slidge/util/jid_escaping.py,sha256=pWJTrB6-M923a_rEE-nxPmiDTOx9UCMa8UgE7JbLC0c,1066
 slidge/util/test.py,sha256=l1VHBsw5Uzk2t7wtkfb9kWvtehcYhw1t_d567JAJFKA,14135
-slidge/util/types.py,sha256=R_xfS5mRL0XUJIoDpnaAkZlTOoLPerduXBFftaVwIAI,5489
-slidge/util/util.py,sha256=IfyYLkujW6Pk0kvHpfkpQwejFDHSe5oR4_bczEUnhjs,9678
-slidge-0.2.8.dist-info/METADATA,sha256=_Ugh-_g55rL-uqTZ16WU-Nfo--8JO74xfLfIh75twEg,44841
-slidge-0.2.8.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-slidge-0.2.8.dist-info/entry_points.txt,sha256=py3_x834fFJ2TEzPd18Wt2DnysdAfuVqJ5zzBrXbAZs,44
-slidge-0.2.8.dist-info/top_level.txt,sha256=2LRjDYHaGZ5ieCMF8xy58JIiabRMzX-MGMbCZwfE17c,7
-slidge-0.2.8.dist-info/RECORD,,
+slidge/util/types.py,sha256=5j0G22hhsh3PNhtpJaz2DVt5XINJznZjz0hqewPZoFo,5407
+slidge/util/util.py,sha256=ZkQltO6JmfqZc9T-86XI6gAsZx9BLdF0CCurnxPRNRc,9329
+slidge-0.2.9.dist-info/licenses/LICENSE,sha256=DZak_2itbUtvHzD3E7GNUYSRK6jdOJ-GqncQ2weavLA,34523
+slidge-0.2.9.dist-info/METADATA,sha256=tmqEtywN5eD_3DDDeh4nPQIvp51Uc7d8wRgKibuh-QE,5102
+slidge-0.2.9.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+slidge-0.2.9.dist-info/entry_points.txt,sha256=py3_x834fFJ2TEzPd18Wt2DnysdAfuVqJ5zzBrXbAZs,44
+slidge-0.2.9.dist-info/top_level.txt,sha256=2LRjDYHaGZ5ieCMF8xy58JIiabRMzX-MGMbCZwfE17c,7
+slidge-0.2.9.dist-info/RECORD,,

{slidge-0.2.8.dist-info → slidge-0.2.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.2)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any