summaryrefslogtreecommitdiffstats
path: root/lib/package.sh
blob: 0c39ca43bb3d8706ba657a9e08e676c07316b054 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# Interface for retrieving source and binary package metadata
#
# Copyright (C) 2012, 2019 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_package_dir=
_ob_package_format=
_ob_binary_packages=
_ob_got_binary_packages=false
_ob_source_parameters=
_ob_binary_parameters=

_ob_package_do()
{
	local func="${1}"
	shift 1 || _ob_abort

	"_ob_${func}_${_ob_package_format}" "${@}" || return ${?}

	return 0
}

## @brief Initialize libopkbuild for a source package
## @details \fBob_init_package\fP() detects the version of and parses all
##          metadata of a source package.  This function must be called before
##          any other functions that operate on package metadata.
## @operand dir req The root directory of the source package.
## @return Returns 0 on success or 1 if the source package version can't be
##         detected or if the metadata can't be parsed.
## @stderr Prints error or warning messages on detection or parsing errors.
## @pure no This function sets internal global variables.
ob_init_package()
{
	local dir="${1}"
	shift 1 || _ob_abort

	_ob_package_dir="$(cd -- "${dir}" && pwd)"

	if [ -r "${_ob_package_dir}/format" ]; then
		case "$(cat -- "${_ob_package_dir}/format")" in
			2.0)
				_ob_package_format='2'
				;;
		esac
	fi

	if [ -z "${_ob_package_format}" ]; then
		_ob_error_msg 'unable_to_detect_package_format'
		return 1
	fi

	_ob_binary_packages=

	_ob_package_do 'parse_package_metadata' || return ${?}

	return 0
}

## @brief Get a list of binary packages
## @details \fBob_get_binary_packages\fP() finds a source package's binary
##          packages, optionally filtering for packages that build for a certain
##          host architecture and/or platform.
## @option -a host_arch The architecture by which to filter binary packages.
## @option -a host_plat The platform by which to filter binary packages.
## @return Returns 0 on success.
## @stdout Prints the resulting list of binary packages.
## @stderr Prints warning messages on invalid binary package names and duplicate
##         "clean" binary package names.
## @pure maybe This function caches a list of all binary packages to an internal
##             global variable to save time and avoid repeating warning messages
##             on subsequent invocations.  It should therefore first be called
##             outside a subshell, though this is not required.
ob_get_binary_packages()
{
	local opt=
	local host_arch=
	local host_plat=
	local pkg=
	local pkgs_clean=
	local pkg_clean=
	local pkgs=

	OPTIND=1
	while getopts 'a:p:' opt; do
		case "${opt}" in
			a)
				host_arch="${OPTARG}"
				;;
			p)
				host_plat="${OPTARG}"
				;;
			?)
				_ob_abort
				;;
		esac
	done
	shift $((${OPTIND} - 1))

	if ! ${_ob_got_binary_packages}; then

		_ob_package_do 'get_binary_packages'

		pkgs_clean=' '

		for pkg in ${_ob_binary_packages}; do

			# Validate the name.
			if ! ob_validate_binary_name "${pkg}"; then
				_ob_warn_msg 'bad_binary_name' "${pkg}"
				continue
			fi

			# Make sure the "clean" name is unique.
			pkg_clean="$({ tr 'a-z' 'A-Z' | tr -dC 'A-Z0-9';} <<-EOF
				"${pkg}"
				EOF
				)"
			case "${pkgs_clean}" in *" ${pkg_clean} "*)
				_ob_warn_msg 'duplicate_clean_binary_name' \
					"${pkg_clean}"
				continue
			esac
			pkgs_clean="${pkgs_clean}${pkg_clean} "

			_ob_binary_packages="${_ob_binary_packages} ${pkgs}"

		done

		_ob_got_binary_packages=true

	fi

	pkgs=''

	for pkg in ${_ob_binary_packages}; do
		if [ -n "${host_arch}" ] && ! ob_arch_is_concerned \
				"${host_arch}" "$(ob_get_binary_parameter \
				"${pkg}" 'Architecture')"; then
			continue
		fi
		if [ -n "${host_plat}" ] && ! ob_plat_is_concerned \
				"${host_plat}" "$(ob_get_binary_parameter \
				"${pkg}" 'Platform')"; then
			continue
		fi
		pkgs="${pkgs} ${pkg}"
	done

	printf '%s ' ${pkgs}

	return 0
}

## @brief Get a source package field value
## @details \fBob_get_source_parameter\fP() gets the value of a source package
##          field.
## @operand name req The name of the field.
## @return Returns 0 on success or 1 if \fIname\fP is invalid.
## @stdout Prints the source package field value.
## @pure yes This function has no side effects.
ob_get_source_parameter()
{
	local name="${1}"
	shift 1 || _ob_abort

	# Convert field name to uppercase and validate.
	case "${name}" in *[!A-Za-z0-9-]* | '')
		return 1
	esac
	name="$(tr 'a-z-' 'A-Z_' <<-EOF
		${name}
		EOF
		)"

	eval "printf '%s' \"\${_OB_SRCFIELD_${name}}\""

	return 0
}

## @brief Get a binary package field value
## @details \fBob_get_binary_parameter\fP() gets the value of a binary package
##          field.
## @operand package req The name of the binary package.
## @operand name    req The name of the field.
## @return Returns 0 on success or 1 if \fIname\fP is invalid.
## @stdout Prints the binary package field value.
## @pure yes This function has no side effects.
ob_get_binary_parameter()
{
	local package="${1}"
	local name="${2}"
	shift 2 || _ob_abort

	if ! ob_validate_binary_name "${package}"; then
		return 1
	fi

	# Convert package name to its uppercase "clean" form.
	package="$({ tr 'a-z' 'A-Z' | tr -dC 'A-Z0-9'; } <<-EOF
		"${pkg}"
		EOF
		)"

	# Convert field name to uppercase and validate.
	case "${name}" in *[!A-Za-z0-9-]* | '')
		return 1
	esac
	name="$(tr 'a-z-' 'A-Z_' <<-EOF
		${name}
		EOF
		)"

	eval "printf '%s' \"\${_OB_BINFIELD_${package}_${name}}\""

	return 0
}

## @brief Get the documentation-providing binary package
## @details \fBob_get_doc_package\fP() gets the name of the binary package that
##          will provide documentation files about the source package.
## @return Returns 0 on success or 1 if no or multiple packages are found to
##         provide documentation files.
## @stdout Prints the documentation-providing binary package name.
## @pure yes This function has no side effects.
ob_get_doc_package()
{
	_ob_package_do 'get_doc_package' || return ${?}

	return 0
}

## @brief Get the source package documentation files table
## @details \fBob_get_doc_files\fP() gets the table of source package
##          documentation files.  The table consists of lines of space-separated
##          source (relative to the build work area) and destination (relative
##          to the source package documentation directory) file paths.
## @return Returns 0 on success.
## @stdout Prints the source package documentation files table.
## @pure yes This function has no side effects.
ob_get_doc_files()
{
	_ob_package_do 'get_doc_files' || return ${?}

	return 0
}

## @brief Set package substitution variables
## @details \fBob_set_package_substvars\fP() sets any substitution variables
##          defined by a source package, as well as any standard substitution
##          variables defined by the source package format, for later use by
##          \fBob_substvars\fP(3).
## @operand pkg req The binary package for which to set substitution variables
##                  (currently ignored).
## @return Returns 0 on success.
## @stderr Prints error messages on parse errors.
## @pure no This function sets internal global variables.
ob_set_package_substvars()
{
	local pkg="${1}"
	shift 1 || _ob_abort

	_ob_package_do 'set_package_substvars' "${pkg}" || return ${?}

	return 0
}

_ob_set_binary_packages()
{
	local packages="${1}"
	shift 1 || _ob_abort

	_ob_binary_packages="${packages}"

	return 0
}

_ob_set_source_parameter()
{
	local name="${1}"
	local value="${2}"
	shift 2 || _ob_abort

	# Convert field name to uppercase and validate.
	case "${name}" in *[!A-Za-z0-9-]* | '')
		return 1
	esac
	name="$(tr 'a-z-' 'A-Z_' <<-EOF
		${name}
		EOF
		)"

	_ob_source_parameters="${_ob_source_parameters} ${name}"

	eval "_OB_SRCFIELD_${name}=\"\${value}\""

	return 0
}

_ob_set_binary_parameter()
{
	local package="${1}"
	local name="${2}"
	local value="${3}"
	shift 3 || _ob_abort

	if ! ob_validate_binary_name "${package}"; then
		return 1
	fi

	# Convert package name to its uppercase "clean" form.
	package="$({ tr 'a-z' 'A-Z' | tr -dC 'A-Z0-9'; } <<-EOF
		"${pkg}"
		EOF
		)"

	# Convert field name to uppercase and validate.
	case "${name}" in *[!A-Za-z0-9-]* | '')
		return 1
	esac
	name="$(tr 'a-z-' 'A-Z_' <<-EOF
		${name}
		EOF
		)"

	case " ${_ob_binary_parameters} " in
		*" ${name} "*)
			;;
		*)
			_ob_binary_parameters="${_ob_binary_parameters} ${name}"
			;;
	esac

	eval "_OB_BINFIELD_${package}_${name}=\"\${value}\""

	return 0
}