omg-actionpack 8.0.0.alpha1

data/lib/action_dispatch/http/request.rb

@@ -0,0 +1,498 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "stringio"
+
+require "active_support/inflector"
+require "action_dispatch/http/headers"
+require "action_controller/metal/exceptions"
+require "rack/request"
+require "action_dispatch/http/cache"
+require "action_dispatch/http/mime_negotiation"
+require "action_dispatch/http/parameters"
+require "action_dispatch/http/filter_parameters"
+require "action_dispatch/http/upload"
+require "action_dispatch/http/url"
+require "active_support/core_ext/array/conversions"
+
+module ActionDispatch
+  class Request
+    include Rack::Request::Helpers
+    include ActionDispatch::Http::Cache::Request
+    include ActionDispatch::Http::MimeNegotiation
+    include ActionDispatch::Http::Parameters
+    include ActionDispatch::Http::FilterParameters
+    include ActionDispatch::Http::URL
+    include ActionDispatch::ContentSecurityPolicy::Request
+    include ActionDispatch::PermissionsPolicy::Request
+    include Rack::Request::Env
+
+    autoload :Session, "action_dispatch/request/session"
+    autoload :Utils,   "action_dispatch/request/utils"
+
+    LOCALHOST   = Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]
+
+    ENV_METHODS = %w[ AUTH_TYPE GATEWAY_INTERFACE
+        PATH_TRANSLATED REMOTE_HOST
+        REMOTE_IDENT REMOTE_USER REMOTE_ADDR
+        SERVER_NAME SERVER_PROTOCOL
+        ORIGINAL_SCRIPT_NAME
+
+        HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
+        HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM
+        HTTP_NEGOTIATE HTTP_PRAGMA HTTP_CLIENT_IP
+        HTTP_X_FORWARDED_FOR HTTP_ORIGIN HTTP_VERSION
+        HTTP_X_CSRF_TOKEN HTTP_X_REQUEST_ID HTTP_X_FORWARDED_HOST
+        ].freeze
+
+    ENV_METHODS.each do |env|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        # frozen_string_literal: true
+        def #{env.delete_prefix("HTTP_").downcase}  # def accept_charset
+          get_header "#{env}"                       #   get_header "HTTP_ACCEPT_CHARSET"
+        end                                         # end
+      METHOD
+    end
+
+    TRANSFER_ENCODING = "HTTP_TRANSFER_ENCODING" # :nodoc:
+
+    def self.empty
+      new({})
+    end
+
+    def initialize(env)
+      super
+      @method            = nil
+      @request_method    = nil
+      @remote_ip         = nil
+      @original_fullpath = nil
+      @fullpath          = nil
+      @ip                = nil
+    end
+
+    def commit_cookie_jar! # :nodoc:
+    end
+
+    PASS_NOT_FOUND = Class.new { # :nodoc:
+      def self.action(_); self; end
+      def self.call(_); [404, { Constants::X_CASCADE => "pass" }, []]; end
+      def self.action_encoding_template(action); false; end
+    }
+
+    def controller_class
+      params = path_parameters
+      params[:action] ||= "index"
+      controller_class_for(params[:controller])
+    end
+
+    def controller_class_for(name)
+      if name
+        controller_param = name.underscore
+        const_name = controller_param.camelize << "Controller"
+        begin
+          const_name.constantize
+        rescue NameError => error
+          if error.missing_name == const_name || const_name.start_with?("#{error.missing_name}::")
+            raise MissingController.new(error.message, error.name)
+          else
+            raise
+          end
+        end
+      else
+        PASS_NOT_FOUND
+      end
+    end
+
+    # Returns true if the request has a header matching the given key parameter.
+    #
+    #     request.key? :ip_spoofing_check # => true
+    def key?(key)
+      has_header? key
+    end
+
+    # HTTP methods from [RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1](https://www.ietf.org/rfc/rfc2616.txt)
+    RFC2616 = %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
+    # HTTP methods from [RFC 2518: HTTP Extensions for Distributed Authoring -- WEBDAV](https://www.ietf.org/rfc/rfc2518.txt)
+    RFC2518 = %w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
+    # HTTP methods from [RFC 3253: Versioning Extensions to WebDAV](https://www.ietf.org/rfc/rfc3253.txt)
+    RFC3253 = %w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
+    # HTTP methods from [RFC 3648: WebDAV Ordered Collections Protocol](https://www.ietf.org/rfc/rfc3648.txt)
+    RFC3648 = %w(ORDERPATCH)
+    # HTTP methods from [RFC 3744: WebDAV Access Control Protocol](https://www.ietf.org/rfc/rfc3744.txt)
+    RFC3744 = %w(ACL)
+    # HTTP methods from [RFC 5323: WebDAV SEARCH](https://www.ietf.org/rfc/rfc5323.txt)
+    RFC5323 = %w(SEARCH)
+    # HTTP methods from [RFC 4791: Calendaring Extensions to WebDAV](https://www.ietf.org/rfc/rfc4791.txt)
+    RFC4791 = %w(MKCALENDAR)
+    # HTTP methods from [RFC 5789: PATCH Method for HTTP](https://www.ietf.org/rfc/rfc5789.txt)
+    RFC5789 = %w(PATCH)
+
+    HTTP_METHODS = RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
+
+    HTTP_METHOD_LOOKUP = {}
+
+    # Populate the HTTP method lookup cache.
+    HTTP_METHODS.each { |method|
+      HTTP_METHOD_LOOKUP[method] = method.underscore.to_sym
+    }
+
+    alias raw_request_method request_method # :nodoc:
+
+    # Returns the HTTP method that the application should see. In the case where the
+    # method was overridden by a middleware (for instance, if a HEAD request was
+    # converted to a GET, or if a _method parameter was used to determine the method
+    # the application should use), this method returns the overridden value, not the
+    # original.
+    def request_method
+      @request_method ||= check_method(super)
+    end
+
+    # Returns the URI pattern of the matched route for the request, using the same
+    # format as `bin/rails routes`:
+    #
+    #     request.route_uri_pattern # => "/:controller(/:action(/:id))(.:format)"
+    def route_uri_pattern
+      get_header("action_dispatch.route_uri_pattern")
+    end
+
+    def route_uri_pattern=(pattern) # :nodoc:
+      set_header("action_dispatch.route_uri_pattern", pattern)
+    end
+
+    def routes # :nodoc:
+      get_header("action_dispatch.routes")
+    end
+
+    def routes=(routes) # :nodoc:
+      set_header("action_dispatch.routes", routes)
+    end
+
+    def engine_script_name(_routes) # :nodoc:
+      get_header(_routes.env_key)
+    end
+
+    def engine_script_name=(name) # :nodoc:
+      set_header(routes.env_key, name.dup)
+    end
+
+    def request_method=(request_method) # :nodoc:
+      if check_method(request_method)
+        @request_method = set_header("REQUEST_METHOD", request_method)
+      end
+    end
+
+    def controller_instance # :nodoc:
+      get_header("action_controller.instance")
+    end
+
+    def controller_instance=(controller) # :nodoc:
+      set_header("action_controller.instance", controller)
+    end
+
+    def http_auth_salt
+      get_header "action_dispatch.http_auth_salt"
+    end
+
+    # Returns a symbol form of the #request_method.
+    def request_method_symbol
+      HTTP_METHOD_LOOKUP[request_method]
+    end
+
+    # Returns the original value of the environment's REQUEST_METHOD, even if it was
+    # overridden by middleware. See #request_method for more information.
+    #
+    # For debugging purposes, when called with arguments this method will fall back
+    # to Object#method
+    def method(*args)
+      if args.empty?
+        @method ||= check_method(
+          get_header("rack.methodoverride.original_method") ||
+          get_header("REQUEST_METHOD")
+        )
+      else
+        super
+      end
+    end
+    ruby2_keywords(:method)
+
+    # Returns a symbol form of the #method.
+    def method_symbol
+      HTTP_METHOD_LOOKUP[method]
+    end
+
+    # Provides access to the request's HTTP headers, for example:
+    #
+    #     request.headers["Content-Type"] # => "text/plain"
+    def headers
+      @headers ||= Http::Headers.new(self)
+    end
+
+    # Early Hints is an HTTP/2 status code that indicates hints to help a client
+    # start making preparations for processing the final response.
+    #
+    # If the env contains `rack.early_hints` then the server accepts HTTP2 push for
+    # link headers.
+    #
+    # The `send_early_hints` method accepts a hash of links as follows:
+    #
+    #     send_early_hints("link" => "</style.css>; rel=preload; as=style,</script.js>; rel=preload")
+    #
+    # If you are using `javascript_include_tag` or `stylesheet_link_tag` the Early
+    # Hints headers are included by default if supported.
+    def send_early_hints(links)
+      env["rack.early_hints"]&.call(links)
+    end
+
+    # Returns a `String` with the last requested path including their params.
+    #
+    #     # get '/foo'
+    #     request.original_fullpath # => '/foo'
+    #
+    #     # get '/foo?bar'
+    #     request.original_fullpath # => '/foo?bar'
+    def original_fullpath
+      @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
+    end
+
+    # Returns the `String` full path including params of the last URL requested.
+    #
+    #     # get "/articles"
+    #     request.fullpath # => "/articles"
+    #
+    #     # get "/articles?page=2"
+    #     request.fullpath # => "/articles?page=2"
+    def fullpath
+      @fullpath ||= super
+    end
+
+    # Returns the original request URL as a `String`.
+    #
+    #     # get "/articles?page=2"
+    #     request.original_url # => "http://www.example.com/articles?page=2"
+    def original_url
+      base_url + original_fullpath
+    end
+
+    # The `String` MIME type of the request.
+    #
+    #     # get "/articles"
+    #     request.media_type # => "application/x-www-form-urlencoded"
+    def media_type
+      content_mime_type&.to_s
+    end
+
+    # Returns the content length of the request as an integer.
+    def content_length
+      return raw_post.bytesize if has_header?(TRANSFER_ENCODING)
+      super.to_i
+    end
+
+    # Returns true if the `X-Requested-With` header contains "XMLHttpRequest"
+    # (case-insensitive), which may need to be manually added depending on the
+    # choice of JavaScript libraries and frameworks.
+    def xml_http_request?
+      /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
+    end
+    alias :xhr? :xml_http_request?
+
+    # Returns the IP address of client as a `String`.
+    def ip
+      @ip ||= super
+    end
+
+    # Returns the IP address of client as a `String`, usually set by the RemoteIp
+    # middleware.
+    def remote_ip
+      @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
+    end
+
+    def remote_ip=(remote_ip)
+      @remote_ip = nil
+      set_header "action_dispatch.remote_ip", remote_ip
+    end
+
+    ACTION_DISPATCH_REQUEST_ID = "action_dispatch.request_id" # :nodoc:
+
+    # Returns the unique request id, which is based on either the `X-Request-Id`
+    # header that can be generated by a firewall, load balancer, or web server, or
+    # by the RequestId middleware (which sets the `action_dispatch.request_id`
+    # environment variable).
+    #
+    # This unique ID is useful for tracing a request from end-to-end as part of
+    # logging or debugging. This relies on the Rack variable set by the
+    # ActionDispatch::RequestId middleware.
+    def request_id
+      get_header ACTION_DISPATCH_REQUEST_ID
+    end
+
+    def request_id=(id) # :nodoc:
+      set_header ACTION_DISPATCH_REQUEST_ID, id
+    end
+
+    alias_method :uuid, :request_id
+
+    # Returns the lowercase name of the HTTP server software.
+    def server_software
+      (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil
+    end
+
+    # Read the request body. This is useful for web services that need to work with
+    # raw requests directly.
+    def raw_post
+      unless has_header? "RAW_POST_DATA"
+        set_header("RAW_POST_DATA", read_body_stream)
+      end
+      get_header "RAW_POST_DATA"
+    end
+
+    # The request body is an IO input stream. If the RAW_POST_DATA environment
+    # variable is already set, wrap it in a StringIO.
+    def body
+      if raw_post = get_header("RAW_POST_DATA")
+        raw_post = (+raw_post).force_encoding(Encoding::BINARY)
+        StringIO.new(raw_post)
+      else
+        body_stream
+      end
+    end
+
+    # Determine whether the request body contains form-data by checking the request
+    # `Content-Type` for one of the media-types: `application/x-www-form-urlencoded`
+    # or `multipart/form-data`. The list of form-data media types can be modified
+    # through the `FORM_DATA_MEDIA_TYPES` array.
+    #
+    # A request body is not assumed to contain form-data when no `Content-Type`
+    # header is provided and the request_method is POST.
+    def form_data?
+      FORM_DATA_MEDIA_TYPES.include?(media_type)
+    end
+
+    def body_stream # :nodoc:
+      get_header("rack.input")
+    end
+
+    def reset_session
+      session.destroy
+      reset_csrf_token
+    end
+
+    def session=(session) # :nodoc:
+      Session.set self, session
+    end
+
+    def session_options=(options)
+      Session::Options.set self, options
+    end
+
+    # Override Rack's GET method to support indifferent access.
+    def GET
+      fetch_header("action_dispatch.request.query_parameters") do |k|
+        rack_query_params = super || {}
+        controller = path_parameters[:controller]
+        action = path_parameters[:action]
+        rack_query_params = Request::Utils.set_binary_encoding(self, rack_query_params, controller, action)
+        # Check for non UTF-8 parameter values, which would cause errors later
+        Request::Utils.check_param_encoding(rack_query_params)
+        set_header k, Request::Utils.normalize_encode_params(rack_query_params)
+      end
+    rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError => e
+      raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
+    end
+    alias :query_parameters :GET
+
+    # Override Rack's POST method to support indifferent access.
+    def POST
+      fetch_header("action_dispatch.request.request_parameters") do
+        pr = parse_formatted_parameters(params_parsers) do |params|
+          super || {}
+        end
+        pr = Request::Utils.set_binary_encoding(self, pr, path_parameters[:controller], path_parameters[:action])
+        Request::Utils.check_param_encoding(pr)
+        self.request_parameters = Request::Utils.normalize_encode_params(pr)
+      end
+    rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError, EOFError => e
+      raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}")
+    end
+    alias :request_parameters :POST
+
+    # Returns the authorization header regardless of whether it was specified
+    # directly or through one of the proxy alternatives.
+    def authorization
+      get_header("HTTP_AUTHORIZATION")   ||
+      get_header("X-HTTP_AUTHORIZATION") ||
+      get_header("X_HTTP_AUTHORIZATION") ||
+      get_header("REDIRECT_X_HTTP_AUTHORIZATION")
+    end
+
+    # True if the request came from localhost, 127.0.0.1, or ::1.
+    def local?
+      LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip)
+    end
+
+    def request_parameters=(params)
+      raise if params.nil?
+      set_header("action_dispatch.request.request_parameters", params)
+    end
+
+    def logger
+      get_header("action_dispatch.logger")
+    end
+
+    def commit_flash
+    end
+
+    def inspect # :nodoc:
+      "#<#{self.class.name} #{method} #{original_url.dump} for #{remote_ip}>"
+    end
+
+    def reset_csrf_token
+      controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token)
+    end
+
+    def commit_csrf_token
+      controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token)
+    end
+
+    private
+      def check_method(name)
+        if name
+          HTTP_METHOD_LOOKUP[name] || raise(ActionController::UnknownHttpMethod, "#{name}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(locale: false)}")
+        end
+
+        name
+      end
+
+      def default_session
+        Session.disabled(self)
+      end
+
+      def read_body_stream
+        if body_stream
+          reset_stream(body_stream) do
+            if has_header?(TRANSFER_ENCODING)
+              body_stream.read # Read body stream until EOF if "Transfer-Encoding" is present
+            else
+              body_stream.read(content_length)
+            end
+          end
+        end
+      end
+
+      def reset_stream(body_stream)
+        if body_stream.respond_to?(:rewind)
+          body_stream.rewind
+
+          content = yield
+
+          body_stream.rewind
+
+          content
+        else
+          yield
+        end
+      end
+  end
+end
+
+ActiveSupport.run_load_hooks :action_dispatch_request, ActionDispatch::Request