4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
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/;
31 use String::RewritePrefix;
32 use Catalyst::EngineLoader;
34 use Carp qw/croak carp shortmess/;
37 use Plack::Middleware::Conditional;
38 use Plack::Middleware::ReverseProxy;
39 use Plack::Middleware::IIS6ScriptNameFix;
40 use Plack::Middleware::IIS7KeepAliveFix;
41 use Plack::Middleware::LighttpdScriptNameFix;
43 BEGIN { require 5.008003; }
45 has stack => (is => 'ro', default => sub { [] });
46 has stash => (is => 'rw', default => sub { {} });
47 has state => (is => 'rw', default => 0);
48 has stats => (is => 'rw');
49 has action => (is => 'rw');
50 has counter => (is => 'rw', default => sub { {} });
55 my %p = ( _log => $self->log );
56 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
57 $self->request_class->new(\%p);
65 $self->response_class->new({ _log => $self->log });
69 has namespace => (is => 'rw');
71 sub depth { scalar @{ shift->stack || [] }; }
72 sub comp { shift->component(@_) }
75 my $self = shift; return $self->request(@_);
78 my $self = shift; return $self->response(@_);
81 # For backwards compatibility
82 sub finalize_output { shift->finalize_body(@_) };
87 our $RECURSION = 1000;
88 our $DETACH = Catalyst::Exception::Detach->new;
89 our $GO = Catalyst::Exception::Go->new;
91 #I imagine that very few of these really need to be class variables. if any.
92 #maybe we should just make them attributes with a default?
93 __PACKAGE__->mk_classdata($_)
94 for qw/components arguments dispatcher engine log dispatcher_class
95 engine_loader context_class request_class response_class stats_class
96 setup_finished _psgi_app loading_psgi_file run_options/;
98 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
99 __PACKAGE__->request_class('Catalyst::Request');
100 __PACKAGE__->response_class('Catalyst::Response');
101 __PACKAGE__->stats_class('Catalyst::Stats');
103 # Remember to update this in Catalyst::Runtime as well!
105 our $VERSION = '5.90015';
108 my ( $class, @arguments ) = @_;
110 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
112 return unless $class eq 'Catalyst';
114 my $caller = caller();
115 return if $caller eq 'main';
117 my $meta = Moose::Meta::Class->initialize($caller);
118 unless ( $caller->isa('Catalyst') ) {
119 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
120 $meta->superclasses(@superclasses);
122 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
123 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
125 unless( $meta->has_method('meta') ){
126 if ($Moose::VERSION >= 1.15) {
127 $meta->_add_meta_method('meta');
130 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
134 $caller->arguments( [@arguments] );
138 sub _application { $_[0] }
144 Catalyst - The Elegant MVC Web Application Framework
148 See the L<Catalyst::Manual> distribution for comprehensive
149 documentation and tutorials.
151 # Install Catalyst::Devel for helpers and other development tools
152 # use the helper to create a new application
155 # add models, views, controllers
156 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
157 script/myapp_create.pl view MyTemplate TT
158 script/myapp_create.pl controller Search
160 # built in testserver -- use -r to restart automatically on changes
161 # --help to see all available options
162 script/myapp_server.pl
164 # command line testing interface
165 script/myapp_test.pl /yada
168 use Catalyst qw/-Debug/; # include plugins here as well
170 ### In lib/MyApp/Controller/Root.pm (autocreated)
171 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
172 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
173 $c->stash->{template} = 'foo.tt'; # set the template
174 # lookup something from db -- stash vars are passed to TT
176 $c->model('Database::Foo')->search( { country => $args[0] } );
177 if ( $c->req->params->{bar} ) { # access GET or POST parameters
178 $c->forward( 'bar' ); # process another action
179 # do something else after forward returns
183 # The foo.tt TT template can use the stash data from the database
184 [% WHILE (item = data.next) %]
188 # called for /bar/of/soap, /bar/of/soap/10, etc.
189 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
191 # called after all actions are finished
193 my ( $self, $c ) = @_;
194 if ( scalar @{ $c->error } ) { ... } # handle errors
195 return if $c->res->body; # already have a response
196 $c->forward( 'MyApp::View::TT' ); # render template
199 See L<Catalyst::Manual::Intro> for additional information.
203 Catalyst is a modern framework for making web applications without the
204 pain usually associated with this process. This document is a reference
205 to the main Catalyst application. If you are a new user, we suggest you
206 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
208 See L<Catalyst::Manual> for more documentation.
210 Catalyst plugins can be loaded by naming them as arguments to the "use
211 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
212 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
215 use Catalyst qw/My::Module/;
217 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
218 fully qualify the name by using a unary plus:
222 +Fully::Qualified::Plugin::Name
225 Special flags like C<-Debug> can also be specified as
226 arguments when Catalyst is loaded:
228 use Catalyst qw/-Debug My::Module/;
230 The position of plugins and flags in the chain is important, because
231 they are loaded in the order in which they appear.
233 The following flags are supported:
237 Enables debug output. You can also force this setting from the system
238 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
239 settings override the application, with <MYAPP>_DEBUG having the highest
242 This sets the log level to 'debug' and enables full debug output on the
243 error screen. If you only want the latter, see L<< $c->debug >>.
247 Forces Catalyst to use a specific home directory, e.g.:
249 use Catalyst qw[-Home=/usr/mst];
251 This can also be done in the shell environment by setting either the
252 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
253 is replaced with the uppercased name of your application, any "::" in
254 the name will be replaced with underscores, e.g. MyApp::Web should use
255 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
257 If none of these are set, Catalyst will attempt to automatically detect the
258 home directory. If you are working in a development environment, Catalyst
259 will try and find the directory containing either Makefile.PL, Build.PL or
260 dist.ini. If the application has been installed into the system (i.e.
261 you have done C<make install>), then Catalyst will use the path to your
262 application module, without the .pm extension (e.g., /foo/MyApp if your
263 application was installed at /foo/MyApp.pm)
267 use Catalyst '-Log=warn,fatal,error';
269 Specifies a comma-delimited list of log levels.
273 Enables statistics collection and reporting.
275 use Catalyst qw/-Stats=1/;
277 You can also force this setting from the system environment with CATALYST_STATS
278 or <MYAPP>_STATS. The environment settings override the application, with
279 <MYAPP>_STATS having the highest priority.
281 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
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 rendering all
331 exceptions thrown by the called action non-fatal and pushing them onto
332 $c->error instead. If you want C<die> to propagate you need to do something
336 die join "\n", @{ $c->error } if @{ $c->error };
338 Or make sure to always return true values from your actions and write
341 $c->forward('foo') || return;
343 Another note is that C<< $c->forward >> always returns a scalar because it
344 actually returns $c->state which operates in a scalar context.
345 Thus, something like:
349 in an action that is forwarded to is going to return a scalar,
350 i.e. how many items are in that array, which is probably not what you want.
351 If you need to return an array then return a reference to it,
354 $c->stash->{array} = \@array;
356 and access it from the stash.
358 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
362 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
364 =head2 $c->detach( $action [, \@arguments ] )
366 =head2 $c->detach( $class, $method, [, \@arguments ] )
370 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
371 doesn't return to the previous action when processing is finished.
373 When called with no arguments it escapes the processing chain entirely.
377 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
379 =head2 $c->visit( $action [, \@arguments ] )
381 =head2 $c->visit( $action [, \@captures, \@arguments ] )
383 =head2 $c->visit( $class, $method, [, \@arguments ] )
385 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
387 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
388 but does a full dispatch, instead of just calling the new C<$action> /
389 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
390 you go to are called, just like a new request.
392 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
393 This means, for example, that C<< $c->action >> methods such as
394 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
395 L<reverse|Catalyst::Action/reverse> return information for the visited action
396 when they are invoked within the visited action. This is different from the
397 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
398 continues to use the $c->action object from the caller action even when
399 invoked from the called action.
401 C<< $c->stash >> is kept unchanged.
403 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
404 allows you to "wrap" another action, just as it would have been called by
405 dispatching from a URL, while the analogous
406 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
407 transfer control to another action as if it had been reached directly from a URL.
411 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
413 =head2 $c->go( $action [, \@arguments ] )
415 =head2 $c->go( $action [, \@captures, \@arguments ] )
417 =head2 $c->go( $class, $method, [, \@arguments ] )
419 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
421 The relationship between C<go> and
422 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
423 the relationship between
424 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
425 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
426 C<< $c->go >> will perform a full dispatch on the specified action or method,
427 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
428 C<go> escapes the processing of the current request chain on completion, and
429 does not return to its caller.
431 @arguments are arguments to the final destination of $action. @captures are
432 arguments to the intermediate steps, if any, on the way to the final sub of
437 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
443 Returns the current L<Catalyst::Response> object, see there for details.
447 Returns a hashref to the stash, which may be used to store data and pass
448 it between components during a request. You can also set hash keys by
449 passing arguments. The stash is automatically sent to the view. The
450 stash is cleared at the end of a request; it cannot be used for
451 persistent storage (for this you must use a session; see
452 L<Catalyst::Plugin::Session> for a complete system integrated with
455 $c->stash->{foo} = $bar;
456 $c->stash( { moose => 'majestic', qux => 0 } );
457 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
459 # stash is automatically passed to the view for use in a template
460 $c->forward( 'MyApp::View::TT' );
464 around stash => sub {
467 my $stash = $orig->($c);
469 my $new_stash = @_ > 1 ? {@_} : $_[0];
470 croak('stash takes a hash or hashref') unless ref $new_stash;
471 foreach my $key ( keys %$new_stash ) {
472 $stash->{$key} = $new_stash->{$key};
482 =head2 $c->error($error, ...)
484 =head2 $c->error($arrayref)
486 Returns an arrayref containing error messages. If Catalyst encounters an
487 error while processing a request, it stores the error in $c->error. This
488 method should only be used to store fatal error messages.
490 my @error = @{ $c->error };
494 $c->error('Something bad happened');
501 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
502 croak @$error unless ref $c;
503 push @{ $c->{error} }, @$error;
505 elsif ( defined $_[0] ) { $c->{error} = undef }
506 return $c->{error} || [];
512 Contains the return value of the last executed action.
513 Note that << $c->state >> operates in a scalar context which means that all
514 values it returns are scalar.
516 =head2 $c->clear_errors
518 Clear errors. You probably don't want to clear the errors unless you are
519 implementing a custom error screen.
521 This is equivalent to running
532 sub _comp_search_prefixes {
534 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
537 # search components given a name and some prefixes
538 sub _comp_names_search_prefixes {
539 my ( $c, $name, @prefixes ) = @_;
540 my $appclass = ref $c || $c;
541 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
542 $filter = qr/$filter/; # Compile regex now rather than once per loop
544 # map the original component name to the sub part that we will search against
545 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
546 grep { /$filter/ } keys %{ $c->components };
548 # undef for a name will return all
549 return keys %eligible if !defined $name;
551 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
552 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
554 return @result if @result;
556 # if we were given a regexp to search against, we're done.
557 return if $name->$_isa('Regexp');
559 # skip regexp fallback if configured
561 if $appclass->config->{disable_component_resolution_regex_fallback};
565 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
567 # no results? try against full names
569 @result = grep { m{$query} } keys %eligible;
572 # don't warn if we didn't find any results, it just might not exist
574 # Disgusting hack to work out correct method name
575 my $warn_for = lc $prefixes[0];
576 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
577 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
578 "component resolution is unreliable and unsafe.";
579 my $short = $result[0];
580 # remove the component namespace prefix
581 $short =~ s/.*?(Model|Controller|View):://;
582 my $shortmess = Carp::shortmess('');
583 if ($shortmess =~ m#Catalyst/Plugin#) {
584 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
586 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
587 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
588 "component's config";
590 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
591 "but if you really wanted to search, pass in a regexp as the argument " .
592 "like so: \$c->${warn_for}(qr/${name}/)";
594 $c->log->warn( "${msg}$shortmess" );
600 # Find possible names for a prefix
602 my ( $c, @prefixes ) = @_;
603 my $appclass = ref $c || $c;
605 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
607 my @names = map { s{$filter}{}; $_; }
608 $c->_comp_names_search_prefixes( undef, @prefixes );
613 # Filter a component before returning by calling ACCEPT_CONTEXT if available
614 sub _filter_component {
615 my ( $c, $comp, @args ) = @_;
617 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
618 return $comp->ACCEPT_CONTEXT( $c, @args );
624 =head2 COMPONENT ACCESSORS
626 =head2 $c->controller($name)
628 Gets a L<Catalyst::Controller> instance by name.
630 $c->controller('Foo')->do_stuff;
632 If the name is omitted, will return the controller for the dispatched
635 If you want to search for controllers, pass in a regexp as the argument.
637 # find all controllers that start with Foo
638 my @foo_controllers = $c->controller(qr{^Foo});
644 my ( $c, $name, @args ) = @_;
646 my $appclass = ref($c) || $c;
648 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
649 my $comps = $c->components;
650 my $check = $appclass."::Controller::".$name;
651 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
653 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
654 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
655 return $c->_filter_component( $result[ 0 ], @args );
658 return $c->component( $c->action->class );
661 =head2 $c->model($name)
663 Gets a L<Catalyst::Model> instance by name.
665 $c->model('Foo')->do_stuff;
667 Any extra arguments are directly passed to ACCEPT_CONTEXT.
669 If the name is omitted, it will look for
670 - a model object in $c->stash->{current_model_instance}, then
671 - a model name in $c->stash->{current_model}, then
672 - a config setting 'default_model', or
673 - check if there is only one model, and return it if that's the case.
675 If you want to search for models, pass in a regexp as the argument.
677 # find all models that start with Foo
678 my @foo_models = $c->model(qr{^Foo});
683 my ( $c, $name, @args ) = @_;
684 my $appclass = ref($c) || $c;
686 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
687 my $comps = $c->components;
688 my $check = $appclass."::Model::".$name;
689 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
691 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
692 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
693 return $c->_filter_component( $result[ 0 ], @args );
697 return $c->stash->{current_model_instance}
698 if $c->stash->{current_model_instance};
699 return $c->model( $c->stash->{current_model} )
700 if $c->stash->{current_model};
702 return $c->model( $appclass->config->{default_model} )
703 if $appclass->config->{default_model};
705 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
708 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
709 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
710 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
711 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
712 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
715 return $c->_filter_component( $comp );
719 =head2 $c->view($name)
721 Gets a L<Catalyst::View> instance by name.
723 $c->view('Foo')->do_stuff;
725 Any extra arguments are directly passed to ACCEPT_CONTEXT.
727 If the name is omitted, it will look for
728 - a view object in $c->stash->{current_view_instance}, then
729 - a view name in $c->stash->{current_view}, then
730 - a config setting 'default_view', or
731 - check if there is only one view, and return it if that's the case.
733 If you want to search for views, pass in a regexp as the argument.
735 # find all views that start with Foo
736 my @foo_views = $c->view(qr{^Foo});
741 my ( $c, $name, @args ) = @_;
743 my $appclass = ref($c) || $c;
745 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
746 my $comps = $c->components;
747 my $check = $appclass."::View::".$name;
748 if( exists $comps->{$check} ) {
749 return $c->_filter_component( $comps->{$check}, @args );
752 $c->log->warn( "Attempted to use view '$check', but does not exist" );
755 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
756 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
757 return $c->_filter_component( $result[ 0 ], @args );
761 return $c->stash->{current_view_instance}
762 if $c->stash->{current_view_instance};
763 return $c->view( $c->stash->{current_view} )
764 if $c->stash->{current_view};
766 return $c->view( $appclass->config->{default_view} )
767 if $appclass->config->{default_view};
769 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
772 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
773 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
774 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
775 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
776 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
779 return $c->_filter_component( $comp );
782 =head2 $c->controllers
784 Returns the available names which can be passed to $c->controller
790 return $c->_comp_names(qw/Controller C/);
795 Returns the available names which can be passed to $c->model
801 return $c->_comp_names(qw/Model M/);
807 Returns the available names which can be passed to $c->view
813 return $c->_comp_names(qw/View V/);
816 =head2 $c->comp($name)
818 =head2 $c->component($name)
820 Gets a component object by name. This method is not recommended,
821 unless you want to get a specific component by full
822 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
823 should be used instead.
825 If C<$name> is a regexp, a list of components matched against the full
826 component name will be returned.
828 If Catalyst can't find a component by name, it will fallback to regex
829 matching by default. To disable this behaviour set
830 disable_component_resolution_regex_fallback to a true value.
832 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
837 my ( $c, $name, @args ) = @_;
840 my $comps = $c->components;
843 # is it the exact name?
844 return $c->_filter_component( $comps->{ $name }, @args )
845 if exists $comps->{ $name };
847 # perhaps we just omitted "MyApp"?
848 my $composed = ( ref $c || $c ) . "::${name}";
849 return $c->_filter_component( $comps->{ $composed }, @args )
850 if exists $comps->{ $composed };
852 # search all of the models, views and controllers
853 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
854 return $c->_filter_component( $comp, @args ) if $comp;
858 if $c->config->{disable_component_resolution_regex_fallback};
860 # This is here so $c->comp( '::M::' ) works
861 my $query = ref $name ? $name : qr{$name}i;
863 my @result = grep { m{$query} } keys %{ $c->components };
864 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
867 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
868 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
869 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
870 return $c->_filter_component( $result[ 0 ], @args );
873 # I would expect to return an empty list here, but that breaks back-compat
877 return sort keys %{ $c->components };
880 =head2 CLASS DATA AND HELPER CLASSES
884 Returns or takes a hashref containing the application's configuration.
886 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
888 You can also use a C<YAML>, C<XML> or L<Config::General> config file
889 like C<myapp.conf> in your applications home directory. See
890 L<Catalyst::Plugin::ConfigLoader>.
892 =head3 Cascading configuration
894 The config method is present on all Catalyst components, and configuration
895 will be merged when an application is started. Configuration loaded with
896 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
897 followed by configuration in your top level C<MyApp> class. These two
898 configurations are merged, and then configuration data whose hash key matches a
899 component name is merged with configuration for that component.
901 The configuration for a component is then passed to the C<new> method when a
902 component is constructed.
906 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
907 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
909 will mean that C<MyApp::Model::Foo> receives the following data when
912 MyApp::Model::Foo->new({
918 It's common practice to use a Moose attribute
919 on the receiving component to access the config value.
921 package MyApp::Model::Foo;
925 # this attr will receive 'baz' at construction time
931 You can then get the value 'baz' by calling $c->model('Foo')->bar
932 (or $self->bar inside code in the model).
934 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
935 as a way of reading config within your code, as this B<will not> give you the
936 correctly merged config back. You B<MUST> take the config values supplied to
937 the constructor and use those instead.
941 around config => sub {
945 croak('Setting config after setup has been run is not allowed.')
946 if ( @_ and $c->setup_finished );
953 Returns the logging object instance. Unless it is already set, Catalyst
954 sets this up with a L<Catalyst::Log> object. To use your own log class,
955 set the logger with the C<< __PACKAGE__->log >> method prior to calling
956 C<< __PACKAGE__->setup >>.
958 __PACKAGE__->log( MyLogger->new );
963 $c->log->info( 'Now logging with my own logger!' );
965 Your log class should implement the methods described in
971 Returns 1 if debug mode is enabled, 0 otherwise.
973 You can enable debug mode in several ways:
977 =item By calling myapp_server.pl with the -d flag
979 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
981 =item The -Debug option in your MyApp.pm
983 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
987 The first three also set the log level to 'debug'.
989 Calling C<< $c->debug(1) >> has no effect.
995 =head2 $c->dispatcher
997 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1001 Returns the engine instance. See L<Catalyst::Engine>.
1004 =head2 UTILITY METHODS
1006 =head2 $c->path_to(@path)
1008 Merges C<@path> with C<< $c->config->{home} >> and returns a
1009 L<Path::Class::Dir> object. Note you can usually use this object as
1010 a filename, but sometimes you will have to explicitly stringify it
1011 yourself by calling the C<< ->stringify >> method.
1015 $c->path_to( 'db', 'sqlite.db' );
1020 my ( $c, @path ) = @_;
1021 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1022 if ( -d $path ) { return $path }
1023 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1027 my ( $class, $name, $plugin, @args ) = @_;
1029 # See block comment in t/unit_core_plugin.t
1030 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1032 $class->_register_plugin( $plugin, 1 );
1034 eval { $plugin->import };
1035 $class->mk_classdata($name);
1037 eval { $obj = $plugin->new(@args) };
1040 Catalyst::Exception->throw( message =>
1041 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1044 $class->$name($obj);
1045 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1051 Initializes the dispatcher and engine, loads any plugins, and loads the
1052 model, view, and controller components. You may also specify an array
1053 of plugins to load here, if you choose to not load them in the C<use
1057 MyApp->setup( qw/-Debug/ );
1059 B<Note:> You B<should not> wrap this method with method modifiers
1060 or bad things will happen - wrap the C<setup_finalize> method instead.
1065 my ( $class, @arguments ) = @_;
1066 croak('Running setup more than once')
1067 if ( $class->setup_finished );
1069 unless ( $class->isa('Catalyst') ) {
1071 Catalyst::Exception->throw(
1072 message => qq/'$class' does not inherit from Catalyst/ );
1075 if ( $class->arguments ) {
1076 @arguments = ( @arguments, @{ $class->arguments } );
1082 foreach (@arguments) {
1086 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1088 elsif (/^-(\w+)=?(.*)$/) {
1089 $flags->{ lc $1 } = $2;
1092 push @{ $flags->{plugins} }, $_;
1096 $class->setup_home( delete $flags->{home} );
1098 $class->setup_log( delete $flags->{log} );
1099 $class->setup_plugins( delete $flags->{plugins} );
1100 $class->setup_dispatcher( delete $flags->{dispatcher} );
1101 if (my $engine = delete $flags->{engine}) {
1102 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1104 $class->setup_engine();
1105 $class->setup_stats( delete $flags->{stats} );
1107 for my $flag ( sort keys %{$flags} ) {
1109 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1110 &$code( $class, delete $flags->{$flag} );
1113 $class->log->warn(qq/Unknown flag "$flag"/);
1117 eval { require Catalyst::Devel; };
1118 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1119 $class->log->warn(<<"EOF");
1120 You are running an old script!
1122 Please update by running (this will overwrite existing files):
1123 catalyst.pl -force -scripts $class
1125 or (this will not overwrite existing files):
1126 catalyst.pl -scripts $class
1131 if ( $class->debug ) {
1132 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1135 my $column_width = Catalyst::Utils::term_width() - 6;
1136 my $t = Text::SimpleTable->new($column_width);
1137 $t->row($_) for @plugins;
1138 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1141 my $dispatcher = $class->dispatcher;
1142 my $engine = $class->engine;
1143 my $home = $class->config->{home};
1145 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1146 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1150 ? $class->log->debug(qq/Found home "$home"/)
1151 : $class->log->debug(qq/Home "$home" doesn't exist/)
1152 : $class->log->debug(q/Couldn't find home/);
1155 # Call plugins setup, this is stupid and evil.
1156 # Also screws C3 badly on 5.10, hack to avoid.
1158 no warnings qw/redefine/;
1159 local *setup = sub { };
1160 $class->setup unless $Catalyst::__AM_RESTARTING;
1163 # Initialize our data structure
1164 $class->components( {} );
1166 $class->setup_components;
1168 if ( $class->debug ) {
1169 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1170 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1171 for my $comp ( sort keys %{ $class->components } ) {
1172 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1173 $t->row( $comp, $type );
1175 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1176 if ( keys %{ $class->components } );
1179 # Add our self to components, since we are also a component
1180 if( $class->isa('Catalyst::Controller') ){
1181 $class->components->{$class} = $class;
1184 $class->setup_actions;
1186 if ( $class->debug ) {
1187 my $name = $class->config->{name} || 'Application';
1188 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1191 if ($class->config->{case_sensitive}) {
1192 $class->log->warn($class . "->config->{case_sensitive} is set.");
1193 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1196 $class->setup_finalize;
1197 # Should be the last thing we do so that user things hooking
1198 # setup_finalize can log..
1199 $class->log->_flush() if $class->log->can('_flush');
1200 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1203 =head2 $app->setup_finalize
1205 A hook to attach modifiers to. This method does not do anything except set the
1206 C<setup_finished> accessor.
1208 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1212 after setup_finalize => sub {
1220 sub setup_finalize {
1222 $class->setup_finished(1);
1225 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1227 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1229 Constructs an absolute L<URI> object based on the application root, the
1230 provided path, and the additional arguments and query parameters provided.
1231 When used as a string, provides a textual URI. If you need more flexibility
1232 than this (i.e. the option to provide relative URIs etc.) see
1233 L<Catalyst::Plugin::SmartURI>.
1235 If no arguments are provided, the URI for the current action is returned.
1236 To return the current action and also provide @args, use
1237 C<< $c->uri_for( $c->action, @args ) >>.
1239 If the first argument is a string, it is taken as a public URI path relative
1240 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1241 relative to the application root (if it does). It is then merged with
1242 C<< $c->request->base >>; any C<@args> are appended as additional path
1243 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1245 If the first argument is a L<Catalyst::Action> it represents an action which
1246 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1247 optional C<\@captures> argument (an arrayref) allows passing the captured
1248 variables that are needed to fill in the paths of Chained and Regex actions;
1249 once the path is resolved, C<uri_for> continues as though a path was
1250 provided, appending any arguments or parameters and creating an absolute
1253 The captures for the current request can be found in
1254 C<< $c->request->captures >>, and actions can be resolved using
1255 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1256 path, use C<< $c->uri_for_action >> instead.
1258 # Equivalent to $c->req->uri
1259 $c->uri_for($c->action, $c->req->captures,
1260 @{ $c->req->args }, $c->req->params);
1262 # For the Foo action in the Bar controller
1263 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1265 # Path to a static resource
1266 $c->uri_for('/static/images/logo.png');
1271 my ( $c, $path, @args ) = @_;
1273 if ( $path->$_isa('Catalyst::Controller') ) {
1274 $path = $path->path_prefix;
1279 undef($path) if (defined $path && $path eq '');
1282 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1284 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1285 foreach my $arg (@args) {
1286 utf8::encode($arg) if utf8::is_utf8($arg);
1287 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1290 if ( $path->$_isa('Catalyst::Action') ) { # action object
1291 s|/|%2F|g for @args;
1292 my $captures = [ map { s|/|%2F|g; $_; }
1293 ( scalar @args && ref $args[0] eq 'ARRAY'
1297 foreach my $capture (@$captures) {
1298 utf8::encode($capture) if utf8::is_utf8($capture);
1299 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1303 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1304 if( !@args && $action->number_of_args ) {
1305 my $expanded_action = $c->dispatcher->expand_action( $action );
1307 my $num_captures = $expanded_action->number_of_captures;
1308 unshift @args, splice @$captures, $num_captures;
1311 $path = $c->dispatcher->uri_for_action($action, $captures);
1312 if (not defined $path) {
1313 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1317 $path = '/' if $path eq '';
1320 unshift(@args, $path);
1322 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1323 my $namespace = $c->namespace;
1324 if (defined $path) { # cheesy hack to handle path '../foo'
1325 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1327 unshift(@args, $namespace || '');
1330 # join args with '/', or a blank string
1331 my $args = join('/', grep { defined($_) } @args);
1332 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1334 my $base = $c->req->base;
1335 my $class = ref($base);
1336 $base =~ s{(?<!/)$}{/};
1340 if (my @keys = keys %$params) {
1341 # somewhat lifted from URI::_query's query_form
1342 $query = '?'.join('&', map {
1343 my $val = $params->{$_};
1344 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1347 $val = '' unless defined $val;
1350 utf8::encode( $param ) if utf8::is_utf8($param);
1351 # using the URI::Escape pattern here so utf8 chars survive
1352 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1354 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1358 my $res = bless(\"${base}${args}${query}", $class);
1362 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1364 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1370 A private path to the Catalyst action you want to create a URI for.
1372 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1373 >> and passing the resulting C<$action> and the remaining arguments to C<<
1376 You can also pass in a Catalyst::Action object, in which case it is passed to
1379 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.
1381 For example, if the action looks like:
1383 package MyApp::Controller::Users;
1385 sub lst : Path('the-list') {}
1389 $c->uri_for_action('/users/lst')
1391 and it will create the URI /users/the-list.
1393 =item \@captures_and_args?
1395 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1396 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1397 to interpolate all the parameters in the URI.
1401 Optional list of extra arguments - can be supplied in the
1402 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1405 Your action can have zero, a fixed or a variable number of args (e.g.
1406 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1408 =item \%query_values?
1410 Optional array reference of query parameters to append. E.g.
1416 /rest/of/your/uri?foo=bar
1422 sub uri_for_action {
1423 my ( $c, $path, @args ) = @_;
1424 my $action = blessed($path)
1426 : $c->dispatcher->get_action_by_path($path);
1427 unless (defined $action) {
1428 croak "Can't find action for path '$path'";
1430 return $c->uri_for( $action, @args );
1433 =head2 $c->welcome_message
1435 Returns the Catalyst welcome HTML page.
1439 sub welcome_message {
1441 my $name = $c->config->{name};
1442 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1443 my $prefix = Catalyst::Utils::appprefix( ref $c );
1444 $c->response->content_type('text/html; charset=utf-8');
1446 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1447 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1448 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1450 <meta http-equiv="Content-Language" content="en" />
1451 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1452 <title>$name on Catalyst $VERSION</title>
1453 <style type="text/css">
1456 background-color: #eee;
1463 margin-bottom: 10px;
1465 background-color: #ccc;
1466 border: 1px solid #aaa;
1471 font-family: verdana, tahoma, sans-serif;
1474 font-family: verdana, tahoma, sans-serif;
1477 text-decoration: none;
1479 border-bottom: 1px dotted #bbb;
1481 :link:hover, :visited:hover {
1494 background-color: #fff;
1495 border: 1px solid #aaa;
1499 font-weight: normal;
1521 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1526 <img src="$logo" alt="Catalyst Logo" />
1528 <p>Welcome to the world of Catalyst.
1529 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1530 framework will make web development something you had
1531 never expected it to be: Fun, rewarding, and quick.</p>
1532 <h2>What to do now?</h2>
1533 <p>That really depends on what <b>you</b> want to do.
1534 We do, however, provide you with a few starting points.</p>
1535 <p>If you want to jump right into web development with Catalyst
1536 you might want to start with a tutorial.</p>
1537 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1539 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1541 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1542 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1544 <h2>What to do next?</h2>
1545 <p>Next it's time to write an actual application. Use the
1546 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1547 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1548 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1549 they can save you a lot of work.</p>
1550 <pre><code>script/${prefix}_create.pl --help</code></pre>
1551 <p>Also, be sure to check out the vast and growing
1552 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1553 you are likely to find what you need there.
1557 <p>Catalyst has a very active community. Here are the main places to
1558 get in touch with us.</p>
1561 <a href="http://dev.catalyst.perl.org">Wiki</a>
1564 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1567 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1570 <h2>In conclusion</h2>
1571 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1572 as we enjoyed making it. Please contact us if you have ideas
1573 for improvement or other feedback.</p>
1583 Contains a hash of options passed from the application script, including
1584 the original ARGV the script received, the processed values from that
1585 ARGV and any extra arguments to the script which were not processed.
1587 This can be used to add custom options to your application's scripts
1588 and setup your application differently depending on the values of these
1591 =head1 INTERNAL METHODS
1593 These methods are not meant to be used by end users.
1595 =head2 $c->components
1597 Returns a hash of components.
1599 =head2 $c->context_class
1601 Returns or sets the context class.
1605 Returns a hashref containing coderefs and execution counts (needed for
1606 deep recursion detection).
1610 Returns the number of actions on the current internal execution stack.
1614 Dispatches a request to actions.
1618 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1620 =head2 $c->dispatcher_class
1622 Returns or sets the dispatcher class.
1624 =head2 $c->dump_these
1626 Returns a list of 2-element array references (name, structure) pairs
1627 that will be dumped on the error page in debug mode.
1633 [ Request => $c->req ],
1634 [ Response => $c->res ],
1635 [ Stash => $c->stash ],
1636 [ Config => $c->config ];
1639 =head2 $c->engine_class
1641 Returns or sets the engine class.
1643 =head2 $c->execute( $class, $coderef )
1645 Execute a coderef in given class and catch exceptions. Errors are available
1651 my ( $c, $class, $code ) = @_;
1652 $class = $c->component($class) || $class;
1655 if ( $c->depth >= $RECURSION ) {
1656 my $action = $code->reverse();
1657 $action = "/$action" unless $action =~ /->/;
1658 my $error = qq/Deep recursion detected calling "${action}"/;
1659 $c->log->error($error);
1665 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1667 push( @{ $c->stack }, $code );
1669 no warnings 'recursion';
1670 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1671 # I have no idea how, ergo $ret (which appears to fix the issue)
1672 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1674 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1676 my $last = pop( @{ $c->stack } );
1678 if ( my $error = $@ ) {
1679 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1680 $error->rethrow if $c->depth > 1;
1682 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1683 $error->rethrow if $c->depth > 0;
1686 unless ( ref $error ) {
1687 no warnings 'uninitialized';
1689 my $class = $last->class;
1690 my $name = $last->name;
1691 $error = qq/Caught exception in $class->$name "$error"/;
1700 sub _stats_start_execute {
1701 my ( $c, $code ) = @_;
1702 my $appclass = ref($c) || $c;
1703 return if ( ( $code->name =~ /^_.*/ )
1704 && ( !$appclass->config->{show_internal_actions} ) );
1706 my $action_name = $code->reverse();
1707 $c->counter->{$action_name}++;
1709 my $action = $action_name;
1710 $action = "/$action" unless $action =~ /->/;
1712 # determine if the call was the result of a forward
1713 # this is done by walking up the call stack and looking for a calling
1714 # sub of Catalyst::forward before the eval
1716 for my $index ( 2 .. 11 ) {
1718 if ( ( caller($index) )[0] eq 'Catalyst'
1719 && ( caller($index) )[3] eq '(eval)' );
1721 if ( ( caller($index) )[3] =~ /forward$/ ) {
1722 $callsub = ( caller($index) )[3];
1723 $action = "-> $action";
1728 my $uid = $action_name . $c->counter->{$action_name};
1730 # is this a root-level call or a forwarded call?
1731 if ( $callsub =~ /forward$/ ) {
1732 my $parent = $c->stack->[-1];
1734 # forward, locate the caller
1735 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1738 parent => "$parent" . $c->counter->{"$parent"},
1744 # forward with no caller may come from a plugin
1763 sub _stats_finish_execute {
1764 my ( $c, $info ) = @_;
1765 $c->stats->profile( end => $info );
1770 Finalizes the request.
1777 for my $error ( @{ $c->error } ) {
1778 $c->log->error($error);
1781 # Allow engine to handle finalize flow (for POE)
1782 my $engine = $c->engine;
1783 if ( my $code = $engine->can('finalize') ) {
1788 $c->finalize_uploads;
1791 if ( $#{ $c->error } >= 0 ) {
1795 $c->finalize_headers unless $c->response->finalized_headers;
1798 if ( $c->request->method eq 'HEAD' ) {
1799 $c->response->body('');
1807 if ($c->use_stats) {
1808 my $elapsed = sprintf '%f', $c->stats->elapsed;
1809 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1811 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1814 return $c->response->status;
1817 =head2 $c->finalize_body
1823 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1825 =head2 $c->finalize_cookies
1831 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1833 =head2 $c->finalize_error
1839 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1841 =head2 $c->finalize_headers
1847 sub finalize_headers {
1850 my $response = $c->response; #accessor calls can add up?
1852 # Check if we already finalized headers
1853 return if $response->finalized_headers;
1856 if ( my $location = $response->redirect ) {
1857 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1858 $response->header( Location => $location );
1860 if ( !$response->has_body ) {
1861 # Add a default body if none is already present
1862 $response->body(<<"EOF");
1863 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1864 <html xmlns="http://www.w3.org/1999/xhtml">
1866 <title>Moved</title>
1869 <p>This item has moved <a href="$location">here</a>.</p>
1873 $response->content_type('text/html; charset=utf-8');
1878 if ( defined $response->body && length $response->body && !$response->content_length ) {
1880 # get the length from a filehandle
1881 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1883 my $size = -s $response->body;
1885 $response->content_length( $size );
1888 $c->log->warn('Serving filehandle without a content-length');
1892 # everything should be bytes at this point, but just in case
1893 $response->content_length( length( $response->body ) );
1898 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1899 $response->headers->remove_header("Content-Length");
1900 $response->body('');
1903 $c->finalize_cookies;
1905 $c->response->finalize_headers();
1908 $response->finalized_headers(1);
1911 =head2 $c->finalize_output
1913 An alias for finalize_body.
1915 =head2 $c->finalize_read
1917 Finalizes the input after reading is complete.
1921 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1923 =head2 $c->finalize_uploads
1925 Finalizes uploads. Cleans up any temporary files.
1929 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1931 =head2 $c->get_action( $action, $namespace )
1933 Gets an action in a given namespace.
1937 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1939 =head2 $c->get_actions( $action, $namespace )
1941 Gets all actions of a given name in a namespace and all parent
1946 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1948 =head2 $app->handle_request( @arguments )
1950 Called to handle each HTTP request.
1954 sub handle_request {
1955 my ( $class, @arguments ) = @_;
1957 # Always expect worst case!
1960 if ($class->debug) {
1961 my $secs = time - $START || 1;
1962 my $av = sprintf '%.3f', $COUNT / $secs;
1963 my $time = localtime time;
1964 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1967 my $c = $class->prepare(@arguments);
1969 $status = $c->finalize;
1972 chomp(my $error = $_);
1973 $class->log->error(qq/Caught exception in engine "$error"/);
1978 if(my $coderef = $class->log->can('_flush')){
1979 $class->log->$coderef();
1984 =head2 $class->prepare( @arguments )
1986 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1993 predicate => '_has_uploadtmp',
1997 my ( $class, @arguments ) = @_;
2000 # After the app/ctxt split, this should become an attribute based on something passed
2001 # into the application.
2002 $class->context_class( ref $class || $class ) unless $class->context_class;
2004 my $uploadtmp = $class->config->{uploadtmp};
2005 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2007 $c->response->_context($c);
2009 #surely this is not the most efficient way to do things...
2010 $c->stats($class->stats_class->new)->enable($c->use_stats);
2011 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2012 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2016 # Allow engine to direct the prepare flow (for POE)
2017 if ( my $prepare = $c->engine->can('prepare') ) {
2018 $c->engine->$prepare( $c, @arguments );
2021 $c->prepare_request(@arguments);
2022 $c->prepare_connection;
2023 $c->prepare_query_parameters;
2024 $c->prepare_headers; # Just hooks, no longer needed - they just
2025 $c->prepare_cookies; # cause the lazy attribute on req to build
2028 # Prepare the body for reading, either by prepare_body
2029 # or the user, if they are using $c->read
2032 # Parse the body unless the user wants it on-demand
2033 unless ( ref($c)->config->{parse_on_demand} ) {
2039 # VERY ugly and probably shouldn't rely on ->finalize actually working
2041 # failed prepare is always due to an invalid request, right?
2042 $c->response->status(400);
2043 $c->response->content_type('text/plain');
2044 $c->response->body('Bad Request');
2045 # Note we call finalize and then die here, which escapes
2046 # finalize being called in the enclosing block..
2047 # It in fact couldn't be called, as we don't return $c..
2048 # This is a mess - but I'm unsure you can fix this without
2049 # breaking compat for people doing crazy things (we should set
2050 # the 400 and just return the ctx here IMO, letting finalize get called
2061 =head2 $c->prepare_action
2063 Prepares action. See L<Catalyst::Dispatcher>.
2067 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2069 =head2 $c->prepare_body
2071 Prepares message body.
2078 return if $c->request->_has_body;
2080 # Initialize on-demand data
2081 $c->engine->prepare_body( $c, @_ );
2082 $c->prepare_parameters;
2083 $c->prepare_uploads;
2086 =head2 $c->prepare_body_chunk( $chunk )
2088 Prepares a chunk of data before sending it to L<HTTP::Body>.
2090 See L<Catalyst::Engine>.
2094 sub prepare_body_chunk {
2096 $c->engine->prepare_body_chunk( $c, @_ );
2099 =head2 $c->prepare_body_parameters
2101 Prepares body parameters.
2105 sub prepare_body_parameters {
2107 $c->engine->prepare_body_parameters( $c, @_ );
2110 =head2 $c->prepare_connection
2112 Prepares connection.
2116 sub prepare_connection {
2118 # XXX - This is called on the engine (not the request) to maintain
2119 # Engine::PSGI back compat.
2120 $c->engine->prepare_connection($c);
2123 =head2 $c->prepare_cookies
2125 Prepares cookies by ensuring that the attribute on the request
2126 object has been built.
2130 sub prepare_cookies { my $c = shift; $c->request->cookies }
2132 =head2 $c->prepare_headers
2134 Prepares request headers by ensuring that the attribute on the request
2135 object has been built.
2139 sub prepare_headers { my $c = shift; $c->request->headers }
2141 =head2 $c->prepare_parameters
2143 Prepares parameters.
2147 sub prepare_parameters {
2149 $c->prepare_body_parameters;
2150 $c->engine->prepare_parameters( $c, @_ );
2153 =head2 $c->prepare_path
2155 Prepares path and base.
2159 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2161 =head2 $c->prepare_query_parameters
2163 Prepares query parameters.
2167 sub prepare_query_parameters {
2170 $c->engine->prepare_query_parameters( $c, @_ );
2173 =head2 $c->log_request
2175 Writes information about the request to the debug logs. This includes:
2179 =item * Request method, path, and remote IP address
2181 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2183 =item * Request parameters
2185 =item * File uploads
2194 return unless $c->debug;
2196 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2197 my $request = $dump->[1];
2199 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2201 $path = '/' unless length $path;
2203 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2205 $c->log_request_headers($request->headers);
2207 if ( my $keywords = $request->query_keywords ) {
2208 $c->log->debug("Query keywords are: $keywords");
2211 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2213 $c->log_request_uploads($request);
2216 =head2 $c->log_response
2218 Writes information about the response to the debug logs by calling
2219 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2226 return unless $c->debug;
2228 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2229 my $response = $dump->[1];
2231 $c->log_response_status_line($response);
2232 $c->log_response_headers($response->headers);
2235 =head2 $c->log_response_status_line($response)
2237 Writes one line of information about the response to the debug logs. This includes:
2241 =item * Response status code
2243 =item * Content-Type header (if present)
2245 =item * Content-Length header (if present)
2251 sub log_response_status_line {
2252 my ($c, $response) = @_;
2256 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2257 $response->status || 'unknown',
2258 $response->headers->header('Content-Type') || 'unknown',
2259 $response->headers->header('Content-Length') || 'unknown'
2264 =head2 $c->log_response_headers($headers);
2266 Hook method which can be wrapped by plugins to log the response headers.
2267 No-op in the default implementation.
2271 sub log_response_headers {}
2273 =head2 $c->log_request_parameters( query => {}, body => {} )
2275 Logs request parameters to debug logs
2279 sub log_request_parameters {
2281 my %all_params = @_;
2283 return unless $c->debug;
2285 my $column_width = Catalyst::Utils::term_width() - 44;
2286 foreach my $type (qw(query body)) {
2287 my $params = $all_params{$type};
2288 next if ! keys %$params;
2289 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2290 for my $key ( sort keys %$params ) {
2291 my $param = $params->{$key};
2292 my $value = defined($param) ? $param : '';
2293 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2295 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2299 =head2 $c->log_request_uploads
2301 Logs file uploads included in the request to the debug logs.
2302 The parameter name, filename, file type, and file size are all included in
2307 sub log_request_uploads {
2309 my $request = shift;
2310 return unless $c->debug;
2311 my $uploads = $request->uploads;
2312 if ( keys %$uploads ) {
2313 my $t = Text::SimpleTable->new(
2314 [ 12, 'Parameter' ],
2319 for my $key ( sort keys %$uploads ) {
2320 my $upload = $uploads->{$key};
2321 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2322 $t->row( $key, $u->filename, $u->type, $u->size );
2325 $c->log->debug( "File Uploads are:\n" . $t->draw );
2329 =head2 $c->log_request_headers($headers);
2331 Hook method which can be wrapped by plugins to log the request headers.
2332 No-op in the default implementation.
2336 sub log_request_headers {}
2338 =head2 $c->log_headers($type => $headers)
2340 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2347 my $headers = shift; # an HTTP::Headers instance
2349 return unless $c->debug;
2351 my $column_width = Catalyst::Utils::term_width() - 28;
2352 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2355 my ( $name, $value ) = @_;
2356 $t->row( $name, $value );
2359 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2363 =head2 $c->prepare_read
2365 Prepares the input for reading.
2369 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2371 =head2 $c->prepare_request
2373 Prepares the engine request.
2377 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2379 =head2 $c->prepare_uploads
2385 sub prepare_uploads {
2388 $c->engine->prepare_uploads( $c, @_ );
2391 =head2 $c->prepare_write
2393 Prepares the output for writing.
2397 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2399 =head2 $c->request_class
2401 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2403 =head2 $c->response_class
2405 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2407 =head2 $c->read( [$maxlength] )
2409 Reads a chunk of data from the request body. This method is designed to
2410 be used in a while loop, reading C<$maxlength> bytes on every call.
2411 C<$maxlength> defaults to the size of the request if not specified.
2413 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2416 Warning: If you use read(), Catalyst will not process the body,
2417 so you will not be able to access POST parameters or file uploads via
2418 $c->request. You must handle all body parsing yourself.
2422 sub read { my $c = shift; return $c->request->read( @_ ) }
2432 $app->_make_immutable_if_needed;
2433 $app->engine_loader->needs_psgi_engine_compat_hack ?
2434 $app->engine->run($app, @_) :
2435 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2438 sub _make_immutable_if_needed {
2440 my $meta = Class::MOP::get_metaclass_by_name($class);
2441 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2444 && ! { $meta->immutable_options }->{replace_constructor}
2447 warn("You made your application class ($class) immutable, "
2448 . "but did not inline the\nconstructor. "
2449 . "This will break catalyst, as your app \@ISA "
2450 . "Class::Accessor(::Fast)?\nPlease pass "
2451 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2453 unless ($meta->is_immutable) {
2454 # XXX - FIXME warning here as you should make your app immutable yourself.
2455 $meta->make_immutable(
2456 replace_constructor => 1,
2461 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2463 Sets an action in a given namespace.
2467 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2469 =head2 $c->setup_actions($component)
2471 Sets up actions for a component.
2475 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2477 =head2 $c->setup_components
2479 This method is called internally to set up the application's components.
2481 It finds modules by calling the L<locate_components> method, expands them to
2482 package names with the L<expand_component_module> method, and then installs
2483 each component into the application.
2485 The C<setup_components> config option is passed to both of the above methods.
2487 Installation of each component is performed by the L<setup_component> method,
2492 sub setup_components {
2495 my $config = $class->config->{ setup_components };
2497 my @comps = $class->locate_components($config);
2498 my %comps = map { $_ => 1 } @comps;
2500 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2501 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2502 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2503 ) if $deprecatedcatalyst_component_names;
2505 for my $component ( @comps ) {
2507 # We pass ignore_loaded here so that overlay files for (e.g.)
2508 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2509 # we know M::P::O found a file on disk so this is safe
2511 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2514 for my $component (@comps) {
2515 my $instance = $class->components->{ $component } = $class->setup_component($component);
2516 my @expanded_components = $instance->can('expand_modules')
2517 ? $instance->expand_modules( $component, $config )
2518 : $class->expand_component_module( $component, $config );
2519 for my $component (@expanded_components) {
2520 next if $comps{$component};
2521 $class->components->{ $component } = $class->setup_component($component);
2526 =head2 $c->locate_components( $setup_component_config )
2528 This method is meant to provide a list of component modules that should be
2529 setup for the application. By default, it will use L<Module::Pluggable>.
2531 Specify a C<setup_components> config option to pass additional options directly
2532 to L<Module::Pluggable>. To add additional search paths, specify a key named
2533 C<search_extra> as an array reference. Items in the array beginning with C<::>
2534 will have the application class name prepended to them.
2538 sub locate_components {
2542 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2543 my $extra = delete $config->{ search_extra } || [];
2545 push @paths, @$extra;
2547 my $locator = Module::Pluggable::Object->new(
2548 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2552 # XXX think about ditching this sort entirely
2553 my @comps = sort { length $a <=> length $b } $locator->plugins;
2558 =head2 $c->expand_component_module( $component, $setup_component_config )
2560 Components found by C<locate_components> will be passed to this method, which
2561 is expected to return a list of component (package) names to be set up.
2565 sub expand_component_module {
2566 my ($class, $module) = @_;
2567 return Devel::InnerPackage::list_packages( $module );
2570 =head2 $c->setup_component
2574 sub setup_component {
2575 my( $class, $component ) = @_;
2577 unless ( $component->can( 'COMPONENT' ) ) {
2581 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2582 my $config = $class->config->{ $suffix } || {};
2583 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2584 # methods also pass it. local to avoid pointlessly shitting in config
2585 # for the debug screen, as $component is already the key name.
2586 local $config->{catalyst_component_name} = $component;
2588 my $instance = eval { $component->COMPONENT( $class, $config ); };
2590 if ( my $error = $@ ) {
2592 Catalyst::Exception->throw(
2593 message => qq/Couldn't instantiate component "$component", "$error"/
2597 unless (blessed $instance) {
2598 my $metaclass = Moose::Util::find_meta($component);
2599 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2600 my $component_method_from = $method_meta->associated_metaclass->name;
2601 my $value = defined($instance) ? $instance : 'undef';
2602 Catalyst::Exception->throw(
2604 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2610 =head2 $c->setup_dispatcher
2616 sub setup_dispatcher {
2617 my ( $class, $dispatcher ) = @_;
2620 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2623 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2624 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2627 unless ($dispatcher) {
2628 $dispatcher = $class->dispatcher_class;
2631 Class::MOP::load_class($dispatcher);
2633 # dispatcher instance
2634 $class->dispatcher( $dispatcher->new );
2637 =head2 $c->setup_engine
2644 my ($class, $requested_engine) = @_;
2646 if (!$class->engine_loader || $requested_engine) {
2647 $class->engine_loader(
2648 Catalyst::EngineLoader->new({
2649 application_name => $class,
2650 (defined $requested_engine
2651 ? (catalyst_engine_class => $requested_engine) : ()),
2656 $class->engine_loader->catalyst_engine_class;
2660 my ($class, $requested_engine) = @_;
2663 my $loader = $class->engine_loader;
2665 if (!$loader || $requested_engine) {
2666 $loader = Catalyst::EngineLoader->new({
2667 application_name => $class,
2668 (defined $requested_engine
2669 ? (requested_engine => $requested_engine) : ()),
2672 $class->engine_loader($loader);
2675 $loader->catalyst_engine_class;
2678 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2679 return if $class->loading_psgi_file;
2681 Class::MOP::load_class($engine);
2683 if ($ENV{MOD_PERL}) {
2684 my $apache = $class->engine_loader->auto;
2686 my $meta = find_meta($class);
2687 my $was_immutable = $meta->is_immutable;
2688 my %immutable_options = $meta->immutable_options;
2689 $meta->make_mutable if $was_immutable;
2691 $meta->add_method(handler => sub {
2693 my $psgi_app = $class->_finalized_psgi_app;
2694 $apache->call_app($r, $psgi_app);
2697 $meta->make_immutable(%immutable_options) if $was_immutable;
2700 $class->engine( $engine->new );
2705 sub _finalized_psgi_app {
2708 unless ($app->_psgi_app) {
2709 my $psgi_app = $app->_setup_psgi_app;
2710 $app->_psgi_app($psgi_app);
2713 return $app->_psgi_app;
2716 sub _setup_psgi_app {
2719 for my $home (Path::Class::Dir->new($app->config->{home})) {
2720 my $psgi_file = $home->file(
2721 Catalyst::Utils::appprefix($app) . '.psgi',
2724 next unless -e $psgi_file;
2726 # If $psgi_file calls ->setup_engine, it's doing so to load
2727 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2728 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2729 # anyway. So set a flag (ick) that tells setup_engine not to populate
2730 # $c->engine or do any other things we might regret.
2732 $app->loading_psgi_file(1);
2733 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2734 $app->loading_psgi_file(0);
2737 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2740 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2742 Its content has been ignored. Please consult the Catalyst::Upgrading
2743 documentation on how to upgrade from Catalyst::Engine::PSGI.
2747 return $app->apply_default_middlewares($app->psgi_app);
2750 =head2 $c->apply_default_middlewares
2752 Adds the following L<Plack> middlewares to your application, since they are
2753 useful and commonly needed:
2755 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2756 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2757 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2758 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2759 applied since this middleware is smart enough to conditionally apply itself).
2761 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2762 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2768 sub apply_default_middlewares {
2769 my ($app, $psgi_app) = @_;
2771 $psgi_app = Plack::Middleware::Conditional->wrap(
2773 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2776 return if $app->config->{ignore_frontend_proxy};
2777 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2778 || $app->config->{using_frontend_proxy};
2782 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2783 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2784 $psgi_app = Plack::Middleware::Conditional->wrap(
2786 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2789 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2790 return unless $1 < 4.23;
2795 # we're applying this unconditionally as the middleware itself already makes
2796 # sure it doesn't fuck things up if it's not running under one of the right
2798 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2800 # And another IIS issue, this time with IIS7.
2801 $psgi_app = Plack::Middleware::Conditional->wrap(
2803 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2806 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2815 Returns a PSGI application code reference for the catalyst application
2816 C<$c>. This is the bare application without any middlewares
2817 applied. C<${myapp}.psgi> is not taken into account.
2819 This is what you want to be using to retrieve the PSGI application code
2820 reference of your Catalyst application for use in F<.psgi> files.
2826 return $app->engine->build_psgi_app($app);
2829 =head2 $c->setup_home
2831 Sets up the home directory.
2836 my ( $class, $home ) = @_;
2838 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2842 $home ||= Catalyst::Utils::home($class);
2845 #I remember recently being scolded for assigning config values like this
2846 $class->config->{home} ||= $home;
2847 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2851 =head2 $c->setup_log
2853 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2854 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2857 This method also installs a C<debug> method that returns a true value into the
2858 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2859 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2861 Note that if the log has already been setup, by either a previous call to
2862 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2863 that this method won't actually set up the log object.
2868 my ( $class, $levels ) = @_;
2871 $levels =~ s/^\s+//;
2872 $levels =~ s/\s+$//;
2873 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2875 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2876 if ( defined $env_debug ) {
2877 $levels{debug} = 1 if $env_debug; # Ugly!
2878 delete($levels{debug}) unless $env_debug;
2881 unless ( $class->log ) {
2882 $class->log( Catalyst::Log->new(keys %levels) );
2885 if ( $levels{debug} ) {
2886 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2887 $class->log->debug('Debug messages enabled');
2891 =head2 $c->setup_plugins
2897 =head2 $c->setup_stats
2899 Sets up timing statistics class.
2904 my ( $class, $stats ) = @_;
2906 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2908 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2909 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2910 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2911 $class->log->debug('Statistics enabled');
2916 =head2 $c->registered_plugins
2918 Returns a sorted list of the plugins which have either been stated in the
2921 If passed a given plugin name, it will report a boolean value indicating
2922 whether or not that plugin is loaded. A fully qualified name is required if
2923 the plugin name does not begin with C<Catalyst::Plugin::>.
2925 if ($c->registered_plugins('Some::Plugin')) {
2933 sub registered_plugins {
2935 return sort keys %{ $proto->_plugins } unless @_;
2937 return 1 if exists $proto->_plugins->{$plugin};
2938 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2941 sub _register_plugin {
2942 my ( $proto, $plugin, $instant ) = @_;
2943 my $class = ref $proto || $proto;
2945 Class::MOP::load_class( $plugin );
2946 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2947 if $plugin->isa( 'Catalyst::Component' );
2948 my $plugin_meta = Moose::Meta::Class->create($plugin);
2949 if (!$plugin_meta->has_method('new')
2950 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
2951 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
2953 if (!$instant && !$proto->_plugins->{$plugin}) {
2954 my $meta = Class::MOP::get_metaclass_by_name($class);
2955 $meta->superclasses($plugin, $meta->superclasses);
2957 $proto->_plugins->{$plugin} = 1;
2962 my ( $class, $plugins ) = @_;
2964 $class->_plugins( {} ) unless $class->_plugins;
2965 $plugins = Data::OptList::mkopt($plugins || []);
2968 [ Catalyst::Utils::resolve_namespace(
2969 $class . '::Plugin',
2970 'Catalyst::Plugin', $_->[0]
2976 for my $plugin ( reverse @plugins ) {
2977 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2978 my $meta = find_meta($plugin->[0]);
2979 next if $meta && $meta->isa('Moose::Meta::Role');
2981 $class->_register_plugin($plugin->[0]);
2985 map { $_->[0]->name, $_->[1] }
2986 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2987 map { [find_meta($_->[0]), $_->[1]] }
2990 Moose::Util::apply_all_roles(
2998 Returns an arrayref of the internal execution stack (actions that are
2999 currently executing).
3003 Returns the current timing statistics object. By default Catalyst uses
3004 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3005 L<< stats_class|/"$c->stats_class" >>.
3007 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3008 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3009 profile explicitly, although MyApp.pm still won't profile nor output anything
3012 =head2 $c->stats_class
3014 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3016 =head2 $c->use_stats
3018 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3020 Note that this is a static method, not an accessor and should be overridden
3021 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3028 =head2 $c->write( $data )
3030 Writes $data to the output stream. When using this method directly, you
3031 will need to manually set the C<Content-Length> header to the length of
3032 your output data, if known.
3039 # Finalize headers if someone manually writes output (for compat)
3040 $c->finalize_headers;
3042 return $c->response->write( @_ );
3047 Returns the Catalyst version number. Mostly useful for "powered by"
3048 messages in template systems.
3052 sub version { return $Catalyst::VERSION }
3054 =head1 CONFIGURATION
3056 There are a number of 'base' config variables which can be set:
3062 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3066 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3070 C<disable_component_resolution_regex_fallback> - Turns
3071 off the deprecated component resolution functionality so
3072 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3073 are called then regex search will not be attempted on string values and
3074 instead C<undef> will be returned.
3078 C<home> - The application home directory. In an uninstalled application,
3079 this is the top level application directory. In an installed application,
3080 this will be the directory containing C<< MyApp.pm >>.
3084 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3088 C<name> - The name of the application in debug messages and the debug and
3093 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3094 until it is accessed. This allows you to (for example) check authentication (and reject
3095 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3099 C<root> - The root directory for templates. Usually this is just a
3100 subdirectory of the home directory, but you can set it to change the
3101 templates to a different directory.
3105 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3106 namespaces from which components will be loaded (and constructed and stored in
3107 C<< $c->components >>).
3111 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3112 to be shown in hit debug tables in the test server.
3116 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3117 variable should be used for determining the request path.
3119 Most web server environments pass the requested path to the application using environment variables,
3120 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3121 exposed as C<< $c->request->base >>) and the request path below that base.
3123 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3124 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3128 =item use_request_uri_for_path => 0
3130 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3131 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3132 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3133 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3135 However this method has the major disadvantage that it is impossible to correctly decode some elements
3136 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3137 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3138 can't distinguish / vs %2F in paths (in addition to other encoded values).
3140 =item use_request_uri_for_path => 1
3142 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3143 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3144 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3146 Given that this method of path resolution is provably more correct, it is recommended that you use
3147 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3148 aware of the implications of not being able to handle encoded URI paths correctly.
3150 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3151 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3152 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3153 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3154 C<< $c->request->base >> will be incorrect.
3160 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3164 =head1 INTERNAL ACTIONS
3166 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3167 C<_ACTION>, and C<_END>. These are by default not shown in the private
3168 action table, but you can make them visible with a config parameter.
3170 MyApp->config(show_internal_actions => 1);
3172 =head1 ON-DEMAND PARSER
3174 The request body is usually parsed at the beginning of a request,
3175 but if you want to handle input yourself, you can enable on-demand
3176 parsing with a config parameter.
3178 MyApp->config(parse_on_demand => 1);
3180 =head1 PROXY SUPPORT
3182 Many production servers operate using the common double-server approach,
3183 with a lightweight frontend web server passing requests to a larger
3184 backend server. An application running on the backend server must deal
3185 with two problems: the remote user always appears to be C<127.0.0.1> and
3186 the server's hostname will appear to be C<localhost> regardless of the
3187 virtual host that the user connected through.
3189 Catalyst will automatically detect this situation when you are running
3190 the frontend and backend servers on the same machine. The following
3191 changes are made to the request.
3193 $c->req->address is set to the user's real IP address, as read from
3194 the HTTP X-Forwarded-For header.
3196 The host value for $c->req->base and $c->req->uri is set to the real
3197 host, as read from the HTTP X-Forwarded-Host header.
3199 Additionally, you may be running your backend application on an insecure
3200 connection (port 80) while your frontend proxy is running under SSL. If there
3201 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3202 tell Catalyst what port the frontend listens on. This will allow all URIs to
3203 be created properly.
3205 In the case of passing in:
3207 X-Forwarded-Port: 443
3209 All calls to C<uri_for> will result in an https link, as is expected.
3211 Obviously, your web server must support these headers for this to work.
3213 In a more complex server farm environment where you may have your
3214 frontend proxy server(s) on different machines, you will need to set a
3215 configuration option to tell Catalyst to read the proxied data from the
3218 MyApp->config(using_frontend_proxy => 1);
3220 If you do not wish to use the proxy support at all, you may set:
3222 MyApp->config(ignore_frontend_proxy => 0);
3224 =head2 Note about psgi files
3226 Note that if you supply your own .psgi file, calling
3227 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3229 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3230 in your psgi, for example:
3233 enable "Plack::Middleware::ReverseProxy";
3237 This will unconditionally add the ReverseProxy support, or you need to call
3238 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3239 apply the support depending upon your config).
3241 See L<Catalyst::PSGI> for more information.
3243 =head1 THREAD SAFETY
3245 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3246 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3247 believe the Catalyst core to be thread-safe.
3249 If you plan to operate in a threaded environment, remember that all other
3250 modules you are using must also be thread-safe. Some modules, most notably
3251 L<DBD::SQLite>, are not thread-safe.
3257 Join #catalyst on irc.perl.org.
3261 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3262 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3266 http://catalyst.perl.org
3270 http://dev.catalyst.perl.org
3274 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3276 =head2 L<Catalyst::Manual> - The Catalyst Manual
3278 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3280 =head2 L<Catalyst::Engine> - Core engine
3282 =head2 L<Catalyst::Log> - Log class.
3284 =head2 L<Catalyst::Request> - Request object
3286 =head2 L<Catalyst::Response> - Response object
3288 =head2 L<Catalyst::Test> - The test suite.
3290 =head1 PROJECT FOUNDER
3292 sri: Sebastian Riedel <sri@cpan.org>
3298 acme: Leon Brocard <leon@astray.com>
3300 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3304 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3308 andyg: Andy Grundman <andy@hybridized.org>
3310 audreyt: Audrey Tang
3312 bricas: Brian Cassidy <bricas@cpan.org>
3314 Caelum: Rafael Kitover <rkitover@io.com>
3316 chansen: Christian Hansen
3318 chicks: Christopher Hicks
3320 Chisel Wright C<pause@herlpacker.co.uk>
3322 Danijel Milicevic C<me@danijel.de>
3324 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3326 David Naughton, C<naughton@umn.edu>
3330 dhoss: Devin Austin <dhoss@cpan.org>
3332 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3336 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3338 esskar: Sascha Kiefer
3340 fireartist: Carl Franks <cfranks@cpan.org>
3342 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3344 gabb: Danijel Milicevic
3348 Gavin Henry C<ghenry@perl.me.uk>
3352 groditi: Guillermo Roditi <groditi@gmail.com>
3354 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3356 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3358 jcamacho: Juan Camacho
3360 jester: Jesse Sheidlower C<jester@panix.com>
3362 jhannah: Jay Hannah <jay@jays.net>
3368 jon: Jon Schutz <jjschutz@cpan.org>
3370 Jonathan Rockway C<< <jrockway@cpan.org> >>
3372 Kieren Diment C<kd@totaldatasolution.com>
3374 konobi: Scott McWhirter <konobi@cpan.org>
3376 marcus: Marcus Ramberg <mramberg@cpan.org>
3378 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3380 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3384 naughton: David Naughton
3386 ningu: David Kamholz <dkamholz@cpan.org>
3388 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3390 numa: Dan Sully <daniel@cpan.org>
3396 omega: Andreas Marienborg
3398 Oleg Kostyuk <cub.uanic@gmail.com>
3400 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3402 rafl: Florian Ragwitz <rafl@debian.org>
3404 random: Roland Lammel <lammel@cpan.org>
3406 Robert Sedlacek C<< <rs@474.at> >>
3408 SpiceMan: Marcel Montes
3412 szbalint: Balint Szilakszi <szbalint@cpan.org>
3414 t0m: Tomas Doran <bobtfish@bobtfish.net>
3418 Viljo Marrandi C<vilts@yahoo.com>
3420 Will Hawes C<info@whawes.co.uk>
3422 willert: Sebastian Willert <willert@cpan.org>
3424 wreis: Wallace Reis <wallace@reis.org.br>
3426 Yuval Kogman, C<nothingmuch@woobling.org>
3428 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3430 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3434 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3438 This library is free software. You can redistribute it and/or modify it under
3439 the same terms as Perl itself.
3445 __PACKAGE__->meta->make_immutable;