libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0334.py @ 2845:42380a4f6433

quick frontend (app): new synchronisation mechanism: on some frontend (notably on mobiles) frontend can be paused and lose synchronisation with backend, this can also happen if backend restart a connexion without resuming using stream management. To manage that, QuickApp now has a sync attribute which is True when the backend is in sync with frontend. When synchronisation has been lost and is possible again, all widget will have their "resync" method called, which can be used to do necessary calls to update the status. It's the responsability of each widget to then reset the "sync" attribute, once everything has been resynchronised.

author	Goffi <goffi@goffi.org>
date	Sat, 09 Mar 2019 16:33:31 +0100
parents	003b8b4b56a7
children	ab2696e34d29

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1766 diff changeset	1 #!/usr/bin/env python2
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	3
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT plugin for Delayed Delivery (XEP-0334)
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2698 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1396 diff changeset	6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	7
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	8 # This program is free software: you can redistribute it and/or modify
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	9 # it under the terms of the GNU Affero General Public License as published by
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	10 # the Free Software Foundation, either version 3 of the License, or
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	11 # (at your option) any later version.
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	12
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	13 # This program is distributed in the hope that it will be useful,
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	16 # GNU Affero General Public License for more details.
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	17
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	18 # You should have received a copy of the GNU Affero General Public License
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	20
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	21 from sat.core.i18n import _, D_
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	22 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	23
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	24 log = getLogger(__name__)
2132 c0577837680a core: replaced SkipHistory exception by a key in mess_data: Goffi <goffi@goffi.org> parents: 2131 diff changeset	25 from sat.core.constants import Const as C
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	26
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	27 from sat.tools.common import data_format
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	28
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	29 from wokkel import disco, iwokkel
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	30
2698 5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2652 diff changeset	31 from twisted.words.protocols.jabber import xmlstream
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	32 from zope.interface import implements
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	33 from textwrap import dedent
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	34
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	35
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	36 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	37 C.PI_NAME: u"Message Processing Hints",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	38 C.PI_IMPORT_NAME: u"XEP-0334",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	39 C.PI_TYPE: u"XEP",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	40 C.PI_PROTOCOLS: [u"XEP-0334"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	41 C.PI_MAIN: "XEP_0334",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	42 C.PI_HANDLER: u"yes",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	43 C.PI_DESCRIPTION: D_(u"""Implementation of Message Processing Hints"""),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	44 C.PI_USAGE: dedent(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	45 D_(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	46 u"""\
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	47 Frontends can use HINT_* constants in mess_data['extra'] in a serialized 'hints' dict.
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	48 Internal plugins can use directly addHint([HINT_* constant]).
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	49 Will set mess_data['extra']['history'] to 'skipped' when no store is requested and message is not saved in history."""
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	50 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	51 ),
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	52 }
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	53
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	54 NS_HINTS = u"urn:xmpp:hints"
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	55
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	56
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	57 class XEP_0334(object):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	58 HINT_NO_PERMANENT_STORE = u"no-permanent-store"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	59 HINT_NO_STORE = u"no-store"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	60 HINT_NO_COPY = u"no-copy"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	61 HINT_STORE = u"store"
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	62 HINTS = (HINT_NO_PERMANENT_STORE, HINT_NO_STORE, HINT_NO_COPY, HINT_STORE)
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	63
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	64 def __init__(self, host):
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	65 log.info(_("Message Processing Hints plugin initialization"))
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	66 self.host = host
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2132 diff changeset	67 host.trigger.add("sendMessage", self.sendMessageTrigger)
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	68 host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=-1000)
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	69
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2132 diff changeset	70 def getHandler(self, client):
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	71 return XEP_0334_handler()
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	72
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	73 def addHint(self, mess_data, hint):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	74 if hint == self.HINT_NO_COPY and not mess_data["to"].resource:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	75 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	76 u"{hint} can only be used with full jids! Ignoring it.".format(hint=hint)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	77 )
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	78 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	79 hints = mess_data.setdefault("hints", set())
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	80 if hint in self.HINTS:
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	81 hints.add(hint)
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	82 else:
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	83 log.error(u"Unknown hint: {}".format(hint))
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	84
2652 baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	85 def addHintElements(self, message_elt, hints):
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	86 """Add hints elements to message stanza
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	87
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	88 @param message_elt(domish.Element): stanza where hints must be added
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	89 @param hints(iterable(unicode)): hints to add
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	90 """
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	91 for hint in hints:
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	92 message_elt.addElement((NS_HINTS, hint))
baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	93
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	94 def _sendPostXmlTreatment(self, mess_data):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	95 if "hints" in mess_data:
2652 baccc27d5c5c plugin XEP-0334: added a method to add hint directly to elements (i.e. on domish.Element instead of message data) Goffi <goffi@goffi.org> parents: 2624 diff changeset	96 self.addHintElements(mess_data[u"xml"], mess_data[u"hints"])
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	97 return mess_data
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	98
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	99 def sendMessageTrigger(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	100 self, client, mess_data, pre_xml_treatments, post_xml_treatments
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	101 ):
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	102 """Add the hints element to the message to be sent"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	103 if u"hints" in mess_data[u"extra"]:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	104 for hint in data_format.dict2iter(u"hints", mess_data[u"extra"], pop=True):
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	105 self.addHint(hint)
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	106
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	107 post_xml_treatments.addCallback(self._sendPostXmlTreatment)
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	108 return True
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	109
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	110 def _receivedSkipHistory(self, mess_data):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	111 mess_data[u"history"] = C.HISTORY_SKIP
2132 c0577837680a core: replaced SkipHistory exception by a key in mess_data: Goffi <goffi@goffi.org> parents: 2131 diff changeset	112 return mess_data
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	113
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	114 def messageReceivedTrigger(self, client, message_elt, post_treat):
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	115 """Check for hints in the received message"""
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	116 for elt in message_elt.elements():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	117 if elt.uri == NS_HINTS and elt.name in (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	118 self.HINT_NO_PERMANENT_STORE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	119 self.HINT_NO_STORE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	120 ):
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	121 log.debug(u"history will be skipped for this message, as requested")
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	122 post_treat.addCallback(self._receivedSkipHistory)
628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	123 break
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	124 return True
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	125
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	126
2698 5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2652 diff changeset	127 class XEP_0334_handler(xmlstream.XMPPHandler):
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	128 implements(iwokkel.IDisco)
d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	129
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	130 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
2131 628c1c95f442 plugin XEP-0334: fixed and improved message processing hints: Goffi <goffi@goffi.org> parents: 1955 diff changeset	131 return [disco.DiscoFeature(NS_HINTS)]
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	132
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	133 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
1279 d84905c3e124 plugin XEP-0334: first draft souliane <souliane@mailoo.org> parents: diff changeset	134 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0334.py @ 2845:42380a4f6433