Issue 3687 - Add experimental support for Safari content blockers

safari/ext/background.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
@@ skipping 366 matching lines @@
     {
     },
     getIndistinguishableTypes: function()
     {
       return [];
     }
   };
 
   /* Message processing */
 
+  var dispatchedLegacyAPISupportMessage = false;
   safari.application.addEventListener("message", function(event)
   {
     var tab = event.target;
     var message = event.message;
     var sender;
     if ("documentId" in message && "_documentLookup" in tab)
     {
       sender = tab._documentLookup[message.documentId];
       if (sender)
       {
@@ skipping 15 matching lines @@
 
             event.message = (results.indexOf(false) == -1);
             break;
           case "request":
             var response = null;
             var sendResponse = function(message) { response = message; };
 
             ext.onMessage._dispatch(message.payload, sender, sendResponse);
 
             event.message = response;
-            break;
-          case "useContentBlockerAPI":

[Sebastian Noack, 2016/05/12 11:12:23]

I think this should rather go into safari/contentBlocking.js. Note that you can
send any message synchronously on Safari, e.g. see how the include.youtube.js
does it.

[kzar, 2016/05/17 15:15:40]

As discussed in IRC we can actually use prefs.get instead of adding this
redundant message.

-            event.message = require("prefs").Prefs["safariContentBlocker"];
             break;
         }
         break;
       case "request":
         sender.page._messageProxy.handleRequest(message, sender);
         break;
       case "response":
         // All documents within a page have the same pageId and that's all we
         // care about here.
         var pageId = tab._documentLookup[message.targetDocuments[0]].pageId;
@@ skipping 64 matching lines @@
             pageId = lastPageId;
             page = lastPage;
             parentFrame = lastPageTopLevelFrame;
           }
 
           frameId = page._frames.length;
           page._frames.push({url: new URL(message.url), parent: parentFrame});
         }
 
         tab._documentLookup[documentId] = {pageId: pageId, frameId: frameId};
+
+        if (!dispatchedLegacyAPISupportMessage)
+        {
+          ext.onMessage._dispatch({
+            type: "safari.legacyAPISupported",
+            legacyAPISupported: message.legacyAPISupported
+          });
+          dispatchedLegacyAPISupportMessage = true;
+        }
         break;
       case "documentId":
         tab._documentLookup[message.documentId] = {
           pageId: message.pageId, frameId: 0
         };
         break;
     }
   });
 
 
@@ skipping 71 matching lines @@
   /* Windows */
   ext.windows = {
     // Safari doesn't provide as rich a windows API as Chrome does, so instead
     // of chrome.windows.create we have to fall back to just opening a new tab.
     create: function(createData, callback)
     {
       ext.pages.open(createData.url, callback);
     }
   };
 })();