xdg-unused-data.sh

#!/usr/bin/env bash

# bash strict mode
# http://redsymbol.net/articles/unofficial-bash-strict-mode/
set -euo pipefail
IFS=$'\n\t'

main() {
    # shellcheck disable=SC2016
    local JQ_SELECTOR='.name as $name | .executables as $exes | .locations[] | "\($name),\($exes|join("|")),\(.file)"'

    while IFS="," read -r APP_NAME APP_EXECUTABLE FILE_PATH; do
        check_application "$APP_NAME" "$APP_EXECUTABLE" "$FILE_PATH"
    done <<<"$(jq -r "$JQ_SELECTOR" "$JSON_DIRECTORY"/*.json)"

    ([ -n "$APP_OUTPUT" ] && print_info_output ) || ($OPTION_RAW || printf "No files found\n")
}

check_application() {
    local APP_NAME="$1"
    local APP_EXECUTABLE="$2"
    local FILE_PATH="$3"
    local OBJECT_SIZE=0

    FILE_PATH=$(echo "$FILE_PATH" | envsubst)

    # Skip if executable and file or folder doesn't exists
    (! check_command_available "$APP_EXECUTABLE" && { [ -f "$FILE_PATH" ] || [ -d "$FILE_PATH" ]; }) || return 0

    OBJECT_SIZE=$(\du -0 -b -s "$FILE_PATH" 2>/dev/null | \cut -f1)

    if $OPTION_RAW; then
        printf -v APP_OUTPUT_LOC "%s\n" "$FILE_PATH"
    else
        printf -v APP_OUTPUT_LOC "[$COLOR_GREEN%s$COLOR_RESET]: %s ($COLOR_BLUE%s$COLOR_RESET)\n" \
                                 "$APP_NAME" "$FILE_PATH" "$(bytes_to_human_readable "$OBJECT_SIZE")"
    fi

    if [[ "$APP_OUTPUT" != *"$APP_OUTPUT_LOC"* ]]; then
        TOTAL_FILE_SIZE=$((TOTAL_FILE_SIZE + OBJECT_SIZE))
        TOTAL_FILE_COUNT=$((TOTAL_FILE_COUNT + 1))

        APP_OUTPUT="$APP_OUTPUT""$APP_OUTPUT_LOC"
    fi
}

print_info_output() {
    printf "%b" "$APP_OUTPUT"

    if ! $OPTION_RAW; then
        printf "\n%s:\n" "Summary"
        printf " Total files: %s\n" "$TOTAL_FILE_COUNT"
        printf " Total size: %s\n" "$(bytes_to_human_readable "$TOTAL_FILE_SIZE")"
    fi
}

requirement_check() {
    check_command_available "jq" || {
        printf "$COLOR_RED%b$COLOR_RESET" "jq is required. Please install https://github.com/jqlang/jq\n"
        exit 1
    }

    # Check if XDG_* env variables are undefined and define fallback
    [ -z "${XDG_DATA_HOME+x}" ] && XDG_DATA_HOME=$HOME"/.local/share"
    [ -z "${XDG_CONFIG_HOME+x}" ] && XDG_CONFIG_HOME=$HOME"/.config"
    [ -z "${XDG_STATE_HOME+x}" ] && XDG_STATE_HOME=$HOME"/.local/state"
    [ -z "${XDG_CACHE_HOME+x}" ] && XDG_CACHE_HOME=$HOME"/.cache"

    return 0
}

manage_flags() {
    if [ "$1" = "--raw" ]; then
        OPTION_RAW=true
    elif [ -n "$1" ]; then
        print_help
        exit
    fi
}

print_help() {
    HELP_OUTPUT=$(
        cat <<END
A simple way to identify and remove unused data from applications stored in user directories

USAGE:
    $SCRIPT_NAME [argument]

ARGUMENTS:
    -h, --help    Print this help message
    --raw         Outputs only pathes of files
END
    )
    printf "%b\n" "$HELP_OUTPUT"
}

check_command_available() {
    local COMMANDS="$1"
    local COMMAND_CHECK=1

    IFS='|' read -ra COMMANDS <<<"$COMMANDS"

    for COMMAND in "${COMMANDS[@]}"; do
        command -v "$COMMAND" >/dev/null 2>&1 && COMMAND_CHECK=0
    done

    return $COMMAND_CHECK
}

# https://unix.stackexchange.com/a/259254
bytes_to_human_readable() {
    local i=${1:-0} d="" s=0 S=("B" "kB" "MB" "GB" "TB")
    while ((i > 1024 && s < ${#S[@]} - 1)); do
        printf -v d ".%02d" $((i % 1024 * 100 / 1024))
        i=$((i / 1024))
        s=$((s + 1))
    done

    echo "$i$d ${S[$s]}"
}

set_global_variables() {
    JSON_DIRECTORY=$(realpath "$0" | xargs dirname)"/applications"
    SCRIPT_NAME="$0"
    APP_OUTPUT=""
    TOTAL_FILE_SIZE=0
    TOTAL_FILE_COUNT=0
    [ -t 1 ] && OPTION_RAW=false || OPTION_RAW=true

    COLOR_RESET="\033[0m"
    COLOR_RED="\033[31m"
    COLOR_GREEN="\033[32m"
    COLOR_BLUE="\033[34m"
}

set_global_variables
requirement_check
[ $# -ne 0 ] && manage_flags "$@"
main