Issue 2040 - Replaced localStorage with chrome.storage.local

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()
 {
+  /* Context menus */
+
+  var contextMenuItems = new ext.PageMap();
+
+  var ContextMenus = function(page)
+  {
+    this._page = page;
+  };
+  ContextMenus.prototype = {
+    create: function(item)
+    {
+      var items = contextMenuItems.get(this._page);
+      if (!items)
+        contextMenuItems.set(this._page, items = []);
+
+      items.push(item);
+    },
+    removeAll: function()
+    {
+      contextMenuItems.delete(this._page);
+    }
+  };
+
+  safari.application.addEventListener("contextmenu", function(event)
+  {
+    if (!event.userInfo)
+      return;
+
+    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++)
+    {
+      var toolbarItem = safari.extension.toolbarItems[i];
+
+      if (toolbarItem.browserWindow == win)
+        return toolbarItem;
+    }
+
+    return null;
+  };
+
+  var updateToolbarItemForPage = function(page, win) {
+    var toolbarItem = getToolbarItemForWindow(win);
+    if (!toolbarItem)
+      return;
+
+    for (var name in toolbarItemProperties)
+    {
+      var property = toolbarItemProperties[name];
+
+      if (page && property.pages.has(page))
+        toolbarItem[name] = property.pages.get(page);
+      else
+        toolbarItem[name] = property.global;
+    }
+  };
+
+  var BrowserAction = function(page)
+  {
+    this._page = page;
+  };
+  BrowserAction.prototype = {
+    _set: function(name, value)
+    {
+      var toolbarItem = getToolbarItemForWindow(this._page._tab.browserWindow);
+      if (!toolbarItem)
+        return;
+
+      var property = toolbarItemProperties[name];
+      if (!property)
+        property = toolbarItemProperties[name] = {
+          pages: new ext.PageMap(),
+          global: toolbarItem[name]
+        };
+
+      property.pages.set(this._page, value);
+
+      if (isPageActive(this._page))
+        toolbarItem[name] = value;
+    },
+    setIcon: function(path)
+    {
+      this._set("image", safari.extension.baseURI + path.replace("$size", "16"));
+    },
+    setBadge: function(badge)
+    {
+      if (!badge)
+        this._set("badge", 0);
+      else if ("number" in badge)
+        this._set("badge", badge.number);
+    }
+  };
+
+  safari.application.addEventListener("activate", function(event)
+  {
+    // this event is also dispatched on windows that got focused. But we
+    // are only interested in tabs, which became active in their window.
+    if (!(event.target instanceof SafariBrowserTab))
+      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);
+
+
   /* Pages */
 
   var pages = Object.create(null);
   var pageCounter = 0;
 
+  var Frame = function(url, parent)
+  {
+    this._urlString = url;
+    this._urlObj = null;
+
+    this.parent = parent;
+  }
+  Frame.prototype = {
+    get url()
+    {
+      // On Safari 6 and before, the URL constuctor doesn't exist.
+      // The "urls" module provides a polifill, but it might not
+      // be loaded yet. So we have to lazily parse URLs.
+      if (!this._urlObj)
+      {
+        this._urlObj = new URL(this._urlString);
+        this._urlString = null;
+      }
+
+      return this._urlObj;
+    }
+  };
+
   var Page = function(id, tab, url)
   {
     this._id = id;
     this._tab = tab;
-    this._frames = [{url: new URL(url), parent: null}];
+    this._frames = [new Frame(url, 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() {}
@@ skipping 41 matching lines @@
     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)
+  {
+    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;
+
+    // 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 (!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)
         {
@@ skipping 37 matching lines @@
       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);
 
-
-  /* Browser actions */
-
-  var toolbarItemProperties = {};
-
-  var getToolbarItemForWindow = function(win)
-  {
-    for (var i = 0; i < safari.extension.toolbarItems.length; i++)
-    {
-      var toolbarItem = safari.extension.toolbarItems[i];
-
-      if (toolbarItem.browserWindow == win)
-        return toolbarItem;
-    }
-
-    return null;
-  };
-
-  var updateToolbarItemForPage = function(page, win) {
-    var toolbarItem = getToolbarItemForWindow(win);
-    if (!toolbarItem)
-      return;
-
-    for (var name in toolbarItemProperties)
-    {
-      var property = toolbarItemProperties[name];
-
-      if (page && property.pages.has(page))
-        toolbarItem[name] = property.pages.get(page);
-      else
-        toolbarItem[name] = property.global;
-    }
-  };
-
-  var BrowserAction = function(page)
-  {
-    this._page = page;
-  };
-  BrowserAction.prototype = {
-    _set: function(name, value)
-    {
-      var toolbarItem = getToolbarItemForWindow(this._page._tab.browserWindow);
-      if (!toolbarItem)
-        return;
-
-      var property = toolbarItemProperties[name];
-      if (!property)
-        property = toolbarItemProperties[name] = {
-          pages: new ext.PageMap(),
-          global: toolbarItem[name]
-        };
-
-      property.pages.set(this._page, value);
-
-      if (isPageActive(this._page))
-        toolbarItem[name] = value;
-    },
-    setIcon: function(path)
-    {
-      this._set("image", safari.extension.baseURI + path.replace("$size", "16"));
-    },
-    setBadge: function(badge)
-    {
-      if (!badge)
-        this._set("badge", 0);
-      else if ("number" in badge)
-        this._set("badge", badge.number);
-    }
-  };
-
-  safari.application.addEventListener("activate", function(event)
-  {
-    // this event is also dispatched on windows that got focused. But we
-    // are only interested in tabs, which became active in their window.
-    if (!(event.target instanceof SafariBrowserTab))
-      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 */
-
-  var contextMenuItems = new ext.PageMap();
-
-  var ContextMenus = function(page)
-  {
-    this._page = page;
-  };
-  ContextMenus.prototype = {
-    create: function(item)
-    {
-      var items = contextMenuItems.get(this._page);
-      if (!items)
-        contextMenuItems.set(this._page, items = []);
-
-      items.push(item);
-    },
-    removeAll: function()
-    {
-      contextMenuItems.delete(this._page);
-    }
-  };
-
-  safari.application.addEventListener("contextmenu", function(event)
-  {
-    if (!event.userInfo)
-      return;
-
-    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);
+  // We generally rely on content scripts to report new pages,
+  // since Safari's extension API doesn't consider pre-rendered
+  // pages. However, when the extension initializes we have to
+  // use  Safari's extension API to detect existing tabs.
+  safari.application.browserWindows.forEach(function(win)
+  {
+    for (var i = 0; i < win.tabs.length; i++)
+    {
+      var tab = win.tabs[i];
+      var url = tab.url;
+
+      // For the new tab page the url property is undefined.
+      if (url)
+        addPage(tab, url, false);
+    }
   });
 
 
   /* Web requests */
 
   ext.webRequest = {
     onBeforeRequest: new ext._EventTarget(),
     handlerBehaviorChanged: function() {},
     indistinguishableTypes: [["OTHER", "FONT"]]
   };
@@ skipping 217 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 28 matching lines @@
               // if we can't find the parent frame and its page, fall back to
               // the page most recently loaded in the tab and its top level frame
               if (!page)
               {
                 pageId = lastPageId;
                 page = lastPage;
                 parentFrame = lastPageTopLevelFrame;
               }
 
               frameId = page._frames.length;
-              page._frames.push({url: new URL(message.url), parent: parentFrame});
+              page._frames.push(new Frame(message.url, 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 45 matching lines @@
       var items = {};
       var settings = safari.extension.settings;
 
       for (var i = 0; i < keys.length; i++)
       {
         var key = keys[i];
         if (key in settings)
           items[key] = settings[key];
       }
 
       setTimeout(callback, 0, items);

[Wladimir Palant, 2015/03/12 23:05:37]

Did you verify that this works on all Safari versions we support? MDN doesn't
know when Safari added support for additional setTimeout parameters.

[Sebastian Noack, 2015/03/12 23:35:29]

I saw this one coming. I checked MDN and made the same observation as you did.
So I tried on Safari 5.1 (the oldest version ABP runs on) and Safari 8 (the
newest one). And also to my surprise that is actually supported. :D

     },
     set: function(key, value, callback)
     {
       safari.extension.settings[key] = value;
 
       if (callback)
         setTimeout(callback, 0);
     },
     remove: function(key, callback)
     {
       delete safari.extension.settings[key];
 
       if (callback)
         setTimeout(callback, 0);
     },
     onChanged: new ext._EventTarget(),
 
     // Preferences were previously encoded as JSON for compatibility
     // with localStorage, which has been used on Chrome.
-    migratePrefs: function(prefs)
+    migratePrefs: function(hooks)
     {
       var settings = safari.extension.settings;
 
       for (var key in settings)
       {
-        if (key in prefs)
+        var item = hooks.map(key, settings[key]);
+
+        if (item)
         {
-          try
-          {
-            settings["pref:" + key] = JSON.parse(settings[key]);
-          }
-          catch (e)
-          {
-          }
-
           delete settings[key];
+          settings[item.key] = item.value;
         }
       }
+
+      hooks.done();
     }
   };
 
   safari.extension.settings.addEventListener("change", function(event)
   {
     var changes = {};
     var change = changes[event.key] = {};
 
     if (event.oldValue != null)
       change.oldValue = event.oldValue;
@@ skipping 20 matching lines @@
         tab.activate();
         if (callback)
           callback(page);
         return;
       }
     }
 
     ext.pages.open(optionsUrl, callback);
   };
 })();