PLC/Methods/GetSliceTags.py

   1 # $Id$
   2 from PLC.Faults import *
   3 from PLC.Method import Method
   4 from PLC.Parameter import Parameter, Mixed
   5 from PLC.Filter import Filter
   6 from PLC.SliceTags import SliceTag, SliceTags
   7 from PLC.Persons import Person, Persons
   8 from PLC.Sites import Site, Sites
   9 from PLC.Slices import Slice, Slices
  10 from PLC.Auth import Auth
  11
  12 class GetSliceTags(Method):
  13     """
  14     Returns an array of structs containing details about slice and
  15     sliver attributes. An attribute is a sliver attribute if the
  16     node_id field is set. If slice_tag_filter is specified and
  17     is an array of slice attribute identifiers, or a struct of slice
  18     attribute attributes, only slice attributes matching the filter
  19     will be returned. If return_fields is specified, only the
  20     specified details will be returned.
  21
  22     Users may only query attributes of slices or slivers of which they
  23     are members. PIs may only query attributes of slices or slivers at
  24     their sites, or of which they are members. Admins may query
  25     attributes of any slice or sliver.
  26     """
  27
  28     roles = ['admin', 'pi', 'user', 'node']
  29
  30     accepts = [
  31         Auth(),
  32         Mixed([SliceTag.fields['slice_tag_id']],
  33               Filter(SliceTag.fields)),
  34         Parameter([str], "List of fields to return", nullok = True)
  35         ]
  36
  37     returns = [SliceTag.fields]
  38
  39
  40     def call(self, auth, slice_tag_filter = None, return_fields = None):
  41         # If we are not admin, make sure to only return our own slice
  42         # and sliver attributes.
  43         if isinstance(self.caller, Person) and \
  44            'admin' not in self.caller['roles']:
  45             # Get slices that we are able to view
  46             valid_slice_ids = self.caller['slice_ids']
  47             if 'pi' in self.caller['roles'] and self.caller['site_ids']:
  48                 sites = Sites(self.api, self.caller['site_ids'])
  49                 for site in sites:
  50                     valid_slice_ids += site['slice_ids']
  51
  52             if not valid_slice_ids:
  53                 return []
  54
  55             # Get slice attributes that we are able to view
  56             valid_slice_tag_ids = []
  57             slices = Slices(self.api, valid_slice_ids)
  58             for slice in slices:
  59                 valid_slice_tag_ids += slice['slice_tag_ids']
  60
  61             if not valid_slice_tag_ids:
  62                 return []
  63
  64             if slice_tag_filter is None:
  65                 slice_tag_filter = valid_slice_tag_ids
  66
  67         # Must query at least slice_tag_id (see below)
  68         if return_fields is not None and 'slice_tag_id' not in return_fields:
  69             return_fields.append('slice_tag_id')
  70             added_fields = True
  71         else:
  72             added_fields = False
  73
  74         slice_tags = SliceTags(self.api, slice_tag_filter, return_fields)
  75
  76         # Filter out slice attributes that are not viewable
  77         if isinstance(self.caller, Person) and \
  78            'admin' not in self.caller['roles']:
  79             slice_tags = filter(lambda slice_tag: \
  80                                       slice_tag['slice_tag_id'] in valid_slice_tag_ids,
  81                                       slice_tags)
  82
  83         # Remove slice_tag_id if not specified
  84         if added_fields:
  85             for slice_tag in slice_tags:
  86                 if 'slice_tag_id' in slice_tag:
  87                     del slice_tag['slice_tag_id']
  88
  89         return slice_tags