X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Session-State-Cookie.git;a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession%2FState%2FCookie.pm;h=1a9cdbe1d7939a9972bf991b2e60e65b07e2ac3e;hp=aa1d9a389893f8c0dabefc88b3528583550541fe;hb=47f47da510091b02abf3dd8421b042db630690b6;hpb=d52e50798843d02dd22557fbac181a7147c0c608 diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index aa1d9a3..1a9cdbe 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -19,24 +19,38 @@ sub setup_session { sub finalize_cookies { my $c = shift; + if ( $c->sessionid ) { + $c->update_session_cookie( $c->make_session_cookie ); + } + + return $c->NEXT::finalize_cookies(@_); +} + +sub update_session_cookie { + my ( $c, $updated ) = @_; my $cookie_name = $c->config->{session}{cookie_name}; + $c->response->cookies->{$cookie_name} = $updated; +} - if ( my $sid = $c->sessionid ) { - my $cookie = $c->request->cookies->{$cookie_name}; - if ( !$cookie or $cookie->value ne $sid ) { - $c->response->cookies->{$cookie_name} = { - value => $sid, - expires => $c->session->{__expires}, - }; - if ( my $domain = $c->config->{session}{cookie_domain} ) { - $c->response->cookies->{$cookie_name}->{domain} = $domain; - } - $c->log->debug(qq/A cookie with the session id "$sid" was saved/) - if $c->debug; - } +sub make_session_cookie { + my $c = shift; + + my $cfg = $c->config->{session}; + my $cookie = { + value => $c->sessionid, + ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ), + }; + + if ( exists $cfg->{cookie_expires} ) { + if ( my $ttl = $cfg->{cookie_expires} ) { + $cookie->{expires} = time() + $ttl; + } # else { cookie is non-persistent } + } + else { + $cookie->{expires} = $c->session->{__expires}; } - return $c->NEXT::finalize_cookies(@_); + return $cookie; } sub prepare_cookies { @@ -76,6 +90,20 @@ stored on the client, and the session data needs to be stored on the server. This plugin stores the session ID on the client using the cookie mechanism. +=head1 METHODS + +=over 4 + +=item make_session_cookie + +Returns a hash reference with the default values for new cookies. + +=item update_session_cookie $hash_ref + +Sets the cookie based on C in the response object. + +=back + =head1 EXTENDED METHODS =over 4 @@ -109,16 +137,35 @@ The name of the domain to store in the cookie (defaults to current host) =back +=head1 CAVEATS + +Sessions have to be created before the first write to be saved. For example: + + sub action : Local { + my ( $self, $c ) = @_; + $c->res->write("foo"); + $c->session( ... ); + ... + } + +Will cause a session ID to not be set, because by the time a session is +actually created the headers have already been sent to the client. + =head1 SEE ALSO L, L. -=head1 AUTHOR +=head1 AUTHORS + +This module is derived from L code, and +has been heavily modified since. -Sebastian Riedel ECE, -Marcus Ramberg ECE, -Andrew Ford ECE, -Yuval Kogman ECE +Andrew Ford +Andy Grundman +Christian Hansen +Yuval Kogman, C +Marcus Ramberg +Sebastian Riedel =head1 COPYRIGHT