libervia-backend: sat/plugins/plugin_pubsub

author	Goffi <goffi@goffi.org>
date	Wed, 20 Jul 2022 17:49:51 +0200
parents
children	c0bcbcf5b4b7

rev	line source
3864 ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/env python3
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	2
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	3 # Libervia plugin for Pubsub Attachments
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	4 # Copyright (C) 2009-2022 Jérôme Poisson (goffi@goffi.org)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	5
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	6 # This program is free software: you can redistribute it and/or modify
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	9 # (at your option) any later version.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	10
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	11 # This program is distributed in the hope that it will be useful,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	14 # GNU Affero General Public License for more details.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	15
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	16 # You should have received a copy of the GNU Affero General Public License
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	18
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	19 from typing import List, Tuple, Dict, Any, Callable, Optional
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	20
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	21 from twisted.words.protocols.jabber import jid, xmlstream, error
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	22 from twisted.words.xish import domish
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	23 from twisted.internet import defer
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	24 from zope.interface import implementer
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	25 from wokkel import pubsub, disco, iwokkel
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	26
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	27 from sat.core.constants import Const as C
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	28 from sat.core.i18n import _
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	29 from sat.core.log import getLogger
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	30 from sat.core.core_types import SatXMPPEntity
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	31 from sat.core import exceptions
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	32 from sat.tools.common import uri, data_format, date_utils
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	33 from sat.tools.utils import xmpp_date
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	34
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	35
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	36 log = getLogger(__name__)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	37
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	38 IMPORT_NAME = "PUBSUB_ATTACHMENTS"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	39
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	40 PLUGIN_INFO = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	41 C.PI_NAME: "Pubsub Attachments",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	42 C.PI_IMPORT_NAME: IMPORT_NAME,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	43 C.PI_TYPE: C.PLUG_TYPE_EXP,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	44 C.PI_MODES: C.PLUG_MODE_BOTH,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	45 C.PI_PROTOCOLS: [],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	46 C.PI_DEPENDENCIES: ["XEP-0060"],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	47 C.PI_MAIN: "PubsubAttachments",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	48 C.PI_HANDLER: "yes",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	49 C.PI_DESCRIPTION: _("""Pubsub Attachments implementation"""),
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	50 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	51 NS_PREFIX = "urn:xmpp:pubsub-attachments:"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	52 NS_PUBSUB_ATTACHMENTS = f"{NS_PREFIX}0"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	53 NS_PUBSUB_ATTACHMENTS_SUM = f"{NS_PREFIX}summary:0"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	54
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	55
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	56 class PubsubAttachments:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	57 namespace = NS_PUBSUB_ATTACHMENTS
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	58
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	59 def __init__(self, host):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	60 log.info(_("Pubsub Attachments plugin initialization"))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	61 host.registerNamespace("pubsub-attachments", NS_PUBSUB_ATTACHMENTS)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	62 self.host = host
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	63 self._p = host.plugins["XEP-0060"]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	64 self.handlers = {}
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	65 host.trigger.add("XEP-0277_send", self.onMBSend)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	66 self.registerAttachmentHandler(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	67 "noticed", NS_PUBSUB_ATTACHMENTS, self.noticedGet, self.noticedSet
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	68 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	69 self.registerAttachmentHandler(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	70 "reaction", NS_PUBSUB_ATTACHMENTS, self.reactionGet, self.reactionSet
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	71 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	72 host.bridge.addMethod(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	73 "psAttachmentsGet",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	74 ".plugin",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	75 in_sign="sssasss",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	76 out_sign="(ss)",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	77 method=self._get,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	78 async_=True,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	79 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	80 host.bridge.addMethod(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	81 "psAttachmentsSet",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	82 ".plugin",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	83 in_sign="ss",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	84 out_sign="",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	85 method=self._set,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	86 async_=True,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	87 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	88
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	89 def getHandler(self, client):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	90 return PubsubAttachments_Handler()
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	91
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	92 def registerAttachmentHandler(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	93 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	94 name: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	95 namespace: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	96 get_cb: Callable[
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	97 [SatXMPPEntity, domish.Element, Dict[str, Any]],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	98 None],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	99 set_cb: Callable[
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	100 [SatXMPPEntity, Dict[str, Any], Optional[domish.Element]],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	101 Optional[domish.Element]],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	102 ) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	103 """Register callbacks to handle an attachment
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	104
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	105 @param name: name of the element
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	106 @param namespace: namespace of the element
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	107 (name, namespace) couple must be unique
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	108 @param get: method to call when attachments are retrieved
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	109 it will be called with (client, element, data) where element is the
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	110 <attachments> element to parse, and data must be updated in place with
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	111 parsed data
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	112 @param set: method to call when the attachment need to be set or udpated
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	113 it will be called with (client, data, former_elt of None if there was no
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	114 former element). When suitable, ``operation`` should be used to check if we
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	115 request an ``update`` or a ``replace``.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	116 """
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	117 key = (name, namespace)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	118 if key in self.handlers:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	119 raise exceptions.ConflictError(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	120 f"({name}, {namespace}) attachment handlers are already registered"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	121 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	122 self.handlers[(name, namespace)] = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	123 "get": get_cb,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	124 "set": set_cb
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	125 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	126
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	127 def getAttachmentNodeName(self, service: jid.JID, node: str, item: str) -> str:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	128 """Generate name to use for attachment node"""
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	129 target_item_uri = uri.buildXMPPUri(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	130 "pubsub",
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	131 path=service.userhost(),
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	132 node=node,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	133 item=item
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	134 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	135 return f"{NS_PUBSUB_ATTACHMENTS}/{target_item_uri}"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	136
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	137 def isAttachmentNode(self, node: str) -> bool:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	138 """Return True if node name is an attachment node"""
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	139 return node.startswith(f"{NS_PUBSUB_ATTACHMENTS}/")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	140
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	141 def attachmentNode2Item(self, node: str) -> Tuple[jid.JID, str, str]:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	142 """Retrieve service, node and item from attachement node's name"""
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	143 if not self.isAttachmentNode(node):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	144 raise ValueError("this is not an attachment node!")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	145 prefix_len = len(f"{NS_PUBSUB_ATTACHMENTS}/")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	146 item_uri = node[prefix_len:]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	147 parsed_uri = uri.parseXMPPUri(item_uri)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	148 if parsed_uri["type"] != "pubsub":
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	149 raise ValueError(f"unexpected URI type, it must be a pubsub URI: {item_uri}")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	150 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	151 service = jid.JID(parsed_uri["path"])
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	152 except RuntimeError:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	153 raise ValueError(f"invalid service in pubsub URI: {item_uri}")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	154 node = parsed_uri["node"]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	155 item = parsed_uri["item"]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	156 return (service, node, item)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	157
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	158 async def onMBSend(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	159 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	160 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	161 service: jid.JID,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	162 node: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	163 item: domish.Element,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	164 data: dict
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	165 ) -> bool:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	166 """trigger to create attachment node on each publication"""
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	167 node_config = await self._p.getConfiguration(client, service, node)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	168 attachment_node = self.getAttachmentNodeName(service, node, item["id"])
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	169 # we use the same options as target node
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	170 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	171 await self._p.createIfNewNode(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	172 client, service, attachment_node, options=dict(node_config)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	173 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	174 except Exception as e:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	175 log.warning(f"Can't create attachment node {attachment_node}: {e}]")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	176 return True
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	177
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	178 def items2attachmentData(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	179 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	180 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	181 items: List[domish.Element]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	182 ) -> List[Dict[str, Any]]:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	183 """Convert items from attachment node to attachment data"""
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	184 list_data = []
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	185 for item in items:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	186 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	187 attachments_elt = next(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	188 item.elements(NS_PUBSUB_ATTACHMENTS, "attachments")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	189 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	190 except StopIteration:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	191 log.warning(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	192 "item is missing <attachments> elements, ignoring it: {item.toXml()}"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	193 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	194 continue
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	195 item_id = item["id"]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	196 publisher_s = item.getAttribute("publisher")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	197 # publisher is not filled by all pubsub service, so we can't count on it
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	198 if publisher_s:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	199 publisher = jid.JID(publisher_s)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	200 if publisher.userhost() != item_id:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	201 log.warning(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	202 f"publisher {publisher.userhost()!r} doesn't correspond to item "
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	203 f"id {item['id']!r}, ignoring. This may be a hack attempt.\n"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	204 f"{item.toXml()}"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	205 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	206 continue
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	207 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	208 jid.JID(item_id)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	209 except RuntimeError:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	210 log.warning(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	211 "item ID is not a JID, this is not compliant and is ignored: "
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	212 f"{item.toXml}"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	213 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	214 continue
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	215 data = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	216 "from": item_id
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	217 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	218 for handler in self.handlers.values():
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	219 handler["get"](client, attachments_elt, data)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	220 if len(data) > 1:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	221 list_data.append(data)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	222 return list_data
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	223
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	224 def _get(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	225 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	226 service_s: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	227 node: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	228 item: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	229 senders_s: List[str],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	230 extra_s: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	231 profile_key: str
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	232 ) -> defer.Deferred:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	233 client = self.host.getClient(profile_key)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	234 extra = data_format.deserialise(extra_s)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	235 senders = [jid.JID(s) for s in senders_s]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	236 d = defer.ensureDeferred(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	237 self.getAttachments(client, jid.JID(service_s), node, item, senders)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	238 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	239 d.addCallback(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	240 lambda ret:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	241 (data_format.serialise(ret[0]),
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	242 data_format.serialise(ret[1]))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	243 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	244 return d
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	245
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	246 async def getAttachments(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	247 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	248 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	249 service: jid.JID,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	250 node: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	251 item: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	252 senders: Optional[List[jid.JID]],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	253 extra: Optional[dict] = None
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	254 ) -> Tuple[List[Dict[str, Any]], dict]:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	255 if extra is None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	256 extra = {}
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	257 attachment_node = self.getAttachmentNodeName(service, node, item)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	258 item_ids = [e.userhost() for e in senders] if senders else None
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	259 items, metadata = await self._p.getItems(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	260 client, service, attachment_node, item_ids=item_ids, extra=extra
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	261 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	262 list_data = self.items2attachmentData(client, items)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	263
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	264 return list_data, metadata
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	265
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	266 def _set(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	267 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	268 attachments_s: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	269 profile_key: str
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	270 ) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	271 client = self.host.getClient(profile_key)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	272 attachments = data_format.deserialise(attachments_s) or {}
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	273 return defer.ensureDeferred(self.setAttachments( client, attachments))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	274
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	275 async def setAttachments(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	276 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	277 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	278 data: Dict[str, Any]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	279 ) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	280 """Set or update attachments
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	281
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	282 Former <attachments> element will be retrieved and updated. Individual
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	283 attachments replace or update their elements individually, according to the
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	284 "operation" key.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	285
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	286 "operation" key may be "update" or "replace", and defaults to update, it is only
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	287 used in attachments where "update" makes sense (e.g. it's used for "reactions"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	288 but not for "noticed").
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	289
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	290 @param data: microblog data data. Various keys (usually stored in
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	291 data["extra"]) may be used depending on the attachments handlers
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	292 registered. The keys "service", "node" and "id" MUST be set.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	293 """
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	294 data.setdefault("extra", {})
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	295 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	296 service = jid.JID(data["service"])
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	297 node = data["node"]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	298 item = data["id"]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	299 except (KeyError, RuntimeError):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	300 raise ValueError(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	301 'data must have "service", "node" and "id" set'
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	302 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	303 attachment_node = self.getAttachmentNodeName(service, node, item)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	304 items, __ = await self._p.getItems(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	305 client, service, attachment_node, item_ids=[client.jid.userhost()]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	306 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	307 if not items:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	308 # the item doesn't exist, we create a new one
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	309 item_elt = pubsub.Item(client.jid.userhost())
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	310 item_elt.addElement((NS_PUBSUB_ATTACHMENTS, "attachments"))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	311 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	312 item_elt = items[0]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	313
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	314 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	315 attachments_elt = next(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	316 item_elt.elements(NS_PUBSUB_ATTACHMENTS, "attachments")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	317 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	318 except StopIteration:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	319 log.warning(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	320 f"no <attachments> element found, creating a new one: {item_elt.toXml()}"
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	321 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	322 attachments_elt = item_elt.addElement((NS_PUBSUB_ATTACHMENTS, "attachments"))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	323
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	324 for (name, namespace), handler in self.handlers.items():
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	325 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	326 former_elt = next(attachments_elt.elements(namespace, name))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	327 except StopIteration:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	328 former_elt = None
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	329 new_elt = handler["set"](client, data, former_elt)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	330 if new_elt != former_elt:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	331 if former_elt is not None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	332 attachments_elt.children.remove(former_elt)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	333 if new_elt is not None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	334 attachments_elt.addChild(new_elt)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	335 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	336 await self._p.sendItems(client, service, attachment_node, [item_elt])
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	337 except error.StanzaError as e:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	338 if e.condition == "item-not-found":
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	339 # the node doesn't exist, we can't publish attachments
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	340 log.warning(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	341 f"no attachment node found at {service} on {node!r} for item "
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	342 f"{item!r}, we can't update attachments."
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	343 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	344 raise exceptions.NotFound("No attachment node available")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	345 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	346 raise e
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	347
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	348 async def subscribe(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	349 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	350 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	351 service: jid.JID,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	352 node: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	353 item: str,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	354 ) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	355 """Subscribe to attachment node targeting the item
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	356
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	357 @param service: service of target item (will also be used for attachment node)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	358 @param node: node of target item (used to get attachment node's name)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	359 @param item: name of target item (used to get attachment node's name)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	360 """
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	361 attachment_node = self.getAttachmentNodeName(service, node, item)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	362 await self._p.subscribe(client, service, attachment_node)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	363
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	364
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	365 def setTimestamp(self, attachment_elt: domish.Element, data: dict) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	366 """Check if a ``timestamp`` attribute is set, parse it, and fill data
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	367
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	368 @param attachments_elt: element where the ``timestamp`` attribute may be set
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	369 @param data: data specific to the attachment (i.e. not the whole microblog data)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	370 ``timestamp`` field will be set there if timestamp exists and is parsable
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	371 """
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	372 timestamp_raw = attachment_elt.getAttribute("timestamp")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	373 if timestamp_raw:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	374 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	375 timestamp = date_utils.date_parse(timestamp_raw)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	376 except date_utils.ParserError:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	377 log.warning(f"can't parse timestamp: {timestamp_raw}")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	378 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	379 data["timestamp"] = timestamp
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	380
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	381 def noticedGet(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	382 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	383 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	384 attachments_elt: domish.Element,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	385 data: Dict[str, Any],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	386 ) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	387 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	388 noticed_elt = next(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	389 attachments_elt.elements(NS_PUBSUB_ATTACHMENTS, "noticed")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	390 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	391 except StopIteration:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	392 pass
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	393 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	394 noticed_data = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	395 "noticed": True
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	396 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	397 self.setTimestamp(noticed_elt, noticed_data)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	398 data["noticed"] = noticed_data
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	399
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	400 def noticedSet(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	401 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	402 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	403 data: Dict[str, Any],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	404 former_elt: Optional[domish.Element]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	405 ) -> Optional[domish.Element]:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	406 """add or remove a <noticed> attachment
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	407
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	408 if data["noticed"] is True, element is added, if it's False, it's removed, and
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	409 it's not present or None, the former element is kept.
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	410 """
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	411 noticed = data["extra"].get("noticed")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	412 if noticed is None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	413 return former_elt
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	414 elif noticed:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	415 return domish.Element(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	416 (NS_PUBSUB_ATTACHMENTS, "noticed"),
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	417 attribs = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	418 "timestamp": xmpp_date()
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	419 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	420 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	421 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	422 return None
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	423
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	424 def reactionGet(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	425 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	426 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	427 attachments_elt: domish.Element,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	428 data: Dict[str, Any],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	429 ) -> None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	430 try:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	431 reaction_elt = next(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	432 attachments_elt.elements(NS_PUBSUB_ATTACHMENTS, "reaction")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	433 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	434 except StopIteration:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	435 pass
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	436 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	437 reaction_data = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	438 "reactions": str(reaction_elt)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	439 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	440 self.setTimestamp(reaction_elt, reaction_data)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	441 data["reaction"] = reaction_data
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	442
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	443 def reactionSet(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	444 self,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	445 client: SatXMPPEntity,
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	446 data: Dict[str, Any],
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	447 former_elt: Optional[domish.Element]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	448 ) -> Optional[domish.Element]:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	449 """update the <reaction> attachment"""
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	450 reaction = data["extra"].get("reaction")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	451 if reaction is None:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	452 return former_elt
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	453 operation_type = reaction.get("operation", "update")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	454 if operation_type == "update":
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	455 reactions = "".join(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	456 set(str(former_elt or ""))
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	457 \| set(reaction.get("reactions") or "")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	458 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	459 elif operation_type == "replace":
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	460 reactions = reaction.get("reactions", "")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	461 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	462 raise exceptions.DataError(f"invalid reaction operation: {operation_type!r}")
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	463 if reactions:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	464 reaction_elt = domish.Element(
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	465 (NS_PUBSUB_ATTACHMENTS, "reaction"),
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	466 attribs = {
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	467 "timestamp": xmpp_date()
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	468 }
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	469 )
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	470 reaction_elt.addContent(reactions)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	471 return reaction_elt
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	472 else:
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	473 return None
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	474
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	475
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	476 @implementer(iwokkel.IDisco)
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	477 class PubsubAttachments_Handler(xmlstream.XMPPHandler):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	478
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	479 def getDiscoInfo(self, requestor, service, nodeIdentifier=""):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	480 return [disco.DiscoFeature(NS_PUBSUB_ATTACHMENTS)]
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	481
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	482 def getDiscoItems(self, requestor, service, nodeIdentifier=""):
ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP: Goffi <goffi@goffi.org> parents: diff changeset	483 return []

3864

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

1 #!/usr/bin/env python3

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

2

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

3 # Libervia plugin for Pubsub Attachments

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

5

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

6 # This program is free software: you can redistribute it and/or modify

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

7 # it under the terms of the GNU Affero General Public License as published by

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

8 # the Free Software Foundation, either version 3 of the License, or

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

9 # (at your option) any later version.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

10

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

11 # This program is distributed in the hope that it will be useful,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

12 # but WITHOUT ANY WARRANTY; without even the implied warranty of

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

14 # GNU Affero General Public License for more details.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

15

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

16 # You should have received a copy of the GNU Affero General Public License

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

17 # along with this program. If not, see <http://www.gnu.org/licenses/>.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

18

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

19 from typing import List, Tuple, Dict, Any, Callable, Optional

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

20

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

21 from twisted.words.protocols.jabber import jid, xmlstream, error

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

22 from twisted.words.xish import domish

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

23 from twisted.internet import defer

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

24 from zope.interface import implementer

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

25 from wokkel import pubsub, disco, iwokkel

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

26

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

27 from sat.core.constants import Const as C

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

28 from sat.core.i18n import _

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

29 from sat.core.log import getLogger

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

30 from sat.core.core_types import SatXMPPEntity

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

31 from sat.core import exceptions

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

32 from sat.tools.common import uri, data_format, date_utils

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

33 from sat.tools.utils import xmpp_date

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

34

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

35

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

36 log = getLogger(__name__)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

37

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

38 IMPORT_NAME = "PUBSUB_ATTACHMENTS"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

39

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

40 PLUGIN_INFO = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

41 C.PI_NAME: "Pubsub Attachments",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

42 C.PI_IMPORT_NAME: IMPORT_NAME,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

43 C.PI_TYPE: C.PLUG_TYPE_EXP,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

44 C.PI_MODES: C.PLUG_MODE_BOTH,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

45 C.PI_PROTOCOLS: [],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

46 C.PI_DEPENDENCIES: ["XEP-0060"],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

47 C.PI_MAIN: "PubsubAttachments",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

48 C.PI_HANDLER: "yes",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

49 C.PI_DESCRIPTION: _("""Pubsub Attachments implementation"""),

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

50 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

51 NS_PREFIX = "urn:xmpp:pubsub-attachments:"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

52 NS_PUBSUB_ATTACHMENTS = f"{NS_PREFIX}0"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

53 NS_PUBSUB_ATTACHMENTS_SUM = f"{NS_PREFIX}summary:0"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

54

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

55

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

56 class PubsubAttachments:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

57 namespace = NS_PUBSUB_ATTACHMENTS

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

58

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

59 def __init__(self, host):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

60 log.info(_("Pubsub Attachments plugin initialization"))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

61 host.registerNamespace("pubsub-attachments", NS_PUBSUB_ATTACHMENTS)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

62 self.host = host

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

63 self._p = host.plugins["XEP-0060"]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

64 self.handlers = {}

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

65 host.trigger.add("XEP-0277_send", self.onMBSend)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

66 self.registerAttachmentHandler(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

67 "noticed", NS_PUBSUB_ATTACHMENTS, self.noticedGet, self.noticedSet

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

68 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

69 self.registerAttachmentHandler(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

70 "reaction", NS_PUBSUB_ATTACHMENTS, self.reactionGet, self.reactionSet

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

71 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

72 host.bridge.addMethod(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

73 "psAttachmentsGet",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

74 ".plugin",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

75 in_sign="sssasss",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

76 out_sign="(ss)",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

77 method=self._get,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

78 async_=True,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

79 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

80 host.bridge.addMethod(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

81 "psAttachmentsSet",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

82 ".plugin",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

83 in_sign="ss",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

84 out_sign="",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

85 method=self._set,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

86 async_=True,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

87 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

88

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

89 def getHandler(self, client):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

90 return PubsubAttachments_Handler()

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

91

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

92 def registerAttachmentHandler(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

93 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

94 name: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

95 namespace: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

96 get_cb: Callable[

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

97 [SatXMPPEntity, domish.Element, Dict[str, Any]],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

98 None],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

99 set_cb: Callable[

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

100 [SatXMPPEntity, Dict[str, Any], Optional[domish.Element]],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

101 Optional[domish.Element]],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

102 ) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

103 """Register callbacks to handle an attachment

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

104

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

105 @param name: name of the element

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

106 @param namespace: namespace of the element

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

107 (name, namespace) couple must be unique

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

108 @param get: method to call when attachments are retrieved

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

109 it will be called with (client, element, data) where element is the

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

110 <attachments> element to parse, and data must be updated in place with

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

111 parsed data

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

112 @param set: method to call when the attachment need to be set or udpated

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

113 it will be called with (client, data, former_elt of None if there was no

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

114 former element). When suitable, ``operation`` should be used to check if we

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

115 request an ``update`` or a ``replace``.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

116 """

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

117 key = (name, namespace)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

118 if key in self.handlers:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

119 raise exceptions.ConflictError(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

120 f"({name}, {namespace}) attachment handlers are already registered"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

121 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

122 self.handlers[(name, namespace)] = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

123 "get": get_cb,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

124 "set": set_cb

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

125 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

126

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

127 def getAttachmentNodeName(self, service: jid.JID, node: str, item: str) -> str:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

128 """Generate name to use for attachment node"""

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

129 target_item_uri = uri.buildXMPPUri(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

130 "pubsub",

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

131 path=service.userhost(),

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

132 node=node,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

133 item=item

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

134 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

135 return f"{NS_PUBSUB_ATTACHMENTS}/{target_item_uri}"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

136

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

137 def isAttachmentNode(self, node: str) -> bool:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

138 """Return True if node name is an attachment node"""

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

139 return node.startswith(f"{NS_PUBSUB_ATTACHMENTS}/")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

140

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

141 def attachmentNode2Item(self, node: str) -> Tuple[jid.JID, str, str]:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

142 """Retrieve service, node and item from attachement node's name"""

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

143 if not self.isAttachmentNode(node):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

144 raise ValueError("this is not an attachment node!")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

145 prefix_len = len(f"{NS_PUBSUB_ATTACHMENTS}/")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

146 item_uri = node[prefix_len:]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

147 parsed_uri = uri.parseXMPPUri(item_uri)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

148 if parsed_uri["type"] != "pubsub":

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

149 raise ValueError(f"unexpected URI type, it must be a pubsub URI: {item_uri}")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

150 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

151 service = jid.JID(parsed_uri["path"])

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

152 except RuntimeError:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

153 raise ValueError(f"invalid service in pubsub URI: {item_uri}")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

154 node = parsed_uri["node"]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

155 item = parsed_uri["item"]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

156 return (service, node, item)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

157

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

158 async def onMBSend(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

159 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

160 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

161 service: jid.JID,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

162 node: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

163 item: domish.Element,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

164 data: dict

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

165 ) -> bool:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

166 """trigger to create attachment node on each publication"""

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

167 node_config = await self._p.getConfiguration(client, service, node)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

168 attachment_node = self.getAttachmentNodeName(service, node, item["id"])

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

169 # we use the same options as target node

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

170 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

171 await self._p.createIfNewNode(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

172 client, service, attachment_node, options=dict(node_config)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

173 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

174 except Exception as e:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

175 log.warning(f"Can't create attachment node {attachment_node}: {e}]")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

176 return True

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

177

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

178 def items2attachmentData(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

179 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

180 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

181 items: List[domish.Element]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

182 ) -> List[Dict[str, Any]]:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

183 """Convert items from attachment node to attachment data"""

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

184 list_data = []

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

185 for item in items:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

186 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

187 attachments_elt = next(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

188 item.elements(NS_PUBSUB_ATTACHMENTS, "attachments")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

189 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

190 except StopIteration:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

191 log.warning(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

192 "item is missing <attachments> elements, ignoring it: {item.toXml()}"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

193 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

194 continue

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

195 item_id = item["id"]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

196 publisher_s = item.getAttribute("publisher")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

197 # publisher is not filled by all pubsub service, so we can't count on it

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

198 if publisher_s:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

199 publisher = jid.JID(publisher_s)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

200 if publisher.userhost() != item_id:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

201 log.warning(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

202 f"publisher {publisher.userhost()!r} doesn't correspond to item "

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

203 f"id {item['id']!r}, ignoring. This may be a hack attempt.\n"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

204 f"{item.toXml()}"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

205 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

206 continue

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

207 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

208 jid.JID(item_id)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

209 except RuntimeError:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

210 log.warning(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

211 "item ID is not a JID, this is not compliant and is ignored: "

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

212 f"{item.toXml}"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

213 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

214 continue

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

215 data = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

216 "from": item_id

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

217 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

218 for handler in self.handlers.values():

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

219 handler["get"](client, attachments_elt, data)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

220 if len(data) > 1:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

221 list_data.append(data)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

222 return list_data

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

223

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

224 def _get(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

225 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

226 service_s: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

227 node: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

228 item: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

229 senders_s: List[str],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

230 extra_s: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

231 profile_key: str

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

232 ) -> defer.Deferred:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

233 client = self.host.getClient(profile_key)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

234 extra = data_format.deserialise(extra_s)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

235 senders = [jid.JID(s) for s in senders_s]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

236 d = defer.ensureDeferred(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

237 self.getAttachments(client, jid.JID(service_s), node, item, senders)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

238 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

239 d.addCallback(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

240 lambda ret:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

241 (data_format.serialise(ret[0]),

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

242 data_format.serialise(ret[1]))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

243 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

244 return d

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

245

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

246 async def getAttachments(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

247 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

248 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

249 service: jid.JID,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

250 node: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

251 item: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

252 senders: Optional[List[jid.JID]],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

253 extra: Optional[dict] = None

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

254 ) -> Tuple[List[Dict[str, Any]], dict]:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

255 if extra is None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

256 extra = {}

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

257 attachment_node = self.getAttachmentNodeName(service, node, item)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

258 item_ids = [e.userhost() for e in senders] if senders else None

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

259 items, metadata = await self._p.getItems(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

260 client, service, attachment_node, item_ids=item_ids, extra=extra

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

261 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

262 list_data = self.items2attachmentData(client, items)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

263

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

264 return list_data, metadata

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

265

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

266 def _set(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

267 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

268 attachments_s: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

269 profile_key: str

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

270 ) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

271 client = self.host.getClient(profile_key)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

272 attachments = data_format.deserialise(attachments_s) or {}

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

273 return defer.ensureDeferred(self.setAttachments( client, attachments))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

274

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

275 async def setAttachments(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

276 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

277 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

278 data: Dict[str, Any]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

279 ) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

280 """Set or update attachments

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

281

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

282 Former <attachments> element will be retrieved and updated. Individual

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

283 attachments replace or update their elements individually, according to the

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

284 "operation" key.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

285

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

286 "operation" key may be "update" or "replace", and defaults to update, it is only

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

287 used in attachments where "update" makes sense (e.g. it's used for "reactions"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

288 but not for "noticed").

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

289

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

290 @param data: microblog data data. Various keys (usually stored in

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

291 data["extra"]) may be used depending on the attachments handlers

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

292 registered. The keys "service", "node" and "id" MUST be set.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

293 """

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

294 data.setdefault("extra", {})

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

295 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

296 service = jid.JID(data["service"])

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

297 node = data["node"]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

298 item = data["id"]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

299 except (KeyError, RuntimeError):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

300 raise ValueError(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

301 'data must have "service", "node" and "id" set'

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

302 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

303 attachment_node = self.getAttachmentNodeName(service, node, item)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

304 items, __ = await self._p.getItems(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

305 client, service, attachment_node, item_ids=[client.jid.userhost()]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

306 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

307 if not items:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

308 # the item doesn't exist, we create a new one

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

309 item_elt = pubsub.Item(client.jid.userhost())

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

310 item_elt.addElement((NS_PUBSUB_ATTACHMENTS, "attachments"))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

311 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

312 item_elt = items[0]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

313

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

314 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

315 attachments_elt = next(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

316 item_elt.elements(NS_PUBSUB_ATTACHMENTS, "attachments")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

317 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

318 except StopIteration:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

319 log.warning(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

320 f"no <attachments> element found, creating a new one: {item_elt.toXml()}"

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

321 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

322 attachments_elt = item_elt.addElement((NS_PUBSUB_ATTACHMENTS, "attachments"))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

323

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

324 for (name, namespace), handler in self.handlers.items():

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

325 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

326 former_elt = next(attachments_elt.elements(namespace, name))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

327 except StopIteration:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

328 former_elt = None

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

329 new_elt = handler["set"](client, data, former_elt)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

330 if new_elt != former_elt:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

331 if former_elt is not None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

332 attachments_elt.children.remove(former_elt)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

333 if new_elt is not None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

334 attachments_elt.addChild(new_elt)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

335 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

336 await self._p.sendItems(client, service, attachment_node, [item_elt])

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

337 except error.StanzaError as e:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

338 if e.condition == "item-not-found":

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

339 # the node doesn't exist, we can't publish attachments

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

340 log.warning(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

341 f"no attachment node found at {service} on {node!r} for item "

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

342 f"{item!r}, we can't update attachments."

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

343 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

344 raise exceptions.NotFound("No attachment node available")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

345 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

346 raise e

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

347

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

348 async def subscribe(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

349 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

350 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

351 service: jid.JID,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

352 node: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

353 item: str,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

354 ) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

355 """Subscribe to attachment node targeting the item

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

356

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

357 @param service: service of target item (will also be used for attachment node)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

358 @param node: node of target item (used to get attachment node's name)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

359 @param item: name of target item (used to get attachment node's name)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

360 """

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

361 attachment_node = self.getAttachmentNodeName(service, node, item)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

362 await self._p.subscribe(client, service, attachment_node)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

363

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

364

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

365 def setTimestamp(self, attachment_elt: domish.Element, data: dict) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

366 """Check if a ``timestamp`` attribute is set, parse it, and fill data

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

367

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

368 @param attachments_elt: element where the ``timestamp`` attribute may be set

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

369 @param data: data specific to the attachment (i.e. not the whole microblog data)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

370 ``timestamp`` field will be set there if timestamp exists and is parsable

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

371 """

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

372 timestamp_raw = attachment_elt.getAttribute("timestamp")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

373 if timestamp_raw:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

374 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

375 timestamp = date_utils.date_parse(timestamp_raw)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

376 except date_utils.ParserError:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

377 log.warning(f"can't parse timestamp: {timestamp_raw}")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

378 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

379 data["timestamp"] = timestamp

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

380

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

381 def noticedGet(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

382 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

383 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

384 attachments_elt: domish.Element,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

385 data: Dict[str, Any],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

386 ) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

387 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

388 noticed_elt = next(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

389 attachments_elt.elements(NS_PUBSUB_ATTACHMENTS, "noticed")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

390 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

391 except StopIteration:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

392 pass

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

393 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

394 noticed_data = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

395 "noticed": True

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

396 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

397 self.setTimestamp(noticed_elt, noticed_data)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

398 data["noticed"] = noticed_data

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

399

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

400 def noticedSet(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

401 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

402 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

403 data: Dict[str, Any],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

404 former_elt: Optional[domish.Element]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

405 ) -> Optional[domish.Element]:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

406 """add or remove a <noticed> attachment

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

407

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

408 if data["noticed"] is True, element is added, if it's False, it's removed, and

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

409 it's not present or None, the former element is kept.

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

410 """

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

411 noticed = data["extra"].get("noticed")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

412 if noticed is None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

413 return former_elt

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

414 elif noticed:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

415 return domish.Element(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

416 (NS_PUBSUB_ATTACHMENTS, "noticed"),

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

417 attribs = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

418 "timestamp": xmpp_date()

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

419 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

420 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

421 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

422 return None

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

423

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

424 def reactionGet(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

425 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

426 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

427 attachments_elt: domish.Element,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

428 data: Dict[str, Any],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

429 ) -> None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

430 try:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

431 reaction_elt = next(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

432 attachments_elt.elements(NS_PUBSUB_ATTACHMENTS, "reaction")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

433 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

434 except StopIteration:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

435 pass

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

436 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

437 reaction_data = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

438 "reactions": str(reaction_elt)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

439 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

440 self.setTimestamp(reaction_elt, reaction_data)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

441 data["reaction"] = reaction_data

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

442

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

443 def reactionSet(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

444 self,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

445 client: SatXMPPEntity,

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

446 data: Dict[str, Any],

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

447 former_elt: Optional[domish.Element]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

448 ) -> Optional[domish.Element]:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

449 """update the <reaction> attachment"""

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

450 reaction = data["extra"].get("reaction")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

451 if reaction is None:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

452 return former_elt

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

453 operation_type = reaction.get("operation", "update")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

454 if operation_type == "update":

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

455 reactions = "".join(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

456 set(str(former_elt or ""))

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

457 | set(reaction.get("reactions") or "")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

458 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

459 elif operation_type == "replace":

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

460 reactions = reaction.get("reactions", "")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

461 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

462 raise exceptions.DataError(f"invalid reaction operation: {operation_type!r}")

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

463 if reactions:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

464 reaction_elt = domish.Element(

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

465 (NS_PUBSUB_ATTACHMENTS, "reaction"),

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

466 attribs = {

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

467 "timestamp": xmpp_date()

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

468 }

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

469 )

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

470 reaction_elt.addContent(reactions)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

471 return reaction_elt

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

472 else:

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

473 return None

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

474

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

475

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

476 @implementer(iwokkel.IDisco)

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

477 class PubsubAttachments_Handler(xmlstream.XMPPHandler):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

478

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

479 def getDiscoInfo(self, requestor, service, nodeIdentifier=""):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

480 return [disco.DiscoFeature(NS_PUBSUB_ATTACHMENTS)]

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

481

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

482 def getDiscoItems(self, requestor, service, nodeIdentifier=""):

ac255a0fbd4c plugin pubsub attachments: partial implementation of pubsub-attachments protoXEP:

Goffi <goffi@goffi.org>

parents:

diff changeset

483 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_pubsub_attachments.py @ 3864:ac255a0fbd4c