Skip to content

Latest commit

 

History

History
136 lines (101 loc) · 5.56 KB

README.md

File metadata and controls

136 lines (101 loc) · 5.56 KB
Raw

safetymaps-onboard

Onboard Java application for embedded servers on fire engines connected to a tablet/phone or for on (Java-capable) tablets themselves to provide services to the fullscreen safetymapsDBK viewer.

Design principles

  • No application server installation required (such as Tomcat or NodeJS on Windows)
  • No database required (unfeasable on remote embedded installs)
  • Java client installation is feasable
  • Updatable by filesetsync-client when fire engine returns to base with WiFi

Auto-update

The Main class monitors the current directory for changes to the file update.flag. On changes, it exits with exit code 99.

The filesetsync-client should be configured to download a new fileset of the safetymaps-onboard application (including Lucene search index) in the update directory. When this is completely downloaded, the flag file should be updated.

The script safetymaps-onboard.cmd copies the update directory to bin and and starts it. The old version is moved to the bak directory.

Making a release

Copy bag_settings.sh.example to bag_settings.sh and adjust settings to your environment. The settings should allow psql to connect to the same BAG database as the NodeJS safetymapsDBK application. Alternatively, a few example rows are provided in bag.txt.example. Copy this to bag.txt and comment out the psql call in release.sh to use it.

Run release.sh to create a distribution in the bin directory including the Lucene search index.

Installation on server and embedded client

Configure filesetsync on the server as follows: TODO

To install on a Windows embedded client, copy the contents of the bin directory to c:\ogg\safetymaps-onboard\bin and create a shortcut to safetymaps-onboard.cmd in the Startup Start Menu folder, and set it to start minimized. Start the application and allow network access before deploying the system image to fire engines.

To avoid having to modify safetymaps-onboard.cmd, specify the command line in a file commandline.txt.

Test the location search by browsing to [http://localhost:1080/q/zonnebaan] on the embedded system, and test all functionality described below in the fullscreen safetymaps viewer.

Functionality

The fullscreen safetymapsDBK viewer is designed to work as a static web application as much as possible but searching a large adress index is not doable in JavaScript, therefore the following web API functionality is included in this project.

Command line config:

  • -port <port> Port to start server on, default 1080

Location search

Path: /q/<term>
Command line config:

  • -searchdb <file> ZIP file containing the Lucene index, default db/index.zip

Configuring safetymaps fullscreen:

dbkjs.options.urls = dbkjs.options.urls ? dbkjs.options.urls : {};
// If running fullscreen safetymaps on server, use default port. Otherwise use port 1080
// because the static webserver is running on port 80
dbkjs.options.urls.autocomplete = 'http://' + window.location.hostname + (window.location.hostname === 'localhost' ? ':1080' : '') + '/q/';

Implementing class: LocationSearch

Search for adresses/locations. Same API as controllers/bag.js, but the implementation is completely different because installing and keeping an entire PostGIS installation up-to-date with a BAG database is unworkable in an embedded situation.

Uses Lucene for searching. Lucene index is created on the server using the IndexBuilder class, which takes as input the result of the psql query in release.sh.

This input is parsed and put in a Lucene index and compressed as ZIP with 10MB split parts to be transferred with filesetsync-client.

The index is extracted on startup in the index subdirectory of the workdir.

Request forwarding

The fullscreen safetymaps viewers may not be connected to the server all the time. For the following functionality the request is saved by safetymaps-onboard and forwarded to the server when connection to the server is available (when fire engine is returned to base WiFi):

  • support module emails

Path: /forward/<forward-path> (GET and POST supported)
Command line config:

  • -forwardurl <url> The URL to safetymaps server to forward the request to
  • -save Keep forwarded requests in forwarded subdirectory var/store/forwarded

Configuring safetymaps fullscreen, support module:

dbkjs.options.urls = dbkjs.options.urls ? dbkjs.options.urls : {};
// If running fullscreen safetymaps on server, use default port. Otherwise use port 1080
// because the static webserver is running on port 80
dbkjs.options.urls.annotation = 'http://' + window.location.hostname +  (window.location.hostname === 'localhost' ? ':1080' : '') + '/forward/mail';
// Add notification that messages are forwarded on return to base
$(dbkjs).one("dbkjs_init_complete", function() {
    $('#foutknop').on("click", function() {
        $("#email_help").append("<i> Meldingen worden bewaard en verstuurd bij terugkeer in kazerne.</i>");
    });
});

Implementing class: RequestStoreAndForward

Feedback is currently available in logging output and examining the store directory, users of safetymaps fullscreen do not currently get feedback of stored and succesfully forwarded requests.

Only some headers are forwarded:

  • Content-Type
  • User-Agent

Additional headers added:

  • X-Original-Date Original Date header

A pure webbrowser-based solution using local storage was decided against because the disk store and log is more robust and manageable.