Work in progress on broken rule indication.

pde · pde · commit 8ccfcca052d9 · 2011-06-27T17:43:39.000-07:00
diff --git a/src/chrome/content/code/ApplicableList.js b/src/chrome/content/code/ApplicableList.js
@@ -7,17 +7,16 @@ serial_number = 0
 function ApplicableList(logger, doc, domWin) {
   this.domWin = domWin;
   this.home = doc.baseURIObject.spec; // what doc we're housekeeping for
+  this.doc = doc;
   this.log = logger;
   this.active = {};
+  this.breaking = {}; // rulesets with redirection loops
   this.inactive = {};
   this.moot={};  // rulesets that might be applicable but uris are already https
-  this.all={};  // active + inactive + moot
+  this.all={};  // active + breaking + inactive + moot
   serial_number += 1;
   this.serial = serial_number;
   this.log(DBUG,"Alist serial #" + this.serial + " for " + this.home);
-  // The base URI of the dom tends to be loaded from some /other/
-  // ApplicableList, so pretend we're loading it from here.
-  HTTPSEverywhere.instance.https_rules.rewrittenURI(this, doc.baseURIObject);
 };
 
 ApplicableList.prototype = {
@@ -29,6 +28,13 @@ ApplicableList.prototype = {
     this.all[ruleset.name] = ruleset;
   },
 
+  breaking_rule: function(ruleset) {
+    this.log(WARN,"breaking rule " + ruleset.name +" in "+ this.home +" -> " +
+             this.domWin.document.baseURIObject.spec+ " serial " + this.serial);
+    this.breaking[ruleset.name] = ruleset;
+    this.all[ruleset.name] = ruleset;
+  },
+
   inactive_rule: function(ruleset) {
 
     this.log(INFO,"inactive rule " + ruleset.name +" in "+ this.home +" -> " +
@@ -50,6 +56,13 @@ ApplicableList.prototype = {
   },
 
   populate_menu: function(document) {
+
+    // The base URI of the dom tends to be loaded from some /other/
+    // ApplicableList, so pretend we're loading it from here.
+    this.log(WARN,"BASE uri is", this.doc.baseURIObject.spec);
+    this.log(WARN,"home is", this.home);
+    HTTPSEverywhere.instance.https_rules.rewrittenURI(this, this.doc.baseURIObject);
+    this.show_applicable();
     this.log(DBUG, "populating using alist #" + this.serial);
     this.document = document;
     
@@ -62,12 +75,13 @@ ApplicableList.prototype = {
     }
 
     // add the label at the top
-    var rules_count = 0;
-    for(x in this.active) rules_count++;
-    for(x in this.inactive) rules_count++;
-    for(x in this.moot) rules_count++;
+    var any_rules = false
+    for (var x in this.all) {
+      any_rules = true;  // how did JavaScript get this ugly?
+      break;
+    }
     var label = document.createElement('menuitem');
-    if(rules_count > 0) {
+    if (any_rules) {
         label.setAttribute('label', 'Enable / Disable Rules');
     } else {
         label.setAttribute('label', '(No Rules for This Page)');
@@ -89,6 +103,8 @@ ApplicableList.prototype = {
     }
 
     // add all applicable commands
+    for(var x in this.breaking) 
+      this.add_command(this.breaking[x]); 
     for(var x in this.active) 
       this.add_command(this.active[x]); 
     for(var x in this.moot)
@@ -97,13 +113,17 @@ ApplicableList.prototype = {
       this.add_command(this.inactive[x]);
 
     // add all the menu items
-    for(var x in this.active) 
-      this.add_menuitem(this.active[x], 'active');
+    for (var x in this.breaking)
+      this.add_menuitem(this.breaking[x], 'breaking');
+    // break once break everywhere
+    for (var x in this.active) 
+      if (!(x in this.breaking))
+        this.add_menuitem(this.active[x], 'active');
     // rules that are active for some uris are not really moot
-    for(var x in this.moot) 
-      if(!(x in this.active))   
+    for (var x in this.moot) 
+      if (!(x in this.active))   
         this.add_menuitem(this.moot[x], 'moot');
-    for(var x in this.inactive)
+    for (var x in this.inactive)
       this.add_menuitem(this.inactive[x], 'inactive');
 
     // add other menu items
@@ -140,7 +160,9 @@ ApplicableList.prototype = {
       this.commandset.appendChild(command);
   },
 
-  // add a menu item for a rule -- type is "active", "inactive", or "moot"
+  // add a menu item for a rule -- type is "active", "inactive", "moot",
+  // or "breaking"
+
   add_menuitem: function(rule, type) {
     // create the menuitem
     var item = this.document.createElement('menuitem');
@@ -150,9 +172,10 @@ ApplicableList.prototype = {
     // set the icon
     var image = this.document.createElement('image');
     var image_src;
-    if(type == 'active') image_src = 'tick.png';
-    else if(type == 'inactive') image_src = 'cross.png';
-    else if(type == 'moot') image_src = 'tick-moot.png';
+    if (type == 'active') image_src = 'tick.png';
+    else if (type == 'inactive') image_src = 'cross.png';
+    else if (type == 'moot') image_src = 'tick-moot.png';
+    else if (type == 'breaking') image_src = 'tick-red.png';
     image.setAttribute('src', 'chrome://https-everywhere/skin/'+image_src);
 
     // set the label
@@ -173,6 +196,9 @@ ApplicableList.prototype = {
     this.log(WARN, "Applicable list number " + this.serial);
     for (var x in this.active) 
       this.log(WARN,"Active: " + this.active[x].name);
+
+    for (var x in this.breaking) 
+      this.log(WARN,"Breaking: " + this.breaking[x].name);
   
     for (x in this.inactive) 
       this.log(WARN,"Inactive: " + this.inactive[x].name);
diff --git a/src/chrome/content/code/HTTPS.js b/src/chrome/content/code/HTTPS.js
@@ -29,13 +29,15 @@ const HTTPS = {
   httpsRewrite: null,
   
   replaceChannel: function(applicable_list, channel) {
-    var uri = HTTPSRules.rewrittenURI(applicable_list, channel.URI);
-    if (!uri) {
+    var blob = HTTPSRules.rewrittenURI(applicable_list, channel.URI);
+    if (null == blob) {
        //HTTPS.log(INFO,
        //    "Got replace channel with no applicable rules for URI "
        //    + channel.URI.spec);
        return false;
      }
+    var uri = blob.newuri;
+    if (!uri) this.log(WARN, "OH NO BAD ARGH\nARGH");
 
     var c2=channel.QueryInterface(CI.nsIHttpChannel);
     this.log(DBUG,"Redirection limit is " + c2.redirectionLimit);
@@ -46,7 +48,11 @@ const HTTPS = {
     if (c2.redirectionLimit < 10) {
       this.log(WARN, "Redirection loop trying to set HTTPS on:\n  " +
       channel.URI.spec +"\n(falling back to HTTP)");
-      https_everywhere_blacklist[channel.URI.spec] = true;
+      if (!blob.applied_rule) {
+        this.log(WARN,"DEATH\nDEATH\nDEATH\nDEATH");
+        https_everywhere_blacklist[channel.URI.spec] = true;
+      }
+      https_everywhere_blacklist[channel.URI.spec] = blob.applied_rule;
       return false;
     }
     if (ChannelReplacement.supported) {
@@ -97,7 +103,7 @@ const HTTPS = {
         return null;
       }
       domWin = doc.defaultView;
-      this.log(DBUG,"Coerced nsIDOMWin from Node: " + domWin);
+      //this.log(DBUG,"Coerced nsIDOMWin from Node: " + domWin);
     } else {
       this.log(WARN, "Context for " + uri.spec + 
                      "is some bizarre unexpected thing: " + ctx);
@@ -116,8 +122,9 @@ const HTTPS = {
     // what rulesets might have applied to this page
     this.log(VERB, "Context is " + ctx);
     var alist = this.getApplicableListForContext(ctx, uri);
-    var newuri = HTTPSRules.rewrittenURI(alist, uri);
-    if (!newuri) return true;                          // no applicable rule
+    var blob = HTTPSRules.rewrittenURI(alist, uri);
+    if (null == blob) return true;                          // no applicable rule
+    var newuri = blob.newuri;
 
     try {
       if (this.rewriteInPlace(uri, newuri)) 
diff --git a/src/chrome/content/code/HTTPSRules.js b/src/chrome/content/code/HTTPSRules.js
@@ -347,9 +347,13 @@ const HTTPSRules = {
   rewrittenURI: function(alist, 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
-    // applicable rulesets are and aren't active.
+    // applicable rulesets are and aren't active.  Previously this returned
+    // the new uri if there was a rewrite.  Now it returns a JS object with
+    // a newuri attribute and an applied_rule attribute (or null if there's no
+    // rewrite).
     var i = 0;
-    var newuri = null
+    var blob = {};
+    blob.newuri = null;
     try {
       var rs = this.potentiallyApplicableRulesets(uri.host);
     } catch(e) {
@@ -364,11 +368,16 @@ const HTTPSRules = {
           alist.inactive_rule(rs[i]);
         continue;
       } 
-      newuri = rs[i].transformURI(uri);
-      if (newuri) {
+      blob.newuri = rs[i].transformURI(uri);
+      if (blob.newuri) {
         // we rewrote the uri
-        if (alist) alist.active_rule(rs[i]);
-        return newuri;
+        if (alist)
+          if (blob.newuri.spec in https_everywhere_blacklist)
+            alist.breaking_rule(rs[i])
+          else
+            alist.active_rule(rs[i]);
+        blob.applied_rule = rs[i];
+        return blob;
       }
       if (uri.scheme == "https" && alist) {
         // we didn't rewrite but the rule applies to this domain and the
diff --git a/src/chrome/skin/https-everywhere.css b/src/chrome/skin/https-everywhere.css
@@ -17,6 +17,10 @@ toolbar[iconsize="small"] #https-everywhere-button {
     opacity: 0.5;
     font-weight: bold;
 }
+#https-everywhere-button menuitem.breaking-item label {
+    color: #b99999;
+    font-weight: bold;
+}
 #https-everywhere-button menuitem.inactive-item label {
     color: #999999;
     font-weight: bold;
diff --git a/src/chrome/skin/tick-red.png b/src/chrome/skin/tick-red.png
diff --git a/src/components/https-everywhere.js b/src/components/https-everywhere.js
@@ -236,7 +236,7 @@ HTTPSEverywhere.prototype = {
     try {
       if (c) {
         c = c.wrappedJSObject;
-        this.log(DBUG, "Found a controller, returning data");
+        //this.log(DBUG, "Found a controller, returning data");
         return c.data[key];
       } else {
         this.log(INFO, "No controller attached to " + domWin);
@@ -245,7 +245,9 @@ HTTPSEverywhere.prototype = {
     } catch(e) {
       // Firefox 3.5
       this.log(WARN,"exception in getExpando");
-      return this.getExpando_old(domWin.document, key, null);
+      this.getExpando = this.getExpando_old;
+      this.setExpando = this.setExpando_old;
+      return this.getExpando_old(domWin, key, null);
     }
   },
   setExpando: function(domWin, key, value) {
@@ -260,16 +262,21 @@ HTTPSEverywhere.prototype = {
       }
       c.data[key] = value;
     } catch(e) {
-      this.setExpando_old(domWin.document, key, value);
+      this.log(WARN,"exception in setExpando");
+      this.getExpando = this.getExpando_old;
+      this.setExpando = this.setExpando_old;
+      this.setExpando_old(domWin, key, value);
     }
   },
 
   // This method is straight out of NoScript... we fall back to it in FF 3.*?
-  getExpando_old: function(domObject, key, defValue) {
+  getExpando_old: function(domWin, key, defValue) {
+    var domObject = domWin.document;
     return domObject && domObject.__httpsEStorage && domObject.__httpsEStorage[key] || 
            (defValue ? this.setExpando(domObject, key, defValue) : null);
   },
-  setExpando_old: function(domObject, key, value) {
+  setExpando_old: function(domWin, key, value) {
+    var domObject = domWin.document;
     if (!domObject) return null;
     if (!domObject.__httpsEStorage) domObject.__httpsEStorage = {};
     if (domObject.__httpsEStorage) domObject.__httpsEStorage[key] = value;
@@ -317,7 +324,7 @@ HTTPSEverywhere.prototype = {
     try {
       var domWin = nc.getInterface(CI.nsIDOMWindow);
     } catch(e) {
-      this.log(WARN, "exploded getting DOMWin for " + channel.URI.spec);
+      this.log(INFO, "exploded getting DOMWin for " + channel.URI.spec);
       return null;
     }
     if (!domWin) {
@@ -341,23 +348,23 @@ HTTPSEverywhere.prototype = {
       return null;
     }
     var dw = domWin.top;
-    this.log(DBUG, "Forcing new AL in getApplicableListForDOMWin in onLocationChange");
     var alist = new ApplicableList(this.log,dw.document,dw);
     this.setExpando(dw,"applicable_rules",alist);
     return alist;
   },
 
   getApplicableListForDOMWin: function(domWin, where) {
     if (!domWin || !(domWin instanceof CI.nsIDOMWindow)) {
-      this.log(WARN, "Get alist without domWin");
+      //this.log(WARN, "Get alist without domWin");
       return null;
     }
     var dw = domWin.top;
     var alist= this.getExpando(dw,"applicable_rules",null);
     if (alist) {
-      this.log(DBUG,"get AL success in " + where);
+      //this.log(DBUG,"get AL success in " + where);
+      return alist;
     } else {
-      this.log(DBUG, "Making new AL in getApplicableListForDOMWin in " + where);
+      //this.log(DBUG, "Making new AL in getApplicableListForDOMWin in " + where);
       alist = new ApplicableList(this.log,dw.document,dw);
       this.setExpando(dw,"applicable_rules",alist);
     }
@@ -373,11 +380,12 @@ HTTPSEverywhere.prototype = {
     if (topic == "http-on-modify-request") {
       if (!(channel instanceof CI.nsIHttpChannel)) return;
       this.log(DBUG,"Got http-on-modify-request: "+channel.URI.spec);
+      var lst = this.getApplicableListForChannel(channel);
       if (channel.URI.spec in https_everywhere_blacklist) {
-        this.log(DBUG, "Avoiding blacklisted " + channel.URI.spec);
+        this.log(WARN, "Avoiding blacklisted " + channel.URI.spec);
+        lst.breaking_rule(https_everywhere_blacklist[channel.URI.spec]);
         return;
       }
-      var lst = this.getApplicableListForChannel(channel);
       HTTPS.replaceChannel(lst, channel);
     } else if (topic == "http-on-examine-response") {
       this.log(DBUG, "Got http-on-examine-response @ "+ (channel.URI ? channel.URI.spec : '') );
