Skip to content

Commit

Permalink
GUI file chooser for win, separate functions, more
Browse files Browse the repository at this point in the history 
+ Android 11+ wireless backups
+ GUI file chooser for windows
+ separate functions into their own files
+ cleanup more stuff after restoring a backup
  • Loading branch information
@mrrfv
mrrfv committed Dec 31, 2022
1 parent bcbef05 commit 66a6987
Show file tree
Hide file tree
Showing 13 changed files with 20,795 additions and 269 deletions.
3 changes: 2 additions & 1 deletion backup-windows.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Write-Output .
pause
Write-Output "Installing dependencies and setting up environment..."
wsl sudo apt update
wsl sudo apt install p7zip-full curl bc dos2unix pv -y
wsl sudo apt install p7zip-full curl bc dos2unix pv kdialog -y
Write-Output "Converting files - this may take several minutes..."
wsl bash -c "sudo find ./ -type f -print0 | sudo xargs -0 dos2unix --"
Clear-Host
Write-Output "Ready to run the backup script."
Expand Down
278 changes: 12 additions & 266 deletions backup.sh
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/env bash
set -e

# Load Inquirer.sh
SOURCE="${BASH_SOURCE[0]}"
while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
Expand All @@ -10,90 +9,13 @@ while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symli
done
DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"

PARENT_DIR=$(dirname "$DIR")
# Load Inquirer.sh
source $DIR/inquirer-sh/list_input.sh
source $DIR/inquirer-sh/text_input.sh
# ---

# Helper functions
function wait_for_enter() {
if [ ! -v unattended_mode ]; then
read -p "" </dev/tty
else
sleep 5s
fi
}

# "cecho" makes output messages yellow, if possible
function cecho() {
if [ ! -v CI ]; then
echo "$(tput setaf 11)$1$(tput init)"
else
echo "$1"
fi
}

function check_adb_connection() {
cecho "Please enable developer options on your device, connect it to your computer and set it to file transfer mode. Then, press Enter to continue."
wait_for_enter
adb devices > /dev/null
cecho "If you have connected your device correctly, you should now see a message asking for access to your phone. Allow it, then press Enter to go to the last step."
cecho "Tip: If this is not the first time you're using this script, you might not need to allow anything."
wait_for_enter
adb devices
cecho "Can you see your device in the list above, and does it say 'device' next to it? If not, quit this script (ctrl+c) and try again."
}

function uninstall_companion_app() {
cecho "Attempting to uninstall companion app."
{
set +e
adb uninstall com.example.companion_app
set -e
} &> /dev/null
}

function retry() {
local -r -i max_attempts="$1"; shift
local -i attempt_num=1
until "$@"
do
if ((attempt_num==max_attempts))
then
echo "Attempt $attempt_num failed and there are no more attempts left!"
return 1
else
echo "Attempt $attempt_num failed! Trying again in $attempt_num seconds..."
sleep $((attempt_num++))
fi
done
}

# Usage: get_file <directory> <file> <destination>
function get_file() {
if [ "$export_method" = 'tar' ]; then
(adb exec-out "tar -c -C $1 $2 2> /dev/null" | pv -p --timer --rate --bytes | tar -C "$3" -xf -) || cecho "Errors occurred while backing up $2 - this file (or multiple files) might've been ignored." 1>&2
else # we're falling back to adb pull if the variable is empty/unset
adb pull "$1"/"$2" "$3" || cecho "Errors occurred while backing up $2 - this file (or multiple files) might've been ignored." 1>&2
fi
}

# Usage: directory_ok <directory>
# Returns 0 (true) or 1 (false)
function directory_ok() {
if [ ! -d "$1" ]; then
cecho "Can't find directory '$1'"
echo "Please re-enter the path, or hit ^C to exit"
return 1
fi
if [ ! -w "$1" ]; then
cecho "No write permission for directory '$1'"
echo "Please enter a new path, or hit ^C to exit"
return 1
fi
return 0
}
# ---
# Load all functions in ./functions
for f in $DIR/functions/*; do source "$f"; done

check_adb_connection

Expand All @@ -103,23 +25,8 @@ if [ ! -v mode ]; then
fi

if [ "$mode" = 'Wireless' ]; then
cecho "Warnings:"
cecho "1. Wireless backups are experimental and might not work on all devices."
cecho "2. Your computer and phone need to be connected to the same WiFi network."
cecho "3. Keep your phone connected to the PC until the connection is established."
cecho "Press Enter to continue."
wait_for_enter

cecho "Establishing connection..."
adb tcpip 5353
sleep 5
adb connect "$(adb shell ip addr show wlan0 | grep 'inet ' | cut -d ' ' -f 6 | cut -d / -f 1):5353"

cecho "Please unplug your device from the computer, and press Enter to continue."
wait_for_enter
adb devices
cecho "If you can see an IP address in the list above, and it says 'device' next to it, then you have successfully established a connection to the phone."
cecho "If it says 'unauthorized' or similar, then you need to unlock your device and approve the connection before continuing."
# See ./functions/wireless_connection.sh
wireless_connection
fi

if [ ! -v export_method ]; then
Expand Down Expand Up @@ -150,189 +57,28 @@ elif [ "$use_hooks" = "yes" ]; then
exit 1
fi


if [ ! -v selected_action ]; then
actions=( 'Backup' 'Restore' )
list_input "What do you want to do?" actions selected_action
fi

# The companion app is required regardless of whether we're backing up the device or not,
# so we're installing it before the if statement
cecho "Linux Android Backup will install a companion app on your device, which will allow for contacts to be backed up and restored."
cecho "The companion app is open-source, and you can see what it's doing under the hood on GitHub."
if [ ! -f linux-android-backup-companion.apk ]; then
cecho "Downloading companion app."
# -L makes curl follow redirects
curl -L -o linux-android-backup-companion.apk https://github.com/mrrfv/linux-android-backup/releases/download/latest/app-release.apk
else
cecho "Companion app already downloaded."
fi
uninstall_companion_app
cecho "Installing companion app."
adb install -r linux-android-backup-companion.apk
cecho "Granting required permissions to companion app."
permissions=(
'android.permission.READ_CONTACTS'
'android.permission.WRITE_CONTACTS'
'android.permission.READ_EXTERNAL_STORAGE'
)
# Grant permissions
for permission in "${permissions[@]}"; do
adb shell pm grant com.example.companion_app "$permission" || cecho "Couldn't assign permission $permission to the companion app - this is not a fatal error, and you will just have to allow this permission in the app." 1>&2
done
# See ./functions/install_companion_app.sh
install_companion_app

if [ -d backup-tmp ]; then
cecho "Cleaning up after previous backup/restore..."
rm -rfv backup-tmp
fi
remove_backup_tmp

mkdir backup-tmp

if [ "$selected_action" = 'Backup' ]
then
while true; do
if [ ! -v archive_path ]; then
echo "Note: Backups will first be made on the drive this script is located in, and then will be copied to the specified location."
text_input "Please enter the backup location. Enter '.' for the current working directory." archive_path "."
fi
directory_ok "$archive_path" && break
unset archive_path
done

adb shell am start -n com.example.companion_app/.MainActivity
cecho "The companion app has been opened on your device. Please press the 'Export Data' button - this will export contacts to the internal storage, allowing this script to backup them. Press Enter to continue."
wait_for_enter
uninstall_companion_app # we're uninstalling it so that it isn't included in the backup

# Export apps (.apk files)
cecho "Exporting apps."
mkdir -p backup-tmp/Apps
for app in $(adb shell pm list packages -3 -f)
# -f: see their associated file
# -3: filter to only show third party packages
do
declare output=backup-tmp/Apps
(
apk_path=${app%=*} # apk path on device
apk_path=${apk_path/package:} # stip "package:"
apk_base=$RANDOM$RANDOM$RANDOM$RANDOM.apk # base apk name
# e.g.:
# app=package:/data/app/~~4wyPu0QoTM3AByZS==/com.whatsapp-iaTC9-W1lyR1FxO==/base.apk=com.whatsapp
# apk_path=/data/app/~~4wyPu0QoTM3AByZS==/com.whatsapp-iaTC9-W1lyR1FxO==/base.apk
# apk_base=47856542.apk
get_file "$(dirname "$apk_path")" "$(basename "$apk_path")" ./backup-tmp/Apps
mv "./backup-tmp/Apps/$(basename "$apk_path")" "./backup-tmp/Apps/$apk_base" || cecho "Couldn't find app $(basename "$apk_path") after exporting from device - ignoring." 1>&2
)
done

# Export contacts
cecho "Exporting contacts (as vCard)."
mkdir ./backup-tmp/Contacts
get_file /storage/emulated/0/linux-android-backup-temp . ./backup-tmp/Contacts
cecho "Removing temporary files created by the companion app."
adb shell rm -rf /storage/emulated/0/linux-android-backup-temp

# Export internal storage. We're not using adb pull due to reliability issues
cecho "Exporting internal storage - this will take a while."
mkdir ./backup-tmp/Storage
get_file /storage/emulated/0 . ./backup-tmp/Storage

# Run the third-party backup hook, if enabled.
if [ "$use_hooks" = "yes" ] && [ "$(type -t backup_hook)" == "function" ]; then
cecho "Running backup hooks in 5 seconds."
sleep 5
backup_hook
elif [ "$use_hooks" = "yes" ] && [ ! "$(type -t backup_hook)" == "function" ]; then
cecho "WARNING! Hooks are enabled, but the backup hook hasn't been found in hooks.sh."
cecho "Skipping in 5 seconds."
sleep 5
fi

# All data has been collected and the phone can now be unplugged
cecho "---"
cecho "All required data has been copied from your device and it can now be unplugged."
cecho "---"
sleep 2

# Compress
cecho "Compressing & encrypting data - this will take a while."
# -p: encrypt backup
# -mhe=on: encrypt headers (metadata)
# -mx=9: ultra compression
# -bb3: verbose logging
# -sdel: delete files after compression
# The undefined variable is set by the user
declare backup_archive="$archive_path/linux-android-backup-$(date +%m-%d-%Y-%H-%M-%S).7z"
retry 5 7z a -p"$archive_password" -mhe=on -mx=9 -bb3 -sdel "$backup_archive" backup-tmp/*

if [ "$use_hooks" = "yes" ] && [ "$(type -t after_backup_hook)" == function ]; then
cecho "Running after backup hook in 5 seconds."
sleep 5
after_backup_hook
elif [ "$use_hooks" = "yes" ] && [ ! "$(type -t after_backup_hook)" == function ]; then
cecho "WARNING! Hooks are enabled, but an after backup hook hasn't been found in hooks.sh."
cecho "Skipping in 5 seconds."
sleep 5
fi

cecho "Backed up successfully."
rm -rf backup-tmp > /dev/null
# See ./functions/backup_func.sh
backup_func
elif [ "$selected_action" = 'Restore' ]
then
if [ ! -v archive_path ]; then
text_input "Please provide the location of the backup archive to restore (drag-n-drop):" archive_path
fi

if [ ! -f "$archive_path" ]; then
cecho "The specified backup location doesn't exist or isn't a file."
exit 1
fi

cecho "Extracting archive."
7z x "$archive_path" # -obackup-tmp isn't needed

# Restore applications
cecho "Restoring applications."
# We don't want a single app to break the whole script
set +e
if [[ $(grep microsoft /proc/version) ]]; then
cecho "Windows/WSL detected"
find ./backup-tmp/Apps -type f -name "*.apk" -exec ./windows-dependencies/adb.exe install {} \;
else
cecho "macOS/Linux detected"
find ./backup-tmp/Apps -type f -name "*.apk" -exec adb install {} \;
fi
set -e

# TODO: use tar to restore data to internal storage instead of adb push

# Restore internal storage
cecho "Restoring internal storage."
adb push ./backup-tmp/Storage/* /storage/emulated/0

# Restore contacts
cecho "Pushing backed up contacts to device."
adb push ./backup-tmp/Contacts /storage/emulated/0/Contacts_Backup

adb shell am start -n com.example.companion_app/.MainActivity
cecho "The companion app has been opened on your device. Please press the 'Auto-restore contacts' button - this will import your contacts to the device's contact database. Press Enter to continue."
wait_for_enter

# Run the third-party restore hook, if enabled.
if [ "$use_hooks" = "yes" ] && [ "$(type -t restore_hook)" == function ]; then
cecho "Running restore hook in 5 seconds."
sleep 5
restore_hook
elif [ "$use_hooks" = "yes" ] && [ ! "$(type -t restore_hook)" == function ]; then
cecho "WARNING! Hooks are enabled, but the restore hook hasn't been found in hooks.sh."
cecho "Skipping in 5 seconds."
sleep 5
fi

cecho "Cleaning up..."
adb shell rm -rfv /storage/emulated/0/Contacts_Backup

cecho "Data restored!"
# See ./functions/restore_func.sh
restore_func
fi

if [ "$mode" = 'Wireless' ]; then
Expand Down
Loading

0 comments on commit 66a6987

Please sign in to comment.