Remove references to the -Engine flag from docs
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
CommitLineData
fc7ec1d9 1package Catalyst;
2
a7caa492 3use Moose;
c98492ae 4use Moose::Meta::Class ();
60eabdaf 5extends 'Catalyst::Component';
2f5cb070 6use Moose::Util qw/find_meta/;
acca8cd5 7use B::Hooks::EndOfScope ();
a2f2cde9 8use Catalyst::Exception;
154ef0c8 9use Catalyst::Exception::Detach;
10use Catalyst::Exception::Go;
fc7ec1d9 11use Catalyst::Log;
fbcc39ad 12use Catalyst::Request;
13use Catalyst::Request::Upload;
14use Catalyst::Response;
812a28c9 15use Catalyst::Utils;
31375184 16use Catalyst::Controller;
62b6b631 17use Data::OptList;
364d7324 18use Devel::InnerPackage ();
c50f595c 19use Module::Pluggable::Object ();
c50f595c 20use Text::SimpleTable ();
21use Path::Class::Dir ();
22use Path::Class::File ();
c50f595c 23use URI ();
933ba403 24use URI::http;
25use URI::https;
5513038d 26use Tree::Simple qw/use_weak_refs/;
27use Tree::Simple::Visitor::FindByUID;
269408a4 28use Class::C3::Adopt::NEXT;
196f06d1 29use List::MoreUtils qw/uniq/;
261c571e 30use attributes;
532f0516 31use String::RewritePrefix;
b1ededd4 32use Catalyst::EngineLoader;
5789a3d8 33use utf8;
108201b5 34use Carp qw/croak carp shortmess/;
3640641e 35use Try::Tiny;
ad79be34 36use Plack::Middleware::Conditional;
37use Plack::Middleware::ReverseProxy;
fb99321f 38use Plack::Middleware::IIS6ScriptNameFix;
d3670826 39use Plack::Middleware::LighttpdScriptNameFix;
fc7ec1d9 40
2407a0ae 41BEGIN { require 5.008004; }
f63c03e4 42
8a440eba 43has stack => (is => 'ro', default => sub { [] });
6680c772 44has stash => (is => 'rw', default => sub { {} });
45has state => (is => 'rw', default => 0);
b6d4ee6e 46has stats => (is => 'rw');
47has action => (is => 'rw');
6680c772 48has counter => (is => 'rw', default => sub { {} });
49has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
50has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
e63bdf38 51has namespace => (is => 'rw');
52
8767c5a3 53sub depth { scalar @{ shift->stack || [] }; }
0fc2d522 54sub comp { shift->component(@_) }
6680c772 55
56sub req {
6680c772 57 my $self = shift; return $self->request(@_);
58}
59sub res {
6680c772 60 my $self = shift; return $self->response(@_);
61}
fbcc39ad 62
63# For backwards compatibility
0fc2d522 64sub finalize_output { shift->finalize_body(@_) };
fbcc39ad 65
66# For statistics
67our $COUNT = 1;
68our $START = time;
69our $RECURSION = 1000;
154ef0c8 70our $DETACH = Catalyst::Exception::Detach->new;
71our $GO = Catalyst::Exception::Go->new;
fbcc39ad 72
b6d4ee6e 73#I imagine that very few of these really need to be class variables. if any.
74#maybe we should just make them attributes with a default?
fbcc39ad 75__PACKAGE__->mk_classdata($_)
3cec521a 76 for qw/components arguments dispatcher engine log dispatcher_class
1e5dad00 77 engine_loader context_class request_class response_class stats_class
2e1f92a3 78 setup_finished _psgi_app loading_psgi_file/;
cb0354c6 79
3cec521a 80__PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
3cec521a 81__PACKAGE__->request_class('Catalyst::Request');
82__PACKAGE__->response_class('Catalyst::Response');
dc5f035e 83__PACKAGE__->stats_class('Catalyst::Stats');
fbcc39ad 84
6415bb4d 85# Remember to update this in Catalyst::Runtime as well!
86
4ec26b6c 87our $VERSION = '5.90004';
189e2a51 88
fbcc39ad 89sub import {
90 my ( $class, @arguments ) = @_;
91
92 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
93 # callers @ISA.
94 return unless $class eq 'Catalyst';
95
84ff88cf 96 my $caller = caller();
97 return if $caller eq 'main';
269408a4 98
84ff88cf 99 my $meta = Moose::Meta::Class->initialize($caller);
fbcc39ad 100 unless ( $caller->isa('Catalyst') ) {
84ff88cf 101 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
102 $meta->superclasses(@superclasses);
103 }
1cad29ab 104 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
105 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
106
84ff88cf 107 unless( $meta->has_method('meta') ){
9c74923d 108 if ($Moose::VERSION >= 1.15) {
109 $meta->_add_meta_method('meta');
110 }
111 else {
112 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
113 }
fbcc39ad 114 }
115
116 $caller->arguments( [@arguments] );
117 $caller->setup_home;
118}
fc7ec1d9 119
e6bfaa20 120sub _application { $_[0] }
121
fc7ec1d9 122=head1 NAME
123
124Catalyst - The Elegant MVC Web Application Framework
125
126=head1 SYNOPSIS
127
e7ad3b81 128See the L<Catalyst::Manual> distribution for comprehensive
129documentation and tutorials.
130
86418559 131 # Install Catalyst::Devel for helpers and other development tools
b4b01a8a 132 # use the helper to create a new application
91864987 133 catalyst.pl MyApp
fc7ec1d9 134
135 # add models, views, controllers
2f381252 136 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
cc95842f 137 script/myapp_create.pl view MyTemplate TT
0ef52a96 138 script/myapp_create.pl controller Search
fc7ec1d9 139
e7f1cf73 140 # built in testserver -- use -r to restart automatically on changes
cc95842f 141 # --help to see all available options
ae4e40a7 142 script/myapp_server.pl
fc7ec1d9 143
0ef52a96 144 # command line testing interface
ae4e40a7 145 script/myapp_test.pl /yada
fc7ec1d9 146
b4b01a8a 147 ### in lib/MyApp.pm
0ef52a96 148 use Catalyst qw/-Debug/; # include plugins here as well
62a6df80 149
85d9fce6 150 ### In lib/MyApp/Controller/Root.pm (autocreated)
20f0d47b 151 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
ae1e6b59 152 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
153 $c->stash->{template} = 'foo.tt'; # set the template
0ef52a96 154 # lookup something from db -- stash vars are passed to TT
62a6df80 155 $c->stash->{data} =
b4b01a8a 156 $c->model('Database::Foo')->search( { country => $args[0] } );
0ef52a96 157 if ( $c->req->params->{bar} ) { # access GET or POST parameters
158 $c->forward( 'bar' ); # process another action
62a6df80 159 # do something else after forward returns
0ef52a96 160 }
161 }
62a6df80 162
ae1e6b59 163 # The foo.tt TT template can use the stash data from the database
0ef52a96 164 [% WHILE (item = data.next) %]
165 [% item.foo %]
166 [% END %]
62a6df80 167
0ef52a96 168 # called for /bar/of/soap, /bar/of/soap/10, etc.
20f0d47b 169 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
62a6df80 170
ae1e6b59 171 # called after all actions are finished
20f0d47b 172 sub end : Action {
5a8ed4fe 173 my ( $self, $c ) = @_;
0ef52a96 174 if ( scalar @{ $c->error } ) { ... } # handle errors
175 return if $c->res->body; # already have a response
176 $c->forward( 'MyApp::View::TT' ); # render template
5a8ed4fe 177 }
178
0ef52a96 179See L<Catalyst::Manual::Intro> for additional information.
3803e98f 180
fc7ec1d9 181=head1 DESCRIPTION
182
86418559 183Catalyst is a modern framework for making web applications without the
184pain usually associated with this process. This document is a reference
185to the main Catalyst application. If you are a new user, we suggest you
186start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
fc7ec1d9 187
188See L<Catalyst::Manual> for more documentation.
189
ae1e6b59 190Catalyst plugins can be loaded by naming them as arguments to the "use
191Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
192plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
193C<My::Module>.
fc7ec1d9 194
0ef52a96 195 use Catalyst qw/My::Module/;
fc7ec1d9 196
836e1134 197If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
198fully qualify the name by using a unary plus:
199
200 use Catalyst qw/
201 My::Module
202 +Fully::Qualified::Plugin::Name
203 /;
204
5853fd49 205Special flags like C<-Debug> can also be specified as
ae1e6b59 206arguments when Catalyst is loaded:
fc7ec1d9 207
208 use Catalyst qw/-Debug My::Module/;
209
ae1e6b59 210The position of plugins and flags in the chain is important, because
86418559 211they are loaded in the order in which they appear.
fc7ec1d9 212
23f9d934 213The following flags are supported:
214
b5ecfcf0 215=head2 -Debug
23f9d934 216
f8ad6ea5 217Enables debug output. You can also force this setting from the system
86418559 218environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
219settings override the application, with <MYAPP>_DEBUG having the highest
220priority.
fc7ec1d9 221
c8083f4e 222This sets the log level to 'debug' and enables full debug output on the
223error screen. If you only want the latter, see L<< $c->debug >>.
224
b5ecfcf0 225=head2 -Home
fbcc39ad 226
ae1e6b59 227Forces Catalyst to use a specific home directory, e.g.:
228
86418559 229 use Catalyst qw[-Home=/usr/mst];
fbcc39ad 230
cc95842f 231This can also be done in the shell environment by setting either the
232C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
233is replaced with the uppercased name of your application, any "::" in
234the name will be replaced with underscores, e.g. MyApp::Web should use
235MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
236
d7a82605 237If none of these are set, Catalyst will attempt to automatically detect the
8ad6fd58 238home directory. If you are working in a development environment, Catalyst
d7a82605 239will try and find the directory containing either Makefile.PL, Build.PL or
240dist.ini. If the application has been installed into the system (i.e.
241you have done C<make install>), then Catalyst will use the path to your
8ad6fd58 242application module, without the .pm extension (e.g., /foo/MyApp if your
d7a82605 243application was installed at /foo/MyApp.pm)
244
b5ecfcf0 245=head2 -Log
fbcc39ad 246
0fa676a7 247 use Catalyst '-Log=warn,fatal,error';
62a6df80 248
0fa676a7 249Specifies a comma-delimited list of log levels.
fbcc39ad 250
dc5f035e 251=head2 -Stats
252
01c5eab0 253Enables statistics collection and reporting.
dc5f035e 254
01c5eab0 255 use Catalyst qw/-Stats=1/;
dc5f035e 256
01c5eab0 257You can also force this setting from the system environment with CATALYST_STATS
258or <MYAPP>_STATS. The environment settings override the application, with
259<MYAPP>_STATS having the highest priority.
dc5f035e 260
01c5eab0 261Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
dc5f035e 262
23f9d934 263=head1 METHODS
264
f7b672ef 265=head2 INFORMATION ABOUT THE CURRENT REQUEST
0ef52a96 266
b5ecfcf0 267=head2 $c->action
66e28e3f 268
ae1e6b59 269Returns a L<Catalyst::Action> object for the current action, which
270stringifies to the action name. See L<Catalyst::Action>.
0ef52a96 271
b5ecfcf0 272=head2 $c->namespace
0ef52a96 273
86418559 274Returns the namespace of the current action, i.e., the URI prefix
ae1e6b59 275corresponding to the controller of the current action. For example:
276
277 # in Controller::Foo::Bar
278 $c->namespace; # returns 'foo/bar';
0ef52a96 279
b5ecfcf0 280=head2 $c->request
0ef52a96 281
b5ecfcf0 282=head2 $c->req
0ef52a96 283
86418559 284Returns the current L<Catalyst::Request> object, giving access to
285information about the current client request (including parameters,
286cookies, HTTP headers, etc.). See L<Catalyst::Request>.
0ef52a96 287
b4b01a8a 288=head2 REQUEST FLOW HANDLING
0ef52a96 289
b5ecfcf0 290=head2 $c->forward( $action [, \@arguments ] )
0ef52a96 291
b5ecfcf0 292=head2 $c->forward( $class, $method, [, \@arguments ] )
0ef52a96 293
86418559 294Forwards processing to another action, by its private name. If you give a
b4b01a8a 295class name but no method, C<process()> is called. You may also optionally
296pass arguments in an arrayref. The action will receive the arguments in
cc95842f 297C<@_> and C<< $c->req->args >>. Upon returning from the function,
298C<< $c->req->args >> will be restored to the previous values.
0ef52a96 299
3b984c64 300Any data C<return>ed from the action forwarded to, will be returned by the
d759db1e 301call to forward.
3b984c64 302
303 my $foodata = $c->forward('/foo');
0ef52a96 304 $c->forward('index');
1d3a0700 305 $c->forward(qw/Model::DBIC::Foo do_stuff/);
306 $c->forward('View::TT');
0ef52a96 307
18a9655c 308Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
309an C<< eval { } >> around the call (actually
8ad6fd58 310L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
311exceptions thrown by the called action non-fatal and pushing them onto
312$c->error instead. If you want C<die> to propagate you need to do something
313like:
f3e6a8c0 314
315 $c->forward('foo');
7d6820cc 316 die join "\n", @{ $c->error } if @{ $c->error };
f3e6a8c0 317
86418559 318Or make sure to always return true values from your actions and write
319your code like this:
f3e6a8c0 320
321 $c->forward('foo') || return;
1d3a0700 322
2e60292e 323Another note is that C<< $c->forward >> always returns a scalar because it
324actually returns $c->state which operates in a scalar context.
325Thus, something like:
326
327 return @array;
1d3a0700 328
329in an action that is forwarded to is going to return a scalar,
2e60292e 330i.e. how many items are in that array, which is probably not what you want.
1d3a0700 331If you need to return an array then return a reference to it,
2e60292e 332or stash it like so:
333
334 $c->stash->{array} = \@array;
335
336and access it from the stash.
f3e6a8c0 337
9c74923d 338Keep 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.
339
0ef52a96 340=cut
341
6680c772 342sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
0ef52a96 343
b5ecfcf0 344=head2 $c->detach( $action [, \@arguments ] )
0ef52a96 345
b5ecfcf0 346=head2 $c->detach( $class, $method, [, \@arguments ] )
0ef52a96 347
264bac8c 348=head2 $c->detach()
349
18a9655c 350The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
351doesn't return to the previous action when processing is finished.
0ef52a96 352
264bac8c 353When called with no arguments it escapes the processing chain entirely.
354
0ef52a96 355=cut
356
357sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
358
5d91ffe2 359=head2 $c->visit( $action [, \@captures, \@arguments ] )
ae0e35ee 360
5d91ffe2 361=head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
ae0e35ee 362
18a9655c 363Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
364but does a full dispatch, instead of just calling the new C<$action> /
365C<< $class->$method >>. This means that C<begin>, C<auto> and the method
366you go to are called, just like a new request.
ae0e35ee 367
4b48773e 368In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
18a9655c 369This means, for example, that C<< $c->action >> methods such as
370L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
371L<reverse|Catalyst::Action/reverse> return information for the visited action
372when they are invoked within the visited action. This is different from the
373behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
374continues to use the $c->action object from the caller action even when
8ad6fd58 375invoked from the called action.
4b48773e 376
18a9655c 377C<< $c->stash >> is kept unchanged.
ae0e35ee 378
18a9655c 379In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
380allows you to "wrap" another action, just as it would have been called by
381dispatching from a URL, while the analogous
382L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
383transfer control to another action as if it had been reached directly from a URL.
ae0e35ee 384
385=cut
386
387sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
388
5d91ffe2 389=head2 $c->go( $action [, \@captures, \@arguments ] )
2f381252 390
5d91ffe2 391=head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
2f381252 392
1d3a0700 393The relationship between C<go> and
12c48597 394L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
1d3a0700 395the relationship between
12c48597 396L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
397L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
398C<< $c->go >> will perform a full dispatch on the specified action or method,
399with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
400C<go> escapes the processing of the current request chain on completion, and
401does not return to its caller.
2f381252 402
9c74923d 403@arguments are arguments to the final destination of $action. @captures are
404arguments to the intermediate steps, if any, on the way to the final sub of
405$action.
406
2f381252 407=cut
408
409sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
410
b4b01a8a 411=head2 $c->response
412
413=head2 $c->res
414
cc95842f 415Returns the current L<Catalyst::Response> object, see there for details.
b4b01a8a 416
417=head2 $c->stash
418
419Returns a hashref to the stash, which may be used to store data and pass
420it between components during a request. You can also set hash keys by
421passing arguments. The stash is automatically sent to the view. The
422stash is cleared at the end of a request; it cannot be used for
86418559 423persistent storage (for this you must use a session; see
424L<Catalyst::Plugin::Session> for a complete system integrated with
425Catalyst).
b4b01a8a 426
427 $c->stash->{foo} = $bar;
428 $c->stash( { moose => 'majestic', qux => 0 } );
429 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
62a6df80 430
b4b01a8a 431 # stash is automatically passed to the view for use in a template
cc95842f 432 $c->forward( 'MyApp::View::TT' );
b4b01a8a 433
434=cut
435
4090e3bb 436around stash => sub {
437 my $orig = shift;
b4b01a8a 438 my $c = shift;
4090e3bb 439 my $stash = $orig->($c);
b4b01a8a 440 if (@_) {
4090e3bb 441 my $new_stash = @_ > 1 ? {@_} : $_[0];
442 croak('stash takes a hash or hashref') unless ref $new_stash;
443 foreach my $key ( keys %$new_stash ) {
444 $stash->{$key} = $new_stash->{$key};
b4b01a8a 445 }
446 }
0fc2d522 447
4090e3bb 448 return $stash;
449};
0fc2d522 450
b4b01a8a 451
b5ecfcf0 452=head2 $c->error
0ef52a96 453
b5ecfcf0 454=head2 $c->error($error, ...)
0ef52a96 455
b5ecfcf0 456=head2 $c->error($arrayref)
0ef52a96 457
83a8fcac 458Returns an arrayref containing error messages. If Catalyst encounters an
459error while processing a request, it stores the error in $c->error. This
e7ad3b81 460method should only be used to store fatal error messages.
0ef52a96 461
462 my @error = @{ $c->error };
463
464Add a new error.
465
466 $c->error('Something bad happened');
467
0ef52a96 468=cut
469
470sub error {
471 my $c = shift;
472 if ( $_[0] ) {
473 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
9ce44430 474 croak @$error unless ref $c;
0ef52a96 475 push @{ $c->{error} }, @$error;
476 }
477 elsif ( defined $_[0] ) { $c->{error} = undef }
478 return $c->{error} || [];
479}
480
b4b01a8a 481
482=head2 $c->state
483
1d3a0700 484Contains the return value of the last executed action.
2e60292e 485Note that << $c->state >> operates in a scalar context which means that all
486values it returns are scalar.
b4b01a8a 487
ca81eb67 488=head2 $c->clear_errors
489
490Clear errors. You probably don't want to clear the errors unless you are
491implementing a custom error screen.
492
493This is equivalent to running
494
495 $c->error(0);
496
497=cut
498
499sub clear_errors {
500 my $c = shift;
501 $c->error(0);
502}
503
2f381252 504sub _comp_search_prefixes {
c23b894b 505 my $c = shift;
506 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
507}
508
509# search components given a name and some prefixes
510sub _comp_names_search_prefixes {
2f381252 511 my ( $c, $name, @prefixes ) = @_;
512 my $appclass = ref $c || $c;
513 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
cce626ed 514 $filter = qr/$filter/; # Compile regex now rather than once per loop
0ef52a96 515
2f381252 516 # map the original component name to the sub part that we will search against
517 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
518 grep { /$filter/ } keys %{ $c->components };
0756fe3b 519
2f381252 520 # undef for a name will return all
521 return keys %eligible if !defined $name;
0756fe3b 522
2f381252 523 my $query = ref $name ? $name : qr/^$name$/i;
524 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
0756fe3b 525
c23b894b 526 return @result if @result;
0756fe3b 527
2f381252 528 # if we were given a regexp to search against, we're done.
529 return if ref $name;
0756fe3b 530
ab86b480 531 # skip regexp fallback if configured
532 return
533 if $appclass->config->{disable_component_resolution_regex_fallback};
534
2f381252 535 # regexp fallback
536 $query = qr/$name/i;
c23b894b 537 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
0756fe3b 538
2f381252 539 # no results? try against full names
540 if( !@result ) {
c23b894b 541 @result = grep { m{$query} } keys %eligible;
2f381252 542 }
0756fe3b 543
2f381252 544 # don't warn if we didn't find any results, it just might not exist
545 if( @result ) {
cce626ed 546 # Disgusting hack to work out correct method name
547 my $warn_for = lc $prefixes[0];
e260802a 548 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
108201b5 549 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
550 "component resolution is unreliable and unsafe.";
551 my $short = $result[0];
ab86b480 552 # remove the component namespace prefix
553 $short =~ s/.*?(Model|Controller|View):://;
108201b5 554 my $shortmess = Carp::shortmess('');
555 if ($shortmess =~ m#Catalyst/Plugin#) {
556 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
557 "plugin's config";
558 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
559 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
560 "component's config";
561 } else {
ab86b480 562 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
108201b5 563 "but if you really wanted to search, pass in a regexp as the argument " .
cce626ed 564 "like so: \$c->${warn_for}(qr/${name}/)";
108201b5 565 }
566 $c->log->warn( "${msg}$shortmess" );
2f381252 567 }
0756fe3b 568
2f381252 569 return @result;
0756fe3b 570}
571
62a6df80 572# Find possible names for a prefix
3b88a455 573sub _comp_names {
574 my ( $c, @prefixes ) = @_;
3b88a455 575 my $appclass = ref $c || $c;
576
2f381252 577 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
3b88a455 578
c23b894b 579 my @names = map { s{$filter}{}; $_; }
580 $c->_comp_names_search_prefixes( undef, @prefixes );
581
3b88a455 582 return @names;
583}
584
197bd788 585# Filter a component before returning by calling ACCEPT_CONTEXT if available
586sub _filter_component {
587 my ( $c, $comp, @args ) = @_;
2f381252 588
8abaac85 589 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
197bd788 590 return $comp->ACCEPT_CONTEXT( $c, @args );
591 }
62a6df80 592
2f381252 593 return $comp;
197bd788 594}
595
f7b672ef 596=head2 COMPONENT ACCESSORS
0ef52a96 597
b5ecfcf0 598=head2 $c->controller($name)
af3ff00e 599
0ef52a96 600Gets a L<Catalyst::Controller> instance by name.
af3ff00e 601
602 $c->controller('Foo')->do_stuff;
603
86418559 604If the name is omitted, will return the controller for the dispatched
605action.
649fd1fa 606
2f381252 607If you want to search for controllers, pass in a regexp as the argument.
608
609 # find all controllers that start with Foo
610 my @foo_controllers = $c->controller(qr{^Foo});
611
612
af3ff00e 613=cut
614
615sub controller {
197bd788 616 my ( $c, $name, @args ) = @_;
2f381252 617
13311c16 618 my $appclass = ref($c) || $c;
2f381252 619 if( $name ) {
13311c16 620 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
621 my $comps = $c->components;
622 my $check = $appclass."::Controller::".$name;
623 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
624 }
2f381252 625 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
626 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
627 return $c->_filter_component( $result[ 0 ], @args );
628 }
629
197bd788 630 return $c->component( $c->action->class );
af3ff00e 631}
632
b5ecfcf0 633=head2 $c->model($name)
fc7ec1d9 634
0ef52a96 635Gets a L<Catalyst::Model> instance by name.
636
637 $c->model('Foo')->do_stuff;
fc7ec1d9 638
72f87c4b 639Any extra arguments are directly passed to ACCEPT_CONTEXT.
640
62a6df80 641If the name is omitted, it will look for
2f381252 642 - a model object in $c->stash->{current_model_instance}, then
a3b71f0f 643 - a model name in $c->stash->{current_model}, then
644 - a config setting 'default_model', or
645 - check if there is only one model, and return it if that's the case.
649fd1fa 646
2f381252 647If you want to search for models, pass in a regexp as the argument.
648
649 # find all models that start with Foo
650 my @foo_models = $c->model(qr{^Foo});
651
fc7ec1d9 652=cut
653
0ef52a96 654sub model {
197bd788 655 my ( $c, $name, @args ) = @_;
df960201 656 my $appclass = ref($c) || $c;
2f381252 657 if( $name ) {
13311c16 658 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
659 my $comps = $c->components;
660 my $check = $appclass."::Model::".$name;
661 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
662 }
2f381252 663 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
664 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
665 return $c->_filter_component( $result[ 0 ], @args );
666 }
667
a3b71f0f 668 if (ref $c) {
62a6df80 669 return $c->stash->{current_model_instance}
a3b71f0f 670 if $c->stash->{current_model_instance};
671 return $c->model( $c->stash->{current_model} )
672 if $c->stash->{current_model};
a3b71f0f 673 }
df960201 674 return $c->model( $appclass->config->{default_model} )
675 if $appclass->config->{default_model};
3b88a455 676
2f381252 677 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
3b88a455 678
2f381252 679 if( $rest ) {
108201b5 680 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
4600a5a1 681 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
2f381252 682 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
683 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
11c270bd 684 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
2f381252 685 }
3b88a455 686
2f381252 687 return $c->_filter_component( $comp );
3b88a455 688}
689
b4b01a8a 690
b5ecfcf0 691=head2 $c->view($name)
0ef52a96 692
693Gets a L<Catalyst::View> instance by name.
fc7ec1d9 694
0ef52a96 695 $c->view('Foo')->do_stuff;
fc7ec1d9 696
72f87c4b 697Any extra arguments are directly passed to ACCEPT_CONTEXT.
698
62a6df80 699If the name is omitted, it will look for
2f381252 700 - a view object in $c->stash->{current_view_instance}, then
a3b71f0f 701 - a view name in $c->stash->{current_view}, then
702 - a config setting 'default_view', or
703 - check if there is only one view, and return it if that's the case.
649fd1fa 704
2f381252 705If you want to search for views, pass in a regexp as the argument.
706
707 # find all views that start with Foo
708 my @foo_views = $c->view(qr{^Foo});
709
fc7ec1d9 710=cut
711
0ef52a96 712sub view {
197bd788 713 my ( $c, $name, @args ) = @_;
2f381252 714
df960201 715 my $appclass = ref($c) || $c;
2f381252 716 if( $name ) {
13311c16 717 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
718 my $comps = $c->components;
719 my $check = $appclass."::View::".$name;
9c74923d 720 if( exists $comps->{$check} ) {
721 return $c->_filter_component( $comps->{$check}, @args );
722 }
723 else {
724 $c->log->warn( "Attempted to use view '$check', but does not exist" );
725 }
13311c16 726 }
2f381252 727 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
728 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
729 return $c->_filter_component( $result[ 0 ], @args );
730 }
731
a3b71f0f 732 if (ref $c) {
62a6df80 733 return $c->stash->{current_view_instance}
a3b71f0f 734 if $c->stash->{current_view_instance};
735 return $c->view( $c->stash->{current_view} )
736 if $c->stash->{current_view};
a3b71f0f 737 }
df960201 738 return $c->view( $appclass->config->{default_view} )
739 if $appclass->config->{default_view};
2f381252 740
741 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
742
743 if( $rest ) {
744 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
4600a5a1 745 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
2f381252 746 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
747 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
11c270bd 748 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
2f381252 749 }
750
751 return $c->_filter_component( $comp );
752}
753
754=head2 $c->controllers
755
756Returns the available names which can be passed to $c->controller
757
758=cut
759
760sub controllers {
761 my ( $c ) = @_;
762 return $c->_comp_names(qw/Controller C/);
0ef52a96 763}
fbcc39ad 764
b4b01a8a 765=head2 $c->models
766
767Returns the available names which can be passed to $c->model
768
769=cut
770
771sub models {
772 my ( $c ) = @_;
773 return $c->_comp_names(qw/Model M/);
774}
775
776
3b88a455 777=head2 $c->views
778
779Returns the available names which can be passed to $c->view
780
781=cut
782
783sub views {
784 my ( $c ) = @_;
785 return $c->_comp_names(qw/View V/);
786}
787
b4b01a8a 788=head2 $c->comp($name)
789
790=head2 $c->component($name)
791
cc95842f 792Gets a component object by name. This method is not recommended,
b4b01a8a 793unless you want to get a specific component by full
cc95842f 794class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
b4b01a8a 795should be used instead.
796
2f381252 797If C<$name> is a regexp, a list of components matched against the full
798component name will be returned.
799
ab86b480 800If Catalyst can't find a component by name, it will fallback to regex
801matching by default. To disable this behaviour set
802disable_component_resolution_regex_fallback to a true value.
1d3a0700 803
220f4575 804 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
ab86b480 805
b4b01a8a 806=cut
807
808sub component {
2f381252 809 my ( $c, $name, @args ) = @_;
b4b01a8a 810
2f381252 811 if( $name ) {
812 my $comps = $c->components;
b4b01a8a 813
2f381252 814 if( !ref $name ) {
815 # is it the exact name?
816 return $c->_filter_component( $comps->{ $name }, @args )
817 if exists $comps->{ $name };
b4b01a8a 818
2f381252 819 # perhaps we just omitted "MyApp"?
820 my $composed = ( ref $c || $c ) . "::${name}";
821 return $c->_filter_component( $comps->{ $composed }, @args )
822 if exists $comps->{ $composed };
b4b01a8a 823
2f381252 824 # search all of the models, views and controllers
825 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
826 return $c->_filter_component( $comp, @args ) if $comp;
827 }
828
f899107d 829 return
830 if $c->config->{disable_component_resolution_regex_fallback};
831
2f381252 832 # This is here so $c->comp( '::M::' ) works
833 my $query = ref $name ? $name : qr{$name}i;
b4b01a8a 834
2f381252 835 my @result = grep { m{$query} } keys %{ $c->components };
836 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
b4b01a8a 837
2f381252 838 if( $result[ 0 ] ) {
108201b5 839 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
2f381252 840 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
841 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
842 return $c->_filter_component( $result[ 0 ], @args );
843 }
844
845 # I would expect to return an empty list here, but that breaks back-compat
b4b01a8a 846 }
847
2f381252 848 # fallback
b4b01a8a 849 return sort keys %{ $c->components };
850}
851
b4b01a8a 852=head2 CLASS DATA AND HELPER CLASSES
fbcc39ad 853
b5ecfcf0 854=head2 $c->config
fbcc39ad 855
0ef52a96 856Returns or takes a hashref containing the application's configuration.
857
61b1d329 858 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
81557adf 859
18a9655c 860You can also use a C<YAML>, C<XML> or L<Config::General> config file
861like C<myapp.conf> in your applications home directory. See
cc95842f 862L<Catalyst::Plugin::ConfigLoader>.
a6ad13b6 863
6df30f7e 864=head3 Cascading configuration
a6ad13b6 865
b3542016 866The config method is present on all Catalyst components, and configuration
867will be merged when an application is started. Configuration loaded with
868L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
62a6df80 869followed by configuration in your top level C<MyApp> class. These two
a51d14ff 870configurations are merged, and then configuration data whose hash key matches a
b3542016 871component name is merged with configuration for that component.
872
873The configuration for a component is then passed to the C<new> method when a
874component is constructed.
875
876For example:
877
878 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
790ff9aa 879 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
62a6df80 880
881will mean that C<MyApp::Model::Foo> receives the following data when
b3542016 882constructed:
883
884 MyApp::Model::Foo->new({
885 bar => 'baz',
886 quux => 'frob',
887 overrides => 'me',
888 });
b4b01a8a 889
f8a54681 890It's common practice to use a Moose attribute
891on the receiving component to access the config value.
892
893 package MyApp::Model::Foo;
894
895 use Moose;
896
897 # this attr will receive 'baz' at construction time
9c74923d 898 has 'bar' => (
f8a54681 899 is => 'rw',
900 isa => 'Str',
901 );
902
903You can then get the value 'baz' by calling $c->model('Foo')->bar
9c74923d 904(or $self->bar inside code in the model).
905
906B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
907as a way of reading config within your code, as this B<will not> give you the
908correctly merged config back. You B<MUST> take the config values supplied to
909the constructor and use those instead.
f8a54681 910
3643e890 911=cut
912
4090e3bb 913around config => sub {
914 my $orig = shift;
3643e890 915 my $c = shift;
916
fcf89172 917 croak('Setting config after setup has been run is not allowed.')
918 if ( @_ and $c->setup_finished );
3643e890 919
4090e3bb 920 $c->$orig(@_);
921};
3643e890 922
b5ecfcf0 923=head2 $c->log
0ef52a96 924
86418559 925Returns the logging object instance. Unless it is already set, Catalyst
926sets this up with a L<Catalyst::Log> object. To use your own log class,
927set the logger with the C<< __PACKAGE__->log >> method prior to calling
9e7673af 928C<< __PACKAGE__->setup >>.
929
930 __PACKAGE__->log( MyLogger->new );
931 __PACKAGE__->setup;
932
933And later:
0ef52a96 934
ae1e6b59 935 $c->log->info( 'Now logging with my own logger!' );
0ef52a96 936
86418559 937Your log class should implement the methods described in
938L<Catalyst::Log>.
af3ff00e 939
b4b01a8a 940
941=head2 $c->debug
942
c74d3f0c 943Returns 1 if debug mode is enabled, 0 otherwise.
b4b01a8a 944
7e5c67f2 945You can enable debug mode in several ways:
946
947=over
948
62a6df80 949=item By calling myapp_server.pl with the -d flag
950
7e5c67f2 951=item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
952
953=item The -Debug option in your MyApp.pm
954
8eae92ad 955=item By declaring C<sub debug { 1 }> in your MyApp.pm.
7e5c67f2 956
957=back
c74d3f0c 958
c8083f4e 959The first three also set the log level to 'debug'.
960
8eae92ad 961Calling C<< $c->debug(1) >> has no effect.
e80e8542 962
af3ff00e 963=cut
964
b4b01a8a 965sub debug { 0 }
966
967=head2 $c->dispatcher
968
2887a7f1 969Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
b4b01a8a 970
971=head2 $c->engine
972
2887a7f1 973Returns the engine instance. See L<Catalyst::Engine>.
b4b01a8a 974
975
f7b672ef 976=head2 UTILITY METHODS
66e28e3f 977
b5ecfcf0 978=head2 $c->path_to(@path)
01033d73 979
cc95842f 980Merges C<@path> with C<< $c->config->{home} >> and returns a
4e392da6 981L<Path::Class::Dir> object. Note you can usually use this object as
982a filename, but sometimes you will have to explicitly stringify it
18a9655c 983yourself by calling the C<< ->stringify >> method.
01033d73 984
985For example:
986
987 $c->path_to( 'db', 'sqlite.db' );
988
989=cut
990
991sub path_to {
992 my ( $c, @path ) = @_;
a738ab68 993 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
01033d73 994 if ( -d $path ) { return $path }
a738ab68 995 else { return Path::Class::File->new( $c->config->{home}, @path ) }
01033d73 996}
997
b5ecfcf0 998=head2 $c->plugin( $name, $class, @args )
0ef52a96 999
10011c19 1000Helper method for plugins. It creates a class data accessor/mutator and
ae1e6b59 1001loads and instantiates the given class.
0ef52a96 1002
1003 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1004
1005 $c->prototype->define_javascript_functions;
4e68badc 1006
6b2a933b 1007B<Note:> This method of adding plugins is deprecated. The ability
4e68badc 1008to add plugins like this B<will be removed> in a Catalyst 5.81.
6b2a933b 1009Please do not use this functionality in new code.
0ef52a96 1010
1011=cut
1012
1013sub plugin {
1014 my ( $class, $name, $plugin, @args ) = @_;
6b2a933b 1015
4e68badc 1016 # See block comment in t/unit_core_plugin.t
b3542016 1017 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
4e68badc 1018
97b58e17 1019 $class->_register_plugin( $plugin, 1 );
0ef52a96 1020
1021 eval { $plugin->import };
1022 $class->mk_classdata($name);
1023 my $obj;
1024 eval { $obj = $plugin->new(@args) };
1025
1026 if ($@) {
1027 Catalyst::Exception->throw( message =>
1028 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1029 }
1030
1031 $class->$name($obj);
1032 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1033 if $class->debug;
1034}
1035
b5ecfcf0 1036=head2 MyApp->setup
fbcc39ad 1037
e7f1cf73 1038Initializes the dispatcher and engine, loads any plugins, and loads the
ae1e6b59 1039model, view, and controller components. You may also specify an array
1040of plugins to load here, if you choose to not load them in the C<use
1041Catalyst> line.
fbcc39ad 1042
0ef52a96 1043 MyApp->setup;
1044 MyApp->setup( qw/-Debug/ );
fbcc39ad 1045
1046=cut
1047
1048sub setup {
0319a12c 1049 my ( $class, @arguments ) = @_;
c2f3cc1b 1050 croak('Running setup more than once')
1051 if ( $class->setup_finished );
5168a5fc 1052
fbcc39ad 1053 unless ( $class->isa('Catalyst') ) {
953b0e15 1054
fbcc39ad 1055 Catalyst::Exception->throw(
1056 message => qq/'$class' does not inherit from Catalyst/ );
1c99e125 1057 }
0319a12c 1058
fbcc39ad 1059 if ( $class->arguments ) {
1060 @arguments = ( @arguments, @{ $class->arguments } );
1061 }
1062
1063 # Process options
1064 my $flags = {};
1065
1066 foreach (@arguments) {
1067
1068 if (/^-Debug$/) {
1069 $flags->{log} =
1070 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1071 }
1072 elsif (/^-(\w+)=?(.*)$/) {
1073 $flags->{ lc $1 } = $2;
1074 }
1075 else {
1076 push @{ $flags->{plugins} }, $_;
1077 }
1078 }
1079
99f187d6 1080 $class->setup_home( delete $flags->{home} );
1081
fbcc39ad 1082 $class->setup_log( delete $flags->{log} );
1083 $class->setup_plugins( delete $flags->{plugins} );
1084 $class->setup_dispatcher( delete $flags->{dispatcher} );
acbecf08 1085 if (my $engine = delete $flags->{engine}) {
0aafa77a 1086 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
acbecf08 1087 }
1088 $class->setup_engine();
dc5f035e 1089 $class->setup_stats( delete $flags->{stats} );
fbcc39ad 1090
1091 for my $flag ( sort keys %{$flags} ) {
1092
1093 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1094 &$code( $class, delete $flags->{$flag} );
1095 }
1096 else {
1097 $class->log->warn(qq/Unknown flag "$flag"/);
1098 }
1099 }
1100
0eb4af72 1101 eval { require Catalyst::Devel; };
1102 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1103 $class->log->warn(<<"EOF");
4ff0d824 1104You are running an old script!
1105
34a83d89 1106 Please update by running (this will overwrite existing files):
1107 catalyst.pl -force -scripts $class
1108
1109 or (this will not overwrite existing files):
1110 catalyst.pl -scripts $class
1cf0345b 1111
4ff0d824 1112EOF
0eb4af72 1113 }
62a6df80 1114
fbcc39ad 1115 if ( $class->debug ) {
6601f2ad 1116 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
fbcc39ad 1117
1118 if (@plugins) {
39fc2ce1 1119 my $column_width = Catalyst::Utils::term_width() - 6;
1120 my $t = Text::SimpleTable->new($column_width);
8c113188 1121 $t->row($_) for @plugins;
1cf0345b 1122 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
fbcc39ad 1123 }
1124
1125 my $dispatcher = $class->dispatcher;
1126 my $engine = $class->engine;
1127 my $home = $class->config->{home};
1128
01ce7075 1129 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1130 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
fbcc39ad 1131
1132 $home
1133 ? ( -d $home )
1134 ? $class->log->debug(qq/Found home "$home"/)
1135 : $class->log->debug(qq/Home "$home" doesn't exist/)
1136 : $class->log->debug(q/Couldn't find home/);
1137 }
1138
54f4bfef 1139 # Call plugins setup, this is stupid and evil.
16b7c476 1140 # Also screws C3 badly on 5.10, hack to avoid.
fbcc39ad 1141 {
1142 no warnings qw/redefine/;
1143 local *setup = sub { };
16b7c476 1144 $class->setup unless $Catalyst::__AM_RESTARTING;
fbcc39ad 1145 }
1146
1147 # Initialize our data structure
1148 $class->components( {} );
1149
1150 $class->setup_components;
1151
1152 if ( $class->debug ) {
39fc2ce1 1153 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1154 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
684d10ed 1155 for my $comp ( sort keys %{ $class->components } ) {
1156 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1157 $t->row( $comp, $type );
1158 }
1cf0345b 1159 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
8c113188 1160 if ( keys %{ $class->components } );
fbcc39ad 1161 }
1162
1163 # Add our self to components, since we are also a component
96d8d513 1164 if( $class->isa('Catalyst::Controller') ){
1165 $class->components->{$class} = $class;
1166 }
fbcc39ad 1167
1168 $class->setup_actions;
1169
1170 if ( $class->debug ) {
1171 my $name = $class->config->{name} || 'Application';
1172 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1173 }
3643e890 1174
62a6df80 1175 # Make sure that the application class becomes immutable at this point,
acca8cd5 1176 B::Hooks::EndOfScope::on_scope_end {
df861f8e 1177 return if $@;
e106a59f 1178 my $meta = Class::MOP::get_metaclass_by_name($class);
4ffa3785 1179 if (
1180 $meta->is_immutable
1181 && ! { $meta->immutable_options }->{replace_constructor}
1182 && (
1183 $class->isa('Class::Accessor::Fast')
1184 || $class->isa('Class::Accessor')
1185 )
1186 ) {
81ef9afd 1187 warn "You made your application class ($class) immutable, "
4ffa3785 1188 . "but did not inline the\nconstructor. "
1189 . "This will break catalyst, as your app \@ISA "
1190 . "Class::Accessor(::Fast)?\nPlease pass "
1191 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
6e5505d4 1192 }
83b8cda1 1193 $meta->make_immutable(
1194 replace_constructor => 1,
83b8cda1 1195 ) unless $meta->is_immutable;
acca8cd5 1196 };
3d041c32 1197
647a3de1 1198 if ($class->config->{case_sensitive}) {
1199 $class->log->warn($class . "->config->{case_sensitive} is set.");
1200 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1201 }
1202
a5d07d29 1203 $class->setup_finalize;
647a3de1 1204 # Should be the last thing we do so that user things hooking
1205 # setup_finalize can log..
1206 $class->log->_flush() if $class->log->can('_flush');
64ceb36b 1207 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
a5d07d29 1208}
1209
23c63a17 1210=head2 $app->setup_finalize
1211
128a7cee 1212A hook to attach modifiers to. This method does not do anything except set the
1213C<setup_finished> accessor.
23c63a17 1214
ae7da8f5 1215Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
23c63a17 1216
128a7cee 1217Example:
23c63a17 1218
128a7cee 1219 after setup_finalize => sub {
1220 my $app = shift;
23c63a17 1221
128a7cee 1222 ## do stuff here..
1223 };
23c63a17 1224
1225=cut
1226
a5d07d29 1227sub setup_finalize {
1228 my ($class) = @_;
3643e890 1229 $class->setup_finished(1);
fbcc39ad 1230}
1231
d71da6fe 1232=head2 $c->uri_for( $path?, @args?, \%query_values? )
fbcc39ad 1233
ee8963de 1234=head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
9df7c5d9 1235
ee8963de 1236Constructs an absolute L<URI> object based on the application root, the
1237provided path, and the additional arguments and query parameters provided.
186d5270 1238When used as a string, provides a textual URI. If you need more flexibility
92981fc3 1239than this (i.e. the option to provide relative URIs etc.) see
186d5270 1240L<Catalyst::Plugin::SmartURI>.
ee8963de 1241
d71da6fe 1242If no arguments are provided, the URI for the current action is returned.
1243To return the current action and also provide @args, use
1d3a0700 1244C<< $c->uri_for( $c->action, @args ) >>.
d71da6fe 1245
ee8963de 1246If the first argument is a string, it is taken as a public URI path relative
1247to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
e7e4c469 1248relative to the application root (if it does). It is then merged with
ee8963de 1249C<< $c->request->base >>; any C<@args> are appended as additional path
1250components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1251
1252If the first argument is a L<Catalyst::Action> it represents an action which
1253will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1254optional C<\@captures> argument (an arrayref) allows passing the captured
1255variables that are needed to fill in the paths of Chained and Regex actions;
1256once the path is resolved, C<uri_for> continues as though a path was
1257provided, appending any arguments or parameters and creating an absolute
1258URI.
1259
e7e4c469 1260The captures for the current request can be found in
ee8963de 1261C<< $c->request->captures >>, and actions can be resolved using
1262C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1263path, use C<< $c->uri_for_action >> instead.
1264
1265 # Equivalent to $c->req->uri
e7e4c469 1266 $c->uri_for($c->action, $c->req->captures,
ee8963de 1267 @{ $c->req->args }, $c->req->params);
62a6df80 1268
9df7c5d9 1269 # For the Foo action in the Bar controller
ee8963de 1270 $c->uri_for($c->controller('Bar')->action_for('Foo'));
9df7c5d9 1271
ee8963de 1272 # Path to a static resource
1273 $c->uri_for('/static/images/logo.png');
d5e3d528 1274
4cf1dd00 1275=cut
1276
fbcc39ad 1277sub uri_for {
00e6a2b7 1278 my ( $c, $path, @args ) = @_;
00e6a2b7 1279
7069eab5 1280 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1281 $path = $path->path_prefix;
1282 $path =~ s{/+\z}{};
1283 $path .= '/';
1284 }
1285
2689f8a4 1286 undef($path) if (defined $path && $path eq '');
1287
1288 my $params =
1289 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1290
1291 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
a4f2cdc8 1292 foreach my $arg (@args) {
1293 utf8::encode($arg) if utf8::is_utf8($arg);
49229f68 1294 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
2689f8a4 1295 }
1296
7e95ba12 1297 if ( blessed($path) ) { # action object
49229f68 1298 s|/|%2F|g for @args;
2689f8a4 1299 my $captures = [ map { s|/|%2F|g; $_; }
aaf72276 1300 ( scalar @args && ref $args[0] eq 'ARRAY'
1301 ? @{ shift(@args) }
1302 : ()) ];
7b346bc3 1303
1304 foreach my $capture (@$captures) {
1305 utf8::encode($capture) if utf8::is_utf8($capture);
1306 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1307 }
1308
aa7e913e 1309 my $action = $path;
0cff119a 1310 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1311 if( !@args && $action->number_of_args ) {
1312 my $expanded_action = $c->dispatcher->expand_action( $action );
1313
1314 my $num_captures = $expanded_action->number_of_captures;
1315 unshift @args, splice @$captures, $num_captures;
1316 }
1317
1318 $path = $c->dispatcher->uri_for_action($action, $captures);
aa7e913e 1319 if (not defined $path) {
1320 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1321 if $c->debug;
1322 return undef;
1323 }
81e75875 1324 $path = '/' if $path eq '';
ea0e58d9 1325 }
1326
51674a63 1327 unshift(@args, $path);
1328
1329 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1330 my $namespace = $c->namespace;
1331 if (defined $path) { # cheesy hack to handle path '../foo'
1332 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
6601f2ad 1333 }
51674a63 1334 unshift(@args, $namespace || '');
1335 }
62a6df80 1336
189e2a51 1337 # join args with '/', or a blank string
51674a63 1338 my $args = join('/', grep { defined($_) } @args);
1339 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
7a2295bc 1340 $args =~ s!^/+!!;
51674a63 1341 my $base = $c->req->base;
1342 my $class = ref($base);
1343 $base =~ s{(?<!/)$}{/};
1344
1345 my $query = '';
1346
1347 if (my @keys = keys %$params) {
1348 # somewhat lifted from URI::_query's query_form
1349 $query = '?'.join('&', map {
2f381252 1350 my $val = $params->{$_};
51674a63 1351 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1352 s/ /+/g;
1353 my $key = $_;
51674a63 1354 $val = '' unless defined $val;
1355 (map {
1f851263 1356 my $param = "$_";
1357 utf8::encode( $param ) if utf8::is_utf8($param);
51674a63 1358 # using the URI::Escape pattern here so utf8 chars survive
1f851263 1359 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1360 $param =~ s/ /+/g;
1361 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
51674a63 1362 } @keys);
1363 }
1364
1365 my $res = bless(\"${base}${args}${query}", $class);
d3e7a648 1366 $res;
fbcc39ad 1367}
1368
833b385e 1369=head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1370
1371=head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1372
1373=over
1374
1375=item $path
1376
1377A private path to the Catalyst action you want to create a URI for.
1378
1379This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1380>> and passing the resulting C<$action> and the remaining arguments to C<<
1381$c->uri_for >>.
1382
1383You can also pass in a Catalyst::Action object, in which case it is passed to
1384C<< $c->uri_for >>.
1385
c9ec25f8 1386Note 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.
1387
1388For example, if the action looks like:
1389
1390 package MyApp::Controller::Users;
1391
1392 sub lst : Path('the-list') {}
1393
1394You can use:
1395
1396 $c->uri_for_action('/users/lst')
1397
1398and it will create the URI /users/the-list.
1399
833b385e 1400=back
1401
1402=cut
1403
1404sub uri_for_action {
1405 my ( $c, $path, @args ) = @_;
62a6df80 1406 my $action = blessed($path)
1407 ? $path
833b385e 1408 : $c->dispatcher->get_action_by_path($path);
4ac0b9cb 1409 unless (defined $action) {
1410 croak "Can't find action for path '$path'";
1411 }
833b385e 1412 return $c->uri_for( $action, @args );
1413}
1414
b5ecfcf0 1415=head2 $c->welcome_message
ab2374d3 1416
1417Returns the Catalyst welcome HTML page.
1418
1419=cut
1420
1421sub welcome_message {
bf1f2c60 1422 my $c = shift;
1423 my $name = $c->config->{name};
1424 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1425 my $prefix = Catalyst::Utils::appprefix( ref $c );
80cdbbff 1426 $c->response->content_type('text/html; charset=utf-8');
ab2374d3 1427 return <<"EOF";
80cdbbff 1428<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1429 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1430<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
ab2374d3 1431 <head>
85d9fce6 1432 <meta http-equiv="Content-Language" content="en" />
1433 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
ab2374d3 1434 <title>$name on Catalyst $VERSION</title>
1435 <style type="text/css">
1436 body {
ab2374d3 1437 color: #000;
1438 background-color: #eee;
1439 }
1440 div#content {
1441 width: 640px;
80cdbbff 1442 margin-left: auto;
1443 margin-right: auto;
ab2374d3 1444 margin-top: 10px;
1445 margin-bottom: 10px;
1446 text-align: left;
1447 background-color: #ccc;
1448 border: 1px solid #aaa;
ab2374d3 1449 }
d84c4dab 1450 p, h1, h2 {
ab2374d3 1451 margin-left: 20px;
1452 margin-right: 20px;
16215972 1453 font-family: verdana, tahoma, sans-serif;
ab2374d3 1454 }
d84c4dab 1455 a {
1456 font-family: verdana, tahoma, sans-serif;
1457 }
d114e033 1458 :link, :visited {
1459 text-decoration: none;
1460 color: #b00;
1461 border-bottom: 1px dotted #bbb;
1462 }
1463 :link:hover, :visited:hover {
d114e033 1464 color: #555;
1465 }
ab2374d3 1466 div#topbar {
1467 margin: 0px;
1468 }
3e82a295 1469 pre {
3e82a295 1470 margin: 10px;
1471 padding: 8px;
1472 }
ab2374d3 1473 div#answers {
1474 padding: 8px;
1475 margin: 10px;
d114e033 1476 background-color: #fff;
ab2374d3 1477 border: 1px solid #aaa;
ab2374d3 1478 }
1479 h1 {
33108eaf 1480 font-size: 0.9em;
1481 font-weight: normal;
ab2374d3 1482 text-align: center;
1483 }
1484 h2 {
1485 font-size: 1.0em;
1486 }
1487 p {
1488 font-size: 0.9em;
1489 }
ae7c5252 1490 p img {
1491 float: right;
1492 margin-left: 10px;
1493 }
9619f23c 1494 span#appname {
1495 font-weight: bold;
33108eaf 1496 font-size: 1.6em;
ab2374d3 1497 }
1498 </style>
1499 </head>
1500 <body>
1501 <div id="content">
1502 <div id="topbar">
9619f23c 1503 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
d84c4dab 1504 $VERSION</h1>
ab2374d3 1505 </div>
1506 <div id="answers">
ae7c5252 1507 <p>
80cdbbff 1508 <img src="$logo" alt="Catalyst Logo" />
ae7c5252 1509 </p>
596aaffe 1510 <p>Welcome to the world of Catalyst.
f92fd545 1511 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1512 framework will make web development something you had
60dd6e1d 1513 never expected it to be: Fun, rewarding, and quick.</p>
ab2374d3 1514 <h2>What to do now?</h2>
4b8cb778 1515 <p>That really depends on what <b>you</b> want to do.
ab2374d3 1516 We do, however, provide you with a few starting points.</p>
1517 <p>If you want to jump right into web development with Catalyst
2f381252 1518 you might want to start with a tutorial.</p>
b607f8a0 1519<pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
596aaffe 1520</pre>
1521<p>Afterwards you can go on to check out a more complete look at our features.</p>
1522<pre>
b607f8a0 1523<code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1524<!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1525</code></pre>
ab2374d3 1526 <h2>What to do next?</h2>
f5681c92 1527 <p>Next it's time to write an actual application. Use the
80cdbbff 1528 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&amp;mode=all">controllers</a>,
60dd6e1d 1529 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&amp;mode=all">models</a>, and
1530 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&amp;mode=all">views</a>;
bf1f2c60 1531 they can save you a lot of work.</p>
c5f31918 1532 <pre><code>script/${prefix}_create.pl --help</code></pre>
bf1f2c60 1533 <p>Also, be sure to check out the vast and growing
802bf2cb 1534 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
bf1f2c60 1535 you are likely to find what you need there.
f5681c92 1536 </p>
1537
82245cc4 1538 <h2>Need help?</h2>
f5681c92 1539 <p>Catalyst has a very active community. Here are the main places to
1540 get in touch with us.</p>
16215972 1541 <ul>
1542 <li>
2b9a7d76 1543 <a href="http://dev.catalyst.perl.org">Wiki</a>
16215972 1544 </li>
1545 <li>
6d4c3368 1546 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
16215972 1547 </li>
1548 <li>
4eaf7c88 1549 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
16215972 1550 </li>
1551 </ul>
ab2374d3 1552 <h2>In conclusion</h2>
62a6df80 1553 <p>The Catalyst team hopes you will enjoy using Catalyst as much
f5681c92 1554 as we enjoyed making it. Please contact us if you have ideas
1555 for improvement or other feedback.</p>
ab2374d3 1556 </div>
1557 </div>
1558 </body>
1559</html>
1560EOF
1561}
1562
fbcc39ad 1563=head1 INTERNAL METHODS
1564
ae1e6b59 1565These methods are not meant to be used by end users.
1566
b5ecfcf0 1567=head2 $c->components
fbcc39ad 1568
e7f1cf73 1569Returns a hash of components.
fbcc39ad 1570
b5ecfcf0 1571=head2 $c->context_class
1f9cb7c1 1572
e7f1cf73 1573Returns or sets the context class.
1f9cb7c1 1574
b5ecfcf0 1575=head2 $c->counter
fbcc39ad 1576
ae1e6b59 1577Returns a hashref containing coderefs and execution counts (needed for
1578deep recursion detection).
fbcc39ad 1579
b5ecfcf0 1580=head2 $c->depth
fbcc39ad 1581
e7f1cf73 1582Returns the number of actions on the current internal execution stack.
fbcc39ad 1583
b5ecfcf0 1584=head2 $c->dispatch
fbcc39ad 1585
e7f1cf73 1586Dispatches a request to actions.
fbcc39ad 1587
1588=cut
1589
1590sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1591
b5ecfcf0 1592=head2 $c->dispatcher_class
1f9cb7c1 1593
e7f1cf73 1594Returns or sets the dispatcher class.
1f9cb7c1 1595
b5ecfcf0 1596=head2 $c->dump_these
7f92deef 1597
ae1e6b59 1598Returns a list of 2-element array references (name, structure) pairs
1599that will be dumped on the error page in debug mode.
7f92deef 1600
1601=cut
1602
1603sub dump_these {
1604 my $c = shift;
62a6df80 1605 [ Request => $c->req ],
1606 [ Response => $c->res ],
052a2d89 1607 [ Stash => $c->stash ],
1608 [ Config => $c->config ];
7f92deef 1609}
1610
b5ecfcf0 1611=head2 $c->engine_class
1f9cb7c1 1612
e7f1cf73 1613Returns or sets the engine class.
1f9cb7c1 1614
b5ecfcf0 1615=head2 $c->execute( $class, $coderef )
fbcc39ad 1616
0ef52a96 1617Execute a coderef in given class and catch exceptions. Errors are available
1618via $c->error.
fbcc39ad 1619
1620=cut
1621
1622sub execute {
1623 my ( $c, $class, $code ) = @_;
858828dd 1624 $class = $c->component($class) || $class;
fbcc39ad 1625 $c->state(0);
a0eca838 1626
197bd788 1627 if ( $c->depth >= $RECURSION ) {
f3414019 1628 my $action = $code->reverse();
91d08727 1629 $action = "/$action" unless $action =~ /->/;
f3414019 1630 my $error = qq/Deep recursion detected calling "${action}"/;
1627551a 1631 $c->log->error($error);
1632 $c->error($error);
1633 $c->state(0);
1634 return $c->state;
1635 }
1636
dc5f035e 1637 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
22247e54 1638
8767c5a3 1639 push( @{ $c->stack }, $code );
62a6df80 1640
6f3df815 1641 no warnings 'recursion';
524b0e1c 1642 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1643 # I have no idea how, ergo $ret (which appears to fix the issue)
1644 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
22247e54 1645
dc5f035e 1646 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
62a6df80 1647
a6724a82 1648 my $last = pop( @{ $c->stack } );
fbcc39ad 1649
1650 if ( my $error = $@ ) {
79f5d571 1651 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
f87b7c21 1652 $error->rethrow if $c->depth > 1;
2f381252 1653 }
79f5d571 1654 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
f87b7c21 1655 $error->rethrow if $c->depth > 0;
55424863 1656 }
fbcc39ad 1657 else {
1658 unless ( ref $error ) {
91d08727 1659 no warnings 'uninitialized';
fbcc39ad 1660 chomp $error;
f59def82 1661 my $class = $last->class;
1662 my $name = $last->name;
1663 $error = qq/Caught exception in $class->$name "$error"/;
fbcc39ad 1664 }
fbcc39ad 1665 $c->error($error);
fbcc39ad 1666 }
2688734f 1667 $c->state(0);
fbcc39ad 1668 }
1669 return $c->state;
1670}
1671
7a7d7af5 1672sub _stats_start_execute {
1673 my ( $c, $code ) = @_;
df960201 1674 my $appclass = ref($c) || $c;
a6724a82 1675 return if ( ( $code->name =~ /^_.*/ )
df960201 1676 && ( !$appclass->config->{show_internal_actions} ) );
7a7d7af5 1677
f3414019 1678 my $action_name = $code->reverse();
1679 $c->counter->{$action_name}++;
7a7d7af5 1680
f3414019 1681 my $action = $action_name;
a6724a82 1682 $action = "/$action" unless $action =~ /->/;
1683
7a7d7af5 1684 # determine if the call was the result of a forward
1685 # this is done by walking up the call stack and looking for a calling
1686 # sub of Catalyst::forward before the eval
1687 my $callsub = q{};
1688 for my $index ( 2 .. 11 ) {
1689 last
1690 if ( ( caller($index) )[0] eq 'Catalyst'
1691 && ( caller($index) )[3] eq '(eval)' );
1692
1693 if ( ( caller($index) )[3] =~ /forward$/ ) {
1694 $callsub = ( caller($index) )[3];
1695 $action = "-> $action";
1696 last;
1697 }
1698 }
1699
f3414019 1700 my $uid = $action_name . $c->counter->{$action_name};
74efc144 1701
a6724a82 1702 # is this a root-level call or a forwarded call?
1703 if ( $callsub =~ /forward$/ ) {
91740f34 1704 my $parent = $c->stack->[-1];
a6724a82 1705
1706 # forward, locate the caller
9c74923d 1707 if ( defined $parent && exists $c->counter->{"$parent"} ) {
69d8f33c 1708 $c->stats->profile(
62a6df80 1709 begin => $action,
69d8f33c 1710 parent => "$parent" . $c->counter->{"$parent"},
1711 uid => $uid,
1712 );
7a7d7af5 1713 }
1714 else {
1715
a6724a82 1716 # forward with no caller may come from a plugin
69d8f33c 1717 $c->stats->profile(
1718 begin => $action,
1719 uid => $uid,
1720 );
7a7d7af5 1721 }
1722 }
a6724a82 1723 else {
62a6df80 1724
a6724a82 1725 # root-level call
69d8f33c 1726 $c->stats->profile(
1727 begin => $action,
1728 uid => $uid,
1729 );
a6724a82 1730 }
dc5f035e 1731 return $action;
7a7d7af5 1732
7a7d7af5 1733}
1734
1735sub _stats_finish_execute {
1736 my ( $c, $info ) = @_;
69d8f33c 1737 $c->stats->profile( end => $info );
7a7d7af5 1738}
1739
b5ecfcf0 1740=head2 $c->finalize
fbcc39ad 1741
e7f1cf73 1742Finalizes the request.
fbcc39ad 1743
1744=cut
1745
1746sub finalize {
1747 my $c = shift;
1748
369c09bc 1749 for my $error ( @{ $c->error } ) {
1750 $c->log->error($error);
1751 }
1752
5050d7a7 1753 # Allow engine to handle finalize flow (for POE)
e63bdf38 1754 my $engine = $c->engine;
1755 if ( my $code = $engine->can('finalize') ) {
1756 $engine->$code($c);
fbcc39ad 1757 }
5050d7a7 1758 else {
fbcc39ad 1759
5050d7a7 1760 $c->finalize_uploads;
fbcc39ad 1761
5050d7a7 1762 # Error
1763 if ( $#{ $c->error } >= 0 ) {
1764 $c->finalize_error;
1765 }
1766
1767 $c->finalize_headers;
fbcc39ad 1768
5050d7a7 1769 # HEAD request
1770 if ( $c->request->method eq 'HEAD' ) {
1771 $c->response->body('');
1772 }
1773
1774 $c->finalize_body;
1775 }
62a6df80 1776
2bf54936 1777 $c->log_response;
10f204e1 1778
62a6df80 1779 if ($c->use_stats) {
596677b6 1780 my $elapsed = sprintf '%f', $c->stats->elapsed;
12bf12c0 1781 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
908e3d9e 1782 $c->log->info(
62a6df80 1783 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
908e3d9e 1784 }
fbcc39ad 1785
1786 return $c->response->status;
1787}
1788
b5ecfcf0 1789=head2 $c->finalize_body
fbcc39ad 1790
e7f1cf73 1791Finalizes body.
fbcc39ad 1792
1793=cut
1794
1795sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1796
b5ecfcf0 1797=head2 $c->finalize_cookies
fbcc39ad 1798
e7f1cf73 1799Finalizes cookies.
fbcc39ad 1800
1801=cut
1802
147821ea 1803sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
fbcc39ad 1804
b5ecfcf0 1805=head2 $c->finalize_error
fbcc39ad 1806
e7f1cf73 1807Finalizes error.
fbcc39ad 1808
1809=cut
1810
1811sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1812
b5ecfcf0 1813=head2 $c->finalize_headers
fbcc39ad 1814
e7f1cf73 1815Finalizes headers.
fbcc39ad 1816
1817=cut
1818
1819sub finalize_headers {
1820 my $c = shift;
1821
e63bdf38 1822 my $response = $c->response; #accessor calls can add up?
1823
fbcc39ad 1824 # Check if we already finalized headers
6680c772 1825 return if $response->finalized_headers;
fbcc39ad 1826
1827 # Handle redirects
e63bdf38 1828 if ( my $location = $response->redirect ) {
fbcc39ad 1829 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
e63bdf38 1830 $response->header( Location => $location );
a7caa492 1831
02570318 1832 if ( !$response->has_body ) {
39655cdc 1833 # Add a default body if none is already present
9c331634 1834 $response->body(<<"EOF");
1835<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1836<html xmlns="http://www.w3.org/1999/xhtml">
1837 <head>
1838 <title>Moved</title>
1839 </head>
1840 <body>
1841 <p>This item has moved <a href="$location">here</a>.</p>
1842 </body>
1843</html>
1844EOF
d455230c 1845 $response->content_type('text/html; charset=utf-8');
39655cdc 1846 }
fbcc39ad 1847 }
1848
1849 # Content-Length
ac057d3b 1850 if ( defined $response->body && length $response->body && !$response->content_length ) {
775878ac 1851
8f62c91a 1852 # get the length from a filehandle
9c74923d 1853 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
197bd788 1854 {
34effbc7 1855 my $size = -s $response->body;
1856 if ( $size ) {
1857 $response->content_length( $size );
8f62c91a 1858 }
1859 else {
775878ac 1860 $c->log->warn('Serving filehandle without a content-length');
8f62c91a 1861 }
1862 }
1863 else {
b5d7a61f 1864 # everything should be bytes at this point, but just in case
5ab21903 1865 $response->content_length( length( $response->body ) );
8f62c91a 1866 }
fbcc39ad 1867 }
1868
1869 # Errors
e63bdf38 1870 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1871 $response->headers->remove_header("Content-Length");
1872 $response->body('');
fbcc39ad 1873 }
1874
1875 $c->finalize_cookies;
1876
1877 $c->engine->finalize_headers( $c, @_ );
1878
1879 # Done
6680c772 1880 $response->finalized_headers(1);
fbcc39ad 1881}
1882
b5ecfcf0 1883=head2 $c->finalize_output
fbcc39ad 1884
1885An alias for finalize_body.
1886
b5ecfcf0 1887=head2 $c->finalize_read
fbcc39ad 1888
e7f1cf73 1889Finalizes the input after reading is complete.
fbcc39ad 1890
1891=cut
1892
1893sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1894
b5ecfcf0 1895=head2 $c->finalize_uploads
fbcc39ad 1896
ae1e6b59 1897Finalizes uploads. Cleans up any temporary files.
fbcc39ad 1898
1899=cut
1900
1901sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1902
b5ecfcf0 1903=head2 $c->get_action( $action, $namespace )
fbcc39ad 1904
e7f1cf73 1905Gets an action in a given namespace.
fbcc39ad 1906
1907=cut
1908
684d10ed 1909sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
fbcc39ad 1910
b5ecfcf0 1911=head2 $c->get_actions( $action, $namespace )
a9dc674c 1912
ae1e6b59 1913Gets all actions of a given name in a namespace and all parent
1914namespaces.
a9dc674c 1915
1916=cut
1917
1918sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1919
e5ce5f04 1920=head2 $app->handle_request( @arguments )
fbcc39ad 1921
e7f1cf73 1922Called to handle each HTTP request.
fbcc39ad 1923
1924=cut
1925
1926sub handle_request {
1927 my ( $class, @arguments ) = @_;
1928
1929 # Always expect worst case!
1930 my $status = -1;
3640641e 1931 try {
dea1884f 1932 if ($class->debug) {
908e3d9e 1933 my $secs = time - $START || 1;
1934 my $av = sprintf '%.3f', $COUNT / $secs;
1935 my $time = localtime time;
1936 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
dea1884f 1937 }
908e3d9e 1938
1939 my $c = $class->prepare(@arguments);
1940 $c->dispatch;
62a6df80 1941 $status = $c->finalize;
fbcc39ad 1942 }
3640641e 1943 catch {
1944 chomp(my $error = $_);
1945 $class->log->error(qq/Caught exception in engine "$error"/);
1946 };
fbcc39ad 1947
1948 $COUNT++;
62a6df80 1949
6680c772 1950 if(my $coderef = $class->log->can('_flush')){
1951 $class->log->$coderef();
1952 }
fbcc39ad 1953 return $status;
1954}
1955
d536010b 1956=head2 $class->prepare( @arguments )
fbcc39ad 1957
ae1e6b59 1958Creates a Catalyst context from an engine-specific request (Apache, CGI,
1959etc.).
fbcc39ad 1960
1961=cut
1962
1963sub prepare {
1964 my ( $class, @arguments ) = @_;
1965
6680c772 1966 # XXX
1967 # After the app/ctxt split, this should become an attribute based on something passed
1968 # into the application.
3cec521a 1969 $class->context_class( ref $class || $class ) unless $class->context_class;
62a6df80 1970
6680c772 1971 my $c = $class->context_class->new({});
1972
1973 # For on-demand data
1974 $c->request->_context($c);
1975 $c->response->_context($c);
fbcc39ad 1976
b6d4ee6e 1977 #surely this is not the most efficient way to do things...
dc5f035e 1978 $c->stats($class->stats_class->new)->enable($c->use_stats);
4f0b7cf1 1979 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
62a6df80 1980 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
908e3d9e 1981 }
1982
3640641e 1983 try {
1984 # Allow engine to direct the prepare flow (for POE)
1985 if ( my $prepare = $c->engine->can('prepare') ) {
1986 $c->engine->$prepare( $c, @arguments );
1987 }
1988 else {
1989 $c->prepare_request(@arguments);
1990 $c->prepare_connection;
1991 $c->prepare_query_parameters;
1992 $c->prepare_headers;
1993 $c->prepare_cookies;
1994 $c->prepare_path;
1995
1996 # Prepare the body for reading, either by prepare_body
1997 # or the user, if they are using $c->read
1998 $c->prepare_read;
1999
2000 # Parse the body unless the user wants it on-demand
2001 unless ( ref($c)->config->{parse_on_demand} ) {
2002 $c->prepare_body;
2003 }
878b821c 2004 }
5050d7a7 2005 }
3640641e 2006 # VERY ugly and probably shouldn't rely on ->finalize actually working
2007 catch {
2008 # failed prepare is always due to an invalid request, right?
2009 $c->response->status(400);
2010 $c->response->content_type('text/plain');
2011 $c->response->body('Bad Request');
2012 $c->finalize;
2013 die $_;
2014 };
fbcc39ad 2015
fbcc39ad 2016 my $method = $c->req->method || '';
2f381252 2017 my $path = $c->req->path;
2018 $path = '/' unless length $path;
fbcc39ad 2019 my $address = $c->req->address || '';
2020
10f204e1 2021 $c->log_request;
fbcc39ad 2022
e3a13771 2023 $c->prepare_action;
2024
fbcc39ad 2025 return $c;
2026}
2027
b5ecfcf0 2028=head2 $c->prepare_action
fbcc39ad 2029
b4b01a8a 2030Prepares action. See L<Catalyst::Dispatcher>.
fbcc39ad 2031
2032=cut
2033
2034sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2035
b5ecfcf0 2036=head2 $c->prepare_body
fbcc39ad 2037
e7f1cf73 2038Prepares message body.
fbcc39ad 2039
2040=cut
2041
2042sub prepare_body {
2043 my $c = shift;
2044
0f56bbcf 2045 return if $c->request->_has_body;
fbcc39ad 2046
2047 # Initialize on-demand data
2048 $c->engine->prepare_body( $c, @_ );
2049 $c->prepare_parameters;
2050 $c->prepare_uploads;
fbcc39ad 2051}
2052
b5ecfcf0 2053=head2 $c->prepare_body_chunk( $chunk )
4bd82c41 2054
e7f1cf73 2055Prepares a chunk of data before sending it to L<HTTP::Body>.
4bd82c41 2056
b4b01a8a 2057See L<Catalyst::Engine>.
2058
4bd82c41 2059=cut
2060
4f5ebacd 2061sub prepare_body_chunk {
2062 my $c = shift;
4bd82c41 2063 $c->engine->prepare_body_chunk( $c, @_ );
2064}
2065
b5ecfcf0 2066=head2 $c->prepare_body_parameters
fbcc39ad 2067
e7f1cf73 2068Prepares body parameters.
fbcc39ad 2069
2070=cut
2071
2072sub prepare_body_parameters {
2073 my $c = shift;
2074 $c->engine->prepare_body_parameters( $c, @_ );
2075}
2076
b5ecfcf0 2077=head2 $c->prepare_connection
fbcc39ad 2078
e7f1cf73 2079Prepares connection.
fbcc39ad 2080
2081=cut
2082
2083sub prepare_connection {
2084 my $c = shift;
2085 $c->engine->prepare_connection( $c, @_ );
2086}
2087
b5ecfcf0 2088=head2 $c->prepare_cookies
fbcc39ad 2089
e7f1cf73 2090Prepares cookies.
fbcc39ad 2091
2092=cut
2093
2094sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2095
b5ecfcf0 2096=head2 $c->prepare_headers
fbcc39ad 2097
e7f1cf73 2098Prepares headers.
fbcc39ad 2099
2100=cut
2101
2102sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2103
b5ecfcf0 2104=head2 $c->prepare_parameters
fbcc39ad 2105
e7f1cf73 2106Prepares parameters.
fbcc39ad 2107
2108=cut
2109
2110sub prepare_parameters {
2111 my $c = shift;
2112 $c->prepare_body_parameters;
2113 $c->engine->prepare_parameters( $c, @_ );
2114}
2115
b5ecfcf0 2116=head2 $c->prepare_path
fbcc39ad 2117
e7f1cf73 2118Prepares path and base.
fbcc39ad 2119
2120=cut
2121
2122sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2123
b5ecfcf0 2124=head2 $c->prepare_query_parameters
fbcc39ad 2125
e7f1cf73 2126Prepares query parameters.
fbcc39ad 2127
2128=cut
2129
2130sub prepare_query_parameters {
2131 my $c = shift;
2132
2133 $c->engine->prepare_query_parameters( $c, @_ );
10f204e1 2134}
fbcc39ad 2135
10f204e1 2136=head2 $c->log_request
2137
2138Writes information about the request to the debug logs. This includes:
2139
2140=over 4
2141
854e5dcd 2142=item * Request method, path, and remote IP address
10f204e1 2143
2144=item * Query keywords (see L<Catalyst::Request/query_keywords>)
2145
e7cbe1bf 2146=item * Request parameters
10f204e1 2147
2148=item * File uploads
2149
2150=back
fbcc39ad 2151
2152=cut
2153
10f204e1 2154sub log_request {
2155 my $c = shift;
fbcc39ad 2156
10f204e1 2157 return unless $c->debug;
fbcc39ad 2158
2bf54936 2159 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2160 my $request = $dump->[1];
e7cbe1bf 2161
2162 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
10f204e1 2163 $method ||= '';
2164 $path = '/' unless length $path;
2165 $address ||= '';
2166 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2167
3a4abdb3 2168 $c->log_request_headers($request->headers);
e7cbe1bf 2169
2170 if ( my $keywords = $request->query_keywords ) {
10f204e1 2171 $c->log->debug("Query keywords are: $keywords");
fbcc39ad 2172 }
10f204e1 2173
9c74923d 2174 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
10f204e1 2175
e7cbe1bf 2176 $c->log_request_uploads($request);
fbcc39ad 2177}
2178
10f204e1 2179=head2 $c->log_response
fbcc39ad 2180
75b65816 2181Writes information about the response to the debug logs by calling
2182C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
fbcc39ad 2183
2184=cut
2185
75b65816 2186sub log_response {
2187 my $c = shift;
fbcc39ad 2188
75b65816 2189 return unless $c->debug;
fbcc39ad 2190
75b65816 2191 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2192 my $response = $dump->[1];
2193
2194 $c->log_response_status_line($response);
2195 $c->log_response_headers($response->headers);
2196}
2197
2198=head2 $c->log_response_status_line($response)
2199
2200Writes one line of information about the response to the debug logs. This includes:
10f204e1 2201
2202=over 4
2203
2204=item * Response status code
2205
3a4abdb3 2206=item * Content-Type header (if present)
2207
2208=item * Content-Length header (if present)
10f204e1 2209
2210=back
fbcc39ad 2211
2212=cut
2213
75b65816 2214sub log_response_status_line {
2215 my ($c, $response) = @_;
fbcc39ad 2216
697bab77 2217 $c->log->debug(
2218 sprintf(
2219 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2220 $response->status || 'unknown',
2221 $response->headers->header('Content-Type') || 'unknown',
2222 $response->headers->header('Content-Length') || 'unknown'
2223 )
2224 );
10f204e1 2225}
fbcc39ad 2226
75b65816 2227=head2 $c->log_response_headers($headers);
2228
8ad6fd58 2229Hook method which can be wrapped by plugins to log the response headers.
75b65816 2230No-op in the default implementation.
fbcc39ad 2231
2232=cut
2233
75b65816 2234sub log_response_headers {}
fbcc39ad 2235
10f204e1 2236=head2 $c->log_request_parameters( query => {}, body => {} )
2237
2238Logs request parameters to debug logs
2239
10f204e1 2240=cut
2241
2242sub log_request_parameters {
2243 my $c = shift;
2244 my %all_params = @_;
2245
2bf54936 2246 return unless $c->debug;
e7cbe1bf 2247
10f204e1 2248 my $column_width = Catalyst::Utils::term_width() - 44;
2249 foreach my $type (qw(query body)) {
2bf54936 2250 my $params = $all_params{$type};
2251 next if ! keys %$params;
10f204e1 2252 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
e7cbe1bf 2253 for my $key ( sort keys %$params ) {
2254 my $param = $params->{$key};
10f204e1 2255 my $value = defined($param) ? $param : '';
2256 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2257 }
2258 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2259 }
2260}
2261
2262=head2 $c->log_request_uploads
2263
2264Logs file uploads included in the request to the debug logs.
854e5dcd 2265The parameter name, filename, file type, and file size are all included in
10f204e1 2266the debug logs.
2267
2268=cut
fbcc39ad 2269
10f204e1 2270sub log_request_uploads {
2271 my $c = shift;
2bf54936 2272 my $request = shift;
e7cbe1bf 2273 return unless $c->debug;
2274 my $uploads = $request->uploads;
10f204e1 2275 if ( keys %$uploads ) {
8c113188 2276 my $t = Text::SimpleTable->new(
34d28dfd 2277 [ 12, 'Parameter' ],
2278 [ 26, 'Filename' ],
8c113188 2279 [ 18, 'Type' ],
2280 [ 9, 'Size' ]
2281 );
10f204e1 2282 for my $key ( sort keys %$uploads ) {
2283 my $upload = $uploads->{$key};
fbcc39ad 2284 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
8c113188 2285 $t->row( $key, $u->filename, $u->type, $u->size );
fbcc39ad 2286 }
2287 }
2288 $c->log->debug( "File Uploads are:\n" . $t->draw );
2289 }
2290}
2291
3a4abdb3 2292=head2 $c->log_request_headers($headers);
2293
2294Hook method which can be wrapped by plugins to log the request headers.
2295No-op in the default implementation.
2296
2297=cut
2298
2299sub log_request_headers {}
2300
10f204e1 2301=head2 $c->log_headers($type => $headers)
2302
e7cbe1bf 2303Logs L<HTTP::Headers> (either request or response) to the debug logs.
10f204e1 2304
2305=cut
2306
2307sub log_headers {
2308 my $c = shift;
2309 my $type = shift;
2310 my $headers = shift; # an HTTP::Headers instance
2311
e7cbe1bf 2312 return unless $c->debug;
10f204e1 2313
f0e9921a 2314 my $column_width = Catalyst::Utils::term_width() - 28;
2315 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
e7cbe1bf 2316 $headers->scan(
10f204e1 2317 sub {
2318 my ( $name, $value ) = @_;
2319 $t->row( $name, $value );
2320 }
2321 );
2322 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2323}
2324
10f204e1 2325
2326=head2 $c->prepare_read
2327
2328Prepares the input for reading.
2329
2330=cut
2331
2332sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2333
2334=head2 $c->prepare_request
2335
2336Prepares the engine request.
2337
2338=cut
2339
2340sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2341
2342=head2 $c->prepare_uploads
2343
2344Prepares uploads.
2345
2346=cut
2347
2348sub prepare_uploads {
2349 my $c = shift;
2350
2351 $c->engine->prepare_uploads( $c, @_ );
2352}
2353
b5ecfcf0 2354=head2 $c->prepare_write
fbcc39ad 2355
e7f1cf73 2356Prepares the output for writing.
fbcc39ad 2357
2358=cut
2359
2360sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2361
b5ecfcf0 2362=head2 $c->request_class
1f9cb7c1 2363
3f87d500 2364Returns or sets the request class. Defaults to L<Catalyst::Request>.
1f9cb7c1 2365
b5ecfcf0 2366=head2 $c->response_class
1f9cb7c1 2367
3f87d500 2368Returns or sets the response class. Defaults to L<Catalyst::Response>.
1f9cb7c1 2369
b5ecfcf0 2370=head2 $c->read( [$maxlength] )
fbcc39ad 2371
ae1e6b59 2372Reads a chunk of data from the request body. This method is designed to
2373be used in a while loop, reading C<$maxlength> bytes on every call.
2374C<$maxlength> defaults to the size of the request if not specified.
fbcc39ad 2375
4600a5a1 2376You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
ae1e6b59 2377directly.
fbcc39ad 2378
878b821c 2379Warning: If you use read(), Catalyst will not process the body,
2380so you will not be able to access POST parameters or file uploads via
2381$c->request. You must handle all body parsing yourself.
2382
fbcc39ad 2383=cut
2384
2385sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2386
b5ecfcf0 2387=head2 $c->run
fbcc39ad 2388
2389Starts the engine.
2390
2391=cut
2392
0c6352ff 2393sub run {
2394 my $app = shift;
2395 $app->engine_loader->needs_psgi_engine_compat_hack ?
2396 $app->engine->run($app, @_) :
2397 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2398}
fbcc39ad 2399
b5ecfcf0 2400=head2 $c->set_action( $action, $code, $namespace, $attrs )
fbcc39ad 2401
e7f1cf73 2402Sets an action in a given namespace.
fbcc39ad 2403
2404=cut
2405
2406sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2407
b5ecfcf0 2408=head2 $c->setup_actions($component)
fbcc39ad 2409
e7f1cf73 2410Sets up actions for a component.
fbcc39ad 2411
2412=cut
2413
2414sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2415
b5ecfcf0 2416=head2 $c->setup_components
fbcc39ad 2417
d261d153 2418This method is called internally to set up the application's components.
fbcc39ad 2419
d261d153 2420It finds modules by calling the L<locate_components> method, expands them to
2421package names with the L<expand_component_module> method, and then installs
2422each component into the application.
2423
2424The C<setup_components> config option is passed to both of the above methods.
fbcc39ad 2425
d261d153 2426Installation of each component is performed by the L<setup_component> method,
2427below.
2f381252 2428
fbcc39ad 2429=cut
2430
2431sub setup_components {
2432 my $class = shift;
2433
18de900e 2434 my $config = $class->config->{ setup_components };
62a6df80 2435
69c6b6cb 2436 my @comps = $class->locate_components($config);
b94b200c 2437 my %comps = map { $_ => 1 } @comps;
73e1183e 2438
8f6cebb2 2439 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
73e1183e 2440 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2441 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
8f6cebb2 2442 ) if $deprecatedcatalyst_component_names;
73e1183e 2443
b94b200c 2444 for my $component ( @comps ) {
dd91afb5 2445
2446 # We pass ignore_loaded here so that overlay files for (e.g.)
2447 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2448 # we know M::P::O found a file on disk so this is safe
2449
f5a4863c 2450 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
196f06d1 2451 }
2452
e7e4c469 2453 for my $component (@comps) {
5d02e790 2454 my $instance = $class->components->{ $component } = $class->setup_component($component);
2455 my @expanded_components = $instance->can('expand_modules')
2456 ? $instance->expand_modules( $component, $config )
2457 : $class->expand_component_module( $component, $config );
2458 for my $component (@expanded_components) {
05887b58 2459 next if $comps{$component};
e7e4c469 2460 $class->components->{ $component } = $class->setup_component($component);
fbcc39ad 2461 }
364d7324 2462 }
2463}
fbcc39ad 2464
d261d153 2465=head2 $c->locate_components( $setup_component_config )
2466
2467This method is meant to provide a list of component modules that should be
2468setup for the application. By default, it will use L<Module::Pluggable>.
2469
2470Specify a C<setup_components> config option to pass additional options directly
2471to L<Module::Pluggable>. To add additional search paths, specify a key named
2472C<search_extra> as an array reference. Items in the array beginning with C<::>
2473will have the application class name prepended to them.
2474
2475=cut
2476
2477sub locate_components {
2478 my $class = shift;
2479 my $config = shift;
2480
2481 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2482 my $extra = delete $config->{ search_extra } || [];
2483
2484 push @paths, @$extra;
2485
2486 my $locator = Module::Pluggable::Object->new(
2487 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2488 %$config
2489 );
2490
69c6b6cb 2491 # XXX think about ditching this sort entirely
2492 my @comps = sort { length $a <=> length $b } $locator->plugins;
d261d153 2493
2494 return @comps;
2495}
2496
2497=head2 $c->expand_component_module( $component, $setup_component_config )
2498
2499Components found by C<locate_components> will be passed to this method, which
2500is expected to return a list of component (package) names to be set up.
2501
d261d153 2502=cut
2503
2504sub expand_component_module {
2505 my ($class, $module) = @_;
05887b58 2506 return Devel::InnerPackage::list_packages( $module );
d261d153 2507}
2508
364d7324 2509=head2 $c->setup_component
fbcc39ad 2510
364d7324 2511=cut
fbcc39ad 2512
364d7324 2513sub setup_component {
2514 my( $class, $component ) = @_;
fbcc39ad 2515
364d7324 2516 unless ( $component->can( 'COMPONENT' ) ) {
2517 return $component;
2518 }
fbcc39ad 2519
364d7324 2520 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2521 my $config = $class->config->{ $suffix } || {};
8f6cebb2 2522 # Stash catalyst_component_name in the config here, so that custom COMPONENT
d2598ac8 2523 # methods also pass it. local to avoid pointlessly shitting in config
2524 # for the debug screen, as $component is already the key name.
8f6cebb2 2525 local $config->{catalyst_component_name} = $component;
fbcc39ad 2526
364d7324 2527 my $instance = eval { $component->COMPONENT( $class, $config ); };
fbcc39ad 2528
2529 if ( my $error = $@ ) {
fbcc39ad 2530 chomp $error;
fbcc39ad 2531 Catalyst::Exception->throw(
364d7324 2532 message => qq/Couldn't instantiate component "$component", "$error"/
2533 );
fbcc39ad 2534 }
2535
7490de2a 2536 unless (blessed $instance) {
2537 my $metaclass = Moose::Util::find_meta($component);
2538 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2539 my $component_method_from = $method_meta->associated_metaclass->name;
637fa644 2540 my $value = defined($instance) ? $instance : 'undef';
7490de2a 2541 Catalyst::Exception->throw(
2542 message =>
637fa644 2543 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
7490de2a 2544 );
2545 }
364d7324 2546 return $instance;
fbcc39ad 2547}
2548
b5ecfcf0 2549=head2 $c->setup_dispatcher
fbcc39ad 2550
ae1e6b59 2551Sets up dispatcher.
2552
fbcc39ad 2553=cut
2554
2555sub setup_dispatcher {
2556 my ( $class, $dispatcher ) = @_;
2557
2558 if ($dispatcher) {
2559 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2560 }
2561
cb69249e 2562 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2563 $dispatcher = 'Catalyst::Dispatcher::' . $env;
fbcc39ad 2564 }
2565
2566 unless ($dispatcher) {
cb0354c6 2567 $dispatcher = $class->dispatcher_class;
fbcc39ad 2568 }
2569
e63bdf38 2570 Class::MOP::load_class($dispatcher);
fbcc39ad 2571
2572 # dispatcher instance
2573 $class->dispatcher( $dispatcher->new );
2574}
2575
b5ecfcf0 2576=head2 $c->setup_engine
fbcc39ad 2577
ae1e6b59 2578Sets up engine.
2579
fbcc39ad 2580=cut
2581
1e5dad00 2582sub engine_class {
a8153308 2583 my ($class, $requested_engine) = @_;
2584
2585 if (!$class->engine_loader || $requested_engine) {
2586 $class->engine_loader(
2587 Catalyst::EngineLoader->new({
2588 application_name => $class,
2589 (defined $requested_engine
65420d46 2590 ? (catalyst_engine_class => $requested_engine) : ()),
a8153308 2591 }),
2592 );
2593 }
65420d46 2594
8ee06de7 2595 $class->engine_loader->catalyst_engine_class;
1e5dad00 2596}
2597
fbcc39ad 2598sub setup_engine {
a26a6adb 2599 my ($class, $requested_engine) = @_;
1085c936 2600
65420d46 2601 my $engine = do {
2602 my $loader = $class->engine_loader;
2603
2604 if (!$loader || $requested_engine) {
2605 $loader = Catalyst::EngineLoader->new({
2606 application_name => $class,
2607 (defined $requested_engine
2608 ? (requested_engine => $requested_engine) : ()),
2609 }),
2610
2611 $class->engine_loader($loader);
2612 }
2613
2614 $loader->catalyst_engine_class;
2615 };
1e5dad00 2616
2e1f92a3 2617 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2618 return if $class->loading_psgi_file;
2619
e63bdf38 2620 Class::MOP::load_class($engine);
0e7f5826 2621
532f0516 2622 if ($ENV{MOD_PERL}) {
1e5dad00 2623 my $apache = $class->engine_loader->auto;
ab4df9f8 2624
2625 my $meta = find_meta($class);
2626 my $was_immutable = $meta->is_immutable;
2627 my %immutable_options = $meta->immutable_options;
2628 $meta->make_mutable if $was_immutable;
2629
2630 $meta->add_method(handler => sub {
9fe15721 2631 my $r = shift;
1e5dad00 2632 my $psgi_app = $class->psgi_app;
2633 $apache->call_app($r, $psgi_app);
9fe15721 2634 });
ab4df9f8 2635
2636 $meta->make_immutable(%immutable_options) if $was_immutable;
532f0516 2637 }
2638
fbcc39ad 2639 $class->engine( $engine->new );
9fe15721 2640
fcffcb05 2641 return;
2642}
2643
8f076801 2644sub _finalized_psgi_app {
c8f4781e 2645 my ($app) = @_;
a0eec1fb 2646
2647 unless ($app->_psgi_app) {
8f076801 2648 my $psgi_app = $app->_setup_psgi_app;
a0eec1fb 2649 $app->_psgi_app($psgi_app);
2650 }
2651
2652 return $app->_psgi_app;
c8f4781e 2653}
2654
8f076801 2655sub _setup_psgi_app {
fcffcb05 2656 my ($app) = @_;
2657
1085c936 2658 for my $home (Path::Class::Dir->new($app->config->{home})) {
fcffcb05 2659 my $psgi_file = $home->file(
2660 Catalyst::Utils::appprefix($app) . '.psgi',
2661 );
2662
1085c936 2663 next unless -e $psgi_file;
2e1f92a3 2664
2665 # If $psgi_file calls ->setup_engine, it's doing so to load
2666 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2667 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2668 # anyway. So set a flag (ick) that tells setup_engine not to populate
2669 # $c->engine or do any other things we might regret.
2670
2671 $app->loading_psgi_file(1);
1085c936 2672 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2e1f92a3 2673 $app->loading_psgi_file(0);
1085c936 2674
2675 return $psgi_app
2676 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2677
1085c936 2678 warn <<"EOW";
2679Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2680
2681Its content has been ignored. Please consult the Catalyst::Upgrading
2682documentation on how to upgrade from Catalyst::Engine::PSGI.
2683EOW
fcffcb05 2684 }
2685
f05b654b 2686 return $app->apply_default_middlewares($app->psgi_app);
8f076801 2687}
2688
1316cc64 2689=head2 $c->apply_default_middlewares
2690
2691Adds the following L<Plack> middlewares to your application, since they are
2692useful and commonly needed:
2693
2694L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2695of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2696or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2697(if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2698applied since this middleware is smart enough to conditionally apply itself).
2699
2700Additionally if we detect we are using Nginx, we add a bit of custom middleware
2701to solve some problems with the way that server handles $ENV{PATH_INFO} and
2702$ENV{SCRIPT_NAME}
2703
2704=cut
2705
f05b654b 2706
2707sub apply_default_middlewares {
c72bc6eb 2708 my ($app, $psgi_app) = @_;
8f076801 2709
d89b863e 2710 $psgi_app = Plack::Middleware::Conditional->wrap(
c72bc6eb 2711 $psgi_app,
fcffcb05 2712 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2713 condition => sub {
2714 my ($env) = @_;
2715 return if $app->config->{ignore_frontend_proxy};
2716 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2717 || $app->config->{using_frontend_proxy};
2718 },
2719 );
d89b863e 2720
2721 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2722 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
d3670826 2723 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
d89b863e 2724
fb99321f 2725 # we're applying this unconditionally as the middleware itself already makes
2726 # sure it doesn't fuck things up if it's not running under one of the right
2727 # IIS versions
2728 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
a6fb59b7 2729
d89b863e 2730 return $psgi_app;
fcffcb05 2731}
2732
8f076801 2733=head2 $c->psgi_app
fcffcb05 2734
2735Returns a PSGI application code reference for the catalyst application
2736C<$c>. This is the bare application without any middlewares
8f076801 2737applied. C<${myapp}.psgi> is not taken into account.
2738
2739This is what you want to be using to retrieve the PSGI application code
2740reference of your Catalyst application for use in F<.psgi> files.
fcffcb05 2741
2742=cut
2743
8f076801 2744sub psgi_app {
fcffcb05 2745 my ($app) = @_;
2746 return $app->engine->build_psgi_app($app);
fbcc39ad 2747}
2748
b5ecfcf0 2749=head2 $c->setup_home
fbcc39ad 2750
ae1e6b59 2751Sets up the home directory.
2752
fbcc39ad 2753=cut
2754
2755sub setup_home {
2756 my ( $class, $home ) = @_;
2757
cb69249e 2758 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2759 $home = $env;
fbcc39ad 2760 }
2761
b6d4ee6e 2762 $home ||= Catalyst::Utils::home($class);
fbcc39ad 2763
2764 if ($home) {
e63bdf38 2765 #I remember recently being scolded for assigning config values like this
fbcc39ad 2766 $class->config->{home} ||= $home;
a738ab68