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
|
run_simple_action() {
case "$SHURIKEN_CLI_ACTION" in
--version)
if [[ -n "$SHURIKEN_CLI_CONFIG_FILE" \
|| "$SHURIKEN_CLI_HAS_CONFIG_OVERRIDES" = 'yes' \
|| "$SHURIKEN_FORCE_GENERATE" = yes ]]; then
usage
exit 1
fi
printf 'This is Shuriken Version %s\n' "$VERSION"
;;
--init)
if [[ -n "$SHURIKEN_CLI_CONFIG_FILE" \
|| "$SHURIKEN_CLI_HAS_CONFIG_OVERRIDES" = 'yes' \
|| "$SHURIKEN_FORCE_GENERATE" = yes ]]; then
usage
exit 1
fi
init_config
;;
esac
}
# Runs an action function in-process and propagates its exit status.
#
# Shuriken is a single-process CLI, so the action body runs as a plain function
# call in the current shell. An earlier version could serialize 30+ globals plus
# every function definition and pipe them into a fresh "bash -euo pipefail"
# subprocess for isolation. That added real complexity (a hand-maintained list
# of variables to forward) for no benefit here: there is no second process to
# isolate from and nothing the action needs protecting from. Per KISS we dropped
# the subprocess runner and call the action directly. Tests that genuinely need
# subprocess isolation provide their own shim in tests/helpers.sh.
run_configured_action_body() {
local -r action_name="$1"; shift
"$action_name" "$@"
}
load_configured_action() {
local -r rc_file="$1"; shift
local -i status=0
if [ ! -f "$rc_file" ]; then
missing_config "$rc_file"
fi
# shellcheck source=/dev/null
source "$rc_file"
status=$?
if (( status != 0 )); then
return "$status"
fi
apply_config_defaults
status=$?
if (( status != 0 )); then
return "$status"
fi
apply_template_dir_default
status=$?
if (( status != 0 )); then
return "$status"
fi
apply_cli_overrides
status=$?
if (( status != 0 )); then
return "$status"
fi
SHURIKEN_CONFIG_SOURCE="$rc_file"
export SHURIKEN_CONFIG_SOURCE
}
log_configured_action() {
local -r rc_file="$1"; shift
if [ "$SHURIKEN_CLI_ACTION" = --print-config ]; then
return
fi
log_verbose "Selected config file: $rc_file"
log_verbose "Effective incoming directory: ${INCOMING_DIR:-}"
log_verbose "Effective output directory: ${DIST_DIR:-}"
log_verbose "Effective template directory: ${TEMPLATE_DIR:-}"
log_verbose "Effective favicon: ${FAVICON:-(bundled default)}"
log_verbose "Effective image jobs: $IMAGE_JOBS"
log_verbose "Effective ImageMagick timeout: ${IMAGEMAGICK_TIMEOUT}s"
log_verbose "Effective tar timeout: ${TAR_TIMEOUT}s"
log_verbose "Effective splash page setting: $SPLASH_PAGE"
log_verbose "Effective stats page setting: $STATS_PAGE"
log_verbose "Effective tarball setting: $TARBALL_INCLUDE"
log_verbose "Effective sync delete setting: $SYNC_DELETE"
log_verbose "Effective force generation setting: $SHURIKEN_FORCE_GENERATE"
}
# Remove leftover generation staging/backup directories for DIST_DIR (ln0).
#
# The generation pipeline (config.staging.source.sh) stages output in sibling
# directories of DIST_DIR named via mktemp templates
# ".shuriken.<basename>.staging.XXXXXX" and ".shuriken.<basename>.backup.XXXXXX"
# in DIST_DIR's parent. A crash or kill can leave these behind, so --clean
# removes them too -- otherwise "clean" would not actually clean all generation
# output (Principle of Least Astonishment).
#
# Safety: callers MUST run validate_clean_dist_dir first so a dangerous DIST_DIR
# aborts before any deletion. We only match shuriken's own, basename-specific
# staging/backup prefixes (never a loose ".shuriken.*" or arbitrary dotfiles),
# derive the parent exactly as the staging code does (dirname "$DIST_DIR"), and
# use nullglob so a missing match never expands to a literal pattern to rm.
clean_generation_staging_artifacts() {
local final_base final_parent artifact
local -a artifacts=()
final_base=$(basename "$DIST_DIR")
final_parent=$(dirname "$DIST_DIR")
# nullglob: a non-matching glob expands to nothing rather than to the
# literal pattern, so we never accidentally rm a path called "*".
shopt -s nullglob
artifacts=(
"$final_parent/.shuriken.$final_base.staging."*
"$final_parent/.shuriken.$final_base.backup."*
)
shopt -u nullglob
for artifact in "${artifacts[@]}"; do
if [ -d "$artifact" ]; then
log_info "Cleaning leftover staging directory $artifact"
rm -rf "$artifact"
fi
done
}
run_configured_action() {
local rc_file
local -i status=0
if [[ "$SHURIKEN_FORCE_GENERATE" = yes \
&& "$SHURIKEN_CLI_ACTION" != --generate ]]; then
usage
exit 1
fi
rc_file="$(resolve_config_file "$SHURIKEN_CLI_CONFIG_FILE")"
load_configured_action "$rc_file"
status=$?
if (( status != 0 )); then
return "$status"
fi
log_configured_action "$rc_file"
case "$SHURIKEN_CLI_ACTION" in
--clean)
# Validate DIST_DIR before any destructive rm -rf. Unlike the bare
# check that used to live here, validate_clean_dist_dir rejects unset,
# empty, and dangerous paths (/, HOME, cwd, system dirs) so a
# misconfigured DIST_DIR can never nuke the wrong tree.
validate_clean_dist_dir
status=$?
if (( status != 0 )); then
return "$status"
fi
if [ -d "$DIST_DIR" ]; then
log_info "Cleaning $DIST_DIR"
rm -rf "$DIST_DIR"
else
log_verbose "Output directory does not exist: $DIST_DIR"
fi
# Also remove any leftover staging/backup directories that the
# generation pipeline created as siblings of DIST_DIR. This stays
# behind the validate_clean_dist_dir guard above (so a dangerous
# DIST_DIR aborts before any deletion).
clean_generation_staging_artifacts
;;
--generate)
validate_generation_config
status=$?
if (( status != 0 )); then
return "$status"
fi
run_configured_action_body generate_staged
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
--refresh-splash)
validate_refresh_splash_config
status=$?
if (( status != 0 )); then
return "$status"
fi
run_configured_action_body refresh_splash
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
--sync)
validate_sync_config
status=$?
if (( status != 0 )); then
return "$status"
fi
run_configured_action_body sync_dist
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
--dry-run)
validate_generation_config no
status=$?
if (( status != 0 )); then
return "$status"
fi
run_configured_action_body dry_run
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
--print-config)
validate_print_config
status=$?
if (( status != 0 )); then
return "$status"
fi
run_configured_action_body print_config
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
esac
}
run_action() {
local -i status=0
case "$SHURIKEN_CLI_ACTION" in
--version|--init)
run_simple_action
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
--clean|--generate|--refresh-splash|--sync|--dry-run|--print-config)
run_configured_action
status=$?
if (( status != 0 )); then
return "$status"
fi
;;
*)
usage
exit 1
;;
esac
}
|