path: root/lib/metadata.sh

# Functions for parsing and validating package metadata
#
# Copyright (C) 2012, 2014, 2018 Patrick McDermott
#
# This file is part of opkbuild.
#
# opkbuild is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# opkbuild is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with opkbuild.  If not, see <http://www.gnu.org/licenses/>.

_ob_metadata_do()
{
	local func=

	func="${1}"
	shift 1

	"_ob_${func}" "${@}"

	return ${?}
}

## @brief Validate a source package name
## @details \fBob_validate_source_name\fP validates a source package name
##          against the rules of the metadata plugin selected at libopkbuild's
##          build time.
## @operand name req The source package name to validate.
## @return Returns 0 if valid, 1 if invalid, or 125 if given an incorrect number
##         of arguments.
## @pure yes This function has no side effects.
ob_validate_source_name()
{
	local name=

	if [ ${#} -eq 1 ]; then
		name="${1}"
	else
		return 125
	fi

	_ob_metadata_do 'validate_source_name' "${name}"

	return ${?}
}

## @brief Validate a binary package name
## @details \fBob_validate_binary_name\fP validates a binary package name
##          against the rules of the metadata plugin selected at libopkbuild's
##          build time.
## @operand name req The binary package name to validate.
## @return Returns 0 if valid, 1 if invalid, or 125 if given an incorrect number
##         of arguments.
## @pure yes This function has no side effects.
ob_validate_binary_name()
{
	local name=

	if [ ${#} -eq 1 ]; then
		name="${1}"
	else
		return 125
	fi

	_ob_metadata_do 'validate_binary_name' "${name}"

	return ${?}
}

## @brief Parse a source package version
## @details \fBob_parse_version\fP validates and parses a source package version
##          identifier using the metadata plugin selected at libopkbuild's build
##          time.  Parsing is limited to extracting the entire upstream version
##          and distribution revision.
## @option -u upstreamver_var The name of the variable in which to store the
##                            upstream version.
## @option -d distrev_var     The name of the variable in which to store the
##                            distribution revision.
## @operand version req The version to validate and parse.
## @return Returns 0 on success; 1 on invalid \fIversion\fP; or 125 if given an
##         invalid variable name as an argument to \fB-u\fP or \fB-d\fP, an
##         invalid option, or an incorrect number of operands.
## @pure maybe This function has side effects when used with either or both of
##             the \fB-u\fP and \fB-d\fP options.  Without these options, this
##             function only validates a version identifier.  The purpose of
##             this function is mainly to extract version components using these
##             options, so in practice this function is generally not
##             subshell-safe.
ob_parse_version()
{
	local opt=
	local upstreamver_var=
	local distrev_var=
	local version=

	OPTIND=1
	while getopts 'u:d:' opt; do
		case "${opt}" in
			u)
				upstreamver_var="${OPTARG}"
				if ! _ob_validate_var_name "${upstreamver_var}"; then
					return 125
				fi
				;;
			d)
				distrev_var="${OPTARG}"
				if ! _ob_validate_var_name "${distrev_var}"; then
					return 125
				fi
				;;
			?)
				return 125
				;;
		esac
	done
	shift $(($OPTIND - 1))

	if [ ${#} -eq 1 ]; then
		version="${1}"
	else
		return 125
	fi

	if ! _ob_metadata_do 'validate_version' "${version}"; then
		return 1
	fi

	if [ -n "${upstreamver_var}" ]; then
		eval ${upstreamver_var}="$(_ob_metadata_do 'get_upstreamver' \
			"${version}")"
	fi
	if [ -n "${distrev_var}" ]; then
		eval ${distrev_var}="$(_ob_metadata_do 'get_distrev' \
			"${version}")"
	fi

	return 0
}

## @brief Get the running system's architecture
## @details \fBob_get_system_arch\fP gets the architecture of the build
##          (running) system using the metadata plugin selected at libopkbuild's
##          build time.
## @return Returns 0 on success, 1 if the system's architecture cannot be
##         determined, or 125 if given any arguments.
## @stdout Prints the system's architecture.
## @pure yes This function has no side effects.
ob_get_system_arch()
{
	if [ ${#} -gt 0 ]; then
		return 125
	fi

	_ob_metadata_do 'get_system_arch'

	return ${?}
}

## @brief Get the running system's platform
## @details \fBob_get_system_arch\fP gets the platform of the build (running)
##          system using the metadata plugin selected at libopkbuild's build
##          time.
## @return Returns 0 on success, 1 if the system's platform cannot be
##         determined, or 125 if given any arguments.
## @stdout Prints the system's platform.
## @pure yes This function has no side effects.
ob_get_system_plat()
{
	if [ ${#} -gt 0 ]; then
		return 125
	fi

	_ob_metadata_do 'get_system_plat'

	return ${?}
}

ob_match_arch()
{
	local arch=
	local arch_field=
	local a=
	local a_ere=

	if [ ${#} -eq 2 ]; then
		arch="${1}"
		arch_field="${2}"
	else
		return 125
	fi

	for a in ${arch_field}; do

		# "all" == "all"
		if [ "${arch}" = 'all' ]; then
			if [ "${a}" = 'all' ]; then
				return 0
			else
				continue
			fi
		fi

		# "foo-bar-baz" == "any"
		if [ "${a}" = 'any' ]; then
			return 0
		fi

		# Generate an ERE to match hyphenated architectures.
		a_ere="$(echo "${a}" | \
			sed 's/^any-/[^-]+-/;s/-any-/-[^-]+-/g;s/-any$/-[^-]+/g')"

		# "foo-bar-baz" == "foo-any-any"
		if echo "${arch}" | grep -E "${a_ere}" >/dev/null 2>&1; then
			return 0
		fi

	done

	# Nothing matched.
	return 1
}

ob_match_plat()
{
	local plat=
	local plat_field=
	local p=

	if [ ${#} -eq 2 ]; then
		plat="${1}"
		plat_field="${2}"
	else
		return 125
	fi

	for p in ${plat_field}; do
		if [ "${plat}" = 'all' ]; then
			if [ "${p}" = 'all' ]; then
				return 0
			else
				continue
			fi
		fi
		if [ "${p}" = 'any' ]; then
			return 0
		fi
		if [ "${p}" = "${plat}" ]; then
			return 0
		fi
	done

	return 1
}

ob_arch_is_concerned()
{
	local host_arch=
	local arches=
	local arch=
	local not_arch=
	local seen_arch=

	if [ ${#} -eq 2 ]; then
		host_arch="${1}"
		arches="${2}"
	else
		return 125
	fi

	if [ "x${arches}" = 'x' ]; then
		return 0
	elif [ "x${host_arch}" = 'xall' ]; then
		if [ "x${arches}" = 'xall' ]; then
			return 0
		else
			return 1
		fi
	else
		seen_arch=1
		for arch in ${arches}; do
			not_arch="${arch#!}"
			if [ "${not_arch}" != "${arch}" ]; then
				if ob_match_arch "${host_arch}" "${not_arch}"
				then
					seen_arch=1
					break
				else
					seen_arch=0
				fi
			elif ob_match_arch "${host_arch}" "${arch}"; then
				seen_arch=0
				break
			fi
		done
		return ${seen_arch}
	fi
}

ob_plat_is_concerned()
{
	local host_plat=
	local plats=
	local plat=
	local not_plat=
	local seen_plat=

	if [ ${#} -eq 2 ]; then
		host_plat="${1}"
		plats="${2}"
	else
		return 125
	fi

	if [ "x${plats}" = 'x' ]; then
		return 0
	elif [ "x${host_plat}" = 'xall' ]; then
		if [ "x${plats}" = 'xall' ]; then
			return 0
		else
			return 1
		fi
	else
		seen_plat=1
		for plat in ${plats}; do
			not_plat="${plat#!}"
			if [ "${not_plat}" != "${plat}" ]; then
				if ob_match_plat "${host_plat}" "${not_plat}"
				then
					seen_plat=1
					break
				else
					seen_plat=0
				fi
			elif ob_match_plat "${host_plat}" "${plat}"; then
				seen_plat=0
				break
			fi
		done
		return ${seen_plat}
	fi
}

## @brief Get a system path
## @details \fBob_get_system_path\fP gets a system path consisting of \fIargs\fP
##          formatted, by the metadata plugin selected at libopkbuild's build
##          time, according to a path format identified by \fIpath_id\fP.  The
##          arguments for a \fIpath_id\fP of either \fBpackage-source\fP or
##          \fBpackage-docs\fP are \fIsource\fP and \fIversion\fP.  For
##          \fBbuildflags\fP the argument is \fI arch\fP.  For \fBplatconf\fP
##          they are \fIsource\fP, \fIversion\fP, and \fIplat\fP.
## @operand path_id req One of \fBpackage-source\fP, \fBpackage-docs\fP,
##                      \fBbuildflags\fP, or \fBplatconf\fP.
## @operand args    req Additional arguments specific to each \fIpath_id\fP.
## @return Returns 0 on success, or 125 if given an incorrect number of
##         arguments.
## @stdout Prints the requested path with \fIargs\fP.
## @pure yes This function has no side effects.
ob_get_system_path()
{
	local path_id=

	if [ ${#} -ge 1 ]; then
		path_id="${1}"
		shift 1
	else
		return 125
	fi

	_ob_metadata_do 'get_system_path' "${path_id}" "${@}"

	return ${?}
}