rewrite of user config, major improvements

For the full changelog and remaining todos, refer to:

https://github.com/bevry/dorothy/discussions/24

Closes #23 #17

Signed-off-by: Benjamin Lupton <b@lupton.cc>

TIPS.md

@@ -1,5 +1,25 @@
 # Scripts
 
+## shell
+
+``` bash
+if test -n "${ZSH_VERSION-}"; then
+	echo 'zsh'
+elif test -n "${FISH_VERSION-}"; then
+	echo 'fish'
+elif test -n "${BASH_VERSION-}"; then
+	echo 'bash'
+elif test -n "${KSH_VERSION-}"; then
+	echo 'ksh'
+elif test -n "${FCEDIT-}"; then
+	echo 'ksh'
+elif test -n "${PS3-}"; then
+	echo 'unknown'
+else
+	echo 'sh'
+fi
+```
+
 ## exit codes
 
 - [Command exit codes](https://gist.github.com/shinokada/5432e491f9992da994fbed05948bfba1)
@@ -39,6 +59,7 @@ https://stackoverflow.com/a/68310927/130638
 - http://unix.stackexchange.com/a/246320/50703
 - `-z` is empty string: True if the length of string is zero.
 - `-n` is string: True if the length of string is nonzero.
+- `-e` is file or directory.
 - `-d` is dir: True if file exists and is a directory.
 - `-f` is file: True if file exists and is a regular file.
 - `-s` is nonempty file: True if file exists and has a size greater than zero.

commands/ask

@@ -19,7 +19,8 @@ if is-help "$@"; then
 		'Provide [--password] to specify that the prompt should hide the value when entering by using password mode.' \
 		'Provide [--required] to specify that the prompt should not continue until a value is provided.' \
 		'Provide [--timeout=...] to specify a custom timeout value in seconds.' \
-		'Provide [--flag=...] -- <...args> to specify a flag to search the arguments for, to set a default value.'
+		'Provide [--flag=...] -- <...args> to specify a flag to search the arguments for, to set a default value.' \
+		'Provide [--main] to not create an alternative TTY shell when promting for questions.'
 	exit 22 # Invalid argument
 fi
 
@@ -29,9 +30,10 @@ option_question="$(get-flag-value question -- "${options[@]}")"
 option_default="$(get-flag-value default -- "${options[@]}")"
 option_confirm="$(get-flag-value confirm -- "${options[@]}")"
 option_password="$(get-flag-value password -- "${options[@]}")"
-option_required="$(get-flag-value required -- "${options[@]}")"
+option_required="$(get-flag-value required -- "${options[@]}" | echo-on-empty-stdin 'no')"
 option_timeout="$(get-flag-value timeout -- "${options[@]}")"
 option_flag="$(get-flag-value flag -- "${options[@]}")"
+option_main="$(get-flag-value main -- "${options[@]}" | echo-on-empty-stdin 'no')"
 mapfile -t args < <(echo-after-separator "$@")
 
 # prepare
@@ -52,7 +54,7 @@ function handle_timeout () {
 		sleep 10
 		echo "$result"
 		return 0
-	elif test "$option_required" != 'yes'; then
+	elif test "$option_required" = 'no'; then
 		stderr echo 'Ask timed out, as the field was optional will use no value.'
 		sleep 10
 		return 0
@@ -63,7 +65,9 @@ function handle_timeout () {
 	fi
 }
 function ask () {
-	tty_auto
+	if test "$option_main" = 'no'; then
+		tty_auto
+	fi
 	asked='yes'
 	if test -n "${1-}"; then
 		echo -e "$1" > /dev/tty
@@ -75,7 +79,7 @@ function ask () {
 		fi
 		if is-value "$result"; then
 			break
-		elif test "$option_required" != 'yes'; then
+		elif test "$option_required" = 'no'; then
 			result=''
 			break
 		fi
@@ -110,12 +114,12 @@ function validate () {
 	else
 		choices+=('custom' 'enter a value')
 	fi
-	if test "$option_required" != 'yes'; then
+	if test "$option_required" = 'no'; then
 		choices+=('none' 'use no value')
 	fi
 
 	# as need to confirm, adjust the timeout
-	if test -z "$option_timeout" && (is-value "$result" || test "$option_required" != 'yes'); then
+	if test -z "$option_timeout" && (is-value "$result" || test "$option_required" = 'no'); then
 		# timeout of one minute for confirms of existing values, or optional values
 		option_timeout=60
 	fi
@@ -124,6 +128,7 @@ function validate () {
 	local ec=0; choice="$(choose-option \
 		--question="$option_question" \
 		--timeout="$option_timeout" \
+		--main="$option_main" \
 		--label \
 		-- "${choices[@]}")" || ec="$?"
 

commands/checksum

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 source "$DOROTHY/sources/strict.bash"
 
+# dependencies
+env QUIET=y CLI='pv' APT='pv' BREW='pv' setup-util
+
 # algorithms
 algorithms=()
 for alg in 'md5sum' 'shasum' 'sha256sum'; do

commands/chmod-partial

@@ -2,18 +2,18 @@
 source "$DOROTHY/sources/strict.bash"
 
 # options
-mapfile -t options < <(echo-before-separator "$@")
+mapfile -t permissions < <(echo-before-separator "$@")
 mapfile -t paths < <(echo-after-separator "$@")
 
-if is-array-empty-or-partial "${options[@]}" || is-array-empty-or-partial "${paths[@]}"; then
+if is-array-empty-or-partial "${permissions[@]}" || is-array-empty-or-partial "${paths[@]}"; then
 	stderr echo "USAGE:"
-	stderr echo "chmod-partial <options> -- <paths...>"
+	stderr echo "chmod-partial <permissions> -- <paths...>"
 	stderr echo ""
 	stderr echo "EXAPLE:"
-	stderr echo "chmod-partial -f +x -- path path path"
+	stderr echo "chmod-partial +x -- path path path"
 	exit 1
 fi
 
 for path in "${paths[@]}"; do
-	chmod "${options[@]}" "$path" || echo "unable to ${options[*]}: $path"
+	chmod --changes --recursive "${permissions[@]}" "$path" || echo "unable to ${permissions[*]}: $path"
 done

commands/choose-menu

@@ -25,16 +25,18 @@ if is-help-separator "$@"; then
 		'FLAGS:' \
 		'Provide [--question=...] to specify the question that the prompt will be answering.' \
 		'Provide [--multi] to specify that multiple menu items should be able to be selected.' \
-		'Provide [--timeout=...] to specify a custom timeout value in seconds.'
+		'Provide [--timeout=...] to specify a custom timeout value in seconds.' \
+		'Provide [--main] to not create an alternative TTY shell when promting for questions.'
 	exit 22 # Invalid argument
 fi
-tty_auto
 
 # options
 mapfile -t options < <(echo-before-separator "$@")
 option_question="$(get-flag-value question -- "${options[@]}")"
 option_multi="$(get-flag-value multi -- "${options[@]}" | echo-on-empty-stdin 'no')"
 option_timeout="$(get-flag-value timeout -- "${options[@]}")"
+option_main="$(get-flag-value main -- "${options[@]}" | echo-on-empty-stdin 'no')"
+option_required="$(get-flag-value required -- "${options[@]}" | echo-on-empty-stdin 'no')"
 mapfile -t choices < <(echo-after-separator "$@")
 
 # ensure we have items
@@ -46,6 +48,9 @@ if is-array-empty-or-partial "${choices[@]}"; then
 fi
 
 # prepare
+if test "$option_main" = 'no'; then
+	tty_auto
+fi
 cursor=0
 count="${#choices[@]}"
 last="$((count - 1 ))"
@@ -150,24 +155,34 @@ while test "$action" != 'done'; do
 		fi
 		break
 	elif test "$action" = "escape"; then
-		break
+		# todo implement --required with --multi fallback properly here
+		if test "$option_required" = 'no'; then
+			break
+		fi
 	fi
 
 	# no break, so repeat the menu
-	tty_clear
+	if test "$option_main" = 'no'; then
+		tty_clear
+	fi
 done
 
 # if break, then no clear occured, so clear it here
-tty_clear
+if test "$option_main" = 'no'; then
+	tty_clear
+fi
 
 # if multi with no selection then ask for everything
+# todo implement --required properly here
 if is-array-empty "${selections[@]}" && test "$option_multi" = 'yes'; then
 	if confirm-positive "You exited without selecting anything, do you wish to select all?" > /dev/tty; then
 		for i in "${!choices[@]}"; do
 			selections[$i]='yes'
 		done
 	fi
-	tty_clear
+	if test "$option_main" = 'no'; then
+		tty_clear
+	fi
 fi
 
 # output the custom selections

commands/choose-option

@@ -18,9 +18,11 @@ if is-help-separator "$@"; then
 		'  [--filter=filter] \ ' \
 		'  [--label[=first]] \ ' \
 		"  [--return='\$label'] \ " \
-		"  [--visual='\$label [\$value]' \ " \
-		"  [--multi]' \ " \
-		"  [--confirm]' \ " \
+		"  [--visual='\$label [\$value]'] \ " \
+		'  [--required] \ ' \
+		"  [--multi] \ " \
+		"  [--confirm] \ " \
+		"  [--main] \ " \
 		'  -- <[value]...> <value> <value>' \
 		'' \
 		'If you wish to show a question above the menu:' \
@@ -29,6 +31,9 @@ if is-help-separator "$@"; then
 		'If you wish to filter the value and/or labels, use:' \
 		'--filter=filter -- <...>' \
 		'' \
+		'If you wish to prevent using the escape key to provide no selection, use:' \
+		'--required -- <...>' \
+		'' \
 		'If you wish to allow multiple selections:' \
 		'--multi -- <...>' \
 		'' \
@@ -54,7 +59,10 @@ if is-help-separator "$@"; then
 		'' \
 		'If you wish to return the visual use:' \
 		"--label --return='\$visual' -- <[value, label]...>" \
-		"^ the value is eval'd"
+		"^ the value is eval'd" \
+		'' \
+		'If you wish to not use an alternative TTY shell, use:' \
+		'--main -- <[value, label]...>'
 	exit 22 # Invalid argument
 fi
 
@@ -67,6 +75,8 @@ option_visual="$(get-flag-value visual -- "${options[@]}")"
 option_multi="$(get-flag-value multi -- "${options[@]}" | echo-on-empty-stdin 'no')"
 option_timeout="$(get-flag-value timeout -- "${options[@]}")"
 option_confirm="$(get-flag-value confirm -- "${options[@]}")"
+option_required="$(get-flag-value required -- "${options[@]}" | echo-on-empty-stdin 'no')"
+option_main="$(get-flag-value main -- "${options[@]}" | echo-on-empty-stdin 'no')"
 # shellcheck disable=2016
 option_return="$(get-flag-value 'return' -- "${options[@]}" | echo-on-empty-stdin '$value')"
 
@@ -209,6 +219,8 @@ function act () {
 		local ec=0; results="$(choose-menu \
 			--question="$option_question" \
 			--multi="$option_multi" \
+			--main="$option_main" \
+			--required="$option_required" \
 			--timeout="$option_timeout" \
 			-- "${filtered_visuals[@]}")" || ec="$?"
 
@@ -222,6 +234,15 @@ function act () {
 			# some other failure
 			sleep 10
 			exit "$ec"
+		elif test -z "$results"; then
+			# no option
+			if test "$option_required" = 'no'; then
+				exit 0
+			else
+				echo "No input returned, despite required." > /dev/stderr
+				sleep 10
+				exit 5 # Input/output error
+			fi
 		fi
 
 		# results
@@ -235,7 +256,13 @@ function act () {
 	if test "${#values[@]}" -gt 1 -a "$option_confirm" = 'yes'; then
 		# timeout of one minute for confirms of existing values
 		confirm_value="$(echo -n "${final_results[@]}")"
-		local ec=0; confirmed="$(choose-option --timeout=60 --question="$option_question" --label -- \
+		local ec=0; confirmed="$(choose-option \
+			--timeout=60 \
+			--question="$option_question" \
+			--main="$option_main" \
+			--required="$option_required" \
+			--label \
+			-- \
 			yes "Use: $confirm_value" \
 			no  "Select something else.")" || ec="$?"
 

commands/config-add

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+source "$DOROTHY/sources/strict.bash"
+
+config-set "$1" "$2" "$2"

commands/config-get

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+source "$DOROTHY/sources/strict.bash"
+
+# dependencies
+env QUIET=y setup-util-ripgrep
+
+# options
+file="$1"      # /etc/systemd/resolved.conf
+find="$2"      # Domains
+
+rg -o "^$find=(.+)" --replace '$1' < "$file"

commands/config-replace

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+source "$DOROTHY/sources/strict.bash"
+
+# dependencies
+env QUIET=y setup-util-ripgrep
+
+# options
+file="$1"      # /etc/systemd/resolved.conf
+content="$(cat "$file")"
+find="$2"      # Domains
+pattern="^[#]?$find=.+?\n"
+replace="$3"   # Domains=~.
+
+# act, replacing inline
+sudo touch "$file"
+if rg -q "$pattern" <<< "$content"; then
+	(rg --passthru "$pattern" --replace "$replace" <<< "$content") > "$file"
+else
+	echo -e "$content\n\n$replace" > "$file"
+fi

commands/conf-update → commands/config-set

@@ -1,16 +1,19 @@
 #!/usr/bin/env bash
 source "$DOROTHY/sources/strict.bash"
 
+# dependencies
+env QUIET=y setup-util-sd
+
 # options
 file="$1"      # /etc/systemd/resolved.conf
 find="$2"      # Domains
+pattern="^[#]?$find=.+?\n"
 replace="$3"   # Domains=~.
 
-env QUIET=y setup-util-sd
-
+# act, replacing at the end
 sudo touch "$file"
-contents="$(sd -p "^[#]?$find=.+?\n" '' < "$file")"
-if is-nonempty-string "$contents"; then
+contents="$(sd -p "$pattern" '' < "$file")"
+if test -n "$contents"; then
 	contents+="\n"
 fi
 echo -e "$contents$replace" | sudo tee "$file" &> /dev/null  # silent everything

commands/ddns

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
-source "$DOROTHY/sources/user.sh"
 source "$DOROTHY/sources/strict.bash"
+source "$DOROTHY/sources/config.sh"
+load_dorothy_config 'ddns.bash'
 
 # dependencies
 env QUIET=y setup-util-httpie
@@ -10,5 +11,4 @@ env QUIET=y setup-util-httpie
 # tunnel="$(fetch localhost:4040/api/tunnels | jq -r .tunnels[0].public_url)"
 # tunnel="$(get-url-hostname "$tunnel")"
 
-tunnel="coolflower3649.cotunnel.com"
-http --verbose --check-status "$DDNS_WORKER" Authorization:"${DDNS_WORKER_AUTH-}" content="$tunnel"
+http --verbose --check-status "${DDNS_WORKER}" Authorization:"${DDNS_WORKER_AUTH-}" content="${DDNS_URL}"

commands/debug-docker

@@ -84,5 +84,5 @@ sudo service docker restart
 
 dnsip="$(what-is-my-exposed-dns)"
 set -x
-sudo docker run --rm --cap-add=NET_ADMIN --net=bridge --dns="$dnsip" alpine sh -c "apk add curl bind-tools; $(cat "$DOROTHY/commands/debug-network")"
+sudo docker run --rm --cap-add=NET_ADMIN --net=bridge --dns="$dnsip" alpine sh -c "$(cat "$DOROTHY/commands/debug-network")"
 set +x