- change calling convention for Add slightly; if the Add function for
[plcapi.git] / PLC / Methods / AddSlice.py
1 import re
2
3 from PLC.Faults import *
4 from PLC.Method import Method
5 from PLC.Parameter import Parameter, Mixed
6 from PLC.Slices import Slice, Slices
7 from PLC.Auth import PasswordAuth
8 from PLC.Sites import Site, Sites
9
10 can_update = lambda (field, value): field in \
11              ['name', 'instantiation', 'url', 'description', 'max_nodes']
12
13 class AddSlice(Method):
14     """
15     Adds a new slice. Any fields specified in slice_fields are used,
16     otherwise defaults are used.
17
18     Valid slice names are lowercase and begin with the login_base
19     (slice prefix) of a valid site, followed by a single
20     underscore. Thereafter, only letters, numbers, or additional
21     underscores may be used.
22
23     PIs may only add slices associated with their own sites (i.e.,
24     slice prefixes must always be the login_base of one of their
25     sites).
26
27     Returns the new slice_id (> 0) if successful, faults otherwise.
28     """
29
30     roles = ['admin', 'pi']
31
32     slice_fields = dict(filter(can_update, Slice.fields.items()))
33
34     accepts = [
35         PasswordAuth(),
36         slice_fields
37         ]
38
39     returns = Parameter(int, 'New slice_id (> 0) if successful')
40
41     event_type = 'Add'
42     object_type = 'Slice'
43     object_ids = []
44
45     def call(self, auth, slice_fields):
46         slice_fields = dict(filter(can_update, slice_fields.items()))
47
48         # 1. Lowercase.
49         # 2. Begins with login_base (only letters).
50         # 3. Then single underscore after login_base.
51         # 4. Then letters, numbers, or underscores.
52         name = slice_fields['name']
53         good_name = r'^[a-z]+_[a-z0-9_]+$'
54         if not name or \
55            not re.match(good_name, name):
56             raise PLCInvalidArgument, "Invalid slice name"
57
58         # Get associated site details
59         login_base = name.split("_")[0]
60         sites = Sites(self.api, [login_base]).values()
61         if not sites:
62             raise PLCInvalidArgument, "Invalid slice prefix"
63         site = sites[0]
64
65         if 'admin' not in self.caller['roles']:
66             if site['site_id'] not in self.caller['site_ids']:
67                 raise PLCPermissionDenied, "Slice prefix must be the same as the login_base of one of your sites"
68
69         if len(site['slice_ids']) >= site['max_slices']:
70             raise PLCInvalidArgument, "Site has reached its maximum allowable slice count"
71
72         slice = Slice(self.api, slice_fields)
73         slice['creator_person_id'] = self.caller['person_id']
74         slice['site_id'] = site['site_id']
75         slice.sync()
76
77         self.object_ids = [slice['slice_id']]
78
79         return slice['slice_id']