Matt/grub-btrfs
1
0
Fork 0
mirror of https://github.com/Antynea/grub-btrfs.git synced 2026-03-04 13:05:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

grub-btrfsd: watch more than one snapshot dir

Browse Source 
Fix #262

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
This commit is contained in:
Pascal Jäger
2023-03-26 20:56:07 +02:00
parent 879bec3697
commit 8105a2edf7
8 changed files with 93 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -96,9 +96,10 @@ Grub-btrfs comes with a daemon script that automatically updates the grub menu w
The daemon can be configured by passing different command line arguments to it. The daemon can be configured by passing different command line arguments to it.
The arguments are: The arguments are:
* `SNAPSHOTS_DIR` * `SNAPSHOTS_DIRS`
This argument specifies the path where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots. This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
E.g. for Snapper this would be `/.snapshots` E.g. for Snapper this would be `/.snapshots`. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
This argument is not necessary to provide if `--timeshift-auto` is set.
* `-c / --no-color` * `-c / --no-color`
Disable colors in output. Disable colors in output.
* `-l / --log-file` * `-l / --log-file`
@@ -109,7 +110,7 @@ Watch the snapshots directory recursively
* `-o / --timeshift-old` * `-o / --timeshift-old`
Look for snapshots in `/run/timeshift/backup/timeshift-btrfs` instead of `/run/timeshift/$PID/backup/timeshift-btrfs.` This is to be used for Timeshift versions <22.06. Look for snapshots in `/run/timeshift/backup/timeshift-btrfs` instead of `/run/timeshift/$PID/backup/timeshift-btrfs.` This is to be used for Timeshift versions <22.06.
* `-t / --timeshift-auto` * `-t / --timeshift-auto`
This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to `/run/timeshift/$PID/backup/timeshift-btrfs`. Where `$PID` is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument `SNAPSHOTS_DIR` has no effect. This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to `/run/timeshift/$PID/backup/timeshift-btrfs`. Where `$PID` is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument `SNAPSHOTS_DIRS` has no effect.
* `-v / --verbose` * `-v / --verbose`
Let the log of the daemon be more verbose Let the log of the daemon be more verbose
* `-h / --help` * `-h / --help`
@@ -182,8 +183,8 @@ Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
# Load environment variables from the configuration # Load environment variables from the configuration
EnvironmentFile=/etc/default/grub-btrfs/config EnvironmentFile=/etc/default/grub-btrfs/config
# Start the daemon, usage of it is: # Start the daemon, usage of it is:
# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIR # grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIRS
# SNAPSHOTS_DIR Snapshot directory to watch, without effect when --timeshift-auto # SNAPSHOTS_DIRS Snapshot directories to watch, without effect when --timeshift-auto
# Optional arguments: # Optional arguments:
# -t, --timeshift-auto Automatically detect Timeshifts snapshot directory # -t, --timeshift-auto Automatically detect Timeshifts snapshot directory
# -o, --timeshift-old Activate for timeshift versions <22.06 # -o, --timeshift-old Activate for timeshift versions <22.06
@@ -235,8 +236,8 @@ Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
# Load environment variables from the configuration # Load environment variables from the configuration
EnvironmentFile=/etc/default/grub-btrfs/config EnvironmentFile=/etc/default/grub-btrfs/config
# Start the daemon, usage of it is: # Start the daemon, usage of it is:
# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIR # grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIRS
# SNAPSHOTS_DIR Snapshot directory to watch, without effect when --timeshift-auto # SNAPSHOTS_DIRS Snapshot directories to watch, without effect when --timeshift-auto
# Optional arguments: # Optional arguments:
# -t, --timeshift-auto Automatically detect Timeshifts snapshot directory # -t, --timeshift-auto Automatically detect Timeshifts snapshot directory
# -l, --log-file Specify a logfile to write to # -l, --log-file Specify a logfile to write to

2
config
View File

@@ -1,7 +1,7 @@
#!/usr/bin/env bash #!/usr/bin/env bash
GRUB_BTRFS_VERSION=4.12-master-2023-03-26T18:44:50+00:00 GRUB_BTRFS_VERSION=4.12-master-2023-03-26T19:08:16+00:00
# Disable grub-btrfs. # Disable grub-btrfs.
# Default: "false" # Default: "false"

46
grub-btrfsd
View File

@@ -38,9 +38,9 @@ grub_btrfs_config="${sysconfdir}/default/grub-btrfs/config"
print_help() { print_help() {
echo "${CYAN}[?] Usage:" echo "${CYAN}[?] Usage:"
echo "${0##*/} [-h, --help] [-c, --no-color] [-l, --log-file LOG_FILE] [-r, --recursive] [-s, --syslog] [-t, --timeshift-auto] [-v, --verbose] SNAPSHOTS_DIR" echo "${0##*/} [-h, --help] [-c, --no-color] [-l, --log-file LOG_FILE] [-r, --recursive] [-s, --syslog] [-t, --timeshift-auto] [-v, --verbose] SNAPSHOTS_DIRS"
echo echo
echo "SNAPSHOTS_DIR Snapshot directory to watch, without effect when --timeshift-auto" echo "SNAPSHOTS_DIRS Snapshot directories to watch, without effect when --timeshift-auto"
echo echo
echo "Optional arguments:" echo "Optional arguments:"
echo "-c, --no-color Disable colors in output" echo "-c, --no-color Disable colors in output"
@@ -196,7 +196,7 @@ if [ ${timeshift_auto} = false ] && [ ${timeshift_old} = true ]; then
fi fi
vlog "Arguments:" vlog "Arguments:"
vlog "Snapshot directory: $snapshots" vlog "Snapshot directories: $snapshots"
vlog "Timestift autodetection: $timeshift_auto" vlog "Timestift autodetection: $timeshift_auto"
vlog "Timeshift old: $timeshift_old" vlog "Timeshift old: $timeshift_old"
vlog "Logfile: $logfile" vlog "Logfile: $logfile"
@@ -236,16 +236,18 @@ create_grub_menu() {
set_snapshot_dir() { set_snapshot_dir() {
# old timeshift has it's snapshot dir in a different location # old timeshift has it's snapshot dir in a different location
if [ "${timeshift_old}" = true ]; then if [ "${timeshift_old}" = true ]; then
snapshots="/run/timeshift/backup/timeshift-btrfs/snapshots" snapdir="/run/timeshift/backup/timeshift-btrfs/snapshots"
else else
snapshots="/run/timeshift/${timeshift_pid}/backup/timeshift-btrfs/snapshots" snapdir="/run/timeshift/${timeshift_pid}/backup/timeshift-btrfs/snapshots"
fi fi
} }
# start the actual daemon daemon_function() {
vlog "Snapshot dir watchtimeout: $watchtime" # start the actual daemon
vlog "Entering infinite while" "${GREEN}" snapdir=$1
while true; do vlog "Snapshot dir watchtimeout: $watchtime"
vlog "Entering infinite while for $snapdir" "${GREEN}"
while true; do
runs=false runs=false
if [ ${timeshift_auto} = true ] && ! [ "${timeshift_pid}" -gt 0 ] ; then if [ ${timeshift_auto} = true ] && ! [ "${timeshift_pid}" -gt 0 ] ; then
# watch the timeshift folder for a folder that is created when timeshift starts up # watch the timeshift folder for a folder that is created when timeshift starts up
@@ -257,7 +259,7 @@ while true; do
if [ "${#timeshift_pid}" -gt 0 ]; then if [ "${#timeshift_pid}" -gt 0 ]; then
set_snapshot_dir set_snapshot_dir
log "detected running Timeshift at daemon startup, PID is: $timeshift_pid" log "detected running Timeshift at daemon startup, PID is: $timeshift_pid"
vlog "new snapshots directory is $snapshots" vlog "new snapshots directory is $snapdir"
else else
log "Watching /run/timeshift for timeshift to start" log "Watching /run/timeshift for timeshift to start"
inotifywait ${inotify_qiet_flag} -e create -e delete /run/timeshift && { inotifywait ${inotify_qiet_flag} -e create -e delete /run/timeshift && {
@@ -265,21 +267,21 @@ while true; do
timeshift_pid=$(ps ax | awk '{sub(/.*\//, "", $5)} $5 ~ /timeshift/ {print $1}') timeshift_pid=$(ps ax | awk '{sub(/.*\//, "", $5)} $5 ~ /timeshift/ {print $1}')
set_snapshot_dir set_snapshot_dir
log "detected Timeshift startup, PID is: $timeshift_pid" "${CYAN}" log "detected Timeshift startup, PID is: $timeshift_pid" "${CYAN}"
vlog "new snapshots directory is $snapshots" "${CYAN}" vlog "new snapshots directory is $snapdir" "${CYAN}"
(create_grub_menu) # create the grub menu once immidiatly in a forking process. Snapshots from commandline using timeshift --create need this (create_grub_menu) # create the grub menu once immidiatly in a forking process. Snapshots from commandline using timeshift --create need this
} }
fi fi
runs=false runs=false
else else
while [ -d "$snapshots" ]; do while [ -d "$snapdir" ]; do
# watch the actual snapshots folder for a new snapshot or a deletion of a snapshot # watch the actual snapshots folder for a new snapshot or a deletion of a snapshot
if [ ${runs} = false ] && [ ${verbose} = false ]; then if [ ${runs} = false ] && [ ${verbose} = false ]; then
log "Watching $snapshots for new snapshots..." "${CYAN}" log "Watching $snapdir for new snapshots..." "${CYAN}"
else else
vlog "Watching $snapshots for new snapshots..." "${CYAN}" vlog "Watching $snapdir for new snapshots..." "${CYAN}"
fi fi
runs=true runs=true
inotifywait ${inotify_qiet_flag} ${inotify_recursive_flag} -e create -e delete -e unmount -t "$watchtime" "$snapshots" && { inotifywait ${inotify_qiet_flag} ${inotify_recursive_flag} -e create -e delete -e unmount -t "$watchtime" "$snapdir" && {
log "Detected snapshot creation/ deletion, recreating Grub menu" "${CYAN}" log "Detected snapshot creation/ deletion, recreating Grub menu" "${CYAN}"
sleep 5 sleep 5
create_grub_menu create_grub_menu
@@ -288,9 +290,21 @@ while true; do
done done
timeshift_pid=-2 timeshift_pid=-2
fi fi
if ! [ ${timeshift_auto} = true ] && ! [ -d "${snapshots}" ] ; then # in case someone deletes the snapshots folder (in snapper mode) to prevent the while loop from going wild if ! [ ${timeshift_auto} = true ] && ! [ -d "${snapdir}" ] ; then # in case someone deletes the snapshots folder (in snapper mode) to prevent the while loop from going wild
break break
fi fi
done
}
# for all dirs that got passed to the script, start a new fork with that dir
snapdirs=( "${@}" )
for snapdir in "${snapdirs[@]}"
do
vlog "starting daemon with watching $snapdir..."
daemon_function "${snapdir}" &
done done
wait # wait for forks to finish, kill child forks if SIGTERM is sent
exit 0 # tradition is tradition exit 0 # tradition is tradition

2
grub-btrfsd.confd
View File

@@ -1,4 +1,4 @@
# Copyright 2022 Pascal Jaeger # Copyright 2023 Pascal Jaeger
# Distributed under the terms of the GNU General Public License v3 # Distributed under the terms of the GNU General Public License v3
## Where to locate the root snapshots ## Where to locate the root snapshots

2
grub-btrfsd.initd
View File

@@ -1,5 +1,5 @@
#!/sbin/openrc-run #!/sbin/openrc-run
# Copyright 2021 Pascal Jaeger # Copyright 2023 Pascal Jaeger
# Distributed under the terms of the GNU General Public License v3 # Distributed under the terms of the GNU General Public License v3
name="grub-btrfs daemon" name="grub-btrfs daemon"

4
grub-btrfsd.service
View File

@@ -9,8 +9,8 @@ Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
# Load environment variables from the configuration # Load environment variables from the configuration
EnvironmentFile=/etc/default/grub-btrfs/config EnvironmentFile=/etc/default/grub-btrfs/config
# Start the daemon, usage of it is: # Start the daemon, usage of it is:
# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIR # grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIRS
# SNAPSHOTS_DIR Snapshot directory to watch, without effect when --timeshift-auto # SNAPSHOTS_DIRS Snapshot directories to watch, without effect when --timeshift-auto
# Optional arguments: # Optional arguments:
# -t, --timeshift-auto Automatically detect Timeshifts snapshot directory # -t, --timeshift-auto Automatically detect Timeshifts snapshot directory
# -o, --timeshift-old Activate for timeshift versions <22.06 # -o, --timeshift-old Activate for timeshift versions <22.06

11
manpages/grub-btrfsd.8.man
View File

@@ -9,7 +9,7 @@ when a new btrfs snapshot is created.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.PP .PP
\fCgrub\-btrfsd [\-h, \-\-help] [\-c, \-\-no\-color] [\-l, \-\-log\-file LOG_FILE] [\-r, \-\-recursive] [\-s, \-\-syslog] [\-t, \-\-timeshift\-auto] [\-o, \-\-timeshift\-old] [\-v, \-\-verbose] SNAPSHOTS_DIR\fP \fCgrub\-btrfsd [\-h, \-\-help] [\-c, \-\-no\-color] [\-l, \-\-log\-file LOG_FILE] [\-r, \-\-recursive] [\-s, \-\-syslog] [\-t, \-\-timeshift\-auto] [\-o, \-\-timeshift\-old] [\-v, \-\-verbose] SNAPSHOTS_DIRS\fP
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@@ -17,10 +17,11 @@ Grub-btrfsd is a shell script which is meant to be run as a daemon.
Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or \fC/etc/grub.d/41_snapshots\-btrfs\fP (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes. Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or \fC/etc/grub.d/41_snapshots\-btrfs\fP (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes.
.SH "OPTIONS" .SH "OPTIONS"
.SS "\fCSNAPSHOTS_DIR\fP" .SS "\fCSNAPSHOTS_DIRS\fP"
.PP .PP
This argument specifies the path where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots. This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
E.g. for Snapper this would be \fC/.snapshots\fP E.g. for Snapper this would be \fC/.snapshots\fP. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
This argument is not necessary to provide if \fC\-\-timeshift\-auto\fP is set.
.SS "\fC\-c / \-\-no\-color\fP" .SS "\fC\-c / \-\-no\-color\fP"
.PP .PP
@@ -40,7 +41,7 @@ Write to syslog
.SS "\fC\-t / \-\-timeshift\-auto\fP" .SS "\fC\-t / \-\-timeshift\-auto\fP"
.PP .PP
This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to \fC/run/timeshift/$PID/backup/timeshift\-btrfs\fP. Where \fC$PID\fP is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument \fCSNAPSHOTS_DIR\fP has no effect. This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to \fC/run/timeshift/$PID/backup/timeshift\-btrfs\fP. Where \fC$PID\fP is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument \fCSNAPSHOTS_DIRS\fP has no effect.
.SS "\fC\-o / \-\-timeshift\-old\fP" .SS "\fC\-o / \-\-timeshift\-old\fP"
.PP .PP

11
manpages/grub-btrfsd.8.org
View File

@@ -10,16 +10,17 @@ grub-btrfsd - An OpenRC daemon to automatically update the grub menu with
when a new btrfs snapshot is created. when a new btrfs snapshot is created.
* SYNOPSIS * SYNOPSIS
~grub-btrfsd [-h, --help] [-c, --no-color] [-l, --log-file LOG_FILE] [-r, --recursive] [-s, --syslog] [-t, --timeshift-auto] [-o, --timeshift-old] [-v, --verbose] SNAPSHOTS_DIR~ ~grub-btrfsd [-h, --help] [-c, --no-color] [-l, --log-file LOG_FILE] [-r, --recursive] [-s, --syslog] [-t, --timeshift-auto] [-o, --timeshift-old] [-v, --verbose] SNAPSHOTS_DIRS~
* DESCRIPTION * DESCRIPTION
Grub-btrfsd is a shell script which is meant to be run as a daemon. Grub-btrfsd is a shell script which is meant to be run as a daemon.
Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or ~/etc/grub.d/41_snapshots-btrfs~ (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes. Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or ~/etc/grub.d/41_snapshots-btrfs~ (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes.
* OPTIONS * OPTIONS
** ~SNAPSHOTS_DIR~ ** ~SNAPSHOTS_DIRS~
This argument specifies the path where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots. This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
E.g. for Snapper this would be ~/.snapshots~ E.g. for Snapper this would be ~/.snapshots~. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
This argument is not necessary to provide if ~--timeshift-auto~ is set.
** ~-c / --no-color~ ** ~-c / --no-color~
Disable colors in output. Disable colors in output.
@@ -34,7 +35,7 @@ Watch snapshot directory recursively
Write to syslog Write to syslog
** ~-t / --timeshift-auto~ ** ~-t / --timeshift-auto~
This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to ~/run/timeshift/$PID/backup/timeshift-btrfs~. Where ~$PID~ is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument ~SNAPSHOTS_DIR~ has no effect. This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to ~/run/timeshift/$PID/backup/timeshift-btrfs~. Where ~$PID~ is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument ~SNAPSHOTS_DIRS~ has no effect.
** ~-o / --timeshift-old~ ** ~-o / --timeshift-old~
Look for snapshots in ~/run/timeshift/backup/timeshift-btrfs~ instead of ~/run/timeshift/$PID/backup/timeshift-btrfs~. This is to be used for Timeshift versions <22.06. Look for snapshots in ~/run/timeshift/backup/timeshift-btrfs~ instead of ~/run/timeshift/$PID/backup/timeshift-btrfs~. This is to be used for Timeshift versions <22.06.