sql/oodml.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; The CLSQL Object Oriented Data Manipulation Language (OODML).
   5 ;;;;
   6 ;;;; This file is part of CLSQL.
   7 ;;;;
   8 ;;;; CLSQL users are granted the rights to distribute and use this software
   9 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  10 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  11 ;;;; *************************************************************************
  12
  13 (in-package #:clsql-sys)
  14
  15 (defun find-normalized-key (obj)
  16   "Find the first / primary key of a normalized object"
  17   (find-slot-if obj #'key-slot-p T T))
  18
  19 (defun normalized-key-value (obj)
  20   "Normalized classes share a single key for all their key slots"
  21   (when (normalizedp (class-of obj))
  22     (easy-slot-value obj (find-normalized-key obj))))
  23
  24 (defun key-qualifier-for-instance (obj &key (database *default-database*) this-class)
  25   "Generate a boolean sql-expression that identifies an object by its keys"
  26   (let* ((obj-class (or this-class (class-of obj)))
  27          (keys (keyslots-for-class obj-class))
  28          (normal-db-value (normalized-key-value obj)))
  29     (when keys
  30       (labels ((db-value (k)
  31                  (or normal-db-value
  32                      (db-value-from-slot
  33                       k
  34                       (easy-slot-value obj k)
  35                       database)))
  36                (key-equal-exp (k)
  37                  (sql-operation '== (generate-attribute-reference obj-class k database)
  38                                 (db-value k))))
  39         (clsql-ands (mapcar #'key-equal-exp keys))))))
  40
  41 (defun generate-attribute-reference (vclass slotdef &optional (database *default-database*))
  42   "Turns key class and slot-def into a sql-expression representing the
  43    table and column it comes from
  44
  45    used by things like make-select-list, update-slot-from-record"
  46   (when (key-or-base-slot-p slotdef)
  47     (sql-expression :attribute (database-identifier slotdef database)
  48                     :table (database-identifier vclass database))))
  49
  50 (defun get-join-slots (class &optional retrieval-method)
  51   "Returns list of join slots for a class.
  52
  53    if a retrieval method is specified only return slots of that type
  54    if the retrieval method is T, nil or :all return all join slots"
  55   (assert (member retrieval-method '(nil t :all :immediate :deferred)))
  56   (setf class (to-class class))
  57   (let ((all? (member retrieval-method '(nil t :all))))
  58     (loop for slot in (ordered-class-slots class)
  59           when (and (join-slot-p slot)
  60                     (or all? (eql (join-slot-retrieval-method slot) retrieval-method)))
  61           collect slot)))
  62
  63 (defun immediate-join-slots (class)
  64   (get-join-slots class :immediate))
  65
  66 (defmethod choose-database-for-instance ((obj standard-db-object) &optional database)
  67   "Determine which database connection to use for a standard-db-object.
  68         Errs if none is available."
  69   (or (find-if #'(lambda (db)
  70                    (and db (is-database-open db)))
  71                (list (view-database obj)
  72                      database
  73                      *default-database*))
  74       (signal-no-database-error nil)))
  75
  76
  77
  78 (defmethod update-slot-with-null ((object standard-db-object) slotdef)
  79   "sets a slot to the void value of the slot-def (usually nil)"
  80   (setf (easy-slot-value object slotdef)
  81         (slot-value slotdef 'void-value)))
  82
  83 (defmethod update-slot-from-db-value ((instance standard-db-object) slotdef value)
  84   "This gets a value from the database and turns it itno a lisp value
  85    based on the slot's slot-db-reader or baring that read-sql-value"
  86   (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
  87   (let* ((slot-reader (view-class-slot-db-reader slotdef))
  88          (slot-type   (specified-type slotdef)))
  89     (cond
  90       ((null value) (update-slot-with-null instance slotdef))
  91       ((null slot-reader)
  92        (setf (easy-slot-value instance slotdef)
  93              (read-sql-value value (delistify slot-type)
  94                              (choose-database-for-instance instance)
  95                              (database-underlying-type
  96                               (choose-database-for-instance instance)))))
  97       (t (etypecase slot-reader
  98            ((or symbol function)
  99             (setf (easy-slot-value instance slotdef)
 100                   (apply slot-reader (list value))))
 101            (string
 102             (setf (easy-slot-value instance slotdef)
 103                   (format nil slot-reader value))))))))
 104
 105 (defmethod key-value-from-db (slotdef value database)
 106   "TODO: is this deprecated? there are no uses anywhere in clsql"
 107   (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
 108   (let ((slot-reader (view-class-slot-db-reader slotdef))
 109         (slot-type (specified-type slotdef)))
 110     (cond ((and value (null slot-reader))
 111            (read-sql-value value (delistify slot-type) database
 112                            (database-underlying-type database)))
 113           ((null value)
 114            nil)
 115           ((typep slot-reader 'string)
 116            (format nil slot-reader value))
 117           ((typep slot-reader '(or symbol function))
 118            (apply slot-reader (list value)))
 119           (t
 120            (error "Slot reader is of an unusual type.")))))
 121
 122 (defun db-value-from-slot (slotdef val database)
 123   (let ((dbwriter (view-class-slot-db-writer slotdef))
 124         (dbtype (specified-type slotdef)))
 125     (typecase dbwriter
 126       (string (format nil dbwriter val))
 127       ((and (or symbol function) (not null)) (apply dbwriter (list val)))
 128       (t
 129        (database-output-sql-as-type
 130         (typecase dbtype
 131           (cons (car dbtype))
 132           (t dbtype))
 133         val database (database-underlying-type database))))))
 134
 135 (defun check-slot-type (slotdef val)
 136   (let* ((slot-type (specified-type slotdef))
 137          (basetype (if (listp slot-type) (car slot-type) slot-type)))
 138     (when (and slot-type val)
 139       (unless (typep val basetype)
 140         (error 'sql-user-error
 141                :message
 142                (format nil "Invalid value ~A in slot ~A, not of type ~A."
 143                        val (slot-definition-name slotdef) slot-type))))))
 144
 145 (defmethod get-slot-values-from-view (obj slotdeflist values)
 146   "Used to copy values from the database into the object
 147    used by things like find-all and select"
 148   (loop for slot in slotdeflist
 149         for value in values
 150         do (update-slot-from-db-value obj slot value))
 151   obj)
 152
 153 (defclass class-and-slots ()
 154   ((view-class :accessor view-class :initarg :view-class :initform nil)
 155    (slot-defs :accessor slot-defs :initarg :slot-defs :initform nil))
 156   (:documentation "A helper class to keep track of which slot-defs from a
 157    table need to be updated, a normalized class might have many of these
 158    because each of its parent classes might represent some other table and we
 159    need to match which slots came from which parent class/table"))
 160
 161 (defun make-class-and-slots (c &optional s)
 162   "Create a new class-and-slots object"
 163   (make-instance 'class-and-slots :view-class c :slot-defs (listify s) ))
 164
 165 (defmethod view-table ((o class-and-slots))
 166   "get the view-table of the view-class of o"
 167   (view-table (view-class o)))
 168
 169 (defmethod view-table-exp ((o class-and-slots))
 170   (sql-expression :table (view-table o)))
 171
 172 (defmethod view-table-exp ((o standard-db-class))
 173   (sql-expression :table (view-table o)))
 174
 175 (defmethod attribute-references ((o class-and-slots))
 176   "build sql-ident-attributes for a given class-and-slots"
 177   (loop
 178     with class = (view-class o)
 179     for sd in (slot-defs o)
 180     collect (generate-attribute-reference class sd)))
 181
 182 (defmethod attribute-value-pairs ((def class-and-slots) (o standard-db-object)
 183                                   database)
 184   "for a given class-and-slots and object, create the sql-expression & value pairs
 185    that need to be sent to the database"
 186   (loop for s in (slot-defs def)
 187         for n = (to-slot-name s)
 188         when (slot-boundp o n)
 189         collect (make-attribute-value-pair s (slot-value o n) database)))
 190
 191 (defmethod view-classes-and-slots-by-name ((obj standard-db-object) slots-to-match)
 192   "If it's normalized, find the class that actually contains
 193    the slot that's tied to the db,
 194
 195    otherwise just search the current class
 196   "
 197   (let* ((view-class (class-of obj))
 198          (normalizedp (normalizedp view-class))
 199          rtns)
 200     (labels ((get-c&s-obj (class)
 201                (or (find class rtns :key #'view-class)
 202                    (first (push (make-class-and-slots class) rtns))))
 203              (associate-slot-with-class (class slot)
 204                "Find the best class to associate with the slot. If it is
 205                 normalized then it needs to be a direct slot otherwise it just
 206                 needs to be on the class."
 207                (let ((sd (find-slot-by-name class slot normalizedp nil)))
 208                  (if sd
 209                      ;;we found it directly or it's (not normalized)
 210                      (pushnew sd (slot-defs (get-c&s-obj class)))
 211                      (when normalizedp
 212                        (loop for parent in (class-direct-superclasses class)
 213                              until (associate-slot-with-class parent slot))))
 214                  sd)))
 215       (loop
 216         for in-slot in (listify slots-to-match)
 217         do (associate-slot-with-class view-class in-slot)))
 218     rtns))
 219
 220 (defun update-auto-increments-keys (class obj database)
 221   " handle pulling any autoincrement values into the object
 222    if normalized and we now that all the "
 223   (let ((pk-slots (keyslots-for-class class))
 224         (table (view-table class))
 225         new-pk-value)
 226     (labels ((do-update (slot)
 227                (when (and (null (easy-slot-value obj slot))
 228                           (auto-increment-column-p slot database))
 229                  (update-slot-from-db-value
 230                   obj slot
 231                   (or new-pk-value
 232                       (setf new-pk-value
 233                             (database-last-auto-increment-id
 234                              database table slot))))))
 235              (chain-primary-keys (in-class)
 236                "This seems kindof wrong, but this is mostly how it was working, so
 237                   its here to keep the normalized code path working"
 238                (when (typep in-class 'standard-db-class)
 239                  (loop for slot in (ordered-class-slots in-class)
 240                        when (key-slot-p slot)
 241                        do (do-update slot)))))
 242       (loop for slot in pk-slots do (do-update slot))
 243       (let ((direct-class (to-class obj)))
 244         (when (and new-pk-value (normalizedp direct-class))
 245           (chain-primary-keys direct-class)))
 246       new-pk-value)))
 247
 248 (defmethod %update-instance-helper
 249     (class-and-slots obj database
 250      &aux (avps (attribute-value-pairs class-and-slots obj database)))
 251   "A function to help us update a given table (based on class-and-slots)
 252    with values from an object"
 253   ;; we dont actually need to update anything on this particular
 254   ;; class / parent class
 255   (unless avps (return-from %update-instance-helper))
 256
 257   (let* ((view-class (view-class class-and-slots))
 258          (table (view-table view-class))
 259          (table-sql (sql-expression :table table)))
 260
 261     ;; view database is the flag we use to tell it was pulled from a database
 262     ;; and thus probably needs an update instead of an insert
 263     (cond ((view-database obj)
 264            (let ((where (key-qualifier-for-instance
 265                          obj :database database :this-class view-class)))
 266              (unless where
 267                (error "update-record-from-*: could not generate a where clause for ~a using ~A"
 268                       obj view-class))
 269              (update-records table-sql
 270                              :av-pairs avps
 271                              :where where
 272                              :database database)))
 273           (T ;; was not pulled from the db so insert it
 274            ;; avps MUST contain any primary key slots set
 275            ;; by previous inserts of the same object into different
 276            ;; tables (ie: normalized stuff)
 277            (insert-records :into table-sql
 278                            :av-pairs avps
 279                            :database database)
 280            (update-auto-increments-keys view-class obj database)
 281            ;; we dont set view database here, because there could be
 282            ;; N of these for each call to update-record-from-* because
 283            ;; of normalized classes
 284            ))
 285     (update-slot-default-values obj class-and-slots)))
 286
 287 (defmethod update-record-from-slots ((obj standard-db-object) slots
 288                                      &key (database *default-database*))
 289   "For a given list of slots, update all records associated with those slots
 290    and classes.
 291
 292    Generally this will update the single record associated with this object,
 293    but for normalized classes might update as many records as there are
 294    inheritances "
 295   (setf slots (listify slots))
 296   (let* ((classes-and-slots (view-classes-and-slots-by-name obj slots))
 297          (database (choose-database-for-instance obj database)))
 298     (loop for class-and-slots in classes-and-slots
 299           do (%update-instance-helper class-and-slots obj database))
 300     (setf (slot-value obj 'view-database) database))
 301   (values))
 302
 303 (defmethod update-record-from-slot
 304     ((obj standard-db-object) slot &key (database *default-database*))
 305   "just call update-records-from-slots which now handles this.
 306
 307    This function is only here to maintain backwards compatibility in
 308    the public api"
 309   (update-record-from-slots obj slot :database database))
 310
 311 (defmethod view-classes-and-storable-slots (class)
 312   "Get a list of all the tables we need to update and the slots on them
 313
 314    for non normalized classes we return the class and all its storable slots
 315
 316    for normalized classes we return a list of direct slots and the class they
 317    came from for each normalized view class
 318   "
 319   (setf class (to-class class))
 320   (let* (rtns)
 321     (labels ((storable-slots (class)
 322                (loop for sd in (slots-for-possibly-normalized-class class)
 323                      when (key-or-base-slot-p sd)
 324                      collect sd))
 325              (get-classes-and-slots (class &aux (normalizedp (normalizedp class)))
 326                (let ((slots (storable-slots class)))
 327                  (when slots
 328                    (push (make-class-and-slots class slots) rtns)))
 329                (when normalizedp
 330                  (loop for new-class in (class-direct-superclasses class)
 331                        do (when (typep new-class 'standard-db-class)
 332                             (get-classes-and-slots new-class))))))
 333       (get-classes-and-slots class))
 334     rtns))
 335
 336 (defmethod primary-key-slot-values ((obj standard-db-object)
 337                                     &key class slots )
 338   "Returns the values of all key-slots for a given class"
 339   (defaulting class (class-of obj)
 340               slots (keyslots-for-class class))
 341   (loop for slot in slots
 342         collect (easy-slot-value obj slot)))
 343
 344 (defmethod update-slot-default-values ((obj standard-db-object)
 345                                        classes-and-slots)
 346   "Makes sure that if a class has unfilled slots that claim to have a default,
 347    that we retrieve those defaults from the database
 348
 349    TODO: use update-slots-from-record (doesnt exist) instead to batch this!"
 350   (loop for class-and-slots in (listify classes-and-slots)
 351         do (loop for slot in (slot-defs class-and-slots)
 352                  do (when (and (slot-has-default-p slot)
 353                                (not (easy-slot-value obj slot)))
 354                       (update-slot-from-record obj (to-slot-name slot))))))
 355
 356 (defmethod update-records-from-instance ((obj standard-db-object)
 357                                          &key (database *default-database*))
 358   "Updates the records in the database associated with this object if
 359    view-database slot on the object is nil then the object is assumed to be
 360    new and is inserted"
 361   (let ((database (choose-database-for-instance obj database))
 362         (classes-and-slots (view-classes-and-storable-slots obj)))
 363     (loop for class-and-slots in classes-and-slots
 364           do (%update-instance-helper class-and-slots obj database))
 365     (setf (slot-value obj 'view-database) database)
 366     (primary-key-slot-values obj)))
 367
 368 (defmethod delete-instance-records ((instance standard-db-object) &key database)
 369   "Removes the records associated with a given instance
 370    (as determined by key-qualifier-for-instance)
 371
 372    TODO: Doesnt handle normalized classes at all afaict"
 373   (let ((database (choose-database-for-instance instance database))
 374         (vt (sql-expression :table (view-table (class-of instance)))))
 375     (if database
 376         (let ((qualifier (key-qualifier-for-instance instance :database database)))
 377           (delete-records :from vt :where qualifier :database database)
 378           (setf (record-caches database) nil)
 379           (setf (slot-value instance 'view-database) nil)
 380           (values))
 381         (signal-no-database-error database))))
 382
 383 (defmethod update-instance-from-records ((instance standard-db-object)
 384                                          &key (database *default-database*))
 385   "Updates a database object with the current values stored in the database
 386
 387    TODO: Should this update immediate join slots similar to build-objects?
 388          Can we just call build-objects?, update-objects-joins?
 389   "
 390
 391   (let* ((classes-and-slots (view-classes-and-storable-slots instance))
 392          (vd (choose-database-for-instance instance database)))
 393     (labels ((do-update (class-and-slots)
 394                (let* ((select-list (make-select-list class-and-slots :do-joins-p nil))
 395                       (view-table (sql-table select-list))
 396                       (view-qual (key-qualifier-for-instance
 397                                   instance :database vd
 398                                   :this-class (view-class select-list)))
 399                       (res (when view-qual
 400                              (first
 401                               (apply #'select
 402                                      (append (full-select-list select-list)
 403                                              (list :from view-table
 404                                                    :where view-qual
 405                                                    :result-types nil
 406                                                    :database vd)))))))
 407                  (when res
 408                    (setf (slot-value instance 'view-database) vd)
 409                    (get-slot-values-from-view instance (slot-list select-list) res))
 410                  )))
 411       (loop for class-and-slots in classes-and-slots
 412             do (do-update class-and-slots)))))
 413
 414
 415 (defmethod get-slot-value-from-record ((instance standard-db-object)
 416                                        slot &key (database *default-database*))
 417   (let* ((class-and-slot
 418            (first
 419             (view-classes-and-slots-by-name instance slot)))
 420          (view-class (view-class class-and-slot))
 421          (slot-def (first (slot-defs class-and-slot)))
 422          (vd (choose-database-for-instance instance database))
 423          (att-ref (first (attribute-references class-and-slot)))
 424          (res (first
 425                (select att-ref
 426                  :from (view-table-exp class-and-slot)
 427                  :where (key-qualifier-for-instance
 428                          instance
 429                          :database vd
 430                          :this-class view-class)
 431                  :result-types nil
 432                  :flatp T))))
 433     (values res slot-def)))
 434
 435 (defmethod update-slot-from-record ((instance standard-db-object)
 436                                     slot &key (database *default-database*))
 437   "Pulls the value of a given slot form the database and stores that in the
 438    appropriate slot on instance"
 439   (multiple-value-bind (res slot-def)
 440       (get-slot-value-from-record instance slot :database database)
 441     (let ((vd (choose-database-for-instance instance database)))
 442       (setf (slot-value instance 'view-database) vd)
 443       (update-slot-from-db-value instance slot-def res))))
 444
 445
 446 (defvar +no-slot-value+ '+no-slot-value+)
 447
 448 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
 449         (let* ((class (find-class classname))
 450                (sld (slotdef-for-slot-with-class slot class)))
 451           (if sld
 452               (if (eq value +no-slot-value+)
 453                   (sql-expression :attribute (database-identifier sld database)
 454                                   :table (view-table class))
 455                   (db-value-from-slot
 456                    sld
 457                    value
 458                    database))
 459               (error "Unknown slot ~A for class ~A" slot classname))))
 460
 461 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
 462         (declare (ignore database))
 463         (let* ((class (find-class classname)))
 464           (unless (view-table class)
 465             (error "No view-table for class ~A"  classname))
 466           (sql-expression :table (view-table class))))
 467
 468 (deftype tinyint ()
 469   "An 8-bit integer, this width may vary by SQL implementation."
 470   'integer)
 471
 472 (deftype smallint ()
 473   "An integer smaller than a 32-bit integer. this width may vary by SQL implementation."
 474   'integer)
 475
 476 (deftype mediumint ()
 477   "An integer smaller than a 32-bit integer, but may be larger than a smallint. This width may vary by SQL implementation."
 478   'integer)
 479
 480 (deftype bigint ()
 481   "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
 482   'integer)
 483
 484 (deftype varchar (&optional size)
 485   "A variable length string for the SQL varchar type."
 486   (declare (ignore size))
 487   'string)
 488
 489 (deftype universal-time ()
 490   "A positive integer as returned by GET-UNIVERSAL-TIME."
 491   '(integer 1 *))
 492
 493 (deftype generalized-boolean ()
 494   "A type which outputs a SQL boolean value, though any lisp type can be stored in the slot."
 495   t)
 496
 497 #+ignore
 498 (deftype char (&optional len)
 499   "A lisp type for the SQL CHAR type."
 500   `(string ,len))
 501
 502 (defmethod database-get-type-specifier ((type string) args database (db-type t))
 503   "Pass through the literal type as defined in the type string"
 504   (declare (ignore args database db-type))
 505   type)
 506
 507
 508 (defmethod database-get-type-specifier ((type symbol) args database db-type)
 509   (case type
 510     (char (if args
 511               (format nil "CHAR(~D)" (first args))
 512               "CHAR(1)"))
 513     ((varchar string)
 514      (if args
 515          (format nil "VARCHAR(~A)" (car args))
 516          (format nil "VARCHAR(~D)" *default-string-length*)))
 517     ((longchar text) "text")
 518     (integer (if args
 519                  (format nil "INT(~A)" (car args))
 520                  "INT"))
 521     ((tinyint smallint mediumint) "INT")
 522     ((long-float float)
 523      (if args
 524          (format nil "FLOAT(~A)" (car args))
 525          "FLOAT"))
 526     ((bigint universal-time) "BIGINT")
 527     (number
 528      (cond
 529        ((and (consp args) (= (length args) 2))
 530         (format nil "NUMBER(~D,~D)" (first args) (second args)))
 531        ((and (consp args) (= (length args) 1))
 532         (format nil "NUMBER(~D)" (first args)))
 533        (t
 534         "NUMBER")))
 535     (wall-time "TIMESTAMP")
 536     (date "DATE")
 537     (duration "VARCHAR")
 538     (money "INT8")
 539     ((boolean generalized-boolean) "BOOL")
 540     (t (warn "Could not determine a valid ~A type specifier for ~A ~A ~A, defaulting to VARCHAR "
 541              db-type type args database)
 542      (format nil "VARCHAR(~D)" *default-string-length*))))
 543
 544 (defmethod database-output-sql-as-type (type val database db-type)
 545   (declare (ignore type database db-type))
 546   val)
 547
 548 (defmethod database-output-sql-as-type ((type (eql 'list)) val database db-type)
 549   (declare (ignore database db-type))
 550   (progv '(*print-circle* *print-array*) '(t t)
 551     (let ((escaped (prin1-to-string val)))
 552       (substitute-char-string
 553        escaped #\Null " "))))
 554
 555 (defmethod database-output-sql-as-type ((type (eql 'symbol)) val database db-type)
 556   (declare (ignore database db-type))
 557   (if val
 558       (concatenate 'string
 559                    (package-name (symbol-package val))
 560                    "::"
 561                    (symbol-name val))
 562       ""))
 563
 564 (defmethod database-output-sql-as-type ((type (eql 'keyword)) val database db-type)
 565   (declare (ignore database db-type))
 566   (if val
 567       (symbol-name val)
 568       ""))
 569
 570 (defmethod database-output-sql-as-type ((type (eql 'vector)) val database db-type)
 571   (declare (ignore database db-type))
 572   (progv '(*print-circle* *print-array*) '(t t)
 573     (prin1-to-string val)))
 574
 575 (defmethod database-output-sql-as-type ((type (eql 'array)) val database db-type)
 576   (declare (ignore database db-type))
 577   (progv '(*print-circle* *print-array*) '(t t)
 578     (prin1-to-string val)))
 579
 580 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database db-type)
 581   (declare (ignore database db-type))
 582   (if val "t" "f"))
 583
 584 (defmethod database-output-sql-as-type ((type (eql 'generalized-boolean)) val database db-type)
 585   (declare (ignore database db-type))
 586   (if val "t" "f"))
 587
 588 (defmethod database-output-sql-as-type ((type (eql 'string)) val database db-type)
 589   (declare (ignore database db-type))
 590   val)
 591
 592 (defmethod database-output-sql-as-type ((type (eql 'char)) val database db-type)
 593   (declare (ignore database db-type))
 594   (etypecase val
 595     (character (write-to-string val))
 596     (string val)))
 597
 598 (defmethod database-output-sql-as-type ((type (eql 'float)) val database db-type)
 599   (declare (ignore database db-type))
 600   (if (eq (type-of val) 'null)
 601       nil
 602       (let ((*read-default-float-format* (type-of val)))
 603        (format nil "~F" val))))
 604
 605 (defmethod read-sql-value (val type database db-type)
 606   (declare (ignore database db-type))
 607   (cond
 608     ((null type) val) ;;we have no desired type, just give the value
 609     ((typep val type) val) ;;check that it hasn't already been converted.
 610     ((typep val 'string) (read-from-string val)) ;;maybe read will just take care of it?
 611     (T (error "Unable to read-sql-value ~a as type ~a" val type))))
 612
 613 (defmethod read-sql-value (val (type (eql 'string)) database db-type)
 614   (declare (ignore database db-type))
 615   val)
 616
 617 (defmethod read-sql-value (val (type (eql 'varchar)) database db-type)
 618   (declare (ignore database db-type))
 619   val)
 620
 621 (defmethod read-sql-value (val (type (eql 'char)) database db-type)
 622   (declare (ignore database db-type))
 623   (schar val 0))
 624
 625 (defmethod read-sql-value (val (type (eql 'keyword)) database db-type)
 626   (declare (ignore database db-type))
 627   (when (< 0 (length val))
 628     (intern (symbol-name-default-case val)
 629             (find-package '#:keyword))))
 630
 631 (defmethod read-sql-value (val (type (eql 'symbol)) database db-type)
 632   (declare (ignore database db-type))
 633   (when (< 0 (length val))
 634     (unless (string= val (symbol-name-default-case "NIL"))
 635       (read-from-string val))))
 636
 637 (defmethod read-sql-value (val (type (eql 'integer)) database db-type)
 638   (declare (ignore database db-type))
 639   (etypecase val
 640     (string
 641      (unless (string-equal "NIL" val)
 642        (parse-integer val)))
 643     (number val)))
 644
 645 (defmethod read-sql-value (val (type (eql 'smallint)) database db-type)
 646   (declare (ignore database db-type))
 647   (etypecase val
 648     (string
 649      (unless (string-equal "NIL" val)
 650        (parse-integer val)))
 651     (number val)))
 652
 653 (defmethod read-sql-value (val (type (eql 'bigint)) database db-type)
 654   (declare (ignore database db-type))
 655   (etypecase val
 656     (string
 657      (unless (string-equal "NIL" val)
 658        (parse-integer val)))
 659     (number val)))
 660
 661 (defmethod read-sql-value (val (type (eql 'float)) database db-type)
 662   (declare (ignore database db-type))
 663   ;; writing 1.0 writes 1, so we we *really* want a float, must do (float ...)
 664   (etypecase val
 665     (string (float (read-from-string val)))
 666     (float val)))
 667
 668 (defmethod read-sql-value (val (type (eql 'double-float)) database db-type)
 669   (declare (ignore database db-type))
 670   ;; writing 1.0 writes 1, so if we *really* want a float, must do (float ...)
 671   (etypecase val
 672     (string (float
 673              (let ((*read-default-float-format* 'double-float))
 674                (read-from-string val))
 675              1.0d0))
 676     (double-float val)
 677     (float (coerce val 'double-float))))
 678
 679 (defmethod read-sql-value (val (type (eql 'boolean)) database db-type)
 680   (declare (ignore database db-type))
 681   (equal "t" val))
 682
 683 (defmethod read-sql-value (val (type (eql 'generalized-boolean)) database db-type)
 684   (declare (ignore database db-type))
 685   (equal "t" val))
 686
 687 (defmethod read-sql-value (val (type (eql 'number)) database db-type)
 688   (declare (ignore database db-type))
 689   (etypecase val
 690     (string
 691      (unless (string-equal "NIL" val)
 692        (read-from-string val)))
 693     (number val)))
 694
 695 (defmethod read-sql-value (val (type (eql 'universal-time)) database db-type)
 696   (declare (ignore database db-type))
 697   (unless (eq 'NULL val)
 698     (etypecase val
 699       (string
 700        (parse-integer val))
 701       (number val))))
 702
 703 (defmethod read-sql-value (val (type (eql 'wall-time)) database db-type)
 704   (declare (ignore database db-type))
 705   (unless (eq 'NULL val)
 706     (parse-timestring val)))
 707
 708 (defmethod read-sql-value (val (type (eql 'date)) database db-type)
 709   (declare (ignore database db-type))
 710   (unless (eq 'NULL val)
 711     (parse-datestring val)))
 712
 713 (defmethod read-sql-value (val (type (eql 'duration)) database db-type)
 714   (declare (ignore database db-type))
 715   (unless (or (eq 'NULL val)
 716               (equal "NIL" val))
 717     (parse-timestring val)))
 718
 719 ;; ------------------------------------------------------------
 720 ;; Logic for 'faulting in' :join slots
 721
 722 ;; this works, but is inefficient requiring (+ 1 n-rows)
 723 ;; SQL queries
 724 #+ignore
 725 (defun fault-join-target-slot (class object slot-def)
 726   (let* ((res (fault-join-slot-raw class object slot-def))
 727          (dbi (view-class-slot-db-info slot-def))
 728          (target-name (gethash :target-slot dbi))
 729          (target-class (find-class target-name)))
 730     (when res
 731       (mapcar (lambda (obj)
 732                 (list
 733                  (car
 734                   (fault-join-slot-raw
 735                    target-class
 736                    obj
 737                    (find target-name (class-slots (class-of obj))
 738                          :key #'slot-definition-name)))
 739                  obj))
 740               res)
 741       #+ignore ;; this doesn't work when attempting to call slot-value
 742       (mapcar (lambda (obj)
 743                 (cons obj (slot-value obj ts))) res))))
 744
 745 (defun fault-join-target-slot (class object slot-def)
 746   (let* ((dbi (view-class-slot-db-info slot-def))
 747          (ts (gethash :target-slot dbi))
 748          (jc  (gethash :join-class dbi))
 749          (jc-view-table (view-table (find-class jc)))
 750          (tdbi (view-class-slot-db-info
 751                 (find ts (class-slots (find-class jc))
 752                       :key #'slot-definition-name)))
 753          (retrieval (gethash :retrieval tdbi))
 754          (tsc (gethash :join-class tdbi))
 755          (ts-view-table (view-table (find-class tsc)))
 756          (jq (join-qualifier class object slot-def))
 757          (key (slot-value object (gethash :home-key dbi))))
 758
 759     (when jq
 760       (ecase retrieval
 761         (:immediate
 762          (let ((res
 763                 (find-all (list tsc)
 764                           :inner-join (sql-expression :table jc-view-table)
 765                           :on (sql-operation
 766                                '==
 767                                (sql-expression
 768                                 :attribute (gethash :foreign-key tdbi)
 769                                 :table ts-view-table)
 770                                (sql-expression
 771                                 :attribute (gethash :home-key tdbi)
 772                                 :table jc-view-table))
 773                           :where jq
 774                           :result-types :auto
 775                           :database (choose-database-for-instance object))))
 776            (mapcar #'(lambda (i)
 777                        (let* ((instance (car i))
 778                               (jcc (make-instance jc :view-database (choose-database-for-instance instance))))
 779                          (setf (slot-value jcc (gethash :foreign-key dbi))
 780                                key)
 781                          (setf (slot-value jcc (gethash :home-key tdbi))
 782                                (slot-value instance (gethash :foreign-key tdbi)))
 783                          (list instance jcc)))
 784                    res)))
 785         (:deferred
 786          ;; just fill in minimal slots
 787          (mapcar
 788           #'(lambda (k)
 789               (let ((instance (make-instance tsc :view-database (choose-database-for-instance object)))
 790                     (jcc (make-instance jc :view-database (choose-database-for-instance object)))
 791                     (fk (car k)))
 792                 (setf (slot-value instance (gethash :home-key tdbi)) fk)
 793                 (setf (slot-value jcc (gethash :foreign-key dbi))
 794                       key)
 795                 (setf (slot-value jcc (gethash :home-key tdbi))
 796                       fk)
 797                 (list instance jcc)))
 798           (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
 799                   :from (sql-expression :table jc-view-table)
 800                   :where jq
 801                   :database (choose-database-for-instance object))))))))
 802
 803
 804 ;;; Remote Joins
 805
 806 (defvar *default-update-objects-max-len* nil
 807   "The default value to use for the MAX-LEN keyword argument to
 808   UPDATE-OBJECT-JOINS.")
 809
 810 (defun %update-objects-joins-slot-defs (class slot-names)
 811   "Get the slot definitions for the joins slots specified as slot-names
 812    if slot-names is :immediate, :deferred or (or :all t) return all of
 813    that type of slot definitions"
 814   (setf class (to-class class))
 815   (when (eq t slot-names) (setf slot-names :all))
 816   (etypecase slot-names
 817     (null nil)
 818     (keyword
 819      ;; slot-names is the retrieval type of the join-slot or :all
 820      (get-join-slots class slot-names))
 821     ((or symbol list)
 822      (loop for slot in (listify slot-names)
 823            for def = (find-slot-by-name class slot)
 824            when (and def (join-slot-p def))
 825            collecting def
 826            unless (and def (join-slot-p def))
 827            do (warn "Unable to find join slot named ~S in class ~S." slot class)))))
 828
 829 (defun get-joined-objects (objects slotdef &key force-p
 830                                            (batch-size *default-update-objects-max-len*))
 831   "Given a list of objects and a join slot-def get the objects that need to be
 832    joined to the input objects
 833
 834    we will query in batches as large as batch-size"
 835   (when (join-slot-p slotdef)
 836     (let* ((slot-name (to-slot-name slotdef))
 837            (join-class (join-slot-class-name slotdef))
 838            (home-key (join-slot-info-value slotdef :home-key))
 839            (foreign-key (join-slot-info-value slotdef :foreign-key))
 840            (foreign-key-values
 841              (remove-duplicates
 842               (loop for object in (listify objects)
 843                     for hk = (slot-value object home-key)
 844                     when (or force-p
 845                              (not (slot-boundp object slot-name)))
 846                     collect hk)
 847               :test #'equal)))
 848       ;; we want to retrieve at most batch-size objects per query
 849       (flet ((fetch (keys)
 850                (find-all
 851                 (list join-class)
 852                 :where (make-instance
 853                         'sql-relational-exp
 854                         :operator 'in
 855                         :sub-expressions (list (sql-expression :attribute foreign-key)
 856                                                keys))
 857                 :result-types :auto
 858                 :flatp t)))
 859         (if (null batch-size)
 860             (fetch foreign-key-values)
 861             (loop
 862               for keys = (pop-n foreign-key-values batch-size)
 863               while keys
 864               nconcing (fetch keys)))))))
 865
 866 (defun %object-joins-from-list (object slot joins force-p )
 867   "Given a list of objects that we are trying to join to, pull the correct
 868    ones for this object"
 869   (when (or force-p (not (slot-boundp object (to-slot-name slot))))
 870     (let ((home-key (join-slot-info-value slot :home-key))
 871           (foreign-key (join-slot-info-value slot :foreign-key)))
 872       (loop for join in joins
 873             when (equal (slot-value join foreign-key)
 874                         (slot-value object home-key))
 875             collect join))))
 876
 877 (defun update-objects-joins (objects &key (slots :immediate) (force-p t)
 878                                      class-name (max-len *default-update-objects-max-len*))
 879   "Updates from the records of the appropriate database tables the join slots
 880    specified by SLOTS in the supplied list of View Class instances OBJECTS.
 881
 882    A simpler method of causing a join-slot to be requeried is to set it to
 883    unbound, then request it again.  This function has efficiency gains where
 884    join-objects are shared among the `objects` (querying all join-objects,
 885    then attaching them appropriately to each of the `objects`)
 886
 887    SLOTS can be one of:
 888
 889     * :immediate (DEFAULT) - refresh join slots created with :retrieval :immediate
 890     * :deferred - refresh join slots created with :retrieval :deferred
 891     * :all,t - refresh all join slots regardless of :retrieval
 892     * list of symbols - which explicit slots to refresh
 893     * a single symobl - what slot to refresh
 894
 895    CLASS-NAME is used to specify the View Class of all instance in OBJECTS and
 896    default to nil which means that the class of the first instance in OBJECTS
 897    is used.
 898
 899    FORCE-P is t by default which means that all join slots are updated whereas
 900    a value of nil means that only unbound join slots are updated.
 901
 902    MAX-LEN defaults to *DEFAULT-UPDATE-OBJECTS-MAX-LEN* When non-nil this is
 903    essentially a batch size for the max number of objects to query from the
 904    database at a time.  If we need more than max-len we loop till we have all
 905    the objects"
 906   (assert (or (null max-len) (plusp max-len)))
 907   (when objects
 908     (defaulting class-name (class-name (class-of (first objects))))
 909     (let* ((class (find-class class-name))
 910            (slotdefs (%update-objects-joins-slot-defs class slots)))
 911       (loop for slotdef in slotdefs
 912             ;; all the joins we will need for *all* the objects
 913             ;; which then get filtered below for each object
 914             for joins = (unless (join-slot-info-value slotdef :target-slot)
 915                           (get-joined-objects objects slotdef
 916                                               :force-p force-p :batch-size max-len))
 917             do (loop for object in objects
 918                      for these-joins = ;; the joins just for this object (filtered from above)
 919                                        ;; or retrieved via fault-join-target-slot
 920                         (or (%object-joins-from-list object slotdef joins force-p)
 921                             (when (join-slot-info-value slotdef :target-slot)
 922                               (fault-join-target-slot class object slotdef)))
 923                      ;; when this object has joined-objects copy them in to the correct slot
 924                      do (when these-joins
 925                           (setf (easy-slot-value object slotdef)
 926                                 (if (join-slot-info-value slotdef :set)
 927                                     these-joins
 928                                     (first these-joins))))))))
 929   (values))
 930
 931 (defun fault-join-slot-raw (class object slot-def)
 932   (let* ((dbi (view-class-slot-db-info slot-def))
 933          (jc (gethash :join-class dbi)))
 934     (let ((jq (join-qualifier class object slot-def)))
 935       (when jq
 936         (select jc :where jq :flatp t :result-types nil
 937                 :database (choose-database-for-instance object))))))
 938
 939 (defun fault-join-slot (class object slot-def)
 940   (let* ((dbi (view-class-slot-db-info slot-def))
 941          (ts (gethash :target-slot dbi))
 942          (dbi-set (gethash :set dbi)))
 943     (if (and ts dbi-set)
 944         (fault-join-target-slot class object slot-def)
 945         (let ((res (fault-join-slot-raw class object slot-def)))
 946           (when res
 947             (cond
 948               ((and ts (not dbi-set))
 949                (mapcar (lambda (obj) (slot-value obj ts)) res))
 950               ((and (not ts) (not dbi-set))
 951                (car res))
 952               ((and (not ts) dbi-set)
 953                res)))))))
 954
 955 (defun update-fault-join-normalized-slot (class object slot-def)
 956   (if (and (normalizedp class) (key-slot-p slot-def))
 957       (setf (easy-slot-value object slot-def)
 958             (normalized-key-value object))
 959       (update-slot-from-record object slot-def)))
 960
 961 (defun all-home-keys-have-values-p (object slot-def)
 962   "Do all of the home-keys have values ?"
 963   (let ((home-keys (join-slot-info-value slot-def :home-key)))
 964     (loop for key in (listify home-keys)
 965           always (easy-slot-value object key))))
 966
 967 (defun join-qualifier (class object slot-def)
 968   "Builds the join where clause based on the keys of the join slot and values
 969    of the object"
 970   (declare (ignore class))
 971   (let* ((jc (join-slot-class slot-def))
 972          ;;(ts (gethash :target-slot dbi))
 973          ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
 974          (foreign-keys (listify (join-slot-info-value slot-def :foreign-key)))
 975          (home-keys (listify (join-slot-info-value slot-def :home-key))))
 976     (when (all-home-keys-have-values-p object slot-def)
 977       (clsql-ands
 978        (loop for hk in home-keys
 979              for fk in foreign-keys
 980              for fksd = (slotdef-for-slot-with-class fk jc)
 981              for fk-sql = (typecase fk
 982                             (symbol
 983                              (sql-expression
 984                               :attribute (database-identifier fksd nil)
 985                               :table (database-identifier jc nil)))
 986                             (t fk))
 987              for hk-val = (typecase hk
 988                             ((or symbol
 989                                  view-class-effective-slot-definition
 990                                  view-class-direct-slot-definition)
 991                              (easy-slot-value object hk))
 992                             (t hk))
 993              collect (sql-operation '== fk-sql hk-val))))))
 994
 995 (defmethod select-table-sql-expr ((table T))
 996   "Turns an object representing a table into the :from part of the sql expression that will be executed "
 997   (sql-expression :table (view-table table)))
 998
 999 (defun select-reference-equal (r1 r2)
1000   "determines if two sql select references are equal
1001    using database identifier equal"
1002   (flet ((id-of (r)
1003            (etypecase r
1004              (cons (cdr r))
1005              (sql-ident-attribute r))))
1006     (database-identifier-equal (id-of r1) (id-of r2))))
1007
1008 (defun join-slot-qualifier (class join-slot)
1009   "Creates a sql-expression expressing the join between the home-key on the table
1010    and its respective key on the joined-to-table"
1011   (sql-operation
1012    '==
1013    (sql-expression
1014     :attribute (join-slot-info-value join-slot :foreign-key)
1015     :table (view-table (join-slot-class join-slot)))
1016    (sql-expression
1017     :attribute (join-slot-info-value join-slot :home-key)
1018     :table (view-table class))))
1019
1020 (defun all-immediate-join-classes-for (classes)
1021   "returns a list of all join-classes needed for a list of classes"
1022   (loop for class in (listify classes)
1023         appending (loop for slot in (immediate-join-slots class)
1024                         collect (join-slot-class slot))))
1025
1026 (defun %tables-for-query (classes from where inner-joins)
1027   "Given lists of classes froms wheres and inner-join compile a list
1028    of tables that should appear in the FROM section of the query.
1029
1030    This includes any immediate join classes from each of the classes"
1031   (let ((inner-join-tables (collect-table-refs (listify inner-joins))))
1032     (loop for tbl in (append
1033                       (mapcar #'select-table-sql-expr classes)
1034                       (mapcar #'select-table-sql-expr
1035                               (all-immediate-join-classes-for classes))
1036                       (collect-table-refs (listify where))
1037                       (collect-table-refs (listify from)))
1038           when (and tbl
1039                     (not (find tbl rtn :test #'database-identifier-equal))
1040                     ;; TODO: inner-join is currently hacky as can be
1041                     (not (find tbl inner-join-tables :test #'database-identifier-equal)))
1042           collect tbl into rtn
1043           finally (return rtn))))
1044
1045
1046 (defclass select-list ()
1047   ((view-class :accessor view-class :initarg :view-class :initform nil)
1048    (select-list :accessor select-list :initarg :select-list :initform nil)
1049    (slot-list :accessor slot-list :initarg :slot-list :initform nil)
1050    (joins :accessor joins :initarg :joins :initform nil)
1051    (join-slots :accessor join-slots :initarg :join-slots :initform nil))
1052   (:documentation
1053    "Collects the classes, slots and their respective sql representations
1054     so that update-instance-from-recors, find-all, build-objects can share this
1055     info and calculate it once.  Joins are select-lists for each immediate join-slot
1056     but only if make-select-list is called with do-joins-p"))
1057
1058 (defmethod view-table ((o select-list))
1059   (view-table (view-class o)))
1060
1061 (defmethod sql-table ((o select-list))
1062   (sql-expression :table (view-table o)))
1063
1064 (defun make-select-list (class-and-slots &key (do-joins-p nil))
1065   "Make a select-list for the current class (or class-and-slots) object."
1066   (let* ((class-and-slots
1067            (etypecase class-and-slots
1068              (class-and-slots class-and-slots)
1069              ((or symbol standard-db-class)
1070               ;; find the first class with slots for us to select (this should be)
1071               ;; the first of its classes / parent-classes with slots
1072               (first (reverse (view-classes-and-storable-slots
1073                                (to-class class-and-slots)))))))
1074          (class (view-class class-and-slots))
1075          (join-slots (when do-joins-p (immediate-join-slots class))))
1076     (multiple-value-bind (slots sqls)
1077         (loop for slot in (slot-defs class-and-slots)
1078               for sql = (generate-attribute-reference class slot)
1079               collect slot into slots
1080               collect sql into sqls
1081               finally (return (values slots sqls)))
1082       (unless slots
1083         (error "No slots of type :base in view-class ~A" (class-name class)))
1084       (make-instance
1085        'select-list
1086        :view-class class
1087        :select-list sqls
1088        :slot-list slots
1089        :join-slots join-slots
1090        ;; only do a single layer of join objects
1091        :joins (when do-joins-p
1092                 (loop for js in join-slots
1093                       collect (make-select-list
1094                                (join-slot-class js)
1095                                :do-joins-p nil)))))))
1096
1097 (defun full-select-list ( select-lists )
1098   "Returns a list of sql-ref of things to select for the given classes
1099
1100    THIS NEEDS TO MATCH THE ORDER OF build-objects
1101   "
1102   (loop for s in (listify select-lists)
1103         appending (select-list s)
1104         appending (loop for join in (joins s)
1105                         appending (select-list join))))
1106
1107 (defun build-objects (select-lists row database &optional existing-instances)
1108   "Used by find-all to build objects.
1109
1110    THIS NEEDS TO MATCH THE ORDER OF FULL-SELECT-LIST
1111
1112    TODO: this caching scheme seems bad for a number of reasons
1113     * order is not guaranteed so references being held by one object
1114       might change to represent a different database row (seems HIGHLY
1115       suspect)
1116     * also join objects are overwritten rather than refreshed
1117
1118    TODO: the way we handle immediate joins seems only valid if it is a single
1119       object.  I suspect that making a :set :immediate join column would result
1120       in an invalid number of objects returned from the database, because there
1121       would be multiple rows per object, but we would return an object per row
1122    "
1123   (setf existing-instances (listify existing-instances))
1124   (loop
1125     for select-list in select-lists
1126     for class = (view-class select-list)
1127     for existing = (pop existing-instances)
1128     for object = (or existing
1129                      (make-instance class :view-database database))
1130     do (loop for slot in (slot-list select-list)
1131              do (update-slot-from-db-value object slot (pop row)))
1132     do (loop for join-slot in (join-slots select-list)
1133              for join in (joins select-list)
1134              for join-class = (view-class join)
1135              for join-object =
1136                 (setf (easy-slot-value object join-slot)
1137                       (make-instance join-class))
1138              do (loop for slot in (slot-list join)
1139                       do (update-slot-from-db-value join-object slot (pop row))))
1140     do (when existing (instance-refreshed object))
1141         collect object))
1142
1143 (defun find-all (view-classes
1144                  &rest args
1145                  &key all set-operation distinct from where group-by having
1146                  order-by offset limit refresh flatp result-types
1147                  inner-join on
1148                  (database *default-database*)
1149                  instances parameters)
1150   "Called by SELECT to generate object query results when the
1151   View Classes VIEW-CLASSES are passed as arguments to SELECT.
1152
1153    TODO: the caching scheme of passing in instances and overwriting their
1154          values seems bad for a number of reasons
1155     * order is not guaranteed so references being held by one object
1156       might change to represent a different database row (seems HIGHLY
1157       suspect)
1158
1159    TODO: the way we handle immediate joins seems only valid if it is a single
1160       object.  I suspect that making a :set :immediate join column would result
1161       in an invalid number of objects returned from the database, because there
1162       would be multiple objects returned from the database
1163   "
1164   (declare (ignore all set-operation group-by having offset limit on parameters
1165                    distinct order-by)
1166            (dynamic-extent args))
1167   (let* ((args (filter-plist
1168                 args :from :where :flatp :additional-fields :result-types :instances))
1169          (*db-deserializing* t)
1170          (sclasses (mapcar #'to-class view-classes))
1171          (tables (%tables-for-query sclasses from where inner-join))
1172          (join-where
1173            (loop for class in sclasses
1174                  appending (loop for slot in (immediate-join-slots class)
1175                                  collect (join-slot-qualifier class slot))))
1176          (select-lists (loop for class in sclasses
1177                              collect (make-select-list class :do-joins-p t)))
1178          (full-select-list (full-select-list select-lists))
1179          (where (clsql-ands (append (listify where) (listify join-where))))
1180          #|
1181           (_ (format t "~&sclasses: ~W~%ijc: ~W~%tables: ~W~%"
1182                     sclasses immediate-join-classes tables))
1183          |#
1184          (rows (apply #'select
1185                       (append full-select-list
1186                               (list :from tables
1187                                     :result-types result-types
1188                                     :where where)
1189                               args)))
1190          (return-objects
1191            (loop for row in rows
1192                  for old-objs = (pop instances)
1193                  for objs = (build-objects select-lists row database
1194                                            (when refresh old-objs))
1195                  collecting (if flatp
1196                                 (delist-if-single objs)
1197                                 objs))))
1198     return-objects))
1199
1200 (defmethod instance-refreshed ((instance standard-db-object)))
1201
1202 (defvar *default-caching* t
1203   "Controls whether SELECT caches objects by default. The CommonSQL
1204 specification states caching is on by default.")
1205
1206 (defun select (&rest select-all-args)
1207   "Executes a query on DATABASE, which has a default value of
1208 *DEFAULT-DATABASE*, specified by the SQL expressions supplied
1209 using the remaining arguments in SELECT-ALL-ARGS. The SELECT
1210 argument can be used to generate queries in both functional and
1211 object oriented contexts.
1212
1213 In the functional case, the required arguments specify the
1214 columns selected by the query and may be symbolic SQL expressions
1215 or strings representing attribute identifiers. Type modified
1216 identifiers indicate that the values selected from the specified
1217 column are converted to the specified lisp type. The keyword
1218 arguments ALL, DISTINCT, FROM, GROUP-by, HAVING, ORDER-BY,
1219 SET-OPERATION and WHERE are used to specify, using the symbolic
1220 SQL syntax, the corresponding components of the SQL query
1221 generated by the call to SELECT. RESULT-TYPES is a list of
1222 symbols which specifies the lisp type for each field returned by
1223 the query. If RESULT-TYPES is nil all results are returned as
1224 strings whereas the default value of :auto means that the lisp
1225 types are automatically computed for each field. FIELD-NAMES is t
1226 by default which means that the second value returned is a list
1227 of strings representing the columns selected by the query. If
1228 FIELD-NAMES is nil, the list of column names is not returned as a
1229 second value.
1230
1231 In the object oriented case, the required arguments to SELECT are
1232 symbols denoting View Classes which specify the database tables
1233 to query. In this case, SELECT returns a list of View Class
1234 instances whose slots are set from the attribute values of the
1235 records in the specified table. Slot-value is a legal operator
1236 which can be employed as part of the symbolic SQL syntax used in
1237 the WHERE keyword argument to SELECT. REFRESH is nil by default
1238 which means that the View Class instances returned are retrieved
1239 from a cache if an equivalent call to SELECT has previously been
1240 issued. If REFRESH is true, the View Class instances returned are
1241 updated as necessary from the database and the generic function
1242 INSTANCE-REFRESHED is called to perform any necessary operations
1243 on the updated instances.
1244
1245 In both object oriented and functional contexts, FLATP has a
1246 default value of nil which means that the results are returned as
1247 a list of lists. If FLATP is t and only one result is returned
1248 for each record selected in the query, the results are returned
1249 as elements of a list."
1250   (multiple-value-bind (target-args qualifier-args)
1251       (query-get-selections select-all-args)
1252     (unless (or *default-database* (getf qualifier-args :database))
1253       (signal-no-database-error nil))
1254
1255     (let ((caching (getf qualifier-args :caching *default-caching*))
1256           (result-types (getf qualifier-args :result-types :auto))
1257           (refresh (getf qualifier-args :refresh nil))
1258           (database (getf qualifier-args :database *default-database*)))
1259
1260       (cond
1261         ((and target-args
1262               (every #'(lambda (arg)
1263                          (and (symbolp arg)
1264                               (find-class arg nil)))
1265                      target-args))
1266
1267          (setf qualifier-args (filter-plist qualifier-args :caching :refresh :result-types))
1268
1269          ;; Add explicity table name to order-by if not specified and only
1270          ;; one selected table. This is required so FIND-ALL won't duplicate
1271          ;; the field
1272          (let ((order-by (getf qualifier-args :order-by)))
1273            (when (and order-by (= 1 (length target-args)))
1274              (let ((table-name (view-table (find-class (car target-args))))
1275                    (order-by-list (copy-seq (listify order-by))))
1276                (labels ((sv (val name) (ignore-errors (slot-value val name)))
1277                         (set-table-if-needed (val)
1278                           (typecase val
1279                             (sql-ident-attribute
1280                              (handler-case
1281                                  (if (sv val 'qualifier)
1282                                      val
1283                                      (make-instance 'sql-ident-attribute
1284                                                     :name (sv val 'name)
1285                                                     :qualifier table-name))
1286                                (simple-error ()
1287                                  ;; TODO: Check for a specific error we expect
1288                                  )))
1289                             (cons (cons (set-table-if-needed (car val))
1290                                         (cdr val)))
1291                             (t val))))
1292                  (setf order-by-list
1293                        (loop for i from 0 below (length order-by-list)
1294                              for id in order-by-list
1295                              collect (set-table-if-needed id))))
1296                (setf (getf qualifier-args :order-by) order-by-list))))
1297
1298          (cond
1299            ((null caching)
1300             (apply #'find-all target-args :result-types result-types :refresh refresh qualifier-args))
1301            (t
1302             (let ((cached (records-cache-results target-args qualifier-args database)))
1303               (if (and cached (not refresh))
1304                   cached
1305                   (let ((results (apply #'find-all target-args
1306                                         :result-types :auto :refresh refresh
1307                                         :instances cached
1308                                         qualifier-args)))
1309                     (setf (records-cache-results target-args qualifier-args database) results)
1310
1311                     results))))))
1312         (t
1313          (let* ((expr (apply #'make-query select-all-args))
1314                 (parameters (second (member :parameters select-all-args)))
1315                 (specified-types
1316                   (mapcar #'(lambda (attrib)
1317                               (if (typep attrib 'sql-ident-attribute)
1318                                   (let ((type (slot-value attrib 'type)))
1319                                     (if type
1320                                         type
1321                                         t))
1322                                   t))
1323                           (slot-value expr 'selections)))
1324                 (flatp (getf qualifier-args :flatp))
1325                 (field-names (getf qualifier-args :field-names t)))
1326
1327            (when parameters
1328              (setf expr (command-object (sql-output expr database) parameters)))
1329            (query expr :flatp flatp
1330                        :result-types
1331                        ;; specifying a type for an attribute overrides result-types
1332                        (if (some #'(lambda (x) (not (eq t x))) specified-types)
1333                            specified-types
1334                            result-types)
1335                        :field-names field-names
1336                        :database database)))))))
1337
1338 (defun compute-records-cache-key (targets qualifiers)
1339   (list targets
1340         (do ((args *select-arguments* (cdr args))
1341              (results nil))
1342             ((null args) results)
1343           (let* ((arg (car args))
1344                  (value (getf qualifiers arg)))
1345             (when value
1346               (push (list arg
1347                           (typecase value
1348                             (cons (cons (sql (car value)) (cdr value)))
1349                             (%sql-expression (sql value))
1350                             (t value)))
1351                     results))))))
1352
1353 (defun records-cache-results (targets qualifiers database)
1354   (when (record-caches database)
1355     (gethash (compute-records-cache-key targets qualifiers) (record-caches database))))
1356
1357 (defun (setf records-cache-results) (results targets qualifiers database)
1358   (unless (record-caches database)
1359     (setf (record-caches database)
1360           (make-weak-hash-table :test 'equal)))
1361   (setf (gethash (compute-records-cache-key (copy-list targets) qualifiers)
1362                  (record-caches database)) results)
1363   results)
1364
1365
1366
1367 ;;; Serialization functions
1368
1369 (defun write-instance-to-stream (obj stream)
1370   "Writes an instance to a stream where it can be later be read.
1371 NOTE: an error will occur if a slot holds a value which can not be written readably."
1372   (let* ((class (class-of obj))
1373          (alist '()))
1374     (dolist (slot (ordered-class-slots (class-of obj)))
1375       (let ((name (slot-definition-name slot)))
1376         (when (and (not (eq 'view-database name))
1377                    (slot-boundp obj name))
1378           (push (cons name (slot-value obj name)) alist))))
1379     (setq alist (reverse alist))
1380     (write (cons (class-name class) alist) :stream stream :readably t))
1381   obj)
1382
1383 (defun read-instance-from-stream (stream)
1384   (let ((raw (read stream nil nil)))
1385     (when raw
1386       (let ((obj (make-instance (car raw))))
1387         (dolist (pair (cdr raw))
1388           (setf (slot-value obj (car pair)) (cdr pair)))
1389         obj))))