package.el 84.8 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 116 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
;;    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:

;; - 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:

164 165
(eval-when-compile (require 'cl-lib))

166 167
(require 'tabulated-list)

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
(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.
194
If VERSION is t, the most recent version is activated.
195 196 197 198 199
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)
200
  :risky t
201 202 203 204 205
  :group 'package
  :version "24.1")

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

210 211 212
(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.
213 214 215 216 217 218

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.
219 220 221 222
  (Other types of URL are currently not supported.)

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

229
(defcustom package-pinned-packages nil
230 231 232 233 234 235 236 237 238 239 240 241 242
  "An alist of packages that are pinned to specific archives.
This can be useful if you have multiple package archives enabled,
and want to control which archive a given package gets installed from.

Each element of the alist has the form (PACKAGE . ARCHIVE), where:
 PACKAGE is a symbol representing a package
 ARCHIVE is a string representing an archive (it should be the car of
an element in `package-archives', e.g. \"gnu\").

Adding an entry to this variable means that only ARCHIVE will be
considered as a source for PACKAGE.  If other archives provide PACKAGE,
they are ignored (for this package).  If ARCHIVE does not contain PACKAGE,
the package will be unavailable."
243 244
  :type '(alist :key-type (symbol :tag "Package")
                :value-type (string :tag "Archive name"))
245 246 247 248
  ;; I don't really see why this is risky...
  ;; I suppose it could prevent you receiving updates for a package,
  ;; via an entry (PACKAGE . NON-EXISTING).  Which could be an issue
  ;; if PACKAGE has a known vulnerability that is fixed in newer versions.
249 250 251 252
  :risky t
  :group 'package
  :version "24.4")

253 254 255 256 257 258 259
(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.
260
This is an alist mapping package names (symbols) to
261
non-empty lists of `package-desc' structures.")
262
(put 'package-archive-contents 'risky-local-variable t)
263 264 265 266 267 268 269

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

292
(defcustom package-check-signature 'allow-unsigned
293 294 295 296 297 298
  "Non-nil means to check package signatures when installing.
The value `allow-unsigned' means to still install a package even if
it is unsigned.

This also applies to the \"archive-contents\" file that lists the
contents of the archive."
299 300 301 302
  :type '(choice (const nil :tag "Never")
		 (const allow-unsigned :tag "Allow unsigned")
		 (const t :tag "Check always"))
  :risky t
Glenn Morris's avatar
Glenn Morris committed
303
  :group 'package
304
  :version "24.4")
305 306

(defcustom package-unsigned-archives nil
307
  "List of archives where we do not check for package signatures."
308 309 310
  :type '(repeat (string :tag "Archive name"))
  :risky t
  :group 'package
311
  :version "24.4")
312

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

351
`name'	Name of the package, as a symbol.
352 353 354 355

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

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

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

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

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

368
`dir'	The directory where the package is installed (if installed),
369 370
	`builtin' if it is built-in, or nil otherwise.

371 372 373
`extras' Optional alist of additional keyword-value pairs.

`signed' Flag to indicate that the package is signed by provider."
374 375 376 377 378
  name
  version
  (summary package--default-summary)
  reqs
  kind
379
  archive
380
  dir
381 382
  extras
  signed)
383 384

;; Pseudo fields.
385
(defun package-desc-full-name (pkg-desc)
386 387 388
  (format "%s-%s"
          (package-desc-name pkg-desc)
          (package-version-join (package-desc-version pkg-desc))))
389

390 391 392 393 394 395
(defun package-desc-suffix (pkg-desc)
  (pcase (package-desc-kind pkg-desc)
    (`single ".el")
    (`tar ".tar")
    (kind (error "Unknown package kind: %s" kind))))

396 397
(defun package-desc--keywords (pkg-desc)
  (let ((keywords (cdr (assoc :keywords (package-desc-extras pkg-desc)))))
398
    (if (eq (car-safe keywords) 'quote)
399
        (nth 1 keywords)
400 401
      keywords)))

402 403 404 405 406 407 408 409
;; 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)

410 411
(defvar package--builtins nil
  "Alist of built-in packages.
412 413 414 415
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'.

416 417
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.")
418
(put 'package--builtins 'risky-local-variable t)
419

420
(defvar package-alist nil
421
  "Alist of all packages available for activation.
422 423 424
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.
425 426 427 428

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

431
(defvar package-activated-list nil
432
  ;; FIXME: This should implicitly include all builtin packages.
433
  "List of the names of currently activated packages.")
434
(put 'package-activated-list 'risky-local-variable t)
435

436 437 438 439 440 441 442 443 444 445 446 447 448
(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))
449
	 ((< num -4)
450 451 452 453 454 455 456 457 458
	  (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")
459 460
		      ((= num -3) "alpha")
                      ((= num -4) "snapshot"))
461 462 463 464
		str-list))))
      (if (equal "." (car str-list))
	  (pop str-list))
      (apply 'concat (nreverse str-list)))))
465

466 467 468
(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)
469 470
                                    pkg-dir))
	(signed-file (concat pkg-dir ".signed")))
471 472 473 474
    (when (file-exists-p pkg-file)
      (with-temp-buffer
        (insert-file-contents pkg-file)
        (goto-char (point-min))
475 476
        (let ((pkg-desc (package-process-define-package
                         (read (current-buffer)) pkg-file)))
477
          (setf (package-desc-dir pkg-desc) pkg-dir)
478 479
	  (if (file-exists-p signed-file)
	      (setf (package-desc-signed pkg-desc) t))
480
          pkg-desc)))))
481 482 483 484 485 486 487 488 489

(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
490
updates `package-alist'."
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
  (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'")))))
512

513 514
(defun package-activate-1 (pkg-desc)
  (let* ((name (package-desc-name pkg-desc))
515 516
	 (pkg-dir (package-desc-dir pkg-desc))
         (pkg-dir-dir (file-name-as-directory pkg-dir)))
517
    (unless pkg-dir
518 519
      (error "Internal error: unable to find directory for `%s'"
	     (package-desc-full-name pkg-desc)))
520 521
    ;; Add to load path, add autoloads, and activate the package.
    (let ((old-lp load-path))
522 523
      (with-demoted-errors
        (load (expand-file-name (format "%s-autoloads" name) pkg-dir) nil t))
524 525 526 527 528 529
      (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)))
530
    ;; Add info node.
531 532 533 534 535
    (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))
536
    (push name package-activated-list)
537 538 539
    ;; Don't return nil.
    t))

Chong Yidong's avatar
Chong Yidong committed
540 541 542 543
(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."
544 545 546 547 548
  (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)))
549
       ((remove 0 min-version) nil)
550 551 552
       (t
        (require 'finder-inf nil t) ; For `package--builtins'.
        (assq package package--builtins))))))
553 554 555 556

(defun package--from-builtin (bi-desc)
  (package-desc-create :name (pop bi-desc)
                       :version (package--bi-desc-version bi-desc)
557 558
                       :summary (package--bi-desc-summary bi-desc)
                       :dir 'builtin))
559

560 561 562 563
;; 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.
564 565 566 567
(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))))
568
    ;; Check if PACKAGE is available in `package-alist'.
569 570 571 572 573 574 575
    (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)))
576 577
    (cond
     ;; If no such package is found, maybe it's built-in.
578 579
     ((null pkg-descs)
      (package-built-in-p package))
580
     ;; If the package is already activated, just return t.
581
     ((and (memq package package-activated-list) (not force))
582 583 584
      t)
     ;; Otherwise, proceed with activation.
     (t
585 586 587 588 589 590
      (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))))))
591 592
	(if fail
	    (warn "Unable to activate package `%s'.
593
Required package `%s-%s' is unavailable"
594 595
		  package (car fail) (package-version-join (cadr fail)))
	  ;; If all goes well, activate the package itself.
596
	  (package-activate-1 pkg-vec)))))))
597

598 599 600
(defun define-package (_name-string _version-string
                                    &optional _docstring _requirements
                                    &rest _extra-properties)
601
  "Define a new package.
602
NAME-STRING is the name of the package, as a string.
Chong Yidong's avatar
Chong Yidong committed
603
VERSION-STRING is the version of the package, as a string.
604 605
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
606 607
 Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
 where OTHER-VERSION is a string.
608 609

EXTRA-PROPERTIES is currently unused."
610 611 612 613 614 615 616 617 618
  ;; 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))
619 620 621 622 623
         (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.
624 625 626 627 628 629 630
      (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)))
631
    new-pkg-desc))
632

633
;; From Emacs 22, but changed so it adds to load-path.
634 635 636 637 638 639 640
(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"
641 642
	     ";;; Code:\n"
             "(add-to-list 'load-path (or (file-name-directory #$) (car load-path)))\n"
643 644 645 646 647 648 649
	     "\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")
650
     nil file nil 'silent))
651 652
  file)

653 654 655
(defvar generated-autoload-file)
(defvar version-control)

656
(defun package-generate-autoloads (name pkg-dir)
657
  (let* ((auto-name (format "%s-autoloads.el" name))
658
	 ;;(ignore-name (concat name "-pkg.el"))
659 660
	 (generated-autoload-file (expand-file-name auto-name pkg-dir))
	 (version-control 'never))
661
    (package-autoload-ensure-default-file generated-autoload-file)
662 663
    (update-directory-autoloads pkg-dir)
    (let ((buf (find-buffer-visiting generated-autoload-file)))
664 665
      (when buf (kill-buffer buf)))
    auto-name))
666

667 668
(defvar tar-parse-info)
(declare-function tar-untar-buffer "tar-mode" ())
Glenn Morris's avatar
Glenn Morris committed
669 670
(declare-function tar-header-name "tar-mode" (tar-header) t)
(declare-function tar-header-link-type "tar-mode" (tar-header) t)
671 672

(defun package-untar-buffer (dir)
673
  "Untar the current buffer.
674 675
This uses `tar-untar-buffer' from Tar mode.  All files should
untar into a directory named DIR; otherwise, signal an error."
676
  (require 'tar-mode)
677 678
  (tar-mode)
  ;; Make sure everything extracts into DIR.
679 680
  (let ((regexp (concat "\\`" (regexp-quote (expand-file-name dir)) "/"))
	(case-fold-search (memq system-type '(windows-nt ms-dos cygwin))))
681
    (dolist (tar-data tar-parse-info)
682 683 684 685 686 687 688
      (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)))))
689
  (tar-untar-buffer))
690

691
(defun package-generate-description-file (pkg-desc pkg-file)
692
  "Create the foo-pkg.el file for single-file packages."
693
  (let* ((name (package-desc-name pkg-desc)))
694 695 696 697 698 699
    (let ((print-level nil)
          (print-quoted t)
          (print-length nil))
      (write-region
       (concat
        (prin1-to-string
700 701 702 703 704 705 706 707 708 709 710 711 712
         (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))))
713
          (package--alist-to-plist-args
714
           (package-desc-extras pkg-desc))))
715
        "\n")
716
       nil pkg-file nil 'silent))))
717

718 719 720 721 722 723 724 725 726
(defun package--alist-to-plist-args (alist)
  (mapcar (lambda (x)
            (if (and (not (consp x))
                     (or (keywordp x)
                         (not (symbolp x))
                         (memq x '(nil t))))
                x `',x))
          (apply #'nconc
                 (mapcar (lambda (pair) (list (car pair) (cdr pair))) alist))))
727

728 729 730 731
(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))
732
	 (pkg-dir (expand-file-name dirname package-user-dir)))
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
    (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.
753
    (package-activate name 'force)
754 755 756 757 758
    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)
759 760
  (let ((desc-file (expand-file-name (package--description-file pkg-dir)
                                     pkg-dir)))
761
    (unless (file-exists-p desc-file)
762
      (package-generate-description-file pkg-desc desc-file)))
763 764 765 766 767 768 769
  ;; 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))
770

771
(defun package--write-file-no-coding (file-name)
772
  (let ((buffer-file-coding-system 'no-conversion))
773
    (write-region (point-min) (point-max) file-name nil 'silent)))
774

775 776 777 778 779 780 781 782 783
(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."
784
  (declare (indent 2) (debug t))
785 786 787 788 789 790 791 792
  `(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))
793

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
(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'."
817 818 819 820 821
  (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))))
822 823
    (epg-context-set-home-directory context homedir)
    (epg-verify-string context sig-content (buffer-string))
824 825 826 827 828 829 830 831 832 833 834 835 836 837
    (let (good-signatures had-fatal-error)
      ;; The .sig file may contain multiple signatures.  Success if one
      ;; of the signatures is good.
      (dolist (sig (epg-context-result-for context 'verify))
	(if (eq (epg-signature-status sig) 'good)
	    (push sig good-signatures)
	  ;; If package-check-signature is allow-unsigned, don't
	  ;; signal error when we can't verify signature because of
	  ;; missing public key.  Other errors are still treated as
	  ;; fatal (bug#17625).
	  (unless (and (eq package-check-signature 'allow-unsigned)
		       (eq (epg-signature-status sig) 'no-pubkey))
	    (setq had-fatal-error t))))
      (if (and (null good-signatures) had-fatal-error)
838 839 840 841 842
          (error "Failed to verify signature %s: %S"
                 sig-file
                 (mapcar #'epg-signature-to-string
                         (epg-context-result-for context 'verify)))
        good-signatures))))
843

844
(defun package-install-from-archive (pkg-desc)
845
  "Download and install a tar package."
846 847 848 849 850
  (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)
851
    (package--with-work-buffer location file
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
      (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")
870 871
		     package-user-dir)
                    nil 'silent)
872 873 874 875 876 877
      ;; 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)))))
878

879 880
(defvar package--initialized nil)

881
(defun package-installed-p (package &optional min-version)
Chong Yidong's avatar
Chong Yidong committed
882 883
  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
MIN-VERSION should be a version list."
884
  (unless package--initialized (error "package.el is not yet initialized!"))
885 886 887 888 889 890 891
  (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)))
892

893
(defun package-compute-transaction (packages requirements &optional seen)
894 895
  "Return a list of packages to be installed, including PACKAGES.
PACKAGES should be a list of `package-desc'.
896 897

REQUIREMENTS should be a list of additional requirements; each
Chong Yidong's avatar
Chong Yidong committed
898 899 900
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.
901 902 903 904

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
905 906 907
not included in this list.

SEEN is used internally to detect infinite recursion."
908 909 910 911 912
  ;; 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).
913 914
  (dolist (elt requirements)
    (let* ((next-pkg (car elt))
915 916 917 918 919
	   (next-version (cadr elt))
           (already ()))
      (dolist (pkg packages)
        (if (eq next-pkg (package-desc-name pkg))
            (setq already pkg)))
920
      (when already
Dmitry Gutov's avatar
Dmitry Gutov committed
921
        (if (version-list-<= next-version (package-desc-version already))
922 923 924 925 926 927 928 929 930
            ;; `next-pkg' is already in `packages', but its position there
            ;; means it might be installed too late: remove it from there, so
            ;; we re-add it (along with its dependencies) at an earlier place
            ;; below (bug#16994).
            (if (memq already seen)     ;Avoid inf-loop on dependency cycles.
                (message "Dependency cycle going through %S"
                         (package-desc-full-name already))
              (setq packages (delq already packages))
              (setq already nil))
Dmitry Gutov's avatar
Dmitry Gutov committed
931
          (error "Need package `%s-%s', but only %s is being installed"
932 933
                 next-pkg (package-version-join next-version)
                 (package-version-join (package-desc-version already)))))
934 935
      (cond
       (already nil)
936 937 938
       ((package-installed-p next-pkg next-version) nil)

       (t
939 940
	;; A package is required, but not installed.  It might also be
	;; blocked via `package-load-list'.
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
	(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, \
959
but version %s required"
960 961 962 963 964 965 966
                                    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
967
                (error "%s" problem)
968 969 970 971
              (error "Package `%s-%s' is unavailable"
                     next-pkg (package-version-join next-version))))
	  (setq packages
		(package-compute-transaction (cons found packages)
972 973
					     (package-desc-reqs found)
                                             (cons found seen))))))))
974
  packages)
975 976 977 978 979

(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))
980 981 982 983 984 985 986
	 (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))))
987 988 989 990 991 992 993 994 995
    (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)))
996 997 998 999 1000 1001 1002 1003
    (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))))))
1004

1005
(defun package-read-all-archive-contents ()
1006 1007
  "Re-read `archive-contents', if it exists.
If successful, set `package-archive-contents'."
1008
  (setq package-archive-contents nil)
1009
  (dolist (archive package-archives)
1010
    (package-read-archive-contents (car archive))))
1011

1012
(defun package-read-archive-contents (archive)
1013 1014
  "Re-read archive contents for ARCHIVE.
If successful, set the variable `package-archive-contents'.
1015
If the archive version is too new, signal an error."
1016 1017
  ;; Version 1 of 'archive-contents' is identical to our internal
  ;; representation.
1018 1019 1020
  (let* ((contents-file (format "archives/%s/archive-contents" archive))
	 (contents (package--read-archive-file contents-file)))
    (when contents
1021 1022
      (dolist (package contents)
	(package--add-to-archive-contents package archive)))))
1023

1024 1025 1026 1027
;; 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
1028
               (:constructor package-make-ac-desc (version reqs summary kind extras))
1029 1030
               (:copier nil)
               (:type vector))
1031
  version reqs summary kind extras)
1032

1033 1034
(defun package--add-to-archive-contents (package archive)
  "Add the PACKAGE from the given ARCHIVE if necessary.
1035 1036 1037
PACKAGE should have the form (NAME . PACKAGE--AC-DESC).
Also, add the originating archive to the `package-desc' structure."
  (let* ((name (car package))
1038
         (version (package--ac-desc-version (cdr package)))
1039 1040 1041
         (pkg-desc
          (package-desc-create
           :name name
1042
           :version version
1043 1044 1045
           :reqs (package--ac-desc-reqs (cdr package))
           :summary (package--ac-desc-summary (cdr package))
           :kind (package--ac-desc-kind (cdr package))
1046 1047 1048 1049 1050
           :archive archive
           :extras (and (> (length (cdr package)) 4)
                        ;; Older archive-contents files have only 4
                        ;; elements here.
                        (package--ac-desc-extras (cdr package)))))
1051
         (existing-packages (assq name package-archive-contents))
1052
         (pinned-to-archive (assoc name package-pinned-packages)))
1053
    (cond
Dmitry Gutov's avatar
Dmitry Gutov committed
1054 1055 1056
     ;; Skip entirely if pinned to another archive.
     ((and pinned-to-archive
           (not (equal (cdr pinned-to-archive) archive)))
1057
      nil)
1058 1059 1060 1061 1062 1063 1064 1065
     ((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))
1066 1067
            (push pkg-desc (cdr existing-packages))
            nil))))))
1068 1069 1070 1071

(defun package-download-transaction (packages)
  "Download and install all the packages in PACKAGES.
PACKAGES should be a list of package-desc.
1072
This function assumes that all package requirements in
1073
PACKAGES are satisfied, i.e. that PACKAGES is computed
1074
using `package-compute-transaction'."
1075
  (mapc #'package-install-from-archive packages))
1076 1077

;;;###autoload
1078 1079 1080 1081
(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."
1082
  (interactive
1083 1084 1085 1086 1087
   (progn
     ;; Initialize the package system to get the list of package
     ;; symbols for completion.
     (unless package--initialized
       (package-initialize t))
1088 1089
     (unless package-archive-contents
       (package-refresh-contents))
1090
     (list (intern (completing-read
1091
                    "Install package: "
Dmitry Gutov's avatar
Dmitry Gutov committed
1092 1093 1094 1095 1096
                    (delq nil
                          (mapcar (lambda (elt)
                                    (unless (package-installed-p (car elt))
                                      (symbol-name (car elt))))
                                  package-archive-contents))
1097
                    nil t)))))
1098
  (package-download-transaction
1099 1100 1101 1102 1103
   (if (package-desc-p pkg)
       (package-compute-transaction (list pkg)
                                    (package-desc-reqs pkg))
     (package-compute-transaction ()
                                  (list (list pkg))))))
1104

1105 1106
(defun package-strip-rcs-id (str)
  "Strip RCS version ID from the version string STR.
1107 1108
If the result looks like a dotted numeric version, return it.
Otherwise return nil."
1109 1110 1111 1112 1113 1114 1115
  (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))))
1116

1117 1118
(declare-function lm-homepage "lisp-mnt" (&optional file))

1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
(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))
1133 1134
                 ((and (listp dep) (null (cdr dep)))
                  (list (car dep) "0"))
1135 1136 1137
                 (t dep)))
              deps))))

1138
(defun package-buffer-info ()
1139
  "Return a `package-desc' describing the package in the current buffer.
1140 1141 1142 1143

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."
1144
  (goto-char (point-min))
1145
  (unless (re-search-forward "^;;; \\([^ ]*\\)\\.el ---[ \t]*\\(.*?\\)[ \t]*\\(-\\*-.*-\\*-[ \t]*\\)?$" nil t)
1146
    (error "Package lacks a file header"))
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
  (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"))