Embedded WebExtension

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "addon-sdk"]
-	path = addon-sdk
-	url = https://github.com/mozilla/addon-sdk.git
 [submodule "translations"]
 	path = translations
 	url = https://git.torproject.org/translation.git

chromium/.eslintrc.json

@@ -1,4 +1,7 @@
 {
+    "parserOptions": {
+        "ecmaVersion": 2017
+    },
     "env": {
         "browser": true,
         "commonjs": true,

chromium/background.js

@@ -31,6 +31,15 @@ storage.get({enableMixedRulesets: false}, function(item) {
   all_rules.addFromXml(loadExtensionFile('rules/default.rulesets', 'xml'));
 });
 
+// Load in the legacy custom rulesets, if any
+storage.get({legacy_custom_rulesets: false}, item => {
+  if(item.legacy_custom_rulesets){
+    for(let legacy_custom_ruleset of item.legacy_custom_rulesets){
+      all_rules.addFromXml((new DOMParser()).parseFromString(legacy_custom_ruleset, 'text/xml'));
+    }
+  }
+});
+
 var USER_RULE_KEY = 'userRules';
 // Records which tabId's are active in the HTTPS Switch Planner (see
 // devtools-panel.js).
@@ -61,12 +70,16 @@ chrome.storage.onChanged.addListener(function(changes, areaName) {
     }
   }
 });
-chrome.tabs.onActivated.addListener(function() {
-  updateState();
-});
-chrome.windows.onFocusChanged.addListener(function() {
-  updateState();
-});
+if (chrome.tabs) {
+  chrome.tabs.onActivated.addListener(function() {
+    updateState();
+  });
+}
+if (chrome.windows) {
+  chrome.windows.onFocusChanged.addListener(function() {
+    updateState();
+  });
+}
 chrome.webNavigation.onCompleted.addListener(function() {
   updateState();
 });
@@ -106,6 +119,9 @@ loadStoredUserRules();
  * disabled: extension is disabled from the popup menu.
  */
 var updateState = function() {
+  if (!chrome.tabs) {
+    return;
+  }
   chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
     if (!tabs || tabs.length === 0) {
       return;
@@ -174,21 +190,20 @@ var removeRule = function(ruleset) {
  * */
 function AppliedRulesets() {
   this.active_tab_rules = {};
+  this.active_tab_hostnames = {};
 
   var that = this;
-  chrome.tabs.onRemoved.addListener(function(tabId, info) {
-    that.removeTab(tabId);
-  });
+  if (chrome.tabs) {
+    chrome.tabs.onRemoved.addListener(function(tabId, info) {
+      that.removeTab(tabId);
+    });
+  }
 }
 
 AppliedRulesets.prototype = {
   addRulesetToTab: function(tabId, ruleset) {
-    if (tabId in this.active_tab_rules) {
-      this.active_tab_rules[tabId][ruleset.name] = ruleset;
-    } else {
-      this.active_tab_rules[tabId] = {};
-      this.active_tab_rules[tabId][ruleset.name] = ruleset;
-    }
+    this.active_tab_rules[tabId] = this.active_tab_rules[tabId] || {};
+    this.active_tab_rules[tabId][ruleset.name] = ruleset;
   },
 
   getRulesets: function(tabId) {
@@ -198,8 +213,21 @@ AppliedRulesets.prototype = {
     return null;
   },
 
+  addHostnameToTab: function(tabId, ruleset_name, hostname) {
+    this.active_tab_hostnames[tabId] = this.active_tab_hostnames[tabId] || {};
+    this.active_tab_hostnames[tabId][ruleset_name] = hostname;
+  },
+
+  getHostnames: function(tabId) {
+    if (tabId in this.active_tab_hostnames) {
+      return this.active_tab_hostnames[tabId];
+    }
+    return null;
+  },
+
   removeTab: function(tabId) {
     delete this.active_tab_rules[tabId];
+    delete this.active_tab_hostnames[tabId];
   }
 };
 
@@ -283,6 +311,7 @@ function onBeforeRequest(details) {
 
   for (let ruleset of potentiallyApplicable) {
     activeRulesets.addRulesetToTab(details.tabId, ruleset);
+    activeRulesets.addHostnameToTab(details.tabId, ruleset.name, uri.hostname);
     if (ruleset.active && !newuristr) {
       newuristr = ruleset.apply(canonical_url);
     }
@@ -618,3 +647,97 @@ chrome.runtime.onConnect.addListener(function (port) {
     });
   }
 });
+
+// This is necessary for communication with the popup in Firefox Private
+// Browsing Mode, see https://bugzilla.mozilla.org/show_bug.cgi?id=1329304
+chrome.runtime.onMessage.addListener(function(message, sender, sendResponse){
+  if (message.type == "get_option") {
+    storage.get(message.object, function(item){
+      sendResponse(item);
+    });
+    return true;
+  } else if (message.type == "set_option") {
+    storage.set(message.object);
+  } else if (message.type == "get_is_extension_enabled") {
+    sendResponse(isExtensionEnabled);
+  } else if (message.type == "set_is_extension_enabled") {
+    isExtensionEnabled = message.object;
+    sendResponse(isExtensionEnabled);
+  } else if (message.type == "delete_from_ruleset_cache") {
+    all_rules.ruleCache.delete(message.object);
+  } else if (message.type == "get_active_rulesets_and_hostnames") {
+    sendResponse({
+      rulesets: activeRulesets.getRulesets(message.object),
+      hostnames: activeRulesets.getHostnames(message.object)
+    });
+  } else if (message.type == "set_ruleset_active_status") {
+    var ruleset = activeRulesets.getRulesets(message.object.tab_id)[message.object.name];
+    ruleset.active = message.object.active;
+    sendResponse(true);
+  } else if (message.type == "add_new_rule") {
+    addNewRule(message.object, function() {
+      sendResponse(true);
+    });
+    return true;
+  } else if (message.type == "update_state") {
+    updateState();
+  } else if (message.type == "remove_rule") {
+    removeRule(message.object);
+  } else if (message.type == "import_settings") {
+    import_settings(message.object).then(() => {
+      sendResponse(true);
+    });
+  }
+});
+
+// Send a message to the embedded webextension bootstrap.js to get settings to import
+chrome.runtime.sendMessage("import-legacy-data", function(settings){
+  import_settings(settings);
+});
+
+/**
+ * Enable switch planner for specific tab
+ * @param settings the settings object
+ */
+async function import_settings(settings){
+  if(settings.changed){
+    // Load custom rulesets and add to storage
+    await new Promise(resolve => {
+      for(let ruleset of settings.custom_rulesets){
+        all_rules.addFromXml((new DOMParser()).parseFromString(ruleset, 'text/xml'));
+      }
+      storage.set({"legacy_custom_rulesets": settings.custom_rulesets}, item => {
+        resolve(item);
+      });
+    });
+
+    // 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];
+
+      rule_toggle_promises.push((ruleset_name, ruleset_active => {
+        return new Promise(resolve => {
+          for(let host in all_rules.targets){
+            for(let ruleset of all_rules.targets[host]){
+              if(ruleset.name == ruleset_name){
+                ruleset.active = ruleset_active;
+                resolve(true);
+                return;
+              }
+            }
+          }
+          resolve(false);
+        })
+      })(ruleset_name, settings.rule_toggle[ruleset_name]));
+    }
+    await Promise.all(rule_toggle_promises);
+
+    all_rules.ruleCache = new Map();
+
+    // Set/store globals
+    storage.set({'httpNowhere': settings.prefs.http_nowhere_enabled});
+    storage.set({'showCounter': settings.prefs.show_counter});
+    isExtensionEnabled = settings.prefs.global_enabled;
+  }
+}

chromium/incognito-cache-clearing.js

@@ -55,7 +55,11 @@ function detect_incognito_destruction(windowId) {
 
 
 // Listen to window creation, so we can detect if an incognito window is created
-chrome.windows.onCreated.addListener(detect_incognito_creation);
+if (chrome.windows) {
+  chrome.windows.onCreated.addListener(detect_incognito_creation);
+}
 
 // Listen to window destruction, so we can clear caches if all incognito windows are destroyed
-chrome.windows.onRemoved.addListener(detect_incognito_destruction);
+if (chrome.windows) {
+  chrome.windows.onRemoved.addListener(detect_incognito_destruction);
+}

chromium/manifest.json

@@ -1,7 +1,11 @@
 {
-    "author": {
-        "email": "eff.software.projects@gmail.com"
-    }, 
+    "applications": {
+        "gecko": {
+            "id": "https-everywhere-eff@eff.org",
+            "update_url": "https://www.eff.org/files/https-everywhere-updates.json"
+        }
+    },
+    "author": "eff.software.projects@gmail.com",
     "background": {
         "scripts": [
             "rules.js", 
@@ -11,6 +15,9 @@
             "incognito-cache-clearing.js"
         ]
     }, 
+    "options_ui": {
+      "page": "options.html"
+    },
     "browser_action": {
         "default_icon": {
             "38": "icons/icon-active-38.png"
@@ -28,7 +35,7 @@
     }, 
     "incognito": "spanning", 
     "manifest_version": 2, 
-    "minimum_chrome_version": "52", 
+    "minimum_chrome_version": "55",
     "name": "__MSG_about_ext_name__", 
     "permissions": [
         "webNavigation", 

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;
+}

chromium/options.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <link href="options.css" rel="stylesheet" type="text/css"/>
+    <script src="options.js"></script>
+    <script src="translation.js"></script>
+    <script src="send-message.js"></script>
+  </head>
+  <body>
+    <div id='import-confirmed' i18n="options_imported"></div>
+
+    <form>
+      <div class="section-header"><span class="section-header-span" i18n="options_importSettings"></span></div>
+      <section id="ImportSettings" class="options">
+        <input id="import-settings" type="file" accept="application/json" value="importSettings" />
+      </section>
+      <button type="submit" id="import" i18n="options_import" disabled></button>
+    </form>
+
+  </body>
+</html>

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);
+});

chromium/popup.css

@@ -69,6 +69,7 @@ section.rules {
 /* Override display attribute of text labels in widgets.css. */
 .rule span {
   display: inline !important;
+  margin-left: 0.6em;
 }
 
 body {

chromium/popup.html

@@ -9,6 +9,8 @@
 
     <link href="popup.css" rel="stylesheet" type="text/css"/>
     <script src="popup.js"></script>
+    <script src="translation.js"></script>
+    <script src="send-message.js"></script>
 
 </head>