XEmacs 21.4.6 "Common Lisp".
[chise/xemacs-chise.git.1] / lisp / package-net.el
1 ;;; package-net.el --- Installation and Maintenance of XEmacs packages
2
3 ;; Copyright (C) 2000 Andy Piper.
4
5 ;; Keywords: internal
6
7 ;; This file is part of XEmacs.
8
9 ;; XEmacs is free software; you can redistribute it and/or modify it
10 ;; under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; XEmacs is distributed in the hope that it will be useful, but
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 ;; General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
21 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
22 ;; 02111-1307, USA.
23
24 ;;; Synched up with: Not in FSF
25
26 ;;; Commentary:
27
28 ;; Manipulate packages for the netinstall setup utility
29
30 ;; The process should be so:
31
32 ;; 1. The package maintainer or release manager makes a release
33 ;; announcement.
34 ;;
35 ;; 2. For a new package releases the netinstall maintainer simply
36 ;; needs to update `ftp://ftp.xemacs.org/pub/xemacs/setup.ini'. This is
37 ;; harder than it sounds because the file also includes information
38 ;; about the binary releases. At the moment going to the netinstall
39 ;; directory and typing:
40 ;;
41 ;;   `make XEMACS=<current executable location> setup.ini' 
42 ;;
43 ;; will do the right thing provided that:
44 ;; 
45 ;; (a) `package-net-cygwin32-binary-size' and
46 ;; `package-net-win32-binary-size' are set correctly.
47 ;;
48 ;; (b) The binary pointed to by `XEMACS' has a current
49 ;; `package-index.LATEST.pgp' file. If you don't specify the XEMACS=
50 ;; part then you will get whatever is current for your build tree -
51 ;; which is probably not what you want.
52 ;;
53 ;; You can run `package-net-convert-index-to-ini' manually and specify
54 ;; REMOTE but I generally found that to be inconvenient and error-prone.
55 ;;
56 ;; 3. For package releases that's all you need to do. For binary
57 ;; releases you need to build both cygwin and win32 binaries and put
58 ;; them in appropriate tarballs: This can be achieved by running
59 ;; build-msw-release.sh
60 ;;
61
62 (require 'package-admin)
63 (require 'package-get)
64
65 ;; What path should we use from the myriad available?
66 ;; For netinstall we just want something simple, and anyway this is only to 
67 ;; bootstrap the process. This will be:
68 ;; <root>/setup/ for native windows
69 ;; <root>/lib/xemacs/setup for cygwin.
70 ;;
71 ;;; To Do:
72 ;;
73 ;; 1. Package update functions should also update the installed
74 ;; database so that running setup.exe again does not reinstall
75 ;; packages.
76 ;;
77 ;; 2. Generating setup.ini should be more automatic.
78
79 (defvar package-net-cygwin32-binary-size 0
80   "The size in bytes of the cygwin32 binary distribution.")
81
82 (defvar package-net-win32-binary-size 0
83   "The size in bytes of the win32 binary distribution.")
84
85 (defvar package-net-setup-version "1.0"
86   "The version string of setup.")
87
88 ;;;###autoload
89 (defun package-net-setup-directory ()
90   (file-truename (concat data-directory "../../" (if (eq system-type 'cygwin32)
91                                                      "xemacs/setup/" "setup/"))))
92
93 (defun package-net-convert-index-to-ini (&optional destdir remote version)
94   "Convert the package index to ini file format in DESTDIR.
95 DESTDIR defaults to the value of `data-directory'."
96   (package-get-require-base remote)
97
98   (setq destdir (file-name-as-directory (or destdir data-directory)))
99   (let ((buf (get-buffer-create "*setup.ini*")))
100     (unwind-protect
101         (save-excursion
102           (set-buffer buf)
103           (erase-buffer buf)
104           (goto-char (point-min))
105           (let ((entries package-get-base) entry plist)
106             (insert "# This file is automatically generated.  If you edit it, your\n")
107             (insert "# edits will be discarded next time the file is generated.\n")
108             (insert "#\n\n")
109             (insert (format "setup-timestamp: %d\n" 
110                             (+ (* (car (current-time)) 65536) (car (cdr (current-time))))))
111             (insert (format "setup-version: %s\n\n" (or version "1.0")))
112             ;; Native version
113             (insert (format "@ %s\n" "xemacs-i386-pc-win32"))
114             (insert (format "version: %s\n" emacs-program-version))
115             (insert "type: native\n")
116             (insert (format "install: win32/%s %d\n\n"
117                             (concat emacs-program-name
118                                     "-i386-pc-win32-"
119                                     emacs-program-version ".tar.gz")
120                             package-net-win32-binary-size))
121             ;; Cygwin version
122             (insert (format "@ %s\n" "xemacs-i686-pc-cygwin32"))
123             (insert (format "version: %s\n" emacs-program-version))
124             (insert "type: cygwin\n")
125             (insert (format "install: cygwin32/%s %d\n\n"
126                             (concat emacs-program-name
127                                     "-i686-pc-cygwin32-"
128                                     emacs-program-version ".tar.gz") 
129                             package-net-cygwin32-binary-size))
130             ;; Standard packages
131             (while entries
132               (setq entry (car entries))
133               (setq plist (car (cdr entry)))
134               ;; ignore mule packages
135               (unless (or (memq 'mule-base (plist-get plist 'requires))
136                           (eq 'mule-base (car entry)))
137                 (insert (format "@ %s\n" (symbol-name (car entry))))
138                 (insert (format "version: %s\n" (plist-get plist 'version)))
139                 (insert (format "install: packages/%s %s\n" (plist-get plist 'filename)
140                                 (plist-get plist 'size)))
141               ;; These are not supported as yet
142               ;;
143               ;; (insert (format "source: %s\n" (plist-get plist 'source)))
144               ;; (insert "[prev]\n")
145               ;; (insert (format "version: %s\n" (plist-get plist 'version)))
146               ;; (insert (format "install: %s\n" (plist-get plist 'filename)))
147               ;; (insert (format "source: %s\n" (plist-get plist 'source)))
148                 (insert "\n"))
149               (setq entries (cdr entries))))
150           (insert "# setup.ini file ends here\n")
151           (write-region (point-min) (point-max) (concat destdir "setup.ini")))
152       (kill-buffer buf))))
153
154 (defun package-net-generate-bin-ini (&optional version)
155   "Convert the package index to ini file format in the current directory."
156   (let ((buf (get-buffer-create "*setup-bin.ini*")))
157     (unwind-protect
158         (save-excursion
159           (set-buffer buf)
160           (erase-buffer buf)
161           (goto-char (point-min))
162           (insert "# This file is automatically generated.  If you edit it, your\n")
163           (insert "# edits will be discarded next time the file is generated.\n")
164           (insert "#\n\n")
165           (insert (format "setup-timestamp: %d\n" 
166                           (+ (* (car (current-time)) 65536) (car (cdr (current-time))))))
167           (insert (format "setup-version: %s\n\n" (or version "1.0")))
168           ;; Native version
169           (insert (format "@ %s\n" "xemacs-i586-pc-win32"))
170           (insert (format "version: %s\n" emacs-program-version))
171           (insert "type: native\n")
172           (insert (format "install: win32/%s %d\n\n"
173                           (concat emacs-program-name
174                                   "-i586-pc-win32-"
175                                     emacs-program-version ".tar.gz")
176                           package-net-win32-binary-size))
177           ;; Cygwin version
178           (insert (format "@ %s\n" "xemacs-i686-pc-cygwin"))
179           (insert (format "version: %s\n" emacs-program-version))
180           (insert "type: cygwin\n")
181           (insert (format "install: cygwin32/%s %d\n\n"
182                           (concat emacs-program-name
183                                   "-i686-pc-cygwin-"
184                                   emacs-program-version ".tar.gz") 
185                           package-net-cygwin32-binary-size))
186           (insert "# setup.ini file ends here\n")
187           (write-region (point-min) (point-max) "setup-bin.ini")))
188     (kill-buffer buf)))
189
190 (defun package-net-batch-generate-bin-ini ()
191   "Convert the package index to ini file format."
192   (unless noninteractive
193     (error "`package-net-batch-generate-bin-ini' is to be used only with -batch"))
194   (package-net-generate-bin-ini package-net-setup-version))
195
196 ;;;###autoload
197 (defun package-net-update-installed-db (&optional destdir)
198   "Write out the installed package index in a net install suitable format.
199 If DESTDIR is non-nil then use that as the destination directory. 
200 DESTDIR defaults to the value of `package-net-setup-directory'."
201
202   (when (or (eq system-type 'cygwin32)
203             (eq system-type 'window-nt))
204     (setq destdir (file-name-as-directory 
205                    (or destdir (package-net-setup-directory))))
206     (let ((buf (get-buffer-create "*installed.db*")))
207       (unwind-protect
208           (save-excursion
209             (set-buffer buf)
210             (erase-buffer buf)
211             (goto-char (point-min))
212             ;; we use packages-package-list here as we actually want to
213             ;; update relative to the installed reality
214             (let ((entries packages-package-list) entry version)
215               (while entries
216                 (setq entry (car entries))
217                 (setq version (plist-get (cdr entry) :version))
218                 ;; Unfortunately we can't read the size from this
219                 (insert (format "%s %s-%3.2f-pkg.tar.gz 0\n" (symbol-name (car entry))
220                                 (symbol-name (car entry))
221                                 version))
222                 (setq entries (cdr entries))))
223             (make-directory-path destdir)
224             (write-region (point-min) (point-max) (concat destdir "installed.db")))
225         (kill-buffer buf)))))
226
227 (defun package-net-convert-download-sites-to-mirrors (&optional destdir)
228   "Write out the download site list in a net install suitable format.
229 If DESTDIR is non-nil then use that as the destination directory. 
230 DESTDIR defaults to the value of `data-directory'."
231
232   (setq destdir (file-name-as-directory (or destdir data-directory)))
233   (let ((buf (get-buffer-create "*mirrors.lst*")))
234     (unwind-protect
235         (save-excursion
236           (set-buffer buf)
237           (erase-buffer buf)
238           (goto-char (point-min))
239           (let ((entries package-get-download-sites) entry)
240             (while entries
241               (setq entry (car entries))
242               (insert (format "ftp://%s/%s;%s;%s\n"
243                               (nth 1 entry) (substring (nth 2 entry) 0 -9)
244                               (nth 0 entry) (nth 0 entry)))
245               (setq entries (cdr entries))))
246           (write-region (point-min) (point-max) (concat destdir "mirrors.lst")))
247       (kill-buffer buf))))