package.el 66.8 KB
Newer Older
1 2
;;; package.el --- Simple package system for Emacs

3
;; Copyright (C) 2007-2013 Free Software Foundation, Inc.
4 5 6

;; Author: Tom Tromey <tromey@redhat.com>
;; Created: 10 Mar 2007
7
;; Version: 1.0.1
8
;; Keywords: tools
9
;; Package-Requires: ((tabulated-list "1.0"))
10 11 12

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
17 18 19 20 21 22 23

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

;;; Change Log:

;;  2 Apr 2007 - now using ChangeLog file
;; 15 Mar 2007 - updated documentation
;; 14 Mar 2007 - Changed how obsolete packages are handled
;; 13 Mar 2007 - Wrote package-install-from-buffer
;; 12 Mar 2007 - Wrote package-menu mode

;;; Commentary:

;; The idea behind package.el is to be able to download packages and
;; install them.  Packages are versioned and have versioned
;; dependencies.  Furthermore, this supports built-in packages which
;; may or may not be newer than user-specified packages.  This makes
;; it possible to upgrade Emacs and automatically disable packages
;; which have moved from external to core.  (Note though that we don't
;; currently register any of these, so this feature does not actually
;; work.)

;; A package is described by its name and version.  The distribution
;; format is either  a tar file or a single .el file.

;; A tar file should be named "NAME-VERSION.tar".  The tar file must
;; unpack into a directory named after the package and version:
;; "NAME-VERSION".  It must contain a file named "PACKAGE-pkg.el"
;; which consists of a call to define-package.  It may also contain a
;; "dir" file and the info files it references.

54
;; A .el file is named "NAME-VERSION.el" in the remote archive, but is
55 56
;; installed as simply "NAME.el" in a directory named "NAME-VERSION".

57 58 59 60
;; The downloader downloads all dependent packages.  By default,
;; packages come from the official GNU sources, but others may be
;; added by customizing the `package-archives' alist.  Packages get
;; byte-compiled at install time.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78

;; At activation time we will set up the load-path and the info path,
;; and we will load the package's autoloads.  If a package's
;; dependencies are not available, we will not activate that package.

;; Conceptually a package has multiple state transitions:
;;
;; * Download.  Fetching the package from ELPA.
;; * Install.  Untar the package, or write the .el file, into
;;   ~/.emacs.d/elpa/ directory.
;; * Byte compile.  Currently this phase is done during install,
;;   but we may change this.
;; * Activate.  Evaluate the autoloads for the package to make it
;;   available to the user.
;; * Load.  Actually load the package and run some code from it.

;; Other external functions you may want to use:
;;
79
;; M-x list-packages
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
;;    Enters a mode similar to buffer-menu which lets you manage
;;    packages.  You can choose packages for install (mark with "i",
;;    then "x" to execute) or deletion (not implemented yet), and you
;;    can see what packages are available.  This will automatically
;;    fetch the latest list of packages from ELPA.
;;
;; M-x package-install-from-buffer
;;    Install a package consisting of a single .el file that appears
;;    in the current buffer.  This only works for packages which
;;    define a Version header properly; package.el also supports the
;;    extension headers Package-Version (in case Version is an RCS id
;;    or similar), and Package-Requires (if the package requires other
;;    packages).
;;
;; M-x package-install-file
;;    Install a package from the indicated file.  The package can be
;;    either a tar file or a .el file.  A tar file must contain an
;;    appropriately-named "-pkg.el" file; a .el file must be properly
;;    formatted as with package-install-from-buffer.

;;; Thanks:
;;; (sorted by sort-lines):

;; Jim Blandy <jimb@red-bean.com>
;; Karl Fogel <kfogel@red-bean.com>
;; Kevin Ryde <user42@zip.com.au>
;; Lawrence Mitchell
;; Michael Olson <mwolson@member.fsf.org>
;; Sebastian Tennant <sebyte@smolny.plus.com>
;; Stefan Monnier <monnier@iro.umontreal.ca>
;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
;; Phil Hagelberg <phil@hagelb.org>

;;; ToDo:

115 116
;; - a trust mechanism, since compiling a package can run arbitrary code.
;;   For example, download package signatures and check that they match.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
;; - putting info dirs at the start of the info path means
;;   users see a weird ordering of categories.  OTOH we want to
;;   override later entries.  maybe emacs needs to enforce
;;   the standard layout?
;; - put bytecode in a separate directory tree
;; - perhaps give users a way to recompile their bytecode
;;   or do it automatically when emacs changes
;; - give users a way to know whether a package is installed ok
;; - give users a way to view a package's documentation when it
;;   only appears in the .el
;; - use/extend checkdoc so people can tell if their package will work
;; - "installed" instead of a blank in the status column
;; - tramp needs its files to be compiled in a certain order.
;;   how to handle this?  fix tramp?
;; - on emacs 21 we don't kill the -autoloads.el buffer.  what about 22?
;; - maybe we need separate .elc directories for various emacs versions
;;   and also emacs-vs-xemacs.  That way conditional compilation can
;;   work.  But would this break anything?
;; - should store the package's keywords in archive-contents, then
;;   let the users filter the package-menu by keyword.  See
;;   finder-by-keyword.  (We could also let people view the
;;   Commentary, but it isn't clear how useful this is.)
;; - William Xu suggests being able to open a package file without
;;   installing it
;; - Interface with desktop.el so that restarting after an install
;;   works properly
;; - Use hierarchical layout.  PKG/etc PKG/lisp PKG/info
;;   ... except maybe lisp?
;; - It may be nice to have a macro that expands to the package's
;;   private data dir, aka ".../etc".  Or, maybe data-directory
;;   needs to be a list (though this would be less nice)
;;   a few packages want this, eg sokoban
;; - package menu needs:
;;     ability to know which packages are built-in & thus not deletable
;;     it can sometimes print odd results, like 0.3 available but 0.4 active
;;        why is that?
;; - Allow multiple versions on the server...?
;;   [ why bother? ]
;; - Don't install a package which will invalidate dependencies overall
;; - Allow something like (or (>= emacs 21.0) (>= xemacs 21.5))
;;   [ currently thinking, why bother.. KISS ]
;; - Allow optional package dependencies
;;   then if we require 'bbdb', bbdb-specific lisp in lisp/bbdb
;;   and just don't compile to add to load path ...?
;; - Our treatment of the info path is somewhat bogus

;;; Code:

165 166
(eval-when-compile (require 'cl-lib))

167 168
(require 'tabulated-list)

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
(defgroup package nil
  "Manager for Emacs Lisp packages."
  :group 'applications
  :version "24.1")

;;;###autoload
(defcustom package-enable-at-startup t
  "Whether to activate installed packages when Emacs starts.
If non-nil, packages are activated after reading the init file
and before `after-init-hook'.  Activation is not done if
`user-init-file' is nil (e.g. Emacs was started with \"-q\").

Even if the value is nil, you can type \\[package-initialize] to
activate the package system at any time."
  :type 'boolean
  :group 'package
  :version "24.1")

(defcustom package-load-list '(all)
  "List of packages for `package-initialize' to load.
Each element in this list should be a list (NAME VERSION), or the
symbol `all'.  The symbol `all' says to load the latest installed
versions of all packages not specified by other elements.

For an element (NAME VERSION), NAME is a package name (a symbol).
VERSION should be t, a string, or nil.
If VERSION is t, all versions are loaded, though obsolete ones
196
 will be put in `package-obsolete-list' and not activated.
197 198 199 200 201
If VERSION is a string, only that version is ever loaded.
 Any other version, even if newer, is silently ignored.
 Hence, the package is \"held\" at that version.
If VERSION is nil, the package is not loaded (it is \"disabled\")."
  :type '(repeat symbol)
202
  :risky t
203 204 205 206 207 208 209 210
  :group 'package
  :version "24.1")

(defvar Info-directory-list)
(declare-function info-initialize "info" ())
(declare-function url-http-parse-response "url-http" ())
(declare-function lm-header "lisp-mnt" (header))
(declare-function lm-commentary "lisp-mnt" (&optional file))
211
(defvar url-http-end-of-headers)
212

213 214 215
(defcustom package-archives '(("gnu" . "http://elpa.gnu.org/packages/"))
  "An alist of archives from which to fetch.
The default value points to the GNU Emacs package repository.
216 217 218 219 220 221

Each element has the form (ID . LOCATION).
 ID is an archive name, as a string.
 LOCATION specifies the base location for the archive.
  If it starts with \"http:\", it is treated as a HTTP URL;
  otherwise it should be an absolute directory name.
222 223 224 225
  (Other types of URL are currently not supported.)

Only add locations that you trust, since fetching and installing
a package can run arbitrary code."
226
  :type '(alist :key-type (string :tag "Archive name")
227
                :value-type (string :tag "URL or directory name"))
228 229 230
  :risky t
  :group 'package
  :version "24.1")
231

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
(defcustom package-pinned-packages nil
  "An alist of packages that are pinned to a specific archive

Each element has the form (SYM . ID).
 SYM is a package, as a symbol.
 ID is an archive name, as a string. This should correspond to an
 entry in `package-archives'.

If the archive of name ID does not contain the package SYM, no
other location will be considered, which will make the
package unavailable."
  :type '(alist :key-type (symbol :tag "Package")
                :value-type (string :tag "Archive name"))
  :risky t
  :group 'package
  :version "24.4")

249 250 251 252
(defconst package-archive-version 1
  "Version number of the package archive understood by this file.
Lower version numbers than this will probably be understood as well.")

253
(defconst package-el-version "1.0.1"
254 255 256 257 258
  "Version of package.el.")

;; We don't prime the cache since it tends to get out of date.
(defvar package-archive-contents nil
  "Cache of the contents of the Emacs Lisp Package Archive.
259
This is an alist mapping package names (symbols) to
260
`package-desc' structures.")
261
(put 'package-archive-contents 'risky-local-variable t)
262 263 264 265 266 267 268

(defcustom package-user-dir (locate-user-emacs-file "elpa")
  "Directory containing the user's Emacs Lisp packages.
The directory name should be absolute.
Apart from this directory, Emacs also looks for system-wide
packages in `package-directory-list'."
  :type 'directory
269
  :risky t
270 271 272 273 274 275 276
  :group 'package
  :version "24.1")

(defcustom package-directory-list
  ;; Defaults are subdirs named "elpa" in the site-lisp dirs.
  (let (result)
    (dolist (f load-path)
277 278 279
      (and (stringp f)
	   (equal (file-name-nondirectory f) "site-lisp")
	   (push (expand-file-name "elpa" f) result)))
280 281 282 283 284 285 286
    (nreverse result))
  "List of additional directories containing Emacs Lisp packages.
Each directory name should be absolute.

These directories contain packages intended for system-wide; in
contrast, `package-user-dir' contains packages for personal use."
  :type '(repeat directory)
287
  :risky t
288 289 290
  :group 'package
  :version "24.1")

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
(defvar package--default-summary "No description available.")

(cl-defstruct (package-desc
               ;; Rename the default constructor from `make-package-desc'.
               (:constructor package-desc-create)
               ;; Has the same interface as the old `define-package',
               ;; which is still used in the "foo-pkg.el" files. Extra
               ;; options can be supported by adding additional keys.
               (:constructor
                package-desc-from-define
                (name-string version-string &optional summary requirements
                 &key kind archive
                 &aux
                 (name (intern name-string))
                 (version (version-to-list version-string))
                 (reqs (mapcar #'(lambda (elt)
                                   (list (car elt)
                                         (version-to-list (cadr elt))))
                               (if (eq 'quote (car requirements))
                                   (nth 1 requirements)
                                 requirements))))))
  "Structure containing information about an individual package.

Slots:

`name' Name of the package, as a symbol.

`version' Version of the package, as a version list.

`summary' Short description of the package, typically taken from
the first line of the file.

`reqs' Requirements of the package. A list of (PACKAGE
VERSION-LIST) naming the dependent package and the minimum
required version.

`kind' The distribution format of the package. Currently, it is
either `single' or `tar'.

`archive' The name of the archive (as a string) whence this
331 332 333
package came.

`dir' The directory where the package is installed (if installed)."
334 335 336 337 338
  name
  version
  (summary package--default-summary)
  reqs
  kind
339 340 341 342
  archive
  dir)

;; Pseudo fields.
343
(defun package-desc-full-name (pkg-desc)
344 345 346
  (format "%s-%s"
          (package-desc-name pkg-desc)
          (package-version-join (package-desc-version pkg-desc))))
347

348 349 350 351 352 353
(defun package-desc-suffix (pkg-desc)
  (pcase (package-desc-kind pkg-desc)
    (`single ".el")
    (`tar ".tar")
    (kind (error "Unknown package kind: %s" kind))))

354 355 356 357 358 359 360 361
;; Package descriptor format used in finder-inf.el and package--builtins.
(cl-defstruct (package--bi-desc
               (:constructor package-make-builtin (version summary))
               (:type vector))
  version
  reqs
  summary)

362 363
(defvar package--builtins nil
  "Alist of built-in packages.
364 365 366 367
The actual value is initialized by loading the library
`finder-inf'; this is not done until it is needed, e.g. by the
function `package-built-in-p'.

368 369
Each element has the form (PKG . PACKAGE-BI-DESC), where PKG is a package
name (a symbol) and DESC is a `package--bi-desc' structure.")
370
(put 'package--builtins 'risky-local-variable t)
371

372
(defvar package-alist nil
373
  "Alist of all packages available for activation.
374
Each element has the form (PKG . DESC), where PKG is a package
375
name (a symbol) and DESC is a `package-desc' structure.
376 377 378 379

This variable is set automatically by `package-load-descriptor',
called via `package-initialize'.  To change which packages are
loaded and/or activated, customize `package-load-list'.")
380
(put 'package-alist 'risky-local-variable t)
381

382
(defvar package-activated-list nil
383
  ;; FIXME: This should implicitly include all builtin packages.
384
  "List of the names of currently activated packages.")
385
(put 'package-activated-list 'risky-local-variable t)
386

387 388 389 390
(defvar package-obsolete-list nil
  "List of obsolete packages.
Each element of the list is a `package-desc'.")
(put 'package-obsolete-list 'risky-local-variable t)
391

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
(defun package-version-join (vlist)
  "Return the version string corresponding to the list VLIST.
This is, approximately, the inverse of `version-to-list'.
\(Actually, it returns only one of the possible inverses, since
`version-to-list' is a many-to-one operation.)"
  (if (null vlist)
      ""
    (let ((str-list (list "." (int-to-string (car vlist)))))
      (dolist (num (cdr vlist))
	(cond
	 ((>= num 0)
	  (push (int-to-string num) str-list)
	  (push "." str-list))
	 ((< num -3)
	  (error "Invalid version list `%s'" vlist))
	 (t
	  ;; pre, or beta, or alpha
	  (cond ((equal "." (car str-list))
		 (pop str-list))
		((not (string-match "[0-9]+" (car str-list)))
		 (error "Invalid version list `%s'" vlist)))
	  (push (cond ((= num -1) "pre")
		      ((= num -2) "beta")
		      ((= num -3) "alpha"))
		str-list))))
      (if (equal "." (car str-list))
	  (pop str-list))
      (apply 'concat (nreverse str-list)))))
420

421 422 423 424 425 426 427 428
(defun package-load-descriptor (pkg-dir)
  "Load the description file in directory PKG-DIR."
  (let ((pkg-file (expand-file-name (package--description-file pkg-dir)
                                    pkg-dir)))
    (when (file-exists-p pkg-file)
      (with-temp-buffer
        (insert-file-contents pkg-file)
        (goto-char (point-min))
429 430
        (let ((pkg-desc (package-process-define-package
                         (read (current-buffer)) pkg-file)))
431 432
          (setf (package-desc-dir pkg-desc) pkg-dir)
          pkg-desc)))))
433 434 435 436 437 438 439 440 441

(defun package-load-all-descriptors ()
  "Load descriptors for installed Emacs Lisp packages.
This looks for package subdirectories in `package-user-dir' and
`package-directory-list'.  The variable `package-load-list'
controls which package subdirectories may be loaded.

In each valid package subdirectory, this function loads the
description file containing a call to `define-package', which
442
updates `package-alist' and `package-obsolete-list'."
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
  (dolist (dir (cons package-user-dir package-directory-list))
    (when (file-directory-p dir)
      (dolist (subdir (directory-files dir))
        (let ((pkg-dir (expand-file-name subdir dir)))
          (when (file-directory-p pkg-dir)
            (package-load-descriptor pkg-dir)))))))

(defun package-disabled-p (pkg-name version)
  "Return whether PKG-NAME at VERSION can be activated.
The decision is made according to `package-load-list'.
Return nil if the package can be activated.
Return t if the package is completely disabled.
Return the max version (as a string) if the package is held at a lower version."
  (let ((force (assq pkg-name package-load-list)))
    (cond ((null force) (not (memq 'all package-load-list)))
          ((null (setq force (cadr force))) t) ; disabled
          ((eq force t) nil)
          ((stringp force)              ; held
           (unless (version-list-= version (version-to-list force))
             force))
          (t (error "Invalid element in `package-load-list'")))))
464

465 466
(defun package-activate-1 (pkg-desc)
  (let* ((name (package-desc-name pkg-desc))
467
	 (pkg-dir (package-desc-dir pkg-desc)))
468
    (unless pkg-dir
469 470
      (error "Internal error: unable to find directory for `%s'"
	     (package-desc-full-name pkg-desc)))
471
    ;; Add info node.
472 473 474 475 476
    (when (file-exists-p (expand-file-name "dir" pkg-dir))
      ;; FIXME: not the friendliest, but simple.
      (require 'info)
      (info-initialize)
      (push pkg-dir Info-directory-list))
477
    ;; Add to load path, add autoloads, and activate the package.
478
    (push pkg-dir load-path)
479 480
    (load (expand-file-name (format "%s-autoloads" name) pkg-dir) nil t)
    (push name package-activated-list)
481 482 483
    ;; Don't return nil.
    t))

Chong Yidong's avatar
Chong Yidong committed
484 485 486 487
(defun package-built-in-p (package &optional min-version)
  "Return true if PACKAGE is built-in to Emacs.
Optional arg MIN-VERSION, if non-nil, should be a version list
specifying the minimum acceptable version."
488 489 490 491 492 493 494
  (let ((bi (assq package package--builtin-versions)))
    (cond
     (bi (version-list-<= min-version (cdr bi)))
     (min-version nil)
     (t
      (require 'finder-inf nil t) ; For `package--builtins'.
      (assq package package--builtins)))))
495 496 497 498 499

(defun package--from-builtin (bi-desc)
  (package-desc-create :name (pop bi-desc)
                       :version (package--bi-desc-version bi-desc)
                       :summary (package--bi-desc-summary bi-desc)))
500

501 502 503 504
;; This function goes ahead and activates a newer version of a package
;; if an older one was already activated.  This is not ideal; we'd at
;; least need to check to see if the package has actually been loaded,
;; and not merely activated.
Chong Yidong's avatar
Chong Yidong committed
505 506 507
(defun package-activate (package min-version)
  "Activate package PACKAGE, of version MIN-VERSION or newer.
MIN-VERSION should be a version list.
508
If PACKAGE has any dependencies, recursively activate them.
509
Return nil if the package could not be activated."
510 511 512 513
  (let ((pkg-vec (cdr (assq package package-alist)))
	available-version found)
    ;; Check if PACKAGE is available in `package-alist'.
    (when pkg-vec
514
      (setq available-version (package-desc-version pkg-vec)
Chong Yidong's avatar
Chong Yidong committed
515
	    found (version-list-<= min-version available-version)))
516 517 518
    (cond
     ;; If no such package is found, maybe it's built-in.
     ((null found)
Chong Yidong's avatar
Chong Yidong committed
519
      (package-built-in-p package min-version))
520 521 522
     ;; If the package is already activated, just return t.
     ((memq package package-activated-list)
      t)
523 524
     ;; If it's disabled, then just skip it.
     ((package-disabled-p package available-version) nil)
525 526 527 528 529 530 531 532 533
     ;; Otherwise, proceed with activation.
     (t
      (let ((fail (catch 'dep-failure
		    ;; Activate its dependencies recursively.
		    (dolist (req (package-desc-reqs pkg-vec))
		      (unless (package-activate (car req) (cadr req))
			(throw 'dep-failure req))))))
	(if fail
	    (warn "Unable to activate package `%s'.
534
Required package `%s-%s' is unavailable"
535 536
		  package (car fail) (package-version-join (cadr fail)))
	  ;; If all goes well, activate the package itself.
537
	  (package-activate-1 pkg-vec)))))))
538

539 540 541
(defun package-mark-obsolete (pkg-desc)
  "Put PKG-DESC on the obsolete list, if not already there."
  (push pkg-desc package-obsolete-list))
542

543 544 545
(defun define-package (_name-string _version-string
                                    &optional _docstring _requirements
                                    &rest _extra-properties)
546
  "Define a new package.
547
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
548
VERSION-STRING is the version of the package, as a string.
549 550
DOCSTRING is a short description of the package, a string.
REQUIREMENTS is a list of dependencies on other packages.
Chong Yidong's avatar
Chong Yidong committed
551 552
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
553 554

EXTRA-PROPERTIES is currently unused."
555 556 557 558 559 560 561 562 563 564
  ;; FIXME: Placeholder!  Should we keep it?
  (error "Don't call me!"))

(defun package-process-define-package (exp origin)
  (unless (eq (car-safe exp) 'define-package)
    (error "Can't find define-package in %s" origin))
  (let* ((new-pkg-desc (apply #'package-desc-from-define (cdr exp)))
         (name (package-desc-name new-pkg-desc))
         (version (package-desc-version new-pkg-desc))
         (old-pkg (assq name package-alist)))
565
    (cond
566 567 568
     ;; If it's not newer than a builtin version, mark it obsolete.
     ((let ((bi (assq name package--builtin-versions)))
        (and bi (version-list-<= version (cdr bi))))
569
      (package-mark-obsolete new-pkg-desc))
570 571
     ;; If there's no old package, just add this to `package-alist'.
     ((null old-pkg)
572
      (push (cons name new-pkg-desc) package-alist))
573
     ((version-list-< (package-desc-version (cdr old-pkg)) version)
574
      ;; Remove the old package and declare it obsolete.
575
      (package-mark-obsolete (cdr old-pkg))
576
      (setq package-alist (cons (cons name new-pkg-desc)
577 578 579 580
				(delq old-pkg package-alist))))
     ;; You can have two packages with the same version, e.g. one in
     ;; the system package directory and one in your private
     ;; directory.  We just let the first one win.
581
     ((not (version-list-= (package-desc-version (cdr old-pkg)) version))
582
      ;; The package is born obsolete.
583
      (package-mark-obsolete new-pkg-desc)))
584
    new-pkg-desc))
585

586
;; From Emacs 22, but changed so it adds to load-path.
587 588 589 590 591 592 593
(defun package-autoload-ensure-default-file (file)
  "Make sure that the autoload file FILE exists and if not create it."
  (unless (file-exists-p file)
    (write-region
     (concat ";;; " (file-name-nondirectory file)
	     " --- automatically extracted autoloads\n"
	     ";;\n"
594 595
	     ";;; Code:\n"
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
596 597 598 599 600 601 602 603 604 605 606
	     "\n;; Local Variables:\n"
	     ";; version-control: never\n"
	     ";; no-byte-compile: t\n"
	     ";; no-update-autoloads: t\n"
	     ";; End:\n"
	     ";;; " (file-name-nondirectory file)
	     " ends here\n")
     nil file))
  file)

(defun package-generate-autoloads (name pkg-dir)
Paul Eggert's avatar
Paul Eggert committed
607
  (require 'autoload)         ;Load before we let-bind generated-autoload-file!
608
  (let* ((auto-name (format "%s-autoloads.el" name))
609
	 ;;(ignore-name (concat name "-pkg.el"))
610 611
	 (generated-autoload-file (expand-file-name auto-name pkg-dir))
	 (version-control 'never))
612
    (package-autoload-ensure-default-file generated-autoload-file)
613 614
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
615 616
      (when buf (kill-buffer buf)))
    auto-name))
617

618 619
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
620 621
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
622 623

(defun package-untar-buffer (dir)
624
  "Untar the current buffer.
625 626
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
627
  (require 'tar-mode)
628 629
  (tar-mode)
  ;; Make sure everything extracts into DIR.
630 631
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
	(case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
632
    (dolist (tar-data tar-parse-info)
633 634 635 636 637 638 639
      (let ((name (expand-file-name (tar-header-name tar-data))))
	(or (string-match regexp name)
	    ;; Tarballs created by some utilities don't list
	    ;; directories with a trailing slash (Bug#13136).
	    (and (string-equal dir name)
		 (eq (tar-header-link-type tar-data) 5))
	    (error "Package does not untar cleanly into directory %s/" dir)))))
640
  (tar-untar-buffer))
641

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
(defun package-generate-description-file (pkg-desc pkg-dir)
  "Create the foo-pkg.el file for single-file packages."
  (let* ((name (package-desc-name pkg-desc))
         (pkg-file (expand-file-name (package--description-file pkg-dir)
                                     pkg-dir)))
    (let ((print-level nil)
          (print-quoted t)
          (print-length nil))
      (write-region
       (concat
        (prin1-to-string
         (list 'define-package
               (symbol-name name)
               (package-version-join (package-desc-version pkg-desc))
               (package-desc-summary pkg-desc)
               (let ((requires (package-desc-reqs pkg-desc)))
                 (list 'quote
                       ;; Turn version lists into string form.
                       (mapcar
                        (lambda (elt)
                          (list (car elt)
                                (package-version-join (cadr elt))))
                        requires)))))
        "\n")
       nil
       pkg-file))))

(defun package-unpack (pkg-desc)
  "Install the contents of the current buffer as a package."
  (let* ((name (package-desc-name pkg-desc))
         (dirname (package-desc-full-name pkg-desc))
673
	 (pkg-dir (expand-file-name dirname package-user-dir)))
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
    (pcase (package-desc-kind pkg-desc)
      (`tar
       (make-directory package-user-dir t)
       ;; FIXME: should we delete PKG-DIR if it exists?
       (let* ((default-directory (file-name-as-directory package-user-dir)))
         (package-untar-buffer dirname)))
      (`single
       (let ((el-file (expand-file-name (format "%s.el" name) pkg-dir)))
         (make-directory pkg-dir t)
         (package--write-file-no-coding el-file)))
      (kind (error "Unknown package kind: %S" kind)))
    (package--make-autoloads-and-stuff pkg-desc pkg-dir)
    ;; Update package-alist.
    (let ((new-desc (package-load-descriptor pkg-dir)))
      ;; FIXME: Check that `new-desc' matches `desc'!
      ;; FIXME: Compilation should be done as a separate, optional, step.
      ;; E.g. for multi-package installs, we should first install all packages
      ;; and then compile them.
      (package--compile new-desc))
    ;; Try to activate it.
    (package-activate name (package-desc-version pkg-desc))
    pkg-dir))

(defun package--make-autoloads-and-stuff (pkg-desc pkg-dir)
  "Generate autoloads, description file, etc.. for PKG-DESC installed at PKG-DIR."
  (package-generate-autoloads (package-desc-name pkg-desc) pkg-dir)
  (let ((desc-file (package--description-file pkg-dir)))
    (unless (file-exists-p desc-file)
      (package-generate-description-file pkg-desc pkg-dir)))
  ;; FIXME: Create foo.info and dir file from foo.texi?
  )

(defun package--compile (pkg-desc)
  "Byte-compile installed package PKG-DESC."
  (package-activate-1 pkg-desc)
  (byte-recompile-directory (package-desc-dir pkg-desc) 0 t))
710

711
(defun package--write-file-no-coding (file-name)
712
  (let ((buffer-file-coding-system 'no-conversion))
713
    (write-region (point-min) (point-max) file-name)))
714

715 716 717 718 719 720 721 722 723
(defmacro package--with-work-buffer (location file &rest body)
  "Run BODY in a buffer containing the contents of FILE at LOCATION.
LOCATION is the base location of a package archive, and should be
one of the URLs (or file names) specified in `package-archives'.
FILE is the name of a file relative to that base location.

This macro retrieves FILE from LOCATION into a temporary buffer,
and evaluates BODY while that buffer is current.  This work
buffer is killed afterwards.  Return the last value in BODY."
724
  (declare (indent 2) (debug t))
725
  `(let* ((http (string-match "\\`https?:" ,location))
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
	  (buffer
	   (if http
	       (url-retrieve-synchronously (concat ,location ,file))
	     (generate-new-buffer "*package work buffer*"))))
     (prog1
	 (with-current-buffer buffer
	   (if http
	       (progn (package-handle-response)
		      (re-search-forward "^$" nil 'move)
		      (forward-char)
		      (delete-region (point-min) (point)))
	     (unless (file-name-absolute-p ,location)
	       (error "Archive location %s is not an absolute file name"
		      ,location))
	     (insert-file-contents (expand-file-name ,file ,location)))
	   ,@body)
       (kill-buffer buffer))))

744
(defun package-handle-response ()
745
  "Handle the response from a `url-retrieve-synchronously' call.
746 747 748 749 750 751 752 753 754
Parse the HTTP response and throw if an error occurred.
The url package seems to require extra processing for this.
This should be called in a `save-excursion', in the download buffer.
It will move point to somewhere in the headers."
  ;; We assume HTTP here.
  (require 'url-http)
  (let ((response (url-http-parse-response)))
    (when (or (< response 200) (>= response 300))
      (error "Error during download request:%s"
755
	     (buffer-substring-no-properties (point) (line-end-position))))))
756

757
(defun package-install-from-archive (pkg-desc)
758
  "Download and install a tar package."
759 760 761
  (let ((location (package-archive-base pkg-desc))
	(file (concat (package-desc-full-name pkg-desc)
                      (package-desc-suffix pkg-desc))))
762
    (package--with-work-buffer location file
763
      (package-unpack pkg-desc))))
764

765 766
(defvar package--initialized nil)

767
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
768 769
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
MIN-VERSION should be a version list."
770
  (unless package--initialized (error "package.el is not yet initialized!"))
771
  (let ((pkg-desc (assq package package-alist)))
772 773
    (if pkg-desc
	(version-list-<= min-version
774
			 (package-desc-version (cdr pkg-desc)))
775 776
      ;; Also check built-in packages.
      (package-built-in-p package min-version))))
777

778 779 780 781 782
(defun package-compute-transaction (package-list requirements)
  "Return a list of packages to be installed, including PACKAGE-LIST.
PACKAGE-LIST should be a list of package names (symbols).

REQUIREMENTS should be a list of additional requirements; each
Chong Yidong's avatar
Chong Yidong committed
783 784 785
element in this list should have the form (PACKAGE VERSION-LIST),
where PACKAGE is a package name and VERSION-LIST is the required
version of that package.
786 787 788 789 790

This function recursively computes the requirements of the
packages in REQUIREMENTS, and returns a list of all the packages
that must be installed.  Packages that are already installed are
not included in this list."
791 792 793 794 795 796
  (dolist (elt requirements)
    (let* ((next-pkg (car elt))
	   (next-version (cadr elt)))
      (unless (package-installed-p next-pkg next-version)
	;; A package is required, but not installed.  It might also be
	;; blocked via `package-load-list'.
797
	(let ((pkg-desc (cdr (assq next-pkg package-archive-contents)))
798
              ;; FIXME: package-disabled-p needs to use a <= test!
799 800 801 802
	      (disabled (package-disabled-p next-pkg next-version)))
          (when disabled
            (if (stringp disabled)
                (error "Package `%s' held at version %s, \
803
but version %s required"
804 805 806 807
                       (symbol-name next-pkg) disabled
                       (package-version-join next-version))
              (error "Required package '%s' is disabled"
                     (symbol-name next-pkg))))
808
	  (unless pkg-desc
809
	    (error "Package `%s-%s' is unavailable"
810 811
		   (symbol-name next-pkg)
		   (package-version-join next-version)))
812
	  (unless (version-list-<= next-version
813
				   (package-desc-version pkg-desc))
814
	    (error
815
	     "Need package `%s-%s', but only %s is available"
816
	     (symbol-name next-pkg) (package-version-join next-version)
817
	     (package-version-join (package-desc-version pkg-desc))))
818 819
          ;; Move to front, so it gets installed early enough (bug#14082).
          (setq package-list (cons next-pkg (delq next-pkg package-list)))
820 821
	  (setq package-list
		(package-compute-transaction package-list
822
					     (package-desc-reqs
823
					      pkg-desc)))))))
824
  package-list)
825 826 827 828 829

(defun package-read-from-string (str)
  "Read a Lisp expression from STR.
Signal an error if the entire string was not used."
  (let* ((read-data (read-from-string str))
830 831 832 833 834 835 836
	 (more-left
	  (condition-case nil
	      ;; The call to `ignore' suppresses a compiler warning.
	      (progn (ignore (read-from-string
			      (substring str (cdr read-data))))
		     t)
	    (end-of-file nil))))
837 838 839 840 841 842 843 844 845
    (if more-left
        (error "Can't read whole string")
      (car read-data))))

(defun package--read-archive-file (file)
  "Re-read archive file FILE, if it exists.
Will return the data from the file, or nil if the file does not exist.
Will throw an error if the archive version is too new."
  (let ((filename (expand-file-name file package-user-dir)))
846 847 848 849 850 851 852 853
    (when (file-exists-p filename)
      (with-temp-buffer
	(insert-file-contents-literally filename)
	(let ((contents (read (current-buffer))))
	  (if (> (car contents) package-archive-version)
	      (error "Package archive version %d is higher than %d"
		     (car contents) package-archive-version))
	  (cdr contents))))))
854

855
(defun package-read-all-archive-contents ()
856 857
  "Re-read `archive-contents', if it exists.
If successful, set `package-archive-contents'."
858
  (setq package-archive-contents nil)
859
  (dolist (archive package-archives)
860
    (package-read-archive-contents (car archive))))
861

862
(defun package-read-archive-contents (archive)
863 864
  "Re-read archive contents for ARCHIVE.
If successful, set the variable `package-archive-contents'.
865
If the archive version is too new, signal an error."
866 867
  ;; Version 1 of 'archive-contents' is identical to our internal
  ;; representation.
868 869 870
  (let* ((contents-file (format "archives/%s/archive-contents" archive))
	 (contents (package--read-archive-file contents-file)))
    (when contents
871 872
      (dolist (package contents)
	(package--add-to-archive-contents package archive)))))
873

874 875 876 877 878 879 880 881 882
;; Package descriptor objects used inside the "archive-contents" file.
;; Changing this defstruct implies changing the format of the
;; "archive-contents" files.
(cl-defstruct (package--ac-desc
               (:constructor package-make-ac-desc (version reqs summary kind))
               (:copier nil)
               (:type vector))
  version reqs summary kind)

883 884
(defun package--add-to-archive-contents (package archive)
  "Add the PACKAGE from the given ARCHIVE if necessary.
885 886 887
PACKAGE should have the form (NAME . PACKAGE--AC-DESC).
Also, add the originating archive to the `package-desc' structure."
  (let* ((name (car package))
888
         (version (package--ac-desc-version (cdr package)))
889 890 891
         (pkg-desc
          (package-desc-create
           :name name
892
           :version version
893 894 895 896 897
           :reqs (package--ac-desc-reqs (cdr package))
           :summary (package--ac-desc-summary (cdr package))
           :kind (package--ac-desc-kind (cdr package))
           :archive archive))
         (entry (cons name pkg-desc))
898 899
         (existing-package (assq name package-archive-contents))
         (pinned-to-archive (assoc name package-pinned-packages)))
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
    (cond
     ;; Skip entirely if pinned to another archive or if no more recent
     ;; than what we already have installed.
     ((or (and pinned-to-archive
               (not (equal (cdr pinned-to-archive) archive)))
          (let ((bi (assq name package--builtin-versions)))
            (and bi (version-list-<= version (cdr bi))))
          (let ((ins (cdr (assq name package-alist))))
            (and ins (version-list-<= version (package-desc-version ins)))))
      nil)
     ((not existing-package)
      (push entry package-archive-contents))
     ((version-list-< (package-desc-version (cdr existing-package))
                      version)
      ;; Replace the entry with this one.
      (setq package-archive-contents
            (cons entry
                  (delq existing-package
                        package-archive-contents)))))))
919

920 921 922 923 924 925
(defun package-download-transaction (package-list)
  "Download and install all the packages in PACKAGE-LIST.
PACKAGE-LIST should be a list of package names (symbols).
This function assumes that all package requirements in
PACKAGE-LIST are satisfied, i.e. that PACKAGE-LIST is computed
using `package-compute-transaction'."
926
  ;; FIXME: make package-list a list of pkg-desc.
927
  (dolist (elt package-list)
928 929
    (let ((desc (cdr (assq elt package-archive-contents))))
      (package-install-from-archive desc))))
930 931

;;;###autoload
932 933 934 935
(defun package-install (pkg-desc)
  "Install the package PKG-DESC.
PKG-DESC should be one of the available packages in an
archive in `package-archives'.  Interactively, prompt for its name."
936
  (interactive
937 938 939 940 941
   (progn
     ;; Initialize the package system to get the list of package
     ;; symbols for completion.
     (unless package--initialized
       (package-initialize t))
942 943
     (unless package-archive-contents
       (package-refresh-contents))
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
     (let* ((name (intern (completing-read
                           "Install package: "
                           (mapcar (lambda (elt)
                                     (cons (symbol-name (car elt))
                                           nil))
                                   package-archive-contents)
                           nil t)))
            (pkg-desc (cdr (assq name package-archive-contents))))
       (unless pkg-desc
         (error "Package `%s' is not available for installation"
                name))
       (list pkg-desc))))
  (package-download-transaction
   ;; FIXME: Use (list pkg-desc) instead of just the name.
   (package-compute-transaction (list (package-desc-name pkg-desc))
                                (package-desc-reqs pkg-desc))))
960

961 962
(defun package-strip-rcs-id (str)
  "Strip RCS version ID from the version string STR.
963 964
If the result looks like a dotted numeric version, return it.
Otherwise return nil."
965 966 967 968 969 970 971
  (when str
    (when (string-match "\\`[ \t]*[$]Revision:[ \t]+" str)
      (setq str (substring str (match-end 0))))
    (condition-case nil
	(if (version-to-list str)
	    str)
      (error nil))))
972 973

(defun package-buffer-info ()
974
  "Return a `package-desc' describing the package in the current buffer.
975 976 977 978

If the buffer does not contain a conforming package, signal an
error.  If there is a package, narrow the buffer to the file's
boundaries."
979
  (goto-char (point-min))
980
  (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
    (error "Packages lacks a file header"))
  (let ((file-name (match-string-no-properties 1))
	(desc      (match-string-no-properties 2))
	(start     (line-beginning-position)))
    (unless (search-forward (concat ";;; " file-name ".el ends here"))
      (error "Package lacks a terminating comment"))
    ;; Try to include a trailing newline.
    (forward-line)
    (narrow-to-region start (point))
    (require 'lisp-mnt)
    ;; Use some headers we've invented to drive the process.
    (let* ((requires-str (lm-header "package-requires"))
	   ;; Prefer Package-Version; if defined, the package author
	   ;; probably wants us to use it.  Otherwise try Version.
	   (pkg-version
	    (or (package-strip-rcs-id (lm-header "package-version"))
997
		(package-strip-rcs-id (lm-header "version")))))
998 999 1000
      (unless pkg-version
	(error
	 "Package lacks a \"Version\" or \"Package-Version\" header"))
1001 1002 1003 1004
      (package-desc-from-define
       file-name pkg-version desc
       (if requires-str (package-read-from-string requires-str))
       :kind 'single))))
1005

1006
(defun package-tar-file-info ()
1007
  "Find package information for a tar file.
1008 1009 1010 1011
The return result is a `package-desc'."
  (cl-assert (derived-mode-p 'tar-mode))
  (let* ((dir-name (file-name-directory
                    (tar-header-name (car tar-parse-info))))
1012
         (desc-file (package--description-file dir-name))
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
         (tar-desc (tar-get-file-descriptor (concat dir-name desc-file))))
    (unless tar-desc
      (error "No package descriptor file found"))
    (with-current-buffer (tar--extract tar-desc)
      (goto-char (point-min))
      (unwind-protect
          (let* ((pkg-def-parsed (read (current-buffer)))
                 (pkg-desc
                  (if (not (eq (car pkg-def-parsed) 'define-package))
                      (error "Can't find define-package in %s"
                             (tar-header-name tar-desc))
                    (apply #'package-desc-from-define
                           (append (cdr pkg-def-parsed))))))
            (setf (package-desc-kind pkg-desc) 'tar)
            pkg-desc)
        (kill-buffer (current-buffer))))))
1029

1030

1031
;;;###autoload
1032
(defun package-install-from-buffer ()
1033
  "Install a package from the current buffer.
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
The current buffer is assumed to be a single .el or .tar file that follows the
packaging guidelines; see info node `(elisp)Packaging'.
Downloads and installs required packages as needed."
  (interactive)
  (let ((pkg-desc (if (derived-mode-p 'tar-mode)
                      (package-tar-file-info)
                    (package-buffer-info))))
    ;; Download and install the dependencies.
    (let* ((requires (package-desc-reqs pkg-desc))
           (transaction (package-compute-transaction nil requires)))
      (package-download-transaction transaction))
    ;; Install the package itself.
    (package-unpack pkg-desc)
    pkg-desc))
1048 1049 1050 1051 1052 1053 1054 1055

;;;###autoload
(defun package-install-file (file)
  "Install a package from a file.
The file can either be a tar file or an Emacs Lisp file."
  (interactive "fPackage file name: ")
  (with-temp-buffer
    (insert-file-contents-literally file)
1056 1057
    (when (string-match "\\.tar\\'" file) (tar-mode))
    (package-install-from-buffer)))
1058

1059 1060
(defun package-delete (pkg-desc)
  (let ((dir (package-desc-dir pkg-desc)))
1061 1062 1063 1064 1065
    (if (string-equal (file-name-directory dir)
		      (file-name-as-directory
		       (expand-file-name package-user-dir)))
	(progn
	  (delete-directory dir t t)
1066
	  (message "Package `%s' deleted." (package-desc-full-name pkg-desc)))
1067
      ;; Don't delete "system" packages
1068 1069
      (error "Package `%s' is a system package, not deleting"
	     (package-desc-full-name pkg-desc)))))
1070

1071
(defun package-archive-base (desc)
1072
  "Return the archive containing the package NAME."
1073
  (cdr (assoc (package-desc-archive desc) package-archives)))
1074 1075

(defun package--download-one-archive (archive file)
1076 1077 1078 1079
  "Retrieve an archive file FILE from ARCHIVE, and cache it.
ARCHIVE should be a cons cell of the form (NAME . LOCATION),
similar to an entry in `package-alist'.  Save the cached copy to
\"archives/NAME/archive-contents\" in `package-user-dir'."
1080 1081
  (let* ((dir (expand-file-name (format "archives/%s" (car archive))
                                package-user-dir)))
1082
    (package--with-work-buffer (cdr archive) file
1083 1084 1085 1086 1087 1088
      ;; Read the retrieved buffer to make sure it is valid (e.g. it
      ;; may fetch a URL redirect page).
      (when (listp (read buffer))
	(make-directory dir t)
	(setq buffer-file-name (expand-file-name file dir))
	(let ((version-control 'never))
1089
	  (save-buffer))))))
1090

1091
;;;###autoload
1092 1093
(defun package-refresh-contents ()
  "Download the ELPA archive description if needed.
1094 1095
This informs Emacs about the latest versions of all packages, and
makes them available for download."
1096 1097 1098
  (interactive)
  (unless (file-exists-p package-user-dir)
    (make-directory package-user-dir t))
1099
  (dolist (archive package-archives)
1100
    (condition-case-unless-debug nil
1101
	(package--download-one-archive archive "archive-contents")
1102
      (error (message "Failed to download `%s' archive."
1103
		      (car archive)))))
1104
  (package-read-all-archive-contents))
1105 1106

;;;###autoload
1107
(defun package-initialize (&optional no-activate)
1108
  "Load Emacs Lisp packages, and activate them.
1109 1110
The variable `package-load-list' controls which packages to load.
If optional arg NO-ACTIVATE is non-nil, don't activate packages."
1111
  (interactive)
1112
  (setq package-alist nil
1113
	package-obsolete-list nil)
1114
  (package-load-all-descriptors)
1115
  (package-read-all-archive-contents)
1116 1117
  (unless no-activate
    (dolist (elt package-alist)
1118
      (package-activate (car elt) (package-desc-version (cdr elt)))))
1119
  (setq package--initialized t))
1120 1121


1122
;;;; Package description buffer.
1123

1124 1125 1126 1127
;;;###autoload
(defun describe-package (package)
  "Display the full documentation of PACKAGE (a symbol)."
  (interactive
1128 1129
   (let* ((guess (function-called-at-point))
	  packages val)
1130 1131 1132 1133
     (require 'finder-inf nil t)
     ;; Load the package list if necessary (but don't activate them).
     (unless package--initialized
       (package-initialize t))
1134
     (setq packages (append (mapcar 'car package-alist)
1135 1136
			    (mapcar 'car package-archive-contents)
			    (mapcar 'car package--builtins)))
1137 1138 1139 1140 1141 1142 1143 1144 1145
     (unless (memq guess packages)
       (setq guess nil))
     (setq packages (mapcar 'symbol-name packages))
     (setq val
	   (completing-read (if guess
				(format "Describe package (default %s): "
					guess)
			      "Describe package: ")
			    packages nil t nil nil guess))
1146
     (list (if (equal val "") guess (intern val)))))
1147
  (if (not (and package (symbolp package)))
1148
      (message "No package specified")
1149 1150 1151 1152 1153 1154 1155
    (help-setup-xref (list #'describe-package package)
		     (called-interactively-p 'interactive))
    (with-help-window (help-buffer)
      (with-current-buffer standard-output
	(describe-package-1 package)))))

(defun describe-package-1 (package)
1156
  (require 'lisp-mnt)
1157 1158
  (let ((package-name (symbol-name package))
	(built-in (assq package package--builtins))
1159
	desc pkg-dir reqs version installable archive)
1160 1161
    (prin1 package)
    (princ " is ")
1162 1163 1164
    (cond
     ;; Loaded packages are in `package-alist'.
     ((setq desc (cdr (assq package package-alist)))
1165
      (setq version (package-version-join (package-desc-version desc)))
1166
      (if (setq pkg-dir (package-desc-dir desc))
1167 1168 1169 1170 1171
	  (insert "an installed package.\n\n")
	;; This normally does not happen.
	(insert "a deleted package.\n\n")))
     ;; Available packages are in `package-archive-contents'.
     ((setq desc (cdr (assq package package-archive-contents)))
1172 1173
      (setq version (package-version-join (package-desc-version desc))
	    archive (package-desc-archive desc)
Chong Yidong's avatar
Chong Yidong committed
1174
	    installable t)