Port _quote() from old version of pgdb. Simpliy code.
[plcapi.git] / PLC / PostgreSQL.py
index 98ef727..c08dd71 100644 (file)
@@ -6,6 +6,7 @@
 # Copyright (C) 2006 The Trustees of Princeton University
 #
 # $Id$
+# $URL$
 #
 
 import psycopg2
@@ -15,6 +16,7 @@ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE)
 psycopg2.extensions.register_type(psycopg2._psycopg.UNICODEARRAY)
 
 import pgdb
+import types
 from types import StringTypes, NoneType
 import traceback
 import commands
@@ -23,59 +25,52 @@ from pprint import pformat
 
 from PLC.Debug import profile, log
 from PLC.Faults import *
-
-if not psycopg2:
-    is8bit = re.compile("[\x80-\xff]").search
-
-    def unicast(typecast):
-        """
-        pgdb returns raw UTF-8 strings. This function casts strings that
-        appear 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)
+from datetime import datetime as DateTimeType
+
+# From pgdb
+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:
+        raise pgdb.InterfaceError, 'do not know how to handle type %s' % type(x)
+    return x
 
 class PostgreSQL:
     def __init__(self, api):
         self.api = api
         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.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")
-            else:
-                self.connection = pgdb.connect(user = self.api.config.PLC_DB_USER,
-                                               password = self.api.config.PLC_DB_PASSWORD,
-                                               host = "%s:%d" % (api.config.PLC_DB_HOST, api.config.PLC_DB_PORT),
-                                               database = self.api.config.PLC_DB_NAME)
+            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)
@@ -87,20 +82,14 @@ class PostgreSQL:
             self.connection.close()
             self.connection = None
 
+    @classmethod
     def quote(self, value):
         """
         Returns quoted version of the specified value.
         """
+        return _quote(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)
-
+    @classmethod
     def param(self, name, value):
         # None is converted to the unquoted string NULL
         if isinstance(value, NoneType):
@@ -117,8 +106,6 @@ class PostgreSQL:
 
         return '%(' + name + ')' + conversion
 
-    param = classmethod(param)
-
     def begin_work(self):
         # Implicit in pgdb.connect()
         pass
@@ -135,13 +122,13 @@ class PostgreSQL:
         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 
+        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):
@@ -153,7 +140,7 @@ class PostgreSQL:
 
         return None
 
-    # modified for psycopg2-2.0.7 
+    # 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
@@ -165,8 +152,13 @@ class PostgreSQL:
 
             # 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:
@@ -221,7 +213,7 @@ class PostgreSQL:
         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()).