ClosedLess/Microsoft-Edge-Updater
ClosedLess/Microsoft-Edge-Updater
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated common

Browse Source 
Changed comments and preamble of script.

'backup_file' variable in 'restore_function' is now global to allow for
removal of backup archive if the restoration was successful.
This commit is contained in:
Ethan Smith-Coss 2021-06-22 17:16:09 +01:00
parent 3ee9ca3936
commit a2fcbb0512
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
utils/common
View File

@ -3,13 +3,15 @@
# common - Utility file with common functions for updater #
# #
# Dependencies: #
# bash #
# coreutils (>=8.32) #
# tar #
# #
# #
# Author: Ethan Smith-Coss #
# Version: 0.1.4 #
# Created: 2021-05-20T16:47+0100 #
# Last Modified: 2021-06-21T15:06+0100 #
# Last Modified: 2021-06-22T16:57+0100 #
# #
# #################################### #
# #
@ -31,6 +33,7 @@
# #
#########################################################################
# logging function called to log information to a file.
function log {
local log_out=$(realpath "${0%/*}/.log.1")
[[ $# -eq 0 ]] && log "ERROR" "Log function was called without any arguments. Returning 1." "$log_out" && return 1
@ -41,6 +44,7 @@ function log {
return 0
}
# archive function used to create an archive compression of Microsoft Edge
function archive_system {
local log_out=$(realpath "${0%/*}/.log.1")
[[ -e $1 ]] && log "ERROR" "Archive function was called without any arguments." "$log_out"
@ -48,10 +52,11 @@ function archive_system {
local archive_output="/tmp/microsoft-edge-autoupdater/$(echo $1 | sed 's/\//_/').tar.gz"
[[ -f "$archive_output" ]] && return 0
## identify the files required for compressing
usr_files="$(grep -E '^usr/.*beta.*$' "/tmp/microsoft-edge-autoupdater/Contents-amd64" | awk '{print "/" $1}')"
opt_files="$(ls -1 "/opt/$1/" | sed -E "s/^(.*)$/\/opt\/"$(echo $1 | sed 's/\//\\\//')"\/\1/g")"
## :@Ethan: we need to identify all the symlinked files and store them in a record. When we decompress we reinstate the symlinks.
## This file is included in the archive and tar will dereference symlink files.
### :@Ethan: we need to identify all the symlinked files and store them in a record. When we decompress we reinstate the symlinks.
## This file is only stored temporarily and any symlinks will be removed from the identified files for compression.
symlink_record="/tmp/microsoft-edge-autoupdater/symlink-record"
ls -l $opt_files $usr_files | grep -Eo ':.*->.*$' | sed 's/\s->\s/:/g' | cut -d' ' -f2- > "$symlink_record"
@ -62,6 +67,7 @@ function archive_system {
[[ "$record" =~ \/opt\/ ]] && record=$(echo $record | sed 's/\//\\\//g') && opt_files=$(echo "$opt_files" | sed "s/^"$record"$//")
done < <(cat $symlink_record)
## use gzip compression to create the tarball archive
tar --overwrite -czf "$archive_output" $opt_files $usr_files > "/tmp/microsoft-edge-autoupdater/tar_dump.log" 2>>"$log_out"
exit_code=$?
[[ ! $exit_code -eq 0 ]] && { log "ERROR" "(Archive) There was an issue creating the archive file of system. Returning...(10)" "$log_out" ; return 10 ; }
@ -69,23 +75,26 @@ function archive_system {
return 0
}
# restoration function called at any point when the update fails during an installation process.
function restore_files {
local log_out=$(realpath "${0%/*}/.log.1")
[[ -e $1 ]] && log "ERROR" "Restore function was called without any arguments." "$log_out"
local backup_file="/tmp/microsoft-edge-autoupdater/$1.tar.gz"
backup_file="/tmp/microsoft-edge-autoupdater/$1.tar.gz"
[[ ! -f "$backup_file" ]] && { log "ERROR" "There is no backup of Microsoft Edge (Beta) identified. Restoration not possible." "$log_out" ; return 12 ; }
## decompress the tarball archive using gzip and overwrite all files in the archive on the system
tar --overwrite -xzf "$backup_file" -C "/" > "/tmp/microsoft-edge-autoupdater/tar_dump.log" 2>>"$log_out"
exit_code=$?
[[ ! $exit_code -eq 0 ]] && { log "ERROR" "There was an issue restoring pervious files to system." \
"The backup created will not be removed to allow for manual restoration. Returning...(12)" ; return 12 ; }
## recreate the symlinks
log "DEBUG" "Re-establishing symlinks..." "$log_out"
symlink_record="/tmp/microsoft-edge-autoupdater/symlink-record"
while read -r record ; do
symlink="$(echo $record | cut -d':' -f1)"
symlink_to="$(echo $record | cut -d':' -f2)"
## :NOTE: symlinks may already exist from new update and theoretically could be different in a newer version. Remove them first
### :NOTE: symlinks may already exist from new update and theoretically could be different in a newer version. Remove them first
rm "$symlink"
## create new sylinks based on the restored files
ln -s "$symlink_to" "$symlink" >/dev/null 2>>"$log_out"
@ -98,8 +107,8 @@ function restore_files {
return 0
}
# notification function used to send the user a notification via the dbus
function notify {
## :@TODO: implement notification system.
local log_out=$(realpath "${0%/*}/.log.1")
[[ $# -eq 0 ]] && log "ERROR" "Notify function was called without any arguments. Returning 1." "$log_out" && return 1
[[ ! $# -eq 2 ]] && log "ERROR" "Notify function expected at least 2 arguments, recieved $#. Returning 1." "$log_out" && return 1