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=7ff701f2d21c2cea19a7d182e48b250769779b62;hp=698063959a6630adb02721aeff8fc94769d8e3d8;hb=df55e81852ab240c060fc6423ac188bfebb5df51;hpb=cc88d7267f661665aca3f3dda7bb2f0342c237c9

diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm
index 6980639..7ff701f 100644
--- a/lib/Catalyst/Plugin/Session/State/Cookie.pm
+++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm
@@ -1,212 +1,226 @@
-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 warnings;
+
 use NEXT;
-use Cache::FastMmap;
-use Digest::MD5;
-use URI;
-use URI::Find;
-use File::Temp 'tempdir';
+use Catalyst::Utils ();
+
+our $VERSION = "0.02";
 
-our $VERSION = '0.13';
+sub setup_session {
+    my $c = shift;
 
-__PACKAGE__->mk_classdata('_session');
-__PACKAGE__->mk_accessors('sessionid');
+    $c->NEXT::setup_session(@_);
 
-=head1 NAME
+    $c->config->{session}{cookie_name}
+        ||= Catalyst::Utils::appprefix($c) . '_session';
+}
 
-Catalyst::Plugin::Session::FastMmap - FastMmap sessions for Catalyst
+sub extend_session_id {
+    my ( $c, $sid, $expires ) = @_;
 
-=head1 SYNOPSIS
+    if ( my $cookie = $c->get_session_cookie ) {
+        $c->update_session_cookie( $c->make_session_cookie( $sid ) );
+    }
 
-    use Catalyst 'Session::FastMmap';
-    
-    MyApp->config->{session} = {
-        expires => 3600,
-        rewrite => 1,
-        storage => '/tmp/session'
-    };
+    $c->NEXT::extend_session_id( @_ );
+}
 
-    $c->session->{foo} = 'bar';
-    print $c->sessionid;
+sub set_session_id {
+    my ( $c, $sid ) = @_;
 
-=head1 DESCRIPTION
+    $c->update_session_cookie( $c->make_session_cookie( $sid ) );
 
-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>.
+    return $c->NEXT::set_session_id(@_);
+}
 
+sub update_session_cookie {
+    my ( $c, $updated ) = @_;
+    my $cookie_name = $c->config->{session}{cookie_name};
+    $c->response->cookies->{$cookie_name} = $updated;
+}
 
-=head2 EXTENDED METHODS
+sub make_session_cookie {
+    my ( $c, $sid, %attrs ) = @_;
 
-=over 4
+    my $cfg    = $c->config->{session};
+    my $cookie = {
+        value => $sid,
+        ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
+        %attrs,
+    };
 
-=item finalize
+    unless ( exists $cookie->{expires} ) {
+        $cookie->{expires} = $c->calculate_session_cookie_expires();
+    }
 
-=cut
+    $cookie->{secure} = 1 if $cfg->{cookie_secure};
 
-sub finalize {
+    return $cookie;
+}
+
+sub calc_expiry { # compat
     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
-            };
+    $c->NEXT::calc_expiry( @_ ) || $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(@_);
+    return $value if $value;
+
+    if ( exists $cfg->{cookie_expires} ) {
+        if ( $cfg->{cookie_expires} > 0 ) {
+            return time() + $cfg->{cookie_expires};
         }
-        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;
+        else {
+            return undef;
         }
     }
-    return $c->NEXT::finalize(@_);
+    else {
+        return $c->session_expires;
+    }
 }
 
-=item prepare_action
+sub get_session_cookie {
+    my $c = shift;
 
-=cut
+    my $cookie_name = $c->config->{session}{cookie_name};
 
-sub prepare_action {
+    return $c->request->cookies->{$cookie_name};
+}
+
+sub get_session_id {
     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} ) {
+
+    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;
     }
-    $c->NEXT::prepare_action(@_);
+
+    $c->NEXT::get_session_id(@_);
 }
 
-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} = {};
-    }
+sub delete_session_id {
+    my ( $c, $sid ) = @_;
+
+    $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
+
+    $c->NEXT::delete_session_id($sid);
 }
 
-=item setup
+__PACKAGE__
 
-Sets up the session cache file.
+__END__
 
-=cut
+=pod
 
-sub setup {
-    my $self = shift;
-    $self->config->{session}->{storage} ||= '/tmp/session';
-    $self->config->{session}->{expires} ||= 60 * 60 * 24;
-    $self->config->{session}->{rewrite} ||= 0;
+=head1 NAME
 
-    $self->_session(
-        Cache::FastMmap->new(
-            share_file  => $self->config->{session}->{storage},
-            expire_time => $self->config->{session}->{expires}
-        )
-    );
+Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
 
-    return $self->NEXT::setup(@_);
-}
+=head1 SYNOPSIS
+
+    use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
+
+=head1 DESCRIPTION
+
+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.
+
+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.
 
 =back
 
-=head2 METHODS
+=head1 EXTENDED METHODS
 
 =over 4
 
-=item session
+=item prepare_cookies
 
-=item uri
+Will restore if an appropriate cookie is found.
 
-Extends an uri with session id if needed.
+=item finalize_cookies
 
-    my $uri = $c->uri('http://localhost/foo');
+Will set a cookie called C<session> if it doesn't exist or if it's value is not
+the current session id.
 
-=cut
+=item setup_session
 
-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;
-}
+Will set the C<cookie_name> parameter to it's default value if it isn't set.
 
 =back
 
-=head2 CONFIG OPTIONS
+=head1 CONFIGURATION
 
 =over 4
 
-=item rewrite
+=item cookie_name
 
-If set to a true value sessions are automatically stored in the url;
-defaults to false.
+The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
 
-=item storage
+=item cookie_domain
 
-Specifies the file to be used for the sharing of session data;
-defaults to C</tmp/session>. 
+The name of the domain to store in the cookie (defaults to current host)
 
-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 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 expires
+=item cookie_secure
 
-Specifies the session expiry time in seconds; defaults to 86,400,
-i.e. one day.
+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<Catalyst>, L<Cache::FastMmap>.
+L<Catalyst>, L<Catalyst::Plugin::Session>.
+
+=head1 AUTHORS
 
-=head1 AUTHOR
+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>
+Andrew Ford
+Andy Grundman
+Christian Hansen
+Yuval Kogman, C<nothingmuch@woobling.org>
+Marcus Ramberg
+Sebastian Riedel
 
 =head1 COPYRIGHT