script.subr revision 252745 
1if [ ! "$_SCRIPT_SUBR" ]; then _SCRIPT_SUBR=1
2#
3# Copyright (c) 2012-2013 Devin Teske
4# All Rights Reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions
8# are met:
9# 1. Redistributions of source code must retain the above copyright
10#    notice, this list of conditions and the following disclaimer.
11# 2. Redistributions in binary form must reproduce the above copyright
12#    notice, this list of conditions and the following disclaimer in the
13#    documentation and/or other materials provided with the distribution.
14#
15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE
17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20# DAMAGES (INLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25# SUCH DAMAGE.
26#
27# $FreeBSD: head/usr.sbin/bsdconfig/share/script.subr 252745 2013-07-05 01:44:59Z dteske $
28#
29############################################################ INCLUDES
30
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_dprintf "%s: loading includes..." script.subr
34f_include $BSDCFG_SHARE/device.subr
35f_include $BSDCFG_SHARE/media/any.subr
36f_include $BSDCFG_SHARE/media/tcpip.subr
37f_include $BSDCFG_SHARE/mustberoot.subr
38f_include $BSDCFG_SHARE/packages/packages.subr
39f_include $BSDCFG_SHARE/variable.subr
40
41############################################################ GLOBALS
42
43RESWORDS=
44
45############################################################ FUNCTIONS
46
47# f_resword_new $resword $function
48#
49# Create a new `reserved' word for scripting purposes. Reswords call pre-
50# defined functions but differ from those functions in the following ways:
51#
52# 	+ Reswords do not take arguments but instead get all their data from
53# 	  the environment variable namespace.
54# 	+ Unless noError is set (must be non-NULL), if calling the resword
55# 	  results in failure, the application will terminate prematurely.
56# 	+ noError is unset after each/every resword is called.
57#
58# Reswords should not be used in bsdconfig itself (hence the name `reserved
59# word') but instead only in scripts loaded through f_script_load()).
60#
61f_resword_new()
62{
63	local resword="$1" func="$2"
64	[ "$resword" ] || return $FAILURE
65	f_dprintf "script.subr: New resWord %s -> %s" "$resword" "$func"
66	eval $resword\(\){ f_dispatch $func $resword\; }
67	RESWORDS="$RESWORDS${RESWORDS:+ }$resword"
68}
69
70# f_dispatch $func [$resword]
71#
72# Wrapper function used by `reserved words' (reswords) to call other functions.
73# If $noError is set and non-NULL, a failure result from $func is ignored,
74# otherwise the application is prematurely terminated using f_die().
75#
76# NOTE: $noError is unset after every call.
77#
78f_dispatch()
79{
80	local func="$1" resword="${2:-$1}"
81	f_dprintf "f_dispatch: calling resword \`%s'" "$resword"
82	eval $func
83	local retval=$?
84	if [ $retval -ne $SUCCESS ]; then
85		local _ignore_this_error
86		f_getvar $VAR_NO_ERROR _ignore_this_error
87		[ "$_ignore_this_error" ] || f_die $retval \
88			"$msg_command_failed_rest_of_script_aborted" "$resword"
89	fi
90	unset $VAR_NO_ERROR
91}
92
93# f_script_load [$file]
94#
95# Load a script (usually filled with reswords). If $file is missing or NULL,
96# use one of the following instead (in order):
97#
98# 	$configFile
99# 	install.cfg
100# 	/stand/install.fg
101# 	/tmp/install.cfg
102#
103# Unknown/unregistered reswords will generate sh(1) syntax errors but not cause
104# premature termination.
105#
106# Returns success if a script was loaded and itself returned success.
107#
108f_script_load()
109{
110	local script="$1" config_file retval=$SUCCESS
111
112	f_dprintf "f_script_load: script=[%s]" "$script"
113	if [ ! "$script" ]; then
114		f_getvar $VAR_CONFIG_FILE config_file
115		for script in \
116			$config_file \
117			install.cfg \
118			/stand/install.cfg \
119			/tmp/install.cfg \
120		; do
121			[ -e "$script" ] && break
122		done
123	fi
124
125	local old_interactive=
126	f_getvar $VAR_NONINTERACTIVE old_interactive # save a copy
127
128	# Hint to others that we're running from a script, should they care
129	setvar $VAR_NONINTERACTIVE yes
130
131	if [ "$script" = "-" ]; then
132		f_dprintf "f_script_load: Loading script from stdin"
133		eval "$( cat )"
134		retval=$?
135	else
136		f_dprintf "f_script_load: Loading script \`%s'" "$script"
137		if [ ! -e "$script" ]; then
138			f_show_msg "$msg_unable_to_open" "$script"
139			return $FAILURE
140		fi
141		. "$script"
142		retval=$?
143	fi
144
145	[ "$old_interactive" ] &&
146		setvar $VAR_NONINTERACTIVE "$old_interactive"
147
148	return $retval
149}
150
151############################################################ MAIN
152
153#
154# Reserved words meant for scripting
155#
156
157# this file
158f_resword_new loadConfig	f_script_load
159
160# device.subr
161f_resword_new deviceRescan	f_device_rescan
162
163# media/common.subr
164f_resword_new mediaOpen		f_media_open
165f_resword_new mediaClose	f_media_close
166
167# media includes
168f_resword_new mediaGetType	f_media_get_type         # media/any.subr
169f_resword_new mediaSetCDROM	f_media_set_cdrom        # media/cdrom.subr
170f_resword_new mediaSetDOS	f_media_set_dos          # media/dos.subr
171f_resword_new mediaSetDirectory	f_media_set_directory    # media/directory.subr
172f_resword_new mediaSetFloppy	f_media_set_floppy       # media/floppy.subr
173f_resword_new mediaSetNFS	f_media_set_nfs          # media/nfs.subr
174f_resword_new mediaSetUFS	f_media_set_ufs          # media/ufs.subr
175f_resword_new mediaSetUSB	f_media_set_usb          # media/usb.subr
176f_resword_new optionsEditor	f_media_options_menu     # media/options.subr
177f_resword_new tcpMenuSelect	f_dialog_menu_select_tcp # media/tcp.subr
178
179# media/ftp.subr
180f_resword_new mediaSetFTP		f_media_set_ftp
181f_resword_new mediaSetFTPActive		f_media_set_ftp_active
182f_resword_new mediaSetFTPPassive	f_media_set_ftp_passive
183f_resword_new mediaSetFTPUserPass	f_media_set_ftp_userpass
184
185# media/http.subr
186f_resword_new mediaSetHTTP	f_media_set_http
187
188# media/httpproxy.subr
189f_resword_new mediaSetHTTPProxy	f_media_set_http_proxy
190
191# packages/packages.subr
192f_resword_new configPackages	f_package_config
193f_resword_new packageAdd	f_package_add
194
195# variable.subr
196f_resword_new installVarDefaults	f_variable_set_defaults
197f_resword_new dumpVariables		f_dump_variables
198
199f_dprintf "%s: Successfully loaded." script.subr
200
201fi # ! $_SCRIPT_SUBR
202