2 NEPI, a framework to manage network experiments
3 Copyright (C) 2013 INRIA
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from nepi.util.logger import Logger
23 from sleekxmpp.exceptions import IqError, IqTimeout
25 import xml.etree.ElementTree as ET
27 # inherit from BaseXmpp and XMLStream classes
28 class OMFClient(sleekxmpp.ClientXMPP, Logger):
30 .. class:: Class Args :
32 :param jid: Jabber Id (= Xmpp Slice + Date)
34 :param password: Jabber Password (= Xmpp Password)
39 This class is an XMPP Client with customized method
43 def __init__(self, jid, password):
46 :param jid: Jabber Id (= Xmpp Slice + Date)
48 :param password: Jabber Password (= Xmpp Password)
53 Logger.__init__(self, "OMFClient")
55 sleekxmpp.ClientXMPP.__init__(self, jid, password)
57 self._registered = False
60 self.register_plugin('xep_0077') # In-band registration
61 self.register_plugin('xep_0030')
62 self.register_plugin('xep_0059')
63 self.register_plugin('xep_0060') # PubSub
65 self.add_event_handler("session_start", self.start)
66 self.add_event_handler("register", self.register)
67 self.add_event_handler("pubsub_publish", self.handle_omf_message)
71 """ Check if the client is ready
76 def start(self, event):
77 """ Send presence to the Xmppp Server. This function is called directly by the sleekXmpp library
82 self._server = "pubsub.%s" % self.boundjid.domain
84 def register(self, iq):
85 """ Register to the Xmppp Server. This function is called directly by the sleekXmpp library
89 msg = " %s already registered!" % self.boundjid
95 resp['register']['username'] = self.boundjid.user
96 resp['register']['password'] = self.password
100 msg = " Account created for %s!" % self.boundjid
102 self._registered = True
104 msg = " Could not register account: %s" % e.iq['error']['text']
107 msg = " No response from server."
110 def unregister(self):
111 """ Unregister from the Xmppp Server.
115 self.plugin['xep_0077'].cancel_registration(
116 ifrom=self.boundjid.full)
117 msg = " Account unregistered for %s!" % self.boundjid
120 msg = " Could not unregister account: %s" % e.iq['error']['text']
123 msg = " No response from server."
127 """ Get all the nodes of the Xmppp Server.
131 result = self['xep_0060'].get_nodes(self._server)
132 for item in result['disco_items']['items']:
133 msg = ' - %s' % str(item)
137 error = traceback.format_exc()
138 msg = 'Could not retrieve node list.\ntraceback:\n%s' % error
141 def subscriptions(self):
142 """ Get all the subscriptions of the Xmppp Server.
146 result = self['xep_0060'].get_subscriptions(self._server)
148 for node in result['node']:
149 msg = ' - %s' % str(node)
153 error = traceback.format_exc()
154 msg = ' Could not retrieve subscriptions.\ntraceback:\n%s' % error
157 def create(self, node):
158 """ Create the topic corresponding to the node
160 :param node: Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)
164 msg = " Create Topic : " + node
167 config = self['xep_0004'].makeForm('submit')
168 config.add_field(var='pubsub#node_type', value='leaf')
169 config.add_field(var='pubsub#notify_retract', value='0')
170 config.add_field(var='pubsub#publish_model', value='open')
171 config.add_field(var='pubsub#persist_items', value='1')
172 config.add_field(var='pubsub#max_items', value='1')
173 config.add_field(var='pubsub#title', value=node)
176 self['xep_0060'].create_node(self._server, node, config = config)
178 error = traceback.format_exc()
179 msg = ' Could not create topic: %s\ntraceback:\n%s' % (node, error)
182 def delete(self, node):
183 """ Delete the topic corresponding to the node
185 :param node: Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)
189 # To check if the queue are well empty at the end
190 #print " length of the queue : " + str(self.send_queue.qsize())
191 #print " length of the queue : " + str(self.event_queue.qsize())
193 self['xep_0060'].delete_node(self._server, node)
194 msg = ' Deleted node: %s' % node
197 error = traceback.format_exc()
198 msg = ' Could not delete topic: %s\ntraceback:\n%s' % (node, error)
201 def publish(self, data, node):
202 """ Publish the data to the corresponding topic
204 :param data: Data that will be published
206 :param node: Name of the topic
211 msg = " Publish to Topic : " + node
214 result = self['xep_0060'].publish(self._server,node,payload=data)
215 # id = result['pubsub']['publish']['item']['id']
216 # print('Published at item id: %s' % id)
218 error = traceback.format_exc()
219 msg = ' Could not publish to: %s\ntraceback:\n%s' % (node, error)
225 :param data: data from which the items will be get back
231 result = self['xep_0060'].get_item(self._server, self.boundjid,
233 for item in result['pubsub']['items']['substanzas']:
234 msg = 'Retrieved item %s: %s' % (item['id'], tostring(item['payload']))
237 error = traceback.format_exc()
238 msg = ' Could not retrieve item %s from topic %s\ntraceback:\n%s' \
239 % (data, self.boundjid, error)
242 def retract(self, data):
245 :param data: data from which the item will be retracted
250 result = self['xep_0060'].retract(self._server, self.boundjid, data)
251 msg = ' Retracted item %s from topic %s' % (data, self.boundjid)
254 error = traceback.format_exc()
255 msg = 'Could not retract item %s from topic %s\ntraceback:\n%s' \
256 % (data, self.boundjid, error)
260 """ Purge the information in the server
264 result = self['xep_0060'].purge(self._server, self.boundjid)
265 msg = ' Purged all items from topic %s' % self.boundjid
268 error = traceback.format_exc()
269 msg = ' Could not purge items from topic %s\ntraceback:\n%s' \
270 % (self.boundjid, error)
273 def subscribe(self, node):
274 """ Subscribe to a topic
276 :param node: Name of the topic
281 result = self['xep_0060'].subscribe(self._server, node)
282 msg = ' Subscribed %s to topic %s' \
283 % (self.boundjid.user, node)
287 error = traceback.format_exc()
288 msg = ' Could not subscribe %s to topic %s\ntraceback:\n%s' \
289 % (self.boundjid.bare, node, error)
292 def unsubscribe(self, node):
293 """ Unsubscribe to a topic
295 :param node: Name of the topic
300 result = self['xep_0060'].unsubscribe(self._server, node)
301 msg = ' Unsubscribed %s from topic %s' % (self.boundjid.bare, node)
304 error = traceback.format_exc()
305 msg = ' Could not unsubscribe %s from topic %s\ntraceback:\n%s' \
306 % (self.boundjid.bare, node, error)
309 def _check_for_tag(self, root, namespaces, tag):
310 """ Check if an element markup is in the ElementTree
312 :param root: Root of the tree
313 :type root: ElementTree Element
314 :param namespaces: Namespaces of the element
315 :type namespaces: str
316 :param tag: Tag that will search in the tree
320 for element in root.iter(namespaces+tag):
326 def _check_output(self, root, namespaces):
327 """ Check the significative element in the answer and display it
329 :param root: Root of the tree
330 :type root: ElementTree Element
331 :param namespaces: Namespaces of the tree
332 :type namespaces: str
335 fields = ["TARGET", "REASON", "PATH", "APPID", "VALUE"]
338 msg = self._check_for_tag(root, namespaces, elt)
340 response = response + " " + msg.text + " :"
341 deb = self._check_for_tag(root, namespaces, "MESSAGE")
343 msg = response + " " + deb.text
348 def handle_omf_message(self, iq):
349 """ Handle published/received message
351 :param iq: Stanzas that is currently published/received
355 namespaces = "{http://jabber.org/protocol/pubsub}"
356 for i in iq['pubsub_event']['items']:
357 root = ET.fromstring(str(i))
358 self._check_output(root, namespaces)