X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FPostgreSQL.py;h=1dfced50951822a30a87c17fb6a4903240c55fdf;hb=9aecb8c6fde06136bef94e2fd6fce832dc3c0c10;hp=069d944f4d52423d8059ef7d512264c0e2811b54;hpb=bb792d37e71f8fb701ec1afa9b3234723a830b77;p=plcapi.git diff --git a/PLC/PostgreSQL.py b/PLC/PostgreSQL.py index 069d944..1dfced5 100644 --- a/PLC/PostgreSQL.py +++ b/PLC/PostgreSQL.py @@ -1,53 +1,108 @@ # -# PostgreSQL database interface. Sort of like DBI(3) (Database -# independent interface for Perl). +# PostgreSQL database interface. +# Sort of like DBI(3) (Database independent interface for Perl). # # Mark Huang # Copyright (C) 2006 The Trustees of Princeton University # -# $Id: PostgreSQL.py,v 1.4 2006/10/13 20:00:37 mlhuang Exp $ -# -import pgdb +import psycopg2 +import psycopg2.extensions +psycopg2.extensions.register_type(psycopg2.extensions.UNICODE) +# UNICODEARRAY not exported yet +psycopg2.extensions.register_type(psycopg2._psycopg.UNICODEARRAY) + +import types from types import StringTypes, NoneType import traceback import commands +import re from pprint import pformat from PLC.Debug import profile, log from PLC.Faults import * +from datetime import datetime as DateTimeType class PostgreSQL: def __init__(self, api): self.api = api + self.debug = False +# self.debug = True + self.connection = None - # Initialize database connection - self.db = pgdb.connect(user = api.config.PLC_DB_USER, - password = api.config.PLC_DB_PASSWORD, - host = "%s:%d" % (api.config.PLC_DB_HOST, api.config.PLC_DB_PORT), - database = api.config.PLC_DB_NAME) - self.cursor = self.db.cursor() + def cursor(self): + if self.connection is None: + # (Re)initialize database connection + try: + # Try UNIX socket first + self.connection = psycopg2.connect(user = self.api.config.PLC_DB_USER, + password = self.api.config.PLC_DB_PASSWORD, + database = self.api.config.PLC_DB_NAME) + except psycopg2.OperationalError: + # Fall back on TCP + self.connection = psycopg2.connect(user = self.api.config.PLC_DB_USER, + password = self.api.config.PLC_DB_PASSWORD, + database = self.api.config.PLC_DB_NAME, + host = self.api.config.PLC_DB_HOST, + port = self.api.config.PLC_DB_PORT) + self.connection.set_client_encoding("UNICODE") (self.rowcount, self.description, self.lastrowid) = \ (None, None, None) - def quote(self, params): - """ - Returns quoted version(s) of the specified parameter(s). - """ + return self.connection.cursor() - # pgdb._quote functions are good enough for general SQL quoting - if hasattr(params, 'has_key'): - params = pgdb._quoteitem(params) - elif isinstance(params, list) or isinstance(params, tuple): - params = map(pgdb._quote, params) + def close(self): + if self.connection is not None: + self.connection.close() + self.connection = None + + @staticmethod + # From pgdb, and simplify code + def _quote(x): + if isinstance(x, DateTimeType): + x = str(x) + elif isinstance(x, unicode): + x = x.encode( 'utf-8' ) + + if isinstance(x, types.StringType): + x = "'%s'" % str(x).replace("\\", "\\\\").replace("'", "''") + elif isinstance(x, (types.IntType, types.LongType, types.FloatType)): + pass + elif x is None: + x = 'NULL' + elif isinstance(x, (types.ListType, types.TupleType, set)): + x = 'ARRAY[%s]' % ', '.join(map(lambda x: str(_quote(x)), x)) + elif hasattr(x, '__pg_repr__'): + x = x.__pg_repr__() else: - params = pgdb._quote(params) + raise PLCDBError, 'Cannot quote type %s' % type(x) + return x - return params - quote = classmethod(quote) + def quote(self, value): + """ + Returns quoted version of the specified value. + """ + return PostgreSQL._quote (value) +# following is an unsuccessful attempt to re-use lib code as much as possible +# def quote(self, value): +# # The pgdb._quote function is good enough for general SQL +# # quoting, except for array types. +# if isinstance (value, (types.ListType, types.TupleType, set)): +# 'ARRAY[%s]' % ', '.join( [ str(self.quote(x)) for x in value ] ) +# else: +# try: +# # up to PyGreSQL-3.x, function was pgdb._quote +# import pgdb +# return pgdb._quote(value) +# except: +# # with PyGreSQL-4.x, use psycopg2's adapt +# from psycopg2.extensions import adapt +# return adapt (value) + + @classmethod def param(self, name, value): # None is converted to the unquoted string NULL if isinstance(value, NoneType): @@ -64,22 +119,30 @@ class PostgreSQL: return '%(' + name + ')' + conversion - param = classmethod(param) - def begin_work(self): # Implicit in pgdb.connect() pass def commit(self): - self.db.commit() + self.connection.commit() def rollback(self): - self.db.rollback() + self.connection.rollback() def do(self, query, params = None): - self.execute(query, params) + 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" % \ @@ -90,16 +153,47 @@ class PostgreSQL: 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): - self.execute_array(query, (params,)) - def execute_array(self, query, param_seq): - cursor = self.cursor + cursor = self.cursor() try: - cursor.executemany(query, param_seq) + + # 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 pgdb.DatabaseError, e: + except Exception, e: try: self.rollback() except: @@ -110,12 +204,14 @@ class PostgreSQL: print >> log, "Query:" print >> log, query print >> log, "Params:" - print >> log, pformat(param_seq[0]) + print >> log, pformat(params) raise PLCDBError("Please contact " + \ self.api.config.PLC_NAME + " Support " + \ "<" + self.api.config.PLC_MAIL_SUPPORT_ADDRESS + ">" + \ " and reference " + uuid) + 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 @@ -124,14 +220,14 @@ class PostgreSQL: selectall_hashref()). If params is specified, the specified parameters will be bound - to the query (see PLC.DB.parameterize() and - pgdb.cursor.execute()). + to the query. """ - self.execute(query, params) - rows = self.cursor.fetchall() - - if hashref: + 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] @@ -149,6 +245,12 @@ class PostgreSQL: 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" @@ -161,4 +263,6 @@ class PostgreSQL: rows = self.selectall(sql, locals(), hashref = False) - return [row[0] for row in rows] + self.fields_cache[(table, notnull, hasdef)] = [row[0] for row in rows] + + return self.fields_cache[(table, notnull, hasdef)]