Mercurial > libervia-backend
annotate sat/plugins/plugin_xep_0334.py @ 3874:c2b292d30c66
doc (components/AP gateway): "repeat" and "noticed/like":
fix 370
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 22 Jul 2022 17:40:03 +0200 |
parents | 68a11b95a7d3 |
children | 8289ac1b34f4 |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
3137 | 2 |
1279 | 3 |
4 # SAT plugin for Delayed Delivery (XEP-0334) | |
3479 | 5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
1766 | 6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) |
1279 | 7 |
8 # This program is free software: you can redistribute it and/or modify | |
9 # it under the terms of the GNU Affero General Public License as published by | |
10 # the Free Software Foundation, either version 3 of the License, or | |
11 # (at your option) any later version. | |
12 | |
13 # This program is distributed in the hope that it will be useful, | |
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 # GNU Affero General Public License for more details. | |
17 | |
18 # You should have received a copy of the GNU Affero General Public License | |
19 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
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 | 22 from sat.core.log import getLogger |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
23 |
1279 | 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 | 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 | 28 |
29 from wokkel import disco, iwokkel | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
30 |
2698 | 31 from twisted.words.protocols.jabber import xmlstream |
3028 | 32 from zope.interface import implementer |
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 | 34 |
35 | |
36 PLUGIN_INFO = { | |
3028 | 37 C.PI_NAME: "Message Processing Hints", |
38 C.PI_IMPORT_NAME: "XEP-0334", | |
39 C.PI_TYPE: "XEP", | |
3830
68a11b95a7d3
plugin XEP-0372: References implementation:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
40 C.PI_MODES: C.PLUG_MODE_BOTH, |
3028 | 41 C.PI_PROTOCOLS: ["XEP-0334"], |
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
42 C.PI_MAIN: "XEP_0334", |
3028 | 43 C.PI_HANDLER: "yes", |
44 C.PI_DESCRIPTION: D_("""Implementation of Message Processing Hints"""), | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
45 C.PI_USAGE: dedent( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
46 D_( |
3028 | 47 """\ |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
48 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
|
49 Internal plugins can use directly addHint([HINT_* constant]). |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
50 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
|
51 ) |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
52 ), |
1279 | 53 } |
54 | |
3028 | 55 NS_HINTS = "urn:xmpp:hints" |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
56 |
1279 | 57 |
58 class XEP_0334(object): | |
3028 | 59 HINT_NO_PERMANENT_STORE = "no-permanent-store" |
60 HINT_NO_STORE = "no-store" | |
61 HINT_NO_COPY = "no-copy" | |
62 HINT_STORE = "store" | |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
63 HINTS = (HINT_NO_PERMANENT_STORE, HINT_NO_STORE, HINT_NO_COPY, HINT_STORE) |
1279 | 64 |
65 def __init__(self, host): | |
66 log.info(_("Message Processing Hints plugin initialization")) | |
67 self.host = host | |
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2132
diff
changeset
|
68 host.trigger.add("sendMessage", self.sendMessageTrigger) |
3172
dcebc585c29f
core: renamed "MessageReceived" trigger to "messageReceived" for consistency.
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
69 host.trigger.add("messageReceived", self.messageReceivedTrigger, priority=-1000) |
1279 | 70 |
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2132
diff
changeset
|
71 def getHandler(self, client): |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
72 return XEP_0334_handler() |
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
73 |
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
74 def addHint(self, mess_data, hint): |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
75 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
|
76 log.error( |
3028 | 77 "{hint} can only be used with full jids! Ignoring it.".format(hint=hint) |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
78 ) |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
79 return |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
80 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
|
81 if hint in self.HINTS: |
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
82 hints.add(hint) |
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
83 else: |
3028 | 84 log.error("Unknown hint: {}".format(hint)) |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
85 |
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
|
86 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
|
87 """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
|
88 |
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 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
|
90 @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
|
91 """ |
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 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
|
93 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
|
94 |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
95 def _sendPostXmlTreatment(self, mess_data): |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
96 if "hints" in mess_data: |
3028 | 97 self.addHintElements(mess_data["xml"], mess_data["hints"]) |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
98 return mess_data |
1279 | 99 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
100 def sendMessageTrigger( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
101 self, client, mess_data, pre_xml_treatments, post_xml_treatments |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
102 ): |
1279 | 103 """Add the hints element to the message to be sent""" |
3028 | 104 if "hints" in mess_data["extra"]: |
105 for hint in data_format.dict2iter("hints", mess_data["extra"], pop=True): | |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
106 self.addHint(hint) |
1279 | 107 |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
108 post_xml_treatments.addCallback(self._sendPostXmlTreatment) |
1279 | 109 return True |
110 | |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
111 def _receivedSkipHistory(self, mess_data): |
3028 | 112 mess_data["history"] = C.HISTORY_SKIP |
2132
c0577837680a
core: replaced SkipHistory exception by a key in mess_data:
Goffi <goffi@goffi.org>
parents:
2131
diff
changeset
|
113 return mess_data |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
114 |
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
115 def messageReceivedTrigger(self, client, message_elt, post_treat): |
1279 | 116 """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
|
117 for elt in message_elt.elements(): |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
118 if elt.uri == NS_HINTS and elt.name in ( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
119 self.HINT_NO_PERMANENT_STORE, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
120 self.HINT_NO_STORE, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
121 ): |
3028 | 122 log.debug("history will be skipped for this message, as requested") |
2131
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
123 post_treat.addCallback(self._receivedSkipHistory) |
628c1c95f442
plugin XEP-0334: fixed and improved message processing hints:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
124 break |
1279 | 125 return True |
126 | |
127 | |
3028 | 128 @implementer(iwokkel.IDisco) |
2698 | 129 class XEP_0334_handler(xmlstream.XMPPHandler): |
1279 | 130 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
131 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
|
132 return [disco.DiscoFeature(NS_HINTS)] |
1279 | 133 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
134 def getDiscoItems(self, requestor, target, nodeIdentifier=""): |
1279 | 135 return [] |