src/nepi/resources/omf/omf6_parser.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License version 2 as
   7 #    published by the Free Software Foundation;
   8 #
   9 #    This program is distributed in the hope that it will be useful,
  10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #    GNU General Public License for more details.
  13 #
  14 #    You should have received a copy of the GNU General Public License
  15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  18 #         Julien Tribino <julien.tribino@inria.fr>
  19
  20 from nepi.util.logger import Logger
  21
  22 import os
  23 import traceback
  24 import xml.etree.ElementTree as ET
  25
  26 # inherit from BaseXmpp and XMLstream classes
  27 class OMF6Parser(Logger):
  28     """
  29     .. class:: Class Args :
  30
  31         :param jid: Jabber Id (= Xmpp Slice + Date)
  32         :type jid: str
  33         :param password: Jabber Password (= Xmpp Password)
  34         :type password: str
  35
  36     .. note::
  37
  38        This class is an XMPP Client with customized method
  39
  40     """
  41
  42     def __init__(self):
  43         """
  44
  45         :param jid: Jabber Id (= Xmpp Slice + Date)
  46         :type jid: str
  47         :param password: Jabber Password (= Xmpp Password)
  48         :type password: str
  49
  50
  51         """
  52         super(OMF6Parser, self).__init__("OMF6API")
  53         self.mailbox={}
  54         self.traces={}
  55         self.trace='NULL'
  56
  57         self.init_mailbox()
  58
  59
  60     def init_mailbox(self):
  61         self.mailbox['create'] = []
  62         self.mailbox['started'] = []
  63         self.mailbox['release'] = []
  64
  65     def _check_for_tag(self, root, namespaces, tag):
  66         """  Check if an element markup is in the ElementTree
  67
  68         :param root: Root of the tree
  69         :type root: ElementTree Element
  70         :param namespaces: Namespaces of the element
  71         :type namespaces: str
  72         :param tag: Tag that will search in the tree
  73         :type tag: str
  74
  75         """
  76         for element in root.iter(namespaces+tag):
  77             if element.text:
  78                 return element.text
  79             else :
  80                 return None
  81
  82     def _check_for_props(self, root, namespaces):
  83         """  Check if an element markup is in the ElementTree
  84
  85         :param root: Root of the tree
  86         :type root: ElementTree Element
  87         :param namespaces: Namespaces of the element
  88         :type namespaces: str
  89
  90         """
  91         props = {}
  92         for properties in root.iter(namespaces+'props'):
  93             for element in properties.iter():
  94                 if element.tag and element.text:
  95                     props[element.tag] = element.text
  96         return props
  97
  98     def _check_for_membership(self, root, namespaces):
  99         """  Check if an element markup is in the ElementTree
 100
 101         :param root: Root of the tree
 102         :type root: ElementTree Element
 103         :param namespaces: Namespaces of the element
 104         :type namespaces: str
 105
 106         """
 107         for element in root.iter(namespaces+'membership'):
 108             for elt in element.iter(namespaces+'it'):
 109                 ##XXX : change
 110                 return elt.text
 111
 112
 113     def _check_output(self, root, namespaces):
 114         """ Check the significative element in the answer and display it
 115
 116         :param root: Root of the tree
 117         :type root: ElementTree Element
 118         :param namespaces: Namespaces of the tree
 119         :type namespaces: str
 120
 121         """
 122         fields = ["TARGET", "REASON", "PATH", "APPID", "VALUE"]
 123         response = ""
 124         for elt in fields:
 125             msg = self._check_for_tag(root, namespaces, elt)
 126             if msg is not None:
 127                 response = response + " " + msg.text + " :"
 128         deb = self._check_for_tag(root, namespaces, "MESSAGE")
 129         if deb is not None:
 130             msg = response + " " + deb.text
 131             self.debug(msg)
 132         else :
 133             self.info(response)
 134
 135
 136     def _inform_creation_ok(self, root, namespaces):
 137         """ Parse and Display CREATION OK message
 138
 139         """
 140         #ET.dump(root)
 141         uid = self._check_for_tag(root, namespaces, "uid")
 142         cid = self._check_for_tag(root, namespaces, "cid")
 143         member = self._check_for_membership(root, namespaces)
 144         binary_path = self._check_for_tag(root, namespaces, "binary_path")
 145         msg = "CREATION OK -- "
 146         if binary_path :
 147             msg = msg + "The resource : '"+binary_path
 148         else :
 149             msg = msg + "The interface"
 150         if uid :
 151             msg = msg + "' is listening to the topics : '"+ uid
 152         if member :
 153             msg = msg + "' and '"+ member +"'"
 154         if cid:
 155             self.info(msg)
 156             self.mailbox['create'].append([cid, uid ])
 157
 158     def _inform_creation_failed(self, root, namespaces):
 159         """ Parse and Display CREATION FAILED message
 160
 161         """
 162         reason = self._check_for_tag(root, namespaces, "reason")
 163         cid = self._check_for_tag(root, namespaces, "cid")
 164         msg = "CREATION FAILED - The reason : "+reason
 165         if cid:
 166             self.error(msg)
 167             self.mailbox['create'].append([cid, uid ])
 168
 169     def _inform_status(self, root, namespaces):
 170         """ Parse and Display STATUS message
 171
 172         """
 173         props = self._check_for_props(root, namespaces)
 174         uid = self._check_for_tag(root, namespaces, "uid")
 175         event = self._check_for_tag(root, namespaces, "event")
 176
 177         log = "STATUS -- "
 178         for elt in props.keys():
 179             ns, tag = elt.split('}')
 180             if tag == "it":
 181                 log = log + "membership : " + props[elt]+" -- "
 182             elif tag == "event":
 183                 self.mailbox['started'].append(uid)
 184                 log = log + "event : " + props[elt]+" -- "
 185             elif tag == "msg":
 186                 if event == "STDOUT" :
 187                     filename = os.path.join("/tmp", "%s.out" % uid)
 188                     with open(filename,'a+') as f:
 189                         # XXX: Adding fake \n for visual formatting
 190                         msg = props[elt] # + "\n"
 191                         f.write(msg)
 192                 elif event == "STDERR" :
 193                     filename = os.path.join("/tmp", "%s.err" % uid)
 194                     with open(filename,'a+') as f:
 195                         # XXX: Adding fake \n for visual formatting
 196                         msg = props[elt] # + "\n"
 197                         f.write(msg)
 198                 log = log + tag +" : " + props[elt]+" -- "
 199             else:
 200                 log = log + tag +" : " + props[elt]+" -- "
 201         log = log + " STATUS "
 202         self.info(log)
 203
 204     def _inform_released(self, root, namespaces):
 205         """ Parse and Display RELEASED message
 206
 207         """
 208         #ET.dump(root)
 209         parent_id = self._check_for_tag(root, namespaces, "src")
 210         child_id = self._check_for_tag(root, namespaces, "res_id")
 211         cid = self._check_for_tag(root, namespaces, "cid")
 212         if cid :
 213             msg = "RELEASED - The resource : '"+child_id+ \
 214               "' has been released by : '"+ parent_id
 215             self.info(msg)
 216             self.mailbox['release'].append(cid)
 217
 218     def _inform_error(self, root, namespaces):
 219         """ Parse and Display ERROR message
 220
 221         """
 222         reason = self._check_for_tag(root, namespaces, "reason")
 223         msg = "The reason : "+reason
 224         self.error(msg)
 225
 226     def _inform_warn(self, root, namespaces):
 227         """ Parse and Display WARN message
 228
 229         """
 230         reason = self._check_for_tag(root, namespaces, "reason")
 231         msg = "The reason : "+reason
 232         self.warn(msg)
 233
 234     def _parse_inform(self, root, namespaces):
 235         """ Check the significative element in the answer
 236             Then Parse it and display using specific method
 237
 238         :param root: Root of the tree
 239         :type root: ElementTree Element
 240         :param namespaces: Namespaces of the tree
 241         :type namespaces: str
 242
 243         """
 244         itype = self._check_for_tag(root, namespaces, "itype")
 245         if itype :
 246             method_name = '_inform_'+ itype.replace('.', '_').lower()
 247             method = getattr(self, method_name)
 248             if method :
 249                 method(root, namespaces)
 250             else :
 251                 msg = "There is no method to parse the response of the type " + itype
 252                 self.info(msg)
 253                 return
 254
 255
 256     def check_mailbox(self, itype, attr):
 257         """ Check the mail box
 258
 259         :param itype: type of mail
 260         :type itype: str
 261         :param attr: value wanted
 262         :type attr: str
 263
 264         """
 265         if itype == "create":
 266             for res in self.mailbox[itype]:
 267                 binary, uid = res
 268                 if binary == attr:
 269                     self.mailbox[itype].remove(res)
 270                     return uid
 271         else :
 272             for res in self.mailbox[itype]:
 273                 if attr == res:
 274                     self.mailbox[itype].remove(res)
 275                     return res
 276
 277
 278     def handle(self, iq):
 279         """ Check the mail box
 280
 281         :param iq: message received
 282         :type itype: iq
 283         """
 284         namespaces = "{http://schema.mytestbed.net/omf/6.0/protocol}"
 285         for i in iq['pubsub_event']['items']:
 286             root = ET.fromstring(str(i))
 287             #ET.dump(root)
 288             self._parse_inform(root, namespaces)
 289