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 { {} });
54 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
55 $self->request_class->new(\%p);
59 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
60 has namespace => (is => 'rw');
62 sub depth { scalar @{ shift->stack || [] }; }
63 sub comp { shift->component(@_) }
66 my $self = shift; return $self->request(@_);
69 my $self = shift; return $self->response(@_);
72 # For backwards compatibility
73 sub finalize_output { shift->finalize_body(@_) };
78 our $RECURSION = 1000;
79 our $DETACH = Catalyst::Exception::Detach->new;
80 our $GO = Catalyst::Exception::Go->new;
82 #I imagine that very few of these really need to be class variables. if any.
83 #maybe we should just make them attributes with a default?
84 __PACKAGE__->mk_classdata($_)
85 for qw/components arguments dispatcher engine log dispatcher_class
86 engine_loader context_class request_class response_class stats_class
87 setup_finished _psgi_app loading_psgi_file run_options/;
89 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
90 __PACKAGE__->request_class('Catalyst::Request');
91 __PACKAGE__->response_class('Catalyst::Response');
92 __PACKAGE__->stats_class('Catalyst::Stats');
94 # Remember to update this in Catalyst::Runtime as well!
96 our $VERSION = '5.90006';
99 my ( $class, @arguments ) = @_;
101 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
103 return unless $class eq 'Catalyst';
105 my $caller = caller();
106 return if $caller eq 'main';
108 my $meta = Moose::Meta::Class->initialize($caller);
109 unless ( $caller->isa('Catalyst') ) {
110 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
111 $meta->superclasses(@superclasses);
113 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
114 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
116 unless( $meta->has_method('meta') ){
117 if ($Moose::VERSION >= 1.15) {
118 $meta->_add_meta_method('meta');
121 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
125 $caller->arguments( [@arguments] );
129 sub _application { $_[0] }
133 Catalyst - The Elegant MVC Web Application Framework
137 See the L<Catalyst::Manual> distribution for comprehensive
138 documentation and tutorials.
140 # Install Catalyst::Devel for helpers and other development tools
141 # use the helper to create a new application
144 # add models, views, controllers
145 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
146 script/myapp_create.pl view MyTemplate TT
147 script/myapp_create.pl controller Search
149 # built in testserver -- use -r to restart automatically on changes
150 # --help to see all available options
151 script/myapp_server.pl
153 # command line testing interface
154 script/myapp_test.pl /yada
157 use Catalyst qw/-Debug/; # include plugins here as well
159 ### In lib/MyApp/Controller/Root.pm (autocreated)
160 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
161 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
162 $c->stash->{template} = 'foo.tt'; # set the template
163 # lookup something from db -- stash vars are passed to TT
165 $c->model('Database::Foo')->search( { country => $args[0] } );
166 if ( $c->req->params->{bar} ) { # access GET or POST parameters
167 $c->forward( 'bar' ); # process another action
168 # do something else after forward returns
172 # The foo.tt TT template can use the stash data from the database
173 [% WHILE (item = data.next) %]
177 # called for /bar/of/soap, /bar/of/soap/10, etc.
178 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
180 # called after all actions are finished
182 my ( $self, $c ) = @_;
183 if ( scalar @{ $c->error } ) { ... } # handle errors
184 return if $c->res->body; # already have a response
185 $c->forward( 'MyApp::View::TT' ); # render template
188 See L<Catalyst::Manual::Intro> for additional information.
192 Catalyst is a modern framework for making web applications without the
193 pain usually associated with this process. This document is a reference
194 to the main Catalyst application. If you are a new user, we suggest you
195 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
197 See L<Catalyst::Manual> for more documentation.
199 Catalyst plugins can be loaded by naming them as arguments to the "use
200 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
201 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
204 use Catalyst qw/My::Module/;
206 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
207 fully qualify the name by using a unary plus:
211 +Fully::Qualified::Plugin::Name
214 Special flags like C<-Debug> can also be specified as
215 arguments when Catalyst is loaded:
217 use Catalyst qw/-Debug My::Module/;
219 The position of plugins and flags in the chain is important, because
220 they are loaded in the order in which they appear.
222 The following flags are supported:
226 Enables debug output. You can also force this setting from the system
227 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
228 settings override the application, with <MYAPP>_DEBUG having the highest
231 This sets the log level to 'debug' and enables full debug output on the
232 error screen. If you only want the latter, see L<< $c->debug >>.
236 Forces Catalyst to use a specific home directory, e.g.:
238 use Catalyst qw[-Home=/usr/mst];
240 This can also be done in the shell environment by setting either the
241 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
242 is replaced with the uppercased name of your application, any "::" in
243 the name will be replaced with underscores, e.g. MyApp::Web should use
244 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
246 If none of these are set, Catalyst will attempt to automatically detect the
247 home directory. If you are working in a development environment, Catalyst
248 will try and find the directory containing either Makefile.PL, Build.PL or
249 dist.ini. If the application has been installed into the system (i.e.
250 you have done C<make install>), then Catalyst will use the path to your
251 application module, without the .pm extension (e.g., /foo/MyApp if your
252 application was installed at /foo/MyApp.pm)
256 use Catalyst '-Log=warn,fatal,error';
258 Specifies a comma-delimited list of log levels.
262 Enables statistics collection and reporting.
264 use Catalyst qw/-Stats=1/;
266 You can also force this setting from the system environment with CATALYST_STATS
267 or <MYAPP>_STATS. The environment settings override the application, with
268 <MYAPP>_STATS having the highest priority.
270 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
274 =head2 INFORMATION ABOUT THE CURRENT REQUEST
278 Returns a L<Catalyst::Action> object for the current action, which
279 stringifies to the action name. See L<Catalyst::Action>.
283 Returns the namespace of the current action, i.e., the URI prefix
284 corresponding to the controller of the current action. For example:
286 # in Controller::Foo::Bar
287 $c->namespace; # returns 'foo/bar';
293 Returns the current L<Catalyst::Request> object, giving access to
294 information about the current client request (including parameters,
295 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
297 =head2 REQUEST FLOW HANDLING
299 =head2 $c->forward( $action [, \@arguments ] )
301 =head2 $c->forward( $class, $method, [, \@arguments ] )
303 Forwards processing to another action, by its private name. If you give a
304 class name but no method, C<process()> is called. You may also optionally
305 pass arguments in an arrayref. The action will receive the arguments in
306 C<@_> and C<< $c->req->args >>. Upon returning from the function,
307 C<< $c->req->args >> will be restored to the previous values.
309 Any data C<return>ed from the action forwarded to, will be returned by the
312 my $foodata = $c->forward('/foo');
313 $c->forward('index');
314 $c->forward(qw/Model::DBIC::Foo do_stuff/);
315 $c->forward('View::TT');
317 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
318 an C<< eval { } >> around the call (actually
319 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
320 exceptions thrown by the called action non-fatal and pushing them onto
321 $c->error instead. If you want C<die> to propagate you need to do something
325 die join "\n", @{ $c->error } if @{ $c->error };
327 Or make sure to always return true values from your actions and write
330 $c->forward('foo') || return;
332 Another note is that C<< $c->forward >> always returns a scalar because it
333 actually returns $c->state which operates in a scalar context.
334 Thus, something like:
338 in an action that is forwarded to is going to return a scalar,
339 i.e. how many items are in that array, which is probably not what you want.
340 If you need to return an array then return a reference to it,
343 $c->stash->{array} = \@array;
345 and access it from the stash.
347 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.
351 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
353 =head2 $c->detach( $action [, \@arguments ] )
355 =head2 $c->detach( $class, $method, [, \@arguments ] )
359 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
360 doesn't return to the previous action when processing is finished.
362 When called with no arguments it escapes the processing chain entirely.
366 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
368 =head2 $c->visit( $action [, \@captures, \@arguments ] )
370 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
372 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
373 but does a full dispatch, instead of just calling the new C<$action> /
374 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
375 you go to are called, just like a new request.
377 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
378 This means, for example, that C<< $c->action >> methods such as
379 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
380 L<reverse|Catalyst::Action/reverse> return information for the visited action
381 when they are invoked within the visited action. This is different from the
382 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
383 continues to use the $c->action object from the caller action even when
384 invoked from the called action.
386 C<< $c->stash >> is kept unchanged.
388 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
389 allows you to "wrap" another action, just as it would have been called by
390 dispatching from a URL, while the analogous
391 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
392 transfer control to another action as if it had been reached directly from a URL.
396 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
398 =head2 $c->go( $action [, \@captures, \@arguments ] )
400 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
402 The relationship between C<go> and
403 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
404 the relationship between
405 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
406 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
407 C<< $c->go >> will perform a full dispatch on the specified action or method,
408 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
409 C<go> escapes the processing of the current request chain on completion, and
410 does not return to its caller.
412 @arguments are arguments to the final destination of $action. @captures are
413 arguments to the intermediate steps, if any, on the way to the final sub of
418 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
424 Returns the current L<Catalyst::Response> object, see there for details.
428 Returns a hashref to the stash, which may be used to store data and pass
429 it between components during a request. You can also set hash keys by
430 passing arguments. The stash is automatically sent to the view. The
431 stash is cleared at the end of a request; it cannot be used for
432 persistent storage (for this you must use a session; see
433 L<Catalyst::Plugin::Session> for a complete system integrated with
436 $c->stash->{foo} = $bar;
437 $c->stash( { moose => 'majestic', qux => 0 } );
438 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
440 # stash is automatically passed to the view for use in a template
441 $c->forward( 'MyApp::View::TT' );
445 around stash => sub {
448 my $stash = $orig->($c);
450 my $new_stash = @_ > 1 ? {@_} : $_[0];
451 croak('stash takes a hash or hashref') unless ref $new_stash;
452 foreach my $key ( keys %$new_stash ) {
453 $stash->{$key} = $new_stash->{$key};
463 =head2 $c->error($error, ...)
465 =head2 $c->error($arrayref)
467 Returns an arrayref containing error messages. If Catalyst encounters an
468 error while processing a request, it stores the error in $c->error. This
469 method should only be used to store fatal error messages.
471 my @error = @{ $c->error };
475 $c->error('Something bad happened');
482 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
483 croak @$error unless ref $c;
484 push @{ $c->{error} }, @$error;
486 elsif ( defined $_[0] ) { $c->{error} = undef }
487 return $c->{error} || [];
493 Contains the return value of the last executed action.
494 Note that << $c->state >> operates in a scalar context which means that all
495 values it returns are scalar.
497 =head2 $c->clear_errors
499 Clear errors. You probably don't want to clear the errors unless you are
500 implementing a custom error screen.
502 This is equivalent to running
513 sub _comp_search_prefixes {
515 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
518 # search components given a name and some prefixes
519 sub _comp_names_search_prefixes {
520 my ( $c, $name, @prefixes ) = @_;
521 my $appclass = ref $c || $c;
522 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
523 $filter = qr/$filter/; # Compile regex now rather than once per loop
525 # map the original component name to the sub part that we will search against
526 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
527 grep { /$filter/ } keys %{ $c->components };
529 # undef for a name will return all
530 return keys %eligible if !defined $name;
532 my $query = ref $name ? $name : qr/^$name$/i;
533 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
535 return @result if @result;
537 # if we were given a regexp to search against, we're done.
540 # skip regexp fallback if configured
542 if $appclass->config->{disable_component_resolution_regex_fallback};
546 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
548 # no results? try against full names
550 @result = grep { m{$query} } keys %eligible;
553 # don't warn if we didn't find any results, it just might not exist
555 # Disgusting hack to work out correct method name
556 my $warn_for = lc $prefixes[0];
557 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
558 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
559 "component resolution is unreliable and unsafe.";
560 my $short = $result[0];
561 # remove the component namespace prefix
562 $short =~ s/.*?(Model|Controller|View):://;
563 my $shortmess = Carp::shortmess('');
564 if ($shortmess =~ m#Catalyst/Plugin#) {
565 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
567 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
568 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
569 "component's config";
571 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
572 "but if you really wanted to search, pass in a regexp as the argument " .
573 "like so: \$c->${warn_for}(qr/${name}/)";
575 $c->log->warn( "${msg}$shortmess" );
581 # Find possible names for a prefix
583 my ( $c, @prefixes ) = @_;
584 my $appclass = ref $c || $c;
586 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
588 my @names = map { s{$filter}{}; $_; }
589 $c->_comp_names_search_prefixes( undef, @prefixes );
594 # Filter a component before returning by calling ACCEPT_CONTEXT if available
595 sub _filter_component {
596 my ( $c, $comp, @args ) = @_;
598 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
599 return $comp->ACCEPT_CONTEXT( $c, @args );
605 =head2 COMPONENT ACCESSORS
607 =head2 $c->controller($name)
609 Gets a L<Catalyst::Controller> instance by name.
611 $c->controller('Foo')->do_stuff;
613 If the name is omitted, will return the controller for the dispatched
616 If you want to search for controllers, pass in a regexp as the argument.
618 # find all controllers that start with Foo
619 my @foo_controllers = $c->controller(qr{^Foo});
625 my ( $c, $name, @args ) = @_;
627 my $appclass = ref($c) || $c;
629 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
630 my $comps = $c->components;
631 my $check = $appclass."::Controller::".$name;
632 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
634 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
635 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
636 return $c->_filter_component( $result[ 0 ], @args );
639 return $c->component( $c->action->class );
642 =head2 $c->model($name)
644 Gets a L<Catalyst::Model> instance by name.
646 $c->model('Foo')->do_stuff;
648 Any extra arguments are directly passed to ACCEPT_CONTEXT.
650 If the name is omitted, it will look for
651 - a model object in $c->stash->{current_model_instance}, then
652 - a model name in $c->stash->{current_model}, then
653 - a config setting 'default_model', or
654 - check if there is only one model, and return it if that's the case.
656 If you want to search for models, pass in a regexp as the argument.
658 # find all models that start with Foo
659 my @foo_models = $c->model(qr{^Foo});
664 my ( $c, $name, @args ) = @_;
665 my $appclass = ref($c) || $c;
667 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
668 my $comps = $c->components;
669 my $check = $appclass."::Model::".$name;
670 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
672 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
673 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
674 return $c->_filter_component( $result[ 0 ], @args );
678 return $c->stash->{current_model_instance}
679 if $c->stash->{current_model_instance};
680 return $c->model( $c->stash->{current_model} )
681 if $c->stash->{current_model};
683 return $c->model( $appclass->config->{default_model} )
684 if $appclass->config->{default_model};
686 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
689 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
690 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
691 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
692 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
693 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
696 return $c->_filter_component( $comp );
700 =head2 $c->view($name)
702 Gets a L<Catalyst::View> instance by name.
704 $c->view('Foo')->do_stuff;
706 Any extra arguments are directly passed to ACCEPT_CONTEXT.
708 If the name is omitted, it will look for
709 - a view object in $c->stash->{current_view_instance}, then
710 - a view name in $c->stash->{current_view}, then
711 - a config setting 'default_view', or
712 - check if there is only one view, and return it if that's the case.
714 If you want to search for views, pass in a regexp as the argument.
716 # find all views that start with Foo
717 my @foo_views = $c->view(qr{^Foo});
722 my ( $c, $name, @args ) = @_;
724 my $appclass = ref($c) || $c;
726 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
727 my $comps = $c->components;
728 my $check = $appclass."::View::".$name;
729 if( exists $comps->{$check} ) {
730 return $c->_filter_component( $comps->{$check}, @args );
733 $c->log->warn( "Attempted to use view '$check', but does not exist" );
736 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
737 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
738 return $c->_filter_component( $result[ 0 ], @args );
742 return $c->stash->{current_view_instance}
743 if $c->stash->{current_view_instance};
744 return $c->view( $c->stash->{current_view} )
745 if $c->stash->{current_view};
747 return $c->view( $appclass->config->{default_view} )
748 if $appclass->config->{default_view};
750 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
753 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
754 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
755 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
756 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
757 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
760 return $c->_filter_component( $comp );
763 =head2 $c->controllers
765 Returns the available names which can be passed to $c->controller
771 return $c->_comp_names(qw/Controller C/);
776 Returns the available names which can be passed to $c->model
782 return $c->_comp_names(qw/Model M/);
788 Returns the available names which can be passed to $c->view
794 return $c->_comp_names(qw/View V/);
797 =head2 $c->comp($name)
799 =head2 $c->component($name)
801 Gets a component object by name. This method is not recommended,
802 unless you want to get a specific component by full
803 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
804 should be used instead.
806 If C<$name> is a regexp, a list of components matched against the full
807 component name will be returned.
809 If Catalyst can't find a component by name, it will fallback to regex
810 matching by default. To disable this behaviour set
811 disable_component_resolution_regex_fallback to a true value.
813 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
818 my ( $c, $name, @args ) = @_;
821 my $comps = $c->components;
824 # is it the exact name?
825 return $c->_filter_component( $comps->{ $name }, @args )
826 if exists $comps->{ $name };
828 # perhaps we just omitted "MyApp"?
829 my $composed = ( ref $c || $c ) . "::${name}";
830 return $c->_filter_component( $comps->{ $composed }, @args )
831 if exists $comps->{ $composed };
833 # search all of the models, views and controllers
834 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
835 return $c->_filter_component( $comp, @args ) if $comp;
839 if $c->config->{disable_component_resolution_regex_fallback};
841 # This is here so $c->comp( '::M::' ) works
842 my $query = ref $name ? $name : qr{$name}i;
844 my @result = grep { m{$query} } keys %{ $c->components };
845 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
848 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
849 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
850 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
851 return $c->_filter_component( $result[ 0 ], @args );
854 # I would expect to return an empty list here, but that breaks back-compat
858 return sort keys %{ $c->components };
861 =head2 CLASS DATA AND HELPER CLASSES
865 Returns or takes a hashref containing the application's configuration.
867 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
869 You can also use a C<YAML>, C<XML> or L<Config::General> config file
870 like C<myapp.conf> in your applications home directory. See
871 L<Catalyst::Plugin::ConfigLoader>.
873 =head3 Cascading configuration
875 The config method is present on all Catalyst components, and configuration
876 will be merged when an application is started. Configuration loaded with
877 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
878 followed by configuration in your top level C<MyApp> class. These two
879 configurations are merged, and then configuration data whose hash key matches a
880 component name is merged with configuration for that component.
882 The configuration for a component is then passed to the C<new> method when a
883 component is constructed.
887 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
888 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
890 will mean that C<MyApp::Model::Foo> receives the following data when
893 MyApp::Model::Foo->new({
899 It's common practice to use a Moose attribute
900 on the receiving component to access the config value.
902 package MyApp::Model::Foo;
906 # this attr will receive 'baz' at construction time
912 You can then get the value 'baz' by calling $c->model('Foo')->bar
913 (or $self->bar inside code in the model).
915 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
916 as a way of reading config within your code, as this B<will not> give you the
917 correctly merged config back. You B<MUST> take the config values supplied to
918 the constructor and use those instead.
922 around config => sub {
926 croak('Setting config after setup has been run is not allowed.')
927 if ( @_ and $c->setup_finished );
934 Returns the logging object instance. Unless it is already set, Catalyst
935 sets this up with a L<Catalyst::Log> object. To use your own log class,
936 set the logger with the C<< __PACKAGE__->log >> method prior to calling
937 C<< __PACKAGE__->setup >>.
939 __PACKAGE__->log( MyLogger->new );
944 $c->log->info( 'Now logging with my own logger!' );
946 Your log class should implement the methods described in
952 Returns 1 if debug mode is enabled, 0 otherwise.
954 You can enable debug mode in several ways:
958 =item By calling myapp_server.pl with the -d flag
960 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
962 =item The -Debug option in your MyApp.pm
964 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
968 The first three also set the log level to 'debug'.
970 Calling C<< $c->debug(1) >> has no effect.
976 =head2 $c->dispatcher
978 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
982 Returns the engine instance. See L<Catalyst::Engine>.
985 =head2 UTILITY METHODS
987 =head2 $c->path_to(@path)
989 Merges C<@path> with C<< $c->config->{home} >> and returns a
990 L<Path::Class::Dir> object. Note you can usually use this object as
991 a filename, but sometimes you will have to explicitly stringify it
992 yourself by calling the C<< ->stringify >> method.
996 $c->path_to( 'db', 'sqlite.db' );
1001 my ( $c, @path ) = @_;
1002 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1003 if ( -d $path ) { return $path }
1004 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1008 my ( $class, $name, $plugin, @args ) = @_;
1010 # See block comment in t/unit_core_plugin.t
1011 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1013 $class->_register_plugin( $plugin, 1 );
1015 eval { $plugin->import };
1016 $class->mk_classdata($name);
1018 eval { $obj = $plugin->new(@args) };
1021 Catalyst::Exception->throw( message =>
1022 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1025 $class->$name($obj);
1026 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1032 Initializes the dispatcher and engine, loads any plugins, and loads the
1033 model, view, and controller components. You may also specify an array
1034 of plugins to load here, if you choose to not load them in the C<use
1038 MyApp->setup( qw/-Debug/ );
1040 B<Note:> You B<should not> wrap this method with method modifiers
1041 or bad things will happen - wrap the C<setup_finalize> method instead.
1046 my ( $class, @arguments ) = @_;
1047 croak('Running setup more than once')
1048 if ( $class->setup_finished );
1050 unless ( $class->isa('Catalyst') ) {
1052 Catalyst::Exception->throw(
1053 message => qq/'$class' does not inherit from Catalyst/ );
1056 if ( $class->arguments ) {
1057 @arguments = ( @arguments, @{ $class->arguments } );
1063 foreach (@arguments) {
1067 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1069 elsif (/^-(\w+)=?(.*)$/) {
1070 $flags->{ lc $1 } = $2;
1073 push @{ $flags->{plugins} }, $_;
1077 $class->setup_home( delete $flags->{home} );
1079 $class->setup_log( delete $flags->{log} );
1080 $class->setup_plugins( delete $flags->{plugins} );
1081 $class->setup_dispatcher( delete $flags->{dispatcher} );
1082 if (my $engine = delete $flags->{engine}) {
1083 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1085 $class->setup_engine();
1086 $class->setup_stats( delete $flags->{stats} );
1088 for my $flag ( sort keys %{$flags} ) {
1090 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1091 &$code( $class, delete $flags->{$flag} );
1094 $class->log->warn(qq/Unknown flag "$flag"/);
1098 eval { require Catalyst::Devel; };
1099 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1100 $class->log->warn(<<"EOF");
1101 You are running an old script!
1103 Please update by running (this will overwrite existing files):
1104 catalyst.pl -force -scripts $class
1106 or (this will not overwrite existing files):
1107 catalyst.pl -scripts $class
1112 if ( $class->debug ) {
1113 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1116 my $column_width = Catalyst::Utils::term_width() - 6;
1117 my $t = Text::SimpleTable->new($column_width);
1118 $t->row($_) for @plugins;
1119 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1122 my $dispatcher = $class->dispatcher;
1123 my $engine = $class->engine;
1124 my $home = $class->config->{home};
1126 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1127 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1131 ? $class->log->debug(qq/Found home "$home"/)
1132 : $class->log->debug(qq/Home "$home" doesn't exist/)
1133 : $class->log->debug(q/Couldn't find home/);
1136 # Call plugins setup, this is stupid and evil.
1137 # Also screws C3 badly on 5.10, hack to avoid.
1139 no warnings qw/redefine/;
1140 local *setup = sub { };
1141 $class->setup unless $Catalyst::__AM_RESTARTING;
1144 # Initialize our data structure
1145 $class->components( {} );
1147 $class->setup_components;
1149 if ( $class->debug ) {
1150 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1151 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1152 for my $comp ( sort keys %{ $class->components } ) {
1153 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1154 $t->row( $comp, $type );
1156 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1157 if ( keys %{ $class->components } );
1160 # Add our self to components, since we are also a component
1161 if( $class->isa('Catalyst::Controller') ){
1162 $class->components->{$class} = $class;
1165 $class->setup_actions;
1167 if ( $class->debug ) {
1168 my $name = $class->config->{name} || 'Application';
1169 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1172 # Make sure that the application class becomes immutable at this point,
1173 B::Hooks::EndOfScope::on_scope_end {
1175 my $meta = Class::MOP::get_metaclass_by_name($class);
1178 && ! { $meta->immutable_options }->{replace_constructor}
1180 $class->isa('Class::Accessor::Fast')
1181 || $class->isa('Class::Accessor')
1184 warn "You made your application class ($class) immutable, "
1185 . "but did not inline the\nconstructor. "
1186 . "This will break catalyst, as your app \@ISA "
1187 . "Class::Accessor(::Fast)?\nPlease pass "
1188 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1190 $meta->make_immutable(
1191 replace_constructor => 1,
1192 ) unless $meta->is_immutable;
1195 if ($class->config->{case_sensitive}) {
1196 $class->log->warn($class . "->config->{case_sensitive} is set.");
1197 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1200 $class->setup_finalize;
1201 # Should be the last thing we do so that user things hooking
1202 # setup_finalize can log..
1203 $class->log->_flush() if $class->log->can('_flush');
1204 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1207 =head2 $app->setup_finalize
1209 A hook to attach modifiers to. This method does not do anything except set the
1210 C<setup_finished> accessor.
1212 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1216 after setup_finalize => sub {
1224 sub setup_finalize {
1226 $class->setup_finished(1);
1229 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1231 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1233 Constructs an absolute L<URI> object based on the application root, the
1234 provided path, and the additional arguments and query parameters provided.
1235 When used as a string, provides a textual URI. If you need more flexibility
1236 than this (i.e. the option to provide relative URIs etc.) see
1237 L<Catalyst::Plugin::SmartURI>.
1239 If no arguments are provided, the URI for the current action is returned.
1240 To return the current action and also provide @args, use
1241 C<< $c->uri_for( $c->action, @args ) >>.
1243 If the first argument is a string, it is taken as a public URI path relative
1244 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1245 relative to the application root (if it does). It is then merged with
1246 C<< $c->request->base >>; any C<@args> are appended as additional path
1247 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1249 If the first argument is a L<Catalyst::Action> it represents an action which
1250 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1251 optional C<\@captures> argument (an arrayref) allows passing the captured
1252 variables that are needed to fill in the paths of Chained and Regex actions;
1253 once the path is resolved, C<uri_for> continues as though a path was
1254 provided, appending any arguments or parameters and creating an absolute
1257 The captures for the current request can be found in
1258 C<< $c->request->captures >>, and actions can be resolved using
1259 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1260 path, use C<< $c->uri_for_action >> instead.
1262 # Equivalent to $c->req->uri
1263 $c->uri_for($c->action, $c->req->captures,
1264 @{ $c->req->args }, $c->req->params);
1266 # For the Foo action in the Bar controller
1267 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1269 # Path to a static resource
1270 $c->uri_for('/static/images/logo.png');
1275 my ( $c, $path, @args ) = @_;
1277 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1278 $path = $path->path_prefix;
1283 undef($path) if (defined $path && $path eq '');
1286 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1288 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1289 foreach my $arg (@args) {
1290 utf8::encode($arg) if utf8::is_utf8($arg);
1291 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1294 if ( blessed($path) ) { # action object
1295 s|/|%2F|g for @args;
1296 my $captures = [ map { s|/|%2F|g; $_; }
1297 ( scalar @args && ref $args[0] eq 'ARRAY'
1301 foreach my $capture (@$captures) {
1302 utf8::encode($capture) if utf8::is_utf8($capture);
1303 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1307 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1308 if( !@args && $action->number_of_args ) {
1309 my $expanded_action = $c->dispatcher->expand_action( $action );
1311 my $num_captures = $expanded_action->number_of_captures;
1312 unshift @args, splice @$captures, $num_captures;
1315 $path = $c->dispatcher->uri_for_action($action, $captures);
1316 if (not defined $path) {
1317 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1321 $path = '/' if $path eq '';
1324 unshift(@args, $path);
1326 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1327 my $namespace = $c->namespace;
1328 if (defined $path) { # cheesy hack to handle path '../foo'
1329 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1331 unshift(@args, $namespace || '');
1334 # join args with '/', or a blank string
1335 my $args = join('/', grep { defined($_) } @args);
1336 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1338 my $base = $c->req->base;
1339 my $class = ref($base);
1340 $base =~ s{(?<!/)$}{/};
1344 if (my @keys = keys %$params) {
1345 # somewhat lifted from URI::_query's query_form
1346 $query = '?'.join('&', map {
1347 my $val = $params->{$_};
1348 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1351 $val = '' unless defined $val;
1354 utf8::encode( $param ) if utf8::is_utf8($param);
1355 # using the URI::Escape pattern here so utf8 chars survive
1356 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1358 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1362 my $res = bless(\"${base}${args}${query}", $class);
1366 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1368 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1374 A private path to the Catalyst action you want to create a URI for.
1376 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1377 >> and passing the resulting C<$action> and the remaining arguments to C<<
1380 You can also pass in a Catalyst::Action object, in which case it is passed to
1383 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.
1385 For example, if the action looks like:
1387 package MyApp::Controller::Users;
1389 sub lst : Path('the-list') {}
1393 $c->uri_for_action('/users/lst')
1395 and it will create the URI /users/the-list.
1397 =item \@captures_and_args?
1399 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1400 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1401 to interpolate all the parameters in the URI.
1405 Optional list of extra arguments - can be supplied in the
1406 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1409 Your action can have zero, a fixed or a variable number of args (e.g.
1410 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1412 =item \%query_values?
1414 Optional array reference of query parameters to append. E.g.
1420 /rest/of/your/uri?foo=bar
1426 sub uri_for_action {
1427 my ( $c, $path, @args ) = @_;
1428 my $action = blessed($path)
1430 : $c->dispatcher->get_action_by_path($path);
1431 unless (defined $action) {
1432 croak "Can't find action for path '$path'";
1434 return $c->uri_for( $action, @args );
1437 =head2 $c->welcome_message
1439 Returns the Catalyst welcome HTML page.
1443 sub welcome_message {
1445 my $name = $c->config->{name};
1446 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1447 my $prefix = Catalyst::Utils::appprefix( ref $c );
1448 $c->response->content_type('text/html; charset=utf-8');
1450 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1451 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1452 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1454 <meta http-equiv="Content-Language" content="en" />
1455 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1456 <title>$name on Catalyst $VERSION</title>
1457 <style type="text/css">
1460 background-color: #eee;
1467 margin-bottom: 10px;
1469 background-color: #ccc;
1470 border: 1px solid #aaa;
1475 font-family: verdana, tahoma, sans-serif;
1478 font-family: verdana, tahoma, sans-serif;
1481 text-decoration: none;
1483 border-bottom: 1px dotted #bbb;
1485 :link:hover, :visited:hover {
1498 background-color: #fff;
1499 border: 1px solid #aaa;
1503 font-weight: normal;
1525 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1530 <img src="$logo" alt="Catalyst Logo" />
1532 <p>Welcome to the world of Catalyst.
1533 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1534 framework will make web development something you had
1535 never expected it to be: Fun, rewarding, and quick.</p>
1536 <h2>What to do now?</h2>
1537 <p>That really depends on what <b>you</b> want to do.
1538 We do, however, provide you with a few starting points.</p>
1539 <p>If you want to jump right into web development with Catalyst
1540 you might want to start with a tutorial.</p>
1541 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1543 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1545 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1546 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1548 <h2>What to do next?</h2>
1549 <p>Next it's time to write an actual application. Use the
1550 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1551 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1552 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1553 they can save you a lot of work.</p>
1554 <pre><code>script/${prefix}_create.pl --help</code></pre>
1555 <p>Also, be sure to check out the vast and growing
1556 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1557 you are likely to find what you need there.
1561 <p>Catalyst has a very active community. Here are the main places to
1562 get in touch with us.</p>
1565 <a href="http://dev.catalyst.perl.org">Wiki</a>
1568 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1571 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1574 <h2>In conclusion</h2>
1575 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1576 as we enjoyed making it. Please contact us if you have ideas
1577 for improvement or other feedback.</p>
1587 Contains a hash of options passed from the application script, including
1588 the original ARGV the script received, the processed values from that
1589 ARGV and any extra arguments to the script which were not processed.
1591 This can be used to add custom options to your application's scripts
1592 and setup your application differently depending on the values of these
1595 =head1 INTERNAL METHODS
1597 These methods are not meant to be used by end users.
1599 =head2 $c->components
1601 Returns a hash of components.
1603 =head2 $c->context_class
1605 Returns or sets the context class.
1609 Returns a hashref containing coderefs and execution counts (needed for
1610 deep recursion detection).
1614 Returns the number of actions on the current internal execution stack.
1618 Dispatches a request to actions.
1622 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1624 =head2 $c->dispatcher_class
1626 Returns or sets the dispatcher class.
1628 =head2 $c->dump_these
1630 Returns a list of 2-element array references (name, structure) pairs
1631 that will be dumped on the error page in debug mode.
1637 [ Request => $c->req ],
1638 [ Response => $c->res ],
1639 [ Stash => $c->stash ],
1640 [ Config => $c->config ];
1643 =head2 $c->engine_class
1645 Returns or sets the engine class.
1647 =head2 $c->execute( $class, $coderef )
1649 Execute a coderef in given class and catch exceptions. Errors are available
1655 my ( $c, $class, $code ) = @_;
1656 $class = $c->component($class) || $class;
1659 if ( $c->depth >= $RECURSION ) {
1660 my $action = $code->reverse();
1661 $action = "/$action" unless $action =~ /->/;
1662 my $error = qq/Deep recursion detected calling "${action}"/;
1663 $c->log->error($error);
1669 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1671 push( @{ $c->stack }, $code );
1673 no warnings 'recursion';
1674 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1675 # I have no idea how, ergo $ret (which appears to fix the issue)
1676 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1678 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1680 my $last = pop( @{ $c->stack } );
1682 if ( my $error = $@ ) {
1683 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1684 $error->rethrow if $c->depth > 1;
1686 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1687 $error->rethrow if $c->depth > 0;
1690 unless ( ref $error ) {
1691 no warnings 'uninitialized';
1693 my $class = $last->class;
1694 my $name = $last->name;
1695 $error = qq/Caught exception in $class->$name "$error"/;
1704 sub _stats_start_execute {
1705 my ( $c, $code ) = @_;
1706 my $appclass = ref($c) || $c;
1707 return if ( ( $code->name =~ /^_.*/ )
1708 && ( !$appclass->config->{show_internal_actions} ) );
1710 my $action_name = $code->reverse();
1711 $c->counter->{$action_name}++;
1713 my $action = $action_name;
1714 $action = "/$action" unless $action =~ /->/;
1716 # determine if the call was the result of a forward
1717 # this is done by walking up the call stack and looking for a calling
1718 # sub of Catalyst::forward before the eval
1720 for my $index ( 2 .. 11 ) {
1722 if ( ( caller($index) )[0] eq 'Catalyst'
1723 && ( caller($index) )[3] eq '(eval)' );
1725 if ( ( caller($index) )[3] =~ /forward$/ ) {
1726 $callsub = ( caller($index) )[3];
1727 $action = "-> $action";
1732 my $uid = $action_name . $c->counter->{$action_name};
1734 # is this a root-level call or a forwarded call?
1735 if ( $callsub =~ /forward$/ ) {
1736 my $parent = $c->stack->[-1];
1738 # forward, locate the caller
1739 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1742 parent => "$parent" . $c->counter->{"$parent"},
1748 # forward with no caller may come from a plugin
1767 sub _stats_finish_execute {
1768 my ( $c, $info ) = @_;
1769 $c->stats->profile( end => $info );
1774 Finalizes the request.
1781 for my $error ( @{ $c->error } ) {
1782 $c->log->error($error);
1785 # Allow engine to handle finalize flow (for POE)
1786 my $engine = $c->engine;
1787 if ( my $code = $engine->can('finalize') ) {
1792 $c->finalize_uploads;
1795 if ( $#{ $c->error } >= 0 ) {
1799 $c->finalize_headers;
1802 if ( $c->request->method eq 'HEAD' ) {
1803 $c->response->body('');
1811 if ($c->use_stats) {
1812 my $elapsed = sprintf '%f', $c->stats->elapsed;
1813 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1815 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1818 return $c->response->status;
1821 =head2 $c->finalize_body
1827 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1829 =head2 $c->finalize_cookies
1835 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1837 =head2 $c->finalize_error
1843 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1845 =head2 $c->finalize_headers
1851 sub finalize_headers {
1854 my $response = $c->response; #accessor calls can add up?
1856 # Check if we already finalized headers
1857 return if $response->finalized_headers;
1860 if ( my $location = $response->redirect ) {
1861 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1862 $response->header( Location => $location );
1864 if ( !$response->has_body ) {
1865 # Add a default body if none is already present
1866 $response->body(<<"EOF");
1867 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1868 <html xmlns="http://www.w3.org/1999/xhtml">
1870 <title>Moved</title>
1873 <p>This item has moved <a href="$location">here</a>.</p>
1877 $response->content_type('text/html; charset=utf-8');
1882 if ( defined $response->body && length $response->body && !$response->content_length ) {
1884 # get the length from a filehandle
1885 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1887 my $size = -s $response->body;
1889 $response->content_length( $size );
1892 $c->log->warn('Serving filehandle without a content-length');
1896 # everything should be bytes at this point, but just in case
1897 $response->content_length( length( $response->body ) );
1902 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1903 $response->headers->remove_header("Content-Length");
1904 $response->body('');
1907 $c->finalize_cookies;
1909 $c->engine->finalize_headers( $c, @_ );
1912 $response->finalized_headers(1);
1915 =head2 $c->finalize_output
1917 An alias for finalize_body.
1919 =head2 $c->finalize_read
1921 Finalizes the input after reading is complete.
1925 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1927 =head2 $c->finalize_uploads
1929 Finalizes uploads. Cleans up any temporary files.
1933 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1935 =head2 $c->get_action( $action, $namespace )
1937 Gets an action in a given namespace.
1941 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1943 =head2 $c->get_actions( $action, $namespace )
1945 Gets all actions of a given name in a namespace and all parent
1950 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1952 =head2 $app->handle_request( @arguments )
1954 Called to handle each HTTP request.
1958 sub handle_request {
1959 my ( $class, @arguments ) = @_;
1961 # Always expect worst case!
1964 if ($class->debug) {
1965 my $secs = time - $START || 1;
1966 my $av = sprintf '%.3f', $COUNT / $secs;
1967 my $time = localtime time;
1968 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1971 my $c = $class->prepare(@arguments);
1973 $status = $c->finalize;
1976 chomp(my $error = $_);
1977 $class->log->error(qq/Caught exception in engine "$error"/);
1982 if(my $coderef = $class->log->can('_flush')){
1983 $class->log->$coderef();
1988 =head2 $class->prepare( @arguments )
1990 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1997 predicate => '_has_uploadtmp',
2001 my ( $class, @arguments ) = @_;
2004 # After the app/ctxt split, this should become an attribute based on something passed
2005 # into the application.
2006 $class->context_class( ref $class || $class ) unless $class->context_class;
2008 my $uploadtmp = $class->config->{uploadtmp};
2009 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2011 # For on-demand data
2012 $c->request->_context($c);
2013 $c->response->_context($c);
2015 #surely this is not the most efficient way to do things...
2016 $c->stats($class->stats_class->new)->enable($c->use_stats);
2017 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2018 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2022 # Allow engine to direct the prepare flow (for POE)
2023 if ( my $prepare = $c->engine->can('prepare') ) {
2024 $c->engine->$prepare( $c, @arguments );
2027 $c->prepare_request(@arguments);
2028 $c->prepare_connection;
2029 $c->prepare_query_parameters;
2032 # Prepare the body for reading, either by prepare_body
2033 # or the user, if they are using $c->read
2036 # Parse the body unless the user wants it on-demand
2037 unless ( ref($c)->config->{parse_on_demand} ) {
2042 # VERY ugly and probably shouldn't rely on ->finalize actually working
2044 # failed prepare is always due to an invalid request, right?
2045 $c->response->status(400);
2046 $c->response->content_type('text/plain');
2047 $c->response->body('Bad Request');
2052 my $method = $c->req->method || '';
2053 my $path = $c->req->path;
2054 $path = '/' unless length $path;
2055 my $address = $c->req->address || '';
2064 =head2 $c->prepare_action
2066 Prepares action. See L<Catalyst::Dispatcher>.
2070 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2072 =head2 $c->prepare_body
2074 Prepares message body.
2081 return if $c->request->_has_body;
2083 # Initialize on-demand data
2084 $c->engine->prepare_body( $c, @_ );
2085 $c->prepare_parameters;
2086 $c->prepare_uploads;
2089 =head2 $c->prepare_body_chunk( $chunk )
2091 Prepares a chunk of data before sending it to L<HTTP::Body>.
2093 See L<Catalyst::Engine>.
2097 sub prepare_body_chunk {
2099 $c->engine->prepare_body_chunk( $c, @_ );
2102 =head2 $c->prepare_body_parameters
2104 Prepares body parameters.
2108 sub prepare_body_parameters {
2110 $c->engine->prepare_body_parameters( $c, @_ );
2113 =head2 $c->prepare_connection
2115 Prepares connection.
2119 sub prepare_connection {
2121 $c->request->prepare_connection;
2124 =head2 $c->prepare_parameters
2126 Prepares parameters.
2130 sub prepare_parameters {
2132 $c->prepare_body_parameters;
2133 $c->engine->prepare_parameters( $c, @_ );
2136 =head2 $c->prepare_path
2138 Prepares path and base.
2142 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2144 =head2 $c->prepare_query_parameters
2146 Prepares query parameters.
2150 sub prepare_query_parameters {
2153 $c->engine->prepare_query_parameters( $c, @_ );
2156 =head2 $c->log_request
2158 Writes information about the request to the debug logs. This includes:
2162 =item * Request method, path, and remote IP address
2164 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2166 =item * Request parameters
2168 =item * File uploads
2177 return unless $c->debug;
2179 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2180 my $request = $dump->[1];
2182 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2184 $path = '/' unless length $path;
2186 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2188 $c->log_request_headers($request->headers);
2190 if ( my $keywords = $request->query_keywords ) {
2191 $c->log->debug("Query keywords are: $keywords");
2194 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2196 $c->log_request_uploads($request);
2199 =head2 $c->log_response
2201 Writes information about the response to the debug logs by calling
2202 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2209 return unless $c->debug;
2211 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2212 my $response = $dump->[1];
2214 $c->log_response_status_line($response);
2215 $c->log_response_headers($response->headers);
2218 =head2 $c->log_response_status_line($response)
2220 Writes one line of information about the response to the debug logs. This includes:
2224 =item * Response status code
2226 =item * Content-Type header (if present)
2228 =item * Content-Length header (if present)
2234 sub log_response_status_line {
2235 my ($c, $response) = @_;
2239 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2240 $response->status || 'unknown',
2241 $response->headers->header('Content-Type') || 'unknown',
2242 $response->headers->header('Content-Length') || 'unknown'
2247 =head2 $c->log_response_headers($headers);
2249 Hook method which can be wrapped by plugins to log the response headers.
2250 No-op in the default implementation.
2254 sub log_response_headers {}
2256 =head2 $c->log_request_parameters( query => {}, body => {} )
2258 Logs request parameters to debug logs
2262 sub log_request_parameters {
2264 my %all_params = @_;
2266 return unless $c->debug;
2268 my $column_width = Catalyst::Utils::term_width() - 44;
2269 foreach my $type (qw(query body)) {
2270 my $params = $all_params{$type};
2271 next if ! keys %$params;
2272 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2273 for my $key ( sort keys %$params ) {
2274 my $param = $params->{$key};
2275 my $value = defined($param) ? $param : '';
2276 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2278 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2282 =head2 $c->log_request_uploads
2284 Logs file uploads included in the request to the debug logs.
2285 The parameter name, filename, file type, and file size are all included in
2290 sub log_request_uploads {
2292 my $request = shift;
2293 return unless $c->debug;
2294 my $uploads = $request->uploads;
2295 if ( keys %$uploads ) {
2296 my $t = Text::SimpleTable->new(
2297 [ 12, 'Parameter' ],
2302 for my $key ( sort keys %$uploads ) {
2303 my $upload = $uploads->{$key};
2304 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2305 $t->row( $key, $u->filename, $u->type, $u->size );
2308 $c->log->debug( "File Uploads are:\n" . $t->draw );
2312 =head2 $c->log_request_headers($headers);
2314 Hook method which can be wrapped by plugins to log the request headers.
2315 No-op in the default implementation.
2319 sub log_request_headers {}
2321 =head2 $c->log_headers($type => $headers)
2323 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2330 my $headers = shift; # an HTTP::Headers instance
2332 return unless $c->debug;
2334 my $column_width = Catalyst::Utils::term_width() - 28;
2335 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2338 my ( $name, $value ) = @_;
2339 $t->row( $name, $value );
2342 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2346 =head2 $c->prepare_read
2348 Prepares the input for reading.
2352 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2354 =head2 $c->prepare_request
2356 Prepares the engine request.
2360 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2362 =head2 $c->prepare_uploads
2368 sub prepare_uploads {
2371 $c->engine->prepare_uploads( $c, @_ );
2374 =head2 $c->prepare_write
2376 Prepares the output for writing.
2380 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2382 =head2 $c->request_class
2384 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2386 =head2 $c->response_class
2388 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2390 =head2 $c->read( [$maxlength] )
2392 Reads a chunk of data from the request body. This method is designed to
2393 be used in a while loop, reading C<$maxlength> bytes on every call.
2394 C<$maxlength> defaults to the size of the request if not specified.
2396 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2399 Warning: If you use read(), Catalyst will not process the body,
2400 so you will not be able to access POST parameters or file uploads via
2401 $c->request. You must handle all body parsing yourself.
2405 sub read { my $c = shift; return $c->request->read( @_ ) }
2415 $app->engine_loader->needs_psgi_engine_compat_hack ?
2416 $app->engine->run($app, @_) :
2417 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2420 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2422 Sets an action in a given namespace.
2426 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2428 =head2 $c->setup_actions($component)
2430 Sets up actions for a component.
2434 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2436 =head2 $c->setup_components
2438 This method is called internally to set up the application's components.
2440 It finds modules by calling the L<locate_components> method, expands them to
2441 package names with the L<expand_component_module> method, and then installs
2442 each component into the application.
2444 The C<setup_components> config option is passed to both of the above methods.
2446 Installation of each component is performed by the L<setup_component> method,
2451 sub setup_components {
2454 my $config = $class->config->{ setup_components };
2456 my @comps = $class->locate_components($config);
2457 my %comps = map { $_ => 1 } @comps;
2459 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2460 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2461 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2462 ) if $deprecatedcatalyst_component_names;
2464 for my $component ( @comps ) {
2466 # We pass ignore_loaded here so that overlay files for (e.g.)
2467 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2468 # we know M::P::O found a file on disk so this is safe
2470 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2473 for my $component (@comps) {
2474 my $instance = $class->components->{ $component } = $class->setup_component($component);
2475 my @expanded_components = $instance->can('expand_modules')
2476 ? $instance->expand_modules( $component, $config )
2477 : $class->expand_component_module( $component, $config );
2478 for my $component (@expanded_components) {
2479 next if $comps{$component};
2480 $class->components->{ $component } = $class->setup_component($component);
2485 =head2 $c->locate_components( $setup_component_config )
2487 This method is meant to provide a list of component modules that should be
2488 setup for the application. By default, it will use L<Module::Pluggable>.
2490 Specify a C<setup_components> config option to pass additional options directly
2491 to L<Module::Pluggable>. To add additional search paths, specify a key named
2492 C<search_extra> as an array reference. Items in the array beginning with C<::>
2493 will have the application class name prepended to them.
2497 sub locate_components {
2501 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2502 my $extra = delete $config->{ search_extra } || [];
2504 push @paths, @$extra;
2506 my $locator = Module::Pluggable::Object->new(
2507 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2511 # XXX think about ditching this sort entirely
2512 my @comps = sort { length $a <=> length $b } $locator->plugins;
2517 =head2 $c->expand_component_module( $component, $setup_component_config )
2519 Components found by C<locate_components> will be passed to this method, which
2520 is expected to return a list of component (package) names to be set up.
2524 sub expand_component_module {
2525 my ($class, $module) = @_;
2526 return Devel::InnerPackage::list_packages( $module );
2529 =head2 $c->setup_component
2533 sub setup_component {
2534 my( $class, $component ) = @_;
2536 unless ( $component->can( 'COMPONENT' ) ) {
2540 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2541 my $config = $class->config->{ $suffix } || {};
2542 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2543 # methods also pass it. local to avoid pointlessly shitting in config
2544 # for the debug screen, as $component is already the key name.
2545 local $config->{catalyst_component_name} = $component;
2547 my $instance = eval { $component->COMPONENT( $class, $config ); };
2549 if ( my $error = $@ ) {
2551 Catalyst::Exception->throw(
2552 message => qq/Couldn't instantiate component "$component", "$error"/
2556 unless (blessed $instance) {
2557 my $metaclass = Moose::Util::find_meta($component);
2558 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2559 my $component_method_from = $method_meta->associated_metaclass->name;
2560 my $value = defined($instance) ? $instance : 'undef';
2561 Catalyst::Exception->throw(
2563 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2569 =head2 $c->setup_dispatcher
2575 sub setup_dispatcher {
2576 my ( $class, $dispatcher ) = @_;
2579 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2582 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2583 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2586 unless ($dispatcher) {
2587 $dispatcher = $class->dispatcher_class;
2590 Class::MOP::load_class($dispatcher);
2592 # dispatcher instance
2593 $class->dispatcher( $dispatcher->new );
2596 =head2 $c->setup_engine
2603 my ($class, $requested_engine) = @_;
2605 if (!$class->engine_loader || $requested_engine) {
2606 $class->engine_loader(
2607 Catalyst::EngineLoader->new({
2608 application_name => $class,
2609 (defined $requested_engine
2610 ? (catalyst_engine_class => $requested_engine) : ()),
2615 $class->engine_loader->catalyst_engine_class;
2619 my ($class, $requested_engine) = @_;
2622 my $loader = $class->engine_loader;
2624 if (!$loader || $requested_engine) {
2625 $loader = Catalyst::EngineLoader->new({
2626 application_name => $class,
2627 (defined $requested_engine
2628 ? (requested_engine => $requested_engine) : ()),
2631 $class->engine_loader($loader);
2634 $loader->catalyst_engine_class;
2637 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2638 return if $class->loading_psgi_file;
2640 Class::MOP::load_class($engine);
2642 if ($ENV{MOD_PERL}) {
2643 my $apache = $class->engine_loader->auto;
2645 my $meta = find_meta($class);
2646 my $was_immutable = $meta->is_immutable;
2647 my %immutable_options = $meta->immutable_options;
2648 $meta->make_mutable if $was_immutable;
2650 $meta->add_method(handler => sub {
2652 my $psgi_app = $class->_finalized_psgi_app;
2653 $apache->call_app($r, $psgi_app);
2656 $meta->make_immutable(%immutable_options) if $was_immutable;
2659 $class->engine( $engine->new );
2664 sub _finalized_psgi_app {
2667 unless ($app->_psgi_app) {
2668 my $psgi_app = $app->_setup_psgi_app;
2669 $app->_psgi_app($psgi_app);
2672 return $app->_psgi_app;
2675 sub _setup_psgi_app {
2678 for my $home (Path::Class::Dir->new($app->config->{home})) {
2679 my $psgi_file = $home->file(
2680 Catalyst::Utils::appprefix($app) . '.psgi',
2683 next unless -e $psgi_file;
2685 # If $psgi_file calls ->setup_engine, it's doing so to load
2686 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2687 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2688 # anyway. So set a flag (ick) that tells setup_engine not to populate
2689 # $c->engine or do any other things we might regret.
2691 $app->loading_psgi_file(1);
2692 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2693 $app->loading_psgi_file(0);
2696 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2699 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2701 Its content has been ignored. Please consult the Catalyst::Upgrading
2702 documentation on how to upgrade from Catalyst::Engine::PSGI.
2706 return $app->apply_default_middlewares($app->psgi_app);
2709 =head2 $c->apply_default_middlewares
2711 Adds the following L<Plack> middlewares to your application, since they are
2712 useful and commonly needed:
2714 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2715 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2716 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2717 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2718 applied since this middleware is smart enough to conditionally apply itself).
2720 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2721 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2727 sub apply_default_middlewares {
2728 my ($app, $psgi_app) = @_;
2730 $psgi_app = Plack::Middleware::Conditional->wrap(
2732 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2735 return if $app->config->{ignore_frontend_proxy};
2736 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2737 || $app->config->{using_frontend_proxy};
2741 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2742 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2743 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
2745 # we're applying this unconditionally as the middleware itself already makes
2746 # sure it doesn't fuck things up if it's not running under one of the right
2748 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2755 Returns a PSGI application code reference for the catalyst application
2756 C<$c>. This is the bare application without any middlewares
2757 applied. C<${myapp}.psgi> is not taken into account.
2759 This is what you want to be using to retrieve the PSGI application code
2760 reference of your Catalyst application for use in F<.psgi> files.
2766 return $app->engine->build_psgi_app($app);
2769 =head2 $c->setup_home
2771 Sets up the home directory.
2776 my ( $class, $home ) = @_;
2778 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2782 $home ||= Catalyst::Utils::home($class);
2785 #I remember recently being scolded for assigning config values like this
2786 $class->config->{home} ||= $home;
2787 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2791 =head2 $c->setup_log
2793 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2794 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2797 This method also installs a C<debug> method that returns a true value into the
2798 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2799 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2801 Note that if the log has already been setup, by either a previous call to
2802 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2803 that this method won't actually set up the log object.
2808 my ( $class, $levels ) = @_;
2811 $levels =~ s/^\s+//;
2812 $levels =~ s/\s+$//;
2813 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2815 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2816 if ( defined $env_debug ) {
2817 $levels{debug} = 1 if $env_debug; # Ugly!
2818 delete($levels{debug}) unless $env_debug;
2821 unless ( $class->log ) {
2822 $class->log( Catalyst::Log->new(keys %levels) );
2825 if ( $levels{debug} ) {
2826 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2827 $class->log->debug('Debug messages enabled');
2831 =head2 $c->setup_plugins
2837 =head2 $c->setup_stats
2839 Sets up timing statistics class.
2844 my ( $class, $stats ) = @_;
2846 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2848 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2849 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2850 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2851 $class->log->debug('Statistics enabled');
2856 =head2 $c->registered_plugins
2858 Returns a sorted list of the plugins which have either been stated in the
2861 If passed a given plugin name, it will report a boolean value indicating
2862 whether or not that plugin is loaded. A fully qualified name is required if
2863 the plugin name does not begin with C<Catalyst::Plugin::>.
2865 if ($c->registered_plugins('Some::Plugin')) {
2873 sub registered_plugins {
2875 return sort keys %{ $proto->_plugins } unless @_;
2877 return 1 if exists $proto->_plugins->{$plugin};
2878 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2881 sub _register_plugin {
2882 my ( $proto, $plugin, $instant ) = @_;
2883 my $class = ref $proto || $proto;
2885 Class::MOP::load_class( $plugin );
2886 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2887 if $plugin->isa( 'Catalyst::Component' );
2888 $proto->_plugins->{$plugin} = 1;
2890 my $meta = Class::MOP::get_metaclass_by_name($class);
2891 $meta->superclasses($plugin, $meta->superclasses);
2897 my ( $class, $plugins ) = @_;
2899 $class->_plugins( {} ) unless $class->_plugins;
2900 $plugins = Data::OptList::mkopt($plugins || []);
2903 [ Catalyst::Utils::resolve_namespace(
2904 $class . '::Plugin',
2905 'Catalyst::Plugin', $_->[0]
2911 for my $plugin ( reverse @plugins ) {
2912 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2913 my $meta = find_meta($plugin->[0]);
2914 next if $meta && $meta->isa('Moose::Meta::Role');
2916 $class->_register_plugin($plugin->[0]);
2920 map { $_->[0]->name, $_->[1] }
2921 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2922 map { [find_meta($_->[0]), $_->[1]] }
2925 Moose::Util::apply_all_roles(
2933 Returns an arrayref of the internal execution stack (actions that are
2934 currently executing).
2938 Returns the current timing statistics object. By default Catalyst uses
2939 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2940 L<< stats_class|/"$c->stats_class" >>.
2942 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2943 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2944 profile explicitly, although MyApp.pm still won't profile nor output anything
2947 =head2 $c->stats_class
2949 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2951 =head2 $c->use_stats
2953 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2955 Note that this is a static method, not an accessor and should be overridden
2956 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2963 =head2 $c->write( $data )
2965 Writes $data to the output stream. When using this method directly, you
2966 will need to manually set the C<Content-Length> header to the length of
2967 your output data, if known.
2974 # Finalize headers if someone manually writes output
2975 $c->finalize_headers;
2977 return $c->engine->write( $c, @_ );
2982 Returns the Catalyst version number. Mostly useful for "powered by"
2983 messages in template systems.
2987 sub version { return $Catalyst::VERSION }
2989 =head1 CONFIGURATION
2991 There are a number of 'base' config variables which can be set:
2997 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3001 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3005 C<disable_component_resolution_regex_fallback> - Turns
3006 off the deprecated component resolution functionality so
3007 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3008 are called then regex search will not be attempted on string values and
3009 instead C<undef> will be returned.
3013 C<home> - The application home directory. In an uninstalled application,
3014 this is the top level application directory. In an installed application,
3015 this will be the directory containing C<< MyApp.pm >>.
3019 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3023 C<name> - The name of the application in debug messages and the debug and
3028 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3029 until it is accessed. This allows you to (for example) check authentication (and reject
3030 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3034 C<root> - The root directory for templates. Usually this is just a
3035 subdirectory of the home directory, but you can set it to change the
3036 templates to a different directory.
3040 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3041 namespaces from which components will be loaded (and constructed and stored in
3042 C<< $c->components >>).
3046 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3047 to be shown in hit debug tables in the test server.
3051 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3052 variable should be used for determining the request path.
3054 Most web server environments pass the requested path to the application using environment variables,
3055 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3056 exposed as C<< $c->request->base >>) and the request path below that base.
3058 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3059 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3063 =item use_request_uri_for_path => 0
3065 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3066 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3067 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3068 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3070 However this method has the major disadvantage that it is impossible to correctly decode some elements
3071 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3072 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3073 can't distinguish / vs %2F in paths (in addition to other encoded values).
3075 =item use_request_uri_for_path => 1
3077 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3078 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3079 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3081 Given that this method of path resolution is provably more correct, it is recommended that you use
3082 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3083 aware of the implications of not being able to handle encoded URI paths correctly.
3085 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3086 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3087 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3088 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3089 C<< $c->request->base >> will be incorrect.
3095 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3099 =head1 INTERNAL ACTIONS
3101 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3102 C<_ACTION>, and C<_END>. These are by default not shown in the private
3103 action table, but you can make them visible with a config parameter.
3105 MyApp->config(show_internal_actions => 1);
3107 =head1 ON-DEMAND PARSER
3109 The request body is usually parsed at the beginning of a request,
3110 but if you want to handle input yourself, you can enable on-demand
3111 parsing with a config parameter.
3113 MyApp->config(parse_on_demand => 1);
3115 =head1 PROXY SUPPORT
3117 Many production servers operate using the common double-server approach,
3118 with a lightweight frontend web server passing requests to a larger
3119 backend server. An application running on the backend server must deal
3120 with two problems: the remote user always appears to be C<127.0.0.1> and
3121 the server's hostname will appear to be C<localhost> regardless of the
3122 virtual host that the user connected through.
3124 Catalyst will automatically detect this situation when you are running
3125 the frontend and backend servers on the same machine. The following
3126 changes are made to the request.
3128 $c->req->address is set to the user's real IP address, as read from
3129 the HTTP X-Forwarded-For header.
3131 The host value for $c->req->base and $c->req->uri is set to the real
3132 host, as read from the HTTP X-Forwarded-Host header.
3134 Additionally, you may be running your backend application on an insecure
3135 connection (port 80) while your frontend proxy is running under SSL. If there
3136 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3137 tell Catalyst what port the frontend listens on. This will allow all URIs to
3138 be created properly.
3140 In the case of passing in:
3142 X-Forwarded-Port: 443
3144 All calls to C<uri_for> will result in an https link, as is expected.
3146 Obviously, your web server must support these headers for this to work.
3148 In a more complex server farm environment where you may have your
3149 frontend proxy server(s) on different machines, you will need to set a
3150 configuration option to tell Catalyst to read the proxied data from the
3153 MyApp->config(using_frontend_proxy => 1);
3155 If you do not wish to use the proxy support at all, you may set:
3157 MyApp->config(ignore_frontend_proxy => 0);
3159 =head2 Note about psgi files
3161 Note that if you supply your own .psgi file, calling
3162 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3164 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3165 in your psgi, for example:
3168 enable "Plack::Middleware::ReverseProxy";
3172 This will unconditionally add the ReverseProxy support, or you need to call
3173 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3174 apply the support depending upon your config).
3176 See L<Catalyst::PSGI> for more information.
3178 =head1 THREAD SAFETY
3180 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3181 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3182 believe the Catalyst core to be thread-safe.
3184 If you plan to operate in a threaded environment, remember that all other
3185 modules you are using must also be thread-safe. Some modules, most notably
3186 L<DBD::SQLite>, are not thread-safe.
3192 Join #catalyst on irc.perl.org.
3196 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3197 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3201 http://catalyst.perl.org
3205 http://dev.catalyst.perl.org
3209 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3211 =head2 L<Catalyst::Manual> - The Catalyst Manual
3213 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3215 =head2 L<Catalyst::Engine> - Core engine
3217 =head2 L<Catalyst::Log> - Log class.
3219 =head2 L<Catalyst::Request> - Request object
3221 =head2 L<Catalyst::Response> - Response object
3223 =head2 L<Catalyst::Test> - The test suite.
3227 =head1 PROJECT FOUNDER
3229 sri: Sebastian Riedel <sri@cpan.org>
3235 acme: Leon Brocard <leon@astray.com>
3237 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3241 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3245 andyg: Andy Grundman <andy@hybridized.org>
3247 audreyt: Audrey Tang
3249 bricas: Brian Cassidy <bricas@cpan.org>
3251 Caelum: Rafael Kitover <rkitover@io.com>
3253 chansen: Christian Hansen
3255 chicks: Christopher Hicks
3257 Chisel Wright C<pause@herlpacker.co.uk>
3259 Danijel Milicevic C<me@danijel.de>
3261 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3263 David Naughton, C<naughton@umn.edu>
3267 dhoss: Devin Austin <dhoss@cpan.org>
3269 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3273 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3275 esskar: Sascha Kiefer
3277 fireartist: Carl Franks <cfranks@cpan.org>
3279 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3281 gabb: Danijel Milicevic
3285 Gavin Henry C<ghenry@perl.me.uk>
3289 groditi: Guillermo Roditi <groditi@gmail.com>
3291 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3293 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3295 jcamacho: Juan Camacho
3297 jester: Jesse Sheidlower C<jester@panix.com>
3299 jhannah: Jay Hannah <jay@jays.net>
3305 jon: Jon Schutz <jjschutz@cpan.org>
3307 Jonathan Rockway C<< <jrockway@cpan.org> >>
3309 Kieren Diment C<kd@totaldatasolution.com>
3311 konobi: Scott McWhirter <konobi@cpan.org>
3313 marcus: Marcus Ramberg <mramberg@cpan.org>
3315 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3317 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3321 naughton: David Naughton
3323 ningu: David Kamholz <dkamholz@cpan.org>
3325 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3327 numa: Dan Sully <daniel@cpan.org>
3333 omega: Andreas Marienborg
3335 Oleg Kostyuk <cub.uanic@gmail.com>
3337 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3339 rafl: Florian Ragwitz <rafl@debian.org>
3341 random: Roland Lammel <lammel@cpan.org>
3343 Robert Sedlacek C<< <rs@474.at> >>
3345 SpiceMan: Marcel Montes
3349 szbalint: Balint Szilakszi <szbalint@cpan.org>
3351 t0m: Tomas Doran <bobtfish@bobtfish.net>
3355 Viljo Marrandi C<vilts@yahoo.com>
3357 Will Hawes C<info@whawes.co.uk>
3359 willert: Sebastian Willert <willert@cpan.org>
3361 wreis: Wallace Reis <wallace@reis.org.br>
3363 Yuval Kogman, C<nothingmuch@woobling.org>
3365 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3367 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3373 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3377 This library is free software. You can redistribute it and/or modify it under
3378 the same terms as Perl itself.
3384 __PACKAGE__->meta->make_immutable;