From 5e111876fddf8182935a5459edffd7e9c7e5968f Mon Sep 17 00:00:00 2001 From: Holly Date: Fri, 7 Jan 2022 14:04:39 +0000 Subject: [PATCH] add module node module checks and auto module install support --- config/config.example.json | 11 ++-- index.js | 85 +++++++++++++++++++++++++----- modules/consoleHelper.js | 2 + modules/example_request_handler.js | 4 +- package.json | 28 +++++----- 5 files changed, 96 insertions(+), 34 deletions(-) diff --git a/config/config.example.json b/config/config.example.json index 8246c73..eaac36f 100644 --- a/config/config.example.json +++ b/config/config.example.json @@ -1,6 +1,9 @@ { - "server": { - "port":5906, - "instance_type":"Default" - } + "server": { + "port": 5906, + "instance_type": "Default" + }, + "other": { + "auto_install_modules": false + } } \ No newline at end of file diff --git a/index.js b/index.js index 9252e7c..56ab763 100644 --- a/index.js +++ b/index.js @@ -35,6 +35,8 @@ global.modules = []; let startTime = Date.now(), reqhandler; +let shutdownOnInitEnd = false; + // Clear console before printing anything console.clear(); @@ -46,7 +48,7 @@ fs.readFile('./misc/ascii.txt', function(err, data) { console.log(highlightHeader(data)); // Get the modules from the ./modules folder fs.readdir("./modules", (err, files) => { - // Make sure there are no errors + // Throw if we failed to read folder if (err) throw err; for (var i = 0; i < files.length; i++) { /* @@ -58,20 +60,71 @@ fs.readFile('./misc/ascii.txt', function(err, data) { // Make sure the file has the extention of .js if (files[i].includes(".js")) { console.log(`[Modules] Found module ${files[i].toString()}`); - global.modules[files[i].toString().replace(".js", "")] = require(`./modules/${files[i].toString()}`); - - // We want to find out what the request handler module is - if (global.modules[files[i].toString().replace(".js", "")].MOD_FUNC == "handle_requests") { - // Set reqhandler to the request handler for easy getting - reqhandler = global.modules[files[i].toString().replace(".js", "")]; + const thisModule = global.modules[files[i].toString().replace(".js", "")] = require(`./modules/${files[i].toString()}`); + + let nodeModulesCheck = []; + thisModule.REQUIRED_NODE_MODULES.forEach(module => { + try { + require(module); + } catch (e) { + // we'll only get down here if the module is not installed or has an error + if ((!config.other.auto_install_modules && e.code != "MODULE_NOT_FOUND")) + console.error(chalk.bgRed(chalk.black(` ! [Modules] ${files[i].replace(".js", "")} requires node module "${module}" but it ${e.code != "MODULE_NOT_FOUND" ? "failed to load" : "is not installed"} `))); + + if (e.code != "MODULE_NOT_FOUND") { + console.error(e); + } + // Push module name so we can install it if + // it is enabled in the config + nodeModulesCheck.push(module); + } + }); + + if (nodeModulesCheck.length != 0) { + // Check if we can auto install node modules + if (config.other.auto_install_modules) { + // We've been told to install modules for the user lmao + const { execSync } = require("child_process"); + console.log(`[Modules] Installing all ${files[i].replace(".js", "")} node modules...`); + let installed = 0; + nodeModulesCheck.forEach(module => { + console.log(`[Modules] [${(installed++) + 1}/${nodeModulesCheck.length}] Installing ${module}...`); + execSync(`npm i --save ${module.split("\"").join("").split("'").join("").split(";").join("").split("&").join("")}`) + }); + console.log(`[Modules] Installed all ${files[i].replace(".js", "")} node modules`); + // Clear it out + nodeModulesCheck = []; + } else { + // We can't auto install node modules so just make sure Revolution shuts down at the end of module loading. + // We want the user to have a full picture of what they need to install + shutdownOnInitEnd = true; + } } - // Loop through and set the required modules flags + // If this is 0 we can safely init the module + if (nodeModulesCheck.length == 0 && thisModule.init != null) { + console.log(`[Modules] Running init for ${files[i]}`); + try { + thisModule.init(); + } catch (e) { + console.log(chalk.bgRed(chalk.black(` ! [Modules] There was an issue running init for ${files[i]}`))); + console.log(chalk.bgRed(chalk.black(` ! [Modules] ${err}`))); + } + } + + // We want to find out what the request handler module is + if (thisModule.MOD_FUNC == "handle_requests") { + // Set reqhandler to the request handler for easy getting + reqhandler = thisModule; + } + + // Loop through the required modules for (var i1 = 0; i1 < requiredModules.length; i1++) { // Check if this module is a required module - if (global.modules[files[i].toString().replace(".js", "")].MOD_FUNC == requiredModules[i1].name) { - // It is a required module, set the status flag of this one to true + if (thisModule.MOD_FUNC == requiredModules[i1].name) { + // It is a required module, set the status of this one to true requiredModules[i1].status = true; + break; } } } else { @@ -82,8 +135,8 @@ fs.readFile('./misc/ascii.txt', function(err, data) { console.log(`[Modules] Found file ${files[i]}. It is not a module.`) } } catch (err) { - console.log(chalk.bgRed(` ! [Modules] There was an issue loading ${files[i]} ! `)); - console.log(chalk.bgRed(` ! [Modules] ${err} ! `)); + console.log(chalk.bgRed(chalk.black(` ! [Modules] There was an issue loading ${files[i]}`))); + console.log(chalk.bgRed(chalk.black(` ! [Modules] ${err}`))); } } // Check if all the required modules flags are set @@ -95,10 +148,14 @@ fs.readFile('./misc/ascii.txt', function(err, data) { // Make sure all required modules are found if (allRequiredExist.length !== requiredModules.length) { // Inform the user that not all required modules are found. - console.log("[Modules] All required modules could not be found."); - console.log("[Modules] Server will not start until all required modules are found."); + console.log(chalk.bgRed(chalk.black(" ! [Modules] All required modules could not be found. "))); + console.log(chalk.bgRed(chalk.black(" ! [Modules] Server will not start until all required modules are found. "))); // They are not all found, exit Revolution with code 1. process.exit(1); + } else if (shutdownOnInitEnd) { + console.log("\n" + chalk.bgRed(chalk.black(" ! [Modules] Required node modules for one or more modules could not be found. "))); + console.log(chalk.bgRed(chalk.black(" ! [Modules] Either install all required modules or enable auto install in the config. "))); + process.exit(1); } else { // All required modules are found, start Revolution's server. global.modules.consoleHelper.printInfo(emoji.wave, "Starting Revolution..."); diff --git a/modules/consoleHelper.js b/modules/consoleHelper.js index 3c40fcf..a28ea2e 100644 --- a/modules/consoleHelper.js +++ b/modules/consoleHelper.js @@ -72,6 +72,8 @@ module.exports = { module.exports.MOD_FUNC = MODULE_FUNCTION; +module.exports.REQUIRED_NODE_MODULES = []; + // Date returns numbers without a 0 in front of them of course so this adds them. function correctValue(i) { if (i < 10) { diff --git a/modules/example_request_handler.js b/modules/example_request_handler.js index f5a84de..1d11218 100644 --- a/modules/example_request_handler.js +++ b/modules/example_request_handler.js @@ -58,4 +58,6 @@ module.exports = { } } -module.exports.MOD_FUNC = MODULE_FUNCTION; \ No newline at end of file +module.exports.MOD_FUNC = MODULE_FUNCTION; + +module.exports.REQUIRED_NODE_MODULES = []; \ No newline at end of file diff --git a/package.json b/package.json index 303f3ff..5a5873a 100644 --- a/package.json +++ b/package.json @@ -1,16 +1,14 @@ { - "name": "revolution", - "version": "1.0.0", - "description": "", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "author": "", - "license": "MIT", - "dependencies": { - "chalk": "^2.4.2", - "express": "^4.17.1", - "http": "0.0.0" - } -} + "name": "revolution", + "description": "Revolution is a web server that I designed to be flexible to fit the needs of it's applications. It is mainly used in my Screenshot server, EUS which was recently rewriten. It's main design goal was to be modular.", + "version": "1.0.0", + "main": "index.js", + "scripts": {}, + "keywords": [], + "author": "", + "license": "MIT", + "dependencies": { + "express": "^4.17.2", + "chalk": "^4.1.2" + } +} \ No newline at end of file