r2753: move files
[clsql.git] / db-postgresql-socket / postgresql-socket-sql.cl
diff --git a/db-postgresql-socket/postgresql-socket-sql.cl b/db-postgresql-socket/postgresql-socket-sql.cl
new file mode 100644 (file)
index 0000000..4532dc2
--- /dev/null
@@ -0,0 +1,309 @@
+;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
+;;;; *************************************************************************
+;;;; FILE IDENTIFICATION
+;;;;
+;;;; Name:          postgresql-socket-sql.sql
+;;;; Purpose:       High-level PostgreSQL interface using socket
+;;;; Programmers:   Kevin M. Rosenberg based on
+;;;;                Original code by Pierre R. Mai 
+;;;; Date Started:  Feb 2002
+;;;;
+;;;; $Id: postgresql-socket-sql.cl,v 1.1 2002/09/18 07:43:41 kevin Exp $
+;;;;
+;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
+;;;; and Copyright (c) 1999-2001 by Pierre R. Mai
+;;;;
+;;;; CLSQL users are granted the rights to distribute and use this software
+;;;; as governed by the terms of the Lisp Lesser GNU Public License
+;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
+;;;; *************************************************************************
+
+(declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
+(in-package :cl-user)
+
+(defpackage :clsql-postgresql-socket
+    (:use :common-lisp :clsql-base-sys :postgresql-socket)
+    (:export #:postgresql-socket-database)
+    (:documentation "This is the CLSQL socket interface to PostgreSQL."))
+
+(in-package :clsql-postgresql-socket)
+
+;; interface foreign library loading routines
+
+(defmethod database-type-library-loaded ((database-type (eql :postgresql-socket)))
+  t)
+
+(defmethod clsql-base-sys:database-type-load-foreign ((database-type (eql :postgresql-socket)))
+  t)
+
+(clsql-base-sys:database-type-load-foreign :postgresql-socket)
+
+
+;; Field type conversion
+
+(defun make-type-list-for-auto (cursor)
+  (let* ((fields (postgresql-cursor-fields cursor))
+        (num-fields (length fields))
+        (new-types '()))
+    (dotimes (i num-fields)
+      (declare (fixnum i))
+      (push (canonical-field-type fields i) new-types))
+    (nreverse new-types)))
+
+(defun canonical-field-type (fields index)
+  "Extracts canonical field type from fields list"
+  (let ((oid (cadr (nth index fields))))
+    (case oid
+      ((#.pgsql-ftype#bytea
+       #.pgsql-ftype#int2
+       #.pgsql-ftype#int4)
+       :int32)
+      (#.pgsql-ftype#int8
+       :int64)
+      ((#.pgsql-ftype#float4
+       #.pgsql-ftype#float8)
+       :double)
+      (otherwise
+       t))))
+
+(defun canonicalize-types (types cursor)
+  (if (null types)
+      nil
+      (let ((auto-list (make-type-list-for-auto cursor)))
+       (cond
+         ((listp types)
+          (canonicalize-type-list types auto-list))
+         ((eq types :auto)
+          auto-list)
+         (t
+          nil)))))
+
+(defun canonicalize-type-list (types auto-list)
+  "Ensure a field type list meets expectations.
+Duplicated from clsql-uffi package so that this interface
+doesn't depend on UFFI."
+  (let ((length-types (length types))
+       (new-types '()))
+    (loop for i from 0 below (length auto-list)
+         do
+         (if (>= i length-types)
+             (push t new-types) ;; types is shorted than num-fields
+             (push
+              (case (nth i types)
+                (:int
+                 (case (nth i auto-list)
+                   (:int32
+                    :int32)
+                   (:int64
+                    :int64)
+                   (t
+                    t)))
+                (:double
+                 (case (nth i auto-list)
+                   (:double
+                    :double)
+                   (t
+                    t)))
+                (t
+                 t))
+              new-types)))
+    (nreverse new-types)))
+
+
+(defun convert-to-clsql-warning (database condition)
+  (warn 'clsql-database-warning :database database
+       :message (postgresql-condition-message condition)))
+
+(defun convert-to-clsql-error (database expression condition)
+  (error 'clsql-sql-error :database database
+        :expression expression
+        :errno (type-of condition)
+        :error (postgresql-condition-message condition)))
+
+(defmacro with-postgresql-handlers
+    ((database &optional expression)
+     &body body)
+  (let ((database-var (gensym))
+       (expression-var (gensym)))
+    `(let ((,database-var ,database)
+          (,expression-var ,expression))
+       (handler-bind ((postgresql-warning
+                      (lambda (c)
+                        (convert-to-clsql-warning ,database-var c)))
+                     (postgresql-error
+                      (lambda (c)
+                        (convert-to-clsql-error
+                         ,database-var ,expression-var c))))
+        ;; KMR - removed double @@
+        ,@body))))
+
+(defmethod database-initialize-database-type ((database-type
+                                              (eql :postgresql-socket)))
+  t)
+
+(defclass postgresql-socket-database (database)
+  ((connection :accessor database-connection :initarg :connection
+              :type postgresql-connection)))
+
+(defmethod database-type ((database postgresql-socket-database))
+  :postgresql-socket)
+
+(defmethod database-name-from-spec (connection-spec
+                                   (database-type (eql :postgresql-socket)))
+  (check-connection-spec connection-spec database-type
+                        (host db user password &optional port options tty))
+  (destructuring-bind (host db user password &optional port options tty)
+      connection-spec
+    (declare (ignore password options tty))
+    (concatenate 'string host (if port ":") (if port port) "/" db "/" user)))
+
+(defmethod database-connect (connection-spec 
+                            (database-type (eql :postgresql-socket)))
+  (check-connection-spec connection-spec database-type
+                        (host db user password &optional port options tty))
+  (destructuring-bind (host db user password &optional
+                           (port +postgresql-server-default-port+)
+                           (options "") (tty ""))
+      connection-spec
+    (handler-case
+       (handler-bind ((postgresql-warning
+                       (lambda (c)
+                         (warn 'clsql-simple-warning
+                               :format-control "~A"
+                               :format-arguments
+                               (list (princ-to-string c))))))
+         (open-postgresql-connection :host host :port port
+                                     :options options :tty tty
+                                     :database db :user user
+                                     :password password))
+      (:no-error (connection)
+       ;; Success, make instance
+       (make-instance 'postgresql-socket-database
+                      :name (database-name-from-spec connection-spec
+                                                     database-type)
+                      :connection-spec connection-spec
+                      :connection connection))
+      (postgresql-error (c)
+       ;; Connect failed
+       (error 'clsql-connect-error
+              :database-type database-type
+              :connection-spec connection-spec
+              :errno (type-of c)
+              :error (postgresql-condition-message c))))))
+
+(defmethod database-disconnect ((database postgresql-socket-database))
+  (close-postgresql-connection (database-connection database))
+  t)
+
+(defmethod database-query (expression (database postgresql-socket-database) types)
+  (let ((connection (database-connection database)))
+    (with-postgresql-handlers (database expression)
+      (start-query-execution connection expression)
+      (multiple-value-bind (status cursor)
+         (wait-for-query-results connection)
+       (unless (eq status :cursor)
+         (close-postgresql-connection connection)
+         (error 'clsql-sql-error
+                :database database
+                :expression expression
+                :errno 'missing-result
+                :error "Didn't receive result cursor for query."))
+       (setq types (canonicalize-types types cursor))
+       (loop for row = (read-cursor-row cursor types)
+             while row
+             collect row
+             finally
+             (unless (null (wait-for-query-results connection))
+               (close-postgresql-connection connection)
+               (error 'clsql-sql-error
+                      :database database
+                      :expression expression
+                      :errno 'multiple-results
+                      :error "Received multiple results for query.")))))))
+
+(defmethod database-execute-command
+    (expression (database postgresql-socket-database))
+  (let ((connection (database-connection database)))
+    (with-postgresql-handlers (database expression)
+      (start-query-execution connection expression)
+      (multiple-value-bind (status result)
+         (wait-for-query-results connection)
+       (when (eq status :cursor)
+         (loop
+             (multiple-value-bind (row stuff)
+                 (skip-cursor-row result)
+               (unless row
+                 (setq status :completed result stuff)
+                 (return)))))
+       (cond
+         ((null status)
+          t)
+         ((eq status :completed)
+          (unless (null (wait-for-query-results connection))
+            (close-postgresql-connection connection)
+            (error 'clsql-sql-error
+                   :database database
+                   :expression expression
+                   :errno 'multiple-results
+                   :error "Received multiple results for command."))
+          result)
+         (t
+          (close-postgresql-connection connection)
+          (error 'clsql-sql-error
+                 :database database
+                 :expression expression
+                 :errno 'missing-result
+                 :error "Didn't receive completion for command.")))))))
+
+(defstruct postgresql-socket-result-set
+  (done nil)
+  (cursor nil)
+  (types nil))
+
+(defmethod database-query-result-set (expression (database postgresql-socket-database) 
+                                     &key full-set types
+     )
+  (declare (ignore full-set))
+  (let ((connection (database-connection database)))
+    (with-postgresql-handlers (database expression)
+      (start-query-execution connection expression)
+      (multiple-value-bind (status cursor)
+         (wait-for-query-results connection)
+       (unless (eq status :cursor)
+         (close-postgresql-connection connection)
+         (error 'clsql-sql-error
+                :database database
+                :expression expression
+                :errno 'missing-result
+                :error "Didn't receive result cursor for query."))
+       (values (make-postgresql-socket-result-set
+                :done nil 
+                :cursor cursor
+                :types (canonicalize-types types cursor))
+               (length (postgresql-cursor-fields cursor)))))))
+
+(defmethod database-dump-result-set (result-set
+                                    (database postgresql-socket-database))
+  (if (postgresql-socket-result-set-done result-set)
+      t
+      (with-postgresql-handlers (database)
+       (loop while (skip-cursor-row 
+                    (postgresql-socket-result-set-cursor result-set))
+         finally (setf (postgresql-socket-result-set-done result-set) t)))))
+
+(defmethod database-store-next-row (result-set
+                                   (database postgresql-socket-database)
+                                   list)
+  (let ((cursor (postgresql-socket-result-set-cursor result-set)))
+    (with-postgresql-handlers (database)
+      (if (copy-cursor-row cursor 
+                          list
+                          (postgresql-socket-result-set-types
+                           result-set))
+         t
+         (prog1 nil
+           (setf (postgresql-socket-result-set-done result-set) t)
+           (wait-for-query-results (database-connection database)))))))
+
+(when (clsql-base-sys:database-type-library-loaded :postgresql-socket)
+  (clsql-base-sys:initialize-database-type :database-type :postgresql-socket))