ok
Mini Shell
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=US-ASCII" http-equiv="Content-Type" />
<title>Class: Rack::Sendfile</title>
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
<script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
</head>
<body id="top" class="class">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="../index.html">Home</a>
<a href="../index.html#classes">Classes</a>
<a href="../index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="../lib/rack/sendfile_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/rack/sendfile.rb">lib/rack/sendfile.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="../Object.html">Object</a></p>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-c-new">::new</a></li>
<li><a href="#method-i-call">#call</a></li>
</ul>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="../KNOWN-ISSUES.html">KNOWN-ISSUES</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class/Module Index
<span class="search-toggle"><img src="../images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="../Rack.html">Rack</a></li>
<li><a href="../Rack/Auth.html">Rack::Auth</a></li>
<li><a href="../Rack/Auth/AbstractHandler.html">Rack::Auth::AbstractHandler</a></li>
<li><a href="../Rack/Auth/AbstractRequest.html">Rack::Auth::AbstractRequest</a></li>
<li><a href="../Rack/Auth/Basic.html">Rack::Auth::Basic</a></li>
<li><a href="../Rack/Auth/Basic/Request.html">Rack::Auth::Basic::Request</a></li>
<li><a href="../Rack/Auth/Digest.html">Rack::Auth::Digest</a></li>
<li><a href="../Rack/Auth/Digest/MD5.html">Rack::Auth::Digest::MD5</a></li>
<li><a href="../Rack/Auth/Digest/Nonce.html">Rack::Auth::Digest::Nonce</a></li>
<li><a href="../Rack/Auth/Digest/Params.html">Rack::Auth::Digest::Params</a></li>
<li><a href="../Rack/Auth/Digest/Request.html">Rack::Auth::Digest::Request</a></li>
<li><a href="../Rack/BodyProxy.html">Rack::BodyProxy</a></li>
<li><a href="../Rack/Builder.html">Rack::Builder</a></li>
<li><a href="../Rack/Cascade.html">Rack::Cascade</a></li>
<li><a href="../Rack/Chunked.html">Rack::Chunked</a></li>
<li><a href="../Rack/Chunked/Body.html">Rack::Chunked::Body</a></li>
<li><a href="../Rack/CommonLogger.html">Rack::CommonLogger</a></li>
<li><a href="../Rack/ConditionalGet.html">Rack::ConditionalGet</a></li>
<li><a href="../Rack/Config.html">Rack::Config</a></li>
<li><a href="../Rack/ContentLength.html">Rack::ContentLength</a></li>
<li><a href="../Rack/ContentType.html">Rack::ContentType</a></li>
<li><a href="../Rack/Deflater.html">Rack::Deflater</a></li>
<li><a href="../Rack/Deflater/DeflateStream.html">Rack::Deflater::DeflateStream</a></li>
<li><a href="../Rack/Deflater/GzipStream.html">Rack::Deflater::GzipStream</a></li>
<li><a href="../Rack/Directory.html">Rack::Directory</a></li>
<li><a href="../Rack/ETag.html">Rack::ETag</a></li>
<li><a href="../Rack/File.html">Rack::File</a></li>
<li><a href="../Rack/ForwardRequest.html">Rack::ForwardRequest</a></li>
<li><a href="../Rack/Handler.html">Rack::Handler</a></li>
<li><a href="../Rack/Handler/CGI.html">Rack::Handler::CGI</a></li>
<li><a href="../Rack/Handler/EventedMongrel.html">Rack::Handler::EventedMongrel</a></li>
<li><a href="../Rack/Handler/FastCGI.html">Rack::Handler::FastCGI</a></li>
<li><a href="../Rack/Handler/LSWS.html">Rack::Handler::LSWS</a></li>
<li><a href="../Rack/Handler/Mongrel.html">Rack::Handler::Mongrel</a></li>
<li><a href="../Rack/Handler/SCGI.html">Rack::Handler::SCGI</a></li>
<li><a href="../Rack/Handler/SwiftipliedMongrel.html">Rack::Handler::SwiftipliedMongrel</a></li>
<li><a href="../Rack/Handler/Thin.html">Rack::Handler::Thin</a></li>
<li><a href="../Rack/Handler/WEBrick.html">Rack::Handler::WEBrick</a></li>
<li><a href="../Rack/Head.html">Rack::Head</a></li>
<li><a href="../Rack/Lint.html">Rack::Lint</a></li>
<li><a href="../Rack/Lobster.html">Rack::Lobster</a></li>
<li><a href="../Rack/Lock.html">Rack::Lock</a></li>
<li><a href="../Rack/Logger.html">Rack::Logger</a></li>
<li><a href="../Rack/MethodOverride.html">Rack::MethodOverride</a></li>
<li><a href="../Rack/Mime.html">Rack::Mime</a></li>
<li><a href="../Rack/MockRequest.html">Rack::MockRequest</a></li>
<li><a href="../Rack/MockRequest/FatalWarner.html">Rack::MockRequest::FatalWarner</a></li>
<li><a href="../Rack/MockRequest/FatalWarning.html">Rack::MockRequest::FatalWarning</a></li>
<li><a href="../Rack/MockResponse.html">Rack::MockResponse</a></li>
<li><a href="../Rack/Multipart.html">Rack::Multipart</a></li>
<li><a href="../Rack/Multipart/Generator.html">Rack::Multipart::Generator</a></li>
<li><a href="../Rack/Multipart/MultipartPartLimitError.html">Rack::Multipart::MultipartPartLimitError</a></li>
<li><a href="../Rack/Multipart/Parser.html">Rack::Multipart::Parser</a></li>
<li><a href="../Rack/Multipart/UploadedFile.html">Rack::Multipart::UploadedFile</a></li>
<li><a href="../Rack/NullLogger.html">Rack::NullLogger</a></li>
<li><a href="../Rack/Recursive.html">Rack::Recursive</a></li>
<li><a href="../Rack/Reloader.html">Rack::Reloader</a></li>
<li><a href="../Rack/Reloader/Stat.html">Rack::Reloader::Stat</a></li>
<li><a href="../Rack/Request.html">Rack::Request</a></li>
<li><a href="../Rack/Response.html">Rack::Response</a></li>
<li><a href="../Rack/Response/Helpers.html">Rack::Response::Helpers</a></li>
<li><a href="../Rack/RewindableInput.html">Rack::RewindableInput</a></li>
<li><a href="../Rack/RewindableInput/Tempfile.html">Rack::RewindableInput::Tempfile</a></li>
<li><a href="../Rack/Runtime.html">Rack::Runtime</a></li>
<li><a href="../Rack/Sendfile.html">Rack::Sendfile</a></li>
<li><a href="../Rack/Server.html">Rack::Server</a></li>
<li><a href="../Rack/Server/Options.html">Rack::Server::Options</a></li>
<li><a href="../Rack/Session.html">Rack::Session</a></li>
<li><a href="../Rack/Session/Abstract.html">Rack::Session::Abstract</a></li>
<li><a href="../Rack/Session/Abstract/ID.html">Rack::Session::Abstract::ID</a></li>
<li><a href="../Rack/Session/Abstract/SessionHash.html">Rack::Session::Abstract::SessionHash</a></li>
<li><a href="../Rack/Session/Cookie.html">Rack::Session::Cookie</a></li>
<li><a href="../Rack/Session/Cookie/Base64.html">Rack::Session::Cookie::Base64</a></li>
<li><a href="../Rack/Session/Cookie/Base64/JSON.html">Rack::Session::Cookie::Base64::JSON</a></li>
<li><a href="../Rack/Session/Cookie/Base64/Marshal.html">Rack::Session::Cookie::Base64::Marshal</a></li>
<li><a href="../Rack/Session/Cookie/Base64/ZipJSON.html">Rack::Session::Cookie::Base64::ZipJSON</a></li>
<li><a href="../Rack/Session/Cookie/Identity.html">Rack::Session::Cookie::Identity</a></li>
<li><a href="../Rack/Session/Memcache.html">Rack::Session::Memcache</a></li>
<li><a href="../Rack/Session/Pool.html">Rack::Session::Pool</a></li>
<li><a href="../Rack/ShowExceptions.html">Rack::ShowExceptions</a></li>
<li><a href="../Rack/ShowStatus.html">Rack::ShowStatus</a></li>
<li><a href="../Rack/Static.html">Rack::Static</a></li>
<li><a href="../Rack/TempfileReaper.html">Rack::TempfileReaper</a></li>
<li><a href="../Rack/URLMap.html">Rack::URLMap</a></li>
<li><a href="../Rack/Utils.html">Rack::Utils</a></li>
<li><a href="../Rack/Utils/Context.html">Rack::Utils::Context</a></li>
<li><a href="../Rack/Utils/HeaderHash.html">Rack::Utils::HeaderHash</a></li>
<li><a href="../Rack/Utils/InvalidParameterError.html">Rack::Utils::InvalidParameterError</a></li>
<li><a href="../Rack/Utils/KeySpaceConstrainedParams.html">Rack::Utils::KeySpaceConstrainedParams</a></li>
<li><a href="../Rack/Multipart.html">Rack::Utils::Multipart</a></li>
<li><a href="../Rack/Utils/OkJson.html">Rack::Utils::OkJson</a></li>
<li><a href="../Rack/Utils/OkJson/Error.html">Rack::Utils::OkJson::Error</a></li>
<li><a href="../Rack/Utils/OkJson/Utf8Error.html">Rack::Utils::OkJson::Utf8Error</a></li>
<li><a href="../Rack/Utils/ParameterTypeError.html">Rack::Utils::ParameterTypeError</a></li>
<li><a href="../FCGI.html">FCGI</a></li>
<li><a href="../FCGI/Stream.html">FCGI::Stream</a></li>
<li><a href="../WEBrick.html">WEBrick</a></li>
<li><a href="../WEBrick/HTTPResponse.html">WEBrick::HTTPResponse</a></li>
<li><a href="../Object.html">Object</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">Rack::Sendfile</h1>
<div id="description" class="description">
<h1><a href="Sendfile.html">Sendfile</a></h1>
<p>The <a href="Sendfile.html">Sendfile</a> middleware intercepts responses
whose body is being served from a file and replaces it with a server
specific X-<a href="Sendfile.html">Sendfile</a> header. The web server is
then responsible for writing the file contents to the client. This can
dramatically reduce the amount of work required by the Ruby backend and
takes advantage of the web server's optimized file delivery code.</p>
<p>In order to take advantage of this middleware, the response body must
respond to <tt>to_path</tt> and the request must include an X-Sendfile-Type
header. <a href="File.html">Rack::File</a> and other components implement
<tt>to_path</tt> so there's rarely anything you need to do in your
application. The X-Sendfile-Type header is typically set in your web
servers configuration. The following sections attempt to document</p>
<h3>Nginx</h3>
<p>Nginx supports the X-Accel-Redirect header. This is similar to X-<a
href="Sendfile.html">Sendfile</a> but requires parts of the filesystem to
be mapped into a private URL hierarchy.</p>
<p>The following example shows the Nginx configuration required to create a
private "/files/" area, enable X-Accel-Redirect, and pass the special
X-Sendfile-Type and X-Accel-Mapping headers to the backend:</p>
<pre>location ~ /files/(.*) {
internal;
alias /var/www/$1;
}
location / {
proxy_redirect off;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Sendfile-Type X-Accel-Redirect;
proxy_set_header X-Accel-Mapping /var/www/=/files/;
proxy_pass http://127.0.0.1:8080/;
}</pre>
<p>Note that the X-Sendfile-Type header must be set exactly as shown above.
The X-Accel-Mapping header should specify the location on the file system,
followed by an equals sign (=), followed name of the private URL pattern
that it maps to. The middleware performs a simple substitution on the
resulting path.</p>
<p>See Also: <a
href="http://wiki.codemongers.com/NginxXSendfile">wiki.codemongers.com/NginxXSendfile</a></p>
<h3>lighttpd</h3>
<p>Lighttpd has supported some variation of the X-<a
href="Sendfile.html">Sendfile</a> header for some time, although only
recent version support X-<a href="Sendfile.html">Sendfile</a> in a reverse
proxy configuration.</p>
<pre>$HTTP["host"] == "example.com" {
proxy-core.protocol = "http"
proxy-core.balancer = "round-robin"
proxy-core.backends = (
"127.0.0.1:8000",
"127.0.0.1:8001",
...
)
proxy-core.allow-x-sendfile = "enable"
proxy-core.rewrite-request = (
"X-Sendfile-Type" => (".*" => "X-Sendfile")
)
}</pre>
<p>See Also: <a
href="http://redmine.lighttpd.net/wiki/lighttpd/Docs:ModProxyCore">redmine.lighttpd.net/wiki/lighttpd/Docs:ModProxyCore</a></p>
<h3>Apache</h3>
<p>X-<a href="Sendfile.html">Sendfile</a> is supported under Apache 2.x using
a separate module:</p>
<p><a href="https://tn123.org/mod_xsendfile/">tn123.org/mod_xsendfile/</a></p>
<p>Once the module is compiled and installed, you can enable it using
XSendFile config directive:</p>
<pre>RequestHeader Set X-Sendfile-Type X-Sendfile
ProxyPassReverse / http://localhost:8001/
XSendFile on</pre>
<h3>Mapping parameter</h3>
<p>The third parameter allows for an overriding extension of the
X-Accel-Mapping header. Mappings should be provided in tuples of internal
to external. The internal values may contain regular expression syntax,
they will be matched with case indifference.</p>
</div><!-- description -->
<div id="5Buntitled-5D" class="documentation-section">
<!-- Constants -->
<div id="constants-list" class="section">
<h3 class="section-header">Constants</h3>
<dl>
<dt><a name="F">F</a></dt>
<dd class="description"></dd>
</dl>
</div>
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="new-method" class="method-detail ">
<a name="method-c-new"></a>
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(app, variation=nil, mappings=[])</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre>
<span class="ruby-comment"># File lib/rack/sendfile.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">variation</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">mappings</span>=[])
<span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</span>
<span class="ruby-ivar">@variation</span> = <span class="ruby-identifier">variation</span>
<span class="ruby-ivar">@mappings</span> = <span class="ruby-identifier">mappings</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">internal</span>, <span class="ruby-identifier">external</span><span class="ruby-operator">|</span>
[<span class="ruby-node">/^#{internal}/</span>, <span class="ruby-identifier">external</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- new-source -->
</div>
</div><!-- new-method -->
</div><!-- public-class-method-details -->
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="call-method" class="method-detail ">
<a name="method-i-call"></a>
<div class="method-heading">
<span class="method-name">call</span><span
class="method-args">(env)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="call-source">
<pre>
<span class="ruby-comment"># File lib/rack/sendfile.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span> = <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_path</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">variation</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">when</span> <span class="ruby-string">'X-Accel-Redirect'</span>
<span class="ruby-identifier">path</span> = <span class="ruby-constant">F</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_path</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">url</span> = <span class="ruby-identifier">map_accel_path</span>(<span class="ruby-identifier">env</span>, <span class="ruby-identifier">path</span>)
<span class="ruby-identifier">headers</span>[<span class="ruby-constant">CONTENT_LENGTH</span>] = <span class="ruby-string">'0'</span>
<span class="ruby-identifier">headers</span>[<span class="ruby-identifier">type</span>] = <span class="ruby-identifier">url</span>
<span class="ruby-identifier">obody</span> = <span class="ruby-identifier">body</span>
<span class="ruby-identifier">body</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">BodyProxy</span>.<span class="ruby-identifier">new</span>([]) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">obody</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">obody</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:close</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">env</span>[<span class="ruby-string">'rack.errors'</span>].<span class="ruby-identifier">puts</span> <span class="ruby-string">"X-Accel-Mapping header missing"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'X-Sendfile'</span>, <span class="ruby-string">'X-Lighttpd-Send-File'</span>
<span class="ruby-identifier">path</span> = <span class="ruby-constant">F</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_path</span>)
<span class="ruby-identifier">headers</span>[<span class="ruby-constant">CONTENT_LENGTH</span>] = <span class="ruby-string">'0'</span>
<span class="ruby-identifier">headers</span>[<span class="ruby-identifier">type</span>] = <span class="ruby-identifier">path</span>
<span class="ruby-identifier">obody</span> = <span class="ruby-identifier">body</span>
<span class="ruby-identifier">body</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">BodyProxy</span>.<span class="ruby-identifier">new</span>([]) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">obody</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">obody</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:close</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">''</span>, <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">env</span>[<span class="ruby-string">'rack.errors'</span>].<span class="ruby-identifier">puts</span> <span class="ruby-node">"Unknown x-sendfile variation: '#{type}'.\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
[<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span>]
<span class="ruby-keyword">end</span></pre>
</div><!-- call-source -->
</div>
</div><!-- call-method -->
</div><!-- public-instance-method-details -->
</div><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 2</small>.</p>
</div>
</body>
</html>
Zerion Mini Shell 1.0