git.chise.org Git - chise/xemacs-chise.git-/blob - lisp/package-get.el

   1 ;;; package-get.el --- Retrieve XEmacs package
   2
   3 ;; Copyright (C) 1998 by Pete Ware
   4
   5 ;; Author: Pete Ware <ware@cis.ohio-state.edu>
   6 ;; Heavy-Modifications: Greg Klanderman <greg@alphatech.com>
   7 ;;                      Jan Vroonhof    <vroonhof@math.ethz.ch>
   8 ;; Keywords: internal
   9
  10 ;; This file is part of XEmacs.
  11
  12 ;; XEmacs is free software; you can redistribute it and/or modify it
  13 ;; under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; XEmacs is distributed in the hope that it will be useful, but
  18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 ;; General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
  24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  25 ;; 02111-1307, USA.
  26
  27 ;;; Synched up with: Not in FSF
  28
  29 ;;; Commentary:
  30
  31 ;; package-get -
  32 ;;      Retrieve a package and any other required packages from an archive
  33 ;;
  34 ;;
  35 ;; Note (JV): Most of this no longer applies!
  36 ;;
  37 ;; The idea:
  38 ;;      A new XEmacs lisp-only release is generated with the following steps:
  39 ;;      1. The maintainer runs some yet to be written program that
  40 ;;         generates all the dependency information.  This should
  41 ;;         determine all the require and provide statements and associate
  42 ;;         them with a package.
  43 ;;      2. All the packages are then bundled into their own tar balls
  44 ;;         (or whatever format)
  45 ;;      3. Maintainer automatically generates a new `package-get-base'
  46 ;;         data structure which contains information such as the
  47 ;;         package name, the file to be retrieved, an md5 checksum,
  48 ;;         etc (see `package-get-base').
  49 ;;      4. The maintainer posts an announcement with the new version
  50 ;;         of `package-get-base'.
  51 ;;      5. A user/system manager saves this posting and runs
  52 ;;         `package-get-update' which uses the previously saved list
  53 ;;         of packages, `package-get-here' that the user/site
  54 ;;         wants to determine what new versions to download and
  55 ;;         install.
  56 ;;
  57 ;;      A user/site manager can generate a new `package-get-here' structure
  58 ;;      by using `package-get-setup' which generates a customize like
  59 ;;      interface to the list of packages.  The buffer looks something
  60 ;;      like:
  61 ;;
  62 ;;      gnus    - a mail and news reader
  63 ;;      []      Always install
  64 ;;      []      Needs updating
  65 ;;      []      Required by other [packages]
  66 ;;      version: 2.0
  67 ;;
  68 ;;      vm      - a mail reader
  69 ;;      []      Always install
  70 ;;      []      Needs updating
  71 ;;      []      Required by other [packages]
  72 ;;
  73 ;;      Where `[]' indicates a toggle box
  74 ;;
  75 ;;      - Clicking on "Always install" puts this into
  76 ;;        `package-get-here' list.  "Needs updating" indicates a new
  77 ;;        version is available.  Anything already in
  78 ;;        `package-get-here' has this enabled.
  79 ;;      - "Required by other" means some other packages are going to force
  80 ;;        this to be installed.  Clicking on  [packages] gives a list
  81 ;;        of packages that require this.
  82 ;;
  83 ;;      The `package-get-base' should be installed in a file in
  84 ;;      `data-directory'.  The `package-get-here' should be installed in
  85 ;;      site-lisp.  Both are then read at run time.
  86 ;;
  87 ;; TODO:
  88 ;;      - Implement `package-get-setup'
  89 ;;      - Actually put `package-get-base' and `package-get-here' into
  90 ;;        files that are read.
  91 ;;      - Allow users to have their own packages that they want installed
  92 ;;        in ~/.xemacs/.
  93 ;;      - SOMEONE needs to write the programs that generate the
  94 ;;        provides/requires database and makes it into a lisp data
  95 ;;        structure suitable for `package-get-base'
  96 ;;      - Handle errors such as no package providing a required symbol.
  97 ;;      - Tie this into the `require' function to download packages
  98 ;;        transparently.
  99
 100 ;;; Change Log
 101
 102 ;;; Code:
 103
 104 (require 'package-admin)
 105 ;; (require 'package-get-base)
 106
 107 (defgroup package-tools nil
 108   "Tools to manipulate packages."
 109   :group 'emacs)
 110
 111 (defgroup package-get nil
 112   "Automatic Package Fetcher and Installer."
 113   :prefix "package-get"
 114   :group 'package-tools)
 115
 116 ;;;###autoload
 117 (defvar package-get-base nil
 118   "List of packages that are installed at this site.
 119 For each element in the alist,  car is the package name and the cdr is
 120 a plist containing information about the package.   Typical fields
 121 kept in the plist are:
 122
 123 version         - version of this package
 124 provides        - list of symbols provided
 125 requires        - list of symbols that are required.
 126                   These in turn are provided by other packages.
 127 filename        - name of the file.
 128 size            - size of the file (aka the bundled package)
 129 md5sum          - computed md5 checksum
 130 description     - What this package is for.
 131 type            - Whether this is a 'binary (default) or 'single file package
 132
 133 More fields may be added as needed.  An example:
 134
 135 '(
 136  (name
 137   (version \"<version 2>\"
 138    file \"filename\"
 139    description \"what this package is about.\"
 140    provides (<list>)
 141    requires (<list>)
 142    size <integer-bytes>
 143    md5sum \"<checksum\"
 144    type single
 145    )
 146   (version \"<version 1>\"
 147    file \"filename\"
 148    description \"what this package is about.\"
 149    provides (<list>)
 150    requires (<list>)
 151    size <integer-bytes>
 152    md5sum \"<checksum\"
 153    type single
 154    )
 155    ...
 156    ))
 157
 158 For version information, it is assumed things are listed in most
 159 recent to least recent -- in other words, the version names don't have to
 160 be lexically ordered.  It is debatable if it makes sense to have more than
 161 one version of a package available.")
 162
 163 (defcustom package-get-dir (temp-directory)
 164   "*Where to store temporary files for staging."
 165   :tag "Temporary directory"
 166   :type 'directory
 167   :group 'package-get)
 168
 169 (define-widget 'host-name 'string
 170   "A Host name."
 171   :tag "Host")
 172
 173 (defcustom package-get-remote nil
 174   "*List of remote sites to contact for downloading packages.
 175 List format is '(site-name directory-on-site).  Each site is tried in
 176 order until the package is found.  As a special case, `site-name' can be
 177 `nil', in which case `directory-on-site' is treated as a local directory."
 178   :tag "Package repository"
 179   :type '(repeat (choice (list :tag "Local" (const :tag "Local" nil) directory )
 180                          (list :tag "Remote" host-name directory) ))
 181   :group 'package-get)
 182
 183 ;;;###autoload
 184 (defcustom package-get-download-sites
 185   '(
 186     ;; North America
 187     ("Pre-Releases" "ftp.xemacs.org" "pub/xemacs/beta/experimental/packages")
 188     ("xemacs.org" "ftp.xemacs.org" "pub/xemacs/packages")
 189     ("ca.xemacs.org (Canada)" "ftp.ca.xemacs.org" "pub/Mirror/xemacs/packages")
 190     ("crc.ca (Canada)" "ftp.crc.ca" "pub/packages/editors/xemacs/packages")
 191     ("us.xemacs.org (United States)" "ftp.us.xemacs.org" "pub/xemacs/packages")
 192     ("ibiblio.org (United States)" "ibiblio.org" "pub/packages/editors/xemacs/packages")
 193     ("stealth.net (United States)" "ftp.stealth.net" "pub/mirrors/ftp.xemacs.org/pub/xemacs/packages")
 194     ;("uiuc.edu (United States)" "uiarchive.uiuc.edu" "pub/packages/xemacs/packages")
 195
 196     ;; South America
 197     ("br.xemacs.org (Brazil)" "ftp.br.xemacs.org" "pub/xemacs/packages")
 198
 199     ;; Europe
 200     ("at.xemacs.org (Austria)" "ftp.at.xemacs.org" "editors/xemacs/packages")
 201     ("be.xemacs.org (Belgium)" "ftp.be.xemacs.org" "xemacs/packages")
 202     ("cz.xemacs.org (Czech Republic)" "ftp.cz.xemacs.org" "MIRRORS/ftp.xemacs.org/pub/xemacs/packages")
 203     ("dk.xemacs.org (Denmark)" "ftp.dk.xemacs.org" "pub/emacs/xemacs/packages")
 204     ("fi.xemacs.org (Finland)" "ftp.fi.xemacs.org" "pub/mirrors/ftp.xemacs.org/pub/tux/xemacs/packages")
 205     ("fr.xemacs.org (France)" "ftp.fr.xemacs.org" "pub/xemacs/packages")
 206     ("pasteur.fr (France)" "ftp.pasteur.fr" "pub/computing/xemacs/packages")
 207     ("de.xemacs.org (Germany)" "ftp.de.xemacs.org" "pub/ftp.xemacs.org/tux/xemacs/packages")
 208     ("tu-darmstadt.de (Germany)" "ftp.tu-darmstadt.de" "pub/editors/xemacs/packages")
 209     ;("hu.xemacs.org (Hungary)" "ftp.hu.xemacs.org" "pub/packages/xemacs/packages")
 210     ("ie.xemacs.org (Ireland)" "ftp.ie.xemacs.org" "mirrors/ftp.xemacs.org/pub/xemacs/packages")
 211     ("it.xemacs.org (Italy)" "ftp.it.xemacs.org" "unix/packages/XEMACS/packages")
 212     ("no.xemacs.org (Norway)" "ftp.no.xemacs.org" "pub/xemacs/packages")
 213     ("pl.xemacs.org (Poland)" "ftp.pl.xemacs.org" "pub/unix/editors/xemacs/packages")
 214     ("ru.xemacs.org (Russia)" "ftp.ru.xemacs.org" "pub/xemacs/packages")
 215     ("sk.xemacs.org (Slovakia)" "ftp.sk.xemacs.org" "pub/mirrors/xemacs/packages")
 216     ("se.xemacs.org (Sweden)" "ftp.se.xemacs.org" "pub/gnu/xemacs/packages")
 217     ("ch.xemacs.org (Switzerland)" "ftp.ch.xemacs.org" "mirror/xemacs/packages")
 218     ("uk.xemacs.org (United Kingdom)" "ftp.uk.xemacs.org" "sites/ftp.xemacs.org/pub/xemacs/packages")
 219
 220     ;; Asia
 221     ("jp.xemacs.org (Japan)" "ftp.jp.xemacs.org" "pub/GNU/xemacs/packages")
 222     ("aist.go.jp (Japan)" "ring.aist.go.jp" "pub/text/xemacs/packages")
 223     ("asahi-net.or.jp (Japan)" "ring.asahi-net.or.jp" "pub/text/xemacs/packages")
 224     ("dti.ad.jp (Japan)" "ftp.dti.ad.jp" "pub/unix/editor/xemacs/packages")
 225     ("jaist.ac.jp (Japan)" "ftp.jaist.ac.jp" "pub/GNU/xemacs/packages")
 226     ("nucba.ac.jp (Japan)" "mirror.nucba.ac.jp" "mirror/xemacs/packages")
 227     ("sut.ac.jp (Japan)" "sunsite.sut.ac.jp" "pub/archives/packages/xemacs/packages")
 228     ("kr.xemacs.org (Korea)" "ftp.kr.xemacs.org" "pub/tools/emacs/xemacs/packages")
 229     ;("tw.xemacs.org (Taiwan)" "ftp.tw.xemacs.org" "Editors/xemacs/packages")
 230
 231     ;; Africa
 232     ("za.xemacs.org (South Africa)" "ftp.za.xemacs.org" "mirrorsites/ftp.xemacs.org/packages")
 233
 234     ;; Middle East
 235     ("sa.xemacs.org (Saudi Arabia)" "ftp.sa.xemacs.org" "pub/mirrors/ftp.xemacs.org/xemacs/packages")
 236
 237     ;; Australia
 238     ("au.xemacs.org (Australia)" "ftp.au.xemacs.org" "pub/xemacs/packages")
 239     ("aarnet.edu.au (Australia)" "mirror.aarnet.edu.au" "pub/xemacs/packages")
 240
 241     ;; Oceania
 242     ("nz.xemacs.org (New Zealand)" "ftp.nz.xemacs.org" "mirror/ftp.xemacs.org/packages")
 243     )
 244   "*List of remote sites available for downloading packages.
 245 List format is '(site-description site-name directory-on-site).
 246 SITE-DESCRIPTION is a textual description of the site.  SITE-NAME
 247 is the internet address of the download site.  DIRECTORY-ON-SITE
 248 is the directory on the site in which packages may be found.
 249 This variable is used to initialize `package-get-remote', the
 250 variable actually used to specify package download sites."
 251   :tag "Package download sites"
 252   :type '(repeat (list (string :tag "Name") host-name directory))
 253   :group 'package-get)
 254
 255 (defcustom package-get-remove-copy t
 256   "*After copying and installing a package, if this is t, then remove the
 257 copy.  Otherwise, keep it around."
 258   :type 'boolean
 259   :group 'package-get)
 260
 261 ;; #### it may make sense for this to be a list of names.
 262 ;; #### also, should we rename "*base*" to "*index*" or "*db*"?
 263 ;;      "base" is a pretty poor name.
 264 (defcustom package-get-base-filename "package-index.LATEST.pgp"
 265   "*Name of the default package-get database file.
 266 This may either be a relative path, in which case it is interpreted
 267 with respect to `package-get-remote', or an absolute path."
 268   :type 'file
 269   :group 'package-get)
 270
 271 (defvar package-get-user-index-filename
 272   (paths-construct-path (list user-init-directory package-get-base-filename))
 273   "Name for the user-specific location of the package-get database file.")
 274
 275 (defcustom package-get-always-update nil
 276   "*If Non-nil always make sure we are using the latest package index (base).
 277 Otherwise respect the `force-current' argument of `package-get-require-base'."
 278   :type 'boolean
 279   :group 'package-get)
 280
 281 (defcustom package-get-require-signed-base-updates nil
 282   "*If set to a non-nil value, require explicit user confirmation for updates
 283 to the package-get database which cannot have their signature verified via PGP.
 284 When nil, updates which are not PGP signed are allowed without confirmation."
 285   :type 'boolean
 286   :group 'package-get)
 287
 288 (defvar package-get-was-current nil
 289   "Non-nil we did our best to fetch a current database.")
 290
 291
 292 ;Shouldn't this be in package-ui?
 293 ;;;###autoload
 294 (defun package-get-download-menu ()
 295   "Build the `Add Download Site' menu."
 296   (mapcar (lambda (site)
 297             (vector (car site)
 298                     `(if (member (quote ,(cdr site))
 299                                  package-get-remote)
 300                          (setq package-get-remote
 301                                (delete (quote ,(cdr site))
 302                                        package-get-remote))
 303                        (package-ui-add-site (quote ,(cdr site))))
 304                     :style 'toggle
 305                     :selected `(member (quote ,(cdr site))
 306                                        package-get-remote)))
 307           package-get-download-sites))
 308
 309 ;;;###autoload
 310 (defun package-get-require-base (&optional force-current)
 311   "Require that a package-get database has been loaded.
 312 If the optional FORCE-CURRENT argument or the value of
 313 `package-get-always-update' is Non-nil, try to update the database
 314 from a location in `package-get-remote'. Otherwise a local copy is used
 315 if available and remote access is never done.
 316
 317 Please use FORCE-CURRENT only when the user is explictly dealing with packages
 318 and remote access is likely in the near future."
 319   (setq force-current (or force-current package-get-always-update))
 320   (unless (and (boundp 'package-get-base)
 321                package-get-base
 322                (or (not force-current) package-get-was-current))
 323     (package-get-update-base nil force-current))
 324   (if (or (not (boundp 'package-get-base))
 325           (not package-get-base))
 326       (error "Package-get database not loaded")
 327     (setq package-get-was-current force-current)))
 328
 329 (defconst package-get-pgp-signed-begin-line "^-----BEGIN PGP SIGNED MESSAGE-----"
 330   "Text for start of PGP signed messages.")
 331 (defconst package-get-pgp-signature-begin-line "^-----BEGIN PGP SIGNATURE-----"
 332   "Text for beginning of PGP signature.")
 333 (defconst package-get-pgp-signature-end-line "^-----END PGP SIGNATURE-----"
 334   "Text for end of PGP signature.")
 335
 336 ;;;###autoload
 337 (defun package-get-update-base-entry (entry)
 338   "Update an entry in `package-get-base'."
 339   (let ((existing (assq (car entry) package-get-base)))
 340     (if existing
 341         (setcdr existing (cdr entry))
 342       (setq package-get-base (cons entry package-get-base))
 343       (package-get-custom-add-entry (car entry) (car (cdr entry))))))
 344
 345 (defun package-get-locate-file (file &optional nil-if-not-found no-remote)
 346   "Locate an existing FILE with respect to `package-get-remote'.
 347 If FILE is an absolute path or is not found, simply return FILE.
 348 If optional argument NIL-IF-NOT-FOUND is non-nil, return nil
 349 if FILE can not be located.
 350 If NO-REMOTE is non-nil never search remote locations."
 351   (if (file-name-absolute-p file)
 352       file
 353     (let ((entries package-get-remote)
 354           (expanded nil))
 355       (while entries
 356         (unless (and no-remote (caar entries))
 357           (let ((expn (package-get-remote-filename (car entries) file)))
 358             (if (and expn (file-exists-p expn))
 359                 (setq entries  nil
 360                       expanded expn))))
 361         (setq entries (cdr entries)))
 362       (or expanded
 363           (and (not nil-if-not-found)
 364                file)))))
 365
 366 (defun package-get-locate-index-file (no-remote)
 367   "Locate the package-get index file.  Do not return remote paths if NO-REMOTE
 368 is non-nil."
 369   (or (package-get-locate-file package-get-base-filename t no-remote)
 370       (if (file-exists-p package-get-user-index-filename)
 371           package-get-user-index-filename)
 372       (locate-data-file package-get-base-filename)
 373       (error "Can't locate a package index file.")))
 374
 375 (defun package-get-maybe-save-index (filename)
 376   "Offer to save the current buffer as the local package index file,
 377 if different."
 378   (let ((location (package-get-locate-index-file t)))
 379     (unless (and filename (equal filename location))
 380       (unless (and location
 381                    (equal (md5 (current-buffer))
 382                           (with-temp-buffer
 383                             (insert-file-contents-literally location)
 384                             (md5 (current-buffer)))))
 385         (unless (and location (file-writable-p location))
 386           (setq location package-get-user-index-filename))
 387         (when (y-or-n-p (concat "Update package index in " location "? "))
 388           (let ((coding-system-for-write 'binary))
 389             (write-file location)))))))
 390
 391
 392 ;;;###autoload
 393 (defun package-get-update-base (&optional db-file force-current)
 394   "Update the package-get database file with entries from DB-FILE.
 395 Unless FORCE-CURRENT is non-nil never try to update the database."
 396   (interactive
 397    (let ((dflt (package-get-locate-index-file nil)))
 398      (list (read-file-name "Load package-get database: "
 399                            (file-name-directory dflt)
 400                            dflt
 401                            t
 402                            (file-name-nondirectory dflt)))))
 403   (setq db-file (expand-file-name (or db-file
 404                                       (package-get-locate-index-file
 405                                          (not force-current)))))
 406   (if (not (file-exists-p db-file))
 407       (error "Package-get database file `%s' does not exist" db-file))
 408   (if (not (file-readable-p db-file))
 409       (error "Package-get database file `%s' not readable" db-file))
 410   (let ((buf (get-buffer-create "*package database*")))
 411     (unwind-protect
 412         (save-excursion
 413           (set-buffer buf)
 414           (erase-buffer buf)
 415           (insert-file-contents-literally db-file)
 416           (package-get-update-base-from-buffer buf)
 417           (if (file-remote-p db-file)
 418               (package-get-maybe-save-index db-file)))
 419       (kill-buffer buf))))
 420
 421 ;;;###autoload
 422 (defun package-get-update-base-from-buffer (&optional buf)
 423   "Update the package-get database with entries from BUFFER.
 424 BUFFER defaults to the current buffer.  This command can be
 425 used interactively, for example from a mail or news buffer."
 426   (interactive)
 427   (setq buf (or buf (current-buffer)))
 428   (let (content-beg content-end beg end)
 429     (save-excursion
 430       (set-buffer buf)
 431       (goto-char (point-min))
 432       (setq content-beg (point))
 433       (setq content-end (save-excursion (goto-char (point-max)) (point)))
 434       (when (re-search-forward package-get-pgp-signed-begin-line nil t)
 435         (setq beg (match-beginning 0))
 436         (setq content-beg (match-end 0)))
 437       (when (re-search-forward package-get-pgp-signature-begin-line nil t)
 438         (setq content-end (match-beginning 0)))
 439       (when (re-search-forward package-get-pgp-signature-end-line nil t)
 440         (setq end (point)))
 441       (if (not (and content-beg content-end beg end))
 442           (or (not package-get-require-signed-base-updates)
 443               (yes-or-no-p "Package-get entries not PGP signed, continue? ")
 444               (error "Package-get database not updated")))
 445       (if (and content-beg content-end beg end)
 446           (if (not (condition-case nil
 447                        (or (fboundp 'mc-pgp-verify-region)
 448                            (load-library "mc-pgp")
 449                            (fboundp 'mc-pgp-verify-region))
 450                      (error nil)))
 451               (or (not package-get-require-signed-base-updates)
 452                   (yes-or-no-p
 453                    "No mailcrypt; can't verify package-get DB signature, continue? ")
 454                   (error "Package-get database not updated"))))
 455       (if (and beg end
 456                (fboundp 'mc-pgp-verify-region)
 457                (or (not
 458                     (condition-case err
 459                         (mc-pgp-verify-region beg end)
 460                       (file-error
 461                        (and (string-match "No such file" (nth 2 err))
 462                             (or (not package-get-require-signed-base-updates)
 463                                 (yes-or-no-p
 464                                  (concat "Can't find PGP, continue without "
 465                                          "package-get DB verification? ")))))
 466                       (t nil)))))
 467           (error "Package-get PGP signature failed to verify"))
 468       ;; ToDo: We should call package-get-maybe-save-index on the region
 469       (package-get-update-base-entries content-beg content-end)
 470       (message "Updated package-get database"))))
 471
 472 (defun package-get-update-base-entries (start end)
 473   "Update the package-get database with the entries found between
 474 START and END in the current buffer."
 475   (save-excursion
 476     (goto-char start)
 477     (if (not (re-search-forward "^(package-get-update-base-entry" nil t))
 478         (error "Buffer does not contain package-get database entries"))
 479     (beginning-of-line)
 480     (let ((count 0))
 481       (while (and (< (point) end)
 482                   (re-search-forward "^(package-get-update-base-entry" nil t))
 483         (beginning-of-line)
 484         (let ((entry (read (current-buffer))))
 485           (if (or (not (consp entry))
 486                   (not (eq (car entry) 'package-get-update-base-entry)))
 487               (error "Invalid package-get database entry found"))
 488           (package-get-update-base-entry
 489            (car (cdr (car (cdr entry)))))
 490           (setq count (1+ count))))
 491       (message "Got %d package-get database entries" count))))
 492
 493 ;;;###autoload
 494 (defun package-get-save-base (file)
 495   "Write the package-get database to FILE.
 496
 497 Note: This database will be unsigned of course."
 498   (interactive "FSave package-get database to: ")
 499   (package-get-require-base t)
 500   (let ((buf (get-buffer-create "*package database*")))
 501     (unwind-protect
 502         (save-excursion
 503           (set-buffer buf)
 504           (erase-buffer buf)
 505           (goto-char (point-min))
 506           (let ((entries package-get-base) entry plist)
 507             (insert ";; Package Index file -- Do not edit manually.\n")
 508             (insert ";;;@@@\n")
 509             (while entries
 510               (setq entry (car entries))
 511               (setq plist (car (cdr entry)))
 512               (insert "(package-get-update-base-entry (quote\n")
 513               (insert (format "(%s\n" (symbol-name (car entry))))
 514               (while plist
 515                 (insert (format "  %s%s %S\n"
 516                                 (if (eq plist (car (cdr entry))) "(" " ")
 517                                 (symbol-name (car plist))
 518                                 (car (cdr plist))))
 519                 (setq plist (cdr (cdr plist))))
 520               (insert "))\n))\n;;;@@@\n")
 521               (setq entries (cdr entries))))
 522           (insert ";; Package Index file ends here\n")
 523           (write-region (point-min) (point-max) file))
 524       (kill-buffer buf))))
 525
 526 (defun package-get-interactive-package-query (get-version package-symbol)
 527   "Perform interactive querying for package and optional version.
 528 Query for a version if GET-VERSION is non-nil.  Return package name as
 529 a symbol instead of a string if PACKAGE-SYMBOL is non-nil.
 530 The return value is suitable for direct passing to `interactive'."
 531   (package-get-require-base t)
 532   (let ((table (mapcar #'(lambda (item)
 533                            (let ((name (symbol-name (car item))))
 534                              (cons name name)))
 535                        package-get-base))
 536         package package-symbol default-version version)
 537     (save-window-excursion
 538       (setq package (completing-read "Package: " table nil t))
 539       (setq package-symbol (intern package))
 540       (if get-version
 541           (progn
 542             (setq default-version
 543                   (package-get-info-prop
 544                    (package-get-info-version
 545                     (package-get-info-find-package package-get-base
 546                                                    package-symbol) nil)
 547                    'version))
 548             (while (string=
 549                     (setq version (read-string "Version: " default-version))
 550                     "")
 551               )
 552             (if package-symbol
 553                 (list package-symbol version)
 554               (list package version))
 555             )
 556         (if package-symbol
 557             (list package-symbol)
 558           (list package))))))
 559
 560 ;;;###autoload
 561 (defun package-get-delete-package (package &optional pkg-topdir)
 562   "Delete an installation of PACKAGE below directory PKG-TOPDIR.
 563 PACKAGE is a symbol, not a string.
 564 This is just an interactive wrapper for `package-admin-delete-binary-package'."
 565   (interactive (package-get-interactive-package-query nil t))
 566   (package-admin-delete-binary-package package pkg-topdir))
 567
 568 ;;;###autoload
 569 (defun package-get-update-all ()
 570   "Fetch and install the latest versions of all currently installed packages."
 571   (interactive)
 572   (package-get-require-base t)
 573   ;; Load a fresh copy
 574   (catch 'exit
 575     (mapcar (lambda (pkg)
 576               (if (not (package-get (car pkg) nil 'never))
 577                   (throw 'exit nil)             ;; Bail out if error detected
 578                   ))
 579             packages-package-list))
 580   (package-net-update-installed-db))
 581
 582 ;;;###autoload
 583 (defun package-get-all (package version &optional fetched-packages install-dir)
 584   "Fetch PACKAGE with VERSION and all other required packages.
 585 Uses `package-get-base' to determine just what is required and what
 586 package provides that functionality.  If VERSION is nil, retrieves
 587 latest version.  Optional argument FETCHED-PACKAGES is used to keep
 588 track of packages already fetched.  Optional argument INSTALL-DIR,
 589 if non-nil, specifies the package directory where fetched packages
 590 should be installed.
 591
 592 Returns nil upon error."
 593   (interactive (package-get-interactive-package-query t nil))
 594   (let* ((the-package (package-get-info-find-package package-get-base
 595                                                      package))
 596          (this-package (package-get-info-version
 597                         the-package version))
 598          (this-requires (package-get-info-prop this-package 'requires))
 599          )
 600     (catch 'exit
 601       (setq version (package-get-info-prop this-package 'version))
 602       (unless (package-get-installedp package version)
 603         (if (not (package-get package version nil install-dir))
 604             (progn
 605               (setq fetched-packages nil)
 606               (throw 'exit nil))))
 607       (setq fetched-packages
 608             (append (list package)
 609                     (package-get-info-prop this-package 'provides)
 610                     fetched-packages))
 611       ;; grab everything that this package requires plus recursively
 612       ;; grab everything that the requires require.  Keep track
 613       ;; in `fetched-packages' the list of things provided -- this
 614       ;; keeps us from going into a loop
 615       (while this-requires
 616         (if (not (member (car this-requires) fetched-packages))
 617             (let* ((reqd-package (package-get-package-provider
 618                                   (car this-requires) t))
 619                    (reqd-version (cadr reqd-package))
 620                    (reqd-name (car reqd-package)))
 621               (if (null reqd-name)
 622                   (error "Unable to find a provider for %s"
 623                          (car this-requires)))
 624               (if (not (setq fetched-packages
 625                              (package-get-all reqd-name reqd-version
 626                                               fetched-packages
 627                                               install-dir)))
 628                   (throw 'exit nil)))
 629           )
 630         (setq this-requires (cdr this-requires)))
 631       )
 632     fetched-packages
 633     ))
 634
 635 ;;;###autoload
 636 (defun package-get-dependencies (packages)
 637   "Compute dependencies for PACKAGES.
 638 Uses `package-get-base' to determine just what is required and what
 639 package provides that functionality.  Returns the list of packages
 640 required by PACKAGES."
 641   (package-get-require-base t)
 642   (let ((orig-packages packages)
 643         dependencies provided)
 644     (while packages
 645       (let* ((package (car packages))
 646              (the-package (package-get-info-find-package
 647                            package-get-base package))
 648              (this-package (package-get-info-version
 649                             the-package nil))
 650              (this-requires (package-get-info-prop this-package 'requires))
 651              (new-depends   (set-difference
 652                              (mapcar
 653                               #'(lambda (reqd)
 654                                   (let* ((reqd-package (package-get-package-provider reqd))
 655                                          (reqd-name    (car reqd-package)))
 656                                     (if (null reqd-name)
 657                                         (error "Unable to find a provider for %s" reqd))
 658                                     reqd-name))
 659                               this-requires)
 660                              dependencies))
 661              (this-provides (package-get-info-prop this-package 'provides)))
 662         (setq dependencies
 663               (union dependencies new-depends))
 664         (setq provided
 665               (union provided (union (list package) this-provides)))
 666         (setq packages
 667               (union new-depends (cdr packages)))))
 668     (set-difference dependencies orig-packages)))
 669
 670 (defun package-get-load-package-file (lispdir file)
 671   (let (pathname)
 672     (setq pathname (expand-file-name file lispdir))
 673     (condition-case err
 674         (progn
 675           (load pathname t)
 676           t)
 677       (t
 678        (message "Error loading package file \"%s\" %s!" pathname err)
 679        nil))
 680     ))
 681
 682 (defun package-get-init-package (lispdir)
 683   "Initialize the package.
 684 This really assumes that the package has never been loaded.  Updating
 685 a newer package can cause problems, due to old, obsolete functions in
 686 the old package.
 687
 688 Return `t' upon complete success, `nil' if any errors occurred."
 689   (progn
 690     (if (and lispdir
 691              (file-accessible-directory-p lispdir))
 692         (progn
 693           ;; Add lispdir to load-path if it doesn't already exist.
 694           ;; NOTE: this does not take symlinks, etc., into account.
 695           (if (let ( (dirs load-path) )
 696                 (catch 'done
 697                   (while dirs
 698                     (if (string-equal (car dirs) lispdir)
 699                         (throw 'done nil))
 700                     (setq dirs (cdr dirs))
 701                     )
 702                   t))
 703               (setq load-path (cons lispdir load-path)))
 704           (if (not (package-get-load-package-file lispdir "auto-autoloads"))
 705               (package-get-load-package-file lispdir "_pkg"))
 706           t)
 707       nil)
 708     ))
 709
 710 ;;;###autoload
 711 (defun package-get (package &optional version conflict install-dir)
 712   "Fetch PACKAGE from remote site.
 713 Optional arguments VERSION indicates which version to retrieve, nil
 714 means most recent version.  CONFLICT indicates what happens if the
 715 package is already installed.  Valid values for CONFLICT are:
 716 'always always retrieve the package even if it is already installed
 717 'never  do not retrieve the package if it is installed.
 718 INSTALL-DIR, if non-nil, specifies the package directory where
 719 fetched packages should be installed.
 720
 721 The value of `package-get-base' is used to determine what files should
 722 be retrieved.  The value of `package-get-remote' is used to determine
 723 where a package should be retrieved from.  The sites are tried in
 724 order so one is better off listing easily reached sites first.
 725
 726 Once the package is retrieved, its md5 checksum is computed.  If that
 727 sum does not match that stored in `package-get-base' for this version
 728 of the package, an error is signalled.
 729
 730 Returns `t' upon success, the symbol `error' if the package was
 731 successfully installed but errors occurred during initialization, or
 732 `nil' upon error."
 733   (interactive (package-get-interactive-package-query nil t))
 734   (catch 'skip-update
 735   (let* ((this-package
 736           (package-get-info-version
 737            (package-get-info-find-package package-get-base
 738                                           package) version))
 739          (latest (package-get-info-prop this-package 'version))
 740          (installed (package-get-key package :version))
 741          (this-requires (package-get-info-prop this-package 'requires))
 742          (found nil)
 743          (search-dirs package-get-remote)
 744          (base-filename (package-get-info-prop this-package 'filename))
 745          (package-status t)
 746          filenames full-package-filename)
 747     (if (null this-package)
 748         (if package-get-remote
 749             (error "Couldn't find package %s with version %s"
 750                    package version)
 751           (error "No download sites or local package locations specified.")))
 752     (if (null base-filename)
 753         (error "No filename associated with package %s, version %s"
 754                package version))
 755     (setq install-dir
 756           (package-admin-get-install-dir package install-dir
 757                 (or (eq package 'mule-base) (memq 'mule-base this-requires))))
 758
 759     ;; If they asked for the latest using version=nil, don't get an older
 760     ;; version than we already have.
 761     (if installed
 762         (if (> (if (stringp installed)
 763                    (string-to-number installed)
 764                  installed)
 765                (if (stringp latest)
 766                    (string-to-number latest)
 767                  latest))
 768             (if (not (null version))
 769                 (warn "Installing %s package version %s, you had a newer version %s"
 770                       package latest installed)
 771               (warn "Skipping %s package, you have a newer version %s"
 772                     package installed)
 773               (throw 'skip-update t))))
 774
 775     ;; Contrive a list of possible package filenames.
 776     ;; Ugly.  Is there a better way to do this?
 777     (setq filenames (cons base-filename nil))
 778     (if (string-match "^\\(..*\\)\.tar\.gz$" base-filename)
 779         (setq filenames (append filenames
 780                                 (list (concat (match-string 1 base-filename)
 781                                               ".tgz")))))
 782
 783     (setq version latest)
 784     (unless (and (eq conflict 'never)
 785                  (package-get-installedp package version))
 786       ;; Find the package from the search list in package-get-remote
 787       ;; and copy it into the staging directory.  Then validate
 788       ;; the checksum.  Finally, install the package.
 789       (catch 'done
 790         (let (search-filenames current-dir-entry host dir current-filename
 791                                dest-filename)
 792           ;; In each search directory ...
 793           (while search-dirs
 794             (setq current-dir-entry (car search-dirs)
 795                   host (car current-dir-entry)
 796                   dir (car (cdr current-dir-entry))
 797                   search-filenames filenames
 798                   )
 799
 800             ;; Look for one of the possible package filenames ...
 801             (while search-filenames
 802               (setq current-filename (car search-filenames)
 803                     dest-filename (package-get-staging-dir current-filename))
 804               (cond
 805                ;; No host means look on the current system.
 806                ( (null host)
 807                  (setq full-package-filename
 808                        (substitute-in-file-name
 809                         (expand-file-name current-filename
 810                                           (file-name-as-directory dir))))
 811                  )
 812
 813                ;; If it's already on the disk locally, and the size is
 814                ;; greater than zero ...
 815                ( (and (file-exists-p dest-filename)
 816                       (let (attrs)
 817                         ;; file-attributes could return -1 for LARGE files,
 818                         ;; but, hopefully, packages won't be that large.
 819                         (and (setq attrs (file-attributes dest-filename))
 820                              (> (nth 7 attrs) 0))))
 821                  (setq full-package-filename dest-filename)
 822                  )
 823
 824                ;; If the file exists on the remote system ...
 825                ( (file-exists-p (package-get-remote-filename
 826                                  current-dir-entry current-filename))
 827                  ;; Get it
 828                  (setq full-package-filename dest-filename)
 829                  (message "Retrieving package `%s' ..."
 830                           current-filename)
 831                  (sit-for 0)
 832                  (copy-file (package-get-remote-filename current-dir-entry
 833                                                          current-filename)
 834                             full-package-filename t)
 835                  )
 836                )
 837
 838               ;; If we found it, we're done.
 839               (if (and full-package-filename
 840                        (file-exists-p full-package-filename))
 841                   (throw 'done nil))
 842               ;; Didn't find it.  Try the next possible filename.
 843               (setq search-filenames (cdr search-filenames))
 844               )
 845             ;; Try looking in the next possible directory ...
 846             (setq search-dirs (cdr search-dirs))
 847             )
 848           ))
 849
 850       (if (or (not full-package-filename)
 851               (not (file-exists-p full-package-filename)))
 852           (if package-get-remote
 853               (error "Unable to find file %s" base-filename)
 854             (error
 855              "No download sites or local package locations specified.")))
 856       ;; Validate the md5 checksum
 857       ;; Doing it with XEmacs removes the need for an external md5 program
 858       (message "Validating checksum for `%s'..." package) (sit-for 0)
 859       (with-temp-buffer
 860         (insert-file-contents-literally full-package-filename)
 861         (if (not (string= (md5 (current-buffer))
 862                           (package-get-info-prop this-package
 863                                                  'md5sum)))
 864             (error "Package %s does not match md5 checksum" base-filename)))
 865
 866       (package-admin-delete-binary-package package install-dir)
 867
 868       (message "Installing package `%s' ..." package) (sit-for 0)
 869       (let ((status
 870              (package-admin-add-binary-package full-package-filename
 871                                                install-dir)))
 872         (if (= status 0)
 873             (progn
 874               ;; clear messages so that only messages from
 875               ;; package-get-init-package are seen, below.
 876               (clear-message)
 877               (if (package-get-init-package (package-admin-get-lispdir
 878                                              install-dir package))
 879                   (progn
 880                     (run-hook-with-args 'package-install-hook package install-dir)
 881                     (message "Added package `%s'" package)
 882                     (sit-for 0)
 883                     )
 884                 (progn
 885                   ;; display message only if there isn't already one.
 886                   (if (not (current-message))
 887                       (progn
 888                         (message "Added package `%s' (errors occurred)"
 889                                  package)
 890                         (sit-for 0)
 891                         ))
 892                   (if package-status
 893                       (setq package-status 'errors))
 894                   ))
 895               )
 896           (message "Installation of package %s failed." base-filename)
 897           (sit-for 0)
 898           (switch-to-buffer package-admin-temp-buffer)
 899           (setq package-status nil)
 900           ))
 901       (setq found t))
 902     (if (and found package-get-remove-copy)
 903         (delete-file full-package-filename))
 904     package-status
 905     )))
 906
 907 (defun package-get-info-find-package (which name)
 908   "Look in WHICH for the package called NAME and return all the info
 909 associated with it.  See `package-get-base' for info on the format
 910 returned.
 911
 912  To access fields returned from this, use
 913 `package-get-info-version' to return information about particular a
 914 version.  Use `package-get-info-find-prop' to find particular property
 915 from a version returned by `package-get-info-version'."
 916   (interactive "xPackage list: \nsPackage Name: ")
 917   (if which
 918       (if (eq (caar which) name)
 919           (cdar which)
 920         (if (cdr which)
 921             (package-get-info-find-package (cdr which) name)))))
 922
 923 (defun package-get-info-version (package version)
 924   "In PACKAGE, return the plist associated with a particular VERSION of the
 925   package.  PACKAGE is typically as returned by
 926   `package-get-info-find-package'.  If VERSION is nil, then return the
 927   first (aka most recent) version.  Use `package-get-info-find-prop'
 928   to retrieve a particular property from the value returned by this."
 929   (interactive (package-get-interactive-package-query t t))
 930   (while (and version package (not (string= (plist-get (car package) 'version) version)))
 931     (setq package (cdr package)))
 932   (if package (car package)))
 933
 934 (defun package-get-info-prop (package-version property)
 935   "In PACKAGE-VERSION, return the value associated with PROPERTY.
 936 PACKAGE-VERSION is typically returned by `package-get-info-version'
 937 and PROPERTY is typically (although not limited to) one of the
 938 following:
 939
 940 version         - version of this package
 941 provides                - list of symbols provided
 942 requires                - list of symbols that are required.
 943                   These in turn are provided by other packages.
 944 size            - size of the bundled package
 945 md5sum          - computed md5 checksum"
 946   (interactive "xPackage Version: \nSProperty")
 947   (plist-get package-version property))
 948
 949 (defun package-get-info-version-prop (package-list package version property)
 950   "In PACKAGE-LIST, search for PACKAGE with this VERSION and return
 951   PROPERTY value."
 952   (package-get-info-prop
 953    (package-get-info-version
 954     (package-get-info-find-package package-list package) version) property))
 955
 956 (defun package-get-set-version-prop (package-list package version
 957                                                   property value)
 958   "A utility to make it easier to add a VALUE for a specific PROPERTY
 959   in this VERSION of a specific PACKAGE kept in the PACKAGE-LIST.
 960 Returns the modified PACKAGE-LIST.  Any missing fields are created."
 961   )
 962
 963 (defun package-get-staging-dir (filename)
 964   "Return a good place to stash FILENAME when it is retrieved.
 965 Use `package-get-dir' for directory to store stuff.
 966 Creates `package-get-dir'  if it doesn't exist."
 967   (interactive "FPackage filename: ")
 968   (if (not (file-exists-p package-get-dir))
 969       (make-directory package-get-dir))
 970   (expand-file-name
 971    (file-name-nondirectory (or (and (fboundp 'efs-ftp-path)
 972                                     (nth 2 (efs-ftp-path filename)))
 973                                filename))
 974    (file-name-as-directory package-get-dir)))
 975
 976 (defun package-get-remote-filename (search filename)
 977   "Return FILENAME as a remote filename.
 978 It first checks if FILENAME already is a remote filename.  If it is
 979 not, then it uses the (car search) as the remote site-name and the (cadr
 980 search) as the remote-directory and concatenates filename.  In other
 981 words
 982         site-name:remote-directory/filename.
 983
 984 If (car search) is nil, (cadr search is interpreted as  a local directory).
 985 "
 986   (if (file-remote-p filename)
 987       filename
 988     (let ((dir (cadr search)))
 989       (concat (when (car search)
 990                 (concat
 991                  (if (string-match "@" (car search))
 992                      "/"
 993                    "/anonymous@")
 994                  (car search) ":"))
 995               (if (string-match "/$" dir)
 996                   dir
 997                 (concat dir "/"))
 998               filename))))
 999
1000
1001 (defun package-get-installedp (package version)
1002   "Determine if PACKAGE with VERSION has already been installed.
1003 I'm not sure if I want to do this by searching directories or checking
1004 some built in variables.  For now, use packages-package-list."
1005   ;; Use packages-package-list which contains name and version
1006   (equal (plist-get
1007           (package-get-info-find-package packages-package-list
1008                                          package) ':version)
1009          (if (floatp version) version (string-to-number version))))
1010
1011 ;;;###autoload
1012 (defun package-get-package-provider (sym &optional force-current)
1013   "Search for a package that provides SYM and return the name and
1014   version.  Searches in `package-get-base' for SYM.   If SYM is a
1015   consp, then it must match a corresponding (provide (SYM VERSION)) from
1016   the package.
1017
1018 If FORCE-CURRENT is non-nil make sure the database is up to date. This might
1019 lead to Emacs accessing remote sites."
1020   (interactive "SSymbol: ")
1021   (package-get-require-base force-current)
1022   (let ((packages package-get-base)
1023         (done nil)
1024         (found nil))
1025     (while (and (not done) packages)
1026       (let* ((this-name (caar packages))
1027              (this-package (cdr (car packages)))) ;strip off package name
1028         (while (and (not done) this-package)
1029           (if (or (eq this-name sym)
1030                   (eq (cons this-name
1031                           (package-get-info-prop (car this-package) 'version))
1032                       sym)
1033                   (member sym
1034                         (package-get-info-prop (car this-package) 'provides)))
1035               (progn (setq done t)
1036                      (setq found
1037                        (list (caar packages)
1038                          (package-get-info-prop (car this-package) 'version))))
1039             (setq this-package (cdr this-package)))))
1040       (setq packages (cdr packages)))
1041     (when (interactive-p)
1042       (if found
1043           (message "%S" found)
1044         (message "No appropriate package found")))
1045     found))
1046
1047 ;;
1048 ;; customize interfaces.
1049 ;; The group is in this file so that custom loads includes this file.
1050 ;;
1051 (defgroup packages nil
1052   "Configure XEmacs packages."
1053   :group 'emacs)
1054
1055 ;;;###autoload
1056 (defun package-get-custom ()
1057   "Fetch and install the latest versions of all customized packages."
1058   (interactive)
1059   (package-get-require-base t)
1060   (mapcar (lambda (pkg)
1061             (if (eval (intern (concat (symbol-name (car pkg)) "-package")))
1062                 (package-get (car pkg) nil))
1063             t)
1064           package-get-base)
1065   (package-net-update-installed-db))
1066
1067 (defun package-get-ever-installed-p (pkg &optional notused)
1068   (string-match "-package$" (symbol-name pkg))
1069   (custom-initialize-set
1070    pkg
1071    (if (package-get-info-find-package
1072         packages-package-list
1073         (intern (substring (symbol-name pkg) 0 (match-beginning 0))))
1074        t)))
1075
1076 (defvar package-get-custom-groups nil
1077   "List of package-get-custom groups")
1078
1079 (defun package-get-custom-add-entry (package props)
1080   (let* ((category (plist-get props 'category))
1081          (group (intern (concat category "-packages")))
1082          (custom-var (intern (concat (symbol-name package) "-package")))
1083          (description (plist-get props 'description)))
1084     (when (not (memq group package-get-custom-groups))
1085       (setq package-get-custom-groups (cons group
1086                                             package-get-custom-groups))
1087       (eval `(defgroup ,group nil
1088                ,(concat category " package group")
1089                :group 'packages)))
1090     (eval `(defcustom ,custom-var nil
1091              ,description
1092              :group ',group
1093              :initialize 'package-get-ever-installed-p
1094              :type 'boolean))))
1095
1096
1097 (provide 'package-get)
1098 ;;; package-get.el ends here