├── images ├── msm.png ├── logo.pdf ├── logo.png ├── video.png ├── language.jpg ├── screenshot_main.png └── screenshot_sudo_find.png ├── sounds └── switch.wav ├── delete_history.sh ├── sound.sh ├── sudo_utils.sh ├── .github └── workflows │ └── ci.yml ├── config.sh ├── size_calculations.sh ├── logging.sh ├── menu.sh ├── main.sh ├── README.md ├── deletion.sh └── LICENSE /images/msm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/msm.png -------------------------------------------------------------------------------- /images/logo.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/logo.pdf -------------------------------------------------------------------------------- /images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/logo.png -------------------------------------------------------------------------------- /images/video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/video.png -------------------------------------------------------------------------------- /sounds/switch.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/sounds/switch.wav -------------------------------------------------------------------------------- /images/language.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/language.jpg -------------------------------------------------------------------------------- /images/screenshot_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/screenshot_main.png -------------------------------------------------------------------------------- /images/screenshot_sudo_find.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NarekMosisian/mac-storage-manager/HEAD/images/screenshot_sudo_find.png -------------------------------------------------------------------------------- /delete_history.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | 5 | # ------------------------------------------------------------------------------------------------------ 6 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 7 | # 8 | # This script was created by Narek Mosisian. For more information, visit: 9 | # https://github.com/NarekMosisian/mac-storage-manager 10 | # © 2024 Narek Mosisian. All rights reserved. 11 | # 12 | # This script is licensed under the AGPL-3.0 license. 13 | # ------------------------------------------------------------------------------------------------------ 14 | # NOTICE: 15 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 16 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 17 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 18 | # This requirement is mandated by the terms of the AGPL-3.0 license. 19 | # ------------------------------------------------------------------------------------------------------ 20 | 21 | show_delete_history() { 22 | local tmpfile 23 | tmpfile=$(mktemp) 24 | if ! grep -F "Deleted application" "$LOG_FILE" | tac > "$tmpfile"; then 25 | echo "$(get_text delete_history_not_found)" > "$tmpfile" 26 | fi 27 | 28 | whiptail --title "$(get_text delete_history_title) ($(get_text delete_history_only_by_this_script))" \ 29 | --textbox "$tmpfile" 20 78 \ 30 | --ok-button "$(get_ok_button)" 31 | rm -f "$tmpfile" 32 | 33 | main_menu 34 | } -------------------------------------------------------------------------------- /sound.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # ------------------------------------------------------------------------------------------------------ 4 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 5 | # 6 | # This script was created by Narek Mosisian. For more information, visit: 7 | # https://github.com/NarekMosisian/mac-storage-manager 8 | # © 2024 Narek Mosisian. All rights reserved. 9 | # 10 | # This script is licensed under the AGPL-3.0 license. 11 | # ------------------------------------------------------------------------------------------------------ 12 | # NOTICE: 13 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 14 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 15 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 16 | # This requirement is mandated by the terms of the AGPL-3.0 license. 17 | # ------------------------------------------------------------------------------------------------------ 18 | 19 | play_key_sound() { 20 | if [ "$SOUND_ENABLED" = "on" ]; then 21 | if [ -f "$SOUND_PATH/switch.wav" ]; then 22 | $SOUND_PLAYER "$SOUND_PATH/switch.wav" & 23 | else 24 | log_message "Sound file not found: $SOUND_PATH/switch.wav" 25 | fi 26 | fi 27 | } 28 | 29 | toggle_sound() { 30 | if [ "$SOUND_ENABLED" = "on" ]; then 31 | btn_label="$(get_text sound_off_button)" 32 | else 33 | btn_label="$(get_text sound_on_button)" 34 | fi 35 | 36 | whiptail --title "$(get_text sound_title)" \ 37 | --msgbox "$(printf "$(get_text sound_status_message)" "$SOUND_ENABLED")" 8 60 \ 38 | --ok-button "$btn_label" 39 | 40 | if [ "$SOUND_ENABLED" = "on" ]; then 41 | SOUND_ENABLED="off" 42 | else 43 | SOUND_ENABLED="on" 44 | fi 45 | save_sound_setting 46 | 47 | play_key_sound 48 | 49 | main_menu 50 | } 51 | 52 | -------------------------------------------------------------------------------- /sudo_utils.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | 5 | # ------------------------------------------------------------------------------------------------------ 6 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 7 | # 8 | # This script was created by Narek Mosisian. For more information, visit: 9 | # https://github.com/NarekMosisian/mac-storage-manager 10 | # © 2024 Narek Mosisian. All rights reserved. 11 | # 12 | # This script is licensed under the AGPL-3.0 license. 13 | # ------------------------------------------------------------------------------------------------------ 14 | # NOTICE: 15 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 16 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 17 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 18 | # This requirement is mandated by the terms of the AGPL-3.0 license. 19 | # ------------------------------------------------------------------------------------------------------ 20 | 21 | ensure_sudo_valid() { 22 | local attempts=0 23 | local password 24 | while true; do 25 | if ! password=$(whiptail --passwordbox "$(get_text please_enter_your_sudo_password)" 8 60 3>&1 1>&2 2>&3); then 26 | log_message "Sudo password dialog canceled." 27 | main_menu 28 | return 1 29 | fi 30 | if [ -z "$password" ]; then 31 | display_error "$(get_text critical_error_sudo_failed_associated)" 32 | main_menu 33 | return 1 34 | fi 35 | 36 | if echo "$password" | sudo -S -v >/dev/null 2>&1; then 37 | unset password 38 | return 0 39 | fi 40 | 41 | attempts=$((attempts + 1)) 42 | display_error "$(printf "$(get_text invalid_sudo_password_attempts)" "$attempts")" 43 | 44 | if [ $attempts -ge 3 ]; then 45 | display_error "$(get_text failed_obtain_sudo_after_3_exiting)" 46 | main_menu 47 | return 1 48 | fi 49 | done 50 | } 51 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Continuous Integration 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | branches: 9 | - main 10 | 11 | jobs: 12 | macos: 13 | runs-on: macos-latest 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v3 17 | 18 | - name: Add your external Tap 19 | run: brew tap NarekMosisian/mac-storage-manager 20 | 21 | - name: Update Homebrew 22 | run: brew update || true 23 | 24 | - name: Install formula from your Tap 25 | run: brew install --build-from-source mac-storage-manager 26 | 27 | - name: Run tests 28 | run: | 29 | brew test mac-storage-manager 30 | brew audit --strict mac-storage-manager 31 | 32 | linux: 33 | runs-on: ubuntu-latest 34 | steps: 35 | - name: Checkout repository 36 | uses: actions/checkout@v3 37 | 38 | - name: Install Homebrew on Linux 39 | run: | 40 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 41 | echo 'eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"' >> $HOME/.profile 42 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 43 | 44 | - name: Install zsh 45 | run: | 46 | sudo apt-get update 47 | sudo apt-get install -y zsh 48 | 49 | - name: Add your external Tap 50 | run: | 51 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 52 | brew tap NarekMosisian/mac-storage-manager 53 | 54 | - name: Update Homebrew and run doctor 55 | run: | 56 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 57 | brew update || true 58 | brew doctor || true 59 | 60 | - name: Install dependencies 61 | run: | 62 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 63 | brew install jq newt 64 | 65 | - name: Uninstall previous version (if any) 66 | run: | 67 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 68 | brew uninstall mac-storage-manager || true 69 | 70 | - name: Build and install formula from your Tap 71 | run: | 72 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 73 | brew install --build-from-source narekmosisian/mac-storage-manager/mac-storage-manager 74 | 75 | - name: Run tests 76 | run: | 77 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" 78 | brew test narekmosisian/mac-storage-manager/mac-storage-manager 79 | brew audit --strict narekmosisian/mac-storage-manager/mac-storage-manager 80 | -------------------------------------------------------------------------------- /config.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | 5 | # ------------------------------------------------------------------------------------------------------ 6 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 7 | # 8 | # This script was created by Narek Mosisian. For more information, visit: 9 | # https://github.com/NarekMosisian/mac-storage-manager 10 | # © 2024 Narek Mosisian. All rights reserved. 11 | # 12 | # This script is licensed under the AGPL-3.0 license. 13 | # ------------------------------------------------------------------------------------------------------ 14 | # NOTICE: 15 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 16 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 17 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 18 | # This requirement is mandated by the terms of the AGPL-3.0 license. 19 | # ------------------------------------------------------------------------------------------------------ 20 | 21 | export LANG=en_US.UTF-8 22 | export LC_ALL=en_US.UTF-8 23 | export NCURSES_NO_UTF8_ACS=1 24 | 25 | # XDG Base Directories (available on both macOS and Linux) 26 | XDG_DATA="${XDG_DATA_HOME:-"$HOME/.local/share"}" 27 | XDG_CONFIG="${XDG_CONFIG_HOME:-"$HOME/.config"}" 28 | XDG_CACHE="${XDG_CACHE_HOME:-"$HOME/.cache"}" 29 | 30 | FIND_METHOD_FILE="find_method.conf" 31 | 32 | LANG_CONF_FILE="language.conf" 33 | CURRENT_LANG="English" 34 | 35 | LOG_FILE="mac_storage_manager.log" 36 | if [ ! -f "$LOG_FILE" ]; then 37 | touch "$LOG_FILE" 38 | fi 39 | echo "Script started at $(date)" >> "$LOG_FILE" 40 | 41 | OS_TYPE=$(uname) 42 | if [ "$OS_TYPE" != "Darwin" ] && [ "$OS_TYPE" != "Linux" ]; then 43 | echo "This script currently only supports macOS and Linux." >&2 44 | exit 1 45 | fi 46 | 47 | APP_DIRS=() 48 | if [ "$OS_TYPE" = "Darwin" ]; then 49 | APP_DIRS+=( "/Applications" "$HOME/Applications" ) 50 | else 51 | APP_DIRS+=( "/usr/share/applications" "$HOME/.local/share/applications" ) 52 | fi 53 | 54 | if [ "$OS_TYPE" = "Darwin" ]; then 55 | extension="app" 56 | else 57 | extension="desktop" 58 | fi 59 | 60 | [ -n "${CUSTOM_APP_DIR:-}" ] && APP_DIRS+=( "${CUSTOM_APP_DIR}" ) 61 | 62 | SOUND_PATH="./sounds" 63 | if [ -n "${MAC_STORAGE_MANAGER_SHARE:-}" ]; then 64 | SOUND_PATH="${MAC_STORAGE_MANAGER_SHARE}/sounds" 65 | fi 66 | 67 | load_language() { 68 | if [ -f "$LANG_CONF_FILE" ]; then 69 | CURRENT_LANG=$(<"$LANG_CONF_FILE") 70 | else 71 | CURRENT_LANG="English" 72 | echo "$CURRENT_LANG" > "$LANG_CONF_FILE" 73 | fi 74 | } 75 | 76 | if [ -f "sound.conf" ]; then 77 | SOUND_ENABLED=$( sound.conf 81 | fi 82 | 83 | save_sound_setting() { 84 | echo "$SOUND_ENABLED" > "sound.conf" 85 | } 86 | 87 | load_language 88 | 89 | save_language() { 90 | echo "$CURRENT_LANG" > "$LANG_CONF_FILE" 91 | } 92 | 93 | cleanup() { 94 | log_message "Cleaning up temporary files..." 95 | rm -f brew_formula_sizes.txt brew_cask_sizes.txt applications_sizes.txt home_applications_sizes.txt sudo_find_results.txt 96 | } 97 | -------------------------------------------------------------------------------- /size_calculations.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # ------------------------------------------------------------------------------------------------------ 4 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 5 | # 6 | # This script was created by Narek Mosisian. For more information, visit: 7 | # https://github.com/NarekMosisian/mac-storage-manager 8 | # © 2024 Narek Mosisian. All rights reserved. 9 | # 10 | # This script is licensed under the AGPL-3.0 license. 11 | # ------------------------------------------------------------------------------------------------------ 12 | # NOTICE: 13 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 14 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 15 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 16 | # This requirement is mandated by the terms of the AGPL-3.0 license. 17 | # ------------------------------------------------------------------------------------------------------ 18 | 19 | parse_size() { 20 | local raw="$1" 21 | if [[ -z "$raw" ]]; then 22 | echo 0 23 | return 24 | fi 25 | raw="$(echo "$raw" | tr '[:upper:]' '[:lower:]')" 26 | if [[ "$raw" =~ ^[0-9]+$ ]]; then 27 | echo "$raw" 28 | return 29 | fi 30 | if [[ "$raw" =~ ^([0-9]*\.?[0-9]+)([gmkb]+)$ ]]; then 31 | local num="${BASH_REMATCH[1]}" 32 | local unit="${BASH_REMATCH[2]}" 33 | case "$unit" in 34 | g) 35 | awk "BEGIN {printf \"%d\", $num * 1048576}" 36 | return 37 | ;; 38 | m) 39 | awk "BEGIN {printf \"%d\", $num * 1024}" 40 | return 41 | ;; 42 | k) 43 | awk "BEGIN {printf \"%d\", $num}" 44 | return 45 | ;; 46 | b) 47 | awk "BEGIN {printf \"%d\", $num / 1024}" 48 | return 49 | ;; 50 | esac 51 | fi 52 | echo 0 53 | } 54 | 55 | format_size() { 56 | local size_in_kb="$1" 57 | if (( size_in_kb >= 1048576 )); then 58 | awk "BEGIN {printf \"%.2fG\", $size_in_kb / 1048576}" 59 | elif (( size_in_kb >= 1024 )); then 60 | awk "BEGIN {printf \"%.2fM\", $size_in_kb / 1024}" 61 | elif (( size_in_kb > 0 )); then 62 | echo "${size_in_kb}K" 63 | else 64 | echo "0B" 65 | fi 66 | } 67 | 68 | calculate_actual_size() { 69 | local app_name="$1" 70 | local app_path="" 71 | 72 | for dir in "${APP_DIRS[@]}"; do 73 | candidate=$(find "$dir" -maxdepth 1 -iname "$app_name" -print -quit 2>/dev/null) 74 | if [ -n "$candidate" ]; then 75 | app_path="$candidate" 76 | break 77 | fi 78 | done 79 | 80 | if [ -n "$app_path" ]; then 81 | du -sk "$app_path" 2>/dev/null | cut -f1 82 | else 83 | echo 0 84 | fi 85 | } 86 | 87 | calculate_size() { 88 | local app_path="$1" 89 | local size_in_kb 90 | size_in_kb=$(du -sk "$app_path" 2>/dev/null | cut -f1) 91 | if [ -n "$size_in_kb" ]; then 92 | echo "$size_in_kb" 93 | else 94 | echo 0 95 | fi 96 | } 97 | 98 | calculate_brew_formula_size() { 99 | if command -v brew &>/dev/null; then 100 | local formula_path 101 | formula_path=$(brew --cellar "$1" 2>/dev/null) 102 | if [ -d "$formula_path" ]; then 103 | calculate_size "$formula_path" 104 | else 105 | echo 0 106 | fi 107 | else 108 | echo 0 109 | fi 110 | } 111 | 112 | calculate_brew_cask_size() { 113 | if command -v brew &>/dev/null; then 114 | local cask_name="$1" 115 | local brew_prefix 116 | local caskroom_path 117 | brew_prefix=$(brew --prefix) 118 | caskroom_path="$brew_prefix/Caskroom/$cask_name" 119 | if [ -d "$caskroom_path" ]; then 120 | local size 121 | size=$(du -sk "$caskroom_path" 2>/dev/null | cut -f1) 122 | if [ -n "$size" ] && [ "$size" -gt 0 ]; then 123 | echo "$size" 124 | else 125 | echo 0 126 | fi 127 | else 128 | echo 0 129 | fi 130 | else 131 | echo 0 132 | fi 133 | } -------------------------------------------------------------------------------- /logging.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # ------------------------------------------------------------------------------------------------------ 4 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 5 | # 6 | # This script was created by Narek Mosisian. For more information, visit: 7 | # https://github.com/NarekMosisian/mac-storage-manager 8 | # © 2024 Narek Mosisian. All rights reserved. 9 | # 10 | # This script is licensed under the AGPL-3.0 license. 11 | # ------------------------------------------------------------------------------------------------------ 12 | # NOTICE: 13 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 14 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 15 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 16 | # This requirement is mandated by the terms of the AGPL-3.0 license. 17 | # ------------------------------------------------------------------------------------------------------ 18 | 19 | log_message() { 20 | echo "$1" >> "$LOG_FILE" 21 | } 22 | 23 | log_start() { 24 | log_message "Script started at $(date)" 25 | } 26 | 27 | log_end() { 28 | log_message "Script ended at $(date)" 29 | } 30 | 31 | update_progress() { 32 | local percent="$1" 33 | local message="$2" 34 | echo -e "$percent\n# $message" >&3 35 | sleep 0.5 36 | } 37 | 38 | reconstruct_log_entries() { 39 | local infile="$LOG_FILE" 40 | local outfile="fixed_${LOG_FILE}" 41 | 42 | if [ "$OS_TYPE" = "Darwin" ]; then 43 | if command -v gawk >/dev/null 2>&1; then 44 | gawk ' 45 | BEGIN { prev = "" } 46 | { 47 | if (match($0, /^(.*)[[:space:]]+size:[[:space:]]+(.*)$/, arr)) { 48 | name = arr[1] 49 | size = arr[2] 50 | if (size == "0B") { 51 | if (prev == "") 52 | prev = name 53 | else 54 | prev = prev " " name 55 | next 56 | } else { 57 | if (prev != "" && name ~ /\.app$/) { 58 | print prev " " name " size: " size 59 | prev = "" 60 | } else { 61 | if (prev != "") { 62 | print prev " size: 0B" 63 | prev = "" 64 | } 65 | print $0 66 | } 67 | } 68 | } else { 69 | if (prev != "") { 70 | print prev " size: 0B" 71 | prev = "" 72 | } 73 | print $0 74 | } 75 | } 76 | END { 77 | if (prev != "") 78 | print prev " size: 0B" 79 | } 80 | ' "$infile" > "$outfile" 81 | else 82 | awk ' 83 | BEGIN { prev = "" } 84 | { 85 | if (match($0, /^(.*)[[:space:]]+size:[[:space:]]+(.*)$/, arr)) { 86 | name = arr[1] 87 | size = arr[2] 88 | if (size == "0B") { 89 | if (prev == "") 90 | prev = name 91 | else 92 | prev = prev " " name 93 | next 94 | } else { 95 | if (prev != "" && name ~ /\.app$/) { 96 | print prev " " name " size: " size 97 | prev = "" 98 | } else { 99 | if (prev != "") { 100 | print prev " size: 0B" 101 | prev = "" 102 | } 103 | print $0 104 | } 105 | } 106 | } else { 107 | if (prev != "") { 108 | print prev " size: 0B" 109 | prev = "" 110 | } 111 | print $0 112 | } 113 | } 114 | END { 115 | if (prev != "") 116 | print prev " size: 0B" 117 | } 118 | ' "$infile" > "$outfile" 119 | fi 120 | elif [ "$OS_TYPE" = "Linux" ]; then 121 | awk ' 122 | BEGIN { prev = "" } 123 | { 124 | if (match($0, /^(.*)[[:space:]]+size:[[:space:]]+(.*)$/, arr)) { 125 | name = arr[1] 126 | size = arr[2] 127 | if (size == "0B") { 128 | if (prev == "") 129 | prev = name 130 | else 131 | prev = prev " " name 132 | next 133 | } else { 134 | if (prev != "" && name ~ /\.app$/) { 135 | print prev " " name " size: " size 136 | prev = "" 137 | } else { 138 | if (prev != "") { 139 | print prev " size: 0B" 140 | prev = "" 141 | } 142 | print $0 143 | } 144 | } 145 | } else { 146 | if (prev != "") { 147 | print prev " size: 0B" 148 | prev = "" 149 | } 150 | print $0 151 | } 152 | } 153 | END { 154 | if (prev != "") 155 | print prev " size: 0B" 156 | } 157 | ' "$infile" > "$outfile" 158 | fi 159 | 160 | mv "$outfile" "$infile" 161 | } 162 | -------------------------------------------------------------------------------- /menu.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | 5 | # ------------------------------------------------------------------------------------------------------ 6 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 7 | # 8 | # This script was created by Narek Mosisian. For more information, visit: 9 | # https://github.com/NarekMosisian/mac-storage-manager 10 | # © 2024 Narek Mosisian. All rights reserved. 11 | # 12 | # This script is licensed under the AGPL-3.0 license. 13 | # ------------------------------------------------------------------------------------------------------ 14 | # NOTICE: 15 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 16 | # the original author's name, "Narek Mosisian", is clearly indicated in all copies and 17 | # derivative works, and that all derivative works are licensed under AGPL-3.0. This requirement 18 | # is mandated by the license. 19 | # ------------------------------------------------------------------------------------------------------ 20 | 21 | calculate_actual_size() { 22 | local app_name="$1" 23 | for dir in "${APP_DIRS[@]}"; do 24 | local candidate 25 | candidate=$(find "$dir" -maxdepth 1 -iname "$app_name" -print -quit 2>/dev/null) 26 | if [ -n "$candidate" ]; then 27 | du -sk "$candidate" 2>/dev/null | cut -f1 28 | return 29 | fi 30 | done 31 | echo 0 32 | } 33 | 34 | format_and_sort_results() { 35 | local items=("$@") formatted=() 36 | for item in "${items[@]}"; do 37 | local name=${item%%:*} raw=${item#*:} 38 | [[ "$raw" =~ ^[0-9]+$ ]] || raw=0 39 | local pretty=$(format_size "$raw") 40 | if [[ ! "$pretty" =~ (B|K|M|G)$ ]]; then 41 | raw=$(calculate_actual_size "$name") 42 | pretty=$(format_size "$raw") 43 | fi 44 | formatted+=( "$name:$pretty:$raw" ) 45 | done 46 | printf "%s\n" "${formatted[@]}" | sort -t: -k3nr 47 | } 48 | 49 | combine_results() { 50 | local all=() file 51 | for file in brew_formula_sizes.txt brew_cask_sizes.txt applications_sizes.txt home_applications_sizes.txt sudo_find_results.txt; do 52 | [[ -f $file ]] || continue 53 | while read -r line; do all+=( "$line" ); done <"$file" 54 | done 55 | declare -A best_size best_name 56 | for entry in "${all[@]}"; do 57 | local name=${entry%%:*} size=${entry#*:} 58 | local num=$(parse_size "$size") 59 | [[ "$num" =~ ^[0-9]+$ ]] || num=0 60 | local key=$(echo "$name" | sed 's/\.app$//I; s/\.desktop$//I' | tr '[:upper:]' '[:lower:]') 61 | if [[ -z ${best_size[$key]:-} || $num -gt ${best_size[$key]} ]]; then 62 | best_size[$key]=$num 63 | best_name[$key]=$name 64 | fi 65 | done 66 | local pairs=() 67 | for k in "${!best_size[@]}"; do 68 | pairs+=( "${best_name[$k]}:${best_size[$k]}" ) 69 | done 70 | mapfile -t sorted_items < <(format_and_sort_results "${pairs[@]}") 71 | { 72 | echo "===== Combined & Deduplicated Results =====" 73 | for line in "${sorted_items[@]}"; do 74 | IFS=':' read -r app pretty _ <<<"$line" 75 | [[ $pretty =~ (B|K|M|G)$ ]] || pretty="0B" 76 | echo "$app size: $pretty" 77 | done 78 | } >>"$LOG_FILE" 79 | } 80 | 81 | interactive_app_selection() { 82 | local opts=() line app pretty 83 | for line in "${sorted_items[@]}"; do 84 | IFS=':' read -r app pretty _ <<<"$line" 85 | [[ $pretty =~ ^[0-9]+(\.[0-9]+)?[BKMGT]$ ]] || continue 86 | opts+=( "${app// /_}" "$pretty" OFF ) 87 | done 88 | 89 | if [ ${#opts[@]} -eq 0 ]; then 90 | whiptail --title "$(get_text no_applications_found)" \ 91 | --msgbox "$(get_text no_applications_found_for_selection)" 8 60 \ 92 | --ok-button "$(get_ok_button)" 93 | main_menu; return 94 | fi 95 | 96 | local sel 97 | if ! sel=$(whiptail --title "$(get_text select_apps_to_delete)" \ 98 | --checklist "$(get_text select_the_apps_to_delete)" 20 78 10 \ 99 | --ok-button "$(get_ok_button)" \ 100 | --cancel-button "$(get_cancel_button)" \ 101 | "${opts[@]}" 3>&1 1>&2 2>&3); then 102 | main_menu; return 103 | fi 104 | 105 | [[ -z $sel ]] && { main_menu; return; } 106 | 107 | confirm_deletion "$sel" 108 | } 109 | 110 | start_collection() { 111 | handle_sudo_find 112 | combine_results 113 | reconstruct_log_entries 114 | if [ ${#sorted_items[@]} -eq 0 ]; then 115 | whiptail --title "$(get_text no_applications_found)" \ 116 | --msgbox "$(get_text no_applications_found_for_selection)" 8 60 \ 117 | --ok-button "$(get_ok_button)" 118 | return 119 | fi 120 | interactive_app_selection 121 | } 122 | 123 | show_delete_history() { 124 | local tmp 125 | tmp=$(mktemp) 126 | { 127 | echo "$(get_text delete_history_warning)" 128 | grep '^Deleted application ' "$LOG_FILE" | sort -r 129 | } >"$tmp" 130 | whiptail --title "$(get_text delete_history_title)" --scrolltext "$(cat "$tmp")" 20 80 \ 131 | --ok-button "$(get_ok_button)" 132 | rm "$tmp" 133 | main_menu 134 | } 135 | 136 | main_menu() { 137 | local choice ret 138 | if choice=$(whiptail --title "$(get_text main_menu_title)" \ 139 | --menu "$(get_text main_menu_prompt)" 20 70 4 \ 140 | --ok-button "$(get_ok_button)" \ 141 | --cancel-button "$(get_text exit_button)" \ 142 | "°" "$(get_text menu_option_start)" \ 143 | "°°" "$(get_text menu_option_language)" \ 144 | "°°°" "$(get_text menu_option_sound)" \ 145 | "°°°°" "$(get_text menu_option_delete_history)" 3>&1 1>&2 2>&3); then 146 | ret=0 147 | else 148 | ret=$? 149 | fi 150 | 151 | case $ret in 152 | 0) 153 | case $choice in 154 | "°") start_collection ;; 155 | "°°") select_language ;; 156 | "°°°") toggle_sound ;; 157 | "°°°°") show_delete_history ;; 158 | esac 159 | ;; 160 | 1|255) 161 | trap - EXIT; cleanup; log_end 162 | whiptail --title "$(get_text about_title)" \ 163 | --msgbox "$(get_text about_message)" 15 70 \ 164 | --ok-button "$(get_ok_button)" 165 | exit 0 166 | ;; 167 | esac 168 | } -------------------------------------------------------------------------------- /main.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | 5 | # ------------------------------------------------------------------------------------------------------ 6 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 7 | # 8 | # This script was created by Narek Mosisian. For more information, visit: 9 | # https://github.com/NarekMosisian/mac-storage-manager 10 | # © 2024 Narek Mosisian. All rights reserved. 11 | # 12 | # This script is licensed under the AGPL-3.0 license. 13 | # ------------------------------------------------------------------------------------------------------ 14 | # NOTICE: 15 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 16 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 17 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 18 | # This requirement is mandated by the terms of the AGPL-3.0 license. 19 | # ------------------------------------------------------------------------------------------------------ 20 | 21 | source config.sh 22 | set +u 23 | source translations.sh 24 | set -u 25 | source logging.sh 26 | source sudo_utils.sh 27 | source size_calculations.sh 28 | source deletion.sh 29 | source menu.sh 30 | source delete_history.sh 31 | source sound.sh 32 | 33 | trap cleanup EXIT 34 | 35 | if [ "$OS_TYPE" = "Linux" ]; then 36 | SOUND_PLAYER="paplay" 37 | else 38 | SOUND_PLAYER="afplay" 39 | fi 40 | 41 | if [ -f "$SOUND_PATH/switch.wav" ]; then 42 | log_message "Sound check successful" 43 | else 44 | log_message "Sound check failed: switch.wav not found in $SOUND_PATH" 45 | fi 46 | 47 | if [ "${1:-}" = "--test-run" ]; then 48 | if [ "$OS_TYPE" = "Darwin" ]; then 49 | echo "Dummy.app" 50 | else 51 | echo "dummy.desktop" 52 | fi 53 | echo "DEBUG: SOUND_PATH=$SOUND_PATH" > "$LOG_FILE" 54 | ls -l "$SOUND_PATH" >> "$LOG_FILE" 2>&1 55 | exit 0 56 | fi 57 | 58 | handle_sudo_find() { 59 | local include_sudo_find=false 60 | local scan_type="" 61 | local prev="" 62 | if [ -f "$FIND_METHOD_FILE" ]; then 63 | prev=$(<"$FIND_METHOD_FILE") 64 | fi 65 | 66 | if whiptail --title "$(get_text include_sudo_find)" \ 67 | --yesno "$(get_text do_you_want_sudo_find)" 8 78 \ 68 | --yes-button "$(get_yes_button)" \ 69 | --no-button "$(get_no_button)"; then 70 | play_key_sound 71 | include_sudo_find=true 72 | 73 | if whiptail --title "$(get_text select_scan_type_title)" --defaultno \ 74 | --yesno "$(get_text select_scan_type_message)" \ 75 | 16 70 \ 76 | --yes-button "full" \ 77 | --no-button "optimized"; then 78 | scan_type="full" 79 | else 80 | scan_type="optimized" 81 | fi 82 | 83 | echo "$scan_type" > "$FIND_METHOD_FILE" 84 | play_key_sound 85 | fi 86 | 87 | local ts 88 | ts=$(date '+%Y-%m-%d %H:%M:%S') 89 | if [ "$include_sudo_find" = false ]; then 90 | log_message "[$ts] Normal scan executed" 91 | fi 92 | 93 | gather_application_sizes "$include_sudo_find" "$scan_type" 94 | } 95 | 96 | gather_application_sizes() { 97 | local include_sudo_find="$1" 98 | local scan_type="${2:-optimized}" 99 | 100 | if [ "$include_sudo_find" = true ]; then 101 | ensure_sudo_valid 102 | local ts 103 | ts=$(date '+%Y-%m-%d %H:%M:%S') 104 | if [ "$scan_type" = "full" ]; then 105 | log_message "[$ts] sudo-find scan (full) executed" 106 | else 107 | log_message "[$ts] sudo-find scan (optimized) executed" 108 | fi 109 | fi 110 | 111 | local pipe pid 112 | pipe=$(mktemp -u) 113 | mkfifo "$pipe" 114 | ( 115 | whiptail --gauge "$(get_text gathering_application_sizes...)" 6 60 0 \ 116 | --ok-button "$(get_ok_button)" \ 117 | --cancel-button "$(get_cancel_button)" < "$pipe" 118 | ) & 119 | pid=$! 120 | exec 3> "$pipe" 121 | 122 | { 123 | update_progress 0 "$(get_text starting_homebrew_formula_size_calc)" 124 | if command -v brew &>/dev/null; then 125 | brew list --formula | while read -r formula; do 126 | size=$(calculate_brew_formula_size "$formula") 127 | echo "$formula:$size" 128 | done > brew_formula_sizes.txt 129 | fi 130 | 131 | update_progress 20 "$(get_text starting_homebrew_cask_size_calc)" 132 | if command -v brew &>/dev/null; then 133 | brew list --cask | while read -r cask; do 134 | size=$(calculate_brew_cask_size "$cask") 135 | echo "$cask:$size" 136 | done > brew_cask_sizes.txt 137 | fi 138 | 139 | > applications_sizes.txt 140 | for dir in "${APP_DIRS[@]}"; do 141 | find "$dir" -maxdepth 1 -iname "*.${extension}" -print0 2>/dev/null \ 142 | | while IFS= read -r -d '' app; do 143 | size=$(du -sk "$app" 2>/dev/null | cut -f1) 144 | echo "$(basename "$app"):$size" 145 | done 146 | done >> applications_sizes.txt 147 | 148 | if [ "$OS_TYPE" = "Linux" ]; then 149 | > home_applications_sizes.txt 150 | find "$HOME/.local/share/applications" -maxdepth 1 -iname "*.desktop" -print0 2>/dev/null \ 151 | | while IFS= read -r -d '' app; do 152 | size=$(du -sk "$app" 2>/dev/null | cut -f1) 153 | echo "$(basename "$app"):$size" 154 | done > home_applications_sizes.txt 155 | fi 156 | 157 | if [ "$include_sudo_find" = true ]; then 158 | if [ "$scan_type" = "full" ]; then 159 | update_progress 85 "$(get_text running_sudo_find_full)" 160 | sudo -n find / -iname "*.${extension}" -type d -maxdepth 5 -print0 2>/dev/null \ 161 | | sort -z -u \ 162 | | xargs -0 du -sk --files0-from=- 2>/dev/null \ 163 | | awk -F'\t' '{print $2 ":" $1}' \ 164 | > sudo_find_results.txt || true 165 | else 166 | update_progress 85 "$(get_text running_sudo_find_optimized)" 167 | sudo -n find / -mount \ 168 | \( -path /dev -o -path /proc -o -path /sys -o -path /var \) -prune -o \ 169 | -iname "*.${extension}" -type d -maxdepth 5 -print0 2>/dev/null \ 170 | | xargs -0 du -sk --files0-from=- 2>/dev/null \ 171 | | awk -F'\t' '{print $2 ":" $1}' \ 172 | > sudo_find_results.txt || true 173 | fi 174 | fi 175 | 176 | update_progress 100 "$(get_text process_completed)" 177 | exec 3>&- 178 | } > /dev/null 2>&1 179 | 180 | rm "$pipe" 181 | wait $pid 182 | sleep 0.5 183 | } 184 | 185 | start_collection() { 186 | handle_sudo_find 187 | combine_results 188 | reconstruct_log_entries 189 | 190 | if [ ${#sorted_items[@]} -eq 0 ]; then 191 | whiptail --title "$(get_text no_applications_found)" \ 192 | --msgbox "$(get_text no_applications_found_for_selection)" 8 60 \ 193 | --ok-button "$(get_ok_button)" 194 | return 195 | fi 196 | 197 | interactive_app_selection 198 | } 199 | 200 | check_homebrew() { 201 | if ! command -v brew &>/dev/null; then 202 | whiptail --title "$(get_text error)" \ 203 | --msgbox "$(get_text homebrew_not_installed_msg)" 8 60 \ 204 | --ok-button "$(get_ok_button)" \ 205 | --cancel-button "$(get_cancel_button)" 206 | log_message "Critical error: Homebrew is not installed." 207 | exit 1 208 | fi 209 | } 210 | check_homebrew 211 | 212 | while true; do 213 | main_menu 214 | done 215 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Mac Storage Manager – Cross-Platform (macOS & Linux) 2 | 3 | ![CI](https://github.com/NarekMosisian/mac-storage-manager/actions/workflows/ci.yml/badge.svg) 4 | 5 | Mac Storage Manager is a shell script suite that helps you reclaim disk space by identifying and managing large applications on your macOS or Linux system. 6 | 7 | Mac Storage Manager 8 | 9 | --- 10 | 11 | ## Table of Contents 12 | - [Features](#features) 13 | - [Installation and Setup](#installation-and-setup) 14 | - [Clone the Repository](#clone-the-repository) 15 | - [Make Scripts Executable](#make-scripts-executable) 16 | - [Install Dependencies](#install-dependencies) 17 | - [Run the Project](#run-the-project) 18 | - [Homebrew Support](#homebrew-support) 19 | - [Known Limitations and Common Issues](#known-limitations-and-common-issues) 20 | - [Dependencies](#dependencies) 21 | - [What Exactly is Deleted](#what-exactly-is-deleted) 22 | - [Warning](#warning) 23 | - [Connect with me](#connect-with-me) 24 | - [License](#license) 25 | 26 | --- 27 | 28 | ## Features 29 | 30 | ### -> New in Version 3.2.0 <- 31 | The following additions are brand‑new since the previous release while keeping all legacy functionality intact: 32 | 33 | - **Delete‑History Viewer:** A new *Delete History* menu item shows every application MSM has removed, with timestamps. 34 | - **Optimized ↔ Full sudo Scans:** Choose between a lightning‑fast mount‑aware search or an exhaustive full‑disk crawl; your preference is remembered. 35 | - **User‑Scope Linux Support:** MSM now scans `~/.local/share/applications` so apps installed just for your user account are included. 36 | - **Strict Bash Mode:** All scripts execute with `set -euo pipefail` and a safe `IFS` to catch silent failures early. 37 | - **Smarter Homebrew Uninstall:** If a formula refuses to uninstall, MSM automatically retries using `brew uninstall --ignore-dependencies`. 38 | - **Richer Logging & Sudo Handling:** Deletions are timestamped for the history viewer and the sudo prompt now allows three attempts before safely returning to the menu. 39 | 40 | - **Enhanced Logging & Progress Feedback:** 41 | - Detailed logs (stored in `mac_storage_manager.log`) are generated throughout the operation. 42 | - Advanced error handling is provided via interactive whiptail dialogs and extensive logging. 43 | 44 | - **Interactive Application Deletion:** 45 | - Applications are listed with calculated sizes (including Homebrew formulas and casks). 46 | - Users can select one or more apps to delete using an interactive checklist UI. 47 | - Confirmation dialogs present all files and associated directories that will be removed, ensuring safe deletion. 48 | 49 | - **Cross‑Platform Application Discovery:** 50 | - Centralizes handling of `.app` vs. `.desktop` extensions and `APP_DIRS` for unified scanning and deletion on both macOS and Linux. 51 | 52 | - **Package Manager Removal (Linux):** 53 | - Introduces `delete_via_package_manager` to detect and uninstall via apt, dnf/yum, or pacman where available. 54 | 55 | - **Critical Application Protection:** 56 | - Prevents deletion of essential system apps (e.g., Finder, Safari, gnome‑terminal) to avoid accidental damage. 57 | 58 | - **Main Menu Sound Toggle:** 59 | - Adds an on/off switch for audio feedback directly in the main menu, enabling quick control over sound notifications. 60 | 61 | - **Internationalization & Localization:** 62 | - Translations are provided for over 40 languages, making the tool accessible worldwide. 63 | 64 | (Note that many language translations are experimental and may not yet be completely accurate or consistent. I welcome feedback from native speakers!) 65 | 66 | Mac Storage Manager 67 | 68 | --- 69 | 70 | ## Installation and Setup 71 | 72 | ### Clone the Repository 73 | 74 | Clone the repository to your local machine: 75 | 76 | ```bash 77 | git clone https://github.com/NarekMosisian/mac-storage-manager.git 78 | ``` 79 | 80 | ### Make Scripts Executable 81 | 82 | After cloning, navigate to the project directory and run: 83 | 84 | ```bash 85 | cd mac-storage-manager 86 | chmod +x *.sh 87 | ``` 88 | 89 | ### Install Dependencies 90 | 91 | Ensure you have the following dependencies installed: 92 | 93 | - **jq** (for JSON parsing) 94 | - **newt/whiptail** (for interactive terminal dialogs) 95 | - **Sound utilities:** 96 | - On macOS, the `afplay` command is used (usually pre‑installed). 97 | - On Linux, `paplay` is used (install via your package manager). 98 | 99 | For macOS via Homebrew: 100 | 101 | ```bash 102 | brew install jq newt 103 | ``` 104 | 105 | For Debian/Ubuntu (Linux): 106 | 107 | ```bash 108 | sudo apt-get update 109 | sudo apt-get install jq newt paplay 110 | ``` 111 | 112 | --- 113 | 114 | ## Run the Project 115 | 116 | Start the application by running the main entry point: 117 | 118 | ```bash 119 | ./main.sh 120 | ``` 121 | 122 | --- 123 | 124 | ## Homebrew Support 125 | 126 | A dedicated Homebrew tap is provided specifically for Mac Storage Manager. This tap ensures that the Homebrew formula is always up-to-date and error-free. You can check it out at the following link: 127 | 128 | [**NarekMosisian/homebrew-mac-storage-manager**](https://github.com/NarekMosisian/homebrew-mac-storage-manager) 129 | 130 | 131 | --- 132 | 133 | ## Known Limitations and Common Issues 134 | 135 | - **Performance:** Scanning the entire filesystem with `sudo find` can be slow. 136 | - **Permissions:** Ensure you have sufficient permissions to delete system files. 137 | - **Interactive Dialogs:** The project uses whiptail/newt; make sure they are installed correctly on your system. 138 | - **Shell Compatibility:** It is recommended to use bash for running the scripts to ensure full compatibility. 139 | 140 | --- 141 | 142 | ## Dependencies 143 | 144 | This script relies on the following tools: 145 | 146 | - **jq**: A lightweight and flexible command-line JSON processor. 147 | - **Homebrew**: (macOS only) or **Linuxbrew** (optional on Linux). 148 | - **whiptail**: A package for creating GUI dialogs in the terminal. 149 | - **newt**: For terminal-based GUI dialogs. 150 | 151 | Make sure these dependencies are installed before running the script. 152 | 153 | --- 154 | 155 | ## What Exactly is Deleted 156 | 157 | When you confirm the deletion of an application, the script attempts to thoroughly remove it by deleting: 158 | 159 | - **Main Application Files**: 160 | - **On macOS**: The application bundle from `/Applications` and `~/Applications`. 161 | - **On Linux**: The corresponding .desktop files from `/usr/share/applications` or `~/.local/share/` applications. 162 | 163 | - **Homebrew Files** (macOS only): 164 | - Uninstalls associated Homebrew formulas and casks installed via Homebrew. 165 | 166 | **Associated Files and Directories**: 167 | - **macOS**: 168 | - **Application Support** (optional): 169 | - `~/Library/Application Support/` 170 | - `/Library/Application Support/` 171 | - **Preferences** (optional): 172 | - `~/Library/Preferences/com..*` 173 | - `/Library/Preferences/com..*` 174 | - **Caches** (optional): 175 | - `~/Library/Caches/` 176 | - `~/Library/Caches/com..*` 177 | - `/Library/Caches/` 178 | - `/Library/Caches/com..*` 179 | - **Logs** (optional): 180 | - `~/Library/Logs/` 181 | - `/Library/Logs/` 182 | - **Saved Application State** (optional): 183 | - `~/Library/Saved Application State/com..*` 184 | - `/Library/Saved Application State/com..*` 185 | 186 | - **Linux**: 187 | - **Application Data** (optional): 188 | - `$XDG_DATA_HOME/` 189 | - `~/.local/share/` 190 | - **Configuration Files** (optional): 191 | - `$XDG_CONFIG_HOME/` 192 | - `~/.config/` 193 | - **Cache Files** (optional): 194 | - `$XDG_CACHE_HOME/` 195 | - `~/.cache/` 196 | - **Log Files** (optional): 197 | - Common log directories (if any) related to the application 198 | 199 | - **Additional Files Found via `sudo find` (optional)**: Any files matching the application name found during the `sudo find` operation (if you chose to include this step). The script will display these files and ask for your confirmation before deletion. 200 | 201 | --- 202 | 203 | ## Warning 204 | 205 | Please read the following carefully before using the script: 206 | 207 | - **Data Loss Risk**: The script performs a thorough deletion of applications and their associated files. Be cautious when selecting applications to delete. Ensure that you do not remove essential system applications or files. 208 | - **Review Before Deleting**: Before any files are deleted, the script will display a list of files and directories that will be removed. Please review this list carefully to avoid unintended deletions. 209 | - **No Undo**: Deleting applications and files is permanent and cannot be undone. Consider backing up important data before proceeding. 210 | - **Use at Your Own Risk**: The script is provided "as is," without warranty of any kind. The author is not responsible for any damage or data loss that may occur as a result of using this script. 211 | 212 | --- 213 | 214 | ## Connect with me 215 | 216 | If you have any questions or want to discuss the project further, feel free to connect with me on [narekmosisian.com](https://narekmosisian.com/). 217 | 218 | --- 219 | 220 | ## License 221 | 222 | This project is licensed under the **GNU Affero General Public License v3.0 (AGPLv3)**. 223 | This license ensures that anyone who modifies, uses, or redistributes this software—especially in a networked environment—must share the source code and any modifications under the same license. 224 | 225 | For detailed information, see the [LICENSE](./LICENSE) file. 226 | -------------------------------------------------------------------------------- /deletion.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | 5 | # ------------------------------------------------------------------------------------------------------ 6 | # Mac Storage Manager - Cross-Platform internationalized Version (macOS/Linux) 7 | # 8 | # This script was created by Narek Mosisian. For more information, visit: 9 | # https://github.com/NarekMosisian/mac-storage-manager 10 | # © 2024 Narek Mosisian. All rights reserved. 11 | # 12 | # This script is licensed under the AGPL-3.0 license. 13 | # ------------------------------------------------------------------------------------------------------ 14 | # NOTICE: 15 | # If you distribute, modify, or incorporate any parts of this code, you must ensure that 16 | # the original author's name, "Narek Mosisian", is clearly attributed in all copies and 17 | # derivative works. Additionally, any derivative work must be distributed under the AGPL-3.0 license. 18 | # This requirement is mandated by the terms of the AGPL-3.0 license. 19 | # ------------------------------------------------------------------------------------------------------ 20 | 21 | display_error() { 22 | local message="$1" 23 | whiptail --title "$(get_text critical_error)" \ 24 | --msgbox "$message" 8 60 \ 25 | --ok-button "$(get_ok_button)" \ 26 | --cancel-button "$(get_cancel_button)" 27 | } 28 | 29 | delete_via_package_manager() { 30 | local pkg="$1" 31 | 32 | # Debian/Ubuntu 33 | if command -v dpkg &>/dev/null; then 34 | if dpkg -l | grep -qi -F -- "$pkg"; then 35 | if whiptail --title "$(get_text warning)" \ 36 | --yesno "$(printf "$(get_text pkgmgr_remove_confirm)" "$pkg")" 10 60 \ 37 | --yes-button "$(get_text yes)" \ 38 | --no-button "$(get_text no)"; then 39 | ensure_sudo_valid 40 | sudo apt-get remove --purge -y -- "$pkg" 41 | return $? 42 | fi 43 | fi 44 | fi 45 | 46 | # Fedora/RHEL/CentOS (dnf or yum) 47 | if command -v rpm &>/dev/null; then 48 | if rpm -q --quiet "$pkg"; then 49 | if whiptail --title "$(get_text warning)" \ 50 | --yesno "$(printf "$(get_text pkgmgr_remove_confirm)" "$pkg")" 10 60 \ 51 | --yes-button "$(get_text yes)" \ 52 | --no-button "$(get_text no)"; then 53 | ensure_sudo_valid 54 | if command -v dnf &>/dev/null; then 55 | sudo dnf remove -y -- "$pkg" 56 | else 57 | sudo yum remove -y -- "$pkg" 58 | fi 59 | return $? 60 | fi 61 | fi 62 | fi 63 | 64 | # Arch Linux (pacman) 65 | if command -v pacman &>/dev/null; then 66 | if pacman -Qi "$pkg" &>/dev/null; then 67 | if whiptail --title "$(get_text warning)" \ 68 | --yesno "$(printf "$(get_text pkgmgr_remove_confirm)" "$pkg")" 10 60 \ 69 | --yes-button "$(get_text yes)" \ 70 | --no-button "$(get_text no)"; then 71 | ensure_sudo_valid 72 | sudo pacman -Rs --noconfirm "$pkg" 73 | return $? 74 | fi 75 | fi 76 | fi 77 | 78 | return 1 79 | } 80 | 81 | delete_application() { 82 | local app_name_raw="$1" 83 | local app_name="${app_name_raw//_/ }" 84 | app_name="${app_name#\"}" 85 | app_name="${app_name%\"}" 86 | local app_path="" 87 | 88 | log_message "$(printf "$(get_text attempting_to_delete)" "$app_name")" 89 | 90 | # Block deletion of critical system apps 91 | local CRITICAL_APPS 92 | if [ "$OS_TYPE" = "Darwin" ]; then 93 | CRITICAL_APPS=("Finder.app" "Safari.app" "System Preferences.app" "Terminal.app" "Dock.app") 94 | else 95 | CRITICAL_APPS=("gnome-terminal.desktop" "org.gnome.Nautilus.desktop") 96 | fi 97 | for crit in "${CRITICAL_APPS[@]}"; do 98 | if [ "$app_name" = "$crit" ]; then 99 | display_error "$(printf "$(get_text critical_app_blocked)" "$app_name")" 100 | log_message "Deletion of critical application $app_name blocked." 101 | return 1 102 | fi 103 | done 104 | 105 | local normalized_name 106 | normalized_name=$(echo "$app_name" | sed 's/\.app$//I; s/\.desktop$//I' | tr '[:upper:]' '[:lower:]') 107 | 108 | if delete_via_package_manager "$normalized_name"; then 109 | log_message "Removed $normalized_name via package manager." 110 | log_message "Deleted application $app_name at $(date)" 111 | return 0 112 | fi 113 | 114 | if [ "$app_name" = "Docker.app" ] || [ "$app_name" = "Docker.desktop" ]; then 115 | if command -v brew &>/dev/null && brew list --cask | grep -qi -F -- "^docker\$"; then 116 | log_message "$(printf "$(get_text homebrew_cask_uninstalling)" "$app_name")" 117 | ensure_sudo_valid 118 | if brew uninstall --cask docker >> "$LOG_FILE" 2>&1; then 119 | log_message "$(get_text docker_uninstall_success_homebrew)" 120 | log_message "Deleted application $app_name at $(date)" 121 | else 122 | log_message "$(get_text docker_uninstall_failed_homebrew)" 123 | display_error "$(get_text docker_uninstall_failed_homebrew)" 124 | interactive_app_selection "${sorted_items[@]}" 125 | return 1 126 | fi 127 | fi 128 | for dir in "${APP_DIRS[@]}"; do 129 | if [ -d "$dir/Docker.app" ]; then 130 | app_path="$dir/Docker.app" 131 | break 132 | fi 133 | done 134 | if [ -n "$app_path" ]; then 135 | ensure_sudo_valid 136 | sudo rm -rf -- "$app_path" >> "$LOG_FILE" 2>&1 137 | if [ $? -eq 0 ]; then 138 | log_message "$(printf "$(get_text successfully_deleted_path)" "$app_path")" 139 | log_message "Deleted application $app_name at $(date)" 140 | else 141 | log_message "$(printf "$(get_text failed_to_delete_path)" "$app_path")" 142 | display_error "$(printf "$(get_text failed_to_delete_path)" "$app_path")" 143 | return 1 144 | fi 145 | return 0 146 | fi 147 | fi 148 | 149 | if command -v brew &>/dev/null && brew list --cask | grep -qi -F -- "^$normalized_name\$"; then 150 | log_message "$(printf "$(get_text homebrew_cask_uninstalling)" "$app_name")" 151 | ensure_sudo_valid 152 | if brew uninstall --cask "$normalized_name" >> "$LOG_FILE" 2>&1; then 153 | log_message "$(printf "$(get_text homebrew_cask_uninstall_success)" "$normalized_name")" 154 | log_message "Deleted application $app_name at $(date)" 155 | else 156 | log_message "$(printf "$(get_text homebrew_cask_uninstall_failure)" "$normalized_name")" 157 | display_error "$(printf "$(get_text homebrew_cask_uninstall_failure)" "$app_name")" 158 | interactive_app_selection "${sorted_items[@]}" 159 | return 1 160 | fi 161 | return 0 162 | fi 163 | 164 | if command -v brew &>/dev/null && brew list --formula --versions | awk '{print $1}' | grep -xq "$normalized_name"; then 165 | log_message "$(printf "$(get_text homebrew_formula_uninstalling)" "$app_name")" 166 | ensure_sudo_valid 167 | 168 | if brew uninstall --formula "$normalized_name" >>"$LOG_FILE" 2>&1; then 169 | brew cleanup "$normalized_name" >> "$LOG_FILE" 2>&1 170 | log_message "$(printf "$(get_text homebrew_formula_uninstall_success)" "$normalized_name")" 171 | log_message "Deleted application $app_name at $(date)" 172 | return 0 173 | fi 174 | 175 | log_message "Normal uninstall failed, retrying with --ignore-dependencies" 176 | if brew uninstall --formula --ignore-dependencies "$normalized_name" >>"$LOG_FILE" 2>&1; then 177 | brew cleanup "$normalized_name" >> "$LOG_FILE" 2>&1 178 | log_message "$(printf "$(get_text homebrew_formula_uninstall_success_ignore_deps)" "$normalized_name")" 179 | log_message "Deleted application $app_name at $(date)" 180 | return 0 181 | else 182 | log_message "$(printf "$(get_text homebrew_formula_uninstall_failure)" "$normalized_name")" 183 | display_error "$(printf "$(get_text homebrew_formula_uninstall_failure)" "$app_name")" 184 | return 1 185 | fi 186 | fi 187 | 188 | local find_type 189 | if [[ "$app_name" == *.desktop ]]; then 190 | find_type="f" 191 | else 192 | find_type="d" 193 | fi 194 | for dir in "${APP_DIRS[@]}"; do 195 | candidate=$(find "$dir" -maxdepth 1 -iname "$app_name" -type "$find_type" 2>/dev/null | head -n1) 196 | if [ -z "$candidate" ] && [[ "$app_name" != *.* ]]; then 197 | candidate=$(find "$dir" -maxdepth 1 -iname "*${app_name}*.${extension}" -type "$find_type" 2>/dev/null | head -n1) 198 | fi 199 | if [ -n "$candidate" ]; then 200 | app_path="$candidate" 201 | break 202 | fi 203 | done 204 | 205 | if [ -z "$app_path" ]; then 206 | display_error "$(printf "$(get_text app_not_found_on_system)" "$app_name")" 207 | log_message "Deletion failed: $app_name not found." 208 | return 1 209 | fi 210 | 211 | ensure_sudo_valid 212 | sudo rm -rf -- "$app_path" >> "$LOG_FILE" 2>&1 213 | if [ $? -eq 0 ]; then 214 | log_message "$(printf "$(get_text successfully_deleted_path)" "$app_path")" 215 | log_message "Deleted application $app_name at $(date)" 216 | return 0 217 | else 218 | log_message "$(printf "$(get_text failed_to_delete_path)" "$app_path")" 219 | display_error "$(printf "$(get_text failed_to_delete_path)" "$app_path")" 220 | return 1 221 | fi 222 | } 223 | 224 | confirm_deletion() { 225 | local selected_apps="$1" 226 | log_message "Selected apps: $selected_apps" 227 | 228 | read -r -a apps_to_delete <<< "$selected_apps" 229 | if [ ${#apps_to_delete[@]} -eq 0 ]; then 230 | whiptail --title "$(get_text error)" \ 231 | --msgbox "$(get_text no_applications_found_for_selection)" 8 60 \ 232 | --ok-button "$(get_ok_button)" \ 233 | --cancel-button "$(get_cancel_button)" 234 | exit 0 235 | fi 236 | 237 | local deletion_message 238 | deletion_message="$(get_text are_you_sure_permanently_delete)" 239 | for app in "${apps_to_delete[@]}"; do 240 | deletion_message+="$app\n" 241 | done 242 | deletion_message+="$(get_text this_action_cannot_be_undone)" 243 | 244 | if whiptail --title "$(get_text confirm_deletion)" \ 245 | --yesno "$deletion_message" 15 60 \ 246 | --yes-button "$(get_yes_button)" \ 247 | --no-button "$(get_no_button)"; then 248 | play_key_sound 249 | log_message "Confirmed deletion" 250 | 251 | for app in "${apps_to_delete[@]}"; do 252 | delete_application "$app" || { log_message "Deletion failed for $app."; return; } 253 | sleep 1 254 | done 255 | 256 | ask_to_delete_associated_files "${apps_to_delete[@]}" 257 | 258 | whiptail --title "$(get_text selected_apps_processed)" \ 259 | --msgbox "$(get_text selected_apps_processed)" 8 60 \ 260 | --ok-button "$(get_ok_button)" 261 | 262 | whiptail --title "$(get_text log_file_status_title)" \ 263 | --msgbox "$(get_text log_file_updated_message)" 8 60 \ 264 | --ok-button "$(get_ok_button)" \ 265 | --cancel-button "$(get_cancel_button)" 266 | else 267 | play_key_sound 268 | log_message "User canceled deletion" 269 | fi 270 | 271 | main_menu 272 | } 273 | 274 | ask_to_delete_associated_files() { 275 | local apps=("$@") 276 | local delete_app_files=false 277 | local delete_config_files=false 278 | local delete_cache_files=false 279 | local delete_log_files=false 280 | local delete_saved_state=false 281 | 282 | ensure_sudo_valid || return 283 | 284 | if [ "$OS_TYPE" = "Darwin" ]; then 285 | if whiptail --title "$(get_text short_delete_app_support_title)" \ 286 | --yesno "$(get_text delete_application_support_title)" 8 78 \ 287 | --ok-button "$(get_ok_button)" \ 288 | --no-button "$(get_cancel_button)"; then 289 | play_key_sound 290 | delete_app_files=true 291 | fi 292 | if whiptail --title "$(get_text short_delete_preferences_title)" \ 293 | --yesno "$(get_text delete_preferences_title)" 8 78 \ 294 | --ok-button "$(get_ok_button)" \ 295 | --no-button "$(get_cancel_button)"; then 296 | play_key_sound 297 | delete_config_files=true 298 | fi 299 | if whiptail --title "$(get_text short_delete_caches_title)" \ 300 | --yesno "$(get_text delete_caches_title)" 8 78 \ 301 | --ok-button "$(get_ok_button)" \ 302 | --no-button "$(get_cancel_button)"; then 303 | play_key_sound 304 | delete_cache_files=true 305 | fi 306 | if whiptail --title "$(get_text short_delete_logs_title)" \ 307 | --yesno "$(get_text delete_logs_title)" 8 78 \ 308 | --ok-button "$(get_ok_button)" \ 309 | --no-button "$(get_cancel_button)"; then 310 | play_key_sound 311 | delete_log_files=true 312 | fi 313 | if whiptail --title "$(get_text short_delete_saved_state_title)" \ 314 | --yesno "$(get_text delete_saved_state_title)" 8 78 \ 315 | --ok-button "$(get_ok_button)" \ 316 | --no-button "$(get_cancel_button)"; then 317 | play_key_sound 318 | delete_saved_state=true 319 | fi 320 | else 321 | if whiptail --title "$(get_text short_delete_app_data_title)" \ 322 | --yesno "$(get_text delete_application_data_title)" 8 78 \ 323 | --ok-button "$(get_ok_button)" \ 324 | --no-button "$(get_cancel_button)"; then 325 | play_key_sound 326 | delete_app_files=true 327 | fi 328 | if whiptail --title "$(get_text short_delete_configuration_title)" \ 329 | --yesno "$(get_text delete_configuration_title)" 8 78 \ 330 | --ok-button "$(get_ok_button)" \ 331 | --no-button "$(get_cancel_button)"; then 332 | play_key_sound 333 | delete_config_files=true 334 | fi 335 | if whiptail --title "$(get_text short_delete_cache_files_title)" \ 336 | --yesno "$(get_text delete_cache_files_title)" 8 78 \ 337 | --ok-button "$(get_ok_button)" \ 338 | --no-button "$(get_cancel_button)"; then 339 | play_key_sound 340 | delete_cache_files=true 341 | fi 342 | if whiptail --title "$(get_text short_delete_log_files_title)" \ 343 | --yesno "$(get_text delete_log_files_title)" 8 78 \ 344 | --ok-button "$(get_ok_button)" \ 345 | --no-button "$(get_cancel_button)"; then 346 | play_key_sound 347 | delete_log_files=true 348 | fi 349 | fi 350 | 351 | for app in "${apps[@]}"; do 352 | local app_clean="${app//\"/}" 353 | log_message "$(printf "$(get_text deleting_associated_files_for)" "$app_clean")" 354 | if [ "$OS_TYPE" = "Darwin" ]; then 355 | [ "$delete_app_files" = true ] && (sudo rm -rf "/Library/Application Support/$app_clean" >> "$LOG_FILE" 2>&1; \ 356 | rm -rf "$HOME/Library/Application Support/$app_clean" >> "$LOG_FILE" 2>&1) 357 | [ "$delete_config_files" = true ] && (sudo find "/Library/Preferences" -name "*$app_clean*" -exec rm -f {} \; >> "$LOG_FILE" 2>&1; \ 358 | find "$HOME/Library/Preferences" -name "*$app_clean*" -exec rm -f {} \; >> "$LOG_FILE" 2>&1) 359 | [ "$delete_cache_files" = true ] && (sudo rm -rf "/Library/Caches/$app_clean" >> "$LOG_FILE" 2>&1; \ 360 | sudo rm -rf "/Library/Caches/com.$app_clean.*" >> "$LOG_FILE" 2>&1; \ 361 | rm -rf "$HOME/Library/Caches/$app_clean" >> "$LOG_FILE" 2>&1; \ 362 | rm -rf "$HOME/Library/Caches/com.$app_clean.*" >> "$LOG_FILE" 2>&1) 363 | [ "$delete_log_files" = true ] && (sudo rm -rf "/Library/Logs/$app_clean" >> "$LOG_FILE" 2>&1; \ 364 | rm -rf "$HOME/Library/Logs/$app_clean" >> "$LOG_FILE" 2>&1) 365 | [ "$delete_saved_state" = true ] && (sudo rm -rf "/Library/Saved Application State/com.$app_clean.*" >> "$LOG_FILE" 2>&1; \ 366 | rm -rf "$HOME/Library/Saved Application State/com.$app_clean.*" >> "$LOG_FILE" 2>&1) 367 | else 368 | [ "$delete_app_files" = true ] && rm -rf "$XDG_DATA/$app_clean" >> "$LOG_FILE" 2>&1 369 | [ "$delete_config_files" = true ] && rm -rf "$XDG_CONFIG/$app_clean" >> "$LOG_FILE" 2>&1 370 | [ "$delete_cache_files" = true ] && rm -rf "$XDG_CACHE/$app_clean" >> "$LOG_FILE" 2>&1 371 | [ "$delete_log_files" = true ] && (rm -rf "$XDG_CACHE/$app_clean-logs" >> "$LOG_FILE" 2>&1; \ 372 | rm -rf "$HOME/.local/share/$app_clean-logs" >> "$LOG_FILE" 2>&1) 373 | fi 374 | done 375 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | # GNU AFFERO GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 19 November 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ## Preamble 12 | 13 | The GNU Affero General Public License is a free, copyleft license for 14 | software and other kinds of works, specifically designed to ensure 15 | cooperation with the community in the case of network server software. 16 | 17 | The licenses for most software and other practical works are designed 18 | to take away your freedom to share and change the works. By contrast, 19 | our General Public Licenses are intended to guarantee your freedom to 20 | share and change all versions of a program--to make sure it remains 21 | free software for all its users. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | Developers that use our General Public Licenses protect your rights 31 | with two steps: (1) assert copyright on the software, and (2) offer 32 | you this License which gives you legal permission to copy, distribute 33 | and/or modify the software. 34 | 35 | A secondary benefit of defending all users' freedom is that 36 | improvements made in alternate versions of the program, if they 37 | receive widespread use, become available for other developers to 38 | incorporate. Many developers of free software are heartened and 39 | encouraged by the resulting cooperation. However, in the case of 40 | software used on network servers, this result may fail to come about. 41 | The GNU General Public License permits making a modified version and 42 | letting the public access it on a server without ever releasing its 43 | source code to the public. 44 | 45 | The GNU Affero General Public License is designed specifically to 46 | ensure that, in such cases, the modified source code becomes available 47 | to the community. It requires the operator of a network server to 48 | provide the source code of the modified version running there to the 49 | users of that server. Therefore, public use of a modified version, on 50 | a publicly accessible server, gives the public access to the source 51 | code of the modified version. 52 | 53 | An older license, called the Affero General Public License and 54 | published by Affero, was designed to accomplish similar goals. This is 55 | a different license, not a version of the Affero GPL, but Affero has 56 | released a new version of the Affero GPL which permits relicensing 57 | under this license. 58 | 59 | The precise terms and conditions for copying, distribution and 60 | modification follow. 61 | 62 | ## TERMS AND CONDITIONS 63 | 64 | ### 0. Definitions. 65 | 66 | "This License" refers to version 3 of the GNU Affero General Public 67 | License. 68 | 69 | "Copyright" also means copyright-like laws that apply to other kinds 70 | of works, such as semiconductor masks. 71 | 72 | "The Program" refers to any copyrightable work licensed under this 73 | License. Each licensee is addressed as "you". "Licensees" and 74 | "recipients" may be individuals or organizations. 75 | 76 | To "modify" a work means to copy from or adapt all or part of the work 77 | in a fashion requiring copyright permission, other than the making of 78 | an exact copy. The resulting work is called a "modified version" of 79 | the earlier work or a work "based on" the earlier work. 80 | 81 | A "covered work" means either the unmodified Program or a work based 82 | on the Program. 83 | 84 | To "propagate" a work means to do anything with it that, without 85 | permission, would make you directly or secondarily liable for 86 | infringement under applicable copyright law, except executing it on a 87 | computer or modifying a private copy. Propagation includes copying, 88 | distribution (with or without modification), making available to the 89 | public, and in some countries other activities as well. 90 | 91 | To "convey" a work means any kind of propagation that enables other 92 | parties to make or receive copies. Mere interaction with a user 93 | through a computer network, with no transfer of a copy, is not 94 | conveying. 95 | 96 | An interactive user interface displays "Appropriate Legal Notices" to 97 | the extent that it includes a convenient and prominently visible 98 | feature that (1) displays an appropriate copyright notice, and (2) 99 | tells the user that there is no warranty for the work (except to the 100 | extent that warranties are provided), that licensees may convey the 101 | work under this License, and how to view a copy of this License. If 102 | the interface presents a list of user commands or options, such as a 103 | menu, a prominent item in the list meets this criterion. 104 | 105 | ### 1. Source Code. 106 | 107 | The "source code" for a work means the preferred form of the work for 108 | making modifications to it. "Object code" means any non-source form of 109 | a work. 110 | 111 | A "Standard Interface" means an interface that either is an official 112 | standard defined by a recognized standards body, or, in the case of 113 | interfaces specified for a particular programming language, one that 114 | is widely used among developers working in that language. 115 | 116 | The "System Libraries" of an executable work include anything, other 117 | than the work as a whole, that (a) is included in the normal form of 118 | packaging a Major Component, but which is not part of that Major 119 | Component, and (b) serves only to enable use of the work with that 120 | Major Component, or to implement a Standard Interface for which an 121 | implementation is available to the public in source code form. A 122 | "Major Component", in this context, means a major essential component 123 | (kernel, window system, and so on) of the specific operating system 124 | (if any) on which the executable work runs, or a compiler used to 125 | produce the work, or an object code interpreter used to run it. 126 | 127 | The "Corresponding Source" for a work in object code form means all 128 | the source code needed to generate, install, and (for an executable 129 | work) run the object code and to modify the work, including scripts to 130 | control those activities. However, it does not include the work's 131 | System Libraries, or general-purpose tools or generally available free 132 | programs which are used unmodified in performing those activities but 133 | which are not part of the work. For example, Corresponding Source 134 | includes interface definition files associated with source files for 135 | the work, and the source code for shared libraries and dynamically 136 | linked subprograms that the work is specifically designed to require, 137 | such as by intimate data communication or control flow between those 138 | subprograms and other parts of the work. 139 | 140 | The Corresponding Source need not include anything that users can 141 | regenerate automatically from other parts of the Corresponding Source. 142 | 143 | The Corresponding Source for a work in source code form is that same 144 | work. 145 | 146 | ### 2. Basic Permissions. 147 | 148 | All rights granted under this License are granted for the term of 149 | copyright on the Program, and are irrevocable provided the stated 150 | conditions are met. This License explicitly affirms your unlimited 151 | permission to run the unmodified Program. The output from running a 152 | covered work is covered by this License only if the output, given its 153 | content, constitutes a covered work. This License acknowledges your 154 | rights of fair use or other equivalent, as provided by copyright law. 155 | 156 | You may make, run and propagate covered works that you do not convey, 157 | without conditions so long as your license otherwise remains in force. 158 | You may convey covered works to others for the sole purpose of having 159 | them make modifications exclusively for you, or provide you with 160 | facilities for running those works, provided that you comply with the 161 | terms of this License in conveying all material for which you do not 162 | control copyright. Those thus making or running the covered works for 163 | you must do so exclusively on your behalf, under your direction and 164 | control, on terms that prohibit them from making any copies of your 165 | copyrighted material outside their relationship with you. 166 | 167 | Conveying under any other circumstances is permitted solely under the 168 | conditions stated below. Sublicensing is not allowed; section 10 makes 169 | it unnecessary. 170 | 171 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 172 | 173 | No covered work shall be deemed part of an effective technological 174 | measure under any applicable law fulfilling obligations under article 175 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 176 | similar laws prohibiting or restricting circumvention of such 177 | measures. 178 | 179 | When you convey a covered work, you waive any legal power to forbid 180 | circumvention of technological measures to the extent such 181 | circumvention is effected by exercising rights under this License with 182 | respect to the covered work, and you disclaim any intention to limit 183 | operation or modification of the work as a means of enforcing, against 184 | the work's users, your or third parties' legal rights to forbid 185 | circumvention of technological measures. 186 | 187 | ### 4. Conveying Verbatim Copies. 188 | 189 | You may convey verbatim copies of the Program's source code as you 190 | receive it, in any medium, provided that you conspicuously and 191 | appropriately publish on each copy an appropriate copyright notice; 192 | keep intact all notices stating that this License and any 193 | non-permissive terms added in accord with section 7 apply to the code; 194 | keep intact all notices of the absence of any warranty; and give all 195 | recipients a copy of this License along with the Program. 196 | 197 | You may charge any price or no price for each copy that you convey, 198 | and you may offer support or warranty protection for a fee. 199 | 200 | ### 5. Conveying Modified Source Versions. 201 | 202 | You may convey a work based on the Program, or the modifications to 203 | produce it from the Program, in the form of source code under the 204 | terms of section 4, provided that you also meet all of these 205 | conditions: 206 | 207 | - a) The work must carry prominent notices stating that you modified 208 | it, and giving a relevant date. 209 | - b) The work must carry prominent notices stating that it is 210 | released under this License and any conditions added under 211 | section 7. This requirement modifies the requirement in section 4 212 | to "keep intact all notices". 213 | - c) You must license the entire work, as a whole, under this 214 | License to anyone who comes into possession of a copy. This 215 | License will therefore apply, along with any applicable section 7 216 | additional terms, to the whole of the work, and all its parts, 217 | regardless of how they are packaged. This License gives no 218 | permission to license the work in any other way, but it does not 219 | invalidate such permission if you have separately received it. 220 | - d) If the work has interactive user interfaces, each must display 221 | Appropriate Legal Notices; however, if the Program has interactive 222 | interfaces that do not display Appropriate Legal Notices, your 223 | work need not make them do so. 224 | 225 | A compilation of a covered work with other separate and independent 226 | works, which are not by their nature extensions of the covered work, 227 | and which are not combined with it such as to form a larger program, 228 | in or on a volume of a storage or distribution medium, is called an 229 | "aggregate" if the compilation and its resulting copyright are not 230 | used to limit the access or legal rights of the compilation's users 231 | beyond what the individual works permit. Inclusion of a covered work 232 | in an aggregate does not cause this License to apply to the other 233 | parts of the aggregate. 234 | 235 | ### 6. Conveying Non-Source Forms. 236 | 237 | You may convey a covered work in object code form under the terms of 238 | sections 4 and 5, provided that you also convey the machine-readable 239 | Corresponding Source under the terms of this License, in one of these 240 | ways: 241 | 242 | - a) Convey the object code in, or embodied in, a physical product 243 | (including a physical distribution medium), accompanied by the 244 | Corresponding Source fixed on a durable physical medium 245 | customarily used for software interchange. 246 | - b) Convey the object code in, or embodied in, a physical product 247 | (including a physical distribution medium), accompanied by a 248 | written offer, valid for at least three years and valid for as 249 | long as you offer spare parts or customer support for that product 250 | model, to give anyone who possesses the object code either (1) a 251 | copy of the Corresponding Source for all the software in the 252 | product that is covered by this License, on a durable physical 253 | medium customarily used for software interchange, for a price no 254 | more than your reasonable cost of physically performing this 255 | conveying of source, or (2) access to copy the Corresponding 256 | Source from a network server at no charge. 257 | - c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | - d) Convey the object code by offering access from a designated 263 | place (gratis or for a charge), and offer equivalent access to the 264 | Corresponding Source in the same way through the same place at no 265 | further charge. You need not require recipients to copy the 266 | Corresponding Source along with the object code. If the place to 267 | copy the object code is a network server, the Corresponding Source 268 | may be on a different server (operated by you or a third party) 269 | that supports equivalent copying facilities, provided you maintain 270 | clear directions next to the object code saying where to find the 271 | Corresponding Source. Regardless of what server hosts the 272 | Corresponding Source, you remain obligated to ensure that it is 273 | available for as long as needed to satisfy these requirements. 274 | - e) Convey the object code using peer-to-peer transmission, 275 | provided you inform other peers where the object code and 276 | Corresponding Source of the work are being offered to the general 277 | public at no charge under subsection 6d. 278 | 279 | A separable portion of the object code, whose source code is excluded 280 | from the Corresponding Source as a System Library, need not be 281 | included in conveying the object code work. 282 | 283 | A "User Product" is either (1) a "consumer product", which means any 284 | tangible personal property which is normally used for personal, 285 | family, or household purposes, or (2) anything designed or sold for 286 | incorporation into a dwelling. In determining whether a product is a 287 | consumer product, doubtful cases shall be resolved in favor of 288 | coverage. For a particular product received by a particular user, 289 | "normally used" refers to a typical or common use of that class of 290 | product, regardless of the status of the particular user or of the way 291 | in which the particular user actually uses, or expects or is expected 292 | to use, the product. A product is a consumer product regardless of 293 | whether the product has substantial commercial, industrial or 294 | non-consumer uses, unless such uses represent the only significant 295 | mode of use of the product. 296 | 297 | "Installation Information" for a User Product means any methods, 298 | procedures, authorization keys, or other information required to 299 | install and execute modified versions of a covered work in that User 300 | Product from a modified version of its Corresponding Source. The 301 | information must suffice to ensure that the continued functioning of 302 | the modified object code is in no case prevented or interfered with 303 | solely because modification has been made. 304 | 305 | If you convey an object code work under this section in, or with, or 306 | specifically for use in, a User Product, and the conveying occurs as 307 | part of a transaction in which the right of possession and use of the 308 | User Product is transferred to the recipient in perpetuity or for a 309 | fixed term (regardless of how the transaction is characterized), the 310 | Corresponding Source conveyed under this section must be accompanied 311 | by the Installation Information. But this requirement does not apply 312 | if neither you nor any third party retains the ability to install 313 | modified object code on the User Product (for example, the work has 314 | been installed in ROM). 315 | 316 | The requirement to provide Installation Information does not include a 317 | requirement to continue to provide support service, warranty, or 318 | updates for a work that has been modified or installed by the 319 | recipient, or for the User Product in which it has been modified or 320 | installed. Access to a network may be denied when the modification 321 | itself materially and adversely affects the operation of the network 322 | or violates the rules and protocols for communication across the 323 | network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | ### 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders 351 | of that material) supplement the terms of this License with terms: 352 | 353 | - a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | - b) Requiring preservation of specified reasonable legal notices or 356 | author attributions in that material or in the Appropriate Legal 357 | Notices displayed by works containing it; or 358 | - c) Prohibiting misrepresentation of the origin of that material, 359 | or requiring that modified versions of such material be marked in 360 | reasonable ways as different from the original version; or 361 | - d) Limiting the use for publicity purposes of names of licensors 362 | or authors of the material; or 363 | - e) Declining to grant rights under trademark law for use of some 364 | trade names, trademarks, or service marks; or 365 | - f) Requiring indemnification of licensors and authors of that 366 | material by anyone who conveys the material (or modified versions 367 | of it) with contractual assumptions of liability to the recipient, 368 | for any liability that these contractual assumptions directly 369 | impose on those licensors and authors. 370 | 371 | All other non-permissive additional terms are considered "further 372 | restrictions" within the meaning of section 10. If the Program as you 373 | received it, or any part of it, contains a notice stating that it is 374 | governed by this License along with a term that is a further 375 | restriction, you may remove that term. If a license document contains 376 | a further restriction but permits relicensing or conveying under this 377 | License, you may add to a covered work material governed by the terms 378 | of that license document, provided that the further restriction does 379 | not survive such relicensing or conveying. 380 | 381 | If you add terms to a covered work in accord with this section, you 382 | must place, in the relevant source files, a statement of the 383 | additional terms that apply to those files, or a notice indicating 384 | where to find the applicable terms. 385 | 386 | Additional terms, permissive or non-permissive, may be stated in the 387 | form of a separately written license, or stated as exceptions; the 388 | above requirements apply either way. 389 | 390 | ### 8. Termination. 391 | 392 | You may not propagate or modify a covered work except as expressly 393 | provided under this License. Any attempt otherwise to propagate or 394 | modify it is void, and will automatically terminate your rights under 395 | this License (including any patent licenses granted under the third 396 | paragraph of section 11). 397 | 398 | However, if you cease all violation of this License, then your license 399 | from a particular copyright holder is reinstated (a) provisionally, 400 | unless and until the copyright holder explicitly and finally 401 | terminates your license, and (b) permanently, if the copyright holder 402 | fails to notify you of the violation by some reasonable means prior to 403 | 60 days after the cessation. 404 | 405 | Moreover, your license from a particular copyright holder is 406 | reinstated permanently if the copyright holder notifies you of the 407 | violation by some reasonable means, this is the first time you have 408 | received notice of violation of this License (for any work) from that 409 | copyright holder, and you cure the violation prior to 30 days after 410 | your receipt of the notice. 411 | 412 | Termination of your rights under this section does not terminate the 413 | licenses of parties who have received copies or rights from you under 414 | this License. If your rights have been terminated and not permanently 415 | reinstated, you do not qualify to receive new licenses for the same 416 | material under section 10. 417 | 418 | ### 9. Acceptance Not Required for Having Copies. 419 | 420 | You are not required to accept this License in order to receive or run 421 | a copy of the Program. Ancillary propagation of a covered work 422 | occurring solely as a consequence of using peer-to-peer transmission 423 | to receive a copy likewise does not require acceptance. However, 424 | nothing other than this License grants you permission to propagate or 425 | modify any covered work. These actions infringe copyright if you do 426 | not accept this License. Therefore, by modifying or propagating a 427 | covered work, you indicate your acceptance of this License to do so. 428 | 429 | ### 10. Automatic Licensing of Downstream Recipients. 430 | 431 | Each time you convey a covered work, the recipient automatically 432 | receives a license from the original licensors, to run, modify and 433 | propagate that work, subject to this License. You are not responsible 434 | for enforcing compliance by third parties with this License. 435 | 436 | An "entity transaction" is a transaction transferring control of an 437 | organization, or substantially all assets of one, or subdividing an 438 | organization, or merging organizations. If propagation of a covered 439 | work results from an entity transaction, each party to that 440 | transaction who receives a copy of the work also receives whatever 441 | licenses to the work the party's predecessor in interest had or could 442 | give under the previous paragraph, plus a right to possession of the 443 | Corresponding Source of the work from the predecessor in interest, if 444 | the predecessor has it or can get it with reasonable efforts. 445 | 446 | You may not impose any further restrictions on the exercise of the 447 | rights granted or affirmed under this License. For example, you may 448 | not impose a license fee, royalty, or other charge for exercise of 449 | rights granted under this License, and you may not initiate litigation 450 | (including a cross-claim or counterclaim in a lawsuit) alleging that 451 | any patent claim is infringed by making, using, selling, offering for 452 | sale, or importing the Program or any portion of it. 453 | 454 | ### 11. Patents. 455 | 456 | A "contributor" is a copyright holder who authorizes use under this 457 | License of the Program or a work on which the Program is based. The 458 | work thus licensed is called the contributor's "contributor version". 459 | 460 | A contributor's "essential patent claims" are all patent claims owned 461 | or controlled by the contributor, whether already acquired or 462 | hereafter acquired, that would be infringed by some manner, permitted 463 | by this License, of making, using, or selling its contributor version, 464 | but do not include claims that would be infringed only as a 465 | consequence of further modification of the contributor version. For 466 | purposes of this definition, "control" includes the right to grant 467 | patent sublicenses in a manner consistent with the requirements of 468 | this License. 469 | 470 | Each contributor grants you a non-exclusive, worldwide, royalty-free 471 | patent license under the contributor's essential patent claims, to 472 | make, use, sell, offer for sale, import and otherwise run, modify and 473 | propagate the contents of its contributor version. 474 | 475 | In the following three paragraphs, a "patent license" is any express 476 | agreement or commitment, however denominated, not to enforce a patent 477 | (such as an express permission to practice a patent or covenant not to 478 | sue for patent infringement). To "grant" such a patent license to a 479 | party means to make such an agreement or commitment not to enforce a 480 | patent against the party. 481 | 482 | If you convey a covered work, knowingly relying on a patent license, 483 | and the Corresponding Source of the work is not available for anyone 484 | to copy, free of charge and under the terms of this License, through a 485 | publicly available network server or other readily accessible means, 486 | then you must either (1) cause the Corresponding Source to be so 487 | available, or (2) arrange to deprive yourself of the benefit of the 488 | patent license for this particular work, or (3) arrange, in a manner 489 | consistent with the requirements of this License, to extend the patent 490 | license to downstream recipients. "Knowingly relying" means you have 491 | actual knowledge that, but for the patent license, your conveying the 492 | covered work in a country, or your recipient's use of the covered work 493 | in a country, would infringe one or more identifiable patents in that 494 | country that you have reason to believe are valid. 495 | 496 | If, pursuant to or in connection with a single transaction or 497 | arrangement, you convey, or propagate by procuring conveyance of, a 498 | covered work, and grant a patent license to some of the parties 499 | receiving the covered work authorizing them to use, propagate, modify 500 | or convey a specific copy of the covered work, then the patent license 501 | you grant is automatically extended to all recipients of the covered 502 | work and works based on it. 503 | 504 | A patent license is "discriminatory" if it does not include within the 505 | scope of its coverage, prohibits the exercise of, or is conditioned on 506 | the non-exercise of one or more of the rights that are specifically 507 | granted under this License. You may not convey a covered work if you 508 | are a party to an arrangement with a third party that is in the 509 | business of distributing software, under which you make payment to the 510 | third party based on the extent of your activity of conveying the 511 | work, and under which the third party grants, to any of the parties 512 | who would receive the covered work from you, a discriminatory patent 513 | license (a) in connection with copies of the covered work conveyed by 514 | you (or copies made from those copies), or (b) primarily for and in 515 | connection with specific products or compilations that contain the 516 | covered work, unless you entered into that arrangement, or that patent 517 | license was granted, prior to 28 March 2007. 518 | 519 | Nothing in this License shall be construed as excluding or limiting 520 | any implied license or other defenses to infringement that may 521 | otherwise be available to you under applicable patent law. 522 | 523 | ### 12. No Surrender of Others' Freedom. 524 | 525 | If conditions are imposed on you (whether by court order, agreement or 526 | otherwise) that contradict the conditions of this License, they do not 527 | excuse you from the conditions of this License. If you cannot convey a 528 | covered work so as to satisfy simultaneously your obligations under 529 | this License and any other pertinent obligations, then as a 530 | consequence you may not convey it at all. For example, if you agree to 531 | terms that obligate you to collect a royalty for further conveying 532 | from those to whom you convey the Program, the only way you could 533 | satisfy both those terms and this License would be to refrain entirely 534 | from conveying the Program. 535 | 536 | ### 13. Remote Network Interaction; Use with the GNU General Public License. 537 | 538 | Notwithstanding any other provision of this License, if you modify the 539 | Program, your modified version must prominently offer all users 540 | interacting with it remotely through a computer network (if your 541 | version supports such interaction) an opportunity to receive the 542 | Corresponding Source of your version by providing access to the 543 | Corresponding Source from a network server at no charge, through some 544 | standard or customary means of facilitating copying of software. This 545 | Corresponding Source shall include the Corresponding Source for any 546 | work covered by version 3 of the GNU General Public License that is 547 | incorporated pursuant to the following paragraph. 548 | 549 | Notwithstanding any other provision of this License, you have 550 | permission to link or combine any covered work with a work licensed 551 | under version 3 of the GNU General Public License into a single 552 | combined work, and to convey the resulting work. The terms of this 553 | License will continue to apply to the part which is the covered work, 554 | but the work with which it is combined will remain governed by version 555 | 3 of the GNU General Public License. 556 | 557 | ### 14. Revised Versions of this License. 558 | 559 | The Free Software Foundation may publish revised and/or new versions 560 | of the GNU Affero General Public License from time to time. Such new 561 | versions will be similar in spirit to the present version, but may 562 | differ in detail to address new problems or concerns. 563 | 564 | Each version is given a distinguishing version number. If the Program 565 | specifies that a certain numbered version of the GNU Affero General 566 | Public License "or any later version" applies to it, you have the 567 | option of following the terms and conditions either of that numbered 568 | version or of any later version published by the Free Software 569 | Foundation. If the Program does not specify a version number of the 570 | GNU Affero General Public License, you may choose any version ever 571 | published by the Free Software Foundation. 572 | 573 | If the Program specifies that a proxy can decide which future versions 574 | of the GNU Affero General Public License can be used, that proxy's 575 | public statement of acceptance of a version permanently authorizes you 576 | to choose that version for the Program. 577 | 578 | Later license versions may give you additional or different 579 | permissions. However, no additional obligations are imposed on any 580 | author or copyright holder as a result of your choosing to follow a 581 | later version. 582 | 583 | ### 15. Disclaimer of Warranty. 584 | 585 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 586 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 587 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 588 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 589 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 590 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 591 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 592 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 593 | CORRECTION. 594 | 595 | ### 16. Limitation of Liability. 596 | 597 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 598 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 599 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 600 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 601 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 602 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 603 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 604 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 605 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 606 | 607 | ### 17. Interpretation of Sections 15 and 16. 608 | 609 | If the disclaimer of warranty and limitation of liability provided 610 | above cannot be given local legal effect according to their terms, 611 | reviewing courts shall apply local law that most closely approximates 612 | an absolute waiver of all civil liability in connection with the 613 | Program, unless a warranty or assumption of liability accompanies a 614 | copy of the Program in return for a fee. 615 | 616 | END OF TERMS AND CONDITIONS 617 | 618 | ## How to Apply These Terms to Your New Programs 619 | 620 | If you develop a new program, and you want it to be of the greatest 621 | possible use to the public, the best way to achieve this is to make it 622 | free software which everyone can redistribute and change under these 623 | terms. 624 | 625 | To do so, attach the following notices to the program. It is safest to 626 | attach them to the start of each source file to most effectively state 627 | the exclusion of warranty; and each file should have at least the 628 | "copyright" line and a pointer to where the full notice is found. 629 | 630 | 631 | Copyright (C) 632 | 633 | This program is free software: you can redistribute it and/or modify 634 | it under the terms of the GNU Affero General Public License as 635 | published by the Free Software Foundation, either version 3 of the 636 | License, or (at your option) any later version. 637 | 638 | This program is distributed in the hope that it will be useful, 639 | but WITHOUT ANY WARRANTY; without even the implied warranty of 640 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 641 | GNU Affero General Public License for more details. 642 | 643 | You should have received a copy of the GNU Affero General Public License 644 | along with this program. If not, see . 645 | 646 | Also add information on how to contact you by electronic and paper 647 | mail. 648 | 649 | If your software can interact with users remotely through a computer 650 | network, you should also make sure that it provides a way for users to 651 | get its source. For example, if your program is a web application, its 652 | interface could display a "Source" link that leads users to an archive 653 | of the code. There are many ways you could offer source, and different 654 | solutions will be better for different programs; see section 13 for 655 | the specific requirements. 656 | 657 | You should also get your employer (if you work as a programmer) or 658 | school, if any, to sign a "copyright disclaimer" for the program, if 659 | necessary. For more information on this, and how to apply and follow 660 | the GNU AGPL, see . 661 | --------------------------------------------------------------------------------