From 4eba7612bc06f3ebd6745ec08014235c2f13d8e9 Mon Sep 17 00:00:00 2001
From: Darren <darren@darrenwhitlen.com>
Date: Sat, 17 Aug 2013 19:55:28 +0100
Subject: [PATCH] Standardised server control interface

---
 server/controlinterface.js | 157 +++++++++++++++++++++++++++++++++++++
 server/kiwi.js             |  64 +--------------
 server_modules/control.js  | 111 +++++---------------------
 3 files changed, 178 insertions(+), 154 deletions(-)
 create mode 100644 server/controlinterface.js

diff --git a/server/controlinterface.js b/server/controlinterface.js
new file mode 100644
index 0000000..2d0a88a
--- /dev/null
+++ b/server/controlinterface.js
@@ -0,0 +1,157 @@
+var _           = require('lodash'),
+    rehash      = require('./rehash.js'),
+    config      = require('../server/configuration.js'),
+    kiwiModules = require('../server/modules');
+
+
+
+var ControlInterface = module.exports = function(stream_in, stream_out, opts) {
+    stream_out = stream_out || stream_in;
+    this.stream_out = stream_out;
+    this.stream_in = stream_in;
+
+    opts = opts || {};
+    this.prompt = (typeof opts.prompt === 'string') ?
+        opts.prompt :
+        'Kiwi > ';
+
+    this._custom_commands = {};
+
+    this._onData = this.onData.bind(this);
+    stream_in.on('data', this._onData);
+
+    this.displayPrompt();
+};
+
+
+
+ControlInterface.prototype.dispose = function() {
+    this.stream_in.removeListener('data', this._onData);
+    this.stream_in = null;
+    this.stream_out = null;
+};
+
+
+
+ControlInterface.prototype.write = function(data, append) {
+    if (typeof append === 'undefined') append = '\n';
+    try {
+        this.stream_out.write(data + append);
+    } catch(err){}
+};
+
+
+
+ControlInterface.prototype.displayPrompt = function(prompt) {
+    prompt = prompt || this.prompt;
+    this.write(prompt, '');
+};
+
+
+
+ControlInterface.prototype.onData = function(buffered) {
+    var data = buffered.toString().trim(),
+        data_parts = data.split(' '),
+        cmd = data_parts[0] || null;
+
+    if (typeof this._custom_commands[cmd] === 'function') {
+        this._custom_commands[cmd].call(this, data_parts.slice(1), data);
+
+    } else if (typeof commands[cmd] === 'function') {
+        commands[cmd].call(this, data_parts.slice(1), data);
+
+    } else {
+        this.write('Unrecognised command: ' + cmd);
+    }
+
+    this.displayPrompt();
+};
+
+
+
+ControlInterface.prototype.addCommand = function(command, fn) {
+    this._custom_commands[command] = fn;
+};
+
+
+
+var commands = {};
+commands.stats = function(args, raw) {
+    this.write('Connected clients: ' + _.size(global.clients.clients).toString());
+    this.write('Num. remote hosts: ' + _.size(global.clients.addresses).toString());
+};
+
+
+commands.reconfig = function(args, raw) {
+    if (config.loadConfig()) {
+        console.log('New config file loaded');
+    } else {
+        console.log("No new config file was loaded");
+    }
+};
+
+
+commands.rehash = function(args, raw) {
+    rehash.rehashAll();
+    console.log('Rehashed');
+};
+
+
+commands.jumpserver = function(args, raw) {
+    var num_clients = _.size(global.clients.clients),
+        packet = {}, args_idx;
+
+    if (num_clients === 0) {
+        console.log('No connected clients');
+        return;
+    }
+
+    // For each word in the line minus the last, add it to the packet
+    for(args_idx=0; args_idx<args.length-1; args_idx++){
+        packet[args[args_idx]] = true;
+    }
+
+    packet.kiwi_server = args[args_idx];
+
+    console.log('Broadcasting jumpserver to ' + num_clients.toString() + ' clients..');
+    global.clients.broadcastKiwiCommand('jumpserver', packet, function() {
+        console.log('Broadcast complete.');
+    });
+};
+
+
+commands.module = function(args, raw) {
+    switch(args[0]) {
+        case 'reload':
+            if (!args[1]) {
+                this.write('A module name must be specified');
+                return;
+            }
+
+            if (!kiwiModules.unload(args[1])) {
+                this.write('Module ' + (args[1] || '') + ' is not loaded');
+                return;
+            }
+
+            if (!kiwiModules.load(args[1])) {
+                this.write('Error loading module ' + (args[1] || ''));
+            }
+            this.write('Module ' + args[1] + ' reloaded');
+
+            break;
+
+        case 'list':
+        case 'ls':
+        default:
+            var module_names = [];
+            kiwiModules.getRegisteredModules().forEach(function(module) {
+                module_names.push(module.module_name);
+            });
+            this.write('Loaded modules: ' + module_names.join(', '));
+    }
+};
+
+
+commands.hello = function(args, raw) {
+    this.write('Hello, beautiful :)');
+};
diff --git a/server/kiwi.js b/server/kiwi.js
index baf8124..0255e1a 100755
--- a/server/kiwi.js
+++ b/server/kiwi.js
@@ -3,9 +3,9 @@ var fs          = require('fs'),
     util        = require('util'),
     WebListener = require('./weblistener.js'),
     config      = require('./configuration.js'),
-    rehash      = require('./rehash.js'),
     modules     = require('./modules.js'),
-    Identd      = require('./identd.js');
+    Identd      = require('./identd.js'),
+    ControlInterface = require('./controlinterface.js');
 
 
 
@@ -306,63 +306,5 @@ process.on('SIGUSR2', function() {
 /*
  * Listen for runtime commands
  */
-
 process.stdin.resume();
-process.stdin.on('data', function (buffered) {
-    var data = buffered.toString().trim(),
-        data_parts = data.split(' '),
-        cmd = data_parts[0] || null;
-
-    switch (cmd) {
-        case 'stats':
-            console.log('Connected clients: ' + _.size(global.clients.clients).toString());
-            console.log('Num. remote hosts: ' + _.size(global.clients.addresses).toString());
-            break;
-
-        case 'reconfig':
-            if (config.loadConfig()) {
-                console.log('New config file loaded');
-            } else {
-                console.log("No new config file was loaded");
-            }
-
-            break;
-
-
-        case 'rehash':
-            (function () {
-                rehash.rehashAll();
-                console.log('Rehashed');
-            })();
-
-            break;
-
-        case 'jumpserver':
-            (function() {
-                var num_clients = _.size(global.clients.clients),
-                    packet = {}, parts_idx;
-
-                if (num_clients === 0) {
-                    console.log('No connected clients');
-                    return;
-                }
-
-                // For each word in the line minus the last, add it to the packet
-                for(parts_idx=1; parts_idx<data_parts.length-1; parts_idx++){
-                    packet[data_parts[parts_idx]] = true;
-                }
-
-                packet.kiwi_server = data_parts[parts_idx];
-
-                console.log('Broadcasting jumpserver to ' + num_clients.toString() + ' clients..');
-                global.clients.broadcastKiwiCommand('jumpserver', packet, function() {
-                    console.log('Broadcast complete.');
-                });
-            })();
-
-            break;
-
-        default:
-            console.log('Unrecognised command: ' + data);
-    }
-});
+new ControlInterface(process.stdin, process.stdout, {prompt: ''});
diff --git a/server_modules/control.js b/server_modules/control.js
index bbe4254..83e562f 100644
--- a/server_modules/control.js
+++ b/server_modules/control.js
@@ -4,11 +4,10 @@
  * Listens on localhost:8888 by default
  */
 
-var net         = require('net'),
-    kiwiModules = require('../server/modules'),
-    rehash      = require('../server/rehash.js'),
-    config      = require('../server/configuration.js'),
-    _           = require('lodash');
+var net                = require('net'),
+    kiwiModules        = require('../server/modules'),
+    ControlInterface   = require('../server/controlinterface.js'),
+    _                  = require('lodash');
 
 var control_module = new kiwiModules.Module('Control');
 
@@ -17,6 +16,8 @@ var control_module = new kiwiModules.Module('Control');
  * The socket client
  */
 function SocketClient (socket) {
+    var that = this;
+
     this.socket = socket;
     this.socket_closing = false;
 
@@ -26,59 +27,33 @@ function SocketClient (socket) {
     this.bindEvents();
 
     socket.write("\nHello, you are connected to the Kiwi server :)\n\n");
-    this.displayPrompt();
+
+    this.control_interface = new ControlInterface(socket);
+    _.each(socket_commands, function(fn, command_name) {
+        console.log('adding command', command_name);
+        that.control_interface.addCommand(command_name, fn.bind(that));
+    });
 }
 
 SocketClient.prototype.bindEvents = function() {
     var that = this;
 
-    this.socket.on('data', function() { that.onData.apply(that, arguments); });
     this.socket.on('close', function() { that.onClose.apply(that, arguments); });
 };
-SocketClient.prototype.unbindEvents = function() {
-    this.socket.removeAllListeners();
-};
-
-
-
-SocketClient.prototype.write = function(data, append) {
-    if (typeof append === 'undefined') append = '\n';
-    if (this.socket && !this.socket_closing)
-        this.socket.write(data + append);
-};
-SocketClient.prototype.displayPrompt = function(prompt) {
-    prompt = prompt || 'Kiwi > ';
-    this.write(prompt, '');
-};
-
-
-
-SocketClient.prototype.onData = function(data) {
-    data = data.toString().trim();
-
-
 
-    try {
-        var data_split = data.split(' ');
 
-        if (typeof socket_commands[data_split[0]] === 'function') {
-            socket_commands[data_split[0]].call(this, data_split.slice(1));
-        } else {
-            this.write('Unrecognised command: ' + data);
-        }
-
-    } catch (err) {
-        console.log('[Control error] ' + err);
-        this.write('An error occured. Check the Kiwi server log for more details');
-    }
-
-    this.displayPrompt();
+SocketClient.prototype.unbindEvents = function() {
+    this.socket.removeAllListeners();
 };
 
 
 SocketClient.prototype.onClose = function() {
+    this.control_interface.dispose();
+    this.control_interface = null;
+
     this.unbindEvents();
     this.socket = null;
+
     console.log('Control connection from ' + this.remoteAddress + ' closed');
 };
 
@@ -89,56 +64,6 @@ SocketClient.prototype.onClose = function() {
  * Each function is run in context of the SocketClient
  */
 var socket_commands = {
-    module: function(data) {
-        switch(data[0]) {
-            case 'reload':
-                if (!data[1]) {
-                    this.write('A module name must be specified');
-                    return;
-                }
-
-                if (!kiwiModules.unload(data[1])) {
-                    this.write('Module ' + (data[1] || '') + ' is not loaded');
-                    return;
-                }
-
-                if (!kiwiModules.load(data[1])) {
-                    this.write('Error loading module ' + (data[1] || ''));
-                }
-                this.write('Module ' + data[1] + ' reloaded');
-
-                break;
-
-            case 'list':
-            case 'ls':
-            default:
-                var module_names = [];
-                kiwiModules.getRegisteredModules().forEach(function(module) {
-                    module_names.push(module.module_name);
-                });
-                this.write('Loaded modules: ' + module_names.join(', '));
-        }
-
-    },
-
-    stats: function(data) {
-        this.write('Connected clients: ' + _.size(global.clients.clients).toString());
-        this.write('Num. remote hosts: ' + _.size(global.clients.addresses).toString());
-    },
-
-    rehash: function(data) {
-        rehash.rehashAll();
-        this.write('Rehashed');
-    },
-
-    reconfig: function(data) {
-        if (config.loadConfig()) {
-            this.write('New config file loaded');
-        } else {
-            this.write("No new config file was loaded");
-        }
-    },
-
     quit: function(data) {
         this.socket.destroy();
         this.socket_closing = true;
-- 
2.25.1