Switch locale system to browser.i18n

[jrrdev]

Changelog

Based on myrdd/feature/we-i18n branch Fixes Issue #873:

• [x] issue #876: convert *.properties to message.json files
• [x] move RPC description localization from install.rdf to the WE i18n json files
• [x] extend the gulpfile.js to create the INSTALL_RDF_I18N string for install.rdf by parsing the i18n json files.
• [x] implement a fake browser.i18n.getMessage() function
• [x] replace all usages of StringUtils.$str() by browser.i18n.getMessage()
• [x] check if everything works ;)
• [x] remove all *.properties files
• [x] retrieve default_locale from manifest.json

Notes

• Chrome browser only supports locales listed here. Firefox i18n documentation isn't very precise about this, but after looking at Mozilla's i18n code, I think any valid BCP 47 tag should work. For instance fr_CA (Canadian french) or zh_cmn_Hans_CN(Chinese, Mandarin, Simplified script, as used in China) should work if the corresponding directory exists in _locales/. Thus, I made the FakeAPI to support any valid BCP 47 tag as well.
• I changed some keys in messages.json (like rp.menu.foo) because they weren't i18n compliant. The message key format is described here
• For the moment, default_locale is hard coded to en_US. I will try to retrieve it from manifest.json later (should be easy with existing manifest.js)
• About licensing:
  • chrome-files.js and locale-data.js are released under MPL-2.0 because it use some code from Mozilla
  • l10n.js is released under MIT License (from https://github.com/piroor/webextensions-lib-l10n)
  • Other files are released under GPL because it is brand new code. LocaleManager serves the same purpose as some code from Mozilla's Extension.jsm (locales loading) but logics and implementation are completely different.

Future enhancements proposals

Some proposals to consider when we will have some spare time (I guess after WE transition):

• Add locale message for some hard-coded text (e.g old_rules.html, experimental.html)
• Enhance make check-locales to give informations about missing translated keys for each language in comparison to default locale (for instance, I noticed some missing keys in fr/messages.json)

Are they relevant ? What do you think about it ?

Tests

• make lint => OK
• make mocha => OK

I performed manual tests on Firefox ESR 52.5.1 Nightly and Firefox 56.0b12 Developer Edition. OS Language was fr_FR (Ubuntu 16.04 32 bits):

$ locale
LANG=fr_FR.UTF-8
LANGUAGE=fr_FR

• Popup content is properly localized:
  • Main origin entry && corresponding right menu
  • Others origins entries && corresponding right menu
  • Allowed targets entries && corresponding right menu
  • Denied targets entries && corresponding right menu
  • Revoke temporary permission link
  • Footer links
• Request log is properly localized:
  • Title && clear button
  • Requests list when empty
  • Requests list with entries
  • Regex filter
  • Right-click context menu
• Settings page are properly localized:
  • Basic prefs
  • Advanced prefs
  • Your policy
  • Old rules (note: there is some hard-coded text from previous version. This will be changed later on a general l10n enhancement branch)
  • Default policy
  • Subscriptions
  • Experimental (note: there is some hard-coded text from previous version. This will be changed later on a general l10n enhancement branch)
• Setup page is properly localized
• Redirection notifications are properly localized:
  • <page> asked redirect to <target> yellow text
  • notification buttons (allow/deny/add rule)
  • Add rule menu
• about:addons entry (Add-on's description)

[jrrdev]

Commit for retrieve default_locale from manifest.json task have been pushed, see https://github.com/RequestPolicyContinued/requestpolicy/pull/881/commits/fc16fae71f86e1f85750d00030d3cd9285f10aa5

[myrdd]

Thank you! I will look into your changes after my vacations. Until then, I will comment on some of your changes. Keep up the great work! 👍👍

[jrrdev]

I added few commits to improve make check-locales command and to make some related fixes. I won't commit anything else beside review corrections to this branch.

[myrdd]

Hi @jrrdev

so far I've made some minor corrections on https://github.com/myrdd/requestpolicy/commits/feature/we-i18n

These are a few notes: (I'm not finished with the review yet, sorry for the delay)

• license headers in new GPL files
  • put your name there instead of mine.
  • put there only one year (2017)
• yourpolicy.js and overlay.js
  • please use const $str = browser.i18n.getMessage.bind(browser.i18n); and then e.g. $str("redirectNotification") to make the code shorter

[myrdd]

Add locale message for some hard-coded text (e.g old_rules.html, experimental.html)

Experimental features do not need to be localized IMHO. The old_rules page can be considered to be localized; however, for Firefox 57+ users that page is obsolete. The "old rules" refer to v0.5.x rules, which cannot be accessed by a WE.

I'm going to complete the review now.

[jrrdev]

Hi @jrrdev

so far I've made some minor corrections on https://github.com/myrdd/requestpolicy/commits/feature/we-i18n

These are a few notes: (I'm not finished with the review yet, sorry for the delay)

• license headers in new GPL files
  • put your name there instead of mine.
  • put there only one year (2017)
• yourpolicy.js and overlay.js
  • please use const $str = browser.i18n.getMessage.bind(browser.i18n); and then e.g. $str("redirectNotification") to make the code shorter

@myrdd: I merged your corrections in this PR and made the requested changes :wink:

[myrdd]

Hi @jrrdev, I've fixed some issues, made some refactorings and codings style changes, rebased onto and merged into develop. The merge commit is https://github.com/RequestPolicyContinued/requestpolicy/commit/3b2c656dae08da780e96b11c30dd88c637830184. Note that I also changed the directory structure a bit, the api is now at src/conditional/legacy/content/bootstrap/content/models/api/