Class: ActionDispatch::FileHandler

Inherits:
Object
  • Object
show all
Defined in:
actionpack/lib/action_dispatch/middleware/static.rb

Overview

This middleware returns a file’s contents from disk in the body response. When initialized, it can accept optional HTTP headers, which will be set when a response containing a file’s contents is delivered.

This middleware will render the file specified in env["PATH_INFO"] where the base path is in the root directory. For example, if the root is set to public/, then a request with env["PATH_INFO"] of assets/application.js will return a response with the contents of a file located at public/assets/application.js if the file exists. If the file does not exist, a 404 “File not Found” response will be returned.

Instance Method Summary collapse

Constructor Details

#initialize(root, index: "index", headers: {}) ⇒ FileHandler

Returns a new instance of FileHandler.



18
19
20
21
22
 
# File 'actionpack/lib/action_dispatch/middleware/static.rb', line 18

def initialize(root, index: "index", headers: {})
  @root          = root.chomp("/").b
  @file_server   = ::Rack::File.new(@root, headers)
  @index         = index
end

Instance Method Details

#call(env) ⇒ Object 



44
45
46
 
# File 'actionpack/lib/action_dispatch/middleware/static.rb', line 44

def call(env)
  serve(Rack::Request.new(env))
end

#match?(path) ⇒ Boolean

Takes a path to a file. If the file is found, has valid encoding, and has correct read permissions, the return value is a URI-escaped string representing the filename. Otherwise, false is returned.

Used by the Static class to check the existence of a valid file in the server’s public/ directory (see Static#call).

Returns:

  • (Boolean) 


30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'actionpack/lib/action_dispatch/middleware/static.rb', line 30

def match?(path)
  path = ::Rack::Utils.unescape_path path
  return false unless ::Rack::Utils.valid_path? path
  path = ::Rack::Utils.clean_path_info path

  return ::Rack::Utils.escape_path(path).b if file_readable?(path)

  path_with_ext = path + ext
  return ::Rack::Utils.escape_path(path_with_ext).b if file_readable?(path_with_ext)

  path << "/" << @index << ext
  return ::Rack::Utils.escape_path(path).b if file_readable?(path)
end

#serve(request) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'actionpack/lib/action_dispatch/middleware/static.rb', line 48

def serve(request)
  path      = request.path_info
  gzip_path = gzip_file_path(path)

  if gzip_path && gzip_encoding_accepted?(request)
    request.path_info           = gzip_path
    status, headers, body       = @file_server.call(request.env)
    if status == 304
      return [status, headers, body]
    end
    headers["Content-Encoding"] = "gzip"
    headers["Content-Type"]     = content_type(path)
  else
    status, headers, body = @file_server.call(request.env)
  end

  headers["Vary"] = "Accept-Encoding" if gzip_path

  [status, headers, body]
ensure
  request.path_info = path
end