package.el 111 KB
Newer Older
1
;;; package.el --- Simple package system for Emacs  -*- lexical-binding:t -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2007-2015 Free Software Foundation, Inc.
4 5

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

;; This file is part of GNU Emacs.

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

;; 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
25
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
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 54

;;; 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.

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

58 59 60 61
;; 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.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

;; 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:
;;
80
;; M-x list-packages
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 115 116 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
;;    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:

;; - 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:

164
(eval-when-compile (require 'subr-x))
165
(eval-when-compile (require 'cl-lib))
166
(eval-when-compile (require 'epg))      ;For setf accessors.
167

168
(require 'tabulated-list)
169
(require 'macroexp)
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 196
(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.
197
If VERSION is t, the most recent version is activated.
198 199 200 201 202
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)
203
  :risky t
204 205 206 207 208
  :group 'package
  :version "24.1")

(defvar Info-directory-list)
(declare-function info-initialize "info" ())
209
(declare-function url-http-file-exists-p "url-http" (url))
210 211 212
(declare-function lm-header "lisp-mnt" (header))
(declare-function lm-commentary "lisp-mnt" (&optional file))

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
(defcustom package-archive-priorities nil
  "An alist of priorities for packages.

Each element has the form (ARCHIVE-ID . PRIORITY).

When installing packages, the package with the highest version
number from the archive with the highest priority is
selected. When higher versions are available from archives with
lower priorities, the user has to select those manually.

Archives not in this list have the priority 0."
Jorgen Schaefer's avatar
Jorgen Schaefer committed
243 244
  :type '(alist :key-type (string :tag "Archive name")
                :value-type (integer :tag "Priority (default is 0)"))
245 246 247 248
  :risky t
  :group 'package
  :version "25.1")

249
(defcustom package-pinned-packages nil
250 251 252 253 254 255 256 257 258 259 260 261 262
  "An alist of packages that are pinned to specific archives.
This can be useful if you have multiple package archives enabled,
and want to control which archive a given package gets installed from.

Each element of the alist has the form (PACKAGE . ARCHIVE), where:
 PACKAGE is a symbol representing a package
 ARCHIVE is a string representing an archive (it should be the car of
an element in `package-archives', e.g. \"gnu\").

Adding an entry to this variable means that only ARCHIVE will be
considered as a source for PACKAGE.  If other archives provide PACKAGE,
they are ignored (for this package).  If ARCHIVE does not contain PACKAGE,
the package will be unavailable."
263 264
  :type '(alist :key-type (symbol :tag "Package")
                :value-type (string :tag "Archive name"))
265 266 267 268
  ;; I don't really see why this is risky...
  ;; I suppose it could prevent you receiving updates for a package,
  ;; via an entry (PACKAGE . NON-EXISTING).  Which could be an issue
  ;; if PACKAGE has a known vulnerability that is fixed in newer versions.
269 270 271 272
  :risky t
  :group 'package
  :version "24.4")

273 274 275 276 277 278 279
(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.
280
This is an alist mapping package names (symbols) to
281
non-empty lists of `package-desc' structures.")
282
(put 'package-archive-contents 'risky-local-variable t)
283 284 285 286 287 288 289

(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
290
  :risky t
291 292 293 294 295 296 297
  :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)
298
      (and (stringp f)
299 300
           (equal (file-name-nondirectory f) "site-lisp")
           (push (expand-file-name "elpa" f) result)))
301 302 303 304 305 306 307
    (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)
308
  :risky t
309 310 311
  :group 'package
  :version "24.1")

Stefan Monnier's avatar
Stefan Monnier committed
312 313
(defvar epg-gpg-program)

314 315 316
(defcustom package-check-signature
  (if (progn (require 'epg-config) (executable-find epg-gpg-program))
      'allow-unsigned)
317 318 319 320 321 322
  "Non-nil means to check package signatures when installing.
The value `allow-unsigned' means to still install a package even if
it is unsigned.

This also applies to the \"archive-contents\" file that lists the
contents of the archive."
323
  :type '(choice (const nil :tag "Never")
324 325
                 (const allow-unsigned :tag "Allow unsigned")
                 (const t :tag "Check always"))
326 327
  :risky t
  :group 'package
328
  :version "24.4")
329 330

(defcustom package-unsigned-archives nil
331
  "List of archives where we do not check for package signatures."
332 333 334
  :type '(repeat (string :tag "Archive name"))
  :risky t
  :group 'package
335
  :version "24.4")
336

337 338 339 340 341 342 343
(defcustom package-selected-packages nil
  "Store here packages installed explicitely by user.
This variable will be feeded automatically by emacs,
when installing a new package.
This variable will be used by `package-autoremove' to decide
which packages are no more needed.
You can use it to (re)install packages on other machines
344 345 346 347 348
by running `package-user-selected-packages-install'.

To check if a package is contained in this list here, use
`package--user-selected-p', as it may populate the variable with
a sane initial value."
349
  :group 'package
350
  :type '(repeat symbol))
351

352 353 354 355 356 357 358 359 360 361 362
(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
363
                 &rest rest-plist
364 365 366 367 368 369 370 371
                 &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)
372 373 374 375 376
                                 requirements)))
                 (kind (plist-get rest-plist :kind))
                 (archive (plist-get rest-plist :archive))
                 (extras (let (alist)
                           (while rest-plist
377 378 379
                             (unless (memq (car rest-plist) '(:kind :archive))
                               (let ((value (cadr rest-plist)))
                                 (when value
380 381
                                   (push (cons (car rest-plist)
                                               (if (eq (car-safe value) 'quote)
Dmitry Gutov's avatar
Dmitry Gutov committed
382
                                                   (cadr value)
383
                                                 value))
384
                                         alist))))
385 386
                             (setq rest-plist (cddr rest-plist)))
                           alist)))))
387 388 389
  "Structure containing information about an individual package.
Slots:

390
`name'	Name of the package, as a symbol.
391 392 393 394

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

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

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

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

`archive' The name of the archive (as a string) whence this
405
        package came.
406

407
`dir'	The directory where the package is installed (if installed),
408
        `builtin' if it is built-in, or nil otherwise.
409

410 411 412
`extras' Optional alist of additional keyword-value pairs.

`signed' Flag to indicate that the package is signed by provider."
413 414 415 416 417
  name
  version
  (summary package--default-summary)
  reqs
  kind
418
  archive
419
  dir
420 421
  extras
  signed)
422 423

;; Pseudo fields.
424
(defun package-desc-full-name (pkg-desc)
425 426 427
  (format "%s-%s"
          (package-desc-name pkg-desc)
          (package-version-join (package-desc-version pkg-desc))))
428

429 430 431 432
(defun package-desc-suffix (pkg-desc)
  (pcase (package-desc-kind pkg-desc)
    (`single ".el")
    (`tar ".tar")
433
    (`dir "")
434 435
    (kind (error "Unknown package kind: %s" kind))))

436 437
(defun package-desc--keywords (pkg-desc)
  (let ((keywords (cdr (assoc :keywords (package-desc-extras pkg-desc)))))
438
    (if (eq (car-safe keywords) 'quote)
439
        (nth 1 keywords)
440 441
      keywords)))

442 443 444 445 446 447 448 449
;; 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)

450 451
(defvar package--builtins nil
  "Alist of built-in packages.
452 453 454 455
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'.

456 457
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.")
458
(put 'package--builtins 'risky-local-variable t)
459

460
(defvar package-alist nil
461
  "Alist of all packages available for activation.
462 463 464
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.
465 466 467 468

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

471 472 473 474 475 476 477 478 479 480 481 482 483
(defvar package--compatibility-table nil
  "Hash table connecting package names to their compatibility.
Each key is a symbol, the name of a package.

The value is either nil, representing an incompatible package, or
a version list, representing the highest compatible version of
that package which is available.

A package is considered incompatible if it requires an Emacs
version higher than the one being used.  To check for package
\(in)compatibility, don't read this table directly, use
`package--incompatible-p' which also checks dependencies.")

484
(defvar package-activated-list nil
485
  ;; FIXME: This should implicitly include all builtin packages.
486
  "List of the names of currently activated packages.")
487
(put 'package-activated-list 'risky-local-variable t)
488

489 490 491 492 493 494 495 496 497
(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))
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
        (cond
         ((>= num 0)
          (push (int-to-string num) str-list)
          (push "." str-list))
         ((< num -4)
          (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")
513
                      ((= num -4) "snapshot"))
514
                str-list))))
515
      (if (equal "." (car str-list))
516
          (pop str-list))
517
      (apply 'concat (nreverse str-list)))))
518

519 520 521
(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)
522
                                    pkg-dir))
523
        (signed-file (concat pkg-dir ".signed")))
524 525 526 527
    (when (file-exists-p pkg-file)
      (with-temp-buffer
        (insert-file-contents pkg-file)
        (goto-char (point-min))
528 529
        (let ((pkg-desc (package-process-define-package
                         (read (current-buffer)) pkg-file)))
530
          (setf (package-desc-dir pkg-desc) pkg-dir)
531 532
          (if (file-exists-p signed-file)
              (setf (package-desc-signed pkg-desc) t))
533
          pkg-desc)))))
534 535 536 537 538 539 540 541 542

(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
543
updates `package-alist'."
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
  (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'")))))
565

566 567 568 569 570
(defun package-activate-1 (pkg-desc &optional reload)
  "Activate package given by PKG-DESC, even if it was already active.
If RELOAD is non-nil, also `load' any files inside the package which
correspond to previously loaded files (those returned by
`package--list-loaded-files')."
571
  (let* ((name (package-desc-name pkg-desc))
572
         (pkg-dir (package-desc-dir pkg-desc))
573
         (pkg-dir-dir (file-name-as-directory pkg-dir)))
574
    (unless pkg-dir
575
      (error "Internal error: unable to find directory for `%s'"
576
             (package-desc-full-name pkg-desc)))
577
    ;; Add to load path, add autoloads, and activate the package.
578 579 580
    (let* ((old-lp load-path)
           (autoloads-file (expand-file-name
                            (format "%s-autoloads" name) pkg-dir))
581
           (loaded-files-list (and reload (package--list-loaded-files pkg-dir))))
582
      (with-demoted-errors "Error in package-activate-1: %s"
583
        (load autoloads-file nil t))
584 585 586 587 588
      (when (and (eq old-lp load-path)
                 (not (or (member pkg-dir load-path)
                          (member pkg-dir-dir load-path))))
        ;; Old packages don't add themselves to the `load-path', so we have to
        ;; do it ourselves.
589 590 591 592 593 594
        (push pkg-dir load-path))
      ;; Call `load' on all files in `pkg-dir' already present in
      ;; `load-history'.  This is done so that macros in these files are updated
      ;; to their new definitions.  If another package is being installed which
      ;; depends on this new definition, not doing this update would cause
      ;; compilation errors and break the installation.
595
      (with-demoted-errors "Error in package-activate-1: %s"
596
        (mapc (lambda (feature) (load feature nil t))
597 598
              ;; Skip autoloads file since we already evaluated it above.
              (remove (file-truename autoloads-file) loaded-files-list))))
599
    ;; Add info node.
600 601 602 603 604
    (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))
605
    (push name package-activated-list)
606 607 608
    ;; Don't return nil.
    t))

Sam Steingold's avatar
Sam Steingold committed
609
(declare-function find-library-name "find-func" (library))
610 611 612 613
(defun package--list-loaded-files (dir)
  "Recursively list all files in DIR which correspond to loaded features.
Returns the `file-name-sans-extension' of each file, relative to
DIR, sorted by most recently loaded last."
614 615 616 617 618
  (let* ((history (delq nil
                        (mapcar (lambda (x)
                                  (let ((f (car x)))
                                    (and f (file-name-sans-extension f))))
                                load-history)))
619 620 621
         (dir (file-truename dir))
         ;; List all files that have already been loaded.
         (list-of-conflicts
622
          (delq
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
           nil
           (mapcar
               (lambda (x) (let* ((file (file-relative-name x dir))
                             ;; Previously loaded file, if any.
                             (previous
                              (ignore-errors
                                (file-name-sans-extension
                                 (file-truename (find-library-name file)))))
                             (pos (when previous (member previous history))))
                        ;; Return (RELATIVE-FILENAME . HISTORY-POSITION)
                        (when pos
                          (cons (file-name-sans-extension file) (length pos)))))
             (directory-files-recursively dir "\\`[^\\.].*\\.el\\'")))))
    ;; Turn the list of (FILENAME . POS) back into a list of features.  Files in
    ;; subdirectories are returned relative to DIR (so not actually features).
    (let ((default-directory (file-name-as-directory dir)))
      (mapcar (lambda (x) (file-truename (car x)))
        (sort list-of-conflicts
              ;; Sort the files by ascending HISTORY-POSITION.
              (lambda (x y) (< (cdr x) (cdr y))))))))

Chong Yidong's avatar
Chong Yidong committed
644 645 646 647
(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."
648 649 650 651 652
  (if (package-desc-p package) ;; was built-in and then was converted
      (eq 'builtin (package-desc-dir package))
    (let ((bi (assq package package--builtin-versions)))
      (cond
       (bi (version-list-<= min-version (cdr bi)))
653
       ((remove 0 min-version) nil)
654 655 656
       (t
        (require 'finder-inf nil t) ; For `package--builtins'.
        (assq package package--builtins))))))
657 658 659 660

(defun package--from-builtin (bi-desc)
  (package-desc-create :name (pop bi-desc)
                       :version (package--bi-desc-version bi-desc)
661 662
                       :summary (package--bi-desc-summary bi-desc)
                       :dir 'builtin))
663

664 665 666 667
;; 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.
668 669 670 671
(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))))
672
    ;; Check if PACKAGE is available in `package-alist'.
673 674 675 676 677 678 679
    (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)))
680 681
    (cond
     ;; If no such package is found, maybe it's built-in.
682 683
     ((null pkg-descs)
      (package-built-in-p package))
684
     ;; If the package is already activated, just return t.
685
     ((and (memq package package-activated-list) (not force))
686 687 688
      t)
     ;; Otherwise, proceed with activation.
     (t
689 690 691 692
      (let* ((pkg-vec (car pkg-descs))
             (fail (catch 'dep-failure
                     ;; Activate its dependencies recursively.
                     (dolist (req (package-desc-reqs pkg-vec))
Dmitry Gutov's avatar
Dmitry Gutov committed
693
                       (unless (package-activate (car req))
694
                         (throw 'dep-failure req))))))
695 696
        (if fail
            (warn "Unable to activate package `%s'.
697
Required package `%s-%s' is unavailable"
698 699 700
                  package (car fail) (package-version-join (cadr fail)))
          ;; If all goes well, activate the package itself.
          (package-activate-1 pkg-vec force)))))))
701

702 703 704
(defun define-package (_name-string _version-string
                                    &optional _docstring _requirements
                                    &rest _extra-properties)
705
  "Define a new package.
706
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
707
VERSION-STRING is the version of the package, as a string.
708 709
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
710 711
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
712 713

EXTRA-PROPERTIES is currently unused."
714 715 716 717 718 719 720 721 722
  ;; 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))
723 724 725 726 727
         (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.
728 729 730 731 732 733 734
      (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)))
735
    new-pkg-desc))
736

737
;; From Emacs 22, but changed so it adds to load-path.
738 739 740 741 742
(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)
743 744 745
             " --- automatically extracted autoloads\n"
             ";;\n"
             ";;; Code:\n"
746
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
747 748 749 750 751 752 753
             "\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")
754
     nil file nil 'silent))
755 756
  file)

757 758 759
(defvar generated-autoload-file)
(defvar version-control)

760
(defun package-generate-autoloads (name pkg-dir)
761
  (let* ((auto-name (format "%s-autoloads.el" name))
762 763
         ;;(ignore-name (concat name "-pkg.el"))
         (generated-autoload-file (expand-file-name auto-name pkg-dir))
764
         (backup-inhibited t)
765
         (version-control 'never))
766
    (package-autoload-ensure-default-file generated-autoload-file)
767 768
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
769 770
      (when buf (kill-buffer buf)))
    auto-name))
771

772 773
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
774 775
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
776 777

(defun package-untar-buffer (dir)
778
  "Untar the current buffer.
779 780
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
781
  (require 'tar-mode)
782 783
  (tar-mode)
  ;; Make sure everything extracts into DIR.
784
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
785
        (case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
786
    (dolist (tar-data tar-parse-info)
787
      (let ((name (expand-file-name (tar-header-name tar-data))))
788 789 790 791 792 793
        (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)))))
794
  (tar-untar-buffer))
795

796
(defun package-generate-description-file (pkg-desc pkg-file)
797
  "Create the foo-pkg.el file for single-file packages."
798
  (let* ((name (package-desc-name pkg-desc)))
799 800 801 802 803
    (let ((print-level nil)
          (print-quoted t)
          (print-length nil))
      (write-region
       (concat
804
        ";;; -*- no-byte-compile: t -*-\n"
805
        (prin1-to-string
806 807 808 809 810 811 812 813 814 815 816 817 818
         (nconc
          (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))))
819
          (package--alist-to-plist-args
820
           (package-desc-extras pkg-desc))))
821
        "\n")
822
       nil pkg-file nil 'silent))))
823

824
(defun package--alist-to-plist-args (alist)
825
  (mapcar 'macroexp-quote
826 827
          (apply #'nconc
                 (mapcar (lambda (pair) (list (car pair) (cdr pair))) alist))))
828 829 830 831
(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))
832
         (pkg-dir (expand-file-name dirname package-user-dir)))
833
    (pcase (package-desc-kind pkg-desc)
834 835 836 837 838 839 840 841 842 843 844 845 846 847
      (`dir
       (make-directory pkg-dir t)
       (let ((file-list
              (directory-files
               default-directory 'full "\\`[^.].*\\.el\\'" 'nosort)))
         (dolist (source-file file-list)
           (let ((target-el-file
                  (expand-file-name (file-name-nondirectory source-file) pkg-dir)))
             (copy-file source-file target-el-file t)))
         ;; Now that the files have been installed, this package is
         ;; indistinguishable from a `tar' or a `single'. Let's make
         ;; things simple by ensuring we're one of them.
         (setf (package-desc-kind pkg-desc)
               (if (> (length file-list) 1) 'tar 'single))))
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
      (`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.
867
    (package-activate name 'force)
868 869 870 871 872
    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)
873 874
  (let ((desc-file (expand-file-name (package--description-file pkg-dir)
                                     pkg-dir)))
875
    (unless (file-exists-p desc-file)
876
      (package-generate-description-file pkg-desc desc-file)))
877 878 879 880 881 882 883
  ;; 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))
884

885
(defun package--write-file-no-coding (file-name)
886
  (let ((buffer-file-coding-system 'no-conversion))
887
    (write-region (point-min) (point-max) file-name nil 'silent)))
888

889 890 891 892 893 894 895 896 897
(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."
898
  (declare (indent 2) (debug t))
899 900
  `(with-temp-buffer
     (if (string-match-p "\\`https?:" ,location)
901
         (url-insert-file-contents (concat ,location ,file))
902
       (unless (file-name-absolute-p ,location)
903 904
         (error "Archive location %s is not an absolute file name"
                ,location))
905 906
       (insert-file-contents (expand-file-name ,file ,location)))
     ,@body))
907

908 909 910
(defun package--archive-file-exists-p (location file)
  (let ((http (string-match "\\`https?:" location)))
    (if http
911 912 913
        (progn
          (require 'url-http)
          (url-http-file-exists-p (concat location file)))
914 915 916
      (file-exists-p (expand-file-name file location)))))

(declare-function epg-make-context "epg"
917 918 919 920
                  (&optional protocol armor textmode include-certs
                             cipher-algorithm
                             digest-algorithm
                             compress-algorithm))
921
(declare-function epg-verify-string "epg" (context signature
922
                                                   &optional signed-text))
923 924 925 926
(declare-function epg-context-result-for "epg" (context name))
(declare-function epg-signature-status "epg" (signature))
(declare-function epg-signature-to-string "epg" (signature))

927 928 929 930
(defun package--display-verify-error (context sig-file)
  (unless (equal (epg-context-error-output context) "")
    (with-output-to-temp-buffer "*Error*"
      (with-current-buffer standard-output
931 932 933 934 935 936 937
        (if (epg-context-result-for context 'verify)
            (insert (format "Failed to verify signature %s:\n" sig-file)
                    (mapconcat #'epg-signature-to-string
                               (epg-context-result-for context 'verify)
                               "\n"))
          (insert (format "Error while verifying signature %s:\n" sig-file)))
        (insert "\nCommand output:\n" (epg-context-error-output context))))))
938

939 940 941
(defun package--check-signature (location file)
  "Check signature of the current buffer.
GnuPG keyring is located under \"gnupg\" in `package-user-dir'."
942 943 944 945
  (let* ((context (epg-make-context 'OpenPGP))
         (homedir (expand-file-name "gnupg" package-user-dir))
         (sig-file (concat file ".sig"))
         (sig-content (package--with-work-buffer location sig-file
946
                        (buffer-string))))
947
    (setf (epg-context-home-directory context) homedir)
948
    (condition-case error
949
        (epg-verify-string context sig-content (buffer-string))
950 951 952
      (error
       (package--display-verify-error context sig-file)
       (signal (car error) (cdr error))))
953 954 955 956
    (let (good-signatures had-fatal-error)
      ;; The .sig file may contain multiple signatures.  Success if one
      ;; of the signatures is good.
      (dolist (sig (epg-context-result-for context 'verify))
957 958 959 960 961 962 963 964 965
        (if (eq (epg-signature-status sig) 'good)
            (push sig good-signatures)
          ;; If package-check-signature is allow-unsigned, don't
          ;; signal error when we can't verify signature because of
          ;; missing public key.  Other errors are still treated as
          ;; fatal (bug#17625).
          (unless (and (eq package-check-signature 'allow-unsigned)
                       (eq (epg-signature-status sig) 'no-pubkey))
            (setq had-fatal-error t))))
966
      (when (and (null good-signatures) had-fatal-error)
967 968
        (package--display-verify-error context sig-file)
        (error "Failed to verify signature %s" sig-file))
969
      good-signatures)))
970

971
(defun package-install-from-archive (pkg-desc)
972
  "Download and install a tar package."
973 974 975
  ;; This won't happen, unless the archive is doing something wrong.
  (when (eq (package-desc-kind pkg-desc) 'dir)
    (error "Can't install directory package from archive"))
976
  (let* ((location (package-archive-base pkg-desc))
977 978 979 980
         (file (concat (package-desc-full-name pkg-desc)
                       (package-desc-suffix pkg-desc)))
         (sig-file (concat file ".sig"))
         good-signatures pkg-descs)
981
    (package--with-work-buffer location file
982
      (if (and package-check-signature
983 984 985 986 987 988 989
               (not (member (package-desc-archive pkg-desc)
                            package-unsigned-archives)))
          (if (package--archive-file-exists-p location sig-file)
              (setq good-signatures (package--check-signature location file))
            (unless (eq package-check-signature 'allow-unsigned)
              (error "Unsigned package: `%s'"
                     (package-desc-name pkg-desc)))))
990 991 992 993 994 995
      (package-unpack pkg-desc))
    ;; Here the package has been installed successfully, mark it as
    ;; signed if appropriate.
    (when good-signatures
      ;; Write out good signatures into NAME-VERSION.signed file.
      (write-region (mapconcat #'epg-signature-to-string good-signatures "\n")
996 997 998 999 1000
                    nil
                    (expand-file-name
                     (concat (package-desc-full-name pkg-desc)
                             ".signed")
                     package-user-dir)
1001
                    nil 'silent)
1002 1003 1004 1005 1006
      ;; Update the old pkg-desc which will be shown on the description buffer.
      (setf (package-desc-signed pkg-desc) t)
      ;; Update the new (activated) pkg-desc as well.
      (setq pkg-descs (cdr (assq (package-desc-name pkg-desc) package-alist)))
      (if pkg-descs
1007
          (setf (package-desc-signed (car pkg-descs)) t)))))
1008

1009 1010
(defvar package--initialized nil)

1011
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
1012
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
1013 1014 1015 1016
If PACKAGE is a symbol, it is the package name and MIN-VERSION
should be a version list.

If PACKAGE is a package-desc object, MIN-VERSION is ignored."
1017
  (unless package--initialized (error "package.el is not yet initialized!"))
1018
  (if (package-desc-p package)
1019
      (let ((dir (package-desc-dir package)))
1020 1021 1022 1023 1024 1025 1026 1027 1028
        (and (stringp dir)
             (file-exists-p dir)))
    (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))))
1029

1030
(defun package-compute-transaction (packages requirements &optional seen)
1031 1032
  "Return a list of packages to be installed, including PACKAGES.
PACKAGES should be a list of `package-desc'.
1033 1034

REQUIREMENTS should be a list of additional requirements; each
Chong Yidong's avatar
Chong Yidong committed
1035 1036 1037
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.
1038 1039 1040 1041

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
1042 1043 1044
not included in this list.

SEEN is used internally to detect infinite recursion."
1045 1046 1047 1048 1049
  ;; FIXME: We really should use backtracking to explore the whole
  ;; search space (e.g. if foo require bar-1.3, and bar-1.4 requires toto-1.1
  ;; whereas bar-1.3 requires toto-1.0 and the user has put a hold on toto-1.0:
  ;; the current code might fail to see that it could install foo by using the
  ;; older bar-1.3).
1050 1051
  (dolist (elt requirements)
    (let* ((next-pkg (car elt))
1052
           (next-version (cadr elt))
1053 1054 1055 1056
           (already ()))
      (dolist (pkg packages)
        (if (eq next-pkg (package-desc-name pkg))
            (setq already pkg)))
1057
      (when already
Dmitry Gutov's avatar
Dmitry Gutov committed
1058
        (if (version-list-<= next-version (package-desc-version already))
1059 1060 1061 1062 1063 1064 1065 1066 1067
            ;; `next-pkg' is already in `packages', but its position there
            ;; means it might be installed too late: remove it from there, so
            ;; we re-add it (along with its dependencies) at an earlier place
            ;; below (bug#16994).
            (if (memq already seen)     ;Avoid inf-loop on dependency cycles.
                (message "Dependency cycle going through %S"
                         (package-desc-full-name already))
              (setq packages (delq already packages))
              (setq already nil))
Dmitry Gutov's avatar
Dmitry Gutov committed
1068
          (error "Need package `%s-%s', but only %s is being installed"
1069 1070
                 next-pkg (package-version-join next-version)
                 (package-version-join (package-desc-version already)))))
1071 1072
      (cond
       (already nil)
1073 1074 1075
       ((package-installed-p next-pkg next-version) nil)

       (t
1076 1077 1078
        ;; A package is required, but not installed.  It might also be
        ;; blocked via `package-load-list'.
        (let ((pkg-descs (cdr (assq next-pkg package-archive-contents)))
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
              (found nil)
              (problem nil))
          (while (and pkg-descs (not found))
            (let* ((pkg-desc (pop pkg-descs))
                   (version (package-desc-version pkg-desc))
                   (disabled (package-disabled-p next-pkg version)))
              (cond
               ((version-list-< version next-version)
                (error
                 "Need package `%s-%s', but only %s is available"
                 next-pkg (package-version-join next-version)
                 (package-version-join version)))
               (disabled
                (unless problem
                  (setq problem
                        (if (stringp disabled)
                            (format "Package `%s' held at version %s, \
1096
but version %s required"
1097 1098 1099 1100 1101
                                    next-pkg disabled
                                    (package-version-join next-version))
                          (format "Required package '%s' is disabled"
                                  next-pkg)))))
               (t (setq found pkg-desc)))))
1102
          (unless found
1103
            (if problem
1104
                (error "%s" problem)
Stefan Monnier's avatar