Class: Rack::Directory

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

Overview

Rack::Directory serves entries below the root given, according to the path info of the Rack request. If a directory is found, the file's contents will be presented in an html based index. If a file is found, the env will be passed to the specified app.

If app is not specified, a Rack::File of the same root will be used.

Defined Under Namespace

Classes: DirectoryBody

Constant Summary collapse

DIR_FILE =
"<tr><td class='name'><a href='%s'>%s</a></td><td class='size'>%s</td><td class='type'>%s</td><td class='mtime'>%s</td></tr>"
DIR_PAGE =
<<-PAGE
<html><head>
  <title>%s</title>
  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  <style type='text/css'>
table { width:100%%; }
.name { text-align:left; }
.size, .mtime { text-align:right; }
.type { width:11em; }
.mtime { width:15em; }
  </style>
</head><body>
<h1>%s</h1>
<hr />
<table>
  <tr>
<th class='name'>Name</th>
<th class='size'>Size</th>
<th class='type'>Type</th>
<th class='mtime'>Last Modified</th>
  </tr>
%s
</table>
<hr />
</body></html>
PAGE
FILESIZE_FORMAT =

Stolen from Ramaze

[
  ['%.1fT', 1 << 40],
  ['%.1fG', 1 << 30],
  ['%.1fM', 1 << 20],
  ['%.1fK', 1 << 10],
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root, app = nil) ⇒ Directory

Returns a new instance of Directory


59
60
61
62
63
# File 'lib/rack/directory.rb', line 59

def initialize(root, app=nil)
  @root = ::File.expand_path(root)
  @app = app || Rack::File.new(@root)
  @head = Rack::Head.new(lambda { |env| get env })
end

Instance Attribute Details

#pathObject (readonly)

Returns the value of attribute path


57
58
59
# File 'lib/rack/directory.rb', line 57

def path
  @path
end

#rootObject (readonly)

Returns the value of attribute root


57
58
59
# File 'lib/rack/directory.rb', line 57

def root
  @root
end

Instance Method Details

#call(env) ⇒ Object


65
66
67
68
# File 'lib/rack/directory.rb', line 65

def call(env)
  # strip body if this is a HEAD call
  @head.call env
end

#check_bad_request(path_info) ⇒ Object


84
85
86
87
88
89
90
91
92
# File 'lib/rack/directory.rb', line 84

def check_bad_request(path_info)
  return if Utils.valid_path?(path_info)

  body = "Bad Request\n"
  size = body.bytesize
  return [400, {CONTENT_TYPE => "text/plain",
    CONTENT_LENGTH => size.to_s,
    "X-Cascade" => "pass"}, [body]]
end

#check_forbidden(path_info) ⇒ Object


94
95
96
97
98
99
100
101
102
# File 'lib/rack/directory.rb', line 94

def check_forbidden(path_info)
  return unless path_info.include? ".."

  body = "Forbidden\n"
  size = body.bytesize
  return [403, {CONTENT_TYPE => "text/plain",
    CONTENT_LENGTH => size.to_s,
    "X-Cascade" => "pass"}, [body]]
end

#entity_not_found(path_info) ⇒ Object


154
155
156
157
158
159
160
# File 'lib/rack/directory.rb', line 154

def entity_not_found(path_info)
  body = "Entity not found: #{path_info}\n"
  size = body.bytesize
  return [404, {CONTENT_TYPE => "text/plain",
    CONTENT_LENGTH => size.to_s,
    "X-Cascade" => "pass"}, [body]]
end

#filesize_format(int) ⇒ Object


171
172
173
174
175
176
177
# File 'lib/rack/directory.rb', line 171

def filesize_format(int)
  FILESIZE_FORMAT.each do |format, size|
    return format % (int.to_f / size) if int >= size
  end

  "#{int}B"
end

#get(env) ⇒ Object


70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/rack/directory.rb', line 70

def get(env)
  script_name = env[SCRIPT_NAME]
  path_info = Utils.unescape_path(env[PATH_INFO])

  if bad_request = check_bad_request(path_info)
    bad_request
  elsif forbidden = check_forbidden(path_info)
    forbidden
  else
    path = ::File.join(@root, path_info)
    list_path(env, path, path_info, script_name)
  end
end

#list_directory(path_info, path, script_name) ⇒ Object


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/rack/directory.rb', line 104

def list_directory(path_info, path, script_name)
  files = [['../','Parent Directory','','','']]
  glob = ::File.join(path, '*')

  url_head = (script_name.split('/') + path_info.split('/')).map do |part|
    Rack::Utils.escape_path part
  end

  Dir[glob].sort.each do |node|
    stat = stat(node)
    next unless stat
    basename = ::File.basename(node)
    ext = ::File.extname(node)

    url = ::File.join(*url_head + [Rack::Utils.escape_path(basename)])
    size = stat.size
    type = stat.directory? ? 'directory' : Mime.mime_type(ext)
    size = stat.directory? ? '-' : filesize_format(size)
    mtime = stat.mtime.httpdate
    url << '/'  if stat.directory?
    basename << '/'  if stat.directory?

    files << [ url, basename, size, type, mtime ]
  end

  return [ 200, { CONTENT_TYPE =>'text/html; charset=utf-8'}, DirectoryBody.new(@root, path, files) ]
end

#list_path(env, path, path_info, script_name) ⇒ Object

TODO: add correct response if not readable, not sure if 404 is the best

option

140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/rack/directory.rb', line 140

def list_path(env, path, path_info, script_name)
  stat = ::File.stat(path)

  if stat.readable?
    return @app.call(env) if stat.file?
    return list_directory(path_info, path, script_name) if stat.directory?
  else
    raise Errno::ENOENT, 'No such file or directory'
  end

rescue Errno::ENOENT, Errno::ELOOP
  return entity_not_found(path_info)
end

#stat(node) ⇒ Object


132
133
134
135
136
# File 'lib/rack/directory.rb', line 132

def stat(node)
  ::File.stat(node)
rescue Errno::ENOENT, Errno::ELOOP
  return nil
end