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.

1 files changed, 174 insertions, 0 deletions

diff --git a/usr.sbin/bsdconfig/share/media/usb.subr b/usr.sbin/bsdconfig/share/media/usb.subr
new file mode 100644
index 0000000..c7fc973
--- /dev/null
+++ b/usr.sbin/bsdconfig/share/media/usb.subr
@@ -0,0 +1,174 @@
+if [ ! "$_MEDIA_USB_SUBR" ]; then _MEDIA_USB_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/usb.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
+
+USB_MOUNTED=
+
+############################################################ FUNCTIONS
+
+# f_media_set_usb
+#
+# Attempt to use USB as the media type. Return success if we both found and set
+# the media type to be a USB drive.
+#
+f_media_set_usb()
+{
+	f_media_close
+
+	local devs ndevs
+	f_device_find "" $DEVICE_TYPE_USB devs
+	ndevs=$( set -- $devs; echo $# )
+
+	if [ ${ndevs:=0} -eq 0 ]; then
+		f_dialog_msgbox "$msg_no_usb_devices_found"
+		return $FAILURE
+	elif [ $ndevs -gt 1 ]; then
+		local title="$msg_choose_a_usb_drive"
+		local prompt="$msg_please_select_a_usb_drive"
+		local hline=""
+
+		local dev retval
+		dev=$( f_device_menu \
+			"$title" "$prompt" "$hline" $DEVICE_TYPE_USB \
+			2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD )
+		retval=$?
+		[ "$dev" ] || return $FAILURE
+
+		f_device_find "$dev" $DEVICE_TYPE_USB devs
+		[ "$devs" ] || return $FAILURE
+		dev="${devs%%[$IFS]*}"
+
+		f_struct_copy device_$dev device_media
+		[ $retval -eq $SUCCESS ] || return $FAILURE
+	else
+		f_struct_copy device_$devs device_media
+	fi
+
+	f_struct device_media &&
+		device_media unset private
+
+	if f_interactive; then
+		local name
+		f_struct device_media get name name
+		f_show_msg "$msg_using_usb_device" "$name"
+	fi
+
+	f_struct device_media || return $FAILURE
+}
+
+# f_media_init_usb $device
+#
+# Initializes the USB media device. Returns success if able to mount the USB
+# disk device using mount(8).
+#
+f_media_init_usb()
+{
+	local dev="$1" devname err
+
+	device_$dev get devname devname || return $FAILURE
+	f_dprintf "Init routine called for USB device. devname=[%s]" \
+	          "$devname"
+
+	if [ "$USB_MOUNTED" ]; then
+		f_dprintf "USB device already mounted."
+		return $SUCCESS
+	fi
+
+	if [ ! -e "$MOUNTPOINT" ] &&
+	   ! err=$( mkdir -p "$MOUNTPOINT" 2>&1 )
+	then
+		f_dialog_msgbox "$err"
+		return $FAILURE
+	fi
+
+	if err=$( mount "$devname" "$MOUNTPOINT" 2>&1 ); then
+		USB_MOUNTED=1
+		return $SUCCESS
+	fi
+
+	err="${err#mount: }"; err="${err#$devname: }"
+	f_show_msg "$msg_error_mounting_usb_drive" \
+	           "$devname" "$MOUNTPOINT" "$err"
+	return $FAILURE
+}
+
+# f_media_get_usb $device $file [$probe_only]
+#
+# Returns data from $file on a mounted USB disk device. Similar to cat(1).
+# $probe_only is currently unused by this media type.
+#
+f_media_get_usb()
+{
+	local dev="$1" file="$2" probe_only="$3"
+
+	f_dprintf "f_media_get_usb: dev=[%s] file=[%s] probe_only=%s" \
+	          "$dev" "$file" "$probe_only"
+
+	f_media_generic_get "$MOUNTPOINT" "$file"
+}
+
+# f_media_shutdown_usb $device
+#
+# Shuts down the USB disk device using umount(8). Return status should be
+# ignored.
+#
+f_media_shutdown_usb()
+{
+	local dev="$1" err
+
+	[ "$USB_MOUNTED" ] || return
+
+	if ! err=$( umount -f "$MOUNTPOINT" 2>&1 ); then
+		err="${err#umount: }"; err="${err#*: }"
+		f_show_msg "$msg_could_not_unmount_the_ufs_partition" \
+		           "$MOUNTPOINT" "$err"
+	else
+		USB_MOUNTED=
+	fi
+}
+
+############################################################ MAIN
+
+f_dprintf "%s: Successfully loaded." media/usb.subr
+
+fi # ! $_MEDIA_USB_SUBR