PLC/Methods/GetSlices.py

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