Log file system implemented

cinnamon-dynamic-wallpaper@TobiZog/5.4/scripts/communication.js

@@ -0,0 +1,84 @@
+/**
+ * @name	Cinnamon-Dynamic-Wallpaper
+ * @alias 	TobiZog
+ * @since	2023-08-25
+ * 
+ * @description Handles communications with the user (notifications, logs)
+ */
+
+/******************** Imports ********************/
+
+const St = imports.gi.St;
+const Main = imports.ui.main;
+const Util = imports.misc.util;
+const MessageTray = imports.ui.messageTray;
+
+
+
+
+/******************** Functions ********************/
+
+/**
+ * Displaying a desktop notification
+ * 
+ * @param {string} title 				The Title in the notification
+ * @param {string} text 				The text in the notification
+ * @param {boolean} showOpenSettings 	Display the "Open settings" button in the notification, 
+ * 										defaults to false
+ */
+function 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("xlet-settings extension " + UUID));
+	}
+
+	// Put all together
+	Main.messageTray.add(source);
+
+	// Display it
+	source.notify(notification);
+}
+
+
+/**
+ * Adding a message to the logs
+ * 
+ * @param {string} logMsg New log message to add
+ */
+function createLogs(tvLogs, logMsg) {
+	/**
+	 * Pad a number with leading zeros
+	 * 
+	 * @param {number} num Number to format
+	 * @param {number} size Final string length
+	 * 
+	 * @returns String with defined length
+	 */
+	function pad(num, size) {
+		var s = "00" + num
+		return s.substring(s.length - size)
+	}
+
+	// Estimate date and time
+	let date = new Date()
+	let formattedDate = pad(date.getHours(), 2) + ":" + pad(date.getMinutes(), 2) + ":" + pad(date.getSeconds(), 2)
+
+	// Add the the logs
+	return formattedDate + "\t" + logMsg + "\n" + tvLogs
+}

cinnamon-dynamic-wallpaper@TobiZog/5.4/scripts/location.js

@@ -1,6 +1,23 @@
+/**
+ * @name	Cinnamon-Dynamic-Wallpaper
+ * @alias 	TobiZog
+ * @since	2023
+ * 
+ * @description Functions to estimate the user location
+ */
+
+/******************** Imports ********************/
+
 const Soup = imports.gi.Soup;
 
 
+/******************** Functions ********************/
+
+/**
+ * Estimate the location of the user
+ * 
+ * @returns Location data if succeded or -1 if failed
+ */
 function estimateLocation() {
 	let sessionSync = new Soup.SessionSync();
 	let msg = Soup.Message.new('GET', "https://get.geojs.io/v1/ip/geo.json");

cinnamon-dynamic-wallpaper@TobiZog/5.4/scripts/suntimes.js

@@ -2,8 +2,12 @@
  * @name	Cinnamon-Dynamic-Wallpaper
  * @alias 	TobiZog
  * @since	2023
+ * 
+ * @description Functions to calculate sun time periods
  */
 
+/******************** Constants ********************/
+
 const DAYPERIOD = {
 	MTWILIGHT: 0,
 	SUNRISE: 1,
@@ -22,6 +26,9 @@ const J1970 = 2440588
 const J2000 = 2451545
 
 
+/******************** Functions ********************/
+
+
 function fromJulian(j) {
 	let ms_date = (j + 0.5 - J1970) * DAYMS
 	return new Date(ms_date)
@@ -83,6 +90,14 @@ function subTimesToMinutes(date1, date2) {
 }
 
 
+/**
+ * Calculating the start and end time of all time periods of the day
+ * 
+ * @param {float} latitude Location latitude
+ * @param {float} longitude Location longitude
+ * 
+ * @returns JSON of time periods
+ */
 function calcTimePeriod(latitude, longitude) {
 	let todaySunEventsDay = sunEventsOfDay(latitude, longitude, Date.now())
 	let tomorrowSunEventsDay = sunEventsOfDay(latitude, longitude, addMinutesToTime(new Date(), 1440))