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 ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
33 use Carp qw/croak carp shortmess/;
35 BEGIN { require 5.008004; }
37 has stack => (is => 'ro', default => sub { [] });
38 has stash => (is => 'rw', default => sub { {} });
39 has state => (is => 'rw', default => 0);
40 has stats => (is => 'rw');
41 has action => (is => 'rw');
42 has counter => (is => 'rw', default => sub { {} });
43 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
44 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
45 has namespace => (is => 'rw');
47 sub depth { scalar @{ shift->stack || [] }; }
48 sub comp { shift->component(@_) }
51 my $self = shift; return $self->request(@_);
54 my $self = shift; return $self->response(@_);
57 # For backwards compatibility
58 sub finalize_output { shift->finalize_body(@_) };
63 our $RECURSION = 1000;
64 our $DETACH = Catalyst::Exception::Detach->new;
65 our $GO = Catalyst::Exception::Go->new;
67 #I imagine that very few of these really need to be class variables. if any.
68 #maybe we should just make them attributes with a default?
69 __PACKAGE__->mk_classdata($_)
70 for qw/components arguments dispatcher engine log dispatcher_class
71 engine_class context_class request_class response_class stats_class
74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
75 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
76 __PACKAGE__->request_class('Catalyst::Request');
77 __PACKAGE__->response_class('Catalyst::Response');
78 __PACKAGE__->stats_class('Catalyst::Stats');
80 # Remember to update this in Catalyst::Runtime as well!
82 our $VERSION = '5.80025';
85 my ( $class, @arguments ) = @_;
87 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
89 return unless $class eq 'Catalyst';
91 my $caller = caller();
92 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 unless ( $caller->isa('Catalyst') ) {
96 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
97 $meta->superclasses(@superclasses);
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
106 $caller->arguments( [@arguments] );
110 sub _application { $_[0] }
114 Catalyst - The Elegant MVC Web Application Framework
118 See the L<Catalyst::Manual> distribution for comprehensive
119 documentation and tutorials.
121 # Install Catalyst::Devel for helpers and other development tools
122 # use the helper to create a new application
125 # add models, views, controllers
126 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
127 script/myapp_create.pl view MyTemplate TT
128 script/myapp_create.pl controller Search
130 # built in testserver -- use -r to restart automatically on changes
131 # --help to see all available options
132 script/myapp_server.pl
134 # command line testing interface
135 script/myapp_test.pl /yada
138 use Catalyst qw/-Debug/; # include plugins here as well
140 ### In lib/MyApp/Controller/Root.pm (autocreated)
141 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
142 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
143 $c->stash->{template} = 'foo.tt'; # set the template
144 # lookup something from db -- stash vars are passed to TT
146 $c->model('Database::Foo')->search( { country => $args[0] } );
147 if ( $c->req->params->{bar} ) { # access GET or POST parameters
148 $c->forward( 'bar' ); # process another action
149 # do something else after forward returns
153 # The foo.tt TT template can use the stash data from the database
154 [% WHILE (item = data.next) %]
158 # called for /bar/of/soap, /bar/of/soap/10, etc.
159 sub bar : Path('/bar/of/soap') { ... }
161 # called for all actions, from the top-most controller downwards
163 my ( $self, $c ) = @_;
164 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
165 $c->res->redirect( '/login' ); # require login
166 return 0; # abort request and go immediately to end()
168 return 1; # success; carry on to next action
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 ### in MyApp/Controller/Foo.pm
180 # called for /foo/bar
181 sub bar : Local { ... }
183 # called for /blargle
184 sub blargle : Global { ... }
186 # an index action matches /foo, but not /foo/1, etc.
187 sub index : Private { ... }
189 ### in MyApp/Controller/Foo/Bar.pm
190 # called for /foo/bar/baz
191 sub baz : Local { ... }
193 # first Root auto is called, then Foo auto, then this
194 sub auto : Private { ... }
196 # powerful regular expression paths are also possible
197 sub details : Regex('^product/(\w+)/details$') {
198 my ( $self, $c ) = @_;
199 # extract the (\w+) from the URI
200 my $product = $c->req->captures->[0];
203 See L<Catalyst::Manual::Intro> for additional information.
207 Catalyst is a modern framework for making web applications without the
208 pain usually associated with this process. This document is a reference
209 to the main Catalyst application. If you are a new user, we suggest you
210 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
212 See L<Catalyst::Manual> for more documentation.
214 Catalyst plugins can be loaded by naming them as arguments to the "use
215 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
216 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
219 use Catalyst qw/My::Module/;
221 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
222 fully qualify the name by using a unary plus:
226 +Fully::Qualified::Plugin::Name
229 Special flags like C<-Debug> and C<-Engine> can also be specified as
230 arguments when Catalyst is loaded:
232 use Catalyst qw/-Debug My::Module/;
234 The position of plugins and flags in the chain is important, because
235 they are loaded in the order in which they appear.
237 The following flags are supported:
241 Enables debug output. You can also force this setting from the system
242 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
243 settings override the application, with <MYAPP>_DEBUG having the highest
246 This sets the log level to 'debug' and enables full debug output on the
247 error screen. If you only want the latter, see L<< $c->debug >>.
251 Forces Catalyst to use a specific engine. Omit the
252 C<Catalyst::Engine::> prefix of the engine name, i.e.:
254 use Catalyst qw/-Engine=CGI/;
258 Forces Catalyst to use a specific home directory, e.g.:
260 use Catalyst qw[-Home=/usr/mst];
262 This can also be done in the shell environment by setting either the
263 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
264 is replaced with the uppercased name of your application, any "::" in
265 the name will be replaced with underscores, e.g. MyApp::Web should use
266 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
268 If none of these are set, Catalyst will attempt to automatically detect the
269 home directory. If you are working in a development envirnoment, Catalyst
270 will try and find the directory containing either Makefile.PL, Build.PL or
271 dist.ini. If the application has been installed into the system (i.e.
272 you have done C<make install>), then Catalyst will use the path to your
273 application module, without the .pm extension (ie, /foo/MyApp if your
274 application was installed at /foo/MyApp.pm)
278 use Catalyst '-Log=warn,fatal,error';
280 Specifies a comma-delimited list of log levels.
284 Enables statistics collection and reporting.
286 use Catalyst qw/-Stats=1/;
288 You can also force this setting from the system environment with CATALYST_STATS
289 or <MYAPP>_STATS. The environment settings override the application, with
290 <MYAPP>_STATS having the highest priority.
292 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
296 =head2 INFORMATION ABOUT THE CURRENT REQUEST
300 Returns a L<Catalyst::Action> object for the current action, which
301 stringifies to the action name. See L<Catalyst::Action>.
305 Returns the namespace of the current action, i.e., the URI prefix
306 corresponding to the controller of the current action. For example:
308 # in Controller::Foo::Bar
309 $c->namespace; # returns 'foo/bar';
315 Returns the current L<Catalyst::Request> object, giving access to
316 information about the current client request (including parameters,
317 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
319 =head2 REQUEST FLOW HANDLING
321 =head2 $c->forward( $action [, \@arguments ] )
323 =head2 $c->forward( $class, $method, [, \@arguments ] )
325 Forwards processing to another action, by its private name. If you give a
326 class name but no method, C<process()> is called. You may also optionally
327 pass arguments in an arrayref. The action will receive the arguments in
328 C<@_> and C<< $c->req->args >>. Upon returning from the function,
329 C<< $c->req->args >> will be restored to the previous values.
331 Any data C<return>ed from the action forwarded to, will be returned by the
334 my $foodata = $c->forward('/foo');
335 $c->forward('index');
336 $c->forward(qw/Model::DBIC::Foo do_stuff/);
337 $c->forward('View::TT');
339 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
340 an C<< eval { } >> around the call (actually
341 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
342 all 'dies' within the called action. If you want C<die> to propagate you
343 need to do something like:
346 die join "\n", @{ $c->error } if @{ $c->error };
348 Or make sure to always return true values from your actions and write
351 $c->forward('foo') || return;
353 Another note is that C<< $c->forward >> always returns a scalar because it
354 actually returns $c->state which operates in a scalar context.
355 Thus, something like:
359 in an action that is forwarded to is going to return a scalar,
360 i.e. how many items are in that array, which is probably not what you want.
361 If you need to return an array then return a reference to it,
364 $c->stash->{array} = \@array;
366 and access it from the stash.
370 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
372 =head2 $c->detach( $action [, \@arguments ] )
374 =head2 $c->detach( $class, $method, [, \@arguments ] )
378 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
379 doesn't return to the previous action when processing is finished.
381 When called with no arguments it escapes the processing chain entirely.
385 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
387 =head2 $c->visit( $action [, \@captures, \@arguments ] )
389 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
391 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
392 but does a full dispatch, instead of just calling the new C<$action> /
393 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
394 you go to are called, just like a new request.
396 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
397 This means, for example, that C<< $c->action >> methods such as
398 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
399 L<reverse|Catalyst::Action/reverse> return information for the visited action
400 when they are invoked within the visited action. This is different from the
401 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
402 continues to use the $c->action object from the caller action even when
403 invoked from the callee.
405 C<< $c->stash >> is kept unchanged.
407 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
408 allows you to "wrap" another action, just as it would have been called by
409 dispatching from a URL, while the analogous
410 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
411 transfer control to another action as if it had been reached directly from a URL.
415 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
417 =head2 $c->go( $action [, \@captures, \@arguments ] )
419 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
421 The relationship between C<go> and
422 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
423 the relationship between
424 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
425 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
426 C<< $c->go >> will perform a full dispatch on the specified action or method,
427 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
428 C<go> escapes the processing of the current request chain on completion, and
429 does not return to its caller.
433 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
439 Returns the current L<Catalyst::Response> object, see there for details.
443 Returns a hashref to the stash, which may be used to store data and pass
444 it between components during a request. You can also set hash keys by
445 passing arguments. The stash is automatically sent to the view. The
446 stash is cleared at the end of a request; it cannot be used for
447 persistent storage (for this you must use a session; see
448 L<Catalyst::Plugin::Session> for a complete system integrated with
451 $c->stash->{foo} = $bar;
452 $c->stash( { moose => 'majestic', qux => 0 } );
453 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
455 # stash is automatically passed to the view for use in a template
456 $c->forward( 'MyApp::View::TT' );
460 around stash => sub {
463 my $stash = $orig->($c);
465 my $new_stash = @_ > 1 ? {@_} : $_[0];
466 croak('stash takes a hash or hashref') unless ref $new_stash;
467 foreach my $key ( keys %$new_stash ) {
468 $stash->{$key} = $new_stash->{$key};
478 =head2 $c->error($error, ...)
480 =head2 $c->error($arrayref)
482 Returns an arrayref containing error messages. If Catalyst encounters an
483 error while processing a request, it stores the error in $c->error. This
484 method should only be used to store fatal error messages.
486 my @error = @{ $c->error };
490 $c->error('Something bad happened');
497 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
498 croak @$error unless ref $c;
499 push @{ $c->{error} }, @$error;
501 elsif ( defined $_[0] ) { $c->{error} = undef }
502 return $c->{error} || [];
508 Contains the return value of the last executed action.
509 Note that << $c->state >> operates in a scalar context which means that all
510 values it returns are scalar.
512 =head2 $c->clear_errors
514 Clear errors. You probably don't want to clear the errors unless you are
515 implementing a custom error screen.
517 This is equivalent to running
528 sub _comp_search_prefixes {
530 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
533 # search components given a name and some prefixes
534 sub _comp_names_search_prefixes {
535 my ( $c, $name, @prefixes ) = @_;
536 my $appclass = ref $c || $c;
537 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
538 $filter = qr/$filter/; # Compile regex now rather than once per loop
540 # map the original component name to the sub part that we will search against
541 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
542 grep { /$filter/ } keys %{ $c->components };
544 # undef for a name will return all
545 return keys %eligible if !defined $name;
547 my $query = ref $name ? $name : qr/^$name$/i;
548 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
550 return @result if @result;
552 # if we were given a regexp to search against, we're done.
555 # skip regexp fallback if configured
557 if $appclass->config->{disable_component_resolution_regex_fallback};
561 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
563 # no results? try against full names
565 @result = grep { m{$query} } keys %eligible;
568 # don't warn if we didn't find any results, it just might not exist
570 # Disgusting hack to work out correct method name
571 my $warn_for = lc $prefixes[0];
572 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
573 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
574 "component resolution is unreliable and unsafe.";
575 my $short = $result[0];
576 # remove the component namespace prefix
577 $short =~ s/.*?(Model|Controller|View):://;
578 my $shortmess = Carp::shortmess('');
579 if ($shortmess =~ m#Catalyst/Plugin#) {
580 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
582 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
583 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
584 "component's config";
586 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
587 "but if you really wanted to search, pass in a regexp as the argument " .
588 "like so: \$c->${warn_for}(qr/${name}/)";
590 $c->log->warn( "${msg}$shortmess" );
596 # Find possible names for a prefix
598 my ( $c, @prefixes ) = @_;
599 my $appclass = ref $c || $c;
601 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
603 my @names = map { s{$filter}{}; $_; }
604 $c->_comp_names_search_prefixes( undef, @prefixes );
609 # Filter a component before returning by calling ACCEPT_CONTEXT if available
610 sub _filter_component {
611 my ( $c, $comp, @args ) = @_;
613 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
614 return $comp->ACCEPT_CONTEXT( $c, @args );
620 =head2 COMPONENT ACCESSORS
622 =head2 $c->controller($name)
624 Gets a L<Catalyst::Controller> instance by name.
626 $c->controller('Foo')->do_stuff;
628 If the name is omitted, will return the controller for the dispatched
631 If you want to search for controllers, pass in a regexp as the argument.
633 # find all controllers that start with Foo
634 my @foo_controllers = $c->controller(qr{^Foo});
640 my ( $c, $name, @args ) = @_;
642 my $appclass = ref($c) || $c;
644 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
645 my $comps = $c->components;
646 my $check = $appclass."::Controller::".$name;
647 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
649 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
650 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
651 return $c->_filter_component( $result[ 0 ], @args );
654 return $c->component( $c->action->class );
657 =head2 $c->model($name)
659 Gets a L<Catalyst::Model> instance by name.
661 $c->model('Foo')->do_stuff;
663 Any extra arguments are directly passed to ACCEPT_CONTEXT.
665 If the name is omitted, it will look for
666 - a model object in $c->stash->{current_model_instance}, then
667 - a model name in $c->stash->{current_model}, then
668 - a config setting 'default_model', or
669 - check if there is only one model, and return it if that's the case.
671 If you want to search for models, pass in a regexp as the argument.
673 # find all models that start with Foo
674 my @foo_models = $c->model(qr{^Foo});
679 my ( $c, $name, @args ) = @_;
680 my $appclass = ref($c) || $c;
682 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
683 my $comps = $c->components;
684 my $check = $appclass."::Model::".$name;
685 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
687 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
688 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
689 return $c->_filter_component( $result[ 0 ], @args );
693 return $c->stash->{current_model_instance}
694 if $c->stash->{current_model_instance};
695 return $c->model( $c->stash->{current_model} )
696 if $c->stash->{current_model};
698 return $c->model( $appclass->config->{default_model} )
699 if $appclass->config->{default_model};
701 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
704 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
705 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
706 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
707 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
708 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
711 return $c->_filter_component( $comp );
715 =head2 $c->view($name)
717 Gets a L<Catalyst::View> instance by name.
719 $c->view('Foo')->do_stuff;
721 Any extra arguments are directly passed to ACCEPT_CONTEXT.
723 If the name is omitted, it will look for
724 - a view object in $c->stash->{current_view_instance}, then
725 - a view name in $c->stash->{current_view}, then
726 - a config setting 'default_view', or
727 - check if there is only one view, and return it if that's the case.
729 If you want to search for views, pass in a regexp as the argument.
731 # find all views that start with Foo
732 my @foo_views = $c->view(qr{^Foo});
737 my ( $c, $name, @args ) = @_;
739 my $appclass = ref($c) || $c;
741 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
742 my $comps = $c->components;
743 my $check = $appclass."::View::".$name;
744 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
746 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
747 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
748 return $c->_filter_component( $result[ 0 ], @args );
752 return $c->stash->{current_view_instance}
753 if $c->stash->{current_view_instance};
754 return $c->view( $c->stash->{current_view} )
755 if $c->stash->{current_view};
757 return $c->view( $appclass->config->{default_view} )
758 if $appclass->config->{default_view};
760 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
763 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
764 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
765 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
766 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
767 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
770 return $c->_filter_component( $comp );
773 =head2 $c->controllers
775 Returns the available names which can be passed to $c->controller
781 return $c->_comp_names(qw/Controller C/);
786 Returns the available names which can be passed to $c->model
792 return $c->_comp_names(qw/Model M/);
798 Returns the available names which can be passed to $c->view
804 return $c->_comp_names(qw/View V/);
807 =head2 $c->comp($name)
809 =head2 $c->component($name)
811 Gets a component object by name. This method is not recommended,
812 unless you want to get a specific component by full
813 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
814 should be used instead.
816 If C<$name> is a regexp, a list of components matched against the full
817 component name will be returned.
819 If Catalyst can't find a component by name, it will fallback to regex
820 matching by default. To disable this behaviour set
821 disable_component_resolution_regex_fallback to a true value.
823 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
828 my ( $c, $name, @args ) = @_;
831 my $comps = $c->components;
834 # is it the exact name?
835 return $c->_filter_component( $comps->{ $name }, @args )
836 if exists $comps->{ $name };
838 # perhaps we just omitted "MyApp"?
839 my $composed = ( ref $c || $c ) . "::${name}";
840 return $c->_filter_component( $comps->{ $composed }, @args )
841 if exists $comps->{ $composed };
843 # search all of the models, views and controllers
844 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
845 return $c->_filter_component( $comp, @args ) if $comp;
848 # This is here so $c->comp( '::M::' ) works
849 my $query = ref $name ? $name : qr{$name}i;
851 my @result = grep { m{$query} } keys %{ $c->components };
852 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
855 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
856 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
857 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
858 return $c->_filter_component( $result[ 0 ], @args );
861 # I would expect to return an empty list here, but that breaks back-compat
865 return sort keys %{ $c->components };
868 =head2 CLASS DATA AND HELPER CLASSES
872 Returns or takes a hashref containing the application's configuration.
874 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
876 You can also use a C<YAML>, C<XML> or L<Config::General> config file
877 like C<myapp.conf> in your applications home directory. See
878 L<Catalyst::Plugin::ConfigLoader>.
880 =head3 Cascading configuration
882 The config method is present on all Catalyst components, and configuration
883 will be merged when an application is started. Configuration loaded with
884 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
885 followed by configuration in your top level C<MyApp> class. These two
886 configurations are merged, and then configuration data whose hash key matches a
887 component name is merged with configuration for that component.
889 The configuration for a component is then passed to the C<new> method when a
890 component is constructed.
894 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
895 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
897 will mean that C<MyApp::Model::Foo> receives the following data when
900 MyApp::Model::Foo->new({
906 It's common practice to use a Moose attribute
907 on the receiving component to access the config value.
909 package MyApp::Model::Foo;
913 # this attr will receive 'baz' at construction time
919 You can then get the value 'baz' by calling $c->model('Foo')->bar
923 around config => sub {
927 croak('Setting config after setup has been run is not allowed.')
928 if ( @_ and $c->setup_finished );
935 Returns the logging object instance. Unless it is already set, Catalyst
936 sets this up with a L<Catalyst::Log> object. To use your own log class,
937 set the logger with the C<< __PACKAGE__->log >> method prior to calling
938 C<< __PACKAGE__->setup >>.
940 __PACKAGE__->log( MyLogger->new );
945 $c->log->info( 'Now logging with my own logger!' );
947 Your log class should implement the methods described in
953 Returns 1 if debug mode is enabled, 0 otherwise.
955 You can enable debug mode in several ways:
959 =item By calling myapp_server.pl with the -d flag
961 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
963 =item The -Debug option in your MyApp.pm
965 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
969 The first three also set the log level to 'debug'.
971 Calling C<< $c->debug(1) >> has no effect.
977 =head2 $c->dispatcher
979 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
983 Returns the engine instance. See L<Catalyst::Engine>.
986 =head2 UTILITY METHODS
988 =head2 $c->path_to(@path)
990 Merges C<@path> with C<< $c->config->{home} >> and returns a
991 L<Path::Class::Dir> object. Note you can usually use this object as
992 a filename, but sometimes you will have to explicitly stringify it
993 yourself by calling the C<< ->stringify >> method.
997 $c->path_to( 'db', 'sqlite.db' );
1002 my ( $c, @path ) = @_;
1003 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1004 if ( -d $path ) { return $path }
1005 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1008 =head2 $c->plugin( $name, $class, @args )
1010 Helper method for plugins. It creates a class data accessor/mutator and
1011 loads and instantiates the given class.
1013 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1015 $c->prototype->define_javascript_functions;
1017 B<Note:> This method of adding plugins is deprecated. The ability
1018 to add plugins like this B<will be removed> in a Catalyst 5.81.
1019 Please do not use this functionality in new code.
1024 my ( $class, $name, $plugin, @args ) = @_;
1026 # See block comment in t/unit_core_plugin.t
1027 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1029 $class->_register_plugin( $plugin, 1 );
1031 eval { $plugin->import };
1032 $class->mk_classdata($name);
1034 eval { $obj = $plugin->new(@args) };
1037 Catalyst::Exception->throw( message =>
1038 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1041 $class->$name($obj);
1042 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1048 Initializes the dispatcher and engine, loads any plugins, and loads the
1049 model, view, and controller components. You may also specify an array
1050 of plugins to load here, if you choose to not load them in the C<use
1054 MyApp->setup( qw/-Debug/ );
1059 my ( $class, @arguments ) = @_;
1060 croak('Running setup more than once')
1061 if ( $class->setup_finished );
1063 unless ( $class->isa('Catalyst') ) {
1065 Catalyst::Exception->throw(
1066 message => qq/'$class' does not inherit from Catalyst/ );
1069 if ( $class->arguments ) {
1070 @arguments = ( @arguments, @{ $class->arguments } );
1076 foreach (@arguments) {
1080 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1082 elsif (/^-(\w+)=?(.*)$/) {
1083 $flags->{ lc $1 } = $2;
1086 push @{ $flags->{plugins} }, $_;
1090 $class->setup_home( delete $flags->{home} );
1092 $class->setup_log( delete $flags->{log} );
1093 $class->setup_plugins( delete $flags->{plugins} );
1094 $class->setup_dispatcher( delete $flags->{dispatcher} );
1095 $class->setup_engine( delete $flags->{engine} );
1096 $class->setup_stats( delete $flags->{stats} );
1098 for my $flag ( sort keys %{$flags} ) {
1100 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1101 &$code( $class, delete $flags->{$flag} );
1104 $class->log->warn(qq/Unknown flag "$flag"/);
1108 eval { require Catalyst::Devel; };
1109 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1110 $class->log->warn(<<"EOF");
1111 You are running an old script!
1113 Please update by running (this will overwrite existing files):
1114 catalyst.pl -force -scripts $class
1116 or (this will not overwrite existing files):
1117 catalyst.pl -scripts $class
1122 if ( $class->debug ) {
1123 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1126 my $column_width = Catalyst::Utils::term_width() - 6;
1127 my $t = Text::SimpleTable->new($column_width);
1128 $t->row($_) for @plugins;
1129 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1132 my $dispatcher = $class->dispatcher;
1133 my $engine = $class->engine;
1134 my $home = $class->config->{home};
1136 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1137 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1141 ? $class->log->debug(qq/Found home "$home"/)
1142 : $class->log->debug(qq/Home "$home" doesn't exist/)
1143 : $class->log->debug(q/Couldn't find home/);
1146 # Call plugins setup, this is stupid and evil.
1147 # Also screws C3 badly on 5.10, hack to avoid.
1149 no warnings qw/redefine/;
1150 local *setup = sub { };
1151 $class->setup unless $Catalyst::__AM_RESTARTING;
1154 # Initialize our data structure
1155 $class->components( {} );
1157 $class->setup_components;
1159 if ( $class->debug ) {
1160 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1161 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1162 for my $comp ( sort keys %{ $class->components } ) {
1163 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1164 $t->row( $comp, $type );
1166 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1167 if ( keys %{ $class->components } );
1170 # Add our self to components, since we are also a component
1171 if( $class->isa('Catalyst::Controller') ){
1172 $class->components->{$class} = $class;
1175 $class->setup_actions;
1177 if ( $class->debug ) {
1178 my $name = $class->config->{name} || 'Application';
1179 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1182 # Make sure that the application class becomes immutable at this point,
1183 B::Hooks::EndOfScope::on_scope_end {
1185 my $meta = Class::MOP::get_metaclass_by_name($class);
1188 && ! { $meta->immutable_options }->{replace_constructor}
1190 $class->isa('Class::Accessor::Fast')
1191 || $class->isa('Class::Accessor')
1194 warn "You made your application class ($class) immutable, "
1195 . "but did not inline the\nconstructor. "
1196 . "This will break catalyst, as your app \@ISA "
1197 . "Class::Accessor(::Fast)?\nPlease pass "
1198 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1200 $meta->make_immutable(
1201 replace_constructor => 1,
1202 ) unless $meta->is_immutable;
1205 if ($class->config->{case_sensitive}) {
1206 $class->log->warn($class . "->config->{case_sensitive} is set.");
1207 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1210 $class->setup_finalize;
1211 # Should be the last thing we do so that user things hooking
1212 # setup_finalize can log..
1213 $class->log->_flush() if $class->log->can('_flush');
1214 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1217 =head2 $app->setup_finalize
1219 A hook to attach modifiers to. This method does not do anything except set the
1220 C<setup_finished> accessor.
1222 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1226 after setup_finalize => sub {
1234 sub setup_finalize {
1236 $class->setup_finished(1);
1239 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1241 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1243 Constructs an absolute L<URI> object based on the application root, the
1244 provided path, and the additional arguments and query parameters provided.
1245 When used as a string, provides a textual URI. If you need more flexibility
1246 than this (i.e. the option to provide relative URIs etc.) see
1247 L<Catalyst::Plugin::SmartURI>.
1249 If no arguments are provided, the URI for the current action is returned.
1250 To return the current action and also provide @args, use
1251 C<< $c->uri_for( $c->action, @args ) >>.
1253 If the first argument is a string, it is taken as a public URI path relative
1254 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1255 relative to the application root (if it does). It is then merged with
1256 C<< $c->request->base >>; any C<@args> are appended as additional path
1257 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1259 If the first argument is a L<Catalyst::Action> it represents an action which
1260 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1261 optional C<\@captures> argument (an arrayref) allows passing the captured
1262 variables that are needed to fill in the paths of Chained and Regex actions;
1263 once the path is resolved, C<uri_for> continues as though a path was
1264 provided, appending any arguments or parameters and creating an absolute
1267 The captures for the current request can be found in
1268 C<< $c->request->captures >>, and actions can be resolved using
1269 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1270 path, use C<< $c->uri_for_action >> instead.
1272 # Equivalent to $c->req->uri
1273 $c->uri_for($c->action, $c->req->captures,
1274 @{ $c->req->args }, $c->req->params);
1276 # For the Foo action in the Bar controller
1277 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1279 # Path to a static resource
1280 $c->uri_for('/static/images/logo.png');
1285 my ( $c, $path, @args ) = @_;
1287 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1288 $path = $path->path_prefix;
1293 undef($path) if (defined $path && $path eq '');
1296 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1298 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1299 foreach my $arg (@args) {
1300 utf8::encode($arg) if utf8::is_utf8($arg);
1301 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1304 if ( blessed($path) ) { # action object
1305 s|/|%2F|g for @args;
1306 my $captures = [ map { s|/|%2F|g; $_; }
1307 ( scalar @args && ref $args[0] eq 'ARRAY'
1311 foreach my $capture (@$captures) {
1312 utf8::encode($capture) if utf8::is_utf8($capture);
1313 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1317 $path = $c->dispatcher->uri_for_action($action, $captures);
1318 if (not defined $path) {
1319 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1323 $path = '/' if $path eq '';
1326 unshift(@args, $path);
1328 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1329 my $namespace = $c->namespace;
1330 if (defined $path) { # cheesy hack to handle path '../foo'
1331 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1333 unshift(@args, $namespace || '');
1336 # join args with '/', or a blank string
1337 my $args = join('/', grep { defined($_) } @args);
1338 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1340 my $base = $c->req->base;
1341 my $class = ref($base);
1342 $base =~ s{(?<!/)$}{/};
1346 if (my @keys = keys %$params) {
1347 # somewhat lifted from URI::_query's query_form
1348 $query = '?'.join('&', map {
1349 my $val = $params->{$_};
1350 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1353 $val = '' unless defined $val;
1356 utf8::encode( $param ) if utf8::is_utf8($param);
1357 # using the URI::Escape pattern here so utf8 chars survive
1358 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1360 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1364 my $res = bless(\"${base}${args}${query}", $class);
1368 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1370 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1376 A private path to the Catalyst action you want to create a URI for.
1378 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1379 >> and passing the resulting C<$action> and the remaining arguments to C<<
1382 You can also pass in a Catalyst::Action object, in which case it is passed to
1385 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.
1387 For example, if the action looks like:
1389 package MyApp::Controller::Users;
1391 sub lst : Path('the-list') {}
1395 $c->uri_for_action('/users/lst')
1397 and it will create the URI /users/the-list.
1403 sub uri_for_action {
1404 my ( $c, $path, @args ) = @_;
1405 my $action = blessed($path)
1407 : $c->dispatcher->get_action_by_path($path);
1408 unless (defined $action) {
1409 croak "Can't find action for path '$path'";
1411 return $c->uri_for( $action, @args );
1414 =head2 $c->welcome_message
1416 Returns the Catalyst welcome HTML page.
1420 sub welcome_message {
1422 my $name = $c->config->{name};
1423 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1424 my $prefix = Catalyst::Utils::appprefix( ref $c );
1425 $c->response->content_type('text/html; charset=utf-8');
1427 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1428 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1429 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1431 <meta http-equiv="Content-Language" content="en" />
1432 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1433 <title>$name on Catalyst $VERSION</title>
1434 <style type="text/css">
1437 background-color: #eee;
1444 margin-bottom: 10px;
1446 background-color: #ccc;
1447 border: 1px solid #aaa;
1452 font-family: verdana, tahoma, sans-serif;
1455 font-family: verdana, tahoma, sans-serif;
1458 text-decoration: none;
1460 border-bottom: 1px dotted #bbb;
1462 :link:hover, :visited:hover {
1475 background-color: #fff;
1476 border: 1px solid #aaa;
1480 font-weight: normal;
1502 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1507 <img src="$logo" alt="Catalyst Logo" />
1509 <p>Welcome to the world of Catalyst.
1510 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1511 framework will make web development something you had
1512 never expected it to be: Fun, rewarding, and quick.</p>
1513 <h2>What to do now?</h2>
1514 <p>That really depends on what <b>you</b> want to do.
1515 We do, however, provide you with a few starting points.</p>
1516 <p>If you want to jump right into web development with Catalyst
1517 you might want to start with a tutorial.</p>
1518 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1520 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1522 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1523 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1525 <h2>What to do next?</h2>
1526 <p>Next it's time to write an actual application. Use the
1527 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1528 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1529 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1530 they can save you a lot of work.</p>
1531 <pre><code>script/${prefix}_create.pl --help</code></pre>
1532 <p>Also, be sure to check out the vast and growing
1533 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1534 you are likely to find what you need there.
1538 <p>Catalyst has a very active community. Here are the main places to
1539 get in touch with us.</p>
1542 <a href="http://dev.catalyst.perl.org">Wiki</a>
1545 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1548 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1551 <h2>In conclusion</h2>
1552 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1553 as we enjoyed making it. Please contact us if you have ideas
1554 for improvement or other feedback.</p>
1562 =head1 INTERNAL METHODS
1564 These methods are not meant to be used by end users.
1566 =head2 $c->components
1568 Returns a hash of components.
1570 =head2 $c->context_class
1572 Returns or sets the context class.
1576 Returns a hashref containing coderefs and execution counts (needed for
1577 deep recursion detection).
1581 Returns the number of actions on the current internal execution stack.
1585 Dispatches a request to actions.
1589 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1591 =head2 $c->dispatcher_class
1593 Returns or sets the dispatcher class.
1595 =head2 $c->dump_these
1597 Returns a list of 2-element array references (name, structure) pairs
1598 that will be dumped on the error page in debug mode.
1604 [ Request => $c->req ],
1605 [ Response => $c->res ],
1606 [ Stash => $c->stash ],
1607 [ Config => $c->config ];
1610 =head2 $c->engine_class
1612 Returns or sets the engine class.
1614 =head2 $c->execute( $class, $coderef )
1616 Execute a coderef in given class and catch exceptions. Errors are available
1622 my ( $c, $class, $code ) = @_;
1623 $class = $c->component($class) || $class;
1626 if ( $c->depth >= $RECURSION ) {
1627 my $action = $code->reverse();
1628 $action = "/$action" unless $action =~ /->/;
1629 my $error = qq/Deep recursion detected calling "${action}"/;
1630 $c->log->error($error);
1636 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1638 push( @{ $c->stack }, $code );
1640 no warnings 'recursion';
1641 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1643 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1645 my $last = pop( @{ $c->stack } );
1647 if ( my $error = $@ ) {
1648 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1649 $error->rethrow if $c->depth > 1;
1651 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1652 $error->rethrow if $c->depth > 0;
1655 unless ( ref $error ) {
1656 no warnings 'uninitialized';
1658 my $class = $last->class;
1659 my $name = $last->name;
1660 $error = qq/Caught exception in $class->$name "$error"/;
1669 sub _stats_start_execute {
1670 my ( $c, $code ) = @_;
1671 my $appclass = ref($c) || $c;
1672 return if ( ( $code->name =~ /^_.*/ )
1673 && ( !$appclass->config->{show_internal_actions} ) );
1675 my $action_name = $code->reverse();
1676 $c->counter->{$action_name}++;
1678 my $action = $action_name;
1679 $action = "/$action" unless $action =~ /->/;
1681 # determine if the call was the result of a forward
1682 # this is done by walking up the call stack and looking for a calling
1683 # sub of Catalyst::forward before the eval
1685 for my $index ( 2 .. 11 ) {
1687 if ( ( caller($index) )[0] eq 'Catalyst'
1688 && ( caller($index) )[3] eq '(eval)' );
1690 if ( ( caller($index) )[3] =~ /forward$/ ) {
1691 $callsub = ( caller($index) )[3];
1692 $action = "-> $action";
1697 my $uid = $action_name . $c->counter->{$action_name};
1699 # is this a root-level call or a forwarded call?
1700 if ( $callsub =~ /forward$/ ) {
1701 my $parent = $c->stack->[-1];
1703 # forward, locate the caller
1704 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1707 parent => "$parent" . $c->counter->{"$parent"},
1713 # forward with no caller may come from a plugin
1732 sub _stats_finish_execute {
1733 my ( $c, $info ) = @_;
1734 $c->stats->profile( end => $info );
1739 Finalizes the request.
1746 for my $error ( @{ $c->error } ) {
1747 $c->log->error($error);
1750 # Allow engine to handle finalize flow (for POE)
1751 my $engine = $c->engine;
1752 if ( my $code = $engine->can('finalize') ) {
1757 $c->finalize_uploads;
1760 if ( $#{ $c->error } >= 0 ) {
1764 $c->finalize_headers;
1767 if ( $c->request->method eq 'HEAD' ) {
1768 $c->response->body('');
1776 if ($c->use_stats) {
1777 my $elapsed = sprintf '%f', $c->stats->elapsed;
1778 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1780 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1783 return $c->response->status;
1786 =head2 $c->finalize_body
1792 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1794 =head2 $c->finalize_cookies
1800 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1802 =head2 $c->finalize_error
1808 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1810 =head2 $c->finalize_headers
1816 sub finalize_headers {
1819 my $response = $c->response; #accessor calls can add up?
1821 # Check if we already finalized headers
1822 return if $response->finalized_headers;
1825 if ( my $location = $response->redirect ) {
1826 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1827 $response->header( Location => $location );
1829 if ( !$response->has_body ) {
1830 # Add a default body if none is already present
1832 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1838 if ( $response->body && !$response->content_length ) {
1840 # get the length from a filehandle
1841 if ( blessed( $response->body ) && $response->body->can('read') )
1843 my $stat = stat $response->body;
1844 if ( $stat && $stat->size > 0 ) {
1845 $response->content_length( $stat->size );
1848 $c->log->warn('Serving filehandle without a content-length');
1852 # everything should be bytes at this point, but just in case
1853 $response->content_length( length( $response->body ) );
1858 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1859 $response->headers->remove_header("Content-Length");
1860 $response->body('');
1863 $c->finalize_cookies;
1865 $c->engine->finalize_headers( $c, @_ );
1868 $response->finalized_headers(1);
1871 =head2 $c->finalize_output
1873 An alias for finalize_body.
1875 =head2 $c->finalize_read
1877 Finalizes the input after reading is complete.
1881 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1883 =head2 $c->finalize_uploads
1885 Finalizes uploads. Cleans up any temporary files.
1889 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1891 =head2 $c->get_action( $action, $namespace )
1893 Gets an action in a given namespace.
1897 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1899 =head2 $c->get_actions( $action, $namespace )
1901 Gets all actions of a given name in a namespace and all parent
1906 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1908 =head2 $app->handle_request( @arguments )
1910 Called to handle each HTTP request.
1914 sub handle_request {
1915 my ( $class, @arguments ) = @_;
1917 # Always expect worst case!
1920 if ($class->debug) {
1921 my $secs = time - $START || 1;
1922 my $av = sprintf '%.3f', $COUNT / $secs;
1923 my $time = localtime time;
1924 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1927 my $c = $class->prepare(@arguments);
1929 $status = $c->finalize;
1932 if ( my $error = $@ ) {
1934 $class->log->error(qq/Caught exception in engine "$error"/);
1939 if(my $coderef = $class->log->can('_flush')){
1940 $class->log->$coderef();
1945 =head2 $c->prepare( @arguments )
1947 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1953 my ( $class, @arguments ) = @_;
1956 # After the app/ctxt split, this should become an attribute based on something passed
1957 # into the application.
1958 $class->context_class( ref $class || $class ) unless $class->context_class;
1960 my $c = $class->context_class->new({});
1962 # For on-demand data
1963 $c->request->_context($c);
1964 $c->response->_context($c);
1966 #surely this is not the most efficient way to do things...
1967 $c->stats($class->stats_class->new)->enable($c->use_stats);
1968 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1969 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1972 #XXX reuse coderef from can
1973 # Allow engine to direct the prepare flow (for POE)
1974 if ( $c->engine->can('prepare') ) {
1975 $c->engine->prepare( $c, @arguments );
1978 $c->prepare_request(@arguments);
1979 $c->prepare_connection;
1980 $c->prepare_query_parameters;
1981 $c->prepare_headers;
1982 $c->prepare_cookies;
1985 # Prepare the body for reading, either by prepare_body
1986 # or the user, if they are using $c->read
1989 # Parse the body unless the user wants it on-demand
1990 unless ( ref($c)->config->{parse_on_demand} ) {
1995 my $method = $c->req->method || '';
1996 my $path = $c->req->path;
1997 $path = '/' unless length $path;
1998 my $address = $c->req->address || '';
2007 =head2 $c->prepare_action
2009 Prepares action. See L<Catalyst::Dispatcher>.
2013 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2015 =head2 $c->prepare_body
2017 Prepares message body.
2024 return if $c->request->_has_body;
2026 # Initialize on-demand data
2027 $c->engine->prepare_body( $c, @_ );
2028 $c->prepare_parameters;
2029 $c->prepare_uploads;
2032 =head2 $c->prepare_body_chunk( $chunk )
2034 Prepares a chunk of data before sending it to L<HTTP::Body>.
2036 See L<Catalyst::Engine>.
2040 sub prepare_body_chunk {
2042 $c->engine->prepare_body_chunk( $c, @_ );
2045 =head2 $c->prepare_body_parameters
2047 Prepares body parameters.
2051 sub prepare_body_parameters {
2053 $c->engine->prepare_body_parameters( $c, @_ );
2056 =head2 $c->prepare_connection
2058 Prepares connection.
2062 sub prepare_connection {
2064 $c->engine->prepare_connection( $c, @_ );
2067 =head2 $c->prepare_cookies
2073 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2075 =head2 $c->prepare_headers
2081 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2083 =head2 $c->prepare_parameters
2085 Prepares parameters.
2089 sub prepare_parameters {
2091 $c->prepare_body_parameters;
2092 $c->engine->prepare_parameters( $c, @_ );
2095 =head2 $c->prepare_path
2097 Prepares path and base.
2101 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2103 =head2 $c->prepare_query_parameters
2105 Prepares query parameters.
2109 sub prepare_query_parameters {
2112 $c->engine->prepare_query_parameters( $c, @_ );
2115 =head2 $c->log_request
2117 Writes information about the request to the debug logs. This includes:
2121 =item * Request method, path, and remote IP address
2123 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2125 =item * Request parameters
2127 =item * File uploads
2136 return unless $c->debug;
2138 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2139 my $request = $dump->[1];
2141 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2143 $path = '/' unless length $path;
2145 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2147 $c->log_request_headers($request->headers);
2149 if ( my $keywords = $request->query_keywords ) {
2150 $c->log->debug("Query keywords are: $keywords");
2153 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2155 $c->log_request_uploads($request);
2158 =head2 $c->log_response
2160 Writes information about the response to the debug logs by calling
2161 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2168 return unless $c->debug;
2170 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2171 my $response = $dump->[1];
2173 $c->log_response_status_line($response);
2174 $c->log_response_headers($response->headers);
2177 =head2 $c->log_response_status_line($response)
2179 Writes one line of information about the response to the debug logs. This includes:
2183 =item * Response status code
2185 =item * Content-Type header (if present)
2187 =item * Content-Length header (if present)
2193 sub log_response_status_line {
2194 my ($c, $response) = @_;
2198 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2199 $response->status || 'unknown',
2200 $response->headers->header('Content-Type') || 'unknown',
2201 $response->headers->header('Content-Length') || 'unknown'
2206 =head2 $c->log_response_headers($headers);
2208 Hook method which can be wrapped by plugins to log the responseheaders.
2209 No-op in the default implementation.
2213 sub log_response_headers {}
2215 =head2 $c->log_request_parameters( query => {}, body => {} )
2217 Logs request parameters to debug logs
2221 sub log_request_parameters {
2223 my %all_params = @_;
2225 return unless $c->debug;
2227 my $column_width = Catalyst::Utils::term_width() - 44;
2228 foreach my $type (qw(query body)) {
2229 my $params = $all_params{$type};
2230 next if ! keys %$params;
2231 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2232 for my $key ( sort keys %$params ) {
2233 my $param = $params->{$key};
2234 my $value = defined($param) ? $param : '';
2235 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2237 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2241 =head2 $c->log_request_uploads
2243 Logs file uploads included in the request to the debug logs.
2244 The parameter name, filename, file type, and file size are all included in
2249 sub log_request_uploads {
2251 my $request = shift;
2252 return unless $c->debug;
2253 my $uploads = $request->uploads;
2254 if ( keys %$uploads ) {
2255 my $t = Text::SimpleTable->new(
2256 [ 12, 'Parameter' ],
2261 for my $key ( sort keys %$uploads ) {
2262 my $upload = $uploads->{$key};
2263 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2264 $t->row( $key, $u->filename, $u->type, $u->size );
2267 $c->log->debug( "File Uploads are:\n" . $t->draw );
2271 =head2 $c->log_request_headers($headers);
2273 Hook method which can be wrapped by plugins to log the request headers.
2274 No-op in the default implementation.
2278 sub log_request_headers {}
2280 =head2 $c->log_headers($type => $headers)
2282 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2289 my $headers = shift; # an HTTP::Headers instance
2291 return unless $c->debug;
2293 my $column_width = Catalyst::Utils::term_width() - 28;
2294 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2297 my ( $name, $value ) = @_;
2298 $t->row( $name, $value );
2301 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2305 =head2 $c->prepare_read
2307 Prepares the input for reading.
2311 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2313 =head2 $c->prepare_request
2315 Prepares the engine request.
2319 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2321 =head2 $c->prepare_uploads
2327 sub prepare_uploads {
2330 $c->engine->prepare_uploads( $c, @_ );
2333 =head2 $c->prepare_write
2335 Prepares the output for writing.
2339 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2341 =head2 $c->request_class
2343 Returns or sets the request class.
2345 =head2 $c->response_class
2347 Returns or sets the response class.
2349 =head2 $c->read( [$maxlength] )
2351 Reads a chunk of data from the request body. This method is designed to
2352 be used in a while loop, reading C<$maxlength> bytes on every call.
2353 C<$maxlength> defaults to the size of the request if not specified.
2355 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2358 Warning: If you use read(), Catalyst will not process the body,
2359 so you will not be able to access POST parameters or file uploads via
2360 $c->request. You must handle all body parsing yourself.
2364 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2372 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2374 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2376 Sets an action in a given namespace.
2380 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2382 =head2 $c->setup_actions($component)
2384 Sets up actions for a component.
2388 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2390 =head2 $c->setup_components
2392 This method is called internally to set up the application's components.
2394 It finds modules by calling the L<locate_components> method, expands them to
2395 package names with the L<expand_component_module> method, and then installs
2396 each component into the application.
2398 The C<setup_components> config option is passed to both of the above methods.
2400 Installation of each component is performed by the L<setup_component> method,
2405 sub setup_components {
2408 my $config = $class->config->{ setup_components };
2410 my @comps = $class->locate_components($config);
2411 my %comps = map { $_ => 1 } @comps;
2413 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2414 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2415 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2416 ) if $deprecatedcatalyst_component_names;
2418 for my $component ( @comps ) {
2420 # We pass ignore_loaded here so that overlay files for (e.g.)
2421 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2422 # we know M::P::O found a file on disk so this is safe
2424 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2427 for my $component (@comps) {
2428 my $instance = $class->components->{ $component } = $class->setup_component($component);
2429 my @expanded_components = $instance->can('expand_modules')
2430 ? $instance->expand_modules( $component, $config )
2431 : $class->expand_component_module( $component, $config );
2432 for my $component (@expanded_components) {
2433 next if $comps{$component};
2434 $class->components->{ $component } = $class->setup_component($component);
2439 =head2 $c->locate_components( $setup_component_config )
2441 This method is meant to provide a list of component modules that should be
2442 setup for the application. By default, it will use L<Module::Pluggable>.
2444 Specify a C<setup_components> config option to pass additional options directly
2445 to L<Module::Pluggable>. To add additional search paths, specify a key named
2446 C<search_extra> as an array reference. Items in the array beginning with C<::>
2447 will have the application class name prepended to them.
2451 sub locate_components {
2455 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2456 my $extra = delete $config->{ search_extra } || [];
2458 push @paths, @$extra;
2460 my $locator = Module::Pluggable::Object->new(
2461 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2465 # XXX think about ditching this sort entirely
2466 my @comps = sort { length $a <=> length $b } $locator->plugins;
2471 =head2 $c->expand_component_module( $component, $setup_component_config )
2473 Components found by C<locate_components> will be passed to this method, which
2474 is expected to return a list of component (package) names to be set up.
2478 sub expand_component_module {
2479 my ($class, $module) = @_;
2480 return Devel::InnerPackage::list_packages( $module );
2483 =head2 $c->setup_component
2487 sub setup_component {
2488 my( $class, $component ) = @_;
2490 unless ( $component->can( 'COMPONENT' ) ) {
2494 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2495 my $config = $class->config->{ $suffix } || {};
2496 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2497 # methods also pass it. local to avoid pointlessly shitting in config
2498 # for the debug screen, as $component is already the key name.
2499 local $config->{catalyst_component_name} = $component;
2501 my $instance = eval { $component->COMPONENT( $class, $config ); };
2503 if ( my $error = $@ ) {
2505 Catalyst::Exception->throw(
2506 message => qq/Couldn't instantiate component "$component", "$error"/
2510 unless (blessed $instance) {
2511 my $metaclass = Moose::Util::find_meta($component);
2512 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2513 my $component_method_from = $method_meta->associated_metaclass->name;
2514 my $value = defined($instance) ? $instance : 'undef';
2515 Catalyst::Exception->throw(
2517 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2523 =head2 $c->setup_dispatcher
2529 sub setup_dispatcher {
2530 my ( $class, $dispatcher ) = @_;
2533 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2536 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2537 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2540 unless ($dispatcher) {
2541 $dispatcher = $class->dispatcher_class;
2544 Class::MOP::load_class($dispatcher);
2546 # dispatcher instance
2547 $class->dispatcher( $dispatcher->new );
2550 =head2 $c->setup_engine
2557 my ( $class, $engine ) = @_;
2560 $engine = 'Catalyst::Engine::' . $engine;
2563 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2564 $engine = 'Catalyst::Engine::' . $env;
2567 if ( $ENV{MOD_PERL} ) {
2568 my $meta = Class::MOP::get_metaclass_by_name($class);
2570 # create the apache method
2571 $meta->add_method('apache' => sub { shift->engine->apache });
2573 my ( $software, $version ) =
2574 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2577 $version =~ s/(\.[^.]+)\./$1/g;
2579 if ( $software eq 'mod_perl' ) {
2583 if ( $version >= 1.99922 ) {
2584 $engine = 'Catalyst::Engine::Apache2::MP20';
2587 elsif ( $version >= 1.9901 ) {
2588 $engine = 'Catalyst::Engine::Apache2::MP19';
2591 elsif ( $version >= 1.24 ) {
2592 $engine = 'Catalyst::Engine::Apache::MP13';
2596 Catalyst::Exception->throw( message =>
2597 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2602 # install the correct mod_perl handler
2603 if ( $version >= 1.9901 ) {
2604 *handler = sub : method {
2605 shift->handle_request(@_);
2609 *handler = sub ($$) { shift->handle_request(@_) };
2614 elsif ( $software eq 'Zeus-Perl' ) {
2615 $engine = 'Catalyst::Engine::Zeus';
2619 Catalyst::Exception->throw(
2620 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2625 $engine = $class->engine_class;
2628 Class::MOP::load_class($engine);
2630 # check for old engines that are no longer compatible
2632 if ( $engine->isa('Catalyst::Engine::Apache')
2633 && !Catalyst::Engine::Apache->VERSION )
2638 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2639 && Catalyst::Engine::Server->VERSION le '0.02' )
2644 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2645 && $engine->VERSION eq '0.01' )
2650 elsif ($engine->isa('Catalyst::Engine::Zeus')
2651 && $engine->VERSION eq '0.01' )
2657 Catalyst::Exception->throw( message =>
2658 qq/Engine "$engine" is not supported by this version of Catalyst/
2663 $class->engine( $engine->new );
2666 =head2 $c->setup_home
2668 Sets up the home directory.
2673 my ( $class, $home ) = @_;
2675 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2679 $home ||= Catalyst::Utils::home($class);
2682 #I remember recently being scolded for assigning config values like this
2683 $class->config->{home} ||= $home;
2684 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2688 =head2 $c->setup_log
2690 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2691 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2694 This method also installs a C<debug> method that returns a true value into the
2695 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2696 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2698 Note that if the log has already been setup, by either a previous call to
2699 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2700 that this method won't actually set up the log object.
2705 my ( $class, $levels ) = @_;
2708 $levels =~ s/^\s+//;
2709 $levels =~ s/\s+$//;
2710 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2712 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2713 if ( defined $env_debug ) {
2714 $levels{debug} = 1 if $env_debug; # Ugly!
2715 delete($levels{debug}) unless $env_debug;
2718 unless ( $class->log ) {
2719 $class->log( Catalyst::Log->new(keys %levels) );
2722 if ( $levels{debug} ) {
2723 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2724 $class->log->debug('Debug messages enabled');
2728 =head2 $c->setup_plugins
2734 =head2 $c->setup_stats
2736 Sets up timing statistics class.
2741 my ( $class, $stats ) = @_;
2743 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2745 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2746 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2747 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2748 $class->log->debug('Statistics enabled');
2753 =head2 $c->registered_plugins
2755 Returns a sorted list of the plugins which have either been stated in the
2756 import list or which have been added via C<< MyApp->plugin(@args); >>.
2758 If passed a given plugin name, it will report a boolean value indicating
2759 whether or not that plugin is loaded. A fully qualified name is required if
2760 the plugin name does not begin with C<Catalyst::Plugin::>.
2762 if ($c->registered_plugins('Some::Plugin')) {
2770 sub registered_plugins {
2772 return sort keys %{ $proto->_plugins } unless @_;
2774 return 1 if exists $proto->_plugins->{$plugin};
2775 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2778 sub _register_plugin {
2779 my ( $proto, $plugin, $instant ) = @_;
2780 my $class = ref $proto || $proto;
2782 Class::MOP::load_class( $plugin );
2783 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2784 if $plugin->isa( 'Catalyst::Component' );
2785 $proto->_plugins->{$plugin} = 1;
2787 my $meta = Class::MOP::get_metaclass_by_name($class);
2788 $meta->superclasses($plugin, $meta->superclasses);
2794 my ( $class, $plugins ) = @_;
2796 $class->_plugins( {} ) unless $class->_plugins;
2797 $plugins = Data::OptList::mkopt($plugins || []);
2800 [ Catalyst::Utils::resolve_namespace(
2801 $class . '::Plugin',
2802 'Catalyst::Plugin', $_->[0]
2808 for my $plugin ( reverse @plugins ) {
2809 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2810 my $meta = find_meta($plugin->[0]);
2811 next if $meta && $meta->isa('Moose::Meta::Role');
2813 $class->_register_plugin($plugin->[0]);
2817 map { $_->[0]->name, $_->[1] }
2818 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2819 map { [find_meta($_->[0]), $_->[1]] }
2822 Moose::Util::apply_all_roles(
2830 Returns an arrayref of the internal execution stack (actions that are
2831 currently executing).
2835 Returns the current timing statistics object. By default Catalyst uses
2836 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2837 L<< stats_class|/"$c->stats_class" >>.
2839 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2840 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2841 profile explicitly, although MyApp.pm still won't profile nor output anything
2844 =head2 $c->stats_class
2846 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2848 =head2 $c->use_stats
2850 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2852 Note that this is a static method, not an accessor and should be overridden
2853 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2860 =head2 $c->write( $data )
2862 Writes $data to the output stream. When using this method directly, you
2863 will need to manually set the C<Content-Length> header to the length of
2864 your output data, if known.
2871 # Finalize headers if someone manually writes output
2872 $c->finalize_headers;
2874 return $c->engine->write( $c, @_ );
2879 Returns the Catalyst version number. Mostly useful for "powered by"
2880 messages in template systems.
2884 sub version { return $Catalyst::VERSION }
2886 =head1 CONFIGURATION
2888 There are a number of 'base' config variables which can be set:
2894 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2898 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2902 C<disable_component_resolution_regex_fallback> - Turns
2903 off the deprecated component resolution functionality so
2904 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2905 are called then regex search will not be attempted on string values and
2906 instead C<undef> will be returned.
2910 C<home> - The application home directory. In an uninstalled application,
2911 this is the top level application directory. In an installed application,
2912 this will be the directory containing C<< MyApp.pm >>.
2916 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2920 C<name> - The name of the application in debug messages and the debug and
2925 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2926 until it is accessed. This allows you to (for example) check authentication (and reject
2927 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2931 C<root> - The root directory for templates. Usually this is just a
2932 subdirectory of the home directory, but you can set it to change the
2933 templates to a different directory.
2937 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2938 namespaces from which components will be loaded (and constructed and stored in
2939 C<< $c->components >>).
2943 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2944 to be shown in hit debug tables in the test server.
2948 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2949 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2950 for more information.
2954 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2958 =head1 INTERNAL ACTIONS
2960 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2961 C<_ACTION>, and C<_END>. These are by default not shown in the private
2962 action table, but you can make them visible with a config parameter.
2964 MyApp->config(show_internal_actions => 1);
2966 =head1 ON-DEMAND PARSER
2968 The request body is usually parsed at the beginning of a request,
2969 but if you want to handle input yourself, you can enable on-demand
2970 parsing with a config parameter.
2972 MyApp->config(parse_on_demand => 1);
2974 =head1 PROXY SUPPORT
2976 Many production servers operate using the common double-server approach,
2977 with a lightweight frontend web server passing requests to a larger
2978 backend server. An application running on the backend server must deal
2979 with two problems: the remote user always appears to be C<127.0.0.1> and
2980 the server's hostname will appear to be C<localhost> regardless of the
2981 virtual host that the user connected through.
2983 Catalyst will automatically detect this situation when you are running
2984 the frontend and backend servers on the same machine. The following
2985 changes are made to the request.
2987 $c->req->address is set to the user's real IP address, as read from
2988 the HTTP X-Forwarded-For header.
2990 The host value for $c->req->base and $c->req->uri is set to the real
2991 host, as read from the HTTP X-Forwarded-Host header.
2993 Additionally, you may be running your backend application on an insecure
2994 connection (port 80) while your frontend proxy is running under SSL. If there
2995 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2996 tell Catalyst what port the frontend listens on. This will allow all URIs to
2997 be created properly.
2999 In the case of passing in:
3001 X-Forwarded-Port: 443
3003 All calls to C<uri_for> will result in an https link, as is expected.
3005 Obviously, your web server must support these headers for this to work.
3007 In a more complex server farm environment where you may have your
3008 frontend proxy server(s) on different machines, you will need to set a
3009 configuration option to tell Catalyst to read the proxied data from the
3012 MyApp->config(using_frontend_proxy => 1);
3014 If you do not wish to use the proxy support at all, you may set:
3016 MyApp->config(ignore_frontend_proxy => 1);
3018 =head1 THREAD SAFETY
3020 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3021 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3022 believe the Catalyst core to be thread-safe.
3024 If you plan to operate in a threaded environment, remember that all other
3025 modules you are using must also be thread-safe. Some modules, most notably
3026 L<DBD::SQLite>, are not thread-safe.
3032 Join #catalyst on irc.perl.org.
3036 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3037 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3041 http://catalyst.perl.org
3045 http://dev.catalyst.perl.org
3049 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3051 =head2 L<Catalyst::Manual> - The Catalyst Manual
3053 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3055 =head2 L<Catalyst::Engine> - Core engine
3057 =head2 L<Catalyst::Log> - Log class.
3059 =head2 L<Catalyst::Request> - Request object
3061 =head2 L<Catalyst::Response> - Response object
3063 =head2 L<Catalyst::Test> - The test suite.
3065 =head1 PROJECT FOUNDER
3067 sri: Sebastian Riedel <sri@cpan.org>
3073 acme: Leon Brocard <leon@astray.com>
3075 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3079 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3083 andyg: Andy Grundman <andy@hybridized.org>
3085 audreyt: Audrey Tang
3087 bricas: Brian Cassidy <bricas@cpan.org>
3089 Caelum: Rafael Kitover <rkitover@io.com>
3091 chansen: Christian Hansen
3093 chicks: Christopher Hicks
3095 Chisel Wright C<pause@herlpacker.co.uk>
3097 Danijel Milicevic C<me@danijel.de>
3099 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3101 David Naughton, C<naughton@umn.edu>
3105 dhoss: Devin Austin <dhoss@cpan.org>
3107 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3111 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3113 esskar: Sascha Kiefer
3115 fireartist: Carl Franks <cfranks@cpan.org>
3117 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3119 gabb: Danijel Milicevic
3123 Gavin Henry C<ghenry@perl.me.uk>
3127 groditi: Guillermo Roditi <groditi@gmail.com>
3129 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3131 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3133 jcamacho: Juan Camacho
3135 jester: Jesse Sheidlower C<jester@panix.com>
3137 jhannah: Jay Hannah <jay@jays.net>
3143 jon: Jon Schutz <jjschutz@cpan.org>
3145 Jonathan Rockway C<< <jrockway@cpan.org> >>
3147 Kieren Diment C<kd@totaldatasolution.com>
3149 konobi: Scott McWhirter <konobi@cpan.org>
3151 marcus: Marcus Ramberg <mramberg@cpan.org>
3153 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3155 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3159 naughton: David Naughton
3161 ningu: David Kamholz <dkamholz@cpan.org>
3163 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3165 numa: Dan Sully <daniel@cpan.org>
3171 omega: Andreas Marienborg
3173 Oleg Kostyuk <cub.uanic@gmail.com>
3175 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3177 rafl: Florian Ragwitz <rafl@debian.org>
3179 random: Roland Lammel <lammel@cpan.org>
3181 Robert Sedlacek C<< <rs@474.at> >>
3183 SpiceMan: Marcel Montes
3187 szbalint: Balint Szilakszi <szbalint@cpan.org>
3189 t0m: Tomas Doran <bobtfish@bobtfish.net>
3193 Viljo Marrandi C<vilts@yahoo.com>
3195 Will Hawes C<info@whawes.co.uk>
3197 willert: Sebastian Willert <willert@cpan.org>
3199 wreis: Wallace Reis <wallace@reis.org.br>
3201 Yuval Kogman, C<nothingmuch@woobling.org>
3203 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3207 This library is free software. You can redistribute it and/or modify it under
3208 the same terms as Perl itself.
3214 __PACKAGE__->meta->make_immutable;