--- /dev/null
+#
+# NEPI, a framework to manage network experiments
+# Copyright (C) 2013 INRIA
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation;
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
+# Julien Tribino <julien.tribino@inria.fr>
+
+from nepi.util.logger import Logger
+from nepi.resources.omf.omf6_parser import OMF6Parser
+try:
+ import sleekxmpp
+ from sleekxmpp.exceptions import IqError, IqTimeout
+ class BaseOMFClient(sleekxmpp.ClientXMPP):
+ pass
+except ImportError:
+ msg = ("SleekXMPP is not installed. Without this library "
+ "you will be not able to use OMF Resources "
+ "if you want to install SleekXmpp: \n"
+ " git clone -b develop git://github.com/fritzy/SleekXMPP.git \n"
+ " cd SleekXMPP \n"
+ " sudo python setup.py install\n")
+
+ logger = Logger("BaseOMFClient")
+ logger.debug(msg)
+
+ class BaseOMFClient(object):
+ pass
+
+import traceback
+import xml.etree.ElementTree as ET
+
+# inherit from BaseXmpp and XMLstream classes
+class OMFClient(BaseOMFClient, Logger):
+ """
+ .. class:: Class Args :
+
+ :param jid: Jabber Id (= Xmpp Slice + Date)
+ :type jid: str
+ :param password: Jabber Password (= Xmpp Password)
+ :type password: str
+
+ .. note::
+
+ This class is an XMPP Client with customized method
+
+ """
+
+ def __init__(self, jid, password):
+ """
+
+ :param jid: Jabber Id (= Xmpp Slice + Date)
+ :type jid: str
+ :param password: Jabber Password (= Xmpp Password)
+ :type password: str
+
+
+ """
+ Logger.__init__(self, "OMFClient")
+
+ sleekxmpp.ClientXMPP.__init__(self, jid, password)
+ self._ready = False
+ self._registered = False
+ self._server = None
+ self._parser = None
+
+ self.register_plugin('xep_0077') # In-band registration
+ self.register_plugin('xep_0030')
+ self.register_plugin('xep_0059')
+ self.register_plugin('xep_0060') # PubSub
+
+ self.add_event_handler("session_start", self.start)
+ self.add_event_handler("register", self.register)
+ self.add_event_handler("pubsub_publish", self.handle_omf_message)
+
+ #Init the parser
+ self._init_parser()
+
+ def _init_parser(self):
+ """ Init the parser depending on the OMF Version
+
+ """
+ self._parser = OMF6Parser()
+
+ @property
+ def ready(self):
+ """ Check if the client is ready
+
+ """
+ return self._ready
+
+ def start(self, event):
+ """ Send presence to the Xmppp Server. This function is called directly by the sleekXmpp library
+
+ """
+ self.send_presence()
+ self._ready = True
+ self._server = "pubsub.%s" % self.boundjid.domain
+
+ def register(self, iq):
+ """ Register to the Xmppp Server. This function is called directly by the sleekXmpp library
+
+ """
+ if self._registered:
+ msg = " %s already registered!" % self.boundjid
+ self.info(msg)
+ return
+
+ resp = self.Iq()
+ resp['type'] = 'set'
+ resp['register']['username'] = self.boundjid.user
+ resp['register']['password'] = self.password
+
+ try:
+ resp.send(now=True)
+ msg = " Account created for %s!" % self.boundjid
+ self.info(msg)
+ self._registered = True
+ except IqError as e:
+ msg = " Could not register account: %s" % e.iq['error']['text']
+ self.error(msg)
+ except IqTimeout:
+ msg = " No response from server."
+ self.error(msg)
+
+ def unregister(self):
+ """ Unregister from the Xmppp Server.
+
+ """
+ try:
+ self.plugin['xep_0077'].cancel_registration(
+ ifrom=self.boundjid.full)
+ msg = " Account unregistered for %s!" % self.boundjid
+ self.info(msg)
+ except IqError as e:
+ msg = " Could not unregister account: %s" % e.iq['error']['text']
+ self.error(msg)
+ except IqTimeout:
+ msg = " No response from server."
+ self.error(msg)
+
+ def nodes(self):
+ """ Get all the nodes of the Xmppp Server.
+
+ """
+ try:
+ result = self['xep_0060'].get_nodes(self._server)
+ for item in result['disco_items']['items']:
+ msg = ' - %s' % str(item)
+ self.debug(msg)
+ return result
+ except:
+ error = traceback.format_exc()
+ msg = 'Could not retrieve node list.\ntraceback:\n%s' % error
+ self.error(msg)
+
+ def subscriptions(self):
+ """ Get all the subscriptions of the Xmppp Server.
+
+ """
+ try:
+ result = self['xep_0060'].get_subscriptions(self._server)
+ #self.boundjid.full)
+ for node in result['node']:
+ msg = ' - %s' % str(node)
+ self.debug(msg)
+ return result
+ except:
+ error = traceback.format_exc()
+ msg = ' Could not retrieve subscriptions.\ntraceback:\n%s' % error
+ self.error(msg)
+
+ def create(self, node):
+ """ Create the topic corresponding to the node
+
+ :param node: Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)
+ :type node: str
+
+ """
+ msg = " Create Topic : " + node
+ self.info(msg)
+
+ config = self['xep_0004'].makeForm('submit')
+ config.add_field(var='pubsub#node_type', value='leaf')
+ config.add_field(var='pubsub#notify_retract', value='0')
+ config.add_field(var='pubsub#publish_model', value='open')
+ config.add_field(var='pubsub#persist_items', value='1')
+ config.add_field(var='pubsub#max_items', value='1')
+ config.add_field(var='pubsub#title', value=node)
+
+ try:
+ self['xep_0060'].create_node(self._server, node, config = config)
+ except:
+ #error = traceback.format_exc()
+ #msg = ' Could not create topic: %s\ntraceback:\n%s' % (node, error)
+ msg = 'Could not create the topic : '+node+' . Maybe the topic already exists'
+ self.error(msg)
+
+ def delete(self, node):
+ """ Delete the topic corresponding to the node
+
+ :param node: Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)
+ :type node: str
+
+ """
+ # To check if the queue are well empty at the end
+ #print " length of the queue : " + str(self.send_queue.qsize())
+ #print " length of the queue : " + str(self.event_queue.qsize())
+ try:
+ self['xep_0060'].delete_node(self._server, node)
+ msg = ' Deleted node: %s' % node
+ self.info(msg)
+ except:
+ #error = traceback.format_exc()
+ #msg = ' Could not delete topic: %s\ntraceback:\n%s' % (node, error)
+ msg = 'Could not delete the topic : '+node+' . Maybe It is not the owner of the topic'
+ self.error(msg)
+
+ def publish(self, data, node):
+ """ Publish the data to the corresponding topic
+
+ :param data: Data that will be published
+ :type data: str
+ :param node: Name of the topic
+ :type node: str
+
+ """
+
+ msg = " Publish to Topic : " + node
+ self.info(msg)
+ try:
+ result = self['xep_0060'].publish(self._server,node,payload=data)
+ # id = result['pubsub']['publish']['item']['id']
+ # print('Published at item id: %s' % id)
+ except:
+ error = traceback.format_exc()
+ msg = ' Could not publish to: %s\ntraceback:\n%s' % (node, error)
+ self.error(msg)
+
+ def get(self, data):
+ """ Get the item
+
+ :param data: data from which the items will be get back
+ :type data: str
+
+
+ """
+ try:
+ result = self['xep_0060'].get_item(self._server, self.boundjid,
+ data)
+ for item in result['pubsub']['items']['substanzas']:
+ msg = 'Retrieved item %s: %s' % (item['id'], tostring(item['payload']))
+ self.debug(msg)
+ except:
+ error = traceback.format_exc()
+ msg = ' Could not retrieve item %s from topic %s\ntraceback:\n%s' \
+ % (data, self.boundjid, error)
+ self.error(msg)
+
+ def retract(self, data):
+ """ Retract the item
+
+ :param data: data from which the item will be retracted
+ :type data: str
+
+ """
+ try:
+ result = self['xep_0060'].retract(self._server, self.boundjid, data)
+ msg = ' Retracted item %s from topic %s' % (data, self.boundjid)
+ self.debug(msg)
+ except:
+ error = traceback.format_exc()
+ msg = 'Could not retract item %s from topic %s\ntraceback:\n%s' \
+ % (data, self.boundjid, error)
+ self.error(msg)
+
+ def purge(self):
+ """ Purge the information in the server
+
+ """
+ try:
+ result = self['xep_0060'].purge(self._server, self.boundjid)
+ msg = ' Purged all items from topic %s' % self.boundjid
+ self.debug(msg)
+ except:
+ error = traceback.format_exc()
+ msg = ' Could not purge items from topic %s\ntraceback:\n%s' \
+ % (self.boundjid, error)
+ self.error(msg)
+
+ def subscribe(self, node):
+ """ Subscribe to a topic
+
+ :param node: Name of the topic
+ :type node: str
+
+ """
+ try:
+ result = self['xep_0060'].subscribe(self._server, node)
+ msg = ' Subscribed %s to topic %s' \
+ % (self.boundjid.user, node)
+ #self.info(msg)
+ self.debug(msg)
+ except:
+ error = traceback.format_exc()
+ msg = ' Could not subscribe %s to topic %s\ntraceback:\n%s' \
+ % (self.boundjid.bare, node, error)
+ self.error(msg)
+
+ def unsubscribe(self, node):
+ """ Unsubscribe to a topic
+
+ :param node: Name of the topic
+ :type node: str
+
+ """
+ try:
+ result = self['xep_0060'].unsubscribe(self._server, node)
+ msg = ' Unsubscribed %s from topic %s' % (self.boundjid.bare, node)
+ self.debug(msg)
+ except:
+ error = traceback.format_exc()
+ msg = ' Could not unsubscribe %s from topic %s\ntraceback:\n%s' \
+ % (self.boundjid.bare, node, error)
+ self.error(msg)
+
+ def check_mailbox(self, itype, attr):
+ """ Check the mail box
+
+ :param itype: type of mail
+ :type itype: str
+ :param attr: value wanted
+ :type attr: str
+
+ """
+ return self._parser.check_mailbox(itype, attr)
+
+
+ def handle_omf_message(self, iq):
+ """ Handle published/received message
+
+ :param iq: Stanzas that is currently published/received
+ :type iq: Iq Stanza
+
+ """
+ self._parser.handle(iq)
+
git://git.onelab.eu / nepi.git / blobdiff