Adding ABP core modules to ABP/Opera

lib/adblockplus_compat.js

 /*
  * This Source Code is subject to the terms of the Mozilla Public License
  * version 2.0 (the "License"). You can obtain a copy of the License at
  * http://mozilla.org/MPL/2.0/.
  */
 
 // TODO: Parts of this file are identical to ABP/Chrome, these should be split
 // away into a separate file.
 
 //
@@ skipping 92 matching lines @@
   },
   application: "opera"
 };
 
 //
 // IO module: no direct file system access, using FileSystem API
 //
 
 require.scopes.io =
 {
   IO: {

[Felix Dahlke, 2012/10/10 12:11:22]

Opening brace not on its own line?

[Felix Dahlke, 2012/10/11 07:54:28]

Nevermind.

     _getFilePath: function(file)
     {
       if (file instanceof FakeFile)
         return file.path;
       else if ("spec" in file)
         return file.spec;
 
       throw new Error("Unexpected file type");
     },
 
+    _setFileContents: function(path, contents, lastModified)
+    {
+      window.localStorage[path] = contents;
+      window.localStorage[path + "/lastModified"] = lastModified || 0;
+    },
+
     lineBreak: "\n",
 
     resolveFilePath: function(path)
     {
       return new FakeFile(path);
     },
 
     readFromFile: function(file, decode, listener, callback, timeLineID)
     {
-      if ("spec" in file && /^defaults\b/.test(file.spec))

[Felix Dahlke, 2012/10/10 12:11:22]

The first check is not necessary, .test(undefined) will return false.

[Felix Dahlke, 2012/10/11 07:54:28]

Nevermind.

[Wladimir Palant, 2012/10/11 09:36:26]

Still, I don't feel comfortable running regular expressions in undefined values.
I better check first whether this actually is a URL - it also makes clear that
it might not be one.

-      {
-        // Code attempts to read the default patterns.ini, we don't have that.
-        // Make sure to execute first-run actions instead.
-        callback(null);
-        executeFirstRunActions();

[Felix Dahlke, 2012/10/11 07:54:28]

This function cannot be called from here.

-        return;
-      }
-
-      var path = this._getFilePath(file);
-      if (!(path in window.localStorage))
-      {
-        callback(new Error("File doesn't exist"))
-        return;
-      }
-
-      var lines = window.localStorage[path].split(/[\r\n]+/);
-
       // Fake asynchronous execution
       setTimeout(function()
       {
+        if ("spec" in file && /^defaults\b/.test(file.spec))
+        {
+          // Code attempts to read the default patterns.ini, we don't have that.
+          // Make sure to execute first-run actions instead.
+          callback(null);
+          executeFirstRunActions();

[Felix Dahlke, 2012/10/11 13:10:02]

This function cannot be called from here.

+          return;
+        }
+
+        var path = this._getFilePath(file);
+        if (!(path in window.localStorage))
+        {
+          callback(new Error("File doesn't exist"))
+          return;
+        }
+
+        var lines = window.localStorage[path].split(/[\r\n]+/);
         for (var i = 0; i < lines.length; i++)
           listener.process(lines[i]);
         listener.process(null);
         callback(null);
       }.bind(this), 0);
     },
 
     writeToFile: function(file, encode, data, callback, timeLineID)
     {
       var path = this._getFilePath(file);
-      window.localStorage[path] = data.join("\n") + "\n";

[Felix Dahlke, 2012/10/10 12:11:22]

Why not use this.lineBreak?

-      window.localStorage[path + "/lastModified"] = Date.now();
+      this._setFileContents(path, data.join(this.lineBreak) + this.lineBreak, Date.now());
 
       // Fake asynchronous execution
       setTimeout(callback.bind(null, null), 0);
     },
 
     copyFile: function(fromFile, toFile, callback)
     {
       // Simply combine read and write operations
       var data = [];
       this.readFromFile(fromFile, false, {

[Felix Dahlke, 2012/10/10 12:11:22]

Shouldn't the opening brace be on its own line?

         process: function(line)
         {
           if (line !== null)
             data.push(line);
         }
       }, function(e)
       {
         if (e)
           callback(e);
         else
           this.writeToFile(toFile, false, data, callback);
       }.bind(this));
     },
 
     renameFile: function(fromFile, newName, callback)
     {
       var path = this._getFilePath(fromFile);
       if (!(path in window.localStorage))
       {
         callback(new Error("File doesn't exist"))
         return;
       }
 
-      window.localStorage[newName] = window.localStorage[path];
-      window.localStorage[newName + "/lastModified"] = window.localStorage[path + "/lastModified"] || 0;

[Felix Dahlke, 2012/10/10 12:11:22]

How about a function that sets both localStorage[x] and localStorage[x +
"/lastModified"]? lastModified could be optional and default to 0. Could also be
used in writeFile() above.

-      delete window.localStorage[path];
-      delete window.localStorage[path + "/lastModified"];
-      callback(null);
+      this._setFileContents(newName, window.localStorage[path], window.localStorage[path + "/lastModified"]);
+      this.removeFile(fromFile, callback);
     },
 
     removeFile: function(file, callback)
     {
       var path = this._getFilePath(file);
       delete window.localStorage[path];

[Felix Dahlke, 2012/10/10 12:11:22]

How about a function to delete both localStorage[x] and localStorage[x +
"/lastModified"]? Could also be used in renameFile() above.

       delete window.localStorage[path + "/lastModified"];
       callback(null);
     },
 
     statFile: function(file, callback)
     {
       var path = this._getFilePath(file);
       callback(null, {
         exists: path in window.localStorage,
         isDirectory: false,
@@ skipping 271 matching lines @@
   status: -1,
   notificationCallbacks: {},
   loadFlags: 0,
   INHIBIT_CACHING: 0,
   VALIDATE_ALWAYS: 0,
   QueryInterface: function()
   {
     return this;
   }
 };