add module node module checks and auto module install support

This commit is contained in:
Holly Stubbs 2022-01-07 14:04:39 +00:00
parent 53bf425bd3
commit 5e111876fd
Signed by: tgpholly
GPG key ID: B8583C4B7D18119E
5 changed files with 96 additions and 34 deletions

View file

@ -2,5 +2,8 @@
"server": { "server": {
"port": 5906, "port": 5906,
"instance_type": "Default" "instance_type": "Default"
},
"other": {
"auto_install_modules": false
} }
} }

View file

@ -35,6 +35,8 @@ global.modules = [];
let startTime = Date.now(), let startTime = Date.now(),
reqhandler; reqhandler;
let shutdownOnInitEnd = false;
// Clear console before printing anything // Clear console before printing anything
console.clear(); console.clear();
@ -46,7 +48,7 @@ fs.readFile('./misc/ascii.txt', function(err, data) {
console.log(highlightHeader(data)); console.log(highlightHeader(data));
// Get the modules from the ./modules folder // Get the modules from the ./modules folder
fs.readdir("./modules", (err, files) => { fs.readdir("./modules", (err, files) => {
// Make sure there are no errors // Throw if we failed to read folder
if (err) throw err; if (err) throw err;
for (var i = 0; i < files.length; i++) { 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 // Make sure the file has the extention of .js
if (files[i].includes(".js")) { if (files[i].includes(".js")) {
console.log(`[Modules] Found module ${files[i].toString()}`); console.log(`[Modules] Found module ${files[i].toString()}`);
global.modules[files[i].toString().replace(".js", "")] = require(`./modules/${files[i].toString()}`); const thisModule = global.modules[files[i].toString().replace(".js", "")] = require(`./modules/${files[i].toString()}`);
// We want to find out what the request handler module is let nodeModulesCheck = [];
if (global.modules[files[i].toString().replace(".js", "")].MOD_FUNC == "handle_requests") { thisModule.REQUIRED_NODE_MODULES.forEach(module => {
// Set reqhandler to the request handler for easy getting try {
reqhandler = global.modules[files[i].toString().replace(".js", "")]; 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++) { for (var i1 = 0; i1 < requiredModules.length; i1++) {
// Check if this module is a required module // Check if this module is a required module
if (global.modules[files[i].toString().replace(".js", "")].MOD_FUNC == requiredModules[i1].name) { if (thisModule.MOD_FUNC == requiredModules[i1].name) {
// It is a required module, set the status flag of this one to true // It is a required module, set the status of this one to true
requiredModules[i1].status = true; requiredModules[i1].status = true;
break;
} }
} }
} else { } 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.`) console.log(`[Modules] Found file ${files[i]}. It is not a module.`)
} }
} catch (err) { } catch (err) {
console.log(chalk.bgRed(` ! [Modules] There was an issue loading ${files[i]} ! `)); console.log(chalk.bgRed(chalk.black(` ! [Modules] There was an issue loading ${files[i]}`)));
console.log(chalk.bgRed(` ! [Modules] ${err} ! `)); console.log(chalk.bgRed(chalk.black(` ! [Modules] ${err}`)));
} }
} }
// Check if all the required modules flags are set // 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 // Make sure all required modules are found
if (allRequiredExist.length !== requiredModules.length) { if (allRequiredExist.length !== requiredModules.length) {
// Inform the user that not all required modules are found. // Inform the user that not all required modules are found.
console.log("[Modules] All required modules could not be found."); console.log(chalk.bgRed(chalk.black(" ! [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] Server will not start until all required modules are found. ")));
// They are not all found, exit Revolution with code 1. // They are not all found, exit Revolution with code 1.
process.exit(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 { } else {
// All required modules are found, start Revolution's server. // All required modules are found, start Revolution's server.
global.modules.consoleHelper.printInfo(emoji.wave, "Starting Revolution..."); global.modules.consoleHelper.printInfo(emoji.wave, "Starting Revolution...");

View file

@ -72,6 +72,8 @@ module.exports = {
module.exports.MOD_FUNC = MODULE_FUNCTION; 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. // Date returns numbers without a 0 in front of them of course so this adds them.
function correctValue(i) { function correctValue(i) {
if (i < 10) { if (i < 10) {

View file

@ -59,3 +59,5 @@ module.exports = {
} }
module.exports.MOD_FUNC = MODULE_FUNCTION; module.exports.MOD_FUNC = MODULE_FUNCTION;
module.exports.REQUIRED_NODE_MODULES = [];

View file

@ -1,16 +1,14 @@
{ {
"name": "revolution", "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", "version": "1.0.0",
"description": "",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {},
"test": "echo \"Error: no test specified\" && exit 1" "keywords": [],
},
"author": "", "author": "",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"chalk": "^2.4.2", "express": "^4.17.2",
"express": "^4.17.1", "chalk": "^4.1.2"
"http": "0.0.0"
} }
} }