From 62490834318c6a83cc6632a4320ab75fb2f70354 Mon Sep 17 00:00:00 2001
From: Nick O'Leary <nick.oleary@gmail.com>
Date: Fri, 8 May 2015 14:21:01 +0100
Subject: [PATCH] Extract all core runtime messages

---
 locales/en-US/runtime.json         | 64 +++++++++++++++++++++++++++---
 red/api/flows.js                   |  3 +-
 red/api/library.js                 |  9 +++--
 red/api/nodes.js                   |  4 +-
 red/comms.js                       |  8 ++--
 red/log.js                         |  4 ++
 red/nodes/credentials.js           |  5 ++-
 red/nodes/flows.js                 | 25 ++++++------
 red/nodes/registry/loader.js       |  2 +-
 red/red.js                         |  3 --
 red/server.js                      | 44 ++++++++++----------
 red/storage/localfilesystem.js     | 10 ++---
 test/red/nodes/credentials_spec.js |  6 +--
 13 files changed, 123 insertions(+), 64 deletions(-)

diff --git a/locales/en-US/runtime.json b/locales/en-US/runtime.json
index 5164883aa..72e7e3b44 100644
--- a/locales/en-US/runtime.json
+++ b/locales/en-US/runtime.json
@@ -6,8 +6,8 @@
             "settings": "Settings file  : __path__"
         }
     },
-        
-    "nodes": {
+    
+    "server": {
         "loading": "Loading palette nodes",
         "errors": "Failed to register __count__ node type",
         "errors_plural": "Failed to register __count__ node types",
@@ -28,10 +28,64 @@
             "uninstall-failed": "Uninstall failed",
             "uninstall-failed-long": "Uninstall of module __name__ failed:",
             "uninstalled": "Uninstalled module: __name__"
-            
-            
+        }
+    },
+    
+    "api": {
+        "flows": {
+            "error-save": "Error saving flows: __message__"
+        },
+        "library": {
+            "error-load-entry": "Error loading library entry '__path__': __message__",
+            "error-save-entry": "Error saving library entry '__path__': __message__",
+            "error-load-flow": "Error loading flow '__path__': __message__",
+            "error-save-flow": "Error saving flow '__path__': __message__"
+        },
+        "nodes": {
+            "enabled": "Enabled node types:",
+            "disabled": "Disabled node types:",
+            "error-enable": "Failed to enable node:"
+        }
+    },
+    
+    "comms": {
+        "error": "Communication channel error: __message__",
+        "error-server": "Communication server error: __message__",
+        "error-send": "Communication send error: __message__"
+    },
+    
+    "nodes": {
+        "credentials": {
+            "error":"Error loading credentials: __message__",
+            "not-registered": "Credential type '__type__' is not registered"
+        },
+        "flows": {
+            "registered-missing": "Missing type registered: __type__",
+            "error": "Error loading flows: __message__",
+            "starting-modified-nodes": "Starting modified nodes",
+            "starting-modified-flows": "Starting modified flows",
+            "starting-flows": "Starting flows",
+            "started-modified-nodes": "Started modified nodes",
+            "started-modified-flows": "Started modified flows",
+            "started-flows": "Started flows",
+            "stopping-modified-nodes": "Stopping modified nodes",
+            "stopping-modified-flows": "Stopping modified flows",
+            "stopping-flows": "Stopping flows",
+            "stopped-modified-nodes": "Stopped modified nodes",
+            "stopped-modified-flows": "Stopped modified flows",
+            "stopped-flows": "Stopped flows",
+            "stopped": "Stopped",
+            "missing-types": "Waiting for missing types to be registered:"
             
         }
-    }
+    },
     
+    "storage": {
+        "localfilesystem": {
+            "user-dir": "User directory : __path__",
+            "flows-file": "Flows file : __path__",
+            "create": "Creating new flow file"
+        }
+    }
+
 }
diff --git a/red/api/flows.js b/red/api/flows.js
index 1504c0f43..313cd02fc 100644
--- a/red/api/flows.js
+++ b/red/api/flows.js
@@ -15,6 +15,7 @@
  **/
 
 var log = require("../log");
+
 var redNodes = require("../nodes");
 var settings = require("../settings");
 
@@ -30,7 +31,7 @@ module.exports = {
         redNodes.setFlows(flows,deploymentType).then(function() {
             res.send(204);
         }).otherwise(function(err) {
-            log.warn("Error saving flows : "+err.message);
+            log.warn(log._("api.flows.error-save",{message:err.message}));
             log.warn(err.stack);
             res.json(500,{error:"unexpected_error", message:err.message});
         });
diff --git a/red/api/library.js b/red/api/library.js
index 1d0a2becf..e03f4bd56 100644
--- a/red/api/library.js
+++ b/red/api/library.js
@@ -17,6 +17,7 @@
 var redApp = null;
 var storage = require("../storage");
 var log = require("../log");
+
 var needsPermission = require("./auth").needsPermission;
 
 function createLibrary(type) {
@@ -34,7 +35,7 @@ function createLibrary(type) {
                 }
             }).otherwise(function(err) {
                 if (err) {
-                    log.warn("Error loading library entry '"+path+"' : "+err);
+                    log.warn(log._("api.library.error-load-entry",{path:path,message:err}));
                     if (err.message.indexOf('forbidden') === 0) {
                         log.audit({event: "library.get",type:type,error:"forbidden"},req);
                         res.send(403);
@@ -56,7 +57,7 @@ function createLibrary(type) {
                 log.audit({event: "library.set",type:type},req);
                 res.send(204);
             }).otherwise(function(err) {
-                log.warn("Error saving library entry '"+path+"' : "+err);
+                log.warn(log._("api.library.error-save-entry",{path:path,message:err}));
                 if (err.message.indexOf('forbidden') === 0) {
                     log.audit({event: "library.set",type:type,error:"forbidden"},req);
                     res.send(403);
@@ -88,7 +89,7 @@ module.exports = {
             res.send(data);
         }).otherwise(function(err) {
             if (err) {
-                log.warn("Error loading flow '"+req.params[0]+"' : "+err);
+                log.warn(log._("api.library.error-load-flow",{path:req.params[0],message:err}));
                 if (err.message.indexOf('forbidden') === 0) {
                     log.audit({event: "library.get",type:"flow",path:req.params[0],error:"forbidden"},req);
                     res.send(403);
@@ -105,7 +106,7 @@ module.exports = {
             log.audit({event: "library.set",type:"flow",path:req.params[0]},req);
             res.send(204);
         }).otherwise(function(err) {
-            log.warn("Error loading flow '"+req.params[0]+"' : "+err);
+            log.warn(log._("api.library.error-save-flow",{path:req.params[0],message:err}));
             if (err.message.indexOf('forbidden') === 0) {
                 log.audit({event: "library.set",type:"flow",path:req.params[0],error:"forbidden"},req);
                 res.send(403);
diff --git a/red/api/nodes.js b/red/api/nodes.js
index bed72fc8a..a71bc4413 100644
--- a/red/api/nodes.js
+++ b/red/api/nodes.js
@@ -226,12 +226,12 @@ function putNode(node, enabled) {
         return promise.then(function(info) {
             if (info.enabled === enabled && !info.err) {
                 comms.publish("node/"+(enabled?"enabled":"disabled"),info,false);
-                log.info(" "+(enabled?"Enabled":"Disabled")+" node types:");
+                log.info(" "+log._("api.nodes."+(enabled?"enabled":"disabled")));
                 for (var i=0;i<info.types.length;i++) {
                     log.info(" - "+info.types[i]);
                 }
             } else if (enabled && info.err) {
-                log.warn("Failed to enable node:");
+            log.warn(log._("api.nodes.error-enable"));
                 log.warn(" - "+info.name+" : "+info.err);
             }
             return info;
diff --git a/red/comms.js b/red/comms.js
index 086862806..55e4b80d4 100644
--- a/red/comms.js
+++ b/red/comms.js
@@ -65,7 +65,7 @@ function start() {
                     try {
                         msg = JSON.parse(data);
                     } catch(err) {
-                        log.warn("comms received malformed message : "+err.toString());
+                        log.trace("comms received malformed message : "+err.toString());
                         return;
                     }
                     if (!pendingAuth) {
@@ -119,12 +119,12 @@ function start() {
                     }
                 });
                 ws.on('error', function(err) {
-                    log.warn("comms error : "+err.toString());
+                    log.warn(log._("comms.error",{message:err.toString()}));
                 });
             });
             
             wsServer.on('error', function(err) {
-                log.warn("comms server error : "+err.toString());
+                log.warn(log._("comms.error-server",{message:err.toString()}));
             });
              
             lastSentTime = Date.now();
@@ -167,7 +167,7 @@ function publishTo(ws,topic,data) {
     try {
         ws.send(msg);
     } catch(err) {
-        log.warn("comms send error : "+err.toString());
+        log.warn(log._("comms.error-send",{message:err.toString()}));
     }
 }
 
diff --git a/red/log.js b/red/log.js
index 8906704fc..83d767d59 100644
--- a/red/log.js
+++ b/red/log.js
@@ -17,6 +17,8 @@
 var util = require("util");
 var EventEmitter = require("events").EventEmitter;
 
+var i18n = require("./i18n");
+
 var levels = {
     off:    1,
     fatal:  10,
@@ -143,3 +145,5 @@ var log = module.exports = {
         log.log(msg);
     }
 }
+
+log["_"] = i18n._;
diff --git a/red/nodes/credentials.js b/red/nodes/credentials.js
index c723b0749..d7e80a2d3 100644
--- a/red/nodes/credentials.js
+++ b/red/nodes/credentials.js
@@ -17,6 +17,7 @@
 var when = require("when");
 
 var log = require("../log");
+
 var needsPermission = require("../api/auth").needsPermission;
 
 var credentialCache = {};
@@ -75,7 +76,7 @@ module.exports = {
         return storage.getCredentials().then(function (creds) {
             credentialCache = creds;
         }).otherwise(function (err) {
-            log.warn("Error loading credentials : " + err);
+            log.warn(log._("nodes.credentials.error",{message: err}));
         });
     },
     
@@ -167,7 +168,7 @@ module.exports = {
             var dashedType = nodeType.replace(/\s+/g, '-');
             var definition = credentialsDef[dashedType];
             if (!definition) {
-                log.warn('Credential Type ' + nodeType + ' is not registered.');
+                log.warn(log._("nodes.credentials.not-registered",{type:nodeType}));
                 return;
             }
             
diff --git a/red/nodes/flows.js b/red/nodes/flows.js
index adf5903e1..475be1f25 100644
--- a/red/nodes/flows.js
+++ b/red/nodes/flows.js
@@ -21,6 +21,7 @@ var typeRegistry = require("./registry");
 var credentials = require("./credentials");
 var Flow = require("./Flow");
 var log = require("../log");
+
 var events = require("../events");
 var redUtil = require("../util");
 var storage = null;
@@ -36,7 +37,7 @@ var activeConfigNodes = {};
 
 events.on('type-registered',function(type) {
     if (activeFlow && activeFlow.typeRegistered(type)) {
-        log.info("Missing type registered: "+type);
+        log.info(log._("nodes.flows.registered-missing", {type:type}));
     }
 });
 
@@ -57,7 +58,7 @@ var flowNodes = module.exports = {
                 flowNodes.startFlows();
             });
         }).otherwise(function(err) {
-            log.warn("Error loading flows : "+err);
+            log.warn(log._("nodes.flows.error",{err:err}));
             console.log(err.stack);
         });
     },
@@ -132,21 +133,21 @@ var flowNodes = module.exports = {
     },
     startFlows: function(configDiff) {
         if (configDiff) {
-            log.info("Starting modified "+configDiff.type);
+            log.info(log._("nodes.flows.starting-modified-"+configDiff.type));
         } else {
-            log.info("Starting flows");
+            log.info(log._("nodes.flows.starting-flows"));
         }
         try {
             activeFlow.start(configDiff);
             if (configDiff) {
-                log.info("Started modified "+configDiff.type);
+                log.info(log._("nodes.flows.started-modified-"+configDiff.type));
             } else {
-                log.info("Started flows");
+                log.info(log._("nodes.flows.started-flows"));
             }
         } catch(err) {
             var missingTypes = activeFlow.getMissingTypes();
             if (missingTypes.length > 0) {
-                log.info("Waiting for missing types to be registered:");
+                log.info(log._("nodes.flows.missing-types"));
                 var knownUnknowns = 0;
                 for (var i=0;i<missingTypes.length;i++) {
                     var type = missingTypes[i];
@@ -169,21 +170,21 @@ var flowNodes = module.exports = {
     },
     stopFlows: function(configDiff) {
         if (configDiff) {
-            log.info("Stopping modified "+configDiff.type);
+            log.info(log._("nodes.flows.stopping-modified-"+configDiff.type));
         } else {
-            log.info("Stopping flows");
+            log.info(log._("nodes.flows.stopping-flows"));
         }
         if (activeFlow) {
             return activeFlow.stop(configDiff).then(function() {
                 if (configDiff) {
-                    log.info("Stopped modified "+configDiff.type);
+                    log.info(log._("nodes.flows.stopped-modified-"+configDiff.type));
                 } else {
-                    log.info("Stopped flows");
+                    log.info(log._("nodes.flows.stopped-flows"));
                 }
                 return;
             });
         } else {
-            log.info("Stopped");
+            log.info(log._("nodes.flows.stopped"));
             return;
         }
     },
diff --git a/red/nodes/registry/loader.js b/red/nodes/registry/loader.js
index d136c7a22..5bf7e1184 100644
--- a/red/nodes/registry/loader.js
+++ b/red/nodes/registry/loader.js
@@ -251,7 +251,7 @@ function loadNodeSet(node) {
             red["_"] = function() {
                 var args = Array.prototype.slice.call(arguments, 0);
                 args[0] = node.namespace+":"+args[0];
-                return red.i18n._.apply(null,args);
+                return i18n._.apply(null,args);
             }
             var promise = r(red);
             if (promise != null && typeof promise.then === "function") {
diff --git a/red/red.js b/red/red.js
index 53cd0891d..93208503e 100644
--- a/red/red.js
+++ b/red/red.js
@@ -57,7 +57,6 @@ var RED = {
     credentials: credentials,
     events: events,
     log: log,
-    i18n: i18n,
     comms: comms,
     settings:settings,
     util: util,
@@ -78,6 +77,4 @@ var RED = {
     get server() { return server.server }
 };
 
-//RED["_"] = i18n._;
-
 module.exports = RED;
diff --git a/red/server.js b/red/server.js
index 6fdb76524..9748f4a7e 100644
--- a/red/server.js
+++ b/red/server.js
@@ -58,12 +58,12 @@ function start() {
                     reportMetrics();
                 }, settings.runtimeMetricInterval||15000);
             }
-            console.log("\n\n"+i18n._("runtime.welcome")+"\n===================\n");
+            console.log("\n\n"+log._("runtime.welcome")+"\n===================\n");
             if (settings.version) {
-                log.info(i18n._("runtime.version",{component:"Node-RED",version:"v"+settings.version}));
+                log.info(log._("runtime.version",{component:"Node-RED",version:"v"+settings.version}));
             }
-            log.info(i18n._("runtime.version",{component:"Node.js ",version:process.version}));
-            log.info(i18n._("nodes.loading"));
+            log.info(log._("runtime.version",{component:"Node.js ",version:process.version}));
+            log.info(log._("server.loading"));
             redNodes.init(settings,storage,app);
             return redNodes.load().then(function() {
                     
@@ -77,13 +77,13 @@ function start() {
                             log.warn("["+nodeErrors[i].name+"] "+nodeErrors[i].err);
                         }
                     } else {
-                        log.warn(i18n._("nodes.errors",{count:nodeErrors.length}));
-                        log.warn(i18n._("nodes.errors-help"));
+                        log.warn(log._("server.errors",{count:nodeErrors.length}));
+                        log.warn(log._("server.errors-help"));
                     }
                     log.warn("------------------------------------------");
                 }
                 if (nodeMissing.length > 0) {
-                    log.warn(i18n._("nodes.missing-modules"));
+                    log.warn(log._("server.missing-modules"));
                     var missingModules = {};
                     for (i=0;i<nodeMissing.length;i++) {
                         var missing = nodeMissing[i];
@@ -102,11 +102,11 @@ function start() {
                         }
                     }
                     if (!settings.autoInstallModules) {
-                        log.info(i18n._("nodes.removing-modules"));
+                        log.info(log._("server.removing-modules"));
                         redNodes.cleanModuleList();
                     }
                 }
-                log.info(i18n._("runtime.paths.settings",{path:settings.settingsFile}));
+                log.info(log._("runtime.paths.settings",{path:settings.settingsFile}));
                 redNodes.loadFlows();
                 comms.start();
             }).otherwise(function(err) {
@@ -119,7 +119,7 @@ function start() {
 function reportAddedModules(info) {
     comms.publish("node/added",info.nodes,false);
     if (info.nodes.length > 0) {
-        log.info(i18n._("nodes.added-types"));
+        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(" - "+
@@ -135,7 +135,7 @@ function reportAddedModules(info) {
 
 function reportRemovedModules(removedNodes) {
     comms.publish("node/removed",removedNodes,false);
-    log.info(i18n._("nodes.removed-types"));
+    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]);
@@ -161,7 +161,7 @@ function installModule(module) {
     //TODO: ensure module is 'safe'
     return when.promise(function(resolve,reject) {
         if (/[\s;]/.test(module)) {
-            reject(new Error(i18n._("nodes.install.invalid")));
+            reject(new Error(log._("server.install.invalid")));
             return;
         }
         if (redNodes.getModuleInfo(module)) {
@@ -182,19 +182,19 @@ function installModule(module) {
                 if (err) {
                     var lookFor404 = new RegExp(" 404 .*"+module+"$","m");
                     if (lookFor404.test(stdout)) {
-                        log.warn(i18n._("nodes.install.install-failed-not-found",{name:module}));
+                        log.warn(log._("server.install.install-failed-not-found",{name:module}));
                         var e = new Error();
                         e.code = 404;
                         reject(e);
                     } else {
-                        log.warn(i18n._("nodes.install.install-failed-long",{name:module}));
+                        log.warn(log._("server.install.install-failed-long",{name:module}));
                         log.warn("------------------------------------------");
                         log.warn(err.toString());
                         log.warn("------------------------------------------");
-                        reject(new Error(i18n._("nodes.install.install-failed")));
+                        reject(new Error(log._("server.install.install-failed")));
                     }
                 } else {
-                    log.info(i18n._("nodes.install.installed",{name:module}));
+                    log.info(log._("server.install.installed",{name:module}));
                     resolve(redNodes.addModule(module).then(reportAddedModules));
                 }
             }
@@ -205,30 +205,30 @@ function installModule(module) {
 function uninstallModule(module) {
     return when.promise(function(resolve,reject) {
         if (/[\s;]/.test(module)) {
-            reject(new Error(i18n._("nodes.install.invalid")));
+            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);
         if (!fs.existsSync(moduleDir)) {
-            return reject(new Error(i18n._("nodes.install.uninstall-failed",{name:module})));
+            return reject(new Error(log._("server.install.uninstall-failed",{name:module})));
         }
 
         var list = redNodes.removeModule(module);
-        log.info(i18n._("nodes.install.uninstalling",{name:module}));
+        log.info(log._("server.install.uninstalling",{name:module}));
         var child = child_process.exec('npm remove '+module,
             {
                 cwd: installDir
             },
             function(err, stdin, stdout) {
                 if (err) {
-                    log.warn(i18n._("nodes.install.uninstall-failed-long",{name:module}));
+                    log.warn(log._("server.install.uninstall-failed-long",{name:module}));
                     log.warn("------------------------------------------");
                     log.warn(err.toString());
                     log.warn("------------------------------------------");
-                    reject(new Error(i18n._("nodes.install.uninstall-failed",{name:module})));
+                    reject(new Error(log._("server.install.uninstall-failed",{name:module})));
                 } else {
-                    log.info(i18n._("nodes.install.uninstalled",{name:module}));
+                    log.info(log._("server.install.uninstalled",{name:module}));
                     reportRemovedModules(list);
                     resolve(list);
                 }
diff --git a/red/storage/localfilesystem.js b/red/storage/localfilesystem.js
index c758ecd0e..f426bdc49 100644
--- a/red/storage/localfilesystem.js
+++ b/red/storage/localfilesystem.js
@@ -185,15 +185,15 @@ var localfilesystem = {
 
     getFlows: function() {
         return when.promise(function(resolve) {
-            log.info("User Directory : "+settings.userDir);
-            log.info("Flows file     : "+flowsFullPath);
+            log.info(log._("storage.localfilesystem.user-dir",{path:settings.userDir}));
+            log.info(log._("storage.localfilesystem.flows-file",{path:flowsFullPath}));
             fs.exists(flowsFullPath, function(exists) {
                 if (exists) {
                     resolve(nodeFn.call(fs.readFile,flowsFullPath,'utf8').then(function(data) {
                         return JSON.parse(data);
                     }));
                 } else {
-                    log.info("Creating new flows file");
+                    log.info(log._("storage.localfilesystem.create"));
                     resolve([]);
                 }
             });
@@ -257,7 +257,7 @@ var localfilesystem = {
                     try {
                         return JSON.parse(data);
                     } catch(err) {
-                        log.info("Corrupted config detected - resetting");
+                        log.trace("Corrupted config detected - resetting");
                         return {};
                     }
                 } else {
@@ -277,7 +277,7 @@ var localfilesystem = {
                     try {
                         return JSON.parse(data);
                     } catch(err) {
-                        log.info("Corrupted sessions file - resetting");
+                        log.trace("Corrupted sessions file - resetting");
                         return {};
                     }
                 } else {
diff --git a/test/red/nodes/credentials_spec.js b/test/red/nodes/credentials_spec.js
index 2fdc35c9b..e71863d86 100644
--- a/test/red/nodes/credentials_spec.js
+++ b/test/red/nodes/credentials_spec.js
@@ -29,7 +29,7 @@ var auth = require("../../../red/api/auth");
 
 
 describe('Credentials', function() {
-    
+        
     afterEach(function() {
         index.clearRegistry();
     });
@@ -156,7 +156,7 @@ describe('Credentials', function() {
         
         credentials.init(storage);
         credentials.load().then(function() {
-            logmsg.should.equal("Error loading credentials : test forcing failure");
+            log.warn.calledOnce.should.be.true;
             log.warn.restore();
             done();
         }).otherwise(function(err){
@@ -218,7 +218,7 @@ describe('Credentials', function() {
         index.loadFlows().then(function() {
             var testnode = new TestNode({id:'tab1',type:'test',name:'barney'});   
             credentials.extract(testnode);
-            should.equal(logmsg, 'Credential Type test is not registered.');
+            log.warn.calledOnce.should.be.true;
             log.warn.restore();
             done();
         }).otherwise(function(err){