First attempt at cleanup

pde · pde · commit 370be366b89e · 2014-01-31T12:47:07.000-08:00
diff --git a/src/chrome/content/observatory-xul.js b/src/chrome/content/observatory-xul.js
@@ -52,6 +52,7 @@ function observatory_prefs_init(doc) {
 // again
 function popup_done() {
   obsprefs.setBoolPref("extensions.https_everywhere._observatory.popup_shown", true);
+  obsprefs.setBoolPref("extensions.https_everywhere._observatory.clean_config", true);
   window.close();
 }
 
diff --git a/src/components/https-everywhere.js b/src/components/https-everywhere.js
@@ -590,8 +590,37 @@ HTTPSEverywhere.prototype = {
     };
     if (!shown && !enabled)
       ssl_observatory.registerProxyTestNotification(obs_popup_callback);
+
+    if (shown && enabled)
+      this.maybeCleanupObservatoryPrefs(ssl_observatory);
   },
 
+  maybeCleanupObservatoryPrefs: function(ssl_observatory) {
+    // Recover from a past UI processing bug that would leave the Obsevatory
+    // accidentally disabled for some users
+    // https://trac.torproject.org/projects/tor/ticket/10728
+    var clean = ssl_observatory.myGetBoolPref("clean_config");
+    if (clean) return;
+
+    // unchanged: returns true if a pref has not been modified
+    var unchanged = function(p){return !ssl_observatory.prefs.prefHasUserValue("extensions.https_everywhere._observatory."+p)};
+    var cleanup_obsprefs_callback = function(tor_avail) {
+      // we only run this once
+      ssl_observatory.prefs.setBoolPref("extensions.https_everywhere._observatory.clean_config", true);
+      if (!tor_avail) {
+        // use_custom_proxy is the variable that is often false when it should be true;
+        if (!ssl_observatory.myGetBoolPref("use_custom_proxy")) {
+           // however don't do anything if any of the prefs have been set by the user
+           if (unchanged("alt_roots") && unchanged("self_signed") && unchanged ("send_asn") && unchanged("priv_dns")) {
+             ssl_observatory.prefs.setBoolPref("extensions.https_everywhere._observatory.use_custom_proxy", true);
+           }
+        }
+      }
+    }
+    ssl_observatory.registerProxyTestNotification(cleanup_obsprefs_callback);
+  },
+
+
   getExperimentalFeatureCohort: function() {
     // This variable is used for gradually turning on features for testing and
     // scalability purposes.  It is a random integer [0,N_COHORTS) generated
diff --git a/src/defaults/preferences/preferences.js b/src/defaults/preferences/preferences.js
@@ -41,3 +41,4 @@ pref("extensions.https_everywhere._observatory.self_signed",true);
 pref("extensions.https_everywhere._observatory.priv_dns",false);
 pref("extensions.https_everywhere._observatory.send_asn",true);
 pref("extensions.https_everywhere._observatory.use_whitelist",true);
+pref("extensions.https_everywhere._observatory.clean_config",false);

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@ function observatory_prefs_init(doc) {`
`52`	`52`	`// again`
`53`	`53`	`function popup_done() {`
`54`	`54`	`obsprefs.setBoolPref("extensions.https_everywhere._observatory.popup_shown", true);`
	`55`	`+ obsprefs.setBoolPref("extensions.https_everywhere._observatory.clean_config", true);`
`55`	`56`	`window.close();`
`56`	`57`	`}`
`57`	`58`