rack 1.5.5 → 1.6.0.beta

data/lib/rack/content_length.rb

@@ -1,4 +1,5 @@
 require 'rack/utils'
+require 'rack/body_proxy'
 
 module Rack
 
@@ -22,7 +23,10 @@ module Rack
         obody = body
         body, length = [], 0
         obody.each { |part| body << part; length += bytesize(part) }
-        obody.close if obody.respond_to?(:close)
+
+        body = BodyProxy.new(body) do
+          obody.close if obody.respond_to?(:close)
+        end
 
         headers['Content-Length'] = length.to_s
       end

data/lib/rack/deflater.rb

@@ -17,19 +17,26 @@ module Rack
   # directive of 'no-transform' is present, or when the response status
   # code is one that doesn't allow an entity body.
   class Deflater
-    def initialize(app)
+    ##
+    # Creates Rack::Deflater middleware.
+    #
+    # [app] rack app instance
+    # [options] hash of deflater options, i.e.
+    #           'if' - a lambda enabling / disabling deflation based on returned boolean value
+    #                  e.g use Rack::Deflater, :if => lambda { |env, status, headers, body| body.length > 512 }
+    #           'include' - a list of content types that should be compressed
+    def initialize(app, options = {})
       @app = app
+
+      @condition = options[:if]
+      @compressible_types = options[:include]
     end
 
     def call(env)
       status, headers, body = @app.call(env)
       headers = Utils::HeaderHash.new(headers)
 
-      # Skip compressing empty entity body responses and responses with
-      # no-transform set.
-      if Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status) ||
-          headers['Cache-Control'].to_s =~ /\bno-transform\b/ ||
-         (headers['Content-Encoding'] && headers['Content-Encoding'] !~ /\bidentity\b/)
+      unless should_deflate?(env, status, headers, body)
         return [status, headers, body]
       end
 
@@ -58,9 +65,9 @@ module Rack
       when "identity"
         [status, headers, body]
       when nil
-        body.close if body.respond_to?(:close)
         message = "An acceptable encoding for the requested resource #{request.fullpath} could not be found."
-        [406, {"Content-Type" => "text/plain", "Content-Length" => message.length.to_s}, [message]]
+        bp = Rack::BodyProxy.new([message]) { body.close if body.respond_to?(:close) }
+        [406, {"Content-Type" => "text/plain", "Content-Length" => message.length.to_s}, bp]
       end
     end
 
@@ -68,6 +75,7 @@ module Rack
       def initialize(body, mtime)
         @body = body
         @mtime = mtime
+        @closed = false
       end
 
       def each(&block)
@@ -79,7 +87,6 @@ module Rack
           gzip.flush
         }
       ensure
-        @body.close if @body.respond_to?(:close)
         gzip.close
         @writer = nil
       end
@@ -87,6 +94,12 @@ module Rack
       def write(data)
         @writer.call(data)
       end
+
+      def close
+        return if @closed
+        @closed = true
+        @body.close if @body.respond_to?(:close)
+      end
     end
 
     class DeflateStream
@@ -100,17 +113,43 @@ module Rack
 
       def initialize(body)
         @body = body
+        @closed = false
       end
 
       def each
-        deflater = ::Zlib::Deflate.new(*DEFLATE_ARGS)
-        @body.each { |part| yield deflater.deflate(part, Zlib::SYNC_FLUSH) }
-        yield deflater.finish
+        deflator = ::Zlib::Deflate.new(*DEFLATE_ARGS)
+        @body.each { |part| yield deflator.deflate(part, Zlib::SYNC_FLUSH) }
+        yield deflator.finish
         nil
       ensure
+        deflator.close
+      end
+
+      def close
+        return if @closed
+        @closed = true
         @body.close if @body.respond_to?(:close)
-        deflater.close
       end
     end
+
+    private
+
+    def should_deflate?(env, status, headers, body)
+      # Skip compressing empty entity body responses and responses with
+      # no-transform set.
+      if Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status) ||
+          headers['Cache-Control'].to_s =~ /\bno-transform\b/ ||
+         (headers['Content-Encoding'] && headers['Content-Encoding'] !~ /\bidentity\b/)
+        return false
+      end
+
+      # Skip if @compressible_types are given and does not include request's content type
+      return false if @compressible_types && !(headers.has_key?('Content-Type') && @compressible_types.include?(headers['Content-Type'][/[^;]*/]))
+
+      # Skip if @condition lambda is given and evaluates to false
+      return false if @condition && !@condition.call(env, status, headers, body)
+
+      true
+    end
   end
 end

data/lib/rack/directory.rb

@@ -135,8 +135,8 @@ table { width:100%%; }
     end
 
     def each
-      show_path = @path.sub(/^#{@root}/,'')
-      files = @files.map{|f| DIR_FILE % f }*"\n"
+      show_path = Rack::Utils.escape_html(@path.sub(/^#{@root}/,''))
+      files = @files.map{|f| DIR_FILE % DIR_FILE_escape(*f) }*"\n"
       page  = DIR_PAGE % [ show_path, show_path , files ]
       page.each_line{|l| yield l }
     end
@@ -157,5 +157,11 @@ table { width:100%%; }
 
       int.to_s + 'B'
     end
+
+    private
+    # Assumes url is already escaped.
+    def DIR_FILE_escape url, *html
+      [url, *html.map { |e| Utils.escape_html(e) }]
+    end
   end
 end

data/lib/rack/etag.rb

@@ -23,8 +23,12 @@ module Rack
       status, headers, body = @app.call(env)
 
       if etag_status?(status) && etag_body?(body) && !skip_caching?(headers)
-        digest, body = digest_body(body)
-        headers['ETag'] = %("#{digest}") if digest
+        original_body = body
+        digest, new_body = digest_body(body)
+        body = Rack::BodyProxy.new(new_body) do
+          original_body.close if original_body.respond_to?(:close)
+        end
+        headers['ETag'] = %(W/"#{digest}") if digest
       end
 
       unless headers['Cache-Control']
@@ -55,10 +59,14 @@ module Rack
 
       def digest_body(body)
         parts = []
-        body.each { |part| parts << part }
-        string_body = parts.join
-        digest = Digest::MD5.hexdigest(string_body) unless string_body.empty?
-        [digest, parts]
+        digest = nil
+
+        body.each do |part|
+          parts << part
+          (digest ||= Digest::MD5.new) << part unless part.empty?
+        end
+
+        [digest && digest.hexdigest, parts]
       end
   end
 end

data/lib/rack/file.rb

@@ -12,8 +12,8 @@ module Rack
   # like sendfile on the +path+.
 
   class File
-    SEPS = Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact)
-    ALLOWED_VERBS = %w[GET HEAD]
+    ALLOWED_VERBS = %w[GET HEAD OPTIONS]
+    ALLOW_HEADER = ALLOWED_VERBS.join(', ')
 
     attr_accessor :root
     attr_accessor :path
@@ -35,20 +35,13 @@ module Rack
 
     def _call(env)
       unless ALLOWED_VERBS.include? env["REQUEST_METHOD"]
-        return fail(405, "Method Not Allowed")
+        return fail(405, "Method Not Allowed", {'Allow' => ALLOW_HEADER})
       end
 
       path_info = Utils.unescape(env["PATH_INFO"])
-      parts = path_info.split SEPS
+      clean_path_info = Utils.clean_path_info(path_info)
 
-      clean = []
-
-      parts.each do |part|
-        next if part.empty? || part == '.'
-        part == '..' ? clean.pop : clean << part
-      end
-
-      @path = F.join(@root, *clean)
+      @path = F.join(@root, clean_path_info)
 
       available = begin
         F.file?(@path) && F.readable?(@path)
@@ -64,6 +57,9 @@ module Rack
     end
 
     def serving(env)
+      if env["REQUEST_METHOD"] == "OPTIONS"
+      	return [200, {'Allow' => ALLOW_HEADER, 'Content-Length' => '0'}, []]
+      end
       last_modified = F.mtime(@path).httpdate
       return [304, {}, []] if env['HTTP_IF_MODIFIED_SINCE'] == last_modified
 
@@ -121,7 +117,7 @@ module Rack
 
     private
 
-    def fail(status, body)
+    def fail(status, body, headers = {})
       body += "\n"
       [
         status,
@@ -129,7 +125,7 @@ module Rack
           "Content-Type" => "text/plain",
           "Content-Length" => body.size.to_s,
           "X-Cascade" => "pass"
-        },
+        }.merge!(headers),
         [body]
       ]
     end

data/lib/rack/handler.rb

@@ -53,6 +53,8 @@ module Rack
         Rack::Handler::FastCGI
       elsif ENV.include?("REQUEST_METHOD")
         Rack::Handler::CGI
+      elsif ENV.include?("RACK_HANDLER")
+        self.get(ENV["RACK_HANDLER"])
       else
         pick ['thin', 'puma', 'webrick']
       end

data/lib/rack/handler/fastcgi.rb

@@ -30,8 +30,11 @@ module Rack
       end
 
       def self.valid_options
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
         {
-          "Host=HOST" => "Hostname to listen on (default: localhost)",
+          "Host=HOST" => "Hostname to listen on (default: #{default_host})",
           "Port=PORT" => "Port to listen on (default: 8080)",
           "File=PATH" => "Creates a Domain socket at PATH instead of a TCP socket. Ignores Host and Port if set.",
         }

data/lib/rack/handler/mongrel.rb

@@ -7,8 +7,11 @@ module Rack
   module Handler
     class Mongrel < ::Mongrel::HttpHandler
       def self.run(app, options={})
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
         server = ::Mongrel::HttpServer.new(
-          options[:Host]           || '0.0.0.0',
+          options[:Host]           || default_host,
           options[:Port]           || 8080,
           options[:num_processors] || 950,
           options[:throttle]       || 0,
@@ -39,8 +42,11 @@ module Rack
       end
 
       def self.valid_options
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
         {
-          "Host=HOST" => "Hostname to listen on (default: localhost)",
+          "Host=HOST" => "Hostname to listen on (default: #{default_host})",
           "Port=PORT" => "Port to listen on (default: 8080)",
           "Processors=N" => "Number of concurrent processors to accept (default: 950)",
           "Timeout=N" => "Time before a request is dropped for inactivity (default: 60)",

data/lib/rack/handler/scgi.rb

@@ -17,8 +17,11 @@ module Rack
       end
 
       def self.valid_options
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
         {
-          "Host=HOST" => "Hostname to listen on (default: localhost)",
+          "Host=HOST" => "Hostname to listen on (default: #{default_host})",
           "Port=PORT" => "Port to listen on (default: 8080)",
         }
       end

data/lib/rack/handler/thin.rb

@@ -6,7 +6,10 @@ module Rack
   module Handler
     class Thin
       def self.run(app, options={})
-        host = options.delete(:Host) || '0.0.0.0'
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
+        host = options.delete(:Host) || default_host
         port = options.delete(:Port) || 8080
         args = [host, port, app, options]
         # Thin versions below 0.8.0 do not support additional options
@@ -17,8 +20,11 @@ module Rack
       end
 
       def self.valid_options
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
         {
-          "Host=HOST" => "Hostname to listen on (default: localhost)",
+          "Host=HOST" => "Hostname to listen on (default: #{default_host})",
           "Port=PORT" => "Port to listen on (default: 8080)",
         }
       end

data/lib/rack/handler/webrick.rb

@@ -2,12 +2,33 @@ require 'webrick'
 require 'stringio'
 require 'rack/content_length'
 
+# This monkey patch allows for applications to perform their own chunking
+# through WEBrick::HTTPResponse iff rack is set to true.
+class WEBrick::HTTPResponse
+  attr_accessor :rack
+
+  alias _rack_setup_header setup_header
+  def setup_header
+    app_chunking = rack && @header['transfer-encoding'] == 'chunked'
+
+    @chunked = app_chunking if app_chunking
+
+    _rack_setup_header
+
+    @chunked = false if app_chunking
+  end
+end
+
 module Rack
   module Handler
     class WEBrick < ::WEBrick::HTTPServlet::AbstractServlet
       def self.run(app, options={})
-        options[:BindAddress] = options.delete(:Host) if options[:Host]
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
+        options[:BindAddress] = options.delete(:Host) || default_host
         options[:Port] ||= 8080
+        options[:OutputBufferSize] = 5
         @server = ::WEBrick::HTTPServer.new(options)
         @server.mount "/", Rack::Handler::WEBrick, app
         yield @server  if block_given?
@@ -15,8 +36,11 @@ module Rack
       end
 
       def self.valid_options
+        environment  = ENV['RACK_ENV'] || 'development'
+        default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
         {
-          "Host=HOST" => "Hostname to listen on (default: localhost)",
+          "Host=HOST" => "Hostname to listen on (default: #{default_host})",
           "Port=PORT" => "Port to listen on (default: 8080)",
         }
       end
@@ -32,6 +56,7 @@ module Rack
       end
 
       def service(req, res)
+        res.rack = true
         env = req.meta_vars
         env.delete_if { |k, v| v.nil? }
 
@@ -46,7 +71,11 @@ module Rack
                      "rack.multiprocess" => false,
                      "rack.run_once" => false,
 
-                     "rack.url_scheme" => ["yes", "on", "1"].include?(ENV["HTTPS"]) ? "https" : "http"
+                     "rack.url_scheme" => ["yes", "on", "1"].include?(env["HTTPS"]) ? "https" : "http",
+
+                     "rack.hijack?" => true,
+                     "rack.hijack" => lambda { raise NotImplementedError, "only partial hijack is supported."},
+                     "rack.hijack_io" => nil,
                    })
 
         env["HTTP_VERSION"] ||= env["SERVER_PROTOCOL"]
@@ -61,6 +90,8 @@ module Rack
         begin
           res.status = status.to_i
           headers.each { |k, vs|
+            next if k.downcase == "rack.hijack"
+
             if k.downcase == "set-cookie"
               res.cookies.concat vs.split("\n")
             else
@@ -69,9 +100,18 @@ module Rack
               res[k] = vs.split("\n").join(", ")
             end
           }
-          body.each { |part|
-            res.body << part
-          }
+
+          io_lambda = headers["rack.hijack"]
+          if io_lambda
+            rd, wr = IO.pipe
+            res.body = rd
+            res.chunked = true
+            io_lambda.call wr
+          else
+            body.each { |part|
+              res.body << part
+            }
+          end
         ensure
           body.close  if body.respond_to? :close
         end

data/lib/rack/head.rb

@@ -1,3 +1,5 @@
+require 'rack/body_proxy'
+
 module Rack
 
 class Head
@@ -11,8 +13,11 @@ class Head
     status, headers, body = @app.call(env)
 
     if env["REQUEST_METHOD"] == "HEAD"
-      body.close if body.respond_to? :close
-      [status, headers, []]
+      [
+        status, headers, Rack::BodyProxy.new([]) do
+          body.close if body.respond_to? :close
+        end
+      ]
     else
       [status, headers, body]
     end