lbmk/include/get.sh

# SPDX-License-Identifier: GPL-3.0-or-later

# Copyright (c) 2020-2021,2023-2025 Leah Rowe <leah@libreboot.org>
# Copyright (c) 2022 Caleb La Grange <thonkpeasant@protonmail.com>

depend=""
loc=""
url=""
bkup_url=""
subgit=""
subgit_bkup=""
subcurl=""
subcurl_bkup=""
subhash=""

tmpgit="$xbtmp/gitclone"
tmpgitcache="$xbtmp/tmpgit"

fetch_targets()
{
	if [ ! -d "src/$project/$tree" ]; then
		git_prep "$url" "$bkup_url" \
		    "$xbmkpwd/$configdir/$tree/patches" \
		    "src/$project/$tree" "submod"
	fi
}

fetch_project()
{
	xgcctree=""

	. "config/git/$project/pkg.cfg" || \
	    err "Can't read config 'config/git/$project/pkg.cfg'" \
	    "fetch_project" "@"

	if [ -z "$url" ] || [ -z "$bkup_url" ]; then
		err "url/bkup_url not both set 'config/git/$project/pkg.cfg'" \
		    "fetch_project" "$@"
	fi

	if [ -n "$xgcctree" ]; then
		x_ ./mk -f coreboot "$xgcctree"
	fi
	if [ -n "$depend" ]; then
		for d in $depend ; do
			x_ ./mk -f $d
		done
	fi

	clone_project
}

clone_project()
{
	loc="$XBMK_CACHE/clone/$project"
	if singletree "$project"; then
		loc="src/$project"
	fi

	if e "$loc" d missing; then
		remkdir "${tmpgit%/*}"
		git_prep "$url" "$bkup_url" \
		    "$xbmkpwd/config/$project/patches" "$loc"
	fi
}

git_prep()
{
	printf "Creating code directory, src/%s/%s\n" "$project" "$tree"

	_patchdir="$3"
	_loc="$4" # $1 and $2 are gitrepo and gitrepo_backup

	if [ -z "$rev" ]; then
		err "$project/$tree: rev not set" "git_prep" "$@"
	fi

	xbget git "$1" "$2" "$tmpgit" "$rev" "$_patchdir"
	if singletree "$project" || [ $# -gt 4 ]; then
		dx_ fetch_submodule "$mdir/module.list"
	fi

	if [ "$_loc" != "${_loc%/*}" ]; then
		x_ xbmkdir "${_loc%/*}"
	fi
	x_ mv "$tmpgit" "$_loc"
}

fetch_submodule()
{
	mcfgdir="$mdir/${1##*/}"

	subhash=""
	subgit=""
	subgit_bkup=""
	subcurl=""
	subcurl_bkup=""
	st=""

	if e "$mcfgdir/module.cfg" f missing; then
		return 0
	fi
	. "$mcfgdir/module.cfg" || \
	    err "Can't read '$mcfgdir/module.cfg'" "fetch_submodules" "$@"

	if [ -n "$subgit" ] || [ -n "$subgit_bkup" ]; then
		st="$st git"
	fi
	if [ -n "$subcurl" ] || [ -n "$subcurl_bkup" ]; then
		st="$st curl"
	fi

	st="${st# }"
	if [ "$st" = "git curl" ]; then
		err "$mdir: git+curl defined" "fetch_submodule" "$@"
	fi

	if [ -z "$st" ]; then
		return 0
	fi

	if [ "$st" = "curl" ]; then
		if [ -z "$subcurl" ] || [ -z "$subcurl_bkup" ]; then
			err "subcurl/subcurl_bkup not both set" \
			    "fetch_submodule" "$@"
		fi
	elif [ -z "$subgit" ] || [ -z "$subgit_bkup" ]; then
		err "subgit/subgit_bkup not both set" "fetch_submodule" "$@"
	elif [ -z "$subhash" ]; then
		err "subhash not set" "fetch_submodule" "$@"
	fi

	if [ "$st" = "git" ]; then
		x_ rm -Rf "$tmpgit/$1"
		xbget "$st" "$subgit" "$subgit_bkup" "$tmpgit/$1" \
		    "$subhash" "$mdir/${1##*/}/patches"
	else
		xbget "$st" "$subcurl" "$subcurl_bkup" "$tmpgit/$1" \
		    "$subhash" "$mdir/${1##*/}/patches"
	fi
}

# TODO: in the following functions, argument numbers are used
#       which is hard to understand. the code should be modified
#       so that variable names are used instead, for easy reading

xbget()
{
	if [ "$1" != "curl" ] && [ "$1" != "copy" ] && [ "$1" != "git" ]; then
		err "Bad dlop (arg 1)" "xbget" "$@"
	fi

	for url in "$2" "$3"
	do
		if [ -z "$url" ]; then
			err "empty URL given in" "xbget" "$@"
		elif ! try_fetch "$url" "$@"; then
			continue
		fi

		case "$1" in
		git)
			if [ ! -d "$4" ]; then
				continue
			fi
			;;
		*)
			if [ ! -f "$4" ]; then
				continue
			fi
			;;
		esac
		return 0 # successful download/copy
	done

	err "failed to download file/repository" "xbget" "$@"; :
}

try_fetch()
{
	if [ "$2" = "git" ]; then
		if ! try_fetch_git "$@"; then
			return 1
		fi
	else
		if ! try_fetch_file "$@"; then
			return 1
		fi
	fi
}

try_fetch_git()
{
	# always the main repo as basis for naming,
	# in case the backup has another name

	cached="clone/${3##*/}"
	cached="${cached%.git}"
	cached="$XBMK_CACHE/$cached"

	x_ xbmkdir "${5%/*}" "${cached%/*}"

	if ! try_$2 "$cached" "$@"; then
		return 1
	elif [ ! -d "$cached" ]; then
		return 1
	fi

	if [ ! -d "$5" ]; then
		tmpclone "$cached" "$5" "$6" "$7" || \
		    err "Can't clone final repo" "try_fetch" "$@"; :
	fi

	if [ ! -d "$5" ]; then
		return 1
	fi
}

try_fetch_file()
{
	cached="file/$6"
	cached="$XBMK_CACHE/$cached"

	x_ xbmkdir "${5%/*}" "${cached%/*}"

	if bad_checksum "$6" "$cached" 2>/dev/null; then
		x_ rm -f "$cached"
	fi

	if [ ! -f "$cached" ]; then
		if ! try_$2 "$cached" "$@"; then
			return 1
		fi
	fi

	if [ -f "$5" ]; then
		if bad_checksum "$6" "$5" 2>/dev/null; then
			x_ cp "$cached" "$5"
		fi
	fi

	if [ ! -f "$cached" ]; then
		return 1
	elif bad_checksum "$6" "$cached"; then
		x_ rm -f "$cached"

		return 1
	fi

	if [ "$cached" != "$5" ]; then
		x_ cp "$cached" "$5"
	fi

	if bad_checksum "$6" "$5"; then
		x_ rm -f "$5"

		return 1
	elif [ ! -f "$5" ]; then
		return 1
	fi
}

try_curl()
{
	_ua="Mozilla/5.0 (Windows NT 10.0; rv:91.0) Gecko/20100101 Firefox/91.0"

	( x_ curl --location --retry 3 -A "$_ua" "$2" -o "$1" ) \
	    || ( x_ wget --tries 3 -U "$_ua" "$2" -O "$1" ) \
	    || return 1; :
}

try_copy()
{
	( x_ cp "$2" "$1" ) || return 1; :
}

try_git()
{
	gitdest="`findpath "$1" || err "Can't get findpath for '$1'"`" || \
	    err "failed findpath for '$1'" try_get "$@"

	x_ rm -Rf "$tmpgitcache"

	if [ ! -d "$gitdest" ]; then
		( x_ git clone "$2" "$tmpgitcache" ) || return 1

		x_ xbmkdir "${gitdest%/*}"
		x_ mv "$tmpgitcache" "$gitdest"
	fi

	if git -C "$gitdest" whatchanged "$7" 1>/dev/null 2>/dev/null && \
	    [ "$forcepull" != "y" ]; then
		# don't try to pull the latest changes if the given target
		# revision already exists locally. this saves a lot of time
		# during release builds, and reduces the chance that we will
		# interact with grub.git or gnulib.git overall during runtime

		return 0
	fi

	( x_ git -C "$gitdest" remote remove main ) || :
	( x_ git -C "$gitdest" remote remove backup ) || :

	x_ git -C "$gitdest" remote add main "$4"
	x_ git -C "$gitdest" remote add backup "$5"

	( x_ git -C "$gitdest" pull --all ) || :; :
}

bad_checksum()
{
	if e "$2" f missing; then
		return 0
	fi

	build_sbase
	csum="$(x_ "$sha512sum" "$2" | awk '{print $1}')" || \
	    err "!sha512 '$2' $1" bad_checksum "$@"

	if [ "$csum" = "$1" ]; then
		return 1
	else
		x_ rm -f "$2"
		printf "BAD SHA512 %s, '%s'; need %s\n" "$csum" "$2" "$1" 1>&2
	fi
}

tmpclone()
{
	( x_ git clone "$1" "$2" ) || return 1
	( x_ git -C "$2" reset --hard "$3" ) || return 1

	if [ ! -d "$4" ]; then
		return 0
	fi

	tmpclone_patchlist="`mktemp || err "Can't create tmp patch list"`" || \
	    err "Can't create tmp patch list" "tmpclone" "$@"

	x_ find "$4" -type f | sort > "$tmpclone_patchlist" || \
	    err "Can't write patch names to '$tmpclone_patchlist'" \
	    "tmpclone" "$@"

	while read -r tmpclone_patch; do

		( x_ git -C "$2" am "$tmpclone_patch" ) || \
		    err "Can't apply '$tmpclone_patch'" "tmpclone" "$@"; :

	done < "$tmpclone_patchlist" || \
	    err "Can't read '$tmpclone_patchlist'" "tmpclone" "$@"

	x_ rm -f "$tmpclone_patchlist"
}