easel-dashboard 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b20ce9712ac3e87e83e527b03665b9c64a9b707f571cfcbbd1c0989df494e8
-  data.tar.gz: bebb6eeafa225d2a05401fea5f8f8ec7e63674de617a811ec8b6cb2cf7a56640
+  metadata.gz: 1bb0d5d2b352f523eaea5641d64b835153d8fe24e2fea68fc493636c207cc25b
+  data.tar.gz: 378c2dad0c4ad34d39b908d49b5a32ff779c7a7c26ffc4acc886226b58fb9c51
 SHA512:
-  metadata.gz: c50fd692b5fcd3826cc6b3ac80aa400e1319501303f951b576c9c4ada4fe43990a383ed7f84e70d2808363a77dd04e1f07e6b0a2218608309bbed2681a42382b
-  data.tar.gz: d1353d563bf9b9306ebbf5bb69e7a4b401558b4be77010320b7b734808e74124bdbfaecd12890a61a400a2432ee5d16536c909fa9c4c6f2d13885a488465f788
+  metadata.gz: df5b92218548203a7268852978a8238a26709506ee3f7eaf8c7345b6baab6b47b4bdbf786797a04b09815fc70386cf86b46ae9dc6efdda44d1038591efb33521
+  data.tar.gz: d2baa673d372e3e86e38635a425c757698e1ca76eb69822725d78ccea2749cd3ffaef804e2331765239797057a127e10b48efe416d2d38cf7ee6e772c40cd1b6

data/bin/easel

@@ -1,3 +1,3 @@
-#!/usr/bin/env ruby
+#!/bin/env ruby
 require 'easel'
 launch

data/lib/easel/build_pages.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 
@@ -8,6 +8,7 @@ require 'erb'
 # Key Variables
 @code_names = {
   200 => "OK",
+  400 => "Bad Request",
   404 => "Not Found",
   405 => "Forbidden",
   418 => "I'm a teapot",

data/lib/easel/configuration.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 #
@@ -68,23 +68,23 @@ $config = {
               regex: ", (\\d+.\\d+)\\n"
             }
           ]
-        },
-        {
-          name: "Memory",
-          type: "time-series",  # uses Time.now.strftime("%H:%M") as x asix.
-          data: [
-            {
-              cmd:   "free",
-              name:  "Total Memory",
-              regex: "Mem:\\W+(\\d+)"
-            },
-            {
-              cmd:   "free",
-              name:  "Free Memory",
-              regex: "Mem:\\W+\\d+\\W+(\\d+)"
-            }
-          ]
-        }
+        }#,
+        # {
+        #   name: "Memory",
+        #   type: "time-series",  # uses Time.now.strftime("%H:%M") as x asix.
+        #   data: [
+        #     {
+        #       cmd:   "free",
+        #       name:  "Total Memory",
+        #       regex: "Mem:\\W+(\\d+)"
+        #     },
+        #     {
+        #       cmd:   "free",
+        #       name:  "Free Memory",
+        #       regex: "Mem:\\W+\\d+\\W+(\\d+)"
+        #     }
+        #   ]
+        # }
       ]
     }
   ]

data/lib/easel/controller.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 

data/lib/easel/data_gathering.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 #

data/lib/easel/logging.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 #

data/lib/easel/server.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 #
@@ -37,6 +37,7 @@ def launch_server
     log_info "Interrupt received, server shutting down..."
   rescue Exception => e
     log_error "Unexpected error occured and closed client connection. Error: #{e}"
+    e.backtrace.each { |trace| log_error "#{trace}" }
   end
 end
 
@@ -46,32 +47,46 @@ def handle_request socket
   log_info "Receieved request: #{socket}"
   request = read_HTTP_message socket
 
-  # TODO: check what the minimum allow handling is. I think there's one more method I need to handle.
+  if request.nil?
+    socket.print build_error 400
+    socket.close
+    return
+  end
+
   case request[:method]
   when "GET"
-    # TODO: respond with app, css file, favicon, or 404 error.
     if request[:fields][:Upgrade] == "websocket\r\n"
       run_websocket(socket, request)
     else
         handle_get(socket, request)
     end
-  #when "HEAD"
-    # TODO: Deal with HEAD request. https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.4
+  when "HEAD"
+    if request[:fields][:Upgrade] == "websocket\r\n"
+    else
+      read_end, write_end = IO.pipe
+      handle_get(write_end, request)
+      msg = ""
+      loop do
+        msg += read_end.readline
+        if msg.include? "\r\n\r\n"
+          socket.print msg
+          socket.close
+          break
+        elsif read_end.readline.nil?
+          socket.print build_error 500
+          socket.close
+          break
+        end
+      end
+    end
   else
-    # TODO: respond with an appropriate error.
-    socket.print "HTTP/1.1 200 OK\r\n" +
-                 "Content-Type: text/plain\r\n" +
-                 "Content-Length: #{response.bytesize}\r\n" +
-                 "Connection: close\r\n" +
-                 "\r\n" +
-                 response
+    puts "THIS SHOULD NOT OCCUREEEEEE"
+    socket.print build_error 400
     socket.close
   end
 
 end
 
-
-
 # handle_get
 #
 # Handle a get request.
@@ -80,28 +95,28 @@ def handle_get(socket, request)
   case request[:url]
   when "/", "/index.html"
     socket.print build_app
-    socket.close
-  when "/test.html" # TODO: Remove this!
-    socket.print return_html "test.html"
-    socket.close
+    socket.close unless request[:Connection].is_a? String and request[:Connection].downcase == "keep-alive\r\n"
   when "/app.css"
     socket.print build_css
-    socket.close
+    socket.close unless request[:Connection].is_a? String and request[:Connection].downcase == "keep-alive\r\n"
   when "/controller.js"
     log_info "building controller"
     socket.print build_js
-    socket.close
+    socket.close unless request[:Connection].is_a? String and request[:Connection].downcase == "keep-alive\r\n"
   when "/dashboardElements.js"
     socket.print return_js 'dashboardElements.js'
-    socket.close
+    socket.close unless request[:Connection].is_a? String and request[:Connection].downcase == "keep-alive\r\n"
   when "/createComponents.js"
     socket.print return_js 'createComponents.js'
-    socket.close
+    socket.close unless request[:Connection].is_a? String and request[:Connection].downcase == "keep-alive\r\n"
+  # TODO: respond with favicon
   else
     socket.print build_error 404
-    socket.close
+    socket.close unless request[:Connection].is_a? String and request[:Connection].downcase == "keep-alive\r\n"
   end
 
+  log_info "Handled HTTP request: #{request}"
+
 end
 
 
@@ -110,8 +125,13 @@ end
 # Read an HTTP message from the socket, and parse it into a request Hash.
 def read_HTTP_message socket
   message = []
+  first_line = true
   loop do
     line = socket.gets
+    if first_line
+      return nil if line.nil? or not line.match(/^(GET|HEAD|POST|PUT|DELETE|OPTIONS|TRACE) .+ HTTP.+/)
+      first_line = false
+    end
     message << line
     if line == "\r\n"
       break

data/lib/easel/websocket.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/bin/env ruby
 #
 # Author: Eric Power
 #
@@ -69,6 +69,8 @@ require_relative 'data_gathering'
 
 # Key Variables
 MAX_WS_FRAME_SIZE = 50.0  # Must be a float number to allow a non-truncated division result.
+# TODO: change to 127.0
+
 
 # run_websocket
 #
@@ -76,44 +78,63 @@ MAX_WS_FRAME_SIZE = 50.0  # Must be a float number to allow a non-truncated divi
 def run_websocket(socket, initial_request)
 
   accept_connection(socket, initial_request[:fields][:Sec_WebSocket_Key][0..-3])
+  log_info "Accepted WebSocket Connection"
   child_threads = {}
   send_msg_mutex = Mutex.new # One mutex per websocket to control sending messages.
 
+
   Thread.new {  # Periodically update the generic dashboard if set.
     loop do
-      data = read_data
-      send_msg(socket, send_msg_mutex, nil, "DASH", data)
+      #begin
+        data = read_data
+        send_msg(socket, send_msg_mutex, nil, "DASH", data)
+      #rescue Errno::EPIPE
+      #  log_info "Pipe closed erorr while sending periodic data to client"
+      #  break
+      #end
       sleep $config[:collect_data_period]
     end
   } unless $config[:collect_data_period] == 0
 
-  loop {
-    msg = receive_msg socket
-    break if msg.nil? # The socket was closed by the client.
+  begin
+    loop {
+      begin
+        msg = receive_msg socket
+      rescue Errno::ECONNRESET => e
+        log_error "Client reset the connection"
+        socket.close
+        msg = nil
+      end
+      break if msg.nil? # The socket was closed by the client.
 
-    case msg.split(":")[0]
-    when "RUN"
-      cmd_id = msg.match(/^RUN:(.*)$/)[1].to_i
+      case msg.split(":")[1]
+      when "RUN"
+        cmd_id = msg.match(/^RUN:(.*)$/)[1].to_i
 
-      unless child_threads[cmd_id]
-        child_threads[cmd_id] = Thread.new do
-          run_command_and_stream(socket, cmd_id, send_msg_mutex)
-          child_threads[cmd_id] = nil
+        unless child_threads[cmd_id]
+          child_threads[cmd_id] = Thread.new do
+            run_command_and_stream(socket, cmd_id, send_msg_mutex)
+            child_threads[cmd_id] = nil
+          end
         end
-      end
 
-    when "STOP"
+      when "STOP"
 
-      cmd_id = msg.match(/^STOP:(.*)$/)[1].to_i
-      unless child_threads[cmd_id].nil?
-        child_threads[cmd_id].kill
-        child_threads[cmd_id] = nil
-      end
+        cmd_id = msg.match(/^STOP:(.*)$/)[1].to_i
+        unless child_threads[cmd_id].nil?
+          child_threads[cmd_id].kill
+          child_threads[cmd_id] = nil
+        end
 
-    else
-      log_error "Received an unrecognized message over the websocket: #{msg}"
-    end
-  }
+      else
+        log_error "Received an unrecognized message over the websocket: #{msg}"
+      end
+    }
+  rescue Exception => e
+    log_error "Wuh Woh #2: #{e}"
+    e.backtrace.each { |trace| log_error "#{trace}" }
+    raise e
+  end
 
 end
 
@@ -186,12 +207,14 @@ end
 
 # receive_msg
 #
-#
+# Extremely naive websocket server. Requires masking, and a message with a length
+# of at most 125. Needs to be updated to conform with RFC 6544
 def receive_msg socket
 
   # Check first two bytes
   byte1 = socket.getbyte
   byte2 = socket.getbyte
+  return nil if byte1.nil? or byte2.nil?
   if byte1 == 0x88  # Client is requesting that we close the connection.
     # TODO: Unsure how to properly handle this case. Right now the socket will close and
     # everything here will shut down - eventually? Kill all child threads first?
@@ -204,19 +227,28 @@ def receive_msg socket
   msg_size = byte2 & 0b01111111
   is_masked = byte2 & 0b10000000
   unless fin and opcode == 1 and is_masked and msg_size < MAX_WS_FRAME_SIZE
-    log_error "Invalid websocket message received. #{byte1}-#{byte2}"
-    puts socket.gets
-    msg_size.times.map { socket.getbyte }  # Read message from socket.
+    log_error "Invalid websocket message received. #{fin}, #{opcode == 1}, #{is_masked}, #{msg_size}"
+    msg_size.times { socket.getbyte }  # Read message from socket.
     return
   end
 
   # Get message
   mask = 4.times.map { socket.getbyte }
-  msg = msg_size.times.map { socket.getbyte }.each_with_index.map {
-    |byte, i| byte ^ mask[i % 4]
+  raise "Not Integer: fin       > #{fin      }" if not fin.is_a? Integer
+  raise "Not Integer: msg_size  > #{msg_size }" if not msg_size.is_a? Integer
+  raise "Not Integer: opcode    > #{opcode   }" if not opcode.is_a? Integer
+  raise "Not Integer: is_masked > #{is_masked}" if not is_masked.is_a? Integer
+  raise "Not aRRAY: mask      > #{mask     }" if not mask.is_a? Array
+  msg = msg_size.times.map { socket.getbyte }.each_with_index.map { |byte, i|
+    byte ^ mask[i % 4]
   }.pack('C*').force_encoding('utf-8').inspect
+
+  log_info "WebSocket received: #{msg}"
+
   msg[1..-2] # Remove quotation marks from message
 
+
+
 end
 
 
@@ -225,7 +257,6 @@ end
 #
 def send_msg(socket, send_msg_mutex, cmd_id, msg_type, msg=nil)
 
-
   case msg_type
   when "OUT", "ERR" # See comments at the top of the file to explain this part of the protocol.
     header = "#{cmd_id}:#{msg_type}:"
@@ -295,6 +326,8 @@ def send_msg(socket, send_msg_mutex, cmd_id, msg_type, msg=nil)
     log_error "Trying to send a websocket message with unrecognized type: #{msg_type}"
   end
 
+  log_info "Message sent via WebSocket: #{msg}"
+
 end
 
 # send_frame
@@ -304,10 +337,11 @@ end
 # this function).
 # TODO: Figure out the proper frame size (MAX_WS_FRAME_SIZE).
 def send_frame(socket, msg)
+
   output = [0b10000001, msg.size, msg]
   begin
     socket.write output.pack("CCA#{msg.size}")
-  rescue IOError
+  rescue IOError, Errno::EPIPE
     log_error "WebSocket is closed. Msg: #{msg}"
   end
 end

data/lib/easel.rb

@@ -1,4 +1,4 @@
-#!/snap/bin/ruby
+#!/usr/bin/env ruby
 #
 # Author: Eric Power
 #
@@ -65,12 +65,8 @@ def parse_ARGV
       end
     end
 
-    opts.on("-h HOST", "--hostname HOST",  "Sets the hostname. Default is '#{$config[:hostname]}'.") do |port|
-      if port >= 0 and port <= 65535
-        $config[:port] = port
-      else
-        log_fatal "Command argument PORT '#{port}' not a valid port. Must be between 0 and 65535 (inclusive)"
-      end
+    opts.on("-h HOST", "--hostname HOST",  "Sets the hostname. Default is '#{$config[:hostname]}'.") do |host|
+      $config[:host] = host
     end
 
     opts.on("-o [FILE]", "--output [FILE]",  "Set a log file.") do |filename|

data/lib/html/controller.js.erb

@@ -118,9 +118,9 @@ function toggle_run(id){
     return;
   }
   if (tDash.isRunning) { // TODO: Move into the Dashboard Class.
-    webSocket.send("STOP:" + id);
+    webSocket.send(id + ":STOP");
   } else {
-    webSocket.send("RUN:" + id);
+    webSocket.send(id + ":RUN");
   }
   tDash.toggleRunning();
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easel-dashboard
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Eric Power
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An easier way to manage your server.