Files
omarchy-pkgs/pkgbuilds/omawake-bin/package-remove
T
fbfbda4eca Package Omawake 0.0.3 and Omaspeak 0.0.3 with service-removal cleanup hooks (#503)
* Package Omawake 0.0.3 and Omaspeak 0.0.2

Bump both -bin packages to the model-support roadmap delivery:

Omawake 0.0.3:
- W02-W05 setup/activation/cache gates audited and closed
- W07 pinned catalog URL health checks and import diagnostics
- W08 Moonshine Small/Medium benchmarked; both deferred (Tiny default)
- W09 Spanish wake profile (multilingual Whisper Base INT8, es)
- W10 connection-owned playback pauses (HoldPause)

Omaspeak 0.0.2:
- S09 Kokoro 82M: Kokoro-capable packaged provider (supertonic;kokoro_tts)
  with espeak-ng-data.bin shipped beside the executable, 54 named voices
- S10 catalog URL checks, Spanish speech profile, consistent status shape
- S07 streaming deferred at the current pin

Upstream: omawake v0.0.3, omaspeak v0.0.2 (aarch64 + x86_64 verified on
promaxgb10-d666 CUDA and local NPU installs).

* omaspeak-bin: install espeak-ng-data.bin beside the packaged library

* omaspeak-bin: bump to 0.0.3-rc.1 (catalog-managed eSpeak data)

- The tarball no longer ships espeak-ng-data.bin: the Kokoro catalog row
  pins the data package as a model asset (downloaded/verified/installed
  into the model directory with the GGUF), so the core package ships no
  model data at all.
- Both arch checksums taken from the v0.0.3-rc.1 SHA256SUMS.txt.

* omaspeak-bin: finalize at 0.0.3

* Stop setup-created Oma services before pacman removes their binaries

* Drop stale release-verification fixtures from the branch

These were swept in by git add -A during the version bumps: packaged
copies of old releases (0.0.1 tarballs and extracted trees, ~80 MB)
belong to the local verification workflow, not to the package repo.
The consolidated upstream PR should carry only the package changes,
hooks and the removal regression suite.

* Update removal-test fixture versions to the packaged finals

* Ask systemd to reset only an Oma unit that actually failed

The removal helper reset the failed state of every unit it stopped, but
systemd accepts ResetFailed for a unit that is in the failed state alone.
For any other state it answers that the unit is not loaded and exits
non-zero, and because the helper runs under errexit while the hook aborts
on failure, a healthy unit then aborted the whole transaction:

  (2/2) Stop and remove omaspeak user services before package removal
  Failed to reset failed state of unit omaspeak.service: Unit omaspeak.service not loaded.
  :: Could not clean up omaspeak for jacob; removal aborted.

That is the ordinary case, as the packaged service ships disabled and an
enabled one is commonly stopped rather than failed. Read the active state
after the stop and ask for the reset only where it applies, so a failed
unit still loses its failed state along with its rate and restart counters
while a clean unit no longer fails the removal. A reset that a reachable
manager still refuses stays fatal.

Model the rule in the removal suite, where reset-failed now follows the
active state the way a real manager does, and cover both outcomes: an
inactive unit must not be asked for, a failed one must be reset between
the stop and the disable, and a refused reset must still fail the hook.

* Keep removal cleanup faithful to how systemd reads configuration

Both defects from the review of e025111 sat in the shared package-remove
helper, so both packages were affected the same way.

An offline user's drop-in was recognised by grep '^ExecStart=', while the
configuration parser throws away the whitespace around an assignment
(parse_line() strips the line and both halves of the assignment).  A drop-in
naming a development build as

  ExecStart =
  ExecStart = /home/alice/build/omawake daemon

therefore went unmatched, and the helper cleared away the generated base unit
beside with its enablement links, right behind a service that was never meant
to be the package's.  Match an assignment the way the parser accepts one.  The
gate that decides whether a unit file is the generated one stays strict on
purpose: only the exact generated shape is ever deleted.

systemctl show-environment also prints every value the way a shell would read
it, through shell_maybe_quote(SHELL_ESCAPE_POSIX), so an XDG_CONFIG_HOME with a
space arrives as $'/home/alice/custom config'.  The XDG_CONFIG_HOME=/* case saw
neither form and kept the home's .config directory quietly, leaving the unit in
the directory the manager really reads pointing at the removed binary.  Decode
that quoting character by character, without letting the text become shell
syntax, and refuse a value that is neither a plain path nor a closed $'...'
quote rather than delete what would have to be guessed at.  A value that is not
an absolute path stays the fallback it is in systemd itself.

The fixtures now hand the helper the very text a manager prints, quoted by a
mirror of that printer, and cover a quoted path with a space, an apostrophe and
a backslash, an unreadable quoted value, a relative one, and each spacing of an
offline override.  Verified with the removal suite, 15 tests; the eight new
assertions fail against the helper as it was.  The other suites were not run
here, as they reach for the network.

pkgrel 3 -> 4 and the helper's checksum, in both recipes.
Reported-by: spencerbull

* Decode systemd control escapes during service removal

systemctl C-escapes control bytes in show-environment output. Rejecting those valid values aborted package removal for every user, even when the affected account had no Oma service. Decode the printer’s named and octal escapes without evaluating shell syntax or stripping trailing newlines, and cover the real printer format in the fixtures.

Co-Authored-By: GPT-6 XHigh <noreply@openai.com>

---------

Co-authored-by: Spencer Bull <spencer@omarchy.org>
Co-authored-by: GPT-6 XHigh <noreply@openai.com>
2026-09-18 20:32:11 -05:00

151 lines
5.7 KiB
Bash

#!/bin/bash
# Invoked only by the package's Remove/PreTransaction ALPM hook.
set -eu
# systemd's configuration parser throws the whitespace around an assignment away
# (parse_line() runs both halves through strstrip()), so a drop-in written as
# ExecStart = /home/alice/build/omawake daemon
# picks the executable just as surely as the unspaced form does.
readonly execstart_assignment='^[[:space:]]*ExecStart[[:space:]]*='
owned_unit() {
local commands
[[ -f $1 && ! -L $1 ]] || return 1
# Only a unit in the very shape the application generates is ever deleted;
# anything else, however it is spaced, stays somebody's own file.
commands=$(grep '^ExecStart=' "$1") || return 1
[[ $commands != *$'\n'* ]] || return 1
grep -Eq "^ExecStart=\"?/usr/bin/$2\"?([[:space:]]|$)" <<< "$commands"
}
# Decode systemd's shell_maybe_quote() output, including cescape_char() escapes.
# Never evaluate manager-controlled values as shell syntax.
unquote_manager_value() {
local text=$1 decoded= character octal
if [[ $text != '$'* ]]; then
unquoted_value=$text
return 0
fi
[[ $text == \$\'*\' ]] || return 1
text=${text:2:${#text}-3}
while [[ -n $text ]]; do
if [[ ${text:0:1} != \\ ]]; then
decoded+=${text:0:1}
text=${text:1}
continue
fi
case ${text:1:1} in
\\ | "'") decoded+=${text:1:1} ;;
a | b | f | n | r | t | v)
printf -v character '%b' "\\${text:1:1}"
decoded+=$character
;;
[0-3])
octal=${text:1:3}
[[ $octal =~ ^[0-3][0-7]{2}$ && $octal != 000 ]] || return 1
printf -v character '%b' "\\0$octal"
decoded+=$character
text=${text:4}
continue
;;
*) return 1 ;;
esac
text=${text:2}
done
unquoted_value=$decoded
}
remove_for_user() {
local app=$1 user_home=$2 runtime=$3 config="$2/.config" unit="$1.service"
local online=false effective path target manager_environment load_state
if [[ -S $runtime/bus || -S $runtime/systemd/private ]]; then
online=true
# Do not evaluate shell syntax from a user manager's environment.
manager_environment=$(systemctl --user show-environment) || return 1
while IFS= read -r line; do
case $line in
XDG_CONFIG_HOME=*)
if ! unquote_manager_value "${line#XDG_CONFIG_HOME=}"; then
echo ":: Cannot tell which directory $user_home's manager reads $unit from; removal aborted." >&2
return 1
fi
# An XDG_CONFIG_HOME that is not an absolute path is no setting at all:
# the manager itself falls back to the home's .config directory then.
if [[ $unquoted_value == /* ]]; then config=$unquoted_value; fi
;;
esac
done <<< "$manager_environment"
effective=$(systemctl --user show "$unit" --property=ExecStart --value) || return 1
if [[ -n $effective && $effective != *"path=/usr/bin/$app ;"* ]]; then
echo ":: Preserving $unit for $user_home: it uses another executable."
return 0
fi
fi
path="$config/systemd/user/$unit"
if ! $online && grep -qs "$execstart_assignment" "$path.d/"*.conf; then
echo ":: Preserving offline service with an executable override: $path."
return 0
fi
if [[ -e $path || -L $path ]]; then
if ! owned_unit "$path" "$app"; then
echo ":: Preserving custom or masked unit $path."
return 0
fi
fi
if $online; then
# Stop first, and fail the package transaction if stopping fails.
load_state=$(systemctl --user show "$unit" --property=LoadState --value) || return 1
if [[ $load_state != not-found ]]; then
systemctl --user stop "$unit" || return 1
# A unit that had failed stays failed once it is stopped, which is the one
# state systemd will reset. For every other state it answers that the unit
# is not loaded and exits non-zero, so the reset is asked for only where it
# applies: a healthy unit leaving the transaction never aborts a removal.
if [[ $(systemctl --user show "$unit" --property=ActiveState --value) == failed ]]; then
systemctl --user reset-failed "$unit" || return 1
fi
# Disabling also removes enablement links outside the normal target.
systemctl --user disable "$unit" || return 1
fi
fi
# Offline users have no bus. Remove only exact enablement links for this unit.
# All filesystem operations run as the owning user, never as pacman's root.
for target in "$config/systemd/user/"*.wants/"$unit" "$config/systemd/user/"*.requires/"$unit"; do
[[ -L $target ]] || continue
case $(realpath -m -- "$target") in
"$path"|"/usr/lib/systemd/user/$unit") rm -- "$target" ;;
esac
done
if owned_unit "$path" "$app"; then rm -- "$path"; fi
if $online; then systemctl --user daemon-reload || return 1; fi
}
if [[ ${1-} == --user ]]; then
shift
case ${1-} in omawake|omaspeak) ;; *) exit 2 ;; esac
[[ $# == 3 ]] || exit 2
remove_for_user "$@"
exit
fi
[[ $# == 1 ]] || exit 2
case $1 in omawake|omaspeak) ;; *) exit 2 ;; esac
app=$1
result=0
# Include logged-out users as well as active/lingering user managers.
accounts=$(getent passwd) || exit 1
while IFS=: read -r account _ user_id _ _ user_home _; do
[[ $user_home == /* ]] || continue
runtime="/run/user/$user_id"
if [[ ! -d $user_home/.config/systemd/user && ! -S $runtime/bus && ! -S $runtime/systemd/private ]]; then
continue
fi
if ! runuser -u "$account" -- env -u XDG_CONFIG_HOME \
XDG_RUNTIME_DIR="$runtime" DBUS_SESSION_BUS_ADDRESS="unix:path=$runtime/bus" \
"$0" --user "$app" "$user_home" "$runtime"; then
echo ":: Could not clean up $app for $account; removal aborted. Stop/remove the user service and retry." >&2
result=1
fi
done <<< "$accounts"
exit "$result"