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
120
121
122
123
124
125
126
127
128
|
[](https://travis-ci.org/moznion/Plack-Request-WithEncoding) [](https://coveralls.io/r/moznion/Plack-Request-WithEncoding?branch=master)
# NAME
Plack::Request::WithEncoding - Subclass of [Plack::Request](http://search.cpan.org/perldoc?Plack::Request) which supports encoding.
# SYNOPSIS
use Plack::Request::WithEncoding;
my $app_or_middleware = sub {
my $env = shift; # PSGI env
# Example of $env
#
# $env = {
# QUERY_STRING => 'query=%82%d9%82%b0', # <= encoded by 'cp932'
# REQUEST_METHOD => 'GET',
# HTTP_HOST => 'example.com',
# PATH_INFO => '/foo/bar',
# };
my $req = Plack::Request::WithEncoding->new($env);
$req->env->{'plack.request.withencoding.encoding'} = 'cp932'; # <= specify the encoding method.
my $query = $req->param('query'); # <= get parameters of 'query' that is decoded by 'cp932'.
my $res = $req->new_response(200); # new Plack::Response
$res->finalize;
};
# DESCRIPTION
Plack::Request::WithEncoding is the subclass of [Plack::Request](http://search.cpan.org/perldoc?Plack::Request).
This module supports the encoding for requests, the following attributes will return decoded request values.
Please refer also ["SPECIFICATION OF THE ENCODING METHOD"](#SPECIFICATION OF THE ENCODING METHOD).
# ATTRIBUTES
- encoding
Returns a encoding method to use to decode parameters.
- query\_parameters
Returns a reference to a hash containing __decoded__ query string (GET)
parameters. This hash reference is [Hash::MultiValue](http://search.cpan.org/perldoc?Hash::MultiValue) object.
- body\_parameters
Returns a reference to a hash containing __decoded__ posted parameters in the
request body (POST). As with `query_parameters`, the hash
reference is a [Hash::MultiValue](http://search.cpan.org/perldoc?Hash::MultiValue) object.
- parameters
Returns a [Hash::MultiValue](http://search.cpan.org/perldoc?Hash::MultiValue) hash reference containing __decoded__ (and merged) GET
and POST parameters.
- param
Returns __decoded__ GET and POST parameters with a CGI.pm-compatible param
method. This is an alternative method for accessing parameters in
`$req->parameters`. Unlike CGI.pm, it does _not_ allow
setting or modifying query parameters.
$value = $req->param( 'foo' );
@values = $req->param( 'foo' );
@params = $req->param;
- raw\_query\_parameters
This attribute is the same as `query_parameters` of [Plack::Request](http://search.cpan.org/perldoc?Plack::Request).
- raw\_body\_parameters
This attribute is the same as `body_parameters` of [Plack::Request](http://search.cpan.org/perldoc?Plack::Request).
- raw\_parameters
This attribute is the same as `parameters` of [Plack::Request](http://search.cpan.org/perldoc?Plack::Request).
- raw\_param
This attribute is the same as `param` of [Plack::Request](http://search.cpan.org/perldoc?Plack::Request).
# SPECIFICATION OF THE ENCODING METHOD
You can specify the encoding method, like so;
$req->env->{'plack.request.withencoding.encoding'} = 'utf-7'; # <= set utf-7
And this encoding method will be used to decode.
When not once substituted for `$req->env->{'plack.request.withencoding.encoding'}`, this module will use "utf-8" as encoding method.
However the behavior of a program will become unclear if this function is used. Therefore __YOU SHOULD NOT USE THIS__.
You should specify the encoding method explicitly.
In case of false value (e.g. \`undef\`, 0, '') is explicitly substituted for `$req->env->{'plack.request.withencoding.encoding'}`,
then this module will return __raw value__ (with no encoding).
The example of a code is shown below.
print exists $req->env->{'plack.request.withencoding.encoding'} ? 'EXISTS'
: 'NOT EXISTS'; # <= NOT EXISTS
$query = $req->param('query'); # <= get parameters of 'query' that is decoded by 'utf-8' (*** YOU SHOULD NOT USE LIKE THIS ***)
$req->env->{'plack.request.withencoding.encoding'} = undef; # <= explicitly specify the `undef`
$query = $req->param('query'); # <= get parameters of 'query' that is not decoded (raw value)
$req->env->{'plack.request.withencoding.encoding'} = 'cp932'; # <= specify the 'cp932' as encoding method
$query = $req->param('query'); # <= get parameters of 'query' that is decoded by 'cp932'
# SEE ALSO
[Plack::Request](http://search.cpan.org/perldoc?Plack::Request)
# LICENSE
Copyright (C) moznion.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
# AUTHOR
moznion <moznion@gmail.com>
|
