OwlCyberSecurity - MANAGER

Edit File: Server.html

<!DOCTYPE html>

<title>class Rack::Server - rack-2.2.10 Documentation</title>

<div id="table-of-contents-navigation">
 <a href="../table_of_contents.html#pages">Pages</a>
 <a href="../table_of_contents.html#classes">Classes</a>
 <a href="../table_of_contents.html#methods">Methods</a>
 </div>
</div>

</div>

<div id="class-metadata">
 
 <div id="parent-class-section" class="nav-section">
 <h3>Parent</h3>

Object
 
</div>

<div id="method-list-section" class="nav-section">
 <h3>Methods</h3>

<ul class="link-list" role="directory">
 
 <li ><a href="#method-c-default_middleware_by_environment">::default_middleware_by_environment</a>
 
 <li ><a href="#method-c-logging_middleware">::logging_middleware</a>
 
 <li ><a href="#method-c-middleware">::middleware</a>
 
 <li ><a href="#method-c-new">::new</a>
 
 <li ><a href="#method-c-start">::start</a>
 
 <li ><a href="#method-i-app">#app</a>
 
 <li ><a href="#method-i-build_app">#build_app</a>
 
 <li ><a href="#method-i-build_app_and_options_from_config">#build_app_and_options_from_config</a>
 
 <li ><a href="#method-i-build_app_from_string">#build_app_from_string</a>
 
 <li ><a href="#method-i-check_pid-21">#check_pid!</a>
 
 <li ><a href="#method-i-daemonize_app">#daemonize_app</a>
 
 <li ><a href="#method-i-default_options">#default_options</a>
 
 <li ><a href="#method-i-handle_profiling">#handle_profiling</a>
 
 <li ><a href="#method-i-make_profile_name">#make_profile_name</a>
 
 <li ><a href="#method-i-middleware">#middleware</a>
 
 <li ><a href="#method-i-opt_parser">#opt_parser</a>
 
 <li ><a href="#method-i-options">#options</a>
 
 <li ><a href="#method-i-parse_options">#parse_options</a>
 
 <li ><a href="#method-i-pidfile_process_status">#pidfile_process_status</a>
 
 <li ><a href="#method-i-server">#server</a>
 
 <li ><a href="#method-i-start">#start</a>
 
 <li ><a href="#method-i-wrapped_app">#wrapped_app</a>
 
 <li ><a href="#method-i-write_pid">#write_pid</a>
 
 </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="class-Rack::Server">
 <h1 id="class-Rack::Server" class="class">
 class Rack::Server
 </h1>

<section class="attribute-method-details" class="method-section">
 <header>
 <h3>Attributes</h3>
 </header>

<div id="attribute-i-options" class="method-detail">
 <div class="method-heading attribute-method-heading">
 options[W]
 </div>

<section id="public-class-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Public Class Methods</h3>
 </header>

<div id="method-c-default_middleware_by_environment" class="method-detail ">
 
 <div class="method-heading">
 default_middleware_by_environment()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="default_middleware_by_environment-source">
 <pre># File lib/rack/server.rb, line 259
def default_middleware_by_environment
 m = Hash.new {|h, k| h[k] = []}
 m[&quot;deployment&quot;] = [
 [Rack::ContentLength],
 logging_middleware,
 [Rack::TempfileReaper]
 ]
 m[&quot;development&quot;] = [
 [Rack::ContentLength],
 logging_middleware,
 [Rack::ShowExceptions],
 [Rack::Lint],
 [Rack::TempfileReaper]
 ]

m
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-logging_middleware" class="method-detail ">
 
 <div class="method-heading">
 logging_middleware()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="logging_middleware-source">
 <pre># File lib/rack/server.rb, line 253
def logging_middleware
 lambda { |server|
 /CGI/.match?(server.server.name) || server.options[:quiet] ? nil : [Rack::CommonLogger, $stderr]
 }
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-middleware" class="method-detail ">
 
 <div class="method-heading">
 middleware()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="middleware-source">
 <pre># File lib/rack/server.rb, line 277
def middleware
 default_middleware_by_environment
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-new" class="method-detail ">
 
 <div class="method-heading">
 new(options = nil)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 <a href="Server/Options.html"><code>Options</code></a> may include:
<ul><li>
:app

<pre class="ruby">a rack application to run (overrides :config and :builder)
</pre>
</li><li>
:builder

<pre class="ruby">a string to evaluate a Rack::Builder from
</pre>
</li><li>
:config

<pre>a rackup configuration file path to load (.ru)</pre>
</li><li>
:environment

<pre>this selects the middleware that will be wrapped around
your application. Default options available are:
 - development: CommonLogger, ShowExceptions, and Lint
 - deployment: CommonLogger
 - none: no extra middleware
note: when the server is a cgi server, CommonLogger is not included.</pre>
</li><li>
:server

<pre class="ruby">choose a specific Rack::Handler, e.g. cgi, fcgi, webrick
</pre>
</li><li>
:daemonize

<pre>if true, the server will daemonize itself (fork, detach, etc)</pre>
</li><li>
:pid

<pre class="ruby">path to write a pid file after daemonize
</pre>
</li><li>
:Host

<pre class="ruby">the host address to bind to (used by supporting Rack::Handler)
</pre>
</li><li>
:Port

<pre class="ruby">the port to bind to (used by supporting Rack::Handler)
</pre>
</li><li>
:AccessLog

<pre>webrick access log options (or supporting Rack::Handler)</pre>
</li><li>
:debug

<pre class="ruby">turn on debug output ($DEBUG = true)
</pre>
</li><li>
:warn

<pre class="ruby">turn on warnings ($-w = true)
</pre>
</li><li>
:include

<pre class="ruby">add given paths to $LOAD_PATH
</pre>
</li><li>
:require

<pre class="ruby">require the given libraries
</pre>
</li></ul>

Additional options for profiling app initialization include:
<ul><li>
:heapfile

<pre>location for ObjectSpace.dump_all to write the output to</pre>
</li><li>
:profile_file

<pre>location for CPU/Memory (StackProf) profile output (defaults to a tempfile)</pre>
</li><li>
:profile_mode

<pre class="ruby">StackProf profile mode (cpu|wall|object)
</pre>
</li></ul>

<div class="method-source-code" id="new-source">
 <pre># File lib/rack/server.rb, line 215
def initialize(options = nil)
 @ignore_options = []

if options
 @use_default_options = false
 @options = options
 @app = options[:app] if options[:app]
 else
 argv = defined?(SPEC_ARGV) ? SPEC_ARGV : ARGV
 @use_default_options = true
 @options = parse_options(argv)
 end
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-start" class="method-detail ">
 
 <div class="method-heading">
 start(options = nil)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Start a new rack server (like running rackup). This will parse ARGV and provide standard ARGV rackup options, defaulting to load &#39;config.ru&#39;.

Providing an options hash will prevent ARGV parsing and will not include any default options.

This method can be used to very easily launch a CGI application, for example:

<pre class="ruby">Rack::Server.start(
 :app =&gt; lambda do |e|
 [200, {&#39;Content-Type&#39; =&gt; &#39;text/html&#39;}, [&#39;hello world&#39;]]
 end,
 :server =&gt; &#39;cgi&#39;
)
</pre>

Further options available here are documented on Rack::Server#initialize

<div class="method-source-code" id="start-source">
 <pre># File lib/rack/server.rb, line 167
def self.start(options = nil)
 new(options).start
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Public Instance Methods</h3>
 </header>

<div id="method-i-app" class="method-detail ">
 
 <div class="method-heading">
 app()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="app-source">
 <pre># File lib/rack/server.rb, line 248
def app
 @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-default_options" class="method-detail ">
 
 <div class="method-heading">
 default_options()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="default_options-source">
 <pre># File lib/rack/server.rb, line 234
def default_options
 environment = ENV[&#39;RACK_ENV&#39;] || &#39;development&#39;
 default_host = environment == &#39;development&#39; ? &#39;localhost&#39; : &#39;0.0.0.0&#39;

{
 environment: environment,
 pid: nil,
 Port: 9292,
 Host: default_host,
 AccessLog: [],
 config: &quot;config.ru&quot;
 }
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-middleware" class="method-detail ">
 
 <div class="method-heading">
 middleware()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="middleware-source">
 <pre># File lib/rack/server.rb, line 282
def middleware
 self.class.middleware
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-options" class="method-detail ">
 
 <div class="method-heading">
 options()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="options-source">
 <pre># File lib/rack/server.rb, line 229
def options
 merged_options = @use_default_options ? default_options.merge(@options) : @options
 merged_options.reject { |k, v| @ignore_options.include?(k) }
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-server" class="method-detail ">
 
 <div class="method-heading">
 server()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="server-source">
 <pre># File lib/rack/server.rb, line 330
def server
 @_server ||= Rack::Handler.get(options[:server])

unless @_server
 @_server = Rack::Handler.default

# We already speak FastCGI
 @ignore_options = [:File, :Port] if @_server.to_s == &#39;Rack::Handler::FastCGI&#39;
 end

@_server
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-start" class="method-detail ">
 
 <div class="method-heading">
 start(&amp;block)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="start-source">
 <pre># File lib/rack/server.rb, line 286
def start(&amp;block)
 if options[:warn]
 $-w = true
 end

if includes = options[:include]
 $LOAD_PATH.unshift(*includes)
 end

Array(options[:require]).each do |library|
 require library
 end

if options[:debug]
 $DEBUG = true
 require &#39;pp&#39;
 p options[:server]
 pp wrapped_app
 pp app
 end

check_pid! if options[:pid]

# Touch the wrapped app, so that the config.ru is loaded before
 # daemonization (i.e. before chdir, etc).
 handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
 wrapped_app
 end

daemonize_app if options[:daemonize]

write_pid if options[:pid]

trap(:INT) do
 if server.respond_to?(:shutdown)
 server.shutdown
 else
 exit
 end
 end

server.run(wrapped_app, **options, &amp;block)
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Private Instance Methods</h3>
 </header>

<div id="method-i-build_app" class="method-detail ">
 
 <div class="method-heading">
 build_app(app)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="build_app-source">
 <pre># File lib/rack/server.rb, line 411
def build_app(app)
 middleware[options[:environment]].reverse_each do |middleware|
 middleware = middleware.call(self) if middleware.respond_to?(:call)
 next unless middleware
 klass, *args = middleware
 app = klass.new(app, *args)
 end
 app
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-build_app_and_options_from_config" class="method-detail ">
 
 <div class="method-heading">
 build_app_and_options_from_config()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="build_app_and_options_from_config-source">
 <pre># File lib/rack/server.rb, line 344
def build_app_and_options_from_config
 if !::File.exist? options[:config]
 abort &quot;configuration #{options[:config]} not found&quot;
 end

app, options = Rack::Builder.parse_file(self.options[:config], opt_parser)
 @options.merge!(options) { |key, old, new| old }
 app
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-build_app_from_string" class="method-detail ">
 
 <div class="method-heading">
 build_app_from_string()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="build_app_from_string-source">
 <pre># File lib/rack/server.rb, line 392
def build_app_from_string
 Rack::Builder.new_from_string(self.options[:builder])
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-check_pid-21" class="method-detail ">
 
 <div class="method-heading">
 check_pid!()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="check_pid-21-source">
 <pre># File lib/rack/server.rb, line 440
def check_pid!
 case pidfile_process_status
 when :running, :not_owned
 $stderr.puts &quot;A server is already running. Check #{options[:pid]}.&quot;
 exit(1)
 when :dead
 ::File.delete(options[:pid])
 end
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-daemonize_app" class="method-detail ">
 
 <div class="method-heading">
 daemonize_app()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="daemonize_app-source">
 <pre># File lib/rack/server.rb, line 425
def daemonize_app
 # Cannot be covered as it forks
 # :nocov:
 Process.daemon
 # :nocov:
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-handle_profiling" class="method-detail ">
 
 <div class="method-heading">
 handle_profiling(heapfile, profile_mode, filename) { || ... }
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="handle_profiling-source">
 <pre># File lib/rack/server.rb, line 354
def handle_profiling(heapfile, profile_mode, filename)
 if heapfile
 require &quot;objspace&quot;
 ObjectSpace.trace_object_allocations_start
 yield
 GC.start
 ::File.open(heapfile, &quot;w&quot;) { |f| ObjectSpace.dump_all(output: f) }
 exit
 end

if profile_mode
 require &quot;stackprof&quot;
 require &quot;tempfile&quot;

make_profile_name(filename) do |filename|
 ::File.open(filename, &quot;w&quot;) do |f|
 StackProf.run(mode: profile_mode, out: f) do
 yield
 end
 puts &quot;Profile written to: #{filename}&quot;
 end
 end
 exit
 end

yield
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-make_profile_name" class="method-detail ">
 
 <div class="method-heading">
 make_profile_name(filename) { |filename| ... }
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="make_profile_name-source">
 <pre># File lib/rack/server.rb, line 382
def make_profile_name(filename)
 if filename
 yield filename
 else
 ::Dir::Tmpname.create(&quot;profile.dump&quot;) do |tmpname, _, _|
 yield tmpname
 end
 end
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-opt_parser" class="method-detail ">
 
 <div class="method-heading">
 opt_parser()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="opt_parser-source">
 <pre># File lib/rack/server.rb, line 407
def opt_parser
 Options.new
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-parse_options" class="method-detail ">
 
 <div class="method-heading">
 parse_options(args)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="parse_options-source">
 <pre># File lib/rack/server.rb, line 396
def parse_options(args)
 # Don&#39;t evaluate CGI ISINDEX parameters.
 # http://www.meb.uni-bonn.de/docs/cgi/cl.html
 args.clear if ENV.include?(REQUEST_METHOD)

@options = opt_parser.parse!(args)
 @options[:config] = ::File.expand_path(options[:config])
 ENV[&quot;RACK_ENV&quot;] = options[:environment]
 @options
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-pidfile_process_status" class="method-detail ">
 
 <div class="method-heading">
 pidfile_process_status()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="pidfile_process_status-source">
 <pre># File lib/rack/server.rb, line 450
def pidfile_process_status
 return :exited unless ::File.exist?(options[:pid])

pid = ::File.read(options[:pid]).to_i
 return :dead if pid == 0

Process.kill(0, pid)
 :running
rescue Errno::ESRCH
 :dead
rescue Errno::EPERM
 :not_owned
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-wrapped_app" class="method-detail ">
 
 <div class="method-heading">
 wrapped_app()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="wrapped_app-source">
 <pre># File lib/rack/server.rb, line 421
def wrapped_app
 @wrapped_app ||= build_app app
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-write_pid" class="method-detail ">
 
 <div class="method-heading">
 write_pid()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="write_pid-source">
 <pre># File lib/rack/server.rb, line 432
def write_pid
 ::File.open(options[:pid], ::File::CREAT | ::File::EXCL | ::File::WRONLY ){ |f| f.write(&quot;#{Process.pid}&quot;) }
 at_exit { ::FileUtils.rm_f(options[:pid]) }
rescue Errno::EEXIST
 check_pid!
 retry
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 </section>

</main>

<footer id="validator-badges" role="contentinfo">
 <a href="https://validator.w3.org/check/referer">Validate</a>
 Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
 Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>