sql/oodml.lisp

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