'use strict'; exports = module.exports = { CloudronError: CloudronError, initialize: initialize, uninitialize: uninitialize, getConfig: getConfig, getDisks: getDisks, getLogs: getLogs, reboot: reboot, isRebootRequired: isRebootRequired, onActivated: onActivated, prepareDashboardDomain: prepareDashboardDomain, setDashboardDomain: setDashboardDomain, renewCerts: renewCerts, checkDiskSpace: checkDiskSpace }; var assert = require('assert'), async = require('async'), clients = require('./clients.js'), config = require('./config.js'), constants = require('./constants.js'), cron = require('./cron.js'), debug = require('debug')('box:cloudron'), domains = require('./domains.js'), DomainsError = require('./domains.js').DomainsError, df = require('@sindresorhus/df'), eventlog = require('./eventlog.js'), fs = require('fs'), mail = require('./mail.js'), mailer = require('./mailer.js'), os = require('os'), path = require('path'), paths = require('./paths.js'), platform = require('./platform.js'), reverseProxy = require('./reverseproxy.js'), settings = require('./settings.js'), shell = require('./shell.js'), spawn = require('child_process').spawn, split = require('split'), tasks = require('./tasks.js'), users = require('./users.js'), util = require('util'); var REBOOT_CMD = path.join(__dirname, 'scripts/reboot.sh'); var NOOP_CALLBACK = function (error) { if (error) debug(error); }; function CloudronError(reason, errorOrMessage) { assert.strictEqual(typeof reason, 'string'); assert(errorOrMessage instanceof Error || typeof errorOrMessage === 'string' || typeof errorOrMessage === 'undefined'); Error.call(this); Error.captureStackTrace(this, this.constructor); this.name = this.constructor.name; this.reason = reason; if (typeof errorOrMessage === 'undefined') { this.message = reason; } else if (typeof errorOrMessage === 'string') { this.message = errorOrMessage; } else { this.message = 'Internal error'; this.nestedError = errorOrMessage; } } util.inherits(CloudronError, Error); CloudronError.BAD_FIELD = 'Field error'; CloudronError.INTERNAL_ERROR = 'Internal Error'; CloudronError.EXTERNAL_ERROR = 'External Error'; CloudronError.BAD_STATE = 'Bad state'; CloudronError.ALREADY_UPTODATE = 'No Update Available'; function initialize(callback) { assert.strictEqual(typeof callback, 'function'); cron.startPreActivationJobs(callback); runStartupTasks(); } function uninitialize(callback) { assert.strictEqual(typeof callback, 'function'); async.series([ cron.stopJobs, platform.stop ], callback); } function onActivated(callback) { assert.strictEqual(typeof callback, 'function'); // Starting the platform after a user is available means: // 1. mail bounces can now be sent to the cloudron owner // 2. the restore code path can run without sudo (since mail/ is non-root) async.series([ platform.start, cron.startPostActivationJobs ], callback); } // each of these tasks can fail. we will add some routes to fix/re-run them function runStartupTasks() { // configure nginx to be reachable by IP reverseProxy.configureDefaultServer(NOOP_CALLBACK); // always generate webadmin config since we have no versioning mechanism for the ejs if (config.adminDomain()) reverseProxy.writeAdminConfig(config.adminDomain(), NOOP_CALLBACK); // check activation state and start the platform users.isActivated(function (error, activated) { if (error) return debug(error); if (!activated) return debug('initialize: not activated yet'); // not activated onActivated(NOOP_CALLBACK); }); } function getDisks(callback) { assert.strictEqual(typeof callback, 'function'); var disks = { boxDataDisk: null, platformDataDisk: null, appsDataDisk: null }; df.file(paths.BOX_DATA_DIR).then(function (result) { disks.boxDataDisk = result.filesystem; return df.file(paths.PLATFORM_DATA_DIR); }).then(function (result) { disks.platformDataDisk = result.filesystem; return df.file(paths.APPS_DATA_DIR); }).then(function (result) { disks.appsDataDisk = result.filesystem; callback(null, disks); }).catch(function (error) { callback(new CloudronError(CloudronError.INTERNAL_ERROR, error)); }); } function getConfig(callback) { assert.strictEqual(typeof callback, 'function'); settings.getAll(function (error, allSettings) { if (error) return callback(new CloudronError(CloudronError.INTERNAL_ERROR, error)); // be picky about what we send out here since this is sent for 'normal' users as well callback(null, { apiServerOrigin: config.apiServerOrigin(), webServerOrigin: config.webServerOrigin(), adminDomain: config.adminDomain(), adminFqdn: config.adminFqdn(), mailFqdn: config.mailFqdn(), version: config.version(), isDemo: config.isDemo(), edition: config.edition(), memory: os.totalmem(), provider: config.provider(), cloudronName: allSettings[settings.CLOUDRON_NAME_KEY] }); }); } function reboot(callback) { shell.sudo('reboot', [ REBOOT_CMD ], {}, callback); } function isRebootRequired(callback) { assert.strictEqual(typeof callback, 'function'); // https://serverfault.com/questions/92932/how-does-ubuntu-keep-track-of-the-system-restart-required-flag-in-motd callback(null, fs.existsSync('/var/run/reboot-required')); } function checkDiskSpace(callback) { callback = callback || NOOP_CALLBACK; debug('Checking disk space'); getDisks(function (error, disks) { if (error) { debug('df error %s', error.message); return callback(); } df().then(function (entries) { /* [{ filesystem: '/dev/disk1', size: 499046809600, used: 443222245376, available: 55562420224, capacity: 0.89, mountpoint: '/' }, ...] */ var oos = entries.some(function (entry) { // ignore other filesystems but where box, app and platform data is if (entry.filesystem !== disks.boxDataDisk && entry.filesystem !== disks.platformDataDisk && entry.filesystem !== disks.appsDataDisk) return false; return (entry.available <= (1.25 * 1024 * 1024 * 1024)); // 1.5G }); debug('Disk space checked. ok: %s', !oos); if (oos) mailer.outOfDiskSpace(JSON.stringify(entries, null, 4)); callback(); }).catch(function (error) { debug('df error %s', error.message); mailer.outOfDiskSpace(error.message); return callback(); }); }); } function getLogs(unit, options, callback) { assert.strictEqual(typeof unit, 'string'); assert(options && typeof options === 'object'); assert.strictEqual(typeof callback, 'function'); assert.strictEqual(typeof options.lines, 'number'); assert.strictEqual(typeof options.format, 'string'); assert.strictEqual(typeof options.follow, 'boolean'); var lines = options.lines === -1 ? '+1' : options.lines, format = options.format || 'json', follow = options.follow; debug('Getting logs for %s as %s', unit, format); let args = [ '--lines=' + lines ]; if (follow) args.push('--follow'); // need to handle box.log without subdir if (unit === 'box') args.push(path.join(paths.LOG_DIR, 'box.log')); else args.push(path.join(paths.LOG_DIR, unit, 'app.log')); var cp = spawn('/usr/bin/tail', args); var transformStream = split(function mapper(line) { if (format !== 'json') return line + '\n'; var data = line.split(' '); // logs are var timestamp = (new Date(data[0])).getTime(); if (isNaN(timestamp)) timestamp = 0; return JSON.stringify({ realtimeTimestamp: timestamp * 1000, message: line.slice(data[0].length+1), source: unit }) + '\n'; }); transformStream.close = cp.kill.bind(cp, 'SIGKILL'); // closing stream kills the child process cp.stdout.pipe(transformStream); return callback(null, transformStream); } function prepareDashboardDomain(domain, auditSource, callback) { assert.strictEqual(typeof domain, 'string'); assert.strictEqual(typeof auditSource, 'object'); assert.strictEqual(typeof callback, 'function'); debug(`prepareDashboardDomain: ${domain}`); let task = tasks.startTask(tasks.TASK_PREPARE_DASHBOARD_DOMAIN, [ domain, auditSource ]); task.on('error', (error) => callback(new CloudronError(CloudronError.INTERNAL_ERROR, error))); task.on('start', (taskId) => callback(null, taskId)); } function setDashboardDomain(domain, auditSource, callback) { assert.strictEqual(typeof domain, 'string'); assert.strictEqual(typeof auditSource, 'object'); assert.strictEqual(typeof callback, 'function'); debug(`setDashboardDomain: ${domain}`); domains.get(domain, function (error, domainObject) { if (error && error.reason === DomainsError.NOT_FOUND) return callback(new CloudronError(CloudronError.BAD_FIELD, 'No such domain')); if (error) return callback(new CloudronError(CloudronError.INTERNAL_ERROR, error)); reverseProxy.writeAdminConfig(domain, function (error) { if (error) return callback(new CloudronError(CloudronError.INTERNAL_ERROR, error)); const fqdn = domains.fqdn(constants.ADMIN_LOCATION, domainObject); config.setAdminDomain(domain); config.setAdminLocation(constants.ADMIN_LOCATION); config.setAdminFqdn(fqdn); clients.addDefaultClients(config.adminOrigin(), function (error) { if (error) return callback(new CloudronError(CloudronError.INTERNAL_ERROR, error)); eventlog.add(eventlog.ACTION_DASHBOARD_DOMAIN_UPDATE, auditSource, { domain: domain, fqdn: fqdn }); mail.setMailFqdn(fqdn, domain, NOOP_CALLBACK); callback(null); }); }); }); } function renewCerts(options, auditSource, callback) { assert.strictEqual(typeof options, 'object'); assert.strictEqual(typeof auditSource, 'object'); assert.strictEqual(typeof callback, 'function'); let task = tasks.startTask(tasks.TASK_RENEW_CERTS, [ options, auditSource ]); task.on('error', (error) => callback(new CloudronError(CloudronError.INTERNAL_ERROR, error))); task.on('start', (taskId) => callback(null, taskId)); }