cloudron-box/src/storage/filesystem.js

'use strict';

exports = module.exports = {
    backup: backup,
    restore: restore,
    copyBackup: copyBackup,

    saveAppRestoreConfig: saveAppRestoreConfig,
    getAppRestoreConfig: getAppRestoreConfig,
    copyAppRestoreConfig: copyAppRestoreConfig,

    getDownloadStream: getDownloadStream,

    removeBackup: removeBackup,
    backupDone: backupDone,

    testConfig: testConfig
};

var assert = require('assert'),
    async = require('async'),
    BackupsError = require('../backups.js').BackupsError,
    debug = require('debug')('box:storage/filesystem'),
    fs = require('fs'),
    path = require('path'),
    mkdirp = require('mkdirp'),
    once = require('once'),
    safe = require('safetydance'),
    SettingsError = require('../settings.js').SettingsError,
    shell = require('../shell.js'),
    tar = require('tar-fs'),
    zlib = require('zlib'),
    crypto = require('crypto'),
    archiver = require('archiver');

var FALLBACK_BACKUP_FOLDER = '/var/backups';
var REMOVE_BACKUP_CMD = path.join(__dirname, '../scripts/rmbackup.sh');

// internal only
function copyFile(source, destination, callback) {
    callback = once(callback);

    var readStream = fs.createReadStream(source);
    var writeStream = fs.createWriteStream(destination);

    readStream.on('error', callback);
    writeStream.on('error', callback);
    writeStream.on('close', callback);

    readStream.pipe(writeStream);
}

function backup(apiConfig, backupId, sourceDirectories, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof backupId, 'string');
    assert(Array.isArray(sourceDirectories));
    assert.strictEqual(typeof callback, 'function');

    callback = once(callback);

    var backupFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, backupId + '.tar.gz');

    debug('[%s] backup: %j -> %s', backupId, sourceDirectories, backupFilePath);

    mkdirp(path.dirname(backupFilePath), function (error) {
        if (error) return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));

        var fileStream = fs.createWriteStream(backupFilePath);
        var archive = archiver('tar', { gzip: true });
        var cipher = crypto.createCipher('aes-256-cbc', apiConfig.key || '');

        fileStream.on('error', function (error) {
            console.error('[%s] backup: out stream error.', backupId, error);
        });

        cipher.on('error', function (error) {
            console.error('[%s] backup: cipher stream error.', backupId, error);
        });

        archive.on('error', function (error) {
            console.error('[%s] backup: archive stream error.', backupId, error);
        });

        fileStream.on('close', function () {
            debug('[%s] backup: done.', backupId);
            callback(null);
        });

        archive.pipe(cipher).pipe(fileStream);

        sourceDirectories.forEach(function (directory) {
            // archive does not like destination beginning with a slash
            directory.destination = path.normalize(directory.destination).replace(/^\//, '');

            archive.directory(directory.source, directory.destination);
        });

        archive.finalize();
    });
}

function restore(apiConfig, backupId, destinationDirectories, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof backupId, 'string');
    assert(Array.isArray(destinationDirectories));
    assert.strictEqual(typeof callback, 'function');

    var sourceFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, backupId + '.tar.gz');

    debug('[%s] restore: %s -> %j', backupId, sourceFilePath, destinationDirectories);

    if (!fs.existsSync(sourceFilePath)) return callback(new BackupsError(BackupsError.NOT_FOUND, 'backup file does not exist'));

    async.eachSeries(destinationDirectories, function (directory, callback) {
        debug('[%s] restore: directory %s -> %s', backupId, directory.source, directory.destination);

        // tar-fs reports without slash at the beginning
        directory.source = path.normalize(directory.source).replace(/^\//, '');

        mkdirp(directory.destination, function (error) {
            if (error) return callback(error);

            var fileStream = fs.createReadStream(sourceFilePath);
            var decipher = crypto.createDecipher('aes-256-cbc', apiConfig.key || '');
            var gunzipStream = zlib.createGunzip({});

            var IGNORE_PREFIX = '__ignore__';

            var extract = tar.extract(directory.destination, {
                ignore: function (name, header) { return header.name.startsWith(IGNORE_PREFIX); },
                map: function (header) {
                    // ignore is called after map, we mark everything we dont want!
                    // else slice off the mapping prefix
                    if (!header.name.startsWith(directory.source)) header.name = IGNORE_PREFIX + header.name;
                    else header.name = header.name.slice(directory.source.length);

                    return header;
                }
            });

            fileStream.on('error', function (error) {
                console.error('[%s] restore: file stream error.', error);
                callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));
            });

            decipher.on('error', function (error) {
                console.error('[%s] restore: decipher stream error.', error);
                callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));
            });

            gunzipStream.on('error', function (error) {
                console.error('[%s] restore: gunzip stream error.', error);
                callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));
            });

            extract.on('error', function (error) {
                console.error('[%s] restore: extract stream error.', error);
                callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));
            });

            extract.on('finish', function () {
                debug('[%s] restore: directory %s done.', backupId, directory.source);
                callback();
            });

            fileStream.pipe(decipher).pipe(gunzipStream).pipe(extract);
        });
    }, function (error) {
        if (error) return callback(error);

        debug('[%s] restore: done', backupId);

        callback(null);
    });
}

function copyBackup(apiConfig, oldBackupId, newBackupId, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof oldBackupId, 'string');
    assert.strictEqual(typeof newBackupId, 'string');
    assert.strictEqual(typeof callback, 'function');

    callback = once(callback);

    var oldFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, oldBackupId + '.tar.gz');
    var newFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, newBackupId + '.tar.gz');

    copyFile(oldFilePath, newFilePath, function (error) {
        if (error) {
            console.error('Unable to copy backup %s -> %s.', oldFilePath, newFilePath, error);
            return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));
        }

        callback();
    });
}

function getDownloadStream(apiConfig, backupId, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof backupId, 'string');
    assert.strictEqual(typeof callback, 'function');

    var backupFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, backupId + '.tar.gz');

    debug('[%s] getDownloadStream: %s %s', backupId, backupId, backupFilePath);

    if (!fs.existsSync(backupFilePath)) return callback(new BackupsError(BackupsError.NOT_FOUND, 'backup file does not exist'));

    var stream = fs.createReadStream(backupFilePath);
    callback(null, stream);
}

function saveAppRestoreConfig(apiConfig, backupId, restoreConfig, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof backupId, 'string');
    assert.strictEqual(typeof restoreConfig, 'object');
    assert.strictEqual(typeof callback, 'function');

    var backupFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, backupId + '.json');

    debug('[%s] saveAppRestoreConfig: %j -> %s', backupId, restoreConfig, backupFilePath);

    mkdirp(path.dirname(backupFilePath), function (error) {
        if (error) return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));

        fs.writeFile(backupFilePath, JSON.stringify(restoreConfig), function (error) {
            if (error) return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));

            debug('[%s] saveAppRestoreConfig: done', backupId);

            callback();
        });
    });
}

function getAppRestoreConfig(apiConfig, backupId, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof backupId, 'string');
    assert.strictEqual(typeof callback, 'function');

    var sourceFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, backupId + '.json');

    debug('[%s] getAppRestoreConfig: %s', backupId, sourceFilePath);

    if (!fs.existsSync(sourceFilePath)) return callback(new BackupsError(BackupsError.NOT_FOUND, 'restore config file does not exist'));

    var restoreConfig = safe.require(sourceFilePath);
    if (!restoreConfig) {
        console.error('[%s] getAppRestoreConfig: failed', safe.error);
        return callback(new BackupsError(BackupsError.INTERNAL_ERROR, safe.error));
    }

    callback(null, restoreConfig);
}

function copyAppRestoreConfig(apiConfig, oldBackupId, newBackupId, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof oldBackupId, 'string');
    assert.strictEqual(typeof newBackupId, 'string');
    assert.strictEqual(typeof callback, 'function');

    var oldFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, oldBackupId) + '.json';
    var newFilePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, newBackupId + '.json');

    copyFile(oldFilePath, newFilePath, function (error) {
        if (error) {
            console.error('Unable to copy app restore config %s -> %s.', oldFilePath, newFilePath, error);
            return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error));
        }

        callback(null);
    });
}

function removeBackup(apiConfig, backupId, appBackupIds, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof backupId, 'string');
    assert(Array.isArray(appBackupIds));
    assert.strictEqual(typeof callback, 'function');

    async.each([backupId].concat(appBackupIds), function (id, callback) {
        var filePath = path.join(apiConfig.backupFolder || FALLBACK_BACKUP_FOLDER, id + '.tar.gz');

        shell.sudo('deleteBackup', [ REMOVE_BACKUP_CMD, filePath ], function (error) {
            if (error) console.error('Unable to remove %s. Not fatal.', filePath, safe.error);
            callback();
        });
    }, callback);
}

function testConfig(apiConfig, callback) {
    assert.strictEqual(typeof apiConfig, 'object');
    assert.strictEqual(typeof callback, 'function');

    if (typeof apiConfig.backupFolder !== 'string') return callback(new SettingsError(SettingsError.BAD_FIELD, 'backupFolder must be string'));

    callback();
}

function backupDone(filename, app, appBackupIds, callback) {
    assert.strictEqual(typeof filename, 'string');
    assert(!app || typeof app === 'object');
    assert(!appBackupIds || Array.isArray(appBackupIds));
    assert.strictEqual(typeof callback, 'function');

    callback();
}