testsAndMisc/linux_configuration/periodic_background/setup_periodic_system.sh

#!/bin/bash
# Script to set up periodic execution of pacman wrapper and hosts file installation
# Executes every hour and on system startup
# Handles sudo privileges automatically

set -e # Exit on any error

# Source common library for shared functions
SCRIPT_DIR="$(dirname "$(readlink -f "$0")")"
# shellcheck source=../lib/common.sh
source "$SCRIPT_DIR/../lib/common.sh"

# Initialize setup script (parse args, require root, print header)
init_setup_script "Periodic System Setup - Pacman Wrapper & Hosts File" "$@"

# Get the directory where this script is located
CONFIG_DIR="$(dirname "$(dirname "$SCRIPT_DIR")")"

# Define paths
DW_REPO="$(require_extracted_repo digital-wellbeing "the periodic system setup")" || exit 1
PACMAN_WRAPPER_SCRIPT="$DW_REPO/pacman/pacman_wrapper.sh"
PACMAN_WRAPPER_INSTALL="$DW_REPO/pacman/install_pacman_wrapper.sh"
MAKEPKG_WRAPPER_INSTALL="$DW_REPO/pacman/install_makepkg_wrapper.sh"
# hosts-blocker was EXTRACTED out of this monorepo
# (github.com/kuhyx/hosts-blocker), so this path deliberately lives
# outside it. A missing checkout is fatal, never a silent skip.
# shellcheck source=../lib/extracted_repos.sh
source "$CONFIG_DIR/lib/extracted_repos.sh"
HOSTS_BLOCKER_DIR_RESOLVED="$(require_extracted_repo hosts-blocker "the periodic system setup")" || exit 1
HOSTS_INSTALL_SCRIPT="$HOSTS_BLOCKER_DIR_RESOLVED/install.sh"

echo ""
echo "Configuration directory: $CONFIG_DIR"
echo "Pacman wrapper script: $PACMAN_WRAPPER_SCRIPT"
echo "Pacman wrapper installer: $PACMAN_WRAPPER_INSTALL"
echo "Hosts install script: $HOSTS_INSTALL_SCRIPT"

# Templates directory (version-controlled files).
# system-maintenance was EXTRACTED out of this monorepo
# (github.com/kuhyx/system-maintenance). This path pointed at the old in-repo
# location until 2026-08-23, by which time the directory held nothing but
# untracked build residue -- so every `install -m 0644 "$TEMPLATE_..."` here
# was reading a file that did not exist. Same failure class as the stale
# hosts path below: a repair tool silently unable to repair.
TEMPLATES_BASE="$(require_extracted_repo system-maintenance "the periodic system setup")" || exit 1
BIN_TEMPLATES="$TEMPLATES_BASE/bin"
SYSTEMD_TEMPLATES="$TEMPLATES_BASE/systemd"
LOGROTATE_TEMPLATES="$TEMPLATES_BASE/logrotate"

# Template files
TEMPLATE_MAINT_SCRIPT="$BIN_TEMPLATES/periodic-system-maintenance.sh"
TEMPLATE_HOSTS_MONITOR="$BIN_TEMPLATES/hosts-file-monitor.sh"
TEMPLATE_BROWSER_WRAPPER="$BIN_TEMPLATES/browser-preexec-wrapper.sh"
TEMPLATE_SVC_MAINT="$SYSTEMD_TEMPLATES/periodic-system-maintenance.service"
TEMPLATE_TIMER="$SYSTEMD_TEMPLATES/periodic-system-maintenance.timer"
TEMPLATE_STARTUP="$SYSTEMD_TEMPLATES/periodic-system-startup.service"
TEMPLATE_HOSTS_SVC="$SYSTEMD_TEMPLATES/hosts-file-monitor.service"
TEMPLATE_AUTO_UPDATE="$BIN_TEMPLATES/auto-system-update.sh"
TEMPLATE_AUTO_UPDATE_SVC="$SYSTEMD_TEMPLATES/auto-system-update.service"
TEMPLATE_AUTO_UPDATE_TIMER="$SYSTEMD_TEMPLATES/auto-system-update.timer"
TEMPLATE_LOGROTATE="$LOGROTATE_TEMPLATES/periodic-system-maintenance"

# Function to verify required files exist
verify_files() {
	echo ""
	echo "1. Verifying Required Files..."
	echo "=============================="

	local missing_files=()

	if [[ ! -f $PACMAN_WRAPPER_SCRIPT ]]; then
		missing_files+=("$PACMAN_WRAPPER_SCRIPT")
	fi

	if [[ ! -f $PACMAN_WRAPPER_INSTALL ]]; then
		missing_files+=("$PACMAN_WRAPPER_INSTALL")
	fi

	if [[ ! -f $MAKEPKG_WRAPPER_INSTALL ]]; then
		missing_files+=("$MAKEPKG_WRAPPER_INSTALL")
	fi

	if [[ ! -f $HOSTS_INSTALL_SCRIPT ]]; then
		missing_files+=("$HOSTS_INSTALL_SCRIPT")
	fi

	# Check template files as well
	for tmpl in \
		"$TEMPLATE_MAINT_SCRIPT" \
		"$TEMPLATE_HOSTS_MONITOR" \
		"$TEMPLATE_BROWSER_WRAPPER" \
		"$TEMPLATE_SVC_MAINT" \
		"$TEMPLATE_TIMER" \
		"$TEMPLATE_STARTUP" \
		"$TEMPLATE_HOSTS_SVC" \
		"$TEMPLATE_AUTO_UPDATE" \
		"$TEMPLATE_AUTO_UPDATE_SVC" \
		"$TEMPLATE_AUTO_UPDATE_TIMER" \
		"$TEMPLATE_LOGROTATE"; do
		if [[ ! -f $tmpl ]]; then
			missing_files+=("$tmpl")
		fi
	done

	if [[ ${#missing_files[@]} -gt 0 ]]; then
		echo "Error: The following required files are missing:"
		for file in "${missing_files[@]}"; do
			echo "  - $file"
		done
		exit 1
	fi

	echo "✓ All required files found"
}

# Function to create the combined execution script
create_execution_script() {
	echo ""
	echo "2. Creating Combined Execution Script..."
	echo "======================================="

	local exec_script="/usr/local/bin/periodic-system-maintenance.sh"

	# Install from template with path substitutions
	sed \
		-e "s|__PACMAN_WRAPPER_INSTALL__|$PACMAN_WRAPPER_INSTALL|g" \
		-e "s|__MAKEPKG_WRAPPER_INSTALL__|$MAKEPKG_WRAPPER_INSTALL|g" \
		-e "s|__HOSTS_INSTALL_SCRIPT__|$HOSTS_INSTALL_SCRIPT|g" \
		"$TEMPLATE_MAINT_SCRIPT" >"$exec_script"

	chmod +x "$exec_script"
	echo "✓ Installed execution script from template: $exec_script"
}

# Function to create systemd service
create_systemd_service() {
	echo ""
	echo "3. Creating Systemd Service..."
	echo "============================="

	local service_file="/etc/systemd/system/periodic-system-maintenance.service"
	install -m 0644 "$TEMPLATE_SVC_MAINT" "$service_file"
	echo "✓ Installed systemd service from template: $service_file"
}

# Function to create systemd timer for hourly execution
create_systemd_timer() {
	echo ""
	echo "4. Creating Systemd Timer..."
	echo "============================"

	local timer_file="/etc/systemd/system/periodic-system-maintenance.timer"
	install -m 0644 "$TEMPLATE_TIMER" "$timer_file"
	echo "✓ Installed systemd timer from template: $timer_file"
}

# Function to create startup service (additional to timer)
create_startup_service() {
	echo ""
	echo "5. Creating Startup Service..."
	echo "=============================="

	local startup_service="/etc/systemd/system/periodic-system-startup.service"
	install -m 0644 "$TEMPLATE_STARTUP" "$startup_service"
	echo "✓ Installed startup service from template: $startup_service"
}

# Function to create hosts file monitor service
create_hosts_monitor_service() {
	echo ""
	echo "6. Creating Hosts File Monitor Service..."
	echo "========================================"

	local monitor_script="/usr/local/bin/hosts-file-monitor.sh"
	local monitor_service="/etc/systemd/system/hosts-file-monitor.service"

	# Install the monitor script from template with substitution
	sed -e "s|__HOSTS_INSTALL_SCRIPT__|$HOSTS_INSTALL_SCRIPT|g" \
		"$TEMPLATE_HOSTS_MONITOR" >"$monitor_script"
	chmod +x "$monitor_script"
	echo "✓ Installed hosts monitor script from template: $monitor_script"

	# Install the systemd service from template
	install -m 0644 "$TEMPLATE_HOSTS_SVC" "$monitor_service"
	echo "✓ Installed hosts monitor service from template: $monitor_service"
}

# shellcheck source=lib/periodic_browser.sh
source "$SCRIPT_DIR/lib/periodic_browser.sh"

verify_files
create_execution_script
create_systemd_service
create_systemd_timer
create_startup_service
create_hosts_monitor_service
install_browser_preexec_wrapper
install_auto_update
enable_services
create_log_rotation
run_initial_execution

echo ""
echo "=========================================="
echo "Periodic System Setup Complete"
echo "=========================================="
echo "Summary:"
echo "✓ Execution script created: /usr/local/bin/periodic-system-maintenance.sh"
echo "✓ Systemd service created and enabled: periodic-system-maintenance.service"
echo "✓ Systemd timer created and enabled: periodic-system-maintenance.timer"
echo "✓ Startup service created and enabled: periodic-system-startup.service"
echo "✓ Hosts file monitor script and service created and enabled"
echo "✓ Auto-update service created and enabled: auto-system-update.timer"
echo "✓ Log rotation configured: /etc/logrotate.d/periodic-system-maintenance"
echo ""
echo "The system will now:"
echo "• Run maintenance every hour"
echo "• Run maintenance 5 minutes after system startup"
echo "• Monitor hosts file for changes and restore if needed"
echo "• Run pacman -Syuu and yay -Sua daily at 04:00 (±30min)"
echo "• Log all activities to /var/log/periodic-system-maintenance.log, /var/log/auto-system-update.log, and /var/log/hosts-file-monitor.log"
echo ""
echo "To check status:"
echo "  systemctl status periodic-system-maintenance.timer"
echo "  systemctl status auto-system-update.timer"
echo "  systemctl list-timers periodic-system-maintenance.timer auto-system-update.timer"
echo "  systemctl status hosts-file-monitor.service"
echo ""
echo "To view logs:"
echo "  tail -f /var/log/periodic-system-maintenance.log"
echo "  journalctl -u periodic-system-maintenance.service -f"
echo "  tail -f /var/log/auto-system-update.log"
echo "  journalctl -u auto-system-update.service -f"
echo "  tail -f /var/log/hosts-file-monitor.log"
echo "  journalctl -u hosts-file-monitor.service -f"
echo ""
echo "To disable (if needed):"
echo "  sudo systemctl disable periodic-system-maintenance.timer"
echo "  sudo systemctl disable periodic-system-startup.service"
echo "  sudo systemctl disable auto-system-update.timer"
echo "  sudo systemctl disable hosts-file-monitor.service"