Relocated icon and redesigned icon popup

lib/stats.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/>.
  */
 
 /**
  * @fileOverview Provides usage stats
  */
 
 let {Prefs} = require("prefs");
 let {BlockingFilter} = require("filterClasses");
 let {FilterNotifier} = require("filterNotifier");
 
+let badgeColor = [100, 100, 100, 255];

[Wladimir Palant, 2013/12/03 12:55:43]

I'd prefer "#606060" here - it's more compact and it is more obvious what it
represents.

[Thomas Greiner, 2013/12/04 10:44:50]

Done.

+
 /**
  * Get statistics for specified tab
  * @param  {String} key   field key
  * @param  {Number} tabId tab ID (leave undefined for total stats)
  * @return {Number}       field value
  */
 let getStats = exports.getStats = function getStats(key, tab)
 {
   if (!tab)
     return (key in Prefs.stats_total ? Prefs.stats_total[key] : 0);
 
   let frameData = getFrameData(tab, 0);
   return (frameData && key in frameData ? frameData[key] : 0);
 };
 
 FilterNotifier.addListener(function(action, item, newValue, oldValue, tab)
 {
   if (action != "filter.hitCount")
     return;
   
-  var blocked = item instanceof BlockingFilter;
+  let blocked = item instanceof BlockingFilter;
   
   // Increment counts
   if (blocked)
   {
     if ("blocked" in Prefs.stats_total)
       Prefs.stats_total.blocked++;
     else
       Prefs.stats_total.blocked = 1;
     Prefs.stats_total = Prefs.stats_total;
     
     let frameData = getFrameData(tab, 0);
     if (frameData)
     {
       if ("blocked" in frameData)
         frameData.blocked++;
       else
         frameData.blocked = 1;
     }
+    
+    // Update number in icon
+    if (Prefs.show_iconnumber)
+    {
+      tab.browserAction.setBadgeBackgroundColor(badgeColor);
+      tab.browserAction.setBadgeNumber(frameData.blocked);

[Wladimir Palant, 2013/12/03 12:55:43]

Will this count be automatically removed if the tab location changes?

[Thomas Greiner, 2013/12/04 10:44:50]

Yes, it gets reset implicitly.

+    }
   }
 });
+
+/**
+ * Execute function for each tab in any window
+ * @param  {Function} func function to be executed
+ */
+function forEachTab(func)
+{
+  ext.windows.getAll(function(windows)
+  {
+    for (let i = 0; i < windows.length; i++)

[Wladimir Palant, 2013/12/03 12:55:43]

|for each (let window in windows)| should be a better way to write this,
similarly for tabs below. That's a Firefox-only construct but so is the let
statement.

[Thomas Greiner, 2013/12/04 10:44:50]

Done.

+    {
+      windows[i].getAllTabs(function(tabs)
+      {
+        for (let i = 0; i < tabs.length; i++)
+          func(tabs[i]);
+      });
+    }
+  });
+}
+
+Prefs.addListener(function(name)
+{
+  if (name != "show_iconnumber")
+    return;
+  
+  if (Prefs.show_iconnumber)
+  {
+    // Add number to icon
+    forEachTab(function(tab) {

[Felix Dahlke, 2013/12/02 15:45:58]

Opening brace should go on the next line.

[Thomas Greiner, 2013/12/03 12:06:05]

Done.

+      tab.browserAction.setBadgeBackgroundColor(badgeColor);
+      
+      let frameData = getFrameData(tab, 0);
+      if (frameData && "blocked" in frameData)
+        tab.browserAction.setBadgeNumber(frameData.blocked);

[Felix Dahlke, 2013/12/02 15:45:58]

Shouldn't we set the badge number to null explicitly if something's wrong with
frameData? I think the whole function could be simplified if we do that.

[Thomas Greiner, 2013/12/03 12:06:05]

The value is already null when we get here (either because it hasn't been set
yet or because it was removed previously as seen below) so it seems redundant.

I can, however, put the if(Prefs.show_iconnumber) inside the loop if that's what
you mean with "simplify".

[Felix Dahlke, 2013/12/04 12:30:06]

True, fine like this then.
Yup, I had something like this in mind:

forEachTab(function(tab)
{
  let badgeNumber = null;
  if (Prefs.show_iconnumber)
  {
    let frameData = getFrameData(tab, 0);
    if (frameData && "blocked" in frameData)
      badgeNumber = frameData.blocked;
  }
  tab.browserAction.setBadgeNumber(badgeNumber);
}

[Thomas Greiner, 2013/12/10 10:09:29]

Done.

+    });
+  }
+  else
+  {
+    // Remove number from icon
+    forEachTab(function(tab)
+    {
+      tab.browserAction.setBadgeNumber(null);
+    });
+  }
+});