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