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     def create(self):
  66
  67         querystr = "CREATE TABLE " + self.tablename + " ( \
  68                 record_id serial PRIMARY KEY , \
  69                 hrn text NOT NULL, \
  70                 authority text NOT NULL, \
  71                 peer_authority text, \
  72                 gid text, \
  73                 type text NOT NULL, \
  74                 pointer integer, \
  75                 date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP, \
  76                 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP);"
  77         template = "CREATE INDEX %s_%s_idx ON %s (%s);"
  78         indexes = [template % ( self.tablename, field, self.tablename, field) \
  79                    for field in ['hrn', 'type', 'authority', 'peer_authority', 'pointer']]
  80         # IF EXISTS doenst exist in postgres < 8.2
  81         try:
  82             self.cnx.query('DROP TABLE IF EXISTS ' + self.tablename)
  83         except ProgrammingError:
  84             try:
  85                 self.cnx.query('DROP TABLE ' + self.tablename)
  86             except ProgrammingError:
  87                 pass
  88
  89         self.cnx.query(querystr)
  90         for index in indexes:
  91             self.cnx.query(index)
  92
  93     def remove(self, record):
  94         query_str = "DELETE FROM %s WHERE record_id = %s" % (self.tablename, record['record_id'])
  95         self.cnx.query(query_str)
  96
  97     def insert(self, record):
  98         db_fields = self.db_fields(record)
  99         keys = db_fields.keys()
 100         values = [self.db.param(key, value) for (key, value) in db_fields.items()]
 101         query_str = "INSERT INTO " + self.tablename + \
 102                        "(" + ",".join(keys) + ") " + \
 103                        "VALUES(" + ",".join(values) + ")"
 104         self.db.do(query_str, db_fields)
 105         self.db.commit()
 106         result = self.find({'hrn': record['hrn'], 'type': record['type'], 'peer_authority': record['peer_authority']})
 107         if not result:
 108             record_id = None
 109         elif isinstance(result, list):
 110             record_id = result[0]['record_id']
 111         else:
 112             record_id = result['record_id']
 113
 114         return record_id
 115
 116     def update(self, record):
 117         db_fields = self.db_fields(record)
 118         keys = db_fields.keys()
 119         values = [self.db.param(key, value) for (key, value) in db_fields.items()]
 120         pairs = []
 121         for (key, value) in db_fields.items():
 122             pairs.append(key + " = " + value)
 123         update = ", ".join(pairs)
 124
 125         query_str = "UPDATE %s SET %s WHERE record_id = %s" % \
 126                     (self.tablename, update, record['record_id'])
 127         self.db.do(query_str, db_fields)
 128         self.db.commit()
 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):
 143         sql = "SELECT * FROM %s WHERE True " % self.tablename
 144
 145         if isinstance(record_filter, (list, tuple, set)):
 146             ints = filter(lambda x: isinstance(x, (int, long)), record_filter)
 147             strs = filter(lambda x: isinstance(x, StringTypes), record_filter)
 148             record_filter = Filter(GeniRecord.all_fields, {'record_id': ints, 'hrn': strs})
 149             sql += "AND (%s) %s " % record_filter.sql("OR")
 150         elif isinstance(record_filter, dict):
 151             record_filter = Filter(GeniRecord.all_fields, record_filter)
 152             sql += " AND (%s) %s" % record_filter.sql("AND")
 153         elif isinstance(record_filter, StringTypes):
 154             record_filter = Filter(GeniRecord.all_fields, {'hrn':[record_filter]})
 155             sql += " AND (%s) %s" % record_filter.sql("AND")
 156         elif isinstance(record_filter, int):
 157             record_filter = Filter(GeniRecord.all_fields, {'record_id':[record_filter]})
 158             sql += " AND (%s) %s" % record_filter.sql("AND")
 159
 160         results = self.cnx.query(sql).dictresult()
 161         if isinstance(results, dict):
 162             results = [results]
 163         return results
 164
 165     def findObjects(self, record_filter = None):
 166
 167         results = self.find(record_filter)
 168         result_rec_list = []
 169         for result in results:
 170             if result['type'] in ['authority']:
 171                 result_rec_list.append(AuthorityRecord(dict=result))
 172             elif result['type'] in ['node']:
 173                 result_rec_list.append(NodeRecord(dict=result))
 174             elif result['type'] in ['slice']:
 175                 result_rec_list.append(SliceRecord(dict=result))
 176             elif result['type'] in ['user']:
 177                 result_rec_list.append(UserRecord(dict=result))
 178             else:
 179                 result_rec_list.append(GeniRecord(dict=result))
 180         return result_rec_list
 181
 182
 183     def drop(self):
 184         try:
 185             self.cnx.query('DROP TABLE IF EXISTS ' + self.tablename)
 186         except ProgrammingError:
 187             try:
 188                 self.cnx.query('DROP TABLE ' + self.tablename)
 189             except ProgrammingError:
 190                 pass
 191
 192     @staticmethod
 193     def geni_records_purge(cninfo):
 194
 195         cnx = DB(cninfo['dbname'], cninfo['address'],
 196                  port=cninfo['port'], user=cninfo['user'], passwd=cninfo['password'])
 197         tableList = cnx.get_tables()
 198         for table in tableList:
 199             if table.startswith(GeniTable.GENI_TABLE_PREFIX) or \
 200                     table.startswith('public.' + GeniTable.GENI_TABLE_PREFIX) or \
 201                     table.startswith('public."' + GeniTable.GENI_TABLE_PREFIX):
 202                 report.trace("dropping table " + table)
 203                 cnx.query("DROP TABLE " + table)