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=aae53326c48ca9fc6adc650b11adc65dbdd230ac;hp=708646dc5b5c4e2e19462ead2315498aefafcbfc;hb=d2cf2047cb7892e69e434b621321d1b3d410e0f1;hpb=e115cbd59ac1c126f35aeaaedc1d31954e189e6a diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index 708646d..aae5332 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,58 +1,141 @@ 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.01"; +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} ||= "session"; + $c->config->{session}{cookie_name} + ||= Catalyst::Utils::appprefix($c) . '_session'; } -sub finalize { - my $c = shift; +sub extend_session_id { + my ( $c, $sid, $expires ) = @_; - my $cookie_name = $c->config->{session}{cookie_name}; + if ( my $cookie = $c->get_session_cookie ) { + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); + } - 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, - expires => $c->session->{__expires}, - }; - if ( my $domain = $c->config->{session}{cookie_domain} ) { - $c->response->cookies->{$cookie_name}->{domain} = $domain; - } - $c->log->debug(qq/A cookie with the session id "$sid" was saved/) - if $c->debug; - } + $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 ) = @_; + + 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, $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 $c->NEXT::finalize(@_); + #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 ); + + my $hto = $cookie->{httponly} || 1; # default = 1 (set httponly) + $cookie->{httponly} = 1 unless ($hto==0); + + return $cookie; } -sub prepare_cookies { +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}; + } + else { + return undef; + } + } + else { + return $c->session_expires; + } +} - my $ret = $c->NEXT::prepare_cookies(@_); +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->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__ @@ -63,7 +146,7 @@ __END__ =head1 NAME -Catalyst::Plugin::Session::State::Cookie - A session ID +Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies. =head1 SYNOPSIS @@ -76,6 +159,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 @@ -84,14 +197,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 +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 @@ -101,24 +214,94 @@ 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 B the cookie will not have the secure flag. + +If this attribute B (or true for backward compatibility) - the cookie +send by the server to the client will got the secure flag that tells the browser +to send this cookies back to the server only via HTTPS. + +If this attribute B then the cookie will got 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 you application). + +Default vaule 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 paramater 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( 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 + +Yuval Kogman Enothingmuch@woobling.orgE + +=head1 CONTRIBUTORS + +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 + Marcus Ramberg + Jonathan Rockway Ejrockway@cpan.orgE + Sebastian Riedel =head1 COPYRIGHT