1 package Catalyst::Plugin::Session::State::Cookie;
2 use base qw/Catalyst::Plugin::Session::State/;
8 use Catalyst::Utils ();
10 our $VERSION = "0.02";
15 $c->NEXT::setup_session(@_);
16 $c->config->{session}{cookie_name}
17 ||= Catalyst::Utils::appprefix($c) . '_session';
20 sub finalize_cookies {
23 if ( $c->sessionid ) {
24 $c->update_session_cookie( $c->make_session_cookie );
27 return $c->NEXT::finalize_cookies(@_);
30 sub update_session_cookie {
31 my ( $c, $updated ) = @_;
32 my $cookie_name = $c->config->{session}{cookie_name};
33 $c->response->cookies->{$cookie_name} = $updated;
36 sub make_session_cookie {
39 my $cfg = $c->config->{session};
41 value => $c->sessionid,
42 ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
45 $cookie->{expires}=$c->calc_expiry();
52 my $cfg = $c->config->{session};
53 my $value= $c->NEXT::calc_expiry(@_);
54 return $value if $value;
55 if ( exists $cfg->{cookie_expires} ) {
56 if ( $cfg->{cookie_expires} > 0 ) {
57 return time() + $cfg->{cookie_expires};
64 return $c->session_expires;
71 my $ret = $c->NEXT::prepare_cookies(@_);
73 my $cookie_name = $c->config->{session}{cookie_name};
75 if ( my $cookie = $c->request->cookies->{$cookie_name} ) {
76 my $sid = $cookie->value;
78 $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug;
92 Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
96 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
100 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
101 stored on the client, and the session data needs to be stored on the server.
103 This plugin stores the session ID on the client using the cookie mechanism.
109 =item make_session_cookie
111 Returns a hash reference with the default values for new cookies.
113 =item update_session_cookie $hash_ref
115 Sets the cookie based on C<cookie_name> in the response object.
119 =head1 EXTENDED METHODS
123 =item prepare_cookies
125 Will restore if an appropriate cookie is found.
127 =item finalize_cookies
129 Will set a cookie called C<session> if it doesn't exist or if it's value is not
130 the current session id.
134 Will set the C<cookie_name> parameter to it's default value if it isn't set.
144 The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
148 The name of the domain to store in the cookie (defaults to current host)
152 Number of seconds from now you want to elapse before cookie will expire.
153 Set to 0 to create a session cookie, ie one which will die when the
154 user's browser is shut down.
160 Sessions have to be created before the first write to be saved. For example:
163 my ( $self, $c ) = @_;
164 $c->res->write("foo");
169 Will cause a session ID to not be set, because by the time a session is
170 actually created the headers have already been sent to the client.
174 L<Catalyst>, L<Catalyst::Plugin::Session>.
178 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
179 has been heavily modified since.
184 Yuval Kogman, C<nothingmuch@woobling.org>
190 This program is free software, you can redistribute it and/or modify it
191 under the same terms as Perl itself.