rack 1.6.13 → 2.2.3

data/lib/rack/response.rb

@@ -1,6 +1,5 @@
-require 'rack/request'
-require 'rack/utils'
-require 'rack/body_proxy'
+# frozen_string_literal: true
+
 require 'time'
 
 module Rack
@@ -8,7 +7,7 @@ module Rack
   # response.
   #
   # It allows setting of headers and cookies, and provides useful
-  # defaults (a OK response containing HTML).
+  # defaults (an OK response with empty headers and body).
   #
   # You can use Response#write to iteratively generate your response,
   # but note that this is buffered by Rack::Response until you call
@@ -16,147 +15,304 @@ module Rack
   # +write+ are synchronous with the Rack response.
   #
   # Your application's +call+ should end returning Response#finish.
-
   class Response
-    attr_accessor :length
+    def self.[](status, headers, body)
+      self.new(body, status, headers)
+    end
 
-    CHUNKED = 'chunked'.freeze
-    TRANSFER_ENCODING = 'Transfer-Encoding'.freeze
-    def initialize(body=[], status=200, header={})
-      @status = status.to_i
-      @header = Utils::HeaderHash.new.merge(header)
+    CHUNKED = 'chunked'
+    STATUS_WITH_NO_ENTITY_BODY = Utils::STATUS_WITH_NO_ENTITY_BODY
 
-      @chunked = CHUNKED == @header[TRANSFER_ENCODING]
-      @writer  = lambda { |x| @body << x }
-      @block   = nil
-      @length  = 0
+    attr_accessor :length, :status, :body
+    attr_reader :headers
 
-      @body = []
+    # @deprecated Use {#headers} instead.
+    alias header headers
 
-      if body.respond_to? :to_str
-        write body.to_str
-      elsif body.respond_to?(:each)
-        body.each { |part|
-          write part.to_s
-        }
-      else
-        raise TypeError, "stringable or iterable required"
-      end
-
-      yield self  if block_given?
-    end
+    # Initialize the response object with the specified body, status
+    # and headers.
+    #
+    # @param body [nil, #each, #to_str] the response body.
+    # @param status [Integer] the integer status as defined by the
+    # HTTP protocol RFCs.
+    # @param headers [#each] a list of key-value header pairs which
+    # conform to the HTTP protocol RFCs.
+    #
+    # Providing a body which responds to #to_str is legacy behaviour.
+    def initialize(body = nil, status = 200, headers = {})
+      @status = status.to_i
+      @headers = Utils::HeaderHash[headers]
 
-    attr_reader :header
-    attr_accessor :status, :body
+      @writer = self.method(:append)
 
-    def [](key)
-      header[key]
-    end
+      @block = nil
 
-    def []=(key, value)
-      header[key] = value
-    end
+      # Keep track of whether we have expanded the user supplied body.
+      if body.nil?
+        @body = []
+        @buffered = true
+        @length = 0
+      elsif body.respond_to?(:to_str)
+        @body = [body]
+        @buffered = true
+        @length = body.to_str.bytesize
+      else
+        @body = body
+        @buffered = false
+        @length = 0
+      end
 
-    def set_cookie(key, value)
-      Utils.set_cookie_header!(header, key, value)
+      yield self if block_given?
     end
 
-    def delete_cookie(key, value={})
-      Utils.delete_cookie_header!(header, key, value)
+    def redirect(target, status = 302)
+      self.status = status
+      self.location = target
     end
 
-    def redirect(target, status=302)
-      self.status = status
-      self["Location"] = target
+    def chunked?
+      CHUNKED == get_header(TRANSFER_ENCODING)
     end
 
+    # Generate a response array consistent with the requirements of the SPEC.
+    # @return [Array] a 3-tuple suitable of `[status, headers, body]`
+    # which is suitable to be returned from the middleware `#call(env)` method.
     def finish(&block)
-      @block = block
-
-      if [204, 205, 304].include?(status.to_i)
-        header.delete CONTENT_TYPE
-        header.delete CONTENT_LENGTH
+      if STATUS_WITH_NO_ENTITY_BODY[status.to_i]
+        delete_header CONTENT_TYPE
+        delete_header CONTENT_LENGTH
         close
-        [status.to_i, header, []]
+        return [@status, @headers, []]
       else
-        [status.to_i, header, BodyProxy.new(self){}]
+        if block_given?
+          @block = block
+          return [@status, @headers, self]
+        else
+          return [@status, @headers, @body]
+        end
       end
     end
+
     alias to_a finish           # For *response
-    alias to_ary finish         # For implicit-splat on Ruby 1.9.2
 
     def each(&callback)
       @body.each(&callback)
-      @writer = callback
-      @block.call(self)  if @block
+      @buffered = true
+
+      if @block
+        @writer = callback
+        @block.call(self)
+      end
     end
 
     # Append to body and update Content-Length.
     #
     # NOTE: Do not mix #write and direct #body access!
     #
-    def write(str)
-      s = str.to_s
-      @length += Rack::Utils.bytesize(s) unless @chunked
-      @writer.call s
+    def write(chunk)
+      buffered_body!
 
-      header[CONTENT_LENGTH] = @length.to_s unless @chunked
-      str
+      @writer.call(chunk.to_s)
     end
 
     def close
-      body.close if body.respond_to?(:close)
+      @body.close if @body.respond_to?(:close)
     end
 
     def empty?
       @block == nil && @body.empty?
     end
 
-    alias headers header
+    def has_header?(key);   headers.key? key;   end
+    def get_header(key);    headers[key];       end
+    def set_header(key, v); headers[key] = v;   end
+    def delete_header(key); headers.delete key; end
+
+    alias :[] :get_header
+    alias :[]= :set_header
 
     module Helpers
-      def invalid?;            status < 100 || status >= 600;        end
-
-      def informational?;      status >= 100 && status < 200;        end
-      def successful?;         status >= 200 && status < 300;        end
-      def redirection?;        status >= 300 && status < 400;        end
-      def client_error?;       status >= 400 && status < 500;        end
-      def server_error?;       status >= 500 && status < 600;        end
-
-      def ok?;                 status == 200;                        end
-      def created?;            status == 201;                        end
-      def accepted?;           status == 202;                        end
-      def bad_request?;        status == 400;                        end
-      def unauthorized?;       status == 401;                        end
-      def forbidden?;          status == 403;                        end
-      def not_found?;          status == 404;                        end
-      def method_not_allowed?; status == 405;                        end
-      def i_m_a_teapot?;       status == 418;                        end
-      def unprocessable?;      status == 422;                        end
-
-      def redirect?;           [301, 302, 303, 307].include? status; end
-
-      # Headers
-      attr_reader :headers, :original_headers
+      def invalid?;             status < 100 || status >= 600;        end
+
+      def informational?;       status >= 100 && status < 200;        end
+      def successful?;          status >= 200 && status < 300;        end
+      def redirection?;         status >= 300 && status < 400;        end
+      def client_error?;        status >= 400 && status < 500;        end
+      def server_error?;        status >= 500 && status < 600;        end
+
+      def ok?;                  status == 200;                        end
+      def created?;             status == 201;                        end
+      def accepted?;            status == 202;                        end
+      def no_content?;          status == 204;                        end
+      def moved_permanently?;   status == 301;                        end
+      def bad_request?;         status == 400;                        end
+      def unauthorized?;        status == 401;                        end
+      def forbidden?;           status == 403;                        end
+      def not_found?;           status == 404;                        end
+      def method_not_allowed?;  status == 405;                        end
+      def precondition_failed?; status == 412;                        end
+      def unprocessable?;       status == 422;                        end
+
+      def redirect?;            [301, 302, 303, 307, 308].include? status; end
 
       def include?(header)
-        !!headers[header]
+        has_header? header
+      end
+
+      # Add a header that may have multiple values.
+      #
+      # Example:
+      #   response.add_header 'Vary', 'Accept-Encoding'
+      #   response.add_header 'Vary', 'Cookie'
+      #
+      #   assert_equal 'Accept-Encoding,Cookie', response.get_header('Vary')
+      #
+      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
+      def add_header(key, v)
+        if v.nil?
+          get_header key
+        elsif has_header? key
+          set_header key, "#{get_header key},#{v}"
+        else
+          set_header key, v
+        end
       end
 
+      # Get the content type of the response.
       def content_type
-        headers[CONTENT_TYPE]
+        get_header CONTENT_TYPE
+      end
+
+      # Set the content type of the response.
+      def content_type=(content_type)
+        set_header CONTENT_TYPE, content_type
+      end
+
+      def media_type
+        MediaType.type(content_type)
+      end
+
+      def media_type_params
+        MediaType.params(content_type)
       end
 
       def content_length
-        cl = headers[CONTENT_LENGTH]
+        cl = get_header CONTENT_LENGTH
         cl ? cl.to_i : cl
       end
 
       def location
-        headers["Location"]
+        get_header "Location"
+      end
+
+      def location=(location)
+        set_header "Location", location
+      end
+
+      def set_cookie(key, value)
+        cookie_header = get_header SET_COOKIE
+        set_header SET_COOKIE, ::Rack::Utils.add_cookie_to_header(cookie_header, key, value)
+      end
+
+      def delete_cookie(key, value = {})
+        set_header SET_COOKIE, ::Rack::Utils.add_remove_cookie_to_header(get_header(SET_COOKIE), key, value)
+      end
+
+      def set_cookie_header
+        get_header SET_COOKIE
+      end
+
+      def set_cookie_header=(v)
+        set_header SET_COOKIE, v
+      end
+
+      def cache_control
+        get_header CACHE_CONTROL
+      end
+
+      def cache_control=(v)
+        set_header CACHE_CONTROL, v
+      end
+
+      # Specifies that the content shouldn't be cached. Overrides `cache!` if already called.
+      def do_not_cache!
+        set_header CACHE_CONTROL, "no-cache, must-revalidate"
+        set_header EXPIRES, Time.now.httpdate
+      end
+
+      # Specify that the content should be cached.
+      # @param duration [Integer] The number of seconds until the cache expires.
+      # @option directive [String] The cache control directive, one of "public", "private", "no-cache" or "no-store".
+      def cache!(duration = 3600, directive: "public")
+        unless headers[CACHE_CONTROL] =~ /no-cache/
+          set_header CACHE_CONTROL, "#{directive}, max-age=#{duration}"
+          set_header EXPIRES, (Time.now + duration).httpdate
+        end
+      end
+
+      def etag
+        get_header ETAG
+      end
+
+      def etag=(v)
+        set_header ETAG, v
+      end
+
+    protected
+
+      def buffered_body!
+        return if @buffered
+
+        if @body.is_a?(Array)
+          # The user supplied body was an array:
+          @body = @body.compact
+          @body.each do |part|
+            @length += part.to_s.bytesize
+          end
+        else
+          # Turn the user supplied body into a buffered array:
+          body = @body
+          @body = Array.new
+
+          body.each do |part|
+            @writer.call(part.to_s)
+          end
+
+          body.close if body.respond_to?(:close)
+        end
+
+        @buffered = true
+      end
+
+      def append(chunk)
+        @body << chunk
+
+        unless chunked?
+          @length += chunk.bytesize
+          set_header(CONTENT_LENGTH, @length.to_s)
+        end
+
+        return chunk
       end
     end
 
     include Helpers
+
+    class Raw
+      include Helpers
+
+      attr_reader :headers
+      attr_accessor :status
+
+      def initialize(status, headers)
+        @status = status
+        @headers = headers
+      end
+
+      def has_header?(key);   headers.key? key;   end
+      def get_header(key);    headers[key];       end
+      def set_header(key, v); headers[key] = v;   end
+      def delete_header(key); headers.delete key; end
+    end
   end
 end

data/lib/rack/rewindable_input.rb

@@ -1,6 +1,7 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
+
 require 'tempfile'
-require 'rack/utils'
 
 module Rack
   # Class which can make any IO object rewindable, including non-rewindable ones. It does
@@ -40,7 +41,7 @@ module Rack
     end
 
     # Closes this RewindableInput object without closing the originally
-    # wrapped IO oject. Cleans up any temporary resources that this RewindableInput
+    # wrapped IO object. Cleans up any temporary resources that this RewindableInput
     # has created.
     #
     # This method may be called multiple times. It does nothing on subsequent calls.
@@ -57,15 +58,6 @@ module Rack
 
     private
 
-    # Ruby's Tempfile class has a bug. Subclass it and fix it.
-    class Tempfile < ::Tempfile
-      def _close
-        @tmpfile.close if @tmpfile
-        @data[1] = nil if @data
-        @tmpfile = nil
-      end
-    end
-
     def make_rewindable
       # Buffer all data into a tempfile. Since this tempfile is private to this
       # RewindableInput object, we chmod it so that nobody else can read or write
@@ -77,18 +69,16 @@ module Rack
       @rewindable_io.set_encoding(Encoding::BINARY) if @rewindable_io.respond_to?(:set_encoding)
       @rewindable_io.binmode
       if filesystem_has_posix_semantics?
-        # Use ::File.unlink as 1.9.1 Tempfile has a bug where unlink closes the file!
-        ::File.unlink @rewindable_io.path
         raise 'Unlink failed. IO closed.' if @rewindable_io.closed?
         @unlinked = true
       end
 
-      buffer = ""
+      buffer = "".dup
       while @io.read(1024 * 4, buffer)
         entire_buffer_written_out = false
         while !entire_buffer_written_out
           written = @rewindable_io.write(buffer)
-          entire_buffer_written_out = written == Rack::Utils.bytesize(buffer)
+          entire_buffer_written_out = written == buffer.bytesize
           if !entire_buffer_written_out
             buffer.slice!(0 .. written - 1)
           end

data/lib/rack/runtime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   # Sets an "X-Runtime" response header, indicating the response
   # time of the request, in seconds
@@ -6,35 +8,27 @@ module Rack
   # time, or before all the other middlewares to include time for them,
   # too.
   class Runtime
+    FORMAT_STRING = "%0.6f" # :nodoc:
+    HEADER_NAME = "X-Runtime" # :nodoc:
+
     def initialize(app, name = nil)
       @app = app
-      @header_name = "X-Runtime"
-      @header_name << "-#{name}" if name
+      @header_name = HEADER_NAME
+      @header_name += "-#{name}" if name
     end
 
-    FORMAT_STRING = "%0.6f"
     def call(env)
-      start_time = clock_time
+      start_time = Utils.clock_time
       status, headers, body = @app.call(env)
-      request_time = clock_time - start_time
+      headers = Utils::HeaderHash[headers]
 
-      if !headers.has_key?(@header_name)
+      request_time = Utils.clock_time - start_time
+
+      unless headers.key?(@header_name)
         headers[@header_name] = FORMAT_STRING % request_time
       end
 
       [status, headers, body]
     end
-
-    private
-
-    if defined?(Process::CLOCK_MONOTONIC)
-      def clock_time
-        Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      end
-    else
-      def clock_time
-        Time.now.to_f
-      end
-    end
   end
 end

data/lib/rack/sendfile.rb

@@ -1,5 +1,4 @@
-require 'rack/file'
-require 'rack/body_proxy'
+# frozen_string_literal: true
 
 module Rack
 
@@ -14,7 +13,7 @@ module Rack
   #
   # In order to take advantage of this middleware, the response body must
   # respond to +to_path+ and the request must include an X-Sendfile-Type
-  # header. Rack::File and other components implement +to_path+ so there's
+  # header. Rack::Files and other components implement +to_path+ so there's
   # rarely anything you need to do in your application. The X-Sendfile-Type
   # header is typically set in your web servers configuration. The following
   # sections attempt to document
@@ -53,7 +52,7 @@ module Rack
   # that it maps to. The middleware performs a simple substitution on the
   # resulting path.
   #
-  # See Also: http://wiki.codemongers.com/NginxXSendfile
+  # See Also: https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile
   #
   # === lighttpd
   #
@@ -99,9 +98,7 @@ module Rack
   # will be matched with case indifference.
 
   class Sendfile
-    F = ::File
-
-    def initialize(app, variation=nil, mappings=[])
+    def initialize(app, variation = nil, mappings = [])
       @app = app
       @variation = variation
       @mappings = mappings.map do |internal, external|
@@ -114,19 +111,20 @@ module Rack
       if body.respond_to?(:to_path)
         case type = variation(env)
         when 'X-Accel-Redirect'
-          path = F.expand_path(body.to_path)
+          path = ::File.expand_path(body.to_path)
           if url = map_accel_path(env, path)
             headers[CONTENT_LENGTH] = '0'
-            headers[type] = url
+            # '?' must be percent-encoded because it is not query string but a part of path
+            headers[type] = ::Rack::Utils.escape_path(url).gsub('?', '%3F')
             obody = body
             body = Rack::BodyProxy.new([]) do
               obody.close if obody.respond_to?(:close)
             end
           else
-            env['rack.errors'].puts "X-Accel-Mapping header missing"
+            env[RACK_ERRORS].puts "X-Accel-Mapping header missing"
           end
         when 'X-Sendfile', 'X-Lighttpd-Send-File'
-          path = F.expand_path(body.to_path)
+          path = ::File.expand_path(body.to_path)
           headers[CONTENT_LENGTH] = '0'
           headers[type] = path
           obody = body
@@ -135,7 +133,7 @@ module Rack
           end
         when '', nil
         else
-          env['rack.errors'].puts "Unknown x-sendfile variation: '#{type}'.\n"
+          env[RACK_ERRORS].puts "Unknown x-sendfile variation: '#{type}'.\n"
         end
       end
       [status, headers, body]
@@ -149,11 +147,15 @@ module Rack
     end
 
     def map_accel_path(env, path)
-      if mapping = @mappings.find { |internal,_| internal =~ path }
+      if mapping = @mappings.find { |internal, _| internal =~ path }
         path.sub(*mapping)
       elsif mapping = env['HTTP_X_ACCEL_MAPPING']
-        internal, external = mapping.split('=', 2).map{ |p| p.strip }
-        path.sub(/^#{internal}/i, external)
+        mapping.split(',').map(&:strip).each do |m|
+          internal, external = m.split('=', 2).map(&:strip)
+          new_path = path.sub(/^#{internal}/i, external)
+          return new_path unless path == new_path
+        end
+        path
       end
     end
   end