Optimisation - only save session if data added by application

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

diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm
index 2549f66..168b60f 100644 (file)
--- a/lib/Catalyst/Plugin/Session.pm
+++ b/lib/Catalyst/Plugin/Session.pm
@@ -13,7 +13,8 @@ use Carp;
 
 use namespace::clean -except => 'meta';
 
-our $VERSION = '0.26';
+our $VERSION = '0.31';
+$VERSION = eval $VERSION;
 
 my @session_data_accessors; # used in delete_session
 
@@ -374,6 +375,11 @@ sub reset_session_expires {
 
     my $exp = $c->calculate_initial_session_expires;
     $c->_session_expires( $exp );
+    #
+    # since we're setting _session_expires directly, make load_session_expires
+    # actually use that value.
+    #
+    $c->_tried_loading_session_expires(1);
     $c->_extended_session_expires( $exp );
     $exp;
 }
@@ -424,10 +430,21 @@ sub validate_session_id {
 sub session {
     my $c = shift;
 
-    $c->_session || $c->_load_session || do {
+    my $session = $c->_session || $c->_load_session || do {
         $c->create_session_id_if_needed;
         $c->initialize_session_data;
     };
+
+    if (@_) {
+      my $new_values = @_ > 1 ? { @_ } : $_[0];
+      croak('session takes a hash or hashref') unless ref $new_values;
+
+      for my $key (keys %$new_values) {
+        $session->{$key} = $new_values->{$key};
+      }
+    }
+
+    $session;
 }
 
 sub keep_flash {
@@ -482,8 +499,7 @@ sub initialize_session_data {
 
     my $now = time;
 
-    return $c->_session(
-        {
+    my $session_data = {
             __created => $now,
             __updated => $now,
 
@@ -497,8 +513,12 @@ sub initialize_session_data {
                 ? ( __user_agent => $c->request->user_agent||'' )
                 : ()
             ),
-        }
-    );
+    };
+
+    # Only save this session if data is added by the application
+    $c->_session_data_sig( Object::Signature::signature($session_data) );
+
+    return $c->_session($session_data);
 }
 
 sub generate_session_id {
@@ -561,7 +581,7 @@ sub dump_these {
     (
         $c->maybe::next::method(),
 
-        $c->sessionid
+        $c->_sessionid
         ? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], )
         : ()
     );
@@ -677,6 +697,13 @@ requests.
 This method will automatically create a new session and session ID if none
 exists.
 
+You can also set session keys by passing a list of key/value pairs or a
+hashref.
+
+    $c->session->{foo} = "bar";      # This works.
+    $c->session(one => 1, two => 2); # And this.
+    $c->session({ answer => 42 });   # And this.
+
 =item session_expires
 
 =item session_expires $reset
@@ -764,7 +791,8 @@ expiry time for the whole session).
 
 For example:
 
-    __PACKAGE__->config('Plugin::Session' => { expires => 1000000000000 }); # forever
+    __PACKAGE__->config('Plugin::Session' => { expires => 10000000000 }); # "forever" 
+    (NB If this number is too large, Y2K38 breakage could result.)
 
     # later
 
@@ -1081,11 +1109,8 @@ changes by request a
 
 =back
 
-If this is a concern in your application, a soon-to-be-developed locking
-solution is the only safe way to go. This will have a bigger overhead.
-
-For applications where any given user is only making one request at a time this
-plugin should be safe enough.
+For applications where any given user's session is only making one request
+at a time this plugin should be safe enough.
 
 =head1 AUTHORS
 
@@ -1103,6 +1128,10 @@ Sergio Salvi
 
 kmx C<kmx@volny.cz>
 
+Florian Ragwitz (rafl) C<rafl@debian.org>
+
+Kent Fredric (kentnl)
+
 And countless other contributers from #catalyst. Thanks guys!
 
 =head1 COPYRIGHT & LICENSE