forked from tokuhirom/Furl
-
Notifications
You must be signed in to change notification settings - Fork 1
/
HTTP.pm
1180 lines (970 loc) · 36.4 KB
/
HTTP.pm
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Furl::HTTP;
use strict;
use warnings;
use base qw/Exporter/;
use 5.008001;
use Carp ();
use Furl;
use Furl::ConnectionCache;
use Scalar::Util ();
use Errno qw(EAGAIN ECONNRESET EINPROGRESS EINTR EWOULDBLOCK);
use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK SEEK_SET SEEK_END);
use Socket qw(
PF_INET SOCK_STREAM
IPPROTO_TCP
TCP_NODELAY
pack_sockaddr_in
);
use Time::HiRes qw(time);
use constant WIN32 => $^O eq 'MSWin32';
use HTTP::Parser::XS qw/HEADERS_NONE HEADERS_AS_ARRAYREF HEADERS_AS_HASHREF/;
our @EXPORT_OK = qw/HEADERS_NONE HEADERS_AS_ARRAYREF HEADERS_AS_HASHREF/;
# ref. RFC 2616, 3.5 Content Codings:
# For compatibility with previous implementations of HTTP,
# applications SHOULD consider "x-gzip" and "x-compress" to be
# equivalent to "gzip" and "compress" respectively.
# ("compress" is not supported, though)
my %COMPRESSED = map { $_ => undef } qw(gzip x-gzip deflate);
my $HTTP_TOKEN = '[^\x00-\x31\x7F]+';
my $HTTP_QUOTED_STRING = q{"([^"]+|\\.)*"};
sub new {
my $class = shift;
my %args = @_ == 1 ? %{$_[0]} : @_;
my @headers = (
'User-Agent' => (delete($args{agent}) || __PACKAGE__ . '/' . $Furl::VERSION),
);
my $connection_header = 'keep-alive';
if(defined $args{headers}) {
my $in_headers = delete $args{headers};
for (my $i = 0; $i < @$in_headers; $i += 2) {
my $name = $in_headers->[$i];
if (lc($name) eq 'connection') {
$connection_header = $in_headers->[$i + 1];
} else {
push @headers, $name, $in_headers->[$i + 1];
}
}
}
bless {
timeout => 10,
max_redirects => 7,
bufsize => 10*1024, # no mmap
headers => \@headers,
connection_header => $connection_header,
proxy => '',
no_proxy => '',
connection_pool => Furl::ConnectionCache->new(),
header_format => HEADERS_AS_ARRAYREF,
stop_if => sub {},
inet_aton => sub { Socket::inet_aton($_[0]) },
%args
}, $class;
}
sub get {
my ( $self, $url, $headers ) = @_;
$self->request(
method => 'GET',
url => $url,
headers => $headers
);
}
sub head {
my ( $self, $url, $headers ) = @_;
$self->request(
method => 'HEAD',
url => $url,
headers => $headers
);
}
sub post {
my ( $self, $url, $headers, $content ) = @_;
$self->request(
method => 'POST',
url => $url,
headers => $headers,
content => $content
);
}
sub put {
my ( $self, $url, $headers, $content ) = @_;
$self->request(
method => 'PUT',
url => $url,
headers => $headers,
content => $content
);
}
sub delete {
my ( $self, $url, $headers ) = @_;
$self->request(
method => 'DELETE',
url => $url,
headers => $headers
);
}
sub _header_get {
my ($headers, $key) = (shift, lc shift);
for (my $i=0; $i<@$headers; $i+=2) {
return $headers->[$i+1] if lc($headers->[$i]) eq $key;
}
return undef;
}
sub _requires {
my($file, $feature, $library) = @_;
return if exists $INC{$file};
unless(eval { require $file }) {
if ($@ =~ /^Can't locate/) {
$library ||= do {
local $_ = $file;
s/ \.pm \z//xms;
s{/}{::}g;
$_;
};
Carp::croak(
"$feature requires $library, but it is not available."
. " Please install $library using your prefer CPAN client"
);
} else {
die $@;
}
}
}
# returns $scheme, $host, $port, $path_query
sub _parse_url {
my($self, $url) = @_;
$url =~ m{\A
([a-z]+) # scheme
://
([^/:]+) # host
(?: : (\d+) )? # port
(?: (/ .*) )? # path_query
\z}xms or Carp::croak("Passed malformed URL: $url");
return( $1, $2, $3, $4 );
}
sub make_x_www_form_urlencoded {
my($self, $content) = @_;
my @params;
my @p = ref($content) eq 'HASH' ? %{$content}
: ref($content) eq 'ARRAY' ? @{$content}
: Carp::croak("Cannot coerce $content to x-www-form-urlencoded");
while ( my ( $k, $v ) = splice @p, 0, 2 ) {
foreach my $s($k, $v) {
utf8::downgrade($s); # will die in wide characters
# escape unsafe chars (defined by RFC 3986)
$s =~ s/ ([^A-Za-z0-9\-\._~]) / sprintf '%%%02X', ord $1 /xmsge;
}
push @params, "$k=$v";
}
return join( "&", @params );
}
sub env_proxy {
my $self = shift;
$self->{proxy} = $ENV{HTTP_PROXY} || '';
$self->{no_proxy} = $ENV{NO_PROXY} || '';
$self;
}
sub request {
my $self = shift;
my %args = @_;
my $timeout_at = time + $self->{timeout};
my ($scheme, $host, $port, $path_query);
if (defined(my $url = $args{url})) {
($scheme, $host, $port, $path_query) = $self->_parse_url($url);
}
else {
($scheme, $host, $port, $path_query) = @args{qw/scheme host port path_query/};
if (not defined $host) {
Carp::croak("Missing host name in arguments");
}
}
if (not defined $scheme) {
$scheme = 'http';
} elsif($scheme ne 'http' && $scheme ne 'https') {
Carp::croak("Unsupported scheme: $scheme");
}
if(not defined $port) {
if ($scheme eq 'http') {
$port = 80;
} else {
$port = 443;
}
}
if(not defined $path_query) {
$path_query = '/';
}
if ($host =~ /[^A-Za-z0-9.-]/) {
_requires('Net/IDN/Encode.pm',
'Internationalized Domain Name (IDN)');
$host = Net::IDN::Encode::domain_to_ascii($host);
}
my $proxy = $self->{proxy};
my $no_proxy = $self->{no_proxy};
if ($proxy && $no_proxy) {
if ($self->match_no_proxy($no_proxy, $host)) {
undef $proxy;
}
}
local $SIG{PIPE} = 'IGNORE';
my $sock = $self->{connection_pool}->steal($host, $port);
my $in_keepalive = defined $sock;
if(!$in_keepalive) {
my $err_reason;
if ($proxy) {
my (undef, $proxy_host, $proxy_port, undef)
= $self->_parse_url($proxy);
if ($scheme eq 'http') {
($sock, $err_reason)
= $self->connect($proxy_host, $proxy_port, $timeout_at);
} else {
($sock, $err_reason) = $self->connect_ssl_over_proxy(
$proxy_host, $proxy_port, $host, $port, $timeout_at);
}
} else {
if ($scheme eq 'http') {
($sock, $err_reason)
= $self->connect($host, $port, $timeout_at);
} else {
($sock, $err_reason)
= $self->connect_ssl($host, $port, $timeout_at);
}
}
return $self->_r500($err_reason)
unless $sock;
}
# write request
my $method = $args{method} || 'GET';
my $connection_header = $self->{connection_header};
{
if($proxy) {
$path_query = "$scheme://$host:$port$path_query";
}
my $p = "$method $path_query HTTP/1.1\015\012"
. "Host: $host:$port\015\012";
my @headers = @{$self->{headers}};
$connection_header = 'close'
if $method eq 'HEAD';
if (my $in_headers = $args{headers}) {
for (my $i = 0; $i < @$in_headers; $i += 2) {
my $name = $in_headers->[$i];
if (lc($name) eq 'connection') {
$connection_header = $in_headers->[$i + 1];
} else {
push @headers, $name, $in_headers->[$i + 1];
}
}
}
unshift @headers, 'Connection', $connection_header;
my $content = $args{content};
my $content_is_fh = 0;
if(defined $content) {
$content_is_fh = Scalar::Util::openhandle($content);
if(!$content_is_fh && ref $content) {
$content = $self->make_x_www_form_urlencoded($content);
if(!defined _header_get(\@headers, 'Content-Type')) {
push @headers, 'Content-Type'
=> 'application/x-www-form-urlencoded';
}
}
if(!defined _header_get(\@headers, 'Content-Length')) {
my $content_length;
if($content_is_fh) {
my $assert = sub {
$_[0] or Carp::croak(
"Failed to $_[1] for Content-Length: $!",
);
};
$assert->(defined(my $cur_pos = tell($content)), 'tell');
$assert->(seek($content, 0, SEEK_END), 'seek');
$assert->(defined(my $end_pos = tell($content)), 'tell');
$assert->(seek($content, $cur_pos, SEEK_SET), 'seek');
$content_length = $end_pos - $cur_pos;
}
else {
$content_length = length($content);
}
push @headers, 'Content-Length' => $content_length;
}
}
for (my $i = 0; $i < @headers; $i += 2) {
my $val = $headers[ $i + 1 ];
# the de facto standard way to handle [\015\012](by kazuho-san)
$val =~ tr/\015\012/ /;
$p .= "$headers[$i]: $val\015\012";
}
$p .= "\015\012";
$self->write_all($sock, $p, $timeout_at)
or return $self->_r500(
"Failed to send HTTP request: " . _strerror_or_timeout());
if (defined $content) {
if ($content_is_fh) {
my $ret;
my $buf;
SENDFILE: while (1) {
$ret = read($content, $buf, $self->{bufsize});
if (not defined $ret) {
Carp::croak("Failed to read request content: $!");
} elsif ($ret == 0) { # EOF
last SENDFILE;
}
$self->write_all($sock, $buf, $timeout_at)
or return $self->_r500(
"Failed to send content: " . _strerror_or_timeout()
);
}
} else { # simple string
if (length($content) > 0) {
$self->write_all($sock, $content, $timeout_at)
or return $self->_r500(
"Failed to send content: " . _strerror_or_timeout()
);
}
}
}
}
# read response
my $buf = '';
my $rest_header;
my $res_minor_version;
my $res_status;
my $res_msg;
my $res_headers;
my $special_headers = $args{special_headers} || +{};
$special_headers->{'connection'} = '';
$special_headers->{'content-length'} = undef;
$special_headers->{'location'} = '';
$special_headers->{'content-encoding'} = '';
$special_headers->{'transfer-encoding'} = '';
LOOP: while (1) {
my $n = $self->read_timeout($sock,
\$buf, $self->{bufsize}, length($buf), $timeout_at);
if(!$n) { # error or eof
if($in_keepalive && (defined($n) || $!==ECONNRESET)) {
# the server closes the connection (maybe because of keep-alive timeout)
return $self->request(%args);
}
return $self->_r500(
!defined($n)
? "Cannot read response header: " . _strerror_or_timeout()
: "Unexpected EOF while reading response header"
);
}
else {
my $ret;
( $ret, $res_minor_version, $res_status, $res_msg, $res_headers )
= HTTP::Parser::XS::parse_http_response( $buf,
$self->{header_format}, $special_headers );
if ( $ret == -1 ) {
return $self->_r500("Invalid HTTP response");
}
elsif ( $ret == -2 ) {
# partial response
next LOOP;
}
else {
# succeeded
$rest_header = substr( $buf, $ret );
last LOOP;
}
}
}
my $res_content;
if (my $fh = $args{write_file}) {
$res_content = Furl::FileStream->new( $fh );
} elsif (my $coderef = $args{write_code}) {
$res_content = Furl::CallbackStream->new(
sub { $coderef->($res_status, $res_msg, $res_headers, @_) }
);
}
else {
$res_content = '';
}
if (exists $COMPRESSED{ $special_headers->{'content-encoding'} }) {
_requires('Furl/ZlibStream.pm', 'Content-Encoding', 'Compress::Raw::Zlib');
$res_content = Furl::ZlibStream->new($res_content);
}
my $chunked = ($special_headers->{'transfer-encoding'} eq 'chunked');
my $content_length = $special_headers->{'content-length'};
unless ($method eq 'HEAD'
|| ($res_status < 200 && $res_status >= 100)
|| $res_status == 204
|| $res_status == 304) {
my @err;
if ( $chunked ) {
@err = $self->_read_body_chunked($sock,
\$res_content, $rest_header, $timeout_at);
} else {
$res_content .= $rest_header;
if (ref $res_content || !defined($content_length)) {
@err = $self->_read_body_normal($sock,
\$res_content, length($rest_header),
$content_length, $timeout_at);
} else {
@err = $self->_read_body_normal_to_string_buffer($sock,
\$res_content, length($rest_header),
$content_length, $timeout_at);
}
}
if(@err) {
return @err;
}
}
if ($special_headers->{location}) {
my $max_redirects = defined($args{max_redirects}) ? $args{max_redirects} : $self->{max_redirects};
if ($max_redirects && $res_status =~ /^30[123]$/) {
my $location = $special_headers->{location};
unless ($location =~ m{^[a-z0-9]+://}) {
# RFC 2616 14.30 says Location header is absoluteURI.
# But, a lot of servers return relative URI.
_requires("URI.pm", "redirect with relative url");
$location = URI->new_abs($location, "$scheme://$host:$port$path_query")->as_string;
}
# Note: RFC 1945 and RFC 2068 specify that the client is not allowed
# to change the method on the redirected request. However, most
# existing user agent implementations treat 302 as if it were a 303
# response, performing a GET on the Location field-value regardless
# of the original request method. The status codes 303 and 307 have
# been added for servers that wish to make unambiguously clear which
# kind of reaction is expected of the client.
return $self->request(
@_,
method => $res_status eq '301' ? $method : 'GET',
url => $location,
max_redirects => $max_redirects - 1,
);
}
}
# manage connection cache (i.e. keep-alive)
if ($connection_header eq 'keep-alive') {
my $connection = lc $special_headers->{'connection'};
if (($res_minor_version == 0
? $connection eq 'keep-alive' # HTTP/1.0 needs explicit keep-alive
: $connection ne 'close') # HTTP/1.1 can keep alive by default
&& ( defined $content_length or $chunked)) {
$self->{connection_pool}->push($host, $port, $sock);
}
}
# return response.
if (ref $res_content) {
return ($res_minor_version, $res_status, $res_msg, $res_headers, $res_content->get_response_string);
} else {
return ($res_minor_version, $res_status, $res_msg, $res_headers, $res_content);
}
}
# connects to $host:$port and returns $socket
sub connect :method {
my($self, $host, $port, $timeout_at) = @_;
my $sock;
my $timeout = $timeout_at - time;
return (undef, "Failed to resolve host name: timeout")
if $timeout <= 0;
my $iaddr = $self->{inet_aton}->($host, $timeout)
or return (undef, "Cannot resolve host name: $host, $!");
my $sock_addr = pack_sockaddr_in($port, $iaddr);
RETRY:
socket($sock, PF_INET, SOCK_STREAM, 0)
or Carp::croak("Cannot create socket: $!");
_set_sockopts($sock);
if (connect($sock, $sock_addr)) {
# connected
} elsif ($! == EINPROGRESS) {
$self->do_select(1, $sock, $timeout_at)
or return (undef, "Cannot connect to ${host}:${port}: timeout");
# connected
} else {
if ($! == EINTR && ! $self->{stop_if}->()) {
close $sock;
goto RETRY;
}
return (undef, "Cannot connect to ${host}:${port}: $!");
}
return $sock;
}
# connect SSL socket.
# You can override this methond in your child class, if you want to use Crypt::SSLeay or some other library.
# @return file handle like object
sub connect_ssl {
my ($self, $host, $port, $timeout_at) = @_;
_requires('IO/Socket/SSL.pm', 'SSL');
my $timeout = $timeout_at - time;
return (undef, "Cannot create SSL connection: timeout")
if $timeout <= 0;
my $sock = IO::Socket::SSL->new(
PeerHost => $host,
PeerPort => $port,
Timeout => $timeout,
) or return (undef, "Cannot create SSL connection: $!");
_set_sockopts($sock);
$sock;
}
sub connect_ssl_over_proxy {
my ($self, $proxy_host, $proxy_port, $host, $port, $timeout_at) = @_;
_requires('IO/Socket/SSL.pm', 'SSL');
my $sock = $self->connect($proxy_host, $proxy_port, $timeout_at);
my $p = "CONNECT $host:$port HTTP/1.0\015\012Server: $host\015\012\015\012";
$self->write_all($sock, $p, $timeout_at)
or return $self->_r500(
"Failed to send HTTP request to proxy: " . _strerror_or_timeout());
my $buf = '';
my $read = $self->read_timeout($sock,
\$buf, $self->{bufsize}, length($buf), $timeout_at);
if (not defined $read) {
return (undef, "Cannot read proxy response: " . _strerror_or_timeout());
} elsif ( $read == 0 ) { # eof
return (undef, "Unexpected EOF while reading proxy response");
} elsif ( $buf !~ /^HTTP\/1.[01] 200 Connection established\015\012/ ) {
return (undef, "Invalid HTTP Response via proxy");
}
my $timeout = $timeout_at - time;
return (undef, "Cannot start SSL connection: timeout")
if $timeout_at <= 0;
IO::Socket::SSL->start_SSL( $sock, Timeout => $timeout )
or return (
undef, "Cannot start SSL connection: " . _strerror_or_timeout());
_set_sockopts($sock); # just in case (20101118 kazuho)
}
sub _read_body_chunked {
my ($self, $sock, $res_content, $rest_header, $timeout_at) = @_;
my $buf = $rest_header;
READ_LOOP: while (1) {
if (
my ( $header, $next_len ) = (
$buf =~
m{\A ( # header
( [0-9a-fA-F]+ ) # next_len (hex number)
(?:;
$HTTP_TOKEN
=
(?: $HTTP_TOKEN | $HTTP_QUOTED_STRING )
)* # optional chunk-extentions
[ ]* # www.yahoo.com adds spaces here.
# Is this valid?
\015\012 # CR+LF
) }xmso
)
)
{
$buf = substr($buf, length($header)); # remove header from buf
if ($next_len eq '0') {
last READ_LOOP;
}
$next_len = hex($next_len);
# +2 means trailing CRLF
READ_CHUNK: while ( $next_len+2 > length($buf) ) {
my $n = $self->read_timeout( $sock,
\$buf, $self->{bufsize}, length($buf), $timeout_at );
if ( not defined $n ) {
return $self->_r500(
"Cannot read chunk: " . _strerror_or_timeout());
}
}
$$res_content .= substr($buf, 0, $next_len);
$buf = substr($buf, $next_len+2);
if (length($buf) > 0) {
next; # re-parse header
}
}
my $n = $self->read_timeout( $sock,
\$buf, $self->{bufsize}, length($buf), $timeout_at );
if (!$n) {
return $self->_r500(
!defined($n)
? "Cannot read chunk: " . _strerror_or_timeout()
: "Unexpected EOF while reading packets"
);
}
}
# read last CRLF
return $self->_read_body_normal(
$sock, \$buf, length($buf), 2, $timeout_at);
}
sub _read_body_normal {
my ($self, $sock, $res_content, $nread, $res_content_length, $timeout_at)
= @_;
while (!defined($res_content_length) || $res_content_length != $nread) {
my $n = $self->read_timeout( $sock,
\my $buf, $self->{bufsize}, 0, $timeout_at );
if (!$n) {
last if ! defined($res_content_length);
return $self->_r500(
!defined($n)
? "Cannot read content body: " . _strerror_or_timeout()
: "Unexpected EOF while reading content body"
);
}
$$res_content .= $buf;
$nread += $n;
}
return;
}
# This function loads all content at once if it's possible. Since $res_content is just a plain scalar.
# Buffering is not needed.
sub _read_body_normal_to_string_buffer {
my ($self, $sock, $res_content, $nread, $res_content_length, $timeout_at)
= @_;
while ($res_content_length != $nread) {
my $n = $self->read_timeout( $sock,
$res_content, $res_content_length, $nread, $timeout_at );
if (!$n) {
return $self->_r500(
!defined($n)
? "Cannot read content body: " . _strerror_or_timeout()
: "Unexpected EOF while reading content body"
);
}
$nread += $n;
}
return;
}
# returns true if the socket is ready to read, false if timeout has occurred ($! will be cleared upon timeout)
sub do_select {
my($self, $is_write, $sock, $timeout_at) = @_;
# wait for data
while (1) {
my $timeout = $timeout_at - time;
if ($timeout <= 0) {
$! = 0;
return 0;
}
my($rfd, $wfd);
my $efd = '';
vec($efd, fileno($sock), 1) = 1;
if ($is_write) {
$wfd = $efd;
} else {
$rfd = $efd;
}
my $nfound = select($rfd, $wfd, $efd, $timeout);
return 1 if $nfound > 0;
return 0 if $nfound == -1 && $! == EINTR && $self->{stop_if}->();
}
die 'not reached';
}
# returns (positive) number of bytes read, or undef if the socket is to be closed
sub read_timeout {
my ($self, $sock, $buf, $len, $off, $timeout_at) = @_;
my $ret;
$self->do_select(0, $sock, $timeout_at) or return undef;
while(1) {
# try to do the IO
defined($ret = sysread($sock, $$buf, $len, $off))
and return $ret;
if ($! == EAGAIN || $! == EWOULDBLOCK) {
# pass thru
} elsif ($! == EINTR) {
return undef if $self->{stop_if}->();
# otherwise pass thru
} else {
return undef;
}
# on EINTER/EAGAIN/EWOULDBLOCK
$self->do_select(0, $sock, $timeout_at) or return undef;
}
}
# returns (positive) number of bytes written, or undef if the socket is to be closed
sub write_timeout {
my ($self, $sock, $buf, $len, $off, $timeout_at) = @_;
my $ret;
while(1) {
# try to do the IO
defined($ret = syswrite($sock, $buf, $len, $off))
and return $ret;
if ($! == EAGAIN || $! == EWOULDBLOCK) {
# pass thru
} elsif ($! == EINTR) {
return undef if $self->{stop_if}->();
# otherwise pass thru
} else {
return undef;
}
$self->do_select(1, $sock, $timeout_at) or return undef;
}
}
# writes all data in buf and returns number of bytes written or undef if failed
sub write_all {
my ($self, $sock, $buf, $timeout_at) = @_;
my $off = 0;
while (my $len = length($buf) - $off) {
my $ret = $self->write_timeout($sock, $buf, $len, $off, $timeout_at)
or return undef;
$off += $ret;
}
return $off;
}
sub _r500 {
my($self, $message) = @_;
$message = Carp::shortmess($message); # add lineno and filename
return(0, 500, "Internal Response: $message",
['Content-Length' => length($message)], $message);
}
sub _strerror_or_timeout {
$! != 0 ? "$!" : 'timeout';
}
sub _set_sockopts {
my $sock = shift;
setsockopt( $sock, IPPROTO_TCP, TCP_NODELAY, 1 )
or Carp::croak("Failed to setsockopt(TCP_NODELAY): $!");
if (WIN32) {
my $tmp = 1;
ioctl( $sock, 0x8004667E, \$tmp )
or Carp::croak("Cannot set flags for the socket: $!");
} else {
my $flags = fcntl( $sock, F_GETFL, 0 )
or Carp::croak("Cannot get flags for the socket: $!");
$flags = fcntl( $sock, F_SETFL, $flags | O_NONBLOCK )
or Carp::croak("Cannot set flags for the socket: $!");
}
{
# no buffering
my $orig = select();
select($sock); $|=1;
select($orig);
}
binmode $sock;
}
# You can override this method if you want to use more powerful matcher.
sub match_no_proxy {
my ( $self, $no_proxy, $host ) = @_;
# ref. curl.1.
# list of host names that shouldn't go through any proxy.
# If set to a asterisk '*' only, it matches all hosts.
if ( $no_proxy eq '*' ) {
return 1;
}
else {
for my $pat ( split /\s*,\s*/, lc $no_proxy ) {
if ( $host =~ /\Q$pat\E$/ ) { # suffix match(same behavior with LWP)
return 1;
}
}
}
return 0;
}
# utility class
{
package # hide from pause
Furl::FileStream;
use overload '.=' => 'append', fallback => 1;
sub new {
my ($class, $fh) = @_;
bless {fh => $fh}, $class;
}
sub append {
my($self, $partial) = @_;
print {$self->{fh}} $partial;
return $self;
}
sub get_response_string { undef }
}
{
package # hide from pause
Furl::CallbackStream;
use overload '.=' => 'append', fallback => 1;
sub new {
my ($class, $cb) = @_;
bless {cb => $cb}, $class;
}
sub append {
my($self, $partial) = @_;
$self->{cb}->($partial);
return $self;
}
sub get_response_string { undef }
}
1;
__END__
=encoding utf8
=head1 NAME
Furl::HTTP - Low level interface to Furl
=head1 SYNOPSIS
use Furl;
my $furl = Furl::HTTP->new(
agent => 'MyGreatUA/2.0',
timeout => 10,
);
my ($minor_version, $code, $msg, $headers, $body) = $furl->request(
method => 'GET',
host => 'example.com',
port => 80,
path_query => '/'
);
# or
# Accept-Encoding is supported but optional
$furl = Furl->new(
headers => [ 'Accept-Encoding' => 'gzip' ],
);
my $body = $furl->get('http://example.com/some/compressed');
=head1 DESCRIPTION
Furl is yet another HTTP client library. LWP is the de facto standard HTTP
client for Perl5, but it is too slow for some critical jobs, and too complex
for weekend hacking. Furl resolves these issues. Enjoy it!
This library is an B<beta> software. Any API may change without notice.
=head1 INTERFACE
=head2 Class Methods
=head3 C<< Furl::HTTP->new(%args | \%args) :Furl >>
Creates and returns a new Furl client with I<%args>. Dies on errors.
I<%args> might be:
=over
=item agent :Str = "Furl/$VERSION"
=item timeout :Int = 10
Seconds until the call to $furl->request returns a timeout error (as an internally generated 500 error). The timeout might not be accurate since some underlying modules / built-ins function may block longer than the specified timeout. See the FAQ for how to support timeout during name resolution.
=item max_redirects :Int = 7
=item proxy :Str
=item no_proxy :Str
=item headers :ArrayRef
=item header_format :Int = HEADERS_AS_ARRAYREF
This option choose return value format of C<< $furl->request >>.
This option allows HEADERS_NONE or HEADERS_AS_ARRAYREF.
B<HEADERS_AS_ARRAYREF> is a default value. This makes B<$headers> as ArrayRef.
B<HEADERS_NONE> makes B<$headers> as undef. Furl does not return parsing result of headers. You should take needed headers from B<special_headers>.
=item connection_pool
This is the connection pool object for keep-alive requests. By default, it is a instance of L<Furl::ConnectionCache>.
You may not customize this variable otherwise to use L<Coro>. This attribute requires a duck type object. It has two methods, C<< $obj->steal($host, $port >> and C<< $obj->push($host, $port, $sock) >>.
=item stop_if
A callback function that is called by Furl after when a blocking function call returns EINTR. Furl will abort the HTTP request and return immediately if the callback returns true. Otherwise the operation is continued (the default behaviour).
=item inet_aton
A callback function to customize name resolution. Takes two arguments: ($hostname, $timeout_in_seconds). If omitted, Furl calls L<Socket::inet_aton>.
=back
=head2 Instance Methods
=head3 C<< $furl->request(%args) :($protocol_minor_version, $code, $msg, \@headers, $body) >>
Sends an HTTP request to a specified URL and returns a protocol minor version,
status code, status message, response headers, response body respectively.
I<%args> might be:
=over
=item scheme :Str = "http"
Protocol scheme. May be C<http> or C<https>.
=item host :Str
Server host to connect.
You must specify at least C<host> or C<url>.
=item port :Int = 80
Server port to connect. The default is 80 on C<< scheme => 'http' >>,
or 443 on C<< scheme => 'https' >>.
=item path_query :Str = "/"
Path and query to request.
=item url :Str
URL to request.
You can use C<url> instead of C<scheme>, C<host>, C<port> and C<path_query>.
=item headers :ArrayRef
HTTP request headers. e.g. C<< headers => [ 'Accept-Encoding' => 'gzip' ] >>.
=item content : Str | ArrayRef[Str] | HashRef[Str] | FileHandle
Content to request.
=item write_file : FileHandle
If this parameter is set, the response content will be saved here instead of in the response object.
It's like a ':content_file' in L<LWP::UserAgent>.
=item write_code : CodeRef
If a callback is provided with the "write_code" option
then this function will be called for each chunk of the response
content as it is received from the server.
It's like a ':content_cb' in L<LWP::UserAgent>.
=back
The C<request()> method assumes the first argument to be an instance
of C<HTTP::Request> if the arguments are an odd number: