src: modularize repo layout into a library

This will greatly help us to structure the functionality and commands in
a more sane way. We will distribute the sources as actual libraries and
reuse code with imports instead of processing everything with m4 and
duplicating a lot of code.

3 files changed, 392 insertions, 0 deletions

diff --git a/src/lib/repo/clone.sh b/src/lib/repo/clone.sh
new file mode 100644
index 0000000..42dc383
--- /dev/null
+++ b/src/lib/repo/clone.sh
@@ -0,0 +1,139 @@
+#!/bin/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[[ -z ${DEVTOOLS_INCLUDE_REPO_CLONE_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_REPO_CLONE_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+# shellcheck source=src/lib/api/gitlab.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/api/gitlab.sh
+# shellcheck source=src/lib/repo/configure.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/repo/configure.sh
+
+source /usr/share/makepkg/util/message.sh
+
+set -e
+
+
+pkgctl_repo_clone_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
+
+		Clone Git packaging repositories from the canonical namespace.
+
+		The configure command is subsequently invoked to synchronize the distro
+		specs and makepkg.conf settings. The unprivileged option can be used
+		for cloning packaging repositories without SSH access using read-only
+		HTTPS.
+
+		OPTIONS
+		    -m, --maintainer=NAME  Clone all packages of the named maintainer
+		    -u, --unprivileged     Clone package with read-only access and without
+		                           packager info as Git author
+		    --universe             Clone all existing packages, useful for cache warming
+		    -h, --help             Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} libfoo linux libbar
+		    $ ${COMMAND} --maintainer mynickname
+_EOF_
+}
+
+pkgctl_repo_clone() {
+	if (( $# < 1 )); then
+		pkgctl_repo_clone_usage
+		exit 0
+	fi
+
+	# options
+	local GIT_REPO_BASE_URL=${GIT_PACKAGING_URL_SSH}
+	local CLONE_ALL=0
+	local MAINTAINER=
+	local CONFIGURE_OPTIONS=()
+	local pkgbases
+
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_repo_clone_usage
+				exit 0
+				;;
+			-u|--unprivileged)
+				GIT_REPO_BASE_URL=${GIT_PACKAGING_URL_HTTPS}
+				CONFIGURE_OPTIONS+=("$1")
+				shift
+				;;
+			-m|--maintainer)
+				(( $# <= 1 )) && die "missing argument for %s" "$1"
+				MAINTAINER="$2"
+				shift 2
+				;;
+			--maintainer=*)
+				MAINTAINER="${1#*=}"
+				shift
+				;;
+			--universe)
+				CLONE_ALL=1
+				shift
+				;;
+			--)
+				shift
+				break
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				pkgbases=("$@")
+				break
+				;;
+		esac
+	done
+
+	# Query packages of a maintainer
+	if [[ -n ${MAINTAINER} ]]; then
+		stat_busy "Query packages"
+		max_pages=$(curl --silent --location --fail --retry 3 --retry-delay 3 "https://archlinux.org/packages/search/json/?sort=name&maintainer=${MAINTAINER}" | jq -r '.num_pages')
+		if [[ ! ${max_pages} =~ ([[:digit:]]) ]]; then
+			stat_done
+			warning "found no packages for maintainer ${MAINTAINER}"
+			exit 0
+		fi
+		mapfile -t pkgbases < <(for page in $(seq "${max_pages}"); do
+			curl --silent --location --fail --retry 3 --retry-delay 3 "https://archlinux.org/packages/search/json/?sort=name&maintainer=${MAINTAINER}&page=${page}" | jq -r '.results[].pkgbase'
+			stat_progress
+		done | sort --unique)
+		stat_done
+	fi
+
+	# Query all released packages
+	if (( CLONE_ALL )); then
+		stat_busy "Query all released packages"
+		max_pages=$(curl --silent --location --fail --retry 3 --retry-delay 3 "https://archlinux.org/packages/search/json/?sort=name" | jq -r '.num_pages')
+		if [[ ! ${max_pages} =~ ([[:digit:]]) ]]; then
+			stat_done
+			die "failed to query packages"
+		fi
+		mapfile -t pkgbases < <(for page in $(seq "${max_pages}"); do
+			curl --silent --location --fail --retry 3 --retry-delay 3 "https://archlinux.org/packages/search/json/?sort=name&page=${page}" | jq -r '.results[].pkgbase'
+			stat_progress
+		done | sort --unique)
+		stat_done
+	fi
+
+	for pkgbase in "${pkgbases[@]}"; do
+		if [[ ! -d ${pkgbase} ]]; then
+			msg "Cloning ${pkgbase} ..."
+			remote_url="${GIT_REPO_BASE_URL}/${pkgbase}.git"
+			git clone --origin origin "${remote_url}" "${pkgbase}"
+		else
+			warning "Skip cloning ${pkgbase}: Directory exists"
+		fi
+
+		pkgctl_repo_configure "${CONFIGURE_OPTIONS[@]}" "${pkgbase}"
+	done
+}
diff --git a/src/lib/repo/configure.sh b/src/lib/repo/configure.sh
new file mode 100644
index 0000000..5c99562
--- /dev/null
+++ b/src/lib/repo/configure.sh
@@ -0,0 +1,169 @@
+#!/bin/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[[ -z ${DEVTOOLS_INCLUDE_REPO_CONFIGURE_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_REPO_CONFIGURE_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+# shellcheck source=src/lib/api/gitlab.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/api/gitlab.sh
+
+source /usr/share/makepkg/util/config.sh
+source /usr/share/makepkg/util/message.sh
+
+set -e
+
+
+pkgctl_repo_configure_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [PATH]...
+
+		Configure Git packaging repositories according to distro specs and
+		makepkg.conf settings.
+
+		Git author information and the used signing key is set up from
+		makepkg.conf read from any valid location like /etc or XDG_CONFIG_HOME.
+		The unprivileged option can be used for cloning packaging repositories
+		without SSH access using read-only HTTPS.
+
+		OPTIONS
+		    -u, --unprivileged   Configure read-only repo without packager info as Git author
+		    -h, --help           Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} configure *
+_EOF_
+}
+
+pkgctl_repo_configure() {
+	# options
+	local GIT_REPO_BASE_URL=${GIT_PACKAGING_URL_SSH}
+	local UNPRIVILEGED=0
+	local PACKAGER_NAME=
+	local PACKAGER_EMAIL=
+	local paths=()
+
+	# variables
+	local path realpath pkgbase remote_url
+
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_repo_configure_usage
+				exit 0
+				;;
+			-u|--unprivileged)
+				GIT_REPO_BASE_URL=${GIT_PACKAGING_URL_HTTPS}
+				UNPRIVILEGED=1
+				shift
+				;;
+			--)
+				shift
+				break
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				paths=("$@")
+				break
+				;;
+		esac
+	done
+
+	# check if invoked without any path from within a packaging repo
+	if (( ${#paths[@]} == 0 )); then
+		if [[ -f PKGBUILD ]]; then
+			paths=(".")
+		else
+			pkgctl_repo_configure_usage
+			exit 1
+		fi
+	fi
+
+	# Load makepkg.conf variables to be available
+	# shellcheck disable=2119
+	load_makepkg_config
+
+	# Check official packaging identity before setting Git author
+	if (( ! UNPRIVILEGED )); then
+		if [[ $PACKAGER == *"Unknown Packager"* ]]; then
+			die "Packager must be set in makepkg.conf"
+		fi
+		packager_pattern="(.+) <(.+@.+)>"
+		if [[ ! $PACKAGER =~ $packager_pattern ]]; then
+			die "Invalid Packager format '${PACKAGER}' in makepkg.conf"
+		fi
+
+		PACKAGER_NAME=$(echo "${PACKAGER}"|sed -E "s/${packager_pattern}/\1/")
+		PACKAGER_EMAIL=$(echo "${PACKAGER}"|sed -E "s/${packager_pattern}/\2/")
+
+		if [[ ! $PACKAGER_EMAIL =~ .+@archlinux.org ]]; then
+			die "Packager email '${PACKAGER_EMAIL}' is not an @archlinux.org address"
+		fi
+	fi
+
+	msg "Collected packager settings"
+	msg2 "name    : ${PACKAGER_NAME}"
+	msg2 "email   : ${PACKAGER_EMAIL}"
+	msg2 "gpg-key : ${GPGKEY:-undefined}"
+
+	# TODO: print which protocol got auto detected, ssh https
+
+	for path in "${paths[@]}"; do
+		if ! realpath=$(realpath -e "${path}"); then
+			error "No such directory: ${path}"
+			continue
+		fi
+
+		pkgbase=$(basename "${realpath}")
+		pkgbase=${pkgbase%.git}
+		msg "Configuring ${pkgbase}"
+
+		if [[ ! -d "${path}/.git" ]]; then
+			error "Not a Git repository: ${path}"
+			continue
+		fi
+
+		remote_url="${GIT_REPO_BASE_URL}/${pkgbase}.git"
+		if ! git -C "${path}" remote add origin "${remote_url}" &>/dev/null; then
+			git -C "${path}" remote set-url origin "${remote_url}"
+		fi
+
+		# move the master branch to main
+		if [[ $(git -C "${path}" symbolic-ref --short HEAD) == master ]]; then
+			git -C "${path}" branch --move main
+			git -C "${path}" config branch.main.merge refs/heads/main
+		fi
+
+		git -C "${path}" config devtools.version "${GIT_REPO_SPEC_VERSION}"
+		git -C "${path}" config pull.rebase true
+		git -C "${path}" config branch.autoSetupRebase always
+		git -C "${path}" config branch.main.remote origin
+		git -C "${path}" config branch.main.rebase true
+
+		git -C "${path}" config transfer.fsckobjects true
+		git -C "${path}" config fetch.fsckobjects true
+		git -C "${path}" config receive.fsckobjects true
+
+		if (( ! UNPRIVILEGED )); then
+			git -C "${path}" config user.name "${PACKAGER_NAME}"
+			git -C "${path}" config user.email "${PACKAGER_EMAIL}"
+			git -C "${path}" config commit.gpgsign true
+			if [[ -n $GPGKEY ]]; then
+				git -C "${path}" config user.signingKey "${GPGKEY}"
+			else
+				warning "Missing makepkg.conf configuration: GPGKEY"
+			fi
+		fi
+
+		if ! git ls-remote origin &>/dev/null; then
+			warning "configured remote origin may not exist, run:"
+			msg2 "pkgctl repo create ${pkgbase}"
+		fi
+	done
+}
diff --git a/src/lib/repo/web.sh b/src/lib/repo/web.sh
new file mode 100644
index 0000000..3fa214d
--- /dev/null
+++ b/src/lib/repo/web.sh
@@ -0,0 +1,84 @@
+#!/bin/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[[ -z ${DEVTOOLS_INCLUDE_REPO_WEB_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_REPO_WEB_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+# shellcheck source=src/lib/api/gitlab.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/api/gitlab.sh
+
+set -e
+
+
+pkgctl_repo_web_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
+
+		Open the packaging repository's website via xdg-open. If called with
+		no arguments, open the package cloned in the current working directory.
+
+		OPTIONS
+		    -h, --help    Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} web linux
+_EOF_
+}
+
+pkgctl_repo_web() {
+	local pkgbases=()
+	local path giturl pkgbase
+
+	# option checking
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_repo_web_usage
+				exit 0
+				;;
+			--)
+				shift
+				break
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				pkgbases=("$@")
+				break
+				;;
+		esac
+	done
+
+	# Check if web mode has xdg-open
+	if ! command -v xdg-open &>/dev/null; then
+		die "The web command requires 'xdg-open'"
+	fi
+
+	# Check if used without pkgnames in a packaging directory
+	if (( ! $# )); then
+		path=${PWD}
+		if [[ ! -d "${path}/.git" ]]; then
+			die "Not a Git repository: ${path}"
+		fi
+
+		giturl=$(git -C "${path}" remote get-url origin)
+		if [[ ${giturl} != *${GIT_PACKAGING_NAMESPACE}* ]]; then
+			die "Not a packaging repository: ${path}"
+		fi
+
+		pkgbase=$(basename "${giturl}")
+		pkgbase=${pkgbase%.git}
+		pkgbases=("${pkgbase}")
+	fi
+
+	for pkgbase in "${pkgbases[@]}"; do
+		path=$(gitlab_project_name_to_path "${pkgbase}")
+		xdg-open "${GIT_PACKAGING_URL_HTTPS}/${path}"
+	done
+}