justfile

# Machines build and install tasks.
#
# `build` needs cargo, blueprint-compiler and the libvirt, gvnc, spice-glib, libusb and
# VTE headers; `install` only copies what is already in target/release, so the two can run
# on different machines sharing this directory.
#
#   just build
#   sudo just install              (prefix /usr/local)
#   just prefix=$HOME/.local install

set shell := ["bash", "-euo", "pipefail", "-c"]

app_id := "io.github.sachesi.machines"
prefix := env("PREFIX", "/usr/local")
destdir := env("DESTDIR", "")
bindir := destdir + prefix + "/bin"
libexecdir := prefix + "/libexec"
# polkit reads actions from here alone, whatever the prefix.
polkitdir := destdir + "/usr/share/polkit-1/actions"
datadir := destdir + prefix + "/share"
release := "target/release"
schema_dir := "target/schemas"
pot_dir := "target/pot"
check_dir := "target/check"
version := `sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -n1`

default:
    @just --list

# Release build.
build:
    cargo build --release

# Debug build.
build-debug:
    cargo build

# Compile the GSettings schema into target/schemas for running uninstalled.
schemas:
    mkdir -p {{schema_dir}}
    cp data/{{app_id}}.gschema.xml {{schema_dir}}/
    glib-compile-schemas {{schema_dir}}

# Run the debug build uninstalled.
run *args: build-debug schemas
    GSETTINGS_SCHEMA_DIR={{schema_dir}} target/debug/machines {{args}}

# Lints: rustfmt, clippy, dependency advisories and licences, blueprint, desktop file and
# metainfo validation.
check:
    cargo fmt --check
    cargo clippy --all-targets -- -D warnings
    cargo deny check
    mkdir -p {{check_dir}}
    blueprint-compiler batch-compile {{check_dir}} data/ui data/ui/*.blp >/dev/null
    desktop-file-validate data/{{app_id}}.desktop
    appstreamcli validate --no-net data/{{app_id}}.metainfo.xml
    for lang in $(cat po/LINGUAS); do msgfmt -c -o /dev/null po/$lang.po; done

# Unit tests.
test:
    cargo test

# Regenerate po/machines.pot from the Rust sources, the Blueprint files, the desktop entry,
# the metainfo, the schema and the polkit policy.
pot:
    mkdir -p {{pot_dir}}/ui
    blueprint-compiler batch-compile {{pot_dir}}/ui data/ui data/ui/*.blp >/dev/null
    # xgettext has no Rust mode; the C lexer copes once lifetimes ('a, 'static) are stripped.
    rm -rf {{pot_dir}}/src && cp -r src {{pot_dir}}/src
    find {{pot_dir}}/src -name '*.rs' -exec sed -i -E "s/'([A-Za-z_][A-Za-z0-9_]*)([^'A-Za-z0-9_]|$)/\1\2/g" {} +
    xgettext --from-code=UTF-8 --package-name=machines --package-version={{version}} \
        --msgid-bugs-address=https://github.com/sachesi/machines/issues \
        --language=C --keyword= --keyword=gettext --keyword=ngettext:1,2 \
        --flag=gettext:1:no-c-format --flag=ngettext:1:no-c-format --flag=ngettext:2:no-c-format \
        --add-comments=Translators --sort-by-file --directory={{pot_dir}} -o po/machines.pot $(cd {{pot_dir}} && find src -name '*.rs' | sort)
    xgettext -j --from-code=UTF-8 --package-name=machines --package-version={{version}} --msgid-bugs-address=https://github.com/sachesi/machines/issues --add-comments=Translators --sort-by-file --directory={{pot_dir}} -o po/machines.pot $(cd {{pot_dir}} && ls ui/*.ui)
    xgettext -j --from-code=UTF-8 --package-name=machines --package-version={{version}} --msgid-bugs-address=https://github.com/sachesi/machines/issues --language=Desktop --sort-by-file -o po/machines.pot data/{{app_id}}.desktop
    GETTEXTDATADIRS=data xgettext -j --from-code=UTF-8 --package-name=machines --package-version={{version}} --msgid-bugs-address=https://github.com/sachesi/machines/issues --sort-by-file -o po/machines.pot data/{{app_id}}.metainfo.xml data/{{app_id}}.gschema.xml data/{{app_id}}.policy

# Merge the current template into every po/<lang>.po.
po: pot
    for lang in $(cat po/LINGUAS); do msgmerge --update --backup=none --quiet po/$lang.po po/machines.pot; done
    for lang in $(cat po/LINGUAS); do msgfmt --statistics -o /dev/null po/$lang.po; done

# Install the release build. Does not build: run `just build` first.
install:
    @test -x {{release}}/machines || { echo "error: {{release}}/machines missing; run 'just build' first" >&2; exit 1; }
    install -Dm755 {{release}}/machines {{bindir}}/machines
    install -Dm755 {{release}}/machines-hooks {{destdir}}{{libexecdir}}/machines-hooks
    # Without it, pkexec still runs the helper, asking in its own words.
    if [ -n "{{destdir}}" ] || [ -w /usr/share/polkit-1/actions ]; then \
        install -d {{polkitdir}}; \
        GETTEXTDATADIRS=data msgfmt --xml --template=data/{{app_id}}.policy -d po -o - | sed 's|@LIBEXECDIR@|{{libexecdir}}|' > {{polkitdir}}/{{app_id}}.policy; \
    else echo "note: the polkit policy goes to /usr/share/polkit-1/actions, which takes root" >&2; fi
    mkdir -p {{datadir}}/applications {{datadir}}/metainfo
    msgfmt --desktop --template=data/{{app_id}}.desktop -d po -o {{datadir}}/applications/{{app_id}}.desktop
    msgfmt --xml --template=data/{{app_id}}.metainfo.xml -d po -o {{datadir}}/metainfo/{{app_id}}.metainfo.xml
    install -Dm644 data/{{app_id}}.gschema.xml {{datadir}}/glib-2.0/schemas/{{app_id}}.gschema.xml
    install -Dm644 data/icons/hicolor/scalable/apps/{{app_id}}.svg {{datadir}}/icons/hicolor/scalable/apps/{{app_id}}.svg
    install -Dm644 data/icons/hicolor/symbolic/apps/{{app_id}}-symbolic.svg {{datadir}}/icons/hicolor/symbolic/apps/{{app_id}}-symbolic.svg
    for lang in $(cat po/LINGUAS); do install -d {{datadir}}/locale/$lang/LC_MESSAGES; msgfmt -o {{datadir}}/locale/$lang/LC_MESSAGES/machines.mo po/$lang.po; done
    # A staged install (DESTDIR) leaves the caches to the package manager's triggers.
    [ -n "{{destdir}}" ] || glib-compile-schemas {{datadir}}/glib-2.0/schemas
    [ -n "{{destdir}}" ] || update-desktop-database -q {{datadir}}/applications || true
    [ -n "{{destdir}}" ] || gtk4-update-icon-cache -qtf {{datadir}}/icons/hicolor || gtk-update-icon-cache -qtf {{datadir}}/icons/hicolor || true
    @echo "installed to {{prefix}}"

uninstall:
    rm -f {{bindir}}/machines {{destdir}}{{libexecdir}}/machines-hooks
    [ ! -w {{polkitdir}} ] || rm -f {{polkitdir}}/{{app_id}}.policy
    rm -f {{datadir}}/applications/{{app_id}}.desktop {{datadir}}/metainfo/{{app_id}}.metainfo.xml
    rm -f {{datadir}}/glib-2.0/schemas/{{app_id}}.gschema.xml
    rm -f {{datadir}}/icons/hicolor/scalable/apps/{{app_id}}.svg {{datadir}}/icons/hicolor/symbolic/apps/{{app_id}}-symbolic.svg
    for lang in $(cat po/LINGUAS); do rm -f {{datadir}}/locale/$lang/LC_MESSAGES/machines.mo; done
    glib-compile-schemas {{datadir}}/glib-2.0/schemas || true
    update-desktop-database -q {{datadir}}/applications || true
    # A cache that still lists the removed icons hides the same icons installed elsewhere.
    gtk4-update-icon-cache -qtf {{datadir}}/icons/hicolor || gtk-update-icon-cache -qtf {{datadir}}/icons/hicolor || true

# Remove build artefacts.
clean:
    cargo clean