class Rack::Directory - rack-1.6.2 Documentation

# class Rack::Directory

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.

### Constants

DIR_FILE
DIR_PAGE
F
FILESIZE_FORMAT

  Stolen from Ramaze

### Attributes

files[R]
path[RW]
root[RW]

### Public Class Methods

new(root, app=nil) click to toggle source

    # File lib/rack/directory.rb, line 45
    def initialize(root, app=nil)
      @root = F.expand_path(root)
      @app = app || Rack::File.new(@root)
    end

### Public Instance Methods

_call(env) click to toggle source

    # 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) click to toggle source

    # File lib/rack/directory.rb, line 50
    def call(env)
      dup._call(env)
    end

check_forbidden() click to toggle source

    # 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() { |l| ... } click to toggle source

    # 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() click to toggle source

    # 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) click to toggle source

    # 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() click to toggle source

    # 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() click to toggle source

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

    option

    # 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) click to toggle source

    # File lib/rack/directory.rb, line 107
    def stat(node, max = 10)
      F.stat(node)
    rescue Errno::ENOENT, Errno::ELOOP
      return nil
    end

### Private Instance Methods

DIR_FILE_escape(url, *html) click to toggle source

Assumes url is already escaped.

    # File lib/rack/directory.rb, line 163
    def DIR_FILE_escape url, *html
      [url, *html.map { |e| Utils.escape_html(e) }]
    end