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=536f82f9b1e86a825069af04df8ae5deb757f9b9;hp=5319500777eee36932d5978945459e48c58d049a;hb=refs%2Ftags%2Fv0.11;hpb=fc4b9d6d856e4a7571309881c4f7cd4b1d445642 diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index 5319500..536f82f 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,59 +1,94 @@ package Catalyst::Plugin::Session::State::Cookie; -use base qw/Catalyst::Plugin::Session::State/; +use base qw/Catalyst::Plugin::Session::State Class::Accessor::Fast/; use strict; use warnings; -use NEXT; +use MRO::Compat; use Catalyst::Utils (); -our $VERSION = "0.02"; +our $VERSION = "0.11"; + +BEGIN { __PACKAGE__->mk_accessors(qw/_deleted_session_id/) } sub setup_session { my $c = shift; - $c->NEXT::setup_session(@_); + $c->maybe::next::method(@_); + $c->config->{session}{cookie_name} ||= Catalyst::Utils::appprefix($c) . '_session'; } -sub finalize_cookies { - my $c = shift; +sub extend_session_id { + my ( $c, $sid, $expires ) = @_; - if ( $c->sessionid ) { - $c->update_session_cookie( $c->make_session_cookie ); + if ( my $cookie = $c->get_session_cookie ) { + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); } - return $c->NEXT::finalize_cookies(@_); + $c->maybe::next::method( $sid, $expires ); +} + +sub set_session_id { + my ( $c, $sid ) = @_; + + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); + + return $c->maybe::next::method($sid); } sub update_session_cookie { my ( $c, $updated ) = @_; - my $cookie_name = $c->config->{session}{cookie_name}; - $c->response->cookies->{$cookie_name} = $updated; + + unless ( $c->cookie_is_rejecting( $updated ) ) { + my $cookie_name = $c->config->{session}{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 = shift; + my ( $c, $sid, %attrs ) = @_; my $cfg = $c->config->{session}; my $cookie = { - value => $c->sessionid, + value => $sid, ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ), + ( $cfg->{cookie_path} ? ( path => $cfg->{cookie_path} ) : () ), + %attrs, }; - $cookie->{expires}=$c->calc_expiry(); + unless ( exists $cookie->{expires} ) { + $cookie->{expires} = $c->calculate_session_cookie_expires(); + } $cookie->{secure} = 1 if $cfg->{cookie_secure}; return $cookie; } -sub calc_expiry { - my $c=shift; - my $cfg = $c->config->{session}; - my $value= $c->NEXT::calc_expiry(@_); +sub calc_expiry { # compat + my $c = shift; + $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ ); +} + +sub calculate_session_cookie_expires { + my $c = shift; + my $cfg = $c->config->{session}; + + 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}; @@ -63,24 +98,38 @@ sub calc_expiry { } } else { - return $c->session_expires; + return $c->session_expires; } } -sub prepare_cookies { +sub get_session_cookie { my $c = shift; - my $ret = $c->NEXT::prepare_cookies(@_); - my $cookie_name = $c->config->{session}{cookie_name}; - if ( my $cookie = $c->request->cookies->{$cookie_name} ) { + return $c->request->cookies->{$cookie_name}; +} + +sub get_session_id { + my $c = shift; + + 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; } - return $ret; + $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__ @@ -116,6 +165,22 @@ Returns a hash reference with the default values for new cookies. 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 @@ -128,12 +193,12 @@ Will restore if an appropriate cookie is found. =item finalize_cookies -Will set a cookie called C if it doesn't exist or if it's value is not +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 it's default value if it isn't set. +Will set the C parameter to its default value if it isn't set. =back @@ -159,8 +224,18 @@ user's browser is shut down. If this attribute set true, the cookie will only be sent via HTTPS. +=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( session => { + cookie_domain => '.mydomain.com', + }); + =head1 CAVEATS Sessions have to be created before the first write to be saved. For example: @@ -181,15 +256,19 @@ L, L. =head1 AUTHORS +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 -Yuval Kogman, C -Marcus Ramberg -Sebastian Riedel + Andrew Ford + Andy Grundman + Christian Hansen + Marcus Ramberg + Jonathan Rockway Ejrockway@cpan.orgE + Sebastian Riedel =head1 COPYRIGHT