28834e5b9ebb8c5d3f6d8acb3d3a9dd0b5f86dd4
[plcapi.git] / PLC / Methods / AddSliceAttribute.py
1 # $Id#
2 from PLC.Faults import *
3 from PLC.Method import Method
4 from PLC.Parameter import Parameter, Mixed
5 from PLC.TagTypes import TagType, TagTypes
6 from PLC.Slices import Slice, Slices
7 from PLC.Nodes import Node, Nodes
8 from PLC.SliceAttributes import SliceAttribute, SliceAttributes
9 from PLC.NodeGroups import NodeGroup, NodeGroups
10 from PLC.InitScripts import InitScript, InitScripts
11 from PLC.Auth import Auth
12
13 class AddSliceAttribute(Method):
14     """
15     Sets the specified attribute of the slice (or sliver, if
16     node_id_or_hostname is specified) to the specified value.
17
18     Attributes may require the caller to have a particular role in
19     order to be set or changed. Users may only set attributes of
20     slices or slivers of which they are members. PIs may only set
21     attributes of slices or slivers at their sites, or of which they
22     are members. Admins may set attributes of any slice or sliver.
23
24     Returns the new slice_attribute_id (> 0) if successful, faults
25     otherwise.
26     """
27
28     roles = ['admin', 'pi', 'user']
29
30     accepts = [
31         Auth(),
32         Mixed(Slice.fields['slice_id'],
33               Slice.fields['name']),
34         Mixed(SliceAttribute.fields['tag_type_id'],
35               SliceAttribute.fields['tagname']),
36         Mixed(SliceAttribute.fields['value'],
37               InitScript.fields['name']),
38         Mixed(Node.fields['node_id'],
39               Node.fields['hostname'],
40               None),
41         Mixed(NodeGroup.fields['nodegroup_id'],
42               NodeGroup.fields['groupname'])
43         ]
44
45     returns = Parameter(int, 'New slice_attribute_id (> 0) if successful')
46
47     def call(self, auth, slice_id_or_name, tag_type_id_or_name, value, node_id_or_hostname = None, nodegroup_id_or_name = None):
48         slices = Slices(self.api, [slice_id_or_name])
49         if not slices:
50             raise PLCInvalidArgument, "No such slice %r"%slice_id_or_name
51         slice = slices[0]
52
53         tag_types = TagTypes(self.api, [tag_type_id_or_name])
54         if not tag_types:
55             raise PLCInvalidArgument, "No such tag type %r"%tag_type_id_or_name
56         tag_type = tag_types[0]
57
58         if 'admin' not in self.caller['roles']:
59             if self.caller['person_id'] in slice['person_ids']:
60                 pass
61             elif 'pi' not in self.caller['roles']:
62                 raise PLCPermissionDenied, "Not a member of the specified slice"
63             elif slice['site_id'] not in self.caller['site_ids']:
64                 raise PLCPermissionDenied, "Specified slice not associated with any of your sites"
65
66             if tag_type['min_role_id'] is not None and \
67                min(self.caller['role_ids']) > tag_type['min_role_id']:
68                 raise PLCPermissionDenied, "Not allowed to set the specified slice attribute"
69
70         # if initscript is specified, validate value
71         if tag_type['tagname'] in ['initscript']:
72             initscripts = InitScripts(self.api, {'enabled': True, 'name': value})
73             if not initscripts: 
74                 raise PLCInvalidArgument, "No such plc initscript %r"%value
75
76         slice_attribute = SliceAttribute(self.api)
77         slice_attribute['slice_id'] = slice['slice_id']
78         slice_attribute['tag_type_id'] = tag_type['tag_type_id']
79         slice_attribute['value'] = unicode(value)
80
81         # Sliver attribute if node is specified
82         if node_id_or_hostname is not None:
83             nodes = Nodes(self.api, [node_id_or_hostname])
84             if not nodes:
85                 raise PLCInvalidArgument, "No such node"
86             node = nodes[0]
87             
88             if node['node_id'] not in slice['node_ids']:
89                 raise PLCInvalidArgument, "Node not in the specified slice"
90             slice_attribute['node_id'] = node['node_id']
91
92         # Sliver attribute shared accross nodes if nodegroup is sepcified
93         if nodegroup_id_or_name is not None:
94             nodegroups = NodeGroups(self.api, [nodegroup_id_or_name])
95             if not nodegroups:
96                 raise PLCInvalidArgument, "No such nodegroup %r"%nodegroup_id_or_name
97             nodegroup = nodegroups[0]
98         
99             slice_attribute['nodegroup_id'] = nodegroup['nodegroup_id']
100
101         # Check if slice attribute alreay exists
102         slice_attributes_check = SliceAttributes(self.api, {'slice_id': slice['slice_id'], 
103                                                             'tagname': tag_type['tagname'], 
104                                                             'value': value})
105         for slice_attribute_check in slice_attributes_check:
106             if 'node_id' in slice_attribute and slice_attribute['node_id'] == slice_attribute_check['node_id']:
107                 raise PLCInvalidArgument, "Sliver attribute already exists"
108             if 'nodegroup_id' in slice_attribute and slice_attribute['nodegroup_id'] == slice_attribute_check['nodegroup_id']:
109                 raise PLCInvalidArgument, "Slice attribute already exists for this nodegroup"
110             if node_id_or_hostname is None and nodegroup_id_or_name is None:
111                 raise PLCInvalidArgument, "Slice attribute already exists"
112
113         slice_attribute.sync()
114         self.event_objects = {'SliceAttribute': [slice_attribute['slice_attribute_id']]}
115
116         return slice_attribute['slice_attribute_id']