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.80020';
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 ) = @_;
644 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
645 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
646 return $c->_filter_component( $result[ 0 ], @args );
649 return $c->component( $c->action->class );
652 =head2 $c->model($name)
654 Gets a L<Catalyst::Model> instance by name.
656 $c->model('Foo')->do_stuff;
658 Any extra arguments are directly passed to ACCEPT_CONTEXT.
660 If the name is omitted, it will look for
661 - a model object in $c->stash->{current_model_instance}, then
662 - a model name in $c->stash->{current_model}, then
663 - a config setting 'default_model', or
664 - check if there is only one model, and return it if that's the case.
666 If you want to search for models, pass in a regexp as the argument.
668 # find all models that start with Foo
669 my @foo_models = $c->model(qr{^Foo});
674 my ( $c, $name, @args ) = @_;
675 my $appclass = ref($c) || $c;
677 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
678 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
679 return $c->_filter_component( $result[ 0 ], @args );
683 return $c->stash->{current_model_instance}
684 if $c->stash->{current_model_instance};
685 return $c->model( $c->stash->{current_model} )
686 if $c->stash->{current_model};
688 return $c->model( $appclass->config->{default_model} )
689 if $appclass->config->{default_model};
691 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
694 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
695 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
696 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
697 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
698 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
701 return $c->_filter_component( $comp );
705 =head2 $c->view($name)
707 Gets a L<Catalyst::View> instance by name.
709 $c->view('Foo')->do_stuff;
711 Any extra arguments are directly passed to ACCEPT_CONTEXT.
713 If the name is omitted, it will look for
714 - a view object in $c->stash->{current_view_instance}, then
715 - a view name in $c->stash->{current_view}, then
716 - a config setting 'default_view', or
717 - check if there is only one view, and return it if that's the case.
719 If you want to search for views, pass in a regexp as the argument.
721 # find all views that start with Foo
722 my @foo_views = $c->view(qr{^Foo});
727 my ( $c, $name, @args ) = @_;
729 my $appclass = ref($c) || $c;
731 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
732 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
733 return $c->_filter_component( $result[ 0 ], @args );
737 return $c->stash->{current_view_instance}
738 if $c->stash->{current_view_instance};
739 return $c->view( $c->stash->{current_view} )
740 if $c->stash->{current_view};
742 return $c->view( $appclass->config->{default_view} )
743 if $appclass->config->{default_view};
745 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
748 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
749 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
750 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
751 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
752 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
755 return $c->_filter_component( $comp );
758 =head2 $c->controllers
760 Returns the available names which can be passed to $c->controller
766 return $c->_comp_names(qw/Controller C/);
771 Returns the available names which can be passed to $c->model
777 return $c->_comp_names(qw/Model M/);
783 Returns the available names which can be passed to $c->view
789 return $c->_comp_names(qw/View V/);
792 =head2 $c->comp($name)
794 =head2 $c->component($name)
796 Gets a component object by name. This method is not recommended,
797 unless you want to get a specific component by full
798 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
799 should be used instead.
801 If C<$name> is a regexp, a list of components matched against the full
802 component name will be returned.
804 If Catalyst can't find a component by name, it will fallback to regex
805 matching by default. To disable this behaviour set
806 disable_component_resolution_regex_fallback to a true value.
808 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
813 my ( $c, $name, @args ) = @_;
816 my $comps = $c->components;
819 # is it the exact name?
820 return $c->_filter_component( $comps->{ $name }, @args )
821 if exists $comps->{ $name };
823 # perhaps we just omitted "MyApp"?
824 my $composed = ( ref $c || $c ) . "::${name}";
825 return $c->_filter_component( $comps->{ $composed }, @args )
826 if exists $comps->{ $composed };
828 # search all of the models, views and controllers
829 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
830 return $c->_filter_component( $comp, @args ) if $comp;
833 # This is here so $c->comp( '::M::' ) works
834 my $query = ref $name ? $name : qr{$name}i;
836 my @result = grep { m{$query} } keys %{ $c->components };
837 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
840 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
841 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
842 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
843 return $c->_filter_component( $result[ 0 ], @args );
846 # I would expect to return an empty list here, but that breaks back-compat
850 return sort keys %{ $c->components };
853 =head2 CLASS DATA AND HELPER CLASSES
857 Returns or takes a hashref containing the application's configuration.
859 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
861 You can also use a C<YAML>, C<XML> or L<Config::General> config file
862 like C<myapp.conf> in your applications home directory. See
863 L<Catalyst::Plugin::ConfigLoader>.
865 =head3 Cascading configuration
867 The config method is present on all Catalyst components, and configuration
868 will be merged when an application is started. Configuration loaded with
869 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
870 followed by configuration in your top level C<MyApp> class. These two
871 configurations are merged, and then configuration data whose hash key matches a
872 component name is merged with configuration for that component.
874 The configuration for a component is then passed to the C<new> method when a
875 component is constructed.
879 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
880 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
882 will mean that C<MyApp::Model::Foo> receives the following data when
885 MyApp::Model::Foo->new({
893 around config => sub {
897 croak('Setting config after setup has been run is not allowed.')
898 if ( @_ and $c->setup_finished );
905 Returns the logging object instance. Unless it is already set, Catalyst
906 sets this up with a L<Catalyst::Log> object. To use your own log class,
907 set the logger with the C<< __PACKAGE__->log >> method prior to calling
908 C<< __PACKAGE__->setup >>.
910 __PACKAGE__->log( MyLogger->new );
915 $c->log->info( 'Now logging with my own logger!' );
917 Your log class should implement the methods described in
923 Returns 1 if debug mode is enabled, 0 otherwise.
925 You can enable debug mode in several ways:
929 =item By calling myapp_server.pl with the -d flag
931 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
933 =item The -Debug option in your MyApp.pm
935 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
939 The first three also set the log level to 'debug'.
941 Calling C<< $c->debug(1) >> has no effect.
947 =head2 $c->dispatcher
949 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
953 Returns the engine instance. See L<Catalyst::Engine>.
956 =head2 UTILITY METHODS
958 =head2 $c->path_to(@path)
960 Merges C<@path> with C<< $c->config->{home} >> and returns a
961 L<Path::Class::Dir> object. Note you can usually use this object as
962 a filename, but sometimes you will have to explicitly stringify it
963 yourself by calling the C<< ->stringify >> method.
967 $c->path_to( 'db', 'sqlite.db' );
972 my ( $c, @path ) = @_;
973 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
974 if ( -d $path ) { return $path }
975 else { return Path::Class::File->new( $c->config->{home}, @path ) }
978 =head2 $c->plugin( $name, $class, @args )
980 Helper method for plugins. It creates a class data accessor/mutator and
981 loads and instantiates the given class.
983 MyApp->plugin( 'prototype', 'HTML::Prototype' );
985 $c->prototype->define_javascript_functions;
987 B<Note:> This method of adding plugins is deprecated. The ability
988 to add plugins like this B<will be removed> in a Catalyst 5.81.
989 Please do not use this functionality in new code.
994 my ( $class, $name, $plugin, @args ) = @_;
996 # See block comment in t/unit_core_plugin.t
997 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
999 $class->_register_plugin( $plugin, 1 );
1001 eval { $plugin->import };
1002 $class->mk_classdata($name);
1004 eval { $obj = $plugin->new(@args) };
1007 Catalyst::Exception->throw( message =>
1008 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1011 $class->$name($obj);
1012 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1018 Initializes the dispatcher and engine, loads any plugins, and loads the
1019 model, view, and controller components. You may also specify an array
1020 of plugins to load here, if you choose to not load them in the C<use
1024 MyApp->setup( qw/-Debug/ );
1029 my ( $class, @arguments ) = @_;
1030 croak('Running setup more than once')
1031 if ( $class->setup_finished );
1033 unless ( $class->isa('Catalyst') ) {
1035 Catalyst::Exception->throw(
1036 message => qq/'$class' does not inherit from Catalyst/ );
1039 if ( $class->arguments ) {
1040 @arguments = ( @arguments, @{ $class->arguments } );
1046 foreach (@arguments) {
1050 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1052 elsif (/^-(\w+)=?(.*)$/) {
1053 $flags->{ lc $1 } = $2;
1056 push @{ $flags->{plugins} }, $_;
1060 $class->setup_home( delete $flags->{home} );
1062 $class->setup_log( delete $flags->{log} );
1063 $class->setup_plugins( delete $flags->{plugins} );
1064 $class->setup_dispatcher( delete $flags->{dispatcher} );
1065 $class->setup_engine( delete $flags->{engine} );
1066 $class->setup_stats( delete $flags->{stats} );
1068 for my $flag ( sort keys %{$flags} ) {
1070 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1071 &$code( $class, delete $flags->{$flag} );
1074 $class->log->warn(qq/Unknown flag "$flag"/);
1078 eval { require Catalyst::Devel; };
1079 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1080 $class->log->warn(<<"EOF");
1081 You are running an old script!
1083 Please update by running (this will overwrite existing files):
1084 catalyst.pl -force -scripts $class
1086 or (this will not overwrite existing files):
1087 catalyst.pl -scripts $class
1092 if ( $class->debug ) {
1093 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1096 my $column_width = Catalyst::Utils::term_width() - 6;
1097 my $t = Text::SimpleTable->new($column_width);
1098 $t->row($_) for @plugins;
1099 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1102 my $dispatcher = $class->dispatcher;
1103 my $engine = $class->engine;
1104 my $home = $class->config->{home};
1106 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1107 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1111 ? $class->log->debug(qq/Found home "$home"/)
1112 : $class->log->debug(qq/Home "$home" doesn't exist/)
1113 : $class->log->debug(q/Couldn't find home/);
1116 # Call plugins setup, this is stupid and evil.
1117 # Also screws C3 badly on 5.10, hack to avoid.
1119 no warnings qw/redefine/;
1120 local *setup = sub { };
1121 $class->setup unless $Catalyst::__AM_RESTARTING;
1124 # Initialize our data structure
1125 $class->components( {} );
1127 $class->setup_components;
1129 if ( $class->debug ) {
1130 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1131 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1132 for my $comp ( sort keys %{ $class->components } ) {
1133 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1134 $t->row( $comp, $type );
1136 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1137 if ( keys %{ $class->components } );
1140 # Add our self to components, since we are also a component
1141 if( $class->isa('Catalyst::Controller') ){
1142 $class->components->{$class} = $class;
1145 $class->setup_actions;
1147 if ( $class->debug ) {
1148 my $name = $class->config->{name} || 'Application';
1149 $class->log->info("$name powered by Catalyst $Catalyst::PRETTY_VERSION");
1152 # Make sure that the application class becomes immutable at this point,
1153 B::Hooks::EndOfScope::on_scope_end {
1155 my $meta = Class::MOP::get_metaclass_by_name($class);
1158 && ! { $meta->immutable_options }->{replace_constructor}
1160 $class->isa('Class::Accessor::Fast')
1161 || $class->isa('Class::Accessor')
1164 warn "You made your application class ($class) immutable, "
1165 . "but did not inline the\nconstructor. "
1166 . "This will break catalyst, as your app \@ISA "
1167 . "Class::Accessor(::Fast)?\nPlease pass "
1168 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1170 $meta->make_immutable(
1171 replace_constructor => 1,
1172 ) unless $meta->is_immutable;
1175 if ($class->config->{case_sensitive}) {
1176 $class->log->warn($class . "->config->{case_sensitive} is set.");
1177 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1180 $class->setup_finalize;
1181 # Should be the last thing we do so that user things hooking
1182 # setup_finalize can log..
1183 $class->log->_flush() if $class->log->can('_flush');
1184 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1187 =head2 $app->setup_finalize
1189 A hook to attach modifiers to. This method does not do anything except set the
1190 C<setup_finished> accessor.
1192 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1196 after setup_finalize => sub {
1204 sub setup_finalize {
1206 $class->setup_finished(1);
1209 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1211 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1213 Constructs an absolute L<URI> object based on the application root, the
1214 provided path, and the additional arguments and query parameters provided.
1215 When used as a string, provides a textual URI.
1217 If no arguments are provided, the URI for the current action is returned.
1218 To return the current action and also provide @args, use
1219 C<< $c->uri_for( $c->action, @args ) >>.
1221 If the first argument is a string, it is taken as a public URI path relative
1222 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1223 relative to the application root (if it does). It is then merged with
1224 C<< $c->request->base >>; any C<@args> are appended as additional path
1225 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1227 If the first argument is a L<Catalyst::Action> it represents an action which
1228 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1229 optional C<\@captures> argument (an arrayref) allows passing the captured
1230 variables that are needed to fill in the paths of Chained and Regex actions;
1231 once the path is resolved, C<uri_for> continues as though a path was
1232 provided, appending any arguments or parameters and creating an absolute
1235 The captures for the current request can be found in
1236 C<< $c->request->captures >>, and actions can be resolved using
1237 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1238 path, use C<< $c->uri_for_action >> instead.
1240 # Equivalent to $c->req->uri
1241 $c->uri_for($c->action, $c->req->captures,
1242 @{ $c->req->args }, $c->req->params);
1244 # For the Foo action in the Bar controller
1245 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1247 # Path to a static resource
1248 $c->uri_for('/static/images/logo.png');
1253 my ( $c, $path, @args ) = @_;
1255 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1256 $path = $path->path_prefix;
1261 undef($path) if (defined $path && $path eq '');
1264 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1266 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1267 foreach my $arg (@args) {
1268 utf8::encode($arg) if utf8::is_utf8($arg);
1270 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1271 if (blessed $path) { # Action object only.
1272 s|/|%2F|g for @args;
1275 if ( blessed($path) ) { # action object
1276 my $captures = [ map { s|/|%2F|g; $_; }
1277 ( scalar @args && ref $args[0] eq 'ARRAY'
1281 foreach my $capture (@$captures) {
1282 utf8::encode($capture) if utf8::is_utf8($capture);
1283 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1287 $path = $c->dispatcher->uri_for_action($action, $captures);
1288 if (not defined $path) {
1289 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1293 $path = '/' if $path eq '';
1296 undef($path) if (defined $path && $path eq '');
1298 unshift(@args, $path);
1300 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1301 my $namespace = $c->namespace;
1302 if (defined $path) { # cheesy hack to handle path '../foo'
1303 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1305 unshift(@args, $namespace || '');
1308 # join args with '/', or a blank string
1309 my $args = join('/', grep { defined($_) } @args);
1310 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1312 my $base = $c->req->base;
1313 my $class = ref($base);
1314 $base =~ s{(?<!/)$}{/};
1318 if (my @keys = keys %$params) {
1319 # somewhat lifted from URI::_query's query_form
1320 $query = '?'.join('&', map {
1321 my $val = $params->{$_};
1322 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1325 $val = '' unless defined $val;
1328 utf8::encode( $param ) if utf8::is_utf8($param);
1329 # using the URI::Escape pattern here so utf8 chars survive
1330 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1332 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1336 my $res = bless(\"${base}${args}${query}", $class);
1340 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1342 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1348 A private path to the Catalyst action you want to create a URI for.
1350 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1351 >> and passing the resulting C<$action> and the remaining arguments to C<<
1354 You can also pass in a Catalyst::Action object, in which case it is passed to
1357 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.
1359 For example, if the action looks like:
1361 package MyApp::Controller::Users;
1363 sub lst : Path('the-list') {}
1367 $c->uri_for_action('/users/lst')
1369 and it will create the URI /users/the-list.
1375 sub uri_for_action {
1376 my ( $c, $path, @args ) = @_;
1377 my $action = blessed($path)
1379 : $c->dispatcher->get_action_by_path($path);
1380 unless (defined $action) {
1381 croak "Can't find action for path '$path'";
1383 return $c->uri_for( $action, @args );
1386 =head2 $c->welcome_message
1388 Returns the Catalyst welcome HTML page.
1392 sub welcome_message {
1394 my $name = $c->config->{name};
1395 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1396 my $prefix = Catalyst::Utils::appprefix( ref $c );
1397 $c->response->content_type('text/html; charset=utf-8');
1399 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1400 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1401 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1403 <meta http-equiv="Content-Language" content="en" />
1404 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1405 <title>$name on Catalyst $VERSION</title>
1406 <style type="text/css">
1409 background-color: #eee;
1416 margin-bottom: 10px;
1418 background-color: #ccc;
1419 border: 1px solid #aaa;
1424 font-family: verdana, tahoma, sans-serif;
1427 font-family: verdana, tahoma, sans-serif;
1430 text-decoration: none;
1432 border-bottom: 1px dotted #bbb;
1434 :link:hover, :visited:hover {
1447 background-color: #fff;
1448 border: 1px solid #aaa;
1452 font-weight: normal;
1474 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1479 <img src="$logo" alt="Catalyst Logo" />
1481 <p>Welcome to the world of Catalyst.
1482 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1483 framework will make web development something you had
1484 never expected it to be: Fun, rewarding, and quick.</p>
1485 <h2>What to do now?</h2>
1486 <p>That really depends on what <b>you</b> want to do.
1487 We do, however, provide you with a few starting points.</p>
1488 <p>If you want to jump right into web development with Catalyst
1489 you might want to start with a tutorial.</p>
1490 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1492 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1494 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1495 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1497 <h2>What to do next?</h2>
1498 <p>Next it's time to write an actual application. Use the
1499 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1500 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1501 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1502 they can save you a lot of work.</p>
1503 <pre><code>script/${prefix}_create.pl -help</code></pre>
1504 <p>Also, be sure to check out the vast and growing
1505 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1506 you are likely to find what you need there.
1510 <p>Catalyst has a very active community. Here are the main places to
1511 get in touch with us.</p>
1514 <a href="http://dev.catalyst.perl.org">Wiki</a>
1517 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1520 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1523 <h2>In conclusion</h2>
1524 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1525 as we enjoyed making it. Please contact us if you have ideas
1526 for improvement or other feedback.</p>
1534 =head1 INTERNAL METHODS
1536 These methods are not meant to be used by end users.
1538 =head2 $c->components
1540 Returns a hash of components.
1542 =head2 $c->context_class
1544 Returns or sets the context class.
1548 Returns a hashref containing coderefs and execution counts (needed for
1549 deep recursion detection).
1553 Returns the number of actions on the current internal execution stack.
1557 Dispatches a request to actions.
1561 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1563 =head2 $c->dispatcher_class
1565 Returns or sets the dispatcher class.
1567 =head2 $c->dump_these
1569 Returns a list of 2-element array references (name, structure) pairs
1570 that will be dumped on the error page in debug mode.
1576 [ Request => $c->req ],
1577 [ Response => $c->res ],
1578 [ Stash => $c->stash ],
1579 [ Config => $c->config ];
1582 =head2 $c->engine_class
1584 Returns or sets the engine class.
1586 =head2 $c->execute( $class, $coderef )
1588 Execute a coderef in given class and catch exceptions. Errors are available
1594 my ( $c, $class, $code ) = @_;
1595 $class = $c->component($class) || $class;
1598 if ( $c->depth >= $RECURSION ) {
1599 my $action = $code->reverse();
1600 $action = "/$action" unless $action =~ /->/;
1601 my $error = qq/Deep recursion detected calling "${action}"/;
1602 $c->log->error($error);
1608 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1610 push( @{ $c->stack }, $code );
1612 no warnings 'recursion';
1613 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1615 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1617 my $last = pop( @{ $c->stack } );
1619 if ( my $error = $@ ) {
1620 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1621 $error->rethrow if $c->depth > 1;
1623 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1624 $error->rethrow if $c->depth > 0;
1627 unless ( ref $error ) {
1628 no warnings 'uninitialized';
1630 my $class = $last->class;
1631 my $name = $last->name;
1632 $error = qq/Caught exception in $class->$name "$error"/;
1641 sub _stats_start_execute {
1642 my ( $c, $code ) = @_;
1643 my $appclass = ref($c) || $c;
1644 return if ( ( $code->name =~ /^_.*/ )
1645 && ( !$appclass->config->{show_internal_actions} ) );
1647 my $action_name = $code->reverse();
1648 $c->counter->{$action_name}++;
1650 my $action = $action_name;
1651 $action = "/$action" unless $action =~ /->/;
1653 # determine if the call was the result of a forward
1654 # this is done by walking up the call stack and looking for a calling
1655 # sub of Catalyst::forward before the eval
1657 for my $index ( 2 .. 11 ) {
1659 if ( ( caller($index) )[0] eq 'Catalyst'
1660 && ( caller($index) )[3] eq '(eval)' );
1662 if ( ( caller($index) )[3] =~ /forward$/ ) {
1663 $callsub = ( caller($index) )[3];
1664 $action = "-> $action";
1669 my $uid = $action_name . $c->counter->{$action_name};
1671 # is this a root-level call or a forwarded call?
1672 if ( $callsub =~ /forward$/ ) {
1673 my $parent = $c->stack->[-1];
1675 # forward, locate the caller
1676 if ( exists $c->counter->{"$parent"} ) {
1679 parent => "$parent" . $c->counter->{"$parent"},
1685 # forward with no caller may come from a plugin
1704 sub _stats_finish_execute {
1705 my ( $c, $info ) = @_;
1706 $c->stats->profile( end => $info );
1711 Finalizes the request.
1718 for my $error ( @{ $c->error } ) {
1719 $c->log->error($error);
1722 # Allow engine to handle finalize flow (for POE)
1723 my $engine = $c->engine;
1724 if ( my $code = $engine->can('finalize') ) {
1729 $c->finalize_uploads;
1732 if ( $#{ $c->error } >= 0 ) {
1736 $c->finalize_headers;
1739 if ( $c->request->method eq 'HEAD' ) {
1740 $c->response->body('');
1748 if ($c->use_stats) {
1749 my $elapsed = sprintf '%f', $c->stats->elapsed;
1750 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1752 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1755 return $c->response->status;
1758 =head2 $c->finalize_body
1764 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1766 =head2 $c->finalize_cookies
1772 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1774 =head2 $c->finalize_error
1780 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1782 =head2 $c->finalize_headers
1788 sub finalize_headers {
1791 my $response = $c->response; #accessor calls can add up?
1793 # Check if we already finalized headers
1794 return if $response->finalized_headers;
1797 if ( my $location = $response->redirect ) {
1798 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1799 $response->header( Location => $location );
1801 if ( !$response->has_body ) {
1802 # Add a default body if none is already present
1804 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1810 if ( $response->body && !$response->content_length ) {
1812 # get the length from a filehandle
1813 if ( blessed( $response->body ) && $response->body->can('read') )
1815 my $stat = stat $response->body;
1816 if ( $stat && $stat->size > 0 ) {
1817 $response->content_length( $stat->size );
1820 $c->log->warn('Serving filehandle without a content-length');
1824 # everything should be bytes at this point, but just in case
1825 $response->content_length( length( $response->body ) );
1830 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1831 $response->headers->remove_header("Content-Length");
1832 $response->body('');
1835 $c->finalize_cookies;
1837 $c->engine->finalize_headers( $c, @_ );
1840 $response->finalized_headers(1);
1843 =head2 $c->finalize_output
1845 An alias for finalize_body.
1847 =head2 $c->finalize_read
1849 Finalizes the input after reading is complete.
1853 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1855 =head2 $c->finalize_uploads
1857 Finalizes uploads. Cleans up any temporary files.
1861 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1863 =head2 $c->get_action( $action, $namespace )
1865 Gets an action in a given namespace.
1869 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1871 =head2 $c->get_actions( $action, $namespace )
1873 Gets all actions of a given name in a namespace and all parent
1878 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1880 =head2 $c->handle_request( $class, @arguments )
1882 Called to handle each HTTP request.
1886 sub handle_request {
1887 my ( $class, @arguments ) = @_;
1889 # Always expect worst case!
1892 if ($class->debug) {
1893 my $secs = time - $START || 1;
1894 my $av = sprintf '%.3f', $COUNT / $secs;
1895 my $time = localtime time;
1896 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1899 my $c = $class->prepare(@arguments);
1901 $status = $c->finalize;
1904 if ( my $error = $@ ) {
1906 $class->log->error(qq/Caught exception in engine "$error"/);
1911 if(my $coderef = $class->log->can('_flush')){
1912 $class->log->$coderef();
1917 =head2 $c->prepare( @arguments )
1919 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1925 my ( $class, @arguments ) = @_;
1928 # After the app/ctxt split, this should become an attribute based on something passed
1929 # into the application.
1930 $class->context_class( ref $class || $class ) unless $class->context_class;
1932 my $c = $class->context_class->new({});
1934 # For on-demand data
1935 $c->request->_context($c);
1936 $c->response->_context($c);
1938 #surely this is not the most efficient way to do things...
1939 $c->stats($class->stats_class->new)->enable($c->use_stats);
1941 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1944 #XXX reuse coderef from can
1945 # Allow engine to direct the prepare flow (for POE)
1946 if ( $c->engine->can('prepare') ) {
1947 $c->engine->prepare( $c, @arguments );
1950 $c->prepare_request(@arguments);
1951 $c->prepare_connection;
1952 $c->prepare_query_parameters;
1953 $c->prepare_headers;
1954 $c->prepare_cookies;
1957 # Prepare the body for reading, either by prepare_body
1958 # or the user, if they are using $c->read
1961 # Parse the body unless the user wants it on-demand
1962 unless ( ref($c)->config->{parse_on_demand} ) {
1967 my $method = $c->req->method || '';
1968 my $path = $c->req->path;
1969 $path = '/' unless length $path;
1970 my $address = $c->req->address || '';
1979 =head2 $c->prepare_action
1981 Prepares action. See L<Catalyst::Dispatcher>.
1985 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1987 =head2 $c->prepare_body
1989 Prepares message body.
1996 return if $c->request->_has_body;
1998 # Initialize on-demand data
1999 $c->engine->prepare_body( $c, @_ );
2000 $c->prepare_parameters;
2001 $c->prepare_uploads;
2004 =head2 $c->prepare_body_chunk( $chunk )
2006 Prepares a chunk of data before sending it to L<HTTP::Body>.
2008 See L<Catalyst::Engine>.
2012 sub prepare_body_chunk {
2014 $c->engine->prepare_body_chunk( $c, @_ );
2017 =head2 $c->prepare_body_parameters
2019 Prepares body parameters.
2023 sub prepare_body_parameters {
2025 $c->engine->prepare_body_parameters( $c, @_ );
2028 =head2 $c->prepare_connection
2030 Prepares connection.
2034 sub prepare_connection {
2036 $c->engine->prepare_connection( $c, @_ );
2039 =head2 $c->prepare_cookies
2045 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2047 =head2 $c->prepare_headers
2053 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2055 =head2 $c->prepare_parameters
2057 Prepares parameters.
2061 sub prepare_parameters {
2063 $c->prepare_body_parameters;
2064 $c->engine->prepare_parameters( $c, @_ );
2067 =head2 $c->prepare_path
2069 Prepares path and base.
2073 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2075 =head2 $c->prepare_query_parameters
2077 Prepares query parameters.
2081 sub prepare_query_parameters {
2084 $c->engine->prepare_query_parameters( $c, @_ );
2087 =head2 $c->log_request
2089 Writes information about the request to the debug logs. This includes:
2093 =item * Request method, path, and remote IP address
2095 =item * Request headers (see L</log_headers>)
2097 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2099 =item * Request parameters
2101 =item * File uploads
2110 return unless $c->debug;
2112 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2113 my $request = $dump->[1];
2115 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2117 $path = '/' unless length $path;
2119 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2121 $c->log_headers('request', $request->headers);
2123 if ( my $keywords = $request->query_keywords ) {
2124 $c->log->debug("Query keywords are: $keywords");
2127 $c->log_request_parameters( query => $request->query_parameters, body => $request->body_parameters );
2129 $c->log_request_uploads($request);
2132 =head2 $c->log_response
2134 Writes information about the response to the debug logs. This includes:
2138 =item * Response status code
2140 =item * Response headers (see L</log_headers>)
2149 return unless $c->debug;
2151 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2152 my $response = $dump->[1];
2154 $c->log->debug('Response Status: ' . $response->status);
2155 $c->log_headers('response', $response->headers);
2158 =head2 $c->log_request_parameters( query => {}, body => {} )
2160 Logs request parameters to debug logs
2164 sub log_request_parameters {
2166 my %all_params = @_;
2168 return unless $c->debug;
2170 my $column_width = Catalyst::Utils::term_width() - 44;
2171 foreach my $type (qw(query body)) {
2172 my $params = $all_params{$type};
2173 next if ! keys %$params;
2174 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2175 for my $key ( sort keys %$params ) {
2176 my $param = $params->{$key};
2177 my $value = defined($param) ? $param : '';
2178 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2180 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2184 =head2 $c->log_request_uploads
2186 Logs file uploads included in the request to the debug logs.
2187 The parameter name, filename, file type, and file size are all included in
2192 sub log_request_uploads {
2194 my $request = shift;
2195 return unless $c->debug;
2196 my $uploads = $request->uploads;
2197 if ( keys %$uploads ) {
2198 my $t = Text::SimpleTable->new(
2199 [ 12, 'Parameter' ],
2204 for my $key ( sort keys %$uploads ) {
2205 my $upload = $uploads->{$key};
2206 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2207 $t->row( $key, $u->filename, $u->type, $u->size );
2210 $c->log->debug( "File Uploads are:\n" . $t->draw );
2214 =head2 $c->log_headers($type => $headers)
2216 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2223 my $headers = shift; # an HTTP::Headers instance
2225 return unless $c->debug;
2227 my $t = Text::SimpleTable->new( [ 35, 'Header Name' ], [ 40, 'Value' ] );
2230 my ( $name, $value ) = @_;
2231 $t->row( $name, $value );
2234 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2238 =head2 $c->prepare_read
2240 Prepares the input for reading.
2244 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2246 =head2 $c->prepare_request
2248 Prepares the engine request.
2252 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2254 =head2 $c->prepare_uploads
2260 sub prepare_uploads {
2263 $c->engine->prepare_uploads( $c, @_ );
2266 =head2 $c->prepare_write
2268 Prepares the output for writing.
2272 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2274 =head2 $c->request_class
2276 Returns or sets the request class.
2278 =head2 $c->response_class
2280 Returns or sets the response class.
2282 =head2 $c->read( [$maxlength] )
2284 Reads a chunk of data from the request body. This method is designed to
2285 be used in a while loop, reading C<$maxlength> bytes on every call.
2286 C<$maxlength> defaults to the size of the request if not specified.
2288 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2291 Warning: If you use read(), Catalyst will not process the body,
2292 so you will not be able to access POST parameters or file uploads via
2293 $c->request. You must handle all body parsing yourself.
2297 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2305 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2307 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2309 Sets an action in a given namespace.
2313 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2315 =head2 $c->setup_actions($component)
2317 Sets up actions for a component.
2321 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2323 =head2 $c->setup_components
2325 This method is called internally to set up the application's components.
2327 It finds modules by calling the L<locate_components> method, expands them to
2328 package names with the L<expand_component_module> method, and then installs
2329 each component into the application.
2331 The C<setup_components> config option is passed to both of the above methods.
2333 Installation of each component is performed by the L<setup_component> method,
2338 sub setup_components {
2341 my $config = $class->config->{ setup_components };
2343 my @comps = sort { length $a <=> length $b }
2344 $class->locate_components($config);
2345 my %comps = map { $_ => 1 } @comps;
2347 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2348 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2349 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2350 ) if $deprecatedcatalyst_component_names;
2352 for my $component ( @comps ) {
2354 # We pass ignore_loaded here so that overlay files for (e.g.)
2355 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2356 # we know M::P::O found a file on disk so this is safe
2358 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2360 # Needs to be done as soon as the component is loaded, as loading a sub-component
2361 # (next time round the loop) can cause us to get the wrong metaclass..
2362 $class->_controller_init_base_classes($component);
2365 for my $component (@comps) {
2366 my $instance = $class->components->{ $component } = $class->setup_component($component);
2367 my @expanded_components = $instance->can('expand_modules')
2368 ? $instance->expand_modules( $component, $config )
2369 : $class->expand_component_module( $component, $config );
2370 for my $component (@expanded_components) {
2371 next if $comps{$component};
2372 $class->_controller_init_base_classes($component); # Also cover inner packages
2373 $class->components->{ $component } = $class->setup_component($component);
2378 =head2 $c->locate_components( $setup_component_config )
2380 This method is meant to provide a list of component modules that should be
2381 setup for the application. By default, it will use L<Module::Pluggable>.
2383 Specify a C<setup_components> config option to pass additional options directly
2384 to L<Module::Pluggable>. To add additional search paths, specify a key named
2385 C<search_extra> as an array reference. Items in the array beginning with C<::>
2386 will have the application class name prepended to them.
2390 sub locate_components {
2394 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2395 my $extra = delete $config->{ search_extra } || [];
2397 push @paths, @$extra;
2399 my $locator = Module::Pluggable::Object->new(
2400 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2404 my @comps = $locator->plugins;
2409 =head2 $c->expand_component_module( $component, $setup_component_config )
2411 Components found by C<locate_components> will be passed to this method, which
2412 is expected to return a list of component (package) names to be set up.
2416 sub expand_component_module {
2417 my ($class, $module) = @_;
2418 return Devel::InnerPackage::list_packages( $module );
2421 =head2 $c->setup_component
2425 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2426 # nearest to Catalyst::Controller first, no matter what order stuff happens
2427 # to be loaded. There are TODO tests in Moose for this, see
2428 # f2391d17574eff81d911b97be15ea51080500003
2429 sub _controller_init_base_classes {
2430 my ($app_class, $component) = @_;
2431 return unless $component->isa('Catalyst::Controller');
2432 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2433 Moose::Meta::Class->initialize( $class )
2434 unless find_meta($class);
2438 sub setup_component {
2439 my( $class, $component ) = @_;
2441 unless ( $component->can( 'COMPONENT' ) ) {
2445 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2446 my $config = $class->config->{ $suffix } || {};
2447 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2448 # methods also pass it. local to avoid pointlessly shitting in config
2449 # for the debug screen, as $component is already the key name.
2450 local $config->{catalyst_component_name} = $component;
2452 my $instance = eval { $component->COMPONENT( $class, $config ); };
2454 if ( my $error = $@ ) {
2456 Catalyst::Exception->throw(
2457 message => qq/Couldn't instantiate component "$component", "$error"/
2461 unless (blessed $instance) {
2462 my $metaclass = Moose::Util::find_meta($component);
2463 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2464 my $component_method_from = $method_meta->associated_metaclass->name;
2465 my $value = defined($instance) ? $instance : 'undef';
2466 Catalyst::Exception->throw(
2468 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2474 =head2 $c->setup_dispatcher
2480 sub setup_dispatcher {
2481 my ( $class, $dispatcher ) = @_;
2484 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2487 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2488 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2491 unless ($dispatcher) {
2492 $dispatcher = $class->dispatcher_class;
2495 Class::MOP::load_class($dispatcher);
2497 # dispatcher instance
2498 $class->dispatcher( $dispatcher->new );
2501 =head2 $c->setup_engine
2508 my ( $class, $engine ) = @_;
2511 $engine = 'Catalyst::Engine::' . $engine;
2514 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2515 $engine = 'Catalyst::Engine::' . $env;
2518 if ( $ENV{MOD_PERL} ) {
2519 my $meta = Class::MOP::get_metaclass_by_name($class);
2521 # create the apache method
2522 $meta->add_method('apache' => sub { shift->engine->apache });
2524 my ( $software, $version ) =
2525 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2528 $version =~ s/(\.[^.]+)\./$1/g;
2530 if ( $software eq 'mod_perl' ) {
2534 if ( $version >= 1.99922 ) {
2535 $engine = 'Catalyst::Engine::Apache2::MP20';
2538 elsif ( $version >= 1.9901 ) {
2539 $engine = 'Catalyst::Engine::Apache2::MP19';
2542 elsif ( $version >= 1.24 ) {
2543 $engine = 'Catalyst::Engine::Apache::MP13';
2547 Catalyst::Exception->throw( message =>
2548 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2553 # install the correct mod_perl handler
2554 if ( $version >= 1.9901 ) {
2555 *handler = sub : method {
2556 shift->handle_request(@_);
2560 *handler = sub ($$) { shift->handle_request(@_) };
2565 elsif ( $software eq 'Zeus-Perl' ) {
2566 $engine = 'Catalyst::Engine::Zeus';
2570 Catalyst::Exception->throw(
2571 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2576 $engine = $class->engine_class;
2579 Class::MOP::load_class($engine);
2581 # check for old engines that are no longer compatible
2583 if ( $engine->isa('Catalyst::Engine::Apache')
2584 && !Catalyst::Engine::Apache->VERSION )
2589 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2590 && Catalyst::Engine::Server->VERSION le '0.02' )
2595 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2596 && $engine->VERSION eq '0.01' )
2601 elsif ($engine->isa('Catalyst::Engine::Zeus')
2602 && $engine->VERSION eq '0.01' )
2608 Catalyst::Exception->throw( message =>
2609 qq/Engine "$engine" is not supported by this version of Catalyst/
2614 $class->engine( $engine->new );
2617 =head2 $c->setup_home
2619 Sets up the home directory.
2624 my ( $class, $home ) = @_;
2626 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2630 $home ||= Catalyst::Utils::home($class);
2633 #I remember recently being scolded for assigning config values like this
2634 $class->config->{home} ||= $home;
2635 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2639 =head2 $c->setup_log
2641 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2642 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2645 This method also installs a C<debug> method that returns a true value into the
2646 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2647 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2649 Note that if the log has already been setup, by either a previous call to
2650 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2651 that this method won't actually set up the log object.
2656 my ( $class, $levels ) = @_;
2659 $levels =~ s/^\s+//;
2660 $levels =~ s/\s+$//;
2661 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2663 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2664 if ( defined $env_debug ) {
2665 $levels{debug} = 1 if $env_debug; # Ugly!
2666 delete($levels{debug}) unless $env_debug;
2669 unless ( $class->log ) {
2670 $class->log( Catalyst::Log->new(keys %levels) );
2673 if ( $levels{debug} ) {
2674 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2675 $class->log->debug('Debug messages enabled');
2679 =head2 $c->setup_plugins
2685 =head2 $c->setup_stats
2687 Sets up timing statistics class.
2692 my ( $class, $stats ) = @_;
2694 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2696 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2697 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2698 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2699 $class->log->debug('Statistics enabled');
2704 =head2 $c->registered_plugins
2706 Returns a sorted list of the plugins which have either been stated in the
2707 import list or which have been added via C<< MyApp->plugin(@args); >>.
2709 If passed a given plugin name, it will report a boolean value indicating
2710 whether or not that plugin is loaded. A fully qualified name is required if
2711 the plugin name does not begin with C<Catalyst::Plugin::>.
2713 if ($c->registered_plugins('Some::Plugin')) {
2721 sub registered_plugins {
2723 return sort keys %{ $proto->_plugins } unless @_;
2725 return 1 if exists $proto->_plugins->{$plugin};
2726 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2729 sub _register_plugin {
2730 my ( $proto, $plugin, $instant ) = @_;
2731 my $class = ref $proto || $proto;
2733 Class::MOP::load_class( $plugin );
2734 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2735 if $plugin->isa( 'Catalyst::Component' );
2736 $proto->_plugins->{$plugin} = 1;
2739 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2740 my @superclasses = ($plugin, $meta->superclasses );
2741 $meta->superclasses(@superclasses);
2743 unshift @{"$class\::ISA"}, $plugin;
2750 my ( $class, $plugins ) = @_;
2752 $class->_plugins( {} ) unless $class->_plugins;
2755 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2757 for my $plugin ( reverse @plugins ) {
2758 Class::MOP::load_class($plugin);
2759 my $meta = find_meta($plugin);
2760 next if $meta && $meta->isa('Moose::Meta::Role');
2762 $class->_register_plugin($plugin);
2767 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2768 map { find_meta($_) }
2771 Moose::Util::apply_all_roles(
2779 Returns an arrayref of the internal execution stack (actions that are
2780 currently executing).
2782 =head2 $c->stats_class
2784 Returns or sets the stats (timing statistics) class.
2786 =head2 $c->use_stats
2788 Returns 1 when stats collection is enabled. Stats collection is enabled
2789 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2790 environment variable is set.
2792 Note that this is a static method, not an accessor and should be overridden
2793 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2800 =head2 $c->write( $data )
2802 Writes $data to the output stream. When using this method directly, you
2803 will need to manually set the C<Content-Length> header to the length of
2804 your output data, if known.
2811 # Finalize headers if someone manually writes output
2812 $c->finalize_headers;
2814 return $c->engine->write( $c, @_ );
2819 Returns the Catalyst version number. Mostly useful for "powered by"
2820 messages in template systems.
2824 sub version { return $Catalyst::VERSION }
2826 =head1 CONFIGURATION
2828 There are a number of 'base' config variables which can be set:
2834 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2838 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2842 C<disable_component_resolution_regex_fallback> - Turns
2843 off the deprecated component resolution functionality so
2844 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2845 are called then regex search will not be attempted on string values and
2846 instead C<undef> will be returned.
2850 C<home> - The application home directory. In an uninstalled application,
2851 this is the top level application directory. In an installed application,
2852 this will be the directory containing C<< MyApp.pm >>.
2856 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2860 C<name> - The name of the application in debug messages and the debug and
2865 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2866 until it is accessed. This allows you to (for example) check authentication (and reject
2867 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2871 C<root> - The root directory for templates. Usually this is just a
2872 subdirectory of the home directory, but you can set it to change the
2873 templates to a different directory.
2877 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2878 namespaces from which components will be loaded (and constructed and stored in
2879 C<< $c->components >>).
2883 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2884 to be shown in hit debug tables in the test server.
2888 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2892 =head1 INTERNAL ACTIONS
2894 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2895 C<_ACTION>, and C<_END>. These are by default not shown in the private
2896 action table, but you can make them visible with a config parameter.
2898 MyApp->config(show_internal_actions => 1);
2900 =head1 ON-DEMAND PARSER
2902 The request body is usually parsed at the beginning of a request,
2903 but if you want to handle input yourself, you can enable on-demand
2904 parsing with a config parameter.
2906 MyApp->config(parse_on_demand => 1);
2908 =head1 PROXY SUPPORT
2910 Many production servers operate using the common double-server approach,
2911 with a lightweight frontend web server passing requests to a larger
2912 backend server. An application running on the backend server must deal
2913 with two problems: the remote user always appears to be C<127.0.0.1> and
2914 the server's hostname will appear to be C<localhost> regardless of the
2915 virtual host that the user connected through.
2917 Catalyst will automatically detect this situation when you are running
2918 the frontend and backend servers on the same machine. The following
2919 changes are made to the request.
2921 $c->req->address is set to the user's real IP address, as read from
2922 the HTTP X-Forwarded-For header.
2924 The host value for $c->req->base and $c->req->uri is set to the real
2925 host, as read from the HTTP X-Forwarded-Host header.
2927 Additionally, you may be running your backend application on an insecure
2928 connection (port 80) while your frontend proxy is running under SSL. If there
2929 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2930 tell Catalyst what port the frontend listens on. This will allow all URIs to
2931 be created properly.
2933 In the case of passing in:
2935 X-Forwarded-Port: 443
2937 All calls to C<uri_for> will result in an https link, as is expected.
2939 Obviously, your web server must support these headers for this to work.
2941 In a more complex server farm environment where you may have your
2942 frontend proxy server(s) on different machines, you will need to set a
2943 configuration option to tell Catalyst to read the proxied data from the
2946 MyApp->config(using_frontend_proxy => 1);
2948 If you do not wish to use the proxy support at all, you may set:
2950 MyApp->config(ignore_frontend_proxy => 1);
2952 =head1 THREAD SAFETY
2954 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2955 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2956 believe the Catalyst core to be thread-safe.
2958 If you plan to operate in a threaded environment, remember that all other
2959 modules you are using must also be thread-safe. Some modules, most notably
2960 L<DBD::SQLite>, are not thread-safe.
2966 Join #catalyst on irc.perl.org.
2970 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2971 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2975 http://catalyst.perl.org
2979 http://dev.catalyst.perl.org
2983 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2985 =head2 L<Catalyst::Manual> - The Catalyst Manual
2987 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2989 =head2 L<Catalyst::Engine> - Core engine
2991 =head2 L<Catalyst::Log> - Log class.
2993 =head2 L<Catalyst::Request> - Request object
2995 =head2 L<Catalyst::Response> - Response object
2997 =head2 L<Catalyst::Test> - The test suite.
2999 =head1 PROJECT FOUNDER
3001 sri: Sebastian Riedel <sri@cpan.org>
3007 acme: Leon Brocard <leon@astray.com>
3009 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3013 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3017 andyg: Andy Grundman <andy@hybridized.org>
3019 audreyt: Audrey Tang
3021 bricas: Brian Cassidy <bricas@cpan.org>
3023 Caelum: Rafael Kitover <rkitover@io.com>
3025 chansen: Christian Hansen
3027 chicks: Christopher Hicks
3029 Chisel Wright C<pause@herlpacker.co.uk>
3031 Danijel Milicevic C<me@danijel.de>
3033 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3035 David Naughton, C<naughton@umn.edu>
3039 dhoss: Devin Austin <dhoss@cpan.org>
3041 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3045 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3047 esskar: Sascha Kiefer
3049 fireartist: Carl Franks <cfranks@cpan.org>
3051 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3053 gabb: Danijel Milicevic
3057 Gavin Henry C<ghenry@perl.me.uk>
3061 groditi: Guillermo Roditi <groditi@gmail.com>
3063 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3065 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3067 jcamacho: Juan Camacho
3069 jester: Jesse Sheidlower C<jester@panix.com>
3071 jhannah: Jay Hannah <jay@jays.net>
3077 jon: Jon Schutz <jjschutz@cpan.org>
3079 Jonathan Rockway C<< <jrockway@cpan.org> >>
3081 Kieren Diment C<kd@totaldatasolution.com>
3083 konobi: Scott McWhirter <konobi@cpan.org>
3085 marcus: Marcus Ramberg <mramberg@cpan.org>
3087 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3089 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3093 naughton: David Naughton
3095 ningu: David Kamholz <dkamholz@cpan.org>
3097 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3099 numa: Dan Sully <daniel@cpan.org>
3105 omega: Andreas Marienborg
3107 Oleg Kostyuk <cub.uanic@gmail.com>
3109 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3111 rafl: Florian Ragwitz <rafl@debian.org>
3113 random: Roland Lammel <lammel@cpan.org>
3115 Robert Sedlacek C<< <rs@474.at> >>
3119 t0m: Tomas Doran <bobtfish@bobtfish.net>
3123 Viljo Marrandi C<vilts@yahoo.com>
3125 Will Hawes C<info@whawes.co.uk>
3127 willert: Sebastian Willert <willert@cpan.org>
3129 Yuval Kogman, C<nothingmuch@woobling.org>
3133 This library is free software. You can redistribute it and/or modify it under
3134 the same terms as Perl itself.
3140 __PACKAGE__->meta->make_immutable;