NAME
Catalyst::Plugin::Session::Store::CHI - Use CHI module to handle storage
backend for session data.
VERSION
Version 0.02
SYNOPSIS
use Catalyst qw/Session Session::Store::CHI::File Session::State::Foo/;
MyApp->config->{'Plugin::Session'} = {
storage => '/tmp/session'
};
# ... in an action:
$c->session->{foo} = 'bar'; # will be saved
DESCRIPTION
`Catalyst::Plugin::Session::Store::CHI' is an easy to use storage plugin
for Catalyst that uses a file or mmap'ed file to act as a shared memory
interprocess cache. It is based on `CHI'. At this point only file
functionality is available via
`Catalyst::Plugin::Session::Store::CHI::File'. This module is
expiremental.
METHODS
get_session_data
store_session_data
delete_session_data
delete_expired_sessions
These are implementations of the required methods for a store. See
Catalyst::Plugin::Session::Store.
setup_session
Sets up the session cache file.
CONFIGURATION
These parameters are placed in the hash under the `Plugin::Session' key
in the configuration hash.
storage
Specifies the directory root to be used for the sharing of session
data. The default value will use File::Spec to find the default
tempdir, and use a file named `MyApp/session/data', where `MyApp' is
replaced with the appname.
Note that the file will be created with mode 0640, which means that
it will only be writeable by processes running with the same uid as
the process that creates the file. If this may be a problem, for
example if you may try to debug the program as one user and run it
as another, specify a directory like `/tmp/session-$>', which
includes the UID of the process in the filename.
relative
Makes the storage path relative to *$c-*path_to>
namespace
The namespace associated with this cache. Defaults to an empty
string if not explicitly set. If set, the session data will be
stored in a directory called `MyApp/session/data/<namespace'>.
cache_depth
The number of subdirectories deep to session object item. This
should be large enough that no session directory has more than a few
hundred objects. Defaults to 3 unless explicitly set.
directory_umask
The directories in the session on the filesystem should be globally
writable to allow for multiple users. While this is a potential
security concern, the actual cache entries are written with the
user's umask, thus reducing the risk of cache poisoning. If you
desire it to only be user writable, set the 'directory_umask' option
to '077' or similar. Defaults to '000' unless explicitly set.
SEE ALSO
Catalyst, Catalyst::Plugin::Session, CHI.
AUTHOR
Know Zero,
BUGS
Please report any bugs or feature requests to
`bug-catalyst-plugin-session-store-chi at rt.cpan.org', or through the
web interface at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Plugin-Session-S
tore-CHI. I will be notified, and then you'll automatically be notified
of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Catalyst::Plugin::Session::Store::CHI
You can also look for information at:
* RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Plugin-Session-Sto
re-CHI
* AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Catalyst-Plugin-Session-Store-CHI
* CPAN Ratings
http://cpanratings.perl.org/d/Catalyst-Plugin-Session-Store-CHI
* Search CPAN
http://search.cpan.org/dist/Catalyst-Plugin-Session-Store-CHI/
ACKNOWLEDGEMENTS
LICENSE AND COPYRIGHT
Copyright 2014 Know Zero.
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a copy
of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.