PLC/Methods/GetSlices.py

   1 from PLC.Method import Method
   2 from PLC.Parameter import Parameter, Mixed
   3 from PLC.Auth import PasswordAuth
   4 from PLC.Slices import Slice, Slices
   5
   6 class GetSlices(Method):
   7     """
   8     Return an array of structs containing details about slices. If
   9     slice_id_or_name_list is specified, only the specified slices will
  10     be queried.
  11
  12     Users may only query slices of which they are members. PIs may
  13     query any of the slices at their sites. Admins may query any
  14     slice. If a slice that cannot be queried is specified in
  15     slice_id_or_name_list, details about that slice will not be
  16     returned.
  17     """
  18
  19     roles = ['admin', 'pi', 'user']
  20
  21     accepts = [
  22         PasswordAuth(),
  23         [Mixed(Slice.fields['slice_id'],
  24                Slice.fields['name'])]
  25         ]
  26
  27     returns = [Slice.fields]
  28
  29     def call(self, auth, slice_id_or_name_list = None):
  30         # If we are not admin, make sure to return only viewable
  31         # slices.
  32         if 'admin' not in self.caller['roles']:
  33             # Get slices that we are able to view
  34             valid_slice_ids = self.caller['slice_ids']
  35             if 'pi' in self.caller['roles'] and self.caller['site_ids']:
  36                 sites = Sites(self.api, self.caller['site_ids']).values()
  37                 for site in sites:
  38                     valid_slice_ids += site['slice_ids']
  39
  40             if not valid_slice_ids:
  41                 return []
  42
  43             if not slice_id_or_name_list:
  44                 slice_id_or_name_list = valid_slice_ids
  45
  46         slices = Slices(self.api, slice_id_or_name_list).values()
  47
  48         # Filter out slices that are not viewable
  49         if 'admin' not in self.caller['roles']:
  50             can_view = lambda slice: slice['slice_id'] in valid_slice_ids
  51             slices = filter(can_view, slices)
  52
  53         return slices