iteration 4 & last:

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

diff --git a/PLC/Methods/GetNodes.py b/PLC/Methods/GetNodes.py
index 2b270d0..937b948 100644 (file)
--- a/PLC/Methods/GetNodes.py
+++ b/PLC/Methods/GetNodes.py
@@ -1,52 +1,43 @@
-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.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']
 
     accepts = [
-        PasswordAuth(),
-        [Mixed(Node.fields['node_id'],
-               Node.fields['hostname'])],
+        Auth(),
+        Mixed([Mixed(Node.fields['node_id'],
+                     Node.fields['hostname'])],
+              Filter(Node.fields)),
+        Parameter([str], "List of fields to return", nullok = True),
+        Parameter(str,"scope string, can be either 'all', 'local' or 'foreign'"),
         ]
 
     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
-
-        valid_fields = Node.fields.keys()
+    def call(self, auth, node_filter = None, return_fields = None, scope = 'all'):
+        # Get node information
+        nodes = Nodes(self.api, node_filter, return_fields, scope)
 
         # 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)
-
-        # Get node information
-        nodes = Nodes(self.api, node_id_or_hostname_list).values()
+            for node in nodes:
+                for field in ['boot_nonce', 'key', 'session', 'root_person_ids']:
+                    if field in node:
+                        del node[field]
 
-        # turn each node into a real dict.
-        nodes = [dict(node.items()) for node in nodes]
-                    
         return nodes