server.js

/*
Copyright (c) 2018-2023 Dave Weilert

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.
*/

//------------------------------------------------------------------------------
// Main server 
//------------------------------------------------------------------------------
const softwareVersion = '6.2.6';

//------------------------------------------------------------------------------
// Require statements
//------------------------------------------------------------------------------
import vpk from './lib/vpk.js';
import utl from './lib/utl.js';
import flh from './lib/fileHandler.js';
import vpkReset from './lib/vpkReset.js';
import docm from './lib/documentation.js';
import appRoutes from './lib/appRoutes.js';
import splash from './lib/splash.js';
import clientIO from './lib/clientIO.js';
import indexRouter from './public/routes/index.js';


// third-party requires and configuration
import bodyParser from 'body-parser';
import commandLineArgs from 'command-line-args';
import http from 'http';
import express from 'express';
// import socketio from 'socket.io';
import { Server } from 'socket.io';
import partials from 'express-partials';
import compression from 'compression';
import cors from 'cors';
import fs from 'fs-extra';
import path from 'path';
import { fileURLToPath } from 'url';

// server and socketio configuration
let app = express();
let server = http.createServer(app);
let io = new Server(server);



const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

//------------------------------------------------------------------------------
// Application start parms
//------------------------------------------------------------------------------
let port = 4200;
let snapshot = "x";

let startMsg = [];
let cwd = process.cwd();
let optionDefinitions = [{
    name: 'port',
    description: 'Port to provide access for the browser portion of the VpK application. Range is 1 to 65535.',
    alias: 'p',
    type: Number,
    defaultOption: 4200
},
{
    name: 'snapshot',
    description: 'Directory that contains the cluster Snapshot files. '
        + 'Provide the complete path to the snapshot instances. '
        + 'If not defined the directory: ' + cwd + '/cluster will be used.',
    alias: 's',
    type: String
},
{
    name: 'container',
    description: 'Indicates VpK is running from a container.'
        + 'Enables an additional feature to communicate via the web interface to send commands to the container.',
    alias: 'c'
},
{
    name: 'help',
    description: 'Display this usage guide.',
    alias: 'h'
}
];

//------------------------------------------------------------------------------
// Process start parameters if provided
//------------------------------------------------------------------------------
let options = commandLineArgs(optionDefinitions);

// -help used
if (typeof options.help !== 'undefined') {
    splash.help(optionDefinitions);
    process.exit(0);
}

// -p used
if (typeof options.port !== 'undefined' && options.port !== null) {
    port = options.port;
    if (port < 1 || port > 65535) {
        utl.logMsg('vpkMNL099 - Invalid port number defined.  Valid range is 1 - 65535');
        process.exit(-1);
    }
}

// -s snapshot volume
if (typeof options.snapshot !== 'undefined' && options.snapshot !== null) {
    snapshot = options.snapshot;

    let nd = flh.formatDir(snapshot);

    vpk.snapshotDir = nd;
} else {
    vpk.snapshotDir = "none";
}

// -c container instance
if (typeof options.container !== 'undefined' && options.container !== null) {
    vpk.runMode = 'C';
    // startMsg.push('vpkMNL104 - Vpk running from container');
} else {
    vpk.runMode = 'L';
    // startMsg.push('vpkMNL105 - Vpk running locally');
}

//------------------------------------------------------------------------------
// splash screen
//------------------------------------------------------------------------------
splash.pop(softwareVersion, port);

if (startMsg.length > 0) {
    for (let m = 0; m < startMsg.length; m++) {
        utl.logMsg(startMsg[m]);
    }
}

//------------------------------------------------------------------------------
// read vpk configuration file
//------------------------------------------------------------------------------
let gcstatus = flh.readConfig();
if (gcstatus !== 'OK') {
    utl.logMsg('vpkMNL095 - Terminating application error processing configuration file vpkconfig.json');
    process.exit(-1);
}


//------------------------------------------------------------------------------
// Define configuration for app
//------------------------------------------------------------------------------
app.use(express.static(__dirname + '/public'));
app.use(bodyParser.json());
app.use(compression());
app.use(cors());
// Partials 
app.use(partials());
// Express 
app.use(express.urlencoded({ extended: true }));
// Routes
app.use('/', indexRouter);
// Views location and processing engine
app.set('views', __dirname + '/public/views');
app.set('view engine', 'ejs');


//------------------------------------------------------------------------------
// Define app routes / urls
//------------------------------------------------------------------------------
appRoutes.init(app);


//------------------------------------------------------------------------------
// Define Client SocketIO 
//------------------------------------------------------------------------------
clientIO.init(io, softwareVersion);


//------------------------------------------------------------------------------
// Reset all vars in global vpk
//------------------------------------------------------------------------------
vpkReset.resetAll();


//------------------------------------------------------------------------------
// start server
//------------------------------------------------------------------------------
function startServer() {
    try {
        server.listen(port);              // start server
        flh.readLicenseFile();            // read license text into global vpk
        // create the cluster directory if it does not exist
        // if (vpk.snapshotDir === "") {
        //     flh.makedir('cluster');
        // }
        flh.makedir('cluster');
        flh.makedir('usage');             // create the usage directory if it does not exist

        docm.buildDocumentation();        // read, parse, and load documentation markdown files into global vpk
    } catch (err) {
        console.log(err.stack)
    }
}

//------------------------------------------------------------------------------
// Begin processing
//------------------------------------------------------------------------------
startServer();