Class: ActionDispatch::Cookies::CookieJar
- Inherits:
-
Object
- Object
- ActionDispatch::Cookies::CookieJar
- Includes:
- ChainedCookieJars, Enumerable
- Defined in:
- lib/action_dispatch/middleware/cookies.rb
Overview
:nodoc:
Direct Known Subclasses
ActionController::RequestForgeryProtection::ProtectionMethods::NullSession::NullCookieJar
Constant Summary collapse
- DOMAIN_REGEXP =
This regular expression is used to split the levels of a domain. The top level domain can be any string without a period or ., *. style TLDs like co.uk or com.au
www.example.co.uk gives: $& => example.co.uk
example.com gives: $& => example.com
lots.of.subdomains.example.local gives: $& => example.local
/[^.]*\.([^.]*|..\...|...\...)$/
Class Method Summary collapse
Instance Method Summary collapse
-
#[](name) ⇒ Object
Returns the value of the cookie by
name
, ornil
if no such cookie exists. -
#[]=(name, options) ⇒ Object
Sets the cookie named
name
. -
#clear(options = {}) ⇒ Object
Removes all cookies on the client machine by calling
delete
for each cookie. - #commit! ⇒ Object
- #committed? ⇒ Boolean
-
#delete(name, options = {}) ⇒ Object
Removes the cookie on the client machine by setting the value to an empty string and the expiration date in the past.
-
#deleted?(name, options = {}) ⇒ Boolean
Whether the given cookie is to be deleted by this CookieJar.
- #each(&block) ⇒ Object
- #fetch(name, *args, &block) ⇒ Object
-
#handle_options(options) ⇒ Object
:nodoc:.
-
#initialize(key_generator, host = nil, secure = false, options = {}) ⇒ CookieJar
constructor
A new instance of CookieJar.
- #key?(name) ⇒ Boolean (also: #has_key?)
-
#recycle! ⇒ Object
:nodoc:.
- #update(other_hash) ⇒ Object
- #write(headers) ⇒ Object
Methods included from ChainedCookieJars
#encrypted, #permanent, #signed, #signed_or_encrypted
Constructor Details
#initialize(key_generator, host = nil, secure = false, options = {}) ⇒ CookieJar
Returns a new instance of CookieJar.
234 235 236 237 238 239 240 241 242 243 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 234 def initialize(key_generator, host = nil, secure = false, = {}) @key_generator = key_generator @set_cookies = {} @delete_cookies = {} @host = host @secure = secure @options = @cookies = {} @committed = false end |
Class Method Details
.build(request) ⇒ Object
221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 221 def self.build(request) env = request.env key_generator = env[GENERATOR_KEY] = env host = request.host secure = request.ssl? new(key_generator, host, secure, ).tap do |hash| hash.update(request.) end end |
.options_for_env(env) ⇒ Object
:nodoc:
210 211 212 213 214 215 216 217 218 219 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 210 def self.(env) #:nodoc: { signed_cookie_salt: env[SIGNED_COOKIE_SALT] || '', encrypted_cookie_salt: env[ENCRYPTED_COOKIE_SALT] || '', encrypted_signed_cookie_salt: env[ENCRYPTED_SIGNED_COOKIE_SALT] || '', secret_token: env[SECRET_TOKEN], secret_key_base: env[SECRET_KEY_BASE], upgrade_legacy_signed_cookies: env[SECRET_TOKEN].present? && env[SECRET_KEY_BASE].present?, serializer: env[COOKIES_SERIALIZER] } end |
Instance Method Details
#[](name) ⇒ Object
Returns the value of the cookie by name
, or nil
if no such cookie exists.
258 259 260 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 258 def [](name) @cookies[name.to_s] end |
#[]=(name, options) ⇒ Object
Sets the cookie named name
. The second argument may be the very cookie value, or a hash of options as documented above.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 296 def []=(name, ) if .is_a?(Hash) .symbolize_keys! value = [:value] else value = = { :value => value } end () if @cookies[name.to_s] != value or [:expires] @cookies[name.to_s] = value @set_cookies[name.to_s] = @delete_cookies.delete(name.to_s) end value end |
#clear(options = {}) ⇒ Object
Removes all cookies on the client machine by calling delete
for each cookie
340 341 342 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 340 def clear( = {}) @cookies.each_key{ |k| delete(k, ) } end |
#commit! ⇒ Object
247 248 249 250 251 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 247 def commit! @committed = true @set_cookies.freeze @delete_cookies.freeze end |
#committed? ⇒ Boolean
245 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 245 def committed?; @committed; end |
#delete(name, options = {}) ⇒ Object
Removes the cookie on the client machine by setting the value to an empty string and the expiration date in the past. Like []=
, you can pass in an options hash to delete cookies with extra data such as a :path
.
319 320 321 322 323 324 325 326 327 328 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 319 def delete(name, = {}) return unless @cookies.has_key? name.to_s .symbolize_keys! () value = @cookies.delete(name.to_s) @delete_cookies[name.to_s] = value end |
#deleted?(name, options = {}) ⇒ Boolean
Whether the given cookie is to be deleted by this CookieJar. Like []=
, you can pass in an options hash to test if a deletion applies to a specific :path
, :domain
etc.
333 334 335 336 337 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 333 def deleted?(name, = {}) .symbolize_keys! () @delete_cookies[name.to_s] == end |
#each(&block) ⇒ Object
253 254 255 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 253 def each(&block) @cookies.each(&block) end |
#fetch(name, *args, &block) ⇒ Object
262 263 264 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 262 def fetch(name, *args, &block) @cookies.fetch(name.to_s, *args, &block) end |
#handle_options(options) ⇒ Object
:nodoc:
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 276 def () #:nodoc: [:path] ||= "/" if [:domain] == :all # if there is a provided tld length then we use it otherwise default domain regexp domain_regexp = [:tld_length] ? /([^.]+\.?){#{[:tld_length]}}$/ : DOMAIN_REGEXP # if host is not ip and matches domain regexp # (ip confirms to domain regexp so we explicitly check for ip) [:domain] = if (@host !~ /^[\d.]+$/) && (@host =~ domain_regexp) ".#{$&}" end elsif [:domain].is_a? Array # if host matches one of the supplied domains without a dot in front of it [:domain] = [:domain].find {|domain| @host.include? domain.sub(/^\./, '') } end end |
#key?(name) ⇒ Boolean Also known as: has_key?
266 267 268 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 266 def key?(name) @cookies.key?(name.to_s) end |
#recycle! ⇒ Object
:nodoc:
349 350 351 352 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 349 def recycle! #:nodoc: @set_cookies = {} @delete_cookies = {} end |
#update(other_hash) ⇒ Object
271 272 273 274 |
# File 'lib/action_dispatch/middleware/cookies.rb', line 271 def update(other_hash) @cookies.update other_hash.stringify_keys self end |