svn keywords

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

diff --git a/PLC/Methods/GetNodes.py b/PLC/Methods/GetNodes.py
index 92f0111..90be951 100644 (file)
--- a/PLC/Methods/GetNodes.py
+++ b/PLC/Methods/GetNodes.py
@@ -1,45 +1,143 @@
+# $Id$
+# $URL$
 from PLC.Faults import *
 from PLC.Method import Method
 from PLC.Parameter import Parameter, Mixed
 from PLC.Filter import Filter
 from PLC.Nodes import Node, Nodes
+from PLC.Persons import Person, Persons
 from PLC.Auth import Auth
 
-class GetNodes(Method):
+admin_only = ['key', 'session', 'boot_nonce' ]
+
+class v43GetNodes(Method):
     """
     Returns an array of structs containing details about nodes. If
     node_filter is specified and is an array of node identifiers or
     hostnames, or a struct of node attributes, only nodes matching the
-    filter will be returned. If return_fields is specified, only the
-    specified details will be returned.
+    filter will be returned. 
+
+    If return_fields is specified, only the specified details will be
+    returned. NOTE that if return_fields is unspecified, the complete
+    set of native fields are returned, which DOES NOT include tags at
+    this time.
 
     Some fields may only be viewed by admins.
     """
 
-    roles = ['admin', 'pi', 'user', 'tech']
+    roles = ['admin', 'pi', 'user', 'tech', 'node', 'anonymous']
 
     accepts = [
         Auth(),
         Mixed([Mixed(Node.fields['node_id'],
                      Node.fields['hostname'])],
+             Parameter(str,"hostname"),
+              Parameter(int,"node_id"),
               Filter(Node.fields)),
         Parameter([str], "List of fields to return", nullok = True),
         ]
 
     returns = [Node.fields]
 
-    event_type = 'Get'
-    object_type = 'Node'
 
     def call(self, auth, node_filter = None, return_fields = None):
-        # Get node information
+        
+       # Must query at least slice_ids_whitelist
+       if return_fields is not None:
+           added_fields = set(['slice_ids_whitelist', 'site_id']).difference(return_fields)
+           return_fields += added_fields
+       else:
+           added_fields =[]    
+
+       # Get node information
         nodes = Nodes(self.api, node_filter, return_fields)
 
         # Remove admin only fields
-        if 'admin' not in self.caller['roles']:
-            for node in nodes:
-                for field in ['boot_nonce', 'key', 'session', 'root_person_ids']:
+        if not isinstance(self.caller, Person) or \
+           'admin' not in self.caller['roles']:
+           slice_ids = set()
+           site_ids = set()
+           
+           if self.caller:
+               slice_ids.update(self.caller['slice_ids'])
+               if isinstance(self.caller, Node):
+                   site_ids.update([self.caller['site_id']])
+               else:  
+                   site_ids.update(self.caller['site_ids'])
+
+           # if node has whitelist, only return it if users is at
+           # the same site or user has a slice on the whitelist 
+            for node in nodes[:]:
+               if 'site_id' in node and \
+                  site_ids.intersection([node['site_id']]):
+                   continue    
+               if 'slice_ids_whitelist' in node and \
+                  node['slice_ids_whitelist'] and \
+                  not slice_ids.intersection(node['slice_ids_whitelist']):
+                   nodes.remove(node)
+
+           # remove remaining admin only fields
+            for node in nodes:    
+               for field in admin_only:
                     if field in node:
                         del node[field]
+       
+       # remove added fields if not specified
+       if added_fields:
+           for node in nodes:
+               for field in added_fields:
+                   del node[field]     
 
         return nodes
+
+node_fields = Node.fields.copy()
+node_fields['nodenetwork_ids']=Parameter([int], "Legacy version of interface_ids")
+
+class v42GetNodes(v43GetNodes):
+    """
+    Legacy wrapper for v43GetNodes.
+    """
+
+    accepts = [
+        Auth(),
+        Mixed([Mixed(Node.fields['node_id'],
+                     Node.fields['hostname'])],
+             Parameter(str,"hostname"),
+              Parameter(int,"node_id"),
+              Filter(node_fields)),
+        Parameter([str], "List of fields to return", nullok = True),
+        ]
+    returns = [node_fields]
+
+    def call(self, auth, node_filter = None, return_fields = None):
+        # convert nodenetwork_ids -> interface_ids
+        if isinstance(node_filter, dict):
+            if node_filter.has_key('nodenetwork_ids'):
+                interface_ids = node_filter.pop('nodenetwork_ids')
+                if not node_filter.has_key('interface_ids'):
+                    node_filter['interface_ids']=interface_ids
+
+        if isinstance(return_fields, list):
+            if 'nodenetwork_ids' in return_fields:
+                return_fields.remove('nodenetwork_ids')
+                if 'interface_ids' not in return_fields:
+                    return_fields.append('interface_ids')
+        nodes = v43GetNodes.call(self,auth,node_filter,return_fields)
+        # if interface_ids are present, then create a nodenetwork_ids mapping
+        for node in nodes:
+            if node.has_key('interface_ids'):
+                node['nodenetwork_ids']=node['interface_ids']
+        return nodes
+
+class GetNodes(v42GetNodes):
+    """
+    Returns an array of structs containing details about nodes. If
+    node_filter is specified and is an array of node identifiers or
+    hostnames, or a struct of node attributes, only nodes matching the
+    filter will be returned. If return_fields is specified, only the
+    specified details will be returned.
+
+    Some fields may only be viewed by admins.
+    """
+
+    pass