1 from types import StringTypes
5 from PLC.Faults import *
6 from PLC.Parameter import Parameter
7 from PLC.Filter import Filter
8 from PLC.Debug import profile
9 from PLC.Table import Row, Table
10 from PLC.SliceInstantiations import SliceInstantiations
11 from PLC.Nodes import Node, Nodes
16 Representation of a row in the slices table. To use, optionally
17 instantiate with a dict of values. Update as you would a
18 dict. Commit to the database with sync().To use, instantiate
19 with a dict of values.
23 primary_key = 'slice_id'
25 'slice_id': Parameter(int, "Slice identifier"),
26 'site_id': Parameter(int, "Identifier of the site to which this slice belongs"),
27 'peer_id': Parameter(int, "Peer at which this slice was created", nullok = True),
28 'name': Parameter(str, "Slice name", max = 32),
29 'instantiation': Parameter(str, "Slice instantiation state"),
30 'url': Parameter(str, "URL further describing this slice", max = 254, nullok = True),
31 'description': Parameter(str, "Slice description", max = 2048, nullok = True),
32 'max_nodes': Parameter(int, "Maximum number of nodes that can be assigned to this slice"),
33 'creator_person_id': Parameter(int, "Identifier of the account that created this slice"),
34 'created': Parameter(int, "Date and time when slice was created, in seconds since UNIX epoch", ro = True),
35 'expires': Parameter(int, "Date and time when slice expires, in seconds since UNIX epoch"),
36 'node_ids': Parameter([int], "List of nodes in this slice", ro = True),
37 'person_ids': Parameter([int], "List of accounts that can use this slice", ro = True),
38 'slice_attribute_ids': Parameter([int], "List of slice attributes", ro = True),
42 foreign_fields = ['instantiation', 'url', 'description',
43 'max_nodes', 'created', 'expires']
44 foreign_xrefs = { 'Node' : { 'field' : 'node_ids' ,
45 'table': 'slice_node' } }
47 def validate_name(self, name):
48 # N.B.: Responsibility of the caller to ensure that login_base
49 # portion of the slice name corresponds to a valid site, if
53 # 2. Begins with login_base (only letters).
54 # 3. Then single underscore after login_base.
55 # 4. Then letters, numbers, or underscores.
56 good_name = r'^[a-z]+_[a-z0-9_]+$'
58 not re.match(good_name, name):
59 raise PLCInvalidArgument, "Invalid slice name"
61 conflicts = Slices(self.api, [name])
62 for slice in conflicts:
63 if 'slice_id' not in self or self['slice_id'] != slice['slice_id']:
64 raise PLCInvalidArgument, "Slice name already in use, %s"%name
68 def validate_instantiation(self, instantiation):
69 instantiations = [row['instantiation'] for row in SliceInstantiations(self.api)]
70 if instantiation not in instantiations:
71 raise PLCInvalidArgument, "No such instantiation state"
75 def validate_expires(self, expires):
76 # N.B.: Responsibility of the caller to ensure that expires is
77 # not too far into the future.
78 if expires < time.time():
79 raise PLCInvalidArgument, "Expiration date must be in the future"
81 return time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(expires))
83 def add_person(self, person, commit = True):
85 Add person to existing slice.
88 assert 'slice_id' in self
89 assert isinstance(person, PLC.Persons.Person)
90 assert 'person_id' in person
92 slice_id = self['slice_id']
93 person_id = person['person_id']
95 if person_id not in self['person_ids']:
96 assert slice_id not in person['slice_ids']
98 self.api.db.do("INSERT INTO slice_person (person_id, slice_id)" \
99 " VALUES(%(person_id)d, %(slice_id)d)",
105 self['person_ids'].append(person_id)
106 person['slice_ids'].append(slice_id)
108 def remove_person(self, person, commit = True):
110 Remove person from existing slice.
113 assert 'slice_id' in self
114 assert isinstance(person, PLC.Persons.Person)
115 assert 'person_id' in person
117 slice_id = self['slice_id']
118 person_id = person['person_id']
120 if person_id in self['person_ids']:
121 assert slice_id in person['slice_ids']
123 self.api.db.do("DELETE FROM slice_person" \
124 " WHERE person_id = %(person_id)d" \
125 " AND slice_id = %(slice_id)d",
131 self['person_ids'].remove(person_id)
132 person['slice_ids'].remove(slice_id)
134 def add_node(self, node, commit = True):
136 Add node to existing slice.
139 assert 'slice_id' in self
140 assert isinstance(node, Node)
141 assert 'node_id' in node
143 slice_id = self['slice_id']
144 node_id = node['node_id']
146 if node_id not in self['node_ids']:
147 assert slice_id not in node['slice_ids']
149 self.api.db.do("INSERT INTO slice_node (node_id, slice_id)" \
150 " VALUES(%(node_id)d, %(slice_id)d)",
156 self['node_ids'].append(node_id)
157 node['slice_ids'].append(slice_id)
159 def remove_node(self, node, commit = True):
161 Remove node from existing slice.
164 assert 'slice_id' in self
165 assert isinstance(node, Node)
166 assert 'node_id' in node
168 slice_id = self['slice_id']
169 node_id = node['node_id']
171 if node_id in self['node_ids']:
172 assert slice_id in node['slice_ids']
174 self.api.db.do("DELETE FROM slice_node" \
175 " WHERE node_id = %(node_id)d" \
176 " AND slice_id = %(slice_id)d",
182 self['node_ids'].remove(node_id)
183 node['slice_ids'].remove(slice_id)
186 def sync(self, commit = True):
188 Add or update a slice.
191 # Before a new slice is added, delete expired slices
192 if 'slice_id' not in self:
193 expired = Slices(self.api, expires = -int(time.time()))
194 for slice in expired:
197 Row.sync(self, commit)
199 def delete(self, commit = True):
201 Delete existing slice.
204 assert 'slice_id' in self
206 # Clean up miscellaneous join tables
207 for table in ['slice_node', 'slice_person', 'slice_attribute']:
208 self.api.db.do("DELETE FROM %s" \
209 " WHERE slice_id = %d" % \
210 (table, self['slice_id']), self)
213 self['is_deleted'] = True
218 Representation of row(s) from the slices table in the
222 def __init__(self, api, slice_filter = None, columns = None, expires = int(time.time())):
223 Table.__init__(self, api, Slice, columns)
225 sql = "SELECT %s FROM view_slices WHERE is_deleted IS False" % \
226 ", ".join(self.columns)
228 if expires is not None:
230 sql += " AND expires > %(expires)d"
233 sql += " AND expires < %(expires)d"
235 if slice_filter is not None:
236 if isinstance(slice_filter, (list, tuple, set)):
237 # Separate the list into integers and strings
238 ints = filter(lambda x: isinstance(x, (int, long)), slice_filter)
239 strs = filter(lambda x: isinstance(x, StringTypes), slice_filter)
240 slice_filter = Filter(Slice.fields, {'slice_id': ints, 'name': strs})
241 sql += " AND (%s)" % slice_filter.sql(api, "OR")
242 elif isinstance(slice_filter, dict):
243 slice_filter = Filter(Slice.fields, slice_filter)
244 sql += " AND (%s)" % slice_filter.sql(api, "AND")
246 self.selectall(sql, locals())