1 package Catalyst::Plugin::Session::State::Cookie;
3 use namespace::autoclean;
5 extends 'Catalyst::Plugin::Session::State';
8 use Catalyst::Utils ();
10 our $VERSION = "0.17";
12 has _deleted_session_id => ( is => 'rw' );
17 $c->maybe::next::method(@_);
19 $c->_session_plugin_config->{cookie_name}
20 ||= Catalyst::Utils::appprefix($c) . '_session';
23 sub extend_session_id {
24 my ( $c, $sid, $expires ) = @_;
26 if ( my $cookie = $c->get_session_cookie ) {
27 $c->update_session_cookie( $c->make_session_cookie( $sid ) );
30 $c->maybe::next::method( $sid, $expires );
36 $c->update_session_cookie( $c->make_session_cookie( $sid ) );
38 return $c->maybe::next::method($sid);
41 sub update_session_cookie {
42 my ( $c, $updated ) = @_;
44 unless ( $c->cookie_is_rejecting( $updated ) ) {
45 my $cookie_name = $c->_session_plugin_config->{cookie_name};
46 $c->response->cookies->{$cookie_name} = $updated;
50 sub cookie_is_rejecting {
51 my ( $c, $cookie ) = @_;
53 if ( $cookie->{path} ) {
54 return 1 if index '/'.$c->request->path, $cookie->{path};
60 sub make_session_cookie {
61 my ( $c, $sid, %attrs ) = @_;
63 my $cfg = $c->_session_plugin_config;
66 ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
67 ( $cfg->{cookie_path} ? ( path => $cfg->{cookie_path} ) : () ),
71 unless ( exists $cookie->{expires} ) {
72 $cookie->{expires} = $c->calculate_session_cookie_expires();
75 #beware: we have to accept also the old syntax "cookie_secure = true"
76 my $sec = $cfg->{cookie_secure} || 0; # default = 0 (not set)
77 $cookie->{secure} = 1 unless ( ($sec==0) || ($sec==2) );
78 $cookie->{secure} = 1 if ( ($sec==2) && $c->req->secure );
80 $cookie->{httponly} = $cfg->{cookie_httponly};
81 $cookie->{httponly} = 1
82 unless defined $cookie->{httponly}; # default = 1 (set httponly)
87 sub calc_expiry { # compat
89 $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ );
92 sub calculate_session_cookie_expires {
94 my $cfg = $c->_session_plugin_config;
96 my $value = $c->maybe::next::method(@_);
97 return $value if $value;
99 if ( exists $cfg->{cookie_expires} ) {
100 if ( $cfg->{cookie_expires} > 0 ) {
101 return time() + $cfg->{cookie_expires};
108 return $c->session_expires;
112 sub get_session_cookie {
115 my $cookie_name = $c->_session_plugin_config->{cookie_name};
117 return $c->request->cookies->{$cookie_name};
123 if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) {
124 my $sid = $cookie->value;
125 $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug;
129 $c->maybe::next::method(@_);
132 sub delete_session_id {
133 my ( $c, $sid ) = @_;
135 $c->_deleted_session_id(1); # to prevent get_session_id from returning it
137 $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
139 $c->maybe::next::method($sid);
147 Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
151 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
155 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
156 stored on the client, and the session data needs to be stored on the server.
158 This plugin stores the session ID on the client using the cookie mechanism.
164 =item make_session_cookie
166 Returns a hash reference with the default values for new cookies.
168 =item update_session_cookie $hash_ref
170 Sets the cookie based on C<cookie_name> in the response object.
174 =item calculate_session_cookie_expires
176 =item cookie_is_rejecting
178 =item delete_session_id
180 =item extend_session_id
182 =item get_session_cookie
190 =head1 EXTENDED METHODS
194 =item prepare_cookies
196 Will restore if an appropriate cookie is found.
198 =item finalize_cookies
200 Will set a cookie called C<session> if it doesn't exist or if its value is not
201 the current session id.
205 Will set the C<cookie_name> parameter to its default value if it isn't set.
215 The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
219 The name of the domain to store in the cookie (defaults to current host)
223 Number of seconds from now you want to elapse before cookie will expire.
224 Set to 0 to create a session cookie, ie one which will die when the
225 user's browser is shut down.
229 If this attribute B<set to 0> the cookie will not have the secure flag.
231 If this attribute B<set to 1> (or true for backward compatibility) - the cookie
232 sent by the server to the client will get the secure flag that tells the browser
233 to send this cookie back to the server only via HTTPS.
235 If this attribute B<set to 2> then the cookie will get the secure flag only if
236 the request that caused cookie generation was sent over https (this option is
237 not good if you are mixing https and http in your application).
241 =item cookie_httponly
243 If this attribute B<set to 0>, the cookie will not have HTTPOnly flag.
245 If this attribute B<set to 1>, the cookie will got HTTPOnly flag that should
246 prevent client side Javascript accessing the cookie value - this makes some
247 sort of session hijacking attacks significantly harder. Unfortunately not all
248 browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if
249 a browser is not aware of HTTPOnly the flag will be ignored.
253 Note1: Many people are confused by the name "HTTPOnly" - it B<does not mean>
254 that this cookie works only over HTTP and not over HTTPS.
256 Note2: This parameter requires Catalyst::Runtime 5.80005 otherwise is skipped.
260 The path of the request url where cookie should be baked.
264 For example, you could stick this in MyApp.pm:
266 __PACKAGE__->config( 'Plugin::Session' => {
267 cookie_domain => '.mydomain.com',
272 Sessions have to be created before the first write to be saved. For example:
275 my ( $self, $c ) = @_;
276 $c->res->write("foo");
281 Will cause a session ID to not be set, because by the time a session is
282 actually created the headers have already been sent to the client.
286 L<Catalyst>, L<Catalyst::Plugin::Session>.
290 Yuval Kogman <nothingmuch@woobling.org>
294 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
295 has been heavily modified since.
305 Jonathan Rockway <jrockway@cpan.org>
313 Copyright (c) 2005 - 2009
314 the Catalyst::Plugin::Session::State::Cookie L</AUTHORS> and L</CONTRIBUTORS>
319 This program is free software, you can redistribute it and/or modify it
320 under the same terms as Perl itself.