1f658c88be
accessing files from various types of media nice and abstracted away from the wet-work involved in preparing, validating, and initializing those types of media. This will be used for the package management system module and other modules that need access to files and want to allow the user to decide where those files come from (either in a scripted fashion, prompted fashion, or any combination thereof). Heavily inspired by sysinstall and even uses the same reserved words so that scripts are portable. Coded over months, tested continuously through- out, and reviewed several times. Some notes about the changes: - Move network-setting acquisition/validation routines to media/tcpip.subr - The options screen from sysinstall has been converted to a dialog menu - The "UFS" media choice is renamed to "Directory" to reflect how sysinstall treats the choice and a new [true] "UFS" media choice has been added that acts on real UFS partitions (such as external disks with disklabels). - Many more help files have been resurrected from sysinstall (I noticed that some of the content seems a bit dated; I gave them a once-over but they could really use an update). - A total of 10 media choices are presented (via mediaGetType) including: CD/DVD, FTP, FTP Passive, HTTP Proxy, Directory, NFS, DOS, UFS, Floppy, USB - Novel struct/device management layer for managing the issue of passing more information than can comfortably fit in an argument list.
248 lines
7.8 KiB
Plaintext
248 lines
7.8 KiB
Plaintext
if [ ! "$_VARIABLE_SUBR" ]; then _VARIABLE_SUBR=1
|
|
#
|
|
# Copyright (c) 2012-2013 Devin Teske
|
|
# All Rights Reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions
|
|
# are met:
|
|
# 1. Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# 2. Redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
# DAMAGES (INLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
# SUCH DAMAGE.
|
|
#
|
|
# $FreeBSD$
|
|
#
|
|
############################################################ INCLUDES
|
|
|
|
BSDCFG_SHARE="/usr/share/bsdconfig"
|
|
. $BSDCFG_SHARE/common.subr || exit 1
|
|
f_dprintf "%s: loading includes..." variable.subr
|
|
f_include $BSDCFG_SHARE/dialog.subr
|
|
|
|
############################################################ GLOBALS
|
|
|
|
VARIABLES=
|
|
|
|
#
|
|
# Default behavior is to call f_variable_set_defaults() when loaded.
|
|
#
|
|
: ${VARIABLE_SELF_INITIALIZE=1}
|
|
|
|
#
|
|
# File to write when f_dump_variables() is called.
|
|
#
|
|
: ${VARIABLE_DUMPFILE:=/etc/bsdconfig.vars}
|
|
|
|
############################################################ FUNCTIONS
|
|
|
|
# f_variable_new $handle $variable
|
|
#
|
|
# Register a new variable named $variable with the given reference-handle
|
|
# $handle. The environment variable $handle is set to $variable allowing you to
|
|
# use the f_getvar() function (from common.subr) with $handle to get the value
|
|
# of environment variable $variable. For example:
|
|
#
|
|
# f_variable_new VAR_ABC abc
|
|
#
|
|
# allows the later indirection:
|
|
#
|
|
# f_getvar $VAR_ABC
|
|
#
|
|
# to return the value of environment variable `abc'. Variables registered in
|
|
# this manner are recorded in the $VARIABLES environment variable for later
|
|
# allowing dynamic enumeration of so-called `registered/advertised' variables.
|
|
#
|
|
f_variable_new()
|
|
{
|
|
local handle="$1" variable="$2"
|
|
[ "$handle" ] || return $FAILURE
|
|
f_dprintf "variable.subr: New variable %s -> %s" "$handle" "$variable"
|
|
setvar $handle $variable
|
|
VARIABLES="$VARIABLES${VARIABLES:+ }$handle"
|
|
}
|
|
|
|
# f_variable_get_value $var [ $fmt [ $opts ... ] ]
|
|
#
|
|
# Unless nonInteractive is set, prompt the user with a given value (pre-filled
|
|
# with the value of $var) and give them the chance to change the value.
|
|
#
|
|
# Unlike f_getvar() (from common.subr) which can return a variable to the
|
|
# caller on standard output, this function has no [meaningful] output.
|
|
#
|
|
# Returns success unless $var is either NULL or missing.
|
|
#
|
|
f_variable_get_value()
|
|
{
|
|
local var="$1" cp
|
|
|
|
[ "$var" ] || return $FAILURE
|
|
|
|
if ! { f_getvar $var cp && ! f_interactive; }; then
|
|
shift 1 # var
|
|
cp=$( f_dialog_input "$( printf "$@" )" "$cp" ) &&
|
|
setvar $var "$cp"
|
|
fi
|
|
|
|
return $SUCCESS
|
|
}
|
|
|
|
# f_variable_set_defaults
|
|
#
|
|
# Installs sensible defaults for registered/advertised variables.
|
|
#
|
|
f_variable_set_defaults()
|
|
{
|
|
#
|
|
# Initialize various user-edittable values to their defaults
|
|
#
|
|
setvar $VAR_EDITOR "${EDITOR:-/usr/bin/ee}"
|
|
setvar $VAR_FTP_STATE "passive"
|
|
setvar $VAR_FTP_USER "ftp"
|
|
setvar $VAR_HOSTNAME "$( hostname )"
|
|
setvar $VAR_MEDIA_TIMEOUT "300"
|
|
setvar $VAR_NFS_SECURE "NO"
|
|
setvar $VAR_NFS_TCP "NO"
|
|
setvar $VAR_NFS_V3 "YES"
|
|
setvar $VAR_RELNAME "$UNAME_R"
|
|
|
|
f_dprintf "f_variable_set_defaults: Defaults initialized."
|
|
}
|
|
|
|
# f_dump_variables
|
|
#
|
|
# Dump a list of registered/advertised variables and their respective values to
|
|
# $VARIABLE_DUMPFILE. Returns success unless the file couldn't be written. If
|
|
# an error occurs, it is displayed using f_dialog_msgbox() (from dialog.subr).
|
|
#
|
|
f_dump_variables()
|
|
{
|
|
local err sanitize_awk="{ gsub(/'/, \"'\\\\''\"); print }"
|
|
if ! err=$(
|
|
( for handle in $VARIABLES; do
|
|
f_getvar $handle var || continue
|
|
f_getvar $var value || continue
|
|
value=$( echo "$value" | awk "$sanitize_awk" )
|
|
printf "%s='%s'\n" "$var" "$value"
|
|
done > "$VARIABLE_DUMPFILE" ) 2>&1
|
|
); then
|
|
f_dialog_msgbox "$err"
|
|
return $FAILURE
|
|
fi
|
|
}
|
|
|
|
# f_debugging
|
|
#
|
|
# Are we in debug mode? Returns success if extra DEBUG information has been
|
|
# requested (by setting $debug to non-NULL), otherwise false.
|
|
#
|
|
f_debugging()
|
|
{
|
|
local value
|
|
f_getvar $VAR_DEBUG value && [ "$value" ]
|
|
}
|
|
|
|
# f_interactive()
|
|
#
|
|
# Are we running interactively? Return error if $nonInteractive is set and non-
|
|
# NULL, otherwise return success.
|
|
#
|
|
f_interactive()
|
|
{
|
|
local value
|
|
! f_getvar $VAR_NONINTERACTIVE value || [ ! "$value" ]
|
|
}
|
|
|
|
# f_netinteractive()
|
|
#
|
|
# Has the user specifically requested the network-portion of configuration and
|
|
# setup to be performed interactively? Returns success if the user has asked
|
|
# for the network configuration to be done interactively even if perhaps over-
|
|
# all non-interactive mode has been requested (by setting nonInteractive).
|
|
#
|
|
# Returns success if $netInteractive is set and non-NULL.
|
|
#
|
|
f_netinteractive()
|
|
{
|
|
local value
|
|
f_getvar $VAR_NETINTERACTIVE value && [ "$value" ]
|
|
}
|
|
|
|
############################################################ MAIN
|
|
|
|
#
|
|
# Variables that can be tweaked from config files
|
|
#
|
|
# Handle Variable Name
|
|
f_variable_new VAR_CONFIG_FILE configFile
|
|
f_variable_new VAR_DEBUG debug
|
|
f_variable_new VAR_DEBUG_FILE debugFile
|
|
f_variable_new VAR_DIRECTORY_PATH _directoryPath
|
|
f_variable_new VAR_DOMAINNAME domainname
|
|
f_variable_new VAR_EDITOR editor
|
|
f_variable_new VAR_EXTRAS ifconfig_
|
|
f_variable_new VAR_FTP_DIR ftpDirectory
|
|
f_variable_new VAR_FTP_HOST ftpHost
|
|
f_variable_new VAR_FTP_PASS ftpPass
|
|
f_variable_new VAR_FTP_PATH _ftpPath
|
|
f_variable_new VAR_FTP_PORT ftpPort
|
|
f_variable_new VAR_FTP_STATE ftpState
|
|
f_variable_new VAR_FTP_USER ftpUser
|
|
f_variable_new VAR_GATEWAY defaultrouter
|
|
f_variable_new VAR_HOSTNAME hostname
|
|
f_variable_new VAR_HTTP_FTP_MODE httpFtpMode
|
|
f_variable_new VAR_HTTP_PROXY httpProxy
|
|
f_variable_new VAR_HTTP_PROXY_HOST httpProxyHost
|
|
f_variable_new VAR_HTTP_PROXY_PATH _httpProxyPath
|
|
f_variable_new VAR_HTTP_PROXY_PORT httpProxyPort
|
|
f_variable_new VAR_IFCONFIG ifconfig_
|
|
f_variable_new VAR_IPADDR ipaddr
|
|
f_variable_new VAR_IPV6ADDR ipv6addr
|
|
f_variable_new VAR_IPV6_ENABLE ipv6_activate_all_interfaces
|
|
f_variable_new VAR_MEDIA_TIMEOUT MEDIA_TIMEOUT
|
|
f_variable_new VAR_MEDIA_TYPE mediaType
|
|
f_variable_new VAR_NAMESERVER nameserver
|
|
f_variable_new VAR_NETINTERACTIVE netInteractive
|
|
f_variable_new VAR_NETMASK netmask
|
|
f_variable_new VAR_NETWORK_DEVICE netDev
|
|
f_variable_new VAR_NFS_HOST nfsHost
|
|
f_variable_new VAR_NFS_PATH nfsPath
|
|
f_variable_new VAR_NFS_SECURE nfs_reserved_port_only
|
|
f_variable_new VAR_NFS_TCP nfs_use_tcp
|
|
f_variable_new VAR_NFS_V3 nfs_use_v3
|
|
f_variable_new VAR_NONINTERACTIVE nonInteractive
|
|
f_variable_new VAR_NO_ERROR noError
|
|
f_variable_new VAR_NO_INET6 noInet6
|
|
f_variable_new VAR_RELNAME releaseName
|
|
f_variable_new VAR_SLOW_ETHER slowEthernetCard
|
|
f_variable_new VAR_TRY_DHCP tryDHCP
|
|
f_variable_new VAR_TRY_RTSOL tryRTSOL
|
|
f_variable_new VAR_UFS_PATH ufs
|
|
|
|
#
|
|
# Self-initialize unless requested otherwise
|
|
#
|
|
f_dprintf "%s: VARIABLE_SELF_INITIALIZE=[%s]" \
|
|
variable.subr "$VARIABLE_SELF_INITIALIZE"
|
|
case "$VARIABLE_SELF_INITIALIZE" in
|
|
""|0|[Nn][Oo]|[Oo][Ff][Ff]|[Ff][Aa][Ll][Ss][Ee]) : do nothing ;;
|
|
*) f_variable_set_defaults
|
|
esac
|
|
|
|
f_dprintf "%s: Successfully loaded." variable.subr
|
|
|
|
fi # ! $_VARIABLE_SUBR
|