Mercurial > libervia-pubsub
annotate sat_pubsub/mam.py @ 405:c56a728412f1
file organisation + setup refactoring:
- `/src` has been renamed to `/sat_pubsub`, this is the recommended naming convention
- revamped `setup.py` on the basis of SàT's `setup.py`
- added a `VERSION` which is the unique place where version number will now be set
- use same trick as in SàT to specify dev version (`D` at the end)
- use setuptools_scm to retrieve Mercurial hash when in dev version
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 16 Aug 2019 12:00:02 +0200 |
| parents | src/mam.py@907b10480394 |
| children | ccb2a22ea0fc |
| rev | line source |
|---|---|
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
1 #!/usr/bin/python |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
2 #-*- coding: utf-8 -*- |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
3 |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
4 # Copyright (c) 2016 Jérôme Poisson |
| 311 | 5 # Copyright (c) 2015-2016 Adrien Cossa |
| 6 # | |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 # | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 # | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
20 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
21 XMPP Message Archive Management protocol. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
22 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
23 This protocol is specified in |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
24 U{XEP-0313<http://xmpp.org/extensions/xep-0313.html>}. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
25 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
26 |
| 311 | 27 |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
28 from zope.interface import implements |
|
281
30895c49ebd2
fixes the imports from sat.tmp
souliane <souliane@mailoo.org>
parents:
280
diff
changeset
|
29 |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
30 from twisted.words.xish import domish |
| 322 | 31 from twisted.python import log |
| 32 from twisted.words.protocols.jabber import error | |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
33 |
|
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
34 from sat_pubsub import const |
| 322 | 35 from sat_pubsub import backend |
| 36 from wokkel import pubsub | |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
37 |
| 322 | 38 from wokkel import rsm |
| 39 from wokkel import mam | |
| 40 from wokkel import delay | |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
41 |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
42 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
43 class MAMResource(object): |
| 322 | 44 implements(mam.IMAMResource) |
| 45 _errorMap = backend.PubSubResourceFromBackend._errorMap | |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
46 |
| 322 | 47 def __init__(self, backend_): |
| 48 self.backend = backend_ | |
| 49 | |
| 50 def _mapErrors(self, failure): | |
| 51 # XXX: come from backend.PubsubResourceFromBackend | |
| 52 e = failure.trap(*self._errorMap.keys()) | |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
53 |
| 322 | 54 condition, pubsubCondition, feature = self._errorMap[e] |
| 55 msg = failure.value.msg | |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
56 |
| 322 | 57 if pubsubCondition: |
| 58 exc = pubsub.PubSubError(condition, pubsubCondition, feature, msg) | |
| 59 else: | |
| 60 exc = error.StanzaError(condition, text=msg) | |
| 61 | |
| 62 raise exc | |
| 63 | |
|
325
8d939378f023
mam: removed requestor in favor of mam_request.sender and recipient + fixed bad use of requestor instead of recipient in getItemsData
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
64 def onArchiveRequest(self, mam_request): |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
65 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
66 |
| 322 | 67 @param mam_request: The MAM archive request. |
| 68 @type mam_request: L{MAMQueryReques<wokkel.mam.MAMRequest>} | |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
69 |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
70 @return: A tuple with list of message data (id, element, data) and RSM element |
|
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
71 @rtype: C{tuple} |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
72 """ |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
73 # FIXME: bad result ordering |
| 322 | 74 try: |
| 75 pep = mam_request.delegated | |
| 76 except AttributeError: | |
| 77 pep = False | |
| 78 ext_data = {'pep': pep} | |
| 79 if mam_request.form: | |
| 80 ext_data['filters'] = mam_request.form.fields.values() | |
| 81 if mam_request.rsm is None: | |
| 82 if const.VAL_RSM_MAX_DEFAULT != None: | |
| 83 log.msg("MAM request without RSM limited to {}".format(const.VAL_RSM_MAX_DEFAULT)) | |
| 84 ext_data['rsm'] = rsm.RSMRequest(const.VAL_RSM_MAX_DEFAULT) | |
| 85 else: | |
| 86 ext_data['rsm'] = mam_request.rsm | |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
87 |
|
375
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
88 if mam_request.orderBy: |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
89 ext_data['order_by'] = mam_request.orderBy |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
90 |
|
398
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
91 d = self.backend.getItemsData(mam_request.node, mam_request.sender, |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
92 mam_request.recipient, None, None, ext_data) |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
93 |
|
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
94 def make_message(elt): |
|
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
95 # XXX: http://xmpp.org/extensions/xep-0297.html#sect-idp629952 (rule 3) |
| 322 | 96 message = domish.Element((const.NS_CLIENT, "message")) |
| 97 event = message.addElement((pubsub.NS_PUBSUB_EVENT, "event")) | |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
98 items = event.addElement('items') |
| 322 | 99 items["node"] = mam_request.node |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
100 items.addChild(elt) |
|
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
101 return message |
|
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
102 |
| 322 | 103 def cb(items_data): |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
104 msg_data = [] |
|
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
105 rsm_elt = None |
|
379
66fbf026ed49
mam: set "complete" attribute when suitable
Goffi <goffi@goffi.org>
parents:
375
diff
changeset
|
106 attributes = {} |
| 322 | 107 for item_data in items_data: |
| 108 if item_data.item.name == 'set' and item_data.item.uri == rsm.NS_RSM: | |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
109 assert rsm_elt is None |
| 322 | 110 rsm_elt = item_data.item |
|
398
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
111 if rsm_elt.first: |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
112 # XXX: we check if it is the last page using initial request data |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
113 # and RSM element data. In this case, we must have the |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
114 # "complete" |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
115 # attribute set to "true". |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
116 page_max = (int(rsm_elt.first['index']) + 1) * mam_request.rsm.max |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
117 count = int(unicode(rsm_elt.count)) |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
118 if page_max >= count: |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
119 # the maximum items which can be displayed is equal to or |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
120 # above the total number of items, which means we are complete |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
121 attributes['complete'] = "true" |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
122 else: |
|
401
907b10480394
mam: fixed confusion between twisted log.msg and log.warning used elsewhere
Goffi <goffi@goffi.org>
parents:
399
diff
changeset
|
123 log.msg("WARNING: no <first> element in RSM request: {xml}".format( |
|
907b10480394
mam: fixed confusion between twisted log.msg and log.warning used elsewhere
Goffi <goffi@goffi.org>
parents:
399
diff
changeset
|
124 xml = rsm_elt.toXml().encode('utf-8'))) |
| 322 | 125 elif item_data.item.name == 'item': |
|
398
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
126 msg_data.append([item_data.item['id'], make_message(item_data.item), |
|
845ed0f71dd6
mam: don't crash on missing <first> element in RSM on archive request
Goffi <goffi@goffi.org>
parents:
379
diff
changeset
|
127 item_data.created]) |
| 322 | 128 else: |
| 129 log.msg("WARNING: unknown element: {}".format(item_data.item.name)) | |
| 130 if pep: | |
| 131 # we need to send privileged message | |
| 132 # so me manage the sending ourself, and return | |
| 133 # an empty msg_data list to avoid double sending | |
| 134 for data in msg_data: | |
|
325
8d939378f023
mam: removed requestor in favor of mam_request.sender and recipient + fixed bad use of requestor instead of recipient in getItemsData
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
135 self.forwardPEPMessage(mam_request, *data) |
| 322 | 136 msg_data = [] |
|
379
66fbf026ed49
mam: set "complete" attribute when suitable
Goffi <goffi@goffi.org>
parents:
375
diff
changeset
|
137 return (msg_data, rsm_elt, attributes) |
|
282
7d54ff2eeaf2
actually retrieve the MAM messages
souliane <souliane@mailoo.org>
parents:
281
diff
changeset
|
138 |
| 322 | 139 d.addErrback(self._mapErrors) |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
140 d.addCallback(cb) |
|
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
141 return d |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
142 |
|
367
a772f7dac930
backend, storage(pgsql): creation/update date + serial ids:
Goffi <goffi@goffi.org>
parents:
335
diff
changeset
|
143 def forwardPEPMessage(self, mam_request, id_, elt, created): |
| 322 | 144 msg = domish.Element((None, 'message')) |
| 145 msg['from'] = self.backend.privilege.server_jid.full() | |
|
325
8d939378f023
mam: removed requestor in favor of mam_request.sender and recipient + fixed bad use of requestor instead of recipient in getItemsData
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
146 msg['to'] = mam_request.sender.full() |
| 322 | 147 result = msg.addElement((mam.NS_MAM, 'result')) |
| 148 if mam_request.query_id is not None: | |
| 149 result['queryid'] = mam_request.query_id | |
| 150 result['id'] = id_ | |
| 151 forward = result.addElement((const.NS_FORWARD, 'forwarded')) | |
|
367
a772f7dac930
backend, storage(pgsql): creation/update date + serial ids:
Goffi <goffi@goffi.org>
parents:
335
diff
changeset
|
152 forward.addChild(delay.Delay(created).toElement()) |
| 322 | 153 forward.addChild(elt) |
| 154 self.backend.privilege.sendMessage(msg) | |
| 155 | |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
156 def onPrefsGetRequest(self, requestor): |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
157 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
158 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
159 @param requestor: JID of the requestor. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
160 @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>} |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
161 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
162 @return: The current settings. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
163 @rtype: L{wokkel.mam.MAMPrefs} |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
164 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
165 # TODO: return the actual current settings |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
166 return mam.MAMPrefs() |
|
280
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
167 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
168 def onPrefsSetRequest(self, prefs, requestor): |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
169 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
170 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
171 @param prefs: The new settings to set. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
172 @type prefs: L{wokkel.mam.MAMPrefs} |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
173 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
174 @param requestor: JID of the requestor. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
175 @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>} |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
176 |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
177 @return: The settings that have actually been set. |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
178 @rtype: L{wokkel.mam.MAMPrefs} |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
179 """ |
|
798cb8962c0b
MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
180 # TODO: set the new settings and return them |
|
316
cca47e9977a5
mam: minor improvments (module import and some checks)
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
181 return mam.MAMPrefs() |