sfa/util/genitable.py

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