X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession.pm;h=9cdf6281c86b07614e610259969ddd153e845b60;hb=fff59d60cf54ef8d5040df21b36324b07df0cc36;hp=3b8d60fde528589c44fdd8fe02d08250f82ba348;hpb=340449a2298791740760b77b9837439226563e72;p=catagits%2FCatalyst-Plugin-Session.git diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm index 3b8d60f..9cdf628 100644 --- a/lib/Catalyst/Plugin/Session.pm +++ b/lib/Catalyst/Plugin/Session.pm @@ -1,27 +1,30 @@ #!/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.07"; +our $VERSION = '0.21'; my @session_data_accessors; # used in delete_session -BEGIN { - __PACKAGE__->mk_accessors( + +__PACKAGE__->mk_accessors( "_session_delete_reason", @session_data_accessors = qw/ _sessionid _session _session_expires + _extended_session_expires _session_data_sig _flash _flash_keep_keys @@ -31,13 +34,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; @@ -67,11 +70,11 @@ sub setup_session { %$cfg = ( expires => 7200, - verify_address => 1, + verify_address => 0, %$cfg, ); - $c->NEXT::setup_session(); + $c->maybe::next::method(); } sub prepare_action { @@ -84,33 +87,56 @@ 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; + + return $c->maybe::next::method(@_); +} + +sub finalize_session { + my $c = shift; + + $c->maybe::next::method(@_); + + $c->_save_session_id; $c->_save_session; $c->_save_flash; - $c->_save_session_id; - $c->NEXT::finalize(@_); + $c->_clear_session_instance_data; } sub _save_session_id { my $c = shift; + + # we already called set when allocating + # no need to tell the state plugins anything new } sub _save_session_expires { my $c = shift; - if ( defined(my $expires = $c->_session_expires) ) { + if ( defined($c->_session_expires) ) { + my $expires = $c->session_expires; # force extension + my $sid = $c->sessionid; $c->store_session_data( "expires:$sid" => $expires ); - - $c->_session_expires(undef); - $c->_tried_loading_session_expires(undef); } } @@ -127,9 +153,6 @@ sub _save_session { my $sid = $c->sessionid; $c->store_session_data( "session:$sid" => $session_data ); } - - $c->_session(undef); - $c->_tried_loading_session_data(undef); } } @@ -148,15 +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->_flash(undef); - $c->_tried_loading_flash_data(undef); + $c->_session($session_data); + $c->_save_session; } } @@ -169,7 +192,8 @@ sub _load_session_expires { 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; @@ -185,7 +209,7 @@ sub _load_session { $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); @@ -220,8 +244,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 }); @@ -244,10 +271,16 @@ sub _expire_session_keys { } } +sub _clear_session_instance_data { + my $c = shift; + $c->$_(undef) for @session_data_accessors; + $c->maybe::next::method(@_); # allow other plugins to hook in on this +} + sub delete_session { my ( $c, $msg ) = @_; - $c->log->debug("Deleting session") if $c->debug; + $c->log->debug("Deleting session" . ( defined($msg) ? "($msg)" : '(no reason given)') ) if $c->debug; # delete the session data if ( my $sid = $c->sessionid ) { @@ -257,7 +290,7 @@ sub delete_session { # 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); } @@ -273,11 +306,10 @@ 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 ) ) { - $c->_session_expires($expires); - return $expires; + return $c->extend_session_expires( $expires ); } else { return 0; } @@ -285,7 +317,7 @@ sub session_expires { 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; } @@ -302,7 +334,10 @@ 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; } @@ -319,7 +354,8 @@ sub _load_sessionid { if ( defined( my $sid = $c->get_session_id ) ) { if ( $c->validate_session_id($sid) ) { - $c->_sessionid( $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'"; @@ -363,14 +399,39 @@ 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_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 { my ( $c, %keys ) = @_; @@ -456,7 +517,7 @@ sub dump_these { my $c = shift; ( - $c->NEXT::dump_these(), + $c->maybe::next::method(), $c->sessionid ? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], ) @@ -465,10 +526,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__; @@ -478,8 +539,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 @@ -491,11 +551,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 @@ -540,7 +600,7 @@ made by the same client. This plugin links the two pieces together. -=head1 RECCOMENDED BACKENDS +=head1 RECOMENDED BACKENDS =over 4 @@ -622,9 +682,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 @@ -632,6 +696,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 @@ -690,16 +756,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 before sending +the response. + +=item finalize_body -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 before the other +finalize_body methods run. Here we persist the session data if a session exists. =item initialize_session_data @@ -708,7 +779,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 @@ -723,7 +794,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 @@ -734,29 +805,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 * +=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 { @@ -778,11 +839,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 @@ -794,16 +882,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 @@ -826,6 +914,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 @@ -872,13 +962,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: @@ -886,7 +976,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. @@ -911,7 +1001,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 @@ -919,25 +1009,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