routing.subr revision 244548 
1if [ ! "$_NETWORKING_ROUTING_SUBR" ]; then _NETWORKING_ROUTING_SUBR=1
2#
3# Copyright (c) 2006-2012 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/networking/share/routing.subr 244548 2012-12-21 18:58:19Z dteske $
28#
29############################################################ INCLUDES
30
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_include $BSDCFG_SHARE/sysrc.subr
34f_include $BSDCFG_SHARE/dialog.subr
35f_include $BSDCFG_SHARE/networking/common.subr
36f_include $BSDCFG_SHARE/networking/ipaddr.subr
37
38BSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="120.networking"
39f_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
40
41############################################################ FUNCTIONS
42
43# f_route_get_default
44#
45# Returns the IP address of the currently active default router.
46#
47f_route_get_default()
48{
49	route -n get default 2> /dev/null | awk \
50	'
51		BEGIN { found = 0 }
52		( $1 == "gateway:" ) \
53		{
54			print $2
55			found = 1
56			exit
57		}
58		END { exit ! found }
59	'
60}
61
62# f_dialog_input_defaultrouter
63#
64# Edits the default router.
65#
66f_dialog_input_defaultrouter()
67{
68	#
69	# Get the defaultrouter. When this is not configured, the default is
70	# "NO", however we don't ever want to present this default to the user
71	# in the following dialog. If the current value is "NO", then try to
72	# obtain the value from the running system using route(8).
73	#
74	# NOTE: Our `f_route_get_default' function will return NULL if the
75	# system does not have an active default router set (which is what we
76	# want).
77	#
78	local defaultrouter="$( f_sysrc_get 'defaultrouter:-NO' )"
79	local defaultrouter_orig="$defaultrouter" # for change-tracking
80	case "$defaultrouter" in
81	[Nn][Oo])
82		defaultrouter=$( f_route_get_default )
83		;;
84	esac
85
86	#
87	# Return with-error when there are NFS-mounts currently active. If the
88	# default router/gateway is changed while NFS-exported directories are
89	# mounted, the system will hang.
90	#
91	if f_nfs_mounted && ! f_jailed; then
92		local setting="$( printf "$msg_current_default_router" \
93		                         "$defaultrouter" )"
94		local message="$( printf "$msg_nfs_mounts_may_cause_hang" \
95		                         "$setting" )"
96		f_dialog_msgbox "$message"
97		return $FAILURE
98	fi
99
100	#
101	# Loop until the user provides taint-free input.
102	#
103	local retval
104	while :; do
105		defaultrouter=$( f_dialog_input \
106			"$msg_please_enter_default_router" \
107			"$defaultrouter" "$hline_num_punc_tab_enter"
108		)
109		retval=$?
110		[ "$defaultrouter" ] || return $SUCCESS
111		[ $retval -eq $SUCCESS ] || return $retval
112
113		# Taint-check the user's input
114		f_dialog_validate_ipaddr "$defaultrouter" && break
115	done
116
117	#
118	# Save only if the user changed the default router/gateway.
119	#
120	if [ "$defaultrouter" != "$defaultrouter_orig" ]; then
121		f_dialog_info "$msg_saving_default_router"
122
123		# Save the default router/gateway
124		f_sysrc_set defaultrouter "$defaultrouter"
125	fi
126
127	#
128	# Only ask to apply setting if the current defaultrouter is different
129	# than the stored configuration (in rc.conf(5)).
130	#
131	if [ "$( f_route_get_default )" != "$defaultrouter" ]; then
132		f_dialog_clear
133		f_dialog_yesno "$(
134			printf "$msg_activate_default_router" \
135			       "$( f_route_get_default )" "$defaultrouter"
136		)"
137
138		if [ $? -eq $SUCCESS ]; then
139			local err
140
141			# Apply the default router/gateway
142			f_quietly route delete default
143			err=$( route add default "$defaultrouter" 2>&1 )
144			if [ $? -ne $SUCCESS ]; then
145				f_dialog_msgbox "$err"
146				return $FAILURE
147			fi
148		fi
149	fi
150}
151
152fi # ! $_NETWORKING_ROUTING_SUBR
153