sql/metaclasses.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; CLSQL metaclass for standard-db-objects created in the OODDL.
   7 ;;;;
   8 ;;;; This file is part of CLSQL.
   9 ;;;;
  10 ;;;; CLSQL users are granted the rights to distribute and use this software
  11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  13 ;;;; *************************************************************************
  14
  15 (in-package #:clsql)
  16
  17 (eval-when (:compile-toplevel :load-toplevel :execute)
  18   (when (>= (length (generic-function-lambda-list
  19                      (ensure-generic-function
  20                       'compute-effective-slot-definition)))
  21             3)
  22     (pushnew :kmr-normal-cesd cl:*features*))
  23
  24   (when (>= (length (generic-function-lambda-list
  25                      (ensure-generic-function
  26                       'direct-slot-definition-class)))
  27             3)
  28     (pushnew :kmr-normal-dsdc cl:*features*))
  29
  30   (when (>= (length (generic-function-lambda-list
  31                      (ensure-generic-function
  32                       'effective-slot-definition-class)))
  33             3)
  34     (pushnew :kmr-normal-esdc cl:*features*)))
  35
  36
  37 ;; ------------------------------------------------------------
  38 ;; metaclass: view-class
  39
  40 (defclass standard-db-class (standard-class)
  41   ((view-table
  42     :accessor view-table
  43     :initarg :view-table)
  44    (definition
  45     :accessor object-definition
  46     :initarg :definition
  47     :initform nil)
  48    (key-slots
  49     :accessor key-slots
  50     :initform nil)
  51    (class-qualifier
  52     :accessor view-class-qualifier
  53     :initarg :qualifier
  54     :initform nil))
  55   (:documentation "VIEW-CLASS metaclass."))
  56
  57 ;;; Lispworks 4.2 and before requires special processing of extra slot and class options
  58
  59 (defvar +extra-slot-options+ '(:column :db-kind :db-type :db-reader :void-value :db-constraints
  60                                :db-writer :db-info))
  61 (defvar +extra-class-options+ '(:base-table))
  62
  63 #+lispworks
  64 (dolist (slot-option +extra-slot-options+)
  65   (process-slot-option standard-db-class slot-option))
  66
  67 #+lispworks
  68 (dolist (class-option +extra-class-options+)
  69   (process-class-option standard-db-class class-option))
  70
  71 (defmethod validate-superclass ((class standard-db-class)
  72                                 (superclass standard-class))
  73   t)
  74
  75 (defun table-name-from-arg (arg)
  76   (cond ((symbolp arg)
  77          arg)
  78         ((typep arg 'sql-ident)
  79          (slot-value arg 'name))
  80         ((stringp arg)
  81          (intern (symbol-name-default-case arg)))))
  82
  83 (defun column-name-from-arg (arg)
  84   (cond ((symbolp arg)
  85          arg)
  86         ((typep arg 'sql-ident)
  87          (slot-value arg 'name))
  88         ((stringp arg)
  89          (intern (symbol-name-default-case arg)))))
  90
  91
  92 (defun remove-keyword-arg (arglist akey)
  93   (let ((mylist arglist)
  94         (newlist ()))
  95     (labels ((pop-arg (alist)
  96              (let ((arg (pop alist))
  97                    (val (pop alist)))
  98                (unless (equal arg akey)
  99                  (setf newlist (append (list arg val) newlist)))
 100                (when alist (pop-arg alist)))))
 101       (pop-arg mylist))
 102     newlist))
 103
 104 (defmethod initialize-instance :around ((class standard-db-class)
 105                                         &rest all-keys
 106                                         &key direct-superclasses base-table
 107                                         qualifier
 108                                         &allow-other-keys)
 109   (let ((root-class (find-class 'standard-db-object nil))
 110         (vmc (find-class 'standard-db-class)))
 111     (setf (view-class-qualifier class)
 112           (car qualifier))
 113     (if root-class
 114         (if (member-if #'(lambda (super)
 115                            (eq (class-of super) vmc)) direct-superclasses)
 116             (call-next-method)
 117             (apply #'call-next-method
 118                    class
 119                    :direct-superclasses (append (list root-class)
 120                                                 direct-superclasses)
 121                    (remove-keyword-arg all-keys :direct-superclasses)))
 122         (call-next-method))
 123     (setf (view-table class)
 124           (table-name-from-arg (sql-escape (or (and base-table
 125                                                     (if (listp base-table)
 126                                                         (car base-table)
 127                                                         base-table))
 128                                                (class-name class)))))
 129     (register-metaclass class (nth (1+ (position :direct-slots all-keys))
 130                                    all-keys))))
 131
 132 (defmethod reinitialize-instance :around ((class standard-db-class)
 133                                           &rest all-keys
 134                                           &key base-table
 135                                           direct-superclasses qualifier
 136                                           &allow-other-keys)
 137   (let ((root-class (find-class 'standard-db-object nil))
 138         (vmc (find-class 'standard-db-class)))
 139     (setf (view-table class)
 140           (table-name-from-arg (sql-escape (or (and base-table
 141                                                     (if (listp base-table)
 142                                                         (car base-table)
 143                                                         base-table))
 144                                                (class-name class)))))
 145     (setf (view-class-qualifier class)
 146           (car qualifier))
 147     (if (and root-class (not (equal class root-class)))
 148         (if (member-if #'(lambda (super)
 149                            (eq (class-of super) vmc)) direct-superclasses)
 150             (call-next-method)
 151             (apply #'call-next-method
 152                    class
 153                    :direct-superclasses (append (list root-class)
 154                                                 direct-superclasses)
 155                    (remove-keyword-arg all-keys :direct-superclasses)))
 156         (call-next-method)))
 157   (register-metaclass class (nth (1+ (position :direct-slots all-keys))
 158                                  all-keys)))
 159
 160
 161 (defun get-keywords (keys list)
 162   (flet ((extract (key)
 163            (let ((pos (position key list)))
 164              (when pos
 165                (nth (1+ pos) list)))))
 166     (mapcar #'extract keys)))
 167
 168 (defun describe-db-layout (class)
 169   (flet ((not-db-col (col)
 170            (not (member (nth 2 col)  '(nil :base :key))))
 171          (frob-slot (slot)
 172            (let ((type (slot-value slot 'type)))
 173              (if (eq type t)
 174                  (setq type nil))
 175              (list (slot-value slot 'name)
 176                    type
 177                    (slot-value slot 'db-kind)
 178                    (and (slot-boundp slot 'column)
 179                         (slot-value slot 'column))))))
 180     (let ((all-slots (mapcar #'frob-slot (ordered-class-slots class))))
 181       (setq all-slots (remove-if #'not-db-col all-slots))
 182       (setq all-slots (stable-sort all-slots #'string< :key #'car))
 183       ;;(mapcar #'dink-type all-slots)
 184       all-slots)))
 185
 186 (defun register-metaclass (class slots)
 187   (labels ((not-db-col (col)
 188              (not (member (nth 2 col)  '(nil :base :key))))
 189            (frob-slot (slot)
 190              (get-keywords '(:name :type :db-kind :column) slot)))
 191     (let ((all-slots (mapcar #'frob-slot slots)))
 192       (setq all-slots (remove-if #'not-db-col all-slots))
 193       (setq all-slots (stable-sort all-slots #'string< :key #'car))
 194       (setf (object-definition class) all-slots))
 195     #-allegro
 196     (setf (key-slots class) (remove-if-not (lambda (slot)
 197                                              (eql (slot-value slot 'db-kind)
 198                                                   :key))
 199                                            (ordered-class-slots class)))))
 200
 201 #+allegro
 202 (defmethod finalize-inheritance :after ((class standard-db-class))
 203   (setf (key-slots class) (remove-if-not (lambda (slot)
 204                                            (eql (slot-value slot 'db-kind)
 205                                                 :key))
 206                                          (ordered-class-slots class))))
 207
 208 ;; return the deepest view-class ancestor for a given view class
 209
 210 (defun base-db-class (classname)
 211   (let* ((class (find-class classname))
 212          (db-class (find-class 'standard-db-object)))
 213     (loop
 214      (let ((cds (class-direct-superclasses class)))
 215        (cond ((null cds)
 216               (error "not a db class"))
 217              ((member db-class cds)
 218               (return (class-name class))))
 219        (setq class (car cds))))))
 220
 221 (defun db-ancestors (classname)
 222   (let ((class (find-class classname))
 223         (db-class (find-class 'standard-db-object)))
 224     (labels ((ancestors (class)
 225              (let ((scs (class-direct-superclasses class)))
 226                (if (member db-class scs)
 227                    (list class)
 228                    (append (list class) (mapcar #'ancestors scs))))))
 229       (ancestors class))))
 230
 231 (defclass view-class-slot-definition-mixin ()
 232   ((column
 233     :accessor view-class-slot-column
 234     :initarg :column
 235     :documentation
 236     "The name of the SQL column this slot is stored in.  Defaults to
 237 the slot name.")
 238    (db-kind
 239     :accessor view-class-slot-db-kind
 240     :initarg :db-kind
 241     :initform :base
 242     :type keyword
 243     :documentation
 244     "The kind of DB mapping which is performed for this slot.  :base
 245 indicates the slot maps to an ordinary column of the DB view.  :key
 246 indicates that this slot corresponds to part of the unique keys for
 247 this view, :join indicates ... and :virtual indicates that this slot
 248 is an ordinary CLOS slot.  Defaults to :base.")
 249    (db-reader
 250     :accessor view-class-slot-db-reader
 251     :initarg :db-reader
 252     :initform nil
 253     :documentation
 254     "If a string, then when reading values from the DB, the string
 255 will be used for a format string, with the only value being the value
 256 from the database.  The resulting string will be used as the slot
 257 value.  If a function then it will take one argument, the value from
 258 the database, and return the value that should be put into the slot.")
 259    (db-writer
 260     :accessor view-class-slot-db-writer
 261     :initarg :db-writer
 262     :initform nil
 263     :documentation
 264     "If a string, then when reading values from the slot for the DB,
 265 the string will be used for a format string, with the only value being
 266 the value of the slot.  The resulting string will be used as the
 267 column value in the DB.  If a function then it will take one argument,
 268 the value of the slot, and return the value that should be put into
 269 the database.")
 270    (db-type
 271     :accessor view-class-slot-db-type
 272     :initarg :db-type
 273     :initform nil
 274     :documentation
 275     "A string which will be used as the type specifier for this slots
 276 column definition in the database.")
 277    (db-constraints
 278     :accessor view-class-slot-db-constraints
 279     :initarg :db-constraints
 280     :initform nil
 281     :documentation
 282     "A single constraint or list of constraints for this column")
 283    (void-value
 284     :accessor view-class-slot-void-value
 285     :initarg :void-value
 286     :initform nil
 287     :documentation
 288     "Value to store is the SQL value is NULL. Default is NIL.")
 289    (db-info
 290     :accessor view-class-slot-db-info
 291     :initarg :db-info
 292     :documentation "Description of the join.")
 293    (specified-type
 294     :accessor specified-type
 295     :initform nil
 296     :documentation "KMR: Internal slot storing the :type specified by user.")))
 297
 298 (defparameter *db-info-lambda-list*
 299   '(&key join-class
 300          home-key
 301          foreign-key
 302          (key-join nil)
 303          (target-slot nil)
 304          (retrieval :immmediate)
 305          (set nil)))
 306
 307 (defun parse-db-info (db-info-list)
 308   (destructuring-bind
 309         (&key join-class home-key key-join foreign-key (delete-rule nil)
 310               (target-slot nil) (retrieval :deferred) (set nil))
 311       db-info-list
 312     (let ((ih (make-hash-table :size 6)))
 313       (if join-class
 314           (setf (gethash :join-class ih) join-class)
 315           (error "Must specify :join-class in :db-info"))
 316       (if home-key
 317           (setf (gethash :home-key ih) home-key)
 318           (error "Must specify :home-key in :db-info"))
 319       (when delete-rule
 320         (setf (gethash :delete-rule ih) delete-rule))
 321       (if foreign-key
 322           (setf (gethash :foreign-key ih) foreign-key)
 323           (error "Must specify :foreign-key in :db-info"))
 324       (when key-join
 325         (setf (gethash :key-join ih) t))
 326       (when target-slot
 327         (setf (gethash :target-slot ih) target-slot))
 328       (when set
 329         (setf (gethash :set ih) set))
 330       (when retrieval
 331         (progn
 332           (setf (gethash :retrieval ih) retrieval)
 333           (if (eql retrieval :immediate)
 334               (setf (gethash :set ih) nil))))
 335       ih)))
 336
 337 (defclass view-class-direct-slot-definition (view-class-slot-definition-mixin
 338                                              standard-direct-slot-definition)
 339   ())
 340
 341 (defclass view-class-effective-slot-definition (view-class-slot-definition-mixin
 342                                                 standard-effective-slot-definition)
 343   ())
 344
 345 (defmethod direct-slot-definition-class ((class standard-db-class)
 346                                          #+kmr-normal-dsdc &rest
 347                                          initargs)
 348   (declare (ignore initargs))
 349   (find-class 'view-class-direct-slot-definition))
 350
 351 (defmethod effective-slot-definition-class ((class standard-db-class)
 352                                             #+kmr-normal-esdc &rest
 353                                             initargs)
 354   (declare (ignore initargs))
 355   (find-class 'view-class-effective-slot-definition))
 356
 357 #+openmcl
 358 (defun compute-class-precedence-list (class)
 359   ;; safe to call this in openmcl
 360   (class-precedence-list class))
 361
 362 #-(or sbcl cmu)
 363 (defmethod compute-slots ((class standard-db-class))
 364   "Need to sort order of class slots so they are the same across
 365 implementations."
 366   (let ((slots (call-next-method))
 367         desired-sequence
 368         output-slots)
 369     (dolist (c (compute-class-precedence-list class))
 370       (dolist (s (class-direct-slots c))
 371         (let ((name (slot-definition-name s)))
 372           (unless (find name desired-sequence)
 373             (push name desired-sequence)))))
 374     (dolist (desired desired-sequence)
 375       (let ((slot (find desired slots :key #'slot-definition-name)))
 376         (assert slot)
 377         (push slot output-slots)))
 378     output-slots))
 379
 380 (defun compute-lisp-type-from-slot-specification (slotd specified-type)
 381   "Computes the Lisp type for a user-specified type. Needed for OpenMCL
 382 which does type checking before storing a value in a slot."
 383   ;; This function is called after the base compute-effective-slots is called.
 384   ;; OpenMCL sets the type-predicate based on the initial value of the slots type.
 385   ;; so we have to override the type-predicates here
 386   (cond
 387     ((consp specified-type)
 388      (cond
 389        ((and (symbolp (car specified-type))
 390              (string-equal (symbol-name (car specified-type)) "string"))
 391         'string)
 392        (t
 393         specified-type)))
 394     ((eq (ensure-keyword specified-type) :bigint)
 395      'integer)
 396     ((and specified-type
 397           (not (eql :not-null (slot-value slotd 'db-constraints))))
 398      `(or null ,specified-type))
 399     (t
 400      specified-type)))
 401
 402 ;; Compute the slot definition for slots in a view-class.  Figures out
 403 ;; what kind of database value (if any) is stored there, generates and
 404 ;; verifies the column name.
 405
 406 (defmethod compute-effective-slot-definition ((class standard-db-class)
 407                                               #+kmr-normal-cesd slot-name
 408                                               direct-slots)
 409   #+kmr-normal-cesd (declare (ignore slot-name))
 410
 411   ;; KMR: store the user-specified type and then compute
 412   ;; real Lisp type and store it
 413   (let ((dsd (car direct-slots)))
 414     (when (and (typep dsd 'view-class-slot-definition-mixin)
 415                (null (specified-type dsd)))
 416       (setf (specified-type dsd)
 417         (slot-definition-type dsd))
 418       (setf (slot-value dsd 'type)
 419         (compute-lisp-type-from-slot-specification
 420          dsd (slot-definition-type dsd))))
 421
 422     (let ((esd (call-next-method)))
 423       (typecase dsd
 424         (view-class-slot-definition-mixin
 425          ;; Use the specified :column argument if it is supplied, otherwise
 426          ;; the column slot is filled in with the slot-name,  but transformed
 427          ;; to be sql safe, - to _ and such.
 428          (setf (slot-value esd 'column)
 429            (column-name-from-arg
 430             (if (slot-boundp dsd 'column)
 431                 (view-class-slot-column dsd)
 432               (column-name-from-arg
 433                (sql-escape (slot-definition-name dsd))))))
 434
 435          (setf (slot-value esd 'db-type)
 436            (when (slot-boundp dsd 'db-type)
 437              (view-class-slot-db-type dsd)))
 438
 439          (setf (slot-value esd 'void-value)
 440            (view-class-slot-void-value dsd))
 441
 442          ;; :db-kind slot value defaults to :base (store slot value in
 443          ;; database)
 444
 445          (setf (slot-value esd 'db-kind)
 446            (if (slot-boundp dsd 'db-kind)
 447                (view-class-slot-db-kind dsd)
 448              :base))
 449
 450          (setf (slot-value esd 'db-writer)
 451            (when (slot-boundp dsd 'db-writer)
 452              (view-class-slot-db-writer dsd)))
 453          (setf (slot-value esd 'db-constraints)
 454            (when (slot-boundp dsd 'db-constraints)
 455              (view-class-slot-db-constraints dsd)))
 456
 457          ;; I wonder if this slot option and the previous could be merged,
 458          ;; so that :base and :key remain keyword options, but :db-kind
 459          ;; :join becomes :db-kind (:join <db info .... >)?
 460
 461          (setf (slot-value esd 'db-info)
 462            (when (slot-boundp dsd 'db-info)
 463              (if (listp (view-class-slot-db-info dsd))
 464                  (parse-db-info (view-class-slot-db-info dsd))
 465                (view-class-slot-db-info dsd))))
 466
 467          (setf (specified-type esd) (specified-type dsd))
 468
 469          )
 470         ;; all other slots
 471         (t
 472          (let ((type-predicate #+openmcl (slot-value esd 'ccl::type-predicate)))
 473
 474            (change-class esd 'view-class-effective-slot-definition
 475                          #+allegro :name
 476                          #+allegro (slot-definition-name dsd))
 477            #+openmcl (setf (slot-value esd 'ccl::type-predicate)
 478                            type-predicate))
 479
 480          (setf (slot-value esd 'column)
 481            (column-name-from-arg
 482             (sql-escape (slot-definition-name dsd))))
 483
 484          (setf (slot-value esd 'db-info) nil)
 485          (setf (slot-value esd 'db-kind) :virtual)
 486          (setf (specified-type esd) (slot-definition-type dsd)))
 487         )
 488       esd)))
 489
 490 (defun slotdefs-for-slots-with-class (slots class)
 491   (let ((result nil))
 492     (dolist (s slots)
 493       (let ((c (slotdef-for-slot-with-class s class)))
 494         (if c (setf result (cons c result)))))
 495     result))
 496
 497 (defun slotdef-for-slot-with-class (slot class)
 498   (find-if #'(lambda (d) (eql slot (slot-definition-name d)))
 499            (class-slots class)))
 500
 501 #+ignore
 502 (eval-when (:compile-toplevel :load-toplevel :execute)
 503   #+kmr-normal-cesd
 504   (setq cl:*features* (delete :kmr-normal-cesd cl:*features*))
 505   #+kmr-normal-dsdc
 506   (setq cl:*features* (delete :kmr-normal-dsdc cl:*features*))
 507   #+kmr-normal-esdc
 508   (setq cl:*features* (delete :kmr-normal-esdc cl:*features*))
 509   )