Issue 1663 - Emulate background page and implement proper message responder

ext/common.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 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/>.
  */
 
 (function(global)
 {
+  if (!global.ext)
+    global.ext = {};
+
+  function Page(source)
+  {
+    this._source = source;
+  }
+  Page.prototype =
+  {
+    equals: function(page)
+    {
+      return page._source == this._source;
+    },
+
+    sendMessage: function(message)
+    {
+      this._source.postMessage({
+        type: "message",
+        messageId: -1,
+        payload: message
+      }, "*");
+    }
+  }
+
+  /* Message passing */
+
+  global.ext.onMessage =
+  {
+    addListener: function(listener)
+    {
+      listener.__wrapper = function(event)

[Thomas Greiner, 2014/12/18 17:32:06]

Two underscores are easy to get wrong and detect when looking for errors. It
should be sufficient to only use a single one and to make the name more specific
(e.g. "_extWrapper").

[Wladimir Palant, 2014/12/18 22:04:44]

Done.

+      {
+        if (event.data.type != "message")
+          return;
+
+        var message = event.data.payload;
+        var messageId = event.data.messageId;
+        var sender = {
+          page: new Page(event.source)
+        };
+        var callback = function(message)
+        {
+          event.source.postMessage({
+            type: "response",
+            messageId: messageId,
+            payload: message
+          }, "*");
+        };
+        listener(message, sender, callback);
+      };
+      window.addEventListener("message", listener.__wrapper, false);
+    },
+
+    removeListener: function(listener)
+    {
+      if ("__wrapper" in listener)
+        window.removeEventListener("message", listener.__wrapper, false);
+    }
+  };
+
   /* I18n */
 
   var getLocaleCandidates = function(selectedLocale)
   {
     var candidates = [];
     var defaultLocale = "en-US";
 
     // e.g. "ja-jp-mac" -> "ja-JP", note that the part after the second
     // dash is dropped, since we only support language and region
     var parts = selectedLocale.split("-");
@@ skipping 73 matching lines @@
       return;
 
     var rawCatalog = JSON.parse(xhr.responseText);
     for (var msgId in rawCatalog)
     {
       if (!(msgId in catalog))
         catalog[msgId] = parseMessage(rawCatalog[msgId]);
     }
   };
 
-  if (!global.ext)
-    global.ext = {};
-
   global.ext.i18n = {
     getMessage: function(msgId, substitutions)
     {
       while (true)
       {
         var message = catalog[msgId];
         if (message)
         {
           var text = message[0];
           var placeholders = message[1];
 
           if (!(substitutions instanceof Array))
             substitutions = [substitutions];
 
           for (var i = 0; i < placeholders.length; i++)
             text = replacePlaceholder(text, placeholders[i], substitutions[i]);
 
           return text;
         }
 
         if (locales.length == 0)
           return "";
 
         readCatalog(locales.shift());
       }
     }
   };
 })(this);