X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession.pm;h=8e3a2da74790c2e0bcaf6db2a46a1a1d01d7d849;hb=f8f81744361da95c2b7f8a35c4e5aec63622e677;hp=59ab30d42304c6dfeb6ff1da8a159d7157c47fdc;hpb=0466f6c7502b13bcabdea9576fe646f35c06d08d;p=catagits%2FCatalyst-Plugin-Session.git diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm index 59ab30d..8e3a2da 100644 --- a/lib/Catalyst/Plugin/Session.pm +++ b/lib/Catalyst/Plugin/Session.pm @@ -1,23 +1,23 @@ #!/usr/bin/perl package Catalyst::Plugin::Session; -use base qw/Class::Accessor::Fast/; -use strict; -use warnings; - -use NEXT; +use Moose; +with 'MooseX::Emulate::Class::Accessor::Fast'; +use MRO::Compat; use Catalyst::Exception (); use Digest (); use overload (); use Object::Signature (); use Carp; -our $VERSION = "0.14"; +use namespace::clean -except => 'meta'; + +our $VERSION = '0.24'; my @session_data_accessors; # used in delete_session -BEGIN { - __PACKAGE__->mk_accessors( + +__PACKAGE__->mk_accessors( "_session_delete_reason", @session_data_accessors = qw/ _sessionid @@ -33,13 +33,13 @@ BEGIN { _tried_loading_session_expires _tried_loading_flash_data / - ); -} +); + sub setup { my $c = shift; - $c->NEXT::setup(@_); + $c->maybe::next::method(@_); $c->check_session_plugin_requirements; $c->setup_session; @@ -70,10 +70,11 @@ sub setup_session { %$cfg = ( expires => 7200, verify_address => 0, + verify_user_agent => 0, %$cfg, ); - $c->NEXT::setup_session(); + $c->maybe::next::method(); } sub prepare_action { @@ -86,26 +87,37 @@ sub prepare_action { @{ $c->stash }{ keys %$flash_data } = values %$flash_data; } - $c->NEXT::prepare_action(@_); + $c->maybe::next::method(@_); } -sub finalize { +sub finalize_headers { my $c = shift; + # fix cookie before we send headers + $c->_save_session_expires; + + return $c->maybe::next::method(@_); +} + +sub finalize_body { + my $c = shift; + + # We have to finalize our session *before* $c->engine->finalize_xxx is called, + # because we do not want to send the HTTP response before the session is stored/committed to + # the session database (or whatever Session::Store you use). $c->finalize_session; - - $c->NEXT::finalize(@_); + + return $c->maybe::next::method(@_); } sub finalize_session { my $c = shift; - $c->NEXT::finalize_session; + $c->maybe::next::method(@_); $c->_save_session_id; $c->_save_session; $c->_save_flash; - $c->_save_session_expires; $c->_clear_session_instance_data; } @@ -159,12 +171,15 @@ sub _save_flash { my $sid = $c->sessionid; + my $session_data = $c->_session; if (%$flash_data) { - $c->store_session_data( "flash:$sid", $flash_data ); + $session_data->{__flash} = $flash_data; } else { - $c->delete_session_data("flash:$sid"); + delete $session_data->{__flash}; } + $c->_session($session_data); + $c->_save_session; } } @@ -211,6 +226,17 @@ sub _load_session { $c->delete_session("address mismatch"); return; } + if ( $c->config->{session}{verify_user_agent} + && $session_data->{__user_agent} ne $c->request->user_agent ) + { + $c->log->warn( + "Deleting session $sid due to user agent mismatch (" + . $session_data->{__user_agent} . " != " + . $c->request->user_agent . ")" + ); + $c->delete_session("user agent mismatch"); + return; + } $c->log->debug(qq/Restored session "$sid"/) if $c->debug; $c->_session_data_sig( Object::Signature::signature($session_data) ) if $session_data; @@ -229,8 +255,11 @@ sub _load_flash { $c->_tried_loading_flash_data(1); if ( my $sid = $c->sessionid ) { - if ( my $flash_data = $c->_flash - || $c->_flash( $c->get_session_data("flash:$sid") ) ) + + my $session_data = $c->session; + $c->_flash($session_data->{__flash}); + + if ( my $flash_data = $c->_flash ) { $c->_flash_key_hashes({ map { $_ => Object::Signature::signature( \$flash_data->{$_} ) } keys %$flash_data }); @@ -256,7 +285,7 @@ sub _expire_session_keys { sub _clear_session_instance_data { my $c = shift; $c->$_(undef) for @session_data_accessors; - $c->NEXT::_clear_session_instance_data; # allow other plugins to hook in on this + $c->maybe::next::method(@_); # allow other plugins to hook in on this } sub delete_session { @@ -401,8 +430,8 @@ sub _set_flash { sub flash { my $c = shift; $c->_flash_data; - $c->_set_flash(@_); - return $c->_flash; + $c->_set_flash(@_); + return $c->_flash; } sub clear_flash { @@ -434,7 +463,12 @@ sub initialize_session_data { ( $c->config->{session}{verify_address} - ? ( __address => $c->request->address ) + ? ( __address => $c->request->address||'' ) + : () + ), + ( + $c->config->{session}{verify_user_agent} + ? ( __user_agent => $c->request->user_agent||'' ) : () ), } @@ -499,7 +533,7 @@ sub dump_these { my $c = shift; ( - $c->NEXT::dump_these(), + $c->maybe::next::method(), $c->sessionid ? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], ) @@ -508,10 +542,10 @@ sub dump_these { } -sub get_session_id { shift->NEXT::get_session_id(@_) } -sub set_session_id { shift->NEXT::set_session_id(@_) } -sub delete_session_id { shift->NEXT::delete_session_id(@_) } -sub extend_session_id { shift->NEXT::extend_session_id(@_) } +sub get_session_id { shift->maybe::next::method(@_) } +sub set_session_id { shift->maybe::next::method(@_) } +sub delete_session_id { shift->maybe::next::method(@_) } +sub extend_session_id { shift->maybe::next::method(@_) } __PACKAGE__; @@ -521,8 +555,7 @@ __END__ =head1 NAME -Catalyst::Plugin::Session - Generic Session plugin - ties together server side -storage and client side state required to maintain session data. +Catalyst::Plugin::Session - Generic Session plugin - ties together server side storage and client side state required to maintain session data. =head1 SYNOPSIS @@ -534,11 +567,11 @@ storage and client side state required to maintain session data. Session::State::Cookie /; - # you can replace Store::FastMmap with Store::File - both have sensible - # default configurations (see their docs for details) + # you can replace Store::FastMmap with Store::File - both have sensible + # default configurations (see their docs for details) - # more complicated backends are available for other scenarios (DBI storage, - # etc) + # more complicated backends are available for other scenarios (DBI storage, + # etc) # after you've loaded the plugins you can save session data @@ -583,7 +616,7 @@ made by the same client. This plugin links the two pieces together. -=head1 RECCOMENDED BACKENDS +=head1 RECOMENDED BACKENDS =over 4 @@ -671,7 +704,7 @@ Zap all the keys in the flash regardless of their current state. =item keep_flash @keys -If you wawnt to keep a flash key for the next request too, even if it hasn't +If you want to keep a flash key for the next request too, even if it hasn't changed, call C and pass in the keys as arguments. =item delete_session REASON @@ -679,6 +712,8 @@ changed, call C and pass in the keys as arguments. This method is used to invalidate a session. It takes an optional parameter which will be saved in C if provided. +NOTE: This method will B delete your flash data. + =item session_delete_reason This accessor contains a string with the reason a session was deleted. Possible @@ -737,16 +772,21 @@ listed in L. =item prepare_action -This methoid is extended. +This method is extended. -It's only effect is if the (off by default) C configuration +Its only effect is if the (off by default) C configuration parameter is on - then it will copy the contents of the flash to the stash at prepare time. -=item finalize +=item finalize_headers -This method is extended and will extend the expiry time, as well as persist the -session data if a session exists. +This method is extended and will extend the expiry time before sending +the response. + +=item finalize_body + +This method is extended and will call finalize_session before the other +finalize_body methods run. Here we persist the session data if a session exists. =item initialize_session_data @@ -755,7 +795,7 @@ called by the C method if appropriate. =item create_session_id -Creates a new session id using C if there is no session ID +Creates a new session ID using C if there is no session ID yet. =item validate_session_id SID @@ -770,7 +810,7 @@ insensitive hexadecimal characters. This method will return a string that can be used as a session ID. It is supposed to be a reasonably random string with enough bits to prevent collision. It basically takes C and hashes it using SHA-1, -MD5 or SHA-256, depending on the availibility of these modules. +MD5 or SHA-256, depending on the availability of these modules. =item session_hash_seed @@ -781,29 +821,19 @@ Currently it returns a concatenated string which contains: =over 4 -=item * - -A counter - -=item * - -The current time +=item * A counter -=item * - -One value from C. +=item * The current time -=item * +=item * One value from C. -The stringified value of a newly allocated hash reference +=item * The stringified value of a newly allocated hash reference -=item * - -The stringified value of the Catalyst context object +=item * The stringified value of the Catalyst context object =back -In the hopes that those combined values are entropic enough for most uses. If +in the hopes that those combined values are entropic enough for most uses. If this is not the case you can replace C with e.g. sub session_hash_seed { @@ -836,6 +866,27 @@ This clears the various accessors after saving to the store. See L - ammends the session data structure to the list of dumped objects if session ID is defined. + +=item calculate_extended_session_expires + +=item calculate_initial_session_expires + +=item create_session_id_if_needed + +=item delete_session_id + +=item extend_session_expires + +=item extend_session_id + +=item get_session_id + +=item reset_session_expires + +=item session_is_valid + +=item set_session_id + =back =head1 USING SESSIONS DURING PREPARE @@ -847,16 +898,16 @@ State plugins must set $c->session ID before C, and during C L will actually load the data from the store. - sub prepare_action { - my $c = shift; + sub prepare_action { + my $c = shift; - # don't touch $c->session yet! + # don't touch $c->session yet! - $c->NEXT::prepare_action( @_ ); + $c->NEXT::prepare_action( @_ ); - $c->session; # this is OK - $c->sessionid; # this is also OK - } + $c->session; # this is OK + $c->sessionid; # this is also OK + } =head1 CONFIGURATION @@ -881,6 +932,14 @@ not the same as the address that initiated the session, the session is deleted. Defaults to false. +=item verify_user_agent + +When true, C<<$c->request->user_agent>> will be checked at prepare time. If it +is not the same as the user agent that initiated the session, the session is +deleted. + +Defaults to false. + =item flash_to_stash This option makes it easier to have actions behave the same whether they were @@ -913,6 +972,11 @@ The time when the session was first created. The value of C<< $c->request->address >> at the time the session was created. This value is only populated if C is true in the configuration. +=item __user_agent + +The value of C<< $c->request->user_agent >> at the time the session was created. +This value is only populated if C is true in the configuration. + =back =head1 CAVEATS @@ -927,13 +991,13 @@ users' sessions cannot persist. To let these users access your site you can either disable address verification as a whole, or provide a checkbox in the login dialog that tells the server that it's OK for the address of the client to change. When the server sees that -this box is checked it should delete the C<__address> sepcial key from the +this box is checked it should delete the C<__address> special key from the session hash when the hash is first created. =head2 Race Conditions -In this day and age where cleaning detergents and dutch football (not the -american kind) teams roam the plains in great numbers, requests may happen +In this day and age where cleaning detergents and Dutch football (not the +American kind) teams roam the plains in great numbers, requests may happen simultaneously. This means that there is some risk of session data being overwritten, like this: @@ -941,7 +1005,7 @@ overwritten, like this: =item 1. -request a starts, request b starts, with the same session id +request a starts, request b starts, with the same session ID =item 2. @@ -966,7 +1030,7 @@ changes by request a =back -If this is a concern in your application, a soon to be developed locking +If this is a concern in your application, a soon-to-be-developed locking solution is the only safe way to go. This will have a bigger overhead. For applications where any given user is only making one request at a time this @@ -974,25 +1038,25 @@ plugin should be safe enough. =head1 AUTHORS -=over 4 +Andy Grundman -=item Andy Grundman +Christian Hansen -=item Christian Hansen +Yuval Kogman, C -=item Yuval Kogman, C (current maintainer) +Sebastian Riedel -=item Sebastian Riedel +Tomas Doran (t0m) C (current maintainer) -=back +Sergio Salvi And countless other contributers from #catalyst. Thanks guys! =head1 COPYRIGHT & LICENSE - Copyright (c) 2005 the aforementioned authors. All rights - reserved. This program is free software; you can redistribute - it and/or modify it under the same terms as Perl itself. + Copyright (c) 2005 the aforementioned authors. All rights + reserved. This program is free software; you can redistribute + it and/or modify it under the same terms as Perl itself. =cut