rcdelete revision 250633 
1#!/bin/sh
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/startup/rcdelete 250633 2013-05-14 03:21:13Z dteske $
28#
29############################################################ INCLUDES
30
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_dprintf "%s: loading includes..." "$0"
34f_include $BSDCFG_SHARE/dialog.subr
35f_include $BSDCFG_SHARE/mustberoot.subr
36f_include $BSDCFG_SHARE/sysrc.subr
37f_include $BSDCFG_SHARE/startup/rcconf.subr
38
39BSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="140.startup"
40f_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
41
42ipgm=$( f_index_menusel_keyword $BSDCFG_LIBE/$APP_DIR/INDEX "$pgm" )
43[ $? -eq $SUCCESS -a "$ipgm" ] && pgm="$ipgm"
44
45############################################################ GLOBALS
46
47#
48# Global map/menu-list for the main menu
49#
50RCCONF_MAP=
51RCCONF_MENU_LIST=
52
53#
54# Options
55#
56# Inherit SHOW_DESC value if set, otherwise default to 1
57[ "${SHOW_DESC+set}" ] || SHOW_DESC=1
58# Selectively inherit SHOW_* value (in order of preference)
59if [ "$SHOW_DEFAULT_VALUE" ]; then
60	SHOW_DEFAULT_VALUE=1
61	SHOW_CONFIGURED=
62	SHOW_VALUE=
63elif [ "$SHOW_CONFIGURED" ]; then
64	SHOW_DEFAULT_VALUE=
65	SHOW_CONFIGURED=1
66	SHOW_VALUE=
67else
68	SHOW_DEFAULT_VALUE=
69	SHOW_CONFIGURED=
70	SHOW_VALUE=1
71fi
72
73############################################################ FUNCTIONS
74
75# dialog_create_main
76#
77# Create the dialog(1) main menu. Separated from dialog_menu_main (used to
78# display the menu) to speed up execution (we only call this function when
79# initializing or changing the view details).
80#
81dialog_create_main()
82{
83	# Show infobox for modes that take a while to calculate/display
84	[ "$SHOW_DEFAULT_VALUE" -o "$SHOW_CONFIGURED" ] &&
85		f_dialog_info "$msg_creating_menu_list"
86
87	RCCONF_MENU_LIST=$(
88		. "$RC_DEFAULTS" > /dev/null
89		source_rc_confs > /dev/null
90		var_list=$( f_startup_rcconf_list )
91		for var in $var_list; do
92			eval export $var
93			[ "$SHOW_DEFAULT_VALUE" ] && export \
94				_${var}_default="$( f_sysrc_get_default $var )"
95			[ "$SHOW_CONFIGURED" ] && export \
96				_${var}_file="$( f_sysrc_find $var )"
97		done
98		export SHOW_VALUE SHOW_DESC SHOW_DEFAULT_VALUE SHOW_CONFIGURED
99		export msg_default_value
100		echo "$var_list" | awk '
101		BEGIN {
102			prefix = ""
103		}
104		{
105			cur_prefix = tolower(substr($1, 1, 1))
106			printf "'\''"
107			if ( prefix != cur_prefix )
108				prefix = cur_prefix
109			else
110				printf " "
111			var = $1
112			printf "%s'\'' '\''[", var
113			if ( ENVIRON["_" var "_delete"] )
114				printf "X"
115			else
116				printf " "
117			printf "] "
118			if ( ENVIRON["SHOW_DEFAULT_VALUE"] ) {
119				default = ENVIRON["_" var "_default"]
120				gsub(/'\''/, "'\''\\'\'\''", default)
121				value = ENVIRON[var]
122				gsub(/'\''/, "'\''\\'\'\''", value)
123				printf ENVIRON["msg_default_value"] "; %s",
124				       default, value
125			} else if ( ENVIRON["SHOW_CONFIGURED"] ) {
126				printf "%s", ENVIRON["_" var "_file"]
127			} else { # SHOW_VALUE (default behavior)
128				value = ENVIRON[var]
129				gsub(/'\''/, "'\''\\'\'\''", value)
130				printf "%s", value
131			}
132			printf "'\''"
133			if ( ENVIRON["SHOW_DESC"] ) {
134				desc = ENVIRON["_" var "_desc"]
135				gsub(/'\''/, "'\''\\'\'\''", desc)
136				printf " '\''%s'\''", desc
137			}
138			printf "\n"
139		}'
140	)
141}
142
143# dialog_menu_main
144#
145# Display the dialog(1)-based application main menu.
146#
147dialog_menu_main()
148{
149	local size
150	local hline="$hline_arrows_tab_enter"
151	local prompt=""
152
153	#
154	# [Re-]Accent the menu list before incorporating it
155	#
156	local rcconf_var details help menu_buf delete
157	eval set -- $RCCONF_MENU_LIST
158	while [ $# -gt 0 ]; do
159		rcconf_var="$1" details="$2" delete=
160		f_shell_escape "$details" details
161		if [ "$SHOW_DESC" ]; then
162			help="$3"
163			f_shell_escape "$help" help
164			shift 3 # rcconf_var/details/help
165		else
166			shift 2 # rcconf_var/details
167		fi
168
169		# Update mark
170		f_getvar _${rcconf_var# }_delete delete
171		if [ "$delete" ]; then
172			details="[X]${details#???}"
173		else
174			details="[ ]${details#???}"
175		fi
176
177		# Update buffer with modified elements
178		menu_buf="$menu_buf
179		'$rcconf_var' '$details' ${SHOW_DESC:+'$help'}" # End-Quote
180	done
181
182	local menu_list="
183		'X $msg_exit_cancel'     '$msg_exit_cancel_desc'
184		            ${SHOW_DESC:+'$msg_exit_cancel_help'}
185		'> $msg_delete_selected' '$msg_delete_selected_desc'
186		            ${SHOW_DESC:+'$msg_delete_selected_help'}
187		'> $msg_all'             '$msg_all_desc'
188		            ${SHOW_DESC:+'$msg_all_help'}
189		'> $msg_none'            '$msg_none_desc'
190		            ${SHOW_DESC:+'$msg_none_help'}
191	${USE_XDIALOG:+
192		'> $msg_view_details'    '$msg_view_details_desc'
193		            ${SHOW_DESC:+'$msg_view_details_help'}
194	}
195		$menu_buf
196	" # END-QUOTE
197
198	set -f # noglob (descriptions in $RCCONF_MENU_LIST may contain *)
199
200	size=$( eval f_dialog_menu_${SHOW_DESC:+with_help_}size \
201	        	\"\$DIALOG_TITLE\"     \
202	        	\"\$DIALOG_BACKTITLE\" \
203	                \"\$prompt\"           \
204	        	\"\$hline\"            \
205	        	$menu_list             )
206
207	local dialog_menu
208	dialog_menu=$( eval $DIALOG \
209		--title \"\$DIALOG_TITLE\"          \
210		--backtitle \"\$DIALOG_BACKTITLE\"  \
211		--hline \"\$hline\"                 \
212		--keep-tite                         \
213		--ok-label \"\$msg_ok\"             \
214		--cancel-label \"\$msg_cancel\"     \
215		--help-button                       \
216		--help-label \"\$msg_details\"      \
217		${SHOW_DESC:+--item-help}           \
218		--default-item \"\$DEFAULTITEM_$$\" \
219		--menu \"\$prompt\" $size           \
220		$menu_list                          \
221		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
222	)
223	local retval=$?
224	setvar DIALOG_MENU_$$ "$dialog_menu"
225
226	# Only update default-item on success
227	[ $retval -eq 0 ] && setvar DEFAULTITEM_$$ "$dialog_menu"
228
229	return $retval
230}
231
232# dialog_menu_confirm_delete $var1 [$var2 ...]
233#
234# Get the user's blessing to delete one or more variables. Returns success if
235# (and only-if) the user confirms (does not press ESC or Cancel/NO). Does NOT
236# return the user's menu-choice.
237#
238dialog_menu_confirm_delete()
239{
240	local size
241	local hline="$hline_arrows_tab_enter"
242	local prompt="$msg_are_you_sure_you_want_delete_the_following"
243	local var_list menu_list
244
245	[ $# -ge 1 ] || return $FAILURE
246
247	if [ $# -eq 1 ]; then
248		f_noyes "$msg_are_you_sure_you_want_to_delete" "$delete_vars"
249		return $?
250	fi
251
252	var_list=$( for var in $*; do echo "$var"; done | sort -u )
253	menu_list=$(
254		. "$RC_DEFAULTS"
255		source_rc_confs
256		echo "$var_list" | awk '
257		BEGIN {
258			prefix = ""
259		}
260		{
261			cur_prefix = tolower(substr($1, 1, 1))
262			printf "'\''"
263			if ( prefix != cur_prefix )
264				prefix = cur_prefix
265			else
266				printf " "
267			var = $1
268			printf "%s'\'' '\'\''\n", var
269		}'
270	)
271
272	size=$( eval f_dialog_menu_size \
273	        	\"\$DIALOG_TITLE\"     \
274	        	\"\$DIALOG_BACKTITLE\" \
275	                \"\$prompt\"           \
276	        	\"\$hline\"            \
277	        	$menu_list             )
278
279	local defaultno="defaultno"
280	[ "$USE_XDIALOG" ] && defaultno="default-no"
281
282	eval $DIALOG \
283		--title \"\$DIALOG_TITLE\"         \
284		--backtitle \"\$DIALOG_BACKTITLE\" \
285		--hline \"\$hline\"                \
286		--$defaultno                       \
287		--ok-label \"\$msg_ok\"            \
288		--cancel-label \"\$msg_cancel\"    \
289		--menu \"\$prompt\" $size          \
290		$menu_list                         \
291		2> /dev/null
292
293	# Menu choice ignored; status of above command returned
294}
295
296############################################################ MAIN
297
298# Incorporate rc-file if it exists
299[ -f "$HOME/.bsdconfigrc" ] && f_include "$HOME/.bsdconfigrc"
300
301#
302# Process command-line arguments
303#
304while getopts h$GETOPTS_STDARGS flag; do
305	case "$flag" in
306	h|\?) f_usage $BSDCFG_LIBE/$APP_DIR/USAGE "PROGRAM_NAME" "$pgm";;
307	esac
308done
309shift $(( $OPTIND - 1 ))
310
311#
312# Initialize
313#
314f_dialog_title "$msg_delete_startup_directives"
315f_dialog_backtitle "${ipgm:+bsdconfig }$pgm"
316f_mustberoot_init
317
318# Genreate $RCCONF_MAP of `var desc ...' per-line (see share/rcconf.subr)
319f_dialog_info "$msg_creating_rcconf_map"
320f_startup_rcconf_map RCCONF_MAP
321
322# Generate _${var}_desc variables from $RCCONF_MAP
323f_startup_rcconf_map_expand RCCONF_MAP
324
325# Generate RCCONF_MENU_LIST from $RCCONF_MAP
326dialog_create_main
327
328while :; do
329	dialog_menu_main
330	retval=$?
331	mtag=$( f_dialog_menutag )
332
333	if [ "$USE_XDIALOG" ]; then
334		case "$mtag" in "> $msg_view_details")
335			f_dialog_input_view_details && dialog_create_main
336			continue
337		esac
338	elif [ $retval -eq 2 ]; then
339		# The ``Help'' button (labeled "Details") was pressed
340		f_dialog_input_view_details && dialog_create_main
341		continue
342	fi
343
344	[ $retval -eq 0 ] || f_die
345
346	case "$mtag" in
347	"X $msg_exit_cancel") break ;;
348	"> $msg_delete_selected")
349		delete_vars=
350		for var in $( f_startup_rcconf_list ); do
351			[ "$( eval echo \$_${var}_delete )" ] || continue
352			delete_vars="$delete_vars${delete_vars:+ }$var"
353		done
354		unset var # no longer needed
355		if dialog_menu_confirm_delete $delete_vars; then
356			f_dialog_title "$msg_info"
357			f_dialog_info "$msg_deleting_selected_directives"
358			f_dialog_title_restore
359			for var in $delete_vars; do
360				err=$( f_sysrc_delete $var 2>&1 )
361				if [ $? -ne $SUCCESS ]; then
362					f_dialog_msgbox "$err\n"
363					break
364				fi
365			done
366			unset var # no longer needed
367			dialog_create_main
368		fi
369		;;
370	"> $msg_all")
371		for var in $( f_startup_rcconf_list ); do
372			setvar _${var}_delete 1
373			export _${var}_delete
374		done
375		unset var # no longer needed
376		;;
377	"> $msg_none")
378		var_list=$( set | awk -F= "
379			/$STARTUP_RCCONF_REGEX/ {
380				if (\$1 ~ /^_[[:alpha:]_][[:alnum:]_]*_delete/)
381					print \$1
382			}"
383		)
384		[ "$var_list" ] && unset $var_list
385		unset var_list # no longer needed
386		;;
387	*) # Anything else is a variable to edit
388		var="${mtag# }"
389
390		# Toggle the state-variable and loop back to menu
391		if f_isset _${var}_delete; then
392			unset _${var}_delete
393		else
394			setvar _${var}_delete 1
395			export _${var}_delete
396		fi
397		unset var # no longer needed
398	esac
399done
400
401exit $SUCCESS
402
403################################################################################
404# END
405################################################################################
406