Add .pacnew and reboot reminders

Remind about files to merge with pacdiff and a reboot after the running kernel
was upgraded. They join every notification and notify alone only for new items;
PACNEW_CHECK/REBOOT_CHECK disable them, and the pending file gets pacnew/reboot lines.

PKGBUILD

@@ -3,11 +3,11 @@
 # Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
 
 pkgname=update-notify
-pkgver=3.4
+pkgver=3.11.2
 pkgrel=1
 pkgdesc='Notify when updates are available'
 arch=('any')
-url="https://git.shouldnt.work/fuxino/${pkgname}"
+url="https://git.shouldnt.work/fuxino/$pkgname"
 license=('GPL-3.0-or-later')
 depends=('pacman-contrib'
          'libnotify')
@@ -15,15 +15,18 @@ makedepends=('git')
 optdepends=('aurutils: to check AUR packages in the local repo for updates'
             'fwupd: to check for firmware updates'
             'git-monitor: to check git repos for updates')
-source=("git+${url}?signed#tag=${pkgver}")
+source=("git+$url?signed#tag=$pkgver")
 validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
-sha256sums=('12a68498d50871264f4a0ed082ff29a361676cf134c43520f98ee3f287e45509')
+sha256sums=('1a3859f3c9d3bbcd46c59ccc728f6ffa9a1d162df940bcd31e2b5753a40324f4')
 
 package()
 {
-    cd "${srcdir}/${pkgname}"
-    install -Dm755 "${pkgname}" "${pkgdir}/usr/bin/${pkgname}"
-    install -Dm644 "${pkgname}.service" "${pkgdir}/usr/lib/systemd/user/${pkgname}.service"
-    install -Dm644 "${pkgname}.timer" "${pkgdir}/usr/lib/systemd/user/${pkgname}.timer"
-    install -Dm644 README.md "${pkgdir}/usr/share/doc/${pkgname}/README.md"
+    cd "$srcdir"/"$pkgname"
+    install -Dm755 "$pkgname" "$pkgdir"/usr/bin/"$pkgname"
+    install -Dm644 "$pkgname".service "$pkgdir"/usr/lib/systemd/user/"$pkgname".service
+    install -Dm644 "$pkgname"-quiet.service "$pkgdir"/usr/lib/systemd/user/"$pkgname"-quiet.service
+    install -Dm644 "$pkgname".timer "$pkgdir"/usr/lib/systemd/user/"$pkgname".timer
+    install -Dm644 "$pkgname".path "$pkgdir"/usr/lib/systemd/user/"$pkgname".path
+    install -Dm644 README.md "$pkgdir"/usr/share/doc/"$pkgname"/README.md
+    install -Dm644 config.example "$pkgdir"/usr/share/doc/"$pkgname"/config.example
 }

README.md

@@ -7,11 +7,13 @@ update-notify runs on a systemd user timer and checks:
 - **Repo updates**, using `checkupdates` from pacman-contrib.
 - **AUR updates** for packages in a local aurutils repository (`aur repo -u`).
 - **Custom kernel rebuilds**: when a stock kernel (e.g. `linux-lts`) has a newer version than your custom build of it (e.g. `linux-lts-custom`).
+- **Maintenance**: `.pacnew`/`.pacsave` files to merge (`pacdiff -o`), and a reboot after the running kernel was upgraded.
 
 It sends one notification, and only when its content changes since the last one:
 
 - Update counts are shown once the total number of updates reaches a threshold (default 30). Reminders for `git-monitor` and pending firmware updates (`fwupdmgr`) are added when those tools are installed.
 - Kernel rebuild reminders are always shown, even below the threshold.
+- Maintenance reminders are added to every notification. On their own, they notify only when something new appears (a new file to merge, a new kernel to reboot into), so a `.pacnew` you keep isn't repeated.
 
 ## Requirements
 
@@ -26,13 +28,13 @@ Optional:
 
 ## Installation
 
-Build and install the package with the included PKGBUILD:
+Build and install the package with the included PKGBUILD, which builds the signed release tag set in `pkgver`:
 
 ```
 makepkg -si
 ```
 
-Or, with aurutils, build it into your local repository with `aur build` and install it with pacman.
+Or, with aurutils, build it into a local repository with `aur build` and install it with pacman.
 
 Then enable the timer:
 
@@ -42,13 +44,35 @@ systemctl --user enable --now update-notify.timer
 
 The timer runs 5 minutes after boot, then every 6 hours.
 
+### Refresh after building packages
+
+To run `update-notify --quiet` whenever a repository changes, add the repository files to watch to `update-notify.path`:
+
+```
+systemctl --user edit update-notify.path
+```
+
+```
+[Path]
+PathChanged=/home/aur-local/aur-local.db.tar.gz.sig
+PathChanged=/home/custom-pkgs/custom-pkgs.db.tar.gz.sig
+```
+
+Watch the `.db.tar.gz.sig` file for signed repositories, or `.db.tar.gz` for unsigned ones (`.db` is a symlink). Then enable it:
+
+```
+systemctl --user enable --now update-notify.path
+```
+
 ## Usage
 
 ```
-update-notify [threshold]
+update-notify [-q|--quiet] [threshold]
 ```
 
-`threshold` is the minimum number of updates (repo + AUR) before update counts are shown. It overrides the `THRESHOLD` setting below.
+`threshold` is the minimum number of updates (repo + AUR) before update counts are shown. It overrides the `THRESHOLD` setting below for that run's notification only; the pending file keeps the configured value.
+
+`--quiet` updates the pending file without notifying. Changes to a notification already shown are recorded, so the next timer run doesn't repeat them; a new notification is left for the timer. `update-notify.path` uses it (through `update-notify-quiet.service`), so building many packages doesn't notify after each one.
 
 ## Configuration
 
@@ -57,6 +81,8 @@ Settings are read from `$XDG_CONFIG_HOME/update-notify/config` (default `~/.conf
 - `THRESHOLD`: minimum number of updates before update counts are shown (default 30).
 - `AUR_REPO`: name of the local aurutils repository (default `aur-local`).
 - `KERNELS`: maps each stock kernel package to its custom build (default: `linux`, `linux-lts` and `linux-zen` to `<name>-custom`). Kernels where either package isn't installed are skipped. Set `KERNELS=()` to disable the kernel check.
+- `PACNEW_CHECK`: set to `0` to disable the `.pacnew`/`.pacsave` reminder (default `1`).
+- `REBOOT_CHECK`: set to `0` to disable the reboot reminder (default `1`). A reboot is needed when the running kernel's `/usr/lib/modules/<version>/vmlinuz` is gone.
 
 A commented sample config is installed with the package. To start from it:
 
@@ -69,6 +95,21 @@ Kernel versions are compared without `pkgrel`, so a stock packaging-only update
 
 The content of the last notification is stored in `$XDG_STATE_HOME/update-notify` (default `~/.local/state/update-notify`). Delete it to get the current notification again.
 
+## Status bars
+
+Each run also writes the pending updates to `$XDG_STATE_HOME/update-notify/pending`, whether or not the threshold is reached, for status bars such as xmobar to read:
+
+```
+threshold <THRESHOLD from the config, not the argument>
+repo <pkg> <newver>
+aur <pkg> <newver>
+kernel <custom-pkg> <stock-ver>
+pacnew <path>
+reboot <running kernel version>
+```
+
+The file reflects the last timer or `update-notify.path` run. To keep a bar current in between, e.g. right after an upgrade, drop entries whose installed version (`pacman -Q`) is no longer older than `newver`; for `kernel` lines, whose custom build has caught up with `stock-ver` (ignoring `pkgrel`); for `pacnew` lines, whose file is gone; for `reboot` lines, whose version is no longer `uname -r`. This only reads local data, so it's cheap to run often.
+
 ## License
 
 GPL-3.0-or-later. See [LICENSE](LICENSE).

config.example

@@ -17,3 +17,9 @@
 #    [linux-lts]="linux-lts-custom"
 #    [linux-zen]="linux-zen-custom"
 #)
+
+# Remind about .pacnew/.pacsave files to merge with pacdiff (0 to disable).
+#PACNEW_CHECK=1
+
+# Remind to reboot after the running kernel was upgraded (0 to disable).
+#REBOOT_CHECK=1

update-notify

@@ -12,6 +12,8 @@ declare -A KERNELS=(
     [linux-lts]="linux-lts-custom"
     [linux-zen]="linux-zen-custom"
 )
+PACNEW_CHECK=1  # remind about .pacnew/.pacsave files (0 to disable)
+REBOOT_CHECK=1  # remind to reboot after a kernel upgrade (0 to disable)
 config_file="${XDG_CONFIG_HOME:-$HOME/.config}/update-notify/config"
 state_dir="${XDG_STATE_HOME:-$HOME/.local/state}/update-notify"
 
@@ -19,10 +21,20 @@ if [[ -r $config_file ]]; then
     # shellcheck source=/dev/null
     source "$config_file"
 fi
+quiet=0  # refresh the pending file without notifying (path unit)
+if [[ ${1:-} == -q || ${1:-} == --quiet ]]; then
+    quiet=1
+    shift
+fi
+config_threshold=$THRESHOLD  # written to the pending file, so a one-off argument doesn't change status bars
 THRESHOLD=${1:-$THRESHOLD}
 
-[[ $THRESHOLD =~ ^[0-9]+$ ]] || { echo "Threshold must be a number" >&2; exit 1; }
-THRESHOLD=$((10#$THRESHOLD))  # force base 10, so e.g. "08" isn't read as octal
+for t in "$config_threshold" "$THRESHOLD"; do
+    [[ $t =~ ^[0-9]+$ ]] || { echo "Threshold must be a number" >&2; exit 1; }
+done
+# force base 10, so e.g. "08" isn't read as octal
+config_threshold=$((10#$config_threshold))
+THRESHOLD=$((10#$THRESHOLD))
 mkdir -p "$state_dir"
 
 # notify-send from cron/systemd needs the session bus address
@@ -32,21 +44,6 @@ export DBUS_SESSION_BUS_ADDRESS="${DBUS_SESSION_BUS_ADDRESS:-unix:path=/run/user
 # Helpers
 # ---------------------------------------------------------------------------
 
-# Send a notification only if its body changed since last time for this key.
-notify_once() {
-    local key=$1 title=$2 body=$3
-    local file="$state_dir/$key"
-    if [[ -f $file && $(<"$file") == "$body" ]]; then
-        return 0
-    fi
-    notify-send "$title" "$body" && printf '%s' "$body" > "$file"
-}
-
-# Forget a key so the next occurrence notifies again.
-clear_state() {
-    rm -f "$state_dir/$1"
-}
-
 # If $1 has a pending update, print its new version and return 0.
 # checkupdates lines look like: "pkgname oldver -> newver"
 pending_version() {
@@ -93,20 +90,22 @@ if [[ -n $checkupdates_out ]]; then
 fi
 arch_updates=${#arch_list[@]}
 
-aur_updates=0
+aur_list=()
 if command -v aur >/dev/null 2>&1; then
     if aur_out=$(aur repo -u -d "$AUR_REPO"); then
-        [[ -n $aur_out ]] && aur_updates=$(wc -l <<< "$aur_out")
+        [[ -n $aur_out ]] && mapfile -t aur_list <<< "$aur_out"
     else
         echo "aur repo -u failed, AUR updates not counted" >&2
     fi
 fi
+aur_updates=${#aur_list[@]}
 updates=$((arch_updates + aur_updates))
 
 # ---------------------------------------------------------------------------
 # Kernel check: the stock kernel updated, but your custom build didn't
 # ---------------------------------------------------------------------------
 kernel_lines=()
+kernel_pending=()
 for stock_pkg in "${!KERNELS[@]}"; do
     custom_pkg=${KERNELS[$stock_pkg]}
 
@@ -120,9 +119,51 @@ for stock_pkg in "${!KERNELS[@]}"; do
     # pkgrel is ignored: a stock packaging-only bump doesn't need a rebuild.
     if (( $(vercmp "${stock_ver%-*}" "${custom_ver%-*}") > 0 )); then
         kernel_lines+=("Rebuild $custom_pkg ($stock_pkg $stock_ver)")
+        kernel_pending+=("$custom_pkg $stock_ver")
     fi
 done
 
+# ---------------------------------------------------------------------------
+# Maintenance: config files to merge, reboot after a kernel upgrade.
+# maint_items are tracked in the state and the pending file, maint_lines are shown.
+# ---------------------------------------------------------------------------
+maint_items=()
+maint_lines=()
+if [[ $PACNEW_CHECK != 0 ]]; then
+    mapfile -t pacnew_files < <(pacdiff -o 2>/dev/null)
+    if (( ${#pacnew_files[@]} )); then
+        maint_items+=("${pacnew_files[@]/#/pacnew }")
+        maint_lines+=("Config files to merge with pacdiff: ${#pacnew_files[@]}")
+    fi
+fi
+running_kernel=$(uname -r)
+# vmlinuz belongs to the kernel package, while DKMS files can keep the folder around
+if [[ $REBOOT_CHECK != 0 && ! -e /usr/lib/modules/$running_kernel/vmlinuz ]]; then
+    maint_items+=("reboot $running_kernel")
+    maint_lines+=("Reboot to load the new kernel (running $running_kernel)")
+fi
+
+# ---------------------------------------------------------------------------
+# Pending list for status bars, one "<source> <pkg> <newver>" per line
+# ---------------------------------------------------------------------------
+{
+    printf 'threshold %s\n' "$config_threshold"
+    for item in "${arch_list[@]}"; do
+        read -r pkg _ _ new <<< "$item"
+        printf 'repo %s %s\n' "$pkg" "$new"
+    done
+    for item in "${aur_list[@]}"; do
+        read -r pkg _ _ new <<< "$item"
+        printf 'aur %s %s\n' "$pkg" "$new"
+    done
+    for item in "${kernel_pending[@]}"; do
+        printf 'kernel %s\n' "$item"
+    done
+    for item in "${maint_items[@]}"; do
+        printf '%s\n' "$item"
+    done
+} > "$state_dir/pending.tmp" && mv "$state_dir/pending.tmp" "$state_dir/pending"  # readers never see a partial file
+
 # ---------------------------------------------------------------------------
 # Build a single notification
 #   - kernel rebuild lines are always included
@@ -160,11 +201,66 @@ if (( over_threshold )); then
     fi
 fi
 
+# ---------------------------------------------------------------------------
+# Notify when the update part changed since the last notification (maintenance
+# lines included), or for maintenance alone when it has items not shown before
+# ---------------------------------------------------------------------------
+main_file="$state_dir/updates"
+main_body=""
+main_changed=0
 if (( ${#parts[@]} )); then
+    printf -v main_body '%s\n' "${parts[@]}"
+    main_body=${main_body%$'\n'}
+    [[ -f $main_file && $(<"$main_file") == "$main_body" ]] || main_changed=1
+else
+    rm -f "$main_file"  # so the next occurrence notifies again
+fi
+
+maint_file="$state_dir/maintenance"
+declare -A maint_seen=()
+if [[ -f $maint_file ]]; then
+    while IFS= read -r item; do
+        maint_seen["$item"]=1
+    done < "$maint_file"
+fi
+maint_new=0
+maint_kept=()  # current items already shown
+for item in "${maint_items[@]}"; do
+    if [[ -n ${maint_seen["$item"]:-} ]]; then
+        maint_kept+=("$item")
+    else
+        maint_new=1
+    fi
+done
+
+lines=()
+if (( main_changed )); then
+    lines=("${parts[@]}" "${maint_lines[@]}")
     title="Updates available"
     (( over_threshold )) || title="Kernel update available"
-    printf -v body '%s\n' "${parts[@]}"
-    notify_once "updates" "$title" "${body%$'\n'}"
-else
-    clear_state "updates"
+elif (( maint_new )); then
+    lines=("${maint_lines[@]}")
+    title="System maintenance"
+fi
+
+shown=0
+if (( ${#lines[@]} )); then
+    printf -v body '%s\n' "${lines[@]}"
+    if (( quiet )); then
+        # Track changes to a shown notification, so the timer doesn't re-notify them;
+        # leave a new one for the timer to show
+        (( main_changed )) && [[ -f $main_file ]] && printf '%s' "$main_body" > "$main_file"
+    elif notify-send "$title" "${body%$'\n'}"; then
+        shown=1
+        [[ -n $main_body ]] && printf '%s' "$main_body" > "$main_file"
+    fi
+fi
+
+# Remember the maintenance items shown: drop resolved ones, keep new ones for the next notification
+maint_save=("${maint_kept[@]}")
+(( shown )) && maint_save=("${maint_items[@]}")
+if (( ${#maint_save[@]} )); then
+    printf '%s\n' "${maint_save[@]}" > "$maint_file"
+else
+    rm -f "$maint_file"
 fi

update-notify-quiet.service

@@ -0,0 +1,6 @@
+[Unit]
+Description=Refresh the update-notify pending file without notifying
+
+[Service]
+ExecStart=/usr/bin/update-notify --quiet
+Type=oneshot

update-notify.path

@@ -0,0 +1,10 @@
+[Unit]
+Description=Run update-notify when a local repository changes
+
+# Add the repository files to watch with: systemctl --user edit update-notify.path
+# e.g. PathChanged=/home/aur-local/aur-local.db.tar.gz.sig
+[Path]
+Unit=update-notify-quiet.service
+
+[Install]
+WantedBy=default.target