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
 127     def __iq(self, t="get"):
 128         iq = domish.Element((None, "iq"))
 129         iq['from'] = self.id.full()
 130         iq['to'] = "pubsub.vplc27.inria.fr"
 131         iq['type'] = t
 132         iq.addUniqueId()
 133         return iq
 134
 135     def __add_pubsub(self, iq):
 136         pubsub = iq.addElement("pubsub")
 137         pubsub['xmlns'] = "http://jabber.org/protocol/pubsub"
 138         return pubsub
 139
 140     def discover(self, node = None):
 141         iq = self.__iq("get")
 142         query = iq.addElement("query")
 143         query['xmlns'] = "http://jabber.org/protocol/disco#items"
 144         if node:
 145             query['node'] = node
 146         self.requests[iq['id']] = node
 147         self.xmlstream.send(iq)
 148
 149     def result_discover(self, iq):
 150         if self.verbose: self.info("Items for node: %s" % self.requests[iq['id']])
 151
 152         hook = self.hooks.get('discover', None)
 153         if hook:
 154             hook(iq)
 155             self.delete_result_hook('discover')
 156
 157         if self.verbose:
 158             for i in iq.query.elements():
 159                 self.msg(i.toXml())
 160
 161         self.requests.pop(iq['id'])
 162
 163     def subscribe_to_node(self, node):
 164         iq = self.__iq("set")
 165         pubsub = self.__add_pubsub(iq)
 166         subscribe = pubsub.addElement("subscribe")
 167         subscribe['node'] = node
 168         subscribe['jid'] = self.id.full()
 169         self.requests[iq['id']] = node
 170         self.xmlstream.send(iq)
 171
 172     def result_subscribe_to_node(self, iq):
 173         self.requests.pop(iq['id'])
 174
 175     def publish_to_node(self, node, payload):
 176         iq = self.__iq("set")
 177         pubsub = self.__add_pubsub(iq)
 178         publish = pubsub.addElement("publish")
 179         publish['node'] = node
 180         items = publish.addElement("item", content=payload)
 181         self.requests[iq['id']] = node
 182         self.xmlstream.send(iq)
 183
 184     def result_publish_to_node(self, iq):
 185         pass
 186
 187     def create_node(self, node = None):
 188         iq = self.__iq("set")
 189         pubsub = self.__add_pubsub(iq)
 190         create = pubsub.addElement("create")
 191         if node:
 192             create['node'] = node
 193         configure = pubsub.addElement("configure")
 194         self.requests[iq['id']] = node
 195         self.xmlstream.send(iq)
 196
 197     def result_create_node(self, iq):
 198         node = self.requests[iq['id']]
 199         if iq.error:
 200             if iq.error.conflict:
 201                 # node is already there, nothing important.
 202                 self.warn("NodeID exists: %s" % node)
 203             else:
 204                 err_type = ""
 205                 if iq.error['type']:
 206                     err_type = iq.error['type']
 207                 self.error("Can not create node: %s (error type: %s)" %  (node, err_type))
 208         else:
 209             # no errors
 210             # try subscribing to the node for debugging purposes
 211             self.subscribe_to_node(node)
 212
 213         self.requests.pop(iq['id'])
 214
 215
 216     def delete_node(self, node):
 217         iq = self.__iq("set")
 218         pubsub = self.__add_pubsub(iq)
 219         delete = pubsub.addElement("delete")
 220         delete['node'] = node
 221         self.requests[iq['id']] = node
 222         self.xmlstream.send(iq)
 223
 224     def result_delete_node(self, iq):
 225         self.requests.pop(iq['id'])
 226
 227     def message_chat(self, m):
 228         body = ""
 229         for e in m.elements():
 230             if e.name == "body":
 231                 body = "%s" % e
 232                 break
 233
 234 #         try:
 235 #             node = m.event.items['node']
 236 #             n = domish.Element((None, "message"))
 237 #             n.addElement("body", content = "published to: %s\n%s" % (node, m.event.items.toXml()))
 238 #             # for each listener in promiscuous mode send the published event
 239 #             self.xmlstream.send(n)
 240 #             return
 241 #         except:
 242 #             # not a pubsub message continue on
 243 #             pass
 244
 245         if body == "list groups":
 246             def list_groups(iq):
 247                 reply = ""
 248                 for i in iq.query.elements():
 249                     reply += "%s\n" % i['node']
 250                 n = domish.Element((None, "message"))
 251                 n['to'] = m['from']
 252                 n['from'] = self.id.full()
 253                 n.addElement("body", content = reply)
 254                 self.xmlstream.send(n)
 255
 256             self.add_result_hook("discover", list_groups)
 257             self.discover()
 258
 259         else:
 260             BaseClient.message_chat(self, m)
 261
 262
 263 class Slicemgr(xmlrpc.XMLRPC, PubSubClient):
 264
 265     DOMAIN = "/OMF"
 266     RESOURCES = 'resources'
 267
 268     def __init__(self, id, secret, verbose = False, log = None):
 269         xmlrpc.XMLRPC.__init__(self, allowNone=True)
 270         PubSubClient.__init__(self, id, secret, verbose = verbose, log = log)
 271         self.command_queue = Queue.Queue()
 272
 273         xmlrpc.addIntrospection(self)
 274
 275     def xmlrpc_createSlice(self, slice):
 276         self.create_slice(slice)
 277
 278     def xmlrpc_addResource(self, slice, resource):
 279         self.add_resource(slice, resource)
 280
 281     def xmlrpc_deleteSlice(self, slice):
 282         self.delete_slice(slice)
 283
 284     def xmlrpc_removeResource(self, slice, resource):
 285         self.delete_resource(slice, resource)
 286
 287
 288     def flush_commands(self):
 289 #        self.info("Running %d commands" % self.command_queue.qsize())
 290         while not self.command_queue.empty():
 291             (meth, param) = self.command_queue.get()
 292             meth(param)
 293
 294     def create_slice(self, slice):
 295         self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice]) ))
 296         self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES]) ))
 297
 298     def add_resource(self, slice, resource):
 299         self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
 300
 301     def delete_slice(self, slice):
 302         slice_prefix = "/".join([self.DOMAIN,slice])
 303         resource_prefix = "/".join([self.DOMAIN,slice,self.RESOURCES])
 304         def delete_slice_resources(iq):
 305             for i in iq.query.elements():
 306                 node = i['node']
 307                 if node.startswith(resource_prefix):
 308                     self.command_que.put(self.delete_node, node)
 309
 310         self.add_result_hook("discover", delete_slice_resources)
 311         self.discover()
 312
 313         self.command_queue.put(( self.delete_node, resource_prefix) )
 314         self.command_queue.put(( self.delete_node, slice_prefix) )
 315
 316     def delete_resource(self, slice, resource):
 317         self.command_queue.put(( self.delete_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
 318
 319
 320
 321 if __name__ == "__main__":
 322
 323     config = Config("/etc/planetlab/plc_config")
 324
 325     xmppserver = config.PLC_OMF_XMPP_SERVER
 326     xmppuser = "@".join([config.PLC_OMF_XMPP_USER, xmppserver])
 327     xmpppass = config.PLC_OMF_XMPP_PASSWORD
 328     slicemgr = Slicemgr(xmppuser, xmpppass,
 329                         log=open("/var/log/omf/pubsub_client.log", "a"),
 330                         verbose=True)
 331
 332     t = task.LoopingCall(slicemgr.flush_commands)
 333     t.start(5.0) # check every 5 seconds
 334     reactor.connectTCP(slicemgr.id.host, 5222, slicemgr.factory)
 335     reactor.listenTCP(5053, server.Site(slicemgr), interface="localhost")
 336     reactor.run(installSignalHandlers=True)
 337
 338
 339