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.80023';
85 my ( $class, @arguments ) = @_;
87 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
89 return unless $class eq 'Catalyst';
91 my $caller = caller();
92 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 unless ( $caller->isa('Catalyst') ) {
96 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
97 $meta->superclasses(@superclasses);
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
106 $caller->arguments( [@arguments] );
110 sub _application { $_[0] }
114 Catalyst - The Elegant MVC Web Application Framework
118 See the L<Catalyst::Manual> distribution for comprehensive
119 documentation and tutorials.
121 # Install Catalyst::Devel for helpers and other development tools
122 # use the helper to create a new application
125 # add models, views, controllers
126 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
127 script/myapp_create.pl view MyTemplate TT
128 script/myapp_create.pl controller Search
130 # built in testserver -- use -r to restart automatically on changes
131 # --help to see all available options
132 script/myapp_server.pl
134 # command line testing interface
135 script/myapp_test.pl /yada
138 use Catalyst qw/-Debug/; # include plugins here as well
140 ### In lib/MyApp/Controller/Root.pm (autocreated)
141 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
142 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
143 $c->stash->{template} = 'foo.tt'; # set the template
144 # lookup something from db -- stash vars are passed to TT
146 $c->model('Database::Foo')->search( { country => $args[0] } );
147 if ( $c->req->params->{bar} ) { # access GET or POST parameters
148 $c->forward( 'bar' ); # process another action
149 # do something else after forward returns
153 # The foo.tt TT template can use the stash data from the database
154 [% WHILE (item = data.next) %]
158 # called for /bar/of/soap, /bar/of/soap/10, etc.
159 sub bar : Path('/bar/of/soap') { ... }
161 # called for all actions, from the top-most controller downwards
163 my ( $self, $c ) = @_;
164 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
165 $c->res->redirect( '/login' ); # require login
166 return 0; # abort request and go immediately to end()
168 return 1; # success; carry on to next action
171 # called after all actions are finished
173 my ( $self, $c ) = @_;
174 if ( scalar @{ $c->error } ) { ... } # handle errors
175 return if $c->res->body; # already have a response
176 $c->forward( 'MyApp::View::TT' ); # render template
179 ### in MyApp/Controller/Foo.pm
180 # called for /foo/bar
181 sub bar : Local { ... }
183 # called for /blargle
184 sub blargle : Global { ... }
186 # an index action matches /foo, but not /foo/1, etc.
187 sub index : Private { ... }
189 ### in MyApp/Controller/Foo/Bar.pm
190 # called for /foo/bar/baz
191 sub baz : Local { ... }
193 # first Root auto is called, then Foo auto, then this
194 sub auto : Private { ... }
196 # powerful regular expression paths are also possible
197 sub details : Regex('^product/(\w+)/details$') {
198 my ( $self, $c ) = @_;
199 # extract the (\w+) from the URI
200 my $product = $c->req->captures->[0];
203 See L<Catalyst::Manual::Intro> for additional information.
207 Catalyst is a modern framework for making web applications without the
208 pain usually associated with this process. This document is a reference
209 to the main Catalyst application. If you are a new user, we suggest you
210 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
212 See L<Catalyst::Manual> for more documentation.
214 Catalyst plugins can be loaded by naming them as arguments to the "use
215 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
216 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
219 use Catalyst qw/My::Module/;
221 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
222 fully qualify the name by using a unary plus:
226 +Fully::Qualified::Plugin::Name
229 Special flags like C<-Debug> and C<-Engine> can also be specified as
230 arguments when Catalyst is loaded:
232 use Catalyst qw/-Debug My::Module/;
234 The position of plugins and flags in the chain is important, because
235 they are loaded in the order in which they appear.
237 The following flags are supported:
241 Enables debug output. You can also force this setting from the system
242 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
243 settings override the application, with <MYAPP>_DEBUG having the highest
246 This sets the log level to 'debug' and enables full debug output on the
247 error screen. If you only want the latter, see L<< $c->debug >>.
251 Forces Catalyst to use a specific engine. Omit the
252 C<Catalyst::Engine::> prefix of the engine name, i.e.:
254 use Catalyst qw/-Engine=CGI/;
258 Forces Catalyst to use a specific home directory, e.g.:
260 use Catalyst qw[-Home=/usr/mst];
262 This can also be done in the shell environment by setting either the
263 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
264 is replaced with the uppercased name of your application, any "::" in
265 the name will be replaced with underscores, e.g. MyApp::Web should use
266 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
268 If none of these are set, Catalyst will attempt to automatically detect the
269 home directory. If you are working in a development envirnoment, Catalyst
270 will try and find the directory containing either Makefile.PL, Build.PL or
271 dist.ini. If the application has been installed into the system (i.e.
272 you have done C<make install>), then Catalyst will use the path to your
273 application module, without the .pm extension (ie, /foo/MyApp if your
274 application was installed at /foo/MyApp.pm)
278 use Catalyst '-Log=warn,fatal,error';
280 Specifies a comma-delimited list of log levels.
284 Enables statistics collection and reporting.
286 use Catalyst qw/-Stats=1/;
288 You can also force this setting from the system environment with CATALYST_STATS
289 or <MYAPP>_STATS. The environment settings override the application, with
290 <MYAPP>_STATS having the highest priority.
292 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
296 =head2 INFORMATION ABOUT THE CURRENT REQUEST
300 Returns a L<Catalyst::Action> object for the current action, which
301 stringifies to the action name. See L<Catalyst::Action>.
305 Returns the namespace of the current action, i.e., the URI prefix
306 corresponding to the controller of the current action. For example:
308 # in Controller::Foo::Bar
309 $c->namespace; # returns 'foo/bar';
315 Returns the current L<Catalyst::Request> object, giving access to
316 information about the current client request (including parameters,
317 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
319 =head2 REQUEST FLOW HANDLING
321 =head2 $c->forward( $action [, \@arguments ] )
323 =head2 $c->forward( $class, $method, [, \@arguments ] )
325 Forwards processing to another action, by its private name. If you give a
326 class name but no method, C<process()> is called. You may also optionally
327 pass arguments in an arrayref. The action will receive the arguments in
328 C<@_> and C<< $c->req->args >>. Upon returning from the function,
329 C<< $c->req->args >> will be restored to the previous values.
331 Any data C<return>ed from the action forwarded to, will be returned by the
334 my $foodata = $c->forward('/foo');
335 $c->forward('index');
336 $c->forward(qw/Model::DBIC::Foo do_stuff/);
337 $c->forward('View::TT');
339 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
340 an C<< eval { } >> around the call (actually
341 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
342 all 'dies' within the called action. If you want C<die> to propagate you
343 need to do something like:
346 die join "\n", @{ $c->error } if @{ $c->error };
348 Or make sure to always return true values from your actions and write
351 $c->forward('foo') || return;
353 Another note is that C<< $c->forward >> always returns a scalar because it
354 actually returns $c->state which operates in a scalar context.
355 Thus, something like:
359 in an action that is forwarded to is going to return a scalar,
360 i.e. how many items are in that array, which is probably not what you want.
361 If you need to return an array then return a reference to it,
364 $c->stash->{array} = \@array;
366 and access it from the stash.
370 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
372 =head2 $c->detach( $action [, \@arguments ] )
374 =head2 $c->detach( $class, $method, [, \@arguments ] )
378 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
379 doesn't return to the previous action when processing is finished.
381 When called with no arguments it escapes the processing chain entirely.
385 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
387 =head2 $c->visit( $action [, \@captures, \@arguments ] )
389 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
391 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
392 but does a full dispatch, instead of just calling the new C<$action> /
393 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
394 you go to are called, just like a new request.
396 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
397 This means, for example, that C<< $c->action >> methods such as
398 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
399 L<reverse|Catalyst::Action/reverse> return information for the visited action
400 when they are invoked within the visited action. This is different from the
401 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
402 continues to use the $c->action object from the caller action even when
403 invoked from the callee.
405 C<< $c->stash >> is kept unchanged.
407 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
408 allows you to "wrap" another action, just as it would have been called by
409 dispatching from a URL, while the analogous
410 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
411 transfer control to another action as if it had been reached directly from a URL.
415 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
417 =head2 $c->go( $action [, \@captures, \@arguments ] )
419 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
421 The relationship between C<go> and
422 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
423 the relationship between
424 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
425 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
426 C<< $c->go >> will perform a full dispatch on the specified action or method,
427 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
428 C<go> escapes the processing of the current request chain on completion, and
429 does not return to its caller.
433 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
439 Returns the current L<Catalyst::Response> object, see there for details.
443 Returns a hashref to the stash, which may be used to store data and pass
444 it between components during a request. You can also set hash keys by
445 passing arguments. The stash is automatically sent to the view. The
446 stash is cleared at the end of a request; it cannot be used for
447 persistent storage (for this you must use a session; see
448 L<Catalyst::Plugin::Session> for a complete system integrated with
451 $c->stash->{foo} = $bar;
452 $c->stash( { moose => 'majestic', qux => 0 } );
453 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
455 # stash is automatically passed to the view for use in a template
456 $c->forward( 'MyApp::View::TT' );
460 around stash => sub {
463 my $stash = $orig->($c);
465 my $new_stash = @_ > 1 ? {@_} : $_[0];
466 croak('stash takes a hash or hashref') unless ref $new_stash;
467 foreach my $key ( keys %$new_stash ) {
468 $stash->{$key} = $new_stash->{$key};
478 =head2 $c->error($error, ...)
480 =head2 $c->error($arrayref)
482 Returns an arrayref containing error messages. If Catalyst encounters an
483 error while processing a request, it stores the error in $c->error. This
484 method should only be used to store fatal error messages.
486 my @error = @{ $c->error };
490 $c->error('Something bad happened');
497 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
498 croak @$error unless ref $c;
499 push @{ $c->{error} }, @$error;
501 elsif ( defined $_[0] ) { $c->{error} = undef }
502 return $c->{error} || [];
508 Contains the return value of the last executed action.
509 Note that << $c->state >> operates in a scalar context which means that all
510 values it returns are scalar.
512 =head2 $c->clear_errors
514 Clear errors. You probably don't want to clear the errors unless you are
515 implementing a custom error screen.
517 This is equivalent to running
528 sub _comp_search_prefixes {
530 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
533 # search components given a name and some prefixes
534 sub _comp_names_search_prefixes {
535 my ( $c, $name, @prefixes ) = @_;
536 my $appclass = ref $c || $c;
537 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
538 $filter = qr/$filter/; # Compile regex now rather than once per loop
540 # map the original component name to the sub part that we will search against
541 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
542 grep { /$filter/ } keys %{ $c->components };
544 # undef for a name will return all
545 return keys %eligible if !defined $name;
547 my $query = ref $name ? $name : qr/^$name$/i;
548 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
550 return @result if @result;
552 # if we were given a regexp to search against, we're done.
555 # skip regexp fallback if configured
557 if $appclass->config->{disable_component_resolution_regex_fallback};
561 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
563 # no results? try against full names
565 @result = grep { m{$query} } keys %eligible;
568 # don't warn if we didn't find any results, it just might not exist
570 # Disgusting hack to work out correct method name
571 my $warn_for = lc $prefixes[0];
572 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
573 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
574 "component resolution is unreliable and unsafe.";
575 my $short = $result[0];
576 # remove the component namespace prefix
577 $short =~ s/.*?(Model|Controller|View):://;
578 my $shortmess = Carp::shortmess('');
579 if ($shortmess =~ m#Catalyst/Plugin#) {
580 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
582 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
583 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
584 "component's config";
586 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
587 "but if you really wanted to search, pass in a regexp as the argument " .
588 "like so: \$c->${warn_for}(qr/${name}/)";
590 $c->log->warn( "${msg}$shortmess" );
596 # Find possible names for a prefix
598 my ( $c, @prefixes ) = @_;
599 my $appclass = ref $c || $c;
601 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
603 my @names = map { s{$filter}{}; $_; }
604 $c->_comp_names_search_prefixes( undef, @prefixes );
609 # Filter a component before returning by calling ACCEPT_CONTEXT if available
610 sub _filter_component {
611 my ( $c, $comp, @args ) = @_;
613 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
614 return $comp->ACCEPT_CONTEXT( $c, @args );
620 =head2 COMPONENT ACCESSORS
622 =head2 $c->controller($name)
624 Gets a L<Catalyst::Controller> instance by name.
626 $c->controller('Foo')->do_stuff;
628 If the name is omitted, will return the controller for the dispatched
631 If you want to search for controllers, pass in a regexp as the argument.
633 # find all controllers that start with Foo
634 my @foo_controllers = $c->controller(qr{^Foo});
640 my ( $c, $name, @args ) = @_;
642 my $appclass = ref($c) || $c;
644 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
645 my $comps = $c->components;
646 my $check = $appclass."::Controller::".$name;
647 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
649 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
650 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
651 return $c->_filter_component( $result[ 0 ], @args );
654 return $c->component( $c->action->class );
657 =head2 $c->model($name)
659 Gets a L<Catalyst::Model> instance by name.
661 $c->model('Foo')->do_stuff;
663 Any extra arguments are directly passed to ACCEPT_CONTEXT.
665 If the name is omitted, it will look for
666 - a model object in $c->stash->{current_model_instance}, then
667 - a model name in $c->stash->{current_model}, then
668 - a config setting 'default_model', or
669 - check if there is only one model, and return it if that's the case.
671 If you want to search for models, pass in a regexp as the argument.
673 # find all models that start with Foo
674 my @foo_models = $c->model(qr{^Foo});
679 my ( $c, $name, @args ) = @_;
680 my $appclass = ref($c) || $c;
682 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
683 my $comps = $c->components;
684 my $check = $appclass."::Model::".$name;
685 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
687 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
688 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
689 return $c->_filter_component( $result[ 0 ], @args );
693 return $c->stash->{current_model_instance}
694 if $c->stash->{current_model_instance};
695 return $c->model( $c->stash->{current_model} )
696 if $c->stash->{current_model};
698 return $c->model( $appclass->config->{default_model} )
699 if $appclass->config->{default_model};
701 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
704 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
705 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
706 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
707 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
708 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
711 return $c->_filter_component( $comp );
715 =head2 $c->view($name)
717 Gets a L<Catalyst::View> instance by name.
719 $c->view('Foo')->do_stuff;
721 Any extra arguments are directly passed to ACCEPT_CONTEXT.
723 If the name is omitted, it will look for
724 - a view object in $c->stash->{current_view_instance}, then
725 - a view name in $c->stash->{current_view}, then
726 - a config setting 'default_view', or
727 - check if there is only one view, and return it if that's the case.
729 If you want to search for views, pass in a regexp as the argument.
731 # find all views that start with Foo
732 my @foo_views = $c->view(qr{^Foo});
737 my ( $c, $name, @args ) = @_;
739 my $appclass = ref($c) || $c;
741 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
742 my $comps = $c->components;
743 my $check = $appclass."::View::".$name;
744 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
746 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
747 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
748 return $c->_filter_component( $result[ 0 ], @args );
752 return $c->stash->{current_view_instance}
753 if $c->stash->{current_view_instance};
754 return $c->view( $c->stash->{current_view} )
755 if $c->stash->{current_view};
757 return $c->view( $appclass->config->{default_view} )
758 if $appclass->config->{default_view};
760 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
763 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
764 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
765 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
766 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
767 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
770 return $c->_filter_component( $comp );
773 =head2 $c->controllers
775 Returns the available names which can be passed to $c->controller
781 return $c->_comp_names(qw/Controller C/);
786 Returns the available names which can be passed to $c->model
792 return $c->_comp_names(qw/Model M/);
798 Returns the available names which can be passed to $c->view
804 return $c->_comp_names(qw/View V/);
807 =head2 $c->comp($name)
809 =head2 $c->component($name)
811 Gets a component object by name. This method is not recommended,
812 unless you want to get a specific component by full
813 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
814 should be used instead.
816 If C<$name> is a regexp, a list of components matched against the full
817 component name will be returned.
819 If Catalyst can't find a component by name, it will fallback to regex
820 matching by default. To disable this behaviour set
821 disable_component_resolution_regex_fallback to a true value.
823 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
828 my ( $c, $name, @args ) = @_;
831 my $comps = $c->components;
834 # is it the exact name?
835 return $c->_filter_component( $comps->{ $name }, @args )
836 if exists $comps->{ $name };
838 # perhaps we just omitted "MyApp"?
839 my $composed = ( ref $c || $c ) . "::${name}";
840 return $c->_filter_component( $comps->{ $composed }, @args )
841 if exists $comps->{ $composed };
843 # search all of the models, views and controllers
844 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
845 return $c->_filter_component( $comp, @args ) if $comp;
848 # This is here so $c->comp( '::M::' ) works
849 my $query = ref $name ? $name : qr{$name}i;
851 my @result = grep { m{$query} } keys %{ $c->components };
852 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
855 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
856 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
857 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
858 return $c->_filter_component( $result[ 0 ], @args );
861 # I would expect to return an empty list here, but that breaks back-compat
865 return sort keys %{ $c->components };
868 =head2 CLASS DATA AND HELPER CLASSES
872 Returns or takes a hashref containing the application's configuration.
874 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
876 You can also use a C<YAML>, C<XML> or L<Config::General> config file
877 like C<myapp.conf> in your applications home directory. See
878 L<Catalyst::Plugin::ConfigLoader>.
880 =head3 Cascading configuration
882 The config method is present on all Catalyst components, and configuration
883 will be merged when an application is started. Configuration loaded with
884 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
885 followed by configuration in your top level C<MyApp> class. These two
886 configurations are merged, and then configuration data whose hash key matches a
887 component name is merged with configuration for that component.
889 The configuration for a component is then passed to the C<new> method when a
890 component is constructed.
894 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
895 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
897 will mean that C<MyApp::Model::Foo> receives the following data when
900 MyApp::Model::Foo->new({
908 around config => sub {
912 croak('Setting config after setup has been run is not allowed.')
913 if ( @_ and $c->setup_finished );
920 Returns the logging object instance. Unless it is already set, Catalyst
921 sets this up with a L<Catalyst::Log> object. To use your own log class,
922 set the logger with the C<< __PACKAGE__->log >> method prior to calling
923 C<< __PACKAGE__->setup >>.
925 __PACKAGE__->log( MyLogger->new );
930 $c->log->info( 'Now logging with my own logger!' );
932 Your log class should implement the methods described in
938 Returns 1 if debug mode is enabled, 0 otherwise.
940 You can enable debug mode in several ways:
944 =item By calling myapp_server.pl with the -d flag
946 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
948 =item The -Debug option in your MyApp.pm
950 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
954 The first three also set the log level to 'debug'.
956 Calling C<< $c->debug(1) >> has no effect.
962 =head2 $c->dispatcher
964 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
968 Returns the engine instance. See L<Catalyst::Engine>.
971 =head2 UTILITY METHODS
973 =head2 $c->path_to(@path)
975 Merges C<@path> with C<< $c->config->{home} >> and returns a
976 L<Path::Class::Dir> object. Note you can usually use this object as
977 a filename, but sometimes you will have to explicitly stringify it
978 yourself by calling the C<< ->stringify >> method.
982 $c->path_to( 'db', 'sqlite.db' );
987 my ( $c, @path ) = @_;
988 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
989 if ( -d $path ) { return $path }
990 else { return Path::Class::File->new( $c->config->{home}, @path ) }
993 =head2 $c->plugin( $name, $class, @args )
995 Helper method for plugins. It creates a class data accessor/mutator and
996 loads and instantiates the given class.
998 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1000 $c->prototype->define_javascript_functions;
1002 B<Note:> This method of adding plugins is deprecated. The ability
1003 to add plugins like this B<will be removed> in a Catalyst 5.81.
1004 Please do not use this functionality in new code.
1009 my ( $class, $name, $plugin, @args ) = @_;
1011 # See block comment in t/unit_core_plugin.t
1012 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1014 $class->_register_plugin( $plugin, 1 );
1016 eval { $plugin->import };
1017 $class->mk_classdata($name);
1019 eval { $obj = $plugin->new(@args) };
1022 Catalyst::Exception->throw( message =>
1023 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1026 $class->$name($obj);
1027 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1033 Initializes the dispatcher and engine, loads any plugins, and loads the
1034 model, view, and controller components. You may also specify an array
1035 of plugins to load here, if you choose to not load them in the C<use
1039 MyApp->setup( qw/-Debug/ );
1044 my ( $class, @arguments ) = @_;
1045 croak('Running setup more than once')
1046 if ( $class->setup_finished );
1048 unless ( $class->isa('Catalyst') ) {
1050 Catalyst::Exception->throw(
1051 message => qq/'$class' does not inherit from Catalyst/ );
1054 if ( $class->arguments ) {
1055 @arguments = ( @arguments, @{ $class->arguments } );
1061 foreach (@arguments) {
1065 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1067 elsif (/^-(\w+)=?(.*)$/) {
1068 $flags->{ lc $1 } = $2;
1071 push @{ $flags->{plugins} }, $_;
1075 $class->setup_home( delete $flags->{home} );
1077 $class->setup_log( delete $flags->{log} );
1078 $class->setup_plugins( delete $flags->{plugins} );
1079 $class->setup_dispatcher( delete $flags->{dispatcher} );
1080 $class->setup_engine( delete $flags->{engine} );
1081 $class->setup_stats( delete $flags->{stats} );
1083 for my $flag ( sort keys %{$flags} ) {
1085 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1086 &$code( $class, delete $flags->{$flag} );
1089 $class->log->warn(qq/Unknown flag "$flag"/);
1093 eval { require Catalyst::Devel; };
1094 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1095 $class->log->warn(<<"EOF");
1096 You are running an old script!
1098 Please update by running (this will overwrite existing files):
1099 catalyst.pl -force -scripts $class
1101 or (this will not overwrite existing files):
1102 catalyst.pl -scripts $class
1107 if ( $class->debug ) {
1108 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1111 my $column_width = Catalyst::Utils::term_width() - 6;
1112 my $t = Text::SimpleTable->new($column_width);
1113 $t->row($_) for @plugins;
1114 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1117 my $dispatcher = $class->dispatcher;
1118 my $engine = $class->engine;
1119 my $home = $class->config->{home};
1121 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1122 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1126 ? $class->log->debug(qq/Found home "$home"/)
1127 : $class->log->debug(qq/Home "$home" doesn't exist/)
1128 : $class->log->debug(q/Couldn't find home/);
1131 # Call plugins setup, this is stupid and evil.
1132 # Also screws C3 badly on 5.10, hack to avoid.
1134 no warnings qw/redefine/;
1135 local *setup = sub { };
1136 $class->setup unless $Catalyst::__AM_RESTARTING;
1139 # Initialize our data structure
1140 $class->components( {} );
1142 $class->setup_components;
1144 if ( $class->debug ) {
1145 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1146 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1147 for my $comp ( sort keys %{ $class->components } ) {
1148 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1149 $t->row( $comp, $type );
1151 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1152 if ( keys %{ $class->components } );
1155 # Add our self to components, since we are also a component
1156 if( $class->isa('Catalyst::Controller') ){
1157 $class->components->{$class} = $class;
1160 $class->setup_actions;
1162 if ( $class->debug ) {
1163 my $name = $class->config->{name} || 'Application';
1164 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1167 # Make sure that the application class becomes immutable at this point,
1168 B::Hooks::EndOfScope::on_scope_end {
1170 my $meta = Class::MOP::get_metaclass_by_name($class);
1173 && ! { $meta->immutable_options }->{replace_constructor}
1175 $class->isa('Class::Accessor::Fast')
1176 || $class->isa('Class::Accessor')
1179 warn "You made your application class ($class) immutable, "
1180 . "but did not inline the\nconstructor. "
1181 . "This will break catalyst, as your app \@ISA "
1182 . "Class::Accessor(::Fast)?\nPlease pass "
1183 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1185 $meta->make_immutable(
1186 replace_constructor => 1,
1187 ) unless $meta->is_immutable;
1190 if ($class->config->{case_sensitive}) {
1191 $class->log->warn($class . "->config->{case_sensitive} is set.");
1192 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1195 $class->setup_finalize;
1196 # Should be the last thing we do so that user things hooking
1197 # setup_finalize can log..
1198 $class->log->_flush() if $class->log->can('_flush');
1199 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1202 =head2 $app->setup_finalize
1204 A hook to attach modifiers to. This method does not do anything except set the
1205 C<setup_finished> accessor.
1207 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1211 after setup_finalize => sub {
1219 sub setup_finalize {
1221 $class->setup_finished(1);
1224 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1226 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1228 Constructs an absolute L<URI> object based on the application root, the
1229 provided path, and the additional arguments and query parameters provided.
1230 When used as a string, provides a textual URI.
1232 If no arguments are provided, the URI for the current action is returned.
1233 To return the current action and also provide @args, use
1234 C<< $c->uri_for( $c->action, @args ) >>.
1236 If the first argument is a string, it is taken as a public URI path relative
1237 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1238 relative to the application root (if it does). It is then merged with
1239 C<< $c->request->base >>; any C<@args> are appended as additional path
1240 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1242 If the first argument is a L<Catalyst::Action> it represents an action which
1243 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1244 optional C<\@captures> argument (an arrayref) allows passing the captured
1245 variables that are needed to fill in the paths of Chained and Regex actions;
1246 once the path is resolved, C<uri_for> continues as though a path was
1247 provided, appending any arguments or parameters and creating an absolute
1250 The captures for the current request can be found in
1251 C<< $c->request->captures >>, and actions can be resolved using
1252 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1253 path, use C<< $c->uri_for_action >> instead.
1255 # Equivalent to $c->req->uri
1256 $c->uri_for($c->action, $c->req->captures,
1257 @{ $c->req->args }, $c->req->params);
1259 # For the Foo action in the Bar controller
1260 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1262 # Path to a static resource
1263 $c->uri_for('/static/images/logo.png');
1268 my ( $c, $path, @args ) = @_;
1270 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1271 $path = $path->path_prefix;
1276 undef($path) if (defined $path && $path eq '');
1279 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1281 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1282 foreach my $arg (@args) {
1283 utf8::encode($arg) if utf8::is_utf8($arg);
1284 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1287 if ( blessed($path) ) { # action object
1288 s|/|%2F|g for @args;
1289 my $captures = [ map { s|/|%2F|g; $_; }
1290 ( scalar @args && ref $args[0] eq 'ARRAY'
1294 foreach my $capture (@$captures) {
1295 utf8::encode($capture) if utf8::is_utf8($capture);
1296 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1300 $path = $c->dispatcher->uri_for_action($action, $captures);
1301 if (not defined $path) {
1302 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1306 $path = '/' if $path eq '';
1309 unshift(@args, $path);
1311 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1312 my $namespace = $c->namespace;
1313 if (defined $path) { # cheesy hack to handle path '../foo'
1314 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1316 unshift(@args, $namespace || '');
1319 # join args with '/', or a blank string
1320 my $args = join('/', grep { defined($_) } @args);
1321 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1323 my $base = $c->req->base;
1324 my $class = ref($base);
1325 $base =~ s{(?<!/)$}{/};
1329 if (my @keys = keys %$params) {
1330 # somewhat lifted from URI::_query's query_form
1331 $query = '?'.join('&', map {
1332 my $val = $params->{$_};
1333 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1336 $val = '' unless defined $val;
1339 utf8::encode( $param ) if utf8::is_utf8($param);
1340 # using the URI::Escape pattern here so utf8 chars survive
1341 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1343 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1347 my $res = bless(\"${base}${args}${query}", $class);
1351 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1353 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1359 A private path to the Catalyst action you want to create a URI for.
1361 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1362 >> and passing the resulting C<$action> and the remaining arguments to C<<
1365 You can also pass in a Catalyst::Action object, in which case it is passed to
1368 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.
1370 For example, if the action looks like:
1372 package MyApp::Controller::Users;
1374 sub lst : Path('the-list') {}
1378 $c->uri_for_action('/users/lst')
1380 and it will create the URI /users/the-list.
1386 sub uri_for_action {
1387 my ( $c, $path, @args ) = @_;
1388 my $action = blessed($path)
1390 : $c->dispatcher->get_action_by_path($path);
1391 unless (defined $action) {
1392 croak "Can't find action for path '$path'";
1394 return $c->uri_for( $action, @args );
1397 =head2 $c->welcome_message
1399 Returns the Catalyst welcome HTML page.
1403 sub welcome_message {
1405 my $name = $c->config->{name};
1406 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1407 my $prefix = Catalyst::Utils::appprefix( ref $c );
1408 $c->response->content_type('text/html; charset=utf-8');
1410 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1411 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1412 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1414 <meta http-equiv="Content-Language" content="en" />
1415 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1416 <title>$name on Catalyst $VERSION</title>
1417 <style type="text/css">
1420 background-color: #eee;
1427 margin-bottom: 10px;
1429 background-color: #ccc;
1430 border: 1px solid #aaa;
1435 font-family: verdana, tahoma, sans-serif;
1438 font-family: verdana, tahoma, sans-serif;
1441 text-decoration: none;
1443 border-bottom: 1px dotted #bbb;
1445 :link:hover, :visited:hover {
1458 background-color: #fff;
1459 border: 1px solid #aaa;
1463 font-weight: normal;
1485 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1490 <img src="$logo" alt="Catalyst Logo" />
1492 <p>Welcome to the world of Catalyst.
1493 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1494 framework will make web development something you had
1495 never expected it to be: Fun, rewarding, and quick.</p>
1496 <h2>What to do now?</h2>
1497 <p>That really depends on what <b>you</b> want to do.
1498 We do, however, provide you with a few starting points.</p>
1499 <p>If you want to jump right into web development with Catalyst
1500 you might want to start with a tutorial.</p>
1501 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1503 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1505 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1506 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1508 <h2>What to do next?</h2>
1509 <p>Next it's time to write an actual application. Use the
1510 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1511 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1512 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1513 they can save you a lot of work.</p>
1514 <pre><code>script/${prefix}_create.pl --help</code></pre>
1515 <p>Also, be sure to check out the vast and growing
1516 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1517 you are likely to find what you need there.
1521 <p>Catalyst has a very active community. Here are the main places to
1522 get in touch with us.</p>
1525 <a href="http://dev.catalyst.perl.org">Wiki</a>
1528 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1531 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1534 <h2>In conclusion</h2>
1535 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1536 as we enjoyed making it. Please contact us if you have ideas
1537 for improvement or other feedback.</p>
1545 =head1 INTERNAL METHODS
1547 These methods are not meant to be used by end users.
1549 =head2 $c->components
1551 Returns a hash of components.
1553 =head2 $c->context_class
1555 Returns or sets the context class.
1559 Returns a hashref containing coderefs and execution counts (needed for
1560 deep recursion detection).
1564 Returns the number of actions on the current internal execution stack.
1568 Dispatches a request to actions.
1572 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1574 =head2 $c->dispatcher_class
1576 Returns or sets the dispatcher class.
1578 =head2 $c->dump_these
1580 Returns a list of 2-element array references (name, structure) pairs
1581 that will be dumped on the error page in debug mode.
1587 [ Request => $c->req ],
1588 [ Response => $c->res ],
1589 [ Stash => $c->stash ],
1590 [ Config => $c->config ];
1593 =head2 $c->engine_class
1595 Returns or sets the engine class.
1597 =head2 $c->execute( $class, $coderef )
1599 Execute a coderef in given class and catch exceptions. Errors are available
1605 my ( $c, $class, $code ) = @_;
1606 $class = $c->component($class) || $class;
1609 if ( $c->depth >= $RECURSION ) {
1610 my $action = $code->reverse();
1611 $action = "/$action" unless $action =~ /->/;
1612 my $error = qq/Deep recursion detected calling "${action}"/;
1613 $c->log->error($error);
1619 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1621 push( @{ $c->stack }, $code );
1623 no warnings 'recursion';
1624 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1626 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1628 my $last = pop( @{ $c->stack } );
1630 if ( my $error = $@ ) {
1631 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1632 $error->rethrow if $c->depth > 1;
1634 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1635 $error->rethrow if $c->depth > 0;
1638 unless ( ref $error ) {
1639 no warnings 'uninitialized';
1641 my $class = $last->class;
1642 my $name = $last->name;
1643 $error = qq/Caught exception in $class->$name "$error"/;
1652 sub _stats_start_execute {
1653 my ( $c, $code ) = @_;
1654 my $appclass = ref($c) || $c;
1655 return if ( ( $code->name =~ /^_.*/ )
1656 && ( !$appclass->config->{show_internal_actions} ) );
1658 my $action_name = $code->reverse();
1659 $c->counter->{$action_name}++;
1661 my $action = $action_name;
1662 $action = "/$action" unless $action =~ /->/;
1664 # determine if the call was the result of a forward
1665 # this is done by walking up the call stack and looking for a calling
1666 # sub of Catalyst::forward before the eval
1668 for my $index ( 2 .. 11 ) {
1670 if ( ( caller($index) )[0] eq 'Catalyst'
1671 && ( caller($index) )[3] eq '(eval)' );
1673 if ( ( caller($index) )[3] =~ /forward$/ ) {
1674 $callsub = ( caller($index) )[3];
1675 $action = "-> $action";
1680 my $uid = $action_name . $c->counter->{$action_name};
1682 # is this a root-level call or a forwarded call?
1683 if ( $callsub =~ /forward$/ ) {
1684 my $parent = $c->stack->[-1];
1686 # forward, locate the caller
1687 if ( exists $c->counter->{"$parent"} ) {
1690 parent => "$parent" . $c->counter->{"$parent"},
1696 # forward with no caller may come from a plugin
1715 sub _stats_finish_execute {
1716 my ( $c, $info ) = @_;
1717 $c->stats->profile( end => $info );
1722 Finalizes the request.
1729 for my $error ( @{ $c->error } ) {
1730 $c->log->error($error);
1733 # Allow engine to handle finalize flow (for POE)
1734 my $engine = $c->engine;
1735 if ( my $code = $engine->can('finalize') ) {
1740 $c->finalize_uploads;
1743 if ( $#{ $c->error } >= 0 ) {
1747 $c->finalize_headers;
1750 if ( $c->request->method eq 'HEAD' ) {
1751 $c->response->body('');
1759 if ($c->use_stats) {
1760 my $elapsed = sprintf '%f', $c->stats->elapsed;
1761 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1763 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1766 return $c->response->status;
1769 =head2 $c->finalize_body
1775 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1777 =head2 $c->finalize_cookies
1783 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1785 =head2 $c->finalize_error
1791 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1793 =head2 $c->finalize_headers
1799 sub finalize_headers {
1802 my $response = $c->response; #accessor calls can add up?
1804 # Check if we already finalized headers
1805 return if $response->finalized_headers;
1808 if ( my $location = $response->redirect ) {
1809 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1810 $response->header( Location => $location );
1812 if ( !$response->has_body ) {
1813 # Add a default body if none is already present
1815 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1821 if ( $response->body && !$response->content_length ) {
1823 # get the length from a filehandle
1824 if ( blessed( $response->body ) && $response->body->can('read') )
1826 my $stat = stat $response->body;
1827 if ( $stat && $stat->size > 0 ) {
1828 $response->content_length( $stat->size );
1831 $c->log->warn('Serving filehandle without a content-length');
1835 # everything should be bytes at this point, but just in case
1836 $response->content_length( length( $response->body ) );
1841 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1842 $response->headers->remove_header("Content-Length");
1843 $response->body('');
1846 $c->finalize_cookies;
1848 $c->engine->finalize_headers( $c, @_ );
1851 $response->finalized_headers(1);
1854 =head2 $c->finalize_output
1856 An alias for finalize_body.
1858 =head2 $c->finalize_read
1860 Finalizes the input after reading is complete.
1864 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1866 =head2 $c->finalize_uploads
1868 Finalizes uploads. Cleans up any temporary files.
1872 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1874 =head2 $c->get_action( $action, $namespace )
1876 Gets an action in a given namespace.
1880 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1882 =head2 $c->get_actions( $action, $namespace )
1884 Gets all actions of a given name in a namespace and all parent
1889 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1891 =head2 $app->handle_request( @arguments )
1893 Called to handle each HTTP request.
1897 sub handle_request {
1898 my ( $class, @arguments ) = @_;
1900 # Always expect worst case!
1903 if ($class->debug) {
1904 my $secs = time - $START || 1;
1905 my $av = sprintf '%.3f', $COUNT / $secs;
1906 my $time = localtime time;
1907 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1910 my $c = $class->prepare(@arguments);
1912 $status = $c->finalize;
1915 if ( my $error = $@ ) {
1917 $class->log->error(qq/Caught exception in engine "$error"/);
1922 if(my $coderef = $class->log->can('_flush')){
1923 $class->log->$coderef();
1928 =head2 $c->prepare( @arguments )
1930 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1936 my ( $class, @arguments ) = @_;
1939 # After the app/ctxt split, this should become an attribute based on something passed
1940 # into the application.
1941 $class->context_class( ref $class || $class ) unless $class->context_class;
1943 my $c = $class->context_class->new({});
1945 # For on-demand data
1946 $c->request->_context($c);
1947 $c->response->_context($c);
1949 #surely this is not the most efficient way to do things...
1950 $c->stats($class->stats_class->new)->enable($c->use_stats);
1951 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1952 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1955 #XXX reuse coderef from can
1956 # Allow engine to direct the prepare flow (for POE)
1957 if ( $c->engine->can('prepare') ) {
1958 $c->engine->prepare( $c, @arguments );
1961 $c->prepare_request(@arguments);
1962 $c->prepare_connection;
1963 $c->prepare_query_parameters;
1964 $c->prepare_headers;
1965 $c->prepare_cookies;
1968 # Prepare the body for reading, either by prepare_body
1969 # or the user, if they are using $c->read
1972 # Parse the body unless the user wants it on-demand
1973 unless ( ref($c)->config->{parse_on_demand} ) {
1978 my $method = $c->req->method || '';
1979 my $path = $c->req->path;
1980 $path = '/' unless length $path;
1981 my $address = $c->req->address || '';
1990 =head2 $c->prepare_action
1992 Prepares action. See L<Catalyst::Dispatcher>.
1996 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1998 =head2 $c->prepare_body
2000 Prepares message body.
2007 return if $c->request->_has_body;
2009 # Initialize on-demand data
2010 $c->engine->prepare_body( $c, @_ );
2011 $c->prepare_parameters;
2012 $c->prepare_uploads;
2015 =head2 $c->prepare_body_chunk( $chunk )
2017 Prepares a chunk of data before sending it to L<HTTP::Body>.
2019 See L<Catalyst::Engine>.
2023 sub prepare_body_chunk {
2025 $c->engine->prepare_body_chunk( $c, @_ );
2028 =head2 $c->prepare_body_parameters
2030 Prepares body parameters.
2034 sub prepare_body_parameters {
2036 $c->engine->prepare_body_parameters( $c, @_ );
2039 =head2 $c->prepare_connection
2041 Prepares connection.
2045 sub prepare_connection {
2047 $c->engine->prepare_connection( $c, @_ );
2050 =head2 $c->prepare_cookies
2056 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2058 =head2 $c->prepare_headers
2064 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2066 =head2 $c->prepare_parameters
2068 Prepares parameters.
2072 sub prepare_parameters {
2074 $c->prepare_body_parameters;
2075 $c->engine->prepare_parameters( $c, @_ );
2078 =head2 $c->prepare_path
2080 Prepares path and base.
2084 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2086 =head2 $c->prepare_query_parameters
2088 Prepares query parameters.
2092 sub prepare_query_parameters {
2095 $c->engine->prepare_query_parameters( $c, @_ );
2098 =head2 $c->log_request
2100 Writes information about the request to the debug logs. This includes:
2104 =item * Request method, path, and remote IP address
2106 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2108 =item * Request parameters
2110 =item * File uploads
2119 return unless $c->debug;
2121 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2122 my $request = $dump->[1];
2124 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2126 $path = '/' unless length $path;
2128 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2130 $c->log_request_headers($request->headers);
2132 if ( my $keywords = $request->query_keywords ) {
2133 $c->log->debug("Query keywords are: $keywords");
2136 $c->log_request_parameters( query => $request->query_parameters, body => $request->body_parameters );
2138 $c->log_request_uploads($request);
2141 =head2 $c->log_response
2143 Writes information about the response to the debug logs by calling
2144 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2151 return unless $c->debug;
2153 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2154 my $response = $dump->[1];
2156 $c->log_response_status_line($response);
2157 $c->log_response_headers($response->headers);
2160 =head2 $c->log_response_status_line($response)
2162 Writes one line of information about the response to the debug logs. This includes:
2166 =item * Response status code
2168 =item * Content-Type header (if present)
2170 =item * Content-Length header (if present)
2176 sub log_response_status_line {
2177 my ($c, $response) = @_;
2181 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2182 $response->status || 'unknown',
2183 $response->headers->header('Content-Type') || 'unknown',
2184 $response->headers->header('Content-Length') || 'unknown'
2189 =head2 $c->log_response_headers($headers);
2191 Hook method which can be wrapped by plugins to log the responseheaders.
2192 No-op in the default implementation.
2196 sub log_response_headers {}
2198 =head2 $c->log_request_parameters( query => {}, body => {} )
2200 Logs request parameters to debug logs
2204 sub log_request_parameters {
2206 my %all_params = @_;
2208 return unless $c->debug;
2210 my $column_width = Catalyst::Utils::term_width() - 44;
2211 foreach my $type (qw(query body)) {
2212 my $params = $all_params{$type};
2213 next if ! keys %$params;
2214 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2215 for my $key ( sort keys %$params ) {
2216 my $param = $params->{$key};
2217 my $value = defined($param) ? $param : '';
2218 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2220 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2224 =head2 $c->log_request_uploads
2226 Logs file uploads included in the request to the debug logs.
2227 The parameter name, filename, file type, and file size are all included in
2232 sub log_request_uploads {
2234 my $request = shift;
2235 return unless $c->debug;
2236 my $uploads = $request->uploads;
2237 if ( keys %$uploads ) {
2238 my $t = Text::SimpleTable->new(
2239 [ 12, 'Parameter' ],
2244 for my $key ( sort keys %$uploads ) {
2245 my $upload = $uploads->{$key};
2246 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2247 $t->row( $key, $u->filename, $u->type, $u->size );
2250 $c->log->debug( "File Uploads are:\n" . $t->draw );
2254 =head2 $c->log_request_headers($headers);
2256 Hook method which can be wrapped by plugins to log the request headers.
2257 No-op in the default implementation.
2261 sub log_request_headers {}
2263 =head2 $c->log_headers($type => $headers)
2265 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2272 my $headers = shift; # an HTTP::Headers instance
2274 return unless $c->debug;
2276 my $column_width = Catalyst::Utils::term_width() - 28;
2277 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2280 my ( $name, $value ) = @_;
2281 $t->row( $name, $value );
2284 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2288 =head2 $c->prepare_read
2290 Prepares the input for reading.
2294 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2296 =head2 $c->prepare_request
2298 Prepares the engine request.
2302 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2304 =head2 $c->prepare_uploads
2310 sub prepare_uploads {
2313 $c->engine->prepare_uploads( $c, @_ );
2316 =head2 $c->prepare_write
2318 Prepares the output for writing.
2322 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2324 =head2 $c->request_class
2326 Returns or sets the request class.
2328 =head2 $c->response_class
2330 Returns or sets the response class.
2332 =head2 $c->read( [$maxlength] )
2334 Reads a chunk of data from the request body. This method is designed to
2335 be used in a while loop, reading C<$maxlength> bytes on every call.
2336 C<$maxlength> defaults to the size of the request if not specified.
2338 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2341 Warning: If you use read(), Catalyst will not process the body,
2342 so you will not be able to access POST parameters or file uploads via
2343 $c->request. You must handle all body parsing yourself.
2347 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2355 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2357 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2359 Sets an action in a given namespace.
2363 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2365 =head2 $c->setup_actions($component)
2367 Sets up actions for a component.
2371 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2373 =head2 $c->setup_components
2375 This method is called internally to set up the application's components.
2377 It finds modules by calling the L<locate_components> method, expands them to
2378 package names with the L<expand_component_module> method, and then installs
2379 each component into the application.
2381 The C<setup_components> config option is passed to both of the above methods.
2383 Installation of each component is performed by the L<setup_component> method,
2388 sub setup_components {
2391 my $config = $class->config->{ setup_components };
2393 my @comps = sort { length $a <=> length $b }
2394 $class->locate_components($config);
2395 my %comps = map { $_ => 1 } @comps;
2397 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2398 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2399 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2400 ) if $deprecatedcatalyst_component_names;
2402 for my $component ( @comps ) {
2404 # We pass ignore_loaded here so that overlay files for (e.g.)
2405 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2406 # we know M::P::O found a file on disk so this is safe
2408 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2410 # Needs to be done as soon as the component is loaded, as loading a sub-component
2411 # (next time round the loop) can cause us to get the wrong metaclass..
2412 $class->_controller_init_base_classes($component);
2415 for my $component (@comps) {
2416 my $instance = $class->components->{ $component } = $class->setup_component($component);
2417 my @expanded_components = $instance->can('expand_modules')
2418 ? $instance->expand_modules( $component, $config )
2419 : $class->expand_component_module( $component, $config );
2420 for my $component (@expanded_components) {
2421 next if $comps{$component};
2422 $class->_controller_init_base_classes($component); # Also cover inner packages
2423 $class->components->{ $component } = $class->setup_component($component);
2428 =head2 $c->locate_components( $setup_component_config )
2430 This method is meant to provide a list of component modules that should be
2431 setup for the application. By default, it will use L<Module::Pluggable>.
2433 Specify a C<setup_components> config option to pass additional options directly
2434 to L<Module::Pluggable>. To add additional search paths, specify a key named
2435 C<search_extra> as an array reference. Items in the array beginning with C<::>
2436 will have the application class name prepended to them.
2440 sub locate_components {
2444 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2445 my $extra = delete $config->{ search_extra } || [];
2447 push @paths, @$extra;
2449 my $locator = Module::Pluggable::Object->new(
2450 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2454 my @comps = $locator->plugins;
2459 =head2 $c->expand_component_module( $component, $setup_component_config )
2461 Components found by C<locate_components> will be passed to this method, which
2462 is expected to return a list of component (package) names to be set up.
2466 sub expand_component_module {
2467 my ($class, $module) = @_;
2468 return Devel::InnerPackage::list_packages( $module );
2471 =head2 $c->setup_component
2475 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2476 # nearest to Catalyst::Controller first, no matter what order stuff happens
2477 # to be loaded. There are TODO tests in Moose for this, see
2478 # f2391d17574eff81d911b97be15ea51080500003
2479 sub _controller_init_base_classes {
2480 my ($app_class, $component) = @_;
2481 return unless $component->isa('Catalyst::Controller');
2482 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2483 Moose::Meta::Class->initialize( $class )
2484 unless find_meta($class);
2488 sub setup_component {
2489 my( $class, $component ) = @_;
2491 unless ( $component->can( 'COMPONENT' ) ) {
2495 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2496 my $config = $class->config->{ $suffix } || {};
2497 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2498 # methods also pass it. local to avoid pointlessly shitting in config
2499 # for the debug screen, as $component is already the key name.
2500 local $config->{catalyst_component_name} = $component;
2502 my $instance = eval { $component->COMPONENT( $class, $config ); };
2504 if ( my $error = $@ ) {
2506 Catalyst::Exception->throw(
2507 message => qq/Couldn't instantiate component "$component", "$error"/
2511 unless (blessed $instance) {
2512 my $metaclass = Moose::Util::find_meta($component);
2513 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2514 my $component_method_from = $method_meta->associated_metaclass->name;
2515 my $value = defined($instance) ? $instance : 'undef';
2516 Catalyst::Exception->throw(
2518 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2524 =head2 $c->setup_dispatcher
2530 sub setup_dispatcher {
2531 my ( $class, $dispatcher ) = @_;
2534 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2537 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2538 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2541 unless ($dispatcher) {
2542 $dispatcher = $class->dispatcher_class;
2545 Class::MOP::load_class($dispatcher);
2547 # dispatcher instance
2548 $class->dispatcher( $dispatcher->new );
2551 =head2 $c->setup_engine
2558 my ( $class, $engine ) = @_;
2561 $engine = 'Catalyst::Engine::' . $engine;
2564 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2565 $engine = 'Catalyst::Engine::' . $env;
2568 if ( $ENV{MOD_PERL} ) {
2569 my $meta = Class::MOP::get_metaclass_by_name($class);
2571 # create the apache method
2572 $meta->add_method('apache' => sub { shift->engine->apache });
2574 my ( $software, $version ) =
2575 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2578 $version =~ s/(\.[^.]+)\./$1/g;
2580 if ( $software eq 'mod_perl' ) {
2584 if ( $version >= 1.99922 ) {
2585 $engine = 'Catalyst::Engine::Apache2::MP20';
2588 elsif ( $version >= 1.9901 ) {
2589 $engine = 'Catalyst::Engine::Apache2::MP19';
2592 elsif ( $version >= 1.24 ) {
2593 $engine = 'Catalyst::Engine::Apache::MP13';
2597 Catalyst::Exception->throw( message =>
2598 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2603 # install the correct mod_perl handler
2604 if ( $version >= 1.9901 ) {
2605 *handler = sub : method {
2606 shift->handle_request(@_);
2610 *handler = sub ($$) { shift->handle_request(@_) };
2615 elsif ( $software eq 'Zeus-Perl' ) {
2616 $engine = 'Catalyst::Engine::Zeus';
2620 Catalyst::Exception->throw(
2621 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2626 $engine = $class->engine_class;
2629 Class::MOP::load_class($engine);
2631 # check for old engines that are no longer compatible
2633 if ( $engine->isa('Catalyst::Engine::Apache')
2634 && !Catalyst::Engine::Apache->VERSION )
2639 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2640 && Catalyst::Engine::Server->VERSION le '0.02' )
2645 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2646 && $engine->VERSION eq '0.01' )
2651 elsif ($engine->isa('Catalyst::Engine::Zeus')
2652 && $engine->VERSION eq '0.01' )
2658 Catalyst::Exception->throw( message =>
2659 qq/Engine "$engine" is not supported by this version of Catalyst/
2664 $class->engine( $engine->new );
2667 =head2 $c->setup_home
2669 Sets up the home directory.
2674 my ( $class, $home ) = @_;
2676 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2680 $home ||= Catalyst::Utils::home($class);
2683 #I remember recently being scolded for assigning config values like this
2684 $class->config->{home} ||= $home;
2685 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2689 =head2 $c->setup_log
2691 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2692 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2695 This method also installs a C<debug> method that returns a true value into the
2696 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2697 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2699 Note that if the log has already been setup, by either a previous call to
2700 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2701 that this method won't actually set up the log object.
2706 my ( $class, $levels ) = @_;
2709 $levels =~ s/^\s+//;
2710 $levels =~ s/\s+$//;
2711 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2713 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2714 if ( defined $env_debug ) {
2715 $levels{debug} = 1 if $env_debug; # Ugly!
2716 delete($levels{debug}) unless $env_debug;
2719 unless ( $class->log ) {
2720 $class->log( Catalyst::Log->new(keys %levels) );
2723 if ( $levels{debug} ) {
2724 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2725 $class->log->debug('Debug messages enabled');
2729 =head2 $c->setup_plugins
2735 =head2 $c->setup_stats
2737 Sets up timing statistics class.
2742 my ( $class, $stats ) = @_;
2744 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2746 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2747 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2748 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2749 $class->log->debug('Statistics enabled');
2754 =head2 $c->registered_plugins
2756 Returns a sorted list of the plugins which have either been stated in the
2757 import list or which have been added via C<< MyApp->plugin(@args); >>.
2759 If passed a given plugin name, it will report a boolean value indicating
2760 whether or not that plugin is loaded. A fully qualified name is required if
2761 the plugin name does not begin with C<Catalyst::Plugin::>.
2763 if ($c->registered_plugins('Some::Plugin')) {
2771 sub registered_plugins {
2773 return sort keys %{ $proto->_plugins } unless @_;
2775 return 1 if exists $proto->_plugins->{$plugin};
2776 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2779 sub _register_plugin {
2780 my ( $proto, $plugin, $instant ) = @_;
2781 my $class = ref $proto || $proto;
2783 Class::MOP::load_class( $plugin );
2784 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2785 if $plugin->isa( 'Catalyst::Component' );
2786 $proto->_plugins->{$plugin} = 1;
2788 my $meta = Class::MOP::get_metaclass_by_name($class);
2789 $meta->superclasses($plugin, $meta->superclasses);
2795 my ( $class, $plugins ) = @_;
2797 $class->_plugins( {} ) unless $class->_plugins;
2798 $plugins = Data::OptList::mkopt($plugins || []);
2801 [ Catalyst::Utils::resolve_namespace(
2802 $class . '::Plugin',
2803 'Catalyst::Plugin', $_->[0]
2809 for my $plugin ( reverse @plugins ) {
2810 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2811 my $meta = find_meta($plugin->[0]);
2812 next if $meta && $meta->isa('Moose::Meta::Role');
2814 $class->_register_plugin($plugin->[0]);
2818 map { $_->[0]->name, $_->[1] }
2819 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2820 map { [find_meta($_->[0]), $_->[1]] }
2823 Moose::Util::apply_all_roles(
2831 Returns an arrayref of the internal execution stack (actions that are
2832 currently executing).
2836 Returns the current timing statistics object. By default Catalyst uses
2837 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2838 L<< stats_class|/"$c->stats_class" >>.
2840 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2841 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2842 profile explicitly, although MyApp.pm still won't profile nor output anything
2845 =head2 $c->stats_class
2847 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2849 =head2 $c->use_stats
2851 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2853 Note that this is a static method, not an accessor and should be overridden
2854 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2861 =head2 $c->write( $data )
2863 Writes $data to the output stream. When using this method directly, you
2864 will need to manually set the C<Content-Length> header to the length of
2865 your output data, if known.
2872 # Finalize headers if someone manually writes output
2873 $c->finalize_headers;
2875 return $c->engine->write( $c, @_ );
2880 Returns the Catalyst version number. Mostly useful for "powered by"
2881 messages in template systems.
2885 sub version { return $Catalyst::VERSION }
2887 =head1 CONFIGURATION
2889 There are a number of 'base' config variables which can be set:
2895 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2899 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2903 C<disable_component_resolution_regex_fallback> - Turns
2904 off the deprecated component resolution functionality so
2905 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2906 are called then regex search will not be attempted on string values and
2907 instead C<undef> will be returned.
2911 C<home> - The application home directory. In an uninstalled application,
2912 this is the top level application directory. In an installed application,
2913 this will be the directory containing C<< MyApp.pm >>.
2917 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2921 C<name> - The name of the application in debug messages and the debug and
2926 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2927 until it is accessed. This allows you to (for example) check authentication (and reject
2928 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2932 C<root> - The root directory for templates. Usually this is just a
2933 subdirectory of the home directory, but you can set it to change the
2934 templates to a different directory.
2938 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2939 namespaces from which components will be loaded (and constructed and stored in
2940 C<< $c->components >>).
2944 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2945 to be shown in hit debug tables in the test server.
2949 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2953 =head1 INTERNAL ACTIONS
2955 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2956 C<_ACTION>, and C<_END>. These are by default not shown in the private
2957 action table, but you can make them visible with a config parameter.
2959 MyApp->config(show_internal_actions => 1);
2961 =head1 ON-DEMAND PARSER
2963 The request body is usually parsed at the beginning of a request,
2964 but if you want to handle input yourself, you can enable on-demand
2965 parsing with a config parameter.
2967 MyApp->config(parse_on_demand => 1);
2969 =head1 PROXY SUPPORT
2971 Many production servers operate using the common double-server approach,
2972 with a lightweight frontend web server passing requests to a larger
2973 backend server. An application running on the backend server must deal
2974 with two problems: the remote user always appears to be C<127.0.0.1> and
2975 the server's hostname will appear to be C<localhost> regardless of the
2976 virtual host that the user connected through.
2978 Catalyst will automatically detect this situation when you are running
2979 the frontend and backend servers on the same machine. The following
2980 changes are made to the request.
2982 $c->req->address is set to the user's real IP address, as read from
2983 the HTTP X-Forwarded-For header.
2985 The host value for $c->req->base and $c->req->uri is set to the real
2986 host, as read from the HTTP X-Forwarded-Host header.
2988 Additionally, you may be running your backend application on an insecure
2989 connection (port 80) while your frontend proxy is running under SSL. If there
2990 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2991 tell Catalyst what port the frontend listens on. This will allow all URIs to
2992 be created properly.
2994 In the case of passing in:
2996 X-Forwarded-Port: 443
2998 All calls to C<uri_for> will result in an https link, as is expected.
3000 Obviously, your web server must support these headers for this to work.
3002 In a more complex server farm environment where you may have your
3003 frontend proxy server(s) on different machines, you will need to set a
3004 configuration option to tell Catalyst to read the proxied data from the
3007 MyApp->config(using_frontend_proxy => 1);
3009 If you do not wish to use the proxy support at all, you may set:
3011 MyApp->config(ignore_frontend_proxy => 1);
3013 =head1 THREAD SAFETY
3015 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3016 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3017 believe the Catalyst core to be thread-safe.
3019 If you plan to operate in a threaded environment, remember that all other
3020 modules you are using must also be thread-safe. Some modules, most notably
3021 L<DBD::SQLite>, are not thread-safe.
3027 Join #catalyst on irc.perl.org.
3031 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3032 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3036 http://catalyst.perl.org
3040 http://dev.catalyst.perl.org
3044 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3046 =head2 L<Catalyst::Manual> - The Catalyst Manual
3048 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3050 =head2 L<Catalyst::Engine> - Core engine
3052 =head2 L<Catalyst::Log> - Log class.
3054 =head2 L<Catalyst::Request> - Request object
3056 =head2 L<Catalyst::Response> - Response object
3058 =head2 L<Catalyst::Test> - The test suite.
3060 =head1 PROJECT FOUNDER
3062 sri: Sebastian Riedel <sri@cpan.org>
3068 acme: Leon Brocard <leon@astray.com>
3070 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3074 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3078 andyg: Andy Grundman <andy@hybridized.org>
3080 audreyt: Audrey Tang
3082 bricas: Brian Cassidy <bricas@cpan.org>
3084 Caelum: Rafael Kitover <rkitover@io.com>
3086 chansen: Christian Hansen
3088 chicks: Christopher Hicks
3090 Chisel Wright C<pause@herlpacker.co.uk>
3092 Danijel Milicevic C<me@danijel.de>
3094 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3096 David Naughton, C<naughton@umn.edu>
3100 dhoss: Devin Austin <dhoss@cpan.org>
3102 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3106 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3108 esskar: Sascha Kiefer
3110 fireartist: Carl Franks <cfranks@cpan.org>
3112 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3114 gabb: Danijel Milicevic
3118 Gavin Henry C<ghenry@perl.me.uk>
3122 groditi: Guillermo Roditi <groditi@gmail.com>
3124 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3126 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3128 jcamacho: Juan Camacho
3130 jester: Jesse Sheidlower C<jester@panix.com>
3132 jhannah: Jay Hannah <jay@jays.net>
3138 jon: Jon Schutz <jjschutz@cpan.org>
3140 Jonathan Rockway C<< <jrockway@cpan.org> >>
3142 Kieren Diment C<kd@totaldatasolution.com>
3144 konobi: Scott McWhirter <konobi@cpan.org>
3146 marcus: Marcus Ramberg <mramberg@cpan.org>
3148 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3150 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3154 naughton: David Naughton
3156 ningu: David Kamholz <dkamholz@cpan.org>
3158 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3160 numa: Dan Sully <daniel@cpan.org>
3166 omega: Andreas Marienborg
3168 Oleg Kostyuk <cub.uanic@gmail.com>
3170 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3172 rafl: Florian Ragwitz <rafl@debian.org>
3174 random: Roland Lammel <lammel@cpan.org>
3176 Robert Sedlacek C<< <rs@474.at> >>
3180 szbalint: Balint Szilakszi <szbalint@cpan.org>
3182 t0m: Tomas Doran <bobtfish@bobtfish.net>
3186 Viljo Marrandi C<vilts@yahoo.com>
3188 Will Hawes C<info@whawes.co.uk>
3190 willert: Sebastian Willert <willert@cpan.org>
3192 wreis: Wallace Reis <wallace@reis.org.br>
3194 Yuval Kogman, C<nothingmuch@woobling.org>
3198 This library is free software. You can redistribute it and/or modify it under
3199 the same terms as Perl itself.
3205 __PACKAGE__->meta->make_immutable;