- use base class __init__() and delete() implementations
[plcapi.git] / PLC / Slices.py
index 2223c20..94b50e9 100644 (file)
@@ -1,11 +1,13 @@
 from types import StringTypes
 import time
+import re
 
 from PLC.Faults import *
 from PLC.Parameter import Parameter
 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):
@@ -16,34 +18,41 @@ class Slice(Row):
     with a dict of values.
     """
 
+    table_name = 'slices'
+    primary_key = 'slice_id'
     fields = {
         'slice_id': Parameter(int, "Slice type"),
         'site_id': Parameter(int, "Identifier of the site to which this slice belongs"),
         'name': Parameter(str, "Slice name", max = 32),
-        'state': Parameter(str, "Slice state"),
+        'instantiation': Parameter(str, "Slice instantiation state"),
         'url': Parameter(str, "URL further describing this slice", max = 254),
         'description': Parameter(str, "Slice description", max = 2048),
         '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"),
-        'is_deleted': Parameter(bool, "Has been deleted"),
-        '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),
         }
 
-    def __init__(self, api, fields):
-        Row.__init__(self, fields)
-        self.api = api
-
     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 not slice['is_deleted'] and ('slice_id' not in self or self['slice_id'] != slice_id):
+            if 'slice_id' not in self or self['slice_id'] != slice_id:
                 raise PLCInvalidArgument, "Slice name already in use"
 
         return name
@@ -53,7 +62,7 @@ class Slice(Row):
         if instantiation not in instantiations:
             raise PLCInvalidArgument, "No such instantiation state"
 
-        return state
+        return instantiation
 
     def validate_expires(self, expires):
         # N.B.: Responsibility of the caller to ensure that expires is
@@ -70,58 +79,107 @@ class Slice(Row):
 
         return person_id
 
-    def sync(self, commit = True):
+    def add_person(self, person, commit = True):
         """
-        Flush changes back to the database.
+        Add person to existing slice.
         """
 
-        try:
-            if not self['name']:
-                raise KeyError
-        except KeyError:
-            raise PLCInvalidArgument, "Slice name must be specified"
-
-        self.validate()
-
-        # Fetch a new slice_id if necessary
-        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()
+        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 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):
+        """
+        Add node to existing slice.
+        """
+
+        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['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
+
+        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 delete(self, commit = True):
         """
@@ -146,13 +204,11 @@ class Slices(Table):
     database.
     """
 
-    def __init__(self, api, slice_id_or_name_list = None, deleted = False):
+    def __init__(self, api, slice_id_or_name_list = None):
         self.api = api
 
-        sql = "SELECT * FROM view_slices WHERE TRUE"
-
-        if deleted is not None:
-            sql += " AND view_slices.is_deleted IS %(deleted)s"
+        sql = "SELECT %s FROM view_slices WHERE is_deleted IS False" % \
+              ", ".join(Slice.fields)
 
         if slice_id_or_name_list:
             # Separate the list into integers and strings
@@ -167,11 +223,11 @@ class Slices(Table):
                 sql += " OR name IN (%s)" % ", ".join(api.db.quote(names))
             sql += ")"
 
-        rows = self.api.db.selectall(sql, locals())
+        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':
+            for aggregate in 'node_ids', 'person_ids', 'slice_attribute_ids':
                 if not slice.has_key(aggregate) or slice[aggregate] is None:
                     slice[aggregate] = []
                 else: