1 if [ ! "$_MEDIA_DIRECTORY_SUBR" ]; then _MEDIA_DIRECTORY_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..." media/directory.subr
34 f_include $BSDCFG_SHARE/device.subr
35 f_include $BSDCFG_SHARE/dialog.subr
36 f_include $BSDCFG_SHARE/media/common.subr
37 f_include $BSDCFG_SHARE/struct.subr
38 f_include $BSDCFG_SHARE/variable.subr
40 BSDCFG_LIBE="/usr/libexec/bsdconfig"
41 f_include_lang $BSDCFG_LIBE/include/messages.subr
43 ############################################################ GLOBALS
47 ############################################################ FUNCTIONS
49 # f_media_set_directory
51 # Return success if we both found and set the media type to be a local
54 # Variables from variable.subr that can be used to script user input:
57 # Path to an existing directory containing the FreeBSD
60 f_media_set_directory()
66 f_variable_get_value $VAR_DIRECTORY_PATH \
67 "$msg_enter_a_fully_qualified_pathname_for_the_directory"
68 f_getvar $VAR_DIRECTORY_PATH path
69 [ "$path" ] || return $FAILURE
71 f_struct_new DEVICE device_directory
72 device_directory set name "$path"
73 device_directory set get f_media_get_directory
74 device_directory set init f_media_init_directory
75 device_directory set shutdown f_media_shutdown_directory
76 device_directory set private "$path"
78 f_struct_copy device_directory device_media
79 f_struct_free device_directory
81 f_struct device_media || return $FAILURE
84 # f_media_init_directory $device
86 # Initializes the Directory media device. Returns success if the directory path
87 # both exists and is a directory.
89 f_media_init_directory()
93 $dev get private path || return $FAILURE
94 f_dprintf "Init routine called for Directory device. path=[%s]" \
97 # Track whether we've been through here before (for remote filesystems
98 # mounted in the directory path, not repeating these queries saves us
99 # valuable time for slow/uncooperative links).
100 if [ "$DIRECTORY_CHECKED" ]; then
101 f_dprintf "Directory device already checked."
105 if [ ! -e "$path" ]; then
106 f_show_msg "$msg_no_such_file_or_directory" \
107 "f_media_init_directory" "$path"
109 elif [ ! -d "$path" ]; then
110 f_show_msg "$msg_not_a_directory" \
111 "f_media_init_directory" "$path"
118 # f_media_get_directory $device $file [$probe_type]
120 # Returns data from $file in the existing/current filesystem. Similar to
121 # cat(1). If $probe_type is present and non-NULL, returns success if $file
122 # exists. If $probe_type is equal to $PROBE_SIZE, prints the size of $file in
123 # bytes to standard-out.
125 f_media_get_directory()
127 local dev="$1" file="$2" probe_type="$3" path
131 f_dprintf "f_media_get_directory: dev=[%s] file=[%s] probe_type=%s" \
132 "$name" "$file" "$probe_type"
134 $dev get private path
135 f_media_generic_get "$path" "$file" "$probe_type"
138 # f_media_shutdown_directory $device
140 # Shuts down the Directory device. Return status should be ignored.
142 f_media_shutdown_directory()
147 ############################################################ MAIN
149 f_dprintf "%s: Successfully loaded." media/directory.subr
151 fi # ! $_MEDIA_DIRECTORY_SUBR