sat_tmp: wokkel/rsm.py annotate

annotate wokkel/rsm.py @ 8:a07bf3fb4b54

core (tests): test fixes

author	Goffi <goffi@goffi.org>
date	Thu, 23 Apr 2015 14:19:43 +0200
parents	1e21b4e94566
children	9a4c367b22bb

rev	line source
8 a07bf3fb4b54 core (tests): test fixes Goffi <goffi@goffi.org> parents: 7 diff changeset	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 dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	4 # SàT Wokkel extension for Result Set Management (XEP-0059)
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	5 # Copyright (C) 2015 Adien Cossa (souliane@mailoo.org)
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	6
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	7 # This program is free software: you can redistribute it and/or modify
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	10 # (at your option) any later version.
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	11
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	12 # This program is distributed in the hope that it will be useful,
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	15 # GNU Affero General Public License for more details.
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	16
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
dc3a3f454f39 tmp (wokkel): licenses fixes: Goffi <goffi@goffi.org> parents: 5 diff changeset	18 # 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	19
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 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	22
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	23 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	24 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	25 """
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 from twisted.words.xish import domish
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	28
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	29 import pubsub
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	30 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	31
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	32
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	33 # RSM namespace
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	34 NS_RSM = 'http://jabber.org/protocol/rsm'
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
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	37 class RSMError(Exception):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	38 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	39 RSM error.
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	40 """
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
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	43 class RSMNotFoundError(Exception):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	44 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	45 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	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
0 09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	49 class RSMRequest():
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	50 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	51 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	52
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	53 @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	54 @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	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 @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	57 @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	58
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	59 @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	60 @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	61
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	62 @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	63 @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	64 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	65
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	66 def __init__(self, max_=10, index=None, after=None, before=None):
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	67 max_ = int(max_)
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	68 assert max_ >= 0
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	69 self.max = 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	70
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	71 if index is not None:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	72 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	73 index = int(index)
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	74 assert index >= 0
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	75 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	76
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	77 if after is not None:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	78 assert before is None
4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	79 assert isinstance(after, unicode)
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	80 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	81
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	82 if before is not None:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	83 assert isinstance(before, unicode)
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	84 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	85
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	86 @classmethod
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	87 def parse(cls, element):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	88 """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	89
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	90 @param element: request containing a set element.
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	91 @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	92
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	93 @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	94 @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	95 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	96 try:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	97 set_elt = domish.generateElementsQNamed(element.elements(),
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	98 name="set",
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	99 uri=NS_RSM).next()
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	100 except StopIteration:
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	101 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	102
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	103 request = RSMRequest()
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	104 for elt in list(set_elt.elements()):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	105 if elt.name in ('before', 'after'):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	106 setattr(request, elt.name, ''.join(elt.children))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	107 elif elt.name in ('max', 'index'):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	108 setattr(request, elt.name, int(''.join(elt.children)))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	109
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	110 if request.max is None:
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	111 raise RSMError("RSM request is missing its '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	112
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	113 return request
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	114
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	115 def toElement(self):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	116 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	117 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	118
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	119 @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	120 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	121 set_elt = domish.Element((NS_RSM, 'set'))
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	122 set_elt.addElement('max').addContent(unicode(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	123
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	124 if self.index 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	125 set_elt.addElement('index').addContent(unicode(self.index))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	126
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	127 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	128 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	129 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	130 else:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	131 set_elt.addElement('before').addContent(self.before)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	132
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	133 if self.after 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	134 set_elt.addElement('after').addContent(self.after)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	135
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	136 return set_elt
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	137
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	138 def render(self, element):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	139 """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	140
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	141 @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	142 @type element: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	143
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	144 @return: RSM request element.
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	145 @rtype: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	146 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	147 if element.name == 'pubsub' and hasattr(element, 'items'):
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	148 element.items.attributes['max_items'] = unicode(self.max)
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	149
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	150 set_elt = self.toElement()
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	151 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	152
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	153 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	154
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 class RSMResponse():
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	157 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	158 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	159
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	160 @ivar count: total number of items.
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	161 @itype count: 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	162
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	163 @ivar index: starting index 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	164 @itype index: 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	165
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	166 @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	167 @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	168
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	169 @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	170 @itype last: 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	171 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	172
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	173 def __init__(self, count=0, index=None, first=None, last=None):
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	174 assert isinstance(count, int) and count >= 0
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	175 self.count = 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	176 if index is not None:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	177 assert isinstance(index, int) and index >= 0
4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	178 assert isinstance(first, unicode)
4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	179 assert isinstance(last, 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	180 else:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	181 assert first is None and last is None
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	182 self.index = index
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	183 self.first = first
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	184 self.last = 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	185
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	186 @classmethod
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	187 def parse(cls, element):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	188 """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	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 @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	191 @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	192
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	193 @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	194 @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	195 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	196 try:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	197 set_elt = domish.generateElementsQNamed(element.elements(),
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	198 name="set",
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	199 uri=NS_RSM).next()
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	200 except StopIteration:
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	201 return 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	202
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	203 response = RSMResponse()
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	204 for elt in list(set_elt.elements()):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	205 if elt.name in ('first', 'last'):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	206 setattr(response, elt.name, ''.join(elt.children))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	207 if elt.name == 'first':
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	208 response.index = int(elt.getAttribute("index"))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	209 elif elt.name == 'count':
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	210 response.count = int(''.join(elt.children))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	211
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	212 if response.count is None:
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	213 raise RSMError("RSM response is missing its 'count' 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	214
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	215 return response
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	216
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	217 def toElement(self):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	218 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	219 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	220
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	221 @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	222 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	223 set_elt = domish.Element((NS_RSM, 'set'))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	224 set_elt.addElement('count').addContent(unicode(self.count))
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	225
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	226 if self.index 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	227 first_elt = set_elt.addElement('first')
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	228 first_elt.addContent(self.first)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	229 first_elt['index'] = unicode(self.index)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	230
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	231 set_elt.addElement('last').addContent(self.last)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	232
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	233 return set_elt
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	234
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	235 def render(self, element):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	236 """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	237
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	238 @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	239 @type element: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	240
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	241 @return: RSM request element.
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	242 @rtype: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	243 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	244 set_elt = self.toElement()
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	245 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	246 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	247
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	248 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	249 """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	250
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	251 @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	252 @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	253 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	254 result = {}
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	255 for attr in ('count', 'index', 'first', 'last'):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	256 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	257 if value 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	258 result[attr] = unicode(value)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	259 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	260
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	261
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	262 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	263 """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	264
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	265 @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	266 @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	267 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	268
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	269 rsm = None
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	270
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	271 def __init__(self, verb=None):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	272 pubsub.PubSubRequest.__init__(self, verb)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	273 self._parameters = copy.deepcopy(pubsub.PubSubRequest._parameters)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	274 self._parameters['items'].append('rsm')
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	275
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	276 def _parse_rsm(self, verbElement):
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	277 try:
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	278 self.rsm = RSMRequest.parse(verbElement.parent)
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	279 except RSMNotFoundError:
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	280 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	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 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	283 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	284 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	285
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	286
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	287 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	288 """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	289
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	290 _rsm_responses = {}
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	291
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	292 def items(self, service, nodeIdentifier, maxItems=None, itemIdentifiers=None,
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	293 subscriptionIdentifier=None, sender=None, ext_data=None):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	294 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	295 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	296
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	297 @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	298 @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	299
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	300 @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	301 @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	302
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	303 @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	304 @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	305
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	306 @param itemIdentifiers: Identifiers of the items to be retrieved.
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	307 @type itemIdentifiers: C{set}
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	308
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	309 @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	310 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	311 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	312 @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	313
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	314 @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	315 @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	316
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	317 @return: a Deferred that fires a C{list} of 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	318 @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	319 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	320 request = PubSubRequest('items') # that's a rsm.PubSubRequest instance
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	321 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	322 request.nodeIdentifier = nodeIdentifier
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	323 if maxItems:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	324 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	325 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	326 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	327 request.itemIdentifiers = itemIdentifiers
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	328 if ext_data and 'rsm' in ext_data:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	329 request.rsm = ext_data['rsm']
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 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	332 items = []
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	333 if iq.pubsub.items:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	334 for element in iq.pubsub.items.elements():
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	335 if element.uri == pubsub.NS_PUBSUB and element.name == 'item':
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	336 items.append(element)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	337
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	338 if request.rsm:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	339 response = RSMResponse.parse(iq.pubsub)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	340 if response 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	341 self._rsm_responses[ext_data['id']] = response
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	342 return items
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	343
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	344 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	345 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	346 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	347
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	348 def getRSMResponse(self, id):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	349 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	350 Post-retrieve the RSM response data after items retrieval is done.
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	351
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	352 @param id: extension data ID
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	353 @type id: 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	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 @return: dict representation of the RSM response.
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	356 @rtype: C{dict} of 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	357 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	358 # This method exists to not modify the return value of self.items.
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	359 if id not in self._rsm_responses:
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	360 return {}
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	361 result = self._rsm_responses[id].toDict()
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	362 del self._rsm_responses[id]
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	363 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	364
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 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	367 """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	368
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	369 _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	370
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	371 def _toResponse_items(self, result, resource, request):
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	372 response = pubsub.PubSubService._toResponse_items(self, result,
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	373 resource, request)
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	374 set_elts = [elt for elt in result if elt.name == 'set']
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	375 if set_elts:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	376 assert len(set_elts) == 1
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 response.addChild(set_elts[0])
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	378
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	379 return response

Mercurial > sat_tmp

annotate wokkel/rsm.py @ 8:a07bf3fb4b54