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;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
33 use Carp qw/croak carp shortmess/;
35 BEGIN { require 5.008004; }
37 has stack => (is => 'ro', default => sub { [] });
38 has stash => (is => 'rw', default => sub { {} });
39 has state => (is => 'rw', default => 0);
40 has stats => (is => 'rw');
41 has action => (is => 'rw');
42 has counter => (is => 'rw', default => sub { {} });
43 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
44 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
45 has namespace => (is => 'rw');
47 sub depth { scalar @{ shift->stack || [] }; }
48 sub comp { shift->component(@_) }
51 my $self = shift; return $self->request(@_);
54 my $self = shift; return $self->response(@_);
57 # For backwards compatibility
58 sub finalize_output { shift->finalize_body(@_) };
63 our $RECURSION = 1000;
64 our $DETACH = Catalyst::Exception::Detach->new;
65 our $GO = Catalyst::Exception::Go->new;
67 #I imagine that very few of these really need to be class variables. if any.
68 #maybe we should just make them attributes with a default?
69 __PACKAGE__->mk_classdata($_)
70 for qw/container arguments dispatcher engine log dispatcher_class
71 engine_class context_class request_class response_class stats_class
74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
75 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
76 __PACKAGE__->request_class('Catalyst::Request');
77 __PACKAGE__->response_class('Catalyst::Response');
78 __PACKAGE__->stats_class('Catalyst::Stats');
80 # Remember to update this in Catalyst::Runtime as well!
82 our $VERSION = '5.80032';
85 my ( $class, @arguments ) = @_;
87 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
89 return unless $class eq 'Catalyst';
91 my $caller = caller();
92 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
96 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
97 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
98 $meta->superclasses(@superclasses); # XXX - Remove!
101 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
102 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
104 unless( $meta->has_method('meta') ){
105 if ($Moose::VERSION >= 1.15) {
106 $meta->_add_meta_method('meta');
109 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
113 $caller->arguments( [@arguments] );
117 sub MODIFY_CODE_ATTRIBUTES {
118 Catalyst::Exception->throw(
119 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
120 "That has been deprecated and removed. You should create a " .
121 "controller class called Root.pm, and move relevant code to that class."
126 sub _application { $_[0] }
130 Catalyst - The Elegant MVC Web Application Framework
134 See the L<Catalyst::Manual> distribution for comprehensive
135 documentation and tutorials.
137 # Install Catalyst::Devel for helpers and other development tools
138 # use the helper to create a new application
141 # add models, views, controllers
142 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
143 script/myapp_create.pl view MyTemplate TT
144 script/myapp_create.pl controller Search
146 # built in testserver -- use -r to restart automatically on changes
147 # --help to see all available options
148 script/myapp_server.pl
150 # command line testing interface
151 script/myapp_test.pl /yada
154 use Catalyst qw/-Debug/; # include plugins here as well
156 ### In lib/MyApp/Controller/Root.pm (autocreated)
157 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
158 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
159 $c->stash->{template} = 'foo.tt'; # set the template
160 # lookup something from db -- stash vars are passed to TT
162 $c->model('Database::Foo')->search( { country => $args[0] } );
163 if ( $c->req->params->{bar} ) { # access GET or POST parameters
164 $c->forward( 'bar' ); # process another action
165 # do something else after forward returns
169 # The foo.tt TT template can use the stash data from the database
170 [% WHILE (item = data.next) %]
174 # called for /bar/of/soap, /bar/of/soap/10, etc.
175 sub bar : Path('/bar/of/soap') { ... }
177 # called for all actions, from the top-most controller downwards
179 my ( $self, $c ) = @_;
180 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
181 $c->res->redirect( '/login' ); # require login
182 return 0; # abort request and go immediately to end()
184 return 1; # success; carry on to next action
187 # called after all actions are finished
189 my ( $self, $c ) = @_;
190 if ( scalar @{ $c->error } ) { ... } # handle errors
191 return if $c->res->body; # already have a response
192 $c->forward( 'MyApp::View::TT' ); # render template
195 ### in MyApp/Controller/Foo.pm
196 # called for /foo/bar
197 sub bar : Local { ... }
199 # called for /blargle
200 sub blargle : Global { ... }
202 # an index action matches /foo, but not /foo/1, etc.
203 sub index : Private { ... }
205 ### in MyApp/Controller/Foo/Bar.pm
206 # called for /foo/bar/baz
207 sub baz : Local { ... }
209 # first Root auto is called, then Foo auto, then this
210 sub auto : Private { ... }
212 # powerful regular expression paths are also possible
213 sub details : Regex('^product/(\w+)/details$') {
214 my ( $self, $c ) = @_;
215 # extract the (\w+) from the URI
216 my $product = $c->req->captures->[0];
219 See L<Catalyst::Manual::Intro> for additional information.
223 Catalyst is a modern framework for making web applications without the
224 pain usually associated with this process. This document is a reference
225 to the main Catalyst application. If you are a new user, we suggest you
226 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
228 See L<Catalyst::Manual> for more documentation.
230 Catalyst plugins can be loaded by naming them as arguments to the "use
231 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
232 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
235 use Catalyst qw/My::Module/;
237 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
238 fully qualify the name by using a unary plus:
242 +Fully::Qualified::Plugin::Name
245 Special flags like C<-Debug> and C<-Engine> can also be specified as
246 arguments when Catalyst is loaded:
248 use Catalyst qw/-Debug My::Module/;
250 The position of plugins and flags in the chain is important, because
251 they are loaded in the order in which they appear.
253 The following flags are supported:
257 Enables debug output. You can also force this setting from the system
258 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
259 settings override the application, with <MYAPP>_DEBUG having the highest
262 This sets the log level to 'debug' and enables full debug output on the
263 error screen. If you only want the latter, see L<< $c->debug >>.
267 Forces Catalyst to use a specific engine. Omit the
268 C<Catalyst::Engine::> prefix of the engine name, i.e.:
270 use Catalyst qw/-Engine=CGI/;
274 Forces Catalyst to use a specific home directory, e.g.:
276 use Catalyst qw[-Home=/usr/mst];
278 This can also be done in the shell environment by setting either the
279 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
280 is replaced with the uppercased name of your application, any "::" in
281 the name will be replaced with underscores, e.g. MyApp::Web should use
282 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
284 If none of these are set, Catalyst will attempt to automatically detect the
285 home directory. If you are working in a development envirnoment, Catalyst
286 will try and find the directory containing either Makefile.PL, Build.PL or
287 dist.ini. If the application has been installed into the system (i.e.
288 you have done C<make install>), then Catalyst will use the path to your
289 application module, without the .pm extension (ie, /foo/MyApp if your
290 application was installed at /foo/MyApp.pm)
294 use Catalyst '-Log=warn,fatal,error';
296 Specifies a comma-delimited list of log levels.
300 Enables statistics collection and reporting.
302 use Catalyst qw/-Stats=1/;
304 You can also force this setting from the system environment with CATALYST_STATS
305 or <MYAPP>_STATS. The environment settings override the application, with
306 <MYAPP>_STATS having the highest priority.
308 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
312 =head2 INFORMATION ABOUT THE CURRENT REQUEST
316 Returns a L<Catalyst::Action> object for the current action, which
317 stringifies to the action name. See L<Catalyst::Action>.
321 Returns the namespace of the current action, i.e., the URI prefix
322 corresponding to the controller of the current action. For example:
324 # in Controller::Foo::Bar
325 $c->namespace; # returns 'foo/bar';
331 Returns the current L<Catalyst::Request> object, giving access to
332 information about the current client request (including parameters,
333 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
335 =head2 REQUEST FLOW HANDLING
337 =head2 $c->forward( $action [, \@arguments ] )
339 =head2 $c->forward( $class, $method, [, \@arguments ] )
341 Forwards processing to another action, by its private name. If you give a
342 class name but no method, C<process()> is called. You may also optionally
343 pass arguments in an arrayref. The action will receive the arguments in
344 C<@_> and C<< $c->req->args >>. Upon returning from the function,
345 C<< $c->req->args >> will be restored to the previous values.
347 Any data C<return>ed from the action forwarded to, will be returned by the
350 my $foodata = $c->forward('/foo');
351 $c->forward('index');
352 $c->forward(qw/Model::DBIC::Foo do_stuff/);
353 $c->forward('View::TT');
355 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
356 an C<< eval { } >> around the call (actually
357 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
358 all 'dies' within the called action. If you want C<die> to propagate you
359 need to do something like:
362 die join "\n", @{ $c->error } if @{ $c->error };
364 Or make sure to always return true values from your actions and write
367 $c->forward('foo') || return;
369 Another note is that C<< $c->forward >> always returns a scalar because it
370 actually returns $c->state which operates in a scalar context.
371 Thus, something like:
375 in an action that is forwarded to is going to return a scalar,
376 i.e. how many items are in that array, which is probably not what you want.
377 If you need to return an array then return a reference to it,
380 $c->stash->{array} = \@array;
382 and access it from the stash.
384 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.
388 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
390 =head2 $c->detach( $action [, \@arguments ] )
392 =head2 $c->detach( $class, $method, [, \@arguments ] )
396 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
397 doesn't return to the previous action when processing is finished.
399 When called with no arguments it escapes the processing chain entirely.
403 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
405 =head2 $c->visit( $action [, \@captures, \@arguments ] )
407 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
409 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
410 but does a full dispatch, instead of just calling the new C<$action> /
411 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
412 you go to are called, just like a new request.
414 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
415 This means, for example, that C<< $c->action >> methods such as
416 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
417 L<reverse|Catalyst::Action/reverse> return information for the visited action
418 when they are invoked within the visited action. This is different from the
419 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
420 continues to use the $c->action object from the caller action even when
421 invoked from the callee.
423 C<< $c->stash >> is kept unchanged.
425 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
426 allows you to "wrap" another action, just as it would have been called by
427 dispatching from a URL, while the analogous
428 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
429 transfer control to another action as if it had been reached directly from a URL.
433 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
435 =head2 $c->go( $action [, \@captures, \@arguments ] )
437 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
439 The relationship between C<go> and
440 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
441 the relationship between
442 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
443 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
444 C<< $c->go >> will perform a full dispatch on the specified action or method,
445 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
446 C<go> escapes the processing of the current request chain on completion, and
447 does not return to its caller.
449 @arguments are arguments to the final destination of $action. @captures are
450 arguments to the intermediate steps, if any, on the way to the final sub of
455 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
461 Returns the current L<Catalyst::Response> object, see there for details.
465 Returns a hashref to the stash, which may be used to store data and pass
466 it between components during a request. You can also set hash keys by
467 passing arguments. The stash is automatically sent to the view. The
468 stash is cleared at the end of a request; it cannot be used for
469 persistent storage (for this you must use a session; see
470 L<Catalyst::Plugin::Session> for a complete system integrated with
473 $c->stash->{foo} = $bar;
474 $c->stash( { moose => 'majestic', qux => 0 } );
475 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
477 # stash is automatically passed to the view for use in a template
478 $c->forward( 'MyApp::View::TT' );
482 around stash => sub {
485 my $stash = $orig->($c);
487 my $new_stash = @_ > 1 ? {@_} : $_[0];
488 croak('stash takes a hash or hashref') unless ref $new_stash;
489 foreach my $key ( keys %$new_stash ) {
490 $stash->{$key} = $new_stash->{$key};
500 =head2 $c->error($error, ...)
502 =head2 $c->error($arrayref)
504 Returns an arrayref containing error messages. If Catalyst encounters an
505 error while processing a request, it stores the error in $c->error. This
506 method should only be used to store fatal error messages.
508 my @error = @{ $c->error };
512 $c->error('Something bad happened');
519 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
520 croak @$error unless ref $c;
521 push @{ $c->{error} }, @$error;
523 elsif ( defined $_[0] ) { $c->{error} = undef }
524 return $c->{error} || [];
530 Contains the return value of the last executed action.
531 Note that << $c->state >> operates in a scalar context which means that all
532 values it returns are scalar.
534 =head2 $c->clear_errors
536 Clear errors. You probably don't want to clear the errors unless you are
537 implementing a custom error screen.
539 This is equivalent to running
550 =head2 COMPONENT ACCESSORS
552 =head2 $c->controller($name)
554 Gets a L<Catalyst::Controller> instance by name.
556 $c->controller('Foo')->do_stuff;
558 If the name is omitted, will return the controller for the dispatched
561 If you want to search for controllers, pass in a regexp as the argument.
563 # find all controllers that start with Foo
564 my @foo_controllers = $c->controller(qr{^Foo});
570 my ( $c, $name, @args ) = @_;
572 $name ||= Catalyst::Utils::class2classshortsuffix( $c->action->class );
574 return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
577 =head2 $c->model($name)
579 Gets a L<Catalyst::Model> instance by name.
581 $c->model('Foo')->do_stuff;
583 Any extra arguments are directly passed to ACCEPT_CONTEXT.
585 If the name is omitted, it will look for
586 - a model object in $c->stash->{current_model_instance}, then
587 - a model name in $c->stash->{current_model}, then
588 - a config setting 'default_model', or
589 - check if there is only one model, and return it if that's the case.
591 If you want to search for models, pass in a regexp as the argument.
593 # find all models that start with Foo
594 my @foo_models = $c->model(qr{^Foo});
599 my ( $c, $name, @args ) = @_;
601 if (ref $c && !$name) {
602 return $c->stash->{current_model_instance}
603 if $c->stash->{current_model_instance};
605 $name = $c->stash->{current_model}
606 if $c->stash->{current_model};
609 return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
613 =head2 $c->view($name)
615 Gets a L<Catalyst::View> instance by name.
617 $c->view('Foo')->do_stuff;
619 Any extra arguments are directly passed to ACCEPT_CONTEXT.
621 If the name is omitted, it will look for
622 - a view object in $c->stash->{current_view_instance}, then
623 - a view name in $c->stash->{current_view}, then
624 - a config setting 'default_view', or
625 - check if there is only one view, and return it if that's the case.
627 If you want to search for views, pass in a regexp as the argument.
629 # find all views that start with Foo
630 my @foo_views = $c->view(qr{^Foo});
635 my ( $c, $name, @args ) = @_;
637 if (ref $c && !$name) {
638 return $c->stash->{current_view_instance}
639 if $c->stash->{current_view_instance};
641 $name = $c->stash->{current_view}
642 if $c->stash->{current_view};
645 return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
648 =head2 $c->controllers
650 Returns the available names which can be passed to $c->controller
656 return $c->container->get_sub_container('controller')->get_service_list;
661 Returns the available names which can be passed to $c->model
667 return $c->container->get_sub_container('model')->get_service_list;
673 Returns the available names which can be passed to $c->view
679 return $c->container->get_sub_container('view')->get_service_list;
682 =head2 $c->comp($name)
684 =head2 $c->component($name)
686 Gets a component object by name. This method is not recommended,
687 unless you want to get a specific component by full
688 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
689 should be used instead.
691 If C<$name> is a regexp, a list of components matched against the full
692 component name will be returned.
697 my ( $c, $component, @args ) = @_;
699 unless ($component) {
700 $c->log->warn('Calling $c->component with no args is deprecated and ');
701 $c->log->warn('will be removed in a future release.');
702 $c->log->warn('Use $c->component_list instead.');
703 return $c->component_list;
706 my @result = $c->container->find_component( $component, $c, @args );
708 # list context for regexp searches
709 return @result if ref $component;
711 # only one component (if it's found) for string searches
712 return shift @result if @result;
714 if (ref $c eq $component) {
715 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
716 $c->log->warn('deprecated, and will be removed in a future release.');
720 $c->log->warn("Looking for '$component', but nothing was found.");
722 # I would expect to return an empty list here, but that breaks back-compat
723 $c->log->warn('Component not found, returning the list of existing');
724 $c->log->warn('components. This behavior is deprecated and will be');
725 $c->log->warn('removed in a future release. Use $c->component_list');
726 $c->log->warn('instead.');
728 return $c->component_list;
731 =head2 $c->component_list
733 Returns the sorted list of the component names of the application.
737 sub component_list { sort keys %{ shift->components } }
739 =head2 CLASS DATA AND HELPER CLASSES
743 Returns or takes a hashref containing the application's configuration.
745 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
747 You can also use a C<YAML>, C<XML> or L<Config::General> config file
748 like C<myapp.conf> in your applications home directory. See
749 L<Catalyst::Plugin::ConfigLoader>.
751 =head3 Cascading configuration
753 The config method is present on all Catalyst components, and configuration
754 will be merged when an application is started. Configuration loaded with
755 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
756 followed by configuration in your top level C<MyApp> class. These two
757 configurations are merged, and then configuration data whose hash key matches a
758 component name is merged with configuration for that component.
760 The configuration for a component is then passed to the C<new> method when a
761 component is constructed.
765 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
766 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
768 will mean that C<MyApp::Model::Foo> receives the following data when
771 MyApp::Model::Foo->new({
777 It's common practice to use a Moose attribute
778 on the receiving component to access the config value.
780 package MyApp::Model::Foo;
784 # this attr will receive 'baz' at construction time
790 You can then get the value 'baz' by calling $c->model('Foo')->bar
791 (or $self->bar inside code in the model).
793 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
794 as a way of reading config within your code, as this B<will not> give you the
795 correctly merged config back. You B<MUST> take the config values supplied to
796 the constructor and use those instead.
800 around config => sub {
804 croak('Setting config after setup has been run is not allowed.')
805 if ( @_ and $c->setup_finished );
812 Returns the logging object instance. Unless it is already set, Catalyst
813 sets this up with a L<Catalyst::Log> object. To use your own log class,
814 set the logger with the C<< __PACKAGE__->log >> method prior to calling
815 C<< __PACKAGE__->setup >>.
817 __PACKAGE__->log( MyLogger->new );
822 $c->log->info( 'Now logging with my own logger!' );
824 Your log class should implement the methods described in
830 Returns 1 if debug mode is enabled, 0 otherwise.
832 You can enable debug mode in several ways:
836 =item By calling myapp_server.pl with the -d flag
838 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
840 =item The -Debug option in your MyApp.pm
842 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
846 The first three also set the log level to 'debug'.
848 Calling C<< $c->debug(1) >> has no effect.
854 =head2 $c->dispatcher
856 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
860 Returns the engine instance. See L<Catalyst::Engine>.
863 =head2 UTILITY METHODS
865 =head2 $c->path_to(@path)
867 Merges C<@path> with C<< $c->config->{home} >> and returns a
868 L<Path::Class::Dir> object. Note you can usually use this object as
869 a filename, but sometimes you will have to explicitly stringify it
870 yourself by calling the C<< ->stringify >> method.
874 $c->path_to( 'db', 'sqlite.db' );
879 my ( $c, @path ) = @_;
880 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
881 if ( -d $path ) { return $path }
882 else { return Path::Class::File->new( $c->config->{home}, @path ) }
885 =head2 $c->plugin( $name, $class, @args )
887 Helper method for plugins. It creates a class data accessor/mutator and
888 loads and instantiates the given class.
890 MyApp->plugin( 'prototype', 'HTML::Prototype' );
892 $c->prototype->define_javascript_functions;
894 B<Note:> This method of adding plugins is deprecated. The ability
895 to add plugins like this B<will be removed> in a Catalyst 5.81.
896 Please do not use this functionality in new code.
901 my ( $class, $name, $plugin, @args ) = @_;
903 # See block comment in t/aggregate/unit_core_plugin.t
904 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
906 $class->_register_plugin( $plugin, 1 );
908 eval { $plugin->import };
909 $class->mk_classdata($name);
911 eval { $obj = $plugin->new(@args) };
914 Catalyst::Exception->throw( message =>
915 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
919 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
925 Initializes the dispatcher and engine, loads any plugins, and loads the
926 model, view, and controller components. You may also specify an array
927 of plugins to load here, if you choose to not load them in the C<use
931 MyApp->setup( qw/-Debug/ );
936 my ( $class, @arguments ) = @_;
937 croak('Running setup more than once')
938 if ( $class->setup_finished );
940 unless ( $class->isa('Catalyst') ) {
942 Catalyst::Exception->throw(
943 message => qq/'$class' does not inherit from Catalyst/ );
946 if ( $class->arguments ) {
947 @arguments = ( @arguments, @{ $class->arguments } );
953 foreach (@arguments) {
957 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
959 elsif (/^-(\w+)=?(.*)$/) {
960 $flags->{ lc $1 } = $2;
963 push @{ $flags->{plugins} }, $_;
967 $class->setup_config();
968 $class->setup_home( delete $flags->{home} );
970 $class->setup_log( delete $flags->{log} );
971 $class->setup_plugins( delete $flags->{plugins} );
972 $class->setup_dispatcher( delete $flags->{dispatcher} );
973 $class->setup_engine( delete $flags->{engine} );
974 $class->setup_stats( delete $flags->{stats} );
976 for my $flag ( sort keys %{$flags} ) {
978 if ( my $code = $class->can( 'setup_' . $flag ) ) {
979 &$code( $class, delete $flags->{$flag} );
982 $class->log->warn(qq/Unknown flag "$flag"/);
986 eval { require Catalyst::Devel; };
987 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
988 $class->log->warn(<<"EOF");
989 You are running an old script!
991 Please update by running (this will overwrite existing files):
992 catalyst.pl -force -scripts $class
994 or (this will not overwrite existing files):
995 catalyst.pl -scripts $class
1000 if ( $class->debug ) {
1001 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1004 my $column_width = Catalyst::Utils::term_width() - 6;
1005 my $t = Text::SimpleTable->new($column_width);
1006 $t->row($_) for @plugins;
1007 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1010 my $dispatcher = $class->dispatcher;
1011 my $engine = $class->engine;
1012 my $home = $class->config->{home};
1014 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1015 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1019 ? $class->log->debug(qq/Found home "$home"/)
1020 : $class->log->debug(qq/Home "$home" doesn't exist/)
1021 : $class->log->debug(q/Couldn't find home/);
1024 # Call plugins setup, this is stupid and evil.
1025 # Also screws C3 badly on 5.10, hack to avoid.
1027 no warnings qw/redefine/;
1028 local *setup = sub { };
1029 $class->setup unless $Catalyst::__AM_RESTARTING;
1032 $class->setup_components;
1036 my @comps_types = $class->container->get_components_types
1038 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1039 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1040 $t->row( @$_ ) for @comps_types;
1042 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1045 $class->setup_actions;
1047 if ( $class->debug ) {
1048 my $name = $class->config->{name} || 'Application';
1049 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1052 # Make sure that the application class becomes immutable at this point,
1053 B::Hooks::EndOfScope::on_scope_end {
1055 my $meta = Class::MOP::get_metaclass_by_name($class);
1058 && ! { $meta->immutable_options }->{replace_constructor}
1060 $class->isa('Class::Accessor::Fast')
1061 || $class->isa('Class::Accessor')
1064 warn "You made your application class ($class) immutable, "
1065 . "but did not inline the\nconstructor. "
1066 . "This will break catalyst, as your app \@ISA "
1067 . "Class::Accessor(::Fast)?\nPlease pass "
1068 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1070 $meta->make_immutable(
1071 replace_constructor => 1,
1072 ) unless $meta->is_immutable;
1075 if ($class->config->{case_sensitive}) {
1076 $class->log->warn($class . "->config->{case_sensitive} is set.");
1077 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1080 $class->setup_finalize;
1081 # Should be the last thing we do so that user things hooking
1082 # setup_finalize can log..
1083 $class->log->_flush() if $class->log->can('_flush');
1084 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1087 =head2 $app->setup_finalize
1089 A hook to attach modifiers to. This method does not do anything except set the
1090 C<setup_finished> accessor.
1092 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1096 after setup_finalize => sub {
1104 sub setup_finalize {
1106 $class->setup_finished(1);
1109 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1111 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1113 Constructs an absolute L<URI> object based on the application root, the
1114 provided path, and the additional arguments and query parameters provided.
1115 When used as a string, provides a textual URI. If you need more flexibility
1116 than this (i.e. the option to provide relative URIs etc.) see
1117 L<Catalyst::Plugin::SmartURI>.
1119 If no arguments are provided, the URI for the current action is returned.
1120 To return the current action and also provide @args, use
1121 C<< $c->uri_for( $c->action, @args ) >>.
1123 If the first argument is a string, it is taken as a public URI path relative
1124 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1125 relative to the application root (if it does). It is then merged with
1126 C<< $c->request->base >>; any C<@args> are appended as additional path
1127 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1129 If the first argument is a L<Catalyst::Action> it represents an action which
1130 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1131 optional C<\@captures> argument (an arrayref) allows passing the captured
1132 variables that are needed to fill in the paths of Chained and Regex actions;
1133 once the path is resolved, C<uri_for> continues as though a path was
1134 provided, appending any arguments or parameters and creating an absolute
1137 The captures for the current request can be found in
1138 C<< $c->request->captures >>, and actions can be resolved using
1139 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1140 path, use C<< $c->uri_for_action >> instead.
1142 # Equivalent to $c->req->uri
1143 $c->uri_for($c->action, $c->req->captures,
1144 @{ $c->req->args }, $c->req->params);
1146 # For the Foo action in the Bar controller
1147 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1149 # Path to a static resource
1150 $c->uri_for('/static/images/logo.png');
1155 my ( $c, $path, @args ) = @_;
1157 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1158 $path = $path->path_prefix;
1163 undef($path) if (defined $path && $path eq '');
1166 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1168 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1169 foreach my $arg (@args) {
1170 utf8::encode($arg) if utf8::is_utf8($arg);
1171 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1174 if ( blessed($path) ) { # action object
1175 s|/|%2F|g for @args;
1176 my $captures = [ map { s|/|%2F|g; $_; }
1177 ( scalar @args && ref $args[0] eq 'ARRAY'
1181 foreach my $capture (@$captures) {
1182 utf8::encode($capture) if utf8::is_utf8($capture);
1183 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1187 $path = $c->dispatcher->uri_for_action($action, $captures);
1188 if (not defined $path) {
1189 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1193 $path = '/' if $path eq '';
1196 unshift(@args, $path);
1198 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1199 my $namespace = $c->namespace;
1200 if (defined $path) { # cheesy hack to handle path '../foo'
1201 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1203 unshift(@args, $namespace || '');
1206 # join args with '/', or a blank string
1207 my $args = join('/', grep { defined($_) } @args);
1208 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1210 my $base = $c->req->base;
1211 my $class = ref($base);
1212 $base =~ s{(?<!/)$}{/};
1216 if (my @keys = keys %$params) {
1217 # somewhat lifted from URI::_query's query_form
1218 $query = '?'.join('&', map {
1219 my $val = $params->{$_};
1220 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1223 $val = '' unless defined $val;
1226 utf8::encode( $param ) if utf8::is_utf8($param);
1227 # using the URI::Escape pattern here so utf8 chars survive
1228 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1230 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1234 my $res = bless(\"${base}${args}${query}", $class);
1238 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1240 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1246 A private path to the Catalyst action you want to create a URI for.
1248 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1249 >> and passing the resulting C<$action> and the remaining arguments to C<<
1252 You can also pass in a Catalyst::Action object, in which case it is passed to
1255 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.
1257 For example, if the action looks like:
1259 package MyApp::Controller::Users;
1261 sub lst : Path('the-list') {}
1265 $c->uri_for_action('/users/lst')
1267 and it will create the URI /users/the-list.
1273 sub uri_for_action {
1274 my ( $c, $path, @args ) = @_;
1275 my $action = blessed($path)
1277 : $c->dispatcher->get_action_by_path($path);
1278 unless (defined $action) {
1279 croak "Can't find action for path '$path'";
1281 return $c->uri_for( $action, @args );
1284 =head2 $c->welcome_message
1286 Returns the Catalyst welcome HTML page.
1290 sub welcome_message {
1292 my $name = $c->config->{name};
1293 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1294 my $prefix = Catalyst::Utils::appprefix( ref $c );
1295 $c->response->content_type('text/html; charset=utf-8');
1297 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1298 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1299 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1301 <meta http-equiv="Content-Language" content="en" />
1302 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1303 <title>$name on Catalyst $VERSION</title>
1304 <style type="text/css">
1307 background-color: #eee;
1314 margin-bottom: 10px;
1316 background-color: #ccc;
1317 border: 1px solid #aaa;
1322 font-family: verdana, tahoma, sans-serif;
1325 font-family: verdana, tahoma, sans-serif;
1328 text-decoration: none;
1330 border-bottom: 1px dotted #bbb;
1332 :link:hover, :visited:hover {
1345 background-color: #fff;
1346 border: 1px solid #aaa;
1350 font-weight: normal;
1372 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1377 <img src="$logo" alt="Catalyst Logo" />
1379 <p>Welcome to the world of Catalyst.
1380 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1381 framework will make web development something you had
1382 never expected it to be: Fun, rewarding, and quick.</p>
1383 <h2>What to do now?</h2>
1384 <p>That really depends on what <b>you</b> want to do.
1385 We do, however, provide you with a few starting points.</p>
1386 <p>If you want to jump right into web development with Catalyst
1387 you might want to start with a tutorial.</p>
1388 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1390 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1392 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1393 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1395 <h2>What to do next?</h2>
1396 <p>Next it's time to write an actual application. Use the
1397 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1398 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1399 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1400 they can save you a lot of work.</p>
1401 <pre><code>script/${prefix}_create.pl --help</code></pre>
1402 <p>Also, be sure to check out the vast and growing
1403 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1404 you are likely to find what you need there.
1408 <p>Catalyst has a very active community. Here are the main places to
1409 get in touch with us.</p>
1412 <a href="http://dev.catalyst.perl.org">Wiki</a>
1415 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1418 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1421 <h2>In conclusion</h2>
1422 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1423 as we enjoyed making it. Please contact us if you have ideas
1424 for improvement or other feedback.</p>
1432 =head1 INTERNAL METHODS
1434 These methods are not meant to be used by end users.
1436 =head2 $c->components
1438 Returns a hash of components.
1443 my ( $class, $comps ) = @_;
1445 # people create components calling this sub directly, before setup
1446 $class->setup_config unless $class->container;
1448 my $container = $class->container;
1451 $container->add_component(
1456 return $container->get_all_components();
1459 =head2 $c->context_class
1461 Returns or sets the context class.
1465 Returns a hashref containing coderefs and execution counts (needed for
1466 deep recursion detection).
1470 Returns the number of actions on the current internal execution stack.
1474 Dispatches a request to actions.
1478 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1480 =head2 $c->dispatcher_class
1482 Returns or sets the dispatcher class.
1484 =head2 $c->dump_these
1486 Returns a list of 2-element array references (name, structure) pairs
1487 that will be dumped on the error page in debug mode.
1493 [ Request => $c->req ],
1494 [ Response => $c->res ],
1495 [ Stash => $c->stash ],
1496 [ Config => $c->config ];
1499 =head2 $c->engine_class
1501 Returns or sets the engine class.
1503 =head2 $c->execute( $class, $coderef )
1505 Execute a coderef in given class and catch exceptions. Errors are available
1511 my ( $c, $class, $code ) = @_;
1512 $class = $c->component($class) || $class;
1515 if ( $c->depth >= $RECURSION ) {
1516 my $action = $code->reverse();
1517 $action = "/$action" unless $action =~ /->/;
1518 my $error = qq/Deep recursion detected calling "${action}"/;
1519 $c->log->error($error);
1525 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1527 push( @{ $c->stack }, $code );
1529 no warnings 'recursion';
1530 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1531 # I have no idea how, ergo $ret (which appears to fix the issue)
1532 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1534 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1536 my $last = pop( @{ $c->stack } );
1538 if ( my $error = $@ ) {
1539 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1540 $error->rethrow if $c->depth > 1;
1542 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1543 $error->rethrow if $c->depth > 0;
1546 unless ( ref $error ) {
1547 no warnings 'uninitialized';
1549 my $class = $last->class;
1550 my $name = $last->name;
1551 $error = qq/Caught exception in $class->$name "$error"/;
1560 sub _stats_start_execute {
1561 my ( $c, $code ) = @_;
1562 my $appclass = ref($c) || $c;
1563 return if ( ( $code->name =~ /^_.*/ )
1564 && ( !$appclass->config->{show_internal_actions} ) );
1566 my $action_name = $code->reverse();
1567 $c->counter->{$action_name}++;
1569 my $action = $action_name;
1570 $action = "/$action" unless $action =~ /->/;
1572 # determine if the call was the result of a forward
1573 # this is done by walking up the call stack and looking for a calling
1574 # sub of Catalyst::forward before the eval
1576 for my $index ( 2 .. 11 ) {
1578 if ( ( caller($index) )[0] eq 'Catalyst'
1579 && ( caller($index) )[3] eq '(eval)' );
1581 if ( ( caller($index) )[3] =~ /forward$/ ) {
1582 $callsub = ( caller($index) )[3];
1583 $action = "-> $action";
1588 my $uid = $action_name . $c->counter->{$action_name};
1590 # is this a root-level call or a forwarded call?
1591 if ( $callsub =~ /forward$/ ) {
1592 my $parent = $c->stack->[-1];
1594 # forward, locate the caller
1595 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1598 parent => "$parent" . $c->counter->{"$parent"},
1604 # forward with no caller may come from a plugin
1623 sub _stats_finish_execute {
1624 my ( $c, $info ) = @_;
1625 $c->stats->profile( end => $info );
1630 Finalizes the request.
1637 for my $error ( @{ $c->error } ) {
1638 $c->log->error($error);
1641 # Allow engine to handle finalize flow (for POE)
1642 my $engine = $c->engine;
1643 if ( my $code = $engine->can('finalize') ) {
1648 $c->finalize_uploads;
1651 if ( $#{ $c->error } >= 0 ) {
1655 $c->finalize_headers;
1658 if ( $c->request->method eq 'HEAD' ) {
1659 $c->response->body('');
1667 if ($c->use_stats) {
1668 my $elapsed = sprintf '%f', $c->stats->elapsed;
1669 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1671 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1674 return $c->response->status;
1677 =head2 $c->finalize_body
1683 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1685 =head2 $c->finalize_cookies
1691 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1693 =head2 $c->finalize_error
1699 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1701 =head2 $c->finalize_headers
1707 sub finalize_headers {
1710 my $response = $c->response; #accessor calls can add up?
1712 # Check if we already finalized headers
1713 return if $response->finalized_headers;
1716 if ( my $location = $response->redirect ) {
1717 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1718 $response->header( Location => $location );
1720 if ( !$response->has_body ) {
1721 # Add a default body if none is already present
1723 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
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 $stat = stat $response->body;
1735 if ( $stat && $stat->size > 0 ) {
1736 $response->content_length( $stat->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 if ( my $error = $@ ) {
1825 $class->log->error(qq/Caught exception in engine "$error"/);
1830 if(my $coderef = $class->log->can('_flush')){
1831 $class->log->$coderef();
1836 =head2 $c->prepare( @arguments )
1838 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1844 my ( $class, @arguments ) = @_;
1847 # After the app/ctxt split, this should become an attribute based on something passed
1848 # into the application.
1849 $class->context_class( ref $class || $class ) unless $class->context_class;
1851 my $c = $class->context_class->new({});
1853 # For on-demand data
1854 $c->request->_context($c);
1855 $c->response->_context($c);
1857 #surely this is not the most efficient way to do things...
1858 $c->stats($class->stats_class->new)->enable($c->use_stats);
1859 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1860 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1863 #XXX reuse coderef from can
1864 # Allow engine to direct the prepare flow (for POE)
1865 if ( $c->engine->can('prepare') ) {
1866 $c->engine->prepare( $c, @arguments );
1869 $c->prepare_request(@arguments);
1870 $c->prepare_connection;
1871 $c->prepare_query_parameters;
1872 $c->prepare_headers;
1873 $c->prepare_cookies;
1876 # Prepare the body for reading, either by prepare_body
1877 # or the user, if they are using $c->read
1880 # Parse the body unless the user wants it on-demand
1881 unless ( ref($c)->config->{parse_on_demand} ) {
1886 my $method = $c->req->method || '';
1887 my $path = $c->req->path;
1888 $path = '/' unless length $path;
1889 my $address = $c->req->address || '';
1898 =head2 $c->prepare_action
1900 Prepares action. See L<Catalyst::Dispatcher>.
1904 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1906 =head2 $c->prepare_body
1908 Prepares message body.
1915 return if $c->request->_has_body;
1917 # Initialize on-demand data
1918 $c->engine->prepare_body( $c, @_ );
1919 $c->prepare_parameters;
1920 $c->prepare_uploads;
1923 =head2 $c->prepare_body_chunk( $chunk )
1925 Prepares a chunk of data before sending it to L<HTTP::Body>.
1927 See L<Catalyst::Engine>.
1931 sub prepare_body_chunk {
1933 $c->engine->prepare_body_chunk( $c, @_ );
1936 =head2 $c->prepare_body_parameters
1938 Prepares body parameters.
1942 sub prepare_body_parameters {
1944 $c->engine->prepare_body_parameters( $c, @_ );
1947 =head2 $c->prepare_connection
1949 Prepares connection.
1953 sub prepare_connection {
1955 $c->engine->prepare_connection( $c, @_ );
1958 =head2 $c->prepare_cookies
1964 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1966 =head2 $c->prepare_headers
1972 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1974 =head2 $c->prepare_parameters
1976 Prepares parameters.
1980 sub prepare_parameters {
1982 $c->prepare_body_parameters;
1983 $c->engine->prepare_parameters( $c, @_ );
1986 =head2 $c->prepare_path
1988 Prepares path and base.
1992 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1994 =head2 $c->prepare_query_parameters
1996 Prepares query parameters.
2000 sub prepare_query_parameters {
2003 $c->engine->prepare_query_parameters( $c, @_ );
2006 =head2 $c->log_request
2008 Writes information about the request to the debug logs. This includes:
2012 =item * Request method, path, and remote IP address
2014 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2016 =item * Request parameters
2018 =item * File uploads
2027 return unless $c->debug;
2029 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2030 my $request = $dump->[1];
2032 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2034 $path = '/' unless length $path;
2036 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2038 $c->log_request_headers($request->headers);
2040 if ( my $keywords = $request->query_keywords ) {
2041 $c->log->debug("Query keywords are: $keywords");
2044 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2046 $c->log_request_uploads($request);
2049 =head2 $c->log_response
2051 Writes information about the response to the debug logs by calling
2052 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2059 return unless $c->debug;
2061 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2062 my $response = $dump->[1];
2064 $c->log_response_status_line($response);
2065 $c->log_response_headers($response->headers);
2068 =head2 $c->log_response_status_line($response)
2070 Writes one line of information about the response to the debug logs. This includes:
2074 =item * Response status code
2076 =item * Content-Type header (if present)
2078 =item * Content-Length header (if present)
2084 sub log_response_status_line {
2085 my ($c, $response) = @_;
2089 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2090 $response->status || 'unknown',
2091 $response->headers->header('Content-Type') || 'unknown',
2092 $response->headers->header('Content-Length') || 'unknown'
2097 =head2 $c->log_response_headers($headers);
2099 Hook method which can be wrapped by plugins to log the responseheaders.
2100 No-op in the default implementation.
2104 sub log_response_headers {}
2106 =head2 $c->log_request_parameters( query => {}, body => {} )
2108 Logs request parameters to debug logs
2112 sub log_request_parameters {
2114 my %all_params = @_;
2116 return unless $c->debug;
2118 my $column_width = Catalyst::Utils::term_width() - 44;
2119 foreach my $type (qw(query body)) {
2120 my $params = $all_params{$type};
2121 next if ! keys %$params;
2122 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2123 for my $key ( sort keys %$params ) {
2124 my $param = $params->{$key};
2125 my $value = defined($param) ? $param : '';
2126 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2128 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2132 =head2 $c->log_request_uploads
2134 Logs file uploads included in the request to the debug logs.
2135 The parameter name, filename, file type, and file size are all included in
2140 sub log_request_uploads {
2142 my $request = shift;
2143 return unless $c->debug;
2144 my $uploads = $request->uploads;
2145 if ( keys %$uploads ) {
2146 my $t = Text::SimpleTable->new(
2147 [ 12, 'Parameter' ],
2152 for my $key ( sort keys %$uploads ) {
2153 my $upload = $uploads->{$key};
2154 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2155 $t->row( $key, $u->filename, $u->type, $u->size );
2158 $c->log->debug( "File Uploads are:\n" . $t->draw );
2162 =head2 $c->log_request_headers($headers);
2164 Hook method which can be wrapped by plugins to log the request headers.
2165 No-op in the default implementation.
2169 sub log_request_headers {}
2171 =head2 $c->log_headers($type => $headers)
2173 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2180 my $headers = shift; # an HTTP::Headers instance
2182 return unless $c->debug;
2184 my $column_width = Catalyst::Utils::term_width() - 28;
2185 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2188 my ( $name, $value ) = @_;
2189 $t->row( $name, $value );
2192 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2196 =head2 $c->prepare_read
2198 Prepares the input for reading.
2202 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2204 =head2 $c->prepare_request
2206 Prepares the engine request.
2210 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2212 =head2 $c->prepare_uploads
2218 sub prepare_uploads {
2221 $c->engine->prepare_uploads( $c, @_ );
2224 =head2 $c->prepare_write
2226 Prepares the output for writing.
2230 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2232 =head2 $c->request_class
2234 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2236 =head2 $c->response_class
2238 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2240 =head2 $c->read( [$maxlength] )
2242 Reads a chunk of data from the request body. This method is designed to
2243 be used in a while loop, reading C<$maxlength> bytes on every call.
2244 C<$maxlength> defaults to the size of the request if not specified.
2246 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2249 Warning: If you use read(), Catalyst will not process the body,
2250 so you will not be able to access POST parameters or file uploads via
2251 $c->request. You must handle all body parsing yourself.
2255 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2263 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2265 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2267 Sets an action in a given namespace.
2271 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2273 =head2 $c->setup_actions($component)
2275 Sets up actions for a component.
2279 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2281 =head2 $c->setup_config
2288 my %args = %{ $class->config || {} };
2290 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2291 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2293 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2295 my $container = $container_class->new( %args, name => "$class" );
2296 $class->container($container);
2298 my $config = $container->resolve(service => 'config');
2299 $class->config($config);
2300 $class->finalize_config; # back-compat
2303 =head2 $c->finalize_config
2307 sub finalize_config { }
2309 =head2 $c->setup_components
2311 This method is called internally to set up the application's components.
2313 It finds modules by calling the L<locate_components> method, expands them to
2314 package names with the L<expand_component_module> method, and then installs
2315 each component into the application.
2317 The C<setup_components> config option is passed to both of the above methods.
2321 sub setup_components {
2324 my $config = $class->config->{ setup_components };
2326 Catalyst::Exception->throw(
2327 qq{You are using search_extra config option. That option is\n} .
2328 qq{deprecated, please refer to the documentation for\n} .
2329 qq{other ways of achieving the same results.\n}
2330 ) if delete $config->{ search_extra };
2332 my @comps = $class->locate_components($config);
2333 my %comps = map { $_ => 1 } @comps;
2335 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2336 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2337 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2338 ) if $deprecatedcatalyst_component_names;
2340 for my $component ( @comps ) {
2342 # We pass ignore_loaded here so that overlay files for (e.g.)
2343 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2344 # we know M::P::O found a file on disk so this is safe
2346 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2349 my $container = $class->container;
2351 for my $component (@comps) {
2352 my $instance = $container->add_component( $component, $class );
2353 my @expanded_components = $instance->can('expand_modules')
2354 ? $instance->expand_modules( $component, $config )
2355 : $class->expand_component_module( $component, $config );
2356 for my $component (@expanded_components) {
2357 next if $comps{$component};
2359 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2360 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2361 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2362 ) if $deprecatedcatalyst_component_names;
2364 $container->add_component( $component, $class );
2368 $container->get_sub_container('model')->make_single_default;
2369 $container->get_sub_container('view')->make_single_default;
2373 =head2 $c->locate_components( $setup_component_config )
2375 This method is meant to provide a list of component modules that should be
2376 setup for the application. By default, it will use L<Module::Pluggable>.
2378 Specify a C<setup_components> config option to pass additional options directly
2379 to L<Module::Pluggable>.
2383 sub locate_components {
2387 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2389 my $locator = Module::Pluggable::Object->new(
2390 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2394 # XXX think about ditching this sort entirely
2395 my @comps = sort { length $a <=> length $b } $locator->plugins;
2400 =head2 $c->expand_component_module( $component, $setup_component_config )
2402 Components found by C<locate_components> will be passed to this method, which
2403 is expected to return a list of component (package) names to be set up.
2407 sub expand_component_module {
2408 my ($class, $module) = @_;
2409 return Devel::InnerPackage::list_packages( $module );
2412 =head2 $c->setup_dispatcher
2418 sub setup_dispatcher {
2419 my ( $class, $dispatcher ) = @_;
2422 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2425 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2426 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2429 unless ($dispatcher) {
2430 $dispatcher = $class->dispatcher_class;
2433 Class::MOP::load_class($dispatcher);
2435 # dispatcher instance
2436 $class->dispatcher( $dispatcher->new );
2439 =head2 $c->setup_engine
2446 my ( $class, $engine ) = @_;
2449 $engine = 'Catalyst::Engine::' . $engine;
2452 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2453 $engine = 'Catalyst::Engine::' . $env;
2456 if ( $ENV{MOD_PERL} ) {
2457 my $meta = Class::MOP::get_metaclass_by_name($class);
2459 # create the apache method
2460 $meta->add_method('apache' => sub { shift->engine->apache });
2462 my ( $software, $version ) =
2463 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2466 $version =~ s/(\.[^.]+)\./$1/g;
2468 if ( $software eq 'mod_perl' ) {
2472 if ( $version >= 1.99922 ) {
2473 $engine = 'Catalyst::Engine::Apache2::MP20';
2476 elsif ( $version >= 1.9901 ) {
2477 $engine = 'Catalyst::Engine::Apache2::MP19';
2480 elsif ( $version >= 1.24 ) {
2481 $engine = 'Catalyst::Engine::Apache::MP13';
2485 Catalyst::Exception->throw( message =>
2486 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2491 # install the correct mod_perl handler
2492 if ( $version >= 1.9901 ) {
2493 *handler = sub : method {
2494 shift->handle_request(@_);
2498 *handler = sub ($$) { shift->handle_request(@_) };
2503 elsif ( $software eq 'Zeus-Perl' ) {
2504 $engine = 'Catalyst::Engine::Zeus';
2508 Catalyst::Exception->throw(
2509 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2514 $engine = $class->engine_class;
2517 Class::MOP::load_class($engine);
2519 # check for old engines that are no longer compatible
2521 if ( $engine->isa('Catalyst::Engine::Apache')
2522 && !Catalyst::Engine::Apache->VERSION )
2527 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2528 && Catalyst::Engine::Server->VERSION le '0.02' )
2533 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2534 && $engine->VERSION eq '0.01' )
2539 elsif ($engine->isa('Catalyst::Engine::Zeus')
2540 && $engine->VERSION eq '0.01' )
2546 Catalyst::Exception->throw( message =>
2547 qq/Engine "$engine" is not supported by this version of Catalyst/
2552 $class->engine( $engine->new );
2555 =head2 $c->setup_home
2557 Sets up the home directory.
2562 my ( $class, $home ) = @_;
2564 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2568 $home ||= Catalyst::Utils::home($class);
2571 #I remember recently being scolded for assigning config values like this
2572 $class->config->{home} ||= $home;
2573 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2577 =head2 $c->setup_log
2579 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2580 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2583 This method also installs a C<debug> method that returns a true value into the
2584 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2585 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2587 Note that if the log has already been setup, by either a previous call to
2588 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2589 that this method won't actually set up the log object.
2594 my ( $class, $levels ) = @_;
2597 $levels =~ s/^\s+//;
2598 $levels =~ s/\s+$//;
2599 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2601 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2602 if ( defined $env_debug ) {
2603 $levels{debug} = 1 if $env_debug; # Ugly!
2604 delete($levels{debug}) unless $env_debug;
2607 unless ( $class->log ) {
2608 $class->log( Catalyst::Log->new(keys %levels) );
2611 if ( $levels{debug} ) {
2612 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2613 $class->log->debug('Debug messages enabled');
2617 =head2 $c->setup_plugins
2623 =head2 $c->setup_stats
2625 Sets up timing statistics class.
2630 my ( $class, $stats ) = @_;
2632 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2634 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2635 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2636 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2637 $class->log->debug('Statistics enabled');
2642 =head2 $c->registered_plugins
2644 Returns a sorted list of the plugins which have either been stated in the
2645 import list or which have been added via C<< MyApp->plugin(@args); >>.
2647 If passed a given plugin name, it will report a boolean value indicating
2648 whether or not that plugin is loaded. A fully qualified name is required if
2649 the plugin name does not begin with C<Catalyst::Plugin::>.
2651 if ($c->registered_plugins('Some::Plugin')) {
2659 sub registered_plugins {
2661 return sort keys %{ $proto->_plugins } unless @_;
2663 return 1 if exists $proto->_plugins->{$plugin};
2664 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2667 sub _register_plugin {
2668 my ( $proto, $plugin, $instant ) = @_;
2669 my $class = ref $proto || $proto;
2671 Class::MOP::load_class( $plugin );
2672 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2673 if $plugin->isa( 'Catalyst::Component' );
2674 $proto->_plugins->{$plugin} = 1;
2676 my $meta = Class::MOP::get_metaclass_by_name($class);
2677 $meta->superclasses($plugin, $meta->superclasses);
2683 my ( $class, $plugins ) = @_;
2685 $class->_plugins( {} ) unless $class->_plugins;
2686 $plugins = Data::OptList::mkopt($plugins || []);
2689 [ Catalyst::Utils::resolve_namespace(
2690 $class . '::Plugin',
2691 'Catalyst::Plugin', $_->[0]
2697 for my $plugin ( reverse @plugins ) {
2698 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2699 my $meta = find_meta($plugin->[0]);
2700 next if $meta && $meta->isa('Moose::Meta::Role');
2702 $class->_register_plugin($plugin->[0]);
2706 map { $_->[0]->name, $_->[1] }
2707 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2708 map { [find_meta($_->[0]), $_->[1]] }
2711 Moose::Util::apply_all_roles(
2719 Returns an arrayref of the internal execution stack (actions that are
2720 currently executing).
2724 Returns the current timing statistics object. By default Catalyst uses
2725 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2726 L<< stats_class|/"$c->stats_class" >>.
2728 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2729 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2730 profile explicitly, although MyApp.pm still won't profile nor output anything
2733 =head2 $c->stats_class
2735 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2737 =head2 $c->use_stats
2739 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2741 Note that this is a static method, not an accessor and should be overridden
2742 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2749 =head2 $c->write( $data )
2751 Writes $data to the output stream. When using this method directly, you
2752 will need to manually set the C<Content-Length> header to the length of
2753 your output data, if known.
2760 # Finalize headers if someone manually writes output
2761 $c->finalize_headers;
2763 return $c->engine->write( $c, @_ );
2768 Returns the Catalyst version number. Mostly useful for "powered by"
2769 messages in template systems.
2773 sub version { return $Catalyst::VERSION }
2775 =head1 CONFIGURATION
2777 There are a number of 'base' config variables which can be set:
2783 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2787 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2791 C<home> - The application home directory. In an uninstalled application,
2792 this is the top level application directory. In an installed application,
2793 this will be the directory containing C<< MyApp.pm >>.
2797 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2801 C<name> - The name of the application in debug messages and the debug and
2806 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2807 until it is accessed. This allows you to (for example) check authentication (and reject
2808 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2812 C<root> - The root directory for templates. Usually this is just a
2813 subdirectory of the home directory, but you can set it to change the
2814 templates to a different directory.
2818 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2819 to be shown in hit debug tables in the test server.
2823 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2824 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2825 for more information.
2829 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2833 =head1 INTERNAL ACTIONS
2835 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2836 C<_ACTION>, and C<_END>. These are by default not shown in the private
2837 action table, but you can make them visible with a config parameter.
2839 MyApp->config(show_internal_actions => 1);
2841 =head1 ON-DEMAND PARSER
2843 The request body is usually parsed at the beginning of a request,
2844 but if you want to handle input yourself, you can enable on-demand
2845 parsing with a config parameter.
2847 MyApp->config(parse_on_demand => 1);
2849 =head1 PROXY SUPPORT
2851 Many production servers operate using the common double-server approach,
2852 with a lightweight frontend web server passing requests to a larger
2853 backend server. An application running on the backend server must deal
2854 with two problems: the remote user always appears to be C<127.0.0.1> and
2855 the server's hostname will appear to be C<localhost> regardless of the
2856 virtual host that the user connected through.
2858 Catalyst will automatically detect this situation when you are running
2859 the frontend and backend servers on the same machine. The following
2860 changes are made to the request.
2862 $c->req->address is set to the user's real IP address, as read from
2863 the HTTP X-Forwarded-For header.
2865 The host value for $c->req->base and $c->req->uri is set to the real
2866 host, as read from the HTTP X-Forwarded-Host header.
2868 Additionally, you may be running your backend application on an insecure
2869 connection (port 80) while your frontend proxy is running under SSL. If there
2870 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2871 tell Catalyst what port the frontend listens on. This will allow all URIs to
2872 be created properly.
2874 In the case of passing in:
2876 X-Forwarded-Port: 443
2878 All calls to C<uri_for> will result in an https link, as is expected.
2880 Obviously, your web server must support these headers for this to work.
2882 In a more complex server farm environment where you may have your
2883 frontend proxy server(s) on different machines, you will need to set a
2884 configuration option to tell Catalyst to read the proxied data from the
2887 MyApp->config(using_frontend_proxy => 1);
2889 If you do not wish to use the proxy support at all, you may set:
2891 MyApp->config(ignore_frontend_proxy => 1);
2893 =head1 THREAD SAFETY
2895 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2896 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2897 believe the Catalyst core to be thread-safe.
2899 If you plan to operate in a threaded environment, remember that all other
2900 modules you are using must also be thread-safe. Some modules, most notably
2901 L<DBD::SQLite>, are not thread-safe.
2907 Join #catalyst on irc.perl.org.
2911 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2912 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2916 http://catalyst.perl.org
2920 http://dev.catalyst.perl.org
2924 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2926 =head2 L<Catalyst::Manual> - The Catalyst Manual
2928 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2930 =head2 L<Catalyst::Engine> - Core engine
2932 =head2 L<Catalyst::Log> - Log class.
2934 =head2 L<Catalyst::Request> - Request object
2936 =head2 L<Catalyst::Response> - Response object
2938 =head2 L<Catalyst::Test> - The test suite.
2940 =head1 PROJECT FOUNDER
2942 sri: Sebastian Riedel <sri@cpan.org>
2948 acme: Leon Brocard <leon@astray.com>
2950 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2954 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2960 andyg: Andy Grundman <andy@hybridized.org>
2962 audreyt: Audrey Tang
2964 bricas: Brian Cassidy <bricas@cpan.org>
2966 Caelum: Rafael Kitover <rkitover@io.com>
2968 chansen: Christian Hansen
2970 chicks: Christopher Hicks
2972 Chisel Wright C<pause@herlpacker.co.uk>
2974 Danijel Milicevic C<me@danijel.de>
2976 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2978 David Naughton, C<naughton@umn.edu>
2982 dhoss: Devin Austin <dhoss@cpan.org>
2984 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2988 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2990 esskar: Sascha Kiefer
2992 fireartist: Carl Franks <cfranks@cpan.org>
2994 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2996 gabb: Danijel Milicevic
3000 Gavin Henry C<ghenry@perl.me.uk>
3004 groditi: Guillermo Roditi <groditi@gmail.com>
3006 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3008 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3010 jcamacho: Juan Camacho
3012 jester: Jesse Sheidlower C<jester@panix.com>
3014 jhannah: Jay Hannah <jay@jays.net>
3020 jon: Jon Schutz <jjschutz@cpan.org>
3022 Jonathan Rockway C<< <jrockway@cpan.org> >>
3024 Kieren Diment C<kd@totaldatasolution.com>
3026 konobi: Scott McWhirter <konobi@cpan.org>
3028 marcus: Marcus Ramberg <mramberg@cpan.org>
3030 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3032 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3036 naughton: David Naughton
3038 ningu: David Kamholz <dkamholz@cpan.org>
3040 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3042 numa: Dan Sully <daniel@cpan.org>
3048 omega: Andreas Marienborg
3050 Oleg Kostyuk <cub.uanic@gmail.com>
3052 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3054 rafl: Florian Ragwitz <rafl@debian.org>
3056 random: Roland Lammel <lammel@cpan.org>
3058 Robert Sedlacek C<< <rs@474.at> >>
3060 SpiceMan: Marcel Montes
3064 szbalint: Balint Szilakszi <szbalint@cpan.org>
3066 t0m: Tomas Doran <bobtfish@bobtfish.net>
3070 Viljo Marrandi C<vilts@yahoo.com>
3072 Will Hawes C<info@whawes.co.uk>
3074 willert: Sebastian Willert <willert@cpan.org>
3076 wreis: Wallace Reis <wallace@reis.org.br>
3078 Yuval Kogman, C<nothingmuch@woobling.org>
3080 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3082 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3086 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3090 This library is free software. You can redistribute it and/or modify it under
3091 the same terms as Perl itself.
3097 __PACKAGE__->meta->make_immutable;