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: Messages.py,v 1.1 2006/11/03 16:11:42 mlhuang Exp $
   8 #
   9
  10 from PLC.Parameter import Parameter
  11 from PLC.Table import Row, Table
  12
  13 class Message(Row):
  14     """
  15     Representation of a row in the messages table.
  16     """
  17
  18     table_name = 'messages'
  19     primary_key = 'message_id'
  20     fields = {
  21         'message_id': Parameter(str, "Message identifier"),
  22         'template': Parameter(str, "Message template", nullok = True),
  23         'enabled': Parameter(bool, "Message is enabled"),
  24         }
  25
  26 class Messages(Table):
  27     """
  28     Representation of row(s) from the messages table in the database.
  29     """
  30
  31     def __init__(self, api, message_ids, enabled = None):
  32         Table.__init__(self, api, Message)
  33
  34         sql = "SELECT %s from messages WHERE True" % \
  35               ", ".join(Message.fields)
  36
  37         if message_ids:
  38             sql += " AND message_id IN (%s)" %  ", ".join(map(str, message_ids))
  39
  40         if enabled is not None:
  41             sql += " AND enabled IS %s" % enabled
  42
  43         self.selectall(sql)