Merge pull request #4 from OpenframeProject/xinit-settings

Xinit settings

Author: jmwohl

.gitignore

@@ -4,4 +4,6 @@ log/*
 artwork/
 npm-debug.log
 coverage/*
-player/*
+player/*
+.xinitrc
+!.xinitrc.tpl

extension.js

@@ -1,5 +1,6 @@
 var pjson = require('./package.json'),
-    Extension = require('openframe-extension');
+    Extension = require('openframe-extension'),
+    execSync = require('child_process').execSync;
 
 /**
  * Extensions should expose an instance of the Extension class.
@@ -13,7 +14,54 @@ module.exports = new Extension({
         // this is what might get displayed to users (not currently used)
         'display_name': 'Website',
         'download': false,
-        'start_command': 'xinit /usr/bin/chromium --kiosk $url',
-        'end_command': 'sudo pkill -f chromium'
-    }
+        '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
+            return 'xinit ' + filePath;
+        },
+        'end_command': 'pkill -f X',
+        xinitrcTplPath: __dirname + '/scripts/.xinitrc.tpl'
+    },
 });
+
+/**
+ * Replace tokens in a file.
+ *
+ * @param  {string} _str
+ * @param  {object} tokens
+ * @return {string} The string with tokens replaced.
+ */
+function _replaceTokens(filePath, tokens) {
+    console.log(_replaceTokens, filePath, tokens);
+
+    function replace(token, value) {
+        // tokens start with a $ which needs to be escaped, oops
+        var _token = '\\' + token,
+            // use commas as delims so that we don't need to escape value, which might be a URL
+            cmd = 'sed -i "s,' + _token + ',' + value + ',g" ' + filePath;
+        execSync(cmd);
+    }
+
+    var key;
+    for (key in tokens) {
+        // TODO: better token replacement (global replacement?
+        replace(key, tokens[key]);
+    }
+}
+
+/**
+ * Clone xinitrc
+ *
+ * @return {string} The string with tokens replaced.
+ */
+function _cloneTemplate(filePath) {
+    var newFilePath = filePath.replace('.tpl', ''),
+        cmd = 'cp -f ' + filePath + ' ' + newFilePath;
+
+    execSync(cmd);
+
+    return newFilePath;
+}

install.sh

@@ -23,8 +23,8 @@ if [ $os == "Linux" ]; then
     # same for any debian disto (untested), including rpi (tested)
     sudo apt-get install chromium
 
-    if [ $arq == "armv7l" ]; then
-        # on RaspberryPi
+    if [ $arq == "armv7l" ] || [ $arq == "armv6l" ]; then
+        # on RaspberryPi or other arm 6/7 device
 
         # ####
         #
@@ -62,12 +62,10 @@ if [ $os == "Linux" ]; then
         fi
 
         # TODO: update chromium window_placement settings
-        echo "armv7l"
 
 
     else
-        # Non-arm7 Debian...
-        echo "non armv7l"
+        # Non-arm Debian...
     fi
 
 elif [ $os == "Darwin" ]; then

package.json

@@ -38,7 +38,7 @@
   "license": "GPL-3.0",
   "devDependencies": {
     "coveralls": "^2.11.9",
-    "eslint": "^2.8.0",
+    "eslint": "^2.9.0",
     "istanbul": "^0.4.2",
     "mocha": "^2.3.4",
     "sinon": "^1.17.2"

scripts/.end_command

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# cleanup chromium in case it dies unexpectedly
+sed -i 's/"exited_cleanly": false/"exited_cleanly": true/' ~/.config/chromium/Default/Preferences

scripts/.xinitrc.tpl

@@ -0,0 +1,7 @@
+xscreensaver -no-splash
+
+xset s off
+xset -dpms
+xset s noblank
+
+exec /usr/bin/chromium --noerrdialogs --kiosk --incognito $url

test/.xinitrc.tpl

@@ -0,0 +1 @@
+exec /usr/bin/chromium --noerrdialogs --kiosk --incognito $url

test/extension.spec.js

@@ -1,4 +1,6 @@
 var assert = require('assert'),
+    exec = require('child_process').exec,
+    fs = require('fs'),
     Extension = require('openframe-extension'),
     WebsiteExtension = require('../extension');
 
@@ -9,6 +11,10 @@ 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;
 
@@ -31,4 +37,29 @@ 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';
+
+        // use test .xinitrc
+        format.xinitrcTplPath = __dirname + '/.xinitrc.tpl';
+        format.xinitrcFinalPath = format.xinitrcTplPath.replace('.tpl', '');
+
+        // replace $url token with url string
+        command = format.start_command({}, {
+            $url: 'http://test.com'
+        });
+
+        assert(typeof command === 'string');
+
+        fs.readFile(format.xinitrcFinalPath, 'utf8', function(err, data) {
+            if (err) {
+                throw err;
+            }
+            assert.equal(data, expected);
+            done();
+        });
+    });
 });