6f808c49083ba2b5eac5b0e5d904320f091077f8
[plcapi.git] / PLC / Methods / AddSliceAttribute.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.SliceAttributeTypes import SliceAttributeType, SliceAttributeTypes
5 from PLC.Slices import Slice, Slices
6 from PLC.Nodes import Node, Nodes
7 from PLC.SliceAttributes import SliceAttribute, SliceAttributes
8 from PLC.Auth import Auth
9
10 class AddSliceAttribute(Method):
11     """
12     Sets the specified attribute of the slice (or sliver, if
13     node_id_or_hostname is specified) to the specified value.
14
15     Attributes may require the caller to have a particular role in
16     order to be set or changed. Users may only set attributes of
17     slices or slivers of which they are members. PIs may only set
18     attributes of slices or slivers at their sites, or of which they
19     are members. Admins may set attributes of any slice or sliver.
20
21     Returns the new slice_attribute_id (> 0) if successful, faults
22     otherwise.
23     """
24
25     roles = ['admin', 'pi', 'user']
26
27     accepts = [
28         Auth(),
29         Mixed(SliceAttribute.fields['slice_id'],
30               SliceAttribute.fields['name']),
31         Mixed(SliceAttribute.fields['attribute_type_id'],
32               SliceAttribute.fields['name']),
33         SliceAttribute.fields['value'],
34         Mixed(Node.fields['node_id'],
35               Node.fields['hostname'])
36         ]
37
38     returns = Parameter(int, 'New slice_attribute_id (> 0) if successful')
39
40     event_type = 'Add'
41     object_type = 'SliceAttribute'
42     object_ids = []
43
44     def call(self, auth, slice_id_or_name, attribute_type_id_or_name, value, node_id_or_hostname = None):
45         slices = Slices(self.api, [slice_id_or_name]).values()
46         if not slices:
47             raise PLCInvalidArgument, "No such slice"
48         slice = slices[0]
49
50         attribute_types = SliceAttributeTypes(self.api, [attribute_type_id_or_name]).values()
51         if not attribute_types:
52             raise PLCInvalidArgument, "No such slice attribute type"
53         attribute_type = attribute_types[0]
54
55         if 'admin' not in self.caller['roles']:
56             if self.caller['person_id'] in slice['person_ids']:
57                 pass
58             elif 'pi' not in self.caller['roles']:
59                 raise PLCPermissionDenied, "Not a member of the specified slice"
60             elif slice['site_id'] not in self.caller['site_ids']:
61                 raise PLCPermissionDenied, "Specified slice not associated with any of your sites"
62
63             if attribute_type['min_role_id'] is not None and \
64                min(self.caller['role_ids']) > attribute_type['min_role_id']:
65                 raise PLCPermissionDenied, "Not allowed to set the specified slice attribute"
66
67         slice_attribute = SliceAttribute(self.api)
68         slice_attribute['slice_id'] = slice['slice_id']
69         slice_attribute['attribute_type_id'] = attribute_type['attribute_type_id']
70         slice_attribute['value'] = value
71
72         # Sliver attribute if node is specified
73         if node_id_or_hostname is not None:
74             nodes = Nodes(self.api, [node_id_or_hostname]).values()
75             if not nodes:
76                 raise PLCInvalidArgument, "No such node"
77             node = nodes[0]
78             
79             if node['node_id'] not in slice['node_ids']:
80                 raise PLCInvalidArgument, "Node not in the specified slice"
81
82             slice_attribute['node_id'] = node['node_id']
83
84         slice_attribute.sync()
85         self.object_ids = [slice_attribute['slice_attribute_id']]
86
87         return slice_attribute['slice_attribute_id']