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/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19 # Julien Tribino <julien.tribino@inria.fr>
21 from nepi.util.logger import Logger
25 from sleekxmpp.exceptions2 import IqError, IqTimeout
26 class BaseOMFClient(sleekxmpp.ClientXMPP):
29 msg = ("SleekXMPP is not installed. Without this library "
30 " you will be not able to use OMF Resources "
31 " if you want to install SleekXmpp : \n"
32 " git clone -b develop git://github.com/fritzy/SleekXMPP.git \n"
34 " sudo python setup.py install\n")
36 logger = Logger("BaseOMFClient")
39 class BaseOMFClient(object):
43 import xml.etree.ElementTree as ET
45 # inherit from BaseXmpp and XMLstream classes
46 class OMFClient(sleekxmpp.ClientXMPP, Logger):
48 .. class:: Class Args :
50 :param jid: Jabber Id (= Xmpp Slice + Date)
52 :param password: Jabber Password (= Xmpp Password)
57 This class is an XMPP Client with customized method
61 def __init__(self, jid, password):
64 :param jid: Jabber Id (= Xmpp Slice + Date)
66 :param password: Jabber Password (= Xmpp Password)
71 Logger.__init__(self, "OMFClient")
73 sleekxmpp.ClientXMPP.__init__(self, jid, password)
75 self._registered = False
78 self.register_plugin('xep_0077') # In-band registration
79 self.register_plugin('xep_0030')
80 self.register_plugin('xep_0059')
81 self.register_plugin('xep_0060') # PubSub
83 self.add_event_handler("session_start", self.start)
84 self.add_event_handler("register", self.register)
85 self.add_event_handler("pubsub_publish", self.handle_omf_message)
89 """ Check if the client is ready
94 def start(self, event):
95 """ Send presence to the Xmppp Server. This function is called directly by the sleekXmpp library
100 self._server = "pubsub.%s" % self.boundjid.domain
102 def register(self, iq):
103 """ Register to the Xmppp Server. This function is called directly by the sleekXmpp library
107 msg = " %s already registered!" % self.boundjid
113 resp['register']['username'] = self.boundjid.user
114 resp['register']['password'] = self.password
118 msg = " Account created for %s!" % self.boundjid
120 self._registered = True
122 msg = " Could not register account: %s" % e.iq['error']['text']
125 msg = " No response from server."
128 def unregister(self):
129 """ Unregister from the Xmppp Server.
133 self.plugin['xep_0077'].cancel_registration(
134 ifrom=self.boundjid.full)
135 msg = " Account unregistered for %s!" % self.boundjid
138 msg = " Could not unregister account: %s" % e.iq['error']['text']
141 msg = " No response from server."
145 """ Get all the nodes of the Xmppp Server.
149 result = self['xep_0060'].get_nodes(self._server)
150 for item in result['disco_items']['items']:
151 msg = ' - %s' % str(item)
155 error = traceback.format_exc()
156 msg = 'Could not retrieve node list.\ntraceback:\n%s' % error
159 def subscriptions(self):
160 """ Get all the subscriptions of the Xmppp Server.
164 result = self['xep_0060'].get_subscriptions(self._server)
166 for node in result['node']:
167 msg = ' - %s' % str(node)
171 error = traceback.format_exc()
172 msg = ' Could not retrieve subscriptions.\ntraceback:\n%s' % error
175 def create(self, node):
176 """ Create the topic corresponding to the node
178 :param node: Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)
182 msg = " Create Topic : " + node
185 config = self['xep_0004'].makeForm('submit')
186 config.add_field(var='pubsub#node_type', value='leaf')
187 config.add_field(var='pubsub#notify_retract', value='0')
188 config.add_field(var='pubsub#publish_model', value='open')
189 config.add_field(var='pubsub#persist_items', value='1')
190 config.add_field(var='pubsub#max_items', value='1')
191 config.add_field(var='pubsub#title', value=node)
194 self['xep_0060'].create_node(self._server, node, config = config)
196 error = traceback.format_exc()
197 msg = ' Could not create topic: %s\ntraceback:\n%s' % (node, error)
200 def delete(self, node):
201 """ Delete the topic corresponding to the node
203 :param node: Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)
207 # To check if the queue are well empty at the end
208 #print " length of the queue : " + str(self.send_queue.qsize())
209 #print " length of the queue : " + str(self.event_queue.qsize())
211 self['xep_0060'].delete_node(self._server, node)
212 msg = ' Deleted node: %s' % node
215 error = traceback.format_exc()
216 msg = ' Could not delete topic: %s\ntraceback:\n%s' % (node, error)
219 def publish(self, data, node):
220 """ Publish the data to the corresponding topic
222 :param data: Data that will be published
224 :param node: Name of the topic
229 msg = " Publish to Topic : " + node
232 result = self['xep_0060'].publish(self._server,node,payload=data)
233 # id = result['pubsub']['publish']['item']['id']
234 # print('Published at item id: %s' % id)
236 error = traceback.format_exc()
237 msg = ' Could not publish to: %s\ntraceback:\n%s' % (node, error)
243 :param data: data from which the items will be get back
249 result = self['xep_0060'].get_item(self._server, self.boundjid,
251 for item in result['pubsub']['items']['substanzas']:
252 msg = 'Retrieved item %s: %s' % (item['id'], tostring(item['payload']))
255 error = traceback.format_exc()
256 msg = ' Could not retrieve item %s from topic %s\ntraceback:\n%s' \
257 % (data, self.boundjid, error)
260 def retract(self, data):
263 :param data: data from which the item will be retracted
268 result = self['xep_0060'].retract(self._server, self.boundjid, data)
269 msg = ' Retracted item %s from topic %s' % (data, self.boundjid)
272 error = traceback.format_exc()
273 msg = 'Could not retract item %s from topic %s\ntraceback:\n%s' \
274 % (data, self.boundjid, error)
278 """ Purge the information in the server
282 result = self['xep_0060'].purge(self._server, self.boundjid)
283 msg = ' Purged all items from topic %s' % self.boundjid
286 error = traceback.format_exc()
287 msg = ' Could not purge items from topic %s\ntraceback:\n%s' \
288 % (self.boundjid, error)
291 def subscribe(self, node):
292 """ Subscribe to a topic
294 :param node: Name of the topic
299 result = self['xep_0060'].subscribe(self._server, node)
300 msg = ' Subscribed %s to topic %s' \
301 % (self.boundjid.user, node)
305 error = traceback.format_exc()
306 msg = ' Could not subscribe %s to topic %s\ntraceback:\n%s' \
307 % (self.boundjid.bare, node, error)
310 def unsubscribe(self, node):
311 """ Unsubscribe to a topic
313 :param node: Name of the topic
318 result = self['xep_0060'].unsubscribe(self._server, node)
319 msg = ' Unsubscribed %s from topic %s' % (self.boundjid.bare, node)
322 error = traceback.format_exc()
323 msg = ' Could not unsubscribe %s from topic %s\ntraceback:\n%s' \
324 % (self.boundjid.bare, node, error)
327 def _check_for_tag(self, root, namespaces, tag):
328 """ Check if an element markup is in the ElementTree
330 :param root: Root of the tree
331 :type root: ElementTree Element
332 :param namespaces: Namespaces of the element
333 :type namespaces: str
334 :param tag: Tag that will search in the tree
338 for element in root.iter(namespaces+tag):
344 def _check_output(self, root, namespaces):
345 """ Check the significative element in the answer and display it
347 :param root: Root of the tree
348 :type root: ElementTree Element
349 :param namespaces: Namespaces of the tree
350 :type namespaces: str
353 fields = ["TARGET", "REASON", "PATH", "APPID", "VALUE"]
356 msg = self._check_for_tag(root, namespaces, elt)
358 response = response + " " + msg.text + " :"
359 deb = self._check_for_tag(root, namespaces, "MESSAGE")
361 msg = response + " " + deb.text
366 def handle_omf_message(self, iq):
367 """ Handle published/received message
369 :param iq: Stanzas that is currently published/received
373 namespaces = "{http://jabber.org/protocol/pubsub}"
374 for i in iq['pubsub_event']['items']:
375 root = ET.fromstring(str(i))
376 self._check_output(root, namespaces)