Issue 5279 - Fix broken I/O in non-Firefox applications

lib/io.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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 58 matching lines @@
   });
 }
 
 function legacyFile(fileName)
 {
   let file = LegacyIO.resolveFilePath("adblockplus");
   file.append(fileName);
   return file;
 }
 
+let fallback = {
+  readFromFile(fileName, listener)
+  {
+    let wrapper = {
+      process(line)
+      {
+        if (line !== null)
+          listener(line);
+      }
+    };
+    return callLegacy("readFromFile", legacyFile(fileName), wrapper);
+  },
+
+  writeToFile(fileName, data)
+  {
+    return callLegacy("writeToFile", legacyFile(fileName), data);
+  },
+
+  copyFile(fromFile, toFile)
+  {
+    return callLegacy("copyFile", legacyFile(fromFile), legacyFile(toFile));
+  },
+
+  renameFile(fromFile, newName)
+  {
+    return callLegacy("renameFile", legacyFile(fromFile), newName);
+  },
+
+  removeFile(fileName)
+  {
+    return callLegacy("removeFile", legacyFile(fileName));
+  },
+
+  statFile(fileName)
+  {
+    return callLegacy("statFile", legacyFile(fileName));
+  }
+};
+
 exports.IO =
 {
   /**
    * @callback TextSink
    * @param {string} line
    */
 
   /**
    * Reads text lines from a file.
    * @param {string} fileName
@@ skipping 20 matching lines @@
             {
               Utils.runAsync(processBatch);
               return;
             }
           }
           resolve();
         }
 
         processBatch();
       });
-    }).catch(error =>
-    {
-      if (error == "NoSuchFile")
-      {
-        let wrapper = {
-          process(line)
-          {
-            if (line !== null)
-              listener(line);
-          }
-        };
-        return callLegacy("readFromFile", legacyFile(fileName), wrapper);
-      }
-      throw error;
     });
   },
 
   /**
    * Writes text lines to a file.
    * @param {string} fileName
    *    Name of the file to be written
    * @param {Iterable.<string>} data
    *    An array-like or iterable object containing the lines (without line
    *    endings)
    * @return {Promise}
    *    Promise to be resolved or rejected once the operation is completed
    */
   writeToFile(fileName, data)
   {
     return callWebExt("writeToFile", fileName, Array.from(data));
   },
 
   /**
    * Copies a file.
    * @param {string} fromFile
    *    Name of the file to be copied
    * @param {string} toFile
    *    Name of the file to be written, will be overwritten if exists
    * @return {Promise}
    *    Promise to be resolved or rejected once the operation is completed
    */
   copyFile(fromFile, toFile)
   {
-    return callWebExt("copyFile", fromFile, toFile).catch(error =>
-    {
-      if (error == "NoSuchFile")
-        return callLegacy("copyFile", legacyFile(fromFile), legacyFile(toFile));
-      throw error;
-    });
+    return callWebExt("copyFile", fromFile, toFile);
   },
 
   /**
    * Renames a file.
    * @param {string} fromFile
    *    Name of the file to be renamed
    * @param {string} newName
    *    New file name, will be overwritten if exists
    * @return {Promise}
    *    Promise to be resolved or rejected once the operation is completed
    */
   renameFile(fromFile, newName)
   {
-    return callWebExt("renameFile", fromFile, newName).catch(error =>
-    {
-      if (error == "NoSuchFile")
-        return callLegacy("renameFile", legacyFile(fromFile), newName);
-      throw error;
-    });
+    return callWebExt("renameFile", fromFile, newName);
   },
 
   /**
    * Removes a file.
    * @param {string} fileName
    *    Name of the file to be removed
    * @return {Promise}
    *    Promise to be resolved or rejected once the operation is completed
    */
   removeFile(fileName)
   {
-    return callWebExt("removeFile", fileName).catch(error =>
-    {
-      if (error == "NoSuchFile")
-        return callLegacy("removeFile", legacyFile(fileName));
-      throw error;
-    });
+    return callWebExt("removeFile", fileName);
   },
 
   /**
    * @typedef StatData
    * @type {object}
    * @property {boolean} exists
    *    true if the file exists
    * @property {number} lastModified
    *    file modification time in milliseconds
    */
 
   /**
    * Retrieves file metadata.
    * @param {string} fileName
    *    Name of the file to be looked up
    * @return {Promise.<StatData>}
    *    Promise to be resolved with file metadata once the operation is
    *    completed
    */
   statFile(fileName)
   {
-    return callWebExt("statFile", fileName).catch(error =>
-    {
-      if (error == "NoSuchFile")
-        return callLegacy("statFile", legacyFile(fileName));
-      throw error;
-    });
+    return callWebExt("statFile", fileName);
   }
 };
+
+let {application} = require("info");
+if (application != "firefox" && application != "fennec2")
+{
+  // Currently, only Firefox has a working WebExtensions implementation, other
+  // applications should just use the fallback.
+  exports.IO = fallback;
+}
+else
+{
+  for (let name of [
+    "readFromFile", "copyFile", "renameFile", "removeFile", "statFile"

[Felix Dahlke, 2017/05/29 12:22:30]

We could avoid duplication here by iterating over the own properties in
fallback, just skipping over writeToFile.

[Wladimir Palant, 2017/05/29 12:41:23]

Done.

+  ])
+  {
+    // For missing files, fall back to legacy I/O for all methods except

[Felix Dahlke, 2017/05/29 12:22:30]

Nit: I think that comment should move in front of the `for` above, since the
logic starts there.

[Wladimir Palant, 2017/05/29 12:41:23]

Done.

+    // writeToFile()
+    let method = exports.IO[name];
+    let fallbackMethod = fallback[name];
+    exports.IO[name] = (...args) =>
+    {
+      return method(...args).catch(error =>
+      {
+        if (error == "NoSuchFile")
+          return fallbackMethod(...args);
+        throw error;
+      });
+    };
+  }
+}