sfa/plc/network.py

   1 from __future__ import with_statement
   2 import re
   3 import socket
   4 from sfa.util.namespace import *
   5 from sfa.util.faults import *
   6 from xmlbuilder import XMLBuilder
   7 from lxml import etree
   8 import sys
   9 from StringIO import StringIO
  10
  11
  12 class Sliver:
  13     def __init__(self, node):
  14         self.node = node
  15         self.network = node.network
  16         self.slice = node.network.slice
  17
  18     def toxml(self, xml):
  19         with xml.sliver:
  20             self.slice.tags_to_xml(xml, self.node)
  21
  22
  23 class Iface:
  24     def __init__(self, network, iface):
  25         self.network = network
  26         self.id = iface['interface_id']
  27         self.idtag = "i%s" % self.id
  28         self.ipv4 = iface['ip']
  29         self.bwlimit = iface['bwlimit']
  30         self.hostname = iface['hostname']
  31         self.primary = iface['is_primary']
  32
  33     """
  34     Just print out bwlimit right now
  35     """
  36     def toxml(self, xml):
  37         if self.bwlimit:
  38             with xml.bw_limit(units="kbps"):
  39                 xml << str(self.bwlimit / 1000)
  40
  41
  42 class Node:
  43     def __init__(self, network, node):
  44         self.network = network
  45         self.id = node['node_id']
  46         self.idtag = "n%s" % self.id
  47         self.hostname = node['hostname']
  48         self.site_id = node['site_id']
  49         self.iface_ids = node['interface_ids']
  50         self.sliver = None
  51         self.whitelist = node['slice_ids_whitelist']
  52
  53     def get_primary_iface(self):
  54         for id in self.iface_ids:
  55             iface = self.network.lookupIface(id)
  56             if iface.primary:
  57                 return iface
  58         return None
  59
  60     def get_site(self):
  61         return self.network.lookupSite(self.site_id)
  62
  63     def add_sliver(self):
  64         self.sliver = Sliver(self)
  65
  66     def toxml(self, xml):
  67         slice = self.network.slice
  68         if self.whitelist and not self.sliver:
  69             if not slice or slice.id not in self.whitelist:
  70                 return
  71
  72         with xml.node(id = self.idtag):
  73             with xml.hostname:
  74                 xml << self.hostname
  75             iface = self.get_primary_iface()
  76             if iface:
  77                 iface.toxml(xml)
  78             if self.sliver:
  79                 self.sliver.toxml(xml)
  80
  81
  82 class Site:
  83     def __init__(self, network, site):
  84         self.network = network
  85         self.id = site['site_id']
  86         self.idtag = "s%s" % self.id
  87         self.node_ids = site['node_ids']
  88         self.node_ids.sort()
  89         self.name = site['abbreviated_name']
  90         self.tag = site['login_base']
  91         self.public = site['is_public']
  92         self.enabled = site['enabled']
  93         self.links = set()
  94         self.whitelist = False
  95
  96     def get_sitenodes(self):
  97         n = []
  98         for i in self.node_ids:
  99             n.append(self.network.lookupNode(i))
 100         return n
 101
 102     def toxml(self, xml):
 103         if not (self.public and self.enabled and self.node_ids):
 104             return
 105         with xml.site(id = self.idtag):
 106             with xml.name:
 107                 xml << self.name
 108             for node in self.get_sitenodes():
 109                 node.toxml(xml)
 110
 111
 112 class Slice:
 113     def __init__(self, network, hrn, slice):
 114         self.hrn = hrn
 115         self.network = network
 116         self.id = slice['slice_id']
 117         self.name = slice['name']
 118         self.peer_id = slice['peer_id']
 119         self.node_ids = set(slice['node_ids'])
 120         self.slice_tag_ids = slice['slice_tag_ids']
 121
 122     """
 123     Use with tags that can have more than one instance
 124     """
 125     def get_multi_tag(self, tagname, node = None):
 126         tags = []
 127         for i in self.slice_tag_ids:
 128             tag = self.network.lookupSliceTag(i)
 129             if tag.tagname == tagname:
 130                 if not (node and node.id != tag.node_id):
 131                     tags.append(tag)
 132         return tags
 133
 134     """
 135     Use with tags that have only one instance
 136     """
 137     def get_tag(self, tagname, node = None):
 138         for i in self.slice_tag_ids:
 139             tag = self.network.lookupSliceTag(i)
 140             if tag.tagname == tagname:
 141                 if (not node) or (node.id == tag.node_id):
 142                     return tag
 143         return None
 144
 145     def get_nodes(self):
 146         n = []
 147         for id in self.node_ids:
 148             if id in self.network.nodes:
 149                 n.append(self.network.nodes[id])
 150         return n
 151
 152     # Add a new slice tag
 153     def add_tag(self, tagname, value, node = None):
 154         tt = self.network.lookupTagType(tagname)
 155         tag = Slicetag()
 156         tag.initialize(tagname, value, node, self.network)
 157         self.network.tags[tag.id] = tag
 158         self.slice_tag_ids.append(tag.id)
 159         return tag
 160
 161     # Update a slice tag if it exists, else add it
 162     def update_tag(self, tagname, value, node = None):
 163         tag = self.get_tag(tagname, node)
 164         if tag:
 165             tag.change(value)
 166         else:
 167             tag = self.add_tag(tagname, value, node)
 168         return tag
 169
 170     def update_multi_tag(self, tagname, value, node = None):
 171         tags = self.get_multi_tag(tagname, node)
 172         for tag in tags:
 173             if tag and tag.value == value:
 174                 break
 175         else:
 176             tag = self.add_tag(tagname, value, node)
 177         return tag
 178
 179     def tags_to_xml(self, xml, node = None):
 180         tagtypes = self.network.getTagTypes()
 181         for tt in tagtypes:
 182             if tt.in_rspec:
 183                 if tt.multi:
 184                     tags = self.get_multi_tag(tt.tagname, node)
 185                     for tag in tags:
 186                         if not tag.was_deleted():  ### Debugging
 187                             xml << (tag.tagname, tag.value)
 188                 else:
 189                     tag = self.get_tag(tt.tagname, node)
 190                     if tag:
 191                         if not tag.was_deleted():   ### Debugging
 192                             xml << (tag.tagname, tag.value)
 193
 194     def toxml(self, xml):
 195         with xml.sliver_defaults:
 196             self.tags_to_xml(xml)
 197
 198
 199 class Slicetag:
 200     newid = -1
 201     filter_fields = ['slice_tag_id','slice_id','tagname','value','node_id','category','min_role_id']
 202     ignore_tags = ['hmac','ssh_key']
 203
 204     def __init__(self, tag = None):
 205         if not tag:
 206             return
 207         self.id = tag['slice_tag_id']
 208         self.slice_id = tag['slice_id']
 209         self.tagname = tag['tagname']
 210         self.value = tag['value']
 211         self.node_id = tag['node_id']
 212         self.category = tag['category']
 213         self.status = None
 214
 215     # Create a new slicetag that will be written to the DB later
 216     def initialize(self, tagname, value, node, network):
 217         tt = network.lookupTagType(tagname)
 218         self.id = Slicetag.newid
 219         Slicetag.newid -=1
 220         self.slice_id = network.slice.id
 221         self.tagname = tagname
 222         self.value = value
 223         if node:
 224             self.node_id = node.id
 225         else:
 226             self.node_id = None
 227         self.category = tt.category
 228         self.status = "new"
 229
 230     def change(self, value):
 231         if self.value != value:
 232             self.value = value
 233             self.status = "change"
 234         else:
 235             self.status = "updated"
 236
 237     # Mark a tag as deleted
 238     def delete(self):
 239         self.status = "delete"
 240
 241     def was_added(self):
 242         return (self.id < 0)
 243
 244     def was_changed(self):
 245         return (self.status == "change")
 246
 247     def was_deleted(self):
 248         return (self.status == "delete")
 249
 250     def was_updated(self):
 251         return (self.status != None)
 252
 253     def write(self, api, user_plauth):
 254         try:
 255             if self.was_added():
 256                 api.plshell.AddSliceTag(user_plauth, self.slice_id,
 257                                         self.tagname, self.value, self.node_id)
 258             elif self.was_changed():
 259                 api.plshell.UpdateSliceTag(user_plauth, self.id, self.value)
 260             elif self.was_deleted():
 261                 api.plshell.DeleteSliceTag(user_plauth, self.id)
 262         except:
 263             raise InvalidRSpec("user cannot modify '%s' tag" % self.tagname)
 264
 265
 266
 267 class TagType:
 268     def __init__(self, tagtype):
 269         self.id = tagtype['tag_type_id']
 270         self.category = tagtype['category']
 271         self.tagname = tagtype['tagname']
 272         self.multi = False
 273         self.in_rspec = False
 274         if self.category == 'slice/rspec':
 275             self.in_rspec = True
 276         if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
 277             self.multi = True
 278
 279
 280 class Network:
 281     """
 282     A Network is a compound object consisting of:
 283     * a dictionary mapping site IDs to Site objects
 284     * a dictionary mapping node IDs to Node objects
 285     * a dictionary mapping interface IDs to Iface objects
 286     """
 287     def __init__(self, api, user_plauth, type = "SFA"):
 288         self.api = api
 289         self.user_plauth = user_plauth
 290         self.type = type
 291         self.sites = self.get_sites(api)
 292         self.nodes = self.get_nodes(api)
 293         self.ifaces = self.get_ifaces(api)
 294         self.tags = self.get_slice_tags(api)
 295         self.tagtypes = self.get_tag_types(api)
 296         self.slice = None
 297
 298     def lookupSite(self, id):
 299         """ Lookup site based on id or idtag value """
 300         val = None
 301         if isinstance(id, basestring):
 302             id = int(id.lstrip('s'))
 303         try:
 304             val = self.sites[id]
 305         except:
 306             raise InvalidRSpec("site ID %s not found" % id)
 307         return val
 308
 309     def getSites(self):
 310         sites = []
 311         for s in self.sites:
 312             sites.append(self.sites[s])
 313         return sites
 314
 315     def lookupNode(self, id):
 316         """ Lookup node based on id or idtag value """
 317         val = None
 318         if isinstance(id, basestring):
 319             id = int(id.lstrip('n'))
 320         try:
 321             val = self.nodes[id]
 322         except:
 323             raise InvalidRSpec("node ID %s not found" % id)
 324         return val
 325
 326     def getNodes(self):
 327         nodes = []
 328         for n in self.nodes:
 329             nodes.append(self.nodes[n])
 330         return nodes
 331
 332     def lookupIface(self, id):
 333         """ Lookup iface based on id or idtag value """
 334         val = None
 335         if isinstance(id, basestring):
 336             id = int(id.lstrip('i'))
 337         try:
 338             val = self.ifaces[id]
 339         except:
 340             raise InvalidRSpec("interface ID %s not found" % id)
 341         return val
 342
 343     def getIfaces(self):
 344         ifaces = []
 345         for i in self.ifaces:
 346             ifaces.append(self.ifaces[i])
 347         return ifaces
 348
 349     def nodesWithSlivers(self):
 350         nodes = []
 351         for n in self.nodes:
 352             node = self.nodes[n]
 353             if node.sliver:
 354                 nodes.append(node)
 355         return nodes
 356
 357     def lookupSliceTag(self, id):
 358         val = None
 359         try:
 360             val = self.tags[id]
 361         except:
 362             raise InvalidRSpec("slicetag ID %s not found" % id)
 363         return val
 364
 365     def getSliceTags(self):
 366         tags = []
 367         for t in self.tags:
 368             tags.append(self.tags[t])
 369         return tags
 370
 371     def lookupTagType(self, name):
 372         val = None
 373         try:
 374             val = self.tagtypes[name]
 375         except:
 376             raise InvalidRSpec("tag %s not found" % name)
 377         return val
 378
 379     def getTagTypes(self):
 380         tags = []
 381         for t in self.tagtypes:
 382             tags.append(self.tagtypes[t])
 383         return tags
 384
 385     def __process_attributes(self, element, node=None):
 386         """
 387         Process the elements under <sliver_defaults> or <sliver>
 388         """
 389         if element is None:
 390             return
 391
 392         tagtypes = self.getTagTypes()
 393         for tt in tagtypes:
 394             if tt.in_rspec:
 395                 if tt.multi:
 396                     for e in element.iterfind("./" + tt.tagname):
 397                         self.slice.update_multi_tag(tt.tagname, e.text, node)
 398                 else:
 399                     e = element.find("./" + tt.tagname)
 400                     if e is not None:
 401                         self.slice.update_tag(tt.tagname, e.text, node)
 402
 403     def addRSpec(self, xml, schema=None):
 404         """
 405         Annotate the objects in the Network with information from the RSpec
 406         """
 407         try:
 408             tree = etree.parse(StringIO(xml))
 409         except etree.XMLSyntaxError:
 410             message = str(sys.exc_info()[1])
 411             raise InvalidRSpec(message)
 412
 413         # Filter out stuff that's not for us
 414         rspec = tree.getroot()
 415         for network in rspec.iterfind("./network"):
 416             if network.get("name") != self.api.hrn:
 417                 rspec.remove(network)
 418         for request in rspec.iterfind("./request"):
 419             if request.get("name") != self.api.hrn:
 420                 rspec.remove(request)
 421
 422         if schema:
 423             # Validate the incoming request against the RelaxNG schema
 424             relaxng_doc = etree.parse(schema)
 425             relaxng = etree.RelaxNG(relaxng_doc)
 426
 427             if not relaxng(tree):
 428                 error = relaxng.error_log.last_error
 429                 message = "%s (line %s)" % (error.message, error.line)
 430                 raise InvalidRSpec(message)
 431
 432         self.rspec = rspec
 433
 434         defaults = rspec.find(".//sliver_defaults")
 435         self.__process_attributes(defaults)
 436
 437         # Find slivers under node elements
 438         for sliver in rspec.iterfind("./network/site/node/sliver"):
 439             elem = sliver.getparent()
 440             try:
 441                 node = self.lookupNode(elem.get("id"))
 442             except:
 443                 # Don't worry about nodes from other aggregates
 444                 pass
 445             else:
 446                 node.add_sliver()
 447                 self.__process_attributes(sliver, node)
 448
 449         # Find slivers that specify nodeid
 450         for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
 451             try:
 452                 node = self.lookupNode(sliver.get("nodeid"))
 453             except:
 454                 # Don't worry about nodes from other aggregates
 455                 pass
 456             else:
 457                 node.add_sliver()
 458                 self.__process_attributes(sliver, node)
 459
 460         return
 461
 462     def addSlice(self):
 463         """
 464         Annotate the objects in the Network with information from the slice
 465         """
 466         slice = self.slice
 467         if not slice:
 468             raise InvalidRSpec("no slice associated with network")
 469
 470         for node in slice.get_nodes():
 471             node.add_sliver()
 472
 473     def updateSliceTags(self):
 474         """
 475         Write any slice tags that have been added or modified back to the DB
 476         """
 477         for tag in self.getSliceTags():
 478             if tag.category == 'slice/rspec' and not tag.was_updated():
 479                 # The user wants to delete this tag
 480                 tag.delete()
 481
 482         # Update slice tags in database
 483         for tag in self.getSliceTags():
 484             if tag.slice_id == self.slice.id:
 485                 tag.write(self.api, self.user_plauth)
 486
 487     def toxml(self):
 488         """
 489         Produce XML directly from the topology specification.
 490         """
 491         xml = XMLBuilder(format = True, tab_step = "  ")
 492         with xml.RSpec(type=self.type):
 493             if self.slice:
 494                 element = xml.network(name=self.api.hrn, slice=self.slice.hrn)
 495             else:
 496                 element = xml.network(name=self.api.hrn)
 497
 498             with element:
 499                 if self.slice:
 500                     self.slice.toxml(xml)
 501                 for site in self.getSites():
 502                     site.toxml(xml)
 503
 504         header = '<?xml version="1.0"?>\n'
 505         return header + str(xml)
 506
 507     def get_sites(self, api):
 508         """
 509         Create a dictionary of site objects keyed by site ID
 510         """
 511         tmp = []
 512         for site in api.plshell.GetSites(self.user_plauth, {'peer_id': None}):
 513             t = site['site_id'], Site(self, site)
 514             tmp.append(t)
 515
 516         return dict(tmp)
 517
 518
 519     def get_nodes(self, api):
 520         """
 521         Create a dictionary of node objects keyed by node ID
 522         """
 523         tmp = []
 524         for node in api.plshell.GetNodes(self.user_plauth, {'peer_id': None}):
 525             t = node['node_id'], Node(self, node)
 526             tmp.append(t)
 527         return dict(tmp)
 528
 529     def get_ifaces(self, api):
 530         """
 531         Create a dictionary of node objects keyed by node ID
 532         """
 533         tmp = []
 534         for iface in api.plshell.GetInterfaces(self.user_plauth):
 535             t = iface['interface_id'], Iface(self, iface)
 536             tmp.append(t)
 537         return dict(tmp)
 538
 539     def get_slice_tags(self, api):
 540         """
 541         Create a dictionary of slicetag objects keyed by slice tag ID
 542         """
 543         tmp = []
 544         for tag in api.plshell.GetSliceTags(self.user_plauth, {'~tagname':Slicetag.ignore_tags}, Slicetag.filter_fields):
 545             t = tag['slice_tag_id'], Slicetag(tag)
 546             tmp.append(t)
 547         return dict(tmp)
 548
 549     def get_tag_types(self, api):
 550         """
 551         Create a list of tagtype obects keyed by tag name
 552         """
 553         tmp = []
 554         for tag in api.plshell.GetTagTypes(self.user_plauth):
 555             t = tag['tagname'], TagType(tag)
 556             tmp.append(t)
 557         return dict(tmp)
 558
 559     def get_slice(self, api, hrn):
 560         """
 561         Return a Slice object for a single slice
 562         """
 563         slicename = hrn_to_pl_slicename(hrn)
 564         slice = api.plshell.GetSlices(self.user_plauth, [slicename])
 565         if len(slice):
 566             self.slice = Slice(self, slicename, slice[0])
 567             return self.slice
 568         else:
 569             return None
 570
 571