- fix documentation
[plcapi.git] / PLC / Methods / AddNode.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.Nodes import Node, Nodes
5 from PLC.NodeGroups import NodeGroup, NodeGroups
6 from PLC.Sites import Site, Sites
7 from PLC.Auth import PasswordAuth
8
9 class AddNode(Method):
10     """
11     Adds a new node. Any values specified in optional_vals are used,
12     otherwise defaults are used.
13
14     PIs and techs may only add nodes to their own sites. Admins may
15     add nodes to any site.
16
17     Returns the new node_id (> 0) if successful, faults otherwise.
18     """
19
20     roles = ['admin', 'pi', 'tech']
21
22     can_update = lambda (field, value): field in \
23                  ['boot_state', 'model', 'version']
24     update_fields = dict(filter(can_update, Node.fields.items()))
25
26     accepts = [
27         PasswordAuth(),
28         Mixed(Site.fields['site_id'],
29               Site.fields['login_base']),
30         Node.fields['hostname'],
31         update_fields
32         ]
33
34     returns = Parameter(int, 'New node_id (> 0) if successful')
35
36     def call(self, auth, site_id_or_login_base, hostname, optional_vals = {}):
37         if filter(lambda field: field not in self.update_fields, optional_vals):
38             raise PLCInvalidArgument, "Invalid fields specified"
39
40         # Get site information
41         sites = Sites(self.api, [site_id_or_login_base])
42         if not sites:
43             raise PLCInvalidArgument, "No such site"
44
45         site = sites.values()[0]
46
47         # Authenticated function
48         assert self.caller is not None
49
50         # If we are not an admin, make sure that the caller is a
51         # member of the site.
52         if 'admin' not in self.caller['roles']:
53             if site['site_id'] not in self.caller['site_ids']:
54                 assert self.caller['person_id'] not in site['person_ids']
55                 raise PLCPermissionDenied, "Not allowed to add nodes to specified site"
56             else:
57                 assert self.caller['person_id'] in site['person_ids']
58
59         node = Node(self.api, optional_vals)
60         node['hostname'] = hostname
61         node['site_id'] = site['site_id']
62         node.sync()
63
64         return node['node_id']