script.subr revision 252743
1245052Sdteskeif [ ! "$_SCRIPT_SUBR" ]; then _SCRIPT_SUBR=1 2245052Sdteske# 3247280Sdteske# Copyright (c) 2012-2013 Devin Teske 4245052Sdteske# All Rights Reserved. 5245052Sdteske# 6245052Sdteske# Redistribution and use in source and binary forms, with or without 7245052Sdteske# modification, are permitted provided that the following conditions 8245052Sdteske# are met: 9245052Sdteske# 1. Redistributions of source code must retain the above copyright 10245052Sdteske# notice, this list of conditions and the following disclaimer. 11245052Sdteske# 2. Redistributions in binary form must reproduce the above copyright 12245052Sdteske# notice, this list of conditions and the following disclaimer in the 13245052Sdteske# documentation and/or other materials provided with the distribution. 14245052Sdteske# 15245052Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16245052Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE 17245052Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18245052Sdteske# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19245052Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20245052Sdteske# DAMAGES (INLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21245052Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22245052Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23245052Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24245052Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25245052Sdteske# SUCH DAMAGE. 26245052Sdteske# 27245052Sdteske# $FreeBSD: head/usr.sbin/bsdconfig/share/script.subr 252743 2013-07-05 01:37:35Z dteske $ 28245052Sdteske# 29245052Sdteske############################################################ INCLUDES 30245052Sdteske 31245052SdteskeBSDCFG_SHARE="/usr/share/bsdconfig" 32245052Sdteske. $BSDCFG_SHARE/common.subr || exit 1 33245052Sdteskef_dprintf "%s: loading includes..." script.subr 34247280Sdteskef_include $BSDCFG_SHARE/device.subr 35247280Sdteskef_include $BSDCFG_SHARE/media/any.subr 36247280Sdteskef_include $BSDCFG_SHARE/media/tcpip.subr 37252743Sdteskef_include $BSDCFG_SHARE/mustberoot.subr 38250323Sdteskef_include $BSDCFG_SHARE/packages/packages.subr 39251996Sdteskef_include $BSDCFG_SHARE/variable.subr 40245052Sdteske 41245052Sdteske############################################################ GLOBALS 42245052Sdteske 43245052SdteskeRESWORDS= 44245052Sdteske 45245052Sdteske############################################################ FUNCTIONS 46245052Sdteske 47245052Sdteske# f_resword_new $resword $function 48245052Sdteske# 49245052Sdteske# Create a new `reserved' word for scripting purposes. Reswords call pre- 50245052Sdteske# defined functions but differ from those functions in the following ways: 51245052Sdteske# 52245052Sdteske# + Reswords do not take arguments but instead get all their data from 53245052Sdteske# the environment variable namespace. 54245052Sdteske# + Unless noError is set (must be non-NULL), if calling the resword 55245052Sdteske# results in failure, the application will terminate prematurely. 56245052Sdteske# + noError is unset after each/every resword is called. 57245052Sdteske# 58245052Sdteske# Reswords should not be used in bsdconfig itself (hence the name `reserved 59245052Sdteske# word') but instead only in scripts loaded through f_script_load()). 60245052Sdteske# 61245052Sdteskef_resword_new() 62245052Sdteske{ 63245052Sdteske local resword="$1" func="$2" 64245052Sdteske [ "$resword" ] || return $FAILURE 65245052Sdteske f_dprintf "script.subr: New resWord %s -> %s" "$resword" "$func" 66245052Sdteske eval $resword\(\){ f_dispatch $func $resword\; } 67245052Sdteske RESWORDS="$RESWORDS${RESWORDS:+ }$resword" 68245052Sdteske} 69245052Sdteske 70245052Sdteske# f_dispatch $func [$resword] 71245052Sdteske# 72245052Sdteske# Wrapper function used by `reserved words' (reswords) to call other functions. 73245052Sdteske# If $noError is set and non-NULL, a failure result from $func is ignored, 74245052Sdteske# otherwise the application is prematurely terminated using f_die(). 75245052Sdteske# 76245052Sdteske# NOTE: $noError is unset after every call. 77245052Sdteske# 78245052Sdteskef_dispatch() 79245052Sdteske{ 80245052Sdteske local func="$1" resword="${2:-$1}" 81245052Sdteske f_dprintf "f_dispatch: calling resword \`%s'" "$resword" 82245052Sdteske eval $func 83247280Sdteske local retval=$? 84247280Sdteske if [ $retval -ne $SUCCESS ]; then 85247280Sdteske local _ignore_this_error 86247280Sdteske f_getvar $VAR_NO_ERROR _ignore_this_error 87245052Sdteske [ "$_ignore_this_error" ] || f_die $retval \ 88247280Sdteske "$msg_command_failed_rest_of_script_aborted" "$resword" 89247280Sdteske fi 90245052Sdteske unset $VAR_NO_ERROR 91245052Sdteske} 92245052Sdteske 93245052Sdteske# f_script_load [$file] 94245052Sdteske# 95245052Sdteske# Load a script (usually filled with reswords). If $file is missing or NULL, 96245052Sdteske# use one of the following instead (in order): 97245052Sdteske# 98245052Sdteske# $configFile 99245052Sdteske# install.cfg 100245052Sdteske# /stand/install.fg 101245052Sdteske# /tmp/install.cfg 102245052Sdteske# 103245052Sdteske# Unknown/unregistered reswords will generate sh(1) syntax errors but not cause 104245052Sdteske# premature termination. 105245052Sdteske# 106245052Sdteske# Returns success if a script was loaded and itself returned success. 107245052Sdteske# 108245052Sdteskef_script_load() 109245052Sdteske{ 110245695Sdteske local script="$1" config_file retval=$SUCCESS 111245052Sdteske 112245052Sdteske f_dprintf "f_script_load: script=[%s]" "$script" 113245052Sdteske if [ ! "$script" ]; then 114245052Sdteske f_getvar $VAR_CONFIG_FILE config_file 115245052Sdteske for script in \ 116245052Sdteske $config_file \ 117245052Sdteske install.cfg \ 118245052Sdteske /stand/install.cfg \ 119245052Sdteske /tmp/install.cfg \ 120245052Sdteske ; do 121245052Sdteske [ -e "$script" ] && break 122245052Sdteske done 123245695Sdteske fi 124245695Sdteske 125245695Sdteske local old_interactive= 126245695Sdteske f_getvar $VAR_NONINTERACTIVE old_interactive # save a copy 127245695Sdteske 128245695Sdteske # Hint to others that we're running from a script, should they care 129245695Sdteske setvar $VAR_NONINTERACTIVE yes 130245695Sdteske 131245695Sdteske if [ "$script" = "-" ]; then 132245052Sdteske f_dprintf "f_script_load: Loading script from stdin" 133245052Sdteske eval "$( cat )" 134245695Sdteske retval=$? 135245052Sdteske else 136245052Sdteske f_dprintf "f_script_load: Loading script \`%s'" "$script" 137245052Sdteske if [ ! -e "$script" ]; then 138245052Sdteske f_show_msg "$msg_unable_to_open" "$script" 139245052Sdteske return $FAILURE 140245052Sdteske fi 141245052Sdteske . "$script" 142245695Sdteske retval=$? 143245052Sdteske fi 144245695Sdteske 145245695Sdteske [ "$old_interactive" ] && 146245695Sdteske setvar $VAR_NONINTERACTIVE "$old_interactive" 147245695Sdteske 148245695Sdteske return $retval 149245052Sdteske} 150245052Sdteske 151245052Sdteske############################################################ MAIN 152245052Sdteske 153245052Sdteske# 154245052Sdteske# Reserved words meant for scripting 155245052Sdteske# 156250318Sdteske 157250318Sdteske# this file 158250318Sdteskef_resword_new loadConfig f_script_load 159250318Sdteske 160250318Sdteske# device.subr 161250318Sdteskef_resword_new deviceRescan f_device_rescan 162250318Sdteske 163250318Sdteske# media/common.subr 164250318Sdteskef_resword_new mediaOpen f_media_open 165250318Sdteskef_resword_new mediaClose f_media_close 166250318Sdteske 167250318Sdteske# media includes 168250318Sdteskef_resword_new mediaGetType f_media_get_type # media/any.subr 169250318Sdteskef_resword_new mediaSetCDROM f_media_set_cdrom # media/cdrom.subr 170250318Sdteskef_resword_new mediaSetDOS f_media_set_dos # media/dos.subr 171250318Sdteskef_resword_new mediaSetDirectory f_media_set_directory # media/directory.subr 172250318Sdteskef_resword_new mediaSetFloppy f_media_set_floppy # media/floppy.subr 173250318Sdteskef_resword_new mediaSetNFS f_media_set_nfs # media/nfs.subr 174250318Sdteskef_resword_new mediaSetUFS f_media_set_ufs # media/ufs.subr 175250318Sdteskef_resword_new mediaSetUSB f_media_set_usb # media/usb.subr 176250318Sdteskef_resword_new optionsEditor f_media_options_menu # media/options.subr 177250318Sdteskef_resword_new tcpMenuSelect f_dialog_menu_select_tcp # media/tcp.subr 178250318Sdteske 179250318Sdteske# media/ftp.subr 180247280Sdteskef_resword_new mediaSetFTP f_media_set_ftp 181247280Sdteskef_resword_new mediaSetFTPActive f_media_set_ftp_active 182247280Sdteskef_resword_new mediaSetFTPPassive f_media_set_ftp_passive 183247280Sdteskef_resword_new mediaSetFTPUserPass f_media_set_ftp_userpass 184245052Sdteske 185252112Sdteske# media/http.subr 186252112Sdteskef_resword_new mediaSetHTTP f_media_set_http 187252112Sdteske 188250318Sdteske# media/httpproxy.subr 189250318Sdteskef_resword_new mediaSetHTTPProxy f_media_set_http_proxy 190250318Sdteske 191250323Sdteske# packages/packages.subr 192250323Sdteskef_resword_new configPackages f_package_config 193250323Sdteske 194251997Sdteske# variable.subr 195251997Sdteskef_resword_new installVarDefaults f_variable_set_defaults 196251997Sdteskef_resword_new dumpVariables f_dump_variables 197251997Sdteske 198245052Sdteskef_dprintf "%s: Successfully loaded." script.subr 199245052Sdteske 200245052Sdteskefi # ! $_SCRIPT_SUBR 201