X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/blobdiff_plain/64cb164507e7e0e24093d56b9a7782699a583e5e..45732bfcb6f62c92861f6549faa5006fd1e06266:/xdg-ninja.sh diff --git a/xdg-ninja.sh b/xdg-ninja.sh index 7b68acf..7a0b29e 100755 --- a/xdg-ninja.sh +++ b/xdg-ninja.sh @@ -1,78 +1,114 @@ #!/usr/bin/env sh -# shellcheck disable=SC2016 - -USE_GLOW=false -USE_BAT=false -if command -v glow >/dev/null 2>/dev/null; then - USE_GLOW=true -elif command -v bat >/dev/null 2>/dev/null; then - USE_BAT=true - printf "Glow not found, markdown rendering will be done by bat.\n" - printf "Install glow for easier reading & copy-paste.\n" -else - printf "Glow or bat not found, markdown rendering not available.\n" - printf "Output will be raw markdown and might look weird.\n" - printf "Install glow for easier reading & copy-paste.\n" -fi + +has_command() { + command -v "$1" >/dev/null 2>/dev/null + return $? +} + +auto_set_decoder() { + DECODER="cat" + if has_command glow; then + DECODER="glow -" + elif has_command batcat; then + DECODER="batcat -pp --decorations=always --color=always --language markdown" + printf "Markdown rendering will be done by bat. (Glow is recommended)\n" + elif has_command bat; then + DECODER="bat -pp --decorations=always --color=always --language markdown" + printf "Markdown rendering will be done by bat. (Glow is recommended)\n" + elif has_command pygmentize; then + DECODER="pygmentize -l markdown" + printf "Markdown rendering will be done by pygmentize. (Glow is recommended)\n" + elif has_command highlight; then + DECODER="highlight --out-format ansi --syntax markdown" + printf "Markdown rendering will be done by highlight. (Glow is recommended)\n" + else + printf "Install glow for easier reading & copy-paste.\n" + fi +} +auto_set_decoder unalias -a -HELPSTRING="""\ +init_constants() { + FX_RESET="\033[0m" + FX_BOLD="\033[1m" + FX_ITALIC="\033[3m" + + FG_RED="\033[31m" + FG_GREEN="\033[32m" + FG_YELLOW="\033[33m" + FG_CYAN="\033[36m" + FG_WHITE="\033[37m" + + BG_MAGENTA="\033[45m" +} +init_constants + +help() { + init_constants + HELPSTRING="""\ - \033[37;45;1mxdg-ninja\033[0m + ${FG_WHITE}${BG_MAGENTA}${FX_BOLD}xdg-ninja${FX_RESET} - \033[1;3mCheck your \$HOME for unwanted files.\033[1;0m + ${FX_BOLD}${FX_ITALIC}Check your \$HOME for unwanted files.${FX_RESET} ──────────────────────────────────── - \033[3m--help\033[0m \033[1mThis help menu\033[0m - \033[3m-h\033[0m + ${FX_ITALIC}--help${FX_RESET} ${FX_BOLD}This help menu${FX_RESET} + ${FX_ITALIC}-h\033${FX_RESET} - \033[3m--no-skip-ok\033[0m \033[1mDisplay messages for all files checked (verbose)\033[0m - \033[3m-v\033[0m + ${FX_ITALIC}--no-skip-ok${FX_RESET} ${FX_BOLD}Display messages for all files checked (verbose)${FX_RESET} + ${FX_ITALIC}-v${FX_RESET} - \033[3m--skip-ok\033[0m \033[1mDon't display anything for files that do not exist (default)\033[0m + ${FX_ITALIC}--skip-ok${FX_RESET} ${FX_BOLD}Don't display anything for files that do not exist (default)${FX_RESET} -""" + ${FX_ITALIC}--skip-unsupported${FX_RESET} ${FX_BOLD}Don't display anything for files that do not have fixes available${FX_RESET} + + """ + printf "%b\n" "$HELPSTRING" +} SKIP_OK=true +SKIP_UNSUPPORTED=false for i in "$@"; do if [ "$i" = "--help" ] || [ "$i" = "-h" ]; then - printf "%b" "$HELPSTRING" + help exit elif [ "$i" = "--skip-ok" ]; then SKIP_OK=true elif [ "$i" = "--no-skip-ok" ]; then SKIP_OK=false + elif [ "$i" = "--skip-unsupported" ]; then + SKIP_UNSUPPORTED=true elif [ "$i" = "-v" ]; then SKIP_OK=false fi done if [ -z "${XDG_DATA_HOME}" ]; then - printf '\033[1;36m%s\033[1;0m\n' "The \$XDG_DATA_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" - printf '\033[1;36m ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.local/share\033[1;0m\n' + printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_DATA_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}" + printf "%b ⤷ The recommended value is: %b\$HOME/.local/share%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}" fi if [ -z "${XDG_CONFIG_HOME}" ]; then - printf '\033[1;36m%s\033[1;0m\n' "The \$XDG_CONFIG_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" - printf '\033[1;36m ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.config\033[1;0m\n' + printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_CONFIG_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}" + printf "%b ⤷ The recommended value is: %b\$HOME/.config%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}" fi if [ -z "${XDG_STATE_HOME}" ]; then - printf '\033[1;36m%s\033[1;0m\n' "The \$XDG_STATE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" - printf '\033[1;36m ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.local/state\033[1;0m\n' + printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_STATE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}" + printf "%b ⤷ The recommended value is: %b\$HOME/.local/state%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}" fi if [ -z "${XDG_CACHE_HOME}" ]; then - printf '\033[1;36m%s\033[1;0m\n' "The \$XDG_CACHE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" - printf '\033[1;36m ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.cache\033[1;0m\n' + printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_CACHE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}" + printf "%b ⤷ The recommended value is: %b\$HOME/.cache%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}" fi if [ -z "${XDG_RUNTIME_DIR}" ]; then - printf '\033[1;36m%s\033[1;0m\n' "The \$XDG_RUNTIME_DIR environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" - printf '\033[1;36m ⤷ \033[1mThe recommended value is: \033[1;3m/run/user/$UID\033[1;0m\n' + printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_RUNTIME_DIR environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}" + printf "%b ⤷ The recommended value is: %b/run/user/\$UID%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}" fi if ! command -v jq >/dev/null 2>/dev/null; then - printf "jq is needed to run this script, but it wasn't found. Please install it to be able to use this script." + printf "jq is needed to run this script, but it wasn't found. Please install it to be able to use this script.\n" exit fi @@ -87,19 +123,45 @@ apply_shell_expansion() { eval "$command" } -# Returns 0 if the path doesn't lead anywhere -# Return 1 if the path points to a file, 2 if it points to a directory -check_not_exists_file() { - FILE_PATH=$(apply_shell_expansion "$1") - if [ -f "$FILE_PATH" ]; then +# Function to check if a string contains shell pattern matching +has_pattern() { + case $1 in + *\** | *\?* | *\[*\]*) + return 0 + ;; + *) return 1 - elif [ -d "$FILE_PATH" ]; then - return 2 + ;; + esac +} + +# Returns the actual name of the given file that is on the user's disk +# This command applies shell pattern matching and return the actual filename +retrieve_existing_filename() { + FILE_PATH=$(apply_shell_expansion "$1") + + # return filename if found, nothing else + if has_pattern "$FILE_PATH"; then + dir="$(dirname "$FILE_PATH")" + part="$(basename "$FILE_PATH")" + find "$dir" -maxdepth 1 -name "$part" -print -quit 2>/dev/null else - return 0 + if [ -e "$FILE_PATH" ]; then + printf "%s" "$FILE_PATH" + fi fi } +decode_string() { + printf "%s" "$1" | sed -e 's/\\n/\ +/g' -e 's/\\\"/\"/g' -e '$ s/\n*$/\ +\ +/' # Replace \n with literal newline and \" with ", normalize number of trailing newlines to 2 +} + +# Counter to keep track of how many files can be moved +FIXABLE=0 + # Function to handle the formatting of output log() { MODE="$1" @@ -110,30 +172,26 @@ log() { case "$MODE" in ERR) - printf '[\033[1;31m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME" + printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_RED}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}" + FIXABLE=$((FIXABLE+1)) ;; WARN) - printf '[\033[1;33m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME" + [ "$SKIP_UNSUPPORTED" = false ] && + printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_YELLOW}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}" ;; INFO) - printf '[\033[1;36m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME" + printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_CYAN}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}" ;; SUCS) [ "$SKIP_OK" = false ] && - printf '[\033[1;32m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME" + printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_GREEN}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}" ;; HELP) - if $USE_GLOW; then - printf "%s\n" "$HELP" | glow - - elif $USE_BAT; then - printf "%s\n" "$HELP" | bat -pp -f --language markdown - else - printf "%s\n" "$HELP" - fi + decode_string "$HELP" | PAGER="cat" $DECODER ;; esac @@ -141,61 +199,58 @@ log() { # Checks that the given file does not exist, otherwise outputs help check_file() { - INPUT="$1" - NAME="$2" - - FILENAME=$(printf "%s" "$INPUT" | jq -r .path) - MOVABLE=$(printf "%s" "$INPUT" | jq -r .movable) - HELP=$(printf "%s" "$INPUT" | jq -r .help) - - check_not_exists_file "$FILENAME" + NAME="$1" + FILENAME="$2" + MOVABLE="$3" + HELP="$4" - case $? in + file=$(retrieve_existing_filename "$FILENAME") - 0) - log SUCS "$NAME" "$FILENAME" "$HELP" - ;; - - 1 | 2) - if "$MOVABLE"; then - log ERR "$NAME" "$FILENAME" "$HELP" + if [ "$file" ]; then + if [ "$MOVABLE" = true ]; then + log ERR "$NAME" "$file" "$HELP" else - log WARN "$NAME" "$FILENAME" "$HELP" + log WARN "$NAME" "$file" "$HELP" fi if [ "$HELP" ]; then - log HELP "$NAME" "$FILENAME" "$HELP" + if [ "$MOVABLE" = true ] || [ "$SKIP_UNSUPPORTED" = false ]; then + log HELP "$NAME" "$file" "$HELP" + fi else - log HELP "$NAME" "$FILENAME" "_No help available._" + log HELP "$NAME" "$file" "_No help available._" fi - ;; - - esac + else + log SUCS "$NAME" "$file" "$HELP" + fi } -# Reads a file from programs/, calls check_file on each file specified for the program -check_program() { - PROGRAM=$1 - - NAME=$(jq -r .name "$PROGRAM") - - while IFS= read -r file; do - check_file "$file" "$NAME" +# Reads files from programs/, calls check_file on each file specified for each program +do_check_programs() { + while IFS=" +" read -r name; read -r filename; read -r movable; read -r help; do + check_file "$name" "$filename" "$movable" "$help" done <