2 NEPI, a framework to manage network experiments
3 Copyright (C) 2013 INRIA
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 from nepi.resources.omf.omf_client import OMFClient
30 from nepi.resources.omf.omf_messages_5_4 import MessageHandler
34 .. class:: Class Args :
36 :param slice: Xmpp Slice
38 :param host: Xmpp Server
40 :param port: Xmpp Port
42 :param password: Xmpp password
44 :param xmpp_root: Root of the Xmpp Topic Architecture
49 This class is the implementation of an OMF 5.4 API. Since the version 5.4.1, the Topic Architecture start with OMF_5.4 instead of OMF used for OMF5.3
52 def __init__(self, slice, host, port, password, xmpp_root = None):
55 :param slice: Xmpp Slice
57 :param host: Xmpp Server
59 :param port: Xmpp Port
61 :param password: Xmpp password
63 :param xmpp_root: Root of the Xmpp Topic Architecture
67 date = datetime.datetime.now().strftime("%Y-%m-%dt%H.%M.%S")
68 tz = -time.altzone if time.daylight != 0 else -time.timezone
69 date += "%+06.2f" % (tz / 3600) # timezone difference is in seconds
70 self._user = "%s-%s" % (slice, date)
74 self._password = password
76 self._xmpp_root = xmpp_root or "OMF_5.4"
78 self._logger = logging.getLogger("nepi.omf.omfApi ")
79 self._logger.setLevel(nepi.LOGLEVEL)
86 if sys.version_info < (3, 0):
88 sys.setdefaultencoding('utf8')
90 # instantiate the xmpp client
93 # register xmpp nodes for the experiment
94 self._enroll_experiment()
95 self._enroll_newexperiment()
97 # register xmpp logger for the experiment
100 def _init_client(self):
101 """ Initialize XMPP Client
104 jid = "%s@%s" % (self._user, self._host)
105 xmpp = OMFClient(jid, self._password)
106 # PROTOCOL_SSLv3 required for compatibility with OpenFire
107 xmpp.ssl_version = ssl.PROTOCOL_SSLv3
109 if xmpp.connect((self._host, self._port)):
110 xmpp.process(block=False)
111 while not xmpp.ready:
114 self._message = MessageHandler(self._slice, self._user)
116 msg = "Unable to connect to the XMPP server."
117 self._logger.error(msg)
118 raise RuntimeError(msg)
120 def _enroll_experiment(self):
121 """ Create and Subscribe to the Session Topic
124 xmpp_node = self._exp_session_id
125 self._client.create(xmpp_node)
126 #print "Create experiment sesion id topics !!"
127 self._client.subscribe(xmpp_node)
128 #print "Subscribe to experiment sesion id topics !!"
131 def _enroll_newexperiment(self):
132 """ Publish New Experiment Message
135 address = "/%s/%s/%s/%s" % (self._host, self._xmpp_root, self._slice, self._user)
137 payload = self._message.newexp_function(self._user, address)
138 slice_sid = "/%s/%s" % (self._xmpp_root, self._slice)
139 self._client.publish(payload, slice_sid)
141 def _enroll_logger(self):
142 """ Create and Subscribe to the Logger Topic
145 xmpp_node = self._logger_session_id
146 self._client.create(xmpp_node)
147 self._client.subscribe(xmpp_node)
149 payload = self._message.log_function("2",
150 "nodeHandler::NodeHandler",
152 "OMF Experiment Controller 5.4 (git 529a626)")
153 self._client.publish(payload, xmpp_node)
155 def _host_session_id(self, hostname):
156 """ Return the Topic Name as /xmpp_root/slice/user/hostname
158 :param hostname: Full hrn of the node
162 return "/%s/%s/%s/%s" % (self._xmpp_root, self._slice, self._user, hostname)
164 def _host_resource_id(self, hostname):
165 """ Return the Topic Name as /xmpp_root/slice/resources/hostname
167 :param hostname: Full hrn of the node
171 return "/%s/%s/resources/%s" % (self._xmpp_root, self._slice, hostname)
174 def _exp_session_id(self):
175 """ Return the Topic Name as /xmpp_root/slice/user
178 return "/%s/%s/%s" % (self._xmpp_root, self._slice, self._user)
181 def _logger_session_id(self):
182 """ Return the Topic Name as /xmpp_root/slice/LOGGER
185 return "/%s/%s/%s/LOGGER" % (self._xmpp_root, self._slice, self._user)
187 def delete(self, hostname):
188 """ Delete the topic corresponding to the hostname for this session
190 :param hostname: Full hrn of the node
194 if not hostname in self._hostnames:
197 self._hostnames.remove(hostname)
199 xmpp_node = self._host_session_id(hostname)
200 self._client.delete(xmpp_node)
202 def enroll_host(self, hostname):
203 """ Create and Subscribe to the session topic and the resources corresponding to the hostname
205 :param hostname: Full hrn of the node
209 if hostname in self._hostnames:
212 self._hostnames.append(hostname)
214 xmpp_node = self._host_session_id(hostname)
215 self._client.create(xmpp_node)
216 self._client.subscribe(xmpp_node)
218 xmpp_node = self._host_resource_id(hostname)
219 self._client.subscribe(xmpp_node)
221 payload = self._message.enroll_function("1", "*", "1", hostname)
222 self._client.publish(payload, xmpp_node)
224 def configure(self, hostname, attribute, value):
225 """ Configure attribute on the node
227 :param hostname: Full hrn of the node
229 :param attribute: Attribute that need to be configured (often written as /net/wX/attribute, with X the interface number)
231 :param value: Value of the attribute
235 payload = self._message.configure_function(hostname, value, attribute)
236 xmpp_node = self._host_session_id(hostname)
237 self._client.publish(payload, xmpp_node)
239 def execute(self, hostname, app_id, arguments, path, env):
240 """ Execute command on the node
242 :param hostname: Full hrn of the node
244 :param app_id: Application Id (Any id that represents in a unique way the application)
246 :param arguments: Arguments of the application
248 :param path: Path of the application
250 :param env: Environnement values for the application
254 payload = self._message.execute_function(hostname, app_id, arguments, path, env)
255 xmpp_node = self._host_session_id(hostname)
256 self._client.publish(payload, xmpp_node)
258 def exit(self, hostname, app_id):
259 """ Kill an application started with OMF
261 :param hostname: Full hrn of the node
263 :param app_id: Application Id of the application you want to stop
267 payload = self._message.exit_function(hostname, app_id)
268 xmpp_node = self._host_session_id(hostname)
269 self._client.publish(payload, xmpp_node)
271 def release(self, hostname):
272 """ Delete the session and logger topics. Then disconnect
275 if hostname in self._hostnames:
276 self.delete(hostname)
278 def disconnect(self) :
279 """ Delete the session and logger topics. Then disconnect
282 self._client.delete(self._exp_session_id)
283 self._client.delete(self._logger_session_id)
287 # Wait the send queue to be empty before disconnect
288 self._client.disconnect(wait=True)
289 self._logger.debug(" Disconnected from XMPP Server")
292 class OMFAPIFactory(object):
296 It allows the different RM to use the same xmpp client if they use the same credentials.
297 For the moment, it is focused on Xmpp.
300 # use lock to avoid concurrent access to the Api list at the same times by 2 different threads
301 lock = threading.Lock()
305 def get_api(cls, slice, host, port, password):
308 :param slice: Xmpp Slice Name
310 :param host: Xmpp Server Adress
312 :param port: Xmpp Port (Default : 5222)
314 :param password: Xmpp Password
318 if slice and host and port and password:
319 key = cls._make_key(slice, host, port, password)
322 cls._apis[key]['cnt'] += 1
324 return cls._apis[key]['api']
326 omf_api = cls.create_api(slice, host, port, password)
332 def create_api(cls, slice, host, port, password):
333 """ Create an API if this one doesn't exist yet with this credentials
335 :param slice: Xmpp Slice Name
337 :param host: Xmpp Server Adress
339 :param port: Xmpp Port (Default : 5222)
341 :param password: Xmpp Password
345 omf_api = OMFAPI(slice, host, port, password)
346 key = cls._make_key(slice, host, port, password)
348 cls._apis[key]['api'] = omf_api
349 cls._apis[key]['cnt'] = 1
353 def release_api(cls, slice, host, port, password):
354 """ Release an API with this credentials
356 :param slice: Xmpp Slice Name
358 :param host: Xmpp Server Adress
360 :param port: Xmpp Port (Default : 5222)
362 :param password: Xmpp Password
366 if slice and host and port and password:
367 key = cls._make_key(slice, host, port, password)
369 cls._apis[key]['cnt'] -= 1
370 #print "Api Counter : " + str(cls._apis[key]['cnt'])
371 if cls._apis[key]['cnt'] == 0:
372 omf_api = cls._apis[key]['api']
377 def _make_key(cls, *args):
378 """ Hash the credentials in order to create a key
380 :param args: list of arguments used to create the hash (user, host, port, ...)
381 :type args: list of args
384 skey = "".join(map(str, args))
385 return hashlib.md5(skey).hexdigest()