use Catalyst::Exception ();
use Digest ();
use overload ();
+use Object::Signature ();
-our $VERSION = "0.02";
+our $VERSION = "0.09";
+my @session_data_accessors; # used in delete_session
BEGIN {
- __PACKAGE__->mk_accessors(qw/_sessionid _session _session_delete_reason _flash _flash_stale_keys/);
+ __PACKAGE__->mk_accessors(
+ "_session_delete_reason",
+ @session_data_accessors = qw/
+ _sessionid
+ _session
+ _session_expires
+ _session_data_sig
+ _flash
+ _flash_keep_keys
+ _flash_key_hashes
+ _tried_loading_session_id
+ _tried_loading_session_data
+ _tried_loading_session_expires
+ _tried_loading_flash_data
+ /
+ );
}
sub setup {
$c->NEXT::setup_session();
}
+sub prepare_action {
+ my $c = shift;
+
+ if ( $c->config->{session}{flash_to_stash}
+ and $c->sessionid
+ and my $flash_data = $c->flash )
+ {
+ @{ $c->stash }{ keys %$flash_data } = values %$flash_data;
+ }
+
+ $c->NEXT::prepare_action(@_);
+}
+
sub finalize {
my $c = shift;
+ $c->_save_session_expires;
$c->_save_session;
$c->_save_flash;
+ $c->_save_session_id;
$c->NEXT::finalize(@_);
}
+sub _save_session_id {
+ my $c = shift;
+}
+
+sub _save_session_expires {
+ my $c = shift;
+
+ if ( defined(my $expires = $c->_session_expires) ) {
+ my $sid = $c->sessionid;
+ $c->store_session_data( "expires:$sid" => $expires );
+
+ $c->_session_expires(undef);
+ $c->_tried_loading_session_expires(undef);
+ }
+}
+
sub _save_session {
my $c = shift;
-
+
if ( my $session_data = $c->_session ) {
- # all sessions are extended at the end of the request
- my $now = time;
- @{ $session_data }{qw/__updated __expires/} =
- ( $now, $c->config->{session}{expires} + $now );
+ no warnings 'uninitialized';
+ if ( Object::Signature::signature($session_data) ne
+ $c->_session_data_sig )
+ {
+ $session_data->{__updated} = time();
+ my $sid = $c->sessionid;
+ $c->store_session_data( "session:$sid" => $session_data );
+ }
- $c->store_session_data( "session:" . $c->sessionid, $session_data );
+ $c->_session(undef);
+ $c->_tried_loading_session_data(undef);
}
}
my $c = shift;
if ( my $flash_data = $c->_flash ) {
- delete @{ $flash_data }{ @{ $c->_flash_stale_keys || [] } };
- $c->store_session_data( "flash:" . $c->sessionid, $flash_data );
+
+ my $hashes = $c->_flash_key_hashes || {};
+ my $keep = $c->_flash_keep_keys || {};
+ foreach my $key ( keys %$hashes ) {
+ if ( !exists $keep->{$key} and Object::Signature::signature( \$flash_data->{$key} ) eq $hashes->{$key} ) {
+ delete $flash_data->{$key};
+ }
+ }
+
+ my $sid = $c->sessionid;
+
+ if (%$flash_data) {
+ $c->store_session_data( "flash:$sid", $flash_data );
+ }
+ else {
+ $c->delete_session_data("flash:$sid");
+ }
+
+ $c->_flash(undef);
+ $c->_tried_loading_flash_data(undef);
}
}
-sub _load_session {
+sub _load_session_expires {
my $c = shift;
+ return $c->_session_expires if $c->_tried_loading_session_expires;
+ $c->_tried_loading_session_expires(1);
- if ( my $sid = $c->_sessionid ) {
- no warnings 'uninitialized'; # ne __address
-
- my $session_data = $c->_session || $c->_session( $c->get_session_data( "session:$sid" ) );
- if ( !$session_data or $session_data->{__expires} < time ) {
+ if ( my $sid = $c->sessionid ) {
+ my $expires = $c->get_session_data("expires:$sid") || 0;
- # session expired
- $c->log->debug("Deleting session $sid (expired)") if $c->debug;
- $c->delete_session("session expired");
- }
- elsif ($c->config->{session}{verify_address}
- && $session_data->{__address} ne $c->request->address )
- {
- $c->log->warn(
- "Deleting session $sid due to address mismatch ("
- . $session_data->{__address} . " != "
- . $c->request->address . ")",
- );
- $c->delete_session("address mismatch");
+ if ( $expires >= time() ) {
+ return $c->extend_session_expires( $expires );
+ } else {
+ $c->delete_session( "session expired" );
+ return 0;
}
- else {
+ }
+
+ return;
+}
+
+sub _load_session {
+ my $c = shift;
+ return $c->_session if $c->_tried_loading_session_data;
+ $c->_tried_loading_session_data(1);
+
+ if ( my $sid = $c->sessionid ) {
+ if ( $c->session_expires ) { # > 0
+
+ my $session_data = $c->get_session_data("session:$sid") || return;
+ $c->_session($session_data);
+
+ no warnings 'uninitialized'; # ne __address
+ if ( $c->config->{session}{verify_address}
+ && $session_data->{__address} ne $c->request->address )
+ {
+ $c->log->warn(
+ "Deleting session $sid due to address mismatch ("
+ . $session_data->{__address} . " != "
+ . $c->request->address . ")"
+ );
+ $c->delete_session("address mismatch");
+ return;
+ }
+
$c->log->debug(qq/Restored session "$sid"/) if $c->debug;
- }
-
- $c->_expire_ession_keys;
+ $c->_session_data_sig( Object::Signature::signature($session_data) ) if $session_data;
+ $c->_expire_session_keys;
- return $session_data;
+ return $session_data;
+ }
}
- return undef;
+ return;
}
sub _load_flash {
my $c = shift;
+ return $c->_flash if $c->_tried_loading_flash_data;
+ $c->_tried_loading_flash_data(1);
- if ( my $sid = $c->_sessionid ) {
- if ( my $flash_data = $c->_flash || $c->_flash( $c->get_session_data("flash:$sid") ) ) {
- $c->_flash_stale_keys([ keys %$flash_data ]);
+ if ( my $sid = $c->sessionid ) {
+ if ( my $flash_data = $c->_flash
+ || $c->_flash( $c->get_session_data("flash:$sid") ) )
+ {
+ $c->_flash_key_hashes({ map { $_ => Object::Signature::signature( \$flash_data->{$_} ) } keys %$flash_data });
+
return $flash_data;
}
}
- return undef;
+ return;
}
-sub _expire_ession_keys {
+sub _expire_session_keys {
my ( $c, $data ) = @_;
my $now = time;
- my $expiry = ($data || $c->_session || {})->{__expire_keys} || {};
- foreach my $key (grep { $expiry->{$_} < $now } keys %$expiry ) {
+ my $expire_times = ( $data || $c->_session || {} )->{__expire_keys} || {};
+ foreach my $key ( grep { $expire_times->{$_} < $now } keys %$expire_times ) {
delete $c->_session->{$key};
- delete $expiry->{$key};
+ delete $expire_times->{$key};
}
}
sub delete_session {
my ( $c, $msg ) = @_;
+ $c->log->debug("Deleting session") if $c->debug;
+
# delete the session data
- my $sid = $c->_sessionid || return;
- $c->delete_session_data( "session:$sid" );
+ if ( my $sid = $c->sessionid ) {
+ $c->delete_session_data("${_}:${sid}") for qw/session expires flash/;
+ $c->delete_session_id($sid);
+ }
# reset the values in the context object
- $c->_session(undef);
- $c->_sessionid(undef);
+ # see the BEGIN block
+ $c->$_(undef) for @session_data_accessors;
+
$c->_session_delete_reason($msg);
}
sub session_delete_reason {
my $c = shift;
- $c->_load_session if ( $c->_sessionid && !$c->_session ); # must verify session data
+ $c->session_is_valid; # check that it was loaded
- $c->_session_delete_reason( @_ );
+ $c->_session_delete_reason(@_);
+}
+
+sub session_expires {
+ my $c = shift;
+
+ if ( defined( my $expires = $c->_session_expires ) ) {
+ return $expires;
+ } elsif ( defined( $expires = $c->_load_session_expires ) ) {
+ $c->_session_expires($expires);
+ return $expires;
+ } else {
+ return 0;
+ }
+}
+
+sub extend_session_expires {
+ my ( $c, $expires ) = @_;
+ $c->_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) );
+ $c->extend_session_id( $c->sessionid, $updated );
+ return $updated;
+}
+
+sub calculate_initial_session_expires {
+ my $c = shift;
+ return ( time() + $c->config->{session}{expires} );
+}
+
+sub calculate_extended_session_expires {
+ my ( $c, $prev ) = @_;
+ $c->calculate_initial_session_expires;
+}
+
+sub reset_session_expires {
+ my ( $c, $sid ) = @_;
+ $c->_session_expires( my $exp = $c->calculate_initial_session_expires );
+ $exp;
}
sub sessionid {
- my $c = shift;
-
- if ( @_ ) {
- if ( $c->validate_session_id( my $sid = shift ) ) {
- $c->_sessionid( $sid );
- return unless defined wantarray;
- } else {
- my $err = "Tried to set invalid session ID '$sid'";
- $c->log->error( $err );
- Catalyst::Exception->throw( $err );
- }
- }
+ my $c = shift;
- $c->_load_session if ( $c->_sessionid && !$c->_session ); # must verify session data
+ return $c->_sessionid || $c->_load_sessionid;
+}
+
+sub _load_sessionid {
+ my $c = shift;
+ return if $c->_tried_loading_session_id;
+ $c->_tried_loading_session_id(1);
+
+ if ( defined( my $sid = $c->get_session_id ) ) {
+ if ( $c->validate_session_id($sid) ) {
+ # temporarily set the inner key, so that validation will work
+ $c->_sessionid($sid);
+ return $sid;
+ } else {
+ my $err = "Tried to set invalid session ID '$sid'";
+ $c->log->error($err);
+ Catalyst::Exception->throw($err);
+ }
+ }
- return $c->_sessionid;
+ return;
+}
+
+sub session_is_valid {
+ my $c = shift;
+
+ # force a check for expiry, but also __address, etc
+ if ( $c->_load_session ) {
+ return 1;
+ } else {
+ return;
+ }
}
sub validate_session_id {
- my ( $c, $sid ) = @_;
+ my ( $c, $sid ) = @_;
- $sid =~ /^[a-f\d]+$/i;
+ $sid and $sid =~ /^[a-f\d]+$/i;
}
sub session {
my $c = shift;
$c->_session || $c->_load_session || do {
- my $sid = $c->generate_session_id;
- $c->sessionid($sid);
-
- $c->log->debug(qq/Created session "$sid"/) if $c->debug;
-
+ $c->create_session_id_if_needed;
$c->initialize_session_data;
- };
+ };
+}
+
+sub keep_flash {
+ my ( $c, @keys ) = @_;
+ my $href = $c->_flash_keep_keys || $c->_flash_keep_keys({});
+ (@{$href}{@keys}) = ((undef) x @keys);
}
sub flash {
my $c = shift;
- $c->_flash || $c->_load_flash || $c->_flash( {} );
+ $c->_flash || $c->_load_flash || do {
+ $c->create_session_id_if_needed;
+ $c->_flash( {} );
+ }
}
sub session_expire_key {
my ( $c, %keys ) = @_;
my $now = time;
- @{ $c->session->{__expire_keys} }{keys %keys} = map { $now + $_ } values %keys;
+ @{ $c->session->{__expire_keys} }{ keys %keys } =
+ map { $now + $_ } values %keys;
}
sub initialize_session_data {
my $now = time;
- return $c->_session({
- __created => $now,
- __updated => $now,
- __expires => $now + $c->config->{session}{expires},
-
- (
- $c->config->{session}{verify_address}
- ? ( __address => $c->request->address )
- : ()
- ),
- });
+ return $c->_session(
+ {
+ __created => $now,
+ __updated => $now,
+
+ (
+ $c->config->{session}{verify_address}
+ ? ( __address => $c->request->address )
+ : ()
+ ),
+ }
+ );
}
sub generate_session_id {
return $digest->hexdigest;
}
+sub create_session_id_if_needed {
+ my $c = shift;
+ $c->create_session_id unless $c->sessionid;
+}
+
+sub create_session_id {
+ my $c = shift;
+
+ my $sid = $c->generate_session_id;
+
+ $c->log->debug(qq/Created session "$sid"/) if $c->debug;
+
+ $c->_sessionid($sid);
+ $c->reset_session_expires;
+ $c->set_session_id($sid);
+
+ return $sid;
+}
+
my $counter;
sub session_hash_seed {
sub _find_digest () {
unless ($usable) {
- foreach my $alg (qw/SHA-1 MD5 SHA-256/) {
- eval {
- my $obj = Digest->new($alg);
+ foreach my $alg (qw/SHA-1 SHA-256 MD5/) {
+ if ( eval { Digest->new($alg) } ) {
$usable = $alg;
- return $obj;
- };
+ last;
+ }
}
- $usable
- or Catalyst::Exception->throw(
+ Catalyst::Exception->throw(
"Could not find a suitable Digest module. Please install "
- . "Digest::SHA1, Digest::SHA, or Digest::MD5" );
+ . "Digest::SHA1, Digest::SHA, or Digest::MD5" )
+ unless $usable;
}
return Digest->new($usable);
);
}
+
+sub get_session_id { shift->NEXT::get_session_id(@_) }
+sub set_session_id { shift->NEXT::set_session_id(@_) }
+sub delete_session_id { shift->NEXT::delete_session_id(@_) }
+sub extend_session_id { shift->NEXT::extend_session_id(@_) }
+
__PACKAGE__;
__END__
This method will automatically create a new session and session ID if none
exists.
+=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
-lasts a single redirect, not only a forward.
+lasts for longer than one request, letting you redirect instead of forward.
+
+The flash data will be cleaned up only on requests on which actually use
+$c->flash (thus allowing multiple redirections), and the policy is to delete
+all the keys which haven't changed since the flash data was loaded at the end
+of every request.
sub moose : Local {
my ( $self, $c ) = @_;
}
}
+=item keep_flash @keys
+
+If you wawnt to keep a flash key for the next request too, even if it hasn't
+changed, call C<keep_flash> and pass in the keys as arguments.
+
+=item delete_session REASON
+
+This method is used to invalidate a session. It takes an optional parameter
+which will be saved in C<session_delete_reason> if provided.
+
=item session_delete_reason
This accessor contains a string with the reason a session was deleted. Possible
=back
-=item INTERNAL METHODS
+=head1 INTERNAL METHODS
=over 4
=item prepare_action
-This methoid is extended, and will restore session data and check it for
-validity if a session id is defined. It assumes that the State plugin will
-populate the C<sessionid> key beforehand.
+This methoid is extended.
+
+It's only effect is if the (off by default) C<flash_to_stash> configuration
+parameter is on - then it will copy the contents of the flash to the stash at
+prepare time.
=item finalize
This method is extended and will extend the expiry time, as well as persist the
session data if a session exists.
-=item delete_session REASON
-
-This method is used to invalidate a session. It takes an optional parameter
-which will be saved in C<session_delete_reason> if provided.
-
=item initialize_session_data
This method will initialize the internal structure of the session, and is
called by the C<session> method if appropriate.
+=item create_session_id
+
+Creates a new session id using C<generate_session_id> if there is no session ID
+yet.
+
+=item validate_session_id SID
+
+Make sure a session ID is of the right format.
+
+This currently ensures that the session ID string is any amount of case
+insensitive hexadecimal characters.
+
=item generate_session_id
This method will return a string that can be used as a session ID. It is
Currently it returns a concatenated string which contains:
-=item validate_session_id SID
-
-Make sure a session ID is of the right format.
-
-This currently ensures that the session ID string is any amount of case
-insensitive hexadecimal characters.
-
=over 4
=item *
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.
+=item flash_to_stash
+
+This option makes it easier to have actions behave the same whether they were
+forwarded to or redirected to. On prepare time it copies the contents of
+C<flash> (if any) to the stash.
+
=back
=head1 SPECIAL KEYS
=item __expires
-A timestamp whose value is the last second when the session is still valid. If
-a session is restored, and __expires is less than the current time, the session
-is deleted.
+This key no longer exists. Use C<session_expires> instead.
=item __updated
-The last time a session was saved. This is the value of
-C<< $c->session->{__expires} - $c->config->session->{expires} >>.
+The last time a session was saved to the store.
=item __created
projects / catagits/Catalyst-Plugin-Session.git / blobdiff