X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=42dabb87c0e17e5b77e3415c48506c13238f11ae;hb=7a1a325a72e9a197866000cfab091a4f660ce348;hp=ef99798bd4e3bfc5e612d19a1eb2399579841290;hpb=3677a4ddb3053561fa232f93fbdf1201b063ba64;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index ef99798..42dabb8 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -14,6 +14,7 @@ use Catalyst::Request::Upload; use Catalyst::Response; use Catalyst::Utils; use Catalyst::Controller; +use Data::OptList; use Devel::InnerPackage (); use File::stat; use Module::Pluggable::Object (); @@ -78,10 +79,7 @@ __PACKAGE__->stats_class('Catalyst::Stats'); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.80020'; -our $PRETTY_VERSION = $VERSION; - -$VERSION = eval $VERSION; +our $VERSION = '5.80022'; sub import { my ( $class, @arguments ) = @_; @@ -640,7 +638,13 @@ If you want to search for controllers, pass in a regexp as the argument. sub controller { my ( $c, $name, @args ) = @_; + my $appclass = ref($c) || $c; if( $name ) { + unless ( ref($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}; + } my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ ); return map { $c->_filter_component( $_, @args ) } @result if ref $name; return $c->_filter_component( $result[ 0 ], @args ); @@ -674,6 +678,11 @@ sub model { my ( $c, $name, @args ) = @_; my $appclass = ref($c) || $c; if( $name ) { + unless ( ref($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}; + } my @result = $c->_comp_search_prefixes( $name, qw/Model M/ ); return map { $c->_filter_component( $_, @args ) } @result if ref $name; return $c->_filter_component( $result[ 0 ], @args ); @@ -728,6 +737,11 @@ sub view { my $appclass = ref($c) || $c; if( $name ) { + unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps + my $comps = $c->components; + my $check = $appclass."::View::".$name; + return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check}; + } my @result = $c->_comp_search_prefixes( $name, qw/View V/ ); return map { $c->_filter_component( $_, @args ) } @result if ref $name; return $c->_filter_component( $result[ 0 ], @args ); @@ -1146,7 +1160,7 @@ EOF if ( $class->debug ) { my $name = $class->config->{name} || 'Application'; - $class->log->info("$name powered by Catalyst $Catalyst::PRETTY_VERSION"); + $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); } # Make sure that the application class becomes immutable at this point, @@ -1500,7 +1514,7 @@ sub welcome_message { models, and views; they can save you a lot of work.

- 
script/${prefix}_create.pl -help
+ 
script/${prefix}_create.pl --help

Also, be sure to check out the vast and growing collection of plugins for Catalyst on CPAN; you are likely to find what you need there. @@ -1743,7 +1757,7 @@ sub finalize { $c->finalize_body; } - $c->log_response; + $c->log_response; if ($c->use_stats) { my $elapsed = sprintf '%f', $c->stats->elapsed; @@ -1877,7 +1891,7 @@ namespaces. sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) } -=head2 $c->handle_request( $class, @arguments ) +=head2 $app->handle_request( @arguments ) Called to handle each HTTP request. @@ -1937,7 +1951,7 @@ sub prepare { #surely this is not the most efficient way to do things... $c->stats($class->stats_class->new)->enable($c->use_stats); - if ( $c->debug ) { + if ( $c->debug || $c->config->{enable_catalyst_header} ) { $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); } @@ -2084,84 +2098,6 @@ sub prepare_query_parameters { $c->engine->prepare_query_parameters( $c, @_ ); } -=head2 $c->apply_parameter_debug_filters($params) - -=cut - -sub _apply_parameter_debug_filters { - my $c = shift; - my $type = shift; - my $params = shift; - - # take a copy since we don't want to modify the original - my $filtered_params = {%$params}; - - my @filters; - - my $filter_param_config = $c->config->{Debug}->{param_filters}; - if ( ref($filter_param_config) eq 'HASH' ) { - - # filters broken out by parameter type (i.e. body, query, all) - my $type_filters = $filter_param_config->{$type} || []; - $type_filters = [$type_filters] if ref $type_filters ne 'ARRAY'; - - my $all_filters = $filter_param_config->{'all'} || []; - $all_filters = [$all_filters] if ref $all_filters ne 'ARRAY'; - - @filters = $c->_normalize_debug_filters( [ @$type_filters, @$all_filters ] ); - } elsif ($filter_param_config) { - @filters = $c->_normalize_debug_filters($filter_param_config); - } - - # allow callback to modify each parameter - foreach my $k ( keys %$filtered_params ) { - - # apply filters to each param - foreach my $f (@filters) { - - # take a copy of the key to avoid the callback inadvertantly - # modifying things - my $copy_key = $k; - - my $returned = $f->( $copy_key => $filtered_params->{$k} ); - - if ( defined $returned ) { - - # if no value is returned, we assume the filter chose not to modify anything - # otherwise, the returned value is the logged value - $filtered_params->{$k} = $returned; - - last; # skip the rest of the filters since this one matched - } - } - } - return $filtered_params; -} - -# turn debug filters into a list of CodeRef's -sub _normalize_debug_filters { - my $c = shift; - - my @filters = ref( $_[0] ) eq 'ARRAY' ? @{ $_[0] } : grep { defined $_ } @_; - - my @normalized = map { _make_filter_callback($_) } @filters; - - return @normalized; -} - -sub _make_filter_callback { - my $filter = shift; - - my $filter_str = '[FILTERED]'; - if ( ref($filter) eq 'Regexp' ) { - return sub { return $_[0] =~ $filter ? $filter_str : undef }; - } elsif ( ref($filter) eq 'CODE' ) { - return $filter; - } else { - return sub { return $_[0] eq $filter ? $filter_str : undef }; - } -} - =head2 $c->log_request Writes information about the request to the debug logs. This includes: @@ -2172,7 +2108,7 @@ Writes information about the request to the debug logs. This includes: =item * Query keywords (see L) -=item * Request parameters (see L) +=item * Request parameters =item * File uploads @@ -2185,184 +2121,86 @@ sub log_request { return unless $c->debug; - my ( $method, $path, $address ) = ( $c->req->method, $c->req->path, $c->req->address ); + my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these; + my $request = $dump->[1]; + + my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address ); $method ||= ''; $path = '/' unless length $path; $address ||= ''; $c->log->debug(qq/"$method" request for "$path" from "$address"/); - if ( my $keywords = $c->req->query_keywords ) { + $c->log_request_headers($request->headers); + + if ( my $keywords = $request->query_keywords ) { $c->log->debug("Query keywords are: $keywords"); } - $c->log_request_parameters( query => $c->req->query_parameters, body => $c->req->body_parameters ); + $c->log_request_parameters( query => $request->query_parameters, body => $request->body_parameters ); - $c->log_request_uploads; + $c->log_request_uploads($request); } =head2 $c->log_response -Writes information about the response to the debug logs. This includes: - -=over 4 - -=item * Response status code - -=item * Response headers (see L) - -=back - -This logging is not enabled by default. To enable it, you must set a flag in your Catalyst config: - - __PACKAGE__->config( Debug => { log_response => 1 } ); +Writes information about the response to the debug logs by calling +C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>. =cut sub log_response { my $c = shift; - return unless $c->debug && $c->config->{Debug}->{log_response}; - - $c->log->debug('Response Status: ' . $c->response->status); - $c->log_headers('response', $c->response->headers); -} - -=head2 $c->log_request_parameters( query => {}, body => {} ) - -Logs request parameters to debug logs - -If you have sensitive data that you do not want written to the Catalyst -debug logs, you can set options in your config to filter those values out. -There are a few different ways you can set these up depending on what -exactly you need to filter. - -=head3 Filtering parameters by name - -The most basic means of filtering is to add an entry into your config -as shown below. You can have a simple scalar to just filter a -single parameter or an ARRAY ref to filter out multiple params. + return unless $c->debug; - # filters a single param - __PACKAGE__->config( Debug => { param_filters => 'param_name' } ); + my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these; + my $response = $dump->[1]; - # filters multiple params - __PACKAGE__->config( Debug => { param_filters => [qw(param1 param2)] } ); + $c->log_response_status_line($response); + $c->log_response_headers($response->headers); +} -When the debug logs are generated for a given request, any parameters -(query or body) that exactly match the specified value(s) will have -their values replaced with '[FILTERED]'. For instance: +=head2 $c->log_response_status_line($response) - [debug] Query Parameters are: - .-------------------------------------+--------------------------------------. - | Parameter | Value | - +-------------------------------------+--------------------------------------+ - | password | [FILTERED] | - .-------------------------------------+--------------------------------------. +Writes one line of information about the response to the debug logs. This includes: -=head3 Filtering parameters by regular expression +=over 4 -If you have a set of parameters you need to filter, you can specify a -regular expression that will be used to match against parameter names. +=item * Response status code - # filters parameters starting with "private." - __PACKAGE__->config( Debug => { param_filters => qr/^private\./ } ); +=item * Content-Type header (if present) - # filters parameters named "param1" or starting with "private." or "secret." - __PACKAGE__->config( Debug => { param_filters => [ 'param1', qr/^private\./, qr/^secret\./ ] } ); +=item * Content-Length header (if present) -Notice on the second example, the arrayref contains a string as well -as two regular expressions. This should DWIM and filter parameters that -match any of the filters specified. +=back -=head3 Filtering parameters by callback +=cut -If you want even more flexible filtering, you can specify an anonymous -subroutine. The subroutine is given the parameter name and value and -is expected to return the new value that will be shown in the debug log. -An C return value indicates that no change should be made to -the value. +sub log_response_status_line { + my ($c, $response) = @_; - # transform any "password" param to "********" - __PACKAGE__->config( - Debug => { - param_filters => sub { my ( $k, $v ) = @_; return unless $k eq 'password'; return '*' x 8; } - } + $c->log->debug( + sprintf( + 'Response Code: %s; Content-Type: %s; Content-Length: %s', + $response->status || 'unknown', + $response->headers->header('Content-Type') || 'unknown', + $response->headers->header('Content-Length') || 'unknown' + ) ); +} - # combine several param filtering methods - __PACKAGE__->config( - Debug => { - param_filters => [ - 'simple_param_name', - qr/^private\./, - sub { my ( $k, $v ) = @_; return unless $k eq 'password'; return '*' x 8; }, - ] - } - ); - -An example of the debug log for a request with -C would be: - - [debug] Body Parameters are: - .-------------------------------------+--------------------------------------. - | Parameter | Value | - +-------------------------------------+--------------------------------------+ - | some_other_param | some_other_value | - | password | ******** | - .-------------------------------------+--------------------------------------. - -=head3 Filtering by parameter location - -If you have different filters that depend on whether a param was passed -as a query or body param (or as either), you can specify a hashref with -different sets of filters: - - # filters all body parameters - __PACKAGE__->config( Debug => { param_filters => { body => qr// } } ); +=head2 $c->log_response_headers($headers); - # filters query parameters starting with 'private'. - __PACKAGE__->config( Debug => { param_filters => { query => qr/^private\./ } } ); +Hook method which can be wrapped by plugins to log the responseheaders. +No-op in the default implementation. - # filters all parameters (query or body) through the specified callback - __PACKAGE__->config( - Debug => { - param_filters => { - all => sub { return unless $_[0] eq 'fizzbuzz'; return 'FIZZBUZZ FILTER' } - } - } - ); +=cut -Of course, you can use any of the above filtering methods with these -"location-specific" filters: - - # body parameter filters - __PACKAGE__->config( - Debug => { - param_filters => { - body => [ - 'some_param', - qr/^private\./, - sub { return 'XXX' if shift eq 'other_param' } - ] - } - } - ); +sub log_response_headers {} - # query parameter filters - __PACKAGE__->config( - Debug => { - param_filters => { - body => [ - 'some_param', - qr/^private\./, - sub { return 'XXX' if shift eq 'other_param' } - ] - } - } - ); +=head2 $c->log_request_parameters( query => {}, body => {} ) - # query parameter filters - __PACKAGE__->config( Debug => { param_filters => { all => [qw(foo bar)] } } ); +Logs request parameters to debug logs =cut @@ -2370,13 +2208,15 @@ sub log_request_parameters { my $c = shift; my %all_params = @_; + return unless $c->debug; + my $column_width = Catalyst::Utils::term_width() - 44; foreach my $type (qw(query body)) { - my $filtered_params = $c->_apply_parameter_debug_filters( $type, $all_params{$type} || {} ); - next unless keys %$filtered_params; + my $params = $all_params{$type}; + next if ! keys %$params; my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] ); - for my $key ( sort keys %$filtered_params ) { - my $param = $filtered_params->{$key}; + 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 ); } @@ -2394,7 +2234,9 @@ the debug logs. sub log_request_uploads { my $c = shift; - my $uploads = $c->req->uploads; + my $request = shift; + return unless $c->debug; + my $uploads = $request->uploads; if ( keys %$uploads ) { my $t = Text::SimpleTable->new( [ 12, 'Parameter' ], @@ -2412,30 +2254,18 @@ sub log_request_uploads { } } +=head2 $c->log_request_headers($headers); + +Hook method which can be wrapped by plugins to log the request headers. +No-op in the default implementation. + +=cut + +sub log_request_headers {} + =head2 $c->log_headers($type => $headers) -Writes HTTP::Headers to debug logs, applying filters as configured. - -Similarly to how L is configured, you can -configure Catalyst to filter response header values to avoid writing -sensitive data to your logs (e.g. cookie values, etc.). The configuration -works in virtually the same way as the examples in -L. Here are a few specific examples: - - # filters all "Set-Cookie" headers from response logging - __PACKAGE__->config(Debug => { response_header_filters => 'Set-Cookie' } ); - - # filters only the value of the cookie (and leaves the name, path, expiration) - __PACKAGE__->config( - Debug => { - response_header_filters => sub { - my ( $n, $v ) = @_; - return unless $n eq 'Set-Cookie'; - $v =~ s/^.*?;//; - return $v; - }, - } - ); +Logs L (either request or response) to the debug logs. =cut @@ -2444,10 +2274,11 @@ sub log_headers { my $type = shift; my $headers = shift; # an HTTP::Headers instance - my $filtered = $c->_apply_header_debug_filters( $type, $headers ); + return unless $c->debug; - my $t = Text::SimpleTable->new( [ 35, 'Header Name' ], [ 40, 'Value' ] ); - $filtered->scan( + my $column_width = Catalyst::Utils::term_width() - 28; + my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] ); + $headers->scan( sub { my ( $name, $value ) = @_; $t->row( $name, $value ); @@ -2456,33 +2287,6 @@ sub log_headers { $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw ); } -# Applies debug filters to $headers and returns a new HTTP::Headers object which has (potentially) filtered values. -sub _apply_header_debug_filters { - my $c = shift; - my $type = shift; - my $headers = shift; - - my @header_filters = $c->_normalize_debug_filters( $c->config->{Debug}->{ $type . '_header_filters' } ); - my $filtered_headers = HTTP::Headers->new(); - foreach my $name ( $headers->header_field_names ) { - my @values = $headers->header($name); - - # headers can be multi-valued - foreach my $value (@values) { - foreach my $f (@header_filters) { - my $new_value = $f->( $name, $value ); - - # if a defined value is returned, we use that - if ( defined $new_value ) { - $value = $new_value; - last; # skip the rest of the filters - } - } - $filtered_headers->push_header( $name, $value ); - } - } - return $filtered_headers; -} =head2 $c->prepare_read @@ -2979,18 +2783,14 @@ the plugin name does not begin with C. my ( $proto, $plugin, $instant ) = @_; my $class = ref $proto || $proto; + # FIXME: also pass along plugin options as soon as the mop has it Class::MOP::load_class( $plugin ); $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" ) if $plugin->isa( 'Catalyst::Component' ); $proto->_plugins->{$plugin} = 1; unless ($instant) { - no strict 'refs'; - if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) { - my @superclasses = ($plugin, $meta->superclasses ); - $meta->superclasses(@superclasses); - } else { - unshift @{"$class\::ISA"}, $plugin; - } + my $meta = Class::MOP::get_metaclass_by_name($class); + $meta->superclasses($plugin, $meta->superclasses); } return $class; } @@ -2999,22 +2799,30 @@ the plugin name does not begin with C. my ( $class, $plugins ) = @_; $class->_plugins( {} ) unless $class->_plugins; - $plugins ||= []; - - my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins); + $plugins = Data::OptList::mkopt($plugins || []); + + my @plugins = map { + [ Catalyst::Utils::resolve_namespace( + $class . '::Plugin', + 'Catalyst::Plugin', $_->[0] + ), + $_->[1], + ] + } @{ $plugins }; for my $plugin ( reverse @plugins ) { - Class::MOP::load_class($plugin); - my $meta = find_meta($plugin); + # pass along $plugin->[1] as well once cmop supports it + Class::MOP::load_class($plugin->[0]); + my $meta = find_meta($plugin->[0]); next if $meta && $meta->isa('Moose::Meta::Role'); - $class->_register_plugin($plugin); + $class->_register_plugin($plugin->[0]); } my @roles = - map { $_->name } - grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') } - map { find_meta($_) } + map { $_->[0]->name, $_->[1] } + grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') } + map { [find_meta($_->[0]), $_->[1]] } @plugins; Moose::Util::apply_all_roles( @@ -3365,6 +3173,8 @@ Robert Sedlacek C<< >> sky: Arthur Bergman +szbalint: Balint Szilakszi + t0m: Tomas Doran Ulf Edvinsson