blob: 3d189f1838a6edcc634a022af7274384ee51098b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
package Dancer2::Session::YAML;
$Dancer2::Session::YAML::VERSION = '1.0.0';
# ABSTRACT: YAML-file-based session backend for Dancer2
use Moo;
use Dancer2::Core::Types;
use YAML;
has _suffix => (
is => 'ro',
isa => Str,
default => sub {'.yml'},
);
with 'Dancer2::Core::Role::SessionFactory::File';
sub _freeze_to_handle {
my ( $self, $fh, $data ) = @_;
print {$fh} YAML::Dump($data);
return;
}
sub _thaw_from_handle {
my ( $self, $fh ) = @_;
local $YAML::LoadBlessed = 1;
return YAML::LoadFile($fh);
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Session::YAML - YAML-file-based session backend for Dancer2
=head1 VERSION
version 1.0.0
=head1 DESCRIPTION
This module implements a session engine based on YAML files. Session are stored
in a I<session_dir> as YAML files. The idea behind this module was to provide a
human-readable session storage for the developer.
This backend is intended to be used in development environments, when digging
inside a session can be useful.
This backend can perfectly be used in production environments, but two things
should be kept in mind: The content of the session files is in plain text, and
the session files should be purged by a CRON job.
=head1 CONFIGURATION
The setting B<session> should be set to C<YAML> in order to use this session
engine in a Dancer2 application.
Files will be stored to the value of the setting C<session_dir>, whose default
value is C<appdir/sessions>.
Here is an example configuration that use this session engine and stores session
files in /tmp/dancer-sessions
session: "YAML"
engines:
session:
YAML:
session_dir: "/tmp/dancer-sessions"
cookie_duration: 3600 # Default cookie timeout in seconds
=head1 DEPENDENCY
This module depends on L<YAML>.
=head1 SEE ALSO
See L<Dancer2::Core::Session> for details about session usage in route handlers.
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
