3 from PLC.Faults import *
4 from PLC.Method import Method
5 from PLC.Parameter import Parameter, Mixed
6 from PLC.Nodes import Node, Nodes
7 from PLC.Auth import PasswordAuth
9 class AdmGetNodes(Method):
11 Return an array of dictionaries containing details about the
14 Admins may retrieve details about all accounts by not specifying
15 node_id_or_email_list or by specifying an empty list. Users and
16 techs may only retrieve details about themselves. PIs may retrieve
17 details about themselves and others at their sites.
19 If return_fields is specified, only the specified fields will be
20 returned, if set. Otherwise, the default set of fields returned is:
24 roles = ['admin', 'pi', 'user', 'tech']
28 [Mixed(Node.fields['node_id'],
29 Node.fields['hostname'])],
30 Parameter([str], 'List of fields to return')
33 # Filter out hidden fields
34 can_return = lambda (field, value): field not in ['deleted']
35 return_fields = dict(filter(can_return, Node.all_fields.items()))
36 returns = [return_fields]
38 def __init__(self, *args, **kwds):
39 Method.__init__(self, *args, **kwds)
40 # Update documentation with list of default fields returned
41 self.__doc__ += os.linesep.join(Node.default_fields.keys())
43 def call(self, auth, node_id_or_hostname_list = None, return_fields = None):
44 # Authenticated function
45 assert self.caller is not None
47 # Remove admin only fields
48 if 'admin' not in self.caller['roles']:
49 for key in ['boot_nonce', 'key', 'session', 'root_person_ids']:
50 del self.return_fields[key]
52 # Make sure that only valid fields are specified
53 if return_fields is None:
54 return_fields = self.return_fields
55 elif filter(lambda field: field not in self.return_fields, return_fields):
56 raise PLCInvalidArgument, "Invalid return field specified"
58 # Get node information
59 nodes = Nodes(self.api, node_id_or_hostname_list, return_fields).values()
61 # Filter out undesired or None fields (XML-RPC cannot marshal
62 # None) and turn each node into a real dict.
63 valid_return_fields_only = lambda (key, value): \
64 key in return_fields and value is not None
65 nodes = [dict(filter(valid_return_fields_only, node.items())) \