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=8d32081e6de65e71774852d26f848db42ab27ee9;hp=d1ed4a48dc1b88dfef0677c3a866fb2fe143535e;hb=bab1512d7270f7f38f63a54ebe0677f27e9172b5;hpb=0b3bde04ae84268c122ca38c1e06fca2d0623b47 diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index d1ed4a4..8d32081 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,18 +1,20 @@ 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.05"; +our $VERSION = "0.14"; + +has _deleted_session_id => ( is => 'rw' ); sub setup_session { my $c = shift; - $c->NEXT::setup_session(@_); + $c->maybe::next::method(@_); $c->config->{session}{cookie_name} ||= Catalyst::Utils::appprefix($c) . '_session'; @@ -25,7 +27,7 @@ sub extend_session_id { $c->update_session_cookie( $c->make_session_cookie( $sid ) ); } - $c->NEXT::extend_session_id( $sid, $expires ); + $c->maybe::next::method( $sid, $expires ); } sub set_session_id { @@ -33,12 +35,12 @@ sub set_session_id { $c->update_session_cookie( $c->make_session_cookie( $sid ) ); - return $c->NEXT::set_session_id($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; @@ -47,11 +49,11 @@ sub update_session_cookie { sub cookie_is_rejecting { my ( $c, $cookie ) = @_; - + if ( $cookie->{path} ) { return 1 if index '/'.$c->request->path, $cookie->{path}; } - + return 0; } @@ -70,21 +72,27 @@ sub make_session_cookie { $cookie->{expires} = $c->calculate_session_cookie_expires(); } - $cookie->{secure} = 1 if $cfg->{cookie_secure}; + #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} = 1 + unless exists $cookie->{httponly}; # default = 1 (set httponly) return $cookie; } sub calc_expiry { # compat my $c = shift; - $c->NEXT::calc_expiry( @_ ) || $c->calculate_session_cookie_expires( @_ ); + $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->NEXT::calculate_session_cookie_expires(@_); + my $value = $c->maybe::next::method(@_); return $value if $value; if ( exists $cfg->{cookie_expires} ) { @@ -111,21 +119,23 @@ sub get_session_cookie { sub get_session_id { my $c = shift; - if ( my $cookie = $c->get_session_cookie ) { + if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) { my $sid = $cookie->value; $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug; return $sid if $sid; } - $c->NEXT::get_session_id(@_); + $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->NEXT::delete_session_id($sid); + $c->maybe::next::method($sid); } __PACKAGE__ @@ -161,6 +171,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 @@ -173,12 +199,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 @@ -196,13 +222,40 @@ 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 +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. +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 @@ -210,6 +263,12 @@ 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: @@ -230,18 +289,26 @@ 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 +Copyright (c) 2005, Yuval Kogman C<< >> + +=head1 LICENSE + This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.