sade.h revision 8709 
127837Sdavidn/*
266830Sobrien * The new sysinstall program.
366830Sobrien *
466830Sobrien * This is probably the last attempt in the `sysinstall' line, the next
566830Sobrien * generation being slated to essentially a complete rewrite.
666830Sobrien *
766830Sobrien * $Id: sysinstall.h,v 1.27 1995/05/23 02:41:16 jkh Exp $
866830Sobrien *
966830Sobrien * Copyright (c) 1995
1066830Sobrien *	Jordan Hubbard.  All rights reserved.
1166830Sobrien *
1266830Sobrien * Redistribution and use in source and binary forms, with or without
1366830Sobrien * modification, are permitted provided that the following conditions
1466830Sobrien * are met:
1566830Sobrien * 1. Redistributions of source code must retain the above copyright
1666830Sobrien *    notice, this list of conditions and the following disclaimer,
1766830Sobrien *    verbatim and that no modifications are made prior to this
1866830Sobrien *    point in the file.
1966830Sobrien * 2. Redistributions in binary form must reproduce the above copyright
2066830Sobrien *    notice, this list of conditions and the following disclaimer in the
2166830Sobrien *    documentation and/or other materials provided with the distribution.
2266830Sobrien * 3. All advertising materials mentioning features or use of this software
2366830Sobrien *    must display the following acknowledgement:
2466830Sobrien *	This product includes software developed by Jordan Hubbard
2566830Sobrien *	for the FreeBSD Project.
2666830Sobrien * 4. The name of Jordan Hubbard or the FreeBSD project may not be used to
2750472Speter *    endorse or promote products derived from this software without specific
2866830Sobrien *    prior written permission.
2927837Sdavidn *
3051231Ssheldonh * THIS SOFTWARE IS PROVIDED BY JORDAN HUBBARD ``AS IS'' AND
3127837Sdavidn * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
3227837Sdavidn * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
3327837Sdavidn * ARE DISCLAIMED.  IN NO EVENT SHALL JORDAN HUBBARD OR HIS PETS BE LIABLE
3427837Sdavidn * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35233943Sed * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3627837Sdavidn * OR SERVICES; LOSS OF USE, DATA, LIFE OR PROFITS; OR BUSINESS INTERRUPTION)
3727837Sdavidn * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3827837Sdavidn * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3927837Sdavidn * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
4027837Sdavidn * SUCH DAMAGE.
4127837Sdavidn *
4251231Ssheldonh */
4327837Sdavidn
4451231Ssheldonh#ifndef _SYSINSTALL_H_INCLUDE
4527837Sdavidn#define _SYSINSTALL_H_INCLUDE
46117324Smtm
4762640Stg#include <stdio.h>
48117324Smtm#include <stdlib.h>
4998189Sgordon#include <string.h>
5096830Sgordon#include <unistd.h>
5196830Sgordon#include <dialog.h>
5296830Sgordon#include "libdisk.h"
5396830Sgordon#include "dist.h"
5496830Sgordon
5596830Sgordon/*** Defines ***/
5696830Sgordon
5796830Sgordon/* Bitfields for menu options */
5896830Sgordon#define DMENU_NORMAL_TYPE	0x1	/* Normal dialog menu		*/
5996830Sgordon#define DMENU_RADIO_TYPE	0x2	/* Radio dialog menu		*/
6096830Sgordon#define DMENU_MULTIPLE_TYPE	0x4	/* Multiple choice menu		*/
6196830Sgordon#define DMENU_SELECTION_RETURNS	0x8	/* Select item then exit	*/
62117324Smtm#define DMENU_CALL_FIRST	0x10	/* In multiple, use one handler */
63117324Smtm
64117324Smtm/* variable limits */
6563307Smarkm#define VAR_NAME_MAX		128
66117324Smtm#define VAR_VALUE_MAX		1024
67117324Smtm
68117324Smtm/* device limits */
69130151Sschweikh#define DEV_NAME_MAX		128	/* The maximum length of a device name	*/
70136615Sschweikh#define DEV_MAX			200	/* The maximum number of devices we'll deal with */
71136615Sschweikh#define INTERFACE_MAX		50	/* Maximum number of network interfaces we'll deal with */
72117324Smtm
73117324Smtm/*
74117324Smtm * I make some pretty gross assumptions about having a max of 50 chunks
75117324Smtm * total - 8 slices and 42 partitions.  I can't easily display many more
76117324Smtm * than that on the screen at once!
77117324Smtm *
78117324Smtm * For 2.1 I'll revisit this and try to make it more dynamic, but since
7963307Smarkm * this will catch 99.99% of all possible cases, I'm not too worried.
80117324Smtm */
81117324Smtm#define MAX_CHUNKS	50
82117324Smtm
83138847Srse/* Internal flag variables */
84250915Sjamie#define DISK_PARTITIONED	"_diskPartitioned"
85250915Sjamie#define DISK_LABELLED		"_diskLabelled"
86250915Sjamie#define RUNNING_ON_ROOT		"_runningOnRoot"
87250915Sjamie#define TCP_CONFIGURED		"_tcpConfigured"
88250915Sjamie#define NO_CONFIRMATION		"_noConfirmation"
89250915Sjamie
9053550Sdillon#define VAR_HOSTNAME		"hostname"
91153027Sdougb#define VAR_DOMAINNAME		"domainname"
92153027Sdougb#define VAR_NAMESERVER		"nameserver"
93153027Sdougb#define VAR_GATEWAY		"gateway"
94153027Sdougb
95153027Sdougb#define VAR_IFCONFIG		"ifconfig_"
96153027Sdougb
97153027Sdougb/* The help file for the TCP/IP setup screen */
98117324Smtm#define TCP_HELPFILE		"tcp.hlp"
99131135Smtm
100131135Smtm/*** Types ***/
101117324Smtmtypedef unsigned int Boolean;
10227837Sdavidntypedef struct disk Disk;
103117324Smtmtypedef struct chunk Chunk;
104117324Smtm
105117324Smtmtypedef enum {
106187685Sbz    DMENU_SHELL_ESCAPE,			/* Fork a shell			*/
107117324Smtm    DMENU_DISPLAY_FILE,			/* Display a file's contents	*/
10827837Sdavidn    DMENU_SUBMENU,			/* Recurse into another menu	*/
10986856Sdarrenr    DMENU_SYSTEM_COMMAND,		/* Run shell commmand		*/
11085219Sdarrenr    DMENU_SYSTEM_COMMAND_BOX,		/* Same as above, but in prgbox	*/
11186856Sdarrenr    DMENU_SET_VARIABLE,			/* Set an environment/system var */
11227837Sdavidn    DMENU_SET_FLAG,			/* Set flag in an unsigned int	*/
11327837Sdavidn    DMENU_CALL,				/* Call back a C function	*/
114    DMENU_CANCEL,			/* Cancel out of this menu	*/
115    DMENU_NOP,				/* Do nothing special for item	*/
116} DMenuItemType;
117
118typedef struct _dmenuItem {
119    char *title;			/* Our title			*/
120    char *prompt;			/* Our prompt			*/
121    DMenuItemType type;			/* What type of item we are	*/
122    void *ptr;				/* Generic data ptr		*/
123    u_long parm;			/* Parameter for above		*/
124    Boolean disabled;			/* Are we temporarily disabled?	*/
125} DMenuItem;
126
127typedef struct _dmenu {
128    unsigned int options;		/* What sort of menu we are	*/
129    char *title;			/* Our title			*/
130    char *prompt;			/* Our prompt			*/
131    char *helpline;			/* Line of help at bottom	*/
132    char *helpfile;			/* Help file for "F1"		*/
133    DMenuItem items[0];			/* Array of menu items		*/
134} DMenu;
135
136/* A sysconfig variable */
137typedef struct _variable {
138    struct _variable *next;
139    char name[VAR_NAME_MAX];
140    char value[VAR_VALUE_MAX];
141} Variable;
142
143typedef enum {
144    DEVICE_TYPE_NONE,
145    DEVICE_TYPE_DISK,
146    DEVICE_TYPE_FLOPPY,
147    DEVICE_TYPE_NETWORK,
148    DEVICE_TYPE_CDROM,
149    DEVICE_TYPE_TAPE,
150    DEVICE_TYPE_DOS,
151    DEVICE_TYPE_ANY,
152} DeviceType;
153
154/* A "device" from sysinstall's point of view */
155typedef struct _device {
156    char name[DEV_NAME_MAX];
157    char *description;
158    char *devname;
159    DeviceType type;
160    Boolean enabled;
161    Boolean (*init)(struct _device *);
162    Boolean (*get)(char *fname);
163    void (*close)(struct _device *);
164    void *private;
165} Device;
166
167/* Some internal representations of partitions */
168typedef enum {
169    PART_NONE,
170    PART_SLICE,
171    PART_SWAP,
172    PART_FILESYSTEM,
173    PART_FAT,
174} PartType;
175
176/* The longest newfs command we'll hand to system() */
177#define NEWFS_CMD_MAX	256
178
179typedef struct _part_info {
180    Boolean newfs;
181    char mountpoint[FILENAME_MAX];
182    char newfs_cmd[NEWFS_CMD_MAX];
183} PartInfo;
184
185typedef int (*commandFunc)(char *key, void *data);
186
187
188/*** Externs ***/
189extern int		CpioFD;			/* The file descriptor for our CPIO floppy	*/
190extern int		DebugFD;		/* Where diagnostic output goes			*/
191extern Boolean		OnCDROM;		/* Are we running off of a CDROM?		*/
192extern Boolean		OnSerial;		/* Are we on a serial console?			*/
193extern Boolean		SystemWasInstalled;	/* Did we install it?				*/
194extern Boolean		DialogActive;		/* Is the dialog() stuff up?			*/
195extern Boolean		ColorDisplay;		/* Are we on a color display?			*/
196extern Boolean		OnVTY;			/* On a syscons VTY?				*/
197extern Variable		*VarHead;		/* The head of the variable chain		*/
198extern Device		*mediaDevice;		/* Where we're getting our distribution from	*/
199extern unsigned int	Dists;			/* Which distributions we want			*/
200extern unsigned int	SrcDists;		/* Which src distributions we want		*/
201extern unsigned int	XF86Dists;		/* Which XFree86 dists we want			*/
202extern unsigned int	XF86ServerDists;	/* The XFree86 servers we want			*/
203extern unsigned int	XF86FontDists;		/* The XFree86 fonts we want			*/
204
205extern DMenu		MenuInitial;		/* Initial installation menu			*/
206extern DMenu		MenuMBRType;		/* Type of MBR to write on the disk		*/
207extern DMenu		MenuDocumentation;	/* Documentation menu				*/
208extern DMenu		MenuOptions;		/* Installation options				*/
209extern DMenu		MenuOptionsLanguage;	/* Language options menu			*/
210extern DMenu		MenuOptionsFTP;		/* FTP options menu				*/
211extern DMenu		MenuMedia;		/* Media type menu				*/
212extern DMenu		MenuMediaCDROM;		/* CDROM media menu				*/
213extern DMenu		MenuMediaDOS;		/* DOS media menu				*/
214extern DMenu		MenuMediaFloppy;	/* Floppy media menu				*/
215extern DMenu		MenuMediaFTP;		/* FTP media menu				*/
216extern DMenu		MenuMediaTape;		/* Tape media menu				*/
217extern DMenu		MenuNetworkDevice;	/* Network device menu				*/
218extern DMenu		MenuInstall;		/* Installation menu				*/
219extern DMenu		MenuInstallType;	/* Installation type menu			*/
220extern DMenu		MenuDistributions;	/* Distribution menu				*/
221extern DMenu		MenuSrcDistributions;	/* Source distribution menu			*/
222extern DMenu		MenuXF86;		/* XFree86 main menu				*/
223extern DMenu		MenuXF86Select;		/* XFree86 distribution selection menu		*/
224extern DMenu		MenuXF86SelectCore;	/* XFree86 core distribution menu		*/
225extern DMenu		MenuXF86SelectServer;	/* XFree86 server distribution menu		*/
226extern DMenu		MenuXF86SelectFonts;	/* XFree86 font selection menu			*/
227extern DMenu		MenuDiskDevices;	/* Disk devices menu				*/
228
229
230/*** Prototypes ***/
231
232/* command.c */
233extern void	command_clear(void);
234extern void	command_sort(void);
235extern void	command_execute(void);
236extern void	command_shell_add(char *key, char *fmt, ...);
237extern void	command_func_add(char *key, commandFunc func, void *data);
238
239/* config.c */
240extern void	config_fstab(void);
241extern void	config_sysconfig(void);
242extern void	config_resolv(void);
243
244/* decode.c */
245extern DMenuItem *decode(DMenu *menu, char *name);
246extern Boolean	dispatch(DMenuItem *tmp, char *name);
247extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
248
249/* devices.c */
250extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
251extern void	deviceGetAll(void);
252extern Device	**deviceFind(char *name, DeviceType type);
253extern int	deviceCount(Device **devs);
254extern Device	*new_device(char *name);
255extern Device	*deviceRegister(char *name, char *desc, char *devname, DeviceType type, Boolean enabled,
256				Boolean (*init)(Device *mediadev), Boolean (*get)(char *distname),
257				void (*close)(Device *mediadev), void *private);
258
259/* disks.c */
260extern int	diskPartitionEditor(char *unused);
261
262/* dist.c */
263extern int	distSetDeveloper(char *str);
264extern int	distSetXDeveloper(char *str);
265extern int	distSetUser(char *str);
266extern int	distSetXUser(char *str);
267extern int	distSetMinimum(char *str);
268extern int	distSetEverything(char *str);
269extern int	distSetSrc(char *str);
270extern void	distExtractAll(void);
271
272/* dmenu.c */
273extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
274			  int *curr, int *max);
275extern void	dmenuOpenSimple(DMenu *menu);
276
277/* globals.c */
278extern void	globalsInit(void);
279
280/* install.c */
281extern int	installCommit(char *str);
282
283/* lang.c */
284extern void	lang_set_Danish(char *str);
285extern void	lang_set_Dutch(char *str);
286extern void	lang_set_English(char *str);
287extern void	lang_set_French(char *str);
288extern void	lang_set_German(char *str);
289extern void	lang_set_Italian(char *str);
290extern void	lang_set_Japanese(char *str);
291extern void	lang_set_Norwegian(char *str);
292extern void	lang_set_Russian(char *str);
293extern void	lang_set_Spanish(char *str);
294extern void	lang_set_Swedish(char *str);
295
296/* label.c */
297extern int	diskLabelEditor(char *str);
298
299/* makedevs.c (auto-generated) */
300extern const char	termcap_vt100[];
301extern const char	termcap_cons25[];
302extern const char	termcap_cons25_m[];
303extern const char	termcap_cons25r[];
304extern const char	termcap_cons25r_m[];
305extern const char	termcap_cons25l1[];
306extern const char	termcap_cons25l1_m[];
307extern const u_char	font_iso_8x16[];
308extern const u_char	font_cp850_8x16[];
309extern const u_char	font_cp866_8x16[];
310extern const u_char	koi8_r2cp866[];
311extern u_char		default_scrnmap[];
312
313/* media.c */
314extern int	mediaSetCDROM(char *str);
315extern int	mediaSetFloppy(char *str);
316extern int	mediaSetDOS(char *str);
317extern int	mediaSetTape(char *str);
318extern int	mediaSetFTP(char *str);
319extern int	mediaSetFS(char *str);
320extern Boolean	mediaGetType(void);
321extern Boolean	mediaExtractDist(char *distname, char *dir, int fd);
322extern Boolean	mediaVerify(void);
323
324/* media_strategy.c */
325extern Boolean	mediaInitCDROM(Device *dev);
326extern Boolean	mediaInitDOS(Device *dev);
327extern Boolean	mediaInitFloppy(Device *dev);
328extern Boolean	mediaInitFTP(Device *dev);
329extern Boolean	mediaInitNetwork(Device *dev);
330extern Boolean	mediaInitTape(Device *dev);
331extern Boolean	mediaInitUFS(Device *dev);
332extern int	mediaGetCDROM(char *dist);
333extern int	mediaGetDOS(char *dist);
334extern int	mediaGetFloppy(char *dist);
335extern int	mediaGetFTP(char *dist);
336extern int	mediaGetTape(char *dist);
337extern int	mediaGetUFS(char *dist);
338extern void	mediaCloseCDROM(Device *dev);
339extern void	mediaCloseDOS(Device *dev);
340extern void	mediaCloseFTP(Device *dev);
341extern void	mediaCloseFloppy(Device *dev);
342extern void	mediaCloseNetwork(Device *dev);
343extern void	mediaCloseTape(Device *dev);
344
345/* misc.c */
346extern Boolean	file_readable(char *fname);
347extern Boolean	file_executable(char *fname);
348extern char	*string_concat(char *p1, char *p2);
349extern char	*string_prune(char *str);
350extern char	*string_skipwhite(char *str);
351extern void	safe_free(void *ptr);
352extern void	*safe_malloc(size_t size);
353extern void	*safe_realloc(void *orig, size_t size);
354extern char	**item_add(char **list, char *item, int *curr, int *max);
355extern char	**item_add_pair(char **list, char *item1, char *item2,
356				int *curr, int *max);
357extern void	items_free(char **list, int *curr, int *max);
358extern int	Mkdir(char *, void *data);
359extern int	Mount(char *, void *data);
360
361/* msg.c */
362extern void	msgInfo(char *fmt, ...);
363extern void	msgYap(char *fmt, ...);
364extern void	msgWarn(char *fmt, ...);
365extern void	msgDebug(char *fmt, ...);
366extern void	msgError(char *fmt, ...);
367extern void	msgFatal(char *fmt, ...);
368extern void	msgConfirm(char *fmt, ...);
369extern void	msgNotify(char *fmt, ...);
370extern void	msgWeHaveOutput(char *fmt, ...);
371extern int	msgYesNo(char *fmt, ...);
372extern char	*msgGetInput(char *buf, char *fmt, ...);
373
374/* system.c */
375extern void	systemInitialize(int argc, char **argv);
376extern void	systemShutdown(void);
377extern void	systemWelcome(void);
378extern int	systemExecute(char *cmd);
379extern int	systemShellEscape(void);
380extern int	systemDisplayFile(char *file);
381extern char	*systemHelpFile(char *file, char *buf);
382extern void	systemChangeFont(const u_char font[]);
383extern void	systemChangeLang(char *lang);
384extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
385				     char *mono, const u_char m_termcap[]);
386extern void	systemChangeScreenmap(const u_char newmap[]);
387extern int	vsystem(char *fmt, ...);
388
389/* tcpip.c */
390extern int	tcpOpenDialog(char *);
391extern Device	*tcpDeviceSelect(void);
392extern Boolean	tcpStartPPP(void);
393
394/* termcap.c */
395extern int	set_termcap(void);
396
397/* variables.c */
398extern void	variable_set(char *var);
399extern void	variable_set2(char *name, char *value);
400
401/* wizard.c */
402extern void	slice_wizard(Disk *d);
403
404#endif
405/* _SYSINSTALL_H_INCLUDE */
406