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