packages.subr revision 250323
1250323Sdteskeif [ ! "$_PACKAGES_PACKAGES_SUBR" ]; then _PACKAGES_PACKAGES_SUBR=1
2250323Sdteske#
3250323Sdteske# Copyright (c) 2013 Devin Teske
4250323Sdteske# All Rights Reserved.
5250323Sdteske#
6250323Sdteske# Redistribution and use in source and binary forms, with or without
7250323Sdteske# modification, are permitted provided that the following conditions
8250323Sdteske# are met:
9250323Sdteske# 1. Redistributions of source code must retain the above copyright
10250323Sdteske#    notice, this list of conditions and the following disclaimer.
11250323Sdteske# 2. Redistributions in binary form must reproduce the above copyright
12250323Sdteske#    notice, this list of conditions and the following disclaimer in the
13250323Sdteske#    documentation and/or other materials provided with the distribution.
14250323Sdteske#
15250323Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16250323Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE
17250323Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18250323Sdteske# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19250323Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20250323Sdteske# DAMAGES (INLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21250323Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22250323Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23250323Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24250323Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25250323Sdteske# SUCH DAMAGE.
26250323Sdteske#
27250323Sdteske# $FreeBSD: head/usr.sbin/bsdconfig/share/packages/packages.subr 250323 2013-05-07 05:40:20Z dteske $
28250323Sdteske#
29250323Sdteske############################################################ INCLUDES
30250323Sdteske
31250323SdteskeBSDCFG_SHARE="/usr/share/bsdconfig"
32250323Sdteske. $BSDCFG_SHARE/common.subr || exit 1
33250323Sdteskef_dprintf "%s: loading includes..." "$0"
34250323Sdteskef_include $BSDCFG_SHARE/dialog.subr
35250323Sdteskef_include $BSDCFG_SHARE/strings.subr
36250323Sdteskef_include $BSDCFG_SHARE/packages/categories.subr
37250323Sdteskef_include $BSDCFG_SHARE/packages/index.subr
38250323Sdteske
39250323SdteskeBSDCFG_LIBE="/usr/libexec/bsdconfig"
40250323Sdteskef_include_lang $BSDCFG_LIBE/include/messages.subr
41250323Sdteske
42250323Sdteske############################################################ CONFIGURATION
43250323Sdteske
44250323Sdteske#
45250323Sdteske# How many packages to display (maximum) per dialog menubox.
46250323Sdteske#
47250323Sdteske: ${PACKAGE_MENU_PAGESIZE:=2000}
48250323Sdteske
49250323Sdteske############################################################ GLOBALS
50250323Sdteske
51250323SdteskePACKAGE_CATEGORIES=
52250323SdteskeSELECTED_PACKAGES=
53250323Sdteske
54250323Sdteske#
55250323Sdteske# Options
56250323Sdteske#
57250323Sdteske[ "${SHOW_DESC+set}" ] || SHOW_DESC=1
58250323Sdteske
59250323Sdteske############################################################ FUNCTIONS
60250323Sdteske
61250323Sdteske# eval f_package_accent_category_menu $var_to_set $CATEGORY_MENU_LIST
62250323Sdteske#
63250323Sdteske# Accent the CATEGORY_MENU_LIST produced by f_index_read() (see
64250323Sdteske# packages/index.subr). Accented information includes adding an asterisk to the
65250323Sdteske# category name if its index has been cached, adding the number of installed
66250323Sdteske# packages for each category, and adding the number _selected_ packages for
67250323Sdteske# each category.
68250323Sdteske#
69250323Sdteske# NOTE: The reason `eval' is recommended/shown for the syntax above is because
70250323Sdteske# the $CATEGORY_MENU_LIST generated by f_index_read() is meant to be expanded
71250323Sdteske# prior to execution (it contains a series of pre-quoted strings which act as
72250323Sdteske# the interpolated command arguments).
73250323Sdteske#
74250323Sdteskef_package_accent_category_menu()
75250323Sdteske{
76250323Sdteske	local var_to_set="$1" cat desc help varcat menu_buf n
77250323Sdteske	shift 1 # var_to_set
78250323Sdteske	while [ $# -gt 0 ]; do
79250323Sdteske		cat="${1%\*}" desc="${2%%; *}" help="$3"
80250323Sdteske		shift 3 # cat/desc/help
81250323Sdteske		f_str2varname "${cat# }" varcat
82250323Sdteske
83250323Sdteske		# Add an asterisk to the category if its index has been cached
84250323Sdteske		f_isset _index_page_${varcat}_1 && cat="$cat*"
85250323Sdteske
86250323Sdteske		# Add number of installed packages for this category (if any)
87250323Sdteske		n=0
88250323Sdteske		debug= f_getvar "_${varcat}_ninstalled" n &&
89250323Sdteske			[ $n -ge 1 ] && desc="$desc; $n installed"
90250323Sdteske
91250323Sdteske		# Add number of selected packages for this category (if any)
92250323Sdteske		n=0
93250323Sdteske		debug= f_getvar "_${varcat}_nselected" n &&
94250323Sdteske			[ $n -ge 1 ] && desc="$desc; $n selected"
95250323Sdteske
96250323Sdteske		# Update buffer with modified elements
97250323Sdteske		menu_buf="$menu_buf
98250323Sdteske		'$cat' '$desc' '$help'" # End-Quote
99250323Sdteske	done
100250323Sdteske	setvar "$var_to_set" "$menu_buf" # return our buffer
101250323Sdteske}
102250323Sdteske
103250323Sdteske# f_package_select $package ...
104250323Sdteske#
105250323Sdteske# Add $package to the list of tracked/selected packages. If $package is already
106250323Sdteske# being tracked (already apears in $SELECTED_PACKAGES), this function amounts
107250323Sdteske# to having no effect.
108250323Sdteske#
109250323Sdteskef_package_select()
110250323Sdteske{
111250323Sdteske	local package pkgsel
112250323Sdteske	while [ $# -gt 0 ]; do
113250323Sdteske		package="$1"
114250323Sdteske		shift 1 # package
115250323Sdteske		for pkgsel in $SELECTED_PACKAGES; do
116250323Sdteske			[ "$package" = "$pkgsel" ] && return
117250323Sdteske		done
118250323Sdteske		SELECTED_PACKAGES="$SELECTED_PACKAGES $package"
119250323Sdteske	done
120250323Sdteske	SELECTED_PACKAGES="${SELECTED_PACKAGES# }" # Trim leading space
121250323Sdteske}
122250323Sdteske
123250323Sdteske# f_package_deselect $package ...
124250323Sdteske#
125250323Sdteske# Remove $package from teh list of tracked/selected packages. If $package is
126250323Sdteske# not being tracked (doesn't appear in $SELECTED_PACKAGES), this function
127250323Sdteske# amounts to having no effet.
128250323Sdteske#
129250323Sdteskef_package_deselect()
130250323Sdteske{
131250323Sdteske	local package pkgsel
132250323Sdteske	while [ $# -gt 1 ]; do
133250323Sdteske		local new_list=""
134250323Sdteske		package="$1"
135250323Sdteske		shift 1 # package
136250323Sdteske		for pkgsel in $SELECTED_PACKAGES; do
137250323Sdteske			[ "$pkgsel" = "$package" ] && continue
138250323Sdteske			new_list="$new_list${new_list:+ }$pkgsel"
139250323Sdteske		done
140250323Sdteske		SELECTED_PACKAGES="$new_list"
141250323Sdteske	done
142250323Sdteske}
143250323Sdteske
144250323Sdteske# f_package_detect_installed
145250323Sdteske#
146250323Sdteske# Detect installed packages. Currently this searches /var/db/pkg for directory
147250323Sdteske# entries and marks each entry as an installed/selected package.
148250323Sdteske#
149250323Sdteskef_package_detect_installed()
150250323Sdteske{
151250323Sdteske	local installed package varpkg
152250323Sdteske	installed=$( find -s /var/db/pkg -mindepth 1 -maxdepth 1 -type d |
153250323Sdteske			sed -e 's:/var/db/pkg/::' )
154250323Sdteske	for package in $installed; do
155250323Sdteske		f_str2varname $package varpkg
156250323Sdteske		export _mark_$varpkg=X # exported for awk(1) ENVIRON[]
157250323Sdteske		f_package_select $package
158250323Sdteske	done
159250323Sdteske}
160250323Sdteske
161250323Sdteske# f_package_calculate_totals
162250323Sdteske#
163250323Sdteske# Calculate number of installed/selected packages for each category listed in
164250323Sdteske# $PACKAGE_CATEGORIES (the number of installed packages for $category is stored
165250323Sdteske# as $_${varcat}_ninstalled -- where $varcat is the product of `f_str2varname
166250323Sdteske# $category varcat' -- and number selected packages as $_${varcat}_nselected).
167250323Sdteske# Also calculates the total number of installed/selected packages stored as
168250323Sdteske# $_All_ninstalled and $_All_nselected.
169250323Sdteske#
170250323Sdteske# Calculations are peformed by checking "marks". A "mark" is stored as
171250323Sdteske# $_mark_$varpkg -- where $varpkg is the product of `f_str2varname $package
172250323Sdteske# varpkg'. A mark can be "X" for an installed package, `I' for a package that
173250323Sdteske# is marked for installation, "R" for a package that is marked for re-install,
174250323Sdteske# and "U" for a package that is marked for uninstallation. If a package mark is
175250323Sdteske# NULL or a single space (e.g., " "), the package is considered to be NOT
176250323Sdteske# selected (and therefore does not increment the counts calculated herein).
177250323Sdteske#
178250323Sdteskef_package_calculate_totals()
179250323Sdteske{
180250323Sdteske	local pkg varpkg mark cat varcat pkgcat n tselected=0 tinstalled=0
181250323Sdteske	for cat in $PACKAGE_CATEGORIES; do
182250323Sdteske		f_str2varname $cat varcat
183250323Sdteske		setvar _${varcat}_ninstalled=0
184250323Sdteske		setvar _${varcat}_nselected=0
185250323Sdteske	done
186250323Sdteske	for pkg in $SELECTED_PACKAGES; do
187250323Sdteske		f_str2varname $pkg varpkg
188250323Sdteske		mark=
189250323Sdteske		f_getvar _mark_$varpkg mark
190250323Sdteske		case "$mark" in
191250323Sdteske		""|" ") : ;;
192250323Sdteske		X) tinstalled=$(( $tinstalled + 1 ));;
193250323Sdteske		*) tselected=$(( $tselected + 1 ))
194250323Sdteske		esac
195250323Sdteske		f_getvar _categories_$varpkg pkgcat
196250323Sdteske		for cat in $pkgcat; do
197250323Sdteske			f_str2varname $cat varcat
198250323Sdteske			case "$mark" in
199250323Sdteske			""|" ") : ;;
200250323Sdteske			X) debug= f_getvar _${varcat}_ninstalled n
201250323Sdteske			   setvar _${varcat}_ninstalled $(( $n + 1 ));;
202250323Sdteske			*) debug= f_getvar _${varcat}_nselected n
203250323Sdteske			   setvar _${varcat}_nselected $(( $n + 1 ))
204250323Sdteske			esac
205250323Sdteske		done
206250323Sdteske	done
207250323Sdteske	_All_nselected=$tselected
208250323Sdteske	_All_ninstalled=$tinstalled
209250323Sdteske}
210250323Sdteske
211250323Sdteske# f_package_calculate_rundeps
212250323Sdteske#
213250323Sdteske# Update package dependencies by first unmarking all dependencies and then
214250323Sdteske# re-marking all dependencies of packages marked for either install ("I") or
215250323Sdteske# re-install ("R").
216250323Sdteske#
217250323Sdteskef_package_calculate_rundeps()
218250323Sdteske{
219250323Sdteske	local pkg varpkg mark rundeps dep vardep
220250323Sdteske
221250323Sdteske	#
222250323Sdteske	# First unmark all the existing run-dependencies
223250323Sdteske	#
224250323Sdteske	f_dprintf "Unselecting package run-dependencies..."
225250323Sdteske	for pkg in $SELECTED_PACKAGES; do
226250323Sdteske		f_str2varname $pkg varpkg
227250323Sdteske		mark=
228250323Sdteske		debug= f_getvar _mark_$varpkg mark
229250323Sdteske		# Only unmark if it's marked as a Dependency
230250323Sdteske		if [ "$mark" = "D" ]; then
231250323Sdteske			f_dprintf "%s unselected" $pkg
232250323Sdteske			unset _mark_$varpkg
233250323Sdteske			f_package_deselect $pkg
234250323Sdteske		fi
235250323Sdteske	done
236250323Sdteske
237250323Sdteske	#
238250323Sdteske	# Processes selected packages, adding dependencies
239250323Sdteske	#
240250323Sdteske	f_dprintf "Re-selecting package run-dependencies..."
241250323Sdteske	for pkg in $SELECTED_PACKAGES; do
242250323Sdteske		f_str2varname $pkg varpkg
243250323Sdteske		mark=
244250323Sdteske		debug= f_getvar _mark_$varpkg mark
245250323Sdteske		# Skip pkg unless marked for [Re-]Install
246250323Sdteske		[ "$mark" = "I" -o "$mark" = "R" ] || continue
247250323Sdteske		f_getvar _rundeps_$varpkg rundeps
248250323Sdteske		for dep in $rundeps; do
249250323Sdteske			f_str2varname $dep vardep
250250323Sdteske			mark=
251250323Sdteske			debug= f_getvar _mark_$vardep mark
252250323Sdteske			# Skip dep if already marked
253250323Sdteske			[ "${mark:- }" = " " ] || continue
254250323Sdteske			export _mark_$vardep="D"
255250323Sdteske			f_package_select $dep
256250323Sdteske		done
257250323Sdteske	done
258250323Sdteske
259250323Sdteske	f_dprintf "Finished recalculating dependencies."
260250323Sdteske}
261250323Sdteske
262250323Sdteske# f_package_menu_categories $var_to_set $defaultitem
263250323Sdteske#
264250323Sdteske# Dislay the menu of package categories, complete with package counts for each
265250323Sdteske# category, accents, and other miscellany. If $defaultitem is non-NULL and
266250323Sdteske# matches one of the existing menu-items, it will be pre-highlighted in the
267250323Sdteske# menu dialog (HINT: Use f_dialog_menutag() to populate a local variable that
268250323Sdteske# is passed as $defaultitem to highlight the user's last selection by default).
269250323Sdteske#
270250323Sdteskef_package_menu_categories()
271250323Sdteske{
272250323Sdteske	local var_to_get="$1" defaultitem="$2" category_list menu_list
273250323Sdteske
274250323Sdteske	f_package_calculate_rundeps
275250323Sdteske		# updates package mark variables and SELECTED_PACKAGES
276250323Sdteske	f_package_calculate_totals
277250323Sdteske		# creates _{varcat}_ninstalled and _{varcat}_nselected
278250323Sdteske
279250323Sdteske	debug= f_getvar "$var_to_get" category_list || return $FAILURE
280250323Sdteske
281250323Sdteske	# Accent the category menu list with ninstalled/nselected
282250323Sdteske	eval f_package_accent_category_menu category_list $category_list
283250323Sdteske
284250323Sdteske	local prompt="$msg_please_select_a_category_to_display"
285250323Sdteske	local hline=""
286250323Sdteske
287250323Sdteske	menu_list="
288250323Sdteske		'> $msg_review' '$msg_review_desc' '$msg_review_help'
289250323Sdteske		$category_list
290250323Sdteske	" # End-Quote
291250323Sdteske
292250323Sdteske	local size dialog_menu
293250323Sdteske	size=$( eval f_dialog_menu_with_help_size \
294250323Sdteske	        	\"\$DIALOG_TITLE\"     \
295250323Sdteske	        	\"\$DIALOG_BACKTITLE\" \
296250323Sdteske	        	\"\$prompt\"           \
297250323Sdteske	        	\"\$hline\"            \
298250323Sdteske	        	$menu_list             )
299250323Sdteske	dialog_menu=$( eval $DIALOG \
300250323Sdteske			--title \"\$DIALOG_TITLE\"         \
301250323Sdteske			--backtitle \"\$DIALOG_BACKTITLE\" \
302250323Sdteske			--hline \"\$hline\"                \
303250323Sdteske			--item-help                        \
304250323Sdteske			--default-item \"\$defaultitem\"   \
305250323Sdteske			--ok-label \"$msg_select\"         \
306250323Sdteske			--cancel-label \"$msg_cancel\"     \
307250323Sdteske			--menu \"\$prompt\" $size          \
308250323Sdteske			$menu_list                         \
309250323Sdteske			2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
310250323Sdteske		)
311250323Sdteske	local retval=$?
312250323Sdteske	setvar DIALOG_MENU_$$ "$dialog_menu"
313250323Sdteske	return $retval
314250323Sdteske}
315250323Sdteske
316250323Sdteske# f_package_index_get_page $category $page [$var_to_set [$var_to_get]]
317250323Sdteske#
318250323Sdteske# Obtain a [potentially cached] page of the INDEX file for a given $category.
319250323Sdteske# If $page is 1 and the cache has not yet been generated, the cache-generating
320250323Sdteske# function f_index_extract_pages() (above) is called to generate all pages
321250323Sdteske# (not just the requested page) in cache before returning the requested page.
322250323Sdteske# If $page is not 1 and there is no cached page, failure status is returned.
323250323Sdteske#
324250323Sdteskef_package_index_get_page()
325250323Sdteske{
326250323Sdteske	local category="$1" page="$2" var_to_set="$3" var_to_get="$4" varcat
327250323Sdteske	f_str2varname "$category" varcat
328250323Sdteske	if ! debug= f_getvar "_index_page_${varcat}_$page" $var_to_set &&
329250323Sdteske	   [ "$page" = "1" ]
330250323Sdteske	then
331250323Sdteske		f_show_info "$msg_building_package_menus"
332250323Sdteske		local pagesize="$PACKAGE_MENU_PAGESIZE"
333250323Sdteske		f_index_extract_pages "${var_to_get:-PACKAGE_INDEX}" \
334250323Sdteske			_index_page_${varcat} "$pagesize" "$category"
335250323Sdteske		debug= f_getvar _index_page_${varcat}_$page $var_to_set
336250323Sdteske
337250323Sdteske		# Update category default-item because now we're cached
338250323Sdteske		[ $page -eq 1 ] &&
339250323Sdteske		    category_defaultitem="${category_defaultitem%\*}*"
340250323Sdteske	else
341250323Sdteske		return $FAILURE
342250323Sdteske	fi
343250323Sdteske}
344250323Sdteske
345250323Sdteske# f_package_menu_select $category [ $page [ $defaultitem ] ]
346250323Sdteske#
347250323Sdteske# Display list of packages for $category, optionally $page N and with a default
348250323Sdteske# item selected. If $page is omitted, the first page is displayed (but this
349250323Sdteske# only matters if there are multiple pages; which is determined by the global
350250323Sdteske# maximum $PACKAGE_MENU_PAGESIZE).
351250323Sdteske#
352250323Sdteske# On success, if the user doesn't press ESC or choose Cancel, the environment
353250323Sdteske# variable $DIALOG_MENUITEM_$$ will hold the item associated with the chosen
354250323Sdteske# tag (accessible through f_dialog_menutag()).
355250323Sdteske#
356250323Sdteskef_package_menu_select()
357250323Sdteske{
358250323Sdteske	local category="$1" page="${2:-1}" defaultitem="$3"
359250323Sdteske	local varcat npkgs=0 npages menu_list
360250323Sdteske
361250323Sdteske	f_isinteger "$page" || return $FAILURE
362250323Sdteske
363250323Sdteske	f_str2varname "$category" varcat
364250323Sdteske	f_package_index_get_page "$category" $page index_page
365250323Sdteske
366250323Sdteske	# Get number of packages for this category
367250323Sdteske	case "$category" in
368250323Sdteske	"All"|"") npkgs="${_npkgs:-0}";;
369250323Sdteske	*) f_getvar _npkgs_$varcat npkgs
370250323Sdteske	esac
371250323Sdteske
372250323Sdteske	# Calculate number of pages
373250323Sdteske	npages=$(( ${npkgs:=0} / $PACKAGE_MENU_PAGESIZE ))
374250323Sdteske
375250323Sdteske	# Add a page to the pagecount if not evenly divisible
376250323Sdteske	[ $(( $npages * $PACKAGE_MENU_PAGESIZE )) -lt $npkgs ] &&
377250323Sdteske		npages=$(( $npages + 1 ))
378250323Sdteske
379250323Sdteske	# Print some debugging information
380250323Sdteske	f_dprintf "f_package_menu_select: category=[%s] npkgs=%u npages=%u" \
381250323Sdteske	          "$category" "$npkgs" "$npages"
382250323Sdteske
383250323Sdteske	local add_prev="" add_next=""
384250323Sdteske	local previous_page="$msg_previous_page" next_page="$msg_next_page"
385250323Sdteske	if [ $page -gt 1 ]; then
386250323Sdteske		add_prev=1
387250323Sdteske		# Accent the `Previous Page' item with an asterisk
388250323Sdteske		# if the page-before-previous is loaded/cached
389250323Sdteske		f_isset _index_page_${varcat}_$(( $page - 1 )) &&
390250323Sdteske			previous_page="$previous_page*"
391250323Sdteske	fi
392250323Sdteske	if [ $page -lt $npages ]; then
393250323Sdteske		add_next=1
394250323Sdteske		# Accent the `Next Page' item with an asterisk
395250323Sdteske		# if the page-after-next is loaded/cached
396250323Sdteske		f_isset _index_page_${varcat}_$(( $page + 1 )) &&
397250323Sdteske			next_page="$next_page*"
398250323Sdteske	fi
399250323Sdteske
400250323Sdteske	menu_list="
401250323Sdteske		${add_prev:+'> $previous_page' '' ${SHOW_DESC:+''}}
402250323Sdteske		${add_next:+'> $next_page' '' ${SHOW_DESC:+''}}
403250323Sdteske	$(
404250323Sdteske		export SHOW_DESC
405250323Sdteske		export VALID_VARNAME_CHARS
406250323Sdteske		echo "$index_page" | awk -F'|' -v view="port" '
407250323Sdteske		BEGIN {
408250323Sdteske			valid_chars = ENVIRON["VALID_VARNAME_CHARS"]
409250323Sdteske			prefix = ""
410250323Sdteske		}
411250323Sdteske		{
412250323Sdteske			cur_prefix = tolower(substr($1, 1, 1))
413250323Sdteske			printf "'\''"
414250323Sdteske			if ( prefix != cur_prefix )
415250323Sdteske				prefix = cur_prefix
416250323Sdteske			else
417250323Sdteske				printf " "
418250323Sdteske			package = $1
419250323Sdteske			if ( view == "port" )
420250323Sdteske				desc = $2
421250323Sdteske			varpkg = package
422250323Sdteske			gsub("[^" valid_chars "]", "_", varpkg)
423250323Sdteske			mark = ENVIRON["_mark_" varpkg]
424250323Sdteske			if ( ! mark ) mark = " "
425250323Sdteske			printf "%s'\'' '\''[%c] %s'\''",
426250323Sdteske			       package, mark, desc
427250323Sdteske			if ( ENVIRON["SHOW_DESC"] ) {
428250323Sdteske				help = $4
429250323Sdteske				gsub(/'\''/, "'\''\\'\'\''", help)
430250323Sdteske				printf " '\''%s'\''", help
431250323Sdteske			}
432250323Sdteske			printf "\n"
433250323Sdteske		}'
434250323Sdteske	)
435250323Sdteske		${add_prev:+'> $previous_page' '' ${SHOW_DESC:+''}}
436250323Sdteske		${add_next:+'> $next_page' '' ${SHOW_DESC:+''}}
437250323Sdteske	" # End-Quote
438250323Sdteske
439250323Sdteske	local prompt=""
440250323Sdteske	f_category_desc_get "$category" prompt
441250323Sdteske	prompt="$prompt $( printf "$msg_page_of_npages" \
442250323Sdteske	                          "$page" "$npages" )"
443250323Sdteske
444250323Sdteske	local hline="$hline_arrows_tab_punc_enter"
445250323Sdteske	local size isize dialog_menu item
446250323Sdteske	size=$( eval f_dialog_menu${SHOW_DESC:+_with_help}_size \
447250323Sdteske	        	\"\$DIALOG_TITLE\"     \
448250323Sdteske	        	\"\$DIALOG_BACKTITLE\" \
449250323Sdteske	        	\"\$prompt\"           \
450250323Sdteske	        	\"\$hline\"            \
451250323Sdteske	        	$menu_list             )
452250323Sdteske	isize=$( f_dialog_infobox_size \
453250323Sdteske	         	"$DIALOG_TITLE"             \
454250323Sdteske	         	"$DIALOG_BACKTITLE"         \
455250323Sdteske	         	"$msg_processing_selection" )
456250323Sdteske	dialog_menu=$( eval $DIALOG \
457250323Sdteske		--title \"\$DIALOG_TITLE\"         \
458250323Sdteske		--backtitle \"\$DIALOG_BACKTITLE\" \
459250323Sdteske		--hline \"\$hline\"                \
460250323Sdteske		--keep-tite                        \
461250323Sdteske		--ok-label \"$msg_select\"         \
462250323Sdteske		--cancel-label \"$msg_back\"       \
463250323Sdteske		${SHOW_DESC:+--item-help}          \
464250323Sdteske		--default-item \"\$defaultitem\"   \
465250323Sdteske		--menu \"\$prompt\" $size          \
466250323Sdteske		$menu_list                         \
467250323Sdteske		--and-widget                       \
468250323Sdteske		${USE_XDIALOG:+--no-buttons}       \
469250323Sdteske		--infobox \"\$msg_processing_selection\" $isize \
470250323Sdteske		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
471250323Sdteske	)
472250323Sdteske	local retval=$?
473250323Sdteske	setvar DIALOG_MENU_$$ "$dialog_menu"
474250323Sdteske
475250323Sdteske	if [ $retval -eq $SUCCESS ]; then
476250323Sdteske		item=$( eval f_dialog_menutag2item${SHOW_DESC:+_with_help} \
477250323Sdteske		             	\"\$dialog_menu\" $menu_list )
478250323Sdteske		setvar DIALOG_MENUITEM_$$ "$item"
479250323Sdteske	fi
480250323Sdteske
481250323Sdteske	return $retval
482250323Sdteske}
483250323Sdteske
484250323Sdteske# f_package_menu_deselect $package
485250323Sdteske#
486250323Sdteske# Display a menu, asking the user what they would like to do with $package
487250323Sdteske# with regard to "deselecting" an already installed package. Choices include
488250323Sdteske# uninstall, re-install, or cancel (leave $package marked as installed).
489250323Sdteske# Returns success if the user does not press ESC or choose Cnacel. Use the
490250323Sdteske# f_dialog_menutag() function upon success to retrieve the user's choice.
491250323Sdteske#
492250323Sdteskef_package_menu_deselect()
493250323Sdteske{
494250323Sdteske	local package="$1" prompt menu_list size dialog_menu
495250323Sdteske	prompt=$( printf "$msg_what_would_you_like_to_do_with" "$package" )
496250323Sdteske	local hline="$hline_alnum_arrows_punc_tab_enter"
497250323Sdteske	menu_list="
498250323Sdteske		'X $msg_installed' '$msg_installed_desc'
499250323Sdteske		'R $msg_reinstall' '$msg_reinstall_desc'
500250323Sdteske		'U $msg_uninstall' '$msg_uninstall_desc'
501250323Sdteske	" # End-Quote
502250323Sdteske	size=$( eval f_dialog_menu_size \
503250323Sdteske	         	\"\$DIALOG_TITLE\"     \
504250323Sdteske	         	\"\$DIALOG_BACKTITLE\" \
505250323Sdteske	         	\"\$prompt\"           \
506250323Sdteske	         	\"\$hline\"            \
507250323Sdteske	         	$menu_list             )
508250323Sdteske	dialog_menu=$( eval $DIALOG \
509250323Sdteske		--title \"\$DIALOG_TITLE\"         \
510250323Sdteske		--backtitle \"\$DIALOG_BACKTITLE\" \
511250323Sdteske		--hline \"\$hline\"                \
512250323Sdteske		--ok-label \"$msg_select\"         \
513250323Sdteske		--cancel-label \"$msg_cancel\"     \
514250323Sdteske		--menu \"\$prompt\" $size          \
515250323Sdteske		$menu_list                         \
516250323Sdteske		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
517250323Sdteske	)
518250323Sdteske	local retval=$?
519250323Sdteske	setvar DIALOG_MENU_$$ "$dialog_menu"
520250323Sdteske	return $retval
521250323Sdteske}
522250323Sdteske
523250323Sdteske# f_package_review
524250323Sdteske#
525250323Sdteske# Display a review screen, showing selected packages and what they are marked
526250323Sdteske# for, before proceeding (if the user does not press ESC or choose Cancel) to
527250323Sdteske# operate on each selection. Returns error if no packages have been selected,
528250323Sdteske# or the user has pressed ESC, or if they have chosen Cancel.
529250323Sdteske#
530250323Sdteskef_package_review()
531250323Sdteske{
532250323Sdteske	local prompt size dialog_menu package varpkg mark menu_list=
533250323Sdteske	prompt=$( printf "$msg_reviewing_selected_packages" \
534250323Sdteske	                 "$_All_nselected" )
535250323Sdteske	local hline="$hline_alnum_arrows_punc_tab_enter"
536250323Sdteske	f_dprintf "f_package_review: SELECTED_PACKAGES=[%s]" \
537250323Sdteske	          "$SELECTED_PACKAGES"
538250323Sdteske	for package in $SELECTED_PACKAGES; do
539250323Sdteske		mark=
540250323Sdteske		f_str2varname "$package" varpkg
541250323Sdteske		f_getvar _mark_$varpkg mark
542250323Sdteske		[ "$mark" -a ! "${mark#[IRUD]}" ] || continue
543250323Sdteske		menu_list="$menu_list
544250323Sdteske			'$mark' '$package'
545250323Sdteske		" # End-Quote
546250323Sdteske	done
547250323Sdteske	if [ ! "$menu_list" ]; then
548250323Sdteske		f_show_msg "$msg_no_packages_were_selected_for_extraction"
549250323Sdteske		return $FAILURE # They might have selected this by accident
550250323Sdteske	fi
551250323Sdteske	menu_list=$( echo "$menu_list" | sort )
552250323Sdteske	size=$( eval f_dialog_menu_size \
553250323Sdteske			\"\$DIALOG_TITLE\"     \
554250323Sdteske			\"\$DIALOG_BACKTITLE\" \
555250323Sdteske			\"\$prompt\"           \
556250323Sdteske			\"\$hline\"            \
557250323Sdteske			$menu_list             )
558250323Sdteske	dialog_menu=$( eval $DIALOG \
559250323Sdteske		--title \"\$DIALOG_TITLE\"         \
560250323Sdteske		--backtitle \"\$DIALOG_BACKTITLE\" \
561250323Sdteske		--hline \"\$hline\"                \
562250323Sdteske		--ok-label \"\$msg_proceed\"       \
563250323Sdteske		--cancel-label \"\$msg_cancel\"    \
564250323Sdteske		--menu \"\$prompt\" $size          \
565250323Sdteske		$menu_list                         \
566250323Sdteske		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
567250323Sdteske	)
568250323Sdteske	local retval=$?
569250323Sdteske	setvar DIALOG_MENU_$$ "$dialog_menu"
570250323Sdteske
571250323Sdteske	#
572250323Sdteske	# XXX
573250323Sdteske	#
574250323Sdteske	f_show_msg "Coming soon..."
575250323Sdteske	#
576250323Sdteske	# XXX
577250323Sdteske	#
578250323Sdteske
579250323Sdteske	return $retval
580250323Sdteske}
581250323Sdteske
582250323Sdteske# f_package_config
583250323Sdteske#
584250323Sdteske# Allow the user to configure packages and install them. Initially, a list of
585250323Sdteske# package categories is loaded/displayed. When the user selects a category,
586250323Sdteske# the menus for that category are built (unlike sysinstall which built all
587250323Sdteske# category menus up-front -- which also took forever, despite the fact that
588250323Sdteske# few people visit more than a couple of categories each time).
589250323Sdteske#
590250323Sdteskef_package_config()
591250323Sdteske{
592250323Sdteske	# Did we get an INDEX?
593250323Sdteske	f_index_initialize packages/INDEX || return $FAILURE
594250323Sdteske		# Creates following variables (indirectly via f_index_read())
595250323Sdteske		#   CATEGORY_MENU_LIST _categories_{varpkg} _rundeps_{varpkg}
596250323Sdteske		#   PACKAGE_CATEGORIES _npkgs
597250323Sdteske
598250323Sdteske	# Detect installed packages (updates marks/SELECTED_PACKAGES)
599250323Sdteske	f_package_detect_installed
600250323Sdteske
601250323Sdteske	local retval category varcat defaultitem category_defaultitem=""
602250323Sdteske	while :; do
603250323Sdteske		# Display the list of package categories
604250323Sdteske		f_package_menu_categories \
605250323Sdteske			CATEGORY_MENU_LIST "$category_defaultitem"
606250323Sdteske		retval=$?
607250323Sdteske		category=$( f_dialog_menutag )
608250323Sdteske		f_dprintf "retval=%u mtag=[%s]" $retval "$category"
609250323Sdteske		category_defaultitem="$category"
610250323Sdteske
611250323Sdteske		[ $retval -eq $SUCCESS ] || break
612250323Sdteske
613250323Sdteske		# Maybe the user chose an action (like `Review')
614250323Sdteske		case "$category" in
615250323Sdteske		"> $msg_review")
616250323Sdteske			f_package_review && break
617250323Sdteske			continue ;;
618250323Sdteske		"> "*)
619250323Sdteske			continue
620250323Sdteske		esac
621250323Sdteske
622250323Sdteske		# Anything else is a package category
623250323Sdteske
624250323Sdteske		category=${category# } # Trim leading space if present
625250323Sdteske		category=${category%\*} # Trim trailing asterisk if present
626250323Sdteske
627250323Sdteske		f_str2varname "$category" varcat
628250323Sdteske
629250323Sdteske		local page package varpkg mark
630250323Sdteske		while :; do
631250323Sdteske			# Display the list of packages for selected category
632250323Sdteske			page=1 defaultitem=""
633250323Sdteske			f_getvar _defaultitem_$varcat defaultitem
634250323Sdteske			f_getvar _defaultpage_$varcat page
635250323Sdteske			f_package_menu_select \
636250323Sdteske				"$category" "${page:=1}" "$defaultitem"
637250323Sdteske			retval=$?
638250323Sdteske			dialog_menu=$( f_dialog_menutag )
639250323Sdteske			f_dprintf "retval=%u mtag=[%s]" $retval "$dialog_menu"
640250323Sdteske
641250323Sdteske			# NOTE: When --and-widget is used only ESC will cause
642250323Sdteske			# dialog(1) to return without going to the next widget.
643250323Sdteske			# This is alright in our case as we can still detect
644250323Sdteske			# the Cancel button because stdout will be NULL.
645250323Sdteske			# Alternatively, Xdialog(1) will terminate with 1
646250323Sdteske			# if/when Cancel is chosen on any widget.
647250323Sdteske			if [ $retval -eq 255 -o ! "$dialog_menu" ]; then
648250323Sdteske				# User pressed ESC or chose Cancel
649250323Sdteske				break
650250323Sdteske			elif [ $retval -eq 1 ]; then
651250323Sdteske				# Using X11, Xdialog(1) returned 1 for Cancel
652250323Sdteske				f_show_msg "%s" "$dialog_menu"
653250323Sdteske				break
654250323Sdteske			elif [ $retval -ne $SUCCESS ]; then
655250323Sdteske				# X11-related error occurred using Xdialog(1)
656250323Sdteske				f_show_msg "%s" "$dialog_menu"
657250323Sdteske				break
658250323Sdteske			fi
659250323Sdteske
660250323Sdteske			defaultitem="$dialog_menu"
661250323Sdteske
662250323Sdteske			# NOTE: f_package_menu_select() does not show the
663250323Sdteske			# `Previous Page' or `Next Page' items unless needed
664250323Sdteske			case "$dialog_menu" in
665250323Sdteske			"> $msg_previous_page"|"> $msg_previous_page*")
666250323Sdteske				page=$(( $page - 1 ))
667250323Sdteske				setvar _defaultpage_$varcat $page
668250323Sdteske				# Update default-item to match accent that will
669250323Sdteske				# be applied by f_package_menu_select(); if the
670250323Sdteske				# page-before-prev is cached, add an asterisk.
671250323Sdteske				if f_isset \
672250323Sdteske					_index_page_${varcat}_$(( $page - 1 ))
673250323Sdteske				then
674250323Sdteske					defaultitem="${defaultitem%\*}*"
675250323Sdteske				else
676250323Sdteske					defaultitem="${defaultitem%\*}"
677250323Sdteske				fi
678250323Sdteske				setvar _defaultitem_$varcat "$defaultitem"
679250323Sdteske				continue ;;
680250323Sdteske			"> $msg_next_page"|"> $msg_next_page*")
681250323Sdteske				page=$(( $page + 1 ))
682250323Sdteske				setvar _defaultpage_$varcat $page
683250323Sdteske				# Update default-item to match accent that will
684250323Sdteske				# be applied by f_package_menu_select(); if the
685250323Sdteske				# page-after-next is cached, add an asterisk.
686250323Sdteske				if f_isset \
687250323Sdteske					_index_page_${varcat}_$(( $page + 1 ))
688250323Sdteske				then
689250323Sdteske					defaultitem="${defaultitem%\*}*"
690250323Sdteske				else
691250323Sdteske					defaultitem="${defaultitem%\*}"
692250323Sdteske				fi
693250323Sdteske				setvar _defaultitem_$varcat "$defaultitem"
694250323Sdteske				continue ;;
695250323Sdteske			"> "*) # Unknown navigation/action item
696250323Sdteske				setvar _defaultpage_$varcat $page
697250323Sdteske				continue ;; # Do not treat as a package
698250323Sdteske			*)
699250323Sdteske				setvar _defaultitem_$varcat "$defaultitem"
700250323Sdteske			esac
701250323Sdteske
702250323Sdteske			# Treat any other selection as a package
703250323Sdteske			package="${dialog_menu# }" # Trim leading space
704250323Sdteske			f_str2varname $package varpkg
705250323Sdteske			f_getvar DIALOG_MENUITEM_$$ mark
706250323Sdteske			mark="${mark#?}"
707250323Sdteske			mark="${mark%%\] *}"
708250323Sdteske			case "$mark" in
709250323Sdteske			"I")
710250323Sdteske				mark=" "
711250323Sdteske				f_package_deselect $package
712250323Sdteske				;;
713250323Sdteske			" "|"D")
714250323Sdteske				mark="I"
715250323Sdteske				f_package_select $package
716250323Sdteske				;;
717250323Sdteske			"X"|"R"|"U")
718250323Sdteske				f_package_menu_deselect $package || continue
719250323Sdteske				dialog_menu=$( f_dialog_menutag )
720250323Sdteske				case "$dialog_menu" in
721250323Sdteske				"X $msg_installed")
722250323Sdteske					f_package_deselect "$package"
723250323Sdteske					mark="X"
724250323Sdteske					;;
725250323Sdteske				"R $msg_reinstall")
726250323Sdteske					f_package_select "$package"
727250323Sdteske					mark="R"
728250323Sdteske					;;
729250323Sdteske				"U $msg_uninstall")
730250323Sdteske					f_package_select "$package"
731250323Sdteske					mark="U"
732250323Sdteske					;;
733250323Sdteske				esac
734250323Sdteske				;;
735250323Sdteske			esac
736250323Sdteske			export _mark_$varpkg="$mark"
737250323Sdteske				# NOTE: exported for awk(1) ENVIRON[]
738250323Sdteske		done
739250323Sdteske	done
740250323Sdteske}
741250323Sdteske
742250323Sdteske############################################################ MAIN
743250323Sdteske
744250323Sdteskef_dprintf "%s: Successfully loaded." packages/packages.subr
745250323Sdteske
746250323Sdteskefi # ! $_PACKAGES_PACKAGES_SUBR
747