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/;
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.90004';
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 : Global { # 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 : Path('/bar/of/soap') { ... }
181 # called for all actions, from the top-most controller downwards
183 my ( $self, $c ) = @_;
184 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
185 $c->res->redirect( '/login' ); # require login
186 return 0; # abort request and go immediately to end()
188 return 1; # success; carry on to next action
191 # called after all actions are finished
193 my ( $self, $c ) = @_;
194 if ( scalar @{ $c->error } ) { ... } # handle errors
195 return if $c->res->body; # already have a response
196 $c->forward( 'MyApp::View::TT' ); # render template
199 ### in MyApp/Controller/Foo.pm
200 # called for /foo/bar
201 sub bar : Local { ... }
203 # called for /blargle
204 sub blargle : Global { ... }
206 # an index action matches /foo, but not /foo/1, etc.
207 sub index : Private { ... }
209 ### in MyApp/Controller/Foo/Bar.pm
210 # called for /foo/bar/baz
211 sub baz : Local { ... }
213 # first Root auto is called, then Foo auto, then this
214 sub auto : Private { ... }
216 # powerful regular expression paths are also possible
217 sub details : Regex('^product/(\w+)/details$') {
218 my ( $self, $c ) = @_;
219 # extract the (\w+) from the URI
220 my $product = $c->req->captures->[0];
223 See L<Catalyst::Manual::Intro> for additional information.
227 Catalyst is a modern framework for making web applications without the
228 pain usually associated with this process. This document is a reference
229 to the main Catalyst application. If you are a new user, we suggest you
230 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
232 See L<Catalyst::Manual> for more documentation.
234 Catalyst plugins can be loaded by naming them as arguments to the "use
235 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
236 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
239 use Catalyst qw/My::Module/;
241 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
242 fully qualify the name by using a unary plus:
246 +Fully::Qualified::Plugin::Name
249 Special flags like C<-Debug> and C<-Engine> can also be specified as
250 arguments when Catalyst is loaded:
252 use Catalyst qw/-Debug My::Module/;
254 The position of plugins and flags in the chain is important, because
255 they are loaded in the order in which they appear.
257 The following flags are supported:
261 Enables debug output. You can also force this setting from the system
262 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
263 settings override the application, with <MYAPP>_DEBUG having the highest
266 This sets the log level to 'debug' and enables full debug output on the
267 error screen. If you only want the latter, see L<< $c->debug >>.
271 Forces Catalyst to use a specific engine. Omit the
272 C<Catalyst::Engine::> prefix of the engine name, i.e.:
274 use Catalyst qw/-Engine=CGI/;
278 Forces Catalyst to use a specific home directory, e.g.:
280 use Catalyst qw[-Home=/usr/mst];
282 This can also be done in the shell environment by setting either the
283 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
284 is replaced with the uppercased name of your application, any "::" in
285 the name will be replaced with underscores, e.g. MyApp::Web should use
286 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
288 If none of these are set, Catalyst will attempt to automatically detect the
289 home directory. If you are working in a development envirnoment, Catalyst
290 will try and find the directory containing either Makefile.PL, Build.PL or
291 dist.ini. If the application has been installed into the system (i.e.
292 you have done C<make install>), then Catalyst will use the path to your
293 application module, without the .pm extension (ie, /foo/MyApp if your
294 application was installed at /foo/MyApp.pm)
298 use Catalyst '-Log=warn,fatal,error';
300 Specifies a comma-delimited list of log levels.
304 Enables statistics collection and reporting.
306 use Catalyst qw/-Stats=1/;
308 You can also force this setting from the system environment with CATALYST_STATS
309 or <MYAPP>_STATS. The environment settings override the application, with
310 <MYAPP>_STATS having the highest priority.
312 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
316 =head2 INFORMATION ABOUT THE CURRENT REQUEST
320 Returns a L<Catalyst::Action> object for the current action, which
321 stringifies to the action name. See L<Catalyst::Action>.
325 Returns the namespace of the current action, i.e., the URI prefix
326 corresponding to the controller of the current action. For example:
328 # in Controller::Foo::Bar
329 $c->namespace; # returns 'foo/bar';
335 Returns the current L<Catalyst::Request> object, giving access to
336 information about the current client request (including parameters,
337 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
339 =head2 REQUEST FLOW HANDLING
341 =head2 $c->forward( $action [, \@arguments ] )
343 =head2 $c->forward( $class, $method, [, \@arguments ] )
345 Forwards processing to another action, by its private name. If you give a
346 class name but no method, C<process()> is called. You may also optionally
347 pass arguments in an arrayref. The action will receive the arguments in
348 C<@_> and C<< $c->req->args >>. Upon returning from the function,
349 C<< $c->req->args >> will be restored to the previous values.
351 Any data C<return>ed from the action forwarded to, will be returned by the
354 my $foodata = $c->forward('/foo');
355 $c->forward('index');
356 $c->forward(qw/Model::DBIC::Foo do_stuff/);
357 $c->forward('View::TT');
359 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
360 an C<< eval { } >> around the call (actually
361 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
362 all 'dies' within the called action. If you want C<die> to propagate you
363 need to do something like:
366 die join "\n", @{ $c->error } if @{ $c->error };
368 Or make sure to always return true values from your actions and write
371 $c->forward('foo') || return;
373 Another note is that C<< $c->forward >> always returns a scalar because it
374 actually returns $c->state which operates in a scalar context.
375 Thus, something like:
379 in an action that is forwarded to is going to return a scalar,
380 i.e. how many items are in that array, which is probably not what you want.
381 If you need to return an array then return a reference to it,
384 $c->stash->{array} = \@array;
386 and access it from the stash.
388 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.
392 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
394 =head2 $c->detach( $action [, \@arguments ] )
396 =head2 $c->detach( $class, $method, [, \@arguments ] )
400 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
401 doesn't return to the previous action when processing is finished.
403 When called with no arguments it escapes the processing chain entirely.
407 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
409 =head2 $c->visit( $action [, \@captures, \@arguments ] )
411 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
413 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
414 but does a full dispatch, instead of just calling the new C<$action> /
415 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
416 you go to are called, just like a new request.
418 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
419 This means, for example, that C<< $c->action >> methods such as
420 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
421 L<reverse|Catalyst::Action/reverse> return information for the visited action
422 when they are invoked within the visited action. This is different from the
423 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
424 continues to use the $c->action object from the caller action even when
425 invoked from the callee.
427 C<< $c->stash >> is kept unchanged.
429 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
430 allows you to "wrap" another action, just as it would have been called by
431 dispatching from a URL, while the analogous
432 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
433 transfer control to another action as if it had been reached directly from a URL.
437 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
439 =head2 $c->go( $action [, \@captures, \@arguments ] )
441 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
443 The relationship between C<go> and
444 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
445 the relationship between
446 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
447 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
448 C<< $c->go >> will perform a full dispatch on the specified action or method,
449 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
450 C<go> escapes the processing of the current request chain on completion, and
451 does not return to its caller.
453 @arguments are arguments to the final destination of $action. @captures are
454 arguments to the intermediate steps, if any, on the way to the final sub of
459 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
465 Returns the current L<Catalyst::Response> object, see there for details.
469 Returns a hashref to the stash, which may be used to store data and pass
470 it between components during a request. You can also set hash keys by
471 passing arguments. The stash is automatically sent to the view. The
472 stash is cleared at the end of a request; it cannot be used for
473 persistent storage (for this you must use a session; see
474 L<Catalyst::Plugin::Session> for a complete system integrated with
477 $c->stash->{foo} = $bar;
478 $c->stash( { moose => 'majestic', qux => 0 } );
479 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
481 # stash is automatically passed to the view for use in a template
482 $c->forward( 'MyApp::View::TT' );
486 around stash => sub {
489 my $stash = $orig->($c);
491 my $new_stash = @_ > 1 ? {@_} : $_[0];
492 croak('stash takes a hash or hashref') unless ref $new_stash;
493 foreach my $key ( keys %$new_stash ) {
494 $stash->{$key} = $new_stash->{$key};
504 =head2 $c->error($error, ...)
506 =head2 $c->error($arrayref)
508 Returns an arrayref containing error messages. If Catalyst encounters an
509 error while processing a request, it stores the error in $c->error. This
510 method should only be used to store fatal error messages.
512 my @error = @{ $c->error };
516 $c->error('Something bad happened');
523 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
524 croak @$error unless ref $c;
525 push @{ $c->{error} }, @$error;
527 elsif ( defined $_[0] ) { $c->{error} = undef }
528 return $c->{error} || [];
534 Contains the return value of the last executed action.
535 Note that << $c->state >> operates in a scalar context which means that all
536 values it returns are scalar.
538 =head2 $c->clear_errors
540 Clear errors. You probably don't want to clear the errors unless you are
541 implementing a custom error screen.
543 This is equivalent to running
554 =head2 COMPONENT ACCESSORS
556 =head2 $c->controller($name)
558 Gets a L<Catalyst::Controller> instance by name.
560 $c->controller('Foo')->do_stuff;
562 If the name is omitted, will return the controller for the dispatched
565 If you want to search for controllers, pass in a regexp as the argument.
567 # find all controllers that start with Foo
568 my @foo_controllers = $c->controller(qr{^Foo});
573 sub controller { shift->_lookup_mvc('controller', @_) }
575 =head2 $c->model($name)
577 Gets a L<Catalyst::Model> instance by name.
579 $c->model('Foo')->do_stuff;
581 Any extra arguments are directly passed to ACCEPT_CONTEXT.
583 If the name is omitted, it will look for
584 - a model object in $c->stash->{current_model_instance}, then
585 - a model name in $c->stash->{current_model}, then
586 - a config setting 'default_model', or
587 - check if there is only one model, and return it if that's the case.
589 If you want to search for models, pass in a regexp as the argument.
591 # find all models that start with Foo
592 my @foo_models = $c->model(qr{^Foo});
596 sub model { shift->_lookup_mvc('model', @_) }
598 =head2 $c->view($name)
600 Gets a L<Catalyst::View> instance by name.
602 $c->view('Foo')->do_stuff;
604 Any extra arguments are directly passed to ACCEPT_CONTEXT.
606 If the name is omitted, it will look for
607 - a view object in $c->stash->{current_view_instance}, then
608 - a view name in $c->stash->{current_view}, then
609 - a config setting 'default_view', or
610 - check if there is only one view, and return it if that's the case.
612 If you want to search for views, pass in a regexp as the argument.
614 # find all views that start with Foo
615 my @foo_views = $c->view(qr{^Foo});
619 sub view { shift->_lookup_mvc('view', @_) }
622 my ( $c, $type, $name, @args ) = @_;
624 if (ref $c && !$name) {
625 my $current_instance = $c->stash->{"current_${type}_instance"};
626 return $current_instance
627 if $current_instance && $type ne 'controller';
629 $name = $type eq 'controller'
630 ? Catalyst::Utils::class2classshortsuffix($c->action->class)
631 : $c->stash->{"current_${type}"}
635 return $c->container->get_component_from_sub_container($type, $name, $c, @args);
638 =head2 $c->controllers
640 Returns the available names which can be passed to $c->controller
646 return $c->container->get_sub_container('controller')->get_service_list;
651 Returns the available names which can be passed to $c->model
657 return $c->container->get_sub_container('model')->get_service_list;
663 Returns the available names which can be passed to $c->view
669 return $c->container->get_sub_container('view')->get_service_list;
672 =head2 $c->comp($name)
674 =head2 $c->component($name)
676 Gets a component object by name. This method is not recommended,
677 unless you want to get a specific component by full
678 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
679 should be used instead.
681 If C<$name> is a regexp, a list of components matched against the full
682 component name will be returned.
687 my ( $c, $component, @args ) = @_;
689 unless ($component) {
690 $c->log->warn('Calling $c->component with no args is deprecated and ');
691 $c->log->warn('will be removed in a future release.');
692 $c->log->warn('Use $c->component_list instead.');
693 return $c->component_list;
696 my @result = $c->container->find_component( $component, $c, @args );
698 # list context for regexp searches
699 return @result if ref $component;
701 # only one component (if it's found) for string searches
702 return shift @result if @result;
704 if (ref $c eq $component) {
705 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
706 $c->log->warn('deprecated, and will be removed in a future release.');
710 $c->log->warn("Looking for '$component', but nothing was found.");
712 # I would expect to return an empty list here, but that breaks back-compat
713 $c->log->warn('Component not found, returning the list of existing');
714 $c->log->warn('components. This behavior is deprecated and will be');
715 $c->log->warn('removed in a future release. Use $c->component_list');
716 $c->log->warn('instead.');
718 return $c->component_list;
721 =head2 $c->component_list
723 Returns the sorted list of the component names of the application.
727 sub component_list { sort keys %{ shift->components } }
729 =head2 CLASS DATA AND HELPER CLASSES
733 Returns or takes a hashref containing the application's configuration.
735 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
737 You can also use a C<YAML>, C<XML> or L<Config::General> config file
738 like C<myapp.conf> in your applications home directory. See
739 L<Catalyst::Plugin::ConfigLoader>.
741 =head3 Cascading configuration
743 The config method is present on all Catalyst components, and configuration
744 will be merged when an application is started. Configuration loaded with
745 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
746 followed by configuration in your top level C<MyApp> class. These two
747 configurations are merged, and then configuration data whose hash key matches a
748 component name is merged with configuration for that component.
750 The configuration for a component is then passed to the C<new> method when a
751 component is constructed.
755 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
756 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
758 will mean that C<MyApp::Model::Foo> receives the following data when
761 MyApp::Model::Foo->new({
767 It's common practice to use a Moose attribute
768 on the receiving component to access the config value.
770 package MyApp::Model::Foo;
774 # this attr will receive 'baz' at construction time
780 You can then get the value 'baz' by calling $c->model('Foo')->bar
781 (or $self->bar inside code in the model).
783 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
784 as a way of reading config within your code, as this B<will not> give you the
785 correctly merged config back. You B<MUST> take the config values supplied to
786 the constructor and use those instead.
790 around config => sub {
794 croak('Setting config after setup has been run is not allowed.')
795 if ( @_ and $c->setup_finished );
802 Returns the logging object instance. Unless it is already set, Catalyst
803 sets this up with a L<Catalyst::Log> object. To use your own log class,
804 set the logger with the C<< __PACKAGE__->log >> method prior to calling
805 C<< __PACKAGE__->setup >>.
807 __PACKAGE__->log( MyLogger->new );
812 $c->log->info( 'Now logging with my own logger!' );
814 Your log class should implement the methods described in
820 Returns 1 if debug mode is enabled, 0 otherwise.
822 You can enable debug mode in several ways:
826 =item By calling myapp_server.pl with the -d flag
828 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
830 =item The -Debug option in your MyApp.pm
832 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
836 The first three also set the log level to 'debug'.
838 Calling C<< $c->debug(1) >> has no effect.
844 =head2 $c->dispatcher
846 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
850 Returns the engine instance. See L<Catalyst::Engine>.
853 =head2 UTILITY METHODS
855 =head2 $c->path_to(@path)
857 Merges C<@path> with C<< $c->config->{home} >> and returns a
858 L<Path::Class::Dir> object. Note you can usually use this object as
859 a filename, but sometimes you will have to explicitly stringify it
860 yourself by calling the C<< ->stringify >> method.
864 $c->path_to( 'db', 'sqlite.db' );
869 my ( $c, @path ) = @_;
870 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
871 if ( -d $path ) { return $path }
872 else { return Path::Class::File->new( $c->config->{home}, @path ) }
875 =head2 $c->plugin( $name, $class, @args )
877 Helper method for plugins. It creates a class data accessor/mutator and
878 loads and instantiates the given class.
880 MyApp->plugin( 'prototype', 'HTML::Prototype' );
882 $c->prototype->define_javascript_functions;
884 B<Note:> This method of adding plugins is deprecated. The ability
885 to add plugins like this B<will be removed> in a Catalyst 5.81.
886 Please do not use this functionality in new code.
891 my ( $class, $name, $plugin, @args ) = @_;
893 # See block comment in t/aggregate/unit_core_plugin.t
894 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
896 $class->_register_plugin( $plugin, 1 );
898 eval { $plugin->import };
899 $class->mk_classdata($name);
901 eval { $obj = $plugin->new(@args) };
904 Catalyst::Exception->throw( message =>
905 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
909 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
915 Initializes the dispatcher and engine, loads any plugins, and loads the
916 model, view, and controller components. You may also specify an array
917 of plugins to load here, if you choose to not load them in the C<use
921 MyApp->setup( qw/-Debug/ );
926 my ( $class, @arguments ) = @_;
927 croak('Running setup more than once')
928 if ( $class->setup_finished );
930 unless ( $class->isa('Catalyst') ) {
932 Catalyst::Exception->throw(
933 message => qq/'$class' does not inherit from Catalyst/ );
936 if ( $class->arguments ) {
937 @arguments = ( @arguments, @{ $class->arguments } );
943 foreach (@arguments) {
947 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
949 elsif (/^-(\w+)=?(.*)$/) {
950 $flags->{ lc $1 } = $2;
953 push @{ $flags->{plugins} }, $_;
957 $class->setup_config();
958 $class->setup_home( delete $flags->{home} );
960 $class->setup_log( delete $flags->{log} );
961 $class->setup_plugins( delete $flags->{plugins} );
962 $class->setup_dispatcher( delete $flags->{dispatcher} );
963 if (my $engine = delete $flags->{engine}) {
964 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
966 $class->setup_engine();
967 $class->setup_stats( delete $flags->{stats} );
969 for my $flag ( sort keys %{$flags} ) {
971 if ( my $code = $class->can( 'setup_' . $flag ) ) {
972 &$code( $class, delete $flags->{$flag} );
975 $class->log->warn(qq/Unknown flag "$flag"/);
979 eval { require Catalyst::Devel; };
980 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
981 $class->log->warn(<<"EOF");
982 You are running an old script!
984 Please update by running (this will overwrite existing files):
985 catalyst.pl -force -scripts $class
987 or (this will not overwrite existing files):
988 catalyst.pl -scripts $class
993 if ( $class->debug ) {
994 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
997 my $column_width = Catalyst::Utils::term_width() - 6;
998 my $t = Text::SimpleTable->new($column_width);
999 $t->row($_) for @plugins;
1000 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1003 my $dispatcher = $class->dispatcher;
1004 my $engine = $class->engine;
1005 my $home = $class->config->{home};
1007 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1008 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1012 ? $class->log->debug(qq/Found home "$home"/)
1013 : $class->log->debug(qq/Home "$home" doesn't exist/)
1014 : $class->log->debug(q/Couldn't find home/);
1017 # Call plugins setup, this is stupid and evil.
1018 # Also screws C3 badly on 5.10, hack to avoid.
1020 no warnings qw/redefine/;
1021 local *setup = sub { };
1022 $class->setup unless $Catalyst::__AM_RESTARTING;
1025 $class->setup_components;
1029 my $comps = $class->container->get_all_components($class)
1031 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1032 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1033 $t->row( $_ => ref($comps->{$_}) ? 'instance' : 'class' ) for keys %$comps;
1035 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1038 $class->setup_actions;
1040 if ( $class->debug ) {
1041 my $name = $class->config->{name} || 'Application';
1042 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1045 # Make sure that the application class becomes immutable at this point,
1046 B::Hooks::EndOfScope::on_scope_end {
1048 my $meta = Class::MOP::get_metaclass_by_name($class);
1051 && ! { $meta->immutable_options }->{replace_constructor}
1053 $class->isa('Class::Accessor::Fast')
1054 || $class->isa('Class::Accessor')
1057 warn "You made your application class ($class) immutable, "
1058 . "but did not inline the\nconstructor. "
1059 . "This will break catalyst, as your app \@ISA "
1060 . "Class::Accessor(::Fast)?\nPlease pass "
1061 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1063 $meta->make_immutable(
1064 replace_constructor => 1,
1065 ) unless $meta->is_immutable;
1068 if ($class->config->{case_sensitive}) {
1069 $class->log->warn($class . "->config->{case_sensitive} is set.");
1070 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1073 $class->setup_finalize;
1074 # Should be the last thing we do so that user things hooking
1075 # setup_finalize can log..
1076 $class->log->_flush() if $class->log->can('_flush');
1077 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1080 =head2 $app->setup_finalize
1082 A hook to attach modifiers to. This method does not do anything except set the
1083 C<setup_finished> accessor.
1085 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1089 after setup_finalize => sub {
1097 sub setup_finalize {
1099 $class->setup_finished(1);
1102 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1104 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1106 Constructs an absolute L<URI> object based on the application root, the
1107 provided path, and the additional arguments and query parameters provided.
1108 When used as a string, provides a textual URI. If you need more flexibility
1109 than this (i.e. the option to provide relative URIs etc.) see
1110 L<Catalyst::Plugin::SmartURI>.
1112 If no arguments are provided, the URI for the current action is returned.
1113 To return the current action and also provide @args, use
1114 C<< $c->uri_for( $c->action, @args ) >>.
1116 If the first argument is a string, it is taken as a public URI path relative
1117 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1118 relative to the application root (if it does). It is then merged with
1119 C<< $c->request->base >>; any C<@args> are appended as additional path
1120 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1122 If the first argument is a L<Catalyst::Action> it represents an action which
1123 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1124 optional C<\@captures> argument (an arrayref) allows passing the captured
1125 variables that are needed to fill in the paths of Chained and Regex actions;
1126 once the path is resolved, C<uri_for> continues as though a path was
1127 provided, appending any arguments or parameters and creating an absolute
1130 The captures for the current request can be found in
1131 C<< $c->request->captures >>, and actions can be resolved using
1132 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1133 path, use C<< $c->uri_for_action >> instead.
1135 # Equivalent to $c->req->uri
1136 $c->uri_for($c->action, $c->req->captures,
1137 @{ $c->req->args }, $c->req->params);
1139 # For the Foo action in the Bar controller
1140 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1142 # Path to a static resource
1143 $c->uri_for('/static/images/logo.png');
1148 my ( $c, $path, @args ) = @_;
1150 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1151 $path = $path->path_prefix;
1156 undef($path) if (defined $path && $path eq '');
1159 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1161 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1162 foreach my $arg (@args) {
1163 utf8::encode($arg) if utf8::is_utf8($arg);
1164 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1167 if ( blessed($path) ) { # action object
1168 s|/|%2F|g for @args;
1169 my $captures = [ map { s|/|%2F|g; $_; }
1170 ( scalar @args && ref $args[0] eq 'ARRAY'
1174 foreach my $capture (@$captures) {
1175 utf8::encode($capture) if utf8::is_utf8($capture);
1176 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1180 $path = $c->dispatcher->uri_for_action($action, $captures);
1181 if (not defined $path) {
1182 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1186 $path = '/' if $path eq '';
1189 unshift(@args, $path);
1191 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1192 my $namespace = $c->namespace;
1193 if (defined $path) { # cheesy hack to handle path '../foo'
1194 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1196 unshift(@args, $namespace || '');
1199 # join args with '/', or a blank string
1200 my $args = join('/', grep { defined($_) } @args);
1201 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1203 my $base = $c->req->base;
1204 my $class = ref($base);
1205 $base =~ s{(?<!/)$}{/};
1209 if (my @keys = keys %$params) {
1210 # somewhat lifted from URI::_query's query_form
1211 $query = '?'.join('&', map {
1212 my $val = $params->{$_};
1213 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1216 $val = '' unless defined $val;
1219 utf8::encode( $param ) if utf8::is_utf8($param);
1220 # using the URI::Escape pattern here so utf8 chars survive
1221 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1223 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1227 my $res = bless(\"${base}${args}${query}", $class);
1231 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1233 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1239 A private path to the Catalyst action you want to create a URI for.
1241 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1242 >> and passing the resulting C<$action> and the remaining arguments to C<<
1245 You can also pass in a Catalyst::Action object, in which case it is passed to
1248 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.
1250 For example, if the action looks like:
1252 package MyApp::Controller::Users;
1254 sub lst : Path('the-list') {}
1258 $c->uri_for_action('/users/lst')
1260 and it will create the URI /users/the-list.
1266 sub uri_for_action {
1267 my ( $c, $path, @args ) = @_;
1268 my $action = blessed($path)
1270 : $c->dispatcher->get_action_by_path($path);
1271 unless (defined $action) {
1272 croak "Can't find action for path '$path'";
1274 return $c->uri_for( $action, @args );
1277 =head2 $c->welcome_message
1279 Returns the Catalyst welcome HTML page.
1283 sub welcome_message {
1285 my $name = $c->config->{name};
1286 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1287 my $prefix = Catalyst::Utils::appprefix( ref $c );
1288 $c->response->content_type('text/html; charset=utf-8');
1290 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1291 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1292 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1294 <meta http-equiv="Content-Language" content="en" />
1295 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1296 <title>$name on Catalyst $VERSION</title>
1297 <style type="text/css">
1300 background-color: #eee;
1307 margin-bottom: 10px;
1309 background-color: #ccc;
1310 border: 1px solid #aaa;
1315 font-family: verdana, tahoma, sans-serif;
1318 font-family: verdana, tahoma, sans-serif;
1321 text-decoration: none;
1323 border-bottom: 1px dotted #bbb;
1325 :link:hover, :visited:hover {
1338 background-color: #fff;
1339 border: 1px solid #aaa;
1343 font-weight: normal;
1365 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1370 <img src="$logo" alt="Catalyst Logo" />
1372 <p>Welcome to the world of Catalyst.
1373 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1374 framework will make web development something you had
1375 never expected it to be: Fun, rewarding, and quick.</p>
1376 <h2>What to do now?</h2>
1377 <p>That really depends on what <b>you</b> want to do.
1378 We do, however, provide you with a few starting points.</p>
1379 <p>If you want to jump right into web development with Catalyst
1380 you might want to start with a tutorial.</p>
1381 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1383 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1385 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1386 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1388 <h2>What to do next?</h2>
1389 <p>Next it's time to write an actual application. Use the
1390 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1391 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1392 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1393 they can save you a lot of work.</p>
1394 <pre><code>script/${prefix}_create.pl --help</code></pre>
1395 <p>Also, be sure to check out the vast and growing
1396 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1397 you are likely to find what you need there.
1401 <p>Catalyst has a very active community. Here are the main places to
1402 get in touch with us.</p>
1405 <a href="http://dev.catalyst.perl.org">Wiki</a>
1408 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1411 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1414 <h2>In conclusion</h2>
1415 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1416 as we enjoyed making it. Please contact us if you have ideas
1417 for improvement or other feedback.</p>
1425 =head1 INTERNAL METHODS
1427 These methods are not meant to be used by end users.
1429 =head2 $c->components
1431 Returns a hash of components.
1436 my ( $class, $comps ) = @_;
1438 # people create components calling this sub directly, before setup
1439 $class->setup_config unless $class->container;
1441 my $container = $class->container;
1444 $container->add_component( $_ ) for keys %$comps;
1447 return $container->get_all_components($class);
1450 =head2 $c->context_class
1452 Returns or sets the context class.
1456 Returns a hashref containing coderefs and execution counts (needed for
1457 deep recursion detection).
1461 Returns the number of actions on the current internal execution stack.
1465 Dispatches a request to actions.
1469 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1471 =head2 $c->dispatcher_class
1473 Returns or sets the dispatcher class.
1475 =head2 $c->dump_these
1477 Returns a list of 2-element array references (name, structure) pairs
1478 that will be dumped on the error page in debug mode.
1484 [ Request => $c->req ],
1485 [ Response => $c->res ],
1486 [ Stash => $c->stash ],
1487 [ Config => $c->config ];
1490 =head2 $c->engine_class
1492 Returns or sets the engine class.
1494 =head2 $c->execute( $class, $coderef )
1496 Execute a coderef in given class and catch exceptions. Errors are available
1502 my ( $c, $class, $code ) = @_;
1503 $class = $c->component($class) || $class;
1506 if ( $c->depth >= $RECURSION ) {
1507 my $action = $code->reverse();
1508 $action = "/$action" unless $action =~ /->/;
1509 my $error = qq/Deep recursion detected calling "${action}"/;
1510 $c->log->error($error);
1516 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1518 push( @{ $c->stack }, $code );
1520 no warnings 'recursion';
1521 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1522 # I have no idea how, ergo $ret (which appears to fix the issue)
1523 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1525 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1527 my $last = pop( @{ $c->stack } );
1529 if ( my $error = $@ ) {
1530 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1531 $error->rethrow if $c->depth > 1;
1533 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1534 $error->rethrow if $c->depth > 0;
1537 unless ( ref $error ) {
1538 no warnings 'uninitialized';
1540 my $class = $last->class;
1541 my $name = $last->name;
1542 $error = qq/Caught exception in $class->$name "$error"/;
1551 sub _stats_start_execute {
1552 my ( $c, $code ) = @_;
1553 my $appclass = ref($c) || $c;
1554 return if ( ( $code->name =~ /^_.*/ )
1555 && ( !$appclass->config->{show_internal_actions} ) );
1557 my $action_name = $code->reverse();
1558 $c->counter->{$action_name}++;
1560 my $action = $action_name;
1561 $action = "/$action" unless $action =~ /->/;
1563 # determine if the call was the result of a forward
1564 # this is done by walking up the call stack and looking for a calling
1565 # sub of Catalyst::forward before the eval
1567 for my $index ( 2 .. 11 ) {
1569 if ( ( caller($index) )[0] eq 'Catalyst'
1570 && ( caller($index) )[3] eq '(eval)' );
1572 if ( ( caller($index) )[3] =~ /forward$/ ) {
1573 $callsub = ( caller($index) )[3];
1574 $action = "-> $action";
1579 my $uid = $action_name . $c->counter->{$action_name};
1581 # is this a root-level call or a forwarded call?
1582 if ( $callsub =~ /forward$/ ) {
1583 my $parent = $c->stack->[-1];
1585 # forward, locate the caller
1586 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1589 parent => "$parent" . $c->counter->{"$parent"},
1595 # forward with no caller may come from a plugin
1614 sub _stats_finish_execute {
1615 my ( $c, $info ) = @_;
1616 $c->stats->profile( end => $info );
1621 Finalizes the request.
1628 for my $error ( @{ $c->error } ) {
1629 $c->log->error($error);
1632 # Allow engine to handle finalize flow (for POE)
1633 my $engine = $c->engine;
1634 if ( my $code = $engine->can('finalize') ) {
1639 $c->finalize_uploads;
1642 if ( $#{ $c->error } >= 0 ) {
1646 $c->finalize_headers;
1649 if ( $c->request->method eq 'HEAD' ) {
1650 $c->response->body('');
1658 if ($c->use_stats) {
1659 my $elapsed = sprintf '%f', $c->stats->elapsed;
1660 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1662 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1665 return $c->response->status;
1668 =head2 $c->finalize_body
1674 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1676 =head2 $c->finalize_cookies
1682 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1684 =head2 $c->finalize_error
1690 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1692 =head2 $c->finalize_headers
1698 sub finalize_headers {
1701 my $response = $c->response; #accessor calls can add up?
1703 # Check if we already finalized headers
1704 return if $response->finalized_headers;
1707 if ( my $location = $response->redirect ) {
1708 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1709 $response->header( Location => $location );
1711 if ( !$response->has_body ) {
1712 # Add a default body if none is already present
1713 $response->body(<<"EOF");
1714 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1715 <html xmlns="http://www.w3.org/1999/xhtml">
1717 <title>Moved</title>
1720 <p>This item has moved <a href="$location">here</a>.</p>
1724 $response->content_type('text/html; charset=utf-8');
1729 if ( defined $response->body && length $response->body && !$response->content_length ) {
1731 # get the length from a filehandle
1732 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1734 my $size = -s $response->body;
1736 $response->content_length( $size );
1739 $c->log->warn('Serving filehandle without a content-length');
1743 # everything should be bytes at this point, but just in case
1744 $response->content_length( length( $response->body ) );
1749 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1750 $response->headers->remove_header("Content-Length");
1751 $response->body('');
1754 $c->finalize_cookies;
1756 $c->engine->finalize_headers( $c, @_ );
1759 $response->finalized_headers(1);
1762 =head2 $c->finalize_output
1764 An alias for finalize_body.
1766 =head2 $c->finalize_read
1768 Finalizes the input after reading is complete.
1772 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1774 =head2 $c->finalize_uploads
1776 Finalizes uploads. Cleans up any temporary files.
1780 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1782 =head2 $c->get_action( $action, $namespace )
1784 Gets an action in a given namespace.
1788 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1790 =head2 $c->get_actions( $action, $namespace )
1792 Gets all actions of a given name in a namespace and all parent
1797 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1799 =head2 $app->handle_request( @arguments )
1801 Called to handle each HTTP request.
1805 sub handle_request {
1806 my ( $class, @arguments ) = @_;
1808 # Always expect worst case!
1811 if ($class->debug) {
1812 my $secs = time - $START || 1;
1813 my $av = sprintf '%.3f', $COUNT / $secs;
1814 my $time = localtime time;
1815 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1818 my $c = $class->prepare(@arguments);
1820 $status = $c->finalize;
1823 chomp(my $error = $_);
1824 $class->log->error(qq/Caught exception in engine "$error"/);
1829 if(my $coderef = $class->log->can('_flush')){
1830 $class->log->$coderef();
1835 =head2 $class->prepare( @arguments )
1837 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1843 my ( $class, @arguments ) = @_;
1846 # After the app/ctxt split, this should become an attribute based on something passed
1847 # into the application.
1848 $class->context_class( ref $class || $class ) unless $class->context_class;
1850 my $c = $class->context_class->new({});
1852 # For on-demand data
1853 $c->request->_context($c);
1854 $c->response->_context($c);
1856 #surely this is not the most efficient way to do things...
1857 $c->stats($class->stats_class->new)->enable($c->use_stats);
1858 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1859 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1863 # Allow engine to direct the prepare flow (for POE)
1864 if ( my $prepare = $c->engine->can('prepare') ) {
1865 $c->engine->$prepare( $c, @arguments );
1868 $c->prepare_request(@arguments);
1869 $c->prepare_connection;
1870 $c->prepare_query_parameters;
1871 $c->prepare_headers;
1872 $c->prepare_cookies;
1875 # Prepare the body for reading, either by prepare_body
1876 # or the user, if they are using $c->read
1879 # Parse the body unless the user wants it on-demand
1880 unless ( ref($c)->config->{parse_on_demand} ) {
1885 # VERY ugly and probably shouldn't rely on ->finalize actually working
1887 # failed prepare is always due to an invalid request, right?
1888 $c->response->status(400);
1889 $c->response->content_type('text/plain');
1890 $c->response->body('Bad Request');
1895 my $method = $c->req->method || '';
1896 my $path = $c->req->path;
1897 $path = '/' unless length $path;
1898 my $address = $c->req->address || '';
1907 =head2 $c->prepare_action
1909 Prepares action. See L<Catalyst::Dispatcher>.
1913 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1915 =head2 $c->prepare_body
1917 Prepares message body.
1924 return if $c->request->_has_body;
1926 # Initialize on-demand data
1927 $c->engine->prepare_body( $c, @_ );
1928 $c->prepare_parameters;
1929 $c->prepare_uploads;
1932 =head2 $c->prepare_body_chunk( $chunk )
1934 Prepares a chunk of data before sending it to L<HTTP::Body>.
1936 See L<Catalyst::Engine>.
1940 sub prepare_body_chunk {
1942 $c->engine->prepare_body_chunk( $c, @_ );
1945 =head2 $c->prepare_body_parameters
1947 Prepares body parameters.
1951 sub prepare_body_parameters {
1953 $c->engine->prepare_body_parameters( $c, @_ );
1956 =head2 $c->prepare_connection
1958 Prepares connection.
1962 sub prepare_connection {
1964 $c->engine->prepare_connection( $c, @_ );
1967 =head2 $c->prepare_cookies
1973 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1975 =head2 $c->prepare_headers
1981 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1983 =head2 $c->prepare_parameters
1985 Prepares parameters.
1989 sub prepare_parameters {
1991 $c->prepare_body_parameters;
1992 $c->engine->prepare_parameters( $c, @_ );
1995 =head2 $c->prepare_path
1997 Prepares path and base.
2001 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2003 =head2 $c->prepare_query_parameters
2005 Prepares query parameters.
2009 sub prepare_query_parameters {
2012 $c->engine->prepare_query_parameters( $c, @_ );
2015 =head2 $c->log_request
2017 Writes information about the request to the debug logs. This includes:
2021 =item * Request method, path, and remote IP address
2023 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2025 =item * Request parameters
2027 =item * File uploads
2036 return unless $c->debug;
2038 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2039 my $request = $dump->[1];
2041 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2043 $path = '/' unless length $path;
2045 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2047 $c->log_request_headers($request->headers);
2049 if ( my $keywords = $request->query_keywords ) {
2050 $c->log->debug("Query keywords are: $keywords");
2053 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2055 $c->log_request_uploads($request);
2058 =head2 $c->log_response
2060 Writes information about the response to the debug logs by calling
2061 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2068 return unless $c->debug;
2070 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2071 my $response = $dump->[1];
2073 $c->log_response_status_line($response);
2074 $c->log_response_headers($response->headers);
2077 =head2 $c->log_response_status_line($response)
2079 Writes one line of information about the response to the debug logs. This includes:
2083 =item * Response status code
2085 =item * Content-Type header (if present)
2087 =item * Content-Length header (if present)
2093 sub log_response_status_line {
2094 my ($c, $response) = @_;
2098 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2099 $response->status || 'unknown',
2100 $response->headers->header('Content-Type') || 'unknown',
2101 $response->headers->header('Content-Length') || 'unknown'
2106 =head2 $c->log_response_headers($headers);
2108 Hook method which can be wrapped by plugins to log the responseheaders.
2109 No-op in the default implementation.
2113 sub log_response_headers {}
2115 =head2 $c->log_request_parameters( query => {}, body => {} )
2117 Logs request parameters to debug logs
2121 sub log_request_parameters {
2123 my %all_params = @_;
2125 return unless $c->debug;
2127 my $column_width = Catalyst::Utils::term_width() - 44;
2128 foreach my $type (qw(query body)) {
2129 my $params = $all_params{$type};
2130 next if ! keys %$params;
2131 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2132 for my $key ( sort keys %$params ) {
2133 my $param = $params->{$key};
2134 my $value = defined($param) ? $param : '';
2135 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2137 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2141 =head2 $c->log_request_uploads
2143 Logs file uploads included in the request to the debug logs.
2144 The parameter name, filename, file type, and file size are all included in
2149 sub log_request_uploads {
2151 my $request = shift;
2152 return unless $c->debug;
2153 my $uploads = $request->uploads;
2154 if ( keys %$uploads ) {
2155 my $t = Text::SimpleTable->new(
2156 [ 12, 'Parameter' ],
2161 for my $key ( sort keys %$uploads ) {
2162 my $upload = $uploads->{$key};
2163 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2164 $t->row( $key, $u->filename, $u->type, $u->size );
2167 $c->log->debug( "File Uploads are:\n" . $t->draw );
2171 =head2 $c->log_request_headers($headers);
2173 Hook method which can be wrapped by plugins to log the request headers.
2174 No-op in the default implementation.
2178 sub log_request_headers {}
2180 =head2 $c->log_headers($type => $headers)
2182 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2189 my $headers = shift; # an HTTP::Headers instance
2191 return unless $c->debug;
2193 my $column_width = Catalyst::Utils::term_width() - 28;
2194 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2197 my ( $name, $value ) = @_;
2198 $t->row( $name, $value );
2201 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2205 =head2 $c->prepare_read
2207 Prepares the input for reading.
2211 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2213 =head2 $c->prepare_request
2215 Prepares the engine request.
2219 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2221 =head2 $c->prepare_uploads
2227 sub prepare_uploads {
2230 $c->engine->prepare_uploads( $c, @_ );
2233 =head2 $c->prepare_write
2235 Prepares the output for writing.
2239 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2241 =head2 $c->request_class
2243 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2245 =head2 $c->response_class
2247 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2249 =head2 $c->read( [$maxlength] )
2251 Reads a chunk of data from the request body. This method is designed to
2252 be used in a while loop, reading C<$maxlength> bytes on every call.
2253 C<$maxlength> defaults to the size of the request if not specified.
2255 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2258 Warning: If you use read(), Catalyst will not process the body,
2259 so you will not be able to access POST parameters or file uploads via
2260 $c->request. You must handle all body parsing yourself.
2264 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2274 $app->engine_loader->needs_psgi_engine_compat_hack ?
2275 $app->engine->run($app, @_) :
2276 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2279 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2281 Sets an action in a given namespace.
2285 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2287 =head2 $c->setup_actions($component)
2289 Sets up actions for a component.
2293 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2295 =head2 $c->setup_config
2302 my %args = %{ $class->config || {} };
2304 my $container_class;
2306 if ( exists $args{container_class} ) {
2307 $container_class = delete $args{container_class};
2308 Class::MOP::load_class($container_class);
2311 $container_class = Class::MOP::load_first_existing_class("${class}::Container", 'Catalyst::IOC::Container');
2314 my $container = $container_class->new( %args, application_name => "$class", name => "$class" );
2315 $class->container($container);
2317 my $config = $container->resolve( service => 'config' );
2318 $class->config($config);
2319 $class->finalize_config; # back-compat
2322 =head2 $c->finalize_config
2326 sub finalize_config { }
2328 =head2 $c->setup_components
2330 This method is called internally to set up the application's components.
2332 It finds modules by calling the L<locate_components> method, expands them to
2333 package names with the $container->expand_component_module method, and then
2334 installs each component into the application.
2336 The C<setup_components> config option is passed to both of the above methods.
2340 sub setup_components { shift->container->setup_components }
2342 =head2 locate_components
2346 sub locate_components {
2349 $class->log->warn('The locate_components method has been deprecated.');
2350 $class->log->warn('Please read Catalyst::IOC::Container documentation to');
2351 $class->log->warn('update your application.');
2353 # XXX think about ditching this sort entirely
2354 return sort { length $a <=> length $b }
2355 @{ $class->container->resolve( service => 'locate_components' ) };
2358 =head2 $c->setup_dispatcher
2364 sub setup_dispatcher {
2365 my ( $class, $dispatcher ) = @_;
2368 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2371 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2372 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2375 unless ($dispatcher) {
2376 $dispatcher = $class->dispatcher_class;
2379 Class::MOP::load_class($dispatcher);
2381 # dispatcher instance
2382 $class->dispatcher( $dispatcher->new );
2385 =head2 $c->setup_engine
2392 my ($class, $requested_engine) = @_;
2394 if (!$class->engine_loader || $requested_engine) {
2395 $class->engine_loader(
2396 Catalyst::EngineLoader->new({
2397 application_name => $class,
2398 (defined $requested_engine
2399 ? (catalyst_engine_class => $requested_engine) : ()),
2404 $class->engine_loader->catalyst_engine_class;
2408 my ($class, $requested_engine) = @_;
2411 my $loader = $class->engine_loader;
2413 if (!$loader || $requested_engine) {
2414 $loader = Catalyst::EngineLoader->new({
2415 application_name => $class,
2416 (defined $requested_engine
2417 ? (requested_engine => $requested_engine) : ()),
2420 $class->engine_loader($loader);
2423 $loader->catalyst_engine_class;
2426 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2427 return if $class->loading_psgi_file;
2429 Class::MOP::load_class($engine);
2431 if ($ENV{MOD_PERL}) {
2432 my $apache = $class->engine_loader->auto;
2434 my $meta = find_meta($class);
2435 my $was_immutable = $meta->is_immutable;
2436 my %immutable_options = $meta->immutable_options;
2437 $meta->make_mutable if $was_immutable;
2439 $meta->add_method(handler => sub {
2441 my $psgi_app = $class->psgi_app;
2442 $apache->call_app($r, $psgi_app);
2445 $meta->make_immutable(%immutable_options) if $was_immutable;
2448 $class->engine( $engine->new );
2453 sub _finalized_psgi_app {
2456 unless ($app->_psgi_app) {
2457 my $psgi_app = $app->_setup_psgi_app;
2458 $app->_psgi_app($psgi_app);
2461 return $app->_psgi_app;
2464 sub _setup_psgi_app {
2467 for my $home (Path::Class::Dir->new($app->config->{home})) {
2468 my $psgi_file = $home->file(
2469 Catalyst::Utils::appprefix($app) . '.psgi',
2472 next unless -e $psgi_file;
2474 # If $psgi_file calls ->setup_engine, it's doing so to load
2475 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2476 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2477 # anyway. So set a flag (ick) that tells setup_engine not to populate
2478 # $c->engine or do any other things we might regret.
2480 $app->loading_psgi_file(1);
2481 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2482 $app->loading_psgi_file(0);
2485 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2488 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2490 Its content has been ignored. Please consult the Catalyst::Upgrading
2491 documentation on how to upgrade from Catalyst::Engine::PSGI.
2495 return $app->apply_default_middlewares($app->psgi_app);
2498 =head2 $c->apply_default_middlewares
2500 Adds the following L<Plack> middlewares to your application, since they are
2501 useful and commonly needed:
2503 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2504 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2505 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2506 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2507 applied since this middleware is smart enough to conditionally apply itself).
2509 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2510 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2516 sub apply_default_middlewares {
2517 my ($app, $psgi_app) = @_;
2519 $psgi_app = Plack::Middleware::Conditional->wrap(
2521 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2524 return if $app->config->{ignore_frontend_proxy};
2525 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2526 || $app->config->{using_frontend_proxy};
2530 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2531 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2532 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
2534 # we're applying this unconditionally as the middleware itself already makes
2535 # sure it doesn't fuck things up if it's not running under one of the right
2537 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2544 Returns a PSGI application code reference for the catalyst application
2545 C<$c>. This is the bare application without any middlewares
2546 applied. C<${myapp}.psgi> is not taken into account.
2548 This is what you want to be using to retrieve the PSGI application code
2549 reference of your Catalyst application for use in F<.psgi> files.
2555 return $app->engine->build_psgi_app($app);
2558 =head2 $c->setup_home
2560 Sets up the home directory.
2565 my ( $class, $home ) = @_;
2567 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2571 $home ||= Catalyst::Utils::home($class);
2574 #I remember recently being scolded for assigning config values like this
2575 $class->config->{home} ||= $home;
2576 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2580 =head2 $c->setup_log
2582 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2583 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2586 This method also installs a C<debug> method that returns a true value into the
2587 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2588 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2590 Note that if the log has already been setup, by either a previous call to
2591 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2592 that this method won't actually set up the log object.
2597 my ( $class, $levels ) = @_;
2600 $levels =~ s/^\s+//;
2601 $levels =~ s/\s+$//;
2602 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2604 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2605 if ( defined $env_debug ) {
2606 $levels{debug} = 1 if $env_debug; # Ugly!
2607 delete($levels{debug}) unless $env_debug;
2610 unless ( $class->log ) {
2611 $class->log( Catalyst::Log->new(keys %levels) );
2614 if ( $levels{debug} ) {
2615 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2616 $class->log->debug('Debug messages enabled');
2620 =head2 $c->setup_plugins
2626 =head2 $c->setup_stats
2628 Sets up timing statistics class.
2633 my ( $class, $stats ) = @_;
2635 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2637 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2638 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2639 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2640 $class->log->debug('Statistics enabled');
2645 =head2 $c->registered_plugins
2647 Returns a sorted list of the plugins which have either been stated in the
2648 import list or which have been added via C<< MyApp->plugin(@args); >>.
2650 If passed a given plugin name, it will report a boolean value indicating
2651 whether or not that plugin is loaded. A fully qualified name is required if
2652 the plugin name does not begin with C<Catalyst::Plugin::>.
2654 if ($c->registered_plugins('Some::Plugin')) {
2662 sub registered_plugins {
2664 return sort keys %{ $proto->_plugins } unless @_;
2666 return 1 if exists $proto->_plugins->{$plugin};
2667 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2670 sub _register_plugin {
2671 my ( $proto, $plugin, $instant ) = @_;
2672 my $class = ref $proto || $proto;
2674 Class::MOP::load_class( $plugin );
2675 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2676 if $plugin->isa( 'Catalyst::Component' );
2677 $proto->_plugins->{$plugin} = 1;
2679 my $meta = Class::MOP::get_metaclass_by_name($class);
2680 $meta->superclasses($plugin, $meta->superclasses);
2686 my ( $class, $plugins ) = @_;
2688 $class->_plugins( {} ) unless $class->_plugins;
2689 $plugins = Data::OptList::mkopt($plugins || []);
2692 [ Catalyst::Utils::resolve_namespace(
2693 $class . '::Plugin',
2694 'Catalyst::Plugin', $_->[0]
2700 for my $plugin ( reverse @plugins ) {
2701 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2702 my $meta = find_meta($plugin->[0]);
2703 next if $meta && $meta->isa('Moose::Meta::Role');
2705 $class->_register_plugin($plugin->[0]);
2709 map { $_->[0]->name, $_->[1] }
2710 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2711 map { [find_meta($_->[0]), $_->[1]] }
2714 Moose::Util::apply_all_roles(
2722 Returns an arrayref of the internal execution stack (actions that are
2723 currently executing).
2727 Returns the current timing statistics object. By default Catalyst uses
2728 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2729 L<< stats_class|/"$c->stats_class" >>.
2731 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2732 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2733 profile explicitly, although MyApp.pm still won't profile nor output anything
2736 =head2 $c->stats_class
2738 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2740 =head2 $c->use_stats
2742 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2744 Note that this is a static method, not an accessor and should be overridden
2745 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2752 =head2 $c->write( $data )
2754 Writes $data to the output stream. When using this method directly, you
2755 will need to manually set the C<Content-Length> header to the length of
2756 your output data, if known.
2763 # Finalize headers if someone manually writes output
2764 $c->finalize_headers;
2766 return $c->engine->write( $c, @_ );
2771 Returns the Catalyst version number. Mostly useful for "powered by"
2772 messages in template systems.
2776 sub version { return $Catalyst::VERSION }
2778 =head1 CONFIGURATION
2780 There are a number of 'base' config variables which can be set:
2786 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2790 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2794 C<home> - The application home directory. In an uninstalled application,
2795 this is the top level application directory. In an installed application,
2796 this will be the directory containing C<< MyApp.pm >>.
2800 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2804 C<name> - The name of the application in debug messages and the debug and
2809 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2810 until it is accessed. This allows you to (for example) check authentication (and reject
2811 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2815 C<root> - The root directory for templates. Usually this is just a
2816 subdirectory of the home directory, but you can set it to change the
2817 templates to a different directory.
2821 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2822 to be shown in hit debug tables in the test server.
2826 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2827 variable should be used for determining the request path.
2829 Most web server environments pass the requested path to the application using environment variables,
2830 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
2831 exposed as C<< $c->request->base >>) and the request path below that base.
2833 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
2834 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
2838 =item use_request_uri_for_path => 0
2840 This is the default (and the) traditional method that Catalyst has used for determining the path information.
2841 The path is synthesised from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
2842 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
2843 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
2845 However this method has the major disadvantage that it is impossible to correctly decode some elements
2846 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
2847 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
2848 can't distinguish / vs %2F in paths (in addition to other encoded values).
2850 =item use_request_uri_for_path => 1
2852 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
2853 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
2854 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
2856 Given that this method of path resolution is provably more correct, it is recommended that you use
2857 this unless you have a specific need to deploy your application in a non-standard environment, and you are
2858 aware of the implications of not being able to handle encoded URI paths correctly.
2860 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
2861 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
2862 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
2863 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
2864 C<< $c->request->base >> will be incorrect.
2870 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2874 =head1 INTERNAL ACTIONS
2876 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2877 C<_ACTION>, and C<_END>. These are by default not shown in the private
2878 action table, but you can make them visible with a config parameter.
2880 MyApp->config(show_internal_actions => 1);
2882 =head1 ON-DEMAND PARSER
2884 The request body is usually parsed at the beginning of a request,
2885 but if you want to handle input yourself, you can enable on-demand
2886 parsing with a config parameter.
2888 MyApp->config(parse_on_demand => 1);
2890 =head1 PROXY SUPPORT
2892 Many production servers operate using the common double-server approach,
2893 with a lightweight frontend web server passing requests to a larger
2894 backend server. An application running on the backend server must deal
2895 with two problems: the remote user always appears to be C<127.0.0.1> and
2896 the server's hostname will appear to be C<localhost> regardless of the
2897 virtual host that the user connected through.
2899 Catalyst will automatically detect this situation when you are running
2900 the frontend and backend servers on the same machine. The following
2901 changes are made to the request.
2903 $c->req->address is set to the user's real IP address, as read from
2904 the HTTP X-Forwarded-For header.
2906 The host value for $c->req->base and $c->req->uri is set to the real
2907 host, as read from the HTTP X-Forwarded-Host header.
2909 Additionally, you may be running your backend application on an insecure
2910 connection (port 80) while your frontend proxy is running under SSL. If there
2911 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2912 tell Catalyst what port the frontend listens on. This will allow all URIs to
2913 be created properly.
2915 In the case of passing in:
2917 X-Forwarded-Port: 443
2919 All calls to C<uri_for> will result in an https link, as is expected.
2921 Obviously, your web server must support these headers for this to work.
2923 In a more complex server farm environment where you may have your
2924 frontend proxy server(s) on different machines, you will need to set a
2925 configuration option to tell Catalyst to read the proxied data from the
2928 MyApp->config(using_frontend_proxy => 1);
2930 If you do not wish to use the proxy support at all, you may set:
2932 MyApp->config(ignore_frontend_proxy => 1);
2934 =head1 THREAD SAFETY
2936 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2937 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2938 believe the Catalyst core to be thread-safe.
2940 If you plan to operate in a threaded environment, remember that all other
2941 modules you are using must also be thread-safe. Some modules, most notably
2942 L<DBD::SQLite>, are not thread-safe.
2948 Join #catalyst on irc.perl.org.
2952 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2953 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2957 http://catalyst.perl.org
2961 http://dev.catalyst.perl.org
2965 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2967 =head2 L<Catalyst::Manual> - The Catalyst Manual
2969 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2971 =head2 L<Catalyst::Engine> - Core engine
2973 =head2 L<Catalyst::Log> - Log class.
2975 =head2 L<Catalyst::Request> - Request object
2977 =head2 L<Catalyst::Response> - Response object
2979 =head2 L<Catalyst::Test> - The test suite.
2981 =head1 PROJECT FOUNDER
2983 sri: Sebastian Riedel <sri@cpan.org>
2989 acme: Leon Brocard <leon@astray.com>
2991 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2995 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3001 andyg: Andy Grundman <andy@hybridized.org>
3003 audreyt: Audrey Tang
3005 bricas: Brian Cassidy <bricas@cpan.org>
3007 Caelum: Rafael Kitover <rkitover@io.com>
3009 chansen: Christian Hansen
3011 chicks: Christopher Hicks
3013 Chisel Wright C<pause@herlpacker.co.uk>
3015 Danijel Milicevic C<me@danijel.de>
3017 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3019 David Naughton, C<naughton@umn.edu>
3023 dhoss: Devin Austin <dhoss@cpan.org>
3025 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3029 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3031 esskar: Sascha Kiefer
3033 fireartist: Carl Franks <cfranks@cpan.org>
3035 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3037 gabb: Danijel Milicevic
3041 Gavin Henry C<ghenry@perl.me.uk>
3045 groditi: Guillermo Roditi <groditi@gmail.com>
3047 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3049 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3051 jcamacho: Juan Camacho
3053 jester: Jesse Sheidlower C<jester@panix.com>
3055 jhannah: Jay Hannah <jay@jays.net>
3061 jon: Jon Schutz <jjschutz@cpan.org>
3063 Jonathan Rockway C<< <jrockway@cpan.org> >>
3065 Kieren Diment C<kd@totaldatasolution.com>
3067 konobi: Scott McWhirter <konobi@cpan.org>
3069 marcus: Marcus Ramberg <mramberg@cpan.org>
3071 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3073 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3077 naughton: David Naughton
3079 ningu: David Kamholz <dkamholz@cpan.org>
3081 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3083 numa: Dan Sully <daniel@cpan.org>
3089 omega: Andreas Marienborg
3091 Oleg Kostyuk <cub.uanic@gmail.com>
3093 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3095 rafl: Florian Ragwitz <rafl@debian.org>
3097 random: Roland Lammel <lammel@cpan.org>
3099 Robert Sedlacek C<< <rs@474.at> >>
3101 SpiceMan: Marcel Montes
3105 szbalint: Balint Szilakszi <szbalint@cpan.org>
3107 t0m: Tomas Doran <bobtfish@bobtfish.net>
3111 Viljo Marrandi C<vilts@yahoo.com>
3113 Will Hawes C<info@whawes.co.uk>
3115 willert: Sebastian Willert <willert@cpan.org>
3117 wreis: Wallace Reis <wallace@reis.org.br>
3119 Yuval Kogman, C<nothingmuch@woobling.org>
3121 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3123 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3127 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3131 This library is free software. You can redistribute it and/or modify it under
3132 the same terms as Perl itself.
3138 __PACKAGE__->meta->make_immutable;