Mercurial > libervia-backend

comparison src/plugins/plugin_xep_0059.py @ 1267:ea692d51a0ee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel
author souliane <souliane@mailoo.org>
date Mon, 15 Dec 2014 14:03:13 +0100
parents 16484ebb695b
children 069ad98b360d
comparison
equal deleted inserted replaced
1266:9141bde7ff31 1267:ea692d51a0ee
20 20
21 from sat.core.i18n import _ 21 from sat.core.i18n import _
22 from sat.core.log import getLogger 22 from sat.core.log import getLogger
23 log = getLogger(__name__) 23 log = getLogger(__name__)
24 24
25 from twisted.words.xish import domish
26 from wokkel import disco, iwokkel 25 from wokkel import disco, iwokkel
27 try: 26 try:
28 from twisted.words.protocols.xmlstream import XMPPHandler 27 from twisted.words.protocols.xmlstream import XMPPHandler
29 except ImportError: 28 except ImportError:
30 from wokkel.subprotocols import XMPPHandler 29 from wokkel.subprotocols import XMPPHandler
43 "description": _("""Implementation of Result Set Management""") 42 "description": _("""Implementation of Result Set Management""")
44 } 43 }
45 44
46 45
47 class XEP_0059(object): 46 class XEP_0059(object):
47 # XXX: RSM management is done directly in Wokkel.
48 48
49 def __init__(self, host): 49 def __init__(self, host):
50 log.info(_("Result Set Management plugin initialization")) 50 log.info(_("Result Set Management plugin initialization"))
51 self.host = host
52
53 def requestPage(self, stanza, limit=10, index=None, after=None, before=None):
54 """Embed a RSM page request in the given stanza.
55
56 @param stanza (domish.Element): any stanza to which RSM applies
57 @param limit (int): the maximum number of items in the page
58 @param index (int): the starting index of the requested page
59 @param after (str, int): the element immediately preceding the page
60 @param before (str, int): the element immediately following the page
61 """
62 main_elt = None
63 try:
64 main_elt = domish.generateElementsNamed(stanza.elements(), name="query").next()
65 except StopIteration:
66 try:
67 main_elt = domish.generateElementsNamed(stanza.elements(), name="pubsub").next()
68 except StopIteration:
69 log.warning("Injection of a RSM element only applies to query or pubsub stanzas")
70 return
71 limit = str(int(limit))
72
73 # in case the service doesn't support RSM, do this at least
74 main_elt.items.attributes['max_items'] = limit
75
76 set_elt = main_elt.addElement('set', NS_RSM)
77 set_elt.addElement('max').addContent(limit)
78 if index:
79 assert(after is None and before is None)
80 set_elt.addElement('index').addContent(str(int(index)))
81 if after:
82 assert(before is None) # could not specify both at the same time
83 set_elt.addElement('after').addContent(str(after))
84 if before is not None:
85 if before == '': # request the last page, according to http://xmpp.org/extensions/xep-0059.html#last
86 set_elt.addElement('before')
87 else:
88 set_elt.addElement('before').addContent(str(before))
89
90 def countItems(self, stanza):
91 """Count the items without retrieving any of them.
92
93 @param stanza (domish.Element): any stanza to which RSM applies
94 """
95 self.requestPage(stanza, limit=0)
96
97 def extractMetadata(self, stanza):
98 """Extract the RSM metadata from the given stanza.
99
100 @param stanza (domish.Element, wokkel.pubsub.PubSubRequest):
101 any stanza to which RSM applies. When used by XEP-0060,
102 wokkel's PubSubRequest instance is also accepted.
103 @return: dict containing the page metadata
104 """
105 try:
106 main_elt = domish.generateElementsNamed(stanza.elements(), name="query").next()
107 except StopIteration:
108 try:
109 main_elt = domish.generateElementsNamed(stanza.elements(), name="pubsub").next()
110 except StopIteration:
111 log.warning("Extracting data from a RSM element only applies to query or pubsub stanzas")
112 return {}
113 try:
114 set_elt = domish.generateElementsQNamed(main_elt.elements(), name="set", uri=NS_RSM).next()
115 except StopIteration:
116 log.debug("There's no RSM element in the stanza")
117 return {}
118
119 data = {}
120 elts = set_elt.elements()
121 try:
122 elt = elts.next()
123 if elt.name == "first":
124 data["first"] = "".join(elt.children)
125 data["first_index"] = int(elt.getAttribute("index"))
126 elif elt.name == "last":
127 data["last"] = "".join(elt.children)
128 elif elt.name == "count":
129 data["count"] = int("".join(elt.children))
130 except StopIteration:
131 pass
132 if "count" not in data:
133 log.warning("There's no 'count' element in the RSM element!")
134 return data
135 51
136 52
137 class XEP_0059_handler(XMPPHandler): 53 class XEP_0059_handler(XMPPHandler):
138 implements(iwokkel.IDisco) 54 implements(iwokkel.IDisco)
139 55