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 'name': Parameter(str, "Slice name", max = 32),
28 'instantiation': Parameter(str, "Slice instantiation state"),
29 'url': Parameter(str, "URL further describing this slice", max = 254, nullok = True),
30 'description': Parameter(str, "Slice description", max = 2048, nullok = True),
31 'max_nodes': Parameter(int, "Maximum number of nodes that can be assigned to this slice"),
32 'creator_person_id': Parameter(int, "Identifier of the account that created this slice"),
33 'created': Parameter(int, "Date and time when slice was created, in seconds since UNIX epoch", ro = True),
34 'expires': Parameter(int, "Date and time when slice expires, in seconds since UNIX epoch"),
35 'node_ids': Parameter([int], "List of nodes in this slice", ro = True),
36 'person_ids': Parameter([int], "List of accounts that can use this slice", ro = True),
37 'slice_attribute_ids': Parameter([int], "List of slice attributes", ro = True),
38 'peer_id': Parameter(int, "Peer at which this slice was created", nullok = True),
42 foreign_fields = ['instantiation', 'url', 'description', 'max_nodes', 'created', 'expires']
44 {'field': 'node_ids' , 'class': 'Node', 'table': 'slice_node' },
45 {'field': 'person_ids', 'class': 'Person', 'table': 'slice_person'},
46 {'field': 'creator_person_id', 'class': 'Person', 'table': 'unused-on-direct-refs'},
47 {'field': 'site_id', 'class': 'Site', 'table': 'unused-on-direct-refs'},
50 def validate_name(self, name):
51 # N.B.: Responsibility of the caller to ensure that login_base
52 # portion of the slice name corresponds to a valid site, if
56 # 2. Begins with login_base (only letters).
57 # 3. Then single underscore after login_base.
58 # 4. Then letters, numbers, or underscores.
59 good_name = r'^[a-z]+_[a-z0-9_]+$'
61 not re.match(good_name, name):
62 raise PLCInvalidArgument, "Invalid slice name"
64 conflicts = Slices(self.api, [name])
65 for slice in conflicts:
66 if 'slice_id' not in self or self['slice_id'] != slice['slice_id']:
67 raise PLCInvalidArgument, "Slice name already in use, %s"%name
71 def validate_instantiation(self, instantiation):
72 instantiations = [row['instantiation'] for row in SliceInstantiations(self.api)]
73 if instantiation not in instantiations:
74 raise PLCInvalidArgument, "No such instantiation state"
78 def validate_expires(self, expires):
79 # N.B.: Responsibility of the caller to ensure that expires is
80 # not too far into the future.
81 if expires < time.time():
82 raise PLCInvalidArgument, "Expiration date must be in the future"
84 return time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(expires))
86 def add_person(self, person, commit = True):
88 Add person to existing slice.
91 assert 'slice_id' in self
92 assert isinstance(person, PLC.Persons.Person)
93 assert 'person_id' in person
95 slice_id = self['slice_id']
96 person_id = person['person_id']
98 if person_id not in self['person_ids']:
99 assert slice_id not in person['slice_ids']
101 self.api.db.do("INSERT INTO slice_person (person_id, slice_id)" \
102 " VALUES(%(person_id)d, %(slice_id)d)",
108 self['person_ids'].append(person_id)
109 person['slice_ids'].append(slice_id)
111 def remove_person(self, person, commit = True):
113 Remove person from existing slice.
116 assert 'slice_id' in self
117 assert isinstance(person, PLC.Persons.Person)
118 assert 'person_id' in person
120 slice_id = self['slice_id']
121 person_id = person['person_id']
123 if person_id in self['person_ids']:
124 assert slice_id in person['slice_ids']
126 self.api.db.do("DELETE FROM slice_person" \
127 " WHERE person_id = %(person_id)d" \
128 " AND slice_id = %(slice_id)d",
134 self['person_ids'].remove(person_id)
135 person['slice_ids'].remove(slice_id)
137 def add_node(self, node, commit = True):
139 Add node to existing slice.
142 assert 'slice_id' in self
143 assert isinstance(node, Node)
144 assert 'node_id' in node
146 slice_id = self['slice_id']
147 node_id = node['node_id']
149 if node_id not in self['node_ids']:
150 assert slice_id not in node['slice_ids']
152 self.api.db.do("INSERT INTO slice_node (node_id, slice_id)" \
153 " VALUES(%(node_id)d, %(slice_id)d)",
159 self['node_ids'].append(node_id)
160 node['slice_ids'].append(slice_id)
162 def remove_node(self, node, commit = True):
164 Remove node from existing slice.
167 assert 'slice_id' in self
168 assert isinstance(node, Node)
169 assert 'node_id' in node
171 slice_id = self['slice_id']
172 node_id = node['node_id']
174 if node_id in self['node_ids']:
175 assert slice_id in node['slice_ids']
177 self.api.db.do("DELETE FROM slice_node" \
178 " WHERE node_id = %(node_id)d" \
179 " AND slice_id = %(slice_id)d",
185 self['node_ids'].remove(node_id)
186 node['slice_ids'].remove(slice_id)
189 def sync(self, commit = True):
191 Add or update a slice.
194 # Before a new slice is added, delete expired slices
195 if 'slice_id' not in self:
196 expired = Slices(self.api, expires = -int(time.time()))
197 for slice in expired:
200 Row.sync(self, commit)
202 def delete(self, commit = True):
204 Delete existing slice.
207 assert 'slice_id' in self
209 # Clean up miscellaneous join tables
210 for table in ['slice_node', 'slice_person', 'slice_attribute']:
211 self.api.db.do("DELETE FROM %s" \
212 " WHERE slice_id = %d" % \
213 (table, self['slice_id']), self)
216 self['is_deleted'] = True
221 Representation of row(s) from the slices table in the
225 def __init__(self, api, slice_filter = None, columns = None, expires = int(time.time())):
226 Table.__init__(self, api, Slice, columns)
228 sql = "SELECT %s FROM view_slices WHERE is_deleted IS False" % \
229 ", ".join(self.columns)
231 if expires is not None:
233 sql += " AND expires > %(expires)d"
236 sql += " AND expires < %(expires)d"
238 if slice_filter is not None:
239 if isinstance(slice_filter, (list, tuple, set)):
240 # Separate the list into integers and strings
241 ints = filter(lambda x: isinstance(x, (int, long)), slice_filter)
242 strs = filter(lambda x: isinstance(x, StringTypes), slice_filter)
243 slice_filter = Filter(Slice.fields, {'slice_id': ints, 'name': strs})
244 sql += " AND (%s)" % slice_filter.sql(api, "OR")
245 elif isinstance(slice_filter, dict):
246 slice_filter = Filter(Slice.fields, slice_filter)
247 sql += " AND (%s)" % slice_filter.sql(api, "AND")
249 self.selectall(sql, locals())