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=b65430fcb2a4276430ffcccbe9359c6bcae62693;hp=aa1d9a389893f8c0dabefc88b3528583550541fe;hb=74586782a63bf750618a42e0a5d5ea1549a65ede;hpb=d52e50798843d02dd22557fbac181a7147c0c608 diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index aa1d9a3..b65430f 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -5,38 +5,56 @@ use strict; use warnings; use NEXT; +use Catalyst::Utils (); -our $VERSION = "0.01"; +our $VERSION = "0.02"; sub setup_session { my $c = shift; $c->NEXT::setup_session(@_); - - $c->config->{session}{cookie_name} ||= "session"; + $c->config->{session}{cookie_name} + ||= Catalyst::Utils::appprefix($c) . '_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 ( $cfg->{cookie_expires} > 0 ) { + $cookie->{expires} = time() + $cfg->{cookie_expires}; } + else { + $cookie->{expires} = undef; + } + } + else { + $cookie->{expires} = $c->session_expires; } - return $c->NEXT::finalize_cookies(@_); + return $cookie; } sub prepare_cookies { @@ -76,6 +94,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 @@ -101,24 +133,49 @@ Will set the C parameter to it's default value if it isn't set. =item cookie_name -The name of the cookie to store (defaults to C). +The name of the cookie to store (defaults to C). =item cookie_domain The name of the domain to store in the cookie (defaults to current host) +=item cookie_expires + +Number of seconds from now you want to elapse before cookie will expire. +Set to 0 to create a session cookie, ie one which will die when the +user's browser is shut down. + =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