Mercurial > sat_tmp
annotate sat_tmp/wokkel/rsm.py @ 87:42cb377e3f3e
wokkel (rsm): deep copy `_legacyHandlers` before modifying it, so original PubSubService is not affected
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 16 May 2022 14:21:11 +0200 |
parents | ba3f695fff34 |
children |
rev | line source |
---|---|
8 | 1 # -*- coding: utf-8 -*- |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
2 # -*- test-case-name: wokkel.test.test_rsm -*- |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
3 # |
6 | 4 # SàT Wokkel extension for Result Set Management (XEP-0059) |
60 | 5 # Copyright (C) 2015-2019 Jérôme Poisson (goffi@goffi.org) |
6 | 6 # Copyright (C) 2015 Adien Cossa (souliane@mailoo.org) |
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/>. | |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
20 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
21 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
22 XMPP Result Set Management protocol. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
23 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
24 This protocol is specified in |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
25 U{XEP-0059<http://xmpp.org/extensions/xep-0059.html>}. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
26 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
27 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
28 from twisted.words.xish import domish |
27
a24c2476f7e0
tmp (wokkel.rsm): RSMError now inherit from StanzaError, so they are correctly handled by services
Goffi <goffi@goffi.org>
parents:
26
diff
changeset
|
29 from twisted.words.protocols.jabber import error |
85
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
30 from wokkel import disco |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
31 |
69 | 32 from . import pubsub |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
33 import copy |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
34 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
35 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
36 NS_RSM = 'http://jabber.org/protocol/rsm' |
85
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
37 NS_PUBSUB_RSM = "http://jabber.org/protocol/pubsub#rsm" |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
38 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
39 |
27
a24c2476f7e0
tmp (wokkel.rsm): RSMError now inherit from StanzaError, so they are correctly handled by services
Goffi <goffi@goffi.org>
parents:
26
diff
changeset
|
40 class RSMError(error.StanzaError): |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
41 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
42 RSM error. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
43 """ |
27
a24c2476f7e0
tmp (wokkel.rsm): RSMError now inherit from StanzaError, so they are correctly handled by services
Goffi <goffi@goffi.org>
parents:
26
diff
changeset
|
44 def __init__(self, text=None): |
a24c2476f7e0
tmp (wokkel.rsm): RSMError now inherit from StanzaError, so they are correctly handled by services
Goffi <goffi@goffi.org>
parents:
26
diff
changeset
|
45 error.StanzaError.__init__(self, 'bad-request', text=text) |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
46 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
47 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
48 class RSMNotFoundError(Exception): |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
49 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
50 An expected RSM element has not been found. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
51 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
52 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
53 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
54 class RSMRequest(object): |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
55 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
56 A Result Set Management request. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
57 |
5
4c3e159abf0b
plugins (groupblog, xep-0277) + tmp(rsm): improved style:
Goffi <goffi@goffi.org>
parents:
1
diff
changeset
|
58 @ivar max_: limit on the number of retrieved items. |
4c3e159abf0b
plugins (groupblog, xep-0277) + tmp(rsm): improved style:
Goffi <goffi@goffi.org>
parents:
1
diff
changeset
|
59 @itype max_: C{int} or C{unicode} |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
60 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
61 @ivar index: starting index of the requested page. |
7
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
62 @itype index: C{int} or C{unicode} or C{None} |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
63 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
64 @ivar after: ID of the element immediately preceding the page. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
65 @itype after: C{unicode} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
66 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
67 @ivar before: ID of the element immediately following the page. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
68 @itype before: C{unicode} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
69 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
70 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
71 def __init__(self, max_=10, after=None, before=None, index=None): |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
72 self.max = int(max_) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
73 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
74 if index is not None: |
5
4c3e159abf0b
plugins (groupblog, xep-0277) + tmp(rsm): improved style:
Goffi <goffi@goffi.org>
parents:
1
diff
changeset
|
75 assert after is None and before is None |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
76 index = int(index) |
7
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
77 self.index = index |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
78 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
79 if after is not None: |
5
4c3e159abf0b
plugins (groupblog, xep-0277) + tmp(rsm): improved style:
Goffi <goffi@goffi.org>
parents:
1
diff
changeset
|
80 assert before is None |
69 | 81 assert isinstance(after, str) |
7
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
82 self.after = after |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
83 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
84 if before is not None: |
69 | 85 assert isinstance(before, str) |
7
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
86 self.before = before |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
87 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
88 def __str__(self): |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
89 return "RSM Request: max={0.max} after={0.after} before={0.before} index={0.index}".format(self) |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
90 |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
91 @classmethod |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
92 def fromElement(cls, element): |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
93 """Parse the given request element. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
94 |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
95 @param element: request containing a set element, or set element itself. |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
96 @type element: L{domish.Element} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
97 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
98 @return: RSMRequest instance. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
99 @rtype: L{RSMRequest} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
100 """ |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
101 |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
102 if element.name == 'set' and element.uri == NS_RSM: |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
103 set_elt = element |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
104 else: |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
105 try: |
69 | 106 set_elt = next(element.elements(NS_RSM, 'set')) |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
107 except StopIteration: |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
108 raise RSMNotFoundError() |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
109 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
110 try: |
69 | 111 before_elt = next(set_elt.elements(NS_RSM, 'before')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
112 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
113 before = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
114 else: |
69 | 115 before = str(before_elt) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
116 |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
117 try: |
69 | 118 after_elt = next(set_elt.elements(NS_RSM, 'after')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
119 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
120 after = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
121 else: |
69 | 122 after = str(after_elt) |
28
c782fb5237f8
tmp (wokkel.rsm): raise RSMError when <after/> element is empty
Goffi <goffi@goffi.org>
parents:
27
diff
changeset
|
123 if not after: |
c782fb5237f8
tmp (wokkel.rsm): raise RSMError when <after/> element is empty
Goffi <goffi@goffi.org>
parents:
27
diff
changeset
|
124 raise RSMError("<after/> element can't be empty in RSM request") |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
125 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
126 try: |
69 | 127 max_elt = next(set_elt.elements(NS_RSM, 'max')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
128 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
129 # FIXME: even if it doesn't make a lot of sense without it |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
130 # <max/> element is not mandatory in XEP-0059 |
7
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
131 raise RSMError("RSM request is missing its 'max' element") |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
132 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
133 try: |
69 | 134 max_ = int(str(max_elt)) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
135 except ValueError: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
136 raise RSMError("bad value for 'max' element") |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
137 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
138 try: |
69 | 139 index_elt = next(set_elt.elements(NS_RSM, 'index')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
140 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
141 index = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
142 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
143 try: |
69 | 144 index = int(str(index_elt)) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
145 except ValueError: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
146 raise RSMError("bad value for 'index' element") |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
147 |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
148 return RSMRequest(max_, after, before, index) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
149 |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
150 def toElement(self): |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
151 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
152 Return the DOM representation of this RSM request. |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
153 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
154 @rtype: L{domish.Element} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
155 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
156 set_elt = domish.Element((NS_RSM, 'set')) |
69 | 157 set_elt.addElement('max', content=str(self.max)) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
158 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
159 if self.index is not None: |
69 | 160 set_elt.addElement('index', content=str(self.index)) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
161 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
162 if self.before is not None: |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
163 if self.before == '': # request the last page |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
164 set_elt.addElement('before') |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
165 else: |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
166 set_elt.addElement('before', content=self.before) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
167 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
168 if self.after is not None: |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
169 set_elt.addElement('after', content=self.after) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
170 |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
171 return set_elt |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
172 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
173 def render(self, element): |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
174 """Embed the DOM representation of this RSM request in the given element. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
175 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
176 @param element: Element to contain the RSM request. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
177 @type element: L{domish.Element} |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
178 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
179 @return: RSM request element. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
180 @rtype: L{domish.Element} |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
181 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
182 set_elt = self.toElement() |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
183 element.addChild(set_elt) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
184 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
185 return set_elt |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
186 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
187 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
188 class RSMResponse(object): |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
189 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
190 A Result Set Management response. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
191 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
192 @ivar first: ID of the first element of the returned page. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
193 @itype first: C{unicode} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
194 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
195 @ivar last: ID of the last element of the returned page. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
196 @itype last: C{unicode} |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
197 |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
198 @ivar index: starting index of the returned page. |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
199 @itype index: C{int} |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
200 |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
201 @ivar count: total number of items. |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
202 @itype count: C{int} |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
203 |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
204 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
205 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
206 def __init__(self, first=None, last=None, index=None, count=None): |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
207 if first is None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
208 assert last is None and index is None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
209 if last is None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
210 assert first is None |
7
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
211 self.first = first |
1e21b4e94566
plugin groupblog, tmp (mam, rsm): some style improvments/fixes:
Goffi <goffi@goffi.org>
parents:
6
diff
changeset
|
212 self.last = last |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
213 if count is not None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
214 self.count = int(count) |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
215 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
216 self.count = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
217 if index is not None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
218 self.index = int(index) |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
219 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
220 self.index = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
221 |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
222 def __str__(self): |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
223 return "RSM Request: first={0.first} last={0.last} index={0.index} count={0.count}".format(self) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
224 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
225 @classmethod |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
226 def fromElement(cls, element): |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
227 """Parse the given response element. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
228 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
229 @param element: response element. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
230 @type element: L{domish.Element} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
231 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
232 @return: RSMResponse instance. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
233 @rtype: L{RSMResponse} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
234 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
235 try: |
69 | 236 set_elt = next(element.elements(NS_RSM, 'set')) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
237 except StopIteration: |
11
bcdae28d2b1f
tmp (wokkel): pubsub response do not fail when target server doesn't handle RSM
souliane <souliane@mailoo.org>
parents:
9
diff
changeset
|
238 raise RSMNotFoundError() |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
239 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
240 try: |
69 | 241 first_elt = next(set_elt.elements(NS_RSM, 'first')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
242 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
243 first = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
244 index = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
245 else: |
69 | 246 first = str(first_elt) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
247 try: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
248 index = int(first_elt['index']) |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
249 except KeyError: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
250 index = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
251 except ValueError: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
252 raise RSMError("bad index in RSM response") |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
253 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
254 try: |
69 | 255 last_elt = next(set_elt.elements(NS_RSM, 'last')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
256 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
257 if first is not None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
258 raise RSMError("RSM response is missing its 'last' element") |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
259 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
260 last = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
261 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
262 if first is None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
263 raise RSMError("RSM response is missing its 'first' element") |
69 | 264 last = str(last_elt) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
265 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
266 try: |
69 | 267 count_elt = next(set_elt.elements(NS_RSM, 'count')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
268 except StopIteration: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
269 count = None |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
270 else: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
271 try: |
69 | 272 count = int(str(count_elt)) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
273 except ValueError: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
274 raise RSMError("invalid count in RSM response") |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
275 |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
276 return RSMResponse(first, last, index, count) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
277 |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
278 def toElement(self): |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
279 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
280 Return the DOM representation of this RSM request. |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
281 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
282 @rtype: L{domish.Element} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
283 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
284 set_elt = domish.Element((NS_RSM, 'set')) |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
285 if self.first is not None: |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
286 first_elt = set_elt.addElement('first', content=self.first) |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
287 if self.index is not None: |
69 | 288 first_elt['index'] = str(self.index) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
289 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
290 set_elt.addElement('last', content=self.last) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
291 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
292 if self.count is not None: |
69 | 293 set_elt.addElement('count', content=str(self.count)) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
294 |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
295 return set_elt |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
296 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
297 def render(self, element): |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
298 """Embed the DOM representation of this RSM response in the given element. |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
299 |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
300 @param element: Element to contain the RSM response. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
301 @type element: L{domish.Element} |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
302 |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
303 @return: RSM request element. |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
304 @rtype: L{domish.Element} |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
305 """ |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
306 set_elt = self.toElement() |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
307 element.addChild(set_elt) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
308 return set_elt |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
309 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
310 def toDict(self): |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
311 """Return a dict representation of the object. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
312 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
313 @return: a dict of strings. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
314 @rtype: C{dict} binding C{unicode} to C{unicode} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
315 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
316 result = {} |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
317 for attr in ('first', 'last', 'index', 'count'): |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
318 value = getattr(self, attr) |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
319 if value is not None: |
74
76b7ae23dc66
wokkel (rsm): don't convert value to str anymore in RSMResponse.toDict
Goffi <goffi@goffi.org>
parents:
69
diff
changeset
|
320 result[attr] = value |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
321 return result |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
322 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
323 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
324 class PubSubRequest(pubsub.PubSubRequest): |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
325 """PubSubRequest extension to handle RSM. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
326 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
327 @ivar rsm: RSM request instance. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
328 @type rsm: L{RSMRequest} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
329 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
330 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
331 rsm = None |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
332 _parameters = copy.deepcopy(pubsub.PubSubRequest._parameters) |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
333 _parameters['items'].append('rsm') |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
334 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
335 def _parse_rsm(self, verbElement): |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
336 try: |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
337 self.rsm = RSMRequest.fromElement(verbElement.parent) |
1
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
338 except RSMNotFoundError: |
9d35f88168a1
tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam
souliane <souliane@mailoo.org>
parents:
0
diff
changeset
|
339 self.rsm = None |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
340 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
341 def _render_rsm(self, verbElement): |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
342 if self.rsm: |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
343 self.rsm.render(verbElement.parent) |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
344 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
345 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
346 class PubSubClient(pubsub.PubSubClient): |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
347 """PubSubClient extension to handle RSM.""" |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
348 |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
349 _request_class = PubSubRequest |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
350 |
58
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
351 def items(self, service, nodeIdentifier, maxItems=None, |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
352 subscriptionIdentifier=None, sender=None, itemIdentifiers=None, |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
353 orderBy=None, rsm_request=None): |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
354 """ |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
355 Retrieve previously published items from a publish subscribe node. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
356 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
357 @param service: The publish subscribe service that keeps the node. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
358 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
359 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
360 @param nodeIdentifier: The identifier of the node. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
361 @type nodeIdentifier: C{unicode} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
362 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
363 @param maxItems: Optional limit on the number of retrieved items. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
364 @type maxItems: C{int} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
365 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
366 @param subscriptionIdentifier: Optional subscription identifier. In |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
367 case the node has been subscribed to multiple times, this narrows |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
368 the results to the specific subscription. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
369 @type subscriptionIdentifier: C{unicode} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
370 |
58
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
371 @param itemIdentifiers: Identifiers of the items to be retrieved. |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
372 @type itemIdentifiers: C{set} |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
373 |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
374 @param orderBy: Keys to order by |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
375 @type orderBy: L{list} of L{unicode} |
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
376 |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
377 @param ext_data: extension data. |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
378 @type ext_data: L{dict} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
379 |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
380 @return: a Deferred that fires a C{list} of C{tuple} of L{domish.Element}, L{RSMResponse}. |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
381 @rtype: L{defer.Deferred} |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
382 """ |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
383 # XXX: we have to copy initial method instead of calling it, |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
384 # as original cb remove all non item elements |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
385 request = self._request_class('items') |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
386 request.recipient = service |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
387 request.nodeIdentifier = nodeIdentifier |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
388 if maxItems: |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
389 request.maxItems = str(int(maxItems)) |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
390 request.subscriptionIdentifier = subscriptionIdentifier |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
391 request.sender = sender |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
392 request.itemIdentifiers = itemIdentifiers |
58
f4d569dc8e6b
wokkel/mam, wokkel/pubsub, wokkel/rsm: implemented "order-by" protoXEP (for Pubsub and MAM)
Goffi <goffi@goffi.org>
parents:
45
diff
changeset
|
393 request.orderBy = orderBy |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
394 request.rsm = rsm_request |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
395 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
396 def cb(iq): |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
397 items = [] |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
398 pubsub_elt = iq.pubsub |
34
213122b92b08
tmp/wokkel (rsm): fixes elements count (items retrieval with RSM max = 0)
souliane <souliane@mailoo.org>
parents:
28
diff
changeset
|
399 if pubsub_elt.items: |
213122b92b08
tmp/wokkel (rsm): fixes elements count (items retrieval with RSM max = 0)
souliane <souliane@mailoo.org>
parents:
28
diff
changeset
|
400 for element in pubsub_elt.items.elements(pubsub.NS_PUBSUB, 'item'): |
213122b92b08
tmp/wokkel (rsm): fixes elements count (items retrieval with RSM max = 0)
souliane <souliane@mailoo.org>
parents:
28
diff
changeset
|
401 items.append(element) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
402 |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
403 try: |
25
4816f7d55367
tmp (wokkel.rsm): fixed forgotten method renaming
Goffi <goffi@goffi.org>
parents:
23
diff
changeset
|
404 rsm_response = RSMResponse.fromElement(pubsub_elt) |
23
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
405 except RSMNotFoundError: |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
406 rsm_response = None |
777b4e63fc8a
plugin XEP-0060, tmp(wokkel.rsm): small refactoring:
Goffi <goffi@goffi.org>
parents:
21
diff
changeset
|
407 return (items, rsm_response) |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
408 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
409 d = request.send(self.xmlstream) |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
410 d.addCallback(cb) |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
411 return d |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
412 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
413 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
414 class PubSubService(pubsub.PubSubService): |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
415 """PubSubService extension to handle RSM.""" |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
416 |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
417 _request_class = PubSubRequest |
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
418 |
84 | 419 def _toResponse_items(self, resp_tuple, resource, request): |
420 elts, rsm_response = resp_tuple | |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
421 |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
422 response = pubsub.PubSubService._toResponse_items(self, elts, |
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
423 resource, request) |
84 | 424 if rsm_response is not None: |
425 response.addChild(rsm_response.toElement()) | |
21
54f834e40341
tmp (wokkel/rsm): various improvments:
Goffi <goffi@goffi.org>
parents:
19
diff
changeset
|
426 |
0
09e7c32a6a00
use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel
souliane <souliane@mailoo.org>
parents:
diff
changeset
|
427 return response |
84 | 428 |
85
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
429 def getDiscoInfo(self, requestor, target, nodeIdentifier=''): |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
430 def appendRSMFeatures(info): |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
431 for ns in (NS_RSM, NS_PUBSUB_RSM): |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
432 feature = disco.DiscoFeature(ns) |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
433 if feature not in info: |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
434 info.append(feature) |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
435 return info |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
436 d = super().getDiscoInfo(requestor, target, nodeIdentifier) |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
437 d.addCallback(appendRSMFeatures) |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
438 return d |
ba3f695fff34
wokkel(rsm): add RSM and Pubsub RSM features to disco
Goffi <goffi@goffi.org>
parents:
84
diff
changeset
|
439 |
84 | 440 |
87
42cb377e3f3e
wokkel (rsm): deep copy `_legacyHandlers` before modifying it, so original PubSubService is not affected
Goffi <goffi@goffi.org>
parents:
85
diff
changeset
|
441 PubSubService._legacyHandlers = copy.deepcopy(pubsub.PubSubService._legacyHandlers) |
84 | 442 PubSubService._legacyHandlers["items"][1].append("rsm") |