Test for cookie expiration and extension behavior, add cookie_expires, disable condit...
[catagits/Catalyst-Plugin-Session-State-Cookie.git] / lib / Catalyst / Plugin / Session / State / Cookie.pm
index aa1d9a3..b0e18dd 100644 (file)
@@ -19,24 +19,37 @@ 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;
 
-    return $c->NEXT::finalize_cookies(@_);
+       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 $cookie;
 }
 
 sub prepare_cookies {
@@ -109,6 +122,20 @@ The name of the domain to store in the cookie (defaults to current host)
 
 =back
 
+=item 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<Catalyst>, L<Catalyst::Plugin::Session>.