Support snapper 0.7.0 (#57)

Snapper changed the order of columns, ID now comes before type.

10-update_grub.conf

@@ -0,0 +1,7 @@
+[Service]
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/grub.d/41_snapshots-btrfs_config
+# Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists, else regenerate the whole grub menu
+ExecStartPost=/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'

41_snapshots-btrfs

@@ -1,74 +1,60 @@
 #! /usr/bin/env bash
 #
 #
-#################################################################################################################################################
+#########################################################################################################################################################################
-# Written by: Antynea																#
+# Written by: Antynea
-#																		#
+# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
-# Purpose: Include btrfs snapshots at boot options (grub-menu).											#
+# Github: https://github.com/Antynea/grub-btrfs
-#																		#
+#
-# What this script does:															#
+# Purpose: Include btrfs snapshots at boot options (grub-menu).
-# - Automatically List snapshots existing on root partition (btrfs).										#
+#
-# - Automatically Detect if "/boot" is in separate partition.											#
+# What this script does:
-# - Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots. (For custon name, see below.)			#
+# Simple rollback using snapshots you made previously.
-# - Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.						#
+# - Automatically List snapshots existing on root partition (btrfs).
-#																		#
+# - Automatically Detect if "/boot" is in separate partition.
-# How to use it:																#
+# - Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
-# - Add this lines to /etc/default/grub:													#
+# - Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.
-#																		#
+# - Automatically detect snapper and use snapper's snapshot description if available.
-# * GRUB_BTRFS_SUBMENUNAME="Arch Linux snapshots" 												#
+#
-#	(Name appearing in the Grub menu.)													#
+# How to customize it:
-# * GRUB_BTRFS_PREFIXENTRY="Snapshot:"        		   											#
+# - Refer 41_snapshots-btrfs_config for the list of available options and their default values.
-#	(Add a name ahead your snapshots entries in the Grub menu.) 										#
+# - Place your configurations to either /etc/grub.d/41_snapshots-btrfs_config or /etc/default/grub.
-# * GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"													#
+#
-#	(Show full path snapshot or only name in the Grub menu)											#
+# - Generate grub.cfg (on Arch Linux use grub-mkconfig -o /boot/$grub_directory/grub.cfg)
-# * 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 automatically generates snapshots entries.
-# * GRUB_BTRFS_LIMIT="100"															#
+# - You will see it appear different entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill)
-#	(Limit the number of snapshots populated in the GRUB menu.)										#
+#
-# * GRUB_BTRFS_SUBVOLUME_SORT="descending"													#
+# Automatically update grub
-#	(Sort the found subvolumes by newest first ("descending") or oldest first ("ascending").						#
+#  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:
-#	If "ascending" is chosen then the $GRUB_BTRFS_LIMIT oldest subvolumes will populate the menu.)						#
+# - /etc/systemd/system/snapper-timeline.service.d/
-# * GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"													#
+# - /etc/systemd/system/snapper-cleanup.service.d/
-#	(Show snapshots found during run "grub-mkconfig")											#
+# Once the configuration files are in place, systemctl daemon-reload should be run to reload the units and make the changes active.
-# * GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND="true"												#
+#
-#	(Show Total of snapshots found during run "grub-mkconfig")										#
+# Special thanks for assistance and contributions:
-# * GRUB_BTRFS_NKERNEL=("vmlinuz-linux") 		 											#
+# - My friends
-#	(Use only if you have custom kernel name or auto-detect failed.)									#
+# - All contributors on Github
-# * 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_CREATE_ONLY_HARMONIZED_ENTRIES="false"												#
-#	(Create entries with matching version number instead of all possible combinations of kernel and initramfs)				#
-#																		#
-# - 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)					#
-#																		#
-#																		#
-# To do:																	#
-#																		#
-#	* Snapper support ....															#
-#																		#
-#################################################################################################################################################
 
 set -e
 
-#prefix="/usr"
+prefix="/usr"
-#exec_prefix="${prefix}"
+exec_prefix="/usr"
 datarootdir="/usr/share"
-#datadir="${datarootdir}"
 sysconfdir="/etc"
+grub_btrfs_config="${sysconfdir}/grub.d/41_snapshots-btrfs_config"
 
-. "${datarootdir}/grub/grub-mkconfig_lib"
 . "${sysconfdir}/default/grub"
+[[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
+. "$datarootdir/grub/grub-mkconfig_lib"
 
 ######################################
 ### Variables in /etc/default/grub ###
 ######################################
+## 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"}
 ## Prefix entry
@@ -83,8 +69,8 @@ nkernel=("${GRUB_BTRFS_NKERNEL[@]}")
 ninit=("${GRUB_BTRFS_NINIT[@]}")
 ## Microcode(s) name(s)
 microcode=("${GRUB_BTRFS_INTEL_UCODE[@]}")
-## Limit to show in the Grub menu
+## Limit snapshots to show in the Grub menu
-limit_snap_show="${GRUB_BTRFS_LIMIT:-100}"
+limit_snap_show="${GRUB_BTRFS_LIMIT:-50}"
 ## How to sort snapshots list
 snap_list_sort=${GRUB_BTRFS_SUBVOLUME_SORT:-"descending"}
 case "${snap_list_sort}" in
@@ -97,9 +83,12 @@ 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[@]}")
-## create only entries with harmonized version numbers
+## Snapper's config name
-harmonized_entries=${GRUB_BTRFS_CREATE_ONLY_HARMONIZED_ENTRIES:-"false"}
+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"}
 
 ########################
 ### variables script ###
@@ -107,14 +96,20 @@ harmonized_entries=${GRUB_BTRFS_CREATE_ONLY_HARMONIZED_ENTRIES:-"false"}
 ## Internationalization (default : english)
 export TEXTDOMAIN=grub-btrfs-git
 export TEXTDOMAINDIR="/usr/share/locale"
-## hints string
+## Probe info "Boot partition"
-hs_boot=$(${grub_probe} --target="hints_string" "/boot" 2>/dev/null)
+# Boot device
-## UUID of the boot partition
+boot_device=$(${grub_probe} --target=device "/boot")
-boot_uuid=$(${grub_probe} --target="fs_uuid" "/boot" 2>/dev/null)
+# hints string
-## Type filesystem of boot partition
+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)
-## UUID of the root partition
+## Probe info "Root partition"
-root_uuid=$(${grub_probe} "/" --target="fs_uuid" 2>/dev/null)
+# 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
@@ -123,123 +118,109 @@ gbgmp=$(mktemp -d)
 CLASS="--class snapshots --class gnu-linux --class gnu --class os"
 ## save IFS
 oldIFS=$IFS
-## boot_dir (auto-detect if /boot is separate partition or not)
+## Detect uuid requirement (lvm,btrfs...)
-boot_dir()
+check_uuid_required() {
-{
+if [ "x${root_uuid}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
-	boot_dir="$gbgmp/$snap_dir_name/boot"
+    || ! test -e "/dev/disk/by-uuid/${root_uuid}" \
-	[[ "$root_uuid" != "$boot_uuid" ]] && boot_dir="/boot"
+    || ( test -e "${root_device}" && uses_abstraction "${root_device}" lvm ); then
-	echo "$boot_dir"
+  LINUX_ROOT_DEVICE=${root_device}
+else
+  LINUX_ROOT_DEVICE=UUID=${root_uuid}
+fi
 }
 
 
+######################
+### Error Handling ###
+######################
+print_error()
+{
+	local arg="$@"
+	local nothing_to_do="If you think an error has occurred , please file a bug report at \" https://github.com/Antynea/grub-btrfs \"\n# Nothing to do. Abort.\n###### - Grub-btrfs: Snapshot detection ended   - ######\n"
+	printf "# ${arg}\n# ${nothing_to_do}" >&2 ;
+	exit 0
+}
+
+test_btrfs()
+{
+	set +e
+	type btrfs >/dev/null 2>&1
+	if [[ $? -ne 0 ]]; then
+		print_error "This script only supports snapshots of the btrfs filesystem, make sure you have btrfs-progs on your system."
+	fi
+	set -e
+}
 ##############
 ### Script ###
 ##############
 
-### BEGIN auto detect ###
+
+## Create entry
+entry()	{
+echo "$@" >> "/boot/$grub_directory/grub-btrfs.cfg"
+# local arg="$@"
+# echo "${arg}" >> "/boot/$grub_directory/grub-btrfs.cfg"
+# cat << EOF >> "/boot/$grub_directory/grub-btrfs.cfg"
+# ${arg}
+# EOF
+}
 
 ## menu entries
-snapshots_entry()
+make_menu_entries()
 {
 ## \" required for snap,kernels,init,microcode with space in their name
-	echo "	submenu '$title_menu' {
+	entry "submenu '$title_menu' {
-		submenu '---> $title_menu <---' { echo }
+	submenu '---> $title_menu <---' { echo }"
-	"
 	for k in "${name_kernel[@]}"; do
+		[[ ! -f "${boot_dir}"/"${k}" ]] && continue;
+		kversion=${k#*"-"}
 		for i in "${name_initramfs[@]}"; do
+			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}" ] ; then
+				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
-				echo "\
+				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 
+				else
-				echo "\
+				entry "
-		menuentry '"${k}" & "${i}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
+	menuentry '"${k}" & "${i}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
-			fi
+				fi
-			echo "\
+				entry "\
-			$(save_default_entry)
+		if [ x\$feature_all_video_module = xy ]; then
-			if [ x\$feature_all_video_module = xy ]; then
+		insmod all_video
-				insmod all_video
+		fi
-			fi
+		set gfxpayload=keep
-			set gfxpayload=keep
+		insmod ${boot_fs}
-			insmod ${boot_fs}
+		if [ x\$feature_platform_search_hint = xy ]; then
-			if [ x\$feature_platform_search_hint = xy ]; then
+			search --no-floppy --fs-uuid  --set=root ${boot_hs} ${boot_uuid}
-				search --no-floppy --fs-uuid  --set=root ${hs_boot} ${boot_uuid}
+		else
-			else
+			search --no-floppy --fs-uuid  --set=root ${boot_uuid}
-				search --no-floppy --fs-uuid  --set=root ${boot_uuid}
+		fi
-			fi
+		echo 'Loading Snapshot: "${snap_date_time}" "${snap_dir_name}"'
-			echo 'Loading Snapshot: "${snap_date_time}" "${snap_dir_name}"'
+		echo 'Loading Kernel: "${k}" ...'
-			echo 'Loading Kernel: "${k}" ...'
+		linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
-			linux \"${boot_dir_real_path}/"${k}"\" root=UUID=${root_uuid} rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
+				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
-			if [ -f "$(boot_dir)"/"${u}" ] ; then
+					entry "\
-				echo "\
+		echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
-			echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
+		initrd \"${boot_dir_root_grub}/"${u}"\" \"${boot_dir_root_grub}/"${i}"\""
-			initrd \"${boot_dir_real_path}/"${u}"\" \"${boot_dir_real_path}/"${i}"\""
+				else
-			else
+					entry "\
-				echo "\
+		echo 'Loading Initramfs: "${i}" ...'
-			echo 'Loading Initramfs: "${i}" ...'
+		initrd \"${boot_dir_root_grub}/"${i}"\""
-			initrd \"${boot_dir_real_path}/"${i}"\""
+				fi
-			fi
+	entry "	}"
-		echo "		}"
+				count_warning_menuentries=$((1+$count_warning_menuentries))
 			done
 		done
 	done
-	echo "	}"
+	entry  "}"
-}
-
-harmonized_snapshots_entry()
-{
-## \" required for snap,kernels,init,microcode with space in their name
-	echo "	submenu '$title_menu' {
-		submenu '---> $title_menu <---' { echo }
-	"
-	for k in "${name_kernel[@]}"; do
-		version=${k#vmlinuz-}
-		i=""
-		if [ -f "$(boot_dir)"/initramfs-"${version}".img ]; then
-			i=initramfs-${version}.img
-		else
-			if [ -f "$(boot_dir)"/initrd.img-"${version}" ]; then
-				i=initrd.img-${version}
-			fi
-		fi
-		for u in "${name_microcode[@]}"; do
-			if [ -f "$(boot_dir)"/"${u}" ] ; then
-				echo "\
-		menuentry '"${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
-			else 
-				echo "\
-		menuentry '"${k}" & "${i}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
-			fi
-			echo "\
-			$(save_default_entry)
-			if [ x\$feature_all_video_module = xy ]; then
-				insmod all_video
-			fi
-			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}
-			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_real_path}/"${k}"\" root=UUID=${root_uuid} rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
-			if [ -f "$(boot_dir)"/"${i}" ] ; then
-				if [ -f "$(boot_dir)"/"${u}" ] ; then
-					echo "\
-			echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
-			initrd \"${boot_dir_real_path}/"${u}"\" \"${boot_dir_real_path}/"${i}"\""
-				else
-					echo "\
-			echo 'Loading Initramfs: "${i}" ...'
-			initrd \"${boot_dir_real_path}/"${i}"\""
-				fi
-			fi
-			echo "		}"
-		done
-	done
-	echo "	}"
 }
 
 ## Trim a string from leading and trailing whitespaces
@@ -256,11 +237,11 @@ 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 list -a | tail -n +3 | cut -d'|' -f 2))
+		local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
-		local snapper_types=($(snapper -t 0 list -a | tail -n +3 | cut -d'|' -f 1))
+		local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))
 
 		IFS=$'\n'
-		local snapper_descriptions=($(snapper -t 0 list -a | tail -n +3 | cut -d'|' -f 7))
+		local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 7))
 	fi
 
 	IFS=$'\n'
@@ -273,10 +254,21 @@ snapshot_list()
 		IFS=$oldIFS
 		snap=($snap)
 		local snap_path_name=${snap[@]:13:${#snap[@]}}
+
 		# Discard deleted snapshots
 		if [ "$snap_path_name" = "DELETED" ]; then continue; fi
 		[[ ${snap_path_name%%"/"*} == "<FS_TREE>" ]] && snap_path_name=${snap_path_name#*"/"}
 
+		# ignore specific path during run "grub-mkconfig"
+		if [ ! -z "${ignore_specific_path}" ] ; then
+			for isp in ${ignore_specific_path[@]} ; do
+				[[ "${snap_path_name}" == "${isp}"/* ]] && continue 2;
+			done
+		fi
+
+		# detect if /boot directory exists
+		[[ ! -d "$gbgmp/$snap_path_name/boot" ]] && continue;
+
 		local id="${snap_path_name//[!0-9]}" # brutal way to get id: remove everything non-numeric
 		ids+=("$id")
 
@@ -293,7 +285,7 @@ snapshot_list()
 	for id in "${ids[@]}"; do
 		for j in "${!snapper_ids[@]}"; do
 			local snapper_id="${snapper_ids[$j]//[[:space:]]/}"
-			if [[ "$snapper_id" -eq "$id" ]]; then
+			if [[ "$snapper_id" == "$id" ]]; then
 				local snapper_type=$(trim "${snapper_types[$j]}")
 				local length="${#snapper_type}"
 				[[ "$length" -gt "$max_type_length" ]] && max_type_length=$length
@@ -306,7 +298,7 @@ snapshot_list()
 		local entry="${entries[$i]}"
 		for j in "${!snapper_ids[@]}"; do
 			local snapper_id="${snapper_ids[$j]//[[:space:]]/}"
-			if [[ "$snapper_id" -eq "$id" ]]; then
+			if [[ "$snapper_id" == "$id" ]]; then
 				local snapper_type=$(trim "${snapper_types[$j]}")
 				local snapper_description=$(trim "${snapper_descriptions[$j]}")
 				printf -v entry "%-${max_entry_length}s | %-${max_type_length}s | %s" "$entry" "$snapper_type" "$snapper_description"
@@ -322,15 +314,19 @@ snapshot_list()
 ## Detect kernels in "/boot"
 detect_kernel()
 {
-	## Arch original kernel (auto-detect)
+	list_kernel=()
-	for akernel in "$(boot_dir)"/vmlinuz-* ; do 
+	# Original kernel (auto-detect)
-		list_kernel+=("$akernel")
+	for okernel in	"${boot_dir}"/vmlinuz-* \
+			"${boot_dir}"/vmlinux-* \
+			"${boot_dir}"/kernel-* ; do
+		[[ ! -f "${okernel}" ]] && continue;
+		list_kernel+=("$okernel")
 	done
 
-	## Custom name kernel in GRUB_BTRFS_NKERNEL
+	# Custom name kernel in GRUB_BTRFS_NKERNEL
 	if [ ! -z "${nkernel}" ] ; then
-		for ckernel in "${nkernel[@]}" ; do
+		for ckernel in "${boot_dir}/${nkernel[@]}" ; do
-			[[ ! -f /"$(boot_dir)"/"${ckernel}" ]] && continue;
+			[[ ! -f "${ckernel}" ]] && continue;
 			list_kernel+=("$ckernel")
 		done
 	fi
@@ -339,15 +335,21 @@ detect_kernel()
 ## Detect initramfs in "/boot"
 detect_initramfs()
 {
-	## Arch original initramfs (auto-detect)
+	list_initramfs=()
-	for ainitramfs in "$(boot_dir)"/initramfs-* ; do 
+	# Original initramfs (auto-detect)
-		list_initramfs+=("$ainitramfs")
+	for oinitramfs in	"${boot_dir}"/initrd.img-* \
+				"${boot_dir}"/initrd-*.img \
+				"${boot_dir}"/initrd-*.gz \
+				"${boot_dir}"/initramfs-*.img \
+				"${boot_dir}"/initramfs-*.gz ; do
+		[[ ! -f "${oinitramfs}" ]] && continue;
+		list_initramfs+=("$oinitramfs")
 	done
-	
+
-	## Custom name initramfs in GRUB_BTRFS_NINIT
+	# Custom name initramfs in GRUB_BTRFS_NINIT
 	if [ ! -z "$ninit" ] ; then
-		for cinitramfs in "${ninit[@]}" ; do
+		for cinitramfs in "${boot_dir}/${ninit[@]}" ; do
-			[[ ! -f /"$(boot_dir)"/"${cinitramfs}" ]] && continue;
+			[[ ! -f "${cinitramfs}" ]] && continue;
 			list_initramfs+=("$cinitramfs")
 		done
 	fi
@@ -356,18 +358,21 @@ detect_initramfs()
 ## Detect microcode in "/boot"
 detect_microcode()
 {
-	## Arch original intel microcode
+	list_ucode=()
-	for aucode in "$(boot_dir)"/intel-ucode.img ; do
+	# Original intel microcode
-		list_ucode+=("$aucode")
+	for oiucode in "${boot_dir}"/intel-ucode.img ; do
+		[[ ! -f "${oiucode}" ]] && continue;
+		list_ucode+=("$oiucode")
 	done
 
-	## Custom name microcode in GRUB_BTRFS_INTEL_UCODE
+	# Custom name microcode in GRUB_BTRFS_INTEL_UCODE
 	if [ ! -z "$microcode" ] ; then
-		for cucode in "${microcode[@]}" ; do
+		for cucode in "${boot_dir}/${microcode[@]}" ; do
-			[[ ! -f /"$(boot_dir)"/"${cucode}" ]] && continue
+			[[ ! -f "${cucode}" ]] && continue
 			list_ucode+=("$cucode")
 		done
 	fi
+	if [ -z "${list_ucode}" ]; then list_ucode=(x); fi
 }
 
 ## Show full path snapshot or only name
@@ -383,103 +388,163 @@ 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}";;
+		p) 		title_menu="${prefixentry}";;
-		d)	title_menu="${snap_date_time}";;
+		d)		title_menu="${snap_date_time}";;
-		n)	title_menu="${name_snapshot}";;
+		n)		title_menu="${name_snapshot}";;
-		*)	gettext_printf $"# Warning: GRUB_BTRFS_TITLE_FORMAT=${title_format}, syntax error \n" >&2
+		*)		title_menu="${prefixentry} ${snap_date_time} ${name_snapshot}"
 	esac
 }
 
 ## List of kernels, initramfs and microcode in snapshots
-list_kernels_initramfs()
+boot_bounded()
 {
+	# Initialize menu entries
 	IFS=$'\n'
-	count_limit_snap=0
 	for item in $(snapshot_list); do
-		### fix: limit_snap_show=0
+		# fix: limit_snap_show=0
 		[[ ${limit_snap_show} -le 0 ]] && break;
 		IFS=$oldIFS
 		snap_full_name="$(echo "$item" | cut -d'|' -f2-)" # do not trim it to keep nice formatting
 		snap_dir_name="$(echo "$item" | cut -d'|' -f2)"
 		snap_dir_name="$(trim "$snap_dir_name")"
-
-		### ignore specific path during run "grub-mkconfig"
-		if [ ! -z "${ignore_specific_path}" ] ; then
-			for isp in ${ignore_specific_path[@]} ; do
-				[[ "${gbgmp}"/"${snap_dir_name}" == "${gbgmp}"/"${isp}"/* ]] && continue 2;
-			done
-		fi
-		### detect if /boot directory exists
-		[[ ! -d "$gbgmp/$snap_dir_name/boot" ]] && continue;
-		### show snapshot found during run "grub-mkconfig"
 		snap_date_time="$(echo "$item" | cut -d' ' -f1-2)"
 		snap_date_time="$(trim "$snap_date_time")"
-		if [[ "${show_snap_found}" = "true" ]]; then
+
-		gettext_printf $"# Found snapshot: %s\n" "$item" >&2 ;
+		boot_dir="$gbgmp/$snap_dir_name/boot"
-		fi
+		# Kernel (Original + custom kernel)
-		### Kernel (auto-detect + custom kernel)
-		unset list_kernel
 		detect_kernel
+		if [ -z "${list_kernel}" ]; then continue; fi
 		name_kernel=("${list_kernel[@]##*"/"}")
-		# echo "kernel = ${name_kernel[*]}"
+		# Initramfs (Original + custom initramfs)
-		if [[ "${harmonized_entries}" != "true" ]]; then
+		detect_initramfs
-			### Initramfs (autodetect + custom initramfs)
+		if [ -z "${list_initramfs}" ]; then continue; fi
-			unset list_initramfs
+		name_initramfs=("${list_initramfs[@]##*"/"}")
-			detect_initramfs
+		# microcode (intel-ucode + custom microcode)
-			name_initramfs=("${list_initramfs[@]##*"/"}")
-			# echo "initramfs = ${name_initramfs[*]}"
-		fi
-		### microcode (auto-detect + custom microcode)
-		unset list_ucode
 		detect_microcode
 		name_microcode=("${list_ucode[@]##*"/"}")
-		# echo "ucode = ${name_microcode[*]}"
+		# show snapshot found during run "grub-mkconfig"
-		### real path to boot
+		if [[ "${show_snap_found}" = "true" ]]; then
-		boot_dir_real_path="$(make_system_path_relative_to_its_root "$(boot_dir)")"
+		printf $"# Found snapshot: %s\n" "$item" >&2 ;
-		### Create menu entries
-		## name snapshot
-		path_snapshot
-		## title menu custom
-		title_format
-		# echo "${title_menu}"
-		if [[ "${harmonized_entries}" = "false" ]]; then
-			snapshots_entry
-		else
-			harmonized_snapshots_entry
 		fi
+		# Show full path snapshot or only name
+		path_snapshot
+		# Title format in grub-menu
+		title_format
+		# convert /boot directory to root of GRUB (e.g /boot become /)
+		boot_dir_root_grub="$(make_system_path_relative_to_its_root "${boot_dir}")"
+		# Make menuentries
+		make_menu_entries
 		### Limit snapshots found during run "grub-mkconfig"
 	        count_limit_snap=$((1+$count_limit_snap))
 	        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+		# Limit generation of menuentries if exceeds 250
+		# [[ $count_warning_menuentries -ge 250 ]] && break;
+	done
+	IFS=$oldIFS
+}
+boot_separate()
+{
+	boot_dir="/boot"
+	# convert /boot directory to root of GRUB (e.g /boot become /)
+	boot_dir_root_grub="$(make_system_path_relative_to_its_root "${boot_dir}")"
+
+	# Kernel (Original + custom kernel)
+	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[@]##*"/"}")
+
+	# Initialize menu entries
+	IFS=$'\n'
+	for item in $(snapshot_list); do
+		# fix: limit_snap_show=0
+		[[ ${limit_snap_show} -le 0 ]] && break;
+		IFS=$oldIFS
+		snap_full_name="$(echo "$item" | cut -d'|' -f2-)" # do not trim it to keep nice formatting
+		snap_dir_name="$(echo "$item" | cut -d'|' -f2)"
+		snap_dir_name="$(trim "$snap_dir_name")"
+		snap_date_time="$(echo "$item" | cut -d' ' -f1-2)"
+		snap_date_time="$(trim "$snap_date_time")"
+		# show snapshot found during run "grub-mkconfig"
+		if [[ "${show_snap_found}" = "true" ]]; then
+		printf $"# Found snapshot: %s\n" "$item" >&2 ;
+		fi
+		# Show full path snapshot or only name
+		path_snapshot
+		# Title format in grub-menu
+		title_format
+		# Make menuentries
+		make_menu_entries
+		# Limit snapshots found during run "grub-mkconfig"
+		count_limit_snap=$((1+$count_limit_snap))
+	        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+		# Limit generation of menuentries if exceeds 250
+		# [[ $count_warning_menuentries -ge 250 ]] && break;
 	done
 	IFS=$oldIFS
 }
-### END auto detect ###
 
 ### Start ###
-	gettext_printf "###### - Grub-btrfs: Auto-detect Start - ######\n" >&2 ;
+printf "###### - Grub-btrfs: Snapshot detection started - ######\n" >&2 ;
-	### create mount point and mounts
+# if btrfs prog isn't installed, exit
-	[[ ! -d $gbgmp ]] && mkdir -p $gbgmp
+test_btrfs
-	mount -o subvolid=5 /dev/disk/by-uuid/$root_uuid $gbgmp/
+# Delete existing config
-	### Create a menu in grub
+#rm -f --preserve-root "/boot/$grub_directory/grub-btrfs.cfg"
-	echo "submenu '${submenuname}' {"
+> "/boot/$grub_directory/grub-btrfs.cfg"
-	list_kernels_initramfs ;
+# Create mount point then mounting
-	## show total found snapshots
+[[ ! -d $gbgmp ]] && mkdir -p $gbgmp
-	if [[ "${show_total_snap_found}" = "true" ]]; then
+mount -o subvolid=5 /dev/disk/by-uuid/$root_uuid $gbgmp/
-	gettext_printf "# Found ${count_limit_snap} snapshot(s)\n" >&2 ;
+# Count menuentries
+count_warning_menuentries=0
+# Count snapshots
+count_limit_snap=0
+# detect uuid requirement
+check_uuid_required
+# Detects if /boot is a separate partition
+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
 	fi
-	## if no snapshot found, show a warning 
+fi
-	if [[ "${count_limit_snap}" = "0" ]]; then
+# unmounting mount point
-		echo " submenu '---> "No snapshot found : Press ESC to return previous menu" <---' { echo } ";
+umount $gbgmp
-		gettext_printf "# No snapshot found \n# make sure you have at least one snapshot \n# or please file a bug report at \"https://github.com/Antynea/grub-btrfs\"\n" >&2 ;
+# Show warn, menuentries exceeds 250 entries
-	fi
+[[ $count_warning_menuentries -ge 250 ]] && printf "# Generated ${count_warning_menuentries} total GRUB entries. You might experience issues loading snapshots menu in GRUB.\n" >&2 ;
-	echo "}"
+# printf "# menuentries = $count_warning_menuentries \n" >&2 ;
-	## unmount mount point
+# Show total found snapshots
-	umount $gbgmp
+if [[ "${show_total_snap_found}" = "true" && ! -z "${count_limit_snap}" && "${count_limit_snap}" != "0" ]]; then
-	gettext_printf "###### - Grub-btrfs: Auto-detect End   - ######\n" >&2 ;
+	printf "# Found ${count_limit_snap} snapshot(s)\n" >&2 ;
+fi
+# if no snapshot found, exit
+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_directory)"
+# Make a submenu in GRUB (grub.cfg)
+cat << EOF
+submenu '${submenuname}' {
+	configfile "${root_grub}/grub-btrfs.cfg"
+}
+EOF
+printf "###### - Grub-btrfs: Snapshot detection ended   - ######\n" >&2 ;
 ### End ###

41_snapshots-btrfs_config

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# 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") and show $GRUB_BTRFS_LIMIT first entries.
+# 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
+# GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")    # Use only if you have custom initramfs name
+# GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")                                 # Use only if you have custom intel-ucode
+# GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")                         # 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
+# GRUB_BTRFS_DIRNAME=grub                                                    # Might be grub2 on some systems ex. /boot/grub2/...
+# 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                                          # Might be 'grub2-mkconfig' on some systems

README.md

@@ -1,14 +1,15 @@
 [![GitHub release](https://img.shields.io/github/release/Antynea/grub-btrfs.svg)](https://github.com/Antynea/grub-btrfs)
   
-### grub-btrfs
+## grub-btrfs
 
-This is a version 1.xx of grub-btrfs
+This is a version 3.xx of grub-btrfs
-
+##### BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
-#### Description
+##
+### Description
 
 grub-btrfs, Include btrfs snapshots at boot options. (grub menu)
-
+##
-#### What does grub-btrfs v1.xx do :
+### What does grub-btrfs v3.xx do :
 
 Simple rollback using snapshots you made previously.
 
@@ -16,16 +17,18 @@ Simple rollback using snapshots you made previously.
 
 * 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 Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
 
 * 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 customize it:
 
-#### How to use it:
+You have the possibility to modify many parameters.
-
 Add this lines to /etc/default/grub:
 
-* GRUB_BTRFS_SUBMENUNAME="ArchLinux Snapshots"
+* GRUB_BTRFS_SUBMENUNAME="Arch Linux Snapshots"
 
 	(Name menu appearing in grub.)
 
@@ -35,25 +38,25 @@ Add this lines to /etc/default/grub:
 	
 * GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"
 	
-	(Show full path snapshot or only name)
+	(Show full path snapshot or only name, 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")
+* GRUB_BTRFS_NKERNEL=("kernel-custom")
 
-	(Use only if you have a custom kernel name or auto-detect failed.)
+	(Use it only if you have a custom kernel name)
 
-* GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")
+* GRUB_BTRFS_NINIT=("initramfs-custom.img" "initrd.img-custom")
 
-	(Use only if you have a custom initramfs name or auto-detect failed.)
+	(Use it only if you have a custom initramfs name)
 
 * GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
 
-	(Use only if you have custom intel-ucode or auto-detect failed.)
+	(Use it only if you have custom intel-ucode)
 
-* GRUB_BTRFS_LIMIT="100"
+* GRUB_BTRFS_LIMIT="50"
 
 	(Limit the number of snapshots populated in the GRUB menu.)
 
@@ -71,27 +74,58 @@ Add this lines to /etc/default/grub:
 	
 	(Show Total number of snapshots found during run "grub-mkconfig")
 
-* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "nosnapshot")
+* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")
 
 	(Ignore specific path during run "grub-mkconfig")
 
-* GRUB_BTRFS_CREATE_ONLY_HARMONIZED_ENTRIES="false"
+* GRUB_BTRFS_SNAPPER_CONFIG="root"													
 
-	(Create entries with matching version number instead of all possible combinations of kernel and initramfs)
+	(Snapper's config name to use)
 
+* GRUB_BTRFS_DISABLE="true"
 
+	(Disable grub-btrfs)
 
-Generate grub.cfg (on Archlinux use grub-mkconfig -o /boot/grub/grub.cfg )
+* GRUB_BTRFS_DIRNAME="grub"
+
+	(Name of the grub folder on /boot/)
+
+* 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; this is 'grub2-mkconfig' on some systems)
+
+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 differents entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill )
+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:
 
-#### TO DO
+- `/etc/systemd/system/snapper-timeline.service.d/`
+- `/etc/systemd/system/snapper-cleanup.service.d/`
 
-* Snapper support
+Or copy `grub-btrfs.path` and `grub-btrfs.service` to `/etc/systemd/system/`
 
+Once the configuration files are in place, `systemctl daemon-reload` should be run to reload the units and make the changes active.
 
-## discussion
+##
+### Discussion
 Pour les francophones : https://forums.archlinux.fr/viewtopic.php?f=18&t=17177
+##
+### Special thanks for assistance and contributions
+
+* [maximbaz](https://github.com/maximbaz)
+* [crossroads1112](https://github.com/crossroads1112)
+* [penetal](https://github.com/penetal)
+* [wesbarnett](https://github.com/wesbarnett)
+* [Psykar](https://github.com/Psykar)
+* [anyc](https://github.com/anyc)
+* [daftaupe](https://github.com/daftaupe)
+* [N-Parsons](https://github.com/N-Parsons)
+##

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/grub.d/41_snapshots-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'