1 ;;; package-get.el --- Retrieve XEmacs package
3 ;; Copyright (C) 1998 by Pete Ware
5 ;; Author: Pete Ware <ware@cis.ohio-state.edu>
6 ;; Heavy-Modifications: Greg Klanderman <greg@alphatech.com>
7 ;; Jan Vroonhof <vroonhof@math.ethz.ch>
10 ;; This file is part of XEmacs.
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)
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.
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
27 ;;; Synched up with: Not in FSF
32 ;; Retrieve a package and any other required packages from an archive
35 ;; Note (JV): Most of this no longer aplies!
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
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
62 ;; gnus - a mail and news reader
65 ;; [] Required by other [packages]
71 ;; [] Required by other [packages]
73 ;; Where `[]' indicates a toggle box
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.
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.
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
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
104 (require 'package-admin)
105 ;; (require 'package-get-base)
107 (defgroup package-tools nil
108 "Tools to manipulate packages."
111 (defgroup package-get nil
112 "Automatic Package Fetcher and Installer."
113 :prefix "package-get"
114 :group 'package-tools)
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:
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
133 More fields may be added as needed. An example:
137 (version \"<version 2>\"
139 description \"what this package is about.\"
146 (version \"<version 1>\"
148 description \"what this package is about.\"
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.")
163 (defcustom package-get-dir (temp-directory)
164 "*Where to store temporary files for staging."
165 :tag "Temporary directory"
169 (define-widget 'host-name 'string
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) ))
184 (defcustom package-get-download-sites
187 ("xemacs.org" "ftp.xemacs.org" "pub/xemacs/packages")
188 ("cso.uiuc.edu" "ftp.cso.uiuc.edu" "pub/packages/xemacs/packages")
191 ("unicamp.br" "ftp.unicamp.br" "pub/xemacs/packages")
194 ("sunsite.cnlab-switch.ch" "sunsite.cnlab-switch.ch" "mirror/xemacs/packages")
195 ("tu-darmstadt.de" "ftp.tu-darmstadt.de" "pub/editors/xemacs/packages")
196 ("sunsite.auc.dk" "sunsite.auc.dk" "pub/emacs/xemacs/packages")
197 ("pasteur.fr" "ftp.pasteur.fr" "pub/computing/xemacs/packages")
198 ("cenatls.cena.dgac.fr" "ftp.cenatls.cena.dgac.fr" "pub/Emacs/xemacs/packages")
199 ("kfki.hu" "ftp.kfki.hu" "pub/packages/xemacs/packages")
200 ("uniroma2.it" "ftp.uniroma2.it" "unix/misc/dist/XEMACS/packages")
201 ("icm.edu.pl" "ftp.icm.edu.pl" "pub/unix/editors/xemacs/packages")
202 ("sunet.se" "ftp.sunet.se" "pub/gnu/xemacs/packages")
203 ("doc.ic.ac.uk" "sunsite.doc.ic.ac.uk" "packages/xemacs/packages")
204 ("srcc.msu.su" "ftp1.srcc.msu.su" "mirror/ftp.xemacs.org/packages")
207 ("usyd.edu.au" "ftp.usyd.edu.au" "pub/Xemacs/packages")
208 ("netlab.is.tsukuba.ac.jp" "ftp.netlab.is.tsukuba.ac.jp" "pub/GNU/xemacs/packages")
209 ("jaist.ac.jp" "ftp.jaist.ac.jp" "pub/GNU/xemacs/packages")
210 ("ring.aist.go.jp" "ring.aist.go.jp" "pub/text/xemacs/packages")
211 ("ring.asahi-net.or.jp" "ring.asahi-net.or.jp" "pub/text/xemacs/packages")
212 ("SunSITE.sut.ac.jp" "SunSITE.sut.ac.jp" "pub/archives/packages/xemacs/packages")
213 ("dti.ad.jp" "ftp.dti.ad.jp" "pub/unix/editor/xemacs/packages")
214 ("kreonet.re.kr" "ftp.kreonet.re.kr" "pub/tools/emacs/xemacs/packages")
216 "*List of remote sites available for downloading packages.
217 List format is '(site-description site-name directory-on-site).
218 SITE-DESCRIPTION is a textual description of the site. SITE-NAME
219 is the internet address of the download site. DIRECTORY-ON-SITE
220 is the directory on the site in which packages may be found.
221 This variable is used to initialize `package-get-remote', the
222 variable actually used to specify package download sites."
223 :tag "Package download sites"
224 :type '(repeat (list hostname directory))
227 (defcustom package-get-remove-copy t
228 "*After copying and installing a package, if this is t, then remove the
229 copy. Otherwise, keep it around."
233 ;; #### it may make sense for this to be a list of names.
234 ;; #### also, should we rename "*base*" to "*index*" or "*db*"?
235 ;; "base" is a pretty poor name.
236 (defcustom package-get-base-filename "package-index.LATEST.pgp"
237 "*Name of the default package-get database file.
238 This may either be a relative path, in which case it is interpreted
239 with respect to `package-get-remote', or an absolute path."
243 (defvar package-get-user-index-filename
244 (paths-construct-path (list user-init-directory package-get-base-filename))
245 "Name for the user-specific location of the package-get database file.")
247 (defcustom package-get-always-update nil
248 "*If Non-nil always make sure we are using the latest package index (base).
249 Otherwise respect the `force-current' argument of `package-get-require-base'."
253 (defcustom package-get-require-signed-base-updates t
254 "*If set to a non-nil value, require explicit user confirmation for updates
255 to the package-get database which cannot have their signature verified via PGP.
256 When nil, updates which are not PGP signed are allowed without confirmation."
260 (defvar package-get-was-current nil
261 "Non-nil we did our best to fetch a current database.")
264 ;Shouldn't this be in package-ui?
266 (defun package-get-download-menu ()
267 "Build the `Add Download Site' menu."
268 (mapcar (lambda (site)
270 `(if (member (quote ,(cdr site))
272 (setq package-get-remote
273 (delete (quote ,(cdr site)) package-get-remote))
274 (package-ui-add-site (quote ,(cdr site))))
276 :selected `(member (quote ,(cdr site))
277 package-get-remote)))
278 package-get-download-sites))
281 (defun package-get-require-base (&optional force-current)
282 "Require that a package-get database has been loaded.
283 If the optional FORCE-CURRENT argument or the value of
284 `package-get-always-update' is Non-nil, try to update the database
285 from a location in `package-get-remote'. Otherwise a local copy is used
286 if available and remote access is never done.
288 Please use FORCE-CURRENT only when the user is explictly dealing with packages
289 and remote access is likely in the near future."
290 (setq force-current (or force-current package-get-always-update))
291 (unless (and (boundp 'package-get-base)
293 (or (not force-current) package-get-was-current))
294 (package-get-update-base nil force-current))
295 (if (or (not (boundp 'package-get-base))
296 (not package-get-base))
297 (error "Package-get database not loaded")
298 (setq package-get-was-current force-current)))
300 (defconst package-get-pgp-signed-begin-line "^-----BEGIN PGP SIGNED MESSAGE-----"
301 "Text for start of PGP signed messages.")
302 (defconst package-get-pgp-signature-begin-line "^-----BEGIN PGP SIGNATURE-----"
303 "Text for beginning of PGP signature.")
304 (defconst package-get-pgp-signature-end-line "^-----END PGP SIGNATURE-----"
305 "Text for end of PGP signature.")
308 (defun package-get-update-base-entry (entry)
309 "Update an entry in `package-get-base'."
310 (let ((existing (assq (car entry) package-get-base)))
312 (setcdr existing (cdr entry))
313 (setq package-get-base (cons entry package-get-base))
314 (package-get-custom-add-entry (car entry) (car (cdr entry))))))
316 (defun package-get-locate-file (file &optional nil-if-not-found no-remote)
317 "Locate an existing FILE with respect to `package-get-remote'.
318 If FILE is an absolute path or is not found, simply return FILE.
319 If optional argument NIL-IF-NOT-FOUND is non-nil, return nil
320 if FILE can not be located.
321 If NO-REMOTE is non-nil never search remote locations."
322 (if (file-name-absolute-p file)
324 (let ((entries package-get-remote)
327 (unless (and no-remote (caar entries))
328 (let ((expn (package-get-remote-filename (car entries) file)))
329 (if (and expn (file-exists-p expn))
332 (setq entries (cdr entries)))
334 (and (not nil-if-not-found)
337 (defun package-get-locate-index-file (no-remote)
338 "Locate the package-get index file. Do not return remote paths if NO-REMOTE
340 (or (package-get-locate-file package-get-base-filename t no-remote)
341 (if (file-exists-p package-get-user-index-filename)
342 package-get-user-index-filename)))
344 (defun package-get-maybe-save-index (filename)
345 "Offer to save the current buffer as the local package index file,
347 (let ((location (package-get-locate-index-file t)))
348 (unless (and filename (equal filename location))
349 (unless (and location
350 (equal (md5 (current-buffer))
352 (insert-file-contents-literally location)
353 (md5 (current-buffer)))))
354 (unless (and location (file-writable-p location))
355 (setq location package-get-user-index-filename))
356 (when (y-or-n-p (concat "Update package index in" location "? "))
357 (write-file location))))))
361 (defun package-get-update-base (&optional db-file force-current)
362 "Update the package-get database file with entries from DB-FILE.
363 Unless FORCE-CURRENT is non-nil never try to update the database."
365 (let ((dflt (package-get-locate-index-file nil)))
366 (list (read-file-name "Load package-get database: "
367 (file-name-directory dflt)
370 (file-name-nondirectory dflt)))))
371 (setq db-file (expand-file-name (or db-file
372 (package-get-locate-index-file
373 (not force-current)))))
374 (if (not (file-exists-p db-file))
375 (error "Package-get database file `%s' does not exist" db-file))
376 (if (not (file-readable-p db-file))
377 (error "Package-get database file `%s' not readable" db-file))
378 (let ((buf (get-buffer-create "*package database*")))
383 (insert-file-contents-internal db-file)
384 (package-get-update-base-from-buffer buf)
385 (if (file-remote-p db-file)
386 (package-get-maybe-save-index db-file)))
390 (defun package-get-update-base-from-buffer (&optional buf)
391 "Update the package-get database with entries from BUFFER.
392 BUFFER defaults to the current buffer. This command can be
393 used interactively, for example from a mail or news buffer."
395 (setq buf (or buf (current-buffer)))
396 (let (content-beg content-end beg end)
399 (goto-char (point-min))
400 (setq content-beg (point))
401 (setq content-end (save-excursion (goto-char (point-max)) (point)))
402 (when (re-search-forward package-get-pgp-signed-begin-line nil t)
403 (setq beg (match-beginning 0))
404 (setq content-beg (match-end 0)))
405 (when (re-search-forward package-get-pgp-signature-begin-line nil t)
406 (setq content-end (match-beginning 0)))
407 (when (re-search-forward package-get-pgp-signature-end-line nil t)
409 (if (not (and content-beg content-end beg end))
410 (or (not package-get-require-signed-base-updates)
411 (yes-or-no-p "Package-get entries not PGP signed, continue? ")
412 (error "Package-get database not updated")))
413 (if (and content-beg content-end beg end)
414 (if (not (condition-case nil
415 (or (fboundp 'mc-pgp-verify-region)
416 (load-library "mc-pgp")
417 (fboundp 'mc-pgp-verify-region))
419 (or (not package-get-require-signed-base-updates)
421 "No mailcrypt; can't verify package-get DB signature, continue? ")
422 (error "Package-get database not updated"))))
424 (fboundp 'mc-pgp-verify-region)
427 (mc-pgp-verify-region beg end)
429 (and (string-match "No such file" (nth 2 err))
430 (or (not package-get-require-signed-base-updates)
432 (concat "Can't find PGP, continue without "
433 "package-get DB verification? ")))))
435 (error "Package-get PGP signature failed to verify"))
436 ;; ToDo: We shoud call package-get-maybe-save-index on the region
437 (package-get-update-base-entries content-beg content-end)
438 (message "Updated package-get database"))))
440 (defun package-get-update-base-entries (beg end)
441 "Update the package-get database with the entries found between
442 BEG and END in the current buffer."
445 (if (not (re-search-forward "^(package-get-update-base-entry" nil t))
446 (error "Buffer does not contain package-get database entries"))
449 (while (and (< (point) end)
450 (re-search-forward "^(package-get-update-base-entry" nil t))
452 (let ((entry (read (current-buffer))))
453 (if (or (not (consp entry))
454 (not (eq (car entry) 'package-get-update-base-entry)))
455 (error "Invalid package-get database entry found"))
456 (package-get-update-base-entry
457 (car (cdr (car (cdr entry)))))
458 (setq count (1+ count))))
459 (message "Got %d package-get database entries" count))))
462 (defun package-get-save-base (file)
463 "Write the package-get database to FILE.
465 Note: This database will be unsigned of course."
466 (interactive "FSave package-get database to: ")
467 (package-get-require-base t)
468 (let ((buf (get-buffer-create "*package database*")))
473 (goto-char (point-min))
474 (let ((entries package-get-base) entry plist)
475 (insert ";; Package Index file -- Do not edit manually.\n")
478 (setq entry (car entries))
479 (setq plist (car (cdr entry)))
480 (insert "(package-get-update-base-entry (quote\n")
481 (insert (format "(%s\n" (symbol-name (car entry))))
483 (insert (format " %s%s %S\n"
484 (if (eq plist (car (cdr entry))) "(" " ")
485 (symbol-name (car plist))
487 (setq plist (cdr (cdr plist))))
488 (insert "))\n))\n;;;@@@\n")
489 (setq entries (cdr entries))))
490 (insert ";; Package Index file ends here\n")
491 (write-region (point-min) (point-max) file))
494 (defun package-get-interactive-package-query (get-version package-symbol)
495 "Perform interactive querying for package and optional version.
496 Query for a version if GET-VERSION is non-nil. Return package name as
497 a symbol instead of a string if PACKAGE-SYMBOL is non-nil.
498 The return value is suitable for direct passing to `interactive'."
499 (package-get-require-base t)
500 (let ( (table (mapcar '(lambda (item)
501 (let ( (name (symbol-name (car item))) )
505 package package-symbol default-version version)
506 (save-window-excursion
507 (setq package (completing-read "Package: " table nil t))
508 (setq package-symbol (intern package))
511 (setq default-version
512 (package-get-info-prop
513 (package-get-info-version
514 (package-get-info-find-package package-get-base
518 (setq version (read-string "Version: " default-version))
522 (list package-symbol version)
523 (list package version))
526 (list package-symbol)
531 (defun package-get-delete-package (package &optional pkg-topdir)
532 "Delete an installation of PACKAGE below directory PKG-TOPDIR.
533 PACKAGE is a symbol, not a string.
534 This is just an interactive wrapper for `package-admin-delete-binary-package'."
535 (interactive (package-get-interactive-package-query nil t))
536 (package-admin-delete-binary-package package pkg-topdir))
539 (defun package-get-update-all ()
540 "Fetch and install the latest versions of all currently installed packages."
542 (package-get-require-base t)
545 (mapcar (lambda (pkg)
546 (if (not (package-get (car pkg) nil 'never))
547 (throw 'exit nil) ;; Bail out if error detected
549 packages-package-list)))
552 (defun package-get-all (package version &optional fetched-packages install-dir)
553 "Fetch PACKAGE with VERSION and all other required packages.
554 Uses `package-get-base' to determine just what is required and what
555 package provides that functionality. If VERSION is nil, retrieves
556 latest version. Optional argument FETCHED-PACKAGES is used to keep
557 track of packages already fetched. Optional argument INSTALL-DIR,
558 if non-nil, specifies the package directory where fetched packages
561 Returns nil upon error."
562 (interactive (package-get-interactive-package-query t nil))
563 (let* ((the-package (package-get-info-find-package package-get-base
565 (this-package (package-get-info-version
566 the-package version))
567 (this-requires (package-get-info-prop this-package 'requires))
570 (setq version (package-get-info-prop this-package 'version))
571 (unless (package-get-installedp package version)
572 (if (not (package-get package version nil install-dir))
574 (setq fetched-packages nil)
576 (setq fetched-packages
577 (append (list package)
578 (package-get-info-prop this-package 'provides)
580 ;; grab everything that this package requires plus recursively
581 ;; grab everything that the requires require. Keep track
582 ;; in `fetched-packages' the list of things provided -- this
583 ;; keeps us from going into a loop
585 (if (not (member (car this-requires) fetched-packages))
586 (let* ((reqd-package (package-get-package-provider
587 (car this-requires) t))
588 (reqd-version (cadr reqd-package))
589 (reqd-name (car reqd-package)))
591 (error "Unable to find a provider for %s"
592 (car this-requires)))
593 (if (not (setq fetched-packages
594 (package-get-all reqd-name reqd-version
599 (setq this-requires (cdr this-requires)))
605 (defun package-get-dependencies (packages)
606 "Compute dependencies for PACKAGES.
607 Uses `package-get-base' to determine just what is required and what
608 package provides that functionality. Returns the list of packages
609 required by PACKAGES."
610 (package-get-require-base t)
611 (let ((orig-packages packages)
612 dependencies provided)
614 (let* ((package (car packages))
615 (the-package (package-get-info-find-package
616 package-get-base package))
617 (this-package (package-get-info-version
619 (this-requires (package-get-info-prop this-package 'requires))
620 (new-depends (set-difference
623 (let* ((reqd-package (package-get-package-provider reqd))
624 (reqd-version (cadr reqd-package))
625 (reqd-name (car reqd-package)))
627 (error "Unable to find a provider for %s" reqd))
631 (this-provides (package-get-info-prop this-package 'provides)))
633 (union dependencies new-depends))
635 (union provided (union (list package) this-provides)))
637 (union new-depends (cdr packages)))))
638 (set-difference dependencies orig-packages)))
640 (defun package-get-load-package-file (lispdir file)
642 (setq pathname (expand-file-name file lispdir))
648 (message "Error loading package file \"%s\" %s!" pathname err)
652 (defun package-get-init-package (lispdir)
653 "Initialize the package.
654 This really assumes that the package has never been loaded. Updating
655 a newer package can cause problems, due to old, obsolete functions in
658 Return `t' upon complete success, `nil' if any errors occurred."
661 (file-accessible-directory-p lispdir))
663 ;; Add lispdir to load-path if it doesn't already exist.
664 ;; NOTE: this does not take symlinks, etc., into account.
665 (if (let ( (dirs load-path) )
668 (if (string-equal (car dirs) lispdir)
670 (setq dirs (cdr dirs))
673 (setq load-path (cons lispdir load-path)))
674 (if (not (package-get-load-package-file lispdir "auto-autoloads"))
675 (package-get-load-package-file lispdir "_pkg"))
681 (defun package-get (package &optional version conflict install-dir)
682 "Fetch PACKAGE from remote site.
683 Optional arguments VERSION indicates which version to retrieve, nil
684 means most recent version. CONFLICT indicates what happens if the
685 package is already installed. Valid values for CONFLICT are:
686 'always always retrieve the package even if it is already installed
687 'never do not retrieve the package if it is installed.
688 INSTALL-DIR, if non-nil, specifies the package directory where
689 fetched packages should be installed.
691 The value of `package-get-base' is used to determine what files should
692 be retrieved. The value of `package-get-remote' is used to determine
693 where a package should be retrieved from. The sites are tried in
694 order so one is better off listing easily reached sites first.
696 Once the package is retrieved, its md5 checksum is computed. If that
697 sum does not match that stored in `package-get-base' for this version
698 of the package, an error is signalled.
700 Returns `t' upon success, the symbol `error' if the package was
701 successfully installed but errors occurred during initialization, or
703 (interactive (package-get-interactive-package-query nil t))
706 (package-get-info-version
707 (package-get-info-find-package package-get-base
709 (latest (package-get-info-prop this-package 'version))
710 (installed (package-get-key package :version))
711 (this-requires (package-get-info-prop this-package 'requires))
713 (search-dirs package-get-remote)
714 (base-filename (package-get-info-prop this-package 'filename))
716 filenames full-package-filename)
717 (if (null this-package)
718 (if package-get-remote
719 (error "Couldn't find package %s with version %s"
721 (error "No download sites or local package locations specified.")))
722 (if (null base-filename)
723 (error "No filename associated with package %s, version %s"
726 (package-admin-get-install-dir package install-dir
727 (or (eq package 'mule-base) (memq 'mule-base this-requires))))
729 ;; If they asked for the latest using version=nil, don't get an older
730 ;; version than we already have.
732 (if (> (if (stringp installed)
733 (string-to-number installed)
736 (string-to-number latest)
738 (if (not (null version))
739 (warn "Installing %s package version %s, you had a newer version %s"
740 package latest installed)
741 (warn "Skipping %s package, you have a newer version %s"
743 (throw 'skip-update t))))
745 ;; Contrive a list of possible package filenames.
746 ;; Ugly. Is there a better way to do this?
747 (setq filenames (cons base-filename nil))
748 (if (string-match "^\\(..*\\)\.tar\.gz$" base-filename)
749 (setq filenames (append filenames
750 (list (concat (match-string 1 base-filename)
753 (setq version latest)
754 (unless (and (eq conflict 'never)
755 (package-get-installedp package version))
756 ;; Find the package from the search list in package-get-remote
757 ;; and copy it into the staging directory. Then validate
758 ;; the checksum. Finally, install the package.
760 (let (search-filenames current-dir-entry host dir current-filename
762 ;; In each search directory ...
764 (setq current-dir-entry (car search-dirs)
765 host (car current-dir-entry)
766 dir (car (cdr current-dir-entry))
767 search-filenames filenames
770 ;; Look for one of the possible package filenames ...
771 (while search-filenames
772 (setq current-filename (car search-filenames)
773 dest-filename (package-get-staging-dir current-filename))
775 ;; No host means look on the current system.
777 (setq full-package-filename
778 (substitute-in-file-name
779 (expand-file-name current-filename
780 (file-name-as-directory dir))))
783 ;; If it's already on the disk locally, and the size is
784 ;; greater than zero ...
785 ( (and (file-exists-p dest-filename)
787 ;; file-attributes could return -1 for LARGE files,
788 ;; but, hopefully, packages won't be that large.
789 (and (setq attrs (file-attributes dest-filename))
790 (> (nth 7 attrs) 0))))
791 (setq full-package-filename dest-filename)
794 ;; If the file exists on the remote system ...
795 ( (file-exists-p (package-get-remote-filename
796 current-dir-entry current-filename))
798 (setq full-package-filename dest-filename)
799 (message "Retrieving package `%s' ..."
802 (copy-file (package-get-remote-filename current-dir-entry
804 full-package-filename t)
808 ;; If we found it, we're done.
809 (if (and full-package-filename
810 (file-exists-p full-package-filename))
812 ;; Didn't find it. Try the next possible filename.
813 (setq search-filenames (cdr search-filenames))
815 ;; Try looking in the next possible directory ...
816 (setq search-dirs (cdr search-dirs))
820 (if (or (not full-package-filename)
821 (not (file-exists-p full-package-filename)))
822 (if package-get-remote
823 (error "Unable to find file %s" base-filename)
825 "No download sites or local package locations specified.")))
826 ;; Validate the md5 checksum
827 ;; Doing it with XEmacs removes the need for an external md5 program
828 (message "Validating checksum for `%s'..." package) (sit-for 0)
830 ;; What ever happened to i-f-c-literally
831 (let (file-name-handler-alist)
832 (insert-file-contents-internal full-package-filename))
833 (if (not (string= (md5 (current-buffer))
834 (package-get-info-prop this-package
836 (error "Package %s does not match md5 checksum" base-filename)))
838 (package-admin-delete-binary-package package install-dir)
840 (message "Installing package `%s' ..." package) (sit-for 0)
842 (package-admin-add-binary-package full-package-filename
846 ;; clear messages so that only messages from
847 ;; package-get-init-package are seen, below.
849 (if (package-get-init-package (package-admin-get-lispdir
850 install-dir package))
852 (message "Added package `%s'" package)
856 ;; display message only if there isn't already one.
857 (if (not (current-message))
859 (message "Added package `%s' (errors occurred)"
864 (setq package-status 'errors))
867 (message "Installation of package %s failed." base-filename)
869 (switch-to-buffer package-admin-temp-buffer)
870 (setq package-status nil)
873 (if (and found package-get-remove-copy)
874 (delete-file full-package-filename))
878 (defun package-get-info-find-package (which name)
879 "Look in WHICH for the package called NAME and return all the info
880 associated with it. See `package-get-base' for info on the format
883 To access fields returned from this, use
884 `package-get-info-version' to return information about particular a
885 version. Use `package-get-info-find-prop' to find particular property
886 from a version returned by `package-get-info-version'."
887 (interactive "xPackage list: \nsPackage Name: ")
889 (if (eq (caar which) name)
892 (package-get-info-find-package (cdr which) name)))))
894 (defun package-get-info-version (package version)
895 "In PACKAGE, return the plist associated with a particular VERSION of the
896 package. PACKAGE is typically as returned by
897 `package-get-info-find-package'. If VERSION is nil, then return the
898 first (aka most recent) version. Use `package-get-info-find-prop'
899 to retrieve a particular property from the value returned by this."
900 (interactive (package-get-interactive-package-query t t))
901 (while (and version package (not (string= (plist-get (car package) 'version) version)))
902 (setq package (cdr package)))
903 (if package (car package)))
905 (defun package-get-info-prop (package-version property)
906 "In PACKAGE-VERSION, return the value associated with PROPERTY.
907 PACKAGE-VERSION is typically returned by `package-get-info-version'
908 and PROPERTY is typically (although not limited to) one of the
911 version - version of this package
912 provides - list of symbols provided
913 requires - list of symbols that are required.
914 These in turn are provided by other packages.
915 size - size of the bundled package
916 md5sum - computed md5 checksum"
917 (interactive "xPackage Version: \nSProperty")
918 (plist-get package-version property))
920 (defun package-get-info-version-prop (package-list package version property)
921 "In PACKAGE-LIST, search for PACKAGE with this VERSION and return
923 (package-get-info-prop
924 (package-get-info-version
925 (package-get-info-find-package package-list package) version) property))
927 (defun package-get-set-version-prop (package-list package version
929 "A utility to make it easier to add a VALUE for a specific PROPERTY
930 in this VERSION of a specific PACKAGE kept in the PACKAGE-LIST.
931 Returns the modified PACKAGE-LIST. Any missing fields are created."
934 (defun package-get-staging-dir (filename)
935 "Return a good place to stash FILENAME when it is retrieved.
936 Use `package-get-dir' for directory to store stuff.
937 Creates `package-get-dir' it it doesn't exist."
938 (interactive "FPackage filename: ")
939 (if (not (file-exists-p package-get-dir))
940 (make-directory package-get-dir))
942 (file-name-nondirectory (or (and (fboundp 'efs-ftp-path)
943 (nth 2 (efs-ftp-path filename)))
945 (file-name-as-directory package-get-dir)))
947 (defun package-get-remote-filename (search filename)
948 "Return FILENAME as a remote filename.
949 It first checks if FILENAME already is a remote filename. If it is
950 not, then it uses the (car search) as the remote site-name and the (cadr
951 search) as the remote-directory and concatenates filename. In other
953 site-name:remote-directory/filename.
955 If (car search) is nil, (cadr search is interpreted as a local directory).
957 (if (file-remote-p filename)
959 (let ((dir (cadr search)))
960 (concat (when (car search)
962 (if (string-match "@" (car search))
966 (if (string-match "/$" dir)
972 (defun package-get-installedp (package version)
973 "Determine if PACKAGE with VERSION has already been installed.
974 I'm not sure if I want to do this by searching directories or checking
975 some built in variables. For now, use packages-package-list."
976 ;; Use packages-package-list which contains name and version
978 (package-get-info-find-package packages-package-list
980 (if (floatp version) version (string-to-number version))))
983 (defun package-get-package-provider (sym &optional force-current)
984 "Search for a package that provides SYM and return the name and
985 version. Searches in `package-get-base' for SYM. If SYM is a
986 consp, then it must match a corresponding (provide (SYM VERSION)) from
989 If FORCE-CURRENT is non-nil make sure the database is up to date. This might
990 lead to Emacs accessing remote sites."
991 (interactive "SSymbol: ")
992 (package-get-require-base force-current)
993 (let ((packages package-get-base)
996 (while (and (not done) packages)
997 (let* ((this-name (caar packages))
998 (this-package (cdr (car packages)))) ;strip off package name
999 (while (and (not done) this-package)
1000 (if (or (eq this-name sym)
1002 (package-get-info-prop (car this-package) 'version))
1005 (package-get-info-prop (car this-package) 'provides)))
1006 (progn (setq done t)
1008 (list (caar packages)
1009 (package-get-info-prop (car this-package) 'version))))
1010 (setq this-package (cdr this-package)))))
1011 (setq packages (cdr packages)))
1012 (when (interactive-p)
1014 (message "%S" found)
1015 (message "No appropriate package found")))
1019 ;; customize interfaces.
1020 ;; The group is in this file so that custom loads includes this file.
1022 (defgroup packages nil
1023 "Configure XEmacs packages."
1027 (defun package-get-custom ()
1028 "Fetch and install the latest versions of all customized packages."
1030 (package-get-require-base t)
1031 (mapcar (lambda (pkg)
1032 (if (eval (intern (concat (symbol-name (car pkg)) "-package")))
1033 (package-get (car pkg) nil))
1037 (defun package-get-ever-installed-p (pkg &optional notused)
1038 (string-match "-package$" (symbol-name pkg))
1039 (custom-initialize-set
1041 (if (package-get-info-find-package
1042 packages-package-list
1043 (intern (substring (symbol-name pkg) 0 (match-beginning 0))))
1046 (defvar package-get-custom-groups nil
1047 "List of package-get-custom groups")
1049 (defun package-get-custom-add-entry (package props)
1050 (let* ((category (plist-get props 'category))
1051 (group (intern (concat category "-packages")))
1052 (custom-var (intern (concat (symbol-name package) "-package")))
1053 (description (plist-get props 'description)))
1054 (when (not (memq group package-get-custom-groups))
1055 (setq package-get-custom-groups (cons group
1056 package-get-custom-groups))
1057 (eval `(defgroup ,group nil
1058 ,(concat category " package group")
1060 (eval `(defcustom ,custom-var nil
1063 :initialize 'package-get-ever-installed-p
1067 (provide 'package-get)
1068 ;;; package-get.el ends here