app pre-translation support - espruino/BangleApps#136

Author: gfwilliams

js/appinfo.js

@@ -42,14 +42,53 @@ function toJS(txt) {
   return js;
 }
 
+// Translate any strings in the app that are prefixed with /*LANG*/
+// see https://github.com/espruino/BangleApps/issues/136
+function translateJS(options, app, code) {
+  var lex = Espruino.Core.Utils.getLexer(code);
+  var outjs = "";
+  var lastIdx = 0;
+  var tok = lex.next();
+  while (tok!==undefined) {
+    var previousString = code.substring(lastIdx, tok.startIdx);
+    var tokenString = code.substring(tok.startIdx, tok.endIdx);
+    if (tok.type=="STRING" && previousString.includes("/*LANG*/")) {
+      previousString=previousString.replace("/*LANG*/","");
+      var language = options.language;
+      if (language[app.id] && language[app.id][tok.value]) {
+        tokenString = JSON.stringify(language.GLOBAL[tok.value]);
+      } else if (language.GLOBAL[tok.value]) {
+        tokenString = JSON.stringify(language.GLOBAL[tok.value]);
+      } else {
+        // Unhandled translation...
+        //console.log("Untranslated ",tokenString);
+      }
+    }
+    outjs += previousString+tokenString;
+    lastIdx = tok.endIdx;
+    tok = lex.next();
+  }
+
+  /*console.log("==================== IN");
+  console.log(code);
+  console.log("==================== OUT");
+  console.log(outjs);*/
+  return outjs;
+}
+
 // Run JS through EspruinoTools to pull in modules/etc
-function parseJS(storageFile, options) {
+function parseJS(storageFile, options, app) {
   if (storageFile.url && storageFile.url.endsWith(".js") && !storageFile.url.endsWith(".min.js")) {
     // if original file ends in '.js'...
+    var js = storageFile.content;
+    // check for language translations
+    if (options.language)
+      js = translateJS(options, app, js);
+    // handle modules
     let localModulesURL = "modules";
     if (typeof window!=="undefined")
       localModulesURL = window.location.origin + window.location.pathname.replace(/[^/]*$/,"") + "modules";
-    return Espruino.transform(storageFile.content, {
+    return Espruino.transform(js, {
       SET_TIME_ON_WRITE : false,
       PRETOKENISE : options.settings.pretokenise,
       MODULE_URL : localModulesURL+"|https://www.espruino.com/modules",
@@ -69,6 +108,7 @@ var AppInfo = {
         fileGetter : callback for getting URL,
         settings : global settings object
         device : { id : ..., version : ... } info about the currently connected device
+        language : object of translations, eg 'lang/de_DE.json'
       }
       */
   getFiles : (app,options) => {
@@ -91,7 +131,7 @@ var AppInfo = {
 
       Promise.all(appFiles.map(storageFile => {
         if (storageFile.content!==undefined)
-          return Promise.resolve(storageFile).then(storageFile => parseJS(storageFile,options));
+          return Promise.resolve(storageFile).then(storageFile => parseJS(storageFile,options,app));
         else if (storageFile.url)
           return options.fileGetter(`apps/${app.id}/${storageFile.url}`).then(content => {
             return {
@@ -100,7 +140,7 @@ var AppInfo = {
               content : content,
               evaluate : storageFile.evaluate,
               noOverwrite : storageFile.noOverwrite
-            }}).then(storageFile => parseJS(storageFile,options));
+            }}).then(storageFile => parseJS(storageFile,options,app));
         else return Promise.resolve();
       })).then(fileContents => { // now we just have a list of files + contents...
         // filter out empty files

js/comms.js

@@ -57,11 +57,13 @@ const Comms = {
     /* app : an apps.json structure (i.e. with `storage`)
        options : { skipReset : bool, // don't reset first
                    device : { id : ..., version : ... } info about the currently connected device
+                   language : object of translations, eg 'lang/de_DE.json'
        } */
     Progress.show({title:`Uploading ${app.name}`,sticky:true});
     return AppInfo.getFiles(app, {
       fileGetter : httpGet,
       settings : SETTINGS,
+      language : options.language,
       device : options.device
     }).then(fileContents => {
       return new Promise((resolve,reject) => {

js/index.js

@@ -1,11 +1,11 @@
 let appJSON = []; // List of apps and info from apps.json
 let appSortInfo = {}; // list of data to sort by, from appdates.csv { created, modified }
 let files = []; // list of files on the Espruimo Device
-let DEFAULTSETTINGS = {
+const DEFAULTSETTINGS = {
   pretokenise : true,
   favourites : ["boot","launch","setting"]
 };
-let SETTINGS = JSON.parse(JSON.stringify(DEFAULTSETTINGS)); // clone
+var SETTINGS = JSON.parse(JSON.stringify(DEFAULTSETTINGS)); // clone
 
 let device = {
   id : undefined,     // The Espruino device ID of this device, eg. BANGLEJS
@@ -14,7 +14,23 @@ let device = {
   connected : false,   // are we connected via BLE right now?
   appsInstalled : []  // list of app {id,version} of installed apps
 };
-
+// FOR TESTING ONLY
+/*let LANGUAGE = {
+  "//":"German language translations",
+  "GLOBAL": {
+    "//":"Translations that apply for all apps",
+    "Alarm" : "Wecker",
+    "Hours" : "Stunden",
+    "Minutes" : "Minuten",
+    "Enabled" : "Aktiviert",
+    "Settings" : "Einstellungen"
+  },
+  "alarm": {
+    "//":"App-specific overrides",
+    "Alarm" : "Alarm"
+  }
+};*/
+var LANGUAGE = undefined;
 
 
 httpGet("apps.json").then(apps=>{
@@ -135,7 +151,7 @@ function handleCustomApp(appTemplate) {
         console.log("Received custom app", app);
         modal.remove();
         checkDependencies(app)
-          .then(()=>Comms.uploadApp(app,{device:device}))
+          .then(()=>Comms.uploadApp(app,{device:device, language:LANGUAGE}))
           .then(()=>{
             Progress.hide({sticky:true});
             resolve();
@@ -423,7 +439,7 @@ function uploadApp(app) {
       return updateApp(app);
     }
     checkDependencies(app)
-      .then(()=>Comms.uploadApp(app,{device:device}))
+      .then(()=>Comms.uploadApp(app,{device:device, language:LANGUAGE}))
       .then((appJSON) => {
         Progress.hide({ sticky: true });
         if (appJSON) {