freebsd-dev/usr.sbin/bsdconfig/share/media/directory.subr
Devin Teske 7323adac99 Import media selection/preparation framework (sysinstall inspired). Makes
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.
2013-02-25 19:55:32 +00:00

147 lines
4.5 KiB
Plaintext

if [ ! "$_MEDIA_DIRECTORY_SUBR" ]; then _MEDIA_DIRECTORY_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..." media/directory.subr
f_include $BSDCFG_SHARE/struct.subr
f_include $BSDCFG_SHARE/device.subr
f_include $BSDCFG_SHARE/dialog.subr
f_include $BSDCFG_SHARE/variable.subr
f_include $BSDCFG_SHARE/media/common.subr
BSDCFG_LIBE="/usr/libexec/bsdconfig"
f_include_lang $BSDCFG_LIBE/include/messages.subr
############################################################ GLOBALS
DIRECTORY_CHECKED=
############################################################ FUNCTIONS
# f_media_set_directory
#
# Return success if we both found and set the media type to be a local
# directory.
#
# Variables from variable.subr that can be used to script user input:
#
# VAR_DIRECTORY_PATH
# Path to an existing directory containing the FreeBSD
# distribution files.
#
f_media_set_directory()
{
local path
f_media_close
f_variable_get_value $VAR_DIRECTORY_PATH \
"$msg_enter_a_fully_qualified_pathname_for_the_directory"
f_getvar $VAR_DIRECTORY_PATH path
[ "$path" ] || return $FAILURE
f_struct_new DEVICE device_directory
device_directory set get f_media_get_directory
device_directory set init f_media_init_directory
device_directory set shutdown f_media_shutdown_directory
device_directory set private "$path"
f_struct_copy device_directory device_media
f_struct_free device_directory
f_struct device_media || return $FAILURE
}
# f_media_init_directory $device
#
# Initializes the Directory media device. Returns success if the directory path
# both exists and is a directory.
#
f_media_init_directory()
{
local dev="$1" path
device_$dev get private path || return $FAILURE
f_dprintf "Init routine called for Directory device. path=[%s]" \
"$path"
# Track whether we've been through here before (for remote filesystems
# mounted in the directory path, not repeating these queries saves us
# valuable time for slow/uncooperative links).
if [ "$DIRECTORY_CHECKED" ]; then
f_dprintf "Directory device already checked."
return $SUCCESS
fi
if [ ! -e "$path" ]; then
f_show_msg "$msg_no_such_file_or_directory" \
"f_media_init_directory" "$path"
return $FAILURE
elif [ ! -d "$path" ]; then
f_show_msg "$msg_not_a_directory" \
"f_media_init_directory" "$path"
return $FAILURE
fi
DIRECTORY_CHECKED=1
return $SUCCESS
}
# f_media_get_directory $device $file [$probe_only]
#
# Returns data from $file in the existing/current filesystem. Similar to
# cat(1). $probe_only is currently unused by this media type.
#
f_media_get_directory()
{
local dev="$1" file="$2" probe_only="$3" path
f_dprintf "f_media_get_directory: dev=[%s] file=[%s] probe_only=%s" \
"$dev" "$file" "$probe_only"
device_$dev get private path
f_media_generic_get "$path" "$file"
}
# f_media_shutdown_directory $device
#
# Shuts down the Directory device. Return status should be ignored.
#
f_media_shutdown_directory()
{
DIRECTORY_CHECKED=
}
############################################################ MAIN
f_dprintf "%s: Successfully loaded." media/directory.subr
fi # ! $_MEDIA_DIRECTORY_SUBR