Assorted consistency tweaks

Author: XhmikosR

.shellcheckrc

@@ -0,0 +1 @@
+enable=require-variable-braces

build-packages.sh

@@ -1,41 +1,44 @@
 #!/usr/bin/env bash
 
 # Exit the script if any of the commands fail
-set -e
-set -u
-set -o pipefail
+set -euo pipefail
 
 # Set working directory to the location of this script
 cd "$(dirname "${BASH_SOURCE[0]}")"
 
 STARTDIR="$(pwd)"
-DESTDIR="$STARTDIR/pkg"
-OUTDIR="$STARTDIR/deb"
+DESTDIR="${STARTDIR}/pkg"
+OUTDIR="${STARTDIR}/deb"
 # get version
 repo="azlux/log2ram"
-api=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq ".[0]")
-new=$(echo $api | grep -Po '"tag_name": "\K.*?(?=")')
+api=$(curl -sSfL --compressed "https://api.github.com/repos/${repo}/releases" | jq ".[0]")
+new=$(echo "${api}" | grep -Po '"tag_name": "\K.*?(?=")')
+
+if [[ -z "${new}" ]]; then
+    echo "Error: Failed to fetch release version from GitHub."
+    exit 1
+fi
 
 # Remove potential leftovers from a previous build
-rm -rf "$DESTDIR" "$OUTDIR"
+rm -rf "${DESTDIR}" "${OUTDIR}"
 
 ## log2ram
 # Create directory
-install -Dm 644 "$STARTDIR/log2ram.service" "$DESTDIR/etc/systemd/system/log2ram.service"
-install -Dm 644 "$STARTDIR/log2ram-daily.service" "$DESTDIR/etc/systemd/system/log2ram-daily.service"
-install -Dm 644 "$STARTDIR/log2ram-daily.timer" "$DESTDIR/etc/systemd/system/log2ram-daily.timer"
-install -Dm 755 "$STARTDIR/log2ram" "$DESTDIR/usr/local/bin/log2ram"
-install -Dm 644 "$STARTDIR/log2ram.conf" "$DESTDIR/etc/log2ram.conf"
-install -Dm 644 "$STARTDIR/uninstall.sh" "$DESTDIR/usr/local/bin/uninstall-log2ram.sh"
+install -Dm 644 "${STARTDIR}/log2ram.service" "${DESTDIR}/etc/systemd/system/log2ram.service"
+install -Dm 644 "${STARTDIR}/log2ram-daily.service" "${DESTDIR}/etc/systemd/system/log2ram-daily.service"
+install -Dm 644 "${STARTDIR}/log2ram-daily.timer" "${DESTDIR}/etc/systemd/system/log2ram-daily.timer"
+install -Dm 755 "${STARTDIR}/log2ram" "${DESTDIR}/usr/local/bin/log2ram"
+install -Dm 644 "${STARTDIR}/log2ram.conf" "${DESTDIR}/etc/log2ram.conf"
+install -Dm 644 "${STARTDIR}/uninstall.sh" "${DESTDIR}/usr/local/bin/uninstall-log2ram.sh"
 
 # logrotate
-install -Dm 644 "$STARTDIR/log2ram.logrotate" "$DESTDIR/etc/logrotate.d/log2ram"
+install -Dm 644 "${STARTDIR}/log2ram.logrotate" "${DESTDIR}/etc/logrotate.d/log2ram"
 
 # Build .deb
-mkdir "$DESTDIR/DEBIAN" "$OUTDIR"
-cp "$STARTDIR/debian/"* "$DESTDIR/DEBIAN/"
+mkdir "${DESTDIR}/DEBIAN" "${OUTDIR}"
+cp "${STARTDIR}/debian/"* "${DESTDIR}/DEBIAN/"
 
 # Set version
-sed -i "s/VERSION-TO-REPLACE/$new/" "$DESTDIR/DEBIAN/control"
+sed -i "s/VERSION-TO-REPLACE/${new}/" "${DESTDIR}/DEBIAN/control"
 
-dpkg-deb --build "$DESTDIR" "$OUTDIR"
+dpkg-deb --build "${DESTDIR}" "${OUTDIR}"

debian/postinst

@@ -1,16 +1,16 @@
 #!/usr/bin/env bash
+
 set -euo pipefail
 
 systemctl daemon-reload
 systemctl enable log2ram.service log2ram-daily.timer
 
-
 rm -f /etc/cron.daily/log2ram
 rm -f /etc/cron.hourly/log2ram
 
-if [ "$1" == "configure" ]; then
-	echo "#####         Reboot to activate log2ram         #####"
-	echo "##### edit /etc/log2ram.conf to configure options ####"
+if [[ "$1" == "configure" ]]; then
+    echo "#####         Reboot to activate log2ram         #####"
+    echo "##### edit /etc/log2ram.conf to configure options ####"
 fi
 
 exit 0

debian/preinst

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
-systemctl -q is-active log2ram.service  && systemctl stop log2ram.service
-systemctl -q is-active log2ram-daily.timer  && systemctl stop log2ram-daily.timer
+
+systemctl -q is-active log2ram.service && systemctl stop log2ram.service
+systemctl -q is-active log2ram-daily.timer && systemctl stop log2ram-daily.timer
+
 rm -rf /var/hdd.log
 
 exit 0

debian/prerm

@@ -1,12 +1,13 @@
 #!/usr/bin/env bash
+
 case "$1" in
-    upgrade)
-        [ -d  /run/systemd/system/ ] && systemctl stop log2ram.service log2ram-daily.timer
-        exit 0
-        ;;
-    *)
-        [ -d  /run/systemd/system/ ] && systemctl stop log2ram.service log2ram-daily.timer
-        [ -d  /run/systemd/system/ ] && systemctl disable log2ram.service log2ram-daily.timer
-        exit 0
-        ;;
+upgrade)
+    [[ -d /run/systemd/system/ ]] && systemctl stop log2ram.service log2ram-daily.timer
+    exit 0
+    ;;
+*)
+    [[ -d /run/systemd/system/ ]] && systemctl stop log2ram.service log2ram-daily.timer
+    [[ -d /run/systemd/system/ ]] && systemctl disable log2ram.service log2ram-daily.timer
+    exit 0
+    ;;
 esac

install.sh

@@ -1,28 +1,32 @@
 #!/usr/bin/env bash
 
-systemctl -q is-active log2ram && {
-    echo "ERROR: log2ram service is still running. Please run \"sudo systemctl stop log2ram\" to stop it."
-    exit 1
-}
-[ "$(id -u)" -eq 0 ] || {
+if [[ "$(id -u)" -ne 0 ]]; then
     echo "You need to be ROOT (sudo can be used)"
     exit 1
-}
+fi
+
+if systemctl -q is-active log2ram; then
+    echo "ERROR: log2ram service is still running. Please run \"sudo systemctl stop log2ram\" to stop it."
+    exit 1
+fi
 
 # log2ram
 mkdir -p /usr/local/bin/
 install -m 644 log2ram.service /etc/systemd/system/log2ram.service
 install -m 644 log2ram-daily.service /etc/systemd/system/log2ram-daily.service
 install -m 644 log2ram-daily.timer /etc/systemd/system/log2ram-daily.timer
+install -m 644 uninstall.sh /usr/local/bin/uninstall-log2ram.sh
 install -m 755 log2ram /usr/local/bin/log2ram
-if [ ! -f /etc/log2ram.conf ]; then
+
+# Install config if not already present
+if [[ ! -f /etc/log2ram.conf ]]; then
     install -m 644 log2ram.conf /etc/log2ram.conf
 fi
-install -m 644 uninstall.sh /usr/local/bin/uninstall-log2ram.sh
+
 systemctl enable log2ram.service log2ram-daily.timer
 
 # logrotate
-if [ -d /etc/logrotate.d ]; then
+if [[ -d /etc/logrotate.d ]]; then
     install -m 644 log2ram.logrotate /etc/logrotate.d/log2ram
 else
     echo "##### Directory /etc/logrotate.d does not exist. #####"
@@ -36,29 +40,30 @@ rm -rf /var/log.hdd
 rm -rf /var/hdd.log
 
 # Include config to check if size is enought (See below)
-source /etc/log2ram.conf
+# shellcheck disable=SC1091
+. /etc/log2ram.conf
 
 # Validates that the SIZE variable is defined in the log2ram configuration file.
 # Exits with an error message if the SIZE variable is not set, preventing further installation.
-if [ -z "$SIZE" ]; then
-  echo "ERROR: SIZE variable is not defined in /etc/log2ram.conf"
-  exit 1
+if [[ -z "${SIZE}" ]]; then
+    echo "ERROR: SIZE variable is not defined in /etc/log2ram.conf"
+    exit 1
 fi
 
 # Checks if the size of /var/log exceeds the specified SIZE threshold
 # Returns an error if the size check fails or if the directory cannot be measured
 # Exits the script with an error message if du command encounters issues
-if ! du_output=$(du -sh -t "$SIZE" /var/log 2>/dev/null); then
-  echo "ERROR: Failed to check size of /var/log"
-  exit 1
+if ! du_output=$(du -sh -t "${SIZE}" /var/log 2>/dev/null); then
+    echo "ERROR: Failed to check size of /var/log"
+    exit 1
 fi
 
 # Check if var SIZE is sufficient and show a warning when too small
-if [ -n "$du_output" ] ; then
-  echo 'WARNING: Variable SIZE in /etc/log2ram.conf is too small to store the /var/log!'
-  echo -n 'Actual size of /var/log is:'
-  du -sh /var/log
-  echo -e '\nPlease increase SIZE in /etc/log2ram.conf to avoid issues'
+if [[ -n "${du_output}" ]]; then
+    echo 'WARNING: Variable SIZE in /etc/log2ram.conf is too small to store the /var/log!'
+    echo -n 'Actual size of /var/log is:'
+    du -sh /var/log
+    echo -e '\nPlease increase SIZE in /etc/log2ram.conf to avoid issues'
 fi
 
 echo "#####         Reboot to activate log2ram         #####"