group_input.subr revision 251266
1238438Sdteskeif [ ! "$_USERMGMT_GROUP_INPUT_SUBR" ]; then _USERMGMT_GROUP_INPUT_SUBR=1 2238438Sdteske# 3238438Sdteske# Copyright (c) 2012 Ron McDowell 4249751Sdteske# Copyright (c) 2012-2013 Devin Teske 5238438Sdteske# All rights reserved. 6238438Sdteske# 7238438Sdteske# Redistribution and use in source and binary forms, with or without 8238438Sdteske# modification, are permitted provided that the following conditions 9238438Sdteske# are met: 10238438Sdteske# 1. Redistributions of source code must retain the above copyright 11238438Sdteske# notice, this list of conditions and the following disclaimer. 12238438Sdteske# 2. Redistributions in binary form must reproduce the above copyright 13238438Sdteske# notice, this list of conditions and the following disclaimer in the 14238438Sdteske# documentation and/or other materials provided with the distribution. 15238438Sdteske# 16238438Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17238438Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18238438Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19238438Sdteske# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20238438Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21238438Sdteske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22238438Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23238438Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24238438Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25238438Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26238438Sdteske# SUCH DAMAGE. 27238438Sdteske# 28238438Sdteske# $FreeBSD: head/usr.sbin/bsdconfig/usermgmt/share/group_input.subr 251266 2013-06-02 22:34:40Z dteske $ 29238438Sdteske# 30238438Sdteske############################################################ INCLUDES 31238438Sdteske 32240684SdteskeBSDCFG_SHARE="/usr/share/bsdconfig" 33240684Sdteske. $BSDCFG_SHARE/common.subr || exit 1 34244675Sdteskef_dprintf "%s: loading includes..." usermgmt/group_input.subr 35240684Sdteskef_include $BSDCFG_SHARE/dialog.subr 36240684Sdteskef_include $BSDCFG_SHARE/strings.subr 37240684Sdteske 38240684SdteskeBSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="070.usermgmt" 39238438Sdteskef_include_lang $BSDCFG_LIBE/include/messages.subr 40238438Sdteskef_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr 41238438Sdteske 42238438Sdteske############################################################ FUNCTIONS 43238438Sdteske 44238438Sdteske# f_input_group $group 45238438Sdteske# 46238438Sdteske# Given $group name or id, create the environment variables group_name, 47238438Sdteske# group_gid, and group_members (and group_password is reset to NULL). 48238438Sdteske# 49238438Sdteskef_input_group() 50238438Sdteske{ 51238438Sdteske eval $( pw groupshow "$1" | awk -F: ' 52238438Sdteske { 53238438Sdteske printf "group_name='\'%s\''\n", $1 54238438Sdteske printf "group_password=\n" 55238438Sdteske printf "group_gid='\'%s\''\n", $3 56238438Sdteske printf "group_members='\'%s\''\n", $4 57238438Sdteske exit 58238438Sdteske }' ) 59238438Sdteske} 60238438Sdteske 61249751Sdteske# f_dialog_menu_group_list [$default] 62238438Sdteske# 63249751Sdteske# Allows the user to select a group from a list. Optionally, if present and 64249751Sdteske# non-NULL, initially highlight $default group. 65238438Sdteske# 66238438Sdteskef_dialog_menu_group_list() 67238438Sdteske{ 68251264Sdteske local prompt= 69251264Sdteske local menu_list=" 70251264Sdteske 'X $msg_exit' '' 71251264Sdteske " # END-QUOTE 72249751Sdteske local defaultitem="$1" 73238438Sdteske local hline="$hline_alnum_punc_tab_enter" 74238438Sdteske 75238438Sdteske # Add groups from group(5) 76238438Sdteske menu_list="$menu_list $( pw groupshow -a | awk -F: ' 77238438Sdteske !/^[[:space:]]*(#|$)/ { 78238438Sdteske printf "'\'%s\'\ \'%s\''\n", $1, $1 79238438Sdteske }' 80238438Sdteske )" 81238438Sdteske 82251190Sdteske local height width rows 83251190Sdteske eval f_dialog_menu_size height width rows \ 84251190Sdteske \"\$DIALOG_TITLE\" \ 85251190Sdteske \"\$DIALOG_BACKTITLE\" \ 86251264Sdteske \"\$prompt\" \ 87251190Sdteske \"\$hline\" \ 88251190Sdteske $menu_list 89238438Sdteske 90251236Sdteske local menu_choice 91251236Sdteske menu_choice=$( eval $DIALOG \ 92249751Sdteske --title \"\$DIALOG_TITLE\" \ 93238438Sdteske --backtitle \"\$DIALOG_BACKTITLE\" \ 94238438Sdteske --hline \"\$hline\" \ 95238438Sdteske --ok-label \"\$msg_ok\" \ 96238438Sdteske --cancel-label \"\$msg_cancel\" \ 97249751Sdteske --default-item \"\$defaultitem\" \ 98251264Sdteske --menu \"\$prompt\" \ 99251190Sdteske $height $width $rows \ 100251190Sdteske $menu_list \ 101240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 102240768Sdteske ) 103240768Sdteske local retval=$? 104251236Sdteske f_dialog_menutag_store -s "$menu_choice" 105240768Sdteske return $retval 106238438Sdteske} 107238438Sdteske 108238438Sdteske# f_dialog_input_group_name [$group_name] 109238438Sdteske# 110238438Sdteske# Allows the user to enter a new groupname for a given group. If the user does 111238438Sdteske# not cancel or press ESC, the $group_name variable will hold the 112238438Sdteske# newly-configured value upon return. 113238438Sdteske# 114238438Sdteske# If $cur_group_name is defined, the user can enter that and by-pass error- 115238438Sdteske# checking (allowing the user to "revert" to an old value without, for example, 116238438Sdteske# being told that the groupname already exists). 117238438Sdteske# 118238438Sdteskef_dialog_input_group_name() 119238438Sdteske{ 120238438Sdteske # 121238438Sdteske # Loop until the user provides taint-free/valid input 122238438Sdteske # 123244548Sdteske local _name="$1" _input="$1" 124238438Sdteske while :; do 125238438Sdteske 126238438Sdteske # Return if user has either pressed ESC or chosen Cancel/No 127251242Sdteske f_dialog_input _input "$msg_group" "$_input" \ 128251242Sdteske "$hline_alnum_tab_enter" || return 129238438Sdteske 130238438Sdteske # Check for no-change 131238438Sdteske [ "$_input" = "$_name" ] && return $SUCCESS 132238438Sdteske 133238438Sdteske # Check for reversion 134238438Sdteske if [ "$_input" = "$cur_group_name" ]; then 135238438Sdteske group_name="$cur_group_name" 136238438Sdteske return $SUCCESS 137238438Sdteske fi 138238438Sdteske 139238438Sdteske # Check for NULL entry 140238438Sdteske if [ ! "$_input" ]; then 141245437Sdteske f_dialog_msgbox "$msg_group_is_empty" 142238438Sdteske continue 143238438Sdteske fi 144238438Sdteske 145238438Sdteske # Check for invalid entry 146238438Sdteske if ! echo "$_input" | grep -q "^[[:alpha:]]"; then 147245437Sdteske f_dialog_msgbox "$msg_group_must_start_with_letter" 148238438Sdteske continue 149238438Sdteske fi 150238438Sdteske 151238438Sdteske # Check for duplicate entry 152238438Sdteske if f_quietly pw groupshow -n "$_input"; then 153238438Sdteske f_show_msg "$msg_group_already_used" "$_input" 154238438Sdteske continue 155238438Sdteske fi 156238438Sdteske 157238438Sdteske group_name="$_input" 158238438Sdteske break 159238438Sdteske done 160238438Sdteske save_flag=1 161238438Sdteske 162244550Sdteske f_dprintf "group_name: [%s]->[%s]" "$cur_group_name" "$group_name" 163238438Sdteske 164238438Sdteske return $SUCCESS 165238438Sdteske} 166238438Sdteske 167238438Sdteske# f_dialog_input_group_password 168238438Sdteske# 169238438Sdteske# Prompt the user to enter a password (twice). 170238438Sdteske# 171238438Sdteskef_dialog_input_group_password() 172238438Sdteske{ 173251264Sdteske local prompt1="$msg_group_password" 174251264Sdteske local prompt2="$msg_reenter_group_password" 175238438Sdteske local hline="$hline_alnum_punc_tab_enter" 176238438Sdteske 177251190Sdteske local height1 width1 178251190Sdteske f_dialog_inputbox_size height1 width1 \ 179238438Sdteske "$DIALOG_TITLE" \ 180238438Sdteske "$DIALOG_BACKTITLE" \ 181251264Sdteske "$prompt1" \ 182238438Sdteske "" \ 183251190Sdteske "$hline" 184238438Sdteske 185251190Sdteske local height2 width2 186251190Sdteske f_dialog_inputbox_size height2 width2 \ 187238438Sdteske "$DIALOG_TITLE" \ 188238438Sdteske "$DIALOG_BACKTITLE" \ 189251264Sdteske "$prompt2" \ 190238438Sdteske "" \ 191251190Sdteske "$hline" 192238438Sdteske 193238438Sdteske # 194238438Sdteske # Loop until the user provides taint-free/valid input 195238438Sdteske # 196238438Sdteske local retval _password1 _password2 197238438Sdteske while :; do 198251242Sdteske _password1=$( $DIALOG \ 199251190Sdteske --title "$DIALOG_TITLE" \ 200251190Sdteske --backtitle "$DIALOG_BACKTITLE" \ 201251190Sdteske --hline "$hline" \ 202251190Sdteske --ok-label "$msg_ok" \ 203251190Sdteske --cancel-label "$msg_cancel" \ 204251190Sdteske --insecure \ 205251264Sdteske --passwordbox "$prompt1" \ 206251190Sdteske $height1 $width1 \ 207240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 208240768Sdteske ) 209238438Sdteske retval=$? 210251242Sdteske debug= f_dialog_line_sanitize _password1 211238438Sdteske 212238438Sdteske # Return if user has either pressed ESC or chosen Cancel/No 213238438Sdteske [ $retval -eq $SUCCESS ] || return $retval 214238438Sdteske 215251242Sdteske _password2=$( $DIALOG \ 216251190Sdteske --title "$DIALOG_TITLE" \ 217251190Sdteske --backtitle "$DIALOG_BACKTITLE" \ 218251190Sdteske --hline "$hline" \ 219251190Sdteske --ok-label "$msg_ok" \ 220251190Sdteske --cancel-label "$msg_cancel" \ 221251190Sdteske --insecure \ 222251264Sdteske --passwordbox "$prompt2" \ 223251190Sdteske $height2 $width2 \ 224240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 225240768Sdteske ) 226238438Sdteske retval=$? 227251242Sdteske debug= f_dialog_line_sanitize _password2 228238438Sdteske 229238438Sdteske # Return if user has either pressed ESC or chosen Cancel/No 230238438Sdteske [ $retval -eq $SUCCESS ] || return $retval 231238438Sdteske 232238438Sdteske # Check for password mismatch 233238438Sdteske if [ "$_password1" != "$_password2" ]; then 234245437Sdteske f_dialog_msgbox "$msg_group_passwords_do_not_match" 235238438Sdteske continue 236238438Sdteske fi 237238438Sdteske 238238438Sdteske # Check for NULL entry 239238438Sdteske if [ ! "$_password1" ]; then 240238438Sdteske f_dialog_yesno \ 241238438Sdteske "$msg_disable_password_auth_for_group" || 242238438Sdteske continue 243238438Sdteske pw_group_password_disable=1 244238438Sdteske else 245238438Sdteske pw_group_password_disable= 246238438Sdteske fi 247238438Sdteske 248238438Sdteske group_password="$_password1" 249238438Sdteske break 250238438Sdteske done 251238438Sdteske save_flag=1 252238438Sdteske 253244550Sdteske f_dprintf "group_password: [%s]->[%s]" \ 254244550Sdteske "$cur_group_password" "$group_password" 255238438Sdteske 256238438Sdteske return $SUCCESS 257238438Sdteske} 258238438Sdteske 259238438Sdteske# f_dialog_input_group_gid [$group_gid] 260238438Sdteske# 261238438Sdteske# Allow the user to enter a new GID for a given group. If the user does not 262238438Sdteske# cancel or press ESC, the $group_gid variable will hold the newly-configured 263238438Sdteske# value upon return. 264238438Sdteske# 265238438Sdteskef_dialog_input_group_gid() 266238438Sdteske{ 267244548Sdteske local _input="$1" 268238438Sdteske 269238438Sdteske # Return if user has either pressed ESC or chosen Cancel/No 270251242Sdteske f_dialog_input _input "$msg_group_id_leave_empty_for_default" \ 271251242Sdteske "$_input" "$hline_num_tab_enter" || return 272238438Sdteske 273238438Sdteske group_gid="$_input" 274238438Sdteske save_flag=1 275238438Sdteske 276244550Sdteske f_dprintf "group_gid: [%s]->[%s]" "$cur_group_gid" "$group_gid" 277238438Sdteske 278238438Sdteske return $SUCCESS 279238438Sdteske} 280238438Sdteske 281238438Sdteske# f_dialog_input_group_members [$group_members] 282238438Sdteske# 283251266Sdteske# Allow the user to modify a list of members for a given group. If the user 284251266Sdteske# does not cancel or press ESC, the $group_members variable will hold the 285251266Sdteske# newly-configured value upon return. 286238438Sdteske# 287238438Sdteskef_dialog_input_group_members() 288238438Sdteske{ 289251264Sdteske local _input="$1" 290251264Sdteske local prompt="$msg_group_members:" 291251264Sdteske local menu_list=" 292238438Sdteske 'X' '$msg_continue' 293238438Sdteske '1' '$msg_select_group_members_from_list' 294238438Sdteske '2' '$msg_enter_group_members_manually' 295238438Sdteske " # END-QUOTE 296251264Sdteske local defaultitem= 297251264Sdteske local hline="$hline_num_arrows_tab_enter" 298238438Sdteske 299251190Sdteske local mheight mwidth mrows 300251190Sdteske eval f_dialog_menu_size mheight mwidth mrows \ 301251190Sdteske \"\$DIALOG_TITLE\" \ 302251190Sdteske \"\$DIALOG_BACKTITLE\" \ 303251264Sdteske \"\$prompt\" \ 304251190Sdteske \"\$hline\" \ 305251190Sdteske $menu_list 306251190Sdteske 307251264Sdteske local menu_choice retval 308238438Sdteske while :; do 309251236Sdteske menu_choice=$( eval $DIALOG \ 310238438Sdteske --title \"\$DIALOG_TITLE\" \ 311238438Sdteske --backtitle \"\$DIALOG_BACKTITLE\" \ 312238438Sdteske --hline \"\$hline\" \ 313238438Sdteske --ok-label \"\$msg_ok\" \ 314238438Sdteske --cancel-label \"\$msg_cancel\" \ 315249751Sdteske --default-item \"\$defaultitem\" \ 316251264Sdteske --menu \"\$prompt\" \ 317251190Sdteske $mheight $mwidth $mrows \ 318238438Sdteske $menu_list \ 319240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 320240768Sdteske ) 321238438Sdteske retval=$? 322251236Sdteske f_dialog_data_sanitize menu_choice 323251236Sdteske defaultitem="$menu_choice" 324244550Sdteske f_dprintf "retval=%u menu_choice=[%s]" $retval "$menu_choice" 325238438Sdteske 326238438Sdteske # Return if user has either pressed ESC or chosen Cancel/No 327238438Sdteske [ $retval -eq $SUCCESS ] || return $retval 328238438Sdteske 329251264Sdteske local _group_members 330238438Sdteske case "$menu_choice" in 331238438Sdteske X) # Exit 332238438Sdteske break ;; 333238438Sdteske 1) # Select Group Members from a list 334251264Sdteske local user check_list= 335251264Sdteske for user in $( pw usershow -a | 336251264Sdteske awk -F: '!/^[[:space:]]*(#|$)/{print $1}' 337251264Sdteske ); do 338251264Sdteske # Format of a checklist entry: tag item status 339238438Sdteske if echo "$_input" | grep -q "\<$user\>"; then 340251264Sdteske check_list="$check_list $user '' on" 341238438Sdteske else 342251264Sdteske check_list="$check_list $user '' off" 343238438Sdteske fi 344238438Sdteske done 345238438Sdteske 346251190Sdteske local cheight cwidth crows 347251190Sdteske eval f_dialog_checklist_size cheight cwidth crows \ 348251190Sdteske \"\$DIALOG_TITLE\" \ 349251190Sdteske \"\$DIALOG_BACKTITLE\" \ 350251264Sdteske \"\$prompt\" \ 351251190Sdteske \"\$hline\" \ 352251264Sdteske $check_list 353251236Sdteske _group_members=$( eval $DIALOG \ 354238438Sdteske --title \"\$DIALOG_TITLE\" \ 355238438Sdteske --backtitle \"\$DIALOG_BACKTITLE\" \ 356238438Sdteske --separate-output \ 357238438Sdteske --hline \"\$hline\" \ 358238438Sdteske --ok-label \"\$msg_ok\" \ 359238438Sdteske --cancel-label \"\$msg_cancel\" \ 360251264Sdteske --checklist \"\$prompt\" \ 361251190Sdteske $cheight $cwidth $crows \ 362251264Sdteske $check_list \ 363240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 364251236Sdteske ) || continue 365251236Sdteske # Return to previous menu if user either 366251236Sdteske # pressed ESC or chose Cancel/No 367251236Sdteske f_dialog_data_sanitize _group_members 368251236Sdteske 369251236Sdteske # Convert the newline separated list into a comma- 370251236Sdteske # separated one so that if the user switches over to 371251236Sdteske # manual editing, list reflects checklist selections 372251236Sdteske _group_members=$( echo "$_group_members" | 373251236Sdteske tr '\n' ' ' | 374251236Sdteske sed -e 's/[[:space:]]\{1,\}/,/g;s/^,//;s/,$//' 375240768Sdteske ) 376238438Sdteske 377238438Sdteske _input="$_group_members" 378238438Sdteske ;; 379238438Sdteske 2) # Enter Group Members manually 380251264Sdteske local p="$msg_group_members ($msg_separated_by_commas)" 381238438Sdteske 382251264Sdteske f_dialog_input _group_members "$p" "$_input" \ 383251242Sdteske "$hline_num_tab_enter" || continue 384251242Sdteske # Return to previous menu if user either 385251242Sdteske # pressed ESC or chose Cancel/No 386238438Sdteske 387238438Sdteske _input="$_group_members" 388238438Sdteske ;; 389238438Sdteske esac 390238438Sdteske done 391238438Sdteske 392238438Sdteske group_members="$_input" 393238438Sdteske save_flag=1 394244550Sdteske f_dprintf "group_members: [%s]->[%s]" \ 395244550Sdteske "$cur_group_members" "$group_members" 396238438Sdteske 397238438Sdteske return $SUCCESS 398238438Sdteske} 399238438Sdteske 400244675Sdteske############################################################ MAIN 401244675Sdteske 402244675Sdteskef_dprintf "%s: Successfully loaded." usermgmt/group_input.subr 403244675Sdteske 404238438Sdteskefi # ! $_USERMGMT_GROUP_INPUT_SUBR 405