File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/CGI.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::CGI - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<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 id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-service">#service</a>
<li ><a href="#method-i-start">#start</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::CGI">
<h1 id="class-WEBrick::CGI" class="class">
class WEBrick::CGI
</h1>
<section class="description">
<p>A <a href="CGI.html"><code>CGI</code></a> library using <a href="../WEBrick.html"><code>WEBrick</code></a> requests and responses.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">MyCGI</span> <span class="ruby-operator"><</span> <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">CGI</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_GET</span> <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> = <span class="ruby-string">'it worked!'</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">status</span> = <span class="ruby-value">200</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">MyCGI</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">start</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="CGIError">CGIError
<dd><p>The <a href="CGI.html"><code>CGI</code></a> error exception class</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-config" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">config</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The <a href="CGI.html"><code>CGI</code></a> configuration. This is based on WEBrick::Config::HTTP</p>
</div>
</div>
<div id="attribute-i-logger" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">logger</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The <a href="CGI.html"><code>CGI</code></a> logger</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="CGI.html"><code>CGI</code></a> interface.</p>
<p>The first argument in <code>args</code> is a configuration hash which would update WEBrick::Config::HTTP.</p>
<p>Any remaining arguments are stored in the <code>@options</code> instance variable for use by a subclass.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/cgi.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">MOD_RUBY</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-constant">ENV</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">"GATEWAY_INTERFACE"</span>)
<span class="ruby-constant">Apache</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">setup_cgi_env</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-regexp">%r{HTTP/(\d+\.\d+)}</span> <span class="ruby-operator">=~</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"SERVER_PROTOCOL"</span>]
<span class="ruby-identifier">httpv</span> = <span class="ruby-node">$1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@config</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">update</span>(
<span class="ruby-value">:ServerSoftware</span> <span class="ruby-operator">=></span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"SERVER_SOFTWARE"</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"null"</span>,
<span class="ruby-value">:HTTPVersion</span> <span class="ruby-operator">=></span> <span class="ruby-constant">HTTPVersion</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">httpv</span> <span class="ruby-operator">||</span> <span class="ruby-string">"1.0"</span>),
<span class="ruby-value">:RunOnCGI</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-comment"># to detect if it runs on CGI.</span>
<span class="ruby-value">:NPH</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> <span class="ruby-comment"># set true to run as NPH script.</span>
)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:Logger</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">BasicLog</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$stderr</span>)
<span class="ruby-ivar">@logger</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value">:Logger</span>]
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">args</span>
<span class="ruby-keyword">end</span></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-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads <code>key</code> from the configuration</p>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/webrick/cgi.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">key</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-service" class="method-detail ">
<div class="method-heading">
<span class="method-name">service</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Services the request <code>req</code> which will fill in the response <code>res</code>. See <a href="HTTPServlet/AbstractServlet.html#method-i-service"><code>WEBrick::HTTPServlet::AbstractServlet#service</code></a> for details.</p>
<div class="method-source-code" id="service-source">
<pre><span class="ruby-comment"># File lib/webrick/cgi.rb, line 157</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">service</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">method_name</span> = <span class="ruby-string">"do_"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_method</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/-/</span>, <span class="ruby-string">"_"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">method_name</span>)
<span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">MethodNotAllowed</span>,
<span class="ruby-node">"unsupported method `#{req.request_method}'."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start" class="method-detail ">
<div class="method-heading">
<span class="method-name">start</span><span
class="method-args">(env=ENV, stdin=$stdin, stdout=$stdout)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Starts the <a href="CGI.html"><code>CGI</code></a> process with the given environment <code>env</code> and standard input and output <code>stdin</code> and <code>stdout</code>.</p>
<div class="method-source-code" id="start-source">
<pre><span class="ruby-comment"># File lib/webrick/cgi.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start</span>(<span class="ruby-identifier">env</span>=<span class="ruby-constant">ENV</span>, <span class="ruby-identifier">stdin</span>=<span class="ruby-identifier">$stdin</span>, <span class="ruby-identifier">stdout</span>=<span class="ruby-identifier">$stdout</span>)
<span class="ruby-identifier">sock</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@config</span>, <span class="ruby-identifier">env</span>, <span class="ruby-identifier">stdin</span>, <span class="ruby-identifier">stdout</span>)
<span class="ruby-identifier">req</span> = <span class="ruby-constant">HTTPRequest</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@config</span>)
<span class="ruby-identifier">res</span> = <span class="ruby-constant">HTTPResponse</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@config</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>[<span class="ruby-value">:NPH</span>] <span class="ruby-keyword">or</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">MOD_RUBY</span>)
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">res</span>.<span class="ruby-identifier">setup_header</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@header</span>[<span class="ruby-string">"status"</span>]
<span class="ruby-identifier">phrase</span> = <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-identifier">reason_phrase</span>(<span class="ruby-ivar">@status</span>)
<span class="ruby-ivar">@header</span>[<span class="ruby-string">"status"</span>] = <span class="ruby-node">"#{@status} #{phrase}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">res</span>.<span class="ruby-identifier">status_line</span>
<span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">script_name</span> = (<span class="ruby-identifier">env</span>[<span class="ruby-string">"SCRIPT_NAME"</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">$0</span>)).<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">path_info</span> = (<span class="ruby-identifier">env</span>[<span class="ruby-string">"PATH_INFO"</span>] <span class="ruby-operator">||</span> <span class="ruby-string">""</span>).<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">query_string</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">"QUERY_STRING"</span>]
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">"REMOTE_USER"</span>]
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">request_method</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_method</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">request_uri</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_uri</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">request_http_version</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">http_version</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">keep_alive</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">keep_alive?</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">service</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">set_error</span>(<span class="ruby-identifier">ex</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">code</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">ex</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">set_error</span>(<span class="ruby-identifier">ex</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">fixup</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">MOD_RUBY</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">setup_header</span>
<span class="ruby-constant">Apache</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">status_line</span> = <span class="ruby-node">"#{res.status} #{res.reason_phrase}"</span>
<span class="ruby-constant">Apache</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">res</span>.<span class="ruby-identifier">status</span>
<span class="ruby-identifier">table</span> = <span class="ruby-constant">Apache</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">headers_out</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">header</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">key</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/^content-encoding$/i</span>
<span class="ruby-constant">Apache</span><span class="ruby-operator">::</span><span class="ruby-identifier">request</span>.<span class="ruby-identifier">content_encoding</span> = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/^content-type$/i</span>
<span class="ruby-constant">Apache</span><span class="ruby-operator">::</span><span class="ruby-identifier">request</span>.<span class="ruby-identifier">content_type</span> = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">table</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">cookies</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">cookie</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">table</span>.<span class="ruby-identifier">add</span>(<span class="ruby-string">"Set-Cookie"</span>, <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">to_s</span>)
}
<span class="ruby-constant">Apache</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">send_http_header</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">send_body</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">send_response</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>