storage.js

/*
 * The MIT License
 *
 * Copyright (c) 2016 Juan Cruz Viotti. https://github.com/jviotti
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

'use strict';

/**
 * @module storage
 */

const _ = require('lodash');
const async = require('async');
const fs = require('fs');
const rimraf = require('rimraf');
const mkdirp = require('mkdirp');
const path = require('path');
const writeFileAtomic = require('write-file-atomic');
const utils = require('./utils');
const lock = require('./lock');

const readFile = function (fileName, callback, times) {
  times = times || 0;

  fs.readFile(fileName, function (error, object) {
    if (!error) {
      return callback(null, object);
    }

    if (error.code === 'ENOENT') {
      return callback(null, JSON.stringify({}));
    }

    if (error.code === 'EPERM' && times < 10) {
      setTimeout(function () {
        readFile(fileName, callback, times + 1);
      }, 1000);
      return;
    }

    return callback(error);
  });
};

const readFileSync = function (fileName, times) {
  times = times || 0;
  try {
    return fs.readFileSync(fileName);
  } catch (error) {
    if (error.code === 'ENOENT') {
      return JSON.stringify({});
    }

    if (error.code === 'EPERM' && times < 10) {
      return readFileSync(fileName, times + 1);
    }

    throw error;
  }
};

/**
 * @summary Get the default data path
 * @function
 * @public
 *
 * @description
 * This function will return `null` when running in the
 * renderer process without support for the `remote` IPC
 * mechanism. You have to explicitly set a data path using
 * `.setDataPath()` in these cases.
 *
 * @returns {(String|Null)} default data path
 *
 * @example
 * const defaultDataPath = storage.getDefaultDataPath()
 */
exports.getDefaultDataPath = utils.getDefaultDataPath;

/**
 * @summary Set current data path
 * @function
 * @public
 *
 * @description
 * The default value will be used if the directory is undefined.
 *
 * @param {(String|Undefined)} directory - directory
 *
 * @example
 * const os = require('os');
 * const storage = require('electron-json-storage');
 *
 * storage.setDataPath(os.tmpdir());
 */
exports.setDataPath = utils.setDataPath;

/**
 * @summary Get current user data path
 * @function
 * @public
 *
 * @description
 * Returns the current data path. It defaults to a directory called
 * "storage" inside Electron's `userData` path.
 *
 * @returns {String} the user data path
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * const dataPath = storage.getDataPath();
 * console.log(dataPath);
 */
exports.getDataPath = utils.getDataPath;

/**
 * @summary Read user data
 * @function
 * @public
 *
 * @description
 * If the key doesn't exist in the user data, an empty object is returned.
 * Also notice that the `.json` extension is added automatically, but it's
 * ignored if you pass it yourself.
 *
 * Passing an extension other than `.json` will result in a file created
 * with both extensions. For example, the key `foo.data` will result in a file
 * called `foo.data.json`.
 *
 * @param {String} key - key
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error, data)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.get('foobar', function(error, data) {
 *   if (error) throw error;
 *
 *   console.log(data);
 * });
 */
exports.get = function (key, options, callback) {
  if (_.isFunction(options)) {
    callback = options;
  }

  options = options || {};
  callback = callback || _.noop;
  var fileName = null;

  async.waterfall([
    async.asyncify(_.partial(utils.getFileName, key, {
      dataPath: options.dataPath
    })),
    function (result, callback) {
      fileName = result;
      mkdirp(path.dirname(fileName), callback);
    },
    function (made, next) {
      lock.lock(utils.getLockFileName(fileName), function (error) {
        if (error && error.code === 'EEXIST') {
          return exports.get(key, options, callback);
        }

        return next(error);
      });
    },
    function (callback) {
      readFile(fileName, callback);
    },
    function (object, callback) {
      var objectJSON = {};
      try {
        objectJSON = JSON.parse(object);
      } catch (error) {
        return callback(new Error('Invalid data: ' + object));
      }
      return callback(null, objectJSON);
    }
  ], function (error, result) {
    lock.unlock(utils.getLockFileName(fileName), function (lockError) {
      if (error) {
        return callback(error);
      }

      return callback(lockError, result);
    });
  });
};

/**
 * @summary Read user data (sync)
 * @function
 * @public
 *
 * @description
 * See `.get()`.
 *
 * @param {String} key - key
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * var data = storage.getSync('foobar');
 * console.log(data);
 */
exports.getSync = function (key, options) {
  options = options || {};
  var fileName = utils.getFileName(key, {
    dataPath: options.dataPath
  });

  mkdirp.sync(path.dirname(fileName));

  try {
    lock.lockSync(utils.getLockFileName(fileName));
  } catch (error) {
    if (error && error.code === 'EEXIST') {
      return exports.getSync(key, options);
    }

    throw error;
  }

  var object = readFileSync(fileName);
  lock.unlockSync(utils.getLockFileName(fileName));

  try {
    return JSON.parse(object);
  } catch (error) {
    throw new Error('Invalid data: ' + object);
  }
};

/**
 * @summary Read many user data keys
 * @function
 * @public
 *
 * @description
 * This function returns an object with the data of all the passed keys.
 * If one of the keys doesn't exist, an empty object is returned for it.
 *
 * @param {String[]} keys - keys
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error, data)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.getMany([ 'foobar', 'barbaz' ], function(error, data) {
 *   if (error) throw error;
 *
 *   console.log(data.foobar);
 *   console.log(data.barbaz);
 * });
 */
exports.getMany = function (keys, options, callback) {
  if (_.isFunction(options)) {
    callback = options;
    options = {};
  }

  options = options || {};
  callback = callback || _.noop;

  async.reduce(keys, {}, function (reducer, key, callback) {
    exports.get(key, options, function (error, data) {
      if (error) {
        return callback(error);
      }
      return callback(null, _.set(reducer, key, data));
    });
  }, callback);
};

/**
 * @summary Read all user data
 * @function
 * @public
 *
 * @description
 * This function returns an empty object if there is no data to be read.
 *
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error, data)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.getAll(function(error, data) {
 *   if (error) throw error;
 *
 *   console.log(data);
 * });
 */
exports.getAll = function (options, callback) {
  if (_.isFunction(options)) {
    callback = options;
    options = {};
  }

  options = options || {};
  callback = callback || _.noop;

  async.waterfall([
    _.partial(exports.keys, options),
    function (keys, callback) {
      async.reduce(keys, {}, function (reducer, key, callback) {
        async.waterfall([
          _.partial(exports.get, key, options),
          function (contents, callback) {
            return callback(null, _.set(reducer, key, contents));
          }
        ], callback);
      }, callback);
    }
  ], callback);
};

/**
 * @summary Write user data
 * @function
 * @public
 *
 * @param {String} key - key
 * @param {Object} json - json object
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {String} [options.validate] - validate writes by reading the data back
 * @param {boolean} [options.prettyPrinting] - adds line breaks and spacing to the written data
 * @param {Function} callback - callback (error)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.set('foobar', { foo: 'bar' }, function(error) {
 *   if (error) throw error;
 * });
 */
exports.set = function (key, json, options, callback, retries) {
  if (!_.isNumber(retries)) {
    retries = 10;
  }

  if (_.isFunction(options)) {
    callback = options;
  }

  options = options || {};
  callback = callback || _.noop;
  var fileName = null;

  async.waterfall([
    async.asyncify(_.partial(utils.getFileName, key, {
      dataPath: options.dataPath
    })),
    function (result, callback) {
      fileName = result;
      const data = JSON.stringify(json, null, (options.prettyPrinting ? 2 : 0));

      if (!data) {
        return callback(new Error('Invalid JSON data'));
      }

      // Create the directory in case it doesn't exist yet
      mkdirp(path.dirname(fileName), function (error) {
        return callback(error, data);
      });
    },
    function (data, next) {
      lock.lock(utils.getLockFileName(fileName), function (error) {
        if (error && error.code === 'EEXIST') {
          return exports.set(key, json, options, callback);
        }

        return next(error, fileName, data);
      });
    },
    function (fileName, data, callback) {
      writeFileAtomic(fileName, data, callback);
    }
  ], function (error) {
    lock.unlock(utils.getLockFileName(fileName), function (lockError) {
      if (error) {
        return callback(error);
      }

      if (!options.validate) {
        return callback(lockError);
      }

      // Check that the writes were actually successful
      // after a little bit
      setTimeout(function () {
        exports.get(key, {
          dataPath: options.dataPath
        }, function (getError, data) {
          if (getError) {
            return callback(getError);
          }

          if (!_.isEqual(data, json)) {
            if (retries <= 0) {
              throw new Error('Couldn\'t ensure data was written correctly');
            }

            return exports.set(key, json, options, callback, retries - 1);
          }

          return callback();
        });
      }, 100);
    });
  });
};

/**
 * @summary Write user data sync
 * @function
 * @public
 *
 * @param {String} key - key
 * @param {Object} json - json object
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {boolean} [options.prettyPrinting] - adds line breaks and spacing to the written data
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.setSync('foobar', { foo: 'bar' });
 */
exports.setSync = function (key, json, options = {}) {
  const fileName = utils.getFileName(key, {
    dataPath: options.dataPath
  });
  const data = JSON.stringify(json, null, (options.prettyPrinting ? 2 : 0));

  if (!data) {
    throw new Error('Invalid JSON data');
  }

  mkdirp.sync(path.dirname(fileName));

  try {
    lock.lockSync(utils.getLockFileName(fileName));
  } catch (error) {
    if (error && error.code === 'EEXIST') {
      return exports.setSync(key, json, options);
    }
    throw error;
  }

  try {
    fs.writeFileSync(fileName, data);
    lock.unlockSync(utils.getLockFileName(fileName));
    return;
  }
  catch (error) {
    throw error;
  }
};

/**
 * @summary Check if a key exists
 * @function
 * @public
 *
 * @param {String} key - key
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error, hasKey)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.has('foobar', function(error, hasKey) {
 *   if (error) throw error;
 *
 *   if (hasKey) {
 *     console.log('There is data stored as `foobar`');
 *   }
 * });
 */
exports.has = function (key, options, callback) {
  if (_.isFunction(options)) {
    callback = options;
  }

  options = options || {};
  callback = callback || _.noop;

  async.waterfall([
    async.asyncify(_.partial(utils.getFileName, key, {
      dataPath: options.dataPath
    })),
    function (filename, done) {
      fs.stat(filename, function (error) {
        if (error) {
          if (error.code === 'ENOENT') {
            return done(null, false);
          }

          return done(error);
        }

        return done(null, true);
      });
    }
  ], callback);
};

/**
 * @summary Get the list of saved keys
 * @function
 * @public
 *
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error, keys)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.keys(function(error, keys) {
 *   if (error) throw error;
 *
 *   for (var key of keys) {
 *     console.log('There is a key called: ' + key);
 *   }
 * });
 */
exports.keys = function (options, callback) {
  if (_.isFunction(options)) {
    callback = options;
    options = {};
  }

  options = options || {};
  callback = callback || _.noop;

  async.waterfall([
    function (callback) {
      callback(null, options.dataPath || exports.getDataPath());
    },
    function (userDataPath, callback) {
      mkdirp(userDataPath, function (error) {
        return callback(error, userDataPath);
      });
    },
    fs.readdir,
    function (keys, callback) {
      callback(null, _.map(_.reject(keys, function (key) {
        return path.extname(key) !== '.json';
      }), function (key) {
        return path.basename(decodeURIComponent(key), '.json');
      }));
    }
  ], callback);
};

/**
 * @summary Remove a key
 * @function
 * @public
 *
 * @description
 * Notice this function does nothing, nor throws any error
 * if the key doesn't exist.
 *
 * @param {String} key - key
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.remove('foobar', function(error) {
 *   if (error) throw error;
 * });
 */
exports.remove = function (key, options, callback) {
  if (_.isFunction(options)) {
    callback = options;
  }

  options = options || {};
  callback = callback || _.noop;

  async.waterfall([
    async.asyncify(_.partial(utils.getFileName, key, {
      dataPath: options.dataPath
    })),
    rimraf
  ], callback);
};

/**
 * @summary Clear all stored data in the current user data path
 * @function
 * @public
 *
 * @param {Object} [options] - options
 * @param {String} [options.dataPath] - data path
 * @param {Function} callback - callback (error)
 *
 * @example
 * const storage = require('electron-json-storage');
 *
 * storage.clear(function(error) {
 *   if (error) throw error;
 * });
 */
exports.clear = function (options, callback) {
  if (_.isFunction(options)) {
    callback = options;
  }

  options = options || {};
  callback = callback || _.noop;

  const userData = options.dataPath || exports.getDataPath();
  const jsonFiles = path.join(userData, '*.json');
  rimraf(jsonFiles, callback);
};