puma 2.7.0 → 3.1.1

data/lib/puma/rack/urlmap.rb

@@ -0,0 +1,90 @@
+module Puma::Rack
+  # Rack::URLMap takes a hash mapping urls or paths to apps, and
+  # dispatches accordingly.  Support for HTTP/1.1 host names exists if
+  # the URLs start with <tt>http://</tt> or <tt>https://</tt>.
+  #
+  # URLMap modifies the SCRIPT_NAME and PATH_INFO such that the part
+  # relevant for dispatch is in the SCRIPT_NAME, and the rest in the
+  # PATH_INFO.  This should be taken care of when you need to
+  # reconstruct the URL in order to create links.
+  #
+  # URLMap dispatches in such a way that the longest paths are tried
+  # first, since they are most specific.
+
+  class URLMap
+    NEGATIVE_INFINITY = -1.0 / 0.0
+    INFINITY = 1.0 / 0.0
+
+    def initialize(map = {})
+      remap(map)
+    end
+
+    def remap(map)
+      @mapping = map.map { |location, app|
+        if location =~ %r{\Ahttps?://(.*?)(/.*)}
+          host, location = $1, $2
+        else
+          host = nil
+        end
+
+        unless location[0] == ?/
+          raise ArgumentError, "paths need to start with /"
+        end
+
+        location = location.chomp('/')
+        match = Regexp.new("^#{Regexp.quote(location).gsub('/', '/+')}(.*)", nil, 'n')
+
+        [host, location, match, app]
+      }.sort_by do |(host, location, _, _)|
+        [host ? -host.size : INFINITY, -location.size]
+      end
+    end
+
+    def call(env)
+      path = env['PATH_INFO']
+      script_name = env['SCRIPT_NAME']
+      hHost = env['HTTP_HOST']
+      sName = env['SERVER_NAME']
+      sPort = env['SERVER_PORT']
+
+      @mapping.each do |host, location, match, app|
+        unless casecmp?(hHost, host) \
+            || casecmp?(sName, host) \
+            || (!host && (casecmp?(hHost, sName) ||
+                          casecmp?(hHost, sName+':'+sPort)))
+          next
+        end
+
+        next unless m = match.match(path.to_s)
+
+        rest = m[1]
+        next unless !rest || rest.empty? || rest[0] == ?/
+
+        env['SCRIPT_NAME'] = (script_name + location)
+        env['PATH_INFO'] = rest
+
+        return app.call(env)
+      end
+
+      [404, {'Content-Type' => "text/plain", "X-Cascade" => "pass"}, ["Not Found: #{path}"]]
+
+    ensure
+      env['PATH_INFO'] = path
+      env['SCRIPT_NAME'] = script_name
+    end
+
+    private
+    def casecmp?(v1, v2)
+      # if both nil, or they're the same string
+      return true if v1 == v2
+
+      # if either are nil... (but they're not the same)
+      return false if v1.nil?
+      return false if v2.nil?
+
+      # otherwise check they're not case-insensitive the same
+      v1.casecmp(v2).zero?
+    end
+  end
+end
+

data/lib/puma/reactor.rb

@@ -1,4 +1,5 @@
 require 'puma/util'
+require 'puma/minissl'
 
 module Puma
   class Reactor
@@ -74,6 +75,17 @@ module Puma
                   sockets.delete c
                 end
 
+              # SSL handshake failure
+              rescue MiniSSL::SSLError => e
+                ssl_socket = c.io
+                addr = ssl_socket.peeraddr.last
+                cert = ssl_socket.peercert
+
+                c.close
+                sockets.delete c
+
+                @events.ssl_error @server, addr, cert, e
+
               # The client doesn't know HTTP well
               rescue HttpParserError => e
                 c.write_400
@@ -98,8 +110,9 @@ module Puma
 
             while @timeouts.first.timeout_at < now
               c = @timeouts.shift
-              sockets.delete c
+              c.write_408 if c.in_data_phase
               c.close
+              sockets.delete c
 
               break if @timeouts.empty?
             end

data/lib/puma/runner.rb

@@ -1,7 +1,8 @@
 module Puma
   class Runner
-    def initialize(cli)
-      @cli = cli
+    def initialize(cli, events)
+      @launcher = cli
+      @events = events
       @options = cli.options
       @app = nil
       @control = nil
@@ -16,15 +17,19 @@ module Puma
     end
 
     def log(str)
-      @cli.log str
+      @events.log str
+    end
+
+    def before_restart
+      @control.stop(true) if @control
     end
 
     def error(str)
-      @cli.error str
+      @events.error str
     end
 
-    def before_restart
-      @control.stop(true) if @control
+    def debug(str)
+      @events.log "- #{str}" if @options[:debug]
     end
 
     def start_control
@@ -35,13 +40,13 @@ module Puma
 
       uri = URI.parse str
 
-      app = Puma::App::Status.new @cli
+      app = Puma::App::Status.new @launcher
 
       if token = @options[:control_auth_token]
         app.auth_token = token unless token.empty? or token == :none
       end
 
-      control = Puma::Server.new app, @cli.events
+      control = Puma::Server.new app, @launcher.events
       control.min_threads = 0
       control.max_threads = 1
 
@@ -52,8 +57,9 @@ module Puma
       when "unix"
         log "* Starting control server on #{str}"
         path = "#{uri.host}#{uri.path}"
+        mask = @options[:control_url_umask]
 
-        control.add_unix_listener path
+        control.add_unix_listener path, mask
       else
         error "Invalid control URI: #{str}"
       end
@@ -62,12 +68,24 @@ module Puma
       @control = control
     end
 
+    def ruby_engine
+      if !defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby"
+        "ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+      else
+        if defined?(RUBY_ENGINE_VERSION)
+          "#{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} - ruby #{RUBY_VERSION}"
+        else
+          "#{RUBY_ENGINE} #{RUBY_VERSION}"
+        end
+      end
+    end
+
     def output_header(mode)
       min_t = @options[:min_threads]
       max_t = @options[:max_threads]
 
       log "Puma starting in #{mode} mode..."
-      log "* Version #{Puma::Const::PUMA_VERSION}, codename: #{Puma::Const::CODE_NAME}"
+      log "* Version #{Puma::Const::PUMA_VERSION} (#{ruby_engine}), codename: #{Puma::Const::CODE_NAME}"
       log "* Min threads: #{min_t}, max threads: #{max_t}"
       log "* Environment: #{ENV['RACK_ENV']}"
 
@@ -95,34 +113,34 @@ module Puma
     end
 
     def load_and_bind
-      unless @cli.config.app_configured?
+      unless @launcher.config.app_configured?
         error "No application configured, nothing to run"
         exit 1
       end
 
       # Load the app before we daemonize.
       begin
-        @app = @cli.config.app
+        @app = @launcher.config.app
       rescue Exception => e
-        log "! Unable to load application"
+        log "! Unable to load application: #{e.class}: #{e.message}"
         raise e
       end
 
-      @cli.binder.parse @options[:binds], self
+      @launcher.binder.parse @options[:binds], self
     end
 
     def app
-      @app ||= @cli.config.app
+      @app ||= @launcher.config.app
     end
 
     def start_server
       min_t = @options[:min_threads]
       max_t = @options[:max_threads]
 
-      server = Puma::Server.new app, @cli.events, @options
+      server = Puma::Server.new app, @launcher.events, @options
       server.min_threads = min_t
       server.max_threads = max_t
-      server.inherit_binder @cli.binder
+      server.inherit_binder @launcher.binder
 
       if @options[:mode] == :tcp
         server.tcp_mode!

data/lib/puma/server.rb

@@ -1,4 +1,3 @@
-require 'rack'
 require 'stringio'
 
 require 'puma/thread_pool'
@@ -13,11 +12,9 @@ require 'puma/delegation'
 require 'puma/accept_nonblock'
 require 'puma/util'
 
-require 'puma/rack_patch'
-
 require 'puma/puma_http11'
 
-unless Puma.const_defined?("IOBuffer", false)
+unless Puma.const_defined? "IOBuffer"
   require 'puma/io_buffer'
 end
 
@@ -39,6 +36,8 @@ module Puma
     attr_accessor :max_threads
     attr_accessor :persistent_timeout
     attr_accessor :auto_trim_time
+    attr_accessor :reaping_time
+    attr_accessor :first_data_timeout
 
     # Create a server for the rack app +app+.
     #
@@ -46,7 +45,7 @@ module Puma
     # to be handled. See Puma::Events for the list of current methods to implement.
     #
     # Server#run returns a thread that you can join on to wait for the server
-    # to do it's work.
+    # to do its work.
     #
     def initialize(app, events=Events.stdio, options={})
       @app = app
@@ -59,6 +58,7 @@ module Puma
       @min_threads = 0
       @max_threads = 16
       @auto_trim_time = 1
+      @reaping_time = 1
 
       @thread = nil
       @thread_pool = nil
@@ -73,6 +73,7 @@ module Puma
       @leak_stack_on_error = true
 
       @options = options
+      @queue_requests = options[:queue_requests].nil? ? true : options[:queue_requests]
 
       ENV['RACK_ENV'] ||= "development"
 
@@ -84,6 +85,7 @@ module Puma
     forward :add_tcp_listener,  :@binder
     forward :add_ssl_listener,  :@binder
     forward :add_unix_listener, :@binder
+    forward :connected_port,    :@binder
 
     def inherit_binder(bind)
       @binder = bind
@@ -102,13 +104,16 @@ module Puma
       # 3 == TCP_CORK
       # 1/0 == turn on/off
       def cork_socket(socket)
-        socket.setsockopt(6, 3, 1) if socket.kind_of? TCPSocket
+        begin
+          socket.setsockopt(6, 3, 1) if socket.kind_of? TCPSocket
+        rescue IOError, SystemCallError
+        end
       end
 
       def uncork_socket(socket)
         begin
           socket.setsockopt(6, 3, 0) if socket.kind_of? TCPSocket
-        rescue IOError
+        rescue IOError, SystemCallError
         end
       end
     else
@@ -181,16 +186,17 @@ module Puma
               else
                 begin
                   if io = sock.accept_nonblock
-                    c = Client.new io, nil
-                    pool << c
+                    client = Client.new io, nil
+                    pool << client
                   end
                 rescue SystemCallError
+                  # nothing
+                rescue Errno::ECONNABORTED
+                  # client closed the socket even before accept
+                  io.close rescue nil
                 end
               end
             end
-          rescue Errno::ECONNABORTED
-            # client closed the socket even before accept
-            client.close rescue nil
           rescue Object => e
             @events.unknown_error self, e, "Listen loop"
           end
@@ -231,13 +237,28 @@ module Puma
         return run_lopez_mode(background)
       end
 
+      queue_requests = @queue_requests
+
       @thread_pool = ThreadPool.new(@min_threads,
                                     @max_threads,
                                     IOBuffer) do |client, buffer|
         process_now = false
 
         begin
-          process_now = client.eagerly_finish
+          if queue_requests
+            process_now = client.eagerly_finish
+          else
+            client.finish
+            process_now = true
+          end
+        rescue MiniSSL::SSLError => e
+          ssl_socket = client.io
+          addr = ssl_socket.peeraddr.last
+          cert = ssl_socket.peercert
+
+          client.close
+
+          @events.ssl_error self, addr, cert, e
         rescue HttpParserError => e
           client.write_400
           client.close
@@ -255,9 +276,16 @@ module Puma
         end
       end
 
-      @reactor = Reactor.new self, @thread_pool
+      @thread_pool.clean_thread_locals = @options[:clean_thread_locals]
 
-      @reactor.run_in_thread
+      if queue_requests
+        @reactor = Reactor.new self, @thread_pool
+        @reactor.run_in_thread
+      end
+
+      if @reaping_time
+        @thread_pool.auto_reap!(@reaping_time)
+      end
 
       if @auto_trim_time
         @thread_pool.auto_trim!(@auto_trim_time)
@@ -278,6 +306,17 @@ module Puma
         check = @check
         sockets = [check] + @binder.ios
         pool = @thread_pool
+        queue_requests = @queue_requests
+
+        remote_addr_value = nil
+        remote_addr_header = nil
+
+        case @options[:remote_address]
+        when :value
+          remote_addr_value = @options[:remote_address_value]
+        when :header
+          remote_addr_header = @options[:remote_address_header]
+        end
 
         while @status == :run
           begin
@@ -288,16 +327,24 @@ module Puma
               else
                 begin
                   if io = sock.accept_nonblock
-                    c = Client.new io, @binder.env(sock)
-                    pool << c
+                    client = Client.new io, @binder.env(sock)
+                    if remote_addr_value
+                      client.peerip = remote_addr_value
+                    elsif remote_addr_header
+                      client.remote_addr_header = remote_addr_header
+                    end
+
+                    pool << client
+                    pool.wait_until_not_full unless queue_requests
                   end
                 rescue SystemCallError
+                  # nothing
+                rescue Errno::ECONNABORTED
+                  # client closed the socket even before accept
+                  io.close rescue nil
                 end
               end
             end
-          rescue Errno::ECONNABORTED
-            # client closed the socket even before accept
-            client.close rescue nil
           rescue Object => e
             @events.unknown_error self, e, "Listen loop"
           end
@@ -306,9 +353,10 @@ module Puma
         @events.fire :state, @status
 
         graceful_shutdown if @status == :stop || @status == :restart
-        @reactor.clear! if @status == :restart
-
-        @reactor.shutdown
+        if queue_requests
+          @reactor.clear! if @status == :restart
+          @reactor.shutdown
+        end
       rescue Exception => e
         STDERR.puts "Exception handling servers: #{e.message} (#{e.class})"
         STDERR.puts e.backtrace
@@ -326,7 +374,7 @@ module Puma
 
     # :nodoc:
     def handle_check
-      cmd = @check.read(1) 
+      cmd = @check.read(1)
 
       case cmd
       when STOP_COMMAND
@@ -351,6 +399,7 @@ module Puma
     #
     def process_client(client, buffer)
       begin
+        clean_thread_locals = @options[:clean_thread_locals]
         close_socket = true
 
         while true
@@ -361,8 +410,11 @@ module Puma
             close_socket = false
             return
           when true
+            return unless @queue_requests
             buffer.reset
 
+            ThreadPool.clean_thread_locals if clean_thread_locals
+
             unless client.reset(@status == :run)
               close_socket = false
               client.set_timeout @persistent_timeout
@@ -376,6 +428,16 @@ module Puma
       rescue ConnectionError
         # Swallow them. The ensure tries to close +client+ down
 
+      # SSL handshake error
+      rescue MiniSSL::SSLError => e
+        ssl_socket = client.io
+        addr = ssl_socket.peeraddr.last
+        cert = ssl_socket.peercert
+
+        close_socket = true
+
+        @events.ssl_error self, addr, cert, e
+
       # The client doesn't know HTTP well
       rescue HttpParserError => e
         client.write_400
@@ -437,15 +499,24 @@ module Puma
       # intermediary acting on behalf of the actual source client."
       #
 
-      addr = client.peeraddr.last
+      unless env.key?(REMOTE_ADDR)
+        begin
+          addr = client.peerip
+        rescue Errno::ENOTCONN
+          # Client disconnects can result in an inability to get the
+          # peeraddr from the socket; default to localhost.
+          addr = LOCALHOST_IP
+        end
 
-      # Set unix socket addrs to localhost
-      addr = "127.0.0.1" if addr.empty?
+        # Set unix socket addrs to localhost
+        addr = LOCALHOST_IP if addr.empty?
 
-      env[REMOTE_ADDR] = addr
+        env[REMOTE_ADDR] = addr
+      end
     end
 
     def default_server_port(env)
+      return PORT_443 if env[HTTPS_KEY] == 'on' || env[HTTPS_KEY] == 'https'
       env['HTTP_X_FORWARDED_PROTO'] == 'https' ? PORT_443 : PORT_80
     end
 
@@ -462,10 +533,14 @@ module Puma
       env = req.env
       client = req.io
 
-      normalize_env env, client
+      normalize_env env, req
 
       env[PUMA_SOCKET] = client
 
+      if env[HTTPS_KEY] && client.peercert
+        env[PUMA_PEERCERT] = client.peercert
+      end
+
       env[HIJACK_P] = true
       env[HIJACK] = req
 
@@ -499,7 +574,7 @@ module Puma
         rescue StandardError => e
           @events.unknown_error self, e, "Rack app"
 
-          status, headers, res_body = lowlevel_error(e)
+          status, headers, res_body = lowlevel_error(e, env)
         end
 
         content_length = nil
@@ -514,9 +589,9 @@ module Puma
         line_ending = LINE_END
         colon = COLON
 
-        if env[HTTP_VERSION] == HTTP_11
+        http_11 = if env[HTTP_VERSION] == HTTP_11
           allow_chunked = true
-          keep_alive = env[HTTP_CONNECTION] != CLOSE
+          keep_alive = env.fetch(HTTP_CONNECTION, "").downcase != CLOSE
           include_keepalive_header = false
 
           # An optimization. The most common response is 200, so we can
@@ -531,9 +606,10 @@ module Puma
 
             no_body ||= status < 200 || STATUS_WITH_NO_ENTITY_BODY[status]
           end
+          true
         else
           allow_chunked = false
-          keep_alive = env[HTTP_CONNECTION] == KEEP_ALIVE
+          keep_alive = env.fetch(HTTP_CONNECTION, "").downcase == KEEP_ALIVE
           include_keepalive_header = keep_alive
 
           # Same optimization as above for HTTP/1.1
@@ -546,12 +622,13 @@ module Puma
 
             no_body ||= status < 200 || STATUS_WITH_NO_ENTITY_BODY[status]
           end
+          false
         end
 
         response_hijack = nil
 
         headers.each do |k, vs|
-          case k
+          case k.downcase
           when CONTENT_LENGTH2
             content_length = vs
             next
@@ -572,6 +649,12 @@ module Puma
           end
         end
 
+        if include_keepalive_header
+          lines << CONNECTION_KEEP_ALIVE
+        elsif http_11 && !keep_alive
+          lines << CONNECTION_CLOSE
+        end
+
         if no_body
           if content_length and status != 204
             lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
@@ -582,20 +665,12 @@ module Puma
           return keep_alive
         end
 
-        if include_keepalive_header
-          lines << CONNECTION_KEEP_ALIVE
-        elsif !keep_alive
-          lines << CONNECTION_CLOSE
-        end
-
-        unless response_hijack
-          if content_length
-            lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
-            chunked = false
-          elsif allow_chunked
-            lines << TRANSFER_ENCODING_CHUNKED
-            chunked = true
-          end
+        if content_length
+          lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
+          chunked = false
+        elsif !response_hijack and allow_chunked
+          lines << TRANSFER_ENCODING_CHUNKED
+          chunked = true
         end
 
         lines << line_ending
@@ -610,10 +685,11 @@ module Puma
         begin
           res_body.each do |part|
             if chunked
-              client.syswrite part.bytesize.to_s(16)
-              client.syswrite line_ending
+              next if part.bytesize.zero?
+              fast_write client, part.bytesize.to_s(16)
+              fast_write client, line_ending
               fast_write client, part
-              client.syswrite line_ending
+              fast_write client, line_ending
             else
               fast_write client, part
             end
@@ -622,7 +698,7 @@ module Puma
           end
 
           if chunked
-            client.syswrite CLOSE_CHUNKED
+            fast_write client, CLOSE_CHUNKED
             client.flush
           end
         rescue SystemCallError, IOError
@@ -633,6 +709,7 @@ module Puma
         uncork_socket client
 
         body.close
+        req.tempfile.unlink if req.tempfile
         res_body.close if res_body.respond_to? :close
 
         after_reply.each { |o| o.call }
@@ -702,17 +779,40 @@ module Puma
 
     # A fallback rack response if +@app+ raises as exception.
     #
-    def lowlevel_error(e)
+    def lowlevel_error(e, env)
+      if handler = @options[:lowlevel_error_handler]
+        if handler.arity == 1
+          return handler.call(e)
+        else
+          return handler.call(e, env)
+        end
+      end
+
       if @leak_stack_on_error
         [500, {}, ["Puma caught this error: #{e.message} (#{e.class})\n#{e.backtrace.join("\n")}"]]
       else
-        [500, {}, ["A really lowlevel plumbing error occured. Please contact your local Maytag(tm) repair man.\n"]]
+        [500, {}, ["An unhandled lowlevel error occurred. The application logs may have details.\n"]]
       end
     end
 
     # Wait for all outstanding requests to finish.
     #
     def graceful_shutdown
+      if @options[:shutdown_debug]
+        threads = Thread.list
+        total = threads.size
+
+        pid = Process.pid
+
+        $stdout.syswrite "#{pid}: === Begin thread backtrace dump ===\n"
+
+        threads.each_with_index do |t,i|
+          $stdout.syswrite "#{pid}: Thread #{i+1}/#{total}: #{t.inspect}\n"
+          $stdout.syswrite "#{pid}: #{t.backtrace.join("\n#{pid}: ")}\n\n"
+        end
+        $stdout.syswrite "#{pid}: === End thread backtrace dump ===\n"
+      end
+
       if @options[:drain_on_shutdown]
         count = 0
 
@@ -724,8 +824,8 @@ module Puma
             begin
               if io = sock.accept_nonblock
                 count += 1
-                c = Client.new io, @binder.env(sock)
-                @thread_pool << c
+                client = Client.new io, @binder.env(sock)
+                @thread_pool << client
               end
             rescue SystemCallError
             end
@@ -775,10 +875,13 @@ module Puma
         begin
           n = io.syswrite str
         rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-          IO.select(nil, [io], nil, 1)
+          if !IO.select(nil, [io], nil, WRITE_TIMEOUT)
+            raise ConnectionError, "Socket timeout writing data"
+          end
+
           retry
         rescue  Errno::EPIPE, SystemCallError, IOError
-          return false
+          raise ConnectionError, "Socket timeout writing data"
         end
 
         return if n == str.bytesize