Merge remote-tracking branch 'origin/pycurl' into planetlab-4_0-branch

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

diff --git a/PLC/Methods/GetNodes.py b/PLC/Methods/GetNodes.py
index 2b270d0..8e2931a 100644 (file)
--- a/PLC/Methods/GetNodes.py
+++ b/PLC/Methods/GetNodes.py
@@ -1,52 +1,79 @@
-import os
-
 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.Auth import PasswordAuth
+from PLC.Persons import Person, Persons
+from PLC.Auth import Auth
 
 class GetNodes(Method):
     """
-    Return an array of dictionaries containing details about the
-    specified nodes.
-
-    If return_fields is specified, only the specified fields will be
-    returned. Only admins may retrieve certain fields. Otherwise, the
-    default set of fields returned is:
+    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.
     """
 
-    roles = ['admin', 'pi', 'user', 'tech']
+    roles = ['admin', 'pi', 'user', 'tech', 'node', 'anonymous']
 
     accepts = [
-        PasswordAuth(),
-        [Mixed(Node.fields['node_id'],
-               Node.fields['hostname'])],
+        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 __init__(self, *args, **kwds):
-        Method.__init__(self, *args, **kwds)
-        # Update documentation with list of default fields returned
-        self.__doc__ += os.linesep.join(Node.fields.keys())
 
-    def call(self, auth, node_id_or_hostname_list = None):
-        # Authenticated function
-        assert self.caller is not None
+    def call(self, auth, node_filter = None, return_fields = None):
+        
+       # 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 =[]    
 
-        valid_fields = Node.fields.keys()
+       # Get node information
+        nodes = Nodes(self.api, node_filter, return_fields)
 
         # Remove admin only fields
-        if 'admin' not in self.caller['roles']:
-            for key in ['boot_nonce', 'key', 'session', 'root_person_ids']:
-                valid_fields.remove(key)
+        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'])
+               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)
 
-        # Get node information
-        nodes = Nodes(self.api, node_id_or_hostname_list).values()
+           # remove remaining admin only fields
+            for node in nodes:    
+               for field in ['boot_nonce', 'key', 'session', 'root_person_ids']:
+                    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]     
 
-        # turn each node into a real dict.
-        nodes = [dict(node.items()) for node in nodes]
-                    
         return nodes