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
 395                                                      :do-joins-p nil
 396                                                      :database database))
 397                       (view-table (sql-table select-list))
 398                       (view-qual (key-qualifier-for-instance
 399                                   instance :database vd
 400                                   :this-class (view-class select-list)))
 401                       (res (when view-qual
 402                              (first
 403                               (apply #'select
 404                                      (append (full-select-list select-list)
 405                                              (list :from view-table
 406                                                    :where view-qual
 407                                                    :result-types nil
 408                                                    :database vd)))))))
 409                  (when res
 410                    (setf (slot-value instance 'view-database) vd)
 411                    (get-slot-values-from-view instance (slot-list select-list) res))
 412                  )))
 413       (loop for class-and-slots in classes-and-slots
 414             do (do-update class-and-slots)))))
 415
 416
 417 (defmethod get-slot-value-from-record ((instance standard-db-object)
 418                                        slot &key (database *default-database*))
 419   (let* ((class-and-slot
 420            (first
 421             (view-classes-and-slots-by-name instance slot)))
 422          (view-class (view-class class-and-slot))
 423          (slot-def (first (slot-defs class-and-slot)))
 424          (vd (choose-database-for-instance instance database))
 425          (att-ref (first (attribute-references class-and-slot)))
 426          (res (first
 427                (select att-ref
 428                  :from (view-table-exp class-and-slot)
 429                  :where (key-qualifier-for-instance
 430                          instance
 431                          :database vd
 432                          :this-class view-class)
 433                  :result-types nil
 434                  :flatp T))))
 435     (values res slot-def)))
 436
 437 (defmethod update-slot-from-record ((instance standard-db-object)
 438                                     slot &key (database *default-database*))
 439   "Pulls the value of a given slot form the database and stores that in the
 440    appropriate slot on instance"
 441   (multiple-value-bind (res slot-def)
 442       (get-slot-value-from-record instance slot :database database)
 443     (let ((vd (choose-database-for-instance instance database)))
 444       (setf (slot-value instance 'view-database) vd)
 445       (update-slot-from-db-value instance slot-def res))))
 446
 447
 448 (defvar +no-slot-value+ '+no-slot-value+)
 449
 450 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
 451         (let* ((class (find-class classname))
 452                (sld (slotdef-for-slot-with-class slot class)))
 453           (if sld
 454               (if (eq value +no-slot-value+)
 455                   (sql-expression :attribute (database-identifier sld database)
 456                                   :table (view-table class))
 457                   (db-value-from-slot
 458                    sld
 459                    value
 460                    database))
 461               (error "Unknown slot ~A for class ~A" slot classname))))
 462
 463 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
 464         (declare (ignore database))
 465         (let* ((class (find-class classname)))
 466           (unless (view-table class)
 467             (error "No view-table for class ~A"  classname))
 468           (sql-expression :table (view-table class))))
 469
 470 (deftype tinyint ()
 471   "An 8-bit integer, this width may vary by SQL implementation."
 472   'integer)
 473
 474 (deftype smallint ()
 475   "An integer smaller than a 32-bit integer. this width may vary by SQL implementation."
 476   'integer)
 477
 478 (deftype mediumint ()
 479   "An integer smaller than a 32-bit integer, but may be larger than a smallint. This width may vary by SQL implementation."
 480   'integer)
 481
 482 (deftype bigint ()
 483   "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
 484   'integer)
 485
 486 (deftype varchar (&optional size)
 487   "A variable length string for the SQL varchar type."
 488   (declare (ignore size))
 489   'string)
 490
 491 (deftype universal-time ()
 492   "A positive integer as returned by GET-UNIVERSAL-TIME."
 493   '(integer 1 *))
 494
 495 (deftype generalized-boolean ()
 496   "A type which outputs a SQL boolean value, though any lisp type can be stored in the slot."
 497   t)
 498
 499 #+ignore
 500 (deftype char (&optional len)
 501   "A lisp type for the SQL CHAR type."
 502   `(string ,len))
 503
 504 (defmethod database-get-type-specifier ((type string) args database (db-type t))
 505   "Pass through the literal type as defined in the type string"
 506   (declare (ignore args database db-type))
 507   type)
 508
 509
 510 (defmethod database-get-type-specifier ((type symbol) args database db-type)
 511   (case type
 512     (char (if args
 513               (format nil "CHAR(~D)" (first args))
 514               "CHAR(1)"))
 515     ((varchar string)
 516      (if args
 517          (format nil "VARCHAR(~A)" (car args))
 518          (format nil "VARCHAR(~D)" *default-string-length*)))
 519     ((longchar text) "text")
 520     (integer (if args
 521                  (format nil "INT(~A)" (car args))
 522                  "INT"))
 523     ((tinyint smallint mediumint) "INT")
 524     ((long-float float)
 525      (if args
 526          (format nil "FLOAT(~A)" (car args))
 527          "FLOAT"))
 528     ((bigint universal-time) "BIGINT")
 529     (number
 530      (cond
 531        ((and (consp args) (= (length args) 2))
 532         (format nil "NUMBER(~D,~D)" (first args) (second args)))
 533        ((and (consp args) (= (length args) 1))
 534         (format nil "NUMBER(~D)" (first args)))
 535        (t
 536         "NUMBER")))
 537     (wall-time "TIMESTAMP")
 538     (date "DATE")
 539     (duration "VARCHAR")
 540     (money "INT8")
 541     ((boolean generalized-boolean) "BOOL")
 542     (t (warn "Could not determine a valid ~A type specifier for ~A ~A ~A, defaulting to VARCHAR "
 543              db-type type args database)
 544      (format nil "VARCHAR(~D)" *default-string-length*))))
 545
 546 (defmethod database-output-sql-as-type (type val database db-type)
 547   (declare (ignore type database db-type))
 548   val)
 549
 550 (defmethod database-output-sql-as-type ((type symbol) val database db-type)
 551   (declare (ignore database))
 552   (case type ;; booleans handle null differently
 553     ((boolean generalized-boolean)
 554      (case db-type
 555        ;; done here so it can be done once
 556        ((:mssql :mysql) (if val 1 0))
 557        (otherwise (if val "t" "f"))))
 558     (otherwise
 559      ;; in all other cases if we have nil give everyone else a shot at it,
 560      ;; which by default returns nil
 561      (if (null val)
 562          (call-next-method)
 563          (case type
 564            (symbol
 565             (format nil "~A::~A"
 566                     (package-name (symbol-package val))
 567                     (symbol-name val)))
 568            (keyword (symbol-name val))
 569            (string val)
 570            (char (etypecase val
 571                    (character (write-to-string val))
 572                    (string val)))
 573            (float (format nil "~F" val))
 574            ((list vector array)
 575             (let* ((*print-circle* t)
 576                    (*print-array* t)
 577                    (value (prin1-to-string val)))
 578               value))
 579            (otherwise (call-next-method)))))))
 580
 581 (defmethod read-sql-value (val type database db-type
 582                            &aux *read-eval*)
 583   (declare (ignore database db-type))
 584   ;; TODO: All the read-from-strings in here do not check that
 585   ;; what we read was of the correct type, should this change?
 586
 587   ;; TODO: Should this case `(typep val type)=>t` be an around
 588   ;; method that short ciruits?
 589   (cond
 590     ((null type) val) ;;we have no desired type, just give the value
 591     ((typep val type) val) ;;check that it hasn't already been converted.
 592     ((typep val 'string) (read-from-string val)) ;;maybe read will just take care of it?
 593     (T (error "Unable to read-sql-value ~a as type ~a" val type))))
 594
 595 (defmethod read-sql-value (val (type symbol) database db-type
 596                            ;; never eval while reading values
 597                            &aux *read-eval*)
 598   ;; TODO: All the read-from-strings in here do not check that
 599   ;; what we read was of the correct type, should this change?
 600   (unless (or (equalp "nil" val) (eql 'null val))
 601     (case type
 602       ((string varchar) val)
 603       (char (etypecase val
 604               (string (schar val 0))
 605               (character val)))
 606       (keyword
 607        (when (< 0 (length val))
 608          (intern (symbol-name-default-case val) :keyword)))
 609       (symbol
 610        (when (< 0 (length val))
 611          (intern (symbol-name-default-case val))))
 612       ((smallint mediumint bigint integer universal-time)
 613        (etypecase val
 614          (string (parse-integer val))
 615          (number val)))
 616       ((double-float float)
 617        ;; ensure that whatever we got is coerced to a float of the correct
 618        ;; type (eg: 1=>1.0d0)
 619        (float
 620         (etypecase val
 621           (string (let ((*read-default-float-format*
 622                           (ecase type
 623                             (float 'single-float)
 624                             (double-float 'double-float))))
 625                     (read-from-string val)))
 626           (float val))
 627         (if (eql type 'double-float) 1.0d0 1.0s0)))
 628       (number
 629        (etypecase val
 630          (string (read-from-string val))
 631          (number val)))
 632       ((boolean generalized-boolean)
 633        (if (member val '(nil t))
 634            val
 635            (etypecase val
 636              (string
 637               (when (member val '("1" "t" "true" "y") :test #'string-equal)
 638                 t))
 639              (number (not (zerop val))))))
 640       ((wall-time duration)
 641        (parse-timestring val))
 642       (date
 643        (parse-datestring val))
 644       (t (call-next-method)))))
 645
 646 ;; ------------------------------------------------------------
 647 ;; Logic for 'faulting in' :join slots
 648
 649 ;; this works, but is inefficient requiring (+ 1 n-rows)
 650 ;; SQL queries
 651 #+ignore
 652 (defun fault-join-target-slot (class object slot-def)
 653   (let* ((res (fault-join-slot-raw class object slot-def))
 654          (dbi (view-class-slot-db-info slot-def))
 655          (target-name (gethash :target-slot dbi))
 656          (target-class (find-class target-name)))
 657     (when res
 658       (mapcar (lambda (obj)
 659                 (list
 660                  (car
 661                   (fault-join-slot-raw
 662                    target-class
 663                    obj
 664                    (find target-name (class-slots (class-of obj))
 665                          :key #'slot-definition-name)))
 666                  obj))
 667               res)
 668       #+ignore ;; this doesn't work when attempting to call slot-value
 669       (mapcar (lambda (obj)
 670                 (cons obj (slot-value obj ts))) res))))
 671
 672 (defun fault-join-target-slot (class object slot-def)
 673   (let* ((dbi (view-class-slot-db-info slot-def))
 674          (ts (gethash :target-slot dbi))
 675          (jc  (gethash :join-class dbi))
 676          (jc-view-table (view-table (find-class jc)))
 677          (tdbi (view-class-slot-db-info
 678                 (find ts (class-slots (find-class jc))
 679                       :key #'slot-definition-name)))
 680          (retrieval (gethash :retrieval tdbi))
 681          (tsc (gethash :join-class tdbi))
 682          (ts-view-table (view-table (find-class tsc)))
 683          (jq (join-qualifier class object slot-def))
 684          (key (slot-value object (gethash :home-key dbi))))
 685
 686     (when jq
 687       (ecase retrieval
 688         (:immediate
 689          (let ((res
 690                 (find-all (list tsc)
 691                           :inner-join (sql-expression :table jc-view-table)
 692                           :on (sql-operation
 693                                '==
 694                                (sql-expression
 695                                 :attribute (gethash :foreign-key tdbi)
 696                                 :table ts-view-table)
 697                                (sql-expression
 698                                 :attribute (gethash :home-key tdbi)
 699                                 :table jc-view-table))
 700                           :where jq
 701                           :result-types :auto
 702                           :database (choose-database-for-instance object))))
 703            (mapcar #'(lambda (i)
 704                        (let* ((instance (car i))
 705                               (jcc (make-instance jc :view-database (choose-database-for-instance instance))))
 706                          (setf (slot-value jcc (gethash :foreign-key dbi))
 707                                key)
 708                          (setf (slot-value jcc (gethash :home-key tdbi))
 709                                (slot-value instance (gethash :foreign-key tdbi)))
 710                          (list instance jcc)))
 711                    res)))
 712         (:deferred
 713          ;; just fill in minimal slots
 714          (mapcar
 715           #'(lambda (k)
 716               (let ((instance (make-instance tsc :view-database (choose-database-for-instance object)))
 717                     (jcc (make-instance jc :view-database (choose-database-for-instance object)))
 718                     (fk (car k)))
 719                 (setf (slot-value instance (gethash :home-key tdbi)) fk)
 720                 (setf (slot-value jcc (gethash :foreign-key dbi))
 721                       key)
 722                 (setf (slot-value jcc (gethash :home-key tdbi))
 723                       fk)
 724                 (list instance jcc)))
 725           (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
 726                   :from (sql-expression :table jc-view-table)
 727                   :where jq
 728                   :database (choose-database-for-instance object))))))))
 729
 730
 731 ;;; Remote Joins
 732
 733 (defvar *default-update-objects-max-len* nil
 734   "The default value to use for the MAX-LEN keyword argument to
 735   UPDATE-OBJECT-JOINS.")
 736
 737 (defun %update-objects-joins-slot-defs (class slot-names)
 738   "Get the slot definitions for the joins slots specified as slot-names
 739    if slot-names is :immediate, :deferred or (or :all t) return all of
 740    that type of slot definitions"
 741   (setf class (to-class class))
 742   (when (eq t slot-names) (setf slot-names :all))
 743   (etypecase slot-names
 744     (null nil)
 745     (keyword
 746      ;; slot-names is the retrieval type of the join-slot or :all
 747      (get-join-slots class slot-names))
 748     ((or symbol list)
 749      (loop for slot in (listify slot-names)
 750            for def = (find-slot-by-name class slot)
 751            when (and def (join-slot-p def))
 752            collecting def
 753            unless (and def (join-slot-p def))
 754            do (warn "Unable to find join slot named ~S in class ~S." slot class)))))
 755
 756 (defun get-joined-objects (objects slotdef &key force-p
 757                                            (batch-size *default-update-objects-max-len*))
 758   "Given a list of objects and a join slot-def get the objects that need to be
 759    joined to the input objects
 760
 761    we will query in batches as large as batch-size"
 762   (when (join-slot-p slotdef)
 763     (let* ((slot-name (to-slot-name slotdef))
 764            (join-class (join-slot-class-name slotdef))
 765            (home-key (join-slot-info-value slotdef :home-key))
 766            (foreign-key (join-slot-info-value slotdef :foreign-key))
 767            (foreign-key-values
 768              (remove-duplicates
 769               (loop for object in (listify objects)
 770                     for hk = (slot-value object home-key)
 771                     when (or force-p
 772                              (not (slot-boundp object slot-name)))
 773                     collect hk)
 774               :test #'equal)))
 775       ;; we want to retrieve at most batch-size objects per query
 776       (flet ((fetch (keys)
 777                (find-all
 778                 (list join-class)
 779                 :where (make-instance
 780                         'sql-relational-exp
 781                         :operator 'in
 782                         :sub-expressions (list (sql-expression :attribute foreign-key)
 783                                                keys))
 784                 :result-types :auto
 785                 :flatp t)))
 786         (if (null batch-size)
 787             (fetch foreign-key-values)
 788             (loop
 789               for keys = (pop-n foreign-key-values batch-size)
 790               while keys
 791               nconcing (fetch keys)))))))
 792
 793 (defun %object-joins-from-list (object slot joins force-p )
 794   "Given a list of objects that we are trying to join to, pull the correct
 795    ones for this object"
 796   (when (or force-p (not (slot-boundp object (to-slot-name slot))))
 797     (let ((home-key (join-slot-info-value slot :home-key))
 798           (foreign-key (join-slot-info-value slot :foreign-key)))
 799       (loop for join in joins
 800             when (equal (slot-value join foreign-key)
 801                         (slot-value object home-key))
 802             collect join))))
 803
 804 (defun update-objects-joins (objects &key (slots :immediate) (force-p t)
 805                                      class-name (max-len *default-update-objects-max-len*))
 806   "Updates from the records of the appropriate database tables the join slots
 807    specified by SLOTS in the supplied list of View Class instances OBJECTS.
 808
 809    A simpler method of causing a join-slot to be requeried is to set it to
 810    unbound, then request it again.  This function has efficiency gains where
 811    join-objects are shared among the `objects` (querying all join-objects,
 812    then attaching them appropriately to each of the `objects`)
 813
 814    SLOTS can be one of:
 815
 816     * :immediate (DEFAULT) - refresh join slots created with :retrieval :immediate
 817     * :deferred - refresh join slots created with :retrieval :deferred
 818     * :all,t - refresh all join slots regardless of :retrieval
 819     * list of symbols - which explicit slots to refresh
 820     * a single symobl - what slot to refresh
 821
 822    CLASS-NAME is used to specify the View Class of all instance in OBJECTS and
 823    default to nil which means that the class of the first instance in OBJECTS
 824    is used.
 825
 826    FORCE-P is t by default which means that all join slots are updated whereas
 827    a value of nil means that only unbound join slots are updated.
 828
 829    MAX-LEN defaults to *DEFAULT-UPDATE-OBJECTS-MAX-LEN* When non-nil this is
 830    essentially a batch size for the max number of objects to query from the
 831    database at a time.  If we need more than max-len we loop till we have all
 832    the objects"
 833   (assert (or (null max-len) (plusp max-len)))
 834   (when objects
 835     (defaulting class-name (class-name (class-of (first objects))))
 836     (let* ((class (find-class class-name))
 837            (slotdefs (%update-objects-joins-slot-defs class slots)))
 838       (loop for slotdef in slotdefs
 839             ;; all the joins we will need for *all* the objects
 840             ;; which then get filtered below for each object
 841             for joins = (unless (join-slot-info-value slotdef :target-slot)
 842                           (get-joined-objects objects slotdef
 843                                               :force-p force-p :batch-size max-len))
 844             do (loop for object in objects
 845                      for these-joins = ;; the joins just for this object (filtered from above)
 846                                        ;; or retrieved via fault-join-target-slot
 847                         (or (%object-joins-from-list object slotdef joins force-p)
 848                             (when (join-slot-info-value slotdef :target-slot)
 849                               (fault-join-target-slot class object slotdef)))
 850                      ;; when this object has joined-objects copy them in to the correct slot
 851                      do (when these-joins
 852                           (setf (easy-slot-value object slotdef)
 853                                 (if (join-slot-info-value slotdef :set)
 854                                     these-joins
 855                                     (first these-joins))))))))
 856   (values))
 857
 858 (defun fault-join-slot-raw (class object slot-def)
 859   (let* ((dbi (view-class-slot-db-info slot-def))
 860          (jc (gethash :join-class dbi)))
 861     (let ((jq (join-qualifier class object slot-def)))
 862       (when jq
 863         (select jc :where jq :flatp t :result-types nil
 864                 :database (choose-database-for-instance object))))))
 865
 866 (defun fault-join-slot (class object slot-def)
 867   (let* ((dbi (view-class-slot-db-info slot-def))
 868          (ts (gethash :target-slot dbi))
 869          (dbi-set (gethash :set dbi)))
 870     (if (and ts dbi-set)
 871         (fault-join-target-slot class object slot-def)
 872         (let ((res (fault-join-slot-raw class object slot-def)))
 873           (when res
 874             (cond
 875               ((and ts (not dbi-set))
 876                (mapcar (lambda (obj) (slot-value obj ts)) res))
 877               ((and (not ts) (not dbi-set))
 878                (car res))
 879               ((and (not ts) dbi-set)
 880                res)))))))
 881
 882 (defun update-fault-join-normalized-slot (class object slot-def)
 883   (if (and (normalizedp class) (key-slot-p slot-def))
 884       (setf (easy-slot-value object slot-def)
 885             (normalized-key-value object))
 886       (update-slot-from-record object slot-def)))
 887
 888 (defun all-home-keys-have-values-p (object slot-def)
 889   "Do all of the home-keys have values ?"
 890   (let ((home-keys (join-slot-info-value slot-def :home-key)))
 891     (loop for key in (listify home-keys)
 892           always (easy-slot-value object key))))
 893
 894 (defun join-qualifier (class object slot-def)
 895   "Builds the join where clause based on the keys of the join slot and values
 896    of the object"
 897   (declare (ignore class))
 898   (let* ((jc (join-slot-class slot-def))
 899          ;;(ts (gethash :target-slot dbi))
 900          ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
 901          (foreign-keys (listify (join-slot-info-value slot-def :foreign-key)))
 902          (home-keys (listify (join-slot-info-value slot-def :home-key))))
 903     (when (all-home-keys-have-values-p object slot-def)
 904       (clsql-ands
 905        (loop for hk in home-keys
 906              for fk in foreign-keys
 907              for fksd = (slotdef-for-slot-with-class fk jc)
 908              for fk-sql = (typecase fk
 909                             (symbol
 910                              (sql-expression
 911                               :attribute (database-identifier fksd nil)
 912                               :table (database-identifier jc nil)))
 913                             (t fk))
 914              for hk-val = (typecase hk
 915                             ((or symbol
 916                                  view-class-effective-slot-definition
 917                                  view-class-direct-slot-definition)
 918                              (easy-slot-value object hk))
 919                             (t hk))
 920              collect (sql-operation '== fk-sql hk-val))))))
 921
 922 (defmethod select-table-sql-expr ((table T))
 923   "Turns an object representing a table into the :from part of the sql expression that will be executed "
 924   (sql-expression :table (view-table table)))
 925
 926 (defun select-reference-equal (r1 r2)
 927   "determines if two sql select references are equal
 928    using database identifier equal"
 929   (flet ((id-of (r)
 930            (etypecase r
 931              (cons (cdr r))
 932              (sql-ident-attribute r))))
 933     (database-identifier-equal (id-of r1) (id-of r2))))
 934
 935 (defun join-slot-qualifier (class join-slot)
 936   "Creates a sql-expression expressing the join between the home-key on the table
 937    and its respective key on the joined-to-table"
 938   (sql-operation
 939    '==
 940    (sql-expression
 941     :attribute (join-slot-info-value join-slot :foreign-key)
 942     :table (view-table (join-slot-class join-slot)))
 943    (sql-expression
 944     :attribute (join-slot-info-value join-slot :home-key)
 945     :table (view-table class))))
 946
 947 (defun all-immediate-join-classes-for (classes)
 948   "returns a list of all join-classes needed for a list of classes"
 949   (loop for class in (listify classes)
 950         appending (loop for slot in (immediate-join-slots class)
 951                         collect (join-slot-class slot))))
 952
 953 (defun %tables-for-query (classes from where inner-joins)
 954   "Given lists of classes froms wheres and inner-join compile a list
 955    of tables that should appear in the FROM section of the query.
 956
 957    This includes any immediate join classes from each of the classes"
 958   (let ((inner-join-tables (collect-table-refs (listify inner-joins))))
 959     (loop for tbl in (append
 960                       (mapcar #'select-table-sql-expr classes)
 961                       (mapcar #'select-table-sql-expr
 962                               (all-immediate-join-classes-for classes))
 963                       (collect-table-refs (listify where))
 964                       (collect-table-refs (listify from)))
 965           when (and tbl
 966                     (not (find tbl rtn :test #'database-identifier-equal))
 967                     ;; TODO: inner-join is currently hacky as can be
 968                     (not (find tbl inner-join-tables :test #'database-identifier-equal)))
 969           collect tbl into rtn
 970           finally (return rtn))))
 971
 972
 973 (defclass select-list ()
 974   ((view-class :accessor view-class :initarg :view-class :initform nil)
 975    (select-list :accessor select-list :initarg :select-list :initform nil)
 976    (slot-list :accessor slot-list :initarg :slot-list :initform nil)
 977    (joins :accessor joins :initarg :joins :initform nil)
 978    (join-slots :accessor join-slots :initarg :join-slots :initform nil))
 979   (:documentation
 980    "Collects the classes, slots and their respective sql representations
 981     so that update-instance-from-recors, find-all, build-objects can share this
 982     info and calculate it once.  Joins are select-lists for each immediate join-slot
 983     but only if make-select-list is called with do-joins-p"))
 984
 985 (defmethod view-table ((o select-list))
 986   (view-table (view-class o)))
 987
 988 (defmethod sql-table ((o select-list))
 989   (sql-expression :table (view-table o)))
 990
 991 (defmethod filter-select-list ((c clsql-sys::standard-db-object)
 992                                (sl clsql-sys::select-list)
 993                                database)
 994   sl)
 995
 996 (defun make-select-list (class-and-slots &key (do-joins-p nil)
 997                                          (database *default-database*))
 998   "Make a select-list for the current class (or class-and-slots) object."
 999   (let* ((class-and-slots
1000            (etypecase class-and-slots
1001              (class-and-slots class-and-slots)
1002              ((or symbol standard-db-class)
1003               ;; find the first class with slots for us to select (this should be)
1004               ;; the first of its classes / parent-classes with slots
1005               (first (reverse (view-classes-and-storable-slots
1006                                (to-class class-and-slots)))))))
1007          (class (view-class class-and-slots))
1008          (join-slots (when do-joins-p (immediate-join-slots class))))
1009     (multiple-value-bind (slots sqls)
1010         (loop for slot in (slot-defs class-and-slots)
1011               for sql = (generate-attribute-reference class slot)
1012               collect slot into slots
1013               collect sql into sqls
1014               finally (return (values slots sqls)))
1015       (unless slots
1016         (error "No slots of type :base in view-class ~A" (class-name class)))
1017       (let ((sl (make-instance
1018                  'select-list
1019                  :view-class class
1020                  :select-list sqls
1021                  :slot-list slots
1022                  :join-slots join-slots
1023                  ;; only do a single layer of join objects
1024                  :joins (when do-joins-p
1025                           (loop for js in join-slots
1026                                 collect (make-select-list
1027                                          (join-slot-class js)
1028                                          :do-joins-p nil
1029                                          :database database))))))
1030         (filter-select-list (make-instance class) sl database)
1031         sl))))
1032
1033 (defun full-select-list ( select-lists )
1034   "Returns a list of sql-ref of things to select for the given classes
1035
1036    THIS NEEDS TO MATCH THE ORDER OF build-objects
1037   "
1038   (loop for s in (listify select-lists)
1039         appending (select-list s)
1040         appending (loop for join in (joins s)
1041                         appending (select-list join))))
1042
1043 (defun build-objects (select-lists row database &optional existing-instances)
1044   "Used by find-all to build objects.
1045
1046    THIS NEEDS TO MATCH THE ORDER OF FULL-SELECT-LIST
1047
1048    TODO: this caching scheme seems bad for a number of reasons
1049     * order is not guaranteed so references being held by one object
1050       might change to represent a different database row (seems HIGHLY
1051       suspect)
1052     * also join objects are overwritten rather than refreshed
1053
1054    TODO: the way we handle immediate joins seems only valid if it is a single
1055       object.  I suspect that making a :set :immediate join column would result
1056       in an invalid number of objects returned from the database, because there
1057       would be multiple rows per object, but we would return an object per row
1058    "
1059   (setf existing-instances (listify existing-instances))
1060   (loop
1061     for select-list in select-lists
1062     for class = (view-class select-list)
1063     for existing = (pop existing-instances)
1064     for object = (or existing
1065                      (make-instance class :view-database database))
1066     do (loop for slot in (slot-list select-list)
1067              do (update-slot-from-db-value object slot (pop row)))
1068     do (loop for join-slot in (join-slots select-list)
1069              for join in (joins select-list)
1070              for join-class = (view-class join)
1071              for join-object =
1072                 (setf (easy-slot-value object join-slot)
1073                       (make-instance join-class))
1074              do (loop for slot in (slot-list join)
1075                       do (update-slot-from-db-value join-object slot (pop row))))
1076     do (when existing (instance-refreshed object))
1077         collect object))
1078
1079 (defun find-all (view-classes
1080                  &rest args
1081                  &key all set-operation distinct from where group-by having
1082                  order-by offset limit refresh flatp result-types
1083                  inner-join on
1084                  (database *default-database*)
1085                  instances parameters)
1086   "Called by SELECT to generate object query results when the
1087   View Classes VIEW-CLASSES are passed as arguments to SELECT.
1088
1089    TODO: the caching scheme of passing in instances and overwriting their
1090          values seems bad for a number of reasons
1091     * order is not guaranteed so references being held by one object
1092       might change to represent a different database row (seems HIGHLY
1093       suspect)
1094
1095    TODO: the way we handle immediate joins seems only valid if it is a single
1096       object.  I suspect that making a :set :immediate join column would result
1097       in an invalid number of objects returned from the database, because there
1098       would be multiple objects returned from the database
1099   "
1100   (declare (ignore all set-operation group-by having offset limit on parameters
1101                    distinct order-by)
1102            (dynamic-extent args))
1103   (let* ((args (filter-plist
1104                 args :from :where :flatp :additional-fields :result-types :instances))
1105          (*db-deserializing* t)
1106          (sclasses (mapcar #'to-class view-classes))
1107          (tables (%tables-for-query sclasses from where inner-join))
1108          (join-where
1109            (loop for class in sclasses
1110                  appending (loop for slot in (immediate-join-slots class)
1111                                  collect (join-slot-qualifier class slot))))
1112          (select-lists (loop for class in sclasses
1113                              collect (make-select-list class :do-joins-p t :database database)))
1114          (full-select-list (full-select-list select-lists))
1115          (where (clsql-ands (append (listify where) (listify join-where))))
1116          #|
1117           (_ (format t "~&sclasses: ~W~%ijc: ~W~%tables: ~W~%"
1118                     sclasses immediate-join-classes tables))
1119          |#
1120          (rows (apply #'select
1121                       (append full-select-list
1122                               (list :from tables
1123                                     :result-types result-types
1124                                     :where where)
1125                               args)))
1126          (return-objects
1127            (loop for row in rows
1128                  for old-objs = (pop instances)
1129                  for objs = (build-objects select-lists row database
1130                                            (when refresh old-objs))
1131                  collecting (if flatp
1132                                 (delist-if-single objs)
1133                                 objs))))
1134     return-objects))
1135
1136 (defmethod instance-refreshed ((instance standard-db-object)))
1137
1138 (defvar *default-caching* t
1139   "Controls whether SELECT caches objects by default. The CommonSQL
1140 specification states caching is on by default.")
1141
1142 (defun select (&rest select-all-args)
1143   "Executes a query on DATABASE, which has a default value of
1144 *DEFAULT-DATABASE*, specified by the SQL expressions supplied
1145 using the remaining arguments in SELECT-ALL-ARGS. The SELECT
1146 argument can be used to generate queries in both functional and
1147 object oriented contexts.
1148
1149 In the functional case, the required arguments specify the
1150 columns selected by the query and may be symbolic SQL expressions
1151 or strings representing attribute identifiers. Type modified
1152 identifiers indicate that the values selected from the specified
1153 column are converted to the specified lisp type. The keyword
1154 arguments ALL, DISTINCT, FROM, GROUP-by, HAVING, ORDER-BY,
1155 SET-OPERATION and WHERE are used to specify, using the symbolic
1156 SQL syntax, the corresponding components of the SQL query
1157 generated by the call to SELECT. RESULT-TYPES is a list of
1158 symbols which specifies the lisp type for each field returned by
1159 the query. If RESULT-TYPES is nil all results are returned as
1160 strings whereas the default value of :auto means that the lisp
1161 types are automatically computed for each field. FIELD-NAMES is t
1162 by default which means that the second value returned is a list
1163 of strings representing the columns selected by the query. If
1164 FIELD-NAMES is nil, the list of column names is not returned as a
1165 second value.
1166
1167 In the object oriented case, the required arguments to SELECT are
1168 symbols denoting View Classes which specify the database tables
1169 to query. In this case, SELECT returns a list of View Class
1170 instances whose slots are set from the attribute values of the
1171 records in the specified table. Slot-value is a legal operator
1172 which can be employed as part of the symbolic SQL syntax used in
1173 the WHERE keyword argument to SELECT. REFRESH is nil by default
1174 which means that the View Class instances returned are retrieved
1175 from a cache if an equivalent call to SELECT has previously been
1176 issued. If REFRESH is true, the View Class instances returned are
1177 updated as necessary from the database and the generic function
1178 INSTANCE-REFRESHED is called to perform any necessary operations
1179 on the updated instances.
1180
1181 In both object oriented and functional contexts, FLATP has a
1182 default value of nil which means that the results are returned as
1183 a list of lists. If FLATP is t and only one result is returned
1184 for each record selected in the query, the results are returned
1185 as elements of a list."
1186   (multiple-value-bind (target-args qualifier-args)
1187       (query-get-selections select-all-args)
1188     (unless (or *default-database* (getf qualifier-args :database))
1189       (signal-no-database-error nil))
1190
1191     (let ((caching (getf qualifier-args :caching *default-caching*))
1192           (result-types (getf qualifier-args :result-types :auto))
1193           (refresh (getf qualifier-args :refresh nil))
1194           (database (getf qualifier-args :database *default-database*)))
1195
1196       (cond
1197         ((and target-args
1198               (every #'(lambda (arg)
1199                          (and (symbolp arg)
1200                               (find-class arg nil)))
1201                      target-args))
1202
1203          (setf qualifier-args (filter-plist qualifier-args :caching :refresh :result-types))
1204
1205          ;; Add explicity table name to order-by if not specified and only
1206          ;; one selected table. This is required so FIND-ALL won't duplicate
1207          ;; the field
1208          (let ((order-by (getf qualifier-args :order-by)))
1209            (when (and order-by (= 1 (length target-args)))
1210              (let ((table-name (view-table (find-class (car target-args))))
1211                    (order-by-list (copy-seq (listify order-by))))
1212                (labels ((sv (val name) (ignore-errors (slot-value val name)))
1213                         (set-table-if-needed (val)
1214                           (typecase val
1215                             (sql-ident-attribute
1216                              (handler-case
1217                                  (if (sv val 'qualifier)
1218                                      val
1219                                      (make-instance 'sql-ident-attribute
1220                                                     :name (sv val 'name)
1221                                                     :qualifier table-name))
1222                                (simple-error ()
1223                                  ;; TODO: Check for a specific error we expect
1224                                  )))
1225                             (cons (cons (set-table-if-needed (car val))
1226                                         (cdr val)))
1227                             (t val))))
1228                  (setf order-by-list
1229                        (loop for i from 0 below (length order-by-list)
1230                              for id in order-by-list
1231                              collect (set-table-if-needed id))))
1232                (setf (getf qualifier-args :order-by) order-by-list))))
1233
1234          (cond
1235            ((null caching)
1236             (apply #'find-all target-args :result-types result-types :refresh refresh qualifier-args))
1237            (t
1238             (let ((cached (records-cache-results target-args qualifier-args database)))
1239               (if (and cached (not refresh))
1240                   cached
1241                   (let ((results (apply #'find-all target-args
1242                                         :result-types :auto :refresh refresh
1243                                         :instances cached
1244                                         qualifier-args)))
1245                     (setf (records-cache-results target-args qualifier-args database) results)
1246
1247                     results))))))
1248         (t
1249          (let* ((expr (apply #'make-query select-all-args))
1250                 (parameters (second (member :parameters select-all-args)))
1251                 (specified-types
1252                   (mapcar #'(lambda (attrib)
1253                               (if (typep attrib 'sql-ident-attribute)
1254                                   (let ((type (slot-value attrib 'type)))
1255                                     (if type
1256                                         type
1257                                         t))
1258                                   t))
1259                           (slot-value expr 'selections)))
1260                 (flatp (getf qualifier-args :flatp))
1261                 (field-names (getf qualifier-args :field-names t)))
1262
1263            (when parameters
1264              (setf expr (command-object (sql-output expr database) parameters)))
1265            (query expr :flatp flatp
1266                        :result-types
1267                        ;; specifying a type for an attribute overrides result-types
1268                        (if (some #'(lambda (x) (not (eq t x))) specified-types)
1269                            specified-types
1270                            result-types)
1271                        :field-names field-names
1272                        :database database)))))))
1273
1274 (defun compute-records-cache-key (targets qualifiers)
1275   (list targets
1276         (do ((args *select-arguments* (cdr args))
1277              (results nil))
1278             ((null args) results)
1279           (let* ((arg (car args))
1280                  (value (getf qualifiers arg)))
1281             (when value
1282               (push (list arg
1283                           (typecase value
1284                             (cons (cons (sql (car value)) (cdr value)))
1285                             (%sql-expression (sql value))
1286                             (t value)))
1287                     results))))))
1288
1289 (defun records-cache-results (targets qualifiers database)
1290   (when (record-caches database)
1291     (gethash (compute-records-cache-key targets qualifiers) (record-caches database))))
1292
1293 (defun (setf records-cache-results) (results targets qualifiers database)
1294   (unless (record-caches database)
1295     (setf (record-caches database)
1296           (make-weak-hash-table :test 'equal)))
1297   (setf (gethash (compute-records-cache-key (copy-list targets) qualifiers)
1298                  (record-caches database)) results)
1299   results)
1300
1301
1302
1303 ;;; Serialization functions
1304
1305 (defun write-instance-to-stream (obj stream)
1306   "Writes an instance to a stream where it can be later be read.
1307 NOTE: an error will occur if a slot holds a value which can not be written readably."
1308   (let* ((class (class-of obj))
1309          (alist '()))
1310     (dolist (slot (ordered-class-slots (class-of obj)))
1311       (let ((name (slot-definition-name slot)))
1312         (when (and (not (eq 'view-database name))
1313                    (slot-boundp obj name))
1314           (push (cons name (slot-value obj name)) alist))))
1315     (setq alist (reverse alist))
1316     (write (cons (class-name class) alist) :stream stream :readably t))
1317   obj)
1318
1319 (defun read-instance-from-stream (stream)
1320   (let ((raw (read stream nil nil)))
1321     (when raw
1322       (let ((obj (make-instance (car raw))))
1323         (dolist (pair (cdr raw))
1324           (setf (slot-value obj (car pair)) (cdr pair)))
1325         obj))))