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.Slices import Slice, Slices
   6
   7 class GetSlices(Method):
   8     """
   9     Returns an array of structs containing details about slices. If
  10     slice_filter is specified and is an array of slice identifiers or
  11     slice names, or a struct of slice attributes, only slices matching
  12     the filter will be returned. If return_fields is specified, only the
  13     specified details will be returned.
  14
  15     Users may only query slices of which they are members. PIs may
  16     query any of the slices at their sites. Admins may query any
  17     slice. If a slice that cannot be queried is specified in
  18     slice_filter, details about that slice will not be returned.
  19     """
  20
  21     roles = ['admin', 'pi', 'user']
  22
  23     accepts = [
  24         Auth(),
  25         Mixed([Mixed(Slice.fields['slice_id'],
  26                      Slice.fields['name'])],
  27               Filter(Slice.fields)),
  28         Parameter([str], "List of fields to return", nullok = True)
  29         ]
  30
  31     returns = [Slice.fields]
  32
  33
  34     def call(self, auth, slice_filter = None, return_fields = None):
  35         # If we are not admin, make sure to return only viewable
  36         # slices.
  37         if 'admin' not in self.caller['roles']:
  38             # Get slices that we are able to view
  39             valid_slice_ids = self.caller['slice_ids']
  40             if 'pi' in self.caller['roles'] and self.caller['site_ids']:
  41                 sites = Sites(self.api, self.caller['site_ids'])
  42                 for site in sites:
  43                     valid_slice_ids += site['slice_ids']
  44
  45             if not valid_slice_ids:
  46                 return []
  47
  48             if slice_filter is None:
  49                 slice_filter = valid_slice_ids
  50
  51         slices = Slices(self.api, slice_filter, return_fields)
  52
  53         # Filter out slices that are not viewable
  54         if 'admin' not in self.caller['roles']:
  55             slices = filter(lambda slice: slice['slice_id'] in valid_slice_ids, slices)
  56
  57         return slices