sfa/util/table.py

   1 #
   2 # implements support for SFA records stored in db tables
   3 #
   4 # TODO: Use existing PLC database methods? or keep this separate?
   5
   6 from types import StringTypes
   7
   8 from sfa.util.config import Config
   9 from sfa.util.parameter import Parameter
  10 from sfa.util.filter import Filter
  11 from sfa.util.PostgreSQL import PostgreSQL
  12 from sfa.util.record import SfaRecord, AuthorityRecord, NodeRecord, SliceRecord, UserRecord
  13
  14 class SfaTable(list):
  15
  16     SFA_TABLE_PREFIX = "sfa"
  17
  18     def __init__(self, record_filter = None):
  19
  20         # pgsql doesn't like table names with "." in them, to replace it with "$"
  21         self.tablename = SfaTable.SFA_TABLE_PREFIX
  22         self.config = Config()
  23         self.db = PostgreSQL(self.config)
  24
  25         if record_filter:
  26             records = self.find(record_filter)
  27             for record in records:
  28                 self.append(record)
  29
  30     def exists(self):
  31         sql = "SELECT * from pg_tables"
  32         tables = self.db.selectall(sql)
  33         tables = filter(lambda row: row['tablename'].startswith(self.SFA_TABLE_PREFIX), tables)
  34         if tables:
  35             return True
  36         return False
  37     def db_fields(self, obj=None):
  38
  39         db_fields = self.db.fields(self.SFA_TABLE_PREFIX)
  40         return dict( [ (key,value) for (key, value) in obj.iteritems() \
  41                         if key in db_fields and
  42                         self.is_writable(key, value, SfaRecord.fields)] )
  43
  44     @staticmethod
  45     def is_writable (key,value,dict):
  46         # if not mentioned, assume it's writable (e.g. deleted ...)
  47         if key not in dict: return True
  48         # if mentioned but not linked to a Parameter object, idem
  49         if not isinstance(dict[key], Parameter): return True
  50         # if not marked ro, it's writable
  51         if not dict[key].ro: return True
  52
  53         return False
  54
  55
  56     def create(self):
  57
  58         querystr = "CREATE TABLE " + self.tablename + " ( \
  59                 record_id serial PRIMARY KEY , \
  60                 hrn text NOT NULL, \
  61                 authority text NOT NULL, \
  62                 peer_authority text, \
  63                 gid text, \
  64                 type text NOT NULL, \
  65                 pointer integer, \
  66                 date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP, \
  67                 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP);"
  68         template = "CREATE INDEX %s_%s_idx ON %s (%s);"
  69         indexes = [template % ( self.tablename, field, self.tablename, field) \
  70                    for field in ['hrn', 'type', 'authority', 'peer_authority', 'pointer']]
  71         # IF EXISTS doenst exist in postgres < 8.2
  72         try:
  73             self.db.do('DROP TABLE IF EXISTS ' + self.tablename)
  74         except:
  75             try:
  76                 self.db.do('DROP TABLE' + self.tablename)
  77             except:
  78                 pass
  79
  80         self.db.do(querystr)
  81         for index in indexes:
  82             self.db.do(index)
  83
  84         self.db.commit()
  85
  86     def remove(self, record):
  87         params = {'record_id': record['record_id']}
  88         template = "DELETE FROM %s " % self.tablename
  89         sql = template + "WHERE record_id = %(record_id)s"
  90         self.db.do(sql, params)
  91
  92         # if this is a site, remove all records where 'authority' == the
  93         # site's hrn
  94         if record['type'] == 'authority':
  95             params = {'authority': record['hrn']}
  96             sql = template + "WHERE authority = %(authority)s"
  97             self.db.do(sql, params)
  98         self.db.commit()
  99
 100     def insert(self, record):
 101         db_fields = self.db_fields(record)
 102         keys = db_fields.keys()
 103         values = [self.db.param(key, value) for (key, value) in db_fields.iteritems()]
 104         query_str = "INSERT INTO " + self.tablename + \
 105                        "(" + ",".join(keys) + ") " + \
 106                        "VALUES(" + ",".join(values) + ")"
 107         self.db.do(query_str, db_fields)
 108         self.db.commit()
 109         result = self.find({'hrn': record['hrn'], 'type': record['type'], 'peer_authority': record['peer_authority']})
 110         if not result:
 111             record_id = None
 112         elif isinstance(result, list):
 113             record_id = result[0]['record_id']
 114         else:
 115             record_id = result['record_id']
 116
 117         return record_id
 118
 119     def update(self, record):
 120         db_fields = self.db_fields(record)
 121         keys = db_fields.keys()
 122         values = [self.db.param(key, value) for (key, value) in db_fields.iteritems()]
 123         columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
 124         query_str = "UPDATE %s SET %s WHERE record_id = %s" % \
 125                     (self.tablename, ", ".join(columns), record['record_id'])
 126         self.db.do(query_str, db_fields)
 127         self.db.commit()
 128
 129     def quote_string(self, value):
 130         return str(self.db.quote(value))
 131
 132     def quote(self, value):
 133         return self.db.quote(value)
 134
 135     def find(self, record_filter = None, columns=None):
 136         if not columns:
 137             columns = "*"
 138         else:
 139             columns = ",".join(columns)
 140         sql = "SELECT %s FROM %s WHERE True " % (columns, self.tablename)
 141
 142         if isinstance(record_filter, (list, tuple, set)):
 143             ints = filter(lambda x: isinstance(x, (int, long)), record_filter)
 144             strs = filter(lambda x: isinstance(x, StringTypes), record_filter)
 145             record_filter = Filter(SfaRecord.all_fields, {'record_id': ints, 'hrn': strs})
 146             sql += "AND (%s) %s " % record_filter.sql("OR")
 147         elif isinstance(record_filter, dict):
 148             record_filter = Filter(SfaRecord.all_fields, record_filter)
 149             sql += " AND (%s) %s" % record_filter.sql("AND")
 150         elif isinstance(record_filter, StringTypes):
 151             record_filter = Filter(SfaRecord.all_fields, {'hrn':[record_filter]})
 152             sql += " AND (%s) %s" % record_filter.sql("AND")
 153         elif isinstance(record_filter, int):
 154             record_filter = Filter(SfaRecord.all_fields, {'record_id':[record_filter]})
 155             sql += " AND (%s) %s" % record_filter.sql("AND")
 156
 157         results = self.db.selectall(sql)
 158         if isinstance(results, dict):
 159             results = [results]
 160         return results
 161
 162     def findObjects(self, record_filter = None, columns=None):
 163
 164         results = self.find(record_filter, columns)
 165         result_rec_list = []
 166         for result in results:
 167             if result['type'] in ['authority']:
 168                 result_rec_list.append(AuthorityRecord(dict=result))
 169             elif result['type'] in ['node']:
 170                 result_rec_list.append(NodeRecord(dict=result))
 171             elif result['type'] in ['slice']:
 172                 result_rec_list.append(SliceRecord(dict=result))
 173             elif result['type'] in ['user']:
 174                 result_rec_list.append(UserRecord(dict=result))
 175             else:
 176                 result_rec_list.append(SfaRecord(dict=result))
 177         return result_rec_list
 178
 179
 180     def drop(self):
 181         try:
 182             self.db.do('DROP TABLE IF EXISTS ' + self.tablename)
 183             self.db.commit()
 184         except:
 185             try:
 186                 self.db.do('DROP TABLE ' + self.tablename)
 187                 self.db.commit()
 188             except:
 189                 pass
 190
 191     def sfa_records_purge(self):
 192         self.drop()