rcdelete revision 251236 
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 251236 2013-06-01 23:58:44Z 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 hline="$hline_arrows_tab_enter"
150	local prompt=""
151
152	#
153	# [Re-]Accent the menu list before incorporating it
154	#
155	local rcconf_var details help menu_buf delete
156	eval set -- $RCCONF_MENU_LIST
157	while [ $# -gt 0 ]; do
158		rcconf_var="$1" details="$2" delete=
159		f_shell_escape "$details" details
160		if [ "$SHOW_DESC" ]; then
161			help="$3"
162			f_shell_escape "$help" help
163			shift 3 # rcconf_var/details/help
164		else
165			shift 2 # rcconf_var/details
166		fi
167
168		# Update mark
169		f_getvar _${rcconf_var# }_delete delete
170		if [ "$delete" ]; then
171			details="[X]${details#???}"
172		else
173			details="[ ]${details#???}"
174		fi
175
176		# Update buffer with modified elements
177		menu_buf="$menu_buf
178		'$rcconf_var' '$details' ${SHOW_DESC:+'$help'}" # End-Quote
179	done
180
181	local menu_list="
182		'X $msg_exit_cancel'     '$msg_exit_cancel_desc'
183		            ${SHOW_DESC:+'$msg_exit_cancel_help'}
184		'> $msg_delete_selected' '$msg_delete_selected_desc'
185		            ${SHOW_DESC:+'$msg_delete_selected_help'}
186		'> $msg_all'             '$msg_all_desc'
187		            ${SHOW_DESC:+'$msg_all_help'}
188		'> $msg_none'            '$msg_none_desc'
189		            ${SHOW_DESC:+'$msg_none_help'}
190	${USE_XDIALOG:+
191		'> $msg_view_details'    '$msg_view_details_desc'
192		            ${SHOW_DESC:+'$msg_view_details_help'}
193	}
194		$menu_buf
195	" # END-QUOTE
196
197	set -f # noglob (descriptions in $RCCONF_MENU_LIST may contain *)
198
199	local height width rows
200	eval f_dialog_menu${SHOW_DESC:+_with_help}_size \
201		height width rows      \
202		\"\$DIALOG_TITLE\"     \
203		\"\$DIALOG_BACKTITLE\" \
204		\"\$prompt\"           \
205		\"\$hline\"            \
206		$menu_list
207
208	local menu_choice
209	menu_choice=$( eval $DIALOG \
210		--title \"\$DIALOG_TITLE\"          \
211		--backtitle \"\$DIALOG_BACKTITLE\"  \
212		--hline \"\$hline\"                 \
213		--keep-tite                         \
214		--ok-label \"\$msg_ok\"             \
215		--cancel-label \"\$msg_cancel\"     \
216		--help-button                       \
217		--help-label \"\$msg_details\"      \
218		${SHOW_DESC:+--item-help}           \
219		--default-item \"\$DEFAULTITEM_$$\" \
220		--menu \"\$prompt\"                 \
221		$height $width $rows                \
222		$menu_list                          \
223		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
224	)
225	local retval=$?
226	f_dialog_data_sanitize menu_choice
227	f_dialog_menutag_store "$menu_choice"
228
229	# Only update default-item on success
230	[ $retval -eq 0 ] && setvar DEFAULTITEM_$$ "$menu_choice"
231
232	return $retval
233}
234
235# dialog_menu_confirm_delete $var1 [$var2 ...]
236#
237# Get the user's blessing to delete one or more variables. Returns success if
238# (and only-if) the user confirms (does not press ESC or Cancel/NO). Does NOT
239# return the user's menu-choice.
240#
241dialog_menu_confirm_delete()
242{
243	local hline="$hline_arrows_tab_enter"
244	local prompt="$msg_are_you_sure_you_want_delete_the_following"
245	local var_list menu_list
246
247	[ $# -ge 1 ] || return $FAILURE
248
249	if [ $# -eq 1 ]; then
250		f_noyes "$msg_are_you_sure_you_want_to_delete" "$delete_vars"
251		return $?
252	fi
253
254	var_list=$( for var in $*; do echo "$var"; done | sort -u )
255	menu_list=$(
256		. "$RC_DEFAULTS"
257		source_rc_confs
258		echo "$var_list" | awk '
259		BEGIN {
260			prefix = ""
261		}
262		{
263			cur_prefix = tolower(substr($1, 1, 1))
264			printf "'\''"
265			if ( prefix != cur_prefix )
266				prefix = cur_prefix
267			else
268				printf " "
269			var = $1
270			printf "%s'\'' '\'\''\n", var
271		}'
272	)
273
274	local height width rows
275	eval f_dialog_menu_size height width rows \
276	                        \"\$DIALOG_TITLE\"     \
277	                        \"\$DIALOG_BACKTITLE\" \
278	                        \"\$prompt\"           \
279	                        \"\$hline\"            \
280	                        $menu_list
281
282	local defaultno="defaultno"
283	[ "$USE_XDIALOG" ] && defaultno="default-no"
284
285	eval $DIALOG \
286		--title \"\$DIALOG_TITLE\"         \
287		--backtitle \"\$DIALOG_BACKTITLE\" \
288		--hline \"\$hline\"                \
289		--$defaultno                       \
290		--ok-label \"\$msg_ok\"            \
291		--cancel-label \"\$msg_cancel\"    \
292		--menu \"\$prompt\"                \
293		$height $width $rows               \
294		$menu_list                         \
295		2> /dev/null
296
297	# Menu choice ignored; status of above command returned
298}
299
300############################################################ MAIN
301
302# Incorporate rc-file if it exists
303[ -f "$HOME/.bsdconfigrc" ] && f_include "$HOME/.bsdconfigrc"
304
305#
306# Process command-line arguments
307#
308while getopts h$GETOPTS_STDARGS flag; do
309	case "$flag" in
310	h|\?) f_usage $BSDCFG_LIBE/$APP_DIR/USAGE "PROGRAM_NAME" "$pgm";;
311	esac
312done
313shift $(( $OPTIND - 1 ))
314
315#
316# Initialize
317#
318f_dialog_title "$msg_delete_startup_directives"
319f_dialog_backtitle "${ipgm:+bsdconfig }$pgm"
320f_mustberoot_init
321
322# Genreate $RCCONF_MAP of `var desc ...' per-line (see share/rcconf.subr)
323f_dialog_info "$msg_creating_rcconf_map"
324f_startup_rcconf_map RCCONF_MAP
325
326# Generate _${var}_desc variables from $RCCONF_MAP
327f_startup_rcconf_map_expand RCCONF_MAP
328
329# Generate RCCONF_MENU_LIST from $RCCONF_MAP
330dialog_create_main
331
332while :; do
333	dialog_menu_main
334	retval=$?
335	f_dialog_menutag_fetch mtag
336
337	if [ "$USE_XDIALOG" ]; then
338		case "$mtag" in "> $msg_view_details")
339			f_dialog_input_view_details && dialog_create_main
340			continue
341		esac
342	elif [ $retval -eq 2 ]; then
343		# The ``Help'' button (labeled "Details") was pressed
344		f_dialog_input_view_details && dialog_create_main
345		continue
346	fi
347
348	[ $retval -eq 0 ] || f_die
349
350	case "$mtag" in
351	"X $msg_exit_cancel") break ;;
352	"> $msg_delete_selected")
353		delete_vars=
354		for var in $( f_startup_rcconf_list ); do
355			[ "$( eval echo \$_${var}_delete )" ] || continue
356			delete_vars="$delete_vars${delete_vars:+ }$var"
357		done
358		unset var # no longer needed
359		if dialog_menu_confirm_delete $delete_vars; then
360			f_dialog_title "$msg_info"
361			f_dialog_info "$msg_deleting_selected_directives"
362			f_dialog_title_restore
363			for var in $delete_vars; do
364				err=$( f_sysrc_delete $var 2>&1 )
365				if [ $? -ne $SUCCESS ]; then
366					f_dialog_msgbox "$err\n"
367					break
368				fi
369			done
370			unset var # no longer needed
371			dialog_create_main
372		fi
373		;;
374	"> $msg_all")
375		for var in $( f_startup_rcconf_list ); do
376			setvar _${var}_delete 1
377			export _${var}_delete
378		done
379		unset var # no longer needed
380		;;
381	"> $msg_none")
382		var_list=$( set | awk -F= "
383			/$STARTUP_RCCONF_REGEX/ {
384				if (\$1 ~ /^_[[:alpha:]_][[:alnum:]_]*_delete/)
385					print \$1
386			}"
387		)
388		[ "$var_list" ] && unset $var_list
389		unset var_list # no longer needed
390		;;
391	*) # Anything else is a variable to edit
392		var="${mtag# }"
393
394		# Toggle the state-variable and loop back to menu
395		if f_isset _${var}_delete; then
396			unset _${var}_delete
397		else
398			setvar _${var}_delete 1
399			export _${var}_delete
400		fi
401		unset var # no longer needed
402	esac
403done
404
405exit $SUCCESS
406
407################################################################################
408# END
409################################################################################
410