Attempt to fix ignore specific path (#102)

* Attempt to fix ignore specific path

Attempt to fix ignore specific path #100

* Update config

10-update_grub.conf

@@ -1,2 +0,0 @@
-[Service]
-ExecStartPost=/usr/sbin/grub-mkconfig -o /boot/grub/grub.cfg

41_snapshots-btrfs

@@ -2,67 +2,41 @@
 #
 #
 #########################################################################################################################################################################
-# Written by: Antynea																																					#
-# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt																												#
-#																																										#
-# Purpose: Include btrfs snapshots at boot options (grub-menu).																											#
-#																																										#
-# What this script does:																																				#
-# Simple rollback using snapshots you made previously.																													#
-# - Automatically List snapshots existing on root partition (btrfs).																									#
-# - Automatically Detect if "/boot" is in separate partition.																											#
-# - Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots. (For custon name, see below.)											#
-# - Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.																	#
-# - Automatically detect snapper and use snapper's snapshot description if available.																					#
-#																																										#
-# How to use it:																																						#
-# - Add this lines to /etc/default/grub:																																#
-#																																										#
-# * GRUB_BTRFS_SUBMENUNAME="Arch Linux snapshots" 																														#
-#		(Name appearing in the Grub menu.)																																#
-# * GRUB_BTRFS_PREFIXENTRY="Snapshot:"        		   																													#
-#		(Add a name ahead your snapshots entries in the Grub menu.) 																									#
-# * GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"																																#
-#		(Show full path snapshot or only name in the Grub menu)																											#
-# * GRUB_BTRFS_TITLE_FORMAT="p/d/n"																																		#
-#		(Custom title, shows/hides p"prefix" d"date" n"name" in the Grub menu, separator "/", custom order available)													#
-# * GRUB_BTRFS_LIMIT="50"																																				#
-#		(Limit the number of snapshots populated in the GRUB menu.)																										#
-# * GRUB_BTRFS_SUBVOLUME_SORT="descending"																																#
-#		(Sort the found subvolumes by newest first ("descending") or oldest first ("ascending").																		#
-#		If "ascending" is chosen then the $GRUB_BTRFS_LIMIT oldest subvolumes will populate the menu.)																	#
-# * GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"																																#
-#		(Show snapshots found during run "grub-mkconfig")																												#
-# * GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND="true"																														#
-#		(Show Total of snapshots found during run "grub-mkconfig")																										#
-# * GRUB_BTRFS_NKERNEL=("vmlinuz-linux") 		 																														#
-#		(Use only if you have custom kernel name or auto-detect failed.)																								#
-# * GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")																								#
-#		(Use only if you have custom initramfs name or auto-detect failed.)																								#
-# * GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img") 																															#
-#		(Use only if you have custom intel-ucode or auto-detect failed.)		    																					#
-# * GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "nosnapshot")																										#
-#		(Ignore specific path during run "grub-mkconfig")																												#
-# * GRUB_BTRFS_SNAPPER_CONFIG="root"																																	#
-#		(Snapper's config name to use)																																	#
-# * GRUB_BTRFS_DISABLE="false"																																			#
-#		Disable Grub-btrfs (default=active)																																#
-#																																										#
-# - Generate grub.cfg (on Arch Linux use grub-mkconfig -o /boot/grub/grub.cfg)																							#
-#																																										#
-# - grub-btrfs automatically generates snapshots entries.																												#
-# - You will see it appear different entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill)															#
-#																																										#
-# Automatically update grub																																				#
-#  If you would like grub to automatically update when Snapper timeline snapshots and cleanups occur, simply install 10-update_grub.conf in the following locations:	#
-# - /etc/systemd/system/snapper-timeline.service.d/																														#
-# - /etc/systemd/system/snapper-cleanup.service.d/																														#
-# Once the configuration files are in place, systemctl daemon-reload should be run to reload the units and make the changes active.										#
-#																																										#
-# Special thanks for assistance and contributions:																														#
-# - My friends																																							#
-# - All contributors on Github																																			#
-#																																										#
+# Written by: Antynea
+# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
+# Github: https://github.com/Antynea/grub-btrfs
+#
+# Purpose:
+#   Improves Grub by adding "btrfs snapshots" to the Grub menu.
+#   You can start your system on a "snapshot" from the Grub menu.
+#   Supports manual snapshots, snapper ...
+#   Warning : it isn't recommended to start on read-only snapshot
+#
+# What this script does:
+# - Automatically List snapshots existing on root partition (btrfs).
+# - Automatically Detect if "/boot" is in separate partition.
+# - Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
+# - Automatically Create corresponding "menuentry" in grub.cfg
+# - Automatically detect snapper and use snapper's snapshot description if available.
+# - Automatically generate grub.cfg if you use the provided systemd service.
+#
+# Installation:
+# - Run `make install` or look into Makefile for instructions on where to put each file.
+#
+# Customization:
+#  Refer to config for the list of available options and their default values.
+#  Place your configurations to /etc/default/grub-btrfs/config.
+#
+# Automatically update Grub
+#  If you would like Grub to automatically update when a snapshots is made or deleted:
+# - Mount your subvolume which contains snapshots to /.snapshots
+# - Use systemctl start/enable grub-btrfs.path
+#  grub-btrfs.path will automatically (re)generate grub.cfg when a modification appear in /.snapshots
+#
+# Special thanks for assistance and contributions:
+# - My friends
+# - All contributors on Github
+#
 #########################################################################################################################################################################
 
 set -e
@@ -71,19 +45,21 @@ prefix="/usr"
 exec_prefix="/usr"
 datarootdir="/usr/share"
 sysconfdir="/etc"
+grub_btrfs_config="${sysconfdir}/default/grub-btrfs/config"
 
+[[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
+. "$datarootdir/grub/grub-mkconfig_lib"
 . "${sysconfdir}/default/grub"
-. "$pkgdatadir/grub-mkconfig_lib"
-# . "$datarootdir/grub/grub-mkconfig_lib" # Uncomment if you run "bash -x"
 
-######################################
-### Variables in /etc/default/grub ###
-######################################
+###################################################
+### Variables in /etc/default/grub-btrfs/config ###
+###################################################
 ## Disable Grub-btrfs (default=active)
 grub_btrfs_disable=${GRUB_BTRFS_DISABLE:-"false"}
 [[ "${grub_btrfs_disable}" == "true" ]] && exit 0
 ## Submenu name
-submenuname=${GRUB_BTRFS_SUBMENUNAME:-"Arch Linux snapshots"}
+distro=$(awk -F "=" '/^NAME=/ {gsub(/"/, "", $2); print $2}' /etc/os-release)
+submenuname=${GRUB_BTRFS_SUBMENUNAME:-"${distro:-Linux} snapshots"}
 ## Prefix entry
 prefixentry=${GRUB_BTRFS_PREFIXENTRY:-"Snapshot:"}
 ## Show full path snapshot or only name
@@ -110,8 +86,24 @@ show_snap_found=${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}
 show_total_snap_found=${GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND:-"true"}
 ## Ignore specific path during run "grub-mkconfig"
 ignore_specific_path=("${GRUB_BTRFS_IGNORE_SPECIFIC_PATH[@]}")
-## snapper's config name
+## Snapper's config name
 snapper_config=${GRUB_BTRFS_SNAPPER_CONFIG:-"root"}
+## Override boot partition detection
+override_boot_partition_detection=${GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION:-"false"}
+## Customize GRUB directory
+grub_directory=${GRUB_BTRFS_DIRNAME:-"grub"}
+## Password protection management for submenu
+# Protection support for submenu (--unrestricted)
+unrestricted_access_submenu=${GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU:-"false"}
+case "${unrestricted_access_submenu}" in
+	true)	unrestricted_access_submenu="--unrestricted ";;
+	*)		unrestricted_access_submenu=""
+esac
+# Authorized users (--users foo,bar)
+protection_authorized_users=${GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS}
+if [ ! -z "${protection_authorized_users}" ] ; then
+	protection_authorized_users="--users ${GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS} "
+fi
 
 ########################
 ### variables script ###
@@ -119,14 +111,20 @@ snapper_config=${GRUB_BTRFS_SNAPPER_CONFIG:-"root"}
 ## Internationalization (default : english)
 export TEXTDOMAIN=grub-btrfs-git
 export TEXTDOMAINDIR="/usr/share/locale"
-## hints string
-hs_boot=$(${grub_probe} --target="hints_string" "/boot" 2>/dev/null)
-## UUID of the boot partition
-boot_uuid=$(${grub_probe} --target="fs_uuid" "/boot" 2>/dev/null)
-## Type filesystem of boot partition
-boot_fs=$(${grub_probe} --target="fs" "/boot" 2>/dev/null)
-## UUID of the root partition
-root_uuid=$(${grub_probe} "/" --target="fs_uuid" 2>/dev/null)
+## Probe info "Boot partition"
+# Boot device
+boot_device=$(${grub_probe} --target=device /boot)
+# hints string
+boot_hs=$(${grub_probe} --device ${boot_device} --target="hints_string" 2>/dev/null)
+# UUID of the boot partition
+boot_uuid=$(${grub_probe} --device ${boot_device} --target="fs_uuid" 2>/dev/null)
+# Type filesystem of boot partition
+boot_fs=$(${grub_probe} --target="fs" /boot 2>/dev/null)
+## Probe info "Root partition"
+# Root device
+root_device=$(${grub_probe} --target=device /)
+# UUID of the root partition
+root_uuid=$(${grub_probe} --device ${root_device} --target="fs_uuid" 2>/dev/null)
 ## Parameters passed to the kernel
 kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
 ## Mount point location
@@ -135,6 +133,16 @@ gbgmp=$(mktemp -d)
 CLASS="--class snapshots --class gnu-linux --class gnu --class os"
 ## save IFS
 oldIFS=$IFS
+## Detect uuid requirement (lvm,btrfs...)
+check_uuid_required() {
+if [ "x${root_uuid}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
+    || ! test -e "/dev/disk/by-uuid/${root_uuid}" \
+    || ( test -e "${root_device}" && uses_abstraction "${root_device}" lvm ); then
+  LINUX_ROOT_DEVICE=${root_device}
+else
+  LINUX_ROOT_DEVICE=UUID=${root_uuid}
+fi
+}
 
 
 ######################
@@ -157,6 +165,7 @@ test_btrfs()
 	fi
 	set -e
 }
+
 ##############
 ### Script ###
 ##############
@@ -164,10 +173,10 @@ test_btrfs()
 
 ## Create entry
 entry()	{
-echo "$@" >> "/boot/grub/grub-btrfs.cfg"
+echo "$@" >> "/boot/$grub_directory/grub-btrfs.cfg"
 # local arg="$@"
-# echo "${arg}" >> "/boot/grub/grub-btrfs.cfg"
-# cat << EOF >> "/boot/grub/grub-btrfs.cfg"
+# echo "${arg}" >> "/boot/$grub_directory/grub-btrfs.cfg"
+# cat << EOF >> "/boot/$grub_directory/grub-btrfs.cfg"
 # ${arg}
 # EOF
 }
@@ -182,21 +191,22 @@ make_menu_entries()
 		[[ ! -f "${boot_dir}"/"${k}" ]] && continue;
 		kversion=${k#*"-"}
 		for i in "${name_initramfs[@]}"; do
-			prefix_i=${i[@]%%"-"*}
-			suffix_i=${i[@]##*"-"}
-			if 		[ -f "${boot_dir}"/"${prefix_i}-${kversion}-${suffix_i}" ];	then i="${i}";
-			elif 	[ -f "${boot_dir}"/"${prefix_i}-${kversion}" ]; 			then i="${i}";
-			elif 	[ -f "${boot_dir}"/"${prefix_i}-${kversion}.img" ]; 		then i="${i}";
-			elif 	[ -f "${boot_dir}"/"${prefix_i}-${kversion}.gz" ]; 			then i="${i}";
+			prefix_i=${i%%"-"*}
+			suffix_i=${i#*"-"}
+         	alt_suffix_i=${i##*"-"}
+            if   [ "${kversion}" = "${suffix_i}" ];                 then i="${i}";
+            elif [ "${kversion}.img" = "${suffix_i}" ];             then i="${i}";
+            elif [ "${kversion}-fallback.img" = "${suffix_i}" ];    then i="${i}";
+            elif [ "${kversion}.gz" = "${suffix_i}" ];              then i="${i}";
 			else 	continue ;
 			fi
 			for u in "${name_microcode[@]}"; do
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != initramfs-linux-fallback.img ]] ; then
+				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
 				entry "
-	menuentry '"${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
+	menuentry '"${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid' {"
 				else
 				entry "
-	menuentry '"${k}" & "${i}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
+	menuentry '"${k}" & "${i}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid' {"
 				fi
 				entry "\
 		if [ x\$feature_all_video_module = xy ]; then
@@ -205,14 +215,14 @@ make_menu_entries()
 		set gfxpayload=keep
 		insmod ${boot_fs}
 		if [ x\$feature_platform_search_hint = xy ]; then
-			search --no-floppy --fs-uuid  --set=root ${hs_boot} ${boot_uuid}
+			search --no-floppy --fs-uuid  --set=root ${boot_hs} ${boot_uuid}
 		else
 			search --no-floppy --fs-uuid  --set=root ${boot_uuid}
 		fi
 		echo 'Loading Snapshot: "${snap_date_time}" "${snap_dir_name}"'
 		echo 'Loading Kernel: "${k}" ...'
-		linux \"${boot_dir_root_grub}/"${k}"\" root=UUID=${root_uuid} rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != initramfs-linux-fallback.img ]] ; then
+		linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" rw ${kernel_parameters} rootflags=subvol=\""${snap_dir_name}"\""
+				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
 					entry "\
 		echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
 		initrd \"${boot_dir_root_grub}/"${u}"\" \"${boot_dir_root_grub}/"${i}"\""
@@ -242,12 +252,17 @@ snapshot_list()
 {
 	# Query info from snapper if it is installed
 	type snapper >/dev/null 2>&1
-	if [[ $? -eq 0 ]]; then
-		local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))
-		local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
+	if [ $? -eq 0 ]; then
+		if [ -s "/etc/snapper/configs/$snapper_config" ]; then
+			printf "# Info: snapper detected, using config '$snapper_config'\n" >&2
+			local snapper_ids=($(snapper --no-dbus -t 0 -c "$snapper_config" list --disable-used-space | tail -n +3 | cut -d'|' -f 1))
+			local snapper_types=($(snapper --no-dbus -t 0 -c "$snapper_config" list --disable-used-space | tail -n +3 | cut -d'|' -f 2))
 
-		IFS=$'\n'
-		local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 7))
+			IFS=$'\n'
+			local snapper_descriptions=($(snapper --no-dbus -t 0 -c "$snapper_config" list --disable-used-space | tail -n +3 | rev | cut -d'|' -f 2 | rev))
+		else
+			printf "# Warning: snapper detected but config '$snapper_config' does not exist\n" >&2
+		fi
 	fi
 
 	IFS=$'\n'
@@ -267,8 +282,9 @@ snapshot_list()
 
 		# ignore specific path during run "grub-mkconfig"
 		if [ ! -z "${ignore_specific_path}" ] ; then
+			[[ "${snap_path_name}" == "@" ]] && continue 2;
 			for isp in ${ignore_specific_path[@]} ; do
-				[[ "${snap_path_name}" == "${isp}"/* ]] && continue 2;
+				[[ "${snap_path_name}" == "${isp}" || "${snap_path_name}" == "${isp}"/* ]] && continue 2;
 			done
 		fi
 
@@ -304,6 +320,10 @@ snapshot_list()
 		local entry="${entries[$i]}"
 		for j in "${!snapper_ids[@]}"; do
 			local snapper_id="${snapper_ids[$j]//[[:space:]]/}"
+			# remove other non numeric characters
+			snapper_id="${snapper_id//\*/}"
+			snapper_id="${snapper_id//\+/}"
+			snapper_id="${snapper_id//-/}"
 			if [[ "$snapper_id" == "$id" ]]; then
 				local snapper_type=$(trim "${snapper_types[$j]}")
 				local snapper_description=$(trim "${snapper_descriptions[$j]}")
@@ -394,16 +414,15 @@ path_snapshot()
 title_format()
 {
 	case "${title_format}" in
-		p/d/n) 	title_menu="${prefixentry} ${snap_date_time} ${name_snapshot}";;
 		p/n/d) 	title_menu="${prefixentry} ${name_snapshot} ${snap_date_time}";;
 		p/d) 	title_menu="${prefixentry} ${snap_date_time}";;
 		p/n) 	title_menu="${prefixentry} ${name_snapshot}";;
 		d/n) 	title_menu="${snap_date_time} ${name_snapshot}";;
 		n/d) 	title_menu="${name_snapshot} ${snap_date_time}";;
-		p) 	title_menu="${prefixentry}";;
-		d)	title_menu="${snap_date_time}";;
-		n)	title_menu="${name_snapshot}";;
-		*)	printf $"# Warning: GRUB_BTRFS_TITLE_FORMAT=${title_format}, syntax error \n" >&2
+		p) 		title_menu="${prefixentry}";;
+		d)		title_menu="${snap_date_time}";;
+		n)		title_menu="${name_snapshot}";;
+		*)		title_menu="${prefixentry} ${snap_date_time} ${name_snapshot}"
 	esac
 }
 
@@ -421,7 +440,7 @@ boot_bounded()
 		snap_dir_name="$(trim "$snap_dir_name")"
 		snap_date_time="$(echo "$item" | cut -d' ' -f1-2)"
 		snap_date_time="$(trim "$snap_date_time")"
-		
+
 		boot_dir="$gbgmp/$snap_dir_name/boot"
 		# Kernel (Original + custom kernel)
 		detect_kernel
@@ -464,12 +483,12 @@ boot_separate()
 	detect_kernel
 	if [ -z "${list_kernel}" ]; then print_error "Kernels not found."; fi
 	name_kernel=("${list_kernel[@]##*"/"}")
-	
+
 	# Initramfs (Original + custom initramfs)
 	detect_initramfs
 	if [ -z "${list_initramfs}" ]; then print_error "Initramfs not found."; fi
 	name_initramfs=("${list_initramfs[@]##*"/"}")
-	
+
 	# microcode (auto-detect + custom microcode)
 	detect_microcode
 	name_microcode=("${list_ucode[@]##*"/"}")
@@ -509,8 +528,8 @@ printf "###### - Grub-btrfs: Snapshot detection started - ######\n" >&2 ;
 # if btrfs prog isn't installed, exit
 test_btrfs
 # Delete existing config
-#rm -f --preserve-root "/boot/grub/grub-btrfs.cfg"
-> "/boot/grub/grub-btrfs.cfg"
+#rm -f --preserve-root "/boot/$grub_directory/grub-btrfs.cfg"
+> "/boot/$grub_directory/grub-btrfs.cfg"
 # Create mount point then mounting
 [[ ! -d $gbgmp ]] && mkdir -p $gbgmp
 mount -o subvolid=5 /dev/disk/by-uuid/$root_uuid $gbgmp/
@@ -518,13 +537,20 @@ mount -o subvolid=5 /dev/disk/by-uuid/$root_uuid $gbgmp/
 count_warning_menuentries=0
 # Count snapshots
 count_limit_snap=0
+# detect uuid requirement
+check_uuid_required
 # Detects if /boot is a separate partition
-if [[ "$root_uuid" != "$boot_uuid" ]]; then
-	printf "# Info: Separate boot partition detected \n" >&2 ;
+if [[ "$override_boot_partition_detection" == "true" ]]; then
+	printf "# Info: Override boot partition detection : enable \n" >&2 ;
 	boot_separate
+else
+	if [[ "$root_uuid" != "$boot_uuid" ]]; then
+		printf "# Info: Separate boot partition detected \n" >&2 ;
+		boot_separate
 	else
-	printf "# Info: Separate boot partition not detected \n" >&2 ;
-	boot_bounded
+		printf "# Info: Separate boot partition not detected \n" >&2 ;
+		boot_bounded
+	fi
 fi
 # unmounting mount point
 umount $gbgmp
@@ -539,11 +565,11 @@ fi
 if [[ "${count_limit_snap}" = "0" || -z "${count_limit_snap}" ]]; then
 	print_error "No snapshots found."
 fi
-root_grub="$(make_system_path_relative_to_its_root /boot/grub)"
+root_grub="$(make_system_path_relative_to_its_root /boot/$grub_directory)"
 # Make a submenu in GRUB (grub.cfg)
 cat << EOF
-submenu '${submenuname}' {
-	configfile "${root_grub}/grub-btrfs.cfg"
+submenu '${submenuname}' ${protection_authorized_users}${unrestricted_access_submenu}{
+	configfile "\${prefix}/grub-btrfs.cfg"
 }
 EOF
 printf "###### - Grub-btrfs: Snapshot detection ended   - ######\n" >&2 ;

Makefile

@@ -0,0 +1,23 @@
+PKGNAME ?= grub-btrfs
+PREFIX ?= /usr
+
+SHARE_DIR = $(DESTDIR)$(PREFIX)/share
+LIB_DIR = $(DESTDIR)$(PREFIX)/lib
+
+.PHONY: install
+
+install:
+	@install -Dm755 -t "$(DESTDIR)/etc/grub.d/" 41_snapshots-btrfs
+	@install -Dm644 -t "$(DESTDIR)/etc/default/grub-btrfs/" config
+	@install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.service
+	@install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.path
+	@install -Dm644 -t "$(SHARE_DIR)/licenses/$(PKGNAME)/" LICENSE
+
+uninstall:
+	rm -f "$(DESTDIR)/etc/grub.d/41_snapshots-btrfs"
+	rm -f "$(DESTDIR)/etc/default/grub-btrfs/config"
+	rmdir --ignore-fail-on-non-empty "$(DESTDIR)/etc/default/grub-btrfs"
+	rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.service"
+	rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.path"
+	rm -f "$(SHARE_DIR)/licenses/$(PKGNAME)/LICENSE"
+	rm -f "$(DESTDIR)/boot/grub/grub-btrfs.cfg"

README.md

@@ -1,112 +1,163 @@
-[![GitHub release](https://img.shields.io/github/release/Antynea/grub-btrfs.svg)](https://github.com/Antynea/grub-btrfs)
-  
+[![GitHub release](https://img.shields.io/github/release/Antynea/grub-btrfs.svg)](https://github.com/Antynea/grub-btrfs/releases)
+![](https://img.shields.io/github/license/Antynea/grub-btrfs.svg)
+
 ## grub-btrfs
 
-This is a version 2.xx of grub-btrfs
-##### BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
+This is a version 4.xx of grub-btrfs
+##### BTC donation address: `1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt`
 ##
 ### Description
+Improves Grub by adding "btrfs snapshots" to the Grub menu.
 
-grub-btrfs, Include btrfs snapshots at boot options. (grub menu)
-##
-### What does grub-btrfs v2.xx do :
+You can start your system on a "snapshot" from the Grub menu.
 
-Simple rollback using snapshots you made previously.
+Supports manual snapshots, snapper, timeshift ...
 
+##### Warning: booting on read-only snapshots can be tricky
+
+If you choose to do it, `/var/log` must be on a separate subvolume.
+
+Otherwise, make sure your snapshots are writeable.
+
+See [this ticket](https://github.com/Antynea/grub-btrfs/issues/92) for more info.
+
+### What does grub-btrfs v4.xx do :
 * Automatically List snapshots existing on root partition (btrfs).
-
 * Automatically Detect if "/boot" is in separate partition.
-
-* Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots. (For custom name, see below.)
-
-* Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.
-
+* Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
+* Automatically Create corresponding "menuentry" in `grub.cfg`
 * Automatically detect snapper and use snapper's snapshot description if available.
+* Automatically generate `grub.cfg` if you use the provided systemd service.
 ##
-### How to use it:
+### Installation :
+#### Arch Linux
 
-Add this lines to /etc/default/grub:
+```
+pacman -S grub-btrfs
+```
+
+### Manual
+
+* Run `make install` or look into Makefile for instructions on where to put each file.
+
+NOTE: Generate your Grub menu after installation for the changes to take effect.
+
+On Arch Linux use `grub-mkconfig -o /boot/grub/grub.cfg`.
+
+##
+### Customization:
+
+You have the possibility to modify many parameters in `/etc/default/grub-btrfs/config`.
 
 * GRUB_BTRFS_SUBMENUNAME="Arch Linux Snapshots"
 
-	(Name menu appearing in grub.)
+	Name appearing in the Grub menu. Use distribution information from /etc/os-release by default.
 
 * GRUB_BTRFS_PREFIXENTRY="Snapshot:"
 
-	(Add a name ahead your snapshots entries.)
+	Add a name ahead your snapshots entries in the Grub menu.
 	
 * GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"
 	
-	(Show full path snapshot or only name, weird reaction with snapper)
+	Show full path snapshot or only name in the Grub menu, weird reaction with snapper.
 	
 * GRUB_BTRFS_TITLE_FORMAT="p/d/n"
 
- 	(Custom title, shows/hides p"prefix" d"date" n"name" in grub-menu, separator "/", custom order available)
-
-* GRUB_BTRFS_NKERNEL=("vmlinuz-linux")
-
-	(Use only if you have a custom kernel name or auto-detect failed.)
-
-* GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")
-
-	(Use only if you have a custom initramfs name or auto-detect failed.)
-
-* GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
-
-	(Use only if you have custom intel-ucode or auto-detect failed.)
+ 	Custom title, shows/hides p"prefix" d"date" n"name" in the Grub menu, separator "/", custom order available.
 
 * GRUB_BTRFS_LIMIT="50"
 
-	(Limit the number of snapshots populated in the GRUB menu.)
+	Limit the number of snapshots populated in the GRUB menu.
 
 * GRUB_BTRFS_SUBVOLUME_SORT="descending"
 
-	(Sort the found subvolumes by newest first ("descending") or oldest first ("ascending"). 
-	If "ascending" is chosen then the $GRUB_BTRFS_LIMIT oldest
-	subvolumes will populate the menu.)
+	Sort the found subvolumes by newest first ("descending") or oldest first ("ascending"). 
+	
+	If "ascending" is chosen then 
+	
+	the $GRUB_BTRFS_LIMIT oldest subvolumes will populate the menu.
 
 * GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"
 	
-	(Show snapshots found during run "grub-mkconfig") 
+	Show snapshots found during run "grub-mkconfig".
 	
 * GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND="true"
 	
-	(Show Total number of snapshots found during run "grub-mkconfig")
+	Show Total number of snapshots found during run "grub-mkconfig".
 
-* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "nosnapshot")
+* GRUB_BTRFS_NKERNEL=("kernel-custom")
 
-	(Ignore specific path during run "grub-mkconfig")
+	Use it only if you have a custom kernel name
 
-* GRUB_BTRFS_CREATE_ONLY_HARMONIZED_ENTRIES="true"
+* GRUB_BTRFS_NINIT=("initramfs-custom.img" "initrd.img-custom")
+
+	Use it only if you have a custom initramfs name.
+
+* GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
+
+	Use it only if you have custom intel-ucode.
+
+* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")
+
+	Ignore specific path during run "grub-mkconfig".
+	
+	For example: 
+	
+	If path is a directory `# Found Snapshot: 2016-03-31 10:24:41` **var/lib/docker/btrfs/subvolumes/...**
+	
+	use : `GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")`
+	
+	If path is a subvolume : `# Found Snapshot: 2016-03-31 10:24:41` **@var/lib/docker/btrfs/subvolumes/...**
+	
+	use : `GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@var/lib/docker")`
+	
+	You can combine them
+	
+	use : `GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@var/lib/docker" "var/lib/docker")`
 
-	(Create entries with matching version number instead of all possible combinations of kernel and initramfs, very useful with debian-like distributions)
 
 * GRUB_BTRFS_SNAPPER_CONFIG="root"													
 
-	(Snapper's config name to use)
+	Snapper's config name to use.
 
+* GRUB_BTRFS_DISABLE="false"
 
-Generate grub.cfg (on Arch linux use grub-mkconfig -o /boot/grub/grub.cfg )
+	Disable grub-btrfs.
 
-grub-btrfs automatically generates snapshots entries.
+* GRUB_BTRFS_DIRNAME="grub"
+
+	Name of the grub folder in `/boot/`, might be grub2 on some distributions.
+
+* GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false"
+
+	Change to "true" if you have a boot partition in a different subvolume.
+
+* GRUB_BTRFS_MKCONFIG=grub-mkconfig
+
+	Name or path of the 'grub-mkconfig' executable; might be 'grub2-mkconfig' on some distributions.
+	
+- Password protection management for submenu (refer to the [Grub documentation](https://www.gnu.org/software/grub/manual/grub/grub.html#Authentication-and-authorisation))
+
+	- GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS=""
+
+		Add authorized usernames separate by comma (foo,bar)
+	
+		When Grub's password protection is enabled, the superuser is authorized by default, it isn't necessary to add it
+		
+	- GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="false"
+
+		Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
+	
+		doesn't work if `GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS` isn't empty
 
-You will see it appear differents entries (e.g : Snapshot: 2018-01-03 15:08:41  @test1 )
 ##
 ### Automatically update grub
-
-If you would like grub to automatically update when Snapper timeline snapshots and cleanups occur, simply install `10-update_grub.conf` in the following locations:
-
-- `/etc/systemd/system/snapper-timeline.service.d/`
-- `/etc/systemd/system/snapper-cleanup.service.d/`
-
-Once the configuration files are in place, `systemctl daemon-reload` should be run to reload the units and make the changes active.
-
-##
-### Discussion
-Pour les francophones : https://forums.archlinux.fr/viewtopic.php?f=18&t=17177
+If you would like Grub to automatically update when a snapshot is made or deleted:
+* Mount your subvolume which contains snapshots to `/.snapshots`
+* Use `systemctl start/enable grub-btrfs.path`
+* `grub-btrfs.path` automatically (re)generates `grub.cfg` when a modification appears in `/.snapshots`
 ##
 ### Special thanks for assistance and contributions
-
 * [maximbaz](https://github.com/maximbaz)
 * [crossroads1112](https://github.com/crossroads1112)
 * [penetal](https://github.com/penetal)

config

@@ -0,0 +1,87 @@
+#!/usr/bin/env bash
+
+# Name appearing in the Grub menu
+# Default: Use distribution information from /etc/os-release
+#GRUB_BTRFS_SUBMENUNAME="Arch Linux snapshots"
+
+# Add a name ahead your snapshots entries in the Grub menu
+# Default: "Snapshot:"
+#GRUB_BTRFS_PREFIXENTRY="Snapshot:"
+
+# Show full path snapshot or only name in the Grub menu
+# Default: "true"
+#GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"
+
+# Custom title
+# shows/hides p"prefix" d"date" n"name" in the Grub menu, separator "/", custom order available
+# Default: "p/d/n"
+#GRUB_BTRFS_TITLE_FORMAT="p/d/n"
+
+# Limit the number of snapshots populated in the GRUB menu
+# Default: "50"
+#GRUB_BTRFS_LIMIT="50"
+
+# Sort the found subvolumes by newest first ("descending") or oldest first ("ascending") and show $GRUB_BTRFS_LIMIT first entries.
+# Default: "descending"
+#GRUB_BTRFS_SUBVOLUME_SORT="descending"
+
+# Show snapshots found during run "grub-mkconfig"
+# Default: "true"
+#GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"
+
+# Show Total of snapshots found during run "grub-mkconfig"
+# Default: "true"
+#GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND="true"
+
+# Use only if you have custom kernel name
+# Default:
+#GRUB_BTRFS_NKERNEL=("vmlinuz-linux")
+
+# Use only if you have custom initramfs name
+# Default:
+#GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")
+
+# Use only if you have custom intel-ucode
+# Default:
+#GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
+
+# Ignore specific path during run "grub-mkconfig".
+# If path is a directory, # Found Snapshot: 2016-03-31 10:24:41 var/lib/docker/btrfs/subvolumes/...
+# use : GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker");
+# If path is a subvolume, # Found Snapshot: 2016-03-31 10:24:41 @var/lib/docker/btrfs/subvolumes/...
+# use : GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@var/lib/docker");
+# You can combine them
+# use : GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@var/lib/docker" "var/lib/docker")
+# Default: 
+GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "@var/lib/docker")
+
+# Snapper's config name to use
+# Default: "root"
+#GRUB_BTRFS_SNAPPER_CONFIG="root"
+
+# Disable Grub-btrfs
+# Default: "false"
+#GRUB_BTRFS_DISABLE="false"
+
+# Change to "true" if you have a boot partition in a different subvolume
+# Default: "false"
+#GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false"
+
+# Might be grub2 on some systems ex. /boot/grub2/...
+# Default: "grub"
+#GRUB_BTRFS_DIRNAME="grub"
+
+# Might be 'grub2-mkconfig' on some systems
+# Default: /usr/bin/grub-mkconfig
+#GRUB_BTRFS_MKCONFIG=/usr/bin/grub2-mkconfig
+
+## Password protection management for submenu,snapshots
+# Add authorized usernames separate by comma (foo,bar)
+# When Grub's password protection is enabled, the superuser is authorized by default, it isn't necessary to add it
+# Default:
+# GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS=""
+#
+# Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
+# doesn't work if GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS isn't empty
+# Default: false
+# GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="false"

grub-btrfs.path

@@ -0,0 +1,8 @@
+[Unit]
+Description=Monitors for new snapshots
+
+[Path]
+PathModified=/.snapshots
+
+[Install]
+WantedBy=multi-user.target

grub-btrfs.service

@@ -0,0 +1,11 @@
+[Unit]
+Description=Regenerate grub-btrfs.cfg
+
+[Service]
+Type=oneshot
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/default/grub-btrfs/config
+# Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists and is not empty, else regenerate the whole grub menu
+ExecStart=/bin/bash -c 'if [ -s "/boot/${GRUB_BTRFS_DIRNAME:-grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-/usr/bin/grub-mkconfig} -o /boot/${GRUB_BTRFS_DIRNAME:-grub}/grub.cfg; fi'