From fe9195b59c9647598ecea00900edfe2678bddcac Mon Sep 17 00:00:00 2001
From: Lyndon Brown <jnqnfe@gmail.com>
Date: Fri, 13 Mar 2020 17:11:53 +0000
Subject: stagefiles: further robustify with auto filenames
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

as suggested by Raphaël

rather than have fixed stagefile filename strings at all in the scripts,
use `$(basename $0)` to use the name of the script (which is the same for
almost all cases anyway, and the stage files are supposed to be almost
exclusively unique per-script). we can thus simplify things by determining
the filename for most use cases within the functions themselves.

this does change the file used by a couple of scripts, affecting backwards
compatibility of executing live-build upon an existing partially or fully
completed build:
 - binary_grub-pc used "binary_grub"
 - chroot_includes used "includes.chroot"

care had to be taken for the following cases:
 - there are some cases like bootstrap_cache, source_debian and
   bootstrap_debootstrap which are dealing with more than one file, and/or
   otherwise a filename that is not specific to the script itself exactly,
   or should not be based upon its name.
 - some cases like chroot_cache, bootstrap_cache and
   chroot_install-packages need to append something to the end of the name
   depending upon which pass/action mode the script is being executed with.
 - furthermore in the bootstrap_cache case one of the filenames is used
   within the bootstrap_debootstrap and thus needs very careful handling
   to be certain that a change in filename of bootstrap_cache does not
   break bootstrap_debootstrap.

Gbp-Dch: Short
---
 functions/stagefile.sh | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

(limited to 'functions')

diff --git a/functions/stagefile.sh b/functions/stagefile.sh
index f51144bd3..6f9e8cc8b 100755
--- a/functions/stagefile.sh
+++ b/functions/stagefile.sh
@@ -9,9 +9,21 @@
 ## under certain conditions; see COPYING for details.
 
 
+# Get the default filename for a script's stagefile (the name of the script
+# file itself). A suffix can be appended via providing as a param.
+Stagefile_name ()
+{
+	local SUFFIX="${1}"
+	local FILENAME
+	FILENAME="$(basename $0)"
+	echo ${FILENAME}${SUFFIX:+.$SUFFIX}
+}
+
 Check_stagefile ()
 {
-	FILE=".build/${1}"
+	local FILE
+	local NAME
+	FILE=".build/${1:-$(Stagefile_name)}"
 	NAME="$(basename ${FILE})"
 
 	# Checking stage file
@@ -32,7 +44,9 @@ Check_stagefile ()
 
 Create_stagefile ()
 {
-	FILE=".build/${1}"
+	local FILE
+	local DIRECTORY
+	FILE=".build/${1:-$(Stagefile_name)}"
 	DIRECTORY="$(dirname ${FILE})"
 
 	# Creating stage directory
@@ -44,7 +58,9 @@ Create_stagefile ()
 
 Remove_stagefile ()
 {
-	rm -f ".build/${1}"
+	local FILE
+	FILE=".build/${1:-$(Stagefile_name)}"
+	rm -f "${FILE}"
 }
 
 Require_stagefile ()
-- 
cgit v1.2.3