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 { {} });
48 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
49 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
50 has namespace => (is => 'rw');
52 sub depth { scalar @{ shift->stack || [] }; }
53 sub comp { shift->component(@_) }
56 my $self = shift; return $self->request(@_);
59 my $self = shift; return $self->response(@_);
62 # For backwards compatibility
63 sub finalize_output { shift->finalize_body(@_) };
68 our $RECURSION = 1000;
69 our $DETACH = Catalyst::Exception::Detach->new;
70 our $GO = Catalyst::Exception::Go->new;
72 #I imagine that very few of these really need to be class variables. if any.
73 #maybe we should just make them attributes with a default?
74 __PACKAGE__->mk_classdata($_)
75 for qw/container arguments dispatcher engine log dispatcher_class
76 engine_loader context_class request_class response_class stats_class
77 setup_finished _psgi_app loading_psgi_file run_options/;
79 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
80 __PACKAGE__->request_class('Catalyst::Request');
81 __PACKAGE__->response_class('Catalyst::Response');
82 __PACKAGE__->stats_class('Catalyst::Stats');
84 # Remember to update this in Catalyst::Runtime as well!
86 our $VERSION = '5.90007';
89 my ( $class, @arguments ) = @_;
91 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
93 return unless $class eq 'Catalyst';
95 my $caller = caller();
96 return if $caller eq 'main';
98 my $meta = Moose::Meta::Class->initialize($caller);
100 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
101 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
102 $meta->superclasses(@superclasses); # XXX - Remove!
105 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
106 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
108 unless( $meta->has_method('meta') ){
109 if ($Moose::VERSION >= 1.15) {
110 $meta->_add_meta_method('meta');
113 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
117 $caller->arguments( [@arguments] );
121 sub MODIFY_CODE_ATTRIBUTES {
122 Catalyst::Exception->throw(
123 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
124 "That has been deprecated and removed. You should create a " .
125 "controller class called Root.pm, and move relevant code to that class."
130 sub _application { $_[0] }
134 Catalyst - The Elegant MVC Web Application Framework
138 See the L<Catalyst::Manual> distribution for comprehensive
139 documentation and tutorials.
141 # Install Catalyst::Devel for helpers and other development tools
142 # use the helper to create a new application
145 # add models, views, controllers
146 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
147 script/myapp_create.pl view MyTemplate TT
148 script/myapp_create.pl controller Search
150 # built in testserver -- use -r to restart automatically on changes
151 # --help to see all available options
152 script/myapp_server.pl
154 # command line testing interface
155 script/myapp_test.pl /yada
158 use Catalyst qw/-Debug/; # include plugins here as well
160 ### In lib/MyApp/Controller/Root.pm (autocreated)
161 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
162 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
163 $c->stash->{template} = 'foo.tt'; # set the template
164 # lookup something from db -- stash vars are passed to TT
166 $c->model('Database::Foo')->search( { country => $args[0] } );
167 if ( $c->req->params->{bar} ) { # access GET or POST parameters
168 $c->forward( 'bar' ); # process another action
169 # do something else after forward returns
173 # The foo.tt TT template can use the stash data from the database
174 [% WHILE (item = data.next) %]
178 # called for /bar/of/soap, /bar/of/soap/10, etc.
179 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
181 # called after all actions are finished
183 my ( $self, $c ) = @_;
184 if ( scalar @{ $c->error } ) { ... } # handle errors
185 return if $c->res->body; # already have a response
186 $c->forward( 'MyApp::View::TT' ); # render template
189 See L<Catalyst::Manual::Intro> for additional information.
193 Catalyst is a modern framework for making web applications without the
194 pain usually associated with this process. This document is a reference
195 to the main Catalyst application. If you are a new user, we suggest you
196 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
198 See L<Catalyst::Manual> for more documentation.
200 Catalyst plugins can be loaded by naming them as arguments to the "use
201 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
202 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
205 use Catalyst qw/My::Module/;
207 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
208 fully qualify the name by using a unary plus:
212 +Fully::Qualified::Plugin::Name
215 Special flags like C<-Debug> can also be specified as
216 arguments when Catalyst is loaded:
218 use Catalyst qw/-Debug My::Module/;
220 The position of plugins and flags in the chain is important, because
221 they are loaded in the order in which they appear.
223 The following flags are supported:
227 Enables debug output. You can also force this setting from the system
228 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
229 settings override the application, with <MYAPP>_DEBUG having the highest
232 This sets the log level to 'debug' and enables full debug output on the
233 error screen. If you only want the latter, see L<< $c->debug >>.
237 Forces Catalyst to use a specific home directory, e.g.:
239 use Catalyst qw[-Home=/usr/mst];
241 This can also be done in the shell environment by setting either the
242 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
243 is replaced with the uppercased name of your application, any "::" in
244 the name will be replaced with underscores, e.g. MyApp::Web should use
245 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
247 If none of these are set, Catalyst will attempt to automatically detect the
248 home directory. If you are working in a development environment, Catalyst
249 will try and find the directory containing either Makefile.PL, Build.PL or
250 dist.ini. If the application has been installed into the system (i.e.
251 you have done C<make install>), then Catalyst will use the path to your
252 application module, without the .pm extension (e.g., /foo/MyApp if your
253 application was installed at /foo/MyApp.pm)
257 use Catalyst '-Log=warn,fatal,error';
259 Specifies a comma-delimited list of log levels.
263 Enables statistics collection and reporting.
265 use Catalyst qw/-Stats=1/;
267 You can also force this setting from the system environment with CATALYST_STATS
268 or <MYAPP>_STATS. The environment settings override the application, with
269 <MYAPP>_STATS having the highest priority.
271 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
275 =head2 INFORMATION ABOUT THE CURRENT REQUEST
279 Returns a L<Catalyst::Action> object for the current action, which
280 stringifies to the action name. See L<Catalyst::Action>.
284 Returns the namespace of the current action, i.e., the URI prefix
285 corresponding to the controller of the current action. For example:
287 # in Controller::Foo::Bar
288 $c->namespace; # returns 'foo/bar';
294 Returns the current L<Catalyst::Request> object, giving access to
295 information about the current client request (including parameters,
296 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
298 =head2 REQUEST FLOW HANDLING
300 =head2 $c->forward( $action [, \@arguments ] )
302 =head2 $c->forward( $class, $method, [, \@arguments ] )
304 Forwards processing to another action, by its private name. If you give a
305 class name but no method, C<process()> is called. You may also optionally
306 pass arguments in an arrayref. The action will receive the arguments in
307 C<@_> and C<< $c->req->args >>. Upon returning from the function,
308 C<< $c->req->args >> will be restored to the previous values.
310 Any data C<return>ed from the action forwarded to, will be returned by the
313 my $foodata = $c->forward('/foo');
314 $c->forward('index');
315 $c->forward(qw/Model::DBIC::Foo do_stuff/);
316 $c->forward('View::TT');
318 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
319 an C<< eval { } >> around the call (actually
320 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
321 exceptions thrown by the called action non-fatal and pushing them onto
322 $c->error instead. If you want C<die> to propagate you need to do something
326 die join "\n", @{ $c->error } if @{ $c->error };
328 Or make sure to always return true values from your actions and write
331 $c->forward('foo') || return;
333 Another note is that C<< $c->forward >> always returns a scalar because it
334 actually returns $c->state which operates in a scalar context.
335 Thus, something like:
339 in an action that is forwarded to is going to return a scalar,
340 i.e. how many items are in that array, which is probably not what you want.
341 If you need to return an array then return a reference to it,
344 $c->stash->{array} = \@array;
346 and access it from the stash.
348 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.
352 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
354 =head2 $c->detach( $action [, \@arguments ] )
356 =head2 $c->detach( $class, $method, [, \@arguments ] )
360 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
361 doesn't return to the previous action when processing is finished.
363 When called with no arguments it escapes the processing chain entirely.
367 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
369 =head2 $c->visit( $action [, \@captures, \@arguments ] )
371 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
373 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
374 but does a full dispatch, instead of just calling the new C<$action> /
375 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
376 you go to are called, just like a new request.
378 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
379 This means, for example, that C<< $c->action >> methods such as
380 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
381 L<reverse|Catalyst::Action/reverse> return information for the visited action
382 when they are invoked within the visited action. This is different from the
383 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
384 continues to use the $c->action object from the caller action even when
385 invoked from the called action.
387 C<< $c->stash >> is kept unchanged.
389 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
390 allows you to "wrap" another action, just as it would have been called by
391 dispatching from a URL, while the analogous
392 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
393 transfer control to another action as if it had been reached directly from a URL.
397 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
399 =head2 $c->go( $action [, \@captures, \@arguments ] )
401 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
403 The relationship between C<go> and
404 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
405 the relationship between
406 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
407 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
408 C<< $c->go >> will perform a full dispatch on the specified action or method,
409 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
410 C<go> escapes the processing of the current request chain on completion, and
411 does not return to its caller.
413 @arguments are arguments to the final destination of $action. @captures are
414 arguments to the intermediate steps, if any, on the way to the final sub of
419 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
425 Returns the current L<Catalyst::Response> object, see there for details.
429 Returns a hashref to the stash, which may be used to store data and pass
430 it between components during a request. You can also set hash keys by
431 passing arguments. The stash is automatically sent to the view. The
432 stash is cleared at the end of a request; it cannot be used for
433 persistent storage (for this you must use a session; see
434 L<Catalyst::Plugin::Session> for a complete system integrated with
437 $c->stash->{foo} = $bar;
438 $c->stash( { moose => 'majestic', qux => 0 } );
439 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
441 # stash is automatically passed to the view for use in a template
442 $c->forward( 'MyApp::View::TT' );
446 around stash => sub {
449 my $stash = $orig->($c);
451 my $new_stash = @_ > 1 ? {@_} : $_[0];
452 croak('stash takes a hash or hashref') unless ref $new_stash;
453 foreach my $key ( keys %$new_stash ) {
454 $stash->{$key} = $new_stash->{$key};
464 =head2 $c->error($error, ...)
466 =head2 $c->error($arrayref)
468 Returns an arrayref containing error messages. If Catalyst encounters an
469 error while processing a request, it stores the error in $c->error. This
470 method should only be used to store fatal error messages.
472 my @error = @{ $c->error };
476 $c->error('Something bad happened');
483 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
484 croak @$error unless ref $c;
485 push @{ $c->{error} }, @$error;
487 elsif ( defined $_[0] ) { $c->{error} = undef }
488 return $c->{error} || [];
494 Contains the return value of the last executed action.
495 Note that << $c->state >> operates in a scalar context which means that all
496 values it returns are scalar.
498 =head2 $c->clear_errors
500 Clear errors. You probably don't want to clear the errors unless you are
501 implementing a custom error screen.
503 This is equivalent to running
514 =head2 COMPONENT ACCESSORS
516 =head2 $c->controller($name)
518 Gets a L<Catalyst::Controller> instance by name.
520 $c->controller('Foo')->do_stuff;
522 If the name is omitted, will return the controller for the dispatched
525 If you want to search for controllers, pass in a regexp as the argument.
527 # find all controllers that start with Foo
528 my @foo_controllers = $c->controller(qr{^Foo});
533 sub controller { shift->_lookup_mvc('controller', @_) }
535 =head2 $c->model($name)
537 Gets a L<Catalyst::Model> instance by name.
539 $c->model('Foo')->do_stuff;
541 Any extra arguments are directly passed to ACCEPT_CONTEXT.
543 If the name is omitted, it will look for
544 - a model object in $c->stash->{current_model_instance}, then
545 - a model name in $c->stash->{current_model}, then
546 - a config setting 'default_model', or
547 - check if there is only one model, and return it if that's the case.
549 If you want to search for models, pass in a regexp as the argument.
551 # find all models that start with Foo
552 my @foo_models = $c->model(qr{^Foo});
556 sub model { shift->_lookup_mvc('model', @_) }
558 =head2 $c->view($name)
560 Gets a L<Catalyst::View> instance by name.
562 $c->view('Foo')->do_stuff;
564 Any extra arguments are directly passed to ACCEPT_CONTEXT.
566 If the name is omitted, it will look for
567 - a view object in $c->stash->{current_view_instance}, then
568 - a view name in $c->stash->{current_view}, then
569 - a config setting 'default_view', or
570 - check if there is only one view, and return it if that's the case.
572 If you want to search for views, pass in a regexp as the argument.
574 # find all views that start with Foo
575 my @foo_views = $c->view(qr{^Foo});
579 sub view { shift->_lookup_mvc('view', @_) }
582 my ( $c, $type, $name, @args ) = @_;
584 if (ref $c && !$name) {
585 my $current_instance = $c->stash->{"current_${type}_instance"};
586 return $current_instance
587 if $current_instance && $type ne 'controller';
589 $name = $type eq 'controller'
590 ? Catalyst::Utils::class2classshortsuffix($c->action->class)
591 : $c->stash->{"current_${type}"}
595 return $c->container->get_component_from_sub_container($type, $name, $c, @args);
598 =head2 $c->controllers
600 Returns the available names which can be passed to $c->controller
606 return $c->container->get_sub_container('controller')->get_service_list;
611 Returns the available names which can be passed to $c->model
617 return $c->container->get_sub_container('model')->get_service_list;
623 Returns the available names which can be passed to $c->view
629 return $c->container->get_sub_container('view')->get_service_list;
632 =head2 $c->comp($name)
634 =head2 $c->component($name)
636 Gets a component object by name. This method is not recommended,
637 unless you want to get a specific component by full
638 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
639 should be used instead.
641 If C<$name> is a regexp, a list of components matched against the full
642 component name will be returned.
647 my ( $c, $component, @args ) = @_;
649 unless ($component) {
650 $c->log->warn('Calling $c->component with no args is deprecated and ');
651 $c->log->warn('will be removed in a future release.');
652 $c->log->warn('Use $c->component_list instead.');
653 return $c->component_list;
656 my @result = $c->container->find_component( $component, $c, @args );
658 # list context for regexp searches
659 return @result if ref $component;
661 # only one component (if it's found) for string searches
662 return shift @result if @result;
664 if (ref $c eq $component) {
665 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
666 $c->log->warn('deprecated, and will be removed in a future release.');
670 $c->log->warn("Looking for '$component', but nothing was found.");
672 # I would expect to return an empty list here, but that breaks back-compat
673 $c->log->warn('Component not found, returning the list of existing');
674 $c->log->warn('components. This behavior is deprecated and will be');
675 $c->log->warn('removed in a future release. Use $c->component_list');
676 $c->log->warn('instead.');
678 return $c->component_list;
681 =head2 $c->component_list
683 Returns the sorted list of the component names of the application.
687 sub component_list { sort keys %{ shift->components } }
689 =head2 CLASS DATA AND HELPER CLASSES
693 Returns or takes a hashref containing the application's configuration.
695 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
697 You can also use a C<YAML>, C<XML> or L<Config::General> config file
698 like C<myapp.conf> in your applications home directory. See
699 L<Catalyst::Plugin::ConfigLoader>.
701 =head3 Cascading configuration
703 The config method is present on all Catalyst components, and configuration
704 will be merged when an application is started. Configuration loaded with
705 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
706 followed by configuration in your top level C<MyApp> class. These two
707 configurations are merged, and then configuration data whose hash key matches a
708 component name is merged with configuration for that component.
710 The configuration for a component is then passed to the C<new> method when a
711 component is constructed.
715 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
716 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
718 will mean that C<MyApp::Model::Foo> receives the following data when
721 MyApp::Model::Foo->new({
727 It's common practice to use a Moose attribute
728 on the receiving component to access the config value.
730 package MyApp::Model::Foo;
734 # this attr will receive 'baz' at construction time
740 You can then get the value 'baz' by calling $c->model('Foo')->bar
741 (or $self->bar inside code in the model).
743 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
744 as a way of reading config within your code, as this B<will not> give you the
745 correctly merged config back. You B<MUST> take the config values supplied to
746 the constructor and use those instead.
750 around config => sub {
754 croak('Setting config after setup has been run is not allowed.')
755 if ( @_ and $c->setup_finished );
762 Returns the logging object instance. Unless it is already set, Catalyst
763 sets this up with a L<Catalyst::Log> object. To use your own log class,
764 set the logger with the C<< __PACKAGE__->log >> method prior to calling
765 C<< __PACKAGE__->setup >>.
767 __PACKAGE__->log( MyLogger->new );
772 $c->log->info( 'Now logging with my own logger!' );
774 Your log class should implement the methods described in
780 Returns 1 if debug mode is enabled, 0 otherwise.
782 You can enable debug mode in several ways:
786 =item By calling myapp_server.pl with the -d flag
788 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
790 =item The -Debug option in your MyApp.pm
792 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
796 The first three also set the log level to 'debug'.
798 Calling C<< $c->debug(1) >> has no effect.
804 =head2 $c->dispatcher
806 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
810 Returns the engine instance. See L<Catalyst::Engine>.
813 =head2 UTILITY METHODS
815 =head2 $c->path_to(@path)
817 Merges C<@path> with C<< $c->config->{home} >> and returns a
818 L<Path::Class::Dir> object. Note you can usually use this object as
819 a filename, but sometimes you will have to explicitly stringify it
820 yourself by calling the C<< ->stringify >> method.
824 $c->path_to( 'db', 'sqlite.db' );
829 my ( $c, @path ) = @_;
830 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
831 if ( -d $path ) { return $path }
832 else { return Path::Class::File->new( $c->config->{home}, @path ) }
836 my ( $class, $name, $plugin, @args ) = @_;
838 # See block comment in t/aggregate/unit_core_plugin.t
839 # See block comment in t/unit_core_plugin.t
840 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
842 $class->_register_plugin( $plugin, 1 );
844 eval { $plugin->import };
845 $class->mk_classdata($name);
847 eval { $obj = $plugin->new(@args) };
850 Catalyst::Exception->throw( message =>
851 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
855 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
861 Initializes the dispatcher and engine, loads any plugins, and loads the
862 model, view, and controller components. You may also specify an array
863 of plugins to load here, if you choose to not load them in the C<use
867 MyApp->setup( qw/-Debug/ );
869 B<Note:> You B<should not> wrap this method with method modifiers
870 or bad things will happen - wrap the C<setup_finalize> method instead.
875 my ( $class, @arguments ) = @_;
876 croak('Running setup more than once')
877 if ( $class->setup_finished );
879 unless ( $class->isa('Catalyst') ) {
881 Catalyst::Exception->throw(
882 message => qq/'$class' does not inherit from Catalyst/ );
885 if ( $class->arguments ) {
886 @arguments = ( @arguments, @{ $class->arguments } );
892 foreach (@arguments) {
896 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
898 elsif (/^-(\w+)=?(.*)$/) {
899 $flags->{ lc $1 } = $2;
902 push @{ $flags->{plugins} }, $_;
906 $class->setup_config();
907 $class->setup_home( delete $flags->{home} );
909 $class->setup_log( delete $flags->{log} );
910 $class->setup_plugins( delete $flags->{plugins} );
911 $class->setup_dispatcher( delete $flags->{dispatcher} );
912 if (my $engine = delete $flags->{engine}) {
913 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
915 $class->setup_engine();
916 $class->setup_stats( delete $flags->{stats} );
918 for my $flag ( sort keys %{$flags} ) {
920 if ( my $code = $class->can( 'setup_' . $flag ) ) {
921 &$code( $class, delete $flags->{$flag} );
924 $class->log->warn(qq/Unknown flag "$flag"/);
928 eval { require Catalyst::Devel; };
929 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
930 $class->log->warn(<<"EOF");
931 You are running an old script!
933 Please update by running (this will overwrite existing files):
934 catalyst.pl -force -scripts $class
936 or (this will not overwrite existing files):
937 catalyst.pl -scripts $class
942 if ( $class->debug ) {
943 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
946 my $column_width = Catalyst::Utils::term_width() - 6;
947 my $t = Text::SimpleTable->new($column_width);
948 $t->row($_) for @plugins;
949 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
952 my $dispatcher = $class->dispatcher;
953 my $engine = $class->engine;
954 my $home = $class->config->{home};
956 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
957 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
961 ? $class->log->debug(qq/Found home "$home"/)
962 : $class->log->debug(qq/Home "$home" doesn't exist/)
963 : $class->log->debug(q/Couldn't find home/);
966 # Call plugins setup, this is stupid and evil.
967 # Also screws C3 badly on 5.10, hack to avoid.
969 no warnings qw/redefine/;
970 local *setup = sub { };
971 $class->setup unless $Catalyst::__AM_RESTARTING;
974 $class->setup_components;
978 my $comps = $class->container->get_all_components($class)
980 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
981 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
982 $t->row( $_ => ref($comps->{$_}) ? 'instance' : 'class' ) for keys %$comps;
984 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
987 $class->setup_actions;
989 if ( $class->debug ) {
990 my $name = $class->config->{name} || 'Application';
991 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
994 # Make sure that the application class becomes immutable at this point,
995 B::Hooks::EndOfScope::on_scope_end {
997 my $meta = Class::MOP::get_metaclass_by_name($class);
1000 && ! { $meta->immutable_options }->{replace_constructor}
1002 $class->isa('Class::Accessor::Fast')
1003 || $class->isa('Class::Accessor')
1006 warn "You made your application class ($class) immutable, "
1007 . "but did not inline the\nconstructor. "
1008 . "This will break catalyst, as your app \@ISA "
1009 . "Class::Accessor(::Fast)?\nPlease pass "
1010 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1012 $meta->make_immutable(
1013 replace_constructor => 1,
1014 ) unless $meta->is_immutable;
1017 if ($class->config->{case_sensitive}) {
1018 $class->log->warn($class . "->config->{case_sensitive} is set.");
1019 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1022 $class->setup_finalize;
1023 # Should be the last thing we do so that user things hooking
1024 # setup_finalize can log..
1025 $class->log->_flush() if $class->log->can('_flush');
1026 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1029 =head2 $app->setup_finalize
1031 A hook to attach modifiers to. This method does not do anything except set the
1032 C<setup_finished> accessor.
1034 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1038 after setup_finalize => sub {
1046 sub setup_finalize {
1048 $class->setup_finished(1);
1051 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1053 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1055 Constructs an absolute L<URI> object based on the application root, the
1056 provided path, and the additional arguments and query parameters provided.
1057 When used as a string, provides a textual URI. If you need more flexibility
1058 than this (i.e. the option to provide relative URIs etc.) see
1059 L<Catalyst::Plugin::SmartURI>.
1061 If no arguments are provided, the URI for the current action is returned.
1062 To return the current action and also provide @args, use
1063 C<< $c->uri_for( $c->action, @args ) >>.
1065 If the first argument is a string, it is taken as a public URI path relative
1066 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1067 relative to the application root (if it does). It is then merged with
1068 C<< $c->request->base >>; any C<@args> are appended as additional path
1069 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1071 If the first argument is a L<Catalyst::Action> it represents an action which
1072 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1073 optional C<\@captures> argument (an arrayref) allows passing the captured
1074 variables that are needed to fill in the paths of Chained and Regex actions;
1075 once the path is resolved, C<uri_for> continues as though a path was
1076 provided, appending any arguments or parameters and creating an absolute
1079 The captures for the current request can be found in
1080 C<< $c->request->captures >>, and actions can be resolved using
1081 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1082 path, use C<< $c->uri_for_action >> instead.
1084 # Equivalent to $c->req->uri
1085 $c->uri_for($c->action, $c->req->captures,
1086 @{ $c->req->args }, $c->req->params);
1088 # For the Foo action in the Bar controller
1089 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1091 # Path to a static resource
1092 $c->uri_for('/static/images/logo.png');
1097 my ( $c, $path, @args ) = @_;
1099 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1100 $path = $path->path_prefix;
1105 undef($path) if (defined $path && $path eq '');
1108 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1110 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1111 foreach my $arg (@args) {
1112 utf8::encode($arg) if utf8::is_utf8($arg);
1113 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1116 if ( blessed($path) ) { # action object
1117 s|/|%2F|g for @args;
1118 my $captures = [ map { s|/|%2F|g; $_; }
1119 ( scalar @args && ref $args[0] eq 'ARRAY'
1123 foreach my $capture (@$captures) {
1124 utf8::encode($capture) if utf8::is_utf8($capture);
1125 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1129 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1130 if( !@args && $action->number_of_args ) {
1131 my $expanded_action = $c->dispatcher->expand_action( $action );
1133 my $num_captures = $expanded_action->number_of_captures;
1134 unshift @args, splice @$captures, $num_captures;
1137 $path = $c->dispatcher->uri_for_action($action, $captures);
1138 if (not defined $path) {
1139 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1143 $path = '/' if $path eq '';
1146 unshift(@args, $path);
1148 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1149 my $namespace = $c->namespace;
1150 if (defined $path) { # cheesy hack to handle path '../foo'
1151 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1153 unshift(@args, $namespace || '');
1156 # join args with '/', or a blank string
1157 my $args = join('/', grep { defined($_) } @args);
1158 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1160 my $base = $c->req->base;
1161 my $class = ref($base);
1162 $base =~ s{(?<!/)$}{/};
1166 if (my @keys = keys %$params) {
1167 # somewhat lifted from URI::_query's query_form
1168 $query = '?'.join('&', map {
1169 my $val = $params->{$_};
1170 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1173 $val = '' unless defined $val;
1176 utf8::encode( $param ) if utf8::is_utf8($param);
1177 # using the URI::Escape pattern here so utf8 chars survive
1178 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1180 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1184 my $res = bless(\"${base}${args}${query}", $class);
1188 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1190 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1196 A private path to the Catalyst action you want to create a URI for.
1198 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1199 >> and passing the resulting C<$action> and the remaining arguments to C<<
1202 You can also pass in a Catalyst::Action object, in which case it is passed to
1205 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.
1207 For example, if the action looks like:
1209 package MyApp::Controller::Users;
1211 sub lst : Path('the-list') {}
1215 $c->uri_for_action('/users/lst')
1217 and it will create the URI /users/the-list.
1219 =item \@captures_and_args?
1221 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1222 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1223 to interpolate all the parameters in the URI.
1227 Optional list of extra arguments - can be supplied in the
1228 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1231 Your action can have zero, a fixed or a variable number of args (e.g.
1232 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1234 =item \%query_values?
1236 Optional array reference of query parameters to append. E.g.
1242 /rest/of/your/uri?foo=bar
1248 sub uri_for_action {
1249 my ( $c, $path, @args ) = @_;
1250 my $action = blessed($path)
1252 : $c->dispatcher->get_action_by_path($path);
1253 unless (defined $action) {
1254 croak "Can't find action for path '$path'";
1256 return $c->uri_for( $action, @args );
1259 =head2 $c->welcome_message
1261 Returns the Catalyst welcome HTML page.
1265 sub welcome_message {
1267 my $name = $c->config->{name};
1268 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1269 my $prefix = Catalyst::Utils::appprefix( ref $c );
1270 $c->response->content_type('text/html; charset=utf-8');
1272 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1273 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1274 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1276 <meta http-equiv="Content-Language" content="en" />
1277 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1278 <title>$name on Catalyst $VERSION</title>
1279 <style type="text/css">
1282 background-color: #eee;
1289 margin-bottom: 10px;
1291 background-color: #ccc;
1292 border: 1px solid #aaa;
1297 font-family: verdana, tahoma, sans-serif;
1300 font-family: verdana, tahoma, sans-serif;
1303 text-decoration: none;
1305 border-bottom: 1px dotted #bbb;
1307 :link:hover, :visited:hover {
1320 background-color: #fff;
1321 border: 1px solid #aaa;
1325 font-weight: normal;
1347 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1352 <img src="$logo" alt="Catalyst Logo" />
1354 <p>Welcome to the world of Catalyst.
1355 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1356 framework will make web development something you had
1357 never expected it to be: Fun, rewarding, and quick.</p>
1358 <h2>What to do now?</h2>
1359 <p>That really depends on what <b>you</b> want to do.
1360 We do, however, provide you with a few starting points.</p>
1361 <p>If you want to jump right into web development with Catalyst
1362 you might want to start with a tutorial.</p>
1363 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1365 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1367 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1368 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1370 <h2>What to do next?</h2>
1371 <p>Next it's time to write an actual application. Use the
1372 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1373 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1374 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1375 they can save you a lot of work.</p>
1376 <pre><code>script/${prefix}_create.pl --help</code></pre>
1377 <p>Also, be sure to check out the vast and growing
1378 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1379 you are likely to find what you need there.
1383 <p>Catalyst has a very active community. Here are the main places to
1384 get in touch with us.</p>
1387 <a href="http://dev.catalyst.perl.org">Wiki</a>
1390 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1393 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1396 <h2>In conclusion</h2>
1397 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1398 as we enjoyed making it. Please contact us if you have ideas
1399 for improvement or other feedback.</p>
1409 Contains a hash of options passed from the application script, including
1410 the original ARGV the script received, the processed values from that
1411 ARGV and any extra arguments to the script which were not processed.
1413 This can be used to add custom options to your application's scripts
1414 and setup your application differently depending on the values of these
1417 =head1 INTERNAL METHODS
1419 These methods are not meant to be used by end users.
1421 =head2 $c->components
1423 Returns a hash of components.
1428 my ( $class, $comps ) = @_;
1430 # people create components calling this sub directly, before setup
1431 $class->setup_config unless $class->container;
1433 my $container = $class->container;
1436 $container->add_component( $_ ) for keys %$comps;
1439 return $container->get_all_components($class);
1442 =head2 $c->context_class
1444 Returns or sets the context class.
1448 Returns a hashref containing coderefs and execution counts (needed for
1449 deep recursion detection).
1453 Returns the number of actions on the current internal execution stack.
1457 Dispatches a request to actions.
1461 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1463 =head2 $c->dispatcher_class
1465 Returns or sets the dispatcher class.
1467 =head2 $c->dump_these
1469 Returns a list of 2-element array references (name, structure) pairs
1470 that will be dumped on the error page in debug mode.
1476 [ Request => $c->req ],
1477 [ Response => $c->res ],
1478 [ Stash => $c->stash ],
1479 [ Config => $c->config ];
1482 =head2 $c->engine_class
1484 Returns or sets the engine class.
1486 =head2 $c->execute( $class, $coderef )
1488 Execute a coderef in given class and catch exceptions. Errors are available
1494 my ( $c, $class, $code ) = @_;
1495 $class = $c->component($class) || $class;
1498 if ( $c->depth >= $RECURSION ) {
1499 my $action = $code->reverse();
1500 $action = "/$action" unless $action =~ /->/;
1501 my $error = qq/Deep recursion detected calling "${action}"/;
1502 $c->log->error($error);
1508 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1510 push( @{ $c->stack }, $code );
1512 no warnings 'recursion';
1513 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1514 # I have no idea how, ergo $ret (which appears to fix the issue)
1515 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1517 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1519 my $last = pop( @{ $c->stack } );
1521 if ( my $error = $@ ) {
1522 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1523 $error->rethrow if $c->depth > 1;
1525 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1526 $error->rethrow if $c->depth > 0;
1529 unless ( ref $error ) {
1530 no warnings 'uninitialized';
1532 my $class = $last->class;
1533 my $name = $last->name;
1534 $error = qq/Caught exception in $class->$name "$error"/;
1543 sub _stats_start_execute {
1544 my ( $c, $code ) = @_;
1545 my $appclass = ref($c) || $c;
1546 return if ( ( $code->name =~ /^_.*/ )
1547 && ( !$appclass->config->{show_internal_actions} ) );
1549 my $action_name = $code->reverse();
1550 $c->counter->{$action_name}++;
1552 my $action = $action_name;
1553 $action = "/$action" unless $action =~ /->/;
1555 # determine if the call was the result of a forward
1556 # this is done by walking up the call stack and looking for a calling
1557 # sub of Catalyst::forward before the eval
1559 for my $index ( 2 .. 11 ) {
1561 if ( ( caller($index) )[0] eq 'Catalyst'
1562 && ( caller($index) )[3] eq '(eval)' );
1564 if ( ( caller($index) )[3] =~ /forward$/ ) {
1565 $callsub = ( caller($index) )[3];
1566 $action = "-> $action";
1571 my $uid = $action_name . $c->counter->{$action_name};
1573 # is this a root-level call or a forwarded call?
1574 if ( $callsub =~ /forward$/ ) {
1575 my $parent = $c->stack->[-1];
1577 # forward, locate the caller
1578 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1581 parent => "$parent" . $c->counter->{"$parent"},
1587 # forward with no caller may come from a plugin
1606 sub _stats_finish_execute {
1607 my ( $c, $info ) = @_;
1608 $c->stats->profile( end => $info );
1613 Finalizes the request.
1620 for my $error ( @{ $c->error } ) {
1621 $c->log->error($error);
1624 # Allow engine to handle finalize flow (for POE)
1625 my $engine = $c->engine;
1626 if ( my $code = $engine->can('finalize') ) {
1631 $c->finalize_uploads;
1634 if ( $#{ $c->error } >= 0 ) {
1638 $c->finalize_headers;
1641 if ( $c->request->method eq 'HEAD' ) {
1642 $c->response->body('');
1650 if ($c->use_stats) {
1651 my $elapsed = sprintf '%f', $c->stats->elapsed;
1652 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1654 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1657 return $c->response->status;
1660 =head2 $c->finalize_body
1666 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1668 =head2 $c->finalize_cookies
1674 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1676 =head2 $c->finalize_error
1682 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1684 =head2 $c->finalize_headers
1690 sub finalize_headers {
1693 my $response = $c->response; #accessor calls can add up?
1695 # Check if we already finalized headers
1696 return if $response->finalized_headers;
1699 if ( my $location = $response->redirect ) {
1700 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1701 $response->header( Location => $location );
1703 if ( !$response->has_body ) {
1704 # Add a default body if none is already present
1705 $response->body(<<"EOF");
1706 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1707 <html xmlns="http://www.w3.org/1999/xhtml">
1709 <title>Moved</title>
1712 <p>This item has moved <a href="$location">here</a>.</p>
1716 $response->content_type('text/html; charset=utf-8');
1721 if ( defined $response->body && length $response->body && !$response->content_length ) {
1723 # get the length from a filehandle
1724 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1726 my $size = -s $response->body;
1728 $response->content_length( $size );
1731 $c->log->warn('Serving filehandle without a content-length');
1735 # everything should be bytes at this point, but just in case
1736 $response->content_length( length( $response->body ) );
1741 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1742 $response->headers->remove_header("Content-Length");
1743 $response->body('');
1746 $c->finalize_cookies;
1748 $c->engine->finalize_headers( $c, @_ );
1751 $response->finalized_headers(1);
1754 =head2 $c->finalize_output
1756 An alias for finalize_body.
1758 =head2 $c->finalize_read
1760 Finalizes the input after reading is complete.
1764 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1766 =head2 $c->finalize_uploads
1768 Finalizes uploads. Cleans up any temporary files.
1772 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1774 =head2 $c->get_action( $action, $namespace )
1776 Gets an action in a given namespace.
1780 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1782 =head2 $c->get_actions( $action, $namespace )
1784 Gets all actions of a given name in a namespace and all parent
1789 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1791 =head2 $app->handle_request( @arguments )
1793 Called to handle each HTTP request.
1797 sub handle_request {
1798 my ( $class, @arguments ) = @_;
1800 # Always expect worst case!
1803 if ($class->debug) {
1804 my $secs = time - $START || 1;
1805 my $av = sprintf '%.3f', $COUNT / $secs;
1806 my $time = localtime time;
1807 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1810 my $c = $class->prepare(@arguments);
1812 $status = $c->finalize;
1815 chomp(my $error = $_);
1816 $class->log->error(qq/Caught exception in engine "$error"/);
1821 if(my $coderef = $class->log->can('_flush')){
1822 $class->log->$coderef();
1827 =head2 $class->prepare( @arguments )
1829 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1835 my ( $class, @arguments ) = @_;
1838 # After the app/ctxt split, this should become an attribute based on something passed
1839 # into the application.
1840 $class->context_class( ref $class || $class ) unless $class->context_class;
1842 my $c = $class->context_class->new({});
1844 # For on-demand data
1845 $c->request->_context($c);
1846 $c->response->_context($c);
1848 #surely this is not the most efficient way to do things...
1849 $c->stats($class->stats_class->new)->enable($c->use_stats);
1850 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1851 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1855 # Allow engine to direct the prepare flow (for POE)
1856 if ( my $prepare = $c->engine->can('prepare') ) {
1857 $c->engine->$prepare( $c, @arguments );
1860 $c->prepare_request(@arguments);
1861 $c->prepare_connection;
1862 $c->prepare_query_parameters;
1863 $c->prepare_headers;
1864 $c->prepare_cookies;
1867 # Prepare the body for reading, either by prepare_body
1868 # or the user, if they are using $c->read
1871 # Parse the body unless the user wants it on-demand
1872 unless ( ref($c)->config->{parse_on_demand} ) {
1878 # VERY ugly and probably shouldn't rely on ->finalize actually working
1880 # failed prepare is always due to an invalid request, right?
1881 $c->response->status(400);
1882 $c->response->content_type('text/plain');
1883 $c->response->body('Bad Request');
1884 # Note we call finalize and then die here, which escapes
1885 # finalize being called in the enclosing block..
1886 # It in fact couldn't be called, as we don't return $c..
1887 # This is a mess - but I'm unsure you can fix this without
1888 # breaking compat for people doing crazy things (we should set
1889 # the 400 and just return the ctx here IMO, letting finalize get called
1900 =head2 $c->prepare_action
1902 Prepares action. See L<Catalyst::Dispatcher>.
1906 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1908 =head2 $c->prepare_body
1910 Prepares message body.
1917 return if $c->request->_has_body;
1919 # Initialize on-demand data
1920 $c->engine->prepare_body( $c, @_ );
1921 $c->prepare_parameters;
1922 $c->prepare_uploads;
1925 =head2 $c->prepare_body_chunk( $chunk )
1927 Prepares a chunk of data before sending it to L<HTTP::Body>.
1929 See L<Catalyst::Engine>.
1933 sub prepare_body_chunk {
1935 $c->engine->prepare_body_chunk( $c, @_ );
1938 =head2 $c->prepare_body_parameters
1940 Prepares body parameters.
1944 sub prepare_body_parameters {
1946 $c->engine->prepare_body_parameters( $c, @_ );
1949 =head2 $c->prepare_connection
1951 Prepares connection.
1955 sub prepare_connection {
1957 $c->engine->prepare_connection( $c, @_ );
1960 =head2 $c->prepare_cookies
1966 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1968 =head2 $c->prepare_headers
1974 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1976 =head2 $c->prepare_parameters
1978 Prepares parameters.
1982 sub prepare_parameters {
1984 $c->prepare_body_parameters;
1985 $c->engine->prepare_parameters( $c, @_ );
1988 =head2 $c->prepare_path
1990 Prepares path and base.
1994 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1996 =head2 $c->prepare_query_parameters
1998 Prepares query parameters.
2002 sub prepare_query_parameters {
2005 $c->engine->prepare_query_parameters( $c, @_ );
2008 =head2 $c->log_request
2010 Writes information about the request to the debug logs. This includes:
2014 =item * Request method, path, and remote IP address
2016 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2018 =item * Request parameters
2020 =item * File uploads
2029 return unless $c->debug;
2031 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2032 my $request = $dump->[1];
2034 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2036 $path = '/' unless length $path;
2038 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2040 $c->log_request_headers($request->headers);
2042 if ( my $keywords = $request->query_keywords ) {
2043 $c->log->debug("Query keywords are: $keywords");
2046 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2048 $c->log_request_uploads($request);
2051 =head2 $c->log_response
2053 Writes information about the response to the debug logs by calling
2054 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2061 return unless $c->debug;
2063 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2064 my $response = $dump->[1];
2066 $c->log_response_status_line($response);
2067 $c->log_response_headers($response->headers);
2070 =head2 $c->log_response_status_line($response)
2072 Writes one line of information about the response to the debug logs. This includes:
2076 =item * Response status code
2078 =item * Content-Type header (if present)
2080 =item * Content-Length header (if present)
2086 sub log_response_status_line {
2087 my ($c, $response) = @_;
2091 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2092 $response->status || 'unknown',
2093 $response->headers->header('Content-Type') || 'unknown',
2094 $response->headers->header('Content-Length') || 'unknown'
2099 =head2 $c->log_response_headers($headers);
2101 Hook method which can be wrapped by plugins to log the response headers.
2102 No-op in the default implementation.
2106 sub log_response_headers {}
2108 =head2 $c->log_request_parameters( query => {}, body => {} )
2110 Logs request parameters to debug logs
2114 sub log_request_parameters {
2116 my %all_params = @_;
2118 return unless $c->debug;
2120 my $column_width = Catalyst::Utils::term_width() - 44;
2121 foreach my $type (qw(query body)) {
2122 my $params = $all_params{$type};
2123 next if ! keys %$params;
2124 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2125 for my $key ( sort keys %$params ) {
2126 my $param = $params->{$key};
2127 my $value = defined($param) ? $param : '';
2128 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2130 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2134 =head2 $c->log_request_uploads
2136 Logs file uploads included in the request to the debug logs.
2137 The parameter name, filename, file type, and file size are all included in
2142 sub log_request_uploads {
2144 my $request = shift;
2145 return unless $c->debug;
2146 my $uploads = $request->uploads;
2147 if ( keys %$uploads ) {
2148 my $t = Text::SimpleTable->new(
2149 [ 12, 'Parameter' ],
2154 for my $key ( sort keys %$uploads ) {
2155 my $upload = $uploads->{$key};
2156 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2157 $t->row( $key, $u->filename, $u->type, $u->size );
2160 $c->log->debug( "File Uploads are:\n" . $t->draw );
2164 =head2 $c->log_request_headers($headers);
2166 Hook method which can be wrapped by plugins to log the request headers.
2167 No-op in the default implementation.
2171 sub log_request_headers {}
2173 =head2 $c->log_headers($type => $headers)
2175 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2182 my $headers = shift; # an HTTP::Headers instance
2184 return unless $c->debug;
2186 my $column_width = Catalyst::Utils::term_width() - 28;
2187 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2190 my ( $name, $value ) = @_;
2191 $t->row( $name, $value );
2194 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2198 =head2 $c->prepare_read
2200 Prepares the input for reading.
2204 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2206 =head2 $c->prepare_request
2208 Prepares the engine request.
2212 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2214 =head2 $c->prepare_uploads
2220 sub prepare_uploads {
2223 $c->engine->prepare_uploads( $c, @_ );
2226 =head2 $c->prepare_write
2228 Prepares the output for writing.
2232 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2234 =head2 $c->request_class
2236 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2238 =head2 $c->response_class
2240 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2242 =head2 $c->read( [$maxlength] )
2244 Reads a chunk of data from the request body. This method is designed to
2245 be used in a while loop, reading C<$maxlength> bytes on every call.
2246 C<$maxlength> defaults to the size of the request if not specified.
2248 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2251 Warning: If you use read(), Catalyst will not process the body,
2252 so you will not be able to access POST parameters or file uploads via
2253 $c->request. You must handle all body parsing yourself.
2257 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2267 $app->engine_loader->needs_psgi_engine_compat_hack ?
2268 $app->engine->run($app, @_) :
2269 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2272 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2274 Sets an action in a given namespace.
2278 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2280 =head2 $c->setup_actions($component)
2282 Sets up actions for a component.
2286 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2288 =head2 $c->setup_config
2295 my %args = %{ $class->config || {} };
2297 my $container_class;
2299 if ( exists $args{container_class} ) {
2300 $container_class = delete $args{container_class};
2301 Class::MOP::load_class($container_class);
2304 $container_class = Class::MOP::load_first_existing_class("${class}::Container", 'Catalyst::IOC::Container');
2307 my $container = $container_class->new( %args, application_name => "$class", name => "$class" );
2308 $class->container($container);
2310 my $config = $container->resolve( service => 'config' );
2311 $class->config($config);
2312 $class->finalize_config; # back-compat
2315 =head2 $c->finalize_config
2319 sub finalize_config { }
2321 =head2 $c->setup_components
2323 This method is called internally to set up the application's components.
2325 It finds modules by calling the L<locate_components> method, expands them to
2326 package names with the $container->expand_component_module method, and then
2327 installs each component into the application.
2329 The C<setup_components> config option is passed to both of the above methods.
2333 sub setup_components { shift->container->setup_components }
2335 =head2 locate_components
2339 sub locate_components {
2342 $class->log->warn('The locate_components method has been deprecated.');
2343 $class->log->warn('Please read Catalyst::IOC::Container documentation to');
2344 $class->log->warn('update your application.');
2346 # XXX think about ditching this sort entirely
2347 return sort { length $a <=> length $b }
2348 @{ $class->container->resolve( service => 'locate_components' ) };
2351 =head2 $c->setup_dispatcher
2357 sub setup_dispatcher {
2358 my ( $class, $dispatcher ) = @_;
2361 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2364 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2365 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2368 unless ($dispatcher) {
2369 $dispatcher = $class->dispatcher_class;
2372 Class::MOP::load_class($dispatcher);
2374 # dispatcher instance
2375 $class->dispatcher( $dispatcher->new );
2378 =head2 $c->setup_engine
2385 my ($class, $requested_engine) = @_;
2387 if (!$class->engine_loader || $requested_engine) {
2388 $class->engine_loader(
2389 Catalyst::EngineLoader->new({
2390 application_name => $class,
2391 (defined $requested_engine
2392 ? (catalyst_engine_class => $requested_engine) : ()),
2397 $class->engine_loader->catalyst_engine_class;
2401 my ($class, $requested_engine) = @_;
2404 my $loader = $class->engine_loader;
2406 if (!$loader || $requested_engine) {
2407 $loader = Catalyst::EngineLoader->new({
2408 application_name => $class,
2409 (defined $requested_engine
2410 ? (requested_engine => $requested_engine) : ()),
2413 $class->engine_loader($loader);
2416 $loader->catalyst_engine_class;
2419 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2420 return if $class->loading_psgi_file;
2422 Class::MOP::load_class($engine);
2424 if ($ENV{MOD_PERL}) {
2425 my $apache = $class->engine_loader->auto;
2427 my $meta = find_meta($class);
2428 my $was_immutable = $meta->is_immutable;
2429 my %immutable_options = $meta->immutable_options;
2430 $meta->make_mutable if $was_immutable;
2432 $meta->add_method(handler => sub {
2434 my $psgi_app = $class->_finalized_psgi_app;
2435 $apache->call_app($r, $psgi_app);
2438 $meta->make_immutable(%immutable_options) if $was_immutable;
2441 $class->engine( $engine->new );
2446 sub _finalized_psgi_app {
2449 unless ($app->_psgi_app) {
2450 my $psgi_app = $app->_setup_psgi_app;
2451 $app->_psgi_app($psgi_app);
2454 return $app->_psgi_app;
2457 sub _setup_psgi_app {
2460 for my $home (Path::Class::Dir->new($app->config->{home})) {
2461 my $psgi_file = $home->file(
2462 Catalyst::Utils::appprefix($app) . '.psgi',
2465 next unless -e $psgi_file;
2467 # If $psgi_file calls ->setup_engine, it's doing so to load
2468 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2469 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2470 # anyway. So set a flag (ick) that tells setup_engine not to populate
2471 # $c->engine or do any other things we might regret.
2473 $app->loading_psgi_file(1);
2474 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2475 $app->loading_psgi_file(0);
2478 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2481 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2483 Its content has been ignored. Please consult the Catalyst::Upgrading
2484 documentation on how to upgrade from Catalyst::Engine::PSGI.
2488 return $app->apply_default_middlewares($app->psgi_app);
2491 =head2 $c->apply_default_middlewares
2493 Adds the following L<Plack> middlewares to your application, since they are
2494 useful and commonly needed:
2496 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2497 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2498 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2499 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2500 applied since this middleware is smart enough to conditionally apply itself).
2502 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2503 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2509 sub apply_default_middlewares {
2510 my ($app, $psgi_app) = @_;
2512 $psgi_app = Plack::Middleware::Conditional->wrap(
2514 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2517 return if $app->config->{ignore_frontend_proxy};
2518 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2519 || $app->config->{using_frontend_proxy};
2523 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2524 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2525 $psgi_app = Plack::Middleware::Conditional->wrap(
2527 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2530 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2531 return unless $1 < 4.23;
2536 # we're applying this unconditionally as the middleware itself already makes
2537 # sure it doesn't fuck things up if it's not running under one of the right
2539 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2546 Returns a PSGI application code reference for the catalyst application
2547 C<$c>. This is the bare application without any middlewares
2548 applied. C<${myapp}.psgi> is not taken into account.
2550 This is what you want to be using to retrieve the PSGI application code
2551 reference of your Catalyst application for use in F<.psgi> files.
2557 return $app->engine->build_psgi_app($app);
2560 =head2 $c->setup_home
2562 Sets up the home directory.
2567 my ( $class, $home ) = @_;
2569 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2573 $home ||= Catalyst::Utils::home($class);
2576 #I remember recently being scolded for assigning config values like this
2577 $class->config->{home} ||= $home;
2578 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2582 =head2 $c->setup_log
2584 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2585 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2588 This method also installs a C<debug> method that returns a true value into the
2589 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2590 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2592 Note that if the log has already been setup, by either a previous call to
2593 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2594 that this method won't actually set up the log object.
2599 my ( $class, $levels ) = @_;
2602 $levels =~ s/^\s+//;
2603 $levels =~ s/\s+$//;
2604 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2606 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2607 if ( defined $env_debug ) {
2608 $levels{debug} = 1 if $env_debug; # Ugly!
2609 delete($levels{debug}) unless $env_debug;
2612 unless ( $class->log ) {
2613 $class->log( Catalyst::Log->new(keys %levels) );
2616 if ( $levels{debug} ) {
2617 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2618 $class->log->debug('Debug messages enabled');
2622 =head2 $c->setup_plugins
2628 =head2 $c->setup_stats
2630 Sets up timing statistics class.
2635 my ( $class, $stats ) = @_;
2637 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2639 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2640 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2641 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2642 $class->log->debug('Statistics enabled');
2647 =head2 $c->registered_plugins
2649 Returns a sorted list of the plugins which have either been stated in the
2652 If passed a given plugin name, it will report a boolean value indicating
2653 whether or not that plugin is loaded. A fully qualified name is required if
2654 the plugin name does not begin with C<Catalyst::Plugin::>.
2656 if ($c->registered_plugins('Some::Plugin')) {
2664 sub registered_plugins {
2666 return sort keys %{ $proto->_plugins } unless @_;
2668 return 1 if exists $proto->_plugins->{$plugin};
2669 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2672 sub _register_plugin {
2673 my ( $proto, $plugin, $instant ) = @_;
2674 my $class = ref $proto || $proto;
2676 Class::MOP::load_class( $plugin );
2677 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2678 if $plugin->isa( 'Catalyst::Component' );
2679 $proto->_plugins->{$plugin} = 1;
2681 my $meta = Class::MOP::get_metaclass_by_name($class);
2682 $meta->superclasses($plugin, $meta->superclasses);
2688 my ( $class, $plugins ) = @_;
2690 $class->_plugins( {} ) unless $class->_plugins;
2691 $plugins = Data::OptList::mkopt($plugins || []);
2694 [ Catalyst::Utils::resolve_namespace(
2695 $class . '::Plugin',
2696 'Catalyst::Plugin', $_->[0]
2702 for my $plugin ( reverse @plugins ) {
2703 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2704 my $meta = find_meta($plugin->[0]);
2705 next if $meta && $meta->isa('Moose::Meta::Role');
2707 $class->_register_plugin($plugin->[0]);
2711 map { $_->[0]->name, $_->[1] }
2712 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2713 map { [find_meta($_->[0]), $_->[1]] }
2716 Moose::Util::apply_all_roles(
2724 Returns an arrayref of the internal execution stack (actions that are
2725 currently executing).
2729 Returns the current timing statistics object. By default Catalyst uses
2730 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2731 L<< stats_class|/"$c->stats_class" >>.
2733 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2734 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2735 profile explicitly, although MyApp.pm still won't profile nor output anything
2738 =head2 $c->stats_class
2740 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2742 =head2 $c->use_stats
2744 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2746 Note that this is a static method, not an accessor and should be overridden
2747 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2754 =head2 $c->write( $data )
2756 Writes $data to the output stream. When using this method directly, you
2757 will need to manually set the C<Content-Length> header to the length of
2758 your output data, if known.
2765 # Finalize headers if someone manually writes output
2766 $c->finalize_headers;
2768 return $c->engine->write( $c, @_ );
2773 Returns the Catalyst version number. Mostly useful for "powered by"
2774 messages in template systems.
2778 sub version { return $Catalyst::VERSION }
2780 =head1 CONFIGURATION
2782 There are a number of 'base' config variables which can be set:
2788 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2792 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2796 C<home> - The application home directory. In an uninstalled application,
2797 this is the top level application directory. In an installed application,
2798 this will be the directory containing C<< MyApp.pm >>.
2802 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2806 C<name> - The name of the application in debug messages and the debug and
2811 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2812 until it is accessed. This allows you to (for example) check authentication (and reject
2813 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
2817 C<root> - The root directory for templates. Usually this is just a
2818 subdirectory of the home directory, but you can set it to change the
2819 templates to a different directory.
2823 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2824 to be shown in hit debug tables in the test server.
2828 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
2829 variable should be used for determining the request path.
2831 Most web server environments pass the requested path to the application using environment variables,
2832 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
2833 exposed as C<< $c->request->base >>) and the request path below that base.
2835 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
2836 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
2840 =item use_request_uri_for_path => 0
2842 This is the default (and the) traditional method that Catalyst has used for determining the path information.
2843 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
2844 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
2845 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
2847 However this method has the major disadvantage that it is impossible to correctly decode some elements
2848 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
2849 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
2850 can't distinguish / vs %2F in paths (in addition to other encoded values).
2852 =item use_request_uri_for_path => 1
2854 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
2855 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
2856 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
2858 Given that this method of path resolution is provably more correct, it is recommended that you use
2859 this unless you have a specific need to deploy your application in a non-standard environment, and you are
2860 aware of the implications of not being able to handle encoded URI paths correctly.
2862 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
2863 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
2864 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
2865 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
2866 C<< $c->request->base >> will be incorrect.
2872 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2876 =head1 INTERNAL ACTIONS
2878 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2879 C<_ACTION>, and C<_END>. These are by default not shown in the private
2880 action table, but you can make them visible with a config parameter.
2882 MyApp->config(show_internal_actions => 1);
2884 =head1 ON-DEMAND PARSER
2886 The request body is usually parsed at the beginning of a request,
2887 but if you want to handle input yourself, you can enable on-demand
2888 parsing with a config parameter.
2890 MyApp->config(parse_on_demand => 1);
2892 =head1 PROXY SUPPORT
2894 Many production servers operate using the common double-server approach,
2895 with a lightweight frontend web server passing requests to a larger
2896 backend server. An application running on the backend server must deal
2897 with two problems: the remote user always appears to be C<127.0.0.1> and
2898 the server's hostname will appear to be C<localhost> regardless of the
2899 virtual host that the user connected through.
2901 Catalyst will automatically detect this situation when you are running
2902 the frontend and backend servers on the same machine. The following
2903 changes are made to the request.
2905 $c->req->address is set to the user's real IP address, as read from
2906 the HTTP X-Forwarded-For header.
2908 The host value for $c->req->base and $c->req->uri is set to the real
2909 host, as read from the HTTP X-Forwarded-Host header.
2911 Additionally, you may be running your backend application on an insecure
2912 connection (port 80) while your frontend proxy is running under SSL. If there
2913 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2914 tell Catalyst what port the frontend listens on. This will allow all URIs to
2915 be created properly.
2917 In the case of passing in:
2919 X-Forwarded-Port: 443
2921 All calls to C<uri_for> will result in an https link, as is expected.
2923 Obviously, your web server must support these headers for this to work.
2925 In a more complex server farm environment where you may have your
2926 frontend proxy server(s) on different machines, you will need to set a
2927 configuration option to tell Catalyst to read the proxied data from the
2930 MyApp->config(using_frontend_proxy => 1);
2932 If you do not wish to use the proxy support at all, you may set:
2934 MyApp->config(ignore_frontend_proxy => 0);
2936 =head2 Note about psgi files
2938 Note that if you supply your own .psgi file, calling
2939 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
2941 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
2942 in your psgi, for example:
2945 enable "Plack::Middleware::ReverseProxy";
2949 This will unconditionally add the ReverseProxy support, or you need to call
2950 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
2951 apply the support depending upon your config).
2953 See L<Catalyst::PSGI> for more information.
2955 =head1 THREAD SAFETY
2957 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2958 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2959 believe the Catalyst core to be thread-safe.
2961 If you plan to operate in a threaded environment, remember that all other
2962 modules you are using must also be thread-safe. Some modules, most notably
2963 L<DBD::SQLite>, are not thread-safe.
2969 Join #catalyst on irc.perl.org.
2973 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2974 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2978 http://catalyst.perl.org
2982 http://dev.catalyst.perl.org
2986 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2988 =head2 L<Catalyst::Manual> - The Catalyst Manual
2990 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2992 =head2 L<Catalyst::Engine> - Core engine
2994 =head2 L<Catalyst::Log> - Log class.
2996 =head2 L<Catalyst::Request> - Request object
2998 =head2 L<Catalyst::Response> - Response object
3000 =head2 L<Catalyst::Test> - The test suite.
3004 =head1 PROJECT FOUNDER
3006 sri: Sebastian Riedel <sri@cpan.org>
3012 acme: Leon Brocard <leon@astray.com>
3014 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3018 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3024 andyg: Andy Grundman <andy@hybridized.org>
3026 audreyt: Audrey Tang
3028 bricas: Brian Cassidy <bricas@cpan.org>
3030 Caelum: Rafael Kitover <rkitover@io.com>
3032 chansen: Christian Hansen
3034 chicks: Christopher Hicks
3036 Chisel Wright C<pause@herlpacker.co.uk>
3038 Danijel Milicevic C<me@danijel.de>
3040 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3042 David Naughton, C<naughton@umn.edu>
3046 dhoss: Devin Austin <dhoss@cpan.org>
3048 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3052 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3054 esskar: Sascha Kiefer
3056 fireartist: Carl Franks <cfranks@cpan.org>
3058 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3060 gabb: Danijel Milicevic
3064 Gavin Henry C<ghenry@perl.me.uk>
3068 groditi: Guillermo Roditi <groditi@gmail.com>
3070 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3072 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3074 jcamacho: Juan Camacho
3076 jester: Jesse Sheidlower C<jester@panix.com>
3078 jhannah: Jay Hannah <jay@jays.net>
3084 jon: Jon Schutz <jjschutz@cpan.org>
3086 Jonathan Rockway C<< <jrockway@cpan.org> >>
3088 Kieren Diment C<kd@totaldatasolution.com>
3090 konobi: Scott McWhirter <konobi@cpan.org>
3092 marcus: Marcus Ramberg <mramberg@cpan.org>
3094 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3096 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3100 naughton: David Naughton
3102 ningu: David Kamholz <dkamholz@cpan.org>
3104 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3106 numa: Dan Sully <daniel@cpan.org>
3112 omega: Andreas Marienborg
3114 Oleg Kostyuk <cub.uanic@gmail.com>
3116 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3118 rafl: Florian Ragwitz <rafl@debian.org>
3120 random: Roland Lammel <lammel@cpan.org>
3122 Robert Sedlacek C<< <rs@474.at> >>
3124 SpiceMan: Marcel Montes
3128 szbalint: Balint Szilakszi <szbalint@cpan.org>
3130 t0m: Tomas Doran <bobtfish@bobtfish.net>
3134 Viljo Marrandi C<vilts@yahoo.com>
3136 Will Hawes C<info@whawes.co.uk>
3138 willert: Sebastian Willert <willert@cpan.org>
3140 wreis: Wallace Reis <wallace@reis.org.br>
3142 Yuval Kogman, C<nothingmuch@woobling.org>
3144 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3146 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3152 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3156 This library is free software. You can redistribute it and/or modify it under
3157 the same terms as Perl itself.
3163 __PACKAGE__->meta->make_immutable;