autostart + clean

Author: leopollini

PackageCreator.js

@@ -1,20 +1,19 @@
 const path = require('./lib/path2');
 const fs = require('fs');
 const kleur = require('kleur');
-const { EXT_CONFIGS_DIR, DATA_CONF_PATH } = require('./lib/Constants');
+const { EXT_CONFIGS_DIR, DATA_CONF_PATH, LINUX_AUTOSTART_DIR } = require('./lib/Constants');
 
 class PackageCreator
 {
 	static CONF_FILE_PATH = path.join(__dirname, 'config.json');
 
 
-	constructor()
+	constructor(conf)
 	{
 		console.log("### CONFIGURING PACKAGE ###");
 
 		this.createAppDirectories();
-		try {this.conf = JSON.parse(fs.readFileSync(PackageCreator.CONF_FILE_PATH));}
-		catch (e) {return console.log('Could not load config file:', e);}
+		this.conf = conf;
 
 		// console.log(conf);
 
@@ -29,7 +28,7 @@ class PackageCreator
 
 	createAppDirectories()
 	{
-		[EXT_CONFIGS_DIR].forEach(dir => {
+		[EXT_CONFIGS_DIR, LINUX_AUTOSTART_DIR].forEach(dir => {
 			dir = path.joinAppData(dir);
 			if (!fs.existsSync(dir))
 			{

config.json

@@ -8,7 +8,9 @@
 		},
 		"version": "0.0.1",
 		"autoupdate": false,
-		"electron_package": "package.json"
+		"electron_package": "package.json",
+		"app_name": "Webpage Accessor",
+		"app_executable": "webpage_accessor"
 	},
 
 	"log":
@@ -79,6 +81,8 @@
 				},
 				"extra_extensions":
 				{
+					"enable_shortcuts": true,
+					"hide_toolbar": true,
 					"extension": "window-events"
 				},
 				"startup_actions": {},
@@ -87,14 +91,19 @@
 					"enabled": true,
 					"extension": "keys-checker",
   					"custom_id": false
+				},
+				"autostart":
+				{
+					"desktop_filename": "webpage-accessor.desktop",
+					"extension": "autostart"
 				}
 			}
 		}
 	},
 
 	"default_data":
 	{
-		"fullscreen": false,
+		"fullscreen": true,
 		"autostart": true,
 		"autorestart": true,
 		"autoreload": false,

extensions_data/autostart/webpage-accessor.desktop

@@ -0,0 +1,5 @@
+[Desktop Entry]
+Name=webpage-accessor
+Comment=webpage accessor autostart script
+Type=Application
+Exec=webpage-accessor

extensions_main/autostart.js

@@ -1,31 +1,32 @@
-const { app } = require('electron');
 const fs = require('fs');
 const path = require('../lib/path2');
+const { notStrictEqual } = require('assert');
+const { LINUX_AUTOSTART_DIR } = require('../lib/Constants')
 
-// Sample Module. Plase copy-paste this file into new module's main folder
+// WARNING: THIS SCRIPT WILL CHANGE THE MACHINE'S STARTUP BEHAVIOUR.
+// TO DISABLE REMOVE .desktop FILE
+// WILL TAKE EFFECT ONLY ON BUILD MODE, NOT ON DEV MODE
 class Autostarter extends require('../lib/BaseModule')
 {
-    // unspecified: loads data.json
-    // MODULE_NAME = "autostarter";
-    
+    MODULE_NAME = "autostart";
+
     setup()
     {
-        this.log("setting autostart to", this.__conf.autostart == true);
-        app.on('ready', () => {
-            app.setLoginItemSettings({
-                openAtLogin: (this.__conf.autostart == true),       // autostart at login
-                openAsHidden: false,     // can hide window if desired
-            });
-        });
-
-        let filel = null;
-        const logfile = path.joinAppData("lel.txt");
-        if (fs.existsSync(logfile))
-            filel = fs.readFileSync(logfile)
-        else
-            filel = ""
-        filel = filel + "\ntried to open at " + Date.now().toString();
-        fs.writeFileSync(logfile, filel);
+        // LINUX SETUP]
+        this.log("setting autostart to", this.getAppData().autostart);
+        if (this.getAppData().autostart == true)
+        {
+            const file_content = `[Desktop Entry]
+Name=` + this.getAppConfig().app_info.app_name + `
+Comment=webpage accessor autostart script
+Type=Application
+Exec=` + this.getAppConfig().app_info.app_executable;
+            // debug location
+            // const desktop_file_dir = this.joinData(this.__conf.desktop_filename);
+            const desktop_file_dir = path.join(LINUX_AUTOSTART_DIR, this.__conf.desktop_filename);
+            fs.writeFileSync(desktop_file_dir, file_content);
+            this.log("desktop file created");
+        }
     }
 }
 

extensions_main/window-events.js

@@ -12,8 +12,6 @@ class WindowSetup extends require('../lib/BaseModule')
 	// Setup code here. This function is called in BaseModule's constructor.
 	setup()
 	{
-		this.requireDataConf();
-
         this.window.on('resize', () => {
 			if (this.window.isFullScreen()) return ;
             this.tab.setBounds({x: 0, y: 0  , height: this.window.getContentBounds().height, width: this.window.getContentBounds().width});
@@ -27,18 +25,21 @@ class WindowSetup extends require('../lib/BaseModule')
             this.tab.setBounds({x: 0, y: 0  , height: this.window.getContentBounds().height, width: this.window.getContentBounds().width});
 			this.logWindowDimensions('leave fullscreen');
         });
-
-		globalShortcut.register('f', () => {
-			this.window.setFullScreen(!this.window.isFullScreen());
-		});
-		globalShortcut.register('d', () => {
-			this.tab.webContents.toggleDevTools();
-		});
-		globalShortcut.register('c', () => {
-			checkActiveModules();
-		});
-
-		if (this.__data.fullscreen == true) this.window.setFullScreen(true);
+	
+		if (this.__conf.enable_shortcuts == true)
+		{
+			globalShortcut.register('f', () => {
+				this.window.setFullScreen(!this.window.isFullScreen());
+			});
+			globalShortcut.register('d', () => {
+				this.tab.webContents.toggleDevTools();
+			});
+			globalShortcut.register('c', () => {
+				checkActiveModules();
+			});true
+		}
+
+		if (this.getAppData().fullscreen == true) this.window.setFullScreen(true);
 	}
 
 	logWindowDimensions(operation = '')

lib/BaseModule.js

@@ -3,17 +3,21 @@ const path = require('./path2')
 const kleur = require('kleur');
 const Env = require('../env');
 const { DATA_CONF_PATH } = require('./Constants');
+const { app } = require('electron');
 
 class BaseModule
 {
+	// extensions's configuration file content. Different from app.conf
 	__conf = null;
+
 	window = null;
 	tab = null;
 	module_name = "";
 	is_active = false;
 
 	constructor() {}
 
+	// extension's constructors are called after window creation and after app.ready().
 	__start(window, tab)
 	{
 		this.window = window;
@@ -25,10 +29,11 @@ class BaseModule
 		else
 			this.conf_file_path = path.joinConfigDir(this.module_name + '.json');
 
-		try { this.__conf = JSON.parse(fs.readFileSync(this.conf_file_path, 'utf-8')); }
-		catch (e) { console.log('Could not load conf file for', this.module_name, ':', e, '.'); }
+		if (fs.existsSync(this.conf_file_path))
+			try { this.__conf = JSON.parse(fs.readFileSync(this.conf_file_path, 'utf-8')); }
+			catch (e) { this.warn('Could not load conf file for', this.module_name, ':', e, '.'); }
 
-		if (!this.__conf) console.log('__conf not defined.');
+		if (!this.__conf) this.warn('__conf not defined.');
 		else if (this.__conf.enabled == false) return;
 
 		// this.log('Setting up', this.module_name, 'config:', this.__conf, '...');
@@ -38,7 +43,7 @@ class BaseModule
 		this.log('... done');
 	}
 
-	// Colored logging!
+	// Colored logging! Use this instead of console.log()
     log(...message)
 	{
 		if (Env.DEBUG_MODE) console.log('[', kleur.green(this.module_name), ']:', ...message);
@@ -52,15 +57,44 @@ class BaseModule
 		if (Env.DEBUG_MODE) console.log('[', kleur.red(this.module_name), ']:', ...message);
 	}
 
+	// sets active status
 	setActive(active = true) {this.is_active = active;}
 
+	// returns active status
 	isActive() {return this.is_active;}
 
-	requireDataConf()
+	// returns module's private folder
+	appData()
+	{
+		return path.joinAppData(this.module_name);
+	}
+
+	// returns module's data folder
+	joinData(...dir)
+	{
+		return path.joinDataDir(this.module_name, ...dir);
+	}
+
+	// returns module's conf folder
+	joinConf(...dir)
 	{
-		try { this.__data = JSON.parse(fs.readFileSync(path.joinAppData(DATA_CONF_PATH))); }
-		catch (e) { console.log('Could not load conf file for', this.module_name, ':', e, '.'); }
+		return path.joinConfigDir(this.module_name, ...dir);
 	}
+
+	// returns app.conf (config.json) content. Maybe not assigned? check main.js
+	getAppConfig()
+	{
+		return app.conf;
+	}
+
+	//returns app.data (data.json) content
+	static getDataFile = false;
+	getAppData()
+	{
+		return app.data;
+	}
+
+	// setup Windows??
 }
 
 module.exports = BaseModule;

lib/Constants.js

@@ -1,6 +1,11 @@
+const { app } = require('electron')
+const path = require('path')
+
 EXT_CONFIGS_DIR = 'extensions_conf';
-APPDATA_DIRNAME = 'Webpage_Accessor';
+EXT_DATA_DIR = 'extensions_data'
+APPDATA_DIRNAME = 'webpage-accessor';
 DATA_CONF_PATH = 'extensions_conf/data.json';
+LINUX_AUTOSTART_DIR = path.join(app.getPath('home'), '.config', 'autostart')
 // APPDATA_SAFE_OVERRIDE = '';
 
-module.exports = { EXT_CONFIGS_DIR, APPDATA_DIRNAME, DATA_CONF_PATH };
+module.exports = { EXT_CONFIGS_DIR, APPDATA_DIRNAME, DATA_CONF_PATH, EXT_DATA_DIR, LINUX_AUTOSTART_DIR };

lib/path2.js

@@ -1,35 +1,44 @@
 const path = require('path');
 const fs = require('fs');
 const { app } = require('electron')
-const { EXT_CONFIGS_DIR, APPDATA_DIRNAME } = require('./Constants');
+const { EXT_CONFIGS_DIR, APPDATA_DIRNAME, EXT_DATA_DIR } = require('./Constants');
 const { findAppArg } = require('./utils')
 
 
 class path2
 {
     // static __dirname = path.join(__dirname, APPDATA_DIRNAME);
-    static __dirname = path.join(app.getPath('appData'), APPDATA_DIRNAME);
+    static appData = path.join(app.getPath('appData'), APPDATA_DIRNAME);
+    static appRoot = path.join(__dirname, '..');
 
-    static config_location = path.join(path2.__dirname, EXT_CONFIGS_DIR);
+    static config_location = path.join(path2.appData, EXT_CONFIGS_DIR);
 
-    static joinAppData(...dir) {return path.join(path2.__dirname, ...dir);}
-    static joinConfigDir(...dir) {return path.join(path2.__dirname, EXT_CONFIGS_DIR, ...dir);}
+    // returns location inside app's private folder in AppData (location is system-specific)
+    static joinAppData(...dir) {return path.join(path2.appData, ...dir);}
+    
+    // retuns location inside extensions_conf in AppData
+    static joinConfigDir(...dir) {return path.join(path2.appData, EXT_CONFIGS_DIR, ...dir);}
+
+    // returns location inside extensions_data in app's root -- READONLY
+    static joinDataDir(...dir) {return path.join(path2.appRoot, EXT_DATA_DIR, ...dir);}
+
+    // regular old join
     static join(...dir) {return path.join(...dir);}
 
     static already_required = false;
 }
 
-
+// this section creates a link to extensions_conf inside appdata at the root of the app. Developer option
 if (!path2.already_required)
 {
     app.whenReady().then(function ()
     {
         console.log('creating dir',path2.config_location )
         if (!fs.existsSync(path2.config_location))
             try {fs.mkdirSync(path2.config_location, { recursive: true });}
-            catch (e) {console.log("could not create path to", EXT_CONFIGS_DIR, "in", path2.__dirname, ".", )}
+            catch (e) {console.log("could not create path to", EXT_CONFIGS_DIR, "in", path2.appData, ".", )}
         if (findAppArg('create_config_link') && !fs.existsSync(path.join(__dirname, '..', EXT_CONFIGS_DIR)))
-            fs.symlinkSync(path2.config_location, path.join(__dirname, '..', EXT_CONFIGS_DIR));
+            fs.symlinkSync(path2.config_location, path.join(appData, '..', EXT_CONFIGS_DIR));
     });
     path2.already_required = true;
 }

main.js

@@ -10,7 +10,7 @@ const { DATA_CONF_PATH } = require('./lib/Constants');
 
 const DATA_FILE_PATH = path.joinAppData(DATA_CONF_PATH);
 const LOAD_DIR = path.join(__dirname, 'extensions_main');
-let PAGE_URL = url.format({
+const PAGE_URL = url.format({
 	pathname: path.join(__dirname, "index.html"),
 	// pathname: path.join("reception.parchotels.it"),
 	// protocol: 'http'
@@ -19,24 +19,27 @@ let PAGE_URL = url.format({
 
 const enabled_modules = [];
 
-async function createMainWindow()
-{
-	// During first execution create all config files
-	app.args = process.argv.slice(3);	
-	app.conf = {};
-	app.data = {};
-	
+// During first execution create all config files
+app.args = process.argv.slice(3);	
+app.conf = {};
+app.data = {};
+
+// loads data file, if present
+if (fs.existsSync(DATA_FILE_PATH))
 	try {app.data = JSON.parse(fs.readFileSync(DATA_FILE_PATH));}
-	catch {console.log('Main: could not load data file'); } // new pc(); return ;}
-	
+	catch {console.log('Main: could not load data file'); }
+// loads config file
+try {app.conf = JSON.parse(fs.readFileSync(pc.CONF_FILE_PATH));}
+catch {console.log('Main: could not load data file'); } // new pc(); return ;}
+
 
+async function createMainWindow()
+{
 	if (!app.data.is_configured) 
-		try {new pc()}
+		try {new pc(app.conf)}
 		catch (e) {console.log("FAILED:", e)}
 		finally {console.log("### CONFIGURATION FINISHED ###")};
 
-
-
 	if (Env.DEBUG_MODE && app.data && app.data.version)
 		console.log("### WELCOME TO VERSION", app.data.version, "###");