from types import StringTypes
import time
+import re
from PLC.Faults import *
from PLC.Parameter import Parameter
+from PLC.Filter import Filter
from PLC.Debug import profile
from PLC.Table import Row, Table
from PLC.SliceInstantiations import SliceInstantiations
+from PLC.Nodes import Node, Nodes
import PLC.Persons
class Slice(Row):
with a dict of values.
"""
+ table_name = 'slices'
+ primary_key = 'slice_id'
fields = {
- 'slice_id': Parameter(int, "Slice type"),
+ 'slice_id': Parameter(int, "Slice identifier"),
'site_id': Parameter(int, "Identifier of the site to which this slice belongs"),
'name': Parameter(str, "Slice name", max = 32),
'instantiation': Parameter(str, "Slice instantiation state"),
- 'url': Parameter(str, "URL further describing this slice", max = 254),
- 'description': Parameter(str, "Slice description", max = 2048),
+ 'url': Parameter(str, "URL further describing this slice", max = 254, nullok = True),
+ 'description': Parameter(str, "Slice description", max = 2048, nullok = True),
'max_nodes': Parameter(int, "Maximum number of nodes that can be assigned to this slice"),
'creator_person_id': Parameter(int, "Identifier of the account that created this slice"),
- 'created': Parameter(int, "Date and time when slice was created, in seconds since UNIX epoch"),
+ 'created': Parameter(int, "Date and time when slice was created, in seconds since UNIX epoch", ro = True),
'expires': Parameter(int, "Date and time when slice expires, in seconds since UNIX epoch"),
- 'node_ids': Parameter([int], "List of nodes in this slice"),
- 'person_ids': Parameter([int], "List of accounts that can use this slice"),
- 'attribute_ids': Parameter([int], "List of slice attributes"),
+ 'node_ids': Parameter([int], "List of nodes in this slice", ro = True),
+ 'person_ids': Parameter([int], "List of accounts that can use this slice", ro = True),
+ 'slice_attribute_ids': Parameter([int], "List of slice attributes", ro = True),
+ 'peer_id': Parameter(int, "Peer at which this slice was created", nullok = True),
}
-
- def __init__(self, api, fields):
- Row.__init__(self, fields)
- self.api = api
+ # for Cache
+ class_key = 'name'
+ foreign_fields = ['instantiation', 'url', 'description', 'max_nodes', 'expires']
+ foreign_xrefs = [
+ {'field': 'node_ids' , 'class': 'Node', 'table': 'slice_node' },
+ {'field': 'person_ids', 'class': 'Person', 'table': 'slice_person'},
+ {'field': 'creator_person_id', 'class': 'Person', 'table': 'unused-on-direct-refs'},
+ {'field': 'site_id', 'class': 'Site', 'table': 'unused-on-direct-refs'},
+ ]
+ # forget about this one, it is read-only anyway
+ # handling it causes Cache to re-sync all over again
+ # 'created'
def validate_name(self, name):
# N.B.: Responsibility of the caller to ensure that login_base
# portion of the slice name corresponds to a valid site, if
# desired.
+
+ # 1. Lowercase.
+ # 2. Begins with login_base (only letters).
+ # 3. Then single underscore after login_base.
+ # 4. Then letters, numbers, or underscores.
+ good_name = r'^[a-z]+_[a-z0-9_]+$'
+ if not name or \
+ not re.match(good_name, name):
+ raise PLCInvalidArgument, "Invalid slice name"
+
conflicts = Slices(self.api, [name])
- for slice_id, slice in conflicts.iteritems():
- if 'slice_id' not in self or self['slice_id'] != slice_id:
- raise PLCInvalidArgument, "Slice name already in use"
+ for slice in conflicts:
+ if 'slice_id' not in self or self['slice_id'] != slice['slice_id']:
+ raise PLCInvalidArgument, "Slice name already in use, %s"%name
return name
def validate_instantiation(self, instantiation):
- instantiations = SliceInstantiations(self.api)
+ instantiations = [row['instantiation'] for row in SliceInstantiations(self.api)]
if instantiation not in instantiations:
raise PLCInvalidArgument, "No such instantiation state"
- return state
+ return instantiation
+
+ # timestamps
+ def validate_created (self, timestamp):
+ return self.validate_timestamp (timestamp)
def validate_expires(self, expires):
# N.B.: Responsibility of the caller to ensure that expires is
# not too far into the future.
- if expires < time.time():
- raise PLCInvalidArgument, "Expiration date must be in the future"
+ return self.validate_timestamp (expires,True)
- return time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(expires))
+ def add_person(self, person, commit = True):
+ """
+ Add person to existing slice.
+ """
- def validate_creator_person_id(self, person_id):
- persons = PLC.Persons.Persons(self.api, [person_id])
- if not persons:
- raise PLCInvalidArgument, "Invalid creator"
+ assert 'slice_id' in self
+ assert isinstance(person, PLC.Persons.Person)
+ assert 'person_id' in person
- return person_id
+ slice_id = self['slice_id']
+ person_id = person['person_id']
- def sync(self, commit = True):
+ if person_id not in self['person_ids']:
+ assert slice_id not in person['slice_ids']
+
+ self.api.db.do("INSERT INTO slice_person (person_id, slice_id)" \
+ " VALUES(%(person_id)d, %(slice_id)d)",
+ locals())
+
+ if commit:
+ self.api.db.commit()
+
+ self['person_ids'].append(person_id)
+ person['slice_ids'].append(slice_id)
+
+ def remove_person(self, person, commit = True):
+ """
+ Remove person from existing slice.
+ """
+
+ assert 'slice_id' in self
+ assert isinstance(person, PLC.Persons.Person)
+ assert 'person_id' in person
+
+ slice_id = self['slice_id']
+ person_id = person['person_id']
+
+ if person_id in self['person_ids']:
+ assert slice_id in person['slice_ids']
+
+ self.api.db.do("DELETE FROM slice_person" \
+ " WHERE person_id = %(person_id)d" \
+ " AND slice_id = %(slice_id)d",
+ locals())
+
+ if commit:
+ self.api.db.commit()
+
+ self['person_ids'].remove(person_id)
+ person['slice_ids'].remove(slice_id)
+
+ def add_node(self, node, commit = True):
"""
- Flush changes back to the database.
+ Add node to existing slice.
"""
- try:
- if not self['name']:
- raise KeyError
- except KeyError:
- raise PLCInvalidArgument, "Slice name must be specified"
+ assert 'slice_id' in self
+ assert isinstance(node, Node)
+ assert 'node_id' in node
+
+ slice_id = self['slice_id']
+ node_id = node['node_id']
+
+ if node_id not in self['node_ids']:
+ assert slice_id not in node['slice_ids']
+
+ self.api.db.do("INSERT INTO slice_node (node_id, slice_id)" \
+ " VALUES(%(node_id)d, %(slice_id)d)",
+ locals())
+
+ if commit:
+ self.api.db.commit()
- self.validate()
+ self['node_ids'].append(node_id)
+ node['slice_ids'].append(slice_id)
+
+ def remove_node(self, node, commit = True):
+ """
+ Remove node from existing slice.
+ """
+
+ assert 'slice_id' in self
+ assert isinstance(node, Node)
+ assert 'node_id' in node
- # Fetch a new slice_id if necessary
+ slice_id = self['slice_id']
+ node_id = node['node_id']
+
+ if node_id in self['node_ids']:
+ assert slice_id in node['slice_ids']
+
+ self.api.db.do("DELETE FROM slice_node" \
+ " WHERE node_id = %(node_id)d" \
+ " AND slice_id = %(slice_id)d",
+ locals())
+
+ if commit:
+ self.api.db.commit()
+
+ self['node_ids'].remove(node_id)
+ node['slice_ids'].remove(slice_id)
+
+ ##########
+ def sync(self, commit = True):
+ """
+ Add or update a slice.
+ """
+
+ # Before a new slice is added, delete expired slices
if 'slice_id' not in self:
- # N.B.: Responsibility of the caller to ensure that
- # max_slices is not exceeded.
- rows = self.api.db.selectall("SELECT NEXTVAL('slices_slice_id_seq') AS slice_id")
- if not rows:
- raise PLCDBError, "Unable to fetch new slice_id"
- self['slice_id'] = rows[0]['slice_id']
- insert = True
- else:
- insert = False
-
- # Filter out fields that cannot be set or updated directly
- slices_fields = self.api.db.fields('slices')
- fields = dict(filter(lambda (key, value): key in slices_fields,
- self.items()))
- for ro_field in 'created',:
- if ro_field in fields:
- del fields[ro_field]
-
- # Parameterize for safety
- keys = fields.keys()
- values = [self.api.db.param(key, value) for (key, value) in fields.items()]
-
- if insert:
- # Insert new row in slices table
- sql = "INSERT INTO slices (%s) VALUES (%s)" % \
- (", ".join(keys), ", ".join(values))
- else:
- # Update existing row in slices table
- columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
- sql = "UPDATE slices SET " + \
- ", ".join(columns) + \
- " WHERE slice_id = %(slice_id)d"
-
- self.api.db.do(sql, fields)
-
- if commit:
- self.api.db.commit()
+ expired = Slices(self.api, expires = -int(time.time()))
+ for slice in expired:
+ slice.delete(commit)
+
+ Row.sync(self, commit)
def delete(self, commit = True):
"""
database.
"""
- def __init__(self, api, slice_id_or_name_list = None, fields = Slice.fields):
- self.api = api
+ def __init__(self, api, slice_filter = None, columns = None, expires = int(time.time())):
+ Table.__init__(self, api, Slice, columns)
sql = "SELECT %s FROM view_slices WHERE is_deleted IS False" % \
- ", ".join(fields)
-
- if slice_id_or_name_list:
- # Separate the list into integers and strings
- slice_ids = filter(lambda slice_id: isinstance(slice_id, (int, long)),
- slice_id_or_name_list)
- names = filter(lambda name: isinstance(name, StringTypes),
- slice_id_or_name_list)
- sql += " AND (False"
- if slice_ids:
- sql += " OR slice_id IN (%s)" % ", ".join(map(str, slice_ids))
- if names:
- sql += " OR name IN (%s)" % ", ".join(api.db.quote(names))
- sql += ")"
-
- rows = self.api.db.selectall(sql)
-
- for row in rows:
- self[row['slice_id']] = slice = Slice(api, row)
- for aggregate in 'person_ids', 'slice_ids', 'attribute_ids':
- if not slice.has_key(aggregate) or slice[aggregate] is None:
- slice[aggregate] = []
- else:
- slice[aggregate] = map(int, slice[aggregate].split(','))
+ ", ".join(self.columns)
+
+ if expires is not None:
+ if expires >= 0:
+ sql += " AND expires > %(expires)d"
+ else:
+ expires = -expires
+ sql += " AND expires < %(expires)d"
+
+ if slice_filter is not None:
+ if isinstance(slice_filter, (list, tuple, set)):
+ # Separate the list into integers and strings
+ ints = filter(lambda x: isinstance(x, (int, long)), slice_filter)
+ strs = filter(lambda x: isinstance(x, StringTypes), slice_filter)
+ slice_filter = Filter(Slice.fields, {'slice_id': ints, 'name': strs})
+ sql += " AND (%s)" % slice_filter.sql(api, "OR")
+ elif isinstance(slice_filter, dict):
+ slice_filter = Filter(Slice.fields, slice_filter)
+ sql += " AND (%s)" % slice_filter.sql(api, "AND")
+
+ self.selectall(sql, locals())
git://git.onelab.eu / plcapi.git / blobdiff