use sfa.util.PostgreSQL. Support inserting Null.
authorTony Mack <tmack@cs.princeton.edu>
Sat, 26 Sep 2009 02:07:07 +0000 (02:07 +0000)
committerTony Mack <tmack@cs.princeton.edu>
Sat, 26 Sep 2009 02:07:07 +0000 (02:07 +0000)
sfa/util/PostgreSQL.py [new file with mode: 0644]
sfa/util/genitable.py

diff --git a/sfa/util/PostgreSQL.py b/sfa/util/PostgreSQL.py
new file mode 100644 (file)
index 0000000..1754119
--- /dev/null
@@ -0,0 +1,262 @@
+#
+# PostgreSQL database interface. Sort of like DBI(3) (Database
+# independent interface for Perl).
+#
+#
+
+import psycopg2
+import psycopg2.extensions
+psycopg2.extensions.register_type(psycopg2.extensions.UNICODE)
+# UNICODEARRAY not exported yet
+psycopg2.extensions.register_type(psycopg2._psycopg.UNICODEARRAY)
+
+import pgdb
+from types import StringTypes, NoneType
+import traceback
+import commands
+import re
+from pprint import pformat
+
+from sfa.util.faults import *
+from sfa.util.debug import *
+
+if not psycopg2:
+    is8bit = re.compile("[\x80-\xff]").search
+
+    def unicast(typecast):
+        """
+        pgdb returns raw UTF-8 strings. This function casts strings that
+        apppear to contain non-ASCII characters to unicode objects.
+        """
+    
+        def wrapper(*args, **kwds):
+            value = typecast(*args, **kwds)
+
+            # pgdb always encodes unicode objects as UTF-8 regardless of
+            # the DB encoding (and gives you no option for overriding
+            # the encoding), so always decode 8-bit objects as UTF-8.
+            if isinstance(value, str) and is8bit(value):
+                value = unicode(value, "utf-8")
+
+            return value
+
+        return wrapper
+
+    pgdb.pgdbTypeCache.typecast = unicast(pgdb.pgdbTypeCache.typecast)
+
+class PostgreSQL:
+    def __init__(self, config):
+        self.config = config
+        self.debug = False
+#        self.debug = True
+        self.connection = None
+
+    def cursor(self):
+        if self.connection is None:
+            # (Re)initialize database connection
+            if psycopg2:
+                try:
+                    # Try UNIX socket first
+                    self.connection = psycopg2.connect(user = self.config.SFA_PLC_DB_USER,
+                                                       password = self.config.SFA_PLC_DB_PASSWORD,
+                                                       database = self.config.SFA_PLC_DB_NAME)
+                except psycopg2.OperationalError:
+                    # Fall back on TCP
+                    self.connection = psycopg2.connect(user = self.config.SFA_PLC_DB_USER,
+                                                       password = self.config.SFA_PLC_DB_PASSWORD,
+                                                       database = self.config.SFA_PLC_DB_NAME,
+                                                       host = self.config.SFA_PLC_DB_HOST,
+                                                       port = self.config.SFA_PLC_DB_PORT)
+                self.connection.set_client_encoding("UNICODE")
+            else:
+                self.connection = pgdb.connect(user = self.config.SFA_PLC_DB_USER,
+                                               password = self.config.SFA_PLC_DB_PASSWORD,
+                                               host = "%s:%d" % (self.config.SFA_PLC_DB_HOST, self.config.SFA_PLC_DB_PORT),
+                                               database = self.config.SFA_PLC_DB_NAME)
+
+        (self.rowcount, self.description, self.lastrowid) = \
+                        (None, None, None)
+
+        return self.connection.cursor()
+
+    def close(self):
+        if self.connection is not None:
+            self.connection.close()
+            self.connection = None
+
+    def quote(self, value):
+        """
+        Returns quoted version of the specified value.
+        """
+
+        # The pgdb._quote function is good enough for general SQL
+        # quoting, except for array types.
+        if isinstance(value, (list, tuple, set)):
+            return "ARRAY[%s]" % ", ".join(map, self.quote, value)
+        else:
+            return pgdb._quote(value)
+
+    quote = classmethod(quote)
+
+    def param(self, name, value):
+        # None is converted to the unquoted string NULL
+        if isinstance(value, NoneType):
+            conversion = "s"
+        # True and False are also converted to unquoted strings
+        elif isinstance(value, bool):
+            conversion = "s"
+        elif isinstance(value, float):
+            conversion = "f"
+        elif not isinstance(value, StringTypes):
+            conversion = "d"
+        else:
+            conversion = "s"
+
+        return '%(' + name + ')' + conversion
+
+    param = classmethod(param)
+
+    def begin_work(self):
+        # Implicit in pgdb.connect()
+        pass
+
+    def commit(self):
+        self.connection.commit()
+
+    def rollback(self):
+        self.connection.rollback()
+
+    def do(self, query, params = None):
+        cursor = self.execute(query, params)
+        cursor.close()
+        return self.rowcount
+
+    def next_id(self, table_name, primary_key):
+       sequence = "%(table_name)s_%(primary_key)s_seq" % locals()      
+       sql = "SELECT nextval('%(sequence)s')" % locals()
+       rows = self.selectall(sql, hashref = False)
+       if rows: 
+           return rows[0][0]
+               
+       return None 
+
+    def last_insert_id(self, table_name, primary_key):
+        if isinstance(self.lastrowid, int):
+            sql = "SELECT %s FROM %s WHERE oid = %d" % \
+                  (primary_key, table_name, self.lastrowid)
+            rows = self.selectall(sql, hashref = False)
+            if rows:
+                return rows[0][0]
+
+        return None
+
+    # modified for psycopg2-2.0.7 
+    # executemany is undefined for SELECT's
+    # see http://www.python.org/dev/peps/pep-0249/
+    # accepts either None, a single dict, a tuple of single dict - in which case it execute's
+    # or a tuple of several dicts, in which case it executemany's
+    def execute(self, query, params = None):
+
+        cursor = self.cursor()
+        try:
+
+            # psycopg2 requires %()s format for all parameters,
+            # regardless of type.
+            # this needs to be done carefully though as with pattern-based filters
+            # we might have percents embedded in the query
+            # so e.g. GetPersons({'email':'*fake*'}) was resulting in .. LIKE '%sake%'
+            if psycopg2:
+                query = re.sub(r'(%\([^)]*\)|%)[df]', r'\1s', query)
+            # rewrite wildcards set by Filter.py as '***' into '%'
+            query = query.replace ('***','%')
+
+            if not params:
+                if self.debug:
+                    print >> log,'execute0',query
+                cursor.execute(query)
+            elif isinstance(params,dict):
+                if self.debug:
+                    print >> log,'execute-dict: params',params,'query',query%params
+                cursor.execute(query,params)
+            elif isinstance(params,tuple) and len(params)==1:
+                if self.debug:
+                    print >> log,'execute-tuple',query%params[0]
+                cursor.execute(query,params[0])
+            else:
+                param_seq=(params,)
+                if self.debug:
+                    for params in param_seq:
+                        print >> log,'executemany',query%params
+                cursor.executemany(query, param_seq)
+            (self.rowcount, self.description, self.lastrowid) = \
+                            (cursor.rowcount, cursor.description, cursor.lastrowid)
+        except Exception, e:
+            try:
+                self.rollback()
+            except:
+                pass
+            uuid = commands.getoutput("uuidgen")
+            print >> log, "Database error %s:" % uuid
+            print >> log, e
+            print >> log, "Query:"
+            print >> log, query
+            print >> log, "Params:"
+            print >> log, pformat(params)
+            raise GeniDBError("Please contact support")
+
+        return cursor
+
+    def selectall(self, query, params = None, hashref = True, key_field = None):
+        """
+        Return each row as a dictionary keyed on field name (like DBI
+        selectrow_hashref()). If key_field is specified, return rows
+        as a dictionary keyed on the specified field (like DBI
+        selectall_hashref()).
+
+        If params is specified, the specified parameters will be bound
+        to the query.
+        """
+
+        cursor = self.execute(query, params)
+        rows = cursor.fetchall()
+        cursor.close()
+        self.commit()
+        if hashref or key_field is not None:
+            # Return each row as a dictionary keyed on field name
+            # (like DBI selectrow_hashref()).
+            labels = [column[0] for column in self.description]
+            rows = [dict(zip(labels, row)) for row in rows]
+
+        if key_field is not None and key_field in labels:
+            # Return rows as a dictionary keyed on the specified field
+            # (like DBI selectall_hashref()).
+            return dict([(row[key_field], row) for row in rows])
+        else:
+            return rows
+
+    def fields(self, table, notnull = None, hasdef = None):
+        """
+        Return the names of the fields of the specified table.
+        """
+
+        if hasattr(self, 'fields_cache'):
+            if self.fields_cache.has_key((table, notnull, hasdef)):
+                return self.fields_cache[(table, notnull, hasdef)]
+        else:
+            self.fields_cache = {}
+
+        sql = "SELECT attname FROM pg_attribute, pg_class" \
+              " WHERE pg_class.oid = attrelid" \
+              " AND attnum > 0 AND relname = %(table)s"
+
+        if notnull is not None:
+            sql += " AND attnotnull is %(notnull)s"
+
+        if hasdef is not None:
+            sql += " AND atthasdef is %(hasdef)s"
+
+        rows = self.selectall(sql, locals(), hashref = False)
+
+        self.fields_cache[(table, notnull, hasdef)] = [row[0] for row in rows]
+
+        return self.fields_cache[(table, notnull, hasdef)]
index 05162f4..4aae797 100644 (file)
@@ -10,6 +10,7 @@
 import report
 import  pgdb
 from pg import DB, ProgrammingError
+from sfa.util.PostgreSQL import *
 from sfa.trust.gid import *
 from sfa.util.record import *
 from sfa.util.debug import *
@@ -24,9 +25,10 @@ class GeniTable(list):
 
         # pgsql doesn't like table names with "." in them, to replace it with "$"
         self.tablename = GeniTable.GENI_TABLE_PREFIX
-
+        self.config = Config()
+        self.db = PostgreSQL(self.config)
         # establish a connection to the pgsql server
-        cninfo = Config().get_plc_dbinfo()     
+        cninfo = self.config.get_plc_dbinfo()     
         self.cnx = DB(cninfo['dbname'], cninfo['address'], port=cninfo['port'], user=cninfo['user'], passwd=cninfo['password'])
 
         if record_filter:
@@ -42,12 +44,31 @@ class GeniTable(list):
             return True
         return False
 
+    def db_fields(self, obj=None):
+        
+        db_fields = self.db.fields(self.GENI_TABLE_PREFIX)
+        return dict( [ (key,value) for (key, value) in obj.items() \
+                        if key in db_fields and
+                        self.is_writable(key, value, GeniRecord.fields)] )      
+
+    @staticmethod
+    def is_writable (key,value,dict):
+        # if not mentioned, assume it's writable (e.g. deleted ...)
+        if key not in dict: return True
+        # if mentioned but not linked to a Parameter object, idem
+        if not isinstance(dict[key], Parameter): return True
+        # if not marked ro, it's writable
+        if not dict[key].ro: return True
+
+        return False
+
     def create(self):
         
         querystr = "CREATE TABLE " + self.tablename + " ( \
                 record_id serial PRIMARY KEY , \
                 hrn text NOT NULL, \
                 authority text NOT NULL, \
+                peer_authority text, \
                 gid text, \
                 type text NOT NULL, \
                 pointer integer, \
@@ -55,7 +76,7 @@ class GeniTable(list):
                 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP);"
         template = "CREATE INDEX %s_%s_idx ON %s (%s);"
         indexes = [template % ( self.tablename, field, self.tablename, field) \
-                   for field in ['hrn', 'type', 'authority', 'pointer']]
+                   for field in ['hrn', 'type', 'authority', 'peer_authority', 'pointer']]
         # IF EXISTS doenst exist in postgres < 8.2
         try:
             self.cnx.query('DROP TABLE IF EXISTS ' + self.tablename)
@@ -74,15 +95,15 @@ class GeniTable(list):
         self.cnx.query(query_str)
 
     def insert(self, record):
-        dont_insert = ['date_created', 'last_updated', 'record_id']
-        fieldnames = [field for field in  record.all_fields.keys() if field not in dont_insert]  
-        fieldvals = record.get_field_value_strings(fieldnames)
+        db_fields = self.db_fields(record)
+        keys = db_fields.keys()
+        values = [self.db.param(key, value) for (key, value) in db_fields.items()]
         query_str = "INSERT INTO " + self.tablename + \
-                       "(" + ",".join(fieldnames) + ") " + \
-                       "VALUES(" + ",".join(fieldvals) + ")"
-        #print query_str
-        self.cnx.query(query_str)
-        result = self.find({'hrn': record['hrn'], 'type': record['type']})
+                       "(" + ",".join(keys) + ") " + \
+                       "VALUES(" + ",".join(values) + ")"
+        self.db.do(query_str, db_fields)
+        self.db.commit()
+        result = self.find({'hrn': record['hrn'], 'type': record['type'], 'peer_authority': record['peer_authority']})
         if not result:
             record_id = None
         elif isinstance(result, list):
@@ -93,18 +114,18 @@ class GeniTable(list):
         return record_id
 
     def update(self, record):
-        dont_update = ['date_created', 'last_updated', 'record_id']
-        fields = [field for field in  record.all_fields.keys() if field not in dont_update]  
-        fieldvals = record.get_field_value_strings(fields)
+        db_fields = self.db_fields(record)
+        keys = db_fields.keys()
+        values = [self.db.param(key, value) for (key, value) in db_fields.items()]
         pairs = []
-        for field in fields:
-            val = record.get_field_value_string(field)
-            pairs.append(field + " = " + val)
+        for (key, value) in db_fields.items():
+            pairs.append(key + " = " + value)
         update = ", ".join(pairs)
 
         query_str = "UPDATE %s SET %s WHERE record_id = %s" % \
                     (self.tablename, update, record['record_id'])
-        self.cnx.query(query_str)
+        self.db.do(query_str, db_fields)
+        self.db.commit()
 
     def quote(self, value):
         """