Slice tags can be managed from AddSlice/UpdateSlice/GetSlices
[plcapi.git] / PLC / Methods / AddSlice.py
1 # $Id$
2 import re
3
4 from PLC.Faults import *
5 from PLC.Auth import Auth
6 from PLC.Method import Method
7 from PLC.Parameter import Parameter, Mixed
8 from PLC.Table import Row
9
10 from PLC.Slices import Slice, Slices
11 from PLC.Sites import Site, Sites
12 from PLC.TagTypes import TagTypes
13 from PLC.SliceTags import SliceTags
14 from PLC.Methods.AddSliceTag import AddSliceTag
15 from PLC.Methods.UpdateSliceTag import UpdateSliceTag
16
17 can_update = ['name', 'instantiation', 'url', 'description', 'max_nodes']
18
19 class AddSlice(Method):
20     """
21     Adds a new slice. Any fields specified in slice_fields are used,
22     otherwise defaults are used.
23
24     Valid slice names are lowercase and begin with the login_base
25     (slice prefix) of a valid site, followed by a single
26     underscore. Thereafter, only letters, numbers, or additional
27     underscores may be used.
28
29     PIs may only add slices associated with their own sites (i.e.,
30     slice prefixes must always be the login_base of one of their
31     sites).
32
33     Returns the new slice_id (> 0) if successful, faults otherwise.
34     """
35
36     roles = ['admin', 'pi']
37
38     accepted_fields = Row.accepted_fields(can_update, [Slice.fields,Slice.tags])
39
40     accepts = [
41         Auth(),
42         accepted_fields
43         ]
44
45     returns = Parameter(int, 'New slice_id (> 0) if successful')
46
47     def call(self, auth, slice_fields):
48
49         [native,tags,rejected]=Row.split_fields(slice_fields,[Slice.fields,Slice.tags])
50
51         if rejected:
52             raise PLCInvalidArgument, "Cannot add Slice with column(s) %r"%rejected
53
54         # Authenticated function
55         assert self.caller is not None
56
57         # 1. Lowercase.
58         # 2. Begins with login_base (letters or numbers).
59         # 3. Then single underscore after login_base.
60         # 4. Then letters, numbers, or underscores.
61         name = slice_fields['name']
62         good_name = r'^[a-z0-9]+_[a-zA-Z0-9_]+$'
63         if not name or \
64            not re.match(good_name, name):
65             raise PLCInvalidArgument, "Invalid slice name"
66
67         # Get associated site details
68         login_base = name.split("_")[0]
69         sites = Sites(self.api, [login_base])
70         if not sites:
71             raise PLCInvalidArgument, "Invalid slice prefix %s in %s"%(login_base,name)
72         site = sites[0]
73
74         if 'admin' not in self.caller['roles']:
75             if site['site_id'] not in self.caller['site_ids']:
76                 raise PLCPermissionDenied, "Slice prefix %s must match one of your sites' login_base"%login_base
77
78         if len(site['slice_ids']) >= site['max_slices']:
79             raise PLCInvalidArgument, \
80                 "Site %s has reached (%d) its maximum allowable slice count (%d)"%(site['name'],
81                                                                                    len(site['slice_ids']),
82                                                                                    site['max_slices'])
83         if not site['enabled']:
84             raise PLCInvalidArgument, "Site %s is disabled and can cannot create slices" % (site['name'])
85          
86         slice = Slice(self.api, native)
87         slice['creator_person_id'] = self.caller['person_id']
88         slice['site_id'] = site['site_id']
89         slice.sync()
90
91         for (tagname,value) in tags.iteritems():
92             # the tagtype instance is assumed to exist, just check that
93             if not TagTypes(self.api,{'tagname':tagname}):
94                 raise PLCInvalidArgument,"No such TagType %s"%tagname
95             slice_tags=SliceTags(self.api,{'tagname':tagname,'slice_id':slice['slice_id']})
96             if not slice_tags:
97                 AddSliceTag(self.api).__call__(auth,slice['slice_id'],tagname,value)
98             else:
99                 UpdateSliceTag(self.api).__call__(auth,slice_tags[0]['slice_tag_id'],value)
100
101         self.event_objects = {'Slice': [slice['slice_id']]}
102         self.message = "Slice %d created" % slice['slice_id']
103
104         return slice['slice_id']