Update version in Build.PL

[catagits/Catalyst-Plugin-Session-State-Cookie.git] / lib / Catalyst / Plugin / Session / State / Cookie.pm

diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm
index 51727e2..7fbde70 100644 (file)
--- a/lib/Catalyst/Plugin/Session/State/Cookie.pm
+++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm
@@ -5,25 +5,35 @@ use strict;
 use warnings;
 
 use NEXT;
+use Catalyst::Utils ();
 
-our $VERSION = "0.01";
+our $VERSION = "0.04";
 
 sub setup_session {
     my $c = shift;
 
     $c->NEXT::setup_session(@_);
 
-    $c->config->{session}{cookie_name} ||= "session";
+    $c->config->{session}{cookie_name}
+        ||= Catalyst::Utils::appprefix($c) . '_session';
 }
 
-sub finalize_cookies {
-    my $c = shift;
+sub extend_session_id {
+    my ( $c, $sid, $expires ) = @_;
 
-    if ( $c->sessionid ) {
-        $c->update_session_cookie( $c->make_session_cookie );
+    if ( my $cookie = $c->get_session_cookie ) {
+        $c->update_session_cookie( $c->make_session_cookie( $sid ) );
     }
 
-    return $c->NEXT::finalize_cookies(@_);
+    $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(@_);
 }
 
 sub update_session_cookie {
@@ -33,40 +43,75 @@ sub update_session_cookie {
 }
 
 sub make_session_cookie {
-    my $c = shift;
+    my ( $c, $sid, %attrs ) = @_;
 
     my $cfg    = $c->config->{session};
     my $cookie = {
-        value => $c->sessionid,
+        value => $sid,
         ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
+        %attrs,
     };
 
-    if ( exists $cfg->{cookie_expires} ) {
-        if ( my $ttl = $cfg->{cookie_expires} ) {
-            $cookie->{expires} = time() + $ttl;
-        }    # else { cookie is non-persistent }
-    }
-    else {
-        $cookie->{expires} = $c->session->{__expires};
+    unless ( exists $cookie->{expires} ) {
+        $cookie->{expires} = $c->calculate_session_cookie_expires();
     }
 
+    $cookie->{secure} = 1 if $cfg->{cookie_secure};
+
     return $cookie;
 }
 
-sub prepare_cookies {
+sub calc_expiry { # compat
     my $c = shift;
+    $c->NEXT::calc_expiry( @_ ) || $c->calculate_session_cookie_expires( @_ );
+}
 
-    my $ret = $c->NEXT::prepare_cookies(@_);
+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};
+        }
+        else {
+            return undef;
+        }
+    }
+    else {
+        return $c->session_expires;
+    }
+}
+
+sub get_session_cookie {
+    my $c = shift;
 
     my $cookie_name = $c->config->{session}{cookie_name};
 
-    if ( my $cookie = $c->request->cookies->{$cookie_name} ) {
+    return $c->request->cookies->{$cookie_name};
+}
+
+sub get_session_id {
+    my $c = shift;
+
+    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, $sid ) = @_;
+
+    $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
+
+    $c->NEXT::delete_session_id($sid);
 }
 
 __PACKAGE__
@@ -77,7 +122,7 @@ __END__
 
 =head1 NAME
 
-Catalyst::Plugin::Session::State::Cookie - A session ID 
+Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
 
 =head1 SYNOPSIS
 
@@ -129,12 +174,22 @@ Will set the C<cookie_name> parameter to it's default value if it isn't set.
 
 =item cookie_name
 
-The name of the cookie to store (defaults to C<session>).
+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.
+
 =back
 
 =head1 CAVEATS
@@ -155,12 +210,17 @@ actually created the headers have already been sent to the client.
 
 L<Catalyst>, L<Catalyst::Plugin::Session>.
 
-=head1 AUTHOR
+=head1 AUTHORS
+
+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
+Yuval Kogman, C<nothingmuch@woobling.org>
+Marcus Ramberg
+Sebastian Riedel
 
 =head1 COPYRIGHT