slidge 0.2.4__py3-none-any.whl → 0.2.5__py3-none-any.whl

slidge/__version__.py

@@ -2,4 +2,4 @@ from slidge.util.util import get_version  # noqa: F401
 
 # this is modified before publish, but if someone cloned from the repo,
 # it can help
-__version__ = "v0.2.4"
+__version__ = "v0.2.5"

slidge/command/base.py

@@ -293,12 +293,16 @@ class FormField:
         return value
 
     def __validate_list_multi(self, value: list[str]) -> Union[list[str], list[JID]]:
+        # COMPAT: all the "if v" and "if not v" are workarounds for https://codeberg.org/slidge/slidge/issues/43
+        # They should be reverted once the bug is fixed upstream, cf https://soprani.ca/todo/390
         for v in value:
             if v not in self.__acceptable_options():
+                if not v:
+                    continue
                 raise XMPPError("not-acceptable", f"Not a valid option: '{v}'")
         if self.type == "list-multi":
-            return value
-        return [JID(v) for v in value]
+            return [v for v in value if v]
+        return [JID(v) for v in value if v]
 
     def get_xml(self) -> SlixFormField:
         """

slidge/contact/contact.py

@@ -454,7 +454,7 @@ class LegacyContact(
         except PermissionError:
             warnings.warn(
                 "Slidge does not have privileges to add contacts to the roster. Refer"
-                " to https://slidge.codeberg.page/docs/main/admin/privilege.html for"
+                " to https://slidge.im/docs/slidge/main/admin/privilege.html for"
                 " more info."
             )
             if config.ROSTER_PUSH_PRESENCE_SUBSCRIPTION_REQUEST_FALLBACK:

slidge/core/config.py

@@ -187,7 +187,7 @@ MAM_MAX_DAYS__DOC = "Maximum number of days for group archive retention."
 CORRECTION_EMPTY_BODY_AS_RETRACTION = True
 CORRECTION_EMPTY_BODY_AS_RETRACTION__DOC = (
     "Treat last message correction to empty message as a retraction. "
-    "(this is what cheogram do for retraction)"
+    "(this is what cheogram does for retraction)"
 )
 
 ATTACHMENT_MAXIMUM_FILE_NAME_LENGTH = 200
@@ -220,3 +220,14 @@ STRIP_LEADING_EMOJI_ADHOC__DOC = (
     "Strip the leading emoji in ad-hoc command names, if present, in case you "
     "are a emoji-hater."
 )
+
+COMPONENT_NAME: Optional[str] = None
+COMPONENT_NAME__DOC = (
+    "Overrides the default component name with a custom one. This is seen in service discovery and as the nickname "
+    "of the component in chat windows."
+)
+
+WELCOME_MESSAGE: Optional[str] = None
+WELCOME_MESSAGE__DOC = (
+    "Overrides the default welcome message received by newly registered users."
+)

slidge/core/gateway.py

@@ -254,6 +254,10 @@ class BaseGateway(
     http: aiohttp.ClientSession
 
     def __init__(self):
+        if config.COMPONENT_NAME:
+            self.COMPONENT_NAME = config.COMPONENT_NAME
+        if config.WELCOME_MESSAGE:
+            self.WELCOME_MESSAGE = config.WELCOME_MESSAGE
         self.log = log
         self.datetime_started = datetime.now()
         self.xmpp = self  # ugly hack to work with the BaseSender mixin :/
@@ -416,8 +420,14 @@ class BaseGateway(
         await self.plugin["xep_0115"].update_caps(jid=self.boundjid)
 
         if self.COMPONENT_AVATAR is not None:
-            cached_avatar = await avatar_cache.convert_or_get(self.COMPONENT_AVATAR)
-            self.avatar_pk = cached_avatar.pk
+            try:
+                cached_avatar = await avatar_cache.convert_or_get(self.COMPONENT_AVATAR)
+            except Exception as e:
+                log.exception("Could not set the component avatar.", exc_info=e)
+                cached_avatar = None
+            else:
+                assert cached_avatar is not None
+                self.avatar_pk = cached_avatar.pk
         else:
             cached_avatar = None
 

slidge/core/mixins/attachment.py

@@ -178,6 +178,7 @@ class AttachmentMixin(TextMessageMixin):
             file_path = temp_dir / file_name
             if file_url:
                 async with self.session.http.get(file_url) as r:
+                    r.raise_for_status()
                     with file_path.open("wb") as f:
                         f.write(await r.read())
 

slidge/core/mixins/message.py

@@ -183,7 +183,7 @@ class CarbonMessageMixin(ContentMessageMixin, MarkerMixin):
                 warnings.warn(
                     "Slidge does not have privileges to send message on behalf of"
                     " user.Refer to"
-                    " https://slidge.codeberg.page/docs/main/admin/privilege.html"
+                    " https://slidge.im/docs/slidge/main/admin/privilege.html"
                     " for more info."
                 )
 

slidge/core/pubsub.py

@@ -207,7 +207,8 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
     ) -> PepAvatar:
         if stanza.get_to() == self.xmpp.boundjid.bare:
             item = PepAvatar()
-            item.set_avatar_from_cache(avatar_cache.get_by_pk(self.xmpp.avatar_pk))
+            if hasattr(self.xmpp, "avatar_pk"):
+                item.set_avatar_from_cache(avatar_cache.get_by_pk(self.xmpp.avatar_pk))
             return item
 
         if contact is None:

slidge/db/avatar.py

@@ -14,6 +14,7 @@ from multidict import CIMultiDictProxy
 from PIL.Image import Image
 from PIL.Image import open as open_image
 from sqlalchemy import select
+from sqlalchemy.orm.exc import DetachedInstanceError
 
 from slidge.core import config
 from slidge.db.models import Avatar
@@ -102,6 +103,7 @@ class AvatarCache:
             if response.status == HTTPStatus.NOT_MODIFIED:
                 log.debug("Using avatar cache for %s", url)
                 raise NotModified
+            response.raise_for_status()
             return (
                 open_image(io.BytesIO(await response.read())),
                 response.headers,
@@ -141,7 +143,24 @@ class AvatarCache:
                     )
                 except NotModified:
                     assert stored is not None
-                    return CachedAvatar.from_store(stored, self.dir)
+                    try:
+                        return CachedAvatar.from_store(stored, self.dir)
+                    except DetachedInstanceError:
+                        # This is an awful hack to prevent errors on startup under certain conditions,
+                        # because we basically misused SQLAlchemy pretty bad in slidge.db.store.EngineMixin.session().
+                        # cf https://codeberg.org/slidge/slidge/issues/36
+                        # and https://docs.sqlalchemy.org/en/20/orm/session_basics.html#session-faq-threadsafe
+                        # It may be related to threads as we only have reports of this for slidge-whatsapp and skidge
+                        # which are the only implementations that uses threads.
+                        # In any case, a proper fix implies a major refactoring in which we spawn and close SQLAlchemy
+                        # "ORM Session"s with a reasonable, well-thought lifetime, instead of how we do it now, where we
+                        # basically just brute-forced our way into having something usable but with poor performance.
+                        # Databases, asyncio, and concurrency in general are hard… :(
+                        # Oh, and getting rid of the convoluted mess that this giant method is would also probably
+                        # be a good idea.
+                        stored = self.store.get_by_url(avatar)
+                        assert stored is not None
+                        return CachedAvatar.from_store(stored, self.dir)
         else:
             img = await self._get_image(avatar)
             response_headers = None

slidge/db/store.py

@@ -58,6 +58,8 @@ class EngineMixin:
     def __init__(self, engine: Engine):
         self._engine = engine
 
+    # TODO: we should not have a global Session object but instead build Sessions with different parameters
+    #       depending on the context (startup, incoming XMPP event, incoming legacy event).
     @contextmanager
     def session(self, **session_kwargs) -> Iterator[Session]:
         global _session

slidge/group/participant.py

@@ -70,6 +70,7 @@ class LegacyParticipant(
         is_system=False,
         role: MucRole = "participant",
         affiliation: MucAffiliation = "member",
+        resource: str | None = None,
     ):
         self.session = session = muc.session
         self.xmpp = session.xmpp
@@ -83,7 +84,13 @@ class LegacyParticipant(
 
         self._nickname = nickname
 
-        self.__update_jid(nickname)
+        if resource is None:
+            self.__update_jid(nickname)
+        else:
+            self._nickname_no_illegal = resource
+            self.jid = JID(self.muc.jid)
+            self.jid.resource = resource
+
         log.debug("Instantiation of: %r", self)
 
         self.contact: Optional["LegacyContact"] = None
@@ -510,6 +517,7 @@ class LegacyParticipant(
             stored.nickname,
             role=stored.role,
             affiliation=stored.affiliation,
+            resource=stored.resource,
         )
         part.pk = stored.id
         if contact is not None:

{slidge-0.2.4.dist-info → slidge-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: slidge
-Version: 0.2.4
+Version: 0.2.5
 Summary: XMPP bridging framework
 Author-email: Nicolas Cedilnik <nicoco@nicoco.fr>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -669,7 +669,8 @@ 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.codeberg.page/docs/main
+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
@@ -693,14 +694,14 @@ Requires-Dist: thumbhash>=0.1.2
 
 
 [![woodpecker CI status](https://ci.codeberg.org/api/badges/14027/status.svg)](https://ci.codeberg.org/repos/14027)
-[![coverage](https://slidge.codeberg.page/coverage/main/coverage.svg)](https://slidge.im/coverage/main)
+[![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/core/dev/tutorial.html)
+[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),
@@ -751,7 +752,7 @@ class Session(BaseSession):
         self.legacy_client.send_message(text=text, destination=chat.legacy_id)
 ```
 
-There's more in [the tutorial](https://slidge.codeberg.page/docs/main/dev/tutorial.html)!
+There's more in [the tutorial](https://slidge.im/docs/slidge/main/dev/tutorial.html)!
 
 Installation
 ------------
@@ -766,7 +767,7 @@ 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.codeberg.page/docs/main/admin/install.html) for details.
+Refer to [the docs](https://slidge.im/docs/slidge/main/admin/install.html) for details.
 
 About privacy
 -------------

{slidge-0.2.4.dist-info → slidge-0.2.5.dist-info}/RECORD

@@ -1,24 +1,24 @@
 slidge/__init__.py,sha256=S0tUjqpZlzsr8G4Y_1Xt-KCYB07qaknTB0OwHU8k29U,1587
 slidge/__main__.py,sha256=ydjUklOoavS4YlGfjRX_8BQN2DaSbaXPMi47RkOgcFI,37
-slidge/__version__.py,sha256=ieOsYgM0aVfIKxAjpsbCrB7YTVXvXet9-wS_3Z87ito,165
+slidge/__version__.py,sha256=4bAi8qOyNOCy78XyBLZqa2BfhBAl80d4H4U1rf4i8-k,165
 slidge/main.py,sha256=vMJzhvUxbeuIXuHxXXs6lm_ShBjXiS9B5Li5Ge4vWPo,6238
 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=-AO4h1N6owSuuqZon5tDL29O6qmEeAd1pcPjGCkzKRs,10065
 slidge/command/admin.py,sha256=TYrzgCIhjcTIwl1IUaFlUd3D98SPyao10gB20zo8b3Q,6187
-slidge/command/base.py,sha256=S-4WnxDuGE3sQTca5L6DjHVBsHqpNuf6zvXffYoP46c,13159
+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
 slidge/command/register.py,sha256=BduDI31Kx8CbWWEdjybimTA5Wcfhn-Jkt8sSPsySCpo,6724
 slidge/command/user.py,sha256=aksfkRUK7xj9n0XM-IfUSS5LrTp0qIHt5K2UkBBT1UE,12099
 slidge/contact/__init__.py,sha256=WMMaHk7UW7YT9EH2LtPdkU0bHQaOp4ikBhbBQskmoc8,191
-slidge/contact/contact.py,sha256=BQ5Fw7InnI76S5bQi_kZL1HhtptZhegmtsKksml7tjY,23125
+slidge/contact/contact.py,sha256=SiFeDoI1zuGKhVoK8O_Jm1ch9jwOsRINKgt1gijrmcc,23121
 slidge/contact/roster.py,sha256=x3speGdHbZ-VTLoQLQW4s53rBeBvW87W8ZibCCZSLDA,10300
 slidge/core/__init__.py,sha256=RG7Jj5JCJERjhqJ31lOLYV-7bH_oblClQD1KF9LsTXo,68
-slidge/core/config.py,sha256=WP3-ScXqdAhJBX7IRB5pBi_tAV_vE6G5W3Z-LGGULQw,7691
-slidge/core/gateway.py,sha256=Rid4Zc_IIV-3lMiiBirqiezkxC_Ed1HMlb9HLyxlnJc,36594
-slidge/core/pubsub.py,sha256=oTiS5KFQJAmsgkhOsvfvthT-LkuZGQSCrrUG0JskNkI,11907
+slidge/core/config.py,sha256=9oIrXYB4Fx9uVQkMYDswrd0xr0ieEH8r1EkGym-AxBE,8060
+slidge/core/gateway.py,sha256=S2fLp_KLPyoixlTQzvlrlus55dHFTYp-WkLZNSWw9mE,37022
+slidge/core/pubsub.py,sha256=BoeYE__ptmRAn4x55Hn_6JWRA4nM-XJgDemG5Cy5kN4,11959
 slidge/core/session.py,sha256=nQexpCd1jlHOhQPnFI4ri-5odp3N2pU5HO4l7WFetZY,28148
 slidge/core/dispatcher/__init__.py,sha256=1EXcjXietUKlxEqdrCWCV3xZ3q_DSsjHoqWrPMbtYao,84
 slidge/core/dispatcher/caps.py,sha256=vzCAXo_bhALuLEpJWtyJTzVfWx96g1AsWD8_wkoDl0Y,2028
@@ -40,22 +40,22 @@ slidge/core/dispatcher/muc/misc.py,sha256=bHBjMC-Pu3jR5hAPGMzXf-C05UbACIwg38YbJU
 slidge/core/dispatcher/muc/owner.py,sha256=1a6YV7b_mmi1jC6q1ko8weeL8imQA-s-hYGPLIHd10I,3308
 slidge/core/dispatcher/muc/ping.py,sha256=lb1VQPhiUPZ19KhbofRXMVCcY6wwQ2w-asnqtANaAwA,1660
 slidge/core/mixins/__init__.py,sha256=muReAzgvENgMvlfm0Fpe6BQFfm2EMjoDe9ZhGgo6Vig,627
-slidge/core/mixins/attachment.py,sha256=sdRo_WMaWnWr00bM3AYyZRAsP0TlgwqkdHd1i2EAkCg,20133
+slidge/core/mixins/attachment.py,sha256=rZcipXiGgo-8klumBvfgrSsU_rmS6cl1zx-zev_FZRg,20174
 slidge/core/mixins/avatar.py,sha256=BVOeH5j5tsPJ0IHUcB5ozpyh02TBPKiZMd9MYizDokA,8136
 slidge/core/mixins/base.py,sha256=MOd-pas38_52VawQVlxWtBtmTKC6My9G0ZaCeQxOJbs,748
 slidge/core/mixins/db.py,sha256=5Qpegd7D8e5TLXLLINYcf_DuVdN-7wNmsfztUuFYPcU,442
 slidge/core/mixins/disco.py,sha256=jk3Z1B6zTuisHv8VKNRJodIo0ee5btYHh2ZrlflPj_Q,3670
 slidge/core/mixins/lock.py,sha256=Vf1rrkbyNbSprr38WGfZiMgTB7AdbqH8ppFHY8N2yXE,975
-slidge/core/mixins/message.py,sha256=5Tt1r_8rjsV445b_28Lx73S-rW5tsP1uGPQhIKN64VM,7998
+slidge/core/mixins/message.py,sha256=0dPpDQwkdAdirUodKpb9Ad7mkr5meWc7S3lf0sXPYnc,7994
 slidge/core/mixins/message_maker.py,sha256=TcCutHi0sIwL6beJNkN7XyR0aDIbA0xZyxd2Gc9ulG4,6022
 slidge/core/mixins/message_text.py,sha256=pCY4tezEuwB2ZuUyUi72i4v9AJkxp_SWF1jrFsn94Ns,8096
 slidge/core/mixins/presence.py,sha256=yywo6KAw8C7GaZSMrSMuioNfhW08MrnobHt8XbHd0q8,7891
 slidge/core/mixins/recipient.py,sha256=b0uFnpym-hOFgYxGjXT1xQcZ4YRbDSBftPcNWLzSwEI,1336
 slidge/db/__init__.py,sha256=EBDH1JSEhgqYcli2Bw11CRC749wJk8AOucgBzmhDSvU,105
-slidge/db/avatar.py,sha256=FfRt2Vu11ZKD9F3x1_drawvUd-TDE3mp7SE3BZ9hOOg,6467
+slidge/db/avatar.py,sha256=z5e72STv8PdN6zkNyKlLqF7NFxHwCa6IjwgFpzu5ghE,8033
 slidge/db/meta.py,sha256=v1Jf-npZ28QwdGpsLQWLBHEbEP3-jnPrygRg05tJ_Iw,1831
 slidge/db/models.py,sha256=0NUJfa3lPKHhwV2zE4p7QVYCVs3yn9egFg2u9mssk5c,13964
-slidge/db/store.py,sha256=4QyK6rjztPdmhjsqxMookEK_WrdlzOpPFPWnCpKy2u4,46704
+slidge/db/store.py,sha256=A2F8QJ88INMSdw0S8G5wDAQJFjwpeExpLuwHu8T3ZHU,46904
 slidge/db/alembic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 slidge/db/alembic/env.py,sha256=hsBlRNs0zF5diSHGRSa8Fi3qRVQDA2rJdR41AEIdvxc,1642
 slidge/db/alembic/old_user_store.py,sha256=zFOv0JEWQQK0_TMRlU4Z0G5Mc9pxvEErLyOzXmRAe5Q,5209
@@ -80,7 +80,7 @@ slidge/db/alembic/versions/e91195719c2c_store_users_avatars_persistently.py,sha2
 slidge/group/__init__.py,sha256=yFt7cHqeaKIMN6f9ZyhhspOcJJvBtLedGv-iICG7lto,258
 slidge/group/archive.py,sha256=IPqklzo0UN3lPHckfsKW9c4nl3m_9XGY4u0eehrhe8k,5281
 slidge/group/bookmarks.py,sha256=AvFL34bEX6n3OP1Np309T5hrLK9GnjkjdyLJ3uiLZyc,6616
-slidge/group/participant.py,sha256=epxXqJ545ALkEYxziiobH149nlBeSZlxsNCYeI8LFhM,17357
+slidge/group/participant.py,sha256=tGGcAkdcK6aob1YP8e9ODbdK2_dGmFNH0F2x-gHyc4M,17611
 slidge/group/room.py,sha256=aJ-VIYACuEuoyKDsBFxsUZFoVpd265i0mzTOOHCNTPg,46849
 slidge/slixfix/__init__.py,sha256=aEXtmxMgxQWsUoDV5NSxZKwb-Hml5XeR2FMJlnaDUng,4324
 slidge/slixfix/delivery_receipt.py,sha256=3bWdZH3-X3CZJXmnI_TpjkTUUK-EY4Ktm78lW0-40fc,1366
@@ -111,8 +111,8 @@ slidge/util/db.py,sha256=4LxZj8oBYgiSnyBUnF_ALjr0TblkfNQq_p28sCfkHMY,242
 slidge/util/test.py,sha256=l1VHBsw5Uzk2t7wtkfb9kWvtehcYhw1t_d567JAJFKA,14135
 slidge/util/types.py,sha256=R_xfS5mRL0XUJIoDpnaAkZlTOoLPerduXBFftaVwIAI,5489
 slidge/util/util.py,sha256=An4BRIHktZGXnu4kCwaKYaSye_PlyuxEm_4SC9YvPhc,9594
-slidge-0.2.4.dist-info/METADATA,sha256=pMPAZlzk25loszDWjC73w2dvufxfN4f9NxTxxQ7KcNA,44799
-slidge-0.2.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-slidge-0.2.4.dist-info/entry_points.txt,sha256=py3_x834fFJ2TEzPd18Wt2DnysdAfuVqJ5zzBrXbAZs,44
-slidge-0.2.4.dist-info/top_level.txt,sha256=2LRjDYHaGZ5ieCMF8xy58JIiabRMzX-MGMbCZwfE17c,7
-slidge-0.2.4.dist-info/RECORD,,
+slidge-0.2.5.dist-info/METADATA,sha256=qPrPddCJQeL3747-F2abvx04v1bGPzyFJiLHX8Xjx0E,44856
+slidge-0.2.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+slidge-0.2.5.dist-info/entry_points.txt,sha256=py3_x834fFJ2TEzPd18Wt2DnysdAfuVqJ5zzBrXbAZs,44
+slidge-0.2.5.dist-info/top_level.txt,sha256=2LRjDYHaGZ5ieCMF8xy58JIiabRMzX-MGMbCZwfE17c,7
+slidge-0.2.5.dist-info/RECORD,,