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-sys)
  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 "Metaclass for all CLSQL View Classes."))
  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   (eval `(process-slot-option standard-db-class ,slot-option)))
  66
  67 #+lispworks
  68 (dolist (class-option +extra-class-options+)
  69   (eval `(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          (intern (sql-escape arg)))
  78         ((typep arg 'sql-ident)
  79          (if (symbolp (slot-value arg 'name))
  80              (intern (sql-escape (slot-value arg 'name)))
  81              (sql-escape (slot-value arg 'name))))
  82         ((stringp arg)
  83          (sql-escape arg))))
  84
  85 (defun column-name-from-arg (arg)
  86   (cond ((symbolp arg)
  87          arg)
  88         ((typep arg 'sql-ident)
  89          (slot-value arg 'name))
  90         ((stringp arg)
  91          (intern (symbol-name-default-case arg)))))
  92
  93
  94 (defun remove-keyword-arg (arglist akey)
  95   (let ((mylist arglist)
  96         (newlist ()))
  97     (labels ((pop-arg (alist)
  98              (let ((arg (pop alist))
  99                    (val (pop alist)))
 100                (unless (equal arg akey)
 101                  (setf newlist (append (list arg val) newlist)))
 102                (when alist (pop-arg alist)))))
 103       (pop-arg mylist))
 104     newlist))
 105
 106 (defun set-view-table-slot (class base-table)
 107   (setf (view-table class)
 108         (table-name-from-arg (or (and base-table
 109                                       (if (listp base-table)
 110                                           (car base-table)
 111                                           base-table))
 112                                  (class-name class)))))
 113
 114 (defmethod initialize-instance :around ((class standard-db-class)
 115                                         &rest all-keys
 116                                         &key direct-superclasses base-table
 117                                         qualifier
 118                                         &allow-other-keys)
 119   (let ((root-class (find-class 'standard-db-object nil))
 120         (vmc 'standard-db-class))
 121     (setf (view-class-qualifier class)
 122           (car qualifier))
 123     (if root-class
 124         (if (some #'(lambda (super) (typep super vmc))
 125                   direct-superclasses)
 126             (call-next-method)
 127             (apply #'call-next-method
 128                    class
 129                    :direct-superclasses (append (list root-class)
 130                                                 direct-superclasses)
 131                    (remove-keyword-arg all-keys :direct-superclasses)))
 132         (call-next-method))
 133     (set-view-table-slot class base-table)
 134     (register-metaclass class (nth (1+ (position :direct-slots all-keys))
 135                                    all-keys))))
 136
 137 (defmethod reinitialize-instance :around ((class standard-db-class)
 138                                           &rest all-keys
 139                                           &key base-table
 140                                           direct-superclasses qualifier
 141                                           &allow-other-keys)
 142   (let ((root-class (find-class 'standard-db-object nil))
 143         (vmc 'standard-db-class))
 144     (set-view-table-slot class base-table)
 145     (setf (view-class-qualifier class)
 146           (car qualifier))
 147     (if (and root-class (not (equal class root-class)))
 148         (if (some #'(lambda (super) (typep super vmc))
 149                   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-definition-type slot)))
 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     #-(or sbcl 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 #+(or sbcl 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     ;; openmcl 0.14.2 stores the value as list in the DSD
 243     ;; :type (or list keyword)
 244     #-openmcl :type #-openmcl keyword
 245     :documentation
 246     "The kind of DB mapping which is performed for this slot.  :base
 247 indicates the slot maps to an ordinary column of the DB view.  :key
 248 indicates that this slot corresponds to part of the unique keys for
 249 this view, :join indicates ... and :virtual indicates that this slot
 250 is an ordinary CLOS slot.  Defaults to :base.")
 251    (db-reader
 252     :accessor view-class-slot-db-reader
 253     :initarg :db-reader
 254     :initform nil
 255     :documentation
 256     "If a string, then when reading values from the DB, the string
 257 will be used for a format string, with the only value being the value
 258 from the database.  The resulting string will be used as the slot
 259 value.  If a function then it will take one argument, the value from
 260 the database, and return the value that should be put into the slot.")
 261    (db-writer
 262     :accessor view-class-slot-db-writer
 263     :initarg :db-writer
 264     :initform nil
 265     :documentation
 266     "If a string, then when reading values from the slot for the DB,
 267 the string will be used for a format string, with the only value being
 268 the value of the slot.  The resulting string will be used as the
 269 column value in the DB.  If a function then it will take one argument,
 270 the value of the slot, and return the value that should be put into
 271 the database.")
 272    (db-type
 273     :accessor view-class-slot-db-type
 274     :initarg :db-type
 275     :initform nil
 276     :documentation
 277     "A string which will be used as the type specifier for this slots
 278 column definition in the database.")
 279    (db-constraints
 280     :accessor view-class-slot-db-constraints
 281     :initarg :db-constraints
 282     :initform nil
 283     :documentation
 284     "A keyword symbol representing a single SQL column constraint or list of such symbols.")
 285    (void-value
 286     :accessor view-class-slot-void-value
 287     :initarg :void-value
 288     :initform nil
 289     :documentation
 290     "Value to store if the SQL value is NULL. Default is NIL.")
 291    (db-info
 292     :accessor view-class-slot-db-info
 293     :initarg :db-info
 294     :documentation "Description of the join.")
 295    (specified-type
 296     :accessor specified-type
 297     :initarg specified-type
 298     :initform nil
 299     :documentation "Internal slot storing the :type specified by user.")))
 300
 301 (defparameter *db-info-lambda-list*
 302   '(&key join-class
 303          home-key
 304          foreign-key
 305          (key-join nil)
 306          (target-slot nil)
 307          (retrieval :immmediate)
 308          (set nil)))
 309
 310 (defun parse-db-info (db-info-list)
 311   (destructuring-bind
 312         (&key join-class home-key key-join foreign-key (delete-rule nil)
 313               (target-slot nil) (retrieval :deferred) (set t))
 314       db-info-list
 315     (let ((ih (make-hash-table :size 6)))
 316       (if join-class
 317           (setf (gethash :join-class ih) join-class)
 318           (error "Must specify :join-class in :db-info"))
 319       (if home-key
 320           (setf (gethash :home-key ih) home-key)
 321           (error "Must specify :home-key in :db-info"))
 322       (when delete-rule
 323         (setf (gethash :delete-rule ih) delete-rule))
 324       (if foreign-key
 325           (setf (gethash :foreign-key ih) foreign-key)
 326           (error "Must specify :foreign-key in :db-info"))
 327       (when key-join
 328         (setf (gethash :key-join ih) t))
 329       (when target-slot
 330         (setf (gethash :target-slot ih) target-slot))
 331       (when set
 332         (setf (gethash :set ih) set))
 333       (when retrieval
 334         (progn
 335           (setf (gethash :retrieval ih) retrieval)
 336           (if (eql retrieval :immediate)
 337               (setf (gethash :set ih) nil))))
 338       ih)))
 339
 340 (defclass view-class-direct-slot-definition (view-class-slot-definition-mixin
 341                                              standard-direct-slot-definition)
 342   ())
 343
 344 (defclass view-class-effective-slot-definition (view-class-slot-definition-mixin
 345                                                 standard-effective-slot-definition)
 346   ())
 347
 348 (defmethod direct-slot-definition-class ((class standard-db-class)
 349                                          #+kmr-normal-dsdc &rest
 350                                          initargs)
 351   (declare (ignore initargs))
 352   (find-class 'view-class-direct-slot-definition))
 353
 354 (defmethod effective-slot-definition-class ((class standard-db-class)
 355                                             #+kmr-normal-esdc &rest
 356                                             initargs)
 357   (declare (ignore initargs))
 358   (find-class 'view-class-effective-slot-definition))
 359
 360 #+openmcl
 361 (when (not (symbol-function 'compute-class-precedence-list))
 362   (eval
 363    (defun compute-class-precedence-list (class)
 364      (class-precedence-list class))))
 365
 366 #-mop-slot-order-reversed
 367 (defmethod compute-slots ((class standard-db-class))
 368   "Need to sort order of class slots so they are the same across
 369 implementations."
 370   (let ((slots (call-next-method))
 371         desired-sequence
 372         output-slots)
 373     (dolist (c (compute-class-precedence-list class))
 374       (dolist (s (class-direct-slots c))
 375         (let ((name (slot-definition-name s)))
 376           (unless (find name desired-sequence)
 377             (push name desired-sequence)))))
 378     (dolist (desired desired-sequence)
 379       (let ((slot (find desired slots :key #'slot-definition-name)))
 380         (assert slot)
 381         (push slot output-slots)))
 382     output-slots))
 383
 384 (defun compute-lisp-type-from-specified-type (specified-type db-constraints)
 385   "Computes the Lisp type for a user-specified type."
 386   (let ((type
 387          (cond
 388            ((consp specified-type)
 389             (let* ((first (first specified-type))
 390                    (name (etypecase first
 391                            (symbol (symbol-name first))
 392                            (string first))))
 393               (cond
 394                ((or (string-equal name "string")
 395                     (string-equal name "varchar")
 396                     (string-equal name "char"))
 397                 'string)
 398                (t
 399                 specified-type))))
 400            ((eq (ensure-keyword specified-type) :bigint)
 401             'integer)
 402            ((eq (ensure-keyword specified-type) :char)
 403             'character)
 404            ((eq (ensure-keyword specified-type) :varchar)
 405             'string)
 406            (t
 407             specified-type))))
 408     (if (and type (not (member :not-null (listify db-constraints))))
 409         `(or null ,type)
 410       type)))
 411
 412 ;; Compute the slot definition for slots in a view-class.  Figures out
 413 ;; what kind of database value (if any) is stored there, generates and
 414 ;; verifies the column name.
 415
 416 (declaim (inline delistify))
 417 (defun delistify (list)
 418   "Some MOPs, like openmcl 0.14.2, cons attribute values in a list."
 419   (if (listp list)
 420       (car list)
 421       list))
 422
 423 (declaim (inline delistify-dsd))
 424 (defun delistify-dsd (list)
 425   "Some MOPs, like openmcl 0.14.2, cons attribute values in a list."
 426   (if (and (listp list) (null (cdr list)))
 427       (car list)
 428       list))
 429
 430 (defmethod initialize-instance :around ((obj view-class-direct-slot-definition)
 431                                         &rest initargs)
 432   (do* ((parsed (list obj))
 433         (name (first initargs) (first initargs))
 434         (val (second initargs) (second initargs))
 435         (type nil)
 436         (db-constraints nil))
 437       ((null initargs)
 438        (setq parsed
 439              (append parsed
 440                      (list 'specified-type type
 441                            :type (compute-lisp-type-from-specified-type
 442                                   type db-constraints))))
 443        (apply #'call-next-method parsed))
 444     (case name
 445       (:db-constraints
 446        (setq db-constraints val)
 447        (setq parsed (append parsed (list name val))))
 448       (:type
 449        (setq type val))
 450       (t
 451        (setq parsed (append parsed (list name val)))))
 452     (setq initargs (cddr initargs))))
 453
 454 (defmethod compute-effective-slot-definition ((class standard-db-class)
 455                                               #+kmr-normal-cesd slot-name
 456                                               direct-slots)
 457   #+kmr-normal-cesd (declare (ignore slot-name))
 458
 459   ;; KMR: store the user-specified type and then compute
 460   ;; real Lisp type and store it
 461   (let ((dsd (car direct-slots)))
 462     (let ((esd (call-next-method)))
 463       (typecase dsd
 464         (view-class-slot-definition-mixin
 465          ;; Use the specified :column argument if it is supplied, otherwise
 466          ;; the column slot is filled in with the slot-name,  but transformed
 467          ;; to be sql safe, - to _ and such.
 468          (setf (slot-value esd 'column)
 469            (column-name-from-arg
 470             (if (slot-boundp dsd 'column)
 471                 (delistify-dsd (view-class-slot-column dsd))
 472               (column-name-from-arg
 473                (sql-escape (slot-definition-name dsd))))))
 474
 475          (setf (slot-value esd 'db-type)
 476            (when (slot-boundp dsd 'db-type)
 477              (delistify-dsd
 478               (view-class-slot-db-type dsd))))
 479
 480          (setf (slot-value esd 'void-value)
 481                (delistify-dsd
 482                 (view-class-slot-void-value dsd)))
 483
 484          ;; :db-kind slot value defaults to :base (store slot value in
 485          ;; database)
 486
 487          (setf (slot-value esd 'db-kind)
 488            (if (slot-boundp dsd 'db-kind)
 489                (delistify-dsd (view-class-slot-db-kind dsd))
 490              :base))
 491
 492          (setf (slot-value esd 'db-reader)
 493            (when (slot-boundp dsd 'db-reader)
 494              (delistify-dsd (view-class-slot-db-reader dsd))))
 495          (setf (slot-value esd 'db-writer)
 496            (when (slot-boundp dsd 'db-writer)
 497              (delistify-dsd (view-class-slot-db-writer dsd))))
 498          (setf (slot-value esd 'db-constraints)
 499            (when (slot-boundp dsd 'db-constraints)
 500              (delistify-dsd (view-class-slot-db-constraints dsd))))
 501
 502          ;; I wonder if this slot option and the previous could be merged,
 503          ;; so that :base and :key remain keyword options, but :db-kind
 504          ;; :join becomes :db-kind (:join <db info .... >)?
 505
 506          (setf (slot-value esd 'db-info)
 507                (when (slot-boundp dsd 'db-info)
 508                  (let ((dsd-info (view-class-slot-db-info dsd)))
 509                    (cond
 510                      ((atom dsd-info)
 511                       dsd-info)
 512                      ((and (listp dsd-info) (> (length dsd-info) 1)
 513                            (atom (car dsd-info)))
 514                       (parse-db-info dsd-info))
 515                      ((and (listp dsd-info) (= 1 (length dsd-info))
 516                            (listp (car dsd-info)))
 517                       (parse-db-info (car dsd-info)))))))
 518
 519          (setf (specified-type esd)
 520                (delistify-dsd (specified-type dsd)))
 521
 522          )
 523         ;; all other slots
 524         (t
 525          (unless (typep esd 'view-class-effective-slot-definition)
 526            (warn "Non view-class-direct-slot object with non-view-class-effective-slot-definition in compute-effective-slot-definition")
 527
 528            (let ((type-predicate #+openmcl (slot-value esd 'ccl::type-predicate)))
 529              #-openmcl (declare (ignore type-predicate))
 530              #-(or clisp sbcl)  (change-class esd 'view-class-effective-slot-definition
 531                                               #+allegro :name
 532                                               #+allegro (slot-definition-name dsd))
 533              #+openmcl (setf (slot-value esd 'ccl::type-predicate)
 534                              type-predicate)))
 535
 536          (setf (slot-value esd 'column)
 537            (column-name-from-arg
 538             (sql-escape (slot-definition-name dsd))))
 539
 540          (setf (slot-value esd 'db-info) nil)
 541          (setf (slot-value esd 'db-kind) :virtual)
 542          (setf (specified-type esd) (slot-definition-type dsd)))
 543         )
 544       esd)))
 545
 546 (defun slotdefs-for-slots-with-class (slots class)
 547   (let ((result nil))
 548     (dolist (s slots)
 549       (let ((c (slotdef-for-slot-with-class s class)))
 550         (if c (setf result (cons c result)))))
 551     result))
 552
 553 (defun slotdef-for-slot-with-class (slot class)
 554   (find-if #'(lambda (d) (eql slot (slot-definition-name d)))
 555            (class-slots class)))
 556
 557 #+ignore
 558 (eval-when (:compile-toplevel :load-toplevel :execute)
 559   #+kmr-normal-cesd
 560   (setq cl:*features* (delete :kmr-normal-cesd cl:*features*))
 561   #+kmr-normal-dsdc
 562   (setq cl:*features* (delete :kmr-normal-dsdc cl:*features*))
 563   #+kmr-normal-esdc
 564   (setq cl:*features* (delete :kmr-normal-esdc cl:*features*))
 565   )