interfaces/mysql/mysql-sql.cl

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          mysql-sql.cl
   6 ;;;; Purpose:       High-level MySQL interface using UFFI
   7 ;;;; Programmers:   Kevin M. Rosenberg based on
   8 ;;;;                Original code by Pierre R. Mai
   9 ;;;; Date Started:  Feb 2002
  10 ;;;;
  11 ;;;; $Id: mysql-sql.cl,v 1.15 2002/03/27 12:09:39 kevin Exp $
  12 ;;;;
  13 ;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
  14 ;;;; and Copyright (c) 1999-2001 by Pierre R. Mai
  15 ;;;;
  16 ;;;; CLSQL users are granted the rights to distribute and use this software
  17 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  18 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  19 ;;;; *************************************************************************
  20
  21 (declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
  22
  23 ;;;; Modified by Kevin Rosenberg, Feb 20002
  24 ;;;; -- Added support for Allegro CL and Lispworks using UFFI layer
  25 ;;;; -- Changed database-connect to use mysql-real-connect. This way,
  26 ;;;;    can avoid using double (unwind-protect)
  27 ;;;; -- Changed database-connect to have MySQL library allocate space
  28 ;;;;    for MYSQL structure. This will make the code more robust in
  29 ;;;;    the event that MySQL library changes the size of the mysql-mysql
  30 ;;;;    structure.
  31 ;;;;
  32 ;;;; Mar 2002
  33 ;;;; Added field types
  34
  35 (defpackage :clsql-mysql
  36     (:use :common-lisp :clsql-sys :mysql :clsql-uffi)
  37     (:export #:mysql-database)
  38     (:documentation "This is the CLSQL interface to MySQL."))
  39
  40 (in-package :clsql-mysql)
  41
  42 ;;; Field conversion functions
  43
  44 (defun make-type-list-for-auto (num-fields res-ptr)
  45   (let ((new-types '())
  46         #+ignore (field-vec (mysql-fetch-fields res-ptr)))
  47     (dotimes (i num-fields)
  48       (declare (fixnum i))
  49       (let* ( (field (mysql-fetch-field-direct res-ptr i))
  50              #+ignore (field (uffi:deref-array field-vec 'mysql-field-vector i))
  51               (type (uffi:get-slot-value field 'mysql-field 'type)))
  52         (push
  53          (case type
  54            ((#.mysql-field-types#tiny
  55              #.mysql-field-types#short
  56              #.mysql-field-types#int24
  57              #.mysql-field-types#long)
  58             :int32)
  59            (#.mysql-field-types#longlong
  60             :int64)
  61            ((#.mysql-field-types#double
  62              #.mysql-field-types#float
  63              #.mysql-field-types#decimal)
  64             :double)
  65            (otherwise
  66             t))
  67          new-types)))
  68     (nreverse new-types)))
  69
  70 (defun canonicalize-types (types num-fields res-ptr)
  71   (let ((auto-list (make-type-list-for-auto num-fields res-ptr)))
  72     (cond
  73       ((listp types)
  74        (canonicalize-type-list types auto-list))
  75       ((eq types :auto)
  76        auto-list)
  77       (t
  78        nil))))
  79
  80 (defmethod database-initialize-database-type ((database-type (eql :mysql)))
  81   t)
  82
  83 (uffi:def-type mysql-mysql-ptr-def (* mysql-mysql))
  84 (uffi:def-type mysql-row-def mysql-row)
  85 (uffi:def-type mysql-mysql-res-ptr-def (* mysql-mysql-res))
  86
  87 (defclass mysql-database (database)
  88   ((mysql-ptr :accessor database-mysql-ptr :initarg :mysql-ptr
  89               :type mysql-mysql-ptr-def)))
  90
  91 (defmethod database-name-from-spec (connection-spec (database-type (eql :mysql)))
  92   (check-connection-spec connection-spec database-type (host db user password))
  93   (destructuring-bind (host db user password) connection-spec
  94     (declare (ignore password))
  95     (concatenate 'string host "/" db "/" user)))
  96
  97
  98 (defmethod database-connect (connection-spec (database-type (eql :mysql)))
  99   (check-connection-spec connection-spec database-type (host db user password))
 100   (destructuring-bind (host db user password) connection-spec
 101     (let ((mysql-ptr (mysql-init (uffi:make-null-pointer 'mysql-mysql)))
 102           (socket nil))
 103       (if (uffi:null-pointer-p mysql-ptr)
 104           (error 'clsql-connect-error
 105                  :database-type database-type
 106                  :connection-spec connection-spec
 107                  :errno (mysql-errno mysql-ptr)
 108                  :error (mysql-error-string mysql-ptr))
 109         (uffi:with-cstrings ((host-native host)
 110                             (user-native user)
 111                             (password-native password)
 112                             (db-native db)
 113                             (socket-native socket))
 114           (let ((error-occurred nil))
 115             (unwind-protect
 116                 (if (uffi:null-pointer-p
 117                      (mysql-real-connect
 118                       mysql-ptr host-native user-native password-native
 119                       db-native 0 socket-native 0))
 120                     (progn
 121                       (setq error-occurred t)
 122                       (error 'clsql-connect-error
 123                              :database-type database-type
 124                              :connection-spec connection-spec
 125                              :errno (mysql-errno mysql-ptr)
 126                              :error (mysql-error-string mysql-ptr)))
 127                   (make-instance 'mysql-database
 128                     :name (database-name-from-spec connection-spec
 129                                                    database-type)
 130                     :mysql-ptr mysql-ptr))
 131               (when error-occurred (mysql-close mysql-ptr)))))))))
 132
 133
 134 (defmethod database-disconnect ((database mysql-database))
 135   (mysql-close (database-mysql-ptr database))
 136   (setf (database-mysql-ptr database) nil)
 137   t)
 138
 139
 140 (defmethod database-query (query-expression (database mysql-database)
 141                            types)
 142   (with-slots (mysql-ptr) database
 143     (uffi:with-cstring (query-native query-expression)
 144        (if (zerop (mysql-query mysql-ptr query-native))
 145            (let ((res-ptr (mysql-use-result mysql-ptr)))
 146              (if res-ptr
 147                  (let ((num-fields (mysql-num-fields res-ptr)))
 148                    (setq types (canonicalize-types
 149                                       types num-fields
 150                                       res-ptr))
 151                    (unwind-protect
 152                         (loop for row = (mysql-fetch-row res-ptr)
 153                               until (uffi:null-pointer-p row)
 154                               collect
 155                               (loop for i from 0 below num-fields
 156                                     collect
 157                                     (convert-raw-field
 158                                      (uffi:deref-array row 'mysql-row i)
 159                                      types i)))
 160                      (mysql-free-result res-ptr)))
 161                (error 'clsql-sql-error
 162                       :database database
 163                       :expression query-expression
 164                       :errno (mysql-errno mysql-ptr)
 165                       :error (mysql-error-string mysql-ptr))))
 166          (error 'clsql-sql-error
 167                 :database database
 168                 :expression query-expression
 169                 :errno (mysql-errno mysql-ptr)
 170                 :error (mysql-error-string mysql-ptr))))))
 171
 172 (defmethod database-execute-command (sql-expression (database mysql-database))
 173   (uffi:with-cstring (sql-native sql-expression)
 174     (let ((mysql-ptr (database-mysql-ptr database)))
 175       (declare (type mysql-mysql-ptr-def mysql-ptr))
 176       (if (zerop (mysql-query mysql-ptr sql-native))
 177           t
 178         (error 'clsql-sql-error
 179                :database database
 180                :expression sql-expression
 181                :errno (mysql-errno mysql-ptr)
 182                :error (mysql-error-string mysql-ptr))))))
 183
 184 (defstruct mysql-result-set
 185   (res-ptr (uffi:make-null-pointer 'mysql-mysql-res)
 186            :type mysql-mysql-res-ptr-def)
 187   (types nil)
 188   (num-fields nil :type fixnum)
 189   (full-set nil :type boolean))
 190
 191
 192 (defmethod database-query-result-set (query-expression
 193                                       (database mysql-database)
 194                                       &key full-set types)
 195   (uffi:with-cstring (query-native query-expression)
 196     (let ((mysql-ptr (database-mysql-ptr database)))
 197      (declare (type mysql-mysql-ptr-def mysql-ptr))
 198       (if (zerop (mysql-query mysql-ptr query-native))
 199           (let ((res-ptr (if full-set
 200                              (mysql-store-result mysql-ptr)
 201                            (mysql-use-result mysql-ptr))))
 202             (declare (type mysql-mysql-res-ptr-def res-ptr))
 203             (if (not (uffi:null-pointer-p res-ptr))
 204                 (let* ((num-fields (mysql-num-fields res-ptr))
 205                        (result-set (make-mysql-result-set
 206                                     :res-ptr res-ptr
 207                                     :num-fields num-fields
 208                                     :full-set full-set
 209                                     :types
 210                                     (canonicalize-types
 211                                      types num-fields
 212                                      res-ptr))))
 213                   (if full-set
 214                       (values result-set
 215                               num-fields
 216                               (mysql-num-rows res-ptr))
 217                       (values result-set
 218                               num-fields)))
 219                 (error 'clsql-sql-error
 220                      :database database
 221                      :expression query-expression
 222                      :errno (mysql-errno mysql-ptr)
 223                      :error (mysql-error-string mysql-ptr))))
 224         (error 'clsql-sql-error
 225                :database database
 226                :expression query-expression
 227                :errno (mysql-errno mysql-ptr)
 228                :error (mysql-error-string mysql-ptr))))))
 229
 230 (defmethod database-dump-result-set (result-set (database mysql-database))
 231   (mysql-free-result (mysql-result-set-res-ptr result-set))
 232   t)
 233
 234
 235 (defmethod database-store-next-row (result-set (database mysql-database) list)
 236   (let* ((res-ptr (mysql-result-set-res-ptr result-set))
 237          (row (mysql-fetch-row res-ptr))
 238          (types (mysql-result-set-types result-set)))
 239     (declare (type mysql-mysql-res-ptr-def res-ptr)
 240              (type mysql-row-def row))
 241     (unless (uffi:null-pointer-p row)
 242       (loop for i from 0 below (mysql-result-set-num-fields result-set)
 243             for rest on list
 244             do
 245             (setf (car rest)
 246                   (convert-raw-field
 247                    (uffi:deref-array row 'mysql-row i)
 248                    types
 249                    i)))
 250       list)))
 251
 252