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.13";
12 has _deleted_session_id => ( is => 'rw' );
17 $c->maybe::next::method(@_);
19 $c->config->{session}{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->config->{session}{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->config->{session};
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} = 1
81 unless exists $cookie->{httponly}; # default = 1 (set httponly)
86 sub calc_expiry { # compat
88 $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ );
91 sub calculate_session_cookie_expires {
93 my $cfg = $c->config->{session};
95 my $value = $c->maybe::next::method(@_);
96 return $value if $value;
98 if ( exists $cfg->{cookie_expires} ) {
99 if ( $cfg->{cookie_expires} > 0 ) {
100 return time() + $cfg->{cookie_expires};
107 return $c->session_expires;
111 sub get_session_cookie {
114 my $cookie_name = $c->config->{session}{cookie_name};
116 return $c->request->cookies->{$cookie_name};
122 if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) {
123 my $sid = $cookie->value;
124 $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug;
128 $c->maybe::next::method(@_);
131 sub delete_session_id {
132 my ( $c, $sid ) = @_;
134 $c->_deleted_session_id(1); # to prevent get_session_id from returning it
136 $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
138 $c->maybe::next::method($sid);
149 Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
153 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
157 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
158 stored on the client, and the session data needs to be stored on the server.
160 This plugin stores the session ID on the client using the cookie mechanism.
166 =item make_session_cookie
168 Returns a hash reference with the default values for new cookies.
170 =item update_session_cookie $hash_ref
172 Sets the cookie based on C<cookie_name> in the response object.
176 =item calculate_session_cookie_expires
178 =item cookie_is_rejecting
180 =item delete_session_id
182 =item extend_session_id
184 =item get_session_cookie
192 =head1 EXTENDED METHODS
196 =item prepare_cookies
198 Will restore if an appropriate cookie is found.
200 =item finalize_cookies
202 Will set a cookie called C<session> if it doesn't exist or if its value is not
203 the current session id.
207 Will set the C<cookie_name> parameter to its default value if it isn't set.
217 The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
221 The name of the domain to store in the cookie (defaults to current host)
225 Number of seconds from now you want to elapse before cookie will expire.
226 Set to 0 to create a session cookie, ie one which will die when the
227 user's browser is shut down.
231 If this attribute B<set to 0> the cookie will not have the secure flag.
233 If this attribute B<set to 1> (or true for backward compatibility) - the cookie
234 send by the server to the client will got the secure flag that tells the browser
235 to send this cookies back to the server only via HTTPS.
237 If this attribute B<set to 2> then the cookie will got the secure flag only if
238 the request that caused cookie generation was sent over https (this option is
239 not good if you are mixing https and http in you application).
243 =item cookie_httponly
245 If this attribute B<set to 0>, the cookie will not have HTTPOnly flag.
247 If this attribute B<set to 1>, the cookie will got HTTPOnly flag that should
248 prevent client side Javascript accessing the cookie value - this makes some
249 sort of session hijacking attacks significantly harder. Unfortunately not all
250 browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if
251 a browser is not aware of HTTPOnly the flag will be ignored.
255 Note1: Many peole are confused by the name "HTTPOnly" - it B<does not mean>
256 that this cookie works only over HTTP and not over HTTPS.
258 Note2: This paramater requires Catalyst::Runtime 5.80005 otherwise is skipped.
262 The path of the request url where cookie should be baked.
266 For example, you could stick this in MyApp.pm:
268 __PACKAGE__->config( session => {
269 cookie_domain => '.mydomain.com',
274 Sessions have to be created before the first write to be saved. For example:
277 my ( $self, $c ) = @_;
278 $c->res->write("foo");
283 Will cause a session ID to not be set, because by the time a session is
284 actually created the headers have already been sent to the client.
288 L<Catalyst>, L<Catalyst::Plugin::Session>.
292 Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
296 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
297 has been heavily modified since.
303 Jonathan Rockway E<lt>jrockway@cpan.orgE<gt>
308 This program is free software, you can redistribute it and/or modify it
309 under the same terms as Perl itself.