xref: /freebsd/usr.sbin/bsdconfig/share/packages/packages.subr (revision 595e514d0df2bac5b813d35f83e32875dbf16a83)
1if [ ! "$_PACKAGES_PACKAGES_SUBR" ]; then _PACKAGES_PACKAGES_SUBR=1
2#
3# Copyright (c) 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$
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/strings.subr
36f_include $BSDCFG_SHARE/packages/categories.subr
37f_include $BSDCFG_SHARE/packages/index.subr
38
39BSDCFG_LIBE="/usr/libexec/bsdconfig"
40f_include_lang $BSDCFG_LIBE/include/messages.subr
41
42############################################################ CONFIGURATION
43
44#
45# How many packages to display (maximum) per dialog menubox.
46#
47: ${PACKAGE_MENU_PAGESIZE:=2000}
48
49############################################################ GLOBALS
50
51PACKAGE_CATEGORIES=
52SELECTED_PACKAGES=
53
54#
55# Options
56#
57[ "${SHOW_DESC+set}" ] || SHOW_DESC=1
58
59############################################################ FUNCTIONS
60
61# eval f_package_accent_category_menu $var_to_set $CATEGORY_MENU_LIST
62#
63# Accent the CATEGORY_MENU_LIST produced by f_index_read() (see
64# packages/index.subr). Accented information includes adding an asterisk to the
65# category name if its index has been cached, adding the number of installed
66# packages for each category, and adding the number _selected_ packages for
67# each category.
68#
69# NOTE: The reason `eval' is recommended/shown for the syntax above is because
70# the $CATEGORY_MENU_LIST generated by f_index_read() is meant to be expanded
71# prior to execution (it contains a series of pre-quoted strings which act as
72# the interpolated command arguments).
73#
74f_package_accent_category_menu()
75{
76	local var_to_set="$1" category cat desc help varcat menu_buf n
77	shift 1 # var_to_set
78	while [ $# -gt 0 ]; do
79		category="${1%\*}" desc="${2%%; *}" help="$3"
80		shift 3 # cat/desc/help
81
82		cat="${category# }" # Trim lead space inserted by sort-method
83		f_str2varname "$cat" varcat
84
85		# Add number of installed packages for this category (if any)
86		n=0
87		case "$cat" in
88		"$msg_all") debug= f_getvar "_All_ninstalled" n ;;
89		         *) debug= f_getvar "_${varcat}_ninstalled" n ;;
90		esac &&
91		[ $n -ge 1 ] && desc="$desc; $n $msg_installed_lc"
92
93		# Add number of selected packages for this category (if any)
94		n=0
95		case "$cat" in
96		"$msg_all") debug= f_getvar "_All_nselected" n ;;
97		         *) debug= f_getvar "_${varcat}_nselected" n ;;
98		esac &&
99		[ $n -ge 1 ] && desc="$desc; $n $msg_selected"
100
101		# Re-Add asterisk to the category if its index has been cached
102		f_isset _index_page_${varcat}_1 && category="$category*"
103
104		# Update buffer with modified elements
105		menu_buf="$menu_buf
106		'$category' '$desc' '$help'" # End-Quote
107	done
108	setvar "$var_to_set" "$menu_buf" # return our buffer
109}
110
111# f_package_select $package ...
112#
113# Add $package to the list of tracked/selected packages. If $package is already
114# being tracked (already apears in $SELECTED_PACKAGES), this function amounts
115# to having no effect.
116#
117f_package_select()
118{
119	local package pkgsel
120	while [ $# -gt 0 ]; do
121		package="$1"
122		shift 1 # package
123		for pkgsel in $SELECTED_PACKAGES; do
124			[ "$package" = "$pkgsel" ] && return
125		done
126		SELECTED_PACKAGES="$SELECTED_PACKAGES $package"
127	done
128	SELECTED_PACKAGES="${SELECTED_PACKAGES# }" # Trim leading space
129}
130
131# f_package_deselect $package ...
132#
133# Remove $package from teh list of tracked/selected packages. If $package is
134# not being tracked (doesn't appear in $SELECTED_PACKAGES), this function
135# amounts to having no effet.
136#
137f_package_deselect()
138{
139	local package pkgsel
140	while [ $# -gt 1 ]; do
141		local new_list=""
142		package="$1"
143		shift 1 # package
144		for pkgsel in $SELECTED_PACKAGES; do
145			[ "$pkgsel" = "$package" ] && continue
146			new_list="$new_list${new_list:+ }$pkgsel"
147		done
148		SELECTED_PACKAGES="$new_list"
149	done
150}
151
152# f_package_detect_installed
153#
154# Detect installed packages. Currently this searches /var/db/pkg for directory
155# entries and marks each entry as an installed/selected package.
156#
157f_package_detect_installed()
158{
159	local installed package varpkg
160	installed=$( find -s /var/db/pkg -mindepth 1 -maxdepth 1 -type d |
161			sed -e 's:/var/db/pkg/::' )
162	for package in $installed; do
163		f_str2varname $package varpkg
164		export _mark_$varpkg=X # exported for awk(1) ENVIRON[]
165		f_package_select $package
166	done
167}
168
169# f_package_calculate_totals
170#
171# Calculate number of installed/selected packages for each category listed in
172# $PACKAGE_CATEGORIES (the number of installed packages for $category is stored
173# as $_${varcat}_ninstalled -- where $varcat is the product of `f_str2varname
174# $category varcat' -- and number selected packages as $_${varcat}_nselected).
175# Also calculates the total number of installed/selected packages stored as
176# $_All_ninstalled and $_All_nselected.
177#
178# Calculations are peformed by checking "marks". A "mark" is stored as
179# $_mark_$varpkg -- where $varpkg is the product of `f_str2varname $package
180# varpkg'. A mark can be "X" for an installed package, `I' for a package that
181# is marked for installation, "R" for a package that is marked for re-install,
182# and "U" for a package that is marked for uninstallation. If a package mark is
183# NULL or a single space (e.g., " "), the package is considered to be NOT
184# selected (and therefore does not increment the counts calculated herein).
185#
186f_package_calculate_totals()
187{
188	local pkg varpkg mark cat varcat pkgcat n tselected=0 tinstalled=0
189	for cat in $PACKAGE_CATEGORIES; do
190		f_str2varname $cat varcat
191		setvar _${varcat}_ninstalled=0
192		setvar _${varcat}_nselected=0
193	done
194	for pkg in $SELECTED_PACKAGES; do
195		f_str2varname $pkg varpkg
196		mark=
197		f_getvar _mark_$varpkg mark
198		case "$mark" in
199		""|" ") : ;;
200		X) tinstalled=$(( $tinstalled + 1 ));;
201		*) tselected=$(( $tselected + 1 ))
202		esac
203		f_getvar _categories_$varpkg pkgcat
204		for cat in $pkgcat; do
205			f_str2varname $cat varcat
206			case "$mark" in
207			""|" ") : ;;
208			X) debug= f_getvar _${varcat}_ninstalled n
209			   setvar _${varcat}_ninstalled $(( $n + 1 ));;
210			*) debug= f_getvar _${varcat}_nselected n
211			   setvar _${varcat}_nselected $(( $n + 1 ))
212			esac
213		done
214	done
215	_All_nselected=$tselected
216	_All_ninstalled=$tinstalled
217}
218
219# f_package_calculate_rundeps
220#
221# Update package dependencies by first unmarking all dependencies and then
222# re-marking all dependencies of packages marked for either install ("I") or
223# re-install ("R").
224#
225f_package_calculate_rundeps()
226{
227	local pkg varpkg mark rundeps dep vardep
228
229	#
230	# First unmark all the existing run-dependencies
231	#
232	f_dprintf "Unselecting package run-dependencies..."
233	for pkg in $SELECTED_PACKAGES; do
234		f_str2varname $pkg varpkg
235		mark=
236		debug= f_getvar _mark_$varpkg mark
237		# Only unmark if it's marked as a Dependency
238		if [ "$mark" = "D" ]; then
239			f_dprintf "%s unselected" $pkg
240			unset _mark_$varpkg
241			f_package_deselect $pkg
242		fi
243	done
244
245	#
246	# Processes selected packages, adding dependencies
247	#
248	f_dprintf "Re-selecting package run-dependencies..."
249	for pkg in $SELECTED_PACKAGES; do
250		f_str2varname $pkg varpkg
251		mark=
252		debug= f_getvar _mark_$varpkg mark
253		# Skip pkg unless marked for [Re-]Install
254		[ "$mark" = "I" -o "$mark" = "R" ] || continue
255		f_getvar _rundeps_$varpkg rundeps
256		for dep in $rundeps; do
257			f_str2varname $dep vardep
258			mark=
259			debug= f_getvar _mark_$vardep mark
260			# Skip dep if already marked
261			[ "${mark:- }" = " " ] || continue
262			export _mark_$vardep="D"
263			f_package_select $dep
264		done
265	done
266
267	f_dprintf "Finished recalculating dependencies."
268}
269
270# f_package_menu_categories $var_to_set $defaultitem
271#
272# Dislay the menu of package categories, complete with package counts for each
273# category, accents, and other miscellany. If $defaultitem is non-NULL and
274# matches one of the existing menu-items, it will be pre-highlighted in the
275# menu dialog (HINT: Use f_dialog_menutag_fetch() to populate a local variable
276# that is passed as $defaultitem to highlight the user's last selection).
277#
278f_package_menu_categories()
279{
280	local var_to_get="$1" defaultitem="$2"
281	local prompt="$msg_please_select_a_category_to_display"
282	local menu_list="
283		'> $msg_review' '$msg_review_desc' '$msg_review_help'
284	" # End-Quote
285	local hline=
286
287	f_package_calculate_rundeps
288		# updates package mark variables and SELECTED_PACKAGES
289	f_package_calculate_totals
290		# creates _{varcat}_ninstalled and _{varcat}_nselected
291
292	local category_list
293	debug= f_getvar "$var_to_get" category_list || return $FAILURE
294
295	# Accent the category menu list with ninstalled/nselected
296	eval f_package_accent_category_menu category_list $category_list
297
298	# Add list of categories to menu list
299	menu_list="$menu_list $category_list"
300
301	local height width rows
302	eval f_dialog_menu_with_help_size height width rows \
303	                                  \"\$DIALOG_TITLE\"     \
304	                                  \"\$DIALOG_BACKTITLE\" \
305	                                  \"\$prompt\"           \
306	                                  \"\$hline\"            \
307	                                  $menu_list
308	local menu_choice
309	menu_choice=$( eval $DIALOG \
310		--title \"\$DIALOG_TITLE\"         \
311		--backtitle \"\$DIALOG_BACKTITLE\" \
312		--hline \"\$hline\"                \
313		--item-help                        \
314		--default-item \"\$defaultitem\"   \
315		--ok-label \"$msg_select\"         \
316		--cancel-label \"$msg_cancel\"     \
317		--menu \"\$prompt\"                \
318		$height $width $rows               \
319		$menu_list                         \
320		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
321	)
322	local retval=$?
323	f_dialog_menutag_store -s "$menu_choice"
324	return $retval
325}
326
327# f_package_index_get_page $category $page [$var_to_set [$var_to_get]]
328#
329# Obtain a [potentially cached] page of the INDEX file for a given $category.
330# If $page is 1 and the cache has not yet been generated, the cache-generating
331# function f_index_extract_pages() (above) is called to generate all pages
332# (not just the requested page) in cache before returning the requested page.
333# If $page is not 1 and there is no cached page, failure status is returned.
334#
335f_package_index_get_page()
336{
337	local category="$1" page="$2" var_to_set="$3" var_to_get="$4" varcat
338	f_str2varname "$category" varcat
339	if ! debug= f_getvar "_index_page_${varcat}_$page" $var_to_set &&
340	   [ "$page" = "1" ]
341	then
342		f_show_info "$msg_building_package_menus"
343		local pagesize="$PACKAGE_MENU_PAGESIZE"
344		f_index_extract_pages "${var_to_get:-PACKAGE_INDEX}" \
345			_index_page_${varcat} "$pagesize" "$category"
346		debug= f_getvar _index_page_${varcat}_$page $var_to_set
347
348		# Update category default-item because now we're cached
349		[ $page -eq 1 ] &&
350		    category_defaultitem="${category_defaultitem%\*}*"
351	else
352		return $FAILURE
353	fi
354}
355
356# f_package_menu_select $category [$page [$defaultitem]]
357#
358# Display list of packages for $category, optionally $page N and with a default
359# item selected. If $page is omitted, the first page is displayed (but this
360# only matters if there are multiple pages; which is determined by the global
361# maximum $PACKAGE_MENU_PAGESIZE).
362#
363# On success, if the user doesn't press ESC or choose Cancel, use
364# f_dialog_menuitem_fetch() to populate a local variable with the item (not
365# tag) corresponding to the user's selection. The tag portion of the user's
366# selection is available through f_dialog_menutag_fetch().
367#
368f_package_menu_select()
369{
370	local category="$1" page="${2:-1}"
371	local prompt= # Calculated below
372	local menu_list # Calculated below
373	local defaultitem="$3"
374	local hline="$hline_arrows_tab_punc_enter"
375
376	f_isinteger "$page" || return $FAILURE
377
378	local varcat
379	f_str2varname "$category" varcat
380
381	# Get number of packages for this category
382	local npkgs=0
383	case "$category" in
384	"$msg_all"|"") npkgs="${_npkgs:-0}";;
385	*) f_getvar _npkgs_$varcat npkgs
386	esac
387
388	# Calculate number of pages
389	local npages=$(( ${npkgs:=0} / $PACKAGE_MENU_PAGESIZE ))
390
391	# Add a page to the pagecount if not evenly divisible
392	[ $(( $npages * $PACKAGE_MENU_PAGESIZE )) -lt $npkgs ] &&
393		npages=$(( $npages + 1 ))
394
395	# Print some debugging information
396	f_dprintf "f_package_menu_select: category=[%s] npkgs=%u npages=%u" \
397	          "$category" "$npkgs" "$npages"
398
399	local add_prev="" add_next=""
400	local previous_page="$msg_previous_page" next_page="$msg_next_page"
401	if [ $page -gt 1 ]; then
402		add_prev=1
403		# Accent the `Previous Page' item with an asterisk
404		# if the page-before-previous is loaded/cached
405		f_isset _index_page_${varcat}_$(( $page - 1 )) &&
406			previous_page="$previous_page*"
407	fi
408	if [ $page -lt $npages ]; then
409		add_next=1
410		# Accent the `Next Page' item with an asterisk
411		# if the page-after-next is loaded/cached
412		f_isset _index_page_${varcat}_$(( $page + 1 )) &&
413			next_page="$next_page*"
414	fi
415
416	local index_page
417	f_package_index_get_page "$category" $page index_page
418
419	menu_list="
420		${add_prev:+'> $previous_page' '' ${SHOW_DESC:+''}}
421		${add_next:+'> $next_page' '' ${SHOW_DESC:+''}}
422	$(
423		export SHOW_DESC
424		export VALID_VARNAME_CHARS
425		echo "$index_page" | awk -F'|' -v view="port" '
426		BEGIN {
427			valid_chars = ENVIRON["VALID_VARNAME_CHARS"]
428			prefix = ""
429		}
430		{
431			cur_prefix = tolower(substr($1, 1, 1))
432			printf "'\''"
433			if ( prefix != cur_prefix )
434				prefix = cur_prefix
435			else
436				printf " "
437			package = $1
438			if ( view == "port" )
439				desc = $2
440			varpkg = package
441			gsub("[^" valid_chars "]", "_", varpkg)
442			mark = ENVIRON["_mark_" varpkg]
443			if ( ! mark ) mark = " "
444			printf "%s'\'' '\''[%c] %s'\''",
445			       package, mark, desc
446			if ( ENVIRON["SHOW_DESC"] ) {
447				help = $4
448				gsub(/'\''/, "'\''\\'\'\''", help)
449				printf " '\''%s'\''", help
450			}
451			printf "\n"
452		}'
453	)
454		${add_prev:+'> $previous_page' '' ${SHOW_DESC:+''}}
455		${add_next:+'> $next_page' '' ${SHOW_DESC:+''}}
456	" # End-Quote
457
458	# Accept/Translate i18n "All" but other category names must
459	# match tree definitions from INDEX, ports, FTP, etc.
460	case "$category" in
461	"$msg_all"|"") f_category_desc_get "All" prompt ;;
462	            *) f_category_desc_get "$category" prompt ;;
463	esac
464	prompt="$prompt $( printf "$msg_page_of_npages" \
465	                          "$page" "$npages" )"
466
467	local mheight mwidth mrows
468	eval f_dialog_menu${SHOW_DESC:+_with_help}_size mheight mwidth mrows \
469	        	\"\$DIALOG_TITLE\" \"\$DIALOG_BACKTITLE\" \
470	        	\"\$prompt\" \"\$hline\" $menu_list
471	local iheight iwidth
472	f_dialog_infobox_size iheight iwidth \
473	         	"$DIALOG_TITLE" "$DIALOG_BACKTITLE" \
474	         	"$msg_processing_selection"
475
476	local menu_choice
477	menu_choice=$( eval $DIALOG \
478		--title \"\$DIALOG_TITLE\"         \
479		--backtitle \"\$DIALOG_BACKTITLE\" \
480		--hline \"\$hline\"                \
481		--keep-tite                        \
482		--ok-label \"$msg_select\"         \
483		--cancel-label \"$msg_back\"       \
484		${SHOW_DESC:+--item-help}          \
485		--default-item \"\$defaultitem\"   \
486		--menu \"\$prompt\"                \
487		$mheight $mwidth $mrows            \
488		$menu_list                         \
489		--and-widget                       \
490		${USE_XDIALOG:+--no-buttons}       \
491		--infobox \"\$msg_processing_selection\" \
492		$iheight $iwidth                   \
493		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
494	)
495	local retval=$?
496	f_dialog_data_sanitize menu_choice
497	f_dialog_menutag_store "$menu_choice"
498
499	if [ $retval -eq $SUCCESS ]; then
500		local item
501		item=$( eval f_dialog_menutag2item${SHOW_DESC:+_with_help} \
502		             	\"\$menu_choice\" $menu_list )
503		f_dialog_menuitem_store "$item"
504	fi
505
506	return $retval
507}
508
509# f_package_menu_deselect $package
510#
511# Display a menu, asking the user what they would like to do with $package
512# with regard to "deselecting" an already installed package. Choices include
513# uninstall, re-install, or cancel (leave $package marked as installed).
514# Returns success if the user does not press ESC or choose Cnacel. Use the
515# f_dialog_menutag_fetch() function upon success to retrieve the user's choice.
516#
517f_package_menu_deselect()
518{
519	local package="$1"
520	local prompt # Calculated below
521	local menu_list="
522		'X $msg_installed' '$msg_installed_desc'
523		'R $msg_reinstall' '$msg_reinstall_desc'
524		'U $msg_uninstall' '$msg_uninstall_desc'
525	" # End-Quote
526	local hline="$hline_alnum_arrows_punc_tab_enter"
527
528	prompt=$( printf "$msg_what_would_you_like_to_do_with" "$package" )
529
530	local height width rows
531	eval f_dialog_menu_size height width rows \
532	                        \"\$DIALOG_TITLE\"     \
533	                        \"\$DIALOG_BACKTITLE\" \
534	                        \"\$prompt\"           \
535	                        \"\$hline\"            \
536	                        $menu_list
537	local menu_choice
538	menu_choice=$( eval $DIALOG \
539		--title \"\$DIALOG_TITLE\"         \
540		--backtitle \"\$DIALOG_BACKTITLE\" \
541		--hline \"\$hline\"                \
542		--ok-label \"$msg_select\"         \
543		--cancel-label \"$msg_cancel\"     \
544		--menu \"\$prompt\"                \
545		$height $width $rows               \
546		$menu_list                         \
547		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
548	)
549	local retval=$?
550	f_dialog_menutag_store -s "$menu_choice"
551	return $retval
552}
553
554# f_package_review
555#
556# Display a review screen, showing selected packages and what they are marked
557# for, before proceeding (if the user does not press ESC or choose Cancel) to
558# operate on each selection. Returns error if no packages have been selected,
559# or the user has pressed ESC, or if they have chosen Cancel.
560#
561f_package_review()
562{
563	local prompt # Calculated below
564	local menu_list # Calculated below
565	local hline="$hline_alnum_arrows_punc_tab_enter"
566
567	f_dprintf "f_package_review: SELECTED_PACKAGES=[%s]" \
568	          "$SELECTED_PACKAGES"
569
570	prompt=$( printf "$msg_reviewing_selected_packages" "$_All_nselected" )
571
572	local package varpkg mark
573	for package in $SELECTED_PACKAGES; do
574		mark=
575		f_str2varname "$package" varpkg
576		f_getvar _mark_$varpkg mark
577		[ "$mark" -a ! "${mark#[IRUD]}" ] || continue
578		menu_list="$menu_list
579			'$mark' '$package'
580		" # End-Quote
581	done
582	if [ ! "$menu_list" ]; then
583		f_show_msg "$msg_no_packages_were_selected_for_extraction"
584		return $FAILURE # They might have selected this by accident
585	fi
586	menu_list=$( echo "$menu_list" | sort )
587
588	local height width rows
589	eval f_dialog_menu_size height width rows \
590	                        \"\$DIALOG_TITLE\"     \
591	                        \"\$DIALOG_BACKTITLE\" \
592	                        \"\$prompt\"           \
593	                        \"\$hline\"            \
594	                        $menu_list
595
596	# Show the review menu (ignore menu choice)
597	eval $DIALOG \
598		--title \"\$DIALOG_TITLE\"         \
599		--backtitle \"\$DIALOG_BACKTITLE\" \
600		--hline \"\$hline\"                \
601		--ok-label \"\$msg_proceed\"       \
602		--cancel-label \"\$msg_cancel\"    \
603		--menu \"\$prompt\"                \
604		$height $width $rows               \
605		$menu_list                         \
606		2> /dev/null
607	local retval=$?
608
609	#
610	# XXX
611	#
612	f_show_msg "Coming soon..."
613	#
614	# XXX
615	#
616
617	return $retval
618}
619
620# f_package_config
621#
622# Allow the user to configure packages and install them. Initially, a list of
623# package categories is loaded/displayed. When the user selects a category,
624# the menus for that category are built (unlike sysinstall which built all
625# category menus up-front -- which also took forever, despite the fact that
626# few people visit more than a couple of categories each time).
627#
628f_package_config()
629{
630	# Did we get an INDEX?
631	f_index_initialize packages/INDEX || return $FAILURE
632		# Creates following variables (indirectly via f_index_read())
633		#   CATEGORY_MENU_LIST _categories_{varpkg} _rundeps_{varpkg}
634		#   PACKAGE_CATEGORIES _npkgs
635
636	# Detect installed packages (updates marks/SELECTED_PACKAGES)
637	f_package_detect_installed
638
639	local retval category varcat defaultitem category_defaultitem=""
640	while :; do
641		# Display the list of package categories
642		f_package_menu_categories \
643			CATEGORY_MENU_LIST "$category_defaultitem"
644		retval=$?
645		f_dialog_menutag_fetch category
646		f_dprintf "retval=%u mtag=[%s]" $retval "$category"
647		category_defaultitem="$category"
648
649		[ $retval -eq $SUCCESS ] || break
650
651		# Maybe the user chose an action (like `Review')
652		case "$category" in
653		"> $msg_review")
654			f_package_review && break
655			continue ;;
656		"> "*)
657			continue
658		esac
659
660		# Anything else is a package category
661
662		category=${category# } # Trim leading space if present
663		category=${category%\*} # Trim trailing asterisk if present
664
665		f_str2varname "$category" varcat
666
667		local page package varpkg mark menu_choice
668		while :; do
669			# Display the list of packages for selected category
670			page=1 defaultitem=""
671			f_getvar _defaultitem_$varcat defaultitem
672			f_getvar _defaultpage_$varcat page
673			f_package_menu_select \
674				"$category" "${page:=1}" "$defaultitem"
675			retval=$?
676			f_dialog_menutag_fetch menu_choice
677			f_dprintf "retval=%u mtag=[%s]" $retval "$menu_choice"
678
679			# NOTE: When --and-widget is used only ESC will cause
680			# dialog(1) to return without going to the next widget.
681			# This is alright in our case as we can still detect
682			# the Cancel button because stdout will be NULL.
683			# Alternatively, Xdialog(1) will terminate with 1
684			# if/when Cancel is chosen on any widget.
685			if [ $retval -eq 255 -o ! "$menu_choice" ]; then
686				# User pressed ESC or chose Cancel
687				break
688			elif [ $retval -eq 1 ]; then
689				# Using X11, Xdialog(1) returned 1 for Cancel
690				f_show_msg "%s" "$menu_choice"
691				break
692			elif [ $retval -ne $SUCCESS ]; then
693				# X11-related error occurred using Xdialog(1)
694				f_show_msg "%s" "$menu_choice"
695				break
696			fi
697
698			defaultitem="$menu_choice"
699
700			# NOTE: f_package_menu_select() does not show the
701			# `Previous Page' or `Next Page' items unless needed
702			case "$menu_choice" in
703			"> $msg_previous_page"|"> $msg_previous_page*")
704				page=$(( $page - 1 ))
705				setvar _defaultpage_$varcat $page
706				# Update default-item to match accent that will
707				# be applied by f_package_menu_select(); if the
708				# page-before-prev is cached, add an asterisk.
709				if f_isset \
710					_index_page_${varcat}_$(( $page - 1 ))
711				then
712					defaultitem="${defaultitem%\*}*"
713				else
714					defaultitem="${defaultitem%\*}"
715				fi
716				setvar _defaultitem_$varcat "$defaultitem"
717				continue ;;
718			"> $msg_next_page"|"> $msg_next_page*")
719				page=$(( $page + 1 ))
720				setvar _defaultpage_$varcat $page
721				# Update default-item to match accent that will
722				# be applied by f_package_menu_select(); if the
723				# page-after-next is cached, add an asterisk.
724				if f_isset \
725					_index_page_${varcat}_$(( $page + 1 ))
726				then
727					defaultitem="${defaultitem%\*}*"
728				else
729					defaultitem="${defaultitem%\*}"
730				fi
731				setvar _defaultitem_$varcat "$defaultitem"
732				continue ;;
733			"> "*) # Unknown navigation/action item
734				setvar _defaultpage_$varcat $page
735				continue ;; # Do not treat as a package
736			*)
737				setvar _defaultitem_$varcat "$defaultitem"
738			esac
739
740			# Treat any other selection as a package
741			package="${menu_choice# }" # Trim leading space
742			f_str2varname $package varpkg
743			f_dialog_menuitem_fetch mark
744			mark="${mark#?}"
745			mark="${mark%%\] *}"
746			case "$mark" in
747			"I")
748				mark=" "
749				f_package_deselect $package
750				;;
751			" "|"D")
752				mark="I"
753				f_package_select $package
754				;;
755			"X"|"R"|"U")
756				f_package_menu_deselect $package || continue
757				f_dialog_menutag_fetch menu_choice
758				case "$menu_choice" in
759				"X $msg_installed")
760					f_package_deselect "$package"
761					mark="X"
762					;;
763				"R $msg_reinstall")
764					f_package_select "$package"
765					mark="R"
766					;;
767				"U $msg_uninstall")
768					f_package_select "$package"
769					mark="U"
770					;;
771				esac
772				;;
773			esac
774			export _mark_$varpkg="$mark"
775				# NOTE: exported for awk(1) ENVIRON[]
776		done
777	done
778}
779
780############################################################ MAIN
781
782f_dprintf "%s: Successfully loaded." packages/packages.subr
783
784fi # ! $_PACKAGES_PACKAGES_SUBR
785