thin 0.4.1 → 0.5.0

data/lib/thin/response.rb

@@ -1,23 +1,17 @@
 module Thin
   # A response sent to the client.
   class Response
-    CONNECTION = 'Connection'.freeze
-    CLOSE = 'close'.freeze
+    CONTENT_LENGTH = 'Content-Length'.freeze
+    CONNECTION     = 'Connection'.freeze
+    CLOSE          = 'close'.freeze
     
-    attr_accessor :body, :headers, :status
+    attr_accessor :status
+    attr_reader   :headers, :body
     
     def initialize
       @headers = Headers.new
-      @body = StringIO.new
-      @status = 200
-    end
-    
-    def content_type=(type)
-      @headers[CONTENT_TYPE] = type
-    end
-    
-    def content_type
-      @headers[CONTENT_TYPE]
+      @body    = StringIO.new
+      @status  = 200
     end
     
     def headers_output
@@ -30,25 +24,27 @@ module Thin
       "HTTP/1.1 #{@status} #{HTTP_STATUS_CODES[@status.to_i]}\r\n#{headers_output}\r\n"
     end
     
-    def write(socket)
-      socket << head
-      @body.rewind
-      socket << @body.read
+    def headers=(key_value_pairs)
+      key_value_pairs.each do |k, vs|
+        vs.each do |v|
+          @headers[k] = v
+        end
+      end
     end
     
-    def close
-      @body.close
+    def body=(stream)
+      stream.each do |part|
+        @body << part
+      end
     end
     
-    def start(status)
-      @status = status
-      yield @headers, @body
+    def close
+      @body.close
     end
     
     def to_s
-      out = ''
-      write out
-      out
+      @body.rewind
+      head + @body.read
     end
   end
 end

data/lib/thin/server.rb

@@ -1,6 +1,7 @@
-require 'socket'
-
 module Thin
+  # Raise when we require the server to stop
+  class StopServer < Exception; end
+  
   # The Thin HTTP server used to served request.
   # It listen for incoming request on a given port
   # and forward all request to all the handlers in the order
@@ -14,36 +15,25 @@ module Thin
     # Addresse and port on which the server is listening for connections.
     attr_accessor :port, :host
     
-    # List of handlers to process the request in the order they are given.
-    attr_accessor :handlers
+    # App called with the request that produce the response.
+    attr_accessor :app
     
     # Maximum time for a request to be red and parsed.
     attr_accessor :timeout
     
     # Creates a new server binded to <tt>host:port</tt>
-    # that will pass request to +handlers+.
-    def initialize(host, port, *handlers)
+    # that will pass request to +app+.
+    def initialize(host, port, app)
       @host       = host
-      @port       = port
-      @handlers   = handlers
-      @timeout    = 60     # sec, max time to read and parse a request
-      @trace      = false
-
-      @stop       = true   # true is server is stopped
-      @processing = false  # true is processing a request
-
-      @socket     = TCPServer.new(host, port)
+      @port       = port.to_i
+      @app        = app
+      @timeout    = 60 # sec
     end
     
     # Starts the handlers.
     def start
       log   ">> Thin web server (v#{VERSION::STRING})"
       trace ">> Tracing ON"
-
-      @handlers.each do |handler|
-        log ">> Starting #{handler} ..."
-        handler.start
-      end
     end
     
     # Start the server and listen for connections
@@ -54,88 +44,34 @@ module Thin
     
     # Start listening for connections
     def listen!
-      @stop = false
-      trap('INT') do
-        log '>> Caught INT signal, stopping ...'
-        stop
-      end
-      
-      log ">> Listening on #{host}:#{port}, CTRL+C to stop"
-      until @stop
-        @processing = false
-        client = @socket.accept rescue nil
-        break if @socket.closed? || client.nil?
-        @processing = true
-        process(client)
-      end
-    ensure
-      @socket.close unless @socket.closed? rescue nil
-    end
-    
-    # Process one request from a client 
-    def process(client)
-      return if client.eof?
-      
-      trace { 'Request started'.center(80, '=') }
-
-      request  = Request.new
-      response = Response.new
-      
-      request.trace = @trace
-      trace { ">> Tracing request parsing ... " }
-
-      # Parse the request checking for timeout to prevent DOS attacks
-      Timeout.timeout(@timeout) { request.parse!(client) }
-      trace { request.raw }
-      
-      # Add client info to the request env
-      request.params['REMOTE_ADDR'] = client.peeraddr.last
-      
-      # Add server info to the request env
-      request.params['SERVER_SOFTWARE'] = SERVER
-      request.params['SERVER_PORT']     = @port.to_s
-      
-      served = false
-      @handlers.each do |handler|
-        served = handler.process(request, response)
-        break if served
-      end
-      
-      if served
-        trace { ">> Sending response:\n" + response.to_s }
-        response.write client
-      else
-        client << ERROR_404_RESPONSE
-      end
+      trap('INT')  { stop }
+			trap('TERM') { stop! }
       
-      trace { 'Request finished'.center(80, '=') }
+      # See http://rubyeventmachine.com/pub/rdoc/files/EPOLL.html
+      EventMachine.epoll
 
-    rescue EOFError, Errno::ECONNRESET, Errno::EPIPE, Errno::EINVAL, Errno::EBADF
-      # Can't do anything sorry, closing the socket in the ensure block
-    rescue InvalidRequest => e
-      log "Invalid request: #{e.message}"
-      trace { e.backtrace.join("\n") }
-      client << ERROR_400_RESPONSE rescue nil
-    rescue Object => e
-      log "Unexpected error while processing request: #{e.message}"
-      log e.backtrace.join("\n")
-    ensure
-      request.close  if request            rescue nil
-      response.close if response           rescue nil
-      client.close   unless client.closed? rescue nil
+			EventMachine.run do
+				begin
+				  log ">> Listening on #{@host}:#{@port}, CTRL+C to stop"
+					EventMachine.start_server(@host, @port, Connection) do |connection|
+					  connection.comm_inactivity_timeout = @timeout
+					  connection.app                     = @app
+					  connection.silent                  = @silent
+					end
+				rescue StopServer
+					EventMachine.stop_event_loop
+				end
+			end
     end
     
-    # Stop the server from accepting new request.
-    # If a request is processing, wait for this to finish
-    # and shutdown the server.
     def stop
-      @stop = true
-      stop! unless @processing  # Not processing a request, so we can stop now
+      EventMachine.stop_event_loop
+    rescue
+      warn "Error stopping : #{$!}"
     end
     
-    # Force the server to stop right now!
     def stop!
-      @socket.close rescue nil # break the accept loop by closing the socket
+      raise StopServer
     end
   end
 end

data/lib/thin/version.rb

@@ -1,8 +1,8 @@
 module Thin
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 4
-    TINY  = 1
+    MINOR = 5
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/daemonizing_spec.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'Daemonizing' do
+  before do
+    @server = Server.new('0.0.0.0', 3000, nil)
+    @server.log_file = File.dirname(__FILE__) + '/../log/daemonizing_test.log'
+    @server.pid_file = 'test.pid'
+    @pid = nil
+  end
+  
+  it 'should have a pid file' do
+    @server.should respond_to(:pid_file)
+    @server.should respond_to(:pid_file=)
+  end
+  
+  it 'should create a pid file' do
+    @pid = fork do
+      @server.daemonize
+      sleep 1
+    end
+    
+    Process.wait(@pid)
+    File.exist?(@server.pid_file).should be_true
+    @pid = @server.pid
+
+    proc { sleep 0.1 while File.exist?(@server.pid_file) }.should take_less_then(2)
+  end
+  
+  it 'should redirect stdio to a log file' do
+    @pid = fork do
+      @server.log_file = 'daemon_test.log'
+      @server.daemonize
+
+      puts "simple puts"
+      STDERR.puts "STDERR.puts"
+      STDOUT.puts "STDOUT.puts"
+    end
+    Process.wait(@pid)
+    
+    # Wait for the file to close and magical stuff to happen
+    proc { sleep 0.1 until File.exist?('daemon_test.log') }.should take_less_then(3)
+    sleep 0.5
+    
+    log = File.read('daemon_test.log')
+    log.should include('simple puts', 'STDERR.puts', 'STDOUT.puts')
+    
+    File.delete 'daemon_test.log'
+  end
+  
+  it 'should change privilege' do
+    @pid = fork do
+      @server.daemonize
+      @server.change_privilege('root', 'admin')
+    end
+    Process.wait(@pid)
+    $?.should be_a_success
+  end
+  
+  it 'should kill process in pid file' do
+    @pid = fork do
+      @server.daemonize
+      loop { sleep 1 }
+    end
+  
+    proc { sleep 0.1 until File.exist?(@server.pid_file) }.should take_less_then(3)
+  
+    silence_stream STDOUT do
+      Server.kill(@server.pid_file, 1)
+    end
+  
+    File.exist?(@server.pid_file).should_not be_true
+  end
+  
+  it 'should send kill signal if timeout' do
+    @pid = fork do
+      @server.should_receive(:stop) # pretend we cannot handle the INT signal
+      @server.daemonize
+      sleep 5
+    end
+  
+    proc { sleep 0.1 until File.exist?(@server.pid_file) }.should take_less_then(10)
+  
+    silence_stream STDOUT do
+      Server.kill(@server.pid_file, 1)
+    end
+  
+    File.exist?(@server.pid_file).should be_false
+    Process.running?(@pid).should be_false
+  end
+  
+  after do
+    Process.kill(9, @pid.to_i) if @pid && Process.running?(@pid.to_i)
+  end
+end

data/spec/headers_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Headers do
+  before do
+    @headers = Headers.new
+  end
+  
+  it 'should allow duplicate on some fields' do
+    @headers['Set-Cookie'] = 'twice'
+    @headers['Set-Cookie'] = 'is cooler the once'
+    
+    @headers.size.should == 2
+  end
+  
+  it 'should overwrite value on non duplicate fields' do
+    @headers['Host'] = 'this is unique'
+    @headers['Host'] = 'so is this'
+    @headers['Host'] = 'so this will overwrite ^'
+
+    @headers['Host'].should == 'so this will overwrite ^'
+  end
+  
+  it 'should return first header value' do
+    @headers['Set-Cookie'] = 'hi'
+    @headers['Set-Cookie'].should == 'hi'
+  end
+  
+  it 'should output to string' do
+    @headers['Host'] = 'localhost:3000'
+    @headers['Set-Cookie'] = 'twice'
+    @headers['Set-Cookie'] = 'is cooler the once'
+    
+    @headers.to_s.should == "Host: localhost:3000\r\nSet-Cookie: twice\r\nSet-Cookie: is cooler the once\r\n"
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,258 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'digest/sha1'
+
+describe Request do
+  it 'should include basic headers' do
+    request = R("GET / HTTP/1.1\r\nHost: localhost\r\n\r\n")
+    request.env['SERVER_PROTOCOL'].should == 'HTTP/1.1'
+    request.env['REQUEST_PATH'].should == '/'
+    request.env['HTTP_VERSION'].should == 'HTTP/1.1'
+    request.env['REQUEST_URI'].should == '/'
+    request.env['GATEWAY_INTERFACE'].should == 'CGI/1.2'
+    request.env['REQUEST_METHOD'].should == 'GET'
+    request.env["rack.url_scheme"].should == 'http'
+    request.env['FRAGMENT'].to_s.should be_empty
+    request.env['QUERY_STRING'].to_s.should be_empty
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should not prepend HTTP_ to Content-Type and Content-Length' do
+    request = R("POST / HTTP/1.1\r\nHost: localhost\r\nContent-Type: text/html\r\nContent-Length: 2\r\n\r\naa")
+    request.env.keys.should_not include('HTTP_CONTENT_TYPE', 'HTTP_CONTENT_LENGTH')
+    request.env.keys.should include('CONTENT_TYPE', 'CONTENT_LENGTH')
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should raise error on invalid request line' do
+    proc { R("GET / SsUTF/1.1") }.should raise_error(InvalidRequest)
+    proc { R("GET / HTTP/1.1yousmelllikecheeze") }.should raise_error(InvalidRequest)
+  end
+  
+  it 'should support fragment in uri' do
+    request = R("GET /forums/1/topics/2375?page=1#posts-17408 HTTP/1.1\r\nHost: localhost\r\n\r\n")
+
+    request.env['REQUEST_URI'].should == '/forums/1/topics/2375?page=1'
+    request.env['PATH_INFO'].should == '/forums/1/topics/2375'
+    request.env['QUERY_STRING'].should == 'page=1'
+    request.env['FRAGMENT'].should == 'posts-17408'
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should parse path with query string' do
+    request = R("GET /index.html?234235 HTTP/1.1\r\nHost: localhost\r\n\r\n")
+    request.env['REQUEST_PATH'].should == '/index.html'
+    request.env['QUERY_STRING'].should == '234235'
+    request.env['FRAGMENT'].should be_nil
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should raise error on large header names' do
+    proc { R("GET /#{rand_data(10,120)} HTTP/1.1\r\nX-#{rand_data(1024, 1024+(1024))}: Test\r\n\r\n") }.
+      should raise_error(InvalidRequest)
+  end
+
+  it 'should raise error on large mangled field values' do
+    proc { R("GET /#{rand_data(10,120)} HTTP/1.1\r\nX-Test: #{rand_data(1024, 100*1024+(1024), false)}\r\n\r\n") }.
+      should raise_error(InvalidRequest)
+  end
+  
+  it 'should raise error on big fat ugly headers' do
+    get = "GET /#{rand_data(10,120)} HTTP/1.1\r\n"
+    get << "X-Test: test\r\n" * (80 * 1024)
+    proc { R(get) }.should raise_error(InvalidRequest)
+  end
+
+  it 'should raise error on random garbage' do
+    proc { R("GET #{rand_data(1024, 1024+(1024), false)} #{rand_data(1024, 1024+(1024), false)}\r\n\r\n") }.
+      should raise_error(InvalidRequest)
+  end
+  
+  it 'should parse headers from GET request' do
+    request = R(<<-EOS, true)
+GET / HTTP/1.1
+Host: localhost:3000
+User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.9) Gecko/20071025 Firefox/2.0.0.9
+Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
+Accept-Language: en-us,en;q=0.5
+Accept-Encoding: gzip,deflate
+Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
+Cookie: mium=7
+Keep-Alive: 300
+Connection: keep-alive
+
+EOS
+    request.env['HTTP_HOST'].should == 'localhost:3000'
+    request.env['SERVER_NAME'].should == 'localhost'
+    request.env['SERVER_PORT'].should == '3000'
+    request.env['HTTP_COOKIE'].should == 'mium=7'
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should parse POST request with data' do
+    request = R(<<-EOS.chomp, true)
+POST /postit HTTP/1.1
+Host: localhost:3000
+User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.9) Gecko/20071025 Firefox/2.0.0.9
+Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
+Accept-Language: en-us,en;q=0.5
+Accept-Encoding: gzip,deflate
+Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
+Keep-Alive: 300
+Connection: keep-alive
+Content-Type: text/html
+Content-Length: 37
+
+name=marc&email=macournoyer@gmail.com
+EOS
+
+    request.env['REQUEST_METHOD'].should == 'POST'
+    request.env['REQUEST_URI'].should == '/postit'
+    request.env['CONTENT_TYPE'].should == 'text/html'
+    request.env['CONTENT_LENGTH'].should == '37'
+    request.env['HTTP_ACCEPT'].should == 'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5'
+    request.env['HTTP_ACCEPT_LANGUAGE'].should == 'en-us,en;q=0.5'
+
+    request.body.rewind
+    request.body.read.should == 'name=marc&email=macournoyer@gmail.com'
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should not fuck up on stupid fucked IE6 headers' do
+    body = <<-EOS
+POST /codes/58-tracking-file-downloads-automatically-in-google-analytics-with-prototype/refactors HTTP/1.0
+X-Real-IP: 62.24.71.95
+X-Forwarded-For: 62.24.71.95
+Host: refactormycode.com
+Connection: close
+TE: deflate,gzip;q=0.3
+Accept: */*
+Range: bytes=0-499999
+Referer: http://refactormycode.com/codes/58-tracking-file-downloads-automatically-in-google-analytics-with-prototype
+User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)
+Content-Length: 1
+Content-Type: application/x-www-form-urlencoded
+Cookie: _refactormycode_session_id=a1b2n3jk4k5; flash=%7B%7D
+Cookie2: $Version="1"
+
+a
+EOS
+    request = R(body, true)
+    request.env['HTTP_COOKIE2'].should == '$Version="1"'
+    
+    request.should validate_with_lint
+  end
+  
+  it 'shoud accept long query string' do
+    body = <<-EOS
+GET /session?open_id_complete=1&nonce=ytPOcwni&nonce=ytPOcwni&openid.assoc_handle=%7BHMAC-SHA1%7D%7B473e38fe%7D%7BJTjJxA%3D%3D%7D&openid.identity=http%3A%2F%2Fmacournoyer.myopenid.com%2F&openid.mode=id_res&openid.op_endpoint=http%3A%2F%2Fwww.myopenid.com%2Fserver&openid.response_nonce=2007-11-29T01%3A19%3A35ZGA5FUU&openid.return_to=http%3A%2F%2Flocalhost%3A3000%2Fsession%3Fopen_id_complete%3D1%26nonce%3DytPOcwni%26nonce%3DytPOcwni&openid.sig=lPIRgwpfR6JAdGGnb0ZjcY%2FWjr8%3D&openid.signed=assoc_handle%2Cidentity%2Cmode%2Cop_endpoint%2Cresponse_nonce%2Creturn_to%2Csigned%2Csreg.email%2Csreg.nickname&openid.sreg.email=macournoyer%40yahoo.ca&openid.sreg.nickname=macournoyer HTTP/1.1
+Host: localhost:3000
+
+EOS
+    request = R(body, true)
+    
+    request.env['QUERY_STRING'].should == 'open_id_complete=1&nonce=ytPOcwni&nonce=ytPOcwni&openid.assoc_handle=%7BHMAC-SHA1%7D%7B473e38fe%7D%7BJTjJxA%3D%3D%7D&openid.identity=http%3A%2F%2Fmacournoyer.myopenid.com%2F&openid.mode=id_res&openid.op_endpoint=http%3A%2F%2Fwww.myopenid.com%2Fserver&openid.response_nonce=2007-11-29T01%3A19%3A35ZGA5FUU&openid.return_to=http%3A%2F%2Flocalhost%3A3000%2Fsession%3Fopen_id_complete%3D1%26nonce%3DytPOcwni%26nonce%3DytPOcwni&openid.sig=lPIRgwpfR6JAdGGnb0ZjcY%2FWjr8%3D&openid.signed=assoc_handle%2Cidentity%2Cmode%2Cop_endpoint%2Cresponse_nonce%2Creturn_to%2Csigned%2Csreg.email%2Csreg.nickname&openid.sreg.email=macournoyer%40yahoo.ca&openid.sreg.nickname=macournoyer'
+    
+    request.should validate_with_lint
+  end
+  
+  it 'should parse even with stupid Content-Length' do
+    body = <<-EOS.chomp
+POST / HTTP/1.1
+Host: localhost:3000
+Content-Length: 300
+
+aye
+EOS
+    request = R(body, true)
+    
+    request.body.rewind
+    request.body.read.should == 'aye'
+  end
+  
+  it 'should parse in chunks' do
+    request = Request.new
+    request.parse("POST / HTTP/1.1\r\n").should be_false
+    request.parse("Host: localhost\r\n").should be_false
+    request.parse("Content-Length: 9\r\n").should be_false
+    request.parse("\r\nvery ").should be_false
+    request.parse("cool").should be_true
+    
+    request.env['CONTENT_LENGTH'].should == '9'
+    request.body.read.should == 'very cool'
+    request.should validate_with_lint
+  end
+  
+  it "should be faster then #{max_parsing_time = 0.2} ms" do
+    body = <<-EOS.chomp
+POST /postit HTTP/1.1
+Host: localhost:3000
+User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.9) Gecko/20071025 Firefox/2.0.0.9
+Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
+Accept-Language: en-us,en;q=0.5
+Accept-Encoding: gzip,deflate
+Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
+Keep-Alive: 300
+Connection: keep-alive
+Content-Type: text/html
+Content-Length: 37
+
+hi=there&name=marc&email=macournoyer@gmail.com
+EOS
+    
+    proc { R(body, true) }.should be_faster_then(max_parsing_time)
+  end
+  
+  it 'should be comparable to Mongrel parser' do
+    require 'http11'
+  
+    body = <<-EOS.chomp.gsub("\n", "\r\n")
+POST /postit HTTP/1.1
+Host: localhost:3000
+User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.9) Gecko/20071025 Firefox/2.0.0.9
+Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
+Accept-Language: en-us,en;q=0.5
+Accept-Encoding: gzip,deflate
+Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
+Keep-Alive: 300
+Connection: keep-alive
+Content-Type: text/html
+Content-Length: 37
+
+hi=there&name=marc&email=macournoyer@gmail.com
+EOS
+  
+    tests = 10_000
+    puts
+    Benchmark.bmbm(10) do |results|
+      results.report("mongrel:") { tests.times { Mongrel::HttpParser.new.execute({}, body.dup, 0) } }
+      results.report("thin:") { tests.times { Thin::HttpParser.new.execute({'rack.input' => StringIO.new}, body.dup, 0) } }
+    end
+  end if ENV['BM']
+  
+  private
+    def rand_data(min, max, readable=true)
+      count = min + ((rand(max)+1) *10).to_i
+      res = count.to_s + "/"
+
+      if readable
+        res << Digest::SHA1.hexdigest(rand(count * 100).to_s) * (count / 40)
+      else
+        res << Digest::SHA1.digest(rand(count * 100).to_s) * (count / 20)
+      end
+
+      return res
+    end
+    
+    def R(raw, convert_line_feed=false)
+      raw.gsub!("\n", "\r\n") if convert_line_feed
+      request = Thin::Request.new
+      request.parse(raw)
+      request
+    end
+end