Clean code

Clean indentation/leading/trailing space

10-update_grub.conf

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

41_snapshots-btrfs

@@ -5,31 +5,34 @@
 # Written by: Antynea
 # BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
 # Github: https://github.com/Antynea/grub-btrfs
-#                                                                                                                                                                       
+#
-# Purpose: Include btrfs snapshots at boot options (grub-menu).
+# 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 : 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.)
 #
 # 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 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 customize it:
+# Installation:
-# - Refer 41_snapshots-btrfs_config for the list of available options and their default values.
+# - Run `make install` or look into Makefile for instructions on where to put each file.
-# - 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/grub.cfg)
+# Customization:
+#  Refer to config for the list of available options and their default values.
+#  Place your configurations to /etc/default/grub-btrfs/config.
 #
-# - grub-btrfs automatically generates snapshots entries.
+# Automatically update Grub
-# - You will see it appear different entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill)
+#  If you would like Grub to automatically update when a snapshots is made or deleted:
-#
+# - Mount your subvolume which contains snapshots to /.snapshots
-# Automatically update grub
+# - Use systemctl start/enable grub-btrfs.path
-#  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:
+#  grub-btrfs.path will automatically (re)generate grub.cfg when a modification appear in /.snapshots
-# - /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
@@ -43,20 +46,21 @@ prefix="/usr"
 exec_prefix="/usr"
 datarootdir="/usr/share"
 sysconfdir="/etc"
-grub_btrfs_config="${sysconfdir}/grub.d/41_snapshots-btrfs_config"
+grub_btrfs_config="${sysconfdir}/default/grub-btrfs/config"
 
-. "${sysconfdir}/default/grub"
 [[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
 . "$datarootdir/grub/grub-mkconfig_lib"
+. "${sysconfdir}/default/grub"
 
-######################################
+###################################################
-### 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
@@ -68,38 +72,53 @@ nkernel=("${GRUB_BTRFS_NKERNEL[@]}")
 ## Initramfs name(s)
 ninit=("${GRUB_BTRFS_NINIT[@]}")
 ## Microcode(s) name(s)
-microcode=("${GRUB_BTRFS_INTEL_UCODE[@]}")
+microcode=("${GRUB_BTRFS_CUSTOM_MICROCODE[@]}")
 ## 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"}
+btrfssubvolsort=(--sort="${GRUB_BTRFS_SUBVOLUME_SORT:-"-rootid"}")
-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'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 ###
 ########################
-## Internationalization (default : english)
+## Probe info "Boot partition"
-export TEXTDOMAIN=grub-btrfs-git
+# Boot device
-export TEXTDOMAINDIR="/usr/share/locale"
+boot_device=$(${grub_probe} --target=device /boot)
-## hints string
+# hints string
-hs_boot=$(${grub_probe} --target="hints_string" "/boot" 2>/dev/null)
+boot_hs=$(${grub_probe} --device ${boot_device} --target="hints_string" 2>/dev/null)
-## UUID of the boot partition
+# UUID of the boot partition
-boot_uuid=$(${grub_probe} --target="fs_uuid" "/boot" 2>/dev/null)
+boot_uuid=$(${grub_probe} --device ${boot_device} --target="fs_uuid" 2>/dev/null)
-## Type filesystem of boot partition
+# Type filesystem of boot partition
-boot_fs=$(${grub_probe} --target="fs" "/boot" 2>/dev/null)
+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
@@ -110,12 +129,12 @@ CLASS="--class snapshots --class gnu-linux --class gnu --class os"
 oldIFS=$IFS
 ## Detect uuid requirement (lvm,btrfs...)
 check_uuid_required() {
-if [ "x${GRUB_DEVICE_UUID}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
+if [ "x${root_uuid}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
-    || ! test -e "/dev/disk/by-uuid/${GRUB_DEVICE_UUID}" \
+    || ! test -e "/dev/disk/by-uuid/${root_uuid}" \
-    || ( test -e "${GRUB_DEVICE}" && uses_abstraction "${GRUB_DEVICE}" lvm ); then
+    || ( test -e "${root_device}" && uses_abstraction "${root_device}" lvm ); then
-  LINUX_ROOT_DEVICE=${GRUB_DEVICE}
+  LINUX_ROOT_DEVICE=${root_device}
 else
-  LINUX_ROOT_DEVICE=UUID=${GRUB_DEVICE_UUID}
+  LINUX_ROOT_DEVICE=UUID=${root_uuid}
 fi
 }
 
@@ -126,8 +145,8 @@ fi
 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"
+	local nothing_to_do="If you think an error has occurred , please file a bug report at \" https://github.com/Antynea/grub-btrfs \"\nNothing to do. Abort.\n"
-	printf "# ${arg}\n# ${nothing_to_do}" >&2 ;
+	printf "${arg}\n${nothing_to_do}" >&2 ;
 	exit 0
 }
 
@@ -140,6 +159,7 @@ test_btrfs()
 	fi
 	set -e
 }
+
 ##############
 ### Script ###
 ##############
@@ -147,10 +167,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"
+# echo "${arg}" >> "/boot/$grub_directory/grub-btrfs.cfg"
-# cat << EOF >> "/boot/grub/grub-btrfs.cfg"
+# cat << EOF >> "/boot/$grub_directory/grub-btrfs.cfg"
 # ${arg}
 # EOF
 }
@@ -175,12 +195,12 @@ make_menu_entries()
 			else 	continue ;
 			fi
 			for u in "${name_microcode[@]}"; do
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
+				if [[ "${name_microcode}" != "x" ]] ; 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
@@ -189,14 +209,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="${LINUX_ROOT_DEVICE}" rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
+		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
+				if [[ "${name_microcode}" != "x" ]] ; then
 					entry "\
 		echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
 		initrd \"${boot_dir_root_grub}/"${u}"\" \"${boot_dir_root_grub}/"${i}"\""
@@ -226,12 +246,17 @@ snapshot_list()
 {
 	# Query info from snapper if it is installed
 	type snapper >/dev/null 2>&1
-	if [[ $? -eq 0 ]]; then
+	if [ $? -eq 0 ]; then
-		local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))
+		if [ -s "/etc/snapper/configs/$snapper_config" ]; then
-		local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
+			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'
+			IFS=$'\n'
-		local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 7))
+			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'
@@ -251,8 +276,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
 
@@ -288,6 +314,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]}")
@@ -307,8 +337,8 @@ detect_kernel()
 	list_kernel=()
 	# Original kernel (auto-detect)
 	for okernel in	"${boot_dir}"/vmlinuz-* \
-			"${boot_dir}"/vmlinux-* \
+					"${boot_dir}"/vmlinux-* \
-			"${boot_dir}"/kernel-* ; do
+					"${boot_dir}"/kernel-* ; do
 		[[ ! -f "${okernel}" ]] && continue;
 		list_kernel+=("$okernel")
 	done
@@ -328,10 +358,10 @@ detect_initramfs()
 	list_initramfs=()
 	# Original initramfs (auto-detect)
 	for oinitramfs in	"${boot_dir}"/initrd.img-* \
-				"${boot_dir}"/initrd-*.img \
+						"${boot_dir}"/initrd-*.img \
-				"${boot_dir}"/initrd-*.gz \
+						"${boot_dir}"/initrd-*.gz \
-				"${boot_dir}"/initramfs-*.img \
+						"${boot_dir}"/initramfs-*.img \
-				"${boot_dir}"/initramfs-*.gz ; do
+						"${boot_dir}"/initramfs-*.gz ; do
 		[[ ! -f "${oinitramfs}" ]] && continue;
 		list_initramfs+=("$oinitramfs")
 	done
@@ -349,8 +379,14 @@ detect_initramfs()
 detect_microcode()
 {
 	list_ucode=()
-	# Original intel microcode
+	# Original intel/amd microcode (auto-detect)
-	for oiucode in "${boot_dir}"/intel-ucode.img ; do
+	# See "https://www.gnu.org/software/grub/manual/grub/html_node/Simple-configuration.html"
+	for oiucode in  "${boot_dir}"/intel-uc.img \
+					"${boot_dir}"/intel-ucode.img \
+					"${boot_dir}"/amd-uc.img \
+					"${boot_dir}"/amd-ucode.img \
+					"${boot_dir}"/early_ucode.cpio \
+					"${boot_dir}"/microcode.cpio; do
 		[[ ! -f "${oiucode}" ]] && continue;
 		list_ucode+=("$oiucode")
 	done
@@ -404,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
@@ -414,12 +450,12 @@ boot_bounded()
 		detect_initramfs
 		if [ -z "${list_initramfs}" ]; then continue; fi
 		name_initramfs=("${list_initramfs[@]##*"/"}")
-		# microcode (intel-ucode + custom microcode)
+		# microcode (auto-detect + 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 ;
+		printf "Found snapshot: %s\n" "$item" >&2 ;
 		fi
 		# Show full path snapshot or only name
 		path_snapshot
@@ -430,8 +466,8 @@ boot_bounded()
 		# Make menuentries
 		make_menu_entries
 		### Limit snapshots found during run "grub-mkconfig"
-	        count_limit_snap=$((1+$count_limit_snap))
+		count_limit_snap=$((1+$count_limit_snap))
-	        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+		[[ $count_limit_snap -ge $limit_snap_show ]] && break;
 		# Limit generation of menuentries if exceeds 250
 		# [[ $count_warning_menuentries -ge 250 ]] && break;
 	done
@@ -470,7 +506,7 @@ boot_separate()
 		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 ;
+		printf "Found snapshot: %s\n" "$item" >&2 ;
 		fi
 		# Show full path snapshot or only name
 		path_snapshot
@@ -480,7 +516,7 @@ boot_separate()
 		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;
+		[[ $count_limit_snap -ge $limit_snap_show ]] && break;
 		# Limit generation of menuentries if exceeds 250
 		# [[ $count_warning_menuentries -ge 250 ]] && break;
 	done
@@ -488,12 +524,12 @@ boot_separate()
 }
 
 ### Start ###
-printf "###### - Grub-btrfs: Snapshot detection started - ######\n" >&2 ;
+printf "Detecting snapshots ...\n" >&2 ;
 # if btrfs prog isn't installed, exit
 test_btrfs
 # Delete existing config
-#rm -f --preserve-root "/boot/grub/grub-btrfs.cfg"
+#rm -f --preserve-root "/boot/$grub_directory/grub-btrfs.cfg"
-> "/boot/grub/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/
@@ -504,32 +540,35 @@ count_limit_snap=0
 # detect uuid requirement
 check_uuid_required
 # Detects if /boot is a separate partition
-if [[ "$root_uuid" != "$boot_uuid" ]]; then
+if [[ "$override_boot_partition_detection" == "true" ]]; then
-	printf "# Info: Separate boot partition detected \n" >&2 ;
+	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 ;
+		printf "Info: Separate boot partition not detected \n" >&2 ;
-	boot_bounded
+		boot_bounded
+	fi
 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 ;
+[[ $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 ;
+# 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 ;
+	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)"
 # Make a submenu in GRUB (grub.cfg)
 cat << EOF
-submenu '${submenuname}' {
+submenu '${submenuname}' ${protection_authorized_users}${unrestricted_access_submenu}{
-	configfile "${root_grub}/grub-btrfs.cfg"
+	configfile "\${prefix}/grub-btrfs.cfg"
 }
 EOF
-printf "###### - Grub-btrfs: Snapshot detection ended   - ######\n" >&2 ;
 ### End ###

41_snapshots-btrfs_config

@@ -1,16 +0,0 @@
-#!/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

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,113 +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 3.xx of grub-btrfs
+This is a version 4.xx of grub-btrfs
-##### BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
+##### 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)
+You can start your system on a "snapshot" from the Grub menu.
-##
-### What does grub-btrfs v3.xx do :
 
-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/amd microcode in "/boot" directory on snapshots.
-* Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
+* Automatically Create corresponding "menuentry" in `grub.cfg`
-
-* Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.
-
 * Automatically detect snapper and use snapper's snapshot description if available.
+* Automatically generate `grub.cfg` if you use the provided systemd service.
 ##
-### How to customize it:
+### Installation :
+#### Arch Linux
 
-You have the possibility to modify many parameters.
+```
-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)
+ 	Custom title, shows/hides p"prefix" d"date" n"name" in the 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.)
+	Limit the number of snapshots populated in the GRUB menu.
 
-* GRUB_BTRFS_SUBVOLUME_SORT="descending"
+* GRUB_BTRFS_SUBVOLUME_SORT="+ogen,-gen,path,rootid"
 
-	(Sort the found subvolumes by newest first ("descending") or oldest first ("ascending"). 
+	Sort the found subvolumes by "ogeneration" or "generation" or "path" or "rootid".
-	If "ascending" is chosen then the $GRUB_BTRFS_LIMIT oldest
+	
-	subvolumes will populate the menu.)
+	Default: "-rootid" means list snapshot by new ones first
+	
+	See [Sorting section](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-subvolume#SUBCOMMAND)
 
 * 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_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_CUSTOM_MICROCODE=("intel-ucode.img")
+
+	Use it only if you have custom microcode.
 
 * GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")
 
-	(Ignore specific path during run "grub-mkconfig")
+	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")`
+
 
 * GRUB_BTRFS_SNAPPER_CONFIG="root"													
 
-	(Snapper's config name to use)
+	Snapper's config name to use.
 
-* GRUB_BTRFS_DISABLE="true"
+* GRUB_BTRFS_DISABLE="false"
 
-	(Disable grub-btrfs)
+	Disable grub-btrfs.
 
+* GRUB_BTRFS_DIRNAME="grub"
 
-Generate grub.cfg (on Arch linux use grub-mkconfig -o /boot/grub/grub.cfg )
+	Name of the grub folder in `/boot/`, might be grub2 on some distributions.
 
-grub-btrfs automatically generates snapshots entries.
+* 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 a snapshot is made or deleted:
-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:
+* Mount your subvolume which contains snapshots to `/.snapshots`
-
+* Use `systemctl start/enable grub-btrfs.path`
-- `/etc/systemd/system/snapper-timeline.service.d/`
+* `grub-btrfs.path` automatically (re)generates `grub.cfg` when a modification appears in `/.snapshots`
-- `/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
 ##
 ### 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,88 @@
+#!/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 "ogeneration" or "generation" or "path" or "rootid"
+# Default: "-rootid"
+# See Sorting section to https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-subvolume#SUBCOMMAND
+#GRUB_BTRFS_SUBVOLUME_SORT="+ogen,-gen,path,rootid"
+
+# 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 microcode
+# Default:
+#GRUB_BTRFS_CUSTOM_MICROCODE=("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'