fix roles interface
[plcapi.git] / PLC / Roles.py
index c035fe6..40c3277 100644 (file)
@@ -4,22 +4,92 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2006 The Trustees of Princeton University
 #
-# $Id: Roles.py,v 1.1 2006/09/06 15:36:07 mlhuang Exp $
+# $Id: Roles.py,v 1.2 2006/10/06 18:19:41 mlhuang Exp $
 #
 
-class Roles(dict):
+from types import StringTypes
+from PLC.Faults import *
+from PLC.Parameter import Parameter
+from PLC.Table import Row, Table
+
+class Role(Row):
+    """
+    Representation of a row in the roles table. To use,
+    instantiate with a dict of values.
+    """
+
+    table_name = 'roles'
+    primary_key = 'role_id'
+    fields = {
+        'role_id': Parameter(int, "Role identifier"),
+        'name': Parameter(str, "Role", max = 100),
+        }
+
+    def __init__(self, api, fields = {}):
+        Row.__init__(self, fields)
+        self.api = api
+
+    def validate_role_id(self, role_id):
+       # Make sure role does not already exist
+       conflicts = Roles(self.api, [role_id])
+        if conflicts:
+            raise PLCInvalidArgument, "Role ID already in use"
+
+        return role_id
+
+    def validate_name(self, name):
+       # Remove leading and trailing spaces
+       name = name.strip()
+
+       # Make sure name is not blank after we removed the spaces
+        if not name:
+            raise PLCInvalidArgument, "Role must be specified"
+       
+       # Make sure role does not already exist
+       conflicts = Roles(self.api, [name])
+        if conflicts:
+            raise PLCInvalidArgument, "Role name already in use"
+
+       return name
+
+    def delete(self, commit = True):
+        assert 'role_id' in self
+
+        # Clean up miscellaneous join tables
+        for table in ['person_role', 'roles']:
+            self.api.db.do("DELETE FROM %s" \
+                           " WHERE role_id = %d" % \
+                           (table, self['role_id']), self)
+
+        self.api.db.do("DELETE FROM attributes WHERE min_role_id = %d" % \
+                       self['role_id'])
+
+        if commit:
+            self.api.db.commit()
+        
+class Roles(Table):
     """
     Representation of the roles table in the database.
     """
 
-    # Role IDs equal to or lower than this number are for use by real
-    # accounts. Other role IDs are used internally.
-    role_max = 500
+    def __init__(self, api, role_id_or_name_list = None):
+        sql = "SELECT %s FROM roles" % \
+              ", ".join(Role.fields)
+        
+        if role_id_or_name_list:
+            # Separate the list into integers and strings
+            role_ids = filter(lambda role_id: isinstance(role_id, (int, long)),
+                                   role_id_or_name_list)
+            names = filter(lambda name: isinstance(name, StringTypes),
+                           role_id_or_name_list)
+            sql += " WHERE (False"
+            if role_ids:
+                sql += " OR role_id IN (%s)" % ", ".join(map(str, role_ids))
+            if names:
+                sql += " OR name IN (%s)" % ", ".join(api.db.quote(names))
+            sql += ")"
 
-    def __init__(self, api):
-        sql = "SELECT * FROM roles" \
-              " WHERE role_id <= %d" % self.role_max
+        rows = api.db.selectall(sql)
 
-        for row in api.db.selectall(sql):
-            self[row['role_id']] = row['name']
-            self[row['name']] = row['role_id']
+        for row in rows:
+            self[row['role_id']] = Role(api, row)