Update getFilesystems.sh: Simplify output

* The 'lsblk' manual page suggests using '--output xxxx' since "the output may change."
* This also allows us to show HOTPLUG and slightly simplify parsing the output.
* Check if the PATH has a space in it.
* Add DEBUG output.
* Improve output messages, especially when only 1 disk (the boot one) is found.

Author: EricClaeys

scripts/utilities/getFilesystems.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
 # Help the user determine where a device like an SSD is mounted.
+# This would be a 2nd drive (or 3rd, etc.).
 
 # Allow this script to be executed manually, which requires several variables to be set.
 [[ -z ${ALLSKY_HOME} ]] && export ALLSKY_HOME="$( realpath "$( dirname "${BASH_ARGV0}" )/../.." )"
@@ -11,78 +12,106 @@ source "${ALLSKY_HOME}/variables.sh"					|| exit "${EXIT_ERROR_STOP}"
 #shellcheck source-path=scripts
 source "${ALLSKY_SCRIPTS}/functions.sh"					|| exit "${EXIT_ERROR_STOP}"
 
+DEBUG="false"
+
 function outputData()
 {
 	local HEADER="${1}"
 	local ENTRIES="${2}"
 
 	echo
 	I_ "$( echo "${HEADER}" | nawk '{
-			printf("%-15s %10s %6s  %-30s\n", $1, $4, $6, "PATH");
+			# Replace "MOUNTPOINTS" with "PATH" for readability.
+			#       NAME  SIZE TYPE  HOTPLUG MOUNTPOINTS
+			printf("%-15s %10s %6s   %7s     %-30s\n", $1, $2, $3, $4, "PATH");
 		}' )"
 	echo "${ENTRIES}" | nawk '{
-			printf("%-15s %10s %6s  %-30s\n", $1, $4, $6, $7 " " $8 " " $9);
+			printf("%-15s %10s %6s   %-7s     %-30s\n",
+				$1, $2, $3, $4 == 0 ? "no" : "yes", $5 " " $6 " " $7);
 		}'
 	echo
 }
 
 
-echo
-
-FS="$( lsblk )"
+# Light versions of Pi OS don't have an automounter so we need to use lsblk.
+FS="$( lsblk --output "NAME,SIZE,TYPE,HOTPLUG,MOUNTPOINTS" )"
 
-# Typical output:
-#	NAME        MAJ:MIN RM   SIZE RO TYPE MOUNTPOINTS
-#	sda           8:0    0 931.5G  0 disk 
-#	|-sda1        8:1    0   128M  0 part 
-#	|-sda2        8:2    0 931.4G  0 part /media/pi/SSD
-#	nvme0n1     259:0    0 465.8G  0 disk 
-#	|-nvme0n1p1 259:1    0   512M  0 part /boot/firmware
-#	|-nvme0n1p2 259:2    0 465.3G  0 part /
+# Typical lsblk output:
+#	NAME        SIZE    TYPE  HOTPLUG MOUNTPOINTS
+#	sda         931.5G  disk  0
+#	|-sda1      128M    part  0
+#	|-sda2      931.4G  part  1        /media/pi/SSD
+#	nvme0n1     465.8G  disk  0
+#	|-nvme0n1p1 512M    part  0        /boot/firmware
+#	|-nvme0n1p2 465.3G  part  0        /
 
-#	$1          $2       $3 $4     $5 $6  $7
+#	$1          $2       $3   $4       $5
 
 HEADER="$( echo "${FS}" | head -1 )"
 ENTRIES="$( echo "${FS}" | grep -v "${HEADER}" )"
+NUM_DISKS="$( echo "${FS}" | grep -E " disk| disk $" | wc -l )"
 
-# Ignore the boot drive and entries we know aren't the user's storage device.
+# Ignore the boot drive and entries we know aren't the user's extra storage device.
 POSSIBLE="$( echo "${ENTRIES}" | nawk 'BEGIN { num = 0; }
 	{
-		if ($6 == "part") {
-			M = $7;
-			if ($7 != "/" && substr($7, 0, 5) != "/boot") {
-				printf("%s", $7);
+		if ($3 == "part") {
+			mountPoint = $5;
+			if (mountPoint != "/" && substr(mountPoint, 0, 5) != "/boot") {
+				printf("%s", mountPoint);
 				# Check for up to 2 blanks in the mount point.
-				if ($8 != "") printf("%s", $8);
-				if ($9 != "") printf("%s", $9);
+				if ($6 != "") printf(" %s", $6);
+				if ($7 != "") printf(" %s", $7);
 				if (++num > 1) printf("\n");
 			}
 		}
 	}' )"
 
+if [[ ${DEBUG} == "true" ]]; then
+	echo "HEADER=[${HEADER}]"
+	echo "ENTRIES=[${ENTRIES}]"
+	echo "NUM_DISKS=${NUM_DISKS}"
+	echo "POSSIBLE=[${POSSIBLE}]"
+	echo
+fi
+
 if [[ -n ${POSSIBLE} ]]; then
+	echo
+	if [[ ${NUM_DISKS} -eq 1 ]]; then
+		W_ "This is the only disk the Pi sees:"
+	else
+		echo "The Pi sees these disks:"
+	fi
+	indent --spaces "$( outputData "${HEADER}" "${ENTRIES}" )"
+
 	NUM=$( echo -e "${POSSIBLE}" | wc -l )
-	echo -n "Your storage device is likely"
+	echo
+	echo -n "Your extra storage device is likely"
 	if [[ ${NUM} -eq 1 ]]; then
-		echo " the entry below whose 'PATH' column is '${POSSIBLE}',"
-		echo "as long as the 'Size' roughly matches your device."
+		echo " the one above whose 'PATH' column is '${POSSIBLE}',"
+		echo "as long as the 'SIZE' roughly matches your device."
+		if [[ ${POSSIBLE} =~ " " ]] then
+			echo
+			echo "If this is your device we suggest removing the space from the PATH name,"
+			echo "which may require changing the disk's label."
+		fi
 	else
-		echo " one of the entries below whose 'TYPE' column is 'part'."
+		echo " one of the entries above whose 'TYPE' column is 'part'."
 		echo "Pick the entry whose 'SIZE' most closely matches your device."
 		echo "Your storage device is in the directory in the 'PATH' column."
 	fi
-
-	outputData "${HEADER}" "${ENTRIES}"
+	echo
 
 else
-	# We get here if the disk isn't connected or isn't mounted.
-	# Light versions of Pi OS don't have an automounter so we need to use lsblk.
-	W_ "WARNING: Unable to determine where your storage device is.\n"
-
-	echo "All the disks the Pi sees are shown below:"
-
-	outputData "${HEADER}" "${ENTRIES}"
+	# We get here if the "other" disk isn't connected or isn't mounted.
+	MSG="\nWARNING: Unable to determine where your storage device is"
+	if [[ ${NUM_DISKS} -eq 1 ]]; then
+		W_ "${MSG} - only 1 disk found:"
+		indent --spaces "$( outputData "${HEADER}" "${ENTRIES}" )"
+		exit 1
+	fi
 
+	W_ "${MSG}."
+	echo
 	echo "Look at the line whose 'TYPE' column is 'part' and whose 'SIZE' column is"
 	echo "roughly the size of your device."
 	echo "If there is something in the 'PATH' column, your device is likely in that directory."