added experimental boundary method to Mojo::Content

mojolicious · Oct 10, 2011 · a0b3338 · a0b3338
1 parent cc67f0d
commit a0b3338
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 27 deletions.
diff --git a/Changes b/Changes
@@ -6,6 +6,7 @@ This file documents the revision history for Perl extension Mojolicious.
         - Added EXPERIMENTAL on_body attribute to Mojo::Content.
         - Added EXPERIMENTAL contains method to Mojo::Path.
         - Added EXPERIMENTAL auto_upgrade attribute to Mojo::Content::Single.
+        - Added EXPERIMENTAL boundary method to Mojo::Content.
         - Improved message parser performance slightly.
         - Improved Mojo::IOLoop to die if started twice.
         - Improved setuidgid in Mojo::Server::Daemon.

diff --git a/lib/Mojo/Content.pm b/lib/Mojo/Content.pm
@@ -16,6 +16,13 @@ sub body_contains {
 
 sub body_size { croak 'Method "body_size" not implemented by subclass' }
 
+sub boundary {
+  return
+    unless (shift->headers->content_type || '')
+    =~ /multipart.*boundary=\"*([a-zA-Z0-9\'\(\)\,\.\:\?\-\_\+\/]+)/i;
+  return $1;
+}
+
 # "Operator! Give me the number for 911!"
 sub build_body {
   my $self = shift;
@@ -131,13 +138,7 @@ sub is_dynamic {
   return;
 }
 
-sub is_multipart {
-  my $self = shift;
-  my $type = $self->headers->content_type || '';
-  $type =~ /multipart.*boundary=\"*([a-zA-Z0-9\'\(\)\,\.\:\?\-\_\+\/]+)/i
-    and return $1;
-  return;
-}
+sub is_multipart {undef}
 
 sub is_parsing_body {
   return 1 if (shift->{state} || '') eq 'body';
@@ -486,6 +487,13 @@ Check if content contains a specific string.
 
 Content size in bytes.
 
+=head2 C<boundary>
+
+  my $boundary = $content->boundary;
+
+Extract multipart boundary from content type header.
+Note that this method is EXPERIMENTAL and might change without warning!
+
 =head2 C<build_body>
 
   my $string = $content->build_body;
@@ -556,9 +564,9 @@ Note that this method is EXPERIMENTAL and might change without warning!
 
 =head2 C<is_multipart>
 
-  my $success = $content->is_multipart;
+  my $false = $content->is_multipart;
 
-Check if content is multipart.
+False.
 
 =head2 C<is_parsing_body>
 

diff --git a/lib/Mojo/Content/MultiPart.pm b/lib/Mojo/Content/MultiPart.pm
@@ -128,6 +128,8 @@ sub get_body_chunk {
   }
 }
 
+sub is_multipart {1}
+
 sub parse {
   my $self = shift;
 
@@ -148,7 +150,7 @@ sub _parse_multipart {
 
   # Parse
   $self->{multi_state} ||= 'multipart_preamble';
-  my $boundary = $self->is_multipart;
+  my $boundary = $self->boundary;
   while (!$self->is_done) {
 
     # Preamble
@@ -300,6 +302,12 @@ Note that this method is EXPERIMENTAL and might change without warning!
 
 Get a chunk of content starting from a specfic position.
 
+=head2 C<is_multipart>
+
+  my $true = $content->is_multipart;
+
+True.
+
 =head2 C<parse>
 
   $content = $content->parse('Content-Type: multipart/mixed');

diff --git a/lib/Mojo/Content/Single.pm b/lib/Mojo/Content/Single.pm
@@ -47,7 +47,7 @@ sub parse {
   return $self if ($self->{state} || '') eq 'headers' || $self->on_read;
 
   # Content needs to be upgraded to multipart
-  if ($self->auto_upgrade && $self->is_multipart) {
+  if ($self->auto_upgrade && defined($self->boundary)) {
     return $self if $self->isa('Mojo::Content::MultiPart');
     return Mojo::Content::MultiPart->new($self)->parse;
   }

diff --git a/lib/Mojo/Message.pm b/lib/Mojo/Message.pm
@@ -772,7 +772,7 @@ Note that this method is EXPERIMENTAL and might change without warning!
 
   my $success = $message->is_multipart;
 
-Check if message content is multipart.
+Check if message content is a L<Mojo::Content::MultiPart> object.
 
 =head2 C<json>
 

diff --git a/lib/Mojo/Transaction.pm b/lib/Mojo/Transaction.pm
@@ -29,7 +29,7 @@ sub is_done {
   return;
 }
 
-sub is_websocket {0}
+sub is_websocket {undef}
 
 sub is_writing {
   return 1 unless my $state = shift->{state};
@@ -237,9 +237,9 @@ Check if transaction is done.
 
 =head2 C<is_websocket>
 
-  my $success = $tx->is_websocket;
+  my $false = $tx->is_websocket;
 
-Check if transaction is a WebSocket.
+False.
 
 =head2 C<is_writing>
 

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -453,7 +453,7 @@ Finish the WebSocket connection gracefully.
 
 =head2 C<is_websocket>
 
-  my $success = $ws->is_websocket;
+  my $true = $ws->is_websocket;
 
 True.
 

diff --git a/t/mojo/message.t b/t/mojo/message.t
@@ -3,7 +3,7 @@ use Mojo::Base -strict;
 
 use utf8;
 
-use Test::More tests => 1231;
+use Test::More tests => 1233;
 
 use File::Spec;
 use File::Temp;
@@ -612,9 +612,10 @@ $req->parse("use strict;\n");
 $req->parse("use warnings;\n\n");
 $req->parse("print \"Hello World :)\\n\"\n");
 $req->parse("\x0d\x0a------------0xKhTmLbOuNdArY--");
-ok $req->is_done, 'request is done';
-is $req->method,  'GET', 'right method';
-is $req->version, '1.1', 'right version';
+ok $req->is_done,      'request is done';
+is $req->is_multipart, 1, 'multipart content';
+is $req->method,       'GET', 'right method';
+is $req->version,      '1.1', 'right version';
 is $req->at_least_version('1.0'), 1,     'at least version 1.0';
 is $req->at_least_version('1.2'), undef, 'not version 1.2';
 is $req->url, '/foo/bar/baz.html?foo13#23', 'right URL';
@@ -660,9 +661,10 @@ $req->parse("use strict;\n");
 $req->parse("use warnings;\n\n");
 $req->parse("print \"Hello World :)\\n\"\n");
 $req->parse("\x0d\x0a------------0xKhTmLbOuNdArY--");
-ok $req->is_done, 'request is done';
-is $req->method,  'GET', 'right method';
-is $req->version, '1.1', 'right version';
+ok $req->is_done,      'request is done';
+is $req->is_multipart, undef, 'no multipart content';
+is $req->method,       'GET', 'right method';
+is $req->version,      '1.1', 'right version';
 is $req->at_least_version('1.0'), 1,     'at least version 1.0';
 is $req->at_least_version('1.2'), undef, 'not version 1.2';
 is $req->url, '/foo/bar/baz.html?foo13#23', 'right URL';

diff --git a/t/mojo/websocket.t b/t/mojo/websocket.t
@@ -191,8 +191,8 @@ $ua->websocket(
   }
 );
 $loop->start;
-is $ws,   0,   'not a websocket';
-is $code, 426, 'right code';
+is $ws,   undef, 'not a websocket';
+is $code, 426,   'right code';
 ok $body =~ /^(\d+)failed!$/, 'right content';
 ok $1 < 100, 'right timeout';
 
@@ -413,7 +413,7 @@ $ua->websocket(
 );
 $loop->start;
 is $done,      1,                       'transaction is done';
-is $websocket, 0,                       'no websocket';
+is $websocket, undef,                   'no websocket';
 is $code,      500,                     'right status';
 is $message,   'Internal Server Error', 'right message';
 
@@ -429,7 +429,7 @@ $ua->websocket(
   }
 );
 $loop->start;
-is $websocket, 0,              'no websocket';
+is $websocket, undef,          'no websocket';
 is $code,      403,            'right status';
 is $message,   "i'm a teapot", 'right message';