Add systemd.path as option to monitor for new Snapshots (#53)

* Use systemd.path to regenerate grub-btrfs.cfg

* Added option GRUB_BTRFS_DIRNAME

* Updated README

10-update_grub.conf

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

41_snapshots-btrfs

@@ -1,53 +1,92 @@
-#! /usr/bin/bash
+#! /usr/bin/env bash
 #
 #
-#########################################################################################################################################
-# Written by: Antynea															#
-#																	#
-# Purpose: Include btrfs snapshots at boot options.											#
-#																	#
-# What this script does:														#
-# - List snapshots existing on root partition (btrfs).											#
-# - Create corresponding menuentry in grub.cfg , which ensures a very easy rollback.							#
-#																	#
-# How to use it:															#
-# - Add this lines to /etc/default/grub:												#
-#																	#
-# * GRUB_BTRFS_SUBMENUNAME="ArchLinux Snapshots" 					(Name menu appearing in grub.)	 		#
-# * GRUB_BTRFS_PREFIXENTRY="Snapshot"        		   				(Add a name ahead your snapshots entries.)	#
-# * GRUB_BTRFS_NKERNEL=("vmlinuz-linux") 		 				(Custom Name kernel you use it.) 		#
-# * GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")		(Custom Name initramfs (ramdisk) you use it.)	#
-# * GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img") 						(Custom Name intel microcode you use it.)	#
-#																	#
-# - Generate grub.cfg (on Archlinux use grub-mkconfig -o /boot/grub/grub.cfg )								#
-#																	#
-# - grub-btrfs automatically generates snapshots entries.										#
-# - You will see it appear different entries, e.g : Prefixentry name of snapshot [2013-02-11 04:00:00]					#
-#																	#
-# Warning:																#
-# This version detect kernels,initramfs,intel microcode only in boot partition, not in snapshot.					#
-# If those that are present in boot partition but not in snapshot,								   	#
-# entry will be created but not fonctional, you don't boot it.										#
-#																	#
-#########################################################################################################################################
+#########################################################################################################################################################################
+# Written by: Antynea
+# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
+# Github: https://github.com/Antynea/grub-btrfs
+#                                                                                                                                                                       
+# 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.
+# - 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:
+# - Refer 41_snapshots-btrfs_config for the list of available options and their default values.
+# - Place your configurations to either /etc/grub.d/41_snapshots-btrfs_config or /etc/default/grub.
+#
+# - Generate grub.cfg (on Arch Linux use grub-mkconfig -o /boot/$grub_directory/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
+#
+#########################################################################################################################################################################
+
 set -e
 
-. /usr/share/grub/grub-mkconfig_lib
-. /etc/default/grub
+prefix="/usr"
+exec_prefix="/usr"
+datarootdir="/usr/share"
+sysconfdir="/etc"
+grub_btrfs_config="${sysconfdir}/grub.d/41_snapshots-btrfs_config"
+
+. "${sysconfdir}/default/grub"
+[[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
+. "$datarootdir/grub/grub-mkconfig_lib"
 
 ######################################
-### variables in /etc/default/grub ###
+### 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:-"ArchLinux Snapshots"}
+submenuname=${GRUB_BTRFS_SUBMENUNAME:-"Arch Linux snapshots"}
 ## Prefix entry
-prefixentry=${GRUB_BTRFS_PREFIXENTRY:-"Snapshot"}
+prefixentry=${GRUB_BTRFS_PREFIXENTRY:-"Snapshot:"}
+## Show full path snapshot or only name
+path_snapshot=${GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT:-"true"}
+## Title format
+title_format=${GRUB_BTRFS_TITLE_FORMAT:-"p/d/n"}
 ## Kernel(s) name(s)
-nkernel=("${GRUB_BTRFS_NKERNEL[@]:-vmlinuz-linux}")
+nkernel=("${GRUB_BTRFS_NKERNEL[@]}")
 ## Initramfs name(s)
-ninit=("${GRUB_BTRFS_NINIT[@]:-initramfs-linux.img initramfs-linux-fallback.img}")
-## Intel-ucode name(s)
-intel_ucode=("${GRUB_BTRFS_INTEL_UCODE[@]:-intel-ucode.img}")
+ninit=("${GRUB_BTRFS_NINIT[@]}")
+## Microcode(s) name(s)
+microcode=("${GRUB_BTRFS_INTEL_UCODE[@]}")
+## Limit snapshots to show in the Grub menu
+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
+    ascending)          btrfssubvolsort=("--sort=+rootid");;
+    *)                  btrfssubvolsort=("--sort=-rootid")
+esac
+## Show snapshots found during run "grub-mkconfig"
+show_snap_found=${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}
+## Show Total of snapshots found during run "grub-mkconfig"
+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_config=${GRUB_BTRFS_SNAPPER_CONFIG:-"root"}
+
+grub_directory=${GRUB_BTRFS_DIRNAME:-"grub"}
 
 ########################
 ### variables script ###
@@ -56,99 +95,443 @@ intel_ucode=("${GRUB_BTRFS_INTEL_UCODE[@]:-intel-ucode.img}")
 export TEXTDOMAIN=grub-btrfs-git
 export TEXTDOMAINDIR="/usr/share/locale"
 ## hints string
-pboot=$(${grub_probe} --target="hints_string" "/boot" 2>/dev/null)
-## UUID of the root partition
-uuid=$(${grub_probe} "/" --target="fs_uuid" 2>/dev/null)
+hs_boot=$(${grub_probe} --target="hints_string" "/boot" 2>/dev/null)
 ## UUID of the boot partition
-buuid=$(${grub_probe} --target="fs_uuid" "/boot" 2>/dev/null)
+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)
 ## Parameters passed to the kernel
-params="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
+kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
+## Mount point location
+gbgmp=$(mktemp -d)
+## Class for theme
+CLASS="--class snapshots --class gnu-linux --class gnu --class os"
+## save IFS
+oldIFS=$IFS
+## Detect uuid requirement (lvm,btrfs...)
+check_uuid_required() {
+if [ "x${GRUB_DEVICE_UUID}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
+    || ! test -e "/dev/disk/by-uuid/${GRUB_DEVICE_UUID}" \
+    || ( test -e "${GRUB_DEVICE}" && uses_abstraction "${GRUB_DEVICE}" lvm ); then
+  LINUX_ROOT_DEVICE=${GRUB_DEVICE}
+else
+  LINUX_ROOT_DEVICE=UUID=${GRUB_DEVICE_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 ###
 ##############
 
-typeset -A date_time
-unset snapshots
 
-# Create list of filesystem snapshots
-oldIFS=$IFS
-IFS=$'\n'
+## 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
+}
 
-for snap in $($bindir/btrfs subvolume list -sa / --sort=-ogen | $bindir/awk '{gsub(/^.*<FS_TREE>\//,"",$NF);print $11" "$12"?"$NF}'); do
-        snap_name="${snap#*"?"}"
-        # Discard deleted snapshots
-        if [ $snap_name = "DELETED" ]; then continue; fi
-        snapshots+=("$snap_name")
-        date_time[$snap_name]="${snap%"?"*}"
-done
-IFS=$oldIFS
-
-# Display the menu
-echo "submenu '$submenuname' {"
-
-# Treat the kernel variables (Translation unclear)
-for kernel in ${nkernel[@]}; do
-	# Check the specified kernel(s) exist, if it/they don't, display an error and exit
-	if [ ! -f /boot/$kernel ]; then gettext_printf $"Error: /boot/$kernel, kernel does not exist" >&2; exit 1; fi
-	# If there are >1 kernels, create a menu
-	if [ ${#nkernel[*]} != 1 ]; then echo "	submenu '$kernel' {
-		submenu '---> Kernel: $kernel <---' { echo }"; fi
-	# Treat the snapshots variable
-	for item in ${snapshots[@]}; do
-		# Output name of snapshot
-		gettext_printf $"Found Snapshot: %s\n" "$item ${date_time[$item]}" >&2
-		# Create a menu for remaining snapshots (name + creation date)
-		echo "		submenu '$prefixentry $item [${date_time[$item]}]' {"
-		# if more than one kernel is found, create a menu
-		if [ ${#nkernel[*]} != 1 ]; then echo "			submenu '---> Kernel: $kernel <---' { echo }"; fi
-		# Treat the initramfs variable
-		for init in ${ninit[@]}; do
-			# Check the specified initramfs(es) exist, if it/they don't, display an error and exit
-			if [ ! -f /boot/$init ]; then gettext_printf $"Error: /boot/$init, initramfs does not exist" >&2; exit 1; fi
-			# Specify a kernel and initramfs for every snapshot
-			echo "\
-			menuentry '$item $init' --class arch --class gnu-linux --class gnu --class os "\$menuentry_id_option" 'gnulinux-snapshots-$uuid'{
-				load_video
-				set gfxpayload=$GRUB_GFXPAYLOAD_LINUX
-				if [ x"\$feature_platform_search_hint" = xy ]; then
-					search --no-floppy --fs-uuid --set=root $pboot $buuid
+## menu entries
+make_menu_entries()
+{
+## \" required for snap,kernels,init,microcode with space in their name
+	entry "submenu '$title_menu' {
+	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}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
+				entry "
+	menuentry '"${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
 				else
-					search --no-floppy --fs-uuid --set=root $buuid
+				entry "
+	menuentry '"${k}" & "${i}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
 				fi
-				echo	'Loading Linux snapshot ...'"
-				# Check the location of the /boot partition
-				if [ $uuid = $buuid ]; then
-					echo "\
-				linux	/$item/boot/$kernel root=UUID=$uuid rw rootflags=subvol=$item $params
-				echo    'Loading initial ramdisk ...'"
-				# Check intel microcode exist
-					if [ -f /boot/$intel_ucode ]; then
-						echo "\
-				initrd	/$item/boot/$intel_ucode /$item/boot/$init"
-					else
-						echo "\
-				initrd	/$item/boot/$init"
-					fi
+				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_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
+				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}"\""
 				else
-					echo "\
-				linux	/$kernel root=UUID=$uuid rw rootflags=subvol=$item $params
-				echo    'Loading initial ramdisk ...'"
-				# Check intel microcode exist
-				if [ -f /boot/$intel_ucode ]; then
-						echo "\
-				initrd	/$intel_ucode /$init"
-					else
-						echo "\
-				initrd  /$init"
-					fi
+					entry "\
+		echo 'Loading Initramfs: "${i}" ...'
+		initrd \"${boot_dir_root_grub}/"${i}"\""
 				fi
-				echo "\
-			}"
+	entry "	}"
+				count_warning_menuentries=$((1+$count_warning_menuentries))
+			done
 		done
-		echo "		}"
 	done
-	# Don't forget to close menus if more than one kernel is found
-	if [ ${#nkernel[*]} != 1 ]; then echo "	}"; fi
-done
-echo "}"
+	entry  "}"
+}
+
+## Trim a string from leading and trailing whitespaces
+trim() {
+	local var="$*"
+	var="${var#"${var%%[![:space:]]*}"}"
+	var="${var%"${var##*[![:space:]]}"}"
+	echo -n "$var"
+}
+
+## List of snapshots on filesystem
+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))
+
+		IFS=$'\n'
+		local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 7))
+	fi
+
+	IFS=$'\n'
+
+	# Parse btrfs snapshots
+	local entries=()
+	local ids=()
+	local max_entry_length=0
+	for snap in $(btrfs subvolume list -sa "${btrfssubvolsort}" /); do
+		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")
+
+		local entry="${snap[@]:10:2} | ${snap_path_name}"
+		entries+=("$entry")
+
+		# Find max length of a snapshot entry, needed for pretty formatting
+		local length="${#entry}"
+		[[ "$length" -gt "$max_entry_length" ]] && max_entry_length=$length
+	done
+
+	# Find max length of a snapshot type, needed for pretty formatting
+	local max_type_length=0
+	for id in "${ids[@]}"; do
+		for j in "${!snapper_ids[@]}"; do
+			local snapper_id="${snapper_ids[$j]//[[:space:]]/}"
+			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
+			fi
+		done
+	done
+
+	for i in "${!entries[@]}"; do
+		local id="${ids[$i]}"
+		local entry="${entries[$i]}"
+		for j in "${!snapper_ids[@]}"; do
+			local snapper_id="${snapper_ids[$j]//[[:space:]]/}"
+			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"
+				break
+			fi
+		done
+		echo "$entry"
+	done
+
+	IFS=$oldIFS
+}
+
+## Detect kernels in "/boot"
+detect_kernel()
+{
+	list_kernel=()
+	# Original kernel (auto-detect)
+	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
+	if [ ! -z "${nkernel}" ] ; then
+		for ckernel in "${boot_dir}/${nkernel[@]}" ; do
+			[[ ! -f "${ckernel}" ]] && continue;
+			list_kernel+=("$ckernel")
+		done
+	fi
+}
+
+## Detect initramfs in "/boot"
+detect_initramfs()
+{
+	list_initramfs=()
+	# Original initramfs (auto-detect)
+	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
+	if [ ! -z "$ninit" ] ; then
+		for cinitramfs in "${boot_dir}/${ninit[@]}" ; do
+			[[ ! -f "${cinitramfs}" ]] && continue;
+			list_initramfs+=("$cinitramfs")
+		done
+	fi
+}
+
+## Detect microcode in "/boot"
+detect_microcode()
+{
+	list_ucode=()
+	# Original intel microcode
+	for oiucode in "${boot_dir}"/intel-ucode.img ; do
+		[[ ! -f "${oiucode}" ]] && continue;
+		list_ucode+=("$oiucode")
+	done
+
+	# Custom name microcode in GRUB_BTRFS_INTEL_UCODE
+	if [ ! -z "$microcode" ] ; then
+		for cucode in "${boot_dir}/${microcode[@]}" ; do
+			[[ ! -f "${cucode}" ]] && continue
+			list_ucode+=("$cucode")
+		done
+	fi
+	if [ -z "${list_ucode}" ]; then list_ucode=(x); fi
+}
+
+## Show full path snapshot or only name
+path_snapshot()
+{
+	case "${path_snapshot}" in
+		true) name_snapshot=("${snap_full_name}");;
+		*) name_snapshot=("${snap_full_name#*"/"}")
+	esac
+}
+
+## Title format in grub-menu
+title_format()
+{
+	case "${title_format}" in
+		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}";;
+		*)		title_menu="${prefixentry} ${snap_date_time} ${name_snapshot}"
+	esac
+}
+
+## List of kernels, initramfs and microcode in snapshots
+boot_bounded()
+{
+	# 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")"
+
+		boot_dir="$gbgmp/$snap_dir_name/boot"
+		# Kernel (Original + custom kernel)
+		detect_kernel
+		if [ -z "${list_kernel}" ]; then continue; fi
+		name_kernel=("${list_kernel[@]##*"/"}")
+		# Initramfs (Original + custom initramfs)
+		detect_initramfs
+		if [ -z "${list_initramfs}" ]; then continue; fi
+		name_initramfs=("${list_initramfs[@]##*"/"}")
+		# microcode (intel-ucode + custom microcode)
+		detect_microcode
+		name_microcode=("${list_ucode[@]##*"/"}")
+		# 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
+		# 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
+}
+
+### Start ###
+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_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/
+# 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 [[ "$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
+# unmounting mount point
+umount $gbgmp
+# Show warn, menuentries exceeds 250 entries
+[[ $count_warning_menuentries -ge 250 ]] && printf "# Generated ${count_warning_menuentries} total GRUB entries. You might experience issues loading snapshots menu in GRUB.\n" >&2 ;
+# printf "# menuentries = $count_warning_menuentries \n" >&2 ;
+# Show total found snapshots
+if [[ "${show_total_snap_found}" = "true" && ! -z "${count_limit_snap}" && "${count_limit_snap}" != "0" ]]; then
+	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,17 @@
+#!/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/...

README.md

@@ -1,41 +1,125 @@
-### grub-btrfs
+[![GitHub release](https://img.shields.io/github/release/Antynea/grub-btrfs.svg)](https://github.com/Antynea/grub-btrfs)
+  
+## grub-btrfs
+
+This is a version 3.xx of grub-btrfs
+##### BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
+##
+### Description
+
+grub-btrfs, Include btrfs snapshots at boot options. (grub menu)
+##
+### What does grub-btrfs v3.xx do :
+
+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.
+
+* 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:
+
+You have the possibility to modify many parameters.
+Add this lines to /etc/default/grub:
+
+* GRUB_BTRFS_SUBMENUNAME="Arch Linux Snapshots"
+
+	(Name menu appearing in grub.)
+
+* GRUB_BTRFS_PREFIXENTRY="Snapshot:"
+
+	(Add a name ahead your snapshots entries.)
+	
+* GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"
+	
+	(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=("kernel-custom")
+
+	(Use it only if you have a custom kernel name)
+
+* 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_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 number of snapshots found during run "grub-mkconfig")
+
+* 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="true"
+
+	(Disable grub-btrfs)
+
+* GRUB_BTRFS_DIRNAME="grub"
+
+	(Name of the grub folder on /boot/)
 
 
-This is a version 0.xx of grub-btrfs
-
-#### Description
-
-grub-btrfs, add support for btrfs snapshots into grub menu
-
-#### What does grub-btrfs v0.xx do :
-
-Simple rollback using snapshots you made previous.
-
-Makes a list of all snapshots, kernels, initramfs present on the filesystem and then creates a corresponding entered with name and date of snapshots in grub.cfg, which ensures a very easy rollback.
-
-#### How to use it :
-
-1. Add lines to /etc/default/grub as needed, defaults listed as examples:
-2. 
-	* submenuname = name menu appear in grub ( e.g: GRUB_BTRFS_SUBMENUNAME="ArchLinux Snapshots" )
-
-	* prefixentry = add a name ahead your snapshots entries ( e.g: GRUB_BTRFS_PREFIXENTRY="Snapshot" )
-
-	* nkernel= name kernel you use it ( e.g: GRUB_BTRFS_NKERNEL=("vmlinuz-linux") )
-
-	* ninit= name initramfs (ramdisk) you use it ( e.g: GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img") )
-
-	* intel_ucode= name intel microcode you use it ( e.g: GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img") )
-
-2. Generate grub.cfg (on Archlinux is grub-mkconfig -o /boot/grub/grub.cfg )
+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 : Prefixentry name of snapshot [2013-02-11 04:00:00]
+You will see it appear differents entries (e.g : Snapshot: 2018-01-03 15:08:41  @test1 )
+##
+### Automatically update grub
 
-#### Warning
+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:
 
-Version 0.xx detect kernels,initramfs,intel microcode only in boot partition, not in snapshot.
-If kernels,initramfs,intel microcode, are present in boot partition but not in snapshot, entry will be created but not fonctional, you don't boot it.
+- `/etc/systemd/system/snapper-timeline.service.d/`
+- `/etc/systemd/system/snapper-cleanup.service.d/`
 
-Version 1.xx will do it, release soon.
+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
+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,10 @@
+[Unit]
+Description=Regenerate grub-btrfs.cfg
+
+[Service]
+Type=oneshot
+#Inital setup
+EnvironmentFile=/etc/grub.d/41_snapshots-btrfs_config
+ExecStartPre=-/bin/bash -c '[ ! -f "/boot/${GRUB_BTRFS_DIRNAME:-grub}/grub-btrfs.cfg" ] && grub2-mkconfig -o /boot/${GRUB_BTRFS_DIRNAME:-grub}/grub.cfg'
+#Regenerate grub-btrfs.cfg instead of the whole grub menu
+ExecStart=/etc/grub.d/41_snapshots-btrfs