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/;
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/components arguments dispatcher engine log dispatcher_class
71 engine_class context_class request_class response_class stats_class
72 setup_finished psgi_app/;
74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
75 __PACKAGE__->engine_class('Catalyst::Engine');
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.80018';
83 $VERSION = eval $VERSION;
86 my ( $class, @arguments ) = @_;
88 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
90 return unless $class eq 'Catalyst';
92 my $caller = caller();
93 return if $caller eq 'main';
95 my $meta = Moose::Meta::Class->initialize($caller);
96 unless ( $caller->isa('Catalyst') ) {
97 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
98 $meta->superclasses(@superclasses);
100 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
101 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
103 unless( $meta->has_method('meta') ){
104 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
107 $caller->arguments( [@arguments] );
111 sub _application { $_[0] }
115 Catalyst - The Elegant MVC Web Application Framework
119 See the L<Catalyst::Manual> distribution for comprehensive
120 documentation and tutorials.
122 # Install Catalyst::Devel for helpers and other development tools
123 # use the helper to create a new application
126 # add models, views, controllers
127 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
128 script/myapp_create.pl view MyTemplate TT
129 script/myapp_create.pl controller Search
131 # built in testserver -- use -r to restart automatically on changes
132 # --help to see all available options
133 script/myapp_server.pl
135 # command line testing interface
136 script/myapp_test.pl /yada
139 use Catalyst qw/-Debug/; # include plugins here as well
141 ### In lib/MyApp/Controller/Root.pm (autocreated)
142 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
143 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
144 $c->stash->{template} = 'foo.tt'; # set the template
145 # lookup something from db -- stash vars are passed to TT
147 $c->model('Database::Foo')->search( { country => $args[0] } );
148 if ( $c->req->params->{bar} ) { # access GET or POST parameters
149 $c->forward( 'bar' ); # process another action
150 # do something else after forward returns
154 # The foo.tt TT template can use the stash data from the database
155 [% WHILE (item = data.next) %]
159 # called for /bar/of/soap, /bar/of/soap/10, etc.
160 sub bar : Path('/bar/of/soap') { ... }
162 # called for all actions, from the top-most controller downwards
164 my ( $self, $c ) = @_;
165 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
166 $c->res->redirect( '/login' ); # require login
167 return 0; # abort request and go immediately to end()
169 return 1; # success; carry on to next action
172 # called after all actions are finished
174 my ( $self, $c ) = @_;
175 if ( scalar @{ $c->error } ) { ... } # handle errors
176 return if $c->res->body; # already have a response
177 $c->forward( 'MyApp::View::TT' ); # render template
180 ### in MyApp/Controller/Foo.pm
181 # called for /foo/bar
182 sub bar : Local { ... }
184 # called for /blargle
185 sub blargle : Global { ... }
187 # an index action matches /foo, but not /foo/1, etc.
188 sub index : Private { ... }
190 ### in MyApp/Controller/Foo/Bar.pm
191 # called for /foo/bar/baz
192 sub baz : Local { ... }
194 # first Root auto is called, then Foo auto, then this
195 sub auto : Private { ... }
197 # powerful regular expression paths are also possible
198 sub details : Regex('^product/(\w+)/details$') {
199 my ( $self, $c ) = @_;
200 # extract the (\w+) from the URI
201 my $product = $c->req->captures->[0];
204 See L<Catalyst::Manual::Intro> for additional information.
208 Catalyst is a modern framework for making web applications without the
209 pain usually associated with this process. This document is a reference
210 to the main Catalyst application. If you are a new user, we suggest you
211 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
213 See L<Catalyst::Manual> for more documentation.
215 Catalyst plugins can be loaded by naming them as arguments to the "use
216 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
217 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
220 use Catalyst qw/My::Module/;
222 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
223 fully qualify the name by using a unary plus:
227 +Fully::Qualified::Plugin::Name
230 Special flags like C<-Debug> and C<-Engine> can also be specified as
231 arguments when Catalyst is loaded:
233 use Catalyst qw/-Debug My::Module/;
235 The position of plugins and flags in the chain is important, because
236 they are loaded in the order in which they appear.
238 The following flags are supported:
242 Enables debug output. You can also force this setting from the system
243 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
244 settings override the application, with <MYAPP>_DEBUG having the highest
249 Forces Catalyst to use a specific engine. Omit the
250 C<Catalyst::Engine::> prefix of the engine name, i.e.:
252 use Catalyst qw/-Engine=CGI/;
256 Forces Catalyst to use a specific home directory, e.g.:
258 use Catalyst qw[-Home=/usr/mst];
260 This can also be done in the shell environment by setting either the
261 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
262 is replaced with the uppercased name of your application, any "::" in
263 the name will be replaced with underscores, e.g. MyApp::Web should use
264 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
268 use Catalyst '-Log=warn,fatal,error';
270 Specifies a comma-delimited list of log levels.
274 Enables statistics collection and reporting. You can also force this setting
275 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
276 environment settings override the application, with <MYAPP>_STATS having the
281 use Catalyst qw/-Stats=1/
285 =head2 INFORMATION ABOUT THE CURRENT REQUEST
289 Returns a L<Catalyst::Action> object for the current action, which
290 stringifies to the action name. See L<Catalyst::Action>.
294 Returns the namespace of the current action, i.e., the URI prefix
295 corresponding to the controller of the current action. For example:
297 # in Controller::Foo::Bar
298 $c->namespace; # returns 'foo/bar';
304 Returns the current L<Catalyst::Request> object, giving access to
305 information about the current client request (including parameters,
306 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
308 =head2 REQUEST FLOW HANDLING
310 =head2 $c->forward( $action [, \@arguments ] )
312 =head2 $c->forward( $class, $method, [, \@arguments ] )
314 Forwards processing to another action, by its private name. If you give a
315 class name but no method, C<process()> is called. You may also optionally
316 pass arguments in an arrayref. The action will receive the arguments in
317 C<@_> and C<< $c->req->args >>. Upon returning from the function,
318 C<< $c->req->args >> will be restored to the previous values.
320 Any data C<return>ed from the action forwarded to, will be returned by the
323 my $foodata = $c->forward('/foo');
324 $c->forward('index');
325 $c->forward(qw/Model::DBIC::Foo do_stuff/);
326 $c->forward('View::TT');
328 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
329 an C<< eval { } >> around the call (actually
330 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
331 all 'dies' within the called action. If you want C<die> to propagate you
332 need to do something like:
335 die $c->error if $c->error;
337 Or make sure to always return true values from your actions and write
340 $c->forward('foo') || return;
342 Another note is that C<< $c->forward >> always returns a scalar because it
343 actually returns $c->state which operates in a scalar context.
344 Thus, something like:
348 in an action that is forwarded to is going to return a scalar,
349 i.e. how many items are in that array, which is probably not what you want.
350 If you need to return an array then return a reference to it,
353 $c->stash->{array} = \@array;
355 and access it from the stash.
359 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
361 =head2 $c->detach( $action [, \@arguments ] )
363 =head2 $c->detach( $class, $method, [, \@arguments ] )
367 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
368 doesn't return to the previous action when processing is finished.
370 When called with no arguments it escapes the processing chain entirely.
374 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
376 =head2 $c->visit( $action [, \@captures, \@arguments ] )
378 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
380 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
381 but does a full dispatch, instead of just calling the new C<$action> /
382 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
383 you go to are called, just like a new request.
385 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
386 This means, for example, that C<< $c->action >> methods such as
387 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
388 L<reverse|Catalyst::Action/reverse> return information for the visited action
389 when they are invoked within the visited action. This is different from the
390 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
391 continues to use the $c->action object from the caller action even when
392 invoked from the callee.
394 C<< $c->stash >> is kept unchanged.
396 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
397 allows you to "wrap" another action, just as it would have been called by
398 dispatching from a URL, while the analogous
399 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
400 transfer control to another action as if it had been reached directly from a URL.
404 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
406 =head2 $c->go( $action [, \@captures, \@arguments ] )
408 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
410 The relationship between C<go> and
411 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
412 the relationship between
413 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
414 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
415 C<< $c->go >> will perform a full dispatch on the specified action or method,
416 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
417 C<go> escapes the processing of the current request chain on completion, and
418 does not return to its caller.
422 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
428 Returns the current L<Catalyst::Response> object, see there for details.
432 Returns a hashref to the stash, which may be used to store data and pass
433 it between components during a request. You can also set hash keys by
434 passing arguments. The stash is automatically sent to the view. The
435 stash is cleared at the end of a request; it cannot be used for
436 persistent storage (for this you must use a session; see
437 L<Catalyst::Plugin::Session> for a complete system integrated with
440 $c->stash->{foo} = $bar;
441 $c->stash( { moose => 'majestic', qux => 0 } );
442 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
444 # stash is automatically passed to the view for use in a template
445 $c->forward( 'MyApp::View::TT' );
449 around stash => sub {
452 my $stash = $orig->($c);
454 my $new_stash = @_ > 1 ? {@_} : $_[0];
455 croak('stash takes a hash or hashref') unless ref $new_stash;
456 foreach my $key ( keys %$new_stash ) {
457 $stash->{$key} = $new_stash->{$key};
467 =head2 $c->error($error, ...)
469 =head2 $c->error($arrayref)
471 Returns an arrayref containing error messages. If Catalyst encounters an
472 error while processing a request, it stores the error in $c->error. This
473 method should only be used to store fatal error messages.
475 my @error = @{ $c->error };
479 $c->error('Something bad happened');
486 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
487 croak @$error unless ref $c;
488 push @{ $c->{error} }, @$error;
490 elsif ( defined $_[0] ) { $c->{error} = undef }
491 return $c->{error} || [];
497 Contains the return value of the last executed action.
498 Note that << $c->state >> operates in a scalar context which means that all
499 values it returns are scalar.
501 =head2 $c->clear_errors
503 Clear errors. You probably don't want to clear the errors unless you are
504 implementing a custom error screen.
506 This is equivalent to running
517 sub _comp_search_prefixes {
519 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
522 # search components given a name and some prefixes
523 sub _comp_names_search_prefixes {
524 my ( $c, $name, @prefixes ) = @_;
525 my $appclass = ref $c || $c;
526 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
527 $filter = qr/$filter/; # Compile regex now rather than once per loop
529 # map the original component name to the sub part that we will search against
530 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
531 grep { /$filter/ } keys %{ $c->components };
533 # undef for a name will return all
534 return keys %eligible if !defined $name;
536 my $query = ref $name ? $name : qr/^$name$/i;
537 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
539 return @result if @result;
541 # if we were given a regexp to search against, we're done.
544 # skip regexp fallback if configured
546 if $appclass->config->{disable_component_resolution_regex_fallback};
550 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
552 # no results? try against full names
554 @result = grep { m{$query} } keys %eligible;
557 # don't warn if we didn't find any results, it just might not exist
559 # Disgusting hack to work out correct method name
560 my $warn_for = lc $prefixes[0];
561 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
562 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
563 "component resolution is unreliable and unsafe.";
564 my $short = $result[0];
565 # remove the component namespace prefix
566 $short =~ s/.*?(Model|Controller|View):://;
567 my $shortmess = Carp::shortmess('');
568 if ($shortmess =~ m#Catalyst/Plugin#) {
569 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
571 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
572 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
573 "component's config";
575 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
576 "but if you really wanted to search, pass in a regexp as the argument " .
577 "like so: \$c->${warn_for}(qr/${name}/)";
579 $c->log->warn( "${msg}$shortmess" );
585 # Find possible names for a prefix
587 my ( $c, @prefixes ) = @_;
588 my $appclass = ref $c || $c;
590 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
592 my @names = map { s{$filter}{}; $_; }
593 $c->_comp_names_search_prefixes( undef, @prefixes );
598 # Filter a component before returning by calling ACCEPT_CONTEXT if available
599 sub _filter_component {
600 my ( $c, $comp, @args ) = @_;
602 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
603 return $comp->ACCEPT_CONTEXT( $c, @args );
609 =head2 COMPONENT ACCESSORS
611 =head2 $c->controller($name)
613 Gets a L<Catalyst::Controller> instance by name.
615 $c->controller('Foo')->do_stuff;
617 If the name is omitted, will return the controller for the dispatched
620 If you want to search for controllers, pass in a regexp as the argument.
622 # find all controllers that start with Foo
623 my @foo_controllers = $c->controller(qr{^Foo});
629 my ( $c, $name, @args ) = @_;
632 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
633 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
634 return $c->_filter_component( $result[ 0 ], @args );
637 return $c->component( $c->action->class );
640 =head2 $c->model($name)
642 Gets a L<Catalyst::Model> instance by name.
644 $c->model('Foo')->do_stuff;
646 Any extra arguments are directly passed to ACCEPT_CONTEXT.
648 If the name is omitted, it will look for
649 - a model object in $c->stash->{current_model_instance}, then
650 - a model name in $c->stash->{current_model}, then
651 - a config setting 'default_model', or
652 - check if there is only one model, and return it if that's the case.
654 If you want to search for models, pass in a regexp as the argument.
656 # find all models that start with Foo
657 my @foo_models = $c->model(qr{^Foo});
662 my ( $c, $name, @args ) = @_;
663 my $appclass = ref($c) || $c;
665 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
666 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
667 return $c->_filter_component( $result[ 0 ], @args );
671 return $c->stash->{current_model_instance}
672 if $c->stash->{current_model_instance};
673 return $c->model( $c->stash->{current_model} )
674 if $c->stash->{current_model};
676 return $c->model( $appclass->config->{default_model} )
677 if $appclass->config->{default_model};
679 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
682 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
683 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
684 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
685 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
686 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
689 return $c->_filter_component( $comp );
693 =head2 $c->view($name)
695 Gets a L<Catalyst::View> instance by name.
697 $c->view('Foo')->do_stuff;
699 Any extra arguments are directly passed to ACCEPT_CONTEXT.
701 If the name is omitted, it will look for
702 - a view object in $c->stash->{current_view_instance}, then
703 - a view name in $c->stash->{current_view}, then
704 - a config setting 'default_view', or
705 - check if there is only one view, and return it if that's the case.
707 If you want to search for views, pass in a regexp as the argument.
709 # find all views that start with Foo
710 my @foo_views = $c->view(qr{^Foo});
715 my ( $c, $name, @args ) = @_;
717 my $appclass = ref($c) || $c;
719 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
720 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
721 return $c->_filter_component( $result[ 0 ], @args );
725 return $c->stash->{current_view_instance}
726 if $c->stash->{current_view_instance};
727 return $c->view( $c->stash->{current_view} )
728 if $c->stash->{current_view};
730 return $c->view( $appclass->config->{default_view} )
731 if $appclass->config->{default_view};
733 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
736 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
737 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
738 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
739 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
740 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
743 return $c->_filter_component( $comp );
746 =head2 $c->controllers
748 Returns the available names which can be passed to $c->controller
754 return $c->_comp_names(qw/Controller C/);
759 Returns the available names which can be passed to $c->model
765 return $c->_comp_names(qw/Model M/);
771 Returns the available names which can be passed to $c->view
777 return $c->_comp_names(qw/View V/);
780 =head2 $c->comp($name)
782 =head2 $c->component($name)
784 Gets a component object by name. This method is not recommended,
785 unless you want to get a specific component by full
786 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
787 should be used instead.
789 If C<$name> is a regexp, a list of components matched against the full
790 component name will be returned.
792 If Catalyst can't find a component by name, it will fallback to regex
793 matching by default. To disable this behaviour set
794 disable_component_resolution_regex_fallback to a true value.
796 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
801 my ( $c, $name, @args ) = @_;
804 my $comps = $c->components;
807 # is it the exact name?
808 return $c->_filter_component( $comps->{ $name }, @args )
809 if exists $comps->{ $name };
811 # perhaps we just omitted "MyApp"?
812 my $composed = ( ref $c || $c ) . "::${name}";
813 return $c->_filter_component( $comps->{ $composed }, @args )
814 if exists $comps->{ $composed };
816 # search all of the models, views and controllers
817 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
818 return $c->_filter_component( $comp, @args ) if $comp;
821 # This is here so $c->comp( '::M::' ) works
822 my $query = ref $name ? $name : qr{$name}i;
824 my @result = grep { m{$query} } keys %{ $c->components };
825 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
828 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
829 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
830 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
831 return $c->_filter_component( $result[ 0 ], @args );
834 # I would expect to return an empty list here, but that breaks back-compat
838 return sort keys %{ $c->components };
841 =head2 CLASS DATA AND HELPER CLASSES
845 Returns or takes a hashref containing the application's configuration.
847 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
849 You can also use a C<YAML>, C<XML> or L<Config::General> config file
850 like C<myapp.conf> in your applications home directory. See
851 L<Catalyst::Plugin::ConfigLoader>.
853 =head3 Cascading configuration
855 The config method is present on all Catalyst components, and configuration
856 will be merged when an application is started. Configuration loaded with
857 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
858 followed by configuration in your top level C<MyApp> class. These two
859 configurations are merged, and then configuration data whose hash key matches a
860 component name is merged with configuration for that component.
862 The configuration for a component is then passed to the C<new> method when a
863 component is constructed.
867 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
868 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
870 will mean that C<MyApp::Model::Foo> receives the following data when
873 MyApp::Model::Foo->new({
881 around config => sub {
885 croak('Setting config after setup has been run is not allowed.')
886 if ( @_ and $c->setup_finished );
893 Returns the logging object instance. Unless it is already set, Catalyst
894 sets this up with a L<Catalyst::Log> object. To use your own log class,
895 set the logger with the C<< __PACKAGE__->log >> method prior to calling
896 C<< __PACKAGE__->setup >>.
898 __PACKAGE__->log( MyLogger->new );
903 $c->log->info( 'Now logging with my own logger!' );
905 Your log class should implement the methods described in
911 Returns 1 if debug mode is enabled, 0 otherwise.
913 You can enable debug mode in several ways:
917 =item By calling myapp_server.pl with the -d flag
919 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
921 =item The -Debug option in your MyApp.pm
923 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
927 Calling C<< $c->debug(1) >> has no effect.
933 =head2 $c->dispatcher
935 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
939 Returns the engine instance. See L<Catalyst::Engine>.
942 =head2 UTILITY METHODS
944 =head2 $c->path_to(@path)
946 Merges C<@path> with C<< $c->config->{home} >> and returns a
947 L<Path::Class::Dir> object. Note you can usually use this object as
948 a filename, but sometimes you will have to explicitly stringify it
949 yourself by calling the C<< ->stringify >> method.
953 $c->path_to( 'db', 'sqlite.db' );
958 my ( $c, @path ) = @_;
959 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
960 if ( -d $path ) { return $path }
961 else { return Path::Class::File->new( $c->config->{home}, @path ) }
964 =head2 $c->plugin( $name, $class, @args )
966 Helper method for plugins. It creates a class data accessor/mutator and
967 loads and instantiates the given class.
969 MyApp->plugin( 'prototype', 'HTML::Prototype' );
971 $c->prototype->define_javascript_functions;
973 B<Note:> This method of adding plugins is deprecated. The ability
974 to add plugins like this B<will be removed> in a Catalyst 5.81.
975 Please do not use this functionality in new code.
980 my ( $class, $name, $plugin, @args ) = @_;
982 # See block comment in t/unit_core_plugin.t
983 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
985 $class->_register_plugin( $plugin, 1 );
987 eval { $plugin->import };
988 $class->mk_classdata($name);
990 eval { $obj = $plugin->new(@args) };
993 Catalyst::Exception->throw( message =>
994 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
998 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1004 Initializes the dispatcher and engine, loads any plugins, and loads the
1005 model, view, and controller components. You may also specify an array
1006 of plugins to load here, if you choose to not load them in the C<use
1010 MyApp->setup( qw/-Debug/ );
1015 my ( $class, @arguments ) = @_;
1016 croak('Running setup more than once')
1017 if ( $class->setup_finished );
1019 unless ( $class->isa('Catalyst') ) {
1021 Catalyst::Exception->throw(
1022 message => qq/'$class' does not inherit from Catalyst/ );
1025 if ( $class->arguments ) {
1026 @arguments = ( @arguments, @{ $class->arguments } );
1032 foreach (@arguments) {
1036 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1038 elsif (/^-(\w+)=?(.*)$/) {
1039 $flags->{ lc $1 } = $2;
1042 push @{ $flags->{plugins} }, $_;
1046 $class->setup_home( delete $flags->{home} );
1048 $class->setup_log( delete $flags->{log} );
1049 $class->setup_plugins( delete $flags->{plugins} );
1050 $class->setup_dispatcher( delete $flags->{dispatcher} );
1051 $class->setup_engine( delete $flags->{engine} );
1052 $class->setup_stats( delete $flags->{stats} );
1054 for my $flag ( sort keys %{$flags} ) {
1056 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1057 &$code( $class, delete $flags->{$flag} );
1060 $class->log->warn(qq/Unknown flag "$flag"/);
1064 eval { require Catalyst::Devel; };
1065 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1066 $class->log->warn(<<"EOF");
1067 You are running an old script!
1069 Please update by running (this will overwrite existing files):
1070 catalyst.pl -force -scripts $class
1072 or (this will not overwrite existing files):
1073 catalyst.pl -scripts $class
1078 if ( $class->debug ) {
1079 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1082 my $column_width = Catalyst::Utils::term_width() - 6;
1083 my $t = Text::SimpleTable->new($column_width);
1084 $t->row($_) for @plugins;
1085 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1088 my $dispatcher = $class->dispatcher;
1089 my $engine = $class->engine;
1090 my $home = $class->config->{home};
1092 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1093 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1097 ? $class->log->debug(qq/Found home "$home"/)
1098 : $class->log->debug(qq/Home "$home" doesn't exist/)
1099 : $class->log->debug(q/Couldn't find home/);
1102 # Call plugins setup, this is stupid and evil.
1103 # Also screws C3 badly on 5.10, hack to avoid.
1105 no warnings qw/redefine/;
1106 local *setup = sub { };
1107 $class->setup unless $Catalyst::__AM_RESTARTING;
1110 # Initialize our data structure
1111 $class->components( {} );
1113 $class->setup_components;
1115 if ( $class->debug ) {
1116 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1117 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1118 for my $comp ( sort keys %{ $class->components } ) {
1119 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1120 $t->row( $comp, $type );
1122 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1123 if ( keys %{ $class->components } );
1126 # Add our self to components, since we are also a component
1127 if( $class->isa('Catalyst::Controller') ){
1128 $class->components->{$class} = $class;
1131 $class->setup_actions;
1133 if ( $class->debug ) {
1134 my $name = $class->config->{name} || 'Application';
1135 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1138 # Make sure that the application class becomes immutable at this point,
1139 B::Hooks::EndOfScope::on_scope_end {
1141 my $meta = Class::MOP::get_metaclass_by_name($class);
1144 && ! { $meta->immutable_options }->{replace_constructor}
1146 $class->isa('Class::Accessor::Fast')
1147 || $class->isa('Class::Accessor')
1150 warn "You made your application class ($class) immutable, "
1151 . "but did not inline the\nconstructor. "
1152 . "This will break catalyst, as your app \@ISA "
1153 . "Class::Accessor(::Fast)?\nPlease pass "
1154 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1156 $meta->make_immutable(
1157 replace_constructor => 1,
1158 ) unless $meta->is_immutable;
1161 if ($class->config->{case_sensitive}) {
1162 $class->log->warn($class . "->config->{case_sensitive} is set.");
1163 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1166 $class->setup_finalize;
1167 # Should be the last thing we do so that user things hooking
1168 # setup_finalize can log..
1169 $class->log->_flush() if $class->log->can('_flush');
1170 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1174 =head2 $app->setup_finalize
1176 A hook to attach modifiers to.
1177 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1178 Also better than C< setup_finished(); >, as that is a getter method.
1180 sub setup_finalize {
1184 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1186 $app->next::method(@_);
1193 sub setup_finalize {
1195 $class->setup_finished(1);
1198 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1200 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1202 Constructs an absolute L<URI> object based on the application root, the
1203 provided path, and the additional arguments and query parameters provided.
1204 When used as a string, provides a textual URI.
1206 If no arguments are provided, the URI for the current action is returned.
1207 To return the current action and also provide @args, use
1208 C<< $c->uri_for( $c->action, @args ) >>.
1210 If the first argument is a string, it is taken as a public URI path relative
1211 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1212 relative to the application root (if it does). It is then merged with
1213 C<< $c->request->base >>; any C<@args> are appended as additional path
1214 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1216 If the first argument is a L<Catalyst::Action> it represents an action which
1217 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1218 optional C<\@captures> argument (an arrayref) allows passing the captured
1219 variables that are needed to fill in the paths of Chained and Regex actions;
1220 once the path is resolved, C<uri_for> continues as though a path was
1221 provided, appending any arguments or parameters and creating an absolute
1224 The captures for the current request can be found in
1225 C<< $c->request->captures >>, and actions can be resolved using
1226 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1227 path, use C<< $c->uri_for_action >> instead.
1229 # Equivalent to $c->req->uri
1230 $c->uri_for($c->action, $c->req->captures,
1231 @{ $c->req->args }, $c->req->params);
1233 # For the Foo action in the Bar controller
1234 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1236 # Path to a static resource
1237 $c->uri_for('/static/images/logo.png');
1242 my ( $c, $path, @args ) = @_;
1244 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1245 $path = $path->path_prefix;
1250 if ( blessed($path) ) { # action object
1251 my $captures = [ map { s|/|%2F|; $_; }
1252 ( scalar @args && ref $args[0] eq 'ARRAY'
1256 $path = $c->dispatcher->uri_for_action($action, $captures);
1257 if (not defined $path) {
1258 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1262 $path = '/' if $path eq '';
1265 undef($path) if (defined $path && $path eq '');
1268 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1270 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1271 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1274 unshift(@args, $path);
1276 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1277 my $namespace = $c->namespace;
1278 if (defined $path) { # cheesy hack to handle path '../foo'
1279 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1281 unshift(@args, $namespace || '');
1284 # join args with '/', or a blank string
1285 my $args = join('/', grep { defined($_) } @args);
1286 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1288 my $base = $c->req->base;
1289 my $class = ref($base);
1290 $base =~ s{(?<!/)$}{/};
1294 if (my @keys = keys %$params) {
1295 # somewhat lifted from URI::_query's query_form
1296 $query = '?'.join('&', map {
1297 my $val = $params->{$_};
1298 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1301 $val = '' unless defined $val;
1304 utf8::encode( $param ) if utf8::is_utf8($param);
1305 # using the URI::Escape pattern here so utf8 chars survive
1306 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1308 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1312 my $res = bless(\"${base}${args}${query}", $class);
1316 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1318 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1324 A private path to the Catalyst action you want to create a URI for.
1326 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1327 >> and passing the resulting C<$action> and the remaining arguments to C<<
1330 You can also pass in a Catalyst::Action object, in which case it is passed to
1333 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.
1335 For example, if the action looks like:
1337 package MyApp::Controller::Users;
1339 sub lst : Path('the-list') {}
1343 $c->uri_for_action('/users/lst')
1345 and it will create the URI /users/the-list.
1351 sub uri_for_action {
1352 my ( $c, $path, @args ) = @_;
1353 my $action = blessed($path)
1355 : $c->dispatcher->get_action_by_path($path);
1356 unless (defined $action) {
1357 croak "Can't find action for path '$path'";
1359 return $c->uri_for( $action, @args );
1362 =head2 $c->welcome_message
1364 Returns the Catalyst welcome HTML page.
1368 sub welcome_message {
1370 my $name = $c->config->{name};
1371 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1372 my $prefix = Catalyst::Utils::appprefix( ref $c );
1373 $c->response->content_type('text/html; charset=utf-8');
1375 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1376 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1377 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1379 <meta http-equiv="Content-Language" content="en" />
1380 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1381 <title>$name on Catalyst $VERSION</title>
1382 <style type="text/css">
1385 background-color: #eee;
1392 margin-bottom: 10px;
1394 background-color: #ccc;
1395 border: 1px solid #aaa;
1400 font-family: verdana, tahoma, sans-serif;
1403 font-family: verdana, tahoma, sans-serif;
1406 text-decoration: none;
1408 border-bottom: 1px dotted #bbb;
1410 :link:hover, :visited:hover {
1423 background-color: #fff;
1424 border: 1px solid #aaa;
1428 font-weight: normal;
1450 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1455 <img src="$logo" alt="Catalyst Logo" />
1457 <p>Welcome to the world of Catalyst.
1458 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1459 framework will make web development something you had
1460 never expected it to be: Fun, rewarding, and quick.</p>
1461 <h2>What to do now?</h2>
1462 <p>That really depends on what <b>you</b> want to do.
1463 We do, however, provide you with a few starting points.</p>
1464 <p>If you want to jump right into web development with Catalyst
1465 you might want to start with a tutorial.</p>
1466 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1468 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1470 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1471 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1473 <h2>What to do next?</h2>
1474 <p>Next it's time to write an actual application. Use the
1475 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1476 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1477 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1478 they can save you a lot of work.</p>
1479 <pre><code>script/${prefix}_create.pl -help</code></pre>
1480 <p>Also, be sure to check out the vast and growing
1481 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1482 you are likely to find what you need there.
1486 <p>Catalyst has a very active community. Here are the main places to
1487 get in touch with us.</p>
1490 <a href="http://dev.catalyst.perl.org">Wiki</a>
1493 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1496 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1499 <h2>In conclusion</h2>
1500 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1501 as we enjoyed making it. Please contact us if you have ideas
1502 for improvement or other feedback.</p>
1510 =head1 INTERNAL METHODS
1512 These methods are not meant to be used by end users.
1514 =head2 $c->components
1516 Returns a hash of components.
1518 =head2 $c->context_class
1520 Returns or sets the context class.
1524 Returns a hashref containing coderefs and execution counts (needed for
1525 deep recursion detection).
1529 Returns the number of actions on the current internal execution stack.
1533 Dispatches a request to actions.
1537 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1539 =head2 $c->dispatcher_class
1541 Returns or sets the dispatcher class.
1543 =head2 $c->dump_these
1545 Returns a list of 2-element array references (name, structure) pairs
1546 that will be dumped on the error page in debug mode.
1552 [ Request => $c->req ],
1553 [ Response => $c->res ],
1554 [ Stash => $c->stash ],
1555 [ Config => $c->config ];
1558 =head2 $c->engine_class
1560 Returns or sets the engine class.
1562 =head2 $c->execute( $class, $coderef )
1564 Execute a coderef in given class and catch exceptions. Errors are available
1570 my ( $c, $class, $code ) = @_;
1571 $class = $c->component($class) || $class;
1574 if ( $c->depth >= $RECURSION ) {
1575 my $action = $code->reverse();
1576 $action = "/$action" unless $action =~ /->/;
1577 my $error = qq/Deep recursion detected calling "${action}"/;
1578 $c->log->error($error);
1584 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1586 push( @{ $c->stack }, $code );
1588 no warnings 'recursion';
1589 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1591 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1593 my $last = pop( @{ $c->stack } );
1595 if ( my $error = $@ ) {
1596 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1597 $error->rethrow if $c->depth > 1;
1599 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1600 $error->rethrow if $c->depth > 0;
1603 unless ( ref $error ) {
1604 no warnings 'uninitialized';
1606 my $class = $last->class;
1607 my $name = $last->name;
1608 $error = qq/Caught exception in $class->$name "$error"/;
1617 sub _stats_start_execute {
1618 my ( $c, $code ) = @_;
1619 my $appclass = ref($c) || $c;
1620 return if ( ( $code->name =~ /^_.*/ )
1621 && ( !$appclass->config->{show_internal_actions} ) );
1623 my $action_name = $code->reverse();
1624 $c->counter->{$action_name}++;
1626 my $action = $action_name;
1627 $action = "/$action" unless $action =~ /->/;
1629 # determine if the call was the result of a forward
1630 # this is done by walking up the call stack and looking for a calling
1631 # sub of Catalyst::forward before the eval
1633 for my $index ( 2 .. 11 ) {
1635 if ( ( caller($index) )[0] eq 'Catalyst'
1636 && ( caller($index) )[3] eq '(eval)' );
1638 if ( ( caller($index) )[3] =~ /forward$/ ) {
1639 $callsub = ( caller($index) )[3];
1640 $action = "-> $action";
1645 my $uid = $action_name . $c->counter->{$action_name};
1647 # is this a root-level call or a forwarded call?
1648 if ( $callsub =~ /forward$/ ) {
1649 my $parent = $c->stack->[-1];
1651 # forward, locate the caller
1652 if ( exists $c->counter->{"$parent"} ) {
1655 parent => "$parent" . $c->counter->{"$parent"},
1661 # forward with no caller may come from a plugin
1680 sub _stats_finish_execute {
1681 my ( $c, $info ) = @_;
1682 $c->stats->profile( end => $info );
1687 Finalizes the request.
1694 for my $error ( @{ $c->error } ) {
1695 $c->log->error($error);
1698 # Allow engine to handle finalize flow (for POE)
1699 my $engine = $c->engine;
1700 if ( my $code = $engine->can('finalize') ) {
1705 $c->finalize_uploads;
1708 if ( $#{ $c->error } >= 0 ) {
1712 $c->finalize_headers;
1715 if ( $c->request->method eq 'HEAD' ) {
1716 $c->response->body('');
1722 if ($c->use_stats) {
1723 my $elapsed = sprintf '%f', $c->stats->elapsed;
1724 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1726 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1729 return $c->response->status;
1732 =head2 $c->finalize_body
1738 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1740 =head2 $c->finalize_cookies
1746 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1748 =head2 $c->finalize_error
1754 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1756 =head2 $c->finalize_headers
1762 sub finalize_headers {
1765 my $response = $c->response; #accessor calls can add up?
1767 # Check if we already finalized headers
1768 return if $response->finalized_headers;
1771 if ( my $location = $response->redirect ) {
1772 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1773 $response->header( Location => $location );
1775 if ( !$response->has_body ) {
1776 # Add a default body if none is already present
1778 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1784 if ( $response->body && !$response->content_length ) {
1786 # get the length from a filehandle
1787 if ( blessed( $response->body ) && $response->body->can('read') )
1789 my $stat = stat $response->body;
1790 if ( $stat && $stat->size > 0 ) {
1791 $response->content_length( $stat->size );
1794 $c->log->warn('Serving filehandle without a content-length');
1798 # everything should be bytes at this point, but just in case
1799 $response->content_length( length( $response->body ) );
1804 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1805 $response->headers->remove_header("Content-Length");
1806 $response->body('');
1809 $c->finalize_cookies;
1811 $c->engine->finalize_headers( $c, @_ );
1814 $response->finalized_headers(1);
1817 =head2 $c->finalize_output
1819 An alias for finalize_body.
1821 =head2 $c->finalize_read
1823 Finalizes the input after reading is complete.
1827 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1829 =head2 $c->finalize_uploads
1831 Finalizes uploads. Cleans up any temporary files.
1835 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1837 =head2 $c->get_action( $action, $namespace )
1839 Gets an action in a given namespace.
1843 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1845 =head2 $c->get_actions( $action, $namespace )
1847 Gets all actions of a given name in a namespace and all parent
1852 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1854 =head2 $c->handle_request( $class, @arguments )
1856 Called to handle each HTTP request.
1860 sub handle_request {
1861 my ( $class, @arguments ) = @_;
1863 # Always expect worst case!
1866 if ($class->debug) {
1867 my $secs = time - $START || 1;
1868 my $av = sprintf '%.3f', $COUNT / $secs;
1869 my $time = localtime time;
1870 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1873 my $c = $class->prepare(@arguments);
1875 $status = $c->finalize;
1878 chomp(my $error = $_);
1879 $class->log->error(qq/Caught exception in engine "$error"/);
1884 if(my $coderef = $class->log->can('_flush')){
1885 $class->log->$coderef();
1890 =head2 $c->prepare( @arguments )
1892 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1898 my ( $class, @arguments ) = @_;
1901 # After the app/ctxt split, this should become an attribute based on something passed
1902 # into the application.
1903 $class->context_class( ref $class || $class ) unless $class->context_class;
1905 my $c = $class->context_class->new({});
1907 # For on-demand data
1908 $c->request->_context($c);
1909 $c->response->_context($c);
1911 #surely this is not the most efficient way to do things...
1912 $c->stats($class->stats_class->new)->enable($c->use_stats);
1914 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1918 # Allow engine to direct the prepare flow (for POE)
1919 if ( my $prepare = $c->engine->can('prepare') ) {
1920 $c->engine->$prepare( $c, @arguments );
1923 $c->prepare_request(@arguments);
1924 $c->prepare_connection;
1925 $c->prepare_query_parameters;
1926 $c->prepare_headers;
1927 $c->prepare_cookies;
1930 # Prepare the body for reading, either by prepare_body
1931 # or the user, if they are using $c->read
1934 # Parse the body unless the user wants it on-demand
1935 unless ( ref($c)->config->{parse_on_demand} ) {
1940 # VERY ugly and probably shouldn't rely on ->finalize actually working
1942 # failed prepare is always due to an invalid request, right?
1943 $c->response->status(400);
1944 $c->response->content_type('text/plain');
1945 $c->response->body('Bad Request');
1950 my $method = $c->req->method || '';
1951 my $path = $c->req->path;
1952 $path = '/' unless length $path;
1953 my $address = $c->req->address || '';
1955 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1963 =head2 $c->prepare_action
1965 Prepares action. See L<Catalyst::Dispatcher>.
1969 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1971 =head2 $c->prepare_body
1973 Prepares message body.
1980 return if $c->request->_has_body;
1982 # Initialize on-demand data
1983 $c->engine->prepare_body( $c, @_ );
1984 $c->prepare_parameters;
1985 $c->prepare_uploads;
1987 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1988 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1989 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1990 my $param = $c->req->body_parameters->{$key};
1991 my $value = defined($param) ? $param : '';
1993 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1995 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1999 =head2 $c->prepare_body_chunk( $chunk )
2001 Prepares a chunk of data before sending it to L<HTTP::Body>.
2003 See L<Catalyst::Engine>.
2007 sub prepare_body_chunk {
2009 $c->engine->prepare_body_chunk( $c, @_ );
2012 =head2 $c->prepare_body_parameters
2014 Prepares body parameters.
2018 sub prepare_body_parameters {
2020 $c->engine->prepare_body_parameters( $c, @_ );
2023 =head2 $c->prepare_connection
2025 Prepares connection.
2029 sub prepare_connection {
2031 $c->engine->prepare_connection( $c, @_ );
2034 =head2 $c->prepare_cookies
2040 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2042 =head2 $c->prepare_headers
2048 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2050 =head2 $c->prepare_parameters
2052 Prepares parameters.
2056 sub prepare_parameters {
2058 $c->prepare_body_parameters;
2059 $c->engine->prepare_parameters( $c, @_ );
2062 =head2 $c->prepare_path
2064 Prepares path and base.
2068 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2070 =head2 $c->prepare_query_parameters
2072 Prepares query parameters.
2076 sub prepare_query_parameters {
2079 $c->engine->prepare_query_parameters( $c, @_ );
2081 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2082 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2083 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2084 my $param = $c->req->query_parameters->{$key};
2085 my $value = defined($param) ? $param : '';
2087 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2089 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2093 =head2 $c->prepare_read
2095 Prepares the input for reading.
2099 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2101 =head2 $c->prepare_request
2103 Prepares the engine request.
2107 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2109 =head2 $c->prepare_uploads
2115 sub prepare_uploads {
2118 $c->engine->prepare_uploads( $c, @_ );
2120 if ( $c->debug && keys %{ $c->request->uploads } ) {
2121 my $t = Text::SimpleTable->new(
2122 [ 12, 'Parameter' ],
2127 for my $key ( sort keys %{ $c->request->uploads } ) {
2128 my $upload = $c->request->uploads->{$key};
2129 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2130 $t->row( $key, $u->filename, $u->type, $u->size );
2133 $c->log->debug( "File Uploads are:\n" . $t->draw );
2137 =head2 $c->prepare_write
2139 Prepares the output for writing.
2143 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2145 =head2 $c->request_class
2147 Returns or sets the request class.
2149 =head2 $c->response_class
2151 Returns or sets the response class.
2153 =head2 $c->read( [$maxlength] )
2155 Reads a chunk of data from the request body. This method is designed to
2156 be used in a while loop, reading C<$maxlength> bytes on every call.
2157 C<$maxlength> defaults to the size of the request if not specified.
2159 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2162 Warning: If you use read(), Catalyst will not process the body,
2163 so you will not be able to access POST parameters or file uploads via
2164 $c->request. You must handle all body parsing yourself.
2168 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2176 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2178 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2180 Sets an action in a given namespace.
2184 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2186 =head2 $c->setup_actions($component)
2188 Sets up actions for a component.
2192 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2194 =head2 $c->setup_components
2196 This method is called internally to set up the application's components.
2198 It finds modules by calling the L<locate_components> method, expands them to
2199 package names with the L<expand_component_module> method, and then installs
2200 each component into the application.
2202 The C<setup_components> config option is passed to both of the above methods.
2204 Installation of each component is performed by the L<setup_component> method,
2209 sub setup_components {
2212 my $config = $class->config->{ setup_components };
2214 my @comps = sort { length $a <=> length $b }
2215 $class->locate_components($config);
2216 my %comps = map { $_ => 1 } @comps;
2218 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2219 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2220 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2221 ) if $deprecatedcatalyst_component_names;
2223 for my $component ( @comps ) {
2225 # We pass ignore_loaded here so that overlay files for (e.g.)
2226 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2227 # we know M::P::O found a file on disk so this is safe
2229 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2231 # Needs to be done as soon as the component is loaded, as loading a sub-component
2232 # (next time round the loop) can cause us to get the wrong metaclass..
2233 $class->_controller_init_base_classes($component);
2236 for my $component (@comps) {
2237 $class->components->{ $component } = $class->setup_component($component);
2238 for my $component ($class->expand_component_module( $component, $config )) {
2239 next if $comps{$component};
2240 $class->_controller_init_base_classes($component); # Also cover inner packages
2241 $class->components->{ $component } = $class->setup_component($component);
2246 =head2 $c->locate_components( $setup_component_config )
2248 This method is meant to provide a list of component modules that should be
2249 setup for the application. By default, it will use L<Module::Pluggable>.
2251 Specify a C<setup_components> config option to pass additional options directly
2252 to L<Module::Pluggable>. To add additional search paths, specify a key named
2253 C<search_extra> as an array reference. Items in the array beginning with C<::>
2254 will have the application class name prepended to them.
2258 sub locate_components {
2262 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2263 my $extra = delete $config->{ search_extra } || [];
2265 push @paths, @$extra;
2267 my $locator = Module::Pluggable::Object->new(
2268 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2272 my @comps = $locator->plugins;
2277 =head2 $c->expand_component_module( $component, $setup_component_config )
2279 Components found by C<locate_components> will be passed to this method, which
2280 is expected to return a list of component (package) names to be set up.
2284 sub expand_component_module {
2285 my ($class, $module) = @_;
2286 return Devel::InnerPackage::list_packages( $module );
2289 =head2 $c->setup_component
2293 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2294 # nearest to Catalyst::Controller first, no matter what order stuff happens
2295 # to be loaded. There are TODO tests in Moose for this, see
2296 # f2391d17574eff81d911b97be15ea51080500003
2297 sub _controller_init_base_classes {
2298 my ($app_class, $component) = @_;
2299 return unless $component->isa('Catalyst::Controller');
2300 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2301 Moose::Meta::Class->initialize( $class )
2302 unless find_meta($class);
2306 sub setup_component {
2307 my( $class, $component ) = @_;
2309 unless ( $component->can( 'COMPONENT' ) ) {
2313 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2314 my $config = $class->config->{ $suffix } || {};
2315 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2316 # methods also pass it. local to avoid pointlessly shitting in config
2317 # for the debug screen, as $component is already the key name.
2318 local $config->{catalyst_component_name} = $component;
2320 my $instance = eval { $component->COMPONENT( $class, $config ); };
2322 if ( my $error = $@ ) {
2324 Catalyst::Exception->throw(
2325 message => qq/Couldn't instantiate component "$component", "$error"/
2329 unless (blessed $instance) {
2330 my $metaclass = Moose::Util::find_meta($component);
2331 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2332 my $component_method_from = $method_meta->associated_metaclass->name;
2333 my $value = defined($instance) ? $instance : 'undef';
2334 Catalyst::Exception->throw(
2336 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2342 =head2 $c->setup_dispatcher
2348 sub setup_dispatcher {
2349 my ( $class, $dispatcher ) = @_;
2352 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2355 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2356 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2359 unless ($dispatcher) {
2360 $dispatcher = $class->dispatcher_class;
2363 Class::MOP::load_class($dispatcher);
2365 # dispatcher instance
2366 $class->dispatcher( $dispatcher->new );
2369 =head2 $c->setup_engine
2376 my ($class, $engine) = @_;
2379 $engine = $class->engine_class;
2382 Class::MOP::load_class($engine);
2384 # check for old engines that are no longer compatible
2386 if ( $engine->isa('Catalyst::Engine::Apache')
2387 && !Catalyst::Engine::Apache->VERSION )
2392 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2393 && Catalyst::Engine::Server->VERSION le '0.02' )
2398 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2399 && $engine->VERSION eq '0.01' )
2404 elsif ($engine->isa('Catalyst::Engine::Zeus')
2405 && $engine->VERSION eq '0.01' )
2411 Catalyst::Exception->throw( message =>
2412 qq/Engine "$engine" is not supported by this version of Catalyst/
2416 $class->engine( $engine->new );
2417 $class->psgi_app( $class->engine->build_psgi_app($class) );
2420 =head2 $c->setup_home
2422 Sets up the home directory.
2427 my ( $class, $home ) = @_;
2429 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2433 $home ||= Catalyst::Utils::home($class);
2436 #I remember recently being scolded for assigning config values like this
2437 $class->config->{home} ||= $home;
2438 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2442 =head2 $c->setup_log
2444 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2445 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2448 This method also installs a C<debug> method that returns a true value into the
2449 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2450 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2452 Note that if the log has already been setup, by either a previous call to
2453 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2454 that this method won't actually set up the log object.
2459 my ( $class, $levels ) = @_;
2462 $levels =~ s/^\s+//;
2463 $levels =~ s/\s+$//;
2464 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2466 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2467 if ( defined $env_debug ) {
2468 $levels{debug} = 1 if $env_debug; # Ugly!
2469 delete($levels{debug}) unless $env_debug;
2472 unless ( $class->log ) {
2473 $class->log( Catalyst::Log->new(keys %levels) );
2476 if ( $levels{debug} ) {
2477 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2478 $class->log->debug('Debug messages enabled');
2482 =head2 $c->setup_plugins
2488 =head2 $c->setup_stats
2490 Sets up timing statistics class.
2495 my ( $class, $stats ) = @_;
2497 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2499 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2500 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2501 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2502 $class->log->debug('Statistics enabled');
2507 =head2 $c->registered_plugins
2509 Returns a sorted list of the plugins which have either been stated in the
2510 import list or which have been added via C<< MyApp->plugin(@args); >>.
2512 If passed a given plugin name, it will report a boolean value indicating
2513 whether or not that plugin is loaded. A fully qualified name is required if
2514 the plugin name does not begin with C<Catalyst::Plugin::>.
2516 if ($c->registered_plugins('Some::Plugin')) {
2524 sub registered_plugins {
2526 return sort keys %{ $proto->_plugins } unless @_;
2528 return 1 if exists $proto->_plugins->{$plugin};
2529 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2532 sub _register_plugin {
2533 my ( $proto, $plugin, $instant ) = @_;
2534 my $class = ref $proto || $proto;
2536 Class::MOP::load_class( $plugin );
2537 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2538 if $plugin->isa( 'Catalyst::Component' );
2539 $proto->_plugins->{$plugin} = 1;
2542 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2543 my @superclasses = ($plugin, $meta->superclasses );
2544 $meta->superclasses(@superclasses);
2546 unshift @{"$class\::ISA"}, $plugin;
2553 my ( $class, $plugins ) = @_;
2555 $class->_plugins( {} ) unless $class->_plugins;
2558 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2560 for my $plugin ( reverse @plugins ) {
2561 Class::MOP::load_class($plugin);
2562 my $meta = find_meta($plugin);
2563 next if $meta && $meta->isa('Moose::Meta::Role');
2565 $class->_register_plugin($plugin);
2570 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2571 map { find_meta($_) }
2574 Moose::Util::apply_all_roles(
2582 Returns an arrayref of the internal execution stack (actions that are
2583 currently executing).
2585 =head2 $c->stats_class
2587 Returns or sets the stats (timing statistics) class.
2589 =head2 $c->use_stats
2591 Returns 1 when stats collection is enabled. Stats collection is enabled
2592 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2593 environment variable is set.
2595 Note that this is a static method, not an accessor and should be overridden
2596 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2603 =head2 $c->write( $data )
2605 Writes $data to the output stream. When using this method directly, you
2606 will need to manually set the C<Content-Length> header to the length of
2607 your output data, if known.
2614 # Finalize headers if someone manually writes output
2615 $c->finalize_headers;
2617 return $c->engine->write( $c, @_ );
2622 Returns the Catalyst version number. Mostly useful for "powered by"
2623 messages in template systems.
2627 sub version { return $Catalyst::VERSION }
2629 =head1 CONFIGURATION
2631 There are a number of 'base' config variables which can be set:
2637 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2641 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2645 C<disable_component_resolution_regex_fallback> - Turns
2646 off the deprecated component resolution functionality so
2647 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2648 are called then regex search will not be attempted on string values and
2649 instead C<undef> will be returned.
2653 C<home> - The application home directory. In an uninstalled application,
2654 this is the top level application directory. In an installed application,
2655 this will be the directory containing C<< MyApp.pm >>.
2659 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2663 C<name> - The name of the application in debug messages and the debug and
2668 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2669 until it is accessed. This allows you to (for example) check authentication (and reject
2670 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2674 C<root> - The root directory for templates. Usually this is just a
2675 subdirectory of the home directory, but you can set it to change the
2676 templates to a different directory.
2680 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2681 namespaces from which components will be loaded (and constructed and stored in
2682 C<< $c->components >>).
2686 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2687 to be shown in hit debug tables in the test server.
2691 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2695 =head1 INTERNAL ACTIONS
2697 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2698 C<_ACTION>, and C<_END>. These are by default not shown in the private
2699 action table, but you can make them visible with a config parameter.
2701 MyApp->config(show_internal_actions => 1);
2703 =head1 ON-DEMAND PARSER
2705 The request body is usually parsed at the beginning of a request,
2706 but if you want to handle input yourself, you can enable on-demand
2707 parsing with a config parameter.
2709 MyApp->config(parse_on_demand => 1);
2711 =head1 PROXY SUPPORT
2713 Many production servers operate using the common double-server approach,
2714 with a lightweight frontend web server passing requests to a larger
2715 backend server. An application running on the backend server must deal
2716 with two problems: the remote user always appears to be C<127.0.0.1> and
2717 the server's hostname will appear to be C<localhost> regardless of the
2718 virtual host that the user connected through.
2720 Catalyst will automatically detect this situation when you are running
2721 the frontend and backend servers on the same machine. The following
2722 changes are made to the request.
2724 $c->req->address is set to the user's real IP address, as read from
2725 the HTTP X-Forwarded-For header.
2727 The host value for $c->req->base and $c->req->uri is set to the real
2728 host, as read from the HTTP X-Forwarded-Host header.
2730 Additionally, you may be running your backend application on an insecure
2731 connection (port 80) while your frontend proxy is running under SSL. If there
2732 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2733 tell Catalyst what port the frontend listens on. This will allow all URIs to
2734 be created properly.
2736 In the case of passing in:
2738 X-Forwarded-Port: 443
2740 All calls to C<uri_for> will result in an https link, as is expected.
2742 Obviously, your web server must support these headers for this to work.
2744 In a more complex server farm environment where you may have your
2745 frontend proxy server(s) on different machines, you will need to set a
2746 configuration option to tell Catalyst to read the proxied data from the
2749 MyApp->config(using_frontend_proxy => 1);
2751 If you do not wish to use the proxy support at all, you may set:
2753 MyApp->config(ignore_frontend_proxy => 1);
2755 =head1 THREAD SAFETY
2757 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2758 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2759 believe the Catalyst core to be thread-safe.
2761 If you plan to operate in a threaded environment, remember that all other
2762 modules you are using must also be thread-safe. Some modules, most notably
2763 L<DBD::SQLite>, are not thread-safe.
2769 Join #catalyst on irc.perl.org.
2773 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2774 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2778 http://catalyst.perl.org
2782 http://dev.catalyst.perl.org
2786 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2788 =head2 L<Catalyst::Manual> - The Catalyst Manual
2790 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2792 =head2 L<Catalyst::Engine> - Core engine
2794 =head2 L<Catalyst::Log> - Log class.
2796 =head2 L<Catalyst::Request> - Request object
2798 =head2 L<Catalyst::Response> - Response object
2800 =head2 L<Catalyst::Test> - The test suite.
2802 =head1 PROJECT FOUNDER
2804 sri: Sebastian Riedel <sri@cpan.org>
2810 acme: Leon Brocard <leon@astray.com>
2812 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2816 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2820 andyg: Andy Grundman <andy@hybridized.org>
2822 audreyt: Audrey Tang
2824 bricas: Brian Cassidy <bricas@cpan.org>
2826 Caelum: Rafael Kitover <rkitover@io.com>
2828 chansen: Christian Hansen
2830 chicks: Christopher Hicks
2832 Chisel Wright C<pause@herlpacker.co.uk>
2834 Danijel Milicevic C<me@danijel.de>
2836 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2838 David Naughton, C<naughton@umn.edu>
2842 dhoss: Devin Austin <dhoss@cpan.org>
2844 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2848 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2850 esskar: Sascha Kiefer
2852 fireartist: Carl Franks <cfranks@cpan.org>
2854 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2856 gabb: Danijel Milicevic
2860 Gavin Henry C<ghenry@perl.me.uk>
2864 groditi: Guillermo Roditi <groditi@gmail.com>
2866 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2868 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2870 jcamacho: Juan Camacho
2872 jester: Jesse Sheidlower C<jester@panix.com>
2874 jhannah: Jay Hannah <jay@jays.net>
2880 jon: Jon Schutz <jjschutz@cpan.org>
2882 Jonathan Rockway C<< <jrockway@cpan.org> >>
2884 Kieren Diment C<kd@totaldatasolution.com>
2886 konobi: Scott McWhirter <konobi@cpan.org>
2888 marcus: Marcus Ramberg <mramberg@cpan.org>
2890 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2892 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2896 naughton: David Naughton
2898 ningu: David Kamholz <dkamholz@cpan.org>
2900 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2902 numa: Dan Sully <daniel@cpan.org>
2908 omega: Andreas Marienborg
2910 Oleg Kostyuk <cub.uanic@gmail.com>
2912 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2914 rafl: Florian Ragwitz <rafl@debian.org>
2916 random: Roland Lammel <lammel@cpan.org>
2918 Robert Sedlacek C<< <rs@474.at> >>
2922 t0m: Tomas Doran <bobtfish@bobtfish.net>
2926 Viljo Marrandi C<vilts@yahoo.com>
2928 Will Hawes C<info@whawes.co.uk>
2930 willert: Sebastian Willert <willert@cpan.org>
2932 Yuval Kogman, C<nothingmuch@woobling.org>
2936 This library is free software. You can redistribute it and/or modify it under
2937 the same terms as Perl itself.
2943 __PACKAGE__->meta->make_immutable;