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=865fb48e0e10a956e399682c982c3654b2b4e4be;hp=ebe362b1cf47446b5574f29a81ca114ffef00810;hb=ea139a65b7a69a7e3059f2440b5ea62a9ef15c13;hpb=724a61732700d4e8e7de83b3665c7611dafc204b diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index ebe362b..865fb48 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,71 +1,135 @@ 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 Catalyst::Utils (); -our $VERSION = "0.01"; +our $VERSION = "0.07"; + +BEGIN { __PACKAGE__->mk_accessors(qw/_deleted_session_id/) } sub setup_session { my $c = shift; $c->NEXT::setup_session(@_); - $c->config->{session}{cookie_name} ||= "session"; + $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 ) ); + } + + $c->NEXT::extend_session_id( $sid, $expires ); +} + +sub set_session_id { + my ( $c, $sid ) = @_; + + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); - return $c->NEXT::finalize_cookies(@_); + return $c->NEXT::set_session_id($sid); } sub update_session_cookie { - my ( $c, $updated ) = @_; - my $cookie_name = $c->config->{session}{cookie_name}; - $c->response->cookies->{$cookie_name} = $updated; + my ( $c, $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 $cfg = $c->config->{session}; - my $cookie = { - value => $c->sessionid, - ($cfg->{cookie_domain} ? (domain => $cfg->{cookie_domain}) : ()), - }; - - if ( exists $cfg->{cookie_expires} ) { - if ( my $ttl = $cfg->{cookie_expires} ) { - $cookie->{expires} = time() + $ttl; - } # else { cookie is non-persistent } - } else { - $cookie->{expires} = $c->session->{__expires}; - } + my ( $c, $sid, %attrs ) = @_; + + my $cfg = $c->config->{session}; + 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(); + } - return $cookie; + $cookie->{secure} = 1 if $cfg->{cookie_secure}; + + return $cookie; } -sub prepare_cookies { +sub calc_expiry { # compat my $c = shift; + $c->NEXT::calc_expiry( @_ ) || $c->calculate_session_cookie_expires( @_ ); +} + +sub calculate_session_cookie_expires { + my $c = shift; + my $cfg = $c->config->{session}; - my $ret = $c->NEXT::prepare_cookies(@_); + my $value = $c->NEXT::calculate_session_cookie_expires(@_); + return $value if $value; + + if ( exists $cfg->{cookie_expires} ) { + if ( $cfg->{cookie_expires} > 0 ) { + return time() + $cfg->{cookie_expires}; + } + else { + return undef; + } + } + else { + return $c->session_expires; + } +} + +sub get_session_cookie { + my $c = shift; 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->NEXT::get_session_id(@_); +} + +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->NEXT::delete_session_id($sid); } __PACKAGE__ @@ -76,7 +140,7 @@ __END__ =head1 NAME -Catalyst::Plugin::Session::State::Cookie - A session ID +Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies. =head1 SYNOPSIS @@ -128,12 +192,26 @@ Will set the C parameter to it's default value if it isn't set. =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 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 =head1 CAVEATS @@ -154,12 +232,17 @@ actually created the headers have already been sent to the client. L, L. -=head1 AUTHOR +=head1 AUTHORS + +This module is derived from L code, and +has been heavily modified since. -Sebastian Riedel ECE, -Marcus Ramberg ECE, -Andrew Ford ECE, -Yuval Kogman ECE +Andrew Ford +Andy Grundman +Christian Hansen +Yuval Kogman, C +Marcus Ramberg +Sebastian Riedel =head1 COPYRIGHT