sql/objects.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; The CLSQL Object Oriented Data Definitional Language (OODDL)
   7 ;;;; and Object Oriented Data Manipulation Language (OODML).
   8 ;;;;
   9 ;;;; This file is part of CLSQL.
  10 ;;;;
  11 ;;;; CLSQL users are granted the rights to distribute and use this software
  12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  14 ;;;; *************************************************************************
  15
  16 (in-package #:clsql-sys)
  17
  18 (defclass standard-db-object ()
  19   ((view-database :initform nil :initarg :view-database :reader view-database
  20     :db-kind :virtual))
  21   (:metaclass standard-db-class)
  22   (:documentation "Superclass for all CLSQL View Classes."))
  23
  24 (defvar *db-deserializing* nil)
  25 (defvar *db-initializing* nil)
  26
  27 (defmethod slot-value-using-class ((class standard-db-class) instance slot-def)
  28   (declare (optimize (speed 3)))
  29   (unless *db-deserializing*
  30     (let* ((slot-name (%svuc-slot-name slot-def))
  31            (slot-object (%svuc-slot-object slot-def class))
  32            (slot-kind (view-class-slot-db-kind slot-object)))
  33       (when (and (eql slot-kind :join)
  34                  (not (slot-boundp instance slot-name)))
  35         (let ((*db-deserializing* t))
  36           (if (view-database instance)
  37               (setf (slot-value instance slot-name)
  38                     (fault-join-slot class instance slot-object))
  39               (setf (slot-value instance slot-name) nil))))))
  40   (call-next-method))
  41
  42 (defmethod (setf slot-value-using-class) (new-value (class standard-db-class)
  43                                           instance slot)
  44   (declare (ignore new-value instance slot))
  45   (call-next-method))
  46
  47 (defmethod initialize-instance :around ((object standard-db-object)
  48                                         &rest all-keys &key &allow-other-keys)
  49   (declare (ignore all-keys))
  50   (let ((*db-initializing* t))
  51     (call-next-method)
  52     (unless *db-deserializing*
  53       #+nil (created-object object)
  54       (update-records-from-instance object))))
  55
  56 ;;
  57 ;; Build the database tables required to store the given view class
  58 ;;
  59
  60 (defun create-view-from-class (view-class-name
  61                                &key (database *default-database*))
  62   "Creates a view in DATABASE based on VIEW-CLASS-NAME which defines
  63 the view. The argument DATABASE has a default value of
  64 *DEFAULT-DATABASE*."
  65   (let ((tclass (find-class view-class-name)))
  66     (if tclass
  67         (let ((*default-database* database))
  68           (%install-class tclass database))
  69         (error "Class ~s not found." view-class-name)))
  70   (values))
  71
  72 (defmethod %install-class ((self standard-db-class) database &aux schemadef)
  73   (dolist (slotdef (ordered-class-slots self))
  74     (let ((res (database-generate-column-definition (class-name self)
  75                                                     slotdef database)))
  76       (when res
  77         (push res schemadef))))
  78   (unless schemadef
  79     (error "Class ~s has no :base slots" self))
  80   (create-table (sql-expression :table (view-table self)) schemadef
  81                 :database database
  82                 :constraints (database-pkey-constraint self database))
  83   (push self (database-view-classes database))
  84   t)
  85
  86 (defmethod database-pkey-constraint ((class standard-db-class) database)
  87   (let ((keylist (mapcar #'view-class-slot-column (keyslots-for-class class))))
  88     (when keylist
  89       (convert-to-db-default-case
  90        (format nil "CONSTRAINT ~APK PRIMARY KEY~A"
  91                (database-output-sql (view-table class) database)
  92                (database-output-sql keylist database))
  93        database))))
  94
  95 (defmethod database-generate-column-definition (class slotdef database)
  96   (declare (ignore database class))
  97   (when (member (view-class-slot-db-kind slotdef) '(:base :key))
  98     (let ((cdef
  99            (list (sql-expression :attribute (view-class-slot-column slotdef))
 100                  (slot-type slotdef))))
 101       (setf cdef (append cdef (list (view-class-slot-db-type slotdef))))
 102       (let ((const (view-class-slot-db-constraints slotdef)))
 103         (when const
 104           (setq cdef (append cdef (list const)))))
 105       cdef)))
 106
 107
 108 ;;
 109 ;; Drop the tables which store the given view class
 110 ;;
 111
 112 (defun drop-view-from-class (view-class-name &key (database *default-database*))
 113   "Deletes a view or base table from DATABASE based on VIEW-CLASS-NAME
 114 which defines that view. The argument DATABASE has a default value of
 115 *DEFAULT-DATABASE*."
 116   (let ((tclass (find-class view-class-name)))
 117     (if tclass
 118         (let ((*default-database* database))
 119           (%uninstall-class tclass))
 120         (error "Class ~s not found." view-class-name)))
 121   (values))
 122
 123 (defun %uninstall-class (self &key (database *default-database*))
 124   (drop-table (sql-expression :table (view-table self))
 125               :if-does-not-exist :ignore
 126               :database database)
 127   (setf (database-view-classes database)
 128         (remove self (database-view-classes database))))
 129
 130
 131 ;;
 132 ;; List all known view classes
 133 ;;
 134
 135 (defun list-classes (&key (test #'identity)
 136                      (root-class (find-class 'standard-db-object))
 137                      (database *default-database*))
 138   "The LIST-CLASSES function collects all the classes below
 139 ROOT-CLASS, which defaults to standard-db-object, that are connected
 140 to the supplied DATABASE and which satisfy the TEST function. The
 141 default for the TEST argument is identity. By default, LIST-CLASSES
 142 returns a list of all the classes connected to the default database,
 143 *DEFAULT-DATABASE*."
 144   (flet ((find-superclass (class)
 145            (member root-class (class-precedence-list class))))
 146     (let ((view-classes (and database (database-view-classes database))))
 147       (when view-classes
 148         (remove-if #'(lambda (c) (or (not (funcall test c))
 149                                      (not (find-superclass c))))
 150                    view-classes)))))
 151
 152 ;;
 153 ;; Define a new view class
 154 ;;
 155
 156 (defmacro def-view-class (class supers slots &rest cl-options)
 157   "Extends the syntax of defclass to allow special slots to be mapped
 158 onto the attributes of database views. The macro DEF-VIEW-CLASS
 159 creates a class called CLASS which maps onto a database view. Such a
 160 class is called a View Class. The macro DEF-VIEW-CLASS extends the
 161 syntax of DEFCLASS to allow special base slots to be mapped onto the
 162 attributes of database views (presently single tables). When a select
 163 query that names a View Class is submitted, then the corresponding
 164 database view is queried, and the slots in the resulting View Class
 165 instances are filled with attribute values from the database. If
 166 SUPERS is nil then STANDARD-DB-OBJECT automatically becomes the
 167 superclass of the newly-defined View Class."
 168   `(progn
 169     (defclass ,class ,supers ,slots
 170       ,@(if (find :metaclass `,cl-options :key #'car)
 171             `,cl-options
 172             (cons '(:metaclass clsql-sys::standard-db-class) `,cl-options)))
 173     (finalize-inheritance (find-class ',class))))
 174
 175 (defun keyslots-for-class (class)
 176   (slot-value class 'key-slots))
 177
 178 (defun key-qualifier-for-instance (obj &key (database *default-database*))
 179   (let ((tb (view-table (class-of obj))))
 180     (flet ((qfk (k)
 181              (sql-operation '==
 182                             (sql-expression :attribute
 183                                             (view-class-slot-column k)
 184                                             :table tb)
 185                             (db-value-from-slot
 186                              k
 187                              (slot-value obj (slot-definition-name k))
 188                              database))))
 189       (let* ((keys (keyslots-for-class (class-of obj)))
 190              (keyxprs (mapcar #'qfk (reverse keys))))
 191         (cond
 192           ((= (length keyxprs) 0) nil)
 193           ((= (length keyxprs) 1) (car keyxprs))
 194           ((> (length keyxprs) 1) (apply #'sql-operation 'and keyxprs)))))))
 195
 196 ;;
 197 ;; Function used by 'generate-selection-list'
 198 ;;
 199
 200 (defun generate-attribute-reference (vclass slotdef)
 201   (cond
 202    ((eq (view-class-slot-db-kind slotdef) :base)
 203     (sql-expression :attribute (view-class-slot-column slotdef)
 204                     :table (view-table vclass)))
 205    ((eq (view-class-slot-db-kind slotdef) :key)
 206     (sql-expression :attribute (view-class-slot-column slotdef)
 207                     :table (view-table vclass)))
 208    (t nil)))
 209
 210 ;;
 211 ;; Function used by 'find-all'
 212 ;;
 213
 214 (defun generate-selection-list (vclass)
 215   (let ((sels nil))
 216     (dolist (slotdef (ordered-class-slots vclass))
 217       (let ((res (generate-attribute-reference vclass slotdef)))
 218         (when res
 219           (push (cons slotdef res) sels))))
 220     (if sels
 221         sels
 222         (error "No slots of type :base in view-class ~A" (class-name vclass)))))
 223
 224
 225 ;;
 226 ;; Called by 'get-slot-values-from-view'
 227 ;;
 228
 229 (declaim (inline delistify))
 230 (defun delistify (list)
 231   (if (listp list)
 232       (car list)
 233       list))
 234
 235 (defun slot-type (slotdef)
 236   (specified-type slotdef))
 237
 238 (defvar *update-context* nil)
 239
 240 (defmethod update-slot-from-db ((instance standard-db-object) slotdef value)
 241   (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
 242   (let* ((slot-reader (view-class-slot-db-reader slotdef))
 243          (slot-name   (slot-definition-name slotdef))
 244          (slot-type   (slot-type slotdef))
 245          (*update-context* (cons (type-of instance) slot-name)))
 246     (cond ((and value (null slot-reader))
 247            (setf (slot-value instance slot-name)
 248                  (read-sql-value value (delistify slot-type)
 249                                  (view-database instance))))
 250           ((null value)
 251            (update-slot-with-null instance slot-name slotdef))
 252           ((typep slot-reader 'string)
 253            (setf (slot-value instance slot-name)
 254                  (format nil slot-reader value)))
 255           ((typep slot-reader 'function)
 256            (setf (slot-value instance slot-name)
 257                  (apply slot-reader (list value))))
 258           (t
 259            (error "Slot reader is of an unusual type.")))))
 260
 261 (defmethod key-value-from-db (slotdef value database)
 262   (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
 263   (let ((slot-reader (view-class-slot-db-reader slotdef))
 264         (slot-type (slot-type slotdef)))
 265     (cond ((and value (null slot-reader))
 266            (read-sql-value value (delistify slot-type) database))
 267           ((null value)
 268            nil)
 269           ((typep slot-reader 'string)
 270            (format nil slot-reader value))
 271           ((typep slot-reader 'function)
 272            (apply slot-reader (list value)))
 273           (t
 274            (error "Slot reader is of an unusual type.")))))
 275
 276 (defun db-value-from-slot (slotdef val database)
 277   (let ((dbwriter (view-class-slot-db-writer slotdef))
 278         (dbtype (slot-type slotdef)))
 279     (typecase dbwriter
 280       (string (format nil dbwriter val))
 281       (function (apply dbwriter (list val)))
 282       (t
 283        (typecase dbtype
 284          (cons
 285           (database-output-sql-as-type (car dbtype) val database))
 286          (t
 287           (database-output-sql-as-type dbtype val database)))))))
 288
 289 (defun check-slot-type (slotdef val)
 290   (let* ((slot-type (slot-type slotdef))
 291          (basetype (if (listp slot-type) (car slot-type) slot-type)))
 292     (when (and slot-type val)
 293       (unless (typep val basetype)
 294         (error 'clsql-type-error
 295                :slotname (slot-definition-name slotdef)
 296                :typespec slot-type
 297                :value val)))))
 298
 299 ;;
 300 ;; Called by find-all
 301 ;;
 302
 303 (defmethod get-slot-values-from-view (obj slotdeflist values)
 304     (flet ((update-slot (slot-def values)
 305              (update-slot-from-db obj slot-def values)))
 306       (mapc #'update-slot slotdeflist values)
 307       obj))
 308
 309 (defmethod update-record-from-slot ((obj standard-db-object) slot &key
 310                                     (database *default-database*))
 311   (let* ((database (or (view-database obj) database))
 312          (vct (view-table (class-of obj)))
 313          (sd (slotdef-for-slot-with-class slot (class-of obj))))
 314     (check-slot-type sd (slot-value obj slot))
 315     (let* ((att (view-class-slot-column sd))
 316            (val (db-value-from-slot sd (slot-value obj slot) database)))
 317       (cond ((and vct sd (view-database obj))
 318              (update-records (sql-expression :table vct)
 319                              :attributes (list (sql-expression :attribute att))
 320                              :values (list val)
 321                              :where (key-qualifier-for-instance
 322                                      obj :database database)
 323                              :database database))
 324             ((and vct sd (not (view-database obj)))
 325              (insert-records :into (sql-expression :table vct)
 326                              :attributes (list (sql-expression :attribute att))
 327                              :values (list val)
 328                              :database database)
 329              (setf (slot-value obj 'view-database) database))
 330             (t
 331              (error "Unable to update record.")))))
 332   (values))
 333
 334 (defmethod update-record-from-slots ((obj standard-db-object) slots &key
 335                                      (database *default-database*))
 336   (let* ((database (or (view-database obj) database))
 337          (vct (view-table (class-of obj)))
 338          (sds (slotdefs-for-slots-with-class slots (class-of obj)))
 339          (avps (mapcar #'(lambda (s)
 340                            (let ((val (slot-value
 341                                        obj (slot-definition-name s))))
 342                              (check-slot-type s val)
 343                              (list (sql-expression
 344                                     :attribute (view-class-slot-column s))
 345                                    (db-value-from-slot s val database))))
 346                        sds)))
 347     (cond ((and avps (view-database obj))
 348            (update-records (sql-expression :table vct)
 349                            :av-pairs avps
 350                            :where (key-qualifier-for-instance
 351                                    obj :database database)
 352                            :database database))
 353           ((and avps (not (view-database obj)))
 354            (insert-records :into (sql-expression :table vct)
 355                            :av-pairs avps
 356                            :database database)
 357            (setf (slot-value obj 'view-database) database))
 358           (t
 359            (error "Unable to update records"))))
 360   (values))
 361
 362 (defmethod update-records-from-instance ((obj standard-db-object)
 363                                          &key (database *default-database*))
 364   (let ((database (or (view-database obj) database)))
 365     (labels ((slot-storedp (slot)
 366                (and (member (view-class-slot-db-kind slot) '(:base :key))
 367                     (slot-boundp obj (slot-definition-name slot))))
 368              (slot-value-list (slot)
 369                (let ((value (slot-value obj (slot-definition-name slot))))
 370                  (check-slot-type slot value)
 371                  (list (sql-expression :attribute (view-class-slot-column slot))
 372                        (db-value-from-slot slot value database)))))
 373       (let* ((view-class (class-of obj))
 374              (view-class-table (view-table view-class))
 375              (slots (remove-if-not #'slot-storedp
 376                                    (ordered-class-slots view-class)))
 377              (record-values (mapcar #'slot-value-list slots)))
 378         (unless record-values
 379           (error "No settable slots."))
 380         (if (view-database obj)
 381             (update-records (sql-expression :table view-class-table)
 382                             :av-pairs record-values
 383                             :where (key-qualifier-for-instance
 384                                     obj :database database)
 385                             :database database)
 386             (progn
 387               (insert-records :into (sql-expression :table view-class-table)
 388                               :av-pairs record-values
 389                               :database database)
 390               (setf (slot-value obj 'view-database) database))))))
 391   (values))
 392
 393 (defmethod delete-instance-records ((instance standard-db-object))
 394   (let ((vt (sql-expression :table (view-table (class-of instance))))
 395         (vd (view-database instance)))
 396     (if vd
 397         (let ((qualifier (key-qualifier-for-instance instance :database vd)))
 398           (delete-records :from vt :where qualifier :database vd)
 399           (setf (slot-value instance 'view-database) nil))
 400         (error 'clsql-base::clsql-no-database-error :database nil))))
 401
 402 (defmethod update-instance-from-records ((instance standard-db-object)
 403                                          &key (database *default-database*))
 404   (let* ((view-class (find-class (class-name (class-of instance))))
 405          (view-table (sql-expression :table (view-table view-class)))
 406          (vd (or (view-database instance) database))
 407          (view-qual (key-qualifier-for-instance instance :database vd))
 408          (sels (generate-selection-list view-class))
 409          (res (apply #'select (append (mapcar #'cdr sels)
 410                                       (list :from  view-table
 411                                             :where view-qual)
 412                                       (list :result-types nil)))))
 413     (when res
 414       (get-slot-values-from-view instance (mapcar #'car sels) (car res)))))
 415
 416 (defmethod update-slot-from-record ((instance standard-db-object)
 417                                     slot &key (database *default-database*))
 418   (let* ((view-class (find-class (class-name (class-of instance))))
 419          (view-table (sql-expression :table (view-table view-class)))
 420          (vd (or (view-database instance) database))
 421          (view-qual (key-qualifier-for-instance instance :database vd))
 422          (slot-def (slotdef-for-slot-with-class slot view-class))
 423          (att-ref (generate-attribute-reference view-class slot-def))
 424          (res (select att-ref :from  view-table :where view-qual
 425                       :result-types nil)))
 426     (when res
 427       (get-slot-values-from-view instance (list slot-def) (car res)))))
 428
 429
 430 (defmethod update-slot-with-null ((object standard-db-object)
 431                                   slotname
 432                                   slotdef)
 433   (setf (slot-value object slotname) (slot-value slotdef 'void-value)))
 434
 435 (defvar +no-slot-value+ '+no-slot-value+)
 436
 437 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
 438   (let* ((class (find-class classname))
 439          (sld (slotdef-for-slot-with-class slot class)))
 440     (if sld
 441         (if (eq value +no-slot-value+)
 442             (sql-expression :attribute (view-class-slot-column sld)
 443                             :table (view-table class))
 444             (db-value-from-slot
 445              sld
 446              value
 447              database))
 448         (error "Unknown slot ~A for class ~A" slot classname))))
 449
 450 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
 451         (declare (ignore database))
 452         (let* ((class (find-class classname)))
 453           (unless (view-table class)
 454             (error "No view-table for class ~A"  classname))
 455           (sql-expression :table (view-table class))))
 456
 457 (defmethod database-get-type-specifier (type args database)
 458   (declare (ignore type args))
 459   (if (clsql-base::in (database-underlying-type database)
 460                           :postgresql :postgresql-socket)
 461           "VARCHAR"
 462           "VARCHAR(255)"))
 463
 464 (defmethod database-get-type-specifier ((type (eql 'integer)) args database)
 465   (declare (ignore database))
 466   ;;"INT8")
 467   (if args
 468       (format nil "INT(~A)" (car args))
 469       "INT"))
 470
 471 (defmethod database-get-type-specifier ((type (eql 'bigint)) args database)
 472   (declare (ignore args database))
 473   "BIGINT")
 474
 475 (defmethod database-get-type-specifier ((type (eql 'simple-base-string)) args
 476                                         database)
 477   (if args
 478       (format nil "VARCHAR(~A)" (car args))
 479     (if (clsql-base::in (database-underlying-type database)
 480                             :postgresql :postgresql-socket)
 481         "VARCHAR"
 482       "VARCHAR(255)")))
 483
 484 (defmethod database-get-type-specifier ((type (eql 'simple-string)) args
 485                                         database)
 486   (if args
 487       (format nil "VARCHAR(~A)" (car args))
 488     (if (clsql-base::in (database-underlying-type database)
 489                             :postgresql :postgresql-socket)
 490         "VARCHAR"
 491       "VARCHAR(255)")))
 492
 493 (defmethod database-get-type-specifier ((type (eql 'string)) args database)
 494   (if args
 495       (format nil "VARCHAR(~A)" (car args))
 496     (if (clsql-base::in (database-underlying-type database)
 497                             :postgresql :postgresql-socket)
 498         "VARCHAR"
 499       "VARCHAR(255)")))
 500
 501 (defmethod database-get-type-specifier ((type (eql 'universal-time)) args database)
 502   (declare (ignore args database))
 503   "BIGINT")
 504
 505 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database)
 506   (declare (ignore args))
 507   (case (database-underlying-type database)
 508     ((:postgresql :postgresql-socket)
 509      "TIMESTAMP WITHOUT TIME ZONE")
 510     (:mysql
 511      "DATETIME")
 512     (t "TIMESTAMP")))
 513
 514 (defmethod database-get-type-specifier ((type (eql 'duration)) args database)
 515   (declare (ignore database args))
 516   "VARCHAR")
 517
 518 (defmethod database-get-type-specifier ((type (eql 'money)) args database)
 519   (declare (ignore database args))
 520   "INT8")
 521
 522 (deftype raw-string (&optional len)
 523   "A string which is not trimmed when retrieved from the database"
 524   `(string ,len))
 525
 526 (defmethod database-get-type-specifier ((type (eql 'raw-string)) args database)
 527   (declare (ignore database))
 528   (if args
 529       (format nil "VARCHAR(~A)" (car args))
 530       "VARCHAR"))
 531
 532 (defmethod database-get-type-specifier ((type (eql 'float)) args database)
 533   (declare (ignore database))
 534   (if args
 535       (format nil "FLOAT(~A)" (car args))
 536       "FLOAT"))
 537
 538 (defmethod database-get-type-specifier ((type (eql 'long-float)) args database)
 539   (declare (ignore database))
 540   (if args
 541       (format nil "FLOAT(~A)" (car args))
 542       "FLOAT"))
 543
 544 (defmethod database-get-type-specifier ((type (eql 'boolean)) args database)
 545   (declare (ignore args database))
 546   "BOOL")
 547
 548 (defmethod database-output-sql-as-type (type val database)
 549   (declare (ignore type database))
 550   val)
 551
 552 (defmethod database-output-sql-as-type ((type (eql 'list)) val database)
 553   (declare (ignore database))
 554   (progv '(*print-circle* *print-array*) '(t t)
 555     (let ((escaped (prin1-to-string val)))
 556       (clsql-base::substitute-char-string
 557        escaped #\Null " "))))
 558
 559 (defmethod database-output-sql-as-type ((type (eql 'symbol)) val database)
 560   (declare (ignore database))
 561   (if (keywordp val)
 562       (symbol-name val)
 563       (if val
 564           (concatenate 'string
 565                        (package-name (symbol-package val))
 566                        "::"
 567                        (symbol-name val))
 568           "")))
 569
 570 (defmethod database-output-sql-as-type ((type (eql 'keyword)) val database)
 571   (declare (ignore database))
 572   (if val
 573       (symbol-name val)
 574       ""))
 575
 576 (defmethod database-output-sql-as-type ((type (eql 'vector)) val database)
 577   (declare (ignore database))
 578   (progv '(*print-circle* *print-array*) '(t t)
 579     (prin1-to-string val)))
 580
 581 (defmethod database-output-sql-as-type ((type (eql 'array)) val database)
 582   (declare (ignore database))
 583   (progv '(*print-circle* *print-array*) '(t t)
 584     (prin1-to-string val)))
 585
 586 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database)
 587   (case (database-underlying-type database)
 588     (:mysql
 589      (if val 1 0))
 590     (t
 591      (if val "t" "f"))))
 592
 593 (defmethod database-output-sql-as-type ((type (eql 'string)) val database)
 594   (declare (ignore database))
 595   val)
 596
 597 (defmethod database-output-sql-as-type ((type (eql 'simple-string))
 598                                         val database)
 599   (declare (ignore database))
 600   val)
 601
 602 (defmethod database-output-sql-as-type ((type (eql 'simple-base-string))
 603                                         val database)
 604   (declare (ignore database))
 605   val)
 606
 607 (defmethod read-sql-value (val type database)
 608   (declare (ignore type database))
 609   (read-from-string val))
 610
 611 (defmethod read-sql-value (val (type (eql 'string)) database)
 612   (declare (ignore database))
 613   val)
 614
 615 (defmethod read-sql-value (val (type (eql 'simple-string)) database)
 616   (declare (ignore database))
 617   val)
 618
 619 (defmethod read-sql-value (val (type (eql 'simple-base-string)) database)
 620   (declare (ignore database))
 621   val)
 622
 623 (defmethod read-sql-value (val (type (eql 'raw-string)) database)
 624   (declare (ignore database))
 625   val)
 626
 627 (defmethod read-sql-value (val (type (eql 'keyword)) database)
 628   (declare (ignore database))
 629   (when (< 0 (length val))
 630     (intern (symbol-name-default-case val)
 631             (find-package '#:keyword))))
 632
 633 (defmethod read-sql-value (val (type (eql 'symbol)) database)
 634   (declare (ignore database))
 635   (when (< 0 (length val))
 636     (unless (string= val (clsql-base:symbol-name-default-case "NIL"))
 637       (intern (clsql-base:symbol-name-default-case val)
 638               (symbol-package *update-context*)))))
 639
 640 (defmethod read-sql-value (val (type (eql 'integer)) database)
 641   (declare (ignore database))
 642   (etypecase val
 643     (string
 644      (unless (string-equal "NIL" val)
 645        (parse-integer val)))
 646     (number val)))
 647
 648 (defmethod read-sql-value (val (type (eql 'bigint)) database)
 649   (declare (ignore database))
 650   (etypecase val
 651     (string
 652      (unless (string-equal "NIL" val)
 653        (parse-integer val)))
 654     (number val)))
 655
 656 (defmethod read-sql-value (val (type (eql 'float)) database)
 657   (declare (ignore database))
 658   ;; writing 1.0 writes 1, so we we *really* want a float, must do (float ...)
 659   (float (read-from-string val)))
 660
 661 (defmethod read-sql-value (val (type (eql 'boolean)) database)
 662   (case (database-underlying-type database)
 663     (:mysql
 664      (etypecase val
 665        (string (if (string= "0" val) nil t))
 666        (integer (if (zerop val) nil t))))
 667     (:postgresql
 668      (if (eq :odbc (database-type database))
 669          (if (string= "0" val) nil t)
 670        (equal "t" val)))
 671     (t
 672      (equal "t" val))))
 673
 674 (defmethod read-sql-value (val (type (eql 'univeral-time)) database)
 675   (declare (ignore database))
 676   (unless (eq 'NULL val)
 677     (etypecase val
 678       (string
 679        (parse-integer val))
 680       (number val))))
 681
 682 (defmethod read-sql-value (val (type (eql 'wall-time)) database)
 683   (declare (ignore database))
 684   (unless (eq 'NULL val)
 685     (parse-timestring val)))
 686
 687 (defmethod read-sql-value (val (type (eql 'duration)) database)
 688   (declare (ignore database))
 689   (unless (or (eq 'NULL val)
 690               (equal "NIL" val))
 691     (parse-timestring val)))
 692
 693 ;; ------------------------------------------------------------
 694 ;; Logic for 'faulting in' :join slots
 695
 696 (defun fault-join-slot-raw (class object slot-def)
 697   (let* ((dbi (view-class-slot-db-info slot-def))
 698          (jc (gethash :join-class dbi)))
 699     (let ((jq (join-qualifier class object slot-def)))
 700       (when jq
 701         (select jc :where jq :flatp t :result-types nil)))))
 702
 703 (defun fault-join-slot (class object slot-def)
 704   (let* ((dbi (view-class-slot-db-info slot-def))
 705          (ts (gethash :target-slot dbi))
 706          (res (fault-join-slot-raw class object slot-def)))
 707     (when res
 708       (cond
 709         ((and ts (gethash :set dbi))
 710          (mapcar (lambda (obj)
 711                    (cons obj (slot-value obj ts))) res))
 712         ((and ts (not (gethash :set dbi)))
 713          (mapcar (lambda (obj) (slot-value obj ts)) res))
 714         ((and (not ts) (not (gethash :set dbi)))
 715          (car res))
 716         ((and (not ts) (gethash :set dbi))
 717          res)))))
 718
 719 (defun join-qualifier (class object slot-def)
 720     (declare (ignore class))
 721     (let* ((dbi (view-class-slot-db-info slot-def))
 722            (jc (find-class (gethash :join-class dbi)))
 723            ;;(ts (gethash :target-slot dbi))
 724            ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
 725            (foreign-keys (gethash :foreign-key dbi))
 726            (home-keys (gethash :home-key dbi)))
 727       (when (every #'(lambda (slt)
 728                        (and (slot-boundp object slt)
 729                             (not (null (slot-value object slt)))))
 730                    (if (listp home-keys) home-keys (list home-keys)))
 731         (let ((jc
 732                (mapcar #'(lambda (hk fk)
 733                            (let ((fksd (slotdef-for-slot-with-class fk jc)))
 734                              (sql-operation '==
 735                                             (typecase fk
 736                                               (symbol
 737                                                (sql-expression
 738                                                 :attribute
 739                                                 (view-class-slot-column fksd)
 740                                                 :table (view-table jc)))
 741                                               (t fk))
 742                                             (typecase hk
 743                                               (symbol
 744                                                (slot-value object hk))
 745                                               (t
 746                                                hk)))))
 747                        (if (listp home-keys)
 748                            home-keys
 749                            (list home-keys))
 750                        (if (listp foreign-keys)
 751                            foreign-keys
 752                            (list foreign-keys)))))
 753           (when jc
 754             (if (> (length jc) 1)
 755                 (apply #'sql-and jc)
 756                 jc))))))
 757
 758 (defun find-all (view-classes &rest args &key all set-operation distinct from
 759                  where group-by having order-by order-by-descending offset limit
 760                  refresh flatp (database *default-database*))
 761   "Called by SELECT to generate object query results when the
 762   View Classes VIEW-CLASSES are passed as arguments to SELECT."
 763   (declare (ignore all set-operation group-by having offset limit)
 764            (optimize (debug 3) (speed 1)))
 765   (remf args :from)
 766   (remf args :flatp)
 767   (remf args :result-types)
 768   (labels ((table-sql-expr (table)
 769              (sql-expression :table (view-table table)))
 770            (ref-equal (ref1 ref2)
 771              (equal (sql ref1)
 772                     (sql ref2)))
 773            (tables-equal (table-a table-b)
 774              (string= (string (slot-value table-a 'name))
 775                       (string (slot-value table-b 'name))))
 776            (build-object (vals vclass selects)
 777              (let* ((class-name (class-name vclass))
 778                     (db-vals (butlast vals (- (list-length vals)
 779                                               (list-length selects))))
 780                     (*db-initializing* t)
 781                     (obj (make-instance class-name :view-database database)))
 782                ;; use refresh keyword here
 783                (setf obj (get-slot-values-from-view obj (mapcar #'car selects)
 784                                                     db-vals))
 785                (when refresh (instance-refreshed obj))
 786                obj))
 787            (build-objects (vals sclasses sels)
 788              (let ((objects (mapcar #'(lambda (sclass sel)
 789                                         (prog1 (build-object vals sclass sel)
 790                                           (setf vals (nthcdr (list-length sel)
 791                                                              vals))))
 792                                     sclasses sels)))
 793                (if (and flatp (= (length sclasses) 1))
 794                    (car objects)
 795                    objects))))
 796     (let* ((*db-deserializing* t)
 797            (*default-database* (or database
 798                                    (error 'clsql-base::clsql-no-database-error :database nil)))
 799            (sclasses (mapcar #'find-class view-classes))
 800            (sels (mapcar #'generate-selection-list sclasses))
 801            (fullsels (apply #'append sels))
 802            (sel-tables (collect-table-refs where))
 803            (tables (remove-duplicates (append (mapcar #'table-sql-expr sclasses)
 804                                               sel-tables)
 805                                       :test #'tables-equal))
 806            (res nil))
 807         (dolist (ob (listify order-by))
 808           (when (and ob (not (member ob (mapcar #'cdr fullsels)
 809                                      :test #'ref-equal)))
 810             (setq fullsels
 811                   (append fullsels (mapcar #'(lambda (att) (cons nil att))
 812                                            (listify ob))))))
 813         (dolist (ob (listify order-by-descending))
 814           (when (and ob (not (member ob (mapcar #'cdr fullsels)
 815                                      :test #'ref-equal)))
 816             (setq fullsels
 817                   (append fullsels (mapcar #'(lambda (att) (cons nil att))
 818                                            (listify ob))))))
 819         (dolist (ob (listify distinct))
 820           (when (and (typep ob 'sql-ident)
 821                      (not (member ob (mapcar #'cdr fullsels)
 822                                   :test #'ref-equal)))
 823             (setq fullsels
 824                   (append fullsels (mapcar #'(lambda (att) (cons nil att))
 825                                            (listify ob))))))
 826         (setq res
 827               (apply #'select
 828                      (append (mapcar #'cdr fullsels)
 829                              (cons :from
 830                                    (list (append (when from (listify from))
 831                                                  (listify tables))))
 832                              (list :result-types nil)
 833                              args)))
 834         (mapcar #'(lambda (r) (build-objects r sclasses sels)) res))))
 835
 836 (defmethod instance-refreshed ((instance standard-db-object)))
 837
 838 (defmethod select (&rest select-all-args)
 839   "Selects data from database given the constraints specified. Returns
 840 a list of lists of record values as specified by select-all-args. By
 841 default, the records are each represented as lists of attribute
 842 values. The selections argument may be either db-identifiers, literal
 843 strings or view classes.  If the argument consists solely of view
 844 classes, the return value will be instances of objects rather than raw
 845 tuples."
 846   (flet ((select-objects (target-args)
 847            (and target-args
 848                 (every #'(lambda (arg)
 849                            (and (symbolp arg)
 850                                 (find-class arg nil)))
 851                        target-args))))
 852     (multiple-value-bind (target-args qualifier-args)
 853         (query-get-selections select-all-args)
 854       (if (select-objects target-args)
 855           (apply #'find-all target-args qualifier-args)
 856           (let ((expr (apply #'make-query select-all-args)))
 857             (destructuring-bind (&key (flatp nil)
 858                                       (result-types :auto)
 859                                       (field-names t)
 860                                       (database *default-database*)
 861                                       &allow-other-keys)
 862                 qualifier-args
 863               (query expr :flatp flatp :result-types result-types
 864                      :field-names field-names :database database)))))))
 865