r10077: * multiple: Apply patch from Joerg Hoehle with multiple
[clsql.git] / sql / oodml.lisp
1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;;
4 ;;;; $Id$
5 ;;;;
6 ;;;; The CLSQL Object Oriented Data Manipulation Language (OODML).
7 ;;;;
8 ;;;; This file is part of CLSQL.
9 ;;;;
10 ;;;; CLSQL users are granted the rights to distribute and use this software
11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
13 ;;;; *************************************************************************
14
15 (in-package #:clsql-sys)
16
17
18 (defun key-qualifier-for-instance (obj &key (database *default-database*))
19   (let ((tb (view-table (class-of obj))))
20     (flet ((qfk (k)
21              (sql-operation '==
22                             (sql-expression :attribute
23                                             (view-class-slot-column k)
24                                             :table tb)
25                             (db-value-from-slot
26                              k
27                              (slot-value obj (slot-definition-name k))
28                              database))))
29       (let* ((keys (keyslots-for-class (class-of obj)))
30              (keyxprs (mapcar #'qfk (reverse keys))))
31         (cond
32           ((= (length keyxprs) 0) nil)
33           ((= (length keyxprs) 1) (car keyxprs))
34           ((> (length keyxprs) 1) (apply #'sql-operation 'and keyxprs)))))))
35
36 ;;
37 ;; Function used by 'generate-selection-list'
38 ;;
39
40 (defun generate-attribute-reference (vclass slotdef)
41   (cond
42    ((eq (view-class-slot-db-kind slotdef) :base)
43     (sql-expression :attribute (view-class-slot-column slotdef)
44                     :table (view-table vclass)))
45    ((eq (view-class-slot-db-kind slotdef) :key)
46     (sql-expression :attribute (view-class-slot-column slotdef)
47                     :table (view-table vclass)))
48    (t nil)))
49
50 ;;
51 ;; Function used by 'find-all'
52 ;;
53
54 (defun generate-selection-list (vclass)
55   (let ((sels nil))
56     (dolist (slotdef (ordered-class-slots vclass))
57       (let ((res (generate-attribute-reference vclass slotdef)))
58         (when res
59           (push (cons slotdef res) sels))))
60     (if sels
61         sels
62         (error "No slots of type :base in view-class ~A" (class-name vclass)))))
63
64
65
66 (defun generate-retrieval-joins-list (vclass retrieval-method)
67   "Returns list of immediate join slots for a class."
68   (let ((join-slotdefs nil))
69     (dolist (slotdef (ordered-class-slots vclass) join-slotdefs)
70       (when (and (eq :join (view-class-slot-db-kind slotdef))
71                  (eq retrieval-method (gethash :retrieval (view-class-slot-db-info slotdef))))
72         (push slotdef join-slotdefs)))))
73
74 (defun generate-immediate-joins-selection-list (vclass)
75   "Returns list of immediate join slots for a class."
76   (let (sels)
77     (dolist (joined-slot (generate-retrieval-joins-list vclass :immediate) sels)
78       (let* ((join-class-name (gethash :join-class (view-class-slot-db-info joined-slot)))
79              (join-class (when join-class-name (find-class join-class-name))))
80         (dolist (slotdef (ordered-class-slots join-class))
81           (let ((res (generate-attribute-reference join-class slotdef)))
82             (when res
83               (push (cons slotdef res) sels))))))
84     sels))
85
86
87 ;; Called by 'get-slot-values-from-view'
88 ;;
89
90 (defmethod update-slot-from-db ((instance standard-db-object) slotdef value)
91   (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
92   (let* ((slot-reader (view-class-slot-db-reader slotdef))
93          (slot-name   (slot-definition-name slotdef))
94          (slot-type   (specified-type slotdef)))
95     (cond ((and value (null slot-reader))
96            (setf (slot-value instance slot-name)
97                  (read-sql-value value (delistify slot-type)
98                                  (view-database instance)
99                                  (database-underlying-type
100                                   (view-database instance)))))
101           ((null value)
102            (update-slot-with-null instance slot-name slotdef))
103           ((typep slot-reader 'string)
104            (setf (slot-value instance slot-name)
105                  (format nil slot-reader value)))
106           ((typep slot-reader 'function)
107            (setf (slot-value instance slot-name)
108                  (apply slot-reader (list value))))
109           (t
110            (error "Slot reader is of an unusual type.")))))
111
112 (defmethod key-value-from-db (slotdef value database) 
113   (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
114   (let ((slot-reader (view-class-slot-db-reader slotdef))
115         (slot-type (specified-type slotdef)))
116     (cond ((and value (null slot-reader))
117            (read-sql-value value (delistify slot-type) database
118                            (database-underlying-type database)))
119           ((null value)
120            nil)
121           ((typep slot-reader 'string)
122            (format nil slot-reader value))
123           ((typep slot-reader 'function)
124            (apply slot-reader (list value)))
125           (t
126            (error "Slot reader is of an unusual type.")))))
127
128 (defun db-value-from-slot (slotdef val database)
129   (let ((dbwriter (view-class-slot-db-writer slotdef))
130         (dbtype (specified-type slotdef)))
131     (typecase dbwriter
132       (string (format nil dbwriter val))
133       (function (apply dbwriter (list val)))
134       (t
135        (database-output-sql-as-type
136         (typecase dbtype
137           (cons (car dbtype))
138           (t dbtype))
139         val database (database-underlying-type database))))))
140
141 (defun check-slot-type (slotdef val)
142   (let* ((slot-type (specified-type slotdef))
143          (basetype (if (listp slot-type) (car slot-type) slot-type)))
144     (when (and slot-type val)
145       (unless (typep val basetype)
146         (error 'sql-user-error
147                :message
148                (format nil "Invalid value ~A in slot ~A, not of type ~A."
149                        val (slot-definition-name slotdef) slot-type))))))
150
151 ;;
152 ;; Called by find-all
153 ;;
154
155 (defmethod get-slot-values-from-view (obj slotdeflist values)
156     (flet ((update-slot (slot-def values)
157              (update-slot-from-db obj slot-def values)))
158       (mapc #'update-slot slotdeflist values)
159       obj))
160
161 (defmethod update-record-from-slot ((obj standard-db-object) slot &key
162                                     (database *default-database*))
163   (let* ((database (or (view-database obj) database))
164          (vct (view-table (class-of obj)))
165          (sd (slotdef-for-slot-with-class slot (class-of obj))))
166     (check-slot-type sd (slot-value obj slot))
167     (let* ((att (view-class-slot-column sd))
168            (val (db-value-from-slot sd (slot-value obj slot) database)))
169       (cond ((and vct sd (view-database obj))
170              (update-records (sql-expression :table vct)
171                              :attributes (list (sql-expression :attribute att))
172                              :values (list val)
173                              :where (key-qualifier-for-instance
174                                      obj :database database)
175                              :database database))
176             ((and vct sd (not (view-database obj)))
177              (insert-records :into (sql-expression :table vct)
178                              :attributes (list (sql-expression :attribute att))
179                              :values (list val)
180                              :database database)
181              (setf (slot-value obj 'view-database) database))
182             (t
183              (error "Unable to update record.")))))
184   (values))
185
186 (defmethod update-record-from-slots ((obj standard-db-object) slots &key
187                                      (database *default-database*))
188   (let* ((database (or (view-database obj) database))
189          (vct (view-table (class-of obj)))
190          (sds (slotdefs-for-slots-with-class slots (class-of obj)))
191          (avps (mapcar #'(lambda (s)
192                            (let ((val (slot-value
193                                        obj (slot-definition-name s))))
194                              (check-slot-type s val)
195                              (list (sql-expression
196                                     :attribute (view-class-slot-column s))
197                                    (db-value-from-slot s val database))))
198                        sds)))
199     (cond ((and avps (view-database obj))
200            (update-records (sql-expression :table vct)
201                            :av-pairs avps
202                            :where (key-qualifier-for-instance
203                                    obj :database database)
204                            :database database))
205           ((and avps (not (view-database obj)))
206            (insert-records :into (sql-expression :table vct)
207                            :av-pairs avps
208                            :database database)
209            (setf (slot-value obj 'view-database) database))
210           (t
211            (error "Unable to update records"))))
212   (values))
213
214 (defmethod update-records-from-instance ((obj standard-db-object)
215                                          &key (database *default-database*))
216   (let ((database (or (view-database obj) database)))
217     (labels ((slot-storedp (slot)
218                (and (member (view-class-slot-db-kind slot) '(:base :key))
219                     (slot-boundp obj (slot-definition-name slot))))
220              (slot-value-list (slot)
221                (let ((value (slot-value obj (slot-definition-name slot))))
222                  (check-slot-type slot value)
223                  (list (sql-expression :attribute (view-class-slot-column slot))
224                        (db-value-from-slot slot value database)))))
225       (let* ((view-class (class-of obj))
226              (view-class-table (view-table view-class))
227              (slots (remove-if-not #'slot-storedp 
228                                    (ordered-class-slots view-class)))
229              (record-values (mapcar #'slot-value-list slots)))
230         (unless record-values
231           (error "No settable slots."))
232         (if (view-database obj)
233             (update-records (sql-expression :table view-class-table)
234                             :av-pairs record-values
235                             :where (key-qualifier-for-instance
236                                     obj :database database)
237                             :database database)
238             (progn
239               (insert-records :into (sql-expression :table view-class-table)
240                               :av-pairs record-values
241                               :database database)
242               (setf (slot-value obj 'view-database) database))))))
243   (values))
244
245 (defmethod delete-instance-records ((instance standard-db-object))
246   (let ((vt (sql-expression :table (view-table (class-of instance))))
247         (vd (view-database instance)))
248     (if vd
249         (let ((qualifier (key-qualifier-for-instance instance :database vd)))
250           (delete-records :from vt :where qualifier :database vd)
251           (setf (slot-value instance 'view-database) nil)
252           (values))
253         (signal-no-database-error vd))))
254
255 (defmethod update-instance-from-records ((instance standard-db-object)
256                                          &key (database *default-database*))
257   (let* ((view-class (find-class (class-name (class-of instance))))
258          (view-table (sql-expression :table (view-table view-class)))
259          (vd (or (view-database instance) database))
260          (view-qual (key-qualifier-for-instance instance :database vd))
261          (sels (generate-selection-list view-class))
262          (res (apply #'select (append (mapcar #'cdr sels)
263                                       (list :from  view-table
264                                             :where view-qual)
265                                       (list :result-types nil)))))
266     (when res
267       (get-slot-values-from-view instance (mapcar #'car sels) (car res)))))
268
269 (defmethod update-slot-from-record ((instance standard-db-object)
270                                     slot &key (database *default-database*))
271   (let* ((view-class (find-class (class-name (class-of instance))))
272          (view-table (sql-expression :table (view-table view-class)))
273          (vd (or (view-database instance) database))
274          (view-qual (key-qualifier-for-instance instance :database vd))
275          (slot-def (slotdef-for-slot-with-class slot view-class))
276          (att-ref (generate-attribute-reference view-class slot-def))
277          (res (select att-ref :from  view-table :where view-qual
278                       :result-types nil)))
279     (when res 
280       (get-slot-values-from-view instance (list slot-def) (car res)))))
281
282
283 (defmethod update-slot-with-null ((object standard-db-object)
284                                   slotname
285                                   slotdef)
286   (setf (slot-value object slotname) (slot-value slotdef 'void-value)))
287
288 (defvar +no-slot-value+ '+no-slot-value+)
289
290 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
291   (let* ((class (find-class classname))
292          (sld (slotdef-for-slot-with-class slot class)))
293     (if sld
294         (if (eq value +no-slot-value+)
295             (sql-expression :attribute (view-class-slot-column sld)
296                             :table (view-table class))
297             (db-value-from-slot
298              sld
299              value
300              database))
301         (error "Unknown slot ~A for class ~A" slot classname))))
302
303 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
304         (declare (ignore database))
305         (let* ((class (find-class classname)))
306           (unless (view-table class)
307             (error "No view-table for class ~A"  classname))
308           (sql-expression :table (view-table class))))
309
310
311 (defmethod database-get-type-specifier (type args database db-type)
312   (declare (ignore type args database db-type))
313   (format nil "VARCHAR(~D)" *default-string-length*))
314
315 (defmethod database-get-type-specifier ((type (eql 'integer)) args database db-type)
316   (declare (ignore database db-type))
317   (if args
318       (format nil "INT(~A)" (car args))
319     "INT"))
320
321 (deftype tinyint () 
322   "An 8-bit integer, this width may vary by SQL implementation."
323   'integer)
324
325 (defmethod database-get-type-specifier ((type (eql 'tinyint)) args database db-type)
326   (declare (ignore args database db-type))
327   "INT")
328
329 (deftype smallint () 
330   "An integer smaller than a 32-bit integer. this width may vary by SQL implementation."
331   'integer)
332
333 (defmethod database-get-type-specifier ((type (eql 'smallint)) args database db-type)
334   (declare (ignore args database db-type))
335   "INT")
336
337 (deftype mediumint () 
338   "An integer smaller than a 32-bit integer, but may be larger than a smallint. This width may vary by SQL implementation."
339   'integer)
340
341 (defmethod database-get-type-specifier ((type (eql 'mediumint)) args database db-type)
342   (declare (ignore args database db-type))
343   "INT")
344
345 (deftype bigint () 
346   "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
347   'integer)
348
349 (defmethod database-get-type-specifier ((type (eql 'bigint)) args database db-type)
350   (declare (ignore args database db-type))
351   "BIGINT")
352
353 (deftype varchar (&optional size) 
354   "A variable length string for the SQL varchar type."
355   (declare (ignore size))
356   'string)
357
358 (defmethod database-get-type-specifier ((type (eql 'varchar)) args
359                                         database db-type)
360   (declare (ignore database db-type))
361   (if args
362       (format nil "VARCHAR(~A)" (car args))
363       (format nil "VARCHAR(~D)" *default-string-length*)))
364
365 (defmethod database-get-type-specifier ((type (eql 'string)) args database db-type)
366   (declare (ignore database db-type))
367   (if args
368       (format nil "CHAR(~A)" (car args))
369       (format nil "VARCHAR(~D)" *default-string-length*)))
370
371 (deftype universal-time () 
372   "A positive integer as returned by GET-UNIVERSAL-TIME."
373   '(integer 1 *))
374
375 (defmethod database-get-type-specifier ((type (eql 'universal-time)) args database db-type)
376   (declare (ignore args database db-type))
377   "BIGINT")
378
379 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database db-type)
380   (declare (ignore args database db-type))
381   "TIMESTAMP")
382
383 (defmethod database-get-type-specifier ((type (eql 'duration)) args database db-type)
384   (declare (ignore database args db-type))
385   "VARCHAR")
386
387 (defmethod database-get-type-specifier ((type (eql 'money)) args database db-type)
388   (declare (ignore database args db-type))
389   "INT8")
390
391 #+ignore
392 (deftype char (&optional len)
393   "A lisp type for the SQL CHAR type."
394   `(string ,len))
395
396 (defmethod database-get-type-specifier ((type (eql 'float)) args database db-type)
397   (declare (ignore database db-type))
398   (if args
399       (format nil "FLOAT(~A)" (car args))
400       "FLOAT"))
401
402 (defmethod database-get-type-specifier ((type (eql 'long-float)) args database db-type)
403   (declare (ignore database db-type))
404   (if args
405       (format nil "FLOAT(~A)" (car args))
406       "FLOAT"))
407
408 (deftype generalized-boolean () 
409   "A type which outputs a SQL boolean value, though any lisp type can be stored in the slot."
410   t)
411
412 (defmethod database-get-type-specifier ((type (eql 'boolean)) args database db-type)
413   (declare (ignore args database db-type))
414   "BOOL")
415
416 (defmethod database-get-type-specifier ((type (eql 'generalized-boolean)) args database db-type)
417   (declare (ignore args database db-type))
418   "BOOL")
419
420 (defmethod database-get-type-specifier ((type (eql 'number)) args database db-type)
421   (declare (ignore database db-type))
422   (cond
423    ((and (consp args) (= (length args) 2))
424     (format nil "NUMBER(~D,~D)" (first args) (second args)))
425    ((and (consp args) (= (length args) 1))
426     (format nil "NUMBER(~D)" (first args)))
427    (t
428     "NUMBER")))
429
430 (defmethod database-get-type-specifier ((type (eql 'char)) args database db-type)
431   (declare (ignore database db-type))
432   (if args
433       (format nil "CHAR(~D)" (first args))
434       "CHAR(1)"))
435
436
437 (defmethod database-output-sql-as-type (type val database db-type)
438   (declare (ignore type database db-type))
439   val)
440
441 (defmethod database-output-sql-as-type ((type (eql 'list)) val database db-type)
442   (declare (ignore database db-type))
443   (progv '(*print-circle* *print-array*) '(t t)
444     (let ((escaped (prin1-to-string val)))
445       (substitute-char-string
446        escaped #\Null " "))))
447
448 (defmethod database-output-sql-as-type ((type (eql 'symbol)) val database db-type)
449   (declare (ignore database db-type))
450   (if val
451     (concatenate 'string
452                  (package-name (symbol-package val))
453                  "::"
454                  (symbol-name val))
455     ""))
456
457 (defmethod database-output-sql-as-type ((type (eql 'keyword)) val database db-type)
458   (declare (ignore database db-type))
459   (if val
460       (symbol-name val)
461       ""))
462
463 (defmethod database-output-sql-as-type ((type (eql 'vector)) val database db-type)
464   (declare (ignore database db-type))
465   (progv '(*print-circle* *print-array*) '(t t)
466     (prin1-to-string val)))
467
468 (defmethod database-output-sql-as-type ((type (eql 'array)) val database db-type)
469   (declare (ignore database db-type))
470   (progv '(*print-circle* *print-array*) '(t t)
471     (prin1-to-string val)))
472
473 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database db-type)
474   (declare (ignore database db-type))
475   (if val "t" "f"))
476
477 (defmethod database-output-sql-as-type ((type (eql 'generalized-boolean)) val database db-type)
478   (declare (ignore database db-type))
479   (if val "t" "f"))
480
481 (defmethod database-output-sql-as-type ((type (eql 'string)) val database db-type)
482   (declare (ignore database db-type))
483   val)
484
485 (defmethod database-output-sql-as-type ((type (eql 'char)) val database db-type)
486   (declare (ignore database db-type))
487   (etypecase val
488     (character (write-to-string val))
489     (string val)))
490
491 (defmethod database-output-sql-as-type ((type (eql 'float)) val database db-type)
492   (declare (ignore database db-type))
493   (let ((*read-default-float-format* (type-of val)))
494     (format nil "~F" val)))
495
496 (defmethod read-sql-value (val type database db-type)
497   (declare (ignore type database db-type))
498   (read-from-string val))
499
500 (defmethod read-sql-value (val (type (eql 'string)) database db-type)
501   (declare (ignore database db-type))
502   val)
503
504 (defmethod read-sql-value (val (type (eql 'varchar)) database db-type)
505   (declare (ignore database db-type))
506   val)
507
508 (defmethod read-sql-value (val (type (eql 'char)) database db-type)
509   (declare (ignore database db-type))
510   (schar val 0))
511               
512 (defmethod read-sql-value (val (type (eql 'keyword)) database db-type)
513   (declare (ignore database db-type))
514   (when (< 0 (length val))
515     (intern (symbol-name-default-case val) 
516             (find-package '#:keyword))))
517
518 (defmethod read-sql-value (val (type (eql 'symbol)) database db-type)
519   (declare (ignore database db-type))
520   (when (< 0 (length val))
521     (unless (string= val (symbol-name-default-case "NIL"))
522       (read-from-string val))))
523
524 (defmethod read-sql-value (val (type (eql 'integer)) database db-type)
525   (declare (ignore database db-type))
526   (etypecase val
527     (string
528      (unless (string-equal "NIL" val)
529        (parse-integer val)))
530     (number val)))
531
532 (defmethod read-sql-value (val (type (eql 'smallint)) database db-type)
533   (declare (ignore database db-type))
534   (etypecase val
535     (string
536      (unless (string-equal "NIL" val)
537        (parse-integer val)))
538     (number val)))
539
540 (defmethod read-sql-value (val (type (eql 'bigint)) database db-type)
541   (declare (ignore database db-type))
542   (etypecase val
543     (string
544      (unless (string-equal "NIL" val)
545        (parse-integer val)))
546     (number val)))
547
548 (defmethod read-sql-value (val (type (eql 'float)) database db-type)
549   (declare (ignore database db-type))
550   ;; writing 1.0 writes 1, so we we *really* want a float, must do (float ...)
551   (etypecase val
552     (string
553      (float (read-from-string val)))
554     (float
555      val)))
556
557 (defmethod read-sql-value (val (type (eql 'boolean)) database db-type)
558   (declare (ignore database db-type))
559   (equal "t" val))
560
561 (defmethod read-sql-value (val (type (eql 'generalized-boolean)) database db-type)
562   (declare (ignore database db-type))
563   (equal "t" val))
564
565 (defmethod read-sql-value (val (type (eql 'number)) database db-type)
566   (declare (ignore database db-type))
567   (etypecase val
568     (string
569      (unless (string-equal "NIL" val)
570        (read-from-string val)))
571     (number val)))
572
573 (defmethod read-sql-value (val (type (eql 'universal-time)) database db-type)
574   (declare (ignore database db-type))
575   (unless (eq 'NULL val)
576     (etypecase val
577       (string
578        (parse-integer val))
579       (number val))))
580
581 (defmethod read-sql-value (val (type (eql 'wall-time)) database db-type)
582   (declare (ignore database db-type))
583   (unless (eq 'NULL val)
584     (parse-timestring val)))
585
586 (defmethod read-sql-value (val (type (eql 'duration)) database db-type)
587   (declare (ignore database db-type))
588   (unless (or (eq 'NULL val)
589               (equal "NIL" val))
590     (parse-timestring val)))
591
592 ;; ------------------------------------------------------------
593 ;; Logic for 'faulting in' :join slots
594
595 ;; this works, but is inefficient requiring (+ 1 n-rows)
596 ;; SQL queries
597 #+ignore
598 (defun fault-join-target-slot (class object slot-def)
599   (let* ((res (fault-join-slot-raw class object slot-def))
600          (dbi (view-class-slot-db-info slot-def))
601          (target-name (gethash :target-slot dbi))
602          (target-class (find-class target-name)))
603     (when res
604       (mapcar (lambda (obj)
605                 (list 
606                  (car
607                   (fault-join-slot-raw 
608                    target-class
609                    obj
610                    (find target-name (class-slots (class-of obj))
611                          :key #'slot-definition-name)))
612                  obj))
613               res)
614       #+ignore ;; this doesn't work when attempting to call slot-value
615       (mapcar (lambda (obj)
616                 (cons obj (slot-value obj ts))) res))))
617
618 (defun fault-join-target-slot (class object slot-def)
619   (let* ((dbi (view-class-slot-db-info slot-def))
620          (ts (gethash :target-slot dbi))
621          (jc (gethash :join-class dbi))
622          (ts-view-table (view-table (find-class ts)))
623          (jc-view-table (view-table (find-class jc)))
624          (tdbi (view-class-slot-db-info 
625                 (find ts (class-slots (find-class jc))
626                       :key #'slot-definition-name)))
627          (retrieval (gethash :retrieval tdbi))
628          (jq (join-qualifier class object slot-def))
629          (key (slot-value object (gethash :home-key dbi))))
630     (when jq
631       (ecase retrieval
632         (:immediate
633          (let ((res
634                 (find-all (list ts) 
635                           :inner-join (sql-expression :table jc-view-table)
636                           :on (sql-operation 
637                                '==
638                                (sql-expression 
639                                 :attribute (gethash :foreign-key tdbi) 
640                                 :table ts-view-table)
641                                (sql-expression 
642                                 :attribute (gethash :home-key tdbi) 
643                                 :table jc-view-table))
644                           :where jq
645                           :result-types :auto)))
646            (mapcar #'(lambda (i)
647                        (let* ((instance (car i))
648                               (jcc (make-instance jc :view-database (view-database instance))))
649                          (setf (slot-value jcc (gethash :foreign-key dbi)) 
650                                key)
651                          (setf (slot-value jcc (gethash :home-key tdbi)) 
652                                (slot-value instance (gethash :foreign-key tdbi)))
653                       (list instance jcc)))
654                    res)))
655         (:deferred
656             ;; just fill in minimal slots
657             (mapcar
658              #'(lambda (k)
659                  (let ((instance (make-instance ts :view-database (view-database object)))
660                        (jcc (make-instance jc :view-database (view-database object)))
661                        (fk (car k)))
662                    (setf (slot-value instance (gethash :home-key tdbi)) fk)
663                    (setf (slot-value jcc (gethash :foreign-key dbi)) 
664                          key)
665                    (setf (slot-value jcc (gethash :home-key tdbi)) 
666                          fk)
667                    (list instance jcc)))
668              (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
669                      :from (sql-expression :table jc-view-table)
670                      :where jq)))))))
671
672
673 ;;; Remote Joins
674
675 (defvar *default-update-objects-max-len* nil
676   "The default value to use for the MAX-LEN keyword argument to
677   UPDATE-OBJECT-JOINS.")
678
679 (defun update-objects-joins (objects &key (slots t) (force-p t)
680                             class-name (max-len
681                             *default-update-objects-max-len*))
682   "Updates from the records of the appropriate database tables
683 the join slots specified by SLOTS in the supplied list of View
684 Class instances OBJECTS.  SLOTS is t by default which means that
685 all join slots with :retrieval :immediate are updated. CLASS-NAME
686 is used to specify the View Class of all instance in OBJECTS and
687 default to nil which means that the class of the first instance
688 in OBJECTS is used. FORCE-P is t by default which means that all
689 join slots are updated whereas a value of nil means that only
690 unbound join slots are updated. MAX-LEN defaults to
691 *DEFAULT-UPDATE-OBJECTS-MAX-LEN* and when non-nil specifies that
692 UPDATE-OBJECT-JOINS may issue multiple database queries with a
693 maximum of MAX-LEN instances updated in each query."
694   (assert (or (null max-len) (plusp max-len)))
695   (when objects
696     (unless class-name
697       (setq class-name (class-name (class-of (first objects)))))
698     (let* ((class (find-class class-name))
699            (class-slots (ordered-class-slots class))
700            (slotdefs 
701             (if (eq t slots)
702                 (generate-retrieval-joins-list class :deferred)
703               (remove-if #'null
704                          (mapcar #'(lambda (name)
705                                      (let ((slotdef (find name class-slots :key #'slot-definition-name)))
706                                        (unless slotdef
707                                          (warn "Unable to find slot named ~S in class ~S." name class))
708                                        slotdef))
709                                  slots)))))
710       (dolist (slotdef slotdefs)
711         (let* ((dbi (view-class-slot-db-info slotdef))
712                (slotdef-name (slot-definition-name slotdef))
713                (foreign-key (gethash :foreign-key dbi))
714                (home-key (gethash :home-key dbi))
715                (object-keys
716                 (remove-duplicates
717                  (if force-p
718                      (mapcar #'(lambda (o) (slot-value o home-key)) objects)
719                    (remove-if #'null
720                               (mapcar
721                                #'(lambda (o) (if (slot-boundp o slotdef-name)
722                                                  nil
723                                                (slot-value o home-key)))
724                                objects)))))
725                (n-object-keys (length object-keys))
726                (query-len (or max-len n-object-keys)))
727           
728           (do ((i 0 (+ i query-len)))
729               ((>= i n-object-keys))
730             (let* ((keys (if max-len
731                              (subseq object-keys i (min (+ i query-len) n-object-keys))
732                            object-keys))
733                    (results (find-all (list (gethash :join-class dbi))
734                                       :where (make-instance 'sql-relational-exp
735                                                :operator 'in
736                                                :sub-expressions (list (sql-expression :attribute foreign-key)
737                                                                       keys))
738                                       :result-types :auto
739                                       :flatp t)))
740               (dolist (object objects)
741                 (when (or force-p (not (slot-boundp object slotdef-name)))
742                   (let ((res (find (slot-value object home-key) results 
743                                    :key #'(lambda (res) (slot-value res foreign-key))
744                                    :test #'equal)))
745                     (when res
746                       (setf (slot-value object slotdef-name) res)))))))))))
747   (values))
748   
749 (defun fault-join-slot-raw (class object slot-def)
750   (let* ((dbi (view-class-slot-db-info slot-def))
751          (jc (gethash :join-class dbi)))
752     (let ((jq (join-qualifier class object slot-def)))
753       (when jq 
754         (select jc :where jq :flatp t :result-types nil)))))
755
756 (defun fault-join-slot (class object slot-def)
757   (let* ((dbi (view-class-slot-db-info slot-def))
758          (ts (gethash :target-slot dbi)))
759     (if (and ts (gethash :set dbi))
760         (fault-join-target-slot class object slot-def)
761         (let ((res (fault-join-slot-raw class object slot-def)))
762           (when res
763             (cond
764               ((and ts (not (gethash :set dbi)))
765                (mapcar (lambda (obj) (slot-value obj ts)) res))
766               ((and (not ts) (not (gethash :set dbi)))
767                (car res))
768               ((and (not ts) (gethash :set dbi))
769                res)))))))
770
771 (defun join-qualifier (class object slot-def)
772     (declare (ignore class))
773     (let* ((dbi (view-class-slot-db-info slot-def))
774            (jc (find-class (gethash :join-class dbi)))
775            ;;(ts (gethash :target-slot dbi))
776            ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
777            (foreign-keys (gethash :foreign-key dbi))
778            (home-keys (gethash :home-key dbi)))
779       (when (every #'(lambda (slt)
780                        (and (slot-boundp object slt)
781                             (not (null (slot-value object slt)))))
782                    (if (listp home-keys) home-keys (list home-keys)))
783         (let ((jc
784                (mapcar #'(lambda (hk fk)
785                            (let ((fksd (slotdef-for-slot-with-class fk jc)))
786                              (sql-operation '==
787                                             (typecase fk
788                                               (symbol
789                                                (sql-expression
790                                                 :attribute
791                                                 (view-class-slot-column fksd)
792                                                 :table (view-table jc)))
793                                               (t fk))
794                                             (typecase hk
795                                               (symbol
796                                                (slot-value object hk))
797                                               (t
798                                                hk)))))
799                        (if (listp home-keys)
800                            home-keys
801                            (list home-keys))
802                        (if (listp foreign-keys)
803                            foreign-keys
804                            (list foreign-keys)))))
805           (when jc
806             (if (> (length jc) 1)
807                 (apply #'sql-and jc)
808                 jc))))))
809
810 ;; FIXME: add retrieval immediate for efficiency
811 ;; For example, for (select 'employee-address) in test suite =>
812 ;; select addr.*,ea_join.* FROM addr,ea_join WHERE ea_join.aaddressid=addr.addressid\g
813
814 (defun build-objects (vals sclasses immediate-join-classes sels immediate-joins database refresh flatp instances)
815   "Used by find-all to build objects."
816   (labels ((build-object (vals vclass jclasses selects immediate-selects instance)
817              (let* ((db-vals (butlast vals (- (list-length vals)
818                                               (list-length selects))))
819                     (obj (if instance instance (make-instance (class-name vclass) :view-database database)))
820                     (join-vals (subseq vals (list-length selects)))
821                     (joins (mapcar #'(lambda (c) (when c (make-instance c :view-database database)))
822                                    jclasses)))
823                
824                ;;(format t "joins: ~S~%db-vals: ~S~%join-values: ~S~%selects: ~S~%immediate-selects: ~S~%" 
825                ;;joins db-vals join-vals selects immediate-selects)
826                
827                ;; use refresh keyword here 
828                (setf obj (get-slot-values-from-view obj (mapcar #'car selects) db-vals))
829                (mapc #'(lambda (jo)
830                          ;; find all immediate-select slots and join-vals for this object
831                          (let* ((slots (class-slots (class-of jo)))
832                                 (pos-list (remove-if #'null
833                                                      (mapcar
834                                                       #'(lambda (s)
835                                                           (position s immediate-selects
836                                                                     :key #'car
837                                                                     :test #'eq))
838                                                       slots))))
839                            (get-slot-values-from-view jo
840                                                       (mapcar #'car 
841                                                               (mapcar #'(lambda (pos)
842                                                                           (nth pos immediate-selects))
843                                                                       pos-list))
844                                                       (mapcar #'(lambda (pos) (nth pos join-vals))
845                                                               pos-list))))
846                      joins)
847                (mapc
848                 #'(lambda (jc) 
849                     (let ((slot (find (class-name (class-of jc)) (class-slots vclass) 
850                                       :key #'(lambda (slot) 
851                                                (when (and (eq :join (view-class-slot-db-kind slot))
852                                                           (eq (slot-definition-name slot)
853                                                               (gethash :join-class (view-class-slot-db-info slot))))
854                                                  (slot-definition-name slot))))))
855                       (when slot
856                         (setf (slot-value obj (slot-definition-name slot)) jc))))
857                 joins)
858                (when refresh (instance-refreshed obj))
859                obj)))
860     (let* ((objects
861             (mapcar #'(lambda (sclass jclass sel immediate-join instance) 
862                         (prog1
863                             (build-object vals sclass jclass sel immediate-join instance)
864                           (setf vals (nthcdr (+ (list-length sel) (list-length immediate-join))
865                                              vals))))
866                     sclasses immediate-join-classes sels immediate-joins instances)))
867       (if (and flatp (= (length sclasses) 1))
868           (car objects)
869         objects))))
870
871 (defun find-all (view-classes 
872                  &rest args
873                  &key all set-operation distinct from where group-by having 
874                       order-by offset limit refresh flatp result-types 
875                       inner-join on 
876                       (database *default-database*)
877                       instances)
878   "Called by SELECT to generate object query results when the
879   View Classes VIEW-CLASSES are passed as arguments to SELECT."
880   (declare (ignore all set-operation group-by having offset limit inner-join on)
881            (optimize (debug 3) (speed 1)))
882   (flet ((ref-equal (ref1 ref2)
883            (string= (sql-output ref1 database)
884                     (sql-output ref2 database)))
885          (table-sql-expr (table)
886            (sql-expression :table (view-table table)))
887          (tables-equal (table-a table-b)
888            (when (and table-a table-b)
889              (string= (string (slot-value table-a 'name))
890                       (string (slot-value table-b 'name))))))
891     (remf args :from)
892     (remf args :where)
893     (remf args :flatp)
894     (remf args :additional-fields)
895     (remf args :result-types)
896     (remf args :instances)
897     (let* ((*db-deserializing* t)
898            (sclasses (mapcar #'find-class view-classes))
899            (immediate-join-slots 
900             (mapcar #'(lambda (c) (generate-retrieval-joins-list c :immediate)) sclasses))
901            (immediate-join-classes
902             (mapcar #'(lambda (jcs)
903                         (mapcar #'(lambda (slotdef)
904                                     (find-class (gethash :join-class (view-class-slot-db-info slotdef))))
905                                 jcs))
906                     immediate-join-slots))
907            (immediate-join-sels (mapcar #'generate-immediate-joins-selection-list sclasses))
908            (sels (mapcar #'generate-selection-list sclasses))
909            (fullsels (apply #'append (mapcar #'append sels immediate-join-sels)))
910            (sel-tables (collect-table-refs where))
911            (tables (remove-if #'null
912                               (remove-duplicates
913                                (append (mapcar #'table-sql-expr sclasses)
914                                        (mapcan #'(lambda (jc-list)
915                                                    (mapcar
916                                                     #'(lambda (jc) (when jc (table-sql-expr jc)))
917                                                     jc-list))
918                                                immediate-join-classes)
919                                        sel-tables)
920                                :test #'tables-equal)))
921            (order-by-slots (mapcar #'(lambda (ob) (if (atom ob) ob (car ob)))
922                                    (listify order-by)))
923            (join-where nil))
924            
925
926       ;;(format t "sclasses: ~W~%ijc: ~W~%tables: ~W~%" sclasses immediate-join-classes tables)
927       
928       (dolist (ob order-by-slots)
929         (when (and ob (not (member ob (mapcar #'cdr fullsels)
930                                    :test #'ref-equal)))
931           (setq fullsels 
932             (append fullsels (mapcar #'(lambda (att) (cons nil att))
933                                      order-by-slots)))))
934       (dolist (ob (listify distinct))
935         (when (and (typep ob 'sql-ident) 
936                    (not (member ob (mapcar #'cdr fullsels) 
937                                 :test #'ref-equal)))
938           (setq fullsels 
939               (append fullsels (mapcar #'(lambda (att) (cons nil att))
940                                        (listify ob))))))
941       (mapcar #'(lambda (vclass jclasses jslots)
942                   (when jclasses
943                     (mapcar
944                      #'(lambda (jclass jslot)
945                          (let ((dbi (view-class-slot-db-info jslot)))
946                            (setq join-where
947                              (append
948                               (list (sql-operation '==
949                                                    (sql-expression
950                                                     :attribute (gethash :foreign-key dbi)
951                                                     :table (view-table jclass))
952                                                    (sql-expression
953                                                     :attribute (gethash :home-key dbi)
954                                                     :table (view-table vclass))))
955                               (when join-where (listify join-where))))))
956                      jclasses jslots)))
957               sclasses immediate-join-classes immediate-join-slots)
958       (when where 
959         (setq where (listify where)))
960       (cond
961        ((and where join-where)
962         (setq where (list (apply #'sql-and where join-where))))
963        ((and (null where) (> (length join-where) 1))
964         (setq where (list (apply #'sql-and join-where)))))
965       
966       (let* ((rows (apply #'select 
967                           (append (mapcar #'cdr fullsels)
968                                   (cons :from 
969                                         (list (append (when from (listify from)) 
970                                                       (listify tables)))) 
971                                   (list :result-types result-types)
972                                   (when where
973                                     (list :where where))
974                                   args)))
975              (instances-to-add (- (length rows) (length instances)))
976              (perhaps-extended-instances
977               (if (plusp instances-to-add)
978                   (append instances (do ((i 0 (1+ i))
979                                          (res nil))
980                                         ((= i instances-to-add) res)
981                                       (push (make-list (length sclasses) :initial-element nil) res)))
982                 instances))
983              (objects (mapcar 
984                        #'(lambda (row instance)
985                            (build-objects row sclasses immediate-join-classes sels
986                                           immediate-join-sels database refresh flatp 
987                                           (if (and flatp (atom instance))
988                                               (list instance)
989                                             instance)))
990                        rows perhaps-extended-instances)))
991         objects))))
992
993 (defmethod instance-refreshed ((instance standard-db-object)))
994
995 (defvar *default-caching* t
996   "Controls whether SELECT caches objects by default. The CommonSQL
997 specification states caching is on by default.")
998
999 (defun select (&rest select-all-args) 
1000    "Executes a query on DATABASE, which has a default value of
1001 *DEFAULT-DATABASE*, specified by the SQL expressions supplied
1002 using the remaining arguments in SELECT-ALL-ARGS. The SELECT
1003 argument can be used to generate queries in both functional and
1004 object oriented contexts. 
1005
1006 In the functional case, the required arguments specify the
1007 columns selected by the query and may be symbolic SQL expressions
1008 or strings representing attribute identifiers. Type modified
1009 identifiers indicate that the values selected from the specified
1010 column are converted to the specified lisp type. The keyword
1011 arguments ALL, DISTINCT, FROM, GROUP-by, HAVING, ORDER-BY,
1012 SET-OPERATION and WHERE are used to specify, using the symbolic
1013 SQL syntax, the corresponding components of the SQL query
1014 generated by the call to SELECT. RESULT-TYPES is a list of
1015 symbols which specifies the lisp type for each field returned by
1016 the query. If RESULT-TYPES is nil all results are returned as
1017 strings whereas the default value of :auto means that the lisp
1018 types are automatically computed for each field. FIELD-NAMES is t
1019 by default which means that the second value returned is a list
1020 of strings representing the columns selected by the query. If
1021 FIELD-NAMES is nil, the list of column names is not returned as a
1022 second value. 
1023
1024 In the object oriented case, the required arguments to SELECT are
1025 symbols denoting View Classes which specify the database tables
1026 to query. In this case, SELECT returns a list of View Class
1027 instances whose slots are set from the attribute values of the
1028 records in the specified table. Slot-value is a legal operator
1029 which can be employed as part of the symbolic SQL syntax used in
1030 the WHERE keyword argument to SELECT. REFRESH is nil by default
1031 which means that the View Class instances returned are retrieved
1032 from a cache if an equivalent call to SELECT has previously been
1033 issued. If REFRESH is true, the View Class instances returned are
1034 updated as necessary from the database and the generic function
1035 INSTANCE-REFRESHED is called to perform any necessary operations
1036 on the updated instances.
1037
1038 In both object oriented and functional contexts, FLATP has a
1039 default value of nil which means that the results are returned as
1040 a list of lists. If FLATP is t and only one result is returned
1041 for each record selected in the query, the results are returned
1042 as elements of a list."
1043
1044    (flet ((select-objects (target-args)
1045             (and target-args
1046                  (every #'(lambda (arg)
1047                             (and (symbolp arg)
1048                                  (find-class arg nil)))
1049                         target-args))))
1050      (multiple-value-bind (target-args qualifier-args)
1051          (query-get-selections select-all-args)
1052        (unless (or *default-database* (getf qualifier-args :database))
1053          (signal-no-database-error nil))
1054        
1055        (cond
1056          ((select-objects target-args)
1057           (let ((caching (getf qualifier-args :caching *default-caching*))
1058                 (result-types (getf qualifier-args :result-types :auto))
1059                 (refresh (getf qualifier-args :refresh nil))
1060                 (database (or (getf qualifier-args :database) *default-database*))
1061                 (order-by (getf qualifier-args :order-by)))
1062             (remf qualifier-args :caching)
1063             (remf qualifier-args :refresh)
1064             (remf qualifier-args :result-types)
1065             
1066             ;; Add explicity table name to order-by if not specified and only
1067             ;; one selected table. This is required so FIND-ALL won't duplicate
1068             ;; the field
1069             (when (and order-by (= 1 (length target-args)))
1070               (let ((table-name  (view-table (find-class (car target-args))))
1071                     (order-by-list (copy-seq (listify order-by))))
1072                 
1073                 (loop for i from 0 below (length order-by-list)
1074                       do (etypecase (nth i order-by-list)
1075                            (sql-ident-attribute
1076                             (unless (slot-value (nth i order-by-list) 'qualifier)
1077                               (setf (slot-value (nth i order-by-list) 'qualifier) table-name)))
1078                            (cons
1079                             (unless (slot-value (car (nth i order-by-list)) 'qualifier)
1080                               (setf (slot-value (car (nth i order-by-list)) 'qualifier) table-name)))))
1081                 (setf (getf qualifier-args :order-by) order-by-list)))
1082             
1083             (cond
1084               ((null caching)
1085                (apply #'find-all target-args
1086                       (append qualifier-args 
1087                               (list :result-types result-types :refresh refresh))))
1088               (t
1089                (let ((cached (records-cache-results target-args qualifier-args database)))
1090                  (cond
1091                    ((and cached (not refresh))
1092                     cached)
1093                    ((and cached refresh)
1094                     (let ((results (apply #'find-all (append (list target-args) qualifier-args `(:instances ,cached :result-types :auto :refresh ,refresh)))))
1095                       (setf (records-cache-results target-args qualifier-args database) results)
1096                       results))
1097                    (t
1098                     (let ((results (apply #'find-all target-args (append qualifier-args
1099                                                                          `(:result-types :auto :refresh ,refresh)))))
1100                       (setf (records-cache-results target-args qualifier-args database) results)
1101                       results))))))))
1102          (t
1103           (let* ((expr (apply #'make-query select-all-args))
1104                  (specified-types
1105                   (mapcar #'(lambda (attrib)
1106                               (if (typep attrib 'sql-ident-attribute)
1107                                   (let ((type (slot-value attrib 'type)))
1108                                     (if type
1109                                         type
1110                                         t))
1111                                   t))
1112                           (slot-value expr 'selections))))
1113             (destructuring-bind (&key (flatp nil)
1114                                       (result-types :auto)
1115                                       (field-names t) 
1116                                       (database *default-database*)
1117                                       &allow-other-keys)
1118                 qualifier-args
1119               (query expr :flatp flatp 
1120                      :result-types 
1121                      ;; specifying a type for an attribute overrides result-types
1122                      (if (some #'(lambda (x) (not (eq t x))) specified-types) 
1123                          specified-types
1124                          result-types)
1125                      :field-names field-names
1126                      :database database))))))))
1127
1128 (defun compute-records-cache-key (targets qualifiers)
1129   (list targets
1130         (do ((args *select-arguments* (cdr args))
1131              (results nil))
1132             ((null args) results)
1133           (let* ((arg (car args))
1134                  (value (getf qualifiers arg)))
1135             (when value
1136               (push (list arg
1137                           (typecase value
1138                             (cons (cons (sql (car value)) (cdr value)))
1139                             (%sql-expression (sql value))
1140                             (t value)))
1141                     results))))))
1142
1143 (defun records-cache-results (targets qualifiers database)
1144   (when (record-caches database)
1145     (gethash (compute-records-cache-key targets qualifiers) (record-caches database)))) 
1146
1147 (defun (setf records-cache-results) (results targets qualifiers database)
1148   (unless (record-caches database)
1149     (setf (record-caches database)
1150           (make-hash-table :test 'equal
1151                            #+allegro   :values    #+allegro :weak
1152                            #+clisp     :weak      #+clisp :value
1153                            #+lispworks :weak-kind #+lispworks :value)))
1154   (setf (gethash (compute-records-cache-key targets qualifiers)
1155                  (record-caches database)) results)
1156   results)
1157
1158
1159
1160 ;;; Serialization functions
1161
1162 (defun write-instance-to-stream (obj stream)
1163   "Writes an instance to a stream where it can be later be read.
1164 NOTE: an error will occur if a slot holds a value which can not be written readably."
1165   (let* ((class (class-of obj))
1166          (alist '()))
1167     (dolist (slot (ordered-class-slots (class-of obj)))
1168       (let ((name (slot-definition-name slot)))
1169         (when (and (not (eq 'view-database name))
1170                    (slot-boundp obj name))
1171           (push (cons name (slot-value obj name)) alist))))
1172     (setq alist (reverse alist))
1173     (write (cons (class-name class) alist) :stream stream :readably t))
1174   obj)
1175
1176 (defun read-instance-from-stream (stream)
1177   (let ((raw (read stream nil nil)))
1178     (when raw
1179       (let ((obj (make-instance (car raw))))
1180         (dolist (pair (cdr raw))
1181           (setf (slot-value obj (car pair)) (cdr pair)))
1182         obj))))