1 package Plack::Middleware::Session;
6 our $AUTHORITY = 'cpan:STEVAN';
14 use parent 'Plack::Middleware';
16 use Plack::Util::Accessor qw(
25 $self->session_class( 'Plack::Session' ) unless $self->session_class;
26 $self->state( 'Cookie' ) unless $self->state;
28 $self->state( $self->inflate_backend('Plack::Session::State', $self->state) );
29 $self->store( $self->inflate_backend('Plack::Session::Store', $self->store) );
33 my($self, $prefix, $backend) = @_;
35 return $backend if defined $backend && Scalar::Util::blessed $backend;
38 push @class, $backend if defined $backend; # undef means the root class
41 Plack::Util::load_class(@class)->new();
48 $env->{'plack.session'} = $self->session_class->new(
49 state => $self->state,
50 store => $self->store,
51 request => Plack::Request->new( $env )
54 my $res = $self->app->($env);
55 $self->response_cb($res, sub {
56 my $res = Plack::Response->new(@{$_[0]});
57 $env->{'plack.session'}->finalize( $res );
58 @{$_[0]} = @{$res->finalize};
70 Plack::Middleware::Session - Middleware for session management
77 return [ 200, [ 'Content-Type' => 'text/plain' ], [ 'Hello Foo' ] ];
85 # Or, use the File store backend (great if you use multiprocess server)
86 # For more options, see perldoc Plack::Session::Store::File
88 enable 'Session', store => 'File';
94 This is a Plack Middleware component for session management. By
95 default it will use cookies to keep session state and store data in
96 memory. This distribution also comes with other state and store
97 solutions. See perldoc for these backends how to use them.
103 =item L<Plack::Session::State>
105 This will maintain session state by passing the session through
106 the request params. It does not do this automatically though,
107 you are responsible for passing the session param.
109 =item L<Plack::Session::State::Cookie>
111 This will maintain session state using browser cookies.
119 =item L<Plack::Session::Store>
121 This is your basic in-memory session data store. It is volatile storage
122 and not recommended for multiprocessing environments. However it is
123 very useful for development and testing.
125 =item L<Plack::Session::Store::File>
127 This will persist session data in a file. By default it uses
128 L<Storable> but it can be configured to have a custom serializer and
131 =item L<Plack::Session::Store::Cache>
133 This will persist session data using the L<Cache> interface.
135 =item L<Plack::Session::Store::Null>
137 Sometimes you don't care about storing session data, in that case
138 you can use this noop module.
144 The following are options that can be passed to this mdoule.
150 This is expected to be an instance of L<Plack::Session::State> or an
151 object that implements the same interface. If no option is provided
152 the default L<Plack::Session::State::Cookie> will be used.
156 This is expected to be an instance of L<Plack::Session::Store> or an
157 object that implements the same interface. If no option is provided
158 the default L<Plack::Session::Store> will be used.
160 It should be noted that this default is an in-memory volatile store
161 is only suitable for development (or single process servers). For a
162 more robust solution see L<Plack::Session::Store::File> or
163 L<Plack::Session::Store::Cache>.
165 =item I<session_class>
167 This can be used to override the actual session class. It currently
168 defaults to L<Plack::Session> but you can substitute any class which
169 implements the same interface.
175 All complex software has bugs lurking in it, and this module is no
176 exception. If you find a bug please either email me, or add the bug
183 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
185 =head1 COPYRIGHT AND LICENSE
187 Copyright 2009 Infinity Interactive, Inc.
189 L<http://www.iinteractive.com>
191 This library is free software; you can redistribute it and/or modify
192 it under the same terms as Perl itself.