Issue 2040 - Replaced localStorage with chrome.storage.local

chrome/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
@@ skipping 313 matching lines @@
   ext.getFrame = function(tabId, frameId)
   {
     return (framesOfTabs[tabId] || {})[frameId];
   };
 
   ext.webRequest = {
     onBeforeRequest: new ext._EventTarget(),
     handlerBehaviorChanged: chrome.webRequest.handlerBehaviorChanged
   };
 
+  // Since Chrome 38 requests of type 'object' (e.g. requests
+  // initiated by Flash) are mistakenly reported with the type 'other'.
+  // https://code.google.com/p/chromium/issues/detail?id=410382
+  if (parseInt(navigator.userAgent.match(/\bChrome\/(\d+)/)[1], 10) >= 38)
+  {
+    ext.webRequest.indistinguishableTypes = [
+      ["OTHER", "OBJECT", "OBJECT_SUBREQUEST"]
+    ];
+  }
+  else
+  {
+    ext.webRequest.indistinguishableTypes = [
+      ["OBJECT", "OBJECT_SUBREQUEST"],
+      ["OTHER", "MEDIA", "FONT"]
+    ];
+  }
+
   chrome.tabs.query({}, function(tabs)
   {
     tabs.forEach(function(tab)
     {
       chrome.webNavigation.getAllFrames({tabId: tab.id}, function(details)
       {
         if (details && details.length > 0)
         {
           var frames = framesOfTabs[tab.id] = Object.create(null);
 
@@ skipping 15 matching lines @@
   chrome.webRequest.onBeforeRequest.addListener(function(details)
   {
     try
     {
       // the high-level code isn't interested in requests that aren't related
       // to a tab and since those can only be handled in Chrome, we ignore
       // them here instead of in the browser independent high-level code.
       if (details.tabId == -1)
         return;
 
-      var requestType = details.type;
-      var isMainFrame = requestType == "main_frame" || (
+      var isMainFrame = details.type == "main_frame" || (
 
         // assume that the first request belongs to the top frame. Chrome
         // may give the top frame the type "object" instead of "main_frame".
         // https://code.google.com/p/chromium/issues/detail?id=281711
         details.frameId == 0 && !(details.tabId in framesOfTabs)
       );
 
       var frames = null;
       if (!isMainFrame)
         frames = framesOfTabs[details.tabId];
       if (!frames)
         frames = framesOfTabs[details.tabId] = Object.create(null);
 
       var frame = null;
       var url = new URL(details.url);
       if (!isMainFrame)
       {
         // we are looking for the frame that contains the element that
         // is about to load, however if a frame is loading the surrounding
         // frame is indicated by parentFrameId instead of frameId
         var frameId;
-        if (requestType == "sub_frame")
+        var requestType;
+        if (details.type == "sub_frame")
+        {
           frameId = details.parentFrameId;
+          requestType = "SUBDOCUMENT";
+        }
         else
+        {
           frameId = details.frameId;
+          requestType = details.type.toUpperCase();
+        }
 
         frame = frames[frameId] || frames[Object.keys(frames)[0]];
 
         if (frame)
         {
-          // Since Chrome 38 requests of type 'object' (e.g. requests
-          // initiated by Flash) are mistakenly reported with the type 'other'.
-          // https://code.google.com/p/chromium/issues/detail?id=410382
-          if (requestType == "other" && parseInt(navigator.userAgent.match(/\bChrome\/(\d+)/)[1], 10) >= 38)
-            requestType = "object";
-
           var results = ext.webRequest.onBeforeRequest._dispatch(
             url,
             requestType,
             new Page({id: details.tabId}),
             frame
           );
 
           if (results.indexOf(false) != -1)
             return {cancel: true};
         }
       }
 
       if (isMainFrame || details.type == "sub_frame")
         frames[details.frameId] = {url: url, parent: frame};
     }
     catch (e)
     {
       // recent versions of Chrome cancel the request when an error occurs in
       // the onBeforeRequest listener. However in our case it is preferred, to
       // let potentially some ads through, rather than blocking legit requests.
       console.error(e);
     }
   }, {urls: ["http://*/*", "https://*/*"]}, ["blocking"]);
 
 
   /* Message passing */
 
   chrome.runtime.onMessage.addListener(function(message, rawSender, sendResponse)
   {
-    var sender = {
-      page: new Page(rawSender.tab),
-      frame: {
+    var sender = {};
+
+    // Add "page" and "frame" if the message was sent by a content script.
+    // If sent by popup or the background page itself, there is no "tab".
+    if ("tab" in rawSender)
+    {
+      sender.page = new Page(rawSender.tab);
+      sender.frame = {
         url: new URL(rawSender.url),
         get parent()
         {
           var frames = framesOfTabs[rawSender.tab.id];
 
           if (!frames)
             return null;
 
           if ("frameId" in rawSender)
           {
             // Chrome 41+
             var frame = frames[rawSender.frameId];
             if (frame)
               return frame.parent;
           }
           else
           {
             // Chrome 28-40
             for (var frameId in frames)
             {
               if (frames[frameId].url.href == this.url.href)
                 return frames[frameId].parent;
             }
           }
 
           return frames[0];
         }
-      }
-    };
+      };
+    }
 
     return ext.onMessage._dispatch(message, sender, sendResponse).indexOf(true) != -1;
   });
 
   // We have to ensure there is at least one listener for the onConnect event.
   // Otherwise we can't connect a port later, which we need to do in order to
   // detect when the extension is reloaded, disabled or uninstalled.
   chrome.runtime.onConnect.addListener(function() {});
 
 
@@ skipping 10 matching lines @@
       items[key] = value;
       chrome.storage.local.set(items, callback);
     },
     remove: function(key, callback)
     {
       chrome.storage.local.remove(key, callback);
     },
     onChanged: chrome.storage.onChanged,
 
     // Migrate localStorage to chrome.storage.local,
-    // ignoring unkown and inavlid preferences.
-    migratePrefs: function(prefs)
+    // ignoring unkown and invalid preferences.
+    migratePrefs: function(hooks)
     {
       var items = {};
 
       for (let key in localStorage)
       {
-        var value = localStorage[key];
-
-        if (key in prefs)
-        {
-          try
-          {
-            items["pref:" + key] = JSON.parse(value);

[kzar, 2015/03/09 15:10:29]

Nit: Shouldn't this make use of the const keyPrefix?

[Sebastian Noack, 2015/03/09 15:21:37]

It's not available here, and IMO not worth beeing exported just for the
temporary migration code.

[kzar, 2015/03/09 15:24:28]

Fair enough, yea I agree it doesn't really matter.

-          }
-          catch (e)
-          {
-          }
-        }
-        else if (key == "currentVersion")
-        {
-          items[key] = value;
-        }
+        var item = hooks.map(key, localStorage[key]);
+        if (item)
+          items[item.key] = item.value;
       }
 
       chrome.storage.local.set(items, function() {
         localStorage.clear();
+        hooks.done();
       });
     }
   };
 
   /* Options */
 
   ext.showOptions = function(callback)
   {
     chrome.windows.getLastFocused(function(win)
     {
       var optionsUrl = chrome.extension.getURL("options.html");
       var queryInfo = {url: optionsUrl};
 
       // extension pages can't be accessed in incognito windows. In order to
       // correctly mimic the way in which Chrome opens extension options,
       // we have to focus the options page in any other window.
       if (!win.incognito)
         queryInfo.windowId = win.id;
 
       chrome.tabs.query(queryInfo, function(tabs)
       {
         if (tabs.length > 0)
         {
           var tab = tabs[0];
 
           chrome.windows.update(tab.windowId, {focused: true});
-          chrome.tabs.highlight(
-            {
-              windowId: tab.windowId,
-              tabs: [tab.index]
-            },
-            function() {}
-          );
+          chrome.tabs.update(tab.id, {active: true});
 
           if (callback)
             callback(new Page(tab));
         }
         else
         {
           ext.pages.open(optionsUrl, callback);
         }
       });
     });
   };
 })();