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         var userManagement_routes = require('./framework/core/modules/routes/userManagement');
 139         /**
 140          * Processing when a plugin is added or modified
 141          * @param {string} plugin_name - Name of the plugin
 142          */
 143         function onPluginAdded(plugin_name) {
 144                 // Load plugin config
 145                 var plugin_config = reload('./plugins/' + plugin_name + '/config.json');
 146
 147                 // Load all app's views
 148                 app.use('/' + plugin_name, express.static('./plugins/' + plugin_name + '/' + plugin_config.root));
 149
 150                 // Load all app's routes
 151                 app.use('/' + plugin_name, require('./plugins/' + plugin_name + '/routes'));
 152
 153                 // Publish navigation links
 154                 if (plugin_config.routes && _.isArray(plugin_config.routes)) {
 155                         skyquakeEmitter.emit('config_discoverer.navigation_discovered', plugin_name, plugin_config);
 156                 }
 157
 158         }
 159
 160         /**
 161          * Start listening on a port
 162          * @param {string} port - Port to listen on
 163          * @param {object} httpServer - httpServer created with http(s).createServer
 164          */
 165         function startListening(port, httpServer) {
 166                 var server = httpServer.listen(port, function () {
 167                         var host = server.address().address;
 168
 169                         var port = server.address().port;
 170
 171                         console.log('Express server listening on port', port);
 172                 });
 173                 return server;
 174         }
 175
 176         /**
 177          * Initialize skyquake
 178          */
 179         function init() {
 180                 skyquakeEmitter.on('plugin_discoverer.plugin_discovered', onPluginAdded);
 181                 skyquakeEmitter.on('plugin_discoverer.plugin_updated', onPluginAdded);
 182         }
 183
 184         /**
 185          * Configure skyquake
 186          */
 187         function config() {
 188                 // Conigure any globals
 189                 process.env.NODE_TLS_REJECT_UNAUTHORIZED=0;
 190
 191                 // Configure navigation router
 192                 app.use(navigation_routes);
 193
 194                 // Configure restconf router
 195                 app.use(restconf_routes);
 196
 197                 //Configure inactivity route(s)
 198                 app.use(inactivity_routes);
 199
 200                 // Configure global config with ssl enabled/disabled
 201                 var globalConfig = {
 202                         ssl_enabled: httpsConfigured,
 203                         api_server: apiServer
 204                 };
 205
 206                 if (uploadServer) {
 207                         globalConfig.upload_server = uploadServer;
 208                 }
 209
 210                 configurationAPI.globalConfiguration.update(globalConfig);
 211
 212                 // Configure configuration route(s)
 213                 app.use(configuration_routes);
 214
 215                 //Configure descriptor route(s)
 216                 app.use(descriptor_routes);
 217
 218                 //Configure user management route(s)
 219                 app.use(userManagement_routes);
 220
 221                 // app.get('/testme', function(req, res) {
 222                 //      res.sendFile(__dirname + '/index.html');
 223                 // });
 224
 225                 // Configure HTTP/HTTPS server and populate socketConfig.
 226                 if (httpsConfigured) {
 227                         console.log('HTTPS configured. Will create 2 servers');
 228                         secureHttpServer = https.createServer(sslOptions, app);
 229                         // Add redirection on SERVER_PORT
 230                         httpServer = http.createServer(function(req, res) {
 231                                 var host = req.headers['host'];
 232                                 host = host.replace(/:\d+$/, ":" + constants.SECURE_SERVER_PORT);
 233
 234                                 res.writeHead(301, { "Location": "https://" + host + req.url });
 235                         res.end();
 236                         });
 237
 238                         socketConfig.httpServer = secureHttpServer;
 239                 } else {
 240                         httpServer = http.createServer(app);
 241                         socketConfig.httpServer = httpServer;
 242                 }
 243
 244                 // Configure socket manager
 245                 socketManager.configure(socketConfig);
 246
 247                 // Configure socket router
 248                 socket_routes.routes(socketManager);
 249                 app.use(socket_routes.router);
 250
 251                 // Serve multiplex-client
 252                 app.get('/multiplex-client', function(req, res) {
 253                         res.sendFile(__dirname + '/node_modules/websocket-multiplex/multiplex_client.js');
 254                 });
 255         }
 256
 257         /**
 258          * Run skyquake functionality
 259          */
 260         function run() {
 261
 262                 // Start plugin_discoverer
 263                 var navigation_manager = require('./framework/core/modules/navigation_manager');
 264                 var plugin_discoverer = require('./framework/core/modules/plugin_discoverer');
 265
 266                 // Initialize asynchronous modules
 267                 navigation_manager.init();
 268                 plugin_discoverer.init();
 269
 270                 // Configure asynchronous modules
 271                 navigation_manager.config()
 272                 plugin_discoverer.config({
 273                         plugins_path: './plugins'
 274                 });
 275
 276                 // Run asynchronous modules
 277                 navigation_manager.run();
 278                 plugin_discoverer.run();
 279
 280
 281                 // Server start
 282                 if (httpsConfigured) {
 283                         console.log('HTTPS configured. Will start 2 servers');
 284                         // Start listening on SECURE_SERVER_PORT (8443)
 285                         var secureServer = startListening(constants.SECURE_SERVER_PORT, secureHttpServer);
 286                 }
 287                 // Start listening on SERVER_PORT (8000)
 288                 var server = startListening(constants.SERVER_PORT, httpServer);
 289
 290         }
 291
 292         init();
 293
 294         config();
 295
 296         run();
 297 }