5 use HTTP::Request::Common;
6 use HTTP::Message::PSGI ();
7 use Encode 2.21 'decode_utf8', 'encode_utf8', 'encode';
11 # Test cases for incoming utf8
14 package MyApp::Controller::Root;
15 $INC{'MyApp/Controller/Root.pm'} = __FILE__;
17 use base 'Catalyst::Controller';
19 sub heart :Path('♥') {
21 $c->response->content_type('text/html');
22 $c->response->body("<p>This is path-heart action ♥</p>");
23 # We let the content length middleware find the length...
28 $c->response->content_type('text/html');
29 $c->response->body("<p>This is path-hat action ^</p>");
32 sub uri_for :Path('uri_for') {
34 $c->response->content_type('text/html');
35 $c->response->body("${\$c->uri_for($c->controller('Root')->action_for('argend'), ['♥'], '♥', {'♥'=>'♥♥'})}");
38 sub heart_with_arg :Path('a♥') Args(1) {
39 my ($self, $c, $arg) = @_;
40 $c->response->content_type('text/html');
41 $c->response->body("<p>This is path-heart-arg action $arg</p>");
42 Test::More::is $c->req->args->[0], '♥';
45 sub base :Chained('/') CaptureArgs(0) { }
46 sub link :Chained('base') PathPart('♥') Args(0) {
48 $c->response->content_type('text/html');
49 $c->response->body("<p>This is base-link action ♥</p>");
51 sub arg :Chained('base') PathPart('♥') Args(1) {
52 my ($self, $c, $arg) = @_;
53 $c->response->content_type('text/html');
54 $c->response->body("<p>This is base-link action ♥ $arg</p>");
56 sub capture :Chained('base') PathPart('♥') CaptureArgs(1) {
57 my ($self, $c, $arg) = @_;
58 $c->stash(capture=>$arg);
60 sub argend :Chained('capture') PathPart('♥') Args(1) {
61 my ($self, $c, $arg) = @_;
62 $c->response->content_type('text/html');
64 Test::More::is $c->req->args->[0], '♥';
65 Test::More::is $c->req->captures->[0], '♥';
66 Test::More::is $arg, '♥';
67 Test::More::is length($arg), 1, "got length of one";
69 $c->response->body("<p>This is base-link action ♥ ${\$c->req->args->[0]}</p>");
71 # Test to make sure redirect can now take an object (sorry don't have a better place for it
72 # but wanted test coverage.
73 my $location = $c->res->redirect( $c->uri_for($c->controller('Root')->action_for('uri_for')) );
74 Test::More::ok !ref $location;
77 sub stream_write :Local {
79 $c->response->content_type('text/html');
80 $c->response->write("<p>This is stream_write action ♥</p>");
83 sub stream_write_fh :Local {
85 $c->response->content_type('text/html');
87 my $writer = $c->res->write_fh;
88 $writer->write_encoded('<p>This is stream_write_fh action ♥</p>');
92 # Stream a file with utf8 chars directly, you don't need to decode
93 sub stream_body_fh :Local {
95 my $path = File::Spec->catfile('t', 'utf8.txt');
96 open(my $fh, '<', $path) || die "trouble: $!";
97 $c->response->content_type('text/html');
98 $c->response->body($fh);
101 # If you pull the file contents into a var, NOW you need to specify the
102 # IO encoding on the FH. Ultimately Plack at the end wants bytes...
103 sub stream_body_fh2 :Local {
105 my $path = File::Spec->catfile('t', 'utf8.txt');
106 open(my $fh, '<:encoding(UTF-8)', $path) || die "trouble: $!";
107 my $contents = do { local $/; <$fh> };
109 $c->response->content_type('text/html');
110 $c->response->body($contents);
113 sub file_upload :POST Consumes(Multipart) Local {
115 Test::More::is $c->req->body_parameters->{'♥'}, '♥♥';
116 Test::More::ok my $upload = $c->req->uploads->{file};
117 Test::More::is $upload->charset, 'UTF-8';
119 my $text = $upload->slurp;
120 Test::More::is Encode::decode_utf8($text), "<p>This is stream_body_fh action ♥</p>\n";
122 my $decoded_text = $upload->decoded_slurp;
123 Test::More::is $decoded_text, "<p>This is stream_body_fh action ♥</p>\n";
125 Test::More::is $upload->filename, '♥ttachment.txt';
126 Test::More::is $upload->raw_basename, '♥ttachment.txt';
128 $c->response->content_type('text/html');
129 $c->response->body($decoded_text);
132 sub json :POST Consumes(JSON) Local {
134 my $post = $c->req->body_data;
136 Test::More::is $post->{'♥'}, '♥♥';
137 Test::More::is length($post->{'♥'}), 2;
138 $c->response->content_type('application/json');
140 # Encode JSON also encodes to a UTF-8 encoded, binary string. This is why we don't
141 # have application/json as one of the things we match, otherwise we get double
143 $c->response->body(JSON::MaybeXS::encode_json($post));
146 ## If someone clears encoding, they can do as they wish
147 sub manual_1 :Local {
150 $c->res->content_type('text/plain');
151 $c->res->content_type_charset('UTF-8');
152 $c->response->body( Encode::encode_utf8("manual_1 ♥"));
155 ## If you do like gzip, well handle that yourself! Basically if you do some sort
156 ## of content encoding like gzip, you must do on top of the encoding. We will fix
157 ## the encoding plugins (Catalyst::Plugin::Compress) to do this properly for you.
160 require Compress::Zlib;
162 $c->res->content_type('text/plain');
163 $c->res->content_type_charset('UTF-8');
164 $c->res->content_encoding('gzip');
165 $c->response->body(Compress::Zlib::memGzip(Encode::encode_utf8("manual_1 ♥")));
168 sub override_encoding :Local {
170 $c->res->content_type('text/plain');
171 $c->encoding(Encode::find_encoding('UTF-8'));
172 $c->encoding(Encode::find_encoding('Shift_JIS'));
173 $c->response->body("テスト");
176 sub stream_write_error :Local {
178 $c->response->content_type('text/html');
179 $c->response->write("<p>This is stream_write action ♥</p>");
180 $c->encoding(Encode::find_encoding('Shift_JIS'));
181 $c->response->write("<p>This is stream_write action ♥</p>");
184 sub from_external_psgi :Local {
186 my $env = HTTP::Message::PSGI::req_to_psgi( HTTP::Request::Common::GET '/root/♥');
187 $c->res->from_psgi_response( ref($c)->to_app->($env));
190 sub echo_arg :Local {
192 $c->response->content_type('text/plain');
193 $c->response->body($c->req->body_parameters->{arg});
199 Test::More::ok(MyApp->setup, 'setup app');
202 ok my $psgi = MyApp->psgi_app, 'build psgi app';
204 use Catalyst::Test 'MyApp';
207 my $res = request "/root/♥";
209 is $res->code, 200, 'OK';
210 is decode_utf8($res->content), '<p>This is path-heart action ♥</p>', 'correct body';
211 is $res->content_length, 36, 'correct length';
212 is $res->content_charset, 'UTF-8';
216 my $res = request "/root/a♥/♥";
218 is $res->code, 200, 'OK';
219 is decode_utf8($res->content), '<p>This is path-heart-arg action ♥</p>', 'correct body';
220 is $res->content_length, 40, 'correct length';
221 is $res->content_charset, 'UTF-8';
225 my $res = request "/root/^";
227 is $res->code, 200, 'OK';
228 is decode_utf8($res->content), '<p>This is path-hat action ^</p>', 'correct body';
229 is $res->content_length, 32, 'correct length';
230 is $res->content_charset, 'UTF-8';
234 my $res = request "/base/♥";
236 is $res->code, 200, 'OK';
237 is decode_utf8($res->content), '<p>This is base-link action ♥</p>', 'correct body';
238 is $res->content_length, 35, 'correct length';
239 is $res->content_charset, 'UTF-8';
243 my ($res, $c) = ctx_request POST "/base/♥?♥=♥&♥=♥♥", [a=>1, b=>'', '♥'=>'♥', '♥'=>'♥♥'];
245 is $res->code, 200, 'OK';
246 is decode_utf8($res->content), '<p>This is base-link action ♥</p>', 'correct body';
247 is $res->content_length, 35, 'correct length';
248 is $c->req->parameters->{'♥'}[0], '♥';
249 is $c->req->query_parameters->{'♥'}[0], '♥';
250 is $c->req->body_parameters->{'♥'}[0], '♥';
251 is $c->req->parameters->{'♥'}[0], '♥';
252 is $c->req->parameters->{a}, 1;
253 is $c->req->body_parameters->{a}, 1;
254 is $res->content_charset, 'UTF-8';
258 my ($res, $c) = ctx_request GET "/base/♥?♥♥♥";
260 is $res->code, 200, 'OK';
261 is decode_utf8($res->content), '<p>This is base-link action ♥</p>', 'correct body';
262 is $res->content_length, 35, 'correct length';
263 is $c->req->query_keywords, '♥♥♥';
264 is $res->content_charset, 'UTF-8';
268 my $res = request "/base/♥/♥";
270 is $res->code, 200, 'OK';
271 is decode_utf8($res->content), '<p>This is base-link action ♥ ♥</p>', 'correct body';
272 is $res->content_length, 39, 'correct length';
273 is $res->content_charset, 'UTF-8';
277 my $res = request "/base/♥/♥/♥/♥";
279 is decode_utf8($res->content), '<p>This is base-link action ♥ ♥</p>', 'correct body';
280 is $res->content_length, 39, 'correct length';
281 is $res->content_charset, 'UTF-8';
285 my ($res, $c) = ctx_request POST "/base/♥/♥/♥/♥?♥=♥♥", [a=>1, b=>'2', '♥'=>'♥♥'];
287 ## Make sure that the urls we generate work the same
288 my $uri_for1 = $c->uri_for($c->controller('Root')->action_for('argend'), ['♥'], '♥', {'♥'=>'♥♥'});
289 my $uri_for2 = $c->uri_for($c->controller('Root')->action_for('argend'), ['♥', '♥'], {'♥'=>'♥♥'});
290 my $uri = $c->req->uri;
292 is "$uri_for1", "$uri_for2";
293 is "$uri", "$uri_for1";
296 my ($res, $c) = ctx_request POST "$uri_for1", [a=>1, b=>'2', '♥'=>'♥♥'];
297 is $c->req->query_parameters->{'♥'}, '♥♥';
298 is $c->req->body_parameters->{'♥'}, '♥♥';
299 is $c->req->parameters->{'♥'}[0], '♥♥'; #combined with query and body
300 is $c->req->args->[0], '♥';
301 is length($c->req->parameters->{'♥'}[0]), 2;
302 is length($c->req->query_parameters->{'♥'}), 2;
303 is length($c->req->body_parameters->{'♥'}), 2;
304 is length($c->req->args->[0]), 1;
305 is $res->content_charset, 'UTF-8';
310 my ($res, $c) = ctx_request "/root/uri_for";
311 my $url = $c->uri_for($c->controller('Root')->action_for('argend'), ['♥'], '♥', {'♥'=>'♥♥'});
313 is $res->code, 200, 'OK';
314 is decode_utf8($res->content), "$url", 'correct body'; #should do nothing
315 is $res->content, "$url", 'correct body';
316 is $res->content_length, 90, 'correct length';
317 is $res->content_charset, 'UTF-8';
320 my $url = $c->uri_for($c->controller->action_for('heart_with_arg'), '♥');
321 is "$url", 'http://localhost/root/a%E2%99%A5/%E2%99%A5', "correct $url";
325 my $url = $c->uri_for($c->controller->action_for('heart_with_arg'), ['♥']);
326 is "$url", 'http://localhost/root/a%E2%99%A5/%E2%99%A5', "correct $url";
331 my $res = request "/root/stream_write";
333 is $res->code, 200, 'OK GET /root/stream_write';
334 is decode_utf8($res->content), '<p>This is stream_write action ♥</p>', 'correct body';
335 is $res->content_charset, 'UTF-8';
339 my $res = request "/root/stream_body_fh";
341 is $res->code, 200, 'OK';
342 is decode_utf8($res->content), "<p>This is stream_body_fh action ♥</p>\n", 'correct body';
343 is $res->content_charset, 'UTF-8';
344 # Not sure why there is a trailing newline above... its not in catalyst code I can see. Not sure
345 # if is a problem or just an artifact of the why the test stuff works - JNAP
349 my $res = request "/root/stream_write_fh";
351 is $res->code, 200, 'OK';
352 is decode_utf8($res->content), '<p>This is stream_write_fh action ♥</p>', 'correct body';
353 #is $res->content_length, 41, 'correct length';
354 is $res->content_charset, 'UTF-8';
358 my $res = request "/root/stream_body_fh2";
360 is $res->code, 200, 'OK';
361 is decode_utf8($res->content), "<p>This is stream_body_fh action ♥</p>\n", 'correct body';
362 is $res->content_length, 41, 'correct length';
363 is $res->content_charset, 'UTF-8';
367 ok my $path = File::Spec->catfile('t', 'utf8.txt');
368 ok my $req = POST '/root/file_upload',
369 Content_Type => 'form-data',
370 Content => [encode_utf8('♥')=>encode_utf8('♥♥'), file=>["$path", encode_utf8('♥ttachment.txt'), 'Content-Type' =>'text/html; charset=UTF-8', ]];
372 ok my $res = request $req;
373 is decode_utf8($res->content), "<p>This is stream_body_fh action ♥</p>\n";
377 ok my $req = POST '/root/json',
378 Content_Type => 'application/json',
379 Content => encode_json +{'♥'=>'♥♥'}; # Note: JSON does the UTF* encoding for us
381 ok my $res = request $req;
383 ## decode_json expect the binary utf8 string and does the decoded bit for us.
384 is_deeply decode_json(($res->content)), +{'♥'=>'♥♥'};
388 ok my $res = request "/root/override_encoding";
389 ok my $enc = Encode::find_encoding('SHIFT_JIS');
391 is $res->code, 200, 'OK';
392 is $enc->decode($res->content), "テスト", 'correct body';
393 is $res->content_length, 6, 'correct length'; # Bytes over the wire
394 is length($enc->decode($res->content)), 3;
395 is $res->content_charset, 'SHIFT_JIS';
399 my $res = request "/root/manual_1";
401 is $res->code, 200, 'OK';
402 is decode_utf8($res->content), "manual_1 ♥", 'correct body';
403 is $res->content_length, 12, 'correct length';
404 is $res->content_charset, 'UTF-8';
408 eval { require Compress::Zlib; 1} || do {
409 skip "Compress::Zlib needed to test gzip encoding", 5 };
411 my $res = request "/root/gzipped";
412 ok my $raw_content = $res->content;
413 ok my $content = Compress::Zlib::memGunzip($raw_content), 'no gunzip error';
415 is $res->code, 200, 'OK';
416 is decode_utf8($content), "manual_1 ♥", 'correct body';
417 is $res->content_charset, 'UTF-8';
421 my $res = request "/root/stream_write_error";
423 is $res->code, 200, 'OK';
424 like decode_utf8($res->content), qr[<p>This is stream_write action ♥</p><!DOCTYPE html], 'correct body';
428 my $res = request "/root/from_external_psgi";
430 is $res->code, 200, 'OK';
431 is decode_utf8($res->content), '<p>This is path-heart action ♥</p>', 'correct body';
432 is $res->content_length, 36, 'correct length';
433 is $res->content_charset, 'UTF-8';
438 my $shiftjs = 'test テスト';
440 ok my $req = POST '/root/echo_arg',
441 Content_Type => 'form-data',
443 arg0 => 'helloworld',
446 'Content-Type' =>'text/plain; charset=UTF-8',
447 'Content' => Encode::encode('UTF-8', $utf8)],
450 'Content-Type' =>'text/plain; charset=SHIFT_JIS',
451 'Content' => Encode::encode('SHIFT_JIS', $shiftjs)],
454 'Content-Type' =>'text/plain; charset=SHIFT_JIS',
455 'Content' => Encode::encode('SHIFT_JIS', $shiftjs)],
458 my ($res, $c) = ctx_request $req;
460 is $c->req->body_parameters->{'arg0'}, 'helloworld';
461 is Encode::decode('UTF-8', $c->req->body_parameters->{'arg1'}), $utf8;
462 is Encode::decode('SHIFT_JIS', $c->req->body_parameters->{'arg2'}[0]), $shiftjs;
466 ## should we use binmode on filehandles to force the encoding...?
467 ## Not sure what else to do with multipart here, if docs are enough...