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.16";
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);
150 Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
154 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
158 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
159 stored on the client, and the session data needs to be stored on the server.
161 This plugin stores the session ID on the client using the cookie mechanism.
167 =item make_session_cookie
169 Returns a hash reference with the default values for new cookies.
171 =item update_session_cookie $hash_ref
173 Sets the cookie based on C<cookie_name> in the response object.
177 =item calculate_session_cookie_expires
179 =item cookie_is_rejecting
181 =item delete_session_id
183 =item extend_session_id
185 =item get_session_cookie
193 =head1 EXTENDED METHODS
197 =item prepare_cookies
199 Will restore if an appropriate cookie is found.
201 =item finalize_cookies
203 Will set a cookie called C<session> if it doesn't exist or if its value is not
204 the current session id.
208 Will set the C<cookie_name> parameter to its default value if it isn't set.
218 The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
222 The name of the domain to store in the cookie (defaults to current host)
226 Number of seconds from now you want to elapse before cookie will expire.
227 Set to 0 to create a session cookie, ie one which will die when the
228 user's browser is shut down.
232 If this attribute B<set to 0> the cookie will not have the secure flag.
234 If this attribute B<set to 1> (or true for backward compatibility) - the cookie
235 send by the server to the client will got the secure flag that tells the browser
236 to send this cookies back to the server only via HTTPS.
238 If this attribute B<set to 2> then the cookie will got the secure flag only if
239 the request that caused cookie generation was sent over https (this option is
240 not good if you are mixing https and http in you application).
244 =item cookie_httponly
246 If this attribute B<set to 0>, the cookie will not have HTTPOnly flag.
248 If this attribute B<set to 1>, the cookie will got HTTPOnly flag that should
249 prevent client side Javascript accessing the cookie value - this makes some
250 sort of session hijacking attacks significantly harder. Unfortunately not all
251 browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if
252 a browser is not aware of HTTPOnly the flag will be ignored.
256 Note1: Many peole are confused by the name "HTTPOnly" - it B<does not mean>
257 that this cookie works only over HTTP and not over HTTPS.
259 Note2: This paramater requires Catalyst::Runtime 5.80005 otherwise is skipped.
263 The path of the request url where cookie should be baked.
267 For example, you could stick this in MyApp.pm:
269 __PACKAGE__->config( 'Plugin::Session' => {
270 cookie_domain => '.mydomain.com',
275 Sessions have to be created before the first write to be saved. For example:
278 my ( $self, $c ) = @_;
279 $c->res->write("foo");
284 Will cause a session ID to not be set, because by the time a session is
285 actually created the headers have already been sent to the client.
289 L<Catalyst>, L<Catalyst::Plugin::Session>.
293 Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
297 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
298 has been heavily modified since.
304 Jonathan Rockway E<lt>jrockway@cpan.orgE<gt>
310 Copyright (c) 2005, Yuval Kogman C<< <nothingmuch@woobling.org> >>
314 This program is free software, you can redistribute it and/or modify it
315 under the same terms as Perl itself.