Added boot/resume detection

Author: guttermonk

README.md

@@ -23,8 +23,9 @@ System Requirements:
 1. NixOS operating system (based on the nature of the script)
 2. A running Waybar instance (the script outputs JSON for Waybar integration)
 3. Internet connectivity for performing update checks
+4. Desktop notification system compatible with `notify-send`
 
-## Privacy
+## Privacy and Security Considerations
 External Network Requests: The script uses `ping -c 1 -W 2 8.8.8.8` to check network connectivity and send packets to Google's DNS servers (8.8.8.8), which could potentially reveal:
 - That your system is running and online
 - The fact you're using this specific script
@@ -36,40 +37,66 @@ External Network Requests: The script uses `ping -c 1 -W 2 8.8.8.8` to check net
 
 2. **File Initialization**: Creates necessary state files if they don't exist (tracks update count, last check time, and tooltip info).
 
-3. **Network Check**: Verifies internet connectivity by pinging 8.8.8.8.
+3. **Boot/Resume Detection**: Detects if the system has recently booted or resumed from suspension/hibernation to avoid unnecessary resource usage during these transition periods.
 
-4. **System Update Status**: Checks if the system was recently rebuilt by looking for the rebuild flag.
+4. **Grace Period Management**: Applies a configurable grace period after boot or resume before running update checks.
 
-5. **Update Check Timing**: Determines if it's time to check for updates based on the last check timestamp.
+5. **Network Check**: Verifies internet connectivity by pinging 8.8.8.8.
 
-6. **Temporary Environment**: Creates a temporary directory for performing update checks without modifying the system.
+6. **System Update Status**: Checks if the system was recently rebuilt by looking for the rebuild flag.
 
-7. **Flake Update**: Runs `nix flake update` either in the config directory or temp directory based on settings.
+7. **Update Check Timing**: Determines if it's time to check for updates based on the last check timestamp.
 
-8. **System Build**: Builds the updated system configuration to compare with the current one.
+8. **Temporary Environment**: Creates a temporary directory for performing update checks without modifying the system.
 
-9. **Update Comparison**: Uses `nvd diff` to compare current system with the new build and count updates.
+9. **Flake Update**: Runs `nix flake update` either in the config directory or temp directory based on settings.
 
-10. **Result Storage**: Saves the number of updates and detailed update information to state files.
+10. **System Build**: Builds the updated system configuration to compare with the current one.
 
-11. **Notification**: Sends desktop notifications to inform the user about the update status.
+11. **Update Comparison**: Uses `nvd diff` to compare current system with the new build and count updates.
 
-12. **JSON Output**: Generates a JSON object with update count, status indicator, and tooltip for Waybar.
+12. **Result Storage**: Saves the number of updates and detailed update information to state files.
 
-13. **Flag Management**: Cleans up system update flags if a rebuild was detected.
+13. **Notification**: Sends desktop notifications to inform the user about the update status.
 
-14. **Error Handling**: Sets appropriate status messages if update checks fail or network is unavailable.
+14. **JSON Output**: Generates a JSON object with update count, status indicator, and tooltip for Waybar.
 
-15. **Tooltip Generation**: Creates detailed tooltips showing which packages have updates available.
+15. **Flag Management**: Cleans up system update flags if a rebuild was detected.
 
-16. **State Management**: Manages update state across multiple runs of the script.
+16. **Error Handling**: Sets appropriate status messages if update checks fail or network is unavailable.
 
-17. **Output Formatting**: Formats the final output to be compatible with Waybar's custom module format.
+17. **Tooltip Generation**: Creates detailed tooltips showing which packages have updates available.
+
+18. **State Management**: Manages update state across multiple runs of the script.
+
+19. **Output Formatting**: Formats the final output to be compatible with Waybar's custom module format.
 
 
 ## How to Use
 Download the `update-checker` script, put it in your [PATH](https://unix.stackexchange.com/a/26059) and make it executable (`chmod +x update-checker`).
 
+### Configuration Options
+
+You can modify these variables at the top of the script to customize behavior:
+
+- `UPDATE_INTERVAL`: Time in seconds between update checks (default: 3599)
+- `NIXOS_CONFIG_PATH`: Path to your NixOS configuration (default: ~/.config/nixos)
+- `CACHE_DIR`: Directory for storing cache files (default: ~/.cache)
+- `SKIP_AFTER_BOOT`: Whether to skip update checks right after boot/resume (default: true)
+- `GRACE_PERIOD`: Time in seconds to wait after boot/resume before checking (default: 60)
+- `UPDATE_LOCK_FILE`: Whether to update the lock file directly or use a temporary copy (default: false)
+
+#### Cache Files
+The script uses several cache files in your ~/.cache directory:
+- `nix-update-state`: Stores the current number of available updates
+- `nix-update-last-run`: Tracks when the last update check was performed
+- `nix-update-tooltip`: Contains the tooltip text with update details
+- `nix-update-boot-marker`: Used to detect system boot/resume events
+- `nix-update-update-flag`: Signals that your lock file has been updated
+- `nix-update-rebuild-flag`: Signals that your system has been rebuilt
+
+### Waybar Integration
+
 To configure, add the following to your Waybar config (`~/.config/waybar/config`).
 
 In json:
@@ -111,30 +138,43 @@ In nix:
 To style use the `#custom-nix-updates` ID in your Waybar styles file (`~/.config/waybar/styles.css`).
 
 
-If you have you have UPDATE_LOCK_FILE set to "false", the UPDATE_FLAG file will signal that your lock file has been updated. Add the following to your update script, used to update your lock file (i.e. "nix flake update" script), so that the output of nvd diff is piped in:
+If you have UPDATE_LOCK_FILE set to "false", the UPDATE_FLAG file will signal that your lock file has been updated. Add the following to your update script, used to update your lock file (i.e. "nix flake update" script), so that the output of nvd diff is piped in:
 `| tee >(if grep -qe '\\[U'; then touch \"$HOME/.cache/nix-update-update-flag\"; else rm -f \"$HOME/.cache/nix-update-update-flag\"; fi) &&`
 
 For example:
 ```nix
-      checkup =
-        "pushd ~/.config/nixos &&
-        nix flake update nixpkgs nixpkgs-unstable &&
-        nix build .#nixosConfigurations.'hyprnix'.config.system.build.toplevel &&
-        nvd diff /run/current-system ./result | tee >(if grep -qe '\\[U'; then touch \"$HOME/.cache/nix-update-update-flag\"; else rm -f \"$HOME/.cache/nix-update-update-flag\"; fi) &&
-        popd";
+checkup =
+  "pushd ~/.config/nixos &&
+  nix flake update nixpkgs nixpkgs-unstable &&
+  nix build .#nixosConfigurations.'hyprnix'.config.system.build.toplevel &&
+  nvd diff /run/current-system ./result | tee >(if grep -qe '\\[U'; then touch \"$HOME/.cache/nix-update-update-flag\"; else rm -f \"$HOME/.cache/nix-update-update-flag\"; fi) &&
+  popd";
 ```
 
 The REBUILD_FLAG signals this script to run after your system has been rebuilt. Add this to your update script to create the REBUILD_FLAG and send a signal to waybar to refresh after updating:
-`touch $HOME/.cache/nix-update-rebuild-flag && pkill -x -RTMIN+12 .waybar-wrapped &&`
+`if [ -f \"$HOME/.cache/nix-update-update-flag\" ]; then touch \"$HOME/.cache/nix-update-rebuild-flag\" && pkill -x -RTMIN+12 .waybar-wrapped; fi &&`
+
+This works with the `signal: 12` parameter in the Waybar configuration, which causes Waybar to run the script when it receives RTMIN+12 signal.
+
+### Notifications
+
+The script sends desktop notifications to keep you informed:
+- When starting an update check: "Checking for Updates"
+- When throttled due to recent checks: "Please Wait" with time until next check
+- When updates are found: "Update Check Complete" with the number of updates
+- When no updates are found: "Update Check Complete - No updates available"
+- When connectivity fails: "Update Check Failed - Not connected to the internet"
+
+These notifications require `notify-send` to be installed on your system.
 
 For example:
 ```nix
 nixup =
   "pushd ~/.config/nixos &&
   echo \"NixOS rebuilding...\" &&
   sudo nixos-rebuild switch --upgrade --flake .#hyprnix &&
-  touch $HOME/.cache/nix-update-rebuild-flag &&
-  pkill -x -RTMIN+12 .waybar-wrapped &&
+  if [ -f \"$HOME/.cache/nix-update-update-flag\" ]; then touch \"$HOME/.cache/nix-update-rebuild-flag\" &&
+  pkill -x -RTMIN+12 .waybar-wrapped; fi &&
   popd";
 ```
 

update-checker

@@ -1,15 +1,20 @@
 #!/usr/bin/env bash
 
-# NixOS Update Checker for Waybar
-# This script checks for NixOS updates and outputs JSON for Waybar integration
-
 # ===== Configuration =====
 UPDATE_INTERVAL=3599  # Check interval in seconds (1 hour)
 NIXOS_CONFIG_PATH="$HOME/.config/nixos"  # Path to NixOS configuration
 CACHE_DIR="$HOME/.cache"
 STATE_FILE="$CACHE_DIR/nix-update-state"
 LAST_RUN_FILE="$CACHE_DIR/nix-update-last-run"
 LAST_RUN_TOOLTIP="$CACHE_DIR/nix-update-tooltip"
+BOOT_MARKER_FILE="$CACHE_DIR/nix-update-boot-marker"  # Marker file to detect boot/resume
+
+# The grace period prevents the update checker from running immediately after:
+# 1. First boot - when the system has just started up
+# 2. Resume from hibernation/suspension - when the system has just woken up
+# This avoids unnecessary resource usage and notifications during these transition periods.
+SKIP_AFTER_BOOT=true  # Set to false if you want to run the checker even after boot/resume
+GRACE_PERIOD=60  # Grace period in seconds (60 seconds) after boot/resume
 
 # If true, update the lock file in the config folder.
 # If false, copy config to temp folder first, and then update the temp dir's lock file.
@@ -24,7 +29,7 @@ UPDATE_FLAG="$CACHE_DIR/nix-update-update-flag"
 
 # The REBUILD_FLAG signals this script to run after your system has been rebuilt.
 # Add this to your update script:
-# && touch $HOME/.cache/nix-update-rebuild-flag && pkill -x -RTMIN+12 .waybar-wrapped
+# if [ -f \"$HOME/.cache/nix-update-update-flag\" ]; then touch \"$HOME/.cache/nix-update-rebuild-flag\" && pkill -x -RTMIN+12 .waybar-wrapped; fi &&
 REBUILD_FLAG="$CACHE_DIR/nix-update-rebuild-flag"
 
 
@@ -59,6 +64,75 @@ function send_notification() {
     notify-send "$title" "$message" -e
 }
 
+function check_boot_resume() {
+        # This function detects if the system has recently booted or resumed from hibernation/sleep
+        # Returns 0 (true) if we're in the grace period, 1 (false) otherwise
+
+        local current_time=$(date +%s)
+        local uptime_seconds=$(cat /proc/uptime | awk '{print int($1)}')
+        local last_boot_time=$((current_time - uptime_seconds))
+
+        # Check if this is first run after boot
+        if [ ! -f "$BOOT_MARKER_FILE" ] || [ $((current_time - last_boot_time)) -lt "$GRACE_PERIOD" ]; then
+            # We're either in first run or within grace period after boot
+            echo "$current_time" > "$BOOT_MARKER_FILE"
+            return 0
+        fi
+
+        # Initialize resume timestamp
+        local last_resume=0
+
+        # Try to detect resume using systemd logs
+        if command -v journalctl >/dev/null 2>&1; then
+            # Get timestamp of last resume/wakeup event from systemd journal
+            local resume_log=$(journalctl -b -u systemd-suspend.service -u systemd-hibernate.service -n 1 -o short-unix 2>/dev/null)
+            if [ -n "$resume_log" ]; then
+                # Extract just the numeric timestamp from the beginning of the line
+                local timestamp=$(echo "$resume_log" | sed -E 's/^([0-9]+).*/\1/')
+                if [ -n "$timestamp" ] && [[ "$timestamp" =~ ^[0-9]+$ ]]; then
+                    last_resume=$timestamp
+                fi
+            fi
+
+            # If no direct service logs, try looking for resume messages in kernel logs
+            if [ $last_resume -eq 0 ]; then
+                local wake_log=$(journalctl -b -k -g "PM: resumed" -n 1 -o short-unix 2>/dev/null)
+                if [ -n "$wake_log" ]; then
+                    # Extract just the numeric timestamp from the beginning of the line
+                    local timestamp=$(echo "$wake_log" | sed -E 's/^([0-9]+).*/\1/')
+                    if [ -n "$timestamp" ] && [[ "$timestamp" =~ ^[0-9]+$ ]]; then
+                        last_resume=$timestamp
+                    fi
+                fi
+            fi
+        fi
+
+        # Check if we can find resume info in NixOS-specific locations
+        if [ $last_resume -eq 0 ] && [ -d "/run/systemd/system" ]; then
+            # Check systemd sleep state
+            if [ -f "/run/systemd/suspend/active" ] || [ -f "/run/systemd/hibernate/active" ]; then
+                last_resume=$current_time  # Just woke up
+            fi
+        fi
+
+        # If we detected a resume and it's recent, we're in grace period
+        if [ $last_resume -gt 0 ] && [ $((current_time - last_resume)) -lt "$GRACE_PERIOD" ]; then
+            echo "$current_time" > "$BOOT_MARKER_FILE"
+            return 0
+        fi
+
+        # Check if we have a saved boot marker and we're still in grace period
+        if [ -f "$BOOT_MARKER_FILE" ]; then
+            local marker_time=$(cat "$BOOT_MARKER_FILE")
+            if [[ "$marker_time" =~ ^[0-9]+$ ]] && [ $((current_time - marker_time)) -lt "$GRACE_PERIOD" ]; then
+                return 0  # Still in grace period from marker
+            fi
+        fi
+
+        # Not in grace period
+        return 1
+    }
+
 function check_network_connectivity() {
     # Check if either ethernet or wireless is connected
     if ping -c 1 -W 2 8.8.8.8 > /dev/null 2>&1; then
@@ -74,7 +148,6 @@ function sys_updated() {
   else
     return 1 # System has not been updated
   fi
-
 }
 
 function calc_next_update() {
@@ -145,6 +218,16 @@ function check_for_updates() {
 function main() {
     init_files
 
+    # Check if we're in post-boot/resume grace period
+    if [ "$SKIP_AFTER_BOOT" = "true" ] && check_boot_resume; then
+        # Skip update check during grace period after boot or resume from hibernation
+        # This prevents unnecessary resource usage during system startup or wakeup
+        updates=$(cat "$STATE_FILE")
+        var_setter
+        echo "{ \"text\":\"$updates\", \"alt\":\"$alt\", \"tooltip\":\"$tooltip\" }"
+        exit 0
+    fi
+
     # Check for network connectivity before proceeding
     if check_network_connectivity; then
 
@@ -177,7 +260,8 @@ function main() {
                   var_setter
               else
                   # Update check failed
-                  alt="error"
+                  updates=$(cat "$STATE_FILE")
+                  var_setter
                   tooltip="Update check failed"
               fi
           else