abalone 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1de9af9802ec0b416470cec7b62a3cd7b3dfa053
-  data.tar.gz: ea85d95749bb862e9b3f1edd9e69fe4cc73781f7
+  metadata.gz: 565875b71d7b4f783f558c97f5e4f0b3695f7428
+  data.tar.gz: cb3a9ed9725aee44626bb591602355a3e95a65fc
 SHA512:
-  metadata.gz: d7d724d615b6e25db425b2d8aaaae18521053dce1c4bfbaee14b1fa6f7b26670ea603d6920e4408e15168103abd364bdd4c1b09c9a072e581bf422350bef5ce3
-  data.tar.gz: d3b76310ff77bb549dea12f1e333d8e390d19ef9e98faef383e8ae7cac3ba3b5400278dad667a7363435828adddd586b3aad5e85f7c001a257375a143084dc7a
+  metadata.gz: d31db1d05ed62bdfdfe4884c4e5e9e6e1b0bbf45ef837b3363af363d7cd9aea617ca0fd45b379d5afd9bbe4928d0452f8b2619d60e335c5cdfdb5dfe334455a7
+  data.tar.gz: 1100692ff4a162c5daa2800bdd077cc6d481e9792235b0101e24bc8670d0fccd5957df785689d83b39956608477c0ee367fc49ffda32a17309887ca86c625992

data/README.md

@@ -5,6 +5,8 @@ A simple Sinatra & hterm based web terminal.
 
 1. [Overview](#overview)
 1. [Configuration](#configuration)
+    1. [SSH](#configuring-ssh)
+    1. [Custom Login Command](#configuring-a-custom-command)
 1. [Limitations](#limitations)
 
 ## Overview
@@ -24,7 +26,22 @@ It supports three methods for providing a shell:
 
 Abalone defaults to loading configuration from `/etc/abalone/config.yaml`. You
 can pass the path to another config file at the command line. In that file, you
-can set one of `:command` or `:ssh`.
+can set several options:
+
+* `:port`
+  * Which port to run the server on.
+  * Default value: `9000`
+* `:bind`
+  * The hostname or IP address of the interface to listen on.
+  * Default value: `0.0.0.0` (listen to all interfaces.)
+* `:logfile`
+  * The path of a file to log to.
+  * Default value: Log only to `STDERR`. If you pass `-l` at the command line
+    with no filename, it will log to `/var/log/abalone`.
+* One of [`:command`](#configuring-a-custom-command) or [`:ssh`](#configuring-ssh), exclusive.
+  * The login method to use. Abalone can use `login`, SSH, or a custom command
+    to start a shell. See configuration instructions below.
+  * Default value: uses the `login` binary, with no configuration possible.
 
 ### Configuring SSH
 

data/bin/abalone

@@ -6,11 +6,10 @@ require 'abalone'
 require 'yaml'
 
 defaults = {
-  :port           => 9000,
-  :host           => '0.0.0.0',
-  :bind           => '0.0.0.0',
+  :port    => 9000,
+  :bind    => '0.0.0.0',
+  :logfile => $stderr,
 }
-logfile    = $stderr
 loglevel   = Logger::WARN
 configfile = '/etc/abalone/config.yaml'
 options    = {}
@@ -29,7 +28,7 @@ optparse = OptionParser.new { |opts|
     end
 
     opts.on("-l [LOGFILE]", "--logfile [LOGFILE]", "Path to logfile. Defaults to no logging, or /var/log/abalone if no filename is passed.") do |arg|
-        logfile = arg || '/var/log/abalone'
+        options[:logfile] = arg || defaults[:logfile] || '/var/log/abalone'
     end
 
     opts.on("-p PORT", "--port PORT", "Port to listen on. Defaults to 9000.") do |arg|
@@ -47,13 +46,13 @@ optparse = OptionParser.new { |opts|
 }
 optparse.parse!
 
-logger           = Logger.new(logfile)
-logger.level     = loglevel
-options[:logger] = logger
-
 config  = YAML.load_file(configfile) rescue {}
 options = defaults.merge(config.merge(options))
 
+logger           = Logger.new(options[:logfile])
+logger.level     = loglevel
+options[:logger] = logger
+
 if options[:params].class == Hash
   options[:params].each do |param, data|
     next if data.nil?
@@ -74,7 +73,7 @@ end
 raise 'Specify only one of a login command or SSH settings' if options.include? :command and options.include? :ssh
 
 if options.include? :command
-  raise ":params must be an Array or Hash, not #{options[:params].class}" unless [Array, Hash].include? options[:params].class
+  raise ":params must be an Array or Hash, not #{options[:params].class}" unless [Array, Hash, NilClass].include? options[:params].class
   raise ":command should be a String or an Array, not a #{options[:command].class}." unless [Array, String].include? options[:command].class
 end
 

data/lib/abalone.rb

@@ -9,8 +9,8 @@ require 'io/console'
 class Abalone < Sinatra::Base
   set :logging, true
   set :strict, true
-  set :public_folder, 'public'
-  set :views, 'views'
+  set :public_folder, "#{settings.root}/../public"
+  set :views, "#{settings.root}/../views"
 
   before {
     env["rack.logger"] = settings.logger if settings.logger
@@ -46,19 +46,26 @@ class Abalone < Sinatra::Base
           # there must be some form of event driven pty interaction, EM or some gem maybe?
           reader.sync = true
           @term = Thread.new do
+            carry = []
             loop do
               begin
                 PTY.check(@pid, true)
-                data = reader.read_nonblock(512) # we read non-blocking to stream data as quickly as we can
+                output = reader.read_nonblock(512).unpack('c*') # we read non-blocking to stream data as quickly as we can
+                index = output.rindex { |x| x < 128 } # find the last low bit
+                carry = output[index...-11]           # save the any remaining high bits and partial chars for next go-round
+                data  = (carry + output[0..index]).pack('c*').force_encoding('UTF-8') # and pack the rest back into a string to send
+
+                ws.send(data)
+
               rescue IO::WaitReadable
                 IO.select([reader])
                 retry
               rescue PTY::ChildExited => e
-                puts "Terminal has exited!"
-                ws.send({'event' => 'logout'}.to_json)
+                warn('Terminal has exited!')
+                ws.close_connection
+
                 Thread.exit
               end
-              ws.send({'event' => 'output', 'data' => data}.to_json)
               sleep(0.05)
             end
           end
@@ -66,7 +73,7 @@ class Abalone < Sinatra::Base
         end
 
         ws.onclose do
-          warn("websocket closed")
+          warn('websocket closed')
           stop_term()
         end
 
@@ -91,9 +98,10 @@ class Abalone < Sinatra::Base
               warn("Unrecognized message: #{message.inspect}")
             end
           rescue Errno::EIO => e
-            puts "Terminal has died!"
+            puts "Remote terminal closed."
             puts e.message
-            ws.send({'event' => 'logout'}.to_json)
+            stop_term()
+
           end
 
         end
@@ -108,7 +116,7 @@ class Abalone < Sinatra::Base
   helpers do
     def stop_term()
       Process.kill('TERM', @pid) rescue nil
-      @term.join
+      @term.join rescue nil
     end
 
     def sanitized(params)

data/public/index.html

@@ -36,7 +36,7 @@
       </style>
   </head>
 
-  <body onload="connect(boogers);">
+  <body onload="connect();">
       <div id="overlay"><input type="button" onclick="javascript:connect();" value="reconnect" /></div>
       <div id="terminal"></div>
   </body>

data/public/js/abalone.js

@@ -59,29 +59,11 @@ function disconnected() {
 }
 
 function messageHandler(data) {
-  message = JSON.parse(data);
-
-  switch(message['event']) {
-    case 'output':
-      if (!term) {
-          buf += message['data'];
-          return;
-      }
-      term.io.writeUTF16(message['data']);
-      break;
-
-    case 'logout':
-      console.log("user logout");
-      disconnected();
-      break;
-
-    case 'disconnect':
-      disconnected();
-      break;
-
-    default:
-
+  if (!term) {
+      buf += data;
+      return;
   }
+  term.io.writeUTF16(data);
 }
 
 /* borrowed from https://github.com/krishnasrinivas/wetty */

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abalone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra