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.

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
F = 
::File
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.



45
46
47
48
 
# File 'lib/rack/directory.rb', line 45

def initialize(root, app=nil)
  @root = F.expand_path(root)
  @app = app || Rack::File.new(@root)
end

Instance Attribute Details

#files ⇒ Object (readonly)

Returns the value of attribute files.



42
43
44
 
# File 'lib/rack/directory.rb', line 42

def files
  @files
end

#path ⇒ Object

Returns the value of attribute path.



43
44
45
 
# File 'lib/rack/directory.rb', line 43

def path
  @path
end

#root ⇒ Object

Returns the value of attribute root.



43
44
45
 
# File 'lib/rack/directory.rb', line 43

def root
  @root
end

Instance Method Details

#_call(env) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rack/directory.rb', line 56

def _call(env)
  @env = env
  @script_name = env[SCRIPT_NAME]
  @path_info = Utils.unescape(env[PATH_INFO])

  if forbidden = check_forbidden
    forbidden
  else
    @path = F.join(@root, @path_info)
    list_path
  end
end

#call(env) ⇒ Object 



50
51
52
 
# File 'lib/rack/directory.rb', line 50

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

#check_forbidden ⇒ Object 



69
70
71
72
73
74
75
76
77
 
# File 'lib/rack/directory.rb', line 69

def check_forbidden
  return unless @path_info.include? ".."

  body = "Forbidden\n"
  size = Rack::Utils.bytesize(body)
  return [403, {"Content-Type" => "text/plain",
    CONTENT_LENGTH => size.to_s,
    "X-Cascade" => "pass"}, [body]]
end

#each ⇒ Object 



137
138
139
140
141
142
 
# File 'lib/rack/directory.rb', line 137

def each
  show_path = Rack::Utils.escape_html(@path.sub(/^#{@root}/,''))
  files = @files.map{|f| DIR_FILE % DIR_FILE_escape(*f) }*"\n"
  page  = DIR_PAGE % [ show_path, show_path , files ]
  page.each_line{|l| yield l }
end

#entity_not_found ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/rack/directory.rb', line 129

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

#filesize_format(int) ⇒ Object 



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

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

  int.to_s + 'B'
end

#list_directory ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/rack/directory.rb', line 79

def list_directory
  @files = [['../','Parent Directory','','','']]
  glob = F.join(@path, '*')

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

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

    url = F.join(*url_head + [Rack::Utils.escape(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'}, self ]
end

#list_path ⇒ Object

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

option



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/rack/directory.rb', line 115

def list_path
  @stat = F.stat(@path)

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

rescue Errno::ENOENT, Errno::ELOOP
  return entity_not_found
end

#stat(node, max = 10) ⇒ Object 



107
108
109
110
111
 
# File 'lib/rack/directory.rb', line 107

def stat(node, max = 10)
  F.stat(node)
rescue Errno::ENOENT, Errno::ELOOP
  return nil
end