Major rewrite of table/column name output escaping system wide.
[clsql.git] / db-mysql / mysql-sql.lisp
1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:          mysql-sql.lisp
6 ;;;; Purpose:       High-level MySQL interface using UFFI
7 ;;;; Date Started:  Feb 2002
8 ;;;;
9 ;;;; This file, part of CLSQL, is Copyright (c) 2002-2010 by Kevin M. Rosenberg
10 ;;;;
11 ;;;; CLSQL users are granted the rights to distribute and use this software
12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
14 ;;;; *************************************************************************
15
16 (defpackage #:clsql-mysql
17     (:use #:common-lisp #:clsql-sys #:mysql #:clsql-uffi)
18     (:export #:mysql-database)
19     (:import-from :clsql-sys
20      :escaped :unescaped :combine-database-identifiers
21      :escaped-database-identifier :unescaped-database-identifier :database-identifier
22      :%sequence-name-to-table :%table-name-to-sequence-name)
23     (:documentation "This is the CLSQL interface to MySQL."))
24
25 (in-package #:clsql-mysql)
26
27 ;;; Field conversion functions
28
29 (defun result-field-names (res-ptr)
30   (let ((names '()))
31     (mysql-field-seek res-ptr 0)
32     (loop
33        (let ((field (mysql-fetch-field res-ptr)))
34          (when (uffi:null-pointer-p field) (return))
35          (push (uffi:convert-from-cstring (clsql-mysql-field-name field)) names)))
36     (nreverse names)))
37
38 (defun make-type-list-for-auto (res-ptr)
39   (let ((new-types '()))
40     (mysql-field-seek res-ptr 0)
41     (loop
42        (let ((field (mysql-fetch-field res-ptr)))
43          (when (uffi:null-pointer-p field) (return))
44          (let* ((flags (clsql-mysql-field-flags field))
45                 (unsigned (plusp (logand flags 32)))
46                 (type (clsql-mysql-field-type field)))
47            (push
48             (case type
49               ((#.mysql-field-types#tiny
50                 #.mysql-field-types#short
51                 #.mysql-field-types#int24)
52                (if unsigned
53                    :uint32
54                    :int32))
55               (#.mysql-field-types#long
56                (if unsigned
57                    :uint
58                    :int))
59               (#.mysql-field-types#longlong
60                (if unsigned
61                    :uint64
62                    :int64))
63               ((#.mysql-field-types#double
64                 #.mysql-field-types#float
65                 #.mysql-field-types#decimal)
66                :double)
67               (otherwise
68                t))
69             new-types))))
70     (nreverse new-types)))
71
72 (defun canonicalize-types (types res-ptr)
73   (when types
74     (let ((auto-list (make-type-list-for-auto res-ptr)))
75       (cond
76         ((listp types)
77          (canonicalize-type-list types auto-list))
78         ((eq types :auto)
79          auto-list)
80         (t
81          nil)))))
82
83 (defmethod database-initialize-database-type ((database-type (eql :mysql)))
84   t)
85
86 ;;(uffi:def-type mysql-mysql-ptr-def (* mysql-mysql))
87 ;;(uffi:def-type mysql-mysql-res-ptr-def (* mysql-mysql-res))
88 (uffi:def-type mysql-mysql-ptr-def mysql-mysql)
89 (uffi:def-type mysql-mysql-res-ptr-def mysql-mysql-res)
90 (uffi:def-type mysql-row-def mysql-row)
91
92 (defclass mysql-database (database)
93   ((mysql-ptr :accessor database-mysql-ptr :initarg :mysql-ptr
94               :type mysql-mysql-ptr-def)
95    (server-info :accessor database-server-info :initarg :server-info
96               :type string)))
97
98 (defmethod database-type ((database mysql-database))
99   :mysql)
100
101 (defmethod database-name-from-spec (connection-spec (database-type (eql :mysql)))
102   (check-connection-spec connection-spec database-type
103                          (host db user password &optional port options))
104   (destructuring-bind (host db user password &optional port options) connection-spec
105     (declare (ignore password options))
106     (concatenate 'string
107                  (etypecase host
108                    (null "localhost")
109                    (pathname (namestring host))
110                    (string host))
111                  (if port
112                      (concatenate 'string
113                                   ":"
114                                   (etypecase port
115                                     (integer (write-to-string port))
116                                     (string port)))
117                      "")
118                  "/" db "/" user)))
119
120 (defun lookup-option-code (option)
121   (if (assoc option +mysql-option-parameter-map+)
122       (symbol-value (intern
123                      (concatenate 'string (symbol-name-default-case "mysql-option#")
124                                   (symbol-name option))
125                      (symbol-name '#:mysql)))
126       (progn
127         (warn "Unknown mysql option name ~A - ignoring.~%" option)
128         nil)))
129
130 (defun set-mysql-options (mysql-ptr options)
131   (flet ((lookup-option-type (option)
132            (cdr (assoc option +mysql-option-parameter-map+))))
133     (dolist (option options)
134       (if (atom option)
135           (let ((option-code (lookup-option-code option)))
136             (when option-code
137               (mysql-options mysql-ptr option-code uffi:+null-cstring-pointer+)))
138           (destructuring-bind (name . value) option
139             (let ((option-code (lookup-option-code name)))
140               (when option-code
141                 (case (lookup-option-type name)
142                   (:none
143                    (mysql-options mysql-ptr option-code uffi:+null-cstring-pointer+))
144                   (:char-ptr
145                    (if (stringp value)
146                        (uffi:with-foreign-string (fs value)
147                            (mysql-options mysql-ptr option-code fs))
148                        (warn "Expecting string argument for mysql option ~A, got ~A ~
149 - ignoring.~%"
150                              name value)))
151                   (:uint-ptr
152                    (if (integerp value)
153                        (uffi:with-foreign-object (fo :unsigned-int)
154                          (setf (uffi:deref-pointer fo :unsigned-int) value)
155                          (mysql-options mysql-ptr option-code fo))
156                        (warn "Expecting integer argument for mysql option ~A, got ~A ~
157 - ignoring.~%"
158                              name value)))
159                   (:boolean-ptr
160                    (uffi:with-foreign-object (fo :byte)
161                      (setf (uffi:deref-pointer fo :byte)
162                            (if (or (zerop value) (null value))
163                                0
164                                1))
165                      (mysql-options mysql-ptr option-code fo)))))))))))
166
167 (defmethod database-connect (connection-spec (database-type (eql :mysql)))
168   (check-connection-spec connection-spec database-type
169                          (host db user password &optional port options))
170   (destructuring-bind (host db user password &optional port options) connection-spec
171     (let ((mysql-ptr (mysql-init (uffi:make-null-pointer 'mysql-mysql)))
172           (socket nil))
173       (if (uffi:null-pointer-p mysql-ptr)
174           (error 'sql-connection-error
175                  :database-type database-type
176                  :connection-spec connection-spec
177                  :error-id (mysql-errno mysql-ptr)
178                  :message (mysql-error-string mysql-ptr))
179         (uffi:with-cstrings ((host-native host)
180                             (user-native user)
181                             (password-native password)
182                             (db-native db)
183                             (socket-native socket))
184           (when options
185             (set-mysql-options mysql-ptr options))
186           (let ((error-occurred nil))
187             (unwind-protect
188                 (if (uffi:null-pointer-p
189                      (mysql-real-connect
190                       mysql-ptr host-native user-native password-native
191                       db-native
192                       (etypecase port
193                         (null 0)
194                         (integer port)
195                         (string (parse-integer port)))
196                       socket-native 0))
197                     (progn
198                       (setq error-occurred t)
199                       (error 'sql-connection-error
200                              :database-type database-type
201                              :connection-spec connection-spec
202                              :error-id (mysql-errno mysql-ptr)
203                              :message (mysql-error-string mysql-ptr)))
204                     (let* ((db
205                             (make-instance 'mysql-database
206                                            :name (database-name-from-spec connection-spec
207                                                                           database-type)
208                                            :database-type :mysql
209                                            :connection-spec connection-spec
210                                            :server-info (uffi:convert-from-cstring
211                                                          (mysql:mysql-get-server-info mysql-ptr))
212                                            :mysql-ptr mysql-ptr))
213                            (cmd "SET SESSION sql_mode='ANSI'"))
214                       (uffi:with-cstring (cmd-cs cmd)
215                         (if (zerop (mysql-real-query mysql-ptr cmd-cs (uffi:foreign-encoded-octet-count
216                                                                        cmd :encoding (encoding db))))
217                             db
218                             (progn
219                               (warn "Error setting ANSI mode for MySQL.")
220                               db)))))
221               (when error-occurred (mysql-close mysql-ptr)))))))))
222
223
224 (defmethod database-disconnect ((database mysql-database))
225   (mysql-close (database-mysql-ptr database))
226   (setf (database-mysql-ptr database) nil)
227   t)
228
229 (defmethod database-execute-command (sql-expression (database mysql-database))
230   (uffi:with-cstring (sql-native sql-expression)
231     (let ((mysql-ptr (database-mysql-ptr database)))
232       (declare (type mysql-mysql-ptr-def mysql-ptr))
233       (if (zerop (mysql-real-query mysql-ptr sql-native
234                                    (uffi:foreign-encoded-octet-count
235                                     sql-expression :encoding (encoding database))))
236           t
237         (error 'sql-database-data-error
238                :database database
239                :expression sql-expression
240                :error-id (mysql-errno mysql-ptr)
241                :message (mysql-error-string mysql-ptr))))))
242
243
244 (defmethod database-query (query-expression (database mysql-database)
245                            result-types field-names)
246   (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
247   (let ((mysql-ptr (database-mysql-ptr database)))
248     (declare (type mysql-mysql-ptr-def mysql-ptr))
249     (when (database-execute-command query-expression database)
250       (let ((res-ptr (mysql-use-result mysql-ptr)))
251         (declare (type mysql-mysql-res-ptr-def res-ptr))
252         (if (and res-ptr (not (uffi:null-pointer-p res-ptr)))
253             (unwind-protect
254                  (let ((num-fields (mysql-num-fields res-ptr)))
255                    (declare (fixnum num-fields))
256                    (setq result-types (canonicalize-types
257                                        result-types res-ptr))
258                    (values
259                      (loop for row = (mysql-fetch-row res-ptr)
260                            for lengths = (mysql-fetch-lengths res-ptr)
261                            until (uffi:null-pointer-p row)
262                            collect
263                         (do* ((rlist (make-list num-fields))
264                               (i 0 (1+ i))
265                               (pos rlist (cdr pos)))
266                             ((= i num-fields) rlist)
267                           (declare (fixnum i))
268                           (setf (car pos)
269                                 (convert-raw-field
270                                  (uffi:deref-array row '(:array
271                                                          (* :unsigned-char))
272                                                    i)
273                                  (nth i result-types)
274                                  :length
275                                  (uffi:deref-array lengths '(:array :unsigned-long) i)
276                                  :encoding (encoding database)))))
277                      (when field-names
278                        (result-field-names res-ptr))))
279               (mysql-free-result res-ptr))
280             (unless (zerop (mysql-errno mysql-ptr))
281               ;;from http://dev.mysql.com/doc/refman/5.0/en/mysql-field-count.html
282               ;; if mysql_use_result or mysql_store_result return a null ptr,
283               ;; we use a mysql_errno check to see if it had a problem or just
284               ;; was a query without a result. If no error, just return nil.
285               (error 'sql-database-data-error
286                      :database database
287                      :expression query-expression
288                      :error-id (mysql-errno mysql-ptr)
289                      :message (mysql-error-string mysql-ptr))))))))
290
291
292 (defstruct mysql-result-set
293   (res-ptr (uffi:make-null-pointer 'mysql-mysql-res) :type mysql-mysql-res-ptr-def)
294   (types nil :type list)
295   (num-fields 0 :type fixnum)
296   (full-set nil :type boolean))
297
298
299 (defmethod database-query-result-set ((query-expression string)
300                                       (database mysql-database)
301                                       &key full-set result-types)
302   (let ((mysql-ptr (database-mysql-ptr database)))
303     (declare (type mysql-mysql-ptr-def mysql-ptr))
304     (when (database-execute-command query-expression database)
305       (let ((res-ptr (if full-set
306                          (mysql-store-result mysql-ptr)
307                          (mysql-use-result mysql-ptr))))
308         (declare (type mysql-mysql-res-ptr-def res-ptr))
309         (if (not (uffi:null-pointer-p res-ptr))
310             (let* ((num-fields (mysql-num-fields res-ptr))
311                    (result-set (make-mysql-result-set
312                                 :res-ptr res-ptr
313                                 :num-fields num-fields
314                                 :full-set full-set
315                                 :types
316                                 (canonicalize-types
317                                  result-types res-ptr))))
318               (if full-set
319                   (values result-set
320                           num-fields
321                           (mysql-num-rows res-ptr))
322                   (values result-set
323                           num-fields)))
324             (error 'sql-database-data-error
325                    :database database
326                    :expression query-expression
327                    :error-id (mysql-errno mysql-ptr)
328                    :message (mysql-error-string mysql-ptr))))
329       )))
330
331 (defmethod database-dump-result-set (result-set (database mysql-database))
332   (mysql-free-result (mysql-result-set-res-ptr result-set))
333   t)
334
335
336 (defmethod database-store-next-row (result-set (database mysql-database) list)
337   (let* ((res-ptr (mysql-result-set-res-ptr result-set))
338          (row (mysql-fetch-row res-ptr))
339          (lengths (mysql-fetch-lengths res-ptr))
340          (types (mysql-result-set-types result-set)))
341     (declare (type mysql-mysql-res-ptr-def res-ptr)
342              (type mysql-row-def row))
343     (unless (uffi:null-pointer-p row)
344       (loop for i from 0 below (mysql-result-set-num-fields result-set)
345             for rest on list
346             do
347             (setf (car rest)
348                   (convert-raw-field
349                    (uffi:deref-array row '(:array (* :unsigned-char)) i)
350                    (nth i types)
351                    :length
352                    (uffi:deref-array lengths '(:array :unsigned-long) i)
353                    :encoding (encoding database))))
354       list)))
355
356
357 ;; Table and attribute introspection
358
359 (defmethod database-list-tables ((database mysql-database) &key (owner nil))
360   (declare (ignore owner))
361   (cond
362    ((eql #\5 (char (database-server-info database) 0))
363     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
364           when (and (string-equal type "base table")
365                     (not (and (>= (length name) 11)
366                               (string-equal (subseq name 0 11) "_CLSQL_SEQ_"))))
367           collect name))
368    (t
369     (remove-if #'(lambda (s)
370                    (and (>= (length s) 11)
371                         (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
372                (mapcar #'car (database-query "SHOW TABLES" database nil nil))))))
373
374 (defmethod database-list-views ((database mysql-database)
375                                 &key (owner nil))
376   (declare (ignore owner))
377   (cond
378    ((eql #\5 (char (database-server-info database) 0))
379     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
380           when (string-equal type "view")
381           collect name))
382      (t
383       nil)))
384
385 (defmethod database-list-indexes ((database mysql-database)
386                                   &key (owner nil))
387   (let ((result '()))
388     (dolist (table (database-list-tables database :owner owner) result)
389       (setq result
390         (append (database-list-table-indexes table database :owner owner)
391                 result)))))
392
393 (defmethod database-list-table-indexes (table (database mysql-database)
394                                         &key (owner nil))
395   (declare (ignore owner))
396   (do ((results nil)
397        (rows (database-query
398               (format nil "SHOW INDEX FROM ~A" (escaped-database-identifier
399                                                 table database))
400               database nil nil)
401              (cdr rows)))
402       ((null rows) (nreverse results))
403     (let ((col (nth 2 (car rows))))
404       (unless (find col results :test #'string-equal)
405         (push col results)))))
406
407 (defmethod database-list-attributes ((table string) (database mysql-database)
408                                      &key (owner nil))
409   (declare (ignore owner))
410   (mapcar #'car
411           (database-query
412            (format nil "SHOW COLUMNS FROM ~A" (escaped-database-identifier
413                                                 table database))
414            database nil nil)))
415
416 (defmethod database-attribute-type (attribute (table string)
417                                     (database mysql-database)
418                                     &key (owner nil))
419   (declare (ignore owner))
420   (let ((row (car (database-query
421                    (format nil
422                            "SHOW COLUMNS FROM ~A LIKE '~A'"
423                            (escaped-database-identifier
424                             table database)
425                            (unescaped-database-identifier
426                             attribute database))
427                    database nil nil))))
428     (let* ((raw-type (second row))
429            (null (third row))
430            (start-length (position #\( raw-type))
431            (type (if start-length
432                      (subseq raw-type 0 start-length)
433                      raw-type))
434            (length (when start-length
435                      (parse-integer (subseq raw-type (1+ start-length))
436                                     :junk-allowed t))))
437       (when type
438         (values (ensure-keyword type) length nil (if (string-equal null "YES") 1 0))))))
439
440 ;;; Sequence functions
441
442 (defmethod database-create-sequence (sequence-name
443                                      (database mysql-database))
444   (let ((table-name (%sequence-name-to-table sequence-name database)))
445     (database-execute-command
446      (concatenate 'string "CREATE TABLE " table-name
447                   " (id int NOT NULL PRIMARY KEY AUTO_INCREMENT)")
448      database)
449     (database-execute-command
450      (concatenate 'string "INSERT INTO " table-name
451                   " VALUES (-1)")
452      database)))
453
454 (defmethod database-drop-sequence (sequence-name
455                                    (database mysql-database))
456   (database-execute-command
457    (concatenate 'string "DROP TABLE "
458                 (%sequence-name-to-table sequence-name database))
459    database))
460
461 (defmethod database-list-sequences ((database mysql-database)
462                                     &key (owner nil))
463   (declare (ignore owner))
464   (mapcan #'(lambda (s)
465               (let ((sn (%table-name-to-sequence-name (car s))))
466                 (and sn (list (car s) sn))))
467           (database-query "SHOW TABLES" database nil nil)))
468
469 (defmethod database-set-sequence-position (sequence-name
470                                            (position integer)
471                                            (database mysql-database))
472   (database-execute-command
473    (format nil "UPDATE ~A SET id=~A" (%sequence-name-to-table sequence-name database)
474            position)
475    database)
476   (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database)))
477
478 (defmethod database-sequence-next (sequence-name (database mysql-database))
479   (without-interrupts
480    (database-execute-command
481     (concatenate 'string "UPDATE " (%sequence-name-to-table sequence-name database)
482                  " SET id=LAST_INSERT_ID(id+1)")
483     database)
484    (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database))))
485
486 (defmethod database-sequence-last (sequence-name (database mysql-database))
487   (without-interrupts
488     (caar (database-query
489            (concatenate 'string "SELECT id from "
490                         (%sequence-name-to-table sequence-name database))
491            database :auto nil))))
492
493 (defmethod database-last-auto-increment-id ((database mysql-database) table column)
494   (declare (ignore table column))
495   (car (query "SELECT LAST_INSERT_ID();"
496              :flatp t :field-names nil
497              :database database)))
498
499 (defmethod database-create (connection-spec (type (eql :mysql)))
500   (destructuring-bind (host name user password) connection-spec
501     (let ((database (database-connect (list host "" user password)
502                                       type)))
503       (setf (slot-value database 'clsql-sys::state) :open)
504       (unwind-protect
505            (database-execute-command (format nil "create database ~A" name) database)
506         (database-disconnect database)))))
507
508 (defmethod database-destroy (connection-spec (type (eql :mysql)))
509   (destructuring-bind (host name user password) connection-spec
510     (let ((database (database-connect (list host "" user password)
511                                       type)))
512       (setf (slot-value database 'clsql-sys::state) :open)
513       (unwind-protect
514           (database-execute-command (format nil "drop database ~A" name) database)
515         (database-disconnect database)))))
516
517 (defmethod database-probe (connection-spec (type (eql :mysql)))
518   (when (find (second connection-spec) (database-list connection-spec type)
519               :test #'string-equal)
520     t))
521
522 (defmethod database-list (connection-spec (type (eql :mysql)))
523   (destructuring-bind (host name user password &optional port options) connection-spec
524     (declare (ignore options))
525     (let ((database (database-connect (list host (or name "mysql")
526                                             user password port) type)))
527       (unwind-protect
528            (progn
529              (setf (slot-value database 'clsql-sys::state) :open)
530              (mapcar #'car (database-query "show databases" database :auto nil)))
531         (progn
532           (database-disconnect database)
533           (setf (slot-value database 'clsql-sys::state) :closed))))))
534
535
536 ;;; Prepared statements
537
538 (defclass mysql-stmt ()
539   ((database :initarg :database :reader database)
540    (stmt :initarg :stmt :accessor stmt)
541    (input-bind :initarg :input-bind :reader input-bind)
542    (output-bind :initarg :output-bind :reader output-bind)
543    (types :initarg :types :reader types)
544    (result-set :initarg :result-set :reader result-set)
545    (num-fields :initarg :num-fields :reader num-fields)
546    (field-names :initarg :field-names :accessor stmt-field-names)
547    (length-ptr :initarg :length-ptr :reader length-ptr)
548    (is-null-ptr :initarg :is-null-ptr :reader is-null-ptr)
549    (result-types :initarg :result-types :reader result-types)))
550
551 (defun clsql-type->mysql-type (type)
552   (cond
553     ((in type :null) mysql-field-types#null)
554     ((in type :int :integer) mysql-field-types#long)
555     ((in type :short) mysql-field-types#short)
556     ((in type :bigint) mysql-field-types#longlong)
557     ((in type :float :double :number) mysql-field-types#double)
558     ((and (consp type) (in (car type) :char :string :varchar)) mysql-field-types#var-string)
559     ((or (eq type :blob) (and (consp type) (in (car type) :blob))) mysql-field-types#var-string)
560     (t
561        (error 'sql-user-error
562               :message
563               (format nil "Unknown clsql type ~A." type)))))
564
565 #+mysql-client-v4.1
566 (defmethod database-prepare (sql-stmt types (database mysql-database) result-types field-names)
567   (let* ((mysql-ptr (database-mysql-ptr database))
568          (stmt (mysql-stmt-init mysql-ptr)))
569     (when (uffi:null-pointer-p stmt)
570       (error 'sql-database-error
571              :error-id (mysql-errno mysql-ptr)
572              :message (mysql-error-string mysql-ptr)))
573
574     (uffi:with-cstring (native-query sql-stmt)
575       (unless (zerop (mysql-stmt-prepare stmt native-query (uffi:foreign-encoded-octet-count
576                                                             sql-stmt :encoding (encoding database))))
577         (mysql-stmt-close stmt)
578         (error 'sql-database-error
579                :error-id (mysql-errno mysql-ptr)
580                :message (mysql-error-string mysql-ptr))))
581
582     (unless (= (mysql-stmt-param-count stmt) (length types))
583       (mysql-stmt-close stmt)
584       (error 'sql-database-error
585              :message
586              (format nil "Mysql param count (~D) does not match number of types (~D)"
587                      (mysql-stmt-param-count stmt) (length types))))
588
589     (let ((rs (mysql-stmt-result-metadata stmt)))
590       (when (uffi:null-pointer-p rs)
591         (warn "mysql_stmt_result_metadata returned NULL")
592         #+nil
593         (mysql-stmt-close stmt)
594         #+nil
595         (error 'sql-database-error
596                :message "mysql_stmt_result_metadata returned NULL"))
597
598       (let ((input-bind (uffi:allocate-foreign-object 'mysql-bind (length types)))
599             (mysql-types (mapcar 'clsql-type->mysql-type types))
600             field-vec num-fields is-null-ptr output-bind length-ptr)
601
602         (print 'a)
603         (dotimes (i (length types))
604           (let* ((binding (uffi:deref-array input-bind '(:array mysql-bind) i)))
605             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type)
606               (nth i mysql-types))
607             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)))
608
609         (print 'b)
610         (unless (uffi:null-pointer-p rs)
611           (setq field-vec (mysql-fetch-fields rs)
612                 num-fields (mysql-num-fields rs)
613                 is-null-ptr (uffi:allocate-foreign-object :byte num-fields)
614                 output-bind (uffi:allocate-foreign-object 'mysql-bind num-fields)
615                 length-ptr (uffi:allocate-foreign-object :unsigned-long num-fields))
616           (dotimes (i num-fields)
617             (declare (fixnum i))
618             (let* ((field (uffi:deref-array field-vec '(:array mysql-field) i))
619                    (type (uffi:get-slot-value field 'mysql-field 'type))
620                    (binding (uffi:deref-array output-bind '(:array mysql-bind) i)))
621               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type) type)
622
623               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)
624               #+need-to-allocate-foreign-object-for-this
625               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::is-null)
626                 (+ i (uffi:pointer-address is-null-ptr)))
627               #+need-to-allocate-foreign-object-for-this
628               (setf (uffi:get-slot-value binding 'mysql-bind 'length)
629                 (+ (* i 8) (uffi:pointer-address length-ptr)))
630
631               (case type
632                 ((#.mysql-field-types#var-string #.mysql-field-types#string
633                   #.mysql-field-types#tiny-blob #.mysql-field-types#blob
634                   #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
635                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 1024)
636                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
637                    (uffi:allocate-foreign-object :unsigned-char 1024)))
638                 (#.mysql-field-types#tiny
639                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
640                    (uffi:allocate-foreign-object :byte)))
641                 (#.mysql-field-types#short
642                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
643                    (uffi:allocate-foreign-object :short)))
644                 (#.mysql-field-types#long
645                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
646                    ;; segfaults if supply :int on amd64
647                    (uffi:allocate-foreign-object :long)))
648                 #+64bit
649                 (#.mysql-field-types#longlong
650                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
651                    (uffi:allocate-foreign-object :long)))
652                 (#.mysql-field-types#float
653                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
654                    (uffi:allocate-foreign-object :float)))
655                 (#.mysql-field-types#double
656                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
657                    (uffi:allocate-foreign-object :double)))
658                 ((#.mysql-field-types#time #.mysql-field-types#date
659                   #.mysql-field-types#datetime #.mysql-field-types#timestamp)
660                  (uffi:allocate-foreign-object 'mysql-time))
661                 (t
662                  (error "mysql type ~D not supported." type)))))
663
664           (unless (zerop (mysql-stmt-bind-result stmt output-bind))
665             (mysql-stmt-close stmt)
666             (error 'sql-database-error
667                    :error-id (mysql-stmt-errno stmt)
668                    :message  (uffi:convert-from-cstring
669                               (mysql-stmt-error stmt)))))
670
671         (make-instance 'mysql-stmt
672           :database database
673           :stmt stmt
674           :num-fields num-fields
675           :input-bind input-bind
676           :output-bind output-bind
677           :result-set rs
678           :result-types result-types
679           :length-ptr length-ptr
680           :is-null-ptr is-null-ptr
681           :types mysql-types
682           :field-names field-names)))))
683
684 #+mysql-client-v4.1
685 (defmethod database-bind-parameter ((stmt mysql-stmt) position value)
686   ;; FIXME: will need to allocate bind structure. This should probably be
687   ;; done in C since the API is not mature and may change
688   (let ((binding (uffi:deref-array (input-bind stmt) '(:array mysql-bind) (1- position)))
689         (type (nth (1- position) (types stmt))))
690     (setf (uffi:get-slot-value binding 'mysql-bind 'length) 0)
691     (cond
692      ((null value)
693       (when (is-null-ptr stmt)
694         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 1)))
695      (t
696       (when (is-null-ptr stmt)
697         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 0))
698       (case type
699         (#.mysql-field-types#long
700          (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer) value))
701         (t
702          (warn "Unknown input bind type ~D." type))
703         )))))
704
705 #+mysql-client-v4.1
706 (defmethod database-run-prepared ((stmt mysql-stmt))
707   (print 'a1)
708   (when (input-bind stmt)
709     (unless (zerop (mysql-stmt-bind-param (stmt stmt) (input-bind stmt)))
710       (error 'sql-database-error
711              :error-id (mysql-stmt-errno (stmt stmt))
712              :message  (uffi:convert-from-cstring
713                         (mysql-stmt-error (stmt stmt))))))
714   (print 'a2)
715   (unless (zerop (mysql-stmt-execute (stmt stmt)))
716     (error 'sql-database-error
717            :error-id (mysql-stmt-errno (stmt stmt))
718            :message  (uffi:convert-from-cstring
719                       (mysql-stmt-error (stmt stmt)))))
720   (print 'a3)
721   (unless (zerop (mysql-stmt-store-result (stmt stmt)))
722     (error 'sql-database-error
723            :error-id (mysql-stmt-errno (stmt stmt))
724            :message  (uffi:convert-from-cstring
725                       (mysql-stmt-error (stmt stmt)))))
726   (database-fetch-prepared-rows stmt))
727
728 #+mysql-client-v4.1
729 (defun database-fetch-prepared-rows (stmt)
730   (do ((rc (mysql-stmt-fetch (stmt stmt)) (mysql-stmt-fetch (stmt stmt)))
731        (num-fields (num-fields stmt))
732        (rows '()))
733       ((not (zerop rc)) (nreverse rows))
734     (push
735      (loop for i from 0 below num-fields
736            collect
737            (let ((is-null
738                   (not (zerop (uffi:ensure-char-integer
739                                (uffi:deref-array (is-null-ptr stmt) '(:array :byte) i))))))
740              (unless is-null
741                (let* ((bind (uffi:deref-array (output-bind stmt) '(:array mysql-bind) i))
742                       (type (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer-type))
743                       (buffer (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer)))
744                  (case type
745                    ((#.mysql-field-types#var-string #.mysql-field-types#string
746                      #.mysql-field-types#tiny-blob #.mysql-field-types#blob
747                      #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
748                     (uffi:convert-from-foreign-string buffer :encoding (encoding (database stmt))))
749                    (#.mysql-field-types#tiny
750                     (uffi:ensure-char-integer
751                      (uffi:deref-pointer buffer :byte)))
752                    (#.mysql-field-types#short
753                     (uffi:deref-pointer buffer :short))
754                    (#.mysql-field-types#long
755                     (uffi:deref-pointer buffer :int))
756                    #+64bit
757                    (#.mysql-field-types#longlong
758                      (uffi:deref-pointer buffer :long))
759                    (#.mysql-field-types#float
760                     (uffi:deref-pointer buffer :float))
761                    (#.mysql-field-types#double
762                     (uffi:deref-pointer buffer :double))
763                    ((#.mysql-field-types#time #.mysql-field-types#date
764                                               #.mysql-field-types#datetime #.mysql-field-types#timestamp)
765                     (let ((year (uffi:get-slot-value buffer 'mysql-time 'mysql::year))
766                           (month (uffi:get-slot-value buffer 'mysql-time 'mysql::month))
767                           (day (uffi:get-slot-value buffer 'mysql-time 'mysql::day))
768                           (hour (uffi:get-slot-value buffer 'mysql-time 'mysql::hour))
769                           (minute (uffi:get-slot-value buffer 'mysql-time 'mysql::minute))
770                           (second (uffi:get-slot-value buffer 'mysql-time 'mysql::second)))
771                       (db-timestring
772                        (make-time :year year :month month :day day :hour hour
773                                   :minute minute :second second))))
774                    (t
775                     (list type)))))))
776      rows)))
777
778
779
780
781 #+mysql-client-v4.1
782 (defmethod database-free-prepared ((stmt mysql-stmt))
783   (with-slots (stmt) stmt
784     (mysql-stmt-close stmt))
785   )
786
787
788 ;;; Database capabilities
789
790 (defmethod db-type-use-column-on-drop-index? ((db-type (eql :mysql)))
791   t)
792
793 (defmethod db-type-has-views? ((db-type (eql :mysql)))
794   #+mysql-client-v5 t
795   #-mysql-client-v5 nil)
796
797 (defmethod db-type-has-subqueries? ((db-type (eql :mysql)))
798   #+(or mysql-client-v4.1 mysql-client-v5) t
799   #-(or mysql-client-v4.1 mysql-client-v5) nil)
800
801 (defmethod db-type-has-boolean-where? ((db-type (eql :mysql)))
802   #+(or mysql-client-v4.1 mysql-client-v5) t
803   #-(or mysql-client-v4.1 mysql-client-v5) nil)
804
805 (defmethod db-type-has-union? ((db-type (eql :mysql)))
806   (not (eql (schar mysql::*mysql-client-info* 0) #\3)))
807
808 (defmethod db-type-transaction-capable? ((db-type (eql :mysql)) database)
809   (let ((tuple (car (database-query "SHOW VARIABLES LIKE 'HAVE_INNODB'" database :auto nil))))
810     (and tuple (string-equal "YES" (second tuple)))))
811
812 (defmethod db-type-has-prepared-stmt? ((db-type (eql :mysql)))
813   #+(or mysql-client-v4.1 mysql-client-v5) t
814   #-(or mysql-client-v4.1 mysql-client-v5) nil)
815
816 (defmethod db-type-has-auto-increment? ((db-type (eql :mysql)))
817   t)
818
819 (when (clsql-sys:database-type-library-loaded :mysql)
820   (clsql-sys:initialize-database-type :database-type :mysql))