puma 2.7.0 → 3.1.1

data/lib/puma/const.rb

@@ -1,5 +1,4 @@
-require 'rack'
-
+#encoding: utf-8
 module Puma
   class UnsupportedOption < RuntimeError
   end
@@ -8,12 +7,85 @@ module Puma
   # Every standard HTTP code mapped to the appropriate message.  These are
   # used so frequently that they are placed directly in Puma for easy
   # access rather than Puma::Const itself.
-  HTTP_STATUS_CODES = Rack::Utils::HTTP_STATUS_CODES
+
+  # Every standard HTTP code mapped to the appropriate message.
+  # Generated with:
+  # curl -s https://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv | \
+  #   ruby -ne 'm = /^(\d{3}),(?!Unassigned|\(Unused\))([^,]+)/.match($_) and \
+  #             puts "#{m[1]} => \x27#{m[2].strip}\x27,"'
+  HTTP_STATUS_CODES = {
+    100 => 'Continue',
+    101 => 'Switching Protocols',
+    102 => 'Processing',
+    200 => 'OK',
+    201 => 'Created',
+    202 => 'Accepted',
+    203 => 'Non-Authoritative Information',
+    204 => 'No Content',
+    205 => 'Reset Content',
+    206 => 'Partial Content',
+    207 => 'Multi-Status',
+    208 => 'Already Reported',
+    226 => 'IM Used',
+    300 => 'Multiple Choices',
+    301 => 'Moved Permanently',
+    302 => 'Found',
+    303 => 'See Other',
+    304 => 'Not Modified',
+    305 => 'Use Proxy',
+    307 => 'Temporary Redirect',
+    308 => 'Permanent Redirect',
+    400 => 'Bad Request',
+    401 => 'Unauthorized',
+    402 => 'Payment Required',
+    403 => 'Forbidden',
+    404 => 'Not Found',
+    405 => 'Method Not Allowed',
+    406 => 'Not Acceptable',
+    407 => 'Proxy Authentication Required',
+    408 => 'Request Timeout',
+    409 => 'Conflict',
+    410 => 'Gone',
+    411 => 'Length Required',
+    412 => 'Precondition Failed',
+    413 => 'Payload Too Large',
+    414 => 'URI Too Long',
+    415 => 'Unsupported Media Type',
+    416 => 'Range Not Satisfiable',
+    417 => 'Expectation Failed',
+    422 => 'Unprocessable Entity',
+    423 => 'Locked',
+    424 => 'Failed Dependency',
+    426 => 'Upgrade Required',
+    428 => 'Precondition Required',
+    429 => 'Too Many Requests',
+    431 => 'Request Header Fields Too Large',
+    500 => 'Internal Server Error',
+    501 => 'Not Implemented',
+    502 => 'Bad Gateway',
+    503 => 'Service Unavailable',
+    504 => 'Gateway Timeout',
+    505 => 'HTTP Version Not Supported',
+    506 => 'Variant Also Negotiates',
+    507 => 'Insufficient Storage',
+    508 => 'Loop Detected',
+    510 => 'Not Extended',
+    511 => 'Network Authentication Required'
+  }
+
+  SYMBOL_TO_STATUS_CODE = Hash[*HTTP_STATUS_CODES.map { |code, message|
+    [message.downcase.gsub(/\s|-|'/, '_').to_sym, code]
+  }.flatten]
 
   # For some HTTP status codes the client only expects headers.
-  STATUS_WITH_NO_ENTITY_BODY = Hash[Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.map { |s|
-    [s, true]
-  }]
+  #
+
+  no_body = {}
+  ((100..199).to_a << 204 << 205 << 304).each do |code|
+    no_body[code] = true
+  end
+
+  STATUS_WITH_NO_ENTITY_BODY = no_body
 
   # Frequently used constants when constructing requests or responses.  Many times
   # the constant just refers to a string with the same contents.  Using these constants
@@ -28,9 +100,10 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.7.0".freeze
-    CODE_NAME = "Earl of Sandwich Partition"
-
+    PUMA_VERSION = VERSION = "3.1.1".freeze
+    CODE_NAME = "El Niño Winter Wonderland".freeze
+    PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
+    
     FAST_TRACK_KA_TIMEOUT = 0.2
 
     # The default number of seconds for another request within a persistent
@@ -41,6 +114,10 @@ module Puma
     # for the request
     FIRST_DATA_TIMEOUT = 30
 
+    # How long to wait when getting some write blocking on the socket when
+    # sending data back
+    WRITE_TIMEOUT = 10
+
     DATE = "Date".freeze
 
     SCRIPT_NAME = "SCRIPT_NAME".freeze
@@ -54,15 +131,18 @@ module Puma
     PUMA_TMP_BASE = "puma".freeze
 
     # Indicate that we couldn't parse the request
-    ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\n\r\n"
+    ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\n\r\n".freeze
 
     # The standard empty 404 response for bad requests.  Use Error4040Handler for custom stuff.
     ERROR_404_RESPONSE = "HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND".freeze
 
+    # The standard empty 408 response for requests that timed out.
+    ERROR_408_RESPONSE = "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze
+
     CONTENT_LENGTH = "CONTENT_LENGTH".freeze
 
     # Indicate that there was an internal error, obviously.
-    ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\n\r\n"
+    ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze
 
     # A common header for indicating the server is too busy.  Not used yet.
     ERROR_503_RESPONSE = "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY".freeze
@@ -104,6 +184,8 @@ module Puma
     PORT_80 = "80".freeze
     PORT_443 = "443".freeze
     LOCALHOST = "localhost".freeze
+    LOCALHOST_IP = "127.0.0.1".freeze
+    LOCALHOST_ADDR = "127.0.0.1:0".freeze
 
     SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
     HTTP_11 = "HTTP/1.1".freeze
@@ -122,6 +204,7 @@ module Puma
     RACK_AFTER_REPLY = "rack.after_reply".freeze
     PUMA_SOCKET = "puma.socket".freeze
     PUMA_CONFIG = "puma.config".freeze
+    PUMA_PEERCERT = "puma.peercert".freeze
 
     HTTP = "http".freeze
     HTTPS = "https".freeze
@@ -135,11 +218,11 @@ module Puma
     HTTP_10_200 = "HTTP/1.0 200 OK\r\n".freeze
 
     CLOSE = "close".freeze
-    KEEP_ALIVE = "Keep-Alive".freeze
+    KEEP_ALIVE = "keep-alive".freeze
 
-    CONTENT_LENGTH2 = "Content-Length".freeze
+    CONTENT_LENGTH2 = "content-length".freeze
     CONTENT_LENGTH_S = "Content-Length: ".freeze
-    TRANSFER_ENCODING = "Transfer-Encoding".freeze
+    TRANSFER_ENCODING = "transfer-encoding".freeze
 
     CONNECTION_CLOSE = "Connection: close\r\n".freeze
     CONNECTION_KEEP_ALIVE = "Connection: Keep-Alive\r\n".freeze

data/lib/puma/control_cli.rb

@@ -1,53 +1,60 @@
 require 'optparse'
+require 'puma'
 require 'puma/const'
+require 'puma/detect'
 require 'puma/configuration'
-require 'yaml'
 require 'uri'
 require 'socket'
+
 module Puma
   class ControlCLI
 
-    COMMANDS = %w{halt restart phased-restart start stats status stop}
-
-    def is_windows?
-      RUBY_PLATFORM =~ /(win|w)32$/ ? true : false
-    end
+    COMMANDS = %w{halt restart phased-restart start stats status stop reload-worker-directory}
 
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
-      @argv = argv
+      @state = nil
+      @quiet = false
+      @pidfile = nil
+      @pid = nil
+      @control_url = nil
+      @control_auth_token = nil
+      @config_file = nil
+      @command = nil
+
+      @argv = argv.dup
       @stdout = stdout
       @stderr = stderr
-      @options = {}
+      @cli_options = {}
 
       opts = OptionParser.new do |o|
         o.banner = "Usage: pumactl (-p PID | -P pidfile | -S status_file | -C url -T token | -F config.rb) (#{COMMANDS.join("|")})"
 
         o.on "-S", "--state PATH", "Where the state file to use is" do |arg|
-          @options[:state] = arg
+          @state = arg
         end
 
         o.on "-Q", "--quiet", "Not display messages" do |arg|
-          @options[:quiet_flag] = true
+          @quiet = true
         end
 
         o.on "-P", "--pidfile PATH", "Pid file" do |arg|
-          @options[:pidfile] = arg
+          @pidfile = arg
         end
 
         o.on "-p", "--pid PID", "Pid" do |arg|
-          @options[:pid] = arg.to_i
+          @pid = arg.to_i
         end
 
         o.on "-C", "--control-url URL", "The bind url to use for the control server" do |arg|
-          @options[:control_url] = arg
+          @control_url = arg
         end
 
         o.on "-T", "--control-token TOKEN", "The token to use as authentication for the control server" do |arg|
-          @options[:control_auth_token] = arg
+          @control_auth_token = arg
         end
 
         o.on "-F", "--config-file PATH", "Puma config script" do |arg|
-          @options[:config_file] = arg
+          @config_file = arg
         end
 
         o.on_tail("-H", "--help", "Show this message") do
@@ -63,18 +70,29 @@ module Puma
 
       opts.order!(argv) { |a| opts.terminate a }
 
-      command = argv.shift
-      @options[:command] = command if command
+      @command = argv.shift
+
+      unless @config_file == '-'
+        if @config_file.nil? and File.exist?('config/puma.rb')
+          @config_file = 'config/puma.rb'
+        end
 
-      Puma::Configuration.new(@options).load if @options[:config_file]
+        if @config_file
+          config = Puma::Configuration.from_file @config_file
+          @state ||= config.options[:state]
+          @control_url ||= config.options[:control_url]
+          @control_auth_token ||= config.options[:control_auth_token]
+          @pidfile ||= config.options[:pidfile]
+        end
+      end
 
       # check present of command
-      unless @options[:command]
+      unless @command
         raise "Available commands: #{COMMANDS.join(", ")}"
       end
 
-      unless COMMANDS.include? @options[:command]
-        raise "Invalid command: #{@options[:command]}"
+      unless COMMANDS.include? @command
+        raise "Invalid command: #{@command}"
       end
 
     rescue => e
@@ -83,45 +101,29 @@ module Puma
     end
 
     def message(msg)
-      @stdout.puts msg unless @options[:quiet_flag]
+      @stdout.puts msg unless @quiet
     end
 
     def prepare_configuration
-      if @options.has_key? :state
-        unless File.exist? @options[:state]
-          raise "Status file not found: #{@options[:state]}"
+      if @state
+        unless File.exist? @state
+          raise "State file not found: #{@state}"
         end
 
-        status = YAML.load File.read(@options[:state])
-
-        if status.kind_of?(Hash) && status.has_key?("config")
-
-          conf = status["config"]
-
-          # get control_url
-          if url = conf.options[:control_url]
-            @options[:control_url] = url
-          end
+        sf = Puma::StateFile.new
+        sf.load @state
 
-          # get control_auth_token
-          if token = conf.options[:control_auth_token]
-            @options[:control_auth_token] = token
-          end
-
-          # get pid
-          @options[:pid] = status["pid"].to_i
-        else
-          raise "Invalid status file: #{@options[:state]}"
-        end
-
-      elsif @options.has_key? :pidfile
+        @control_url = sf.control_url
+        @control_auth_token = sf.control_auth_token
+        @pid = sf.pid
+      elsif @pidfile
         # get pid from pid_file
-        @options[:pid] = File.open(@options[:pidfile]).gets.to_i
+        @pid = File.open(@pidfile).gets.to_i
       end
     end
 
     def send_request
-      uri = URI.parse @options[:control_url]
+      uri = URI.parse @control_url
 
       # create server object by scheme
       @server = case uri.scheme
@@ -133,13 +135,13 @@ module Puma
                   raise "Invalid scheme: #{uri.scheme}"
                 end
 
-      if @options[:command] == "status"
+      if @command == "status"
         message "Puma is started"
       else
-        url = "/#{@options[:command]}"
+        url = "/#{@command}"
 
-        if @options.has_key?(:control_auth_token)
-          url = url + "?token=#{@options[:control_auth_token]}"
+        if @control_auth_token
+          url = url + "?token=#{@control_auth_token}"
         end
 
         @server << "GET #{url} HTTP/1.0\r\n\r\n"
@@ -164,63 +166,66 @@ module Puma
           raise "Bad response from server: #{@code}"
         end
 
-        message "Command #{@options[:command]} sent success"
-        message response.last if @options[:command] == "stats"
+        message "Command #{@command} sent success"
+        message response.last if @command == "stats"
       end
 
       @server.close
     end
 
     def send_signal
-      unless pid = @options[:pid]
+      unless @pid
         raise "Neither pid nor control url available"
       end
 
       begin
-        Process.getpgid pid
+        Process.getpgid @pid
       rescue SystemCallError
-        if @options[:command] == "restart"
-          @options.delete(:command)
+        if @command == "restart"
           start
         else
-          raise "No pid '#{pid}' found"
+          raise "No pid '#{@pid}' found"
         end
       end
 
-      case @options[:command]
+      case @command
       when "restart"
-        Process.kill "SIGUSR2", pid
+        Process.kill "SIGUSR2", @pid
 
       when "halt"
-        Process.kill "QUIT", pid
+        Process.kill "QUIT", @pid
 
       when "stop"
-        Process.kill "SIGTERM", pid
+        Process.kill "SIGTERM", @pid
 
       when "stats"
         puts "Stats not available via pid only"
         return
 
+      when "reload-worker-directory"
+        puts "reload-worker-directory not available via pid only"
+        return
+
       when "phased-restart"
-        Process.kill "SIGUSR1", pid
+        Process.kill "SIGUSR1", @pid
 
       else
         message "Puma is started"
         return
       end
 
-      message "Command #{@options[:command]} sent success"
+      message "Command #{@command} sent success"
     end
 
     def run
-      start if @options[:command] == "start"
+      start if @command == "start"
 
       prepare_configuration
 
-      if is_windows?
+      if Puma.windows?
         send_request
       else
-        @options.has_key?(:control_url) ? send_request : send_signal
+        @control_url ? send_request : send_signal
       end
 
     rescue => e
@@ -232,18 +237,21 @@ module Puma
     def start
       require 'puma/cli'
 
-      run_args = @argv
+      run_args = []
 
-      if path = @options[:state]
-        run_args = ["-S", path] + run_args
-      end
-
-      if path = @options[:config_file]
-        run_args = ["-C", path] + run_args
-      end
+      run_args += ["-S", @state]  if @state
+      run_args += ["-q"] if @quiet
+      run_args += ["--pidfile", @pidfile] if @pidfile
+      run_args += ["--control", @control_url] if @control_url
+      run_args += ["--control-token", @control_auth_token] if @control_auth_token
+      run_args += ["-C", @config_file] if @config_file
 
       events = Puma::Events.new @stdout, @stderr
 
+      # replace $0 because puma use it to generate restart command
+      puma_cmd = $0.gsub(/pumactl$/, 'puma')
+      $0 = puma_cmd if File.exist?(puma_cmd)
+
       cli = Puma::CLI.new run_args, events
       cli.run
     end