Issue 2082 - Detect existing tabs when loading extension on Safari

safari/ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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()
 {
-  /* Pages */
+  /* Context menus */
 
-  var pages = Object.create(null);
-  var pageCounter = 0;
+  var contextMenuItems = new ext.PageMap();
 
-  var Page = function(id, tab, url)
+  var ContextMenus = function(page)
   {
-    this._id = id;
-    this._tab = tab;
-    this._frames = [{url: new URL(url), parent: null}];
+    this._page = page;
+  };
+  ContextMenus.prototype = {
+    create: function(item)
+    {
+      var items = contextMenuItems.get(this._page);
+      if (!items)
+        contextMenuItems.set(this._page, items = []);
 
-    if (tab.page)
-      this._messageProxy = new ext._MessageProxy(tab.page);
-    else
-      // while the new tab page is shown on Safari 7, the 'page' property
-      // of the tab is undefined, and we can't send messages to that page
-      this._messageProxy = {
-        handleRequest: function() {},
-        handleResponse: function() {},
-        sendMessage: function() {}
-      };
-
-    this.browserAction = new BrowserAction(this);
-    this.contextMenus = new ContextMenus(this);
-  };
-  Page.prototype = {
-    get url()
+      items.push(item);
+    },
+    removeAll: function()
     {
-      return this._frames[0].url;
-    },
-    sendMessage: function(message, responseCallback)
-    {
-      this._messageProxy.sendMessage(message, responseCallback, {pageId: this._id});
+      contextMenuItems.delete(this._page);
     }
   };
 
-  ext._getPage = function(id)
+  safari.application.addEventListener("contextmenu", function(event)
   {
-    return pages[id];
-  };
-
-  var isPageActive = function(page)
-  {
-    var tab = page._tab;
-    var win = tab.browserWindow;
-    return win && tab == win.activeTab && page == tab._visiblePage;
-  };
-
-  var forgetPage = function(id)
-  {
-    ext._removeFromAllPageMaps(id);
-
-    delete pages[id]._tab._pages[id];
-    delete pages[id];
-  };
-
-  var replacePage = function(page)
-  {
-    var tab = page._tab;
-    tab._visiblePage = page;
-
-    for (var id in tab._pages)
-    {
-      if (id != page._id)
-        forgetPage(id);
-    }
-
-    if (isPageActive(page))
-      updateToolbarItemForPage(page, tab.browserWindow);
-  };
-
-  ext.pages = {
-    open: function(url, callback)
-    {
-      var tab = safari.application.activeBrowserWindow.openTab();
-      tab.url = url;
-
-      if (callback)
-      {
-        var onLoading = function(page)
-        {
-          if (page._tab == tab)
-          {
-            ext.pages.onLoading.removeListener(onLoading);
-            callback(page);
-          }
-        };
-        ext.pages.onLoading.addListener(onLoading);
-      }
-    },
-    query: function(info, callback)
-    {
-      var matchedPages = [];
-
-      for (var id in pages)
-      {
-        var page = pages[id];
-        var win = page._tab.browserWindow;
-
-        if ("active" in info && info.active != isPageActive(page))
-          continue;
-        if ("lastFocusedWindow" in info && info.lastFocusedWindow != (win == safari.application.activeBrowserWindow))
-          continue;
-
-        matchedPages.push(page);
-      };
-
-      callback(matchedPages);
-    },
-    onLoading: new ext._EventTarget()
-  };
-
-  safari.application.addEventListener("close", function(event)
-  {
-    // this event is dispatched on closing windows and tabs. However when a
-    // window is closed, it is first dispatched on each tab in the window and
-    // then on the window itself. But we are only interested in closed tabs.
-    if (!(event.target instanceof SafariBrowserTab))
+    if (!event.userInfo)
       return;
 
-    // when a tab is closed, forget the previous page associated with that
-    // tab. Note that it wouldn't be sufficient do that when the old page
-    // is unloading, because Safari dispatches window.onunload only when
-    // reloading the page or following links, but not when closing the tab.
-    for (var id in event.target._pages)
-      forgetPage(id);
-  }, true);
+    var pageId = event.userInfo.pageId;
+    if (!pageId)
+      return;
+
+    var page = pages[event.userInfo.pageId];
+    var items = contextMenuItems.get(page);
+    if (!items)
+      return;
+
+    var context = event.userInfo.tagName;
+    if (context == "img")
+      context = "image";
+
+    for (var i = 0; i < items.length; i++)
+    {
+      // Supported contexts are: all, audio, image, video
+      var menuItem = items[i];
+      if (menuItem.contexts.indexOf("all") == -1 && menuItem.contexts.indexOf(context) == -1)
+        continue;
+
+      event.contextMenu.appendContextMenuItem(i, menuItem.title);
+    }
+  });
+
+  safari.application.addEventListener("command", function(event)
+  {
+    var page = pages[event.userInfo.pageId];
+    var items = contextMenuItems.get(page);
+
+    items[event.command].onclick(page);
+  });
 
 
   /* Browser actions */
 
   var toolbarItemProperties = {};
 
   var getToolbarItemForWindow = function(win)
   {
     for (var i = 0; i < safari.extension.toolbarItems.length; i++)
     {
@@ skipping 66 matching lines @@
       return;
 
     // update the toolbar item for the page visible in the tab that just
     // became active. If we can't find that page (e.g. when a page was
     // opened in a new tab, and our content script didn't run yet), the
     // toolbar item of the window, is reset to its intial configuration.
     updateToolbarItemForPage(event.target._visiblePage, event.target.browserWindow);
   }, true);
 
 
-  /* Context menus */
+  /* Pages */
 
-  var contextMenuItems = new ext.PageMap();
+  var pages = Object.create(null);
+  var pageCounter = 0;
 
-  var ContextMenus = function(page)
+  var Page = function(id, tab, url)
   {
-    this._page = page;
+    this._id = id;
+    this._tab = tab;
+    this._frames = [{url: new URL(url), parent: null}];
+
+    if (tab.page)
+      this._messageProxy = new ext._MessageProxy(tab.page);
+    else
+      // while the new tab page is shown on Safari 7, the 'page' property
+      // of the tab is undefined, and we can't send messages to that page
+      this._messageProxy = {
+        handleRequest: function() {},
+        handleResponse: function() {},
+        sendMessage: function() {}
+      };
+
+    this.browserAction = new BrowserAction(this);
+    this.contextMenus = new ContextMenus(this);
   };
-  ContextMenus.prototype = {
-    create: function(item)
+  Page.prototype = {
+    get url()
     {
-      var items = contextMenuItems.get(this._page);
-      if (!items)
-        contextMenuItems.set(this._page, items = []);
-
-      items.push(item);
+      return this._frames[0].url;
     },
-    removeAll: function()
+    sendMessage: function(message, responseCallback)
     {
-      contextMenuItems.delete(this._page);
+      this._messageProxy.sendMessage(message, responseCallback, {pageId: this._id});
     }
   };
 
-  safari.application.addEventListener("contextmenu", function(event)
+  ext._getPage = function(id)
   {
-    if (!event.userInfo)
+    return pages[id];
+  };
+
+  var isPageActive = function(page)
+  {
+    var tab = page._tab;
+    var win = tab.browserWindow;
+    return win && tab == win.activeTab && page == tab._visiblePage;
+  };
+
+  var forgetPage = function(id)
+  {
+    ext._removeFromAllPageMaps(id);
+
+    delete pages[id]._tab._pages[id];
+    delete pages[id];
+  };
+
+  var replacePage = function(page)
+  {
+    var tab = page._tab;
+    tab._visiblePage = page;
+
+    for (var id in tab._pages)
+    {
+      if (id != page._id)
+        forgetPage(id);
+    }
+
+    if (isPageActive(page))
+      updateToolbarItemForPage(page, tab.browserWindow);
+  };
+
+  var addPage = function(tab, url, prerendered)

[Sebastian Noack, 2015/03/03 19:51:34]

This function is new.

+  {
+    var pageId = ++pageCounter;
+
+    if (!('_pages' in tab))
+      tab._pages = Object.create(null);
+
+    var page = new Page(pageId, tab, url);
+    pages[pageId] = tab._pages[pageId] = page;
+

[kzar, 2015/03/04 10:46:57]

Seems a shame you stripped out the useful comment when splitting this off into a
separate function.

[Sebastian Noack, 2015/03/04 11:04:35]

I've re-added that comment. Also added some more comments explaining what the
new code does.

+    if (!prerendered)
+      replacePage(page);
+
+    return pageId;
+  };
+
+  ext.pages = {
+    open: function(url, callback)
+    {
+      var tab = safari.application.activeBrowserWindow.openTab();
+      tab.url = url;
+
+      if (callback)
+      {
+        var onLoading = function(page)
+        {
+          if (page._tab == tab)
+          {
+            ext.pages.onLoading.removeListener(onLoading);
+            callback(page);
+          }
+        };
+        ext.pages.onLoading.addListener(onLoading);
+      }
+    },
+    query: function(info, callback)
+    {
+      var matchedPages = [];
+
+      for (var id in pages)
+      {
+        var page = pages[id];
+        var win = page._tab.browserWindow;
+
+        if ("active" in info && info.active != isPageActive(page))
+          continue;
+        if ("lastFocusedWindow" in info && info.lastFocusedWindow != (win == safari.application.activeBrowserWindow))
+          continue;
+
+        matchedPages.push(page);
+      };
+
+      callback(matchedPages);
+    },
+    onLoading: new ext._EventTarget()
+  };
+
+  safari.application.addEventListener("close", function(event)
+  {
+    // this event is dispatched on closing windows and tabs. However when a
+    // window is closed, it is first dispatched on each tab in the window and
+    // then on the window itself. But we are only interested in closed tabs.
+    if (!(event.target instanceof SafariBrowserTab))
       return;
 
-    var pageId = event.userInfo.pageId;
-    if (!pageId)
-      return;
+    // when a tab is closed, forget the previous page associated with that
+    // tab. Note that it wouldn't be sufficient do that when the old page
+    // is unloading, because Safari dispatches window.onunload only when
+    // reloading the page or following links, but not when closing the tab.
+    for (var id in event.target._pages)
+      forgetPage(id);
+  }, true);
 
-    var page = pages[event.userInfo.pageId];
-    var items = contextMenuItems.get(page);
-    if (!items)
-      return;
+  safari.application.browserWindows.forEach(function(win)

[Sebastian Noack, 2015/03/03 19:51:34]

This is where we detect existing tabs now.

+  {
+    for (var i = 0; i < win.tabs.length; i++)
+    {
+      var tab = win.tabs[i];
+      var url = tab.url;
 
-    var context = event.userInfo.tagName;
-    if (context == "img")
-      context = "image";
-
-    for (var i = 0; i < items.length; i++)
-    {
-      // Supported contexts are: all, audio, image, video
-      var menuItem = items[i];
-      if (menuItem.contexts.indexOf("all") == -1 && menuItem.contexts.indexOf(context) == -1)
-        continue;
-
-      event.contextMenu.appendContextMenuItem(i, menuItem.title);
+      if (url)
+        addPage(tab, url, false);
     }
   });
 
-  safari.application.addEventListener("command", function(event)
-  {
-    var page = pages[event.userInfo.pageId];
-    var items = contextMenuItems.get(page);
-
-    items[event.command].onclick(page);
-  });
-
 
   /* Web requests */

[Sebastian Noack, 2015/03/03 19:51:34]

All other code above this line is unchanged. I merely moved the context menu
code above the browser action code, and the browser action code above the Page
class. I had to do so in order to synchronously create Page objects.

 
   ext.webRequest = {
     onBeforeRequest: new ext._EventTarget(),
     handlerBehaviorChanged: function() {},
     indistinguishableTypes: [["OTHER", "FONT"]]
   };
 
 
   /* Background page proxy (for access from content scripts) */
 
@@ skipping 213 matching lines @@
         {
           case "loading":
             var tab = event.target;
             var message = event.message;
 
             var pageId;
             var frameId;
 
             if (message.isTopLevel)
             {
-              pageId = ++pageCounter;
+              pageId = addPage(tab, message.url, message.isPrerendered);
               frameId = 0;
 
-              if (!('_pages' in tab))
-                tab._pages = Object.create(null);
-
-              var page = new Page(pageId, tab, message.url);
-              pages[pageId] = tab._pages[pageId] = page;
-
-              // when a new page is shown, forget the previous page associated
-              // with its tab, and reset the toolbar item if necessary.
-              // Note that it wouldn't be sufficient to do that when the old
-              // page is unloading, because Safari dispatches window.onunload
-              // only when reloading the page or following links, but not when
-              // you enter a new URL in the address bar.
-              if (!message.isPrerendered)
-                replacePage(page);
-
-              ext.pages.onLoading._dispatch(page);
+              ext.pages.onLoading._dispatch(pages[pageId]);
             }
             else
             {
               var page;
               var parentFrame;
 
               var lastPageId;
               var lastPage;
               var lastPageTopLevelFrame;
 
@@ skipping 30 matching lines @@
               if (!page)
               {
                 pageId = lastPageId;
                 page = lastPage;
                 parentFrame = lastPageTopLevelFrame;
               }
 
               frameId = page._frames.length;
               page._frames.push({url: new URL(message.url), parent: parentFrame});
             }
-
             event.message = {pageId: pageId, frameId: frameId};
             break;
           case "webRequest":
             var page = pages[event.message.pageId];
             var frame = page._frames[event.message.frameId];
 
             var results = ext.webRequest.onBeforeRequest._dispatch(
               new URL(event.message.url, frame.url),
               event.message.type, page, frame
             );
@@ skipping 58 matching lines @@
         tab.activate();
         if (callback)
           callback(page);
         return;
       }
     }
 
     ext.pages.open(optionsUrl, callback);
   };
 })();