skyquake/skyquake.js

   1 /*
   2  *
   3  *   Copyright 2016 RIFT.IO Inc
   4  *
   5  *   Licensed under the Apache License, Version 2.0 (the "License");
   6  *   you may not use this file except in compliance with the License.
   7  *   You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *   Unless required by applicable law or agreed to in writing, software
  12  *   distributed under the License is distributed on an "AS IS" BASIS,
  13  *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *   See the License for the specific language governing permissions and
  15  *   limitations under the License.
  16  *
  17  */
  18
  19 /**
  20  * Main skyquake module.
  21  * @module skyquake
  22  * @author Kiran Kashalkar <kiran.kashalkar@riftio.com>
  23  */
  24
  25 // Standard library imports for forking
  26 var cluster = require("cluster");
  27 var cpu = require('os').cpus().length;
  28 var clusteredLaunch = process.env.CLUSTER_SUPPORT || false;
  29 var constants = require('./framework/core/api_utils/constants');
  30 // Uncomment for Replay support
  31 // const Replay  = require('replay');
  32 var freePorts = [];
  33 for (var i = 0; i < constants.SOCKET_POOL_LENGTH; i++) {
  34         freePorts[i] = constants.SOCKET_BASE_PORT + i;
  35 };
  36
  37
  38 if (cluster.isMaster && clusteredLaunch) {
  39     console.log(cpu, 'CPUs found');
  40     for (var i = 0; i < cpu; i ++) {
  41         var worker = cluster.fork();
  42         worker.on('message', function(msg) {
  43                 if (msg && msg.getPort) {
  44                                 worker.send({
  45                                         port: freePorts.shift()
  46                                 });
  47                                 console.log('freePorts after shift for worker', this.process.pid, ':', freePorts);
  48                         } else if (msg && msg.freePort) {
  49                                 freePorts.unshift(msg.port);
  50                                 console.log('freePorts after unshift of', msg.port, 'for worker', this.process.pid, ':', freePorts);
  51                         }
  52             });
  53     }
  54
  55     cluster.on('online', function(worker) {
  56         console.log("Worker Started pid : " + worker.process.pid);
  57     });
  58     cluster.on('exit', function(worker, code, signal) {
  59         console.log('worker ' + worker.process.pid + ' stopped');
  60     });
  61 } else {
  62         // Standard library imports
  63         var argv = require('minimist')(process.argv.slice(2));
  64         var pid = process.pid;
  65         var fs = require('fs');
  66         var https = require('https');
  67         var http = require('http');
  68         var express = require('express');
  69         var session = require('express-session');
  70         var cors = require('cors');
  71         var bodyParser = require('body-parser');
  72         var _ = require('lodash');
  73         var reload = require('require-reload')(require);
  74         var Sockets = require('./framework/core/api_utils/sockets.js');
  75
  76         require('require-json');
  77
  78         // SSL related configuration bootstrap
  79         var httpServer = null;
  80         var secureHttpServer = null;
  81
  82         var httpsConfigured = false;
  83
  84         var sslOptions = null;
  85
  86         var apiServer = argv['api-server'] ? argv['api-server'] : 'localhost';
  87         var uploadServer = argv['upload-server'] ? argv['upload-server'] : null;
  88
  89         try {
  90                 if (argv['enable-https']) {
  91                         var keyFilePath = argv['keyfile-path'];
  92                         var certFilePath = argv['certfile-path'];
  93
  94                         sslOptions = {
  95                                 key: fs.readFileSync(keyFilePath),
  96                         cert: fs.readFileSync(certFilePath)
  97                         };
  98
  99                         httpsConfigured = true;
 100                 }
 101         } catch (e) {
 102                 console.log('HTTPS enabled but file paths missing/incorrect');
 103                 process.exit(code = -1);
 104         }
 105
 106         var app = express();
 107
 108         app.use(session({
 109           secret: 'ritio rocks',
 110           resave: true,
 111           saveUninitialized: true
 112         }));
 113         app.use(bodyParser.json());
 114         app.use(cors());
 115         app.use(bodyParser.urlencoded({
 116                 extended: true
 117         }));
 118
 119         var socketManager = new Sockets();
 120         var socketConfig = {
 121                 httpsConfigured: httpsConfigured
 122         };
 123
 124         if (httpsConfigured) {
 125                 socketConfig.sslOptions = sslOptions;
 126         }
 127
 128         // Rift framework imports
 129         var constants = require('./framework/core/api_utils/constants');
 130         var skyquakeEmitter = require('./framework/core/modules/skyquakeEmitter');
 131         var navigation_routes = require('./framework/core/modules/routes/navigation');
 132         var socket_routes = require('./framework/core/modules/routes/sockets');
 133         var restconf_routes = require('./framework/core/modules/routes/restconf');
 134         var inactivity_routes = require('./framework/core/modules/routes/inactivity');
 135         var descriptor_routes = require('./framework/core/modules/routes/descriptorModel');
 136         var configuration_routes = require('./framework/core/modules/routes/configuration');
 137         var configurationAPI = require('./framework/core/modules/api/configuration');
 138         /**
 139          * Processing when a plugin is added or modified
 140          * @param {string} plugin_name - Name of the plugin
 141          */
 142         function onPluginAdded(plugin_name) {
 143                 // Load plugin config
 144                 var plugin_config = reload('./plugins/' + plugin_name + '/config.json');
 145
 146                 // Load all app's views
 147                 app.use('/' + plugin_name, express.static('./plugins/' + plugin_name + '/' + plugin_config.root));
 148
 149                 // Load all app's routes
 150                 app.use('/' + plugin_name, require('./plugins/' + plugin_name + '/routes'));
 151
 152                 // Publish navigation links
 153                 if (plugin_config.routes && _.isArray(plugin_config.routes)) {
 154                         skyquakeEmitter.emit('config_discoverer.navigation_discovered', plugin_name, plugin_config);
 155                 }
 156
 157         }
 158
 159         /**
 160          * Start listening on a port
 161          * @param {string} port - Port to listen on
 162          * @param {object} httpServer - httpServer created with http(s).createServer
 163          */
 164         function startListening(port, httpServer) {
 165                 var server = httpServer.listen(port, function () {
 166                         var host = server.address().address;
 167
 168                         var port = server.address().port;
 169
 170                         console.log('Express server listening on port', port);
 171                 });
 172                 return server;
 173         }
 174
 175         /**
 176          * Initialize skyquake
 177          */
 178         function init() {
 179                 skyquakeEmitter.on('plugin_discoverer.plugin_discovered', onPluginAdded);
 180                 skyquakeEmitter.on('plugin_discoverer.plugin_updated', onPluginAdded);
 181         }
 182
 183         /**
 184          * Configure skyquake
 185          */
 186         function config() {
 187                 // Conigure any globals
 188                 process.env.NODE_TLS_REJECT_UNAUTHORIZED=0;
 189
 190                 // Configure navigation router
 191                 app.use(navigation_routes);
 192
 193                 // Configure restconf router
 194                 app.use(restconf_routes);
 195
 196                 //Configure inactivity route(s)
 197                 app.use(inactivity_routes);
 198
 199                 // Configure global config with ssl enabled/disabled
 200                 var globalConfig = {
 201                         ssl_enabled: httpsConfigured,
 202                         api_server: apiServer
 203                 };
 204
 205                 if (uploadServer) {
 206                         globalConfig.upload_server = uploadServer;
 207                 }
 208
 209                 configurationAPI.globalConfiguration.update(globalConfig);
 210
 211                 // Configure configuration route(s)
 212                 app.use(configuration_routes);
 213
 214                 //Configure descriptor route(s)
 215                 app.use(descriptor_routes);
 216
 217                 // app.get('/testme', function(req, res) {
 218                 //      res.sendFile(__dirname + '/index.html');
 219                 // });
 220
 221                 // Configure HTTP/HTTPS server and populate socketConfig.
 222                 if (httpsConfigured) {
 223                         console.log('HTTPS configured. Will create 2 servers');
 224                         secureHttpServer = https.createServer(sslOptions, app);
 225                         // Add redirection on SERVER_PORT
 226                         httpServer = http.createServer(function(req, res) {
 227                                 var host = req.headers['host'];
 228                                 host = host.replace(/:\d+$/, ":" + constants.SECURE_SERVER_PORT);
 229
 230                                 res.writeHead(301, { "Location": "https://" + host + req.url });
 231                         res.end();
 232                         });
 233
 234                         socketConfig.httpServer = secureHttpServer;
 235                 } else {
 236                         httpServer = http.createServer(app);
 237                         socketConfig.httpServer = httpServer;
 238                 }
 239
 240                 // Configure socket manager
 241                 socketManager.configure(socketConfig);
 242
 243                 // Configure socket router
 244                 socket_routes.routes(socketManager);
 245                 app.use(socket_routes.router);
 246
 247                 // Serve multiplex-client
 248                 app.get('/multiplex-client', function(req, res) {
 249                         res.sendFile(__dirname + '/node_modules/websocket-multiplex/multiplex_client.js');
 250                 });
 251         }
 252
 253         /**
 254          * Run skyquake functionality
 255          */
 256         function run() {
 257
 258                 // Start plugin_discoverer
 259                 var navigation_manager = require('./framework/core/modules/navigation_manager');
 260                 var plugin_discoverer = require('./framework/core/modules/plugin_discoverer');
 261
 262                 // Initialize asynchronous modules
 263                 navigation_manager.init();
 264                 plugin_discoverer.init();
 265
 266                 // Configure asynchronous modules
 267                 navigation_manager.config()
 268                 plugin_discoverer.config({
 269                         plugins_path: './plugins'
 270                 });
 271
 272                 // Run asynchronous modules
 273                 navigation_manager.run();
 274                 plugin_discoverer.run();
 275
 276
 277                 // Server start
 278                 if (httpsConfigured) {
 279                         console.log('HTTPS configured. Will start 2 servers');
 280                         // Start listening on SECURE_SERVER_PORT (8443)
 281                         var secureServer = startListening(constants.SECURE_SERVER_PORT, secureHttpServer);
 282                 }
 283                 // Start listening on SERVER_PORT (8000)
 284                 var server = startListening(constants.SERVER_PORT, httpServer);
 285
 286         }
 287
 288         init();
 289
 290         config();
 291
 292         run();
 293 }