PLC/Methods/GetSlices.py

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