1 package Catalyst::Plugin::Session::State::Cookie;
2 use base qw/Catalyst::Plugin::Session::State/;
14 $c->NEXT::setup_session(@_);
16 $c->config->{session}{cookie_name} ||= "session";
19 sub finalize_cookies {
22 if ( $c->sessionid ) {
23 $c->update_session_cookie( $c->make_session_cookie );
26 return $c->NEXT::finalize_cookies(@_);
29 sub update_session_cookie {
30 my ( $c, $updated ) = @_;
31 my $cookie_name = $c->config->{session}{cookie_name};
32 $c->response->cookies->{$cookie_name} = $updated;
35 sub make_session_cookie {
38 my $cfg = $c->config->{session};
40 value => $c->sessionid,
41 ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
44 if ( exists $cfg->{cookie_expires} ) {
45 if ( my $ttl = $cfg->{cookie_expires} ) {
46 $cookie->{expires} = time() + $ttl;
47 } # else { cookie is non-persistent }
50 $cookie->{expires} = $c->session->{__expires};
59 my $ret = $c->NEXT::prepare_cookies(@_);
61 my $cookie_name = $c->config->{session}{cookie_name};
63 if ( my $cookie = $c->request->cookies->{$cookie_name} ) {
64 my $sid = $cookie->value;
66 $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug;
80 Catalyst::Plugin::Session::State::Cookie - A session ID
84 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
88 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
89 stored on the client, and the session data needs to be stored on the server.
91 This plugin stores the session ID on the client using the cookie mechanism.
97 =item make_session_cookie
99 Returns a hash reference with the default values for new cookies.
101 =item update_session_cookie $hash_ref
103 Sets the cookie based on C<cookie_name> in the response object.
107 =head1 EXTENDED METHODS
111 =item prepare_cookies
113 Will restore if an appropriate cookie is found.
115 =item finalize_cookies
117 Will set a cookie called C<session> if it doesn't exist or if it's value is not
118 the current session id.
122 Will set the C<cookie_name> parameter to it's default value if it isn't set.
132 The name of the cookie to store (defaults to C<session>).
136 The name of the domain to store in the cookie (defaults to current host)
142 Sessions have to be created before the first write to be saved. For example:
145 my ( $self, $c ) = @_;
146 $c->res->write("foo");
151 Will cause a session ID to not be set, because by the time a session is
152 actually created the headers have already been sent to the client.
156 L<Catalyst>, L<Catalyst::Plugin::Session>.
160 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
161 has been heavily modified since.
166 Yuval Kogman, C<nothingmuch@woobling.org>
172 This program is free software, you can redistribute it and/or modify it
173 under the same terms as Perl itself.