libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0277.py @ 3817:998c5318230f

plugin identity: make the plugin compatible with component + description: the plugin can now be used with components. the new `description` field is now available. rel 368

author	Goffi <goffi@goffi.org>
date	Wed, 29 Jun 2022 11:49:03 +0200
parents	b2ade5ecdbab
children	5b192a5eb72d

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	3 # SAT plugin for microblogging over XMPP (xep-0277)
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3341 diff changeset	4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	5
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	6 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	9 # (at your option) any later version.
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	10
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	11 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	14 # GNU Affero General Public License for more details.
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	15
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	16 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	18
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	19 import time
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	20 import dateutil
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	21 import calendar
3502 6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	22 from secrets import token_urlsafe
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	23 from typing import Optional
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	24 from functools import partial
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	25
3502 6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	26 import shortuuid
6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	27
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	28 from twisted.words.protocols.jabber import jid, error
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	29 from twisted.words.protocols.jabber.xmlstream import XMPPHandler
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	30 from twisted.words.xish import domish
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	31 from twisted.internet import defer
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	32 from twisted.python import failure
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	33
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	34 # XXX: sat_tmp.wokkel.pubsub is actually used instead of wokkel version
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	35 from wokkel import pubsub
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	36 from wokkel import disco, iwokkel
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	37 from zope.interface import implementer
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	38
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	39 from sat.core.i18n import _
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	40 from sat.core.constants import Const as C
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	41 from sat.core.log import getLogger
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	42 from sat.core import exceptions
3680 68f2a9c171d1 plugin XEP-0277: import `SatXMPPEntity` from core_types Goffi <goffi@goffi.org> parents: 3661 diff changeset	43 from sat.core.core_types import SatXMPPEntity
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	44 from sat.tools import xml_tools
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	45 from sat.tools import sat_defer
1935 1128feb54180 core: removed pyfeed and xe dependencies: Goffi <goffi@goffi.org> parents: 1934 diff changeset	46 from sat.tools import utils
1919 d3354c80bd1f core (tools): moved common to a separate package, and put data method in a data_format module Goffi <goffi@goffi.org> parents: 1913 diff changeset	47 from sat.tools.common import data_format
2480 dc55b854ccf3 plugin XEP-0277: use shortuuid instead of uuid + use item's XMPP URI for atom ID Goffi <goffi@goffi.org> parents: 2475 diff changeset	48 from sat.tools.common import uri as xmpp_uri
3502 6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	49 from sat.tools.common import regex
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	50
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	51
3179 84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3137 diff changeset	52 log = getLogger(__name__)
84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3137 diff changeset	53
84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3137 diff changeset	54
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	55 NS_MICROBLOG = "urn:xmpp:microblog:0"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	56 NS_ATOM = "http://www.w3.org/2005/Atom"
3598 d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	57 NS_PUBSUB_EVENT = f"{pubsub.NS_PUBSUB}#event"
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	58 NS_COMMENT_PREFIX = f"{NS_MICROBLOG}:comments/"
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	59
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	60
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	61 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2117 diff changeset	62 C.PI_NAME: "Microblogging over XMPP Plugin",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2117 diff changeset	63 C.PI_IMPORT_NAME: "XEP-0277",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2117 diff changeset	64 C.PI_TYPE: "XEP",
3726 33d75cd3c371 plugin XEP-0060, XEP-0163, XEP-0277, text syntaxes: make those plugins usable with components Goffi <goffi@goffi.org> parents: 3724 diff changeset	65 C.PI_MODES: C.PLUG_MODE_BOTH,
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2117 diff changeset	66 C.PI_PROTOCOLS: ["XEP-0277"],
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	67 C.PI_DEPENDENCIES: ["XEP-0163", "XEP-0060", "TEXT_SYNTAXES"],
3598 d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	68 C.PI_RECOMMENDATIONS: ["XEP-0059", "EXTRA-PEP", "PUBSUB_CACHE"],
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2117 diff changeset	69 C.PI_MAIN: "XEP_0277",
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	70 C.PI_HANDLER: "yes",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	71 C.PI_DESCRIPTION: _("""Implementation of microblogging Protocol"""),
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	72 }
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	73
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	74
339 b0b773f432e5 plugin XEP-00277: setMicroblogAccess is now asynchronous Goffi <goffi@goffi.org> parents: 311 diff changeset	75 class NodeAccessChangeException(Exception):
b0b773f432e5 plugin XEP-00277: setMicroblogAccess is now asynchronous Goffi <goffi@goffi.org> parents: 311 diff changeset	76 pass
b0b773f432e5 plugin XEP-00277: setMicroblogAccess is now asynchronous Goffi <goffi@goffi.org> parents: 311 diff changeset	77
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	78
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	79 class XEP_0277(object):
1831 68c0dc13d821 plugin blog import, XEP-0277: progress + redirect: Goffi <goffi@goffi.org> parents: 1829 diff changeset	80 namespace = NS_MICROBLOG
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	81 NS_ATOM = NS_ATOM
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	82
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	83 def __init__(self, host):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	84 log.info(_("Microblogging plugin initialization"))
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	85 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	86 host.registerNamespace("microblog", NS_MICROBLOG)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	87 self._p = self.host.plugins[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	88 "XEP-0060"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	89 ] # this facilitate the access to pubsub plugin
3598 d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	90 ps_cache = self.host.plugins.get("PUBSUB_CACHE")
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	91 if ps_cache is not None:
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	92 ps_cache.registerAnalyser(
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	93 {
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	94 "name": "XEP-0277",
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	95 "node": NS_MICROBLOG,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	96 "namespace": NS_ATOM,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	97 "type": "blog",
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	98 "to_sync": True,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	99 "parser": self.item2mbdata,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	100 "match_cb": self._cacheNodeMatchCb,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	101 }
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	102 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	103 self.rt_sessions = sat_defer.RTDeferredSessions()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	104 self.host.plugins["XEP-0060"].addManagedNode(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	105 NS_MICROBLOG, items_cb=self._itemsReceived
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	106 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	107
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	108 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	109 "mbSend",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	110 ".plugin",
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	111 in_sign="ssss",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	112 out_sign="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	113 method=self._mbSend,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	114 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	115 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	116 host.bridge.addMethod(
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	117 "mbPreview",
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	118 ".plugin",
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	119 in_sign="ssss",
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	120 out_sign="s",
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	121 method=self._mbPreview,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	122 async_=True,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	123 )
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	124 host.bridge.addMethod(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	125 "mbRetract",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	126 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	127 in_sign="ssss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	128 out_sign="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	129 method=self._mbRetract,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	130 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	131 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	132 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	133 "mbGet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	134 ".plugin",
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	135 in_sign="ssiasss",
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	136 out_sign="s",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	137 method=self._mbGet,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	138 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	139 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	140 host.bridge.addMethod(
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	141 "mbRename",
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	142 ".plugin",
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	143 in_sign="sssss",
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	144 out_sign="",
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	145 method=self._mbRename,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	146 async_=True,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	147 )
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	148 host.bridge.addMethod(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	149 "mbSetAccess",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	150 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	151 in_sign="ss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	152 out_sign="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	153 method=self.mbSetAccess,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	154 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	155 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	156 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	157 "mbSubscribeToMany",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	158 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	159 in_sign="sass",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	160 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	161 method=self._mbSubscribeToMany,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	162 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	163 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	164 "mbGetFromManyRTResult",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	165 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	166 in_sign="ss",
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	167 out_sign="(ua(sssasa{ss}))",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	168 method=self._mbGetFromManyRTResult,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	169 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	170 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	171 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	172 "mbGetFromMany",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	173 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	174 in_sign="sasia{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	175 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	176 method=self._mbGetFromMany,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	177 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	178 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	179 "mbGetFromManyWithCommentsRTResult",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	180 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	181 in_sign="ss",
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	182 out_sign="(ua(sssa(sa(sssasa{ss}))a{ss}))",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	183 method=self._mbGetFromManyWithCommentsRTResult,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	184 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	185 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	186 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	187 "mbGetFromManyWithComments",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	188 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	189 in_sign="sasiia{ss}a{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	190 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	191 method=self._mbGetFromManyWithComments,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	192 )
3762 becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	193 host.bridge.addMethod(
becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	194 "mbIsCommentNode",
becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	195 ".plugin",
becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	196 in_sign="s",
becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	197 out_sign="b",
becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	198 method=self.isCommentNode,
becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	199 )
302 9f3a6cf91668 plugin xep-0277: added getLastMicroblogs method Goffi <goffi@goffi.org> parents: 297 diff changeset	200
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	201 def getHandler(self, client):
f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	202 return XEP_0277_handler()
f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	203
3598 d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	204 def _cacheNodeMatchCb(
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	205 self,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	206 client: SatXMPPEntity,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	207 analyse: dict,
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	208 ) -> None:
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	209 """Check is analysed node is a comment and fill analyse accordingly"""
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	210 if analyse["node"].startswith(NS_COMMENT_PREFIX):
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	211 analyse["subtype"] = "comment"
d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	212
1656 069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	213 def _checkFeaturesCb(self, available):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	214 return {"available": C.BOOL_TRUE}
1656 069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	215
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	216 def _checkFeaturesEb(self, fail):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	217 return {"available": C.BOOL_FALSE}
1656 069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	218
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	219 def getFeatures(self, profile):
2148 a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods Goffi <goffi@goffi.org> parents: 2145 diff changeset	220 client = self.host.getClient(profile)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	221 d = self.host.checkFeatures(client, [], identity=("pubsub", "pep"))
1656 069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	222 d.addCallbacks(self._checkFeaturesCb, self._checkFeaturesEb)
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	223 return d
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	224
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	225 ## plugin management methods ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	226
2305 972e33507609 plugin XEP-0060: addManagedNode callbacks now use client syntax instead of profile Goffi <goffi@goffi.org> parents: 2289 diff changeset	227 def _itemsReceived(self, client, itemsEvent):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	228 """Callback which manage items notifications (publish + retract)"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	229
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	230 def manageItem(data, event):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	231 self.host.bridge.psEvent(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	232 C.PS_MICROBLOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	233 itemsEvent.sender.full(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	234 itemsEvent.nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	235 event,
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	236 data_format.serialise(data),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	237 client.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	238 )
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	239
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	240 for item in itemsEvent.items:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	241 if item.name == C.PS_ITEM:
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	242 # FIXME: service and node should be used here
3341 13b91b7280bc plugin XEP-0277: fixed item2mbdata call Goffi <goffi@goffi.org> parents: 3328 diff changeset	243 self.item2mbdata(client, item, None, None).addCallbacks(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	244 manageItem, lambda failure: None, (C.PS_PUBLISH,)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	245 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	246 elif item.name == C.PS_RETRACT:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	247 manageItem({"id": item["id"]}, C.PS_RETRACT)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	248 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	249 raise exceptions.InternalError("Invalid event value")
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	250
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	251 ## data/item transformation ##
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	252
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	253 @defer.inlineCallbacks
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	254 def item2mbdata(
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	255 self,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	256 client: SatXMPPEntity,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	257 item_elt: domish.Element,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	258 service: Optional[jid.JID],
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	259 # FIXME: node is Optional until all calls to item2mbdata set properly service
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	260 # and node. Once done, the Optional must be removed here
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	261 node: Optional[str]
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	262 ) -> dict:
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	263 """Convert an XML Item to microblog data
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	264
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	265 @param item_elt: microblog item element
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	266 @param service: PubSub service where the item has been retrieved
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	267 profile's PEP is used when service is None
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	268 @param node: PubSub node where the item has been retrieved
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	269 if None, "uri" won't be set
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	270 @return: microblog data
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	271 """
3763 b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	272 if service is None:
b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	273 service = client.jid.userhostJID()
b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	274
b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	275 microblog_data = {"service": service.full()}
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	276
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	277 def check_conflict(key, increment=False):
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	278 """Check if key is already in microblog data
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	279
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	280 @param key(unicode): key to check
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	281 @param increment(bool): if suffix the key with an increment
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	282 instead of raising an exception
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	283 @raise exceptions.DataError: the key already exists
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	284 (not raised if increment is True)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	285 """
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	286 if key in microblog_data:
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	287 if not increment:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	288 raise failure.Failure(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	289 exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	290 "key {} is already present for item {}"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	291 ).format(key, item_elt["id"])
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	292 )
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	293 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	294 idx = 1 # the idx 0 is the key without suffix
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	295 fmt = "{}#{}"
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	296 new_key = fmt.format(key, idx)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	297 while new_key in microblog_data:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	298 idx += 1
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	299 new_key = fmt.format(key, idx)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	300 key = new_key
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	301 return key
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	302
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	303 @defer.inlineCallbacks
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	304 def parseElement(elem):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	305 """Parse title/content elements and fill microblog_data accordingly"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	306 type_ = elem.getAttribute("type")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	307 if type_ == "xhtml":
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	308 data_elt = elem.firstChildElement()
1709 c47ba491a85a plugin XEP-0277: raise a failure if XHTML content is not wrapped in a <div/> Goffi <goffi@goffi.org> parents: 1708 diff changeset	309 if data_elt is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	310 raise failure.Failure(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	311 exceptions.DataError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	312 "XHML content not wrapped in a <div/> element, this is not "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	313 "standard !"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	314 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	315 )
1822 aaf034bc6f7a plugin XEP-0277: moved NS_XHTML namespace to constants + adapted parsing to new behaviour of ElementParser Goffi <goffi@goffi.org> parents: 1821 diff changeset	316 if data_elt.uri != C.NS_XHTML:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	317 raise failure.Failure(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	318 exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	319 _("Content of type XHTML must declare its namespace!")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	320 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	321 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	322 key = check_conflict("{}_xhtml".format(elem.name))
1791 1359ad0b37c2 reverted patch 3770d13776e8 Goffi <goffi@goffi.org> parents: 1779 diff changeset	323 data = data_elt.toXml()
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	324 microblog_data[key] = yield self.host.plugins["TEXT_SYNTAXES"].cleanXHTML(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	325 data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	326 )
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	327 else:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	328 key = check_conflict(elem.name)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	329 microblog_data[key] = str(elem)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	330
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	331 id_ = item_elt.getAttribute("id", "") # there can be no id for transient nodes
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	332 microblog_data["id"] = id_
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	333 if item_elt.uri not in (pubsub.NS_PUBSUB, NS_PUBSUB_EVENT):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	334 msg = "Unsupported namespace {ns} in pubsub item {id_}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	335 ns=item_elt.uri, id_=id_
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	336 )
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	337 log.warning(msg)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	338 raise failure.Failure(exceptions.DataError(msg))
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	339
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	340 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	341 entry_elt = next(item_elt.elements(NS_ATOM, "entry"))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	342 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	343 msg = "No atom entry found in the pubsub item {}".format(id_)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	344 raise failure.Failure(exceptions.DataError(msg))
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	345
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	346 # uri
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	347 # FIXME: node should alway be set in the future, check FIXME in method signature
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	348 if node is not None:
3763 b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	349 microblog_data["node"] = node
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	350 microblog_data['uri'] = xmpp_uri.buildXMPPUri(
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	351 "pubsub",
3763 b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	352 path=service.full(),
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	353 node=node,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	354 item=id_,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	355 )
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	356
2264 a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	357 # language
a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	358 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	359 microblog_data["language"] = entry_elt[(C.NS_XML, "lang")].strip()
2264 a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	360 except KeyError:
a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	361 pass
a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	362
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	363 # atom:id
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	364 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	365 id_elt = next(entry_elt.elements(NS_ATOM, "id"))
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	366 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	367 msg = ("No atom id found in the pubsub item {}, this is not standard !"
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	368 .format(id_))
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	369 log.warning(msg)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	370 microblog_data["atom_id"] = ""
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	371 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	372 microblog_data["atom_id"] = str(id_elt)
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	373
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	374 # title/content(s)
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	375
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	376 # FIXME: ATOM and XEP-0277 only allow 1 <title/> element
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	377 # but in the wild we have some blogs with several ones
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	378 # so we don't respect the standard for now (it doesn't break
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	379 # anything anyway), and we'll find a better option later
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	380 # try:
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	381 # title_elt = entry_elt.elements(NS_ATOM, 'title').next()
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	382 # except StopIteration:
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	383 # msg = u'No atom title found in the pubsub item {}'.format(id_)
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	384 # raise failure.Failure(exceptions.DataError(msg))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	385 title_elts = list(entry_elt.elements(NS_ATOM, "title"))
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	386 if not title_elts:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	387 msg = "No atom title found in the pubsub item {}".format(id_)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	388 raise failure.Failure(exceptions.DataError(msg))
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	389 for title_elt in title_elts:
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	390 yield parseElement(title_elt)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	391
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	392 # FIXME: as for <title/>, Atom only authorise at most 1 content
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	393 # but XEP-0277 allows several ones. So for no we handle as
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	394 # if more than one can be present
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	395 for content_elt in entry_elt.elements(NS_ATOM, "content"):
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	396 yield parseElement(content_elt)
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	397
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	398 # we check that text content is present
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	399 for key in ("title", "content"):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	400 if key not in microblog_data and ("{}_xhtml".format(key)) in microblog_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	401 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	402 "item {id_} provide a {key}_xhtml data but not a text one".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	403 id_=id_, key=key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	404 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	405 )
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	406 # ... and do the conversion if it's not
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	407 microblog_data[key] = yield self.host.plugins["TEXT_SYNTAXES"].convert(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	408 microblog_data["{}_xhtml".format(key)],
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	409 self.host.plugins["TEXT_SYNTAXES"].SYNTAX_XHTML,
85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	410 self.host.plugins["TEXT_SYNTAXES"].SYNTAX_TEXT,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	411 False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	412 )
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	413
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	414 if "content" not in microblog_data:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	415 # use the atom title data as the microblog body content
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	416 microblog_data["content"] = microblog_data["title"]
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	417 del microblog_data["title"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	418 if "title_xhtml" in microblog_data:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	419 microblog_data["content_xhtml"] = microblog_data["title_xhtml"]
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	420 del microblog_data["title_xhtml"]
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	421
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	422 # published/updated dates
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	423 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	424 updated_elt = next(entry_elt.elements(NS_ATOM, "updated"))
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	425 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	426 msg = "No atom updated element found in the pubsub item {}".format(id_)
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	427 raise failure.Failure(exceptions.DataError(msg))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	428 microblog_data["updated"] = calendar.timegm(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	429 dateutil.parser.parse(str(updated_elt)).utctimetuple()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	430 )
302 9f3a6cf91668 plugin xep-0277: added getLastMicroblogs method Goffi <goffi@goffi.org> parents: 297 diff changeset	431 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	432 published_elt = next(entry_elt.elements(NS_ATOM, "published"))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	433 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	434 microblog_data["published"] = microblog_data["updated"]
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	435 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	436 microblog_data["published"] = calendar.timegm(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	437 dateutil.parser.parse(str(published_elt)).utctimetuple()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	438 )
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	439
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	440 # links
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	441 comments = microblog_data['comments'] = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	442 for link_elt in entry_elt.elements(NS_ATOM, "link"):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	443 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	444 link_elt.getAttribute("rel") == "replies"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	445 and link_elt.getAttribute("title") == "comments"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	446 ):
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	447 uri = link_elt["href"]
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	448 comments_data = {
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	449 "uri": uri,
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	450 }
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	451 try:
3763 b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	452 comment_service, comment_node = self.parseCommentUrl(uri)
3069 73db9db8b9e1 plugin XEP-0277: fixed comments URLs parsing Goffi <goffi@goffi.org> parents: 3028 diff changeset	453 except Exception as e:
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	454 log.warning(f"Can't parse comments url: {e}")
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	455 continue
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	456 else:
3763 b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	457 comments_data["service"] = comment_service.full()
b2ade5ecdbab plugin XEP-0277: be sure to have `service` set in `item2mbdata` and `node` when provided Goffi <goffi@goffi.org> parents: 3762 diff changeset	458 comments_data["node"] = comment_node
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	459 comments.append(comments_data)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	460 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	461 rel = link_elt.getAttribute("rel", "")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	462 title = link_elt.getAttribute("title", "")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	463 href = link_elt.getAttribute("href", "")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	464 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	465 "Unmanaged link element: rel={rel} title={title} href={href}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	466 rel=rel, title=title, href=href
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	467 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	468 )
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	469
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	470 # author
3492 fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	471 publisher = item_elt.getAttribute("publisher")
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	472 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	473 author_elt = next(entry_elt.elements(NS_ATOM, "author"))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	474 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	475 log.debug("Can't find author element in item {}".format(id_))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	476 else:
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	477 # name
770 64dd7c0f4feb plugin groupblog, XEP-0277: store both published and updated timestamps souliane <souliane@mailoo.org> parents: 745 diff changeset	478 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	479 name_elt = next(author_elt.elements(NS_ATOM, "name"))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	480 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	481 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	482 "No name element found in author element of item {}".format(id_)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	483 )
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	484 author = None
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	485 else:
3550 7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	486 author = microblog_data["author"] = str(name_elt).strip()
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	487 # uri
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	488 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	489 uri_elt = next(author_elt.elements(NS_ATOM, "uri"))
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	490 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	491 log.debug(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	492 "No uri element found in author element of item {}".format(id_)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	493 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	494 if publisher:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	495 microblog_data["author_jid"] = publisher
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	496 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	497 uri = str(uri_elt)
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	498 if uri.startswith("xmpp:"):
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	499 uri = uri[5:]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	500 microblog_data["author_jid"] = uri
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	501 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	502 microblog_data["author_jid"] = (
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	503 item_elt.getAttribute("publisher") or ""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	504 )
3550 7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	505 if not author and microblog_data["author_jid"]:
7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	506 # FIXME: temporary workaround for missing author name, would be
7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	507 # better to use directly JID's identity (to be done from frontends?)
7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	508 try:
7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	509 microblog_data["author"] = jid.JID(microblog_data["author_jid"]).user
7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	510 except Exception as e:
7df12ffa6620 plugin XEP-0277: "user" part of author jid is used for author name when later is missing Goffi <goffi@goffi.org> parents: 3548 diff changeset	511 log.warning(f"No author name found, and can't parse author jid: {e}")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	512
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	513 if not publisher:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	514 log.debug("No publisher attribute, we can't verify author jid")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	515 microblog_data["author_jid_verified"] = False
1681 c6c835046681 plugin XEP-0277: minor fixes for publisher attribute Goffi <goffi@goffi.org> parents: 1680 diff changeset	516 elif jid.JID(publisher).userhostJID() == jid.JID(uri).userhostJID():
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	517 microblog_data["author_jid_verified"] = True
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	518 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	519 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	520 "item atom:uri differ from publisher attribute, spoofing "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	521 "attempt ? atom:uri = {} publisher = {}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	522 uri, item_elt.getAttribute("publisher")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	523 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	524 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	525 microblog_data["author_jid_verified"] = False
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	526 # email
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	527 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	528 email_elt = next(author_elt.elements(NS_ATOM, "email"))
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	529 except StopIteration:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	530 pass
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	531 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	532 microblog_data["author_email"] = str(email_elt)
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	533
3493 b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	534 if not microblog_data.get("author_jid"):
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	535 if publisher:
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	536 microblog_data["author_jid"] = publisher
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	537 microblog_data["author_jid_verified"] = True
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	538 else:
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	539 iq_elt = xml_tools.findAncestor(item_elt, "iq", C.NS_CLIENT)
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	540 microblog_data["author_jid"] = iq_elt["from"]
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	541 microblog_data["author_jid_verified"] = False
b54bdd4ec507 plugin XEP-0277: be sure to have an `author_jid` set Goffi <goffi@goffi.org> parents: 3492 diff changeset	542
3492 fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	543 # categories
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	544 categories = [
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	545 category_elt.getAttribute("term", "")
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	546 for category_elt in entry_elt.elements(NS_ATOM, "category")
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	547 ]
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	548 microblog_data["tags"] = categories
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	549
1671 1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	550 ## the trigger ##
1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	551 # if other plugins have things to add or change
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	552 yield self.host.trigger.point(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	553 "XEP-0277_item2data", item_elt, entry_elt, microblog_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	554 )
1671 1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	555
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	556 defer.returnValue(microblog_data)
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	557
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	558 async def data2entry(self, client, data, item_id, service, node):
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	559 """Convert a data dict to en entry usable to create an item
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	560
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	561 @param data: data dict as given by bridge method.
2480 dc55b854ccf3 plugin XEP-0277: use shortuuid instead of uuid + use item's XMPP URI for atom ID Goffi <goffi@goffi.org> parents: 2475 diff changeset	562 @param item_id(unicode): id of the item to use
dc55b854ccf3 plugin XEP-0277: use shortuuid instead of uuid + use item's XMPP URI for atom ID Goffi <goffi@goffi.org> parents: 2475 diff changeset	563 @param service(jid.JID, None): pubsub service where the item is sent
dc55b854ccf3 plugin XEP-0277: use shortuuid instead of uuid + use item's XMPP URI for atom ID Goffi <goffi@goffi.org> parents: 2475 diff changeset	564 Needed to construct Atom id
dc55b854ccf3 plugin XEP-0277: use shortuuid instead of uuid + use item's XMPP URI for atom ID Goffi <goffi@goffi.org> parents: 2475 diff changeset	565 @param node(unicode): pubsub node where the item is sent
dc55b854ccf3 plugin XEP-0277: use shortuuid instead of uuid + use item's XMPP URI for atom ID Goffi <goffi@goffi.org> parents: 2475 diff changeset	566 Needed to construct Atom id
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	567 @return: deferred which fire domish.Element
be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	568 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	569 entry_elt = domish.Element((NS_ATOM, "entry"))
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	570
2264 a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	571 ## language ##
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	572 if "language" in data:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	573 entry_elt[(C.NS_XML, "lang")] = data["language"].strip()
2264 a8eaaac4d80f plugin XEP-0277, tools/common/data_objects: language handling Goffi <goffi@goffi.org> parents: 2243 diff changeset	574
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	575 ## content and title ##
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	576 synt = self.host.plugins["TEXT_SYNTAXES"]
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	577
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	578 for elem_name in ("title", "content"):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	579 for type_ in ["", "_rich", "_xhtml"]:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	580 attr = "{}{}".format(elem_name, type_)
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	581 if attr in data:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	582 elem = entry_elt.addElement(elem_name)
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	583 if type_:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	584 if type_ == "_rich": # convert input from current syntax to XHTML
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	585 xml_content = await synt.convert(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	586 data[attr], synt.getCurrentSyntax(client.profile), "XHTML"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	587 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	588 if "{}_xhtml".format(elem_name) in data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	589 raise failure.Failure(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	590 exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	591 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	592 "Can't have xhtml and rich content at the same time"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	593 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	594 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	595 )
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1814 diff changeset	596 else:
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1814 diff changeset	597 xml_content = data[attr]
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	598
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	599 div_elt = xml_tools.ElementParser()(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	600 xml_content, namespace=C.NS_XHTML
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	601 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	602 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	603 div_elt.name != "div"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	604 or div_elt.uri != C.NS_XHTML
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	605 or div_elt.attributes
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	606 ):
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1814 diff changeset	607 # we need a wrapping <div/> at the top with XHTML namespace
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	608 wrap_div_elt = domish.Element((C.NS_XHTML, "div"))
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1814 diff changeset	609 wrap_div_elt.addChild(div_elt)
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1814 diff changeset	610 div_elt = wrap_div_elt
1802 fed95a6c56f8 plugin (xep-0277): avoid wrapping XML in an extra <div> in data2entry Goffi <goffi@goffi.org> parents: 1791 diff changeset	611 elem.addChild(div_elt)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	612 elem["type"] = "xhtml"
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	613 if elem_name not in data:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	614 # there is raw text content, which is mandatory
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	615 # so we create one from xhtml content
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	616 elem_txt = entry_elt.addElement(elem_name)
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	617 text_content = await self.host.plugins[
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	618 "TEXT_SYNTAXES"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	619 ].convert(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	620 xml_content,
2780 85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	621 self.host.plugins["TEXT_SYNTAXES"].SYNTAX_XHTML,
85d3240a400f plugin text syntaxes: changed import name to TEXT_SYNTAX (better with underscore for autocompletion) Goffi <goffi@goffi.org> parents: 2771 diff changeset	622 self.host.plugins["TEXT_SYNTAXES"].SYNTAX_TEXT,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	623 False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	624 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	625 elem_txt.addContent(text_content)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	626 elem_txt["type"] = "text"
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	627
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	628 else: # raw text only needs to be escaped to get HTML-safe sequence
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	629 elem.addContent(data[attr])
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	630 elem["type"] = "text"
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	631
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	632 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	633 next(entry_elt.elements(NS_ATOM, "title"))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	634 except StopIteration:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	635 # we have no title element which is mandatory
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	636 # so we transform content element to title
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	637 elems = list(entry_elt.elements(NS_ATOM, "content"))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	638 if not elems:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	639 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	640 "There must be at least one content or title element"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	641 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	642 for elem in elems:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	643 elem.name = "title"
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	644
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	645 ## author ##
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	646 author_elt = entry_elt.addElement("author")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	647 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	648 author_name = data["author"]
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	649 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	650 # FIXME: must use better name
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	651 author_name = client.jid.user
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	652 author_elt.addElement("name", content=author_name)
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	653
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	654 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	655 author_jid_s = data["author_jid"]
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	656 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	657 author_jid_s = client.jid.userhost()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	658 author_elt.addElement("uri", content="xmpp:{}".format(author_jid_s))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	659
1820 3c8cf120a0fd plugin XEP-0277: added missing author_email parsing Goffi <goffi@goffi.org> parents: 1817 diff changeset	660 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	661 author_jid_s = data["author_email"]
1820 3c8cf120a0fd plugin XEP-0277: added missing author_email parsing Goffi <goffi@goffi.org> parents: 1817 diff changeset	662 except KeyError:
3c8cf120a0fd plugin XEP-0277: added missing author_email parsing Goffi <goffi@goffi.org> parents: 1817 diff changeset	663 pass
3c8cf120a0fd plugin XEP-0277: added missing author_email parsing Goffi <goffi@goffi.org> parents: 1817 diff changeset	664
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	665 ## published/updated time ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	666 current_time = time.time()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	667 entry_elt.addElement(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	668 "updated", content=utils.xmpp_date(float(data.get("updated", current_time)))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	669 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	670 entry_elt.addElement(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	671 "published",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	672 content=utils.xmpp_date(float(data.get("published", current_time))),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	673 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	674
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	675 ## categories ##
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	676 for tag in data.get('tags', []):
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	677 category_elt = entry_elt.addElement("category")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	678 category_elt["term"] = tag
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	679
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	680 ## id ##
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	681 entry_id = data.get(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	682 "id",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	683 xmpp_uri.buildXMPPUri(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	684 "pubsub",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	685 path=service.full() if service is not None else client.jid.userhost(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	686 node=node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	687 item=item_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	688 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	689 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	690 entry_elt.addElement("id", content=entry_id) #
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	691
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	692 ## comments ##
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	693 for comments_data in data.get('comments', []):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	694 link_elt = entry_elt.addElement("link")
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	695 # XXX: "uri" is set in self._manageComments if not already existing
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	696 link_elt["href"] = comments_data["uri"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	697 link_elt["rel"] = "replies"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	698 link_elt["title"] = "comments"
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	699
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	700 ## final item building ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	701 item_elt = pubsub.Item(id=item_id, payload=entry_elt)
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	702
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	703 ## the trigger ##
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	704 # if other plugins have things to add or change
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	705 self.host.trigger.point(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	706 "XEP-0277_data2entry", client, data, entry_elt, item_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	707 )
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	708
3724 a0c08fcfe11e plugin XEP-0277: various fixes + async: Goffi <goffi@goffi.org> parents: 3680 diff changeset	709 return item_elt
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	710
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	711 ## publish/preview ##
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	712
3762 becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	713 def isCommentNode(self, node: str) -> bool:
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	714 """Indicate if the node is prefixed with comments namespace"""
3762 becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	715 return node.startswith(NS_COMMENT_PREFIX)
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	716
3762 becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	717 def getParentItem(self, item_id: str) -> str:
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	718 """Return parent of a comment node
ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	719
ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	720 @param item_id: a comment node
ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	721 """
3762 becd7f1aa033 plugin XEP-0277: bridge method `mbIsCommentNode` + methods renaming Goffi <goffi@goffi.org> parents: 3761 diff changeset	722 if not self.isCommentNode(item_id):
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	723 raise ValueError("This node is not a comment node")
ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	724 return item_id[len(NS_COMMENT_PREFIX):]
ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	725
1831 68c0dc13d821 plugin blog import, XEP-0277: progress + redirect: Goffi <goffi@goffi.org> parents: 1829 diff changeset	726 def getCommentsNode(self, item_id):
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	727 """Generate comment node
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	728
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	729 @param item_id(unicode): id of the parent item
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	730 @return (unicode): comment node to use
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	731 """
3598 d390ff50af0f plugin XEP-0277: pubsub cache analyser implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	732 return f"{NS_COMMENT_PREFIX}{item_id}"
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	733
1831 68c0dc13d821 plugin blog import, XEP-0277: progress + redirect: Goffi <goffi@goffi.org> parents: 1829 diff changeset	734 def getCommentsService(self, client, parent_service=None):
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	735 """Get prefered PubSub service to create comment node
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	736
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	737 @param pubsub_service(jid.JID, None): PubSub service of the parent item
2433 014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	738 @param return((D)jid.JID, None): PubSub service to use
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	739 """
2433 014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	740 if parent_service is not None:
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	741 if parent_service.user:
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	742 # we are on a PEP
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	743 if parent_service.host == client.jid.host:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	744 # it's our server, we use already found client.pubsub_service below
2433 014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	745 pass
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	746 else:
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	747 # other server, let's try to find a non PEP service there
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	748 d = self.host.findServiceEntity(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	749 client, "pubsub", "service", parent_service
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	750 )
2433 014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	751 d.addCallback(lambda entity: entity or parent_service)
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	752 else:
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	753 # parent is already on a normal Pubsub service, we re-use it
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	754 return defer.succeed(parent_service)
014feb75092d plugin XEP-0277: better getCommentsService: Goffi <goffi@goffi.org> parents: 2415 diff changeset	755
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	756 return defer.succeed(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	757 client.pubsub_service if client.pubsub_service is not None else parent_service
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	758 )
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	759
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	760 async def _manageComments(self, client, mb_data, service, node, item_id, access=None):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	761 """Check comments keys in mb_data and create comments node if necessary
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	762
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	763 if a comments node metadata is set in the mb_data['comments'] list, it is used
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	764 otherwise it is generated (if allow_comments is True).
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	765 @param mb_data(dict): microblog mb_data
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	766 @param service(jid.JID, None): PubSub service of the parent item
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	767 @param node(unicode): node of the parent item
2227 79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	768 @param item_id(unicode): id of the parent item
79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	769 @param access(unicode, None): access model
79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	770 None to use same access model as parent item
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	771 """
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	772 allow_comments = mb_data.pop("allow_comments", None)
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	773 if allow_comments is None:
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	774 if "comments" in mb_data:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	775 mb_data["allow_comments"] = True
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	776 else:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	777 # no comments set or requested, nothing to do
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	778 return
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	779 elif allow_comments == False:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	780 if "comments" in mb_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	781 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	782 "comments are not allowed but there is already a comments node, "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	783 "it may be lost: {uri}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	784 uri=mb_data["comments"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	785 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	786 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	787 del mb_data["comments"]
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	788 return
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	789
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	790 # we have usually a single comment node, but the spec allow several, so we need to
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	791 # handle this in a list
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	792 if len(mb_data.setdefault('comments', [])) == 0:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	793 # we need at least one comment node
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	794 comments_data = {}
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	795 mb_data['comments'].append({})
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	796
2227 79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	797 if access is None:
79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	798 # TODO: cache access models per service/node
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	799 parent_node_config = await self._p.getConfiguration(client, service, node)
2227 79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	800 access = parent_node_config.get(self._p.OPT_ACCESS_MODEL, self._p.ACCESS_OPEN)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	801
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	802 options = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	803 self._p.OPT_ACCESS_MODEL: access,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	804 self._p.OPT_PERSIST_ITEMS: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	805 self._p.OPT_MAX_ITEMS: -1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	806 self._p.OPT_DELIVER_PAYLOADS: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	807 self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	808 # FIXME: would it make sense to restrict publish model to subscribers?
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	809 self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	810 }
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	811
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	812 # if other plugins need to change the options
3761 e0ff2f277e13 plugin XEP-0277: fix `await` trigger incorrectly used on a sync trigger Goffi <goffi@goffi.org> parents: 3740 diff changeset	813 self.host.trigger.point("XEP-0277_comments", client, mb_data, options)
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	814
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	815 for comments_data in mb_data['comments']:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	816 uri = comments_data.get('uri')
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	817 comments_node = comments_data.get('node')
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	818 try:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	819 comments_service = jid.JID(comments_data["service"])
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	820 except KeyError:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	821 comments_service = None
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	822
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	823 if uri:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	824 uri_service, uri_node = self.parseCommentUrl(uri)
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	825 if ((comments_node is not None and comments_node!=uri_node)
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	826 or (comments_service is not None and comments_service!=uri_service)):
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	827 raise ValueError(
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	828 f"Incoherence between comments URI ({uri}) and comments_service "
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	829 f"({comments_service}) or comments_node ({comments_node})")
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	830 comments_data['service'] = comments_service = uri_service
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	831 comments_data['node'] = comments_node = uri_node
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	832 else:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	833 if not comments_node:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	834 comments_node = self.getCommentsNode(item_id)
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	835 comments_data['node'] = comments_node
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	836 if comments_service is None:
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	837 comments_service = await self.getCommentsService(client, service)
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	838 if comments_service is None:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	839 comments_service = client.jid.userhostJID()
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	840 comments_data['service'] = comments_service
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	841
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	842 comments_data['uri'] = xmpp_uri.buildXMPPUri(
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	843 "pubsub",
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	844 path=comments_service.full(),
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	845 node=comments_node,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	846 )
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	847
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	848 try:
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	849 await self._p.createNode(client, comments_service, comments_node, options)
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	850 except error.StanzaError as e:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	851 if e.condition == "conflict":
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	852 log.info(
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	853 "node {} already exists on service {}".format(
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	854 comments_node, comments_service
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	855 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	856 )
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	857 else:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	858 raise e
1711 e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	859 else:
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	860 if access == self._p.ACCESS_WHITELIST:
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	861 # for whitelist access we need to copy affiliations from parent item
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	862 comments_affiliations = await self._p.getNodeAffiliations(
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	863 client, service, node
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	864 )
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	865 # …except for "member", that we transform to publisher
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	866 # because we wants members to be able to write to comments
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	867 for jid_, affiliation in list(comments_affiliations.items()):
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	868 if affiliation == "member":
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	869 comments_affiliations[jid_] == "publisher"
2286 330f8d4e2ad4 plugin XEP-0277: change affiliations for comments + fixes: Goffi <goffi@goffi.org> parents: 2272 diff changeset	870
3740 ea6fda69bb9f plugin XEP-0277: methods to check is a node is a comments node and to get its parent Goffi <goffi@goffi.org> parents: 3726 diff changeset	871 await self._p.setNodeAffiliations(
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	872 client, comments_service, comments_node, comments_affiliations
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	873 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	874
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	875 def friendlyId(self, data):
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	876 """Generate a user friendly id from title or content"""
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	877 # TODO: rich content should be converted to plain text
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	878 id_base = regex.urlFriendlyText(
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	879 data.get('title')
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	880 or data.get('title_rich')
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	881 or data.get('content')
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	882 or data.get('content_rich')
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	883 or ''
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	884 )
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	885 return f"{id_base}-{token_urlsafe(3)}"
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	886
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	887 def _mbSend(self, service, node, data, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	888 service = jid.JID(service) if service else None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	889 node = node if node else NS_MICROBLOG
2227 79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	890 client = self.host.getClient(profile_key)
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	891 data = data_format.deserialise(data)
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	892 return defer.ensureDeferred(self.send(client, data, service, node))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	893
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	894 async def send(
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	895 self,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	896 client: SatXMPPEntity,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	897 data: dict,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	898 service: Optional[jid.JID] = None,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	899 node: Optional[str] = NS_MICROBLOG
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	900 ) -> None:
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	901 """Send XEP-0277's microblog data
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	902
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	903 @param data: microblog data (must include at least a "content" or a "title" key).
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	904 see http://wiki.goffi.org/wiki/Bridge_API_-_Microblogging/en for details
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	905 @param service: PubSub service where the microblog must be published
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	906 None to publish on profile's PEP
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	907 @param node: PubSub node to use (defaut to microblog NS)
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	908 None is equivalend as using default value
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	909 """
1699 a72f04c67ac9 plugin XEP-0277: just a reminder Goffi <goffi@goffi.org> parents: 1681 diff changeset	910 # TODO: check that all data keys are used, this would avoid sending publicly a private message
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	911 # by accident (e.g. if group plugin is not loaded, and "group*" key are not used)
1821 d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	912 if node is None:
d6062afdd54f plugin XEP-0277: comments handling improvments: Goffi <goffi@goffi.org> parents: 1820 diff changeset	913 node = NS_MICROBLOG
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	914
3502 6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	915 item_id = data.get("id")
6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	916 if item_id is None:
6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	917 if data.get("user_friendly_id", True):
6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	918 item_id = self.friendlyId(data)
6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	919 else:
6132d363f0e9 plugin XEP-0277: user friendly ID: Goffi <goffi@goffi.org> parents: 3493 diff changeset	920 item_id = str(shortuuid.uuid())
2227 79d279d1ee88 plugin XEP-0277: comments node access model changes: Goffi <goffi@goffi.org> parents: 2218 diff changeset	921
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	922 try:
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	923 await self._manageComments(client, data, service, node, item_id, access=None)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	924 except error.StanzaError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	925 log.warning("Can't create comments node for item {}".format(item_id))
3513 753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	926 item = await self.data2entry(client, data, item_id, service, node)
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	927 return await self._p.publish(client, service, node, [item])
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	928
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	929 def _mbPreview(self, service, node, data, profile_key):
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	930 service = jid.JID(service) if service else None
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	931 node = node if node else NS_MICROBLOG
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	932 client = self.host.getClient(profile_key)
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	933 data = data_format.deserialise(data)
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	934 d = defer.ensureDeferred(self.preview(client, data, service, node))
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	935 d.addCallback(data_format.serialise)
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	936 return d
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	937
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	938 async def preview(
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	939 self,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	940 client: SatXMPPEntity,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	941 data: dict,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	942 service: Optional[jid.JID] = None,
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	943 node: Optional[str] = NS_MICROBLOG
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	944 ) -> dict:
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	945 """Preview microblog data without publishing them
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	946
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	947 params are the same as for [send]
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	948 @return: microblog data as would be retrieved from published item
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	949 """
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	950 if node is None:
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	951 node = NS_MICROBLOG
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	952
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	953 item_id = data.get("id", "")
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	954
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	955 # we have to serialise then deserialise to be sure that all triggers are called
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	956 item_elt = await self.data2entry(client, data, item_id, service, node)
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	957 item_elt.uri = pubsub.NS_PUBSUB
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	958 return await self.item2mbdata(client, item_elt, service, node)
753d151da886 XEP-0277: new preview/mbPreview method: Goffi <goffi@goffi.org> parents: 3502 diff changeset	959
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	960
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	961 ## retract ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	962
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	963 def _mbRetract(self, service_jid_s, nodeIdentifier, itemIdentifier, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	964 """Call self._p._retractItem, but use default node if node is empty"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	965 return self._p._retractItem(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	966 service_jid_s,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	967 nodeIdentifier or NS_MICROBLOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	968 itemIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	969 True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	970 profile_key,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	971 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	972
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	973 ## get ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	974
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	975 def _mbGetSerialise(self, data):
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	976 items, metadata = data
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	977 metadata['items'] = items
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	978 return data_format.serialise(metadata)
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	979
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	980 def _mbGet(self, service="", node="", max_items=10, item_ids=None, extra="",
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	981 profile_key=C.PROF_KEY_NONE):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	982 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	983 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	984 @param item_ids (list[unicode]): list of item IDs
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	985 """
2286 330f8d4e2ad4 plugin XEP-0277: change affiliations for comments + fixes: Goffi <goffi@goffi.org> parents: 2272 diff changeset	986 client = self.host.getClient(profile_key)
1865 fc6eeacf31bc plugin XEP-0277: service can be None in mbGet, resulting in a request on default pubsub service of profile (i.e. profile's PEP) Goffi <goffi@goffi.org> parents: 1854 diff changeset	987 service = jid.JID(service) if service else None
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	988 max_items = None if max_items == C.NO_LIMIT else max_items
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	989 extra = self._p.parseExtra(data_format.deserialise(extra))
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	990 d = defer.ensureDeferred(
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	991 self.mbGet(client, service, node or None, max_items, item_ids,
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	992 extra.rsm_request, extra.extra)
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	993 )
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	994 d.addCallback(self._mbGetSerialise)
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	995 return d
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	996
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	997 async def mbGet(self, client, service=None, node=None, max_items=10, item_ids=None,
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	998 rsm_request=None, extra=None):
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	999 """Get some microblogs
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	1000
1865 fc6eeacf31bc plugin XEP-0277: service can be None in mbGet, resulting in a request on default pubsub service of profile (i.e. profile's PEP) Goffi <goffi@goffi.org> parents: 1854 diff changeset	1001 @param service(jid.JID, None): jid of the publisher
fc6eeacf31bc plugin XEP-0277: service can be None in mbGet, resulting in a request on default pubsub service of profile (i.e. profile's PEP) Goffi <goffi@goffi.org> parents: 1854 diff changeset	1002 None to get profile's PEP
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1003 @param node(unicode, None): node to get (or microblog node if None)
2286 330f8d4e2ad4 plugin XEP-0277: change affiliations for comments + fixes: Goffi <goffi@goffi.org> parents: 2272 diff changeset	1004 @param max_items(int): maximum number of item to get, None for no limit
3591 d830c11eeef3 plugin XEP-0277: ignore `max_items` if `rsm_request` is set Goffi <goffi@goffi.org> parents: 3586 diff changeset	1005 ignored if rsm_request is set
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	1006 @param item_ids (list[unicode]): list of item IDs
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1007 @param rsm_request (rsm.RSMRequest): RSM request data
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	1008 @param extra (dict): extra data
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1233 diff changeset	1009
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	1010 @return: a deferred couple with the list of items and metadatas.
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1011 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1012 if node is None:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1013 node = NS_MICROBLOG
3591 d830c11eeef3 plugin XEP-0277: ignore `max_items` if `rsm_request` is set Goffi <goffi@goffi.org> parents: 3586 diff changeset	1014 if rsm_request:
d830c11eeef3 plugin XEP-0277: ignore `max_items` if `rsm_request` is set Goffi <goffi@goffi.org> parents: 3586 diff changeset	1015 max_items = None
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1016 items_data = await self._p.getItems(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1017 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1018 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1019 node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1020 max_items=max_items,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1021 item_ids=item_ids,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1022 rsm_request=rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1023 extra=extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1024 )
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1025 mb_data = await self._p.transItemsDataD(
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1026 items_data, partial(self.item2mbdata, client, service=service, node=node))
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1027 return mb_data
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1028
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1029 def _mbRename(self, service, node, item_id, new_id, profile_key):
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1030 return defer.ensureDeferred(self.mbRename(
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1031 self.host.getClient(profile_key),
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1032 jid.JID(service) if service else None,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1033 node or None,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1034 item_id,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1035 new_id
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1036 ))
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1037
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1038 async def mbRename(
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1039 self,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1040 client: SatXMPPEntity,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1041 service: Optional[jid.JID],
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1042 node: Optional[str],
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1043 item_id: str,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1044 new_id: str
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1045 ) -> None:
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1046 if not node:
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1047 node = NS_MICROBLOG
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1048 await self._p.renameItem(client, service, node, item_id, new_id)
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3513 diff changeset	1049
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1050 def parseCommentUrl(self, node_url):
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	1051 """Parse a XMPP URI
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	1052
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	1053 Determine the fields comments_service and comments_node of a microblog data
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1054 from the href attribute of an entry's link element. For example this input:
2160 e67e8cd24141 core (tools/common): data objects first draft: Goffi <goffi@goffi.org> parents: 2148 diff changeset	1055 xmpp:sat-pubsub.example.net?;node=urn%3Axmpp%3Acomments%3A_af43b363-3259-4b2a-ba4c-1bc33aa87634__urn%3Axmpp%3Agroupblog%3Asomebody%40example.net
e67e8cd24141 core (tools/common): data objects first draft: Goffi <goffi@goffi.org> parents: 2148 diff changeset	1056 will return(JID(u'sat-pubsub.example.net'), 'urn:xmpp:comments:_af43b363-3259-4b2a-ba4c-1bc33aa87634__urn:xmpp:groupblog:somebody@example.net')
e67e8cd24141 core (tools/common): data objects first draft: Goffi <goffi@goffi.org> parents: 2148 diff changeset	1057 @return (tuple[jid.JID, unicode]): service and node
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1058 """
3643 30196b9a2b4c plugin XEP-0277: use `common.uri` to parse comment URIs Goffi <goffi@goffi.org> parents: 3550 diff changeset	1059 try:
30196b9a2b4c plugin XEP-0277: use `common.uri` to parse comment URIs Goffi <goffi@goffi.org> parents: 3550 diff changeset	1060 parsed_url = xmpp_uri.parseXMPPUri(node_url)
30196b9a2b4c plugin XEP-0277: use `common.uri` to parse comment URIs Goffi <goffi@goffi.org> parents: 3550 diff changeset	1061 service = jid.JID(parsed_url["path"])
30196b9a2b4c plugin XEP-0277: use `common.uri` to parse comment URIs Goffi <goffi@goffi.org> parents: 3550 diff changeset	1062 node = parsed_url["node"]
30196b9a2b4c plugin XEP-0277: use `common.uri` to parse comment URIs Goffi <goffi@goffi.org> parents: 3550 diff changeset	1063 except Exception as e:
30196b9a2b4c plugin XEP-0277: use `common.uri` to parse comment URIs Goffi <goffi@goffi.org> parents: 3550 diff changeset	1064 raise exceptions.DataError(f"Invalid comments link: {e}")
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1065
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1066 return (service, node)
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1067
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1068 ## configure ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	1069
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1070 def mbSetAccess(self, access="presence", profile_key=C.PROF_KEY_NONE):
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1071 """Create a microblog node on PEP with given access
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	1072
304 e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	1073 If the node already exists, it change options
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1074 @param access: Node access model, according to xep-0060 #4.5
2218 6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2160 diff changeset	1075 @param profile_key: profile key
6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2160 diff changeset	1076 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1077 # FIXME: check if this mehtod is need, deprecate it if not
2218 6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2160 diff changeset	1078 client = self.host.getClient(profile_key)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1079
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1080 _options = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1081 self._p.OPT_ACCESS_MODEL: access,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1082 self._p.OPT_PERSIST_ITEMS: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1083 self._p.OPT_MAX_ITEMS: -1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1084 self._p.OPT_DELIVER_PAYLOADS: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1085 self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1086 }
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1087
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1088 def cb(result):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1089 # Node is created with right permission
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1090 log.debug(_("Microblog node has now access %s") % access)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1091
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1092 def fatal_err(s_error):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1093 # Something went wrong
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1094 log.error(_("Can't set microblog access"))
468 c97640c90a94 D-Bus Bridge: use inspection to name attribute + fix asynchronous calls for dynamically added method, it now use deferred return value instead of callback/errback attributes Goffi <goffi@goffi.org> parents: 465 diff changeset	1095 raise NodeAccessChangeException()
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1096
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1097 def err_cb(s_error):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1098 # If the node already exists, the condition is "conflict",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1099 # else we have an unmanaged error
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1100 if s_error.value.condition == "conflict":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1101 # d = self.host.plugins["XEP-0060"].deleteNode(client, client.jid.userhostJID(), NS_MICROBLOG)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1102 # d.addCallback(lambda x: create_node().addCallback(cb).addErrback(fatal_err))
304 e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	1103 change_node_options().addCallback(cb).addErrback(fatal_err)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1104 else:
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1105 fatal_err(s_error)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1106
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1107 def create_node():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1108 return self._p.createNode(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1109 client, client.jid.userhostJID(), NS_MICROBLOG, _options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1110 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1111
304 e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	1112 def change_node_options():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1113 return self._p.setOptions(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1114 client.jid.userhostJID(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1115 NS_MICROBLOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1116 client.jid.userhostJID(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1117 _options,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1118 profile_key=profile_key,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1119 )
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1120
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	1121 create_node().addCallback(cb).addErrback(err_cb)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1122
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1123 ## methods to manage several stanzas/jids at once ##
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1124
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1125 # common
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1126
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1127 def _getClientAndNodeData(self, publishers_type, publishers, profile_key):
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1128 """Helper method to construct node_data from publishers_type/publishers
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1129
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1130 @param publishers_type: type of the list of publishers, one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1131 C.ALL: get all jids from roster, publishers is not used
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1132 C.GROUP: get jids from groups
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1133 C.JID: use publishers directly as list of jids
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1134 @param publishers: list of publishers, according to "publishers_type" (None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1135 list of groups or list of jids)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1136 @param profile_key: %(doc_profile_key)s
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1137 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1138 client = self.host.getClient(profile_key)
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1139 if publishers_type == C.JID:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1140 jids_set = set(publishers)
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1141 else:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1142 jids_set = client.roster.getJidsSet(publishers_type, publishers)
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	1143 if publishers_type == C.ALL:
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1144 try:
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1145 # display messages from salut-a-toi@libervia.org or other PEP services
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1146 services = self.host.plugins["EXTRA-PEP"].getFollowedEntities(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1147 profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1148 )
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	1149 except KeyError:
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1734 diff changeset	1150 pass # plugin is not loaded
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	1151 else:
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1734 diff changeset	1152 if services:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1153 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1154 "Extra PEP followed entities: %s"
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1155 % ", ".join([str(service) for service in services])
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1156 )
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1734 diff changeset	1157 jids_set.update(services)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1158
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1159 node_data = []
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1160 for jid_ in jids_set:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1161 node_data.append((jid_, NS_MICROBLOG))
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1162 return client, node_data
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1163
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1164 def _checkPublishers(self, publishers_type, publishers):
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1165 """Helper method to deserialise publishers coming from bridge
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1166
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1167 publishers_type(unicode): type of the list of publishers, one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1168 publishers: list of publishers according to type
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1169 @return: deserialised (publishers_type, publishers) tuple
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1170 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1171 if publishers_type == C.ALL:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1172 if publishers:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1173 raise failure.Failure(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1174 ValueError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1175 "Can't use publishers with {} type".format(publishers_type)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1176 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1177 )
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1178 else:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1179 publishers = None
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1180 elif publishers_type == C.JID:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1181 publishers[:] = [jid.JID(publisher) for publisher in publishers]
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1182 return publishers_type, publishers
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1183
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1184 # subscribe #
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1185
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1186 def _mbSubscribeToMany(self, publishers_type, publishers, profile_key):
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1187 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1188
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1189 @return (str): session id: Use pubsub.getSubscribeRTResult to get the results
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1190 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1191 publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1192 return self.mbSubscribeToMany(publishers_type, publishers, profile_key)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1193
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1194 def mbSubscribeToMany(self, publishers_type, publishers, profile_key):
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1195 """Subscribe microblogs for a list of groups or jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1196
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1197 @param publishers_type: type of the list of publishers, one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1198 C.ALL: get all jids from roster, publishers is not used
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1199 C.GROUP: get jids from groups
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1200 C.JID: use publishers directly as list of jids
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1201 @param publishers: list of publishers, according to "publishers_type" (None, list
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1202 of groups or list of jids)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1203 @param profile: %(doc_profile)s
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1204 @return (str): session id
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1205 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1206 client, node_data = self._getClientAndNodeData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1207 publishers_type, publishers, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1208 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1209 return self._p.subscribeToMany(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1210 node_data, client.jid.userhostJID(), profile_key=profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1211 )
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	1212
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1213 # get #
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1214
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1215 def _mbGetFromManyRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1216 """Get real-time results for mbGetFromMany session
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1217
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1218 @param session_id: id of the real-time deferred session
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1219 @param return (tuple): (remaining, results) where:
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1220 - remaining is the number of still expected results
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1221 - results is a list of tuple with
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1222 - service (unicode): pubsub service
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1223 - node (unicode): pubsub node
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1224 - failure (unicode): empty string in case of success, error message else
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	1225 - items_data(list): data as returned by [mbGet]
955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	1226 - items_metadata(dict): metadata as returned by [mbGet]
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1227 @param profile_key: %(doc_profile_key)s
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1228 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1229
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1230 client = self.host.getClient(profile_key)
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1231
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1232 def onSuccess(items_data):
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1233 """convert items elements to list of microblog data in items_data"""
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1234 d = self._p.transItemsDataD(
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1235 items_data,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1236 # FIXME: service and node should be used here
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1237 partial(self.item2mbdata, client),
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1238 serialise=True
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1239 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1240 d.addCallback(lambda serialised: ("", serialised))
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1241 return d
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1242
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1243 d = self._p.getRTResults(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1244 session_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1245 on_success=onSuccess,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1246 on_error=lambda failure: (str(failure.value), ([], {})),
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1247 profile=client.profile,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1248 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1249 d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1250 lambda ret: (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1251 ret[0],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1252 [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1253 (service.full(), node, failure, items, metadata)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1254 for (service, node), (success, (failure, (items, metadata))) in ret[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1255 1
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1256 ].items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1257 ],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1258 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1259 )
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1260 return d
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1261
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1262 def _mbGetFromMany(self, publishers_type, publishers, max_items=10, extra_dict=None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1263 profile_key=C.PROF_KEY_NONE):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1264 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1265 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1266 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1267 max_items = None if max_items == C.NO_LIMIT else max_items
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1268 publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1269 extra = self._p.parseExtra(extra_dict)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1270 return self.mbGetFromMany(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1271 publishers_type,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1272 publishers,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1273 max_items,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1274 extra.rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1275 extra.extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1276 profile_key,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1277 )
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1278
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1279 def mbGetFromMany(self, publishers_type, publishers, max_items=None, rsm_request=None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1280 extra=None, profile_key=C.PROF_KEY_NONE):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1281 """Get the published microblogs for a list of groups or jids
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1282
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1283 @param publishers_type (str): type of the list of publishers (one of "GROUP" or
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1284 "JID" or "ALL")
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1285 @param publishers (list): list of publishers, according to publishers_type (list
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1286 of groups or list of jids)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1287 @param max_items (int): optional limit on the number of retrieved items.
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1288 @param rsm_request (rsm.RSMRequest): RSM request data, common to all publishers
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1289 @param extra (dict): Extra data
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1290 @param profile_key: profile key
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1291 @return (str): RT Deferred session id
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1292 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1293 # XXX: extra is unused here so far
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1294 client, node_data = self._getClientAndNodeData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1295 publishers_type, publishers, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1296 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1297 return self._p.getFromMany(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1298 node_data, max_items, rsm_request, profile_key=profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1299 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1300
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1301 # comments #
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1302
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1303 def _mbGetFromManyWithCommentsRTResultSerialise(self, data):
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1304 """Serialisation of result
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1305
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1306 This is probably the longest method name of whole SàT ecosystem ^^
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1307 @param data(dict): data as received by rt_sessions
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1308 @return (tuple): see [_mbGetFromManyWithCommentsRTResult]
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1309 """
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1310 ret = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1311 data_iter = iter(data[1].items())
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1312 for (service, node), (success, (failure_, (items_data, metadata))) in data_iter:
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1313 items = []
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1314 for item, item_metadata in items_data:
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1315 item = data_format.serialise(item)
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1316 items.append((item, item_metadata))
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1317 ret.append((
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1318 service.full(),
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1319 node,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1320 failure_,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1321 items,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1322 metadata))
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1323
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1324 return data[0], ret
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1325
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1326 def _mbGetFromManyWithCommentsRTResult(self, session_id,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1327 profile_key=C.PROF_KEY_DEFAULT):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1328 """Get real-time results for [mbGetFromManyWithComments] session
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1329
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1330 @param session_id: id of the real-time deferred session
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1331 @param return (tuple): (remaining, results) where:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1332 - remaining is the number of still expected results
1511 83f71763e1a7 plugin XEP-0277: clarify a docstring for one complex method argument souliane <souliane@mailoo.org> parents: 1459 diff changeset	1333 - results is a list of 5-tuple with
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1334 - service (unicode): pubsub service
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1335 - node (unicode): pubsub node
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1336 - failure (unicode): empty string in case of success, error message else
1511 83f71763e1a7 plugin XEP-0277: clarify a docstring for one complex method argument souliane <souliane@mailoo.org> parents: 1459 diff changeset	1337 - items(list[tuple(dict, list)]): list of 2-tuple with
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1338 - item(dict): item microblog data
1511 83f71763e1a7 plugin XEP-0277: clarify a docstring for one complex method argument souliane <souliane@mailoo.org> parents: 1459 diff changeset	1339 - comments_list(list[tuple]): list of 5-tuple with
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1340 - service (unicode): pubsub service where the comments node is
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1341 - node (unicode): comments node
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1342 - failure (unicode): empty in case of success, else error message
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1343 - comments(list[dict]): list of microblog data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1344 - comments_metadata(dict): metadata of the comment node
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1345 - metadata(dict): original node metadata
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1346 @param profile_key: %(doc_profile_key)s
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1347 """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1348 profile = self.host.getClient(profile_key).profile
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1349 d = self.rt_sessions.getResults(session_id, profile=profile)
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1350 d.addCallback(self._mbGetFromManyWithCommentsRTResultSerialise)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1351 return d
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1352
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1353 def _mbGetFromManyWithComments(self, publishers_type, publishers, max_items=10,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1354 max_comments=C.NO_LIMIT, extra_dict=None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1355 extra_comments_dict=None, profile_key=C.PROF_KEY_NONE):
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1356 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1357 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1358 @param max_comments(int): maximum number of comments to get, C.NO_LIMIT for no
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1359 limit
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1360 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1361 max_items = None if max_items == C.NO_LIMIT else max_items
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1362 max_comments = None if max_comments == C.NO_LIMIT else max_comments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1363 publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1364 extra = self._p.parseExtra(extra_dict)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1365 extra_comments = self._p.parseExtra(extra_comments_dict)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1366 return self.mbGetFromManyWithComments(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1367 publishers_type,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1368 publishers,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1369 max_items,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1370 max_comments or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1371 extra.rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1372 extra.extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1373 extra_comments.rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1374 extra_comments.extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1375 profile_key,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1376 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1377
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1378 def mbGetFromManyWithComments(self, publishers_type, publishers, max_items=None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1379 max_comments=None, rsm_request=None, extra=None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1380 rsm_comments=None, extra_comments=None,
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1381 profile_key=C.PROF_KEY_NONE):
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1382 """Helper method to get the microblogs and their comments in one shot
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1383
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1384 @param publishers_type (str): type of the list of publishers (one of "GROUP" or
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1385 "JID" or "ALL")
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1386 @param publishers (list): list of publishers, according to publishers_type (list
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1387 of groups or list of jids)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1388 @param max_items (int): optional limit on the number of retrieved items.
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1389 @param max_comments (int): maximum number of comments to retrieve
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1390 @param rsm_request (rsm.RSMRequest): RSM request for initial items only
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1391 @param extra (dict): extra configuration for initial items only
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1392 @param rsm_comments (rsm.RSMRequest): RSM request for comments only
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1393 @param extra_comments (dict): extra configuration for comments only
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1394 @param profile_key: profile key
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1395 @return (str): RT Deferred session id
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1396 """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1397 # XXX: this method seems complicated because it do a couple of treatments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1398 # to serialise and associate the data, but it make life in frontends side
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1399 # a lot easier
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1400
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1401 client, node_data = self._getClientAndNodeData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1402 publishers_type, publishers, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1403 )
2360 72cbb6478f97 plugin XEP-0060: use client instead of profile_key in getItems Goffi <goffi@goffi.org> parents: 2341 diff changeset	1404
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1405 def getComments(items_data):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1406 """Retrieve comments and add them to the items_data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1407
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1408 @param items_data: serialised items data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1409 @return (defer.Deferred): list of items where each item is associated
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1410 with a list of comments data (service, node, list of items, metadata)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1411 """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1412 items, metadata = items_data
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1413 items_dlist = [] # deferred list for items
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1414 for item in items:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1415 dlist = [] # deferred list for comments
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1416 for key, value in item.items():
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1417 # we look for comments
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1418 if key.startswith("comments") and key.endswith("_service"):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1419 prefix = key[: key.find("_")]
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1420 service_s = value
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1421 service = jid.JID(service_s)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1422 node = item["{}{}".format(prefix, "_node")]
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1423 # time to get the comments
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1424 d = defer.ensureDeferred(
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1425 self._p.getItems(
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1426 client,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1427 service,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1428 node,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1429 max_comments,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1430 rsm_request=rsm_comments,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1431 extra=extra_comments,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1432 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1433 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1434 # then serialise
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1435 d.addCallback(
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1436 lambda items_data: self._p.transItemsDataD(
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1437 items_data,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1438 partial(
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1439 self.item2mbdata, client, service=service, node=node
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1440 ),
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1441 serialise=True
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1442 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1443 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1444 # with failure handling
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1445 d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1446 lambda serialised_items_data: ("",) + serialised_items_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1447 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1448 d.addErrback(lambda failure: (str(failure.value), [], {}))
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1449 # and associate with service/node (needed if there are several
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2780 diff changeset	1450 # comments nodes)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1451 d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1452 lambda serialised, service_s=service_s, node=node: (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1453 service_s,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1454 node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1455 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1456 + serialised
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1457 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1458 dlist.append(d)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1459 # we get the comments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1460 comments_d = defer.gatherResults(dlist)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1461 # and add them to the item data
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1462 comments_d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1463 lambda comments_data, item=item: (item, comments_data)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1464 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1465 items_dlist.append(comments_d)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1466 # we gather the items + comments in a list
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1467 items_d = defer.gatherResults(items_dlist)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1468 # and add the metadata
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	1469 items_d.addCallback(lambda items_completed: (items_completed, metadata))
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1470 return items_d
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1471
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1472 deferreds = {}
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1473 for service, node in node_data:
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1474 d = deferreds[(service, node)] = defer.ensureDeferred(self._p.getItems(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1475 client, service, node, max_items, rsm_request=rsm_request, extra=extra
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3550 diff changeset	1476 ))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1477 d.addCallback(
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3179 diff changeset	1478 lambda items_data: self._p.transItemsDataD(
3328 d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1479 items_data,
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1480 partial(self.item2mbdata, client, service=service, node=node),
d49607e3a066 plugin XEP-0277: set "uri" in item2mbdata Goffi <goffi@goffi.org> parents: 3308 diff changeset	1481 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1482 )
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1483 d.addCallback(getComments)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1484 d.addCallback(lambda items_comments_data: ("", items_comments_data))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1485 d.addErrback(lambda failure: (str(failure.value), ([], {})))
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1486
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	1487 return self.rt_sessions.newSession(deferreds, client.profile)
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1488
f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1489
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2807 diff changeset	1490 @implementer(iwokkel.IDisco)
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1491 class XEP_0277_handler(XMPPHandler):
f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1492
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1493 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1494 return [disco.DiscoFeature(NS_MICROBLOG)]
f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1495
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1496 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
2341 f9580b4a105a plugin XEP-0277: added microblog namespace to disco info Goffi <goffi@goffi.org> parents: 2322 diff changeset	1497 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0277.py @ 3817:998c5318230f