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;
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.008004; }
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.90007';
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 sub MODIFY_CODE_ATTRIBUTES {
138 Catalyst::Exception->throw(
139 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
140 "That has been deprecated and removed. You should create a " .
141 "controller class called Root.pm, and move relevant code to that class."
146 sub _application { $_[0] }
150 Catalyst - The Elegant MVC Web Application Framework
154 See the L<Catalyst::Manual> distribution for comprehensive
155 documentation and tutorials.
157 # Install Catalyst::Devel for helpers and other development tools
158 # use the helper to create a new application
161 # add models, views, controllers
162 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
163 script/myapp_create.pl view MyTemplate TT
164 script/myapp_create.pl controller Search
166 # built in testserver -- use -r to restart automatically on changes
167 # --help to see all available options
168 script/myapp_server.pl
170 # command line testing interface
171 script/myapp_test.pl /yada
174 use Catalyst qw/-Debug/; # include plugins here as well
176 ### In lib/MyApp/Controller/Root.pm (autocreated)
177 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
178 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
179 $c->stash->{template} = 'foo.tt'; # set the template
180 # lookup something from db -- stash vars are passed to TT
182 $c->model('Database::Foo')->search( { country => $args[0] } );
183 if ( $c->req->params->{bar} ) { # access GET or POST parameters
184 $c->forward( 'bar' ); # process another action
185 # do something else after forward returns
189 # The foo.tt TT template can use the stash data from the database
190 [% WHILE (item = data.next) %]
194 # called for /bar/of/soap, /bar/of/soap/10, etc.
195 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
197 # called after all actions are finished
199 my ( $self, $c ) = @_;
200 if ( scalar @{ $c->error } ) { ... } # handle errors
201 return if $c->res->body; # already have a response
202 $c->forward( 'MyApp::View::TT' ); # render template
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> 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 home directory, e.g.:
255 use Catalyst qw[-Home=/usr/mst];
257 This can also be done in the shell environment by setting either the
258 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
259 is replaced with the uppercased name of your application, any "::" in
260 the name will be replaced with underscores, e.g. MyApp::Web should use
261 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
263 If none of these are set, Catalyst will attempt to automatically detect the
264 home directory. If you are working in a development environment, Catalyst
265 will try and find the directory containing either Makefile.PL, Build.PL or
266 dist.ini. If the application has been installed into the system (i.e.
267 you have done C<make install>), then Catalyst will use the path to your
268 application module, without the .pm extension (e.g., /foo/MyApp if your
269 application was installed at /foo/MyApp.pm)
273 use Catalyst '-Log=warn,fatal,error';
275 Specifies a comma-delimited list of log levels.
279 Enables statistics collection and reporting.
281 use Catalyst qw/-Stats=1/;
283 You can also force this setting from the system environment with CATALYST_STATS
284 or <MYAPP>_STATS. The environment settings override the application, with
285 <MYAPP>_STATS having the highest priority.
287 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
291 =head2 INFORMATION ABOUT THE CURRENT REQUEST
295 Returns a L<Catalyst::Action> object for the current action, which
296 stringifies to the action name. See L<Catalyst::Action>.
300 Returns the namespace of the current action, i.e., the URI prefix
301 corresponding to the controller of the current action. For example:
303 # in Controller::Foo::Bar
304 $c->namespace; # returns 'foo/bar';
310 Returns the current L<Catalyst::Request> object, giving access to
311 information about the current client request (including parameters,
312 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
314 =head2 REQUEST FLOW HANDLING
316 =head2 $c->forward( $action [, \@arguments ] )
318 =head2 $c->forward( $class, $method, [, \@arguments ] )
320 Forwards processing to another action, by its private name. If you give a
321 class name but no method, C<process()> is called. You may also optionally
322 pass arguments in an arrayref. The action will receive the arguments in
323 C<@_> and C<< $c->req->args >>. Upon returning from the function,
324 C<< $c->req->args >> will be restored to the previous values.
326 Any data C<return>ed from the action forwarded to, will be returned by the
329 my $foodata = $c->forward('/foo');
330 $c->forward('index');
331 $c->forward(qw/Model::DBIC::Foo do_stuff/);
332 $c->forward('View::TT');
334 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
335 an C<< eval { } >> around the call (actually
336 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
337 exceptions thrown by the called action non-fatal and pushing them onto
338 $c->error instead. If you want C<die> to propagate you need to do something
342 die join "\n", @{ $c->error } if @{ $c->error };
344 Or make sure to always return true values from your actions and write
347 $c->forward('foo') || return;
349 Another note is that C<< $c->forward >> always returns a scalar because it
350 actually returns $c->state which operates in a scalar context.
351 Thus, something like:
355 in an action that is forwarded to is going to return a scalar,
356 i.e. how many items are in that array, which is probably not what you want.
357 If you need to return an array then return a reference to it,
360 $c->stash->{array} = \@array;
362 and access it from the stash.
364 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.
368 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
370 =head2 $c->detach( $action [, \@arguments ] )
372 =head2 $c->detach( $class, $method, [, \@arguments ] )
376 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
377 doesn't return to the previous action when processing is finished.
379 When called with no arguments it escapes the processing chain entirely.
383 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
385 =head2 $c->visit( $action [, \@arguments ] )
387 =head2 $c->visit( $action [, \@captures, \@arguments ] )
389 =head2 $c->visit( $class, $method, [, \@arguments ] )
391 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
393 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
394 but does a full dispatch, instead of just calling the new C<$action> /
395 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
396 you go to are called, just like a new request.
398 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
399 This means, for example, that C<< $c->action >> methods such as
400 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
401 L<reverse|Catalyst::Action/reverse> return information for the visited action
402 when they are invoked within the visited action. This is different from the
403 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
404 continues to use the $c->action object from the caller action even when
405 invoked from the called action.
407 C<< $c->stash >> is kept unchanged.
409 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
410 allows you to "wrap" another action, just as it would have been called by
411 dispatching from a URL, while the analogous
412 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
413 transfer control to another action as if it had been reached directly from a URL.
417 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
419 =head2 $c->go( $action [, \@arguments ] )
421 =head2 $c->go( $action [, \@captures, \@arguments ] )
423 =head2 $c->go( $class, $method, [, \@arguments ] )
425 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
427 The relationship between C<go> and
428 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
429 the relationship between
430 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
431 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
432 C<< $c->go >> will perform a full dispatch on the specified action or method,
433 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
434 C<go> escapes the processing of the current request chain on completion, and
435 does not return to its caller.
437 @arguments are arguments to the final destination of $action. @captures are
438 arguments to the intermediate steps, if any, on the way to the final sub of
443 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
449 Returns the current L<Catalyst::Response> object, see there for details.
453 Returns a hashref to the stash, which may be used to store data and pass
454 it between components during a request. You can also set hash keys by
455 passing arguments. The stash is automatically sent to the view. The
456 stash is cleared at the end of a request; it cannot be used for
457 persistent storage (for this you must use a session; see
458 L<Catalyst::Plugin::Session> for a complete system integrated with
461 $c->stash->{foo} = $bar;
462 $c->stash( { moose => 'majestic', qux => 0 } );
463 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
465 # stash is automatically passed to the view for use in a template
466 $c->forward( 'MyApp::View::TT' );
470 around stash => sub {
473 my $stash = $orig->($c);
475 my $new_stash = @_ > 1 ? {@_} : $_[0];
476 croak('stash takes a hash or hashref') unless ref $new_stash;
477 foreach my $key ( keys %$new_stash ) {
478 $stash->{$key} = $new_stash->{$key};
488 =head2 $c->error($error, ...)
490 =head2 $c->error($arrayref)
492 Returns an arrayref containing error messages. If Catalyst encounters an
493 error while processing a request, it stores the error in $c->error. This
494 method should only be used to store fatal error messages.
496 my @error = @{ $c->error };
500 $c->error('Something bad happened');
507 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
508 croak @$error unless ref $c;
509 push @{ $c->{error} }, @$error;
511 elsif ( defined $_[0] ) { $c->{error} = undef }
512 return $c->{error} || [];
518 Contains the return value of the last executed action.
519 Note that << $c->state >> operates in a scalar context which means that all
520 values it returns are scalar.
522 =head2 $c->clear_errors
524 Clear errors. You probably don't want to clear the errors unless you are
525 implementing a custom error screen.
527 This is equivalent to running
538 =head2 COMPONENT ACCESSORS
540 =head2 $c->controller($name)
542 Gets a L<Catalyst::Controller> instance by name.
544 $c->controller('Foo')->do_stuff;
546 If the name is omitted, will return the controller for the dispatched
549 If you want to search for controllers, pass in a regexp as the argument.
551 # find all controllers that start with Foo
552 my @foo_controllers = $c->controller(qr{^Foo});
557 sub controller { shift->_lookup_mvc('controller', @_) }
559 =head2 $c->model($name)
561 Gets a L<Catalyst::Model> instance by name.
563 $c->model('Foo')->do_stuff;
565 Any extra arguments are directly passed to ACCEPT_CONTEXT.
567 If the name is omitted, it will look for
568 - a model object in $c->stash->{current_model_instance}, then
569 - a model name in $c->stash->{current_model}, then
570 - a config setting 'default_model', or
571 - check if there is only one model, and return it if that's the case.
573 If you want to search for models, pass in a regexp as the argument.
575 # find all models that start with Foo
576 my @foo_models = $c->model(qr{^Foo});
580 sub model { shift->_lookup_mvc('model', @_) }
582 =head2 $c->view($name)
584 Gets a L<Catalyst::View> instance by name.
586 $c->view('Foo')->do_stuff;
588 Any extra arguments are directly passed to ACCEPT_CONTEXT.
590 If the name is omitted, it will look for
591 - a view object in $c->stash->{current_view_instance}, then
592 - a view name in $c->stash->{current_view}, then
593 - a config setting 'default_view', or
594 - check if there is only one view, and return it if that's the case.
596 If you want to search for views, pass in a regexp as the argument.
598 # find all views that start with Foo
599 my @foo_views = $c->view(qr{^Foo});
603 sub view { shift->_lookup_mvc('view', @_) }
606 my ( $c, $type, $name, @args ) = @_;
608 if (ref $c && !$name) {
609 my $current_instance = $c->stash->{"current_${type}_instance"};
610 return $current_instance
611 if $current_instance && $type ne 'controller';
613 $name = $type eq 'controller'
614 ? Catalyst::Utils::class2classshortsuffix($c->action->class)
615 : $c->stash->{"current_${type}"}
619 return $c->container->get_component_from_sub_container($type, $name, $c, @args);
622 =head2 $c->controllers
624 Returns the available names which can be passed to $c->controller
630 return $c->container->get_sub_container('controller')->get_service_list;
635 Returns the available names which can be passed to $c->model
641 return $c->container->get_sub_container('model')->get_service_list;
647 Returns the available names which can be passed to $c->view
653 return $c->container->get_sub_container('view')->get_service_list;
656 =head2 $c->comp($name)
658 =head2 $c->component($name)
660 Gets a component object by name. This method is not recommended,
661 unless you want to get a specific component by full
662 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
663 should be used instead.
665 If C<$name> is a regexp, a list of components matched against the full
666 component name will be returned.
671 my ( $c, $component, @args ) = @_;
673 unless ($component) {
674 $c->log->warn('Calling $c->component with no args is deprecated and ');
675 $c->log->warn('will be removed in a future release.');
676 $c->log->warn('Use $c->component_list instead.');
677 return $c->component_list;
680 my @result = $c->container->find_component( $component, $c, @args );
682 # list context for regexp searches
683 return @result if ref $component;
685 # only one component (if it's found) for string searches
686 return shift @result if @result;
688 if (ref $c eq $component) {
689 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
690 $c->log->warn('deprecated, and will be removed in a future release.');
694 $c->log->warn("Looking for '$component', but nothing was found.");
696 # I would expect to return an empty list here, but that breaks back-compat
697 $c->log->warn('Component not found, returning the list of existing');
698 $c->log->warn('components. This behavior is deprecated and will be');
699 $c->log->warn('removed in a future release. Use $c->component_list');
700 $c->log->warn('instead.');
702 return $c->component_list;
705 =head2 $c->component_list
707 Returns the sorted list of the component names of the application.
711 sub component_list { sort keys %{ shift->components } }
713 =head2 CLASS DATA AND HELPER CLASSES
717 Returns or takes a hashref containing the application's configuration.
719 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
721 You can also use a C<YAML>, C<XML> or L<Config::General> config file
722 like C<myapp.conf> in your applications home directory. See
723 L<Catalyst::Plugin::ConfigLoader>.
725 =head3 Cascading configuration
727 The config method is present on all Catalyst components, and configuration
728 will be merged when an application is started. Configuration loaded with
729 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
730 followed by configuration in your top level C<MyApp> class. These two
731 configurations are merged, and then configuration data whose hash key matches a
732 component name is merged with configuration for that component.
734 The configuration for a component is then passed to the C<new> method when a
735 component is constructed.
739 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
740 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
742 will mean that C<MyApp::Model::Foo> receives the following data when
745 MyApp::Model::Foo->new({
751 It's common practice to use a Moose attribute
752 on the receiving component to access the config value.
754 package MyApp::Model::Foo;
758 # this attr will receive 'baz' at construction time
764 You can then get the value 'baz' by calling $c->model('Foo')->bar
765 (or $self->bar inside code in the model).
767 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
768 as a way of reading config within your code, as this B<will not> give you the
769 correctly merged config back. You B<MUST> take the config values supplied to
770 the constructor and use those instead.
774 around config => sub {
778 croak('Setting config after setup has been run is not allowed.')
779 if ( @_ and $c->setup_finished );
786 Returns the logging object instance. Unless it is already set, Catalyst
787 sets this up with a L<Catalyst::Log> object. To use your own log class,
788 set the logger with the C<< __PACKAGE__->log >> method prior to calling
789 C<< __PACKAGE__->setup >>.
791 __PACKAGE__->log( MyLogger->new );
796 $c->log->info( 'Now logging with my own logger!' );
798 Your log class should implement the methods described in
804 Returns 1 if debug mode is enabled, 0 otherwise.
806 You can enable debug mode in several ways:
810 =item By calling myapp_server.pl with the -d flag
812 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
814 =item The -Debug option in your MyApp.pm
816 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
820 The first three also set the log level to 'debug'.
822 Calling C<< $c->debug(1) >> has no effect.
828 =head2 $c->dispatcher
830 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
834 Returns the engine instance. See L<Catalyst::Engine>.
837 =head2 UTILITY METHODS
839 =head2 $c->path_to(@path)
841 Merges C<@path> with C<< $c->config->{home} >> and returns a
842 L<Path::Class::Dir> object. Note you can usually use this object as
843 a filename, but sometimes you will have to explicitly stringify it
844 yourself by calling the C<< ->stringify >> method.
848 $c->path_to( 'db', 'sqlite.db' );
853 my ( $c, @path ) = @_;
854 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
855 if ( -d $path ) { return $path }
856 else { return Path::Class::File->new( $c->config->{home}, @path ) }
860 my ( $class, $name, $plugin, @args ) = @_;
862 # See block comment in t/aggregate/unit_core_plugin.t
863 # See block comment in t/unit_core_plugin.t
864 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
866 $class->_register_plugin( $plugin, 1 );
868 eval { $plugin->import };
869 $class->mk_classdata($name);
871 eval { $obj = $plugin->new(@args) };
874 Catalyst::Exception->throw( message =>
875 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
879 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
885 Initializes the dispatcher and engine, loads any plugins, and loads the
886 model, view, and controller components. You may also specify an array
887 of plugins to load here, if you choose to not load them in the C<use
891 MyApp->setup( qw/-Debug/ );
893 B<Note:> You B<should not> wrap this method with method modifiers
894 or bad things will happen - wrap the C<setup_finalize> method instead.
899 my ( $class, @arguments ) = @_;
900 croak('Running setup more than once')
901 if ( $class->setup_finished );
903 unless ( $class->isa('Catalyst') ) {
905 Catalyst::Exception->throw(
906 message => qq/'$class' does not inherit from Catalyst/ );
909 if ( $class->arguments ) {
910 @arguments = ( @arguments, @{ $class->arguments } );
916 foreach (@arguments) {
920 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
922 elsif (/^-(\w+)=?(.*)$/) {
923 $flags->{ lc $1 } = $2;
926 push @{ $flags->{plugins} }, $_;
930 $class->setup_config();
931 $class->setup_home( delete $flags->{home} );
933 $class->setup_log( delete $flags->{log} );
934 $class->setup_plugins( delete $flags->{plugins} );
935 $class->setup_dispatcher( delete $flags->{dispatcher} );
936 if (my $engine = delete $flags->{engine}) {
937 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
939 $class->setup_engine();
940 $class->setup_stats( delete $flags->{stats} );
942 for my $flag ( sort keys %{$flags} ) {
944 if ( my $code = $class->can( 'setup_' . $flag ) ) {
945 &$code( $class, delete $flags->{$flag} );
948 $class->log->warn(qq/Unknown flag "$flag"/);
952 eval { require Catalyst::Devel; };
953 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
954 $class->log->warn(<<"EOF");
955 You are running an old script!
957 Please update by running (this will overwrite existing files):
958 catalyst.pl -force -scripts $class
960 or (this will not overwrite existing files):
961 catalyst.pl -scripts $class
966 if ( $class->debug ) {
967 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
970 my $column_width = Catalyst::Utils::term_width() - 6;
971 my $t = Text::SimpleTable->new($column_width);
972 $t->row($_) for @plugins;
973 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
976 my $dispatcher = $class->dispatcher;
977 my $engine = $class->engine;
978 my $home = $class->config->{home};
980 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
981 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
985 ? $class->log->debug(qq/Found home "$home"/)
986 : $class->log->debug(qq/Home "$home" doesn't exist/)
987 : $class->log->debug(q/Couldn't find home/);
990 # Call plugins setup, this is stupid and evil.
991 # Also screws C3 badly on 5.10, hack to avoid.
993 no warnings qw/redefine/;
994 local *setup = sub { };
995 $class->setup unless $Catalyst::__AM_RESTARTING;
998 $class->setup_components;
1002 my $comps = $class->container->get_all_components($class)
1004 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1005 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1006 $t->row( $_ => ref($comps->{$_}) ? 'instance' : 'class' ) for keys %$comps;
1008 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1011 $class->setup_actions;
1013 if ( $class->debug ) {
1014 my $name = $class->config->{name} || 'Application';
1015 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1018 # Make sure that the application class becomes immutable at this point,
1019 B::Hooks::EndOfScope::on_scope_end {
1021 my $meta = Class::MOP::get_metaclass_by_name($class);
1024 && ! { $meta->immutable_options }->{replace_constructor}
1026 $class->isa('Class::Accessor::Fast')
1027 || $class->isa('Class::Accessor')
1030 warn "You made your application class ($class) immutable, "
1031 . "but did not inline the\nconstructor. "
1032 . "This will break catalyst, as your app \@ISA "
1033 . "Class::Accessor(::Fast)?\nPlease pass "
1034 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1036 $meta->make_immutable(
1037 replace_constructor => 1,
1038 ) unless $meta->is_immutable;
1041 if ($class->config->{case_sensitive}) {
1042 $class->log->warn($class . "->config->{case_sensitive} is set.");
1043 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1046 $class->setup_finalize;
1047 # Should be the last thing we do so that user things hooking
1048 # setup_finalize can log..
1049 $class->log->_flush() if $class->log->can('_flush');
1050 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1053 =head2 $app->setup_finalize
1055 A hook to attach modifiers to. This method does not do anything except set the
1056 C<setup_finished> accessor.
1058 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1062 after setup_finalize => sub {
1070 sub setup_finalize {
1072 $class->setup_finished(1);
1075 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1077 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1079 Constructs an absolute L<URI> object based on the application root, the
1080 provided path, and the additional arguments and query parameters provided.
1081 When used as a string, provides a textual URI. If you need more flexibility
1082 than this (i.e. the option to provide relative URIs etc.) see
1083 L<Catalyst::Plugin::SmartURI>.
1085 If no arguments are provided, the URI for the current action is returned.
1086 To return the current action and also provide @args, use
1087 C<< $c->uri_for( $c->action, @args ) >>.
1089 If the first argument is a string, it is taken as a public URI path relative
1090 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1091 relative to the application root (if it does). It is then merged with
1092 C<< $c->request->base >>; any C<@args> are appended as additional path
1093 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1095 If the first argument is a L<Catalyst::Action> it represents an action which
1096 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1097 optional C<\@captures> argument (an arrayref) allows passing the captured
1098 variables that are needed to fill in the paths of Chained and Regex actions;
1099 once the path is resolved, C<uri_for> continues as though a path was
1100 provided, appending any arguments or parameters and creating an absolute
1103 The captures for the current request can be found in
1104 C<< $c->request->captures >>, and actions can be resolved using
1105 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1106 path, use C<< $c->uri_for_action >> instead.
1108 # Equivalent to $c->req->uri
1109 $c->uri_for($c->action, $c->req->captures,
1110 @{ $c->req->args }, $c->req->params);
1112 # For the Foo action in the Bar controller
1113 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1115 # Path to a static resource
1116 $c->uri_for('/static/images/logo.png');
1121 my ( $c, $path, @args ) = @_;
1123 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1124 $path = $path->path_prefix;
1129 undef($path) if (defined $path && $path eq '');
1132 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1134 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1135 foreach my $arg (@args) {
1136 utf8::encode($arg) if utf8::is_utf8($arg);
1137 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1140 if ( blessed($path) ) { # action object
1141 s|/|%2F|g for @args;
1142 my $captures = [ map { s|/|%2F|g; $_; }
1143 ( scalar @args && ref $args[0] eq 'ARRAY'
1147 foreach my $capture (@$captures) {
1148 utf8::encode($capture) if utf8::is_utf8($capture);
1149 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1153 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1154 if( !@args && $action->number_of_args ) {
1155 my $expanded_action = $c->dispatcher->expand_action( $action );
1157 my $num_captures = $expanded_action->number_of_captures;
1158 unshift @args, splice @$captures, $num_captures;
1161 $path = $c->dispatcher->uri_for_action($action, $captures);
1162 if (not defined $path) {
1163 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1167 $path = '/' if $path eq '';
1170 unshift(@args, $path);
1172 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1173 my $namespace = $c->namespace;
1174 if (defined $path) { # cheesy hack to handle path '../foo'
1175 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1177 unshift(@args, $namespace || '');
1180 # join args with '/', or a blank string
1181 my $args = join('/', grep { defined($_) } @args);
1182 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1184 my $base = $c->req->base;
1185 my $class = ref($base);
1186 $base =~ s{(?<!/)$}{/};
1190 if (my @keys = keys %$params) {
1191 # somewhat lifted from URI::_query's query_form
1192 $query = '?'.join('&', map {
1193 my $val = $params->{$_};
1194 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1197 $val = '' unless defined $val;
1200 utf8::encode( $param ) if utf8::is_utf8($param);
1201 # using the URI::Escape pattern here so utf8 chars survive
1202 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1204 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1208 my $res = bless(\"${base}${args}${query}", $class);
1212 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1214 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1220 A private path to the Catalyst action you want to create a URI for.
1222 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1223 >> and passing the resulting C<$action> and the remaining arguments to C<<
1226 You can also pass in a Catalyst::Action object, in which case it is passed to
1229 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.
1231 For example, if the action looks like:
1233 package MyApp::Controller::Users;
1235 sub lst : Path('the-list') {}
1239 $c->uri_for_action('/users/lst')
1241 and it will create the URI /users/the-list.
1243 =item \@captures_and_args?
1245 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1246 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1247 to interpolate all the parameters in the URI.
1251 Optional list of extra arguments - can be supplied in the
1252 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1255 Your action can have zero, a fixed or a variable number of args (e.g.
1256 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1258 =item \%query_values?
1260 Optional array reference of query parameters to append. E.g.
1266 /rest/of/your/uri?foo=bar
1272 sub uri_for_action {
1273 my ( $c, $path, @args ) = @_;
1274 my $action = blessed($path)
1276 : $c->dispatcher->get_action_by_path($path);
1277 unless (defined $action) {
1278 croak "Can't find action for path '$path'";
1280 return $c->uri_for( $action, @args );
1283 =head2 $c->welcome_message
1285 Returns the Catalyst welcome HTML page.
1289 sub welcome_message {
1291 my $name = $c->config->{name};
1292 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1293 my $prefix = Catalyst::Utils::appprefix( ref $c );
1294 $c->response->content_type('text/html; charset=utf-8');
1296 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1297 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1298 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1300 <meta http-equiv="Content-Language" content="en" />
1301 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1302 <title>$name on Catalyst $VERSION</title>
1303 <style type="text/css">
1306 background-color: #eee;
1313 margin-bottom: 10px;
1315 background-color: #ccc;
1316 border: 1px solid #aaa;
1321 font-family: verdana, tahoma, sans-serif;
1324 font-family: verdana, tahoma, sans-serif;
1327 text-decoration: none;
1329 border-bottom: 1px dotted #bbb;
1331 :link:hover, :visited:hover {
1344 background-color: #fff;
1345 border: 1px solid #aaa;
1349 font-weight: normal;
1371 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1376 <img src="$logo" alt="Catalyst Logo" />
1378 <p>Welcome to the world of Catalyst.
1379 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1380 framework will make web development something you had
1381 never expected it to be: Fun, rewarding, and quick.</p>
1382 <h2>What to do now?</h2>
1383 <p>That really depends on what <b>you</b> want to do.
1384 We do, however, provide you with a few starting points.</p>
1385 <p>If you want to jump right into web development with Catalyst
1386 you might want to start with a tutorial.</p>
1387 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1389 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1391 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1392 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1394 <h2>What to do next?</h2>
1395 <p>Next it's time to write an actual application. Use the
1396 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1397 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1398 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1399 they can save you a lot of work.</p>
1400 <pre><code>script/${prefix}_create.pl --help</code></pre>
1401 <p>Also, be sure to check out the vast and growing
1402 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1403 you are likely to find what you need there.
1407 <p>Catalyst has a very active community. Here are the main places to
1408 get in touch with us.</p>
1411 <a href="http://dev.catalyst.perl.org">Wiki</a>
1414 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1417 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1420 <h2>In conclusion</h2>
1421 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1422 as we enjoyed making it. Please contact us if you have ideas
1423 for improvement or other feedback.</p>
1433 Contains a hash of options passed from the application script, including
1434 the original ARGV the script received, the processed values from that
1435 ARGV and any extra arguments to the script which were not processed.
1437 This can be used to add custom options to your application's scripts
1438 and setup your application differently depending on the values of these
1441 =head1 INTERNAL METHODS
1443 These methods are not meant to be used by end users.
1445 =head2 $c->components
1447 Returns a hash of components.
1452 my ( $class, $comps ) = @_;
1454 # people create components calling this sub directly, before setup
1455 $class->setup_config unless $class->container;
1457 my $container = $class->container;
1460 $container->add_component( $_ ) for keys %$comps;
1463 return $container->get_all_components($class);
1466 =head2 $c->context_class
1468 Returns or sets the context class.
1472 Returns a hashref containing coderefs and execution counts (needed for
1473 deep recursion detection).
1477 Returns the number of actions on the current internal execution stack.
1481 Dispatches a request to actions.
1485 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1487 =head2 $c->dispatcher_class
1489 Returns or sets the dispatcher class.
1491 =head2 $c->dump_these
1493 Returns a list of 2-element array references (name, structure) pairs
1494 that will be dumped on the error page in debug mode.
1500 [ Request => $c->req ],
1501 [ Response => $c->res ],
1502 [ Stash => $c->stash ],
1503 [ Config => $c->config ];
1506 =head2 $c->engine_class
1508 Returns or sets the engine class.
1510 =head2 $c->execute( $class, $coderef )
1512 Execute a coderef in given class and catch exceptions. Errors are available
1518 my ( $c, $class, $code ) = @_;
1519 $class = $c->component($class) || $class;
1522 if ( $c->depth >= $RECURSION ) {
1523 my $action = $code->reverse();
1524 $action = "/$action" unless $action =~ /->/;
1525 my $error = qq/Deep recursion detected calling "${action}"/;
1526 $c->log->error($error);
1532 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1534 push( @{ $c->stack }, $code );
1536 no warnings 'recursion';
1537 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1538 # I have no idea how, ergo $ret (which appears to fix the issue)
1539 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1541 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1543 my $last = pop( @{ $c->stack } );
1545 if ( my $error = $@ ) {
1546 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1547 $error->rethrow if $c->depth > 1;
1549 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1550 $error->rethrow if $c->depth > 0;
1553 unless ( ref $error ) {
1554 no warnings 'uninitialized';
1556 my $class = $last->class;
1557 my $name = $last->name;
1558 $error = qq/Caught exception in $class->$name "$error"/;
1567 sub _stats_start_execute {
1568 my ( $c, $code ) = @_;
1569 my $appclass = ref($c) || $c;
1570 return if ( ( $code->name =~ /^_.*/ )
1571 && ( !$appclass->config->{show_internal_actions} ) );
1573 my $action_name = $code->reverse();
1574 $c->counter->{$action_name}++;
1576 my $action = $action_name;
1577 $action = "/$action" unless $action =~ /->/;
1579 # determine if the call was the result of a forward
1580 # this is done by walking up the call stack and looking for a calling
1581 # sub of Catalyst::forward before the eval
1583 for my $index ( 2 .. 11 ) {
1585 if ( ( caller($index) )[0] eq 'Catalyst'
1586 && ( caller($index) )[3] eq '(eval)' );
1588 if ( ( caller($index) )[3] =~ /forward$/ ) {
1589 $callsub = ( caller($index) )[3];
1590 $action = "-> $action";
1595 my $uid = $action_name . $c->counter->{$action_name};
1597 # is this a root-level call or a forwarded call?
1598 if ( $callsub =~ /forward$/ ) {
1599 my $parent = $c->stack->[-1];
1601 # forward, locate the caller
1602 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1605 parent => "$parent" . $c->counter->{"$parent"},
1611 # forward with no caller may come from a plugin
1630 sub _stats_finish_execute {
1631 my ( $c, $info ) = @_;
1632 $c->stats->profile( end => $info );
1637 Finalizes the request.
1644 for my $error ( @{ $c->error } ) {
1645 $c->log->error($error);
1648 # Allow engine to handle finalize flow (for POE)
1649 my $engine = $c->engine;
1650 if ( my $code = $engine->can('finalize') ) {
1655 $c->finalize_uploads;
1658 if ( $#{ $c->error } >= 0 ) {
1662 $c->finalize_headers;
1665 if ( $c->request->method eq 'HEAD' ) {
1666 $c->response->body('');
1674 if ($c->use_stats) {
1675 my $elapsed = sprintf '%f', $c->stats->elapsed;
1676 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1678 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1681 return $c->response->status;
1684 =head2 $c->finalize_body
1690 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1692 =head2 $c->finalize_cookies
1698 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1700 =head2 $c->finalize_error
1706 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1708 =head2 $c->finalize_headers
1714 sub finalize_headers {
1717 my $response = $c->response; #accessor calls can add up?
1719 # Check if we already finalized headers
1720 return if $response->finalized_headers;
1723 if ( my $location = $response->redirect ) {
1724 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1725 $response->header( Location => $location );
1727 if ( !$response->has_body ) {
1728 # Add a default body if none is already present
1729 $response->body(<<"EOF");
1730 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1731 <html xmlns="http://www.w3.org/1999/xhtml">
1733 <title>Moved</title>
1736 <p>This item has moved <a href="$location">here</a>.</p>
1740 $response->content_type('text/html; charset=utf-8');
1745 if ( defined $response->body && length $response->body && !$response->content_length ) {
1747 # get the length from a filehandle
1748 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1750 my $size = -s $response->body;
1752 $response->content_length( $size );
1755 $c->log->warn('Serving filehandle without a content-length');
1759 # everything should be bytes at this point, but just in case
1760 $response->content_length( length( $response->body ) );
1765 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1766 $response->headers->remove_header("Content-Length");
1767 $response->body('');
1770 $c->finalize_cookies;
1772 $c->engine->finalize_headers( $c, @_ );
1775 $response->finalized_headers(1);
1778 =head2 $c->finalize_output
1780 An alias for finalize_body.
1782 =head2 $c->finalize_read
1784 Finalizes the input after reading is complete.
1788 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1790 =head2 $c->finalize_uploads
1792 Finalizes uploads. Cleans up any temporary files.
1796 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1798 =head2 $c->get_action( $action, $namespace )
1800 Gets an action in a given namespace.
1804 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1806 =head2 $c->get_actions( $action, $namespace )
1808 Gets all actions of a given name in a namespace and all parent
1813 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1815 =head2 $app->handle_request( @arguments )
1817 Called to handle each HTTP request.
1821 sub handle_request {
1822 my ( $class, @arguments ) = @_;
1824 # Always expect worst case!
1827 if ($class->debug) {
1828 my $secs = time - $START || 1;
1829 my $av = sprintf '%.3f', $COUNT / $secs;
1830 my $time = localtime time;
1831 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1834 my $c = $class->prepare(@arguments);
1836 $status = $c->finalize;
1839 chomp(my $error = $_);
1840 $class->log->error(qq/Caught exception in engine "$error"/);
1845 if(my $coderef = $class->log->can('_flush')){
1846 $class->log->$coderef();
1851 =head2 $class->prepare( @arguments )
1853 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1860 predicate => '_has_uploadtmp',
1864 my ( $class, @arguments ) = @_;
1867 # After the app/ctxt split, this should become an attribute based on something passed
1868 # into the application.
1869 $class->context_class( ref $class || $class ) unless $class->context_class;
1871 my $uploadtmp = $class->config->{uploadtmp};
1872 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
1874 #surely this is not the most efficient way to do things...
1875 $c->stats($class->stats_class->new)->enable($c->use_stats);
1876 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1877 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1881 # Allow engine to direct the prepare flow (for POE)
1882 if ( my $prepare = $c->engine->can('prepare') ) {
1883 $c->engine->$prepare( $c, @arguments );
1886 $c->prepare_request(@arguments);
1887 $c->prepare_connection;
1888 $c->prepare_query_parameters;
1889 $c->prepare_headers; # Just hooks, no longer needed - they just
1890 $c->prepare_cookies; # cause the lazy attribute on req to build
1893 # Prepare the body for reading, either by prepare_body
1894 # or the user, if they are using $c->read
1897 # Parse the body unless the user wants it on-demand
1898 unless ( ref($c)->config->{parse_on_demand} ) {
1904 # VERY ugly and probably shouldn't rely on ->finalize actually working
1906 # failed prepare is always due to an invalid request, right?
1907 $c->response->status(400);
1908 $c->response->content_type('text/plain');
1909 $c->response->body('Bad Request');
1910 # Note we call finalize and then die here, which escapes
1911 # finalize being called in the enclosing block..
1912 # It in fact couldn't be called, as we don't return $c..
1913 # This is a mess - but I'm unsure you can fix this without
1914 # breaking compat for people doing crazy things (we should set
1915 # the 400 and just return the ctx here IMO, letting finalize get called
1926 =head2 $c->prepare_action
1928 Prepares action. See L<Catalyst::Dispatcher>.
1932 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1934 =head2 $c->prepare_body
1936 Prepares message body.
1943 return if $c->request->_has_body;
1945 # Initialize on-demand data
1946 $c->engine->prepare_body( $c, @_ );
1947 $c->prepare_parameters;
1948 $c->prepare_uploads;
1951 =head2 $c->prepare_body_chunk( $chunk )
1953 Prepares a chunk of data before sending it to L<HTTP::Body>.
1955 See L<Catalyst::Engine>.
1959 sub prepare_body_chunk {
1961 $c->engine->prepare_body_chunk( $c, @_ );
1964 =head2 $c->prepare_body_parameters
1966 Prepares body parameters.
1970 sub prepare_body_parameters {
1972 $c->engine->prepare_body_parameters( $c, @_ );
1975 =head2 $c->prepare_connection
1977 Prepares connection.
1981 sub prepare_connection {
1983 # XXX - This is called on the engine (not the request) to maintain
1984 # Engine::PSGI back compat.
1985 $c->engine->prepare_connection($c);
1988 =head2 $c->prepare_cookies
1990 Prepares cookies by ensuring that the attribute on the request
1991 object has been built.
1995 sub prepare_cookies { my $c = shift; $c->request->cookies }
1997 =head2 $c->prepare_headers
1999 Prepares request headers by ensuring that the attribute on the request
2000 object has been built.
2004 sub prepare_headers { my $c = shift; $c->request->headers }
2006 =head2 $c->prepare_parameters
2008 Prepares parameters.
2012 sub prepare_parameters {
2014 $c->prepare_body_parameters;
2015 $c->engine->prepare_parameters( $c, @_ );
2018 =head2 $c->prepare_path
2020 Prepares path and base.
2024 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2026 =head2 $c->prepare_query_parameters
2028 Prepares query parameters.
2032 sub prepare_query_parameters {
2035 $c->engine->prepare_query_parameters( $c, @_ );
2038 =head2 $c->log_request
2040 Writes information about the request to the debug logs. This includes:
2044 =item * Request method, path, and remote IP address
2046 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2048 =item * Request parameters
2050 =item * File uploads
2059 return unless $c->debug;
2061 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2062 my $request = $dump->[1];
2064 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2066 $path = '/' unless length $path;
2068 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2070 $c->log_request_headers($request->headers);
2072 if ( my $keywords = $request->query_keywords ) {
2073 $c->log->debug("Query keywords are: $keywords");
2076 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2078 $c->log_request_uploads($request);
2081 =head2 $c->log_response
2083 Writes information about the response to the debug logs by calling
2084 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2091 return unless $c->debug;
2093 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2094 my $response = $dump->[1];
2096 $c->log_response_status_line($response);
2097 $c->log_response_headers($response->headers);
2100 =head2 $c->log_response_status_line($response)
2102 Writes one line of information about the response to the debug logs. This includes:
2106 =item * Response status code
2108 =item * Content-Type header (if present)
2110 =item * Content-Length header (if present)
2116 sub log_response_status_line {
2117 my ($c, $response) = @_;
2121 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2122 $response->status || 'unknown',
2123 $response->headers->header('Content-Type') || 'unknown',
2124 $response->headers->header('Content-Length') || 'unknown'
2129 =head2 $c->log_response_headers($headers);
2131 Hook method which can be wrapped by plugins to log the response headers.
2132 No-op in the default implementation.
2136 sub log_response_headers {}
2138 =head2 $c->log_request_parameters( query => {}, body => {} )
2140 Logs request parameters to debug logs
2144 sub log_request_parameters {
2146 my %all_params = @_;
2148 return unless $c->debug;
2150 my $column_width = Catalyst::Utils::term_width() - 44;
2151 foreach my $type (qw(query body)) {
2152 my $params = $all_params{$type};
2153 next if ! keys %$params;
2154 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2155 for my $key ( sort keys %$params ) {
2156 my $param = $params->{$key};
2157 my $value = defined($param) ? $param : '';
2158 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2160 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2164 =head2 $c->log_request_uploads
2166 Logs file uploads included in the request to the debug logs.
2167 The parameter name, filename, file type, and file size are all included in
2172 sub log_request_uploads {
2174 my $request = shift;
2175 return unless $c->debug;
2176 my $uploads = $request->uploads;
2177 if ( keys %$uploads ) {
2178 my $t = Text::SimpleTable->new(
2179 [ 12, 'Parameter' ],
2184 for my $key ( sort keys %$uploads ) {
2185 my $upload = $uploads->{$key};
2186 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2187 $t->row( $key, $u->filename, $u->type, $u->size );
2190 $c->log->debug( "File Uploads are:\n" . $t->draw );
2194 =head2 $c->log_request_headers($headers);
2196 Hook method which can be wrapped by plugins to log the request headers.
2197 No-op in the default implementation.
2201 sub log_request_headers {}
2203 =head2 $c->log_headers($type => $headers)
2205 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2212 my $headers = shift; # an HTTP::Headers instance
2214 return unless $c->debug;
2216 my $column_width = Catalyst::Utils::term_width() - 28;
2217 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2220 my ( $name, $value ) = @_;
2221 $t->row( $name, $value );
2224 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2228 =head2 $c->prepare_read
2230 Prepares the input for reading.
2234 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2236 =head2 $c->prepare_request
2238 Prepares the engine request.
2242 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2244 =head2 $c->prepare_uploads
2250 sub prepare_uploads {
2253 $c->engine->prepare_uploads( $c, @_ );
2256 =head2 $c->prepare_write
2258 Prepares the output for writing.
2262 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2264 =head2 $c->request_class
2266 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2268 =head2 $c->response_class
2270 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2272 =head2 $c->read( [$maxlength] )
2274 Reads a chunk of data from the request body. This method is designed to
2275 be used in a while loop, reading C<$maxlength> bytes on every call.
2276 C<$maxlength> defaults to the size of the request if not specified.
2278 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2281 Warning: If you use read(), Catalyst will not process the body,
2282 so you will not be able to access POST parameters or file uploads via
2283 $c->request. You must handle all body parsing yourself.
2287 sub read { my $c = shift; return $c->request->read( @_ ) }
2297 $app->engine_loader->needs_psgi_engine_compat_hack ?
2298 $app->engine->run($app, @_) :
2299 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2302 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2304 Sets an action in a given namespace.
2308 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2310 =head2 $c->setup_actions($component)
2312 Sets up actions for a component.
2316 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2318 =head2 $c->setup_config
2325 my %args = %{ $class->config || {} };
2327 my $container_class;
2329 if ( exists $args{container_class} ) {
2330 $container_class = delete $args{container_class};
2331 Class::MOP::load_class($container_class);
2334 $container_class = Class::MOP::load_first_existing_class("${class}::Container", 'Catalyst::IOC::Container');
2337 my $container = $container_class->new( %args, application_name => "$class", name => "$class" );
2338 $class->container($container);
2340 my $config = $container->resolve( service => 'config' );
2341 $class->config($config);
2342 $class->finalize_config; # back-compat
2345 =head2 $c->finalize_config
2349 sub finalize_config { }
2351 =head2 $c->setup_components
2353 This method is called internally to set up the application's components.
2355 It finds modules by calling the L<locate_components> method, expands them to
2356 package names with the $container->expand_component_module method, and then
2357 installs each component into the application.
2359 The C<setup_components> config option is passed to both of the above methods.
2363 sub setup_components { shift->container->setup_components }
2365 =head2 locate_components
2369 sub locate_components {
2372 $class->log->warn('The locate_components method has been deprecated.');
2373 $class->log->warn('Please read Catalyst::IOC::Container documentation to');
2374 $class->log->warn('update your application.');
2376 # XXX think about ditching this sort entirely
2377 return sort { length $a <=> length $b }
2378 @{ $class->container->resolve( service => 'locate_components' ) };
2381 =head2 $c->setup_dispatcher
2387 sub setup_dispatcher {
2388 my ( $class, $dispatcher ) = @_;
2391 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2394 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2395 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2398 unless ($dispatcher) {
2399 $dispatcher = $class->dispatcher_class;
2402 Class::MOP::load_class($dispatcher);
2404 # dispatcher instance
2405 $class->dispatcher( $dispatcher->new );
2408 =head2 $c->setup_engine
2415 my ($class, $requested_engine) = @_;
2417 if (!$class->engine_loader || $requested_engine) {
2418 $class->engine_loader(
2419 Catalyst::EngineLoader->new({
2420 application_name => $class,
2421 (defined $requested_engine
2422 ? (catalyst_engine_class => $requested_engine) : ()),
2427 $class->engine_loader->catalyst_engine_class;
2431 my ($class, $requested_engine) = @_;
2434 my $loader = $class->engine_loader;
2436 if (!$loader || $requested_engine) {
2437 $loader = Catalyst::EngineLoader->new({
2438 application_name => $class,
2439 (defined $requested_engine
2440 ? (requested_engine => $requested_engine) : ()),
2443 $class->engine_loader($loader);
2446 $loader->catalyst_engine_class;
2449 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2450 return if $class->loading_psgi_file;
2452 Class::MOP::load_class($engine);
2454 if ($ENV{MOD_PERL}) {
2455 my $apache = $class->engine_loader->auto;
2457 my $meta = find_meta($class);
2458 my $was_immutable = $meta->is_immutable;
2459 my %immutable_options = $meta->immutable_options;
2460 $meta->make_mutable if $was_immutable;
2462 $meta->add_method(handler => sub {
2464 my $psgi_app = $class->_finalized_psgi_app;
2465 $apache->call_app($r, $psgi_app);
2468 $meta->make_immutable(%immutable_options) if $was_immutable;
2471 $class->engine( $engine->new );
2476 sub _finalized_psgi_app {
2479 unless ($app->_psgi_app) {
2480 my $psgi_app = $app->_setup_psgi_app;
2481 $app->_psgi_app($psgi_app);
2484 return $app->_psgi_app;
2487 sub _setup_psgi_app {
2490 for my $home (Path::Class::Dir->new($app->config->{home})) {
2491 my $psgi_file = $home->file(
2492 Catalyst::Utils::appprefix($app) . '.psgi',
2495 next unless -e $psgi_file;
2497 # If $psgi_file calls ->setup_engine, it's doing so to load
2498 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2499 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2500 # anyway. So set a flag (ick) that tells setup_engine not to populate
2501 # $c->engine or do any other things we might regret.
2503 $app->loading_psgi_file(1);
2504 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2505 $app->loading_psgi_file(0);
2508 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2511 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2513 Its content has been ignored. Please consult the Catalyst::Upgrading
2514 documentation on how to upgrade from Catalyst::Engine::PSGI.
2518 return $app->apply_default_middlewares($app->psgi_app);
2521 =head2 $c->apply_default_middlewares
2523 Adds the following L<Plack> middlewares to your application, since they are
2524 useful and commonly needed:
2526 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2527 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2528 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2529 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2530 applied since this middleware is smart enough to conditionally apply itself).
2532 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2533 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2539 sub apply_default_middlewares {
2540 my ($app, $psgi_app) = @_;
2542 $psgi_app = Plack::Middleware::Conditional->wrap(
2544 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2547 return if $app->config->{ignore_frontend_proxy};
2548 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2549 || $app->config->{using_frontend_proxy};
2553 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2554 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2555 $psgi_app = Plack::Middleware::Conditional->wrap(
2557 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2560 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2561 return unless $1 < 4.23;
2566 # we're applying this unconditionally as the middleware itself already makes
2567 # sure it doesn't fuck things up if it's not running under one of the right
2569 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2576 Returns a PSGI application code reference for the catalyst application
2577 C<$c>. This is the bare application without any middlewares
2578 applied. C<${myapp}.psgi> is not taken into account.
2580 This is what you want to be using to retrieve the PSGI application code
2581 reference of your Catalyst application for use in F<.psgi> files.
2587 return $app->engine->build_psgi_app($app);
2590 =head2 $c->setup_home
2592 Sets up the home directory.
2597 my ( $class, $home ) = @_;
2599 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2603 $home ||= Catalyst::Utils::home($class);
2606 #I remember recently being scolded for assigning config values like this
2607 $class->config->{home} ||= $home;
2608 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2612 =head2 $c->setup_log
2614 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2615 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2618 This method also installs a C<debug> method that returns a true value into the
2619 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2620 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2622 Note that if the log has already been setup, by either a previous call to
2623 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2624 that this method won't actually set up the log object.
2629 my ( $class, $levels ) = @_;
2632 $levels =~ s/^\s+//;
2633 $levels =~ s/\s+$//;
2634 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2636 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2637 if ( defined $env_debug ) {
2638 $levels{debug} = 1 if $env_debug; # Ugly!
2639 delete($levels{debug}) unless $env_debug;
2642 unless ( $class->log ) {
2643 $class->log( Catalyst::Log->new(keys %levels) );
2646 if ( $levels{debug} ) {
2647 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2648 $class->log->debug('Debug messages enabled');
2652 =head2 $c->setup_plugins
2658 =head2 $c->setup_stats
2660 Sets up timing statistics class.
2665 my ( $class, $stats ) = @_;
2667 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2669 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2670 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2671 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2672 $class->log->debug('Statistics enabled');
2677 =head2 $c->registered_plugins
2679 Returns a sorted list of the plugins which have either been stated in the
2682 If passed a given plugin name, it will report a boolean value indicating
2683 whether or not that plugin is loaded. A fully qualified name is required if
2684 the plugin name does not begin with C<Catalyst::Plugin::>.
2686 if ($c->registered_plugins('Some::Plugin')) {
2694 sub registered_plugins {
2696 return sort keys %{ $proto->_plugins } unless @_;
2698 return 1 if exists $proto->_plugins->{$plugin};
2699 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2702 sub _register_plugin {
2703 my ( $proto, $plugin, $instant ) = @_;
2704 my $class = ref $proto || $proto;
2706 Class::MOP::load_class( $plugin );
2707 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2708 if $plugin->isa( 'Catalyst::Component' );
2709 $proto->_plugins->{$plugin} = 1;
2711 my $meta = Class::MOP::get_metaclass_by_name($class);
2712 $meta->superclasses($plugin, $meta->superclasses);
2718 my ( $class, $plugins ) = @_;
2720 $class->_plugins( {} ) unless $class->_plugins;
2721 $plugins = Data::OptList::mkopt($plugins || []);
2724 [ Catalyst::Utils::resolve_namespace(
2725 $class . '::Plugin',
2726 'Catalyst::Plugin', $_->[0]
2732 for my $plugin ( reverse @plugins ) {
2733 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2734 my $meta = find_meta($plugin->[0]);
2735 next if $meta && $meta->isa('Moose::Meta::Role');
2737 $class->_register_plugin($plugin->[0]);
2741 map { $_->[0]->name, $_->[1] }
2742 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2743 map { [find_meta($_->[0]), $_->[1]] }
2746 Moose::Util::apply_all_roles(
2754 Returns an arrayref of the internal execution stack (actions that are
2755 currently executing).
2759 Returns the current timing statistics object. By default Catalyst uses
2760 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2761 L<< stats_class|/"$c->stats_class" >>.
2763 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2764 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2765 profile explicitly, although MyApp.pm still won't profile nor output anything
2768 =head2 $c->stats_class
2770 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2772 =head2 $c->use_stats
2774 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2776 Note that this is a static method, not an accessor and should be overridden
2777 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2784 =head2 $c->write( $data )
2786 Writes $data to the output stream. When using this method directly, you
2787 will need to manually set the C<Content-Length> header to the length of
2788 your output data, if known.
2795 # Finalize headers if someone manually writes output (for compat)
2796 $c->finalize_headers;
2798 return $c->response->write( @_ );
2803 Returns the Catalyst version number. Mostly useful for "powered by"
2804 messages in template systems.
2808 sub version { return $Catalyst::VERSION }
2810 =head1 CONFIGURATION
2812 There are a number of 'base' config variables which can be set:
2818 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2822 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2826 C<home> - The application home directory. In an uninstalled application,
2827 this is the top level application directory. In an installed application,
2828 this will be the directory containing C<< MyApp.pm >>.
2832 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2836 C<name> - The name of the application in debug messages and the debug and
2841 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2842 until it is accessed. This allows you to (for example) check authentication (and reject
2843 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
2847 C<root> - The root directory for templates. Usually this is just a
2848 subdirectory of the home directory, but you can set it to change the
2849 templates to a different directory.
2853 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2854 to be shown in hit debug tables in the test server.
2858 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
2859 variable should be used for determining the request path.
2861 Most web server environments pass the requested path to the application using environment variables,
2862 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
2863 exposed as C<< $c->request->base >>) and the request path below that base.
2865 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
2866 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
2870 =item use_request_uri_for_path => 0
2872 This is the default (and the) traditional method that Catalyst has used for determining the path information.
2873 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
2874 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
2875 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
2877 However this method has the major disadvantage that it is impossible to correctly decode some elements
2878 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
2879 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
2880 can't distinguish / vs %2F in paths (in addition to other encoded values).
2882 =item use_request_uri_for_path => 1
2884 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
2885 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
2886 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
2888 Given that this method of path resolution is provably more correct, it is recommended that you use
2889 this unless you have a specific need to deploy your application in a non-standard environment, and you are
2890 aware of the implications of not being able to handle encoded URI paths correctly.
2892 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
2893 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
2894 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
2895 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
2896 C<< $c->request->base >> will be incorrect.
2902 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2906 =head1 INTERNAL ACTIONS
2908 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2909 C<_ACTION>, and C<_END>. These are by default not shown in the private
2910 action table, but you can make them visible with a config parameter.
2912 MyApp->config(show_internal_actions => 1);
2914 =head1 ON-DEMAND PARSER
2916 The request body is usually parsed at the beginning of a request,
2917 but if you want to handle input yourself, you can enable on-demand
2918 parsing with a config parameter.
2920 MyApp->config(parse_on_demand => 1);
2922 =head1 PROXY SUPPORT
2924 Many production servers operate using the common double-server approach,
2925 with a lightweight frontend web server passing requests to a larger
2926 backend server. An application running on the backend server must deal
2927 with two problems: the remote user always appears to be C<127.0.0.1> and
2928 the server's hostname will appear to be C<localhost> regardless of the
2929 virtual host that the user connected through.
2931 Catalyst will automatically detect this situation when you are running
2932 the frontend and backend servers on the same machine. The following
2933 changes are made to the request.
2935 $c->req->address is set to the user's real IP address, as read from
2936 the HTTP X-Forwarded-For header.
2938 The host value for $c->req->base and $c->req->uri is set to the real
2939 host, as read from the HTTP X-Forwarded-Host header.
2941 Additionally, you may be running your backend application on an insecure
2942 connection (port 80) while your frontend proxy is running under SSL. If there
2943 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2944 tell Catalyst what port the frontend listens on. This will allow all URIs to
2945 be created properly.
2947 In the case of passing in:
2949 X-Forwarded-Port: 443
2951 All calls to C<uri_for> will result in an https link, as is expected.
2953 Obviously, your web server must support these headers for this to work.
2955 In a more complex server farm environment where you may have your
2956 frontend proxy server(s) on different machines, you will need to set a
2957 configuration option to tell Catalyst to read the proxied data from the
2960 MyApp->config(using_frontend_proxy => 1);
2962 If you do not wish to use the proxy support at all, you may set:
2964 MyApp->config(ignore_frontend_proxy => 0);
2966 =head2 Note about psgi files
2968 Note that if you supply your own .psgi file, calling
2969 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
2971 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
2972 in your psgi, for example:
2975 enable "Plack::Middleware::ReverseProxy";
2979 This will unconditionally add the ReverseProxy support, or you need to call
2980 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
2981 apply the support depending upon your config).
2983 See L<Catalyst::PSGI> for more information.
2985 =head1 THREAD SAFETY
2987 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2988 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2989 believe the Catalyst core to be thread-safe.
2991 If you plan to operate in a threaded environment, remember that all other
2992 modules you are using must also be thread-safe. Some modules, most notably
2993 L<DBD::SQLite>, are not thread-safe.
2999 Join #catalyst on irc.perl.org.
3003 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3004 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3008 http://catalyst.perl.org
3012 http://dev.catalyst.perl.org
3016 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3018 =head2 L<Catalyst::Manual> - The Catalyst Manual
3020 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3022 =head2 L<Catalyst::Engine> - Core engine
3024 =head2 L<Catalyst::Log> - Log class.
3026 =head2 L<Catalyst::Request> - Request object
3028 =head2 L<Catalyst::Response> - Response object
3030 =head2 L<Catalyst::Test> - The test suite.
3032 =head1 PROJECT FOUNDER
3034 sri: Sebastian Riedel <sri@cpan.org>
3040 acme: Leon Brocard <leon@astray.com>
3042 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3046 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3052 andyg: Andy Grundman <andy@hybridized.org>
3054 audreyt: Audrey Tang
3056 bricas: Brian Cassidy <bricas@cpan.org>
3058 Caelum: Rafael Kitover <rkitover@io.com>
3060 chansen: Christian Hansen
3062 chicks: Christopher Hicks
3064 Chisel Wright C<pause@herlpacker.co.uk>
3066 Danijel Milicevic C<me@danijel.de>
3068 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3070 David Naughton, C<naughton@umn.edu>
3074 dhoss: Devin Austin <dhoss@cpan.org>
3076 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3080 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3082 esskar: Sascha Kiefer
3084 fireartist: Carl Franks <cfranks@cpan.org>
3086 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3088 gabb: Danijel Milicevic
3092 Gavin Henry C<ghenry@perl.me.uk>
3096 groditi: Guillermo Roditi <groditi@gmail.com>
3098 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3100 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3102 jcamacho: Juan Camacho
3104 jester: Jesse Sheidlower C<jester@panix.com>
3106 jhannah: Jay Hannah <jay@jays.net>
3112 jon: Jon Schutz <jjschutz@cpan.org>
3114 Jonathan Rockway C<< <jrockway@cpan.org> >>
3116 Kieren Diment C<kd@totaldatasolution.com>
3118 konobi: Scott McWhirter <konobi@cpan.org>
3120 marcus: Marcus Ramberg <mramberg@cpan.org>
3122 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3124 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3128 naughton: David Naughton
3130 ningu: David Kamholz <dkamholz@cpan.org>
3132 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3134 numa: Dan Sully <daniel@cpan.org>
3140 omega: Andreas Marienborg
3142 Oleg Kostyuk <cub.uanic@gmail.com>
3144 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3146 rafl: Florian Ragwitz <rafl@debian.org>
3148 random: Roland Lammel <lammel@cpan.org>
3150 Robert Sedlacek C<< <rs@474.at> >>
3152 SpiceMan: Marcel Montes
3156 szbalint: Balint Szilakszi <szbalint@cpan.org>
3158 t0m: Tomas Doran <bobtfish@bobtfish.net>
3162 Viljo Marrandi C<vilts@yahoo.com>
3164 Will Hawes C<info@whawes.co.uk>
3166 willert: Sebastian Willert <willert@cpan.org>
3168 wreis: Wallace Reis <wallace@reis.org.br>
3170 Yuval Kogman, C<nothingmuch@woobling.org>
3172 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3174 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3178 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3182 This library is free software. You can redistribute it and/or modify it under
3183 the same terms as Perl itself.
3189 __PACKAGE__->meta->make_immutable;