Class: ActionController::RackRequest

Inherits:
AbstractRequest show all
Defined in:
lib/action_controller/rack_process.rb

Overview

:nodoc:

Defined Under Namespace

Classes: SessionFixationAttempt

Constant Summary collapse

DEFAULT_SESSION_OPTIONS = 
{
  :database_manager => CGI::Session::CookieStore, # store data in cookie
  :prefix           => "ruby_sess.",    # prefix session file names
  :session_path     => "/",             # available to all paths in app
  :session_key      => "_session_id",
  :cookie_only      => true,
  :session_http_only=> true
}

Constants inherited from AbstractRequest

AbstractRequest::HTTP_METHODS, AbstractRequest::HTTP_METHOD_LOOKUP, AbstractRequest::TRUSTED_PROXIES

Instance Attribute Summary collapse

Attributes inherited from AbstractRequest

#env

Instance Method Summary collapse

Methods inherited from AbstractRequest

#accepts, #body, #cache_format, clean_up_ajax_request_body!, #content_length, #content_type, #delete?, #domain, #etag_matches?, extract_content_type_without_parameters, extract_multipart_boundary, #format, #format=, #fresh?, #get?, #head?, #headers, #host, #host_with_port, #if_modified_since, #if_none_match, #method, #not_modified?, #parameters, parse_multipart_form_parameters, parse_query_parameters, parse_request_parameters, #path, #path_parameters, #path_parameters=, #port, #port_string, #post?, #protocol, #put?, #query_parameters, #raw_host_with_port, #raw_post, #referrer, relative_url_root=, #remote_addr, #remote_ip, #request_method, #request_parameters, #request_uri, #session=, #ssl?, #standard_port, #subdomains, #symbolized_path_parameters, #template_format, #url, #xml_http_request?

Constructor Details

#initialize(env, session_options = DEFAULT_SESSION_OPTIONS) ⇒ RackRequest

Returns a new instance of RackRequest.



21
22
23
24
25
26
 
# File 'lib/action_controller/rack_process.rb', line 21

def initialize(env, session_options = DEFAULT_SESSION_OPTIONS)
  @session_options = session_options
  @env = env
  @cgi = CGIWrapper.new(self)
  super()
end

Instance Attribute Details

#cgi ⇒ Object (readonly)

Returns the value of attribute cgi.



7
8
9
 
# File 'lib/action_controller/rack_process.rb', line 7

def cgi
  @cgi
end

#session_options ⇒ Object

Returns the value of attribute session_options.



6
7
8
 
# File 'lib/action_controller/rack_process.rb', line 6

def session_options
  @session_options
end

Instance Method Details

#body_stream ⇒ Object

:nodoc:



50
51
52
 
# File 'lib/action_controller/rack_process.rb', line 50

def body_stream #:nodoc:
  @env['rack.input']
end

#cookies ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/action_controller/rack_process.rb', line 58

def cookies
  return {} unless @env["HTTP_COOKIE"]

  unless @env["rack.request.cookie_string"] == @env["HTTP_COOKIE"]
    @env["rack.request.cookie_string"] = @env["HTTP_COOKIE"]
    @env["rack.request.cookie_hash"] = CGI::Cookie::parse(@env["rack.request.cookie_string"])
  end

  @env["rack.request.cookie_hash"]
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/action_controller/rack_process.rb', line 54

def key?(key)
  @env.key?(key)
end

#query_string ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'lib/action_controller/rack_process.rb', line 41

def query_string
  qs = super
  if !qs.blank?
    qs
  else
    @env['QUERY_STRING']
  end
end

#reset_session ⇒ Object 



109
110
111
112
 
# File 'lib/action_controller/rack_process.rb', line 109

def reset_session
  @session.delete if defined?(@session) && @session.is_a?(CGI::Session)
  @session = new_session
end

#server_port ⇒ Object 



69
70
71
 
# File 'lib/action_controller/rack_process.rb', line 69

def server_port
  @env['SERVER_PORT'].to_i
end

#server_software ⇒ Object 



73
74
75
 
# File 'lib/action_controller/rack_process.rb', line 73

def server_software
  @env['SERVER_SOFTWARE'].split("/").first
end

#session ⇒ Object 



77
78
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
106
107
 
# File 'lib/action_controller/rack_process.rb', line 77

def session
  unless defined?(@session)
    if @session_options == false
      @session = Hash.new
    else
      stale_session_check! do
        if cookie_only? && query_parameters[session_options_with_string_keys['session_key']]
          raise SessionFixationAttempt
        end
        case value = session_options_with_string_keys['new_session']
          when true
            @session = new_session
          when false
            begin
              @session = CGI::Session.new(@cgi, session_options_with_string_keys)
            # CGI::Session raises ArgumentError if 'new_session' == false
            # and no session cookie or query param is present.
            rescue ArgumentError
              @session = Hash.new
            end
          when nil
            @session = CGI::Session.new(@cgi, session_options_with_string_keys)
          else
            raise ArgumentError, "Invalid new_session option: #{value}"
        end
        @session['__valid_session']
      end
    end
  end
  @session
end