package.el 66.6 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
(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.
195
If VERSION is t, the most recent version is activated.
196 197 198 199 200
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)
201
  :risky t
202 203 204 205 206 207 208 209
  :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))
210
(defvar url-http-end-of-headers)
211

212 213 214
(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.
215 216 217 218 219 220

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.
221 222 223 224
  (Other types of URL are currently not supported.)

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

231 232 233 234 235
(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.
236
 ID is an archive name. This should correspond to an
237 238 239 240 241 242 243 244 245 246 247
 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")

248 249 250 251 252 253 254
(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.")

;; 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.
255
This is an alist mapping package names (symbols) to
256
`package-desc' structures.")
257
(put 'package-archive-contents 'risky-local-variable t)
258 259 260 261 262 263 264

(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
265
  :risky t
266 267 268 269 270 271 272
  :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)
273 274 275
      (and (stringp f)
	   (equal (file-name-nondirectory f) "site-lisp")
	   (push (expand-file-name "elpa" f) result)))
276 277 278 279 280 281 282
    (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)
283
  :risky t
284 285 286
  :group 'package
  :version "24.1")

287 288 289 290 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
(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
327 328 329
package came.

`dir' The directory where the package is installed (if installed)."
330 331 332 333 334
  name
  version
  (summary package--default-summary)
  reqs
  kind
335 336 337 338
  archive
  dir)

;; Pseudo fields.
339
(defun package-desc-full-name (pkg-desc)
340 341 342
  (format "%s-%s"
          (package-desc-name pkg-desc)
          (package-version-join (package-desc-version pkg-desc))))
343

344 345 346 347 348 349
(defun package-desc-suffix (pkg-desc)
  (pcase (package-desc-kind pkg-desc)
    (`single ".el")
    (`tar ".tar")
    (kind (error "Unknown package kind: %s" kind))))

350 351 352 353 354 355 356 357
;; 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)

358 359
(defvar package--builtins nil
  "Alist of built-in packages.
360 361 362 363
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'.

364 365
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.")
366
(put 'package--builtins 'risky-local-variable t)
367

368
(defvar package-alist nil
369
  "Alist of all packages available for activation.
370 371 372
Each element has the form (PKG . DESCS), where PKG is a package
name (a symbol) and DESCS is a non-empty list of `package-desc' structure,
sorted by decreasing versions.
373 374 375 376

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'.")
377
(put 'package-alist 'risky-local-variable t)
378

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

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
(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)))))
412

413 414 415 416 417 418 419 420
(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))
421 422
        (let ((pkg-desc (package-process-define-package
                         (read (current-buffer)) pkg-file)))
423 424
          (setf (package-desc-dir pkg-desc) pkg-dir)
          pkg-desc)))))
425 426 427 428 429 430 431 432 433

(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
434
updates `package-alist'."
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
  (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'")))))
456

457 458
(defun package-activate-1 (pkg-desc)
  (let* ((name (package-desc-name pkg-desc))
459
	 (pkg-dir (package-desc-dir pkg-desc)))
460
    (unless pkg-dir
461 462
      (error "Internal error: unable to find directory for `%s'"
	     (package-desc-full-name pkg-desc)))
463
    ;; Add info node.
464 465 466 467 468
    (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))
469
    ;; Add to load path, add autoloads, and activate the package.
470
    (push pkg-dir load-path)
471 472
    (load (expand-file-name (format "%s-autoloads" name) pkg-dir) nil t)
    (push name package-activated-list)
473 474 475
    ;; Don't return nil.
    t))

Chong Yidong's avatar
Chong Yidong committed
476 477 478 479
(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."
480 481 482 483 484 485 486
  (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)))))
487 488 489 490 491

(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)))
492

493 494 495 496
;; 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.
497 498 499 500
(defun package-activate (package &optional force)
  "Activate package PACKAGE.
If FORCE is true, (re-)activate it if it's already activated."
  (let ((pkg-descs (cdr (assq package package-alist))))
501
    ;; Check if PACKAGE is available in `package-alist'.
502 503 504 505 506 507 508
    (while
        (when pkg-descs
          (let ((available-version (package-desc-version (car pkg-descs))))
            (or (package-disabled-p package available-version)
                ;; Prefer a builtin package.
                (package-built-in-p package available-version))))
      (setq pkg-descs (cdr pkg-descs)))
509 510
    (cond
     ;; If no such package is found, maybe it's built-in.
511 512
     ((null pkg-descs)
      (package-built-in-p package))
513
     ;; If the package is already activated, just return t.
514
     ((and (memq package package-activated-list) (not force))
515 516 517
      t)
     ;; Otherwise, proceed with activation.
     (t
518 519 520 521 522 523
      (let* ((pkg-vec (car pkg-descs))
             (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))))))
524 525
	(if fail
	    (warn "Unable to activate package `%s'.
526
Required package `%s-%s' is unavailable"
527 528
		  package (car fail) (package-version-join (cadr fail)))
	  ;; If all goes well, activate the package itself.
529
	  (package-activate-1 pkg-vec)))))))
530

531 532 533
(defun define-package (_name-string _version-string
                                    &optional _docstring _requirements
                                    &rest _extra-properties)
534
  "Define a new package.
535
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
536
VERSION-STRING is the version of the package, as a string.
537 538
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
539 540
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
541 542

EXTRA-PROPERTIES is currently unused."
543 544 545 546 547 548 549 550 551
  ;; 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))
552 553 554 555 556
         (old-pkgs (assq name package-alist)))
    (if (null old-pkgs)
        ;; If there's no old package, just add this to `package-alist'.
        (push (list name new-pkg-desc) package-alist)
      ;; If there is, insert the new package at the right place in the list.
557 558 559 560 561 562 563
      (while
          (if (and (cdr old-pkgs)
                   (version-list-< version
                                   (package-desc-version (cadr old-pkgs))))
              (setq old-pkgs (cdr old-pkgs))
            (push new-pkg-desc (cdr old-pkgs))
            nil)))
564
    new-pkg-desc))
565

566
;; From Emacs 22, but changed so it adds to load-path.
567 568 569 570 571 572 573
(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"
574 575
	     ";;; Code:\n"
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
576 577 578 579 580 581 582 583 584 585 586
	     "\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
587
  (require 'autoload)         ;Load before we let-bind generated-autoload-file!
588
  (let* ((auto-name (format "%s-autoloads.el" name))
589
	 ;;(ignore-name (concat name "-pkg.el"))
590 591
	 (generated-autoload-file (expand-file-name auto-name pkg-dir))
	 (version-control 'never))
592
    (package-autoload-ensure-default-file generated-autoload-file)
593 594
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
595 596
      (when buf (kill-buffer buf)))
    auto-name))
597

598 599
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
600 601
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
602 603

(defun package-untar-buffer (dir)
604
  "Untar the current buffer.
605 606
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
607
  (require 'tar-mode)
608 609
  (tar-mode)
  ;; Make sure everything extracts into DIR.
610 611
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
	(case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
612
    (dolist (tar-data tar-parse-info)
613 614 615 616 617 618 619
      (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)))))
620
  (tar-untar-buffer))
621

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
(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))
653
	 (pkg-dir (expand-file-name dirname package-user-dir)))
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
    (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.
674
    (package-activate name 'force)
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
    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))
690

691
(defun package--write-file-no-coding (file-name)
692
  (let ((buffer-file-coding-system 'no-conversion))
693
    (write-region (point-min) (point-max) file-name)))
694

695 696 697 698 699 700 701 702 703
(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."
704
  (declare (indent 2) (debug t))
705
  `(let* ((http (string-match "\\`https?:" ,location))
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
	  (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))))

724
(defun package-handle-response ()
725
  "Handle the response from a `url-retrieve-synchronously' call.
726 727 728 729 730 731 732 733 734
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"
735
	     (buffer-substring-no-properties (point) (line-end-position))))))
736

737
(defun package-install-from-archive (pkg-desc)
738
  "Download and install a tar package."
739 740 741
  (let ((location (package-archive-base pkg-desc))
	(file (concat (package-desc-full-name pkg-desc)
                      (package-desc-suffix pkg-desc))))
742
    (package--with-work-buffer location file
743
      (package-unpack pkg-desc))))
744

745 746
(defvar package--initialized nil)

747
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
748 749
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
MIN-VERSION should be a version list."
750
  (unless package--initialized (error "package.el is not yet initialized!"))
751 752 753 754 755 756 757
    (or
     (let ((pkg-descs (cdr (assq package package-alist))))
       (and pkg-descs
            (version-list-<= min-version
                             (package-desc-version (car pkg-descs)))))
     ;; Also check built-in packages.
     (package-built-in-p package min-version)))
758

759 760 761 762 763
(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
764 765 766
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.
767 768 769 770 771

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."
772 773 774 775 776 777
  (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'.
778
	(let ((pkg-desc (cdr (assq next-pkg package-archive-contents)))
779
              ;; FIXME: package-disabled-p needs to use a <= test!
780 781 782 783
	      (disabled (package-disabled-p next-pkg next-version)))
          (when disabled
            (if (stringp disabled)
                (error "Package `%s' held at version %s, \
784
but version %s required"
785 786 787 788
                       (symbol-name next-pkg) disabled
                       (package-version-join next-version))
              (error "Required package '%s' is disabled"
                     (symbol-name next-pkg))))
789
	  (unless pkg-desc
790
	    (error "Package `%s-%s' is unavailable"
791 792
		   (symbol-name next-pkg)
		   (package-version-join next-version)))
793
	  (unless (version-list-<= next-version
794
				   (package-desc-version pkg-desc))
795
	    (error
796
	     "Need package `%s-%s', but only %s is available"
797
	     (symbol-name next-pkg) (package-version-join next-version)
798
	     (package-version-join (package-desc-version pkg-desc))))
799 800
          ;; Move to front, so it gets installed early enough (bug#14082).
          (setq package-list (cons next-pkg (delq next-pkg package-list)))
801 802
	  (setq package-list
		(package-compute-transaction package-list
803
					     (package-desc-reqs
804
					      pkg-desc)))))))
805
  package-list)
806 807 808 809 810

(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))
811 812 813 814 815 816 817
	 (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))))
818 819 820 821 822 823 824 825 826
    (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)))
827 828 829 830 831 832 833 834
    (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))))))
835

836
(defun package-read-all-archive-contents ()
837 838
  "Re-read `archive-contents', if it exists.
If successful, set `package-archive-contents'."
839
  (setq package-archive-contents nil)
840
  (dolist (archive package-archives)
841
    (package-read-archive-contents (car archive))))
842

843
(defun package-read-archive-contents (archive)
844 845
  "Re-read archive contents for ARCHIVE.
If successful, set the variable `package-archive-contents'.
846
If the archive version is too new, signal an error."
847 848
  ;; Version 1 of 'archive-contents' is identical to our internal
  ;; representation.
849 850 851
  (let* ((contents-file (format "archives/%s/archive-contents" archive))
	 (contents (package--read-archive-file contents-file)))
    (when contents
852 853
      (dolist (package contents)
	(package--add-to-archive-contents package archive)))))
854

855 856 857 858 859 860 861 862 863
;; 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)

864 865
(defun package--add-to-archive-contents (package archive)
  "Add the PACKAGE from the given ARCHIVE if necessary.
866 867 868
PACKAGE should have the form (NAME . PACKAGE--AC-DESC).
Also, add the originating archive to the `package-desc' structure."
  (let* ((name (car package))
869
         (version (package--ac-desc-version (cdr package)))
870 871 872
         (pkg-desc
          (package-desc-create
           :name name
873
           :version version
874 875 876 877 878
           :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))
879 880
         (existing-package (assq name package-archive-contents))
         (pinned-to-archive (assoc name package-pinned-packages)))
881 882 883 884 885 886 887 888
    (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))))
889 890
            (and ins (version-list-<= version
                                      (package-desc-version (car ins))))))
891 892 893 894 895 896 897 898 899 900
      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)))))))
901

902 903 904 905 906 907
(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'."
908
  ;; FIXME: make package-list a list of pkg-desc.
909
  (dolist (elt package-list)
910 911
    (let ((desc (cdr (assq elt package-archive-contents))))
      (package-install-from-archive desc))))
912 913

;;;###autoload
914 915 916 917
(defun package-install (pkg)
  "Install the package PKG.
PKG can be a package-desc or the package name of one the available packages
in an archive in `package-archives'.  Interactively, prompt for its name."
918
  (interactive
919 920 921 922 923
   (progn
     ;; Initialize the package system to get the list of package
     ;; symbols for completion.
     (unless package--initialized
       (package-initialize t))
924 925
     (unless package-archive-contents
       (package-refresh-contents))
926
     (list (intern (completing-read
927 928 929 930 931
                           "Install package: "
                           (mapcar (lambda (elt)
                                     (cons (symbol-name (car elt))
                                           nil))
                                   package-archive-contents)
932 933 934 935
                    nil t)))))
  (let ((pkg-desc
         (if (package-desc-p pkg) pkg
           (cdr (assq pkg package-archive-contents)))))
936
       (unless pkg-desc
937
      (error "Package `%s' is not available for installation" pkg))
938 939 940
  (package-download-transaction
   ;; FIXME: Use (list pkg-desc) instead of just the name.
   (package-compute-transaction (list (package-desc-name pkg-desc))
941
                                  (package-desc-reqs pkg-desc)))))
942

943 944
(defun package-strip-rcs-id (str)
  "Strip RCS version ID from the version string STR.
945 946
If the result looks like a dotted numeric version, return it.
Otherwise return nil."
947 948 949 950 951 952 953
  (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))))
954 955

(defun package-buffer-info ()
956
  "Return a `package-desc' describing the package in the current buffer.
957 958 959 960

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."
961
  (goto-char (point-min))
962
  (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
    (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"))
979
		(package-strip-rcs-id (lm-header "version")))))
980 981 982
      (unless pkg-version
	(error
	 "Package lacks a \"Version\" or \"Package-Version\" header"))
983 984 985 986
      (package-desc-from-define
       file-name pkg-version desc
       (if requires-str (package-read-from-string requires-str))
       :kind 'single))))
987

988 989 990
(declare-function tar-get-file-descriptor "tar-mode" (file))
(declare-function tar--extract "tar-mode" (descriptor))

991
(defun package-tar-file-info ()
992
  "Find package information for a tar file.
993 994 995 996
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))))
997
         (desc-file (package--description-file dir-name))
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
         (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))))))
1014

1015

1016
;;;###autoload
1017
(defun package-install-from-buffer ()
1018
  "Install a package from the current buffer.
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
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))
1033 1034 1035 1036 1037 1038 1039 1040

;;;###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)
1041 1042
    (when (string-match "\\.tar\\'" file) (tar-mode))
    (package-install-from-buffer)))
1043

1044 1045
(defun package-delete (pkg-desc)
  (let ((dir (package-desc-dir pkg-desc)))
1046 1047 1048 1049 1050
    (if (string-equal (file-name-directory dir)
		      (file-name-as-directory
		       (expand-file-name package-user-dir)))
	(progn
	  (delete-directory dir t t)
1051
	  (message "Package `%s' deleted." (package-desc-full-name pkg-desc)))
1052
      ;; Don't delete "system" packages
1053 1054
      (error "Package `%s' is a system package, not deleting"
	     (package-desc-full-name pkg-desc)))))
1055

1056
(defun package-archive-base (desc)
1057
  "Return the archive containing the package NAME."
1058
  (cdr (assoc (package-desc-archive desc) package-archives)))
1059 1060

(defun package--download-one-archive (archive file)
1061 1062 1063 1064
  "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'."
1065 1066
  (let* ((dir (expand-file-name (format "archives/%s" (car archive))
                                package-user-dir)))
1067
    (package--with-work-buffer (cdr archive) file
1068 1069 1070 1071 1072 1073
      ;; 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))
1074
	  (save-buffer))))))
1075

1076
;;;###autoload
1077 1078
(defun package-refresh-contents ()
  "Download the ELPA archive description if needed.
1079 1080
This informs Emacs about the latest versions of all packages, and
makes them available for download."
1081
  (interactive)
1082
  ;; FIXME: Do it asynchronously.
1083 1084
  (unless (file-exists-p package-user-dir)
    (make-directory package-user-dir t))
1085
  (dolist (archive package-archives)
1086
    (condition-case-unless-debug nil
1087
	(package--download-one-archive archive "archive-contents")
1088
      (error (message "Failed to download `%s' archive."
1089
		      (car archive)))))
1090
  (package-read-all-archive-contents))
1091 1092

;;;###autoload
1093
(defun package-initialize (&optional no-activate)
1094
  "Load Emacs Lisp packages, and activate them.
1095 1096
The variable `package-load-list' controls which packages to load.
If optional arg NO-ACTIVATE is non-nil, don't activate packages."
1097
  (interactive)
1098
  (setq package-alist nil)
1099
  (package-load-all-descriptors)
1100
  (package-read-all-archive-contents)
1101 1102
  (unless no-activate
    (dolist (elt package-alist)
1103
      (package-activate (car elt))))
1104
  (setq package--initialized t))
1105 1106


1107
;;;; Package description buffer.
1108

1109 1110 1111 1112
;;;###autoload
(defun describe-package (package)
  "Display the full documentation of PACKAGE (a symbol)."
  (interactive
1113 1114
   (let* ((guess (function-called-at-point))
	  packages val)
1115 1116 1117 1118
     (require 'finder-inf nil t)
     ;; Load the package list if necessary (but don't activate them).
     (unless package--initialized
       (package-initialize t))
1119
     (setq packages (append (mapcar 'car package-alist)
1120 1121
			    (mapcar 'car package-archive-contents)
			    (mapcar 'car package--builtins)))
1122 1123 1124 1125 1126 1127 1128 1129 1130
     (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))
1131
     (list (if (equal val "") guess (intern val)))))
1132
  (if (not (and package (symbolp package)))
1133
      (message "No package specified")
1134 1135 1136 1137 1138 1139 1140
    (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)
1141
  (require 'lisp-mnt)
1142 1143
  (let ((package-name (symbol-name package))
	(built-in (assq package package--builtins))
1144
	desc pkg-dir reqs version installable archive)
1145 1146
    (prin1 package)
    (princ " is ")
1147 1148
    (cond
     ;; Loaded packages are in `package-alist'.
1149
     ((setq desc (cadr (assq package package-alist)))
1150
      (setq version (package-version-join (package-desc-version desc)))
1151
      (if (setq pkg-dir (package-desc-dir desc))
1152 1153 1154 1155 1156
	  (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)))
1157 1158
      (setq version (package-version-join (package-desc-version desc))
	    archive (package-desc-archive desc)
Chong Yidong's avatar
Chong Yidong committed
1159
	    installable t)
1160 1161 1162 1163
      (if built-in
	  (insert "a built-in package.\n\n")
	(insert "an uninstalled package.\n\n")))
     (built-in
1164 1165
      (setq desc (package--from-builtin built-in)
	    version (package-version-join (package-desc-version desc)))
1166 1167 1168
      (insert "a built-in package.\n\n"))
     (t
      (insert "an orphan package.\n\n")))
1169

1170
    (insert "     " (propertize "Status" 'font-lock-face 'bold) ": ")
1171
    (cond (pkg-dir
1172 1173
	   (insert (propertize "Installed"
			       'font-lock-face 'font-lock-comment-face))
1174 1175