package.el 68.9 KB
Newer Older
1 2
;;; package.el --- Simple package system for Emacs

3
;; Copyright (C) 2007-2013 Free Software Foundation, Inc.
4 5 6

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

;; This file is part of GNU Emacs.

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

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

;;; Change Log:

;;  2 Apr 2007 - now using ChangeLog file
;; 15 Mar 2007 - updated documentation
;; 14 Mar 2007 - Changed how obsolete packages are handled
;; 13 Mar 2007 - Wrote package-install-from-buffer
;; 12 Mar 2007 - Wrote package-menu mode

;;; Commentary:

;; The idea behind package.el is to be able to download packages and
;; install them.  Packages are versioned and have versioned
;; dependencies.  Furthermore, this supports built-in packages which
;; may or may not be newer than user-specified packages.  This makes
;; it possible to upgrade Emacs and automatically disable packages
;; which have moved from external to core.  (Note though that we don't
;; currently register any of these, so this feature does not actually
;; work.)

;; A package is described by its name and version.  The distribution
;; format is either  a tar file or a single .el file.

;; A tar file should be named "NAME-VERSION.tar".  The tar file must
;; unpack into a directory named after the package and version:
;; "NAME-VERSION".  It must contain a file named "PACKAGE-pkg.el"
;; which consists of a call to define-package.  It may also contain a
;; "dir" file and the info files it references.

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

57 58 59 60
;; The downloader downloads all dependent packages.  By default,
;; packages come from the official GNU sources, but others may be
;; added by customizing the `package-archives' alist.  Packages get
;; byte-compiled at install time.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78

;; At activation time we will set up the load-path and the info path,
;; and we will load the package's autoloads.  If a package's
;; dependencies are not available, we will not activate that package.

;; Conceptually a package has multiple state transitions:
;;
;; * Download.  Fetching the package from ELPA.
;; * Install.  Untar the package, or write the .el file, into
;;   ~/.emacs.d/elpa/ directory.
;; * Byte compile.  Currently this phase is done during install,
;;   but we may change this.
;; * Activate.  Evaluate the autoloads for the package to make it
;;   available to the user.
;; * Load.  Actually load the package and run some code from it.

;; Other external functions you may want to use:
;;
79
;; M-x list-packages
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
;;    Enters a mode similar to buffer-menu which lets you manage
;;    packages.  You can choose packages for install (mark with "i",
;;    then "x" to execute) or deletion (not implemented yet), and you
;;    can see what packages are available.  This will automatically
;;    fetch the latest list of packages from ELPA.
;;
;; M-x package-install-from-buffer
;;    Install a package consisting of a single .el file that appears
;;    in the current buffer.  This only works for packages which
;;    define a Version header properly; package.el also supports the
;;    extension headers Package-Version (in case Version is an RCS id
;;    or similar), and Package-Requires (if the package requires other
;;    packages).
;;
;; M-x package-install-file
;;    Install a package from the indicated file.  The package can be
;;    either a tar file or a .el file.  A tar file must contain an
;;    appropriately-named "-pkg.el" file; a .el file must be properly
;;    formatted as with package-install-from-buffer.

;;; Thanks:
;;; (sorted by sort-lines):

;; Jim Blandy <jimb@red-bean.com>
;; Karl Fogel <kfogel@red-bean.com>
;; Kevin Ryde <user42@zip.com.au>
;; Lawrence Mitchell
;; Michael Olson <mwolson@member.fsf.org>
;; Sebastian Tennant <sebyte@smolny.plus.com>
;; Stefan Monnier <monnier@iro.umontreal.ca>
;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
;; Phil Hagelberg <phil@hagelb.org>

;;; ToDo:

115 116
;; - a trust mechanism, since compiling a package can run arbitrary code.
;;   For example, download package signatures and check that they match.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
;; - putting info dirs at the start of the info path means
;;   users see a weird ordering of categories.  OTOH we want to
;;   override later entries.  maybe emacs needs to enforce
;;   the standard layout?
;; - put bytecode in a separate directory tree
;; - perhaps give users a way to recompile their bytecode
;;   or do it automatically when emacs changes
;; - give users a way to know whether a package is installed ok
;; - give users a way to view a package's documentation when it
;;   only appears in the .el
;; - use/extend checkdoc so people can tell if their package will work
;; - "installed" instead of a blank in the status column
;; - tramp needs its files to be compiled in a certain order.
;;   how to handle this?  fix tramp?
;; - on emacs 21 we don't kill the -autoloads.el buffer.  what about 22?
;; - maybe we need separate .elc directories for various emacs versions
;;   and also emacs-vs-xemacs.  That way conditional compilation can
;;   work.  But would this break anything?
;; - should store the package's keywords in archive-contents, then
;;   let the users filter the package-menu by keyword.  See
;;   finder-by-keyword.  (We could also let people view the
;;   Commentary, but it isn't clear how useful this is.)
;; - William Xu suggests being able to open a package file without
;;   installing it
;; - Interface with desktop.el so that restarting after an install
;;   works properly
;; - Implement M-x package-upgrade, to upgrade any/all existing packages
;; - Use hierarchical layout.  PKG/etc PKG/lisp PKG/info
;;   ... except maybe lisp?
;; - It may be nice to have a macro that expands to the package's
;;   private data dir, aka ".../etc".  Or, maybe data-directory
;;   needs to be a list (though this would be less nice)
;;   a few packages want this, eg sokoban
;; - package menu needs:
;;     ability to know which packages are built-in & thus not deletable
;;     it can sometimes print odd results, like 0.3 available but 0.4 active
;;        why is that?
;; - Allow multiple versions on the server...?
;;   [ why bother? ]
;; - Don't install a package which will invalidate dependencies overall
;; - Allow something like (or (>= emacs 21.0) (>= xemacs 21.5))
;;   [ currently thinking, why bother.. KISS ]
;; - Allow optional package dependencies
;;   then if we require 'bbdb', bbdb-specific lisp in lisp/bbdb
;;   and just don't compile to add to load path ...?
;; - Have a list of archive URLs?  [ maybe there's no point ]
;; - David Kastrup pointed out on the xemacs list that for GPL it
;;   is friendlier to ship the source tree.  We could "support" that
;;   by just having a "src" subdir in the package.  This isn't ideal
;;   but it probably is not worth trying to support random source
;;   tree layouts, build schemes, etc.
;; - Our treatment of the info path is somewhat bogus
;; - perhaps have an "unstable" tree in ELPA as well as a stable one

;;; Code:

173 174
(eval-when-compile (require 'cl-lib))

175 176
(require 'tabulated-list)

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
(defgroup package nil
  "Manager for Emacs Lisp packages."
  :group 'applications
  :version "24.1")

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

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

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

For an element (NAME VERSION), NAME is a package name (a symbol).
VERSION should be t, a string, or nil.
If VERSION is t, all versions are loaded, though obsolete ones
 will be put in `package-obsolete-alist' and not activated.
If VERSION is a string, only that version is ever loaded.
 Any other version, even if newer, is silently ignored.
 Hence, the package is \"held\" at that version.
If VERSION is nil, the package is not loaded (it is \"disabled\")."
  :type '(repeat symbol)
210
  :risky t
211 212 213 214 215 216 217 218
  :group 'package
  :version "24.1")

(defvar Info-directory-list)
(declare-function info-initialize "info" ())
(declare-function url-http-parse-response "url-http" ())
(declare-function lm-header "lisp-mnt" (header))
(declare-function lm-commentary "lisp-mnt" (&optional file))
219
(defvar url-http-end-of-headers)
220

221 222 223
(defcustom package-archives '(("gnu" . "http://elpa.gnu.org/packages/"))
  "An alist of archives from which to fetch.
The default value points to the GNU Emacs package repository.
224 225 226 227 228 229

Each element has the form (ID . LOCATION).
 ID is an archive name, as a string.
 LOCATION specifies the base location for the archive.
  If it starts with \"http:\", it is treated as a HTTP URL;
  otherwise it should be an absolute directory name.
230 231 232 233
  (Other types of URL are currently not supported.)

Only add locations that you trust, since fetching and installing
a package can run arbitrary code."
234
  :type '(alist :key-type (string :tag "Archive name")
235
                :value-type (string :tag "URL or directory name"))
236 237 238
  :risky t
  :group 'package
  :version "24.1")
239

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
(defcustom package-pinned-packages nil
  "An alist of packages that are pinned to a specific archive

Each element has the form (SYM . ID).
 SYM is a package, as a symbol.
 ID is an archive name, as a string. This should correspond to an
 entry in `package-archives'.

If the archive of name ID does not contain the package SYM, no
other location will be considered, which will make the
package unavailable."
  :type '(alist :key-type (symbol :tag "Package")
                :value-type (string :tag "Archive name"))
  :risky t
  :group 'package
  :version "24.4")

257 258 259 260
(defconst package-archive-version 1
  "Version number of the package archive understood by this file.
Lower version numbers than this will probably be understood as well.")

261
(defconst package-el-version "1.0.1"
262 263 264 265 266
  "Version of package.el.")

;; We don't prime the cache since it tends to get out of date.
(defvar package-archive-contents nil
  "Cache of the contents of the Emacs Lisp Package Archive.
267 268
This is an alist mapping package names (symbols) to
`package--desc' structures.")
269
(put 'package-archive-contents 'risky-local-variable t)
270 271 272 273 274 275 276

(defcustom package-user-dir (locate-user-emacs-file "elpa")
  "Directory containing the user's Emacs Lisp packages.
The directory name should be absolute.
Apart from this directory, Emacs also looks for system-wide
packages in `package-directory-list'."
  :type 'directory
277
  :risky t
278 279 280 281 282 283 284
  :group 'package
  :version "24.1")

(defcustom package-directory-list
  ;; Defaults are subdirs named "elpa" in the site-lisp dirs.
  (let (result)
    (dolist (f load-path)
285 286 287
      (and (stringp f)
	   (equal (file-name-nondirectory f) "site-lisp")
	   (push (expand-file-name "elpa" f) result)))
288 289 290 291 292 293 294
    (nreverse result))
  "List of additional directories containing Emacs Lisp packages.
Each directory name should be absolute.

These directories contain packages intended for system-wide; in
contrast, `package-user-dir' contains packages for personal use."
  :type '(repeat directory)
295
  :risky t
296 297 298
  :group 'package
  :version "24.1")

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
(defvar package--default-summary "No description available.")

(cl-defstruct (package-desc
               ;; Rename the default constructor from `make-package-desc'.
               (:constructor package-desc-create)
               ;; Has the same interface as the old `define-package',
               ;; which is still used in the "foo-pkg.el" files. Extra
               ;; options can be supported by adding additional keys.
               (:constructor
                package-desc-from-define
                (name-string version-string &optional summary requirements
                 &key kind archive
                 &aux
                 (name (intern name-string))
                 (version (version-to-list version-string))
                 (reqs (mapcar #'(lambda (elt)
                                   (list (car elt)
                                         (version-to-list (cadr elt))))
                               (if (eq 'quote (car requirements))
                                   (nth 1 requirements)
                                 requirements))))))
  "Structure containing information about an individual package.

Slots:

`name' Name of the package, as a symbol.

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

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

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

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

`archive' The name of the archive (as a string) whence this
package came."
  name
  version
  (summary package--default-summary)
  reqs
  kind
  archive)

;; Package descriptor format used in finder-inf.el and package--builtins.
(cl-defstruct (package--bi-desc
               (:constructor package-make-builtin (version summary))
               (:type vector))
  version
  reqs
  summary)

355
;; The value is precomputed in finder-inf.el, but don't load that
Juanma Barranquero's avatar
Juanma Barranquero committed
356
;; until it's needed (i.e. when `package-initialize' is called).
357 358
(defvar package--builtins nil
  "Alist of built-in packages.
359 360 361 362
The actual value is initialized by loading the library
`finder-inf'; this is not done until it is needed, e.g. by the
function `package-built-in-p'.

363 364
Each element has the form (PKG . PACKAGE-BI-DESC), where PKG is a package
name (a symbol) and DESC is a `package--bi-desc' structure.")
365
(put 'package--builtins 'risky-local-variable t)
366

367
(defvar package-alist nil
368
  "Alist of all packages available for activation.
369
Each element has the form (PKG . DESC), where PKG is a package
370
name (a symbol) and DESC is a `package-desc' structure.
371 372 373 374

This variable is set automatically by `package-load-descriptor',
called via `package-initialize'.  To change which packages are
loaded and/or activated, customize `package-load-list'.")
375
(put 'package-alist 'risky-local-variable t)
376

377
(defvar package-activated-list nil
378
  "List of the names of currently activated packages.")
379
(put 'package-activated-list 'risky-local-variable t)
380 381 382 383

(defvar package-obsolete-alist nil
  "Representation of obsolete packages.
Like `package-alist', but maps package name to a second alist.
384 385 386 387
The inner alist is keyed by version.

Each element of the list is (NAME . VERSION-ALIST), where each
entry in VERSION-ALIST is (VERSION-LIST . PACKAGE-DESC).")
388
(put 'package-obsolete-alist 'risky-local-variable t)
389

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
(defun package-version-join (vlist)
  "Return the version string corresponding to the list VLIST.
This is, approximately, the inverse of `version-to-list'.
\(Actually, it returns only one of the possible inverses, since
`version-to-list' is a many-to-one operation.)"
  (if (null vlist)
      ""
    (let ((str-list (list "." (int-to-string (car vlist)))))
      (dolist (num (cdr vlist))
	(cond
	 ((>= num 0)
	  (push (int-to-string num) str-list)
	  (push "." str-list))
	 ((< num -3)
	  (error "Invalid version list `%s'" vlist))
	 (t
	  ;; pre, or beta, or alpha
	  (cond ((equal "." (car str-list))
		 (pop str-list))
		((not (string-match "[0-9]+" (car str-list)))
		 (error "Invalid version list `%s'" vlist)))
	  (push (cond ((= num -1) "pre")
		      ((= num -2) "beta")
		      ((= num -3) "alpha"))
		str-list))))
      (if (equal "." (car str-list))
	  (pop str-list))
      (apply 'concat (nreverse str-list)))))
418 419 420 421

(defun package-strip-version (dirname)
  "Strip the version from a combined package name and version.
E.g., if given \"quux-23.0\", will return \"quux\""
422
  (if (string-match (concat "\\`" package-subdirectory-regexp "\\'") dirname)
423 424 425
      (match-string 1 dirname)))

(defun package-load-descriptor (dir package)
426
  "Load the description file in directory DIR for package PACKAGE.
Chong Yidong's avatar
Chong Yidong committed
427 428
Here, PACKAGE is a string of the form NAME-VERSION, where NAME is
the package name and VERSION is its version."
429 430 431 432 433 434 435
  (let* ((pkg-dir (expand-file-name package dir))
	 (pkg-file (expand-file-name
		    (concat (package-strip-version package) "-pkg")
		    pkg-dir)))
    (when (and (file-directory-p pkg-dir)
	       (file-exists-p (concat pkg-file ".el")))
      (load pkg-file nil t))))
436 437 438 439 440 441 442 443 444 445

(defun package-load-all-descriptors ()
  "Load descriptors for installed Emacs Lisp packages.
This looks for package subdirectories in `package-user-dir' and
`package-directory-list'.  The variable `package-load-list'
controls which package subdirectories may be loaded.

In each valid package subdirectory, this function loads the
description file containing a call to `define-package', which
updates `package-alist' and `package-obsolete-alist'."
446
  (let ((regexp (concat "\\`" package-subdirectory-regexp "\\'")))
447 448 449
    (dolist (dir (cons package-user-dir package-directory-list))
      (when (file-directory-p dir)
	(dolist (subdir (directory-files dir))
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
	  (when (string-match regexp subdir)
	    (package-maybe-load-descriptor (match-string 1 subdir)
					   (match-string 2 subdir)
					   dir)))))))

(defun package-maybe-load-descriptor (name version dir)
  "Maybe load a specific package from directory DIR.
NAME and VERSION are the package's name and version strings.
This function checks `package-load-list', before actually loading
the package by calling `package-load-descriptor'."
  (let ((force (assq (intern name) package-load-list))
	(subdir (concat name "-" version)))
    (and (file-directory-p (expand-file-name subdir dir))
	 ;; Check `package-load-list':
	 (cond ((null force)
		(memq 'all package-load-list))
	       ((null (setq force (cadr force)))
		nil) ; disabled
	       ((eq force t)
		t)
	       ((stringp force) ; held
		(version-list-= (version-to-list version)
				(version-to-list force)))
	       (t
		(error "Invalid element in `package-load-list'")))
	 ;; Actually load the descriptor:
	 (package-load-descriptor dir subdir))))
477

478
(define-obsolete-function-alias 'package-desc-vers 'package-desc-version "24.4")
479

480
(define-obsolete-function-alias 'package-desc-doc 'package-desc-summary "24.4")
481 482


483
(defun package--dir (name version)
484
  ;; FIXME: Keep this as a field in the package-desc.
485
  "Return the directory where a package is installed, or nil if none.
486 487
NAME is a symbol and VERSION is a string."
  (let* ((subdir (format "%s-%s" name version))
488
	 (dir-list (cons package-user-dir package-directory-list))
489
	 pkg-dir)
490
    (while dir-list
491 492 493 494
      (let ((subdir-full (expand-file-name subdir (car dir-list))))
	(if (file-directory-p subdir-full)
	    (setq pkg-dir  subdir-full
		  dir-list nil)
495
	  (setq dir-list (cdr dir-list)))))
496 497
    pkg-dir))

498 499 500
(defun package-activate-1 (pkg-desc)
  (let* ((name (package-desc-name pkg-desc))
	 (version-str (package-version-join (package-desc-version pkg-desc)))
501
	 (pkg-dir (package--dir name version-str)))
502
    (unless pkg-dir
503
      (error "Internal error: unable to find directory for `%s-%s'"
504 505
	     name version-str))
    ;; Add info node.
506 507 508 509 510
    (when (file-exists-p (expand-file-name "dir" pkg-dir))
      ;; FIXME: not the friendliest, but simple.
      (require 'info)
      (info-initialize)
      (push pkg-dir Info-directory-list))
511
    ;; Add to load path, add autoloads, and activate the package.
512
    (push pkg-dir load-path)
513 514
    (load (expand-file-name (format "%s-autoloads" name) pkg-dir) nil t)
    (push name package-activated-list)
515 516 517
    ;; Don't return nil.
    t))

Chong Yidong's avatar
Chong Yidong committed
518 519 520 521
(defun package-built-in-p (package &optional min-version)
  "Return true if PACKAGE is built-in to Emacs.
Optional arg MIN-VERSION, if non-nil, should be a version list
specifying the minimum acceptable version."
522
  (require 'finder-inf nil t) ; For `package--builtins'.
523 524 525 526
  (if (eq package 'emacs)
      (version-list-<= min-version (version-to-list emacs-version))
    (let ((elt (assq package package--builtins)))
      (and elt (version-list-<= min-version
527 528 529 530 531 532
				(package--bi-desc-version (cdr elt)))))))

(defun package--from-builtin (bi-desc)
  (package-desc-create :name (pop bi-desc)
                       :version (package--bi-desc-version bi-desc)
                       :summary (package--bi-desc-summary bi-desc)))
533

534 535 536 537
;; This function goes ahead and activates a newer version of a package
;; if an older one was already activated.  This is not ideal; we'd at
;; least need to check to see if the package has actually been loaded,
;; and not merely activated.
Chong Yidong's avatar
Chong Yidong committed
538 539 540
(defun package-activate (package min-version)
  "Activate package PACKAGE, of version MIN-VERSION or newer.
MIN-VERSION should be a version list.
541
If PACKAGE has any dependencies, recursively activate them.
542
Return nil if the package could not be activated."
543 544 545 546
  (let ((pkg-vec (cdr (assq package package-alist)))
	available-version found)
    ;; Check if PACKAGE is available in `package-alist'.
    (when pkg-vec
547
      (setq available-version (package-desc-version pkg-vec)
Chong Yidong's avatar
Chong Yidong committed
548
	    found (version-list-<= min-version available-version)))
549 550 551
    (cond
     ;; If no such package is found, maybe it's built-in.
     ((null found)
Chong Yidong's avatar
Chong Yidong committed
552
      (package-built-in-p package min-version))
553 554 555 556 557 558 559 560 561 562 563 564
     ;; If the package is already activated, just return t.
     ((memq package package-activated-list)
      t)
     ;; Otherwise, proceed with activation.
     (t
      (let ((fail (catch 'dep-failure
		    ;; Activate its dependencies recursively.
		    (dolist (req (package-desc-reqs pkg-vec))
		      (unless (package-activate (car req) (cadr req))
			(throw 'dep-failure req))))))
	(if fail
	    (warn "Unable to activate package `%s'.
565
Required package `%s-%s' is unavailable"
566 567
		  package (car fail) (package-version-join (cadr fail)))
	  ;; If all goes well, activate the package itself.
568
	  (package-activate-1 pkg-vec)))))))
569 570 571 572 573 574 575

(defun package-mark-obsolete (package pkg-vec)
  "Put package on the obsolete list, if not already there."
  (let ((elt (assq package package-obsolete-alist)))
    (if elt
	;; If this obsolete version does not exist in the list, update
	;; it the list.
576 577
	(unless (assoc (package-desc-version pkg-vec) (cdr elt))
	  (setcdr elt (cons (cons (package-desc-version pkg-vec) pkg-vec)
578 579
			    (cdr elt))))
      ;; Make a new association.
580
      (push (cons package (list (cons (package-desc-version pkg-vec)
581 582
				      pkg-vec)))
	    package-obsolete-alist))))
583

584
(defun define-package (name-string version-string
585
				&optional docstring requirements
586
				&rest _extra-properties)
587
  "Define a new package.
588
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
589
VERSION-STRING is the version of the package, as a string.
590 591
DOCSTRING is a short description of the package, a string.
REQUIREMENTS is a list of dependencies on other packages.
Chong Yidong's avatar
Chong Yidong committed
592 593
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
594 595

EXTRA-PROPERTIES is currently unused."
596 597
  (let* ((name (intern name-string))
	 (version (version-to-list version-string))
598 599 600 601 602
	 (new-pkg-desc (cons name
                             (package-desc-from-define name-string
                                                       version-string
                                                       docstring
                                                       requirements)))
603 604 605 606 607
	 (old-pkg (assq name package-alist)))
    (cond
     ;; If there's no old package, just add this to `package-alist'.
     ((null old-pkg)
      (push new-pkg-desc package-alist))
608
     ((version-list-< (package-desc-version (cdr old-pkg)) version)
609 610 611 612 613 614 615
      ;; Remove the old package and declare it obsolete.
      (package-mark-obsolete name (cdr old-pkg))
      (setq package-alist (cons new-pkg-desc
				(delq old-pkg package-alist))))
     ;; You can have two packages with the same version, e.g. one in
     ;; the system package directory and one in your private
     ;; directory.  We just let the first one win.
616
     ((not (version-list-= (package-desc-version (cdr old-pkg)) version))
617 618
      ;; The package is born obsolete.
      (package-mark-obsolete name (cdr new-pkg-desc))))))
619 620 621 622 623 624 625 626 627

;; From Emacs 22.
(defun package-autoload-ensure-default-file (file)
  "Make sure that the autoload file FILE exists and if not create it."
  (unless (file-exists-p file)
    (write-region
     (concat ";;; " (file-name-nondirectory file)
	     " --- automatically extracted autoloads\n"
	     ";;\n"
628 629
	     ";;; Code:\n"
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
630 631 632 633 634 635 636 637 638 639 640
	     "\n;; Local Variables:\n"
	     ";; version-control: never\n"
	     ";; no-byte-compile: t\n"
	     ";; no-update-autoloads: t\n"
	     ";; End:\n"
	     ";;; " (file-name-nondirectory file)
	     " ends here\n")
     nil file))
  file)

(defun package-generate-autoloads (name pkg-dir)
Paul Eggert's avatar
Paul Eggert committed
641
  (require 'autoload)         ;Load before we let-bind generated-autoload-file!
642
  (let* ((auto-name (format "%s-autoloads.el" name))
643
	 ;;(ignore-name (concat name "-pkg.el"))
644 645
	 (generated-autoload-file (expand-file-name auto-name pkg-dir))
	 (version-control 'never))
646
    (package-autoload-ensure-default-file generated-autoload-file)
647 648
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
649 650
      (when buf (kill-buffer buf)))
    auto-name))
651

652 653
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
654 655
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
656 657

(defun package-untar-buffer (dir)
658
  "Untar the current buffer.
659 660
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
661
  (require 'tar-mode)
662 663
  (tar-mode)
  ;; Make sure everything extracts into DIR.
664 665
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
	(case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
666
    (dolist (tar-data tar-parse-info)
667 668 669 670 671 672 673
      (let ((name (expand-file-name (tar-header-name tar-data))))
	(or (string-match regexp name)
	    ;; Tarballs created by some utilities don't list
	    ;; directories with a trailing slash (Bug#13136).
	    (and (string-equal dir name)
		 (eq (tar-header-link-type tar-data) 5))
	    (error "Package does not untar cleanly into directory %s/" dir)))))
674
  (tar-untar-buffer))
675

676 677 678
(defun package-unpack (package version)
  (let* ((name (symbol-name package))
	 (dirname (concat name "-" version))
679
	 (pkg-dir (expand-file-name dirname package-user-dir)))
680
    (make-directory package-user-dir t)
681
    ;; FIXME: should we delete PKG-DIR if it exists?
682
    (let* ((default-directory (file-name-as-directory package-user-dir)))
683
      (package-untar-buffer dirname)
684
      (package--make-autoloads-and-compile package pkg-dir))))
685 686 687 688

(defun package--make-autoloads-and-compile (name pkg-dir)
  "Generate autoloads and do byte-compilation for package named NAME.
PKG-DIR is the name of the package directory."
689 690
  (let ((auto-name (package-generate-autoloads name pkg-dir))
        (load-path (cons pkg-dir load-path)))
691 692
    ;; We must load the autoloads file before byte compiling, in
    ;; case there are magic cookies to set up non-trivial paths.
693 694 695 696
    (load auto-name nil t)
    ;; FIXME: Compilation should be done as a separate, optional, step.
    ;; E.g. for multi-package installs, we should first install all packages
    ;; and then compile them.
697
    (byte-recompile-directory pkg-dir 0 t)))
698

699
(defun package--write-file-no-coding (file-name)
700
  (let ((buffer-file-coding-system 'no-conversion))
701
    (write-region (point-min) (point-max) file-name)))
702

703
(defun package-unpack-single (name version desc requires)
704
  "Install the contents of the current buffer as a package."
705 706
  ;; Special case "package".  FIXME: Should this still be supported?
  (if (eq name 'package)
707
      (package--write-file-no-coding
708 709
       (expand-file-name (format "%s.el" name) package-user-dir))
    (let* ((pkg-dir  (expand-file-name (format "%s-%s" name
710 711
					       (package-version-join
						(version-to-list version)))
712
				       package-user-dir))
713 714
	   (el-file  (expand-file-name (format "%s.el" name) pkg-dir))
	   (pkg-file (expand-file-name (format "%s-pkg.el" name) pkg-dir)))
715
      (make-directory pkg-dir t)
716
      (package--write-file-no-coding el-file)
717
      (let ((print-level nil)
718
            (print-quoted t)
719 720 721 722 723
	    (print-length nil))
	(write-region
	 (concat
	  (prin1-to-string
	   (list 'define-package
724
		 (symbol-name name)
725 726
		 version
		 desc
727 728 729 730 731 732 733 734
                 (when requires         ;Don't bother quoting nil.
                   (list 'quote
                         ;; Turn version lists into string form.
                         (mapcar
                          (lambda (elt)
                            (list (car elt)
                                  (package-version-join (cadr elt))))
                          requires)))))
735 736 737 738
	  "\n")
	 nil
	 pkg-file
	 nil nil nil 'excl))
739
      (package--make-autoloads-and-compile name pkg-dir))))
740

741 742 743 744 745 746 747 748 749
(defmacro package--with-work-buffer (location file &rest body)
  "Run BODY in a buffer containing the contents of FILE at LOCATION.
LOCATION is the base location of a package archive, and should be
one of the URLs (or file names) specified in `package-archives'.
FILE is the name of a file relative to that base location.

This macro retrieves FILE from LOCATION into a temporary buffer,
and evaluates BODY while that buffer is current.  This work
buffer is killed afterwards.  Return the last value in BODY."
750
  `(let* ((http (string-match "\\`https?:" ,location))
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
	  (buffer
	   (if http
	       (url-retrieve-synchronously (concat ,location ,file))
	     (generate-new-buffer "*package work buffer*"))))
     (prog1
	 (with-current-buffer buffer
	   (if http
	       (progn (package-handle-response)
		      (re-search-forward "^$" nil 'move)
		      (forward-char)
		      (delete-region (point-min) (point)))
	     (unless (file-name-absolute-p ,location)
	       (error "Archive location %s is not an absolute file name"
		      ,location))
	     (insert-file-contents (expand-file-name ,file ,location)))
	   ,@body)
       (kill-buffer buffer))))

769
(defun package-handle-response ()
770
  "Handle the response from a `url-retrieve-synchronously' call.
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
Parse the HTTP response and throw if an error occurred.
The url package seems to require extra processing for this.
This should be called in a `save-excursion', in the download buffer.
It will move point to somewhere in the headers."
  ;; We assume HTTP here.
  (require 'url-http)
  (let ((response (url-http-parse-response)))
    (when (or (< response 200) (>= response 300))
      (error "Error during download request:%s"
	     (buffer-substring-no-properties (point) (progn
						       (end-of-line)
						       (point)))))))

(defun package-download-single (name version desc requires)
  "Download and install a single-file package."
786 787 788
  (let ((location (package-archive-base name))
	(file (concat (symbol-name name) "-" version ".el")))
    (package--with-work-buffer location file
789
      (package-unpack-single name version desc requires))))
790 791 792

(defun package-download-tar (name version)
  "Download and install a tar package."
793 794 795 796
  (let ((location (package-archive-base name))
	(file (concat (symbol-name name) "-" version ".tar")))
    (package--with-work-buffer location file
      (package-unpack name version))))
797

798 799
(defvar package--initialized nil)

800
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
801 802
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
MIN-VERSION should be a version list."
803
  (unless package--initialized (error "package.el is not yet initialized!"))
804
  (let ((pkg-desc (assq package package-alist)))
805 806
    (if pkg-desc
	(version-list-<= min-version
807
			 (package-desc-version (cdr pkg-desc)))
808 809
      ;; Also check built-in packages.
      (package-built-in-p package min-version))))
810

811 812 813 814 815
(defun package-compute-transaction (package-list requirements)
  "Return a list of packages to be installed, including PACKAGE-LIST.
PACKAGE-LIST should be a list of package names (symbols).

REQUIREMENTS should be a list of additional requirements; each
Chong Yidong's avatar
Chong Yidong committed
816 817 818
element in this list should have the form (PACKAGE VERSION-LIST),
where PACKAGE is a package name and VERSION-LIST is the required
version of that package.
819 820 821 822 823

This function recursively computes the requirements of the
packages in REQUIREMENTS, and returns a list of all the packages
that must be installed.  Packages that are already installed are
not included in this list."
824 825 826 827 828 829
  (dolist (elt requirements)
    (let* ((next-pkg (car elt))
	   (next-version (cadr elt)))
      (unless (package-installed-p next-pkg next-version)
	;; A package is required, but not installed.  It might also be
	;; blocked via `package-load-list'.
830
	(let ((pkg-desc (cdr (assq next-pkg package-archive-contents)))
831 832 833
	      hold)
	  (when (setq hold (assq next-pkg package-load-list))
	    (setq hold (cadr hold))
834 835
	    (cond ((eq hold t))
		  ((eq hold nil)
836 837 838 839
		   (error "Required package '%s' is disabled"
			  (symbol-name next-pkg)))
		  ((null (stringp hold))
		   (error "Invalid element in `package-load-list'"))
840
		  ((version-list-< (version-to-list hold) next-version)
841
		   (error "Package `%s' held at version %s, \
842 843 844 845
but version %s required"
			  (symbol-name next-pkg) hold
			  (package-version-join next-version)))))
	  (unless pkg-desc
846
	    (error "Package `%s-%s' is unavailable"
847 848
		   (symbol-name next-pkg)
		   (package-version-join next-version)))
849
	  (unless (version-list-<= next-version
850
				   (package-desc-version pkg-desc))
851
	    (error
852
	     "Need package `%s-%s', but only %s is available"
853
	     (symbol-name next-pkg) (package-version-join next-version)
854
	     (package-version-join (package-desc-version pkg-desc))))
855 856
          ;; Move to front, so it gets installed early enough (bug#14082).
          (setq package-list (cons next-pkg (delq next-pkg package-list)))
857 858
	  (setq package-list
		(package-compute-transaction package-list
859
					     (package-desc-reqs
860
					      pkg-desc)))))))
861
  package-list)
862 863 864 865 866

(defun package-read-from-string (str)
  "Read a Lisp expression from STR.
Signal an error if the entire string was not used."
  (let* ((read-data (read-from-string str))
867 868 869 870 871 872 873
	 (more-left
	  (condition-case nil
	      ;; The call to `ignore' suppresses a compiler warning.
	      (progn (ignore (read-from-string
			      (substring str (cdr read-data))))
		     t)
	    (end-of-file nil))))
874 875 876 877 878 879 880 881 882
    (if more-left
        (error "Can't read whole string")
      (car read-data))))

(defun package--read-archive-file (file)
  "Re-read archive file FILE, if it exists.
Will return the data from the file, or nil if the file does not exist.
Will throw an error if the archive version is too new."
  (let ((filename (expand-file-name file package-user-dir)))
883 884 885 886 887 888 889 890
    (when (file-exists-p filename)
      (with-temp-buffer
	(insert-file-contents-literally filename)
	(let ((contents (read (current-buffer))))
	  (if (> (car contents) package-archive-version)
	      (error "Package archive version %d is higher than %d"
		     (car contents) package-archive-version))
	  (cdr contents))))))
891

892
(defun package-read-all-archive-contents ()
893 894
  "Re-read `archive-contents', if it exists.
If successful, set `package-archive-contents'."
895
  (setq package-archive-contents nil)
896
  (dolist (archive package-archives)
897
    (package-read-archive-contents (car archive))))
898

899
(defun package-read-archive-contents (archive)
900 901
  "Re-read archive contents for ARCHIVE.
If successful, set the variable `package-archive-contents'.
902
If the archive version is too new, signal an error."
903 904 905 906 907 908 909 910
  ;; Version 1 of 'archive-contents' is identical to our internal
  ;; representation.
  (let* ((dir (concat "archives/" archive))
	 (contents-file (concat dir "/archive-contents"))
	 contents)
    (when (setq contents (package--read-archive-file contents-file))
      (dolist (package contents)
	(package--add-to-archive-contents package archive)))))
911

912 913 914 915 916 917 918 919 920
;; Package descriptor objects used inside the "archive-contents" file.
;; Changing this defstruct implies changing the format of the
;; "archive-contents" files.
(cl-defstruct (package--ac-desc
               (:constructor package-make-ac-desc (version reqs summary kind))
               (:copier nil)
               (:type vector))
  version reqs summary kind)

921 922
(defun package--add-to-archive-contents (package archive)
  "Add the PACKAGE from the given ARCHIVE if necessary.
923 924 925 926 927 928 929 930 931 932 933 934
PACKAGE should have the form (NAME . PACKAGE--AC-DESC).
Also, add the originating archive to the `package-desc' structure."
  (let* ((name (car package))
         (pkg-desc
          (package-desc-create
           :name name
           :version (package--ac-desc-version (cdr package))
           :reqs (package--ac-desc-reqs (cdr package))
           :summary (package--ac-desc-summary (cdr package))
           :kind (package--ac-desc-kind (cdr package))
           :archive archive))
         (entry (cons name pkg-desc))
935 936 937 938 939 940 941
         (existing-package (assq name package-archive-contents))
         (pinned-to-archive (assoc name package-pinned-packages)))
    (cond ((and pinned-to-archive
                ;; If pinned to another archive, skip entirely.
                (not (equal (cdr pinned-to-archive) archive)))
           nil)
          ((not existing-package)
942 943 944
	   (push entry package-archive-contents))
	  ((version-list-< (package-desc-version (cdr existing-package))
			   (package-desc-version pkg-desc))
945 946 947 948 949
	   ;; Replace the entry with this one.
	   (setq package-archive-contents
		 (cons entry
		       (delq existing-package
			     package-archive-contents)))))))
950

951 952 953 954 955 956 957
(defun package-download-transaction (package-list)
  "Download and install all the packages in PACKAGE-LIST.
PACKAGE-LIST should be a list of package names (symbols).
This function assumes that all package requirements in
PACKAGE-LIST are satisfied, i.e. that PACKAGE-LIST is computed
using `package-compute-transaction'."
  (dolist (elt package-list)
958 959 960 961 962
    (let* ((desc (cdr (assq elt package-archive-contents)))
	   ;; As an exception, if package is "held" in
	   ;; `package-load-list', download the held version.
	   (hold (cadr (assq elt package-load-list)))
	   (v-string (or (and (stringp hold) hold)
963
			 (package-version-join (package-desc-version desc))))
964 965 966 967 968 969
	   (kind (package-desc-kind desc)))
      (cond
       ((eq kind 'tar)
	(package-download-tar elt v-string))
       ((eq kind 'single)
	(package-download-single elt v-string
970
				 (package-desc-summary desc)
971 972
				 (package-desc-reqs desc)))
       (t
973 974 975 976 977 978 979
	(error "Unknown package kind: %s" (symbol-name kind))))
      ;; If package A depends on package B, then A may `require' B
      ;; during byte compilation.  So we need to activate B before
      ;; unpacking A.
      (package-maybe-load-descriptor (symbol-name elt) v-string
				     package-user-dir)
      (package-activate elt (version-to-list v-string)))))
980 981 982 983

;;;###autoload
(defun package-install (name)
  "Install the package named NAME.
984 985
NAME should be the name of one of the available packages in an
archive in `package-archives'.  Interactively, prompt for NAME."
986
  (interactive
987 988 989 990 991
   (progn
     ;; Initialize the package system to get the list of package
     ;; symbols for completion.
     (unless package--initialized
       (package-initialize t))
992 993
     (unless package-archive-contents
       (package-refresh-contents))
994 995 996 997 998 999 1000
     (list (intern (completing-read
		    "Install package: "
		    (mapcar (lambda (elt)
			      (cons (symbol-name (car elt))
				    nil))
			    package-archive-contents)
		    nil t)))))
1001 1002
  (let ((pkg-desc (assq name package-archive-contents)))
    (unless pkg-desc
1003
      (error "Package `%s' is not available for installation"
1004
	     (symbol-name name)))
1005 1006
    (package-download-transaction
     (package-compute-transaction (list name)
1007
				  (package-desc-reqs (cdr pkg-desc))))))
1008

1009 1010
(defun package-strip-rcs-id (str)
  "Strip RCS version ID from the version string STR.
1011 1012
If the result looks like a dotted numeric version, return it.
Otherwise return nil."
1013 1014 1015 1016 1017 1018 1019
  (when str
    (when (string-match "\\`[ \t]*[$]Revision:[ \t]+" str)
      (setq str (substring str (match-end 0))))
    (condition-case nil
	(if (version-to-list str)
	    str)
      (error nil))))
1020 1021

(defun package-buffer-info ()
1022
  "Return a `package-desc' describing the package in the current buffer.
1023 1024 1025 1026

If the buffer does not contain a conforming package, signal an
error.  If there is a package, narrow the buffer to the file's
boundaries."
1027
  (goto-char (point-min))
1028
  (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
    (error "Packages lacks a file header"))
  (let ((file-name (match-string-no-properties 1))
	(desc      (match-string-no-properties 2))
	(start     (line-beginning-position)))
    (unless (search-forward (concat ";;; " file-name ".el ends here"))
      (error "Package lacks a terminating comment"))
    ;; Try to include a trailing newline.
    (forward-line)
    (narrow-to-region start (point))
    (require 'lisp-mnt)
    ;; Use some headers we've invented to drive the process.
    (let* ((requires-str (lm-header "package-requires"))
	   ;; Prefer Package-Version; if defined, the package author
	   ;; probably wants us to use it.  Otherwise try Version.
	   (pkg-version
	    (or (package-strip-rcs-id (lm-header "package-version"))
1045
		(package-strip-rcs-id (lm-header "version")))))
1046 1047 1048
      (unless pkg-version
	(error
	 "Package lacks a \"Version\" or \"Package-Version\" header"))
1049 1050 1051 1052
      (package-desc-from-define
       file-name pkg-version desc
       (if requires-str (package-read-from-string requires-str))
       :kind 'single))))
1053 1054 1055 1056 1057

(defun package-tar-file-info (file)
  "Find package information for a tar file.
FILE is the name of the tar file to examine.
The return result is a vector like `package-buffer-info'."
1058 1059
  (let ((default-directory (file-name-directory file))
	(file (file-name-nondirectory file)))
1060 1061
    (unless (string-match (concat "\\`" package-subdirectory-regexp "\\.tar\\'")
			  file)
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
      (error "Invalid package name `%s'" file))
    (let* ((pkg-name (match-string-no-properties 1 file))
	   (pkg-version (match-string-no-properties 2 file))
	   ;; Extract the package descriptor.
	   (pkg-def-contents (shell-command-to-string
			      ;; Requires GNU tar.
			      (concat "tar -xOf " file " "
				      pkg-name "-" pkg-version "/"
				      pkg-name "-pkg.el")))
	   (pkg-def-parsed (package-read-from-string pkg-def-contents)))
      (unless (eq (car pkg-def-parsed) 'define-package)
	(error "No `define-package' sexp is present in `%s-pkg.el'" pkg-name))
1074 1075 1076 1077 1078
      (let ((pkg-desc
             (apply #'package-desc-from-define (append (cdr pkg-def-parsed)
                                                       '(:kind tar)))))
	(unless (equal pkg-version
                       (package-version-join (package-desc-version pkg-desc)))
1079
	  (error "Package has inconsistent versions"))
1080
        (unless (equal pkg-name (symbol-name (package-desc-name pkg-desc)))
1081
	  (error "Package has inconsistent names"))
1082 1083
        pkg-desc))))

1084

1085
;;;###autoload
1086
(defun package-install-from-buffer (pkg-desc)
1087 1088 1089 1090 1091
  "Install a package from the current buffer.
When called interactively, the current buffer is assumed to be a
single .el file that follows the packaging guidelines; see info
node `(elisp)Packaging'.

1092 1093 1094
When called from Lisp, PKG-DESC is a `package-desc' describing the
information)."
  (interactive (list (package-buffer-info)))
1095 1096
  (save-excursion
    (save-restriction
1097 1098 1099 1100
      (let* ((name      (package-desc-name pkg-desc))
	     (requires  (package-desc-reqs pkg-desc))
	     (desc      (package-desc-summary pkg-desc))
	     (pkg-version (package-desc-version pkg-desc)))
1101 1102 1103 1104
	;; Download and install the dependencies.
	(let ((transaction (package-compute-transaction nil requires)))
	  (package-download-transaction transaction))
	;; Install the package itself.
1105 1106 1107 1108
	(pcase (package-desc-kind pkg-desc)
	 (`single (package-unpack-single name pkg-version desc requires))
	 (`tar    (package-unpack name pkg-version))
	 (type    (error "Unknown type: %S" type)))
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	;; Try to activate it.
	(package-initialize)))))

;;;###autoload
(defun package-install-file (file)
  "Install a package from a file.
The file can either be a tar file or an Emacs Lisp file."
  (interactive "fPackage file name: ")
  (with-temp-buffer
    (insert-file-contents-literally file)
    (cond
1120 1121 1122 1123
     ((string-match "\\.el\\'" file)
      (package-install-from-buffer (package-buffer-info)))
     ((string-match "\\.tar\\'" file)
      (package-install-from-buffer (package-tar-file-info file)))
1124 1125 1126
     (t (error "Unrecognized extension `%s'" (file-name-extension file))))))

(defun package-delete (name version)
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
  (let ((dir (package--dir name version)))
    (if (string-equal (file-name-directory dir)
		      (file-name-as-directory
		       (expand-file-name package-user-dir)))
	(progn
	  (delete-directory dir t t)
	  (message "Package `%s-%s' deleted." name version))
      ;; Don't delete "system" packages
      (error "Package `%s-%s' is a system package, not deleting"
	     name version))))
1137

1138
(defun package-archive-base (name)
1139 1140
  "Return the archive containing the package NAME."
  (let ((desc (cdr (assq (intern-soft name) package-archive-contents))))
1141
    (cdr (assoc (package-desc-archive desc) package-archives))))
1142 1143

(defun package--download-one-archive (archive file)
1144 1145 1146 1147 1148 1149 1150
  "Retrieve an archive file FILE from ARCHIVE, and cache it.
ARCHIVE should be a cons cell of the form (NAME . LOCATION),
similar to an entry in `package-alist'.  Save the cached copy to
\"archives/NAME/archive-contents\" in `package-user-dir'."
  (let* ((dir (expand-file-name "archives" package-user-dir))
	 (dir (expand-file-name (car archive) dir)))
    (package--with-work-buffer (cdr archive) file
1151 1152 1153 1154 1155 1156
      ;; Read the retrieved buffer to make sure it is valid (e.g. it
      ;; may fetch a URL redirect page).
      (when (listp (read buffer))
	(make-directory dir t)
	(setq buffer-file-name (expand-file-name file dir))
	(let ((version-control 'never))
1157
	  (save-buffer))))))
1158

1159
;;;###autoload
1160 1161
(defun package-refresh-contents ()
  "Download the ELPA archive description if needed.
1162 1163
This informs Emacs about the latest versions of all packages, and
makes them available for download."
1164 1165 1166
  (interactive)
  (unless (file-exists-p package-user-dir)
    (make-directory package-user-dir t))
1167
  (dolist (archive package-archives)
1168
    (condition-case-unless-debug nil
1169
	(package--download-one-archive archive "archive-contents")
1170
      (error (message "Failed to download `%s' archive."
1171
		      (car archive)))))
1172
  (package-read-all-archive-contents))
1173 1174

;;;###autoload
1175
(defun package-initialize (&optional no-activate)
1176
  "Load Emacs Lisp packages, and activate them.
1177 1178
The variable `package-load-list' controls which packages to load.
If optional arg NO-ACTIVATE is non-nil, don't activate packages."
1179
  (interactive)
1180