sade.h revision 8837
1/*
2 * The new sysinstall program.
3 *
4 * This is probably the last attempt in the `sysinstall' line, the next
5 * generation being slated to essentially a complete rewrite.
6 *
7 * $Id: sysinstall.h,v 1.39 1995/05/28 09:31:39 jkh Exp $
8 *
9 * Copyright (c) 1995
10 *	Jordan Hubbard.  All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions and the following disclaimer,
17 *    verbatim and that no modifications are made prior to this
18 *    point in the file.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 *    notice, this list of conditions and the following disclaimer in the
21 *    documentation and/or other materials provided with the distribution.
22 * 3. All advertising materials mentioning features or use of this software
23 *    must display the following acknowledgement:
24 *	This product includes software developed by Jordan Hubbard
25 *	for the FreeBSD Project.
26 * 4. The name of Jordan Hubbard or the FreeBSD project may not be used to
27 *    endorse or promote products derived from this software without specific
28 *    prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY JORDAN HUBBARD ``AS IS'' AND
31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED.  IN NO EVENT SHALL JORDAN HUBBARD OR HIS PETS BE LIABLE
34 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36 * OR SERVICES; LOSS OF USE, DATA, LIFE OR PROFITS; OR BUSINESS INTERRUPTION)
37 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 * SUCH DAMAGE.
41 *
42 */
43
44#ifndef _SYSINSTALL_H_INCLUDE
45#define _SYSINSTALL_H_INCLUDE
46
47#include <stdio.h>
48#include <stdlib.h>
49#include <string.h>
50#include <unistd.h>
51#include <dialog.h>
52#include "libdisk.h"
53#include "dist.h"
54
55/*** Defines ***/
56
57/* Bitfields for menu options */
58#define DMENU_NORMAL_TYPE	0x1	/* Normal dialog menu		*/
59#define DMENU_RADIO_TYPE	0x2	/* Radio dialog menu		*/
60#define DMENU_MULTIPLE_TYPE	0x4	/* Multiple choice menu		*/
61#define DMENU_SELECTION_RETURNS	0x8	/* Select item then exit	*/
62#define DMENU_CALL_FIRST	0x10	/* In multiple, use one handler */
63
64/* variable limits */
65#define VAR_NAME_MAX		128
66#define VAR_VALUE_MAX		1024
67
68/* device limits */
69#define DEV_NAME_MAX		128	/* The maximum length of a device name	*/
70#define DEV_MAX			200	/* The maximum number of devices we'll deal with */
71#define INTERFACE_MAX		50	/* Maximum number of network interfaces we'll deal with */
72
73/*
74 * I make some pretty gross assumptions about having a max of 50 chunks
75 * total - 8 slices and 42 partitions.  I can't easily display many more
76 * than that on the screen at once!
77 *
78 * For 2.1 I'll revisit this and try to make it more dynamic, but since
79 * this will catch 99.99% of all possible cases, I'm not too worried.
80 */
81#define MAX_CHUNKS	50
82
83/* Internal flag variables */
84#define DISK_PARTITIONED	"_diskPartitioned"
85#define DISK_LABELLED		"_diskLabelled"
86#define RUNNING_ON_ROOT		"_runningOnRoot"
87#define TCP_CONFIGURED		"_tcpConfigured"
88#define NO_CONFIRMATION		"noConfirmation"
89
90#define VAR_HOSTNAME		"hostname"
91#define VAR_DOMAINNAME		"domainname"
92#define VAR_NAMESERVER		"nameserver"
93#define VAR_GATEWAY		"defaultrouter"
94#define VAR_IPADDR		"ipaddr"
95
96#define VAR_IFCONFIG		"ifconfig_"
97#define VAR_INTERFACES		"network_interfaces"
98
99/* The help file for the TCP/IP setup screen */
100#define TCP_HELPFILE		"tcp.hlp"
101
102/*** Types ***/
103typedef unsigned int Boolean;
104typedef struct disk Disk;
105typedef struct chunk Chunk;
106
107typedef enum {
108    DMENU_SHELL_ESCAPE,			/* Fork a shell			*/
109    DMENU_DISPLAY_FILE,			/* Display a file's contents	*/
110    DMENU_SUBMENU,			/* Recurse into another menu	*/
111    DMENU_SYSTEM_COMMAND,		/* Run shell commmand		*/
112    DMENU_SYSTEM_COMMAND_BOX,		/* Same as above, but in prgbox	*/
113    DMENU_SET_VARIABLE,			/* Set an environment/system var */
114    DMENU_SET_FLAG,			/* Set flag in an unsigned int	*/
115    DMENU_CALL,				/* Call back a C function	*/
116    DMENU_CANCEL,			/* Cancel out of this menu	*/
117    DMENU_NOP,				/* Do nothing special for item	*/
118} DMenuItemType;
119
120typedef struct _dmenuItem {
121    char *title;			/* Our title			*/
122    char *prompt;			/* Our prompt			*/
123    DMenuItemType type;			/* What type of item we are	*/
124    void *ptr;				/* Generic data ptr		*/
125    u_long parm;			/* Parameter for above		*/
126    Boolean disabled;			/* Are we temporarily disabled?	*/
127} DMenuItem;
128
129typedef struct _dmenu {
130    unsigned int options;		/* What sort of menu we are	*/
131    char *title;			/* Our title			*/
132    char *prompt;			/* Our prompt			*/
133    char *helpline;			/* Line of help at bottom	*/
134    char *helpfile;			/* Help file for "F1"		*/
135    DMenuItem items[0];			/* Array of menu items		*/
136} DMenu;
137
138/* A sysconfig variable */
139typedef struct _variable {
140    struct _variable *next;
141    char name[VAR_NAME_MAX];
142    char value[VAR_VALUE_MAX];
143} Variable;
144
145#define MAX_ATTRIBS	200
146#define MAX_NAME	511
147#define MAX_VALUE	4095
148
149typedef struct _attribs {
150    char *name;
151    char *value;
152} Attribs;
153
154typedef enum {
155    DEVICE_TYPE_NONE,
156    DEVICE_TYPE_DISK,
157    DEVICE_TYPE_FLOPPY,
158    DEVICE_TYPE_FTP,
159    DEVICE_TYPE_NETWORK,
160    DEVICE_TYPE_CDROM,
161    DEVICE_TYPE_TAPE,
162    DEVICE_TYPE_DOS,
163    DEVICE_TYPE_UFS,
164    DEVICE_TYPE_NFS,
165    DEVICE_TYPE_ANY,
166} DeviceType;
167
168/* A "device" from sysinstall's point of view */
169typedef struct _device {
170    char name[DEV_NAME_MAX];
171    char *description;
172    char *devname;
173    DeviceType type;
174    Boolean enabled;
175    Boolean (*init)(struct _device *);
176    int (*get)(char *file);
177    Boolean (*close)(struct _device *, int fd);
178    void (*shutdown)(struct _device *);
179    void *private;
180} Device;
181
182/* Some internal representations of partitions */
183typedef enum {
184    PART_NONE,
185    PART_SLICE,
186    PART_SWAP,
187    PART_FILESYSTEM,
188    PART_FAT,
189} PartType;
190
191/* The longest newfs command we'll hand to system() */
192#define NEWFS_CMD_MAX	256
193
194typedef struct _part_info {
195    Boolean newfs;
196    char mountpoint[FILENAME_MAX];
197    char newfs_cmd[NEWFS_CMD_MAX];
198} PartInfo;
199
200typedef int (*commandFunc)(char *key, void *data);
201
202#define HOSTNAME_FIELD_LEN	256
203#define IPADDR_FIELD_LEN	16
204#define EXTRAS_FIELD_LEN	256
205
206/* This is the structure that Network devices carry around in their private, erm, structures */
207typedef struct _devPriv {
208    char ipaddr[IPADDR_FIELD_LEN];
209    char netmask[IPADDR_FIELD_LEN];
210    char extras[EXTRAS_FIELD_LEN];
211} DevInfo;
212
213
214/*** Externs ***/
215extern int		DebugFD;		/* Where diagnostic output goes			*/
216extern Boolean		OnCDROM;		/* Are we running off of a CDROM?		*/
217extern Boolean		OnSerial;		/* Are we on a serial console?			*/
218extern Boolean		SystemWasInstalled;	/* Did we install it?				*/
219extern Boolean		RunningAsInit;		/* Are we running stand-alone?			*/
220extern Boolean		DialogActive;		/* Is the dialog() stuff up?			*/
221extern Boolean		ColorDisplay;		/* Are we on a color display?			*/
222extern Boolean		OnVTY;			/* On a syscons VTY?				*/
223extern Variable		*VarHead;		/* The head of the variable chain		*/
224extern Device		*mediaDevice;		/* Where we're getting our distribution from	*/
225extern unsigned int	Dists;			/* Which distributions we want			*/
226extern unsigned int	SrcDists;		/* Which src distributions we want		*/
227extern unsigned int	XF86Dists;		/* Which XFree86 dists we want			*/
228extern unsigned int	XF86ServerDists;	/* The XFree86 servers we want			*/
229extern unsigned int	XF86FontDists;		/* The XFree86 fonts we want			*/
230
231extern DMenu		MenuInitial;		/* Initial installation menu			*/
232extern DMenu		MenuMBRType;		/* Type of MBR to write on the disk		*/
233extern DMenu		MenuConfigure;		/* Final configuration menu			*/
234extern DMenu		MenuDocumentation;	/* Documentation menu				*/
235extern DMenu		MenuOptions;		/* Installation options				*/
236extern DMenu		MenuOptionsLanguage;	/* Language options menu			*/
237extern DMenu		MenuOptionsFTP;		/* FTP options menu				*/
238extern DMenu		MenuMedia;		/* Media type menu				*/
239extern DMenu		MenuMediaCDROM;		/* CDROM media menu				*/
240extern DMenu		MenuMediaDOS;		/* DOS media menu				*/
241extern DMenu		MenuMediaFloppy;	/* Floppy media menu				*/
242extern DMenu		MenuMediaFTP;		/* FTP media menu				*/
243extern DMenu		MenuMediaTape;		/* Tape media menu				*/
244extern DMenu		MenuNetworkDevice;	/* Network device menu				*/
245extern DMenu		MenuNTP;		/* NTP time server menu				*/
246extern DMenu		MenuSyscons;		/* System console configuration menu		*/
247extern DMenu		MenuSysconsKeymap;	/* System console keymap configuration menu	*/
248extern DMenu		MenuSysconsKeyrate;	/* System console keyrate configuration menu	*/
249extern DMenu		MenuSysconsSaver;	/* System console saver configuration menu	*/
250extern DMenu		MenuNetworking;		/* Network configuration menu			*/
251extern DMenu		MenuInstall;		/* Installation menu				*/
252extern DMenu		MenuInstallType;	/* Installation type menu			*/
253extern DMenu		MenuDistributions;	/* Distribution menu				*/
254extern DMenu		MenuSrcDistributions;	/* Source distribution menu			*/
255extern DMenu		MenuXF86;		/* XFree86 main menu				*/
256extern DMenu		MenuXF86Select;		/* XFree86 distribution selection menu		*/
257extern DMenu		MenuXF86SelectCore;	/* XFree86 core distribution menu		*/
258extern DMenu		MenuXF86SelectServer;	/* XFree86 server distribution menu		*/
259extern DMenu		MenuXF86SelectFonts;	/* XFree86 font selection menu			*/
260extern DMenu		MenuDiskDevices;	/* Disk devices menu				*/
261
262
263/*** Prototypes ***/
264
265/* attrs.c */
266extern const char	*attr_match(Attribs *attr, char *name);
267extern int		attr_parse(Attribs **attr, char *file);
268
269/* cdrom.c */
270extern Boolean	mediaInitCDROM(Device *dev);
271extern int	mediaGetCDROM(char *file);
272extern void	mediaShutdownCDROM(Device *dev);
273
274/* command.c */
275extern void	command_clear(void);
276extern void	command_sort(void);
277extern void	command_execute(void);
278extern void	command_shell_add(char *key, char *fmt, ...);
279extern void	command_func_add(char *key, commandFunc func, void *data);
280
281/* config.c */
282extern void	configFstab(void);
283extern void	configSysconfig(void);
284extern void	configResolv(void);
285extern int	configPorts(char *str);
286extern int	configPackages(char *str);
287extern int	configSaverTimeout(char *str);
288
289/* decode.c */
290extern DMenuItem *decode(DMenu *menu, char *name);
291extern Boolean	dispatch(DMenuItem *tmp, char *name);
292extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
293
294/* devices.c */
295extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
296extern void	deviceGetAll(void);
297extern Device	**deviceFind(char *name, DeviceType type);
298extern int	deviceCount(Device **devs);
299extern Device	*new_device(char *name);
300extern Device	*deviceRegister(char *name, char *desc, char *devname, DeviceType type, Boolean enabled,
301				Boolean (*init)(Device *mediadev), int (*get)(char *file),
302				Boolean (*close)(Device *mediadev, int fd), void (*shutDown)(Device *mediadev),
303				void *private);
304
305/* disks.c */
306extern int	diskPartitionEditor(char *unused);
307
308/* dist.c */
309extern int	distReset(char *str);
310extern int	distSetDeveloper(char *str);
311extern int	distSetXDeveloper(char *str);
312extern int	distSetUser(char *str);
313extern int	distSetXUser(char *str);
314extern int	distSetMinimum(char *str);
315extern int	distSetEverything(char *str);
316extern int	distSetSrc(char *str);
317extern void	distExtractAll(void);
318
319/* dmenu.c */
320extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
321			  int *curr, int *max);
322extern void	dmenuOpenSimple(DMenu *menu);
323
324/* dos.c */
325extern Boolean	mediaInitDOS(Device *dev);
326extern int	mediaGetDOS(char *file);
327extern void	mediaShutdownDOS(Device *dev);
328
329/* floppy.c */
330extern int	getRootFloppy(void);
331extern Boolean	mediaInitFloppy(Device *dev);
332extern int	mediaGetFloppy(char *file);
333extern void	mediaShutdownFloppy(Device *dev);
334
335/* ftp_strat.c */
336extern Boolean	mediaCloseFTP(Device *dev, int fd);
337extern Boolean	mediaInitFTP(Device *dev);
338extern int	mediaGetFTP(char *file);
339extern void	mediaShutdownFTP(Device *dev);
340
341/* globals.c */
342extern void	globalsInit(void);
343
344/* install.c */
345extern int	installCommit(char *str);
346
347/* lang.c */
348extern void	lang_set_Danish(char *str);
349extern void	lang_set_Dutch(char *str);
350extern void	lang_set_English(char *str);
351extern void	lang_set_French(char *str);
352extern void	lang_set_German(char *str);
353extern void	lang_set_Italian(char *str);
354extern void	lang_set_Japanese(char *str);
355extern void	lang_set_Norwegian(char *str);
356extern void	lang_set_Russian(char *str);
357extern void	lang_set_Spanish(char *str);
358extern void	lang_set_Swedish(char *str);
359
360/* label.c */
361extern int	diskLabelEditor(char *str);
362
363/* makedevs.c (auto-generated) */
364extern const char	termcap_vt100[];
365extern const char	termcap_cons25[];
366extern const char	termcap_cons25_m[];
367extern const char	termcap_cons25r[];
368extern const char	termcap_cons25r_m[];
369extern const char	termcap_cons25l1[];
370extern const char	termcap_cons25l1_m[];
371extern const u_char	font_iso_8x16[];
372extern const u_char	font_cp850_8x16[];
373extern const u_char	font_cp866_8x16[];
374extern const u_char	koi8_r2cp866[];
375extern u_char		default_scrnmap[];
376
377/* media.c */
378extern int	mediaSetCDROM(char *str);
379extern int	mediaSetFloppy(char *str);
380extern int	mediaSetDOS(char *str);
381extern int	mediaSetTape(char *str);
382extern int	mediaSetFTP(char *str);
383extern int	mediaSetUFS(char *str);
384extern int	mediaSetNFS(char *str);
385extern Boolean	mediaGetType(void);
386extern Boolean	mediaExtractDist(char *dir, int fd);
387extern Boolean	mediaExtractDistBegin(char *dir, int *fd, int *zpid, int *cpic);
388extern Boolean	mediaExtractDistEnd(int zpid, int cpid);
389extern Boolean	mediaVerify(void);
390
391/* misc.c */
392extern Boolean	file_readable(char *fname);
393extern Boolean	file_executable(char *fname);
394extern char	*string_concat(char *p1, char *p2);
395extern char	*string_prune(char *str);
396extern char	*string_skipwhite(char *str);
397extern void	safe_free(void *ptr);
398extern void	*safe_malloc(size_t size);
399extern void	*safe_realloc(void *orig, size_t size);
400extern char	**item_add(char **list, char *item, int *curr, int *max);
401extern char	**item_add_pair(char **list, char *item1, char *item2,
402				int *curr, int *max);
403extern void	items_free(char **list, int *curr, int *max);
404extern int	Mkdir(char *, void *data);
405extern int	Mount(char *, void *data);
406extern int	Mount_DOS(char *, void *data);
407
408/* msg.c */
409extern Boolean	isDebug(void);
410extern void	msgInfo(char *fmt, ...);
411extern void	msgYap(char *fmt, ...);
412extern void	msgWarn(char *fmt, ...);
413extern void	msgDebug(char *fmt, ...);
414extern void	msgError(char *fmt, ...);
415extern void	msgFatal(char *fmt, ...);
416extern void	msgConfirm(char *fmt, ...);
417extern void	msgNotify(char *fmt, ...);
418extern void	msgWeHaveOutput(char *fmt, ...);
419extern int	msgYesNo(char *fmt, ...);
420extern char	*msgGetInput(char *buf, char *fmt, ...);
421
422/* network.c */
423extern Boolean	mediaInitNetwork(Device *dev);
424extern void	mediaShutdownNetwork(Device *dev);
425extern int	configRoutedFlags(char *str);
426
427/* nfs.c */
428extern Boolean	mediaInitNFS(Device *dev);
429extern int	mediaGetNFS(char *file);
430extern void	mediaShutdownNFS(Device *dev);
431
432/* system.c */
433extern void	systemInitialize(int argc, char **argv);
434extern void	systemShutdown(void);
435extern void	systemWelcome(void);
436extern int	systemExecute(char *cmd);
437extern int	systemShellEscape(void);
438extern int	systemDisplayFile(char *file);
439extern char	*systemHelpFile(char *file, char *buf);
440extern void	systemChangeFont(const u_char font[]);
441extern void	systemChangeLang(char *lang);
442extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
443				     char *mono, const u_char m_termcap[]);
444extern void	systemChangeScreenmap(const u_char newmap[]);
445extern int	vsystem(char *fmt, ...);
446
447/* tape.c */
448extern Boolean	mediaInitTape(Device *dev);
449extern int	mediaGetTape(char *file);
450extern void	mediaShutdownTape(Device *dev);
451
452/* tcpip.c */
453extern int	tcpOpenDialog(Device *dev);
454extern int	tcpDeviceSelect(char *str);
455
456/* termcap.c */
457extern int	set_termcap(void);
458
459/* ufs.c */
460extern void	mediaShutdownUFS(Device *dev);
461extern Boolean	mediaInitUFS(Device *dev);
462extern int	mediaGetUFS(char *file);
463
464/* variables.c */
465extern void	variable_set(char *var);
466extern void	variable_set2(char *name, char *value);
467
468/* wizard.c */
469extern void	slice_wizard(Disk *d);
470
471#endif
472/* _SYSINSTALL_H_INCLUDE */
473