Class: DispatchServlet

Inherits:
WEBrick::HTTPServlet::AbstractServlet
  • Object
show all
Defined in:
lib/webrick_server.rb

Overview

A custom dispatch servlet for use with WEBrick. It dispatches requests (using the Rails Dispatcher) to the appropriate controller/action. By default, it restricts WEBrick to a managing a single Rails request at a time, but you can change this behavior by setting ActionController::Base.allow_concurrency to true.

Constant Summary collapse

REQUEST_MUTEX = 
Mutex.new

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(server, options) ⇒ DispatchServlet

:nodoc:



66
67
68
69
70
71
72
73
 
# File 'lib/webrick_server.rb', line 66

def initialize(server, options) #:nodoc:
  @server_options = options
  @file_handler = WEBrick::HTTPServlet::FileHandler.new(server, options[:server_root])
  # Change to the RAILS_ROOT, since Webrick::Daemon.start does a Dir::cwd("/") 
  # OPTIONS['working_directory'] is an absolute path of the RAILS_ROOT, set in railties/lib/commands/servers/webrick.rb 
  Dir.chdir(OPTIONS['working_directory']) if defined?(OPTIONS) && File.directory?(OPTIONS['working_directory']) 
  super
end

Class Method Details

.dispatch(options = {}) ⇒ Object

Start the WEBrick server with the given options, mounting the DispatchServlet at /.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/webrick_server.rb', line 50

def self.dispatch(options = {})
  Socket.do_not_reverse_lookup = true # patch for OS X

  params = { :Port        => options[:port].to_i,
             :ServerType  => options[:server_type],
             :BindAddress => options[:ip] }
  params[:MimeTypes] = options[:mime_types] if options[:mime_types]

  server = WEBrick::HTTPServer.new(params)
  server.mount('/', DispatchServlet, options)

  trap("INT") { server.shutdown }
  
  server.start
end

Instance Method Details

#handle_dispatch(req, res, origin = nil) ⇒ Object

:nodoc:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/webrick_server.rb', line 111

def handle_dispatch(req, res, origin = nil) #:nodoc:
  data = StringIO.new
  Dispatcher.dispatch(
    CGI.new("query", create_env_table(req, origin), StringIO.new(req.body || "")), 
    ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS, 
    data
  )

  header, body = extract_header_and_body(data)

  set_charset(header)
  assign_status(res, header)
  res.cookies.concat(header.delete('set-cookie') || [])
  header.each { |key, val| res[key] = val.join(", ") }
  
  res.body = body
  return true
rescue => err
  p err, err.backtrace
  return false
end

#handle_file(req, res) ⇒ Object

:nodoc:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/webrick_server.rb', line 90

def handle_file(req, res) #:nodoc:
  begin
    req = req.dup
    path = req.path.dup

    # Add .html if the last path piece has no . in it
    path << '.html' if path != '/' && (%r{(^|/)[^./]+$} =~ path) 
    path.gsub!('+', ' ') # Unescape + since FileHandler doesn't do so.

    req.instance_variable_set(:@path_info, path) # Set the modified path...

    @file_handler.send(:service, req, res)      
    return true
  rescue HTTPStatus::PartialContent, HTTPStatus::NotModified => err
    res.set_error(err)
    return true
  rescue => err
    return false
  end
end

#service(req, res) ⇒ Object

:nodoc:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/webrick_server.rb', line 75

def service(req, res) #:nodoc:
  unless handle_file(req, res)
    begin
      REQUEST_MUTEX.lock unless ActionController::Base.allow_concurrency
      unless handle_dispatch(req, res)
        raise WEBrick::HTTPStatus::NotFound, "`#{req.path}' not found."
      end
    ensure
      unless ActionController::Base.allow_concurrency
        REQUEST_MUTEX.unlock if REQUEST_MUTEX.locked?
      end
    end
  end
end