usr.sbin/bsdconfig/share/common.subr

   1 if [ ! "$_COMMON_SUBR" ]; then _COMMON_SUBR=1
   2 #
   3 # Copyright (c) 2012 Ron McDowell
   4 # Copyright (c) 2012-2013 Devin Teske
   5 # All rights reserved.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions
   9 # are met:
  10 # 1. Redistributions of source code must retain the above copyright
  11 #    notice, this list of conditions and the following disclaimer.
  12 # 2. Redistributions in binary form must reproduce the above copyright
  13 #    notice, this list of conditions and the following disclaimer in the
  14 #    documentation and/or other materials provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 # SUCH DAMAGE.
  27 #
  28 # $FreeBSD$
  29 #
  30 ############################################################ CONFIGURATION
  31
  32 #
  33 # Default file descriptors to link to stdout/stderr for passthru allowing
  34 # redirection within a sub-shell to bypass directly to the terminal.
  35 #
  36 : ${TERMINAL_STDOUT_PASSTHRU:=3}}
  37 : ${TERMINAL_STDERR_PASSTHRU:=4}}
  38
  39 ############################################################ GLOBALS
  40
  41 #
  42 # Program name
  43 #
  44 pgm="${0##*/}"
  45
  46 #
  47 # Program arguments
  48 #
  49 ARGC="$#"
  50 ARGV="$@"
  51
  52 #
  53 # Global exit status variables
  54 #
  55 SUCCESS=0
  56 FAILURE=1
  57
  58 #
  59 # Operating environment details
  60 #
  61 export UNAME_S="$( uname -s )" # Operating System (i.e. FreeBSD)
  62 export UNAME_P="$( uname -p )" # Processor Architecture (i.e. i386)
  63 export UNAME_M="$( uname -m )" # Machine platform (i.e. i386)
  64 export UNAME_R="$( uname -r )" # Release Level (i.e. X.Y-RELEASE)
  65 if [ ! "${PKG_ABI+set}" ]; then
  66         export PKG_ABI="$(
  67                 ASSUME_ALWAYS_YES=1 pkg -vv 2> /dev/null |
  68                         awk '$1=="ABI"{print $3;exit}'
  69         )"
  70 fi
  71
  72 #
  73 # Default behavior is to call f_debug_init() automatically when loaded.
  74 #
  75 : ${DEBUG_SELF_INITIALIZE=1}
  76
  77 #
  78 # Default behavior of f_debug_init() is to truncate $debugFile (set to NULL to
  79 # disable truncating the debug file when initializing). To get child processes
  80 # to append to the same log file, export this variarable (with a NULL value)
  81 # and also export debugFile with the desired value.
  82 #
  83 : ${DEBUG_INITIALIZE_FILE=1}
  84
  85 #
  86 # Define standard optstring arguments that should be supported by all programs
  87 # using this include (unless DEBUG_SELF_INITIALIZE is set to NULL to prevent
  88 # f_debug_init() from autamatically processing "$@" for the below arguments):
  89 #
  90 #       d       Sets $debug to 1
  91 #       D:      Sets $debugFile to $OPTARG
  92 #
  93 GETOPTS_STDARGS="dD:"
  94
  95 #
  96 # The getopts builtin will return 1 either when the end of "$@" or the first
  97 # invalid flag is reached. This makes it impossible to determine if you've
  98 # processed all the arguments or simply have hit an invalid flag. In the cases
  99 # where we want to tolerate invalid flags (f_debug_init() for example), the
 100 # following variable can be appended to your optstring argument to getopts,
 101 # preventing it from prematurely returning 1 before the end of the arguments.
 102 #
 103 # NOTE: This assumes that all unknown flags are argument-less.
 104 #
 105 GETOPTS_ALLFLAGS="abcdefghijklmnopqrstuvwxyz"
 106 GETOPTS_ALLFLAGS="${GETOPTS_ALLFLAGS}ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 107 GETOPTS_ALLFLAGS="${GETOPTS_ALLFLAGS}0123456789"
 108
 109 #
 110 # When we get included, f_debug_init() will fire (unless $DEBUG_SELF_INITIALIZE
 111 # is set to disable automatic initialization) and process "$@" for a few global
 112 # options such as `-d' and/or `-D file'. However, if your program takes custom
 113 # flags that take arguments, this automatic processing may fail unexpectedly.
 114 #
 115 # The solution to this problem is to pre-define (before including this file)
 116 # the following variable (which defaults to NULL) to indicate that there are
 117 # extra flags that should be considered when performing automatic processing of
 118 # globally persistent flags.
 119 #
 120 : ${GETOPTS_EXTRA:=}
 121
 122 ############################################################ FUNCTIONS
 123
 124 # f_dprintf $format [$arguments ...]
 125 #
 126 # Sensible debug function. Override in ~/.bsdconfigrc if desired.
 127 # See /usr/share/examples/bsdconfig/bsdconfigrc for example.
 128 #
 129 # If $debug is set and non-NULL, prints DEBUG info using printf(1) syntax:
 130 #       + To $debugFile, if set and non-NULL
 131 #       + To standard output if $debugFile is either NULL or unset
 132 #       + To both if $debugFile begins with a single plus-sign (`+')
 133 #
 134 f_dprintf()
 135 {
 136         [ "$debug" ] || return $SUCCESS
 137         local fmt="$1"; shift
 138         case "$debugFile" in ""|+*)
 139         printf "DEBUG: $fmt${fmt:+\n}" "$@" >&${TERMINAL_STDOUT_PASSTHRU:-1}
 140         esac
 141         [ "${debugFile#+}" ] &&
 142                 printf "DEBUG: $fmt${fmt:+\n}" "$@" >> "${debugFile#+}"
 143         return $SUCCESS
 144 }
 145
 146 # f_debug_init
 147 #
 148 # Initialize debugging. Truncates $debugFile to zero bytes if set.
 149 #
 150 f_debug_init()
 151 {
 152         #
 153         # Process stored command-line arguments
 154         #
 155         set -- $ARGV
 156         local OPTIND
 157         f_dprintf "f_debug_init: ARGV=[%s] GETOPTS_STDARGS=[%s]" \
 158                   "$ARGV" "$GETOPTS_STDARGS"
 159         while getopts "$GETOPTS_STDARGS$GETOPTS_EXTRA$GETOPTS_ALLFLAGS" flag \
 160         > /dev/null; do
 161                 case "$flag" in
 162                 d) debug=1 ;;
 163                 D) debugFile="$OPTARG" ;;
 164                 esac
 165         done
 166         shift $(( $OPTIND - 1 ))
 167         f_dprintf "f_debug_init: debug=[%s] debugFile=[%s]" \
 168                   "$debug" "$debugFile"
 169
 170         #
 171         # Automagically enable debugging if debugFile is set (and non-NULL)
 172         #
 173         [ "$debugFile" ] && { [ "${debug+set}" ] || debug=1; }
 174
 175         #
 176         # Make debugging persistant if set
 177         #
 178         [ "$debug" ] && export debug
 179         [ "$debugFile" ] && export debugFile
 180
 181         #
 182         # Truncate debug file unless requested otherwise. Note that we will
 183         # trim a leading plus (`+') from the value of debugFile to support
 184         # persistant meaning that f_dprintf() should print both to standard
 185         # output and $debugFile (minus the leading plus, of course).
 186         #
 187         local _debug_file="${debugFile#+}"
 188         if [ "$_debug_file" -a "$DEBUG_INITIALIZE_FILE" ]; then
 189                 if ( umask 022 && :> "$_debug_file" ); then
 190                         f_dprintf "Successfully initialized debugFile \`%s'" \
 191                                   "$_debug_file"
 192                         f_isset debug || debug=1 # turn debugging on if not set
 193                 else
 194                         unset debugFile
 195                         f_dprintf "Unable to initialize debugFile \`%s'" \
 196                                   "$_debug_file"
 197                 fi
 198         fi
 199 }
 200
 201 # f_err $format [$arguments ...]
 202 #
 203 # Print a message to stderr (fd=2).
 204 #
 205 f_err()
 206 {
 207         printf "$@" >&2
 208 }
 209
 210 # f_quietly $command [$arguments ...]
 211 #
 212 # Run a command quietly (quell any output to stdout or stderr)
 213 #
 214 f_quietly()
 215 {
 216         "$@" > /dev/null 2>&1
 217 }
 218
 219 # f_have $anything ...
 220 #
 221 # A wrapper to the `type' built-in. Returns true if argument is a valid shell
 222 # built-in, keyword, or externally-tracked binary, otherwise false.
 223 #
 224 f_have()
 225 {
 226         f_quietly type "$@"
 227 }
 228
 229 # f_which $anything [$var_to_set]
 230 #
 231 # A fast built-in replacement for syntaxes such as foo=$( which bar ). In a
 232 # comparison of 10,000 runs of this function versus which, this function
 233 # completed in under 3 seconds, while `which' took almost a full minute.
 234 #
 235 # If $var_to_set is missing or NULL, output is (like which) to standard out.
 236 # Returns success if a match was found, failure otherwise.
 237 #
 238 f_which()
 239 {
 240         local __name="$1" __var_to_set="$2"
 241         case "$__name" in */*|'') return $FAILURE; esac
 242         local __p IFS=":" __found=
 243         for __p in $PATH; do
 244                 local __exec="$__p/$__name"
 245                 [ -f "$__exec" -a -x "$__exec" ] && __found=1 && break
 246         done
 247         if [ "$__found" ]; then
 248                 if [ "$__var_to_set" ]; then
 249                         setvar "$__var_to_set" "$__exec"
 250                 else
 251                         echo "$__exec"
 252                 fi
 253                 return $SUCCESS
 254         fi
 255         return $FAILURE
 256 }
 257
 258 # f_getvar $var_to_get [$var_to_set]
 259 #
 260 # Utility function designed to go along with the already-builtin setvar.
 261 # Allows clean variable name indirection without forking or sub-shells.
 262 #
 263 # Returns error status if the requested variable ($var_to_get) is not set.
 264 #
 265 # If $var_to_set is missing or NULL, the value of $var_to_get is printed to
 266 # standard output for capturing in a sub-shell (which is less-recommended
 267 # because of performance degredation; for example, when called in a loop).
 268 #
 269 f_getvar()
 270 {
 271         local __var_to_get="$1" __var_to_set="$2"
 272         [ "$__var_to_set" ] || local value
 273         eval ${__var_to_set:-value}=\"\${$__var_to_get}\"
 274         eval [ \"\${$__var_to_get+set}\" ]
 275         local __retval=$?
 276         eval f_dprintf '"f_getvar: var=[%s] value=[%s] r=%u"' \
 277                 \"\$__var_to_get\" \"\$${__var_to_set:-value}\" \$__retval
 278         [ "$__var_to_set" ] || { [ "$value" ] && echo "$value"; }
 279         return $__retval
 280 }
 281
 282 # f_isset $var
 283 #
 284 # Check if variable $var is set. Returns success if variable is set, otherwise
 285 # returns failure.
 286 #
 287 f_isset()
 288 {
 289         eval [ \"\${${1%%[$IFS]*}+set}\" ]
 290 }
 291
 292 # f_die [$status [$format [$arguments ...]]]
 293 #
 294 # Abruptly terminate due to an error optionally displaying a message in a
 295 # dialog box using printf(1) syntax.
 296 #
 297 f_die()
 298 {
 299         local status=$FAILURE
 300
 301         # If there is at least one argument, take it as the status
 302         if [ $# -gt 0 ]; then
 303                 status=$1
 304                 shift 1 # status
 305         fi
 306
 307         # If there are still arguments left, pass them to f_show_msg
 308         [ $# -gt 0 ] && f_show_msg "$@"
 309
 310         # Optionally call f_clean_up() function if it exists
 311         f_have f_clean_up && f_clean_up
 312
 313         exit $status
 314 }
 315
 316 # f_interrupt
 317 #
 318 # Interrupt handler.
 319 #
 320 f_interrupt()
 321 {
 322         exec 2>&1 # fix sh(1) bug where stderr gets lost within async-trap
 323         f_die
 324 }
 325
 326 # f_show_info $format [$arguments ...]
 327 #
 328 # Display a message in a dialog infobox using printf(1) syntax.
 329 #
 330 f_show_info()
 331 {
 332         local msg
 333         msg=$( printf "$@" )
 334
 335         #
 336         # Use f_dialog_infobox from dialog.subr if possible, otherwise fall
 337         # back to dialog(1) (without options, making it obvious when using
 338         # un-aided system dialog).
 339         #
 340         if f_have f_dialog_info; then
 341                 f_dialog_info "$msg"
 342         else
 343                 dialog --infobox "$msg" 0 0
 344         fi
 345 }
 346
 347 # f_show_msg $format [$arguments ...]
 348 #
 349 # Display a message in a dialog box using printf(1) syntax.
 350 #
 351 f_show_msg()
 352 {
 353         local msg
 354         msg=$( printf "$@" )
 355
 356         #
 357         # Use f_dialog_msgbox from dialog.subr if possible, otherwise fall
 358         # back to dialog(1) (without options, making it obvious when using
 359         # un-aided system dialog).
 360         #
 361         if f_have f_dialog_msgbox; then
 362                 f_dialog_msgbox "$msg"
 363         else
 364                 dialog --msgbox "$msg" 0 0
 365         fi
 366 }
 367
 368 # f_show_err $format [$arguments ...]
 369 #
 370 # Display a message in a dialog box with ``Error'' i18n title (overridden by
 371 # setting msg_error) using printf(1) syntax. If running non-interactively,
 372 # the process will terminate (using [above] f_die()).
 373 #
 374 f_show_err()
 375 {
 376         [ "$nonInteractive" ] && f_die
 377
 378         local msg
 379         msg=$( printf "$@" )
 380
 381         : ${msg:=${msg_an_unknown_error_occurred:-An unknown error occurred}}
 382
 383         if [ "$_DIALOG_SUBR" ]; then
 384                 f_dialog_title "${msg_error:-Error}"
 385                 f_dialog_msgbox "$msg"
 386                 f_dialog_title_restore
 387         else
 388                 dialog --title "${msg_error:-Error}" --msgbox "$msg" 0 0
 389         fi
 390         return $SUCCESS
 391 }
 392
 393 # f_yesno $format [$arguments ...]
 394 #
 395 # Display a message in a dialog yes/no box using printf(1) syntax.
 396 #
 397 f_yesno()
 398 {
 399         local msg
 400         msg=$( printf "$@" )
 401
 402         #
 403         # Use f_dialog_yesno from dialog.subr if possible, otherwise fall
 404         # back to dialog(1) (without options, making it obvious when using
 405         # un-aided system dialog).
 406         #
 407         if f_have f_dialog_yesno; then
 408                 f_dialog_yesno "$msg"
 409         else
 410                 dialog --yesno "$msg" 0 0
 411         fi
 412 }
 413
 414 # f_noyes $format [$arguments ...]
 415 #
 416 # Display a message in a dialog yes/no box using printf(1) syntax.
 417 # NOTE: THis is just like the f_yesno function except "No" is default.
 418 #
 419 f_noyes()
 420 {
 421         local msg
 422         msg=$( printf "$@" )
 423
 424         #
 425         # Use f_dialog_noyes from dialog.subr if possible, otherwise fall
 426         # back to dialog(1) (without options, making it obvious when using
 427         # un-aided system dialog).
 428         #
 429         if f_have f_dialog_noyes; then
 430                 f_dialog_noyes "$msg"
 431         else
 432                 dialog --defaultno --yesno "$msg" 0 0
 433         fi
 434 }
 435
 436 # f_show_help $file
 437 #
 438 # Display a language help-file. Automatically takes $LANG and $LC_ALL into
 439 # consideration when displaying $file (suffix ".$LC_ALL" or ".$LANG" will
 440 # automatically be added prior to loading the language help-file).
 441 #
 442 # If a language has been requested by setting either $LANG or $LC_ALL in the
 443 # environment and the language-specific help-file does not exist we will fall
 444 # back to $file without-suffix.
 445 #
 446 # If the language help-file does not exist, an error is displayed instead.
 447 #
 448 f_show_help()
 449 {
 450         local file="$1"
 451         local lang="${LANG:-$LC_ALL}"
 452
 453         [ -f "$file.$lang" ] && file="$file.$lang"
 454
 455         #
 456         # Use f_dialog_textbox from dialog.subr if possible, otherwise fall
 457         # back to dialog(1) (without options, making it obvious when using
 458         # un-aided system dialog).
 459         #
 460         if f_have f_dialog_textbox; then
 461                 f_dialog_textbox "$file"
 462         else
 463                 dialog --msgbox "$( cat "$file" 2>&1 )" 0 0
 464         fi
 465 }
 466
 467 # f_include $file
 468 #
 469 # Include a shell subroutine file.
 470 #
 471 # If the subroutine file exists but returns error status during loading, exit
 472 # is called and execution is prematurely terminated with the same error status.
 473 #
 474 f_include()
 475 {
 476         local file="$1"
 477         f_dprintf "f_include: file=[%s]" "$file"
 478         . "$file" || exit $?
 479 }
 480
 481 # f_include_lang $file
 482 #
 483 # Include a language file. Automatically takes $LANG and $LC_ALL into
 484 # consideration when including $file (suffix ".$LC_ALL" or ".$LANG" will
 485 # automatically by added prior to loading the language file).
 486 #
 487 # No error is produced if (a) a language has been requested (by setting either
 488 # $LANG or $LC_ALL in the environment) and (b) the language file does not
 489 # exist -- in which case we will fall back to loading $file without-suffix.
 490 #
 491 # If the language file exists but returns error status during loading, exit
 492 # is called and execution is prematurely terminated with the same error status.
 493 #
 494 f_include_lang()
 495 {
 496         local file="$1"
 497         local lang="${LANG:-$LC_ALL}"
 498
 499         f_dprintf "f_include_lang: file=[%s] lang=[%s]" "$file" "$lang"
 500         if [ -f "$file.$lang" ]; then
 501                 . "$file.$lang" || exit $?
 502         else
 503                 . "$file" || exit $?
 504         fi
 505 }
 506
 507 # f_usage $file [$key1 $value1 ...]
 508 #
 509 # Display USAGE file with optional pre-processor macro definitions. The first
 510 # argument is the template file containing the usage text to be displayed. If
 511 # $LANG or $LC_ALL (in order of preference, respectively) is set, ".encoding"
 512 # will automatically be appended as a suffix to the provided $file pathname.
 513 #
 514 # When processing $file, output begins at the first line containing that is
 515 # (a) not a comment, (b) not empty, and (c) is not pure-whitespace. All lines
 516 # appearing after this first-line are output, including (a) comments (b) empty
 517 # lines, and (c) lines that are purely whitespace-only.
 518 #
 519 # If additional arguments appear after $file, substitutions are made while
 520 # printing the contents of the USAGE file. The pre-processor macro syntax is in
 521 # the style of autoconf(1), for example:
 522 #
 523 #       f_usage $file "FOO" "BAR"
 524 #
 525 # Will cause instances of "@FOO@" appearing in $file to be replaced with the
 526 # text "BAR" before bering printed to the screen.
 527 #
 528 # This function is a two-parter. Below is the awk(1) portion of the function,
 529 # afterward is the sh(1) function which utilizes the below awk script.
 530 #
 531 f_usage_awk='
 532 BEGIN { found = 0 }
 533 {
 534         if ( !found && $0 ~ /^[[:space:]]*($|#)/ ) next
 535         found = 1
 536         print
 537 }
 538 '
 539 f_usage()
 540 {
 541         local file="$1"
 542         local lang="${LANG:-$LC_ALL}"
 543
 544         f_dprintf "f_usage: file=[%s] lang=[%s]" "$file" "$lang"
 545
 546         shift 1 # file
 547
 548         local usage
 549         if [ -f "$file.$lang" ]; then
 550                 usage=$( awk "$f_usage_awk" "$file.$lang" ) || exit $FAILURE
 551         else
 552                 usage=$( awk "$f_usage_awk" "$file" ) || exit $FAILURE
 553         fi
 554
 555         while [ $# -gt 0 ]; do
 556                 local key="$1"
 557                 export value="$2"
 558                 usage=$( echo "$usage" | awk \
 559                         "{ gsub(/@$key@/, ENVIRON[\"value\"]); print }" )
 560                 shift 2
 561         done
 562
 563         f_err "%s\n" "$usage"
 564
 565         exit $FAILURE
 566 }
 567
 568 # f_index_file $keyword [$var_to_set]
 569 #
 570 # Process all INDEX files known to bsdconfig and return the path to first file
 571 # containing a menu_selection line with a keyword portion matching $keyword.
 572 #
 573 # If $LANG or $LC_ALL (in order of preference, respectively) is set,
 574 # "INDEX.encoding" files will be searched first.
 575 #
 576 # If no file is found, error status is returned along with the NULL string.
 577 #
 578 # If $var_to_set is NULL or missing, output is printed to stdout (which is less
 579 # recommended due to performance degradation; in a loop for example).
 580 #
 581 # This function is a two-parter. Below is the awk(1) portion of the function,
 582 # afterward is the sh(1) function which utilizes the below awk script.
 583 #
 584 f_index_file_awk='
 585 # Variables that should be defined on the invocation line:
 586 #       -v keyword="keyword"
 587 BEGIN { found = 0 }
 588 ( $0 ~ "^menu_selection=\"" keyword "\\|" ) {
 589         print FILENAME
 590         found++
 591         exit
 592 }
 593 END { exit ! found }
 594 '
 595 f_index_file()
 596 {
 597         local __keyword="$1" __var_to_set="$2"
 598         local __lang="${LANG:-$LC_ALL}"
 599         local __indexes="$BSDCFG_LIBE${BSDCFG_LIBE:+/}*/INDEX"
 600
 601         f_dprintf "f_index_file: keyword=[%s] lang=[%s]" "$__keyword" "$__lang"
 602
 603         if [ "$__lang" ]; then
 604                 if [ "$__var_to_set" ]; then
 605                         eval "$__var_to_set"='"$( awk -v keyword="$__keyword" \
 606                                 "$f_index_file_awk" $__indexes.$__lang
 607                         )"' && return $SUCCESS
 608                 else
 609                         awk -v keyword="$__keyword" "$f_index_file_awk" \
 610                                 $__indexes.$__lang && return $SUCCESS
 611                 fi
 612                 # No match, fall-thru to non-i18n sources
 613         fi
 614         if [ "$__var_to_set" ]; then
 615                 eval "$__var_to_set"='"$( awk -v keyword="$__keyword" \
 616                         "$f_index_file_awk" $__indexes )"' && return $SUCCESS
 617         else
 618                 awk -v keyword="$__keyword" "$f_index_file_awk" $__indexes &&
 619                         return $SUCCESS
 620         fi
 621
 622         # No match? Fall-thru to `local' libexec sources (add-on modules)
 623
 624         [ "$BSDCFG_LOCAL_LIBE" ] || return $FAILURE
 625         __indexes="$BSDCFG_LOCAL_LIBE/*/INDEX"
 626         if [ "$__lang" ]; then
 627                 if [ "$__var_to_set" ]; then
 628                         eval "$__var_to_set"='"$( awk -v keyword="$__keyword" \
 629                                 "$f_index_file_awk" $__indexes.$__lang
 630                         )"' && return $SUCCESS
 631                 else
 632                         awk -v keyword="$__keyword" "$f_index_file_awk" \
 633                                 $__indexes.$__lang && return $SUCCESS
 634                 fi
 635                 # No match, fall-thru to non-i18n sources
 636         fi
 637         if [ "$__var_to_set" ]; then
 638                 eval "$__var_to_set"='$( awk -v keyword="$__keyword" \
 639                         "$f_index_file_awk" $__indexes )"'
 640         else
 641                 awk -v keyword="$__keyword" "$f_index_file_awk" $__indexes
 642         fi
 643 }
 644
 645 # f_index_menusel_keyword $indexfile $pgm [$var_to_set]
 646 #
 647 # Process $indexfile and return only the keyword portion of the menu_selection
 648 # line with a command portion matching $pgm.
 649 #
 650 # This function is for internationalization (i18n) mapping of the on-disk
 651 # scriptname ($pgm) into the localized language (given language-specific
 652 # $indexfile). If $LANG or $LC_ALL (in orderder of preference, respectively) is
 653 # set, ".encoding" will automatically be appended as a suffix to the provided
 654 # $indexfile pathname.
 655 #
 656 # If, within $indexfile, multiple $menu_selection values map to $pgm, only the
 657 # first one will be returned. If no mapping can be made, the NULL string is
 658 # returned.
 659 #
 660 # If $indexfile does not exist, error status is returned with NULL.
 661 #
 662 # If $var_to_set is NULL or missing, output is printed to stdout (which is less
 663 # recommended due to performance degradation; in a loop for example).
 664 #
 665 # This function is a two-parter. Below is the awk(1) portion of the function,
 666 # afterward is the sh(1) function which utilizes the below awk script.
 667 #
 668 f_index_menusel_keyword_awk='
 669 # Variables that should be defined on the invocation line:
 670 #       -v pgm="program_name"
 671 #
 672 BEGIN {
 673         prefix = "menu_selection=\""
 674         plen = length(prefix)
 675         found = 0
 676 }
 677 {
 678         if (!match($0, "^" prefix ".*\\|.*\"")) next
 679
 680         keyword = command = substr($0, plen + 1, RLENGTH - plen - 1)
 681         sub(/^.*\|/, "", command)
 682         sub(/\|.*$/, "", keyword)
 683
 684         if ( command == pgm )
 685         {
 686                 print keyword
 687                 found++
 688                 exit
 689         }
 690 }
 691 END { exit ! found }
 692 '
 693 f_index_menusel_keyword()
 694 {
 695         local __indexfile="$1" __pgm="$2" __var_to_set="$3"
 696         local __lang="${LANG:-$LC_ALL}" __file="$__indexfile"
 697
 698         [ -f "$__indexfile.$__lang" ] && __file="$__indexfile.$__lang"
 699         f_dprintf "f_index_menusel_keyword: index=[%s] pgm=[%s] lang=[%s]" \
 700                   "$__file" "$__pgm" "$__lang"
 701
 702         if [ "$__var_to_set" ]; then
 703                 setvar "$__var_to_set" "$( awk \
 704                     -v pgm="$__pgm" "$f_index_menusel_keyword_awk" "$__file"
 705                 )"
 706         else
 707                 awk -v pgm="$__pgm" "$f_index_menusel_keyword_awk" "$__file"
 708         fi
 709 }
 710
 711 # f_index_menusel_command $indexfile $keyword [$var_to_set]
 712 #
 713 # Process $indexfile and return only the command portion of the menu_selection
 714 # line with a keyword portion matching $keyword.
 715 #
 716 # This function is for mapping [possibly international] keywords into the
 717 # command to be executed. If $LANG or $LC_ALL (order of preference) is set,
 718 # ".encoding" will automatically be appended as a suffix to the provided
 719 # $indexfile pathname.
 720 #
 721 # If, within $indexfile, multiple $menu_selection values map to $keyword, only
 722 # the first one will be returned. If no mapping can be made, the NULL string is
 723 # returned.
 724 #
 725 # If $indexfile doesn't exist, error status is returned with NULL.
 726 #
 727 # If $var_to_set is NULL or missing, output is printed to stdout (which is less
 728 # recommended due to performance degradation; in a loop for example).
 729 #
 730 # This function is a two-parter. Below is the awk(1) portion of the function,
 731 # afterward is the sh(1) function which utilizes the below awk script.
 732 #
 733 f_index_menusel_command_awk='
 734 # Variables that should be defined on the invocation line:
 735 #       -v key="keyword"
 736 #
 737 BEGIN {
 738         prefix = "menu_selection=\""
 739         plen = length(prefix)
 740         found = 0
 741 }
 742 {
 743         if (!match($0, "^" prefix ".*\\|.*\"")) next
 744
 745         keyword = command = substr($0, plen + 1, RLENGTH - plen - 1)
 746         sub(/^.*\|/, "", command)
 747         sub(/\|.*$/, "", keyword)
 748
 749         if ( keyword == key )
 750         {
 751                 print command
 752                 found++
 753                 exit
 754         }
 755 }
 756 END { exit ! found }
 757 '
 758 f_index_menusel_command()
 759 {
 760         local __indexfile="$1" __keyword="$2" __var_to_set="$3" __command
 761         local __lang="${LANG:-$LC_ALL}" __file="$__indexfile"
 762
 763         [ -f "$__indexfile.$__lang" ] && __file="$__indexfile.$__lang"
 764         f_dprintf "f_index_menusel_command: index=[%s] key=[%s] lang=[%s]" \
 765                   "$__file" "$__keyword" "$__lang"
 766
 767         [ -f "$__file" ] || return $FAILURE
 768         __command=$( awk -v key="$__keyword" \
 769                 "$f_index_menusel_command_awk" "$__file" ) || return $FAILURE
 770
 771         #
 772         # If the command pathname is not fully qualified fix-up/force to be
 773         # relative to the $indexfile directory.
 774         #
 775         case "$__command" in
 776         /*) : already fully qualified ;;
 777         *)
 778                 local __indexdir="${__indexfile%/*}"
 779                 [ "$__indexdir" != "$__indexfile" ] || __indexdir="."
 780                 __command="$__indexdir/$__command"
 781         esac
 782
 783         if [ "$__var_to_set" ]; then
 784                 setvar "$__var_to_set" "$__command"
 785         else
 786                 echo "$__command"
 787         fi
 788 }
 789
 790 # f_running_as_init
 791 #
 792 # Returns true if running as init(1).
 793 #
 794 f_running_as_init()
 795 {
 796         #
 797         # When a custom init(8) performs an exec(3) to invoke a shell script,
 798         # PID 1 becomes sh(1) and $PPID is set to 1 in the executed script.
 799         #
 800         [ ${PPID:-0} -eq 1 ] # Return status
 801 }
 802
 803 # f_mounted $local_directory
 804 #
 805 # Return success if a filesystem is mounted on a particular directory.
 806 #
 807 f_mounted()
 808 {
 809         local dir="$1"
 810         [ -d "$dir" ] || return $FAILURE
 811         mount | grep -Eq " on $dir \([^)]+\)$"
 812 }
 813
 814 # f_eval_catch [-de] [-k $var_to_set] $funcname $utility \
 815 #              $format [$arguments ...]
 816 #
 817 # Silently evaluate a command in a sub-shell and test for error. If debugging
 818 # is enabled a copy of the command and its output is sent to debug (either
 819 # stdout or file depending on environment). If an error occurs, output of the
 820 # command is displayed in a dialog(1) msgbox using the [above] f_show_err()
 821 # function (unless optional `-d' flag is given, then no dialog).
 822 #
 823 # The $funcname argument is sent to debugging while the $utility argument is
 824 # used in the title of the dialog box. The command that is executed as well as
 825 # sent to debugging with $funcname is the product of the printf(1) syntax
 826 # produced by $format with optional $arguments.
 827 #
 828 # The following options are supported:
 829 #
 830 #       -d      Do not use dialog(1).
 831 #       -e      Produce error text from failed command on stderr.
 832 #       -k var  Save output from the command in var.
 833 #
 834 # Example 1:
 835 #
 836 #       debug=1
 837 #       f_eval_catch myfunc echo 'echo "%s"' "Hello, World!"
 838 #
 839 #       Produces the following debug output:
 840 #
 841 #               DEBUG: myfunc: echo "Hello, World!"
 842 #               DEBUG: myfunc: retval=0 <output below>
 843 #               Hello, World!
 844 #
 845 # Example 2:
 846 #
 847 #       debug=1
 848 #       f_eval_catch -k contents myfunc cat 'cat "%s"' /some/file
 849 #       # dialog(1) Error ``cat: /some/file: No such file or directory''
 850 #       # contents=[cat: /some/file: No such file or directory]
 851 #
 852 #       Produces the following debug output:
 853 #
 854 #               DEBUG: myfunc: cat "/some/file"
 855 #               DEBUG: myfunc: retval=1 <output below>
 856 #               cat: /some/file: No such file or directory
 857 #
 858 # Example 3:
 859 #
 860 #       debug=1
 861 #       echo 123 | f_eval_catch myfunc rev rev
 862 #
 863 #       Produces the following debug output:
 864 #
 865 #               DEBUG: myfunc: rev
 866 #               DEBUG: myfunc: retval=0 <output below>
 867 #               321
 868 #
 869 # Example 4:
 870 #
 871 #       debug=1
 872 #       f_eval_catch myfunc true true
 873 #
 874 #       Produces the following debug output:
 875 #
 876 #               DEBUG: myfunc: true
 877 #               DEBUG: myfunc: retval=0 <no output>
 878 #
 879 # Example 5:
 880 #
 881 #       f_eval_catch -de myfunc ls 'ls "%s"' /some/dir
 882 #       # Output on stderr ``ls: /some/dir: No such file or directory''
 883 #
 884 # Example 6:
 885 #
 886 #       f_eval_catch -dek contents myfunc ls 'ls "%s"' /etc
 887 #       # Output from `ls' sent to stderr and also saved in $contents
 888 #
 889 f_eval_catch()
 890 {
 891         local __no_dialog= __show_err= __var_to_set=
 892
 893         #
 894         # Process local function arguments
 895         #
 896         local OPTIND __flag
 897         while getopts "dek:" __flag > /dev/null; do
 898                 case "$__flag" in
 899                 d) __no_dialog=1 ;;
 900                 e) __show_err=1 ;;
 901                 k) __var_to_set="$OPTARG" ;;
 902                 esac
 903         done
 904         shift $(( $OPTIND - 1 ))
 905
 906         local __funcname="$1" __utility="$2"; shift 2
 907         local __cmd __output __retval
 908
 909         __cmd=$( printf -- "$@" )
 910         f_dprintf "%s: %s" "$__funcname" "$__cmd" # Log command *before* eval
 911         __output=$( exec 2>&1; eval "$__cmd" )
 912         __retval=$?
 913         if [ "$__output" ]; then
 914                 [ "$__show_err" ] && echo "$__output" >&2
 915                 f_dprintf "%s: retval=%i <output below>\n%s" "$__funcname" \
 916                           $__retval "$__output"
 917         else
 918                 f_dprintf "%s: retval=%i <no output>" "$__funcname" $__retval
 919         fi
 920
 921         ! [ "$__no_dialog" -o "$nonInteractive" -o $__retval -eq $SUCCESS ] &&
 922                 msg_error="${msg_error:-Error}${__utility:+: $__utility}" \
 923                         f_show_err "%s" "$__output"
 924                 # NB: f_show_err will handle NULL output appropriately
 925
 926         [ "$__var_to_set" ] && setvar "$__var_to_set" "$__output"
 927
 928         return $__retval
 929 }
 930
 931 # f_count $var_to_set arguments ...
 932 #
 933 # Sets $var_to_set to the number of arguments minus one (the effective number
 934 # of arguments following $var_to_set).
 935 #
 936 # Example:
 937 #       f_count count dog house # count=[2]
 938 #
 939 f_count()
 940 {
 941         setvar "$1" $(( $# - 1 ))
 942 }
 943
 944 # f_count_ifs $var_to_set string ...
 945 #
 946 # Sets $var_to_set to the number of words (split by the internal field
 947 # separator, IFS) following $var_to_set.
 948 #
 949 # Example 1:
 950 #
 951 #       string="word1   word2   word3"
 952 #       f_count_ifs count "$string" # count=[3]
 953 #       f_count_ifs count $string # count=[3]
 954 #
 955 # Example 2:
 956 #
 957 #       IFS=. f_count_ifs count www.freebsd.org # count=[3]
 958 #
 959 # NB: Make sure to use double-quotes if you are using a custom value for IFS
 960 # and you don't want the current value to effect the result. See example 3.
 961 #
 962 # Example 3:
 963 #
 964 #       string="a-b c-d"
 965 #       IFS=- f_count_ifs count "$string" # count=[3]
 966 #       IFS=- f_count_ifs count $string # count=[4]
 967 #
 968 f_count_ifs()
 969 {
 970         local __var_to_set="$1"
 971         shift 1
 972         set -- $*
 973         setvar "$__var_to_set" $#
 974 }
 975
 976 ############################################################ MAIN
 977
 978 #
 979 # Trap signals so we can recover gracefully
 980 #
 981 trap 'f_interrupt' SIGINT
 982 trap 'f_die' SIGTERM SIGPIPE SIGXCPU SIGXFSZ \
 983              SIGFPE SIGTRAP SIGABRT SIGSEGV
 984 trap '' SIGALRM SIGPROF SIGUSR1 SIGUSR2 SIGHUP SIGVTALRM
 985
 986 #
 987 # Clone terminal stdout/stderr so we can redirect to it from within sub-shells
 988 #
 989 eval exec $TERMINAL_STDOUT_PASSTHRU\>\&1
 990 eval exec $TERMINAL_STDERR_PASSTHRU\>\&2
 991
 992 #
 993 # Self-initialize unless requested otherwise
 994 #
 995 f_dprintf "%s: DEBUG_SELF_INITIALIZE=[%s]" \
 996           dialog.subr "$DEBUG_SELF_INITIALIZE"
 997 case "$DEBUG_SELF_INITIALIZE" in
 998 ""|0|[Nn][Oo]|[Oo][Ff][Ff]|[Ff][Aa][Ll][Ss][Ee]) : do nothing ;;
 999 *) f_debug_init
1000 esac
1001
1002 #
1003 # Log our operating environment for debugging purposes
1004 #
1005 f_dprintf "UNAME_S=[%s] UNAME_P=[%s] UNAME_R=[%s]" \
1006           "$UNAME_S" "$UNAME_P" "$UNAME_R"
1007
1008 f_dprintf "%s: Successfully loaded." common.subr
1009
1010 fi # ! $_COMMON_SUBR