bayserver-docker-fcgi 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2de0757edf90f4c3fe022303174264eb4a8a1cdf78d963bbc8f846bdd0b095ad
+  data.tar.gz: 1d587131837ea5a05db127671f4896e96c0784a9b23eeba7a4d03216faa6e2b0
+SHA512:
+  metadata.gz: 5e3daecd02c65f999f1c853858a7b21dbe8898ec9800e462f6faaecc0fc868b4304a2636882b9e8a75d116525bb50e01a6b99c1c3510bd7e0251e50bee505256
+  data.tar.gz: 61fca56ffe15d0b9cc3d623157a36ed88a48d3d0d8a084440f8bd581139bb5f5e4756fd8d0e0b4b60364c71e8c9d81dec8f8b4b5c554eb280864a7fe1356806f

data/lib/baykit/bayserver/docker/fcgi/command/cmd_begin_request.rb

@@ -0,0 +1,66 @@
+require 'baykit/bayserver/docker/fcgi/fcg_command'
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+# 
+#  Begin request command format
+#          typedef struct {
+#              unsigned char roleB1;
+#              unsigned char roleB0;
+#              unsigned char flags;
+#              unsigned char reserved[5];
+#          } FCGI_BeginRequestBody;
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class CmdBeginRequest < Baykit::BayServer::Docker::Fcgi::FcgCommand
+            include Baykit::BayServer::Docker::Fcgi
+
+            FCGI_KEEP_CONN = 1
+            FCGI_RESPONDER = 1
+            FCGI_AUTHORIZER = 2
+            FCGI_FILTER = 3
+
+            attr_accessor :role
+            attr_accessor :keep_conn
+
+            def initialize(req_id)
+              super(FcgType::BEGIN_REQUEST, req_id)
+            end
+
+            def unpack(pkt)
+              super
+
+              acc = pkt.new_data_accessor
+              @role = acc.get_short
+              flags = acc.get_byte
+              @keep_conn = (flags & FCGI_KEEP_CONN) != 0
+            end
+
+            def pack(pkt)
+              acc = pkt.new_data_accessor
+              acc.put_short(@role)
+              acc.put_byte(@keep_conn ? 1 : 0)
+              reserved = " " * 5
+              acc.put_bytes(reserved)
+
+              # must be called from last line
+              super
+            end
+
+            def handle(cmd_handler)
+              return cmd_handler.handle_begin_request(self)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/fcgi/command/cmd_end_request.rb

@@ -0,0 +1,66 @@
+require 'baykit/bayserver/docker/fcgi/fcg_command'
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+# 
+#  Endrequest command format
+#          typedef struct {
+#              unsigned char appStatusB3;
+#              unsigned char appStatusB2;
+#              unsigned char appStatusB1;
+#              unsigned char appStatusB0;
+#              unsigned char protocolStatus;
+#              unsigned char reserved[3];
+#          } FCGI_EndRequestBody;
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class CmdEndRequest < Baykit::BayServer::Docker::Fcgi::FcgCommand
+
+            FCGI_REQUEST_COMPLETE = 0
+            FCGI_CANT_MPX_CONN = 1
+            FCGI_OVERLOADED = 2
+            FCGI_UNKNOWN_ROLE = 3
+
+            attr :app_status
+            attr :protocol_status
+
+            def initialize(req_id)
+              super(FcgType::END_REQUEST, req_id)
+              @app_status = 0
+              @protocol_status = FCGI_REQUEST_COMPLETE
+            end
+
+            def unpack(pkt)
+              super
+              acc = pkt.new_data_accessor
+              @app_status = acc.get_int
+              @protocol_status = acc.get_byte
+            end
+
+            def pack(pkt)
+              acc = pkt.new_data_accessor
+              acc.put_int(@app_status)
+              acc.put_byte(@protocol_status)
+              reserved = " " * 3
+              acc.put_bytes(reserved)
+
+              # must be called from last line
+              super
+            end
+
+            def handle(cmd_handler)
+              return cmd_handler.handle_end_request(self)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/command/cmd_params.rb

@@ -0,0 +1,160 @@
+require 'baykit/bayserver/docker/fcgi/fcg_command'
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+require 'baykit/bayserver/util/string_util'
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+# 
+# 
+#  Params command format (Name-Value list)
+# 
+#          typedef struct {
+#              unsigned char nameLengthB0;  // nameLengthB0  >> 7 == 0
+#              unsigned char valueLengthB0; // valueLengthB0 >> 7 == 0
+#              unsigned char nameData[nameLength];
+#              unsigned char valueData[valueLength];
+#          } FCGI_NameValuePair11;
+# 
+#          typedef struct {
+#              unsigned char nameLengthB0;  // nameLengthB0  >> 7 == 0
+#              unsigned char valueLengthB3; // valueLengthB3 >> 7 == 1
+#              unsigned char valueLengthB2;
+#              unsigned char valueLengthB1;
+#              unsigned char valueLengthB0;
+#              unsigned char nameData[nameLength];
+#              unsigned char valueData[valueLength
+#                      ((B3 & 0x7f) << 24) + (B2 << 16) + (B1 << 8) + B0];
+#          } FCGI_NameValuePair14;
+# 
+#          typedef struct {
+#              unsigned char nameLengthB3;  // nameLengthB3  >> 7 == 1
+#              unsigned char nameLengthB2;
+#              unsigned char nameLengthB1;
+#              unsigned char nameLengthB0;
+#              unsigned char valueLengthB0; // valueLengthB0 >> 7 == 0
+#              unsigned char nameData[nameLength
+#                      ((B3 & 0x7f) << 24) + (B2 << 16) + (B1 << 8) + B0];
+#              unsigned char valueData[valueLength];
+#          } FCGI_NameValuePair41;
+# 
+#          typedef struct {
+#              unsigned char nameLengthB3;  // nameLengthB3  >> 7 == 1
+#              unsigned char nameLengthB2;
+#              unsigned char nameLengthB1;
+#              unsigned char nameLengthB0;
+#              unsigned char valueLengthB3; // valueLengthB3 >> 7 == 1
+#              unsigned char valueLengthB2;
+#              unsigned char valueLengthB1;
+#              unsigned char valueLengthB0;
+#              unsigned char nameData[nameLength
+#                      ((B3 & 0x7f) << 24) + (B2 << 16) + (B1 << 8) + B0];
+#              unsigned char valueData[valueLength
+#                      ((B3 & 0x7f) << 24) + (B2 << 16) + (B1 << 8) + B0];
+#          } FCGI_NameValuePair44;
+# 
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class CmdParams < Baykit::BayServer::Docker::Fcgi::FcgCommand
+            include Baykit::BayServer::Util
+
+            attr :params
+
+            def initialize(req_id)
+              super(FcgType::PARAMS, req_id)
+              @params = []
+            end
+
+            def unpack(pkt)
+              super
+              acc = pkt.new_data_accessor
+              while acc.pos < pkt.data_len
+                name_len = read_length(acc)
+                value_len = read_length(acc)
+
+                name = StringUtil.alloc(name_len)
+                acc.get_bytes(name, 0, name_len)
+
+                value = StringUtil.alloc(value_len)
+                acc.get_bytes(value, 0, value_len)
+
+                BayLog.trace("Params: %s=%s", name, value)
+                add_param(name, value)
+              end
+            end
+
+            def pack(pkt)
+              acc = pkt.new_data_accessor
+              @params.each do |nv|
+                name = nv[0]
+                value = nv[1]
+                name_len = name.length
+                value_len = value.length
+
+                write_length(name_len, acc)
+                write_length(value_len, acc)
+
+                acc.put_string(name)
+                acc.put_string(value)
+              end
+
+              # must be called from last line
+              super
+            end
+
+            def handle(cmd_handler)
+              return cmd_handler.handle_params(self)
+            end
+
+
+            def read_length(acc)
+              len = acc.get_byte
+              if len >> 7 == 0
+                return len
+              else
+                len2 = acc.get_byte
+                len3 = acc.get_byte
+                len4 = acc.get_byte
+                return ((len & 0x7f) << 24) | (len2 << 16) | (len3 << 8) | len4
+              end
+            end
+
+            def write_length(len, acc)
+              if len >> 7 == 0
+                acc.put_byte(len)
+              else
+                len1 = (len >> 24 & 0xFF) | 0x80
+                len2 = len >> 16 & 0xFF
+                len3 = len >> 8 & 0xFF
+                len4 = len & 0xFF
+                buf = StringUtil.alloc(4)
+                buf << len1 << len2 << len3 << len4
+                acc.put_bytes(buf)
+              end
+            end
+
+            def add_param(name, value)
+              if name == nil
+                raise RuntimeError.new("nil argument")
+              end
+
+              if value == nil
+                value = ""
+              end
+
+              @params.append([name, value])
+            end
+
+            def to_s()
+              "FcgCmdParams#{@params}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/command/cmd_stderr.rb

@@ -0,0 +1,31 @@
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+#
+#   StdErr command format
+#    raw data
+#
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class CmdStdErr < InOutCommandBase
+
+            def initialize(req_id)
+              super(FcgType::STDERR, req_id)
+            end
+
+            def handle(cmd_handler)
+              return cmd_handler.handle_stderr(self)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/command/cmd_stdin.rb

@@ -0,0 +1,33 @@
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+require 'baykit/bayserver/docker/fcgi/command/in_out_command_base'
+
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+#
+#   StdIn command format
+#    raw data
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class CmdStdIn < Baykit::BayServer::Docker::Fcgi::Command::InOutCommandBase
+
+            def initialize(req_id, data=nil, start=0, len=0)
+              super(FcgType::STDIN, req_id, data, start, len)
+            end
+
+            def handle(cmd_handler)
+              return cmd_handler.handle_stdin(self)
+            end
+
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/command/cmd_stdout.rb

@@ -0,0 +1,31 @@
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+#
+#   StdOut command format
+#    raw data
+#
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class CmdStdOut < InOutCommandBase
+
+            def initialize(req_id, data = nil, start = nil, len = nil)
+              super(FcgType::STDOUT, req_id, data, start, len)
+            end
+
+            def handle(cmd_handler)
+              return cmd_handler.handle_stdout(self)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/command/in_out_command_base.rb

@@ -0,0 +1,57 @@
+require 'baykit/bayserver/docker/fcgi/fcg_command'
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+require 'baykit/bayserver/docker/fcgi/fcg_packet'
+
+#
+#  FCGI spec
+#    http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html
+# 
+#  StdIn/StdOut/StdErr command format
+#    raw data
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module Command
+          class InOutCommandBase < Baykit::BayServer::Docker::Fcgi::FcgCommand
+
+            MAX_DATA_LEN = FcgPacket::MAXLEN - FcgPacket::PREAMBLE_SIZE
+
+            #
+            # This class refers external byte array, so this IS NOT mutable
+            #
+            attr :start
+            attr :length
+            attr :data
+
+            def initialize(type, req_id, data=nil, start=0, len=0)
+              super(type, req_id)
+              @data = data
+              @start = start
+              @length = len
+            end
+
+            def unpack(pkt)
+              super
+              @start = pkt.header_len
+              @length = pkt.data_len
+              @data = pkt.buf
+            end
+
+            def pack(pkt)
+              if @data != nil && @length > 0
+                acc = pkt.new_data_accessor()
+                acc.put_bytes(@data, @start, @length)
+              end
+
+              # must be called from last line
+              super
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/command/package.rb

@@ -0,0 +1,6 @@
+require 'baykit/bayserver/docker/fcgi/command/cmd_begin_request'
+require 'baykit/bayserver/docker/fcgi/command/cmd_end_request'
+require 'baykit/bayserver/docker/fcgi/command/cmd_params'
+require 'baykit/bayserver/docker/fcgi/command/cmd_stdin'
+require 'baykit/bayserver/docker/fcgi/command/cmd_stdout'
+require 'baykit/bayserver/docker/fcgi/command/cmd_stderr'

data/lib/baykit/bayserver/docker/fcgi/fcg_command.rb

@@ -0,0 +1,40 @@
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgCommand < Baykit::BayServer::Protocol::Command
+
+          attr :req_id
+
+          def initialize(type, req_id)
+            super(type)
+            @req_id = req_id
+          end
+
+          def unpack(pkt)
+            @req_id = pkt.req_id
+          end
+
+          #
+          # Super class method must be called from last line of override method 
+          # since header cannot be packed before data is constructed
+          #
+          def pack(pkt)
+            pkt.req_id = @req_id
+            pack_header(pkt)
+          end
+
+          def pack_header(pkt)
+            acc = pkt.new_header_accessor()
+            acc.put_byte(pkt.version)
+            acc.put_byte(pkt.type)
+            acc.put_short(pkt.req_id)
+            acc.put_short(pkt.data_len)
+            acc.put_byte(0)  # paddinglen
+            acc.put_byte(0)  # reserved
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baykit/bayserver/docker/fcgi/fcg_command_handler.rb

@@ -0,0 +1,24 @@
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module FcgCommandHandler
+          include Baykit::BayServer::Protocol::CommandHandler # implements
+
+          #
+          # abstract methods
+          #
+          #     public abstract NextSocketAction handleBeginRequest(CmdBeginRequest cmd) throws IOException;
+          #     public abstract NextSocketAction handleEndRequest(CmdEndRequest cmd) throws IOException;
+          #     public abstract NextSocketAction handleParams(CmdParams cmd) throws IOException;
+          #     public abstract NextSocketAction handleStdErr(CmdStdErr cmd) throws IOException;
+          #     public abstract NextSocketAction handleStdIn(CmdStdIn cmd) throws IOException;
+          #     public abstract NextSocketAction handleStdOut(CmdStdOut cmd) throws IOException;
+          #
+
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/fcgi/fcg_command_unpacker.rb

@@ -0,0 +1,56 @@
+require 'baykit/bayserver/protocol/command_unpacker'
+require 'baykit/bayserver/docker/fcgi/command/package'
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgCommandUnPacker < Baykit::BayServer::Protocol::CommandUnPacker
+
+          include Baykit::BayServer::Docker::Fcgi::Command
+
+          attr :handler
+
+          def initialize(handler)
+            @handler = handler
+            reset()
+          end
+
+          def reset()
+
+          end
+
+          def packet_received(pkt)
+
+            case(pkt.type)
+            when FcgType::BEGIN_REQUEST
+              cmd = CmdBeginRequest.new(pkt.req_id)
+
+            when FcgType::END_REQUEST
+              cmd = CmdEndRequest.new(pkt.req_id)
+
+            when FcgType::PARAMS
+              cmd = CmdParams.new(pkt.req_id)
+
+            when FcgType::STDIN
+              cmd = CmdStdIn.new(pkt.req_id)
+
+            when FcgType::STDOUT
+              cmd = CmdStdOut.new(pkt.req_id)
+
+            when FcgType::STDERR
+              cmd = CmdStdErr.new(pkt.req_id)
+
+            else
+              raise RuntimeError.new("IllegalState")
+
+            end
+            cmd.unpack(pkt)
+            cmd.handle(handler)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/fcgi/fcg_docker.rb

@@ -0,0 +1,14 @@
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        module FcgDocker
+          include Baykit::BayServer::Docker::Docker  # implements
+
+          PROTO_NAME = "fcgi"
+        end
+      end
+    end
+  end
+end
+