Use Ref::Util where appropriate
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
index ecaeb94..7112a59 100644 (file)
@@ -51,6 +51,8 @@ use Catalyst::Middleware::Stash;
 use Plack::Util;
 use Class::Load 'load_class';
 use Encode 2.21 'decode_utf8', 'encode_utf8';
+use Scalar::Util;
+use Ref::Util qw(is_plain_arrayref is_plain_coderef is_plain_hashref is_plain_scalarref is_regexpref);
 
 BEGIN { require 5.008003; }
 
@@ -204,7 +206,7 @@ sub composed_stats_class {
 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
 
 # Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.90106';
+our $VERSION = '5.90114';
 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
 
 sub import {
@@ -622,7 +624,7 @@ will be an empty arrayref.
 sub error {
     my $c = shift;
     if ( $_[0] ) {
-        my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
+        my $error = is_plain_arrayref($_[0]) ? $_[0] : [@_];
         croak @$error unless ref $c;
         push @{ $c->{error} }, @$error;
     }
@@ -727,13 +729,13 @@ sub _comp_names_search_prefixes {
     # undef for a name will return all
     return keys %eligible if !defined $name;
 
-    my $query  = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
+    my $query  = is_regexpref($name) ? $name : qr/^$name$/i;
     my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
 
     return @result if @result;
 
     # if we were given a regexp to search against, we're done.
-    return if $name->$_isa('Regexp');
+    return if is_regexpref($name);
 
     # skip regexp fallback if configured
     return
@@ -794,7 +796,7 @@ sub _comp_names {
 sub _filter_component {
     my ( $c, $comp, @args ) = @_;
 
-    if(ref $comp eq 'CODE') {
+    if(is_plain_coderef($comp)) {
       $comp = $comp->();
     }
 
@@ -831,7 +833,7 @@ sub controller {
 
     my $appclass = ref($c) || $c;
     if( $name ) {
-        unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
+        unless ( is_regexpref($name) ) { # Direct component hash lookup to avoid costly regexps
             my $comps = $c->components;
             my $check = $appclass."::Controller::".$name;
             return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
@@ -875,7 +877,7 @@ sub model {
     my ( $c, $name, @args ) = @_;
     my $appclass = ref($c) || $c;
     if( $name ) {
-        unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
+        unless ( is_regexpref($name) ) { # Direct component hash lookup to avoid costly regexps
             my $comps = $c->components;
             my $check = $appclass."::Model::".$name;
             return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
@@ -939,7 +941,7 @@ sub view {
 
     my $appclass = ref($c) || $c;
     if( $name ) {
-        unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
+        unless ( is_regexpref($name) ) { # Direct component hash lookup to avoid costly regexps
             my $comps = $c->components;
             my $check = $appclass."::View::".$name;
             if( exists $comps->{$check} ) {
@@ -1436,7 +1438,7 @@ EOF
         }
 
         my @middleware = map {
-          ref $_ eq 'CODE' ? 
+          is_plain_coderef($_) ?
             "Inline Coderef" : 
               (ref($_) .'  '. ($_->can('VERSION') ? $_->VERSION || '' : '') 
                 || '')  } $class->registered_middlewares;
@@ -1605,7 +1607,7 @@ sub uri_for {
         $path .= '/';
     }
 
-    my $fragment =  ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
+    my $fragment =  ((scalar(@args) && is_plain_scalarref($args[-1])) ? pop @args : undef );
 
     unless(blessed $path) {
       if (defined($path) and $path =~ s/#(.+)$//)  {
@@ -1619,7 +1621,7 @@ sub uri_for {
     }
 
     my $params =
-      ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
+      ( scalar @args && is_plain_hashref($args[$#args]) ? pop @args : {} );
 
     undef($path) if (defined $path && $path eq '');
 
@@ -1629,7 +1631,7 @@ sub uri_for {
     if ( $path->$_isa('Catalyst::Action') ) { # action object
         s|/|%2F|g for @args;
         my $captures = [ map { s|/|%2F|g; $_; }
-                        ( scalar @args && ref $args[0] eq 'ARRAY'
+                        ( scalar @args && is_plain_arrayref($args[0])
                          ? @{ shift(@args) }
                          : ()) ];
 
@@ -1721,7 +1723,7 @@ sub uri_for {
               $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
               $key =~ s/ /+/g;
 
-              "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
+              "${key}=$param"; } ( is_plain_arrayref($val) ? @$val : $val ));
       } @keys);
     }
 
@@ -2319,7 +2321,7 @@ sub finalize_encoding {
     if(
       ($res->encodable_response) and
       (defined($res->body)) and
-      (ref(\$res->body) eq 'SCALAR')
+      (is_plain_scalarref(\$res->body))
     ) {
         $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
 
@@ -2466,9 +2468,6 @@ sub prepare {
     # VERY ugly and probably shouldn't rely on ->finalize actually working
     catch {
         # failed prepare is always due to an invalid request, right?
-        $c->response->status(400);
-        $c->response->content_type('text/plain');
-        $c->response->body('Bad Request');
         # Note we call finalize and then die here, which escapes
         # finalize being called in the enclosing block..
         # It in fact couldn't be called, as we don't return $c..
@@ -2476,11 +2475,25 @@ sub prepare {
         # breaking compat for people doing crazy things (we should set
         # the 400 and just return the ctx here IMO, letting finalize get called
         # above...
-        $c->finalize;
-        die $_;
+        if ( $c->_handle_http_exception($_) ) {
+            foreach my $err (@{$c->error}) {
+                $c->log->error($err);
+            }
+            $c->clear_errors;
+            $c->log->_flush if $c->log->can('_flush');
+            $_->can('rethrow') ? $_->rethrow : croak $_;
+        } else {
+            $c->response->status(400);
+            $c->response->content_type('text/plain');
+            $c->response->body('Bad Request');
+            $c->finalize;
+            die $_;
+        }
     };
 
     $c->log_request;
+    $c->{stash} = $c->stash;
+    Scalar::Util::weaken($c->{stash});
 
     return $c;
 }
@@ -2731,7 +2744,7 @@ sub log_request_parameters {
         for my $key ( sort keys %$params ) {
             my $param = $params->{$key};
             my $value = defined($param) ? $param : '';
-            $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
+            $t->row( $key, is_plain_arrayref($value) ? ( join ', ', @$value ) : $value );
         }
         $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
     }
@@ -2759,7 +2772,7 @@ sub log_request_uploads {
         );
         for my $key ( sort keys %$uploads ) {
             my $upload = $uploads->{$key};
-            for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
+            for my $u ( is_plain_arrayref($upload) ? @{$upload} : ($upload) ) {
                 $t->row( $key, $u->filename, $u->type, $u->size );
             }
         }
@@ -3019,7 +3032,7 @@ sub setup_components {
     # All components are registered, now we need to 'init' them.
     foreach my $component_name (@comps, @injected) {
       $class->components->{$component_name} = $class->components->{$component_name}->() if
-        (ref($class->components->{$component_name}) || '') eq 'CODE';
+        is_plain_coderef($class->components->{$component_name});
     }
 }
 
@@ -3562,15 +3575,44 @@ sub setup_encoding {
 
 =head2 handle_unicode_encoding_exception
 
-Hook to let you customize how encoding errors are handled.  By default
-we just throw an exception.  Receives a hashref of debug information.
-Example:
+Hook to let you customize how encoding errors are handled. By default
+we just throw an exception and the default error page will pick it up.
+Receives a hashref of debug information. Example of call (from the
+Catalyst internals):
 
-    $c->handle_unicode_encoding_exception({
+  my $decoded_after_fail = $c->handle_unicode_encoding_exception({
         param_value => $value,
         error_msg => $_,
-            encoding_step => 'params',
-        });
+        encoding_step => 'params',
+   });
+
+The calling code expects to receive a decoded string or an exception.
+
+You can override this for custom handling of unicode errors. By
+default we just die. If you want a custom response here, one approach
+is to throw an HTTP style exception, instead of returning a decoded
+string or throwing a generic exception.
+
+    sub handle_unicode_encoding_exception {
+      my ($c, $params) = @_;
+      HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
+    }
+
+Alternatively you can 'catch' the error, stash it and write handling code later
+in your application:
+
+    sub handle_unicode_encoding_exception {
+      my ($c, $params) = @_;
+      $c->stash(BAD_UNICODE_DATA=>$params);
+      # return a dummy string.
+      return 1;
+    }
+
+<B>NOTE:</b> Please keep in mind that once an error like this occurs,
+the request setup is still ongoing, which means the state of C<$c> and
+related context parts like the request and response may not be setup
+up correctly (since we haven't finished the setup yet). If you throw
+an exception the setup is aborted.
 
 =cut
 
@@ -3588,13 +3630,13 @@ sub _handle_unicode_decoding {
     return unless defined $value;
 
     ## I think this mess is to support the old nested
-    if ( ref $value eq 'ARRAY' ) {
+    if ( is_plain_arrayref($value) ) {
         foreach ( @$value ) {
             $_ = $self->_handle_unicode_decoding($_);
         }
         return $value;
     }
-    elsif ( ref $value eq 'HASH' ) {
+    elsif ( is_plain_hashref($value) ) {
         foreach (keys %$value) {
             my $encoded_key = $self->_handle_param_unicode_decoding($_);
             $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
@@ -3611,16 +3653,20 @@ sub _handle_unicode_decoding {
 }
 
 sub _handle_param_unicode_decoding {
-    my ( $self, $value ) = @_;
+    my ( $self, $value, $check ) = @_;
     return unless defined $value; # not in love with just ignoring undefs - jnap
     return $value if blessed($value); #don't decode when the value is an object.
 
     my $enc = $self->encoding;
+
+    return $value unless $enc; # don't decode if no encoding is specified
+
+    $check ||= $self->_encode_check;
     return try {
-      $enc->decode( $value, $self->_encode_check );
+      $enc->decode( $value, $check);
     }
     catch {
-        $self->handle_unicode_encoding_exception({
+        return $self->handle_unicode_encoding_exception({
             param_value => $value,
             error_msg => $_,
             encoding_step => 'params',
@@ -3923,9 +3969,9 @@ sub setup_middleware {
         if(ref $next) {
             if(Scalar::Util::blessed $next && $next->can('wrap')) {
                 push @middleware, $next;
-            } elsif(ref $next eq 'CODE') {
+            } elsif(is_plain_coderef($next)) {
                 push @middleware, $next;
-            } elsif(ref $next eq 'HASH') {
+            } elsif(is_plain_hashref($next)) {
                 my $namespace = shift @middleware_definitions;
                 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
                 push @middleware, $mw;
@@ -4321,8 +4367,16 @@ evil clients, this might cause you trouble.  If you find the changes introduced
 in Catalyst version 5.90080+ break some of your query code, you may disable 
 the UTF-8 decoding globally using this configuration.
 
-This setting takes precedence over C<default_query_encoding> and
-C<decode_query_using_global_encoding>
+This setting takes precedence over C<default_query_encoding>
+
+=item *
+
+C<do_not_check_query_encoding>
+
+Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
+request but would not raise an exception when the decoding failed due to
+incorrect unicode.  It now does, but if this change is giving you trouble
+you may disable it by setting this configuration to true.
 
 =item *
 
@@ -4333,15 +4387,6 @@ is our reading of the relevant specifications.  This setting allows one to
 specify a fixed value for how to decode your query.  You might need this if
 you are doing a lot of custom encoding of your URLs and not using UTF-8.
 
-This setting take precedence over C<decode_query_using_global_encoding>.
-
-=item *
-
-C<decode_query_using_global_encoding>
-
-Setting this to true will default your query decoding to whatever your
-general global encoding is (the default is UTF-8).
-
 =item *
 
 C<use_chained_args_0_special_case>