/** * Copyright JS Foundation and other contributors, http://js.foundation * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. **/ var path = require("path"); var fs = require("fs"); var registry = require("./registry"); var library = require("./library"); var log; var exec; var events; var child_process = require('child_process'); var npmCommand = process.platform === 'win32' ? 'npm.cmd' : 'npm'; var paletteEditorEnabled = false; var settings; var moduleRe = /^(@[^/]+?[/])?[^/]+?$/; var slashRe = process.platform === "win32" ? /\\|[/]/ : /[/]/; function init(runtime) { events = runtime.events; settings = runtime.settings; log = runtime.log; exec = runtime.exec; } var activePromise = Promise.resolve(); function checkModulePath(folder) { var moduleName; var err; var fullPath = path.resolve(folder); var packageFile = path.join(fullPath,'package.json'); try { var pkg = require(packageFile); moduleName = pkg.name; if (!pkg['node-red']) { // TODO: nls err = new Error("Invalid Node-RED module"); err.code = 'invalid_module'; throw err; } } catch(err2) { err = new Error("Module not found"); err.code = 404; throw err; } return moduleName; } function checkExistingModule(module,version) { var info = registry.getModuleInfo(module); if (info) { if (!version || info.version === version) { var err = new Error("Module already loaded"); err.code = "module_already_loaded"; throw err; } return true; } return false; } function installModule(module,version) { activePromise = activePromise.then(() => { //TODO: ensure module is 'safe' return new Promise((resolve,reject) => { var installName = module; var isUpgrade = false; try { if (moduleRe.test(module)) { // Simple module name - assume it can be npm installed if (version) { installName += "@"+version; } } else if (slashRe.test(module)) { // A path - check if there's a valid package.json installName = module; module = checkModulePath(module); } isUpgrade = checkExistingModule(module,version); } catch(err) { return reject(err); } if (!isUpgrade) { log.info(log._("server.install.installing",{name: module,version: version||"latest"})); } else { log.info(log._("server.install.upgrading",{name: module,version: version||"latest"})); } var installDir = settings.userDir || process.env.NODE_RED_HOME || "."; var args = ['install','--save','--save-prefix="~"','--production',installName]; log.trace(npmCommand + JSON.stringify(args)); exec.run(npmCommand,args,{ cwd: installDir }, true).then(result => { if (!isUpgrade) { log.info(log._("server.install.installed",{name:module})); resolve(require("./index").addModule(module).then(reportAddedModules)); } else { log.info(log._("server.install.upgraded",{name:module, version:version})); events.emit("runtime-event",{id:"restart-required",payload:{type:"warning",text:"notification.warnings.restartRequired"},retain:true}); resolve(require("./registry").setModulePendingUpdated(module,version)); } }).catch(result => { var output = result.stderr; var e; var lookFor404 = new RegExp(" 404 .*"+module,"m"); var lookForVersionNotFound = new RegExp("version not found: "+module+"@"+version,"m"); if (lookFor404.test(output)) { log.warn(log._("server.install.install-failed-not-found",{name:module})); e = new Error("Module not found"); e.code = 404; reject(e); } else if (isUpgrade && lookForVersionNotFound.test(output)) { log.warn(log._("server.install.upgrade-failed-not-found",{name:module})); e = new Error("Module not found"); e.code = 404; reject(e); } else { log.warn(log._("server.install.install-failed-long",{name:module})); log.warn("------------------------------------------"); log.warn(output); log.warn("------------------------------------------"); reject(new Error(log._("server.install.install-failed"))); } }) }); }).catch(err => { // In case of error, reset activePromise to be resolvable activePromise = Promise.resolve(); throw err; }); return activePromise; } function reportAddedModules(info) { //comms.publish("node/added",info.nodes,false); if (info.nodes.length > 0) { log.info(log._("server.added-types")); for (var i=0;i<info.nodes.length;i++) { for (var j=0;j<info.nodes[i].types.length;j++) { log.info(" - "+ (info.nodes[i].module?info.nodes[i].module+":":"")+ info.nodes[i].types[j]+ (info.nodes[i].err?" : "+info.nodes[i].err:"") ); } } } return info; } function reportRemovedModules(removedNodes) { //comms.publish("node/removed",removedNodes,false); log.info(log._("server.removed-types")); for (var j=0;j<removedNodes.length;j++) { for (var i=0;i<removedNodes[j].types.length;i++) { log.info(" - "+(removedNodes[j].module?removedNodes[j].module+":":"")+removedNodes[j].types[i]); } } return removedNodes; } function uninstallModule(module) { activePromise = activePromise.then(() => { return new Promise((resolve,reject) => { if (/[\s;]/.test(module)) { reject(new Error(log._("server.install.invalid"))); return; } var installDir = settings.userDir || process.env.NODE_RED_HOME || "."; var moduleDir = path.join(installDir,"node_modules",module); try { fs.statSync(moduleDir); } catch(err) { return reject(new Error(log._("server.install.uninstall-failed",{name:module}))); } var list = registry.removeModule(module); log.info(log._("server.install.uninstalling",{name:module})); var args = ['remove','--save',module]; log.trace(npmCommand + JSON.stringify(args)); exec.run(npmCommand,args,{ cwd: installDir, },true).then(result => { log.info(log._("server.install.uninstalled",{name:module})); reportRemovedModules(list); library.removeExamplesDir(module); resolve(list); }).catch(result => { var output = result.stderr; log.warn(log._("server.install.uninstall-failed-long",{name:module})); log.warn("------------------------------------------"); log.warn(output.toString()); log.warn("------------------------------------------"); reject(new Error(log._("server.install.uninstall-failed",{name:module}))); }); }); }).catch(err => { // In case of error, reset activePromise to be resolvable activePromise = Promise.resolve(); throw err; }); return activePromise; } function checkPrereq() { if (settings.hasOwnProperty('editorTheme') && settings.editorTheme.hasOwnProperty('palette') && settings.editorTheme.palette.hasOwnProperty('editable') && settings.editorTheme.palette.editable === false ) { log.info(log._("server.palette-editor.disabled")); paletteEditorEnabled = false; return Promise.resolve(); } else { return new Promise(resolve => { child_process.execFile(npmCommand,['-v'],function(err,stdout) { if (err) { log.info(log._("server.palette-editor.npm-not-found")); paletteEditorEnabled = false; } else { if (parseInt(stdout.split(".")[0]) < 3) { log.info(log._("server.palette-editor.npm-too-old")); paletteEditorEnabled = false; } else { paletteEditorEnabled = true; } } resolve(); }); }) } } module.exports = { init: init, checkPrereq: checkPrereq, installModule: installModule, uninstallModule: uninstallModule, paletteEditorEnabled: function() { return paletteEditorEnabled } }