Make changing lock screen background an option

jlu5 · jlu5 · commit 1b8e47851b8c · 2026-01-02T15:07:58.000-08:00
This adds a new option under the Customize tab, as well as a new set_lock_screen script that only runs when the change lock screen option is enabled. Fixes varietywalls#309. Fixes varietywalls#764.
diff --git a/variety/Options.py b/variety/Options.py
@@ -107,6 +107,11 @@ def read(self):
             except Exception:
                 pass
 
+            try:
+                self.change_lock_screen = config["change_lock_screen"].lower() in TRUTH_VALUES
+            except Exception:
+                pass
+
             try:
                 self.set_wallpaper_script = os.path.expanduser(config["set_wallpaper_script"])
             except Exception:
@@ -117,6 +122,11 @@ def read(self):
             except Exception:
                 pass
 
+            try:
+                self.set_lock_screen_script = os.path.expanduser(config["set_lock_screen_script"])
+            except Exception:
+                pass
+
             try:
                 self.download_folder = os.path.expanduser(config["download_folder"])
             except Exception:
@@ -632,9 +642,11 @@ def set_defaults(self):
         self.change_interval = 300
         self.internet_enabled = True
         self.safe_mode = False
+        self.change_lock_screen = False
 
         self.set_wallpaper_script = os.path.join(get_profile_path(), "scripts", "set_wallpaper")
         self.get_wallpaper_script = os.path.join(get_profile_path(), "scripts", "get_wallpaper")
+        self.set_lock_screen_script = os.path.join(get_profile_path(), "scripts", "set_lock_screen")
 
         self.download_folder = os.path.join(get_profile_path(), "Downloaded")
         self.download_preference_ratio = 0.9
@@ -748,6 +760,7 @@ def write(self):
             config["change_interval"] = str(self.change_interval)
             config["internet_enabled"] = str(self.internet_enabled)
             config["safe_mode"] = str(self.safe_mode)
+            config["change_lock_screen"] = str(self.change_lock_screen)
 
             config["set_wallpaper_script"] = Util.collapseuser(self.set_wallpaper_script)
             config["get_wallpaper_script"] = Util.collapseuser(self.get_wallpaper_script)
diff --git a/variety/PreferencesVarietyDialog.py b/variety/PreferencesVarietyDialog.py
@@ -180,6 +180,7 @@ def reload(self):
 
             self.favorites_operations = self.options.favorites_operations
 
+            self.ui.change_lock_screen_box.set_active(self.options.change_lock_screen)
             self.ui.copyto_enabled.set_active(self.options.copyto_enabled)
             self.copyto_chooser.set_folder(self.parent.get_actual_copyto_folder())
 
@@ -1020,6 +1021,7 @@ def apply(self):
                 pass
 
             self.options.copyto_enabled = self.ui.copyto_enabled.get_active()
+            self.options.change_lock_screen = self.ui.change_lock_screen_box.get_active()
             copyto = os.path.normpath(self.copyto_chooser.get_folder())
             if copyto == os.path.normpath(self.parent.get_actual_copyto_folder("Default")):
                 self.options.copyto_folder = "Default"
diff --git a/variety/VarietyWindow.py b/variety/VarietyWindow.py
@@ -243,6 +243,19 @@ def on_mnu_preferences_activate(self, widget=None, data=None):
 
         self.preferences_dialog.present()
 
+    def _maybe_copy_script(self, script):
+        """Copy a script, if missing, to the Variety profile path."""
+        if not os.path.exists(os.path.join(self.scripts_folder, script)):
+            logger.info(
+                lambda: "Missing %s file, copying it from %s"
+                % (script, varietyconfig.get_data_file("scripts", script))
+            )
+            Util.copy_with_replace(
+                varietyconfig.get_data_file("scripts", script),
+                os.path.join(self.scripts_folder, script),
+                {DEFAULT_PROFILE_PATH.replace("~", "$HOME"): get_profile_path(expanded=True)},
+            )
+
     def prepare_config_folder(self):
         self.config_folder = get_profile_path()
         Util.makedirs(self.config_folder)
@@ -277,27 +290,9 @@ def prepare_config_folder(self):
         self.scripts_folder = os.path.join(self.config_folder, "scripts")
         Util.makedirs(self.scripts_folder)
 
-        if not os.path.exists(os.path.join(self.scripts_folder, "set_wallpaper")):
-            logger.info(
-                lambda: "Missing set_wallpaper file, copying it from "
-                + varietyconfig.get_data_file("scripts", "set_wallpaper")
-            )
-            Util.copy_with_replace(
-                varietyconfig.get_data_file("scripts", "set_wallpaper"),
-                os.path.join(self.scripts_folder, "set_wallpaper"),
-                {DEFAULT_PROFILE_PATH.replace("~", "$HOME"): get_profile_path(expanded=True)},
-            )
-
-        if not os.path.exists(os.path.join(self.scripts_folder, "get_wallpaper")):
-            logger.info(
-                lambda: "Missing get_wallpaper file, copying it from "
-                + varietyconfig.get_data_file("scripts", "get_wallpaper")
-            )
-            Util.copy_with_replace(
-                varietyconfig.get_data_file("scripts", "get_wallpaper"),
-                os.path.join(self.scripts_folder, "get_wallpaper"),
-                {DEFAULT_PROFILE_PATH.replace("~", "$HOME"): get_profile_path(expanded=True)},
-            )
+        self._maybe_copy_script("set_wallpaper")
+        self._maybe_copy_script("get_wallpaper")
+        self._maybe_copy_script("set_lock_screen")
 
         # make all scripts executable:
         for f in os.listdir(self.scripts_folder):
@@ -1559,6 +1554,8 @@ def _update_inidicator():
                 Util.add_mainloop_task(_update_inidicator)
 
                 self.set_desktop_wallpaper(to_set, filename, refresh_level, display_mode_param)
+                if self.options.change_lock_screen:
+                    self.set_desktop_wallpaper(to_set, filename, refresh_level, display_mode_param, lock_screen=True)
                 self.current = filename
 
                 if self.options.icon == "Current" and self.current:
@@ -2753,8 +2750,8 @@ def cleanup_old_wallpapers(self, folder, prefix, new_wallpaper=None):
         except Exception:
             logger.exception(lambda: "Cannot remove all old wallpaper files from %s:" % folder)
 
-    def set_desktop_wallpaper(self, wallpaper, original_file, refresh_level, display_mode):
-        script = self.options.set_wallpaper_script
+    def set_desktop_wallpaper(self, wallpaper, original_file, refresh_level, display_mode, lock_screen=False):
+        script = self.options.set_lock_screen_script if lock_screen else self.options.set_wallpaper_script
         if os.access(script, os.X_OK):
             auto = (
                 "manual"
diff --git a/variety/data/scripts/set_lock_screen b/variety/data/scripts/set_lock_screen
@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+#
+# This script is run by Variety to change lock screen backgrounds, when that option is enabled.
+# The parameters are the same as set_wallpaper.
+WP=$1
+
+detect_desktop() {
+    if [ -n "$XDG_CURRENT_DESKTOP" ]; then
+        case "${XDG_CURRENT_DESKTOP,,}" in
+        *"gnome"*) echo "gnome" ;;
+        *"unity"*) echo "unity" ;;
+        *"budgie"*) echo "budgie" ;;
+        *"kde"*) echo "kde" ;;
+        esac
+        return
+    fi
+    echo "unknown"
+}
+
+DE=$(detect_desktop)
+
+if [ "$DE" == "kde" ]; then
+    kwriteconfig6 --file kscreenlockerrc --group Greeter --group Wallpaper --group org.kde.image --group General --key Image "$WP"
+
+elif [ "$DE" == "gnome" ] || [ "$DE" == "unity" ] || [ "$DE" == "budgie" ]; then
+    # GNOME Screensaver / Lock screen - thanks to George C. de Araujo for the patch
+    gsettings set org.gnome.desktop.screensaver picture-uri "file://$WP" 2>/dev/null
+    if [[ "$4" =~ ^(wallpaper|centered|scaled|stretched|zoom|spanned)$ ]]; then
+        gsettings set org.gnome.desktop.screensaver picture-options "$4"
+    fi
+    if [ "$(gsettings get org.gnome.desktop.screensaver picture-options)" == "'none'" ]; then
+        gsettings set org.gnome.desktop.screensaver picture-options 'zoom'
+    fi
+else
+    echo "Unsupported desktop for automatic lock screen changing"
+    exit 1
+fi
+
+exit 0
diff --git a/variety/data/scripts/set_wallpaper b/variety/data/scripts/set_wallpaper
@@ -162,10 +162,6 @@ elif [ "$DE" == "kde" ]; then
     "
     dbus-send --type=method_call --dest=org.kde.plasmashell /PlasmaShell org.kde.PlasmaShell.evaluateScript string:"$plasma_qdbus_script"
     dbus_exitcode="$?"
-    if [[ "$dbus_exitcode" -eq 0 && "${KDE_SESSION_VERSION}" -eq '6' ]]; then
-        # Update KDE lock screen background
-        kwriteconfig6 --file kscreenlockerrc --group Greeter --group Wallpaper --group org.kde.image --group General --key Image "$WP"
-    fi
     if [[ "$dbus_exitcode" -ne 0 && "${KDE_SESSION_VERSION}" -eq '5' ]]; then
         kdialog --title "Variety: cannot change Plasma wallpaper" --passivepopup "Could not change the Plasma 5 wallpaper; \
             make sure that you're using Plasma 5.7+ and have widgets unlocked.\n----\n \
@@ -184,14 +180,6 @@ elif [ "$DE" == "gnome" ] || [ "$DE" == "unity" ] || [ "$DE" == "budgie" ]; then
     if [ "$(gsettings get org.gnome.desktop.background picture-options)" == "'none'" ]; then
         gsettings set org.gnome.desktop.background picture-options 'zoom'
     fi
-    # GNOME Screensaver / Lock screen - thanks to George C. de Araujo for the patch
-    gsettings set org.gnome.desktop.screensaver picture-uri "file://$WP" 2>/dev/null
-    if [[ "$4" =~ ^(wallpaper|centered|scaled|stretched|zoom|spanned)$ ]]; then
-        gsettings set org.gnome.desktop.screensaver picture-options "$4"
-    fi
-    if [ "$(gsettings get org.gnome.desktop.screensaver picture-options)" == "'none'" ]; then
-        gsettings set org.gnome.desktop.screensaver picture-options 'zoom'
-    fi
 
 elif [ "$DE" == "deepin" ]; then
     # Deepin
diff --git a/variety/data/ui/PreferencesVarietyDialog.ui b/variety/data/ui/PreferencesVarietyDialog.ui
@@ -3606,7 +3606,7 @@ To show the icon in the launcher choose About or Preferences. You may wish to lo
                   </packing>
                 </child>
                 <child>
-                  <object class="GtkBox" id="lightdm_box">
+                  <object class="GtkBox" id="login_screen_support_box">
                     <property name="visible">True</property>
                     <property name="can-focus">False</property>
                     <property name="valign">start</property>
@@ -3640,8 +3640,8 @@ To show the icon in the launcher choose About or Preferences. You may wish to lo
                         <property name="hexpand">True</property>
                         <property name="orientation">vertical</property>
                         <child>
-                          <object class="GtkCheckButton" id="copyto_enabled">
-                            <property name="label" translatable="yes">Copy wallpapers to a static location (for programs like LightDM that require a static path)</property>
+                          <object class="GtkCheckButton" id="change_lock_screen_box">
+                            <property name="label" translatable="yes">Change lock screen background automatically</property>
                             <property name="use-action-appearance">False</property>
                             <property name="visible">True</property>
                             <property name="can-focus">True</property>
@@ -3650,8 +3650,6 @@ To show the icon in the launcher choose About or Preferences. You may wish to lo
                             <property name="margin-top">7</property>
                             <property name="xalign">0</property>
                             <property name="draw-indicator">True</property>
-                            <signal name="toggled" handler="delayed_apply" swapped="no"/>
-                            <signal name="toggled" handler="on_copyto_enabled_toggled" swapped="no"/>
                           </object>
                           <packing>
                             <property name="expand">False</property>
@@ -3660,16 +3658,18 @@ To show the icon in the launcher choose About or Preferences. You may wish to lo
                           </packing>
                         </child>
                         <child>
-                          <object class="GtkLabel" id="label19">
+                          <object class="GtkCheckButton" id="copyto_enabled">
+                            <property name="label" translatable="yes">Copy wallpapers to a static location (for programs like LightDM that require a static path)</property>
+                            <property name="use-action-appearance">False</property>
                             <property name="visible">True</property>
-                            <property name="can-focus">False</property>
+                            <property name="can-focus">True</property>
+                            <property name="receives-default">False</property>
                             <property name="halign">start</property>
                             <property name="margin-top">7</property>
-                            <property name="label" translatable="yes">&lt;b&gt;Privacy warning:&lt;/b&gt; To show your wallpaper in a display manager, it may need read permissions to the image. With this option on, Variety will copy the wallpapers to a public folder and change their permissions to make them readable by all. By default, the folder is ~/Pictures if your home folder in not encrypted, and /usr/share/backgrounds if it is. Please use with care on multiuser systems.</property>
-                            <property name="use-markup">True</property>
-                            <property name="justify">fill</property>
-                            <property name="wrap">True</property>
-                            <property name="max-width-chars">130</property>
+                            <property name="xalign">0</property>
+                            <property name="draw-indicator">True</property>
+                            <signal name="toggled" handler="delayed_apply" swapped="no"/>
+                            <signal name="toggled" handler="on_copyto_enabled_toggled" swapped="no"/>
                           </object>
                           <packing>
                             <property name="expand">False</property>
@@ -3848,6 +3848,24 @@ To show the icon in the launcher choose About or Preferences. You may wish to lo
                             <property name="position">4</property>
                           </packing>
                         </child>
+                        <child>
+                          <object class="GtkLabel" id="label19">
+                            <property name="visible">True</property>
+                            <property name="can-focus">False</property>
+                            <property name="halign">start</property>
+                            <property name="margin-top">7</property>
+                            <property name="label" translatable="yes">&lt;b&gt;Privacy warning:&lt;/b&gt; To show your wallpaper in a display manager, it may need read permissions to the image. With this option on, Variety will copy the wallpapers to a public folder and change their permissions to make them readable by all. By default, the folder is ~/Pictures if your home folder in not encrypted, and /usr/share/backgrounds if it is. Please use with care on multiuser systems.</property>
+                            <property name="use-markup">True</property>
+                            <property name="justify">fill</property>
+                            <property name="wrap">True</property>
+                            <property name="max-width-chars">130</property>
+                          </object>
+                          <packing>
+                            <property name="expand">False</property>
+                            <property name="fill">True</property>
+                            <property name="position">5</property>
+                          </packing>
+                        </child>
                       </object>
                       <packing>
                         <property name="expand">False</property>
