X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession.pm;h=8b66e786a684534a96a2e60ee515b0106122fd3a;hb=eb250519802344a677c86103e5bba640dc40d59f;hp=9394d3b5abd6292b7b615d48843cd6fe0b8f76c4;hpb=fffeb18f24f6f1868b17beba57fb68c997e55113;p=catagits%2FCatalyst-Plugin-Session.git diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm index 9394d3b..8b66e78 100644 --- a/lib/Catalyst/Plugin/Session.pm +++ b/lib/Catalyst/Plugin/Session.pm @@ -11,8 +11,9 @@ use Catalyst::Exception (); use Digest (); use overload (); use Object::Signature (); +use Carp; -our $VERSION = "0.05"; +our $VERSION = '0.20'; my @session_data_accessors; # used in delete_session BEGIN { @@ -22,11 +23,15 @@ BEGIN { _sessionid _session _session_expires + _extended_session_expires _session_data_sig _flash _flash_keep_keys _flash_key_hashes - _tried_loading_session + _tried_loading_session_id + _tried_loading_session_data + _tried_loading_session_expires + _tried_loading_flash_data / ); } @@ -64,7 +69,7 @@ sub setup_session { %$cfg = ( expires => 7200, - verify_address => 1, + verify_address => 0, %$cfg, ); @@ -84,36 +89,66 @@ sub prepare_action { $c->NEXT::prepare_action(@_); } +sub finalize_headers { + my $c = shift; + + # fix cookie before we send headers + $c->_save_session_expires; + + return $c->NEXT::finalize_headers(@_); +} + sub finalize { my $c = shift; + my $ret = $c->NEXT::finalize(@_); + + # then finish the rest + $c->finalize_session; + return $ret; +} + +sub finalize_session { + my $c = shift; + $c->NEXT::finalize_session; + + $c->_save_session_id; $c->_save_session; $c->_save_flash; - $c->NEXT::finalize(@_); + $c->_clear_session_instance_data; } -sub _save_session { +sub _save_session_id { my $c = shift; - if ( my $sid = $c->sessionid ) { + # we already called set when allocating + # no need to tell the state plugins anything new +} + +sub _save_session_expires { + my $c = shift; - # all sessions are extended at the end of the request - my $now = time; + if ( defined($c->_session_expires) ) { + my $expires = $c->session_expires; # force extension - if ( my $expires = $c->session_expires ) { - $c->store_session_data( "expires:$sid" => $expires ); - } + my $sid = $c->sessionid; + $c->store_session_data( "expires:$sid" => $expires ); + } +} - if ( my $session_data = $c->_session ) { +sub _save_session { + my $c = shift; - no warnings 'uninitialized'; - if ( Object::Signature::signature($session_data) ne - $c->_session_data_sig ) - { - $session_data->{__updated} = $now; - $c->store_session_data( "session:$sid" => $session_data ); - } + if ( my $session_data = $c->_session ) { + + no warnings 'uninitialized'; + if ( Object::Signature::signature($session_data) ne + $c->_session_data_sig ) + { + $session_data->{__updated} = time(); + my $sid = $c->sessionid; + $c->store_session_data( "session:$sid" => $session_data ); } } } @@ -121,50 +156,57 @@ sub _save_session { sub _save_flash { my $c = shift; - if ( my $sid = $c->sessionid ) { - if ( my $flash_data = $c->_flash ) { - - my $hashes = $c->_flash_key_hashes || {}; - my $keep = $c->_flash_keep_keys || {}; - foreach my $key ( keys %$hashes ) { - if ( !exists $keep->{$key} and Object::Signature::signature( \$flash_data->{$key} ) eq $hashes->{$key} ) { - delete $flash_data->{$key}; - } - } + if ( my $flash_data = $c->_flash ) { - if (%$flash_data) { - $c->store_session_data( "flash:$sid", $flash_data ); - } - else { - $c->delete_session_data("flash:$sid"); + my $hashes = $c->_flash_key_hashes || {}; + my $keep = $c->_flash_keep_keys || {}; + foreach my $key ( keys %$hashes ) { + if ( !exists $keep->{$key} and Object::Signature::signature( \$flash_data->{$key} ) eq $hashes->{$key} ) { + delete $flash_data->{$key}; } } + + my $sid = $c->sessionid; + + my $session_data = $c->_session; + if (%$flash_data) { + $session_data->{__flash} = $flash_data; + } + else { + delete $session_data->{__flash}; + } + $c->_session($session_data); + $c->_save_session; } } sub _load_session_expires { my $c = shift; + return $c->_session_expires if $c->_tried_loading_session_expires; + $c->_tried_loading_session_expires(1); if ( my $sid = $c->sessionid ) { my $expires = $c->get_session_data("expires:$sid") || 0; if ( $expires >= time() ) { - return $c->extend_session_expires( $expires ); + $c->_session_expires( $expires ); + return $expires; } else { $c->delete_session( "session expired" ); return 0; } - } else { - $c->_session_expires( 0 ); - return 0; } + + return; } sub _load_session { my $c = shift; + return $c->_session if $c->_tried_loading_session_data; + $c->_tried_loading_session_data(1); if ( my $sid = $c->sessionid ) { - if ( $c->session_expires ) { # > 0 + if ( $c->_load_session_expires ) { # > 0 my $session_data = $c->get_session_data("session:$sid") || return; $c->_session($session_data); @@ -195,10 +237,15 @@ sub _load_session { sub _load_flash { my $c = shift; + return $c->_flash if $c->_tried_loading_flash_data; + $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 }); @@ -206,7 +253,7 @@ sub _load_flash { } } - return undef; + return; } sub _expire_session_keys { @@ -221,18 +268,26 @@ 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 +} + sub delete_session { my ( $c, $msg ) = @_; - # delete the session data - my $sid = $c->sessionid || return; - $c->delete_session_data("${_}:${sid}") for qw/session expires flash/; + $c->log->debug("Deleting session" . ( defined($msg) ? "($msg)" : '(no reason given)') ) if $c->debug; - $c->delete_session_id; + # delete the session data + if ( my $sid = $c->sessionid ) { + $c->delete_session_data("${_}:${sid}") for qw/session expires flash/; + $c->delete_session_id($sid); + } # reset the values in the context object # see the BEGIN block - $c->$_(undef) for @session_data_accessors; + $c->_clear_session_instance_data; $c->_session_delete_reason($msg); } @@ -248,16 +303,18 @@ sub session_delete_reason { sub session_expires { my $c = shift; - if ( defined( my $expires = $c->_session_expires ) ) { + if ( defined( my $expires = $c->_extended_session_expires ) ) { return $expires; + } elsif ( defined( $expires = $c->_load_session_expires ) ) { + return $c->extend_session_expires( $expires ); } else { - return $c->_load_session_expires; + return 0; } } sub extend_session_expires { my ( $c, $expires ) = @_; - $c->_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) ); + $c->_extended_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) ); $c->extend_session_id( $c->sessionid, $updated ); return $updated; } @@ -274,38 +331,44 @@ sub calculate_extended_session_expires { sub reset_session_expires { my ( $c, $sid ) = @_; - $c->_session_expires( my $exp = $c->calculate_initial_session_expires ); + + my $exp = $c->calculate_initial_session_expires; + $c->_session_expires( $exp ); + $c->_extended_session_expires( $exp ); $exp; } sub sessionid { my $c = shift; - return $c->_sessionid || do { - unless ( $c->_tried_loading_session ) { - $c->_tried_loading_session(1); - if ( defined( my $sid = $c->get_session_id ) ) { - if ( $c->validate_session_id($sid) ) { - $c->_sessionid( $sid ); - return $sid; - } else { - my $err = "Tried to set invalid session ID '$sid'"; - $c->log->error($err); - Catalyst::Exception->throw($err); - } - } else { - return; - } + return $c->_sessionid || $c->_load_sessionid; +} + +sub _load_sessionid { + my $c = shift; + return if $c->_tried_loading_session_id; + $c->_tried_loading_session_id(1); + + if ( defined( my $sid = $c->get_session_id ) ) { + if ( $c->validate_session_id($sid) ) { + # temporarily set the inner key, so that validation will work + $c->_sessionid($sid); + return $sid; + } else { + my $err = "Tried to set invalid session ID '$sid'"; + $c->log->error($err); + Catalyst::Exception->throw($err); } } + + return; } sub session_is_valid { my $c = shift; - $c->_load_session unless $c->_session; # check expiry and also __address, etc - - if ( $c->_session ) { + # force a check for expiry, but also __address, etc + if ( $c->_load_session ) { return 1; } else { return; @@ -322,7 +385,7 @@ sub session { my $c = shift; $c->_session || $c->_load_session || do { - $c->create_session_id; + $c->create_session_id_if_needed; $c->initialize_session_data; }; } @@ -333,12 +396,37 @@ sub keep_flash { (@{$href}{@keys}) = ((undef) x @keys); } -sub flash { +sub _flash_data { my $c = shift; $c->_flash || $c->_load_flash || do { - $c->create_session_id; + $c->create_session_id_if_needed; $c->_flash( {} ); - } + }; +} + +sub _set_flash { + my $c = shift; + if (@_) { + my $items = @_ > 1 ? {@_} : $_[0]; + croak('flash takes a hash or hashref') unless ref $items; + @{ $c->_flash }{ keys %$items } = values %$items; + } +} + +sub flash { + my $c = shift; + $c->_flash_data; + $c->_set_flash(@_); + return $c->_flash; +} + +sub clear_flash { + my $c = shift; + + #$c->delete_session_data("flash:" . $c->sessionid); # should this be in here? or delayed till finalization? + $c->_flash_key_hashes({}); + $c->_flash_keep_keys({}); + $c->_flash({}); } sub session_expire_key { @@ -376,9 +464,14 @@ sub generate_session_id { return $digest->hexdigest; } -sub create_session_id { +sub create_session_id_if_needed { my $c = shift; + $c->create_session_id unless $c->sessionid; +} +sub create_session_id { + my $c = shift; + my $sid = $c->generate_session_id; $c->log->debug(qq/Created session "$sid"/) if $c->debug; @@ -443,8 +536,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 @@ -456,11 +548,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 @@ -505,7 +597,7 @@ made by the same client. This plugin links the two pieces together. -=head1 RECCOMENDED BACKENDS +=head1 RECOMENDED BACKENDS =over 4 @@ -587,9 +679,13 @@ of every request. } } +=item clear_flash + +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 @@ -597,6 +693,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 @@ -655,16 +753,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_headers + +This method is extended and will extend the expiry time before sending +the response. + =item finalize -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 call finalize_session after the other +finalizes run. Here we persist the session data if a session exists. =item initialize_session_data @@ -673,7 +776,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 @@ -688,7 +791,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 @@ -699,29 +802,19 @@ Currently it returns a concatenated string which contains: =over 4 -=item * - -A counter +=item * A counter -=item * - -The current time - -=item * - -One value from C. - -=item * +=item * The current time -The stringified value of a newly allocated hash reference +=item * One value from C. -=item * +=item * The stringified value of a newly allocated hash reference -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 { @@ -743,11 +836,38 @@ Or even more directly, replace C: Also have a look at L and the various openssl bindings - these modules provide APIs for cryptographically secure random data. +=item finalize_session + +Clean up the session during C. + +This clears the various accessors after saving to the store. + =item dump_these 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 @@ -759,16 +879,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 @@ -791,6 +911,8 @@ hours). When true, C<<$c->request->address>> will be checked at prepare time. If it is not the same as the address 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 @@ -837,13 +959,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: @@ -851,7 +973,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. @@ -876,7 +998,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 @@ -884,25 +1006,21 @@ plugin should be safe enough. =head1 AUTHORS -=over 4 +Andy Grundman -=item Andy Grundman +Christian Hansen -=item Christian Hansen +Yuval Kogman, C (current maintainer) -=item Yuval Kogman, C (current maintainer) - -=item Sebastian Riedel - -=back +Sebastian Riedel 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