]> CyberLeo.Net >> Repos - FreeBSD/releng/9.3.git/blob - usr.sbin/bsdconfig/share/packages/packages.subr
Copy stable/9 to releng/9.3 as part of the 9.3-RELEASE cycle.
[FreeBSD/releng/9.3.git] / usr.sbin / bsdconfig / share / packages / packages.subr
1 if [ ! "$_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 (INCLUDING, 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
31 BSDCFG_SHARE="/usr/share/bsdconfig"
32 . $BSDCFG_SHARE/common.subr || exit 1
33 f_dprintf "%s: loading includes..." "$0"
34 f_include $BSDCFG_SHARE/dialog.subr
35 f_include $BSDCFG_SHARE/device.subr
36 f_include $BSDCFG_SHARE/media/common.subr
37 f_include $BSDCFG_SHARE/packages/categories.subr
38 f_include $BSDCFG_SHARE/packages/index.subr
39 f_include $BSDCFG_SHARE/strings.subr
40
41 BSDCFG_LIBE="/usr/libexec/bsdconfig"
42 f_include_lang $BSDCFG_LIBE/include/messages.subr
43
44 ############################################################ CONFIGURATION
45
46 #
47 # How many packages to display (maximum) per dialog menubox.
48 #
49 : ${PACKAGE_MENU_PAGESIZE:=2000}
50
51 ############################################################ GLOBALS
52
53 #
54 # Package extensions to try
55 #
56 PACKAGE_EXTENSIONS=".tbz .tbz2 .tgz"
57
58 #
59 # Variables used to track runtime states
60 #
61 PACKAGES_DETECTED=      # Boolean (NULL/non-NULL); detected installed packages?
62 PACKAGE_CATEGORIES=     # List of package categories parsed from INDEX
63 SELECTED_PACKAGES=      # Packages selected by user in [X]dialog(1) interface
64
65 #
66 # Options
67 #
68 [ "${SHOW_DESC+set}" ] || SHOW_DESC=1
69
70 ############################################################ FUNCTIONS
71
72 # eval f_package_accent_category_menu $var_to_set $CATEGORY_MENU_LIST
73 #
74 # Accent the CATEGORY_MENU_LIST produced by f_index_read() (see
75 # packages/index.subr). Accented information includes adding an asterisk to the
76 # category name if its index has been cached, adding the number of installed
77 # packages for each category, and adding the number _selected_ packages for
78 # each category.
79 #
80 # NOTE: The reason `eval' is recommended/shown for the syntax above is because
81 # the $CATEGORY_MENU_LIST generated by f_index_read() is meant to be expanded
82 # prior to execution (it contains a series of pre-quoted strings which act as
83 # the interpolated command arguments).
84 #
85 f_package_accent_category_menu()
86 {
87         local var_to_set="$1" category cat desc help varcat menu_buf n
88         shift 1 # var_to_set
89         while [ $# -gt 0 ]; do
90                 category="${1%\*}" desc="${2%%; *}" help="$3"
91                 shift 3 # cat/desc/help
92
93                 cat="${category# }" # Trim lead space inserted by sort-method
94                 f_str2varname "$cat" varcat
95
96                 # Add number of installed packages for this category (if any)
97                 n=0
98                 case "$cat" in
99                 "$msg_all") debug= f_getvar "_All_ninstalled" n ;;
100                          *) debug= f_getvar "_${varcat}_ninstalled" n ;;
101                 esac &&
102                 [ $n -ge 1 ] && desc="$desc; $n $msg_installed_lc"
103
104                 # Add number of selected packages for this category (if any)
105                 n=0
106                 case "$cat" in
107                 "$msg_all") debug= f_getvar "_All_nselected" n ;;
108                          *) debug= f_getvar "_${varcat}_nselected" n ;;
109                 esac &&
110                 [ $n -ge 1 ] && desc="$desc; $n $msg_selected"
111
112                 # Re-Add asterisk to the category if its index has been cached
113                 f_isset _index_page_${varcat}_1 && category="$category*"
114
115                 # Update buffer with modified elements
116                 menu_buf="$menu_buf
117                 '$category' '$desc' '$help'" # End-Quote
118         done
119         setvar "$var_to_set" "$menu_buf" # return our buffer
120 }
121
122 # f_package_select $package ...
123 #
124 # Add $package to the list of tracked/selected packages. If $package is already
125 # being tracked (already apears in $SELECTED_PACKAGES), this function amounts
126 # to having no effect.
127 #
128 f_package_select()
129 {
130         local package pkgsel
131         while [ $# -gt 0 ]; do
132                 package="$1"
133                 shift 1 # package
134                 for pkgsel in $SELECTED_PACKAGES; do
135                         [ "$package" = "$pkgsel" ] && return $SUCCESS
136                 done
137                 SELECTED_PACKAGES="$SELECTED_PACKAGES $package"
138                 f_dprintf "Added %s to selection list" "$package"
139         done
140         SELECTED_PACKAGES="${SELECTED_PACKAGES# }" # Trim leading space
141 }
142
143 # f_package_deselect $package ...
144 #
145 # Remove $package from teh list of tracked/selected packages. If $package is
146 # not being tracked (doesn't appear in $SELECTED_PACKAGES), this function
147 # amounts to having no effet.
148 #
149 f_package_deselect()
150 {
151         local package pkgsel
152         while [ $# -gt 1 ]; do
153                 local new_list=""
154                 package="$1"
155                 shift 1 # package
156                 for pkgsel in $SELECTED_PACKAGES; do
157                         [ "$pkgsel" = "$package" ] && continue
158                         new_list="$new_list${new_list:+ }$pkgsel"
159                 done
160                 SELECTED_PACKAGES="$new_list"
161                 f_dprintf "Removed %s from selection list" "$package"
162         done
163 }
164
165 # f_package_detect_installed
166 #
167 # Detect installed packages. Currently this searches /var/db/pkg for directory
168 # entries and marks each entry as an installed/selected package.
169 #
170 f_package_detect_installed()
171 {
172         local installed package varpkg
173         #
174         # XXX KLUDGE ALERT! This makes evil assumptions about how XXX
175         # packages register themselves and should *really* be done with
176         # `pkg_info -e <name>' except that this is too slow for an
177         # item check routine.. :-(
178         #
179         # NOTE: When transitioning to pkgng, make a single fork to `pkg' to
180         #       produce a list of all installed packages and parse _that_
181         #
182         installed=$( find -s /var/db/pkg -mindepth 1 -maxdepth 1 -type d |
183                         sed -e 's:/var/db/pkg/::' )
184         for package in $installed; do
185                 f_str2varname $package varpkg
186                 export _mark_$varpkg=X # exported for awk(1) ENVIRON[]
187                 f_package_select $package
188         done
189 }
190
191 # f_package_calculate_totals
192 #
193 # Calculate number of installed/selected packages for each category listed in
194 # $PACKAGE_CATEGORIES (the number of installed packages for $category is stored
195 # as $_${varcat}_ninstalled -- where $varcat is the product of `f_str2varname
196 # $category varcat' -- and number selected packages as $_${varcat}_nselected).
197 # Also calculates the total number of installed/selected packages stored as
198 # $_All_ninstalled and $_All_nselected.
199 #
200 # Calculations are peformed by checking "marks". A "mark" is stored as
201 # $_mark_$varpkg -- where $varpkg is the product of `f_str2varname $package
202 # varpkg'. A mark can be "X" for an installed package, `I' for a package that
203 # is marked for installation, "R" for a package that is marked for re-install,
204 # and "U" for a package that is marked for uninstallation. If a package mark is
205 # NULL or a single space (e.g., " "), the package is considered to be NOT
206 # selected (and therefore does not increment the counts calculated herein).
207 #
208 f_package_calculate_totals()
209 {
210         local pkg varpkg mark cat varcat pkgcat n tselected=0 tinstalled=0
211         for cat in $PACKAGE_CATEGORIES; do
212                 f_str2varname $cat varcat
213                 setvar _${varcat}_ninstalled=0
214                 setvar _${varcat}_nselected=0
215         done
216         for pkg in $SELECTED_PACKAGES; do
217                 f_str2varname $pkg varpkg
218                 mark=
219                 f_getvar _mark_$varpkg mark
220                 case "$mark" in
221                 ""|" ") : ;;
222                 X) tinstalled=$(( $tinstalled + 1 )) ;;
223                 *) tselected=$(( $tselected + 1 ))
224                 esac
225                 f_getvar _categories_$varpkg pkgcat
226                 for cat in $pkgcat; do
227                         f_str2varname $cat varcat
228                         case "$mark" in
229                         ""|" ") : ;;
230                         X) debug= f_getvar _${varcat}_ninstalled n
231                            setvar _${varcat}_ninstalled $(( $n + 1 )) ;;
232                         *) debug= f_getvar _${varcat}_nselected n
233                            setvar _${varcat}_nselected $(( $n + 1 ))
234                         esac
235                 done
236         done
237         _All_nselected=$tselected
238         _All_ninstalled=$tinstalled
239 }
240
241 # f_package_calculate_rundeps
242 #
243 # Update package dependencies by first unmarking all dependencies and then
244 # re-marking all dependencies of packages marked for either install ("I") or
245 # re-install ("R").
246 #
247 f_package_calculate_rundeps()
248 {
249         local pkg varpkg mark rundeps dep vardep
250
251         #
252         # First unmark all the existing run-dependencies
253         #
254         f_dprintf "Unselecting package run-dependencies..."
255         for pkg in $SELECTED_PACKAGES; do
256                 f_str2varname $pkg varpkg
257                 mark=
258                 debug= f_getvar _mark_$varpkg mark
259                 # Only unmark if it's marked as a Dependency
260                 if [ "$mark" = "D" ]; then
261                         f_dprintf "%s unselected" $pkg
262                         unset _mark_$varpkg
263                         f_package_deselect $pkg
264                 fi
265         done
266
267         #
268         # Processes selected packages, adding dependencies
269         #
270         f_dprintf "Re-selecting package run-dependencies..."
271         for pkg in $SELECTED_PACKAGES; do
272                 f_str2varname $pkg varpkg
273                 mark=
274                 debug= f_getvar _mark_$varpkg mark
275                 # Skip pkg unless marked for [Re-]Install
276                 [ "$mark" = "I" -o "$mark" = "R" ] || continue
277                 f_getvar _rundeps_$varpkg rundeps
278                 for dep in $rundeps; do
279                         f_str2varname $dep vardep
280                         mark=
281                         debug= f_getvar _mark_$vardep mark
282                         # Skip dep if already marked
283                         [ "${mark:- }" = " " ] || continue
284                         export _mark_$vardep="D"
285                         f_package_select $dep
286                 done
287         done
288
289         f_dprintf "Finished recalculating dependencies."
290 }
291
292 # f_package_menu_categories $var_to_set $defaultitem
293 #
294 # Dislay the menu of package categories, complete with package counts for each
295 # category, accents, and other miscellany. If $defaultitem is non-NULL and
296 # matches one of the existing menu-items, it will be pre-highlighted in the
297 # menu dialog (HINT: Use f_dialog_menutag_fetch() to populate a local variable
298 # that is passed as $defaultitem to highlight the user's last selection).
299 #
300 f_package_menu_categories()
301 {
302         local var_to_get="$1" defaultitem="$2"
303         local prompt="$msg_please_select_a_category_to_display"
304         local menu_list="
305                 '> $msg_review' '$msg_review_desc' '$msg_review_help'
306         " # End-Quote
307         local hline=
308
309         f_package_calculate_rundeps
310                 # updates package mark variables and SELECTED_PACKAGES
311         f_package_calculate_totals
312                 # creates _{varcat}_ninstalled and _{varcat}_nselected
313
314         local category_list
315         debug= f_getvar "$var_to_get" category_list || return $DIALOG_CANCEL
316
317         # Accent the category menu list with ninstalled/nselected
318         eval f_package_accent_category_menu category_list $category_list
319
320         # Add list of categories to menu list
321         menu_list="$menu_list $category_list"
322
323         local height width rows
324         eval f_dialog_menu_with_help_size height width rows \
325                                           \"\$DIALOG_TITLE\"     \
326                                           \"\$DIALOG_BACKTITLE\" \
327                                           \"\$prompt\"           \
328                                           \"\$hline\"            \
329                                           $menu_list
330         local menu_choice
331         menu_choice=$( eval $DIALOG \
332                 --title \"\$DIALOG_TITLE\"         \
333                 --backtitle \"\$DIALOG_BACKTITLE\" \
334                 --hline \"\$hline\"                \
335                 --item-help                        \
336                 --default-item \"\$defaultitem\"   \
337                 --ok-label \"$msg_select\"         \
338                 --cancel-label \"$msg_cancel\"     \
339                 --menu \"\$prompt\"                \
340                 $height $width $rows               \
341                 $menu_list                         \
342                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
343         )
344         local retval=$?
345         f_dialog_menutag_store -s "$menu_choice"
346         return $retval
347 }
348
349 # f_package_index_get_page $category $page [$var_to_set [$var_to_get]]
350 #
351 # Obtain a [potentially cached] page of the INDEX file for a given $category.
352 # If $page is 1 and the cache has not yet been generated, the cache-generating
353 # function f_index_extract_pages() (above) is called to generate all pages
354 # (not just the requested page) in cache before returning the requested page.
355 # If $page is not 1 and there is no cached page, failure status is returned.
356 #
357 f_package_index_get_page()
358 {
359         local category="$1" page="$2" var_to_set="$3" var_to_get="$4" varcat
360         f_str2varname "$category" varcat
361         if ! debug= f_getvar "_index_page_${varcat}_$page" $var_to_set &&
362            [ "$page" = "1" ]
363         then
364                 f_show_info "$msg_building_package_menus"
365                 local pagesize="$PACKAGE_MENU_PAGESIZE"
366                 f_index_extract_pages "${var_to_get:-PACKAGE_INDEX}" \
367                         _index_page_${varcat} "$pagesize" "$category"
368                 debug= f_getvar _index_page_${varcat}_$page $var_to_set
369
370                 # Update category default-item because now we're cached
371                 [ $page -eq 1 ] &&
372                     category_defaultitem="${category_defaultitem%\*}*"
373         else
374                 return $FAILURE
375         fi
376 }
377
378 # f_package_menu_select $category [$page [$defaultitem]]
379 #
380 # Display list of packages for $category, optionally $page N and with a default
381 # item selected. If $page is omitted, the first page is displayed (but this
382 # only matters if there are multiple pages; which is determined by the global
383 # maximum $PACKAGE_MENU_PAGESIZE).
384 #
385 # On success, if the user doesn't press ESC or choose Cancel, use
386 # f_dialog_menuitem_fetch() to populate a local variable with the item (not
387 # tag) corresponding to the user's selection. The tag portion of the user's
388 # selection is available through f_dialog_menutag_fetch().
389 #
390 f_package_menu_select()
391 {
392         local category="$1" page="${2:-1}"
393         local prompt= # Calculated below
394         local menu_list # Calculated below
395         local defaultitem="$3"
396         local hline="$hline_arrows_tab_punc_enter"
397
398         f_isinteger "$page" || return $DIALOG_CANCEL
399
400         local varcat
401         f_str2varname "$category" varcat
402
403         # Get number of packages for this category
404         local npkgs=0
405         case "$category" in
406         "$msg_all"|"") npkgs="${_npkgs:-0}" ;;
407         *) f_getvar _npkgs_$varcat npkgs
408         esac
409
410         # Calculate number of pages
411         local npages=$(( ${npkgs:=0} / $PACKAGE_MENU_PAGESIZE ))
412
413         # Add a page to the pagecount if not evenly divisible
414         [ $(( $npages * $PACKAGE_MENU_PAGESIZE )) -lt $npkgs ] &&
415                 npages=$(( $npages + 1 ))
416
417         # Print some debugging information
418         f_dprintf "f_package_menu_select: category=[%s] npkgs=%u npages=%u" \
419                   "$category" "$npkgs" "$npages"
420
421         local add_prev="" add_next=""
422         local previous_page="$msg_previous_page" next_page="$msg_next_page"
423         if [ $page -gt 1 ]; then
424                 add_prev=1
425                 # Accent the `Previous Page' item with an asterisk
426                 # if the page-before-previous is loaded/cached
427                 f_isset _index_page_${varcat}_$(( $page - 1 )) &&
428                         previous_page="$previous_page*"
429         fi
430         if [ $page -lt $npages ]; then
431                 add_next=1
432                 # Accent the `Next Page' item with an asterisk
433                 # if the page-after-next is loaded/cached
434                 f_isset _index_page_${varcat}_$(( $page + 1 )) &&
435                         next_page="$next_page*"
436         fi
437
438         local index_page
439         f_package_index_get_page "$category" $page index_page
440
441         menu_list="
442                 ${add_prev:+'> $previous_page' '' ${SHOW_DESC:+''}}
443                 ${add_next:+'> $next_page' '' ${SHOW_DESC:+''}}
444         $(
445                 export SHOW_DESC
446                 export VALID_VARNAME_CHARS
447                 echo "$index_page" | awk -F'|' -v view="port" '
448                 BEGIN {
449                         valid_chars = ENVIRON["VALID_VARNAME_CHARS"]
450                         prefix = ""
451                 }
452                 {
453                         cur_prefix = tolower(substr($1, 1, 1))
454                         printf "'\''"
455                         if ( prefix != cur_prefix )
456                                 prefix = cur_prefix
457                         else
458                                 printf " "
459                         package = $1
460                         if ( view == "port" )
461                                 desc = $2
462                         varpkg = package
463                         gsub("[^" valid_chars "]", "_", varpkg)
464                         mark = ENVIRON["_mark_" varpkg]
465                         if ( ! mark ) mark = " "
466                         printf "%s'\'' '\''[%c] %s'\''",
467                                package, mark, desc
468                         if ( ENVIRON["SHOW_DESC"] ) {
469                                 help = $4
470                                 gsub(/'\''/, "'\''\\'\'\''", help)
471                                 printf " '\''%s'\''", help
472                         }
473                         printf "\n"
474                 }'
475         )
476                 ${add_prev:+'> $previous_page' '' ${SHOW_DESC:+''}}
477                 ${add_next:+'> $next_page' '' ${SHOW_DESC:+''}}
478         " # End-Quote
479
480         # Accept/Translate i18n "All" but other category names must
481         # match tree definitions from INDEX, ports, FTP, etc.
482         case "$category" in
483         "$msg_all"|"") f_category_desc_get "All" prompt ;;
484                     *) f_category_desc_get "$category" prompt ;;
485         esac
486         f_sprintf prompt "%s $msg_page_of_npages" "$prompt" "$page" "$npages"
487
488         local mheight mwidth mrows
489         eval f_dialog_menu${SHOW_DESC:+_with_help}_size mheight mwidth mrows \
490                         \"\$DIALOG_TITLE\" \"\$DIALOG_BACKTITLE\" \
491                         \"\$prompt\" \"\$hline\" $menu_list
492         local iheight iwidth
493         f_dialog_infobox_size iheight iwidth \
494                         "$DIALOG_TITLE" "$DIALOG_BACKTITLE" \
495                         "$msg_processing_selection"
496
497         local menu_choice
498         menu_choice=$( eval $DIALOG \
499                 --title \"\$DIALOG_TITLE\"         \
500                 --backtitle \"\$DIALOG_BACKTITLE\" \
501                 --hline \"\$hline\"                \
502                 --keep-tite                        \
503                 --ok-label \"$msg_select\"         \
504                 --cancel-label \"$msg_back\"       \
505                 ${SHOW_DESC:+--item-help}          \
506                 --default-item \"\$defaultitem\"   \
507                 --menu \"\$prompt\"                \
508                 $mheight $mwidth $mrows            \
509                 $menu_list                         \
510                 --and-widget                       \
511                 ${USE_XDIALOG:+--no-buttons}       \
512                 --infobox \"\$msg_processing_selection\" \
513                 $iheight $iwidth                   \
514                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
515         )
516         local retval=$?
517         f_dialog_data_sanitize menu_choice
518         f_dialog_menutag_store "$menu_choice"
519
520         if [ $retval -eq $DIALOG_OK ]; then
521                 local item
522                 item=$( eval f_dialog_menutag2item${SHOW_DESC:+_with_help} \
523                                 \"\$menu_choice\" $menu_list )
524                 f_dialog_menuitem_store "$item"
525         fi
526
527         return $retval
528 }
529
530 # f_package_menu_deselect $package
531 #
532 # Display a menu, asking the user what they would like to do with $package
533 # with regard to "deselecting" an already installed package. Choices include
534 # uninstall, re-install, or cancel (leave $package marked as installed).
535 # Returns success if the user does not press ESC or choose Cnacel. Use the
536 # f_dialog_menutag_fetch() function upon success to retrieve the user's choice.
537 #
538 f_package_menu_deselect()
539 {
540         local package="$1"
541         local prompt # Calculated below
542         local menu_list="
543                 'X $msg_installed' '$msg_installed_desc'
544                 'R $msg_reinstall' '$msg_reinstall_desc'
545                 'U $msg_uninstall' '$msg_uninstall_desc'
546         " # End-Quote
547         local hline="$hline_alnum_arrows_punc_tab_enter"
548
549         f_sprintf prompt "$msg_what_would_you_like_to_do_with" "$package"
550
551         local height width rows
552         eval f_dialog_menu_size height width rows \
553                                 \"\$DIALOG_TITLE\"     \
554                                 \"\$DIALOG_BACKTITLE\" \
555                                 \"\$prompt\"           \
556                                 \"\$hline\"            \
557                                 $menu_list
558         local menu_choice
559         menu_choice=$( eval $DIALOG \
560                 --title \"\$DIALOG_TITLE\"         \
561                 --backtitle \"\$DIALOG_BACKTITLE\" \
562                 --hline \"\$hline\"                \
563                 --ok-label \"$msg_select\"         \
564                 --cancel-label \"$msg_cancel\"     \
565                 --menu \"\$prompt\"                \
566                 $height $width $rows               \
567                 $menu_list                         \
568                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
569         )
570         local retval=$?
571         f_dialog_menutag_store -s "$menu_choice"
572         return $retval
573 }
574
575 # f_package_review
576 #
577 # Display a review screen, showing selected packages and what they are marked
578 # for, before proceeding (if the user does not press ESC or choose Cancel) to
579 # operate on each selection. Returns error if no packages have been selected,
580 # or the user has pressed ESC, or if they have chosen Cancel.
581 #
582 f_package_review()
583 {
584         local funcname=f_package_review
585         local prompt # Calculated below
586         local menu_list # Calculated below
587         local hline="$hline_alnum_arrows_punc_tab_enter"
588
589         f_dprintf "$funcname: SELECTED_PACKAGES=[%s]" "$SELECTED_PACKAGES"
590
591         f_sprintf prompt "$msg_reviewing_selected_packages" "$_All_nselected"
592
593         local package varpkg mark
594         for package in $SELECTED_PACKAGES; do
595                 mark=
596                 f_str2varname "$package" varpkg
597                 f_getvar _mark_$varpkg mark
598                 [ "$mark" -a ! "${mark#[IRUD]}" ] || continue
599                 menu_list="$menu_list
600                         '$mark' '$package'
601                 " # End-Quote
602         done
603         if [ ! "$menu_list" ]; then
604                 f_show_msg "$msg_no_packages_were_selected_for_extraction"
605                 return $DIALOG_CANCEL # Might have selected this by accident
606         fi
607         menu_list=$( echo "$menu_list" | sort )
608
609         local height width rows
610         eval f_dialog_menu_size height width rows \
611                                 \"\$DIALOG_TITLE\"     \
612                                 \"\$DIALOG_BACKTITLE\" \
613                                 \"\$prompt\"           \
614                                 \"\$hline\"            \
615                                 $menu_list
616
617         # Show the review menu (ignore menu choice)
618         eval $DIALOG \
619                 --title \"\$DIALOG_TITLE\"         \
620                 --backtitle \"\$DIALOG_BACKTITLE\" \
621                 --hline \"\$hline\"                \
622                 --ok-label \"\$msg_proceed\"       \
623                 --cancel-label \"\$msg_cancel\"    \
624                 --menu \"\$prompt\"                \
625                 $height $width $rows               \
626                 $menu_list                         \
627                 2> /dev/null || return $?
628                         # Return if the user pressed ESC or chose Cancel/No
629
630         #
631         # Process each of the selected packages:
632         # + First, process packages marked for Install.
633         # + Second, process packages marked for Re-install.
634         # + Finally, process packages marked for Uninstall.
635         #
636         for package in $SELECTED_PACKAGES; do
637                 mark=
638                 f_str2varname "$package" varpkg
639                 debug= f_getvar _mark_$varpkg mark
640                 [ "$mark" = "I" ] || continue
641                 f_dprintf "$funcname: Installing %s package" "$package"
642                 f_package_add "$package"
643         done
644         for package in $SELECTED_PACKAGES; do
645                 mark=
646                 f_str2varname "$package" varpkg
647                 debug= f_getvar _mark_$varpkg mark
648                 [ "$mark" = "R" ] || continue
649                 f_dprintf "$funcname: Reinstalling %s package" "$package"
650                 f_package_reinstall "$package"
651         done
652         for package in $SELECTED_PACKAGES; do
653                 mark=
654                 f_str2varname "$package" varpkg
655                 debug= f_getvar _mark_$varpkg mark
656                 [ "$mark" = "U" ] || continue
657                 f_dprintf "$funcname: Uninstalling %s package" "$package"
658                 f_package_delete "$package" || continue
659                 f_package_deselect "$package"
660         done
661
662         return $DIALOG_OK
663 }
664
665 # f_package_config
666 #
667 # Allow the user to configure packages and install them. Initially, a list of
668 # package categories is loaded/displayed. When the user selects a category,
669 # the menus for that category are built (unlike sysinstall which built all
670 # category menus up-front -- which also took forever, despite the fact that
671 # few people visit more than a couple of categories each time).
672 #
673 f_package_config()
674 {
675         # Did we get an INDEX?
676         f_index_initialize packages/INDEX || return $FAILURE
677                 # Creates following variables (indirectly via f_index_read())
678                 #   CATEGORY_MENU_LIST _categories_{varpkg} _rundeps_{varpkg}
679                 #   PACKAGE_CATEGORIES _npkgs
680
681         # Detect installed packages (updates marks/SELECTED_PACKAGES)
682         f_package_detect_installed
683         export PACKAGES_DETECTED=1 # exported for awk(1) ENVIRON[]
684
685         local retval category varcat defaultitem category_defaultitem=""
686         while :; do
687                 # Display the list of package categories
688                 f_package_menu_categories \
689                         CATEGORY_MENU_LIST "$category_defaultitem"
690                 retval=$?
691                 f_dialog_menutag_fetch category
692                 f_dprintf "retval=%u mtag=[%s]" $retval "$category"
693                 category_defaultitem="$category"
694
695                 [ $retval -eq $DIALOG_OK ] || break
696
697                 # Maybe the user chose an action (like `Review')
698                 case "$category" in
699                 "> $msg_review")
700                         f_package_review && break
701                         continue ;;
702                 "> "*)
703                         continue
704                 esac
705
706                 # Anything else is a package category
707
708                 category=${category# } # Trim leading space if present
709                 category=${category%\*} # Trim trailing asterisk if present
710
711                 f_str2varname "$category" varcat
712
713                 local page package varpkg mark menu_choice
714                 while :; do
715                         # Display the list of packages for selected category
716                         page=1 defaultitem=""
717                         f_getvar _defaultitem_$varcat defaultitem
718                         f_getvar _defaultpage_$varcat page
719                         f_package_menu_select \
720                                 "$category" "${page:=1}" "$defaultitem"
721                         retval=$?
722                         f_dialog_menutag_fetch menu_choice
723                         f_dprintf "retval=%u mtag=[%s]" $retval "$menu_choice"
724
725                         # NOTE: When --and-widget is used only ESC will cause
726                         # dialog(1) to return without going to the next widget.
727                         # This is alright in our case as we can still detect
728                         # the Cancel button because stdout will be NULL.
729                         # Alternatively, Xdialog(1) will terminate with 1
730                         # if/when Cancel is chosen on any widget.
731                         if [ $retval -eq $DIALOG_ESC -o ! "$menu_choice" ]
732                         then
733                                 break
734                         elif [ $retval -eq $DIALOG_CANCEL ]; then
735                                 # Using X11, Xdialog(1) returned 1 for Cancel
736                                 f_show_msg "%s" "$menu_choice"
737                                 break
738                         elif [ $retval -ne $DIALOG_OK ]; then
739                                 # X11-related error occurred using Xdialog(1)
740                                 f_show_msg "%s" "$menu_choice"
741                                 break
742                         fi
743
744                         defaultitem="$menu_choice"
745
746                         # NOTE: f_package_menu_select() does not show the
747                         # `Previous Page' or `Next Page' items unless needed
748                         case "$menu_choice" in
749                         "> $msg_previous_page"|"> $msg_previous_page*")
750                                 page=$(( $page - 1 ))
751                                 setvar _defaultpage_$varcat $page
752                                 # Update default-item to match accent that will
753                                 # be applied by f_package_menu_select(); if the
754                                 # page-before-prev is cached, add an asterisk.
755                                 if f_isset \
756                                         _index_page_${varcat}_$(( $page - 1 ))
757                                 then
758                                         defaultitem="${defaultitem%\*}*"
759                                 else
760                                         defaultitem="${defaultitem%\*}"
761                                 fi
762                                 setvar _defaultitem_$varcat "$defaultitem"
763                                 continue ;;
764                         "> $msg_next_page"|"> $msg_next_page*")
765                                 page=$(( $page + 1 ))
766                                 setvar _defaultpage_$varcat $page
767                                 # Update default-item to match accent that will
768                                 # be applied by f_package_menu_select(); if the
769                                 # page-after-next is cached, add an asterisk.
770                                 if f_isset \
771                                         _index_page_${varcat}_$(( $page + 1 ))
772                                 then
773                                         defaultitem="${defaultitem%\*}*"
774                                 else
775                                         defaultitem="${defaultitem%\*}"
776                                 fi
777                                 setvar _defaultitem_$varcat "$defaultitem"
778                                 continue ;;
779                         "> "*) # Unknown navigation/action item
780                                 setvar _defaultpage_$varcat $page
781                                 continue ;; # Do not treat as a package
782                         *)
783                                 setvar _defaultitem_$varcat "$defaultitem"
784                         esac
785
786                         # Treat any other selection as a package
787                         package="${menu_choice# }" # Trim leading space
788                         f_str2varname $package varpkg
789                         f_dialog_menuitem_fetch mark
790                         mark="${mark#?}"
791                         mark="${mark%%\] *}"
792                         case "$mark" in
793                         "I")
794                                 mark=" "
795                                 f_package_deselect $package
796                                 ;;
797                         " "|"D")
798                                 mark="I"
799                                 f_package_select $package
800                                 ;;
801                         "X"|"R"|"U")
802                                 f_package_menu_deselect $package || continue
803                                 f_dialog_menutag_fetch menu_choice
804                                 case "$menu_choice" in
805                                 "X $msg_installed")
806                                         f_package_deselect "$package"
807                                         mark="X"
808                                         ;;
809                                 "R $msg_reinstall")
810                                         f_package_select "$package"
811                                         mark="R"
812                                         ;;
813                                 "U $msg_uninstall")
814                                         f_package_select "$package"
815                                         mark="U"
816                                         ;;
817                                 esac
818                                 ;;
819                         esac
820                         export _mark_$varpkg="$mark"
821                                 # NOTE: exported for awk(1) ENVIRON[]
822                 done
823         done
824 }
825
826 # f_package_add $package_name [$depended]
827 #
828 # Like f_package_extract(), but assumes current media device and chases deps.
829 # Note that $package_name should not contain the archive suffix (e.g., `.tbz').
830 # If $depended is present and non-NULL, the package is treated as a dependency
831 # (in this function, dependencies are not handled any differently, but the
832 # f_package_extract() function is passed this value and it displays a different
833 # message when installing a dependency versus non-dependency).
834 #
835 f_package_add()
836 {
837         local name="$1" depended="$2" status=$SUCCESS retval
838
839         local alert=f_show_msg no_confirm=
840         f_getvar $VAR_NO_CONFIRM no_confirm
841         [ "$no_confirm" ] && alert=f_show_info
842
843         if ! { [ "$name" ] || { f_getvar $VAR_PACKAGE name && [ "$name" ]; }; }
844         then
845                 f_dprintf "packageAdd: %s" \
846                           "$msg_no_package_name_passed_in_package_variable"
847                 return $FAILURE
848         fi
849
850         { # Verify and initialize device media if-defined
851                 f_media_verify &&
852                 f_device_init device_media &&
853                 f_index_initialize packages/INDEX
854         } || return $FAILURE
855
856         # Now we have (indirectly via f_index_read()):
857         #   CATEGORY_MENU_LIST _categories_{varpkg} _rundeps_{varpkg}
858         #   PACKAGE_CATEGORIES _npkgs
859
860         local varpkg
861         f_str2varname "$name" varpkg
862
863         # Just as-in the user-interface (opposed to scripted-use), only allow
864         # packages with at least one category to be recognized.
865         #
866         local pkgcat=
867         if ! f_getvar _categories_$varpkg pkgcat || [ ! "$pkgcat" ]; then
868                 # $pkg may be a partial name, search the index (this is slow)
869                 f_index_search PACKAGE_INDEX $name name
870                 if [ ! "$name" ]; then
871                         f_show_msg \
872                             "$msg_sorry_package_was_not_found_in_the_index" \
873                             "$name"
874                         return $FAILURE
875                 fi
876                 f_str2varname "$name" varpkg
877         fi
878
879         # If invoked through the scripted interface, we likely have not yet
880         # detected the installed packages -- something we should do only once.
881         #
882         if [ ! "$PACKAGES_DETECTED" ]; then
883                 f_dprintf "f_package_add: Detecting installed packages"
884                 f_package_detect_installed
885                 export PACKAGES_DETECTED=1 # exported for awk(1) ENVIRON[]
886         fi
887         # Now we have: _mark_{varpkg}=X for all installed packages
888
889         #
890         # Since we're maintaining data structures for installed packages,
891         # short-circuit the package dependency checks if the package is already
892         # installed. This prevents wasted cycles, minor delays between package
893         # extractions, and worst-case an infinite loop with a certain faulty
894         # INDEX file.
895         #
896         local mark=
897         f_getvar _mark_$varpkg mark && [ "$mark" = "X" ] && return $SUCCESS
898
899         local dep vardep rundeps=
900         f_getvar _rundeps_$varpkg rundeps
901         for dep in $rundeps; do
902                 f_str2varname "$dep" vardep
903
904                 # Skip dependency if already installed
905                 mark=
906                 f_getvar _mark_$vardep mark && [ "$mark" = "X" ] && continue
907
908                 # Just as-in the user-interface (opposed to scripted-use), only
909                 # allow packages with at least one category to be recognized.
910                 #
911                 local depcat=
912                 if ! f_getvar _categories_$vardep depcat || [ ! "$depcat" ]
913                 then
914                         $alert "$msg_required_package_not_found" "$dep"
915                         [ "$no_confirm" ] && sleep 2
916                 fi
917
918                 f_package_add "$dep"
919                 retval=$?
920                 if [ $retval -ne $SUCCESS ]; then
921                         status=$(( $status | $retval ))
922
923                         # XXX package could be on a future disc volume
924                         # XXX (not supporting multiple disc volumes yet)
925
926                         $alert "$msg_loading_of_dependent_package_failed" \
927                                "$dep"
928                         [ "$no_confirm" ] && sleep 2
929                 fi
930         done
931         [ $status -eq $SUCCESS ] || return $status
932
933         #
934         # Done with the deps? Try to load the real m'coy.
935         #
936
937         f_package_extract device_media "$name" "$depended"
938         retval=$?
939         if [ $retval -ne $SUCCESS ]; then
940                 status=$(( $status | $retval ))
941         else
942                 setvar _mark_$varpkg X
943         fi
944
945         return $status
946 }
947
948 # f_package_extract $device $name [$depended]
949 #
950 # Extract a package based on a namespec and media device. If $depended is
951 # present and non-NULL, the notification displayed while installing the package
952 # has "as a dependency" appended.
953 #
954 f_package_extract()
955 {
956         local funcname=f_package_extract
957         local device="$1" name="$2" depended="$3"
958         local devname=
959
960         $device get name devname
961         f_dprintf "$funcname: device=[%s] name=[%s] depended=[%s]" \
962                   "$devname" "$name" "$depended"
963
964         # Check to make sure it's not already there
965         local varpkg mark=
966         f_str2varname "$name" varpkg
967         f_getvar _mark_$varpkg mark
968         [ "$mark" = "X" ] && return $SUCCESS
969
970         if ! f_device_init $device; then
971                 f_show_msg \
972                     "$msg_unable_to_initialize_media_type_for_package_extract"
973                 return $FAILURE
974         fi
975
976         # If necessary, initialize the ldconfig hints
977         [ -f "/var/run/ld-elf.so.hints" ] ||
978                 f_quietly ldconfig /usr/lib /usr/lib/compat /usr/local/lib
979
980         # Make a couple paranoid locations for temp
981         # files to live if user specified none
982         local tmpdir
983         f_getvar $VAR_PKG_TMPDIR:-/var/tmp tmpdir
984         f_quietly mkdir -p -m 1777 "$tmpdir"
985
986         local path
987         case "$name" in
988         */*) path="$name" ;;
989         *)
990                 case "$name" in
991                 *-*|*_*) path="packages/All/$name" ;;
992                       *) path="packages/Latest/$name"
993                 esac
994         esac
995
996         # We have a path, call the device strategy routine to get the file
997         local pkg_ext found=
998         for pkg_ext in "" $PACKAGE_EXTENSIONS; do
999                 if f_device_get $device "$path$pkg_ext" $PROBE_EXIST; then
1000                         path="$path$pkg_ext"
1001                         f_dprintf "$funcname: found path=[%s] dev=[%s]" \
1002                                   "$path" "$device"
1003                         found=1
1004                         break
1005                 fi
1006         done
1007         [ "$found" ] && f_dprintf "$funcname: found path=[%s] dev=[%s]" \
1008                                   "$path" "$devname"
1009
1010         local alert=f_show_msg no_confirm=
1011         f_getvar $VAR_NO_CONFIRM no_confirm
1012         [ "$no_confirm" ] && alert=f_show_info
1013
1014         if [ ! "$found" ]; then
1015                 f_dprintf "$funcname: No such %s file on %s device" \
1016                           "$path" "$devname"
1017                 $alert "$msg_unable_to_fetch_package_from_selected_media" \
1018                        "$name"
1019                 [ "$no_confirm" ] && sleep 2
1020                 return $FAILURE
1021         fi
1022
1023         if [ "$depended" ]; then
1024                 f_show_info "$msg_adding_package_as_a_dependency_from_media" \
1025                             "$name" "$devname"
1026         else
1027                 f_show_info "$msg_adding_package_from_media" "$name" "$devname"
1028         fi
1029
1030         # Get package data and pipe into pkg_add(1) while providing feedback
1031         {
1032                 if ! f_device_get $device "$path"; then
1033                         $alert "$msg_io_error_while_reading_in_the_package" \
1034                                "$name" \
1035                                >&$DIALOG_TERMINAL_PASSTHRU_FD 2> /dev/null
1036                         [ "$no_confirm" ] && sleep 2
1037                 else
1038                         f_show_info \
1039                          "$msg_package_read_successfully_waiting_for_pkg_add" \
1040                          "$name" >&$DIALOG_TERMINAL_PASSTHRU_FD 2> /dev/null
1041                 fi
1042         } | {
1043                 if f_debugging; then
1044                         /usr/sbin/pkg_add -v -
1045                 else
1046                         f_quietly /usr/sbin/pkg_add -
1047                 fi
1048         }
1049         if [ $? -ne $SUCCESS ]; then
1050                 $alert "$msg_pkg_add_apparently_did_not_like_the_package" \
1051                        "$name"
1052                 [ "$no_confirm" ] && sleep 2
1053         else
1054                 f_show_info "$msg_package_was_added_successfully" "$name"
1055                 sleep 1
1056         fi
1057
1058         return $SUCCESS
1059 }
1060
1061 # f_package_delete $name
1062 #
1063 # Delete package by full $name (lacks archive suffix; e.g., `.tbz').
1064 #
1065 f_package_delete()
1066 {
1067         local funcname=f_package_delete
1068         local name="$1"
1069
1070         if ! { [ "$name" ] || { f_getvar $VAR_PACKAGE name && [ "$name" ]; }; }
1071         then
1072                 f_dprintf "packageDelete: %s" \
1073                           "$msg_no_package_name_passed_in_package_variable"
1074                 return $FAILURE
1075         fi
1076
1077         f_dprintf "$funcname: name=[%s]" "$name"
1078
1079         [ "$name" ] || return $FAILURE
1080
1081         { # Verify and initialize device media if-defined
1082                 f_media_verify &&
1083                 f_device_init device_media &&
1084                 f_index_initialize packages/INDEX
1085         } || return $FAILURE
1086
1087         # Now we have (indirectly via f_index_read()):
1088         #   CATEGORY_MENU_LIST _categories_{varpkg} _rundeps_{varpkg}
1089         #   PACKAGE_CATEGORIES _npkgs
1090
1091         local varpkg
1092         f_str2varname "$name" varpkg
1093
1094         # Just as-in the user-interface (opposed to scripted-use), only allow
1095         # packages with at least one category to be recognized.
1096         #
1097         local pkgcat=
1098         if ! f_getvar _categories_$varpkg pkgcat || [ ! "$pkgcat" ]; then
1099                 # $pkg may be a partial name, search the index (this is slow)
1100                 f_index_search PACKAGE_INDEX "$name" name
1101                 if [ ! "$name" ]; then
1102                         f_show_msg \
1103                             "$msg_sorry_package_was_not_found_in_the_index" \
1104                             "$name"
1105                         return $FAILURE
1106                 fi
1107                 f_str2varname "$name" varpkg
1108         fi
1109
1110         # If invoked through the scripted interface, we likely have not yet
1111         # detected the installed packages -- something we should do only once.
1112         #
1113         if [ ! "$PACKAGES_DETECTED" ]; then
1114                 f_dprintf "$funcname: Detecting installed packages"
1115                 f_package_detect_installed
1116                 export PACKAGES_DETECTED=1 # exported for awk(1) ENVIRON[]
1117         fi
1118         # Now we have: _mark_{varpkg}=X for all installed packages
1119
1120         #
1121         # Return failure if the package is not already installed.
1122         #
1123         local pkgmark=
1124         f_getvar _mark_$varpkg pkgmark
1125         if ! [ "$pkgmark" -a ! "${pkgmark#[XUR]}" ]; then
1126                 f_show_msg "$msg_package_not_installed_cannot_delete" "$name"
1127                 return $FAILURE
1128         fi
1129
1130         #
1131         # Check for dependencies
1132         #
1133         local pkgsel depc=0 udeps=
1134         for pkgsel in $SELECTED_PACKAGES; do
1135                 local mark=
1136                 f_str2varname $pkgsel varpkg
1137                 debug= f_getvar _mark_$varpkg mark
1138                 [ "$mark" -a ! "${mark#[XUR]}" ] || continue
1139                 local dep rundeps=
1140                 debug= f_getvar _rundeps_$varpkg rundeps
1141                 for dep in $rundeps; do
1142                         if [ "$dep" = "$name" ]; then
1143                                 # Maybe this package is marked for deletion too
1144                                 if [ "$mark" = "U" ]; then
1145                                         udeps="$udeps $pkgsel"
1146                                 else
1147                                         depc=$(( $depc + 1 ))
1148                                 fi
1149                                 break
1150                         fi
1151                 done
1152         done
1153         if [ $depc -gt 0 ]; then
1154                 local grammatical_s=
1155                 [ $depc -gt 1 ] && grammatical_s=s
1156                 f_show_msg \
1157                         "$msg_package_is_needed_by_other_installed_packages" \
1158                         "$name" "$depc" "$grammatical_s"
1159                 return $FAILURE
1160         fi
1161
1162         #
1163         # Chase dependencies that are marked for uninstallation
1164         #
1165         for pkgsel in $udeps; do
1166                 f_dprintf "$funcname: Uninstalling dependency %s (%s)" \
1167                           "$pkgsel" "marked for delete"
1168                 f_package_delete "$pkgsel"
1169         done
1170
1171         #
1172         # OK to perform the delete (no other packages depend on it)...
1173         #
1174         f_show_info "$msg_uninstalling_package_waiting_for_pkg_delete" "$name"
1175         if f_debugging; then
1176                 pkg_delete -v "$name"
1177         else
1178                 f_quietly pkg_delete "$name"
1179         fi
1180         if [ $? -ne $SUCCESS ]; then
1181                 f_show_msg "$msg_pkg_delete_failed" "$name"
1182                 return $FAILURE
1183         else
1184                 f_dprintf "$funcname: pkg-delete(8) of %s successful" "$name"
1185                 f_str2varname "$name" varpkg
1186                 setvar _mark_$varpkg ""
1187         fi
1188 }
1189
1190 # f_package_reinstall $name
1191 #
1192 # A simple wrapper to f_package_delete() + f_package_add()
1193 #
1194 f_package_reinstall()
1195 {
1196         f_package_delete "$1" && f_package_add "$1"
1197 }
1198
1199 ############################################################ MAIN
1200
1201 f_dprintf "%s: Successfully loaded." packages/packages.subr
1202
1203 fi # ! $_PACKAGES_PACKAGES_SUBR