* lisp/emacs-lisp/package.el (package-autoload-ensure-default-file):
[emacs.git] / lisp / emacs-lisp / package.el
blobc80b8d970dc6e6010d428cdce161f25829d47bae
1 ;;; package.el --- Simple package system for Emacs
3 ;; Copyright (C) 2007-2013 Free Software Foundation, Inc.
5 ;; Author: Tom Tromey <tromey@redhat.com>
6 ;; Created: 10 Mar 2007
7 ;; Version: 1.0.1
8 ;; Keywords: tools
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Change Log:
27 ;; 2 Apr 2007 - now using ChangeLog file
28 ;; 15 Mar 2007 - updated documentation
29 ;; 14 Mar 2007 - Changed how obsolete packages are handled
30 ;; 13 Mar 2007 - Wrote package-install-from-buffer
31 ;; 12 Mar 2007 - Wrote package-menu mode
33 ;;; Commentary:
35 ;; The idea behind package.el is to be able to download packages and
36 ;; install them. Packages are versioned and have versioned
37 ;; dependencies. Furthermore, this supports built-in packages which
38 ;; may or may not be newer than user-specified packages. This makes
39 ;; it possible to upgrade Emacs and automatically disable packages
40 ;; which have moved from external to core. (Note though that we don't
41 ;; currently register any of these, so this feature does not actually
42 ;; work.)
44 ;; A package is described by its name and version. The distribution
45 ;; format is either a tar file or a single .el file.
47 ;; A tar file should be named "NAME-VERSION.tar". The tar file must
48 ;; unpack into a directory named after the package and version:
49 ;; "NAME-VERSION". It must contain a file named "PACKAGE-pkg.el"
50 ;; which consists of a call to define-package. It may also contain a
51 ;; "dir" file and the info files it references.
53 ;; A .el file is named "NAME-VERSION.el" in the remote archive, but is
54 ;; installed as simply "NAME.el" in a directory named "NAME-VERSION".
56 ;; The downloader downloads all dependent packages. By default,
57 ;; packages come from the official GNU sources, but others may be
58 ;; added by customizing the `package-archives' alist. Packages get
59 ;; byte-compiled at install time.
61 ;; At activation time we will set up the load-path and the info path,
62 ;; and we will load the package's autoloads. If a package's
63 ;; dependencies are not available, we will not activate that package.
65 ;; Conceptually a package has multiple state transitions:
67 ;; * Download. Fetching the package from ELPA.
68 ;; * Install. Untar the package, or write the .el file, into
69 ;; ~/.emacs.d/elpa/ directory.
70 ;; * Byte compile. Currently this phase is done during install,
71 ;; but we may change this.
72 ;; * Activate. Evaluate the autoloads for the package to make it
73 ;; available to the user.
74 ;; * Load. Actually load the package and run some code from it.
76 ;; Other external functions you may want to use:
78 ;; M-x list-packages
79 ;; Enters a mode similar to buffer-menu which lets you manage
80 ;; packages. You can choose packages for install (mark with "i",
81 ;; then "x" to execute) or deletion (not implemented yet), and you
82 ;; can see what packages are available. This will automatically
83 ;; fetch the latest list of packages from ELPA.
85 ;; M-x package-install-from-buffer
86 ;; Install a package consisting of a single .el file that appears
87 ;; in the current buffer. This only works for packages which
88 ;; define a Version header properly; package.el also supports the
89 ;; extension headers Package-Version (in case Version is an RCS id
90 ;; or similar), and Package-Requires (if the package requires other
91 ;; packages).
93 ;; M-x package-install-file
94 ;; Install a package from the indicated file. The package can be
95 ;; either a tar file or a .el file. A tar file must contain an
96 ;; appropriately-named "-pkg.el" file; a .el file must be properly
97 ;; formatted as with package-install-from-buffer.
99 ;;; Thanks:
100 ;;; (sorted by sort-lines):
102 ;; Jim Blandy <jimb@red-bean.com>
103 ;; Karl Fogel <kfogel@red-bean.com>
104 ;; Kevin Ryde <user42@zip.com.au>
105 ;; Lawrence Mitchell
106 ;; Michael Olson <mwolson@member.fsf.org>
107 ;; Sebastian Tennant <sebyte@smolny.plus.com>
108 ;; Stefan Monnier <monnier@iro.umontreal.ca>
109 ;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
110 ;; Phil Hagelberg <phil@hagelb.org>
112 ;;; ToDo:
114 ;; - a trust mechanism, since compiling a package can run arbitrary code.
115 ;; For example, download package signatures and check that they match.
116 ;; - putting info dirs at the start of the info path means
117 ;; users see a weird ordering of categories. OTOH we want to
118 ;; override later entries. maybe emacs needs to enforce
119 ;; the standard layout?
120 ;; - put bytecode in a separate directory tree
121 ;; - perhaps give users a way to recompile their bytecode
122 ;; or do it automatically when emacs changes
123 ;; - give users a way to know whether a package is installed ok
124 ;; - give users a way to view a package's documentation when it
125 ;; only appears in the .el
126 ;; - use/extend checkdoc so people can tell if their package will work
127 ;; - "installed" instead of a blank in the status column
128 ;; - tramp needs its files to be compiled in a certain order.
129 ;; how to handle this? fix tramp?
130 ;; - on emacs 21 we don't kill the -autoloads.el buffer. what about 22?
131 ;; - maybe we need separate .elc directories for various emacs versions
132 ;; and also emacs-vs-xemacs. That way conditional compilation can
133 ;; work. But would this break anything?
134 ;; - should store the package's keywords in archive-contents, then
135 ;; let the users filter the package-menu by keyword. See
136 ;; finder-by-keyword. (We could also let people view the
137 ;; Commentary, but it isn't clear how useful this is.)
138 ;; - William Xu suggests being able to open a package file without
139 ;; installing it
140 ;; - Interface with desktop.el so that restarting after an install
141 ;; works properly
142 ;; - Implement M-x package-upgrade, to upgrade any/all existing packages
143 ;; - Use hierarchical layout. PKG/etc PKG/lisp PKG/info
144 ;; ... except maybe lisp?
145 ;; - It may be nice to have a macro that expands to the package's
146 ;; private data dir, aka ".../etc". Or, maybe data-directory
147 ;; needs to be a list (though this would be less nice)
148 ;; a few packages want this, eg sokoban
149 ;; - package menu needs:
150 ;; ability to know which packages are built-in & thus not deletable
151 ;; it can sometimes print odd results, like 0.3 available but 0.4 active
152 ;; why is that?
153 ;; - Allow multiple versions on the server...?
154 ;; [ why bother? ]
155 ;; - Don't install a package which will invalidate dependencies overall
156 ;; - Allow something like (or (>= emacs 21.0) (>= xemacs 21.5))
157 ;; [ currently thinking, why bother.. KISS ]
158 ;; - Allow optional package dependencies
159 ;; then if we require 'bbdb', bbdb-specific lisp in lisp/bbdb
160 ;; and just don't compile to add to load path ...?
161 ;; - Have a list of archive URLs? [ maybe there's no point ]
162 ;; - David Kastrup pointed out on the xemacs list that for GPL it
163 ;; is friendlier to ship the source tree. We could "support" that
164 ;; by just having a "src" subdir in the package. This isn't ideal
165 ;; but it probably is not worth trying to support random source
166 ;; tree layouts, build schemes, etc.
167 ;; - Our treatment of the info path is somewhat bogus
168 ;; - perhaps have an "unstable" tree in ELPA as well as a stable one
170 ;;; Code:
172 (require 'tabulated-list)
174 (defgroup package nil
175 "Manager for Emacs Lisp packages."
176 :group 'applications
177 :version "24.1")
179 ;;;###autoload
180 (defcustom package-enable-at-startup t
181 "Whether to activate installed packages when Emacs starts.
182 If non-nil, packages are activated after reading the init file
183 and before `after-init-hook'. Activation is not done if
184 `user-init-file' is nil (e.g. Emacs was started with \"-q\").
186 Even if the value is nil, you can type \\[package-initialize] to
187 activate the package system at any time."
188 :type 'boolean
189 :group 'package
190 :version "24.1")
192 (defcustom package-load-list '(all)
193 "List of packages for `package-initialize' to load.
194 Each element in this list should be a list (NAME VERSION), or the
195 symbol `all'. The symbol `all' says to load the latest installed
196 versions of all packages not specified by other elements.
198 For an element (NAME VERSION), NAME is a package name (a symbol).
199 VERSION should be t, a string, or nil.
200 If VERSION is t, all versions are loaded, though obsolete ones
201 will be put in `package-obsolete-alist' and not activated.
202 If VERSION is a string, only that version is ever loaded.
203 Any other version, even if newer, is silently ignored.
204 Hence, the package is \"held\" at that version.
205 If VERSION is nil, the package is not loaded (it is \"disabled\")."
206 :type '(repeat symbol)
207 :risky t
208 :group 'package
209 :version "24.1")
211 (defvar Info-directory-list)
212 (declare-function info-initialize "info" ())
213 (declare-function url-http-parse-response "url-http" ())
214 (declare-function lm-header "lisp-mnt" (header))
215 (declare-function lm-commentary "lisp-mnt" (&optional file))
216 (defvar url-http-end-of-headers)
218 (defcustom package-archives '(("gnu" . "http://elpa.gnu.org/packages/"))
219 "An alist of archives from which to fetch.
220 The default value points to the GNU Emacs package repository.
222 Each element has the form (ID . LOCATION).
223 ID is an archive name, as a string.
224 LOCATION specifies the base location for the archive.
225 If it starts with \"http:\", it is treated as a HTTP URL;
226 otherwise it should be an absolute directory name.
227 (Other types of URL are currently not supported.)
229 Only add locations that you trust, since fetching and installing
230 a package can run arbitrary code."
231 :type '(alist :key-type (string :tag "Archive name")
232 :value-type (string :tag "URL or directory name"))
233 :risky t
234 :group 'package
235 :version "24.1")
237 (defcustom package-pinned-packages nil
238 "An alist of packages that are pinned to a specific archive
240 Each element has the form (SYM . ID).
241 SYM is a package, as a symbol.
242 ID is an archive name, as a string. This should correspond to an
243 entry in `package-archives'.
245 If the archive of name ID does not contain the package SYM, no
246 other location will be considered, which will make the
247 package unavailable."
248 :type '(alist :key-type (symbol :tag "Package")
249 :value-type (string :tag "Archive name"))
250 :risky t
251 :group 'package
252 :version "24.4")
254 (defconst package-archive-version 1
255 "Version number of the package archive understood by this file.
256 Lower version numbers than this will probably be understood as well.")
258 (defconst package-el-version "1.0.1"
259 "Version of package.el.")
261 ;; We don't prime the cache since it tends to get out of date.
262 (defvar package-archive-contents nil
263 "Cache of the contents of the Emacs Lisp Package Archive.
264 This is an alist mapping package names (symbols) to package
265 descriptor vectors. These are like the vectors for `package-alist'
266 but have extra entries: one which is 'tar for tar packages and
267 'single for single-file packages, and one which is the name of
268 the archive from which it came.")
269 (put 'package-archive-contents 'risky-local-variable t)
271 (defcustom package-user-dir (locate-user-emacs-file "elpa")
272 "Directory containing the user's Emacs Lisp packages.
273 The directory name should be absolute.
274 Apart from this directory, Emacs also looks for system-wide
275 packages in `package-directory-list'."
276 :type 'directory
277 :risky t
278 :group 'package
279 :version "24.1")
281 (defcustom package-directory-list
282 ;; Defaults are subdirs named "elpa" in the site-lisp dirs.
283 (let (result)
284 (dolist (f load-path)
285 (and (stringp f)
286 (equal (file-name-nondirectory f) "site-lisp")
287 (push (expand-file-name "elpa" f) result)))
288 (nreverse result))
289 "List of additional directories containing Emacs Lisp packages.
290 Each directory name should be absolute.
292 These directories contain packages intended for system-wide; in
293 contrast, `package-user-dir' contains packages for personal use."
294 :type '(repeat directory)
295 :risky t
296 :group 'package
297 :version "24.1")
299 ;; The value is precomputed in finder-inf.el, but don't load that
300 ;; until it's needed (i.e. when `package-initialize' is called).
301 (defvar package--builtins nil
302 "Alist of built-in packages.
303 The actual value is initialized by loading the library
304 `finder-inf'; this is not done until it is needed, e.g. by the
305 function `package-built-in-p'.
307 Each element has the form (PKG . DESC), where PKG is a package
308 name (a symbol) and DESC is a vector that describes the package.
309 The vector DESC has the form [VERSION-LIST REQS DOCSTRING].
310 VERSION-LIST is a version list.
311 REQS is a list of packages required by the package, each
312 requirement having the form (NAME VL), where NAME is a string
313 and VL is a version list.
314 DOCSTRING is a brief description of the package.")
315 (put 'package--builtins 'risky-local-variable t)
317 (defvar package-alist nil
318 "Alist of all packages available for activation.
319 Each element has the form (PKG . DESC), where PKG is a package
320 name (a symbol) and DESC is a vector that describes the package.
322 The vector DESC has the form [VERSION-LIST REQS DOCSTRING].
323 VERSION-LIST is a version list.
324 REQS is a list of packages required by the package, each
325 requirement having the form (NAME VL) where NAME is a string
326 and VL is a version list.
327 DOCSTRING is a brief description of the package.
329 This variable is set automatically by `package-load-descriptor',
330 called via `package-initialize'. To change which packages are
331 loaded and/or activated, customize `package-load-list'.")
332 (put 'package-alist 'risky-local-variable t)
334 (defvar package-activated-list nil
335 "List of the names of currently activated packages.")
336 (put 'package-activated-list 'risky-local-variable t)
338 (defvar package-obsolete-alist nil
339 "Representation of obsolete packages.
340 Like `package-alist', but maps package name to a second alist.
341 The inner alist is keyed by version.")
342 (put 'package-obsolete-alist 'risky-local-variable t)
344 (defun package-version-join (vlist)
345 "Return the version string corresponding to the list VLIST.
346 This is, approximately, the inverse of `version-to-list'.
347 \(Actually, it returns only one of the possible inverses, since
348 `version-to-list' is a many-to-one operation.)"
349 (if (null vlist)
351 (let ((str-list (list "." (int-to-string (car vlist)))))
352 (dolist (num (cdr vlist))
353 (cond
354 ((>= num 0)
355 (push (int-to-string num) str-list)
356 (push "." str-list))
357 ((< num -3)
358 (error "Invalid version list `%s'" vlist))
360 ;; pre, or beta, or alpha
361 (cond ((equal "." (car str-list))
362 (pop str-list))
363 ((not (string-match "[0-9]+" (car str-list)))
364 (error "Invalid version list `%s'" vlist)))
365 (push (cond ((= num -1) "pre")
366 ((= num -2) "beta")
367 ((= num -3) "alpha"))
368 str-list))))
369 (if (equal "." (car str-list))
370 (pop str-list))
371 (apply 'concat (nreverse str-list)))))
373 (defun package-strip-version (dirname)
374 "Strip the version from a combined package name and version.
375 E.g., if given \"quux-23.0\", will return \"quux\""
376 (if (string-match (concat "\\`" package-subdirectory-regexp "\\'") dirname)
377 (match-string 1 dirname)))
379 (defun package-load-descriptor (dir package)
380 "Load the description file in directory DIR for package PACKAGE.
381 Here, PACKAGE is a string of the form NAME-VERSION, where NAME is
382 the package name and VERSION is its version."
383 (let* ((pkg-dir (expand-file-name package dir))
384 (pkg-file (expand-file-name
385 (concat (package-strip-version package) "-pkg")
386 pkg-dir)))
387 (when (and (file-directory-p pkg-dir)
388 (file-exists-p (concat pkg-file ".el")))
389 (load pkg-file nil t))))
391 (defun package-load-all-descriptors ()
392 "Load descriptors for installed Emacs Lisp packages.
393 This looks for package subdirectories in `package-user-dir' and
394 `package-directory-list'. The variable `package-load-list'
395 controls which package subdirectories may be loaded.
397 In each valid package subdirectory, this function loads the
398 description file containing a call to `define-package', which
399 updates `package-alist' and `package-obsolete-alist'."
400 (let ((regexp (concat "\\`" package-subdirectory-regexp "\\'")))
401 (dolist (dir (cons package-user-dir package-directory-list))
402 (when (file-directory-p dir)
403 (dolist (subdir (directory-files dir))
404 (when (string-match regexp subdir)
405 (package-maybe-load-descriptor (match-string 1 subdir)
406 (match-string 2 subdir)
407 dir)))))))
409 (defun package-maybe-load-descriptor (name version dir)
410 "Maybe load a specific package from directory DIR.
411 NAME and VERSION are the package's name and version strings.
412 This function checks `package-load-list', before actually loading
413 the package by calling `package-load-descriptor'."
414 (let ((force (assq (intern name) package-load-list))
415 (subdir (concat name "-" version)))
416 (and (file-directory-p (expand-file-name subdir dir))
417 ;; Check `package-load-list':
418 (cond ((null force)
419 (memq 'all package-load-list))
420 ((null (setq force (cadr force)))
421 nil) ; disabled
422 ((eq force t)
424 ((stringp force) ; held
425 (version-list-= (version-to-list version)
426 (version-to-list force)))
428 (error "Invalid element in `package-load-list'")))
429 ;; Actually load the descriptor:
430 (package-load-descriptor dir subdir))))
432 (defsubst package-desc-vers (desc)
433 "Extract version from a package description vector."
434 (aref desc 0))
436 (defsubst package-desc-reqs (desc)
437 "Extract requirements from a package description vector."
438 (aref desc 1))
440 (defsubst package-desc-doc (desc)
441 "Extract doc string from a package description vector."
442 (aref desc 2))
444 (defsubst package-desc-kind (desc)
445 "Extract the kind of download from an archive package description vector."
446 (aref desc 3))
448 (defun package--dir (name version)
449 "Return the directory where a package is installed, or nil if none.
450 NAME and VERSION are both strings."
451 (let* ((subdir (concat name "-" version))
452 (dir-list (cons package-user-dir package-directory-list))
453 pkg-dir)
454 (while dir-list
455 (let ((subdir-full (expand-file-name subdir (car dir-list))))
456 (if (file-directory-p subdir-full)
457 (setq pkg-dir subdir-full
458 dir-list nil)
459 (setq dir-list (cdr dir-list)))))
460 pkg-dir))
462 (defun package-activate-1 (package pkg-vec)
463 (let* ((name (symbol-name package))
464 (version-str (package-version-join (package-desc-vers pkg-vec)))
465 (pkg-dir (package--dir name version-str)))
466 (unless pkg-dir
467 (error "Internal error: unable to find directory for `%s-%s'"
468 name version-str))
469 ;; Add info node.
470 (when (file-exists-p (expand-file-name "dir" pkg-dir))
471 ;; FIXME: not the friendliest, but simple.
472 (require 'info)
473 (info-initialize)
474 (push pkg-dir Info-directory-list))
475 ;; Add to load path, add autoloads, and activate the package.
476 (push pkg-dir load-path)
477 (load (expand-file-name (concat name "-autoloads") pkg-dir) nil t)
478 (push package package-activated-list)
479 ;; Don't return nil.
482 (defun package-built-in-p (package &optional min-version)
483 "Return true if PACKAGE is built-in to Emacs.
484 Optional arg MIN-VERSION, if non-nil, should be a version list
485 specifying the minimum acceptable version."
486 (require 'finder-inf nil t) ; For `package--builtins'.
487 (if (eq package 'emacs)
488 (version-list-<= min-version (version-to-list emacs-version))
489 (let ((elt (assq package package--builtins)))
490 (and elt (version-list-<= min-version
491 (package-desc-vers (cdr elt)))))))
493 ;; This function goes ahead and activates a newer version of a package
494 ;; if an older one was already activated. This is not ideal; we'd at
495 ;; least need to check to see if the package has actually been loaded,
496 ;; and not merely activated.
497 (defun package-activate (package min-version)
498 "Activate package PACKAGE, of version MIN-VERSION or newer.
499 MIN-VERSION should be a version list.
500 If PACKAGE has any dependencies, recursively activate them.
501 Return nil if the package could not be activated."
502 (let ((pkg-vec (cdr (assq package package-alist)))
503 available-version found)
504 ;; Check if PACKAGE is available in `package-alist'.
505 (when pkg-vec
506 (setq available-version (package-desc-vers pkg-vec)
507 found (version-list-<= min-version available-version)))
508 (cond
509 ;; If no such package is found, maybe it's built-in.
510 ((null found)
511 (package-built-in-p package min-version))
512 ;; If the package is already activated, just return t.
513 ((memq package package-activated-list)
515 ;; Otherwise, proceed with activation.
517 (let ((fail (catch 'dep-failure
518 ;; Activate its dependencies recursively.
519 (dolist (req (package-desc-reqs pkg-vec))
520 (unless (package-activate (car req) (cadr req))
521 (throw 'dep-failure req))))))
522 (if fail
523 (warn "Unable to activate package `%s'.
524 Required package `%s-%s' is unavailable"
525 package (car fail) (package-version-join (cadr fail)))
526 ;; If all goes well, activate the package itself.
527 (package-activate-1 package pkg-vec)))))))
529 (defun package-mark-obsolete (package pkg-vec)
530 "Put package on the obsolete list, if not already there."
531 (let ((elt (assq package package-obsolete-alist)))
532 (if elt
533 ;; If this obsolete version does not exist in the list, update
534 ;; it the list.
535 (unless (assoc (package-desc-vers pkg-vec) (cdr elt))
536 (setcdr elt (cons (cons (package-desc-vers pkg-vec) pkg-vec)
537 (cdr elt))))
538 ;; Make a new association.
539 (push (cons package (list (cons (package-desc-vers pkg-vec)
540 pkg-vec)))
541 package-obsolete-alist))))
543 (defun define-package (name-string version-string
544 &optional docstring requirements
545 &rest _extra-properties)
546 "Define a new package.
547 NAME-STRING is the name of the package, as a string.
548 VERSION-STRING is the version of the package, as a string.
549 DOCSTRING is a short description of the package, a string.
550 REQUIREMENTS is a list of dependencies on other packages.
551 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
552 where OTHER-VERSION is a string.
554 EXTRA-PROPERTIES is currently unused."
555 (let* ((name (intern name-string))
556 (version (version-to-list version-string))
557 (new-pkg-desc
558 (cons name
559 (vector version
560 (mapcar
561 (lambda (elt)
562 (list (car elt)
563 (version-to-list (car (cdr elt)))))
564 requirements)
565 docstring)))
566 (old-pkg (assq name package-alist)))
567 (cond
568 ;; If there's no old package, just add this to `package-alist'.
569 ((null old-pkg)
570 (push new-pkg-desc package-alist))
571 ((version-list-< (package-desc-vers (cdr old-pkg)) version)
572 ;; Remove the old package and declare it obsolete.
573 (package-mark-obsolete name (cdr old-pkg))
574 (setq package-alist (cons new-pkg-desc
575 (delq old-pkg package-alist))))
576 ;; You can have two packages with the same version, e.g. one in
577 ;; the system package directory and one in your private
578 ;; directory. We just let the first one win.
579 ((not (version-list-= (package-desc-vers (cdr old-pkg)) version))
580 ;; The package is born obsolete.
581 (package-mark-obsolete name (cdr new-pkg-desc))))))
583 ;; From Emacs 22.
584 (defun package-autoload-ensure-default-file (file)
585 "Make sure that the autoload file FILE exists and if not create it."
586 (unless (file-exists-p file)
587 (write-region
588 (concat ";;; " (file-name-nondirectory file)
589 " --- automatically extracted autoloads\n"
590 ";;\n"
591 ";;; Code:\n"
592 "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
593 "\f\n;; Local Variables:\n"
594 ";; version-control: never\n"
595 ";; no-byte-compile: t\n"
596 ";; no-update-autoloads: t\n"
597 ";; End:\n"
598 ";;; " (file-name-nondirectory file)
599 " ends here\n")
600 nil file))
601 file)
603 (defun package-generate-autoloads (name pkg-dir)
604 (require 'autoload) ;Load before we let-bind generated-autoload-file!
605 (let* ((auto-name (concat name "-autoloads.el"))
606 ;;(ignore-name (concat name "-pkg.el"))
607 (generated-autoload-file (expand-file-name auto-name pkg-dir))
608 (version-control 'never))
609 (package-autoload-ensure-default-file generated-autoload-file)
610 (update-directory-autoloads pkg-dir)
611 (let ((buf (find-buffer-visiting generated-autoload-file)))
612 (when buf (kill-buffer buf)))))
614 (defvar tar-parse-info)
615 (declare-function tar-untar-buffer "tar-mode" ())
616 (declare-function tar-header-name "tar-mode" (tar-header))
617 (declare-function tar-header-link-type "tar-mode" (tar-header))
619 (defun package-untar-buffer (dir)
620 "Untar the current buffer.
621 This uses `tar-untar-buffer' from Tar mode. All files should
622 untar into a directory named DIR; otherwise, signal an error."
623 (require 'tar-mode)
624 (tar-mode)
625 ;; Make sure everything extracts into DIR.
626 (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
627 (case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
628 (dolist (tar-data tar-parse-info)
629 (let ((name (expand-file-name (tar-header-name tar-data))))
630 (or (string-match regexp name)
631 ;; Tarballs created by some utilities don't list
632 ;; directories with a trailing slash (Bug#13136).
633 (and (string-equal dir name)
634 (eq (tar-header-link-type tar-data) 5))
635 (error "Package does not untar cleanly into directory %s/" dir)))))
636 (tar-untar-buffer))
638 (defun package-unpack (package version)
639 (let* ((name (symbol-name package))
640 (dirname (concat name "-" version))
641 (pkg-dir (expand-file-name dirname package-user-dir)))
642 (make-directory package-user-dir t)
643 ;; FIXME: should we delete PKG-DIR if it exists?
644 (let* ((default-directory (file-name-as-directory package-user-dir)))
645 (package-untar-buffer dirname)
646 (package--make-autoloads-and-compile name pkg-dir))))
648 (defun package--make-autoloads-and-compile (name pkg-dir)
649 "Generate autoloads and do byte-compilation for package named NAME.
650 PKG-DIR is the name of the package directory."
651 (package-generate-autoloads name pkg-dir)
652 (let ((load-path (cons pkg-dir load-path)))
653 ;; We must load the autoloads file before byte compiling, in
654 ;; case there are magic cookies to set up non-trivial paths.
655 (load (expand-file-name (concat name "-autoloads") pkg-dir) nil t)
656 (byte-recompile-directory pkg-dir 0 t)))
658 (defun package--write-file-no-coding (file-name)
659 (let ((buffer-file-coding-system 'no-conversion))
660 (write-region (point-min) (point-max) file-name)))
662 (defun package-unpack-single (file-name version desc requires)
663 "Install the contents of the current buffer as a package."
664 ;; Special case "package".
665 (if (string= file-name "package")
666 (package--write-file-no-coding
667 (expand-file-name (concat file-name ".el") package-user-dir))
668 (let* ((pkg-dir (expand-file-name (concat file-name "-"
669 (package-version-join
670 (version-to-list version)))
671 package-user-dir))
672 (el-file (expand-file-name (concat file-name ".el") pkg-dir))
673 (pkg-file (expand-file-name (concat file-name "-pkg.el") pkg-dir)))
674 (make-directory pkg-dir t)
675 (package--write-file-no-coding el-file)
676 (let ((print-level nil)
677 (print-length nil))
678 (write-region
679 (concat
680 (prin1-to-string
681 (list 'define-package
682 file-name
683 version
684 desc
685 (list 'quote
686 ;; Turn version lists into string form.
687 (mapcar
688 (lambda (elt)
689 (list (car elt)
690 (package-version-join (cadr elt))))
691 requires))))
692 "\n")
694 pkg-file
695 nil nil nil 'excl))
696 (package--make-autoloads-and-compile file-name pkg-dir))))
698 (defmacro package--with-work-buffer (location file &rest body)
699 "Run BODY in a buffer containing the contents of FILE at LOCATION.
700 LOCATION is the base location of a package archive, and should be
701 one of the URLs (or file names) specified in `package-archives'.
702 FILE is the name of a file relative to that base location.
704 This macro retrieves FILE from LOCATION into a temporary buffer,
705 and evaluates BODY while that buffer is current. This work
706 buffer is killed afterwards. Return the last value in BODY."
707 `(let* ((http (string-match "\\`https?:" ,location))
708 (buffer
709 (if http
710 (url-retrieve-synchronously (concat ,location ,file))
711 (generate-new-buffer "*package work buffer*"))))
712 (prog1
713 (with-current-buffer buffer
714 (if http
715 (progn (package-handle-response)
716 (re-search-forward "^$" nil 'move)
717 (forward-char)
718 (delete-region (point-min) (point)))
719 (unless (file-name-absolute-p ,location)
720 (error "Archive location %s is not an absolute file name"
721 ,location))
722 (insert-file-contents (expand-file-name ,file ,location)))
723 ,@body)
724 (kill-buffer buffer))))
726 (defun package-handle-response ()
727 "Handle the response from a `url-retrieve-synchronously' call.
728 Parse the HTTP response and throw if an error occurred.
729 The url package seems to require extra processing for this.
730 This should be called in a `save-excursion', in the download buffer.
731 It will move point to somewhere in the headers."
732 ;; We assume HTTP here.
733 (require 'url-http)
734 (let ((response (url-http-parse-response)))
735 (when (or (< response 200) (>= response 300))
736 (error "Error during download request:%s"
737 (buffer-substring-no-properties (point) (progn
738 (end-of-line)
739 (point)))))))
741 (defun package-download-single (name version desc requires)
742 "Download and install a single-file package."
743 (let ((location (package-archive-base name))
744 (file (concat (symbol-name name) "-" version ".el")))
745 (package--with-work-buffer location file
746 (package-unpack-single (symbol-name name) version desc requires))))
748 (defun package-download-tar (name version)
749 "Download and install a tar package."
750 (let ((location (package-archive-base name))
751 (file (concat (symbol-name name) "-" version ".tar")))
752 (package--with-work-buffer location file
753 (package-unpack name version))))
755 (defvar package--initialized nil)
757 (defun package-installed-p (package &optional min-version)
758 "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
759 MIN-VERSION should be a version list."
760 (unless package--initialized (error "package.el is not yet initialized!"))
761 (let ((pkg-desc (assq package package-alist)))
762 (if pkg-desc
763 (version-list-<= min-version
764 (package-desc-vers (cdr pkg-desc)))
765 ;; Also check built-in packages.
766 (package-built-in-p package min-version))))
768 (defun package-compute-transaction (package-list requirements)
769 "Return a list of packages to be installed, including PACKAGE-LIST.
770 PACKAGE-LIST should be a list of package names (symbols).
772 REQUIREMENTS should be a list of additional requirements; each
773 element in this list should have the form (PACKAGE VERSION-LIST),
774 where PACKAGE is a package name and VERSION-LIST is the required
775 version of that package.
777 This function recursively computes the requirements of the
778 packages in REQUIREMENTS, and returns a list of all the packages
779 that must be installed. Packages that are already installed are
780 not included in this list."
781 (dolist (elt requirements)
782 (let* ((next-pkg (car elt))
783 (next-version (cadr elt)))
784 (unless (package-installed-p next-pkg next-version)
785 ;; A package is required, but not installed. It might also be
786 ;; blocked via `package-load-list'.
787 (let ((pkg-desc (assq next-pkg package-archive-contents))
788 hold)
789 (when (setq hold (assq next-pkg package-load-list))
790 (setq hold (cadr hold))
791 (cond ((eq hold t))
792 ((eq hold nil)
793 (error "Required package '%s' is disabled"
794 (symbol-name next-pkg)))
795 ((null (stringp hold))
796 (error "Invalid element in `package-load-list'"))
797 ((version-list-< (version-to-list hold) next-version)
798 (error "Package `%s' held at version %s, \
799 but version %s required"
800 (symbol-name next-pkg) hold
801 (package-version-join next-version)))))
802 (unless pkg-desc
803 (error "Package `%s-%s' is unavailable"
804 (symbol-name next-pkg)
805 (package-version-join next-version)))
806 (unless (version-list-<= next-version
807 (package-desc-vers (cdr pkg-desc)))
808 (error
809 "Need package `%s-%s', but only %s is available"
810 (symbol-name next-pkg) (package-version-join next-version)
811 (package-version-join (package-desc-vers (cdr pkg-desc)))))
812 ;; Move to front, so it gets installed early enough (bug#14082).
813 (setq package-list (cons next-pkg (delq next-pkg package-list)))
814 (setq package-list
815 (package-compute-transaction package-list
816 (package-desc-reqs
817 (cdr pkg-desc))))))))
818 package-list)
820 (defun package-read-from-string (str)
821 "Read a Lisp expression from STR.
822 Signal an error if the entire string was not used."
823 (let* ((read-data (read-from-string str))
824 (more-left
825 (condition-case nil
826 ;; The call to `ignore' suppresses a compiler warning.
827 (progn (ignore (read-from-string
828 (substring str (cdr read-data))))
830 (end-of-file nil))))
831 (if more-left
832 (error "Can't read whole string")
833 (car read-data))))
835 (defun package--read-archive-file (file)
836 "Re-read archive file FILE, if it exists.
837 Will return the data from the file, or nil if the file does not exist.
838 Will throw an error if the archive version is too new."
839 (let ((filename (expand-file-name file package-user-dir)))
840 (when (file-exists-p filename)
841 (with-temp-buffer
842 (insert-file-contents-literally filename)
843 (let ((contents (read (current-buffer))))
844 (if (> (car contents) package-archive-version)
845 (error "Package archive version %d is higher than %d"
846 (car contents) package-archive-version))
847 (cdr contents))))))
849 (defun package-read-all-archive-contents ()
850 "Re-read `archive-contents', if it exists.
851 If successful, set `package-archive-contents'."
852 (setq package-archive-contents nil)
853 (dolist (archive package-archives)
854 (package-read-archive-contents (car archive))))
856 (defun package-read-archive-contents (archive)
857 "Re-read archive contents for ARCHIVE.
858 If successful, set the variable `package-archive-contents'.
859 If the archive version is too new, signal an error."
860 ;; Version 1 of 'archive-contents' is identical to our internal
861 ;; representation.
862 (let* ((dir (concat "archives/" archive))
863 (contents-file (concat dir "/archive-contents"))
864 contents)
865 (when (setq contents (package--read-archive-file contents-file))
866 (dolist (package contents)
867 (package--add-to-archive-contents package archive)))))
869 (defun package--add-to-archive-contents (package archive)
870 "Add the PACKAGE from the given ARCHIVE if necessary.
871 Also, add the originating archive to the end of the package vector."
872 (let* ((name (car package))
873 (version (package-desc-vers (cdr package)))
874 (entry (cons name
875 (vconcat (cdr package) (vector archive))))
876 (existing-package (assq name package-archive-contents))
877 (pinned-to-archive (assoc name package-pinned-packages)))
878 (cond ((and pinned-to-archive
879 ;; If pinned to another archive, skip entirely.
880 (not (equal (cdr pinned-to-archive) archive)))
881 nil)
882 ((not existing-package)
883 (add-to-list 'package-archive-contents entry))
884 ((version-list-< (package-desc-vers (cdr existing-package))
885 version)
886 ;; Replace the entry with this one.
887 (setq package-archive-contents
888 (cons entry
889 (delq existing-package
890 package-archive-contents)))))))
892 (defun package-download-transaction (package-list)
893 "Download and install all the packages in PACKAGE-LIST.
894 PACKAGE-LIST should be a list of package names (symbols).
895 This function assumes that all package requirements in
896 PACKAGE-LIST are satisfied, i.e. that PACKAGE-LIST is computed
897 using `package-compute-transaction'."
898 (dolist (elt package-list)
899 (let* ((desc (cdr (assq elt package-archive-contents)))
900 ;; As an exception, if package is "held" in
901 ;; `package-load-list', download the held version.
902 (hold (cadr (assq elt package-load-list)))
903 (v-string (or (and (stringp hold) hold)
904 (package-version-join (package-desc-vers desc))))
905 (kind (package-desc-kind desc)))
906 (cond
907 ((eq kind 'tar)
908 (package-download-tar elt v-string))
909 ((eq kind 'single)
910 (package-download-single elt v-string
911 (package-desc-doc desc)
912 (package-desc-reqs desc)))
914 (error "Unknown package kind: %s" (symbol-name kind))))
915 ;; If package A depends on package B, then A may `require' B
916 ;; during byte compilation. So we need to activate B before
917 ;; unpacking A.
918 (package-maybe-load-descriptor (symbol-name elt) v-string
919 package-user-dir)
920 (package-activate elt (version-to-list v-string)))))
922 ;;;###autoload
923 (defun package-install (name)
924 "Install the package named NAME.
925 NAME should be the name of one of the available packages in an
926 archive in `package-archives'. Interactively, prompt for NAME."
927 (interactive
928 (progn
929 ;; Initialize the package system to get the list of package
930 ;; symbols for completion.
931 (unless package--initialized
932 (package-initialize t))
933 (unless package-archive-contents
934 (package-refresh-contents))
935 (list (intern (completing-read
936 "Install package: "
937 (mapcar (lambda (elt)
938 (cons (symbol-name (car elt))
939 nil))
940 package-archive-contents)
941 nil t)))))
942 (let ((pkg-desc (assq name package-archive-contents)))
943 (unless pkg-desc
944 (error "Package `%s' is not available for installation"
945 (symbol-name name)))
946 (package-download-transaction
947 (package-compute-transaction (list name)
948 (package-desc-reqs (cdr pkg-desc))))))
950 (defun package-strip-rcs-id (str)
951 "Strip RCS version ID from the version string STR.
952 If the result looks like a dotted numeric version, return it.
953 Otherwise return nil."
954 (when str
955 (when (string-match "\\`[ \t]*[$]Revision:[ \t]+" str)
956 (setq str (substring str (match-end 0))))
957 (condition-case nil
958 (if (version-to-list str)
959 str)
960 (error nil))))
962 (defun package-buffer-info ()
963 "Return a vector describing the package in the current buffer.
964 The vector has the form
966 [FILENAME REQUIRES DESCRIPTION VERSION COMMENTARY]
968 FILENAME is the file name, a string, sans the \".el\" extension.
969 REQUIRES is a list of requirements, each requirement having the
970 form (NAME VER); NAME is a string and VER is a version list.
971 DESCRIPTION is the package description, a string.
972 VERSION is the version, a string.
973 COMMENTARY is the commentary section, a string, or nil if none.
975 If the buffer does not contain a conforming package, signal an
976 error. If there is a package, narrow the buffer to the file's
977 boundaries."
978 (goto-char (point-min))
979 (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
980 (error "Packages lacks a file header"))
981 (let ((file-name (match-string-no-properties 1))
982 (desc (match-string-no-properties 2))
983 (start (line-beginning-position)))
984 (unless (search-forward (concat ";;; " file-name ".el ends here"))
985 (error "Package lacks a terminating comment"))
986 ;; Try to include a trailing newline.
987 (forward-line)
988 (narrow-to-region start (point))
989 (require 'lisp-mnt)
990 ;; Use some headers we've invented to drive the process.
991 (let* ((requires-str (lm-header "package-requires"))
992 (requires (if requires-str
993 (package-read-from-string requires-str)))
994 ;; Prefer Package-Version; if defined, the package author
995 ;; probably wants us to use it. Otherwise try Version.
996 (pkg-version
997 (or (package-strip-rcs-id (lm-header "package-version"))
998 (package-strip-rcs-id (lm-header "version"))))
999 (commentary (lm-commentary)))
1000 (unless pkg-version
1001 (error
1002 "Package lacks a \"Version\" or \"Package-Version\" header"))
1003 ;; Turn string version numbers into list form.
1004 (setq requires
1005 (mapcar
1006 (lambda (elt)
1007 (list (car elt)
1008 (version-to-list (car (cdr elt)))))
1009 requires))
1010 (vector file-name requires desc pkg-version commentary))))
1012 (defun package-tar-file-info (file)
1013 "Find package information for a tar file.
1014 FILE is the name of the tar file to examine.
1015 The return result is a vector like `package-buffer-info'."
1016 (let ((default-directory (file-name-directory file))
1017 (file (file-name-nondirectory file)))
1018 (unless (string-match (concat "\\`" package-subdirectory-regexp "\\.tar\\'")
1019 file)
1020 (error "Invalid package name `%s'" file))
1021 (let* ((pkg-name (match-string-no-properties 1 file))
1022 (pkg-version (match-string-no-properties 2 file))
1023 ;; Extract the package descriptor.
1024 (pkg-def-contents (shell-command-to-string
1025 ;; Requires GNU tar.
1026 (concat "tar -xOf " file " "
1028 pkg-name "-" pkg-version "/"
1029 pkg-name "-pkg.el")))
1030 (pkg-def-parsed (package-read-from-string pkg-def-contents)))
1031 (unless (eq (car pkg-def-parsed) 'define-package)
1032 (error "No `define-package' sexp is present in `%s-pkg.el'" pkg-name))
1033 (let ((name-str (nth 1 pkg-def-parsed))
1034 (version-string (nth 2 pkg-def-parsed))
1035 (docstring (nth 3 pkg-def-parsed))
1036 (requires (nth 4 pkg-def-parsed))
1037 (readme (shell-command-to-string
1038 ;; Requires GNU tar.
1039 (concat "tar -xOf " file " "
1040 pkg-name "-" pkg-version "/README"))))
1041 (unless (equal pkg-version version-string)
1042 (error "Package has inconsistent versions"))
1043 (unless (equal pkg-name name-str)
1044 (error "Package has inconsistent names"))
1045 ;; Kind of a hack.
1046 (if (string-match ": Not found in archive" readme)
1047 (setq readme nil))
1048 ;; Turn string version numbers into list form.
1049 (if (eq (car requires) 'quote)
1050 (setq requires (car (cdr requires))))
1051 (setq requires
1052 (mapcar (lambda (elt)
1053 (list (car elt)
1054 (version-to-list (cadr elt))))
1055 requires))
1056 (vector pkg-name requires docstring version-string readme)))))
1058 ;;;###autoload
1059 (defun package-install-from-buffer (pkg-info type)
1060 "Install a package from the current buffer.
1061 When called interactively, the current buffer is assumed to be a
1062 single .el file that follows the packaging guidelines; see info
1063 node `(elisp)Packaging'.
1065 When called from Lisp, PKG-INFO is a vector describing the
1066 information, of the type returned by `package-buffer-info'; and
1067 TYPE is the package type (either `single' or `tar')."
1068 (interactive (list (package-buffer-info) 'single))
1069 (save-excursion
1070 (save-restriction
1071 (let* ((file-name (aref pkg-info 0))
1072 (requires (aref pkg-info 1))
1073 (desc (if (string= (aref pkg-info 2) "")
1074 "No description available."
1075 (aref pkg-info 2)))
1076 (pkg-version (aref pkg-info 3)))
1077 ;; Download and install the dependencies.
1078 (let ((transaction (package-compute-transaction nil requires)))
1079 (package-download-transaction transaction))
1080 ;; Install the package itself.
1081 (cond
1082 ((eq type 'single)
1083 (package-unpack-single file-name pkg-version desc requires))
1084 ((eq type 'tar)
1085 (package-unpack (intern file-name) pkg-version))
1087 (error "Unknown type: %s" (symbol-name type))))
1088 ;; Try to activate it.
1089 (package-initialize)))))
1091 ;;;###autoload
1092 (defun package-install-file (file)
1093 "Install a package from a file.
1094 The file can either be a tar file or an Emacs Lisp file."
1095 (interactive "fPackage file name: ")
1096 (with-temp-buffer
1097 (insert-file-contents-literally file)
1098 (cond
1099 ((string-match "\\.el$" file)
1100 (package-install-from-buffer (package-buffer-info) 'single))
1101 ((string-match "\\.tar$" file)
1102 (package-install-from-buffer (package-tar-file-info file) 'tar))
1103 (t (error "Unrecognized extension `%s'" (file-name-extension file))))))
1105 (defun package-delete (name version)
1106 (let ((dir (package--dir name version)))
1107 (if (string-equal (file-name-directory dir)
1108 (file-name-as-directory
1109 (expand-file-name package-user-dir)))
1110 (progn
1111 (delete-directory dir t t)
1112 (message "Package `%s-%s' deleted." name version))
1113 ;; Don't delete "system" packages
1114 (error "Package `%s-%s' is a system package, not deleting"
1115 name version))))
1117 (defun package-archive-base (name)
1118 "Return the archive containing the package NAME."
1119 (let ((desc (cdr (assq (intern-soft name) package-archive-contents))))
1120 (cdr (assoc (aref desc (- (length desc) 1)) package-archives))))
1122 (defun package--download-one-archive (archive file)
1123 "Retrieve an archive file FILE from ARCHIVE, and cache it.
1124 ARCHIVE should be a cons cell of the form (NAME . LOCATION),
1125 similar to an entry in `package-alist'. Save the cached copy to
1126 \"archives/NAME/archive-contents\" in `package-user-dir'."
1127 (let* ((dir (expand-file-name "archives" package-user-dir))
1128 (dir (expand-file-name (car archive) dir)))
1129 (package--with-work-buffer (cdr archive) file
1130 ;; Read the retrieved buffer to make sure it is valid (e.g. it
1131 ;; may fetch a URL redirect page).
1132 (when (listp (read buffer))
1133 (make-directory dir t)
1134 (setq buffer-file-name (expand-file-name file dir))
1135 (let ((version-control 'never))
1136 (save-buffer))))))
1138 ;;;###autoload
1139 (defun package-refresh-contents ()
1140 "Download the ELPA archive description if needed.
1141 This informs Emacs about the latest versions of all packages, and
1142 makes them available for download."
1143 (interactive)
1144 (unless (file-exists-p package-user-dir)
1145 (make-directory package-user-dir t))
1146 (dolist (archive package-archives)
1147 (condition-case-unless-debug nil
1148 (package--download-one-archive archive "archive-contents")
1149 (error (message "Failed to download `%s' archive."
1150 (car archive)))))
1151 (package-read-all-archive-contents))
1153 ;;;###autoload
1154 (defun package-initialize (&optional no-activate)
1155 "Load Emacs Lisp packages, and activate them.
1156 The variable `package-load-list' controls which packages to load.
1157 If optional arg NO-ACTIVATE is non-nil, don't activate packages."
1158 (interactive)
1159 (setq package-alist nil
1160 package-obsolete-alist nil)
1161 (package-load-all-descriptors)
1162 (package-read-all-archive-contents)
1163 (unless no-activate
1164 (dolist (elt package-alist)
1165 (package-activate (car elt) (package-desc-vers (cdr elt)))))
1166 (setq package--initialized t))
1169 ;;;; Package description buffer.
1171 ;;;###autoload
1172 (defun describe-package (package)
1173 "Display the full documentation of PACKAGE (a symbol)."
1174 (interactive
1175 (let* ((guess (function-called-at-point))
1176 packages val)
1177 (require 'finder-inf nil t)
1178 ;; Load the package list if necessary (but don't activate them).
1179 (unless package--initialized
1180 (package-initialize t))
1181 (setq packages (append (mapcar 'car package-alist)
1182 (mapcar 'car package-archive-contents)
1183 (mapcar 'car package--builtins)))
1184 (unless (memq guess packages)
1185 (setq guess nil))
1186 (setq packages (mapcar 'symbol-name packages))
1187 (setq val
1188 (completing-read (if guess
1189 (format "Describe package (default %s): "
1190 guess)
1191 "Describe package: ")
1192 packages nil t nil nil guess))
1193 (list (if (equal val "") guess (intern val)))))
1194 (if (or (null package) (not (symbolp package)))
1195 (message "No package specified")
1196 (help-setup-xref (list #'describe-package package)
1197 (called-interactively-p 'interactive))
1198 (with-help-window (help-buffer)
1199 (with-current-buffer standard-output
1200 (describe-package-1 package)))))
1202 (defun describe-package-1 (package)
1203 (require 'lisp-mnt)
1204 (let ((package-name (symbol-name package))
1205 (built-in (assq package package--builtins))
1206 desc pkg-dir reqs version installable archive)
1207 (prin1 package)
1208 (princ " is ")
1209 (cond
1210 ;; Loaded packages are in `package-alist'.
1211 ((setq desc (cdr (assq package package-alist)))
1212 (setq version (package-version-join (package-desc-vers desc)))
1213 (if (setq pkg-dir (package--dir package-name version))
1214 (insert "an installed package.\n\n")
1215 ;; This normally does not happen.
1216 (insert "a deleted package.\n\n")))
1217 ;; Available packages are in `package-archive-contents'.
1218 ((setq desc (cdr (assq package package-archive-contents)))
1219 (setq version (package-version-join (package-desc-vers desc))
1220 archive (aref desc (- (length desc) 1))
1221 installable t)
1222 (if built-in
1223 (insert "a built-in package.\n\n")
1224 (insert "an uninstalled package.\n\n")))
1225 (built-in
1226 (setq desc (cdr built-in)
1227 version (package-version-join (package-desc-vers desc)))
1228 (insert "a built-in package.\n\n"))
1230 (insert "an orphan package.\n\n")))
1232 (insert " " (propertize "Status" 'font-lock-face 'bold) ": ")
1233 (cond (pkg-dir
1234 (insert (propertize "Installed"
1235 'font-lock-face 'font-lock-comment-face))
1236 (insert " in `")
1237 ;; Todo: Add button for uninstalling.
1238 (help-insert-xref-button (file-name-as-directory pkg-dir)
1239 'help-package-def pkg-dir)
1240 (if built-in
1241 (insert "',\n shadowing a "
1242 (propertize "built-in package"
1243 'font-lock-face 'font-lock-builtin-face)
1244 ".")
1245 (insert "'.")))
1246 (installable
1247 (if built-in
1248 (insert (propertize "Built-in." 'font-lock-face 'font-lock-builtin-face)
1249 " Alternate version available")
1250 (insert "Available"))
1251 (insert " from " archive)
1252 (insert " -- ")
1253 (let ((button-text (if (display-graphic-p) "Install" "[Install]"))
1254 (button-face (if (display-graphic-p)
1255 '(:box (:line-width 2 :color "dark grey")
1256 :background "light grey"
1257 :foreground "black")
1258 'link)))
1259 (insert-text-button button-text 'face button-face 'follow-link t
1260 'package-symbol package
1261 'action 'package-install-button-action)))
1262 (built-in
1263 (insert (propertize "Built-in." 'font-lock-face 'font-lock-builtin-face)))
1264 (t (insert "Deleted.")))
1265 (insert "\n")
1266 (and version (> (length version) 0)
1267 (insert " "
1268 (propertize "Version" 'font-lock-face 'bold) ": " version "\n"))
1270 (setq reqs (if desc (package-desc-reqs desc)))
1271 (when reqs
1272 (insert " " (propertize "Requires" 'font-lock-face 'bold) ": ")
1273 (let ((first t)
1274 name vers text)
1275 (dolist (req reqs)
1276 (setq name (car req)
1277 vers (cadr req)
1278 text (format "%s-%s" (symbol-name name)
1279 (package-version-join vers)))
1280 (cond (first (setq first nil))
1281 ((>= (+ 2 (current-column) (length text))
1282 (window-width))
1283 (insert ",\n "))
1284 (t (insert ", ")))
1285 (help-insert-xref-button text 'help-package name))
1286 (insert "\n")))
1287 (insert " " (propertize "Summary" 'font-lock-face 'bold)
1288 ": " (if desc (package-desc-doc desc)) "\n\n")
1290 (if built-in
1291 ;; For built-in packages, insert the commentary.
1292 (let ((fn (locate-file (concat package-name ".el") load-path
1293 load-file-rep-suffixes))
1294 (opoint (point)))
1295 (insert (or (lm-commentary fn) ""))
1296 (save-excursion
1297 (goto-char opoint)
1298 (when (re-search-forward "^;;; Commentary:\n" nil t)
1299 (replace-match ""))
1300 (while (re-search-forward "^\\(;+ ?\\)" nil t)
1301 (replace-match ""))))
1302 (let ((readme (expand-file-name (concat package-name "-readme.txt")
1303 package-user-dir))
1304 readme-string)
1305 ;; For elpa packages, try downloading the commentary. If that
1306 ;; fails, try an existing readme file in `package-user-dir'.
1307 (cond ((condition-case nil
1308 (package--with-work-buffer (package-archive-base package)
1309 (concat package-name "-readme.txt")
1310 (setq buffer-file-name
1311 (expand-file-name readme package-user-dir))
1312 (let ((version-control 'never))
1313 (save-buffer))
1314 (setq readme-string (buffer-string))
1316 (error nil))
1317 (insert readme-string))
1318 ((file-readable-p readme)
1319 (insert-file-contents readme)
1320 (goto-char (point-max))))))))
1322 (defun package-install-button-action (button)
1323 (let ((package (button-get button 'package-symbol)))
1324 (when (y-or-n-p (format "Install package `%s'? " package))
1325 (package-install package)
1326 (revert-buffer nil t)
1327 (goto-char (point-min)))))
1330 ;;;; Package menu mode.
1332 (defvar package-menu-mode-map
1333 (let ((map (make-sparse-keymap))
1334 (menu-map (make-sparse-keymap "Package")))
1335 (set-keymap-parent map tabulated-list-mode-map)
1336 (define-key map "\C-m" 'package-menu-describe-package)
1337 (define-key map "u" 'package-menu-mark-unmark)
1338 (define-key map "\177" 'package-menu-backup-unmark)
1339 (define-key map "d" 'package-menu-mark-delete)
1340 (define-key map "i" 'package-menu-mark-install)
1341 (define-key map "U" 'package-menu-mark-upgrades)
1342 (define-key map "r" 'package-menu-refresh)
1343 (define-key map "~" 'package-menu-mark-obsolete-for-deletion)
1344 (define-key map "x" 'package-menu-execute)
1345 (define-key map "h" 'package-menu-quick-help)
1346 (define-key map "?" 'package-menu-describe-package)
1347 (define-key map [menu-bar package-menu] (cons "Package" menu-map))
1348 (define-key menu-map [mq]
1349 '(menu-item "Quit" quit-window
1350 :help "Quit package selection"))
1351 (define-key menu-map [s1] '("--"))
1352 (define-key menu-map [mn]
1353 '(menu-item "Next" next-line
1354 :help "Next Line"))
1355 (define-key menu-map [mp]
1356 '(menu-item "Previous" previous-line
1357 :help "Previous Line"))
1358 (define-key menu-map [s2] '("--"))
1359 (define-key menu-map [mu]
1360 '(menu-item "Unmark" package-menu-mark-unmark
1361 :help "Clear any marks on a package and move to the next line"))
1362 (define-key menu-map [munm]
1363 '(menu-item "Unmark Backwards" package-menu-backup-unmark
1364 :help "Back up one line and clear any marks on that package"))
1365 (define-key menu-map [md]
1366 '(menu-item "Mark for Deletion" package-menu-mark-delete
1367 :help "Mark a package for deletion and move to the next line"))
1368 (define-key menu-map [mi]
1369 '(menu-item "Mark for Install" package-menu-mark-install
1370 :help "Mark a package for installation and move to the next line"))
1371 (define-key menu-map [mupgrades]
1372 '(menu-item "Mark Upgradable Packages" package-menu-mark-upgrades
1373 :help "Mark packages that have a newer version for upgrading"))
1374 (define-key menu-map [s3] '("--"))
1375 (define-key menu-map [mg]
1376 '(menu-item "Update Package List" revert-buffer
1377 :help "Update the list of packages"))
1378 (define-key menu-map [mr]
1379 '(menu-item "Refresh Package List" package-menu-refresh
1380 :help "Download the ELPA archive"))
1381 (define-key menu-map [s4] '("--"))
1382 (define-key menu-map [mt]
1383 '(menu-item "Mark Obsolete Packages" package-menu-mark-obsolete-for-deletion
1384 :help "Mark all obsolete packages for deletion"))
1385 (define-key menu-map [mx]
1386 '(menu-item "Execute Actions" package-menu-execute
1387 :help "Perform all the marked actions"))
1388 (define-key menu-map [s5] '("--"))
1389 (define-key menu-map [mh]
1390 '(menu-item "Help" package-menu-quick-help
1391 :help "Show short key binding help for package-menu-mode"))
1392 (define-key menu-map [mc]
1393 '(menu-item "View Commentary" package-menu-view-commentary
1394 :help "Display information about this package"))
1395 map)
1396 "Local keymap for `package-menu-mode' buffers.")
1398 (defvar package-menu--new-package-list nil
1399 "List of newly-available packages since `list-packages' was last called.")
1401 (define-derived-mode package-menu-mode tabulated-list-mode "Package Menu"
1402 "Major mode for browsing a list of packages.
1403 Letters do not insert themselves; instead, they are commands.
1404 \\<package-menu-mode-map>
1405 \\{package-menu-mode-map}"
1406 (setq tabulated-list-format [("Package" 18 package-menu--name-predicate)
1407 ("Version" 12 nil)
1408 ("Status" 10 package-menu--status-predicate)
1409 ("Description" 0 nil)])
1410 (setq tabulated-list-padding 2)
1411 (setq tabulated-list-sort-key (cons "Status" nil))
1412 (tabulated-list-init-header))
1414 (defmacro package--push (package desc status listname)
1415 "Convenience macro for `package-menu--generate'.
1416 If the alist stored in the symbol LISTNAME lacks an entry for a
1417 package PACKAGE with descriptor DESC, add one. The alist is
1418 keyed with cons cells (PACKAGE . VERSION-LIST), where PACKAGE is
1419 a symbol and VERSION-LIST is a version list."
1420 `(let* ((version (package-desc-vers ,desc))
1421 (key (cons ,package version)))
1422 (unless (assoc key ,listname)
1423 (push (list key ,status (package-desc-doc ,desc)) ,listname))))
1425 (defun package-menu--generate (remember-pos packages)
1426 "Populate the Package Menu.
1427 If REMEMBER-POS is non-nil, keep point on the same entry.
1428 PACKAGES should be t, which means to display all known packages,
1429 or a list of package names (symbols) to display."
1430 ;; Construct list of ((PACKAGE . VERSION) STATUS DESCRIPTION).
1431 (let (info-list name)
1432 ;; Installed packages:
1433 (dolist (elt package-alist)
1434 (setq name (car elt))
1435 (when (or (eq packages t) (memq name packages))
1436 (package--push name (cdr elt)
1437 (if (stringp (cadr (assq name package-load-list)))
1438 "held" "installed")
1439 info-list)))
1441 ;; Built-in packages:
1442 (dolist (elt package--builtins)
1443 (setq name (car elt))
1444 (when (and (not (eq name 'emacs)) ; Hide the `emacs' package.
1445 (or (eq packages t) (memq name packages)))
1446 (package--push name (cdr elt) "built-in" info-list)))
1448 ;; Available and disabled packages:
1449 (dolist (elt package-archive-contents)
1450 (setq name (car elt))
1451 (when (or (eq packages t) (memq name packages))
1452 (let ((hold (assq name package-load-list)))
1453 (package--push name (cdr elt)
1454 (cond
1455 ((and hold (null (cadr hold))) "disabled")
1456 ((memq name package-menu--new-package-list) "new")
1457 (t "available"))
1458 info-list))))
1460 ;; Obsolete packages:
1461 (dolist (elt package-obsolete-alist)
1462 (dolist (inner-elt (cdr elt))
1463 (when (or (eq packages t) (memq (car elt) packages))
1464 (package--push (car elt) (cdr inner-elt) "obsolete" info-list))))
1466 ;; Print the result.
1467 (setq tabulated-list-entries (mapcar 'package-menu--print-info info-list))
1468 (tabulated-list-print remember-pos)))
1470 (defun package-menu--print-info (pkg)
1471 "Return a package entry suitable for `tabulated-list-entries'.
1472 PKG has the form ((PACKAGE . VERSION) STATUS DOC).
1473 Return (KEY [NAME VERSION STATUS DOC]), where KEY is the
1474 identifier (NAME . VERSION-LIST)."
1475 (let* ((package (caar pkg))
1476 (version (cdr (car pkg)))
1477 (status (nth 1 pkg))
1478 (doc (or (nth 2 pkg) ""))
1479 (face (cond
1480 ((string= status "built-in") 'font-lock-builtin-face)
1481 ((string= status "available") 'default)
1482 ((string= status "new") 'bold)
1483 ((string= status "held") 'font-lock-constant-face)
1484 ((string= status "disabled") 'font-lock-warning-face)
1485 ((string= status "installed") 'font-lock-comment-face)
1486 (t 'font-lock-warning-face)))) ; obsolete.
1487 (list (cons package version)
1488 (vector (list (symbol-name package)
1489 'face 'link
1490 'follow-link t
1491 'package-symbol package
1492 'action 'package-menu-describe-package)
1493 (propertize (package-version-join version)
1494 'font-lock-face face)
1495 (propertize status 'font-lock-face face)
1496 (propertize doc 'font-lock-face face)))))
1498 (defun package-menu-refresh ()
1499 "Download the Emacs Lisp package archive.
1500 This fetches the contents of each archive specified in
1501 `package-archives', and then refreshes the package menu."
1502 (interactive)
1503 (unless (derived-mode-p 'package-menu-mode)
1504 (error "The current buffer is not a Package Menu"))
1505 (package-refresh-contents)
1506 (package-menu--generate t t))
1508 (defun package-menu-describe-package (&optional button)
1509 "Describe the current package.
1510 If optional arg BUTTON is non-nil, describe its associated package."
1511 (interactive)
1512 (let ((package (if button (button-get button 'package-symbol)
1513 (car (tabulated-list-get-id)))))
1514 (if package
1515 (describe-package package))))
1517 ;; fixme numeric argument
1518 (defun package-menu-mark-delete (&optional _num)
1519 "Mark a package for deletion and move to the next line."
1520 (interactive "p")
1521 (if (member (package-menu-get-status) '("installed" "obsolete"))
1522 (tabulated-list-put-tag "D" t)
1523 (forward-line)))
1525 (defun package-menu-mark-install (&optional _num)
1526 "Mark a package for installation and move to the next line."
1527 (interactive "p")
1528 (if (member (package-menu-get-status) '("available" "new"))
1529 (tabulated-list-put-tag "I" t)
1530 (forward-line)))
1532 (defun package-menu-mark-unmark (&optional _num)
1533 "Clear any marks on a package and move to the next line."
1534 (interactive "p")
1535 (tabulated-list-put-tag " " t))
1537 (defun package-menu-backup-unmark ()
1538 "Back up one line and clear any marks on that package."
1539 (interactive)
1540 (forward-line -1)
1541 (tabulated-list-put-tag " "))
1543 (defun package-menu-mark-obsolete-for-deletion ()
1544 "Mark all obsolete packages for deletion."
1545 (interactive)
1546 (save-excursion
1547 (goto-char (point-min))
1548 (while (not (eobp))
1549 (if (equal (package-menu-get-status) "obsolete")
1550 (tabulated-list-put-tag "D" t)
1551 (forward-line 1)))))
1553 (defun package-menu-quick-help ()
1554 "Show short key binding help for package-menu-mode."
1555 (interactive)
1556 (message "n-ext, i-nstall, d-elete, u-nmark, x-ecute, r-efresh, h-elp"))
1558 (define-obsolete-function-alias
1559 'package-menu-view-commentary 'package-menu-describe-package "24.1")
1561 (defun package-menu-get-status ()
1562 (let* ((pkg (tabulated-list-get-id))
1563 (entry (and pkg (assq pkg tabulated-list-entries))))
1564 (if entry
1565 (aref (cadr entry) 2)
1566 "")))
1568 (defun package-menu--find-upgrades ()
1569 (let (installed available upgrades)
1570 ;; Build list of installed/available packages in this buffer.
1571 (dolist (entry tabulated-list-entries)
1572 ;; ENTRY is ((NAME . VERSION) [NAME VERSION STATUS DOC])
1573 (let ((pkg (car entry))
1574 (status (aref (cadr entry) 2)))
1575 (cond ((equal status "installed")
1576 (push pkg installed))
1577 ((member status '("available" "new"))
1578 (push pkg available)))))
1579 ;; Loop through list of installed packages, finding upgrades
1580 (dolist (pkg installed)
1581 (let ((avail-pkg (assq (car pkg) available)))
1582 (and avail-pkg
1583 (version-list-< (cdr pkg) (cdr avail-pkg))
1584 (push avail-pkg upgrades))))
1585 upgrades))
1587 (defun package-menu-mark-upgrades ()
1588 "Mark all upgradable packages in the Package Menu.
1589 For each installed package with a newer version available, place
1590 an (I)nstall flag on the available version and a (D)elete flag on
1591 the installed version. A subsequent \\[package-menu-execute]
1592 call will upgrade the package."
1593 (interactive)
1594 (unless (derived-mode-p 'package-menu-mode)
1595 (error "The current buffer is not a Package Menu"))
1596 (let ((upgrades (package-menu--find-upgrades)))
1597 (if (null upgrades)
1598 (message "No packages to upgrade.")
1599 (widen)
1600 (save-excursion
1601 (goto-char (point-min))
1602 (while (not (eobp))
1603 (let* ((pkg (tabulated-list-get-id))
1604 (upgrade (assq (car pkg) upgrades)))
1605 (cond ((null upgrade)
1606 (forward-line 1))
1607 ((equal pkg upgrade)
1608 (package-menu-mark-install))
1610 (package-menu-mark-delete))))))
1611 (message "%d package%s marked for upgrading."
1612 (length upgrades)
1613 (if (= (length upgrades) 1) "" "s")))))
1615 (defun package-menu-execute (&optional noquery)
1616 "Perform marked Package Menu actions.
1617 Packages marked for installation are downloaded and installed;
1618 packages marked for deletion are removed.
1619 Optional argument NOQUERY non-nil means do not ask the user to confirm."
1620 (interactive)
1621 (unless (derived-mode-p 'package-menu-mode)
1622 (error "The current buffer is not in Package Menu mode"))
1623 (let (install-list delete-list cmd id)
1624 (save-excursion
1625 (goto-char (point-min))
1626 (while (not (eobp))
1627 (setq cmd (char-after))
1628 (unless (eq cmd ?\s)
1629 ;; This is the key (PACKAGE . VERSION-LIST).
1630 (setq id (tabulated-list-get-id))
1631 (cond ((eq cmd ?D)
1632 (push (cons (symbol-name (car id))
1633 (package-version-join (cdr id)))
1634 delete-list))
1635 ((eq cmd ?I)
1636 (push (car id) install-list))))
1637 (forward-line)))
1638 (when install-list
1639 (if (or
1640 noquery
1641 (yes-or-no-p
1642 (if (= (length install-list) 1)
1643 (format "Install package `%s'? " (car install-list))
1644 (format "Install these %d packages (%s)? "
1645 (length install-list)
1646 (mapconcat 'symbol-name install-list ", ")))))
1647 (mapc 'package-install install-list)))
1648 ;; Delete packages, prompting if necessary.
1649 (when delete-list
1650 (if (or
1651 noquery
1652 (yes-or-no-p
1653 (if (= (length delete-list) 1)
1654 (format "Delete package `%s-%s'? "
1655 (caar delete-list)
1656 (cdr (car delete-list)))
1657 (format "Delete these %d packages (%s)? "
1658 (length delete-list)
1659 (mapconcat (lambda (elt)
1660 (concat (car elt) "-" (cdr elt)))
1661 delete-list
1662 ", ")))))
1663 (dolist (elt delete-list)
1664 (condition-case-unless-debug err
1665 (package-delete (car elt) (cdr elt))
1666 (error (message (cadr err)))))
1667 (error "Aborted")))
1668 ;; If we deleted anything, regenerate `package-alist'. This is done
1669 ;; automatically if we installed a package.
1670 (and delete-list (null install-list)
1671 (package-initialize))
1672 (if (or delete-list install-list)
1673 (package-menu--generate t t)
1674 (message "No operations specified."))))
1676 (defun package-menu--version-predicate (A B)
1677 (let ((vA (or (aref (cadr A) 1) '(0)))
1678 (vB (or (aref (cadr B) 1) '(0))))
1679 (if (version-list-= vA vB)
1680 (package-menu--name-predicate A B)
1681 (version-list-< vA vB))))
1683 (defun package-menu--status-predicate (A B)
1684 (let ((sA (aref (cadr A) 2))
1685 (sB (aref (cadr B) 2)))
1686 (cond ((string= sA sB)
1687 (package-menu--name-predicate A B))
1688 ((string= sA "new") t)
1689 ((string= sB "new") nil)
1690 ((string= sA "available") t)
1691 ((string= sB "available") nil)
1692 ((string= sA "installed") t)
1693 ((string= sB "installed") nil)
1694 ((string= sA "held") t)
1695 ((string= sB "held") nil)
1696 ((string= sA "built-in") t)
1697 ((string= sB "built-in") nil)
1698 ((string= sA "obsolete") t)
1699 ((string= sB "obsolete") nil)
1700 (t (string< sA sB)))))
1702 (defun package-menu--description-predicate (A B)
1703 (let ((dA (aref (cadr A) 3))
1704 (dB (aref (cadr B) 3)))
1705 (if (string= dA dB)
1706 (package-menu--name-predicate A B)
1707 (string< dA dB))))
1709 (defun package-menu--name-predicate (A B)
1710 (string< (symbol-name (caar A))
1711 (symbol-name (caar B))))
1713 ;;;###autoload
1714 (defun list-packages (&optional no-fetch)
1715 "Display a list of packages.
1716 This first fetches the updated list of packages before
1717 displaying, unless a prefix argument NO-FETCH is specified.
1718 The list is displayed in a buffer named `*Packages*'."
1719 (interactive "P")
1720 (require 'finder-inf nil t)
1721 ;; Initialize the package system if necessary.
1722 (unless package--initialized
1723 (package-initialize t))
1724 (let (old-archives new-packages)
1725 (unless no-fetch
1726 ;; Read the locally-cached archive-contents.
1727 (package-read-all-archive-contents)
1728 (setq old-archives package-archive-contents)
1729 ;; Fetch the remote list of packages.
1730 (package-refresh-contents)
1731 ;; Find which packages are new.
1732 (dolist (elt package-archive-contents)
1733 (unless (assq (car elt) old-archives)
1734 (push (car elt) new-packages))))
1736 ;; Generate the Package Menu.
1737 (let ((buf (get-buffer-create "*Packages*")))
1738 (with-current-buffer buf
1739 (package-menu-mode)
1740 (set (make-local-variable 'package-menu--new-package-list)
1741 new-packages)
1742 (package-menu--generate nil t))
1743 ;; The package menu buffer has keybindings. If the user types
1744 ;; `M-x list-packages', that suggests it should become current.
1745 (switch-to-buffer buf))
1747 (let ((upgrades (package-menu--find-upgrades)))
1748 (if upgrades
1749 (message "%d package%s can be upgraded; type `%s' to mark %s for upgrading."
1750 (length upgrades)
1751 (if (= (length upgrades) 1) "" "s")
1752 (substitute-command-keys "\\[package-menu-mark-upgrades]")
1753 (if (= (length upgrades) 1) "it" "them"))))))
1755 ;;;###autoload
1756 (defalias 'package-list-packages 'list-packages)
1758 ;; Used in finder.el
1759 (defun package-show-package-list (packages)
1760 "Display PACKAGES in a *Packages* buffer.
1761 This is similar to `list-packages', but it does not fetch the
1762 updated list of packages, and it only displays packages with
1763 names in PACKAGES (which should be a list of symbols)."
1764 (require 'finder-inf nil t)
1765 (let ((buf (get-buffer-create "*Packages*")))
1766 (with-current-buffer buf
1767 (package-menu-mode)
1768 (package-menu--generate nil packages))
1769 (switch-to-buffer buf)))
1771 (defun package-list-packages-no-fetch ()
1772 "Display a list of packages.
1773 Does not fetch the updated list of packages before displaying.
1774 The list is displayed in a buffer named `*Packages*'."
1775 (interactive)
1776 (list-packages t))
1778 (provide 'package)
1780 ;;; package.el ends here