nfs.subr revision 247280 
1if [ ! "$_MEDIA_NFS_SUBR" ]; then _MEDIA_NFS_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 (INLUDING, 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/nfs.subr 247280 2013-02-25 19:55:32Z dteske $
28#
29############################################################ INCLUDES
30
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_dprintf "%s: loading includes..." media/nfs.subr
34f_include $BSDCFG_SHARE/struct.subr
35f_include $BSDCFG_SHARE/device.subr
36f_include $BSDCFG_SHARE/dialog.subr
37f_include $BSDCFG_SHARE/variable.subr
38f_include $BSDCFG_SHARE/media/common.subr
39f_include $BSDCFG_SHARE/media/tcpip.subr
40f_include $BSDCFG_SHARE/media/network.subr
41
42BSDCFG_LIBE="/usr/libexec/bsdconfig"
43f_include_lang $BSDCFG_LIBE/include/messages.subr
44
45############################################################ GLOBALS
46
47NFS_MOUNTED=
48
49############################################################ FUNCTIONS
50
51# f_media_set_nfs
52#
53# Return success if we both found and set the media type to be an NFS server.
54# Variables from variable.subr that can be used to script user input:
55#
56# 	VAR_NFS_PATH
57# 		The NFS path specification (host:path) to use when mounting the
58# 		remote repository.
59# 	VAR_NAMESERVER [Optional]
60# 		Automatically populated from resolv.conf(5) but can be
61# 		overridden. If set, the host portion of VAR_NFS_PATH is
62# 		looked up using f_host_lookup() from `tcpip.subr'.
63#
64# Meanwhile, the following variables from variable.subr are set after
65# successful execution:
66#
67# 	VAR_NFS_HOST
68# 		The host portion of the NFS path specification, parsed from
69# 		VAR_NFS_PATH.
70#
71f_media_set_nfs()
72{
73	local nfs
74
75	f_media_close
76
77	f_variable_get_value $VAR_NFS_PATH \
78		"$msg_please_enter_the_full_nfs_file_specification"
79	f_getvar $VAR_NFS_PATH nfs
80	[ "$nfs" ] || return $FAILURE
81
82	case "$nfs" in
83	*:*) : valid NFS path ;;
84	*)
85		f_dialog_msgbox "$msg_invalid_nfs_path_specification"
86		return $FAILURE
87	esac
88
89	f_struct_new DEVICE device_nfs
90	device_nfs set name "$nfs"
91
92	if ! f_struct device_network ||
93	   ! f_dialog_yesno "$msg_youve_already_done_the_network_configuration"
94	then
95		f_struct device_network &&
96			f_device_shutdown network
97		f_device_select_tcp || return $FAILURE
98		local dev
99		f_getvar $VAR_NETWORK_DEVICE dev
100		f_struct_copy "device_$dev" device_network
101	fi
102	f_device_init network ||
103		f_dprintf "%s: $msg_net_device_init_failed\n" f_media_set_nfs
104
105	local hostname="${nfs%%:*}"
106	if f_quietly f_getvar $VAR_NAMESERVER && ! {
107		f_validate_ipaddr "$hostname" ||
108		f_validate_ipaddr6 "$hostname"
109	}; then
110		f_show_info "$msg_looking_up_host" "$hostname"
111		f_dprintf "%s Looking up hostname, %s, using host(1)" \
112		          "f_media_set_nfs" "$hostname"
113		if ! f_quietly f_host_lookup "$hostname"; then
114			f_show_msg "$msg_cannot_resolve_hostname" "$hostname"
115			f_struct device_network &&
116				f_device_shutdown network
117			f_struct_free device_network
118			unset $VAR_NFS_PATH
119			return $FAILURE
120		fi
121		f_dprintf "Found DNS entry for %s successfully." "$hostname"
122	fi
123
124	setvar $VAR_NFS_HOST "$hostname"
125
126	device_nfs set type     $DEVICE_TYPE_NFS
127	device_nfs set init     f_media_init_nfs
128	device_nfs set get      f_media_get_nfs
129	device_nfs set shutdown f_media_shutdown_nfs
130	device_nfs set private  device_network # in name only (deref'd later)
131
132	f_struct_copy device_nfs device_media
133	f_struct_free device_nfs
134
135	return $SUCCESS
136}
137
138# f_media_init_nfs $device
139#
140# Initializes the NFS media device. Returns success if able to mount the NFS
141# device using mount_nfs(1).
142#
143# The variables (from variable.subr) used to initialize the NFS mount are as
144# follows (all of which are configured manually/optionally from the options
145# menu):
146#
147# 	VAR_NFS_TCP [Optional]
148# 		If non-NULL, adds the "tcp" option via `-o' to mount_nfs(8).
149# 	VAR_NFS_V3 [Optional]
150# 		If non-NULL, adds the "nfsv3" option via `-o' to mount_nfs(8).
151# 	VAR_NFS_SECURE [Optional]
152# 		If non-NULL, adds the "-P" flag to mount_nfs(8).
153# 	VAR_SLOW_ETHER [Optional]
154# 		If non-NULL, adjusts the read/write size to avoid timeouts.
155#
156f_media_init_nfs()
157{
158	local dev="$1" name err
159
160	device_$dev get name name || return $FAILURE
161	f_dprintf "Init routine called for NFS device. name=[%s]" \
162	          "$name"
163
164	if [ "$NFS_MOUNTED" ]; then
165		f_dprintf "NFS device already mounted."
166		return $SUCCESS
167	fi
168
169	if ! f_device_init network; then
170		f_dprintf "f_media_init_nfs: %s" "$msg_net_device_init_failed"
171		return $FAILURE
172	fi
173
174	if [ ! -e "$MOUNTPOINT" ] &&
175	   ! err=$( mkdir -p "$MOUNTPOINT" 2>&1 )
176	then
177		f_dialog_msgbox "$err"
178		return $FAILURE
179	fi
180
181	local cp tcp="" use3="" secure="" readsize=4096 writesize=4096
182	f_getvar $VAR_NFS_TCP cp
183	[ "$cp" = "YES" ] && tcp=1
184	f_getvar $VAR_NFS_V3 cp
185	[ "$cp" = "YES" ] && use3=1
186	f_getvar $VAR_NFS_SECURE cp
187	[ "$cp" = "YES" ] && secure=1
188	f_getvar $VAR_SLOW_ETHER cp
189	[ "$cp" = "YES" ] && readsize=1024 writesize=1024
190
191	local options="rsize=$readsize,wsize=$writesize"
192	[ "$use3" ] && options="$options,nfsv3"
193	[ "$tcp" ] && options="$options,tcp"
194
195	if ! err=$( mount_nfs \
196		${secure:+-P} -o "$options" "$name" "$MOUNTPOINT" 2>&1 )
197	then
198		err="${err#mount_nfs: }"
199		f_show_msg "$msg_error_mounting_device" \
200		           "$name" "$MOUNTPOINT" "$err"
201		f_struct device_network &&
202			f_device_shutdown network
203		return $FAILURE
204	fi
205	NFS_MOUNTED=1
206
207	f_dprintf "Mounted NFS device %s onto %s" "$name" "$MOUNTPOINT"
208
209	return $SUCCESS
210}
211
212# f_media_get_nfs $device $file [$probe_only]
213#
214# Returns data from $file on a mounted NFS device. Similar to cat(1).
215# $probe_only is currently unused by this media type.
216#
217f_media_get_nfs()
218{
219	local dev="$1" file="$2" probe_only="$3"
220
221	f_dprintf "f_media_get_nfs: dev=[%s] file=[%s] probe_only=%s" \
222	          "$dev" "$file" "$probe_only"
223
224	f_media_generic_get "$MOUNTPOINT" "$file"
225}
226
227# f_media_shutdown_nfs $device
228#
229# Shuts down the NFS device using umount(8). Return status should be ignored.
230#
231f_media_shutdown_nfs()
232{
233	local dev="$1" err
234
235	[ "$NFS_MOUNTED" ] || return
236
237	f_dprintf "Unmounting NFS partition on %s" "$MOUNTPOINT"
238	if ! err=$( umount -f "$MOUNTPOINT" 2>&1 ); then
239		err="${err#umount: }"; err="${err#*: }"
240		f_show_msg "$msg_could_not_unmount_the_nfs_partition" \
241		           "$MOUNTPOINT" "$err"
242	else
243		NFS_MOUNTED=
244	fi
245}
246
247############################################################ MAIN
248
249f_dprintf "%s: Successfully loaded." media/nfs.subr
250
251fi # ! $_MEDIA_NFS_SUBR
252