-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'
- };
+use warnings;
- $c->session->{foo} = 'bar';
- print $c->sessionid;
-
-=head1 DESCRIPTION
-
-C<Catalyst::Plugin::Session::FastMmap> 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<Cache::FastMMap>.
+use NEXT;
+our $VERSION = "0.01";
-=head2 EXTENDED METHODS
+sub setup_session {
+ my $c = shift;
-=over 4
+ $c->NEXT::setup_session(@_);
-=item finalize
-
-=cut
+ $c->config->{session}{cookie_name} ||= "session";
+}
sub finalize {
my $c = shift;
- if ( $c->config->{session}->{rewrite} ) {
- my $redirect = $c->response->redirect;
- $c->response->redirect( $c->uri($redirect) ) if $redirect;
- }
+
+ my $cookie_name = $c->config->{session}{cookie_name};
+
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->{$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;
}
}
+
return $c->NEXT::finalize(@_);
}
-=item prepare_action
+sub prepare_cookies {
+ my $c = shift;
-=cut
+ my $ret = $c->NEXT::prepare_cookies(@_);
-sub prepare_action {
- 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 $cookie_name = $c->config->{session}{cookie_name};
+
+ if ( my $cookie = $c->request->cookies->{$cookie_name} ) {
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} = {};
- }
+ return $ret;
}
-=item setup
+__PACKAGE__
-Sets up the session cache file.
+__END__
-=cut
-
-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
+=head1 NAME
-=head2 METHODS
+Catalyst::Plugin::Session::State::Cookie - A session ID
-=over 4
+=head1 SYNOPSIS
-=item session
+ use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
-=item uri
+=head1 DESCRIPTION
-Extends an uri with session id if needed.
+In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
+stored on the client, and the session data needs to be stored on the server.
- my $uri = $c->uri('http://localhost/foo');
+This plugin stores the session ID on the client using the cookie mechanism.
-=cut
+=head1 EXTENDED METHODS
-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;
-}
+=over 4
-=back
+=item prepare_cookies
-=head2 CONFIG OPTIONS
+Will restore if an appropriate cookie is found.
-=over 4
+=item finalize
-=item rewrite
+Will set a cookie called C<session> if it doesn't exist or if it's value is not
+the current session id.
-If set to a true value sessions are automatically stored in the url;
-defaults to false.
+=item setup_session
-=item storage
+Will set the C<cookie_name> parameter to it's default value if it isn't set.
-Specifies the file to be used for the sharing of session data;
-defaults to C</tmp/session>.
+=back
-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.
+=head1 CONFIGURATION
+=over 4
-=item expires
+=item cookie_name
-Specifies the session expiry time in seconds; defaults to 86,400,
-i.e. one day.
+The name of the cookie to store (defaults to C<session>).
=back
=head1 SEE ALSO
-L<Catalyst>, L<Cache::FastMmap>.
+L<Catalyst>, L<Catalyst::Plugin::Session>.
=head1 AUTHOR
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>
+Andrew Ford E<lt>C<andrewf@cpan.org>E<gt>,
+Yuval Kogman E<lt>C<nothingmuch@woobling.org>E<gt>
=head1 COPYRIGHT
projects / catagits/Catalyst-Plugin-Session-State-Cookie.git / blobdiff