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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
use strict;
use warnings;
package Catalyst::Middleware::Stash;
use base 'Plack::Middleware';
use Exporter 'import';
use Carp 'croak';
our @EXPORT_OK = qw(stash get_stash);
sub PSGI_KEY { 'Catalyst.Stash.v1' };
sub get_stash {
my $env = shift;
return $env->{&PSGI_KEY} ||
_init_stash_in($env);
}
sub stash {
my ($host, @args) = @_;
return get_stash($host->env)
->(@args);
}
sub _create_stash {
my $stash = shift || +{};
return sub {
if(@_) {
my $new_stash = @_ > 1 ? {@_} : $_[0];
croak('stash takes a hash or hashref')
unless ref $new_stash;
foreach my $key (keys %$new_stash) {
$stash->{$key} = $new_stash->{$key};
}
}
$stash;
};
}
sub _init_stash_in {
my ($env) = @_;
return $env->{&PSGI_KEY} ||=
_create_stash;
}
sub call {
my ($self, $env) = @_;
_init_stash_in($env);
return $self->app->($env);
}
=head1 NAME
Catalyst::Middleware::Stash - The Catalyst stash - in middleware
=head1 DESCRIPTION
We've moved the L<Catalyst> stash to middleware. Please don't use this
directly since it is likely to move off the Catalyst namespace into a stand
alone distribution
We store a coderef under the C<PSGI_KEY> which can be dereferenced with
key values or nothing to access the underly hashref.
=head1 SUBROUTINES
This class defines the following subroutines.
=head2 PSGI_KEY
Returns the hash key where we store the stash. You should not assume
the string value here will never change! Also, its better to use
L</get_stash> or L</stash>.
=head2 get_stash
Expect: $psgi_env.
Exportable subroutine.
Get the stash out of the C<$env>.
=head2 stash
Expects: An object that does C<env> and arguments
Exportable subroutine.
Given an object with a method C<env> get or set stash values, either
as a method or via hashref modification. This stash is automatically
reset for each request (it is not persistent or shared across connected
clients. Stash key / value are stored in memory.
use Plack::Request;
use Catalyst::Middleware::Stash 'stash';
my $app = sub {
my $env = shift;
my $req = Plack::Request->new($env);
my $stashed = $req->stash->{in_the_stash}; # Assume the stash was previously populated.
return [200, ['Content-Type' => 'text/plain'],
["I found $stashed in the stash!"]];
};
If the stash does not yet exist, we initialize one and return that.
=head1 METHODS
This class defines the following methods.
=head2 call
Used by plack to call the middleware
=cut
1;
|
