The Tor Browser: addon-sdk/source/test/test-l10n-locale.js@ac0c01689b40 (annotated)

addon-sdk/source/test/test-l10n-locale.js@ac0c01689b40 (annotated)

addon-sdk/source/test/test-l10n-locale.js

Thu, 15 Jan 2015 15:59:08 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 15 Jan 2015 15:59:08 +0100
branch: TOR_BUG_9701
changeset 10: ac0c01689b40
permissions: -rw-r--r--

Implement a real Private Browsing Mode condition by changing the API/ABI;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 const { getPreferedLocales, findClosestLocale } = require("sdk/l10n/locale");
 const prefs = require("sdk/preferences/service");
 const { Cc, Ci, Cu } = require("chrome");
 const { Services } = Cu.import("resource://gre/modules/Services.jsm");
 const BundleService = Cc["@mozilla.org/intl/stringbundle;1"].getService(Ci.nsIStringBundleService);
 const PREF_MATCH_OS_LOCALE  = "intl.locale.matchOS";
 const PREF_SELECTED_LOCALE  = "general.useragent.locale";
 const PREF_ACCEPT_LANGUAGES = "intl.accept_languages";
 function assertPrefered(assert, expected, msg) {
   assert.equal(JSON.stringify(getPreferedLocales()), JSON.stringify(expected),
                    msg);
 }
 exports.testGetPreferedLocales = function(assert) {
   prefs.set(PREF_MATCH_OS_LOCALE, false);
   prefs.set(PREF_SELECTED_LOCALE, "");
   prefs.set(PREF_ACCEPT_LANGUAGES, "");
   assertPrefered(assert, ["en-us"],
                  "When all preferences are empty, we only have en-us");
   prefs.set(PREF_SELECTED_LOCALE, "fr");
   prefs.set(PREF_ACCEPT_LANGUAGES, "jp");
   assertPrefered(assert, ["fr", "jp", "en-us"],
                  "We first have useragent locale, then web one and finally en-US");
   prefs.set(PREF_SELECTED_LOCALE, "en-US");
   prefs.set(PREF_ACCEPT_LANGUAGES, "en-US");
   assertPrefered(assert, ["en-us"],
                  "We do not have duplicates");
   prefs.set(PREF_SELECTED_LOCALE, "en-US");
   prefs.set(PREF_ACCEPT_LANGUAGES, "fr");
   assertPrefered(assert, ["en-us", "fr"],
                  "en-US can be first if specified by higher priority preference");
   // Reset what we changed
   prefs.reset(PREF_MATCH_OS_LOCALE);
   prefs.reset(PREF_SELECTED_LOCALE);
   prefs.reset(PREF_ACCEPT_LANGUAGES);
 }
 // In some cases, mainly on Fennec and on Linux version,
 // `general.useragent.locale` is a special 'localized' value, like:
 // "chrome://global/locale/intl.properties"
 exports.testPreferedLocalizedLocale = function(assert) {
   prefs.set(PREF_MATCH_OS_LOCALE, false);
   let bundleURL = "chrome://global/locale/intl.properties";
   prefs.setLocalized(PREF_SELECTED_LOCALE, bundleURL);
   let contentLocale = "ja";
   prefs.set(PREF_ACCEPT_LANGUAGES, contentLocale);
   // Read manually the expected locale value from the property file
   let expectedLocale = BundleService.createBundle(bundleURL).
     GetStringFromName(PREF_SELECTED_LOCALE).
     toLowerCase();
   // First add the useragent locale
   let expectedLocaleList = [expectedLocale];
   // Then the content locale
   if (expectedLocaleList.indexOf(contentLocale) == -1)
     expectedLocaleList.push(contentLocale);
   // Add default "en-us" fallback if the main language is not already en-us
   if (expectedLocaleList.indexOf("en-us") == -1)
     expectedLocaleList.push("en-us");
   assertPrefered(assert, expectedLocaleList, "test localized pref value");
   // Reset what we have changed
   prefs.reset(PREF_MATCH_OS_LOCALE);
   prefs.reset(PREF_SELECTED_LOCALE);
   prefs.reset(PREF_ACCEPT_LANGUAGES);
 }
 exports.testPreferedOsLocale = function(assert) {
   prefs.set(PREF_MATCH_OS_LOCALE, true);
   prefs.set(PREF_SELECTED_LOCALE, "");
   prefs.set(PREF_ACCEPT_LANGUAGES, "");
   let expectedLocale = Services.locale.getLocaleComponentForUserAgent().
     toLowerCase();
   let expectedLocaleList = [expectedLocale];
   // Add default "en-us" fallback if the main language is not already en-us
   if (expectedLocale != "en-us")
     expectedLocaleList.push("en-us");
   assertPrefered(assert, expectedLocaleList, "Ensure that we select OS locale when related preference is set");
   // Reset what we have changed
   prefs.reset(PREF_MATCH_OS_LOCALE);
   prefs.reset(PREF_SELECTED_LOCALE);
   prefs.reset(PREF_ACCEPT_LANGUAGES);
 }
 exports.testFindClosestLocale = function(assert) {
   // Second param of findClosestLocale (aMatchLocales) have to be in lowercase
   assert.equal(findClosestLocale([], []), null,
                    "When everything is empty we get null");
   assert.equal(findClosestLocale(["en", "en-US"], ["en"]),
                    "en", "We always accept exact match first 1/5");
   assert.equal(findClosestLocale(["en-US", "en"], ["en"]),
                    "en", "We always accept exact match first 2/5");
   assert.equal(findClosestLocale(["en", "en-US"], ["en-us"]),
                    "en-US", "We always accept exact match first 3/5");
   assert.equal(findClosestLocale(["ja-JP-mac", "ja", "ja-JP"], ["ja-jp"]),
                    "ja-JP", "We always accept exact match first 4/5");
   assert.equal(findClosestLocale(["ja-JP-mac", "ja", "ja-JP"], ["ja-jp-mac"]),
                    "ja-JP-mac", "We always accept exact match first 5/5");
   assert.equal(findClosestLocale(["en", "en-GB"], ["en-us"]),
                    "en", "We accept more generic locale, when there is no exact match 1/2");
   assert.equal(findClosestLocale(["en-ZA", "en"], ["en-gb"]),
                    "en", "We accept more generic locale, when there is no exact match 2/2");
   assert.equal(findClosestLocale(["ja-JP"], ["ja"]),
                    "ja-JP", "We accept more specialized locale, when there is no exact match 1/2");
   // Better to select "ja" in this case but behave same as current AddonManager
   assert.equal(findClosestLocale(["ja-JP-mac", "ja"], ["ja-jp"]),
                    "ja-JP-mac", "We accept more specialized locale, when there is no exact match 2/2");
   assert.equal(findClosestLocale(["en-US"], ["en-us"]),
                    "en-US", "We keep the original one as result 1/2");
   assert.equal(findClosestLocale(["en-us"], ["en-us"]),
                    "en-us", "We keep the original one as result 2/2");
   assert.equal(findClosestLocale(["ja-JP-mac"], ["ja-jp-mac"]),
                    "ja-JP-mac", "We accept locale with 3 parts");
   assert.equal(findClosestLocale(["ja-JP"], ["ja-jp-mac"]),
                    "ja-JP", "We accept locale with 2 parts from locale with 3 parts");
   assert.equal(findClosestLocale(["ja"], ["ja-jp-mac"]),
                    "ja", "We accept locale with 1 part from locale with 3 parts");
 };
 require('sdk/test').run(exports);