slidge 0.1.0__py3-none-any.whl

slidge/core/gateway/vcard_temp.py

@@ -0,0 +1,130 @@
+from copy import copy
+from typing import TYPE_CHECKING
+
+from slixmpp import CoroutineCallback, Iq, StanzaPath, register_stanza_plugin
+from slixmpp.exceptions import XMPPError
+from slixmpp.plugins.xep_0084 import MetaData
+from slixmpp.plugins.xep_0292.stanza import NS as VCard4NS
+
+from ...contact import LegacyContact
+from ...core.session import BaseSession
+from ...group import LegacyParticipant
+
+if TYPE_CHECKING:
+    from .base import BaseGateway
+
+
+class VCardTemp:
+    def __init__(self, xmpp: "BaseGateway"):
+        self.xmpp = xmpp
+        # remove slixmpp's default handler to replace with our own
+        self.xmpp.remove_handler("VCardTemp")
+        xmpp.register_handler(
+            CoroutineCallback(
+                "VCardTemp",
+                StanzaPath("iq/vcard_temp"),
+                self.__handler,  # type:ignore
+            )
+        )
+        # TODO: MR to slixmpp adding this to XEP-0084
+        register_stanza_plugin(
+            self.xmpp.plugin["xep_0060"].stanza.Item,
+            MetaData,
+        )
+
+    async def __handler(self, iq: Iq):
+        if iq["type"] == "get":
+            return await self.__handle_get_vcard_temp(iq)
+
+        if iq["type"] == "set":
+            return await self.__handle_set_vcard_temp(iq)
+
+    async def __fetch_user_avatar(self, session: BaseSession):
+        hash_ = session.avatar_hash
+        if not hash_:
+            raise XMPPError("item-not-found", "This participant has no contact")
+        meta_iq = await self.xmpp.plugin["xep_0060"].get_item(
+            session.user.jid,
+            MetaData.namespace,
+            hash_,
+            ifrom=self.xmpp.boundjid.bare,
+        )
+        info = meta_iq["pubsub"]["items"]["item"]["avatar_metadata"]["info"]
+        type_ = info["type"]
+        data_iq = await self.xmpp.plugin["xep_0084"].retrieve_avatar(
+            session.user.jid, hash_, ifrom=self.xmpp.boundjid.bare
+        )
+        bytes_ = data_iq["pubsub"]["items"]["item"]["avatar_data"]["value"]
+        return bytes_, type_
+
+    async def __handle_get_vcard_temp(self, iq: Iq):
+        session = self.xmpp.get_session_from_stanza(iq)
+        entity = await session.get_contact_or_group_or_participant(iq.get_to())
+        if not entity:
+            raise XMPPError("item-not-found")
+
+        bytes_ = None
+        if isinstance(entity, LegacyParticipant):
+            if entity.is_user:
+                bytes_, type_ = await self.__fetch_user_avatar(session)
+                if not bytes_:
+                    raise XMPPError(
+                        "internal-server-error",
+                        "Could not fetch the slidge user's avatar",
+                    )
+                avatar = None
+                vcard = None
+            elif not (contact := entity.contact):
+                raise XMPPError("item-not-found", "This participant has no contact")
+            else:
+                vcard = await self.xmpp.vcard.get_vcard(contact.jid, iq.get_from())
+                avatar = contact.get_avatar()
+                type_ = "image/png"
+        else:
+            avatar = entity.get_avatar()
+            type_ = "image/png"
+            if isinstance(entity, LegacyContact):
+                vcard = await self.xmpp.vcard.get_vcard(entity.jid, iq.get_from())
+            else:
+                vcard = None
+        v = self.xmpp.plugin["xep_0054"].make_vcard()
+        if avatar is not None and avatar.data:
+            bytes_ = avatar.data.get_value()
+        if bytes_:
+            v["PHOTO"]["BINVAL"] = bytes_
+            v["PHOTO"]["TYPE"] = type_
+        if vcard:
+            for el in vcard.xml:
+                new = copy(el)
+                new.tag = el.tag.replace(f"{{{VCard4NS}}}", "")
+                v.append(new)
+        reply = iq.reply()
+        reply.append(v)
+        reply.send()
+
+    async def __handle_set_vcard_temp(self, iq: Iq):
+        muc = await self.xmpp.get_muc_from_stanza(iq)
+        to = iq.get_to()
+
+        if to.resource:
+            raise XMPPError("bad-request", "You cannot set participants avatars")
+
+        data = iq["vcard_temp"]["PHOTO"]["BINVAL"] or None
+        try:
+            legacy_id = await muc.on_avatar(
+                data, iq["vcard_temp"]["PHOTO"]["TYPE"] or None
+            )
+        except XMPPError:
+            raise
+        except Exception as e:
+            raise XMPPError("internal-server-error", str(e))
+        reply = iq.reply(clear=True)
+        reply.enable("vcard_temp")
+        reply.send()
+
+        if not data:
+            await muc.set_avatar(None, blocking=True)
+            return
+
+        if legacy_id:
+            await muc.set_avatar(data, legacy_id, blocking=True)

slidge/core/mixins/__init__.py

@@ -0,0 +1,19 @@
+"""
+Mixins
+"""
+
+from .avatar import AvatarMixin
+from .disco import ChatterDiscoMixin
+from .message import MessageCarbonMixin, MessageMixin
+from .presence import PresenceMixin
+
+
+class FullMixin(ChatterDiscoMixin, MessageMixin, PresenceMixin):
+    pass
+
+
+class FullCarbonMixin(ChatterDiscoMixin, MessageCarbonMixin, PresenceMixin):
+    pass
+
+
+__all__ = ("AvatarMixin",)

slidge/core/mixins/attachment.py

@@ -0,0 +1,506 @@
+import functools
+import logging
+import os
+import re
+import shutil
+import stat
+import tempfile
+import warnings
+from datetime import datetime
+from mimetypes import guess_type
+from pathlib import Path
+from typing import IO, Collection, Optional, Sequence, Union
+from urllib.parse import quote as urlquote
+from uuid import uuid4
+from xml.etree import ElementTree as ET
+
+import blurhash
+from PIL import Image
+from slixmpp import JID, Message
+from slixmpp.exceptions import IqError
+from slixmpp.plugins.xep_0363 import FileUploadError
+from slixmpp.plugins.xep_0385.stanza import Sims
+from slixmpp.plugins.xep_0447.stanza import StatelessFileSharing
+
+from ...util.sql import db
+from ...util.types import (
+    LegacyAttachment,
+    LegacyMessageType,
+    LegacyThreadType,
+    MessageReference,
+)
+from ...util.util import fix_suffix
+from .. import config
+from ..cache import avatar_cache
+from .message_maker import MessageMaker
+
+
+class AttachmentMixin(MessageMaker):
+    def send_text(self, *_, **k) -> Optional[Message]:
+        raise NotImplementedError
+
+    async def __upload(
+        self,
+        file_path: Path,
+        file_name: Optional[str] = None,
+        content_type: Optional[str] = None,
+    ):
+        if file_name and file_path.name != file_name:
+            d = Path(tempfile.mkdtemp())
+            temp = d / file_name
+            temp.symlink_to(file_path)
+            file_path = temp
+        else:
+            d = None
+        if config.UPLOAD_SERVICE:
+            domain = None
+        else:
+            domain = re.sub(r"^.*?\.", "", self.xmpp.boundjid.bare)
+        try:
+            new_url = await self.xmpp.plugin["xep_0363"].upload_file(
+                filename=file_path,
+                content_type=content_type,
+                ifrom=config.UPLOAD_REQUESTER or self.xmpp.boundjid,
+                domain=JID(domain),
+            )
+        except (FileUploadError, IqError) as e:
+            warnings.warn(f"Something is wrong with the upload service: {e!r}")
+            return None
+        finally:
+            if d is not None:
+                file_path.unlink()
+                d.rmdir()
+
+        return new_url
+
+    @staticmethod
+    async def __no_upload(
+        file_path: Path,
+        file_name: Optional[str] = None,
+        legacy_file_id: Optional[Union[str, int]] = None,
+    ):
+        file_id = str(uuid4()) if legacy_file_id is None else str(legacy_file_id)
+        assert config.NO_UPLOAD_PATH is not None
+        assert config.NO_UPLOAD_URL_PREFIX is not None
+        destination_dir = Path(config.NO_UPLOAD_PATH) / file_id
+
+        if destination_dir.exists():
+            log.debug("Dest dir exists: %s", destination_dir)
+            files = list(f for f in destination_dir.glob("**/*") if f.is_file())
+            if len(files) == 1:
+                log.debug(
+                    "Found the legacy attachment '%s' at '%s'",
+                    legacy_file_id,
+                    files[0],
+                )
+                name = files[0].name
+                uu = files[0].parent.name  # anti-obvious url trick, see below
+                return files[0], "/".join([file_id, uu, name])
+            else:
+                log.warning(
+                    (
+                        "There are several or zero files in %s, "
+                        "slidge doesn't know which one to pick among %s. "
+                        "Removing the dir."
+                    ),
+                    destination_dir,
+                    files,
+                )
+                shutil.rmtree(destination_dir)
+
+        log.debug("Did not find a file in: %s", destination_dir)
+        # let's use a UUID to avoid URLs being too obvious
+        uu = str(uuid4())
+        destination_dir = destination_dir / uu
+        destination_dir.mkdir(parents=True)
+
+        name = file_name or file_path.name
+        destination = destination_dir / name
+        method = config.NO_UPLOAD_METHOD
+        if method == "copy":
+            shutil.copy2(file_path, destination)
+        elif method == "hardlink":
+            os.link(file_path, destination)
+        elif method == "symlink":
+            os.symlink(file_path, destination, target_is_directory=True)
+        elif method == "move":
+            shutil.move(file_path, destination)
+        else:
+            raise RuntimeError("No upload method not recognized", method)
+
+        if config.NO_UPLOAD_FILE_READ_OTHERS:
+            log.debug("Changing perms of %s", destination)
+            destination.chmod(destination.stat().st_mode | stat.S_IROTH)
+        uploaded_url = "/".join([file_id, uu, name])
+
+        return destination, uploaded_url
+
+    async def __get_url(
+        self,
+        file_path: Optional[Path] = None,
+        data_stream: Optional[IO[bytes]] = None,
+        data: Optional[bytes] = None,
+        file_url: Optional[str] = None,
+        file_name: Optional[str] = None,
+        content_type: Optional[str] = None,
+        legacy_file_id: Optional[Union[str, int]] = None,
+    ) -> tuple[bool, Optional[Path], str]:
+        if legacy_file_id:
+            cache = db.attachment_get_url(legacy_file_id)
+            if cache is not None:
+                async with self.session.http.head(cache) as r:
+                    if r.status < 400:
+                        return False, None, cache
+                    else:
+                        db.attachment_remove(legacy_file_id)
+
+        if file_url and config.USE_ATTACHMENT_ORIGINAL_URLS:
+            return False, None, file_url
+
+        if file_name and len(file_name) > config.ATTACHMENT_MAXIMUM_FILE_NAME_LENGTH:
+            log.debug("Trimming long filename: %s", file_name)
+            base, ext = os.path.splitext(file_name)
+            file_name = (
+                base[: config.ATTACHMENT_MAXIMUM_FILE_NAME_LENGTH - len(ext)] + ext
+            )
+
+        if file_path is None:
+            file_name = str(uuid4()) if file_name is None else file_name
+            temp_dir = Path(tempfile.mkdtemp())
+            file_path = temp_dir / file_name
+            if file_url:
+                async with self.session.http.get(file_url) as r:
+                    with file_path.open("wb") as f:
+                        f.write(await r.read())
+
+            else:
+                if data_stream is not None:
+                    data = data_stream.read()
+                if data is None:
+                    raise RuntimeError
+
+                with file_path.open("wb") as f:
+                    f.write(data)
+
+            is_temp = not bool(config.NO_UPLOAD_PATH)
+        else:
+            is_temp = False
+
+        if config.FIX_FILENAME_SUFFIX_MIME_TYPE:
+            file_name = str(fix_suffix(file_path, content_type, file_name))
+
+        if config.NO_UPLOAD_PATH:
+            local_path, new_url = await self.__no_upload(
+                file_path, file_name, legacy_file_id
+            )
+            new_url = (config.NO_UPLOAD_URL_PREFIX or "") + "/" + urlquote(new_url)
+        else:
+            local_path = file_path
+            new_url = await self.__upload(file_path, file_name, content_type)
+        if legacy_file_id:
+            db.attachment_store_url(legacy_file_id, new_url)
+
+        return is_temp, local_path, new_url
+
+    async def __set_sims(
+        self,
+        msg: Message,
+        uploaded_url: str,
+        path: Optional[Path],
+        content_type: Optional[str] = None,
+        caption: Optional[str] = None,
+        file_name: Optional[str] = None,
+    ):
+        cache = db.attachment_get_sims(uploaded_url)
+        if cache:
+            msg.append(Sims(xml=ET.fromstring(cache)))
+            return
+
+        if not path:
+            return
+
+        sims = self.xmpp["xep_0385"].get_sims(
+            path, [uploaded_url], content_type, caption
+        )
+        if file_name:
+            sims["sims"]["file"]["name"] = file_name
+        if content_type is not None and content_type.startswith("image"):
+            try:
+                h, x, y = await self.xmpp.loop.run_in_executor(
+                    avatar_cache._thread_pool, get_blurhash, path
+                )
+            except Exception as e:
+                log.debug("Could not generate a blurhash", exc_info=e)
+            else:
+                thumbnail = sims["sims"]["file"]["thumbnail"]
+                thumbnail["width"] = x
+                thumbnail["height"] = y
+                thumbnail["media-type"] = "image/blurhash"
+                thumbnail["uri"] = "data:image/blurhash," + urlquote(h)
+
+        db.attachment_store_sims(uploaded_url, str(sims))
+
+        msg.append(sims)
+
+    def __set_sfs(
+        self,
+        msg: Message,
+        uploaded_url: str,
+        path: Optional[Path],
+        content_type: Optional[str] = None,
+        caption: Optional[str] = None,
+        file_name: Optional[str] = None,
+    ):
+        cache = db.attachment_get_sfs(uploaded_url)
+        if cache:
+            msg.append(StatelessFileSharing(xml=ET.fromstring(cache)))
+            return
+
+        if not path:
+            return
+
+        sfs = self.xmpp["xep_0447"].get_sfs(path, [uploaded_url], content_type, caption)
+        if file_name:
+            sfs["file"]["name"] = file_name
+        db.attachment_store_sfs(uploaded_url, str(sfs))
+
+        msg.append(sfs)
+
+    def __send_url(
+        self,
+        msg: Message,
+        legacy_msg_id: LegacyMessageType,
+        uploaded_url: str,
+        caption: Optional[str] = None,
+        carbon=False,
+        when: Optional[datetime] = None,
+        **kwargs,
+    ) -> list[Message]:
+        msg["oob"]["url"] = uploaded_url
+        msg["body"] = uploaded_url
+        if caption:
+            m1 = self._send(msg, carbon=carbon, **kwargs)
+            m2 = self.send_text(
+                caption, legacy_msg_id=legacy_msg_id, when=when, carbon=carbon, **kwargs
+            )
+            return [m1, m2] if m2 else [m1]
+        else:
+            self._set_msg_id(msg, legacy_msg_id)
+            return [self._send(msg, carbon=carbon, **kwargs)]
+
+    async def send_file(
+        self,
+        file_path: Optional[Union[Path, str]] = None,
+        legacy_msg_id: Optional[LegacyMessageType] = None,
+        *,
+        data_stream: Optional[IO[bytes]] = None,
+        data: Optional[bytes] = None,
+        file_url: Optional[str] = None,
+        file_name: Optional[str] = None,
+        content_type: Optional[str] = None,
+        reply_to: Optional[MessageReference] = None,
+        when: Optional[datetime] = None,
+        caption: Optional[str] = None,
+        legacy_file_id: Optional[Union[str, int]] = None,
+        thread: Optional[LegacyThreadType] = None,
+        **kwargs,
+    ) -> tuple[Optional[str], list[Message]]:
+        """
+        Send a single file from this :term:`XMPP Entity`.
+
+        :param file_path: Path to the attachment
+        :param data_stream: Alternatively, a stream of bytes (such as a File object)
+        :param data: Alternatively, a bytes object
+        :param file_url: Alternatively, a URL
+        :param file_name: How the file should be named.
+        :param content_type: MIME type, inferred from filename if not given
+        :param legacy_msg_id: If you want to be able to transport read markers from the gateway
+            user to the legacy network, specify this
+        :param reply_to: Quote another message (:xep:`0461`)
+        :param when: when the file was sent, for a "delay" tag (:xep:`0203`)
+        :param caption: an optional text that is linked to the file
+        :param legacy_file_id: A unique identifier for the file on the legacy network.
+             Plugins should try their best to provide it, to avoid duplicates.
+        :param thread:
+        """
+        carbon = kwargs.pop("carbon", False)
+        mto = kwargs.pop("mto", None)
+        store_multi = kwargs.pop("store_multi", True)
+        msg = self._make_message(
+            when=when,
+            reply_to=reply_to,
+            carbon=carbon,
+            mto=mto,
+            thread=thread,
+        )
+
+        if content_type is None and (name := (file_name or file_path or file_url)):
+            content_type, _ = guess_type(name)
+
+        is_temp, local_path, new_url = await self.__get_url(
+            Path(file_path) if file_path else None,
+            data_stream,
+            data,
+            file_url,
+            file_name,
+            content_type,
+            legacy_file_id,
+        )
+
+        if new_url is None:
+            msg["body"] = (
+                "I tried to send a file, but something went wrong. "
+                "Tell your slidge admin to check the logs."
+            )
+            self._set_msg_id(msg, legacy_msg_id)
+            return None, [self._send(msg, **kwargs)]
+
+        await self.__set_sims(
+            msg, new_url, local_path, content_type, caption, file_name
+        )
+        self.__set_sfs(msg, new_url, local_path, content_type, caption, file_name)
+        if is_temp and isinstance(local_path, Path):
+            local_path.unlink()
+            local_path.parent.rmdir()
+
+        msgs = self.__send_url(
+            msg, legacy_msg_id, new_url, caption, carbon, when, **kwargs
+        )
+        if store_multi:
+            self.__store_multi(legacy_msg_id, msgs)
+        return new_url, msgs
+
+    def __send_body(
+        self,
+        body: Optional[str] = None,
+        legacy_msg_id: Optional[LegacyMessageType] = None,
+        reply_to: Optional[MessageReference] = None,
+        when: Optional[datetime] = None,
+        thread: Optional[LegacyThreadType] = None,
+        **kwargs,
+    ) -> Optional[Message]:
+        if body:
+            return self.send_text(
+                body,
+                legacy_msg_id,
+                reply_to=reply_to,
+                when=when,
+                thread=thread,
+                **kwargs,
+            )
+        else:
+            return None
+
+    async def send_files(
+        self,
+        attachments: Collection[LegacyAttachment],
+        legacy_msg_id: Optional[LegacyMessageType] = None,
+        body: Optional[str] = None,
+        *,
+        reply_to: Optional[MessageReference] = None,
+        when: Optional[datetime] = None,
+        thread: Optional[LegacyThreadType] = None,
+        body_first=False,
+        correction=False,
+        correction_event_id: Optional[LegacyMessageType] = None,
+        **kwargs,
+    ):
+        # TODO: once the epic XEP-0385 vs XEP-0447 battle is over, pick
+        #       one and stop sending several attachments this way
+        # we attach the legacy_message ID to the last message we send, because
+        # we don't want several messages with the same ID (especially for MUC MAM)
+        # TODO: refactor this so we limit the number of SQL calls, ie, if
+        #       the legacy file ID is known, only fetch the row once, and if it
+        #       is new, write it all in a single call
+        if not attachments and not body:
+            # ignoring empty message
+            return
+        send_body = functools.partial(
+            self.__send_body,
+            body=body,
+            reply_to=reply_to,
+            when=when,
+            thread=thread,
+            correction=correction,
+            legacy_msg_id=legacy_msg_id,
+            correction_event_id=correction_event_id,
+            **kwargs,
+        )
+        all_msgs = []
+        if body_first:
+            all_msgs.append(send_body())
+        last_attachment_i = len(attachments) - 1
+        for i, attachment in enumerate(attachments):
+            last = i == last_attachment_i
+            if last and not body:
+                legacy = legacy_msg_id
+            else:
+                legacy = None
+            _url, msgs = await self.send_file(
+                file_path=attachment.path,
+                legacy_msg_id=legacy,
+                file_url=attachment.url,
+                data_stream=attachment.stream,
+                data=attachment.data,
+                reply_to=reply_to,
+                when=when,
+                thread=thread,
+                file_name=attachment.name,
+                content_type=attachment.content_type,
+                legacy_file_id=attachment.legacy_file_id,
+                caption=attachment.caption,
+                store_multi=False,
+                **kwargs,
+            )
+            all_msgs.extend(msgs)
+        if not body_first:
+            all_msgs.append(send_body())
+        self.__store_multi(legacy_msg_id, all_msgs)
+
+    def __store_multi(
+        self,
+        legacy_msg_id: Optional[LegacyMessageType],
+        all_msgs: Sequence[Optional[Message]],
+    ):
+        if legacy_msg_id is None:
+            return
+        ids = []
+        for msg in all_msgs:
+            if not msg:
+                continue
+            if stanza_id := msg.get_plugin("stanza_id", check=True):
+                ids.append(stanza_id["id"])
+            else:
+                ids.append(msg.get_id())
+        db.attachment_store_legacy_to_multi_xmpp_msg_ids(legacy_msg_id, ids)
+
+
+def get_blurhash(path: Path, n=9) -> tuple[str, int, int]:
+    img = Image.open(path)
+    width, height = img.size
+    n = min(width, height, n)
+    if width == height:
+        x = y = n
+    elif width > height:
+        x = n
+        y = round(n * height / width)
+    else:
+        x = round(n * width / height)
+        y = n
+    # There are 2 blurhash-python packages:
+    # https://github.com/woltapp/blurhash-python
+    # https://github.com/halcy/blurhash-python
+    # With this hack we're compatible with both, which is useful for packaging
+    # without using pyproject.toml, as most distro do
+    try:
+        hash_ = blurhash.encode(img, x, y)
+    except TypeError:
+        # We are using halcy's blurhash which expects
+        # the 1st argument to be a 3-dimensional array
+        import numpy  # type:ignore
+
+        hash_ = blurhash.encode(numpy.array(img.convert("RGB")), x, y)
+    return hash_, width, height
+
+
+log = logging.getLogger(__name__)