Log altid ud efter X minutter med nedtæller

Source: Download script

Last Updated: 4. December 2024 by Agnete Moos (agms@sonderborg.dk)

Parameters:

Navn	Type	Standardværdi	Påkrævet

Click to see the source code

#! /usr/bin/env sh

# We need to run this program only AFTER login, so not graphical.target or whatever, if that
# includes the login manager which also runs in X.

# This program needs to run as root or superuser so a user can't kill it,
# but at the same time the timer program must run as the regular user to be able to write things to
# screen.
# It's fine if they kill the visual timer as long as they're then logged out automatically or the timer
# continues in the background.

set -x

if get_os2borgerpc_config os2_product | grep --quiet kiosk; then
  echo "Dette script er ikke designet til at blive anvendt på en kiosk-maskine."
  exit 1
fi

# Argument handling
ACTIVATE=$1
MINUTES_TO_LOGOUT=$2 # This sets the default timeout time, which the Cicero script then overwrites
PRE_TIMER_TEXT="${3:-Tid tilbage: }"
HEADS_UP_SECONDS_LEFT=${4:-60}
HEADS_UP_MESSAGE="${5:-Tiden er udløbet om et minut. Husk at gemme dine ting}"


# Settings

# COMMON
export DEBIAN_FRONTEND=noninteractive
SHADOW=".skjult"
EXTENSION_NAME='logout-timer@os2borgerpc.magenta.dk'
LOGOUT_TIMER_CONF="/usr/share/gnome-shell/extensions/$EXTENSION_NAME/config.json"
SESSION_CLEANUP_FILE="/usr/share/os2borgerpc/bin/user-cleanup.bash"
LOGOUT_TIMER_SESSION_CLEANUP_FILE="/usr/share/os2borgerpc/bin/user-cleanup-logout-timer.bash"
OUR_USER="user"

# LOGOUT_TIMER_ACTUAL:
LOGOUT_TIMER_ACTUAL="/usr/share/os2borgerpc/bin/logout_timer_actual.sh"
LOGOUT_TIMER_ACTUAL_LAUNCHER="/usr/share/os2borgerpc/bin/logout_timer_actual_launcher.sh"
# They might have automatic login enabled or not. We add it to all lightdm programs just in case.
LIGHTDM_PAM="/etc/pam.d/lightdm"
LIGHTDM_GREETER_PAM="/etc/pam.d/lightdm-greeter"
LIGHTDM_AUTOLOGIN_PAM="/etc/pam.d/lightdm-autologin"
LIGHTDM_FILES="$LIGHTDM_PAM $LIGHTDM_GREETER_PAM $LIGHTDM_AUTOLOGIN_PAM"
GRACE_PERIOD_MULTIPLIER="1.07" # The root timer has this added to it, to be more certain that it doesn't run out before the gnome extension. Effectively this means thta if the logout timer is set to 60 minutes, the root timer will ensure the user is logged out after around 64 minutes

# EXTENSION ADDITIONAL SETTINGS:
REPO_NAME="os2borgerpc-gnome-extensions"
EXTENSION_GIT_URL=https://github.com/OS2borgerPC/$REPO_NAME/archive/refs/heads/main.zip

# TODO: Consider not handling this here, and instead running install.sh with False to remove an extension. But then the repo
# either needs to remain on disk or be downloaded anew just to delete an extension...?
# It seems better to handle it there once for all extensions, instead of re-implementing installation/removal in every
# single extensi1n script
EXTENSION_ACTIVATION_DESKTOP_FILE="/home/$SHADOW/.config/autostart/logout-timer-user.desktop"

# CLEANUP AFTER PREVIOUS RUNS OF THIS SCRIPT
rm --force /usr/share/os2borgerpc/logout_timer.conf /usr/share/os2borgerpc/bin/logout_timer_visual.sh /home/$SHADOW/.config/autostart/logout-timer_user.desktop
# - This next line is handled in LOGOUT_TIMER_SESSION_CLEANUP_FILE instead
sed --in-place "/pkill -f $(basename $LOGOUT_TIMER_ACTUAL)/d" $SESSION_CLEANUP_FILE
sed --in-place "/pkill -f logout_timer_visual.sh/d" $SESSION_CLEANUP_FILE

[ $# -lt 2 ] && printf "%s\n" "This script takes at least 2 arguments. Exiting." && exit 1

if [ "$ACTIVATE" = 'True' ]; then
	# TODO: Do we need to install bc or is come preinstalled?
	apt-get install --assume-yes jq

	# Fetch and install gnome extension
	BRANCH=main
	wget $EXTENSION_GIT_URL
	unzip $BRANCH.zip
	$REPO_NAME-$BRANCH/install.sh whatever $EXTENSION_NAME true true true
	rm -r $BRANCH.zip $REPO_NAME-$BRANCH

	# Now overwrite the testing config with what the user inputted/defaults in this script
	cat <<- EOF > $LOGOUT_TIMER_CONF
	{
	  "timeMinutes": $MINUTES_TO_LOGOUT,
	  "preTimerText": "$PRE_TIMER_TEXT",
	  "headsUpSecondsLeft": $HEADS_UP_SECONDS_LEFT,
	  "headsUpMessage": "$HEADS_UP_MESSAGE"
	}
	EOF

	# A backup timer used to logout if the user-run gnome extension is disabled/killed, running as root
	cat <<- EOF > $LOGOUT_TIMER_ACTUAL
		#! /usr/bin/env sh

		TIME_MINUTES=\$(jq < $LOGOUT_TIMER_CONF '.timeMinutes')

		# Adding a little to this so they're warned a bit before they're actually logged out
		# This is even more important since currently the timers might get out of sync
		COUNT=\$(bc <<< "\$TIME_MINUTES * 60 * $GRACE_PERIOD_MULTIPLIER")

		until [ "\$COUNT" -eq "0" ]; do                                # Countdown loop.
		    COUNT=\$((COUNT-1))                                        # Decrement seconds.
		    sleep 1
		done

		runuser --login user --command "XDG_RUNTIME_DIR=/run/user/$(id -u user) gnome-session-quit --logout --no-prompt"
		# Alternate, less graceful approaches:
		# 1. PID=who -u && kill  OR killall lightdm OR killall gnome-session
	EOF

	# Simply a small script that launches the timer in the background and immediately exits
	# so the PAM stack continues instead of it waiting for the timer to run out
	# Using bash as disown is undefined in sh
	cat <<- EOF > $LOGOUT_TIMER_ACTUAL_LAUNCHER
		#! /usr/bin/env bash

		$LOGOUT_TIMER_ACTUAL &
		disown
	EOF

	# Make PAM run LOGOUT_TIMER_ACTUAL_LAUNCHER for user, so it's run as root
	# Idempotency: Don't add it multiple times if this script is run more than once
  if ! grep -q "# OS2borgerPC Timer" $LIGHTDM_GREETER_PAM; then
  	for f in $LIGHTDM_FILES; do
  		sed --in-place "/@include common-session/i# OS2borgerPC Timer\nsession [success=1 default=ignore] pam_succeed_if.so user != user\nsession optional pam_exec.so $LOGOUT_TIMER_ACTUAL_LAUNCHER" "$f"
  	done
  fi

	# Modify the cleanup run at logout to also kill remaining timers so they don't persist, affecting
	# the next login
		# Create a new script to handle cleanup after the logout timer
	cat <<- EOF > $LOGOUT_TIMER_SESSION_CLEANUP_FILE
		#! /usr/bin/env sh

		pkill -f "$(basename $LOGOUT_TIMER_ACTUAL)"
		runuser --login $OUR_USER --command "XDG_RUNTIME_DIR=/run/user/$(id -u $OUR_USER) gnome-extensions disable $EXTENSION_NAME"
	EOF

	# Finally append this new cleaner script to the end of user-cleanup
	if ! grep -q "$LOGOUT_TIMER_SESSION_CLEANUP_FILE" $SESSION_CLEANUP_FILE; then
		echo "$LOGOUT_TIMER_SESSION_CLEANUP_FILE" >> $SESSION_CLEANUP_FILE
	fi

	chmod u+x $LOGOUT_TIMER_ACTUAL $LOGOUT_TIMER_ACTUAL_LAUNCHER $LOGOUT_TIMER_SESSION_CLEANUP_FILE

else # Stop the timers and delete everything related to them
	pkill -f "$(basename $LOGOUT_TIMER_ACTUAL)"
	gnome-extensions disable $EXTENSION_NAME  # Note: Don't do this if we make "disable" run "gnome-session-quit --logout" as well!

	sed --in-place "\@$LOGOUT_TIMER_SESSION_CLEANUP_FILE@d" $SESSION_CLEANUP_FILE
	rm -r $LOGOUT_TIMER_ACTUAL $LOGOUT_TIMER_ACTUAL_LAUNCHER $EXTENSION_ACTIVATION_DESKTOP_FILE "$(dirname $LOGOUT_TIMER_CONF)" $LOGOUT_TIMER_SESSION_CLEANUP_FILE

	#	Alternate solution: Kill all processes started by user in user-cleanup.sh? Maybe that's a better idea anyway,
	#	which we should do for everyone in the future?

	for f in $LIGHTDM_FILES; do
		sed --in-place "/# OS2borgerPC Timer/d" "$f"
		sed --in-place "/session \[success=1 default=ignore\] pam_succeed_if.so user != user/d" "$f"
		sed --in-place "\@session optional pam_exec.so $LOGOUT_TIMER_ACTUAL_LAUNCHER@d" "$f"
	done
fi

Beskrivelse

Opsætter en OS2borgerPC til altid at logge ud efter et bestemt antal minutter, med en visuel nedtæller på skærmen, til at vise, hvor længe, der er tilbage før logud.

Parametre

1. (Påkrævet) Aktivér?: Sæt hak for at aktivere scriptet, lad stå tom for at deaktivere scriptet.

2. (Påkrævet) Antal MINUTTER før der logges ud.

3. (Valgfri) Tekst der vises før nuværende tidspunkt i nedtællingen. Standardværdi: “Tid tilbage: “

4. (Valgfri) Hvor mange SEKUNDER inden logud skal de advares om kommende logud. Standardværdi: 60

5. (Valgfri) Tekst der vises i beskeden om at brugeren snart logges ud. Standardværdi: “Tiden er udløbet om et minut. Husk at gemme dine ting.”