Change add-on to be independent on system language

Builtin root node names "Bookmarks bar" and "Other bookmarks" assumed
to always be in english. This fixes #2

Author: 1nfiniteloop

bookmark/BookmarkFormatterV2.js

@@ -1,38 +1,14 @@
 import { Bookmark } from "./Bookmark.js";
+import { BuiltinBookmark } from "./BuiltinBookmark.js";
 
 export class BookmarkFormatterV2
 {
-  #mapping = {
-    "Firefox": {
-      "Bookmarks Menu" : "${BOOKMARKS_MENU}",
-      "Bookmarks Toolbar": "${BOOKMARKS_BAR}"
-    },
-    "Chrome": {
-      "Other bookmarks" : "${BOOKMARKS_MENU}",
-      "Bookmarks bar": "${BOOKMARKS_BAR}",
-    }
-  };
-
-  #mappingIn = {};
-  #mappingOut = {};
-
+  #builtinBookmark = new BuiltinBookmark();
   #version = 2;
 
-  constructor()
-  {
-    const mapping = this.#mapping[BROWSER_VENDOR];
-    this.#mappingOut = mapping;
-    this.#mappingIn = this.#reverseMappingOf(mapping);
-  }
-
-  #reverseMappingOf(mapping)
+  async init()
   {
-    let reverse = {};
-    for (let key of Object.keys(mapping))
-    {
-      reverse[mapping[key]] = key;
-    }
-    return reverse;
+    await this.#builtinBookmark.init();
   }
 
   read(rawJson)
@@ -72,13 +48,11 @@ export class BookmarkFormatterV2
 
   #expandRootNodeIn(path)
   {
-    let key = path[1];
-    path[1] = this.#mappingIn[key];
+    path[1] = this.#builtinBookmark.expand(path[1]);
   }
 
   #substituteRootNodeIn(path)
   {
-    let key = path[1];
-    path[1] = this.#mappingOut[key];
+    path[1] = this.#builtinBookmark.substitute(path[1]);
   }
 }

bookmark/BookmarkImporter.js

@@ -85,12 +85,12 @@ export class BookmarkImporter
     const key = path.join("/");
     if (key in this.#cachedLeafNode)
     {
-      console.debug("Using cached path: " + path);
+      console.debug(`Using cached path: ${key}`);
       return this.#cachedLeafNode[key];
     }
     else
     {
-      console.debug("Walking tree to find path: " + path);
+      console.debug(`Walking tree to find path: ${key}`);
       const folder = await this.#getOrCreatePath(path);
       this.#cachedLeafNode[key] = folder;
       return folder;

bookmark/BookmarkTreeImport.js

@@ -47,11 +47,12 @@ export class BookmarkTreeImport
     let key = path.join("/");
     if (key in this.#cachedPaths)
     {
-      console.debug("Using cached path: " + path);
+      console.debug(`Using cached path: ${key}`);
       return this.#cachedPaths[key];
     }
     else
     {
+      console.debug(`Parsing path: ${key}`);
       let leafNode = this.#getOrCreatePath(path);
       this.#cachedPaths[key] = leafNode;
       return leafNode;
@@ -60,7 +61,6 @@ export class BookmarkTreeImport
 
   #getOrCreatePath(path)
   {
-    console.debug("Parsing path: " + path);
     let root = this.#elementRoot.querySelector("ul");
     if (root == null)
     {

bookmark/BrowserVendor.js

@@ -1,14 +1,16 @@
 // Global
+const BROWSER_FIREFOX = "Firefox";
+const BROWSER_CHROME = "Chrome";
 var BROWSER_VENDOR = "undefined";
 
 if (typeof chrome !== "undefined")
 {
   if (typeof browser !== "undefined")
   {
-    BROWSER_VENDOR = "Firefox";
+    BROWSER_VENDOR = BROWSER_FIREFOX;
   }
   else
   {
-    BROWSER_VENDOR = "Chrome";
+    BROWSER_VENDOR = BROWSER_CHROME;
   }
 }

bookmark/BuiltinBookmark.js

@@ -0,0 +1,86 @@
+/**
+ * The two built-in root node's name differs between Firefox and Chrome, and
+ * also depend on the system language. In english the names is:
+ *
+ * - "Bookmarks Toolbar" in Mozilla Firefox and "Bookmarks bar" in Chrome,
+ *   which is substituted with "${BOOKMARKS_BAR}".
+ * - "Bookmarks Menu" in Mozilla Firefox and "Other bookmarks" in Chrome,
+ *   which is substituted with "${BOOKMARKS_MENU}".
+ */
+export class BuiltinBookmark
+{
+  #mapping = {};
+  #mappingReverse = {};
+
+  async init()
+  {
+    this.#createMappingFor(
+      await this.#getBookmarkNameFrom(this.#getNodeIdForBookmarksBar()),
+      "${BOOKMARKS_BAR}");
+    this.#createMappingFor(
+      await this.#getBookmarkNameFrom(this.#getNodeIdForBookmarksMenu()),
+      "${BOOKMARKS_MENU}");
+  }
+
+  substitute(name)
+  {
+    return this.#mapping[name];
+  }
+
+  expand(substitutedName)
+  {
+    return this.#mappingReverse[substitutedName];
+  }
+
+  #createMappingFor(name, substitutedName)
+  {
+    console.debug(`Create mapping for \"${name}\" : ${substitutedName}`);
+    this.#mapping[name] = substitutedName;
+    this.#mappingReverse[substitutedName] = name;
+  }
+
+  async #getBookmarkNameFrom(id)
+  {
+    const bookmarkNode = await browser.bookmarks.get(id);
+    if (bookmarkNode.length == 1)
+    {
+      return bookmarkNode[0].title;
+    }
+    else
+    {
+      throw `Failed to find bookmark root node with id: ${id}`;
+    }
+  }
+
+  #getNodeIdForBookmarksBar()
+  {
+    if (BROWSER_VENDOR == BROWSER_FIREFOX)
+    {
+      return "toolbar_____";
+    }
+    else if (BROWSER_VENDOR == BROWSER_CHROME)
+    {
+      return "1";
+    }
+    else
+    {
+      throw `Unsupported browser vendor: ${BROWSER_VENDOR}`
+    }
+  }
+
+  #getNodeIdForBookmarksMenu()
+  {
+    if (BROWSER_VENDOR == BROWSER_FIREFOX)
+    {
+      return "menu________";
+    }
+    else if (BROWSER_VENDOR == BROWSER_CHROME)
+    {
+      return "2";
+    }
+    else
+    {
+      throw `Unsupported browser vendor: ${BROWSER_VENDOR}`;
+    }
+  }
+}

bookmark/TabViewExport.js

@@ -39,14 +39,15 @@ export class TabViewExport
     this.#bookmarkTree = null;
   }
 
-  #exportBookmarks()
+  async #exportBookmarks()
   {
     if (this.#tree && this.#bookmarkTree)
     {
       const exporter = new BookmarkExporter();
       exporter.setBookmarkTree(this.#bookmarkTree)
       exporter.setSelection(this.#tree.getSelectedBookmarksId());
       let formatter = new BookmarkFormatterV2();
+      await formatter.init();
       let bookmarks = formatter.write(exporter.export());
       let fileWriter = new BookmarkFile();
       fileWriter.setVersion(formatter.getVersion());

bookmark/TabViewImport.js

@@ -36,7 +36,8 @@ export class TabViewImport
     await this.#fileReader.load();
     this.#tree = new BookmarkTreeImport();
     this.#tree.setElementRoot(document.getElementById(this.#containerId));
-    this.#tree.setBookmarks(this.#getLoadedBookmarks());
+    const loadedBookmarks = await this.#getLoadedBookmarks();
+    this.#tree.setBookmarks(loadedBookmarks);
     this.#tree.render();
   }
 
@@ -55,7 +56,8 @@ export class TabViewImport
     importer.setSelection(selectedBookmarks);
     try
     {
-      await importer.import(this.#getLoadedBookmarks());
+      const loadedBookmarks = await this.#getLoadedBookmarks();
+      await importer.import(loadedBookmarks);
       const statistics = importer.getImportedStatistics();
       this.#showImportedStatus(
         statistics.newBookmarks,
@@ -67,12 +69,12 @@ export class TabViewImport
     }
   }
 
-  #getLoadedBookmarks()
+  async #getLoadedBookmarks()
   {
     const version = this.#fileReader.getVersion();
     const formatter = {
       "1": new BookmarkFormatterV1(),
-      "2": new BookmarkFormatterV2(),
+      "2": await this.#newBookmarkFormatterV2(),
     };
     if (version in formatter)
     {
@@ -85,6 +87,13 @@ export class TabViewImport
     }
   }
 
+  async #newBookmarkFormatterV2()
+  {
+    const formatter = new BookmarkFormatterV2();
+    await formatter.init();
+    return formatter;
+  }
+
   #showImportedStatus(newBookmarks, existingBookmarks)
   {
     const type = "success";