our $VERSION = "0.02";
BEGIN {
- __PACKAGE__->mk_accessors(qw/_sessionid _session session_delete_reason/);
+ __PACKAGE__->mk_accessors(qw/_sessionid _session _session_delete_reason _flash _flash_stale_keys/);
}
sub setup {
$c->NEXT::setup_session();
}
-sub finalize {
+sub prepare_action {
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 );
- delete @{ $session_data->{__flash} }{ @{ delete $session_data->{__flash_stale_keys} || [] } };
- $c->store_session_data( $c->sessionid, $session_data );
+ 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;
+ $c->_save_flash;
+
$c->NEXT::finalize(@_);
}
-sub prepare_action {
+sub _save_session {
my $c = shift;
+
+ if ( my $sid = $c->_sessionid ) {
+ if ( my $session_data = $c->_session ) {
- $c->_load_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 );
- $c->NEXT::prepare_action(@_);
+ $c->store_session_data( "session:$sid", $session_data );
+ }
+ }
+}
+
+sub _save_flash {
+ my $c = shift;
+
+ if ( my $sid = $c->_sessionid ) {
+ if ( my $flash_data = $c->_flash ) {
+ if ( %$flash_data ) { # damn 'my' declarations
+ delete @{ $flash_data }{ @{ $c->_flash_stale_keys || [] } };
+ $c->store_session_data( "flash:$sid", $flash_data );
+ }
+ } else {
+ $c->delete_session_data( "flash:$sid" );
+ }
+ }
}
sub _load_session {
my $c = shift;
- if ( my $sid = $c->sessionid ) {
+ if ( my $sid = $c->_sessionid ) {
no warnings 'uninitialized'; # ne __address
- my $session_data = $c->_session || $c->_session( $c->get_session_data($sid) );
+ my $session_data = $c->_session || $c->_session( $c->get_session_data( "session:$sid" ) );
if ( !$session_data or $session_data->{__expires} < time ) {
# session expired
}
$c->_expire_ession_keys;
- $session_data->{__flash_stale_keys} = [ keys %{ $session_data->{__flash} } ]
+ return $session_data;
+ }
+
+ return undef;
+}
+
+sub _load_flash {
+ my $c = shift;
+
+ 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 ]);
+ return $flash_data;
+ }
}
+
+ return undef;
}
sub _expire_ession_keys {
my ( $c, $msg ) = @_;
# delete the session data
- my $sid = $c->sessionid;
- $c->delete_session_data($sid);
+ my $sid = $c->_sessionid || return;
+ $c->delete_session_data( "session:$sid" );
# reset the values in the context object
$c->_session(undef);
$c->_sessionid(undef);
- $c->session_delete_reason($msg);
+ $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_delete_reason( @_ );
}
sub sessionid {
my $c = shift;
-
+
if ( @_ ) {
if ( $c->validate_session_id( my $sid = shift ) ) {
- return $c->_sessionid( $sid );
+ $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 );
}
}
+
+ $c->_load_session if ( $c->_sessionid && !$c->_session ); # must verify session data
return $c->_sessionid;
}
sub validate_session_id {
my ( $c, $sid ) = @_;
- $sid =~ /^[a-f\d]+$/i;
+ $sid and $sid =~ /^[a-f\d]+$/i;
}
sub session {
my $c = shift;
- $c->_session || do {
- my $sid = $c->generate_session_id;
- $c->sessionid($sid);
-
- $c->log->debug(qq/Created session "$sid"/) if $c->debug;
+ $c->_session || $c->_load_session || do {
+ $c->create_session_id;
- $c->initialize_session_data;
+ $c->initialize_session_data;
};
}
sub flash {
my $c = shift;
- return $c->session->{__flash} ||= {};
+ $c->_flash || $c->_load_flash || do {
+ $c->create_session_id;
+ $c->_flash( {} );
+ }
}
sub session_expire_key {
return $digest->hexdigest;
}
+sub create_session_id {
+ my $c = shift;
+
+ if ( !$c->_sessionid ) {
+ my $sid = $c->generate_session_id;
+
+ $c->log->debug(qq/Created session "$sid"/) if $c->debug;
+
+ $c->sessionid($sid);
+ }
+}
+
my $counter;
sub session_hash_seed {
unless ($usable) {
foreach my $alg (qw/SHA-1 MD5 SHA-256/) {
eval {
- my $obj = Digest->new($alg);
- $usable = $alg;
- return $obj;
+ Digest->new($alg);
};
+ unless ($@) {
+ $usable = $alg;
+ last;
+ }
}
$usable
or Catalyst::Exception->throw(
This method will automatically create a new session and session ID if none
exists.
+=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.
+
+ sub moose : Local {
+ my ( $self, $c ) = @_;
+
+ $c->flash->{beans} = 10;
+ $c->response->redirect( $c->uri_for("foo") );
+ }
+
+ sub foo : Local {
+ my ( $self, $c ) = @_;
+
+ my $value = $c->flash->{beans};
+
+ # ...
+
+ $c->response->redirect( $c->uri_for("bar") );
+ }
+
+ sub bar : Local {
+ my ( $self, $c ) = @_;
+
+ if ( exists $c->flash->{beans} ) { # false
+
+ }
+ }
+
=item session_delete_reason
This accessor contains a string with the reason a session was deleted. Possible
=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 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 generate_session_id
This method will return a string that can be used as a session ID. 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.
+=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
=head1 CAVEATS
+=head2 Round the Robin Proxies
+
C<verify_address> could make your site inaccessible to users who are behind
load balanced proxies. Some ISPs may give a different IP to each request by the
same client due to this type of proxying. If addresses are verified these
this box is checked it should delete the C<__address> sepcial key from the
session hash when the hash is first created.
+=head2 Race Conditions
+
+In this day and age where cleaning detergents and dutch football (not the
+american kind) teams roam the plains in great numbers, requests may happen
+simultaneously. This means that there is some risk of session data being
+overwritten, like this:
+
+=over 4
+
+=item 1.
+
+request a starts, request b starts, with the same session id
+
+=item 2.
+
+session data is loaded in request a
+
+=item 3.
+
+session data is loaded in request b
+
+=item 4.
+
+session data is changed in request a
+
+=item 5.
+
+request a finishes, session data is updated and written to store
+
+=item 6.
+
+request b finishes, session data is updated and written to store, overwriting
+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.
+
=head1 AUTHORS
=over 4
projects / catagits/Catalyst-Plugin-Session.git / blobdiff