use Catalyst::Response;
use Catalyst::Utils;
use Catalyst::Controller;
+use Data::OptList;
use Devel::InnerPackage ();
use File::stat;
use Module::Pluggable::Object ();
#I imagine that very few of these really need to be class variables. if any.
#maybe we should just make them attributes with a default?
__PACKAGE__->mk_classdata($_)
- for qw/components arguments dispatcher engine log dispatcher_class
+ for qw/container components arguments dispatcher engine log dispatcher_class
engine_class context_class request_class response_class stats_class
setup_finished/;
# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.80020';
-our $PRETTY_VERSION = $VERSION;
-
-$VERSION = eval $VERSION;
+our $VERSION = '5.80032';
sub import {
my ( $class, @arguments ) = @_;
$meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
unless( $meta->has_method('meta') ){
- $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
+ if ($Moose::VERSION >= 1.15) {
+ $meta->_add_meta_method('meta');
+ }
+ else {
+ $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
+ }
}
$caller->arguments( [@arguments] );
=head2 -Stats
-Enables statistics collection and reporting. You can also force this setting
-from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
-environment settings override the application, with <MYAPP>_STATS having the
-highest priority.
+Enables statistics collection and reporting.
-e.g.
+ use Catalyst qw/-Stats=1/;
- use Catalyst qw/-Stats=1/
+You can also force this setting from the system environment with CATALYST_STATS
+or <MYAPP>_STATS. The environment settings override the application, with
+<MYAPP>_STATS having the highest priority.
+
+Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
=head1 METHODS
and access it from the stash.
+Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
+
=cut
sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
C<go> escapes the processing of the current request chain on completion, and
does not return to its caller.
+@arguments are arguments to the final destination of $action. @captures are
+arguments to the intermediate steps, if any, on the way to the final sub of
+$action.
+
=cut
sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
$c->error(0);
}
-sub _comp_search_prefixes {
- my $c = shift;
- return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
-}
-
-# search components given a name and some prefixes
-sub _comp_names_search_prefixes {
- my ( $c, $name, @prefixes ) = @_;
- my $appclass = ref $c || $c;
- my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
- $filter = qr/$filter/; # Compile regex now rather than once per loop
-
- # map the original component name to the sub part that we will search against
- my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
- grep { /$filter/ } keys %{ $c->components };
-
- # undef for a name will return all
- return keys %eligible if !defined $name;
-
- my $query = ref $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 ref $name;
-
- # skip regexp fallback if configured
- return
- if $appclass->config->{disable_component_resolution_regex_fallback};
-
- # regexp fallback
- $query = qr/$name/i;
- @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
-
- # no results? try against full names
- if( !@result ) {
- @result = grep { m{$query} } keys %eligible;
- }
-
- # don't warn if we didn't find any results, it just might not exist
- if( @result ) {
- # Disgusting hack to work out correct method name
- my $warn_for = lc $prefixes[0];
- my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
- (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
- "component resolution is unreliable and unsafe.";
- my $short = $result[0];
- # remove the component namespace prefix
- $short =~ s/.*?(Model|Controller|View):://;
- my $shortmess = Carp::shortmess('');
- if ($shortmess =~ m#Catalyst/Plugin#) {
- $msg .= " You probably need to set '$short' instead of '${name}' in this " .
- "plugin's config";
- } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
- $msg .= " You probably need to set '$short' instead of '${name}' in this " .
- "component's config";
- } else {
- $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
- "but if you really wanted to search, pass in a regexp as the argument " .
- "like so: \$c->${warn_for}(qr/${name}/)";
- }
- $c->log->warn( "${msg}$shortmess" );
- }
-
- return @result;
-}
-
-# Find possible names for a prefix
-sub _comp_names {
- my ( $c, @prefixes ) = @_;
- my $appclass = ref $c || $c;
-
- my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
-
- my @names = map { s{$filter}{}; $_; }
- $c->_comp_names_search_prefixes( undef, @prefixes );
-
- return @names;
-}
-
-# Filter a component before returning by calling ACCEPT_CONTEXT if available
-sub _filter_component {
- my ( $c, $comp, @args ) = @_;
-
- if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
- return $comp->ACCEPT_CONTEXT( $c, @args );
- }
-
- return $comp;
-}
-
=head2 COMPONENT ACCESSORS
=head2 $c->controller($name)
sub controller {
my ( $c, $name, @args ) = @_;
+ my $container = $c->container->get_sub_container('controller');
if( $name ) {
- 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 );
+ # Direct component hash lookup to avoid costly regexps
+ return $container->get_component( $name, $c, @args )
+ if $container->has_service($name) && !ref $name;
+
+ return $container->get_component_regexp( $name, $c, @args );
}
return $c->component( $c->action->class );
sub model {
my ( $c, $name, @args ) = @_;
my $appclass = ref($c) || $c;
+ my $container = $c->container->get_sub_container('model');
+
if( $name ) {
- 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 );
+ # Direct component hash lookup to avoid costly regexps
+ return $container->get_component( $name, $c, @args )
+ if $container->has_service($name) && !ref $name;
+
+ return $container->get_component_regexp( $name, $c, @args );
}
if (ref $c) {
return $c->model( $appclass->config->{default_model} )
if $appclass->config->{default_model};
- my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
+# FIXME: will this still be mantained?
+ my( $comp, $rest ) = $container->get_service_list;
if( $rest ) {
$c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
$c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
}
- return $c->_filter_component( $comp );
+ return $container->get_component( $comp, $c, @args );
}
sub view {
my ( $c, $name, @args ) = @_;
-
my $appclass = ref($c) || $c;
+ my $container = $c->container->get_sub_container('view');
+
if( $name ) {
- 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 );
+ # Direct component hash lookup to avoid costly regexps
+ return $container->get_component( $name, $c, @args )
+ if !ref $name && $container->has_service($name);
+
+ $c->log->warn( "Attempted to use view '$name', but does not exist" );
+
+ return $container->get_component_regexp( $name, $c, @args );
}
if (ref $c) {
return $c->view( $appclass->config->{default_view} )
if $appclass->config->{default_view};
- my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
+ my( $comp, $rest ) = $container->get_service_list;
if( $rest ) {
$c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
$c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
}
- return $c->_filter_component( $comp );
+ return $container->get_component( $comp, $c, @args );
}
=head2 $c->controllers
sub controllers {
my ( $c ) = @_;
- return $c->_comp_names(qw/Controller C/);
+ return $c->container->get_sub_container('controller')->get_service_list;
}
=head2 $c->models
sub models {
my ( $c ) = @_;
- return $c->_comp_names(qw/Model M/);
+ return $c->container->get_sub_container('model')->get_service_list;
}
sub views {
my ( $c ) = @_;
- return $c->_comp_names(qw/View V/);
+ return $c->container->get_sub_container('view')->get_service_list;
}
=head2 $c->comp($name)
=cut
sub component {
- my ( $c, $name, @args ) = @_;
+ my ( $c, $component, @args ) = @_;
+ unshift @args, $c;
- if( $name ) {
- my $comps = $c->components;
+ if ( $component ) {
+ my ($type, $name) = _get_component_type_name($component);
- if( !ref $name ) {
- # is it the exact name?
- return $c->_filter_component( $comps->{ $name }, @args )
- if exists $comps->{ $name };
+ if ($type && $c->container->has_sub_container($type)) {
+ my $container = $c->container->get_sub_container($type);
- # perhaps we just omitted "MyApp"?
- my $composed = ( ref $c || $c ) . "::${name}";
- return $c->_filter_component( $comps->{ $composed }, @args )
- if exists $comps->{ $composed };
+ if( !ref $component && $container->has_service($name) ) {
+ return $container->get_component( $name, \@args );
+ }
- # search all of the models, views and controllers
- my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
- return $c->_filter_component( $comp, @args ) if $comp;
+ return $container->get_component_regexp( $c, $name, \@args );
}
+ return
+ if $c->config->{disable_component_resolution_regex_fallback} && !ref $component;
+
# This is here so $c->comp( '::M::' ) works
- my $query = ref $name ? $name : qr{$name}i;
+ my $query = ref $component ? $component : qr{$component}i;
+
+ for my $subcontainer_name (qw/model view controller/) {
+ my $subcontainer = $c->container->get_sub_container($subcontainer_name);
+ my @components = $subcontainer->get_service_list;
+ my @result = grep { m{$query} } @components;
+
+ if (@result) {
+ return map { $subcontainer->get_component( $_, \@args ) } @result
+ if ref $component;
- my @result = grep { m{$query} } keys %{ $c->components };
- return map { $c->_filter_component( $_, @args ) } @result if ref $name;
+ $c->log->warn( Carp::shortmess(qq(Found results for "${component}" using regexp fallback)) );
+ $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
+ $c->log->warn( 'is unreliable and unsafe. You have been warned' );
- if( $result[ 0 ] ) {
- $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
- $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
- $c->log->warn( 'is unreliable and unsafe. You have been warned' );
- return $c->_filter_component( $result[ 0 ], @args );
+ return $subcontainer->get_component( $result[0], \@args );
+ }
}
# I would expect to return an empty list here, but that breaks back-compat
For example:
MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
- MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
+ MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
will mean that C<MyApp::Model::Foo> receives the following data when
constructed:
overrides => 'me',
});
+It's common practice to use a Moose attribute
+on the receiving component to access the config value.
+
+ package MyApp::Model::Foo;
+
+ use Moose;
+
+ # this attr will receive 'baz' at construction time
+ has 'bar' => (
+ is => 'rw',
+ isa => 'Str',
+ );
+
+You can then get the value 'baz' by calling $c->model('Foo')->bar
+(or $self->bar inside code in the model).
+
+B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
+as a way of reading config within your code, as this B<will not> give you the
+correctly merged config back. You B<MUST> take the config values supplied to
+the constructor and use those instead.
+
=cut
around config => sub {
}
}
+ $class->setup_config();
$class->setup_home( delete $flags->{home} );
$class->setup_log( delete $flags->{log} );
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,
A hook to attach modifiers to. This method does not do anything except set the
C<setup_finished> accessor.
-Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
+Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
Example:
Constructs an absolute L<URI> object based on the application root, the
provided path, and the additional arguments and query parameters provided.
-When used as a string, provides a textual URI.
+When used as a string, provides a textual URI. If you need more flexibility
+than this (i.e. the option to provide relative URIs etc.) see
+L<Catalyst::Plugin::SmartURI>.
If no arguments are provided, the URI for the current action is returned.
To return the current action and also provide @args, use
carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
foreach my $arg (@args) {
utf8::encode($arg) if utf8::is_utf8($arg);
- }
- s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
- if (blessed $path) { # Action object only.
- s|/|%2F|g for @args;
+ $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
}
if ( blessed($path) ) { # action object
+ s|/|%2F|g for @args;
my $captures = [ map { s|/|%2F|g; $_; }
( scalar @args && ref $args[0] eq 'ARRAY'
? @{ shift(@args) }
$path = '/' if $path eq '';
}
- undef($path) if (defined $path && $path eq '');
-
unshift(@args, $path);
unless (defined $path && $path =~ s!^/!!) { # in-place strip
<a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
<a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
they can save you a lot of work.</p>
- <pre><code>script/${prefix}_create.pl -help</code></pre>
+ <pre><code>script/${prefix}_create.pl --help</code></pre>
<p>Also, be sure to check out the vast and growing
collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
you are likely to find what you need there.
Returns a hash of components.
+=cut
+
+around components => sub {
+ my $orig = shift;
+ my $class = shift;
+ my $comps = shift;
+
+ return $class->$orig if ( !$comps );
+
+# FIXME: should this ugly kludge exist?
+ $class->setup_config unless defined $class->container;
+
+# FIXME: should there be a warning here, not to use this accessor to create the components?
+ my $components = {};
+
+ my $containers;
+ $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
+
+ for my $component ( keys %$comps ) {
+ $components->{ $component } = $comps->{$component};
+
+ my ($type, $name) = _get_component_type_name($component);
+
+# FIXME: shouldn't the service name be $name?
+ $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+ }
+
+ return $class->$orig($components);
+};
+
=head2 $c->context_class
Returns or sets the context class.
push( @{ $c->stack }, $code );
no warnings 'recursion';
- eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
+ # N.B. This used to be combined, but I have seen $c get clobbered if so, and
+ # I have no idea how, ergo $ret (which appears to fix the issue)
+ eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
$c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
$error = qq/Caught exception in $class->$name "$error"/;
}
$c->error($error);
- $c->state(0);
}
+ $c->state(0);
}
return $c->state;
}
my $parent = $c->stack->[-1];
# forward, locate the caller
- if ( exists $c->counter->{"$parent"} ) {
+ if ( defined $parent && exists $c->counter->{"$parent"} ) {
$c->stats->profile(
begin => $action,
parent => "$parent" . $c->counter->{"$parent"},
$c->finalize_body;
}
- $c->log_response;
+ $c->log_response;
if ($c->use_stats) {
my $elapsed = sprintf '%f', $c->stats->elapsed;
}
# Content-Length
- if ( $response->body && !$response->content_length ) {
+ if ( defined $response->body && length $response->body && !$response->content_length ) {
# get the length from a filehandle
- if ( blessed( $response->body ) && $response->body->can('read') )
+ if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
{
my $stat = stat $response->body;
if ( $stat && $stat->size > 0 ) {
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.
#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 );
}
$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:
=item * Query keywords (see L<Catalyst::Request/query_keywords>)
-=item * Request parameters (see L</log_request_parameters>)
+=item * Request parameters
=item * File uploads
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, $request->_has_body ? (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</log_headers>)
-
-=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.
-
- # filters a single param
- __PACKAGE__->config( Debug => { param_filters => 'param_name' } );
+ return unless $c->debug;
- # filters multiple params
- __PACKAGE__->config( Debug => { param_filters => [qw(param1 param2)] } );
+ my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
+ my $response = $dump->[1];
-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:
+ $c->log_response_status_line($response);
+ $c->log_response_headers($response->headers);
+}
- [debug] Query Parameters are:
- .-------------------------------------+--------------------------------------.
- | Parameter | Value |
- +-------------------------------------+--------------------------------------+
- | password | [FILTERED] |
- .-------------------------------------+--------------------------------------.
+=head2 $c->log_response_status_line($response)
-=head3 Filtering parameters by regular expression
+Writes one line of information about the response to the debug logs. This includes:
-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.
+=over 4
- # filters parameters starting with "private."
- __PACKAGE__->config( Debug => { param_filters => qr/^private\./ } );
+=item * Response status code
- # filters parameters named "param1" or starting with "private." or "secret."
- __PACKAGE__->config( Debug => { param_filters => [ 'param1', qr/^private\./, qr/^secret\./ ] } );
+=item * Content-Type 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.
+=item * Content-Length header (if present)
-=head3 Filtering parameters by callback
+=back
-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<undef> return value indicates that no change should be made to
-the value.
+=cut
- # transform any "password" param to "********"
- __PACKAGE__->config(
- Debug => {
- param_filters => sub { my ( $k, $v ) = @_; return unless $k eq 'password'; return '*' x 8; }
- }
- );
+sub log_response_status_line {
+ my ($c, $response) = @_;
- # 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; },
- ]
- }
+ $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'
+ )
);
+}
-An example of the debug log for a request with
-C<password=secret&some_other_param=some_other_value> 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
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 );
}
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' ],
}
}
+=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</log_request_parameters> 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</log_request_parameters>. 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<HTTP::Headers> (either request or response) to the debug logs.
=cut
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 );
$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
=head2 $c->request_class
-Returns or sets the request class.
+Returns or sets the request class. Defaults to L<Catalyst::Request>.
=head2 $c->response_class
-Returns or sets the response class.
+Returns or sets the response class. Defaults to L<Catalyst::Response>.
=head2 $c->read( [$maxlength] )
sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
+=head2 $c->setup_config
+
+=cut
+
+sub setup_config {
+ my $class = shift;
+
+ my %args = %{ $class->config || {} };
+
+ my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
+ unshift @container_classes, delete $args{container_class} if exists $args{container_class};
+
+ my $container_class = Class::MOP::load_first_existing_class(@container_classes);
+
+ my $container = $container_class->new( %args,
+ name => "$class",
+ disable_regex_fallback =>
+ $class->config->{disable_component_resolution_regex_fallback},
+ );
+ $class->container($container);
+
+ my $config = $container->resolve(service => 'config');
+ $class->config($config);
+ $class->finalize_config; # back-compat
+}
+
+=head2 $c->finalize_config
+
+=cut
+
+sub finalize_config { }
+
=head2 $c->setup_components
This method is called internally to set up the application's components.
my $config = $class->config->{ setup_components };
- my @comps = sort { length $a <=> length $b }
- $class->locate_components($config);
+ my @comps = $class->locate_components($config);
my %comps = map { $_ => 1 } @comps;
my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
# we know M::P::O found a file on disk so this is safe
Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
-
- # Needs to be done as soon as the component is loaded, as loading a sub-component
- # (next time round the loop) can cause us to get the wrong metaclass..
- $class->_controller_init_base_classes($component);
}
+ my $containers;
+ $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
+
for my $component (@comps) {
my $instance = $class->components->{ $component } = $class->setup_component($component);
+ if ( my ($type, $name) = _get_component_type_name($component) ) {
+ $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
+ }
my @expanded_components = $instance->can('expand_modules')
? $instance->expand_modules( $component, $config )
: $class->expand_component_module( $component, $config );
for my $component (@expanded_components) {
next if $comps{$component};
- $class->_controller_init_base_classes($component); # Also cover inner packages
+
+ $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
+ $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
+ qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
+ ) if $deprecatedcatalyst_component_names;
+
+ if (my ($type, $name) = _get_component_type_name($component)) {
+ $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+ }
+
$class->components->{ $component } = $class->setup_component($component);
}
}
}
+sub _get_component_type_name {
+ my $component = shift;
+ my @parts = split /::/, $component;
+
+ while (my $type = shift @parts) {
+ return ('controller', join '::', @parts)
+ if $type =~ /^(c|controller)$/i;
+
+ return ('model', join '::', @parts)
+ if $type =~ /^(m|model)$/i;
+
+ return ('view', join '::', @parts)
+ if $type =~ /^(v|view)$/i;
+ }
+}
+
=head2 $c->locate_components( $setup_component_config )
This method is meant to provide a list of component modules that should be
%$config
);
- my @comps = $locator->plugins;
+ # XXX think about ditching this sort entirely
+ my @comps = sort { length $a <=> length $b } $locator->plugins;
return @comps;
}
=cut
-# FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
-# nearest to Catalyst::Controller first, no matter what order stuff happens
-# to be loaded. There are TODO tests in Moose for this, see
-# f2391d17574eff81d911b97be15ea51080500003
-sub _controller_init_base_classes {
- my ($app_class, $component) = @_;
- return unless $component->isa('Catalyst::Controller');
- foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
- Moose::Meta::Class->initialize( $class )
- unless find_meta($class);
- }
-}
-
sub setup_component {
my( $class, $component ) = @_;
message => qq/Couldn't instantiate component "$component", "$error"/
);
}
-
- unless (blessed $instance) {
+ elsif (!blessed $instance) {
my $metaclass = Moose::Util::find_meta($component);
my $method_meta = $metaclass->find_method_by_name('COMPONENT');
my $component_method_from = $method_meta->associated_metaclass->name;
qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
);
}
+
return $instance;
}
my $class = ref $proto || $proto;
Class::MOP::load_class( $plugin );
- $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
+ $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated 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;
}
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);
+ Class::MOP::load_class($plugin->[0], $plugin->[1]);
+ 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(
Returns an arrayref of the internal execution stack (actions that are
currently executing).
+=head2 $c->stats
+
+Returns the current timing statistics object. By default Catalyst uses
+L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
+L<< stats_class|/"$c->stats_class" >>.
+
+Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
+available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
+profile explicitly, although MyApp.pm still won't profile nor output anything
+by itself.
+
=head2 $c->stats_class
-Returns or sets the stats (timing statistics) class.
+Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
=head2 $c->use_stats
-Returns 1 when stats collection is enabled. Stats collection is enabled
-when the -Stats options is set, debug is on or when the <MYAPP>_STATS
-environment variable is set.
+Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
Note that this is a static method, not an accessor and should be overridden
by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
=item *
+C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
+variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
+for more information.
+
+=item *
+
C<using_frontend_proxy> - See L</PROXY SUPPORT>.
=back
Andrew Ruthven
+André Walker
+
andyg: Andy Grundman <andy@hybridized.org>
audreyt: Audrey Tang
Robert Sedlacek C<< <rs@474.at> >>
+SpiceMan: Marcel Montes
+
sky: Arthur Bergman
+szbalint: Balint Szilakszi <szbalint@cpan.org>
+
t0m: Tomas Doran <bobtfish@bobtfish.net>
Ulf Edvinsson
willert: Sebastian Willert <willert@cpan.org>
+wreis: Wallace Reis <wallace@reis.org.br>
+
Yuval Kogman, C<nothingmuch@woobling.org>
+rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
+
+dd070: Dhaval Dhanani <dhaval070@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
+
=head1 LICENSE
This library is free software. You can redistribute it and/or modify it under