|
235
|
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 ;; Keywords: internal
|
|
|
7
|
|
|
8 ;; This file is part of XEmacs.
|
|
|
9
|
|
|
10 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
11 ;; under the terms of the GNU General Public License as published by
|
|
|
12 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
13 ;; any later version.
|
|
|
14
|
|
|
15 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
18 ;; General Public License for more details.
|
|
|
19
|
|
|
20 ;; You should have received a copy of the GNU General Public License
|
|
|
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
|
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
23 ;; 02111-1307, USA.
|
|
|
24
|
|
|
25 ;;; Synched up with: Not in FSF
|
|
|
26
|
|
|
27 ;;; Commentary:
|
|
|
28
|
|
|
29 ;; package-get -
|
|
|
30 ;; Retrieve a package and any other required packages from an archive
|
|
|
31 ;;
|
|
|
32 ;; The idea:
|
|
|
33 ;; A new XEmacs lisp-only release is generated with the following steps:
|
|
|
34 ;; 1. The maintainer runs some yet to be written program that
|
|
|
35 ;; generates all the dependency information. This should
|
|
|
36 ;; determine all the require and provide statements and associate
|
|
|
37 ;; them with a package.
|
|
|
38 ;; 2. All the packages are then bundled into their own tar balls
|
|
|
39 ;; (or whatever format)
|
|
|
40 ;; 3. Maintainer automatically generates a new `package-get-base'
|
|
|
41 ;; data structure which contains information such as the
|
|
|
42 ;; package name, the file to be retrieved, an md5 checksum,
|
|
|
43 ;; etc (see `package-get-base').
|
|
|
44 ;; 4. The maintainer posts an announcement with the new version
|
|
|
45 ;; of `package-get-base'.
|
|
|
46 ;; 5. A user/system manager saves this posting and runs
|
|
|
47 ;; `package-get-update' which uses the previously saved list
|
|
|
48 ;; of packages, `package-get-here' that the user/site
|
|
|
49 ;; wants to determine what new versions to download and
|
|
|
50 ;; install.
|
|
|
51 ;;
|
|
|
52 ;; A user/site manager can generate a new `package-get-here' structure
|
|
|
53 ;; by using `package-get-setup' which generates a customize like
|
|
|
54 ;; interface to the list of packages. The buffer looks something
|
|
|
55 ;; like:
|
|
|
56 ;;
|
|
|
57 ;; gnus - a mail and news reader
|
|
|
58 ;; [] Always install
|
|
|
59 ;; [] Needs updating
|
|
|
60 ;; [] Required by other [packages]
|
|
|
61 ;; version: 2.0
|
|
|
62 ;;
|
|
|
63 ;; vm - a mail reader
|
|
|
64 ;; [] Always install
|
|
|
65 ;; [] Needs updating
|
|
|
66 ;; [] Required by other [packages]
|
|
|
67 ;;
|
|
|
68 ;; Where `[]' indicates a toggle box
|
|
|
69 ;;
|
|
|
70 ;; - Clicking on "Always install" puts this into
|
|
|
71 ;; `package-get-here' list. "Needs updating" indicates a new
|
|
|
72 ;; version is available. Anything already in
|
|
|
73 ;; `package-get-here' has this enabled.
|
|
|
74 ;; - "Required by other" means some other packages are going to force
|
|
|
75 ;; this to be installed. Clicking on [packages] gives a list
|
|
|
76 ;; of packages that require this.
|
|
|
77 ;;
|
|
|
78 ;; The `package-get-base' should be installed in a file in
|
|
|
79 ;; `data-directory'. The `package-get-here' should be installed in
|
|
|
80 ;; site-lisp. Both are then read at run time.
|
|
|
81 ;;
|
|
|
82 ;; TODO:
|
|
|
83 ;; - Implement `package-get-setup'
|
|
|
84 ;; - Actually put `package-get-base' and `package-get-here' into
|
|
|
85 ;; files that are read.
|
|
|
86 ;; - Allow users to have their own packages that they want installed
|
|
|
87 ;; in ~/.xemacs/.
|
|
|
88 ;; - SOMEONE needs to write the programs that generate the
|
|
|
89 ;; provides/requires database and makes it into a lisp data
|
|
|
90 ;; structure suitable for `package-get-base'
|
|
|
91 ;; - Handle errors such as no package providing a required symbol.
|
|
|
92 ;; - Tie this into the `require' function to download packages
|
|
|
93 ;; transparently.
|
|
|
94
|
|
|
95 ;;; Change Log
|
|
|
96
|
|
|
97 ;;; Code:
|
|
|
98
|
|
|
99 (provide 'package-get)
|
|
|
100 (require 'package-admin)
|
|
|
101
|
|
|
102 (defvar package-get-base nil
|
|
|
103 "List of packages that are installed at this site.
|
|
|
104 For each element in the alist, car is the package name and the cdr is
|
|
|
105 a plist containing information about the package. Typical fields
|
|
|
106 kept in the plist are:
|
|
|
107
|
|
|
108 version - version of this package
|
|
|
109 provides - list of symbols provided
|
|
|
110 requires - list of symbols that are required.
|
|
|
111 These in turn are provided by other packages.
|
|
|
112 filename - name of the file.
|
|
|
113 size - size of the file (aka the bundled package)
|
|
|
114 md5sum - computed md5 checksum
|
|
|
115 description - What this package is for.
|
|
|
116 type - Whether this is a 'binary (default) or 'single file package
|
|
|
117
|
|
|
118 More fields may be added as needed. An example:
|
|
|
119
|
|
|
120 '(
|
|
|
121 (name
|
|
|
122 (version \"<version 2>\"
|
|
|
123 file \"filename\"
|
|
|
124 description \"what this package is about.\"
|
|
|
125 provides (<list>)
|
|
|
126 requires (<list>)
|
|
|
127 size <integer-bytes>
|
|
|
128 md5sum \"<checksum\"
|
|
|
129 type single
|
|
|
130 )
|
|
|
131 (version \"<version 1>\"
|
|
|
132 file \"filename\"
|
|
|
133 description \"what this package is about.\"
|
|
|
134 provides (<list>)
|
|
|
135 requires (<list>)
|
|
|
136 size <integer-bytes>
|
|
|
137 md5sum \"<checksum\"
|
|
|
138 type single
|
|
|
139 )
|
|
|
140 ...
|
|
|
141 ))
|
|
|
142
|
|
|
143 For version information, it is assumed things are listed in most
|
|
|
144 recent to least recent -- in other words, the version names don't have to
|
|
|
145 be lexically ordered. It is debatable if it makes sense to have more than
|
|
|
146 one version of a package available.")
|
|
|
147
|
|
|
148 (defvar package-get-dir "/tmp"
|
|
|
149 "*Where to store temporary files for staging.")
|
|
|
150
|
|
|
151 (defvar package-get-remote
|
|
|
152 '(
|
|
|
153 ("ftp.xemacs.org" "/pub/xemacs/beta/xemacs-20.5/packages/binary-packages")
|
|
|
154 ("ftp.xemacs.org" "/pub/xemacs/beta/xemacs-20.5/packages/single-file-packages")
|
|
|
155 ("ftp.xemacs.org" "/pub/xemacs/package"))
|
|
|
156 "*List of remote sites to contact for downloading packages.
|
|
|
157 List format is '(site-name directory-on-site). Each site is tried in
|
|
|
158 order until the package is found.")
|
|
|
159
|
|
|
160 (defvar package-get-remove-copy nil
|
|
|
161 "*After copying and installing a package, if this is T, then remove the
|
|
|
162 copy. Otherwise, keep it around.")
|
|
|
163
|
|
|
164 (defun package-get-all (package version &optional fetched-packages)
|
|
|
165 "Fetch PACKAGE with VERSION and all other required packages.
|
|
|
166 Uses `package-get-base' to determine just what is required and what
|
|
|
167 package provides that functionality. If VERSION is nil, retrieves
|
|
|
168 latest version. Optional argument FETCHED-PACKAGES is used to keep
|
|
|
169 track of packages already fetched."
|
|
|
170 (interactive "sPackage: sVersion: ")
|
|
|
171 (let* ((this-package (package-get-info-version
|
|
|
172 (package-get-info-find-package package-get-base
|
|
|
173 package) version))
|
|
|
174 (this-requires (package-get-info-prop this-package 'requires))
|
|
|
175 )
|
|
|
176 (unless (package-get-installedp package version)
|
|
|
177 (package-get package version))
|
|
|
178 (setq fetched-packages
|
|
|
179 (append (package-get-info-prop this-package 'provides)
|
|
|
180 fetched-packages))
|
|
|
181 ;; grab everything that this package requires plus recursively
|
|
|
182 ;; grab everything that the requires require. Keep track
|
|
|
183 ;; in `fetched-packages' the list of things provided -- this
|
|
|
184 ;; keeps us from going into a loop
|
|
|
185 (while this-requires
|
|
|
186 (if (not (member (car this-requires) fetched-packages))
|
|
|
187 (let* ((reqd-package (package-get-package-provider
|
|
|
188 (car this-requires)))
|
|
|
189 (reqd-version (cadr reqd-package))
|
|
|
190 (reqd-name (car reqd-package)))
|
|
|
191 (setq fetched-packages
|
|
|
192 (package-get-all reqd-name reqd-version fetched-packages)))
|
|
|
193 )
|
|
|
194 (setq this-requires (cdr this-requires)))
|
|
|
195 fetched-packages
|
|
|
196 ))
|
|
|
197
|
|
|
198 (defun package-get (package &optional version conflict)
|
|
|
199 "Fetch PACKAGE from remote site.
|
|
|
200 Optional arguments VERSION indicates which version to retrieve, nil
|
|
|
201 means most recent version. CONFLICT indicates what happens if the
|
|
|
202 package is already installed. Valid values for CONFLICT are:
|
|
|
203 'always always retrieve the package even if it is already installed
|
|
|
204 'never do not retrieve the package if it is installed.
|
|
|
205
|
|
|
206 The value of `package-get-base' is used to determine what files should
|
|
|
207 be retrieved. The value of `package-get-remote' is used to determine
|
|
|
208 where a package should be retrieved from. The sites are tried in
|
|
|
209 order so one is better off listing easily reached sites first.
|
|
|
210
|
|
|
211 Once the package is retrieved, its md5 checksum is computed. If that
|
|
|
212 sum does not match that stored in `package-get-base' for this version
|
|
|
213 of the package, an error is signalled."
|
|
|
214 (interactive "xPackage List: ")
|
|
|
215 (let* ((this-package
|
|
|
216 (package-get-info-version
|
|
|
217 (package-get-info-find-package package-get-base
|
|
|
218 package) version))
|
|
|
219 (found nil)
|
|
|
220 (search-dirs package-get-remote)
|
|
|
221 (filename (package-get-info-prop this-package 'filename)))
|
|
|
222 (if (null this-package)
|
|
|
223 (error "Couldn't find package %s with version %s"
|
|
|
224 package version))
|
|
|
225 (if (null filename)
|
|
|
226 (error "No filename associated with package %s, version %s"
|
|
|
227 package version))
|
|
|
228
|
|
|
229 (unless (and (eq conflict 'never)
|
|
|
230 (package-get-installedp package version))
|
|
|
231 ;; Find the package from search list in package-get-remote
|
|
|
232 ;; and copy it into the staging directory. Then validate
|
|
|
233 ;; the checksum. Finally, install the package.
|
|
|
234 (while (and search-dirs
|
|
|
235 (not (file-exists-p (package-get-staging-dir filename))))
|
|
|
236 (if (file-exists-p (package-get-remote-filename
|
|
|
237 (car search-dirs) filename))
|
|
|
238 (copy-file (package-get-remote-filename (car search-dirs) filename)
|
|
|
239 (package-get-staging-dir filename))
|
|
|
240 (setq search-dirs (cdr search-dirs))
|
|
|
241 ))
|
|
|
242 (if (not (file-exists-p (package-get-staging-dir filename)))
|
|
|
243 (error "Unable to find file %s" filename))
|
|
|
244 ;;
|
|
|
245 ;; Validate the md5 checksum
|
|
|
246 ;; Unfortunately we cannot do this in XEmacs due to Mule lossage.
|
|
|
247 ;;
|
|
|
248 (with-temp-buffer
|
|
|
249 (call-process "md5sum" (package-get-staging-dir filename) t)
|
|
|
250 (goto-char (point-min))
|
|
|
251 (looking-at "[a-z0-9]+")
|
|
|
252 (if (not (string= (buffer-substring (match-beginning 0) (match-end 0))
|
|
|
253 (package-get-info-prop this-package 'md5sum)))
|
|
|
254 (error "Package %s does not match md5 checksum" filename)))
|
|
|
255 (message "Retrieved package %s" filename) (sit-for 1)
|
|
|
256 (let ((status
|
|
|
257 (if (eq (package-get-info-prop this-package 'type) 'single)
|
|
|
258 (package-admin-add-single-file-package
|
|
|
259 (package-get-staging-dir filename))
|
|
|
260 (package-admin-add-binary-package
|
|
|
261 (package-get-staging-dir filename)))))
|
|
|
262 (when (not (= status 0))
|
|
|
263 (message "Package failed.")
|
|
|
264 (select-buffer package-admin-temp-buffer)))
|
|
|
265 (sit-for 2)
|
|
|
266 (message "Added package") (sit-for 1)
|
|
|
267 (setq found t))
|
|
|
268 (if (and found package-get-remove-copy)
|
|
|
269 (delete-file (package-get-staging-dir filename)))
|
|
|
270 ))
|
|
|
271
|
|
|
272 (defun package-get-info-find-package (which name)
|
|
|
273 "Look in WHICH for the packaged called NAME and return all the info
|
|
|
274 associated with it. See `package-get-base' for info on the format
|
|
|
275 returned.
|
|
|
276
|
|
|
277 To access fields returned from this, use
|
|
|
278 `package-get-info-version' to return information about particular a
|
|
|
279 version. Use `package-get-info-find-prop' to find particular property
|
|
|
280 from a version returned by `package-get-info-version'."
|
|
|
281 (interactive "xPackage list: sPackage Name: ")
|
|
|
282 (if which
|
|
|
283 (if (eq (caar which) name)
|
|
|
284 (cdar which)
|
|
|
285 (if (cdr which)
|
|
|
286 (package-get-info-find-package (cdr which) name)))))
|
|
|
287
|
|
|
288 (defun package-get-info-version (package version)
|
|
|
289 "In PACKAGE, return the plist associated with a particular VERSION of the
|
|
|
290 package. PACKAGE is typically as returned by
|
|
|
291 `package-get-info-find-package'. If VERSION is nil, then return the
|
|
|
292 first (aka most recent) version. Use `package-get-info-find-prop'
|
|
|
293 to retrieve a particular property from the value returned by this."
|
|
|
294 (interactive "xPackage Info: \nsVersion: ")
|
|
|
295 (while (and version package (not (string= (plist-get (car package) 'version) version)))
|
|
|
296 (setq package (cdr package)))
|
|
|
297 (if package (car package)))
|
|
|
298
|
|
|
299 (defun package-get-info-prop (package-version property)
|
|
|
300 "In PACKAGE-VERSION, return the value associated with PROPERTY.
|
|
|
301 PACKAGE-VERSION is typically returned by `package-get-info-version'
|
|
|
302 and PROPERTY is typically (although not limited to) one of the
|
|
|
303 following:
|
|
|
304
|
|
|
305 version - version of this package
|
|
|
306 provides - list of symbols provided
|
|
|
307 requires - list of symbols that are required.
|
|
|
308 These in turn are provided by other packages.
|
|
|
309 size - size of the bundled package
|
|
|
310 md5sum - computed md5 checksum"
|
|
|
311 (interactive "xPackage Version: \nSProperty")
|
|
|
312 (plist-get package-version property))
|
|
|
313
|
|
|
314 (defun package-get-info-version-prop (package-list package version property)
|
|
|
315 "In PACKAGE-LIST, search for PACKAGE with this VERSION and return
|
|
|
316 PROPERTY value."
|
|
|
317 (package-get-info-prop
|
|
|
318 (package-get-info-version
|
|
|
319 (package-get-info-find-package package-list package) version) property))
|
|
|
320
|
|
|
321 (defun package-get-set-version-prop (package-list package version
|
|
|
322 property value)
|
|
|
323 "A utility to make it easier to add a VALUE for a specific PROPERTY
|
|
|
324 in this VERSION of a specific PACKAGE kept in the PACKAGE-LIST.
|
|
|
325 Returns the modified PACKAGE-LIST. Any missing fields are created."
|
|
|
326 )
|
|
|
327
|
|
|
328 (defun package-get-staging-dir (filename)
|
|
|
329 "Return a good place to stash FILENAME when it is retrieved.
|
|
|
330 Use `package-get-dir' for directory to store stuff.
|
|
|
331 Creates `package-get-dir' it it doesn't exist."
|
|
|
332 (interactive "FPackage filename: ")
|
|
|
333 (if (not (file-exists-p package-get-dir))
|
|
|
334 (make-directory package-get-dir))
|
|
|
335 (concat
|
|
|
336 (file-name-as-directory package-get-dir)
|
|
|
337 (file-name-nondirectory (or (nth 2 (efs-ftp-path filename)) filename))))
|
|
|
338
|
|
|
339
|
|
|
340 (defun package-get-remote-filename (search filename)
|
|
|
341 "Return FILENAME as a remote filename.
|
|
|
342 It first checks if FILENAME already is a remote filename. If it is
|
|
|
343 not, then it uses the (car search) as the remote site-name and the (cadr
|
|
|
344 search) as the remote-directory and concatenates filename. In other
|
|
|
345 words
|
|
|
346 site-name:remote-directory/filename
|
|
|
347 "
|
|
|
348 (if (efs-ftp-path filename)
|
|
|
349 filename
|
|
|
350 (concat "/"
|
|
|
351 (car search) ":"
|
|
|
352 (file-name-as-directory (cadr search))
|
|
|
353 filename)))
|
|
|
354
|
|
|
355
|
|
|
356 (defun package-get-installedp (package version)
|
|
|
357 "Determine if PACKAGE with VERSION has already been installed.
|
|
|
358 I'm not sure if I want to do this by searching directories or checking
|
|
|
359 some built in variables. For now, use `locate-library'."
|
|
|
360 ;; Use pacakges-package-list which contains name and version
|
|
|
361 (if (not (floatp version))
|
|
|
362 (setq version (string-to-number version)))
|
|
|
363 (member (cons package version) packages-package-list))
|
|
|
364
|
|
|
365 (defun package-get-package-provider (sym)
|
|
|
366 "Search for a package that provides SYM and return the name and
|
|
|
367 version. Searches in `package-get-base' for SYM. If SYM is a
|
|
|
368 consp, then it must match a corresponding (provide (SYM VERSION)) from
|
|
|
369 the package."
|
|
|
370 (interactive "SSymbol: ")
|
|
|
371 (let ((packages package-get-base)
|
|
|
372 (done nil)
|
|
|
373 (found nil))
|
|
|
374 (while (and (not done) packages)
|
|
|
375 (let ((this-package (cdr (car packages)))) ;strip off package name
|
|
|
376 (while (and (not done) this-package)
|
|
|
377 (if (member sym (package-get-info-prop (car this-package) 'provides))
|
|
|
378 (progn (setq done t)
|
|
|
379 (setq found (list (caar packages)
|
|
|
380 (package-get-info-prop (car this-package) 'version))))
|
|
|
381 (setq this-package (cdr this-package)))))
|
|
|
382 (setq packages (cdr packages)))
|
|
|
383 found))
|
|
|
384
|
|
|
385 ;;; package-get.el ends here
|
