Adding support for Login screen wallpaper

This reverts commit 1ad5a9fe8b.

.gitignore

@@ -1,6 +1,9 @@
 *.glade~
 *.glade#
-extracted/
-custom_images/
 *.txt
+*.json
+extracted_images/
 selected/
+__pycache__
+time_bar.svg
+time_bar_polylines.svg

CHANGELOG

@@ -1,3 +1,49 @@
+# Version 2.3
+- Adding Dutch translation
+- Adding German translation
+- Adding Spanish translation (Thanks to rcalixte)
+
+# Version 2.2
+- Bugfixes
+- Migrate code to MVVM pattern
+- Adding option to change the location provider
+- Adding example image for dynamic background color
+
+# Version 2.1
+- Bugfixes
+- Smaller UI for displays with reduced resolution (< 1000px height)
+
+# Version 2.0
+- New App icon
+- Preferences window redesign - All settings are now in one window accessable!
+- Graphic visualizing of the time periods of a day with a bar chart
+- Adding custom time periods by user choice
+- Adding folder as image source
+- Option to display image on lock screens
+- Bugfixes
+- Remove support for Cinnamon 5.2 and older
+- Apply and OK button to test settings without closing the window
+
+# Version 1.4
+- Log System
+- Bugfixes
+- Display times in Image Configurator
+- Display time of last location update in Preferences
+
+# Version 1.3
+- Adding option to stretch the image over multiple displays
+
+# Version 1.2
+- Compatibility with Cinnamon 4.8 and higher
+- Notification on first start
+- Bugfix: No more restart needed after first enable
+- Load at first start a predefined dynamic wallpaper
+- More informations in the settings
+
+# Version 1.1
+- Compatibility with Cinnamon 5.4 and 5.8
+- Two new image sets
+
 # Version 1.0
 - Offline sun time calculation
 - Online location estimation or manual input

README.md

@@ -0,0 +1,88 @@
+# Cinnamon Dynamic Wallpaper
+<img src="cinnamon-dynamic-wallpaper@TobiZog/5.4/res/icons/icon.svg" alt="drawing" width="200" style="margin-left:auto; margin-right:auto; width:50%; display:block"/>
+
+![](res/wallpaper_merged.jpg)
+
+## About the project
+This extension switches the background image of your Cinnamon desktop multiple times in a day, based on a location or custom time periods. You can choose between included image-sets, your own HEIC-file or a source folder with single images. Configuration through a user-friendly configuration window.
+
+### Features
+- 9 included image sets
+- 10 day periods
+- HEIF converter
+- Image configuration assistent with simple one-click setup for image choices
+- Online location estimation (three provider) or offline with manual latitude and longitude input
+- Time periods individual configured by user
+- Offline sun angles estimation
+- Image stretching over multiple displays or repeat image for every display
+- Creating a color gradient based on the current wallpaper for images which not fill the whole screen
+
+### Tested Cinnamon versions
+- 5.4 (Mint 21)
+- 5.6 (Mint 21.1)
+- 5.8 (Mint 21.2)
+- 6.0 (Mint 21.3)
+
+### Technology
+- `JavaScript`
+	- Display desktop notifications
+	- Calling the Python loop script every 60 seconds to refresh the background image
+- `Python`
+	- Handles the preference window
+	- Esimates the location
+	- Changes of the desktop wallpapers
+- `Glade`
+	- Preference window UI design
+---
+## Installation
+### From Built-in Extension Manager
+![](res/download-manager.png)
+
+1. Open "Extensions" in Linux Mint or any other distribution with Cinnamon as Desktop Environment
+2. Click on "Download"
+3. Search and download it
+
+### From the repo
+1. Download the latest from the Releases page on GitHub: https://github.com/TobiZog/cinnamon-dynamic-wallpaper/releases
+2. Extract the files
+3. Copy the folder `cinnamon-dynamic-wallpaper@TobiZog` to `~/.local/share/cinnamon/extensions/`
+---
+## Usage
+1. Active the Extension via Cinnamon Extension Manager
+2. Open the settings
+3. Configure it to your 
+	- You can apply the setted settings without closing the window if you click on "Apply"
+4. If your config is complete, click on "OK"
+---
+## Preferences Window
+Because of the lack of configuration options in the standard Cinnamon configuration system for extensions offers this extension a custom preference window.  
+All configuration will be handled there. You can choose between included image sets, a HEIC file or a folder source and set the image to ten different daytime periods. Time periods will be estimated via network, custom coordinations or custom time periods. Some behaviour preferences (strech image, fill empty background with gradient color) are also here.
+
+![](res/image_configurator.png)
+---
+## Contribute
+### Translation
+You want to contribute a language which isn't supported yet? Here is how to do:
+
+1. Fork the cinnamon-spices-extensions project: https://github.com/linuxmint/cinnamon-spices-extensions
+2. Pull the repository
+3. Open `cinnamon-dynamic-wallpaper@TobiZog/files/cinnamon-dynamic-wallpaper@TobiZog/po/cinnamon-dynamic-wallpaper@TobiZog.pot` with a po-tool like poedit (https://poedit.net/).
+4. Create a new translation in your language
+5. Push the changes to your repository
+6. Create a pull request
+
+---
+## Included image sets
+The image sets are from https://github.com/adi1090x/dynamic-wallpaper
+
+| Aurora | Beach | Bitday |
+| ------ | ----- | ------ |
+| ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/aurora/5.jpg) | ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/beach/4.jpg) | ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/bitday/4.jpg) |
+
+| Cliffs | Earth | Gradient | 
+| -------- | --------- | ------ |
+| ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/cliffs/4.jpg) | ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/earth/4.jpg) | ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/gradient/4.jpg) | 
+
+| Lakeside | Mountains | Sahara |
+| --------- | ------ | ------ |
+| ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/lakeside/4.jpg) | ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/mountains/4.jpg) | ![](cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/sahara/4.jpg) |

cinnamon-dynamic-wallpaper@TobiZog/5.4/extension.js

@@ -0,0 +1,187 @@
+/**
+ * @name  Cinnamon-Dynamic-Wallpaper
+ * @alias TobiZog
+ * @since 2023-05-17
+ * 
+ * @description Main application file
+ */
+
+/******************** Imports ********************/
+
+const Util = imports.misc.util;
+const Settings = imports.ui.settings;
+const Mainloop = imports.mainloop;
+const Lang = imports.lang;
+const { find_program_in_path } = imports.gi.GLib;
+const Gio = imports.gi.Gio;
+const MessageTray = imports.ui.messageTray;
+const St = imports.gi.St;
+const Main = imports.ui.main;
+const Gettext = imports.gettext;
+const GLib = imports.gi.GLib;
+
+
+/******************** Constants ********************/
+
+const UUID = "cinnamon-dynamic-wallpaper@TobiZog";
+const APPNAME = "Cinnamon Dynamic Wallpaper"
+const DIRECTORY = imports.ui.extensionSystem.extensionMeta[UUID];
+const PATH = DIRECTORY.path;
+
+
+/******************** Global Variables ********************/
+
+// The extension object
+let extension;
+
+// Loop state
+let looping = true
+
+
+/******************** Objects ********************/
+
+function CinnamonDynamicWallpaperExtension(uuid) {
+	this._init(uuid);
+}
+
+
+function _(str) {
+	let customTranslation = Gettext.dgettext(UUID, str);
+	if (customTranslation !== str) {
+		return customTranslation;
+	}
+	return Gettext.gettext(str);
+}
+
+
+CinnamonDynamicWallpaperExtension.prototype = {
+
+	/******************** Lifecycle ********************/
+
+	/**
+	 * Initialization
+	 * 
+	 * @param {string} uuid 	Universally Unique Identifier
+	 */
+	_init: function(uuid) { 
+		this.settings = new Settings.ExtensionSettings(this, uuid);
+
+		Gettext.bindtextdomain(UUID, GLib.get_home_dir() + '/.local/share/locale');
+
+		// Check for the first startup
+		if (this.settings.getValue("first_start")) {
+
+			// Welcome notification
+			this.showNotification(_("Welcome to Cinnamon Dynamic Wallpaper"), 
+				_("Check the preferences to choose a dynamic wallpaper"), true)
+
+			// Hide the notification on system restart
+			this.settings.setValue("first_start", false)
+			this.settings.setValue("source_folder", DIRECTORY["path"] + "/res/images/included_image_sets/lakeside/")
+		}
+
+		// Start the main loop, checks in fixed time periods the 
+		this._loop()
+	},
+
+
+	/**
+	 * Binding the settings objects
+	 * 
+	 * @param {string} ui_name 	Name of preference in settings-schema.json
+	 * @param {string} js_name 	Name of preference in JavaScript
+	 * @param {Function} func 	Function to call on change
+	 */
+	bindSettings: function (ui_name, js_name, func = this.on_settings_changed) {
+		this.settings.bindProperty(
+			Settings.BindingDirection.IN,
+			ui_name,
+			js_name,
+			func
+		)
+	},
+
+
+	/**
+	 * Main loop
+	 */
+	_loop: function () {
+		if (looping) {
+			try {
+				Util.spawnCommandLine("/usr/bin/env python3 " + DIRECTORY.path + "/src/main.py loop")
+			} catch(e) {
+				this.showNotification(_("Error!"), 
+					_("Cinnamon Dynamic Wallpaper got an error while running the loop script. Please create an issue on GitHub."))
+			}
+
+			// Refresh every 60 seconds
+			Mainloop.timeout_add_seconds(60, Lang.bind(this, this._loop));
+		}
+	},
+
+
+	showNotification(title, text, showOpenSettings = false) {
+		let source = new MessageTray.Source(this.uuid);
+
+		// Parameter
+		let params = {
+			icon: new St.Icon({
+				icon_name: "icon",
+				icon_type: St.IconType.FULLCOLOR,
+				icon_size: source.ICON_SIZE
+			})
+		};
+		// The notification itself
+		let notification = new MessageTray.Notification(source, title, text, params);
+
+		// Display the "Open settings" button, if showOpenSettings
+		if (showOpenSettings) {
+			notification.addButton("open-settings", _("Open settings"));
+
+			notification.connect("action-invoked", () =>
+				Util.spawnCommandLine("/usr/bin/env python3 " + DIRECTORY.path + "/src/main.py"));
+		}
+
+		// Put all together
+		Main.messageTray.add(source);
+
+		// Display it
+		source.notify(notification);
+	}
+}
+
+
+
+/******************** Lifecycle ********************/
+
+/**
+ * Lifecycle function on initialization
+ * 
+ * @param {*} extensionMeta 	Metadata of the extension
+ */
+function init(extensionMeta) {
+	extension = new CinnamonDynamicWallpaperExtension(extensionMeta.uuid);
+}
+
+
+/**
+ * Lifecycle function on enable
+ * 
+ * @returns The extension object
+ */
+function enable() {
+	// Check for necessary software
+	if (!find_program_in_path('heif-convert')) {
+		Util.spawnCommandLine("apturl apt://libheif-examples");
+	}
+
+	return extension;
+}
+
+
+/**
+ * Lifecycle function on disable
+ */
+function disable() {
+	looping = false
+}

cinnamon-dynamic-wallpaper@TobiZog/5.4/icon.svg

@@ -0,0 +1 @@
+res/icons/icon.svg

cinnamon-dynamic-wallpaper@TobiZog/5.4/res/icons/icon.svg

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg height="128px" viewBox="0 0 128 128" width="128px" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <linearGradient id="a" gradientTransform="matrix(0.232143 0 0 0.328947 -9.109985 263.79837)" gradientUnits="userSpaceOnUse" x1="88.595886" x2="536.595886" y1="-449.394012" y2="-449.394012">
+        <stop offset="0" stop-color="#77767b"/>
+        <stop offset="0.0384615" stop-color="#c0bfbc"/>
+        <stop offset="0.0768555" stop-color="#9a9996"/>
+        <stop offset="0.923077" stop-color="#9a9996"/>
+        <stop offset="0.961538" stop-color="#c0bfbc"/>
+        <stop offset="1" stop-color="#77767b"/>
+    </linearGradient>
+    <linearGradient id="b" gradientTransform="matrix(0.978582 0 0 0.937323 -9.031522 -9.577706)" gradientUnits="userSpaceOnUse" x1="20.937046" x2="127.213333" y1="76.334984" y2="76.334984">
+        <stop offset="0" stop-color="#066996"/>
+        <stop offset="1" stop-color="#001533"/>
+    </linearGradient>
+    <path d="m 19.457031 15.972656 h 88 c 4.417969 0 8 3.582032 8 8 v 84 c 0 4.417969 -3.582031 8 -8 8 h -88 c -4.417969 0 -8 -3.582031 -8 -8 v -84 c 0 -4.417968 3.582031 -8 8 -8 z m 0 0" fill="url(#a)"/>
+    <path d="m 17.328125 11.972656 h 92.257813 c 3.242187 0 5.871093 2.519532 5.871093 5.625 v 88.75 c 0 3.105469 -2.628906 5.625 -5.871093 5.625 h -92.257813 c -3.242187 0 -5.871094 -2.519531 -5.871094 -5.625 v -88.75 c 0 -3.105468 2.628907 -5.625 5.871094 -5.625 z m 0 0" fill="url(#b)"/>
+    <path d="m 63.945312 74.6875 c 0 10.257812 -8.671874 18.574219 -19.367187 18.574219 s -19.367187 -8.316407 -19.367187 -18.574219 s 8.671874 -18.574219 19.367187 -18.574219 s 19.367187 8.316407 19.367187 18.574219 z m 0 0" fill="#f7c22c"/>
+    <path d="m 61.160156 74.136719 c 0 10.03125 -8.128906 18.164062 -18.160156 18.164062 c -10.027344 0 -18.160156 -8.132812 -18.160156 -18.164062 c 0 -10.027344 8.132812 -18.160157 18.160156 -18.160157 c 10.03125 0 18.160156 8.132813 18.160156 18.160157 z m 0 0" fill="#f7d97e"/>
+    <path d="m 85.46875 19.277344 c 7.65625 3.941406 12.472656 11.832031 12.472656 20.445312 c 0 12.695313 -10.292968 22.992188 -22.992187 22.992188 c -0.074219 -0.007813 -0.148438 -0.011719 -0.222657 -0.019532 c 3.253907 1.679688 6.863282 2.558594 10.527344 2.5625 c 12.695313 0 22.992188 -10.296874 22.992188 -22.992187 c -0.003906 -12.613281 -10.167969 -22.871094 -22.777344 -22.988281 z m 0 0" fill="#eaa22f"/>
+    <path d="m 82.804688 18.175781 c 7.660156 3.9375 12.472656 11.828125 12.476562 20.441407 c 0 12.699218 -10.296875 22.992187 -22.992188 22.992187 c -0.078124 -0.003906 -0.152343 -0.011719 -0.226562 -0.015625 c 3.253906 1.679688 6.863281 2.554688 10.527344 2.558594 c 12.699218 0 22.992187 -10.292969 22.992187 -22.992188 c -0.003906 -12.613281 -10.164062 -22.867187 -22.777343 -22.984375 z m 0 0" fill="#ffc61b"/>
+    <g fill="#f7d97e">
+        <path d="m 44.394531 45.09375 c 0.527344 0 0.953125 0.445312 0.953125 1 v 7.558594 c 0 0.554687 -0.425781 1 -0.953125 1 c -0.527343 0 -0.957031 -0.445313 -0.957031 -1 v -7.558594 c 0 -0.554688 0.429688 -1 0.957031 -1 z m 0 0"/>
+        <path d="m 44.222656 94.574219 c 0.527344 0 0.953125 0.449219 0.953125 1 v 7.5625 c 0 0.554687 -0.425781 1 -0.953125 1 s -0.957031 -0.445313 -0.957031 -1 v -7.5625 c 0 -0.550781 0.429687 -1 0.957031 -1 z m 0 0"/>
+        <path d="m 65.402344 74.839844 c 0 -0.527344 0.449218 -0.953125 1 -0.953125 h 7.5625 c 0.550781 0 1 0.425781 1 0.953125 s -0.449219 0.957031 -1 0.957031 h -7.5625 c -0.550782 0 -1 -0.429687 -1 -0.957031 z m 0 0"/>
+        <path d="m 13.84375 74.300781 c 0 -0.527343 0.445312 -0.957031 1 -0.957031 h 7.558594 c 0.554687 0 1 0.429688 1 0.957031 c 0 0.527344 -0.445313 0.953125 -1 0.953125 h -7.558594 c -0.554688 0 -1 -0.425781 -1 -0.953125 z m 0 0"/>
+        <path d="m 22.230469 53.699219 c 0.371093 -0.375 0.988281 -0.359375 1.378906 0.03125 l 5.347656 5.347656 c 0.390625 0.390625 0.40625 1.007813 0.03125 1.382813 c -0.371093 0.371093 -0.992187 0.355468 -1.382812 -0.035157 l -5.34375 -5.34375 c -0.390625 -0.390625 -0.40625 -1.011719 -0.03125 -1.382812 z m 0 0"/>
+        <path d="m 59.175781 88.910156 c 0.371094 -0.375 0.992188 -0.359375 1.382813 0.03125 l 5.347656 5.347656 c 0.390625 0.390626 0.402344 1.007813 0.03125 1.382813 c -0.375 0.371094 -0.992188 0.355469 -1.382812 -0.035156 l -5.347657 -5.34375 c -0.390625 -0.390625 -0.40625 -1.011719 -0.03125 -1.382813 z m 0 0"/>
+        <path d="m 59.378906 60.664062 c -0.371094 -0.371093 -0.359375 -0.992187 0.03125 -1.382812 l 5.347656 -5.34375 c 0.390626 -0.390625 1.007813 -0.40625 1.382813 -0.035156 c 0.371094 0.375 0.359375 0.992187 -0.03125 1.382812 l -5.347656 5.347656 c -0.390625 0.390626 -1.007813 0.40625 -1.382813 0.03125 z m 0 0"/>
+        <path d="m 22.867188 95.21875 c -0.375 -0.375 -0.359376 -0.992188 0.03125 -1.382812 l 5.34375 -5.347657 c 0.390624 -0.390625 1.011718 -0.40625 1.382812 -0.03125 c 0.375 0.371094 0.359375 0.992188 -0.03125 1.382813 l -5.347656 5.347656 c -0.390625 0.390625 -1.007813 0.402344 -1.378906 0.03125 z m 0 0"/>
+    </g>
+</svg>

cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/beach/9.jpg

@@ -0,0 +1 @@
+0.jpg

cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/cliffs/5.jpg

@@ -0,0 +1 @@
+4.jpg

cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/cliffs/9.jpg

@@ -0,0 +1 @@
+0.jpg

cinnamon-dynamic-wallpaper@TobiZog/5.4/res/images/included_image_sets/mountains/9.jpg

@@ -0,0 +1 @@
+0.jpg

cinnamon-dynamic-wallpaper@TobiZog/5.4/settings-schema.json

@@ -0,0 +1,138 @@
+{
+  "first_start": {
+    "type": "generic",
+    "default": true
+  },
+  "picture_aspect": {
+    "type": "generic",
+    "default": "scaled"
+  },
+  "dynamic_background_color": {
+    "type": "generic",
+    "default": true
+  },
+  "image_source": {
+    "type": "generic",
+    "default": "image_set"
+  },
+  "selected_image_set": {
+    "type": "generic",
+    "default": "lakeside"
+  },
+  "source_folder": {
+    "type": "generic",
+    "default": ""
+  },
+  "period_0_image": {
+    "type": "generic",
+    "default": "9.jpg"
+  },
+  "period_1_image": {
+    "type": "generic",
+    "default": "1.jpg"
+  },
+  "period_2_image": {
+    "type": "generic",
+    "default": "2.jpg"
+  },
+  "period_3_image": {
+    "type": "generic",
+    "default": "3.jpg"
+  },
+  "period_4_image": {
+    "type": "generic",
+    "default": "4.jpg"
+  },
+  "period_5_image": {
+    "type": "generic",
+    "default": "5.jpg"
+  },
+  "period_6_image": {
+    "type": "generic",
+    "default": "6.jpg"
+  },
+  "period_7_image": {
+    "type": "generic",
+    "default": "7.jpg"
+  },
+  "period_8_image": {
+    "type": "generic",
+    "default": "8.jpg"
+  },
+  "period_9_image": {
+    "type": "generic",
+    "default": "9.jpg"
+  },
+  "period_source": {
+    "type": "generic",
+    "default": "network_location"
+  },
+  "location_refresh_intervals": {
+    "type": "generic",
+    "default": 15
+  },
+  "network_location_provider": {
+    "type": "generic",
+    "default": "geojs.io"
+  },
+  "latitude_auto": {
+    "type": "generic",
+    "default": 0
+  },
+  "longitude_auto": {
+    "type": "generic",
+    "default": 0
+  },
+  "latitude_custom": {
+    "type": "generic",
+    "default": 0
+  },
+  "longitude_custom": {
+    "type": "generic",
+    "default": 0
+  },
+  "period_0_custom_start_time": {
+    "type": "generic",
+    "default": "00:00"
+  },
+  "period_1_custom_start_time": {
+    "type": "generic",
+    "default": "05:00"
+  },
+  "period_2_custom_start_time": {
+    "type": "generic",
+    "default": "07:00"
+  },
+  "period_3_custom_start_time": {
+    "type": "generic",
+    "default": "09:00"
+  },
+  "period_4_custom_start_time": {
+    "type": "generic",
+    "default": "11:00"
+  },
+  "period_5_custom_start_time": {
+    "type": "generic",
+    "default": "13:00"
+  },
+  "period_6_custom_start_time": {
+    "type": "generic",
+    "default": "15:00"
+  },
+  "period_7_custom_start_time": {
+    "type": "generic",
+    "default": "17:00"
+  },
+  "period_8_custom_start_time": {
+    "type": "generic",
+    "default": "19:00"
+  },
+  "period_9_custom_start_time": {
+    "type": "generic",
+    "default": "21:00"
+  },
+  "login_image": {
+    "type": "generic",
+    "default": true
+  }
+}