add task to fill contents of custom idle logout hook script

Author: FreekBes

README.md

@@ -57,3 +57,4 @@ It is also possible to specify a default user image in case the user's `~/.face`
 | `dbus_cache_group_check_group`| The group to check for. | `student` |
 | `login_wallpaper_path` | The path to the login wallpaper to set. | `/usr/share/42/login-screen.jpg` |
 | `ddcci_backlight_support` | Whether to enable support for DDC/CI to allow controlling the brightness of external monitors. Should be set to `false` if you're using iMacs with T2 chips or any other *ddcci-dkms* unsupported kernel. | `true` |
+| `codam_web_greeter_idle_logout_hook_contents` | The contents of the custom hook script that is run after a user is logged out due to leaving a computer idle. Look at [defaults/main.yml](defaults/main.yml) for an example. | [View example](defaults/main.yml) |

defaults/main.yml

@@ -21,3 +21,21 @@ login_wallpaper_path: "/usr/share/42/login-screen.jpg"
 # Specify whether or not to add support for ddcci-backlight control on external monitors
 # Requires ddcci-dkms to be installed, which is not supported by iMacs with T2 chips
 ddcci_backlight_support: true
+
+# Custom contents for the idle logout hook script
+codam_web_greeter_idle_logout_hook_contents: |
+  #!/bin/bash
+  #
+  # This script is executed after a user has been logged out due to inactivity by the codam-web-greeter-idler.sh script.
+  # It receives the following arguments:
+  # $1: username of the user that was logged out
+  # $2: idle time in milliseconds
+  # $3: time since screen was locked in milliseconds
+  # $4: max idle time in milliseconds
+  #
+  # You can use this script to perform custom actions, such as logging, notifications, coalition system integration, etc.
+  # It can be easily customized using the Ansible codam.webgreeter role.
+  #
+  # Example: Log the logout event to a file
+  # LOGFILE="/var/log/codam-web-greeter-idle-logout.log"
+  # echo "$(date): User '$1' was logged out due to inactivity (idletime: $2 ms, time_since_lock: $3 ms, max_idle_time: $4 ms)" >> "$LOGFILE"

tasks/setup.yml

@@ -147,6 +147,16 @@
         exit 0
       fi
 
+- name: Customize post-idle-logout hook script
+  tags: [codam.webgreeter, codam.webgreeter.setup, hooks.d]
+  become: true
+  copy:
+    content: "{{ codam_web_greeter_idle_logout_hook_contents }}"
+    dest: /usr/share/codam/codam-web-greeter-idler-hook.sh
+    owner: root
+    group: root
+    mode: '0500' # Do not allow others to read this script, it may contain sensitive info
+
 - name: Allow rebooting from greeter
   tags: [codam.webgreeter, codam.webgreeter.setup]
   become: true