Merge branch 'feature/56040_rewrite_scripts_to_support_language_variability' into 'master'

Feature/56040 rewrite scripts to support language variability

See merge request os2borgerpc/os2borgerpc-scripts!213

Author: Andreas Poulsen

common/fejlfinding/os2borgerpc_general_debug.sh

@@ -15,6 +15,15 @@ text() {
   printf "\n%s\n" "### $MSG ###"
 }
 
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+
 header "General info:"
 
 text "Information about the computer model:"
@@ -39,10 +48,10 @@ text "Check permissions on files in /usr/share/os2borgerpc/bin/"
 ls -l /usr/share/os2borgerpc/bin/
 
 text "List programs/files on the desktop:"
-ls -l /home/user/Skrivebord/
+ls -l /home/user/"$DESKTOP"/
 
 text "Verify this matches what's in the user template (after logout):"
-ls -l /home/.skjult/Skrivebord/
+ls -l /home/.skjult/"$DESKTOP"/
 
 text "Check the contents of /home/.skjult/"
 ls -la /home/.skjult/
@@ -94,13 +103,13 @@ text "Check chrome policies"
 cat /etc/opt/chrome/policies/managed/os2borgerpc-defaults.json
 
 USER=".skjult"
-DESKTOP_FILE_1=/usr/share/applications/google-chrome.desktop
+DESKTOP_FILE_1="/usr/share/applications/google-chrome.desktop"
 # In case they've also added Chrome to their desktop
-DESKTOP_FILE_2=/home/$USER/Skrivebord/google-chrome.desktop
+DESKTOP_FILE_2="/home/$USER/$DESKTOP/google-chrome.desktop"
 # In case they've run chrome_autostart.sh.
 # The name is no mistake, that one is unfortunately not called google-chrome.desktop
-DESKTOP_FILE_3=/home/$USER/.config/autostart/chrome.desktop
-DESKTOP_FILE_4=/home/$USER/.local/share/applications/google-chrome.desktop
+DESKTOP_FILE_3="/home/$USER/.config/autostart/chrome.desktop"
+DESKTOP_FILE_4="/home/$USER/.local/share/applications/google-chrome.desktop"
 
 text "File at $DESKTOP_FILE_1:"
 cat "$DESKTOP_FILE_1"

common/system/upgrade_client_and_settings.sh

@@ -18,8 +18,11 @@ done
 # Set the correct, more restrictive permissions on all previous jobs
 chmod --recursive 700 /var/lib/os2borgerpc
 
+# Determine the name of the superuser desktop directory.
+DESKTOP=$(runuser -u superuser xdg-user-dir DESKTOP)
+
 # More restrictive permissions on /home/superuser
 chmod -R 700 /home/superuser
-chown -R superuser:superuser /home/superuser/Skrivebord
+chown -R superuser:superuser "$DESKTOP"
 
 pip3 install --upgrade os2borgerpc-client

os2borgerpc/chrome/chrome_install.sh

@@ -63,7 +63,15 @@ fi
 export DEBIAN_FRONTEND=noninteractive
 DESKTOP_FILE_PATH_1=/usr/share/applications/google-chrome.desktop
 # In case a Chrome shortcut has been added to the desktop
-DESKTOP_FILE_PATH_2=/home/$USER/Skrivebord/google-chrome.desktop
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+DESKTOP_FILE_PATH_2=/home/$USER/$DESKTOP/google-chrome.desktop
 # In case chrome_autostart.sh has been executed
 DESKTOP_FILE_PATH_3=/home/$USER/.config/autostart/chrome.desktop
 FILES="$DESKTOP_FILE_PATH_1 $DESKTOP_FILE_PATH_2 $DESKTOP_FILE_PATH_3"

os2borgerpc/chrome/chrome_start_maximized_fullscreen_kiosk.sh

@@ -29,7 +29,15 @@ SETTING="$1"
 USER=".skjult"
 DESKTOP_FILE_1=/usr/share/applications/google-chrome.desktop
 # In case they've also added Chrome to their desktop
-DESKTOP_FILE_2=/home/$USER/Skrivebord/google-chrome.desktop
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+DESKTOP_FILE_2=/home/$USER/$DESKTOP/google-chrome.desktop
 # TODO: Delete DESKTOP_FILE_3 later on as its now a symlink to DESKTOP_FILE_1 - as it should be
 # In case they've run chrome_autostart.sh.
 # The name is no mistake, that one is not called google-chrome.desktop

os2borgerpc/desktop/desktop_activate_shortcuts.sh

@@ -7,7 +7,7 @@ if get_os2borgerpc_config os2_product | grep --quiet kiosk; then
   exit 1
 fi
 
-USER=user
+USERNAME=user
 SHADOW=.skjult
 GIO_LAUNCHER=/usr/share/os2borgerpc/bin/gio-fix-desktop-file-permissions.sh
 GIO_SCRIPT=/usr/share/os2borgerpc/bin/gio-dbus.sh
@@ -25,7 +25,12 @@ cat << EOF > "$GIO_SCRIPT"
 export \$(dbus-launch)
 DBUS_PROCESS=\$\$
 
-for FILE in /home/$USER/Skrivebord/*.desktop; do
+# Determine the name of the user desktop directory. This can be done simply
+# because this file is run as user during the execution of GIO_LAUNCHER
+# which already makes sure that /home/user/.config/user-dirs.dirs exists
+DESKTOP=\$(xdg-user-dir DESKTOP)
+
+for FILE in \$DESKTOP/*.desktop; do
   gio set "\$FILE" metadata::trusted true
 done
 
@@ -37,16 +42,25 @@ EOF
 cat << EOF > "$GIO_LAUNCHER"
 #! /usr/bin/env sh
 
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export \$(grep LANG= /etc/default/locale)
+runuser -u user xdg-user-dirs-update
+DESKTOP=\$(runuser -u $USERNAME xdg-user-dir DESKTOP)
+
 # Gio expects the user to own the file so temporarily change that
-for FILE in /home/$USER/Skrivebord/*.desktop; do
-  chown $USER:$USER \$FILE
+for FILE in \$DESKTOP/*.desktop; do
+  chown $USERNAME:$USERNAME \$FILE
 done
 
 su --login user --command $GIO_SCRIPT
 
 # Now set the permissions back to their restricted form
-for FILE in /home/$USER/Skrivebord/*.desktop; do
-  chown root:$USER "\$FILE"
+for FILE in \$DESKTOP/*.desktop; do
+  chown root:$USERNAME "\$FILE"
   # In order for gio changes to take effect, it is necessary to update the file time stamp
   # This can be done with many commands such as chmod or simply touch
   # However, in some cases the files might not have execute permission so we add it with chmod
@@ -60,4 +74,6 @@ chmod +x "$GIO_SCRIPT"
 # Cleanup if there are previous entries of the gio fix script in the file
 sed --in-place "\@$GIO_LAUNCHER@d" $USER_CLEANUP
 
-printf "%s\n" "$GIO_LAUNCHER" >> $USER_CLEANUP
+# Make sure to insert this line before the desktop is made immutable
+# in case desktop_toggle_writable has already been run
+sed -i "/chown -R \$USERNAME:\$USERNAME \/home\/\$USERNAME/a $GIO_LAUNCHER" $USER_CLEANUP

os2borgerpc/desktop/desktop_logout_button_icon.sh

@@ -18,14 +18,23 @@ SHORTCUT_NAME="$2"
 PROMPT=$3
 ICON_UPLOAD="$4"
 
-OLD_DESKTOP_FILE=/home/.skjult/Skrivebord/Logout.desktop
-DESKTOP_FILE=/home/.skjult/Skrivebord/logout.desktop
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+
+OLD_DESKTOP_FILE=/home/.skjult/"$DESKTOP"/Logout.desktop
+DESKTOP_FILE=/home/.skjult/"$DESKTOP"/logout.desktop
 
 rm --force "$OLD_DESKTOP_FILE"
 
 if [ "$ACTIVATE" = 'True' ]; then
 
-  mkdir --parents "$(dirname $DESKTOP_FILE)"
+  mkdir --parents "$(dirname "$DESKTOP_FILE")"
 
   TO_PROMPT_OR_NOT=--no-prompt
 
@@ -56,7 +65,7 @@ if [ "$ACTIVATE" = 'True' ]; then
     fi
   fi
 
-cat <<- EOF > $DESKTOP_FILE
+cat <<- EOF > "$DESKTOP_FILE"
 	[Desktop Entry]
 	Version=1.0
 	Type=Application

os2borgerpc/desktop/desktop_print_program_list.sh

@@ -24,15 +24,23 @@ find_desktop_files_path() {
 
 LOCATION="$(lower "$1")"
 
-SHADOW_DESKTOP=/home/.skjult/Skrivebord
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+SHADOW_DESKTOP=/home/.skjult/$DESKTOP
 SNAP_DESKTOP_FILE_PATH="/var/lib/snapd/desktop/applications"
 APT_DESKTOP_FILE_PATH="/usr/share/applications"
 
 if [ "$LOCATION" = "menu" ]; then
   # Print only the last line only and format it a bit more nicely
   tail -n 1 /etc/dconf/db/os2borgerpc.d/02-launcher-favorites | sed "s/favorite-apps=\[\|'\|\]\ \|.desktop//g" | tr ',' '\n'
   exit
-elif [ "$LOCATION" = "skrivebord" ]; then
+elif [ "$LOCATION" = "skrivebord" ] || [ "$LOCATION" = "$DESKTOP" ]; then
   PTH="$SHADOW_DESKTOP/"
 else
   PTH=$APT_DESKTOP_FILE_PATH/

os2borgerpc/desktop/desktop_program_shortcut.sh

@@ -3,8 +3,8 @@
 # Adds/Removes programs from the desktop in Ubuntu 20.04
 # Author: mfm@magenta.dk
 #
-# Note that this script currently assumes danish locale, where the 'Desktop' directory
-# is instead named 'Skrivebord'.
+# This script has been updated to automatically detect the name of
+# the 'Desktop' directory in the chosen locale.
 #
 # Arguments:
 # 1: Use a boolean to decide whether to add or remove the program shortcut
@@ -21,13 +21,22 @@ if get_os2borgerpc_config os2_product | grep --quiet kiosk; then
   exit 1
 fi
 
-SHADOW_DESKTOP="/home/.skjult/Skrivebord"
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+
+SHADOW_DESKTOP="/home/.skjult/$DESKTOP"
 SNAP_DESKTOP_FILE_PATH="/var/lib/snapd/desktop/applications"
 APT_DESKTOP_FILE_PATH="/usr/share/applications"
 
 # TODO?: Make it replace all desktop icons which are copies with symlinks?
 
-mkdir --parents $SHADOW_DESKTOP
+mkdir --parents "$SHADOW_DESKTOP"
 
 if [ "$ADD" = 'True' ]; then
   if [ -f "$SNAP_DESKTOP_FILE_PATH/${PROGRAM}_$PROGRAM.desktop" ]; then
@@ -39,7 +48,7 @@ if [ "$ADD" = 'True' ]; then
   # Remove it first as it may be a copy and not symlink (ln --force can't overwrite regular files)
   rm --force "$SHADOW_DESKTOP/$PROGRAM.desktop"
 
-  ln --symbolic --force "$DESKTOP_FILE" $SHADOW_DESKTOP/
+  ln --symbolic --force "$DESKTOP_FILE" "$SHADOW_DESKTOP"/
 else
   if [ -f "$SHADOW_DESKTOP/${PROGRAM}_$PROGRAM.desktop" ]; then
     PROGRAM=${PROGRAM}_$PROGRAM

os2borgerpc/desktop/desktop_shortcut_to_directory.sh

@@ -18,9 +18,18 @@ ADD="$1"
 DIRECTORY="$2"
 SHORTCUT_NAME="$3"
 
-SHADOW_DESKTOP="/home/.skjult/Skrivebord"
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
 
-mkdir --parents $SHADOW_DESKTOP
+SHADOW_DESKTOP="/home/.skjult/$DESKTOP"
+
+mkdir --parents "$SHADOW_DESKTOP"
 
 if [ "$ADD" = "True" ]; then
   # Note: "ln" doesn't care if the destination ($DIRECTORY) exists

os2borgerpc/desktop/desktop_url_shortcut.sh

@@ -25,8 +25,17 @@ URL=$2
 SHORTCUT_NAME="$3"
 ICON_UPLOAD="$4"
 
+# Determine the name of the user desktop directory. This is done via xdg-user-dir,
+# which checks the /home/user/.config/user-dirs.dirs file. To ensure this file exists,
+# we run xdg-user-dirs-update, which generates it based on the environment variable
+# LANG. This variable is empty in lightdm so we first export it
+# based on the value stored in /etc/default/locale
+export "$(grep LANG= /etc/default/locale)"
+runuser -u user xdg-user-dirs-update
+DESKTOP=$(basename "$(runuser -u user xdg-user-dir DESKTOP)")
+
 SHADOW=".skjult"
-DESKTOP_FILE="/home/$SHADOW/Skrivebord/$SHORTCUT_NAME.desktop"
+DESKTOP_FILE="/home/$SHADOW/$DESKTOP/$SHORTCUT_NAME.desktop"
 
 if [ "$ACTIVATE" = 'True' ]; then
 
@@ -53,7 +62,7 @@ if [ "$ACTIVATE" = 'True' ]; then
     fi
   fi
 
-  mkdir --parents /home/$SHADOW/Skrivebord
+  mkdir --parents /home/$SHADOW/"$DESKTOP"
 
 	#	Originally used: Type=Link and URL=$URL and no Exec line, but seemingly that doesn't work in 20.04
 	cat <<- EOF > "$DESKTOP_FILE"