package.el 83 KB
Newer Older
1
;;; package.el --- Simple package system for Emacs  -*- lexical-binding:t -*-
2

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

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

;; This file is part of GNU Emacs.

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

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

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

;;; Change Log:

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

;;; Commentary:

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

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

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

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

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

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

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

;; Other external functions you may want to use:
;;
80
;; M-x list-packages
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
;;    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:

116 117
;; - a trust mechanism, since compiling a package can run arbitrary code.
;;   For example, download package signatures and check that they match.
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
;; - putting info dirs at the start of the info path means
;;   users see a weird ordering of categories.  OTOH we want to
;;   override later entries.  maybe emacs needs to enforce
;;   the standard layout?
;; - put bytecode in a separate directory tree
;; - perhaps give users a way to recompile their bytecode
;;   or do it automatically when emacs changes
;; - give users a way to know whether a package is installed ok
;; - give users a way to view a package's documentation when it
;;   only appears in the .el
;; - use/extend checkdoc so people can tell if their package will work
;; - "installed" instead of a blank in the status column
;; - tramp needs its files to be compiled in a certain order.
;;   how to handle this?  fix tramp?
;; - on emacs 21 we don't kill the -autoloads.el buffer.  what about 22?
;; - maybe we need separate .elc directories for various emacs versions
;;   and also emacs-vs-xemacs.  That way conditional compilation can
;;   work.  But would this break anything?
;; - should store the package's keywords in archive-contents, then
;;   let the users filter the package-menu by keyword.  See
;;   finder-by-keyword.  (We could also let people view the
;;   Commentary, but it isn't clear how useful this is.)
;; - William Xu suggests being able to open a package file without
;;   installing it
;; - Interface with desktop.el so that restarting after an install
;;   works properly
;; - Use hierarchical layout.  PKG/etc PKG/lisp PKG/info
;;   ... except maybe lisp?
;; - It may be nice to have a macro that expands to the package's
;;   private data dir, aka ".../etc".  Or, maybe data-directory
;;   needs to be a list (though this would be less nice)
;;   a few packages want this, eg sokoban
;; - package menu needs:
;;     ability to know which packages are built-in & thus not deletable
;;     it can sometimes print odd results, like 0.3 available but 0.4 active
;;        why is that?
;; - Allow multiple versions on the server...?
;;   [ why bother? ]
;; - Don't install a package which will invalidate dependencies overall
;; - Allow something like (or (>= emacs 21.0) (>= xemacs 21.5))
;;   [ currently thinking, why bother.. KISS ]
;; - Allow optional package dependencies
;;   then if we require 'bbdb', bbdb-specific lisp in lisp/bbdb
;;   and just don't compile to add to load path ...?
;; - Our treatment of the info path is somewhat bogus

;;; Code:

166 167
(eval-when-compile (require 'cl-lib))

168 169
(require 'tabulated-list)

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

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

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

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

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

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

212 213 214
(defcustom package-archives '(("gnu" . "http://elpa.gnu.org/packages/"))
  "An alist of archives from which to fetch.
The default value points to the GNU Emacs package repository.
215 216 217 218 219 220

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

Only add locations that you trust, since fetching and installing
a package can run arbitrary code."
225
  :type '(alist :key-type (string :tag "Archive name")
226
                :value-type (string :tag "URL or directory name"))
227 228 229
  :risky t
  :group 'package
  :version "24.1")
230

231 232 233 234 235
(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.
236
 ID is an archive name. This should correspond to an
237 238 239 240 241 242 243 244 245 246 247
 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")

248 249 250 251 252 253 254
(defconst package-archive-version 1
  "Version number of the package archive understood by this file.
Lower version numbers than this will probably be understood as well.")

;; We don't prime the cache since it tends to get out of date.
(defvar package-archive-contents nil
  "Cache of the contents of the Emacs Lisp Package Archive.
255
This is an alist mapping package names (symbols) to
256
non-empty lists of `package-desc' structures.")
257
(put 'package-archive-contents 'risky-local-variable t)
258 259 260 261 262 263 264

(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
265
  :risky t
266 267 268 269 270 271 272
  :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)
273 274 275
      (and (stringp f)
	   (equal (file-name-nondirectory f) "site-lisp")
	   (push (expand-file-name "elpa" f) result)))
276 277 278 279 280 281 282
    (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)
283
  :risky t
284 285 286
  :group 'package
  :version "24.1")

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
(defcustom package-check-signature 'allow-unsigned
  "Whether to check package signatures when installing."
  :type '(choice (const nil :tag "Never")
		 (const allow-unsigned :tag "Allow unsigned")
		 (const t :tag "Check always"))
  :risky t
  :group 'package
  :version "24.1")

(defcustom package-unsigned-archives nil
  "A list of archives which do not use package signature."
  :type '(repeat (string :tag "Archive name"))
  :risky t
  :group 'package
  :version "24.1")

303 304 305 306 307 308 309 310 311 312 313
(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
314
                 &rest rest-plist
315 316 317 318 319 320 321 322
                 &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)
323 324 325 326 327
                                 requirements)))
                 (kind (plist-get rest-plist :kind))
                 (archive (plist-get rest-plist :archive))
                 (extras (let (alist)
                           (while rest-plist
328 329 330
                             (unless (memq (car rest-plist) '(:kind :archive))
                               (let ((value (cadr rest-plist)))
                                 (when value
331 332
                                   (push (cons (car rest-plist)
                                               (if (eq (car-safe value) 'quote)
Dmitry Gutov's avatar
Dmitry Gutov committed
333
                                                   (cadr value)
334
                                                 value))
335
                                         alist))))
336 337
                             (setq rest-plist (cddr rest-plist)))
                           alist)))))
338 339 340
  "Structure containing information about an individual package.
Slots:

341
`name'	Name of the package, as a symbol.
342 343 344 345

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

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

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

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

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

358
`dir'	The directory where the package is installed (if installed),
359 360
	`builtin' if it is built-in, or nil otherwise.

361 362 363
`extras' Optional alist of additional keyword-value pairs.

`signed' Flag to indicate that the package is signed by provider."
364 365 366 367 368
  name
  version
  (summary package--default-summary)
  reqs
  kind
369
  archive
370
  dir
371 372
  extras
  signed)
373 374

;; Pseudo fields.
375
(defun package-desc-full-name (pkg-desc)
376 377 378
  (format "%s-%s"
          (package-desc-name pkg-desc)
          (package-version-join (package-desc-version pkg-desc))))
379

380 381 382 383 384 385
(defun package-desc-suffix (pkg-desc)
  (pcase (package-desc-kind pkg-desc)
    (`single ".el")
    (`tar ".tar")
    (kind (error "Unknown package kind: %s" kind))))

386 387
(defun package-desc--keywords (pkg-desc)
  (let ((keywords (cdr (assoc :keywords (package-desc-extras pkg-desc)))))
388
    (if (eq (car-safe keywords) 'quote)
389
        (nth 1 keywords)
390 391
      keywords)))

392 393 394 395 396 397 398 399
;; 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)

400 401
(defvar package--builtins nil
  "Alist of built-in packages.
402 403 404 405
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'.

406 407
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.")
408
(put 'package--builtins 'risky-local-variable t)
409

410
(defvar package-alist nil
411
  "Alist of all packages available for activation.
412 413 414
Each element has the form (PKG . DESCS), where PKG is a package
name (a symbol) and DESCS is a non-empty list of `package-desc' structure,
sorted by decreasing versions.
415 416 417 418

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

421
(defvar package-activated-list nil
422
  ;; FIXME: This should implicitly include all builtin packages.
423
  "List of the names of currently activated packages.")
424
(put 'package-activated-list 'risky-local-variable t)
425

426 427 428 429 430 431 432 433 434 435 436 437 438
(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))
439
	 ((< num -4)
440 441 442 443 444 445 446 447 448
	  (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")
449 450
		      ((= num -3) "alpha")
                      ((= num -4) "snapshot"))
451 452 453 454
		str-list))))
      (if (equal "." (car str-list))
	  (pop str-list))
      (apply 'concat (nreverse str-list)))))
455

456 457 458
(defun package-load-descriptor (pkg-dir)
  "Load the description file in directory PKG-DIR."
  (let ((pkg-file (expand-file-name (package--description-file pkg-dir)
459 460
                                    pkg-dir))
	(signed-file (concat pkg-dir ".signed")))
461 462 463 464
    (when (file-exists-p pkg-file)
      (with-temp-buffer
        (insert-file-contents pkg-file)
        (goto-char (point-min))
465 466
        (let ((pkg-desc (package-process-define-package
                         (read (current-buffer)) pkg-file)))
467
          (setf (package-desc-dir pkg-desc) pkg-dir)
468 469
	  (if (file-exists-p signed-file)
	      (setf (package-desc-signed pkg-desc) t))
470
          pkg-desc)))))
471 472 473 474 475 476 477 478 479

(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
480
updates `package-alist'."
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
  (dolist (dir (cons package-user-dir package-directory-list))
    (when (file-directory-p dir)
      (dolist (subdir (directory-files dir))
        (let ((pkg-dir (expand-file-name subdir dir)))
          (when (file-directory-p pkg-dir)
            (package-load-descriptor pkg-dir)))))))

(defun package-disabled-p (pkg-name version)
  "Return whether PKG-NAME at VERSION can be activated.
The decision is made according to `package-load-list'.
Return nil if the package can be activated.
Return t if the package is completely disabled.
Return the max version (as a string) if the package is held at a lower version."
  (let ((force (assq pkg-name package-load-list)))
    (cond ((null force) (not (memq 'all package-load-list)))
          ((null (setq force (cadr force))) t) ; disabled
          ((eq force t) nil)
          ((stringp force)              ; held
           (unless (version-list-= version (version-to-list force))
             force))
          (t (error "Invalid element in `package-load-list'")))))
502

503 504
(defun package-activate-1 (pkg-desc)
  (let* ((name (package-desc-name pkg-desc))
505 506
	 (pkg-dir (package-desc-dir pkg-desc))
         (pkg-dir-dir (file-name-as-directory pkg-dir)))
507
    (unless pkg-dir
508 509
      (error "Internal error: unable to find directory for `%s'"
	     (package-desc-full-name pkg-desc)))
510 511
    ;; Add to load path, add autoloads, and activate the package.
    (let ((old-lp load-path))
512 513
      (with-demoted-errors
        (load (expand-file-name (format "%s-autoloads" name) pkg-dir) nil t))
514 515 516 517 518 519
      (when (and (eq old-lp load-path)
                 (not (or (member pkg-dir load-path)
                          (member pkg-dir-dir load-path))))
        ;; Old packages don't add themselves to the `load-path', so we have to
        ;; do it ourselves.
        (push pkg-dir load-path)))
520
    ;; Add info node.
521 522 523 524 525
    (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))
526
    (push name package-activated-list)
527 528 529
    ;; Don't return nil.
    t))

Chong Yidong's avatar
Chong Yidong committed
530 531 532 533
(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."
534 535 536 537 538
  (if (package-desc-p package) ;; was built-in and then was converted
      (eq 'builtin (package-desc-dir package))
    (let ((bi (assq package package--builtin-versions)))
      (cond
       (bi (version-list-<= min-version (cdr bi)))
539
       ((remove 0 min-version) nil)
540 541 542
       (t
        (require 'finder-inf nil t) ; For `package--builtins'.
        (assq package package--builtins))))))
543 544 545 546

(defun package--from-builtin (bi-desc)
  (package-desc-create :name (pop bi-desc)
                       :version (package--bi-desc-version bi-desc)
547 548
                       :summary (package--bi-desc-summary bi-desc)
                       :dir 'builtin))
549

550 551 552 553
;; 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.
554 555 556 557
(defun package-activate (package &optional force)
  "Activate package PACKAGE.
If FORCE is true, (re-)activate it if it's already activated."
  (let ((pkg-descs (cdr (assq package package-alist))))
558
    ;; Check if PACKAGE is available in `package-alist'.
559 560 561 562 563 564 565
    (while
        (when pkg-descs
          (let ((available-version (package-desc-version (car pkg-descs))))
            (or (package-disabled-p package available-version)
                ;; Prefer a builtin package.
                (package-built-in-p package available-version))))
      (setq pkg-descs (cdr pkg-descs)))
566 567
    (cond
     ;; If no such package is found, maybe it's built-in.
568 569
     ((null pkg-descs)
      (package-built-in-p package))
570
     ;; If the package is already activated, just return t.
571
     ((and (memq package package-activated-list) (not force))
572 573 574
      t)
     ;; Otherwise, proceed with activation.
     (t
575 576 577 578 579 580
      (let* ((pkg-vec (car pkg-descs))
             (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))))))
581 582
	(if fail
	    (warn "Unable to activate package `%s'.
583
Required package `%s-%s' is unavailable"
584 585
		  package (car fail) (package-version-join (cadr fail)))
	  ;; If all goes well, activate the package itself.
586
	  (package-activate-1 pkg-vec)))))))
587

588 589 590
(defun define-package (_name-string _version-string
                                    &optional _docstring _requirements
                                    &rest _extra-properties)
591
  "Define a new package.
592
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
593
VERSION-STRING is the version of the package, as a string.
594 595
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
596 597
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
598 599

EXTRA-PROPERTIES is currently unused."
600 601 602 603 604 605 606 607 608
  ;; FIXME: Placeholder!  Should we keep it?
  (error "Don't call me!"))

(defun package-process-define-package (exp origin)
  (unless (eq (car-safe exp) 'define-package)
    (error "Can't find define-package in %s" origin))
  (let* ((new-pkg-desc (apply #'package-desc-from-define (cdr exp)))
         (name (package-desc-name new-pkg-desc))
         (version (package-desc-version new-pkg-desc))
609 610 611 612 613
         (old-pkgs (assq name package-alist)))
    (if (null old-pkgs)
        ;; If there's no old package, just add this to `package-alist'.
        (push (list name new-pkg-desc) package-alist)
      ;; If there is, insert the new package at the right place in the list.
614 615 616 617 618 619 620
      (while
          (if (and (cdr old-pkgs)
                   (version-list-< version
                                   (package-desc-version (cadr old-pkgs))))
              (setq old-pkgs (cdr old-pkgs))
            (push new-pkg-desc (cdr old-pkgs))
            nil)))
621
    new-pkg-desc))
622

623
;; From Emacs 22, but changed so it adds to load-path.
624 625 626 627 628 629 630
(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"
631 632
	     ";;; Code:\n"
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
633 634 635 636 637 638 639
	     "\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")
640
     nil file nil 'silent))
641 642
  file)

643 644 645
(defvar generated-autoload-file)
(defvar version-control)

646
(defun package-generate-autoloads (name pkg-dir)
647
  (let* ((auto-name (format "%s-autoloads.el" name))
648
	 ;;(ignore-name (concat name "-pkg.el"))
649 650
	 (generated-autoload-file (expand-file-name auto-name pkg-dir))
	 (version-control 'never))
651
    (package-autoload-ensure-default-file generated-autoload-file)
652 653
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
654 655
      (when buf (kill-buffer buf)))
    auto-name))
656

657 658
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
659 660
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
661 662

(defun package-untar-buffer (dir)
663
  "Untar the current buffer.
664 665
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
666
  (require 'tar-mode)
667 668
  (tar-mode)
  ;; Make sure everything extracts into DIR.
669 670
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
	(case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
671
    (dolist (tar-data tar-parse-info)
672 673 674 675 676 677 678
      (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)))))
679
  (tar-untar-buffer))
680

681 682 683 684 685 686 687 688 689 690 691
(defun package-generate-description-file (pkg-desc pkg-dir)
  "Create the foo-pkg.el file for single-file packages."
  (let* ((name (package-desc-name pkg-desc))
         (pkg-file (expand-file-name (package--description-file pkg-dir)
                                     pkg-dir)))
    (let ((print-level nil)
          (print-quoted t)
          (print-length nil))
      (write-region
       (concat
        (prin1-to-string
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
         (nconc
          (list 'define-package
                (symbol-name name)
                (package-version-join (package-desc-version pkg-desc))
                (package-desc-summary pkg-desc)
                (let ((requires (package-desc-reqs pkg-desc)))
                  (list 'quote
                        ;; Turn version lists into string form.
                        (mapcar
                         (lambda (elt)
                           (list (car elt)
                                 (package-version-join (cadr elt))))
                         requires))))
          (package--alist-to-plist
           (package-desc-extras pkg-desc))))
707
        "\n")
708
       nil pkg-file nil 'silent))))
709

710 711 712
(defun package--alist-to-plist (alist)
  (apply #'nconc (mapcar (lambda (pair) (list (car pair) (cdr pair))) alist)))

713 714 715 716
(defun package-unpack (pkg-desc)
  "Install the contents of the current buffer as a package."
  (let* ((name (package-desc-name pkg-desc))
         (dirname (package-desc-full-name pkg-desc))
717
	 (pkg-dir (expand-file-name dirname package-user-dir)))
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
    (pcase (package-desc-kind pkg-desc)
      (`tar
       (make-directory package-user-dir t)
       ;; FIXME: should we delete PKG-DIR if it exists?
       (let* ((default-directory (file-name-as-directory package-user-dir)))
         (package-untar-buffer dirname)))
      (`single
       (let ((el-file (expand-file-name (format "%s.el" name) pkg-dir)))
         (make-directory pkg-dir t)
         (package--write-file-no-coding el-file)))
      (kind (error "Unknown package kind: %S" kind)))
    (package--make-autoloads-and-stuff pkg-desc pkg-dir)
    ;; Update package-alist.
    (let ((new-desc (package-load-descriptor pkg-dir)))
      ;; FIXME: Check that `new-desc' matches `desc'!
      ;; FIXME: Compilation should be done as a separate, optional, step.
      ;; E.g. for multi-package installs, we should first install all packages
      ;; and then compile them.
      (package--compile new-desc))
    ;; Try to activate it.
738
    (package-activate name 'force)
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
    pkg-dir))

(defun package--make-autoloads-and-stuff (pkg-desc pkg-dir)
  "Generate autoloads, description file, etc.. for PKG-DESC installed at PKG-DIR."
  (package-generate-autoloads (package-desc-name pkg-desc) pkg-dir)
  (let ((desc-file (package--description-file pkg-dir)))
    (unless (file-exists-p desc-file)
      (package-generate-description-file pkg-desc pkg-dir)))
  ;; FIXME: Create foo.info and dir file from foo.texi?
  )

(defun package--compile (pkg-desc)
  "Byte-compile installed package PKG-DESC."
  (package-activate-1 pkg-desc)
  (byte-recompile-directory (package-desc-dir pkg-desc) 0 t))
754

755
(defun package--write-file-no-coding (file-name)
756
  (let ((buffer-file-coding-system 'no-conversion))
757
    (write-region (point-min) (point-max) file-name nil 'silent)))
758

759 760 761 762 763 764 765 766 767
(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."
768
  (declare (indent 2) (debug t))
769 770 771 772 773 774 775 776
  `(with-temp-buffer
     (if (string-match-p "\\`https?:" ,location)
	 (url-insert-file-contents (concat ,location ,file))
       (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))
777

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
(defun package--archive-file-exists-p (location file)
  (let ((http (string-match "\\`https?:" location)))
    (if http
	(progn
	  (require 'url-http)
	  (url-http-file-exists-p (concat location file)))
      (file-exists-p (expand-file-name file location)))))

(declare-function epg-make-context "epg"
		  (&optional protocol armor textmode include-certs
			     cipher-algorithm
			     digest-algorithm
			     compress-algorithm))
(declare-function epg-context-set-home-directory "epg" (context directory))
(declare-function epg-verify-string "epg" (context signature
						   &optional signed-text))
(declare-function epg-context-result-for "epg" (context name))
(declare-function epg-signature-status "epg" (signature))
(declare-function epg-signature-to-string "epg" (signature))

(defun package--check-signature (location file)
  "Check signature of the current buffer.
GnuPG keyring is located under \"gnupg\" in `package-user-dir'."
801 802 803 804 805
  (let* ((context (epg-make-context 'OpenPGP))
         (homedir (expand-file-name "gnupg" package-user-dir))
         (sig-file (concat file ".sig"))
         (sig-content (package--with-work-buffer location sig-file
			(buffer-string))))
806 807 808 809
    (epg-context-set-home-directory context homedir)
    (epg-verify-string context sig-content (buffer-string))
    ;; The .sig file may contain multiple signatures.  Success if one
    ;; of the signatures is good.
810 811 812 813 814 815 816 817 818 819 820
    (let ((good-signatures
           (delq nil (mapcar (lambda (sig)
                               (if (eq (epg-signature-status sig) 'good)
                                   sig))
                             (epg-context-result-for context 'verify)))))
      (if (null good-signatures)
          (error "Failed to verify signature %s: %S"
                 sig-file
                 (mapcar #'epg-signature-to-string
                         (epg-context-result-for context 'verify)))
        good-signatures))))
821

822
(defun package-install-from-archive (pkg-desc)
823
  "Download and install a tar package."
824 825 826 827 828
  (let* ((location (package-archive-base pkg-desc))
	 (file (concat (package-desc-full-name pkg-desc)
		       (package-desc-suffix pkg-desc)))
	 (sig-file (concat file ".sig"))
	 good-signatures pkg-descs)
829
    (package--with-work-buffer location file
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
      (if (and package-check-signature
	       (not (member (package-desc-archive pkg-desc)
			    package-unsigned-archives)))
	  (if (package--archive-file-exists-p location sig-file)
	      (setq good-signatures (package--check-signature location file))
	    (unless (eq package-check-signature 'allow-unsigned)
	      (error "Unsigned package: `%s'"
		     (package-desc-name pkg-desc)))))
      (package-unpack pkg-desc))
    ;; Here the package has been installed successfully, mark it as
    ;; signed if appropriate.
    (when good-signatures
      ;; Write out good signatures into NAME-VERSION.signed file.
      (write-region (mapconcat #'epg-signature-to-string good-signatures "\n")
		    nil
		    (expand-file-name
		     (concat (package-desc-full-name pkg-desc)
			     ".signed")
848 849
		     package-user-dir)
                    nil 'silent)
850 851 852 853 854 855
      ;; Update the old pkg-desc which will be shown on the description buffer.
      (setf (package-desc-signed pkg-desc) t)
      ;; Update the new (activated) pkg-desc as well.
      (setq pkg-descs (cdr (assq (package-desc-name pkg-desc) package-alist)))
      (if pkg-descs
	  (setf (package-desc-signed (car pkg-descs)) t)))))
856

857 858
(defvar package--initialized nil)

859
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
860 861
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
MIN-VERSION should be a version list."
862
  (unless package--initialized (error "package.el is not yet initialized!"))
863 864 865 866 867 868 869
  (or
   (let ((pkg-descs (cdr (assq package package-alist))))
     (and pkg-descs
	  (version-list-<= min-version
			   (package-desc-version (car pkg-descs)))))
   ;; Also check built-in packages.
   (package-built-in-p package min-version)))
870

871 872 873
(defun package-compute-transaction (packages requirements)
  "Return a list of packages to be installed, including PACKAGES.
PACKAGES should be a list of `package-desc'.
874 875

REQUIREMENTS should be a list of additional requirements; each
Chong Yidong's avatar
Chong Yidong committed
876 877 878
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.
879 880 881 882 883

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."
884 885 886 887 888
  ;; FIXME: We really should use backtracking to explore the whole
  ;; search space (e.g. if foo require bar-1.3, and bar-1.4 requires toto-1.1
  ;; whereas bar-1.3 requires toto-1.0 and the user has put a hold on toto-1.0:
  ;; the current code might fail to see that it could install foo by using the
  ;; older bar-1.3).
889 890
  (dolist (elt requirements)
    (let* ((next-pkg (car elt))
891 892 893 894 895 896 897
	   (next-version (cadr elt))
           (already ()))
      (dolist (pkg packages)
        (if (eq next-pkg (package-desc-name pkg))
            (setq already pkg)))
      (cond
       (already
Dmitry Gutov's avatar
Dmitry Gutov committed
898
        (if (version-list-<= next-version (package-desc-version already))
899 900
            ;; Move to front, so it gets installed early enough (bug#14082).
            (setq packages (cons already (delq already packages)))
Dmitry Gutov's avatar
Dmitry Gutov committed
901
          (error "Need package `%s-%s', but only %s is being installed"
902 903 904 905 906 907
                 next-pkg (package-version-join next-version)
                 (package-version-join (package-desc-version already)))))

       ((package-installed-p next-pkg next-version) nil)

       (t
908 909
	;; A package is required, but not installed.  It might also be
	;; blocked via `package-load-list'.
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
	(let ((pkg-descs (cdr (assq next-pkg package-archive-contents)))
              (found nil)
              (problem nil))
          (while (and pkg-descs (not found))
            (let* ((pkg-desc (pop pkg-descs))
                   (version (package-desc-version pkg-desc))
                   (disabled (package-disabled-p next-pkg version)))
              (cond
               ((version-list-< version next-version)
                (error
                 "Need package `%s-%s', but only %s is available"
                 next-pkg (package-version-join next-version)
                 (package-version-join version)))
               (disabled
                (unless problem
                  (setq problem
                        (if (stringp disabled)
                            (format "Package `%s' held at version %s, \
928
but version %s required"
929 930 931 932 933 934 935 936 937 938 939 940 941 942
                                    next-pkg disabled
                                    (package-version-join next-version))
                          (format "Required package '%s' is disabled"
                                  next-pkg)))))
               (t (setq found pkg-desc)))))
	  (unless found
            (if problem
                (error problem)
              (error "Package `%s-%s' is unavailable"
                     next-pkg (package-version-join next-version))))
	  (setq packages
		(package-compute-transaction (cons found packages)
					     (package-desc-reqs found))))))))
  packages)
943 944 945 946 947

(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))
948 949 950 951 952 953 954
	 (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))))
955 956 957 958 959 960 961 962 963
    (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)))
964 965 966 967 968 969 970 971
    (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))))))
972

973
(defun package-read-all-archive-contents ()
974 975
  "Re-read `archive-contents', if it exists.
If successful, set `package-archive-contents'."
976
  (setq package-archive-contents nil)
977
  (dolist (archive package-archives)
978
    (package-read-archive-contents (car archive))))
979

980
(defun package-read-archive-contents (archive)
981 982
  "Re-read archive contents for ARCHIVE.
If successful, set the variable `package-archive-contents'.
983
If the archive version is too new, signal an error."
984 985
  ;; Version 1 of 'archive-contents' is identical to our internal
  ;; representation.
986 987 988
  (let* ((contents-file (format "archives/%s/archive-contents" archive))
	 (contents (package--read-archive-file contents-file)))
    (when contents
989 990
      (dolist (package contents)
	(package--add-to-archive-contents package archive)))))
991

992 993 994 995
;; 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
996
               (:constructor package-make-ac-desc (version reqs summary kind extras))
997 998
               (:copier nil)
               (:type vector))
999
  version reqs summary kind extras)
1000

1001 1002
(defun package--add-to-archive-contents (package archive)
  "Add the PACKAGE from the given ARCHIVE if necessary.
1003 1004 1005
PACKAGE should have the form (NAME . PACKAGE--AC-DESC).
Also, add the originating archive to the `package-desc' structure."
  (let* ((name (car package))
1006
         (version (package--ac-desc-version (cdr package)))
1007 1008 1009
         (pkg-desc
          (package-desc-create
           :name name
1010
           :version version
1011 1012 1013
           :reqs (package--ac-desc-reqs (cdr package))
           :summary (package--ac-desc-summary (cdr package))
           :kind (package--ac-desc-kind (cdr package))
1014 1015 1016 1017 1018
           :archive archive
           :extras (and (> (length (cdr package)) 4)
                        ;; Older archive-contents files have only 4
                        ;; elements here.
                        (package--ac-desc-extras (cdr package)))))
1019
         (existing-packages (assq name package-archive-contents))
1020
         (pinned-to-archive (assoc name package-pinned-packages)))
1021
    (cond
Dmitry Gutov's avatar
Dmitry Gutov committed
1022 1023 1024
     ;; Skip entirely if pinned to another archive.
     ((and pinned-to-archive
           (not (equal (cdr pinned-to-archive) archive)))
1025
      nil)
1026 1027 1028 1029 1030 1031 1032 1033
     ((not existing-packages)
      (push (list name pkg-desc) package-archive-contents))
     (t
      (while
          (if (and (cdr existing-packages)
                   (version-list-<
                    version (package-desc-version (cadr existing-packages))))
              (setq existing-packages (cdr existing-packages))
1034 1035
            (push pkg-desc (cdr existing-packages))
            nil))))))
1036 1037 1038 1039

(defun package-download-transaction (packages)
  "Download and install all the packages in PACKAGES.
PACKAGES should be a list of package-desc.
1040
This function assumes that all package requirements in
1041
PACKAGES are satisfied, i.e. that PACKAGES is computed
1042
using `package-compute-transaction'."
1043
  (mapc #'package-install-from-archive packages))
1044 1045

;;;###autoload
1046 1047 1048 1049
(defun package-install (pkg)
  "Install the package PKG.
PKG can be a package-desc or the package name of one the available packages
in an archive in `package-archives'.  Interactively, prompt for its name."
1050
  (interactive
1051 1052 1053 1054 1055
   (progn
     ;; Initialize the package system to get the list of package
     ;; symbols for completion.
     (unless package--initialized
       (package-initialize t))
1056 1057
     (unless package-archive-contents
       (package-refresh-contents))
1058
     (list (intern (completing-read
1059
                    "Install package: "
Dmitry Gutov's avatar
Dmitry Gutov committed
1060 1061 1062 1063 1064
                    (delq nil
                          (mapcar (lambda (elt)
                                    (unless (package-installed-p (car elt))
                                      (symbol-name (car elt))))
                                  package-archive-contents))
1065
                    nil t)))))
1066
  (package-download-transaction
1067 1068 1069 1070 1071
   (if (package-desc-p pkg)
       (package-compute-transaction (list pkg)
                                    (package-desc-reqs pkg))
     (package-compute-transaction ()
                                  (list (list pkg))))))
1072

1073 1074
(defun package-strip-rcs-id (str)
  "Strip RCS version ID from the version string STR.
1075 1076
If the result looks like a dotted numeric version, return it.
Otherwise return nil."
1077 1078 1079 1080 1081 1082 1083
  (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))))
1084

1085 1086
(declare-function lm-homepage "lisp-mnt" (&optional file))

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
(defun package--prepare-dependencies (deps)
  "Turn DEPS into an acceptable list of dependencies.

Any parts missing a version string get a default version string
of \"0\" (meaning any version) and an appropriate level of lists
is wrapped around any parts requiring it."
  (cond
   ((not (listp deps))
    (error "Invalid requirement specifier: %S" deps))
   (t (mapcar (lambda (dep)
                (cond
                 ((symbolp dep) `(,dep "0"))
                 ((stringp dep)
                  (error "Invalid requirement specifier: %S" dep))
1101 1102
                 ((and (listp dep) (null (cdr dep)))
                  (list (car dep) "0"))
1103 1104 1105
                 (t dep)))
              deps))))

1106
(defun package-buffer-info ()
1107
  "Return a `package-desc' describing the package in the current buffer.
1108 1109 1110 1111

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."
1112
  (goto-char (point-min))
1113
  (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
1114
    (error "Package lacks a file header"))
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
  (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"))
1130 1131
		(package-strip-rcs-id (lm-header "version"))))
           (homepage (lm-homepage)))
1132 1133 1134
      (unless pkg-version
	(error
	 "Package lacks a \"Version\" or \"Package-Version\" header"))
1135 1136
      (package-desc-from-define
       file-name pkg-version desc
1137 1138 1139
       (if requires-str
           (package--prepare-dependencies
            (package-read-from-string requires-str)))
1140
       :kind 'single
1141
       :url homepage))))
1142

1143 1144 1145
(declare-function tar-get-file-descriptor "tar-mode" (file))
(declare-function tar--extract "tar-mode" (descriptor))

1146
(defun package-tar-file-info ()
1147
  "Find package information for a tar file.
1148 1149 1150 1151
The return result is a `package-desc'."
  (cl-assert (derived-mode-p 'tar-mode))
  (let* ((dir-name (file-name-directory
                    (tar-header-name (car tar-parse-info))))
1152
         (desc-file (package--description-file dir-name))
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
         (tar-desc (tar-get-file-descriptor (concat dir-name desc-file))))
    (unless tar-desc
      (error "No package descriptor file found"))
    (with-current-buffer (tar--extract tar-desc)
      (goto-char (point-min))
      (unwind-protect
          (let* ((pkg-def-parsed (read (current-buffer)))
                 (pkg-desc
                  (if (not (eq (car pkg-def-parsed) 'define-package))
                      (error "Can't find define-package in %s"
                             (tar-header-name tar-desc))
                    (apply #'package-desc-from-define
                           (append (cdr pkg-def-parsed))))))
            (setf (package-desc-kind pkg-desc) 'tar)
            pkg-desc)
        (kill-buffer (current-buffer))))))
1169

1170

1171
;;;###autoload
1172
(defun package-install-from-buffer ()
1173
  "Install a package from the current buffer.
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
The current buffer is assumed to be a single .el or .tar file that follows the
packaging guidelines; see info node `(elisp)Packaging'.
Downloads and installs required packages as needed."
  (interactive)
  (let ((pkg-desc (if (derived-mode-p 'tar-mode)
                      (package-tar-file-info)
                    (package-buffer-info))))
    ;; Download and install the dependencies.
    (let* ((requires (package-desc-reqs pkg-desc))
           (transaction (package-compute-transaction nil requires)))
      (package-download-transaction transaction))
    ;; Install the package itself.
    (package-unpack pkg-desc)
    pkg-desc))
1188 1189 1190 1191 1192 1193 1194 1195

;;;###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)