PLC/Methods/GetSliceTags.py

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