[Spice internet-indicator] creation of a new applet :) (#4481)

* Creation of a new applet :)

Dear cinnamon team : I would like to publish my applet into Cinnamon Spices. I guess that some people would love it. It is a very simple applet which display if Internet work or does not work.

I am a beginner with git, javascript, cinnamon applet et gitHub. Please help me if I am doing anything wrong. I am ready to learn and to improve anything.

Thank you for your collaboration

* Update applet.js

typo : a "r" was here an prevent  the applet to work !!!

* Improvements thanks to  Gr3q feedbacks :)

Translate French to English
Remove duplicated README.md
Remove some comments for better code readibility
Remove the log messages by default

* Start supporting languages

* Solve the bug for the translation which now works

* Initial copy of [email protected]

* The order of window is now saved into a file

The order of window is now saved into a file.
So when Cinnamon restarts or crashes then the order of window is kept :)

* use the applet directory variable

* Save the list of window to /tmp file instead of the applet folder

* Add usefull files for first version of the applet

* Revert "The order of window is now saved into a file"

This reverts commit a1fa624.

* Revert "Initial copy of [email protected]"

This reverts commit c50f74b.

* Revert files which should belong to another pull request

Sorry for the mistake !!!

.gitignore

@@ -4,3 +4,6 @@
 node_modules/
 /.idea/
 package-lock.json
+*.7z
+internet-indicator@sangorys/files/internet-indicator@sangorys/icons/no-internet2.jpg
+internet-indicator@sangorys/files/internet-indicator@sangorys/icons/wifi-icon-off.png

internet-indicator@sangorys/README.md

@@ -0,0 +1,15 @@
+Internet-indicator
+========
+
+Internet-indicator is a simple applet which shows in real time if you are connected to Internet or not.
+
+It should be interersting in these particular environments :
+ * You are connected to a WIFI hotspot
+ * You are connected to a mobile hotspot
+ * You are connected to a VPN
+
+In these cases, maybe you can temporary lost your Internet connection. One of my best example is when I work in a train.
+
+### Features
+
+ * Detect if Internet is connected (thanks to a ping to google)

internet-indicator@sangorys/files/internet-indicator@sangorys/applet.js

@@ -0,0 +1,260 @@
+const Applet = imports.ui.applet;
+const Util = imports.misc.util;
+const Mainloop = imports.mainloop;
+const Lang = imports.lang;
+const PopupMenu = imports.ui.popupMenu;
+const GLib = imports.gi.GLib;
+const St = imports.gi.St;
+const Settings = imports.ui.settings;
+const QUtils = require('./js/QUtils.js');
+const QIcon = QUtils.QIcon;
+
+// FOR TRANSLATION
+const Gettext = imports.gettext;
+const UUID = "internet-indicator@sangorys";
+Gettext.bindtextdomain(UUID, GLib.get_home_dir() + '/.local/share/locale');
+
+var nbTry = 0;
+var message="init";
+var oldStderr="init";
+var debug = 0;
+var verbose = 0;
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+function printDebug(text) {
+    if (debug == 1){
+        global.log(text);
+    }
+}
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+function _(str) {
+    return Gettext.dgettext(UUID, str);
+}
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+class InternetIndicatorApplet extends Applet.TextIconApplet {
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    constructor(orientation, panel_height, instance_id) {
+        super(orientation, panel_height, instance_id);
+
+        printDebug("Start internet-indicator applet");
+
+        this.set_applet_tooltip(_("Initializing"));
+        //this.set_applet_label("NordVPN");
+        this.connected = false;
+
+		this.update_interval = 5; // By default
+		this.update_interval_when_no_internet = 3; // By default
+		this.update_interval_when_internet = 10; // By default
+
+
+        // Reload BTN : for future improvements...
+        /*let reload_btn = new PopupMenu.PopupIconMenuItem(_("Reload Applet"), 'view-refresh-symbolic', QIcon.SYMBOLIC, {hover: true});
+        reload_btn.connect('activate', this.reloadApplet.bind(this));
+        this._applet_context_menu.addMenuItem(reload_btn);
+        this._applet_context_menu.addMenuItem(new PopupMenu.PopupSeparatorMenuItem());*/
+
+
+        try {
+
+            // READ SETTINGS
+            /* Initialize your settings handler instance      this,            the uuid              instance id  */
+            this.settings = new Settings.AppletSettings(this, UUID, this.instance_id);
+
+            this.settings.bindProperty(Settings.BindingDirection.IN, "update-interval-when-no-internet", "update_interval_when_no_internet", this.set_update_interval_when_no_internet, null);
+            this.settings.bindProperty(Settings.BindingDirection.IN, "update-interval-when-internet", "update_interval_when_internet", this.set_update_interval_when_internet, null);
+
+
+            // Create the popup menu
+            this.menuManager = new PopupMenu.PopupMenuManager(this);
+            this.menu = new Applet.AppletPopupMenu(this, orientation);
+            this.menuManager.addMenu(this.menu);
+
+            this._contentSection = new PopupMenu.PopupMenuSection();
+            this.menu.addMenuItem(this._contentSection);
+
+            /*// First item: // For futur use
+            let item = new PopupMenu.PopupIconMenuItem("Test Internet speed", "internet", St.IconType.FULLCOLOR);
+
+            item.connect('activate', Lang.bind(this, function() {
+                           this.testInternetFree();
+                         }));
+            this.menu.addMenuItem(item); */
+
+
+            // START THE PERIODIC TASK TO CHECK INTERNET CONNECTION
+			this._update_loop();
+		}
+		catch (e) {
+			global.logError(e);
+		}
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    on_applet_clicked() {
+        this.menu.toggle();
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    on_applet_removed_from_panel() {
+		if (this._updateLoopID) {
+			Mainloop.source_remove(this._updateLoopID);
+		}
+	}
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    _run_cmd(command) {
+      try {
+        let [result, stdout, stderr] = GLib.spawn_command_line_sync(command);
+        if (stdout != null) {
+          return stdout.toString();
+        }
+      }
+      catch (e) {
+        global.logError(e);
+      }
+
+      return "";
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    // CALLBACK WHEN SETTINGS ARE CHANGED => WARNING THIS CALLBACK IS NEVER CALLED WHEN THE CONFIG IS CHANGED
+    set_update_interval_when_no_internet(){
+    	global.log("update_interval_when_no_internet=" + this.update_interval_when_no_internet);
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    // CALLBACK WHEN SETTINGS ARE CHANGED => WARNING THIS CALLBACK IS NEVER CALLED WHEN THE CONFIG IS CHANGED
+    set_update_interval_when_no_internet(){
+    	global.log("update_interval_when_ninternet=" + this.update_interval_when_internet);
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    // THIS FUNCTION SHOULD BE REMOVED SOON IF NOT USED
+    _new_freq(){
+    	global.log(this.update_interval);
+        if (this._updateLoopID) {
+			Mainloop.source_remove(this._updateLoopID);
+		}
+        this._update_loop();
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    _update_loop() {
+		this._send_ping();	
+		this._updateLoopID = Mainloop.timeout_add(this.update_interval * 1000, Lang.bind(this, this._update_loop));
+	}
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    _send_ping() {
+
+		// INIT
+		let [result, stdout, stderr] = ["", "", ""];
+		nbTry = nbTry + 1;
+		printDebug("Scan " + nbTry + " (period=" + this.update_interval + "s)");
+
+
+        //////////////////////////////////////////////
+        // RUN PING
+		try {
+			[result, stdout, stderr] = GLib.spawn_command_line_sync("ping www.google.fr -c 1 -w 1000");
+			//printDebug("result=" + result);
+			//printDebug("stderr=" + stderr);
+			//printDebug("stdout=" + stdout);
+			//printDebug("oldStderr=" + oldStderr);
+		  }
+		catch (e) {
+			global.logError(e);
+		}
+
+
+        //////////////////////////////////////////////
+        // ANALYZE THE PING ANSWER
+		//printDebug("analyse");  
+
+		if (stderr == "")
+		{
+			//printDebug("ping OK");  
+			if (stderr.toString() != oldStderr)
+			{
+			  //printDebug("connected");
+			  oldStderr = stderr.toString();
+              let TextMessage = _("Internet OK");
+			  Util.spawnCommandLine("/usr/sbin/notify-send '" + TextMessage + "'");
+              this.set_applet_tooltip(TextMessage);
+			  this.update_interval = this.update_interval_when_internet;
+			  this.set_applet_icon_name("internet");
+			}
+			//else {printDebug("No change : still connected");}
+		}
+		else
+		{
+			//printDebug("ping failed");  
+			if (stderr.toString() != oldStderr)
+			{
+			  //printDebug("connected");
+			  oldStderr = stderr.toString();
+              let TextMessage = _("No Internet");
+			  Util.spawnCommandLine("/usr/sbin/notify-send '" + TextMessage + "'");
+              this.set_applet_tooltip(TextMessage);
+			  this.update_interval = this.update_interval_when_no_internet;
+			  this.set_applet_icon_name("no-internet");
+			}
+			//else {printDebug("No change : still connected");}
+		}
+		//printDebug("ping.end");
+	}
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    // WARNING : IS NEVER CALLED !!!! WHY ?
+    reloadApplet() {
+        let cmd = "dbus-send --session --dest=org.Cinnamon.LookingGlass --type=method_call /org/Cinnamon/LookingGlass org.Cinnamon.LookingGlass.ReloadExtension string:'internet-indicator@sangorys' string:'APPLET'";
+        printDebug(cmd);
+        Util.spawnCommandLine(cmd);
+    }
+
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////
+    // NOT USED YET. FOR FUTURE USAGE
+    testInternetFree() {
+
+		// INIT
+		let [result, stdout, stderr] = ["", "", ""];
+		printDebug("testInternetFree ");
+
+
+        //////////////////////////////////////////////
+        // RUN PING
+		try {
+			[result, stdout, stderr] = GLib.spawn_command_line_sync("wget -O /dev/null http://test-debit.free.fr/1048576.rnd");
+			//printDebug("result=" + result);
+			//printDebug("stderr=" + stderr);
+			printDebug("stdout=" + stdout);
+			//printDebug("oldStderr=" + oldStderr);
+		  }
+		catch (e) {
+			global.logError(e);
+		}
+	}
+}
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+function main(metadata, orientation, panel_height, instance_id) {  // Make sure you collect and pass on instanceId
+    return new InternetIndicatorApplet(orientation, panel_height, instance_id);
+}