zfsbootmenu: rename UI library, normalize imports

Rename zfsbootmenu-lib to zfsbootmenu-ui-lib to more accurately represent which functions are contained therein. Additionally, normalize how libraries are sourced.
zbm-dev · Sep 20, 2023 · abf9649 · abf9649
1 parent 40f7928
commit abf9649
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 23 deletions.
diff --git a/contrib/keycache.sh b/contrib/keycache.sh
@@ -40,7 +40,7 @@
 ##    If you use different keys, just give them unique paths.)
 
 # shellcheck disable=SC1091
-[ -r /lib/zfsbootmenu-lib.sh ] && . /lib/zfsbootmenu-lib.sh
+[ -r /lib/zfsbootmenu-core.sh ] && . /lib/zfsbootmenu-core.sh
 
 # Make sure key environment variables are defined
 [ -n "${BOOTFS}" ] || exit 0

diff --git a/zfsbootmenu/bin/zfsbootmenu b/zfsbootmenu/bin/zfsbootmenu
@@ -6,7 +6,7 @@ sources=(
   /lib/profiling-lib.sh
   /etc/zfsbootmenu.conf
   /lib/zfsbootmenu-core.sh
-  /lib/zfsbootmenu-lib.sh
+  /lib/zfsbootmenu-ui.sh
   /lib/kmsg-log-lib.sh
   /etc/profile
   /lib/fzf-defaults.sh

diff --git a/zfsbootmenu/bin/zlogtail b/zfsbootmenu/bin/zlogtail
@@ -1,8 +1,20 @@
 #!/bin/bash
 
 # shellcheck disable=SC1091
-source /lib/zfsbootmenu-lib.sh >/dev/null 2>&1 || exit 1
-source /lib/kmsg-log-lib.sh >/dev/null 2>&1 || exit 1
+sources=(
+  /lib/kmsg-log-lib.sh
+  /lib/zfsbootmenu-ui.sh
+)
+
+for src in "${sources[@]}"; do
+  # shellcheck disable=SC1090
+  if ! source "${src}" >/dev/null 2>&1 ; then
+    echo "<3>ZFSBootMenu: unable to source '${src}' in $0" > /dev/kmsg
+    exit 1
+  fi
+done
+
+unset src sources
 
 [ -f "${BASE}/have_errors" ] && rm "${BASE}/have_errors"
 [ -f "${BASE}/have_warnings" ] && rm "${BASE}/have_warnings"

diff --git a/zfsbootmenu/bin/zsnapshots b/zfsbootmenu/bin/zsnapshots
@@ -5,18 +5,20 @@ sources=(
   /etc/zfsbootmenu.conf
   /lib/kmsg-log-lib.sh
   /lib/zfsbootmenu-core.sh
-  /lib/zfsbootmenu-lib.sh
+  /lib/zfsbootmenu-ui.sh
   /lib/fzf-defaults.sh
 )
 
 for src in "${sources[@]}"; do
   # shellcheck disable=SC1090
   if ! source "${src}" >/dev/null 2>&1 ; then
     echo -e "\033[0;31mWARNING: ${src} was not sourced; unable to proceed\033[0m"
-    exit
+    exit 1
   fi
 done
 
+unset src sources
+
 # Replace the global_header function with a stub
 global_header() {
   echo -n -e "\\033[1;33m[ Recover from snapshot ]"

diff --git a/zfsbootmenu/lib/zfsbootmenu-lib.sh → zfsbootmenu/lib/zfsbootmenu-ui.sh b/zfsbootmenu/lib/zfsbootmenu-lib.sh → zfsbootmenu/lib/zfsbootmenu-ui.sh
@@ -1,8 +1,8 @@
 #!/bin/bash
 # vim: softtabstop=2 shiftwidth=2 expandtab
 
-[ -n "${_ZFSBOOTMENU_LIB}" ] && return
-readonly _ZFSBOOTMENU_LIB=1
+[ -n "${_ZFSBOOTMENU_UI}" ] && return
+readonly _ZFSBOOTMENU_UI=1
 
 # shellcheck disable=SC1091
 source /lib/zfsbootmenu-core.sh >/dev/null 2>&1 || exit 1

diff --git a/zfsbootmenu/libexec/zfsbootmenu-diff b/zfsbootmenu/libexec/zfsbootmenu-diff
@@ -2,11 +2,23 @@
 # vim: softtabstop=2 shiftwidth=2 expandtab
 
 # shellcheck disable=SC1091
-source /lib/profiling-lib.sh >/dev/null 2>&1 || true
-source /etc/zfsbootmenu.conf >/dev/null 2>&1 || exit 1
-source /lib/kmsg-log-lib.sh >/dev/null 2>&1 || exit 1
-source /lib/zfsbootmenu-core.sh >/dev/null 2>&1 || exit 1
-source /lib/zfsbootmenu-lib.sh >/dev/null 2>&1 || exit 1
+sources=(
+  /lib/profiling-lib.sh
+  /etc/zfsbootmenu.conf
+  /lib/kmsg-log-lib.sh
+  /lib/zfsbootmenu-core.sh
+  /lib/zfsbootmenu-ui.sh
+)
+
+for src in "${sources[@]}"; do
+  # shellcheck disable=SC1090
+  if ! source "${src}" >/dev/null 2>&1 ; then
+    echo "<3>ZFSBootMenu: unable to source '${src}' in $0" > /dev/kmsg
+    exit 1
+  fi
+done
+
+unset src sources
 
 # prevent ctrl-c from killing us, so that zfs diff can exit cleanly
 trap '' SIGINT

diff --git a/zfsbootmenu/libexec/zfsbootmenu-help b/zfsbootmenu/libexec/zfsbootmenu-help
@@ -2,11 +2,23 @@
 # vim: softtabstop=2 shiftwidth=2 expandtab
 
 # shellcheck disable=SC1091
-source /lib/profiling-lib.sh >/dev/null 2>&1
-source /etc/zfsbootmenu.conf 2>&1 || exit 1
-source /lib/kmsg-log-lib.sh >/dev/null 2>&1 || exit 1
-source /lib/zfsbootmenu-core.sh >/dev/null 2>&1 || exit 1
-source /lib/zfsbootmenu-lib.sh >/dev/null 2>&1 || exit 1
+sources=(
+  /lib/profiling-lib.sh
+  /etc/zfsbootmenu.conf
+  /lib/kmsg-log-lib.sh
+  /lib/zfsbootmenu-core.sh
+  /lib/zfsbootmenu-ui.sh
+)
+
+for src in "${sources[@]}"; do
+  # shellcheck disable=SC1090
+  if ! source "${src}" >/dev/null 2>&1 ; then
+    echo "<3>ZFSBootMenu: unable to source '${src}' in $0" > /dev/kmsg
+    exit
+  fi
+done
+
+unset src sources
 
 # zfsbootmenu-help invokes itself, so the value of $WIDTH depends
 # on if $0 is launching fzf (-L) or is being launched inside

diff --git a/zfsbootmenu/libexec/zfunc b/zfsbootmenu/libexec/zfunc
@@ -2,11 +2,23 @@
 # vim: softtabstop=2 shiftwidth=2 expandtab
 
 # shellcheck disable=SC1091
-source /lib/profiling-lib.sh >/dev/null 2>&1
-source /etc/zfsbootmenu.conf 2>&1 || exit 1
-source /lib/kmsg-log-lib.sh >/dev/null 2>&1 || exit 1
-source /lib/zfsbootmenu-lib.sh >/dev/null 2>&1 || exit 1
-source /lib/zfsbootmenu-core.sh >/dev/null 2>&1 || exit 1
+sources=(
+  /lib/profiling-lib.sh
+  /etc/zfsbootmenu.conf
+  /lib/kmsg-log-lib.sh
+  /lib/zfsbootmenu-core.sh
+  /lib/zfsbootmenu-ui.sh
+)
+
+for src in "${sources[@]}"; do
+  # shellcheck disable=SC1090
+  if ! source "${src}" >/dev/null 2>&1 ; then
+    echo "<3>ZFSBootMenu: unable to source '${src}' in $0" > /dev/kmsg
+    exit 1
+  fi
+done
+
+unset src sources
 
 # First argument is the function name
 # the rest are positional params