common.subr revision 253333 
1if [ ! "$_MEDIA_COMMON_SUBR" ]; then _MEDIA_COMMON_SUBR=1
2#
3# Copyright (c) 2012-2013 Devin Teske
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions
8# are met:
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.
14#
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
25# SUCH DAMAGE.
26#
27# $FreeBSD: head/usr.sbin/bsdconfig/share/media/common.subr 253333 2013-07-14 03:08:52Z dteske $
28#
29############################################################ INCLUDES
30
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_dprintf "%s: loading includes..." media/common.subr
34f_include $BSDCFG_SHARE/device.subr
35f_include $BSDCFG_SHARE/media/any.subr
36f_include $BSDCFG_SHARE/struct.subr
37
38############################################################ GLOBALS
39
40#
41# Where to mount media
42#
43MOUNTPOINT=/dist
44
45#
46# Media probe values to use for `f_media_get_TYPE media $file $PROBE' or
47# `f_device_get media $file $PROBE' (where $PROBE is one of the below values).
48#
49PROBE_EXIST=1
50PROBE_SIZE=2
51
52############################################################ FUNCTIONS
53
54# f_media_open
55#
56# Returms success if able to initialize the media device.
57#
58f_media_open()
59{
60	f_dprintf "f_media_open: Verifying and initiliazing media device"
61	{ # Verify and initialize device media if-defined
62		f_struct device_media &&
63		f_media_verify &&
64		f_device_init media
65	} || return $FAILURE
66}
67
68# f_media_close
69#
70# Shuts down the media device, see f_device_shutdown() from device.subr for
71# more details.
72#
73f_media_close()
74{
75	f_dprintf "f_media_close: Shutting down media device"
76	f_struct device_media &&
77		f_device_shutdown media
78	f_struct_free device_media
79}
80
81# f_media_verify
82#
83# Returns success if the media device is available, and if not, prompts the
84# user to select a media type. See f_media_get_type() from media/any.subr for
85# more details.
86#
87f_media_verify()
88{
89	f_dprintf "f_media_verify: Verifying media device"
90	f_struct device_media || f_media_get_type
91}
92
93# f_media_generic_get $base $file [$probe_type]
94#
95# A generic open which follows a well-known "path" of places to look. If
96# $probe_type is present and non-NULL, returns success if $file exists. If
97# $probe_type is equal to $PROBE_SIZE, prints the size of $file in bytes to
98# standard-out.
99# 
100f_media_generic_get()
101{
102	local base="$1" file="$2" probe_type="$3"
103
104	local fname=f_media_generic_get
105	f_dprintf "%s: base=[%s] files=[%s] probe_type=%s" \
106	          $fname "$base" "$file" "$probe_type"
107
108	local rel path
109	f_getvar $VAR_RELNAME rel
110	for path in \
111		"$base/$file" \
112		"$base/FreeBSD/$file" \
113		"$base/releases/$file" \
114		"$base/$rel/$file" \
115	; do
116		if [ -f "$path" -a -r "$path" ]; then
117			f_dprintf "%s: file exists path=[%s]" $fname "$path"
118			if [ "$probe_type" = "$PROBE_SIZE" ]; then
119				local size
120				if ! size=$( stat -f %z "$path" 2>&1 ); then
121					f_dprintf "stat: %s" "$size"
122					echo "-1"
123				else
124					f_isinteger "$size" || size=-1
125					echo $size
126				fi
127			fi
128			[ "$probe_type" ] && return $SUCCESS
129			cat "$path"
130			return
131		fi
132	done
133
134	path="$base/releases/$rel/$file" # Final path to try
135	if [ -f "$path" -a -r "$path" ]; then
136		f_dprintf "%s: file exists path=[%s]" $fname "$path"
137		if [ "$probe_type" = "$PROBE_SIZE" ]; then
138			local size
139			if ! size=$( stat -f %z "$path" 2>&1 ); then
140				f_dprintf "stat: %s" "$size"
141				echo "-1"
142			else
143				f_isinteger "$size" || size=-1
144				echo $size
145			fi
146		fi
147		[ "$probe_type" ] && return $SUCCESS
148	elif [ "$probe_type" ]; then
149		[ "$probe_type" = "$PROBE_SIZE" ] && echo "-1"
150		return $FAILURE
151	fi
152	cat "$base/releases/$rel/$file" # Final path to try
153}
154
155############################################################ MAIN
156
157f_dprintf "%s: Successfully loaded." media/common.subr
158
159fi # ! $_MEDIA_COMMON_SUBR
160