File: C:/Ruby27-x64/share/doc/ruby/html/CGI.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class 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 class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-CGI-label-Overview">Overview</a>
<li><a href="#class-CGI-label-Introduction">Introduction</a>
<li><a href="#class-CGI-label-Queries">Queries</a>
<li><a href="#class-CGI-label-Environmental+Variables">Environmental Variables</a>
<li><a href="#class-CGI-label-Parameters">Parameters</a>
<li><a href="#class-CGI-label-Cookies">Cookies</a>
<li><a href="#class-CGI-label-Multipart+requests">Multipart requests</a>
<li><a href="#class-CGI-label-Responses">Responses</a>
<li><a href="#class-CGI-label-Writing+output">Writing output</a>
<li><a href="#class-CGI-label-Generating+HTML">Generating HTML</a>
<li><a href="#class-CGI-label-Utility+HTML+escape+and+other+methods+like+a+function.">Utility HTML escape and other methods like a function.</a>
<li><a href="#class-CGI-label-Examples+of+use">Examples of use</a>
<li><a href="#class-CGI-label-Get+form+values">Get form values</a>
<li><a href="#class-CGI-label-Get+form+values+as+hash">Get form values as hash</a>
<li><a href="#class-CGI-label-Save+form+values+to+file">Save form values to file</a>
<li><a href="#class-CGI-label-Restore+form+values+from+file">Restore form values from file</a>
<li><a href="#class-CGI-label-Get+multipart+form+values">Get multipart form values</a>
<li><a href="#class-CGI-label-Get+cookie+values">Get cookie values</a>
<li><a href="#class-CGI-label-Get+cookie+objects">Get cookie objects</a>
<li><a href="#class-CGI-label-Print+http+header+and+html+string+to+-24DEFAULT_OUTPUT+-28-24-3E-29">Print http header and html string to $DEFAULT_OUTPUT ($>)</a>
<li><a href="#class-CGI-label-Some+utility+methods">Some utility methods</a>
<li><a href="#class-CGI-label-Some+utility+methods+like+a+function">Some utility methods like a function</a>
</ul>
</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>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="CGI/Util.html">CGI::Util</a>
</ul>
</div>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="CGI/Util.html">CGI::Util</a>
<li><a class="extend" href="CGI/QueryExtension.html">CGI::QueryExtension</a>
<li><span class="extend">Html3</span>
<li><a class="extend" href="CGI/HtmlExtension.html">CGI::HtmlExtension</a>
<li><span class="extend">Html4</span>
<li><a class="extend" href="CGI/HtmlExtension.html">CGI::HtmlExtension</a>
<li><span class="extend">Html4Tr</span>
<li><a class="extend" href="CGI/HtmlExtension.html">CGI::HtmlExtension</a>
<li><span class="extend">Html4Tr</span>
<li><span class="extend">Html4Fr</span>
<li><a class="extend" href="CGI/HtmlExtension.html">CGI::HtmlExtension</a>
<li><span class="extend">Html5</span>
<li><a class="extend" href="CGI/HtmlExtension.html">CGI::HtmlExtension</a>
<li><a class="extend" href="CGI/Util.html">CGI::Util</a>
</ul>
</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-accept_charset">::accept_charset</a>
<li ><a href="#method-c-accept_charset-3D">::accept_charset=</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-parse">::parse</a>
<li ><a href="#method-i-_no_crlf_check">#_no_crlf_check</a>
<li ><a href="#method-i-env_table">#env_table</a>
<li ><a href="#method-i-header">#header</a>
<li ><a href="#method-i-http_header">#http_header</a>
<li ><a href="#method-i-out">#out</a>
<li ><a href="#method-i-print">#print</a>
<li ><a href="#method-i-stdinput">#stdinput</a>
<li ><a href="#method-i-stdoutput">#stdoutput</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CGI">
<h1 id="class-CGI" class="class">
class CGI
</h1>
<section class="description">
<h2 id="class-CGI-label-Overview">Overview<span><a href="#class-CGI-label-Overview">¶</a> <a href="#top">↑</a></span></h2>
<p>The Common Gateway Interface (<a href="CGI.html"><code>CGI</code></a>) is a simple protocol for passing an HTTP request from a web server to a standalone program, and returning the output to the web browser. Basically, a <a href="CGI.html"><code>CGI</code></a> program is called with the parameters of the request passed in either in the environment (GET) or via $stdin (POST), and everything it prints to $stdout is returned to the client.</p>
<p>This file holds the <a href="CGI.html"><code>CGI</code></a> class. This class provides functionality for retrieving HTTP request parameters, managing cookies, and generating HTML output.</p>
<p>The file <a href="CGI/Session.html"><code>CGI::Session</code></a> provides session management functionality; see that class for more details.</p>
<p>See <a href="http://www.w3.org/CGI">www.w3.org/CGI</a>/ for more information on the <a href="CGI.html"><code>CGI</code></a> protocol.</p>
<h2 id="class-CGI-label-Introduction">Introduction<span><a href="#class-CGI-label-Introduction">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="CGI.html"><code>CGI</code></a> is a large class, providing several categories of methods, many of which are mixed in from other modules. Some of the documentation is in this class, some in the modules <a href="CGI/QueryExtension.html"><code>CGI::QueryExtension</code></a> and <a href="CGI/HtmlExtension.html"><code>CGI::HtmlExtension</code></a>. See <a href="CGI/Cookie.html"><code>CGI::Cookie</code></a> for specific information on handling cookies, and cgi/session.rb (<a href="CGI/Session.html"><code>CGI::Session</code></a>) for information on sessions.</p>
<p>For queries, <a href="CGI.html"><code>CGI</code></a> provides methods to get at environmental variables, parameters, cookies, and multipart request data. For responses, <a href="CGI.html"><code>CGI</code></a> provides methods for writing output and generating HTML.</p>
<p>Read on for more details. Examples are provided at the bottom.</p>
<h2 id="class-CGI-label-Queries">Queries<span><a href="#class-CGI-label-Queries">¶</a> <a href="#top">↑</a></span></h2>
<p>The <a href="CGI.html"><code>CGI</code></a> class dynamically mixes in parameter and cookie-parsing functionality, environmental variable access, and support for parsing multipart requests (including uploaded files) from the <a href="CGI/QueryExtension.html"><code>CGI::QueryExtension</code></a> module.</p>
<h3 id="class-CGI-label-Environmental+Variables">Environmental Variables<span><a href="#class-CGI-label-Environmental+Variables">¶</a> <a href="#top">↑</a></span></h3>
<p>The standard <a href="CGI.html"><code>CGI</code></a> environmental variables are available as read-only attributes of a <a href="CGI.html"><code>CGI</code></a> object. The following is a list of these variables:</p>
<pre class="ruby"><span class="ruby-constant">AUTH_TYPE</span> <span class="ruby-constant">HTTP_HOST</span> <span class="ruby-constant">REMOTE_IDENT</span>
<span class="ruby-constant">CONTENT_LENGTH</span> <span class="ruby-constant">HTTP_NEGOTIATE</span> <span class="ruby-constant">REMOTE_USER</span>
<span class="ruby-constant">CONTENT_TYPE</span> <span class="ruby-constant">HTTP_PRAGMA</span> <span class="ruby-constant">REQUEST_METHOD</span>
<span class="ruby-constant">GATEWAY_INTERFACE</span> <span class="ruby-constant">HTTP_REFERER</span> <span class="ruby-constant">SCRIPT_NAME</span>
<span class="ruby-constant">HTTP_ACCEPT</span> <span class="ruby-constant">HTTP_USER_AGENT</span> <span class="ruby-constant">SERVER_NAME</span>
<span class="ruby-constant">HTTP_ACCEPT_CHARSET</span> <span class="ruby-constant">PATH_INFO</span> <span class="ruby-constant">SERVER_PORT</span>
<span class="ruby-constant">HTTP_ACCEPT_ENCODING</span> <span class="ruby-constant">PATH_TRANSLATED</span> <span class="ruby-constant">SERVER_PROTOCOL</span>
<span class="ruby-constant">HTTP_ACCEPT_LANGUAGE</span> <span class="ruby-constant">QUERY_STRING</span> <span class="ruby-constant">SERVER_SOFTWARE</span>
<span class="ruby-constant">HTTP_CACHE_CONTROL</span> <span class="ruby-constant">REMOTE_ADDR</span>
<span class="ruby-constant">HTTP_FROM</span> <span class="ruby-constant">REMOTE_HOST</span>
</pre>
<p>For each of these variables, there is a corresponding attribute with the same name, except all lower case and without a preceding HTTP_. <code>content_length</code> and <code>server_port</code> are integers; the rest are strings.</p>
<h3 id="class-CGI-label-Parameters">Parameters<span><a href="#class-CGI-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
<p>The method params() returns a hash of all parameters in the request as name/value-list pairs, where the value-list is an <a href="Array.html"><code>Array</code></a> of one or more values. The <a href="CGI.html"><code>CGI</code></a> object itself also behaves as a hash of parameter names to values, but only returns a single value (as a <a href="String.html"><code>String</code></a>) for each parameter name.</p>
<p>For instance, suppose the request contains the parameter “favourite_colours” with the multiple values “blue” and “green”. The following behavior would occur:</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>[<span class="ruby-string">"favourite_colours"</span>] <span class="ruby-comment"># => ["blue", "green"]</span>
<span class="ruby-identifier">cgi</span>[<span class="ruby-string">"favourite_colours"</span>] <span class="ruby-comment"># => "blue"</span>
</pre>
<p>If a parameter does not exist, the former method will return an empty array, the latter an empty string. The simplest way to test for existence of a parameter is by the has_key? method.</p>
<h3 id="class-CGI-label-Cookies">Cookies<span><a href="#class-CGI-label-Cookies">¶</a> <a href="#top">↑</a></span></h3>
<p>HTTP Cookies are automatically parsed from the request. They are available from the cookies() accessor, which returns a hash from cookie name to <a href="CGI/Cookie.html"><code>CGI::Cookie</code></a> object.</p>
<h3 id="class-CGI-label-Multipart+requests">Multipart requests<span><a href="#class-CGI-label-Multipart+requests">¶</a> <a href="#top">↑</a></span></h3>
<p>If a request's method is POST and its content type is multipart/form-data, then it may contain uploaded files. These are stored by the <a href="CGI/QueryExtension.html"><code>QueryExtension</code></a> module in the parameters of the request. The parameter name is the name attribute of the file input field, as usual. However, the value is not a string, but an <a href="IO.html"><code>IO</code></a> object, either an IOString for small files, or a <a href="Tempfile.html"><code>Tempfile</code></a> for larger ones. This object also has the additional singleton methods:</p>
<dl class="rdoc-list note-list"><dt>local_path()
<dd>
<p>the path of the uploaded file on the local filesystem</p>
</dd><dt>original_filename()
<dd>
<p>the name of the file on the client computer</p>
</dd><dt>content_type()
<dd>
<p>the content type of the file</p>
</dd></dl>
<h2 id="class-CGI-label-Responses">Responses<span><a href="#class-CGI-label-Responses">¶</a> <a href="#top">↑</a></span></h2>
<p>The <a href="CGI.html"><code>CGI</code></a> class provides methods for sending header and content output to the HTTP client, and mixes in methods for programmatic HTML generation from <a href="CGI/HtmlExtension.html"><code>CGI::HtmlExtension</code></a> and CGI::TagMaker modules. The precise version of HTML to use for HTML generation is specified at object creation time.</p>
<h3 id="class-CGI-label-Writing+output">Writing output<span><a href="#class-CGI-label-Writing+output">¶</a> <a href="#top">↑</a></span></h3>
<p>The simplest way to send output to the HTTP client is using the <a href="CGI.html#method-i-out"><code>out()</code></a> method. This takes the HTTP headers as a hash parameter, and the body content via a block. The headers can be generated as a string using the <a href="CGI.html#method-i-http_header"><code>http_header()</code></a> method. The output stream can be written directly to using the <a href="CGI.html#method-i-print"><code>print()</code></a> method.</p>
<h3 id="class-CGI-label-Generating+HTML">Generating HTML<span><a href="#class-CGI-label-Generating+HTML">¶</a> <a href="#top">↑</a></span></h3>
<p>Each HTML element has a corresponding method for generating that element as a <a href="String.html"><code>String</code></a>. The name of this method is the same as that of the element, all lowercase. The attributes of the element are passed in as a hash, and the body as a no-argument block that evaluates to a <a href="String.html"><code>String</code></a>. The HTML generation module knows which elements are always empty, and silently drops any passed-in body. It also knows which elements require matching closing tags and which don't. However, it does not know what attributes are legal for which elements.</p>
<p>There are also some additional HTML generation methods mixed in from the <a href="CGI/HtmlExtension.html"><code>CGI::HtmlExtension</code></a> module. These include individual methods for the different types of form inputs, and methods for elements that commonly take particular attributes where the attributes can be directly specified as arguments, rather than via a hash.</p>
<h3 id="class-CGI-label-Utility+HTML+escape+and+other+methods+like+a+function.">Utility HTML escape and other methods like a function.<span><a href="#class-CGI-label-Utility+HTML+escape+and+other+methods+like+a+function.">¶</a> <a href="#top">↑</a></span></h3>
<p>There are some utility tool defined in cgi/util.rb . And when include, you can use utility methods like a function.</p>
<h2 id="class-CGI-label-Examples+of+use">Examples of use<span><a href="#class-CGI-label-Examples+of+use">¶</a> <a href="#top">↑</a></span></h2>
<h3 id="class-CGI-label-Get+form+values">Get form values<span><a href="#class-CGI-label-Get+form+values">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">cgi</span>[<span class="ruby-string">'field_name'</span>] <span class="ruby-comment"># <== value string for 'field_name'</span>
<span class="ruby-comment"># if not 'field_name' included, then return "".</span>
<span class="ruby-identifier">fields</span> = <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">keys</span> <span class="ruby-comment"># <== array of field names</span>
<span class="ruby-comment"># returns true if form has 'field_name'</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">'field_name'</span>)
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">'field_name'</span>)
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'field_name'</span>)
</pre>
<p>CAUTION! <a href="'field_name'">cgi</a> returned an <a href="Array.html"><code>Array</code></a> with the old cgi.rb(included in Ruby 1.6)</p>
<h3 id="class-CGI-label-Get+form+values+as+hash">Get form values as hash<span><a href="#class-CGI-label-Get+form+values+as+hash">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>
</pre>
<p>cgi.params is a hash.</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>[<span class="ruby-string">'new_field_name'</span>] = [<span class="ruby-string">"value"</span>] <span class="ruby-comment"># add new param</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>[<span class="ruby-string">'field_name'</span>] = [<span class="ruby-string">"new_value"</span>] <span class="ruby-comment"># change value</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">'field_name'</span>) <span class="ruby-comment"># delete param</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>.<span class="ruby-identifier">clear</span> <span class="ruby-comment"># delete all params</span>
</pre>
<h3 id="class-CGI-label-Save+form+values+to+file">Save form values to file<span><a href="#class-CGI-label-Save+form+values+to+file">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"pstore"</span>
<span class="ruby-identifier">db</span> = <span class="ruby-constant">PStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"query.db"</span>)
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">db</span>[<span class="ruby-string">"params"</span>] = <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span>
<span class="ruby-keyword">end</span>
</pre>
<h3 id="class-CGI-label-Restore+form+values+from+file">Restore form values from file<span><a href="#class-CGI-label-Restore+form+values+from+file">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"pstore"</span>
<span class="ruby-identifier">db</span> = <span class="ruby-constant">PStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"query.db"</span>)
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">params</span> = <span class="ruby-identifier">db</span>[<span class="ruby-string">"params"</span>]
<span class="ruby-keyword">end</span>
</pre>
<h3 id="class-CGI-label-Get+multipart+form+values">Get multipart form values<span><a href="#class-CGI-label-Get+multipart+form+values">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">cgi</span>[<span class="ruby-string">'field_name'</span>] <span class="ruby-comment"># <== value string for 'field_name'</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">read</span> <span class="ruby-comment"># <== body of value</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">local_path</span> <span class="ruby-comment"># <== path to local file of value</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">original_filename</span> <span class="ruby-comment"># <== original filename of value</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">content_type</span> <span class="ruby-comment"># <== content_type of value</span>
</pre>
<p>and value has <a href="StringIO.html"><code>StringIO</code></a> or <a href="Tempfile.html"><code>Tempfile</code></a> class methods.</p>
<h3 id="class-CGI-label-Get+cookie+values">Get cookie values<span><a href="#class-CGI-label-Get+cookie+values">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">values</span> = <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span>[<span class="ruby-string">'name'</span>] <span class="ruby-comment"># <== array of 'name'</span>
<span class="ruby-comment"># if not 'name' included, then return [].</span>
<span class="ruby-identifier">names</span> = <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span>.<span class="ruby-identifier">keys</span> <span class="ruby-comment"># <== array of cookie names</span>
</pre>
<p>and cgi.cookies is a hash.</p>
<h3 id="class-CGI-label-Get+cookie+objects">Get cookie objects<span><a href="#class-CGI-label-Get+cookie+objects">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">for</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">cookie</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span>
<span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">expires</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">30</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span>(<span class="ruby-string">"cookie"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span>) {<span class="ruby-string">"string"</span>}
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span> <span class="ruby-comment"># { "name1" => cookie1, "name2" => cookie2, ... }</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span>[<span class="ruby-string">'name'</span>].<span class="ruby-identifier">expires</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">30</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span>(<span class="ruby-string">"cookie"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">cookies</span>[<span class="ruby-string">'name'</span>]) {<span class="ruby-string">"string"</span>}
</pre>
<h3 id="class-CGI-label-Print+http+header+and+html+string+to+-24DEFAULT_OUTPUT+-28-24-3E-29">Print http header and html string to $DEFAULT_OUTPUT ($>)<span><a href="#class-CGI-label-Print+http+header+and+html+string+to+-24DEFAULT_OUTPUT+-28-24-3E-29">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"cgi"</span>
<span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"html4"</span>) <span class="ruby-comment"># add HTML generation methods</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">head</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">title</span> { <span class="ruby-string">"TITLE"</span> }
<span class="ruby-keyword">end</span> <span class="ruby-operator">+</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">body</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">form</span>(<span class="ruby-string">"ACTION"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"uri"</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">p</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">textarea</span>(<span class="ruby-string">"get_text"</span>) <span class="ruby-operator">+</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">br</span> <span class="ruby-operator">+</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">submit</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span> <span class="ruby-operator">+</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">pre</span> <span class="ruby-keyword">do</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escapeHTML</span>(
<span class="ruby-node">"params: #{cgi.params.inspect}\n"</span> <span class="ruby-operator">+</span>
<span class="ruby-node">"cookies: #{cgi.cookies.inspect}\n"</span> <span class="ruby-operator">+</span>
<span class="ruby-constant">ENV</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-node">"#{key} --> #{value}\n"</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">""</span>)
)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># add HTML generation methods</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"html3"</span>) <span class="ruby-comment"># html3.2</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"html4"</span>) <span class="ruby-comment"># html4.01 (Strict)</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"html4Tr"</span>) <span class="ruby-comment"># html4.01 Transitional</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"html4Fr"</span>) <span class="ruby-comment"># html4.01 Frameset</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"html5"</span>) <span class="ruby-comment"># html5</span>
</pre>
<h3 id="class-CGI-label-Some+utility+methods">Some utility methods<span><a href="#class-CGI-label-Some+utility+methods">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'cgi/util'</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escapeHTML</span>(<span class="ruby-string">'Usage: foo "bar" <baz>'</span>)
</pre>
<h3 id="class-CGI-label-Some+utility+methods+like+a+function">Some utility methods like a function<span><a href="#class-CGI-label-Some+utility+methods+like+a+function">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'cgi/util'</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>
<span class="ruby-identifier">escapeHTML</span>(<span class="ruby-string">'Usage: foo "bar" <baz>'</span>)
<span class="ruby-identifier">h</span>(<span class="ruby-string">'Usage: foo "bar" <baz>'</span>) <span class="ruby-comment"># alias</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="CR">CR
<dd><p><a href="String.html"><code>String</code></a> for carriage return</p>
<dt id="EOL">EOL
<dd><p>Standard internet newline sequence</p>
<dt id="HTTP_STATUS">HTTP_STATUS
<dd><p>HTTP status codes.</p>
<dt id="LF">LF
<dd><p><a href="String.html"><code>String</code></a> for linefeed</p>
<dt id="MAX_MULTIPART_COUNT">MAX_MULTIPART_COUNT
<dd><p>Maximum number of request parameters when multipart</p>
<dt id="NEEDS_BINMODE">NEEDS_BINMODE
<dd><p>Whether processing will be required in binary vs text</p>
<dt id="PATH_SEPARATOR">PATH_SEPARATOR
<dd><p>Path separators in different environments.</p>
<dt id="VERSION">VERSION
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-accept_charset" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">accept_charset</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Return the accept character set for this <a href="CGI.html"><code>CGI</code></a> instance.</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-accept_charset" class="method-detail ">
<div class="method-heading">
<span class="method-name">accept_charset</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the accept character set for all new <a href="CGI.html"><code>CGI</code></a> instances.</p>
<div class="method-source-code" id="accept_charset-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 759</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">accept_charset</span>
<span class="ruby-identifier">@@accept_charset</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-accept_charset-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">accept_charset=</span><span
class="method-args">(accept_charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Set.html"><code>Set</code></a> the accept character set for all new <a href="CGI.html"><code>CGI</code></a> instances.</p>
<div class="method-source-code" id="accept_charset-3D-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 764</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">accept_charset=</span>(<span class="ruby-identifier">accept_charset</span>)
<span class="ruby-identifier">@@accept_charset</span>=<span class="ruby-identifier">accept_charset</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
new(tag_maker) { block }
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
new(options_hash = {}) { block }
</span>
</div>
<div class="method-description">
<p>Create a new <a href="CGI.html"><code>CGI</code></a> instance.</p>
<dl class="rdoc-list note-list"><dt><code>tag_maker</code>
<dd>
<p>This is the same as using the <code>options_hash</code> form with the value <code>{ :tag_maker => tag_maker }</code> Note that it is recommended to use the <code>options_hash</code> form, since it also allows you specify the charset you will accept.</p>
</dd><dt><code>options_hash</code>
<dd>
<p>A <a href="Hash.html"><code>Hash</code></a> that recognizes three options:</p>
<dl class="rdoc-list note-list"><dt><code>:accept_charset</code>
<dd>
<p>specifies encoding of received query string. If omitted, <code>@@accept_charset</code> is used. If the encoding is not valid, a <a href="CGI/InvalidEncoding.html"><code>CGI::InvalidEncoding</code></a> will be raised.</p>
<p>Example. Suppose <code>@@accept_charset</code> is “UTF-8”</p>
<p>when not specified:</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span>=<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span> <span class="ruby-comment"># @accept_charset # => "UTF-8"</span>
</pre>
<p>when specified as “EUC-JP”:</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span>=<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:accept_charset</span> <span class="ruby-operator">=></span> <span class="ruby-string">"EUC-JP"</span>) <span class="ruby-comment"># => "EUC-JP"</span>
</pre>
</dd><dt><code>:tag_maker</code>
<dd>
<p><a href="String.html"><code>String</code></a> that specifies which version of the HTML generation methods to use. If not specified, no HTML generation methods will be loaded.</p>
<p>The following values are supported:</p>
<dl class="rdoc-list note-list"><dt>“html3”
<dd>
<p>HTML 3.x</p>
</dd><dt>“html4”
<dd>
<p>HTML 4.0</p>
</dd><dt>“html4Tr”
<dd>
<p>HTML 4.0 Transitional</p>
</dd><dt>“html4Fr”
<dd>
<p>HTML 4.0 with Framesets</p>
</dd><dt>“html5”
<dd>
<p>HTML 5</p>
</dd></dl>
</dd><dt><code>:max_multipart_length</code>
<dd>
<p>Specifies maximum length of multipart data. Can be an <a href="Integer.html"><code>Integer</code></a> scalar or a lambda, that will be evaluated when the request is parsed. This allows more complex logic to be set when determining whether to accept multipart data (e.g. consult a registered users upload allowance)</p>
<p>Default is 128 * 1024 * 1024 bytes</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span>=<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:max_multipart_length</span> <span class="ruby-operator">=></span> <span class="ruby-value">268435456</span>) <span class="ruby-comment"># simple scalar</span>
<span class="ruby-identifier">cgi</span>=<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:max_multipart_length</span> <span class="ruby-operator">=></span> <span class="ruby-operator">-></span> {<span class="ruby-identifier">check_filesystem</span>}) <span class="ruby-comment"># lambda</span>
</pre>
</dd></dl>
</dd><dt><code>block</code>
<dd>
<p>If provided, the block is called when an invalid encoding is encountered. For example:</p>
<pre class="ruby"><span class="ruby-identifier">encoding_errors</span>={}
<span class="ruby-identifier">cgi</span>=<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:accept_charset</span><span class="ruby-operator">=></span><span class="ruby-string">"EUC-JP"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">encoding_errors</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
</pre>
</dd></dl>
<p>Finally, if the <a href="CGI.html"><code>CGI</code></a> object is not created in a standard <a href="CGI.html"><code>CGI</code></a> call environment (that is, it can't locate REQUEST_METHOD in its environment), then it will run in “offline” mode. In this mode, it reads its parameters from the command line or (failing that) from standard input. Otherwise, cookies and other parameters are parsed automatically from the standard <a href="CGI.html"><code>CGI</code></a> locations, which varies according to the REQUEST_METHOD.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 850</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-comment"># :yields: name, value</span>
<span class="ruby-ivar">@accept_charset_error_block</span> = <span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">block</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@options</span>={
<span class="ruby-value">:accept_charset</span><span class="ruby-operator">=></span><span class="ruby-identifier">@@accept_charset</span>,
<span class="ruby-value">:max_multipart_length</span><span class="ruby-operator">=></span><span class="ruby-identifier">@@max_multipart_length</span>
}
<span class="ruby-keyword">case</span> <span class="ruby-identifier">options</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span>
<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-ivar">@options</span>[<span class="ruby-value">:tag_maker</span>]=<span class="ruby-identifier">options</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@accept_charset</span>=<span class="ruby-ivar">@options</span>[<span class="ruby-value">:accept_charset</span>]
<span class="ruby-ivar">@max_multipart_length</span>=<span class="ruby-ivar">@options</span>[<span class="ruby-value">:max_multipart_length</span>]
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">MOD_RUBY</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-constant">ENV</span>.<span class="ruby-identifier">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-identifier">extend</span> <span class="ruby-constant">QueryExtension</span>
<span class="ruby-ivar">@multipart</span> = <span class="ruby-keyword">false</span>
<span class="ruby-identifier">initialize_query</span>() <span class="ruby-comment"># set @params, @cookies</span>
<span class="ruby-ivar">@output_cookies</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@output_hidden</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:tag_maker</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"html3"</span>
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">'html'</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Html3</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">HtmlExtension</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"html4"</span>
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">'html'</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Html4</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">HtmlExtension</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"html4Tr"</span>
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">'html'</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Html4Tr</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">HtmlExtension</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"html4Fr"</span>
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">'html'</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Html4Tr</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Html4Fr</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">HtmlExtension</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"html5"</span>
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">'html'</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Html5</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">HtmlExtension</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse</span><span
class="method-args">(query)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parse an HTTP query string into a hash of key=>value pairs.</p>
<pre class="ruby"><span class="ruby-identifier">params</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">"query_string"</span>)
<span class="ruby-comment"># {"name1" => ["value1", "value2", ...],</span>
<span class="ruby-comment"># "name2" => ["value1", "value2", ...], ... }</span>
</pre>
<div class="method-source-code" id="parse-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 393</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">query</span>)
<span class="ruby-identifier">params</span> = {}
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/[&;]/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pairs</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span> = <span class="ruby-identifier">pairs</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'='</span>,<span class="ruby-value">2</span>).<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">v</span>) }
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">key</span>
<span class="ruby-identifier">params</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">||=</span> []
<span class="ruby-identifier">params</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">push</span>(<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">params</span>.<span class="ruby-identifier">default</span>=[].<span class="ruby-identifier">freeze</span>
<span class="ruby-identifier">params</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-header" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">header</span><span
class="method-args">(options='text/html')</span>
</div>
<div class="method-description">
<p>This method is an alias for <a href="CGI.html#method-i-http_header"><code>http_header</code></a>, when <a href="CGI/HTML5.html"><code>HTML5</code></a> tag maker is inactive.</p>
<p>NOTE: use <a href="CGI.html#method-i-http_header"><code>http_header</code></a> to create HTTP header blocks, this alias is only provided for backwards compatibility.</p>
<p>Using <a href="CGI.html#method-i-header"><code>header</code></a> with the <a href="CGI/HTML5.html"><code>HTML5</code></a> tag maker will create a <header> element.</p>
</div>
<div class="aliases">
Alias for: <a href="CGI.html#method-i-http_header">http_header</a>
</div>
</div>
<div id="method-i-http_header" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
http_header(content_type_string="text/html")
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
http_header(headers_hash)
</span>
</div>
<div class="method-description">
<p>Create an HTTP header block as a string.</p>
<p>Includes the empty line that ends the header block.</p>
<dl class="rdoc-list note-list"><dt><code>content_type_string</code>
<dd>
<p>If this form is used, this string is the <code>Content-Type</code></p>
</dd><dt><code>headers_hash</code>
<dd>
<p>A <a href="Hash.html"><code>Hash</code></a> of header values. The following header keys are recognized:</p>
<dl class="rdoc-list note-list"><dt>type
<dd>
<p>The Content-Type header. Defaults to “text/html”</p>
</dd><dt>charset
<dd>
<p>The charset of the body, appended to the Content-Type header.</p>
</dd><dt>nph
<dd>
<p>A boolean value. If true, prepend protocol string and status code, and date; and sets default values for “server” and “connection” if not explicitly set.</p>
</dd><dt>status
<dd>
<p>The HTTP status code as a <a href="String.html"><code>String</code></a>, returned as the Status header. The values are:</p>
<dl class="rdoc-list note-list"><dt>OK
<dd>
<p>200 OK</p>
</dd><dt>PARTIAL_CONTENT
<dd>
<p>206 Partial Content</p>
</dd><dt>MULTIPLE_CHOICES
<dd>
<p>300 Multiple Choices</p>
</dd><dt>MOVED
<dd>
<p>301 Moved Permanently</p>
</dd><dt>REDIRECT
<dd>
<p>302 Found</p>
</dd><dt>NOT_MODIFIED
<dd>
<p>304 Not Modified</p>
</dd><dt>BAD_REQUEST
<dd>
<p>400 Bad Request</p>
</dd><dt>AUTH_REQUIRED
<dd>
<p>401 Authorization Required</p>
</dd><dt>FORBIDDEN
<dd>
<p>403 Forbidden</p>
</dd><dt>NOT_FOUND
<dd>
<p>404 Not Found</p>
</dd><dt>METHOD_NOT_ALLOWED
<dd>
<p>405 <a href="Method.html"><code>Method</code></a> Not Allowed</p>
</dd><dt>NOT_ACCEPTABLE
<dd>
<p>406 Not Acceptable</p>
</dd><dt>LENGTH_REQUIRED
<dd>
<p>411 Length Required</p>
</dd><dt>PRECONDITION_FAILED
<dd>
<p>412 Precondition Failed</p>
</dd><dt>SERVER_ERROR
<dd>
<p>500 Internal Server <a href="Error.html"><code>Error</code></a></p>
</dd><dt>NOT_IMPLEMENTED
<dd>
<p>501 <a href="Method.html"><code>Method</code></a> Not Implemented</p>
</dd><dt>BAD_GATEWAY
<dd>
<p>502 Bad Gateway</p>
</dd><dt>VARIANT_ALSO_VARIES
<dd>
<p>506 Variant Also Negotiates</p>
</dd></dl>
</dd><dt>server
<dd>
<p>The server software, returned as the Server header.</p>
</dd><dt>connection
<dd>
<p>The connection type, returned as the Connection header (for instance, “close”.</p>
</dd><dt>length
<dd>
<p>The length of the content that will be sent, returned as the Content-Length header.</p>
</dd><dt>language
<dd>
<p>The language of the content, returned as the Content-Language header.</p>
</dd><dt>expires
<dd>
<p>The time on which the current content expires, as a <code>Time</code> object, returned as the Expires header.</p>
</dd><dt>cookie
<dd>
<p>A cookie or cookies, returned as one or more Set-Cookie headers. The value can be the literal string of the cookie; a <a href="CGI/Cookie.html"><code>CGI::Cookie</code></a> object; an <a href="Array.html"><code>Array</code></a> of literal cookie strings or <a href="CGI/Cookie.html"><code>Cookie</code></a> objects; or a hash all of whose values are literal cookie strings or <a href="CGI/Cookie.html"><code>Cookie</code></a> objects.</p>
<p>These cookies are in addition to the cookies held in the @output_cookies field.</p>
</dd></dl>
<p>Other headers can also be set; they are appended as key: value.</p>
</dd></dl>
<p>Examples:</p>
<pre class="ruby"><span class="ruby-identifier">http_header</span>
<span class="ruby-comment"># Content-Type: text/html</span>
<span class="ruby-identifier">http_header</span>(<span class="ruby-string">"text/plain"</span>)
<span class="ruby-comment"># Content-Type: text/plain</span>
<span class="ruby-identifier">http_header</span>(<span class="ruby-string">"nph"</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-string">"status"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"OK"</span>, <span class="ruby-comment"># == "200 OK"</span>
<span class="ruby-comment"># "status" => "200 GOOD",</span>
<span class="ruby-string">"server"</span> <span class="ruby-operator">=></span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'SERVER_SOFTWARE'</span>],
<span class="ruby-string">"connection"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"close"</span>,
<span class="ruby-string">"type"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"text/html"</span>,
<span class="ruby-string">"charset"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"iso-2022-jp"</span>,
<span class="ruby-comment"># Content-Type: text/html; charset=iso-2022-jp</span>
<span class="ruby-string">"length"</span> <span class="ruby-operator">=></span> <span class="ruby-value">103</span>,
<span class="ruby-string">"language"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"ja"</span>,
<span class="ruby-string">"expires"</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">30</span>,
<span class="ruby-string">"cookie"</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">cookie1</span>, <span class="ruby-identifier">cookie2</span>],
<span class="ruby-string">"my_header1"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"my_value"</span>,
<span class="ruby-string">"my_header2"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"my_value"</span>)
</pre>
<p>This method does not perform charset conversion.</p>
<div class="method-source-code" id="http_header-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 160</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">http_header</span>(<span class="ruby-identifier">options</span>=<span class="ruby-string">'text/html'</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">content_type</span> = <span class="ruby-identifier">options</span>
<span class="ruby-identifier">buf</span> = <span class="ruby-identifier">_header_for_string</span>(<span class="ruby-identifier">content_type</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">'type'</span>)
<span class="ruby-identifier">content_type</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">'type'</span>]
<span class="ruby-identifier">buf</span> = <span class="ruby-identifier">_header_for_string</span>(<span class="ruby-identifier">content_type</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">buf</span> = <span class="ruby-identifier">_header_for_hash</span>(<span class="ruby-identifier">options</span>.<span class="ruby-identifier">dup</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"expected String or Hash but got #{options.class}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">MOD_RUBY</span>)
<span class="ruby-identifier">_header_for_modruby</span>(<span class="ruby-identifier">buf</span>)
<span class="ruby-keyword">return</span> <span class="ruby-string">''</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">buf</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">EOL</span> <span class="ruby-comment"># empty line of separator</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="CGI.html#method-i-header">header</a>
</div>
</div>
<div id="method-i-out" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
out(content_type_string='text/html')
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
out(headers_hash)
</span>
</div>
<div class="method-description">
<p>Print an HTTP header and body to $DEFAULT_OUTPUT ($>)</p>
<dl class="rdoc-list note-list"><dt><code>content_type_string</code>
<dd>
<p>If a string is passed, it is assumed to be the content type.</p>
</dd><dt><code>headers_hash</code>
<dd>
<p>This is a <a href="Hash.html"><code>Hash</code></a> of headers, similar to that used by <a href="CGI.html#method-i-http_header"><code>http_header</code></a>.</p>
</dd><dt><code>block</code>
<dd>
<p>A block is required and should evaluate to the body of the response.</p>
</dd></dl>
<p><code>Content-Length</code> is automatically calculated from the size of the <a href="String.html"><code>String</code></a> returned by the content block.</p>
<p>If <code>ENV['REQUEST_METHOD'] == "HEAD"</code>, then only the header is output (the content block is still required, but it is ignored).</p>
<p>If the charset is “iso-2022-jp” or “euc-jp” or “shift_jis” then the content is converted to this charset, and the language is set to “ja”.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span>{ <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># Content-Type: text/html</span>
<span class="ruby-comment"># Content-Length: 6</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># string</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span>(<span class="ruby-string">"text/plain"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># Content-Type: text/plain</span>
<span class="ruby-comment"># Content-Length: 6</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># string</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span>(<span class="ruby-string">"nph"</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-string">"status"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"OK"</span>, <span class="ruby-comment"># == "200 OK"</span>
<span class="ruby-string">"server"</span> <span class="ruby-operator">=></span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'SERVER_SOFTWARE'</span>],
<span class="ruby-string">"connection"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"close"</span>,
<span class="ruby-string">"type"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"text/html"</span>,
<span class="ruby-string">"charset"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"iso-2022-jp"</span>,
<span class="ruby-comment"># Content-Type: text/html; charset=iso-2022-jp</span>
<span class="ruby-string">"language"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"ja"</span>,
<span class="ruby-string">"expires"</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> (<span class="ruby-value">3600</span> <span class="ruby-operator">*</span> <span class="ruby-value">24</span> <span class="ruby-operator">*</span> <span class="ruby-value">30</span>),
<span class="ruby-string">"cookie"</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">cookie1</span>, <span class="ruby-identifier">cookie2</span>],
<span class="ruby-string">"my_header1"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"my_value"</span>,
<span class="ruby-string">"my_header2"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"my_value"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># HTTP/1.1 200 OK</span>
<span class="ruby-comment"># Date: Sun, 15 May 2011 17:35:54 GMT</span>
<span class="ruby-comment"># Server: Apache 2.2.0</span>
<span class="ruby-comment"># Connection: close</span>
<span class="ruby-comment"># Content-Type: text/html; charset=iso-2022-jp</span>
<span class="ruby-comment"># Content-Length: 6</span>
<span class="ruby-comment"># Content-Language: ja</span>
<span class="ruby-comment"># Expires: Tue, 14 Jun 2011 17:35:54 GMT</span>
<span class="ruby-comment"># Set-Cookie: foo</span>
<span class="ruby-comment"># Set-Cookie: bar</span>
<span class="ruby-comment"># my_header1: my_value</span>
<span class="ruby-comment"># my_header2: my_value</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># string</span>
</pre>
<div class="method-source-code" id="out-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 367</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">out</span>(<span class="ruby-identifier">options</span> = <span class="ruby-string">"text/html"</span>) <span class="ruby-comment"># :yield:</span>
<span class="ruby-identifier">options</span> = { <span class="ruby-string">"type"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span> } <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">content</span> = <span class="ruby-keyword">yield</span>
<span class="ruby-identifier">options</span>[<span class="ruby-string">"length"</span>] = <span class="ruby-identifier">content</span>.<span class="ruby-identifier">bytesize</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">output</span> = <span class="ruby-identifier">stdoutput</span>
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">binmode</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span> <span class="ruby-identifier">output</span>.<span class="ruby-identifier">binmode</span>
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">http_header</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">content</span> <span class="ruby-keyword">unless</span> <span class="ruby-string">"HEAD"</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">env_table</span>[<span class="ruby-string">'REQUEST_METHOD'</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-print" class="method-detail ">
<div class="method-heading">
<span class="method-name">print</span><span
class="method-args">(*options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Print an argument or list of arguments to the default output stream</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">print</span> <span class="ruby-comment"># default: cgi.print == $DEFAULT_OUTPUT.print</span>
</pre>
<div class="method-source-code" id="print-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 383</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">options</span>)
<span class="ruby-identifier">stdoutput</span>.<span class="ruby-identifier">print</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span></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-_no_crlf_check" class="method-detail ">
<div class="method-heading">
<span class="method-name">_no_crlf_check</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="_no_crlf_check-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 191</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_no_crlf_check</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">str</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">"A HTTP status or header field must not include CR and LF"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/[\r\n]/</span>
<span class="ruby-identifier">str</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-env_table" class="method-detail ">
<div class="method-heading">
<span class="method-name">env_table</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Synonym for <a href="ENV.html"><code>ENV</code></a>.</p>
<div class="method-source-code" id="env_table-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">env_table</span>
<span class="ruby-constant">ENV</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stdinput" class="method-detail ">
<div class="method-heading">
<span class="method-name">stdinput</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Synonym for $stdin.</p>
<div class="method-source-code" id="stdinput-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stdinput</span>
<span class="ruby-identifier">$stdin</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stdoutput" class="method-detail ">
<div class="method-heading">
<span class="method-name">stdoutput</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Synonym for $stdout.</p>
<div class="method-source-code" id="stdoutput-source">
<pre><span class="ruby-comment"># File lib/cgi/core.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stdoutput</span>
<span class="ruby-identifier">$stdout</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>