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 ();
-sub finalize {
+our $VERSION = "0.11";
+
+BEGIN { __PACKAGE__->mk_accessors(qw/_deleted_session_id/) }
+
+sub setup_session {
my $c = shift;
- if ( my $sid = $c->sessionid ) {
- my $cookie = $c->request->cookies->{session};
- if ( !$cookie or $cookie->value ne $sid ) {
- $c->response->cookies->{session} = { value => $sid };
- $c->log->debug(qq/A cookie with the session id "$sid" was saved/)
- if $c->debug;
+ $c->maybe::next::method(@_);
+
+ $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->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();
+ }
+
+ $cookie->{secure} = 1 if $cfg->{cookie_secure};
+
+ return $cookie;
+}
+
+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;
+ }
+}
+
+sub get_session_cookie {
+ my $c = shift;
+
+ my $cookie_name = $c->config->{session}{cookie_name};
- return $c->NEXT::finalize(@_);
+ return $c->request->cookies->{$cookie_name};
}
-sub prepare_cookies {
+sub get_session_id {
my $c = shift;
- if ( my $cookie = $c->request->cookies->{session} ) {
+ 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;
}
- $c->NEXT::prepare_cookies(@_);
+ $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__
=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
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<cookie_name> 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
Will restore if an appropriate cookie is found.
-=item finalize
+=item finalize_cookies
+
+Will set a cookie called C<session> if it doesn't exist or if its value is not
+the current session id.
+
+=item setup_session
+
+Will set the C<cookie_name> parameter to its default value if it isn't set.
+
+=back
+
+=head1 CONFIGURATION
+
+=over 4
+
+=item cookie_name
+
+The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
+
+=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.
-Will set a cookie called C<session> if it doesn't exist or if it's value is not the current session id.
+=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<Catalyst>, L<Catalyst::Plugin::Session>.
-=head1 AUTHOR
+=head1 AUTHORS
+
+Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
+
+=head1 CONTRIBUTORS
+
+This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
+has been heavily modified since.
-Sebastian Riedel E<lt>C<sri@cpan.org>E<gt>,
-Marcus Ramberg E<lt>C<mramberg@cpan.org>E<gt>,
-Andrew Ford E<lt>C<andrewf@cpan.org>E<gt>,
-Yuval Kogman E<lt>C<nothingmuch@woobling.org>E<gt>
+ Andrew Ford
+ Andy Grundman
+ Christian Hansen
+ Marcus Ramberg
+ Jonathan Rockway E<lt>jrockway@cpan.orgE<gt>
+ Sebastian Riedel
=head1 COPYRIGHT