sysinstall.h revision 8705 
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.26 1995/05/21 15:40:53 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 TCP_CONFIGURED		"_tcpConfigured"
87#define NO_CONFIRMATION		"_noConfirmation"
88
89#define VAR_HOSTNAME		"hostname"
90#define VAR_DOMAINNAME		"domainname"
91#define VAR_NAMESERVER		"nameserver"
92#define VAR_GATEWAY		"gateway"
93
94#define VAR_IFCONFIG		"ifconfig_"
95
96/* The help file for the TCP/IP setup screen */
97#define TCP_HELPFILE		"tcp.hlp"
98
99/*** Types ***/
100typedef unsigned int Boolean;
101typedef struct disk Disk;
102typedef struct chunk Chunk;
103
104typedef enum {
105    DMENU_SHELL_ESCAPE,			/* Fork a shell			*/
106    DMENU_DISPLAY_FILE,			/* Display a file's contents	*/
107    DMENU_SUBMENU,			/* Recurse into another menu	*/
108    DMENU_SYSTEM_COMMAND,		/* Run shell commmand		*/
109    DMENU_SYSTEM_COMMAND_BOX,		/* Same as above, but in prgbox	*/
110    DMENU_SET_VARIABLE,			/* Set an environment/system var */
111    DMENU_SET_FLAG,			/* Set flag in an unsigned int	*/
112    DMENU_CALL,				/* Call back a C function	*/
113    DMENU_CANCEL,			/* Cancel out of this menu	*/
114    DMENU_NOP,				/* Do nothing special for item	*/
115} DMenuItemType;
116
117typedef struct _dmenuItem {
118    char *title;			/* Our title			*/
119    char *prompt;			/* Our prompt			*/
120    DMenuItemType type;			/* What type of item we are	*/
121    void *ptr;				/* Generic data ptr		*/
122    u_long parm;			/* Parameter for above		*/
123    Boolean disabled;			/* Are we temporarily disabled?	*/
124} DMenuItem;
125
126typedef struct _dmenu {
127    unsigned int options;		/* What sort of menu we are	*/
128    char *title;			/* Our title			*/
129    char *prompt;			/* Our prompt			*/
130    char *helpline;			/* Line of help at bottom	*/
131    char *helpfile;			/* Help file for "F1"		*/
132    DMenuItem items[0];			/* Array of menu items		*/
133} DMenu;
134
135/* A sysconfig variable */
136typedef struct _variable {
137    struct _variable *next;
138    char name[VAR_NAME_MAX];
139    char value[VAR_VALUE_MAX];
140} Variable;
141
142typedef enum {
143    DEVICE_TYPE_NONE,
144    DEVICE_TYPE_DISK,
145    DEVICE_TYPE_FLOPPY,
146    DEVICE_TYPE_NETWORK,
147    DEVICE_TYPE_CDROM,
148    DEVICE_TYPE_TAPE,
149    DEVICE_TYPE_DOS,
150    DEVICE_TYPE_ANY,
151} DeviceType;
152
153/* A "device" from sysinstall's point of view */
154typedef struct _device {
155    char name[DEV_NAME_MAX];
156    char *description;
157    char *devname;
158    DeviceType type;
159    Boolean enabled;
160    Boolean (*init)(struct _device *);
161    Boolean (*get)(char *fname);
162    void (*close)(struct _device *);
163    void *private;
164} Device;
165
166/* Some internal representations of partitions */
167typedef enum {
168    PART_NONE,
169    PART_SLICE,
170    PART_SWAP,
171    PART_FILESYSTEM,
172    PART_FAT,
173} PartType;
174
175/* The longest newfs command we'll hand to system() */
176#define NEWFS_CMD_MAX	256
177
178typedef struct _part_info {
179    Boolean newfs;
180    char mountpoint[FILENAME_MAX];
181    char newfs_cmd[NEWFS_CMD_MAX];
182} PartInfo;
183
184typedef int (*commandFunc)(char *key, void *data);
185
186
187/*** Externs ***/
188extern int		CpioFD;			/* The file descriptor for our CPIO floppy	*/
189extern int		DebugFD;		/* Where diagnostic output goes			*/
190extern Boolean		OnCDROM;		/* Are we running off of a CDROM?		*/
191extern Boolean		OnSerial;		/* Are we on a serial console?			*/
192extern Boolean		SystemWasInstalled;	/* Did we install it?				*/
193extern Boolean		DialogActive;		/* Is the dialog() stuff up?			*/
194extern Boolean		ColorDisplay;		/* Are we on a color display?			*/
195extern Boolean		OnVTY;			/* On a syscons VTY?				*/
196extern Variable		*VarHead;		/* The head of the variable chain		*/
197extern Device		*mediaDevice;		/* Where we're getting our distribution from	*/
198extern unsigned int	Dists;			/* Which distributions we want			*/
199extern unsigned int	SrcDists;		/* Which src distributions we want		*/
200extern unsigned int	XF86Dists;		/* Which XFree86 dists we want			*/
201extern unsigned int	XF86ServerDists;	/* The XFree86 servers we want			*/
202extern unsigned int	XF86FontDists;		/* The XFree86 fonts we want			*/
203
204extern DMenu		MenuInitial;		/* Initial installation menu			*/
205extern DMenu		MenuMBRType;		/* Type of MBR to write on the disk		*/
206extern DMenu		MenuDocumentation;	/* Documentation menu				*/
207extern DMenu		MenuOptions;		/* Installation options				*/
208extern DMenu		MenuOptionsLanguage;	/* Language options menu			*/
209extern DMenu		MenuOptionsFTP;		/* FTP options menu				*/
210extern DMenu		MenuMedia;		/* Media type menu				*/
211extern DMenu		MenuMediaCDROM;		/* CDROM media menu				*/
212extern DMenu		MenuMediaDOS;		/* DOS media menu				*/
213extern DMenu		MenuMediaFloppy;	/* Floppy media menu				*/
214extern DMenu		MenuMediaFTP;		/* FTP media menu				*/
215extern DMenu		MenuMediaTape;		/* Tape media menu				*/
216extern DMenu		MenuNetworkDevice;	/* Network device menu				*/
217extern DMenu		MenuInstall;		/* Installation menu				*/
218extern DMenu		MenuInstallType;	/* Installation type menu			*/
219extern DMenu		MenuDistributions;	/* Distribution menu				*/
220extern DMenu		MenuSrcDistributions;	/* Source distribution menu			*/
221extern DMenu		MenuXF86;		/* XFree86 main menu				*/
222extern DMenu		MenuXF86Select;		/* XFree86 distribution selection menu		*/
223extern DMenu		MenuXF86SelectCore;	/* XFree86 core distribution menu		*/
224extern DMenu		MenuXF86SelectServer;	/* XFree86 server distribution menu		*/
225extern DMenu		MenuXF86SelectFonts;	/* XFree86 font selection menu			*/
226extern DMenu		MenuDiskDevices;	/* Disk devices menu				*/
227
228
229/*** Prototypes ***/
230
231/* command.c */
232extern void	command_clear(void);
233extern void	command_sort(void);
234extern void	command_execute(void);
235extern void	command_shell_add(char *key, char *fmt, ...);
236extern void	command_func_add(char *key, commandFunc func, void *data);
237
238/* config.c */
239extern void	config_fstab(void);
240extern void	config_sysconfig(void);
241extern void	config_resolv(void);
242
243/* decode.c */
244extern DMenuItem *decode(DMenu *menu, char *name);
245extern Boolean	dispatch(DMenuItem *tmp, char *name);
246extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
247
248/* devices.c */
249extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
250extern void	deviceGetAll(void);
251extern Device	**deviceFind(char *name, DeviceType type);
252extern int	deviceCount(Device **devs);
253extern Device	*new_device(char *name);
254extern Device	*deviceRegister(char *name, char *desc, char *devname, DeviceType type, Boolean enabled,
255				Boolean (*init)(Device *mediadev), Boolean (*get)(char *distname),
256				void (*close)(Device *mediadev), void *private);
257
258/* disks.c */
259extern int	diskPartitionEditor(char *unused);
260
261/* dist.c */
262extern int	distSetDeveloper(char *str);
263extern int	distSetXDeveloper(char *str);
264extern int	distSetUser(char *str);
265extern int	distSetXUser(char *str);
266extern int	distSetMinimum(char *str);
267extern int	distSetEverything(char *str);
268extern int	distSetSrc(char *str);
269extern void	distExtractAll(void);
270
271/* dmenu.c */
272extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
273			  int *curr, int *max);
274extern void	dmenuOpenSimple(DMenu *menu);
275
276/* globals.c */
277extern void	globalsInit(void);
278
279/* install.c */
280extern int	installCommit(char *str);
281
282/* lang.c */
283extern void	lang_set_Danish(char *str);
284extern void	lang_set_Dutch(char *str);
285extern void	lang_set_English(char *str);
286extern void	lang_set_French(char *str);
287extern void	lang_set_German(char *str);
288extern void	lang_set_Italian(char *str);
289extern void	lang_set_Japanese(char *str);
290extern void	lang_set_Norwegian(char *str);
291extern void	lang_set_Russian(char *str);
292extern void	lang_set_Spanish(char *str);
293extern void	lang_set_Swedish(char *str);
294
295/* label.c */
296extern int	diskLabelEditor(char *str);
297
298/* makedevs.c (auto-generated) */
299extern const char	termcap_vt100[];
300extern const char	termcap_cons25[];
301extern const char	termcap_cons25_m[];
302extern const char	termcap_cons25r[];
303extern const char	termcap_cons25r_m[];
304extern const char	termcap_cons25l1[];
305extern const char	termcap_cons25l1_m[];
306extern const u_char	font_iso_8x16[];
307extern const u_char	font_cp850_8x16[];
308extern const u_char	font_cp866_8x16[];
309extern const u_char	koi8_r2cp866[];
310extern u_char		default_scrnmap[];
311
312/* media.c */
313extern int	mediaSetCDROM(char *str);
314extern int	mediaSetFloppy(char *str);
315extern int	mediaSetDOS(char *str);
316extern int	mediaSetTape(char *str);
317extern int	mediaSetFTP(char *str);
318extern int	mediaSetFS(char *str);
319extern Boolean	mediaGetType(void);
320extern Boolean	mediaExtractDist(char *distname, char *dir, int fd);
321extern Boolean	mediaVerify(void);
322
323/* media_strategy.c */
324extern Boolean	mediaInitCDROM(Device *dev);
325extern Boolean	mediaInitDOS(Device *dev);
326extern Boolean	mediaInitFloppy(Device *dev);
327extern Boolean	mediaInitFTP(Device *dev);
328extern Boolean	mediaInitNetwork(Device *dev);
329extern Boolean	mediaInitTape(Device *dev);
330extern Boolean	mediaInitUFS(Device *dev);
331extern int	mediaGetCDROM(char *dist);
332extern int	mediaGetDOS(char *dist);
333extern int	mediaGetFloppy(char *dist);
334extern int	mediaGetFTP(char *dist);
335extern int	mediaGetTape(char *dist);
336extern int	mediaGetUFS(char *dist);
337extern void	mediaCloseCDROM(Device *dev);
338extern void	mediaCloseDOS(Device *dev);
339extern void	mediaCloseFTP(Device *dev);
340extern void	mediaCloseFloppy(Device *dev);
341extern void	mediaCloseNetwork(Device *dev);
342extern void	mediaCloseTape(Device *dev);
343
344/* misc.c */
345extern Boolean	file_readable(char *fname);
346extern Boolean	file_executable(char *fname);
347extern char	*string_concat(char *p1, char *p2);
348extern char	*string_prune(char *str);
349extern char	*string_skipwhite(char *str);
350extern void	safe_free(void *ptr);
351extern void	*safe_malloc(size_t size);
352extern void	*safe_realloc(void *orig, size_t size);
353extern char	**item_add(char **list, char *item, int *curr, int *max);
354extern char	**item_add_pair(char **list, char *item1, char *item2,
355				int *curr, int *max);
356extern void	items_free(char **list, int *curr, int *max);
357extern int	Mkdir(char *, void *data);
358extern int	Mount(char *, void *data);
359
360/* msg.c */
361extern void	msgInfo(char *fmt, ...);
362extern void	msgYap(char *fmt, ...);
363extern void	msgWarn(char *fmt, ...);
364extern void	msgDebug(char *fmt, ...);
365extern void	msgError(char *fmt, ...);
366extern void	msgFatal(char *fmt, ...);
367extern void	msgConfirm(char *fmt, ...);
368extern void	msgNotify(char *fmt, ...);
369extern void	msgWeHaveOutput(char *fmt, ...);
370extern int	msgYesNo(char *fmt, ...);
371extern char	*msgGetInput(char *buf, char *fmt, ...);
372
373/* system.c */
374extern void	systemInitialize(int argc, char **argv);
375extern void	systemShutdown(void);
376extern void	systemWelcome(void);
377extern int	systemExecute(char *cmd);
378extern int	systemShellEscape(void);
379extern int	systemDisplayFile(char *file);
380extern char	*systemHelpFile(char *file, char *buf);
381extern void	systemChangeFont(const u_char font[]);
382extern void	systemChangeLang(char *lang);
383extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
384				     char *mono, const u_char m_termcap[]);
385extern void	systemChangeScreenmap(const u_char newmap[]);
386extern int	vsystem(char *fmt, ...);
387
388/* tcpip.c */
389extern int	tcpOpenDialog(char *);
390extern Device	*tcpDeviceSelect(void);
391
392/* termcap.c */
393extern int	set_termcap(void);
394
395/* variables.c */
396extern void	variable_set(char *var);
397extern void	variable_set2(char *name, char *value);
398
399/* wizard.c */
400extern void	slice_wizard(Disk *d);
401
402#endif
403/* _SYSINSTALL_H_INCLUDE */
404