OwlCyberSecurity - MANAGER

Edit File: Static.html

<!DOCTYPE html>

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

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

</div>

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

Object
 
</div>

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

<ul class="link-list" role="directory">
 
 <li ><a href="#method-c-new">::new</a>
 
 <li ><a href="#method-i-add_index_root-3F">#add_index_root?</a>
 
 <li ><a href="#method-i-applicable_rules">#applicable_rules</a>
 
 <li ><a href="#method-i-call">#call</a>
 
 <li ><a href="#method-i-can_serve">#can_serve</a>
 
 <li ><a href="#method-i-overwrite_file_path">#overwrite_file_path</a>
 
 <li ><a href="#method-i-route_file">#route_file</a>
 
 </ul>
</div>

</div>
</nav>

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

<section class="description">
 
The <a href="Static.html"><code>Rack::Static</code></a> middleware intercepts requests for static files (javascript files, images, stylesheets, etc) based on the url prefixes or route mappings passed in the options, and serves them using a <a href="Files.html"><code>Rack::Files</code></a> object. This allows a <a href="../Rack.html"><code>Rack</code></a> stack to serve both static and dynamic content.

Examples:

Serve all requests beginning with /media from the “media” folder located in the current directory (ie media/*):

Same as previous, but instead of returning 404 for missing files under /media, call the next middleware:

<pre class="ruby">use Rack::Static, :urls =&gt; [&quot;/media&quot;], :cascade =&gt; true
</pre>

Serve all requests beginning with /css or /images from the folder “public” in the current directory (ie public/css/* and public/images/*):

<pre class="ruby">use Rack::Static, :urls =&gt; [&quot;/css&quot;, &quot;/images&quot;], :root =&gt; &quot;public&quot;
</pre>

Serve all requests to / with “index.html” from the folder “public” in the current directory (ie public/index.html):

<pre class="ruby">use Rack::Static, :urls =&gt; {&quot;/&quot; =&gt; &#39;index.html&#39;}, :root =&gt; &#39;public&#39;
</pre>

Serve all requests normally from the folder “public” in the current directory but uses index.html as default route for “/”

<pre class="ruby">use Rack::Static, :urls =&gt; [&quot;&quot;], :root =&gt; &#39;public&#39;, :index =&gt;
&#39;index.html&#39;
</pre>

Set custom HTTP Headers for based on rules:

<pre> use Rack::Static, :root =&gt; &#39;public&#39;,
 :header_rules =&gt; [
 [rule, {header_field =&gt; content, header_field =&gt; content}],
 [rule, {header_field =&gt; content}]
 ]

Rules for selecting files:

1) All files
   Provide the :all symbol
   :all =&gt; Matches every file

2) Folders
   Provide the folder path as a string
   &#39;/folder&#39; or &#39;/folder/subfolder&#39; =&gt; Matches files in a certain folder

3) File Extensions
   Provide the file extensions as an array
   [&#39;css&#39;, &#39;js&#39;] or %w(css js) =&gt; Matches files ending in .css or .js

4) Regular Expressions / Regexp
   Provide a regular expression
   %r{\.(?:css|js)\z} =&gt; Matches files ending in .css or .js
   /\.(?:eot|ttf|otf|woff2|woff|svg)\z/ =&gt; Matches files ending in
     the most common web font formats (.eot, .ttf, .otf, .woff2, .woff, .svg)
     Note: This Regexp is available as a shortcut, using the :fonts rule

5) Font Shortcut
   Provide the :fonts symbol
   :fonts =&gt; Uses the Regexp rule stated right above to match all common web font endings

Rule Ordering:
  Rules are applied in the order that they are provided.
  List rather general rules above special ones.

Complete example use case including HTTP header rules:

use Rack::Static, :root =&gt; &#39;public&#39;,
       :header_rules =&gt; [
         # Cache all static files in public caches (e.g. Rack::Cache)
         #  as well as in the browser
         [:all, {&#39;Cache-Control&#39; =&gt; &#39;public, max-age=31536000&#39;}],

# Provide web fonts with cross-origin access-control-headers
 # Firefox requires this when serving assets using a Content Delivery Network
 [:fonts, {&#39;Access-Control-Allow-Origin&#39; =&gt; &#39;*&#39;}]
 ]</pre>

</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">
 new(app, options = {})
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="new-source">
 <pre># File lib/rack/static.rb, line 91
def initialize(app, options = {})
 @app = app
 @urls = options[:urls] || [&quot;/favicon.ico&quot;]
 @index = options[:index]
 @gzip = options[:gzip]
 @cascade = options[:cascade]
 root = options[:root] || Dir.pwd

# HTTP Headers
 @header_rules = options[:header_rules] || []
 # Allow for legacy :cache_control option while prioritizing global header_rules setting
 @header_rules.unshift([:all, { CACHE_CONTROL =&gt; options[:cache_control] }]) if options[:cache_control]

@file_server = Rack::Files.new(root)
end</pre>
 </div>
 
 </div>

</div>

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

<div id="method-i-add_index_root-3F" class="method-detail ">
 
 <div class="method-heading">
 add_index_root?(path)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="add_index_root-3F-source">
 <pre># File lib/rack/static.rb, line 107
def add_index_root?(path)
 @index &amp;&amp; route_file(path) &amp;&amp; path.end_with?(&#39;/&#39;)
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-description">
 
 Convert HTTP header rules to HTTP headers

<div class="method-source-code" id="applicable_rules-source">
 <pre># File lib/rack/static.rb, line 166
def applicable_rules(path)
 @header_rules.find_all do |rule, new_headers|
 case rule
 when :all
 true
 when :fonts
 /\.(?:ttf|otf|eot|woff2|woff|svg)\z/.match?(path)
 when String
 path = ::Rack::Utils.unescape(path)
 path.start_with?(rule) || path.start_with?(&#39;/&#39; + rule)
 when Array
 /\.(#{rule.join(&#39;|&#39;)})\z/.match?(path)
 when Regexp
 rule.match?(path)
 else
 false
 end
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="call-source">
 <pre># File lib/rack/static.rb, line 123
def call(env)
 path = env[PATH_INFO]

if can_serve(path)
 if overwrite_file_path(path)
 env[PATH_INFO] = (add_index_root?(path) ? path + @index : @urls[path])
 elsif @gzip &amp;&amp; env[&#39;HTTP_ACCEPT_ENCODING&#39;] &amp;&amp; /\bgzip\b/.match?(env[&#39;HTTP_ACCEPT_ENCODING&#39;])
 path = env[PATH_INFO]
 env[PATH_INFO] += &#39;.gz&#39;
 response = @file_server.call(env)
 env[PATH_INFO] = path

if response[0] == 404
 response = nil
 elsif response[0] == 304
 # Do nothing, leave headers as is
 else
 if mime_type = Mime.mime_type(::File.extname(path), &#39;text/plain&#39;)
 response[1][CONTENT_TYPE] = mime_type
 end
 response[1][&#39;Content-Encoding&#39;] = &#39;gzip&#39;
 end
 end

path = env[PATH_INFO]
 response ||= @file_server.call(env)

if @cascade &amp;&amp; response[0] == 404
 return @app.call(env)
 end

headers = response[1]
 applicable_rules(path).each do |rule, new_headers|
 new_headers.each { |field, content| headers[field] = content }
 end

response
 else
 @app.call(env)
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="can_serve-source">
 <pre># File lib/rack/static.rb, line 119
def can_serve(path)
 route_file(path) || overwrite_file_path(path)
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="overwrite_file_path-source">
 <pre># File lib/rack/static.rb, line 111
def overwrite_file_path(path)
 @urls.kind_of?(Hash) &amp;&amp; @urls.key?(path) || add_index_root?(path)
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="route_file-source">
 <pre># File lib/rack/static.rb, line 115
def route_file(path)
 @urls.kind_of?(Array) &amp;&amp; @urls.any? { |url| path.index(url) == 0 }
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 </section>

</main>

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