sql/oodml.lisp

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