#!/bin/bash
#
# Zusammenfassung
# ===============
# Dieses Skripts erzeugt fortlaufende inkrementelle hardlink-basierte Backups
# wichtiger persoenlicher Daten auf einer oder mehreren externen Festplatten.
#
# Zusaetzlich werden noch Systeminformationen wie die Partitionierung aller
# angeschlossenen Festplatten und deren aktuellen SMART-Werte sichert. Damit
# kann das Skript nach jedem Durchlauf die Aenderungen der SMART-Werte zeigen
# und der Ausfall von Backup-Festplatten laesst sich fruehzeitig erkennen.
#
# Das Skript ist ausfuehrlich unter https://www.carstengrohmann.de/backup.html
# beschrieben.
#
# Copyright & Lizenz
# ==================
# The MIT License (MIT)
# Copyright (c) 2013-2024 Carsten Grohmann
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# Aenderungsprotokoll
# ===================
#
# Version 3 - 2024-07-20
#   - Hardlinks mit "rsync --link-dest" statt "cp -al" erzeugen
#
# Version 2 - 2018-07-05
#   - Erkennung umbenannter Dateien durch rsync --fuzzy
#
# Version 1 - 2016-04-15
#   - erste veroeffentlichte Version

VERSION="3"

# Basisverzeichnis fuer alle Backupverzeichnisse
BASE_DIR="/media/disk"

# Listen mit Dateimustern, die ins Backup sollen oder auch nicht
FILE_EXCLUDE_PATTERN="/root/bin/backup.excl"
FILE_INCLUDE_PATTERN="/root/bin/backup.incl"

# Kommando um die Paketliste zu erzeugen
# für RPM-basierte Systeme: rpm -qa --last
# für ArchLinux:            pacman -Qqen
# für Debin:                dpkg --get-selections
CMD_PKG_LIST="pacman -Qqen"

# Backup-Partition komplett lesend pruefen
# Zum Deaktivieren den Wert einfach auskommentieren
#RUN_DD="ja"

# Zusaetzliche Optionen fuer rsync:
# --checksum - rsync jede Datei bitweise, das ist langsam, aber das Backup
#              ist danach 100% korrekt und lesbar
#RSYNC_OPTS="--checksum"

#
# ==== KEINE AENDERUNGEN UNTERHALT DIESER ZEILE ====
#

#set -x
shopt -s nullglob

echo
echo "-= $(basename $0) - Version $VERSION =-"
echo "(c) 2013-2024 Carsten Grohmann"
echo

# Heutiges Datum als Path fuers heutige Backup
NEW_DIR="$BASE_DIR/$(date +%Y%m%d)"

# Verzeichnis fuer Statusinformationen zum System, wie Partitionierung und
# SMART-Daten
STAT_DIR="$NEW_DIR/status"

# Letztes Backup
PREVIOUS_DIR=$(find $BASE_DIR -maxdepth 1 -type d | sort | tail -n 1)

# Pfade pruefen
fgrep -q "$BASE_DIR" /proc/mounts 2>/dev/null
if [ $? -ne 0 ]; then
  echo "FEHLER: Das Basisverzeichnis fuer alle Backups $BASE_DIR ist kein"
  echo "        Mount."
  exit 1
fi

if [ ! -d "$PREVIOUS_DIR" ]; then
  echo "FEHLER: Verzeichnis der letzten Sicherung $PREVIOUS_DIR existiert"
  echo "        nicht oder es ist kein Verzeichnis."
  exit 1
fi

if [ -d "$NEW_DIR" ]; then
  echo "FEHLER: Das Verzeichnis fuer die neue Sicherung $NEW_DIR existiert"
  echo "        schon."
  exit 1
fi

if [ "$PREVIOUS_DIR" = "$NEW_DIR" ]; then
  echo "FEHLER: Das Verzeichnis fuer die neue Sicherung $NEW_DIR ist auch"
  echo "        das Verzeichnis der letzten Sicherung."
  exit 1
fi

if [ "$PREVIOUS_DIR" = "$BASE_DIR" ]; then
  echo "FEHLER: Es wurde keine vorhergehende Sicherung gefunden."
  echo "        Legen Sie zwischenzeitlich ein leeres Verzeichnis mit "
  echo "        \"mkdir $BASE_DIR/19700101\" an, um eine neue Backupserie zu"
  echo "        starten. Sie koennen das Verzeichnis nach dem ersten Backup"
  echo "        mit \"rmdir $BASE_DIR/19700101\" wieder loeschen, da es nach"
  echo "        dem ersten Backup nicht mehr benoetigt wird."
  exit 1
fi

echo
echo "Sichere alle Aenderungen zwischen der letzten Sicherung in"
echo "$PREVIOUS_DIR und jetzt."
echo
echo "Die neue Sicherung erfolgt nach $NEW_DIR"
echo
echo "Zu sichernde Dateien und Verzeichnisse:       $FILE_INCLUDE_PATTERN"
echo "Nicht zu sichernde Dateien und Verzeichnisse: $FILE_EXCLUDE_PATTERN"
echo
echo "Druecken Sie Enter zum Fortfahren oder Strg+C zum Abbrechen"
read unused

echo
echo "Schritt 1: Neues Backupverzeichnis anlegen ..."
echo "=============================================="
mkdir "$NEW_DIR"
if [ $? -ne 0 ]; then
  echo "FEHLER: Konnte Verzeichnis $NEW_DIR nicht erzeugen."
  exit 1
fi

echo
echo "Schritt 2: Sichere die Aenderungen seit dem letzten Backup mit rsync ..."
echo "========================================================================"
rsync  --archive \
       --verbose \
       --numeric-ids \
       --fuzzy \
       --delete-delay \
       --delete-excluded \
       --recursive \
       $RSYNC_OPTS \
       --link-dest="$PREVIOUS_DIR" \
       --files-from="$FILE_INCLUDE_PATTERN" \
       --exclude-from="$FILE_EXCLUDE_PATTERN" \
       / "$NEW_DIR"


# Rueckgabewert pruefen
# 0 = fehlerfrei
# 24 ist harmlos: tritt auf, wenn waehrend der Laufzeit von rsync Dateien
# geaendert oder geloescht wurden z.B. in /tmp oder /var/log.
# Alles andere ist fatal -- siehe man (1) rsync
res=$?
if [ $res -ne 24 ] && [ $res -ne 0 ] ; then
  echo "FEHLER: rsync beendete sich mit einem Fehler: $res"
  exit 1
fi

echo
echo "Schritt 3: Backup-Festplatte auf Lesefehler pruefen ..."
echo "======================================================="
echo
if [ "$RUN_DD" ]; then
  echo "Die Pruefung kann je nach Laufwerksgroesse etwas dauern ..."
  BACKUP_DEV="$(awk '$2 == mount { print $1 ; exit}' mount=$BASE_DIR /proc/mounts)"
  if [ "$BACKUP_DEV" ]; then
    dd if="$BACKUP_DEV" of=/dev/null bs=1M
    if [ $? -ne 0 ]; then
      echo "WARNUNG: Es trat ein Fehler beim Pruefen des Backup-Laufwerks"
      echo "         $BACKUP_DEV auf."
    fi
  else
    echo "HINWEIS: Das Backup-Laufwerk konnte nicht ermittelt werden."
    echo "         Die Pruefung wird daher uebersprungen."
  fi
else
  echo "Die Pruefung wurde nicht aktiviert und wird daher uebersprungen."
fi

echo
echo "Schritt 4: Informationen ueber die aktuellen Blockgeraete sichern ..."
echo "====================================================================="
if [ -d "$STAT_DIR" ]; then
  rm -rf "$STAT_DIR"
fi
mkdir "$STAT_DIR"

lsblk --list --output NAME,UUID,MODEL,SERIAL,WWN,VENDOR > "$STAT_DIR/block_devices"

for DEVICE_DIR in /sys/class/scsi_device/*/device; do
  # ignoriere alle Geraete, die keine Festplatten sind
  # grep TYPE_ /usr/include/scsi/scsi.h :-)
  DEVICE_TYPE=$(cat "$DEVICE_DIR/type")
  if [ "$DEVICE_TYPE" != "0" ]; then
    continue
  fi

  # Umwandeln von sys/class/scsi_device/*/device/block nach /dev/sda
  DEVICE="/dev/$(ls "$DEVICE_DIR/block")"

  # Eigenschaften des Geraetes als Variablen zur Verfuegung stellen
  eval $(lsblk --output NAME,UUID,MODEL,SERIAL,WWN,VENDOR --nodeps --pairs "$DEVICE")
  SUFFIX="$(echo ${MODEL}_${SERIAL} | tr ' ' '_')"
  PARTFILE="$STAT_DIR/partition.$SUFFIX"
  SMART_ERROR="$STAT_DIR/smart_error.$SUFFIX"
  SMART_ATTRS="$STAT_DIR/smart_attrs.$SUFFIX"

  echo
  echo "Infos zu $DEVICE \"$MODEL\", Seriennummer $SERIAL sichern ..."

  # Alte SMART-Attribute suchen ...
  OLD_SMART_ATTRS="$(echo $BASE_DIR/20*/status/smart_attrs.$SUFFIX | tr ' ' '\n' | sort | tail -n 1)"

  sfdisk --dump --unit S "$DEVICE" 2>/dev/null > "$PARTFILE"
  if [ ! -s "$PARTFILE" ]; then
    echo
    echo "HINWEIS: Partitionstabelle fuer $DEVICE"
    echo "         kann nicht ermittelt werden. Daher werden keine"
    echo "         Informationen ueber die Partitionierung dieses Geraetes"
    echo "         gesichert."
    rm "$PARTFILE"
    continue
  fi

  smartctl -l error "$DEVICE" > "$SMART_ERROR"
  if [ $? -ne 0 ]; then
    echo
    echo "WARNUNG: $DEVICE hat wahrscheinlich Fehler."
    echo "Details:"
    cat "$SMART_ERROR"
  fi
  smartctl -A "$DEVICE" > "$SMART_ATTRS"
  if [ $? -ne 0 ]; then
    echo
    echo "WARNUNG: $DEVICE hat wahrscheinlich Fehler."
    echo "Details:"
    cat "$SMART_ATTRS"
  fi

  # Kein Vergleich, wenn keine alten Werte vorliegen oder der Wert nur
  # das Suchmuster ist
  if [ ! "$OLD_SMART_ATTRS" ] || [ ! -e "$OLD_SMART_ATTRS" ]; then
    echo "HINWEIS: Es wurden keine alten SMART-Attribute fuer das Geraet"
    echo "         $DEVICE - \"$MODEL\" gefunden. Der Vergleich zwischen alten"
    echo "         und aktuellen Werten wird daher uebersprungen."
    continue
  fi

  DELTA="$(diff "$OLD_SMART_ATTRS" "$SMART_ATTRS")"
  if [ $? -eq 0 ]; then
    echo "HINWEIS: Keine Unterschiede in den SMART-Attributen gefunden."
    continue
  fi

  echo
  echo "Unterschiede in den SMART-Attributen anzeigen"
  echo "============================================="
  echo
  echo "Unterschiede der SMART-Attribute fuer $DEVICE - \"$MODEL\""
  echo "Vorherige Daten aus:  $OLD_SMART_ATTRS"
  echo "Aktuelle Daten aus:   $SMART_ATTRS"
  echo
  grep -A3 "START OF READ SMART DATA SECTION" "$SMART_ATTRS"
  echo "$DELTA"
done

if [ "$CMD_PKG_LIST" ]; then
  echo
  echo "Schritt 6: Liste aller installierten Pakete sichern ..."
  echo "======================================================="
  $CMD_PKG_LIST > "$STAT_DIR/packages"
fi

echo
echo "Das Backup nach $NEW_DIR wurde erfolgreich beendet."
