view sat/tools/common/data_objects.py @ 3101:ab7e8ade848a

plugin XEP-0045: added room statuses to metadata: room statuses are now sent with other metadata on bridge signals, and saved in Room instance. They give useful data on the room, for instance they can be used to know if a full jid is used in this room.
author Goffi <goffi@goffi.org>
date Mon, 30 Dec 2019 20:44:02 +0100
parents ab2696e34d29
children 9d0df638c8b4
line wrap: on
line source

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# SAT: a jabber client
# Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Objects handling bridge data, with jinja2 safe markup handling"""

from sat.core.constants import Const as C
from sat.tools.common import data_format

try:
    from jinja2 import Markup as safe
except ImportError:
    safe = str

from sat.tools.common import uri as xmpp_uri
import urllib.request, urllib.parse, urllib.error

q = lambda value: urllib.parse.quote(value.encode("utf-8"), safe="@")


def parsePubSubMetadata(metadata, items):
    """Helper method to have nicer metadata while doing a PubSub request

    The "rsm_index" and "rsm_count" keys will be converted to int
    The "mam_stable" and "mam_complete" keys will be converted to boolean
    A "complete" key can have the following values:
        - True: we are on the last page, i.e. last items have been received
        - False: we are not on the last page
        - None: we don't have enough data fo know our position in the pagination
    @param metadata(dict): dict retrieved fro bridge with request metadata
    @param items(list): items retrieved (used to determine "complete" value)
    @return (dict): parsed metadata
    """
    data = {}
    assert "complete" not in metadata

    for key, value in metadata.items():
        if key in ("rsm_index", "rsm_count"):
            value = int(value)
        elif key == "mam_stable":
            value = C.bool(value)
        elif key == "mam_complete":
            key = "complete"
            value = C.bool(value)
        data[key] = value
    if "complete" not in data:
        index = data.get("rsm_index")
        count = data.get("rsm_count")
        if index is None or count is None:
            # we don't have enough information to know if the data is complete or not
            data["complete"] = None
        else:
            # normally we have a strict equality here but XEP-0059 states
            # that index MAY be approximative, so just in case…
            data["complete"] = index + len(items) >= count
    return data


class BlogItem(object):
    def __init__(self, mb_data, parent, deserialise=True):
        """
        @param deserialise(bool): if True, mb_data is a serialised string which must
          be deserialised
        """
        # FIXME: deserialise should not be done here, but before BlogItem is called
        if deserialise:
            self.mb_data = data_format.deserialise(mb_data)
        else:
            self.mb_data = mb_data
        self.parent = parent
        self._comments = None
        self._comments_items_list = None

    @property
    def id(self):
        return self.mb_data.get("id")

    @property
    def atom_id(self):
        return self.mb_data.get("atom_id")

    @property
    def uri(self):
        node = self.parent.node
        service = self.parent.service
        return xmpp_uri.buildXMPPUri(
            "pubsub", subtype="microblog", path=service, node=node, item=self.id
        )

    @property
    def published(self):
        return self.mb_data.get("published")

    @property
    def updated(self):
        return self.mb_data.get("updated")

    @property
    def language(self):
        return self.mb_data.get("language")

    @property
    def author(self):
        return self.mb_data.get("author")

    @property
    def author_jid(self):
        return self.mb_data.get("author_jid")

    @property
    def author_jid_verified(self):
        return self.mb_data.get("author_jid_verified")

    @property
    def author_email(self):
        return self.mb_data.get("author_email")

    @property
    def tags(self):
        return self.mb_data.get('tags', [])

    @property
    def groups(self):
        return self.mb_data.get('groups', [])

    @property
    def title(self):
        return self.mb_data.get("title")

    @property
    def title_xhtml(self):
        try:
            return safe(self.mb_data["title_xhtml"])
        except KeyError:
            return None

    @property
    def content(self):
        return self.mb_data.get("content")

    @property
    def content_xhtml(self):
        try:
            return safe(self.mb_data["content_xhtml"])
        except KeyError:
            return None

    @property
    def comments(self):
        if self._comments is None:
            self._comments = data_format.dict2iterdict(
                "comments", self.mb_data, ("node", "service")
            )
        return self._comments

    @property
    def comments_service(self):
        return self.mb_data.get("comments_service")

    @property
    def comments_node(self):
        return self.mb_data.get("comments_node")

    @property
    def comments_items_list(self):
        return [] if self._comments_items_list is None else self._comments_items_list

    def appendCommentsItems(self, items):
        """append comments items to self.comments_items"""
        if self._comments_items_list is None:
            self._comments_items_list = []
        self._comments_items_list.append(items)


class BlogItems(object):
    def __init__(self, mb_data, deserialise=True):
        """
        @param deserialise(bool): if True, mb_data is a serialised string which must
          be deserialised
        """
        # FIXME: deserialise should not be done here, but before BlogItem is called
        self.items = [BlogItem(i, self, deserialise=deserialise) for i in mb_data[0]]
        self.metadata = parsePubSubMetadata(mb_data[1], self.items)

    @property
    def service(self):
        return self.metadata["service"]

    @property
    def node(self):
        return self.metadata["node"]

    @property
    def uri(self):
        return self.metadata["uri"]

    @property
    def with_rsm(self):
        """Return True if RSM is activated on this request"""
        return "rsm_first" in self.metadata

    @property
    def rsm_first(self):
        return self.metadata["rsm_first"]

    @property
    def rsm_last(self):
        return self.metadata["rsm_last"]

    @property
    def rsm_index(self):
        return self.metadata["rsm_index"]

    @property
    def rsm_count(self):
        return self.metadata["rsm_count"]

    @property
    def complete(self):
        return self.metadata["complete"]

    def __len__(self):
        return self.items.__len__()

    def __missing__(self, key):
        return self.items.__missing__(key)

    def __getitem__(self, key):
        return self.items.__getitem__(key)

    def __iter__(self):
        return self.items.__iter__()

    def __reversed__(self):
        return self.items.__reversed__()

    def __contains__(self, item):
        return self.items.__contains__(item)


class Message(object):
    def __init__(self, msg_data):
        self._uid = msg_data[0]
        self._timestamp = msg_data[1]
        self._from_jid = msg_data[2]
        self._to_jid = msg_data[3]
        self._message_data = msg_data[4]
        self._subject_data = msg_data[5]
        self._type = msg_data[6]
        self._extra = msg_data[7]
        self._html = dict(data_format.getSubDict("xhtml", self._extra))

    @property
    def id(self):
        return self._uid

    @property
    def timestamp(self):
        return self._timestamp

    @property
    def from_(self):
        return self._from_jid

    @property
    def text(self):
        try:
            return self._message_data[""]
        except KeyError:
            return next(iter(self._message_data.values()))

    @property
    def subject(self):
        try:
            return self._subject_data[""]
        except KeyError:
            return next(iter(self._subject_data.values()))

    @property
    def type(self):
        return self._type

    @property
    def thread(self):
        return self._extra.get("thread")

    @property
    def thread_parent(self):
        return self._extra.get("thread_parent")

    @property
    def received(self):
        return self._extra.get("received_timestamp", self._timestamp)

    @property
    def delay_sender(self):
        return self._extra.get("delay_sender")

    @property
    def info_type(self):
        return self._extra.get("info_type")

    @property
    def html(self):
        if not self._html:
            return None
        try:
            return safe(self._html[""])
        except KeyError:
            return safe(next(iter(self._html.values())))


class Messages(object):
    def __init__(self, msgs_data):
        self.messages = [Message(m) for m in msgs_data]

    def __len__(self):
        return self.messages.__len__()

    def __missing__(self, key):
        return self.messages.__missing__(key)

    def __getitem__(self, key):
        return self.messages.__getitem__(key)

    def __iter__(self):
        return self.messages.__iter__()

    def __reversed__(self):
        return self.messages.__reversed__()

    def __contains__(self, item):
        return self.messages.__contains__(item)


class Room(object):
    def __init__(self, jid, name=None, url=None):
        self.jid = jid
        self.name = name or jid
        if url is not None:
            self.url = url


class Identity(object):
    def __init__(self, jid_str, data=None):
        self.jid_str = jid_str
        self.data = data if data is not None else {}

    def __getitem__(self, key):
        return self.data[key]

    def __getattr__(self, key):
        try:
            return self.data[key]
        except KeyError:
            raise AttributeError(key)


class Identities(object):
    def __init__(self):
        self.identities = {}

    def __getitem__(self, jid_str):
        try:
            return self.identities[jid_str]
        except KeyError:
            return None

    def __setitem__(self, jid_str, data):
        self.identities[jid_str] = Identity(jid_str, data)

    def __contains__(self, jid_str):
        return jid_str in self.identities


class ObjectQuoter(object):
    """object wrapper which quote attribues (to be used in templates)"""

    def __init__(self, obj):
        self.obj = obj

    def __unicode__(self):
        return q(self.obj.__unicode__())

    def __str__(self):
        return self.__unicode__()

    def __getattr__(self, name):
        return q(self.obj.__getattr__(name))

    def __getitem__(self, key):
        return q(self.obj.__getitem__(key))


class OnClick(object):
    """Class to handle clickable elements targets"""

    def __init__(self, url=None):
        self.url = url

    def formatUrl(self, *args, **kwargs):
        """format URL using Python formatting

        values will be quoted before being used
        """
        return self.url.format(
            *[q(a) for a in args], **{k: ObjectQuoter(v) for k, v in kwargs.items()}
        )