usr.sbin/bsdconfig/bsdconfig

   1 #!/bin/sh
   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 ############################################################ INCLUDES
  31
  32 # When common.subr is included, it automatically scans "$@" for `-d' and/or
  33 # `-D file' arguments to conditionally enable debugging. Similarly, when
  34 # dialog.subr is included, it automatically scans "$@" for `-X' and/or `-S'.
  35 # To prevent this scanning from becoming confused by extra options, define
  36 # any/all extra arguments to use in the optstring to getopts when scanning
  37 # for dedicated options such as those described.
  38 #
  39 # NOTE: This needs to be declared before including `common.subr'.
  40 # NOTE: You really only need to list flags that require an argument as unknown
  41 #       flags are silently accepted unless they take an argument (in which case
  42 #       the following argument will terminate option processing unless it looks
  43 #       like a flag).
  44 #
  45 GETOPTS_EXTRA="f:"
  46
  47 BSDCFG_SHARE="/usr/share/bsdconfig"
  48 . $BSDCFG_SHARE/common.subr || exit 1
  49 f_dprintf "%s: loading includes..." "$0"
  50 f_include $BSDCFG_SHARE/dialog.subr
  51 f_include $BSDCFG_SHARE/mustberoot.subr
  52 f_include $BSDCFG_SHARE/strings.subr
  53
  54 BSDCFG_LIBE="/usr/libexec/bsdconfig"
  55 f_include_lang $BSDCFG_LIBE/include/messages.subr
  56
  57 BSDCONFIG_HELPFILE=$BSDCFG_LIBE/include/bsdconfig.hlp
  58 USAGE_HELPFILE=$BSDCFG_LIBE/include/usage.hlp
  59
  60 ############################################################ CONFIGURATION
  61
  62 #
  63 # Alternate `local' libexec directory for add-on modules (e.g., from ports)
  64 #
  65 BSDCFG_LOCAL_LIBE="/usr/local/libexec/bsdconfig"
  66
  67 ############################################################ FUNCTIONS
  68
  69 # usage
  70 #
  71 # display usage and exit
  72 #
  73 usage()
  74 {
  75         local index="INDEX"
  76         local cmd_list # Calculated below
  77
  78         cd $BSDCFG_LIBE
  79                 # No need to preserve CWD (headed toward exit)
  80
  81         # Test for language-specific indices
  82         f_quietly ls */"$index.${LANG:-$LC_ALL}" &&
  83                 index="$index.${LANG:-$LC_ALL}"
  84
  85         cmd_list=$(
  86                 awk '/^menu_selection="/ {
  87                         sub(/\|.*/, "")
  88                         sub(/^menu_selection="/, "")
  89                         print
  90                 }' */$index | sort
  91         )
  92
  93         local alt_cmd_list # Calculated below (if $BSDCFG_LOCAL_LIBE exists)
  94         if f_quietly cd $BSDCFG_LOCAL_LIBE; then
  95                 # No need to preserve CWD (headed toward exit)
  96
  97                 # Test for language-specific indices
  98                 f_quietly ls */"$index.${LANG:-$LC_ALL}" &&
  99                         index="$index.${LANG:-$LC_ALL}"
 100
 101                 alt_cmd_list=$(
 102                         awk '/^menu_selection="/ {
 103                                 sub(/\|.*/, "")
 104                                 sub(/^menu_selection="/, "")
 105                                 print
 106                         }' */$index 2> /dev/null | sort
 107                 )
 108
 109                 # Conflate lists, removing duplicates
 110                 cmd_list=$( printf "%s\n%s\n" \
 111                                    "$cmd_list" "$alt_cmd_list" | sort -u )
 112         fi
 113
 114         #
 115         # Determine the longest command-length (in characters)
 116         #
 117         local longest_cmd
 118         longest_cmd=$( echo "$cmd_list" | f_longest_line_length )
 119         f_dprintf "longest_cmd=[%s]" "$longest_cmd"
 120
 121         #
 122         # Determine the maximum width of terminal/console
 123         #
 124         local max_size="$( stty size 2> /dev/null )"
 125         : ${max_size:="24 80"}
 126         local max_width="${max_size#*[$IFS]}"
 127         f_dprintf "max_width=[%s]" "$max_width"
 128
 129         #
 130         # Using the longest command-length as the width of a single column,
 131         # determine if we can use more than one column to display commands.
 132         #
 133         local x=$longest_cmd ncols=1
 134         x=$(( $x + 8 )) # Accomodate leading tab character
 135         x=$(( $x + 3 + $longest_cmd )) # Preload end of next column
 136         while [ $x -lt $max_width ]; do
 137                 ncols=$(( $ncols + 1 ))
 138                 x=$(( $x + 3 + $longest_cmd ))
 139         done
 140         f_dprintf "ncols=[%u] x=[%u]" $ncols $x
 141
 142         #
 143         # Re-format the command-list into multiple columns
 144         #
 145         cmd_list=$( eval "$( echo "$cmd_list" |
 146                 awk -v ncols=$ncols -v size=$longest_cmd '
 147                 BEGIN {
 148                         n = 0
 149                         row_item[1] = ""
 150                 }
 151                 function print_row()
 152                 {
 153                         fmt = "printf \"\\t%-" size "s"
 154                         for (i = 1; i < cur_col; i++)
 155                                 fmt = fmt "   %-" size "s"
 156                         fmt = fmt "\\n\""
 157                         printf "%s", fmt
 158                         for (i = 1; i <= cur_col; i++)
 159                                 printf " \"%s\"", row_item[i]
 160                         print ""
 161                 }
 162                 {
 163                         n++
 164                         cur_col = (( n - 1 ) % ncols ) + 1
 165                         printf "f_dprintf \"row_item[%u]=[%%s]\" \"%s\"\n",
 166                                cur_col, $0
 167                         row_item[cur_col] = $0
 168                         if ( cur_col == ncols ) print_row()
 169                 }
 170                 END {
 171                         if ( cur_col < ncols ) print_row()
 172                 }' )"
 173         )
 174
 175         f_usage $BSDCFG_LIBE/USAGE \
 176                 "PROGRAM_NAME" "$pgm" \
 177                 "COMMAND_LIST" "$cmd_list"
 178
 179         # Never reached
 180 }
 181
 182 # dialog_menu_main
 183 #
 184 # Display the dialog(1)-based application main menu.
 185 #
 186 dialog_menu_main()
 187 {
 188         local title="$DIALOG_TITLE"
 189         local btitle="$DIALOG_BACKTITLE"
 190         local prompt="$msg_menu_text"
 191         local menu_list="
 192                 'X' '$msg_exit'  '$msg_exit_bsdconfig'
 193                 '1' '$msg_usage' '$msg_quick_start_how_to_use_this_menu_system'
 194         " # END-QUOTE
 195         local defaultitem= # Calculated below
 196         local hline=
 197
 198         #
 199         # Pick up the base modules (directories named `[0-9][0-9][0-9].*')
 200         #
 201         local menuitem menu_title menu_help menu_selection index=2
 202         for menuitem in $( cd $BSDCFG_LIBE && ls -d [0-9][0-9][0-9].* ); do
 203                 [ $index -lt ${#DIALOG_MENU_TAGS} ] || break
 204
 205                 menu_program= menu_title= menu_help=
 206                 f_include_lang $BSDCFG_LIBE/$menuitem/INDEX
 207                 [ "$menu_program" ] || continue
 208
 209                 case "$menu_program" in
 210                 /*) : already fully qualified ;;
 211                  *) menu_program="$menuitem/$menu_program"
 212                 esac
 213
 214                 tag=$( f_substr "$DIALOG_MENU_TAGS" $index 1 )
 215                 setvar "menu_program$tag" "$menu_program"
 216
 217                 f_shell_escape "$menu_title" menu_title
 218                 f_shell_escape "$menu_help" menu_help
 219                 menu_list="$menu_list '$tag' '$menu_title' '$menu_help'"
 220
 221                 index=$(( $index + 1 ))
 222         done
 223
 224         #
 225         # Process the `local' libexec sources.
 226         #
 227         # Whereas modules in $BSDCFG_LIBE must be named [0-9][0-9][0-9].*
 228         # modules in $BSDCFG_LOCAL_LIBE should NOT be named this way (making it
 229         # more practical for port-maintainers).
 230         #
 231         # This also has the fortunate side-effect of making the de-duplication
 232         # effort rather simple (because so-called `base' modules must be named
 233         # differently than add-on modules).
 234         #
 235         local separator_added=
 236         for menuitem in $( cd "$BSDCFG_LOCAL_LIBE" 2> /dev/null && ls -d * )
 237         do
 238                 # Skip the module if it looks like a `base' module
 239                 case "$menuitem" in [0-9][0-9][0-9].*) continue;; esac
 240
 241                 [ $index -lt ${#DIALOG_MENU_TAGS} ] || break
 242
 243                 menu_program= menu_title= menu_help=
 244                 f_include_lang $BSDCFG_LOCAL_LIBE/$menuitem/INDEX || continue
 245                 [ "$menu_program" ] || continue
 246
 247                 if [ ! "$separator_added" ]; then
 248                         menu_list="$menu_list '-' '-' ''"
 249                         separator_added=1
 250                 fi
 251
 252                 case "$menu_program" in
 253                 /*) : already fully qualified ;;
 254                  *) menu_program="$BSDCFG_LOCAL_LIBE/$menuitem/$menu_program"
 255                 esac
 256
 257                 tag=$( f_substr "$DIALOG_MENU_TAGS" $index 1 )
 258                 setvar "menu_program$tag" "$menu_program"
 259
 260                 f_shell_escape "$menu_title" menu_title
 261                 f_shell_escape "$menu_help" menu_help
 262                 menu_list="$menu_list '$tag' '$menu_title' '$menu_help'"
 263
 264                 index=$(( $index + 1 ))
 265         done
 266
 267         local height width rows
 268         eval f_dialog_menu_with_help_size height width rows \
 269                                           \"\$title\"  \
 270                                           \"\$btitle\" \
 271                                           \"\$prompt\" \
 272                                           \"\$hline\"  \
 273                                           $menu_list
 274
 275         # Obtain default-item from previously stored selection
 276         f_dialog_default_fetch defaultitem
 277
 278         local menu_choice
 279         menu_choice=$( eval $DIALOG \
 280                 --clear                                 \
 281                 --title \"\$title\"                     \
 282                 --backtitle \"\$btitle\"                \
 283                 --hline \"\$hline\"                     \
 284                 --item-help                             \
 285                 --ok-label \"\$msg_ok\"                 \
 286                 --cancel-label \"\$msg_exit_bsdconfig\" \
 287                 --help-button                           \
 288                 --help-label \"\$msg_help\"             \
 289                 ${USE_XDIALOG:+--help \"\"}             \
 290                 --default-item \"\$defaultitem\"        \
 291                 --menu \"\$prompt\"                     \
 292                 $height $width $rows                    \
 293                 $menu_list                              \
 294                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 295         )
 296         local retval=$?
 297         f_dialog_data_sanitize menu_choice
 298         f_dialog_menutag_store "$menu_choice"
 299
 300         # Only update default-item on success
 301         [ $retval -eq 0 ] && f_dialog_default_store "$menu_choice"
 302
 303         return $retval
 304 }
 305
 306 ############################################################ MAIN
 307
 308 #
 309 # If $0 is not "bsdconfig", interpret it either as a keyword to a menuitem or
 310 # as a valid resword (see script.subr for additional details about reswords).
 311 #
 312 if [ "$pgm" != "bsdconfig" ]; then
 313         if indexfile=$( f_index_file "$pgm" ) &&
 314            cmd=$( f_index_menusel_command "$indexfile" "$pgm" )
 315         then
 316                 f_dprintf "pgm=[%s] indexfile=[%s] cmd=[%s]" \
 317                           "$pgm" "$indexfile" "$cmd"
 318                 exec "$cmd" "$@" || exit 1
 319         else
 320                 f_include $BSDCFG_SHARE/script.subr
 321                 for resword in $RESWORDS; do
 322                         [ "$pgm" = "$resword" ] || continue
 323                         # Found a match
 324                         f_dprintf "pgm=[%s] A valid resWord!" "$pgm"
 325                         f_dispatch $resword
 326                         exit $?
 327                 done
 328         fi
 329 fi
 330
 331 #
 332 # Process command-line arguments
 333 #
 334 scripts_loaded=0
 335 while getopts f:h$GETOPTS_STDARGS flag; do
 336         case "$flag" in
 337         f) [ $scripts_loaded -eq 0 ] && f_include $BSDCFG_SHARE/script.subr
 338            f_script_load "$OPTARG"
 339            scripts_loaded=$(( $scripts_loaded + 1 )) ;;
 340         h|\?) usage ;;
 341         esac
 342 done
 343 shift $(( $OPTIND -1 ))
 344
 345 # If we've loaded any scripts, do not continue any further
 346 [ $scripts_loaded -gt 0 ] && exit
 347
 348 #
 349 # Initialize
 350 #
 351 f_dialog_title "$msg_main_menu"
 352
 353 [ "$SECURE" ] && f_mustberoot_init
 354
 355 # Incorporate rc-file if it exists
 356 [ -f "$HOME/.bsdconfigrc" ] && f_include "$HOME/.bsdconfigrc"
 357
 358 #
 359 # If a non-option argument was passed, process it as a menuitem selection...
 360 #
 361 if [ "$1" ]; then
 362         #
 363         # ...unless it's a long-option for usage.
 364         #
 365         case "$1" in -help|--help|-\?)
 366                 usage
 367                 # Not reached
 368         esac
 369
 370         #
 371         # Find the INDEX (possibly i18n) claiming this keyword and get the
 372         # command to execute from the menu_selection line.
 373         #
 374         if ! { indexfile=$( f_index_file "$1" ) &&
 375                cmd=$( f_index_menusel_command "$indexfile" "$1" )
 376         }; then
 377                 # no matches, display usage (which shows valid keywords)
 378                 f_err "%s: %s: $msg_not_found\n" "$pgm" "$1"
 379                 usage
 380                 # Not reached
 381         fi
 382
 383         shift
 384         exec $cmd ${USE_XDIALOG:+-X} "$@" || exit 1
 385         # Not reached
 386 fi
 387
 388 #
 389 # Launch application main menu
 390 #
 391 while :; do
 392         dialog_menu_main
 393         retval=$?
 394         f_dialog_menutag_fetch mtag
 395         f_dprintf "retval=%u mtag=[%s]" $retval "$mtag"
 396
 397         if [ $retval -eq 2 ]; then
 398                 # The Help button was pressed
 399                 f_show_help "$BSDCONFIG_HELPFILE"
 400                 continue
 401         elif [ $retval -ne 0 ]; then
 402                 f_die
 403         fi
 404
 405         case "$mtag" in
 406         X) break ;;
 407         1) # Usage
 408            f_show_help "$USAGE_HELPFILE"
 409            continue
 410         esac
 411
 412         # Anything else is a dynamically loaded menuitem
 413
 414         f_getvar menu_program$mtag menu_program
 415         case "$menu_program" in
 416         /*) cmd="$menu_program" ;;
 417          *) cmd="$BSDCFG_LIBE/$menu_program"
 418         esac
 419         f_dprintf "cmd=[%s]" "$cmd"
 420         $cmd ${USE_XDIALOG:+-X}
 421 done
 422
 423 exit $SUCCESS
 424
 425 ################################################################################
 426 # END
 427 ################################################################################