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.008004; }
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 { {} });
49 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
50 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
51 has namespace => (is => 'rw');
53 sub depth { scalar @{ shift->stack || [] }; }
54 sub comp { shift->component(@_) }
57 my $self = shift; return $self->request(@_);
60 my $self = shift; return $self->response(@_);
63 # For backwards compatibility
64 sub finalize_output { shift->finalize_body(@_) };
69 our $RECURSION = 1000;
70 our $DETACH = Catalyst::Exception::Detach->new;
71 our $GO = Catalyst::Exception::Go->new;
73 #I imagine that very few of these really need to be class variables. if any.
74 #maybe we should just make them attributes with a default?
75 __PACKAGE__->mk_classdata($_)
76 for qw/components arguments dispatcher engine log dispatcher_class
77 engine_loader context_class request_class response_class stats_class
78 setup_finished _psgi_app loading_psgi_file/;
80 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
81 __PACKAGE__->request_class('Catalyst::Request');
82 __PACKAGE__->response_class('Catalyst::Response');
83 __PACKAGE__->stats_class('Catalyst::Stats');
85 # Remember to update this in Catalyst::Runtime as well!
87 our $VERSION = '5.90004';
90 my ( $class, @arguments ) = @_;
92 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
94 return unless $class eq 'Catalyst';
96 my $caller = caller();
97 return if $caller eq 'main';
99 my $meta = Moose::Meta::Class->initialize($caller);
100 unless ( $caller->isa('Catalyst') ) {
101 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
102 $meta->superclasses(@superclasses);
104 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
105 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
107 unless( $meta->has_method('meta') ){
108 if ($Moose::VERSION >= 1.15) {
109 $meta->_add_meta_method('meta');
112 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
116 $caller->arguments( [@arguments] );
120 sub _application { $_[0] }
124 Catalyst - The Elegant MVC Web Application Framework
128 See the L<Catalyst::Manual> distribution for comprehensive
129 documentation and tutorials.
131 # Install Catalyst::Devel for helpers and other development tools
132 # use the helper to create a new application
135 # add models, views, controllers
136 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
137 script/myapp_create.pl view MyTemplate TT
138 script/myapp_create.pl controller Search
140 # built in testserver -- use -r to restart automatically on changes
141 # --help to see all available options
142 script/myapp_server.pl
144 # command line testing interface
145 script/myapp_test.pl /yada
148 use Catalyst qw/-Debug/; # include plugins here as well
150 ### In lib/MyApp/Controller/Root.pm (autocreated)
151 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
152 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
153 $c->stash->{template} = 'foo.tt'; # set the template
154 # lookup something from db -- stash vars are passed to TT
156 $c->model('Database::Foo')->search( { country => $args[0] } );
157 if ( $c->req->params->{bar} ) { # access GET or POST parameters
158 $c->forward( 'bar' ); # process another action
159 # do something else after forward returns
163 # The foo.tt TT template can use the stash data from the database
164 [% WHILE (item = data.next) %]
168 # called for /bar/of/soap, /bar/of/soap/10, etc.
169 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
171 # called after all actions are finished
173 my ( $self, $c ) = @_;
174 if ( scalar @{ $c->error } ) { ... } # handle errors
175 return if $c->res->body; # already have a response
176 $c->forward( 'MyApp::View::TT' ); # render template
179 See L<Catalyst::Manual::Intro> for additional information.
183 Catalyst is a modern framework for making web applications without the
184 pain usually associated with this process. This document is a reference
185 to the main Catalyst application. If you are a new user, we suggest you
186 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
188 See L<Catalyst::Manual> for more documentation.
190 Catalyst plugins can be loaded by naming them as arguments to the "use
191 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
192 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
195 use Catalyst qw/My::Module/;
197 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
198 fully qualify the name by using a unary plus:
202 +Fully::Qualified::Plugin::Name
205 Special flags like C<-Debug> can also be specified as
206 arguments when Catalyst is loaded:
208 use Catalyst qw/-Debug My::Module/;
210 The position of plugins and flags in the chain is important, because
211 they are loaded in the order in which they appear.
213 The following flags are supported:
217 Enables debug output. You can also force this setting from the system
218 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
219 settings override the application, with <MYAPP>_DEBUG having the highest
222 This sets the log level to 'debug' and enables full debug output on the
223 error screen. If you only want the latter, see L<< $c->debug >>.
227 Forces Catalyst to use a specific home directory, e.g.:
229 use Catalyst qw[-Home=/usr/mst];
231 This can also be done in the shell environment by setting either the
232 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
233 is replaced with the uppercased name of your application, any "::" in
234 the name will be replaced with underscores, e.g. MyApp::Web should use
235 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
237 If none of these are set, Catalyst will attempt to automatically detect the
238 home directory. If you are working in a development environment, Catalyst
239 will try and find the directory containing either Makefile.PL, Build.PL or
240 dist.ini. If the application has been installed into the system (i.e.
241 you have done C<make install>), then Catalyst will use the path to your
242 application module, without the .pm extension (e.g., /foo/MyApp if your
243 application was installed at /foo/MyApp.pm)
247 use Catalyst '-Log=warn,fatal,error';
249 Specifies a comma-delimited list of log levels.
253 Enables statistics collection and reporting.
255 use Catalyst qw/-Stats=1/;
257 You can also force this setting from the system environment with CATALYST_STATS
258 or <MYAPP>_STATS. The environment settings override the application, with
259 <MYAPP>_STATS having the highest priority.
261 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
265 =head2 INFORMATION ABOUT THE CURRENT REQUEST
269 Returns a L<Catalyst::Action> object for the current action, which
270 stringifies to the action name. See L<Catalyst::Action>.
274 Returns the namespace of the current action, i.e., the URI prefix
275 corresponding to the controller of the current action. For example:
277 # in Controller::Foo::Bar
278 $c->namespace; # returns 'foo/bar';
284 Returns the current L<Catalyst::Request> object, giving access to
285 information about the current client request (including parameters,
286 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
288 =head2 REQUEST FLOW HANDLING
290 =head2 $c->forward( $action [, \@arguments ] )
292 =head2 $c->forward( $class, $method, [, \@arguments ] )
294 Forwards processing to another action, by its private name. If you give a
295 class name but no method, C<process()> is called. You may also optionally
296 pass arguments in an arrayref. The action will receive the arguments in
297 C<@_> and C<< $c->req->args >>. Upon returning from the function,
298 C<< $c->req->args >> will be restored to the previous values.
300 Any data C<return>ed from the action forwarded to, will be returned by the
303 my $foodata = $c->forward('/foo');
304 $c->forward('index');
305 $c->forward(qw/Model::DBIC::Foo do_stuff/);
306 $c->forward('View::TT');
308 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
309 an C<< eval { } >> around the call (actually
310 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
311 exceptions thrown by the called action non-fatal and pushing them onto
312 $c->error instead. If you want C<die> to propagate you need to do something
316 die join "\n", @{ $c->error } if @{ $c->error };
318 Or make sure to always return true values from your actions and write
321 $c->forward('foo') || return;
323 Another note is that C<< $c->forward >> always returns a scalar because it
324 actually returns $c->state which operates in a scalar context.
325 Thus, something like:
329 in an action that is forwarded to is going to return a scalar,
330 i.e. how many items are in that array, which is probably not what you want.
331 If you need to return an array then return a reference to it,
334 $c->stash->{array} = \@array;
336 and access it from the stash.
338 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.
342 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
344 =head2 $c->detach( $action [, \@arguments ] )
346 =head2 $c->detach( $class, $method, [, \@arguments ] )
350 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
351 doesn't return to the previous action when processing is finished.
353 When called with no arguments it escapes the processing chain entirely.
357 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
359 =head2 $c->visit( $action [, \@captures, \@arguments ] )
361 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
363 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
364 but does a full dispatch, instead of just calling the new C<$action> /
365 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
366 you go to are called, just like a new request.
368 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
369 This means, for example, that C<< $c->action >> methods such as
370 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
371 L<reverse|Catalyst::Action/reverse> return information for the visited action
372 when they are invoked within the visited action. This is different from the
373 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
374 continues to use the $c->action object from the caller action even when
375 invoked from the called action.
377 C<< $c->stash >> is kept unchanged.
379 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
380 allows you to "wrap" another action, just as it would have been called by
381 dispatching from a URL, while the analogous
382 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
383 transfer control to another action as if it had been reached directly from a URL.
387 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
389 =head2 $c->go( $action [, \@captures, \@arguments ] )
391 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
393 The relationship between C<go> and
394 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
395 the relationship between
396 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
397 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
398 C<< $c->go >> will perform a full dispatch on the specified action or method,
399 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
400 C<go> escapes the processing of the current request chain on completion, and
401 does not return to its caller.
403 @arguments are arguments to the final destination of $action. @captures are
404 arguments to the intermediate steps, if any, on the way to the final sub of
409 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
415 Returns the current L<Catalyst::Response> object, see there for details.
419 Returns a hashref to the stash, which may be used to store data and pass
420 it between components during a request. You can also set hash keys by
421 passing arguments. The stash is automatically sent to the view. The
422 stash is cleared at the end of a request; it cannot be used for
423 persistent storage (for this you must use a session; see
424 L<Catalyst::Plugin::Session> for a complete system integrated with
427 $c->stash->{foo} = $bar;
428 $c->stash( { moose => 'majestic', qux => 0 } );
429 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
431 # stash is automatically passed to the view for use in a template
432 $c->forward( 'MyApp::View::TT' );
436 around stash => sub {
439 my $stash = $orig->($c);
441 my $new_stash = @_ > 1 ? {@_} : $_[0];
442 croak('stash takes a hash or hashref') unless ref $new_stash;
443 foreach my $key ( keys %$new_stash ) {
444 $stash->{$key} = $new_stash->{$key};
454 =head2 $c->error($error, ...)
456 =head2 $c->error($arrayref)
458 Returns an arrayref containing error messages. If Catalyst encounters an
459 error while processing a request, it stores the error in $c->error. This
460 method should only be used to store fatal error messages.
462 my @error = @{ $c->error };
466 $c->error('Something bad happened');
473 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
474 croak @$error unless ref $c;
475 push @{ $c->{error} }, @$error;
477 elsif ( defined $_[0] ) { $c->{error} = undef }
478 return $c->{error} || [];
484 Contains the return value of the last executed action.
485 Note that << $c->state >> operates in a scalar context which means that all
486 values it returns are scalar.
488 =head2 $c->clear_errors
490 Clear errors. You probably don't want to clear the errors unless you are
491 implementing a custom error screen.
493 This is equivalent to running
504 sub _comp_search_prefixes {
506 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
509 # search components given a name and some prefixes
510 sub _comp_names_search_prefixes {
511 my ( $c, $name, @prefixes ) = @_;
512 my $appclass = ref $c || $c;
513 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
514 $filter = qr/$filter/; # Compile regex now rather than once per loop
516 # map the original component name to the sub part that we will search against
517 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
518 grep { /$filter/ } keys %{ $c->components };
520 # undef for a name will return all
521 return keys %eligible if !defined $name;
523 my $query = ref $name ? $name : qr/^$name$/i;
524 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
526 return @result if @result;
528 # if we were given a regexp to search against, we're done.
531 # skip regexp fallback if configured
533 if $appclass->config->{disable_component_resolution_regex_fallback};
537 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
539 # no results? try against full names
541 @result = grep { m{$query} } keys %eligible;
544 # don't warn if we didn't find any results, it just might not exist
546 # Disgusting hack to work out correct method name
547 my $warn_for = lc $prefixes[0];
548 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
549 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
550 "component resolution is unreliable and unsafe.";
551 my $short = $result[0];
552 # remove the component namespace prefix
553 $short =~ s/.*?(Model|Controller|View):://;
554 my $shortmess = Carp::shortmess('');
555 if ($shortmess =~ m#Catalyst/Plugin#) {
556 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
558 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
559 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
560 "component's config";
562 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
563 "but if you really wanted to search, pass in a regexp as the argument " .
564 "like so: \$c->${warn_for}(qr/${name}/)";
566 $c->log->warn( "${msg}$shortmess" );
572 # Find possible names for a prefix
574 my ( $c, @prefixes ) = @_;
575 my $appclass = ref $c || $c;
577 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
579 my @names = map { s{$filter}{}; $_; }
580 $c->_comp_names_search_prefixes( undef, @prefixes );
585 # Filter a component before returning by calling ACCEPT_CONTEXT if available
586 sub _filter_component {
587 my ( $c, $comp, @args ) = @_;
589 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
590 return $comp->ACCEPT_CONTEXT( $c, @args );
596 =head2 COMPONENT ACCESSORS
598 =head2 $c->controller($name)
600 Gets a L<Catalyst::Controller> instance by name.
602 $c->controller('Foo')->do_stuff;
604 If the name is omitted, will return the controller for the dispatched
607 If you want to search for controllers, pass in a regexp as the argument.
609 # find all controllers that start with Foo
610 my @foo_controllers = $c->controller(qr{^Foo});
616 my ( $c, $name, @args ) = @_;
618 my $appclass = ref($c) || $c;
620 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
621 my $comps = $c->components;
622 my $check = $appclass."::Controller::".$name;
623 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
625 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
626 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
627 return $c->_filter_component( $result[ 0 ], @args );
630 return $c->component( $c->action->class );
633 =head2 $c->model($name)
635 Gets a L<Catalyst::Model> instance by name.
637 $c->model('Foo')->do_stuff;
639 Any extra arguments are directly passed to ACCEPT_CONTEXT.
641 If the name is omitted, it will look for
642 - a model object in $c->stash->{current_model_instance}, then
643 - a model name in $c->stash->{current_model}, then
644 - a config setting 'default_model', or
645 - check if there is only one model, and return it if that's the case.
647 If you want to search for models, pass in a regexp as the argument.
649 # find all models that start with Foo
650 my @foo_models = $c->model(qr{^Foo});
655 my ( $c, $name, @args ) = @_;
656 my $appclass = ref($c) || $c;
658 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
659 my $comps = $c->components;
660 my $check = $appclass."::Model::".$name;
661 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
663 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
664 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
665 return $c->_filter_component( $result[ 0 ], @args );
669 return $c->stash->{current_model_instance}
670 if $c->stash->{current_model_instance};
671 return $c->model( $c->stash->{current_model} )
672 if $c->stash->{current_model};
674 return $c->model( $appclass->config->{default_model} )
675 if $appclass->config->{default_model};
677 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
680 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
681 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
682 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
683 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
684 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
687 return $c->_filter_component( $comp );
691 =head2 $c->view($name)
693 Gets a L<Catalyst::View> instance by name.
695 $c->view('Foo')->do_stuff;
697 Any extra arguments are directly passed to ACCEPT_CONTEXT.
699 If the name is omitted, it will look for
700 - a view object in $c->stash->{current_view_instance}, then
701 - a view name in $c->stash->{current_view}, then
702 - a config setting 'default_view', or
703 - check if there is only one view, and return it if that's the case.
705 If you want to search for views, pass in a regexp as the argument.
707 # find all views that start with Foo
708 my @foo_views = $c->view(qr{^Foo});
713 my ( $c, $name, @args ) = @_;
715 my $appclass = ref($c) || $c;
717 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
718 my $comps = $c->components;
719 my $check = $appclass."::View::".$name;
720 if( exists $comps->{$check} ) {
721 return $c->_filter_component( $comps->{$check}, @args );
724 $c->log->warn( "Attempted to use view '$check', but does not exist" );
727 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
728 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
729 return $c->_filter_component( $result[ 0 ], @args );
733 return $c->stash->{current_view_instance}
734 if $c->stash->{current_view_instance};
735 return $c->view( $c->stash->{current_view} )
736 if $c->stash->{current_view};
738 return $c->view( $appclass->config->{default_view} )
739 if $appclass->config->{default_view};
741 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
744 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
745 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
746 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
747 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
748 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
751 return $c->_filter_component( $comp );
754 =head2 $c->controllers
756 Returns the available names which can be passed to $c->controller
762 return $c->_comp_names(qw/Controller C/);
767 Returns the available names which can be passed to $c->model
773 return $c->_comp_names(qw/Model M/);
779 Returns the available names which can be passed to $c->view
785 return $c->_comp_names(qw/View V/);
788 =head2 $c->comp($name)
790 =head2 $c->component($name)
792 Gets a component object by name. This method is not recommended,
793 unless you want to get a specific component by full
794 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
795 should be used instead.
797 If C<$name> is a regexp, a list of components matched against the full
798 component name will be returned.
800 If Catalyst can't find a component by name, it will fallback to regex
801 matching by default. To disable this behaviour set
802 disable_component_resolution_regex_fallback to a true value.
804 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
809 my ( $c, $name, @args ) = @_;
812 my $comps = $c->components;
815 # is it the exact name?
816 return $c->_filter_component( $comps->{ $name }, @args )
817 if exists $comps->{ $name };
819 # perhaps we just omitted "MyApp"?
820 my $composed = ( ref $c || $c ) . "::${name}";
821 return $c->_filter_component( $comps->{ $composed }, @args )
822 if exists $comps->{ $composed };
824 # search all of the models, views and controllers
825 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
826 return $c->_filter_component( $comp, @args ) if $comp;
830 if $c->config->{disable_component_resolution_regex_fallback};
832 # This is here so $c->comp( '::M::' ) works
833 my $query = ref $name ? $name : qr{$name}i;
835 my @result = grep { m{$query} } keys %{ $c->components };
836 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
839 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
840 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
841 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
842 return $c->_filter_component( $result[ 0 ], @args );
845 # I would expect to return an empty list here, but that breaks back-compat
849 return sort keys %{ $c->components };
852 =head2 CLASS DATA AND HELPER CLASSES
856 Returns or takes a hashref containing the application's configuration.
858 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
860 You can also use a C<YAML>, C<XML> or L<Config::General> config file
861 like C<myapp.conf> in your applications home directory. See
862 L<Catalyst::Plugin::ConfigLoader>.
864 =head3 Cascading configuration
866 The config method is present on all Catalyst components, and configuration
867 will be merged when an application is started. Configuration loaded with
868 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
869 followed by configuration in your top level C<MyApp> class. These two
870 configurations are merged, and then configuration data whose hash key matches a
871 component name is merged with configuration for that component.
873 The configuration for a component is then passed to the C<new> method when a
874 component is constructed.
878 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
879 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
881 will mean that C<MyApp::Model::Foo> receives the following data when
884 MyApp::Model::Foo->new({
890 It's common practice to use a Moose attribute
891 on the receiving component to access the config value.
893 package MyApp::Model::Foo;
897 # this attr will receive 'baz' at construction time
903 You can then get the value 'baz' by calling $c->model('Foo')->bar
904 (or $self->bar inside code in the model).
906 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
907 as a way of reading config within your code, as this B<will not> give you the
908 correctly merged config back. You B<MUST> take the config values supplied to
909 the constructor and use those instead.
913 around config => sub {
917 croak('Setting config after setup has been run is not allowed.')
918 if ( @_ and $c->setup_finished );
925 Returns the logging object instance. Unless it is already set, Catalyst
926 sets this up with a L<Catalyst::Log> object. To use your own log class,
927 set the logger with the C<< __PACKAGE__->log >> method prior to calling
928 C<< __PACKAGE__->setup >>.
930 __PACKAGE__->log( MyLogger->new );
935 $c->log->info( 'Now logging with my own logger!' );
937 Your log class should implement the methods described in
943 Returns 1 if debug mode is enabled, 0 otherwise.
945 You can enable debug mode in several ways:
949 =item By calling myapp_server.pl with the -d flag
951 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
953 =item The -Debug option in your MyApp.pm
955 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
959 The first three also set the log level to 'debug'.
961 Calling C<< $c->debug(1) >> has no effect.
967 =head2 $c->dispatcher
969 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
973 Returns the engine instance. See L<Catalyst::Engine>.
976 =head2 UTILITY METHODS
978 =head2 $c->path_to(@path)
980 Merges C<@path> with C<< $c->config->{home} >> and returns a
981 L<Path::Class::Dir> object. Note you can usually use this object as
982 a filename, but sometimes you will have to explicitly stringify it
983 yourself by calling the C<< ->stringify >> method.
987 $c->path_to( 'db', 'sqlite.db' );
992 my ( $c, @path ) = @_;
993 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
994 if ( -d $path ) { return $path }
995 else { return Path::Class::File->new( $c->config->{home}, @path ) }
999 my ( $class, $name, $plugin, @args ) = @_;
1001 # See block comment in t/unit_core_plugin.t
1002 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1004 $class->_register_plugin( $plugin, 1 );
1006 eval { $plugin->import };
1007 $class->mk_classdata($name);
1009 eval { $obj = $plugin->new(@args) };
1012 Catalyst::Exception->throw( message =>
1013 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1016 $class->$name($obj);
1017 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1023 Initializes the dispatcher and engine, loads any plugins, and loads the
1024 model, view, and controller components. You may also specify an array
1025 of plugins to load here, if you choose to not load them in the C<use
1029 MyApp->setup( qw/-Debug/ );
1034 my ( $class, @arguments ) = @_;
1035 croak('Running setup more than once')
1036 if ( $class->setup_finished );
1038 unless ( $class->isa('Catalyst') ) {
1040 Catalyst::Exception->throw(
1041 message => qq/'$class' does not inherit from Catalyst/ );
1044 if ( $class->arguments ) {
1045 @arguments = ( @arguments, @{ $class->arguments } );
1051 foreach (@arguments) {
1055 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1057 elsif (/^-(\w+)=?(.*)$/) {
1058 $flags->{ lc $1 } = $2;
1061 push @{ $flags->{plugins} }, $_;
1065 $class->setup_home( delete $flags->{home} );
1067 $class->setup_log( delete $flags->{log} );
1068 $class->setup_plugins( delete $flags->{plugins} );
1069 $class->setup_dispatcher( delete $flags->{dispatcher} );
1070 if (my $engine = delete $flags->{engine}) {
1071 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1073 $class->setup_engine();
1074 $class->setup_stats( delete $flags->{stats} );
1076 for my $flag ( sort keys %{$flags} ) {
1078 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1079 &$code( $class, delete $flags->{$flag} );
1082 $class->log->warn(qq/Unknown flag "$flag"/);
1086 eval { require Catalyst::Devel; };
1087 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1088 $class->log->warn(<<"EOF");
1089 You are running an old script!
1091 Please update by running (this will overwrite existing files):
1092 catalyst.pl -force -scripts $class
1094 or (this will not overwrite existing files):
1095 catalyst.pl -scripts $class
1100 if ( $class->debug ) {
1101 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1104 my $column_width = Catalyst::Utils::term_width() - 6;
1105 my $t = Text::SimpleTable->new($column_width);
1106 $t->row($_) for @plugins;
1107 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1110 my $dispatcher = $class->dispatcher;
1111 my $engine = $class->engine;
1112 my $home = $class->config->{home};
1114 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1115 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1119 ? $class->log->debug(qq/Found home "$home"/)
1120 : $class->log->debug(qq/Home "$home" doesn't exist/)
1121 : $class->log->debug(q/Couldn't find home/);
1124 # Call plugins setup, this is stupid and evil.
1125 # Also screws C3 badly on 5.10, hack to avoid.
1127 no warnings qw/redefine/;
1128 local *setup = sub { };
1129 $class->setup unless $Catalyst::__AM_RESTARTING;
1132 # Initialize our data structure
1133 $class->components( {} );
1135 $class->setup_components;
1137 if ( $class->debug ) {
1138 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1139 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1140 for my $comp ( sort keys %{ $class->components } ) {
1141 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1142 $t->row( $comp, $type );
1144 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1145 if ( keys %{ $class->components } );
1148 # Add our self to components, since we are also a component
1149 if( $class->isa('Catalyst::Controller') ){
1150 $class->components->{$class} = $class;
1153 $class->setup_actions;
1155 if ( $class->debug ) {
1156 my $name = $class->config->{name} || 'Application';
1157 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1160 # Make sure that the application class becomes immutable at this point,
1161 B::Hooks::EndOfScope::on_scope_end {
1163 my $meta = Class::MOP::get_metaclass_by_name($class);
1166 && ! { $meta->immutable_options }->{replace_constructor}
1168 $class->isa('Class::Accessor::Fast')
1169 || $class->isa('Class::Accessor')
1172 warn "You made your application class ($class) immutable, "
1173 . "but did not inline the\nconstructor. "
1174 . "This will break catalyst, as your app \@ISA "
1175 . "Class::Accessor(::Fast)?\nPlease pass "
1176 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1178 $meta->make_immutable(
1179 replace_constructor => 1,
1180 ) unless $meta->is_immutable;
1183 if ($class->config->{case_sensitive}) {
1184 $class->log->warn($class . "->config->{case_sensitive} is set.");
1185 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1188 $class->setup_finalize;
1189 # Should be the last thing we do so that user things hooking
1190 # setup_finalize can log..
1191 $class->log->_flush() if $class->log->can('_flush');
1192 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1195 =head2 $app->setup_finalize
1197 A hook to attach modifiers to. This method does not do anything except set the
1198 C<setup_finished> accessor.
1200 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1204 after setup_finalize => sub {
1212 sub setup_finalize {
1214 $class->setup_finished(1);
1217 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1219 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1221 Constructs an absolute L<URI> object based on the application root, the
1222 provided path, and the additional arguments and query parameters provided.
1223 When used as a string, provides a textual URI. If you need more flexibility
1224 than this (i.e. the option to provide relative URIs etc.) see
1225 L<Catalyst::Plugin::SmartURI>.
1227 If no arguments are provided, the URI for the current action is returned.
1228 To return the current action and also provide @args, use
1229 C<< $c->uri_for( $c->action, @args ) >>.
1231 If the first argument is a string, it is taken as a public URI path relative
1232 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1233 relative to the application root (if it does). It is then merged with
1234 C<< $c->request->base >>; any C<@args> are appended as additional path
1235 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1237 If the first argument is a L<Catalyst::Action> it represents an action which
1238 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1239 optional C<\@captures> argument (an arrayref) allows passing the captured
1240 variables that are needed to fill in the paths of Chained and Regex actions;
1241 once the path is resolved, C<uri_for> continues as though a path was
1242 provided, appending any arguments or parameters and creating an absolute
1245 The captures for the current request can be found in
1246 C<< $c->request->captures >>, and actions can be resolved using
1247 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1248 path, use C<< $c->uri_for_action >> instead.
1250 # Equivalent to $c->req->uri
1251 $c->uri_for($c->action, $c->req->captures,
1252 @{ $c->req->args }, $c->req->params);
1254 # For the Foo action in the Bar controller
1255 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1257 # Path to a static resource
1258 $c->uri_for('/static/images/logo.png');
1263 my ( $c, $path, @args ) = @_;
1265 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1266 $path = $path->path_prefix;
1271 undef($path) if (defined $path && $path eq '');
1274 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1276 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1277 foreach my $arg (@args) {
1278 utf8::encode($arg) if utf8::is_utf8($arg);
1279 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1282 if ( blessed($path) ) { # action object
1283 s|/|%2F|g for @args;
1284 my $captures = [ map { s|/|%2F|g; $_; }
1285 ( scalar @args && ref $args[0] eq 'ARRAY'
1289 foreach my $capture (@$captures) {
1290 utf8::encode($capture) if utf8::is_utf8($capture);
1291 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1295 $path = $c->dispatcher->uri_for_action($action, $captures);
1296 if (not defined $path) {
1297 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1301 $path = '/' if $path eq '';
1304 unshift(@args, $path);
1306 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1307 my $namespace = $c->namespace;
1308 if (defined $path) { # cheesy hack to handle path '../foo'
1309 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1311 unshift(@args, $namespace || '');
1314 # join args with '/', or a blank string
1315 my $args = join('/', grep { defined($_) } @args);
1316 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1318 my $base = $c->req->base;
1319 my $class = ref($base);
1320 $base =~ s{(?<!/)$}{/};
1324 if (my @keys = keys %$params) {
1325 # somewhat lifted from URI::_query's query_form
1326 $query = '?'.join('&', map {
1327 my $val = $params->{$_};
1328 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1331 $val = '' unless defined $val;
1334 utf8::encode( $param ) if utf8::is_utf8($param);
1335 # using the URI::Escape pattern here so utf8 chars survive
1336 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1338 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1342 my $res = bless(\"${base}${args}${query}", $class);
1346 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1348 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1354 A private path to the Catalyst action you want to create a URI for.
1356 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1357 >> and passing the resulting C<$action> and the remaining arguments to C<<
1360 You can also pass in a Catalyst::Action object, in which case it is passed to
1363 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.
1365 For example, if the action looks like:
1367 package MyApp::Controller::Users;
1369 sub lst : Path('the-list') {}
1373 $c->uri_for_action('/users/lst')
1375 and it will create the URI /users/the-list.
1381 sub uri_for_action {
1382 my ( $c, $path, @args ) = @_;
1383 my $action = blessed($path)
1385 : $c->dispatcher->get_action_by_path($path);
1386 unless (defined $action) {
1387 croak "Can't find action for path '$path'";
1389 return $c->uri_for( $action, @args );
1392 =head2 $c->welcome_message
1394 Returns the Catalyst welcome HTML page.
1398 sub welcome_message {
1400 my $name = $c->config->{name};
1401 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1402 my $prefix = Catalyst::Utils::appprefix( ref $c );
1403 $c->response->content_type('text/html; charset=utf-8');
1405 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1406 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1407 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1409 <meta http-equiv="Content-Language" content="en" />
1410 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1411 <title>$name on Catalyst $VERSION</title>
1412 <style type="text/css">
1415 background-color: #eee;
1422 margin-bottom: 10px;
1424 background-color: #ccc;
1425 border: 1px solid #aaa;
1430 font-family: verdana, tahoma, sans-serif;
1433 font-family: verdana, tahoma, sans-serif;
1436 text-decoration: none;
1438 border-bottom: 1px dotted #bbb;
1440 :link:hover, :visited:hover {
1453 background-color: #fff;
1454 border: 1px solid #aaa;
1458 font-weight: normal;
1480 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1485 <img src="$logo" alt="Catalyst Logo" />
1487 <p>Welcome to the world of Catalyst.
1488 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1489 framework will make web development something you had
1490 never expected it to be: Fun, rewarding, and quick.</p>
1491 <h2>What to do now?</h2>
1492 <p>That really depends on what <b>you</b> want to do.
1493 We do, however, provide you with a few starting points.</p>
1494 <p>If you want to jump right into web development with Catalyst
1495 you might want to start with a tutorial.</p>
1496 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1498 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1500 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1501 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1503 <h2>What to do next?</h2>
1504 <p>Next it's time to write an actual application. Use the
1505 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1506 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1507 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1508 they can save you a lot of work.</p>
1509 <pre><code>script/${prefix}_create.pl --help</code></pre>
1510 <p>Also, be sure to check out the vast and growing
1511 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1512 you are likely to find what you need there.
1516 <p>Catalyst has a very active community. Here are the main places to
1517 get in touch with us.</p>
1520 <a href="http://dev.catalyst.perl.org">Wiki</a>
1523 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1526 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1529 <h2>In conclusion</h2>
1530 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1531 as we enjoyed making it. Please contact us if you have ideas
1532 for improvement or other feedback.</p>
1540 =head1 INTERNAL METHODS
1542 These methods are not meant to be used by end users.
1544 =head2 $c->components
1546 Returns a hash of components.
1548 =head2 $c->context_class
1550 Returns or sets the context class.
1554 Returns a hashref containing coderefs and execution counts (needed for
1555 deep recursion detection).
1559 Returns the number of actions on the current internal execution stack.
1563 Dispatches a request to actions.
1567 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1569 =head2 $c->dispatcher_class
1571 Returns or sets the dispatcher class.
1573 =head2 $c->dump_these
1575 Returns a list of 2-element array references (name, structure) pairs
1576 that will be dumped on the error page in debug mode.
1582 [ Request => $c->req ],
1583 [ Response => $c->res ],
1584 [ Stash => $c->stash ],
1585 [ Config => $c->config ];
1588 =head2 $c->engine_class
1590 Returns or sets the engine class.
1592 =head2 $c->execute( $class, $coderef )
1594 Execute a coderef in given class and catch exceptions. Errors are available
1600 my ( $c, $class, $code ) = @_;
1601 $class = $c->component($class) || $class;
1604 if ( $c->depth >= $RECURSION ) {
1605 my $action = $code->reverse();
1606 $action = "/$action" unless $action =~ /->/;
1607 my $error = qq/Deep recursion detected calling "${action}"/;
1608 $c->log->error($error);
1614 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1616 push( @{ $c->stack }, $code );
1618 no warnings 'recursion';
1619 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1620 # I have no idea how, ergo $ret (which appears to fix the issue)
1621 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1623 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1625 my $last = pop( @{ $c->stack } );
1627 if ( my $error = $@ ) {
1628 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1629 $error->rethrow if $c->depth > 1;
1631 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1632 $error->rethrow if $c->depth > 0;
1635 unless ( ref $error ) {
1636 no warnings 'uninitialized';
1638 my $class = $last->class;
1639 my $name = $last->name;
1640 $error = qq/Caught exception in $class->$name "$error"/;
1649 sub _stats_start_execute {
1650 my ( $c, $code ) = @_;
1651 my $appclass = ref($c) || $c;
1652 return if ( ( $code->name =~ /^_.*/ )
1653 && ( !$appclass->config->{show_internal_actions} ) );
1655 my $action_name = $code->reverse();
1656 $c->counter->{$action_name}++;
1658 my $action = $action_name;
1659 $action = "/$action" unless $action =~ /->/;
1661 # determine if the call was the result of a forward
1662 # this is done by walking up the call stack and looking for a calling
1663 # sub of Catalyst::forward before the eval
1665 for my $index ( 2 .. 11 ) {
1667 if ( ( caller($index) )[0] eq 'Catalyst'
1668 && ( caller($index) )[3] eq '(eval)' );
1670 if ( ( caller($index) )[3] =~ /forward$/ ) {
1671 $callsub = ( caller($index) )[3];
1672 $action = "-> $action";
1677 my $uid = $action_name . $c->counter->{$action_name};
1679 # is this a root-level call or a forwarded call?
1680 if ( $callsub =~ /forward$/ ) {
1681 my $parent = $c->stack->[-1];
1683 # forward, locate the caller
1684 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1687 parent => "$parent" . $c->counter->{"$parent"},
1693 # forward with no caller may come from a plugin
1712 sub _stats_finish_execute {
1713 my ( $c, $info ) = @_;
1714 $c->stats->profile( end => $info );
1719 Finalizes the request.
1726 for my $error ( @{ $c->error } ) {
1727 $c->log->error($error);
1730 # Allow engine to handle finalize flow (for POE)
1731 my $engine = $c->engine;
1732 if ( my $code = $engine->can('finalize') ) {
1737 $c->finalize_uploads;
1740 if ( $#{ $c->error } >= 0 ) {
1744 $c->finalize_headers;
1747 if ( $c->request->method eq 'HEAD' ) {
1748 $c->response->body('');
1756 if ($c->use_stats) {
1757 my $elapsed = sprintf '%f', $c->stats->elapsed;
1758 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1760 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1763 return $c->response->status;
1766 =head2 $c->finalize_body
1772 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1774 =head2 $c->finalize_cookies
1780 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1782 =head2 $c->finalize_error
1788 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1790 =head2 $c->finalize_headers
1796 sub finalize_headers {
1799 my $response = $c->response; #accessor calls can add up?
1801 # Check if we already finalized headers
1802 return if $response->finalized_headers;
1805 if ( my $location = $response->redirect ) {
1806 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1807 $response->header( Location => $location );
1809 if ( !$response->has_body ) {
1810 # Add a default body if none is already present
1811 $response->body(<<"EOF");
1812 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1813 <html xmlns="http://www.w3.org/1999/xhtml">
1815 <title>Moved</title>
1818 <p>This item has moved <a href="$location">here</a>.</p>
1822 $response->content_type('text/html; charset=utf-8');
1827 if ( defined $response->body && length $response->body && !$response->content_length ) {
1829 # get the length from a filehandle
1830 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1832 my $size = -s $response->body;
1834 $response->content_length( $size );
1837 $c->log->warn('Serving filehandle without a content-length');
1841 # everything should be bytes at this point, but just in case
1842 $response->content_length( length( $response->body ) );
1847 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1848 $response->headers->remove_header("Content-Length");
1849 $response->body('');
1852 $c->finalize_cookies;
1854 $c->engine->finalize_headers( $c, @_ );
1857 $response->finalized_headers(1);
1860 =head2 $c->finalize_output
1862 An alias for finalize_body.
1864 =head2 $c->finalize_read
1866 Finalizes the input after reading is complete.
1870 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1872 =head2 $c->finalize_uploads
1874 Finalizes uploads. Cleans up any temporary files.
1878 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1880 =head2 $c->get_action( $action, $namespace )
1882 Gets an action in a given namespace.
1886 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1888 =head2 $c->get_actions( $action, $namespace )
1890 Gets all actions of a given name in a namespace and all parent
1895 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1897 =head2 $app->handle_request( @arguments )
1899 Called to handle each HTTP request.
1903 sub handle_request {
1904 my ( $class, @arguments ) = @_;
1906 # Always expect worst case!
1909 if ($class->debug) {
1910 my $secs = time - $START || 1;
1911 my $av = sprintf '%.3f', $COUNT / $secs;
1912 my $time = localtime time;
1913 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1916 my $c = $class->prepare(@arguments);
1918 $status = $c->finalize;
1921 chomp(my $error = $_);
1922 $class->log->error(qq/Caught exception in engine "$error"/);
1927 if(my $coderef = $class->log->can('_flush')){
1928 $class->log->$coderef();
1933 =head2 $class->prepare( @arguments )
1935 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1941 my ( $class, @arguments ) = @_;
1944 # After the app/ctxt split, this should become an attribute based on something passed
1945 # into the application.
1946 $class->context_class( ref $class || $class ) unless $class->context_class;
1948 my $c = $class->context_class->new({});
1950 # For on-demand data
1951 $c->request->_context($c);
1952 $c->response->_context($c);
1954 #surely this is not the most efficient way to do things...
1955 $c->stats($class->stats_class->new)->enable($c->use_stats);
1956 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1957 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1961 # Allow engine to direct the prepare flow (for POE)
1962 if ( my $prepare = $c->engine->can('prepare') ) {
1963 $c->engine->$prepare( $c, @arguments );
1966 $c->prepare_request(@arguments);
1967 $c->prepare_connection;
1968 $c->prepare_query_parameters;
1969 $c->prepare_headers;
1970 $c->prepare_cookies;
1973 # Prepare the body for reading, either by prepare_body
1974 # or the user, if they are using $c->read
1977 # Parse the body unless the user wants it on-demand
1978 unless ( ref($c)->config->{parse_on_demand} ) {
1983 # VERY ugly and probably shouldn't rely on ->finalize actually working
1985 # failed prepare is always due to an invalid request, right?
1986 $c->response->status(400);
1987 $c->response->content_type('text/plain');
1988 $c->response->body('Bad Request');
1993 my $method = $c->req->method || '';
1994 my $path = $c->req->path;
1995 $path = '/' unless length $path;
1996 my $address = $c->req->address || '';
2005 =head2 $c->prepare_action
2007 Prepares action. See L<Catalyst::Dispatcher>.
2011 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2013 =head2 $c->prepare_body
2015 Prepares message body.
2022 return if $c->request->_has_body;
2024 # Initialize on-demand data
2025 $c->engine->prepare_body( $c, @_ );
2026 $c->prepare_parameters;
2027 $c->prepare_uploads;
2030 =head2 $c->prepare_body_chunk( $chunk )
2032 Prepares a chunk of data before sending it to L<HTTP::Body>.
2034 See L<Catalyst::Engine>.
2038 sub prepare_body_chunk {
2040 $c->engine->prepare_body_chunk( $c, @_ );
2043 =head2 $c->prepare_body_parameters
2045 Prepares body parameters.
2049 sub prepare_body_parameters {
2051 $c->engine->prepare_body_parameters( $c, @_ );
2054 =head2 $c->prepare_connection
2056 Prepares connection.
2060 sub prepare_connection {
2062 $c->engine->prepare_connection( $c, @_ );
2065 =head2 $c->prepare_cookies
2071 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2073 =head2 $c->prepare_headers
2079 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2081 =head2 $c->prepare_parameters
2083 Prepares parameters.
2087 sub prepare_parameters {
2089 $c->prepare_body_parameters;
2090 $c->engine->prepare_parameters( $c, @_ );
2093 =head2 $c->prepare_path
2095 Prepares path and base.
2099 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2101 =head2 $c->prepare_query_parameters
2103 Prepares query parameters.
2107 sub prepare_query_parameters {
2110 $c->engine->prepare_query_parameters( $c, @_ );
2113 =head2 $c->log_request
2115 Writes information about the request to the debug logs. This includes:
2119 =item * Request method, path, and remote IP address
2121 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2123 =item * Request parameters
2125 =item * File uploads
2134 return unless $c->debug;
2136 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2137 my $request = $dump->[1];
2139 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2141 $path = '/' unless length $path;
2143 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2145 $c->log_request_headers($request->headers);
2147 if ( my $keywords = $request->query_keywords ) {
2148 $c->log->debug("Query keywords are: $keywords");
2151 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2153 $c->log_request_uploads($request);
2156 =head2 $c->log_response
2158 Writes information about the response to the debug logs by calling
2159 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2166 return unless $c->debug;
2168 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2169 my $response = $dump->[1];
2171 $c->log_response_status_line($response);
2172 $c->log_response_headers($response->headers);
2175 =head2 $c->log_response_status_line($response)
2177 Writes one line of information about the response to the debug logs. This includes:
2181 =item * Response status code
2183 =item * Content-Type header (if present)
2185 =item * Content-Length header (if present)
2191 sub log_response_status_line {
2192 my ($c, $response) = @_;
2196 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2197 $response->status || 'unknown',
2198 $response->headers->header('Content-Type') || 'unknown',
2199 $response->headers->header('Content-Length') || 'unknown'
2204 =head2 $c->log_response_headers($headers);
2206 Hook method which can be wrapped by plugins to log the response headers.
2207 No-op in the default implementation.
2211 sub log_response_headers {}
2213 =head2 $c->log_request_parameters( query => {}, body => {} )
2215 Logs request parameters to debug logs
2219 sub log_request_parameters {
2221 my %all_params = @_;
2223 return unless $c->debug;
2225 my $column_width = Catalyst::Utils::term_width() - 44;
2226 foreach my $type (qw(query body)) {
2227 my $params = $all_params{$type};
2228 next if ! keys %$params;
2229 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2230 for my $key ( sort keys %$params ) {
2231 my $param = $params->{$key};
2232 my $value = defined($param) ? $param : '';
2233 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2235 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2239 =head2 $c->log_request_uploads
2241 Logs file uploads included in the request to the debug logs.
2242 The parameter name, filename, file type, and file size are all included in
2247 sub log_request_uploads {
2249 my $request = shift;
2250 return unless $c->debug;
2251 my $uploads = $request->uploads;
2252 if ( keys %$uploads ) {
2253 my $t = Text::SimpleTable->new(
2254 [ 12, 'Parameter' ],
2259 for my $key ( sort keys %$uploads ) {
2260 my $upload = $uploads->{$key};
2261 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2262 $t->row( $key, $u->filename, $u->type, $u->size );
2265 $c->log->debug( "File Uploads are:\n" . $t->draw );
2269 =head2 $c->log_request_headers($headers);
2271 Hook method which can be wrapped by plugins to log the request headers.
2272 No-op in the default implementation.
2276 sub log_request_headers {}
2278 =head2 $c->log_headers($type => $headers)
2280 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2287 my $headers = shift; # an HTTP::Headers instance
2289 return unless $c->debug;
2291 my $column_width = Catalyst::Utils::term_width() - 28;
2292 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2295 my ( $name, $value ) = @_;
2296 $t->row( $name, $value );
2299 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2303 =head2 $c->prepare_read
2305 Prepares the input for reading.
2309 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2311 =head2 $c->prepare_request
2313 Prepares the engine request.
2317 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2319 =head2 $c->prepare_uploads
2325 sub prepare_uploads {
2328 $c->engine->prepare_uploads( $c, @_ );
2331 =head2 $c->prepare_write
2333 Prepares the output for writing.
2337 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2339 =head2 $c->request_class
2341 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2343 =head2 $c->response_class
2345 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2347 =head2 $c->read( [$maxlength] )
2349 Reads a chunk of data from the request body. This method is designed to
2350 be used in a while loop, reading C<$maxlength> bytes on every call.
2351 C<$maxlength> defaults to the size of the request if not specified.
2353 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2356 Warning: If you use read(), Catalyst will not process the body,
2357 so you will not be able to access POST parameters or file uploads via
2358 $c->request. You must handle all body parsing yourself.
2362 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2372 $app->engine_loader->needs_psgi_engine_compat_hack ?
2373 $app->engine->run($app, @_) :
2374 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2377 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2379 Sets an action in a given namespace.
2383 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2385 =head2 $c->setup_actions($component)
2387 Sets up actions for a component.
2391 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2393 =head2 $c->setup_components
2395 This method is called internally to set up the application's components.
2397 It finds modules by calling the L<locate_components> method, expands them to
2398 package names with the L<expand_component_module> method, and then installs
2399 each component into the application.
2401 The C<setup_components> config option is passed to both of the above methods.
2403 Installation of each component is performed by the L<setup_component> method,
2408 sub setup_components {
2411 my $config = $class->config->{ setup_components };
2413 my @comps = $class->locate_components($config);
2414 my %comps = map { $_ => 1 } @comps;
2416 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2417 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2418 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2419 ) if $deprecatedcatalyst_component_names;
2421 for my $component ( @comps ) {
2423 # We pass ignore_loaded here so that overlay files for (e.g.)
2424 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2425 # we know M::P::O found a file on disk so this is safe
2427 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2430 for my $component (@comps) {
2431 my $instance = $class->components->{ $component } = $class->setup_component($component);
2432 my @expanded_components = $instance->can('expand_modules')
2433 ? $instance->expand_modules( $component, $config )
2434 : $class->expand_component_module( $component, $config );
2435 for my $component (@expanded_components) {
2436 next if $comps{$component};
2437 $class->components->{ $component } = $class->setup_component($component);
2442 =head2 $c->locate_components( $setup_component_config )
2444 This method is meant to provide a list of component modules that should be
2445 setup for the application. By default, it will use L<Module::Pluggable>.
2447 Specify a C<setup_components> config option to pass additional options directly
2448 to L<Module::Pluggable>. To add additional search paths, specify a key named
2449 C<search_extra> as an array reference. Items in the array beginning with C<::>
2450 will have the application class name prepended to them.
2454 sub locate_components {
2458 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2459 my $extra = delete $config->{ search_extra } || [];
2461 push @paths, @$extra;
2463 my $locator = Module::Pluggable::Object->new(
2464 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2468 # XXX think about ditching this sort entirely
2469 my @comps = sort { length $a <=> length $b } $locator->plugins;
2474 =head2 $c->expand_component_module( $component, $setup_component_config )
2476 Components found by C<locate_components> will be passed to this method, which
2477 is expected to return a list of component (package) names to be set up.
2481 sub expand_component_module {
2482 my ($class, $module) = @_;
2483 return Devel::InnerPackage::list_packages( $module );
2486 =head2 $c->setup_component
2490 sub setup_component {
2491 my( $class, $component ) = @_;
2493 unless ( $component->can( 'COMPONENT' ) ) {
2497 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2498 my $config = $class->config->{ $suffix } || {};
2499 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2500 # methods also pass it. local to avoid pointlessly shitting in config
2501 # for the debug screen, as $component is already the key name.
2502 local $config->{catalyst_component_name} = $component;
2504 my $instance = eval { $component->COMPONENT( $class, $config ); };
2506 if ( my $error = $@ ) {
2508 Catalyst::Exception->throw(
2509 message => qq/Couldn't instantiate component "$component", "$error"/
2513 unless (blessed $instance) {
2514 my $metaclass = Moose::Util::find_meta($component);
2515 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2516 my $component_method_from = $method_meta->associated_metaclass->name;
2517 my $value = defined($instance) ? $instance : 'undef';
2518 Catalyst::Exception->throw(
2520 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2526 =head2 $c->setup_dispatcher
2532 sub setup_dispatcher {
2533 my ( $class, $dispatcher ) = @_;
2536 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2539 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2540 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2543 unless ($dispatcher) {
2544 $dispatcher = $class->dispatcher_class;
2547 Class::MOP::load_class($dispatcher);
2549 # dispatcher instance
2550 $class->dispatcher( $dispatcher->new );
2553 =head2 $c->setup_engine
2560 my ($class, $requested_engine) = @_;
2562 if (!$class->engine_loader || $requested_engine) {
2563 $class->engine_loader(
2564 Catalyst::EngineLoader->new({
2565 application_name => $class,
2566 (defined $requested_engine
2567 ? (catalyst_engine_class => $requested_engine) : ()),
2572 $class->engine_loader->catalyst_engine_class;
2576 my ($class, $requested_engine) = @_;
2579 my $loader = $class->engine_loader;
2581 if (!$loader || $requested_engine) {
2582 $loader = Catalyst::EngineLoader->new({
2583 application_name => $class,
2584 (defined $requested_engine
2585 ? (requested_engine => $requested_engine) : ()),
2588 $class->engine_loader($loader);
2591 $loader->catalyst_engine_class;
2594 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2595 return if $class->loading_psgi_file;
2597 Class::MOP::load_class($engine);
2599 if ($ENV{MOD_PERL}) {
2600 my $apache = $class->engine_loader->auto;
2602 my $meta = find_meta($class);
2603 my $was_immutable = $meta->is_immutable;
2604 my %immutable_options = $meta->immutable_options;
2605 $meta->make_mutable if $was_immutable;
2607 $meta->add_method(handler => sub {
2609 my $psgi_app = $class->psgi_app;
2610 $apache->call_app($r, $psgi_app);
2613 $meta->make_immutable(%immutable_options) if $was_immutable;
2616 $class->engine( $engine->new );
2621 sub _finalized_psgi_app {
2624 unless ($app->_psgi_app) {
2625 my $psgi_app = $app->_setup_psgi_app;
2626 $app->_psgi_app($psgi_app);
2629 return $app->_psgi_app;
2632 sub _setup_psgi_app {
2635 for my $home (Path::Class::Dir->new($app->config->{home})) {
2636 my $psgi_file = $home->file(
2637 Catalyst::Utils::appprefix($app) . '.psgi',
2640 next unless -e $psgi_file;
2642 # If $psgi_file calls ->setup_engine, it's doing so to load
2643 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2644 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2645 # anyway. So set a flag (ick) that tells setup_engine not to populate
2646 # $c->engine or do any other things we might regret.
2648 $app->loading_psgi_file(1);
2649 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2650 $app->loading_psgi_file(0);
2653 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2656 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2658 Its content has been ignored. Please consult the Catalyst::Upgrading
2659 documentation on how to upgrade from Catalyst::Engine::PSGI.
2663 return $app->apply_default_middlewares($app->psgi_app);
2666 =head2 $c->apply_default_middlewares
2668 Adds the following L<Plack> middlewares to your application, since they are
2669 useful and commonly needed:
2671 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2672 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2673 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2674 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2675 applied since this middleware is smart enough to conditionally apply itself).
2677 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2678 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2684 sub apply_default_middlewares {
2685 my ($app, $psgi_app) = @_;
2687 $psgi_app = Plack::Middleware::Conditional->wrap(
2689 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2692 return if $app->config->{ignore_frontend_proxy};
2693 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2694 || $app->config->{using_frontend_proxy};
2698 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2699 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2700 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
2702 # we're applying this unconditionally as the middleware itself already makes
2703 # sure it doesn't fuck things up if it's not running under one of the right
2705 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2712 Returns a PSGI application code reference for the catalyst application
2713 C<$c>. This is the bare application without any middlewares
2714 applied. C<${myapp}.psgi> is not taken into account.
2716 This is what you want to be using to retrieve the PSGI application code
2717 reference of your Catalyst application for use in F<.psgi> files.
2723 return $app->engine->build_psgi_app($app);
2726 =head2 $c->setup_home
2728 Sets up the home directory.
2733 my ( $class, $home ) = @_;
2735 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2739 $home ||= Catalyst::Utils::home($class);
2742 #I remember recently being scolded for assigning config values like this
2743 $class->config->{home} ||= $home;
2744 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2748 =head2 $c->setup_log
2750 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2751 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2754 This method also installs a C<debug> method that returns a true value into the
2755 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2756 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2758 Note that if the log has already been setup, by either a previous call to
2759 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2760 that this method won't actually set up the log object.
2765 my ( $class, $levels ) = @_;
2768 $levels =~ s/^\s+//;
2769 $levels =~ s/\s+$//;
2770 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2772 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2773 if ( defined $env_debug ) {
2774 $levels{debug} = 1 if $env_debug; # Ugly!
2775 delete($levels{debug}) unless $env_debug;
2778 unless ( $class->log ) {
2779 $class->log( Catalyst::Log->new(keys %levels) );
2782 if ( $levels{debug} ) {
2783 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2784 $class->log->debug('Debug messages enabled');
2788 =head2 $c->setup_plugins
2794 =head2 $c->setup_stats
2796 Sets up timing statistics class.
2801 my ( $class, $stats ) = @_;
2803 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2805 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2806 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2807 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2808 $class->log->debug('Statistics enabled');
2813 =head2 $c->registered_plugins
2815 Returns a sorted list of the plugins which have either been stated in the
2818 If passed a given plugin name, it will report a boolean value indicating
2819 whether or not that plugin is loaded. A fully qualified name is required if
2820 the plugin name does not begin with C<Catalyst::Plugin::>.
2822 if ($c->registered_plugins('Some::Plugin')) {
2830 sub registered_plugins {
2832 return sort keys %{ $proto->_plugins } unless @_;
2834 return 1 if exists $proto->_plugins->{$plugin};
2835 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2838 sub _register_plugin {
2839 my ( $proto, $plugin, $instant ) = @_;
2840 my $class = ref $proto || $proto;
2842 Class::MOP::load_class( $plugin );
2843 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2844 if $plugin->isa( 'Catalyst::Component' );
2845 $proto->_plugins->{$plugin} = 1;
2847 my $meta = Class::MOP::get_metaclass_by_name($class);
2848 $meta->superclasses($plugin, $meta->superclasses);
2854 my ( $class, $plugins ) = @_;
2856 $class->_plugins( {} ) unless $class->_plugins;
2857 $plugins = Data::OptList::mkopt($plugins || []);
2860 [ Catalyst::Utils::resolve_namespace(
2861 $class . '::Plugin',
2862 'Catalyst::Plugin', $_->[0]
2868 for my $plugin ( reverse @plugins ) {
2869 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2870 my $meta = find_meta($plugin->[0]);
2871 next if $meta && $meta->isa('Moose::Meta::Role');
2873 $class->_register_plugin($plugin->[0]);
2877 map { $_->[0]->name, $_->[1] }
2878 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2879 map { [find_meta($_->[0]), $_->[1]] }
2882 Moose::Util::apply_all_roles(
2890 Returns an arrayref of the internal execution stack (actions that are
2891 currently executing).
2895 Returns the current timing statistics object. By default Catalyst uses
2896 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2897 L<< stats_class|/"$c->stats_class" >>.
2899 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2900 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2901 profile explicitly, although MyApp.pm still won't profile nor output anything
2904 =head2 $c->stats_class
2906 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2908 =head2 $c->use_stats
2910 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2912 Note that this is a static method, not an accessor and should be overridden
2913 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2920 =head2 $c->write( $data )
2922 Writes $data to the output stream. When using this method directly, you
2923 will need to manually set the C<Content-Length> header to the length of
2924 your output data, if known.
2931 # Finalize headers if someone manually writes output
2932 $c->finalize_headers;
2934 return $c->engine->write( $c, @_ );
2939 Returns the Catalyst version number. Mostly useful for "powered by"
2940 messages in template systems.
2944 sub version { return $Catalyst::VERSION }
2946 =head1 CONFIGURATION
2948 There are a number of 'base' config variables which can be set:
2954 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2958 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2962 C<disable_component_resolution_regex_fallback> - Turns
2963 off the deprecated component resolution functionality so
2964 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2965 are called then regex search will not be attempted on string values and
2966 instead C<undef> will be returned.
2970 C<home> - The application home directory. In an uninstalled application,
2971 this is the top level application directory. In an installed application,
2972 this will be the directory containing C<< MyApp.pm >>.
2976 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2980 C<name> - The name of the application in debug messages and the debug and
2985 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2986 until it is accessed. This allows you to (for example) check authentication (and reject
2987 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
2991 C<root> - The root directory for templates. Usually this is just a
2992 subdirectory of the home directory, but you can set it to change the
2993 templates to a different directory.
2997 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2998 namespaces from which components will be loaded (and constructed and stored in
2999 C<< $c->components >>).
3003 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3004 to be shown in hit debug tables in the test server.
3008 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
3009 variable should be used for determining the request path.
3011 Most web server environments pass the requested path to the application using environment variables,
3012 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3013 exposed as C<< $c->request->base >>) and the request path below that base.
3015 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3016 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3020 =item use_request_uri_for_path => 0
3022 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3023 The path is synthesised from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3024 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3025 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3027 However this method has the major disadvantage that it is impossible to correctly decode some elements
3028 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3029 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3030 can't distinguish / vs %2F in paths (in addition to other encoded values).
3032 =item use_request_uri_for_path => 1
3034 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3035 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3036 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3038 Given that this method of path resolution is provably more correct, it is recommended that you use
3039 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3040 aware of the implications of not being able to handle encoded URI paths correctly.
3042 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3043 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3044 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3045 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3046 C<< $c->request->base >> will be incorrect.
3052 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3056 =head1 INTERNAL ACTIONS
3058 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3059 C<_ACTION>, and C<_END>. These are by default not shown in the private
3060 action table, but you can make them visible with a config parameter.
3062 MyApp->config(show_internal_actions => 1);
3064 =head1 ON-DEMAND PARSER
3066 The request body is usually parsed at the beginning of a request,
3067 but if you want to handle input yourself, you can enable on-demand
3068 parsing with a config parameter.
3070 MyApp->config(parse_on_demand => 1);
3072 =head1 PROXY SUPPORT
3074 Many production servers operate using the common double-server approach,
3075 with a lightweight frontend web server passing requests to a larger
3076 backend server. An application running on the backend server must deal
3077 with two problems: the remote user always appears to be C<127.0.0.1> and
3078 the server's hostname will appear to be C<localhost> regardless of the
3079 virtual host that the user connected through.
3081 Catalyst will automatically detect this situation when you are running
3082 the frontend and backend servers on the same machine. The following
3083 changes are made to the request.
3085 $c->req->address is set to the user's real IP address, as read from
3086 the HTTP X-Forwarded-For header.
3088 The host value for $c->req->base and $c->req->uri is set to the real
3089 host, as read from the HTTP X-Forwarded-Host header.
3091 Additionally, you may be running your backend application on an insecure
3092 connection (port 80) while your frontend proxy is running under SSL. If there
3093 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3094 tell Catalyst what port the frontend listens on. This will allow all URIs to
3095 be created properly.
3097 In the case of passing in:
3099 X-Forwarded-Port: 443
3101 All calls to C<uri_for> will result in an https link, as is expected.
3103 Obviously, your web server must support these headers for this to work.
3105 In a more complex server farm environment where you may have your
3106 frontend proxy server(s) on different machines, you will need to set a
3107 configuration option to tell Catalyst to read the proxied data from the
3110 MyApp->config(using_frontend_proxy => 1);
3112 If you do not wish to use the proxy support at all, you may set:
3114 MyApp->config(ignore_frontend_proxy => 1);
3116 =head1 THREAD SAFETY
3118 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3119 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3120 believe the Catalyst core to be thread-safe.
3122 If you plan to operate in a threaded environment, remember that all other
3123 modules you are using must also be thread-safe. Some modules, most notably
3124 L<DBD::SQLite>, are not thread-safe.
3130 Join #catalyst on irc.perl.org.
3134 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3135 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3139 http://catalyst.perl.org
3143 http://dev.catalyst.perl.org
3147 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3149 =head2 L<Catalyst::Manual> - The Catalyst Manual
3151 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3153 =head2 L<Catalyst::Engine> - Core engine
3155 =head2 L<Catalyst::Log> - Log class.
3157 =head2 L<Catalyst::Request> - Request object
3159 =head2 L<Catalyst::Response> - Response object
3161 =head2 L<Catalyst::Test> - The test suite.
3165 =head1 PROJECT FOUNDER
3167 sri: Sebastian Riedel <sri@cpan.org>
3173 acme: Leon Brocard <leon@astray.com>
3175 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3179 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3183 andyg: Andy Grundman <andy@hybridized.org>
3185 audreyt: Audrey Tang
3187 bricas: Brian Cassidy <bricas@cpan.org>
3189 Caelum: Rafael Kitover <rkitover@io.com>
3191 chansen: Christian Hansen
3193 chicks: Christopher Hicks
3195 Chisel Wright C<pause@herlpacker.co.uk>
3197 Danijel Milicevic C<me@danijel.de>
3199 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3201 David Naughton, C<naughton@umn.edu>
3205 dhoss: Devin Austin <dhoss@cpan.org>
3207 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3211 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3213 esskar: Sascha Kiefer
3215 fireartist: Carl Franks <cfranks@cpan.org>
3217 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3219 gabb: Danijel Milicevic
3223 Gavin Henry C<ghenry@perl.me.uk>
3227 groditi: Guillermo Roditi <groditi@gmail.com>
3229 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3231 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3233 jcamacho: Juan Camacho
3235 jester: Jesse Sheidlower C<jester@panix.com>
3237 jhannah: Jay Hannah <jay@jays.net>
3243 jon: Jon Schutz <jjschutz@cpan.org>
3245 Jonathan Rockway C<< <jrockway@cpan.org> >>
3247 Kieren Diment C<kd@totaldatasolution.com>
3249 konobi: Scott McWhirter <konobi@cpan.org>
3251 marcus: Marcus Ramberg <mramberg@cpan.org>
3253 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3255 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3259 naughton: David Naughton
3261 ningu: David Kamholz <dkamholz@cpan.org>
3263 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3265 numa: Dan Sully <daniel@cpan.org>
3271 omega: Andreas Marienborg
3273 Oleg Kostyuk <cub.uanic@gmail.com>
3275 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3277 rafl: Florian Ragwitz <rafl@debian.org>
3279 random: Roland Lammel <lammel@cpan.org>
3281 Robert Sedlacek C<< <rs@474.at> >>
3283 SpiceMan: Marcel Montes
3287 szbalint: Balint Szilakszi <szbalint@cpan.org>
3289 t0m: Tomas Doran <bobtfish@bobtfish.net>
3293 Viljo Marrandi C<vilts@yahoo.com>
3295 Will Hawes C<info@whawes.co.uk>
3297 willert: Sebastian Willert <willert@cpan.org>
3299 wreis: Wallace Reis <wallace@reis.org.br>
3301 Yuval Kogman, C<nothingmuch@woobling.org>
3303 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3305 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3311 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3315 This library is free software. You can redistribute it and/or modify it under
3316 the same terms as Perl itself.
3322 __PACKAGE__->meta->make_immutable;