Class: Rack::File

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/file.rb

Overview

Rack::File serves files below the root given, according to the path info of the Rack request.

Handlers can detect if bodies are a Rack::File, and use mechanisms like sendfile on the path.

Constant Summary collapse

F = 
::File

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root) ⇒ File

Returns a new instance of File.



18
19
20
 
# File 'lib/rack/file.rb', line 18

def initialize(root)
  @root = root
end

Instance Attribute Details

#path ⇒ Object Also known as: to_path

Returns the value of attribute path.



14
15
16
 
# File 'lib/rack/file.rb', line 14

def path
  @path
end

#root ⇒ Object

Returns the value of attribute root.



13
14
15
 
# File 'lib/rack/file.rb', line 13

def root
  @root
end

Instance Method Details

#_call(env) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rack/file.rb', line 28

def _call(env)
  @path_info = Utils.unescape(env["PATH_INFO"])
  return forbidden  if @path_info.include? ".."

  @path = F.join(@root, @path_info)

  begin
    if F.file?(@path) && F.readable?(@path)
      serving
    else
      raise Errno::EPERM
    end
  rescue SystemCallError
    not_found
  end
end

#call(env) ⇒ Object 



22
23
24
 
# File 'lib/rack/file.rb', line 22

def call(env)
  dup._call(env)
end

#each ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/rack/file.rb', line 80

def each
  F.open(@path, "rb") { |file|
    while part = file.read(8192)
      yield part
    end
  }
end

#forbidden ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/rack/file.rb', line 45

def forbidden
  body = "Forbidden\n"
  [403, {"Content-Type" => "text/plain",
         "Content-Length" => body.size.to_s},
   [body]]
end

#not_found ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/rack/file.rb', line 73

def not_found
  body = "File not found: #{@path_info}\n"
  [404, {"Content-Type" => "text/plain",
     "Content-Length" => body.size.to_s},
   [body]]
end

#serving ⇒ Object

NOTE:

We check via File::size? whether this file provides size info
via stat (e.g. /proc files often don't), otherwise we have to
figure it out by reading the whole file into memory. And while
we're at it we also use this as body then.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rack/file.rb', line 58

def serving
  if size = F.size?(@path)
    body = self
  else
    body = [F.read(@path)]
    size = Utils.bytesize(body.first)
  end

  [200, {
    "Last-Modified"  => F.mtime(@path).httpdate,
    "Content-Type"   => Mime.mime_type(F.extname(@path), 'text/plain'),
    "Content-Length" => size.to_s
  }, body]
end