2 # Thierry Parmentelat - INRIA
4 from PLC.Faults import *
5 from PLC.Method import Method
6 from PLC.Parameter import Parameter, Mixed
7 from PLC.Auth import Auth
9 from PLC.TagTypes import TagType, TagTypes
10 from PLC.Slices import Slice, Slices
11 from PLC.Nodes import Node, Nodes
12 from PLC.SliceTags import SliceTag, SliceTags
13 from PLC.NodeGroups import NodeGroup, NodeGroups
14 from PLC.InitScripts import InitScript, InitScripts
16 # need to import so the core classes get decorated with caller_may_write_tag
17 from PLC.AuthorizeHelpers import AuthorizeHelpers
19 class AddSliceTag(Method):
21 Sets the specified tag of the slice to the specified value.
22 If nodegroup is specified, this applies to all slivers of that group.
23 If node is specified, this only applies to a sliver.
25 Admins have full access, including on nodegroups.
27 Non-admins need to have at least one of the roles
28 attached to the tagtype. In addition:
29 (*) Users may only set tags of slices or slivers of which they are members.
30 (*) PIs may only set tags of slices in their site
31 (*) techs cannot use this method
33 Returns the new slice_tag_id (> 0) if successful, faults
37 roles = ['admin', 'pi', 'user', 'node']
41 Mixed(Slice.fields['slice_id'],
42 Slice.fields['name']),
43 Mixed(SliceTag.fields['tag_type_id'],
44 SliceTag.fields['tagname']),
45 Mixed(SliceTag.fields['value'],
46 InitScript.fields['name']),
47 Mixed(Node.fields['node_id'],
48 Node.fields['hostname'],
50 Mixed(NodeGroup.fields['nodegroup_id'],
51 NodeGroup.fields['groupname'])
54 returns = Parameter(int, 'New slice_tag_id (> 0) if successful')
56 def call(self, auth, slice_id_or_name, tag_type_id_or_name, value, node_id_or_hostname = None, nodegroup_id_or_name = None):
57 slices = Slices(self.api, [slice_id_or_name])
59 raise PLCInvalidArgument("No such slice %r"%slice_id_or_name)
62 tag_types = TagTypes(self.api, [tag_type_id_or_name])
64 raise PLCInvalidArgument("No such tag type %r"%tag_type_id_or_name)
65 tag_type = tag_types[0]
67 # check authorizations
68 slice.caller_may_write_tag (self.api,self.caller,tag_type,node_id_or_hostname,nodegroup_id_or_name)
70 # if initscript is specified, validate value
71 if tag_type['tagname'] in ['initscript']:
72 initscripts = InitScripts(self.api, {'enabled': True, 'name': value})
74 raise PLCInvalidArgument("No such plc initscript %r"%value)
76 slice_tag = SliceTag(self.api)
77 slice_tag['slice_id'] = slice['slice_id']
78 slice_tag['tag_type_id'] = tag_type['tag_type_id']
79 slice_tag['value'] = str(value)
81 # Sliver attribute if node is specified
82 if node_id_or_hostname is not None or isinstance(self.caller, Node):
84 if isinstance(self.caller, Node):
86 node_id = node['node_id']
88 if node_id_or_hostname is not None:
89 nodes = Nodes(self.api, [node_id_or_hostname])
91 raise PLCInvalidArgument("No such node")
93 if node_id != None and node_id != node['node_id']:
94 raise PLCPermissionDenied("Not allowed to set another node's sliver attribute")
96 node_id = node['node_id']
98 system_slice_tags = SliceTags(self.api, {'tagname': 'system', 'value': '1'}).dict('slice_id')
99 system_slice_ids = list(system_slice_tags.keys())
100 if slice['slice_id'] not in system_slice_ids and node_id not in slice['node_ids']:
101 raise PLCInvalidArgument("AddSliceTag: slice %s not on specified node %s nor is it a system slice (%r)"%\
102 (slice['name'],node['hostname'],system_slice_ids))
103 slice_tag['node_id'] = node['node_id']
105 # Sliver attribute shared accross nodes if nodegroup is sepcified
106 if nodegroup_id_or_name is not None:
107 if isinstance(self.caller, Node):
108 raise PLCPermissionDenied("Not allowed to set nodegroup slice attributes")
110 nodegroups = NodeGroups(self.api, [nodegroup_id_or_name])
112 raise PLCInvalidArgument("No such nodegroup %r"%nodegroup_id_or_name)
113 nodegroup = nodegroups[0]
115 slice_tag['nodegroup_id'] = nodegroup['nodegroup_id']
117 # Check if slice attribute already exists
118 slice_tags_check = SliceTags(self.api, {'slice_id': slice['slice_id'],
119 'tagname': tag_type['tagname'],
121 for slice_tag_check in slice_tags_check:
122 # do not compare between slice tag and sliver tag
123 if 'node_id' not in slice_tag and slice_tag_check['node_id'] is not None:
125 # do not compare between sliver tag and slice tag
126 if 'node_id' in slice_tag and slice_tag['node_id'] is not None and slice_tag_check['node_id'] is None:
128 if 'node_id' in slice_tag and slice_tag['node_id'] == slice_tag_check['node_id']:
129 raise PLCInvalidArgument("Sliver attribute already exists")
130 if 'nodegroup_id' in slice_tag and slice_tag['nodegroup_id'] == slice_tag_check['nodegroup_id']:
131 raise PLCInvalidArgument("Slice attribute already exists for this nodegroup")
132 if node_id_or_hostname is None and nodegroup_id_or_name is None:
133 raise PLCInvalidArgument("Slice attribute already exists")
136 self.event_objects = {'SliceTag': [slice_tag['slice_tag_id']]}
138 return slice_tag['slice_tag_id']