Issue 5028 - Use browser namespace

polyfill.js

+/*
+ * This file is part of Adblock Plus <https://adblockplus.org/>,
+ * Copyright (C) 2006-present eyeo GmbH
+ *
+ * Adblock Plus is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * Adblock Plus is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+"use strict";

[saroyanm, 2017/10/17 12:13:58]

While this polyfill file will be only used in the test environment and we want
to overwrite this file during the build, I'll suggest to move it under
ext/polyfill.js as it's described in the Readme See ->
https://hg.adblockplus.org/adblockplusui/file/tip/README.md#l29 otherwise we
might want to update Readme accordingly.

As far as I can see pollyfill.js in adblockpluschrome repository is being used
in the root directory instead of "ext" ->
https://codereview.adblockplus.org/29570614/ I'm not sure whether it was
intentional or not, so depending on that we might want to move pollyfill in both
repositories into "ext" folder to make it consistent with other implementations
"ext/background.js", "ext/common.js" and etc. or we might want to make a note
about pollyfill.js in the Readme.

In case I'm not missing something.

[Manish Jethani, 2017/10/17 12:19:50]

Hmm ... ext/ was supposed to have the ext namespace, while we're moving away
from it to use the standard browser extension APIs. At the same time, it does
make sense to separate out files that will be overwritten by product-specific
versions. We could make an exception for polyfill.js here, considering it to be
a special file, and update the README accordingly, or we could move it to ext/

Sebastian, what do you think?

[Manish Jethani, 2017/10/17 12:38:17]

So I see that there are a few top-level files that are also not to be imported,
like background.js, subscriptions.xml, and so on. In that case the decision is
easier. Let's keep pollfill.js where it is and just update the README file, in
my opinion.

Done.

[saroyanm, 2017/10/17 12:41:12]

I agree

+
+(function()
+{
+  window.browser = {};
+
+  /* I18n */
+
+  let getLocaleCandidates = function(selectedLocale)
+  {
+    let candidates = [];
+    let defaultLocale = "en_US";
+
+    // e.g. "ja-jp-mac" -> "ja_JP", note that the part after the second
+    // dash is dropped, since we only support language and region
+    let parts = selectedLocale.split("-");
+    let language = parts[0];
+    let region = (parts[1] || "").toUpperCase();
+
+    if (region)
+      candidates.push(language + "_" + region);
+
+    candidates.push(language);
+
+    if (candidates.indexOf(defaultLocale) == -1)
+      candidates.push(defaultLocale);
+
+    return candidates;
+  };
+
+  let selectedLocale = window.navigator.language;
+  let match = /[?&]locale=([\w-]+)/.exec(window.location.search);
+  if (match)
+    selectedLocale = match[1];
+
+  let locales = getLocaleCandidates(selectedLocale);
+  let catalog = Object.create(null);
+  let catalogFile = window.location.pathname.replace(/.*\//, "")
+    .replace(/\..*/, "") + ".json";
+
+  let replacePlaceholder = function(text, placeholder, content)
+  {
+    return text.split("$" + placeholder + "$").join(content || "");
+  };
+
+  let parseMessage = function(rawMessage)
+  {
+    let text = rawMessage.message;
+    let placeholders = [];
+
+    for (let placeholder in rawMessage.placeholders)
+    {
+      let {content} = rawMessage.placeholders[placeholder];
+
+      if (/^\$\d+$/.test(content))
+        placeholders[parseInt(content.substr(1), 10) - 1] = placeholder;
+      else
+        text = replacePlaceholder(text, placeholder, content);
+    }
+
+    return [text, placeholders];
+  };
+
+  let readCatalog = function(locale, file)
+  {
+    let xhr = new XMLHttpRequest();
+    xhr.open("GET", "locale/" + locale + "/" + file, false);
+    xhr.overrideMimeType("text/plain");
+
+    try
+    {
+      xhr.send();
+    }
+    catch (e)
+    {
+      return;
+    }
+
+    if (xhr.status != 200 && xhr.status != 0)
+      return;
+
+    let rawCatalog = JSON.parse(xhr.responseText);
+    for (let msgId in rawCatalog)
+    {
+      if (!(msgId in catalog))
+        catalog[msgId] = parseMessage(rawCatalog[msgId]);
+    }
+  };
+
+  browser.i18n = {
+    getUILanguage()
+    {
+      return locales[0].replace(/_/g, "-");
+    },
+    getMessage(msgId, substitutions)
+    {
+      while (true)
+      {
+        let message = catalog[msgId];
+        if (message)
+        {
+          let text = message[0];
+          let placeholders = message[1];
+
+          if (!(substitutions instanceof Array))
+            substitutions = [substitutions];
+
+          for (let i = 0; i < placeholders.length; i++)
+            text = replacePlaceholder(text, placeholders[i], substitutions[i]);
+
+          return text;
+        }
+
+        if (locales.length == 0)
+          return "";
+
+        let locale = locales.shift();
+        readCatalog(locale, "common.json");
+        readCatalog(locale, catalogFile);
+      }
+    }
+  };
+}());