Detect and clean up the buggy 2.2 configurations

pde · pde · commit 6aea0dec3f97 · 2012-08-17T14:25:42.000-07:00
(This should only be needed for profiles where 2.2 was the first version of
HTTPS Everywhere ever installed).
diff --git a/src/chrome/content/code/HTTPSRules.js b/src/chrome/content/code/HTTPSRules.js
@@ -357,6 +357,7 @@ const HTTPSRules = {
       this.scanRulefiles(rulefiles);
       rulefiles = RuleWriter.enumerate(RuleWriter.getRuleDir());
       this.scanRulefiles(rulefiles);
+      this.checkForBuggyDefaults();
       var t,i;
       for (t in this.targets) {
         for (i = 0 ; i < this.targets[t].length ; i++) {
@@ -397,6 +398,53 @@ const HTTPSRules = {
     }
   },
 
+  checkForBuggyDefaults: function() {
+    // The 2.2 release had a ruleset parsing bug which caused the match_rule
+    // attribute to be misinterpreted as the default_off attribute.  That was
+    // a big problem iff 2.2 was the first version of HTTPS Everywhere
+    // installed in a particular browser profile.  If enough buggy rulesets
+    // are on, conclude that this is such a profile, and reset to the correct
+    // defaults.  More here:
+    //
+    // https://mail1.eff.org/pipermail/https-everywhere/2012-August/001511.html
+    //
+    this.log(DBUG, "Checking for buggy configurations from version 2.2");
+    // All of these were default_off in 2.2, and none of them had a
+    // match_rule:
+    var shouldBeOff = ["SchuelerVZ","Tcodevelopment.com","33Bits","BerliOS",
+                       "BuisnessInsider (broken)","Daft.ie","DVDFab",
+                       "YouMail (buggy)","StudiVZ (disabled)","Woot (broken)"];
+
+    var nonBuggy = 0;
+    for (rulename in shouldBeOff) {
+      // Some of these shouldBeOff rules may be removed in the future, so
+      // tolerate their absence
+      if (rulename in this.rulesetsByName) {
+        if (!this.rulesetsByName[rulename].active) 
+          nonBuggy += 1;
+      } else {
+        this.log("INFO", "Couldn't check state of ruleset " + rulename);
+      }
+    }
+
+    // Heuristic: a user starting with a buggy config might have disabled up
+    // to 2 of the 10 broken rulesets manually, but we will still conclude
+    // that their config is broken and reset it
+    if (nonBuggy <= 2) {
+      this.log(WARN, "Detected a buggy-looking configuration, probably from HTTPS Everywhere 2.2.  Resetting ruleset states to defaults");
+      this.resetRulesetsToDefaults();
+    }
+  },
+
+  resetRulesetsToDefaults: function() {
+    // Callable from within the prefs UI and also for cleaning up buggy
+    // configurations...
+    for (var i in this.rulesets) {
+      if (this.rulesets[i].on_by_default) this.rulesets[i].enable();
+      else                                this.rulesets[i].disable();
+    }
+  },
+
   rewrittenURI: function(alist, input_uri) {
     // This function oversees the task of working out if a uri should be
     // rewritten, what it should be rewritten to, and recordkeeping of which
diff --git a/src/chrome/content/preferences.js b/src/chrome/content/preferences.js
@@ -24,14 +24,7 @@ function disable_all() {
 
 // Reset all rules to their default state.
 function reset_defaults() {
-  for (var i in rulesets) {
-    if (rulesets[i].on_by_default) {
-      rulesets[i].enable();
-    } else {
-      rulesets[i].disable();
-    }
-  }
-
+  https_everywhere.https_rules.resetRulesetsToDefaults()
   treeView.treebox.invalidate();
 }
 
