#!/usr/bin/env sh 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 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="""\ ${FG_WHITE}${BG_MAGENTA}${FX_BOLD}xdg-ninja${FX_RESET} ${FX_BOLD}${FX_ITALIC}Check your \$HOME for unwanted files.${FX_RESET} ──────────────────────────────────── ${FX_ITALIC}--help${FX_RESET} ${FX_BOLD}This help menu${FX_RESET} ${FX_ITALIC}-h${FX_RESET} ${FX_ITALIC}--no-skip-ok${FX_RESET} ${FX_BOLD}Display messages for all files checked (verbose)${FX_RESET} ${FX_ITALIC}-v${FX_RESET} ${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 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 '%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 '%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 '%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 '%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 '%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.\n" exit fi printf "\n" # Function to expand environment variables in string # https://stackoverflow.com/a/20316582/11110290 apply_shell_expansion() { data="$1" delimiter="__apply_shell_expansion_delimiter__" command=$(printf "cat <<%s\n%s\n%s" "$delimiter" "$data" "$delimiter") eval "$command" } # Function to check if a string contains shell pattern matching has_pattern() { case $1 in *\** | *\?* | *\[*\]*) return 0 ;; *) return 1 ;; 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 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" NAME="$2" FILENAME="$3" HELP="$4" case "$MODE" in ERR) 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) [ "$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 '[%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 '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_GREEN}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}" ;; HELP) decode_string "$HELP" | PAGER="cat" $DECODER ;; esac } # Checks that the given file does not exist, otherwise outputs help check_file() { NAME="$1" FILENAME="$2" MOVABLE="$3" HELP="$4" file=$(retrieve_existing_filename "$FILENAME") if [ "$file" ]; then if [ "$MOVABLE" = true ]; then log ERR "$NAME" "$file" "$HELP" else log WARN "$NAME" "$file" "$HELP" fi if [ "$HELP" ]; then if [ "$MOVABLE" = true ] || [ "$SKIP_UNSUPPORTED" = false ]; then log HELP "$NAME" "$file" "$HELP" fi else log HELP "$NAME" "$file" "_No help available._" fi else log SUCS "$NAME" "$file" "$HELP" fi } # 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 <