From 23fd46c5dc1c7ab96029c50a40cb20190513f717 Mon Sep 17 00:00:00 2001 From: William Budington Date: Tue, 8 Aug 2017 14:32:36 -0700 Subject: [PATCH 1/3] Adding options UI for the ability to import settings. Chrome 55+ is required due to use of async functions. --- chromium/.eslintrc.json | 3 +++ chromium/background.js | 47 ++++++++++++++++++++++++++++++++++++++++ chromium/manifest.json | 5 ++++- chromium/options.css | 17 +++++++++++++++ chromium/options.html | 22 +++++++++++++++++++ chromium/options.js | 28 ++++++++++++++++++++++++ chromium/popup.html | 2 ++ chromium/popup.js | 19 ---------------- chromium/send-message.js | 8 +++++++ chromium/translation.js | 11 ++++++++++ 10 files changed, 142 insertions(+), 20 deletions(-) create mode 100644 chromium/options.css create mode 100644 chromium/options.html create mode 100644 chromium/options.js create mode 100644 chromium/send-message.js create mode 100644 chromium/translation.js diff --git a/chromium/.eslintrc.json b/chromium/.eslintrc.json index 772b09843098..97b53825ae30 100644 --- a/chromium/.eslintrc.json +++ b/chromium/.eslintrc.json @@ -1,4 +1,7 @@ { + "parserOptions": { + "ecmaVersion": 2017 + }, "env": { "browser": true, "commonjs": true, diff --git a/chromium/background.js b/chromium/background.js index a7cdbba109bf..96b816724071 100644 --- a/chromium/background.js +++ b/chromium/background.js @@ -31,6 +31,14 @@ storage.get({enableMixedRulesets: false}, function(item) { all_rules.addFromXml(loadExtensionFile('rules/default.rulesets', 'xml')); }); +// Load in the legacy custom rulesets, if any +function load_legacy_custom_rulesets(legacy_custom_rulesets){ + for(let legacy_custom_ruleset of legacy_custom_rulesets){ + all_rules.addFromXml((new DOMParser()).parseFromString(legacy_custom_ruleset, 'text/xml')); + } +} +storage.get({legacy_custom_rulesets: []}, item => load_legacy_custom_rulesets(item.legacy_custom_rulesets)); + var USER_RULE_KEY = 'userRules'; // Records which tabId's are active in the HTTPS Switch Planner (see // devtools-panel.js). @@ -660,5 +668,44 @@ chrome.runtime.onMessage.addListener(function(message, sender, sendResponse){ updateState(); } else if (message.type == "remove_rule") { removeRule(message.object); + } else if (message.type == "import_settings") { + // This is used when importing settings from the options ui + import_settings(message.object).then(() => { + sendResponse(true); + }); } }); + +/** + * Import extension settings (custom rulesets, ruleset toggles, globals) from an object + * @param settings the settings object + */ +async function import_settings(settings){ + if(settings.changed){ + // Load custom rulesets and add to storage + await new Promise(resolve => { + storage.set({"legacy_custom_rulesets": settings.custom_rulesets}, resolve); + }); + + // Load all the ruleset toggles into memory and store + let rule_toggle_promises = []; + for(let ruleset_name in settings.rule_toggle){ + localStorage[ruleset_name] = settings.rule_toggle[ruleset_name]; + } + + all_rules = new RuleSets(localStorage); + all_rules.addFromXml(loadExtensionFile('rules/default.rulesets', 'xml')); + load_legacy_custom_rulesets(settings.custom_rulesets); + + // Set/store globals + await new Promise(resolve => { + storage.set({'httpNowhere': settings.prefs.http_nowhere_enabled}, resolve); + }); + await new Promise(resolve => { + storage.set({'showCounter': settings.prefs.show_counter}, resolve); + }); + await new Promise(resolve => { + storage.set({'globalEnabled': settings.prefs.global_enabled}, resolve); + }); + } +} diff --git a/chromium/manifest.json b/chromium/manifest.json index 35bd1f555e50..a5eb7afe51e3 100644 --- a/chromium/manifest.json +++ b/chromium/manifest.json @@ -15,6 +15,9 @@ "incognito-cache-clearing.js" ] }, + "options_ui": { + "page": "options.html" + }, "browser_action": { "default_icon": { "38": "icons/icon-active-38.png" @@ -32,7 +35,7 @@ }, "incognito": "spanning", "manifest_version": 2, - "minimum_chrome_version": "52", + "minimum_chrome_version": "55", "name": "__MSG_about_ext_name__", "permissions": [ "webNavigation", diff --git a/chromium/options.css b/chromium/options.css new file mode 100644 index 000000000000..1e9f0418e2b9 --- /dev/null +++ b/chromium/options.css @@ -0,0 +1,17 @@ +.section-header{ + margin-bottom: 10px; +} + +.section-header-span{ + border-bottom: 1px solid #ccc; + font-size: 15px; +} + +#import{ + margin-bottom: 10px; + float: right; +} + +#import-confirmed{ + display: none; +} diff --git a/chromium/options.html b/chromium/options.html new file mode 100644 index 000000000000..3a7ae116aa33 --- /dev/null +++ b/chromium/options.html @@ -0,0 +1,22 @@ + + + + + + + + + + +
+ +
+
+
+ +
+ +
+ + + diff --git a/chromium/options.js b/chromium/options.js new file mode 100644 index 000000000000..d979c504e0f2 --- /dev/null +++ b/chromium/options.js @@ -0,0 +1,28 @@ +document.addEventListener("DOMContentLoaded", () => { + + let json_data; + let import_button = document.querySelector("#import"); + + function import_json(e) { + e.preventDefault(); + + let settings = JSON.parse(json_data); + sendMessage("import_settings", settings, resp => { + document.querySelector("#import-confirmed").style.display = "block"; + document.querySelector("form").style.display = "none"; + }); + } + + document.querySelector("#import-settings").addEventListener("change", event => { + const file = event.target.files[0]; + const reader = new FileReader(); + reader.onload = event => { + json_data = event.target.result; + import_button.disabled = false; + }; + + reader.readAsText(file); + }); + + document.querySelector("form").addEventListener("submit", import_json); +}); diff --git a/chromium/popup.html b/chromium/popup.html index 2a400c5a7bd0..b6c92d4cf855 100644 --- a/chromium/popup.html +++ b/chromium/popup.html @@ -9,6 +9,8 @@ + + diff --git a/chromium/popup.js b/chromium/popup.js index 645728e51624..1aeea420ccc2 100644 --- a/chromium/popup.js +++ b/chromium/popup.js @@ -191,16 +191,6 @@ document.addEventListener("DOMContentLoaded", function () { httpNowhereCheckbox.setAttribute('checked', ''); } }); - - // auto-translate all elements with i18n attributes - var elem = document.querySelectorAll("[i18n]"); - for (let el of elem) { - el.innerHTML = chrome.i18n.getMessage(el.getAttribute("i18n")); - } - - // other translations - e("aboutTitle").setAttribute("title", chrome.i18n.getMessage("about_title")); - e("add-rule-link").addEventListener("click", addManualRule); }); @@ -278,12 +268,3 @@ function setOption_(opt, value) { details[opt] = value; sendMessage("set_option", details); } - -function sendMessage(type, object, callback) { - var packet = {}; - packet.type = type; - if(object){ - packet.object = object; - } - chrome.runtime.sendMessage(packet, callback); -} diff --git a/chromium/send-message.js b/chromium/send-message.js new file mode 100644 index 000000000000..2ed895523d79 --- /dev/null +++ b/chromium/send-message.js @@ -0,0 +1,8 @@ +function sendMessage(type, object, callback) { + var packet = {}; + packet.type = type; + if(object){ + packet.object = object; + } + chrome.runtime.sendMessage(packet, callback); +} diff --git a/chromium/translation.js b/chromium/translation.js new file mode 100644 index 000000000000..61ae5ff14808 --- /dev/null +++ b/chromium/translation.js @@ -0,0 +1,11 @@ +document.addEventListener("DOMContentLoaded", function () { + // auto-translate all elements with i18n attributes + var elem = document.querySelectorAll("[i18n]"); + for (let el of elem) { + el.innerHTML = chrome.i18n.getMessage(el.getAttribute("i18n")); + } + + // other translations + e("aboutTitle").setAttribute("title", chrome.i18n.getMessage("about_title")); + e("add-rule-link").addEventListener("click", addManualRule); +}); From e4e2bd4350df0665124e96a95c8ae0ce225c1289 Mon Sep 17 00:00:00 2001 From: William Budington Date: Tue, 8 Aug 2017 14:34:21 -0700 Subject: [PATCH 2/3] Converting the XPCOM extension to an Embedded WebExtension for settings migration --- chromium/background.js | 3 + makexpi.sh | 22 +- src/bootstrap.js | 118 ++ src/chrome/content/about.js | 14 - src/chrome/content/about.xul | 70 -- src/chrome/content/code/AndroidUI.jsm | 260 ----- src/chrome/content/code/ApplicableList.js | 279 ----- src/chrome/content/code/Cookie.js | 150 --- src/chrome/content/code/HTTPS.js | 330 ------ src/chrome/content/code/HTTPSRules.js | 780 ------------- src/chrome/content/code/IOUtil.js | 267 ----- src/chrome/content/code/NSS.js | 489 -------- src/chrome/content/code/Root-CAs.js | 348 ------ src/chrome/content/code/X509ChainWhitelist.js | 1007 ----------------- src/chrome/content/code/commonOCSP.json | 289 ----- src/chrome/content/code/sha256.js | 249 ---- src/chrome/content/meta-preferences.xul | 30 - src/chrome/content/observatory-popup.xul | 61 - .../content/observatory-preferences.xul | 115 -- src/chrome/content/observatory-warning.xul | 49 - src/chrome/content/observatory-xul.js | 208 ---- src/chrome/content/toolbar_button.js | 441 -------- src/chrome/content/toolbar_button.xul | 86 -- src/chrome/content/toolbar_button_binding.xml | 33 - src/chrome/skin/cross.png | Bin 261 -> 0 bytes src/chrome/skin/https-everywhere-banner.png | 1 - src/chrome/skin/https-everywhere.css | 78 -- src/chrome/skin/icon-active-128.png | 1 - src/chrome/skin/icon-active-16.png | 1 - src/chrome/skin/icon-active-24.png | 1 - src/chrome/skin/icon-active-38.png | 1 - src/chrome/skin/icon-blocking-16.png | 1 - src/chrome/skin/icon-blocking-24.png | 1 - src/chrome/skin/icon-blocking-38.png | 1 - src/chrome/skin/icon-disabled-16.png | 1 - src/chrome/skin/icon-disabled-24.png | 1 - src/chrome/skin/icon-disabled-38.png | 1 - src/chrome/skin/icon-inactive-16.png | 1 - src/chrome/skin/icon-inactive-24.png | 1 - src/chrome/skin/icon-inactive-38.png | 1 - src/chrome/skin/loop.png | Bin 364 -> 0 bytes src/chrome/skin/tick-moot.png | Bin 335 -> 0 bytes src/chrome/skin/tick.png | Bin 348 -> 0 bytes src/components/https-everywhere.js | 832 -------------- src/components/ssl-observatory.js | 979 ---------------- src/install.rdf | 12 +- 46 files changed, 147 insertions(+), 7466 deletions(-) create mode 100644 src/bootstrap.js delete mode 100644 src/chrome/content/about.js delete mode 100644 src/chrome/content/about.xul delete mode 100644 src/chrome/content/code/AndroidUI.jsm delete mode 100644 src/chrome/content/code/ApplicableList.js delete mode 100644 src/chrome/content/code/Cookie.js delete mode 100644 src/chrome/content/code/HTTPS.js delete mode 100644 src/chrome/content/code/HTTPSRules.js delete mode 100644 src/chrome/content/code/IOUtil.js delete mode 100644 src/chrome/content/code/NSS.js delete mode 100644 src/chrome/content/code/Root-CAs.js delete mode 100644 src/chrome/content/code/X509ChainWhitelist.js delete mode 100644 src/chrome/content/code/commonOCSP.json delete mode 100644 src/chrome/content/code/sha256.js delete mode 100644 src/chrome/content/meta-preferences.xul delete mode 100644 src/chrome/content/observatory-popup.xul delete mode 100644 src/chrome/content/observatory-preferences.xul delete mode 100644 src/chrome/content/observatory-warning.xul delete mode 100644 src/chrome/content/observatory-xul.js delete mode 100644 src/chrome/content/toolbar_button.js delete mode 100644 src/chrome/content/toolbar_button.xul delete mode 100644 src/chrome/content/toolbar_button_binding.xml delete mode 100644 src/chrome/skin/cross.png delete mode 120000 src/chrome/skin/https-everywhere-banner.png delete mode 100644 src/chrome/skin/https-everywhere.css delete mode 120000 src/chrome/skin/icon-active-128.png delete mode 120000 src/chrome/skin/icon-active-16.png delete mode 120000 src/chrome/skin/icon-active-24.png delete mode 120000 src/chrome/skin/icon-active-38.png delete mode 120000 src/chrome/skin/icon-blocking-16.png delete mode 120000 src/chrome/skin/icon-blocking-24.png delete mode 120000 src/chrome/skin/icon-blocking-38.png delete mode 120000 src/chrome/skin/icon-disabled-16.png delete mode 120000 src/chrome/skin/icon-disabled-24.png delete mode 120000 src/chrome/skin/icon-disabled-38.png delete mode 120000 src/chrome/skin/icon-inactive-16.png delete mode 120000 src/chrome/skin/icon-inactive-24.png delete mode 120000 src/chrome/skin/icon-inactive-38.png delete mode 100644 src/chrome/skin/loop.png delete mode 100644 src/chrome/skin/tick-moot.png delete mode 100644 src/chrome/skin/tick.png delete mode 100644 src/components/https-everywhere.js delete mode 100644 src/components/ssl-observatory.js diff --git a/chromium/background.js b/chromium/background.js index 96b816724071..648da2cd6fde 100644 --- a/chromium/background.js +++ b/chromium/background.js @@ -676,6 +676,9 @@ chrome.runtime.onMessage.addListener(function(message, sender, sendResponse){ } }); +// Send a message to the embedded webextension bootstrap.js to get settings to import +chrome.runtime.sendMessage("import-legacy-data", import_settings); + /** * Import extension settings (custom rulesets, ruleset toggles, globals) from an object * @param settings the settings object diff --git a/makexpi.sh b/makexpi.sh index 02f5e915b63d..c367f0f89ac0 100755 --- a/makexpi.sh +++ b/makexpi.sh @@ -84,7 +84,6 @@ die() { } bash utils/validate.sh -cp pkg/rulesets.json src/chrome/content/rulesets.json # The name/version of the XPI we're building comes from src/install.rdf XPI_NAME="pkg/$APP_NAME-`grep em:version src/install.rdf | sed -e 's/[<>]/ /g' | cut -f3`" @@ -101,7 +100,26 @@ fi # Prepare packages suitable for uploading to EFF and AMO, respectively. [ -d pkg ] || mkdir pkg rsync -aL --delete --delete-excluded --exclude /chrome/content/rules src/ pkg/xpi-eff -cp -a translations/* pkg/xpi-eff/chrome/locale/ + +# START: The next lines are for embedded WebExtensions, and can be deleted after the full transition to WebExtensions +[ -d pkg/xpi-eff/webextension ] || mkdir pkg/xpi-eff/webextension +rsync -aL --delete chromium/ pkg/xpi-eff/webextension/ + +mkdir pkg/xpi-eff/webextension/_locales/ +python2.7 utils/chromium-translations.py translations/ pkg/xpi-eff/webextension/_locales/ +python2.7 utils/chromium-translations.py src/chrome/locale/ pkg/xpi-eff/webextension/_locales/ + +do_not_ship="*.py *.xml icon.jpg" +rm -f pkg/xpi-eff/webextension/$do_not_ship +rm -rf pkg/xpi-eff/chrome/content/rulesets.json +rm -rf pkg/xpi-eff/chrome/locale + +mkdir pkg/xpi-eff/webextension/rules/ +. ./utils/merge-rulesets.sh || exit 1 + +cp src/$RULESETS pkg/xpi-eff/webextension/rules/default.rulesets +# END + rsync -a --delete pkg/xpi-eff/ pkg/xpi-amo # The AMO version of the package cannot contain the updateKey or updateURL tags. # Also, it has a different id than the eff-hosted version, because Firefox now diff --git a/src/bootstrap.js b/src/bootstrap.js new file mode 100644 index 000000000000..57f89e3969e8 --- /dev/null +++ b/src/bootstrap.js @@ -0,0 +1,118 @@ +"use strict"; + +const CI = Components.interfaces; +const CC = Components.classes; + +function get_prefs(branch_name){ + let o_prefs = CC["@mozilla.org/preferences-service;1"] + .getService(CI.nsIPrefService); + let o_branch = o_prefs.getBranch(branch_name); + return o_branch; +} + +function get_custom_rulesets_array(){ + var loc = "ProfD"; // profile directory + var dir = + CC["@mozilla.org/file/directory_service;1"] + .getService(CI.nsIProperties) + .get(loc, CI.nsILocalFile) + .clone(); + dir.append("HTTPSEverywhereUserRules"); + // Check for existence, if not, create. + if (!dir.exists()) { + return []; + } + + var entries = dir.directoryEntries; + var files = []; + while(entries.hasMoreElements()) { + var entry = entries.getNext(); + entry.QueryInterface(CI.nsIFile); + files.push(entry); + } + + let file_data = [] + for(let file of files){ + var data = ""; + var fstream = CC["@mozilla.org/network/file-input-stream;1"] + .createInstance(CI.nsIFileInputStream); + var sstream = CC["@mozilla.org/scriptableinputstream;1"] + .createInstance(CI.nsIScriptableInputStream); + fstream.init(file, -1, 0, 0); + sstream.init(fstream); + + var str = sstream.read(4096); + while (str.length > 0) { + data += str; + str = sstream.read(4096); + } + + sstream.close(); + fstream.close(); + file_data.push(data); + } + + return file_data; +} + +function startup({webExtension}) { + webExtension.startup().then(api => { + const {browser} = api; + browser.runtime.onMessage.addListener((msg, sender, sendReply) => { + if (msg == "import-legacy-data") { + let globals = get_prefs("extensions.https_everywhere."); + if(!pref_retrieve_bool_with_default(globals, "webextension-migrated", false)){ + let changed = false; + + let prefs = { + http_nowhere_enabled: pref_retrieve_bool_with_default(globals, "http_nowhere.enabled", false), + global_enabled: pref_retrieve_bool_with_default(globals, "globalEnabled", true), + show_counter: pref_retrieve_bool_with_default(globals, "show_counter", true) + }; + + if(prefs.http_nowhere_enabled == true || + prefs.global_enabled == false || + prefs.show_counter == true + ){ + changed = true; + } + + let rule_toggle = {} + let rules = get_prefs("extensions.https_everywhere.rule_toggle."); + for(let rule_toggle_key of rules.getChildList("", {})){ + rule_toggle[rule_toggle_key] = rules.getBoolPref(rule_toggle_key); + changed = true; + } + + let custom_rulesets = get_custom_rulesets_array(); + if(custom_rulesets.length > 0){ + changed = true; + } + + sendReply({ + prefs: prefs, + rule_toggle: rule_toggle, + custom_rulesets: custom_rulesets, + changed: changed + }); + + globals.setBoolPref("webextensions-migrated", true); + } else { + sendReply({changed: false}); + } + } + }); + }); +} + +function pref_retrieve_bool_with_default(pref_branch, element, default_value){ + const pref_array = pref_branch.getChildList("", {}); + + if(pref_array.indexOf(element) !== -1){ + return pref_branch.getBoolPref(element); + } + return default_value; +} + +function shutdown(data) { +} diff --git a/src/chrome/content/about.js b/src/chrome/content/about.js deleted file mode 100644 index 7a37815f1454..000000000000 --- a/src/chrome/content/about.js +++ /dev/null @@ -1,14 +0,0 @@ -const CC = Components.classes; - -function window_opener(uri) { - // we don't use window.open, because we need to work around TorButton's state control - if(typeof gBrowser == "undefined"){ - var window = CC["@mozilla.org/appshell/window-mediator;1"].getService(Components.interfaces.nsIWindowMediator); - var browserWindow = window.getMostRecentWindow("navigator:browser").getBrowser(); - var newTab = browserWindow.addTab(uri, null, null); - browserWindow.selectedTab = newTab; - - } - else - gBrowser.selectedTab = gBrowser.addTab(uri); -} diff --git a/src/chrome/content/about.xul b/src/chrome/content/about.xul deleted file mode 100644 index 05ac898f1b4e..000000000000 --- a/src/chrome/content/about.xul +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - -