Mercurial > libervia-pubsub
comparison src/mam.py @ 369:dabee42494ac
config file + cleaning:
- SàT Pubsub can now be configured using the same config file as SàT itself (i.e. sat.conf or .sat.conf), in the same locations (/etc, local dir, xdg dir).
Its options must be in the "pubsub" section
- options on command line override config options
- removed tap and http files which are not used anymore
- changed directory structure to put source in src, to be coherent with SàT and Libervia
- changed options name, db* become db_*, secret become xmpp_pwd
- an exception is raised if jid or xmpp_pwd is are not configured
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 02 Mar 2018 12:59:38 +0100 |
parents | sat_pubsub/mam.py@a772f7dac930 |
children | 9a787881b824 |
comparison
equal
deleted
inserted
replaced
368:618a92080812 | 369:dabee42494ac |
---|---|
1 #!/usr/bin/python | |
2 #-*- coding: utf-8 -*- | |
3 | |
4 # Copyright (c) 2016 Jérôme Poisson | |
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 | |
20 """ | |
21 XMPP Message Archive Management protocol. | |
22 | |
23 This protocol is specified in | |
24 U{XEP-0313<http://xmpp.org/extensions/xep-0313.html>}. | |
25 """ | |
26 | |
27 | |
28 from zope.interface import implements | |
29 | |
30 from twisted.words.xish import domish | |
31 from twisted.python import log | |
32 from twisted.words.protocols.jabber import error | |
33 | |
34 from sat_pubsub import const | |
35 from sat_pubsub import backend | |
36 from wokkel import pubsub | |
37 | |
38 from wokkel import rsm | |
39 from wokkel import mam | |
40 from wokkel import delay | |
41 | |
42 | |
43 class MAMResource(object): | |
44 implements(mam.IMAMResource) | |
45 _errorMap = backend.PubSubResourceFromBackend._errorMap | |
46 | |
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()) | |
53 | |
54 condition, pubsubCondition, feature = self._errorMap[e] | |
55 msg = failure.value.msg | |
56 | |
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 | |
64 def onArchiveRequest(self, mam_request): | |
65 """ | |
66 | |
67 @param mam_request: The MAM archive request. | |
68 @type mam_request: L{MAMQueryReques<wokkel.mam.MAMRequest>} | |
69 | |
70 @return: A tuple with list of message data (id, element, data) and RSM element | |
71 @rtype: C{tuple} | |
72 """ | |
73 # FIXME: bad result ordering | |
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 | |
87 | |
88 d = self.backend.getItemsData(mam_request.node, mam_request.sender, mam_request.recipient, None, None, ext_data) | |
89 | |
90 def make_message(elt): | |
91 # XXX: http://xmpp.org/extensions/xep-0297.html#sect-idp629952 (rule 3) | |
92 message = domish.Element((const.NS_CLIENT, "message")) | |
93 event = message.addElement((pubsub.NS_PUBSUB_EVENT, "event")) | |
94 items = event.addElement('items') | |
95 items["node"] = mam_request.node | |
96 items.addChild(elt) | |
97 return message | |
98 | |
99 def cb(items_data): | |
100 msg_data = [] | |
101 rsm_elt = None | |
102 for item_data in items_data: | |
103 if item_data.item.name == 'set' and item_data.item.uri == rsm.NS_RSM: | |
104 assert rsm_elt is None | |
105 rsm_elt = item_data.item | |
106 elif item_data.item.name == 'item': | |
107 msg_data.append([item_data.item['id'], make_message(item_data.item), item_data.created]) | |
108 else: | |
109 log.msg("WARNING: unknown element: {}".format(item_data.item.name)) | |
110 if pep: | |
111 # we need to send privileged message | |
112 # so me manage the sending ourself, and return | |
113 # an empty msg_data list to avoid double sending | |
114 for data in msg_data: | |
115 self.forwardPEPMessage(mam_request, *data) | |
116 msg_data = [] | |
117 return (msg_data, rsm_elt) | |
118 | |
119 d.addErrback(self._mapErrors) | |
120 d.addCallback(cb) | |
121 return d | |
122 | |
123 def forwardPEPMessage(self, mam_request, id_, elt, created): | |
124 msg = domish.Element((None, 'message')) | |
125 msg['from'] = self.backend.privilege.server_jid.full() | |
126 msg['to'] = mam_request.sender.full() | |
127 result = msg.addElement((mam.NS_MAM, 'result')) | |
128 if mam_request.query_id is not None: | |
129 result['queryid'] = mam_request.query_id | |
130 result['id'] = id_ | |
131 forward = result.addElement((const.NS_FORWARD, 'forwarded')) | |
132 forward.addChild(delay.Delay(created).toElement()) | |
133 forward.addChild(elt) | |
134 self.backend.privilege.sendMessage(msg) | |
135 | |
136 def onPrefsGetRequest(self, requestor): | |
137 """ | |
138 | |
139 @param requestor: JID of the requestor. | |
140 @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>} | |
141 | |
142 @return: The current settings. | |
143 @rtype: L{wokkel.mam.MAMPrefs} | |
144 """ | |
145 # TODO: return the actual current settings | |
146 return mam.MAMPrefs() | |
147 | |
148 def onPrefsSetRequest(self, prefs, requestor): | |
149 """ | |
150 | |
151 @param prefs: The new settings to set. | |
152 @type prefs: L{wokkel.mam.MAMPrefs} | |
153 | |
154 @param requestor: JID of the requestor. | |
155 @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>} | |
156 | |
157 @return: The settings that have actually been set. | |
158 @rtype: L{wokkel.mam.MAMPrefs} | |
159 """ | |
160 # TODO: set the new settings and return them | |
161 return mam.MAMPrefs() |