PLC/Roles.py

   1 #
   2 # Functions for interacting with the roles table in the database
   3 #
   4 # Mark Huang <mlhuang@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7
   8 from PLC.Faults import *
   9 from PLC.Parameter import Parameter
  10 from PLC.Filter import Filter
  11 from PLC.Table import Row, Table
  12
  13 class Role(Row):
  14     """
  15     Representation of a row in the roles table. To use,
  16     instantiate with a dict of values.
  17     """
  18
  19     table_name = 'roles'
  20     primary_key = 'role_id'
  21     join_tables = ['person_role', 'tag_type_role' ]
  22     fields = {
  23         'role_id': Parameter(int, "Role identifier"),
  24         'name': Parameter(str, "Role", max = 100),
  25         }
  26
  27     def validate_role_id(self, role_id):
  28         # Make sure role does not already exist
  29         conflicts = Roles(self.api, [role_id])
  30         if conflicts:
  31             raise PLCInvalidArgument("Role ID already in use")
  32
  33         return role_id
  34
  35     def validate_name(self, name):
  36         # Make sure name is not blank
  37         if not len(name):
  38             raise PLCInvalidArgument("Role must be specified")
  39
  40         # Make sure role does not already exist
  41         conflicts = Roles(self.api, [name])
  42         if conflicts:
  43             raise PLCInvalidArgument("Role name already in use")
  44
  45         return name
  46
  47 class Roles(Table):
  48     """
  49     Representation of the roles table in the database.
  50     """
  51
  52     def __init__(self, api, role_filter = None):
  53         Table.__init__(self, api, Role)
  54
  55         sql = "SELECT %s FROM roles WHERE True" % \
  56               ", ".join(Role.fields)
  57
  58         if role_filter is not None:
  59             if isinstance(role_filter, (list, tuple, set)):
  60                 # Separate the list into integers and strings
  61                 ints = [x for x in role_filter if isinstance(x, int)]
  62                 strs = [x for x in role_filter if isinstance(x, str)]
  63                 role_filter = Filter(Role.fields, {'role_id': ints, 'name': strs})
  64                 sql += " AND (%s) %s" % role_filter.sql(api, "OR")
  65             elif isinstance(role_filter, dict):
  66                 role_filter = Filter(Role.fields, role_filter)
  67                 sql += " AND (%s) %s" % role_filter.sql(api, "AND")
  68             elif isinstance(role_filter, int):
  69                 role_filter = Filter(Role.fields, {'role_id': role_filter})
  70                 sql += " AND (%s) %s" % role_filter.sql(api, "AND")
  71             elif isinstance(role_filter, str):
  72                 role_filter = Filter(Role.fields, {'name': role_filter})
  73                 sql += " AND (%s) %s" % role_filter.sql(api, "AND")
  74             else:
  75                 raise PLCInvalidArgument("Wrong role filter %r"%role_filter)
  76
  77         self.selectall(sql)