Branch 5.0 for module PLCAPI created from tag PLCAPI-4.2-8

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

diff --git a/PLC/Methods/AdmGetSiteNodes.py b/PLC/Methods/AdmGetSiteNodes.py
index df38afa..b366c80 100644 (file)
--- a/PLC/Methods/AdmGetSiteNodes.py
+++ b/PLC/Methods/AdmGetSiteNodes.py
@@ -1,64 +1,44 @@
-import os
-
 from PLC.Faults import *
 from PLC.Method import Method
 from PLC.Parameter import Parameter, Mixed
 from PLC.Sites import Site, Sites
-from PLC.Nodes import Node, Nodes
-from PLC.Auth import PasswordAuth
+from PLC.Auth import Auth
 
 class AdmGetSiteNodes(Method):
     """
-    Return a dictionary containing a list of node_ids for the  sites specified.
+    Deprecated. See GetSites.
+
+    Return a struct containing an array of node_ids for each of the
+    sites specified. Note that the keys of the struct are strings, not
+    integers, because of XML-RPC marshalling limitations.
 
     Admins may retrieve details about all nodes on a site by not specifying
     site_id_or_name or by specifying an empty list. Users and
     techs may only retrieve details about themselves. PIs may retrieve
     details about themselves and others at their sites.
-
     """
 
+    status = "deprecated"
+
     roles = ['admin', 'pi', 'user', 'tech']
 
     accepts = [
-        PasswordAuth(),
+        Auth(),
         [Mixed(Site.fields['site_id'],
                Site.fields['name'])],
-        Parameter([str], 'List of fields to return')
         ]
-       
-    returns={Site.fields['site_id']: [Site.all_fields['node_ids']]}
-    
-    def __init__(self, *args, **kwds):
-        Method.__init__(self, *args, **kwds)
-        # Update documentation with list of default fields returned
-        self.__doc__ += os.linesep.join(Site.default_fields.keys())
 
-    def call(self, auth, site_id_or_name_list = None):
-        # Authenticated function
-        assert self.caller is not None
-
-       #convert site_id_or_name_list to 'None' if is [] (empty list)
-       if site_id_or_name_list is not None and site_id_or_name_list == []:
-               site_id_or_name_list = None
+    returns = dict
 
+    def call(self, auth, site_id_or_name_list = None):
         # Get site information
-       sites = Sites(self.api, site_id_or_name_list, ['node_ids']).values()    
-
-       # make sure sites are found
+       sites = Sites(self.api, site_id_or_name_list)   
        if not sites:
-               raise PLCInvalidArgument, "No such site"
-       elif site_id_or_name_list is None:
-               pass
-       elif not len(sites) == len(site_id_or_name_list):
-               raise PLCInvalidArgument, "at least one site_id is invalid"
+            raise PLCInvalidArgument, "No such site"
         
-       #Convert list of sites dictionaries into a dictionary of sites -> sites:[node_ids]
+       # Convert to {str(site_id): [node_id]}
        site_nodes = {}
        for site in sites:
-               #filter out deleted nodes
-               nodes = Nodes(self.api, site['node_ids'])
-               #creat valid node list dictionary
-               site_nodes[str(site['site_id'])] = nodes.keys()
+            site_nodes[str(site['site_id'])] = site['node_ids']
                
         return site_nodes