mirror of
https://github.com/balena-io/etcher.git
synced 2025-04-25 07:47:18 +00:00
f6ce603e45
* feat(GUI): add convenience localstorage class We add a class `Storage` and accompanying helper methods that makes localStorage usage easier. Change-Type: patch Changelog-Entry: Add a convenience Storage class on top of localStorage.
144 lines
3.2 KiB
JavaScript
144 lines
3.2 KiB
JavaScript
/*
|
|
* Copyright 2017 resin.io
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
'use strict'
|
|
|
|
const Bluebird = require('bluebird')
|
|
const _ = require('lodash')
|
|
const fs = require('fs')
|
|
const path = require('path')
|
|
const os = require('os')
|
|
const Storage = require('./storage')
|
|
|
|
/**
|
|
* @summary Local storage settings key
|
|
* @constant
|
|
* @type {String}
|
|
*/
|
|
const LOCAL_STORAGE_SETTINGS_KEY = 'etcher-settings'
|
|
const settingsStorage = new Storage(LOCAL_STORAGE_SETTINGS_KEY)
|
|
|
|
/**
|
|
* @summary Local settings filename
|
|
* @constant
|
|
* @type {String}
|
|
*/
|
|
const RCFILE = '.etcher.json'
|
|
|
|
/**
|
|
* @summary Read a local .etcherrc file
|
|
* @function
|
|
* @public
|
|
*
|
|
* @param {String} filename - file path
|
|
* @fulfil {Object} - settings
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* readConfigFile('.etcherrc').then((settings) => {
|
|
* console.log(settings)
|
|
* })
|
|
*/
|
|
const readConfigFile = (filename) => {
|
|
return new Bluebird((resolve, reject) => {
|
|
fs.readFile(filename, (error, buffer) => {
|
|
if (error) {
|
|
if (error.code === 'ENOENT') {
|
|
resolve({})
|
|
} else {
|
|
reject(error)
|
|
}
|
|
} else {
|
|
resolve(JSON.parse(buffer.toString()))
|
|
}
|
|
})
|
|
})
|
|
}
|
|
|
|
/**
|
|
* @summary Read all local settings
|
|
* @function
|
|
* @public
|
|
*
|
|
* @fulfil {Object} - local settings
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* localSettings.readAll().then((settings) => {
|
|
* console.log(settings);
|
|
* });
|
|
*/
|
|
exports.readAll = () => {
|
|
const homeConfigPath = process.platform === 'win32'
|
|
? path.join(os.userInfo().homedir, RCFILE)
|
|
: path.join(os.userInfo().homedir, '.config', 'etcher', 'config.json')
|
|
const workdirConfigPath = path.join(process.cwd(), RCFILE)
|
|
const settings = {}
|
|
return Bluebird.try(() => {
|
|
_.merge(settings, settingsStorage.getAll())
|
|
}).return(readConfigFile(homeConfigPath))
|
|
.then((homeConfig) => {
|
|
_.merge(settings, homeConfig)
|
|
})
|
|
.return(readConfigFile(workdirConfigPath))
|
|
.then((workdirConfig) => {
|
|
_.merge(settings, workdirConfig)
|
|
})
|
|
.return(settings)
|
|
}
|
|
|
|
/**
|
|
* @summary Write local settings
|
|
* @function
|
|
* @public
|
|
*
|
|
* @param {Object} settings - settings
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* localSettings.writeAll({
|
|
* foo: 'bar'
|
|
* }).then(() => {
|
|
* console.log('Done!');
|
|
* });
|
|
*/
|
|
exports.writeAll = (settings) => {
|
|
return Bluebird.try(() => {
|
|
settingsStorage.setAll(settings)
|
|
})
|
|
}
|
|
|
|
/**
|
|
* @summary Clear the local settings
|
|
* @function
|
|
* @private
|
|
*
|
|
* @description
|
|
* Exported for testing purposes
|
|
*
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* localSettings.clear().then(() => {
|
|
* console.log('Done!');
|
|
* });
|
|
*/
|
|
exports.clear = () => {
|
|
return Bluebird.try(() => {
|
|
settingsStorage.clearAll()
|
|
})
|
|
}
|