4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
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;
19 use Text::SimpleTable ();
20 use Path::Class::Dir ();
21 use Path::Class::File ();
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
27 use Class::C3::Adopt::NEXT;
28 use List::MoreUtils qw/uniq/;
30 use String::RewritePrefix;
31 use Catalyst::EngineLoader;
33 use Carp qw/croak carp shortmess/;
35 use Plack::Middleware::Conditional;
36 use Plack::Middleware::ReverseProxy;
37 use Plack::Middleware::IIS6ScriptNameFix;
38 use Plack::Middleware::LighttpdScriptNameFix;
40 BEGIN { require 5.008003; }
42 has stack => (is => 'ro', default => sub { [] });
43 has stash => (is => 'rw', default => sub { {} });
44 has state => (is => 'rw', default => 0);
45 has stats => (is => 'rw');
46 has action => (is => 'rw');
47 has counter => (is => 'rw', default => sub { {} });
52 my %p = ( _log => $self->log );
53 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
54 $self->request_class->new(\%p);
62 $self->response_class->new({ _log => $self->log });
66 has namespace => (is => 'rw');
68 sub depth { scalar @{ shift->stack || [] }; }
69 sub comp { shift->component(@_) }
72 my $self = shift; return $self->request(@_);
75 my $self = shift; return $self->response(@_);
78 # For backwards compatibility
79 sub finalize_output { shift->finalize_body(@_) };
84 our $RECURSION = 1000;
85 our $DETACH = Catalyst::Exception::Detach->new;
86 our $GO = Catalyst::Exception::Go->new;
88 #I imagine that very few of these really need to be class variables. if any.
89 #maybe we should just make them attributes with a default?
90 __PACKAGE__->mk_classdata($_)
91 for qw/container arguments dispatcher engine log dispatcher_class
92 engine_loader context_class request_class response_class stats_class
93 setup_finished _psgi_app loading_psgi_file run_options/;
95 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
96 __PACKAGE__->request_class('Catalyst::Request');
97 __PACKAGE__->response_class('Catalyst::Response');
98 __PACKAGE__->stats_class('Catalyst::Stats');
100 # Remember to update this in Catalyst::Runtime as well!
102 our $VERSION = '5.90015';
105 my ( $class, @arguments ) = @_;
107 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
109 return unless $class eq 'Catalyst';
111 my $caller = caller();
112 return if $caller eq 'main';
114 my $meta = Moose::Meta::Class->initialize($caller);
116 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
117 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
118 $meta->superclasses(@superclasses); # XXX - Remove!
121 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
122 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
124 unless( $meta->has_method('meta') ){
125 if ($Moose::VERSION >= 1.15) {
126 $meta->_add_meta_method('meta');
129 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
133 $caller->arguments( [@arguments] );
137 # we call setup_home on import AND on ->setup
138 # is there a reason for it?
139 # anyway there is no point for setup_home without setup_config() so...
140 $caller->setup_config;
144 sub MODIFY_CODE_ATTRIBUTES {
145 Catalyst::Exception->throw(
146 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
147 "That has been deprecated and removed. You should create a " .
148 "controller class called Root.pm, and move relevant code to that class."
153 sub _application { $_[0] }
159 Catalyst - The Elegant MVC Web Application Framework
163 See the L<Catalyst::Manual> distribution for comprehensive
164 documentation and tutorials.
166 # Install Catalyst::Devel for helpers and other development tools
167 # use the helper to create a new application
170 # add models, views, controllers
171 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
172 script/myapp_create.pl view MyTemplate TT
173 script/myapp_create.pl controller Search
175 # built in testserver -- use -r to restart automatically on changes
176 # --help to see all available options
177 script/myapp_server.pl
179 # command line testing interface
180 script/myapp_test.pl /yada
183 use Catalyst qw/-Debug/; # include plugins here as well
185 ### In lib/MyApp/Controller/Root.pm (autocreated)
186 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
187 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
188 $c->stash->{template} = 'foo.tt'; # set the template
189 # lookup something from db -- stash vars are passed to TT
191 $c->model('Database::Foo')->search( { country => $args[0] } );
192 if ( $c->req->params->{bar} ) { # access GET or POST parameters
193 $c->forward( 'bar' ); # process another action
194 # do something else after forward returns
198 # The foo.tt TT template can use the stash data from the database
199 [% WHILE (item = data.next) %]
203 # called for /bar/of/soap, /bar/of/soap/10, etc.
204 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
206 # called after all actions are finished
208 my ( $self, $c ) = @_;
209 if ( scalar @{ $c->error } ) { ... } # handle errors
210 return if $c->res->body; # already have a response
211 $c->forward( 'MyApp::View::TT' ); # render template
214 See L<Catalyst::Manual::Intro> for additional information.
218 Catalyst is a modern framework for making web applications without the
219 pain usually associated with this process. This document is a reference
220 to the main Catalyst application. If you are a new user, we suggest you
221 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
223 See L<Catalyst::Manual> for more documentation.
225 Catalyst plugins can be loaded by naming them as arguments to the "use
226 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
227 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
230 use Catalyst qw/My::Module/;
232 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
233 fully qualify the name by using a unary plus:
237 +Fully::Qualified::Plugin::Name
240 Special flags like C<-Debug> can also be specified as
241 arguments when Catalyst is loaded:
243 use Catalyst qw/-Debug My::Module/;
245 The position of plugins and flags in the chain is important, because
246 they are loaded in the order in which they appear.
248 The following flags are supported:
252 Enables debug output. You can also force this setting from the system
253 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
254 settings override the application, with <MYAPP>_DEBUG having the highest
257 This sets the log level to 'debug' and enables full debug output on the
258 error screen. If you only want the latter, see L<< $c->debug >>.
262 Forces Catalyst to use a specific home directory, e.g.:
264 use Catalyst qw[-Home=/usr/mst];
266 This can also be done in the shell environment by setting either the
267 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
268 is replaced with the uppercased name of your application, any "::" in
269 the name will be replaced with underscores, e.g. MyApp::Web should use
270 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
272 If none of these are set, Catalyst will attempt to automatically detect the
273 home directory. If you are working in a development environment, Catalyst
274 will try and find the directory containing either Makefile.PL, Build.PL or
275 dist.ini. If the application has been installed into the system (i.e.
276 you have done C<make install>), then Catalyst will use the path to your
277 application module, without the .pm extension (e.g., /foo/MyApp if your
278 application was installed at /foo/MyApp.pm)
282 use Catalyst '-Log=warn,fatal,error';
284 Specifies a comma-delimited list of log levels.
288 Enables statistics collection and reporting.
290 use Catalyst qw/-Stats=1/;
292 You can also force this setting from the system environment with CATALYST_STATS
293 or <MYAPP>_STATS. The environment settings override the application, with
294 <MYAPP>_STATS having the highest priority.
296 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
300 =head2 INFORMATION ABOUT THE CURRENT REQUEST
304 Returns a L<Catalyst::Action> object for the current action, which
305 stringifies to the action name. See L<Catalyst::Action>.
309 Returns the namespace of the current action, i.e., the URI prefix
310 corresponding to the controller of the current action. For example:
312 # in Controller::Foo::Bar
313 $c->namespace; # returns 'foo/bar';
319 Returns the current L<Catalyst::Request> object, giving access to
320 information about the current client request (including parameters,
321 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
323 =head2 REQUEST FLOW HANDLING
325 =head2 $c->forward( $action [, \@arguments ] )
327 =head2 $c->forward( $class, $method, [, \@arguments ] )
329 Forwards processing to another action, by its private name. If you give a
330 class name but no method, C<process()> is called. You may also optionally
331 pass arguments in an arrayref. The action will receive the arguments in
332 C<@_> and C<< $c->req->args >>. Upon returning from the function,
333 C<< $c->req->args >> will be restored to the previous values.
335 Any data C<return>ed from the action forwarded to, will be returned by the
338 my $foodata = $c->forward('/foo');
339 $c->forward('index');
340 $c->forward(qw/Model::DBIC::Foo do_stuff/);
341 $c->forward('View::TT');
343 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
344 an C<< eval { } >> around the call (actually
345 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
346 exceptions thrown by the called action non-fatal and pushing them onto
347 $c->error instead. If you want C<die> to propagate you need to do something
351 die join "\n", @{ $c->error } if @{ $c->error };
353 Or make sure to always return true values from your actions and write
356 $c->forward('foo') || return;
358 Another note is that C<< $c->forward >> always returns a scalar because it
359 actually returns $c->state which operates in a scalar context.
360 Thus, something like:
364 in an action that is forwarded to is going to return a scalar,
365 i.e. how many items are in that array, which is probably not what you want.
366 If you need to return an array then return a reference to it,
369 $c->stash->{array} = \@array;
371 and access it from the stash.
373 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
377 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
379 =head2 $c->detach( $action [, \@arguments ] )
381 =head2 $c->detach( $class, $method, [, \@arguments ] )
385 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
386 doesn't return to the previous action when processing is finished.
388 When called with no arguments it escapes the processing chain entirely.
392 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
394 =head2 $c->visit( $action [, \@arguments ] )
396 =head2 $c->visit( $action [, \@captures, \@arguments ] )
398 =head2 $c->visit( $class, $method, [, \@arguments ] )
400 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
402 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
403 but does a full dispatch, instead of just calling the new C<$action> /
404 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
405 you go to are called, just like a new request.
407 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
408 This means, for example, that C<< $c->action >> methods such as
409 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
410 L<reverse|Catalyst::Action/reverse> return information for the visited action
411 when they are invoked within the visited action. This is different from the
412 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
413 continues to use the $c->action object from the caller action even when
414 invoked from the called action.
416 C<< $c->stash >> is kept unchanged.
418 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
419 allows you to "wrap" another action, just as it would have been called by
420 dispatching from a URL, while the analogous
421 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
422 transfer control to another action as if it had been reached directly from a URL.
426 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
428 =head2 $c->go( $action [, \@arguments ] )
430 =head2 $c->go( $action [, \@captures, \@arguments ] )
432 =head2 $c->go( $class, $method, [, \@arguments ] )
434 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
436 The relationship between C<go> and
437 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
438 the relationship between
439 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
440 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
441 C<< $c->go >> will perform a full dispatch on the specified action or method,
442 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
443 C<go> escapes the processing of the current request chain on completion, and
444 does not return to its caller.
446 @arguments are arguments to the final destination of $action. @captures are
447 arguments to the intermediate steps, if any, on the way to the final sub of
452 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
458 Returns the current L<Catalyst::Response> object, see there for details.
462 Returns a hashref to the stash, which may be used to store data and pass
463 it between components during a request. You can also set hash keys by
464 passing arguments. The stash is automatically sent to the view. The
465 stash is cleared at the end of a request; it cannot be used for
466 persistent storage (for this you must use a session; see
467 L<Catalyst::Plugin::Session> for a complete system integrated with
470 $c->stash->{foo} = $bar;
471 $c->stash( { moose => 'majestic', qux => 0 } );
472 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
474 # stash is automatically passed to the view for use in a template
475 $c->forward( 'MyApp::View::TT' );
479 around stash => sub {
482 my $stash = $orig->($c);
484 my $new_stash = @_ > 1 ? {@_} : $_[0];
485 croak('stash takes a hash or hashref') unless ref $new_stash;
486 foreach my $key ( keys %$new_stash ) {
487 $stash->{$key} = $new_stash->{$key};
497 =head2 $c->error($error, ...)
499 =head2 $c->error($arrayref)
501 Returns an arrayref containing error messages. If Catalyst encounters an
502 error while processing a request, it stores the error in $c->error. This
503 method should only be used to store fatal error messages.
505 my @error = @{ $c->error };
509 $c->error('Something bad happened');
516 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
517 croak @$error unless ref $c;
518 push @{ $c->{error} }, @$error;
520 elsif ( defined $_[0] ) { $c->{error} = undef }
521 return $c->{error} || [];
527 Contains the return value of the last executed action.
528 Note that << $c->state >> operates in a scalar context which means that all
529 values it returns are scalar.
531 =head2 $c->clear_errors
533 Clear errors. You probably don't want to clear the errors unless you are
534 implementing a custom error screen.
536 This is equivalent to running
547 =head2 COMPONENT ACCESSORS
549 =head2 $c->controller($name)
551 Gets a L<Catalyst::Controller> instance by name.
553 $c->controller('Foo')->do_stuff;
555 If the name is omitted, will return the controller for the dispatched
558 If you want to search for controllers, pass in a regexp as the argument.
560 # find all controllers that start with Foo
561 my @foo_controllers = $c->controller(qr{^Foo});
566 sub controller { shift->_lookup_mvc('controller', @_) }
568 =head2 $c->model($name)
570 Gets a L<Catalyst::Model> instance by name.
572 $c->model('Foo')->do_stuff;
574 Any extra arguments are directly passed to ACCEPT_CONTEXT.
576 If the name is omitted, it will look for
577 - a model object in $c->stash->{current_model_instance}, then
578 - a model name in $c->stash->{current_model}, then
579 - a config setting 'default_model', or
580 - check if there is only one model, and return it if that's the case.
582 If you want to search for models, pass in a regexp as the argument.
584 # find all models that start with Foo
585 my @foo_models = $c->model(qr{^Foo});
589 sub model { shift->_lookup_mvc('model', @_) }
591 =head2 $c->view($name)
593 Gets a L<Catalyst::View> instance by name.
595 $c->view('Foo')->do_stuff;
597 Any extra arguments are directly passed to ACCEPT_CONTEXT.
599 If the name is omitted, it will look for
600 - a view object in $c->stash->{current_view_instance}, then
601 - a view name in $c->stash->{current_view}, then
602 - a config setting 'default_view', or
603 - check if there is only one view, and return it if that's the case.
605 If you want to search for views, pass in a regexp as the argument.
607 # find all views that start with Foo
608 my @foo_views = $c->view(qr{^Foo});
612 sub view { shift->_lookup_mvc('view', @_) }
615 my ( $c, $type, $name, @args ) = @_;
617 if (ref $c && !$name) {
618 my $current_instance = $c->stash->{"current_${type}_instance"};
619 return $current_instance
620 if $current_instance && $type ne 'controller';
622 $name = $type eq 'controller'
623 ? Catalyst::Utils::class2classshortsuffix($c->action->class)
624 : $c->stash->{"current_${type}"}
628 return $c->container->get_component_from_sub_container($type, $name, $c, @args);
631 =head2 $c->controllers
633 Returns the available names which can be passed to $c->controller
639 return $c->container->get_sub_container('controller')->get_service_list;
644 Returns the available names which can be passed to $c->model
650 return $c->container->get_sub_container('model')->get_service_list;
656 Returns the available names which can be passed to $c->view
662 return $c->container->get_sub_container('view')->get_service_list;
665 =head2 $c->comp($name)
667 =head2 $c->component($name)
669 Gets a component object by name. This method is not recommended,
670 unless you want to get a specific component by full
671 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
672 should be used instead.
674 If C<$name> is a regexp, a list of components matched against the full
675 component name will be returned.
680 my ( $c, $component, @args ) = @_;
682 unless ($component) {
683 $c->log->warn('Calling $c->component with no args is deprecated and ');
684 $c->log->warn('will be removed in a future release.');
685 $c->log->warn('Use $c->component_list instead.');
686 return $c->component_list;
689 my @result = $c->container->find_component( $component, $c, @args );
691 # list context for regexp searches
692 return @result if ref $component;
694 # only one component (if it's found) for string searches
695 return shift @result if @result;
697 if (ref $c eq $component) {
698 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
699 $c->log->warn('deprecated, and will be removed in a future release.');
703 $c->log->warn("Looking for '$component', but nothing was found.");
705 # I would expect to return an empty list here, but that breaks back-compat
706 $c->log->warn('Component not found, returning the list of existing');
707 $c->log->warn('components. This behavior is deprecated and will be');
708 $c->log->warn('removed in a future release. Use $c->component_list');
709 $c->log->warn('instead.');
711 return $c->component_list;
714 =head2 $c->component_list
716 Returns the sorted list of the component names of the application.
720 sub component_list { sort keys %{ shift->components } }
722 =head2 CLASS DATA AND HELPER CLASSES
726 Returns or takes a hashref containing the application's configuration.
728 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
730 You can also use a C<YAML>, C<XML> or L<Config::General> config file
731 like C<myapp.conf> in your applications home directory. See
732 L<Catalyst::Plugin::ConfigLoader>.
734 =head3 Cascading configuration
736 The config method is present on all Catalyst components, and configuration
737 will be merged when an application is started. Configuration loaded with
738 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
739 followed by configuration in your top level C<MyApp> class. These two
740 configurations are merged, and then configuration data whose hash key matches a
741 component name is merged with configuration for that component.
743 The configuration for a component is then passed to the C<new> method when a
744 component is constructed.
748 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
749 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
751 will mean that C<MyApp::Model::Foo> receives the following data when
754 MyApp::Model::Foo->new({
760 It's common practice to use a Moose attribute
761 on the receiving component to access the config value.
763 package MyApp::Model::Foo;
767 # this attr will receive 'baz' at construction time
773 You can then get the value 'baz' by calling $c->model('Foo')->bar
774 (or $self->bar inside code in the model).
776 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
777 as a way of reading config within your code, as this B<will not> give you the
778 correctly merged config back. You B<MUST> take the config values supplied to
779 the constructor and use those instead.
783 around config => sub {
787 croak('Setting config after setup has been run is not allowed.')
788 if ( @_ and $c->setup_finished );
795 Returns the logging object instance. Unless it is already set, Catalyst
796 sets this up with a L<Catalyst::Log> object. To use your own log class,
797 set the logger with the C<< __PACKAGE__->log >> method prior to calling
798 C<< __PACKAGE__->setup >>.
800 __PACKAGE__->log( MyLogger->new );
805 $c->log->info( 'Now logging with my own logger!' );
807 Your log class should implement the methods described in
813 Returns 1 if debug mode is enabled, 0 otherwise.
815 You can enable debug mode in several ways:
819 =item By calling myapp_server.pl with the -d flag
821 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
823 =item The -Debug option in your MyApp.pm
825 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
829 The first three also set the log level to 'debug'.
831 Calling C<< $c->debug(1) >> has no effect.
837 =head2 $c->dispatcher
839 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
843 Returns the engine instance. See L<Catalyst::Engine>.
846 =head2 UTILITY METHODS
848 =head2 $c->path_to(@path)
850 Merges C<@path> with C<< $c->config->{home} >> and returns a
851 L<Path::Class::Dir> object. Note you can usually use this object as
852 a filename, but sometimes you will have to explicitly stringify it
853 yourself by calling the C<< ->stringify >> method.
857 $c->path_to( 'db', 'sqlite.db' );
862 my ( $c, @path ) = @_;
863 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
864 if ( -d $path ) { return $path }
865 else { return Path::Class::File->new( $c->config->{home}, @path ) }
869 my ( $class, $name, $plugin, @args ) = @_;
871 # See block comment in t/aggregate/unit_core_plugin.t
872 # See block comment in t/unit_core_plugin.t
873 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
875 $class->_register_plugin( $plugin, 1 );
877 eval { $plugin->import };
878 $class->mk_classdata($name);
880 eval { $obj = $plugin->new(@args) };
883 Catalyst::Exception->throw( message =>
884 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
888 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
894 Initializes the dispatcher and engine, loads any plugins, and loads the
895 model, view, and controller components. You may also specify an array
896 of plugins to load here, if you choose to not load them in the C<use
900 MyApp->setup( qw/-Debug/ );
902 B<Note:> You B<should not> wrap this method with method modifiers
903 or bad things will happen - wrap the C<setup_finalize> method instead.
908 my ( $class, @arguments ) = @_;
909 croak('Running setup more than once')
910 if ( $class->setup_finished );
912 unless ( $class->isa('Catalyst') ) {
914 Catalyst::Exception->throw(
915 message => qq/'$class' does not inherit from Catalyst/ );
918 if ( $class->arguments ) {
919 @arguments = ( @arguments, @{ $class->arguments } );
925 foreach (@arguments) {
929 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
931 elsif (/^-(\w+)=?(.*)$/) {
932 $flags->{ lc $1 } = $2;
935 push @{ $flags->{plugins} }, $_;
939 $class->setup_config();
940 $class->setup_home( delete $flags->{home} );
942 $class->setup_log( delete $flags->{log} );
943 $class->setup_plugins( delete $flags->{plugins} );
944 $class->setup_dispatcher( delete $flags->{dispatcher} );
945 if (my $engine = delete $flags->{engine}) {
946 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
948 $class->setup_engine();
949 $class->setup_stats( delete $flags->{stats} );
951 for my $flag ( sort keys %{$flags} ) {
953 if ( my $code = $class->can( 'setup_' . $flag ) ) {
954 &$code( $class, delete $flags->{$flag} );
957 $class->log->warn(qq/Unknown flag "$flag"/);
961 eval { require Catalyst::Devel; };
962 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
963 $class->log->warn(<<"EOF");
964 You are running an old script!
966 Please update by running (this will overwrite existing files):
967 catalyst.pl -force -scripts $class
969 or (this will not overwrite existing files):
970 catalyst.pl -scripts $class
975 if ( $class->debug ) {
976 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
979 my $column_width = Catalyst::Utils::term_width() - 6;
980 my $t = Text::SimpleTable->new($column_width);
981 $t->row($_) for @plugins;
982 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
985 my $dispatcher = $class->dispatcher;
986 my $engine = $class->engine;
987 my $home = $class->config->{home};
989 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
990 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
994 ? $class->log->debug(qq/Found home "$home"/)
995 : $class->log->debug(qq/Home "$home" doesn't exist/)
996 : $class->log->debug(q/Couldn't find home/);
999 # Call plugins setup, this is stupid and evil.
1000 # Also screws C3 badly on 5.10, hack to avoid.
1002 no warnings qw/redefine/;
1003 local *setup = sub { };
1004 $class->setup unless $Catalyst::__AM_RESTARTING;
1007 $class->setup_components;
1011 my $comps = $class->container->get_all_components($class)
1013 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1014 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1015 $t->row( $_ => ref($comps->{$_}) ? 'instance' : 'class' ) for keys %$comps;
1017 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1020 $class->setup_actions;
1022 if ( $class->debug ) {
1023 my $name = $class->config->{name} || 'Application';
1024 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1027 if ($class->config->{case_sensitive}) {
1028 $class->log->warn($class . "->config->{case_sensitive} is set.");
1029 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1032 $class->setup_finalize;
1033 # Should be the last thing we do so that user things hooking
1034 # setup_finalize can log..
1035 $class->log->_flush() if $class->log->can('_flush');
1036 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1039 =head2 $app->setup_finalize
1041 A hook to attach modifiers to. This method does not do anything except set the
1042 C<setup_finished> accessor.
1044 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1048 after setup_finalize => sub {
1056 sub setup_finalize {
1058 $class->setup_finished(1);
1061 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1063 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1065 Constructs an absolute L<URI> object based on the application root, the
1066 provided path, and the additional arguments and query parameters provided.
1067 When used as a string, provides a textual URI. If you need more flexibility
1068 than this (i.e. the option to provide relative URIs etc.) see
1069 L<Catalyst::Plugin::SmartURI>.
1071 If no arguments are provided, the URI for the current action is returned.
1072 To return the current action and also provide @args, use
1073 C<< $c->uri_for( $c->action, @args ) >>.
1075 If the first argument is a string, it is taken as a public URI path relative
1076 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1077 relative to the application root (if it does). It is then merged with
1078 C<< $c->request->base >>; any C<@args> are appended as additional path
1079 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1081 If the first argument is a L<Catalyst::Action> it represents an action which
1082 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1083 optional C<\@captures> argument (an arrayref) allows passing the captured
1084 variables that are needed to fill in the paths of Chained and Regex actions;
1085 once the path is resolved, C<uri_for> continues as though a path was
1086 provided, appending any arguments or parameters and creating an absolute
1089 The captures for the current request can be found in
1090 C<< $c->request->captures >>, and actions can be resolved using
1091 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1092 path, use C<< $c->uri_for_action >> instead.
1094 # Equivalent to $c->req->uri
1095 $c->uri_for($c->action, $c->req->captures,
1096 @{ $c->req->args }, $c->req->params);
1098 # For the Foo action in the Bar controller
1099 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1101 # Path to a static resource
1102 $c->uri_for('/static/images/logo.png');
1107 my ( $c, $path, @args ) = @_;
1109 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1110 $path = $path->path_prefix;
1115 undef($path) if (defined $path && $path eq '');
1118 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1120 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1121 foreach my $arg (@args) {
1122 utf8::encode($arg) if utf8::is_utf8($arg);
1123 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1126 if ( blessed($path) ) { # action object
1127 s|/|%2F|g for @args;
1128 my $captures = [ map { s|/|%2F|g; $_; }
1129 ( scalar @args && ref $args[0] eq 'ARRAY'
1133 foreach my $capture (@$captures) {
1134 utf8::encode($capture) if utf8::is_utf8($capture);
1135 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1139 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1140 if( !@args && $action->number_of_args ) {
1141 my $expanded_action = $c->dispatcher->expand_action( $action );
1143 my $num_captures = $expanded_action->number_of_captures;
1144 unshift @args, splice @$captures, $num_captures;
1147 $path = $c->dispatcher->uri_for_action($action, $captures);
1148 if (not defined $path) {
1149 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1153 $path = '/' if $path eq '';
1156 unshift(@args, $path);
1158 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1159 my $namespace = $c->namespace;
1160 if (defined $path) { # cheesy hack to handle path '../foo'
1161 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1163 unshift(@args, $namespace || '');
1166 # join args with '/', or a blank string
1167 my $args = join('/', grep { defined($_) } @args);
1168 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1170 my $base = $c->req->base;
1171 my $class = ref($base);
1172 $base =~ s{(?<!/)$}{/};
1176 if (my @keys = keys %$params) {
1177 # somewhat lifted from URI::_query's query_form
1178 $query = '?'.join('&', map {
1179 my $val = $params->{$_};
1180 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1183 $val = '' unless defined $val;
1186 utf8::encode( $param ) if utf8::is_utf8($param);
1187 # using the URI::Escape pattern here so utf8 chars survive
1188 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1190 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1194 my $res = bless(\"${base}${args}${query}", $class);
1198 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1200 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1206 A private path to the Catalyst action you want to create a URI for.
1208 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1209 >> and passing the resulting C<$action> and the remaining arguments to C<<
1212 You can also pass in a Catalyst::Action object, in which case it is passed to
1215 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.
1217 For example, if the action looks like:
1219 package MyApp::Controller::Users;
1221 sub lst : Path('the-list') {}
1225 $c->uri_for_action('/users/lst')
1227 and it will create the URI /users/the-list.
1229 =item \@captures_and_args?
1231 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1232 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1233 to interpolate all the parameters in the URI.
1237 Optional list of extra arguments - can be supplied in the
1238 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1241 Your action can have zero, a fixed or a variable number of args (e.g.
1242 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1244 =item \%query_values?
1246 Optional array reference of query parameters to append. E.g.
1252 /rest/of/your/uri?foo=bar
1258 sub uri_for_action {
1259 my ( $c, $path, @args ) = @_;
1260 my $action = blessed($path)
1262 : $c->dispatcher->get_action_by_path($path);
1263 unless (defined $action) {
1264 croak "Can't find action for path '$path'";
1266 return $c->uri_for( $action, @args );
1269 =head2 $c->welcome_message
1271 Returns the Catalyst welcome HTML page.
1275 sub welcome_message {
1277 my $name = $c->config->{name};
1278 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1279 my $prefix = Catalyst::Utils::appprefix( ref $c );
1280 $c->response->content_type('text/html; charset=utf-8');
1282 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1283 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1284 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1286 <meta http-equiv="Content-Language" content="en" />
1287 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1288 <title>$name on Catalyst $VERSION</title>
1289 <style type="text/css">
1292 background-color: #eee;
1299 margin-bottom: 10px;
1301 background-color: #ccc;
1302 border: 1px solid #aaa;
1307 font-family: verdana, tahoma, sans-serif;
1310 font-family: verdana, tahoma, sans-serif;
1313 text-decoration: none;
1315 border-bottom: 1px dotted #bbb;
1317 :link:hover, :visited:hover {
1330 background-color: #fff;
1331 border: 1px solid #aaa;
1335 font-weight: normal;
1357 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1362 <img src="$logo" alt="Catalyst Logo" />
1364 <p>Welcome to the world of Catalyst.
1365 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1366 framework will make web development something you had
1367 never expected it to be: Fun, rewarding, and quick.</p>
1368 <h2>What to do now?</h2>
1369 <p>That really depends on what <b>you</b> want to do.
1370 We do, however, provide you with a few starting points.</p>
1371 <p>If you want to jump right into web development with Catalyst
1372 you might want to start with a tutorial.</p>
1373 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1375 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1377 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1378 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1380 <h2>What to do next?</h2>
1381 <p>Next it's time to write an actual application. Use the
1382 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1383 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1384 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1385 they can save you a lot of work.</p>
1386 <pre><code>script/${prefix}_create.pl --help</code></pre>
1387 <p>Also, be sure to check out the vast and growing
1388 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1389 you are likely to find what you need there.
1393 <p>Catalyst has a very active community. Here are the main places to
1394 get in touch with us.</p>
1397 <a href="http://dev.catalyst.perl.org">Wiki</a>
1400 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1403 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1406 <h2>In conclusion</h2>
1407 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1408 as we enjoyed making it. Please contact us if you have ideas
1409 for improvement or other feedback.</p>
1419 Contains a hash of options passed from the application script, including
1420 the original ARGV the script received, the processed values from that
1421 ARGV and any extra arguments to the script which were not processed.
1423 This can be used to add custom options to your application's scripts
1424 and setup your application differently depending on the values of these
1427 =head1 INTERNAL METHODS
1429 These methods are not meant to be used by end users.
1431 =head2 $c->components
1433 Returns a hash of components.
1438 my ( $class, $comps ) = @_;
1440 # people create components calling this sub directly, before setup
1441 $class->setup_config unless $class->container;
1443 my $container = $class->container;
1446 $container->add_component( $_ ) for keys %$comps;
1449 return $container->get_all_components($class);
1452 =head2 $c->context_class
1454 Returns or sets the context class.
1458 Returns a hashref containing coderefs and execution counts (needed for
1459 deep recursion detection).
1463 Returns the number of actions on the current internal execution stack.
1467 Dispatches a request to actions.
1471 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1473 =head2 $c->dispatcher_class
1475 Returns or sets the dispatcher class.
1477 =head2 $c->dump_these
1479 Returns a list of 2-element array references (name, structure) pairs
1480 that will be dumped on the error page in debug mode.
1486 [ Request => $c->req ],
1487 [ Response => $c->res ],
1488 [ Stash => $c->stash ],
1489 [ Config => $c->config ];
1492 =head2 $c->engine_class
1494 Returns or sets the engine class.
1496 =head2 $c->execute( $class, $coderef )
1498 Execute a coderef in given class and catch exceptions. Errors are available
1504 my ( $c, $class, $code ) = @_;
1505 $class = $c->component($class) || $class;
1508 if ( $c->depth >= $RECURSION ) {
1509 my $action = $code->reverse();
1510 $action = "/$action" unless $action =~ /->/;
1511 my $error = qq/Deep recursion detected calling "${action}"/;
1512 $c->log->error($error);
1518 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1520 push( @{ $c->stack }, $code );
1522 no warnings 'recursion';
1523 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1524 # I have no idea how, ergo $ret (which appears to fix the issue)
1525 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1527 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1529 my $last = pop( @{ $c->stack } );
1531 if ( my $error = $@ ) {
1532 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1533 $error->rethrow if $c->depth > 1;
1535 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1536 $error->rethrow if $c->depth > 0;
1539 unless ( ref $error ) {
1540 no warnings 'uninitialized';
1542 my $class = $last->class;
1543 my $name = $last->name;
1544 $error = qq/Caught exception in $class->$name "$error"/;
1553 sub _stats_start_execute {
1554 my ( $c, $code ) = @_;
1555 my $appclass = ref($c) || $c;
1556 return if ( ( $code->name =~ /^_.*/ )
1557 && ( !$appclass->config->{show_internal_actions} ) );
1559 my $action_name = $code->reverse();
1560 $c->counter->{$action_name}++;
1562 my $action = $action_name;
1563 $action = "/$action" unless $action =~ /->/;
1565 # determine if the call was the result of a forward
1566 # this is done by walking up the call stack and looking for a calling
1567 # sub of Catalyst::forward before the eval
1569 for my $index ( 2 .. 11 ) {
1571 if ( ( caller($index) )[0] eq 'Catalyst'
1572 && ( caller($index) )[3] eq '(eval)' );
1574 if ( ( caller($index) )[3] =~ /forward$/ ) {
1575 $callsub = ( caller($index) )[3];
1576 $action = "-> $action";
1581 my $uid = $action_name . $c->counter->{$action_name};
1583 # is this a root-level call or a forwarded call?
1584 if ( $callsub =~ /forward$/ ) {
1585 my $parent = $c->stack->[-1];
1587 # forward, locate the caller
1588 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1591 parent => "$parent" . $c->counter->{"$parent"},
1597 # forward with no caller may come from a plugin
1616 sub _stats_finish_execute {
1617 my ( $c, $info ) = @_;
1618 $c->stats->profile( end => $info );
1623 Finalizes the request.
1630 for my $error ( @{ $c->error } ) {
1631 $c->log->error($error);
1634 # Allow engine to handle finalize flow (for POE)
1635 my $engine = $c->engine;
1636 if ( my $code = $engine->can('finalize') ) {
1641 $c->finalize_uploads;
1644 if ( $#{ $c->error } >= 0 ) {
1648 $c->finalize_headers unless $c->response->finalized_headers;
1651 if ( $c->request->method eq 'HEAD' ) {
1652 $c->response->body('');
1660 if ($c->use_stats) {
1661 my $elapsed = sprintf '%f', $c->stats->elapsed;
1662 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1664 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1667 return $c->response->status;
1670 =head2 $c->finalize_body
1676 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1678 =head2 $c->finalize_cookies
1684 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1686 =head2 $c->finalize_error
1692 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1694 =head2 $c->finalize_headers
1700 sub finalize_headers {
1703 my $response = $c->response; #accessor calls can add up?
1705 # Check if we already finalized headers
1706 return if $response->finalized_headers;
1709 if ( my $location = $response->redirect ) {
1710 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1711 $response->header( Location => $location );
1713 if ( !$response->has_body ) {
1714 # Add a default body if none is already present
1715 $response->body(<<"EOF");
1716 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1717 <html xmlns="http://www.w3.org/1999/xhtml">
1719 <title>Moved</title>
1722 <p>This item has moved <a href="$location">here</a>.</p>
1726 $response->content_type('text/html; charset=utf-8');
1731 if ( defined $response->body && length $response->body && !$response->content_length ) {
1733 # get the length from a filehandle
1734 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1736 my $size = -s $response->body;
1738 $response->content_length( $size );
1741 $c->log->warn('Serving filehandle without a content-length');
1745 # everything should be bytes at this point, but just in case
1746 $response->content_length( length( $response->body ) );
1751 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1752 $response->headers->remove_header("Content-Length");
1753 $response->body('');
1756 $c->finalize_cookies;
1758 $c->response->finalize_headers();
1761 $response->finalized_headers(1);
1764 =head2 $c->finalize_output
1766 An alias for finalize_body.
1768 =head2 $c->finalize_read
1770 Finalizes the input after reading is complete.
1774 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1776 =head2 $c->finalize_uploads
1778 Finalizes uploads. Cleans up any temporary files.
1782 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1784 =head2 $c->get_action( $action, $namespace )
1786 Gets an action in a given namespace.
1790 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1792 =head2 $c->get_actions( $action, $namespace )
1794 Gets all actions of a given name in a namespace and all parent
1799 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1801 =head2 $app->handle_request( @arguments )
1803 Called to handle each HTTP request.
1807 sub handle_request {
1808 my ( $class, @arguments ) = @_;
1810 # Always expect worst case!
1813 if ($class->debug) {
1814 my $secs = time - $START || 1;
1815 my $av = sprintf '%.3f', $COUNT / $secs;
1816 my $time = localtime time;
1817 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1820 my $c = $class->prepare(@arguments);
1822 $status = $c->finalize;
1825 chomp(my $error = $_);
1826 $class->log->error(qq/Caught exception in engine "$error"/);
1831 if(my $coderef = $class->log->can('_flush')){
1832 $class->log->$coderef();
1837 =head2 $class->prepare( @arguments )
1839 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1846 predicate => '_has_uploadtmp',
1850 my ( $class, @arguments ) = @_;
1853 # After the app/ctxt split, this should become an attribute based on something passed
1854 # into the application.
1855 $class->context_class( ref $class || $class ) unless $class->context_class;
1857 my $uploadtmp = $class->config->{uploadtmp};
1858 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
1860 $c->response->_context($c);
1862 #surely this is not the most efficient way to do things...
1863 $c->stats($class->stats_class->new)->enable($c->use_stats);
1864 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1865 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1869 # Allow engine to direct the prepare flow (for POE)
1870 if ( my $prepare = $c->engine->can('prepare') ) {
1871 $c->engine->$prepare( $c, @arguments );
1874 $c->prepare_request(@arguments);
1875 $c->prepare_connection;
1876 $c->prepare_query_parameters;
1877 $c->prepare_headers; # Just hooks, no longer needed - they just
1878 $c->prepare_cookies; # cause the lazy attribute on req to build
1881 # Prepare the body for reading, either by prepare_body
1882 # or the user, if they are using $c->read
1885 # Parse the body unless the user wants it on-demand
1886 unless ( ref($c)->config->{parse_on_demand} ) {
1892 # VERY ugly and probably shouldn't rely on ->finalize actually working
1894 # failed prepare is always due to an invalid request, right?
1895 $c->response->status(400);
1896 $c->response->content_type('text/plain');
1897 $c->response->body('Bad Request');
1898 # Note we call finalize and then die here, which escapes
1899 # finalize being called in the enclosing block..
1900 # It in fact couldn't be called, as we don't return $c..
1901 # This is a mess - but I'm unsure you can fix this without
1902 # breaking compat for people doing crazy things (we should set
1903 # the 400 and just return the ctx here IMO, letting finalize get called
1914 =head2 $c->prepare_action
1916 Prepares action. See L<Catalyst::Dispatcher>.
1920 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1922 =head2 $c->prepare_body
1924 Prepares message body.
1931 return if $c->request->_has_body;
1933 # Initialize on-demand data
1934 $c->engine->prepare_body( $c, @_ );
1935 $c->prepare_parameters;
1936 $c->prepare_uploads;
1939 =head2 $c->prepare_body_chunk( $chunk )
1941 Prepares a chunk of data before sending it to L<HTTP::Body>.
1943 See L<Catalyst::Engine>.
1947 sub prepare_body_chunk {
1949 $c->engine->prepare_body_chunk( $c, @_ );
1952 =head2 $c->prepare_body_parameters
1954 Prepares body parameters.
1958 sub prepare_body_parameters {
1960 $c->engine->prepare_body_parameters( $c, @_ );
1963 =head2 $c->prepare_connection
1965 Prepares connection.
1969 sub prepare_connection {
1971 # XXX - This is called on the engine (not the request) to maintain
1972 # Engine::PSGI back compat.
1973 $c->engine->prepare_connection($c);
1976 =head2 $c->prepare_cookies
1978 Prepares cookies by ensuring that the attribute on the request
1979 object has been built.
1983 sub prepare_cookies { my $c = shift; $c->request->cookies }
1985 =head2 $c->prepare_headers
1987 Prepares request headers by ensuring that the attribute on the request
1988 object has been built.
1992 sub prepare_headers { my $c = shift; $c->request->headers }
1994 =head2 $c->prepare_parameters
1996 Prepares parameters.
2000 sub prepare_parameters {
2002 $c->prepare_body_parameters;
2003 $c->engine->prepare_parameters( $c, @_ );
2006 =head2 $c->prepare_path
2008 Prepares path and base.
2012 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2014 =head2 $c->prepare_query_parameters
2016 Prepares query parameters.
2020 sub prepare_query_parameters {
2023 $c->engine->prepare_query_parameters( $c, @_ );
2026 =head2 $c->log_request
2028 Writes information about the request to the debug logs. This includes:
2032 =item * Request method, path, and remote IP address
2034 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2036 =item * Request parameters
2038 =item * File uploads
2047 return unless $c->debug;
2049 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2050 my $request = $dump->[1];
2052 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2054 $path = '/' unless length $path;
2056 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2058 $c->log_request_headers($request->headers);
2060 if ( my $keywords = $request->query_keywords ) {
2061 $c->log->debug("Query keywords are: $keywords");
2064 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2066 $c->log_request_uploads($request);
2069 =head2 $c->log_response
2071 Writes information about the response to the debug logs by calling
2072 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2079 return unless $c->debug;
2081 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2082 my $response = $dump->[1];
2084 $c->log_response_status_line($response);
2085 $c->log_response_headers($response->headers);
2088 =head2 $c->log_response_status_line($response)
2090 Writes one line of information about the response to the debug logs. This includes:
2094 =item * Response status code
2096 =item * Content-Type header (if present)
2098 =item * Content-Length header (if present)
2104 sub log_response_status_line {
2105 my ($c, $response) = @_;
2109 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2110 $response->status || 'unknown',
2111 $response->headers->header('Content-Type') || 'unknown',
2112 $response->headers->header('Content-Length') || 'unknown'
2117 =head2 $c->log_response_headers($headers);
2119 Hook method which can be wrapped by plugins to log the response headers.
2120 No-op in the default implementation.
2124 sub log_response_headers {}
2126 =head2 $c->log_request_parameters( query => {}, body => {} )
2128 Logs request parameters to debug logs
2132 sub log_request_parameters {
2134 my %all_params = @_;
2136 return unless $c->debug;
2138 my $column_width = Catalyst::Utils::term_width() - 44;
2139 foreach my $type (qw(query body)) {
2140 my $params = $all_params{$type};
2141 next if ! keys %$params;
2142 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2143 for my $key ( sort keys %$params ) {
2144 my $param = $params->{$key};
2145 my $value = defined($param) ? $param : '';
2146 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2148 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2152 =head2 $c->log_request_uploads
2154 Logs file uploads included in the request to the debug logs.
2155 The parameter name, filename, file type, and file size are all included in
2160 sub log_request_uploads {
2162 my $request = shift;
2163 return unless $c->debug;
2164 my $uploads = $request->uploads;
2165 if ( keys %$uploads ) {
2166 my $t = Text::SimpleTable->new(
2167 [ 12, 'Parameter' ],
2172 for my $key ( sort keys %$uploads ) {
2173 my $upload = $uploads->{$key};
2174 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2175 $t->row( $key, $u->filename, $u->type, $u->size );
2178 $c->log->debug( "File Uploads are:\n" . $t->draw );
2182 =head2 $c->log_request_headers($headers);
2184 Hook method which can be wrapped by plugins to log the request headers.
2185 No-op in the default implementation.
2189 sub log_request_headers {}
2191 =head2 $c->log_headers($type => $headers)
2193 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2200 my $headers = shift; # an HTTP::Headers instance
2202 return unless $c->debug;
2204 my $column_width = Catalyst::Utils::term_width() - 28;
2205 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2208 my ( $name, $value ) = @_;
2209 $t->row( $name, $value );
2212 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2216 =head2 $c->prepare_read
2218 Prepares the input for reading.
2222 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2224 =head2 $c->prepare_request
2226 Prepares the engine request.
2230 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2232 =head2 $c->prepare_uploads
2238 sub prepare_uploads {
2241 $c->engine->prepare_uploads( $c, @_ );
2244 =head2 $c->prepare_write
2246 Prepares the output for writing.
2250 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2252 =head2 $c->request_class
2254 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2256 =head2 $c->response_class
2258 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2260 =head2 $c->read( [$maxlength] )
2262 Reads a chunk of data from the request body. This method is designed to
2263 be used in a while loop, reading C<$maxlength> bytes on every call.
2264 C<$maxlength> defaults to the size of the request if not specified.
2266 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2269 Warning: If you use read(), Catalyst will not process the body,
2270 so you will not be able to access POST parameters or file uploads via
2271 $c->request. You must handle all body parsing yourself.
2275 sub read { my $c = shift; return $c->request->read( @_ ) }
2285 $app->_make_immutable_if_needed;
2286 $app->engine_loader->needs_psgi_engine_compat_hack ?
2287 $app->engine->run($app, @_) :
2288 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2291 sub _make_immutable_if_needed {
2293 my $meta = Class::MOP::get_metaclass_by_name($class);
2294 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2297 && ! { $meta->immutable_options }->{replace_constructor}
2300 warn("You made your application class ($class) immutable, "
2301 . "but did not inline the\nconstructor. "
2302 . "This will break catalyst, as your app \@ISA "
2303 . "Class::Accessor(::Fast)?\nPlease pass "
2304 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2306 unless ($meta->is_immutable) {
2307 # XXX - FIXME warning here as you should make your app immutable yourself.
2308 $meta->make_immutable(
2309 replace_constructor => 1,
2314 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2316 Sets an action in a given namespace.
2320 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2322 =head2 $c->setup_actions($component)
2324 Sets up actions for a component.
2328 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2330 =head2 $c->setup_config
2337 my %args = %{ $class->config || {} };
2339 my $container_class;
2341 if ( exists $args{container_class} ) {
2342 $container_class = delete $args{container_class};
2343 Class::MOP::load_class($container_class);
2346 $container_class = Class::MOP::load_first_existing_class("${class}::Container", 'Catalyst::IOC::Container');
2349 my $container = $container_class->new( %args, name => $class );
2350 $class->container($container);
2352 my $config = $container->resolve( service => 'config' );
2353 $class->config($config);
2354 $class->finalize_config; # back-compat
2357 =head2 $c->finalize_config
2361 sub finalize_config { }
2363 =head2 $c->setup_components
2365 This method is called internally to set up the application's components.
2367 It finds modules by calling the L<locate_components> method, expands them to
2368 package names with the $container->expand_component_module method, and then
2369 installs each component into the application.
2371 The C<setup_components> config option is passed to both of the above methods.
2375 sub setup_components { shift->container->setup_components }
2377 =head2 locate_components
2381 sub locate_components {
2384 $class->log->warn('The locate_components method has been deprecated.');
2385 $class->log->warn('Please read Catalyst::IOC::Container documentation to');
2386 $class->log->warn('update your application.');
2388 # XXX think about ditching this sort entirely
2389 return sort { length $a <=> length $b }
2390 @{ $class->container->resolve( service => 'locate_components' ) };
2393 =head2 $c->setup_dispatcher
2399 sub setup_dispatcher {
2400 my ( $class, $dispatcher ) = @_;
2403 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2406 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2407 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2410 unless ($dispatcher) {
2411 $dispatcher = $class->dispatcher_class;
2414 Class::MOP::load_class($dispatcher);
2416 # dispatcher instance
2417 $class->dispatcher( $dispatcher->new );
2420 =head2 $c->setup_engine
2427 my ($class, $requested_engine) = @_;
2429 if (!$class->engine_loader || $requested_engine) {
2430 $class->engine_loader(
2431 Catalyst::EngineLoader->new({
2432 application_name => $class,
2433 (defined $requested_engine
2434 ? (catalyst_engine_class => $requested_engine) : ()),
2439 $class->engine_loader->catalyst_engine_class;
2443 my ($class, $requested_engine) = @_;
2446 my $loader = $class->engine_loader;
2448 if (!$loader || $requested_engine) {
2449 $loader = Catalyst::EngineLoader->new({
2450 application_name => $class,
2451 (defined $requested_engine
2452 ? (requested_engine => $requested_engine) : ()),
2455 $class->engine_loader($loader);
2458 $loader->catalyst_engine_class;
2461 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2462 return if $class->loading_psgi_file;
2464 Class::MOP::load_class($engine);
2466 if ($ENV{MOD_PERL}) {
2467 my $apache = $class->engine_loader->auto;
2469 my $meta = find_meta($class);
2470 my $was_immutable = $meta->is_immutable;
2471 my %immutable_options = $meta->immutable_options;
2472 $meta->make_mutable if $was_immutable;
2474 $meta->add_method(handler => sub {
2476 my $psgi_app = $class->_finalized_psgi_app;
2477 $apache->call_app($r, $psgi_app);
2480 $meta->make_immutable(%immutable_options) if $was_immutable;
2483 $class->engine( $engine->new );
2488 sub _finalized_psgi_app {
2491 unless ($app->_psgi_app) {
2492 my $psgi_app = $app->_setup_psgi_app;
2493 $app->_psgi_app($psgi_app);
2496 return $app->_psgi_app;
2499 sub _setup_psgi_app {
2502 for my $home (Path::Class::Dir->new($app->config->{home})) {
2503 my $psgi_file = $home->file(
2504 Catalyst::Utils::appprefix($app) . '.psgi',
2507 next unless -e $psgi_file;
2509 # If $psgi_file calls ->setup_engine, it's doing so to load
2510 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2511 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2512 # anyway. So set a flag (ick) that tells setup_engine not to populate
2513 # $c->engine or do any other things we might regret.
2515 $app->loading_psgi_file(1);
2516 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2517 $app->loading_psgi_file(0);
2520 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2523 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2525 Its content has been ignored. Please consult the Catalyst::Upgrading
2526 documentation on how to upgrade from Catalyst::Engine::PSGI.
2530 return $app->apply_default_middlewares($app->psgi_app);
2533 =head2 $c->apply_default_middlewares
2535 Adds the following L<Plack> middlewares to your application, since they are
2536 useful and commonly needed:
2538 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2539 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2540 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2541 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2542 applied since this middleware is smart enough to conditionally apply itself).
2544 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2545 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2551 sub apply_default_middlewares {
2552 my ($app, $psgi_app) = @_;
2554 $psgi_app = Plack::Middleware::Conditional->wrap(
2556 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2559 return if $app->config->{ignore_frontend_proxy};
2560 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2561 || $app->config->{using_frontend_proxy};
2565 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2566 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2567 $psgi_app = Plack::Middleware::Conditional->wrap(
2569 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2572 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2573 return unless $1 < 4.23;
2578 # we're applying this unconditionally as the middleware itself already makes
2579 # sure it doesn't fuck things up if it's not running under one of the right
2581 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2588 Returns a PSGI application code reference for the catalyst application
2589 C<$c>. This is the bare application without any middlewares
2590 applied. C<${myapp}.psgi> is not taken into account.
2592 This is what you want to be using to retrieve the PSGI application code
2593 reference of your Catalyst application for use in F<.psgi> files.
2599 return $app->engine->build_psgi_app($app);
2602 =head2 $c->setup_home
2604 Sets up the home directory.
2609 my ( $class, $home_flag ) = @_;
2611 my $home = $class->container->resolve(
2614 home_flag => $home_flag
2619 #I remember recently being scolded for assigning config values like this
2620 $class->config->{home} ||= $home;
2621 $class->config->{root} ||= $class->container->resolve(service => 'root_dir');
2625 =head2 $c->setup_log
2627 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2628 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2631 This method also installs a C<debug> method that returns a true value into the
2632 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2633 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2635 Note that if the log has already been setup, by either a previous call to
2636 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2637 that this method won't actually set up the log object.
2642 my ( $class, $levels ) = @_;
2645 $levels =~ s/^\s+//;
2646 $levels =~ s/\s+$//;
2647 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2649 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2650 if ( defined $env_debug ) {
2651 $levels{debug} = 1 if $env_debug; # Ugly!
2652 delete($levels{debug}) unless $env_debug;
2655 unless ( $class->log ) {
2656 $class->log( Catalyst::Log->new(keys %levels) );
2659 if ( $levels{debug} ) {
2660 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2661 $class->log->debug('Debug messages enabled');
2665 =head2 $c->setup_plugins
2671 =head2 $c->setup_stats
2673 Sets up timing statistics class.
2678 my ( $class, $stats ) = @_;
2680 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2682 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2683 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2684 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2685 $class->log->debug('Statistics enabled');
2690 =head2 $c->registered_plugins
2692 Returns a sorted list of the plugins which have either been stated in the
2695 If passed a given plugin name, it will report a boolean value indicating
2696 whether or not that plugin is loaded. A fully qualified name is required if
2697 the plugin name does not begin with C<Catalyst::Plugin::>.
2699 if ($c->registered_plugins('Some::Plugin')) {
2707 sub registered_plugins {
2709 return sort keys %{ $proto->_plugins } unless @_;
2711 return 1 if exists $proto->_plugins->{$plugin};
2712 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2715 sub _register_plugin {
2716 my ( $proto, $plugin, $instant ) = @_;
2717 my $class = ref $proto || $proto;
2719 Class::MOP::load_class( $plugin );
2720 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2721 if $plugin->isa( 'Catalyst::Component' );
2722 my $plugin_meta = Moose::Meta::Class->create($plugin);
2723 if (!$plugin_meta->has_method('new')
2724 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
2725 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
2727 if (!$instant && !$proto->_plugins->{$plugin}) {
2728 my $meta = Class::MOP::get_metaclass_by_name($class);
2729 $meta->superclasses($plugin, $meta->superclasses);
2731 $proto->_plugins->{$plugin} = 1;
2736 my ( $class, $plugins ) = @_;
2738 $class->_plugins( {} ) unless $class->_plugins;
2739 $plugins = Data::OptList::mkopt($plugins || []);
2742 [ Catalyst::Utils::resolve_namespace(
2743 $class . '::Plugin',
2744 'Catalyst::Plugin', $_->[0]
2750 for my $plugin ( reverse @plugins ) {
2751 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2752 my $meta = find_meta($plugin->[0]);
2753 next if $meta && $meta->isa('Moose::Meta::Role');
2755 $class->_register_plugin($plugin->[0]);
2759 map { $_->[0]->name, $_->[1] }
2760 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2761 map { [find_meta($_->[0]), $_->[1]] }
2764 Moose::Util::apply_all_roles(
2772 Returns an arrayref of the internal execution stack (actions that are
2773 currently executing).
2777 Returns the current timing statistics object. By default Catalyst uses
2778 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2779 L<< stats_class|/"$c->stats_class" >>.
2781 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2782 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2783 profile explicitly, although MyApp.pm still won't profile nor output anything
2786 =head2 $c->stats_class
2788 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2790 =head2 $c->use_stats
2792 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2794 Note that this is a static method, not an accessor and should be overridden
2795 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2802 =head2 $c->write( $data )
2804 Writes $data to the output stream. When using this method directly, you
2805 will need to manually set the C<Content-Length> header to the length of
2806 your output data, if known.
2813 # Finalize headers if someone manually writes output (for compat)
2814 $c->finalize_headers;
2816 return $c->response->write( @_ );
2821 Returns the Catalyst version number. Mostly useful for "powered by"
2822 messages in template systems.
2826 sub version { return $Catalyst::VERSION }
2828 =head1 CONFIGURATION
2830 There are a number of 'base' config variables which can be set:
2836 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2840 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2844 C<home> - The application home directory. In an uninstalled application,
2845 this is the top level application directory. In an installed application,
2846 this will be the directory containing C<< MyApp.pm >>.
2850 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2854 C<name> - The name of the application in debug messages and the debug and
2859 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2860 until it is accessed. This allows you to (for example) check authentication (and reject
2861 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
2865 C<root> - The root directory for templates. Usually this is just a
2866 subdirectory of the home directory, but you can set it to change the
2867 templates to a different directory.
2871 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2872 to be shown in hit debug tables in the test server.
2876 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
2877 variable should be used for determining the request path.
2879 Most web server environments pass the requested path to the application using environment variables,
2880 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
2881 exposed as C<< $c->request->base >>) and the request path below that base.
2883 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
2884 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
2888 =item use_request_uri_for_path => 0
2890 This is the default (and the) traditional method that Catalyst has used for determining the path information.
2891 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
2892 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
2893 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
2895 However this method has the major disadvantage that it is impossible to correctly decode some elements
2896 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
2897 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
2898 can't distinguish / vs %2F in paths (in addition to other encoded values).
2900 =item use_request_uri_for_path => 1
2902 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
2903 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
2904 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
2906 Given that this method of path resolution is provably more correct, it is recommended that you use
2907 this unless you have a specific need to deploy your application in a non-standard environment, and you are
2908 aware of the implications of not being able to handle encoded URI paths correctly.
2910 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
2911 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
2912 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
2913 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
2914 C<< $c->request->base >> will be incorrect.
2920 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2924 =head1 INTERNAL ACTIONS
2926 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2927 C<_ACTION>, and C<_END>. These are by default not shown in the private
2928 action table, but you can make them visible with a config parameter.
2930 MyApp->config(show_internal_actions => 1);
2932 =head1 ON-DEMAND PARSER
2934 The request body is usually parsed at the beginning of a request,
2935 but if you want to handle input yourself, you can enable on-demand
2936 parsing with a config parameter.
2938 MyApp->config(parse_on_demand => 1);
2940 =head1 PROXY SUPPORT
2942 Many production servers operate using the common double-server approach,
2943 with a lightweight frontend web server passing requests to a larger
2944 backend server. An application running on the backend server must deal
2945 with two problems: the remote user always appears to be C<127.0.0.1> and
2946 the server's hostname will appear to be C<localhost> regardless of the
2947 virtual host that the user connected through.
2949 Catalyst will automatically detect this situation when you are running
2950 the frontend and backend servers on the same machine. The following
2951 changes are made to the request.
2953 $c->req->address is set to the user's real IP address, as read from
2954 the HTTP X-Forwarded-For header.
2956 The host value for $c->req->base and $c->req->uri is set to the real
2957 host, as read from the HTTP X-Forwarded-Host header.
2959 Additionally, you may be running your backend application on an insecure
2960 connection (port 80) while your frontend proxy is running under SSL. If there
2961 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2962 tell Catalyst what port the frontend listens on. This will allow all URIs to
2963 be created properly.
2965 In the case of passing in:
2967 X-Forwarded-Port: 443
2969 All calls to C<uri_for> will result in an https link, as is expected.
2971 Obviously, your web server must support these headers for this to work.
2973 In a more complex server farm environment where you may have your
2974 frontend proxy server(s) on different machines, you will need to set a
2975 configuration option to tell Catalyst to read the proxied data from the
2978 MyApp->config(using_frontend_proxy => 1);
2980 If you do not wish to use the proxy support at all, you may set:
2982 MyApp->config(ignore_frontend_proxy => 0);
2984 =head2 Note about psgi files
2986 Note that if you supply your own .psgi file, calling
2987 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
2989 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
2990 in your psgi, for example:
2993 enable "Plack::Middleware::ReverseProxy";
2997 This will unconditionally add the ReverseProxy support, or you need to call
2998 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
2999 apply the support depending upon your config).
3001 See L<Catalyst::PSGI> for more information.
3003 =head1 THREAD SAFETY
3005 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3006 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3007 believe the Catalyst core to be thread-safe.
3009 If you plan to operate in a threaded environment, remember that all other
3010 modules you are using must also be thread-safe. Some modules, most notably
3011 L<DBD::SQLite>, are not thread-safe.
3017 Join #catalyst on irc.perl.org.
3021 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3022 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3026 http://catalyst.perl.org
3030 http://dev.catalyst.perl.org
3034 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3036 =head2 L<Catalyst::Manual> - The Catalyst Manual
3038 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3040 =head2 L<Catalyst::Engine> - Core engine
3042 =head2 L<Catalyst::Log> - Log class.
3044 =head2 L<Catalyst::Request> - Request object
3046 =head2 L<Catalyst::Response> - Response object
3048 =head2 L<Catalyst::Test> - The test suite.
3050 =head1 PROJECT FOUNDER
3052 sri: Sebastian Riedel <sri@cpan.org>
3058 acme: Leon Brocard <leon@astray.com>
3060 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3064 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3070 andyg: Andy Grundman <andy@hybridized.org>
3072 audreyt: Audrey Tang
3074 bricas: Brian Cassidy <bricas@cpan.org>
3076 Caelum: Rafael Kitover <rkitover@io.com>
3078 chansen: Christian Hansen
3080 chicks: Christopher Hicks
3082 Chisel Wright C<pause@herlpacker.co.uk>
3084 Danijel Milicevic C<me@danijel.de>
3086 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3088 David Naughton, C<naughton@umn.edu>
3092 dhoss: Devin Austin <dhoss@cpan.org>
3094 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3098 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3100 esskar: Sascha Kiefer
3102 fireartist: Carl Franks <cfranks@cpan.org>
3104 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3106 gabb: Danijel Milicevic
3110 Gavin Henry C<ghenry@perl.me.uk>
3114 groditi: Guillermo Roditi <groditi@gmail.com>
3116 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3118 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3120 jcamacho: Juan Camacho
3122 jester: Jesse Sheidlower C<jester@panix.com>
3124 jhannah: Jay Hannah <jay@jays.net>
3130 jon: Jon Schutz <jjschutz@cpan.org>
3132 Jonathan Rockway C<< <jrockway@cpan.org> >>
3134 Kieren Diment C<kd@totaldatasolution.com>
3136 konobi: Scott McWhirter <konobi@cpan.org>
3138 marcus: Marcus Ramberg <mramberg@cpan.org>
3140 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3142 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3146 naughton: David Naughton
3148 ningu: David Kamholz <dkamholz@cpan.org>
3150 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3152 numa: Dan Sully <daniel@cpan.org>
3158 omega: Andreas Marienborg
3160 Oleg Kostyuk <cub.uanic@gmail.com>
3162 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3164 rafl: Florian Ragwitz <rafl@debian.org>
3166 random: Roland Lammel <lammel@cpan.org>
3168 Robert Sedlacek C<< <rs@474.at> >>
3170 SpiceMan: Marcel Montes
3174 szbalint: Balint Szilakszi <szbalint@cpan.org>
3176 t0m: Tomas Doran <bobtfish@bobtfish.net>
3180 Viljo Marrandi C<vilts@yahoo.com>
3182 Will Hawes C<info@whawes.co.uk>
3184 willert: Sebastian Willert <willert@cpan.org>
3186 wreis: Wallace Reis <wallace@reis.org.br>
3188 Yuval Kogman, C<nothingmuch@woobling.org>
3190 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3192 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3196 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3200 This library is free software. You can redistribute it and/or modify it under
3201 the same terms as Perl itself.
3207 __PACKAGE__->meta->make_immutable;