upgrade.lisp 8.35 KB
Newer Older
1 2 3 4
;;;; -------------------------------------------------------------------------
;;;; Handle upgrade as forward- and backward-compatibly as possible
;; See https://bugs.launchpad.net/asdf/+bug/485687

5
(uiop/package:define-package :asdf/upgrade
6
  (:recycle :asdf/upgrade :asdf)
7
  (:use :uiop/common-lisp :uiop)
8
  (:export
9
   #:asdf-version #:*previous-asdf-versions* #:*asdf-version*
10
   #:asdf-message #:*verbose-out*
11
   #:upgrading-p #:when-upgrading #:upgrade-asdf #:asdf-upgrade-error #:defparameter*
12
   #:*post-upgrade-cleanup-hook* #:*post-upgrade-restart-hook* #:cleanup-upgraded-asdf
13
   ;; There will be no symbol left behind!
14
   #:intern*)
15
  (:import-from :uiop/package #:intern* #:find-symbol*))
16 17 18 19
(in-package :asdf/upgrade)

;;; Special magic to detect if this is an upgrade

20
(with-upgradability ()
21 22 23 24 25
  (defun asdf-version ()
    "Exported interface to the version of ASDF currently installed. A string.
You can compare this string with e.g.: (ASDF:VERSION-SATISFIES (ASDF:ASDF-VERSION) \"3.4.5.67\")."
    (when (find-package :asdf)
      (or (symbol-value (find-symbol (string :*asdf-version*) :asdf))
26 27 28 29 30
          (let* ((revsym (find-symbol (string :*asdf-revision*) :asdf))
                 (rev (and revsym (boundp revsym) (symbol-value revsym))))
            (etypecase rev
              (string rev)
              (cons (format nil "~{~D~^.~}" rev))
31
              (null "1.0"))))))
32 33
  ;; Important: define *p-a-v* /before/ *a-v* so that it initializes correctly.
  (defvar *previous-asdf-versions* (if-let (previous (asdf-version)) (list previous)))
34
  (defvar *asdf-version* nil)
35
  ;; We need to clear systems from versions yet older than the below:
36
  (defparameter *oldest-forward-compatible-asdf-version* "2.33") ;; 2.32.13 renames a slot in component.
37
  (defvar *verbose-out* nil)
38
  (defun asdf-message (format-string &rest format-args)
39
    (when *verbose-out* (apply 'format *verbose-out* format-string format-args)))
40 41
  (defvar *post-upgrade-cleanup-hook* ())
  (defvar *post-upgrade-restart-hook* ())
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
42 43 44
  (defun upgrading-p (&optional (oldest-compatible-version *oldest-forward-compatible-asdf-version*))
    (and *previous-asdf-versions*
         (version< (first *previous-asdf-versions*) oldest-compatible-version)))
45 46 47 48 49 50 51 52
  (defmacro defparameter* (var value &optional docstring (version *oldest-forward-compatible-asdf-version*))
    (let* ((name (string-trim "*" var))
           (valfun (intern (format nil "%~A-~A-~A" :compute name :value))))
      `(progn
         (defun ,valfun () ,value)
         (defvar ,var (,valfun) ,@(ensure-list docstring))
         (when (upgrading-p ,version)
           (setf ,var (,valfun))))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
53 54
  (defmacro when-upgrading ((&key (version *oldest-forward-compatible-asdf-version*)
                               (upgrading-p `(upgrading-p ,version)) when) &body body)
55
    "A wrapper macro for code that should only be run when upgrading a
56
previously-loaded version of ASDF."
57
    `(with-upgradability ()
58 59
       (when (and ,upgrading-p ,@(when when `(,when)))
         (handler-bind ((style-warning #'muffle-warning))
60
           (eval '(progn ,@body))))))
61
  (let* (;; For bug reporting sanity, please always bump this version when you modify this file.
62
         ;; Please also modify asdf.asd to reflect this change. make bump-version v=3.4.5.67.8
63
         ;; can help you do these changes in synch (look at the source for documentation).
64
         ;; Relying on its automation, the version is now redundantly present on top of asdf.lisp.
65 66
         ;; "3.4" would be the general branch for major version 3, minor version 4.
         ;; "3.4.5" would be an official release in the 3.4 branch.
67
         ;; "3.4.5.67" would be a development version in the official branch, on top of 3.4.5.
68 69
         ;; "3.4.5.0.8" would be your eighth local modification of official release 3.4.5
         ;; "3.4.5.67.8" would be your eighth local modification of development version 3.4.5.67
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
70
         (asdf-version "3.1.5.8")
71
         (existing-version (asdf-version)))
72
    (setf *asdf-version* asdf-version)
73 74
    (when (and existing-version (not (equal asdf-version existing-version)))
      (push existing-version *previous-asdf-versions*)
75 76
      (when (or *verbose-out* *load-verbose*)
        (format (or *verbose-out* *trace-output*)
77
                (compatfmt "~&~@<; ~@;Upgrading ASDF ~@[from version ~A ~]to version ~A~@:>~%")
78
                existing-version asdf-version)))))
79 80 81

(when-upgrading ()
  (let ((redefined-functions ;; gf signature and/or semantics changed incompatibly. Oops.
82 83
          ;; NB: it's too late to do anything about functions in UIOP!
          ;; If you introduce some critically incompatibility there, you must change name.
84 85 86
          '(#:component-relative-pathname #:component-parent-pathname ;; component
            #:source-file-type
            #:find-system #:system-source-file #:system-relative-pathname ;; system
87 88 89 90
            #:find-component ;; find-component
            #:explain #:perform #:perform-with-restarts #:input-files #:output-files ;; action
            #:component-depends-on #:operation-done-p #:component-depends-on
            #:traverse ;; backward-interface
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
91
            #:map-direct-dependencies #:reduce-direct-dependencies #:direct-dependencies ;; plan
92 93 94 95 96 97 98 99
            #:operate  ;; operate
            #:parse-component-form ;; defsystem
            #:apply-output-translations ;; output-translations
            #:process-output-translations-directive
            #:inherit-source-registry #:process-source-registry ;; source-registry
            #:process-source-registry-directive
            #:trivial-system-p)) ;; bundle
        (redefined-classes
100
          ;; redefining the classes causes interim circularities
101
          ;; with the old ASDF during upgrade, and many implementations bork
102
          '((#:compile-concatenated-source-op (#:operation) ()))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
103
    (loop :for name :in redefined-functions
104 105
          :for sym = (find-symbol* name :asdf nil) :do
            (when sym
106 107
              ;; On CLISP we seem to be unable to fmakunbound and define a function in the same fasl. Sigh.
              #-clisp (fmakunbound sym)))
108
    (labels ((asym (x) (multiple-value-bind (s p) (if (consp x) (values (car x) (cadr x)) (values x :asdf))
109 110
                         (find-symbol* s p nil)))
             (asyms (l) (mapcar #'asym l)))
111
      (loop* :for (name superclasses slots) :in redefined-classes
112 113 114
             :for sym = (find-symbol* name :asdf nil)
             :when (and sym (find-class sym))
             :do (eval `(defclass ,sym ,(asyms superclasses) ,(asyms slots)))))))
115

116

117
;;; Self-upgrade functions
118

119 120 121 122 123
(with-upgradability ()
  (defun asdf-upgrade-error ()
    ;; Important notice for whom it concerns. The crux of the matter is that
    ;; TRAVERSE can be completely refactored, and so after the find-system returns, it's too late.
    (error "When a system transitively depends on ASDF, it must :defsystem-depends-on (:asdf)~%~
124
          Otherwise, when you upgrade from ASDF 2, you must do it before you operate on any system.~%"))
125

126 127 128 129 130
  (defun cleanup-upgraded-asdf (&optional (old-version (first *previous-asdf-versions*)))
    (let ((new-version (asdf-version)))
      (unless (equal old-version new-version)
        (push new-version *previous-asdf-versions*)
        (when old-version
131 132 133 134 135
          (if (version<= new-version old-version)
              (error (compatfmt "~&~@<; ~@;Downgraded ASDF from version ~A to version ~A~@:>~%")
                     old-version new-version)
              (asdf-message (compatfmt "~&~@<; ~@;Upgraded ASDF from version ~A to version ~A~@:>~%")
                            old-version new-version))
136 137 138 139 140 141
          ;; In case the previous version was too old to be forward-compatible, clear systems.
          ;; TODO: if needed, we may have to define a separate hook to run
          ;; in case of forward-compatible upgrade.
          ;; Or to move the tests forward-compatibility test inside each hook function?
          (unless (version<= *oldest-forward-compatible-asdf-version* old-version)
            (call-functions (reverse *post-upgrade-cleanup-hook*)))
142
          t))))
143

144 145
  (defun upgrade-asdf ()
    "Try to upgrade of ASDF. If a different version was used, return T.
146
   We need do that before we operate on anything that may possibly depend on ASDF."
147 148
    (let ((*load-print* nil)
          (*compile-print* nil))
149
      (handler-bind (((or style-warning) #'muffle-warning))
150 151 152
        (symbol-call :asdf :load-system :asdf :verbose nil))))

  (register-hook-function '*post-upgrade-cleanup-hook* 'upgrade-configuration))
153