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.80022';
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. You can also force this setting
285 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
286 environment settings override the application, with <MYAPP>_STATS having the
291 use Catalyst qw/-Stats=1/
295 =head2 INFORMATION ABOUT THE CURRENT REQUEST
299 Returns a L<Catalyst::Action> object for the current action, which
300 stringifies to the action name. See L<Catalyst::Action>.
304 Returns the namespace of the current action, i.e., the URI prefix
305 corresponding to the controller of the current action. For example:
307 # in Controller::Foo::Bar
308 $c->namespace; # returns 'foo/bar';
314 Returns the current L<Catalyst::Request> object, giving access to
315 information about the current client request (including parameters,
316 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
318 =head2 REQUEST FLOW HANDLING
320 =head2 $c->forward( $action [, \@arguments ] )
322 =head2 $c->forward( $class, $method, [, \@arguments ] )
324 Forwards processing to another action, by its private name. If you give a
325 class name but no method, C<process()> is called. You may also optionally
326 pass arguments in an arrayref. The action will receive the arguments in
327 C<@_> and C<< $c->req->args >>. Upon returning from the function,
328 C<< $c->req->args >> will be restored to the previous values.
330 Any data C<return>ed from the action forwarded to, will be returned by the
333 my $foodata = $c->forward('/foo');
334 $c->forward('index');
335 $c->forward(qw/Model::DBIC::Foo do_stuff/);
336 $c->forward('View::TT');
338 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
339 an C<< eval { } >> around the call (actually
340 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
341 all 'dies' within the called action. If you want C<die> to propagate you
342 need to do something like:
345 die join "\n", @{ $c->error } if @{ $c->error };
347 Or make sure to always return true values from your actions and write
350 $c->forward('foo') || return;
352 Another note is that C<< $c->forward >> always returns a scalar because it
353 actually returns $c->state which operates in a scalar context.
354 Thus, something like:
358 in an action that is forwarded to is going to return a scalar,
359 i.e. how many items are in that array, which is probably not what you want.
360 If you need to return an array then return a reference to it,
363 $c->stash->{array} = \@array;
365 and access it from the stash.
369 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
371 =head2 $c->detach( $action [, \@arguments ] )
373 =head2 $c->detach( $class, $method, [, \@arguments ] )
377 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
378 doesn't return to the previous action when processing is finished.
380 When called with no arguments it escapes the processing chain entirely.
384 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
386 =head2 $c->visit( $action [, \@captures, \@arguments ] )
388 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
390 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
391 but does a full dispatch, instead of just calling the new C<$action> /
392 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
393 you go to are called, just like a new request.
395 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
396 This means, for example, that C<< $c->action >> methods such as
397 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
398 L<reverse|Catalyst::Action/reverse> return information for the visited action
399 when they are invoked within the visited action. This is different from the
400 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
401 continues to use the $c->action object from the caller action even when
402 invoked from the callee.
404 C<< $c->stash >> is kept unchanged.
406 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
407 allows you to "wrap" another action, just as it would have been called by
408 dispatching from a URL, while the analogous
409 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
410 transfer control to another action as if it had been reached directly from a URL.
414 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
416 =head2 $c->go( $action [, \@captures, \@arguments ] )
418 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
420 The relationship between C<go> and
421 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
422 the relationship between
423 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
424 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
425 C<< $c->go >> will perform a full dispatch on the specified action or method,
426 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
427 C<go> escapes the processing of the current request chain on completion, and
428 does not return to its caller.
432 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
438 Returns the current L<Catalyst::Response> object, see there for details.
442 Returns a hashref to the stash, which may be used to store data and pass
443 it between components during a request. You can also set hash keys by
444 passing arguments. The stash is automatically sent to the view. The
445 stash is cleared at the end of a request; it cannot be used for
446 persistent storage (for this you must use a session; see
447 L<Catalyst::Plugin::Session> for a complete system integrated with
450 $c->stash->{foo} = $bar;
451 $c->stash( { moose => 'majestic', qux => 0 } );
452 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
454 # stash is automatically passed to the view for use in a template
455 $c->forward( 'MyApp::View::TT' );
459 around stash => sub {
462 my $stash = $orig->($c);
464 my $new_stash = @_ > 1 ? {@_} : $_[0];
465 croak('stash takes a hash or hashref') unless ref $new_stash;
466 foreach my $key ( keys %$new_stash ) {
467 $stash->{$key} = $new_stash->{$key};
477 =head2 $c->error($error, ...)
479 =head2 $c->error($arrayref)
481 Returns an arrayref containing error messages. If Catalyst encounters an
482 error while processing a request, it stores the error in $c->error. This
483 method should only be used to store fatal error messages.
485 my @error = @{ $c->error };
489 $c->error('Something bad happened');
496 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
497 croak @$error unless ref $c;
498 push @{ $c->{error} }, @$error;
500 elsif ( defined $_[0] ) { $c->{error} = undef }
501 return $c->{error} || [];
507 Contains the return value of the last executed action.
508 Note that << $c->state >> operates in a scalar context which means that all
509 values it returns are scalar.
511 =head2 $c->clear_errors
513 Clear errors. You probably don't want to clear the errors unless you are
514 implementing a custom error screen.
516 This is equivalent to running
527 sub _comp_search_prefixes {
529 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
532 # search components given a name and some prefixes
533 sub _comp_names_search_prefixes {
534 my ( $c, $name, @prefixes ) = @_;
535 my $appclass = ref $c || $c;
536 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
537 $filter = qr/$filter/; # Compile regex now rather than once per loop
539 # map the original component name to the sub part that we will search against
540 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
541 grep { /$filter/ } keys %{ $c->components };
543 # undef for a name will return all
544 return keys %eligible if !defined $name;
546 my $query = ref $name ? $name : qr/^$name$/i;
547 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
549 return @result if @result;
551 # if we were given a regexp to search against, we're done.
554 # skip regexp fallback if configured
556 if $appclass->config->{disable_component_resolution_regex_fallback};
560 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
562 # no results? try against full names
564 @result = grep { m{$query} } keys %eligible;
567 # don't warn if we didn't find any results, it just might not exist
569 # Disgusting hack to work out correct method name
570 my $warn_for = lc $prefixes[0];
571 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
572 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
573 "component resolution is unreliable and unsafe.";
574 my $short = $result[0];
575 # remove the component namespace prefix
576 $short =~ s/.*?(Model|Controller|View):://;
577 my $shortmess = Carp::shortmess('');
578 if ($shortmess =~ m#Catalyst/Plugin#) {
579 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
581 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
582 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
583 "component's config";
585 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
586 "but if you really wanted to search, pass in a regexp as the argument " .
587 "like so: \$c->${warn_for}(qr/${name}/)";
589 $c->log->warn( "${msg}$shortmess" );
595 # Find possible names for a prefix
597 my ( $c, @prefixes ) = @_;
598 my $appclass = ref $c || $c;
600 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
602 my @names = map { s{$filter}{}; $_; }
603 $c->_comp_names_search_prefixes( undef, @prefixes );
608 # Filter a component before returning by calling ACCEPT_CONTEXT if available
609 sub _filter_component {
610 my ( $c, $comp, @args ) = @_;
612 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
613 return $comp->ACCEPT_CONTEXT( $c, @args );
619 =head2 COMPONENT ACCESSORS
621 =head2 $c->controller($name)
623 Gets a L<Catalyst::Controller> instance by name.
625 $c->controller('Foo')->do_stuff;
627 If the name is omitted, will return the controller for the dispatched
630 If you want to search for controllers, pass in a regexp as the argument.
632 # find all controllers that start with Foo
633 my @foo_controllers = $c->controller(qr{^Foo});
639 my ( $c, $name, @args ) = @_;
641 my $appclass = ref($c) || $c;
643 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
644 my $comps = $c->components;
645 my $check = $appclass."::Controller::".$name;
646 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
648 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
649 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
650 return $c->_filter_component( $result[ 0 ], @args );
653 return $c->component( $c->action->class );
656 =head2 $c->model($name)
658 Gets a L<Catalyst::Model> instance by name.
660 $c->model('Foo')->do_stuff;
662 Any extra arguments are directly passed to ACCEPT_CONTEXT.
664 If the name is omitted, it will look for
665 - a model object in $c->stash->{current_model_instance}, then
666 - a model name in $c->stash->{current_model}, then
667 - a config setting 'default_model', or
668 - check if there is only one model, and return it if that's the case.
670 If you want to search for models, pass in a regexp as the argument.
672 # find all models that start with Foo
673 my @foo_models = $c->model(qr{^Foo});
678 my ( $c, $name, @args ) = @_;
679 my $appclass = ref($c) || $c;
681 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
682 my $comps = $c->components;
683 my $check = $appclass."::Model::".$name;
684 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
686 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
687 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
688 return $c->_filter_component( $result[ 0 ], @args );
692 return $c->stash->{current_model_instance}
693 if $c->stash->{current_model_instance};
694 return $c->model( $c->stash->{current_model} )
695 if $c->stash->{current_model};
697 return $c->model( $appclass->config->{default_model} )
698 if $appclass->config->{default_model};
700 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
703 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
704 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
705 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
706 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
707 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
710 return $c->_filter_component( $comp );
714 =head2 $c->view($name)
716 Gets a L<Catalyst::View> instance by name.
718 $c->view('Foo')->do_stuff;
720 Any extra arguments are directly passed to ACCEPT_CONTEXT.
722 If the name is omitted, it will look for
723 - a view object in $c->stash->{current_view_instance}, then
724 - a view name in $c->stash->{current_view}, then
725 - a config setting 'default_view', or
726 - check if there is only one view, and return it if that's the case.
728 If you want to search for views, pass in a regexp as the argument.
730 # find all views that start with Foo
731 my @foo_views = $c->view(qr{^Foo});
736 my ( $c, $name, @args ) = @_;
738 my $appclass = ref($c) || $c;
740 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
741 my $comps = $c->components;
742 my $check = $appclass."::View::".$name;
743 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
745 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
746 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
747 return $c->_filter_component( $result[ 0 ], @args );
751 return $c->stash->{current_view_instance}
752 if $c->stash->{current_view_instance};
753 return $c->view( $c->stash->{current_view} )
754 if $c->stash->{current_view};
756 return $c->view( $appclass->config->{default_view} )
757 if $appclass->config->{default_view};
759 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
762 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
763 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
764 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
765 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
766 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
769 return $c->_filter_component( $comp );
772 =head2 $c->controllers
774 Returns the available names which can be passed to $c->controller
780 return $c->_comp_names(qw/Controller C/);
785 Returns the available names which can be passed to $c->model
791 return $c->_comp_names(qw/Model M/);
797 Returns the available names which can be passed to $c->view
803 return $c->_comp_names(qw/View V/);
806 =head2 $c->comp($name)
808 =head2 $c->component($name)
810 Gets a component object by name. This method is not recommended,
811 unless you want to get a specific component by full
812 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
813 should be used instead.
815 If C<$name> is a regexp, a list of components matched against the full
816 component name will be returned.
818 If Catalyst can't find a component by name, it will fallback to regex
819 matching by default. To disable this behaviour set
820 disable_component_resolution_regex_fallback to a true value.
822 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
827 my ( $c, $name, @args ) = @_;
830 my $comps = $c->components;
833 # is it the exact name?
834 return $c->_filter_component( $comps->{ $name }, @args )
835 if exists $comps->{ $name };
837 # perhaps we just omitted "MyApp"?
838 my $composed = ( ref $c || $c ) . "::${name}";
839 return $c->_filter_component( $comps->{ $composed }, @args )
840 if exists $comps->{ $composed };
842 # search all of the models, views and controllers
843 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
844 return $c->_filter_component( $comp, @args ) if $comp;
847 # This is here so $c->comp( '::M::' ) works
848 my $query = ref $name ? $name : qr{$name}i;
850 my @result = grep { m{$query} } keys %{ $c->components };
851 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
854 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
855 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
856 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
857 return $c->_filter_component( $result[ 0 ], @args );
860 # I would expect to return an empty list here, but that breaks back-compat
864 return sort keys %{ $c->components };
867 =head2 CLASS DATA AND HELPER CLASSES
871 Returns or takes a hashref containing the application's configuration.
873 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
875 You can also use a C<YAML>, C<XML> or L<Config::General> config file
876 like C<myapp.conf> in your applications home directory. See
877 L<Catalyst::Plugin::ConfigLoader>.
879 =head3 Cascading configuration
881 The config method is present on all Catalyst components, and configuration
882 will be merged when an application is started. Configuration loaded with
883 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
884 followed by configuration in your top level C<MyApp> class. These two
885 configurations are merged, and then configuration data whose hash key matches a
886 component name is merged with configuration for that component.
888 The configuration for a component is then passed to the C<new> method when a
889 component is constructed.
893 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
894 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
896 will mean that C<MyApp::Model::Foo> receives the following data when
899 MyApp::Model::Foo->new({
907 around config => sub {
911 croak('Setting config after setup has been run is not allowed.')
912 if ( @_ and $c->setup_finished );
919 Returns the logging object instance. Unless it is already set, Catalyst
920 sets this up with a L<Catalyst::Log> object. To use your own log class,
921 set the logger with the C<< __PACKAGE__->log >> method prior to calling
922 C<< __PACKAGE__->setup >>.
924 __PACKAGE__->log( MyLogger->new );
929 $c->log->info( 'Now logging with my own logger!' );
931 Your log class should implement the methods described in
937 Returns 1 if debug mode is enabled, 0 otherwise.
939 You can enable debug mode in several ways:
943 =item By calling myapp_server.pl with the -d flag
945 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
947 =item The -Debug option in your MyApp.pm
949 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
953 The first three also set the log level to 'debug'.
955 Calling C<< $c->debug(1) >> has no effect.
961 =head2 $c->dispatcher
963 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
967 Returns the engine instance. See L<Catalyst::Engine>.
970 =head2 UTILITY METHODS
972 =head2 $c->path_to(@path)
974 Merges C<@path> with C<< $c->config->{home} >> and returns a
975 L<Path::Class::Dir> object. Note you can usually use this object as
976 a filename, but sometimes you will have to explicitly stringify it
977 yourself by calling the C<< ->stringify >> method.
981 $c->path_to( 'db', 'sqlite.db' );
986 my ( $c, @path ) = @_;
987 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
988 if ( -d $path ) { return $path }
989 else { return Path::Class::File->new( $c->config->{home}, @path ) }
992 =head2 $c->plugin( $name, $class, @args )
994 Helper method for plugins. It creates a class data accessor/mutator and
995 loads and instantiates the given class.
997 MyApp->plugin( 'prototype', 'HTML::Prototype' );
999 $c->prototype->define_javascript_functions;
1001 B<Note:> This method of adding plugins is deprecated. The ability
1002 to add plugins like this B<will be removed> in a Catalyst 5.81.
1003 Please do not use this functionality in new code.
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 Catalyst 5.81/);
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/ );
1043 my ( $class, @arguments ) = @_;
1044 croak('Running setup more than once')
1045 if ( $class->setup_finished );
1047 unless ( $class->isa('Catalyst') ) {
1049 Catalyst::Exception->throw(
1050 message => qq/'$class' does not inherit from Catalyst/ );
1053 if ( $class->arguments ) {
1054 @arguments = ( @arguments, @{ $class->arguments } );
1060 foreach (@arguments) {
1064 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1066 elsif (/^-(\w+)=?(.*)$/) {
1067 $flags->{ lc $1 } = $2;
1070 push @{ $flags->{plugins} }, $_;
1074 $class->setup_home( delete $flags->{home} );
1076 $class->setup_log( delete $flags->{log} );
1077 $class->setup_plugins( delete $flags->{plugins} );
1078 $class->setup_dispatcher( delete $flags->{dispatcher} );
1079 $class->setup_engine( delete $flags->{engine} );
1080 $class->setup_stats( delete $flags->{stats} );
1082 for my $flag ( sort keys %{$flags} ) {
1084 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1085 &$code( $class, delete $flags->{$flag} );
1088 $class->log->warn(qq/Unknown flag "$flag"/);
1092 eval { require Catalyst::Devel; };
1093 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1094 $class->log->warn(<<"EOF");
1095 You are running an old script!
1097 Please update by running (this will overwrite existing files):
1098 catalyst.pl -force -scripts $class
1100 or (this will not overwrite existing files):
1101 catalyst.pl -scripts $class
1106 if ( $class->debug ) {
1107 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1110 my $column_width = Catalyst::Utils::term_width() - 6;
1111 my $t = Text::SimpleTable->new($column_width);
1112 $t->row($_) for @plugins;
1113 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1116 my $dispatcher = $class->dispatcher;
1117 my $engine = $class->engine;
1118 my $home = $class->config->{home};
1120 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1121 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1125 ? $class->log->debug(qq/Found home "$home"/)
1126 : $class->log->debug(qq/Home "$home" doesn't exist/)
1127 : $class->log->debug(q/Couldn't find home/);
1130 # Call plugins setup, this is stupid and evil.
1131 # Also screws C3 badly on 5.10, hack to avoid.
1133 no warnings qw/redefine/;
1134 local *setup = sub { };
1135 $class->setup unless $Catalyst::__AM_RESTARTING;
1138 # Initialize our data structure
1139 $class->components( {} );
1141 $class->setup_components;
1143 if ( $class->debug ) {
1144 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1145 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1146 for my $comp ( sort keys %{ $class->components } ) {
1147 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1148 $t->row( $comp, $type );
1150 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1151 if ( keys %{ $class->components } );
1154 # Add our self to components, since we are also a component
1155 if( $class->isa('Catalyst::Controller') ){
1156 $class->components->{$class} = $class;
1159 $class->setup_actions;
1161 if ( $class->debug ) {
1162 my $name = $class->config->{name} || 'Application';
1163 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1166 # Make sure that the application class becomes immutable at this point,
1167 B::Hooks::EndOfScope::on_scope_end {
1169 my $meta = Class::MOP::get_metaclass_by_name($class);
1172 && ! { $meta->immutable_options }->{replace_constructor}
1174 $class->isa('Class::Accessor::Fast')
1175 || $class->isa('Class::Accessor')
1178 warn "You made your application class ($class) immutable, "
1179 . "but did not inline the\nconstructor. "
1180 . "This will break catalyst, as your app \@ISA "
1181 . "Class::Accessor(::Fast)?\nPlease pass "
1182 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1184 $meta->make_immutable(
1185 replace_constructor => 1,
1186 ) unless $meta->is_immutable;
1189 if ($class->config->{case_sensitive}) {
1190 $class->log->warn($class . "->config->{case_sensitive} is set.");
1191 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1194 $class->setup_finalize;
1195 # Should be the last thing we do so that user things hooking
1196 # setup_finalize can log..
1197 $class->log->_flush() if $class->log->can('_flush');
1198 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1201 =head2 $app->setup_finalize
1203 A hook to attach modifiers to. This method does not do anything except set the
1204 C<setup_finished> accessor.
1206 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1210 after setup_finalize => sub {
1218 sub setup_finalize {
1220 $class->setup_finished(1);
1223 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1225 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1227 Constructs an absolute L<URI> object based on the application root, the
1228 provided path, and the additional arguments and query parameters provided.
1229 When used as a string, provides a textual URI.
1231 If no arguments are provided, the URI for the current action is returned.
1232 To return the current action and also provide @args, use
1233 C<< $c->uri_for( $c->action, @args ) >>.
1235 If the first argument is a string, it is taken as a public URI path relative
1236 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1237 relative to the application root (if it does). It is then merged with
1238 C<< $c->request->base >>; any C<@args> are appended as additional path
1239 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1241 If the first argument is a L<Catalyst::Action> it represents an action which
1242 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1243 optional C<\@captures> argument (an arrayref) allows passing the captured
1244 variables that are needed to fill in the paths of Chained and Regex actions;
1245 once the path is resolved, C<uri_for> continues as though a path was
1246 provided, appending any arguments or parameters and creating an absolute
1249 The captures for the current request can be found in
1250 C<< $c->request->captures >>, and actions can be resolved using
1251 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1252 path, use C<< $c->uri_for_action >> instead.
1254 # Equivalent to $c->req->uri
1255 $c->uri_for($c->action, $c->req->captures,
1256 @{ $c->req->args }, $c->req->params);
1258 # For the Foo action in the Bar controller
1259 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1261 # Path to a static resource
1262 $c->uri_for('/static/images/logo.png');
1267 my ( $c, $path, @args ) = @_;
1269 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1270 $path = $path->path_prefix;
1275 undef($path) if (defined $path && $path eq '');
1278 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1280 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1281 foreach my $arg (@args) {
1282 utf8::encode($arg) if utf8::is_utf8($arg);
1283 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1286 if ( blessed($path) ) { # action object
1287 s|/|%2F|g for @args;
1288 my $captures = [ map { s|/|%2F|g; $_; }
1289 ( scalar @args && ref $args[0] eq 'ARRAY'
1293 foreach my $capture (@$captures) {
1294 utf8::encode($capture) if utf8::is_utf8($capture);
1295 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1299 $path = $c->dispatcher->uri_for_action($action, $captures);
1300 if (not defined $path) {
1301 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1305 $path = '/' if $path eq '';
1308 unshift(@args, $path);
1310 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1311 my $namespace = $c->namespace;
1312 if (defined $path) { # cheesy hack to handle path '../foo'
1313 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1315 unshift(@args, $namespace || '');
1318 # join args with '/', or a blank string
1319 my $args = join('/', grep { defined($_) } @args);
1320 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1322 my $base = $c->req->base;
1323 my $class = ref($base);
1324 $base =~ s{(?<!/)$}{/};
1328 if (my @keys = keys %$params) {
1329 # somewhat lifted from URI::_query's query_form
1330 $query = '?'.join('&', map {
1331 my $val = $params->{$_};
1332 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1335 $val = '' unless defined $val;
1338 utf8::encode( $param ) if utf8::is_utf8($param);
1339 # using the URI::Escape pattern here so utf8 chars survive
1340 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1342 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1346 my $res = bless(\"${base}${args}${query}", $class);
1350 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1352 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1358 A private path to the Catalyst action you want to create a URI for.
1360 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1361 >> and passing the resulting C<$action> and the remaining arguments to C<<
1364 You can also pass in a Catalyst::Action object, in which case it is passed to
1367 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.
1369 For example, if the action looks like:
1371 package MyApp::Controller::Users;
1373 sub lst : Path('the-list') {}
1377 $c->uri_for_action('/users/lst')
1379 and it will create the URI /users/the-list.
1385 sub uri_for_action {
1386 my ( $c, $path, @args ) = @_;
1387 my $action = blessed($path)
1389 : $c->dispatcher->get_action_by_path($path);
1390 unless (defined $action) {
1391 croak "Can't find action for path '$path'";
1393 return $c->uri_for( $action, @args );
1396 =head2 $c->welcome_message
1398 Returns the Catalyst welcome HTML page.
1402 sub welcome_message {
1404 my $name = $c->config->{name};
1405 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1406 my $prefix = Catalyst::Utils::appprefix( ref $c );
1407 $c->response->content_type('text/html; charset=utf-8');
1409 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1410 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1411 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1413 <meta http-equiv="Content-Language" content="en" />
1414 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1415 <title>$name on Catalyst $VERSION</title>
1416 <style type="text/css">
1419 background-color: #eee;
1426 margin-bottom: 10px;
1428 background-color: #ccc;
1429 border: 1px solid #aaa;
1434 font-family: verdana, tahoma, sans-serif;
1437 font-family: verdana, tahoma, sans-serif;
1440 text-decoration: none;
1442 border-bottom: 1px dotted #bbb;
1444 :link:hover, :visited:hover {
1457 background-color: #fff;
1458 border: 1px solid #aaa;
1462 font-weight: normal;
1484 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1489 <img src="$logo" alt="Catalyst Logo" />
1491 <p>Welcome to the world of Catalyst.
1492 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1493 framework will make web development something you had
1494 never expected it to be: Fun, rewarding, and quick.</p>
1495 <h2>What to do now?</h2>
1496 <p>That really depends on what <b>you</b> want to do.
1497 We do, however, provide you with a few starting points.</p>
1498 <p>If you want to jump right into web development with Catalyst
1499 you might want to start with a tutorial.</p>
1500 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1502 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1504 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1505 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1507 <h2>What to do next?</h2>
1508 <p>Next it's time to write an actual application. Use the
1509 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1510 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1511 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1512 they can save you a lot of work.</p>
1513 <pre><code>script/${prefix}_create.pl --help</code></pre>
1514 <p>Also, be sure to check out the vast and growing
1515 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1516 you are likely to find what you need there.
1520 <p>Catalyst has a very active community. Here are the main places to
1521 get in touch with us.</p>
1524 <a href="http://dev.catalyst.perl.org">Wiki</a>
1527 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1530 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1533 <h2>In conclusion</h2>
1534 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1535 as we enjoyed making it. Please contact us if you have ideas
1536 for improvement or other feedback.</p>
1544 =head1 INTERNAL METHODS
1546 These methods are not meant to be used by end users.
1548 =head2 $c->components
1550 Returns a hash of components.
1552 =head2 $c->context_class
1554 Returns or sets the context class.
1558 Returns a hashref containing coderefs and execution counts (needed for
1559 deep recursion detection).
1563 Returns the number of actions on the current internal execution stack.
1567 Dispatches a request to actions.
1571 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1573 =head2 $c->dispatcher_class
1575 Returns or sets the dispatcher class.
1577 =head2 $c->dump_these
1579 Returns a list of 2-element array references (name, structure) pairs
1580 that will be dumped on the error page in debug mode.
1586 [ Request => $c->req ],
1587 [ Response => $c->res ],
1588 [ Stash => $c->stash ],
1589 [ Config => $c->config ];
1592 =head2 $c->engine_class
1594 Returns or sets the engine class.
1596 =head2 $c->execute( $class, $coderef )
1598 Execute a coderef in given class and catch exceptions. Errors are available
1604 my ( $c, $class, $code ) = @_;
1605 $class = $c->component($class) || $class;
1608 if ( $c->depth >= $RECURSION ) {
1609 my $action = $code->reverse();
1610 $action = "/$action" unless $action =~ /->/;
1611 my $error = qq/Deep recursion detected calling "${action}"/;
1612 $c->log->error($error);
1618 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1620 push( @{ $c->stack }, $code );
1622 no warnings 'recursion';
1623 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1625 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1627 my $last = pop( @{ $c->stack } );
1629 if ( my $error = $@ ) {
1630 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1631 $error->rethrow if $c->depth > 1;
1633 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1634 $error->rethrow if $c->depth > 0;
1637 unless ( ref $error ) {
1638 no warnings 'uninitialized';
1640 my $class = $last->class;
1641 my $name = $last->name;
1642 $error = qq/Caught exception in $class->$name "$error"/;
1651 sub _stats_start_execute {
1652 my ( $c, $code ) = @_;
1653 my $appclass = ref($c) || $c;
1654 return if ( ( $code->name =~ /^_.*/ )
1655 && ( !$appclass->config->{show_internal_actions} ) );
1657 my $action_name = $code->reverse();
1658 $c->counter->{$action_name}++;
1660 my $action = $action_name;
1661 $action = "/$action" unless $action =~ /->/;
1663 # determine if the call was the result of a forward
1664 # this is done by walking up the call stack and looking for a calling
1665 # sub of Catalyst::forward before the eval
1667 for my $index ( 2 .. 11 ) {
1669 if ( ( caller($index) )[0] eq 'Catalyst'
1670 && ( caller($index) )[3] eq '(eval)' );
1672 if ( ( caller($index) )[3] =~ /forward$/ ) {
1673 $callsub = ( caller($index) )[3];
1674 $action = "-> $action";
1679 my $uid = $action_name . $c->counter->{$action_name};
1681 # is this a root-level call or a forwarded call?
1682 if ( $callsub =~ /forward$/ ) {
1683 my $parent = $c->stack->[-1];
1685 # forward, locate the caller
1686 if ( exists $c->counter->{"$parent"} ) {
1689 parent => "$parent" . $c->counter->{"$parent"},
1695 # forward with no caller may come from a plugin
1714 sub _stats_finish_execute {
1715 my ( $c, $info ) = @_;
1716 $c->stats->profile( end => $info );
1721 Finalizes the request.
1728 for my $error ( @{ $c->error } ) {
1729 $c->log->error($error);
1732 # Allow engine to handle finalize flow (for POE)
1733 my $engine = $c->engine;
1734 if ( my $code = $engine->can('finalize') ) {
1739 $c->finalize_uploads;
1742 if ( $#{ $c->error } >= 0 ) {
1746 $c->finalize_headers;
1749 if ( $c->request->method eq 'HEAD' ) {
1750 $c->response->body('');
1758 if ($c->use_stats) {
1759 my $elapsed = sprintf '%f', $c->stats->elapsed;
1760 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1762 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1765 return $c->response->status;
1768 =head2 $c->finalize_body
1774 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1776 =head2 $c->finalize_cookies
1782 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1784 =head2 $c->finalize_error
1790 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1792 =head2 $c->finalize_headers
1798 sub finalize_headers {
1801 my $response = $c->response; #accessor calls can add up?
1803 # Check if we already finalized headers
1804 return if $response->finalized_headers;
1807 if ( my $location = $response->redirect ) {
1808 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1809 $response->header( Location => $location );
1811 if ( !$response->has_body ) {
1812 # Add a default body if none is already present
1814 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1820 if ( $response->body && !$response->content_length ) {
1822 # get the length from a filehandle
1823 if ( blessed( $response->body ) && $response->body->can('read') )
1825 my $stat = stat $response->body;
1826 if ( $stat && $stat->size > 0 ) {
1827 $response->content_length( $stat->size );
1830 $c->log->warn('Serving filehandle without a content-length');
1834 # everything should be bytes at this point, but just in case
1835 $response->content_length( length( $response->body ) );
1840 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1841 $response->headers->remove_header("Content-Length");
1842 $response->body('');
1845 $c->finalize_cookies;
1847 $c->engine->finalize_headers( $c, @_ );
1850 $response->finalized_headers(1);
1853 =head2 $c->finalize_output
1855 An alias for finalize_body.
1857 =head2 $c->finalize_read
1859 Finalizes the input after reading is complete.
1863 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1865 =head2 $c->finalize_uploads
1867 Finalizes uploads. Cleans up any temporary files.
1871 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1873 =head2 $c->get_action( $action, $namespace )
1875 Gets an action in a given namespace.
1879 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1881 =head2 $c->get_actions( $action, $namespace )
1883 Gets all actions of a given name in a namespace and all parent
1888 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1890 =head2 $app->handle_request( @arguments )
1892 Called to handle each HTTP request.
1896 sub handle_request {
1897 my ( $class, @arguments ) = @_;
1899 # Always expect worst case!
1902 if ($class->debug) {
1903 my $secs = time - $START || 1;
1904 my $av = sprintf '%.3f', $COUNT / $secs;
1905 my $time = localtime time;
1906 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1909 my $c = $class->prepare(@arguments);
1911 $status = $c->finalize;
1914 if ( my $error = $@ ) {
1916 $class->log->error(qq/Caught exception in engine "$error"/);
1921 if(my $coderef = $class->log->can('_flush')){
1922 $class->log->$coderef();
1927 =head2 $c->prepare( @arguments )
1929 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1935 my ( $class, @arguments ) = @_;
1938 # After the app/ctxt split, this should become an attribute based on something passed
1939 # into the application.
1940 $class->context_class( ref $class || $class ) unless $class->context_class;
1942 my $c = $class->context_class->new({});
1944 # For on-demand data
1945 $c->request->_context($c);
1946 $c->response->_context($c);
1948 #surely this is not the most efficient way to do things...
1949 $c->stats($class->stats_class->new)->enable($c->use_stats);
1950 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1951 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1954 #XXX reuse coderef from can
1955 # Allow engine to direct the prepare flow (for POE)
1956 if ( $c->engine->can('prepare') ) {
1957 $c->engine->prepare( $c, @arguments );
1960 $c->prepare_request(@arguments);
1961 $c->prepare_connection;
1962 $c->prepare_query_parameters;
1963 $c->prepare_headers;
1964 $c->prepare_cookies;
1967 # Prepare the body for reading, either by prepare_body
1968 # or the user, if they are using $c->read
1971 # Parse the body unless the user wants it on-demand
1972 unless ( ref($c)->config->{parse_on_demand} ) {
1977 my $method = $c->req->method || '';
1978 my $path = $c->req->path;
1979 $path = '/' unless length $path;
1980 my $address = $c->req->address || '';
1989 =head2 $c->prepare_action
1991 Prepares action. See L<Catalyst::Dispatcher>.
1995 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1997 =head2 $c->prepare_body
1999 Prepares message body.
2006 return if $c->request->_has_body;
2008 # Initialize on-demand data
2009 $c->engine->prepare_body( $c, @_ );
2010 $c->prepare_parameters;
2011 $c->prepare_uploads;
2014 =head2 $c->prepare_body_chunk( $chunk )
2016 Prepares a chunk of data before sending it to L<HTTP::Body>.
2018 See L<Catalyst::Engine>.
2022 sub prepare_body_chunk {
2024 $c->engine->prepare_body_chunk( $c, @_ );
2027 =head2 $c->prepare_body_parameters
2029 Prepares body parameters.
2033 sub prepare_body_parameters {
2035 $c->engine->prepare_body_parameters( $c, @_ );
2038 =head2 $c->prepare_connection
2040 Prepares connection.
2044 sub prepare_connection {
2046 $c->engine->prepare_connection( $c, @_ );
2049 =head2 $c->prepare_cookies
2055 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2057 =head2 $c->prepare_headers
2063 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2065 =head2 $c->prepare_parameters
2067 Prepares parameters.
2071 sub prepare_parameters {
2073 $c->prepare_body_parameters;
2074 $c->engine->prepare_parameters( $c, @_ );
2077 =head2 $c->prepare_path
2079 Prepares path and base.
2083 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2085 =head2 $c->prepare_query_parameters
2087 Prepares query parameters.
2091 sub prepare_query_parameters {
2094 $c->engine->prepare_query_parameters( $c, @_ );
2097 =head2 $c->log_request
2099 Writes information about the request to the debug logs. This includes:
2103 =item * Request method, path, and remote IP address
2105 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2107 =item * Request parameters
2109 =item * File uploads
2118 return unless $c->debug;
2120 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2121 my $request = $dump->[1];
2123 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2125 $path = '/' unless length $path;
2127 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2129 $c->log_request_headers($request->headers);
2131 if ( my $keywords = $request->query_keywords ) {
2132 $c->log->debug("Query keywords are: $keywords");
2135 $c->log_request_parameters( query => $request->query_parameters, body => $request->body_parameters );
2137 $c->log_request_uploads($request);
2140 =head2 $c->log_response
2142 Writes information about the response to the debug logs by calling
2143 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2150 return unless $c->debug;
2152 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2153 my $response = $dump->[1];
2155 $c->log_response_status_line($response);
2156 $c->log_response_headers($response->headers);
2159 =head2 $c->log_response_status_line($response)
2161 Writes one line of information about the response to the debug logs. This includes:
2165 =item * Response status code
2167 =item * Content-Type header (if present)
2169 =item * Content-Length header (if present)
2175 sub log_response_status_line {
2176 my ($c, $response) = @_;
2180 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2181 $response->status || 'unknown',
2182 $response->headers->header('Content-Type') || 'unknown',
2183 $response->headers->header('Content-Length') || 'unknown'
2188 =head2 $c->log_response_headers($headers);
2190 Hook method which can be wrapped by plugins to log the responseheaders.
2191 No-op in the default implementation.
2195 sub log_response_headers {}
2197 =head2 $c->log_request_parameters( query => {}, body => {} )
2199 Logs request parameters to debug logs
2203 sub log_request_parameters {
2205 my %all_params = @_;
2207 return unless $c->debug;
2209 my $column_width = Catalyst::Utils::term_width() - 44;
2210 foreach my $type (qw(query body)) {
2211 my $params = $all_params{$type};
2212 next if ! keys %$params;
2213 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2214 for my $key ( sort keys %$params ) {
2215 my $param = $params->{$key};
2216 my $value = defined($param) ? $param : '';
2217 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2219 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2223 =head2 $c->log_request_uploads
2225 Logs file uploads included in the request to the debug logs.
2226 The parameter name, filename, file type, and file size are all included in
2231 sub log_request_uploads {
2233 my $request = shift;
2234 return unless $c->debug;
2235 my $uploads = $request->uploads;
2236 if ( keys %$uploads ) {
2237 my $t = Text::SimpleTable->new(
2238 [ 12, 'Parameter' ],
2243 for my $key ( sort keys %$uploads ) {
2244 my $upload = $uploads->{$key};
2245 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2246 $t->row( $key, $u->filename, $u->type, $u->size );
2249 $c->log->debug( "File Uploads are:\n" . $t->draw );
2253 =head2 $c->log_request_headers($headers);
2255 Hook method which can be wrapped by plugins to log the request headers.
2256 No-op in the default implementation.
2260 sub log_request_headers {}
2262 =head2 $c->log_headers($type => $headers)
2264 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2271 my $headers = shift; # an HTTP::Headers instance
2273 return unless $c->debug;
2275 my $column_width = Catalyst::Utils::term_width() - 28;
2276 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2279 my ( $name, $value ) = @_;
2280 $t->row( $name, $value );
2283 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2287 =head2 $c->prepare_read
2289 Prepares the input for reading.
2293 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2295 =head2 $c->prepare_request
2297 Prepares the engine request.
2301 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2303 =head2 $c->prepare_uploads
2309 sub prepare_uploads {
2312 $c->engine->prepare_uploads( $c, @_ );
2315 =head2 $c->prepare_write
2317 Prepares the output for writing.
2321 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2323 =head2 $c->request_class
2325 Returns or sets the request class.
2327 =head2 $c->response_class
2329 Returns or sets the response class.
2331 =head2 $c->read( [$maxlength] )
2333 Reads a chunk of data from the request body. This method is designed to
2334 be used in a while loop, reading C<$maxlength> bytes on every call.
2335 C<$maxlength> defaults to the size of the request if not specified.
2337 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2340 Warning: If you use read(), Catalyst will not process the body,
2341 so you will not be able to access POST parameters or file uploads via
2342 $c->request. You must handle all body parsing yourself.
2346 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2354 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2356 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2358 Sets an action in a given namespace.
2362 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2364 =head2 $c->setup_actions($component)
2366 Sets up actions for a component.
2370 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2372 =head2 $c->setup_components
2374 This method is called internally to set up the application's components.
2376 It finds modules by calling the L<locate_components> method, expands them to
2377 package names with the L<expand_component_module> method, and then installs
2378 each component into the application.
2380 The C<setup_components> config option is passed to both of the above methods.
2382 Installation of each component is performed by the L<setup_component> method,
2387 sub setup_components {
2390 my $config = $class->config->{ setup_components };
2392 my @comps = sort { length $a <=> length $b }
2393 $class->locate_components($config);
2394 my %comps = map { $_ => 1 } @comps;
2396 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2397 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2398 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2399 ) if $deprecatedcatalyst_component_names;
2401 for my $component ( @comps ) {
2403 # We pass ignore_loaded here so that overlay files for (e.g.)
2404 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2405 # we know M::P::O found a file on disk so this is safe
2407 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2409 # Needs to be done as soon as the component is loaded, as loading a sub-component
2410 # (next time round the loop) can cause us to get the wrong metaclass..
2411 $class->_controller_init_base_classes($component);
2414 for my $component (@comps) {
2415 my $instance = $class->components->{ $component } = $class->setup_component($component);
2416 my @expanded_components = $instance->can('expand_modules')
2417 ? $instance->expand_modules( $component, $config )
2418 : $class->expand_component_module( $component, $config );
2419 for my $component (@expanded_components) {
2420 next if $comps{$component};
2421 $class->_controller_init_base_classes($component); # Also cover inner packages
2422 $class->components->{ $component } = $class->setup_component($component);
2427 =head2 $c->locate_components( $setup_component_config )
2429 This method is meant to provide a list of component modules that should be
2430 setup for the application. By default, it will use L<Module::Pluggable>.
2432 Specify a C<setup_components> config option to pass additional options directly
2433 to L<Module::Pluggable>. To add additional search paths, specify a key named
2434 C<search_extra> as an array reference. Items in the array beginning with C<::>
2435 will have the application class name prepended to them.
2439 sub locate_components {
2443 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2444 my $extra = delete $config->{ search_extra } || [];
2446 push @paths, @$extra;
2448 my $locator = Module::Pluggable::Object->new(
2449 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2453 my @comps = $locator->plugins;
2458 =head2 $c->expand_component_module( $component, $setup_component_config )
2460 Components found by C<locate_components> will be passed to this method, which
2461 is expected to return a list of component (package) names to be set up.
2465 sub expand_component_module {
2466 my ($class, $module) = @_;
2467 return Devel::InnerPackage::list_packages( $module );
2470 =head2 $c->setup_component
2474 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2475 # nearest to Catalyst::Controller first, no matter what order stuff happens
2476 # to be loaded. There are TODO tests in Moose for this, see
2477 # f2391d17574eff81d911b97be15ea51080500003
2478 sub _controller_init_base_classes {
2479 my ($app_class, $component) = @_;
2480 return unless $component->isa('Catalyst::Controller');
2481 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2482 Moose::Meta::Class->initialize( $class )
2483 unless find_meta($class);
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).
2833 =head2 $c->stats_class
2835 Returns or sets the stats (timing statistics) class.
2837 =head2 $c->use_stats
2839 Returns 1 when stats collection is enabled. Stats collection is enabled
2840 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2841 environment variable is set.
2843 Note that this is a static method, not an accessor and should be overridden
2844 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2851 =head2 $c->write( $data )
2853 Writes $data to the output stream. When using this method directly, you
2854 will need to manually set the C<Content-Length> header to the length of
2855 your output data, if known.
2862 # Finalize headers if someone manually writes output
2863 $c->finalize_headers;
2865 return $c->engine->write( $c, @_ );
2870 Returns the Catalyst version number. Mostly useful for "powered by"
2871 messages in template systems.
2875 sub version { return $Catalyst::VERSION }
2877 =head1 CONFIGURATION
2879 There are a number of 'base' config variables which can be set:
2885 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2889 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2893 C<disable_component_resolution_regex_fallback> - Turns
2894 off the deprecated component resolution functionality so
2895 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2896 are called then regex search will not be attempted on string values and
2897 instead C<undef> will be returned.
2901 C<home> - The application home directory. In an uninstalled application,
2902 this is the top level application directory. In an installed application,
2903 this will be the directory containing C<< MyApp.pm >>.
2907 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2911 C<name> - The name of the application in debug messages and the debug and
2916 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2917 until it is accessed. This allows you to (for example) check authentication (and reject
2918 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2922 C<root> - The root directory for templates. Usually this is just a
2923 subdirectory of the home directory, but you can set it to change the
2924 templates to a different directory.
2928 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2929 namespaces from which components will be loaded (and constructed and stored in
2930 C<< $c->components >>).
2934 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2935 to be shown in hit debug tables in the test server.
2939 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2943 =head1 INTERNAL ACTIONS
2945 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2946 C<_ACTION>, and C<_END>. These are by default not shown in the private
2947 action table, but you can make them visible with a config parameter.
2949 MyApp->config(show_internal_actions => 1);
2951 =head1 ON-DEMAND PARSER
2953 The request body is usually parsed at the beginning of a request,
2954 but if you want to handle input yourself, you can enable on-demand
2955 parsing with a config parameter.
2957 MyApp->config(parse_on_demand => 1);
2959 =head1 PROXY SUPPORT
2961 Many production servers operate using the common double-server approach,
2962 with a lightweight frontend web server passing requests to a larger
2963 backend server. An application running on the backend server must deal
2964 with two problems: the remote user always appears to be C<127.0.0.1> and
2965 the server's hostname will appear to be C<localhost> regardless of the
2966 virtual host that the user connected through.
2968 Catalyst will automatically detect this situation when you are running
2969 the frontend and backend servers on the same machine. The following
2970 changes are made to the request.
2972 $c->req->address is set to the user's real IP address, as read from
2973 the HTTP X-Forwarded-For header.
2975 The host value for $c->req->base and $c->req->uri is set to the real
2976 host, as read from the HTTP X-Forwarded-Host header.
2978 Additionally, you may be running your backend application on an insecure
2979 connection (port 80) while your frontend proxy is running under SSL. If there
2980 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2981 tell Catalyst what port the frontend listens on. This will allow all URIs to
2982 be created properly.
2984 In the case of passing in:
2986 X-Forwarded-Port: 443
2988 All calls to C<uri_for> will result in an https link, as is expected.
2990 Obviously, your web server must support these headers for this to work.
2992 In a more complex server farm environment where you may have your
2993 frontend proxy server(s) on different machines, you will need to set a
2994 configuration option to tell Catalyst to read the proxied data from the
2997 MyApp->config(using_frontend_proxy => 1);
2999 If you do not wish to use the proxy support at all, you may set:
3001 MyApp->config(ignore_frontend_proxy => 1);
3003 =head1 THREAD SAFETY
3005 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3006 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3007 believe the Catalyst core to be thread-safe.
3009 If you plan to operate in a threaded environment, remember that all other
3010 modules you are using must also be thread-safe. Some modules, most notably
3011 L<DBD::SQLite>, are not thread-safe.
3017 Join #catalyst on irc.perl.org.
3021 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3022 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3026 http://catalyst.perl.org
3030 http://dev.catalyst.perl.org
3034 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3036 =head2 L<Catalyst::Manual> - The Catalyst Manual
3038 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3040 =head2 L<Catalyst::Engine> - Core engine
3042 =head2 L<Catalyst::Log> - Log class.
3044 =head2 L<Catalyst::Request> - Request object
3046 =head2 L<Catalyst::Response> - Response object
3048 =head2 L<Catalyst::Test> - The test suite.
3050 =head1 PROJECT FOUNDER
3052 sri: Sebastian Riedel <sri@cpan.org>
3058 acme: Leon Brocard <leon@astray.com>
3060 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3064 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3068 andyg: Andy Grundman <andy@hybridized.org>
3070 audreyt: Audrey Tang
3072 bricas: Brian Cassidy <bricas@cpan.org>
3074 Caelum: Rafael Kitover <rkitover@io.com>
3076 chansen: Christian Hansen
3078 chicks: Christopher Hicks
3080 Chisel Wright C<pause@herlpacker.co.uk>
3082 Danijel Milicevic C<me@danijel.de>
3084 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3086 David Naughton, C<naughton@umn.edu>
3090 dhoss: Devin Austin <dhoss@cpan.org>
3092 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3096 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3098 esskar: Sascha Kiefer
3100 fireartist: Carl Franks <cfranks@cpan.org>
3102 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3104 gabb: Danijel Milicevic
3108 Gavin Henry C<ghenry@perl.me.uk>
3112 groditi: Guillermo Roditi <groditi@gmail.com>
3114 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3116 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3118 jcamacho: Juan Camacho
3120 jester: Jesse Sheidlower C<jester@panix.com>
3122 jhannah: Jay Hannah <jay@jays.net>
3128 jon: Jon Schutz <jjschutz@cpan.org>
3130 Jonathan Rockway C<< <jrockway@cpan.org> >>
3132 Kieren Diment C<kd@totaldatasolution.com>
3134 konobi: Scott McWhirter <konobi@cpan.org>
3136 marcus: Marcus Ramberg <mramberg@cpan.org>
3138 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3140 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3144 naughton: David Naughton
3146 ningu: David Kamholz <dkamholz@cpan.org>
3148 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3150 numa: Dan Sully <daniel@cpan.org>
3156 omega: Andreas Marienborg
3158 Oleg Kostyuk <cub.uanic@gmail.com>
3160 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3162 rafl: Florian Ragwitz <rafl@debian.org>
3164 random: Roland Lammel <lammel@cpan.org>
3166 Robert Sedlacek C<< <rs@474.at> >>
3170 szbalint: Balint Szilakszi <szbalint@cpan.org>
3172 t0m: Tomas Doran <bobtfish@bobtfish.net>
3176 Viljo Marrandi C<vilts@yahoo.com>
3178 Will Hawes C<info@whawes.co.uk>
3180 willert: Sebastian Willert <willert@cpan.org>
3182 wreis: Wallace Reis <wallace@reis.org.br>
3184 Yuval Kogman, C<nothingmuch@woobling.org>
3188 This library is free software. You can redistribute it and/or modify it under
3189 the same terms as Perl itself.
3195 __PACKAGE__->meta->make_immutable;