1 package HTTP
::AnyUA
::Util
;
2 # ABSTRACT: Utility subroutines for HTTP::AnyUA backends and middleware
7 our $VERSION = '9999.999'; # VERSION
9 use Exporter
qw(import);
13 http_headers_to_native
14 native_to_http_request
15 coderef_content_to_string
25 sub _croak
{ require Carp
; Carp
::croak
(@_) }
26 sub _usage
{ _croak
("Usage: @_\n") }
28 =func coderef_content_to_string
30 $content = coderef_content_to_string
(\
&code
);
31 $content = coderef_content_to_string
($content); # noop
33 Convert a coderef into a string of content by iteratively calling the coderef
and concatenating the
34 chunks it provides
until the coderef returns
undef or an empty string
.
38 sub coderef_content_to_string
{
41 return $content if !$content;
43 if (ref($content) eq 'CODE') {
44 # drain the request body
46 while (my $chunk = $content->()) {
55 =func native_to_http_request
57 $http_request = native_to_http_request
($method, $url);
58 $http_request = native_to_http_request
($method, $url, \
%options);
60 Convert a
"native" request tuple to an L
<HTTP
::Request
> object
.
64 sub native_to_http_request
{
67 my $args = shift || {};
70 my $content = $args->{content
}; # works as either scalar or coderef
73 for my $header (keys %{$args->{headers
} || {}}) {
74 my $value = $args->{headers
}{$header};
75 my @values = ref($value) eq 'ARRAY' ? @$value : ($value);
77 push @$headers, ($header => $v);
81 require HTTP
::Request
;
82 return HTTP
::Request-
>new($method, $url, $headers, $content);
85 =func http_headers_to_native
87 $headers = http_headers_to_native
($http_headers);
89 Convert an L
<HTTP
::Headers
> object to a
"native" hashref
.
93 sub http_headers_to_native
{
94 my $http_headers = shift;
98 for my $header ($http_headers->header_field_names) {
99 my @values = $http_headers->header($header);
100 $native->{lc($header)} = @values == 1 ? $values[0] : [@values];
106 =func normalize_headers
108 $normalized_headers = normalize_headers
(\
%headers);
110 Normalize headers
. Currently lowercases header
keys.
114 sub normalize_headers
{
115 my $headers_in = shift;
119 if (defined $headers_in) {
120 while (my ($key, $value) = each %{$headers_in || {}}) {
121 $headers->{lc($key)} = $value;
128 =func internal_exception
130 $response = internal_exception
($content);
131 $response = internal_exception
($content, $response);
133 Create an internal exception response
. If an existing response
is passed
, that response will have
134 its fields modified to become an internal exception
.
138 sub internal_exception
{
139 my $e = shift or _usage
(q{internal_exception($exception)});
140 my $resp = shift || {};
144 $resp->{headers
}{'client-original-status'} = $resp->{status
} if $resp->{status
};
145 $resp->{headers
}{'client-original-reason'} = $resp->{reason
} if $resp->{reason
};
147 $resp->{success
} = '';
148 $resp->{status
} = 599;
149 $resp->{reason
} = 'Internal Exception';
150 $resp->{content
} = $e;
151 $resp->{headers
}{'content-type'} = 'text/plain';
152 $resp->{headers
}{'content-length'} = length $e;
159 ($scheme, $host, $port, $path_query, $auth) = split_url
($url);
161 Split a URL into its components
.
165 # adapted from HTTP/Tiny.pm
167 my $url = shift or _usage
(q{split_url($url)});
169 # URI regex adapted from the URI module
170 my ($scheme, $host, $path_query) = $url =~ m
<\A
([^:/?#]+)://([^/?#]*)([^#]*)>
171 or die(qq
/Cannot parse URL: '$url'\n/);
173 $scheme = lc $scheme;
174 $path_query = "/$path_query" unless $path_query =~ m
<\A
/>;
177 if ( (my $i = index $host, '@') != -1 ) {
179 $auth = substr $host, 0, $i, ''; # take up to the @ for auth
180 substr $host, 0, 1, ''; # knock the @ off the host
182 # userinfo might be percent escaped, so recover real auth info
183 $auth =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
185 my $port = $host =~ s/:(\d*)\z// && length $1 ? $1
186 : $scheme eq 'http' ? 80
187 : $scheme eq 'https' ? 443
190 return ($scheme, (length $host ? lc $host : "localhost") , $port, $path_query, $auth);
195 $http_date = http_date
($epoch_time);
197 Convert an epoch
time into a date format suitable
for HTTP
.
201 # Date conversions adapted from HTTP::Date
202 # adapted from HTTP/Tiny.pm
203 my $DoW = 'Sun|Mon|Tue|Wed|Thu|Fri|Sat';
204 my $MoY = 'Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec';
206 my $time = shift or _usage
(q{http_date($time)});
207 my ($sec, $min, $hour, $mday, $mon, $year, $wday) = gmtime($time);
208 return sprintf('%s, %02d %s %04d %02d:%02d:%02d GMT',
209 substr($DoW,$wday*4,3),
210 $mday, substr($MoY,$mon*4,3), $year+1900,
215 =func parse_http_date
217 $epoch_time = parse_http_date
($http_date);
219 Convert an HTTP date into an epoch
time. Returns
undef if the date cannot be parsed
.
223 # adapted from HTTP/Tiny.pm
224 sub parse_http_date
{
225 my $str = shift or _usage
(q{parse_http_date($str)});
227 if ($str =~ /^[SMTWF][a-z]+, +(\d{1,2}) ($MoY) +(\d\d\d\d) +(\d\d):(\d\d):(\d\d) +GMT$/) {
228 @tl_parts = ($6, $5, $4, $1, (index($MoY,$2)/4), $3);
230 elsif ($str =~ /^[SMTWF][a-z]+, +(\d\d)-($MoY)-(\d{2,4}) +(\d\d):(\d\d):(\d\d) +GMT$/ ) {
231 @tl_parts = ($6, $5, $4, $1, (index($MoY,$2)/4), $3);
233 elsif ($str =~ /^[SMTWF][a-z]+ +($MoY) +(\d{1,2}) +(\d\d):(\d\d):(\d\d) +(?:[^0-9]+ +)?(\d\d\d\d)$/ ) {
234 @tl_parts = ($5, $4, $3, $2, (index($MoY,$1)/4), $6);
238 my $t = @tl_parts ? Time
::Local
::timegm
(@tl_parts) : -1;
245 $escaped = uri_escape
($unescaped);
247 Escape a string
for use in a URL query param
or as C
<application
/x-www-form-urlencoded
> data
.
251 # URI escaping adapted from URI::Escape
252 # c.f. http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1
253 # perl 5.6 ready UTF-8 encoding adapted from JSON::PP
254 # adapted from HTTP/Tiny.pm
255 my %escapes = map { chr($_) => sprintf('%%%02X', $_) } 0..255;
257 my $unsafe_char = qr/[^A-Za-z0-9\-\._~]/;
260 my $str = shift or _usage
(q{uri_escape($str)});
265 $str = pack('U*', unpack('C*', $str)) # UTF-8 encode a byte string
266 if (length $str == do { use bytes
; length $str });
267 $str = pack('C*', unpack('C*', $str)); # clear UTF-8 flag
269 $str =~ s/($unsafe_char)/$escapes{$1}/ge;
273 =func www_form_urlencode
275 $bytes = www_form_urlencode
(\
%form_data);
276 $bytes = www_form_urlencode
(\
@form_data);
278 Encode a hashref
or arrayref as C
<application
/x-www-form-urlencoded
> data
.
282 # adapted from HTTP/Tiny.pm
283 sub www_form_urlencode
{
286 or _usage
(q{www_form_urlencode($dataref)});
287 (ref $data eq 'HASH' || ref $data eq 'ARRAY')
288 or _croak
("form data must be a hash or array reference\n");
290 my @params = ref $data eq 'HASH' ? %$data : @$data;
292 or _croak
("form data reference must have an even number of terms\n");
296 my ($key, $value) = splice(@params, 0, 2);
297 if (ref $value eq 'ARRAY') {
298 unshift @params, map { $key => $_ } @$value;
301 push @terms, join('=', map { uri_escape
($_) } $key, $value);
305 return join('&', ref($data) eq 'ARRAY' ? @terms : sort @terms);