GET /api/getFactorioLocale now returns entire base en locale

lib/getFactorioLocale.js

@@ -0,0 +1,29 @@
+const fs = require("fs");
+const ini = require("ini");
+
+function getLocale(factorioDirectory, languageCode, callback){
+	var localeFile = factorioDirectory + '/data/base/locale/' + languageCode + '/base.cfg';
+	fs.readFile(localeFile, "utf8", (err, rawLocale) => {
+		callback(err, rawLocale);
+	});
+}
+
+function getLocaleAsObject(factorioDirectory, languageCode, callback){
+	if(typeof factorioDirectory != "string" || typeof languageCode != "string" || typeof callback != "function"){
+		throw "Error: wrong parameters provided";
+	}
+	getLocale(factorioDirectory, languageCode, (err, rawLocale) => {
+		if(err){
+			callback(err);
+		} else {
+			let processedLocale = ini.parse(rawLocale)
+			callback(undefined, processedLocale);
+		}
+	});
+}
+
+module.exports = {
+	asObject: getLocaleAsObject,
+}
+
+

lib/getFactorioLocale.spec.js

@@ -0,0 +1,74 @@
+const assert = require("assert");
+const getFactorioLocale = require("./getFactorioLocale");
+
+describe("getFactorioLocale.js", () => {
+	describe("asObject()", () => {
+		it("requires 2 strings and a function as parameters", () => {
+			let validate = (err) => {
+				return err == "Error: wrong parameters provided"
+			}
+			let message = "getFactorioLocale is responding incorrectly to invalid arguments"
+			let callback = (err,object) => true;
+			
+			assert.throws(() => getFactorioLocale.asObject(), validate, message);
+			assert.throws(() => getFactorioLocale.asObject("hello", "I forgot my callback"), validate, message);
+			assert.throws(() => getFactorioLocale.asObject(undefined, undefined, callback), validate, message);
+			
+			// the proper way to do it
+			assert.doesNotThrow(() => getFactorioLocale.asObject("factorio_0.15.27", "en", callback), validate, message);
+		});
+		it("returns a nested object with base game locale information", (done) => {
+			getFactorioLocale.asObject("factorio", "en", callback);
+			
+			function callback(err, object){
+				assert.equal(typeof object, "object");
+				assert.equal(object["entity-name"]["fish"], "Fish");
+				assert.equal(object["entity-name"]["small-lamp"], "Lamp");
+				Object.keys(object).forEach(key => {
+					// first level of the nested object is always an object
+					assert.equal(typeof object[key], "object");
+					
+					Object.keys(object[key]).forEach(key2 => {
+						// second level of the nested object is always a string, nearly always truthy
+						if(key2 != "so-long-and-thanks-for-all-the-fish"){
+							assert.ok(object[key][key2]);
+							assert.equal(typeof object[key][key2], "string");
+						}
+					});
+				});
+				done();
+			}
+		});
+		it("has some duplicate keys", (done) => {
+			getFactorioLocale.asObject("factorio", "en", callback);
+			
+			function callback(err, object){
+				let arrayOfKeys = [];
+				// collect all keys in a single array
+				Object.keys(object).forEach(key => {
+					arrayOfKeys.push(key);
+					Object.keys(object[key]).forEach(key2 => {
+						arrayOfKeys.push(key2);
+					});
+				});
+				
+				// check for duplicates
+				let duplicateKeys = [];
+				let i = 0;
+				arrayOfKeys.forEach(key => {
+					let o = 0;
+					arrayOfKeys.forEach(key2 => {
+						if(i != o && key == key2){
+							duplicateKeys.push(key);
+						}
+						o++
+					});
+					i++;
+				});
+				// we got 704 but this is a very unexact number
+				assert(duplicateKeys.length > 10)
+				done();
+			}
+		});
+	});
+});

master.js

@@ -2,7 +2,11 @@
 debug = false;
 
 // constants
-const masterModFolder = "./database/masterMods/"
+const masterModFolder = "./database/masterMods/";
+var config = require('./config');
+
+// homebrew modules
+const getFactorioLocale = require("./lib/getFactorioLocale");
 
 // Library for create folder recursively if it does not exist
 const mkdirp = require("mkdirp");
@@ -12,8 +16,6 @@ const deepmerge = require("deepmerge");
 const path = require("path");
 const fs = require("fs");
 var nedb = require("nedb");
-// require config.json
-var config = require('./config');
 
 var express = require("express");
 var ejs = require("ejs");
@@ -305,6 +307,9 @@ app.post("/api/getStats", function(req,res) {
 		});
 	}
 });
+app.get("/api/getFactorioLocale", function(req,res){
+	getFactorioLocale.asObject(config.factorioDirectory, "en", (err, factorioLocale) => res.send(factorioLocale));
+});
 
 // endpoint for getting the chartjs library
 app.get("/chart.js", function(req, res) {

package-lock.json

@@ -720,6 +720,11 @@
       "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
       "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4="
     },
+    "ini": {
+      "version": "1.3.4",
+      "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.4.tgz",
+      "integrity": "sha1-BTfLedr1m1mhpRff9wbIbsA5Fi4="
+    },
     "inline-process-browser": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/inline-process-browser/-/inline-process-browser-1.0.0.tgz",

package.json

@@ -29,6 +29,7 @@
     "fs-extra": "^1.0.0",
     "getmac": "^1.2.1",
     "hash-files": "^1.1.1",
+    "ini": "^1.3.4",
     "luamin": "^1.0.4",
     "mkdirp": "^0.5.1",
     "ncp": "^2.0.0",