use strict;
use warnings;
+use Digest::SHA1 ();
+
use Plack::Util::Accessor qw[
session_key
sid_generator
+ sid_validator
];
sub new {
$params{'_expired'} ||= +{};
$params{'session_key'} ||= 'plack_session';
$params{'sid_generator'} ||= sub {
- require Digest::SHA1;
Digest::SHA1::sha1_hex(rand() . $$ . {} . time)
};
+ $params{'sid_validator'} ||= qr/\A[0-9a-f]{40}\Z/;
bless { %params } => $class;
}
sub check_expired {
my ($self, $id) = @_;
- return unless $id && not $self->is_session_expired( $id );
+ return if $self->is_session_expired( $id );
return $id;
}
+sub validate_session_id {
+ my ($self, $id) = @_;
+ $id =~ $self->sid_validator;
+}
+
sub get_session_id {
my ($self, $request) = @_;
$self->extract( $request )
$self->generate( $request )
}
+sub get_session_id_from_request {
+ my ($self, $request) = @_;
+ $request->param( $self->session_key );
+}
+
sub extract {
my ($self, $request) = @_;
- $self->check_expired( $request->param( $self->session_key ) );
+
+ my $id = $self->get_session_id_from_request( $request );
+ return unless defined $id;
+
+ $self->validate_session_id( $id )
+ &&
+ $self->check_expired( $id );
}
sub generate {
Plack::Session::State - Basic parameter-based session state
+=head1 SYNOPSIS
+
+ use Plack::Builder;
+ use Plack::Middleware::Session;
+ use Plack::Session::State;
+
+ my $app = sub {
+ return [ 200, [ 'Content-Type' => 'text/plain' ], [ 'Hello Foo' ] ];
+ };
+
+ builder {
+ enable 'Session',
+ state => Plack::Session::State->new;
+ $app;
+ };
+
=head1 DESCRIPTION
+This will maintain session state by passing the session through
+the request params. It does not do this automatically though,
+you are responsible for passing the session param.
+
+This should be considered the state "base" class (although
+subclassing is not a requirement) and defines the spec for
+all B<Plack::Session::State::*> modules. You will only
+need to override a couple methods if you do subclass. See
+L<Plack::Session::State::Cookie> for an example of this.
+
=head1 METHODS
=over 4
=item B<new ( %params )>
+The C<%params> can include I<session_key>, I<sid_generator> and I<sid_checker>
+however in both cases a default will be provided for you.
+
=item B<session_key>
+This is the name of the session key, it default to 'plack_session'.
+
=item B<sid_generator>
+This is a CODE ref used to generate unique session ids, by default
+it will generate a SHA1 using fairly sufficient entropy. If you are
+concerned or interested, just read the source.
+
+=item B<sid_validator>
+
+This is a regex used to validate requested session id.
+
=back
+=head2 Session ID Managment
+
=over 4
=item B<get_session_id ( $request )>
+Given a C<$request> this will first attempt to extract the session,
+if the is expired or does not exist, it will then generate a new
+session. The C<$request> is expected to be a L<Plack::Request> instance
+or an object with an equivalent interface.
+
+=item B<get_session_id_from_request ( $request )>
+
+This is the method used to extract the session id from a C<$request>.
+Subclasses will often only need to override this method and the
+C<finalize> method.
+
+=item B<validate_session_id ( $session_id )>
+
+This will use the C<sid_validator> regex and confirm that the
+C<$session_id> is valid.
+
=item B<extract ( $request )>
+This will attempt to extract the session from a C<$request> by looking
+for the C<session_key> in the C<$request> params. It will then check to
+see if the session is valid and that it has not expired. It will return
+the session id if everything is good or undef otherwise. The C<$request>
+is expected to be a L<Plack::Request> instance or an object with an
+equivalent interface.
+
=item B<generate ( $request )>
+This will generate a new session id using the C<sid_generator> callback.
+The C<$request> argument is not used by this method but is there for
+use by subclasses. The C<$request> is expected to be a L<Plack::Request>
+instance or an object with an equivalent interface.
+
=item B<finalize ( $session_id, $response )>
+Given a C<$session_id> and a C<$response> this will perform any
+finalization nessecary to preserve state. This method is called by
+the L<Plack::Session> C<finalize> method. The C<$response> is expected
+to be a L<Plack::Response> instance or an object with an equivalent
+interface.
+
=back
+=head2 Session Expiration Handling
+
=over 4
=item B<expire_session_id ( $id )>
+This will mark the session for C<$id> as expired. This method is called
+by the L<Plack::Session> C<expire> method.
+
+=item B<is_session_expired ( $id )>
+
+This will check to see if the session C<$id> has been marked as
+expired.
+
=item B<check_expired ( $id )>
+Given an session C<$id> this will return C<undef> if the session is
+expired or return the C<$id> if it is not.
+
=back
=head1 BUGS
projects / catagits/Web-Session.git / blobdiff