* lisp/info.el (info-initialize): Revert 2014-01-10 change.
[emacs.git] / lisp / emacs-lisp / package.el
blobb15ae6f1376e3de2de4c5dd44f6c2ba96888bf43
1 ;;; package.el --- Simple package system for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 2007-2014 Free Software Foundation, Inc.
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"))
12 ;; 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 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; 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/>.
27 ;;; Change Log:
29 ;; 2 Apr 2007 - now using ChangeLog file
30 ;; 15 Mar 2007 - updated documentation
31 ;; 14 Mar 2007 - Changed how obsolete packages are handled
32 ;; 13 Mar 2007 - Wrote package-install-from-buffer
33 ;; 12 Mar 2007 - Wrote package-menu mode
35 ;;; Commentary:
37 ;; The idea behind package.el is to be able to download packages and
38 ;; install them. Packages are versioned and have versioned
39 ;; dependencies. Furthermore, this supports built-in packages which
40 ;; may or may not be newer than user-specified packages. This makes
41 ;; it possible to upgrade Emacs and automatically disable packages
42 ;; which have moved from external to core. (Note though that we don't
43 ;; currently register any of these, so this feature does not actually
44 ;; work.)
46 ;; A package is described by its name and version. The distribution
47 ;; format is either a tar file or a single .el file.
49 ;; A tar file should be named "NAME-VERSION.tar". The tar file must
50 ;; unpack into a directory named after the package and version:
51 ;; "NAME-VERSION". It must contain a file named "PACKAGE-pkg.el"
52 ;; which consists of a call to define-package. It may also contain a
53 ;; "dir" file and the info files it references.
55 ;; A .el file is named "NAME-VERSION.el" in the remote archive, but is
56 ;; installed as simply "NAME.el" in a directory named "NAME-VERSION".
58 ;; The downloader downloads all dependent packages. By default,
59 ;; packages come from the official GNU sources, but others may be
60 ;; added by customizing the `package-archives' alist. Packages get
61 ;; byte-compiled at install time.
63 ;; At activation time we will set up the load-path and the info path,
64 ;; and we will load the package's autoloads. If a package's
65 ;; dependencies are not available, we will not activate that package.
67 ;; Conceptually a package has multiple state transitions:
69 ;; * Download. Fetching the package from ELPA.
70 ;; * Install. Untar the package, or write the .el file, into
71 ;; ~/.emacs.d/elpa/ directory.
72 ;; * Byte compile. Currently this phase is done during install,
73 ;; but we may change this.
74 ;; * Activate. Evaluate the autoloads for the package to make it
75 ;; available to the user.
76 ;; * Load. Actually load the package and run some code from it.
78 ;; Other external functions you may want to use:
80 ;; M-x list-packages
81 ;; Enters a mode similar to buffer-menu which lets you manage
82 ;; packages. You can choose packages for install (mark with "i",
83 ;; then "x" to execute) or deletion (not implemented yet), and you
84 ;; can see what packages are available. This will automatically
85 ;; fetch the latest list of packages from ELPA.
87 ;; M-x package-install-from-buffer
88 ;; Install a package consisting of a single .el file that appears
89 ;; in the current buffer. This only works for packages which
90 ;; define a Version header properly; package.el also supports the
91 ;; extension headers Package-Version (in case Version is an RCS id
92 ;; or similar), and Package-Requires (if the package requires other
93 ;; packages).
95 ;; M-x package-install-file
96 ;; Install a package from the indicated file. The package can be
97 ;; either a tar file or a .el file. A tar file must contain an
98 ;; appropriately-named "-pkg.el" file; a .el file must be properly
99 ;; formatted as with package-install-from-buffer.
101 ;;; Thanks:
102 ;;; (sorted by sort-lines):
104 ;; Jim Blandy <jimb@red-bean.com>
105 ;; Karl Fogel <kfogel@red-bean.com>
106 ;; Kevin Ryde <user42@zip.com.au>
107 ;; Lawrence Mitchell
108 ;; Michael Olson <mwolson@member.fsf.org>
109 ;; Sebastian Tennant <sebyte@smolny.plus.com>
110 ;; Stefan Monnier <monnier@iro.umontreal.ca>
111 ;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
112 ;; Phil Hagelberg <phil@hagelb.org>
114 ;;; ToDo:
116 ;; - a trust mechanism, since compiling a package can run arbitrary code.
117 ;; For example, download package signatures and check that they match.
118 ;; - putting info dirs at the start of the info path means
119 ;; users see a weird ordering of categories. OTOH we want to
120 ;; override later entries. maybe emacs needs to enforce
121 ;; the standard layout?
122 ;; - put bytecode in a separate directory tree
123 ;; - perhaps give users a way to recompile their bytecode
124 ;; or do it automatically when emacs changes
125 ;; - give users a way to know whether a package is installed ok
126 ;; - give users a way to view a package's documentation when it
127 ;; only appears in the .el
128 ;; - use/extend checkdoc so people can tell if their package will work
129 ;; - "installed" instead of a blank in the status column
130 ;; - tramp needs its files to be compiled in a certain order.
131 ;; how to handle this? fix tramp?
132 ;; - on emacs 21 we don't kill the -autoloads.el buffer. what about 22?
133 ;; - maybe we need separate .elc directories for various emacs versions
134 ;; and also emacs-vs-xemacs. That way conditional compilation can
135 ;; work. But would this break anything?
136 ;; - should store the package's keywords in archive-contents, then
137 ;; let the users filter the package-menu by keyword. See
138 ;; finder-by-keyword. (We could also let people view the
139 ;; Commentary, but it isn't clear how useful this is.)
140 ;; - William Xu suggests being able to open a package file without
141 ;; installing it
142 ;; - Interface with desktop.el so that restarting after an install
143 ;; works properly
144 ;; - Use hierarchical layout. PKG/etc PKG/lisp PKG/info
145 ;; ... except maybe lisp?
146 ;; - It may be nice to have a macro that expands to the package's
147 ;; private data dir, aka ".../etc". Or, maybe data-directory
148 ;; needs to be a list (though this would be less nice)
149 ;; a few packages want this, eg sokoban
150 ;; - package menu needs:
151 ;; ability to know which packages are built-in & thus not deletable
152 ;; it can sometimes print odd results, like 0.3 available but 0.4 active
153 ;; why is that?
154 ;; - Allow multiple versions on the server...?
155 ;; [ why bother? ]
156 ;; - Don't install a package which will invalidate dependencies overall
157 ;; - Allow something like (or (>= emacs 21.0) (>= xemacs 21.5))
158 ;; [ currently thinking, why bother.. KISS ]
159 ;; - Allow optional package dependencies
160 ;; then if we require 'bbdb', bbdb-specific lisp in lisp/bbdb
161 ;; and just don't compile to add to load path ...?
162 ;; - Our treatment of the info path is somewhat bogus
164 ;;; Code:
166 (eval-when-compile (require 'cl-lib))
168 (require 'tabulated-list)
170 (defgroup package nil
171 "Manager for Emacs Lisp packages."
172 :group 'applications
173 :version "24.1")
175 ;;;###autoload
176 (defcustom package-enable-at-startup t
177 "Whether to activate installed packages when Emacs starts.
178 If non-nil, packages are activated after reading the init file
179 and before `after-init-hook'. Activation is not done if
180 `user-init-file' is nil (e.g. Emacs was started with \"-q\").
182 Even if the value is nil, you can type \\[package-initialize] to
183 activate the package system at any time."
184 :type 'boolean
185 :group 'package
186 :version "24.1")
188 (defcustom package-load-list '(all)
189 "List of packages for `package-initialize' to load.
190 Each element in this list should be a list (NAME VERSION), or the
191 symbol `all'. The symbol `all' says to load the latest installed
192 versions of all packages not specified by other elements.
194 For an element (NAME VERSION), NAME is a package name (a symbol).
195 VERSION should be t, a string, or nil.
196 If VERSION is t, the most recent version is activated.
197 If VERSION is a string, only that version is ever loaded.
198 Any other version, even if newer, is silently ignored.
199 Hence, the package is \"held\" at that version.
200 If VERSION is nil, the package is not loaded (it is \"disabled\")."
201 :type '(repeat symbol)
202 :risky t
203 :group 'package
204 :version "24.1")
206 (defvar Info-directory-list)
207 (declare-function info-initialize "info" ())
208 (declare-function url-http-parse-response "url-http" ())
209 (declare-function url-http-file-exists-p "url-http" (url))
210 (declare-function lm-header "lisp-mnt" (header))
211 (declare-function lm-commentary "lisp-mnt" (&optional file))
212 (defvar url-http-end-of-headers)
213 (declare-function url-recreate-url "url-parse" (urlobj))
214 (defvar url-http-target-url)
216 (defcustom package-archives '(("gnu" . "http://elpa.gnu.org/packages/"))
217 "An alist of archives from which to fetch.
218 The default value points to the GNU Emacs package repository.
220 Each element has the form (ID . LOCATION).
221 ID is an archive name, as a string.
222 LOCATION specifies the base location for the archive.
223 If it starts with \"http:\", it is treated as a HTTP URL;
224 otherwise it should be an absolute directory name.
225 (Other types of URL are currently not supported.)
227 Only add locations that you trust, since fetching and installing
228 a package can run arbitrary code."
229 :type '(alist :key-type (string :tag "Archive name")
230 :value-type (string :tag "URL or directory name"))
231 :risky t
232 :group 'package
233 :version "24.1")
235 (defcustom package-pinned-packages nil
236 "An alist of packages that are pinned to a specific archive
238 Each element has the form (SYM . ID).
239 SYM is a package, as a symbol.
240 ID is an archive name. This should correspond to an
241 entry in `package-archives'.
243 If the archive of name ID does not contain the package SYM, no
244 other location will be considered, which will make the
245 package unavailable."
246 :type '(alist :key-type (symbol :tag "Package")
247 :value-type (string :tag "Archive name"))
248 :risky t
249 :group 'package
250 :version "24.4")
252 (defconst package-archive-version 1
253 "Version number of the package archive understood by this file.
254 Lower version numbers than this will probably be understood as well.")
256 ;; We don't prime the cache since it tends to get out of date.
257 (defvar package-archive-contents nil
258 "Cache of the contents of the Emacs Lisp Package Archive.
259 This is an alist mapping package names (symbols) to
260 non-empty lists of `package-desc' structures.")
261 (put 'package-archive-contents 'risky-local-variable t)
263 (defcustom package-user-dir (locate-user-emacs-file "elpa")
264 "Directory containing the user's Emacs Lisp packages.
265 The directory name should be absolute.
266 Apart from this directory, Emacs also looks for system-wide
267 packages in `package-directory-list'."
268 :type 'directory
269 :risky t
270 :group 'package
271 :version "24.1")
273 (defcustom package-directory-list
274 ;; Defaults are subdirs named "elpa" in the site-lisp dirs.
275 (let (result)
276 (dolist (f load-path)
277 (and (stringp f)
278 (equal (file-name-nondirectory f) "site-lisp")
279 (push (expand-file-name "elpa" f) result)))
280 (nreverse result))
281 "List of additional directories containing Emacs Lisp packages.
282 Each directory name should be absolute.
284 These directories contain packages intended for system-wide; in
285 contrast, `package-user-dir' contains packages for personal use."
286 :type '(repeat directory)
287 :risky t
288 :group 'package
289 :version "24.1")
291 (defcustom package-check-signature 'allow-unsigned
292 "Whether to check package signatures when installing."
293 :type '(choice (const nil :tag "Never")
294 (const allow-unsigned :tag "Allow unsigned")
295 (const t :tag "Check always"))
296 :risky t
297 :group 'package
298 :version "24.1")
300 (defcustom package-unsigned-archives nil
301 "A list of archives which do not use package signature."
302 :type '(repeat (string :tag "Archive name"))
303 :risky t
304 :group 'package
305 :version "24.1")
307 (defvar package--default-summary "No description available.")
309 (cl-defstruct (package-desc
310 ;; Rename the default constructor from `make-package-desc'.
311 (:constructor package-desc-create)
312 ;; Has the same interface as the old `define-package',
313 ;; which is still used in the "foo-pkg.el" files. Extra
314 ;; options can be supported by adding additional keys.
315 (:constructor
316 package-desc-from-define
317 (name-string version-string &optional summary requirements
318 &rest rest-plist
319 &aux
320 (name (intern name-string))
321 (version (version-to-list version-string))
322 (reqs (mapcar #'(lambda (elt)
323 (list (car elt)
324 (version-to-list (cadr elt))))
325 (if (eq 'quote (car requirements))
326 (nth 1 requirements)
327 requirements)))
328 (kind (plist-get rest-plist :kind))
329 (archive (plist-get rest-plist :archive))
330 (extras (let (alist)
331 (while rest-plist
332 (unless (memq (car rest-plist) '(:kind :archive))
333 (let ((value (cadr rest-plist)))
334 (when value
335 (push (cons (car rest-plist)
336 (if (eq (car-safe value) 'quote)
337 (cdr value)
338 value))
339 alist))))
340 (setq rest-plist (cddr rest-plist)))
341 alist)))))
342 "Structure containing information about an individual package.
343 Slots:
345 `name' Name of the package, as a symbol.
347 `version' Version of the package, as a version list.
349 `summary' Short description of the package, typically taken from
350 the first line of the file.
352 `reqs' Requirements of the package. A list of (PACKAGE
353 VERSION-LIST) naming the dependent package and the minimum
354 required version.
356 `kind' The distribution format of the package. Currently, it is
357 either `single' or `tar'.
359 `archive' The name of the archive (as a string) whence this
360 package came.
362 `dir' The directory where the package is installed (if installed),
363 `builtin' if it is built-in, or nil otherwise.
365 `extras' Optional alist of additional keyword-value pairs.
367 `signed' Flag to indicate that the package is signed by provider."
368 name
369 version
370 (summary package--default-summary)
371 reqs
372 kind
373 archive
375 extras
376 signed)
378 ;; Pseudo fields.
379 (defun package-desc-full-name (pkg-desc)
380 (format "%s-%s"
381 (package-desc-name pkg-desc)
382 (package-version-join (package-desc-version pkg-desc))))
384 (defun package-desc-suffix (pkg-desc)
385 (pcase (package-desc-kind pkg-desc)
386 (`single ".el")
387 (`tar ".tar")
388 (kind (error "Unknown package kind: %s" kind))))
390 (defun package-desc--keywords (pkg-desc)
391 (let ((keywords (cdr (assoc :keywords (package-desc-extras pkg-desc)))))
392 (if (eq (car-safe keywords) 'quote)
393 (nth 1 keywords)
394 keywords)))
396 ;; Package descriptor format used in finder-inf.el and package--builtins.
397 (cl-defstruct (package--bi-desc
398 (:constructor package-make-builtin (version summary))
399 (:type vector))
400 version
401 reqs
402 summary)
404 (defvar package--builtins nil
405 "Alist of built-in packages.
406 The actual value is initialized by loading the library
407 `finder-inf'; this is not done until it is needed, e.g. by the
408 function `package-built-in-p'.
410 Each element has the form (PKG . PACKAGE-BI-DESC), where PKG is a package
411 name (a symbol) and DESC is a `package--bi-desc' structure.")
412 (put 'package--builtins 'risky-local-variable t)
414 (defvar package-alist nil
415 "Alist of all packages available for activation.
416 Each element has the form (PKG . DESCS), where PKG is a package
417 name (a symbol) and DESCS is a non-empty list of `package-desc' structure,
418 sorted by decreasing versions.
420 This variable is set automatically by `package-load-descriptor',
421 called via `package-initialize'. To change which packages are
422 loaded and/or activated, customize `package-load-list'.")
423 (put 'package-alist 'risky-local-variable t)
425 (defvar package-activated-list nil
426 ;; FIXME: This should implicitly include all builtin packages.
427 "List of the names of currently activated packages.")
428 (put 'package-activated-list 'risky-local-variable t)
430 (defun package-version-join (vlist)
431 "Return the version string corresponding to the list VLIST.
432 This is, approximately, the inverse of `version-to-list'.
433 \(Actually, it returns only one of the possible inverses, since
434 `version-to-list' is a many-to-one operation.)"
435 (if (null vlist)
437 (let ((str-list (list "." (int-to-string (car vlist)))))
438 (dolist (num (cdr vlist))
439 (cond
440 ((>= num 0)
441 (push (int-to-string num) str-list)
442 (push "." str-list))
443 ((< num -4)
444 (error "Invalid version list `%s'" vlist))
446 ;; pre, or beta, or alpha
447 (cond ((equal "." (car str-list))
448 (pop str-list))
449 ((not (string-match "[0-9]+" (car str-list)))
450 (error "Invalid version list `%s'" vlist)))
451 (push (cond ((= num -1) "pre")
452 ((= num -2) "beta")
453 ((= num -3) "alpha")
454 ((= num -4) "snapshot"))
455 str-list))))
456 (if (equal "." (car str-list))
457 (pop str-list))
458 (apply 'concat (nreverse str-list)))))
460 (defun package-load-descriptor (pkg-dir)
461 "Load the description file in directory PKG-DIR."
462 (let ((pkg-file (expand-file-name (package--description-file pkg-dir)
463 pkg-dir))
464 (signed-file (concat pkg-dir ".signed")))
465 (when (file-exists-p pkg-file)
466 (with-temp-buffer
467 (insert-file-contents pkg-file)
468 (goto-char (point-min))
469 (let ((pkg-desc (package-process-define-package
470 (read (current-buffer)) pkg-file)))
471 (setf (package-desc-dir pkg-desc) pkg-dir)
472 (if (file-exists-p signed-file)
473 (setf (package-desc-signed pkg-desc) t))
474 pkg-desc)))))
476 (defun package-load-all-descriptors ()
477 "Load descriptors for installed Emacs Lisp packages.
478 This looks for package subdirectories in `package-user-dir' and
479 `package-directory-list'. The variable `package-load-list'
480 controls which package subdirectories may be loaded.
482 In each valid package subdirectory, this function loads the
483 description file containing a call to `define-package', which
484 updates `package-alist'."
485 (dolist (dir (cons package-user-dir package-directory-list))
486 (when (file-directory-p dir)
487 (dolist (subdir (directory-files dir))
488 (let ((pkg-dir (expand-file-name subdir dir)))
489 (when (file-directory-p pkg-dir)
490 (package-load-descriptor pkg-dir)))))))
492 (defun package-disabled-p (pkg-name version)
493 "Return whether PKG-NAME at VERSION can be activated.
494 The decision is made according to `package-load-list'.
495 Return nil if the package can be activated.
496 Return t if the package is completely disabled.
497 Return the max version (as a string) if the package is held at a lower version."
498 (let ((force (assq pkg-name package-load-list)))
499 (cond ((null force) (not (memq 'all package-load-list)))
500 ((null (setq force (cadr force))) t) ; disabled
501 ((eq force t) nil)
502 ((stringp force) ; held
503 (unless (version-list-= version (version-to-list force))
504 force))
505 (t (error "Invalid element in `package-load-list'")))))
507 (defun package-activate-1 (pkg-desc)
508 (let* ((name (package-desc-name pkg-desc))
509 (pkg-dir (package-desc-dir pkg-desc))
510 (pkg-dir-dir (file-name-as-directory pkg-dir)))
511 (unless pkg-dir
512 (error "Internal error: unable to find directory for `%s'"
513 (package-desc-full-name pkg-desc)))
514 ;; Add to load path, add autoloads, and activate the package.
515 (let ((old-lp load-path))
516 (with-demoted-errors
517 (load (expand-file-name (format "%s-autoloads" name) pkg-dir) nil t))
518 (when (and (eq old-lp load-path)
519 (not (or (member pkg-dir load-path)
520 (member pkg-dir-dir load-path))))
521 ;; Old packages don't add themselves to the `load-path', so we have to
522 ;; do it ourselves.
523 (push pkg-dir load-path)))
524 ;; Add info node.
525 (when (file-exists-p (expand-file-name "dir" pkg-dir))
526 ;; FIXME: not the friendliest, but simple.
527 (require 'info)
528 (info-initialize)
529 (push pkg-dir Info-directory-list))
530 (push name package-activated-list)
531 ;; Don't return nil.
534 (defun package-built-in-p (package &optional min-version)
535 "Return true if PACKAGE is built-in to Emacs.
536 Optional arg MIN-VERSION, if non-nil, should be a version list
537 specifying the minimum acceptable version."
538 (if (package-desc-p package) ;; was built-in and then was converted
539 (eq 'builtin (package-desc-dir package))
540 (let ((bi (assq package package--builtin-versions)))
541 (cond
542 (bi (version-list-<= min-version (cdr bi)))
543 (min-version nil)
545 (require 'finder-inf nil t) ; For `package--builtins'.
546 (assq package package--builtins))))))
548 (defun package--from-builtin (bi-desc)
549 (package-desc-create :name (pop bi-desc)
550 :version (package--bi-desc-version bi-desc)
551 :summary (package--bi-desc-summary bi-desc)
552 :dir 'builtin))
554 ;; This function goes ahead and activates a newer version of a package
555 ;; if an older one was already activated. This is not ideal; we'd at
556 ;; least need to check to see if the package has actually been loaded,
557 ;; and not merely activated.
558 (defun package-activate (package &optional force)
559 "Activate package PACKAGE.
560 If FORCE is true, (re-)activate it if it's already activated."
561 (let ((pkg-descs (cdr (assq package package-alist))))
562 ;; Check if PACKAGE is available in `package-alist'.
563 (while
564 (when pkg-descs
565 (let ((available-version (package-desc-version (car pkg-descs))))
566 (or (package-disabled-p package available-version)
567 ;; Prefer a builtin package.
568 (package-built-in-p package available-version))))
569 (setq pkg-descs (cdr pkg-descs)))
570 (cond
571 ;; If no such package is found, maybe it's built-in.
572 ((null pkg-descs)
573 (package-built-in-p package))
574 ;; If the package is already activated, just return t.
575 ((and (memq package package-activated-list) (not force))
577 ;; Otherwise, proceed with activation.
579 (let* ((pkg-vec (car pkg-descs))
580 (fail (catch 'dep-failure
581 ;; Activate its dependencies recursively.
582 (dolist (req (package-desc-reqs pkg-vec))
583 (unless (package-activate (car req) (cadr req))
584 (throw 'dep-failure req))))))
585 (if fail
586 (warn "Unable to activate package `%s'.
587 Required package `%s-%s' is unavailable"
588 package (car fail) (package-version-join (cadr fail)))
589 ;; If all goes well, activate the package itself.
590 (package-activate-1 pkg-vec)))))))
592 (defun define-package (_name-string _version-string
593 &optional _docstring _requirements
594 &rest _extra-properties)
595 "Define a new package.
596 NAME-STRING is the name of the package, as a string.
597 VERSION-STRING is the version of the package, as a string.
598 DOCSTRING is a short description of the package, a string.
599 REQUIREMENTS is a list of dependencies on other packages.
600 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
601 where OTHER-VERSION is a string.
603 EXTRA-PROPERTIES is currently unused."
604 ;; FIXME: Placeholder! Should we keep it?
605 (error "Don't call me!"))
607 (defun package-process-define-package (exp origin)
608 (unless (eq (car-safe exp) 'define-package)
609 (error "Can't find define-package in %s" origin))
610 (let* ((new-pkg-desc (apply #'package-desc-from-define (cdr exp)))
611 (name (package-desc-name new-pkg-desc))
612 (version (package-desc-version new-pkg-desc))
613 (old-pkgs (assq name package-alist)))
614 (if (null old-pkgs)
615 ;; If there's no old package, just add this to `package-alist'.
616 (push (list name new-pkg-desc) package-alist)
617 ;; If there is, insert the new package at the right place in the list.
618 (while
619 (if (and (cdr old-pkgs)
620 (version-list-< version
621 (package-desc-version (cadr old-pkgs))))
622 (setq old-pkgs (cdr old-pkgs))
623 (push new-pkg-desc (cdr old-pkgs))
624 nil)))
625 new-pkg-desc))
627 ;; From Emacs 22, but changed so it adds to load-path.
628 (defun package-autoload-ensure-default-file (file)
629 "Make sure that the autoload file FILE exists and if not create it."
630 (unless (file-exists-p file)
631 (write-region
632 (concat ";;; " (file-name-nondirectory file)
633 " --- automatically extracted autoloads\n"
634 ";;\n"
635 ";;; Code:\n"
636 "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
637 "\f\n;; Local Variables:\n"
638 ";; version-control: never\n"
639 ";; no-byte-compile: t\n"
640 ";; no-update-autoloads: t\n"
641 ";; End:\n"
642 ";;; " (file-name-nondirectory file)
643 " ends here\n")
644 nil file nil 'silent))
645 file)
647 (defvar generated-autoload-file)
648 (defvar version-control)
650 (defun package-generate-autoloads (name pkg-dir)
651 (let* ((auto-name (format "%s-autoloads.el" name))
652 ;;(ignore-name (concat name "-pkg.el"))
653 (generated-autoload-file (expand-file-name auto-name pkg-dir))
654 (version-control 'never))
655 (package-autoload-ensure-default-file generated-autoload-file)
656 (update-directory-autoloads pkg-dir)
657 (let ((buf (find-buffer-visiting generated-autoload-file)))
658 (when buf (kill-buffer buf)))
659 auto-name))
661 (defvar tar-parse-info)
662 (declare-function tar-untar-buffer "tar-mode" ())
663 (declare-function tar-header-name "tar-mode" (tar-header) t)
664 (declare-function tar-header-link-type "tar-mode" (tar-header) t)
666 (defun package-untar-buffer (dir)
667 "Untar the current buffer.
668 This uses `tar-untar-buffer' from Tar mode. All files should
669 untar into a directory named DIR; otherwise, signal an error."
670 (require 'tar-mode)
671 (tar-mode)
672 ;; Make sure everything extracts into DIR.
673 (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
674 (case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
675 (dolist (tar-data tar-parse-info)
676 (let ((name (expand-file-name (tar-header-name tar-data))))
677 (or (string-match regexp name)
678 ;; Tarballs created by some utilities don't list
679 ;; directories with a trailing slash (Bug#13136).
680 (and (string-equal dir name)
681 (eq (tar-header-link-type tar-data) 5))
682 (error "Package does not untar cleanly into directory %s/" dir)))))
683 (tar-untar-buffer))
685 (defun package-generate-description-file (pkg-desc pkg-dir)
686 "Create the foo-pkg.el file for single-file packages."
687 (let* ((name (package-desc-name pkg-desc))
688 (pkg-file (expand-file-name (package--description-file pkg-dir)
689 pkg-dir)))
690 (let ((print-level nil)
691 (print-quoted t)
692 (print-length nil))
693 (write-region
694 (concat
695 (prin1-to-string
696 (nconc
697 (list 'define-package
698 (symbol-name name)
699 (package-version-join (package-desc-version pkg-desc))
700 (package-desc-summary pkg-desc)
701 (let ((requires (package-desc-reqs pkg-desc)))
702 (list 'quote
703 ;; Turn version lists into string form.
704 (mapcar
705 (lambda (elt)
706 (list (car elt)
707 (package-version-join (cadr elt))))
708 requires))))
709 (package--alist-to-plist
710 (package-desc-extras pkg-desc))))
711 "\n")
712 nil pkg-file nil 'silent))))
714 (defun package--alist-to-plist (alist)
715 (apply #'nconc (mapcar (lambda (pair) (list (car pair) (cdr pair))) alist)))
717 (defun package-unpack (pkg-desc)
718 "Install the contents of the current buffer as a package."
719 (let* ((name (package-desc-name pkg-desc))
720 (dirname (package-desc-full-name pkg-desc))
721 (pkg-dir (expand-file-name dirname package-user-dir)))
722 (pcase (package-desc-kind pkg-desc)
723 (`tar
724 (make-directory package-user-dir t)
725 ;; FIXME: should we delete PKG-DIR if it exists?
726 (let* ((default-directory (file-name-as-directory package-user-dir)))
727 (package-untar-buffer dirname)))
728 (`single
729 (let ((el-file (expand-file-name (format "%s.el" name) pkg-dir)))
730 (make-directory pkg-dir t)
731 (package--write-file-no-coding el-file)))
732 (kind (error "Unknown package kind: %S" kind)))
733 (package--make-autoloads-and-stuff pkg-desc pkg-dir)
734 ;; Update package-alist.
735 (let ((new-desc (package-load-descriptor pkg-dir)))
736 ;; FIXME: Check that `new-desc' matches `desc'!
737 ;; FIXME: Compilation should be done as a separate, optional, step.
738 ;; E.g. for multi-package installs, we should first install all packages
739 ;; and then compile them.
740 (package--compile new-desc))
741 ;; Try to activate it.
742 (package-activate name 'force)
743 pkg-dir))
745 (defun package--make-autoloads-and-stuff (pkg-desc pkg-dir)
746 "Generate autoloads, description file, etc.. for PKG-DESC installed at PKG-DIR."
747 (package-generate-autoloads (package-desc-name pkg-desc) pkg-dir)
748 (let ((desc-file (package--description-file pkg-dir)))
749 (unless (file-exists-p desc-file)
750 (package-generate-description-file pkg-desc pkg-dir)))
751 ;; FIXME: Create foo.info and dir file from foo.texi?
754 (defun package--compile (pkg-desc)
755 "Byte-compile installed package PKG-DESC."
756 (package-activate-1 pkg-desc)
757 (byte-recompile-directory (package-desc-dir pkg-desc) 0 t))
759 (defun package--write-file-no-coding (file-name)
760 (let ((buffer-file-coding-system 'no-conversion))
761 (write-region (point-min) (point-max) file-name nil 'silent)))
763 (defmacro package--with-work-buffer (location file &rest body)
764 "Run BODY in a buffer containing the contents of FILE at LOCATION.
765 LOCATION is the base location of a package archive, and should be
766 one of the URLs (or file names) specified in `package-archives'.
767 FILE is the name of a file relative to that base location.
769 This macro retrieves FILE from LOCATION into a temporary buffer,
770 and evaluates BODY while that buffer is current. This work
771 buffer is killed afterwards. Return the last value in BODY."
772 (declare (indent 2) (debug t))
773 `(let* ((http (string-match "\\`https?:" ,location))
774 (buffer
775 (if http
776 (url-retrieve-synchronously (concat ,location ,file))
777 (generate-new-buffer "*package work buffer*"))))
778 (prog1
779 (with-current-buffer buffer
780 (if http
781 (progn (package-handle-response)
782 (re-search-forward "^$" nil 'move)
783 (forward-char)
784 (delete-region (point-min) (point)))
785 (unless (file-name-absolute-p ,location)
786 (error "Archive location %s is not an absolute file name"
787 ,location))
788 (insert-file-contents (expand-file-name ,file ,location)))
789 ,@body)
790 (kill-buffer buffer))))
792 (defun package-handle-response ()
793 "Handle the response from a `url-retrieve-synchronously' call.
794 Parse the HTTP response and throw if an error occurred.
795 The url package seems to require extra processing for this.
796 This should be called in a `save-excursion', in the download buffer.
797 It will move point to somewhere in the headers."
798 ;; We assume HTTP here.
799 (require 'url-http)
800 (let ((response (url-http-parse-response)))
801 (when (or (< response 200) (>= response 300))
802 (error "Error downloading %s:%s"
803 (url-recreate-url url-http-target-url)
804 (buffer-substring-no-properties (point) (line-end-position))))))
806 (defun package--archive-file-exists-p (location file)
807 (let ((http (string-match "\\`https?:" location)))
808 (if http
809 (progn
810 (require 'url-http)
811 (url-http-file-exists-p (concat location file)))
812 (file-exists-p (expand-file-name file location)))))
814 (declare-function epg-make-context "epg"
815 (&optional protocol armor textmode include-certs
816 cipher-algorithm
817 digest-algorithm
818 compress-algorithm))
819 (declare-function epg-context-set-home-directory "epg" (context directory))
820 (declare-function epg-verify-string "epg" (context signature
821 &optional signed-text))
822 (declare-function epg-context-result-for "epg" (context name))
823 (declare-function epg-signature-status "epg" (signature))
824 (declare-function epg-signature-to-string "epg" (signature))
826 (defun package--check-signature (location file)
827 "Check signature of the current buffer.
828 GnuPG keyring is located under \"gnupg\" in `package-user-dir'."
829 (let* ((context (epg-make-context 'OpenPGP))
830 (homedir (expand-file-name "gnupg" package-user-dir))
831 (sig-file (concat file ".sig"))
832 (sig-content (package--with-work-buffer location sig-file
833 (buffer-string))))
834 (epg-context-set-home-directory context homedir)
835 (epg-verify-string context sig-content (buffer-string))
836 ;; The .sig file may contain multiple signatures. Success if one
837 ;; of the signatures is good.
838 (let ((good-signatures
839 (delq nil (mapcar (lambda (sig)
840 (if (eq (epg-signature-status sig) 'good)
841 sig))
842 (epg-context-result-for context 'verify)))))
843 (if (null good-signatures)
844 (error "Failed to verify signature %s: %S"
845 sig-file
846 (mapcar #'epg-signature-to-string
847 (epg-context-result-for context 'verify)))
848 good-signatures))))
850 (defun package-install-from-archive (pkg-desc)
851 "Download and install a tar package."
852 (let* ((location (package-archive-base pkg-desc))
853 (file (concat (package-desc-full-name pkg-desc)
854 (package-desc-suffix pkg-desc)))
855 (sig-file (concat file ".sig"))
856 good-signatures pkg-descs)
857 (package--with-work-buffer location file
858 (if (and package-check-signature
859 (not (member (package-desc-archive pkg-desc)
860 package-unsigned-archives)))
861 (if (package--archive-file-exists-p location sig-file)
862 (setq good-signatures (package--check-signature location file))
863 (unless (eq package-check-signature 'allow-unsigned)
864 (error "Unsigned package: `%s'"
865 (package-desc-name pkg-desc)))))
866 (package-unpack pkg-desc))
867 ;; Here the package has been installed successfully, mark it as
868 ;; signed if appropriate.
869 (when good-signatures
870 ;; Write out good signatures into NAME-VERSION.signed file.
871 (write-region (mapconcat #'epg-signature-to-string good-signatures "\n")
873 (expand-file-name
874 (concat (package-desc-full-name pkg-desc)
875 ".signed")
876 package-user-dir)
877 nil 'silent)
878 ;; Update the old pkg-desc which will be shown on the description buffer.
879 (setf (package-desc-signed pkg-desc) t)
880 ;; Update the new (activated) pkg-desc as well.
881 (setq pkg-descs (cdr (assq (package-desc-name pkg-desc) package-alist)))
882 (if pkg-descs
883 (setf (package-desc-signed (car pkg-descs)) t)))))
885 (defvar package--initialized nil)
887 (defun package-installed-p (package &optional min-version)
888 "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
889 MIN-VERSION should be a version list."
890 (unless package--initialized (error "package.el is not yet initialized!"))
892 (let ((pkg-descs (cdr (assq package package-alist))))
893 (and pkg-descs
894 (version-list-<= min-version
895 (package-desc-version (car pkg-descs)))))
896 ;; Also check built-in packages.
897 (package-built-in-p package min-version)))
899 (defun package-compute-transaction (packages requirements)
900 "Return a list of packages to be installed, including PACKAGES.
901 PACKAGES should be a list of `package-desc'.
903 REQUIREMENTS should be a list of additional requirements; each
904 element in this list should have the form (PACKAGE VERSION-LIST),
905 where PACKAGE is a package name and VERSION-LIST is the required
906 version of that package.
908 This function recursively computes the requirements of the
909 packages in REQUIREMENTS, and returns a list of all the packages
910 that must be installed. Packages that are already installed are
911 not included in this list."
912 ;; FIXME: We really should use backtracking to explore the whole
913 ;; search space (e.g. if foo require bar-1.3, and bar-1.4 requires toto-1.1
914 ;; whereas bar-1.3 requires toto-1.0 and the user has put a hold on toto-1.0:
915 ;; the current code might fail to see that it could install foo by using the
916 ;; older bar-1.3).
917 (dolist (elt requirements)
918 (let* ((next-pkg (car elt))
919 (next-version (cadr elt))
920 (already ()))
921 (dolist (pkg packages)
922 (if (eq next-pkg (package-desc-name pkg))
923 (setq already pkg)))
924 (cond
925 (already
926 (if (version-list-< next-version (package-desc-version already))
927 ;; Move to front, so it gets installed early enough (bug#14082).
928 (setq packages (cons already (delq already packages)))
929 (error "Need package `%s-%s', but only %s is available"
930 next-pkg (package-version-join next-version)
931 (package-version-join (package-desc-version already)))))
933 ((package-installed-p next-pkg next-version) nil)
936 ;; A package is required, but not installed. It might also be
937 ;; blocked via `package-load-list'.
938 (let ((pkg-descs (cdr (assq next-pkg package-archive-contents)))
939 (found nil)
940 (problem nil))
941 (while (and pkg-descs (not found))
942 (let* ((pkg-desc (pop pkg-descs))
943 (version (package-desc-version pkg-desc))
944 (disabled (package-disabled-p next-pkg version)))
945 (cond
946 ((version-list-< version next-version)
947 (error
948 "Need package `%s-%s', but only %s is available"
949 next-pkg (package-version-join next-version)
950 (package-version-join version)))
951 (disabled
952 (unless problem
953 (setq problem
954 (if (stringp disabled)
955 (format "Package `%s' held at version %s, \
956 but version %s required"
957 next-pkg disabled
958 (package-version-join next-version))
959 (format "Required package '%s' is disabled"
960 next-pkg)))))
961 (t (setq found pkg-desc)))))
962 (unless found
963 (if problem
964 (error problem)
965 (error "Package `%s-%s' is unavailable"
966 next-pkg (package-version-join next-version))))
967 (setq packages
968 (package-compute-transaction (cons found packages)
969 (package-desc-reqs found))))))))
970 packages)
972 (defun package-read-from-string (str)
973 "Read a Lisp expression from STR.
974 Signal an error if the entire string was not used."
975 (let* ((read-data (read-from-string str))
976 (more-left
977 (condition-case nil
978 ;; The call to `ignore' suppresses a compiler warning.
979 (progn (ignore (read-from-string
980 (substring str (cdr read-data))))
982 (end-of-file nil))))
983 (if more-left
984 (error "Can't read whole string")
985 (car read-data))))
987 (defun package--read-archive-file (file)
988 "Re-read archive file FILE, if it exists.
989 Will return the data from the file, or nil if the file does not exist.
990 Will throw an error if the archive version is too new."
991 (let ((filename (expand-file-name file package-user-dir)))
992 (when (file-exists-p filename)
993 (with-temp-buffer
994 (insert-file-contents-literally filename)
995 (let ((contents (read (current-buffer))))
996 (if (> (car contents) package-archive-version)
997 (error "Package archive version %d is higher than %d"
998 (car contents) package-archive-version))
999 (cdr contents))))))
1001 (defun package-read-all-archive-contents ()
1002 "Re-read `archive-contents', if it exists.
1003 If successful, set `package-archive-contents'."
1004 (setq package-archive-contents nil)
1005 (dolist (archive package-archives)
1006 (package-read-archive-contents (car archive))))
1008 (defun package-read-archive-contents (archive)
1009 "Re-read archive contents for ARCHIVE.
1010 If successful, set the variable `package-archive-contents'.
1011 If the archive version is too new, signal an error."
1012 ;; Version 1 of 'archive-contents' is identical to our internal
1013 ;; representation.
1014 (let* ((contents-file (format "archives/%s/archive-contents" archive))
1015 (contents (package--read-archive-file contents-file)))
1016 (when contents
1017 (dolist (package contents)
1018 (package--add-to-archive-contents package archive)))))
1020 ;; Package descriptor objects used inside the "archive-contents" file.
1021 ;; Changing this defstruct implies changing the format of the
1022 ;; "archive-contents" files.
1023 (cl-defstruct (package--ac-desc
1024 (:constructor package-make-ac-desc (version reqs summary kind extras))
1025 (:copier nil)
1026 (:type vector))
1027 version reqs summary kind extras)
1029 (defun package--add-to-archive-contents (package archive)
1030 "Add the PACKAGE from the given ARCHIVE if necessary.
1031 PACKAGE should have the form (NAME . PACKAGE--AC-DESC).
1032 Also, add the originating archive to the `package-desc' structure."
1033 (let* ((name (car package))
1034 (version (package--ac-desc-version (cdr package)))
1035 (pkg-desc
1036 (package-desc-create
1037 :name name
1038 :version version
1039 :reqs (package--ac-desc-reqs (cdr package))
1040 :summary (package--ac-desc-summary (cdr package))
1041 :kind (package--ac-desc-kind (cdr package))
1042 :archive archive
1043 :extras (and (> (length (cdr package)) 4)
1044 ;; Older archive-contents files have only 4
1045 ;; elements here.
1046 (package--ac-desc-extras (cdr package)))))
1047 (existing-packages (assq name package-archive-contents))
1048 (pinned-to-archive (assoc name package-pinned-packages)))
1049 (cond
1050 ;; Skip entirely if pinned to another archive or already installed.
1051 ((or (and pinned-to-archive
1052 (not (equal (cdr pinned-to-archive) archive)))
1053 (let ((bi (assq name package--builtin-versions)))
1054 (and bi (version-list-= version (cdr bi))))
1055 (let ((ins (cdr (assq name package-alist))))
1056 (and ins (version-list-= version
1057 (package-desc-version (car ins))))))
1058 nil)
1059 ((not existing-packages)
1060 (push (list name pkg-desc) package-archive-contents))
1062 (while
1063 (if (and (cdr existing-packages)
1064 (version-list-<
1065 version (package-desc-version (cadr existing-packages))))
1066 (setq existing-packages (cdr existing-packages))
1067 (push pkg-desc (cdr existing-packages))
1068 nil))))))
1070 (defun package-download-transaction (packages)
1071 "Download and install all the packages in PACKAGES.
1072 PACKAGES should be a list of package-desc.
1073 This function assumes that all package requirements in
1074 PACKAGES are satisfied, i.e. that PACKAGES is computed
1075 using `package-compute-transaction'."
1076 (mapc #'package-install-from-archive packages))
1078 ;;;###autoload
1079 (defun package-install (pkg)
1080 "Install the package PKG.
1081 PKG can be a package-desc or the package name of one the available packages
1082 in an archive in `package-archives'. Interactively, prompt for its name."
1083 (interactive
1084 (progn
1085 ;; Initialize the package system to get the list of package
1086 ;; symbols for completion.
1087 (unless package--initialized
1088 (package-initialize t))
1089 (unless package-archive-contents
1090 (package-refresh-contents))
1091 (list (intern (completing-read
1092 "Install package: "
1093 (mapcar (lambda (elt) (symbol-name (car elt)))
1094 package-archive-contents)
1095 nil t)))))
1096 (package-download-transaction
1097 (if (package-desc-p pkg)
1098 (package-compute-transaction (list pkg)
1099 (package-desc-reqs pkg))
1100 (package-compute-transaction ()
1101 (list (list pkg))))))
1103 (defun package-strip-rcs-id (str)
1104 "Strip RCS version ID from the version string STR.
1105 If the result looks like a dotted numeric version, return it.
1106 Otherwise return nil."
1107 (when str
1108 (when (string-match "\\`[ \t]*[$]Revision:[ \t]+" str)
1109 (setq str (substring str (match-end 0))))
1110 (condition-case nil
1111 (if (version-to-list str)
1112 str)
1113 (error nil))))
1115 (declare-function lm-homepage "lisp-mnt" (&optional file))
1117 (defun package--prepare-dependencies (deps)
1118 "Turn DEPS into an acceptable list of dependencies.
1120 Any parts missing a version string get a default version string
1121 of \"0\" (meaning any version) and an appropriate level of lists
1122 is wrapped around any parts requiring it."
1123 (cond
1124 ((not (listp deps))
1125 (error "Invalid requirement specifier: %S" deps))
1126 (t (mapcar (lambda (dep)
1127 (cond
1128 ((symbolp dep) `(,dep "0"))
1129 ((stringp dep)
1130 (error "Invalid requirement specifier: %S" dep))
1131 (t dep)))
1132 deps))))
1134 (defun package-buffer-info ()
1135 "Return a `package-desc' describing the package in the current buffer.
1137 If the buffer does not contain a conforming package, signal an
1138 error. If there is a package, narrow the buffer to the file's
1139 boundaries."
1140 (goto-char (point-min))
1141 (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
1142 (error "Package lacks a file header"))
1143 (let ((file-name (match-string-no-properties 1))
1144 (desc (match-string-no-properties 2))
1145 (start (line-beginning-position)))
1146 (unless (search-forward (concat ";;; " file-name ".el ends here"))
1147 (error "Package lacks a terminating comment"))
1148 ;; Try to include a trailing newline.
1149 (forward-line)
1150 (narrow-to-region start (point))
1151 (require 'lisp-mnt)
1152 ;; Use some headers we've invented to drive the process.
1153 (let* ((requires-str (lm-header "package-requires"))
1154 ;; Prefer Package-Version; if defined, the package author
1155 ;; probably wants us to use it. Otherwise try Version.
1156 (pkg-version
1157 (or (package-strip-rcs-id (lm-header "package-version"))
1158 (package-strip-rcs-id (lm-header "version"))))
1159 (homepage (lm-homepage)))
1160 (unless pkg-version
1161 (error
1162 "Package lacks a \"Version\" or \"Package-Version\" header"))
1163 (package-desc-from-define
1164 file-name pkg-version desc
1165 (if requires-str
1166 (package--prepare-dependencies
1167 (package-read-from-string requires-str)))
1168 :kind 'single
1169 :url homepage))))
1171 (declare-function tar-get-file-descriptor "tar-mode" (file))
1172 (declare-function tar--extract "tar-mode" (descriptor))
1174 (defun package-tar-file-info ()
1175 "Find package information for a tar file.
1176 The return result is a `package-desc'."
1177 (cl-assert (derived-mode-p 'tar-mode))
1178 (let* ((dir-name (file-name-directory
1179 (tar-header-name (car tar-parse-info))))
1180 (desc-file (package--description-file dir-name))
1181 (tar-desc (tar-get-file-descriptor (concat dir-name desc-file))))
1182 (unless tar-desc
1183 (error "No package descriptor file found"))
1184 (with-current-buffer (tar--extract tar-desc)
1185 (goto-char (point-min))
1186 (unwind-protect
1187 (let* ((pkg-def-parsed (read (current-buffer)))
1188 (pkg-desc
1189 (if (not (eq (car pkg-def-parsed) 'define-package))
1190 (error "Can't find define-package in %s"
1191 (tar-header-name tar-desc))
1192 (apply #'package-desc-from-define
1193 (append (cdr pkg-def-parsed))))))
1194 (setf (package-desc-kind pkg-desc) 'tar)
1195 pkg-desc)
1196 (kill-buffer (current-buffer))))))
1199 ;;;###autoload
1200 (defun package-install-from-buffer ()
1201 "Install a package from the current buffer.
1202 The current buffer is assumed to be a single .el or .tar file that follows the
1203 packaging guidelines; see info node `(elisp)Packaging'.
1204 Downloads and installs required packages as needed."
1205 (interactive)
1206 (let ((pkg-desc (if (derived-mode-p 'tar-mode)
1207 (package-tar-file-info)
1208 (package-buffer-info))))
1209 ;; Download and install the dependencies.
1210 (let* ((requires (package-desc-reqs pkg-desc))
1211 (transaction (package-compute-transaction nil requires)))
1212 (package-download-transaction transaction))
1213 ;; Install the package itself.
1214 (package-unpack pkg-desc)
1215 pkg-desc))
1217 ;;;###autoload
1218 (defun package-install-file (file)
1219 "Install a package from a file.
1220 The file can either be a tar file or an Emacs Lisp file."
1221 (interactive "fPackage file name: ")
1222 (with-temp-buffer
1223 (insert-file-contents-literally file)
1224 (when (string-match "\\.tar\\'" file) (tar-mode))
1225 (package-install-from-buffer)))
1227 (defun package-delete (pkg-desc)
1228 (let ((dir (package-desc-dir pkg-desc)))
1229 (if (not (string-prefix-p (file-name-as-directory
1230 (expand-file-name package-user-dir))
1231 (expand-file-name dir)))
1232 ;; Don't delete "system" packages.
1233 (error "Package `%s' is a system package, not deleting"
1234 (package-desc-full-name pkg-desc))
1235 (delete-directory dir t t)
1236 ;; Remove NAME-VERSION.signed file.
1237 (let ((signed-file (concat dir ".signed")))
1238 (if (file-exists-p signed-file)
1239 (delete-file signed-file)))
1240 ;; Update package-alist.
1241 (let* ((name (package-desc-name pkg-desc))
1242 (pkgs (assq name package-alist)))
1243 (delete pkg-desc pkgs)
1244 (unless (cdr pkgs)
1245 (setq package-alist (delq pkgs package-alist))))
1246 (message "Package `%s' deleted." (package-desc-full-name pkg-desc)))))
1248 (defun package-archive-base (desc)
1249 "Return the archive containing the package NAME."
1250 (cdr (assoc (package-desc-archive desc) package-archives)))
1252 (defun package--download-one-archive (archive file)
1253 "Retrieve an archive file FILE from ARCHIVE, and cache it.
1254 ARCHIVE should be a cons cell of the form (NAME . LOCATION),
1255 similar to an entry in `package-alist'. Save the cached copy to
1256 \"archives/NAME/archive-contents\" in `package-user-dir'."
1257 (let ((dir (expand-file-name (format "archives/%s" (car archive))
1258 package-user-dir))
1259 (sig-file (concat file ".sig"))
1260 good-signatures)
1261 (package--with-work-buffer (cdr archive) file
1262 ;; Check signature of archive-contents, if desired.
1263 (if (and package-check-signature
1264 (not (member archive package-unsigned-archives)))
1265 (if (package--archive-file-exists-p (cdr archive) sig-file)
1266 (setq good-signatures (package--check-signature (cdr archive)
1267 file))
1268 (unless (eq package-check-signature 'allow-unsigned)
1269 (error "Unsigned archive `%s'"
1270 (car archive)))))
1271 ;; Read the retrieved buffer to make sure it is valid (e.g. it
1272 ;; may fetch a URL redirect page).
1273 (when (listp (read buffer))
1274 (make-directory dir t)
1275 (setq buffer-file-name (expand-file-name file dir))
1276 (let ((version-control 'never)
1277 (require-final-newline nil))
1278 (save-buffer))))
1279 (when good-signatures
1280 ;; Write out good signatures into archive-contents.signed file.
1281 (write-region (mapconcat #'epg-signature-to-string good-signatures "\n")
1283 (expand-file-name (concat file ".signed") dir)
1284 nil 'silent))))
1286 (declare-function epg-check-configuration "epg-config"
1287 (config &optional minimum-version))
1288 (declare-function epg-configuration "epg-config" ())
1289 (declare-function epg-import-keys-from-file "epg" (context keys))
1291 ;;;###autoload
1292 (defun package-import-keyring (&optional file)
1293 "Import keys from FILE."
1294 (interactive "fFile: ")
1295 (setq file (expand-file-name file))
1296 (let ((context (epg-make-context 'OpenPGP))
1297 (homedir (expand-file-name "gnupg" package-user-dir)))
1298 (make-directory homedir t)
1299 (epg-context-set-home-directory context homedir)
1300 (message "Importing %s..." (file-name-nondirectory file))
1301 (epg-import-keys-from-file context file)
1302 (message "Importing %s...done" (file-name-nondirectory file))))
1304 ;;;###autoload
1305 (defun package-refresh-contents ()
1306 "Download the ELPA archive description if needed.
1307 This informs Emacs about the latest versions of all packages, and
1308 makes them available for download."
1309 (interactive)
1310 ;; FIXME: Do it asynchronously.
1311 (unless (file-exists-p package-user-dir)
1312 (make-directory package-user-dir t))
1313 (let ((default-keyring (expand-file-name "package-keyring.gpg"
1314 data-directory)))
1315 (if (file-exists-p default-keyring)
1316 (condition-case-unless-debug error
1317 (progn
1318 (epg-check-configuration (epg-configuration))
1319 (package-import-keyring default-keyring))
1320 (error (message "Cannot import default keyring: %S" (cdr error))))))
1321 (dolist (archive package-archives)
1322 (condition-case-unless-debug nil
1323 (package--download-one-archive archive "archive-contents")
1324 (error (message "Failed to download `%s' archive."
1325 (car archive)))))
1326 (package-read-all-archive-contents))
1328 ;;;###autoload
1329 (defun package-initialize (&optional no-activate)
1330 "Load Emacs Lisp packages, and activate them.
1331 The variable `package-load-list' controls which packages to load.
1332 If optional arg NO-ACTIVATE is non-nil, don't activate packages."
1333 (interactive)
1334 (setq package-alist nil)
1335 (package-load-all-descriptors)
1336 (package-read-all-archive-contents)
1337 (unless no-activate
1338 (dolist (elt package-alist)
1339 (package-activate (car elt))))
1340 (setq package--initialized t))
1343 ;;;; Package description buffer.
1345 ;;;###autoload
1346 (defun describe-package (package)
1347 "Display the full documentation of PACKAGE (a symbol)."
1348 (interactive
1349 (let* ((guess (function-called-at-point)))
1350 (require 'finder-inf nil t)
1351 ;; Load the package list if necessary (but don't activate them).
1352 (unless package--initialized
1353 (package-initialize t))
1354 (let ((packages (append (mapcar 'car package-alist)
1355 (mapcar 'car package-archive-contents)
1356 (mapcar 'car package--builtins))))
1357 (unless (memq guess packages)
1358 (setq guess nil))
1359 (setq packages (mapcar 'symbol-name packages))
1360 (let ((val
1361 (completing-read (if guess
1362 (format "Describe package (default %s): "
1363 guess)
1364 "Describe package: ")
1365 packages nil t nil nil guess)))
1366 (list (intern val))))))
1367 (if (not (or (package-desc-p package) (and package (symbolp package))))
1368 (message "No package specified")
1369 (help-setup-xref (list #'describe-package package)
1370 (called-interactively-p 'interactive))
1371 (with-help-window (help-buffer)
1372 (with-current-buffer standard-output
1373 (describe-package-1 package)))))
1375 (defun describe-package-1 (pkg)
1376 (require 'lisp-mnt)
1377 (let* ((desc (or
1378 (if (package-desc-p pkg) pkg)
1379 (cadr (assq pkg package-alist))
1380 (let ((built-in (assq pkg package--builtins)))
1381 (if built-in
1382 (package--from-builtin built-in)
1383 (cadr (assq pkg package-archive-contents))))))
1384 (name (if desc (package-desc-name desc) pkg))
1385 (pkg-dir (if desc (package-desc-dir desc)))
1386 (reqs (if desc (package-desc-reqs desc)))
1387 (version (if desc (package-desc-version desc)))
1388 (archive (if desc (package-desc-archive desc)))
1389 (extras (and desc (package-desc-extras desc)))
1390 (homepage (cdr (assoc :url extras)))
1391 (keywords (if desc (package-desc--keywords desc)))
1392 (built-in (eq pkg-dir 'builtin))
1393 (installable (and archive (not built-in)))
1394 (status (if desc (package-desc-status desc) "orphan"))
1395 (signed (if desc (package-desc-signed desc))))
1396 (prin1 name)
1397 (princ " is ")
1398 (princ (if (memq (aref status 0) '(?a ?e ?i ?o ?u)) "an " "a "))
1399 (princ status)
1400 (princ " package.\n\n")
1402 (insert " " (propertize "Status" 'font-lock-face 'bold) ": ")
1403 (cond (built-in
1404 (insert (propertize (capitalize status)
1405 'font-lock-face 'font-lock-builtin-face)
1406 "."))
1407 (pkg-dir
1408 (insert (propertize (if (equal status "unsigned")
1409 "Installed"
1410 (capitalize status)) ;FIXME: Why comment-face?
1411 'font-lock-face 'font-lock-comment-face))
1412 (insert " in `")
1413 ;; Todo: Add button for uninstalling.
1414 (help-insert-xref-button (abbreviate-file-name
1415 (file-name-as-directory pkg-dir))
1416 'help-package-def pkg-dir)
1417 (if (and (package-built-in-p name)
1418 (not (package-built-in-p name version)))
1419 (insert "',\n shadowing a "
1420 (propertize "built-in package"
1421 'font-lock-face 'font-lock-builtin-face))
1422 (insert "'"))
1423 (if signed
1424 (insert ".")
1425 (insert " (unsigned).")))
1426 (installable
1427 (insert (capitalize status))
1428 (insert " from " (format "%s" archive))
1429 (insert " -- ")
1430 (package-make-button
1431 "Install"
1432 'action 'package-install-button-action
1433 'package-desc desc))
1434 (t (insert (capitalize status) ".")))
1435 (insert "\n")
1436 (insert " " (propertize "Archive" 'font-lock-face 'bold)
1437 ": " (or archive "n/a") "\n")
1438 (and version
1439 (insert " "
1440 (propertize "Version" 'font-lock-face 'bold) ": "
1441 (package-version-join version) "\n"))
1443 (setq reqs (if desc (package-desc-reqs desc)))
1444 (when reqs
1445 (insert " " (propertize "Requires" 'font-lock-face 'bold) ": ")
1446 (let ((first t)
1447 name vers text)
1448 (dolist (req reqs)
1449 (setq name (car req)
1450 vers (cadr req)
1451 text (format "%s-%s" (symbol-name name)
1452 (package-version-join vers)))
1453 (cond (first (setq first nil))
1454 ((>= (+ 2 (current-column) (length text))
1455 (window-width))
1456 (insert ",\n "))
1457 (t (insert ", ")))
1458 (help-insert-xref-button text 'help-package name))
1459 (insert "\n")))
1460 (insert " " (propertize "Summary" 'font-lock-face 'bold)
1461 ": " (if desc (package-desc-summary desc)) "\n")
1462 (when homepage
1463 (insert " " (propertize "Homepage" 'font-lock-face 'bold) ": ")
1464 (help-insert-xref-button homepage 'help-url homepage)
1465 (insert "\n"))
1466 (when keywords
1467 (insert " " (propertize "Keywords" 'font-lock-face 'bold) ": ")
1468 (dolist (k keywords)
1469 (package-make-button
1471 'package-keyword k
1472 'action 'package-keyword-button-action)
1473 (insert " "))
1474 (insert "\n"))
1475 (let* ((all-pkgs (append (cdr (assq name package-alist))
1476 (cdr (assq name package-archive-contents))
1477 (let ((bi (assq name package--builtins)))
1478 (if bi (list (package--from-builtin bi))))))
1479 (other-pkgs (delete desc all-pkgs)))
1480 (when other-pkgs
1481 (insert " " (propertize "Other versions" 'font-lock-face 'bold) ": "
1482 (mapconcat
1483 (lambda (opkg)
1484 (let* ((ov (package-desc-version opkg))
1485 (dir (package-desc-dir opkg))
1486 (from (or (package-desc-archive opkg)
1487 (if (stringp dir) "installed" dir))))
1488 (if (not ov) (format "%s" from)
1489 (format "%s (%s)"
1490 (make-text-button (package-version-join ov) nil
1491 'face 'link
1492 'follow-link t
1493 'action
1494 (lambda (_button)
1495 (describe-package opkg)))
1496 from))))
1497 other-pkgs ", ")
1498 ".\n")))
1500 (insert "\n")
1502 (if built-in
1503 ;; For built-in packages, insert the commentary.
1504 (let ((fn (locate-file (format "%s.el" name) load-path
1505 load-file-rep-suffixes))
1506 (opoint (point)))
1507 (insert (or (lm-commentary fn) ""))
1508 (save-excursion
1509 (goto-char opoint)
1510 (when (re-search-forward "^;;; Commentary:\n" nil t)
1511 (replace-match ""))
1512 (while (re-search-forward "^\\(;+ ?\\)" nil t)
1513 (replace-match ""))))
1514 (let ((readme (expand-file-name (format "%s-readme.txt" name)
1515 package-user-dir))
1516 readme-string)
1517 ;; For elpa packages, try downloading the commentary. If that
1518 ;; fails, try an existing readme file in `package-user-dir'.
1519 (cond ((condition-case nil
1520 (save-excursion
1521 (package--with-work-buffer
1522 (package-archive-base desc)
1523 (format "%s-readme.txt" name)
1524 (setq buffer-file-name
1525 (expand-file-name readme package-user-dir))
1526 (let ((version-control 'never)
1527 (require-final-newline t))
1528 (save-buffer))
1529 (setq readme-string (buffer-string))
1531 (error nil))
1532 (insert readme-string))
1533 ((file-readable-p readme)
1534 (insert-file-contents readme)
1535 (goto-char (point-max))))))))
1537 (defun package-install-button-action (button)
1538 (let ((pkg-desc (button-get button 'package-desc)))
1539 (when (y-or-n-p (format "Install package `%s'? "
1540 (package-desc-full-name pkg-desc)))
1541 (package-install pkg-desc)
1542 (revert-buffer nil t)
1543 (goto-char (point-min)))))
1545 (defun package-keyword-button-action (button)
1546 (let ((pkg-keyword (button-get button 'package-keyword)))
1547 (package-show-package-list t (list pkg-keyword))))
1549 (defun package-make-button (text &rest props)
1550 (let ((button-text (if (display-graphic-p) text (concat "[" text "]")))
1551 (button-face (if (display-graphic-p)
1552 '(:box (:line-width 2 :color "dark grey")
1553 :background "light grey"
1554 :foreground "black")
1555 'link)))
1556 (apply 'insert-text-button button-text 'face button-face 'follow-link t
1557 props)))
1560 ;;;; Package menu mode.
1562 (defvar package-menu-mode-map
1563 (let ((map (make-sparse-keymap))
1564 (menu-map (make-sparse-keymap "Package")))
1565 (set-keymap-parent map tabulated-list-mode-map)
1566 (define-key map "\C-m" 'package-menu-describe-package)
1567 (define-key map "u" 'package-menu-mark-unmark)
1568 (define-key map "\177" 'package-menu-backup-unmark)
1569 (define-key map "d" 'package-menu-mark-delete)
1570 (define-key map "i" 'package-menu-mark-install)
1571 (define-key map "U" 'package-menu-mark-upgrades)
1572 (define-key map "r" 'package-menu-refresh)
1573 (define-key map "f" 'package-menu-filter)
1574 (define-key map "~" 'package-menu-mark-obsolete-for-deletion)
1575 (define-key map "x" 'package-menu-execute)
1576 (define-key map "h" 'package-menu-quick-help)
1577 (define-key map "?" 'package-menu-describe-package)
1578 (define-key map [menu-bar package-menu] (cons "Package" menu-map))
1579 (define-key menu-map [mq]
1580 '(menu-item "Quit" quit-window
1581 :help "Quit package selection"))
1582 (define-key menu-map [s1] '("--"))
1583 (define-key menu-map [mn]
1584 '(menu-item "Next" next-line
1585 :help "Next Line"))
1586 (define-key menu-map [mp]
1587 '(menu-item "Previous" previous-line
1588 :help "Previous Line"))
1589 (define-key menu-map [s2] '("--"))
1590 (define-key menu-map [mu]
1591 '(menu-item "Unmark" package-menu-mark-unmark
1592 :help "Clear any marks on a package and move to the next line"))
1593 (define-key menu-map [munm]
1594 '(menu-item "Unmark Backwards" package-menu-backup-unmark
1595 :help "Back up one line and clear any marks on that package"))
1596 (define-key menu-map [md]
1597 '(menu-item "Mark for Deletion" package-menu-mark-delete
1598 :help "Mark a package for deletion and move to the next line"))
1599 (define-key menu-map [mi]
1600 '(menu-item "Mark for Install" package-menu-mark-install
1601 :help "Mark a package for installation and move to the next line"))
1602 (define-key menu-map [mupgrades]
1603 '(menu-item "Mark Upgradable Packages" package-menu-mark-upgrades
1604 :help "Mark packages that have a newer version for upgrading"))
1605 (define-key menu-map [s3] '("--"))
1606 (define-key menu-map [mf]
1607 '(menu-item "Filter Package List..." package-menu-filter
1608 :help "Filter package selection (q to go back)"))
1609 (define-key menu-map [mg]
1610 '(menu-item "Update Package List" revert-buffer
1611 :help "Update the list of packages"))
1612 (define-key menu-map [mr]
1613 '(menu-item "Refresh Package List" package-menu-refresh
1614 :help "Download the ELPA archive"))
1615 (define-key menu-map [s4] '("--"))
1616 (define-key menu-map [mt]
1617 '(menu-item "Mark Obsolete Packages" package-menu-mark-obsolete-for-deletion
1618 :help "Mark all obsolete packages for deletion"))
1619 (define-key menu-map [mx]
1620 '(menu-item "Execute Actions" package-menu-execute
1621 :help "Perform all the marked actions"))
1622 (define-key menu-map [s5] '("--"))
1623 (define-key menu-map [mh]
1624 '(menu-item "Help" package-menu-quick-help
1625 :help "Show short key binding help for package-menu-mode"))
1626 (define-key menu-map [mc]
1627 '(menu-item "View Commentary" package-menu-view-commentary
1628 :help "Display information about this package"))
1629 map)
1630 "Local keymap for `package-menu-mode' buffers.")
1632 (defvar package-menu--new-package-list nil
1633 "List of newly-available packages since `list-packages' was last called.")
1635 (define-derived-mode package-menu-mode tabulated-list-mode "Package Menu"
1636 "Major mode for browsing a list of packages.
1637 Letters do not insert themselves; instead, they are commands.
1638 \\<package-menu-mode-map>
1639 \\{package-menu-mode-map}"
1640 (setq tabulated-list-format
1641 `[("Package" 18 package-menu--name-predicate)
1642 ("Version" 12 nil)
1643 ("Status" 10 package-menu--status-predicate)
1644 ,@(if (cdr package-archives)
1645 '(("Archive" 10 package-menu--archive-predicate)))
1646 ("Description" 0 nil)])
1647 (setq tabulated-list-padding 2)
1648 (setq tabulated-list-sort-key (cons "Status" nil))
1649 (add-hook 'tabulated-list-revert-hook 'package-menu--refresh nil t)
1650 (tabulated-list-init-header))
1652 (defmacro package--push (pkg-desc status listname)
1653 "Convenience macro for `package-menu--generate'.
1654 If the alist stored in the symbol LISTNAME lacks an entry for a
1655 package PKG-DESC, add one. The alist is keyed with PKG-DESC."
1656 `(unless (assoc ,pkg-desc ,listname)
1657 ;; FIXME: Should we move status into pkg-desc?
1658 (push (cons ,pkg-desc ,status) ,listname)))
1660 (defvar package-list-unversioned nil
1661 "If non-nil include packages that don't have a version in `list-package'.")
1663 (defun package-desc-status (pkg-desc)
1664 (let* ((name (package-desc-name pkg-desc))
1665 (dir (package-desc-dir pkg-desc))
1666 (lle (assq name package-load-list))
1667 (held (cadr lle))
1668 (version (package-desc-version pkg-desc))
1669 (signed (package-desc-signed pkg-desc)))
1670 (cond
1671 ((eq dir 'builtin) "built-in")
1672 ((and lle (null held)) "disabled")
1673 ((stringp held)
1674 (let ((hv (if (stringp held) (version-to-list held))))
1675 (cond
1676 ((version-list-= version hv) "held")
1677 ((version-list-< version hv) "obsolete")
1678 (t "disabled"))))
1679 ((package-built-in-p name version) "obsolete")
1680 (dir ;One of the installed packages.
1681 (cond
1682 ((not (file-exists-p (package-desc-dir pkg-desc))) "deleted")
1683 ((eq pkg-desc (cadr (assq name package-alist))) (if signed
1684 "installed"
1685 "unsigned"))
1686 (t "obsolete")))
1688 (let* ((ins (cadr (assq name package-alist)))
1689 (ins-v (if ins (package-desc-version ins))))
1690 (cond
1691 ((or (null ins) (version-list-< ins-v version))
1692 (if (memq name package-menu--new-package-list)
1693 "new" "available"))
1694 ((version-list-< version ins-v) "obsolete")
1695 ((version-list-= version ins-v) (if signed
1696 "installed"
1697 "unsigned"))))))))
1699 (defun package-menu--refresh (&optional packages keywords)
1700 "Re-populate the `tabulated-list-entries'.
1701 PACKAGES should be nil or t, which means to display all known packages.
1702 KEYWORDS should be nil or a list of keywords."
1703 ;; Construct list of (PKG-DESC . STATUS).
1704 (unless packages (setq packages t))
1705 (let (info-list name)
1706 ;; Installed packages:
1707 (dolist (elt package-alist)
1708 (setq name (car elt))
1709 (when (or (eq packages t) (memq name packages))
1710 (dolist (pkg (cdr elt))
1711 (when (package--has-keyword-p pkg keywords)
1712 (package--push pkg (package-desc-status pkg) info-list)))))
1714 ;; Built-in packages:
1715 (dolist (elt package--builtins)
1716 (setq name (car elt))
1717 (when (and (not (eq name 'emacs)) ; Hide the `emacs' package.
1718 (package--has-keyword-p (package--from-builtin elt) keywords)
1719 (or package-list-unversioned
1720 (package--bi-desc-version (cdr elt)))
1721 (or (eq packages t) (memq name packages)))
1722 (package--push (package--from-builtin elt) "built-in" info-list)))
1724 ;; Available and disabled packages:
1725 (dolist (elt package-archive-contents)
1726 (setq name (car elt))
1727 (when (or (eq packages t) (memq name packages))
1728 (dolist (pkg (cdr elt))
1729 ;; Hide obsolete packages.
1730 (when (and (not (package-installed-p (package-desc-name pkg)
1731 (package-desc-version pkg)))
1732 (package--has-keyword-p pkg keywords))
1733 (package--push pkg (package-desc-status pkg) info-list)))))
1735 ;; Print the result.
1736 (setq tabulated-list-entries
1737 (mapcar #'package-menu--print-info info-list))))
1739 (defun package-all-keywords ()
1740 "Collect all package keywords"
1741 (let (keywords)
1742 (package--mapc (lambda (desc)
1743 (let* ((desc-keywords (and desc (package-desc--keywords desc))))
1744 (setq keywords (append keywords desc-keywords)))))
1745 keywords))
1747 (defun package--mapc (function &optional packages)
1748 "Call FUNCTION for all known PACKAGES.
1749 PACKAGES can be nil or t, which means to display all known
1750 packages, or a list of packages.
1752 Built-in packages are converted with `package--from-builtin'."
1753 (unless packages (setq packages t))
1754 (let (name)
1755 ;; Installed packages:
1756 (dolist (elt package-alist)
1757 (setq name (car elt))
1758 (when (or (eq packages t) (memq name packages))
1759 (mapc function (cdr elt))))
1761 ;; Built-in packages:
1762 (dolist (elt package--builtins)
1763 (setq name (car elt))
1764 (when (and (not (eq name 'emacs)) ; Hide the `emacs' package.
1765 (or package-list-unversioned
1766 (package--bi-desc-version (cdr elt)))
1767 (or (eq packages t) (memq name packages)))
1768 (funcall function (package--from-builtin elt))))
1770 ;; Available and disabled packages:
1771 (dolist (elt package-archive-contents)
1772 (setq name (car elt))
1773 (when (or (eq packages t) (memq name packages))
1774 (dolist (pkg (cdr elt))
1775 ;; Hide obsolete packages.
1776 (unless (package-installed-p (package-desc-name pkg)
1777 (package-desc-version pkg))
1778 (funcall function pkg)))))))
1780 (defun package--has-keyword-p (desc &optional keywords)
1781 "Test if package DESC has any of the given KEYWORDS.
1782 When none are given, the package matches."
1783 (if keywords
1784 (let* ((desc-keywords (and desc (package-desc--keywords desc)))
1785 found)
1786 (dolist (k keywords)
1787 (when (and (not found)
1788 (member k desc-keywords))
1789 (setq found t)))
1790 found)
1793 (defun package-menu--generate (remember-pos packages &optional keywords)
1794 "Populate the Package Menu.
1795 If REMEMBER-POS is non-nil, keep point on the same entry.
1796 PACKAGES should be t, which means to display all known packages,
1797 or a list of package names (symbols) to display.
1799 With KEYWORDS given, only packages with those keywords are
1800 shown."
1801 (package-menu--refresh packages keywords)
1802 (setf (car (aref tabulated-list-format 0))
1803 (if keywords
1804 (let ((filters (mapconcat 'identity keywords ",")))
1805 (concat "Package[" filters "]"))
1806 "Package"))
1807 (if keywords
1808 (define-key package-menu-mode-map "q" 'package-show-package-list)
1809 (define-key package-menu-mode-map "q" 'quit-window))
1810 (tabulated-list-init-header)
1811 (tabulated-list-print remember-pos))
1813 (defun package-menu--print-info (pkg)
1814 "Return a package entry suitable for `tabulated-list-entries'.
1815 PKG has the form (PKG-DESC . STATUS).
1816 Return (PKG-DESC [NAME VERSION STATUS DOC])."
1817 (let* ((pkg-desc (car pkg))
1818 (status (cdr pkg))
1819 (face (pcase status
1820 (`"built-in" 'font-lock-builtin-face)
1821 (`"available" 'default)
1822 (`"new" 'bold)
1823 (`"held" 'font-lock-constant-face)
1824 (`"disabled" 'font-lock-warning-face)
1825 (`"installed" 'font-lock-comment-face)
1826 (`"unsigned" 'font-lock-warning-face)
1827 (_ 'font-lock-warning-face)))) ; obsolete.
1828 (list pkg-desc
1829 `[,(list (symbol-name (package-desc-name pkg-desc))
1830 'face 'link
1831 'follow-link t
1832 'package-desc pkg-desc
1833 'action 'package-menu-describe-package)
1834 ,(propertize (package-version-join
1835 (package-desc-version pkg-desc))
1836 'font-lock-face face)
1837 ,(propertize status 'font-lock-face face)
1838 ,@(if (cdr package-archives)
1839 (list (propertize (or (package-desc-archive pkg-desc) "")
1840 'font-lock-face face)))
1841 ,(propertize (package-desc-summary pkg-desc)
1842 'font-lock-face face)])))
1844 (defun package-menu-refresh ()
1845 "Download the Emacs Lisp package archive.
1846 This fetches the contents of each archive specified in
1847 `package-archives', and then refreshes the package menu."
1848 (interactive)
1849 (unless (derived-mode-p 'package-menu-mode)
1850 (user-error "The current buffer is not a Package Menu"))
1851 (package-refresh-contents)
1852 (package-menu--generate t t))
1854 (defun package-menu-describe-package (&optional button)
1855 "Describe the current package.
1856 If optional arg BUTTON is non-nil, describe its associated package."
1857 (interactive)
1858 (let ((pkg-desc (if button (button-get button 'package-desc)
1859 (tabulated-list-get-id))))
1860 (if pkg-desc
1861 (describe-package pkg-desc)
1862 (user-error "No package here"))))
1864 ;; fixme numeric argument
1865 (defun package-menu-mark-delete (&optional _num)
1866 "Mark a package for deletion and move to the next line."
1867 (interactive "p")
1868 (if (member (package-menu-get-status) '("installed" "obsolete" "unsigned"))
1869 (tabulated-list-put-tag "D" t)
1870 (forward-line)))
1872 (defun package-menu-mark-install (&optional _num)
1873 "Mark a package for installation and move to the next line."
1874 (interactive "p")
1875 (if (member (package-menu-get-status) '("available" "new"))
1876 (tabulated-list-put-tag "I" t)
1877 (forward-line)))
1879 (defun package-menu-mark-unmark (&optional _num)
1880 "Clear any marks on a package and move to the next line."
1881 (interactive "p")
1882 (tabulated-list-put-tag " " t))
1884 (defun package-menu-backup-unmark ()
1885 "Back up one line and clear any marks on that package."
1886 (interactive)
1887 (forward-line -1)
1888 (tabulated-list-put-tag " "))
1890 (defun package-menu-mark-obsolete-for-deletion ()
1891 "Mark all obsolete packages for deletion."
1892 (interactive)
1893 (save-excursion
1894 (goto-char (point-min))
1895 (while (not (eobp))
1896 (if (equal (package-menu-get-status) "obsolete")
1897 (tabulated-list-put-tag "D" t)
1898 (forward-line 1)))))
1900 (defun package-menu-quick-help ()
1901 "Show short key binding help for package-menu-mode."
1902 (interactive)
1903 (message "n-ext, i-nstall, d-elete, u-nmark, x-ecute, r-efresh, h-elp"))
1905 (define-obsolete-function-alias
1906 'package-menu-view-commentary 'package-menu-describe-package "24.1")
1908 (defun package-menu-get-status ()
1909 (let* ((id (tabulated-list-get-id))
1910 (entry (and id (assq id tabulated-list-entries))))
1911 (if entry
1912 (aref (cadr entry) 2)
1913 "")))
1915 (defun package-menu--find-upgrades ()
1916 (let (installed available upgrades)
1917 ;; Build list of installed/available packages in this buffer.
1918 (dolist (entry tabulated-list-entries)
1919 ;; ENTRY is (PKG-DESC [NAME VERSION STATUS DOC])
1920 (let ((pkg-desc (car entry))
1921 (status (aref (cadr entry) 2)))
1922 (cond ((member status '("installed" "unsigned"))
1923 (push pkg-desc installed))
1924 ((member status '("available" "new"))
1925 (push (cons (package-desc-name pkg-desc) pkg-desc)
1926 available)))))
1927 ;; Loop through list of installed packages, finding upgrades.
1928 (dolist (pkg-desc installed)
1929 (let ((avail-pkg (assq (package-desc-name pkg-desc) available)))
1930 (and avail-pkg
1931 (version-list-< (package-desc-version pkg-desc)
1932 (package-desc-version (cdr avail-pkg)))
1933 (push avail-pkg upgrades))))
1934 upgrades))
1936 (defun package-menu-mark-upgrades ()
1937 "Mark all upgradable packages in the Package Menu.
1938 For each installed package with a newer version available, place
1939 an (I)nstall flag on the available version and a (D)elete flag on
1940 the installed version. A subsequent \\[package-menu-execute]
1941 call will upgrade the package."
1942 (interactive)
1943 (unless (derived-mode-p 'package-menu-mode)
1944 (error "The current buffer is not a Package Menu"))
1945 (let ((upgrades (package-menu--find-upgrades)))
1946 (if (null upgrades)
1947 (message "No packages to upgrade.")
1948 (widen)
1949 (save-excursion
1950 (goto-char (point-min))
1951 (while (not (eobp))
1952 (let* ((pkg-desc (tabulated-list-get-id))
1953 (upgrade (cdr (assq (package-desc-name pkg-desc) upgrades))))
1954 (cond ((null upgrade)
1955 (forward-line 1))
1956 ((equal pkg-desc upgrade)
1957 (package-menu-mark-install))
1959 (package-menu-mark-delete))))))
1960 (message "%d package%s marked for upgrading."
1961 (length upgrades)
1962 (if (= (length upgrades) 1) "" "s")))))
1964 (defun package-menu-execute (&optional noquery)
1965 "Perform marked Package Menu actions.
1966 Packages marked for installation are downloaded and installed;
1967 packages marked for deletion are removed.
1968 Optional argument NOQUERY non-nil means do not ask the user to confirm."
1969 (interactive)
1970 (unless (derived-mode-p 'package-menu-mode)
1971 (error "The current buffer is not in Package Menu mode"))
1972 (let (install-list delete-list cmd pkg-desc)
1973 (save-excursion
1974 (goto-char (point-min))
1975 (while (not (eobp))
1976 (setq cmd (char-after))
1977 (unless (eq cmd ?\s)
1978 ;; This is the key PKG-DESC.
1979 (setq pkg-desc (tabulated-list-get-id))
1980 (cond ((eq cmd ?D)
1981 (push pkg-desc delete-list))
1982 ((eq cmd ?I)
1983 (push pkg-desc install-list))))
1984 (forward-line)))
1985 (when install-list
1986 (if (or
1987 noquery
1988 (yes-or-no-p
1989 (if (= (length install-list) 1)
1990 (format "Install package `%s'? "
1991 (package-desc-full-name (car install-list)))
1992 (format "Install these %d packages (%s)? "
1993 (length install-list)
1994 (mapconcat #'package-desc-full-name
1995 install-list ", ")))))
1996 (mapc 'package-install install-list)))
1997 ;; Delete packages, prompting if necessary.
1998 (when delete-list
1999 (if (or
2000 noquery
2001 (yes-or-no-p
2002 (if (= (length delete-list) 1)
2003 (format "Delete package `%s'? "
2004 (package-desc-full-name (car delete-list)))
2005 (format "Delete these %d packages (%s)? "
2006 (length delete-list)
2007 (mapconcat #'package-desc-full-name
2008 delete-list ", ")))))
2009 (dolist (elt delete-list)
2010 (condition-case-unless-debug err
2011 (package-delete elt)
2012 (error (message (cadr err)))))
2013 (error "Aborted")))
2014 (if (or delete-list install-list)
2015 (package-menu--generate t t)
2016 (message "No operations specified."))))
2018 (defun package-menu--version-predicate (A B)
2019 (let ((vA (or (aref (cadr A) 1) '(0)))
2020 (vB (or (aref (cadr B) 1) '(0))))
2021 (if (version-list-= vA vB)
2022 (package-menu--name-predicate A B)
2023 (version-list-< vA vB))))
2025 (defun package-menu--status-predicate (A B)
2026 (let ((sA (aref (cadr A) 2))
2027 (sB (aref (cadr B) 2)))
2028 (cond ((string= sA sB)
2029 (package-menu--name-predicate A B))
2030 ((string= sA "new") t)
2031 ((string= sB "new") nil)
2032 ((string= sA "available") t)
2033 ((string= sB "available") nil)
2034 ((string= sA "installed") t)
2035 ((string= sB "installed") nil)
2036 ((string= sA "unsigned") t)
2037 ((string= sB "unsigned") nil)
2038 ((string= sA "held") t)
2039 ((string= sB "held") nil)
2040 ((string= sA "built-in") t)
2041 ((string= sB "built-in") nil)
2042 ((string= sA "obsolete") t)
2043 ((string= sB "obsolete") nil)
2044 (t (string< sA sB)))))
2046 (defun package-menu--description-predicate (A B)
2047 (let ((dA (aref (cadr A) 3))
2048 (dB (aref (cadr B) 3)))
2049 (if (string= dA dB)
2050 (package-menu--name-predicate A B)
2051 (string< dA dB))))
2053 (defun package-menu--name-predicate (A B)
2054 (string< (symbol-name (package-desc-name (car A)))
2055 (symbol-name (package-desc-name (car B)))))
2057 (defun package-menu--archive-predicate (A B)
2058 (string< (or (package-desc-archive (car A)) "")
2059 (or (package-desc-archive (car B)) "")))
2061 ;;;###autoload
2062 (defun list-packages (&optional no-fetch)
2063 "Display a list of packages.
2064 This first fetches the updated list of packages before
2065 displaying, unless a prefix argument NO-FETCH is specified.
2066 The list is displayed in a buffer named `*Packages*'."
2067 (interactive "P")
2068 (require 'finder-inf nil t)
2069 ;; Initialize the package system if necessary.
2070 (unless package--initialized
2071 (package-initialize t))
2072 (let (old-archives new-packages)
2073 (unless no-fetch
2074 ;; Read the locally-cached archive-contents.
2075 (package-read-all-archive-contents)
2076 (setq old-archives package-archive-contents)
2077 ;; Fetch the remote list of packages.
2078 (package-refresh-contents)
2079 ;; Find which packages are new.
2080 (dolist (elt package-archive-contents)
2081 (unless (assq (car elt) old-archives)
2082 (push (car elt) new-packages))))
2084 ;; Generate the Package Menu.
2085 (let ((buf (get-buffer-create "*Packages*")))
2086 (with-current-buffer buf
2087 (package-menu-mode)
2088 (set (make-local-variable 'package-menu--new-package-list)
2089 new-packages)
2090 (package-menu--generate nil t))
2091 ;; The package menu buffer has keybindings. If the user types
2092 ;; `M-x list-packages', that suggests it should become current.
2093 (switch-to-buffer buf))
2095 (let ((upgrades (package-menu--find-upgrades)))
2096 (if upgrades
2097 (message "%d package%s can be upgraded; type `%s' to mark %s for upgrading."
2098 (length upgrades)
2099 (if (= (length upgrades) 1) "" "s")
2100 (substitute-command-keys "\\[package-menu-mark-upgrades]")
2101 (if (= (length upgrades) 1) "it" "them"))))))
2103 ;;;###autoload
2104 (defalias 'package-list-packages 'list-packages)
2106 ;; Used in finder.el
2107 (defun package-show-package-list (&optional packages keywords)
2108 "Display PACKAGES in a *Packages* buffer.
2109 This is similar to `list-packages', but it does not fetch the
2110 updated list of packages, and it only displays packages with
2111 names in PACKAGES (which should be a list of symbols).
2113 When KEYWORDS are given, only packages with those KEYWORDS are
2114 shown."
2115 (interactive)
2116 (require 'finder-inf nil t)
2117 (let ((buf (get-buffer-create "*Packages*")))
2118 (with-current-buffer buf
2119 (package-menu-mode)
2120 (package-menu--generate nil packages keywords))
2121 (switch-to-buffer buf)))
2123 ;; package-menu--generate rebinds "q" on the fly, so we have to
2124 ;; hard-code the binding in the doc-string here.
2125 (defun package-menu-filter (keyword)
2126 "Filter the *Packages* buffer.
2127 Show only those items that relate to the specified KEYWORD.
2128 To restore the full package list, type `q'."
2129 (interactive (list (completing-read "Keyword: " (package-all-keywords))))
2130 (package-show-package-list t (list keyword)))
2132 (defun package-list-packages-no-fetch ()
2133 "Display a list of packages.
2134 Does not fetch the updated list of packages before displaying.
2135 The list is displayed in a buffer named `*Packages*'."
2136 (interactive)
2137 (list-packages t))
2139 (provide 'package)
2141 ;;; package.el ends here