2 # Baris Metin <tmetin@sophia.inria.fr>
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
12 sys.path.append("/usr/share/plc_api/")
13 from PLC.Config import Config
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):
20 if isinstance(id, (str, unicode)):
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)
29 self.verbose = verbose
30 self.log = log or sys.stdout
32 def __rawDataIN(self, buf):
33 if self.verbose: self.msg("RECV: %s" % buf)
35 def __rawDataOUT(self, buf):
36 if self.verbose: self.msg("SEND: %s" % buf)
39 self.log.write("%s\n" % msg)
43 self.msg("ERROR: %s" % msg)
46 self.msg("WARN: %s" % msg)
49 self.msg("INFO: %s" % msg)
51 def event_connected(self, xs):
53 xs.rawDataInFn = self.__rawDataIN
54 xs.rawDataOutFn = self.__rawDataOUT
57 def event_disconnected(self, xs):
60 def event_init_failed(self, xs):
61 self.error("Init Failed")
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")
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)
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)
82 def presence_unsubscribe(self, m):
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)
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)
97 def message_chat(self, m):
98 n = domish.Element((None, "message"))
100 n['from'] = self.id.full()
101 n.addElement("body", content = "don't have time to chat. working!")
102 self.xmlstream.send(n)
105 class PubSubClient(BaseClient):
106 """ PubSub (XEP 0060) implementation """
108 def __init__(self, id, secret, verbose = False, log = None):
109 BaseClient.__init__(self, id, secret, verbose = verbose, log = log)
112 def add_result_hook(self, hook_to, hook):
113 self.hooks[hook_to] = hook
115 def delete_result_hook(self, hook_to):
116 if self.hooks.has_key(hook_to):
117 del self.hooks[hook_to]
119 def event_authenticated(self, xs):
120 BaseClient.event_authenticated(self, xs)
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/x", self.result_configure_node)
127 xs.addObserver("/iq/pubsub/configure/error", self.result_configure_node)
129 def __iq(self, t="get"):
130 iq = domish.Element((None, "iq"))
131 iq['from'] = self.id.full()
132 iq['to'] = "pubsub.%s" % self.id.host
137 def __add_pubsub(self, iq):
138 pubsub = iq.addElement("pubsub")
139 pubsub['xmlns'] = "http://jabber.org/protocol/pubsub"
143 def discover(self, node = None):
144 iq = self.__iq("get")
145 query = iq.addElement("query")
146 query['xmlns'] = "http://jabber.org/protocol/disco#items"
149 self.requests[iq['id']] = node
150 self.xmlstream.send(iq)
152 def result_discover(self, iq):
153 hook = self.hooks.get('discover', None)
156 self.delete_result_hook('discover')
158 self.requests.pop(iq['id'])
161 def subscribe_to_node(self, node):
162 iq = self.__iq("set")
163 pubsub = self.__add_pubsub(iq)
164 subscribe = pubsub.addElement("subscribe")
165 subscribe['node'] = node
166 subscribe['jid'] = self.id.full()
167 self.requests[iq['id']] = node
168 self.xmlstream.send(iq)
170 def result_subscribe_to_node(self, iq):
171 self.requests.pop(iq['id'])
174 def publish_to_node(self, node, payload):
175 iq = self.__iq("set")
176 pubsub = self.__add_pubsub(iq)
177 publish = pubsub.addElement("publish")
178 publish['node'] = node
179 items = publish.addElement("item", content=payload)
180 self.requests[iq['id']] = node
181 self.xmlstream.send(iq)
183 def result_publish_to_node(self, iq):
184 self.requests.pop(iq['id'])
187 # TODO: ejabberd doesn't have the node configuration feature implmented yet!
188 def configure_node(self, node, fields=None):
189 iq = self.__iq("set")
190 pubsub = self.__add_pubsub(iq)
191 configure = pubsub.addElement("configure")
192 configure['node'] = node
196 self.requests[iq['id']] = node
197 self.xmlstream.send(iq)
199 def result_configure_node(self, iq):
200 hook = self.hooks.get('configure', None)
203 self.delete_result_hook('configure')
205 self.requests.pop(iq['id'])
208 def create_node(self, node = None):
209 iq = self.__iq("set")
210 pubsub = self.__add_pubsub(iq)
211 create = pubsub.addElement("create")
213 create['node'] = node
214 configure = pubsub.addElement("configure")
215 self.requests[iq['id']] = node
216 self.xmlstream.send(iq)
218 def result_create_node(self, iq):
219 node = self.requests[iq['id']]
221 if iq.error.conflict:
222 # node is already there, nothing important.
223 self.warn("NodeID exists: %s" % node)
227 err_type = iq.error['type']
228 self.error("Can not create node: %s (error type: %s)" % (node, err_type))
231 # try subscribing to the node for debugging purposes
232 self.subscribe_to_node(node)
234 self.requests.pop(iq['id'])
237 def delete_node(self, node):
238 iq = self.__iq("set")
239 pubsub = self.__add_pubsub(iq)
240 delete = pubsub.addElement("delete")
241 delete['node'] = node
242 self.requests[iq['id']] = node
243 self.xmlstream.send(iq)
245 def result_delete_node(self, iq):
246 self.requests.pop(iq['id'])
248 def message_chat(self, m):
250 for e in m.elements():
256 # node = m.event.items['node']
257 # n = domish.Element((None, "message"))
258 # n.addElement("body", content = "published to: %s\n%s" % (node, m.event.items.toXml()))
259 # # for each listener in promiscuous mode send the published event
260 # self.xmlstream.send(n)
263 # # not a pubsub message continue on
266 if body == "list groups":
269 for i in iq.query.elements():
270 reply += "%s\n" % i['node']
271 n = domish.Element((None, "message"))
273 n['from'] = self.id.full()
274 n.addElement("body", content = reply)
275 self.xmlstream.send(n)
277 self.add_result_hook("discover", list_groups)
280 elif body.startswith("configuration"):
281 # "configuration NODE"
284 node = body.split()[1].strip()
288 def get_configuration(iq):
290 n = domish.Element((None, "message"))
292 n['from'] = self.id.full()
293 n.addElement("body", content = reply)
294 self.xmlstream.send(n)
296 self.add_result_hook("configure", get_configuration)
297 self.configure_node(node)
300 BaseClient.message_chat(self, m)
303 class Slicemgr(xmlrpc.XMLRPC, PubSubClient):
306 RESOURCES = 'resources'
308 def __init__(self, id, secret, verbose = False, log = None):
309 xmlrpc.XMLRPC.__init__(self, allowNone=True)
310 PubSubClient.__init__(self, id, secret, verbose = verbose, log = log)
311 self.command_queue = Queue.Queue()
313 xmlrpc.addIntrospection(self)
315 def xmlrpc_createSlice(self, slice):
316 self.create_slice(slice)
318 def xmlrpc_addResource(self, slice, resource):
319 self.add_resource(slice, resource)
321 def xmlrpc_deleteSlice(self, slice):
322 self.delete_slice(slice)
324 def xmlrpc_removeResource(self, slice, resource):
325 self.delete_resource(slice, resource)
328 def flush_commands(self):
329 # self.info("Running %d commands" % self.command_queue.qsize())
330 while not self.command_queue.empty():
331 (meth, param) = self.command_queue.get()
334 def create_slice(self, slice):
335 self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice]) ))
336 self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES]) ))
338 def add_resource(self, slice, resource):
339 self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
341 def delete_slice(self, slice):
342 slice_prefix = "/".join([self.DOMAIN,slice])
343 resource_prefix = "/".join([self.DOMAIN,slice,self.RESOURCES])
344 def delete_slice_resources(iq):
345 for i in iq.query.elements():
347 if node.startswith(resource_prefix):
348 self.command_que.put(self.delete_node, node)
350 self.add_result_hook("discover", delete_slice_resources)
353 self.command_queue.put(( self.delete_node, resource_prefix) )
354 self.command_queue.put(( self.delete_node, slice_prefix) )
356 def delete_resource(self, slice, resource):
357 self.command_queue.put(( self.delete_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
361 if __name__ == "__main__":
363 config = Config("/etc/planetlab/plc_config")
365 xmppserver = config.PLC_OMF_XMPP_SERVER
366 xmppuser = "@".join([config.PLC_OMF_XMPP_USER, xmppserver])
367 xmpppass = config.PLC_OMF_XMPP_PASSWORD
368 slicemgr = Slicemgr(xmppuser, xmpppass,
369 log=open("/var/log/omf/pubsub_client.log", "a"),
372 t = task.LoopingCall(slicemgr.flush_commands)
373 t.start(5.0) # check every 5 seconds
375 reactor.callLater(1, slicemgr.create_node, "/OMF")
376 reactor.callLater(1, slicemgr.create_node, "/OMF/SYSTEM")
378 reactor.connectTCP(slicemgr.id.host, 5222, slicemgr.factory)
379 reactor.listenTCP(5053, server.Site(slicemgr), interface="localhost")
380 reactor.run(installSignalHandlers=True)