2 # Thierry Parmentelat - INRIA
6 from PLC.Faults import *
7 from PLC.Method import Method
8 from PLC.Parameter import Parameter, Mixed
9 from PLC.Auth import Auth
11 from PLC.NodeNetworkSettingTypes import NodeNetworkSettingType, NodeNetworkSettingTypes
12 from PLC.NodeNetworkSettings import NodeNetworkSetting, NodeNetworkSettings
13 from PLC.NodeNetworks import NodeNetwork, NodeNetworks
15 from PLC.Nodes import Nodes
16 from PLC.Sites import Sites
18 class AddNodeNetworkSetting(Method):
20 Sets the specified setting for the specified nodenetwork
21 to the specified value.
23 In general only tech(s), PI(s) and of course admin(s) are allowed to
24 do the change, but this is defined in the nodenetwork setting type object.
26 Returns the new nodenetwork_setting_id (> 0) if successful, faults
30 roles = ['admin', 'pi', 'tech', 'user']
34 # no other way to refer to a nodenetwork
35 NodeNetworkSetting.fields['nodenetwork_id'],
36 Mixed(NodeNetworkSettingType.fields['nodenetwork_setting_type_id'],
37 NodeNetworkSettingType.fields['name']),
38 NodeNetworkSetting.fields['value'],
41 returns = Parameter(int, 'New nodenetwork_setting_id (> 0) if successful')
43 object_type = 'NodeNetwork'
46 def call(self, auth, nodenetwork_id, nodenetwork_setting_type_id_or_name, value):
47 nodenetworks = NodeNetworks(self.api, [nodenetwork_id])
49 raise PLCInvalidArgument, "No such nodenetwork %r"%nodenetwork_id
50 nodenetwork = nodenetworks[0]
52 nodenetwork_setting_types = NodeNetworkSettingTypes(self.api, [nodenetwork_setting_type_id_or_name])
53 if not nodenetwork_setting_types:
54 raise PLCInvalidArgument, "No such nodenetwork setting type %r"%nodenetwork_setting_type_id_or_name
55 nodenetwork_setting_type = nodenetwork_setting_types[0]
57 # checks for existence - does not allow several different settings
58 conflicts = NodeNetworkSettings(self.api,
59 {'nodenetwork_id':nodenetwork['nodenetwork_id'],
60 'nodenetwork_setting_type_id':nodenetwork_setting_type['nodenetwork_setting_type_id']})
63 raise PLCInvalidArgument, "Nodenetwork %d already has setting %d"%(nodenetwork['nodenetwork_id'],
64 nodenetwork_setting_type['nodenetwork_setting_type_id'])
66 # check permission : it not admin, is the user affiliated with the right site
67 if 'admin' not in self.caller['roles']:
69 node = Nodes (self.api,[nodenetwork['node_id']])[0]
71 site = Sites (self.api, [node['site_id']])[0]
72 # check caller is affiliated with this site
73 if self.caller['person_id'] not in site['person_ids']:
74 raise PLCPermissionDenied, "Not a member of the hosting site %s"%site['abbreviated_site']
76 required_min_role = nodenetwork_setting_type ['min_role_id']
77 if required_min_role is not None and \
78 min(self.caller['role_ids']) > required_min_role:
79 raise PLCPermissionDenied, "Not allowed to modify the specified nodenetwork setting, requires role %d",required_min_role
81 nodenetwork_setting = NodeNetworkSetting(self.api)
82 nodenetwork_setting['nodenetwork_id'] = nodenetwork['nodenetwork_id']
83 nodenetwork_setting['nodenetwork_setting_type_id'] = nodenetwork_setting_type['nodenetwork_setting_type_id']
84 nodenetwork_setting['value'] = value
86 nodenetwork_setting.sync()
87 self.object_ids = [nodenetwork_setting['nodenetwork_setting_id']]
89 return nodenetwork_setting['nodenetwork_setting_id']