PLC/Table.py

   1 from types import StringTypes
   2 import time
   3 import calendar
   4
   5 from PLC.Faults import *
   6 from PLC.Parameter import Parameter
   7
   8 class Row(dict):
   9     """
  10     Representation of a row in a database table. To use, optionally
  11     instantiate with a dict of values. Update as you would a
  12     dict. Commit to the database with sync().
  13     """
  14
  15     # Set this to the name of the table that stores the row.
  16     table_name = None
  17
  18     # Set this to the name of the primary key of the table. It is
  19     # assumed that the this key is a sequence if it is not set when
  20     # sync() is called.
  21     primary_key = None
  22
  23     # Set this to the names of tables that reference this table's
  24     # primary key.
  25     join_tables = []
  26
  27     # Set this to a dict of the valid fields of this object and their
  28     # types. Not all fields (e.g., joined fields) may be updated via
  29     # sync().
  30     fields = {}
  31
  32     def __init__(self, api, fields = {}):
  33         dict.__init__(self, fields)
  34         self.api = api
  35
  36     def validate(self):
  37         """
  38         Validates values. Will validate a value with a custom function
  39         if a function named 'validate_[key]' exists.
  40         """
  41
  42         # Warn about mandatory fields
  43         mandatory_fields = self.api.db.fields(self.table_name, notnull = True, hasdef = False)
  44         for field in mandatory_fields:
  45             if not self.has_key(field) or self[field] is None:
  46                 raise PLCInvalidArgument, field + " must be specified and cannot be unset in class %s"%self.__class__.__name__
  47
  48         # Validate values before committing
  49         for key, value in self.iteritems():
  50             if value is not None and hasattr(self, 'validate_' + key):
  51                 validate = getattr(self, 'validate_' + key)
  52                 self[key] = validate(value)
  53
  54     time_format = "%Y-%m-%d %H:%M:%S"
  55     def validate_timestamp (self, timestamp, check_future=False):
  56         # in case we try to sync the same object twice
  57         if isinstance(timestamp, StringTypes):
  58             # calendar.timegm is the inverse of time.gmtime, in that it computes in UTC
  59             # surprisingly enough, no other method in the time module behaves this way
  60             # this method is documented in the time module's documentation
  61             timestamp = calendar.timegm (time.strptime (timestamp,Row.time_format))
  62         human = time.strftime (Row.time_format, time.gmtime(timestamp))
  63         if check_future and (timestamp < time.time()):
  64             raise PLCInvalidArgument, "%s: date must be in the future"%human
  65         return human
  66
  67     @classmethod
  68     def add_object(self, classobj, join_table, columns = None):
  69         """
  70         Returns a function that can be used to associate this object
  71         with another.
  72         """
  73
  74         def add(self, obj, columns = None, commit = True):
  75             """
  76             Associate with the specified object.
  77             """
  78
  79             # Various sanity checks
  80             assert isinstance(self, Row)
  81             assert self.primary_key in self
  82             assert join_table in self.join_tables
  83             assert isinstance(obj, classobj)
  84             assert isinstance(obj, Row)
  85             assert obj.primary_key in obj
  86             assert join_table in obj.join_tables
  87
  88             # By default, just insert the primary keys of each object
  89             # into the join table.
  90             if columns is None:
  91                 columns = {self.primary_key: self[self.primary_key],
  92                            obj.primary_key: obj[obj.primary_key]}
  93
  94             params = []
  95             for name, value in columns.iteritems():
  96                 params.append(self.api.db.param(name, value))
  97
  98             self.api.db.do("INSERT INTO %s (%s) VALUES(%s)" % \
  99                            (join_table, ", ".join(columns), ", ".join(params)),
 100                            columns)
 101
 102             if commit:
 103                 self.api.db.commit()
 104
 105         return add
 106
 107     @classmethod
 108     def remove_object(self, classobj, join_table):
 109         """
 110         Returns a function that can be used to disassociate this
 111         object with another.
 112         """
 113
 114         def remove(self, obj, commit = True):
 115             """
 116             Disassociate from the specified object.
 117             """
 118
 119             assert isinstance(self, Row)
 120             assert self.primary_key in self
 121             assert join_table in self.join_tables
 122             assert isinstance(obj, classobj)
 123             assert isinstance(obj, Row)
 124             assert obj.primary_key in obj
 125             assert join_table in obj.join_tables
 126
 127             self_id = self[self.primary_key]
 128             obj_id = obj[obj.primary_key]
 129
 130             self.api.db.do("DELETE FROM %s WHERE %s = %s AND %s = %s" % \
 131                            (join_table,
 132                             self.primary_key, self.api.db.param('self_id', self_id),
 133                             obj.primary_key, self.api.db.param('obj_id', obj_id)),
 134                            locals())
 135
 136             if commit:
 137                 self.api.db.commit()
 138
 139         return remove
 140
 141     def db_fields(self, obj = None):
 142         """
 143         Return only those fields that can be set or updated directly
 144         (i.e., those fields that are in the primary table (table_name)
 145         for this object, and are not marked as a read-only Parameter.
 146         """
 147
 148         if obj is None:
 149             obj = self
 150
 151         db_fields = self.api.db.fields(self.table_name)
 152         return dict(filter(lambda (key, value): \
 153                            key in db_fields and \
 154                            (key not in self.fields or \
 155                             not isinstance(self.fields[key], Parameter) or \
 156                             not self.fields[key].ro),
 157                            obj.items()))
 158
 159     def __eq__(self, y):
 160         """
 161         Compare two objects.
 162         """
 163
 164         # Filter out fields that cannot be set or updated directly
 165         # (and thus would not affect equality for the purposes of
 166         # deciding if we should sync() or not).
 167         x = self.db_fields()
 168         y = self.db_fields(y)
 169         return dict.__eq__(x, y)
 170
 171     def sync(self, commit = True, insert = None):
 172         """
 173         Flush changes back to the database.
 174         """
 175
 176         # Validate all specified fields
 177         self.validate()
 178
 179         # Filter out fields that cannot be set or updated directly
 180         db_fields = self.db_fields()
 181
 182         # Parameterize for safety
 183         keys = db_fields.keys()
 184         values = [self.api.db.param(key, value) for (key, value) in db_fields.items()]
 185
 186         # If the primary key (usually an auto-incrementing serial
 187         # identifier) has not been specified, or the primary key is the
 188         # only field in the table, or insert has been forced.
 189         if not self.has_key(self.primary_key) or \
 190            keys == [self.primary_key] or \
 191            insert is True:
 192             # Insert new row
 193             sql = "INSERT INTO %s (%s) VALUES (%s)" % \
 194                   (self.table_name, ", ".join(keys), ", ".join(values))
 195         else:
 196             # Update existing row
 197             columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
 198             sql = "UPDATE %s SET " % self.table_name + \
 199                   ", ".join(columns) + \
 200                   " WHERE %s = %s" % \
 201                   (self.primary_key,
 202                    self.api.db.param(self.primary_key, self[self.primary_key]))
 203
 204         self.api.db.do(sql, db_fields)
 205
 206         if not self.has_key(self.primary_key):
 207             self[self.primary_key] = self.api.db.last_insert_id(self.table_name, self.primary_key)
 208
 209         if commit:
 210             self.api.db.commit()
 211
 212     def delete(self, commit = True):
 213         """
 214         Delete row from its primary table, and from any tables that
 215         reference it.
 216         """
 217
 218         assert self.primary_key in self
 219
 220         for table in self.join_tables + [self.table_name]:
 221             if isinstance(table, tuple):
 222                 key = table[1]
 223                 table = table[0]
 224             else:
 225                 key = self.primary_key
 226
 227             sql = "DELETE FROM %s WHERE %s = %s" % \
 228                   (table, key,
 229                    self.api.db.param(self.primary_key, self[self.primary_key]))
 230
 231             self.api.db.do(sql, self)
 232
 233         if commit:
 234             self.api.db.commit()
 235
 236 class Table(list):
 237     """
 238     Representation of row(s) in a database table.
 239     """
 240
 241     def __init__(self, api, classobj, columns = None):
 242         self.api = api
 243         self.classobj = classobj
 244         self.rows = {}
 245
 246         if columns is None:
 247             columns = classobj.fields
 248         else:
 249             columns = filter(lambda x: x in classobj.fields, columns)
 250             if not columns:
 251                 raise PLCInvalidArgument, "No valid return fields specified"
 252
 253         self.columns = columns
 254
 255     def sync(self, commit = True):
 256         """
 257         Flush changes back to the database.
 258         """
 259
 260         for row in self:
 261             row.sync(commit)
 262
 263     def selectall(self, sql, params = None):
 264         """
 265         Given a list of rows from the database, fill ourselves with
 266         Row objects.
 267         """
 268
 269         for row in self.api.db.selectall(sql, params):
 270             obj = self.classobj(self.api, row)
 271             self.append(obj)
 272
 273     def dict(self, key_field = None):
 274         """
 275         Return ourself as a dict keyed on key_field.
 276         """
 277
 278         if key_field is None:
 279             key_field = self.classobj.primary_key
 280
 281         return dict([(obj[key_field], obj) for obj in self])