Issue 3532 - Generate animation images at runtime

lib/icon.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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/>.
  */
 
 /** @module icon */
 
-const numberOfFrames = 10;
+"use strict";
 
+const frameOpacities =  [0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9,
+                         1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
+                         0.9, 0.8, 0.7, 0.6, 0.5, 0.4, 0.3, 0.2, 0.1, 0.0];
+const numberOfFrames = frameOpacities.length;
+const safariPlatform = require("info").platform == "safari";
+
+let stopAnimation = null;
+let animationPlaying = false;
 let whitelistedState = new ext.PageMap();
-let notificationType = null;
-let animationInterval = null;
-let animationStep = 0;
 
-function getIconPath(whitelisted)
+let loadImageAsCanvas =
+/**
+ * Loads an image and draws it onto a canvas.
+ *
+ * @param {string} url  URL string of the image to load
+ * @return {Promise}
+ */
+exports.loadImageAsCanvas = function(url)
 {
-  let filename = "icons/abp-$size";
+  return new Promise((resolve, reject) => {
+    let image = new Image();
+    image.src = url;
+    image.addEventListener("load", () =>
+    {
+      let canvas = document.createElement("canvas");
+      let context = canvas.getContext("2d");
+      canvas.height = image.height;
+      canvas.width = image.width;
+      context.drawImage(image, 0, 0);
+      resolve(canvas);
+    });
+    image.addEventListener("error", () => {
+      reject("Failed to load image " + url);
+    });
+  });
+};
 
-  // If the current page is whitelisted, pick an icon that indicates that
-  // Adblock Plus is disabled, however not when the notification icon has
-  // full opacity, or on Safari where icons are genrally grayscale-only.
-  if (whitelisted && animationStep < numberOfFrames && require("info").platform != "safari")
-    filename += "-whitelisted";
+function setIcon(page, animationType, opacity, frames)
+{
+  opacity = opacity || 0;
+  let greyed = whitelistedState.get(page) && !safariPlatform && true || false;
 
-  // If the icon is currently animating to indicate a pending notification,
-  // pick the icon for the corresponing notification type and animation frame.
-  if (notificationType && animationStep > 0)
+  if (!animationType || !frames)
   {
-    filename += "-notification-" + notificationType;
+    if (animationType && opacity > 0.5)
+      page.browserAction.setIcon("icons/abp-$size-notification-"
+                                 + animationType + ".png");
+    else
+      page.browserAction.setIcon("icons/abp-$size" +
+                                 (greyed ? "-whitelisted" : "") + ".png");
+  }
+  else
+  {
+    frames.then(frames =>
+    {
+      chrome.browserAction.setIcon({
+        tabId: page._id,
+        imageData: {19: frames["" + opacity + greyed + 19],
+                    38: frames["" + opacity + greyed + 38]}
+      });
+    });
+  }
+}
 
-    if (animationStep < numberOfFrames)
-      filename += "-" + animationStep;
+function renderFrames(animationType)
+{
+  return Promise.all([
+    loadImageAsCanvas("icons/abp-19.png"),
+    loadImageAsCanvas("icons/abp-19-whitelisted.png"),
+    loadImageAsCanvas("icons/abp-19-notification-" + animationType + ".png"),
+    loadImageAsCanvas("icons/abp-38.png"),
+    loadImageAsCanvas("icons/abp-38-whitelisted.png"),
+    loadImageAsCanvas("icons/abp-38-notification-" + animationType + ".png"),
+  ]).then(images =>
+  {
+    let images = {
+      19: { base: [images[0], images[1]], overlay: images[2] },
+      38: { base: [images[3], images[4]], overlay: images[5] }
+    };
+
+    let frames = {};
+    let canvas = document.createElement("canvas");
+    let context = canvas.getContext("2d");
+
+    for (let size of [19, 38])
+    {
+      canvas.width = size;
+      canvas.height = size;
+      for (let whitelisted of [false, true])
+      {
+        for (let opacity of [0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1])
+        {
+          context.globalAlpha = 1;
+          context.drawImage(images[size]["base"][whitelisted | 0], 0, 0);
+          context.globalAlpha = opacity;
+          context.drawImage(images[size]["overlay"], 0, 0);
+          frames["" + opacity +
+                 whitelisted + size] = context.getImageData(0, 0, size, size);
+        }
+      }
+    }
+
+    return frames;
+  });
+}
+
+function runAnimation(animationType)
+{
+  let frames = !safariPlatform && renderFrames(animationType);
+  let frameInterval;
+
+  function playAnimation()
+  {
+    animationPlaying = true;
+    let animationStep = 0;
+    ext.pages.query({active: true}, pages =>
+    {
+      function appendActivePage(page)
+      {
+        pages.push(page);
+      }
+      ext.pages.onActivated.addListener(appendActivePage);
+
+      frameInterval = setInterval(() =>
+      {
+        pages.forEach(page => {
+          if (whitelistedState.has(page))
+            setIcon(page, animationType,
+                    frameOpacities[animationStep++], frames);
+        });
+        if (animationStep > numberOfFrames)
+        {
+          animationStep = 0;
+          clearInterval(frameInterval);
+          animationPlaying = false;
+          ext.pages.onActivated.removeListener(appendActivePage);
+        }
+      }, 100);
+    });
   }
 
-  return filename + ".png";
-}
-
-function setIcon(page)
-{
-  page.browserAction.setIcon(getIconPath(whitelistedState.get(page)));
-}
-
-function runAnimation()
-{
-  return setInterval(function()
+  playAnimation();
+  let animationInterval = setInterval(playAnimation, 10000);
+  return () =>
   {
-    ext.pages.query({active: true}, function(pages)
-    {
-      let fadeInInterval = setInterval(function()
-      {
-        animationStep++;
-        pages.forEach(setIcon);
-
-        if (animationStep < numberOfFrames)
-          return;
-
-        setTimeout(function()
-        {
-          let fadeOutInterval = setInterval(function()
-          {
-            animationStep--;
-            pages.forEach(setIcon);
-
-            if (animationStep > 0)
-              return;
-
-            clearInterval(fadeOutInterval);
-          }, 100);
-        },1000);
-
-        clearInterval(fadeInInterval);
-      }, 100);
-    });
-  }, 10000);
+    clearInterval(frameInterval);
+    clearInterval(animationInterval);
+    animationPlaying = false;
+  };
 }
 
 /**
  * Set the browser action icon for the given page, indicating whether
  * adblocking is active there, and considering the icon animation.
  *
  * @param {Page}    page         The page to set the browser action icon for
  * @param {Boolean} whitelisted  Whether the page has been whitelisted
  */
 exports.updateIcon = function(page, whitelisted)
 {
-  page.browserAction.setIcon(getIconPath(whitelisted));
   whitelistedState.set(page, whitelisted);
+  if (!animationPlaying)
+    setIcon(page);
 };
 
 /**
  * Starts to animate the browser action icon to indicate a pending notifcation.
  *
  * @param {string} type  The notification type (i.e: "information" or "critical")
  */
 exports.startIconAnimation = function(type)
 {
-  notificationType = type;
-
-  if (animationInterval == null)
-    animationInterval = runAnimation();
+  stopAnimation && stopAnimation();
+  stopAnimation = runAnimation(type);
 };
 
 /**
  * Stops to animate the browser action icon.
  */
 exports.stopIconAnimation = function()
 {
-  if (animationInterval != null)
-  {
-    clearInterval(animationInterval);
-    animationInterval = null;
-  }
-
-  notificationType  = null;
+  stopAnimation && stopAnimation();
 };