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
|
#!/usr/bin/env bash
# SPDX-FileCopyrightText: 2023 Patrick Spek <p.spek@tyil.nl>
#
# SPDX-License-Identifier: AGPL-3.0-or-later
# shellcheck source=lib/util/config.bash
. "$BASHTARD_LIBDIR/util/config.bash"
# shellcheck source=lib/util/pkg.bash
. "$BASHTARD_LIBDIR/util/pkg.bash"
# shellcheck source=lib/util/svc.bash
. "$BASHTARD_LIBDIR/util/svc.bash"
# shellcheck source=lib/vendor/bpt.bash
. "$BASHTARD_LIBDIR/vendor/bpt.bash"
# Change the working directory. In usage, this is the same as using cd,
# however, it will make additional checks to ensure everything is going fine.
chgdir() {
debug "bashtard/chgdir" "Changing workdir to $1"
cd -- "$1" || die "Failed to change directory to $1"
}
# Create a datetime stamp. This is a wrapper around the date utility, ensuring
# that the date being formatted is always in UTC and respect SOURCE_DATE_EPOCH,
# if it is set.
datetime() {
local date_opts
date_opts+=("-u")
# Apply SOURCE_DATE_EPOCH as the date to base off of.
if [[ $SOURCE_DATE_EPOCH ]]
then
date_opts+=("-d@$SOURCE_DATE_EPOCH")
fi
date "${date_opts[@]}" +"${1:-%FT%TZ}"
}
# Log a message as error, and exit the program. This is intended for serious
# issues that prevent the script from running correctly. The exit code can be
# specified with -i, or will default to 1.
die() {
local OPTIND
local code
while getopts ":i:" opt
do
case "$opt" in
i) code=$OPTARG ;;
*) alert "bashtard/die" "Unused argument specified: $opt" ;;
esac
done
shift $(( OPTIND -1 ))
alert "$@"
exit "${code:-1}"
}
# Recursively hash files in a directory, and hashing the output of all those
# hashes again. This results in a single hash representing the state of files
# in a directory. It can be used to check whether contents changed after
# templating files in a given directory.
dir_hash() {
local path
path="$1" ; shift
for entry in "$path"/*
do
if [[ -d "$entry" ]]
then
dir_hash "$entry"
fi
file_hash "$entry"
done | file_hash -
}
# Fetch a file from an URL. Using this function introduces a dependency on curl.
fetch_http() {
local OPTIND
local buffer
while getopts ":o:" opt
do
case "$opt" in
o) buffer=$OPTARG ;;
*) alert "bashtard/fetch_http" "Unused argument specified: $opt" ;;
esac
done
shift $(( OPTIND -1 ))
[[ -z $buffer ]] && buffer="$(tmpfile)"
notice "bashtard/fetch_http" "Downloading $1 to $buffer"
for util in curl wget
do
command -v "$util" > /dev/null || continue
"fetch_http_$util" "$1" "$buffer" || continue
local exit_code=$?
printf "%s" "$buffer"
return $exit_code
done
die "bashtard/fetch_http" "Unable to download file over HTTP!"
}
fetch_http_curl() {
curl -Ls "$1" > "$2"
}
fetch_http_wget() {
wget --quiet --output-document "$2" "$1"
}
# Hash a given file. This is a convenience function to work around different
# systems calling their file hashing programs differently, and generating
# different output. This function only expects 1 file as argument, and only
# outputs the hash of this particular file.
file_hash() {
file_hash_md5 "$@"
}
file_hash_md5() {
local file
file="$1" ; shift
case "${BASHTARD_PLATFORM[key]}" in
freebsd) md5 "$file" | awk '{ print $NF }' ;;
linux-*) md5sum "$file" | awk '{ print $1 }' ;;
esac
}
# A very simple means of templating a file, using sed and awk. The template
# file is assumed to exist within the share directory of the current playbook.
# Variables are passed as key=value pairs to this function. Inside the
# template, they are expected to be written as ${key}.
file_template()
{
local file
local system
file="$1" ; shift
ext="${file##*.}"
path="$(playbook_path "base")/share/$file"
system="bashtard/file_template"
if [[ -z "$ext" || "$ext" == "$file" ]]
then
debug "$system" "Missing extension for template $file, assuming satpl"
ext="satpl"
fi
if [[ ! -f "$path" ]]
then
crit "$system" "No template found at $path"
return 1
fi
if [[ "$(type -t "file_template_$ext")" != "function" ]]
then
crit "$system" "Invalid extension for template $file ($ext)"
return 1
fi
"file_template_$ext" "$path" "$@"
}
file_template_satpl()
{
local file
local sedfile
file="$1" ; shift
sedfile="$(tmpfile)"
for kv in "$@"
do
debug "bashtard/template" "Adding $kv to sedfile at $sedfile"
key="$(awk -F= '{ print $1 }' <<< "$kv")"
if [[ -z "$key" ]]
then
crit "bashtard/template" "Empty key in '$kv' while rendering $file?"
fi
value="$(awk -F= '{ print $NF }' <<< "$kv")"
if [[ -z "$value" ]]
then
crit "bashtard/template" "Empty key in '$kv' while rendering $file?"
fi
# shellcheck disable=SC2016
printf 's@${%s}@%s@g\n' "$key" "$value" >> "$sedfile"
done
sed -f "$sedfile" "$file"
}
file_template_bpt()
{
local file
file="$1" ; shift
eval "$@ bpt.main ge \"$file\""
printf "\n"
}
# Check if the first argument given appears in the list of all following
# arguments.
in_args() {
local needle="$1"
shift
for arg in "$@"
do
[[ $needle == "$arg" ]] && return 0
done
return 1
}
# Join a list of arguments into a single string. By default, this will join
# using a ",", but you can set a different character using -c. Note that this
# only joins with a single character, not a string of characters.
join_args() {
local OPTIND
local IFS=","
while getopts ":c:" opt
do
case "$opt" in
c) IFS="$OPTARG" ;;
*) warn "bashtard/join_args" "Unused opt specified: $opt" ;;
esac
done
shift $(( OPTIND - 1))
printf "%s" "$*"
}
# Convenience function to easily get paths used by the playbook, or to use in
# your playbook.
playbook_path() {
if [[ -z "$BASHTARD_PLAYBOOK" ]]
then
crit "bashtard/playbook_path" "Called outside of a playbook"
return 1
fi
case "$1" in
base) printf "%s/playbooks.d/%s" "$BASHTARD_ETCDIR" "$BASHTARD_PLAYBOOK" ;;
data) printf "%s/data.d/%s" "$BASHTARD_ETCDIR" "$BASHTARD_PLAYBOOK" ;;
*)
crit "bashtard/playbook_path" "Invalid path '$1'"
return 1
esac
}
# Create a temporary directory. Similar to tempfile, but you'll get a directory
# instead.
tmpdir() {
local dir
dir="$(mktemp -d)"
# Ensure the file was created succesfully
if [[ ! -d "$dir" ]]
then
die "bashtard/tmpdir" "Failed to create a temporary directory at $dir"
fi
debug "bashtard/tmpdir" "Temporary file created at $dir"
printf "%s" "$dir"
}
# Create a temporary file. In usage, this is no different from mktemp itself,
# however, it will apply additional checks to ensure everything is going
# correctly, and the files will be cleaned up automatically at the end.
tmpfile() {
local file
file="$(mktemp)"
# Ensure the file was created succesfully
if [[ ! -f "$file" ]]
then
die "bashtard/tmpfile" "Failed to create a temporary file at $file"
fi
debug "bashtard/tmpfile" "Temporary file created at $file"
printf "%s" "$file"
}
|