From: Yuval Kogman Date: Wed, 26 Oct 2005 11:58:55 +0000 (+0000) Subject: Session::State::Cookie X-Git-Tag: v0.01~17 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Session-State-Cookie.git;a=commitdiff_plain;h=1a776a0c28d878c0faad12f6cf35b72bfe87991d Session::State::Cookie --- diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index 6980639..e865c3e 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,212 +1,83 @@ -package Catalyst::Plugin::Session::FastMmap; +package Catalyst::Plugin::Session::State::Cookie; +use base qw/Catalyst::Plugin::Session::State/; use strict; -use base qw/Class::Data::Inheritable Class::Accessor::Fast/; -use NEXT; -use Cache::FastMmap; -use Digest::MD5; -use URI; -use URI::Find; -use File::Temp 'tempdir'; - -our $VERSION = '0.13'; - -__PACKAGE__->mk_classdata('_session'); -__PACKAGE__->mk_accessors('sessionid'); - -=head1 NAME - -Catalyst::Plugin::Session::FastMmap - FastMmap sessions for Catalyst - -=head1 SYNOPSIS - - use Catalyst 'Session::FastMmap'; - - MyApp->config->{session} = { - expires => 3600, - rewrite => 1, - storage => '/tmp/session' - }; - - $c->session->{foo} = 'bar'; - print $c->sessionid; - -=head1 DESCRIPTION - -C is a fast session plugin for -Catalyst that uses an mmap'ed file to act as a shared memory -interprocess cache. It is based on C. - - -=head2 EXTENDED METHODS +use warnings; -=over 4 - -=item finalize - -=cut +use NEXT; sub finalize { my $c = shift; - if ( $c->config->{session}->{rewrite} ) { - my $redirect = $c->response->redirect; - $c->response->redirect( $c->uri($redirect) ) if $redirect; - } + if ( my $sid = $c->sessionid ) { - $c->_session->set( $sid, $c->session ); - my $set = 1; - if ( my $cookie = $c->request->cookies->{session} ) { - $set = 0 if $cookie->value eq $sid; - } - if ( $set ) { - $c->response->cookies->{session} = { - value => $sid - }; - } - if ( $c->config->{session}->{rewrite} ) { - my $finder = URI::Find->new( - sub { - my ( $uri, $orig ) = @_; - my $base = $c->request->base; - return $orig unless $orig =~ /^$base/; - return $orig if $uri->path =~ /\/-\//; - return $c->uri($orig); - } - ); - $finder->find( \$c->res->{body} ) if $c->res->body; + 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; } } + return $c->NEXT::finalize(@_); } -=item prepare_action - -=cut - -sub prepare_action { +sub prepare_cookies { my $c = shift; - if ( $c->request->path =~ /^(.*)\/\-\/(.+)$/ ) { - $c->request->path($1); - $c->sessionid($2); - $c->log->debug(qq/Found sessionid "$2" in path/) if $c->debug; - } + if ( my $cookie = $c->request->cookies->{session} ) { my $sid = $cookie->value; $c->sessionid($sid); $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug; } - $c->NEXT::prepare_action(@_); -} -sub session { - my $c = shift; - return $c->{session} if $c->{session}; - my $sid = $c->sessionid; - if ( $sid - && $c->_session - && ( $c->{session} = $c->_session->get($sid) ) ) - { - $c->log->debug(qq/Found session "$sid"/) if $c->debug; - return $c->{session}; - } - else { - my $sid = Digest::MD5::md5_hex( time, rand, $$, 'catalyst' ); - $c->sessionid($sid); - $c->log->debug(qq/Created session "$sid"/) if $c->debug; - return $c->{session} = {}; - } + $c->NEXT::prepare_cookies(@_); } -=item setup +__PACKAGE__ -Sets up the session cache file. - -=cut +__END__ -sub setup { - my $self = shift; - $self->config->{session}->{storage} ||= '/tmp/session'; - $self->config->{session}->{expires} ||= 60 * 60 * 24; - $self->config->{session}->{rewrite} ||= 0; +=pod - $self->_session( - Cache::FastMmap->new( - share_file => $self->config->{session}->{storage}, - expire_time => $self->config->{session}->{expires} - ) - ); - - return $self->NEXT::setup(@_); -} - -=back - -=head2 METHODS - -=over 4 - -=item session +=head1 NAME -=item uri +Catalyst::Plugin::Session::State::Cookie - A session ID -Extends an uri with session id if needed. +=head1 SYNOPSIS - my $uri = $c->uri('http://localhost/foo'); + use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/; -=cut +=head1 DESCRIPTION -sub uri { - my ( $c, $uri ) = @_; - if ( my $sid = $c->sessionid ) { - $uri = URI->new($uri); - my $path = $uri->path; - $path .= '/' unless $path =~ /\/$/; - $uri->path( $path . "-/$sid" ); - return $uri->as_string; - } - return $uri; -} +In order for L to work the session ID needs to be +stored on the client, and the session data needs to be stored on the server. -=back +This plugin stores the session ID on the client using the cookie mechanism. -=head2 CONFIG OPTIONS +=head1 EXTENDED METHODS =over 4 -=item rewrite - -If set to a true value sessions are automatically stored in the url; -defaults to false. - -=item storage +=item prepare_cookies -Specifies the file to be used for the sharing of session data; -defaults to C. +Will restore if an appropriate cookie is found. -Note that the file will be created with mode 0640, which means that it -will only be writeable by processes running with the same uid as the -process that creates the file. If this may be a problem, for example -if you may try to debug the program as one user and run it as another, -specify a filename like C<< /tmp/session-$> >>, which includes the -UID of the process in the filename. - - -=item expires +=item finalize -Specifies the session expiry time in seconds; defaults to 86,400, -i.e. one day. +Will set a cookie called C if it doesn't exist or if it's value is not the current session id. =back =head1 SEE ALSO -L, L. +L, L. =head1 AUTHOR Sebastian Riedel ECE, Marcus Ramberg ECE, -Andrew Ford ECE +Andrew Ford ECE, +Yuval Kogman ECE =head1 COPYRIGHT diff --git a/t/basic.t b/t/basic.t new file mode 100644 index 0000000..ea32870 --- /dev/null +++ b/t/basic.t @@ -0,0 +1,101 @@ +#!/usr/bin/perl + +use strict; +use warnings; + +use Test::More tests => 13; +use Test::MockObject; +use Test::MockObject::Extends; + +my $m; +BEGIN { use_ok( $m = "Catalyst::Plugin::Session::State::Cookie" ) } + +my $cookie = Test::MockObject->new; +$cookie->set_always( value => "the session id" ); + +my $req = Test::MockObject->new; +my %req_cookies; +$req->set_always( cookies => \%req_cookies ); + +my $res = Test::MockObject->new; +my %res_cookies; +$res->set_always( cookies => \%res_cookies ); + +my $cxt = + Test::MockObject::Extends->new("Catalyst::Plugin::Session::State::Cookie"); + +$cxt->set_always( request => $req ); +$cxt->set_always( response => $res ); +$cxt->set_false("debug"); +my $sessionid; +$cxt->mock( sessionid => sub { shift; $sessionid = shift if @_; $sessionid } ); + +can_ok( $m, "prepare_cookies" ); + +$cxt->prepare_cookies; +ok( !$cxt->called("sessionid"), + "didn't try setting session ID when there was nothing to set it by" ); + +$cxt->clear; + +%req_cookies = ( session => $cookie ); + +ok( !$cxt->sessionid, "no session ID yet" ); +$cxt->prepare_cookies; +is( $cxt->sessionid, "the session id", "session ID was restored from cookie" ); + +$cxt->clear; +$res->clear; + +can_ok( $m, "finalize" ); +$cxt->finalize; +ok( !$res->called("cookies"), + "response cookie was not set since res cookie is already there" ); + +$cxt->clear; +$sessionid = undef; +$res->clear; + +$cxt->finalize; +ok( !$res->called("cookies"), +"response cookie was not set when sessionid was deleted, even if req cookie is still there" +); + +$sessionid = "some other ID"; +$cxt->clear; +$res->clear; + +$cxt->finalize; +$res->called_ok( "cookies", "response cookie was set when sessionid changed" ); +is_deeply( + \%res_cookies, + { session => { value => $sessionid } }, + "cookie was set correctly" +); + +$cxt->clear; +$res->clear; +%req_cookies = (); +%res_cookies = (); +$sessionid = undef; + +$cxt->finalize; +ok( !$res->called("cookies"), + "response cookie was not set when there is no sessionid or request cookie" +); + +$cxt->clear; +$sessionid = "123"; +%res_cookies = (); +$res->clear; + +$cxt->finalize; + +$res->called_ok( "cookies", + "response cookie was set when session was created" ); +is_deeply( + \%res_cookies, + { session => { value => $sessionid } }, + "cookie was set correctly" +); +