sysinstall.h revision 8768
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.34 1995/05/26 08:41:48 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
145typedef enum {
146    DEVICE_TYPE_NONE,
147    DEVICE_TYPE_DISK,
148    DEVICE_TYPE_FLOPPY,
149    DEVICE_TYPE_FTP,
150    DEVICE_TYPE_NETWORK,
151    DEVICE_TYPE_CDROM,
152    DEVICE_TYPE_TAPE,
153    DEVICE_TYPE_DOS,
154    DEVICE_TYPE_ANY,
155} DeviceType;
156
157/* A "device" from sysinstall's point of view */
158typedef struct _device {
159    char name[DEV_NAME_MAX];
160    char *description;
161    char *devname;
162    DeviceType type;
163    Boolean enabled;
164    Boolean (*init)(struct _device *);
165    int (*get)(char *fname, char *dir);
166    Boolean (*close)(struct _device *, int fd);
167    void (*shutdown)(struct _device *);
168    void *private;
169} Device;
170
171/* Some internal representations of partitions */
172typedef enum {
173    PART_NONE,
174    PART_SLICE,
175    PART_SWAP,
176    PART_FILESYSTEM,
177    PART_FAT,
178} PartType;
179
180/* The longest newfs command we'll hand to system() */
181#define NEWFS_CMD_MAX	256
182
183typedef struct _part_info {
184    Boolean newfs;
185    char mountpoint[FILENAME_MAX];
186    char newfs_cmd[NEWFS_CMD_MAX];
187} PartInfo;
188
189typedef int (*commandFunc)(char *key, void *data);
190
191
192/*** Externs ***/
193extern int		DebugFD;		/* Where diagnostic output goes			*/
194extern Boolean		OnCDROM;		/* Are we running off of a CDROM?		*/
195extern Boolean		OnSerial;		/* Are we on a serial console?			*/
196extern Boolean		SystemWasInstalled;	/* Did we install it?				*/
197extern Boolean		RunningAsInit;		/* Are we running stand-alone?			*/
198extern Boolean		DialogActive;		/* Is the dialog() stuff up?			*/
199extern Boolean		ColorDisplay;		/* Are we on a color display?			*/
200extern Boolean		OnVTY;			/* On a syscons VTY?				*/
201extern Variable		*VarHead;		/* The head of the variable chain		*/
202extern Device		*mediaDevice;		/* Where we're getting our distribution from	*/
203extern unsigned int	Dists;			/* Which distributions we want			*/
204extern unsigned int	SrcDists;		/* Which src distributions we want		*/
205extern unsigned int	XF86Dists;		/* Which XFree86 dists we want			*/
206extern unsigned int	XF86ServerDists;	/* The XFree86 servers we want			*/
207extern unsigned int	XF86FontDists;		/* The XFree86 fonts we want			*/
208
209extern DMenu		MenuInitial;		/* Initial installation menu			*/
210extern DMenu		MenuMBRType;		/* Type of MBR to write on the disk		*/
211extern DMenu		MenuConfigure;		/* Final configuration menu			*/
212extern DMenu		MenuDocumentation;	/* Documentation menu				*/
213extern DMenu		MenuOptions;		/* Installation options				*/
214extern DMenu		MenuOptionsLanguage;	/* Language options menu			*/
215extern DMenu		MenuOptionsFTP;		/* FTP options menu				*/
216extern DMenu		MenuMedia;		/* Media type menu				*/
217extern DMenu		MenuMediaCDROM;		/* CDROM media menu				*/
218extern DMenu		MenuMediaDOS;		/* DOS media menu				*/
219extern DMenu		MenuMediaFloppy;	/* Floppy media menu				*/
220extern DMenu		MenuMediaFTP;		/* FTP media menu				*/
221extern DMenu		MenuMediaTape;		/* Tape media menu				*/
222extern DMenu		MenuNetworkDevice;	/* Network device menu				*/
223extern DMenu		MenuSyscons;		/* System console configuration menu		*/
224extern DMenu		MenuInstall;		/* Installation menu				*/
225extern DMenu		MenuInstallType;	/* Installation type menu			*/
226extern DMenu		MenuDistributions;	/* Distribution menu				*/
227extern DMenu		MenuSrcDistributions;	/* Source distribution menu			*/
228extern DMenu		MenuXF86;		/* XFree86 main menu				*/
229extern DMenu		MenuXF86Select;		/* XFree86 distribution selection menu		*/
230extern DMenu		MenuXF86SelectCore;	/* XFree86 core distribution menu		*/
231extern DMenu		MenuXF86SelectServer;	/* XFree86 server distribution menu		*/
232extern DMenu		MenuXF86SelectFonts;	/* XFree86 font selection menu			*/
233extern DMenu		MenuDiskDevices;	/* Disk devices menu				*/
234
235
236/*** Prototypes ***/
237
238/* command.c */
239extern void	command_clear(void);
240extern void	command_sort(void);
241extern void	command_execute(void);
242extern void	command_shell_add(char *key, char *fmt, ...);
243extern void	command_func_add(char *key, commandFunc func, void *data);
244
245/* config.c */
246extern void	configFstab(void);
247extern void	configSysconfig(void);
248extern void	configResolv(void);
249extern int	configPorts(char *str);
250extern int	configPackages(char *str);
251extern int	configSaverTimeout(char *str);
252
253/* decode.c */
254extern DMenuItem *decode(DMenu *menu, char *name);
255extern Boolean	dispatch(DMenuItem *tmp, char *name);
256extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
257
258/* devices.c */
259extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
260extern void	deviceGetAll(void);
261extern Device	**deviceFind(char *name, DeviceType type);
262extern int	deviceCount(Device **devs);
263extern Device	*new_device(char *name);
264extern Device	*deviceRegister(char *name, char *desc, char *devname, DeviceType type, Boolean enabled,
265				Boolean (*init)(Device *mediadev), int (*get)(char *distname, char *path),
266				Boolean (*close)(Device *mediadev, int fd), void (*shutDown)(Device *mediadev),
267				void *private);
268
269/* disks.c */
270extern int	diskPartitionEditor(char *unused);
271
272/* dist.c */
273extern int	distReset(char *str);
274extern int	distSetDeveloper(char *str);
275extern int	distSetXDeveloper(char *str);
276extern int	distSetUser(char *str);
277extern int	distSetXUser(char *str);
278extern int	distSetMinimum(char *str);
279extern int	distSetEverything(char *str);
280extern int	distSetSrc(char *str);
281extern void	distExtractAll(void);
282
283/* dmenu.c */
284extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
285			  int *curr, int *max);
286extern void	dmenuOpenSimple(DMenu *menu);
287
288/* globals.c */
289extern void	globalsInit(void);
290
291/* install.c */
292extern int	installCommit(char *str);
293
294/* lang.c */
295extern void	lang_set_Danish(char *str);
296extern void	lang_set_Dutch(char *str);
297extern void	lang_set_English(char *str);
298extern void	lang_set_French(char *str);
299extern void	lang_set_German(char *str);
300extern void	lang_set_Italian(char *str);
301extern void	lang_set_Japanese(char *str);
302extern void	lang_set_Norwegian(char *str);
303extern void	lang_set_Russian(char *str);
304extern void	lang_set_Spanish(char *str);
305extern void	lang_set_Swedish(char *str);
306
307/* label.c */
308extern int	diskLabelEditor(char *str);
309
310/* makedevs.c (auto-generated) */
311extern const char	termcap_vt100[];
312extern const char	termcap_cons25[];
313extern const char	termcap_cons25_m[];
314extern const char	termcap_cons25r[];
315extern const char	termcap_cons25r_m[];
316extern const char	termcap_cons25l1[];
317extern const char	termcap_cons25l1_m[];
318extern const u_char	font_iso_8x16[];
319extern const u_char	font_cp850_8x16[];
320extern const u_char	font_cp866_8x16[];
321extern const u_char	koi8_r2cp866[];
322extern u_char		default_scrnmap[];
323
324/* media.c */
325extern int	mediaSetCDROM(char *str);
326extern int	mediaSetFloppy(char *str);
327extern int	mediaSetDOS(char *str);
328extern int	mediaSetTape(char *str);
329extern int	mediaSetFTP(char *str);
330extern int	mediaSetFS(char *str);
331extern Boolean	mediaGetType(void);
332extern Boolean	mediaExtractDist(char *distname, char *dir, int fd);
333extern Boolean	mediaVerify(void);
334
335/* media_strategy.c */
336extern int	genericGetDist(char *path, void *dist_attrib, Boolean prompt);
337extern Boolean	mediaInitCDROM(Device *dev);
338extern Boolean	mediaInitDOS(Device *dev);
339extern Boolean	mediaInitFloppy(Device *dev);
340extern Boolean	mediaInitFTP(Device *dev);
341extern Boolean	mediaInitNetwork(Device *dev);
342extern Boolean	mediaInitTape(Device *dev);
343extern Boolean	mediaInitUFS(Device *dev);
344extern int	mediaGetCDROM(char *dist, char *path);
345extern int	mediaGetDOS(char *dist, char *path);
346extern int	mediaGetFloppy(char *dist, char *path);
347extern int	mediaGetFTP(char *dist, char *path);
348extern int	mediaGetTape(char *dist, char *path);
349extern int	mediaGetUFS(char *dist, char *path);
350extern void	mediaShutdownCDROM(Device *dev);
351extern void	mediaShutdownDOS(Device *dev);
352extern void	mediaShutdownFTP(Device *dev);
353extern void	mediaShutdownFloppy(Device *dev);
354extern void	mediaShutdownNetwork(Device *dev);
355extern void	mediaShutdownTape(Device *dev);
356
357/* misc.c */
358extern Boolean	file_readable(char *fname);
359extern Boolean	file_executable(char *fname);
360extern char	*string_concat(char *p1, char *p2);
361extern char	*string_prune(char *str);
362extern char	*string_skipwhite(char *str);
363extern void	safe_free(void *ptr);
364extern void	*safe_malloc(size_t size);
365extern void	*safe_realloc(void *orig, size_t size);
366extern char	**item_add(char **list, char *item, int *curr, int *max);
367extern char	**item_add_pair(char **list, char *item1, char *item2,
368				int *curr, int *max);
369extern void	items_free(char **list, int *curr, int *max);
370extern int	Mkdir(char *, void *data);
371extern int	Mount(char *, void *data);
372extern int	Mount_DOS(char *, void *data);
373
374/* msg.c */
375extern void	msgInfo(char *fmt, ...);
376extern void	msgYap(char *fmt, ...);
377extern void	msgWarn(char *fmt, ...);
378extern void	msgDebug(char *fmt, ...);
379extern void	msgError(char *fmt, ...);
380extern void	msgFatal(char *fmt, ...);
381extern void	msgConfirm(char *fmt, ...);
382extern void	msgNotify(char *fmt, ...);
383extern void	msgWeHaveOutput(char *fmt, ...);
384extern int	msgYesNo(char *fmt, ...);
385extern char	*msgGetInput(char *buf, char *fmt, ...);
386
387/* system.c */
388extern void	systemInitialize(int argc, char **argv);
389extern void	systemShutdown(void);
390extern void	systemWelcome(void);
391extern int	systemExecute(char *cmd);
392extern int	systemShellEscape(void);
393extern int	systemDisplayFile(char *file);
394extern char	*systemHelpFile(char *file, char *buf);
395extern void	systemChangeFont(const u_char font[]);
396extern void	systemChangeLang(char *lang);
397extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
398				     char *mono, const u_char m_termcap[]);
399extern void	systemChangeScreenmap(const u_char newmap[]);
400extern int	vsystem(char *fmt, ...);
401
402/* tcpip.c */
403extern int	tcpOpenDialog(Device *dev);
404extern int	tcpDeviceSelect(char *str);
405extern Boolean	tcpStartPPP(Device *dev);
406
407/* termcap.c */
408extern int	set_termcap(void);
409
410/* variables.c */
411extern void	variable_set(char *var);
412extern void	variable_set2(char *name, char *value);
413
414/* wizard.c */
415extern void	slice_wizard(Disk *d);
416
417#endif
418/* _SYSINSTALL_H_INCLUDE */
419