Issue 4023 - Use localforage (IndexedDB) instead of localStorage

lib/adblockplus.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 339 matching lines @@
 require.scopes["io"] = (function()
 {
   var exports = {};
   var keyPrefix = "file:";
 
   function fileToKey(file)
   {
     return keyPrefix + (file instanceof FakeFile ? file.path : file.spec);
   }
 
-  function loadFile(file)
+  function loadFile(file, successCallback, errorCallback)
   {
-    return new Promise(function(resolve, reject)
+    var key = fileToKey(file);
+    var entry = localStorage.getItem(key);
+    if (entry)
     {
-      var key = fileToKey(file);
-      ext.storage.get([key], function(items)
+      try
       {
-        var entry = items[key];
-        if (!entry)
-        {
-          try
-          {
-            entry = JSON.parse(window.localStorage.getItem(key));
-          }
-          catch (err)
-          {}
-        }
-        if (entry)
-        {
-          resolve(entry);
-        }
-        else
-        {
-          reject(new Error("File doesn't exist"));
-        }
-      });
-    }.bind(this));
-  }
-  function saveFile(file, data, callback)
-  {
-    var entry = {};
-    var key = fileToKey(file);
-
-    if (typeof browser == "undefined")
-    {
-      entry[key] = {
-        lastModified: Date.now(),
-        content: data
-      };
-      ext.storage.set(entry, callback);
+        setTimeout(successCallback(JSON.parse(entry)), 0);

[Sebastian Noack, 2016/10/06 23:38:35]

Not too important but you can call setTimout() without secomd parameter. That is
equivalent to passing 0. Not sure if it is worth catching that theoretical error
in the first place.

[Oleksandr, 2016/10/07 16:29:17]

Done. But I think it wouldn't hurt catching an error here. I stumbled across
this when I tried my synthetic test of upgrade. Who knows what can be found in
localStorage, really... Users can edit it manually too, in theory.

[kzar, 2016/10/07 17:00:00]

Wouldn't this also catch an exception thrown by the successCallback function,
resulting in both successCallback and errorCallback to be called?

[Oleksandr, 2016/10/07 17:21:06]

Yes, but I think that's expected, no?

+      }
+      catch(err) 
+      {
+        setTimeout(errorCallback(new Error("File is corrupted")), 0);
+      }
     }
     else
     {
-      var processedData = LZString.compressToUTF16(JSON.stringify(data));
-      ext.storage.remove(key);
-      entry[key] = {
-        lastModified: Date.now(),
-        content: processedData,
-        compressed: true
-      };
-      window.localStorage.setItem(key, JSON.stringify(entry[key]));
-      setTimeout(callback, 0);
+      localforage.getItem(key, function(err, value) 
+      {
+        if (err || !value)
+          errorCallback(new Error("File doesn't exist"));                
+        else
+          successCallback(value);
+      });
     }
-    callback();
+  }
+
+  function saveFile(file, data, callback)
+  {
+    var key = fileToKey(file);
+    var entry = {
+      lastModified: Date.now(),
+      content: data
+    };
+
+    localStorage.removeItem(key);
+    localforage.setItem(key, entry, callback);
   }
   exports.IO = {
     resolveFilePath: function(path)
     {
       return new FakeFile(path);
     },
     readFromFile: function(file, listener, callback)
     {
       function onLoaded(entry)
       {
         if ("content" in entry)
         {
-          if (entry["compressed"])
-          {
-            entry.content = JSON.parse(LZString.decompressFromUTF16(entry.content));
-          }
           for (var _loopIndex15 = 0; _loopIndex15 < entry.content.length; ++_loopIndex15)
           {
             var line = entry.content[_loopIndex15];
             listener.process(line);
           }
         }
         callback(null);
       }
-      loadFile(file).then(onLoaded, callback);
+      loadFile(file, onLoaded, callback);
     },
     writeToFile: function(file, data, callback)
     {
       saveFile(file, data, callback);
     },
     copyFile: function(fromFile, toFile, callback)
     {
       function onLoaded(entry)
       {
         saveFile(toFile, entry.content, callback);
       }
-      loadFile(file).then(onLoaded, callback);
+      loadFile(file, onLoaded, callback);
     },
     renameFile: function(fromFile, newName, callback)
     {
       function onLoaded()
       {
         ext.storage.remove(fileToKey(fromFile), function()
         {
           ext.storage.set(keyPrefix + newName, entry, callback);
         });
       }
-      loadFile(file).then(onLoaded, callback);
+      loadFile(file, onLoaded, callback);
     },
     removeFile: function(file, callback)
     {
       ext.storage.remove(fileToKey(file), callback);
     },
     statFile: function(file, callback)
     {
       function onLoaded(entry)
       {
         callback(null,
         {
           exists: true,
           lastModified: entry.lastModified
         });
       }
-      loadFile(file).then(onLoaded, callback);
+      loadFile(file, onLoaded, callback);
     }
   };
   return exports;
 })();
 require.scopes["downloader"] = (function()
 {
   var exports = {};
   var Utils = require("utils").Utils;
   var MILLIS_IN_SECOND = exports.MILLIS_IN_SECOND = 1000;
   var MILLIS_IN_MINUTE = exports.MILLIS_IN_MINUTE = 60 * MILLIS_IN_SECOND;
@@ skipping 6088 matching lines @@
     search.push("notificationDownloadCount=" + encodeURIComponent(downlCount));
     chrome.runtime.setUninstallURL(Utils.getDocLink("uninstalled") + "&" + search.join("&"));
   }
   if ("setUninstallURL" in chrome.runtime)
   {
     Prefs.untilLoaded.then(setUninstallURL);
     Prefs.on("notificationdata", setUninstallURL);
   }
   return exports;
 })();