PLC/Messages.py

   1 #
   2 # Functions for interacting with the messages table in the database
   3 #
   4 # Tony Mack <tmack@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7 # $Id$
   8 # $URL$
   9 #
  10
  11 from PLC.Parameter import Parameter
  12 from PLC.Table import Row, Table
  13 from PLC.Filter import Filter
  14
  15 class Message(Row):
  16     """
  17     Representation of a row in the messages table.
  18     """
  19
  20     table_name = 'messages'
  21     primary_key = 'message_id'
  22     fields = {
  23         'message_id': Parameter(str, "Message identifier"),
  24         'subject': Parameter(str, "Message summary", nullok = True),
  25         'template': Parameter(str, "Message template", nullok = True),
  26         'enabled': Parameter(bool, "Message is enabled"),
  27         }
  28
  29 class Messages(Table):
  30     """
  31     Representation of row(s) from the messages table in the database.
  32     """
  33
  34     def __init__(self, api, message_filter = None, columns = None, enabled = None):
  35         Table.__init__(self, api, Message, columns)
  36
  37         sql = "SELECT %s from messages WHERE True" % \
  38               ", ".join(self.columns)
  39
  40         if enabled is not None:
  41             sql += " AND enabled IS %s" % enabled
  42
  43         if message_filter is not None:
  44             if isinstance(message_filter, (list, tuple, set, int, long)):
  45                 message_filter = Filter(Message.fields, {'message_id': message_filter})
  46                 sql += " AND (%s) %s" % message_filter.sql(api, "OR")
  47             elif isinstance(message_filter, dict):
  48                 message_filter = Filter(Message.fields, message_filter)
  49                 sql += " AND (%s) %s" % message_filter.sql(api, "AND")
  50             else:
  51                 raise PLCInvalidArgument, "Wrong message filter %r"%message_filter
  52
  53         self.selectall(sql)