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=7f08b29641de99d64f218e269803f72fb04ffefc;hp=518d8077c1f5a3100e99619e02fc09370186317c;hb=0ff18b66c5e51b0937275b0039461ba902a649b3;hpb=7acb108b5a1ada44cf65824df59a1d00a810b126 diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index 518d807..7f08b29 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -5,48 +5,111 @@ use strict; use warnings; use NEXT; +use Catalyst::Utils (); -our $VERSION = "0.01"; +our $VERSION = "0.02"; sub setup_session { - my $c = shift; + my $c = shift; + + $c->NEXT::setup_session(@_); + + $c->config->{session}{cookie_name} + ||= Catalyst::Utils::appprefix($c) . '_session'; +} + +sub extend_session_id { + my ( $c, $sid, $expires ) = @_; + + if ( my $cookie = $c->get_session_cookie ) { + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); + } + + $c->NEXT::extend_session_id( @_ ); +} + +sub set_session_id { + my ( $c, $sid ) = @_; + + $c->update_session_cookie( $c->make_session_cookie( $sid ) ); + + return $c->NEXT::set_session_id(@_); +} - $c->NEXT::setup_session(@_); +sub update_session_cookie { + my ( $c, $updated ) = @_; + my $cookie_name = $c->config->{session}{cookie_name}; + $c->response->cookies->{$cookie_name} = $updated; +} + +sub make_session_cookie { + my ( $c, $sid, %attrs ) = @_; - $c->config->{session}{cookie_name} ||= "session"; + my $cfg = $c->config->{session}; + my $cookie = { + value => $sid, + %attrs, + ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ), + }; + + unless ( exists $cookie->{expires} ) { + $cookie->{expires} = $c->calculate_session_cookie_expires(); + } + + $cookie->{secure} = 1 if $cfg->{cookie_secure}; + + return $cookie; } -sub finalize { +sub calc_expiry { # compat my $c = shift; + $c->NEXT::calc_expiry( @_ ) || $c->calculate_session_cookie_expires( @_ ); +} - my $cookie_name = $c->config->{session}{cookie_name}; +sub calculate_session_cookie_expires { + my $c = shift; + my $cfg = $c->config->{session}; - 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->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; } } - - return $c->NEXT::finalize(@_); + else { + 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}; + + return $c->request->cookies->{$cookie_name}; +} - my $cookie_name = $c->config->{session}{cookie_name}; +sub get_session_id { + my $c = shift; - if ( my $cookie = $c->request->cookies->{$cookie_name} ) { + if ( 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 = shift; + $c->NEXT::delete_session_id(); + delete $c->response->cookies->{ $c->config->{session}{cookie_name} }; } __PACKAGE__ @@ -57,11 +120,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 @@ -70,6 +133,20 @@ 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. + +=back + =head1 EXTENDED METHODS =over 4 @@ -78,9 +155,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 it's 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. =back @@ -90,20 +172,53 @@ 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 set true, the cookie will only be sent via HTTPS. =back +=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 + +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