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)
126 def __iq(self, t="get"):
127 iq = domish.Element((None, "iq"))
128 iq['from'] = self.id.full()
129 iq['to'] = "pubsub.vplc27.inria.fr"
134 def discover(self, node = None):
135 iq = self.__iq("get")
136 query = iq.addElement("query")
137 query['xmlns'] = "http://jabber.org/protocol/disco#items"
140 self.requests[iq['id']] = node
141 self.xmlstream.send(iq)
143 def result_discover(self, iq):
144 if self.verbose: self.info("Items for node: %s" % self.requests[iq['id']])
146 hook = self.hooks.get('discover', None)
149 self.delete_result_hook('discover')
152 for i in iq.query.elements():
155 self.requests.pop(iq['id'])
157 def create_node(self, node = None):
158 iq = self.__iq("set")
159 pubsub = iq.addElement("pubsub")
160 pubsub['xmlns'] = "http://jabber.org/protocol/pubsub"
161 create = pubsub.addElement("create")
163 create['node'] = node
164 configure = pubsub.addElement("configure")
165 self.requests[iq['id']] = node
166 self.xmlstream.send(iq)
168 def result_create_node(self, iq):
169 # if hasattr(iq, "error"):
170 # node = self.requests[iq['id']]
171 # if hasattr(iq.error, "conflict"):
172 # # node is already there, nothing important.
173 # self.warn("NodeID exists: %s" % node)
178 # if iq.error.has_key('type'):
179 # err_type = iq.error['type']
180 # if iq.error.firstChildElement and hasattr(iq.error.firstChildElement, "name"):
181 # err_name = iq.error.firstChildElement.name
182 # self.error("Can not create node: %s (error type: %s, %s)" % (node, err_type, err_name))
183 self.requests.pop(iq['id'])
186 def delete_node(self, node):
187 iq = self.__iq("set")
188 pubsub = iq.addElement("pubsub")
189 pubsub['xmlns'] = "http://jabber.org/protocol/pubsub#owner"
190 delete = pubsub.addElement("delete")
191 delete['node'] = node
192 self.requests[iq['id']] = node
193 self.xmlstream.send(iq)
195 def result_delete_node(self, iq):
196 self.requests.pop(iq['id'])
198 def message_chat(self, m):
200 for e in m.elements():
205 if command == "list groups":
208 for i in iq.query.elements():
209 reply += "%s\n" % i['node']
210 n = domish.Element((None, "message"))
212 n['from'] = self.id.full()
213 n.addElement("body", content = reply)
214 self.xmlstream.send(n)
216 self.add_result_hook("discover", list_groups)
220 BaseClient.message_chat(self, m)
223 class Slicemgr(xmlrpc.XMLRPC, PubSubClient):
226 RESOURCES = 'resources'
228 def __init__(self, id, secret, verbose = False, log = None):
229 xmlrpc.XMLRPC.__init__(self, allowNone=True)
230 PubSubClient.__init__(self, id, secret, verbose = verbose, log = log)
231 self.command_queue = Queue.Queue()
233 xmlrpc.addIntrospection(self)
235 def xmlrpc_createSlice(self, slice):
236 self.create_slice(slice)
238 def xmlrpc_addResource(self, slice, resource):
239 self.add_resource(slice, resource)
241 def xmlrpc_deleteSlice(self, slice):
242 self.delete_slice(slice)
244 def xmlrpc_removeResource(self, slice, resource):
245 self.delete_resource(slice, resource)
248 def flush_commands(self):
249 # self.info("Running %d commands" % self.command_queue.qsize())
250 while not self.command_queue.empty():
251 (meth, param) = self.command_queue.get()
254 def create_slice(self, slice):
255 self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice]) ))
256 self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES]) ))
258 def add_resource(self, slice, resource):
259 self.command_queue.put(( self.create_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
261 def delete_slice(self, slice):
262 slice_prefix = "/".join([self.DOMAIN,slice])
263 resource_prefix = "/".join([self.DOMAIN,slice,self.RESOURCES])
264 def delete_slice_resources(iq):
265 for i in iq.query.elements():
267 if node.startswith(resource_prefix):
268 self.command_que.put(self.delete_node, node)
270 self.add_result_hook("discover", delete_slice_resources)
273 self.command_queue.put(( self.delete_node, resource_prefix) )
274 self.command_queue.put(( self.delete_node, slice_prefix) )
276 def delete_resource(self, slice, resource):
277 self.command_queue.put(( self.delete_node, "/".join([self.DOMAIN,slice,self.RESOURCES,resource]) ))
281 if __name__ == "__main__":
283 config = Config("/etc/planetlab/plc_config")
285 xmppserver = config.PLC_OMF_XMPP_SERVER
286 xmppuser = "@".join([config.PLC_OMF_XMPP_USER, xmppserver])
287 xmpppass = config.PLC_OMF_XMPP_PASSWORD
288 slicemgr = Slicemgr(xmppuser, xmpppass,
289 log=open("/var/log/omf/pubsub_client.log", "a"),
292 t = task.LoopingCall(slicemgr.flush_commands)
293 t.start(5.0) # check every 5 seconds
294 reactor.connectTCP(slicemgr.id.host, 5222, slicemgr.factory)
295 reactor.listenTCP(5053, server.Site(slicemgr), interface="localhost")
296 reactor.run(installSignalHandlers=True)