sat_tmp: wokkel/rsm.py annotate

annotate wokkel/rsm.py @ 9:9a4c367b22bb

tmp (rsm): better use of domish.Element.elements() + minor fixes

author	Goffi <goffi@goffi.org>
date	Wed, 27 May 2015 19:12:38 +0200
parents	a07bf3fb4b54
children	bcdae28d2b1f

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:
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	97 set_elt = element.elements(NS_RSM, 'set').next()
0 09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	98 except StopIteration:
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	99 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	100
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	101 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	102 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	103 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	104 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	105 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	106 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	107
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	108 if request.max is None:
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	109 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	110
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	111 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	112
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	113 def toElement(self):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	114 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	115 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	116
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	117 @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	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 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	120 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	121
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	122 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	123 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	124
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	125 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	126 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	127 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	128 else:
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').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	130
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	131 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	132 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	133
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	134 return set_elt
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	135
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	136 def render(self, element):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	137 """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	138
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	139 @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	140 @type element: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	141
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	142 @return: RSM request element.
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	143 @rtype: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	144 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	145 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	146 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	147
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	148 set_elt = self.toElement()
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	149 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	150
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	151 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	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
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	154 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	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 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	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 @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	159 @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	160
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	161 @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	162 @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	163
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	164 @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	165 @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	166
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	167 @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	168 @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	169 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	170
7 1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	171 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	172 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	173 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	174 if index is not None:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	175 assert isinstance(index, int) and index >= 0
4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	176 assert isinstance(first, unicode)
4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	177 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	178 else:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	179 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	180 self.index = index
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	181 self.first = first
1e21b4e94566 plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 6 diff changeset	182 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	183
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	184 @classmethod
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	185 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	186 """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	187
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	188 @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	189 @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	190
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	191 @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	192 @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	193 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	194 try:
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	195 set_elt = element.elements(NS_RSM, 'set').next()
0 09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	196 except StopIteration:
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	197 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	198
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	199 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	200 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	201 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	202 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	203 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	204 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	205 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	206 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	207
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	208 if response.count is None:
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	209 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	210
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	211 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	212
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	213 def toElement(self):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	214 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	215 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	216
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	217 @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	218 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	219 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	220 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	221
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	222 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	223 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	224 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	225 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	226
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	227 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	228
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	229 return set_elt
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	230
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	231 def render(self, element):
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	232 """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	233
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	234 @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	235 @type element: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	236
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	237 @return: RSM request element.
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	238 @rtype: L{domish.Element}
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	239 """
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	240 set_elt = self.toElement()
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	241 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	242 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	243
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	244 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	245 """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	246
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	247 @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	248 @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	249 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	250 result = {}
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	251 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	252 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	253 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	254 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	255 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	256
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	257
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	258 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	259 """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	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 @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	262 @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	263 """
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 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	266
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	267 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	268 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	269 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	270 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	271
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	272 def _parse_rsm(self, verbElement):
1 9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	273 try:
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	274 self.rsm = RSMRequest.parse(verbElement.parent)
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	275 except RSMNotFoundError:
9d35f88168a1 tmp: update tmp.wokkel.rsm, add tmp.wokkel.mam souliane <souliane@mailoo.org> parents: 0 diff changeset	276 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	277
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	278 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	279 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	280 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	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
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	283 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	284 """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	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 _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	287
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	288 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	289 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	290 """
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	291 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	292
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	293 @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	294 @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	295
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	296 @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	297 @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	298
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	299 @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	300 @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	301
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	302 @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	303 @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	304
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	305 @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	306 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	307 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	308 @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	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 @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	311 @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	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 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	314 @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	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 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	317 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	318 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	319 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	320 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	321 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	322 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	323 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	324 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	325 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	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 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	328 items = []
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	329 if iq.pubsub.items:
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	330 for element in iq.pubsub.items.elements(pubsub.NS_PUBSUB, 'item'):
9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	331 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	332
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 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	334 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	335 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	336 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	337 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	338
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	339 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	340 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	341 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	342
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	343 def getRSMResponse(self, id_):
9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	344 """Post-retrieve the RSM response data after items retrieval is done.
0 09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	345
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	346 @param id_: extension data ID
9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	347 @type id_: 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	348
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	349 @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	350 @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	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 # This method exists to not modify the return value of self.items.
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	353 if id_ not in self._rsm_responses:
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 return {}
9 9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	355 result = self._rsm_responses[id_].toDict()
9a4c367b22bb tmp (rsm): better use of domish.Element.elements() + minor fixes Goffi <goffi@goffi.org> parents: 8 diff changeset	356 del self._rsm_responses[id_]
0 09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	357 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	358
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 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	361 """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	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 _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	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 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	366 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	367 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	368 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	369 if set_elts:
5 4c3e159abf0b plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1 diff changeset	370 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	371 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	372
09e7c32a6a00 use sat.tmp.wokkel as a buffer module until the changes are integrated to wokkel souliane <souliane@mailoo.org> parents: diff changeset	373 return response

Mercurial > sat_tmp

annotate wokkel/rsm.py @ 9:9a4c367b22bb