feat(pkgctl): add internal update checksums to better control output

This allows us to have more control over the output and status logs.
Using this method we are able to avoid cluttering the version upgrade
subcommand while downloading sources for updating the checksums.

Having this internally will also allow us in the future to have smart
checksums updating by only trying to change the checksums of sources
that have actually changed, for example when adjusting a patch file we
should avoid trying to overwrite the archive checksums unintentionally.

Component: pkgctl version upgrade

4 files changed, 101 insertions, 13 deletions

diff --git a/src/lib/build/build.sh b/src/lib/build/build.sh
index c35d70f..c3e05be 100644
--- a/src/lib/build/build.sh
+++ b/src/lib/build/build.sh
@@ -437,10 +437,11 @@ pkgctl_build() {
 			stat_done
 		fi
 
-
 		# update checksums if any sources are declared
 		if (( UPDATE_CHECKSUMS )) && (( ${#source[@]} >= 1 )); then
-			updpkgsums
+			if ! result=$(pkgbuild_update_checksums /dev/stderr); then
+				die "${result}"
+			fi
 		fi
 
 		# re-source the PKGBUILD if it changed
diff --git a/src/lib/util/makepkg.sh b/src/lib/util/makepkg.sh
index 22df247..d7ec74c 100644
--- a/src/lib/util/makepkg.sh
+++ b/src/lib/util/makepkg.sh
@@ -22,9 +22,11 @@ makepkg_source_package() {
 		return
 	fi
 	(
+		# shellcheck disable=SC2030 disable=SC2031
 		export LIBMAKEPKG_LINT_PKGBUILD_SH=1
 		lint_pkgbuild() { :; }
 
+		# shellcheck disable=SC2030 disable=SC2031
 		export LIBMAKEPKG_SRCINFO_SH=1
 		write_srcinfo() { print_srcinfo; }
 
@@ -35,3 +37,21 @@ makepkg_source_package() {
 		source "$(command -v makepkg)"
 	)
 }
+
+makepkg_generate_integrity() {
+	if [[ -z ${DEVTOOLS_GENERATE_INTEGRITY} ]]; then
+		[[ -z ${WORKDIR:-} ]] && setup_workdir
+		export WORKDIR DEVTOOLS_INCLUDE_COMMON_SH
+		bash -$- -c "DEVTOOLS_GENERATE_INTEGRITY=1; source '${BASH_SOURCE[0]}' && ${FUNCNAME[0]}"
+		return
+	fi
+	(
+		# shellcheck disable=SC2030 disable=SC2031
+		export LIBMAKEPKG_LINT_PKGBUILD_SH=1
+		lint_pkgbuild() { :; }
+
+		set +e -- --geninteg
+		# shellcheck source=/usr/bin/makepkg
+		source "$(command -v makepkg)"
+	)
+}
diff --git a/src/lib/util/pkgbuild.sh b/src/lib/util/pkgbuild.sh
index ebf8e5f..245a82f 100644
--- a/src/lib/util/pkgbuild.sh
+++ b/src/lib/util/pkgbuild.sh
@@ -6,10 +6,13 @@
 DEVTOOLS_INCLUDE_UTIL_PKGBUILD_SH=1
 
 _DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/util/makepkg.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/util/makepkg.sh
 
 source /usr/share/makepkg/util/message.sh
+source /usr/share/makepkg/util/schema.sh
 
-set -e
+set -eo pipefail
 
 
 # set the pkgver variable in a PKGBUILD
@@ -41,3 +44,48 @@ pkgbuild_set_pkgrel() {
 	sed --regexp-extended "s|^(pkgrel=)${pkgrel}$|\1${new_pkgrel}|g" --in-place PKGBUILD
 }
 
+pkgbuild_update_checksums() {
+	local status_file=$1
+	local builddir newbuildfile sumtypes newsums
+
+	[[ -z ${WORKDIR:-} ]] && setup_workdir
+
+	builddir=$(mktemp --tmpdir="${WORKDIR}" --directory update-checksums.XXXXXX)
+	newbuildfile="${builddir}/PKGBUILD"
+
+	# generate new integrity checksums
+	if ! newsums=$(BUILDDIR=${builddir} makepkg_generate_integrity 2>"${status_file}"); then
+		printf 'Failed to generate new checksums'
+		return 1
+	fi
+
+	# early exit if no integrity checksums are needed
+	if [[ -z ${newsums} ]]; then
+		return 0
+	fi
+
+	# replace the integrity sums and write it to a temporary file
+	sumtypes=$(IFS='|'; echo "${known_hash_algos[*]}")
+	if ! awk --assign=sumtypes="${sumtypes}" --assign=newsums="${newsums}" '
+		$0 ~"^[[:blank:]]*(" sumtypes ")sums(_[^=]+)?\\+?=", $0 ~ "\\)[[:blank:]]*(#.*)?$" {
+			if (!w) {
+				print newsums
+				w++
+			}
+			next
+		}
+
+		1
+		END { if (!w) print newsums }' PKGBUILD > "${newbuildfile}"; then
+		printf 'Failed to replace the generated checksums'
+		return 1
+	fi
+
+	# overwrite the original PKGBUILD while preserving permissions
+	if ! cat -- "${newbuildfile}" > PKGBUILD; then
+		printf "Failed to write to the PKGBUILD file"
+		return 1
+	fi
+
+	return 0
+}
diff --git a/src/lib/version/upgrade.sh b/src/lib/version/upgrade.sh
index 2885182..c57171c 100644
--- a/src/lib/version/upgrade.sh
+++ b/src/lib/version/upgrade.sh
@@ -115,6 +115,12 @@ pkgctl_version_upgrade() {
 			die "No PKGBUILD found for ${path}"
 		fi
 
+		# reset common PKGBUILD variables
+		unset pkgbase pkgname arch source pkgver pkgrel validpgpkeys
+		# shellcheck source=contrib/makepkg/PKGBUILD.proto
+		. ./PKGBUILD
+		pkgbase=${pkgbase:-$pkgname}
+
 		# update the current terminal spinner status
 		(( ++current_item ))
 		pkgctl_version_upgrade_spinner \
@@ -123,13 +129,9 @@ pkgctl_version_upgrade() {
 			"${#out_of_date[@]}" \
 			"${#failure[@]}" \
 			"${current_item}" \
-			"${#pkgbases[@]}"
-
-		# reset common PKGBUILD variables
-		unset pkgbase pkgname arch source pkgver pkgrel validpgpkeys
-		# shellcheck source=contrib/makepkg/PKGBUILD.proto
-		. ./PKGBUILD
-		pkgbase=${pkgbase:-$pkgname}
+			"${#pkgbases[@]}" \
+			"${pkgbase}" \
+			"query latest version"
 
 		if ! result=$(get_upstream_version); then
 			result="${BOLD}${pkgbase}${ALL_OFF}: ${result}"
@@ -162,7 +164,20 @@ pkgctl_version_upgrade() {
 
 			# download sources and update the checksums
 			if (( update_checksums )); then
-				updpkgsums
+				pkgctl_version_upgrade_spinner \
+					"${status_dir}" \
+					"${#up_to_date[@]}" \
+					"${#out_of_date[@]}" \
+					"${#failure[@]}" \
+					"${current_item}" \
+					"${#pkgbases[@]}" \
+					"${pkgbase}" \
+					"updating checksums"
+
+				if ! result=$(pkgbuild_update_checksums /dev/null); then
+					result="${BOLD}${pkgbase}${ALL_OFF}: failed to update checksums for version ${DARK_GREEN}${upstream_version}${ALL_OFF}"
+					failure+=("${result}")
+				fi
 			fi
 		fi
 
@@ -242,6 +257,8 @@ pkgctl_version_upgrade_spinner() {
 	local failure_count=$4
 	local current=$5
 	local total=$6
+	local pkgbase=$7
+	local message=$8
 
 	local percentage=$(( 100 * current / total ))
 	local tmp_file="${status_dir}/tmp"
@@ -254,8 +271,10 @@ pkgctl_version_upgrade_spinner() {
 		"${failure_count}" > "${tmp_file}"
 
 	# print the progress status
-	printf "📡 Upgrading: %s/%s [%s] %%spinner%%" \
-		"${BOLD}${current}" "${total}" "${percentage}%${ALL_OFF}"  \
+	printf "📡 %s: %s\n" \
+		"${pkgbase}" "${BOLD}${message}${ALL_OFF}" >> "${tmp_file}"
+	printf "⌛ Upgrading: %s/%s [%s] %%spinner%%" \
+		"${BOLD}${current}" "${total}" "${percentage}%${ALL_OFF}" \
 		>> "${tmp_file}"
 
 	# swap the status file