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