boomcatch/src/cli.js

A standalone, node.js-based beacon receiver for boomerang.

#!/usr/bin/env node

// Copyright © 2014, 2015, 2016 Springer Nature
//
// This file is part of boomcatch.
//
// Boomcatch is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Boomcatch is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with boomcatch. If not, see <http://www.gnu.org/licenses/>.

/*globals require, process, console */

'use strict';

var cli = require('commander'),
    check = require('check-types'),
    packageInfo = require('../package.json'),
    impl = require('./index');

parseCommandLine();
runServer();

function parseCommandLine () {
    cli.version(packageInfo.version)
        .option('-n, --host <name>', 'host name to accept connections on, default is 0.0.0.0 (INADDR_ANY)')
        .option('-p, --port <port>', 'port to accept connections on, default is 80 for HTTP or 443 for HTTPS', parseInt)
        .option('-t, --https', 'start the server in HTTPS mode')
        .option('-x, --httpsPfx <string>', 'PFX/PKCX12 string containing private key, certificate and CA certs (HTTPS only)')
        .option('-k, --httpsKey <path>', 'path to private key file, ignored if --httpsPfx is set (HTTPS only)')
        .option('-c, --httpsCert <path>', 'path to certificate file, ignored if --httpsPfx is set (HTTPS only)')
        .option('-e, --httpsPass <string>', 'passphrase for --httpsPfx or --httpsKey options (HTTPS only)')
        .option('-u, --path <path>', 'URL path to accept requests to, default is /beacon')
        .option('-r, --referer <regex>', 'referers to accept requests from, default is .*', parseRegExp)
        .option('-o, --origin <origin>', 'URL(s) for the Access-Control-Allow-Origin header, default is * (any origin), specify null to force same origin', parseOrigin)
        .option('-l, --limit <milliseconds>', 'minimum elapsed time between requests from the same IP address, default is 0', parseInt)
        .option('-z, --maxSize <bytes>', 'maximum allowable body size for POST requests, default is -1 (unlimited)', parseInt)
        .option('-s, --silent', 'prevent the command from logging output to the console')
        .option('-y, --syslog <facility>', 'use syslog-compatible logging, with the specified facility level')
        .option('-w, --workers <count>', 'use a fixed number of worker processes to handle requests, default is -1 (one worker per CPU)', parseInt)
        .option('-d, --delayRespawn <milliseconds>', 'length of time to delay before respawning worker processes, default is 0 (no delay)', parseInt)
        .option('-a, --maxRespawn <count>', 'maximum number of times to respawn worker processes, default is -1 (unlimited)', parseInt)
        .option('-v, --validator <path>', 'validator to use, default is permissive')
        .option('-i, --filter <path>', 'filter to use, default is unfiltered')
        .option('-m, --mapper <path>', 'data mapper to use, default is statsd')
        .option('-x, --prefix <prefix>', 'prefix to apply to mapped metric names')
        .option('-T, --svgTemplate <path>', 'path to alternative SVG handlebars template file (SVG mapper only)')
        .option('-S, --svgSettings <path>', 'path to alternative SVG settings JSON file (SVG mapper only)')
        .option('-f, --forwarder <path>', 'forwarder to use, default is udp')
        .option('-N, --fwdHost <name>', 'host name to forward data to (UDP forwarder only)')
        .option('-P, --fwdPort <port>', 'port to forward data on (UDP forwarder only)', parseInt)
        .option('-Z, --fwdSize <bytes>', 'maximum allowable packet size for data forwarding (UDP forwarder only)', parseInt)
        .option('-U, --fwdUrl <name>', 'URL to forward data to (HTTP forwarder only)')
        .option('-M, --fwdMethod <name>', 'method to forward data with (HTTP forwarder only)')
        .option('-D, --fwdDir <path>', 'directory to write data to (file forwarder only)')
        .parse(process.argv);
}

function parseRegExp (regExp) {
    return new RegExp(regExp);
}

function parseOrigin (origin) {
    var array = origin.split(',');

    if (array.length === 1) {
        return origin;
    }

    return array.map(function (item) {
        return item.trim();
    });
}

function runServer () {
    if (!cli.silent) {
        cli.log = getLog();
    }

    normaliseWorkers();

    impl.listen(getOptions());
}

function getLog () {
    if (cli.syslog) {
        return getSyslog();
    }
    
    return getFallbackLog();
}

function getSyslog () {
    try {
        return new (require('ain2'))({
            tag: 'boomcatch',
            facility: cli.syslog
        });
    } catch (error) {
        console.log(error.stack);
        console.log('Failed to initialise syslog, exiting.');
        process.exit(1);
    }
}

function getFallbackLog () {
    return require('get-off-my-log').initialise('boomcatch', console.log);
}

function normaliseWorkers () {
    if (check.not.number(cli.workers) || cli.workers < 0) {
        cli.workers = require('os').cpus().length;
    }
}

function getOptions () {
    return Object.keys(cli).reduce(function (options, key) {
        if (key.charAt(0) !== '_' && key !== 'commands' && key !== 'options' && key !== 'rawArgs' && key !== 'args') {
            options[key] = cli[key];
        }

        return options;
    }, {});
}