rack 1.4.7 → 1.5.0.beta.1

data/lib/rack/handler/thin.rb

@@ -6,9 +6,12 @@ module Rack
   module Handler
     class Thin
       def self.run(app, options={})
-        server = ::Thin::Server.new(options[:Host] || '0.0.0.0',
-                                    options[:Port] || 8080,
-                                    app)
+        host = options.delete(:Host) || '0.0.0.0'
+        port = options.delete(:Port) || 8080
+        args = [host, port, app, options]
+        # Thin versions below 0.8.0 do not support additional options
+        args.pop if ::Thin::VERSION::MAJOR < 1 && ::Thin::VERSION::MINOR < 8
+        server = ::Thin::Server.new(*args)
         yield server if block_given?
         server.start
       end

data/lib/rack/handler/webrick.rb

@@ -7,6 +7,7 @@ module Rack
     class WEBrick < ::WEBrick::HTTPServlet::AbstractServlet
       def self.run(app, options={})
         options[:BindAddress] = options.delete(:Host) if options[:Host]
+        options[:Port] ||= 8080
         @server = ::WEBrick::HTTPServer.new(options)
         @server.mount "/", Rack::Handler::WEBrick, app
         yield @server  if block_given?

data/lib/rack/head.rb

@@ -1,6 +1,8 @@
 module Rack
 
 class Head
+  # Rack::Head returns an empty body for all HEAD requests. It leaves
+  # all other requests unchanged.
   def initialize(app)
     @app = app
   end

data/lib/rack/lint.rb

@@ -1,4 +1,5 @@
 require 'rack/utils'
+require 'forwardable'
 
 module Rack
   # Rack::Lint validates your application and the requests and
@@ -50,6 +51,9 @@ module Rack
       check_status status
       ## the *headers*,
       check_headers headers
+
+      check_hijack_response headers, env
+
       ## and the *body*.
       check_content_type status, headers
       check_content_length status, headers
@@ -108,7 +112,8 @@ module Rack
       ##                            variables should correspond with
       ##                            the presence or absence of the
       ##                            appropriate HTTP header in the
-      ##                            request.
+      ##                            request. See <a href="https://tools.ietf.org/html/rfc3875#section-4.1.18">
+      ##                            RFC3875 section 4.1.18</a> for specific behavior.
 
       ## In addition to this, the Rack environment must include these
       ## Rack-specific variables:
@@ -120,6 +125,9 @@ module Rack
       ## <tt>rack.multithread</tt>:: true if the application object may be simultaneously invoked by another thread in the same process, false otherwise.
       ## <tt>rack.multiprocess</tt>:: true if an equivalent application object may be simultaneously invoked by another process, false otherwise.
       ## <tt>rack.run_once</tt>:: true if the server expects (but does not guarantee!) that the application will only be invoked this one time during the life of its containing process. Normally, this will only be true for a server based on CGI (or something similar).
+      ## <tt>rack.hijack?</tt>:: present and true if the server supports connection hijacking. See below, hijacking.
+      ## <tt>rack.hijack</tt>:: an object responding to #call that must be called at least once before using rack.hijack_io. It is recommended #call return rack.hijack_io as well as setting it in env if necessary.
+      ## <tt>rack.hijack_io</tt>:: if rack.hijack? is true, and rack.hijack has received #call, this will contain an object resembling an IO. See hijacking.
       ##
 
       ## Additional environment specifications have approved to
@@ -226,6 +234,8 @@ module Rack
       check_input env["rack.input"]
       ## * There must be a valid error stream in <tt>rack.errors</tt>.
       check_error env["rack.errors"]
+      ## * There may be a valid hijack stream in <tt>rack.hijack_io</tt>
+      check_hijack env
 
       ## * The <tt>REQUEST_METHOD</tt> must be a valid token.
       assert("REQUEST_METHOD unknown: #{env["REQUEST_METHOD"]}") {
@@ -416,6 +426,121 @@ module Rack
       end
     end
 
+    class HijackWrapper
+      include Assertion
+      extend Forwardable
+
+      REQUIRED_METHODS = [
+        :read, :write, :read_nonblock, :write_nonblock, :flush, :close,
+        :close_read, :close_write, :closed?
+      ]
+
+      def_delegators :@io, *REQUIRED_METHODS
+
+      def initialize(io)
+        @io = io
+        REQUIRED_METHODS.each do |meth|
+          assert("rack.hijack_io must respond to #{meth}") { io.respond_to? meth }
+        end
+      end
+    end
+
+    ## === Hijacking
+    #
+    # AUTHORS: n.b. The trailing whitespace between paragraphs is important and
+    # should not be removed. The whitespace creates paragraphs in the RDoc
+    # output.
+    #
+    ## ==== Request (before status)
+    def check_hijack(env)
+      if env['rack.hijack?']
+        ## If rack.hijack? is true then rack.hijack must respond to #call.
+        original_hijack = env['rack.hijack']
+        assert("rack.hijack must respond to call") { original_hijack.respond_to?(:call) }
+        env['rack.hijack'] = proc do
+          ## rack.hijack must return the io that will also be assigned (or is
+          ## already present, in rack.hijack_io.
+          io = original_hijack.call
+          HijackWrapper.new(io)
+          ## 
+          ## rack.hijack_io must respond to:
+          ## <tt>read, write, read_nonblock, write_nonblock, flush, close,
+          ## close_read, close_write, closed?</tt>
+          ## 
+          ## The semantics of these IO methods must be a best effort match to
+          ## those of a normal ruby IO or Socket object, using standard
+          ## arguments and raising standard exceptions. Servers are encouraged
+          ## to simply pass on real IO objects, although it is recognized that
+          ## this approach is not directly compatible with SPDY and HTTP 2.0.
+          ## 
+          ## IO provided in rack.hijack_io should preference the
+          ## IO::WaitReadable and IO::WaitWritable APIs wherever supported.
+          ## 
+          ## There is a deliberate lack of full specification around
+          ## rack.hijack_io, as semantics will change from server to server.
+          ## Users are encouraged to utilize this API with a knowledge of their
+          ## server choice, and servers may extend the functionality of
+          ## hijack_io to provide additional features to users. The purpose of
+          ## rack.hijack is for Rack to "get out of the way", as such, Rack only
+          ## provides the minimum of specification and support.
+          env['rack.hijack_io'] = HijackWrapper.new(env['rack.hijack_io'])
+          io
+        end
+      else
+        ## 
+        ## If rack.hijack? is false, then rack.hijack should not be set.
+        assert("rack.hijack? is false, but rack.hijack is present") { env['rack.hijack'].nil? }
+        ## 
+        ## If rack.hijack? is false, then rack.hijack_io should not be set.
+        assert("rack.hijack? is false, but rack.hijack_io is present") { env['rack.hijack_io'].nil? }
+      end
+    end
+
+    ## ==== Response (after headers)
+    ## It is also possible to hijack a response after the status and headers
+    ## have been sent.
+    def check_hijack_response(headers, env)
+      ## In order to do this, an application may set the special header
+      ## <tt>rack.hijack</tt> to an object that responds to <tt>call</tt>
+      ## accepting an argument that conforms to the <tt>rack.hijack_io</tt>
+      ## protocol.
+      ## 
+      ## After the headers have been sent, and this hijack callback has been
+      ## called, the application is now responsible for the remaining lifecycle
+      ## of the IO. The application is also responsible for maintaining HTTP
+      ## semantics. Of specific note, in almost all cases in the current SPEC,
+      ## applications will have wanted to specify the header Connection:close in
+      ## HTTP/1.1, and not Connection:keep-alive, as there is no protocol for
+      ## returning hijacked sockets to the web server. For that purpose, use the
+      ## body streaming API instead (progressively yielding strings via each).
+      ## 
+      ## Servers must ignore the <tt>body</tt> part of the response tuple when
+      ## the <tt>rack.hijack</tt> response API is in use.
+
+      if env['rack.hijack?'] && headers['rack.hijack']
+        assert('rack.hijack header must respond to #call') {
+          headers['rack.hijack'].respond_to? :call
+        }
+        original_hijack = headers['rack.hijack']
+        headers['rack.hijack'] = proc do |io|
+          original_hijack.call HijackWrapper.new(io)
+        end
+      else
+        ## 
+        ## The special response header <tt>rack.hijack</tt> must only be set
+        ## if the request env has <tt>rack.hijack?</tt> <tt>true</tt>.
+        assert('rack.hijack header must not be present if server does not support hijacking') {
+          headers['rack.hijack'].nil?
+        }
+      end
+    end
+    ## ==== Conventions
+    ## * Middleware should not use hijack unless it is handling the whole
+    ##   response.
+    ## * Middleware may wrap the IO object for the response pattern.
+    ## * Middleware should not wrap the IO object for the request pattern. The
+    ##   request pattern is intended to provide the hijacker with "raw tcp".
+
     ## == The Response
 
     ## === The Status
@@ -432,6 +557,10 @@ module Rack
          header.respond_to? :each
       }
       header.each { |key, value|
+        ## Special headers starting "rack." are for communicating with the
+        ## server, and must not be sent back to the client.
+        next if key =~ /^rack\..+$/
+
         ## The header keys must be Strings.
         assert("header key must be a string, was #{key.class}") {
           key.kind_of? String
@@ -463,9 +592,8 @@ module Rack
     ## === The Content-Type
     def check_content_type(status, headers)
       headers.each { |key, value|
-        ## There must be a <tt>Content-Type</tt>, except when the
-        ## +Status+ is 1xx, 204, 205 or 304, in which case there must be none
-        ## given.
+        ## There must not be a <tt>Content-Type</tt>, when the +Status+ is 1xx,
+        ## 204, 205 or 304.
         if key.downcase == "content-type"
           assert("Content-Type header found in #{status} response, not allowed") {
             not Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
@@ -473,9 +601,6 @@ module Rack
           return
         end
       }
-      assert("No Content-Type header found") {
-        Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
-      }
     end
 
     ## === The Content-Length

data/lib/rack/lobster.rb

@@ -59,7 +59,7 @@ end
 if $0 == __FILE__
   require 'rack'
   require 'rack/showexceptions'
-  Rack::Handler::WEBrick.run \
-    Rack::ShowExceptions.new(Rack::Lint.new(Rack::Lobster.new)),
-    :Port => 9292
+  Rack::Server.start(
+    :app => Rack::ShowExceptions.new(Rack::Lint.new(Rack::Lobster.new)), :Port => 9292
+  )
 end

data/lib/rack/lock.rb

@@ -2,6 +2,8 @@ require 'thread'
 require 'rack/body_proxy'
 
 module Rack
+  # Rack::Lock locks every request inside a mutex, so that every request
+  # will effectively be executed synchronously.
   class Lock
     FLAG = 'rack.multithread'.freeze
 

data/lib/rack/methodoverride.rb

@@ -26,8 +26,6 @@ module Rack
       method = req.POST[METHOD_OVERRIDE_PARAM_KEY] ||
         env[HTTP_METHOD_OVERRIDE_HEADER]
       method.to_s.upcase
-    rescue EOFError
-      ""
     end
   end
 end

data/lib/rack/mime.rb

@@ -18,6 +18,35 @@ module Rack
     end
     module_function :mime_type
 
+    # Returns true if the given value is a mime match for the given mime match
+    # specification, false otherwise.
+    #
+    #    Rack::Mime.match?('text/html', 'text/*') => true
+    #    Rack::Mime.match?('text/plain', '*') => true
+    #    Rack::Mime.match?('text/html', 'application/json') => false
+
+    def match?(value, matcher)
+      v1, v2 = value.split('/', 2)
+      m1, m2 = matcher.split('/', 2)
+
+      if m1 == '*'
+        if m2.nil? || m2 == '*'
+          return true
+        elsif m2 == v2
+          return true
+        else
+          return false
+        end
+      end
+
+      return false if v1 != m1
+
+      return true if m2.nil? || m2 == '*'
+
+      m2 == v2
+    end
+    module_function :match?
+
     # List of most common mime-types, selected various sources
     # according to their usefulness in a webserving scope for Ruby
     # users.

data/lib/rack/multipart/parser.rb

@@ -2,8 +2,6 @@ require 'rack/utils'
 
 module Rack
   module Multipart
-    class MultipartLimitError < Errno::EMFILE; end
-
     class Parser
       BUFSIZE = 16384
 
@@ -16,17 +14,10 @@ module Rack
 
         fast_forward_to_first_boundary
 
-        opened_files = 0
         loop do
-
           head, filename, content_type, name, body =
             get_current_head_and_filename_and_content_type_and_name_and_body
 
-          if Utils.multipart_part_limit > 0
-            opened_files += 1 if filename
-            raise MultipartLimitError, 'Maximum file multiparts in content reached' if opened_files >= Utils.multipart_part_limit
-          end
-
           # Save the rest.
           if i = @buf.index(rx)
             body << @buf.slice!(0, i)

data/lib/rack/request.rb

@@ -98,10 +98,8 @@ module Rack
         port.to_i
       elsif port = @env['HTTP_X_FORWARDED_PORT']
         port.to_i
-      elsif ssl?
-        443
       elsif @env.has_key?("HTTP_X_FORWARDED_HOST")
-        80
+        DEFAULT_PORTS[scheme]
       else
         @env["SERVER_PORT"].to_i
       end
@@ -118,25 +116,25 @@ module Rack
 
     # Checks the HTTP request method (or verb) to see if it was of type DELETE
     def delete?;  request_method == "DELETE"  end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type GET
     def get?;     request_method == "GET"     end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type HEAD
     def head?;    request_method == "HEAD"    end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type OPTIONS
     def options?; request_method == "OPTIONS" end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type PATCH
     def patch?;   request_method == "PATCH"   end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type POST
     def post?;    request_method == "POST"    end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type PUT
     def put?;     request_method == "PUT"     end
-    
+
     # Checks the HTTP request method (or verb) to see if it was of type TRACE
     def trace?;   request_method == "TRACE"   end
 
@@ -157,6 +155,10 @@ module Rack
       'multipart/mixed'
     ]
 
+    # Default ports depending on scheme. Used to decide whether or not
+    # to include the port in a generated URI.
+    DEFAULT_PORTS = { 'http' => 80, 'https' => 443, 'coffee' => 80 }
+
     # 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
@@ -217,10 +219,45 @@ module Rack
     end
 
     # The union of GET and POST data.
+    #
+    # Note that modifications will not be persisted in the env. Use update_param or delete_param if you want to destructively modify params.
     def params
       @params ||= self.GET.merge(self.POST)
     rescue EOFError
-      self.GET
+      self.GET.dup
+    end
+
+    # Destructively update a parameter, whether it's in GET and/or POST. Returns nil.
+    #
+    # The parameter is updated wherever it was previous defined, so GET, POST, or both. If it wasn't previously defined, it's inserted into GET.
+    #
+    # env['rack.input'] is not touched.
+    def update_param(k, v)
+      found = false
+      if self.GET.has_key?(k)
+        found = true
+        self.GET[k] = v
+      end
+      if self.POST.has_key?(k)
+        found = true
+        self.POST[k] = v
+      end
+      unless found
+        self.GET[k] = v
+      end
+      @params = nil
+      nil
+    end
+
+    # Destructively delete a parameter, whether it's in GET or POST. Returns the value of the deleted parameter.
+    #
+    # If the parameter is in both GET and POST, the POST value takes precedence since that's how #params works.
+    #
+    # env['rack.input'] is not touched.
+    def delete_param(k)
+      v = [ self.POST.delete(k), self.GET.delete(k) ].compact.first
+      @params = nil
+      v
     end
 
     # shortcut for request.params[key]
@@ -229,6 +266,8 @@ module Rack
     end
 
     # shortcut for request.params[key] = value
+    #
+    # Note that modifications will not be persisted in the env. Use update_param or delete_param if you want to destructively modify params.
     def []=(key, value)
       params[key.to_s] = value
     end
@@ -271,14 +310,8 @@ module Rack
     end
 
     def base_url
-      url = scheme + "://"
-      url << host
-
-      if scheme == "https" && port != 443 ||
-          scheme == "http" && port != 80
-        url << ":#{port}"
-      end
-
+      url = "#{scheme}://#{host}"
+      url << ":#{port}" if port != DEFAULT_PORTS[scheme]
       url
     end
 
@@ -307,16 +340,16 @@ module Rack
     end
 
     def trusted_proxy?(ip)
-      ip =~ /^127\.0\.0\.1$|^(10|172\.(1[6-9]|2[0-9]|30|31)|192\.168)\.|^::1$|^fd[0-9a-f]{2}:.+|^localhost$/i
+      ip =~ /^127\.0\.0\.1$|^(10|172\.(1[6-9]|2[0-9]|30|31)|192\.168)\.|^::1$|^fd[0-9a-f]{2}:.+|^localhost$|^unix$|^unix:/i
     end
 
     def ip
-      remote_addrs = @env['REMOTE_ADDR'] ? @env['REMOTE_ADDR'].split(/[,\s]+/) : []
-      remote_addrs.reject! { |addr| trusted_proxy?(addr) }
-      
+      remote_addrs = split_ip_addresses(@env['REMOTE_ADDR'])
+      remote_addrs = reject_trusted_ip_addresses(remote_addrs)
+
       return remote_addrs.first if remote_addrs.any?
 
-      forwarded_ips = @env['HTTP_X_FORWARDED_FOR'] ? @env['HTTP_X_FORWARDED_FOR'].strip.split(/[,\s]+/) : []
+      forwarded_ips = split_ip_addresses(@env['HTTP_X_FORWARDED_FOR'])
 
       if client_ip = @env['HTTP_CLIENT_IP']
         # If forwarded_ips doesn't include the client_ip, it might be an
@@ -324,10 +357,18 @@ module Rack
         return client_ip if forwarded_ips.include?(client_ip)
       end
 
-      return forwarded_ips.reject { |ip| trusted_proxy?(ip) }.last || @env["REMOTE_ADDR"]
+      return reject_trusted_ip_addresses(forwarded_ips).last || @env["REMOTE_ADDR"]
     end
 
     protected
+      def split_ip_addresses(ip_addresses)
+        ip_addresses ? ip_addresses.strip.split(/[,\s]+/) : []
+      end
+
+      def reject_trusted_ip_addresses(ip_addresses)
+        ip_addresses.reject { |ip| trusted_proxy?(ip) }
+      end
+
       def parse_query(qs)
         Utils.parse_nested_query(qs)
       end