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;
17 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
26 use Tree::Simple qw/use_weak_refs/;
27 use Tree::Simple::Visitor::FindByUID;
28 use Class::C3::Adopt::NEXT;
29 use List::MoreUtils qw/uniq/;
32 use Carp qw/croak carp shortmess/;
34 BEGIN { require 5.008004; }
36 has stack => (is => 'ro', default => sub { [] });
37 has stash => (is => 'rw', default => sub { {} });
38 has state => (is => 'rw', default => 0);
39 has stats => (is => 'rw');
40 has action => (is => 'rw');
41 has counter => (is => 'rw', default => sub { {} });
42 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
43 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
44 has namespace => (is => 'rw');
46 sub depth { scalar @{ shift->stack || [] }; }
47 sub comp { shift->component(@_) }
50 my $self = shift; return $self->request(@_);
53 my $self = shift; return $self->response(@_);
56 # For backwards compatibility
57 sub finalize_output { shift->finalize_body(@_) };
62 our $RECURSION = 1000;
63 our $DETACH = Catalyst::Exception::Detach->new;
64 our $GO = Catalyst::Exception::Go->new;
66 #I imagine that very few of these really need to be class variables. if any.
67 #maybe we should just make them attributes with a default?
68 __PACKAGE__->mk_classdata($_)
69 for qw/components arguments dispatcher engine log dispatcher_class
70 engine_class context_class request_class response_class stats_class
73 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
74 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
75 __PACKAGE__->request_class('Catalyst::Request');
76 __PACKAGE__->response_class('Catalyst::Response');
77 __PACKAGE__->stats_class('Catalyst::Stats');
79 # Remember to update this in Catalyst::Runtime as well!
81 our $VERSION = '5.80016';
82 $VERSION = eval $VERSION;
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);
95 unless ( $caller->isa('Catalyst') ) {
96 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
97 $meta->superclasses(@superclasses);
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
106 $caller->arguments( [@arguments] );
110 sub _application { $_[0] }
114 Catalyst - The Elegant MVC Web Application Framework
118 See the L<Catalyst::Manual> distribution for comprehensive
119 documentation and tutorials.
121 # Install Catalyst::Devel for helpers and other development tools
122 # use the helper to create a new application
125 # add models, views, controllers
126 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
127 script/myapp_create.pl view MyTemplate TT
128 script/myapp_create.pl controller Search
130 # built in testserver -- use -r to restart automatically on changes
131 # --help to see all available options
132 script/myapp_server.pl
134 # command line testing interface
135 script/myapp_test.pl /yada
138 use Catalyst qw/-Debug/; # include plugins here as well
140 ### In lib/MyApp/Controller/Root.pm (autocreated)
141 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
142 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
143 $c->stash->{template} = 'foo.tt'; # set the template
144 # lookup something from db -- stash vars are passed to TT
146 $c->model('Database::Foo')->search( { country => $args[0] } );
147 if ( $c->req->params->{bar} ) { # access GET or POST parameters
148 $c->forward( 'bar' ); # process another action
149 # do something else after forward returns
153 # The foo.tt TT template can use the stash data from the database
154 [% WHILE (item = data.next) %]
158 # called for /bar/of/soap, /bar/of/soap/10, etc.
159 sub bar : Path('/bar/of/soap') { ... }
161 # called for all actions, from the top-most controller downwards
163 my ( $self, $c ) = @_;
164 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
165 $c->res->redirect( '/login' ); # require login
166 return 0; # abort request and go immediately to end()
168 return 1; # success; carry on to next action
171 # called after all actions are finished
173 my ( $self, $c ) = @_;
174 if ( scalar @{ $c->error } ) { ... } # handle errors
175 return if $c->res->body; # already have a response
176 $c->forward( 'MyApp::View::TT' ); # render template
179 ### in MyApp/Controller/Foo.pm
180 # called for /foo/bar
181 sub bar : Local { ... }
183 # called for /blargle
184 sub blargle : Global { ... }
186 # an index action matches /foo, but not /foo/1, etc.
187 sub index : Private { ... }
189 ### in MyApp/Controller/Foo/Bar.pm
190 # called for /foo/bar/baz
191 sub baz : Local { ... }
193 # first Root auto is called, then Foo auto, then this
194 sub auto : Private { ... }
196 # powerful regular expression paths are also possible
197 sub details : Regex('^product/(\w+)/details$') {
198 my ( $self, $c ) = @_;
199 # extract the (\w+) from the URI
200 my $product = $c->req->captures->[0];
203 See L<Catalyst::Manual::Intro> for additional information.
207 Catalyst is a modern framework for making web applications without the
208 pain usually associated with this process. This document is a reference
209 to the main Catalyst application. If you are a new user, we suggest you
210 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
212 See L<Catalyst::Manual> for more documentation.
214 Catalyst plugins can be loaded by naming them as arguments to the "use
215 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
216 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
219 use Catalyst qw/My::Module/;
221 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
222 fully qualify the name by using a unary plus:
226 +Fully::Qualified::Plugin::Name
229 Special flags like C<-Debug> and C<-Engine> can also be specified as
230 arguments when Catalyst is loaded:
232 use Catalyst qw/-Debug My::Module/;
234 The position of plugins and flags in the chain is important, because
235 they are loaded in the order in which they appear.
237 The following flags are supported:
241 Enables debug output. You can also force this setting from the system
242 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
243 settings override the application, with <MYAPP>_DEBUG having the highest
248 Forces Catalyst to use a specific engine. Omit the
249 C<Catalyst::Engine::> prefix of the engine name, i.e.:
251 use Catalyst qw/-Engine=CGI/;
255 Forces Catalyst to use a specific home directory, e.g.:
257 use Catalyst qw[-Home=/usr/mst];
259 This can also be done in the shell environment by setting either the
260 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
261 is replaced with the uppercased name of your application, any "::" in
262 the name will be replaced with underscores, e.g. MyApp::Web should use
263 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
267 use Catalyst '-Log=warn,fatal,error';
269 Specifies a comma-delimited list of log levels.
273 Enables statistics collection and reporting. You can also force this setting
274 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
275 environment settings override the application, with <MYAPP>_STATS having the
280 use Catalyst qw/-Stats=1/
284 =head2 INFORMATION ABOUT THE CURRENT REQUEST
288 Returns a L<Catalyst::Action> object for the current action, which
289 stringifies to the action name. See L<Catalyst::Action>.
293 Returns the namespace of the current action, i.e., the URI prefix
294 corresponding to the controller of the current action. For example:
296 # in Controller::Foo::Bar
297 $c->namespace; # returns 'foo/bar';
303 Returns the current L<Catalyst::Request> object, giving access to
304 information about the current client request (including parameters,
305 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
307 =head2 REQUEST FLOW HANDLING
309 =head2 $c->forward( $action [, \@arguments ] )
311 =head2 $c->forward( $class, $method, [, \@arguments ] )
313 Forwards processing to another action, by its private name. If you give a
314 class name but no method, C<process()> is called. You may also optionally
315 pass arguments in an arrayref. The action will receive the arguments in
316 C<@_> and C<< $c->req->args >>. Upon returning from the function,
317 C<< $c->req->args >> will be restored to the previous values.
319 Any data C<return>ed from the action forwarded to, will be returned by the
322 my $foodata = $c->forward('/foo');
323 $c->forward('index');
324 $c->forward(qw/Model::DBIC::Foo do_stuff/);
325 $c->forward('View::TT');
327 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
328 an C<< eval { } >> around the call (actually
329 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
330 all 'dies' within the called action. If you want C<die> to propagate you
331 need to do something like:
334 die $c->error if $c->error;
336 Or make sure to always return true values from your actions and write
339 $c->forward('foo') || return;
341 Another note is that C<< $c->forward >> always returns a scalar because it
342 actually returns $c->state which operates in a scalar context.
343 Thus, something like:
347 in an action that is forwarded to is going to return a scalar,
348 i.e. how many items are in that array, which is probably not what you want.
349 If you need to return an array then return a reference to it,
352 $c->stash->{array} = \@array;
354 and access it from the stash.
358 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
360 =head2 $c->detach( $action [, \@arguments ] )
362 =head2 $c->detach( $class, $method, [, \@arguments ] )
366 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
367 doesn't return to the previous action when processing is finished.
369 When called with no arguments it escapes the processing chain entirely.
373 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
375 =head2 $c->visit( $action [, \@captures, \@arguments ] )
377 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
379 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
380 but does a full dispatch, instead of just calling the new C<$action> /
381 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
382 you go to are called, just like a new request.
384 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
385 This means, for example, that C<< $c->action >> methods such as
386 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
387 L<reverse|Catalyst::Action/reverse> return information for the visited action
388 when they are invoked within the visited action. This is different from the
389 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
390 continues to use the $c->action object from the caller action even when
391 invoked from the callee.
393 C<< $c->stash >> is kept unchanged.
395 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
396 allows you to "wrap" another action, just as it would have been called by
397 dispatching from a URL, while the analogous
398 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
399 transfer control to another action as if it had been reached directly from a URL.
403 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
405 =head2 $c->go( $action [, \@captures, \@arguments ] )
407 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
409 The relationship between C<go> and
410 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
411 the relationship between
412 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
413 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
414 C<< $c->go >> will perform a full dispatch on the specified action or method,
415 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
416 C<go> escapes the processing of the current request chain on completion, and
417 does not return to its caller.
421 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
427 Returns the current L<Catalyst::Response> object, see there for details.
431 Returns a hashref to the stash, which may be used to store data and pass
432 it between components during a request. You can also set hash keys by
433 passing arguments. The stash is automatically sent to the view. The
434 stash is cleared at the end of a request; it cannot be used for
435 persistent storage (for this you must use a session; see
436 L<Catalyst::Plugin::Session> for a complete system integrated with
439 $c->stash->{foo} = $bar;
440 $c->stash( { moose => 'majestic', qux => 0 } );
441 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
443 # stash is automatically passed to the view for use in a template
444 $c->forward( 'MyApp::View::TT' );
448 around stash => sub {
451 my $stash = $orig->($c);
453 my $new_stash = @_ > 1 ? {@_} : $_[0];
454 croak('stash takes a hash or hashref') unless ref $new_stash;
455 foreach my $key ( keys %$new_stash ) {
456 $stash->{$key} = $new_stash->{$key};
466 =head2 $c->error($error, ...)
468 =head2 $c->error($arrayref)
470 Returns an arrayref containing error messages. If Catalyst encounters an
471 error while processing a request, it stores the error in $c->error. This
472 method should only be used to store fatal error messages.
474 my @error = @{ $c->error };
478 $c->error('Something bad happened');
485 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
486 croak @$error unless ref $c;
487 push @{ $c->{error} }, @$error;
489 elsif ( defined $_[0] ) { $c->{error} = undef }
490 return $c->{error} || [];
496 Contains the return value of the last executed action.
497 Note that << $c->state >> operates in a scalar context which means that all
498 values it returns are scalar.
500 =head2 $c->clear_errors
502 Clear errors. You probably don't want to clear the errors unless you are
503 implementing a custom error screen.
505 This is equivalent to running
516 sub _comp_search_prefixes {
518 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
521 # search components given a name and some prefixes
522 sub _comp_names_search_prefixes {
523 my ( $c, $name, @prefixes ) = @_;
524 my $appclass = ref $c || $c;
525 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
526 $filter = qr/$filter/; # Compile regex now rather than once per loop
528 # map the original component name to the sub part that we will search against
529 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
530 grep { /$filter/ } keys %{ $c->components };
532 # undef for a name will return all
533 return keys %eligible if !defined $name;
535 my $query = ref $name ? $name : qr/^$name$/i;
536 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
538 return @result if @result;
540 # if we were given a regexp to search against, we're done.
543 # skip regexp fallback if configured
545 if $appclass->config->{disable_component_resolution_regex_fallback};
549 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
551 # no results? try against full names
553 @result = grep { m{$query} } keys %eligible;
556 # don't warn if we didn't find any results, it just might not exist
558 # Disgusting hack to work out correct method name
559 my $warn_for = lc $prefixes[0];
560 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
561 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
562 "component resolution is unreliable and unsafe.";
563 my $short = $result[0];
564 # remove the component namespace prefix
565 $short =~ s/.*?(Model|Controller|View):://;
566 my $shortmess = Carp::shortmess('');
567 if ($shortmess =~ m#Catalyst/Plugin#) {
568 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
570 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
571 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
572 "component's config";
574 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
575 "but if you really wanted to search, pass in a regexp as the argument " .
576 "like so: \$c->${warn_for}(qr/${name}/)";
578 $c->log->warn( "${msg}$shortmess" );
584 # Find possible names for a prefix
586 my ( $c, @prefixes ) = @_;
587 my $appclass = ref $c || $c;
589 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
591 my @names = map { s{$filter}{}; $_; }
592 $c->_comp_names_search_prefixes( undef, @prefixes );
597 # Filter a component before returning by calling ACCEPT_CONTEXT if available
598 sub _filter_component {
599 my ( $c, $comp, @args ) = @_;
601 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
602 return $comp->ACCEPT_CONTEXT( $c, @args );
608 =head2 COMPONENT ACCESSORS
610 =head2 $c->controller($name)
612 Gets a L<Catalyst::Controller> instance by name.
614 $c->controller('Foo')->do_stuff;
616 If the name is omitted, will return the controller for the dispatched
619 If you want to search for controllers, pass in a regexp as the argument.
621 # find all controllers that start with Foo
622 my @foo_controllers = $c->controller(qr{^Foo});
628 my ( $c, $name, @args ) = @_;
631 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
632 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
633 return $c->_filter_component( $result[ 0 ], @args );
636 return $c->component( $c->action->class );
639 =head2 $c->model($name)
641 Gets a L<Catalyst::Model> instance by name.
643 $c->model('Foo')->do_stuff;
645 Any extra arguments are directly passed to ACCEPT_CONTEXT.
647 If the name is omitted, it will look for
648 - a model object in $c->stash->{current_model_instance}, then
649 - a model name in $c->stash->{current_model}, then
650 - a config setting 'default_model', or
651 - check if there is only one model, and return it if that's the case.
653 If you want to search for models, pass in a regexp as the argument.
655 # find all models that start with Foo
656 my @foo_models = $c->model(qr{^Foo});
661 my ( $c, $name, @args ) = @_;
662 my $appclass = ref($c) || $c;
664 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
665 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
666 return $c->_filter_component( $result[ 0 ], @args );
670 return $c->stash->{current_model_instance}
671 if $c->stash->{current_model_instance};
672 return $c->model( $c->stash->{current_model} )
673 if $c->stash->{current_model};
675 return $c->model( $appclass->config->{default_model} )
676 if $appclass->config->{default_model};
678 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
681 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
682 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
683 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
684 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
685 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
688 return $c->_filter_component( $comp );
692 =head2 $c->view($name)
694 Gets a L<Catalyst::View> instance by name.
696 $c->view('Foo')->do_stuff;
698 Any extra arguments are directly passed to ACCEPT_CONTEXT.
700 If the name is omitted, it will look for
701 - a view object in $c->stash->{current_view_instance}, then
702 - a view name in $c->stash->{current_view}, then
703 - a config setting 'default_view', or
704 - check if there is only one view, and return it if that's the case.
706 If you want to search for views, pass in a regexp as the argument.
708 # find all views that start with Foo
709 my @foo_views = $c->view(qr{^Foo});
714 my ( $c, $name, @args ) = @_;
716 my $appclass = ref($c) || $c;
718 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
719 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
720 return $c->_filter_component( $result[ 0 ], @args );
724 return $c->stash->{current_view_instance}
725 if $c->stash->{current_view_instance};
726 return $c->view( $c->stash->{current_view} )
727 if $c->stash->{current_view};
729 return $c->view( $appclass->config->{default_view} )
730 if $appclass->config->{default_view};
732 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
735 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
736 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
737 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
738 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
739 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
742 return $c->_filter_component( $comp );
745 =head2 $c->controllers
747 Returns the available names which can be passed to $c->controller
753 return $c->_comp_names(qw/Controller C/);
758 Returns the available names which can be passed to $c->model
764 return $c->_comp_names(qw/Model M/);
770 Returns the available names which can be passed to $c->view
776 return $c->_comp_names(qw/View V/);
779 =head2 $c->comp($name)
781 =head2 $c->component($name)
783 Gets a component object by name. This method is not recommended,
784 unless you want to get a specific component by full
785 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
786 should be used instead.
788 If C<$name> is a regexp, a list of components matched against the full
789 component name will be returned.
791 If Catalyst can't find a component by name, it will fallback to regex
792 matching by default. To disable this behaviour set
793 disable_component_resolution_regex_fallback to a true value.
795 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
800 my ( $c, $name, @args ) = @_;
803 my $comps = $c->components;
806 # is it the exact name?
807 return $c->_filter_component( $comps->{ $name }, @args )
808 if exists $comps->{ $name };
810 # perhaps we just omitted "MyApp"?
811 my $composed = ( ref $c || $c ) . "::${name}";
812 return $c->_filter_component( $comps->{ $composed }, @args )
813 if exists $comps->{ $composed };
815 # search all of the models, views and controllers
816 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
817 return $c->_filter_component( $comp, @args ) if $comp;
820 # This is here so $c->comp( '::M::' ) works
821 my $query = ref $name ? $name : qr{$name}i;
823 my @result = grep { m{$query} } keys %{ $c->components };
824 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
827 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
828 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
829 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
830 return $c->_filter_component( $result[ 0 ], @args );
833 # I would expect to return an empty list here, but that breaks back-compat
837 return sort keys %{ $c->components };
840 =head2 CLASS DATA AND HELPER CLASSES
844 Returns or takes a hashref containing the application's configuration.
846 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
848 You can also use a C<YAML>, C<XML> or L<Config::General> config file
849 like C<myapp.conf> in your applications home directory. See
850 L<Catalyst::Plugin::ConfigLoader>.
852 =head3 Cascading configuration
854 The config method is present on all Catalyst components, and configuration
855 will be merged when an application is started. Configuration loaded with
856 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
857 followed by configuration in your top level C<MyApp> class. These two
858 configurations are merged, and then configuration data whose hash key matches a
859 component name is merged with configuration for that component.
861 The configuration for a component is then passed to the C<new> method when a
862 component is constructed.
866 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
867 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
869 will mean that C<MyApp::Model::Foo> receives the following data when
872 MyApp::Model::Foo->new({
880 around config => sub {
884 croak('Setting config after setup has been run is not allowed.')
885 if ( @_ and $c->setup_finished );
892 Returns the logging object instance. Unless it is already set, Catalyst
893 sets this up with a L<Catalyst::Log> object. To use your own log class,
894 set the logger with the C<< __PACKAGE__->log >> method prior to calling
895 C<< __PACKAGE__->setup >>.
897 __PACKAGE__->log( MyLogger->new );
902 $c->log->info( 'Now logging with my own logger!' );
904 Your log class should implement the methods described in
910 Returns 1 if debug mode is enabled, 0 otherwise.
912 You can enable debug mode in several ways:
916 =item By calling myapp_server.pl with the -d flag
918 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
920 =item The -Debug option in your MyApp.pm
922 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
926 Calling C<< $c->debug(1) >> has no effect.
932 =head2 $c->dispatcher
934 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
938 Returns the engine instance. See L<Catalyst::Engine>.
941 =head2 UTILITY METHODS
943 =head2 $c->path_to(@path)
945 Merges C<@path> with C<< $c->config->{home} >> and returns a
946 L<Path::Class::Dir> object. Note you can usually use this object as
947 a filename, but sometimes you will have to explicitly stringify it
948 yourself by calling the C<< ->stringify >> method.
952 $c->path_to( 'db', 'sqlite.db' );
957 my ( $c, @path ) = @_;
958 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
959 if ( -d $path ) { return $path }
960 else { return Path::Class::File->new( $c->config->{home}, @path ) }
963 =head2 $c->plugin( $name, $class, @args )
965 Helper method for plugins. It creates a class data accessor/mutator and
966 loads and instantiates the given class.
968 MyApp->plugin( 'prototype', 'HTML::Prototype' );
970 $c->prototype->define_javascript_functions;
972 B<Note:> This method of adding plugins is deprecated. The ability
973 to add plugins like this B<will be removed> in a Catalyst 5.81.
974 Please do not use this functionality in new code.
979 my ( $class, $name, $plugin, @args ) = @_;
981 # See block comment in t/unit_core_plugin.t
982 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
984 $class->_register_plugin( $plugin, 1 );
986 eval { $plugin->import };
987 $class->mk_classdata($name);
989 eval { $obj = $plugin->new(@args) };
992 Catalyst::Exception->throw( message =>
993 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
997 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1003 Initializes the dispatcher and engine, loads any plugins, and loads the
1004 model, view, and controller components. You may also specify an array
1005 of plugins to load here, if you choose to not load them in the C<use
1009 MyApp->setup( qw/-Debug/ );
1014 my ( $class, @arguments ) = @_;
1015 croak('Running setup more than once')
1016 if ( $class->setup_finished );
1018 unless ( $class->isa('Catalyst') ) {
1020 Catalyst::Exception->throw(
1021 message => qq/'$class' does not inherit from Catalyst/ );
1024 if ( $class->arguments ) {
1025 @arguments = ( @arguments, @{ $class->arguments } );
1031 foreach (@arguments) {
1035 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1037 elsif (/^-(\w+)=?(.*)$/) {
1038 $flags->{ lc $1 } = $2;
1041 push @{ $flags->{plugins} }, $_;
1045 $class->setup_home( delete $flags->{home} );
1047 $class->setup_log( delete $flags->{log} );
1048 $class->setup_plugins( delete $flags->{plugins} );
1049 $class->setup_dispatcher( delete $flags->{dispatcher} );
1050 $class->setup_engine( delete $flags->{engine} );
1051 $class->setup_stats( delete $flags->{stats} );
1053 for my $flag ( sort keys %{$flags} ) {
1055 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1056 &$code( $class, delete $flags->{$flag} );
1059 $class->log->warn(qq/Unknown flag "$flag"/);
1063 eval { require Catalyst::Devel; };
1064 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1065 $class->log->warn(<<"EOF");
1066 You are running an old script!
1068 Please update by running (this will overwrite existing files):
1069 catalyst.pl -force -scripts $class
1071 or (this will not overwrite existing files):
1072 catalyst.pl -scripts $class
1077 if ( $class->debug ) {
1078 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1081 my $column_width = Catalyst::Utils::term_width() - 6;
1082 my $t = Text::SimpleTable->new($column_width);
1083 $t->row($_) for @plugins;
1084 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1087 my $dispatcher = $class->dispatcher;
1088 my $engine = $class->engine;
1089 my $home = $class->config->{home};
1091 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1092 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1096 ? $class->log->debug(qq/Found home "$home"/)
1097 : $class->log->debug(qq/Home "$home" doesn't exist/)
1098 : $class->log->debug(q/Couldn't find home/);
1101 # Call plugins setup, this is stupid and evil.
1102 # Also screws C3 badly on 5.10, hack to avoid.
1104 no warnings qw/redefine/;
1105 local *setup = sub { };
1106 $class->setup unless $Catalyst::__AM_RESTARTING;
1109 # Initialize our data structure
1110 $class->components( {} );
1112 $class->setup_components;
1114 if ( $class->debug ) {
1115 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1116 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1117 for my $comp ( sort keys %{ $class->components } ) {
1118 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1119 $t->row( $comp, $type );
1121 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1122 if ( keys %{ $class->components } );
1125 # Add our self to components, since we are also a component
1126 if( $class->isa('Catalyst::Controller') ){
1127 $class->components->{$class} = $class;
1130 $class->setup_actions;
1132 if ( $class->debug ) {
1133 my $name = $class->config->{name} || 'Application';
1134 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1137 # Make sure that the application class becomes immutable at this point,
1138 B::Hooks::EndOfScope::on_scope_end {
1140 my $meta = Class::MOP::get_metaclass_by_name($class);
1143 && ! { $meta->immutable_options }->{replace_constructor}
1145 $class->isa('Class::Accessor::Fast')
1146 || $class->isa('Class::Accessor')
1149 warn "You made your application class ($class) immutable, "
1150 . "but did not inline the\nconstructor. "
1151 . "This will break catalyst, as your app \@ISA "
1152 . "Class::Accessor(::Fast)?\nPlease pass "
1153 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1155 $meta->make_immutable(
1156 replace_constructor => 1,
1157 ) unless $meta->is_immutable;
1160 if ($class->config->{case_sensitive}) {
1161 $class->log->warn($class . "->config->{case_sensitive} is set.");
1162 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1165 $class->setup_finalize;
1166 # Should be the last thing we do so that user things hooking
1167 # setup_finalize can log..
1168 $class->log->_flush() if $class->log->can('_flush');
1169 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1173 =head2 $app->setup_finalize
1175 A hook to attach modifiers to.
1176 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1177 Also better than C< setup_finished(); >, as that is a getter method.
1179 sub setup_finalize {
1183 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1185 $app->next::method(@_);
1192 sub setup_finalize {
1194 $class->setup_finished(1);
1197 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1199 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1201 Constructs an absolute L<URI> object based on the application root, the
1202 provided path, and the additional arguments and query parameters provided.
1203 When used as a string, provides a textual URI.
1205 If no arguments are provided, the URI for the current action is returned.
1206 To return the current action and also provide @args, use
1207 C<< $c->uri_for( $c->action, @args ) >>.
1209 If the first argument is a string, it is taken as a public URI path relative
1210 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1211 relative to the application root (if it does). It is then merged with
1212 C<< $c->request->base >>; any C<@args> are appended as additional path
1213 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1215 If the first argument is a L<Catalyst::Action> it represents an action which
1216 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1217 optional C<\@captures> argument (an arrayref) allows passing the captured
1218 variables that are needed to fill in the paths of Chained and Regex actions;
1219 once the path is resolved, C<uri_for> continues as though a path was
1220 provided, appending any arguments or parameters and creating an absolute
1223 The captures for the current request can be found in
1224 C<< $c->request->captures >>, and actions can be resolved using
1225 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1226 path, use C<< $c->uri_for_action >> instead.
1228 # Equivalent to $c->req->uri
1229 $c->uri_for($c->action, $c->req->captures,
1230 @{ $c->req->args }, $c->req->params);
1232 # For the Foo action in the Bar controller
1233 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1235 # Path to a static resource
1236 $c->uri_for('/static/images/logo.png');
1241 my ( $c, $path, @args ) = @_;
1243 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1244 $path = $path->path_prefix;
1249 if ( blessed($path) ) { # action object
1250 my $captures = [ map { s|/|%2F|; $_; }
1251 ( scalar @args && ref $args[0] eq 'ARRAY'
1255 foreach my $capture (@$captures) {
1256 utf8::encode($capture) if utf8::is_utf8($capture);
1257 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1261 $path = $c->dispatcher->uri_for_action($action, $captures);
1262 if (not defined $path) {
1263 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1267 $path = '/' if $path eq '';
1270 undef($path) if (defined $path && $path eq '');
1273 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1275 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1277 foreach my $arg (@args) {
1278 utf8::encode($arg) if utf8::is_utf8($arg);
1280 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1283 unshift(@args, $path);
1285 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1286 my $namespace = $c->namespace;
1287 if (defined $path) { # cheesy hack to handle path '../foo'
1288 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1290 unshift(@args, $namespace || '');
1293 # join args with '/', or a blank string
1294 my $args = join('/', grep { defined($_) } @args);
1295 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1297 my $base = $c->req->base;
1298 my $class = ref($base);
1299 $base =~ s{(?<!/)$}{/};
1303 if (my @keys = keys %$params) {
1304 # somewhat lifted from URI::_query's query_form
1305 $query = '?'.join('&', map {
1306 my $val = $params->{$_};
1307 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1310 $val = '' unless defined $val;
1313 utf8::encode( $param ) if utf8::is_utf8($param);
1314 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1316 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1320 my $res = bless(\"${base}${args}${query}", $class);
1324 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1326 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1332 A private path to the Catalyst action you want to create a URI for.
1334 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1335 >> and passing the resulting C<$action> and the remaining arguments to C<<
1338 You can also pass in a Catalyst::Action object, in which case it is passed to
1345 sub uri_for_action {
1346 my ( $c, $path, @args ) = @_;
1347 my $action = blessed($path)
1349 : $c->dispatcher->get_action_by_path($path);
1350 unless (defined $action) {
1351 croak "Can't find action for path '$path'";
1353 return $c->uri_for( $action, @args );
1356 =head2 $c->welcome_message
1358 Returns the Catalyst welcome HTML page.
1362 sub welcome_message {
1364 my $name = $c->config->{name};
1365 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1366 my $prefix = Catalyst::Utils::appprefix( ref $c );
1367 $c->response->content_type('text/html; charset=utf-8');
1369 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1370 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1371 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1373 <meta http-equiv="Content-Language" content="en" />
1374 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1375 <title>$name on Catalyst $VERSION</title>
1376 <style type="text/css">
1379 background-color: #eee;
1386 margin-bottom: 10px;
1388 background-color: #ccc;
1389 border: 1px solid #aaa;
1394 font-family: verdana, tahoma, sans-serif;
1397 font-family: verdana, tahoma, sans-serif;
1400 text-decoration: none;
1402 border-bottom: 1px dotted #bbb;
1404 :link:hover, :visited:hover {
1417 background-color: #fff;
1418 border: 1px solid #aaa;
1422 font-weight: normal;
1444 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1449 <img src="$logo" alt="Catalyst Logo" />
1451 <p>Welcome to the world of Catalyst.
1452 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1453 framework will make web development something you had
1454 never expected it to be: Fun, rewarding, and quick.</p>
1455 <h2>What to do now?</h2>
1456 <p>That really depends on what <b>you</b> want to do.
1457 We do, however, provide you with a few starting points.</p>
1458 <p>If you want to jump right into web development with Catalyst
1459 you might want to start with a tutorial.</p>
1460 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1462 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1464 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1465 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1467 <h2>What to do next?</h2>
1468 <p>Next it's time to write an actual application. Use the
1469 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1470 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1471 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1472 they can save you a lot of work.</p>
1473 <pre><code>script/${prefix}_create.pl -help</code></pre>
1474 <p>Also, be sure to check out the vast and growing
1475 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1476 you are likely to find what you need there.
1480 <p>Catalyst has a very active community. Here are the main places to
1481 get in touch with us.</p>
1484 <a href="http://dev.catalyst.perl.org">Wiki</a>
1487 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1490 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1493 <h2>In conclusion</h2>
1494 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1495 as we enjoyed making it. Please contact us if you have ideas
1496 for improvement or other feedback.</p>
1504 =head1 INTERNAL METHODS
1506 These methods are not meant to be used by end users.
1508 =head2 $c->components
1510 Returns a hash of components.
1512 =head2 $c->context_class
1514 Returns or sets the context class.
1518 Returns a hashref containing coderefs and execution counts (needed for
1519 deep recursion detection).
1523 Returns the number of actions on the current internal execution stack.
1527 Dispatches a request to actions.
1531 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1533 =head2 $c->dispatcher_class
1535 Returns or sets the dispatcher class.
1537 =head2 $c->dump_these
1539 Returns a list of 2-element array references (name, structure) pairs
1540 that will be dumped on the error page in debug mode.
1546 [ Request => $c->req ],
1547 [ Response => $c->res ],
1548 [ Stash => $c->stash ],
1549 [ Config => $c->config ];
1552 =head2 $c->engine_class
1554 Returns or sets the engine class.
1556 =head2 $c->execute( $class, $coderef )
1558 Execute a coderef in given class and catch exceptions. Errors are available
1564 my ( $c, $class, $code ) = @_;
1565 $class = $c->component($class) || $class;
1568 if ( $c->depth >= $RECURSION ) {
1569 my $action = $code->reverse();
1570 $action = "/$action" unless $action =~ /->/;
1571 my $error = qq/Deep recursion detected calling "${action}"/;
1572 $c->log->error($error);
1578 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1580 push( @{ $c->stack }, $code );
1582 no warnings 'recursion';
1583 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1585 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1587 my $last = pop( @{ $c->stack } );
1589 if ( my $error = $@ ) {
1590 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1591 $error->rethrow if $c->depth > 1;
1593 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1594 $error->rethrow if $c->depth > 0;
1597 unless ( ref $error ) {
1598 no warnings 'uninitialized';
1600 my $class = $last->class;
1601 my $name = $last->name;
1602 $error = qq/Caught exception in $class->$name "$error"/;
1611 sub _stats_start_execute {
1612 my ( $c, $code ) = @_;
1613 my $appclass = ref($c) || $c;
1614 return if ( ( $code->name =~ /^_.*/ )
1615 && ( !$appclass->config->{show_internal_actions} ) );
1617 my $action_name = $code->reverse();
1618 $c->counter->{$action_name}++;
1620 my $action = $action_name;
1621 $action = "/$action" unless $action =~ /->/;
1623 # determine if the call was the result of a forward
1624 # this is done by walking up the call stack and looking for a calling
1625 # sub of Catalyst::forward before the eval
1627 for my $index ( 2 .. 11 ) {
1629 if ( ( caller($index) )[0] eq 'Catalyst'
1630 && ( caller($index) )[3] eq '(eval)' );
1632 if ( ( caller($index) )[3] =~ /forward$/ ) {
1633 $callsub = ( caller($index) )[3];
1634 $action = "-> $action";
1639 my $uid = $action_name . $c->counter->{$action_name};
1641 # is this a root-level call or a forwarded call?
1642 if ( $callsub =~ /forward$/ ) {
1643 my $parent = $c->stack->[-1];
1645 # forward, locate the caller
1646 if ( exists $c->counter->{"$parent"} ) {
1649 parent => "$parent" . $c->counter->{"$parent"},
1655 # forward with no caller may come from a plugin
1674 sub _stats_finish_execute {
1675 my ( $c, $info ) = @_;
1676 $c->stats->profile( end => $info );
1681 Finalizes the request.
1688 for my $error ( @{ $c->error } ) {
1689 $c->log->error($error);
1692 # Allow engine to handle finalize flow (for POE)
1693 my $engine = $c->engine;
1694 if ( my $code = $engine->can('finalize') ) {
1699 $c->finalize_uploads;
1702 if ( $#{ $c->error } >= 0 ) {
1706 $c->finalize_headers;
1709 if ( $c->request->method eq 'HEAD' ) {
1710 $c->response->body('');
1716 if ($c->use_stats) {
1717 my $elapsed = sprintf '%f', $c->stats->elapsed;
1718 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1720 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1723 return $c->response->status;
1726 =head2 $c->finalize_body
1732 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1734 =head2 $c->finalize_cookies
1740 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1742 =head2 $c->finalize_error
1748 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1750 =head2 $c->finalize_headers
1756 sub finalize_headers {
1759 my $response = $c->response; #accessor calls can add up?
1761 # Check if we already finalized headers
1762 return if $response->finalized_headers;
1765 if ( my $location = $response->redirect ) {
1766 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1767 $response->header( Location => $location );
1769 if ( !$response->has_body ) {
1770 # Add a default body if none is already present
1772 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1778 if ( $response->body && !$response->content_length ) {
1780 # get the length from a filehandle
1781 if ( blessed( $response->body ) && $response->body->can('read') )
1783 my $stat = stat $response->body;
1784 if ( $stat && $stat->size > 0 ) {
1785 $response->content_length( $stat->size );
1788 $c->log->warn('Serving filehandle without a content-length');
1792 # everything should be bytes at this point, but just in case
1793 $response->content_length( length( $response->body ) );
1798 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1799 $response->headers->remove_header("Content-Length");
1800 $response->body('');
1803 $c->finalize_cookies;
1805 $c->engine->finalize_headers( $c, @_ );
1808 $response->finalized_headers(1);
1811 =head2 $c->finalize_output
1813 An alias for finalize_body.
1815 =head2 $c->finalize_read
1817 Finalizes the input after reading is complete.
1821 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1823 =head2 $c->finalize_uploads
1825 Finalizes uploads. Cleans up any temporary files.
1829 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1831 =head2 $c->get_action( $action, $namespace )
1833 Gets an action in a given namespace.
1837 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1839 =head2 $c->get_actions( $action, $namespace )
1841 Gets all actions of a given name in a namespace and all parent
1846 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1848 =head2 $c->handle_request( $class, @arguments )
1850 Called to handle each HTTP request.
1854 sub handle_request {
1855 my ( $class, @arguments ) = @_;
1857 # Always expect worst case!
1860 if ($class->debug) {
1861 my $secs = time - $START || 1;
1862 my $av = sprintf '%.3f', $COUNT / $secs;
1863 my $time = localtime time;
1864 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1867 my $c = $class->prepare(@arguments);
1869 $status = $c->finalize;
1872 if ( my $error = $@ ) {
1874 $class->log->error(qq/Caught exception in engine "$error"/);
1879 if(my $coderef = $class->log->can('_flush')){
1880 $class->log->$coderef();
1885 =head2 $c->prepare( @arguments )
1887 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1893 my ( $class, @arguments ) = @_;
1896 # After the app/ctxt split, this should become an attribute based on something passed
1897 # into the application.
1898 $class->context_class( ref $class || $class ) unless $class->context_class;
1900 my $c = $class->context_class->new({});
1902 # For on-demand data
1903 $c->request->_context($c);
1904 $c->response->_context($c);
1906 #surely this is not the most efficient way to do things...
1907 $c->stats($class->stats_class->new)->enable($c->use_stats);
1909 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1912 #XXX reuse coderef from can
1913 # Allow engine to direct the prepare flow (for POE)
1914 if ( $c->engine->can('prepare') ) {
1915 $c->engine->prepare( $c, @arguments );
1918 $c->prepare_request(@arguments);
1919 $c->prepare_connection;
1920 $c->prepare_query_parameters;
1921 $c->prepare_headers;
1922 $c->prepare_cookies;
1925 # Prepare the body for reading, either by prepare_body
1926 # or the user, if they are using $c->read
1929 # Parse the body unless the user wants it on-demand
1930 unless ( ref($c)->config->{parse_on_demand} ) {
1935 my $method = $c->req->method || '';
1936 my $path = $c->req->path;
1937 $path = '/' unless length $path;
1938 my $address = $c->req->address || '';
1940 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1948 =head2 $c->prepare_action
1950 Prepares action. See L<Catalyst::Dispatcher>.
1954 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1956 =head2 $c->prepare_body
1958 Prepares message body.
1965 return if $c->request->_has_body;
1967 # Initialize on-demand data
1968 $c->engine->prepare_body( $c, @_ );
1969 $c->prepare_parameters;
1970 $c->prepare_uploads;
1972 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1973 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1974 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1975 my $param = $c->req->body_parameters->{$key};
1976 my $value = defined($param) ? $param : '';
1978 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1980 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1984 =head2 $c->prepare_body_chunk( $chunk )
1986 Prepares a chunk of data before sending it to L<HTTP::Body>.
1988 See L<Catalyst::Engine>.
1992 sub prepare_body_chunk {
1994 $c->engine->prepare_body_chunk( $c, @_ );
1997 =head2 $c->prepare_body_parameters
1999 Prepares body parameters.
2003 sub prepare_body_parameters {
2005 $c->engine->prepare_body_parameters( $c, @_ );
2008 =head2 $c->prepare_connection
2010 Prepares connection.
2014 sub prepare_connection {
2016 $c->engine->prepare_connection( $c, @_ );
2019 =head2 $c->prepare_cookies
2025 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2027 =head2 $c->prepare_headers
2033 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2035 =head2 $c->prepare_parameters
2037 Prepares parameters.
2041 sub prepare_parameters {
2043 $c->prepare_body_parameters;
2044 $c->engine->prepare_parameters( $c, @_ );
2047 =head2 $c->prepare_path
2049 Prepares path and base.
2053 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2055 =head2 $c->prepare_query_parameters
2057 Prepares query parameters.
2061 sub prepare_query_parameters {
2064 $c->engine->prepare_query_parameters( $c, @_ );
2066 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2067 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2068 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2069 my $param = $c->req->query_parameters->{$key};
2070 my $value = defined($param) ? $param : '';
2072 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2074 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2078 =head2 $c->prepare_read
2080 Prepares the input for reading.
2084 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2086 =head2 $c->prepare_request
2088 Prepares the engine request.
2092 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2094 =head2 $c->prepare_uploads
2100 sub prepare_uploads {
2103 $c->engine->prepare_uploads( $c, @_ );
2105 if ( $c->debug && keys %{ $c->request->uploads } ) {
2106 my $t = Text::SimpleTable->new(
2107 [ 12, 'Parameter' ],
2112 for my $key ( sort keys %{ $c->request->uploads } ) {
2113 my $upload = $c->request->uploads->{$key};
2114 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2115 $t->row( $key, $u->filename, $u->type, $u->size );
2118 $c->log->debug( "File Uploads are:\n" . $t->draw );
2122 =head2 $c->prepare_write
2124 Prepares the output for writing.
2128 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2130 =head2 $c->request_class
2132 Returns or sets the request class.
2134 =head2 $c->response_class
2136 Returns or sets the response class.
2138 =head2 $c->read( [$maxlength] )
2140 Reads a chunk of data from the request body. This method is designed to
2141 be used in a while loop, reading C<$maxlength> bytes on every call.
2142 C<$maxlength> defaults to the size of the request if not specified.
2144 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2147 Warning: If you use read(), Catalyst will not process the body,
2148 so you will not be able to access POST parameters or file uploads via
2149 $c->request. You must handle all body parsing yourself.
2153 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2161 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2163 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2165 Sets an action in a given namespace.
2169 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2171 =head2 $c->setup_actions($component)
2173 Sets up actions for a component.
2177 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2179 =head2 $c->setup_components
2181 This method is called internally to set up the application's components.
2183 It finds modules by calling the L<locate_components> method, expands them to
2184 package names with the L<expand_component_module> method, and then installs
2185 each component into the application.
2187 The C<setup_components> config option is passed to both of the above methods.
2189 Installation of each component is performed by the L<setup_component> method,
2194 sub setup_components {
2197 my $config = $class->config->{ setup_components };
2199 my @comps = sort { length $a <=> length $b }
2200 $class->locate_components($config);
2201 my %comps = map { $_ => 1 } @comps;
2203 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2204 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2205 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2206 ) if $deprecatedcatalyst_component_names;
2208 for my $component ( @comps ) {
2210 # We pass ignore_loaded here so that overlay files for (e.g.)
2211 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2212 # we know M::P::O found a file on disk so this is safe
2214 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2216 # Needs to be done as soon as the component is loaded, as loading a sub-component
2217 # (next time round the loop) can cause us to get the wrong metaclass..
2218 $class->_controller_init_base_classes($component);
2221 for my $component (@comps) {
2222 $class->components->{ $component } = $class->setup_component($component);
2223 for my $component ($class->expand_component_module( $component, $config )) {
2224 next if $comps{$component};
2225 $class->_controller_init_base_classes($component); # Also cover inner packages
2226 $class->components->{ $component } = $class->setup_component($component);
2231 =head2 $c->locate_components( $setup_component_config )
2233 This method is meant to provide a list of component modules that should be
2234 setup for the application. By default, it will use L<Module::Pluggable>.
2236 Specify a C<setup_components> config option to pass additional options directly
2237 to L<Module::Pluggable>. To add additional search paths, specify a key named
2238 C<search_extra> as an array reference. Items in the array beginning with C<::>
2239 will have the application class name prepended to them.
2243 sub locate_components {
2247 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2248 my $extra = delete $config->{ search_extra } || [];
2250 push @paths, @$extra;
2252 my $locator = Module::Pluggable::Object->new(
2253 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2257 my @comps = $locator->plugins;
2262 =head2 $c->expand_component_module( $component, $setup_component_config )
2264 Components found by C<locate_components> will be passed to this method, which
2265 is expected to return a list of component (package) names to be set up.
2269 sub expand_component_module {
2270 my ($class, $module) = @_;
2271 return Devel::InnerPackage::list_packages( $module );
2274 =head2 $c->setup_component
2278 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2279 # nearest to Catalyst::Controller first, no matter what order stuff happens
2280 # to be loaded. There are TODO tests in Moose for this, see
2281 # f2391d17574eff81d911b97be15ea51080500003
2282 sub _controller_init_base_classes {
2283 my ($app_class, $component) = @_;
2284 return unless $component->isa('Catalyst::Controller');
2285 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2286 Moose::Meta::Class->initialize( $class )
2287 unless find_meta($class);
2291 sub setup_component {
2292 my( $class, $component ) = @_;
2294 unless ( $component->can( 'COMPONENT' ) ) {
2298 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2299 my $config = $class->config->{ $suffix } || {};
2300 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2301 # methods also pass it. local to avoid pointlessly shitting in config
2302 # for the debug screen, as $component is already the key name.
2303 local $config->{catalyst_component_name} = $component;
2305 my $instance = eval { $component->COMPONENT( $class, $config ); };
2307 if ( my $error = $@ ) {
2309 Catalyst::Exception->throw(
2310 message => qq/Couldn't instantiate component "$component", "$error"/
2314 unless (blessed $instance) {
2315 my $metaclass = Moose::Util::find_meta($component);
2316 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2317 my $component_method_from = $method_meta->associated_metaclass->name;
2318 my $value = defined($instance) ? $instance : 'undef';
2319 Catalyst::Exception->throw(
2321 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2327 =head2 $c->setup_dispatcher
2333 sub setup_dispatcher {
2334 my ( $class, $dispatcher ) = @_;
2337 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2340 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2341 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2344 unless ($dispatcher) {
2345 $dispatcher = $class->dispatcher_class;
2348 Class::MOP::load_class($dispatcher);
2350 # dispatcher instance
2351 $class->dispatcher( $dispatcher->new );
2354 =head2 $c->setup_engine
2361 my ( $class, $engine ) = @_;
2364 $engine = 'Catalyst::Engine::' . $engine;
2367 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2368 $engine = 'Catalyst::Engine::' . $env;
2371 if ( $ENV{MOD_PERL} ) {
2372 my $meta = Class::MOP::get_metaclass_by_name($class);
2374 # create the apache method
2375 $meta->add_method('apache' => sub { shift->engine->apache });
2377 my ( $software, $version ) =
2378 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2381 $version =~ s/(\.[^.]+)\./$1/g;
2383 if ( $software eq 'mod_perl' ) {
2387 if ( $version >= 1.99922 ) {
2388 $engine = 'Catalyst::Engine::Apache2::MP20';
2391 elsif ( $version >= 1.9901 ) {
2392 $engine = 'Catalyst::Engine::Apache2::MP19';
2395 elsif ( $version >= 1.24 ) {
2396 $engine = 'Catalyst::Engine::Apache::MP13';
2400 Catalyst::Exception->throw( message =>
2401 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2406 # install the correct mod_perl handler
2407 if ( $version >= 1.9901 ) {
2408 *handler = sub : method {
2409 shift->handle_request(@_);
2413 *handler = sub ($$) { shift->handle_request(@_) };
2418 elsif ( $software eq 'Zeus-Perl' ) {
2419 $engine = 'Catalyst::Engine::Zeus';
2423 Catalyst::Exception->throw(
2424 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2429 $engine = $class->engine_class;
2432 Class::MOP::load_class($engine);
2434 # check for old engines that are no longer compatible
2436 if ( $engine->isa('Catalyst::Engine::Apache')
2437 && !Catalyst::Engine::Apache->VERSION )
2442 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2443 && Catalyst::Engine::Server->VERSION le '0.02' )
2448 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2449 && $engine->VERSION eq '0.01' )
2454 elsif ($engine->isa('Catalyst::Engine::Zeus')
2455 && $engine->VERSION eq '0.01' )
2461 Catalyst::Exception->throw( message =>
2462 qq/Engine "$engine" is not supported by this version of Catalyst/
2467 $class->engine( $engine->new );
2470 =head2 $c->setup_home
2472 Sets up the home directory.
2477 my ( $class, $home ) = @_;
2479 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2483 $home ||= Catalyst::Utils::home($class);
2486 #I remember recently being scolded for assigning config values like this
2487 $class->config->{home} ||= $home;
2488 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2492 =head2 $c->setup_log
2494 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2495 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2498 This method also installs a C<debug> method that returns a true value into the
2499 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2500 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2502 Note that if the log has already been setup, by either a previous call to
2503 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2504 that this method won't actually set up the log object.
2509 my ( $class, $levels ) = @_;
2512 $levels =~ s/^\s+//;
2513 $levels =~ s/\s+$//;
2514 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2516 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2517 if ( defined $env_debug ) {
2518 $levels{debug} = 1 if $env_debug; # Ugly!
2519 delete($levels{debug}) unless $env_debug;
2522 unless ( $class->log ) {
2523 $class->log( Catalyst::Log->new(keys %levels) );
2526 if ( $levels{debug} ) {
2527 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2528 $class->log->debug('Debug messages enabled');
2532 =head2 $c->setup_plugins
2538 =head2 $c->setup_stats
2540 Sets up timing statistics class.
2545 my ( $class, $stats ) = @_;
2547 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2549 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2550 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2551 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2552 $class->log->debug('Statistics enabled');
2557 =head2 $c->registered_plugins
2559 Returns a sorted list of the plugins which have either been stated in the
2560 import list or which have been added via C<< MyApp->plugin(@args); >>.
2562 If passed a given plugin name, it will report a boolean value indicating
2563 whether or not that plugin is loaded. A fully qualified name is required if
2564 the plugin name does not begin with C<Catalyst::Plugin::>.
2566 if ($c->registered_plugins('Some::Plugin')) {
2574 sub registered_plugins {
2576 return sort keys %{ $proto->_plugins } unless @_;
2578 return 1 if exists $proto->_plugins->{$plugin};
2579 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2582 sub _register_plugin {
2583 my ( $proto, $plugin, $instant ) = @_;
2584 my $class = ref $proto || $proto;
2586 Class::MOP::load_class( $plugin );
2587 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2588 if $plugin->isa( 'Catalyst::Component' );
2589 $proto->_plugins->{$plugin} = 1;
2592 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2593 my @superclasses = ($plugin, $meta->superclasses );
2594 $meta->superclasses(@superclasses);
2596 unshift @{"$class\::ISA"}, $plugin;
2603 my ( $class, $plugins ) = @_;
2605 $class->_plugins( {} ) unless $class->_plugins;
2608 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2610 for my $plugin ( reverse @plugins ) {
2611 Class::MOP::load_class($plugin);
2612 my $meta = find_meta($plugin);
2613 next if $meta && $meta->isa('Moose::Meta::Role');
2615 $class->_register_plugin($plugin);
2620 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2621 map { find_meta($_) }
2624 Moose::Util::apply_all_roles(
2632 Returns an arrayref of the internal execution stack (actions that are
2633 currently executing).
2635 =head2 $c->stats_class
2637 Returns or sets the stats (timing statistics) class.
2639 =head2 $c->use_stats
2641 Returns 1 when stats collection is enabled. Stats collection is enabled
2642 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2643 environment variable is set.
2645 Note that this is a static method, not an accessor and should be overridden
2646 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2653 =head2 $c->write( $data )
2655 Writes $data to the output stream. When using this method directly, you
2656 will need to manually set the C<Content-Length> header to the length of
2657 your output data, if known.
2664 # Finalize headers if someone manually writes output
2665 $c->finalize_headers;
2667 return $c->engine->write( $c, @_ );
2672 Returns the Catalyst version number. Mostly useful for "powered by"
2673 messages in template systems.
2677 sub version { return $Catalyst::VERSION }
2679 =head1 CONFIGURATION
2681 There are a number of 'base' config variables which can be set:
2687 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2691 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2695 C<disable_component_resolution_regex_fallback> - Turns
2696 off the deprecated component resolution functionality so
2697 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2698 are called then regex search will not be attempted on string values and
2699 instead C<undef> will be returned.
2703 C<home> - The application home directory. In an uninstalled application,
2704 this is the top level application directory. In an installed application,
2705 this will be the directory containing C<< MyApp.pm >>.
2709 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2713 C<name> - The name of the application in debug messages and the debug and
2718 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2719 until it is accessed. This allows you to (for example) check authentication (and reject
2720 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2724 C<root> - The root directory for templates. Usually this is just a
2725 subdirectory of the home directory, but you can set it to change the
2726 templates to a different directory.
2730 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2731 namespaces from which components will be loaded (and constructed and stored in
2732 C<< $c->components >>).
2736 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2737 to be shown in hit debug tables in the test server.
2741 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2745 =head1 INTERNAL ACTIONS
2747 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2748 C<_ACTION>, and C<_END>. These are by default not shown in the private
2749 action table, but you can make them visible with a config parameter.
2751 MyApp->config(show_internal_actions => 1);
2753 =head1 ON-DEMAND PARSER
2755 The request body is usually parsed at the beginning of a request,
2756 but if you want to handle input yourself, you can enable on-demand
2757 parsing with a config parameter.
2759 MyApp->config(parse_on_demand => 1);
2761 =head1 PROXY SUPPORT
2763 Many production servers operate using the common double-server approach,
2764 with a lightweight frontend web server passing requests to a larger
2765 backend server. An application running on the backend server must deal
2766 with two problems: the remote user always appears to be C<127.0.0.1> and
2767 the server's hostname will appear to be C<localhost> regardless of the
2768 virtual host that the user connected through.
2770 Catalyst will automatically detect this situation when you are running
2771 the frontend and backend servers on the same machine. The following
2772 changes are made to the request.
2774 $c->req->address is set to the user's real IP address, as read from
2775 the HTTP X-Forwarded-For header.
2777 The host value for $c->req->base and $c->req->uri is set to the real
2778 host, as read from the HTTP X-Forwarded-Host header.
2780 Additionally, you may be running your backend application on an insecure
2781 connection (port 80) while your frontend proxy is running under SSL. If there
2782 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2783 tell Catalyst what port the frontend listens on. This will allow all URIs to
2784 be created properly.
2786 In the case of passing in:
2788 X-Forwarded-Port: 443
2790 All calls to C<uri_for> will result in an https link, as is expected.
2792 Obviously, your web server must support these headers for this to work.
2794 In a more complex server farm environment where you may have your
2795 frontend proxy server(s) on different machines, you will need to set a
2796 configuration option to tell Catalyst to read the proxied data from the
2799 MyApp->config(using_frontend_proxy => 1);
2801 If you do not wish to use the proxy support at all, you may set:
2803 MyApp->config(ignore_frontend_proxy => 1);
2805 =head1 THREAD SAFETY
2807 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2808 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2809 believe the Catalyst core to be thread-safe.
2811 If you plan to operate in a threaded environment, remember that all other
2812 modules you are using must also be thread-safe. Some modules, most notably
2813 L<DBD::SQLite>, are not thread-safe.
2819 Join #catalyst on irc.perl.org.
2823 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2824 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2828 http://catalyst.perl.org
2832 http://dev.catalyst.perl.org
2836 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2838 =head2 L<Catalyst::Manual> - The Catalyst Manual
2840 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2842 =head2 L<Catalyst::Engine> - Core engine
2844 =head2 L<Catalyst::Log> - Log class.
2846 =head2 L<Catalyst::Request> - Request object
2848 =head2 L<Catalyst::Response> - Response object
2850 =head2 L<Catalyst::Test> - The test suite.
2852 =head1 PROJECT FOUNDER
2854 sri: Sebastian Riedel <sri@cpan.org>
2860 acme: Leon Brocard <leon@astray.com>
2862 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2866 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2870 andyg: Andy Grundman <andy@hybridized.org>
2872 audreyt: Audrey Tang
2874 bricas: Brian Cassidy <bricas@cpan.org>
2876 Caelum: Rafael Kitover <rkitover@io.com>
2878 chansen: Christian Hansen
2880 chicks: Christopher Hicks
2882 Chisel Wright C<pause@herlpacker.co.uk>
2884 Danijel Milicevic C<me@danijel.de>
2886 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2888 David Naughton, C<naughton@umn.edu>
2892 dhoss: Devin Austin <dhoss@cpan.org>
2894 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2898 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2900 esskar: Sascha Kiefer
2902 fireartist: Carl Franks <cfranks@cpan.org>
2904 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2906 gabb: Danijel Milicevic
2910 Gavin Henry C<ghenry@perl.me.uk>
2914 groditi: Guillermo Roditi <groditi@gmail.com>
2916 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2918 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2920 jcamacho: Juan Camacho
2922 jester: Jesse Sheidlower C<jester@panix.com>
2924 jhannah: Jay Hannah <jay@jays.net>
2930 jon: Jon Schutz <jjschutz@cpan.org>
2932 Jonathan Rockway C<< <jrockway@cpan.org> >>
2934 Kieren Diment C<kd@totaldatasolution.com>
2936 konobi: Scott McWhirter <konobi@cpan.org>
2938 marcus: Marcus Ramberg <mramberg@cpan.org>
2940 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2942 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2946 naughton: David Naughton
2948 ningu: David Kamholz <dkamholz@cpan.org>
2950 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2952 numa: Dan Sully <daniel@cpan.org>
2956 omega: Andreas Marienborg
2958 Oleg Kostyuk <cub.uanic@gmail.com>
2960 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2962 rafl: Florian Ragwitz <rafl@debian.org>
2964 random: Roland Lammel <lammel@cpan.org>
2966 Robert Sedlacek C<< <rs@474.at> >>
2970 t0m: Tomas Doran <bobtfish@bobtfish.net>
2974 Viljo Marrandi C<vilts@yahoo.com>
2976 Will Hawes C<info@whawes.co.uk>
2978 willert: Sebastian Willert <willert@cpan.org>
2980 Yuval Kogman, C<nothingmuch@woobling.org>
2984 This library is free software. You can redistribute it and/or modify it under
2985 the same terms as Perl itself.
2991 __PACKAGE__->meta->make_immutable;