Create scenario update

.gitignore

@@ -5,3 +5,5 @@
 # Node.js
 node_modules
 /npm-debug.log
+/log/xapi-statements.json
+/public/ITDG

CHANGELOG.md

@@ -1,6 +1,16 @@
 VIRTUAL WORLD FRAMEWORK CHANGE LOG
 ==================================
 
+----------------------------------
+0.8.0
+----------------------------------------------------------------------------------------------------
+Note: (*) indicates an API change. 
+
+- CHG*: Handle reflector actions as they arrive, without waiting for a tick. 
+- CHG*: Don't record ticks in the queue. Don't tick nodes and model drivers. 
+- CHG*: Remove ticking function from model drivers. 
+
+
 ----------------------------------
 0.7.0
 ----------------------------------------------------------------------------------------------------

StartVWFServer.bat

@@ -0,0 +1,7 @@
+@echo off
+set NPM_PATH=%HOMEDRIVE%%HOME_PATH%\AppData\Roaming\npm
+set NODEJS_PATH=%ProgramFiles%\nodejs
+set PATH=%NPM_PATH%;%NODEJS_PATH%;%PATH%
+cd C:\ITDG\VWF
+npm start
+exit

StartVWFServerMinimized.bat

@@ -0,0 +1,4 @@
+@echo off
+cd C:\ITDG\VWF
+start /min StartVWFServer.bat
+exit

config/custom-environment-variables.json

@@ -0,0 +1,13 @@
+{
+  "session": {
+    "secret": "VWF_SESSION_SECRET"
+  },
+  "tdg": {
+    "password": "VWF_TDG_PASSWORD"
+  },
+  "txs": {
+    "amqp_host": "VWF_TXS_AMQP_HOST",
+    "amqp_exchange": "VWF_TXS_AMQP_EXCHANGE",
+    "amqp_channel": "VWF_TXS_AMQP_CHANNEL"
+  }
+}

config/default.json

@@ -0,0 +1,24 @@
+{
+
+  // Secret for signed sessions. Generate a new secret with
+  // `node -e 'console.log( require( "crypto" ).randomBytes( 32 ).toString( "hex" ) )'`
+
+  "session": {
+    "secret": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"
+  },
+
+  // TDG instructor password.
+
+  "tdg": {
+    "password": "password"
+  },
+
+  // AMQP parameters for the `/sim` route to publish to TXS.
+
+  "txs": {
+    "amqp_host": "localhost",
+    "amqp_exchange": "x_txs",
+    "amqp_channel": "itdg.loadMission"
+  }
+
+}

documents/ITDG/maps/test-R400.tms/tilemapresource.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+    <TileMap version="1.0.0" tilemapservice="http://tms.osgeo.org/1.0.0">
+      <Title>R400_imagery_wgs84_clipped_noalpha.tif</Title>
+      <Abstract></Abstract>
+      <SRS>EPSG:4326</SRS>
+      <BoundingBox minx="34.30000293136028" miny="-115.98798356199879" maxx="34.31708185985235" maxy="-115.97085609083929"/>
+      <Origin x="34.30000293136028" y="-115.98798356199879"/>
+      <TileFormat width="256" height="256" mime-type="image/png" extension="png"/>
+      <TileSets profile="geodetic">
+        <TileSet href="10" units-per-pixel="0.00068664550781" order="10"/>
+        <TileSet href="11" units-per-pixel="0.00034332275391" order="11"/>
+        <TileSet href="12" units-per-pixel="0.00017166137695" order="12"/>
+        <TileSet href="13" units-per-pixel="0.00008583068848" order="13"/>
+        <TileSet href="14" units-per-pixel="0.00004291534424" order="14"/>
+        <TileSet href="15" units-per-pixel="0.00002145767212" order="15"/>
+        <TileSet href="16" units-per-pixel="0.00001072883606" order="16"/>
+        <TileSet href="17" units-per-pixel="0.00000536441803" order="17"/>
+        <TileSet href="18" units-per-pixel="0.00000268220901" order="18"/>
+        <TileSet href="19" units-per-pixel="0.00000134110451" order="19"/>
+        <TileSet href="20" units-per-pixel="0.00000067055225" order="20"/>
+      </TileSets>
+    </TileMap>
+

documents/ITDG/metrics/TBS_BOC_Metrics.csv

@@ -0,0 +1,5 @@
+"title","index","type","setLayerOwned","defaultValue","options"
+"Student Orders","0","Long Text","undefined","","null"
+"Instructor Rating","1","Range","undefined","","[0,10,1,{'0':'N/A','1':'Unsat','2':'Unsat','3':'Marginal','4':'Marginal','5':'Acceptable','6':'Acceptable','7':'Capable','8':'Capable','9':'Outstanding','10':'Outstanding'}]"
+"Instructor Grade","2","Text","undefined","","null"
+"Instructor Observations","3","Long Text","undefined","","null"

documents/ITDG/scenarioTemplate/saveState.vwf.config.json

@@ -0,0 +1 @@
+{"info":{"title":"Scenario Template"},"model":{"vwf/model/javascript":"","vwf/model/kineticjs":"","vwf/model/mil-sym":"","vwf/model/object":"","nodriver":""},"view":{"vwf/view/document":"","vwf/view/touch":"","vwf/view/kineticjs":"","vwf/view/mil-sym":""}}

documents/ITDG/scenarioTemplate/saveState.vwf.json

@@ -0,0 +1 @@
+{"configuration":{"log-level":"info","random-seed":1466540519030,"randomize-ids":true,"humanize-ids":true,"preserve-script-closures":false,"load-timeout":120},"kernel":{"time":0},"nodes":[{"patches":"http://vwf.example.com/clients.vwf","sequence":7,"random":{"s0":0.24205980077385902,"s1":0.9761656543705612,"s2":0.9434323732275516,"c":11304},"children":{}},{"patches":"/ITDG/index.vwf","properties":{"unitIconDefaults":{"shadowColor":"rgba( 1, 1, 1, 0.5 )","shadowBlur":10,"shadowOffsetX":8,"shadowOffsetY":8,"shadowEnabled":false}},"children":{"scenarioController":{"patches":"/ITDG/index.vwf:3-47-scenarioController","sequence":4,"random":{"s0":0.4123580085579306,"s1":0.9537082586903125,"s2":0.22647805558517575,"c":582588},"properties":{},"children":{}},"participants":{"patches":"/ITDG/index.vwf:5-08-participants","sequence":1,"random":{"s0":0.6633416542317718,"s1":0.6727178883738816,"s2":0.3024811027571559,"c":1237838},"children":{}}}}],"annotations":{"1":"application"},"queue":{"time":0,"queue":[]}}

external/README.txt

@@ -0,0 +1 @@
+Place external applications in "external" folder.

lib/nodejs/admin.js

@@ -232,7 +232,7 @@ function HandleAdminConfig( request, response, parsedRequest ) {
     if ( ( parsedRequest[ 'public_path' ] ) && ( parsedRequest[ 'application' ] ) && ( request.method == "GET" ) ) {
         var filenameRoot = helpers.JoinPath( global.applicationRoot, parsedRequest[ 'public_path' ], parsedRequest[ 'application' ] );
         if ( helpers.IsFile(  filenameRoot + ".config.yaml" ) ) {
-            serve.YAML( ( filenameRoot + ".config.yaml" ).replace( /\//g, libpath.sep ), response, url.parse( request.url, true ) );
+            serve.YAML( request, ( filenameRoot + ".config.yaml" ).replace( /\//g, libpath.sep ), response, url.parse( request.url, true ) );
             return true;
         }
         else if ( helpers.IsFile( filenameRoot + ".config.json" ) ) {
@@ -242,6 +242,7 @@ function HandleAdminConfig( request, response, parsedRequest ) {
         else {
             // If there is no config file, return an empty string to prevent 404 errors
             serve.JSON("", response);
+            return true;
         }
     }
     return false;
@@ -267,9 +268,9 @@ function HandleAdminChrome( request, response, parsedRequest ) {
     return false;
 }
 
-// The Serve function in admin takes in the nodeJS request and nnodeJS response as well as 
+// The Serve function in admin takes in the nodeJS request and nodeJS response as well as
 // the parsedRequest information.
-// It tests if the request is actually an admin request, and if calls an appropriate handler
+// It tests if the request is actually an admin request, and if so, calls an appropriate handler
 // to serve the appropriate response.
 // If the request is succesfully served, it returns TRUE, if the request is not succesfully
 // served (whether due to a file not being present, the request being malformed, or simply it

lib/nodejs/application.js

@@ -5,7 +5,8 @@
 var servehandler = require( './serve-handler' ),
     helpers = require( './helpers' ),
     persistence = require( './persistence' ),
-    admin = require( './admin' );
+    admin = require( './admin' ),
+    stream = require( './stream' );
 
 // Requests are attempted to be served as if they pertain to a specific application.
 // If any of these attempts succesfully serve the request, true is returned.
@@ -32,11 +33,15 @@ function Serve( request, response, parsedRequest ) {
     if ( servehandler.Component( request, response, helpers.JoinPath( global.applicationRoot, parsedRequest[ 'public_path' ], parsedRequest[ 'private_path' ] ) ) ) {
         return true;
     }
+    // Test if mediaServer can server the request.
+    if ( stream.Serve( request, response, parsedRequest ) ) {
+        return true;
+    }
     // If the request was still not served, try and see if the persistence functionality will serve this request.
     if ( persistence.Serve( request, response, parsedRequest ) ) {
         return true;
     }
-    // Finally, test if the admin functionality can serve this request.
+    // Test if the admin functionality can serve this request.
     if ( admin.Serve( request, response, parsedRequest ) ) {
         return true;
     }

lib/nodejs/authentication.js

@@ -0,0 +1,150 @@
+// TDG authentication scheme.
+// 
+// A valid login is required for all routes. Any username is accepted, but instructors must provide
+// the instructor password. A VWF `client.vwf` descriptor is published to the session to describe
+// the user in the VWF application.
+
+var passport = require( "passport" ),
+  passportLocal = require( "passport-local" ),
+  config = require( "config" ),
+  path = require( "path" );
+
+// Passport strategy options.
+
+var strategyOptions = {
+  passReqToCallback: true,      // Call the strategy callback as `cb( req, ... )` instead of `cb( ... )`
+  usernameField: "last_name",   // A non-empty field to appease `passport-local`, but we ignore `username`
+  passwordField: "last_name",   // A non-empty field, and we ignore `password`; the actual password may be empty
+};
+
+// Create and attach the Passport strategy object.
+
+var strategy = new passportLocal( strategyOptions, function( req, username, password, done ) {
+
+  // Build the user object from the form properties.
+
+  var user = {
+    last_name:
+      req.body.last_name || req.query.last_name,
+    first_name:
+      req.body.first_name || req.query.first_name,
+    middle_initial:
+      req.body.middle_initial || req.query.middle_initial,
+    instructor:
+      req.body.instructor || req.query.instructor,
+  };
+
+  // Get the actual password from the form.
+
+  password = req.body.password || req.query.password;
+
+  // Check the password if one is configured. Instructors must provide a password.
+
+  var authenticated = ! config.has( "tdg.password" ) || ! config.get( "tdg.password" ) ||
+    password === config.get( "tdg.password" );
+
+  // Return the result. For successful logins, return the user object. The user object will be
+  // attached to the request at `req.user`.
+  // 
+  // For login errors, return `false` for `user` and provide an error message. If an error occurs
+  // while performing the lookup, return the error object.
+
+  if ( user.instructor && ! authenticated ) {
+    return done( null, false, { message: 'Incorrect password' } );
+  } else {
+    return done( null, user );
+  }
+
+} );
+
+passport.use( strategy );
+
+// Convert the user object to a reference to be stored in the session. Without a user database, this
+// can be the user object. With a local user database, it should be the user id in the database.
+// 
+// Also attach a VWF `client.vwf` descriptor to the session to describe the user for the VWF
+// application.
+
+passport.serializeUser( function( req, user, done ) {
+
+  req.session.vwf = req.session.vwf || {};
+
+  req.session.vwf.client = {
+    properties: {
+      last_name:
+        user.last_name,
+      first_name:
+        user.first_name,
+      middle_initial:
+        user.middle_initial,
+      instructor:
+        user.instructor !== undefined ? !! user.instructor : undefined,
+    }
+  };
+
+  done( null, user );
+
+} );
+
+// Convert a user reference in the session to a user object. Without a user database, the session
+// data is the user object. With a local user database, look up the user from an id in the session.
+
+passport.deserializeUser( function( req, id, done ) {
+  done( null, id );
+} );
+
+// Create a router to contain the Passport middleware and login/logout routes.
+
+var router = require( "express" ).Router();
+
+// Passport and the Passport `session` module.
+
+router.use( passport.initialize() );
+router.use( passport.authenticate( "session" ) );
+
+// Show a login form at `/login`.
+
+router.get( "/login", function( req, res ) {
+  res.sendFile( path.join( __dirname, "../../support/lobby", "login.html" ) );
+} );
+
+// Receive a login request and attempt to authenticate.
+// 
+// The URLs would need the base URL prepended if the application is not mounted at `/`. Since the
+// authentication middleware is created outside the request, we don't have access to `baseUrl` to
+// do this.
+
+router.post( "/login", passport.authenticate( "local", {
+  successReturnToOrRedirect: /* req.baseUrl + */ "/",
+  failureRedirect: /* req.baseUrl + */ "/login",
+  failureFlash: true,
+} ) );
+
+// Receive a logout request and log out. Also remove the VWF `client.vwf` descriptor from the
+// session.
+
+router.post( "/logout", function( req, res ) {
+  req.logout();
+  req.session.vwf && delete req.session.vwf.client;
+  res.redirect( req.baseUrl + "/login" );
+} );
+
+// Enforce authentication rules. This implementation requires a valid login for all routes except
+// for `/login` and `/logout`.
+
+router.use( function( req, res, next ) {
+  if ( req.isUnauthenticated() ) {
+    if ( req.accepts( "html", "json" ) === "html" ) {
+      req.session.returnTo = req.baseUrl + req.url;
+      res.redirect( req.baseUrl + "/login" );
+    } else {
+      res.sendStatus( 401 );
+    }
+  } else {
+    next();
+  }
+} );
+
+// Export the router.
+
+module.exports = router;

lib/nodejs/authentication/passport-http.js

@@ -0,0 +1,65 @@
+// Example authentication module implemented with Passport and HTTP Basic authentication.
+// 
+// A valid login is required for all routes, but any username and password are accepted. Hooks for
+// querying a user database are shown. A VWF `client.vwf` descriptor is published to the session to
+// describe the user in the VWF application.
+// 
+// Add the NPM modules `passport` and `passport-http` to support this method.
+
+var passport = require( "passport" ),
+  passportHTTP = require( "passport-http" );
+
+// Create and attach the Passport strategy object.
+
+var strategy = new passportHTTP.BasicStrategy( function( username, password, done ) {
+
+  // Given `username` and `password` from a login form, look up the user in a local database.
+
+  var user = { username: username };
+
+  // Return the result. For successful logins, return the user object. The user object will be
+  // attached to the request at `req.user`.
+  // 
+  // For login errors, return `false` for `user` and provide an error message. If an error occurs
+  // while performing the lookup, return the error object.
+
+  if ( false /* lookup error */ ) {
+    return done( {} /* err */ );
+  } else if ( false /* bad user */ ) {
+    return done( null, false, { message: 'Incorrect username' } );
+  } else if ( false /* bad password */ ) {
+    return done( null, false, { message: 'Incorrect password' } );
+  } else {
+    return done( null, user );
+  }
+
+} );
+
+passport.use( strategy );
+
+// Convert the user object to a reference to be stored in the session. Without a user database, this
+// can be the user object. With a local user database, it should be the user id in the database.
+// 
+// Also attach a VWF `client.vwf` descriptor to the session to describe the user for the VWF
+// application.
+
+passport.serializeUser( function( req, user, done ) {
+  req.session.vwf = req.session.vwf || {};
+  req.session.vwf.client = { properties: { username: user.username } };
+  done( null, user );
+} );
+
+// Convert a user reference in the session to a user object. Without a user database, the session
+// data is the user object. With a local user database, look up the user from an id in the session.
+
+passport.deserializeUser( function( req, id, done ) {
+  done( null, id );
+} );
+
+// Export the Passport initializer, `session` module, and HTTP Basic strategy module.
+
+module.exports = [
+  passport.initialize(),
+  passport.authenticate( "session" ),
+  passport.authenticate( "basic" ),
+];