ashemsay · Gildas-GH · Feb 27, 2020 · Mar 2, 2020 · Mar 3, 2020 · Mar 4, 2020
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,5 @@
 *.sw*
 .vagrant
+*~
+*.sw[op]
+.DS_Store
diff --git a/README.md b/README.md
@@ -1,189 +1,40 @@
-# Restic for YunoHost
+<!--
+N.B.: This README was automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
+It shall NOT be edited by hand.
+-->
 
-[![Latest Version](https://img.shields.io/badge/version-0.12.0-green.svg?style=flat)](https://github.com/YunoHost-Apps/restic_ynh/releases)
-[![Status](https://img.shields.io/badge/status-testing-yellow.svg?style=flat)](https://github.com/YunoHost-Apps/restic_ynh/milestones)
-[![Integration level](https://dash.yunohost.org/integration/restic.svg)](https://dash.yunohost.org/appci/app/restic)
-[![GitHub license](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](https://raw.githubusercontent.com/YunoHost-Apps/restic_ynh/master/LICENSE)
-[![GitHub issues](https://img.shields.io/github/issues/YunoHost-Apps/restic_ynh.svg?style=flat)](https://github.com/YunoHost-Apps/restic_ynh/issues)
+<h1>
+  <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/restic.png" width="32px" alt="Logo of Restic">
+  Restic, packaged for YunoHost
+</h1>
 
-[![Install Restic with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=restic)
+Regularly create encrypted backups sent to another server using Restic
 
-> *This package allows you to install Restic quickly and simply on a YunoHost server.
-If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
+[![🌐 Official app website](https://img.shields.io/badge/Official_app_website-darkgreen?style=for-the-badge)](https://restic.net)
+[![Version: 0.18.1~ynh3](https://img.shields.io/badge/Version-0.18.1~ynh3-rgb(18,138,11)?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/restic/)
 
-## Overview
+<div align="center">
+<a href="https://apps.yunohost.org/app/restic"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
+<a href="https://github.com/YunoHost-Apps/restic_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
+</div>
 
-A [Restic](https://restic.net/) package for YunoHost (heavily inspired by [the Borg package](https://github.com/YunoHost-Apps/borg_ynh/)).
+## 📦 Developer info
 
-Restic is a backup tool that can make local and remote backups.
-This package uses restic to make backups to a sftp server.
-The package does not handle local backups yet but you can work around that by using the local sftp server as target server (see my comment [here](https://forum.yunohost.org/t/sauvegarde-yunohost-avec-restic/10275/33)).
+[![Automatic tests level](https://apps.yunohost.org/badge/cilevel/restic)](https://ci-apps.yunohost.org/ci/apps/restic/)
 
-## Usage
+🛠️ Upstream Restic repository: <https://github.com/restic/restic>
 
-If you want to backup your server A onto the server B.
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/restic_ynh/tree/testing).
 
-## Setup Restic app on Server A
-
-Firstly set up this app on the server A you want to backup:
-
-```
-$ yunohost app install https://github.com/YunoHost-Apps/restic_ynh
-Indicate the server where you want put your backups: serverb.domain.tld
-sftp port of your server (default: 22): 2222
-The directory where you want your backup repositories to be created in (default: ./): ./servera.domain.tld
-Indicate the ssh user to use to connect on this server: servera
-You are now about to define a new user password. The password should be at least 8 characters - though it is good practice to use longer password (i.e. a passphrase) and/or to use various kind of characters (uppercase, lowercase, digits and special characters).
-Indicate a strong passphrase, that you will keep preciously if you want to be able to use your backups:
-Would you like to backup your YunoHost configuration ? [yes | no] (default: yes):
-Would you like to backup mails and user home directory ? [yes | no] (default: yes):
-Which apps would you backup (list separated by comma or 'all') ? (default: all): gitlab,blogotext,sogo
-Allow backup method to temporarily use more space? [yes | no] (default: yes):
-Indicate the backup frequency (see systemd OnCalendar format) (default: *-*-* 0:15:00): *-*-* 0:05
-Indicate the backup check frequency (see systemd OnCalendar format) (default: Sat *-*-8..31 3:15:00):
-Indicate the complete backup check frequency (see systemd OnCalendar format) (default: Sun *-*-1..7 3:15:00):
-```
-
-You can schedule your backup by choosing an other frequency. Some example:
-
-Monthly :
-
-Weekly :
-
-Daily : Daily at midnight
-
-Hourly : Hourly o Clock
-
-Sat *-*-1..7 18:00:00 : The first saturday of every month at 18:00
-
-4:00 : Every day at 4 AM
-
-5,17:00 : Every day at 5 AM and at 5 PM
-
-See here for more info : https://wiki.archlinux.org/index.php/Systemd/Timers#Realtime_timer
-
-After each invocation an e-mail will be sent to root@yourdomain.tld with the execution log.
-
-Restic can check backups consistency and verify the actual backed up data has not been modified.
-If you use the default values for the backup checks frequencies, a full check will be made on the first day of each month and a simple check will be made on each one of the three remaining weeks of the month.
-
-At the end of the installation, the app displays the public_key and the user to give to the person who has access to the server B.
-
-You should now authorize the public key for user `servera` on server B by logging into server B with user `servera` and running:
-
-```
-mkdir ~/.ssh -p 2>/dev/null
-touch ~/.ssh/authorized_keys
-chmod u=rw,go= ~/.ssh/authorized_keys
-cat << EOPKEY >> ~/.ssh/authorized_keys
-<paste here the privakey displayed at the end of installation>
-EOPKEY
-```
-If you don't find the mail and you don't see the message in the log bar you can find the public_key with this command:
-```
-cat /root/.ssh/id_restic_ed25519.pub
-```
-
-## (Optional) set sftp jail on server B
-
-To improve security, make sure user `servera` can only do sftp and can only access his home directory on server B.
-This is how you would do it on Debian/Ubuntu, otherwise refer to your distribution manual (don't forget to replace `servera` with the real username)
-
-```
-cat << EOCONFIG >> /etc/ssh/sshd_config
-Match User servera
-   ChrootDirectory %h
-   ForceCommand internal-sftp
-   AllowTcpForwarding no
-   X11Forwarding no
-EOCONFIG
-service ssh restart
-```
-
-## Test
-At this step your backup should schedule.
-
-If you want to be sure, you can test it by running on server A:
-```
-systemctl start restic.service
-```
-
-Next you can verify the backup contents by running on server A
-```
-restic -r sftp:serverb.domain.tld:servera.domain.tld/auto_conf snapshots
-```
-
-Replace `auto_conf` with `auto_<app>` if you did not choose to backup configuration but only applications.
-
-If you want to check the backups consistency:
-```
-systemctl start restic_check.service
-```
-
-If you want to make a complete check of the backups - keep in mind that this reads all the backed up data, it can take some time depending on your target server upload speed (more on this topic in [the Restic documentation](https://restic.readthedocs.io/en/latest/045_working_with_repos.html#checking-integrity-and-consistency)):
-```
-systemctl start restic_check_read_data.service
-```
-
-## Display the apps list to backup
-
-```
-yunohost app setting restic apps
+The `testing` branch can be tested using:
 ```
+# fresh install:
+sudo yunohost app install https://github.com/YunoHost-Apps/restic_ynh/tree/testing
 
-## Edit the apps list to backup
-
-```
-yunohost app setting restic apps -v "nextcloud,wordpress"
+# upgrade an existing install:
+sudo yunohost app upgrade restic -u https://github.com/YunoHost-Apps/restic_ynh/tree/testing
 ```
 
-## Launch a backup
-
-```
-systemctl start restic
-```
-
-## Launch a backups check
-
-```
-systemctl start restic_check.service
-```
-
-## Launch a complete backups check
-
-WARNING: this will read data from your backups destination server.
-It may take a quite long time depending on the target server's internet upload speed and hardware performance.
-
-```
-systemctl start restic_check_read_data.service
-```
-
-## Backup on different server, and apply distinct schedule for apps
-
-You can setup the Restic app several times on the same server so you can backup on several server or manage your frequency backup differently for specific part of your server.
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/restic%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/restic/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/restic%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/restic/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/restic_ynh/issues
- * App website: https://restic.net/
- * Upstream app repository: https://github.com/restic/restic
- * YunoHost website: https://yunohost.org/
-
----
-
-## Developer info
-
-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/restic_ynh/tree/testing).
-
-To try the testing branch, please proceed like that.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/restic_ynh/tree/testing --debug
-or
-sudo yunohost app upgrade restic -u https://github.com/YunoHost-Apps/restic_ynh/tree/testing --debug
-```
+### 📚 App packaging documentation
 
+Please see <https://doc.yunohost.org/packaging_apps> for more information.
diff --git a/check_process b/check_process
diff --git a/conf/backup-with-restic b/conf/backup-with-restic
@@ -0,0 +1,135 @@
+#!/usr/bin/env bash
+
+errors=""
+current_date=$(date +"%y%m%d_%H%M")
+log_file="/var/log/__APP__/${current_date}.log"
+mkdir -p "/var/log/__APP__"
+
+filter_hooks() {
+    ls /usr/share/yunohost/hooks/backup/ | grep "\-$1_" | cut -d"-" -f2 | uniq 2>&1
+}
+
+# Some apps need to be stopped to be backed up
+# https://github.com/search?q=org%3AYunoHost-Apps%20recommended%20to%20make%20your%20backup%20when%20the%20service%20is%20stopped&type=code
+apps_to_stop=("synapse" "gitea" "seafile" "sogo" "monitorix" "xwiki")
+stop_apps=$(sudo yunohost app setting __APP__ stop_apps)
+
+sudo yunohost app setting __APP__ last_run -v "${current_date}"
+sudo yunohost app setting __APP__ state -v "ongoing"
+
+BACKUP_CORE_ONLY=$(sudo yunohost app setting __APP__ backup_core_only)
+
+export BACKUP_CORE_ONLY
+
+# Backup system part conf
+conf=$(sudo yunohost app setting __APP__ conf)
+if [[ "$conf" = "1" ]]; then
+    if ! sudo yunohost backup create -n auto_conf --method __APP___app --system $(filter_hooks conf) >> "$log_file" 2>&1 ; then
+        errors+="\nThe backup miserably failed to backup system configurations."
+    fi
+fi
+
+# Backup system data
+data=$(sudo yunohost app setting __APP__ data)
+if [[ "$data" = "1" ]]; then
+    if ! sudo yunohost backup create -n auto_data --method __APP___app --system $(filter_hooks data) >> "$log_file" 2>&1 ; then
+        errors+="\nThe backup miserably failed to backup system data."
+    fi
+fi
+
+# Read and sanitize the app list:
+# - Remove spaces after commas
+# - Replace commas with spaces
+apps=$(sudo yunohost app setting __APP__ apps | sed 's/,[[:space:]]*/,/g')
+apps="${apps//,/ }"
+
+# Initialisation
+include_all=false
+exclude_list=()
+explicit_include_list=()
+
+# Parse app list
+for item in $apps; do
+    if [[ "$item" == "all" ]]; then
+        include_all=true
+    elif [[ "$item" =~ ^exclude: ]]; then
+        exclude_list+=("${item#exclude:}")
+    else
+        # If you are not in "all" mode, add to the explicit inclusion list
+        if ! $include_all; then
+            explicit_include_list+=("$item")
+        # If you are in "all" mode and the element is not prefixed with "exclude:", it is an implicit exclusion.
+        else
+            exclude_list+=("$item")
+        fi
+    fi
+done
+
+# Loop on applications
+for application in $(sudo ls /etc/yunohost/apps/); do
+    stopped="0"
+
+    # Exclude/Include logic
+    if $include_all; then
+        # "All" mode: those in exclude_list are excluded.
+        if printf '%s\n' "${exclude_list[@]}" | grep -q "^${application}\$"; then
+            continue
+        fi
+    else
+        # Explicit inclusion mode: only those in explicit_include_list are included.
+        if ! printf '%s\n' "${explicit_include_list[@]}" | grep -q "^${application}\$"; then
+            continue
+        fi
+    fi
+
+    # Verify backup script
+    if sudo test ! -f "/etc/yunohost/apps/$application/scripts/backup"; then
+        errors+="\nWarning: The application $application has no backup script. This app won't be backed up."
+        continue
+    fi
+
+    if [[ " ${apps_to_stop[@]} " =~ " ${application} " ]] && [ "$stop_apps" = "1" ]; then
+        systemctl stop "$application"
+        stopped="1"
+    fi
+
+    # Execute backup
+    if ! sudo yunohost backup create -n "auto_$application" --method __APP___app --apps "$application" >> "$log_file" 2>&1; then
+        errors+="\nThe backup miserably failed to backup $application application."
+    fi
+
+    # Start app if stopped
+    if [[ "$application" == "1" ]]; then
+        systemctl start "$application"
+        stopped="0"
+    fi
+done
+
+#=============================================
+# SEND MAIL TO NOTIFY ABOUT FAILED OPERATIONS
+#=============================================
+
+# Détection des erreurs critiques
+critical_errors="$(grep -iE "Error|Skipped|Fatal|Fail" "$log_file")"
+
+# Détection des warnings
+warnings="$(grep -iE "Warning" "$log_file")"
+
+# Send mail on backup (partially) failed
+domain=$(hostname)
+repository="$(sudo yunohost app setting __APP__ repository)"
+
+# Si des erreurs critiques sont présentes
+if [ -n "$critical_errors" ]; then
+    errors+="\nSome backup partially failed:\n$critical_errors"
+    sudo yunohost app setting __APP__ state -v "failed"
+    echo -e "$errors\n\n\n$(cat "$log_file")" | mail -a "Content-Type: text/plain; charset=UTF-8" -s "[__APP__] Backup failed from $domain onto $repository" root
+# Si uniquement des warnings sont présents
+elif [ -n "$warnings" ]; then
+    errors+="\nBackup completed with warnings:\n$warnings"
+    sudo yunohost app setting __APP__ state -v "successful_with_warnings"
+    echo -e "$errors\n\n\n$(cat "$log_file")" | mail -a "Content-Type: text/plain; charset=UTF-8" -s "[__APP__] Backup completed with warnings from $domain onto $repository" root
+# Si tout s'est bien passé
+else
+    sudo yunohost app setting __APP__ state -v "successful"
+fi