summaryrefslogtreecommitdiffstats
path: root/src/control.sh
blob: 68ef257db4b62e2c554ed204683b40c6820c4e90 (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
# pro-archman
# src/control.sh
# Functions for parsing control files.
#
# Copyright (C) 2012, 2018, 2019  Patrick McDermott
#
# This file is part of the ProteanOS Archive Manager.
#
# The ProteanOS Archive Manager 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.
#
# The ProteanOS Archive Manager 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 the ProteanOS Archive Manager.  If not, see
# <http://www.gnu.org/licenses/>.

_parse_control_error()
{
	file="${1}"
	line_nr="${2}"
	msg_id="${3}"
	shift 3
	local file_info=

	if [ ${line_nr} -eq 0 ]; then
		file_info="$(printf '%s' "${file}")"
	else
		file_info="$(printf '%s:%d' "${file}" "${line_nr}")"
	fi

	warn "${file_info}: $(get_msg "${msg_id}")" "${@}"

	return 0
}

parse_control()
{
	local file="${1}"
	local field_cb="${2}"
	local req_fields="${3}"
	local opt_fields="${4}"
	shift 4
	local got_fields=
	local line_nr=
	local line=
	local name=
	local value=
	local sep=

	req_fields=" $(printf '%s ' ${req_fields})"
	opt_fields=" $(printf '%s ' ${opt_fields})"
	got_fields=' '

	line_nr=0

	while IFS='' read -r line; do
		line_nr=$((${line_nr} + 1))
		case "${line}" in
			'')
				_parse_control_error "${file}" "${line_nr}" \
					'control_empty_line'
				;;
			'#'*)  # Comment.
				;;
			[!\ ]*':'*)  # "Name: Value" line.
				if [ -n "${name}" ]; then
					if ! "${field_cb}" "${name}" "${value}"
					then
						return 0
					fi
				fi
				IFS=': 	' read name value <<-EOF
					${line}
					EOF
				if [ -z "${name}" ]; then
					# Badly formatted control field.
					_parse_control_error "${file}" \
						"${line_nr}" 'control_bad_nv'
					continue
				fi
				case "${got_fields}" in *" ${name} "*)
					# Duplicate field.
					_parse_control_error \
						"${file}" "${line_nr}" \
						'control_duplicate_field' \
						"${name}"
					continue
				esac
				got_fields="${got_fields}${name} "
				case "${req_fields}" in *" ${name} "*)
					# Required field: remove from list.
					req_fields="${req_fields% ${name} *}$(:\
						) ${req_fields#* ${name} }"
					continue
				esac
				case "${opt_fields}" in *" ${name} "*)
					# Optional field.
					continue
				esac
				# Unknown field.
				_parse_control_error \
					"${file}" "${line_nr}" \
					'control_unknown_field' "${name}"
				;;
			' '*)  # Continuation line.
				if [ -z "${name}" ]; then
					# Expecting a "Name: Value" line.
					_parse_control_error "${file}" \
						"${line_nr}" \
						'control_found_continuation'
					continue
				fi
				value="${value}${LF}${line# }"
				;;
		esac
	done <<-EOF
		$(cat -- "${file}")
		EOF

	if [ -n "${name}" ]; then
		if ! "${field_cb}" "${name}" "${value}"; then
			return 0
		fi
	fi

	case "${req_fields}" in *[!\ ]*)
		# Missing required control fields.
		sep="$(get_msg 'list_item_separator')"
		req_fields="$(printf "%s${sep}" ${req_fields}; printf 'x')"
		req_fields="${req_fields%${sep}x}"
		_parse_control_error "${file}" '0' 'control_missing_fields' \
			"${req_fields}"
		return 1
	esac

	return 0
}