unicorn 5.0.1 → 5.3.1

data/lib/unicorn/tee_input.rb

@@ -1,6 +1,6 @@
 # -*- encoding: binary -*-
 
-# acts like tee(1) on an input input to provide a input-like stream
+# Acts like tee(1) on an input input to provide a input-like stream
 # while providing rewindable semantics through a File/StringIO backing
 # store.  On the first pass, the input is only read on demand so your
 # Rack application can use input notification (upload progress and
@@ -9,22 +9,22 @@
 # strict interpretation of Rack::Lint::InputWrapper functionality and
 # will not support any deviations from it.
 #
-# When processing uploads, Unicorn exposes a TeeInput object under
-# "rack.input" of the Rack environment.
+# When processing uploads, unicorn exposes a TeeInput object under
+# "rack.input" of the Rack environment by default.
 class Unicorn::TeeInput < Unicorn::StreamInput
   # The maximum size (in +bytes+) to buffer in memory before
   # resorting to a temporary file.  Default is 112 kilobytes.
-  @@client_body_buffer_size = Unicorn::Const::MAX_BODY
+  @@client_body_buffer_size = Unicorn::Const::MAX_BODY # :nodoc:
 
   # sets the maximum size of request bodies to buffer in memory,
   # amounts larger than this are buffered to the filesystem
-  def self.client_body_buffer_size=(bytes)
+  def self.client_body_buffer_size=(bytes) # :nodoc:
     @@client_body_buffer_size = bytes
   end
 
   # returns the maximum size of request bodies to buffer in memory,
   # amounts larger than this are buffered to the filesystem
-  def self.client_body_buffer_size
+  def self.client_body_buffer_size # :nodoc:
     @@client_body_buffer_size
   end
 
@@ -37,7 +37,7 @@ class Unicorn::TeeInput < Unicorn::StreamInput
 
   # Initializes a new TeeInput object.  You normally do not have to call
   # this unless you are writing an HTTP server.
-  def initialize(socket, request)
+  def initialize(socket, request) # :nodoc:
     @len = request.content_length
     super
     @tmp = @len && @len <= @@client_body_buffer_size ?
@@ -125,9 +125,7 @@ private
   end
 
   def tee(buffer)
-    if buffer && buffer.size > 0
-      @tmp.write(buffer)
-    end
+    @tmp.write(buffer) if buffer
     buffer
   end
 end

data/lib/unicorn/version.rb

@@ -1 +1 @@
-Unicorn::Const::UNICORN_VERSION = '5.0.1'
+Unicorn::Const::UNICORN_VERSION = '5.3.1'

data/lib/unicorn/worker.rb

@@ -12,18 +12,19 @@ class Unicorn::Worker
   # :stopdoc:
   attr_accessor :nr, :switched
   attr_reader :to_io # IO.select-compatible
+  attr_reader :master
 
   PER_DROP = Raindrops::PAGE_SIZE / Raindrops::SIZE
   DROPS = []
 
-  def initialize(nr)
+  def initialize(nr, pipe=nil)
     drop_index = nr / PER_DROP
     @raindrop = DROPS[drop_index] ||= Raindrops.new(PER_DROP)
     @offset = nr % PER_DROP
     @raindrop[@offset] = 0
     @nr = nr
     @switched = false
-    @to_io, @master = Unicorn.pipe
+    @to_io, @master = pipe || Unicorn.pipe
   end
 
   def atfork_child # :nodoc:
@@ -111,9 +112,11 @@ class Unicorn::Worker
   # In most cases, you should be using the Unicorn::Configurator#user
   # directive instead.  This method should only be used if you need
   # fine-grained control of exactly when you want to change permissions
-  # in your after_fork hooks.
+  # in your after_fork or after_worker_ready hooks, or if you want to
+  # use the chroot support.
   #
-  # Changes the worker process to the specified +user+ and +group+
+  # Changes the worker process to the specified +user+ and +group+,
+  # and chroots to the current working directory if +chroot+ is set.
   # This is only intended to be called from within the worker
   # process from the +after_fork+ hook.  This should be called in
   # the +after_fork+ hook after any privileged functions need to be
@@ -122,8 +125,11 @@ class Unicorn::Worker
   # Any and all errors raised within this method will be propagated
   # directly back to the caller (usually the +after_fork+ hook.
   # These errors commonly include ArgumentError for specifying an
-  # invalid user/group and Errno::EPERM for insufficient privileges
-  def user(user, group = nil)
+  # invalid user/group and Errno::EPERM for insufficient privileges.
+  #
+  # chroot support is only available in unicorn 5.3.0+
+  # user and group switching appeared in unicorn 0.94.0 (2009-11-05)
+  def user(user, group = nil, chroot = false)
     # we do not protect the caller, checking Process.euid == 0 is
     # insufficient because modern systems have fine-grained
     # capabilities.  Let the caller handle any and all errors.
@@ -134,6 +140,11 @@ class Unicorn::Worker
       Process.initgroups(user, gid)
       Process::GID.change_privilege(gid)
     end
+    if chroot
+      chroot = Dir.pwd if chroot == true
+      Dir.chroot(chroot)
+      Dir.chdir('/')
+    end
     Process.euid != uid and Process::UID.change_privilege(uid)
     @switched = true
   end

data/lib/unicorn.rb

@@ -1,9 +1,14 @@
 # -*- encoding: binary -*-
 require 'etc'
 require 'stringio'
-require 'rack'
 require 'kgio'
 
+begin
+  require 'rack'
+rescue LoadError
+  warn 'rack not available, functionality reduced'
+end
+
 # :stopdoc:
 # Unicorn module containing all of the classes (include C extensions) for
 # running a Unicorn web server.  It contains a minimalist HTTP server with just
@@ -20,7 +25,9 @@ module Unicorn
   # application dispatch.  This is always raised with an empty backtrace
   # since there is nothing in the application stack that is responsible
   # for client shutdowns/disconnects.  This exception is visible to Rack
-  # applications unless PrereadInput middleware is loaded.
+  # applications unless PrereadInput middleware is loaded.  This
+  # is a subclass of the standard EOFError class and applications should
+  # not rescue it explicitly, but rescue EOFError instead.
   ClientShutdown = Class.new(EOFError)
 
   # :stopdoc:
@@ -32,6 +39,9 @@ module Unicorn
   def self.builder(ru, op)
     # allow Configurator to parse cli switches embedded in the ru file
     op = Unicorn::Configurator::RACKUP.merge!(:file => ru, :optparse => op)
+    if ru =~ /\.ru$/ && !defined?(Rack::Builder)
+      abort "rack and Rack::Builder must be available for processing #{ru}"
+    end
 
     # Op is going to get cleared before the returned lambda is called, so
     # save this value so that it's still there when we need it:
@@ -53,38 +63,39 @@ module Unicorn
 
       return inner_app if no_default_middleware
 
+      middleware = { # order matters
+        ContentLength: nil,
+        Chunked: nil,
+        CommonLogger: [ $stderr ],
+        ShowExceptions: nil,
+        Lint: nil,
+        TempfileReaper: nil,
+      }
+
       # return value, matches rackup defaults based on env
       # Unicorn does not support persistent connections, but Rainbows!
       # and Zbatery both do.  Users accustomed to the Rack::Server default
       # middlewares will need ContentLength/Chunked middlewares.
       case ENV["RACK_ENV"]
       when "development"
-        Rack::Builder.new do
-          use Rack::ContentLength
-          use Rack::Chunked
-          use Rack::CommonLogger, $stderr
-          use Rack::ShowExceptions
-          use Rack::Lint
-          use Rack::TempfileReaper if Rack.const_defined?(:TempfileReaper)
-          run inner_app
-        end.to_app
       when "deployment"
-        Rack::Builder.new do
-          use Rack::ContentLength
-          use Rack::Chunked
-          use Rack::CommonLogger, $stderr
-          use Rack::TempfileReaper if Rack.const_defined?(:TempfileReaper)
-          run inner_app
-        end.to_app
+        middleware.delete(:ShowExceptions)
+        middleware.delete(:Lint)
       else
-        inner_app
+        return inner_app
       end
+      Rack::Builder.new do
+        middleware.each do |m, args|
+          use(Rack.const_get(m), *args) if Rack.const_defined?(m)
+        end
+        run inner_app
+      end.to_app
     end
   end
 
   # returns an array of strings representing TCP listen socket addresses
   # and Unix domain socket paths.  This is useful for use with
-  # Raindrops::Middleware under Linux: http://raindrops.bogomips.org/
+  # Raindrops::Middleware under Linux: https://bogomips.org/raindrops/
   def self.listener_names
     Unicorn::HttpServer::LISTENERS.map do |io|
       Unicorn::SocketHelper.sock_name(io)

data/man/man1/unicorn.1

@@ -1,19 +1,19 @@
-.TH UNICORN 1 "September 15, 2009" "Unicorn User Manual"
+.TH "UNICORN" "1" "September 15, 2009" "Unicorn User Manual" ""
 .SH NAME
 .PP
-unicorn - a rackup-like command to launch the Unicorn HTTP server
+unicorn \- a rackup\-like command to launch the Unicorn HTTP server
 .SH SYNOPSIS
 .PP
-unicorn [-c CONFIG_FILE] [-E RACK_ENV] [-D] [RACKUP_FILE]
+unicorn [\-c CONFIG_FILE] [\-E RACK_ENV] [\-D] [RACKUP_FILE]
 .SH DESCRIPTION
 .PP
-A rackup(1)-like command to launch Rack applications using Unicorn.
+A rackup(1)\-like command to launch Rack applications using Unicorn.
 It is expected to be started in your application root (APP_ROOT), but
 the "working_directory" directive may be used in the CONFIG_FILE.
 .PP
-While unicorn takes a myriad of command-line options for compatibility
+While unicorn takes a myriad of command\-line options for compatibility
 with ruby(1) and rackup(1), it is recommended to stick to the few
-command-line options specified in the SYNOPSIS and use the CONFIG_FILE
+command\-line options specified in the SYNOPSIS and use the CONFIG_FILE
 as much as possible.
 .SH RACKUP FILE
 .PP
@@ -21,12 +21,12 @@ This defaults to "config.ru" in APP_ROOT.
 It should be the same file used by rackup(1) and other Rack launchers,
 it uses the \f[I]Rack::Builder\f[] DSL.
 .PP
-Embedded command-line options are mostly parsed for compatibility with
+Embedded command\-line options are mostly parsed for compatibility with
 rackup(1) but strongly discouraged.
 .SH UNICORN OPTIONS
 .TP
-.B -c, --config-file CONFIG_FILE
-Path to the Unicorn-specific config file.
+.B \-c, \-\-config\-file CONFIG_FILE
+Path to the Unicorn\-specific config file.
 The config file is implemented as a Ruby DSL, so Ruby code may executed.
 See the RDoc/ri for the \f[I]Unicorn::Configurator\f[] class for the
 full list of directives available from the DSL.
@@ -36,7 +36,7 @@ output.
 .RS
 .RE
 .TP
-.B -D, --daemonize
+.B \-D, \-\-daemonize
 Run daemonized in the background.
 The process is detached from the controlling terminal and stdin is
 redirected to "/dev/null".
@@ -47,134 +47,135 @@ redirected to "/dev/null".
 .RS
 .RE
 .TP
-.B -E, --env RACK_ENV
+.B \-E, \-\-env RACK_ENV
 Run under the given RACK_ENV.
 See the RACK ENVIRONMENT section for more details.
 .RS
 .RE
 .TP
-.B -l, --listen ADDRESS
+.B \-l, \-\-listen ADDRESS
 Listens on a given ADDRESS.
 ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken to
 mean a TCP socket and PATH is meant to be a path to a UNIX domain
 socket.
 Defaults to "0.0.0.0:8080" (all addresses on TCP port 8080) For
 production deployments, specifying the "listen" directive in CONFIG_FILE
-is recommended as it allows fine-tuning of socket options.
+is recommended as it allows fine\-tuning of socket options.
 .RS
 .RE
 .TP
-.B -N, --no-default-middleware
+.B \-N, \-\-no\-default\-middleware
 Disables loading middleware implied by RACK_ENV.
 This bypasses the configuration documented in the RACK ENVIRONMENT
 section, but still allows RACK_ENV to be used for
-application/framework-specific purposes.
+application/framework\-specific purposes.
 .RS
 .RE
 .SH RACKUP COMPATIBILITY OPTIONS
 .TP
-.B -o, --host HOST
+.B \-o, \-\-host HOST
 Listen on a TCP socket belonging to HOST, default is "0.0.0.0" (all
 addresses).
-If specified multiple times on the command-line, only the last-specified
-value takes effect.
+If specified multiple times on the command\-line, only the
+last\-specified value takes effect.
 This option only exists for compatibility with the rackup(1) command,
-use of "-l"/"--listen" switch is recommended instead.
+use of "\-l"/"\-\-listen" switch is recommended instead.
 .RS
 .RE
 .TP
-.B -p, --port PORT
+.B \-p, \-\-port PORT
 Listen on the specified TCP PORT, default is 8080.
-If specified multiple times on the command-line, only the last-specified
-value takes effect.
+If specified multiple times on the command\-line, only the
+last\-specified value takes effect.
 This option only exists for compatibility with the rackup(1) command,
-use of "-l"/"--listen" switch is recommended instead.
+use of "\-l"/"\-\-listen" switch is recommended instead.
 .RS
 .RE
 .TP
-.B -s, --server SERVER
-No-op, this exists only for compatibility with rackup(1).
+.B \-s, \-\-server SERVER
+No\-op, this exists only for compatibility with rackup(1).
 .RS
 .RE
 .SH RUBY OPTIONS
 .TP
-.B -e, --eval LINE
+.B \-e, \-\-eval LINE
 Evaluate a LINE of Ruby code.
-This evaluation happens immediately as the command-line is being parsed.
+This evaluation happens immediately as the command\-line is being
+parsed.
 .RS
 .RE
 .TP
-.B -d, --debug
+.B \-d, \-\-debug
 Turn on debug mode, the $DEBUG variable is set to true.
 .RS
 .RE
 .TP
-.B -w, --warn
+.B \-w, \-\-warn
 Turn on verbose warnings, the $VERBOSE variable is set to true.
 .RS
 .RE
 .TP
-.B -I, --include PATH
-specify $LOAD_PATH.
-PATH will be prepended to $LOAD_PATH.
+.B \-I, \-\-include PATH
+specify
+\f[I]L\f[]\f[I]O\f[]\f[I]A\f[]\f[I]D\f[]~\f[I]P\f[]~\f[I]A\f[]\f[I]T\f[]\f[I]H\f[].\f[I]P\f[]\f[I]A\f[]\f[I]T\f[]\f[I]H\f[]\f[I]w\f[]\f[I]i\f[]\f[I]l\f[]\f[I]l\f[]\f[I]b\f[]\f[I]e\f[]\f[I]p\f[]\f[I]r\f[]\f[I]e\f[]\f[I]p\f[]\f[I]e\f[]\f[I]n\f[]\f[I]d\f[]\f[I]e\f[]\f[I]d\f[]\f[I]t\f[]\f[I]o\f[]LOAD_PATH.
 The \[aq]:\[aq] character may be used to delimit multiple directories.
 This directive may be used more than once.
 Modifications to $LOAD_PATH take place immediately and in the order they
-were specified on the command-line.
+were specified on the command\-line.
 .RS
 .RE
 .TP
-.B -r, --require LIBRARY
+.B \-r, \-\-require LIBRARY
 require a specified LIBRARY before executing the application.
 The "require" statement will be executed immediately and in the order
-they were specified on the command-line.
+they were specified on the command\-line.
 .RS
 .RE
 .SH SIGNALS
 .PP
 The following UNIX signals may be sent to the master process:
 .IP \[bu] 2
-HUP - reload config file, app, and gracefully restart all workers
+HUP \- reload config file, app, and gracefully restart all workers
 .IP \[bu] 2
-INT/TERM - quick shutdown, kills all workers immediately
+INT/TERM \- quick shutdown, kills all workers immediately
 .IP \[bu] 2
-QUIT - graceful shutdown, waits for workers to finish their current
+QUIT \- graceful shutdown, waits for workers to finish their current
 request before finishing.
 .IP \[bu] 2
-USR1 - reopen all logs owned by the master and all workers See
+USR1 \- reopen all logs owned by the master and all workers See
 Unicorn::Util.reopen_logs for what is considered a log.
 .IP \[bu] 2
-USR2 - reexecute the running binary.
+USR2 \- reexecute the running binary.
 A separate QUIT should be sent to the original process once the child is
 verified to be up and running.
 .IP \[bu] 2
-WINCH - gracefully stops workers but keep the master running.
+WINCH \- gracefully stops workers but keep the master running.
 This will only work for daemonized processes.
 .IP \[bu] 2
-TTIN - increment the number of worker processes by one
+TTIN \- increment the number of worker processes by one
 .IP \[bu] 2
-TTOU - decrement the number of worker processes by one
+TTOU \- decrement the number of worker processes by one
 .PP
-See the SIGNALS (http://unicorn.bogomips.org/SIGNALS.html) document for
+See the SIGNALS (https://bogomips.org/unicorn/SIGNALS.html) document for
 full description of all signals used by Unicorn.
 .SH RACK ENVIRONMENT
 .PP
 Accepted values of RACK_ENV and the middleware they automatically load
 (outside of RACKUP_FILE) are exactly as those in rackup(1):
 .IP \[bu] 2
-development - loads Rack::CommonLogger, Rack::ShowExceptions, and
+development \- loads Rack::CommonLogger, Rack::ShowExceptions, and
 Rack::Lint middleware
 .IP \[bu] 2
-deployment - loads Rack::CommonLogger middleware
+deployment \- loads Rack::CommonLogger middleware
 .IP \[bu] 2
-none - loads no middleware at all, relying entirely on RACKUP_FILE
+none \- loads no middleware at all, relying entirely on RACKUP_FILE
 .PP
 All unrecognized values for RACK_ENV are assumed to be "none".
 Production deployments are strongly encouraged to use "deployment" or
 "none" for maximum performance.
 .PP
-As of Unicorn 0.94.0, RACK_ENV is exported as a process-wide environment
-variable as well.
+As of Unicorn 0.94.0, RACK_ENV is exported as a process\-wide
+environment variable as well.
 While not current a part of the Rack specification as of Rack 1.0.1,
 this has become a de facto standard in the Rack world.
 .PP
@@ -185,8 +186,8 @@ If needed, they must be individually specified in the RACKUP_FILE, some
 frameworks do not require them.
 .SH ENVIRONMENT VARIABLES
 .PP
-The RACK_ENV variable is set by the aforementioned -E switch.
-All application or library-specific environment variables (e.g.
+The RACK_ENV variable is set by the aforementioned \-E switch.
+All application or library\-specific environment variables (e.g.
 TMPDIR) may always be set in the Unicorn CONFIG_FILE in addition to the
 spawning shell.
 When transparently upgrading Unicorn, all environment variables set in
@@ -194,7 +195,7 @@ the old master process are inherited by the new master process.
 Unicorn only uses (and will overwrite) the UNICORN_FD environment
 variable internally when doing transparent upgrades.
 .PP
-UNICORN_FD is a comma-delimited list of one or more file descriptors
+UNICORN_FD is a comma\-delimited list of one or more file descriptors
 used to implement USR2 upgrades.
 Init systems may bind listen sockets itself and spawn unicorn with
 UNICORN_FD set to the file descriptor numbers of the listen socket(s).
@@ -205,13 +206,11 @@ Users relying on this feature do not need to specify a listen socket in
 the unicorn config file.
 .SH SEE ALSO
 .IP \[bu] 2
-unicorn_rails(1)
-.IP \[bu] 2
 \f[I]Rack::Builder\f[] ri/RDoc
 .IP \[bu] 2
 \f[I]Unicorn::Configurator\f[] ri/RDoc
 .IP \[bu] 2
-Unicorn RDoc (http://unicorn.bogomips.org/)
+Unicorn RDoc (https://bogomips.org/unicorn/)
 .IP \[bu] 2
 Rack RDoc (http://www.rubydoc.info/github/rack/rack/)
 .IP \[bu] 2