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