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