summaryrefslogtreecommitdiffstats
path: root/lib/metadata.sh
blob: bc7e7171f5dee74019c480d69d20280a54a0b1e7 (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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# Functions for parsing and validating package metadata
#
# Copyright (C) 2012, 2014, 2018-2020 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="${1}"
	shift 1 || _ob_abort

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

	return 0
}

## @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 or 1 if invalid.
## @pure yes This function has no side effects.
ob_validate_source_name()
{
	local name="${1}"
	shift 1 || _ob_abort

	_ob_metadata_do 'validate_source_name' "${name}" || return ${?}

	return 0
}

## @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 or 1 if invalid.
## @pure yes This function has no side effects.
ob_validate_binary_name()
{
	local name="${1}"
	shift 1 || _ob_abort

	_ob_metadata_do 'validate_binary_name' "${name}" || return ${?}

	return 0
}

## @brief Convert a source or binary package name to a "clean" identifier name
## @details \fBob_clean_name\fP() encodes characters in a source or binary
##          package name that would be invalid in a shell variable or function
##          name.  This conversion is performed by the metadata plugin selected
##          at libopkbuild's build time.
## @operand name req The source or binary package name to convert.
## @return Returns 0 on success.
## @stdout Prints the converted name.
## @pure yes This function has no side effects.
ob_clean_name()
{
	local name="${1}"
	shift 1 || _ob_abort

	_ob_metadata_do 'clean_name' "${name}" || return ${?}

	return 0
}

## @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 or 1 on invalid \fIversion\fP.
## @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
					_ob_abort
				fi
				;;
			d)
				distrev_var="${OPTARG}"
				if ! _ob_validate_var_name "${distrev_var}"
				then
					_ob_abort
				fi
				;;
			?)
				_ob_abort
				;;
		esac
	done
	shift $((${OPTIND} - 1))

	version="${1}"
	shift 1 || _ob_abort

	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 or 1 if the system's architecture cannot be
##         determined.
## @stdout Prints the system's architecture.
## @pure yes This function has no side effects.
ob_get_system_arch()
{
	_ob_metadata_do 'get_system_arch' || return ${?}

	return 0
}

## @brief Get the running system's platform
## @details \fBob_get_system_plat\fP() gets the platform of the build (running)
##          system using the metadata plugin selected at libopkbuild's build
##          time.
## @return Returns 0 on success or 1 if the system's platform cannot be
##         determined.
## @stdout Prints the system's platform.
## @pure yes This function has no side effects.
ob_get_system_plat()
{
	_ob_metadata_do 'get_system_plat' || return ${?}

	return 0
}

_ob_match_arch()
{
	local match_arch="${1}"
	local field_arch="${2}"
	shift 2 || _ob_abort
	local match_arch_rest=
	local field_arch_rest=
	local match_arch_part=
	local field_arch_part=

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

	# "foo-bar-baz" == "foo-any-any"
	match_arch_rest="${match_arch}"
	field_arch_rest="${field_arch}"
	while [ -n "${match_arch_rest}" ] && [ -n "${field_arch_rest}" ]; do
		IFS='-' read match_arch_part match_arch_rest <<-EOF
			${match_arch_rest}
			EOF
		IFS='-' read field_arch_part field_arch_rest <<-EOF
			${field_arch_rest}
			EOF
		case "${field_arch_part}" in
			"${match_arch_part}" | 'any') ;;
			*) return 1;;  # Failed match
		esac
	done

	return 0
}

## @brief Match a host architecture against an architecture field
## @details \fBob_arch_is_concerned\fP() checks whether a host architecture
##          matches an architecture field.  The host architecture may be either
##          a specific distribution architecture or "all".  The architecture
##          field may be either a space-separated list of either "any" or
##          specific distribution architectures, any of which can be negated
##          with a prefix of "!", or "all".
## @operand host_arch req The host architecture to match.
## @operand arches    req The architecture field against which to match.
## @return Returns 0 if \fIhost_arch\fP matches \fIarches\fP, or 0 if not.
## @pure yes This function has no side effects.
ob_arch_is_concerned()
{
	local host_arch="${1}"
	local arches="${2}"
	shift 2 || _ob_abort
	local arch=
	local not_arch=
	local seen_arch=

	if [ x"${arches}" = x'' ]; then
		return 0
	elif [ x"${host_arch}" = x'all' ]; then
		if [ x"${arches}" = x'all' ]; then
			return 0
		else
			return 1
		fi
	else
		seen_arch=1
		for arch in ${arches}; do
			not_arch="${arch#!}"
			if [ x"${not_arch}" != x"${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_match_plat()
{
	local match_plat="${1}"
	local field_plat="${2}"
	shift 2 || _ob_abort

	if [ x"${field_plat}" = x'any' ]; then
		return 0
	fi
	if [ x"${field_plat}" = x"${match_plat}" ]; then
		return 0
	fi

	return 1
}

## @brief Match a host platform against a platform field
## @details \fBob_plat_is_concerned\fP() checks whether a host platform matches
##          a platform field.  The host platform may be either a specific
##          distribution platform or "all".  The platform field may be either a
##          space-separated list of either "any" or specific distribution
##          platforms, any of which can be negated with a prefix of "!", or
##          "all".
## @operand host_plat req The host platform to match.
## @operand plats     req The platform field against which to match.
## @return Returns 0 if \fIhost_plat\fP matches \fIplats\fP, or 0 if not.
## @pure yes This function has no side effects.
ob_plat_is_concerned()
{
	local host_plat="${1}"
	local plats="${2}"
	shift 2 || _ob_abort
	local plat=
	local not_plat=
	local seen_plat=

	if [ x"${plats}" = x'' ]; then
		return 0
	elif [ x"${host_plat}" = x'all' ]; then
		if [ x"${plats}" = x'all' ]; then
			return 0
		else
			return 1
		fi
	else
		seen_plat=1
		for plat in ${plats}; do
			not_plat="${plat#!}"
			if [ x"${not_plat}" != x"${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 can be either only \fIplat\fP or all of
##          \fIsource\fP, \fIversion\fP, and \fIplat\fP; the latter form is
##          deprecated.  For \fBbuildflags\fP and \fBplatconf\fP, the system
##          path will be under the value of the \fIOB_TEST_DATADIR\fP
##          environment variable, if set and not null; this is intended for use
##          in testing programs that call this function.
## @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.
## @stdout Prints the requested path with \fIargs\fP.
## @pure yes This function has no side effects.
ob_get_system_path()
{
	local path_id="${1}"
	shift 1 || _ob_abort

	_ob_metadata_do 'get_system_path' "${path_id}" "${@}" || return ${?}

	return 0
}

## @brief Validate a section name
## @details \fBob_validate_section\fP() validates a package archive section name
##          against the list in the metadata plugin selected at libopkbuild's
##          build time.
## @operand section req The section name to validate.
## @return Returns 0 if valid or 1 if invalid.
## @pure yes This function has no side effects.
ob_validate_section()
{
	local section="${1}"
	shift 1 || _ob_abort

	_ob_metadata_do 'validate_section' "${section}" || return ${?}

	return 0
}

## @brief Get a possibly architecture-qualified package name
## @details \fBob_qualify_package_name\fP() qualifies the name of a binary
##          package with the host architecture if the package is in a section
##          whose packages are coinstallable.
## @operand name      req The name of the binary package.
## @operand host_arch req The host architecture.
## @return Returns 0.
## @stdout Prints \fIname\fP, possibly followed by a colon and \fIhost_arch\fP.
## @pure yes This function has no side effects.
ob_qualify_package_name()
{
	local name="${1}"
	local host_arch="${2}"
	shift 2 || _ob_abort
	local sect=

	sect="$(ob_get_binary_parameter "${name}" 'Section')"
	if _ob_metadata_do 'section_is_coinstallable' "${sect}"; then
		printf '%s:%s' "${name}" "${host_arch}"
	else
		printf '%s' "${name}"
	fi

	return 0
}