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