build: Removed NW support in favor of Electron

This includes a simple script to make a release ready for packaging
under the directory `dist-electron`.

Author: andersevenrud

.gitignore

@@ -29,6 +29,7 @@ src/installer/installer.exe
 # Builds
 dist/*
 dist-dev/*
+dist-electron
 !dist-dev/vendor
 doc/jsdoc
 src/server/*.sqlite

Gruntfile.js

@@ -32,7 +32,6 @@ module.exports = function(grunt) {
 
   grunt.file.defaultEncoding = 'utf-8';
 
-  //grunt.loadNpmTasks('grunt-nw-builder');
   grunt.loadNpmTasks('grunt-eslint');
   grunt.loadNpmTasks('grunt-mocha-test');
   grunt.loadNpmTasks('grunt-mocha');
@@ -161,14 +160,6 @@ module.exports = function(grunt) {
           'src/packages/default/*/scheme.html'
         ]
       }
-    },
-    nwjs: {
-      options: {
-        version: '0.12.3',
-        platforms: ['win64', 'linux64'],
-        buildDir: '.nw'
-      },
-      src: ['src/templates/nw/package.json', '.standalone/**/*']
     }
   });
 };

bin/build-electron.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+#
+# Creates an 'electron' build ready for packaging
+#
+
+DIR=dist-electron
+DIST=${DIR}/dist-dev
+
+
+rm -rf ${DIR}
+mkdir -p ${DIST}
+
+# OS.js client
+node osjs build
+cp -r dist-dev/*.* ${DIST}
+cp -r src/client ${DIR}/dist-dev/client
+cp -r dist/themes ${DIR}/dist-dev/themes
+
+# Packages
+mkdir ${DIR}/packages-tmp
+for r in `find dist/packages/*/* -maxdepth 1 -type d -prune`; do
+  pn=`basename $r`
+  rn=`basename $(dirname ${r})`
+  mkdir -p ${DIR}/packages-tmp/${rn}
+  cp -r src/packages/${rn}/${pn} ${DIR}/packages-tmp/${rn}/${pn}
+done
+
+rm -rf ${DIR}/dist-dev/packages
+mv ${DIR}/packages-tmp ${DIR}/dist-dev/packages
+
+# Electron base
+cp -r src/templates/electron/*.* ${DIR}/
+
+# OS.js server and dependencies
+cp src/server/*.json ${DIR}/
+(cd ${DIR}; npm install)
+cp -r src/server/node ${DIR}/node_modules/osjs
+
+# Misc
+cp -r dist/vendor ${DIR}/dist-dev/vendor
+mkdir -p ${DIR}/vfs/home/demo

src/build/core.js

@@ -79,12 +79,10 @@ function readScript(target, verbose, compress, list) {
     }
 
     var data = compress ? _ugly.minify(path, {comments: false}).code : _fs.readFileSync(path).toString();
-    if ( target !== 'nw' ) {
-      data = data.replace(/\/\*\![\s\S]*?\*\//, '')
-        .replace(/console\.(log|debug|info|group|groupStart|groupEnd|count)\((.*)\);/g, '')
-        .replace(/(?:\/\*(?:[\s\S]*?)\*\/)|(?:^\s*\/\/(?:.*)$)/gm, '')
-        .replace(/^\s*[\r\n]/gm, '');
-    }
+    data = data.replace(/\/\*\![\s\S]*?\*\//, '')
+      .replace(/console\.(log|debug|info|group|groupStart|groupEnd|count)\((.*)\);/g, '')
+      .replace(/(?:\/\*(?:[\s\S]*?)\*\/)|(?:^\s*\/\/(?:.*)$)/gm, '')
+      .replace(/^\s*[\r\n]/gm, '');
 
     return data;
   }).join('\n');
@@ -107,12 +105,11 @@ function readStyle(target, verbose, compress, list) {
       data = new Cleancss().minify(data).styles;
     }
 
-    if ( target !== 'nw' ) {
-      data = data.replace(/\/\*\![\s\S]*?\*\//, '')
-        .replace('@charset "UTF-8";', '')
-        .replace(/(?:\/\*(?:[\s\S]*?)\*\/)|(?:^\s*\/\/(?:.*)$)/gm, '')
-        .replace(/^\s*[\r\n]/gm, '');
-    }
+    data = data.replace(/\/\*\![\s\S]*?\*\//, '')
+      .replace('@charset "UTF-8";', '')
+      .replace(/(?:\/\*(?:[\s\S]*?)\*\/)|(?:^\s*\/\/(?:.*)$)/gm, '')
+      .replace(/^\s*[\r\n]/gm, '');
+
     return data;
   }).join('\n');
 }
@@ -189,48 +186,6 @@ function getBuildFiles(opts) {
   };
 }
 
-/*
- * Build NW files
- */
-function buildNW() {
-  return new Promise(function(resolve) {
-    const dest = _path.join(ROOT, 'dist');
-
-    _fs.mkdirSync(_path.join(dest, 'vfs'));
-    _fs.mkdirSync(_path.join(dest, 'vfs', 'home'));
-    _fs.mkdirSync(_path.join(dest, 'vfs', 'home', 'demo'));
-
-    _fs.copySync(
-      _path.join(ROOT, 'README.md'),
-      _path.join(dest, 'vfs', 'home', 'demo', 'README.md')
-    );
-    _fs.copySync(
-      _path.join(ROOT, 'src', 'templates', 'nw', 'package.json'),
-      _path.join(dest, 'package.json')
-    );
-    _fs.copySync(
-      _path.join(ROOT, 'src', 'server', 'packages.json'),
-      _path.join(dest, 'packages.json')
-    );
-
-    // Install dependencies
-    _fs.copySync(
-      _path.join(ROOT, 'src', 'server', 'node'),
-      _path.join(dest, 'node_modules', 'osjs')
-    );
-    _fs.copySync(
-      _path.join(ROOT, 'src', 'templates', 'nw', 'index.js'),
-      _path.join(dest, 'node_modules', 'osjs', 'index.js')
-    );
-
-    const cmd = 'cd "' + dest + '" && npm install';
-    require('child_process').exec(cmd, function(err, stdout, stderr) {
-      console.log(stderr, stdout);
-      resolve();
-    });
-  });
-}
-
 /*
  * File adder wrapper
  */
@@ -364,11 +319,7 @@ const TARGETS = {
           _utils.createStandaloneScheme(src, '/dialogs.html', _path.join(ROOT, 'dist', '_dialogs.js'));
         }
 
-        if ( cli.option('nw') ) {
-          buildNW().then(resolve).catch(reject);
-        } else {
-          resolve();
-        }
+        resolve();
       });
     }
 

src/client/javascript/core/connection.js

@@ -267,8 +267,10 @@
 
     if ( this.offline ) {
       cbError('You are currently off-line and cannot perform this operation!');
+      return;
     } else if ( (API.getConfig('Connection.Type') === 'standalone') ) {
       cbError('You are currently running locally and cannot perform this operation!');
+      return;
     }
 
     if ( method.match(/^FS:/) ) {

src/conf/500-build.json

@@ -55,7 +55,6 @@
       "src/client/javascript/core/search-engine.js",
       "src/client/javascript/core/connections/http.js",
       "src/client/javascript/core/connections/ws.js",
-      "src/client/javascript/core/connections/nw.js",
       "src/client/javascript/core/auth/demo.js",
       "src/client/javascript/core/auth/database.js",
       "src/client/javascript/core/auth/pam.js",

src/server/node/core/instance.js

@@ -106,6 +106,16 @@ const ENV = {
  * Loads generated configuration file
  */
 function loadConfiguration(opts) {
+  Object.keys(opts).forEach(function(k) {
+    if ( typeof ENV[k] !== 'undefined' && typeof opts[k] !== 'undefined' ) {
+      ENV[k] = opts[k];
+    }
+  });
+
+  if ( opts.ROOT ) {
+    ENV.ROOTDIR = opts.ROOT;
+  }
+
   const path = _path.join(ENV.SERVERDIR, 'settings.json');
 
   function _load(resolve, reject) {
@@ -121,23 +131,13 @@ function loadConfiguration(opts) {
         ENV.PORT = config.http.port;
       }
 
-      Object.keys(opts).forEach(function(k) {
-        if ( typeof ENV[k] !== 'undefined' && typeof opts[k] !== 'undefined' ) {
-          ENV[k] = opts[k];
-        }
-      });
-
-      if ( opts.ROOT ) {
-        ENV.ROOTDIR = opts.ROOT;
-      }
-
       if ( typeof opts.LOGLEVEL === 'number' ) {
         ENV.LOGLEVEL = opts.LOGLEVEL;
       } else if ( typeof config.logging === 'number' ) {
         ENV.LOGLEVEL = config.logging;
       }
 
-      ENV.PKGDIR = _path.join(ENV.ROOTDIR, 'src/packages');
+      ENV.PKGDIR = opts.PKGDIR || _path.join(ENV.ROOTDIR, 'src/packages');
       LOGGER = _osjs.logger.create(ENV.LOGLEVEL);
 
       Object.keys(config.proxies).forEach(function(k) {

src/client/javascript/core/connections/nw.js renamed to src/templates/electron/main.js

@@ -13,7 +13,7 @@
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
  *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
@@ -27,52 +27,69 @@
  * @author  Anders Evenrud <[email protected]>
  * @licence Simplified BSD License
  */
+'use strict';
 
-(function(API, Utils, Connection) {
-  'use strict';
+const electron = require('electron');
+const app = electron.app
+const BrowserWindow = electron.BrowserWindow;
+const path = require('path');
+const url = require('url');
+const osjs = require('osjs/core/instance');
 
-  function NWConnection() {
-    Connection.apply(this, arguments);
-    this.nw = require('osjs');
-  }
-
-  NWConnection.prototype = Object.create(Connection.prototype);
-  NWConnection.constructor = Connection;
+let mainWindow;
 
-  NWConnection.prototype.init = function(callback) {
-    /* TODO
-    this.nw.init({
-      root: process.cwd()
-    }, callback);
-    */
+function createServer() {
+  if ( app.server ) {
+    return Promise.resolve();
+  }
 
-    callback('Sorry, but this is not working at the moment');
+  const opts = {
+    DIST: 'dist-dev',
+    ROOT: __dirname,
+    PKGDIR: path.join(__dirname, 'dist-dev', 'packages'),
+    SERVERDIR: __dirname,
+    PORT: 8000,
+    //LOGLEVEL: 15,
+    AUTH: 'demo',
+    STORAGE: 'demo'
   };
 
-  NWConnection.prototype.destroy = function() {
-    this.nw = null;
-    return Connection.prototype.destroy.apply(this, arguments);
-  };
+  return new Promise(function(resolve, reject) {
+    osjs.init(opts).then(function() {
+      resolve(osjs.run());
+    }).catch(reject);
+  });
+}
 
-  NWConnection.prototype._request = function(isVfs, method, args, options, onsuccess, onerror) {
-    onerror = onerror || function() {
-      console.warn('NWConnection::request()', 'error', arguments);
-    };
+function createWindow() {
+  createServer().then(function() {
+    mainWindow = new BrowserWindow({
+      width: 800,
+      height: 600
+    });
 
-    var res = Connection.prototype._request.apply(this, arguments);
-    if ( res !== false ) {
-      return res;
-    }
+    mainWindow.loadURL('http://localhost:8000');
 
-    onerror('Sorry, but this is not working at the moment');
-    return false;
-  };
+    //mainWindow.webContents.openDevTools();
+
+    mainWindow.on('closed', function() {
+      mainWindow = null
+    })
+  }).catch(function(err) {
+    alert(err);
+  });
+}
 
-  /////////////////////////////////////////////////////////////////////////////
-  // EXPORTS
-  /////////////////////////////////////////////////////////////////////////////
+app.on('ready', createWindow)
 
-  OSjs.Connections = OSjs.Connections || {};
-  OSjs.Connections.nw = NWConnection;
+app.on('window-all-closed', function() {
+  if ( process.platform !== 'darwin' ) {
+    app.quit();
+  }
+})
 
-})(OSjs.API, OSjs.Utils, OSjs.Core.Connection);
+app.on('activate', function() {
+  if ( mainWindow === null ) {
+    createWindow();
+  }
+})

src/templates/electron/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "osjs-electron",
+  "version": "1.0.0",
+  "description": "A basic OS.js Electron implementation",
+  "main": "main.js",
+  "scripts": {
+    "start": "electron ."
+  },
+  "keywords": [
+    "OS.js",
+    "Electron"
+  ],
+  "author": "Anders Evenrud <[email protected]>",
+  "devDependencies": {
+    "electron": "^1.4.1"
+  }
+}

src/templates/electron/renderer.js

@@ -0,0 +1,3 @@
+// This file is required by the index.html file and will
+// be executed in the renderer process for that window.
+// All of the Node.js APIs are available in this process.