svn keywords

[plcapi.git] / PLC / Methods / GetSlices.py

diff --git a/PLC/Methods/GetSlices.py b/PLC/Methods/GetSlices.py
index 2b85623..0d34bbf 100644 (file)
--- a/PLC/Methods/GetSlices.py
+++ b/PLC/Methods/GetSlices.py
@@ -1,10 +1,14 @@
+# $Id$
+# $URL$
 from PLC.Method import Method
 from PLC.Parameter import Parameter, Mixed
 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):
+class v43GetSlices(Method):
     """
     Returns an array of structs containing details about slices. If
     slice_filter is specified and is an array of slice identifiers or
@@ -13,28 +17,30 @@ class GetSlices(Method):
     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
+    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 = [
         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_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']:
@@ -48,10 +54,79 @@ class GetSlices(Method):
             if slice_filter is None:
                 slice_filter = valid_slice_ids
 
+        # 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']:
+        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
+
+slice_fields = Slice.fields.copy()
+slice_fields['slice_attribute_ids']=Parameter([int], "Legacy version of slice_tag_ids")
+
+class v42GetSlices(v43GetSlices):
+    """
+    Legacy wrapper for v43GetSlices.
+    """
+
+    accepts = [
+        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_filter = None, return_fields = None):
+        # convert nodenetwork_ids -> interface_ids
+        if isinstance(slice_filter, dict):
+            if slice_filter.has_key('slice_attribute_ids'):
+                slice_tag_ids = slice_filter.pop('slice_attribute_ids') 
+                if not slice_filter.has_key('slice_tag_ids'):
+                    slice_filter['slice_tag_ids']=slice_tag_ids
+        if isinstance(return_fields, list):
+            if 'slice_attribute_ids' in return_fields:
+                return_fields.remove('slice_attribute_ids')
+                if 'slice_tag_ids' not in return_fields:
+                    return_fields.append('slice_tag_ids')
+        slices = v43GetSlices.call(self,auth,slice_filter,return_fields)
+        # add in a slice_tag_ids -> slice_attribute_ids
+        for slice in slices:
+            if slice.has_key('slice_tag_ids'):
+                slice['slice_attribute_ids']=slice['slice_tag_ids']
+        return slices
+
+class GetSlices(v42GetSlices):
+    """
+    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 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.
+    """
+
+    pass