summaryrefslogtreecommitdiffstats
path: root/lib/control.sh
blob: 6907b3d0f18f71449158559caea7b89571ce109b (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
# pro-archman
# lib/control.sh
# Functions for parsing control files.
#
# Copyright (C) 2012, 2013  Patrick "P. J." McDermott
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

[ "x${_CONTROL_SM+set}" = 'xset' ] && return 0
_CONTROL_SM=1

use output
use locale

control_file=
control_line_nr=

parse_control()
{
	local field_cb="${2}"
	local req_fields="${3}"
	local opt_fields="${4}"
	local all_fields=
	local got_fields=
	local line=
	local name=
	local value=

	control_file="${1}"
	control_line_nr=0

	req_fields="$(printf '%s\n' ${req_fields})"
	opt_fields="$(printf '%s\n' ${opt_fields})"
	all_fields="${LF}${req_fields}${LF}${opt_fields}${LF}"
	got_fields="${LF}"

	while IFS='' read -r line; do
		control_line_nr=$(($control_line_nr + 1))
		if [ "x$(echo ${line})" = 'x' ]; then
			parse_control_error 'control_empty_line'
		elif [ "x${line#\#}" != "x${line}" ]; then
			# Comment.
			:
		elif [ "x${line# }" = "x${line}" ]; then
			# "Name: Value" line.
			if [ "x${name}" != 'x' ]; then
				if ! "${field_cb}" "${name}" "${value}"; then
					return 0
				fi
			fi
			name="${line%%:*}"
			value="${line#*:}"
			value="${value# }"
			if [ "x${name}" = 'x' -o "x${name}" = "x${line}" ]; then
				parse_control_error 'control_bad_nv'
				continue
			fi
			if [ "x${req_fields}" != 'x' ]; then
				if [ "x${all_fields%${LF}${name}${LF}*}" = \
						"x${all_fields}" ]; then
					# Unknown field.
					parse_control_error \
						'control_unknown_field' \
						"${name}"
				else
					# Remove field from list of required
					# fields.
					req_fields="$(printf '%s' \
						"${req_fields}" | \
						grep -Fv "${name}")"
				fi
			fi
			if [ "x${got_fields%${LF}${name}${LF}*}" != \
					"x${got_fields}" ]; then
				# Duplicate field.
				parse_control_error 'control_duplicate_field' \
					"${name}"
			else
				got_fields="${got_fields}${name}${LF}"
			fi
		else
			# Continuation line.
			if [ "x${name}" = 'x' ]; then
				# Expecting a "Name: Value" line.
				parse_control_error 'control_found_continuation'
				continue
			fi
			value="${value}${LF}${line# }"
		fi
	done <<-EOF
		$(cat "${control_file}")
		EOF

	if [ "x${name}" != 'x' ]; then
		if ! "${field_cb}" "${name}" "${value}"; then
			return 0
		fi
	fi

	if [ "x${req_fields}" != 'x' ]; then
		req_fields="$(printf "%s$(get_msg 'list_item_separator')" \
			${req_fields})"
		parse_control_error 'control_missing_fields' "${req_fields}"
	fi

	return 0
}

parse_control_error()
{
	local msgid="${1}"
	local file_info=
	shift 1

	if [ ${control_line_nr} -eq 0 ]; then
		file_info="$(printf '%20s:' "${control_file}")"
	else
		file_info="$(printf '%20s(l%d):' "${control_file}" \
			"${control_line_nr}")"
	fi

	warn "${file_info} $(get_msg "${msgid}")" "${@}"

	return 0
}