Muoto auto-apply automation

Headless icon re-apply after app installs and at boot, plus a full stock restore before system upgrade.

Components

Artifact Role
/usr/bin/harbour-muoto-update-icons Read dconf → ApplyIcons (cover-sync); waits on icon-ops.lock via flock
service/muoto-dbus-wait.sh Shared D-Bus helpers, backup probe, flock wait, op-status read, su defaultuser dconf
/usr/share/harbour-muoto/last-op.json Outcome of the last icon operation; how the scripts tell success from a rejected no-op
/usr/bin/harbour-muoto-oneshot-restore Pre-upgrade (no args) or RPM uninstall (--uninstall): fonts, conditional RestoreIcons, dconf, density, vendor locks
harbour-muoto-update-icons.service Boot oneshot (runs as root; dconf via su defaultuser)
harbour-muoto-oneshot-restore.service Before sailfish-upgrade-ui
harbour-muoto-install-listener User D-Bus hooks → exec harbour-muoto-update-icons as defaultuser
org.muoto.Muoto1 helperd D-Bus activation on demand; DensityEnable / UninstallPack (icons use session Launcher1)

OS update guard

While Sailfish OS is upgrading, Muoto must not re-apply icons (that raced with pre-upgrade restore). Detection uses signals SFOS actually exposes:

Signal Used by
/run/defaultuser/osupdate_running muoto_os_update_running, OsUpdateGuard, harbour-muoto-update-icons.service ConditionPathExists
system-update.target active Shell + C++ (when flag absent but upgrade target is up)
sailfish-upgrade-ui.service active Shell + C++

Not gated: harbour-muoto-oneshot-restore still runs RestoreIcons before sailfish-upgrade-ui (stock restore is intentional during update).

During Settings → Sailfish OS update, expect harbour-muoto-oneshot-restore first (dconf → default), listener apply skipped (guard) on app installs, and update-icons: skip (OS update in progress) if the boot script is triggered manually.

ls -l /run/defaultuser/osupdate_running
systemctl is-active system-update.target sailfish-upgrade-ui.service

After reboot the flag should be gone; boot update-icons no-ops until a theme is applied again in the app.

Waits and timeouts

Shell scripts do not wrap restore in an external timeout during RPM uninstall. Limits are layered:

Limit Value What it bounds
Per icon op (flock) 180s Boot update-icons and pre-upgrade oneshot-restore (ApplyIcons / RestoreIcons)
Per icon op (flock) 60s harbour-muoto-oneshot-restore --uninstall only
Lock “did not start” ~15s Poll until session launcher-icond holds icon-ops.lock; else fail fast (busy / rejected)
Helperd bus name 15s Root: systemctl start harbour-muoto-helperd. defaultuser: optional StartService (if supported), Introspect to activate, then poll; if still down, icon-op dbus-send activates (no PIN, no hard fail)
Icon op retry gap 3s Sleep between one retry on failed restore or apply
systemd unit 600s TimeoutStartSec on harbour-muoto-update-icons.service and harbour-muoto-oneshot-restore.service (whole oneshot run)

Flock semantics: scripts wait until /usr/share/harbour-muoto/icon-ops.lock is free again. The launcher daemon holds that lock from its job queue going non-empty to it going empty — the whole drain, not one job (see IconJobQueue in C++). A per-job lock would let a script observe someone else’s operation and return before its own request ran.

The lock only says an operation ran. It never says whether it did anything, which is why a rejected apply used to be logged as a success. The outcome comes from /usr/share/harbour-muoto/last-op.json instead: muoto_op_status_sequence before the call and again after, plus muoto_op_status_outcome (ok / partial / failed), so the caller can tell its own result from a stale one. Reading OperationCompleted from a script would mean dbus-monitor, which is too fragile to gate the repair on; the GUI still uses the signal.

RPM uninstall: %preun runs harbour-muoto-oneshot-restore --uninstall with no timeout and no || true. If restore fails when backup/icons has PNGs, the script exits non-zero and the package stays installed.

Device test checklist

  1. Apply a theme in Muoto (activeIconPack ≠ default).
  2. Install a native app (pkcon install …) or APK — icons should re-theme within ~2 s.
  3. Restart AppSupport — containerReady: true should trigger apply.
  4. Reboot — boot oneshot re-applies if theme still active.
  5. System update: confirm /run/defaultuser/osupdate_running and/or upgrade units active; harbour-muoto-oneshot-restore runs (dconf default); auto-apply and update-icons are skipped; session ApplyIcons returns “upgrade in progress”.
  6. After upgrade, boot apply no-ops until theme applied again in the app.
  7. Remove Muoto (RPM): %preun stops harbour-muoto-update-icons and disables harbour-muoto-install-listener, then runs harbour-muoto-oneshot-restore --uninstall. Close the Muoto app before uninstall if a theme apply is in progress.

Broader smoke and script inventory: Testing.

Automated scripts

Script What
scripts/device-test-3.2.sh Smoke: units, cap, manifest, update-icons; --destructive restore
scripts/device-test-preupgrade-install.sh T-20 pre-upgrade + T-21 install/upgrade re-theme + T-22 silica folder ambient + T-23 dynamic icons
scripts/pipeline-review-full.sh p10 / p11 / p12 / p13 T-20 / T-21 / T-22 / T-23
# On device (defaultuser). Copy the script from the repo if not present.
bash device-test-preupgrade-install.sh --pack haiku
# Or separately:
bash device-test-preupgrade-install.sh --pack haiku --skip-install --skip-folder --skip-dyn   # T-20 only
bash device-test-preupgrade-install.sh --pack haiku --skip-preupgrade --skip-folder --skip-dyn # T-21 only
bash device-test-preupgrade-install.sh --pack haiku --skip-preupgrade --skip-install --skip-dyn # T-22 only
bash device-test-preupgrade-install.sh --pack haiku --skip-preupgrade --skip-install --skip-folder # T-23 only

T-20 pre-upgrade (harbour-muoto-oneshot-restore)

Check Expect
Unit wiring Before=sailfish-upgrade-ui.service, WantedBy=system-update.target, drop-in wants the oneshot
After apply + systemctl start harbour-muoto-oneshot-restore activeIconPack=default, iconOverlay=false, dyn clock/calendar flags false, manifest gone, generated PNGs cleared, Jolla Icon= back to stock names (e.g. fingerterm → icon-launcher-shell)

T-21 install/upgrade re-theme (harbour-muoto-install-listener)

Check Expect
Listener active harbour-muoto-install-listener running
pkcon install / Storeman / pkcon install-local Listener roleRelevant= true for roles 11 / 22 / 10; update-icons logs ApplyIcons (not a missing harbour-themepack-harbour-themepack-… path); icond refreshNewDesktops
After ~debounce+apply Pack still active, probe app themed (manifest and/or generated Icon=), other launchers still themed
With /run/defaultuser/osupdate_running Apply skipped (guard)

T-22 silica folder ambient

Check Expect
Apply pack with overlay Backup under backup/folder-icons/<z>/icon-launcher-folder-01.png; live silica PNG checksum changes when pack/overlay has assets
RestoreIcons Live checksum restored; backup/folder-icons removed

Folder-icon RPM heal (3.5.2+)

Check Expect
Upgrade Muoto while folders themed / backups wiped %post starts harbour-muoto-repair-folder-icons.service; script saves pack, RestoreIcons, pkcon download + rpm force-install of owning graphics packages, reapplies pack, then disables/removes the unit
Offline / download or rpm fail Unit stays enabled for boot retry; repair-folder-icons.state keeps the saved pack across retries

T-23 dynamic icons (enable/disable contract)

Check Expect
Pack has dynclock/ and/or dyncal/ Otherwise T-23 soft-skips (no fail)
dconf enable for present features (Icons / Dynamic icons Apply) Flags match; clock/calendar Icon= under launcher-icons/ when that feature is enabled
Both dyn flags false Flags false; clock/calendar Icon= not muoto dyn redirects
RestoreIcons + dyn flags off activeIconPack=default, both dyn dconf keys false (UI usable for stock; live icons not applied until toggled)

Override probe with MUOTO_PROBE_PKG / MUOTO_PROBE_DESKTOP. Sudo password: MUOTO_SUDO_PASS.

Uninstall behaviour

backup/icons RestoreIcons RPM if restore fails
Has PNGs Yes (session Launcher1) Aborts — Muoto remains installed
Empty / missing Skipped Removes if fonts/dconf succeed

If Storeman or pkcon reports “system management is locked” on an older build, restart the phone, then update Muoto or retry uninstall.

# Manual apply as root (same as boot unit; theme must be active in dconf)
/usr/bin/harbour-muoto-update-icons

# Manual pre-upgrade restore as root (e.g. devel-su shell on device — not sudo, which is
# not installed by default). Needs defaultuser session: /run/user/<uid>/dbus/user_bus_socket
/usr/bin/harbour-muoto-oneshot-restore

# Same restore path as RPM uninstall (from devel-su)
/usr/bin/harbour-muoto-oneshot-restore --uninstall

# Listener status + live journal (script stderr forwarded as muoto: lines)
MUOTO_UID=$(id -u defaultuser)
export XDG_RUNTIME_DIR=/run/user/$MUOTO_UID
systemctl --user status harbour-muoto-install-listener
journalctl --user -f 2>/dev/null | grep -E 'muoto-listener|muoto:' \
  || journalctl -f | grep -E 'muoto-listener|muoto:'

If the listener is not active after RPM install from SSH, enable manually:

systemctl --user enable --now harbour-muoto-install-listener.service

This site uses Just the Docs, a documentation theme for Jekyll.