First-run page (revisited)

chrome/content/ui/firstRun.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2013 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 "use strict";
 
 (function()
 {
   var shade;
   var scrollTimer;
 
-  // determine platform
-  var userAgent = "";
-  if (navigator.userAgent.indexOf("Gecko/") > -1)
-    userAgent = "firefox";
-  else if (navigator.userAgent.indexOf("Chrome/") > -1)
-    userAgent = "chrome";
-
-  if (userAgent !== "")
-    document.documentElement.className = userAgent;
-  
-  // load subscriptions for features
-  var featureSubscriptions = {};
-  (function()
-  {
-    // load feature subscriptions
-    var request = new XMLHttpRequest();
-    request.open("GET", "featureSubscriptions.xml", false); // TODO: check in Chrome
-    request.send();
-    var subscriptions = request.responseXML.getElementsByTagName("subscription");
-    for (var i = 0, len = subscriptions.length; i < len; i++)
-    {
-      var subscription = subscriptions[i];
-      featureSubscriptions[subscription.getAttribute("feature")] = {
-        "url": subscription.getAttribute("url"),
-        "title": subscription.getAttribute("title")
-      };
-    }
-  })();
-
-  var scripts = [];
-  if (userAgent == "chrome")
-  {
-    var backgroundPage = chrome.extension.getBackgroundPage();
-    var require = backgroundPage.require;
-  }
-  else if (userAgent == "firefox")
-  {
-    scripts.push("utils.js");
-  }
-  scripts.push("i18n.js");
-  
-  function loadScripts()
-  {
-    var scriptName = scripts.shift();
-    var script = document.createElement("script");
-    script.type = (userAgent == "firefox") ? "application/x-javascript;version=1.7" : "text/javascript";
-    script.addEventListener("load", (scripts.length == 0) ? onScriptsLoaded : loadScripts, false);
-    script.src = scriptName;
-    document.head.appendChild(script);
-  }
-
-  function onScriptsLoaded()
-  {
-    if (userAgent == "chrome")
-    {
-      window.Utils = require("utils").Utils;
-      window.Prefs = require("prefs").Prefs;
-    }
-    
-    // Set up page title
-    var titleId = "firstRun_title_install";
-    if (userAgent == "chrome" && backgroundPage.isFirstRun
-      || userAgent == "firefox" && UI.firstRunDone)
-      titleId = "firstRun_title_update";
-    var pageTitle = i18n.getMessage(titleId);
-    document.title = document.getElementById("title-main").textContent = pageTitle;
-
-    shade = document.getElementById("shade");
+  // Load subscriptions for features
+  var featureSubscriptions = [
+    {
+      feature: "malware",
+      homepage: "http://malwaredomains.com/",
+      title: "Malware Domains",
+      url: "https://easylist-downloads.adblockplus.org/malwaredomains_full.txt"
+    },
+    {
+      feature: "social",
+      homepage: "https://www.fanboy.co.nz/",
+      title: "Fanboy's Social Blocking List",
+      url: "https://easylist-downloads.adblockplus.org/fanboy-social.txt"
+    },
+    {
+      feature: "tracking",
+      homepage: "https://easylist.adblockplus.org/",
+      title: "EasyPrivacy",
+      url: "https://easylist-downloads.adblockplus.org/easyprivacy.txt"
+    }
+  ];
+
+  function onDOMLoaded()
+  {
+    // Show warning if data corruption was detected
+    if (typeof backgroundPage != "undefined" && backgroundPage.seenDataCorruption)
+    {
+      E("dataCorruptionWarning").removeAttribute("hidden");
+      setLinks("dataCorruptionWarning", Utils.getDocLink("knownIssuesChrome_filterstorage"));
+    }
+
+    // Set up URL
+    setLinks("acceptableAdsExplanation", Utils.getDocLink("acceptable_ads_criteria"), openFilters);
+
+    shade = E("shade");
     shade.addEventListener("mouseover", scrollPage, false);
     shade.addEventListener("mouseout", stopScroll, false);
 
-    if (userAgent == "firefox")
-    {
-      var typoSettings = document.createElement("script");
-      typoSettings.type = "application/x-javascript;version=1.7";
-      typoSettings.src = "typoSettings.js";
-      document.head.appendChild(typoSettings);
-
-      var toggleTypo = document.getElementById("toggle-typo");
+    // Set up typo feature
+    if (require("typoBootstrap"))
+    {
+      var featureTypo = E("feature-typo");
+      featureTypo.removeAttribute("hidden");
+      
       updateToggleButton("typo", Prefs.correctTypos);
-      Prefs.addListener(function(name)
+
+      var listener = function(name)
       {
         if (name == "correctTypos")
           updateToggleButton("typo", Prefs.correctTypos);
-      });
-      toggleTypo.addEventListener("click", function(event)
-      {
-        TypoActions.setEnabled(!Prefs.correctTypos);
+      }
+      Prefs.addListener(listener);
+      window.addEventListener("unload", function(event)
+      {
+        Prefs.removeListener(listener);
       }, false);
-    }
-
-    setToggleSubscriptionButton("malware");
-    setToggleSubscriptionButton("social");
-    setToggleSubscriptionButton("tracking");
-
-    setLinks("acceptableAdsExplanation", getDocLink("acceptable_ads_criteria"), openFilters);
+
+      E("toggle-typo").addEventListener("click", toggleTypoCorrectionEnabled, false);
+    }
+
+    // Set up feature buttons linked to subscriptions
+    featureSubscriptions.forEach(setToggleSubscriptionButton);
+    var filterListener = function(action)
+    {
+      if (/^subscription\.(added|removed|disabled)$/.test(action))
+      {
+        for (var i = 0; i < featureSubscriptions.length; i++)
+        {
+          var featureSubscription = featureSubscriptions[i];
+          updateToggleButton(featureSubscription.feature, isSubscriptionEnabled(featureSubscription));
+        }
+      }
+    }
+    FilterNotifier.addListener(filterListener);
+    window.addEventListener("unload", function(event)
+    {
+      FilterNotifier.removeListener(filterListener);
+    }, false);
 
     window.addEventListener("resize", onWindowResize, false);
     document.addEventListener("scroll", onScroll, false);
 
     onWindowResize();
 
     initSocialLinks(null);
   }
 
   function onScroll()
   {
     var currentHeight = document.documentElement.scrollTop + document.body.scrollTop + document.documentElement.clientHeight;
     shade.style.opacity = (document.documentElement.scrollHeight == currentHeight) ? "0.0" : "0.5";
   }
 
   function onWindowResize()
   {
     onScroll();
   }
-  
-  // TODO: check in Chrome
-  function getSubscription(featureSubscription)
-  {
-    var subscriptions = FilterStorage.subscriptions;
-    for (var i = 0, len = subscriptions.length; i < len; i++)
-    {
-      var subscription = subscriptions[i];
-      if (subscription.url == featureSubscription.url && subscription instanceof DownloadableSubscription)
-        return subscription;
-    }
-    
-    return null;
-  }
-  
+
+  function toggleTypoCorrectionEnabled()
+  {
+    Prefs.correctTypos = !Prefs.correctTypos;
+  }
+
   function isSubscriptionEnabled(featureSubscription)
   {
-    var subscription = getSubscription(featureSubscription);
-    return subscription != null && !subscription.disabled;
-  }
-  
-  // TODO: check in Chrome
-  function setToggleSubscriptionButton(feature)
-  {
-    var featureSubscription = featureSubscriptions[feature];
-    
-    var element = document.getElementById("toggle-" + feature);
+    return featureSubscription.url in FilterStorage.knownSubscriptions
+      && !Subscription.fromURL(featureSubscription.url).disabled;
+  }
+
+  function setToggleSubscriptionButton(featureSubscription)
+  {
+    var feature = featureSubscription.feature;
+
+    var element = E("toggle-" + feature);
     updateToggleButton(feature, isSubscriptionEnabled(featureSubscription));
-    FilterNotifier.addListener(function(action)
-    {
-      if (/^(filter|subscription)\.(added|removed|disabled)$/.test(action))
-        updateToggleButton(feature, isSubscriptionEnabled(featureSubscription));
-    });
     element.addEventListener("click", function(event)
     {
-      var subscription = getSubscription(featureSubscription);
-      if (subscription == null)
-      {
-        subscription = Subscription.fromURL(featureSubscription.url);
+      var subscription = Subscription.fromURL(featureSubscription.url);
+      if (isSubscriptionEnabled(featureSubscription))
+        FilterStorage.removeSubscription(subscription);
+      else
+      {
         subscription.disabled = false;
         subscription.title = featureSubscription.title;
         subscription.homepage = featureSubscription.homepage;
         FilterStorage.addSubscription(subscription);
-        if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
+        if (!subscription.lastDownload)
           Synchronizer.execute(subscription);
       }
-      else if (!subscription.disabled)
-        FilterStorage.removeSubscription(subscription);
-      else
-        subscription.disabled = false;
     }, false);
   }
 
   function scrollPage()
   {
     if (scrollTimer)
       stopScroll();
 
     scrollTimer = setInterval(function()
     {
       window.scrollBy(0, 5);
     }, 20);
   }
 
   function stopScroll()
   {
     clearTimeout(scrollTimer);
     scrollTimer = null;
   }
 
   function openSharePopup(url)
   {
-    var iframe = document.getElementById("share-popup");
-    var glassPane = document.getElementById("glass-pane");
+    var iframe = E("share-popup");
+    var glassPane = E("glass-pane");
     var popupMessageReceived = false;
 
     var popupMessageListener = function(event)
     {
       var originFilter = Filter.fromText("||adblockplus.org^");
       if (!originFilter.matches(event.origin, "OTHER", null, null))
         return;
 
       var width = event.data.width;
       var height = event.data.height;
@@ skipping 32 matching lines @@
 
     iframe.src = url;
     glassPane.className = "visible";
   }
 
   function initSocialLinks(variant)
   {
     var networks = ["twitter", "facebook", "gplus"];
     networks.forEach(function(network)
     {
-      var link = document.getElementById("share-" + network);
+      var link = E("share-" + network);
       link.addEventListener("click", function(e)
       {
         e.preventDefault();
-        openSharePopup(getDocLink("share-" + network) + "&variant=" + variant);
+        openSharePopup(Utils.getDocLink("share-" + network) + "&variant=" + variant);
       }, false);
     });
   }
 
   function setLinks(id)
   {
-    var element = document.getElementById(id);
+    var element = E(id);
     if (!element)
       return;
 
     var links = element.getElementsByTagName("a");
     for (var i = 0; i < links.length; i++)
     {
       if (typeof arguments[i + 1] == "string")
       {
         links[i].href = arguments[i + 1];
         links[i].setAttribute("target", "_blank");
       }
       else if (typeof arguments[i + 1] == "function")
       {
         links[i].href = "javascript:void(0);";
         links[i].addEventListener("click", arguments[i + 1], false);
       }
     }
   }
 
-  function getDocLink(page, anchor)
-  {
-    return Prefs.documentation_link
-                .replace(/%LINK%/g, page)
-                .replace(/%LANG%/g, Utils.appLocale) + (anchor ? "#" + anchor : "");
-  }
-
   function openFilters()
   {
-    if (userAgent == "firefox")
+    if (typeof UI != "undefined")
       UI.openFiltersDialog();
-    else if (userAgent == "chrome")
+    else
     {
       backgroundPage.openOptions();
     }
   }
 
   function updateToggleButton(feature, isEnabled)
   {
-    var button = document.getElementById("toggle-" + feature);
+    var button = E("toggle-" + feature);
     button.className = isEnabled ? "disable" : "enable";
     button.textContent = i18n.getMessage(isEnabled ? "firstRun_action_disable" : "firstRun_action_enable");
   }
 
-  document.addEventListener("DOMContentLoaded", loadScripts, false);
+  document.addEventListener("DOMContentLoaded", onDOMLoaded, false);
 })();