use namespace::clean -except => 'meta';
-our $VERSION = '0.27';
+our $VERSION = '0.37';
$VERSION = eval $VERSION;
my @session_data_accessors; # used in delete_session
# fix cookie before we send headers
$c->_save_session_expires;
+ # Force extension of session_expires before finalizing headers, so a pos
+ # up to date. First call to session_expires will extend the expiry, subs
+ # just return the previously extended value.
+ $c->session_expires;
+
return $c->maybe::next::method(@_);
}
no warnings 'uninitialized'; # ne __address
if ( $c->_session_plugin_config->{verify_address}
+ && exists $session_data->{__address}
&& $session_data->{__address} ne $c->request->address )
{
$c->log->warn(
sub extend_session_expires {
my ( $c, $expires ) = @_;
- $c->_extended_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) );
+ $c->_extended_session_expires( my $updated = $c->calculate_initial_session_expires( $expires ) );
$c->extend_session_id( $c->sessionid, $updated );
return $updated;
}
-sub calculate_initial_session_expires {
+sub change_session_expires {
+ my ( $c, $expires ) = @_;
+
+ $expires ||= 0;
+ my $sid = $c->sessionid;
+ my $time_exp = time() + $expires;
+ $c->store_session_data( "expires:$sid" => $time_exp );
+}
+
+sub initial_session_expires {
my $c = shift;
return ( time() + $c->_session_plugin_config->{expires} );
}
+sub calculate_initial_session_expires {
+ my $c = shift;
+
+ my $initial_expires = $c->initial_session_expires;
+ my $stored_session_expires = 0;
+ if ( my $sid = $c->sessionid ) {
+ $stored_session_expires = $c->get_session_data("expires:$sid") || 0;
+ }
+ return ( $initial_expires > $stored_session_expires ) ? $initial_expires : $stored_session_expires;
+}
+
sub calculate_extended_session_expires {
my ( $c, $prev ) = @_;
- $c->calculate_initial_session_expires;
+ return ( time() + $prev );
}
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;
}
(
$c->maybe::next::method(),
- $c->sessionid
+ $c->_sessionid
? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], )
: ()
);
=item session_expires
-=item session_expires $reset
-
This method returns the time when the current session will expire, or 0 if
there is no current session. If there is a session and it already expired, it
will delete the session and return 0 as well.
-If the C<$reset> parameter is true, and there is a session ID the expiry time
-will be reset to the current time plus the time to live (see
-L</CONFIGURATION>). This is used when creating a new session.
-
=item flash
This is like Ruby on Rails' flash data structure. Think of it as a stash that
all the keys which haven't changed since the flash data was loaded at the end
of every request.
+Note that use of the flash is an easy way to get data across requests, but
+it's also strongly disrecommended, due it it being inherently plagued with
+race conditions. This means that it's unlikely to work well if your
+users have multiple tabs open at once, or if your site does a lot of AJAX
+requests.
+
+L<Catalyst::Plugin::StatusMessage> is the recommended alternative solution,
+as this doesn't suffer from these issues.
+
sub moose : Local {
my ( $self, $c ) = @_;
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
...
}
+=item change_session_expires $expires
+
+You can change the session expiration time for this session;
+
+ $c->change_session_expires( 4000 );
+
+Note that this only works to set the session longer than the config setting.
+
=back
=head1 INTERNAL METHODS
=item extend_session_expires
+Note: this is *not* used to give an individual user a longer session. See
+'change_session_expires'.
+
=item extend_session_id
=item get_session_id
=item set_session_id
+=item initial_session_expires
+
=back
=head1 USING SESSIONS DURING PREPARE
=item verify_address
-When true, C<<$c->request->address>> will be checked at prepare time. If it is
+When true, C<< $c->request->address >> will be checked at prepare time. If it is
not the same as the address that initiated the session, the session is deleted.
Defaults to false.
=item verify_user_agent
-When true, C<<$c->request->user_agent>> will be checked at prepare time. If it
+When true, C<< $c->request->user_agent >> will be checked at prepare time. If it
is not the same as the user agent that initiated the session, the session is
deleted.
=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
kmx C<kmx@volny.cz>
+Florian Ragwitz (rafl) C<rafl@debian.org>
+
+Kent Fredric (kentnl)
+
And countless other contributers from #catalyst. Thanks guys!
+=head1 Contributors
+
+Devin Austin (dhoss) <dhoss@cpan.org>
+
=head1 COPYRIGHT & LICENSE
Copyright (c) 2005 the aforementioned authors. All rights
projects / catagits/Catalyst-Plugin-Session.git / blobdiff