1 if [ ! "$_SCRIPT_SUBR" ]; then _SCRIPT_SUBR=1
3 # Copyright (c) 2012-2013 Devin Teske
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
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.
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 (INCLUDING, 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
29 ############################################################ INCLUDES
31 BSDCFG_SHARE="/usr/share/bsdconfig"
32 . $BSDCFG_SHARE/common.subr || exit 1
33 f_dprintf "%s: loading includes..." script.subr
34 f_include $BSDCFG_SHARE/device.subr
35 f_include $BSDCFG_SHARE/media/any.subr
36 f_include $BSDCFG_SHARE/media/tcpip.subr
37 f_include $BSDCFG_SHARE/mustberoot.subr
38 f_include $BSDCFG_SHARE/networking/services.subr
39 f_include $BSDCFG_SHARE/packages/packages.subr
40 f_include $BSDCFG_SHARE/variable.subr
42 ############################################################ GLOBALS
46 ############################################################ FUNCTIONS
48 # f_resword_new $resword $function
50 # Create a new `reserved' word for scripting purposes. Reswords call pre-
51 # defined functions but differ from those functions in the following ways:
53 # + Reswords do not take arguments but instead get all their data from
54 # the environment variable namespace.
55 # + Unless noError is set (must be non-NULL), if calling the resword
56 # results in failure, the application will terminate prematurely.
57 # + noError is unset after each/every resword is called.
59 # Reswords should not be used in bsdconfig itself (hence the name `reserved
60 # word') but instead only in scripts loaded through f_script_load()).
64 local resword="$1" func="$2"
65 [ "$resword" ] || return $FAILURE
66 f_dprintf "script.subr: New resWord %s -> %s" "$resword" "$func"
67 eval $resword\(\){ f_dispatch $func $resword\; }
68 RESWORDS="$RESWORDS${RESWORDS:+ }$resword"
71 # f_dispatch $func [$resword]
73 # Wrapper function used by `reserved words' (reswords) to call other functions.
74 # If $noError is set and non-NULL, a failure result from $func is ignored,
75 # otherwise the application is prematurely terminated using f_die().
77 # NOTE: $noError is unset after every call.
81 local func="$1" resword="${2:-$1}"
82 f_dprintf "f_dispatch: calling resword \`%s'" "$resword"
85 if [ $retval -ne $SUCCESS ]; then
86 local _ignore_this_error
87 f_getvar $VAR_NO_ERROR _ignore_this_error
88 [ "$_ignore_this_error" ] || f_die $retval \
89 "$msg_command_failed_rest_of_script_aborted" "$resword"
94 # f_script_load [$file]
96 # Load a script (usually filled with reswords). If $file is missing or NULL,
97 # use one of the following instead (in order):
104 # Unknown/unregistered reswords will generate sh(1) syntax errors but not cause
105 # premature termination.
107 # Returns success if a script was loaded and itself returned success.
111 local script="$1" config_file retval=$SUCCESS
113 f_dprintf "f_script_load: script=[%s]" "$script"
114 if [ ! "$script" ]; then
115 f_getvar $VAR_CONFIG_FILE config_file
122 [ -e "$script" ] && break
126 local old_interactive=
127 f_getvar $VAR_NONINTERACTIVE old_interactive # save a copy
129 # Hint to others that we're running from a script, should they care
130 setvar $VAR_NONINTERACTIVE yes
132 if [ "$script" = "-" ]; then
133 f_dprintf "f_script_load: Loading script from stdin"
137 f_dprintf "f_script_load: Loading script \`%s'" "$script"
138 if [ ! -e "$script" ]; then
139 f_show_msg "$msg_unable_to_open" "$script"
146 [ "$old_interactive" ] &&
147 setvar $VAR_NONINTERACTIVE "$old_interactive"
152 ############################################################ MAIN
155 # Reserved words meant for scripting
159 f_resword_new loadConfig f_script_load
162 f_resword_new deviceRescan f_device_rescan
165 f_resword_new mediaOpen f_media_open
166 f_resword_new mediaClose f_media_close
169 f_resword_new mediaGetType f_media_get_type # media/any.subr
170 f_resword_new mediaSetCDROM f_media_set_cdrom # media/cdrom.subr
171 f_resword_new mediaSetDOS f_media_set_dos # media/dos.subr
172 f_resword_new mediaSetDirectory f_media_set_directory # media/directory.subr
173 f_resword_new mediaSetFloppy f_media_set_floppy # media/floppy.subr
174 f_resword_new mediaSetNFS f_media_set_nfs # media/nfs.subr
175 f_resword_new mediaSetUFS f_media_set_ufs # media/ufs.subr
176 f_resword_new mediaSetUSB f_media_set_usb # media/usb.subr
177 f_resword_new optionsEditor f_media_options_menu # media/options.subr
178 f_resword_new tcpMenuSelect f_dialog_menu_select_tcp # media/tcp.subr
181 f_resword_new mediaSetFTP f_media_set_ftp
182 f_resword_new mediaSetFTPActive f_media_set_ftp_active
183 f_resword_new mediaSetFTPPassive f_media_set_ftp_passive
184 f_resword_new mediaSetFTPUserPass f_media_set_ftp_userpass
187 f_resword_new mediaSetHTTP f_media_set_http
189 # media/httpproxy.subr
190 f_resword_new mediaSetHTTPProxy f_media_set_http_proxy
192 # networking/services.subr
193 f_resword_new configPCNFSD f_config_pcnfsd
195 # packages/packages.subr
196 f_resword_new configPackages f_package_config
197 f_resword_new packageAdd f_package_add
198 f_resword_new packageDelete f_package_delete
199 f_resword_new packageReinstall f_package_reinstall
202 f_resword_new installVarDefaults f_variable_set_defaults
203 f_resword_new dumpVariables f_dump_variables
205 f_dprintf "%s: Successfully loaded." script.subr