bayserver-docker-fcgi 2.2.0

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

@@ -0,0 +1,52 @@
+require 'baykit/bayserver/docker/base/port_base'
+require 'baykit/bayserver/protocol/packet_store'
+require 'baykit/bayserver/docker/fcgi/package'
+
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgPortDocker < Baykit::BayServer::Docker::Base::PortBase
+          include Baykit::BayServer::Docker::Fcgi::FcgDocker # implements
+
+          include Baykit::BayServer::Protocol
+          include Baykit::BayServer::WaterCraft
+          include Baykit::BayServer::Docker::Base
+
+          ######################################################
+          # Implements Port
+          ######################################################
+          def protocol()
+            return PROTO_NAME
+          end
+
+          ######################################################
+          # Implements PortBase
+          ######################################################
+          def support_anchored()
+            return true
+          end
+
+          def support_unanchored()
+            return false
+          end
+
+          ######################################################
+          # Class initializer
+          ######################################################
+          begin
+            PacketStore.register_protocol(
+              PROTO_NAME,
+              FcgPacketFactory.new())
+            ProtocolHandlerStore.register_protocol(
+              PROTO_NAME,
+              true,
+              FcgInboundHandler::InboundProtocolHandlerFactory.new())
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,54 @@
+require 'baykit/bayserver/protocol/package'
+require 'baykit/bayserver/tours/package'
+
+require 'baykit/bayserver/util/http_util'
+require 'baykit/bayserver/util/simple_buffer'
+
+require 'baykit/bayserver/docker/fcgi/command/package'
+require 'baykit/bayserver/docker/fcgi/package'
+
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgProtocolHandler < Baykit::BayServer::Protocol::ProtocolHandler
+          include Baykit::BayServer::Docker::Fcgi::FcgCommandHandler # implements
+
+          include Baykit::BayServer::Util
+          include Baykit::BayServer::Agent
+          include Baykit::BayServer::Protocol
+          include Baykit::BayServer::Docker::Fcgi::Command
+
+          def initialize(pkt_store, svr_mode)
+            @command_unpacker = FcgCommandUnPacker.new(self)
+            @packet_unpacker = FcgPacketUnPacker.new(pkt_store, @command_unpacker)
+            @packet_packer = PacketPacker.new()
+            @command_packer = CommandPacker.new(@packet_packer, pkt_store)
+            @server_mode = svr_mode
+          end
+
+          def inspect()
+            return "PH[#{@ship}]"
+          end
+
+          ######################################################
+          # Implements ProtocolHandler
+          ######################################################
+          def protocol()
+            return FcgDocker::PROTO_NAME
+          end
+
+          def max_req_packet_data_size
+            FcgPacket::MAXLEN
+          end
+
+          def max_res_packet_data_size
+            FcgPacket::MAXLEN
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgType
+
+          BEGIN_REQUEST = 1
+          ABORT_REQUEST = 2
+          END_REQUEST = 3
+          PARAMS = 4
+          STDIN = 5
+          STDOUT = 6
+          STDERR = 7
+          DATA = 8
+          GET_VALUES = 9
+          GET_VALUES_RESULT = 10
+          UNKNOWN_TYPE = 11
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'baykit/bayserver/bcf/package'
+require 'baykit/bayserver/docker/warp/warp_docker'
+require 'baykit/bayserver/agent/transporter/plain_transporter'
+require 'baykit/bayserver/docker/fcgi/package'
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgWarpDocker < Baykit::BayServer::Docker::Warp::WarpDocker
+          include Baykit::BayServer::Docker::Fcgi::FcgDocker  # implements
+
+          include Baykit::BayServer::Bcf
+          include Baykit::BayServer::Protocol
+          include Baykit::BayServer::Agent::Transporter
+
+          attr :script_base
+          attr :doc_root
+
+          ######################################################
+          # Implements Docker
+          ######################################################
+          def init(elm, parent)
+            super
+
+            if @script_base == nil
+              BayLog.warn "FCGI: docRoot is not specified"
+            end
+          end
+
+          ######################################################
+          # Implements DockerBase
+          ######################################################
+
+          def init_key_val(kv)
+            case kv.key.downcase
+            when "scritbase"
+              @script_base = kv.value
+            when "docroot"
+              @doc_root = kv.value
+            else
+              return super
+            end
+            true
+          end
+
+          ######################################################
+          # Implements WarpDocker
+          ######################################################
+          def secure()
+            return false
+          end
+
+          ######################################################
+          # Implements WarpDockerBase
+          ######################################################
+          def protocol()
+            return PROTO_NAME
+          end
+
+          def new_transporter(agt, skt)
+            PlainTransporter.new(false, IOUtil.get_sock_recv_buf_size(skt))
+          end
+
+          ######################################################
+          # Class initializer
+          ######################################################
+          begin
+            PacketStore.register_protocol(
+              PROTO_NAME,
+              FcgPacketFactory.new())
+            ProtocolHandlerStore.register_protocol(
+              PROTO_NAME,
+              false,
+              FcgWarpHandler::WarpProtocolHandlerFactory.new())
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,324 @@
+require 'baykit/bayserver/protocol/protocol_exception'
+require 'baykit/bayserver/tours/package'
+require 'baykit/bayserver/agent/next_socket_action'
+
+require 'baykit/bayserver/util/string_util'
+require 'baykit/bayserver/util/simple_buffer'
+require 'baykit/bayserver/util/cgi_util'
+
+require 'baykit/bayserver/docker/warp/warp_data'
+require 'baykit/bayserver/docker/fcgi/fcg_protocol_handler'
+require 'baykit/bayserver/docker/fcgi/command/package'
+require 'baykit/bayserver/docker/fcgi/fcg_params'
+
+module Baykit
+  module BayServer
+    module Docker
+      module Fcgi
+        class FcgWarpHandler < Baykit::BayServer::Docker::Fcgi::FcgProtocolHandler
+          include Baykit::BayServer::Docker::Warp::WarpHandler # implements
+
+          class WarpProtocolHandlerFactory
+            include Baykit::BayServer::Protocol::ProtocolHandlerFactory  # implements
+
+            def create_protocol_handler(pkt_store)
+              return FcgWarpHandler.new(pkt_store)
+            end
+          end
+
+          include Baykit::BayServer::Agent
+          include Baykit::BayServer::Protocol
+          include Baykit::BayServer::Tours
+          include Baykit::BayServer::Util
+          include Baykit::BayServer::Docker::Warp
+          include Baykit::BayServer::Docker::Fcgi::Command
+
+
+          STATE_READ_HEADER = 1
+          STATE_READ_CONTENT = 2
+
+          attr :cur_warp_id
+          attr :state
+          attr :line_buf
+
+          attr :pos
+          attr :last
+          attr :data
+
+          def initialize(pkt_store)
+            super(pkt_store, false)
+            @cur_warp_id = 0
+            @line_buf = SimpleBuffer.new
+            reset()
+          end
+
+          def reset
+            super
+            reset_state
+            @line_buf.reset
+            @pos = 0
+            @last = 0
+            @data = nil
+          end
+
+
+          ######################################################
+          # Implements WarpHandler
+          ######################################################
+          def next_warp_id
+            @cur_warp_id += 1
+            return @cur_warp_id
+          end
+
+          def new_warp_data(warp_id)
+            return WarpData.new(@ship, warp_id)
+          end
+
+          def post_warp_headers(tur)
+            send_begin_req(tur)
+            send_params(tur)
+          end
+
+          def post_warp_contents(tur, buf, start, len, &callback)
+            send_stdin(tur, buf, start, len, &callback)
+          end
+
+          def post_warp_end(tur)
+            send_stdin(tur, nil, 0, 0)
+          end
+
+          def verify_protocol(proto)
+          end
+
+
+          ######################################################
+          # Implements FcgCommandHandler
+          ######################################################
+
+          def handle_begin_request(cmd)
+            raise ProtocolException.new("Invalid FCGI command: %d", cmd.type)
+          end
+
+          def handle_end_request(cmd) 
+            tur = @ship.get_tour(cmd.req_id)
+            end_req_content(tur)
+            NextSocketAction::CONTINUE
+          end 
+
+          def handle_params(cmd)
+            raise ProtocolException.new("Invalid FCGI command: %d", cmd.type)
+          end
+
+          def handle_stderr(cmd)
+            msg = cmd.data[cmd.start .. cmd.start + cmd.length + 1]
+            BayLog.error("%s server error: %s", self, msg)
+            NextSocketAction::CONTINUE
+          end
+
+          def handle_stdin(cmd)
+            raise ProtocolException.new("Invalid FCGI command: %d", cmd.type)
+          end
+
+          def handle_stdout(cmd)
+            BayLog.debug("%s handle_stdout req_id=%d len=%d", @ship, cmd.req_id, cmd.length)
+            #BayLog.debug "#{self} handle_stdout data=#{cmd.data}"
+
+            tur = @ship.get_tour(cmd.req_id)
+            if tur == nil
+              raise Sink.new("Tour not found")
+            end
+
+            if cmd.length == 0
+              # stdout end
+              reset_state
+              return NextSocketAction::CONTINUE
+            end
+
+            @data = cmd.data
+            @pos = cmd.start
+            @last = cmd.start + cmd.length
+
+            if @state == STATE_READ_HEADER
+              read_header(tur)
+            end
+
+            if @pos < @last
+              BayLog.debug("%s fcgi: pos=%d last=%d len=%d", @ship, @pos, @last, @last - @pos)
+              if @state == STATE_READ_CONTENT
+                available = tur.res.send_content(Tour::TOUR_ID_NOCHECK, @data, @pos, @last - @pos)
+                if !available
+                  return NextSocketAction::SUSPEND
+                end
+              end
+            end
+
+            NextSocketAction::CONTINUE
+          end
+
+          ######################################################
+          # Custom methods
+          ######################################################
+          def read_header(tur)
+            wdat = WarpData.get(tur)
+
+            header_finished = parse_header(wdat.res_headers)
+            if header_finished
+              wdat.res_headers.copy_to(tur.res.headers)
+
+              # Check HTTP Status from headers
+              status = wdat.res_headers.get(Headers::STATUS)
+              #BayLog.debug "#{self} fcgi: status=#{wdat.res_headers.headers}"
+              #BayLog.debug "#{self} fcgi: status=#{status}"
+              if StringUtil.set?(status)
+                stlist = status.split(" ")
+                #BayLog.debug("#{self} fcgi: status list=#{stlist}")
+                tur.res.headers.status = stlist[0].to_i
+                tur.res.headers.remove(Headers::STATUS)
+              end
+
+              BayLog.debug("%s fcgi: read header status=%d contlen=%d", @ship, tur.res.headers.status, wdat.res_headers.content_length())
+              sid = @ship.ship_id
+              tur.res.set_consume_listener do |len, resume|
+                if resume
+                  @ship.resume(sid)
+                end
+              end
+
+              tur.res.send_headers(Tour::TOUR_ID_NOCHECK)
+              change_state(STATE_READ_CONTENT)
+            end
+
+          end
+
+          def read_content(tur)
+            tur.res.send_content(Tour::TOUR_ID_NOCHECK, @data, @pos, @last - @pos)
+          end
+
+          def parse_header(headers)
+
+            while true
+              if @pos == @last
+                # no byte data
+                break
+              end
+
+              c = @data[@pos]
+              @pos += 1
+
+              if c == CharUtil::CR
+                next
+              elsif c == CharUtil::LF
+                line = @line_buf.buf
+
+                if line.length == 0
+                  return true
+                end
+
+                colon_pos = line.index(':')
+                if colon_pos == nil
+                  raise ProtocolException.new("fcgi: Header line of server is invalid: %s", line)
+                else
+                  name = line[0 .. colon_pos - 1].strip
+                  value = line[colon_pos + 1 .. -1].strip
+
+                  if StringUtil.empty?(name) || StringUtil.empty?(value)
+                    raise ProtocolException("fcgi: Header line of server is invalid: %s", line)
+                  end
+
+                  headers.add(name, value)
+                  if BayServer.harbor.trace_header?
+                    BayLog.info("%s fcgi_warp: resHeader: %s=%s", @ship, name, value)
+                  end
+                end
+                @line_buf.reset()
+              else
+                @line_buf.put(c)
+              end
+            end
+            false
+          end
+
+          def end_req_content(tur)
+            @ship.end_warp_tour(tur)
+            tur.res.end_content(Tour::TOUR_ID_NOCHECK)
+            reset_state()
+          end
+
+          def change_state(new_state)
+            @state = new_state
+          end
+
+          def reset_state()
+            change_state(STATE_READ_HEADER)
+          end
+
+
+          def send_stdin(tur, data, ofs, len, &callback)
+            cmd = CmdStdIn.new(WarpData.get(tur).warp_id, data, ofs, len)
+            @command_packer.post(@ship, cmd, &callback)
+          end
+
+          def send_begin_req(tur)
+            cmd = CmdBeginRequest.new(WarpData.get(tur).warp_id)
+            cmd.role = CmdBeginRequest::FCGI_RESPONDER
+            cmd.keep_conn = true
+            @command_packer.post(@ship, cmd)
+          end
+
+          def send_params(tur)
+            script_base = @ship.docker.script_base
+            if script_base == nil
+              script_base = tur.town.location
+            end
+
+            if StringUtil.empty?(script_base)
+              raise StandardError.new("#{tur.town} Could not create SCRIPT_FILENAME. Location of town not specified.")
+            end
+
+            doc_root = @ship.docker.doc_root
+            if doc_root == nil
+              doc_root = tur.town.location
+            end
+
+            if StringUtil.empty?(doc_root)
+              raise StandardError.new("#{tur.town} docRoot of fcgi docker or location of town is not specified.")
+            end
+
+            warp_id = WarpData.get(tur).warp_id
+            cmd = CmdParams.new(warp_id)
+            script_fname = nil
+            CgiUtil.get_env(tur.town.name, doc_root, script_base, tur) do |name, value|
+              if name == CgiUtil::SCRIPT_FILENAME
+                script_fname = value
+              else
+                cmd.add_param(name, value)
+              end
+            end
+
+            script_fname = "proxy:fcgi://#{@ship.docker.host}:#{@ship.docker.port}#{script_fname}"
+            cmd.add_param(CgiUtil::SCRIPT_FILENAME, script_fname)
+
+            # Add FCGI params
+            cmd.add_param(FcgParams::CONTEXT_PREFIX, "")
+            cmd.add_param(FcgParams::UNIQUE_ID, DateTime.now.to_s)
+            #cmd.add_param(FcgParams::X_FORWARDED_FOR, tur.req.remote_address)
+            #cmd.add_param(FcgParams::X_FORWARDED_PROTO, tur.is_secure ? "https" : "http")
+            #cmd.add_param(FcgParams::X_FORWARDED_PORT, tur.req.req_port.to_s)
+
+            if BayServer.harbor.trace_header?
+              cmd.params.each do |kv|
+                BayLog.info("%s fcgi_warp: env: %s=%s", @ship, kv[0], kv[1])
+              end
+            end
+
+            @command_packer.post(@ship, cmd)
+
+            cmd_params_end = CmdParams.new(WarpData.get(tur).warp_id)
+            @command_packer.post(@ship, cmd_params_end)
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require 'baykit/bayserver/docker/fcgi/fcg_command'
+require 'baykit/bayserver/docker/fcgi/fcg_command_handler'
+require 'baykit/bayserver/docker/fcgi/fcg_command_unpacker'
+require 'baykit/bayserver/docker/fcgi/fcg_inbound_handler'
+require 'baykit/bayserver/docker/fcgi/fcg_docker'
+require 'baykit/bayserver/docker/fcgi/fcg_packet'
+require 'baykit/bayserver/docker/fcgi/fcg_packet_factory'
+require 'baykit/bayserver/docker/fcgi/fcg_packet_unpacker'
+require 'baykit/bayserver/docker/fcgi/fcg_port_docker'
+require 'baykit/bayserver/docker/fcgi/fcg_protocol_handler'
+require 'baykit/bayserver/docker/fcgi/fcg_type'
+require 'baykit/bayserver/docker/fcgi/fcg_warp_handler'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: bayserver-docker-fcgi
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Michisuke-P
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bayserver-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: AJP docker of BayServer
+email: michisukep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/baykit/bayserver/docker/fcgi/command/cmd_begin_request.rb
+- lib/baykit/bayserver/docker/fcgi/command/cmd_end_request.rb
+- lib/baykit/bayserver/docker/fcgi/command/cmd_params.rb
+- lib/baykit/bayserver/docker/fcgi/command/cmd_stderr.rb
+- lib/baykit/bayserver/docker/fcgi/command/cmd_stdin.rb
+- lib/baykit/bayserver/docker/fcgi/command/cmd_stdout.rb
+- lib/baykit/bayserver/docker/fcgi/command/in_out_command_base.rb
+- lib/baykit/bayserver/docker/fcgi/command/package.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_command.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_command_handler.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_command_unpacker.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_docker.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_inbound_handler.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_packet.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_packet_factory.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_packet_unpacker.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_params.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_port_docker.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_protocol_handler.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_type.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_warp_docker.rb
+- lib/baykit/bayserver/docker/fcgi/fcg_warp_handler.rb
+- lib/baykit/bayserver/docker/fcgi/package.rb
+homepage: https://baykit.yokohama
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: AJP docker of BayServer
+test_files: []