omf/omf-slicemgr.py

   1 #!/usr/bin/python
   2 # Baris Metin <tmetin@sophia.inria.fr>
   3
   4 import os
   5 import sys
   6 import Queue
   7 from twisted.words.xish import domish
   8 from twisted.web import xmlrpc, server
   9 from twisted.internet import reactor, task
  10 from twisted.words.protocols.jabber import xmlstream, client, jid
  11
  12 sys.path.append("/usr/share/plc_api/")
  13 from PLC.Config import Config
  14
  15
  16 class BaseClient(object):
  17     """ Base XMPP client: handles authentication and basic presence/message requests. """
  18     def __init__(self, id, secret, verbose = False, log = None):
  19
  20         if isinstance(id, (str, unicode)):
  21             id = jid.JID(id)
  22         x = client.XMPPClientFactory(id, secret)
  23         x.addBootstrap(xmlstream.STREAM_CONNECTED_EVENT, self.event_connected)
  24         x.addBootstrap(xmlstream.STREAM_END_EVENT, self.event_disconnected)
  25         x.addBootstrap(xmlstream.INIT_FAILED_EVENT, self.event_init_failed)
  26         x.addBootstrap(xmlstream.STREAM_AUTHD_EVENT, self.event_authenticated)
  27         self.id = id
  28         self.factory = x
  29         self.verbose = verbose
  30         self.log = log or sys.stdout
  31
  32     def __rawDataIN(self, buf):
  33         if self.verbose: self.msg("RECV: %s" % buf)
  34
  35     def __rawDataOUT(self, buf):
  36         if self.verbose: self.msg("SEND: %s" % buf)
  37
  38     def msg(self, msg):
  39         self.log.write("%s\n" % msg)
  40         self.log.flush()
  41
  42     def error(self, msg):
  43         self.msg("ERROR: %s" % msg)
  44
  45     def warn(self, msg):
  46         self.msg("WARN: %s" % msg)
  47
  48     def info(self, msg):
  49         self.msg("INFO: %s" % msg)
  50
  51     def event_connected(self, xs):
  52         # log all traffic
  53         xs.rawDataInFn = self.__rawDataIN
  54         xs.rawDataOutFn = self.__rawDataOUT
  55         self.xmlstream = xs
  56
  57     def event_disconnected(self, xs):
  58         pass
  59
  60     def event_init_failed(self, xs):
  61         self.error("Init Failed")
  62
  63     def event_authenticated(self, xs):
  64         presence = domish.Element(("jabber:client", "presence"))
  65         presence.addElement("show", content="dnd")
  66         presence.addElement("status", content="man at work")
  67         xs.send(presence)
  68
  69         # add protocol handlers
  70         xs.addObserver("/presence[@type='subscribe']", self.presence_subscribe)
  71         xs.addObserver("/presence[@type='unsubscribe']", self.presence_unsubscribe)
  72         xs.addObserver("/precence", self.presence)
  73         xs.addObserver("/message[@type='chat']", self.message_chat)
  74
  75     def presence_subscribe(self, m):
  76         self.info("%s request to add us, granting." % m['from'])
  77         p = domish.Element(("jabber:client", "presence"))
  78         p['from'], p['to'] = m['to'], m['from']
  79         p['type'] = "subscribed"
  80         self.xmlstream.send(p)
  81
  82     def presence_unsubscribe(self, m):
  83         # try to re-subscribe
  84         self.info("%s removed us, trying to re-authenticate." % m['from'])
  85         p = domish.Element(("jabber:client", "presence"))
  86         p['from'], p['to'] = m['to'], m['from']
  87         p['type'] = "subscribe"
  88         self.xmlstream.send(p)
  89
  90     def presence(self, m):
  91         p = domish.Element(("jabber:client", "presence"))
  92         p['from'], p['to'] = m['to'], m['from']
  93         presence.addElement("show", content="dnd")
  94         presence.addElement("status", content="man at work")
  95         self.xmlstream.send(p)
  96
  97     def message_chat(self, m):
  98         n = domish.Element((None, "message"))
  99         n['to'] = m['from']
 100         n['from'] = self.id.full()
 101         n.addElement("body", content = "don't have time to chat. working!")
 102         self.xmlstream.send(n)
 103
 104
 105 class PubSubClient(BaseClient):
 106     """ PubSub (XEP 0060) implementation """
 107
 108     def __init__(self, id, secret, verbose = False, log = None):
 109         BaseClient.__init__(self, id, secret, verbose = verbose, log = log)
 110         self.hooks = {}
 111
 112     def add_result_hook(self, hook_to, hook):
 113         self.hooks[hook_to] = hook
 114
 115     def delete_result_hook(self, hook_to):
 116         if self.hooks.has_key(hook_to):
 117             del self.hooks[hook_to]
 118
 119     def event_authenticated(self, xs):
 120         BaseClient.event_authenticated(self, xs)
 121         self.requests = {}
 122         xs.addObserver("/iq/pubsub/create", self.result_create_node)
 123         xs.addObserver("/iq/pubsub/delete", self.result_delete_node)
 124         xs.addObserver("/iq/query[@xmlns='http://jabber.org/protocol/disco#items']", self.result_discover)
 125         xs.addObserver("/iq/pubsub/subscription[@subscription='subscribed']", self.result_subscribe_to_node)
 126         xs.addObserver("/iq/pubsub/configure", self.result_configure_node)
 127
 128     def __iq(self, t="get"):
 129         iq = domish.Element((None, "iq"))
 130         iq['from'] = self.id.full()
 131         iq['to'] = "pubsub.vplc27.inria.fr"
 132         iq['type'] = t
 133         iq.addUniqueId()
 134         return iq
 135
 136     def __add_pubsub(self, iq):
 137         pubsub = iq.addElement("pubsub")
 138         pubsub['xmlns'] = "http://jabber.org/protocol/pubsub"
 139         return pubsub
 140
 141
 142     def discover(self, node = None):
 143         iq = self.__iq("get")
 144         query = iq.addElement("query")
 145         query['xmlns'] = "http://jabber.org/protocol/disco#items"
 146         if node:
 147             query['node'] = node
 148         self.requests[iq['id']] = node
 149         self.xmlstream.send(iq)
 150
 151     def result_discover(self, iq):
 152         hook = self.hooks.get('discover', None)
 153         if hook:
 154             hook(iq)
 155             self.delete_result_hook('discover')
 156
 157         self.requests.pop(iq['id'])
 158
 159
 160     def subscribe_to_node(self, node):
 161         iq = self.__iq("set")
 162         pubsub = self.__add_pubsub(iq)
 163         subscribe = pubsub.addElement("subscribe")
 164         subscribe['node'] = node
 165         subscribe['jid'] = self.id.full()
 166         self.requests[iq['id']] = node
 167         self.xmlstream.send(iq)
 168
 169     def result_subscribe_to_node(self, iq):
 170         self.requests.pop(iq['id'])
 171
 172
 173     def publish_to_node(self, node, payload):
 174         iq = self.__iq("set")
 175         pubsub = self.__add_pubsub(iq)
 176         publish = pubsub.addElement("publish")
 177         publish['node'] = node
 178         items = publish.addElement("item", content=payload)
 179         self.requests[iq['id']] = node
 180         self.xmlstream.send(iq)
 181
 182     def result_publish_to_node(self, iq):
 183         self.requests.pop(iq['id'])
 184
 185
 186     # TODO: ejabberd doesn't have the node configuration feature implmented yet!
 187     def configure_node(self, node, fields=None):
 188         iq = self.__iq("set")
 189         pubsub = self.__add_pubsub(iq)
 190         configure = pubsub.addElement("configure")
 191         configure['node'] = node
 192
 193         # TODO: add fields
 194
 195         self.requests[iq['id']] = node
 196         self.xmlstream.send(iq)
 197
 198     def result_configure_node(self, iq):
 199         hook = self.hooks.get('configure', None)
 200         if hook:
 201             hook(iq)
 202             self.delete_result_hook('configure')
 203         self.requests.pop(iq['id'])
 204
 205
 206     def create_node(self, node = None):
 207         iq = self.__iq("set")
 208         pubsub = self.__add_pubsub(iq)
 209         create = pubsub.addElement("create")
 210         if node:
 211             create['node'] = node
 212         configure = pubsub.addElement("configure")
 213         self.requests[iq['id']] = node
 214         self.xmlstream.send(iq)
 215
 216     def result_create_node(self, iq):
 217         node = self.requests[iq['id']]
 218         if iq.error:
 219             if iq.error.conflict:
 220                 # node is already there, nothing important.
 221                 self.warn("NodeID exists: %s" % node)
 222             else:
 223                 err_type = ""
 224                 if iq.error['type']:
 225                     err_type = iq.error['type']
 226                 self.error("Can not create node: %s (error type: %s)" %  (node, err_type))
 227         else:
 228             # no errors
 229             # try subscribing to the node for debugging purposes
 230             self.subscribe_to_node(node)
 231
 232         self.requests.pop(iq['id'])
 233
 234
 235     def delete_node(self, node):
 236         iq = self.__iq("set")
 237         pubsub = self.__add_pubsub(iq)
 238         delete = pubsub.addElement("delete")
 239         delete['node'] = node
 240         self.requests[iq['id']] = node
 241         self.xmlstream.send(iq)
 242
 243     def result_delete_node(self, iq):
 244         self.requests.pop(iq['id'])
 245
 246     def message_chat(self, m):
 247         body = ""
 248         for e in m.elements():
 249             if e.name == "body":
 250                 body = "%s" % e
 251                 break
 252
 253 #         try:
 254 #             node = m.event.items['node']
 255 #             n = domish.Element((None, "message"))
 256 #             n.addElement("body", content = "published to: %s\n%s" % (node, m.event.items.toXml()))
 257 #             # for each listener in promiscuous mode send the published event
 258 #             self.xmlstream.send(n)
 259 #             return
 260 #         except:
 261 #             # not a pubsub message continue on
 262 #             pass
 263
 264         if body == "list groups":
 265             def list_groups(iq):
 266                 reply = ""
 267                 for i in iq.query.elements():
 268                     reply += "%s\n" % i['node']
 269                 n = domish.Element((None, "message"))
 270                 n['to'] = m['from']
 271                 n['from'] = self.id.full()
 272                 n.addElement("body", content = reply)
 273                 self.xmlstream.send(n)
 274
 275             self.add_result_hook("discover", list_groups)
 276             self.discover()
 277
 278         elif body.startswith("configuration"):
 279             # "configuration NODE"
 280             node = ""
 281             try:
 282                 node = body.split()[1].strip()
 283             except IndexError:
 284                 pass
 285
 286             def get_configuration(iq):
 287                 reply = iq.toXml()
 288                 n = domish.Element((None, "message"))
 289                 n['to'] = m['from']
 290                 n['from'] = self.id.full()
 291                 n.addElement("body", content = reply)
 292                 self.xmlstream.send(n)
 293
 294             self.add_result_hook("configure", get_configuration)
 295             self.configure_node(node)
 296
 297         else:
 298             BaseClient.message_chat(self, m)
 299
 300
 301 class Slicemgr(xmlrpc.XMLRPC, PubSubClient):
 302
 303     DOMAIN = "/OMF"
 304     RESOURCES = 'resources'
 305
 306     def __init__(self, id, secret, verbose = False, log = None):
 307         xmlrpc.XMLRPC.__init__(self, allowNone=True)
 308         PubSubClient.__init__(self, id, secret, verbose = verbose, log = log)
 309         self.command_queue = Queue.Queue()
 310
 311         xmlrpc.addIntrospection(self)
 312
 313     def xmlrpc_createSlice(self, slice):
 314         self.create_slice(slice)
 315
 316     def xmlrpc_addResource(self, slice, resource):
 317         self.add_resource(slice, resource)
 318
 319     def xmlrpc_deleteSlice(self, slice):
 320         self.delete_slice(slice)
 321
 322     def xmlrpc_removeResource(self, slice, resource):
 323         self.delete_resource(slice, resource)
 324
 325
 326     def flush_commands(self):
 327 #        self.info("Running %d commands" % self.command_queue.qsize())
 328         while not self.command_queue.empty():
 329             (meth, param) = self.command_queue.get()
 330             meth(param)
 331
 332     def create_slice(self, slice):
 333         self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice]) ))
 334         self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES]) ))
 335
 336     def add_resource(self, slice, resource):
 337         self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
 338
 339     def delete_slice(self, slice):
 340         slice_prefix = "/".join([self.DOMAIN,slice])
 341         resource_prefix = "/".join([self.DOMAIN,slice,self.RESOURCES])
 342         def delete_slice_resources(iq):
 343             for i in iq.query.elements():
 344                 node = i['node']
 345                 if node.startswith(resource_prefix):
 346                     self.command_que.put(self.delete_node, node)
 347
 348         self.add_result_hook("discover", delete_slice_resources)
 349         self.discover()
 350
 351         self.command_queue.put(( self.delete_node, resource_prefix) )
 352         self.command_queue.put(( self.delete_node, slice_prefix) )
 353
 354     def delete_resource(self, slice, resource):
 355         self.command_queue.put(( self.delete_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
 356
 357
 358
 359 if __name__ == "__main__":
 360
 361     config = Config("/etc/planetlab/plc_config")
 362
 363     xmppserver = config.PLC_OMF_XMPP_SERVER
 364     xmppuser = "@".join([config.PLC_OMF_XMPP_USER, xmppserver])
 365     xmpppass = config.PLC_OMF_XMPP_PASSWORD
 366     slicemgr = Slicemgr(xmppuser, xmpppass,
 367                         log=open("/var/log/omf/pubsub_client.log", "a"),
 368                         verbose=True)
 369
 370     t = task.LoopingCall(slicemgr.flush_commands)
 371     t.start(5.0) # check every 5 seconds
 372     reactor.connectTCP(slicemgr.id.host, 5222, slicemgr.factory)
 373     reactor.listenTCP(5053, server.Site(slicemgr), interface="localhost")
 374     reactor.run(installSignalHandlers=True)
 375
 376
 377