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