4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
26 use Tree::Simple qw/use_weak_refs/;
27 use Tree::Simple::Visitor::FindByUID;
28 use Class::C3::Adopt::NEXT;
29 use List::MoreUtils qw/uniq/;
31 use String::RewritePrefix;
32 use Catalyst::EngineLoader;
34 use Carp qw/croak carp shortmess/;
36 use Plack::Middleware::Conditional;
37 use Plack::Middleware::ReverseProxy;
38 use Plack::Middleware::IIS6ScriptNameFix;
39 use Plack::Middleware::LighttpdScriptNameFix;
41 BEGIN { require 5.008003; }
43 has stack => (is => 'ro', default => sub { [] });
44 has stash => (is => 'rw', default => sub { {} });
45 has state => (is => 'rw', default => 0);
46 has stats => (is => 'rw');
47 has action => (is => 'rw');
48 has counter => (is => 'rw', default => sub { {} });
53 my %p = ( _log => $self->log );
54 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
55 $self->request_class->new(\%p);
63 $self->response_class->new({ _log => $self->log });
67 has namespace => (is => 'rw');
69 sub depth { scalar @{ shift->stack || [] }; }
70 sub comp { shift->component(@_) }
73 my $self = shift; return $self->request(@_);
76 my $self = shift; return $self->response(@_);
79 # For backwards compatibility
80 sub finalize_output { shift->finalize_body(@_) };
85 our $RECURSION = 1000;
86 our $DETACH = Catalyst::Exception::Detach->new;
87 our $GO = Catalyst::Exception::Go->new;
89 #I imagine that very few of these really need to be class variables. if any.
90 #maybe we should just make them attributes with a default?
91 __PACKAGE__->mk_classdata($_)
92 for qw/components arguments dispatcher engine log dispatcher_class
93 engine_loader context_class request_class response_class stats_class
94 setup_finished _psgi_app loading_psgi_file run_options/;
96 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
97 __PACKAGE__->request_class('Catalyst::Request');
98 __PACKAGE__->response_class('Catalyst::Response');
99 __PACKAGE__->stats_class('Catalyst::Stats');
101 # Remember to update this in Catalyst::Runtime as well!
103 our $VERSION = '5.90011';
106 my ( $class, @arguments ) = @_;
108 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
110 return unless $class eq 'Catalyst';
112 my $caller = caller();
113 return if $caller eq 'main';
115 my $meta = Moose::Meta::Class->initialize($caller);
116 unless ( $caller->isa('Catalyst') ) {
117 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
118 $meta->superclasses(@superclasses);
120 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
121 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
123 unless( $meta->has_method('meta') ){
124 if ($Moose::VERSION >= 1.15) {
125 $meta->_add_meta_method('meta');
128 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
132 $caller->arguments( [@arguments] );
136 sub _application { $_[0] }
140 Catalyst - The Elegant MVC Web Application Framework
144 See the L<Catalyst::Manual> distribution for comprehensive
145 documentation and tutorials.
147 # Install Catalyst::Devel for helpers and other development tools
148 # use the helper to create a new application
151 # add models, views, controllers
152 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
153 script/myapp_create.pl view MyTemplate TT
154 script/myapp_create.pl controller Search
156 # built in testserver -- use -r to restart automatically on changes
157 # --help to see all available options
158 script/myapp_server.pl
160 # command line testing interface
161 script/myapp_test.pl /yada
164 use Catalyst qw/-Debug/; # include plugins here as well
166 ### In lib/MyApp/Controller/Root.pm (autocreated)
167 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
168 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
169 $c->stash->{template} = 'foo.tt'; # set the template
170 # lookup something from db -- stash vars are passed to TT
172 $c->model('Database::Foo')->search( { country => $args[0] } );
173 if ( $c->req->params->{bar} ) { # access GET or POST parameters
174 $c->forward( 'bar' ); # process another action
175 # do something else after forward returns
179 # The foo.tt TT template can use the stash data from the database
180 [% WHILE (item = data.next) %]
184 # called for /bar/of/soap, /bar/of/soap/10, etc.
185 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
187 # called after all actions are finished
189 my ( $self, $c ) = @_;
190 if ( scalar @{ $c->error } ) { ... } # handle errors
191 return if $c->res->body; # already have a response
192 $c->forward( 'MyApp::View::TT' ); # render template
195 See L<Catalyst::Manual::Intro> for additional information.
199 Catalyst is a modern framework for making web applications without the
200 pain usually associated with this process. This document is a reference
201 to the main Catalyst application. If you are a new user, we suggest you
202 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
204 See L<Catalyst::Manual> for more documentation.
206 Catalyst plugins can be loaded by naming them as arguments to the "use
207 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
208 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
211 use Catalyst qw/My::Module/;
213 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
214 fully qualify the name by using a unary plus:
218 +Fully::Qualified::Plugin::Name
221 Special flags like C<-Debug> can also be specified as
222 arguments when Catalyst is loaded:
224 use Catalyst qw/-Debug My::Module/;
226 The position of plugins and flags in the chain is important, because
227 they are loaded in the order in which they appear.
229 The following flags are supported:
233 Enables debug output. You can also force this setting from the system
234 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
235 settings override the application, with <MYAPP>_DEBUG having the highest
238 This sets the log level to 'debug' and enables full debug output on the
239 error screen. If you only want the latter, see L<< $c->debug >>.
243 Forces Catalyst to use a specific home directory, e.g.:
245 use Catalyst qw[-Home=/usr/mst];
247 This can also be done in the shell environment by setting either the
248 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
249 is replaced with the uppercased name of your application, any "::" in
250 the name will be replaced with underscores, e.g. MyApp::Web should use
251 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
253 If none of these are set, Catalyst will attempt to automatically detect the
254 home directory. If you are working in a development environment, Catalyst
255 will try and find the directory containing either Makefile.PL, Build.PL or
256 dist.ini. If the application has been installed into the system (i.e.
257 you have done C<make install>), then Catalyst will use the path to your
258 application module, without the .pm extension (e.g., /foo/MyApp if your
259 application was installed at /foo/MyApp.pm)
263 use Catalyst '-Log=warn,fatal,error';
265 Specifies a comma-delimited list of log levels.
269 Enables statistics collection and reporting.
271 use Catalyst qw/-Stats=1/;
273 You can also force this setting from the system environment with CATALYST_STATS
274 or <MYAPP>_STATS. The environment settings override the application, with
275 <MYAPP>_STATS having the highest priority.
277 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
281 =head2 INFORMATION ABOUT THE CURRENT REQUEST
285 Returns a L<Catalyst::Action> object for the current action, which
286 stringifies to the action name. See L<Catalyst::Action>.
290 Returns the namespace of the current action, i.e., the URI prefix
291 corresponding to the controller of the current action. For example:
293 # in Controller::Foo::Bar
294 $c->namespace; # returns 'foo/bar';
300 Returns the current L<Catalyst::Request> object, giving access to
301 information about the current client request (including parameters,
302 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
304 =head2 REQUEST FLOW HANDLING
306 =head2 $c->forward( $action [, \@arguments ] )
308 =head2 $c->forward( $class, $method, [, \@arguments ] )
310 Forwards processing to another action, by its private name. If you give a
311 class name but no method, C<process()> is called. You may also optionally
312 pass arguments in an arrayref. The action will receive the arguments in
313 C<@_> and C<< $c->req->args >>. Upon returning from the function,
314 C<< $c->req->args >> will be restored to the previous values.
316 Any data C<return>ed from the action forwarded to, will be returned by the
319 my $foodata = $c->forward('/foo');
320 $c->forward('index');
321 $c->forward(qw/Model::DBIC::Foo do_stuff/);
322 $c->forward('View::TT');
324 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
325 an C<< eval { } >> around the call (actually
326 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
327 exceptions thrown by the called action non-fatal and pushing them onto
328 $c->error instead. If you want C<die> to propagate you need to do something
332 die join "\n", @{ $c->error } if @{ $c->error };
334 Or make sure to always return true values from your actions and write
337 $c->forward('foo') || return;
339 Another note is that C<< $c->forward >> always returns a scalar because it
340 actually returns $c->state which operates in a scalar context.
341 Thus, something like:
345 in an action that is forwarded to is going to return a scalar,
346 i.e. how many items are in that array, which is probably not what you want.
347 If you need to return an array then return a reference to it,
350 $c->stash->{array} = \@array;
352 and access it from the stash.
354 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.
358 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
360 =head2 $c->detach( $action [, \@arguments ] )
362 =head2 $c->detach( $class, $method, [, \@arguments ] )
366 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
367 doesn't return to the previous action when processing is finished.
369 When called with no arguments it escapes the processing chain entirely.
373 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
375 =head2 $c->visit( $action [, \@arguments ] )
377 =head2 $c->visit( $action [, \@captures, \@arguments ] )
379 =head2 $c->visit( $class, $method, [, \@arguments ] )
381 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
383 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
384 but does a full dispatch, instead of just calling the new C<$action> /
385 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
386 you go to are called, just like a new request.
388 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
389 This means, for example, that C<< $c->action >> methods such as
390 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
391 L<reverse|Catalyst::Action/reverse> return information for the visited action
392 when they are invoked within the visited action. This is different from the
393 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
394 continues to use the $c->action object from the caller action even when
395 invoked from the called action.
397 C<< $c->stash >> is kept unchanged.
399 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
400 allows you to "wrap" another action, just as it would have been called by
401 dispatching from a URL, while the analogous
402 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
403 transfer control to another action as if it had been reached directly from a URL.
407 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
409 =head2 $c->go( $action [, \@arguments ] )
411 =head2 $c->go( $action [, \@captures, \@arguments ] )
413 =head2 $c->go( $class, $method, [, \@arguments ] )
415 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
417 The relationship between C<go> and
418 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
419 the relationship between
420 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
421 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
422 C<< $c->go >> will perform a full dispatch on the specified action or method,
423 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
424 C<go> escapes the processing of the current request chain on completion, and
425 does not return to its caller.
427 @arguments are arguments to the final destination of $action. @captures are
428 arguments to the intermediate steps, if any, on the way to the final sub of
433 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
439 Returns the current L<Catalyst::Response> object, see there for details.
443 Returns a hashref to the stash, which may be used to store data and pass
444 it between components during a request. You can also set hash keys by
445 passing arguments. The stash is automatically sent to the view. The
446 stash is cleared at the end of a request; it cannot be used for
447 persistent storage (for this you must use a session; see
448 L<Catalyst::Plugin::Session> for a complete system integrated with
451 $c->stash->{foo} = $bar;
452 $c->stash( { moose => 'majestic', qux => 0 } );
453 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
455 # stash is automatically passed to the view for use in a template
456 $c->forward( 'MyApp::View::TT' );
460 around stash => sub {
463 my $stash = $orig->($c);
465 my $new_stash = @_ > 1 ? {@_} : $_[0];
466 croak('stash takes a hash or hashref') unless ref $new_stash;
467 foreach my $key ( keys %$new_stash ) {
468 $stash->{$key} = $new_stash->{$key};
478 =head2 $c->error($error, ...)
480 =head2 $c->error($arrayref)
482 Returns an arrayref containing error messages. If Catalyst encounters an
483 error while processing a request, it stores the error in $c->error. This
484 method should only be used to store fatal error messages.
486 my @error = @{ $c->error };
490 $c->error('Something bad happened');
497 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
498 croak @$error unless ref $c;
499 push @{ $c->{error} }, @$error;
501 elsif ( defined $_[0] ) { $c->{error} = undef }
502 return $c->{error} || [];
508 Contains the return value of the last executed action.
509 Note that << $c->state >> operates in a scalar context which means that all
510 values it returns are scalar.
512 =head2 $c->clear_errors
514 Clear errors. You probably don't want to clear the errors unless you are
515 implementing a custom error screen.
517 This is equivalent to running
528 sub _comp_search_prefixes {
530 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
533 # search components given a name and some prefixes
534 sub _comp_names_search_prefixes {
535 my ( $c, $name, @prefixes ) = @_;
536 my $appclass = ref $c || $c;
537 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
538 $filter = qr/$filter/; # Compile regex now rather than once per loop
540 # map the original component name to the sub part that we will search against
541 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
542 grep { /$filter/ } keys %{ $c->components };
544 # undef for a name will return all
545 return keys %eligible if !defined $name;
547 my $query = ref $name ? $name : qr/^$name$/i;
548 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
550 return @result if @result;
552 # if we were given a regexp to search against, we're done.
555 # skip regexp fallback if configured
557 if $appclass->config->{disable_component_resolution_regex_fallback};
561 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
563 # no results? try against full names
565 @result = grep { m{$query} } keys %eligible;
568 # don't warn if we didn't find any results, it just might not exist
570 # Disgusting hack to work out correct method name
571 my $warn_for = lc $prefixes[0];
572 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
573 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
574 "component resolution is unreliable and unsafe.";
575 my $short = $result[0];
576 # remove the component namespace prefix
577 $short =~ s/.*?(Model|Controller|View):://;
578 my $shortmess = Carp::shortmess('');
579 if ($shortmess =~ m#Catalyst/Plugin#) {
580 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
582 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
583 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
584 "component's config";
586 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
587 "but if you really wanted to search, pass in a regexp as the argument " .
588 "like so: \$c->${warn_for}(qr/${name}/)";
590 $c->log->warn( "${msg}$shortmess" );
596 # Find possible names for a prefix
598 my ( $c, @prefixes ) = @_;
599 my $appclass = ref $c || $c;
601 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
603 my @names = map { s{$filter}{}; $_; }
604 $c->_comp_names_search_prefixes( undef, @prefixes );
609 # Filter a component before returning by calling ACCEPT_CONTEXT if available
610 sub _filter_component {
611 my ( $c, $comp, @args ) = @_;
613 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
614 return $comp->ACCEPT_CONTEXT( $c, @args );
620 =head2 COMPONENT ACCESSORS
622 =head2 $c->controller($name)
624 Gets a L<Catalyst::Controller> instance by name.
626 $c->controller('Foo')->do_stuff;
628 If the name is omitted, will return the controller for the dispatched
631 If you want to search for controllers, pass in a regexp as the argument.
633 # find all controllers that start with Foo
634 my @foo_controllers = $c->controller(qr{^Foo});
640 my ( $c, $name, @args ) = @_;
642 my $appclass = ref($c) || $c;
644 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
645 my $comps = $c->components;
646 my $check = $appclass."::Controller::".$name;
647 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
649 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
650 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
651 return $c->_filter_component( $result[ 0 ], @args );
654 return $c->component( $c->action->class );
657 =head2 $c->model($name)
659 Gets a L<Catalyst::Model> instance by name.
661 $c->model('Foo')->do_stuff;
663 Any extra arguments are directly passed to ACCEPT_CONTEXT.
665 If the name is omitted, it will look for
666 - a model object in $c->stash->{current_model_instance}, then
667 - a model name in $c->stash->{current_model}, then
668 - a config setting 'default_model', or
669 - check if there is only one model, and return it if that's the case.
671 If you want to search for models, pass in a regexp as the argument.
673 # find all models that start with Foo
674 my @foo_models = $c->model(qr{^Foo});
679 my ( $c, $name, @args ) = @_;
680 my $appclass = ref($c) || $c;
682 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
683 my $comps = $c->components;
684 my $check = $appclass."::Model::".$name;
685 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
687 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
688 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
689 return $c->_filter_component( $result[ 0 ], @args );
693 return $c->stash->{current_model_instance}
694 if $c->stash->{current_model_instance};
695 return $c->model( $c->stash->{current_model} )
696 if $c->stash->{current_model};
698 return $c->model( $appclass->config->{default_model} )
699 if $appclass->config->{default_model};
701 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
704 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
705 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
706 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
707 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
708 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
711 return $c->_filter_component( $comp );
715 =head2 $c->view($name)
717 Gets a L<Catalyst::View> instance by name.
719 $c->view('Foo')->do_stuff;
721 Any extra arguments are directly passed to ACCEPT_CONTEXT.
723 If the name is omitted, it will look for
724 - a view object in $c->stash->{current_view_instance}, then
725 - a view name in $c->stash->{current_view}, then
726 - a config setting 'default_view', or
727 - check if there is only one view, and return it if that's the case.
729 If you want to search for views, pass in a regexp as the argument.
731 # find all views that start with Foo
732 my @foo_views = $c->view(qr{^Foo});
737 my ( $c, $name, @args ) = @_;
739 my $appclass = ref($c) || $c;
741 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
742 my $comps = $c->components;
743 my $check = $appclass."::View::".$name;
744 if( exists $comps->{$check} ) {
745 return $c->_filter_component( $comps->{$check}, @args );
748 $c->log->warn( "Attempted to use view '$check', but does not exist" );
751 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
752 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
753 return $c->_filter_component( $result[ 0 ], @args );
757 return $c->stash->{current_view_instance}
758 if $c->stash->{current_view_instance};
759 return $c->view( $c->stash->{current_view} )
760 if $c->stash->{current_view};
762 return $c->view( $appclass->config->{default_view} )
763 if $appclass->config->{default_view};
765 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
768 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
769 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
770 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
771 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
772 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
775 return $c->_filter_component( $comp );
778 =head2 $c->controllers
780 Returns the available names which can be passed to $c->controller
786 return $c->_comp_names(qw/Controller C/);
791 Returns the available names which can be passed to $c->model
797 return $c->_comp_names(qw/Model M/);
803 Returns the available names which can be passed to $c->view
809 return $c->_comp_names(qw/View V/);
812 =head2 $c->comp($name)
814 =head2 $c->component($name)
816 Gets a component object by name. This method is not recommended,
817 unless you want to get a specific component by full
818 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
819 should be used instead.
821 If C<$name> is a regexp, a list of components matched against the full
822 component name will be returned.
824 If Catalyst can't find a component by name, it will fallback to regex
825 matching by default. To disable this behaviour set
826 disable_component_resolution_regex_fallback to a true value.
828 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
833 my ( $c, $name, @args ) = @_;
836 my $comps = $c->components;
839 # is it the exact name?
840 return $c->_filter_component( $comps->{ $name }, @args )
841 if exists $comps->{ $name };
843 # perhaps we just omitted "MyApp"?
844 my $composed = ( ref $c || $c ) . "::${name}";
845 return $c->_filter_component( $comps->{ $composed }, @args )
846 if exists $comps->{ $composed };
848 # search all of the models, views and controllers
849 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
850 return $c->_filter_component( $comp, @args ) if $comp;
854 if $c->config->{disable_component_resolution_regex_fallback};
856 # This is here so $c->comp( '::M::' ) works
857 my $query = ref $name ? $name : qr{$name}i;
859 my @result = grep { m{$query} } keys %{ $c->components };
860 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
863 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
864 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
865 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
866 return $c->_filter_component( $result[ 0 ], @args );
869 # I would expect to return an empty list here, but that breaks back-compat
873 return sort keys %{ $c->components };
876 =head2 CLASS DATA AND HELPER CLASSES
880 Returns or takes a hashref containing the application's configuration.
882 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
884 You can also use a C<YAML>, C<XML> or L<Config::General> config file
885 like C<myapp.conf> in your applications home directory. See
886 L<Catalyst::Plugin::ConfigLoader>.
888 =head3 Cascading configuration
890 The config method is present on all Catalyst components, and configuration
891 will be merged when an application is started. Configuration loaded with
892 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
893 followed by configuration in your top level C<MyApp> class. These two
894 configurations are merged, and then configuration data whose hash key matches a
895 component name is merged with configuration for that component.
897 The configuration for a component is then passed to the C<new> method when a
898 component is constructed.
902 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
903 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
905 will mean that C<MyApp::Model::Foo> receives the following data when
908 MyApp::Model::Foo->new({
914 It's common practice to use a Moose attribute
915 on the receiving component to access the config value.
917 package MyApp::Model::Foo;
921 # this attr will receive 'baz' at construction time
927 You can then get the value 'baz' by calling $c->model('Foo')->bar
928 (or $self->bar inside code in the model).
930 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
931 as a way of reading config within your code, as this B<will not> give you the
932 correctly merged config back. You B<MUST> take the config values supplied to
933 the constructor and use those instead.
937 around config => sub {
941 croak('Setting config after setup has been run is not allowed.')
942 if ( @_ and $c->setup_finished );
949 Returns the logging object instance. Unless it is already set, Catalyst
950 sets this up with a L<Catalyst::Log> object. To use your own log class,
951 set the logger with the C<< __PACKAGE__->log >> method prior to calling
952 C<< __PACKAGE__->setup >>.
954 __PACKAGE__->log( MyLogger->new );
959 $c->log->info( 'Now logging with my own logger!' );
961 Your log class should implement the methods described in
967 Returns 1 if debug mode is enabled, 0 otherwise.
969 You can enable debug mode in several ways:
973 =item By calling myapp_server.pl with the -d flag
975 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
977 =item The -Debug option in your MyApp.pm
979 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
983 The first three also set the log level to 'debug'.
985 Calling C<< $c->debug(1) >> has no effect.
991 =head2 $c->dispatcher
993 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
997 Returns the engine instance. See L<Catalyst::Engine>.
1000 =head2 UTILITY METHODS
1002 =head2 $c->path_to(@path)
1004 Merges C<@path> with C<< $c->config->{home} >> and returns a
1005 L<Path::Class::Dir> object. Note you can usually use this object as
1006 a filename, but sometimes you will have to explicitly stringify it
1007 yourself by calling the C<< ->stringify >> method.
1011 $c->path_to( 'db', 'sqlite.db' );
1016 my ( $c, @path ) = @_;
1017 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1018 if ( -d $path ) { return $path }
1019 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1023 my ( $class, $name, $plugin, @args ) = @_;
1025 # See block comment in t/unit_core_plugin.t
1026 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1028 $class->_register_plugin( $plugin, 1 );
1030 eval { $plugin->import };
1031 $class->mk_classdata($name);
1033 eval { $obj = $plugin->new(@args) };
1036 Catalyst::Exception->throw( message =>
1037 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1040 $class->$name($obj);
1041 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1047 Initializes the dispatcher and engine, loads any plugins, and loads the
1048 model, view, and controller components. You may also specify an array
1049 of plugins to load here, if you choose to not load them in the C<use
1053 MyApp->setup( qw/-Debug/ );
1055 B<Note:> You B<should not> wrap this method with method modifiers
1056 or bad things will happen - wrap the C<setup_finalize> method instead.
1061 my ( $class, @arguments ) = @_;
1062 croak('Running setup more than once')
1063 if ( $class->setup_finished );
1065 unless ( $class->isa('Catalyst') ) {
1067 Catalyst::Exception->throw(
1068 message => qq/'$class' does not inherit from Catalyst/ );
1071 if ( $class->arguments ) {
1072 @arguments = ( @arguments, @{ $class->arguments } );
1078 foreach (@arguments) {
1082 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1084 elsif (/^-(\w+)=?(.*)$/) {
1085 $flags->{ lc $1 } = $2;
1088 push @{ $flags->{plugins} }, $_;
1092 $class->setup_home( delete $flags->{home} );
1094 $class->setup_log( delete $flags->{log} );
1095 $class->setup_plugins( delete $flags->{plugins} );
1096 $class->setup_dispatcher( delete $flags->{dispatcher} );
1097 if (my $engine = delete $flags->{engine}) {
1098 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1100 $class->setup_engine();
1101 $class->setup_stats( delete $flags->{stats} );
1103 for my $flag ( sort keys %{$flags} ) {
1105 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1106 &$code( $class, delete $flags->{$flag} );
1109 $class->log->warn(qq/Unknown flag "$flag"/);
1113 eval { require Catalyst::Devel; };
1114 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1115 $class->log->warn(<<"EOF");
1116 You are running an old script!
1118 Please update by running (this will overwrite existing files):
1119 catalyst.pl -force -scripts $class
1121 or (this will not overwrite existing files):
1122 catalyst.pl -scripts $class
1127 if ( $class->debug ) {
1128 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1131 my $column_width = Catalyst::Utils::term_width() - 6;
1132 my $t = Text::SimpleTable->new($column_width);
1133 $t->row($_) for @plugins;
1134 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1137 my $dispatcher = $class->dispatcher;
1138 my $engine = $class->engine;
1139 my $home = $class->config->{home};
1141 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1142 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1146 ? $class->log->debug(qq/Found home "$home"/)
1147 : $class->log->debug(qq/Home "$home" doesn't exist/)
1148 : $class->log->debug(q/Couldn't find home/);
1151 # Call plugins setup, this is stupid and evil.
1152 # Also screws C3 badly on 5.10, hack to avoid.
1154 no warnings qw/redefine/;
1155 local *setup = sub { };
1156 $class->setup unless $Catalyst::__AM_RESTARTING;
1159 # Initialize our data structure
1160 $class->components( {} );
1162 $class->setup_components;
1164 if ( $class->debug ) {
1165 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1166 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1167 for my $comp ( sort keys %{ $class->components } ) {
1168 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1169 $t->row( $comp, $type );
1171 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1172 if ( keys %{ $class->components } );
1175 # Add our self to components, since we are also a component
1176 if( $class->isa('Catalyst::Controller') ){
1177 $class->components->{$class} = $class;
1180 $class->setup_actions;
1182 if ( $class->debug ) {
1183 my $name = $class->config->{name} || 'Application';
1184 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1187 # Make sure that the application class becomes immutable at this point,
1188 B::Hooks::EndOfScope::on_scope_end {
1190 my $meta = Class::MOP::get_metaclass_by_name($class);
1193 && ! { $meta->immutable_options }->{replace_constructor}
1195 $class->isa('Class::Accessor::Fast')
1196 || $class->isa('Class::Accessor')
1199 warn "You made your application class ($class) immutable, "
1200 . "but did not inline the\nconstructor. "
1201 . "This will break catalyst, as your app \@ISA "
1202 . "Class::Accessor(::Fast)?\nPlease pass "
1203 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1205 $meta->make_immutable(
1206 replace_constructor => 1,
1207 ) unless $meta->is_immutable;
1210 if ($class->config->{case_sensitive}) {
1211 $class->log->warn($class . "->config->{case_sensitive} is set.");
1212 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1215 $class->setup_finalize;
1216 # Should be the last thing we do so that user things hooking
1217 # setup_finalize can log..
1218 $class->log->_flush() if $class->log->can('_flush');
1219 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1222 =head2 $app->setup_finalize
1224 A hook to attach modifiers to. This method does not do anything except set the
1225 C<setup_finished> accessor.
1227 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1231 after setup_finalize => sub {
1239 sub setup_finalize {
1241 $class->setup_finished(1);
1244 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1246 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1248 Constructs an absolute L<URI> object based on the application root, the
1249 provided path, and the additional arguments and query parameters provided.
1250 When used as a string, provides a textual URI. If you need more flexibility
1251 than this (i.e. the option to provide relative URIs etc.) see
1252 L<Catalyst::Plugin::SmartURI>.
1254 If no arguments are provided, the URI for the current action is returned.
1255 To return the current action and also provide @args, use
1256 C<< $c->uri_for( $c->action, @args ) >>.
1258 If the first argument is a string, it is taken as a public URI path relative
1259 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1260 relative to the application root (if it does). It is then merged with
1261 C<< $c->request->base >>; any C<@args> are appended as additional path
1262 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1264 If the first argument is a L<Catalyst::Action> it represents an action which
1265 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1266 optional C<\@captures> argument (an arrayref) allows passing the captured
1267 variables that are needed to fill in the paths of Chained and Regex actions;
1268 once the path is resolved, C<uri_for> continues as though a path was
1269 provided, appending any arguments or parameters and creating an absolute
1272 The captures for the current request can be found in
1273 C<< $c->request->captures >>, and actions can be resolved using
1274 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1275 path, use C<< $c->uri_for_action >> instead.
1277 # Equivalent to $c->req->uri
1278 $c->uri_for($c->action, $c->req->captures,
1279 @{ $c->req->args }, $c->req->params);
1281 # For the Foo action in the Bar controller
1282 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1284 # Path to a static resource
1285 $c->uri_for('/static/images/logo.png');
1290 my ( $c, $path, @args ) = @_;
1292 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1293 $path = $path->path_prefix;
1298 undef($path) if (defined $path && $path eq '');
1301 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1303 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1304 foreach my $arg (@args) {
1305 utf8::encode($arg) if utf8::is_utf8($arg);
1306 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1309 if ( blessed($path) ) { # action object
1310 s|/|%2F|g for @args;
1311 my $captures = [ map { s|/|%2F|g; $_; }
1312 ( scalar @args && ref $args[0] eq 'ARRAY'
1316 foreach my $capture (@$captures) {
1317 utf8::encode($capture) if utf8::is_utf8($capture);
1318 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1322 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1323 if( !@args && $action->number_of_args ) {
1324 my $expanded_action = $c->dispatcher->expand_action( $action );
1326 my $num_captures = $expanded_action->number_of_captures;
1327 unshift @args, splice @$captures, $num_captures;
1330 $path = $c->dispatcher->uri_for_action($action, $captures);
1331 if (not defined $path) {
1332 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1336 $path = '/' if $path eq '';
1339 unshift(@args, $path);
1341 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1342 my $namespace = $c->namespace;
1343 if (defined $path) { # cheesy hack to handle path '../foo'
1344 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1346 unshift(@args, $namespace || '');
1349 # join args with '/', or a blank string
1350 my $args = join('/', grep { defined($_) } @args);
1351 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1353 my $base = $c->req->base;
1354 my $class = ref($base);
1355 $base =~ s{(?<!/)$}{/};
1359 if (my @keys = keys %$params) {
1360 # somewhat lifted from URI::_query's query_form
1361 $query = '?'.join('&', map {
1362 my $val = $params->{$_};
1363 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1366 $val = '' unless defined $val;
1369 utf8::encode( $param ) if utf8::is_utf8($param);
1370 # using the URI::Escape pattern here so utf8 chars survive
1371 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1373 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1377 my $res = bless(\"${base}${args}${query}", $class);
1381 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1383 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1389 A private path to the Catalyst action you want to create a URI for.
1391 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1392 >> and passing the resulting C<$action> and the remaining arguments to C<<
1395 You can also pass in a Catalyst::Action object, in which case it is passed to
1398 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
1400 For example, if the action looks like:
1402 package MyApp::Controller::Users;
1404 sub lst : Path('the-list') {}
1408 $c->uri_for_action('/users/lst')
1410 and it will create the URI /users/the-list.
1412 =item \@captures_and_args?
1414 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1415 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1416 to interpolate all the parameters in the URI.
1420 Optional list of extra arguments - can be supplied in the
1421 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1424 Your action can have zero, a fixed or a variable number of args (e.g.
1425 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1427 =item \%query_values?
1429 Optional array reference of query parameters to append. E.g.
1435 /rest/of/your/uri?foo=bar
1441 sub uri_for_action {
1442 my ( $c, $path, @args ) = @_;
1443 my $action = blessed($path)
1445 : $c->dispatcher->get_action_by_path($path);
1446 unless (defined $action) {
1447 croak "Can't find action for path '$path'";
1449 return $c->uri_for( $action, @args );
1452 =head2 $c->welcome_message
1454 Returns the Catalyst welcome HTML page.
1458 sub welcome_message {
1460 my $name = $c->config->{name};
1461 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1462 my $prefix = Catalyst::Utils::appprefix( ref $c );
1463 $c->response->content_type('text/html; charset=utf-8');
1465 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1466 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1467 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1469 <meta http-equiv="Content-Language" content="en" />
1470 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1471 <title>$name on Catalyst $VERSION</title>
1472 <style type="text/css">
1475 background-color: #eee;
1482 margin-bottom: 10px;
1484 background-color: #ccc;
1485 border: 1px solid #aaa;
1490 font-family: verdana, tahoma, sans-serif;
1493 font-family: verdana, tahoma, sans-serif;
1496 text-decoration: none;
1498 border-bottom: 1px dotted #bbb;
1500 :link:hover, :visited:hover {
1513 background-color: #fff;
1514 border: 1px solid #aaa;
1518 font-weight: normal;
1540 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1545 <img src="$logo" alt="Catalyst Logo" />
1547 <p>Welcome to the world of Catalyst.
1548 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1549 framework will make web development something you had
1550 never expected it to be: Fun, rewarding, and quick.</p>
1551 <h2>What to do now?</h2>
1552 <p>That really depends on what <b>you</b> want to do.
1553 We do, however, provide you with a few starting points.</p>
1554 <p>If you want to jump right into web development with Catalyst
1555 you might want to start with a tutorial.</p>
1556 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1558 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1560 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1561 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1563 <h2>What to do next?</h2>
1564 <p>Next it's time to write an actual application. Use the
1565 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1566 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1567 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1568 they can save you a lot of work.</p>
1569 <pre><code>script/${prefix}_create.pl --help</code></pre>
1570 <p>Also, be sure to check out the vast and growing
1571 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1572 you are likely to find what you need there.
1576 <p>Catalyst has a very active community. Here are the main places to
1577 get in touch with us.</p>
1580 <a href="http://dev.catalyst.perl.org">Wiki</a>
1583 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1586 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1589 <h2>In conclusion</h2>
1590 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1591 as we enjoyed making it. Please contact us if you have ideas
1592 for improvement or other feedback.</p>
1602 Contains a hash of options passed from the application script, including
1603 the original ARGV the script received, the processed values from that
1604 ARGV and any extra arguments to the script which were not processed.
1606 This can be used to add custom options to your application's scripts
1607 and setup your application differently depending on the values of these
1610 =head1 INTERNAL METHODS
1612 These methods are not meant to be used by end users.
1614 =head2 $c->components
1616 Returns a hash of components.
1618 =head2 $c->context_class
1620 Returns or sets the context class.
1624 Returns a hashref containing coderefs and execution counts (needed for
1625 deep recursion detection).
1629 Returns the number of actions on the current internal execution stack.
1633 Dispatches a request to actions.
1637 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1639 =head2 $c->dispatcher_class
1641 Returns or sets the dispatcher class.
1643 =head2 $c->dump_these
1645 Returns a list of 2-element array references (name, structure) pairs
1646 that will be dumped on the error page in debug mode.
1652 [ Request => $c->req ],
1653 [ Response => $c->res ],
1654 [ Stash => $c->stash ],
1655 [ Config => $c->config ];
1658 =head2 $c->engine_class
1660 Returns or sets the engine class.
1662 =head2 $c->execute( $class, $coderef )
1664 Execute a coderef in given class and catch exceptions. Errors are available
1670 my ( $c, $class, $code ) = @_;
1671 $class = $c->component($class) || $class;
1674 if ( $c->depth >= $RECURSION ) {
1675 my $action = $code->reverse();
1676 $action = "/$action" unless $action =~ /->/;
1677 my $error = qq/Deep recursion detected calling "${action}"/;
1678 $c->log->error($error);
1684 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1686 push( @{ $c->stack }, $code );
1688 no warnings 'recursion';
1689 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1690 # I have no idea how, ergo $ret (which appears to fix the issue)
1691 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1693 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1695 my $last = pop( @{ $c->stack } );
1697 if ( my $error = $@ ) {
1698 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1699 $error->rethrow if $c->depth > 1;
1701 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1702 $error->rethrow if $c->depth > 0;
1705 unless ( ref $error ) {
1706 no warnings 'uninitialized';
1708 my $class = $last->class;
1709 my $name = $last->name;
1710 $error = qq/Caught exception in $class->$name "$error"/;
1719 sub _stats_start_execute {
1720 my ( $c, $code ) = @_;
1721 my $appclass = ref($c) || $c;
1722 return if ( ( $code->name =~ /^_.*/ )
1723 && ( !$appclass->config->{show_internal_actions} ) );
1725 my $action_name = $code->reverse();
1726 $c->counter->{$action_name}++;
1728 my $action = $action_name;
1729 $action = "/$action" unless $action =~ /->/;
1731 # determine if the call was the result of a forward
1732 # this is done by walking up the call stack and looking for a calling
1733 # sub of Catalyst::forward before the eval
1735 for my $index ( 2 .. 11 ) {
1737 if ( ( caller($index) )[0] eq 'Catalyst'
1738 && ( caller($index) )[3] eq '(eval)' );
1740 if ( ( caller($index) )[3] =~ /forward$/ ) {
1741 $callsub = ( caller($index) )[3];
1742 $action = "-> $action";
1747 my $uid = $action_name . $c->counter->{$action_name};
1749 # is this a root-level call or a forwarded call?
1750 if ( $callsub =~ /forward$/ ) {
1751 my $parent = $c->stack->[-1];
1753 # forward, locate the caller
1754 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1757 parent => "$parent" . $c->counter->{"$parent"},
1763 # forward with no caller may come from a plugin
1782 sub _stats_finish_execute {
1783 my ( $c, $info ) = @_;
1784 $c->stats->profile( end => $info );
1789 Finalizes the request.
1796 for my $error ( @{ $c->error } ) {
1797 $c->log->error($error);
1800 # Allow engine to handle finalize flow (for POE)
1801 my $engine = $c->engine;
1802 if ( my $code = $engine->can('finalize') ) {
1807 $c->finalize_uploads;
1810 if ( $#{ $c->error } >= 0 ) {
1814 $c->finalize_headers;
1817 if ( $c->request->method eq 'HEAD' ) {
1818 $c->response->body('');
1826 if ($c->use_stats) {
1827 my $elapsed = sprintf '%f', $c->stats->elapsed;
1828 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1830 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1833 return $c->response->status;
1836 =head2 $c->finalize_body
1842 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1844 =head2 $c->finalize_cookies
1850 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1852 =head2 $c->finalize_error
1858 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1860 =head2 $c->finalize_headers
1866 sub finalize_headers {
1869 my $response = $c->response; #accessor calls can add up?
1871 # Check if we already finalized headers
1872 return if $response->finalized_headers;
1875 if ( my $location = $response->redirect ) {
1876 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1877 $response->header( Location => $location );
1879 if ( !$response->has_body ) {
1880 # Add a default body if none is already present
1881 $response->body(<<"EOF");
1882 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1883 <html xmlns="http://www.w3.org/1999/xhtml">
1885 <title>Moved</title>
1888 <p>This item has moved <a href="$location">here</a>.</p>
1892 $response->content_type('text/html; charset=utf-8');
1897 if ( defined $response->body && length $response->body && !$response->content_length ) {
1899 # get the length from a filehandle
1900 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1902 my $size = -s $response->body;
1904 $response->content_length( $size );
1907 $c->log->warn('Serving filehandle without a content-length');
1911 # everything should be bytes at this point, but just in case
1912 $response->content_length( length( $response->body ) );
1917 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1918 $response->headers->remove_header("Content-Length");
1919 $response->body('');
1922 $c->finalize_cookies;
1924 $c->engine->finalize_headers( $c, @_ );
1927 $response->finalized_headers(1);
1930 =head2 $c->finalize_output
1932 An alias for finalize_body.
1934 =head2 $c->finalize_read
1936 Finalizes the input after reading is complete.
1940 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1942 =head2 $c->finalize_uploads
1944 Finalizes uploads. Cleans up any temporary files.
1948 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1950 =head2 $c->get_action( $action, $namespace )
1952 Gets an action in a given namespace.
1956 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1958 =head2 $c->get_actions( $action, $namespace )
1960 Gets all actions of a given name in a namespace and all parent
1965 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1967 =head2 $app->handle_request( @arguments )
1969 Called to handle each HTTP request.
1973 sub handle_request {
1974 my ( $class, @arguments ) = @_;
1976 # Always expect worst case!
1979 if ($class->debug) {
1980 my $secs = time - $START || 1;
1981 my $av = sprintf '%.3f', $COUNT / $secs;
1982 my $time = localtime time;
1983 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1986 my $c = $class->prepare(@arguments);
1988 $status = $c->finalize;
1991 chomp(my $error = $_);
1992 $class->log->error(qq/Caught exception in engine "$error"/);
1997 if(my $coderef = $class->log->can('_flush')){
1998 $class->log->$coderef();
2003 =head2 $class->prepare( @arguments )
2005 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2012 predicate => '_has_uploadtmp',
2016 my ( $class, @arguments ) = @_;
2019 # After the app/ctxt split, this should become an attribute based on something passed
2020 # into the application.
2021 $class->context_class( ref $class || $class ) unless $class->context_class;
2023 my $uploadtmp = $class->config->{uploadtmp};
2024 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2026 #surely this is not the most efficient way to do things...
2027 $c->stats($class->stats_class->new)->enable($c->use_stats);
2028 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2029 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2033 # Allow engine to direct the prepare flow (for POE)
2034 if ( my $prepare = $c->engine->can('prepare') ) {
2035 $c->engine->$prepare( $c, @arguments );
2038 $c->prepare_request(@arguments);
2039 $c->prepare_connection;
2040 $c->prepare_query_parameters;
2041 $c->prepare_headers; # Just hooks, no longer needed - they just
2042 $c->prepare_cookies; # cause the lazy attribute on req to build
2045 # Prepare the body for reading, either by prepare_body
2046 # or the user, if they are using $c->read
2049 # Parse the body unless the user wants it on-demand
2050 unless ( ref($c)->config->{parse_on_demand} ) {
2056 # VERY ugly and probably shouldn't rely on ->finalize actually working
2058 # failed prepare is always due to an invalid request, right?
2059 $c->response->status(400);
2060 $c->response->content_type('text/plain');
2061 $c->response->body('Bad Request');
2062 # Note we call finalize and then die here, which escapes
2063 # finalize being called in the enclosing block..
2064 # It in fact couldn't be called, as we don't return $c..
2065 # This is a mess - but I'm unsure you can fix this without
2066 # breaking compat for people doing crazy things (we should set
2067 # the 400 and just return the ctx here IMO, letting finalize get called
2078 =head2 $c->prepare_action
2080 Prepares action. See L<Catalyst::Dispatcher>.
2084 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2086 =head2 $c->prepare_body
2088 Prepares message body.
2095 return if $c->request->_has_body;
2097 # Initialize on-demand data
2098 $c->engine->prepare_body( $c, @_ );
2099 $c->prepare_parameters;
2100 $c->prepare_uploads;
2103 =head2 $c->prepare_body_chunk( $chunk )
2105 Prepares a chunk of data before sending it to L<HTTP::Body>.
2107 See L<Catalyst::Engine>.
2111 sub prepare_body_chunk {
2113 $c->engine->prepare_body_chunk( $c, @_ );
2116 =head2 $c->prepare_body_parameters
2118 Prepares body parameters.
2122 sub prepare_body_parameters {
2124 $c->engine->prepare_body_parameters( $c, @_ );
2127 =head2 $c->prepare_connection
2129 Prepares connection.
2133 sub prepare_connection {
2135 # XXX - This is called on the engine (not the request) to maintain
2136 # Engine::PSGI back compat.
2137 $c->engine->prepare_connection($c);
2140 =head2 $c->prepare_cookies
2142 Prepares cookies by ensuring that the attribute on the request
2143 object has been built.
2147 sub prepare_cookies { my $c = shift; $c->request->cookies }
2149 =head2 $c->prepare_headers
2151 Prepares request headers by ensuring that the attribute on the request
2152 object has been built.
2156 sub prepare_headers { my $c = shift; $c->request->headers }
2158 =head2 $c->prepare_parameters
2160 Prepares parameters.
2164 sub prepare_parameters {
2166 $c->prepare_body_parameters;
2167 $c->engine->prepare_parameters( $c, @_ );
2170 =head2 $c->prepare_path
2172 Prepares path and base.
2176 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2178 =head2 $c->prepare_query_parameters
2180 Prepares query parameters.
2184 sub prepare_query_parameters {
2187 $c->engine->prepare_query_parameters( $c, @_ );
2190 =head2 $c->log_request
2192 Writes information about the request to the debug logs. This includes:
2196 =item * Request method, path, and remote IP address
2198 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2200 =item * Request parameters
2202 =item * File uploads
2211 return unless $c->debug;
2213 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2214 my $request = $dump->[1];
2216 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2218 $path = '/' unless length $path;
2220 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2222 $c->log_request_headers($request->headers);
2224 if ( my $keywords = $request->query_keywords ) {
2225 $c->log->debug("Query keywords are: $keywords");
2228 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2230 $c->log_request_uploads($request);
2233 =head2 $c->log_response
2235 Writes information about the response to the debug logs by calling
2236 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2243 return unless $c->debug;
2245 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2246 my $response = $dump->[1];
2248 $c->log_response_status_line($response);
2249 $c->log_response_headers($response->headers);
2252 =head2 $c->log_response_status_line($response)
2254 Writes one line of information about the response to the debug logs. This includes:
2258 =item * Response status code
2260 =item * Content-Type header (if present)
2262 =item * Content-Length header (if present)
2268 sub log_response_status_line {
2269 my ($c, $response) = @_;
2273 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2274 $response->status || 'unknown',
2275 $response->headers->header('Content-Type') || 'unknown',
2276 $response->headers->header('Content-Length') || 'unknown'
2281 =head2 $c->log_response_headers($headers);
2283 Hook method which can be wrapped by plugins to log the response headers.
2284 No-op in the default implementation.
2288 sub log_response_headers {}
2290 =head2 $c->log_request_parameters( query => {}, body => {} )
2292 Logs request parameters to debug logs
2296 sub log_request_parameters {
2298 my %all_params = @_;
2300 return unless $c->debug;
2302 my $column_width = Catalyst::Utils::term_width() - 44;
2303 foreach my $type (qw(query body)) {
2304 my $params = $all_params{$type};
2305 next if ! keys %$params;
2306 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2307 for my $key ( sort keys %$params ) {
2308 my $param = $params->{$key};
2309 my $value = defined($param) ? $param : '';
2310 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2312 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2316 =head2 $c->log_request_uploads
2318 Logs file uploads included in the request to the debug logs.
2319 The parameter name, filename, file type, and file size are all included in
2324 sub log_request_uploads {
2326 my $request = shift;
2327 return unless $c->debug;
2328 my $uploads = $request->uploads;
2329 if ( keys %$uploads ) {
2330 my $t = Text::SimpleTable->new(
2331 [ 12, 'Parameter' ],
2336 for my $key ( sort keys %$uploads ) {
2337 my $upload = $uploads->{$key};
2338 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2339 $t->row( $key, $u->filename, $u->type, $u->size );
2342 $c->log->debug( "File Uploads are:\n" . $t->draw );
2346 =head2 $c->log_request_headers($headers);
2348 Hook method which can be wrapped by plugins to log the request headers.
2349 No-op in the default implementation.
2353 sub log_request_headers {}
2355 =head2 $c->log_headers($type => $headers)
2357 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2364 my $headers = shift; # an HTTP::Headers instance
2366 return unless $c->debug;
2368 my $column_width = Catalyst::Utils::term_width() - 28;
2369 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2372 my ( $name, $value ) = @_;
2373 $t->row( $name, $value );
2376 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2380 =head2 $c->prepare_read
2382 Prepares the input for reading.
2386 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2388 =head2 $c->prepare_request
2390 Prepares the engine request.
2394 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2396 =head2 $c->prepare_uploads
2402 sub prepare_uploads {
2405 $c->engine->prepare_uploads( $c, @_ );
2408 =head2 $c->prepare_write
2410 Prepares the output for writing.
2414 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2416 =head2 $c->request_class
2418 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2420 =head2 $c->response_class
2422 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2424 =head2 $c->read( [$maxlength] )
2426 Reads a chunk of data from the request body. This method is designed to
2427 be used in a while loop, reading C<$maxlength> bytes on every call.
2428 C<$maxlength> defaults to the size of the request if not specified.
2430 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2433 Warning: If you use read(), Catalyst will not process the body,
2434 so you will not be able to access POST parameters or file uploads via
2435 $c->request. You must handle all body parsing yourself.
2439 sub read { my $c = shift; return $c->request->read( @_ ) }
2449 $app->engine_loader->needs_psgi_engine_compat_hack ?
2450 $app->engine->run($app, @_) :
2451 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2454 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2456 Sets an action in a given namespace.
2460 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2462 =head2 $c->setup_actions($component)
2464 Sets up actions for a component.
2468 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2470 =head2 $c->setup_components
2472 This method is called internally to set up the application's components.
2474 It finds modules by calling the L<locate_components> method, expands them to
2475 package names with the L<expand_component_module> method, and then installs
2476 each component into the application.
2478 The C<setup_components> config option is passed to both of the above methods.
2480 Installation of each component is performed by the L<setup_component> method,
2485 sub setup_components {
2488 my $config = $class->config->{ setup_components };
2490 my @comps = $class->locate_components($config);
2491 my %comps = map { $_ => 1 } @comps;
2493 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2494 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2495 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2496 ) if $deprecatedcatalyst_component_names;
2498 for my $component ( @comps ) {
2500 # We pass ignore_loaded here so that overlay files for (e.g.)
2501 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2502 # we know M::P::O found a file on disk so this is safe
2504 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2507 for my $component (@comps) {
2508 my $instance = $class->components->{ $component } = $class->setup_component($component);
2509 my @expanded_components = $instance->can('expand_modules')
2510 ? $instance->expand_modules( $component, $config )
2511 : $class->expand_component_module( $component, $config );
2512 for my $component (@expanded_components) {
2513 next if $comps{$component};
2514 $class->components->{ $component } = $class->setup_component($component);
2519 =head2 $c->locate_components( $setup_component_config )
2521 This method is meant to provide a list of component modules that should be
2522 setup for the application. By default, it will use L<Module::Pluggable>.
2524 Specify a C<setup_components> config option to pass additional options directly
2525 to L<Module::Pluggable>. To add additional search paths, specify a key named
2526 C<search_extra> as an array reference. Items in the array beginning with C<::>
2527 will have the application class name prepended to them.
2531 sub locate_components {
2535 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2536 my $extra = delete $config->{ search_extra } || [];
2538 push @paths, @$extra;
2540 my $locator = Module::Pluggable::Object->new(
2541 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2545 # XXX think about ditching this sort entirely
2546 my @comps = sort { length $a <=> length $b } $locator->plugins;
2551 =head2 $c->expand_component_module( $component, $setup_component_config )
2553 Components found by C<locate_components> will be passed to this method, which
2554 is expected to return a list of component (package) names to be set up.
2558 sub expand_component_module {
2559 my ($class, $module) = @_;
2560 return Devel::InnerPackage::list_packages( $module );
2563 =head2 $c->setup_component
2567 sub setup_component {
2568 my( $class, $component ) = @_;
2570 unless ( $component->can( 'COMPONENT' ) ) {
2574 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2575 my $config = $class->config->{ $suffix } || {};
2576 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2577 # methods also pass it. local to avoid pointlessly shitting in config
2578 # for the debug screen, as $component is already the key name.
2579 local $config->{catalyst_component_name} = $component;
2581 my $instance = eval { $component->COMPONENT( $class, $config ); };
2583 if ( my $error = $@ ) {
2585 Catalyst::Exception->throw(
2586 message => qq/Couldn't instantiate component "$component", "$error"/
2590 unless (blessed $instance) {
2591 my $metaclass = Moose::Util::find_meta($component);
2592 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2593 my $component_method_from = $method_meta->associated_metaclass->name;
2594 my $value = defined($instance) ? $instance : 'undef';
2595 Catalyst::Exception->throw(
2597 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2603 =head2 $c->setup_dispatcher
2609 sub setup_dispatcher {
2610 my ( $class, $dispatcher ) = @_;
2613 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2616 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2617 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2620 unless ($dispatcher) {
2621 $dispatcher = $class->dispatcher_class;
2624 Class::MOP::load_class($dispatcher);
2626 # dispatcher instance
2627 $class->dispatcher( $dispatcher->new );
2630 =head2 $c->setup_engine
2637 my ($class, $requested_engine) = @_;
2639 if (!$class->engine_loader || $requested_engine) {
2640 $class->engine_loader(
2641 Catalyst::EngineLoader->new({
2642 application_name => $class,
2643 (defined $requested_engine
2644 ? (catalyst_engine_class => $requested_engine) : ()),
2649 $class->engine_loader->catalyst_engine_class;
2653 my ($class, $requested_engine) = @_;
2656 my $loader = $class->engine_loader;
2658 if (!$loader || $requested_engine) {
2659 $loader = Catalyst::EngineLoader->new({
2660 application_name => $class,
2661 (defined $requested_engine
2662 ? (requested_engine => $requested_engine) : ()),
2665 $class->engine_loader($loader);
2668 $loader->catalyst_engine_class;
2671 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2672 return if $class->loading_psgi_file;
2674 Class::MOP::load_class($engine);
2676 if ($ENV{MOD_PERL}) {
2677 my $apache = $class->engine_loader->auto;
2679 my $meta = find_meta($class);
2680 my $was_immutable = $meta->is_immutable;
2681 my %immutable_options = $meta->immutable_options;
2682 $meta->make_mutable if $was_immutable;
2684 $meta->add_method(handler => sub {
2686 my $psgi_app = $class->_finalized_psgi_app;
2687 $apache->call_app($r, $psgi_app);
2690 $meta->make_immutable(%immutable_options) if $was_immutable;
2693 $class->engine( $engine->new );
2698 sub _finalized_psgi_app {
2701 unless ($app->_psgi_app) {
2702 my $psgi_app = $app->_setup_psgi_app;
2703 $app->_psgi_app($psgi_app);
2706 return $app->_psgi_app;
2709 sub _setup_psgi_app {
2712 for my $home (Path::Class::Dir->new($app->config->{home})) {
2713 my $psgi_file = $home->file(
2714 Catalyst::Utils::appprefix($app) . '.psgi',
2717 next unless -e $psgi_file;
2719 # If $psgi_file calls ->setup_engine, it's doing so to load
2720 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2721 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2722 # anyway. So set a flag (ick) that tells setup_engine not to populate
2723 # $c->engine or do any other things we might regret.
2725 $app->loading_psgi_file(1);
2726 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2727 $app->loading_psgi_file(0);
2730 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2733 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2735 Its content has been ignored. Please consult the Catalyst::Upgrading
2736 documentation on how to upgrade from Catalyst::Engine::PSGI.
2740 return $app->apply_default_middlewares($app->psgi_app);
2743 =head2 $c->apply_default_middlewares
2745 Adds the following L<Plack> middlewares to your application, since they are
2746 useful and commonly needed:
2748 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2749 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2750 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2751 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2752 applied since this middleware is smart enough to conditionally apply itself).
2754 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2755 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2761 sub apply_default_middlewares {
2762 my ($app, $psgi_app) = @_;
2764 $psgi_app = Plack::Middleware::Conditional->wrap(
2766 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2769 return if $app->config->{ignore_frontend_proxy};
2770 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2771 || $app->config->{using_frontend_proxy};
2775 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2776 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2777 $psgi_app = Plack::Middleware::Conditional->wrap(
2779 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2782 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2783 return unless $1 < 4.23;
2788 # we're applying this unconditionally as the middleware itself already makes
2789 # sure it doesn't fuck things up if it's not running under one of the right
2791 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2798 Returns a PSGI application code reference for the catalyst application
2799 C<$c>. This is the bare application without any middlewares
2800 applied. C<${myapp}.psgi> is not taken into account.
2802 This is what you want to be using to retrieve the PSGI application code
2803 reference of your Catalyst application for use in F<.psgi> files.
2809 return $app->engine->build_psgi_app($app);
2812 =head2 $c->setup_home
2814 Sets up the home directory.
2819 my ( $class, $home ) = @_;
2821 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2825 $home ||= Catalyst::Utils::home($class);
2828 #I remember recently being scolded for assigning config values like this
2829 $class->config->{home} ||= $home;
2830 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2834 =head2 $c->setup_log
2836 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2837 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2840 This method also installs a C<debug> method that returns a true value into the
2841 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2842 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2844 Note that if the log has already been setup, by either a previous call to
2845 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2846 that this method won't actually set up the log object.
2851 my ( $class, $levels ) = @_;
2854 $levels =~ s/^\s+//;
2855 $levels =~ s/\s+$//;
2856 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2858 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2859 if ( defined $env_debug ) {
2860 $levels{debug} = 1 if $env_debug; # Ugly!
2861 delete($levels{debug}) unless $env_debug;
2864 unless ( $class->log ) {
2865 $class->log( Catalyst::Log->new(keys %levels) );
2868 if ( $levels{debug} ) {
2869 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2870 $class->log->debug('Debug messages enabled');
2874 =head2 $c->setup_plugins
2880 =head2 $c->setup_stats
2882 Sets up timing statistics class.
2887 my ( $class, $stats ) = @_;
2889 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2891 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2892 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2893 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2894 $class->log->debug('Statistics enabled');
2899 =head2 $c->registered_plugins
2901 Returns a sorted list of the plugins which have either been stated in the
2904 If passed a given plugin name, it will report a boolean value indicating
2905 whether or not that plugin is loaded. A fully qualified name is required if
2906 the plugin name does not begin with C<Catalyst::Plugin::>.
2908 if ($c->registered_plugins('Some::Plugin')) {
2916 sub registered_plugins {
2918 return sort keys %{ $proto->_plugins } unless @_;
2920 return 1 if exists $proto->_plugins->{$plugin};
2921 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2924 sub _register_plugin {
2925 my ( $proto, $plugin, $instant ) = @_;
2926 my $class = ref $proto || $proto;
2928 Class::MOP::load_class( $plugin );
2929 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2930 if $plugin->isa( 'Catalyst::Component' );
2931 $proto->_plugins->{$plugin} = 1;
2933 my $meta = Class::MOP::get_metaclass_by_name($class);
2934 $meta->superclasses($plugin, $meta->superclasses);
2940 my ( $class, $plugins ) = @_;
2942 $class->_plugins( {} ) unless $class->_plugins;
2943 $plugins = Data::OptList::mkopt($plugins || []);
2946 [ Catalyst::Utils::resolve_namespace(
2947 $class . '::Plugin',
2948 'Catalyst::Plugin', $_->[0]
2954 for my $plugin ( reverse @plugins ) {
2955 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2956 my $meta = find_meta($plugin->[0]);
2957 next if $meta && $meta->isa('Moose::Meta::Role');
2959 $class->_register_plugin($plugin->[0]);
2963 map { $_->[0]->name, $_->[1] }
2964 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2965 map { [find_meta($_->[0]), $_->[1]] }
2968 Moose::Util::apply_all_roles(
2976 Returns an arrayref of the internal execution stack (actions that are
2977 currently executing).
2981 Returns the current timing statistics object. By default Catalyst uses
2982 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2983 L<< stats_class|/"$c->stats_class" >>.
2985 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2986 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2987 profile explicitly, although MyApp.pm still won't profile nor output anything
2990 =head2 $c->stats_class
2992 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2994 =head2 $c->use_stats
2996 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2998 Note that this is a static method, not an accessor and should be overridden
2999 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3006 =head2 $c->write( $data )
3008 Writes $data to the output stream. When using this method directly, you
3009 will need to manually set the C<Content-Length> header to the length of
3010 your output data, if known.
3017 # Finalize headers if someone manually writes output (for compat)
3018 $c->finalize_headers;
3020 return $c->response->write( @_ );
3025 Returns the Catalyst version number. Mostly useful for "powered by"
3026 messages in template systems.
3030 sub version { return $Catalyst::VERSION }
3032 =head1 CONFIGURATION
3034 There are a number of 'base' config variables which can be set:
3040 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3044 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3048 C<disable_component_resolution_regex_fallback> - Turns
3049 off the deprecated component resolution functionality so
3050 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3051 are called then regex search will not be attempted on string values and
3052 instead C<undef> will be returned.
3056 C<home> - The application home directory. In an uninstalled application,
3057 this is the top level application directory. In an installed application,
3058 this will be the directory containing C<< MyApp.pm >>.
3062 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3066 C<name> - The name of the application in debug messages and the debug and
3071 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3072 until it is accessed. This allows you to (for example) check authentication (and reject
3073 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3077 C<root> - The root directory for templates. Usually this is just a
3078 subdirectory of the home directory, but you can set it to change the
3079 templates to a different directory.
3083 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3084 namespaces from which components will be loaded (and constructed and stored in
3085 C<< $c->components >>).
3089 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3090 to be shown in hit debug tables in the test server.
3094 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3095 variable should be used for determining the request path.
3097 Most web server environments pass the requested path to the application using environment variables,
3098 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3099 exposed as C<< $c->request->base >>) and the request path below that base.
3101 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3102 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3106 =item use_request_uri_for_path => 0
3108 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3109 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3110 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3111 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3113 However this method has the major disadvantage that it is impossible to correctly decode some elements
3114 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3115 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3116 can't distinguish / vs %2F in paths (in addition to other encoded values).
3118 =item use_request_uri_for_path => 1
3120 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3121 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3122 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3124 Given that this method of path resolution is provably more correct, it is recommended that you use
3125 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3126 aware of the implications of not being able to handle encoded URI paths correctly.
3128 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3129 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3130 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3131 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3132 C<< $c->request->base >> will be incorrect.
3138 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3142 =head1 INTERNAL ACTIONS
3144 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3145 C<_ACTION>, and C<_END>. These are by default not shown in the private
3146 action table, but you can make them visible with a config parameter.
3148 MyApp->config(show_internal_actions => 1);
3150 =head1 ON-DEMAND PARSER
3152 The request body is usually parsed at the beginning of a request,
3153 but if you want to handle input yourself, you can enable on-demand
3154 parsing with a config parameter.
3156 MyApp->config(parse_on_demand => 1);
3158 =head1 PROXY SUPPORT
3160 Many production servers operate using the common double-server approach,
3161 with a lightweight frontend web server passing requests to a larger
3162 backend server. An application running on the backend server must deal
3163 with two problems: the remote user always appears to be C<127.0.0.1> and
3164 the server's hostname will appear to be C<localhost> regardless of the
3165 virtual host that the user connected through.
3167 Catalyst will automatically detect this situation when you are running
3168 the frontend and backend servers on the same machine. The following
3169 changes are made to the request.
3171 $c->req->address is set to the user's real IP address, as read from
3172 the HTTP X-Forwarded-For header.
3174 The host value for $c->req->base and $c->req->uri is set to the real
3175 host, as read from the HTTP X-Forwarded-Host header.
3177 Additionally, you may be running your backend application on an insecure
3178 connection (port 80) while your frontend proxy is running under SSL. If there
3179 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3180 tell Catalyst what port the frontend listens on. This will allow all URIs to
3181 be created properly.
3183 In the case of passing in:
3185 X-Forwarded-Port: 443
3187 All calls to C<uri_for> will result in an https link, as is expected.
3189 Obviously, your web server must support these headers for this to work.
3191 In a more complex server farm environment where you may have your
3192 frontend proxy server(s) on different machines, you will need to set a
3193 configuration option to tell Catalyst to read the proxied data from the
3196 MyApp->config(using_frontend_proxy => 1);
3198 If you do not wish to use the proxy support at all, you may set:
3200 MyApp->config(ignore_frontend_proxy => 0);
3202 =head2 Note about psgi files
3204 Note that if you supply your own .psgi file, calling
3205 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3207 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3208 in your psgi, for example:
3211 enable "Plack::Middleware::ReverseProxy";
3215 This will unconditionally add the ReverseProxy support, or you need to call
3216 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3217 apply the support depending upon your config).
3219 See L<Catalyst::PSGI> for more information.
3221 =head1 THREAD SAFETY
3223 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3224 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3225 believe the Catalyst core to be thread-safe.
3227 If you plan to operate in a threaded environment, remember that all other
3228 modules you are using must also be thread-safe. Some modules, most notably
3229 L<DBD::SQLite>, are not thread-safe.
3235 Join #catalyst on irc.perl.org.
3239 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3240 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3244 http://catalyst.perl.org
3248 http://dev.catalyst.perl.org
3252 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3254 =head2 L<Catalyst::Manual> - The Catalyst Manual
3256 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3258 =head2 L<Catalyst::Engine> - Core engine
3260 =head2 L<Catalyst::Log> - Log class.
3262 =head2 L<Catalyst::Request> - Request object
3264 =head2 L<Catalyst::Response> - Response object
3266 =head2 L<Catalyst::Test> - The test suite.
3268 =head1 PROJECT FOUNDER
3270 sri: Sebastian Riedel <sri@cpan.org>
3276 acme: Leon Brocard <leon@astray.com>
3278 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3282 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3286 andyg: Andy Grundman <andy@hybridized.org>
3288 audreyt: Audrey Tang
3290 bricas: Brian Cassidy <bricas@cpan.org>
3292 Caelum: Rafael Kitover <rkitover@io.com>
3294 chansen: Christian Hansen
3296 chicks: Christopher Hicks
3298 Chisel Wright C<pause@herlpacker.co.uk>
3300 Danijel Milicevic C<me@danijel.de>
3302 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3304 David Naughton, C<naughton@umn.edu>
3308 dhoss: Devin Austin <dhoss@cpan.org>
3310 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3314 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3316 esskar: Sascha Kiefer
3318 fireartist: Carl Franks <cfranks@cpan.org>
3320 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3322 gabb: Danijel Milicevic
3326 Gavin Henry C<ghenry@perl.me.uk>
3330 groditi: Guillermo Roditi <groditi@gmail.com>
3332 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3334 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3336 jcamacho: Juan Camacho
3338 jester: Jesse Sheidlower C<jester@panix.com>
3340 jhannah: Jay Hannah <jay@jays.net>
3346 jon: Jon Schutz <jjschutz@cpan.org>
3348 Jonathan Rockway C<< <jrockway@cpan.org> >>
3350 Kieren Diment C<kd@totaldatasolution.com>
3352 konobi: Scott McWhirter <konobi@cpan.org>
3354 marcus: Marcus Ramberg <mramberg@cpan.org>
3356 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3358 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3362 naughton: David Naughton
3364 ningu: David Kamholz <dkamholz@cpan.org>
3366 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3368 numa: Dan Sully <daniel@cpan.org>
3374 omega: Andreas Marienborg
3376 Oleg Kostyuk <cub.uanic@gmail.com>
3378 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3380 rafl: Florian Ragwitz <rafl@debian.org>
3382 random: Roland Lammel <lammel@cpan.org>
3384 Robert Sedlacek C<< <rs@474.at> >>
3386 SpiceMan: Marcel Montes
3390 szbalint: Balint Szilakszi <szbalint@cpan.org>
3392 t0m: Tomas Doran <bobtfish@bobtfish.net>
3396 Viljo Marrandi C<vilts@yahoo.com>
3398 Will Hawes C<info@whawes.co.uk>
3400 willert: Sebastian Willert <willert@cpan.org>
3402 wreis: Wallace Reis <wallace@reis.org.br>
3404 Yuval Kogman, C<nothingmuch@woobling.org>
3406 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3408 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3412 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3416 This library is free software. You can redistribute it and/or modify it under
3417 the same terms as Perl itself.
3423 __PACKAGE__->meta->make_immutable;