X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Session-State-Cookie.git;a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession%2FState%2FCookie.pm;h=dfd10bd038649dc31a39aab358aeaef2f6ad719d;hp=3ba6dd1185bc0b347ce6392fbcd3418c8da05081;hb=e94e9e1c035e1687eb3a8c5758f1005ecf560495;hpb=81eb8ebf83afd9410d40d4232eeb9fb64db991cc diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index 3ba6dd1..dfd10bd 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,50 +1,142 @@ package Catalyst::Plugin::Session::State::Cookie; -use base qw/Catalyst::Plugin::Session::State/; +use Moose; +use namespace::autoclean; -use strict; -use warnings; +extends 'Catalyst::Plugin::Session::State'; -use NEXT; +use MRO::Compat; +use Catalyst::Utils (); -our $VERSION = "0.01"; +our $VERSION = "0.17"; + +has _deleted_session_id => ( is => 'rw' ); sub setup_session { - my $c = shift; + my $c = shift; + + $c->maybe::next::method(@_); + + $c->_session_plugin_config->{cookie_name} + ||= Catalyst::Utils::appprefix($c) . '_session'; +} + +sub extend_session_id { + my ( $c, $sid, $expires ) = @_; - $c->NEXT::setup_session(@_); + if ( my $cookie = $c->get_session_cookie ) { + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); + } + + $c->maybe::next::method( $sid, $expires ); +} - $c->config->{session}{cookie_name} ||= "session"; +sub set_session_id { + my ( $c, $sid ) = @_; + + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); + + return $c->maybe::next::method($sid); } -sub finalize { +sub update_session_cookie { + my ( $c, $updated ) = @_; + + unless ( $c->cookie_is_rejecting( $updated ) ) { + my $cookie_name = $c->_session_plugin_config->{cookie_name}; + $c->response->cookies->{$cookie_name} = $updated; + } +} + +sub cookie_is_rejecting { + my ( $c, $cookie ) = @_; + + if ( $cookie->{path} ) { + return 1 if index '/'.$c->request->path, $cookie->{path}; + } + + return 0; +} + +sub make_session_cookie { + my ( $c, $sid, %attrs ) = @_; + + my $cfg = $c->_session_plugin_config; + my $cookie = { + value => $sid, + ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ), + ( $cfg->{cookie_path} ? ( path => $cfg->{cookie_path} ) : () ), + %attrs, + }; + + unless ( exists $cookie->{expires} ) { + $cookie->{expires} = $c->calculate_session_cookie_expires(); + } + + #beware: we have to accept also the old syntax "cookie_secure = true" + my $sec = $cfg->{cookie_secure} || 0; # default = 0 (not set) + $cookie->{secure} = 1 unless ( ($sec==0) || ($sec==2) ); + $cookie->{secure} = 1 if ( ($sec==2) && $c->req->secure ); + + $cookie->{httponly} = $cfg->{cookie_httponly}; + $cookie->{httponly} = 1 + unless defined $cookie->{httponly}; # default = 1 (set httponly) + + return $cookie; +} + +sub calc_expiry { # compat my $c = shift; + $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ ); +} - my $cookie_name = $c->config->{session}{cookie_name}; +sub calculate_session_cookie_expires { + my $c = shift; + my $cfg = $c->_session_plugin_config; - if ( my $sid = $c->sessionid ) { - my $cookie = $c->request->cookies->{$cookie_name}; - if ( !$cookie or $cookie->value ne $sid ) { - $c->response->cookies->{$cookie_name} = { value => $sid }; - $c->log->debug(qq/A cookie with the session id "$sid" was saved/) - if $c->debug; + my $value = $c->maybe::next::method(@_); + return $value if $value; + + if ( exists $cfg->{cookie_expires} ) { + if ( $cfg->{cookie_expires} > 0 ) { + return time() + $cfg->{cookie_expires}; + } + else { + return undef; } } - - return $c->NEXT::finalize(@_); + else { + return $c->session_expires; + } } -sub prepare_cookies { +sub get_session_cookie { my $c = shift; - my $cookie_name = $c->config->{session}{cookie_name}; + my $cookie_name = $c->_session_plugin_config->{cookie_name}; + + return $c->request->cookies->{$cookie_name}; +} + +sub get_session_id { + my $c = shift; - if ( my $cookie = $c->request->cookies->{$cookie_name} ) { + if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) { my $sid = $cookie->value; - $c->sessionid($sid); $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug; + return $sid if $sid; } - $c->NEXT::prepare_cookies(@_); + $c->maybe::next::method(@_); +} + +sub delete_session_id { + my ( $c, $sid ) = @_; + + $c->_deleted_session_id(1); # to prevent get_session_id from returning it + + $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) ); + + $c->maybe::next::method($sid); } __PACKAGE__ @@ -55,11 +147,11 @@ __END__ =head1 NAME -Catalyst::Plugin::Session::State::Cookie - A session ID +Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies. =head1 SYNOPSIS - use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/; + use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/; =head1 DESCRIPTION @@ -68,6 +160,36 @@ stored on the client, and the session data needs to be stored on the server. This plugin stores the session ID on the client using the cookie mechanism. +=head1 METHODS + +=over 4 + +=item make_session_cookie + +Returns a hash reference with the default values for new cookies. + +=item update_session_cookie $hash_ref + +Sets the cookie based on C in the response object. + +=item calc_expiry + +=item calculate_session_cookie_expires + +=item cookie_is_rejecting + +=item delete_session_id + +=item extend_session_id + +=item get_session_cookie + +=item get_session_id + +=item set_session_id + +=back + =head1 EXTENDED METHODS =over 4 @@ -76,9 +198,14 @@ This plugin stores the session ID on the client using the cookie mechanism. Will restore if an appropriate cookie is found. -=item finalize +=item finalize_cookies -Will set a cookie called C if it doesn't exist or if it's value is not the current session id. +Will set a cookie called C if it doesn't exist or if its value is not +the current session id. + +=item setup_session + +Will set the C parameter to its default value if it isn't set. =back @@ -88,23 +215,104 @@ Will set a cookie called C if it doesn't exist or if it's value is not =item cookie_name -The name of the cookie to store (defaults to C). +The name of the cookie to store (defaults to C). + +=item cookie_domain + +The name of the domain to store in the cookie (defaults to current host) + +=item cookie_expires + +Number of seconds from now you want to elapse before cookie will expire. +Set to 0 to create a session cookie, ie one which will die when the +user's browser is shut down. + +=item cookie_secure + +If this attribute B the cookie will not have the secure flag. + +If this attribute B (or true for backward compatibility) - the cookie +sent by the server to the client will get the secure flag that tells the browser +to send this cookie back to the server only via HTTPS. + +If this attribute B then the cookie will get the secure flag only if +the request that caused cookie generation was sent over https (this option is +not good if you are mixing https and http in your application). + +Default value is 0. + +=item cookie_httponly + +If this attribute B, the cookie will not have HTTPOnly flag. + +If this attribute B, the cookie will got HTTPOnly flag that should +prevent client side Javascript accessing the cookie value - this makes some +sort of session hijacking attacks significantly harder. Unfortunately not all +browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if +a browser is not aware of HTTPOnly the flag will be ignored. + +Default value is 1. + +Note1: Many peole are confused by the name "HTTPOnly" - it B +that this cookie works only over HTTP and not over HTTPS. + +Note2: This parameter requires Catalyst::Runtime 5.80005 otherwise is skipped. + +=item cookie_path + +The path of the request url where cookie should be baked. =back +For example, you could stick this in MyApp.pm: + + __PACKAGE__->config( 'Plugin::Session' => { + cookie_domain => '.mydomain.com', + }); + +=head1 CAVEATS + +Sessions have to be created before the first write to be saved. For example: + + sub action : Local { + my ( $self, $c ) = @_; + $c->res->write("foo"); + $c->session( ... ); + ... + } + +Will cause a session ID to not be set, because by the time a session is +actually created the headers have already been sent to the client. + =head1 SEE ALSO L, L. -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel ECE, -Marcus Ramberg ECE, -Andrew Ford ECE, -Yuval Kogman ECE +Yuval Kogman Enothingmuch@woobling.orgE + +=head1 CONTRIBUTORS + +This module is derived from L code, and +has been heavily modified since. + + Andrew Ford + Andy Grundman + Christian Hansen + Marcus Ramberg + Jonathan Rockway Ejrockway@cpan.orgE + Sebastian Riedel + Florian Ragwitz =head1 COPYRIGHT +Copyright (c) 2005 - 2009 +the Catalyst::Plugin::Session::State::Cookie L and L +as listed above. + +=head1 LICENSE + This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.