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;
17 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
26 use Tree::Simple qw/use_weak_refs/;
27 use Tree::Simple::Visitor::FindByUID;
28 use Class::C3::Adopt::NEXT;
29 use List::MoreUtils qw/uniq/;
32 use Carp qw/croak carp shortmess/;
34 BEGIN { require 5.008004; }
36 has stack => (is => 'ro', default => sub { [] });
37 has stash => (is => 'rw', default => sub { {} });
38 has state => (is => 'rw', default => 0);
39 has stats => (is => 'rw');
40 has action => (is => 'rw');
41 has counter => (is => 'rw', default => sub { {} });
42 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
43 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
44 has namespace => (is => 'rw');
46 sub depth { scalar @{ shift->stack || [] }; }
47 sub comp { shift->component(@_) }
50 my $self = shift; return $self->request(@_);
53 my $self = shift; return $self->response(@_);
56 # For backwards compatibility
57 sub finalize_output { shift->finalize_body(@_) };
62 our $RECURSION = 1000;
63 our $DETACH = Catalyst::Exception::Detach->new;
64 our $GO = Catalyst::Exception::Go->new;
66 #I imagine that very few of these really need to be class variables. if any.
67 #maybe we should just make them attributes with a default?
68 __PACKAGE__->mk_classdata($_)
69 for qw/components arguments dispatcher engine log dispatcher_class
70 engine_class context_class request_class response_class stats_class
73 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
74 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
75 __PACKAGE__->request_class('Catalyst::Request');
76 __PACKAGE__->response_class('Catalyst::Response');
77 __PACKAGE__->stats_class('Catalyst::Stats');
79 # Remember to update this in Catalyst::Runtime as well!
81 our $VERSION = '5.80021';
82 our $PRETTY_VERSION = $VERSION;
84 $VERSION = eval $VERSION;
87 my ( $class, @arguments ) = @_;
89 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
91 return unless $class eq 'Catalyst';
93 my $caller = caller();
94 return if $caller eq 'main';
96 my $meta = Moose::Meta::Class->initialize($caller);
97 unless ( $caller->isa('Catalyst') ) {
98 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
99 $meta->superclasses(@superclasses);
101 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
102 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
104 unless( $meta->has_method('meta') ){
105 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
108 $caller->arguments( [@arguments] );
112 sub _application { $_[0] }
116 Catalyst - The Elegant MVC Web Application Framework
120 See the L<Catalyst::Manual> distribution for comprehensive
121 documentation and tutorials.
123 # Install Catalyst::Devel for helpers and other development tools
124 # use the helper to create a new application
127 # add models, views, controllers
128 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
129 script/myapp_create.pl view MyTemplate TT
130 script/myapp_create.pl controller Search
132 # built in testserver -- use -r to restart automatically on changes
133 # --help to see all available options
134 script/myapp_server.pl
136 # command line testing interface
137 script/myapp_test.pl /yada
140 use Catalyst qw/-Debug/; # include plugins here as well
142 ### In lib/MyApp/Controller/Root.pm (autocreated)
143 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
144 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
145 $c->stash->{template} = 'foo.tt'; # set the template
146 # lookup something from db -- stash vars are passed to TT
148 $c->model('Database::Foo')->search( { country => $args[0] } );
149 if ( $c->req->params->{bar} ) { # access GET or POST parameters
150 $c->forward( 'bar' ); # process another action
151 # do something else after forward returns
155 # The foo.tt TT template can use the stash data from the database
156 [% WHILE (item = data.next) %]
160 # called for /bar/of/soap, /bar/of/soap/10, etc.
161 sub bar : Path('/bar/of/soap') { ... }
163 # called for all actions, from the top-most controller downwards
165 my ( $self, $c ) = @_;
166 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
167 $c->res->redirect( '/login' ); # require login
168 return 0; # abort request and go immediately to end()
170 return 1; # success; carry on to next action
173 # called after all actions are finished
175 my ( $self, $c ) = @_;
176 if ( scalar @{ $c->error } ) { ... } # handle errors
177 return if $c->res->body; # already have a response
178 $c->forward( 'MyApp::View::TT' ); # render template
181 ### in MyApp/Controller/Foo.pm
182 # called for /foo/bar
183 sub bar : Local { ... }
185 # called for /blargle
186 sub blargle : Global { ... }
188 # an index action matches /foo, but not /foo/1, etc.
189 sub index : Private { ... }
191 ### in MyApp/Controller/Foo/Bar.pm
192 # called for /foo/bar/baz
193 sub baz : Local { ... }
195 # first Root auto is called, then Foo auto, then this
196 sub auto : Private { ... }
198 # powerful regular expression paths are also possible
199 sub details : Regex('^product/(\w+)/details$') {
200 my ( $self, $c ) = @_;
201 # extract the (\w+) from the URI
202 my $product = $c->req->captures->[0];
205 See L<Catalyst::Manual::Intro> for additional information.
209 Catalyst is a modern framework for making web applications without the
210 pain usually associated with this process. This document is a reference
211 to the main Catalyst application. If you are a new user, we suggest you
212 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
214 See L<Catalyst::Manual> for more documentation.
216 Catalyst plugins can be loaded by naming them as arguments to the "use
217 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
218 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
221 use Catalyst qw/My::Module/;
223 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
224 fully qualify the name by using a unary plus:
228 +Fully::Qualified::Plugin::Name
231 Special flags like C<-Debug> and C<-Engine> can also be specified as
232 arguments when Catalyst is loaded:
234 use Catalyst qw/-Debug My::Module/;
236 The position of plugins and flags in the chain is important, because
237 they are loaded in the order in which they appear.
239 The following flags are supported:
243 Enables debug output. You can also force this setting from the system
244 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
245 settings override the application, with <MYAPP>_DEBUG having the highest
248 This sets the log level to 'debug' and enables full debug output on the
249 error screen. If you only want the latter, see L<< $c->debug >>.
253 Forces Catalyst to use a specific engine. Omit the
254 C<Catalyst::Engine::> prefix of the engine name, i.e.:
256 use Catalyst qw/-Engine=CGI/;
260 Forces Catalyst to use a specific home directory, e.g.:
262 use Catalyst qw[-Home=/usr/mst];
264 This can also be done in the shell environment by setting either the
265 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
266 is replaced with the uppercased name of your application, any "::" in
267 the name will be replaced with underscores, e.g. MyApp::Web should use
268 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
270 If none of these are set, Catalyst will attempt to automatically detect the
271 home directory. If you are working in a development envirnoment, Catalyst
272 will try and find the directory containing either Makefile.PL, Build.PL or
273 dist.ini. If the application has been installed into the system (i.e.
274 you have done C<make install>), then Catalyst will use the path to your
275 application module, without the .pm extension (ie, /foo/MyApp if your
276 application was installed at /foo/MyApp.pm)
280 use Catalyst '-Log=warn,fatal,error';
282 Specifies a comma-delimited list of log levels.
286 Enables statistics collection and reporting. You can also force this setting
287 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
288 environment settings override the application, with <MYAPP>_STATS having the
293 use Catalyst qw/-Stats=1/
297 =head2 INFORMATION ABOUT THE CURRENT REQUEST
301 Returns a L<Catalyst::Action> object for the current action, which
302 stringifies to the action name. See L<Catalyst::Action>.
306 Returns the namespace of the current action, i.e., the URI prefix
307 corresponding to the controller of the current action. For example:
309 # in Controller::Foo::Bar
310 $c->namespace; # returns 'foo/bar';
316 Returns the current L<Catalyst::Request> object, giving access to
317 information about the current client request (including parameters,
318 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
320 =head2 REQUEST FLOW HANDLING
322 =head2 $c->forward( $action [, \@arguments ] )
324 =head2 $c->forward( $class, $method, [, \@arguments ] )
326 Forwards processing to another action, by its private name. If you give a
327 class name but no method, C<process()> is called. You may also optionally
328 pass arguments in an arrayref. The action will receive the arguments in
329 C<@_> and C<< $c->req->args >>. Upon returning from the function,
330 C<< $c->req->args >> will be restored to the previous values.
332 Any data C<return>ed from the action forwarded to, will be returned by the
335 my $foodata = $c->forward('/foo');
336 $c->forward('index');
337 $c->forward(qw/Model::DBIC::Foo do_stuff/);
338 $c->forward('View::TT');
340 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
341 an C<< eval { } >> around the call (actually
342 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
343 all 'dies' within the called action. If you want C<die> to propagate you
344 need to do something like:
347 die join "\n", @{ $c->error } if @{ $c->error };
349 Or make sure to always return true values from your actions and write
352 $c->forward('foo') || return;
354 Another note is that C<< $c->forward >> always returns a scalar because it
355 actually returns $c->state which operates in a scalar context.
356 Thus, something like:
360 in an action that is forwarded to is going to return a scalar,
361 i.e. how many items are in that array, which is probably not what you want.
362 If you need to return an array then return a reference to it,
365 $c->stash->{array} = \@array;
367 and access it from the stash.
371 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
373 =head2 $c->detach( $action [, \@arguments ] )
375 =head2 $c->detach( $class, $method, [, \@arguments ] )
379 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
380 doesn't return to the previous action when processing is finished.
382 When called with no arguments it escapes the processing chain entirely.
386 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
388 =head2 $c->visit( $action [, \@captures, \@arguments ] )
390 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
392 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
393 but does a full dispatch, instead of just calling the new C<$action> /
394 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
395 you go to are called, just like a new request.
397 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
398 This means, for example, that C<< $c->action >> methods such as
399 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
400 L<reverse|Catalyst::Action/reverse> return information for the visited action
401 when they are invoked within the visited action. This is different from the
402 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
403 continues to use the $c->action object from the caller action even when
404 invoked from the callee.
406 C<< $c->stash >> is kept unchanged.
408 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
409 allows you to "wrap" another action, just as it would have been called by
410 dispatching from a URL, while the analogous
411 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
412 transfer control to another action as if it had been reached directly from a URL.
416 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
418 =head2 $c->go( $action [, \@captures, \@arguments ] )
420 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
422 The relationship between C<go> and
423 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
424 the relationship between
425 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
426 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
427 C<< $c->go >> will perform a full dispatch on the specified action or method,
428 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
429 C<go> escapes the processing of the current request chain on completion, and
430 does not return to its caller.
434 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
440 Returns the current L<Catalyst::Response> object, see there for details.
444 Returns a hashref to the stash, which may be used to store data and pass
445 it between components during a request. You can also set hash keys by
446 passing arguments. The stash is automatically sent to the view. The
447 stash is cleared at the end of a request; it cannot be used for
448 persistent storage (for this you must use a session; see
449 L<Catalyst::Plugin::Session> for a complete system integrated with
452 $c->stash->{foo} = $bar;
453 $c->stash( { moose => 'majestic', qux => 0 } );
454 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
456 # stash is automatically passed to the view for use in a template
457 $c->forward( 'MyApp::View::TT' );
461 around stash => sub {
464 my $stash = $orig->($c);
466 my $new_stash = @_ > 1 ? {@_} : $_[0];
467 croak('stash takes a hash or hashref') unless ref $new_stash;
468 foreach my $key ( keys %$new_stash ) {
469 $stash->{$key} = $new_stash->{$key};
479 =head2 $c->error($error, ...)
481 =head2 $c->error($arrayref)
483 Returns an arrayref containing error messages. If Catalyst encounters an
484 error while processing a request, it stores the error in $c->error. This
485 method should only be used to store fatal error messages.
487 my @error = @{ $c->error };
491 $c->error('Something bad happened');
498 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
499 croak @$error unless ref $c;
500 push @{ $c->{error} }, @$error;
502 elsif ( defined $_[0] ) { $c->{error} = undef }
503 return $c->{error} || [];
509 Contains the return value of the last executed action.
510 Note that << $c->state >> operates in a scalar context which means that all
511 values it returns are scalar.
513 =head2 $c->clear_errors
515 Clear errors. You probably don't want to clear the errors unless you are
516 implementing a custom error screen.
518 This is equivalent to running
529 sub _comp_search_prefixes {
531 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
534 # search components given a name and some prefixes
535 sub _comp_names_search_prefixes {
536 my ( $c, $name, @prefixes ) = @_;
537 my $appclass = ref $c || $c;
538 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
539 $filter = qr/$filter/; # Compile regex now rather than once per loop
541 # map the original component name to the sub part that we will search against
542 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
543 grep { /$filter/ } keys %{ $c->components };
545 # undef for a name will return all
546 return keys %eligible if !defined $name;
548 my $query = ref $name ? $name : qr/^$name$/i;
549 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
551 return @result if @result;
553 # if we were given a regexp to search against, we're done.
556 # skip regexp fallback if configured
558 if $appclass->config->{disable_component_resolution_regex_fallback};
562 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
564 # no results? try against full names
566 @result = grep { m{$query} } keys %eligible;
569 # don't warn if we didn't find any results, it just might not exist
571 # Disgusting hack to work out correct method name
572 my $warn_for = lc $prefixes[0];
573 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
574 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
575 "component resolution is unreliable and unsafe.";
576 my $short = $result[0];
577 # remove the component namespace prefix
578 $short =~ s/.*?(Model|Controller|View):://;
579 my $shortmess = Carp::shortmess('');
580 if ($shortmess =~ m#Catalyst/Plugin#) {
581 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
583 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
584 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
585 "component's config";
587 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
588 "but if you really wanted to search, pass in a regexp as the argument " .
589 "like so: \$c->${warn_for}(qr/${name}/)";
591 $c->log->warn( "${msg}$shortmess" );
597 # Find possible names for a prefix
599 my ( $c, @prefixes ) = @_;
600 my $appclass = ref $c || $c;
602 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
604 my @names = map { s{$filter}{}; $_; }
605 $c->_comp_names_search_prefixes( undef, @prefixes );
610 # Filter a component before returning by calling ACCEPT_CONTEXT if available
611 sub _filter_component {
612 my ( $c, $comp, @args ) = @_;
614 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
615 return $comp->ACCEPT_CONTEXT( $c, @args );
621 =head2 COMPONENT ACCESSORS
623 =head2 $c->controller($name)
625 Gets a L<Catalyst::Controller> instance by name.
627 $c->controller('Foo')->do_stuff;
629 If the name is omitted, will return the controller for the dispatched
632 If you want to search for controllers, pass in a regexp as the argument.
634 # find all controllers that start with Foo
635 my @foo_controllers = $c->controller(qr{^Foo});
641 my ( $c, $name, @args ) = @_;
643 my $appclass = ref($c) || $c;
645 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
646 my $comps = $c->components;
647 my $check = $appclass."::Controller::".$name;
648 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
650 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
651 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
652 return $c->_filter_component( $result[ 0 ], @args );
655 return $c->component( $c->action->class );
658 =head2 $c->model($name)
660 Gets a L<Catalyst::Model> instance by name.
662 $c->model('Foo')->do_stuff;
664 Any extra arguments are directly passed to ACCEPT_CONTEXT.
666 If the name is omitted, it will look for
667 - a model object in $c->stash->{current_model_instance}, then
668 - a model name in $c->stash->{current_model}, then
669 - a config setting 'default_model', or
670 - check if there is only one model, and return it if that's the case.
672 If you want to search for models, pass in a regexp as the argument.
674 # find all models that start with Foo
675 my @foo_models = $c->model(qr{^Foo});
680 my ( $c, $name, @args ) = @_;
681 my $appclass = ref($c) || $c;
683 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
684 my $comps = $c->components;
685 my $check = $appclass."::Model::".$name;
686 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
688 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
689 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
690 return $c->_filter_component( $result[ 0 ], @args );
694 return $c->stash->{current_model_instance}
695 if $c->stash->{current_model_instance};
696 return $c->model( $c->stash->{current_model} )
697 if $c->stash->{current_model};
699 return $c->model( $appclass->config->{default_model} )
700 if $appclass->config->{default_model};
702 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
705 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
706 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
707 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
708 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
709 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
712 return $c->_filter_component( $comp );
716 =head2 $c->view($name)
718 Gets a L<Catalyst::View> instance by name.
720 $c->view('Foo')->do_stuff;
722 Any extra arguments are directly passed to ACCEPT_CONTEXT.
724 If the name is omitted, it will look for
725 - a view object in $c->stash->{current_view_instance}, then
726 - a view name in $c->stash->{current_view}, then
727 - a config setting 'default_view', or
728 - check if there is only one view, and return it if that's the case.
730 If you want to search for views, pass in a regexp as the argument.
732 # find all views that start with Foo
733 my @foo_views = $c->view(qr{^Foo});
738 my ( $c, $name, @args ) = @_;
740 my $appclass = ref($c) || $c;
742 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
743 my $comps = $c->components;
744 my $check = $appclass."::View::".$name;
745 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
747 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
748 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
749 return $c->_filter_component( $result[ 0 ], @args );
753 return $c->stash->{current_view_instance}
754 if $c->stash->{current_view_instance};
755 return $c->view( $c->stash->{current_view} )
756 if $c->stash->{current_view};
758 return $c->view( $appclass->config->{default_view} )
759 if $appclass->config->{default_view};
761 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
764 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
765 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
766 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
767 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
768 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
771 return $c->_filter_component( $comp );
774 =head2 $c->controllers
776 Returns the available names which can be passed to $c->controller
782 return $c->_comp_names(qw/Controller C/);
787 Returns the available names which can be passed to $c->model
793 return $c->_comp_names(qw/Model M/);
799 Returns the available names which can be passed to $c->view
805 return $c->_comp_names(qw/View V/);
808 =head2 $c->comp($name)
810 =head2 $c->component($name)
812 Gets a component object by name. This method is not recommended,
813 unless you want to get a specific component by full
814 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
815 should be used instead.
817 If C<$name> is a regexp, a list of components matched against the full
818 component name will be returned.
820 If Catalyst can't find a component by name, it will fallback to regex
821 matching by default. To disable this behaviour set
822 disable_component_resolution_regex_fallback to a true value.
824 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
829 my ( $c, $name, @args ) = @_;
832 my $comps = $c->components;
835 # is it the exact name?
836 return $c->_filter_component( $comps->{ $name }, @args )
837 if exists $comps->{ $name };
839 # perhaps we just omitted "MyApp"?
840 my $composed = ( ref $c || $c ) . "::${name}";
841 return $c->_filter_component( $comps->{ $composed }, @args )
842 if exists $comps->{ $composed };
844 # search all of the models, views and controllers
845 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
846 return $c->_filter_component( $comp, @args ) if $comp;
849 # This is here so $c->comp( '::M::' ) works
850 my $query = ref $name ? $name : qr{$name}i;
852 my @result = grep { m{$query} } keys %{ $c->components };
853 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
856 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
857 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
858 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
859 return $c->_filter_component( $result[ 0 ], @args );
862 # I would expect to return an empty list here, but that breaks back-compat
866 return sort keys %{ $c->components };
869 =head2 CLASS DATA AND HELPER CLASSES
873 Returns or takes a hashref containing the application's configuration.
875 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
877 You can also use a C<YAML>, C<XML> or L<Config::General> config file
878 like C<myapp.conf> in your applications home directory. See
879 L<Catalyst::Plugin::ConfigLoader>.
881 =head3 Cascading configuration
883 The config method is present on all Catalyst components, and configuration
884 will be merged when an application is started. Configuration loaded with
885 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
886 followed by configuration in your top level C<MyApp> class. These two
887 configurations are merged, and then configuration data whose hash key matches a
888 component name is merged with configuration for that component.
890 The configuration for a component is then passed to the C<new> method when a
891 component is constructed.
895 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
896 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
898 will mean that C<MyApp::Model::Foo> receives the following data when
901 MyApp::Model::Foo->new({
909 around config => sub {
913 croak('Setting config after setup has been run is not allowed.')
914 if ( @_ and $c->setup_finished );
921 Returns the logging object instance. Unless it is already set, Catalyst
922 sets this up with a L<Catalyst::Log> object. To use your own log class,
923 set the logger with the C<< __PACKAGE__->log >> method prior to calling
924 C<< __PACKAGE__->setup >>.
926 __PACKAGE__->log( MyLogger->new );
931 $c->log->info( 'Now logging with my own logger!' );
933 Your log class should implement the methods described in
939 Returns 1 if debug mode is enabled, 0 otherwise.
941 You can enable debug mode in several ways:
945 =item By calling myapp_server.pl with the -d flag
947 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
949 =item The -Debug option in your MyApp.pm
951 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
955 The first three also set the log level to 'debug'.
957 Calling C<< $c->debug(1) >> has no effect.
963 =head2 $c->dispatcher
965 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
969 Returns the engine instance. See L<Catalyst::Engine>.
972 =head2 UTILITY METHODS
974 =head2 $c->path_to(@path)
976 Merges C<@path> with C<< $c->config->{home} >> and returns a
977 L<Path::Class::Dir> object. Note you can usually use this object as
978 a filename, but sometimes you will have to explicitly stringify it
979 yourself by calling the C<< ->stringify >> method.
983 $c->path_to( 'db', 'sqlite.db' );
988 my ( $c, @path ) = @_;
989 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
990 if ( -d $path ) { return $path }
991 else { return Path::Class::File->new( $c->config->{home}, @path ) }
994 =head2 $c->plugin( $name, $class, @args )
996 Helper method for plugins. It creates a class data accessor/mutator and
997 loads and instantiates the given class.
999 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1001 $c->prototype->define_javascript_functions;
1003 B<Note:> This method of adding plugins is deprecated. The ability
1004 to add plugins like this B<will be removed> in a Catalyst 5.81.
1005 Please do not use this functionality in new code.
1010 my ( $class, $name, $plugin, @args ) = @_;
1012 # See block comment in t/unit_core_plugin.t
1013 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1015 $class->_register_plugin( $plugin, 1 );
1017 eval { $plugin->import };
1018 $class->mk_classdata($name);
1020 eval { $obj = $plugin->new(@args) };
1023 Catalyst::Exception->throw( message =>
1024 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1027 $class->$name($obj);
1028 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1034 Initializes the dispatcher and engine, loads any plugins, and loads the
1035 model, view, and controller components. You may also specify an array
1036 of plugins to load here, if you choose to not load them in the C<use
1040 MyApp->setup( qw/-Debug/ );
1045 my ( $class, @arguments ) = @_;
1046 croak('Running setup more than once')
1047 if ( $class->setup_finished );
1049 unless ( $class->isa('Catalyst') ) {
1051 Catalyst::Exception->throw(
1052 message => qq/'$class' does not inherit from Catalyst/ );
1055 if ( $class->arguments ) {
1056 @arguments = ( @arguments, @{ $class->arguments } );
1062 foreach (@arguments) {
1066 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1068 elsif (/^-(\w+)=?(.*)$/) {
1069 $flags->{ lc $1 } = $2;
1072 push @{ $flags->{plugins} }, $_;
1076 $class->setup_home( delete $flags->{home} );
1078 $class->setup_log( delete $flags->{log} );
1079 $class->setup_plugins( delete $flags->{plugins} );
1080 $class->setup_dispatcher( delete $flags->{dispatcher} );
1081 $class->setup_engine( delete $flags->{engine} );
1082 $class->setup_stats( delete $flags->{stats} );
1084 for my $flag ( sort keys %{$flags} ) {
1086 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1087 &$code( $class, delete $flags->{$flag} );
1090 $class->log->warn(qq/Unknown flag "$flag"/);
1094 eval { require Catalyst::Devel; };
1095 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1096 $class->log->warn(<<"EOF");
1097 You are running an old script!
1099 Please update by running (this will overwrite existing files):
1100 catalyst.pl -force -scripts $class
1102 or (this will not overwrite existing files):
1103 catalyst.pl -scripts $class
1108 if ( $class->debug ) {
1109 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1112 my $column_width = Catalyst::Utils::term_width() - 6;
1113 my $t = Text::SimpleTable->new($column_width);
1114 $t->row($_) for @plugins;
1115 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1118 my $dispatcher = $class->dispatcher;
1119 my $engine = $class->engine;
1120 my $home = $class->config->{home};
1122 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1123 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1127 ? $class->log->debug(qq/Found home "$home"/)
1128 : $class->log->debug(qq/Home "$home" doesn't exist/)
1129 : $class->log->debug(q/Couldn't find home/);
1132 # Call plugins setup, this is stupid and evil.
1133 # Also screws C3 badly on 5.10, hack to avoid.
1135 no warnings qw/redefine/;
1136 local *setup = sub { };
1137 $class->setup unless $Catalyst::__AM_RESTARTING;
1140 # Initialize our data structure
1141 $class->components( {} );
1143 $class->setup_components;
1145 if ( $class->debug ) {
1146 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1147 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1148 for my $comp ( sort keys %{ $class->components } ) {
1149 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1150 $t->row( $comp, $type );
1152 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1153 if ( keys %{ $class->components } );
1156 # Add our self to components, since we are also a component
1157 if( $class->isa('Catalyst::Controller') ){
1158 $class->components->{$class} = $class;
1161 $class->setup_actions;
1163 if ( $class->debug ) {
1164 my $name = $class->config->{name} || 'Application';
1165 $class->log->info("$name powered by Catalyst $Catalyst::PRETTY_VERSION");
1168 # Make sure that the application class becomes immutable at this point,
1169 B::Hooks::EndOfScope::on_scope_end {
1171 my $meta = Class::MOP::get_metaclass_by_name($class);
1174 && ! { $meta->immutable_options }->{replace_constructor}
1176 $class->isa('Class::Accessor::Fast')
1177 || $class->isa('Class::Accessor')
1180 warn "You made your application class ($class) immutable, "
1181 . "but did not inline the\nconstructor. "
1182 . "This will break catalyst, as your app \@ISA "
1183 . "Class::Accessor(::Fast)?\nPlease pass "
1184 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1186 $meta->make_immutable(
1187 replace_constructor => 1,
1188 ) unless $meta->is_immutable;
1191 if ($class->config->{case_sensitive}) {
1192 $class->log->warn($class . "->config->{case_sensitive} is set.");
1193 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1196 $class->setup_finalize;
1197 # Should be the last thing we do so that user things hooking
1198 # setup_finalize can log..
1199 $class->log->_flush() if $class->log->can('_flush');
1200 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1203 =head2 $app->setup_finalize
1205 A hook to attach modifiers to. This method does not do anything except set the
1206 C<setup_finished> accessor.
1208 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1212 after setup_finalize => sub {
1220 sub setup_finalize {
1222 $class->setup_finished(1);
1225 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1227 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1229 Constructs an absolute L<URI> object based on the application root, the
1230 provided path, and the additional arguments and query parameters provided.
1231 When used as a string, provides a textual URI.
1233 If no arguments are provided, the URI for the current action is returned.
1234 To return the current action and also provide @args, use
1235 C<< $c->uri_for( $c->action, @args ) >>.
1237 If the first argument is a string, it is taken as a public URI path relative
1238 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1239 relative to the application root (if it does). It is then merged with
1240 C<< $c->request->base >>; any C<@args> are appended as additional path
1241 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1243 If the first argument is a L<Catalyst::Action> it represents an action which
1244 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1245 optional C<\@captures> argument (an arrayref) allows passing the captured
1246 variables that are needed to fill in the paths of Chained and Regex actions;
1247 once the path is resolved, C<uri_for> continues as though a path was
1248 provided, appending any arguments or parameters and creating an absolute
1251 The captures for the current request can be found in
1252 C<< $c->request->captures >>, and actions can be resolved using
1253 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1254 path, use C<< $c->uri_for_action >> instead.
1256 # Equivalent to $c->req->uri
1257 $c->uri_for($c->action, $c->req->captures,
1258 @{ $c->req->args }, $c->req->params);
1260 # For the Foo action in the Bar controller
1261 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1263 # Path to a static resource
1264 $c->uri_for('/static/images/logo.png');
1269 my ( $c, $path, @args ) = @_;
1271 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1272 $path = $path->path_prefix;
1277 undef($path) if (defined $path && $path eq '');
1280 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1282 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1283 foreach my $arg (@args) {
1284 utf8::encode($arg) if utf8::is_utf8($arg);
1286 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1287 if (blessed $path) { # Action object only.
1288 s|/|%2F|g for @args;
1291 if ( blessed($path) ) { # action object
1292 my $captures = [ map { s|/|%2F|g; $_; }
1293 ( scalar @args && ref $args[0] eq 'ARRAY'
1297 foreach my $capture (@$captures) {
1298 utf8::encode($capture) if utf8::is_utf8($capture);
1299 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1303 $path = $c->dispatcher->uri_for_action($action, $captures);
1304 if (not defined $path) {
1305 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1309 $path = '/' if $path eq '';
1312 undef($path) if (defined $path && $path eq '');
1314 unshift(@args, $path);
1316 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1317 my $namespace = $c->namespace;
1318 if (defined $path) { # cheesy hack to handle path '../foo'
1319 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1321 unshift(@args, $namespace || '');
1324 # join args with '/', or a blank string
1325 my $args = join('/', grep { defined($_) } @args);
1326 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1328 my $base = $c->req->base;
1329 my $class = ref($base);
1330 $base =~ s{(?<!/)$}{/};
1334 if (my @keys = keys %$params) {
1335 # somewhat lifted from URI::_query's query_form
1336 $query = '?'.join('&', map {
1337 my $val = $params->{$_};
1338 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1341 $val = '' unless defined $val;
1344 utf8::encode( $param ) if utf8::is_utf8($param);
1345 # using the URI::Escape pattern here so utf8 chars survive
1346 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1348 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1352 my $res = bless(\"${base}${args}${query}", $class);
1356 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1358 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1364 A private path to the Catalyst action you want to create a URI for.
1366 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1367 >> and passing the resulting C<$action> and the remaining arguments to C<<
1370 You can also pass in a Catalyst::Action object, in which case it is passed to
1373 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.
1375 For example, if the action looks like:
1377 package MyApp::Controller::Users;
1379 sub lst : Path('the-list') {}
1383 $c->uri_for_action('/users/lst')
1385 and it will create the URI /users/the-list.
1391 sub uri_for_action {
1392 my ( $c, $path, @args ) = @_;
1393 my $action = blessed($path)
1395 : $c->dispatcher->get_action_by_path($path);
1396 unless (defined $action) {
1397 croak "Can't find action for path '$path'";
1399 return $c->uri_for( $action, @args );
1402 =head2 $c->welcome_message
1404 Returns the Catalyst welcome HTML page.
1408 sub welcome_message {
1410 my $name = $c->config->{name};
1411 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1412 my $prefix = Catalyst::Utils::appprefix( ref $c );
1413 $c->response->content_type('text/html; charset=utf-8');
1415 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1416 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1417 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1419 <meta http-equiv="Content-Language" content="en" />
1420 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1421 <title>$name on Catalyst $VERSION</title>
1422 <style type="text/css">
1425 background-color: #eee;
1432 margin-bottom: 10px;
1434 background-color: #ccc;
1435 border: 1px solid #aaa;
1440 font-family: verdana, tahoma, sans-serif;
1443 font-family: verdana, tahoma, sans-serif;
1446 text-decoration: none;
1448 border-bottom: 1px dotted #bbb;
1450 :link:hover, :visited:hover {
1463 background-color: #fff;
1464 border: 1px solid #aaa;
1468 font-weight: normal;
1490 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1495 <img src="$logo" alt="Catalyst Logo" />
1497 <p>Welcome to the world of Catalyst.
1498 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1499 framework will make web development something you had
1500 never expected it to be: Fun, rewarding, and quick.</p>
1501 <h2>What to do now?</h2>
1502 <p>That really depends on what <b>you</b> want to do.
1503 We do, however, provide you with a few starting points.</p>
1504 <p>If you want to jump right into web development with Catalyst
1505 you might want to start with a tutorial.</p>
1506 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1508 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1510 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1511 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1513 <h2>What to do next?</h2>
1514 <p>Next it's time to write an actual application. Use the
1515 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1516 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1517 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1518 they can save you a lot of work.</p>
1519 <pre><code>script/${prefix}_create.pl --help</code></pre>
1520 <p>Also, be sure to check out the vast and growing
1521 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1522 you are likely to find what you need there.
1526 <p>Catalyst has a very active community. Here are the main places to
1527 get in touch with us.</p>
1530 <a href="http://dev.catalyst.perl.org">Wiki</a>
1533 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1536 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1539 <h2>In conclusion</h2>
1540 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1541 as we enjoyed making it. Please contact us if you have ideas
1542 for improvement or other feedback.</p>
1550 =head1 INTERNAL METHODS
1552 These methods are not meant to be used by end users.
1554 =head2 $c->components
1556 Returns a hash of components.
1558 =head2 $c->context_class
1560 Returns or sets the context class.
1564 Returns a hashref containing coderefs and execution counts (needed for
1565 deep recursion detection).
1569 Returns the number of actions on the current internal execution stack.
1573 Dispatches a request to actions.
1577 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1579 =head2 $c->dispatcher_class
1581 Returns or sets the dispatcher class.
1583 =head2 $c->dump_these
1585 Returns a list of 2-element array references (name, structure) pairs
1586 that will be dumped on the error page in debug mode.
1592 [ Request => $c->req ],
1593 [ Response => $c->res ],
1594 [ Stash => $c->stash ],
1595 [ Config => $c->config ];
1598 =head2 $c->engine_class
1600 Returns or sets the engine class.
1602 =head2 $c->execute( $class, $coderef )
1604 Execute a coderef in given class and catch exceptions. Errors are available
1610 my ( $c, $class, $code ) = @_;
1611 $class = $c->component($class) || $class;
1614 if ( $c->depth >= $RECURSION ) {
1615 my $action = $code->reverse();
1616 $action = "/$action" unless $action =~ /->/;
1617 my $error = qq/Deep recursion detected calling "${action}"/;
1618 $c->log->error($error);
1624 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1626 push( @{ $c->stack }, $code );
1628 no warnings 'recursion';
1629 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1631 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1633 my $last = pop( @{ $c->stack } );
1635 if ( my $error = $@ ) {
1636 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1637 $error->rethrow if $c->depth > 1;
1639 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1640 $error->rethrow if $c->depth > 0;
1643 unless ( ref $error ) {
1644 no warnings 'uninitialized';
1646 my $class = $last->class;
1647 my $name = $last->name;
1648 $error = qq/Caught exception in $class->$name "$error"/;
1657 sub _stats_start_execute {
1658 my ( $c, $code ) = @_;
1659 my $appclass = ref($c) || $c;
1660 return if ( ( $code->name =~ /^_.*/ )
1661 && ( !$appclass->config->{show_internal_actions} ) );
1663 my $action_name = $code->reverse();
1664 $c->counter->{$action_name}++;
1666 my $action = $action_name;
1667 $action = "/$action" unless $action =~ /->/;
1669 # determine if the call was the result of a forward
1670 # this is done by walking up the call stack and looking for a calling
1671 # sub of Catalyst::forward before the eval
1673 for my $index ( 2 .. 11 ) {
1675 if ( ( caller($index) )[0] eq 'Catalyst'
1676 && ( caller($index) )[3] eq '(eval)' );
1678 if ( ( caller($index) )[3] =~ /forward$/ ) {
1679 $callsub = ( caller($index) )[3];
1680 $action = "-> $action";
1685 my $uid = $action_name . $c->counter->{$action_name};
1687 # is this a root-level call or a forwarded call?
1688 if ( $callsub =~ /forward$/ ) {
1689 my $parent = $c->stack->[-1];
1691 # forward, locate the caller
1692 if ( exists $c->counter->{"$parent"} ) {
1695 parent => "$parent" . $c->counter->{"$parent"},
1701 # forward with no caller may come from a plugin
1720 sub _stats_finish_execute {
1721 my ( $c, $info ) = @_;
1722 $c->stats->profile( end => $info );
1727 Finalizes the request.
1734 for my $error ( @{ $c->error } ) {
1735 $c->log->error($error);
1738 # Allow engine to handle finalize flow (for POE)
1739 my $engine = $c->engine;
1740 if ( my $code = $engine->can('finalize') ) {
1745 $c->finalize_uploads;
1748 if ( $#{ $c->error } >= 0 ) {
1752 $c->finalize_headers;
1755 if ( $c->request->method eq 'HEAD' ) {
1756 $c->response->body('');
1764 if ($c->use_stats) {
1765 my $elapsed = sprintf '%f', $c->stats->elapsed;
1766 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1768 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1771 return $c->response->status;
1774 =head2 $c->finalize_body
1780 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1782 =head2 $c->finalize_cookies
1788 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1790 =head2 $c->finalize_error
1796 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1798 =head2 $c->finalize_headers
1804 sub finalize_headers {
1807 my $response = $c->response; #accessor calls can add up?
1809 # Check if we already finalized headers
1810 return if $response->finalized_headers;
1813 if ( my $location = $response->redirect ) {
1814 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1815 $response->header( Location => $location );
1817 if ( !$response->has_body ) {
1818 # Add a default body if none is already present
1820 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1826 if ( $response->body && !$response->content_length ) {
1828 # get the length from a filehandle
1829 if ( blessed( $response->body ) && $response->body->can('read') )
1831 my $stat = stat $response->body;
1832 if ( $stat && $stat->size > 0 ) {
1833 $response->content_length( $stat->size );
1836 $c->log->warn('Serving filehandle without a content-length');
1840 # everything should be bytes at this point, but just in case
1841 $response->content_length( length( $response->body ) );
1846 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1847 $response->headers->remove_header("Content-Length");
1848 $response->body('');
1851 $c->finalize_cookies;
1853 $c->engine->finalize_headers( $c, @_ );
1856 $response->finalized_headers(1);
1859 =head2 $c->finalize_output
1861 An alias for finalize_body.
1863 =head2 $c->finalize_read
1865 Finalizes the input after reading is complete.
1869 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1871 =head2 $c->finalize_uploads
1873 Finalizes uploads. Cleans up any temporary files.
1877 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1879 =head2 $c->get_action( $action, $namespace )
1881 Gets an action in a given namespace.
1885 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1887 =head2 $c->get_actions( $action, $namespace )
1889 Gets all actions of a given name in a namespace and all parent
1894 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1896 =head2 $c->handle_request( $class, @arguments )
1898 Called to handle each HTTP request.
1902 sub handle_request {
1903 my ( $class, @arguments ) = @_;
1905 # Always expect worst case!
1908 if ($class->debug) {
1909 my $secs = time - $START || 1;
1910 my $av = sprintf '%.3f', $COUNT / $secs;
1911 my $time = localtime time;
1912 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1915 my $c = $class->prepare(@arguments);
1917 $status = $c->finalize;
1920 if ( my $error = $@ ) {
1922 $class->log->error(qq/Caught exception in engine "$error"/);
1927 if(my $coderef = $class->log->can('_flush')){
1928 $class->log->$coderef();
1933 =head2 $c->prepare( @arguments )
1935 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1941 my ( $class, @arguments ) = @_;
1944 # After the app/ctxt split, this should become an attribute based on something passed
1945 # into the application.
1946 $class->context_class( ref $class || $class ) unless $class->context_class;
1948 my $c = $class->context_class->new({});
1950 # For on-demand data
1951 $c->request->_context($c);
1952 $c->response->_context($c);
1954 #surely this is not the most efficient way to do things...
1955 $c->stats($class->stats_class->new)->enable($c->use_stats);
1957 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1960 #XXX reuse coderef from can
1961 # Allow engine to direct the prepare flow (for POE)
1962 if ( $c->engine->can('prepare') ) {
1963 $c->engine->prepare( $c, @arguments );
1966 $c->prepare_request(@arguments);
1967 $c->prepare_connection;
1968 $c->prepare_query_parameters;
1969 $c->prepare_headers;
1970 $c->prepare_cookies;
1973 # Prepare the body for reading, either by prepare_body
1974 # or the user, if they are using $c->read
1977 # Parse the body unless the user wants it on-demand
1978 unless ( ref($c)->config->{parse_on_demand} ) {
1983 my $method = $c->req->method || '';
1984 my $path = $c->req->path;
1985 $path = '/' unless length $path;
1986 my $address = $c->req->address || '';
1995 =head2 $c->prepare_action
1997 Prepares action. See L<Catalyst::Dispatcher>.
2001 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2003 =head2 $c->prepare_body
2005 Prepares message body.
2012 return if $c->request->_has_body;
2014 # Initialize on-demand data
2015 $c->engine->prepare_body( $c, @_ );
2016 $c->prepare_parameters;
2017 $c->prepare_uploads;
2020 =head2 $c->prepare_body_chunk( $chunk )
2022 Prepares a chunk of data before sending it to L<HTTP::Body>.
2024 See L<Catalyst::Engine>.
2028 sub prepare_body_chunk {
2030 $c->engine->prepare_body_chunk( $c, @_ );
2033 =head2 $c->prepare_body_parameters
2035 Prepares body parameters.
2039 sub prepare_body_parameters {
2041 $c->engine->prepare_body_parameters( $c, @_ );
2044 =head2 $c->prepare_connection
2046 Prepares connection.
2050 sub prepare_connection {
2052 $c->engine->prepare_connection( $c, @_ );
2055 =head2 $c->prepare_cookies
2061 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2063 =head2 $c->prepare_headers
2069 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2071 =head2 $c->prepare_parameters
2073 Prepares parameters.
2077 sub prepare_parameters {
2079 $c->prepare_body_parameters;
2080 $c->engine->prepare_parameters( $c, @_ );
2083 =head2 $c->prepare_path
2085 Prepares path and base.
2089 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2091 =head2 $c->prepare_query_parameters
2093 Prepares query parameters.
2097 sub prepare_query_parameters {
2100 $c->engine->prepare_query_parameters( $c, @_ );
2103 =head2 $c->log_request
2105 Writes information about the request to the debug logs. This includes:
2109 =item * Request method, path, and remote IP address
2111 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2113 =item * Request parameters
2115 =item * File uploads
2124 return unless $c->debug;
2126 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2127 my $request = $dump->[1];
2129 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2131 $path = '/' unless length $path;
2133 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2135 $c->log_request_headers($request->headers);
2137 if ( my $keywords = $request->query_keywords ) {
2138 $c->log->debug("Query keywords are: $keywords");
2141 $c->log_request_parameters( query => $request->query_parameters, body => $request->body_parameters );
2143 $c->log_request_uploads($request);
2146 =head2 $c->log_response
2148 Writes information about the response to the debug logs by calling
2149 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2156 return unless $c->debug;
2158 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2159 my $response = $dump->[1];
2161 $c->log_response_status_line($response);
2162 $c->log_response_headers($response->headers);
2165 =head2 $c->log_response_status_line($response)
2167 Writes one line of information about the response to the debug logs. This includes:
2171 =item * Response status code
2173 =item * Content-Type header (if present)
2175 =item * Content-Length header (if present)
2181 sub log_response_status_line {
2182 my ($c, $response) = @_;
2186 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2187 $response->status || 'unknown',
2188 $response->headers->header('Content-Type') || 'unknown',
2189 $response->headers->header('Content-Length') || 'unknown'
2194 =head2 $c->log_response_headers($headers);
2196 Hook method which can be wrapped by plugins to log the responseheaders.
2197 No-op in the default implementation.
2201 sub log_response_headers {}
2203 =head2 $c->log_request_parameters( query => {}, body => {} )
2205 Logs request parameters to debug logs
2209 sub log_request_parameters {
2211 my %all_params = @_;
2213 return unless $c->debug;
2215 my $column_width = Catalyst::Utils::term_width() - 44;
2216 foreach my $type (qw(query body)) {
2217 my $params = $all_params{$type};
2218 next if ! keys %$params;
2219 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2220 for my $key ( sort keys %$params ) {
2221 my $param = $params->{$key};
2222 my $value = defined($param) ? $param : '';
2223 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2225 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2229 =head2 $c->log_request_uploads
2231 Logs file uploads included in the request to the debug logs.
2232 The parameter name, filename, file type, and file size are all included in
2237 sub log_request_uploads {
2239 my $request = shift;
2240 return unless $c->debug;
2241 my $uploads = $request->uploads;
2242 if ( keys %$uploads ) {
2243 my $t = Text::SimpleTable->new(
2244 [ 12, 'Parameter' ],
2249 for my $key ( sort keys %$uploads ) {
2250 my $upload = $uploads->{$key};
2251 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2252 $t->row( $key, $u->filename, $u->type, $u->size );
2255 $c->log->debug( "File Uploads are:\n" . $t->draw );
2259 =head2 $c->log_request_headers($headers);
2261 Hook method which can be wrapped by plugins to log the request headers.
2262 No-op in the default implementation.
2266 sub log_request_headers {}
2268 =head2 $c->log_headers($type => $headers)
2270 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2277 my $headers = shift; # an HTTP::Headers instance
2279 return unless $c->debug;
2281 my $t = Text::SimpleTable->new( [ 35, 'Header Name' ], [ 40, 'Value' ] );
2284 my ( $name, $value ) = @_;
2285 $t->row( $name, $value );
2288 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2292 =head2 $c->prepare_read
2294 Prepares the input for reading.
2298 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2300 =head2 $c->prepare_request
2302 Prepares the engine request.
2306 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2308 =head2 $c->prepare_uploads
2314 sub prepare_uploads {
2317 $c->engine->prepare_uploads( $c, @_ );
2320 =head2 $c->prepare_write
2322 Prepares the output for writing.
2326 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2328 =head2 $c->request_class
2330 Returns or sets the request class.
2332 =head2 $c->response_class
2334 Returns or sets the response class.
2336 =head2 $c->read( [$maxlength] )
2338 Reads a chunk of data from the request body. This method is designed to
2339 be used in a while loop, reading C<$maxlength> bytes on every call.
2340 C<$maxlength> defaults to the size of the request if not specified.
2342 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2345 Warning: If you use read(), Catalyst will not process the body,
2346 so you will not be able to access POST parameters or file uploads via
2347 $c->request. You must handle all body parsing yourself.
2351 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2359 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2361 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2363 Sets an action in a given namespace.
2367 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2369 =head2 $c->setup_actions($component)
2371 Sets up actions for a component.
2375 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2377 =head2 $c->setup_components
2379 This method is called internally to set up the application's components.
2381 It finds modules by calling the L<locate_components> method, expands them to
2382 package names with the L<expand_component_module> method, and then installs
2383 each component into the application.
2385 The C<setup_components> config option is passed to both of the above methods.
2387 Installation of each component is performed by the L<setup_component> method,
2392 sub setup_components {
2395 my $config = $class->config->{ setup_components };
2397 my @comps = sort { length $a <=> length $b }
2398 $class->locate_components($config);
2399 my %comps = map { $_ => 1 } @comps;
2401 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2402 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2403 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2404 ) if $deprecatedcatalyst_component_names;
2406 for my $component ( @comps ) {
2408 # We pass ignore_loaded here so that overlay files for (e.g.)
2409 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2410 # we know M::P::O found a file on disk so this is safe
2412 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2414 # Needs to be done as soon as the component is loaded, as loading a sub-component
2415 # (next time round the loop) can cause us to get the wrong metaclass..
2416 $class->_controller_init_base_classes($component);
2419 for my $component (@comps) {
2420 my $instance = $class->components->{ $component } = $class->setup_component($component);
2421 my @expanded_components = $instance->can('expand_modules')
2422 ? $instance->expand_modules( $component, $config )
2423 : $class->expand_component_module( $component, $config );
2424 for my $component (@expanded_components) {
2425 next if $comps{$component};
2426 $class->_controller_init_base_classes($component); # Also cover inner packages
2427 $class->components->{ $component } = $class->setup_component($component);
2432 =head2 $c->locate_components( $setup_component_config )
2434 This method is meant to provide a list of component modules that should be
2435 setup for the application. By default, it will use L<Module::Pluggable>.
2437 Specify a C<setup_components> config option to pass additional options directly
2438 to L<Module::Pluggable>. To add additional search paths, specify a key named
2439 C<search_extra> as an array reference. Items in the array beginning with C<::>
2440 will have the application class name prepended to them.
2444 sub locate_components {
2448 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2449 my $extra = delete $config->{ search_extra } || [];
2451 push @paths, @$extra;
2453 my $locator = Module::Pluggable::Object->new(
2454 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2458 my @comps = $locator->plugins;
2463 =head2 $c->expand_component_module( $component, $setup_component_config )
2465 Components found by C<locate_components> will be passed to this method, which
2466 is expected to return a list of component (package) names to be set up.
2470 sub expand_component_module {
2471 my ($class, $module) = @_;
2472 return Devel::InnerPackage::list_packages( $module );
2475 =head2 $c->setup_component
2479 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2480 # nearest to Catalyst::Controller first, no matter what order stuff happens
2481 # to be loaded. There are TODO tests in Moose for this, see
2482 # f2391d17574eff81d911b97be15ea51080500003
2483 sub _controller_init_base_classes {
2484 my ($app_class, $component) = @_;
2485 return unless $component->isa('Catalyst::Controller');
2486 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2487 Moose::Meta::Class->initialize( $class )
2488 unless find_meta($class);
2492 sub setup_component {
2493 my( $class, $component ) = @_;
2495 unless ( $component->can( 'COMPONENT' ) ) {
2499 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2500 my $config = $class->config->{ $suffix } || {};
2501 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2502 # methods also pass it. local to avoid pointlessly shitting in config
2503 # for the debug screen, as $component is already the key name.
2504 local $config->{catalyst_component_name} = $component;
2506 my $instance = eval { $component->COMPONENT( $class, $config ); };
2508 if ( my $error = $@ ) {
2510 Catalyst::Exception->throw(
2511 message => qq/Couldn't instantiate component "$component", "$error"/
2515 unless (blessed $instance) {
2516 my $metaclass = Moose::Util::find_meta($component);
2517 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2518 my $component_method_from = $method_meta->associated_metaclass->name;
2519 my $value = defined($instance) ? $instance : 'undef';
2520 Catalyst::Exception->throw(
2522 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2528 =head2 $c->setup_dispatcher
2534 sub setup_dispatcher {
2535 my ( $class, $dispatcher ) = @_;
2538 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2541 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2542 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2545 unless ($dispatcher) {
2546 $dispatcher = $class->dispatcher_class;
2549 Class::MOP::load_class($dispatcher);
2551 # dispatcher instance
2552 $class->dispatcher( $dispatcher->new );
2555 =head2 $c->setup_engine
2562 my ( $class, $engine ) = @_;
2565 $engine = 'Catalyst::Engine::' . $engine;
2568 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2569 $engine = 'Catalyst::Engine::' . $env;
2572 if ( $ENV{MOD_PERL} ) {
2573 my $meta = Class::MOP::get_metaclass_by_name($class);
2575 # create the apache method
2576 $meta->add_method('apache' => sub { shift->engine->apache });
2578 my ( $software, $version ) =
2579 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2582 $version =~ s/(\.[^.]+)\./$1/g;
2584 if ( $software eq 'mod_perl' ) {
2588 if ( $version >= 1.99922 ) {
2589 $engine = 'Catalyst::Engine::Apache2::MP20';
2592 elsif ( $version >= 1.9901 ) {
2593 $engine = 'Catalyst::Engine::Apache2::MP19';
2596 elsif ( $version >= 1.24 ) {
2597 $engine = 'Catalyst::Engine::Apache::MP13';
2601 Catalyst::Exception->throw( message =>
2602 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2607 # install the correct mod_perl handler
2608 if ( $version >= 1.9901 ) {
2609 *handler = sub : method {
2610 shift->handle_request(@_);
2614 *handler = sub ($$) { shift->handle_request(@_) };
2619 elsif ( $software eq 'Zeus-Perl' ) {
2620 $engine = 'Catalyst::Engine::Zeus';
2624 Catalyst::Exception->throw(
2625 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2630 $engine = $class->engine_class;
2633 Class::MOP::load_class($engine);
2635 # check for old engines that are no longer compatible
2637 if ( $engine->isa('Catalyst::Engine::Apache')
2638 && !Catalyst::Engine::Apache->VERSION )
2643 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2644 && Catalyst::Engine::Server->VERSION le '0.02' )
2649 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2650 && $engine->VERSION eq '0.01' )
2655 elsif ($engine->isa('Catalyst::Engine::Zeus')
2656 && $engine->VERSION eq '0.01' )
2662 Catalyst::Exception->throw( message =>
2663 qq/Engine "$engine" is not supported by this version of Catalyst/
2668 $class->engine( $engine->new );
2671 =head2 $c->setup_home
2673 Sets up the home directory.
2678 my ( $class, $home ) = @_;
2680 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2684 $home ||= Catalyst::Utils::home($class);
2687 #I remember recently being scolded for assigning config values like this
2688 $class->config->{home} ||= $home;
2689 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2693 =head2 $c->setup_log
2695 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2696 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2699 This method also installs a C<debug> method that returns a true value into the
2700 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2701 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2703 Note that if the log has already been setup, by either a previous call to
2704 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2705 that this method won't actually set up the log object.
2710 my ( $class, $levels ) = @_;
2713 $levels =~ s/^\s+//;
2714 $levels =~ s/\s+$//;
2715 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2717 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2718 if ( defined $env_debug ) {
2719 $levels{debug} = 1 if $env_debug; # Ugly!
2720 delete($levels{debug}) unless $env_debug;
2723 unless ( $class->log ) {
2724 $class->log( Catalyst::Log->new(keys %levels) );
2727 if ( $levels{debug} ) {
2728 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2729 $class->log->debug('Debug messages enabled');
2733 =head2 $c->setup_plugins
2739 =head2 $c->setup_stats
2741 Sets up timing statistics class.
2746 my ( $class, $stats ) = @_;
2748 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2750 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2751 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2752 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2753 $class->log->debug('Statistics enabled');
2758 =head2 $c->registered_plugins
2760 Returns a sorted list of the plugins which have either been stated in the
2761 import list or which have been added via C<< MyApp->plugin(@args); >>.
2763 If passed a given plugin name, it will report a boolean value indicating
2764 whether or not that plugin is loaded. A fully qualified name is required if
2765 the plugin name does not begin with C<Catalyst::Plugin::>.
2767 if ($c->registered_plugins('Some::Plugin')) {
2775 sub registered_plugins {
2777 return sort keys %{ $proto->_plugins } unless @_;
2779 return 1 if exists $proto->_plugins->{$plugin};
2780 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2783 sub _register_plugin {
2784 my ( $proto, $plugin, $instant ) = @_;
2785 my $class = ref $proto || $proto;
2787 Class::MOP::load_class( $plugin );
2788 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2789 if $plugin->isa( 'Catalyst::Component' );
2790 $proto->_plugins->{$plugin} = 1;
2793 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2794 my @superclasses = ($plugin, $meta->superclasses );
2795 $meta->superclasses(@superclasses);
2797 unshift @{"$class\::ISA"}, $plugin;
2804 my ( $class, $plugins ) = @_;
2806 $class->_plugins( {} ) unless $class->_plugins;
2809 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2811 for my $plugin ( reverse @plugins ) {
2812 Class::MOP::load_class($plugin);
2813 my $meta = find_meta($plugin);
2814 next if $meta && $meta->isa('Moose::Meta::Role');
2816 $class->_register_plugin($plugin);
2821 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2822 map { find_meta($_) }
2825 Moose::Util::apply_all_roles(
2833 Returns an arrayref of the internal execution stack (actions that are
2834 currently executing).
2836 =head2 $c->stats_class
2838 Returns or sets the stats (timing statistics) class.
2840 =head2 $c->use_stats
2842 Returns 1 when stats collection is enabled. Stats collection is enabled
2843 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2844 environment variable is set.
2846 Note that this is a static method, not an accessor and should be overridden
2847 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2854 =head2 $c->write( $data )
2856 Writes $data to the output stream. When using this method directly, you
2857 will need to manually set the C<Content-Length> header to the length of
2858 your output data, if known.
2865 # Finalize headers if someone manually writes output
2866 $c->finalize_headers;
2868 return $c->engine->write( $c, @_ );
2873 Returns the Catalyst version number. Mostly useful for "powered by"
2874 messages in template systems.
2878 sub version { return $Catalyst::VERSION }
2880 =head1 CONFIGURATION
2882 There are a number of 'base' config variables which can be set:
2888 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2892 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2896 C<disable_component_resolution_regex_fallback> - Turns
2897 off the deprecated component resolution functionality so
2898 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2899 are called then regex search will not be attempted on string values and
2900 instead C<undef> will be returned.
2904 C<home> - The application home directory. In an uninstalled application,
2905 this is the top level application directory. In an installed application,
2906 this will be the directory containing C<< MyApp.pm >>.
2910 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2914 C<name> - The name of the application in debug messages and the debug and
2919 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2920 until it is accessed. This allows you to (for example) check authentication (and reject
2921 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2925 C<root> - The root directory for templates. Usually this is just a
2926 subdirectory of the home directory, but you can set it to change the
2927 templates to a different directory.
2931 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2932 namespaces from which components will be loaded (and constructed and stored in
2933 C<< $c->components >>).
2937 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2938 to be shown in hit debug tables in the test server.
2942 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2946 =head1 INTERNAL ACTIONS
2948 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2949 C<_ACTION>, and C<_END>. These are by default not shown in the private
2950 action table, but you can make them visible with a config parameter.
2952 MyApp->config(show_internal_actions => 1);
2954 =head1 ON-DEMAND PARSER
2956 The request body is usually parsed at the beginning of a request,
2957 but if you want to handle input yourself, you can enable on-demand
2958 parsing with a config parameter.
2960 MyApp->config(parse_on_demand => 1);
2962 =head1 PROXY SUPPORT
2964 Many production servers operate using the common double-server approach,
2965 with a lightweight frontend web server passing requests to a larger
2966 backend server. An application running on the backend server must deal
2967 with two problems: the remote user always appears to be C<127.0.0.1> and
2968 the server's hostname will appear to be C<localhost> regardless of the
2969 virtual host that the user connected through.
2971 Catalyst will automatically detect this situation when you are running
2972 the frontend and backend servers on the same machine. The following
2973 changes are made to the request.
2975 $c->req->address is set to the user's real IP address, as read from
2976 the HTTP X-Forwarded-For header.
2978 The host value for $c->req->base and $c->req->uri is set to the real
2979 host, as read from the HTTP X-Forwarded-Host header.
2981 Additionally, you may be running your backend application on an insecure
2982 connection (port 80) while your frontend proxy is running under SSL. If there
2983 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2984 tell Catalyst what port the frontend listens on. This will allow all URIs to
2985 be created properly.
2987 In the case of passing in:
2989 X-Forwarded-Port: 443
2991 All calls to C<uri_for> will result in an https link, as is expected.
2993 Obviously, your web server must support these headers for this to work.
2995 In a more complex server farm environment where you may have your
2996 frontend proxy server(s) on different machines, you will need to set a
2997 configuration option to tell Catalyst to read the proxied data from the
3000 MyApp->config(using_frontend_proxy => 1);
3002 If you do not wish to use the proxy support at all, you may set:
3004 MyApp->config(ignore_frontend_proxy => 1);
3006 =head1 THREAD SAFETY
3008 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3009 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3010 believe the Catalyst core to be thread-safe.
3012 If you plan to operate in a threaded environment, remember that all other
3013 modules you are using must also be thread-safe. Some modules, most notably
3014 L<DBD::SQLite>, are not thread-safe.
3020 Join #catalyst on irc.perl.org.
3024 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3025 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3029 http://catalyst.perl.org
3033 http://dev.catalyst.perl.org
3037 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3039 =head2 L<Catalyst::Manual> - The Catalyst Manual
3041 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3043 =head2 L<Catalyst::Engine> - Core engine
3045 =head2 L<Catalyst::Log> - Log class.
3047 =head2 L<Catalyst::Request> - Request object
3049 =head2 L<Catalyst::Response> - Response object
3051 =head2 L<Catalyst::Test> - The test suite.
3053 =head1 PROJECT FOUNDER
3055 sri: Sebastian Riedel <sri@cpan.org>
3061 acme: Leon Brocard <leon@astray.com>
3063 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3067 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3071 andyg: Andy Grundman <andy@hybridized.org>
3073 audreyt: Audrey Tang
3075 bricas: Brian Cassidy <bricas@cpan.org>
3077 Caelum: Rafael Kitover <rkitover@io.com>
3079 chansen: Christian Hansen
3081 chicks: Christopher Hicks
3083 Chisel Wright C<pause@herlpacker.co.uk>
3085 Danijel Milicevic C<me@danijel.de>
3087 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3089 David Naughton, C<naughton@umn.edu>
3093 dhoss: Devin Austin <dhoss@cpan.org>
3095 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3099 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3101 esskar: Sascha Kiefer
3103 fireartist: Carl Franks <cfranks@cpan.org>
3105 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3107 gabb: Danijel Milicevic
3111 Gavin Henry C<ghenry@perl.me.uk>
3115 groditi: Guillermo Roditi <groditi@gmail.com>
3117 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3119 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3121 jcamacho: Juan Camacho
3123 jester: Jesse Sheidlower C<jester@panix.com>
3125 jhannah: Jay Hannah <jay@jays.net>
3131 jon: Jon Schutz <jjschutz@cpan.org>
3133 Jonathan Rockway C<< <jrockway@cpan.org> >>
3135 Kieren Diment C<kd@totaldatasolution.com>
3137 konobi: Scott McWhirter <konobi@cpan.org>
3139 marcus: Marcus Ramberg <mramberg@cpan.org>
3141 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3143 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3147 naughton: David Naughton
3149 ningu: David Kamholz <dkamholz@cpan.org>
3151 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3153 numa: Dan Sully <daniel@cpan.org>
3159 omega: Andreas Marienborg
3161 Oleg Kostyuk <cub.uanic@gmail.com>
3163 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3165 rafl: Florian Ragwitz <rafl@debian.org>
3167 random: Roland Lammel <lammel@cpan.org>
3169 Robert Sedlacek C<< <rs@474.at> >>
3173 szbalint: Balint Szilakszi <szbalint@cpan.org>
3175 t0m: Tomas Doran <bobtfish@bobtfish.net>
3179 Viljo Marrandi C<vilts@yahoo.com>
3181 Will Hawes C<info@whawes.co.uk>
3183 willert: Sebastian Willert <willert@cpan.org>
3185 Yuval Kogman, C<nothingmuch@woobling.org>
3189 This library is free software. You can redistribute it and/or modify it under
3190 the same terms as Perl itself.
3196 __PACKAGE__->meta->make_immutable;