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