X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FMethods%2FGetSlices.py;h=63dc0b40885b2231faac0f4143d5c3327f23669e;hb=refs%2Fheads%2Fplanetlab-4_0-branch;hp=8560367f01de333b74dad873adeb6014574888d7;hpb=c8005424dcfa9e09275402d6e8bacbc989e92174;p=plcapi.git diff --git a/PLC/Methods/GetSlices.py b/PLC/Methods/GetSlices.py index 8560367..63dc0b4 100644 --- a/PLC/Methods/GetSlices.py +++ b/PLC/Methods/GetSlices.py @@ -1,53 +1,75 @@ from PLC.Method import Method from PLC.Parameter import Parameter, Mixed -from PLC.Auth import PasswordAuth +from PLC.Filter import Filter +from PLC.Auth import Auth +from PLC.Persons import Person, Persons +from PLC.Sites import Site, Sites from PLC.Slices import Slice, Slices class GetSlices(Method): """ - Return an array of structs containing details about slices. If - slice_id_or_name_list is specified, only the specified slices will - be queried. + Returns an array of structs containing details about slices. If + slice_filter is specified and is an array of slice identifiers or + slice names, or a struct of slice attributes, only slices matching + the filter will be returned. If return_fields is specified, only the + specified details will be returned. Users may only query slices of which they are members. PIs may - query any of the slices at their sites. Admins may query any - slice. If a slice that cannot be queried is specified in - slice_id_or_name_list, details about that slice will not be - returned. + query any of the slices at their sites. Admins and nodes may query + any slice. If a slice that cannot be queried is specified in + slice_filter, details about that slice will not be returned. """ - roles = ['admin', 'pi', 'user'] + roles = ['admin', 'pi', 'user', 'node'] accepts = [ - PasswordAuth(), - [Mixed(Slice.fields['slice_id'], - Slice.fields['name'])] + Auth(), + Mixed([Mixed(Slice.fields['slice_id'], + Slice.fields['name'])], + Parameter(str,"name"), + Parameter(int,"slice_id"), + Filter(Slice.fields)), + Parameter([str], "List of fields to return", nullok = True) ] returns = [Slice.fields] - def call(self, auth, slice_id_or_name_list = None): + def call(self, auth, slice_filter = None, return_fields = None): # If we are not admin, make sure to return only viewable # slices. - if 'admin' not in self.caller['roles']: + if isinstance(self.caller, Person) and \ + 'admin' not in self.caller['roles']: # Get slices that we are able to view valid_slice_ids = self.caller['slice_ids'] if 'pi' in self.caller['roles'] and self.caller['site_ids']: - sites = Sites(self.api, self.caller['site_ids']).values() + sites = Sites(self.api, self.caller['site_ids']) for site in sites: valid_slice_ids += site['slice_ids'] if not valid_slice_ids: return [] - if not slice_id_or_name_list: - slice_id_or_name_list = valid_slice_ids + if slice_filter is None: + slice_filter = valid_slice_ids - slices = Slices(self.api, slice_id_or_name_list).values() + # Must query at least slice_id (see below) + if return_fields is not None and 'slice_id' not in return_fields: + return_fields.append('slice_id') + added_fields = True + else: + added_fields = False + + slices = Slices(self.api, slice_filter, return_fields) # Filter out slices that are not viewable - if 'admin' not in self.caller['roles']: - can_view = lambda slice: slice['slice_id'] in valid_slice_ids - slices = filter(can_view, slices) + if isinstance(self.caller, Person) and \ + 'admin' not in self.caller['roles']: + slices = filter(lambda slice: slice['slice_id'] in valid_slice_ids, slices) + + # Remove slice_id if not specified + if added_fields: + for slice in slices: + if 'slice_id' in slice: + del slice['slice_id'] return slices