wendell-puma 2.9.2

data/lib/puma/compat.rb

@@ -0,0 +1,18 @@
+# Provides code to work properly on 1.8 and 1.9
+
+class String
+  unless method_defined? :bytesize
+    alias_method :bytesize, :size
+  end
+
+  unless method_defined? :byteslice
+    if RUBY_VERSION < '1.9'
+      alias_method :byteslice, :[]
+    else
+      def byteslice(*arg)
+        enc = self.encoding
+        self.dup.force_encoding(Encoding::ASCII_8BIT).slice(*arg).force_encoding(enc)
+      end
+    end
+  end
+end

data/lib/puma/configuration.rb

@@ -0,0 +1,377 @@
+module Puma
+
+  # The CLI exports it's Configuration object here to allow
+  # apps to pick it up. An app needs to use it conditionally though
+  # since it is not set if the app is launched via another
+  # mechanism than the CLI class.
+
+  class << self
+    attr_accessor :cli_config
+  end
+
+  class Configuration
+    DefaultRackup = "config.ru"
+
+    DefaultTCPHost = "0.0.0.0"
+    DefaultTCPPort = 9292
+    DefaultWorkerTimeout = 60
+
+    def initialize(options)
+      @options = options
+      @options[:mode] ||= :http
+      @options[:binds] ||= []
+      @options[:on_restart] ||= []
+      @options[:before_worker_boot] ||= []
+      @options[:after_worker_boot] ||= []
+      @options[:worker_timeout] ||= DefaultWorkerTimeout
+    end
+
+    attr_reader :options
+
+    def initialize_copy(other)
+      @options = @options.dup
+    end
+
+    def load
+      if path = @options[:config_file]
+        DSL.new(@options)._load_from path
+      end
+
+      # Rakeup default option support
+      if host = @options[:Host]
+        port = @options[:Port] || DefaultTCPPort
+
+        @options[:binds] << "tcp://#{host}:#{port}"
+      end
+
+      if @options[:binds].empty?
+        @options[:binds] << "tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"
+      end
+
+      if @options[:control_url] == "auto"
+        path = Configuration.temp_path
+        @options[:control_url] = "unix://#{path}"
+        @options[:control_url_temp] = path
+      end
+
+      unless @options[:control_auth_token]
+        setup_random_token
+      end
+    end
+
+    # Injects the Configuration object into the env
+    class ConfigMiddleware
+      def initialize(config, app)
+        @config = config
+        @app = app
+      end
+
+      def call(env)
+        env[Const::PUMA_CONFIG] = @config
+        @app.call(env)
+      end
+    end
+
+    # Indicate if there is a properly configured app
+    #
+    def app_configured?
+      @options[:app] || File.exist?(rackup)
+    end
+
+    def rackup
+      @options[:rackup] || DefaultRackup
+    end
+
+    # Load the specified rackup file, pull an options from
+    # the rackup file, and set @app.
+    #
+    def app
+      app = @options[:app]
+
+      unless app
+        unless File.exist?(rackup)
+          raise "Missing rackup file '#{rackup}'"
+        end
+
+        app, options = Rack::Builder.parse_file rackup
+        @options.merge! options
+
+        options.each do |key,val|
+          if key.to_s[0,4] == "bind"
+            @options[:binds] << val
+          end
+        end
+      end
+
+      if @options[:mode] == :tcp
+        require 'puma/tcp_logger'
+
+        logger = @options[:logger] || STDOUT
+        return TCPLogger.new(logger, app, @options[:quiet])
+      end
+
+      if !@options[:quiet] and @options[:environment] == "development"
+        logger = @options[:logger] || STDOUT
+        app = Rack::CommonLogger.new(app, logger)
+      end
+
+      return ConfigMiddleware.new(self, app)
+    end
+
+    def setup_random_token
+      begin
+        require 'openssl'
+      rescue LoadError
+      end
+
+      count = 16
+
+      bytes = nil
+
+      if defined? OpenSSL::Random
+        bytes = OpenSSL::Random.random_bytes(count)
+      elsif File.exist?("/dev/urandom")
+        File.open("/dev/urandom") do |f|
+          bytes = f.read(count)
+        end
+      end
+
+      if bytes
+        token = ""
+        bytes.each_byte { |b| token << b.to_s(16) }
+      else
+        token = (0..count).to_a.map { rand(255).to_s(16) }.join
+      end
+
+      @options[:control_auth_token] = token
+    end
+
+    def self.temp_path
+      require 'tmpdir'
+
+      t = (Time.now.to_f * 1000).to_i
+      "#{Dir.tmpdir}/puma-status-#{t}-#{$$}"
+    end
+
+    # The methods that are available for use inside the config file.
+    #
+    class DSL
+      def initialize(options)
+        @options = options
+      end
+
+      def _load_from(path)
+        instance_eval File.read(path), path, 1
+      end
+
+      # Use +obj+ or +block+ as the Rack app. This allows a config file to
+      # be the app itself.
+      #
+      def app(obj=nil, &block)
+        obj ||= block
+
+        raise "Provide either a #call'able or a block" unless obj
+
+        @options[:app] = obj
+      end
+
+      # Start the Puma control rack app on +url+. This app can be communicated
+      # with to control the main server.
+      #
+      def activate_control_app(url="auto", opts=nil)
+        @options[:control_url] = url
+
+        if opts
+          if tok = opts[:auth_token]
+            @options[:control_auth_token] = tok
+          end
+
+          if opts[:no_token]
+            @options[:control_auth_token] = :none
+          end
+        end
+      end
+
+      # Bind the server to +url+. tcp:// and unix:// are the only accepted
+      # protocols.
+      #
+      def bind(url)
+        @options[:binds] << url
+      end
+
+      # Define the TCP port to bind to. Use +bind+ for more advanced options.
+      #
+      def port(port)
+        @options[:binds] << "tcp://#{Configuration::DefaultTCPHost}:#{port}"
+      end
+
+      # Daemonize the server into the background. Highly suggest that
+      # this be combined with +pidfile+ and +stdout_redirect+.
+      def daemonize(which=true)
+        @options[:daemon] = which
+      end
+
+      # When shutting down, drain the accept socket of pending
+      # connections and proces them. This loops over the accept
+      # socket until there are no more read events and then stops
+      # looking and waits for the requests to finish.
+      def drain_on_shutdown(which=true)
+        @options[:drain_on_shutdown] = which
+      end
+
+      # Set the environment in which the Rack's app will run.
+      def environment(environment)
+        @options[:environment] = environment
+      end
+
+      # Code to run before doing a restart. This code should
+      # close logfiles, database connections, etc.
+      #
+      # This can be called multiple times to add code each time.
+      #
+      def on_restart(&block)
+        @options[:on_restart] << block
+      end
+
+      # Command to use to restart puma. This should be just how to
+      # load puma itself (ie. 'ruby -Ilib bin/puma'), not the arguments
+      # to puma, as those are the same as the original process.
+      #
+      def restart_command(cmd)
+        @options[:restart_cmd] = cmd
+      end
+
+      # Store the pid of the server in the file at +path+.
+      def pidfile(path)
+        @options[:pidfile] = path
+      end
+
+      # Disable request logging.
+      #
+      def quiet
+        @options[:quiet] = true
+      end
+
+      # Load +path+ as a rackup file.
+      #
+      def rackup(path)
+        @options[:rackup] = path.to_s
+      end
+
+      # Redirect STDOUT and STDERR to files specified.
+      def stdout_redirect(stdout=nil, stderr=nil, append=false)
+        @options[:redirect_stdout] = stdout
+        @options[:redirect_stderr] = stderr
+        @options[:redirect_append] = append
+      end
+
+      # Configure +min+ to be the minimum number of threads to use to answer
+      # requests and +max+ the maximum.
+      #
+      def threads(min, max)
+        min = Integer(min)
+        max = Integer(max)
+        if min > max
+          raise "The minimum (#{min}) number of threads must be less than the max (#{max})"
+        end
+
+        @options[:min_threads] = min
+        @options[:max_threads] = max
+      end
+
+      def ssl_bind(host, port, opts)
+        o = [
+          "cert=#{opts[:cert]}",
+          "key=#{opts[:key]}"
+        ]
+
+        @options[:binds] << "ssl://#{host}:#{port}?#{o.join('&')}"
+      end
+
+      # Use +path+ as the file to store the server info state. This is
+      # used by pumactl to query and control the server.
+      #
+      def state_path(path)
+        @options[:state] = path.to_s
+      end
+
+      # *Cluster mode only* How many worker processes to run.
+      #
+      def workers(count)
+        @options[:workers] = count.to_i
+      end
+
+      # *Cluster mode only* Code to run when a worker boots to setup
+      # the process before booting the app.
+      #
+      # This can be called multiple times to add hooks.
+      #
+      def on_worker_boot(&block)
+        @options[:before_worker_boot] << block
+      end
+
+      # *Cluster mode only* Code to run when a worker boots to setup
+      # the process after booting the app.
+      #
+      # This can be called multiple times to add hooks.
+      #
+      def after_worker_boot(&block)
+        @options[:after_worker_boot] << block
+      end
+
+      # The directory to operate out of.
+      def directory(dir)
+        @options[:directory] = dir.to_s
+        @options[:worker_directory] = dir.to_s
+      end
+
+      # Run the app as a raw TCP app instead of an HTTP rack app
+      def tcp_mode
+        @options[:mode] = :tcp
+      end
+
+      # *Cluster mode only* Preload the application before starting
+      # the workers and setting up the listen ports. This conflicts
+      # with using the phased restart feature, you can't use both.
+      #
+      def preload_app!(answer=true)
+        @options[:preload_app] = answer
+      end
+
+      # Use +obj+ or +block+ as the low lever error handler. This allows a config file to
+      # change the default error on the server.
+      #
+      def lowlevel_error_handler(obj=nil, &block)
+        obj ||= block
+        raise "Provide either a #call'able or a block" unless obj
+        @options[:lowlevel_error_handler] = obj
+      end
+
+      # This option is used to allow your app and it's gems to be
+      # properly reloaded when not using preload.
+      #
+      # When set, if puma detects that it's been invoked in the
+      # context of Bundler, it will cleanup the environment and
+      # re-run itself outside the Bundler environment, but directly
+      # using the files that Bundler has setup.
+      #
+      # This means that puma is now decoupled from your Bundler
+      # context and when each worker loads, it will be loading a
+      # new Bundler context and thus can float around as the release
+      # dictates.
+      def prune_bundler(answer=true)
+        @options[:prune_bundler] = answer
+      end
+
+      # Additional text to display in process listing
+      def tag(string)
+        @options[:tag] = string
+      end
+
+      # *Cluster mode only* Set the timeout for workers
+      def worker_timeout(timeout)
+        @options[:worker_timeout] = timeout
+      end
+    end
+  end
+end

data/lib/puma/const.rb

@@ -0,0 +1,165 @@
+require 'rack'
+
+module Puma
+  class UnsupportedOption < RuntimeError
+  end
+
+
+  # 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
+
+  # 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]
+  }]
+
+  # Frequently used constants when constructing requests or responses.  Many times
+  # the constant just refers to a string with the same contents.  Using these constants
+  # gave about a 3% to 10% performance improvement over using the strings directly.
+  #
+  # The constants are frozen because Hash#[]= when called with a String key dups
+  # the String UNLESS the String is frozen. This saves us therefore 2 object
+  # allocations when creating the env hash later.
+  #
+  # While Puma does try to emulate the CGI/1.2 protocol, it does not use the REMOTE_IDENT,
+  # REMOTE_USER, or REMOTE_HOST parameters since those are either a security problem or
+  # too taxing on performance.
+  module Const
+
+    PUMA_VERSION = VERSION = "2.9.2".freeze
+    CODE_NAME = "Team High Five".freeze
+
+    FAST_TRACK_KA_TIMEOUT = 0.2
+
+    # The default number of seconds for another request within a persistent
+    # session.
+    PERSISTENT_TIMEOUT = 20
+
+    # The default number of seconds to wait until we get the first data
+    # 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
+
+    # The original URI requested by the client.
+    REQUEST_URI= 'REQUEST_URI'.freeze
+    REQUEST_PATH = 'REQUEST_PATH'.freeze
+
+    PATH_INFO = 'PATH_INFO'.freeze
+
+    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".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".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
+
+    # The basic max request size we'll try to read.
+    CHUNK_SIZE = 16 * 1024
+
+    # This is the maximum header that is allowed before a client is booted.  The parser detects
+    # this, but we'd also like to do this as well.
+    MAX_HEADER = 1024 * (80 + 32)
+
+    # Maximum request body size before it is moved out of memory and into a tempfile for reading.
+    MAX_BODY = MAX_HEADER
+
+    # A frozen format for this is about 15% faster
+    STATUS_FORMAT = "HTTP/1.1 %d %s\r\nConnection: close\r\n".freeze
+
+    CONTENT_TYPE = "Content-Type".freeze
+
+    LAST_MODIFIED = "Last-Modified".freeze
+    ETAG = "ETag".freeze
+    SLASH = "/".freeze
+    REQUEST_METHOD = "REQUEST_METHOD".freeze
+    GET = "GET".freeze
+    HEAD = "HEAD".freeze
+    # ETag is based on the apache standard of hex mtime-size-inode (inode is 0 on win32)
+    ETAG_FORMAT = "\"%x-%x-%x\"".freeze
+    LINE_END = "\r\n".freeze
+    REMOTE_ADDR = "REMOTE_ADDR".freeze
+    HTTP_X_FORWARDED_FOR = "HTTP_X_FORWARDED_FOR".freeze
+    HTTP_IF_MODIFIED_SINCE = "HTTP_IF_MODIFIED_SINCE".freeze
+    HTTP_IF_NONE_MATCH = "HTTP_IF_NONE_MATCH".freeze
+    REDIRECT = "HTTP/1.1 302 Found\r\nLocation: %s\r\nConnection: close\r\n\r\n".freeze
+    HOST = "HOST".freeze
+
+    SERVER_NAME = "SERVER_NAME".freeze
+    SERVER_PORT = "SERVER_PORT".freeze
+    HTTP_HOST = "HTTP_HOST".freeze
+    PORT_80 = "80".freeze
+    PORT_443 = "443".freeze
+    LOCALHOST = "localhost".freeze
+
+    SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
+    HTTP_11 = "HTTP/1.1".freeze
+    HTTP_10 = "HTTP/1.0".freeze
+
+    SERVER_SOFTWARE = "SERVER_SOFTWARE".freeze
+    GATEWAY_INTERFACE = "GATEWAY_INTERFACE".freeze
+    CGI_VER = "CGI/1.2".freeze
+
+    STOP_COMMAND = "?".freeze
+    HALT_COMMAND = "!".freeze
+    RESTART_COMMAND = "R".freeze
+
+    RACK_INPUT = "rack.input".freeze
+    RACK_URL_SCHEME = "rack.url_scheme".freeze
+    RACK_AFTER_REPLY = "rack.after_reply".freeze
+    PUMA_SOCKET = "puma.socket".freeze
+    PUMA_CONFIG = "puma.config".freeze
+
+    HTTP = "http".freeze
+    HTTPS = "https".freeze
+
+    HTTPS_KEY = "HTTPS".freeze
+
+    HTTP_VERSION = "HTTP_VERSION".freeze
+    HTTP_CONNECTION = "HTTP_CONNECTION".freeze
+
+    HTTP_11_200 = "HTTP/1.1 200 OK\r\n".freeze
+    HTTP_10_200 = "HTTP/1.0 200 OK\r\n".freeze
+
+    CLOSE = "close".freeze
+    KEEP_ALIVE = "Keep-Alive".freeze
+
+    CONTENT_LENGTH2 = "Content-Length".freeze
+    CONTENT_LENGTH_S = "Content-Length: ".freeze
+    TRANSFER_ENCODING = "Transfer-Encoding".freeze
+
+    CONNECTION_CLOSE = "Connection: close\r\n".freeze
+    CONNECTION_KEEP_ALIVE = "Connection: Keep-Alive\r\n".freeze
+
+    TRANSFER_ENCODING_CHUNKED = "Transfer-Encoding: chunked\r\n".freeze
+    CLOSE_CHUNKED = "0\r\n\r\n".freeze
+
+    COLON = ": ".freeze
+
+    NEWLINE = "\n".freeze
+
+    HIJACK_P = "rack.hijack?".freeze
+    HIJACK = "rack.hijack".freeze
+    HIJACK_IO = "rack.hijack_io".freeze
+  end
+end