Merge pull request #7 from quinkennedy/flags-and-fullscreen

Flags and fullscreen

Author: jmwohl

.eslintrc.yml

@@ -73,7 +73,8 @@ env:
   commonjs: true
   mocha: true
 
-
+parserOptions:
+  ecmaVersion: 6
 
 
 globals:

extension.js

@@ -1,6 +1,8 @@
+'use strict';
 var pjson = require('./package.json'),
     Extension = require('openframe-extension'),
-    execSync = require('child_process').execSync;
+    execSync = require('child_process').execSync,
+    debug = require('debug')('openframe-website');
 
 /**
  * Extensions should expose an instance of the Extension class.
@@ -16,17 +18,50 @@ module.exports = new Extension({
         'download': false,
         'start_command': function(args, tokens) {
             // 1. clone template .xinitrc
-            var filePath = _cloneTemplate(this.xinitrcTplPath);
-            // 1. replace tokens in .xinitrc
-            _replaceTokens(filePath, tokens);
-            // 2. return xinit
+            var filePath = _cloneTemplate(this.xinitrcTplPath),
+                // 2. parse options from args into tokens
+                _tokens = _extendTokens(args, tokens);
+            // 3. replace tokens in .xinitrc
+            _replaceTokens(filePath, _tokens);
+            // 4. return xinit
             return 'xinit ' + filePath;
         },
         'end_command': 'pkill -f X',
         xinitrcTplPath: __dirname + '/scripts/.xinitrc.tpl'
     },
 });
 
+/**
+ * extend the tokens with expected values from args
+ *
+ * @param {object} args Arguments provided to this extension
+ * @param {object} tokens Original tokens for this extension
+ */
+function _extendTokens(args, tokens) {
+    var _tokens = {},
+        _args = args,
+        expectedKeys = ['flags'];
+
+    // if args is not an object, we'll just use an empty one
+    if (typeof(args) !== 'object') {
+        _args = {};
+    }
+
+    // shallow-copy the original tokens object
+    for (let key in tokens) {
+        _tokens[key] = tokens[key];
+    }
+
+    // copy expected arguments from args to the new tokens object
+    // defaulting to an emptystring
+    for (let key of expectedKeys) {
+        // prepend keys with a dollar-sign for template-replacement
+        _tokens['$'+key] = _args[key] || '';
+    }
+
+    return _tokens;
+}
+
 /**
  * Replace tokens in a file.
  *
@@ -35,12 +70,12 @@ module.exports = new Extension({
  * @return {string} The string with tokens replaced.
  */
 function _replaceTokens(filePath, tokens) {
-    console.log(_replaceTokens, filePath, tokens);
+    debug(_replaceTokens, filePath, tokens);
 
     function replace(token, value) {
         // tokens start with a $ which needs to be escaped, oops
         var _token = '\\' + token,
-            // any '&' character needs to be escaped in the value, 
+            // any '&' character needs to be escaped in the value,
             //  otherwise it is used as a backreference
             _value = value.replace(/&/g, '\\&'),
             // use commas as delims so that we don't need to escape value, which might be a URL

install.sh

@@ -23,6 +23,7 @@ if [ $os == "Linux" ]; then
     # same for any debian disto (untested), including rpi (tested)
     sudo apt-get install chromium
     sudo apt-get install unclutter
+    sudo apt-get install matchbox-window-manager
 
     if [ $arq == "armv7l" ] || [ $arq == "armv6l" ]; then
         # on RaspberryPi or other arm 6/7 device

scripts/.xinitrc.tpl

@@ -5,5 +5,6 @@ xset -dpms
 xset s noblank
 
 unclutter -idle 0.1 &
+matchbox-window-manager -use_cursor no &
 
-exec /usr/bin/chromium --noerrdialogs --kiosk --incognito "$url"
+exec /usr/bin/chromium --noerrdialogs --kiosk --incognito $flags "$url"

test/.xinitrc.tpl

@@ -1 +1 @@
-exec /usr/bin/chromium --noerrdialogs --kiosk --incognito $url
+exec /usr/bin/chromium --noerrdialogs --kiosk --incognito $flags "$url"

test/extension.spec.js

@@ -11,10 +11,6 @@ describe('instantiation', function() {
 });
 
 describe('properties', function() {
-    after(function(done) {
-        exec('rm ' + __dirname + '/.xinitrc', done);
-    });
-
     it('should include all required format properties', function() {
         var format = WebsiteExtension.props.format;
 
@@ -37,29 +33,81 @@ describe('properties', function() {
         assert(format.end_command);
         assert(typeof format.end_command === 'string');
     });
+});
 
-    it('start_command should update .xinitrc file with supplied token', function(done) {
-        var format = WebsiteExtension.props.format,
-            command,
-            expected = 'exec /usr/bin/chromium --noerrdialogs --kiosk --incognito http://test.com';
+describe('start_command', function() {
+    var expectedDefault = 'exec /usr/bin/chromium --noerrdialogs --kiosk --incognito  "http://test.com"';
 
-        // use test .xinitrc
-        format.xinitrcTplPath = __dirname + '/.xinitrc.tpl';
-        format.xinitrcFinalPath = format.xinitrcTplPath.replace('.tpl', '');
+    after(function(done) {
+        exec('rm ' + __dirname + '/.xinitrc', done);
+    });
+
+    it('should update .xinitrc file with supplied token', function(done) {
+        var format = getTestFormat(),
+            command;
 
         // replace $url token with url string
         command = format.start_command({}, {
             $url: 'http://test.com'
         });
 
         assert(typeof command === 'string');
+        checkXinitrc(format.xinitrcFinalPath, expectedDefault, done);
+    });
+    it('should not accept undefined args parameter', function(done) {
+        var format = getTestFormat(),
+            command;
+
+        // replace $url token with url string
+        command = format.start_command(undefined, {
+            $url: 'http://test.com'
+        });
+
+        assert(typeof command === 'string');
+        checkXinitrc(format.xinitrcFinalPath, expectedDefault, done);
+    });
+    it('should update .xinitrc with optional args', function(done) {
+        var format = getTestFormat(),
+            command,
+            expected = 'exec /usr/bin/chromium --noerrdialogs --kiosk --incognito --allow-insecure-localhost "http://test.com"';
 
-        fs.readFile(format.xinitrcFinalPath, 'utf8', function(err, data) {
+        // replace $url token with url string
+        command = format.start_command({flags:'--allow-insecure-localhost'}, {
+            $url: 'http://test.com'
+        });
+
+        assert(typeof command === 'string');
+        checkXinitrc(format.xinitrcFinalPath, expected, done);
+    });
+    it('should ignore unsupported args', function(done) {
+        var format = getTestFormat(),
+            command;
+
+        // replace $url token with url string
+        command = format.start_command({random:'args'}, {
+            $url: 'http://test.com'
+        });
+
+        assert(typeof command === 'string');
+        checkXinitrc(format.xinitrcFinalPath, expectedDefault, done);
+    });
+
+    function checkXinitrc(path, expected, done) {
+        fs.readFile(path, 'utf8', function(err, data) {
             if (err) {
                 throw err;
             }
             assert.equal(data, expected);
             done();
         });
-    });
+    }
+    function getTestFormat() {
+        var format = WebsiteExtension.props.format;
+
+        // set test .xinitrc.tpl
+        format.xinitrcTplPath = __dirname + '/.xinitrc.tpl';
+        format.xinitrcFinalPath = format.xinitrcTplPath.replace('.tpl', '');
+
+        return format;
+    }
 });