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#
| 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#
|
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/packages/packages.subr
38f_include $BSDCFG_SHARE/variable.subr
39
40############################################################ GLOBALS
41
42RESWORDS=
43
44############################################################ FUNCTIONS
45
46# f_resword_new $resword $function
47#
48# Create a new `reserved' word for scripting purposes. Reswords call pre-
49# defined functions but differ from those functions in the following ways:
50#
51# + Reswords do not take arguments but instead get all their data from
52# the environment variable namespace.
53# + Unless noError is set (must be non-NULL), if calling the resword
54# results in failure, the application will terminate prematurely.
55# + noError is unset after each/every resword is called.
56#
57# Reswords should not be used in bsdconfig itself (hence the name `reserved
58# word') but instead only in scripts loaded through f_script_load()).
59#
60f_resword_new()
61{
62 local resword="$1" func="$2"
63 [ "$resword" ] || return $FAILURE
64 f_dprintf "script.subr: New resWord %s -> %s" "$resword" "$func"
65 eval $resword\(\){ f_dispatch $func $resword\; }
66 RESWORDS="$RESWORDS${RESWORDS:+ }$resword"
67}
68
69# f_dispatch $func [$resword]
70#
71# Wrapper function used by `reserved words' (reswords) to call other functions.
72# If $noError is set and non-NULL, a failure result from $func is ignored,
73# otherwise the application is prematurely terminated using f_die().
74#
75# NOTE: $noError is unset after every call.
76#
77f_dispatch()
78{
79 local func="$1" resword="${2:-$1}"
80 f_dprintf "f_dispatch: calling resword \`%s'" "$resword"
81 eval $func
82 local retval=$?
83 if [ $retval -ne $SUCCESS ]; then
84 local _ignore_this_error
85 f_getvar $VAR_NO_ERROR _ignore_this_error
86 [ "$_ignore_this_error" ] || f_die $retval \
87 "$msg_command_failed_rest_of_script_aborted" "$resword"
88 fi
89 unset $VAR_NO_ERROR
90}
91
92# f_script_load [$file]
93#
94# Load a script (usually filled with reswords). If $file is missing or NULL,
95# use one of the following instead (in order):
96#
97# $configFile
98# install.cfg
99# /stand/install.fg
100# /tmp/install.cfg
101#
102# Unknown/unregistered reswords will generate sh(1) syntax errors but not cause
103# premature termination.
104#
105# Returns success if a script was loaded and itself returned success.
106#
107f_script_load()
108{
109 local script="$1" config_file retval=$SUCCESS
110
111 f_dprintf "f_script_load: script=[%s]" "$script"
112 if [ ! "$script" ]; then
113 f_getvar $VAR_CONFIG_FILE config_file
114 for script in \
115 $config_file \
116 install.cfg \
117 /stand/install.cfg \
118 /tmp/install.cfg \
119 ; do
120 [ -e "$script" ] && break
121 done
122 fi
123
124 local old_interactive=
125 f_getvar $VAR_NONINTERACTIVE old_interactive # save a copy
126
127 # Hint to others that we're running from a script, should they care
128 setvar $VAR_NONINTERACTIVE yes
129
130 if [ "$script" = "-" ]; then
131 f_dprintf "f_script_load: Loading script from stdin"
132 eval "$( cat )"
133 retval=$?
134 else
135 f_dprintf "f_script_load: Loading script \`%s'" "$script"
136 if [ ! -e "$script" ]; then
137 f_show_msg "$msg_unable_to_open" "$script"
138 return $FAILURE
139 fi
140 . "$script"
141 retval=$?
142 fi
143
144 [ "$old_interactive" ] &&
145 setvar $VAR_NONINTERACTIVE "$old_interactive"
146
147 return $retval
148}
149
150############################################################ MAIN
151
152#
153# Reserved words meant for scripting
154#
155
156# this file
157f_resword_new loadConfig f_script_load
158
159# device.subr
160f_resword_new deviceRescan f_device_rescan
161
162# media/common.subr
163f_resword_new mediaOpen f_media_open
164f_resword_new mediaClose f_media_close
165
166# media includes
167f_resword_new mediaGetType f_media_get_type # media/any.subr
168f_resword_new mediaSetCDROM f_media_set_cdrom # media/cdrom.subr
169f_resword_new mediaSetDOS f_media_set_dos # media/dos.subr
170f_resword_new mediaSetDirectory f_media_set_directory # media/directory.subr
171f_resword_new mediaSetFloppy f_media_set_floppy # media/floppy.subr
172f_resword_new mediaSetNFS f_media_set_nfs # media/nfs.subr
173f_resword_new mediaSetUFS f_media_set_ufs # media/ufs.subr
174f_resword_new mediaSetUSB f_media_set_usb # media/usb.subr
175f_resword_new optionsEditor f_media_options_menu # media/options.subr
176f_resword_new tcpMenuSelect f_dialog_menu_select_tcp # media/tcp.subr
177
178# media/ftp.subr
179f_resword_new mediaSetFTP f_media_set_ftp
180f_resword_new mediaSetFTPActive f_media_set_ftp_active
181f_resword_new mediaSetFTPPassive f_media_set_ftp_passive
182f_resword_new mediaSetFTPUserPass f_media_set_ftp_userpass
183
| 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/packages/packages.subr
38f_include $BSDCFG_SHARE/variable.subr
39
40############################################################ GLOBALS
41
42RESWORDS=
43
44############################################################ FUNCTIONS
45
46# f_resword_new $resword $function
47#
48# Create a new `reserved' word for scripting purposes. Reswords call pre-
49# defined functions but differ from those functions in the following ways:
50#
51# + Reswords do not take arguments but instead get all their data from
52# the environment variable namespace.
53# + Unless noError is set (must be non-NULL), if calling the resword
54# results in failure, the application will terminate prematurely.
55# + noError is unset after each/every resword is called.
56#
57# Reswords should not be used in bsdconfig itself (hence the name `reserved
58# word') but instead only in scripts loaded through f_script_load()).
59#
60f_resword_new()
61{
62 local resword="$1" func="$2"
63 [ "$resword" ] || return $FAILURE
64 f_dprintf "script.subr: New resWord %s -> %s" "$resword" "$func"
65 eval $resword\(\){ f_dispatch $func $resword\; }
66 RESWORDS="$RESWORDS${RESWORDS:+ }$resword"
67}
68
69# f_dispatch $func [$resword]
70#
71# Wrapper function used by `reserved words' (reswords) to call other functions.
72# If $noError is set and non-NULL, a failure result from $func is ignored,
73# otherwise the application is prematurely terminated using f_die().
74#
75# NOTE: $noError is unset after every call.
76#
77f_dispatch()
78{
79 local func="$1" resword="${2:-$1}"
80 f_dprintf "f_dispatch: calling resword \`%s'" "$resword"
81 eval $func
82 local retval=$?
83 if [ $retval -ne $SUCCESS ]; then
84 local _ignore_this_error
85 f_getvar $VAR_NO_ERROR _ignore_this_error
86 [ "$_ignore_this_error" ] || f_die $retval \
87 "$msg_command_failed_rest_of_script_aborted" "$resword"
88 fi
89 unset $VAR_NO_ERROR
90}
91
92# f_script_load [$file]
93#
94# Load a script (usually filled with reswords). If $file is missing or NULL,
95# use one of the following instead (in order):
96#
97# $configFile
98# install.cfg
99# /stand/install.fg
100# /tmp/install.cfg
101#
102# Unknown/unregistered reswords will generate sh(1) syntax errors but not cause
103# premature termination.
104#
105# Returns success if a script was loaded and itself returned success.
106#
107f_script_load()
108{
109 local script="$1" config_file retval=$SUCCESS
110
111 f_dprintf "f_script_load: script=[%s]" "$script"
112 if [ ! "$script" ]; then
113 f_getvar $VAR_CONFIG_FILE config_file
114 for script in \
115 $config_file \
116 install.cfg \
117 /stand/install.cfg \
118 /tmp/install.cfg \
119 ; do
120 [ -e "$script" ] && break
121 done
122 fi
123
124 local old_interactive=
125 f_getvar $VAR_NONINTERACTIVE old_interactive # save a copy
126
127 # Hint to others that we're running from a script, should they care
128 setvar $VAR_NONINTERACTIVE yes
129
130 if [ "$script" = "-" ]; then
131 f_dprintf "f_script_load: Loading script from stdin"
132 eval "$( cat )"
133 retval=$?
134 else
135 f_dprintf "f_script_load: Loading script \`%s'" "$script"
136 if [ ! -e "$script" ]; then
137 f_show_msg "$msg_unable_to_open" "$script"
138 return $FAILURE
139 fi
140 . "$script"
141 retval=$?
142 fi
143
144 [ "$old_interactive" ] &&
145 setvar $VAR_NONINTERACTIVE "$old_interactive"
146
147 return $retval
148}
149
150############################################################ MAIN
151
152#
153# Reserved words meant for scripting
154#
155
156# this file
157f_resword_new loadConfig f_script_load
158
159# device.subr
160f_resword_new deviceRescan f_device_rescan
161
162# media/common.subr
163f_resword_new mediaOpen f_media_open
164f_resword_new mediaClose f_media_close
165
166# media includes
167f_resword_new mediaGetType f_media_get_type # media/any.subr
168f_resword_new mediaSetCDROM f_media_set_cdrom # media/cdrom.subr
169f_resword_new mediaSetDOS f_media_set_dos # media/dos.subr
170f_resword_new mediaSetDirectory f_media_set_directory # media/directory.subr
171f_resword_new mediaSetFloppy f_media_set_floppy # media/floppy.subr
172f_resword_new mediaSetNFS f_media_set_nfs # media/nfs.subr
173f_resword_new mediaSetUFS f_media_set_ufs # media/ufs.subr
174f_resword_new mediaSetUSB f_media_set_usb # media/usb.subr
175f_resword_new optionsEditor f_media_options_menu # media/options.subr
176f_resword_new tcpMenuSelect f_dialog_menu_select_tcp # media/tcp.subr
177
178# media/ftp.subr
179f_resword_new mediaSetFTP f_media_set_ftp
180f_resword_new mediaSetFTPActive f_media_set_ftp_active
181f_resword_new mediaSetFTPPassive f_media_set_ftp_passive
182f_resword_new mediaSetFTPUserPass f_media_set_ftp_userpass
183
|
186f_resword_new mediaSetHTTPProxy f_media_set_http_proxy
187
188# packages/packages.subr
189f_resword_new configPackages f_package_config
190
191# variable.subr
192f_resword_new installVarDefaults f_variable_set_defaults
193f_resword_new dumpVariables f_dump_variables
194
195f_dprintf "%s: Successfully loaded." script.subr
196
197fi # ! $_SCRIPT_SUBR
| 188f_resword_new mediaSetHTTPProxy f_media_set_http_proxy
189
190# packages/packages.subr
191f_resword_new configPackages f_package_config
192
193# variable.subr
194f_resword_new installVarDefaults f_variable_set_defaults
195f_resword_new dumpVariables f_dump_variables
196
197f_dprintf "%s: Successfully loaded." script.subr
198
199fi # ! $_SCRIPT_SUBR
|