websocket-server 1.1.4-java → 1.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed1041a901164c473dbfb099e709e6195fc9f206fca0659125b9a417dc911312
-  data.tar.gz: 230e76a31baf6d4d7647b4f21b76c60e36bcf0f1a9860d7cffcf20010387a751
+  metadata.gz: 64315a4d554857c31f1dd058666d4ff50813ec6a0afe829ad89434ab997ad55a
+  data.tar.gz: 6732df15258e1c3fcb5b2552160ad1125e383ab42bc7fa29763e992bf93c920a
 SHA512:
-  metadata.gz: 7f2b3c9a744be8afa350a108e8b2c39017f049a6ab9aaf3e0ea3c54886212d7a4c0d79daa0d86d48882e34f7a8a184e55508d2c33e2a9564dad477bc76b23ca6
-  data.tar.gz: 40db817d3b7af688a03ff27bd40d9a6e7df7ef8ea4c843d81affb260b62845f8f7324546b7a02f5691ac7700a39244e751a7bda4c389a7a4b4d7b674ed80a2f5
+  metadata.gz: a284c684a87c395f2587f0756f0ea6d312233208597e79de7c2e681e0f609ebd8ff552f017f199a0fe4f198860eef0bf2b7876e8d3a43829f9a2f1838635de73
+  data.tar.gz: 34fe8725f760895177dd962954564c9b246005a09ecca02e5be8e3c836edaa71d8bcb9d8aa3af55920579b32cd8c660dfe07214729f3036332a735b4500196f6

data/lib/websocket/channel_initializer.rb

@@ -30,7 +30,7 @@ module WebSocket
   # configuration for the channel pipeline that will handle requests of
   # the server.
   class ChannelInitializer < ::Server::ChannelInitializer
-    HttpObjectAggregatorBufferBytesSize = 65_536
+    HTTP_OBJECT_AGGREGATOR_BUFFER_BYTES_SIZE = 65_536
 
     def initialize(channel_group, options = {})
       super(channel_group, options)
@@ -40,15 +40,15 @@ module WebSocket
     # rubocop: disable Metrics/MethodLength
     def initChannel(channel)
       pipeline = channel.pipeline
-      pipeline.addLast(ssl_handler(channel)) if @options[:ssl]
+      pipeline.addLast(ssl_handler(channel)) if ssl?
       pipeline.addLast(HttpServerCodec.new)
-      pipeline.addLast(HttpObjectAggregator.new(HttpObjectAggregatorBufferBytesSize))
+      pipeline.addLast(HttpObjectAggregator.new(HTTP_OBJECT_AGGREGATOR_BUFFER_BYTES_SIZE))
       pipeline.addLast(ChunkedWriteHandler.new)
-      pipeline.addLast(IdleStateHandler.new(@options[:idle_reading], @options[:idle_writing], 0))
+      pipeline.addLast(IdleStateHandler.new(idle_reading, idle_writing, 0))
       pipeline.addLast(WebSocket::IdleHandler.new)
       pipeline.addLast(WebSocketServerCompressionHandler.new)
-      pipeline.addLast(WebSocketServerProtocolHandler.new(@options[:web_socket_path], nil, true))
-      pipeline.addLast(SslCipherInspector.new) if !ssl_context.nil? && @options[:inspect_ssl]
+      pipeline.addLast(WebSocketServerProtocolHandler.new(web_socket_path, nil, true))
+      pipeline.addLast(SslCipherInspector.new) if !ssl_context.nil? && inspect_ssl?
       pipeline.addLast(HttpStaticFileServerHandler.new(@options))
       add_user_handlers(pipeline)
       pipeline.addLast(default_handler)
@@ -67,6 +67,43 @@ module WebSocket
         end
       end
     end
+
+    private
+
+    def web_socket_path
+      @web_socket_path ||= begin
+        value = @options[:web_socket_path]
+        value.nil? || value.empty? ? DEFAULT_WEB_SOCKET_PATH : value
+      end
+    end
+
+    def idle_reading
+      @idle_reading ||= begin
+        value = @options[:idle_reading]
+        value.nil? ? DEFAULT_IDLE_READING_SECONDS : value
+      end
+    end
+
+    def idle_writing
+      @idle_writing ||= begin
+        value = @options[:idle_writing]
+        value.nil? ? DEFAULT_IDLE_WRITING_SECONDS : value
+      end
+    end
+
+    def ssl?
+      @ssl ||= begin
+        value = @options[:ssl]
+        value.nil? ? DEFAULT_SSL_ENABLED : value
+      end
+    end
+
+    def inspect_ssl?
+      @inspect_ssl = begin
+        value = @options[:inspect_ssl]
+        value.nil? ? DEFAULT_SSL_INSPECTION_ENABLED : value
+      end
+    end
   end
   # class ServerInitializer
 end

data/lib/websocket/config.rb

@@ -14,45 +14,70 @@ require 'logger'
 
 # The WebSocket module
 module WebSocket
+  WEBSOCKET_SUBMODULE_DIR_PATH = File.expand_path(__dir__)
+  LIB_DIR_PATH = File.expand_path(File.dirname(WEBSOCKET_SUBMODULE_DIR_PATH))
+  PROJECT_DIR_PATH = File.expand_path(File.dirname(LIB_DIR_PATH))
+  DEFAULT_LOG_LEVEL = Logger::INFO
+  DEFAULT_HOSTNAME = '0.0.0.0'.freeze
+  DEFAULT_PORT = 4000
+  DEFAULT_SSL_PORT = 443
+  DEFAULT_TELNET_PROXY_HOST = nil
+  DEFAULT_TELNET_PROXY_PORT = 21
+  DEFAULT_KEEP_ALIVE = true
+  DEFAULT_MAX_QUEUED_INCOMING_CONNECTIONS = 100
+  DEFAULT_IDLE_READING_SECONDS = 5 * 60 # seconds
+  DEFAULT_IDLE_WRITING_SECONDS = 30 # seconds
+  DEFAULT_SSL_ENABLED = false
+  DEFAULT_SSL_CERTIFICATE_FILE_PATH = File.join(PROJECT_DIR_PATH, 'fullchain.pem')
+  # openssl pkcs8 -topk8 -nocrypt -in websocket.key -out websocket_pcks8
+  #
+  # The privkey.key file here should be generated using the following
+  # openssl command:
+  #
+  #    openssl pkcs8 -topk8 -inform PEM -outform DER -in privkey.pem -nocrypt > privkey.key
+  #
+  DEFAULT_SSL_PRIVATE_KEY_FILE_PATH = File.join(PROJECT_DIR_PATH, 'privkey.key')
+  DEFAULT_SSL_INSPECTION_ENABLED = false
+  DEFAULT_WEB_SOCKET_PATH = '/websocket'.freeze
+  DEFAULT_WEB_DIR = 'web'.freeze
+  DEFAULT_WEB_ROOT = File.join(PROJECT_DIR_PATH, DEFAULT_WEB_DIR)
+  DEFAULT_INDEX_PAGE = 'index.html'.freeze
+  DEFAULT_PING_MESSAGE = "ping\n".freeze
+  # EEE, dd MMM yyyy HH:mm:ss zzz
+  DEFAULT_HTTP_DATE_FORMAT = '%a, %d %b %Y %H:%M:%S %Z'.freeze
+  DEFAULT_HTTP_DATE_GMT_TIMEZONE = 'GMT'.freeze
+  DEFAULT_CACHE_SECONDS = 60 # seconds
+  DEFAULT_INSECURE_URI_PATTERN = %r{.*[<>&"].*}
+  DEFAULT_LOG_REQUESTS = false
+
   # rubocop: disable Metrics/MethodLength
   def server_config
-    @server_config ||= begin
-      server_submodule_dir_path = File.expand_path(__dir__)
-      lib_dir_path = File.expand_path(File.dirname(server_submodule_dir_path))
-      project_dir_path = File.expand_path(File.dirname(lib_dir_path))
-      {
-        log_level: Logger::INFO,
-        host: '0.0.0.0',
-        port: 4000,
-        ssl_port: 443,
-        telnet_proxy_host: nil,
-        telnet_proxy_port: 21,
-        ssl: false,
-        ssl_certificate_file_path: File.join(project_dir_path, 'fullchain.pem'),
-        # openssl pkcs8 -topk8 -nocrypt -in websocket.key -out websocket_pcks8
-        #
-        # The privkey.key file here should be generated using the following
-        # openssl command:
-        #
-        #    openssl pkcs8 -topk8 -inform PEM -outform DER -in privkey.pem -nocrypt > privkey.key
-        #
-        ssl_private_key_file_path: File.join(project_dir_path, 'privkey.key'),
-        use_jdk_ssl_provider: false,
-        inspect_ssl: false,
-        idle_reading: 5 * 60, # seconds
-        idle_writing: 30, # seconds
-        index_page: 'index.html',
-        web_root: File.join(project_dir_path, 'web'),
-        web_socket_path: '/websocket',
-        ping_message: "ping\n",
-        http_date_format: '%a, %d %b %Y %H:%M:%S %Z', # EEE, dd MMM yyyy HH:mm:ss zzz
-        http_date_gmt_timezone: 'GMT',
-        http_cache_seconds: 60,
-        insecure_uri_pattern: /.*[<>&"].*/,
-        allowed_file_name: /[A-Za-z0-9][-_A-Za-z0-9\\.]*/,
-        log_requests: false
-      }
-    end
+    @server_config ||= {
+      log_level: DEFAULT_LOG_LEVEL,
+      host: DEFAULT_HOSTNAME,
+      port: DEFAULT_PORT,
+      ssl_port: DEFAULT_SSL_PORT,
+      telnet_proxy_host: DEFAULT_TELNET_PROXY_HOST,
+      telnet_proxy_port: DEFAULT_TELNET_PROXY_PORT,
+      ssl: DEFAULT_SSL_ENABLED,
+      ssl_certificate_file_path: DEFAULT_SSL_CERTIFICATE_FILE_PATH,
+      ssl_private_key_file_path: DEFAULT_SSL_PRIVATE_KEY_FILE_PATH,
+      use_jdk_ssl_provider: false,
+      inspect_ssl: DEFAULT_SSL_INSPECTION_ENABLED,
+      idle_reading: DEFAULT_IDLE_READING_SECONDS,
+      idle_writing: DEFAULT_IDLE_WRITING_SECONDS,
+      keep_alive: DEFAULT_KEEP_ALIVE,
+      max_queued_incoming_connections: DEFAULT_MAX_QUEUED_INCOMING_CONNECTIONS,
+      index_page: DEFAULT_INDEX_PAGE,
+      web_root: DEFAULT_WEB_ROOT,
+      web_socket_path: DEFAULT_WEB_SOCKET_PATH,
+      ping_message: DEFAULT_PING_MESSAGE,
+      http_date_format: DEFAULT_HTTP_DATE_FORMAT,
+      http_date_gmt_timezone: DEFAULT_HTTP_DATE_GMT_TIMEZONE,
+      http_cache_seconds: DEFAULT_CACHE_SECONDS,
+      insecure_uri_pattern: DEFAULT_INSECURE_URI_PATTERN,
+      log_requests: DEFAULT_LOG_REQUESTS
+    }
   end
   module_function :server_config
   # rubocop: enable Metrics/MethodLength

data/lib/websocket/frame_handler.rb

@@ -28,7 +28,7 @@ module WebSocket
   class FrameHandler < SimpleChannelInboundHandler
     include ChannelHandler
     include ChannelFutureListener
-    UnsupportedFrameTypeErrorTemplate =
+    UNSUPPORTED_FRAME_TYPE_ERROR_TEMPLATE =
       '%<handler>s encountered unsupported frame type: %<frame>s'.freeze
 
     def initialize
@@ -50,7 +50,9 @@ module WebSocket
 
     def unsupported_frame(frame, handler)
       raise java.lang.UnsupportedOperationException, format(
-        UnsupportedFrameTypeErrorTemplate, handler: handler.class, frame: frame.class
+        UNSUPPORTED_FRAME_TYPE_ERROR_TEMPLATE,
+        handler: handler.class,
+        frame: frame.class
       )
     end
 

data/lib/websocket/header_helpers.rb

@@ -21,6 +21,8 @@ module WebSocket
 
   # The HeaderHelpers module
   module HeaderHelpers
+    PRIVATE_MAX_AGE_TEMPLATE = 'private, max-age=%<max_age>s'.freeze
+
     def keep_alive_header(response)
       response.headers().set(HttpHeaderNames::CONNECTION, HttpHeaderValues::KEEP_ALIVE)
     end
@@ -41,15 +43,13 @@ module WebSocket
       response.headers().set(HttpHeaderNames::LAST_MODIFIED, last_modified)
     end
 
-    PrivateMaxAgeTempalte = 'private, max-age=%<max_age>s'.freeze
-
     # rubocop: disable Metrics/AbcSize
     def date_and_cache_headers(response, path, timestamp = Time.now)
       maximum_age = options[:http_cache_seconds]
       date_format = options[:http_date_format]
       date_header(response, timestamp.strftime(date_format))
       expires_header(response, Time.at(timestamp.to_i + maximum_age).strftime(date_format))
-      cache_control_header(response, format(PrivateMaxAgeTempalte, max_age: maximum_age.to_s))
+      cache_control_header(response, format(PRIVATE_MAX_AGE_TEMPLATE, max_age: maximum_age.to_s))
       last_modified_header(response, File.mtime(path).strftime(date_format))
     end
     # rubocop: enable Metrics/AbcSize

data/lib/websocket/http_static_file_server_handler_instance_methods.rb

@@ -36,6 +36,7 @@ module WebSocket
 
   # The HttpStaticFileServerHandlerInstanceMethods module
   module HttpStaticFileServerHandlerInstanceMethods
+    WEB_SOCKET_PATH_PATTERN_TEMPLATE = '^%<path>s$'.freeze
     FORWARD_SLASH_BEFORE_EOL_PATTERN = %r{/$}
     URI_FORWARD_SLASH_TEMPLATE = '%<uri>s/'.freeze
 
@@ -44,7 +45,7 @@ module WebSocket
     # rubocop: disable Metrics/MethodLength
     # rubocop: disable Metrics/PerceivedComplexity
     def messageReceived(ctx, request)
-      return if %r{^#{options[:web_socket_path]}$}.match?(request.uri)
+      return if web_socket_path_pattern.match?(request.uri)
 
       unless request.decoderResult().isSuccess()
         send_error(ctx, HttpResponseStatus::BAD_REQUEST)
@@ -153,6 +154,22 @@ module WebSocket
       return unless ctx.channel().isActive()
       send_error(ctx, HttpResponseStatus::INTERNAL_SERVER_ERROR)
     end
+
+    private
+
+    def web_socket_path_pattern
+      @web_socket_path_pattern ||= begin
+        pattern = format(WEB_SOCKET_PATH_PATTERN_TEMPLATE, path: web_socket_path)
+        Regexp.new(pattern)
+      end
+    end
+
+    def web_socket_path
+      @web_socket_path ||= begin
+        value = options[:web_socket_path]
+        value.nil? || value.empty? ? DEFAULT_WEB_SOCKET_PATH : value
+      end
+    end
   end
   # module HttpStaticFileServerHandlerInstanceMethods
 end

data/lib/websocket/instance_methods.rb

@@ -19,47 +19,14 @@ require_relative 'shutdown_hook'
 # The WebSocket module
 module WebSocket
   java_import Java::io.netty.bootstrap.ServerBootstrap
-  java_import Java::io.netty.channel.group.DefaultChannelGroup
-  java_import Java::io.netty.channel.nio.NioEventLoopGroup
-  java_import Java::io.netty.handler.logging.LoggingHandler
-  java_import Java::io.netty.handler.logging.LogLevel
-  java_import Java::io.netty.util.concurrent.GlobalEventExecutor
+  java_import Java::io.netty.channel.ChannelOption
 
   # The InstanceMethods module
   module InstanceMethods
-    def configure_handlers(&block)
-      add_listener(self)
-      channel_initializer << block if block_given?
-    end
-
-    def bootstrap
-      @bootstrap = ServerBootstrap.new
-      @bootstrap.group(boss_group, worker_group)
-      @bootstrap.channel(Server::CHANNEL_TYPE)
-      @bootstrap.handler(logging_handler) if @options[:log_requests]
-      @bootstrap.childHandler(channel_initializer)
-    end
-
     def channel_initializer
       @channel_initializer ||= ::WebSocket::ChannelInitializer.new(channel_group, @options)
     end
 
-    def boss_group
-      @boss_group ||= NioEventLoopGroup.new(2)
-    end
-
-    def worker_group
-      @worker_group ||= NioEventLoopGroup.new
-    end
-
-    def channel_group
-      @channel_group ||= DefaultChannelGroup.new('server_channels', GlobalEventExecutor::INSTANCE)
-    end
-
-    def logging_handler
-      LoggingHandler.new(LogLevel::INFO)
-    end
-
     # rubocop: disable Metrics/AbcSize
     # rubocop: disable Metrics/MethodLength
     def run(params = {})
@@ -83,32 +50,12 @@ module WebSocket
       @port ||= (@options[:ssl] ? @options[:ssl_port] : @options[:port]).to_i
     end
 
-    def shutdown
-      channel_group.disconnect().awaitUninterruptibly()
-      channel_group.close().awaitUninterruptibly()
-    end
-
-    def stop
-      boss_group&.shutdownGracefully()
-      worker_group&.shutdownGracefully()
-    end
-
-    def <<(handler)
-      channel_initializer.handlers << handler
-    end
-
-    def add_listener(*listener)
-      channel_initializer.add_listener(*listener)
+    def log_requests?
+      @log_requests ||= begin
+        value = @options[:log_requests]
+        value.nil? ? DEFAULT_LOG_REQUESTS : value
+      end
     end
-
-    # def all_exist?(*files)
-    #   files.all? { |f| File.exist?(f) }
-    # end
-
-    # def init_ssl_context(certificate, private_key)
-    #   return certificate_key_pair(certificate, private_key) if all_exist?(certificate, private_key)
-    #   options[:use_jdk_ssl_provider] ? jdk_ssl_provider : self_signed_certificate
-    # end
   end
   # module ServerInstanceMethods
 end

data/lib/websocket/ssl_context_initialization.rb

@@ -36,6 +36,15 @@ module WebSocket
       channel_initializer.ssl_context = context unless context.nil?
     end
 
+    def all_exist?(*files)
+      files.all? { |f| File.exist?(f) }
+    end
+
+    def init_ssl_context(certificate, private_key)
+      return certificate_key_pair(certificate, private_key) if all_exist?(certificate, private_key)
+      options[:use_jdk_ssl_provider] ? jdk_ssl_provider : self_signed_certificate
+    end
+
     def ssl_context
       @ssl_context ||= init_ssl_context(options[:ssl_certificate_file_path], options[:ssl_private_key_file_path])
     end

data/lib/websocket/validation_helpers.rb

@@ -28,7 +28,7 @@ module WebSocket
         DOT_FILE_SEPARATOR_PATTERN.match?(uri) ||
         uri.start_with?('.') ||
         uri.end_with?('.') ||
-        options[:insecure_uri_pattern].match?(uri)
+        insecure_uri_pattern.match?(uri)
     end
 
     def sanitize_uri(uri)
@@ -39,7 +39,23 @@ module WebSocket
       uri = uri.gsub(FORWARD_SLASH_PATTERN, File::SEPARATOR)
       return nil if insecure_uri?(uri)
       # Convert to absolute path.
-      File.join(options[:web_root], uri)
+      File.join(web_root, uri)
+    end
+
+    private
+
+    def web_root
+      @web_root ||= begin
+        value = options[:web_root]
+        value || DEFAULT_WEB_ROOT
+      end
+    end
+
+    def insecure_uri_pattern
+      @insecure_uri_pattern ||= begin
+        value = options[:insecure_uri_pattern]
+        value || DEFAULT_INSECURE_URI_PATTERN
+      end
     end
   end
   # module ValidationHelpers

data/lib/websocket/version.rb

@@ -12,5 +12,5 @@
 
 # The WebSocket module
 module WebSocket
-  VERSION = '1.1.4'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/websocket_client.rb

@@ -262,8 +262,6 @@ module WebSocket
 
     def add_listener(*listener)
       listeners.addAll(listener)
-    ensure
-      log.trace "Listeners: #{listeners}"
     end
 
     def remove_listener(*listener)

data/lib/websocket_server.rb

@@ -33,7 +33,6 @@ module WebSocket
   end
 
   # rubocop: disable Metrics/AbcSize
-  # rubocop: disable Metrics/MethodLength
   def main(args = parse_arguments)
     Logging.log_level = args[:log_level]
     return telnet_proxy(args) unless args[:telnet_proxy_host].nil?
@@ -42,13 +41,11 @@ module WebSocket
     warn format("\r%<class>s", class: e.class)
     exit
   rescue StandardError => e
-    puts Logging.log_level
     ::WebSocket::Server.log.fatal(e.message)
     e.backtrace.each { |t| WebSocket::Server.log.debug t }
     abort
   end
   # rubocop: enable Metrics/AbcSize
-  # rubocop: enable Metrics/MethodLength
 end
 # module WebSocket
 

data/web/css/client/ansispan.css

@@ -0,0 +1,71 @@
+
+span.underline {
+    text-decoration: underline;
+}
+span.blink {
+    text-decoration: blink;
+}
+span.flash {
+    text-decoration: flash;
+}
+span.inverse {
+    text-decoration: inverse;
+}
+span.hidden {
+    display: none;
+}
+span.line-through {
+    text-decoration: line-through;
+}
+span.monospace {
+    font-family: 'Droid Sans Mono', sans-serif;
+}
+
+span.black-foreground {
+    color: black;
+}
+span.red-foreground {
+    color: red;
+}
+span.green-foreground {
+    color: green;
+}
+span.yellow-foreground {
+    color: yellow;
+}
+span.dodgerblue-foreground {
+    color: dodgerblue;
+}
+span.magenta-foreground {
+    color: magenta;
+}
+span.cyan-foreground {
+    color: cyan;
+}
+span.white-foreground {
+    color: white;
+}
+span.black-background {
+    background-color: black;
+}
+span.red-background {
+    background-color: red;
+}
+span.green-background {
+    background-color: green;
+}
+span.yellow-background {
+    background-color: yellow;
+}
+span.dodgerblue-background {
+    background-color: dodgerblue;
+}
+span.magenta-background {
+    background-color: magenta;
+}
+span.cyan-background {
+    background-color: cyan;
+}
+span.white-background {
+    background-color: white;
+}

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: websocket-server
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.2.1
   name: tcp-server
   type: :runtime
   prerelease: false
@@ -23,7 +23,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.2.1
   force_ruby_platform: false
 description: Websocket Server for JRuby is a websocket server with a file server to
   support a demo javascript client application which interfaces with a demo echo server
@@ -66,6 +66,7 @@ files:
 - lib/websocket_client.rb
 - lib/websocket_server.rb
 - web/client.html
+- web/css/client/ansispan.css
 - web/css/client/console.css
 - web/css/client/parchment.css
 - web/favicon.ico