git.chise.org Git - chise/xemacs-chise.git.1/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     ("xemacs.org" "ftp.xemacs.org" "pub/xemacs/packages")
 188     ("crc.ca (Canada)" "ftp.crc.ca" "pub/packages/editors/xemacs/packages")
 189     ("ualberta.ca (Canada)" "sunsite.ualberta.ca" "pub/Mirror/xemacs/packages")
 190     ("uiuc.edu (United States)" "uiarchive.uiuc.edu" "pub/packages/xemacs/packages")
 191     ("unc.edu (United States)" "metalab.unc.edu" "pub/packages/editors/xemacs/packages")
 192     ("utk.edu (United States)" "ftp.sunsite.utk.edu" "pub/xemacs/packages")
 193
 194     ;; South America
 195     ("unicamp.br (Brazil)" "ftp.unicamp.br" "pub/xemacs/packages")
 196
 197     ;; Europe
 198     ("tuwien.ac.at (Austria)" "gd.tuwien.ac.at" "editors/xemacs/packages")
 199     ("auc.dk (Denmark)" "sunsite.auc.dk" "pub/emacs/xemacs/packages")
 200     ("doc.ic.ac.uk (England)" "sunsite.doc.ic.ac.uk" "packages/xemacs/packages")
 201     ("funet.fi (Finland)" "ftp.funet.fi" "pub/mirrors/ftp.xemacs.org/pub/tux/xemacs/packages")
 202     ("cenatls.cena.dgac.fr (France)" "ftp.cenatls.cena.dgac.fr" "Emacs/xemacs/packages")
 203     ("pasteur.fr (France)" "ftp.pasteur.fr" "pub/computing/xemacs/packages")
 204     ("tu-darmstadt.de (Germany)" "ftp.tu-darmstadt.de" "pub/editors/xemacs/packages")
 205     ("kfki.hu (Hungary)" "ftp.kfki.hu" "pub/packages/xemacs/packages")
 206     ("eunet.ie (Ireland)" "ftp.eunet.ie" "mirrors/ftp.xemacs.org/pub/xemacs/packages")
 207     ("uniroma2.it (Italy)" "ftp.uniroma2.it" "unix/misc/dist/XEMACS/packages")
 208     ("uio.no (Norway)" "sunsite.uio.no" "pub/xemacs/packages")
 209     ("icm.edu.pl (Poland)" "ftp.icm.edu.pl" "pub/unix/editors/xemacs/packages")
 210     ("srcc.msu.su (Russia)" "ftp.srcc.msu.su" "mirror/ftp.xemacs.org/packages")
 211     ("sunet.se (Sweden)" "ftp.sunet.se" "pub/gnu/xemacs/packages")
 212     ("cnlab-switch.ch (Switzerland)" "sunsite.cnlab-switch.ch" "mirror/xemacs/packages")
 213
 214     ;; Asia
 215     ("aist.go.jp (Japan)" "ring.aist.go.jp" "pub/text/xemacs/packages")
 216     ("asahi-net.or.jp (Japan)" "ring.asahi-net.or.jp" "pub/text/xemacs/packages")
 217     ("dti.ad.jp (Japan)" "ftp.dti.ad.jp" "pub/unix/editor/xemacs/packages")
 218     ("jaist.ac.jp (Japan)" "ftp.jaist.ac.jp" "pub/GNU/xemacs/packages")
 219     ("nucba.ac.jp (Japan)" "mirror.nucba.ac.jp" "mirror/xemacs/packages")
 220     ("sut.ac.jp (Japan)" "sunsite.sut.ac.jp" "pub/archives/packages/xemacs/packages")
 221     ("tsukuba.ac.jp (Japan)" "ftp.netlab.is.tsukuba.ac.jp" "pub/GNU/xemacs/packages")
 222     ("kreonet.re.kr (Korea)" "ftp.kreonet.re.kr" "pub/tools/emacs/xemacs/packages")
 223     ("nctu.edu.tw (Taiwan)" "coda.nctu.edu.tw" "Editors/xemacs/packages")
 224
 225     ;; Africa
 226     ("sun.ac.za (South Africa)" "ftp.sun.ac.za" "xemacs/packages")
 227
 228     ;; Middle East
 229     ("isu.net.sa (Saudi Arabia)" "ftp.isu.net.sa" "pub/mirrors/ftp.xemacs.org/packages")
 230
 231     ;; Australia
 232     ("aarnet.edu.au (Australia)" "mirror.aarnet.edu.au" "pub/xemacs/packages")
 233     )
 234   "*List of remote sites available for downloading packages.
 235 List format is '(site-description site-name directory-on-site).
 236 SITE-DESCRIPTION is a textual description of the site.  SITE-NAME
 237 is the internet address of the download site.  DIRECTORY-ON-SITE
 238 is the directory on the site in which packages may be found.
 239 This variable is used to initialize `package-get-remote', the
 240 variable actually used to specify package download sites."
 241   :tag "Package download sites"
 242   :type '(repeat (list (string :tag "Name") host-name directory))
 243   :group 'package-get)
 244
 245 (defcustom package-get-remove-copy t
 246   "*After copying and installing a package, if this is t, then remove the
 247 copy.  Otherwise, keep it around."
 248   :type 'boolean
 249   :group 'package-get)
 250
 251 ;; #### it may make sense for this to be a list of names.
 252 ;; #### also, should we rename "*base*" to "*index*" or "*db*"?
 253 ;;      "base" is a pretty poor name.
 254 (defcustom package-get-base-filename "package-index.LATEST.pgp"
 255   "*Name of the default package-get database file.
 256 This may either be a relative path, in which case it is interpreted
 257 with respect to `package-get-remote', or an absolute path."
 258   :type 'file
 259   :group 'package-get)
 260
 261 (defvar package-get-user-index-filename
 262   (paths-construct-path (list user-init-directory package-get-base-filename))
 263   "Name for the user-specific location of the package-get database file.")
 264
 265 (defcustom package-get-always-update nil
 266   "*If Non-nil always make sure we are using the latest package index (base).
 267 Otherwise respect the `force-current' argument of `package-get-require-base'."
 268   :type 'boolean
 269   :group 'package-get)
 270
 271 (defcustom package-get-require-signed-base-updates t
 272   "*If set to a non-nil value, require explicit user confirmation for updates
 273 to the package-get database which cannot have their signature verified via PGP.
 274 When nil, updates which are not PGP signed are allowed without confirmation."
 275   :type 'boolean
 276   :group 'package-get)
 277
 278 (defvar package-get-was-current nil
 279   "Non-nil we did our best to fetch a current database.")
 280
 281
 282 ;Shouldn't this be in package-ui?
 283 ;;;###autoload
 284 (defun package-get-download-menu ()
 285   "Build the `Add Download Site' menu."
 286   (mapcar (lambda (site)
 287             (vector (car site)
 288                     `(if (member (quote ,(cdr site))
 289                                  package-get-remote)
 290                          (setq package-get-remote
 291                                (delete (quote ,(cdr site))
 292                                        package-get-remote))
 293                        (package-ui-add-site (quote ,(cdr site))))
 294                     :style 'toggle
 295                     :selected `(member (quote ,(cdr site))
 296                                        package-get-remote)))
 297           package-get-download-sites))
 298
 299 ;;;###autoload
 300 (defun package-get-require-base (&optional force-current)
 301   "Require that a package-get database has been loaded.
 302 If the optional FORCE-CURRENT argument or the value of
 303 `package-get-always-update' is Non-nil, try to update the database
 304 from a location in `package-get-remote'. Otherwise a local copy is used
 305 if available and remote access is never done.
 306
 307 Please use FORCE-CURRENT only when the user is explictly dealing with packages
 308 and remote access is likely in the near future."
 309   (setq force-current (or force-current package-get-always-update))
 310   (unless (and (boundp 'package-get-base)
 311                package-get-base
 312                (or (not force-current) package-get-was-current))
 313     (package-get-update-base nil force-current))
 314   (if (or (not (boundp 'package-get-base))
 315           (not package-get-base))
 316       (error "Package-get database not loaded")
 317     (setq package-get-was-current force-current)))
 318
 319 (defconst package-get-pgp-signed-begin-line "^-----BEGIN PGP SIGNED MESSAGE-----"
 320   "Text for start of PGP signed messages.")
 321 (defconst package-get-pgp-signature-begin-line "^-----BEGIN PGP SIGNATURE-----"
 322   "Text for beginning of PGP signature.")
 323 (defconst package-get-pgp-signature-end-line "^-----END PGP SIGNATURE-----"
 324   "Text for end of PGP signature.")
 325
 326 ;;;###autoload
 327 (defun package-get-update-base-entry (entry)
 328   "Update an entry in `package-get-base'."
 329   (let ((existing (assq (car entry) package-get-base)))
 330     (if existing
 331         (setcdr existing (cdr entry))
 332       (setq package-get-base (cons entry package-get-base))
 333       (package-get-custom-add-entry (car entry) (car (cdr entry))))))
 334
 335 (defun package-get-locate-file (file &optional nil-if-not-found no-remote)
 336   "Locate an existing FILE with respect to `package-get-remote'.
 337 If FILE is an absolute path or is not found, simply return FILE.
 338 If optional argument NIL-IF-NOT-FOUND is non-nil, return nil
 339 if FILE can not be located.
 340 If NO-REMOTE is non-nil never search remote locations."
 341   (if (file-name-absolute-p file)
 342       file
 343     (let ((entries package-get-remote)
 344           (expanded nil))
 345       (while entries
 346         (unless (and no-remote (caar entries))
 347           (let ((expn (package-get-remote-filename (car entries) file)))
 348             (if (and expn (file-exists-p expn))
 349                 (setq entries  nil
 350                       expanded expn))))
 351         (setq entries (cdr entries)))
 352       (or expanded
 353           (and (not nil-if-not-found)
 354                file)))))
 355
 356 (defun package-get-locate-index-file (no-remote)
 357   "Locate the package-get index file.  Do not return remote paths if NO-REMOTE
 358 is non-nil."
 359   (or (package-get-locate-file package-get-base-filename t no-remote)
 360       (if (file-exists-p package-get-user-index-filename)
 361           package-get-user-index-filename)))
 362
 363 (defun package-get-maybe-save-index (filename)
 364   "Offer to save the current buffer as the local package index file,
 365 if different."
 366   (let ((location (package-get-locate-index-file t)))
 367     (unless (and filename (equal filename location))
 368       (unless (and location
 369                    (equal (md5 (current-buffer))
 370                           (with-temp-buffer
 371                             (insert-file-contents-literally location)
 372                             (md5 (current-buffer)))))
 373         (unless (and location (file-writable-p location))
 374           (setq location package-get-user-index-filename))
 375         (when (y-or-n-p (concat "Update package index in " location "? "))
 376           (write-file location))))))
 377
 378
 379 ;;;###autoload
 380 (defun package-get-update-base (&optional db-file force-current)
 381   "Update the package-get database file with entries from DB-FILE.
 382 Unless FORCE-CURRENT is non-nil never try to update the database."
 383   (interactive
 384    (let ((dflt (package-get-locate-index-file nil)))
 385      (list (read-file-name "Load package-get database: "
 386                            (file-name-directory dflt)
 387                            dflt
 388                            t
 389                            (file-name-nondirectory dflt)))))
 390   (setq db-file (expand-file-name (or db-file
 391                                       (package-get-locate-index-file
 392                                          (not force-current)))))
 393   (if (not (file-exists-p db-file))
 394       (error "Package-get database file `%s' does not exist" db-file))
 395   (if (not (file-readable-p db-file))
 396       (error "Package-get database file `%s' not readable" db-file))
 397   (let ((buf (get-buffer-create "*package database*")))
 398     (unwind-protect
 399         (save-excursion
 400           (set-buffer buf)
 401           (erase-buffer buf)
 402           (insert-file-contents-internal db-file)
 403           (package-get-update-base-from-buffer buf)
 404           (if (file-remote-p db-file)
 405               (package-get-maybe-save-index db-file)))
 406       (kill-buffer buf))))
 407
 408 ;;;###autoload
 409 (defun package-get-update-base-from-buffer (&optional buf)
 410   "Update the package-get database with entries from BUFFER.
 411 BUFFER defaults to the current buffer.  This command can be
 412 used interactively, for example from a mail or news buffer."
 413   (interactive)
 414   (setq buf (or buf (current-buffer)))
 415   (let (content-beg content-end beg end)
 416     (save-excursion
 417       (set-buffer buf)
 418       (goto-char (point-min))
 419       (setq content-beg (point))
 420       (setq content-end (save-excursion (goto-char (point-max)) (point)))
 421       (when (re-search-forward package-get-pgp-signed-begin-line nil t)
 422         (setq beg (match-beginning 0))
 423         (setq content-beg (match-end 0)))
 424       (when (re-search-forward package-get-pgp-signature-begin-line nil t)
 425         (setq content-end (match-beginning 0)))
 426       (when (re-search-forward package-get-pgp-signature-end-line nil t)
 427         (setq end (point)))
 428       (if (not (and content-beg content-end beg end))
 429           (or (not package-get-require-signed-base-updates)
 430               (yes-or-no-p "Package-get entries not PGP signed, continue? ")
 431               (error "Package-get database not updated")))
 432       (if (and content-beg content-end beg end)
 433           (if (not (condition-case nil
 434                        (or (fboundp 'mc-pgp-verify-region)
 435                            (load-library "mc-pgp")
 436                            (fboundp 'mc-pgp-verify-region))
 437                      (error nil)))
 438               (or (not package-get-require-signed-base-updates)
 439                   (yes-or-no-p
 440                    "No mailcrypt; can't verify package-get DB signature, continue? ")
 441                   (error "Package-get database not updated"))))
 442       (if (and beg end
 443                (fboundp 'mc-pgp-verify-region)
 444                (or (not
 445                     (condition-case err
 446                         (mc-pgp-verify-region beg end)
 447                       (file-error
 448                        (and (string-match "No such file" (nth 2 err))
 449                             (or (not package-get-require-signed-base-updates)
 450                                 (yes-or-no-p
 451                                  (concat "Can't find PGP, continue without "
 452                                          "package-get DB verification? ")))))
 453                       (t nil)))))
 454           (error "Package-get PGP signature failed to verify"))
 455       ;; ToDo: We should call package-get-maybe-save-index on the region
 456       (package-get-update-base-entries content-beg content-end)
 457       (message "Updated package-get database"))))
 458
 459 (defun package-get-update-base-entries (beg end)
 460   "Update the package-get database with the entries found between
 461 BEG and END in the current buffer."
 462   (save-excursion
 463     (goto-char beg)
 464     (if (not (re-search-forward "^(package-get-update-base-entry" nil t))
 465         (error "Buffer does not contain package-get database entries"))
 466     (beginning-of-line)
 467     (let ((count 0))
 468       (while (and (< (point) end)
 469                   (re-search-forward "^(package-get-update-base-entry" nil t))
 470         (beginning-of-line)
 471         (let ((entry (read (current-buffer))))
 472           (if (or (not (consp entry))
 473                   (not (eq (car entry) 'package-get-update-base-entry)))
 474               (error "Invalid package-get database entry found"))
 475           (package-get-update-base-entry
 476            (car (cdr (car (cdr entry)))))
 477           (setq count (1+ count))))
 478       (message "Got %d package-get database entries" count))))
 479
 480 ;;;###autoload
 481 (defun package-get-save-base (file)
 482   "Write the package-get database to FILE.
 483
 484 Note: This database will be unsigned of course."
 485   (interactive "FSave package-get database to: ")
 486   (package-get-require-base t)
 487   (let ((buf (get-buffer-create "*package database*")))
 488     (unwind-protect
 489         (save-excursion
 490           (set-buffer buf)
 491           (erase-buffer buf)
 492           (goto-char (point-min))
 493           (let ((entries package-get-base) entry plist)
 494             (insert ";; Package Index file -- Do not edit manually.\n")
 495             (insert ";;;@@@\n")
 496             (while entries
 497               (setq entry (car entries))
 498               (setq plist (car (cdr entry)))
 499               (insert "(package-get-update-base-entry (quote\n")
 500               (insert (format "(%s\n" (symbol-name (car entry))))
 501               (while plist
 502                 (insert (format "  %s%s %S\n"
 503                                 (if (eq plist (car (cdr entry))) "(" " ")
 504                                 (symbol-name (car plist))
 505                                 (car (cdr plist))))
 506                 (setq plist (cdr (cdr plist))))
 507               (insert "))\n))\n;;;@@@\n")
 508               (setq entries (cdr entries))))
 509           (insert ";; Package Index file ends here\n")
 510           (write-region (point-min) (point-max) file))
 511       (kill-buffer buf))))
 512
 513 (defun package-get-interactive-package-query (get-version package-symbol)
 514   "Perform interactive querying for package and optional version.
 515 Query for a version if GET-VERSION is non-nil.  Return package name as
 516 a symbol instead of a string if PACKAGE-SYMBOL is non-nil.
 517 The return value is suitable for direct passing to `interactive'."
 518   (package-get-require-base t)
 519   (let ((table (mapcar #'(lambda (item)
 520                            (let ((name (symbol-name (car item))))
 521                              (cons name name)))
 522                        package-get-base))
 523         package package-symbol default-version version)
 524     (save-window-excursion
 525       (setq package (completing-read "Package: " table nil t))
 526       (setq package-symbol (intern package))
 527       (if get-version
 528           (progn
 529             (setq default-version
 530                   (package-get-info-prop
 531                    (package-get-info-version
 532                     (package-get-info-find-package package-get-base
 533                                                    package-symbol) nil)
 534                    'version))
 535             (while (string=
 536                     (setq version (read-string "Version: " default-version))
 537                     "")
 538               )
 539             (if package-symbol
 540                 (list package-symbol version)
 541               (list package version))
 542             )
 543         (if package-symbol
 544             (list package-symbol)
 545           (list package))))))
 546
 547 ;;;###autoload
 548 (defun package-get-delete-package (package &optional pkg-topdir)
 549   "Delete an installation of PACKAGE below directory PKG-TOPDIR.
 550 PACKAGE is a symbol, not a string.
 551 This is just an interactive wrapper for `package-admin-delete-binary-package'."
 552   (interactive (package-get-interactive-package-query nil t))
 553   (package-admin-delete-binary-package package pkg-topdir))
 554
 555 ;;;###autoload
 556 (defun package-get-update-all ()
 557   "Fetch and install the latest versions of all currently installed packages."
 558   (interactive)
 559   (package-get-require-base t)
 560   ;; Load a fresh copy
 561   (catch 'exit
 562     (mapcar (lambda (pkg)
 563               (if (not (package-get (car pkg) nil 'never))
 564                   (throw 'exit nil)             ;; Bail out if error detected
 565                   ))
 566             packages-package-list)))
 567
 568 ;;;###autoload
 569 (defun package-get-all (package version &optional fetched-packages install-dir)
 570   "Fetch PACKAGE with VERSION and all other required packages.
 571 Uses `package-get-base' to determine just what is required and what
 572 package provides that functionality.  If VERSION is nil, retrieves
 573 latest version.  Optional argument FETCHED-PACKAGES is used to keep
 574 track of packages already fetched.  Optional argument INSTALL-DIR,
 575 if non-nil, specifies the package directory where fetched packages
 576 should be installed.
 577
 578 Returns nil upon error."
 579   (interactive (package-get-interactive-package-query t nil))
 580   (let* ((the-package (package-get-info-find-package package-get-base
 581                                                      package))
 582          (this-package (package-get-info-version
 583                         the-package version))
 584          (this-requires (package-get-info-prop this-package 'requires))
 585          )
 586     (catch 'exit
 587       (setq version (package-get-info-prop this-package 'version))
 588       (unless (package-get-installedp package version)
 589         (if (not (package-get package version nil install-dir))
 590             (progn
 591               (setq fetched-packages nil)
 592               (throw 'exit nil))))
 593       (setq fetched-packages
 594             (append (list package)
 595                     (package-get-info-prop this-package 'provides)
 596                     fetched-packages))
 597       ;; grab everything that this package requires plus recursively
 598       ;; grab everything that the requires require.  Keep track
 599       ;; in `fetched-packages' the list of things provided -- this
 600       ;; keeps us from going into a loop
 601       (while this-requires
 602         (if (not (member (car this-requires) fetched-packages))
 603             (let* ((reqd-package (package-get-package-provider
 604                                   (car this-requires) t))
 605                    (reqd-version (cadr reqd-package))
 606                    (reqd-name (car reqd-package)))
 607               (if (null reqd-name)
 608                   (error "Unable to find a provider for %s"
 609                          (car this-requires)))
 610               (if (not (setq fetched-packages
 611                              (package-get-all reqd-name reqd-version
 612                                               fetched-packages
 613                                               install-dir)))
 614                   (throw 'exit nil)))
 615           )
 616         (setq this-requires (cdr this-requires)))
 617       )
 618     fetched-packages
 619     ))
 620
 621 ;;;###autoload
 622 (defun package-get-dependencies (packages)
 623   "Compute dependencies for PACKAGES.
 624 Uses `package-get-base' to determine just what is required and what
 625 package provides that functionality.  Returns the list of packages
 626 required by PACKAGES."
 627   (package-get-require-base t)
 628   (let ((orig-packages packages)
 629         dependencies provided)
 630     (while packages
 631       (let* ((package (car packages))
 632              (the-package (package-get-info-find-package
 633                            package-get-base package))
 634              (this-package (package-get-info-version
 635                             the-package nil))
 636              (this-requires (package-get-info-prop this-package 'requires))
 637              (new-depends   (set-difference
 638                              (mapcar
 639                               #'(lambda (reqd)
 640                                   (let* ((reqd-package (package-get-package-provider reqd))
 641                                          (reqd-version (cadr reqd-package))
 642                                          (reqd-name    (car reqd-package)))
 643                                     (if (null reqd-name)
 644                                         (error "Unable to find a provider for %s" reqd))
 645                                     reqd-name))
 646                               this-requires)
 647                              dependencies))
 648              (this-provides (package-get-info-prop this-package 'provides)))
 649         (setq dependencies
 650               (union dependencies new-depends))
 651         (setq provided
 652               (union provided (union (list package) this-provides)))
 653         (setq packages
 654               (union new-depends (cdr packages)))))
 655     (set-difference dependencies orig-packages)))
 656
 657 (defun package-get-load-package-file (lispdir file)
 658   (let (pathname)
 659     (setq pathname (expand-file-name file lispdir))
 660     (condition-case err
 661         (progn
 662           (load pathname t)
 663           t)
 664       (t
 665        (message "Error loading package file \"%s\" %s!" pathname err)
 666        nil))
 667     ))
 668
 669 (defun package-get-init-package (lispdir)
 670   "Initialize the package.
 671 This really assumes that the package has never been loaded.  Updating
 672 a newer package can cause problems, due to old, obsolete functions in
 673 the old package.
 674
 675 Return `t' upon complete success, `nil' if any errors occurred."
 676   (progn
 677     (if (and lispdir
 678              (file-accessible-directory-p lispdir))
 679         (progn
 680           ;; Add lispdir to load-path if it doesn't already exist.
 681           ;; NOTE: this does not take symlinks, etc., into account.
 682           (if (let ( (dirs load-path) )
 683                 (catch 'done
 684                   (while dirs
 685                     (if (string-equal (car dirs) lispdir)
 686                         (throw 'done nil))
 687                     (setq dirs (cdr dirs))
 688                     )
 689                   t))
 690               (setq load-path (cons lispdir load-path)))
 691           (if (not (package-get-load-package-file lispdir "auto-autoloads"))
 692               (package-get-load-package-file lispdir "_pkg"))
 693           t)
 694       nil)
 695     ))
 696
 697 ;;;###autoload
 698 (defun package-get (package &optional version conflict install-dir)
 699   "Fetch PACKAGE from remote site.
 700 Optional arguments VERSION indicates which version to retrieve, nil
 701 means most recent version.  CONFLICT indicates what happens if the
 702 package is already installed.  Valid values for CONFLICT are:
 703 'always always retrieve the package even if it is already installed
 704 'never  do not retrieve the package if it is installed.
 705 INSTALL-DIR, if non-nil, specifies the package directory where
 706 fetched packages should be installed.
 707
 708 The value of `package-get-base' is used to determine what files should
 709 be retrieved.  The value of `package-get-remote' is used to determine
 710 where a package should be retrieved from.  The sites are tried in
 711 order so one is better off listing easily reached sites first.
 712
 713 Once the package is retrieved, its md5 checksum is computed.  If that
 714 sum does not match that stored in `package-get-base' for this version
 715 of the package, an error is signalled.
 716
 717 Returns `t' upon success, the symbol `error' if the package was
 718 successfully installed but errors occurred during initialization, or
 719 `nil' upon error."
 720   (interactive (package-get-interactive-package-query nil t))
 721   (catch 'skip-update
 722   (let* ((this-package
 723           (package-get-info-version
 724            (package-get-info-find-package package-get-base
 725                                           package) version))
 726          (latest (package-get-info-prop this-package 'version))
 727          (installed (package-get-key package :version))
 728          (this-requires (package-get-info-prop this-package 'requires))
 729          (found nil)
 730          (search-dirs package-get-remote)
 731          (base-filename (package-get-info-prop this-package 'filename))
 732          (package-status t)
 733          filenames full-package-filename)
 734     (if (null this-package)
 735         (if package-get-remote
 736             (error "Couldn't find package %s with version %s"
 737                    package version)
 738           (error "No download sites or local package locations specified.")))
 739     (if (null base-filename)
 740         (error "No filename associated with package %s, version %s"
 741                package version))
 742     (setq install-dir
 743           (package-admin-get-install-dir package install-dir
 744                 (or (eq package 'mule-base) (memq 'mule-base this-requires))))
 745
 746     ;; If they asked for the latest using version=nil, don't get an older
 747     ;; version than we already have.
 748     (if installed
 749         (if (> (if (stringp installed)
 750                    (string-to-number installed)
 751                  installed)
 752                (if (stringp latest)
 753                    (string-to-number latest)
 754                  latest))
 755             (if (not (null version))
 756                 (warn "Installing %s package version %s, you had a newer version %s"
 757                       package latest installed)
 758               (warn "Skipping %s package, you have a newer version %s"
 759                     package installed)
 760               (throw 'skip-update t))))
 761
 762     ;; Contrive a list of possible package filenames.
 763     ;; Ugly.  Is there a better way to do this?
 764     (setq filenames (cons base-filename nil))
 765     (if (string-match "^\\(..*\\)\.tar\.gz$" base-filename)
 766         (setq filenames (append filenames
 767                                 (list (concat (match-string 1 base-filename)
 768                                               ".tgz")))))
 769
 770     (setq version latest)
 771     (unless (and (eq conflict 'never)
 772                  (package-get-installedp package version))
 773       ;; Find the package from the search list in package-get-remote
 774       ;; and copy it into the staging directory.  Then validate
 775       ;; the checksum.  Finally, install the package.
 776       (catch 'done
 777         (let (search-filenames current-dir-entry host dir current-filename
 778                                dest-filename)
 779           ;; In each search directory ...
 780           (while search-dirs
 781             (setq current-dir-entry (car search-dirs)
 782                   host (car current-dir-entry)
 783                   dir (car (cdr current-dir-entry))
 784                   search-filenames filenames
 785                   )
 786
 787             ;; Look for one of the possible package filenames ...
 788             (while search-filenames
 789               (setq current-filename (car search-filenames)
 790                     dest-filename (package-get-staging-dir current-filename))
 791               (cond
 792                ;; No host means look on the current system.
 793                ( (null host)
 794                  (setq full-package-filename
 795                        (substitute-in-file-name
 796                         (expand-file-name current-filename
 797                                           (file-name-as-directory dir))))
 798                  )
 799
 800                ;; If it's already on the disk locally, and the size is
 801                ;; greater than zero ...
 802                ( (and (file-exists-p dest-filename)
 803                       (let (attrs)
 804                         ;; file-attributes could return -1 for LARGE files,
 805                         ;; but, hopefully, packages won't be that large.
 806                         (and (setq attrs (file-attributes dest-filename))
 807                              (> (nth 7 attrs) 0))))
 808                  (setq full-package-filename dest-filename)
 809                  )
 810
 811                ;; If the file exists on the remote system ...
 812                ( (file-exists-p (package-get-remote-filename
 813                                  current-dir-entry current-filename))
 814                  ;; Get it
 815                  (setq full-package-filename dest-filename)
 816                  (message "Retrieving package `%s' ..."
 817                           current-filename)
 818                  (sit-for 0)
 819                  (copy-file (package-get-remote-filename current-dir-entry
 820                                                          current-filename)
 821                             full-package-filename t)
 822                  )
 823                )
 824
 825               ;; If we found it, we're done.
 826               (if (and full-package-filename
 827                        (file-exists-p full-package-filename))
 828                   (throw 'done nil))
 829               ;; Didn't find it.  Try the next possible filename.
 830               (setq search-filenames (cdr search-filenames))
 831               )
 832             ;; Try looking in the next possible directory ...
 833             (setq search-dirs (cdr search-dirs))
 834             )
 835           ))
 836
 837       (if (or (not full-package-filename)
 838               (not (file-exists-p full-package-filename)))
 839           (if package-get-remote
 840               (error "Unable to find file %s" base-filename)
 841             (error
 842              "No download sites or local package locations specified.")))
 843       ;; Validate the md5 checksum
 844       ;; Doing it with XEmacs removes the need for an external md5 program
 845       (message "Validating checksum for `%s'..." package) (sit-for 0)
 846       (with-temp-buffer
 847         ;; What ever happened to i-f-c-literally
 848         (let (file-name-handler-alist)
 849           (insert-file-contents-internal full-package-filename))
 850         (if (not (string= (md5 (current-buffer))
 851                           (package-get-info-prop this-package
 852                                                  'md5sum)))
 853             (error "Package %s does not match md5 checksum" base-filename)))
 854
 855       (package-admin-delete-binary-package package install-dir)
 856
 857       (message "Installing package `%s' ..." package) (sit-for 0)
 858       (let ((status
 859              (package-admin-add-binary-package full-package-filename
 860                                                install-dir)))
 861         (if (= status 0)
 862             (progn
 863               ;; clear messages so that only messages from
 864               ;; package-get-init-package are seen, below.
 865               (clear-message)
 866               (if (package-get-init-package (package-admin-get-lispdir
 867                                              install-dir package))
 868                   (progn
 869                     (message "Added package `%s'" package)
 870                     (sit-for 0)
 871                     )
 872                 (progn
 873                   ;; display message only if there isn't already one.
 874                   (if (not (current-message))
 875                       (progn
 876                         (message "Added package `%s' (errors occurred)"
 877                                  package)
 878                         (sit-for 0)
 879                         ))
 880                   (if package-status
 881                       (setq package-status 'errors))
 882                   ))
 883               )
 884           (message "Installation of package %s failed." base-filename)
 885           (sit-for 0)
 886           (switch-to-buffer package-admin-temp-buffer)
 887           (setq package-status nil)
 888           ))
 889       (setq found t))
 890     (if (and found package-get-remove-copy)
 891         (delete-file full-package-filename))
 892     package-status
 893     )))
 894
 895 (defun package-get-info-find-package (which name)
 896   "Look in WHICH for the package called NAME and return all the info
 897 associated with it.  See `package-get-base' for info on the format
 898 returned.
 899
 900  To access fields returned from this, use
 901 `package-get-info-version' to return information about particular a
 902 version.  Use `package-get-info-find-prop' to find particular property
 903 from a version returned by `package-get-info-version'."
 904   (interactive "xPackage list: \nsPackage Name: ")
 905   (if which
 906       (if (eq (caar which) name)
 907           (cdar which)
 908         (if (cdr which)
 909             (package-get-info-find-package (cdr which) name)))))
 910
 911 (defun package-get-info-version (package version)
 912   "In PACKAGE, return the plist associated with a particular VERSION of the
 913   package.  PACKAGE is typically as returned by
 914   `package-get-info-find-package'.  If VERSION is nil, then return the
 915   first (aka most recent) version.  Use `package-get-info-find-prop'
 916   to retrieve a particular property from the value returned by this."
 917   (interactive (package-get-interactive-package-query t t))
 918   (while (and version package (not (string= (plist-get (car package) 'version) version)))
 919     (setq package (cdr package)))
 920   (if package (car package)))
 921
 922 (defun package-get-info-prop (package-version property)
 923   "In PACKAGE-VERSION, return the value associated with PROPERTY.
 924 PACKAGE-VERSION is typically returned by `package-get-info-version'
 925 and PROPERTY is typically (although not limited to) one of the
 926 following:
 927
 928 version         - version of this package
 929 provides                - list of symbols provided
 930 requires                - list of symbols that are required.
 931                   These in turn are provided by other packages.
 932 size            - size of the bundled package
 933 md5sum          - computed md5 checksum"
 934   (interactive "xPackage Version: \nSProperty")
 935   (plist-get package-version property))
 936
 937 (defun package-get-info-version-prop (package-list package version property)
 938   "In PACKAGE-LIST, search for PACKAGE with this VERSION and return
 939   PROPERTY value."
 940   (package-get-info-prop
 941    (package-get-info-version
 942     (package-get-info-find-package package-list package) version) property))
 943
 944 (defun package-get-set-version-prop (package-list package version
 945                                                   property value)
 946   "A utility to make it easier to add a VALUE for a specific PROPERTY
 947   in this VERSION of a specific PACKAGE kept in the PACKAGE-LIST.
 948 Returns the modified PACKAGE-LIST.  Any missing fields are created."
 949   )
 950
 951 (defun package-get-staging-dir (filename)
 952   "Return a good place to stash FILENAME when it is retrieved.
 953 Use `package-get-dir' for directory to store stuff.
 954 Creates `package-get-dir'  it it doesn't exist."
 955   (interactive "FPackage filename: ")
 956   (if (not (file-exists-p package-get-dir))
 957       (make-directory package-get-dir))
 958   (expand-file-name
 959    (file-name-nondirectory (or (and (fboundp 'efs-ftp-path)
 960                                     (nth 2 (efs-ftp-path filename)))
 961                                filename))
 962    (file-name-as-directory package-get-dir)))
 963
 964 (defun package-get-remote-filename (search filename)
 965   "Return FILENAME as a remote filename.
 966 It first checks if FILENAME already is a remote filename.  If it is
 967 not, then it uses the (car search) as the remote site-name and the (cadr
 968 search) as the remote-directory and concatenates filename.  In other
 969 words
 970         site-name:remote-directory/filename.
 971
 972 If (car search) is nil, (cadr search is interpreted as  a local directory).
 973 "
 974   (if (file-remote-p filename)
 975       filename
 976     (let ((dir (cadr search)))
 977       (concat (when (car search)
 978                 (concat
 979                  (if (string-match "@" (car search))
 980                      "/"
 981                    "/anonymous@")
 982                  (car search) ":"))
 983               (if (string-match "/$" dir)
 984                   dir
 985                 (concat dir "/"))
 986               filename))))
 987
 988
 989 (defun package-get-installedp (package version)
 990   "Determine if PACKAGE with VERSION has already been installed.
 991 I'm not sure if I want to do this by searching directories or checking
 992 some built in variables.  For now, use packages-package-list."
 993   ;; Use packages-package-list which contains name and version
 994   (equal (plist-get
 995           (package-get-info-find-package packages-package-list
 996                                          package) ':version)
 997          (if (floatp version) version (string-to-number version))))
 998
 999 ;;;###autoload
1000 (defun package-get-package-provider (sym &optional force-current)
1001   "Search for a package that provides SYM and return the name and
1002   version.  Searches in `package-get-base' for SYM.   If SYM is a
1003   consp, then it must match a corresponding (provide (SYM VERSION)) from
1004   the package.
1005
1006 If FORCE-CURRENT is non-nil make sure the database is up to date. This might
1007 lead to Emacs accessing remote sites."
1008   (interactive "SSymbol: ")
1009   (package-get-require-base force-current)
1010   (let ((packages package-get-base)
1011         (done nil)
1012         (found nil))
1013     (while (and (not done) packages)
1014       (let* ((this-name (caar packages))
1015              (this-package (cdr (car packages)))) ;strip off package name
1016         (while (and (not done) this-package)
1017           (if (or (eq this-name sym)
1018                   (eq (cons this-name
1019                           (package-get-info-prop (car this-package) 'version))
1020                       sym)
1021                   (member sym
1022                         (package-get-info-prop (car this-package) 'provides)))
1023               (progn (setq done t)
1024                      (setq found
1025                        (list (caar packages)
1026                          (package-get-info-prop (car this-package) 'version))))
1027             (setq this-package (cdr this-package)))))
1028       (setq packages (cdr packages)))
1029     (when (interactive-p)
1030       (if found
1031           (message "%S" found)
1032         (message "No appropriate package found")))
1033     found))
1034
1035 ;;
1036 ;; customize interfaces.
1037 ;; The group is in this file so that custom loads includes this file.
1038 ;;
1039 (defgroup packages nil
1040   "Configure XEmacs packages."
1041   :group 'emacs)
1042
1043 ;;;###autoload
1044 (defun package-get-custom ()
1045   "Fetch and install the latest versions of all customized packages."
1046   (interactive)
1047   (package-get-require-base t)
1048   (mapcar (lambda (pkg)
1049             (if (eval (intern (concat (symbol-name (car pkg)) "-package")))
1050                 (package-get (car pkg) nil))
1051             t)
1052           package-get-base))
1053
1054 (defun package-get-ever-installed-p (pkg &optional notused)
1055   (string-match "-package$" (symbol-name pkg))
1056   (custom-initialize-set
1057    pkg
1058    (if (package-get-info-find-package
1059         packages-package-list
1060         (intern (substring (symbol-name pkg) 0 (match-beginning 0))))
1061        t)))
1062
1063 (defvar package-get-custom-groups nil
1064   "List of package-get-custom groups")
1065
1066 (defun package-get-custom-add-entry (package props)
1067   (let* ((category (plist-get props 'category))
1068          (group (intern (concat category "-packages")))
1069          (custom-var (intern (concat (symbol-name package) "-package")))
1070          (description (plist-get props 'description)))
1071     (when (not (memq group package-get-custom-groups))
1072       (setq package-get-custom-groups (cons group
1073                                             package-get-custom-groups))
1074       (eval `(defgroup ,group nil
1075                ,(concat category " package group")
1076                :group 'packages)))
1077     (eval `(defcustom ,custom-var nil
1078              ,description
1079              :group ',group
1080              :initialize 'package-get-ever-installed-p
1081              :type 'boolean))))
1082
1083
1084 (provide 'package-get)
1085 ;;; package-get.el ends here