package.el 107 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 'cl-lib))
165
(eval-when-compile (require 'epg))      ;For setf accessors.
166

167
(require 'tabulated-list)
168
(require 'macroexp)
169

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

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

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

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

For an element (NAME VERSION), NAME is a package name (a symbol).
VERSION should be t, a string, or nil.
196
If VERSION is t, the most recent version is activated.
197 198 199 200 201
If VERSION is a string, only that version is ever loaded.
 Any other version, even if newer, is silently ignored.
 Hence, the package is \"held\" at that version.
If VERSION is nil, the package is not loaded (it is \"disabled\")."
  :type '(repeat symbol)
202
  :risky t
203 204 205 206 207
  :group 'package
  :version "24.1")

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

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 236 237 238 239 240 241
(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
242 243
  :type '(alist :key-type (string :tag "Archive name")
                :value-type (integer :tag "Priority (default is 0)"))
244 245 246 247
  :risky t
  :group 'package
  :version "25.1")

248
(defcustom package-pinned-packages nil
249 250 251 252 253 254 255 256 257 258 259 260 261
  "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."
262 263
  :type '(alist :key-type (symbol :tag "Package")
                :value-type (string :tag "Archive name"))
264 265 266 267
  ;; 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.
268 269 270 271
  :risky t
  :group 'package
  :version "24.4")

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

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

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

313 314 315
(defcustom package-check-signature
  (if (progn (require 'epg-config) (executable-find epg-gpg-program))
      'allow-unsigned)
316 317 318 319 320 321
  "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."
322
  :type '(choice (const nil :tag "Never")
323 324
                 (const allow-unsigned :tag "Allow unsigned")
                 (const t :tag "Check always"))
325 326
  :risky t
  :group 'package
327
  :version "24.4")
328 329

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

336 337 338 339 340 341 342
(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
343 344 345 346 347
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."
348
  :group 'package
349
  :type '(repeat symbol))
350

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

470
(defvar package-activated-list nil
471
  ;; FIXME: This should implicitly include all builtin packages.
472
  "List of the names of currently activated packages.")
473
(put 'package-activated-list 'risky-local-variable t)
474

475 476 477 478 479 480 481 482 483
(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))
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
        (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")
499
                      ((= num -4) "snapshot"))
500
                str-list))))
501
      (if (equal "." (car str-list))
502
          (pop str-list))
503
      (apply 'concat (nreverse str-list)))))
504

505 506 507
(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)
508
                                    pkg-dir))
509
        (signed-file (concat pkg-dir ".signed")))
510 511 512 513
    (when (file-exists-p pkg-file)
      (with-temp-buffer
        (insert-file-contents pkg-file)
        (goto-char (point-min))
514 515
        (let ((pkg-desc (package-process-define-package
                         (read (current-buffer)) pkg-file)))
516
          (setf (package-desc-dir pkg-desc) pkg-dir)
517 518
          (if (file-exists-p signed-file)
              (setf (package-desc-signed pkg-desc) t))
519
          pkg-desc)))))
520 521 522 523 524 525 526 527 528

(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
529
updates `package-alist'."
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
  (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'")))))
551

552 553 554 555 556
(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')."
557
  (let* ((name (package-desc-name pkg-desc))
558
         (pkg-dir (package-desc-dir pkg-desc))
559
         (pkg-dir-dir (file-name-as-directory pkg-dir)))
560
    (unless pkg-dir
561
      (error "Internal error: unable to find directory for `%s'"
562
             (package-desc-full-name pkg-desc)))
563
    ;; Add to load path, add autoloads, and activate the package.
564 565 566
    (let* ((old-lp load-path)
           (autoloads-file (expand-file-name
                            (format "%s-autoloads" name) pkg-dir))
567
           (loaded-files-list (and reload (package--list-loaded-files pkg-dir))))
568
      (with-demoted-errors "Error in package-activate-1: %s"
569
        (load autoloads-file nil t))
570 571 572 573 574
      (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.
575 576 577 578 579 580
        (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.
581
      (with-demoted-errors "Error in package-activate-1: %s"
582
        (mapc (lambda (feature) (load feature nil t))
583 584
              ;; Skip autoloads file since we already evaluated it above.
              (remove (file-truename autoloads-file) loaded-files-list))))
585
    ;; Add info node.
586 587 588 589 590
    (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))
591
    (push name package-activated-list)
592 593 594
    ;; Don't return nil.
    t))

Sam Steingold's avatar
Sam Steingold committed
595
(declare-function find-library-name "find-func" (library))
596 597 598 599
(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."
600 601 602 603 604
  (let* ((history (delq nil
                        (mapcar (lambda (x)
                                  (let ((f (car x)))
                                    (and f (file-name-sans-extension f))))
                                load-history)))
605 606 607
         (dir (file-truename dir))
         ;; List all files that have already been loaded.
         (list-of-conflicts
608
          (delq
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
           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
630 631 632 633
(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."
634 635 636 637 638
  (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)))
639
       ((remove 0 min-version) nil)
640 641 642
       (t
        (require 'finder-inf nil t) ; For `package--builtins'.
        (assq package package--builtins))))))
643 644 645 646

(defun package--from-builtin (bi-desc)
  (package-desc-create :name (pop bi-desc)
                       :version (package--bi-desc-version bi-desc)
647 648
                       :summary (package--bi-desc-summary bi-desc)
                       :dir 'builtin))
649

650 651 652 653
;; 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.
654 655 656 657
(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))))
658
    ;; Check if PACKAGE is available in `package-alist'.
659 660 661 662 663 664 665
    (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)))
666 667
    (cond
     ;; If no such package is found, maybe it's built-in.
668 669
     ((null pkg-descs)
      (package-built-in-p package))
670
     ;; If the package is already activated, just return t.
671
     ((and (memq package package-activated-list) (not force))
672 673 674
      t)
     ;; Otherwise, proceed with activation.
     (t
675 676 677 678
      (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
679
                       (unless (package-activate (car req))
680
                         (throw 'dep-failure req))))))
681 682
        (if fail
            (warn "Unable to activate package `%s'.
683
Required package `%s-%s' is unavailable"
684 685 686
                  package (car fail) (package-version-join (cadr fail)))
          ;; If all goes well, activate the package itself.
          (package-activate-1 pkg-vec force)))))))
687

688 689 690
(defun define-package (_name-string _version-string
                                    &optional _docstring _requirements
                                    &rest _extra-properties)
691
  "Define a new package.
692
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
693
VERSION-STRING is the version of the package, as a string.
694 695
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
696 697
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
698 699

EXTRA-PROPERTIES is currently unused."
700 701 702 703 704 705 706 707 708
  ;; 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))
709 710 711 712 713
         (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.
714 715 716 717 718 719 720
      (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)))
721
    new-pkg-desc))
722

723
;; From Emacs 22, but changed so it adds to load-path.
724 725 726 727 728
(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)
729 730 731
             " --- automatically extracted autoloads\n"
             ";;\n"
             ";;; Code:\n"
732
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
733 734 735 736 737 738 739
             "\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")
740
     nil file nil 'silent))
741 742
  file)

743 744 745
(defvar generated-autoload-file)
(defvar version-control)

746
(defun package-generate-autoloads (name pkg-dir)
747
  (let* ((auto-name (format "%s-autoloads.el" name))
748 749
         ;;(ignore-name (concat name "-pkg.el"))
         (generated-autoload-file (expand-file-name auto-name pkg-dir))
750
         (backup-inhibited t)
751
         (version-control 'never))
752
    (package-autoload-ensure-default-file generated-autoload-file)
753 754
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
755 756
      (when buf (kill-buffer buf)))
    auto-name))
757

758 759
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
760 761
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
762 763

(defun package-untar-buffer (dir)
764
  "Untar the current buffer.
765 766
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
767
  (require 'tar-mode)
768 769
  (tar-mode)
  ;; Make sure everything extracts into DIR.
770
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
771
        (case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
772
    (dolist (tar-data tar-parse-info)
773
      (let ((name (expand-file-name (tar-header-name tar-data))))
774 775 776 777 778 779
        (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)))))
780
  (tar-untar-buffer))
781

782
(defun package-generate-description-file (pkg-desc pkg-file)
783
  "Create the foo-pkg.el file for single-file packages."
784
  (let* ((name (package-desc-name pkg-desc)))
785 786 787 788 789
    (let ((print-level nil)
          (print-quoted t)
          (print-length nil))
      (write-region
       (concat
790
        ";;; -*- no-byte-compile: t -*-\n"
791
        (prin1-to-string
792 793 794 795 796 797 798 799 800 801 802 803 804
         (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))))
805
          (package--alist-to-plist-args
806
           (package-desc-extras pkg-desc))))
807
        "\n")
808
       nil pkg-file nil 'silent))))
809

810
(defun package--alist-to-plist-args (alist)
811
  (mapcar 'macroexp-quote
812 813
          (apply #'nconc
                 (mapcar (lambda (pair) (list (car pair) (cdr pair))) alist))))
814 815 816 817
(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))
818
         (pkg-dir (expand-file-name dirname package-user-dir)))
819
    (pcase (package-desc-kind pkg-desc)
820 821 822 823 824 825 826 827 828 829 830 831 832 833
      (`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))))
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
      (`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.
853
    (package-activate name 'force)
854 855 856 857 858
    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)
859 860
  (let ((desc-file (expand-file-name (package--description-file pkg-dir)
                                     pkg-dir)))
861
    (unless (file-exists-p desc-file)
862
      (package-generate-description-file pkg-desc desc-file)))
863 864 865 866 867 868 869
  ;; 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))
870

871
(defun package--write-file-no-coding (file-name)
872
  (let ((buffer-file-coding-system 'no-conversion))
873
    (write-region (point-min) (point-max) file-name nil 'silent)))
874

875 876 877 878 879 880 881 882 883
(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."
884
  (declare (indent 2) (debug t))
885 886
  `(with-temp-buffer
     (if (string-match-p "\\`https?:" ,location)
887
         (url-insert-file-contents (concat ,location ,file))
888
       (unless (file-name-absolute-p ,location)
889 890
         (error "Archive location %s is not an absolute file name"
                ,location))
891 892
       (insert-file-contents (expand-file-name ,file ,location)))
     ,@body))
893

894 895 896
(defun package--archive-file-exists-p (location file)
  (let ((http (string-match "\\`https?:" location)))
    (if http
897 898 899
        (progn
          (require 'url-http)
          (url-http-file-exists-p (concat location file)))
900 901 902
      (file-exists-p (expand-file-name file location)))))

(declare-function epg-make-context "epg"
903 904 905 906
                  (&optional protocol armor textmode include-certs
                             cipher-algorithm
                             digest-algorithm
                             compress-algorithm))
907
(declare-function epg-verify-string "epg" (context signature
908
                                                   &optional signed-text))
909 910 911 912
(declare-function epg-context-result-for "epg" (context name))
(declare-function epg-signature-status "epg" (signature))
(declare-function epg-signature-to-string "epg" (signature))

913 914 915 916
(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
917 918 919 920 921 922 923
        (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))))))
924

925 926 927
(defun package--check-signature (location file)
  "Check signature of the current buffer.
GnuPG keyring is located under \"gnupg\" in `package-user-dir'."
928 929 930 931
  (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
932
                        (buffer-string))))
933
    (setf (epg-context-home-directory context) homedir)
934
    (condition-case error
935
        (epg-verify-string context sig-content (buffer-string))
936 937 938
      (error
       (package--display-verify-error context sig-file)
       (signal (car error) (cdr error))))
939 940 941 942
    (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))
943 944 945 946 947 948 949 950 951
        (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))))
952
      (when (and (null good-signatures) had-fatal-error)
953 954
        (package--display-verify-error context sig-file)
        (error "Failed to verify signature %s" sig-file))
955
      good-signatures)))
956

957
(defun package-install-from-archive (pkg-desc)
958
  "Download and install a tar package."
959 960 961
  ;; 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"))
962
  (let* ((location (package-archive-base pkg-desc))
963 964 965 966
         (file (concat (package-desc-full-name pkg-desc)
                       (package-desc-suffix pkg-desc)))
         (sig-file (concat file ".sig"))
         good-signatures pkg-descs)
967
    (package--with-work-buffer location file
968
      (if (and package-check-signature
969 970 971 972 973 974 975
               (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)))))
976 977 978 979 980 981
      (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")
982 983 984 985 986
                    nil
                    (expand-file-name
                     (concat (package-desc-full-name pkg-desc)
                             ".signed")
                     package-user-dir)
987
                    nil 'silent)
988 989 990 991 992
      ;; 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
993
          (setf (package-desc-signed (car pkg-descs)) t)))))
994

995 996
(defvar package--initialized nil)

997
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
998
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
999 1000 1001 1002
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."
1003
  (unless package--initialized (error "package.el is not yet initialized!"))
1004
  (if (package-desc-p package)
1005
      (let ((dir (package-desc-dir package)))
1006 1007 1008 1009 1010 1011 1012 1013 1014
        (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))))
1015

1016
(defun package-compute-transaction (packages requirements &optional seen)
1017 1018
  "Return a list of packages to be installed, including PACKAGES.
PACKAGES should be a list of `package-desc'.
1019 1020

REQUIREMENTS should be a list of additional requirements; each
Chong Yidong's avatar
Chong Yidong committed
1021 1022 1023
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.
1024 1025 1026 1027

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
1028 1029 1030
not included in this list.

SEEN is used internally to detect infinite recursion."
1031 1032 1033 1034 1035
  ;; 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).
1036 1037
  (dolist (elt requirements)
    (let* ((next-pkg (car elt))
1038
           (next-version (cadr elt))
1039 1040 1041 1042
           (already ()))
      (dolist (pkg packages)
        (if (eq next-pkg (package-desc-name pkg))
            (setq already pkg)))
1043
      (when already
Dmitry Gutov's avatar
Dmitry Gutov committed
1044
        (if (version-list-<= next-version (package-desc-version already))
1045 1046 1047 1048 1049 1050 1051 1052 1053
            ;; `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
1054
          (error "Need package `%s-%s', but only %s is being installed"
1055 1056
                 next-pkg (package-version-join next-version)
                 (package-version-join (package-desc-version already)))))
1057 1058
      (cond
       (already nil)
1059 1060 1061
       ((package-installed-p next-pkg next-version) nil)

       (t
1062 1063 1064
        ;; 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)))
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
              (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, \
1082
but version %s required"
1083 1084 1085 1086 1087
                                    next-pkg disabled
                                    (package-version-join next-version))
                          (format "Required package '%s' is disabled"
                                  next-pkg)))))
               (t (setq found pkg-desc)))))
1088
          (unless found
1089
            (if problem
1090
                (error "%s" problem)
1091 1092
              (error "Package `%s-%s' is unavailable"
                     next-pkg (package-version-join next-version))))
1093 1094 1095
          (setq packages
                (package-compute-transaction (cons found packages)
                                             (package-desc-reqs found)
1096
                                             (cons found seen))))))))
1097
  packages)