Note that wrapping the setup method will cause you pain
[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
0ef52a96 998sub plugin {
999 my ( $class, $name, $plugin, @args ) = @_;
6b2a933b 1000
4e68badc 1001 # See block comment in t/unit_core_plugin.t
3bdf9e57 1002 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
4e68badc 1003
97b58e17 1004 $class->_register_plugin( $plugin, 1 );
0ef52a96 1005
1006 eval { $plugin->import };
1007 $class->mk_classdata($name);
1008 my $obj;
1009 eval { $obj = $plugin->new(@args) };
1010
1011 if ($@) {
1012 Catalyst::Exception->throw( message =>
1013 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1014 }
1015
1016 $class->$name($obj);
1017 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1018 if $class->debug;
1019}
1020
b5ecfcf0 1021=head2 MyApp->setup
fbcc39ad 1022
e7f1cf73 1023Initializes the dispatcher and engine, loads any plugins, and loads the
ae1e6b59 1024model, view, and controller components. You may also specify an array
1025of plugins to load here, if you choose to not load them in the C<use
1026Catalyst> line.
fbcc39ad 1027
0ef52a96 1028 MyApp->setup;
1029 MyApp->setup( qw/-Debug/ );
fbcc39ad 1030
cf7ace24 1031B<Note:> You B<should not> wrap this method with method modifiers
1032or bad things will happen - wrap the C<setup_finalize> method instead.
1033
fbcc39ad 1034=cut
1035
1036sub setup {
0319a12c 1037 my ( $class, @arguments ) = @_;
c2f3cc1b 1038 croak('Running setup more than once')
1039 if ( $class->setup_finished );
5168a5fc 1040
fbcc39ad 1041 unless ( $class->isa('Catalyst') ) {
953b0e15 1042
fbcc39ad 1043 Catalyst::Exception->throw(
1044 message => qq/'$class' does not inherit from Catalyst/ );
1c99e125 1045 }
0319a12c 1046
fbcc39ad 1047 if ( $class->arguments ) {
1048 @arguments = ( @arguments, @{ $class->arguments } );
1049 }
1050
1051 # Process options
1052 my $flags = {};
1053
1054 foreach (@arguments) {
1055
1056 if (/^-Debug$/) {
1057 $flags->{log} =
1058 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1059 }
1060 elsif (/^-(\w+)=?(.*)$/) {
1061 $flags->{ lc $1 } = $2;
1062 }
1063 else {
1064 push @{ $flags->{plugins} }, $_;
1065 }
1066 }
1067
99f187d6 1068 $class->setup_home( delete $flags->{home} );
1069
fbcc39ad 1070 $class->setup_log( delete $flags->{log} );
1071 $class->setup_plugins( delete $flags->{plugins} );
1072 $class->setup_dispatcher( delete $flags->{dispatcher} );
acbecf08 1073 if (my $engine = delete $flags->{engine}) {
0aafa77a 1074 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
acbecf08 1075 }
1076 $class->setup_engine();
dc5f035e 1077 $class->setup_stats( delete $flags->{stats} );
fbcc39ad 1078
1079 for my $flag ( sort keys %{$flags} ) {
1080
1081 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1082 &$code( $class, delete $flags->{$flag} );
1083 }
1084 else {
1085 $class->log->warn(qq/Unknown flag "$flag"/);
1086 }
1087 }
1088
0eb4af72 1089 eval { require Catalyst::Devel; };
1090 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1091 $class->log->warn(<<"EOF");
4ff0d824 1092You are running an old script!
1093
34a83d89 1094 Please update by running (this will overwrite existing files):
1095 catalyst.pl -force -scripts $class
1096
1097 or (this will not overwrite existing files):
1098 catalyst.pl -scripts $class
1cf0345b 1099
4ff0d824 1100EOF
0eb4af72 1101 }
62a6df80 1102
fbcc39ad 1103 if ( $class->debug ) {
6601f2ad 1104 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
fbcc39ad 1105
1106 if (@plugins) {
39fc2ce1 1107 my $column_width = Catalyst::Utils::term_width() - 6;
1108 my $t = Text::SimpleTable->new($column_width);
8c113188 1109 $t->row($_) for @plugins;
1cf0345b 1110 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
fbcc39ad 1111 }
1112
1113 my $dispatcher = $class->dispatcher;
1114 my $engine = $class->engine;
1115 my $home = $class->config->{home};
1116
01ce7075 1117 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1118 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
fbcc39ad 1119
1120 $home
1121 ? ( -d $home )
1122 ? $class->log->debug(qq/Found home "$home"/)
1123 : $class->log->debug(qq/Home "$home" doesn't exist/)
1124 : $class->log->debug(q/Couldn't find home/);
1125 }
1126
54f4bfef 1127 # Call plugins setup, this is stupid and evil.
16b7c476 1128 # Also screws C3 badly on 5.10, hack to avoid.
fbcc39ad 1129 {
1130 no warnings qw/redefine/;
1131 local *setup = sub { };
16b7c476 1132 $class->setup unless $Catalyst::__AM_RESTARTING;
fbcc39ad 1133 }
1134
1135 # Initialize our data structure
1136 $class->components( {} );
1137
1138 $class->setup_components;
1139
1140 if ( $class->debug ) {
39fc2ce1 1141 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1142 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
684d10ed 1143 for my $comp ( sort keys %{ $class->components } ) {
1144 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1145 $t->row( $comp, $type );
1146 }
1cf0345b 1147 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
8c113188 1148 if ( keys %{ $class->components } );
fbcc39ad 1149 }
1150
1151 # Add our self to components, since we are also a component
96d8d513 1152 if( $class->isa('Catalyst::Controller') ){
1153 $class->components->{$class} = $class;
1154 }
fbcc39ad 1155
1156 $class->setup_actions;
1157
1158 if ( $class->debug ) {
1159 my $name = $class->config->{name} || 'Application';
1160 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1161 }
3643e890 1162
62a6df80 1163 # Make sure that the application class becomes immutable at this point,
acca8cd5 1164 B::Hooks::EndOfScope::on_scope_end {
df861f8e 1165 return if $@;
e106a59f 1166 my $meta = Class::MOP::get_metaclass_by_name($class);
4ffa3785 1167 if (
1168 $meta->is_immutable
1169 && ! { $meta->immutable_options }->{replace_constructor}
1170 && (
1171 $class->isa('Class::Accessor::Fast')
1172 || $class->isa('Class::Accessor')
1173 )
1174 ) {
81ef9afd 1175 warn "You made your application class ($class) immutable, "
4ffa3785 1176 . "but did not inline the\nconstructor. "
1177 . "This will break catalyst, as your app \@ISA "
1178 . "Class::Accessor(::Fast)?\nPlease pass "
1179 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
6e5505d4 1180 }
83b8cda1 1181 $meta->make_immutable(
1182 replace_constructor => 1,
83b8cda1 1183 ) unless $meta->is_immutable;
acca8cd5 1184 };
3d041c32 1185
647a3de1 1186 if ($class->config->{case_sensitive}) {
1187 $class->log->warn($class . "->config->{case_sensitive} is set.");
1188 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1189 }
1190
a5d07d29 1191 $class->setup_finalize;
647a3de1 1192 # Should be the last thing we do so that user things hooking
1193 # setup_finalize can log..
1194 $class->log->_flush() if $class->log->can('_flush');
64ceb36b 1195 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
a5d07d29 1196}
1197
23c63a17 1198=head2 $app->setup_finalize
1199
128a7cee 1200A hook to attach modifiers to. This method does not do anything except set the
1201C<setup_finished> accessor.
23c63a17 1202
ae7da8f5 1203Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
23c63a17 1204
128a7cee 1205Example:
23c63a17 1206
128a7cee 1207 after setup_finalize => sub {
1208 my $app = shift;
23c63a17 1209
128a7cee 1210 ## do stuff here..
1211 };
23c63a17 1212
1213=cut
1214
a5d07d29 1215sub setup_finalize {
1216 my ($class) = @_;
3643e890 1217 $class->setup_finished(1);
fbcc39ad 1218}
1219
d71da6fe 1220=head2 $c->uri_for( $path?, @args?, \%query_values? )
fbcc39ad 1221
ee8963de 1222=head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
9df7c5d9 1223
ee8963de 1224Constructs an absolute L<URI> object based on the application root, the
1225provided path, and the additional arguments and query parameters provided.
186d5270 1226When used as a string, provides a textual URI. If you need more flexibility
92981fc3 1227than this (i.e. the option to provide relative URIs etc.) see
186d5270 1228L<Catalyst::Plugin::SmartURI>.
ee8963de 1229
d71da6fe 1230If no arguments are provided, the URI for the current action is returned.
1231To return the current action and also provide @args, use
1d3a0700 1232C<< $c->uri_for( $c->action, @args ) >>.
d71da6fe 1233
ee8963de 1234If the first argument is a string, it is taken as a public URI path relative
1235to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
e7e4c469 1236relative to the application root (if it does). It is then merged with
ee8963de 1237C<< $c->request->base >>; any C<@args> are appended as additional path
1238components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1239
1240If the first argument is a L<Catalyst::Action> it represents an action which
1241will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1242optional C<\@captures> argument (an arrayref) allows passing the captured
1243variables that are needed to fill in the paths of Chained and Regex actions;
1244once the path is resolved, C<uri_for> continues as though a path was
1245provided, appending any arguments or parameters and creating an absolute
1246URI.
1247
e7e4c469 1248The captures for the current request can be found in
ee8963de 1249C<< $c->request->captures >>, and actions can be resolved using
1250C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1251path, use C<< $c->uri_for_action >> instead.
1252
1253 # Equivalent to $c->req->uri
e7e4c469 1254 $c->uri_for($c->action, $c->req->captures,
ee8963de 1255 @{ $c->req->args }, $c->req->params);
62a6df80 1256
9df7c5d9 1257 # For the Foo action in the Bar controller
ee8963de 1258 $c->uri_for($c->controller('Bar')->action_for('Foo'));
9df7c5d9 1259
ee8963de 1260 # Path to a static resource
1261 $c->uri_for('/static/images/logo.png');
d5e3d528 1262
4cf1dd00 1263=cut
1264
fbcc39ad 1265sub uri_for {
00e6a2b7 1266 my ( $c, $path, @args ) = @_;
00e6a2b7 1267
7069eab5 1268 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1269 $path = $path->path_prefix;
1270 $path =~ s{/+\z}{};
1271 $path .= '/';
1272 }
1273
2689f8a4 1274 undef($path) if (defined $path && $path eq '');
1275
1276 my $params =
1277 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1278
1279 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
a4f2cdc8 1280 foreach my $arg (@args) {
1281 utf8::encode($arg) if utf8::is_utf8($arg);
49229f68 1282 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
2689f8a4 1283 }
1284
7e95ba12 1285 if ( blessed($path) ) { # action object
49229f68 1286 s|/|%2F|g for @args;
2689f8a4 1287 my $captures = [ map { s|/|%2F|g; $_; }
aaf72276 1288 ( scalar @args && ref $args[0] eq 'ARRAY'
1289 ? @{ shift(@args) }
1290 : ()) ];
7b346bc3 1291
1292 foreach my $capture (@$captures) {
1293 utf8::encode($capture) if utf8::is_utf8($capture);
1294 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1295 }
1296
aa7e913e 1297 my $action = $path;
0cff119a 1298 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1299 if( !@args && $action->number_of_args ) {
1300 my $expanded_action = $c->dispatcher->expand_action( $action );
1301
1302 my $num_captures = $expanded_action->number_of_captures;
1303 unshift @args, splice @$captures, $num_captures;
1304 }
1305
1306 $path = $c->dispatcher->uri_for_action($action, $captures);
aa7e913e 1307 if (not defined $path) {
1308 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1309 if $c->debug;
1310 return undef;
1311 }
81e75875 1312 $path = '/' if $path eq '';
ea0e58d9 1313 }
1314
51674a63 1315 unshift(@args, $path);
1316
1317 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1318 my $namespace = $c->namespace;
1319 if (defined $path) { # cheesy hack to handle path '../foo'
1320 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
6601f2ad 1321 }
51674a63 1322 unshift(@args, $namespace || '');
1323 }
62a6df80 1324
189e2a51 1325 # join args with '/', or a blank string
51674a63 1326 my $args = join('/', grep { defined($_) } @args);
1327 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
7a2295bc 1328 $args =~ s!^/+!!;
51674a63 1329 my $base = $c->req->base;
1330 my $class = ref($base);
1331 $base =~ s{(?<!/)$}{/};
1332
1333 my $query = '';
1334
1335 if (my @keys = keys %$params) {
1336 # somewhat lifted from URI::_query's query_form
1337 $query = '?'.join('&', map {
2f381252 1338 my $val = $params->{$_};
51674a63 1339 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1340 s/ /+/g;
1341 my $key = $_;
51674a63 1342 $val = '' unless defined $val;
1343 (map {
1f851263 1344 my $param = "$_";
1345 utf8::encode( $param ) if utf8::is_utf8($param);
51674a63 1346 # using the URI::Escape pattern here so utf8 chars survive
1f851263 1347 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1348 $param =~ s/ /+/g;
1349 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
51674a63 1350 } @keys);
1351 }
1352
1353 my $res = bless(\"${base}${args}${query}", $class);
d3e7a648 1354 $res;
fbcc39ad 1355}
1356
833b385e 1357=head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1358
1359=head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1360
1361=over
1362
1363=item $path
1364
1365A private path to the Catalyst action you want to create a URI for.
1366
1367This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1368>> and passing the resulting C<$action> and the remaining arguments to C<<
1369$c->uri_for >>.
1370
1371You can also pass in a Catalyst::Action object, in which case it is passed to
1372C<< $c->uri_for >>.
1373
c9ec25f8 1374Note 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.
1375
1376For example, if the action looks like:
1377
1378 package MyApp::Controller::Users;
1379
1380 sub lst : Path('the-list') {}
1381
1382You can use:
1383
1384 $c->uri_for_action('/users/lst')
1385
1386and it will create the URI /users/the-list.
1387
833b385e 1388=back
1389
1390=cut
1391
1392sub uri_for_action {
1393 my ( $c, $path, @args ) = @_;
62a6df80 1394 my $action = blessed($path)
1395 ? $path
833b385e 1396 : $c->dispatcher->get_action_by_path($path);
4ac0b9cb 1397 unless (defined $action) {
1398 croak "Can't find action for path '$path'";
1399 }
833b385e 1400 return $c->uri_for( $action, @args );
1401}
1402
b5ecfcf0 1403=head2 $c->welcome_message
ab2374d3 1404
1405Returns the Catalyst welcome HTML page.
1406
1407=cut
1408
1409sub welcome_message {
bf1f2c60 1410 my $c = shift;
1411 my $name = $c->config->{name};
1412 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1413 my $prefix = Catalyst::Utils::appprefix( ref $c );
80cdbbff 1414 $c->response->content_type('text/html; charset=utf-8');
ab2374d3 1415 return <<"EOF";
80cdbbff 1416<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1417 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1418<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
ab2374d3 1419 <head>
85d9fce6 1420 <meta http-equiv="Content-Language" content="en" />
1421 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
ab2374d3 1422 <title>$name on Catalyst $VERSION</title>
1423 <style type="text/css">
1424 body {
ab2374d3 1425 color: #000;
1426 background-color: #eee;
1427 }
1428 div#content {
1429 width: 640px;
80cdbbff 1430 margin-left: auto;
1431 margin-right: auto;
ab2374d3 1432 margin-top: 10px;
1433 margin-bottom: 10px;
1434 text-align: left;
1435 background-color: #ccc;
1436 border: 1px solid #aaa;
ab2374d3 1437 }
d84c4dab 1438 p, h1, h2 {
ab2374d3 1439 margin-left: 20px;
1440 margin-right: 20px;
16215972 1441 font-family: verdana, tahoma, sans-serif;
ab2374d3 1442 }
d84c4dab 1443 a {
1444 font-family: verdana, tahoma, sans-serif;
1445 }
d114e033 1446 :link, :visited {
1447 text-decoration: none;
1448 color: #b00;
1449 border-bottom: 1px dotted #bbb;
1450 }
1451 :link:hover, :visited:hover {
d114e033 1452 color: #555;
1453 }
ab2374d3 1454 div#topbar {
1455 margin: 0px;
1456 }
3e82a295 1457 pre {
3e82a295 1458 margin: 10px;
1459 padding: 8px;
1460 }
ab2374d3 1461 div#answers {
1462 padding: 8px;
1463 margin: 10px;
d114e033 1464 background-color: #fff;
ab2374d3 1465 border: 1px solid #aaa;
ab2374d3 1466 }
1467 h1 {
33108eaf 1468 font-size: 0.9em;
1469 font-weight: normal;
ab2374d3 1470 text-align: center;
1471 }
1472 h2 {
1473 font-size: 1.0em;
1474 }
1475 p {
1476 font-size: 0.9em;
1477 }
ae7c5252 1478 p img {
1479 float: right;
1480 margin-left: 10px;
1481 }
9619f23c 1482 span#appname {
1483 font-weight: bold;
33108eaf 1484 font-size: 1.6em;
ab2374d3 1485 }
1486 </style>
1487 </head>
1488 <body>
1489 <div id="content">
1490 <div id="topbar">
9619f23c 1491 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
d84c4dab 1492 $VERSION</h1>
ab2374d3 1493 </div>
1494 <div id="answers">
ae7c5252 1495 <p>
80cdbbff 1496 <img src="$logo" alt="Catalyst Logo" />
ae7c5252 1497 </p>
596aaffe 1498 <p>Welcome to the world of Catalyst.
f92fd545 1499 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1500 framework will make web development something you had
60dd6e1d 1501 never expected it to be: Fun, rewarding, and quick.</p>
ab2374d3 1502 <h2>What to do now?</h2>
4b8cb778 1503 <p>That really depends on what <b>you</b> want to do.
ab2374d3 1504 We do, however, provide you with a few starting points.</p>
1505 <p>If you want to jump right into web development with Catalyst
2f381252 1506 you might want to start with a tutorial.</p>
b607f8a0 1507<pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
596aaffe 1508</pre>
1509<p>Afterwards you can go on to check out a more complete look at our features.</p>
1510<pre>
b607f8a0 1511<code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1512<!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1513</code></pre>
ab2374d3 1514 <h2>What to do next?</h2>
f5681c92 1515 <p>Next it's time to write an actual application. Use the
80cdbbff 1516 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&amp;mode=all">controllers</a>,
60dd6e1d 1517 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&amp;mode=all">models</a>, and
1518 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&amp;mode=all">views</a>;
bf1f2c60 1519 they can save you a lot of work.</p>
c5f31918 1520 <pre><code>script/${prefix}_create.pl --help</code></pre>
bf1f2c60 1521 <p>Also, be sure to check out the vast and growing
802bf2cb 1522 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
bf1f2c60 1523 you are likely to find what you need there.
f5681c92 1524 </p>
1525
82245cc4 1526 <h2>Need help?</h2>
f5681c92 1527 <p>Catalyst has a very active community. Here are the main places to
1528 get in touch with us.</p>
16215972 1529 <ul>
1530 <li>
2b9a7d76 1531 <a href="http://dev.catalyst.perl.org">Wiki</a>
16215972 1532 </li>
1533 <li>
6d4c3368 1534 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
16215972 1535 </li>
1536 <li>
4eaf7c88 1537 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
16215972 1538 </li>
1539 </ul>
ab2374d3 1540 <h2>In conclusion</h2>
62a6df80 1541 <p>The Catalyst team hopes you will enjoy using Catalyst as much
f5681c92 1542 as we enjoyed making it. Please contact us if you have ideas
1543 for improvement or other feedback.</p>
ab2374d3 1544 </div>
1545 </div>
1546 </body>
1547</html>
1548EOF
1549}
1550
fbcc39ad 1551=head1 INTERNAL METHODS
1552
ae1e6b59 1553These methods are not meant to be used by end users.
1554
b5ecfcf0 1555=head2 $c->components
fbcc39ad 1556
e7f1cf73 1557Returns a hash of components.
fbcc39ad 1558
b5ecfcf0 1559=head2 $c->context_class
1f9cb7c1 1560
e7f1cf73 1561Returns or sets the context class.
1f9cb7c1 1562
b5ecfcf0 1563=head2 $c->counter
fbcc39ad 1564
ae1e6b59 1565Returns a hashref containing coderefs and execution counts (needed for
1566deep recursion detection).
fbcc39ad 1567
b5ecfcf0 1568=head2 $c->depth
fbcc39ad 1569
e7f1cf73 1570Returns the number of actions on the current internal execution stack.
fbcc39ad 1571
b5ecfcf0 1572=head2 $c->dispatch
fbcc39ad 1573
e7f1cf73 1574Dispatches a request to actions.
fbcc39ad 1575
1576=cut
1577
1578sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1579
b5ecfcf0 1580=head2 $c->dispatcher_class
1f9cb7c1 1581
e7f1cf73 1582Returns or sets the dispatcher class.
1f9cb7c1 1583
b5ecfcf0 1584=head2 $c->dump_these
7f92deef 1585
ae1e6b59 1586Returns a list of 2-element array references (name, structure) pairs
1587that will be dumped on the error page in debug mode.
7f92deef 1588
1589=cut
1590
1591sub dump_these {
1592 my $c = shift;
62a6df80 1593 [ Request => $c->req ],
1594 [ Response => $c->res ],
052a2d89 1595 [ Stash => $c->stash ],
1596 [ Config => $c->config ];
7f92deef 1597}
1598
b5ecfcf0 1599=head2 $c->engine_class
1f9cb7c1 1600
e7f1cf73 1601Returns or sets the engine class.
1f9cb7c1 1602
b5ecfcf0 1603=head2 $c->execute( $class, $coderef )
fbcc39ad 1604
0ef52a96 1605Execute a coderef in given class and catch exceptions. Errors are available
1606via $c->error.
fbcc39ad 1607
1608=cut
1609
1610sub execute {
1611 my ( $c, $class, $code ) = @_;
858828dd 1612 $class = $c->component($class) || $class;
fbcc39ad 1613 $c->state(0);
a0eca838 1614
197bd788 1615 if ( $c->depth >= $RECURSION ) {
f3414019 1616 my $action = $code->reverse();
91d08727 1617 $action = "/$action" unless $action =~ /->/;
f3414019 1618 my $error = qq/Deep recursion detected calling "${action}"/;
1627551a 1619 $c->log->error($error);
1620 $c->error($error);
1621 $c->state(0);
1622 return $c->state;
1623 }
1624
dc5f035e 1625 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
22247e54 1626
8767c5a3 1627 push( @{ $c->stack }, $code );
62a6df80 1628
6f3df815 1629 no warnings 'recursion';
524b0e1c 1630 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1631 # I have no idea how, ergo $ret (which appears to fix the issue)
1632 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
22247e54 1633
dc5f035e 1634 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
62a6df80 1635
a6724a82 1636 my $last = pop( @{ $c->stack } );
fbcc39ad 1637
1638 if ( my $error = $@ ) {
79f5d571 1639 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
f87b7c21 1640 $error->rethrow if $c->depth > 1;
2f381252 1641 }
79f5d571 1642 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
f87b7c21 1643 $error->rethrow if $c->depth > 0;
55424863 1644 }
fbcc39ad 1645 else {
1646 unless ( ref $error ) {
91d08727 1647 no warnings 'uninitialized';
fbcc39ad 1648 chomp $error;
f59def82 1649 my $class = $last->class;
1650 my $name = $last->name;
1651 $error = qq/Caught exception in $class->$name "$error"/;
fbcc39ad 1652 }
fbcc39ad 1653 $c->error($error);
fbcc39ad 1654 }
2688734f 1655 $c->state(0);
fbcc39ad 1656 }
1657 return $c->state;
1658}
1659
7a7d7af5 1660sub _stats_start_execute {
1661 my ( $c, $code ) = @_;
df960201 1662 my $appclass = ref($c) || $c;
a6724a82 1663 return if ( ( $code->name =~ /^_.*/ )
df960201 1664 && ( !$appclass->config->{show_internal_actions} ) );
7a7d7af5 1665
f3414019 1666 my $action_name = $code->reverse();
1667 $c->counter->{$action_name}++;
7a7d7af5 1668
f3414019 1669 my $action = $action_name;
a6724a82 1670 $action = "/$action" unless $action =~ /->/;
1671
7a7d7af5 1672 # determine if the call was the result of a forward
1673 # this is done by walking up the call stack and looking for a calling
1674 # sub of Catalyst::forward before the eval
1675 my $callsub = q{};
1676 for my $index ( 2 .. 11 ) {
1677 last
1678 if ( ( caller($index) )[0] eq 'Catalyst'
1679 && ( caller($index) )[3] eq '(eval)' );
1680
1681 if ( ( caller($index) )[3] =~ /forward$/ ) {
1682 $callsub = ( caller($index) )[3];
1683 $action = "-> $action";
1684 last;
1685 }
1686 }
1687
f3414019 1688 my $uid = $action_name . $c->counter->{$action_name};
74efc144 1689
a6724a82 1690 # is this a root-level call or a forwarded call?
1691 if ( $callsub =~ /forward$/ ) {
91740f34 1692 my $parent = $c->stack->[-1];
a6724a82 1693
1694 # forward, locate the caller
9c74923d 1695 if ( defined $parent && exists $c->counter->{"$parent"} ) {
69d8f33c 1696 $c->stats->profile(
62a6df80 1697 begin => $action,
69d8f33c 1698 parent => "$parent" . $c->counter->{"$parent"},
1699 uid => $uid,
1700 );
7a7d7af5 1701 }
1702 else {
1703
a6724a82 1704 # forward with no caller may come from a plugin
69d8f33c 1705 $c->stats->profile(
1706 begin => $action,
1707 uid => $uid,
1708 );
7a7d7af5 1709 }
1710 }
a6724a82 1711 else {
62a6df80 1712
a6724a82 1713 # root-level call
69d8f33c 1714 $c->stats->profile(
1715 begin => $action,
1716 uid => $uid,
1717 );
a6724a82 1718 }
dc5f035e 1719 return $action;
7a7d7af5 1720
7a7d7af5 1721}
1722
1723sub _stats_finish_execute {
1724 my ( $c, $info ) = @_;
69d8f33c 1725 $c->stats->profile( end => $info );
7a7d7af5 1726}
1727
b5ecfcf0 1728=head2 $c->finalize
fbcc39ad 1729
e7f1cf73 1730Finalizes the request.
fbcc39ad 1731
1732=cut
1733
1734sub finalize {
1735 my $c = shift;
1736
369c09bc 1737 for my $error ( @{ $c->error } ) {
1738 $c->log->error($error);
1739 }
1740
5050d7a7 1741 # Allow engine to handle finalize flow (for POE)
e63bdf38 1742 my $engine = $c->engine;
1743 if ( my $code = $engine->can('finalize') ) {
1744 $engine->$code($c);
fbcc39ad 1745 }
5050d7a7 1746 else {
fbcc39ad 1747
5050d7a7 1748 $c->finalize_uploads;
fbcc39ad 1749
5050d7a7 1750 # Error
1751 if ( $#{ $c->error } >= 0 ) {
1752 $c->finalize_error;
1753 }
1754
1755 $c->finalize_headers;
fbcc39ad 1756
5050d7a7 1757 # HEAD request
1758 if ( $c->request->method eq 'HEAD' ) {
1759 $c->response->body('');
1760 }
1761
1762 $c->finalize_body;
1763 }
62a6df80 1764
2bf54936 1765 $c->log_response;
10f204e1 1766
62a6df80 1767 if ($c->use_stats) {
596677b6 1768 my $elapsed = sprintf '%f', $c->stats->elapsed;
12bf12c0 1769 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
908e3d9e 1770 $c->log->info(
62a6df80 1771 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
908e3d9e 1772 }
fbcc39ad 1773
1774 return $c->response->status;
1775}
1776
b5ecfcf0 1777=head2 $c->finalize_body
fbcc39ad 1778
e7f1cf73 1779Finalizes body.
fbcc39ad 1780
1781=cut
1782
1783sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1784
b5ecfcf0 1785=head2 $c->finalize_cookies
fbcc39ad 1786
e7f1cf73 1787Finalizes cookies.
fbcc39ad 1788
1789=cut
1790
147821ea 1791sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
fbcc39ad 1792
b5ecfcf0 1793=head2 $c->finalize_error
fbcc39ad 1794
e7f1cf73 1795Finalizes error.
fbcc39ad 1796
1797=cut
1798
1799sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1800
b5ecfcf0 1801=head2 $c->finalize_headers
fbcc39ad 1802
e7f1cf73 1803Finalizes headers.
fbcc39ad 1804
1805=cut
1806
1807sub finalize_headers {
1808 my $c = shift;
1809
e63bdf38 1810 my $response = $c->response; #accessor calls can add up?
1811
fbcc39ad 1812 # Check if we already finalized headers
6680c772 1813 return if $response->finalized_headers;
fbcc39ad 1814
1815 # Handle redirects
e63bdf38 1816 if ( my $location = $response->redirect ) {
fbcc39ad 1817 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
e63bdf38 1818 $response->header( Location => $location );
a7caa492 1819
02570318 1820 if ( !$response->has_body ) {
39655cdc 1821 # Add a default body if none is already present
9c331634 1822 $response->body(<<"EOF");
1823<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1824<html xmlns="http://www.w3.org/1999/xhtml">
1825 <head>
1826 <title>Moved</title>
1827 </head>
1828 <body>
1829 <p>This item has moved <a href="$location">here</a>.</p>
1830 </body>
1831</html>
1832EOF
d455230c 1833 $response->content_type('text/html; charset=utf-8');
39655cdc 1834 }
fbcc39ad 1835 }
1836
1837 # Content-Length
ac057d3b 1838 if ( defined $response->body && length $response->body && !$response->content_length ) {
775878ac 1839
8f62c91a 1840 # get the length from a filehandle
9c74923d 1841 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
197bd788 1842 {
34effbc7 1843 my $size = -s $response->body;
1844 if ( $size ) {
1845 $response->content_length( $size );
8f62c91a 1846 }
1847 else {
775878ac 1848 $c->log->warn('Serving filehandle without a content-length');
8f62c91a 1849 }
1850 }
1851 else {
b5d7a61f 1852 # everything should be bytes at this point, but just in case
5ab21903 1853 $response->content_length( length( $response->body ) );
8f62c91a 1854 }
fbcc39ad 1855 }
1856
1857 # Errors
e63bdf38 1858 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1859 $response->headers->remove_header("Content-Length");
1860 $response->body('');
fbcc39ad 1861 }
1862
1863 $c->finalize_cookies;
1864
1865 $c->engine->finalize_headers( $c, @_ );
1866
1867 # Done
6680c772 1868 $response->finalized_headers(1);
fbcc39ad 1869}
1870
b5ecfcf0 1871=head2 $c->finalize_output
fbcc39ad 1872
1873An alias for finalize_body.
1874
b5ecfcf0 1875=head2 $c->finalize_read
fbcc39ad 1876
e7f1cf73 1877Finalizes the input after reading is complete.
fbcc39ad 1878
1879=cut
1880
1881sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1882
b5ecfcf0 1883=head2 $c->finalize_uploads
fbcc39ad 1884
ae1e6b59 1885Finalizes uploads. Cleans up any temporary files.
fbcc39ad 1886
1887=cut
1888
1889sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1890
b5ecfcf0 1891=head2 $c->get_action( $action, $namespace )
fbcc39ad 1892
e7f1cf73 1893Gets an action in a given namespace.
fbcc39ad 1894
1895=cut
1896
684d10ed 1897sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
fbcc39ad 1898
b5ecfcf0 1899=head2 $c->get_actions( $action, $namespace )
a9dc674c 1900
ae1e6b59 1901Gets all actions of a given name in a namespace and all parent
1902namespaces.
a9dc674c 1903
1904=cut
1905
1906sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1907
e5ce5f04 1908=head2 $app->handle_request( @arguments )
fbcc39ad 1909
e7f1cf73 1910Called to handle each HTTP request.
fbcc39ad 1911
1912=cut
1913
1914sub handle_request {
1915 my ( $class, @arguments ) = @_;
1916
1917 # Always expect worst case!
1918 my $status = -1;
3640641e 1919 try {
dea1884f 1920 if ($class->debug) {
908e3d9e 1921 my $secs = time - $START || 1;
1922 my $av = sprintf '%.3f', $COUNT / $secs;
1923 my $time = localtime time;
1924 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
dea1884f 1925 }
908e3d9e 1926
1927 my $c = $class->prepare(@arguments);
1928 $c->dispatch;
62a6df80 1929 $status = $c->finalize;
fbcc39ad 1930 }
3640641e 1931 catch {
1932 chomp(my $error = $_);
1933 $class->log->error(qq/Caught exception in engine "$error"/);
1934 };
fbcc39ad 1935
1936 $COUNT++;
62a6df80 1937
6680c772 1938 if(my $coderef = $class->log->can('_flush')){
1939 $class->log->$coderef();
1940 }
fbcc39ad 1941 return $status;
1942}
1943
d536010b 1944=head2 $class->prepare( @arguments )
fbcc39ad 1945
ae1e6b59 1946Creates a Catalyst context from an engine-specific request (Apache, CGI,
1947etc.).
fbcc39ad 1948
1949=cut
1950
1951sub prepare {
1952 my ( $class, @arguments ) = @_;
1953
6680c772 1954 # XXX
1955 # After the app/ctxt split, this should become an attribute based on something passed
1956 # into the application.
3cec521a 1957 $class->context_class( ref $class || $class ) unless $class->context_class;
62a6df80 1958
6680c772 1959 my $c = $class->context_class->new({});
1960
1961 # For on-demand data
1962 $c->request->_context($c);
1963 $c->response->_context($c);
fbcc39ad 1964
b6d4ee6e 1965 #surely this is not the most efficient way to do things...
dc5f035e 1966 $c->stats($class->stats_class->new)->enable($c->use_stats);
4f0b7cf1 1967 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
62a6df80 1968 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
908e3d9e 1969 }
1970
3640641e 1971 try {
1972 # Allow engine to direct the prepare flow (for POE)
1973 if ( my $prepare = $c->engine->can('prepare') ) {
1974 $c->engine->$prepare( $c, @arguments );
1975 }
1976 else {
1977 $c->prepare_request(@arguments);
1978 $c->prepare_connection;
1979 $c->prepare_query_parameters;
1980 $c->prepare_headers;
1981 $c->prepare_cookies;
1982 $c->prepare_path;
1983
1984 # Prepare the body for reading, either by prepare_body
1985 # or the user, if they are using $c->read
1986 $c->prepare_read;
1987
1988 # Parse the body unless the user wants it on-demand
1989 unless ( ref($c)->config->{parse_on_demand} ) {
1990 $c->prepare_body;
1991 }
878b821c 1992 }
5050d7a7 1993 }
3640641e 1994 # VERY ugly and probably shouldn't rely on ->finalize actually working
1995 catch {
1996 # failed prepare is always due to an invalid request, right?
1997 $c->response->status(400);
1998 $c->response->content_type('text/plain');
1999 $c->response->body('Bad Request');
2000 $c->finalize;
2001 die $_;
2002 };
fbcc39ad 2003
fbcc39ad 2004 my $method = $c->req->method || '';
2f381252 2005 my $path = $c->req->path;
2006 $path = '/' unless length $path;
fbcc39ad 2007 my $address = $c->req->address || '';
2008
10f204e1 2009 $c->log_request;
fbcc39ad 2010
e3a13771 2011 $c->prepare_action;
2012
fbcc39ad 2013 return $c;
2014}
2015
b5ecfcf0 2016=head2 $c->prepare_action
fbcc39ad 2017
b4b01a8a 2018Prepares action. See L<Catalyst::Dispatcher>.
fbcc39ad 2019
2020=cut
2021
2022sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2023
b5ecfcf0 2024=head2 $c->prepare_body
fbcc39ad 2025
e7f1cf73 2026Prepares message body.
fbcc39ad 2027
2028=cut
2029
2030sub prepare_body {
2031 my $c = shift;
2032
0f56bbcf 2033 return if $c->request->_has_body;
fbcc39ad 2034
2035 # Initialize on-demand data
2036 $c->engine->prepare_body( $c, @_ );
2037 $c->prepare_parameters;
2038 $c->prepare_uploads;
fbcc39ad 2039}
2040
b5ecfcf0 2041=head2 $c->prepare_body_chunk( $chunk )
4bd82c41 2042
e7f1cf73 2043Prepares a chunk of data before sending it to L<HTTP::Body>.
4bd82c41 2044
b4b01a8a 2045See L<Catalyst::Engine>.
2046
4bd82c41 2047=cut
2048
4f5ebacd 2049sub prepare_body_chunk {
2050 my $c = shift;
4bd82c41 2051 $c->engine->prepare_body_chunk( $c, @_ );
2052}
2053
b5ecfcf0 2054=head2 $c->prepare_body_parameters
fbcc39ad 2055
e7f1cf73 2056Prepares body parameters.
fbcc39ad 2057
2058=cut
2059
2060sub prepare_body_parameters {
2061 my $c = shift;
2062 $c->engine->prepare_body_parameters( $c, @_ );
2063}
2064
b5ecfcf0 2065=head2 $c->prepare_connection
fbcc39ad 2066
e7f1cf73 2067Prepares connection.
fbcc39ad 2068
2069=cut
2070
2071sub prepare_connection {
2072 my $c = shift;
2073 $c->engine->prepare_connection( $c, @_ );
2074}
2075
b5ecfcf0 2076=head2 $c->prepare_cookies
fbcc39ad 2077
e7f1cf73 2078Prepares cookies.
fbcc39ad 2079
2080=cut
2081
2082sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2083
b5ecfcf0 2084=head2 $c->prepare_headers
fbcc39ad 2085
e7f1cf73 2086Prepares headers.
fbcc39ad 2087
2088=cut
2089
2090sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2091
b5ecfcf0 2092=head2 $c->prepare_parameters
fbcc39ad 2093
e7f1cf73 2094Prepares parameters.
fbcc39ad 2095
2096=cut
2097
2098sub prepare_parameters {
2099 my $c = shift;
2100 $c->prepare_body_parameters;
2101 $c->engine->prepare_parameters( $c, @_ );
2102}
2103
b5ecfcf0 2104=head2 $c->prepare_path
fbcc39ad 2105
e7f1cf73 2106Prepares path and base.
fbcc39ad 2107
2108=cut
2109
2110sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2111
b5ecfcf0 2112=head2 $c->prepare_query_parameters
fbcc39ad 2113
e7f1cf73 2114Prepares query parameters.
fbcc39ad 2115
2116=cut
2117
2118sub prepare_query_parameters {
2119 my $c = shift;
2120
2121 $c->engine->prepare_query_parameters( $c, @_ );
10f204e1 2122}
fbcc39ad 2123
10f204e1 2124=head2 $c->log_request
2125
2126Writes information about the request to the debug logs. This includes:
2127
2128=over 4
2129
854e5dcd 2130=item * Request method, path, and remote IP address
10f204e1 2131
2132=item * Query keywords (see L<Catalyst::Request/query_keywords>)
2133
e7cbe1bf 2134=item * Request parameters
10f204e1 2135
2136=item * File uploads
2137
2138=back
fbcc39ad 2139
2140=cut
2141
10f204e1 2142sub log_request {
2143 my $c = shift;
fbcc39ad 2144
10f204e1 2145 return unless $c->debug;
fbcc39ad 2146
2bf54936 2147 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2148 my $request = $dump->[1];
e7cbe1bf 2149
2150 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
10f204e1 2151 $method ||= '';
2152 $path = '/' unless length $path;
2153 $address ||= '';
2154 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2155
3a4abdb3 2156 $c->log_request_headers($request->headers);
e7cbe1bf 2157
2158 if ( my $keywords = $request->query_keywords ) {
10f204e1 2159 $c->log->debug("Query keywords are: $keywords");
fbcc39ad 2160 }
10f204e1 2161
9c74923d 2162 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
10f204e1 2163
e7cbe1bf 2164 $c->log_request_uploads($request);
fbcc39ad 2165}
2166
10f204e1 2167=head2 $c->log_response
fbcc39ad 2168
75b65816 2169Writes information about the response to the debug logs by calling
2170C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
fbcc39ad 2171
2172=cut
2173
75b65816 2174sub log_response {
2175 my $c = shift;
fbcc39ad 2176
75b65816 2177 return unless $c->debug;
fbcc39ad 2178
75b65816 2179 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2180 my $response = $dump->[1];
2181
2182 $c->log_response_status_line($response);
2183 $c->log_response_headers($response->headers);
2184}
2185
2186=head2 $c->log_response_status_line($response)
2187
2188Writes one line of information about the response to the debug logs. This includes:
10f204e1 2189
2190=over 4
2191
2192=item * Response status code
2193
3a4abdb3 2194=item * Content-Type header (if present)
2195
2196=item * Content-Length header (if present)
10f204e1 2197
2198=back
fbcc39ad 2199
2200=cut
2201
75b65816 2202sub log_response_status_line {
2203 my ($c, $response) = @_;
fbcc39ad 2204
697bab77 2205 $c->log->debug(
2206 sprintf(
2207 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2208 $response->status || 'unknown',
2209 $response->headers->header('Content-Type') || 'unknown',
2210 $response->headers->header('Content-Length') || 'unknown'
2211 )
2212 );
10f204e1 2213}
fbcc39ad 2214
75b65816 2215=head2 $c->log_response_headers($headers);
2216
8ad6fd58 2217Hook method which can be wrapped by plugins to log the response headers.
75b65816 2218No-op in the default implementation.
fbcc39ad 2219
2220=cut
2221
75b65816 2222sub log_response_headers {}
fbcc39ad 2223
10f204e1 2224=head2 $c->log_request_parameters( query => {}, body => {} )
2225
2226Logs request parameters to debug logs
2227
10f204e1 2228=cut
2229
2230sub log_request_parameters {
2231 my $c = shift;
2232 my %all_params = @_;
2233
2bf54936 2234 return unless $c->debug;
e7cbe1bf 2235
10f204e1 2236 my $column_width = Catalyst::Utils::term_width() - 44;
2237 foreach my $type (qw(query body)) {
2bf54936 2238 my $params = $all_params{$type};
2239 next if ! keys %$params;
10f204e1 2240 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
e7cbe1bf 2241 for my $key ( sort keys %$params ) {
2242 my $param = $params->{$key};
10f204e1 2243 my $value = defined($param) ? $param : '';
2244 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2245 }
2246 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2247 }
2248}
2249
2250=head2 $c->log_request_uploads
2251
2252Logs file uploads included in the request to the debug logs.
854e5dcd 2253The parameter name, filename, file type, and file size are all included in
10f204e1 2254the debug logs.
2255
2256=cut
fbcc39ad 2257
10f204e1 2258sub log_request_uploads {
2259 my $c = shift;
2bf54936 2260 my $request = shift;
e7cbe1bf 2261 return unless $c->debug;
2262 my $uploads = $request->uploads;
10f204e1 2263 if ( keys %$uploads ) {
8c113188 2264 my $t = Text::SimpleTable->new(
34d28dfd 2265 [ 12, 'Parameter' ],
2266 [ 26, 'Filename' ],
8c113188 2267 [ 18, 'Type' ],
2268 [ 9, 'Size' ]
2269 );
10f204e1 2270 for my $key ( sort keys %$uploads ) {
2271 my $upload = $uploads->{$key};
fbcc39ad 2272 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
8c113188 2273 $t->row( $key, $u->filename, $u->type, $u->size );
fbcc39ad 2274 }
2275 }
2276 $c->log->debug( "File Uploads are:\n" . $t->draw );
2277 }
2278}
2279
3a4abdb3 2280=head2 $c->log_request_headers($headers);
2281
2282Hook method which can be wrapped by plugins to log the request headers.
2283No-op in the default implementation.
2284
2285=cut
2286
2287sub log_request_headers {}
2288
10f204e1 2289=head2 $c->log_headers($type => $headers)
2290
e7cbe1bf 2291Logs L<HTTP::Headers> (either request or response) to the debug logs.
10f204e1 2292
2293=cut
2294
2295sub log_headers {
2296 my $c = shift;
2297 my $type = shift;
2298 my $headers = shift; # an HTTP::Headers instance
2299
e7cbe1bf 2300 return unless $c->debug;
10f204e1 2301
f0e9921a 2302 my $column_width = Catalyst::Utils::term_width() - 28;
2303 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
e7cbe1bf 2304 $headers->scan(
10f204e1 2305 sub {
2306 my ( $name, $value ) = @_;
2307 $t->row( $name, $value );
2308 }
2309 );
2310 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2311}
2312
10f204e1 2313
2314=head2 $c->prepare_read
2315
2316Prepares the input for reading.
2317
2318=cut
2319
2320sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2321
2322=head2 $c->prepare_request
2323
2324Prepares the engine request.
2325
2326=cut
2327
2328sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2329
2330=head2 $c->prepare_uploads
2331
2332Prepares uploads.
2333
2334=cut
2335
2336sub prepare_uploads {
2337 my $c = shift;
2338
2339 $c->engine->prepare_uploads( $c, @_ );
2340}
2341
b5ecfcf0 2342=head2 $c->prepare_write
fbcc39ad 2343
e7f1cf73 2344Prepares the output for writing.
fbcc39ad 2345
2346=cut
2347
2348sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2349
b5ecfcf0 2350=head2 $c->request_class
1f9cb7c1 2351
3f87d500 2352Returns or sets the request class. Defaults to L<Catalyst::Request>.
1f9cb7c1 2353
b5ecfcf0 2354=head2 $c->response_class
1f9cb7c1 2355
3f87d500 2356Returns or sets the response class. Defaults to L<Catalyst::Response>.
1f9cb7c1 2357
b5ecfcf0 2358=head2 $c->read( [$maxlength] )
fbcc39ad 2359
ae1e6b59 2360Reads a chunk of data from the request body. This method is designed to
2361be used in a while loop, reading C<$maxlength> bytes on every call.
2362C<$maxlength> defaults to the size of the request if not specified.
fbcc39ad 2363
4600a5a1 2364You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
ae1e6b59 2365directly.
fbcc39ad 2366
878b821c 2367Warning: If you use read(), Catalyst will not process the body,
2368so you will not be able to access POST parameters or file uploads via
2369$c->request. You must handle all body parsing yourself.
2370
fbcc39ad 2371=cut
2372
2373sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2374
b5ecfcf0 2375=head2 $c->run
fbcc39ad 2376
2377Starts the engine.
2378
2379=cut
2380
0c6352ff 2381sub run {
2382 my $app = shift;
2383 $app->engine_loader->needs_psgi_engine_compat_hack ?
2384 $app->engine->run($app, @_) :
2385 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2386}
fbcc39ad 2387
b5ecfcf0 2388=head2 $c->set_action( $action, $code, $namespace, $attrs )
fbcc39ad 2389
e7f1cf73 2390Sets an action in a given namespace.
fbcc39ad 2391
2392=cut
2393
2394sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2395
b5ecfcf0 2396=head2 $c->setup_actions($component)
fbcc39ad 2397
e7f1cf73 2398Sets up actions for a component.
fbcc39ad 2399
2400=cut
2401
2402sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2403
b5ecfcf0 2404=head2 $c->setup_components
fbcc39ad 2405
d261d153 2406This method is called internally to set up the application's components.
fbcc39ad 2407
d261d153 2408It finds modules by calling the L<locate_components> method, expands them to
2409package names with the L<expand_component_module> method, and then installs
2410each component into the application.
2411
2412The C<setup_components> config option is passed to both of the above methods.
fbcc39ad 2413
d261d153 2414Installation of each component is performed by the L<setup_component> method,
2415below.
2f381252 2416
fbcc39ad 2417=cut
2418
2419sub setup_components {
2420 my $class = shift;
2421
18de900e 2422 my $config = $class->config->{ setup_components };
62a6df80 2423
69c6b6cb 2424 my @comps = $class->locate_components($config);
b94b200c 2425 my %comps = map { $_ => 1 } @comps;
73e1183e 2426
8f6cebb2 2427 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
73e1183e 2428 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2429 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
8f6cebb2 2430 ) if $deprecatedcatalyst_component_names;
73e1183e 2431
b94b200c 2432 for my $component ( @comps ) {
dd91afb5 2433
2434 # We pass ignore_loaded here so that overlay files for (e.g.)
2435 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2436 # we know M::P::O found a file on disk so this is safe
2437
f5a4863c 2438 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
196f06d1 2439 }
2440
e7e4c469 2441 for my $component (@comps) {
5d02e790 2442 my $instance = $class->components->{ $component } = $class->setup_component($component);
2443 my @expanded_components = $instance->can('expand_modules')
2444 ? $instance->expand_modules( $component, $config )
2445 : $class->expand_component_module( $component, $config );
2446 for my $component (@expanded_components) {
05887b58 2447 next if $comps{$component};
e7e4c469 2448 $class->components->{ $component } = $class->setup_component($component);
fbcc39ad 2449 }
364d7324 2450 }
2451}
fbcc39ad 2452
d261d153 2453=head2 $c->locate_components( $setup_component_config )
2454
2455This method is meant to provide a list of component modules that should be
2456setup for the application. By default, it will use L<Module::Pluggable>.
2457
2458Specify a C<setup_components> config option to pass additional options directly
2459to L<Module::Pluggable>. To add additional search paths, specify a key named
2460C<search_extra> as an array reference. Items in the array beginning with C<::>
2461will have the application class name prepended to them.
2462
2463=cut
2464
2465sub locate_components {
2466 my $class = shift;
2467 my $config = shift;
2468
2469 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2470 my $extra = delete $config->{ search_extra } || [];
2471
2472 push @paths, @$extra;
2473
2474 my $locator = Module::Pluggable::Object->new(
2475 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2476 %$config
2477 );
2478
69c6b6cb 2479 # XXX think about ditching this sort entirely
2480 my @comps = sort { length $a <=> length $b } $locator->plugins;
d261d153 2481
2482 return @comps;
2483}
2484
2485=head2 $c->expand_component_module( $component, $setup_component_config )
2486
2487Components found by C<locate_components> will be passed to this method, which
2488is expected to return a list of component (package) names to be set up.
2489
d261d153 2490=cut
2491
2492sub expand_component_module {
2493 my ($class, $module) = @_;
05887b58 2494 return Devel::InnerPackage::list_packages( $module );
d261d153 2495}
2496
364d7324 2497=head2 $c->setup_component
fbcc39ad 2498
364d7324 2499=cut
fbcc39ad 2500
364d7324 2501sub setup_component {
2502 my( $class, $component ) = @_;
fbcc39ad 2503
364d7324 2504 unless ( $component->can( 'COMPONENT' ) ) {
2505 return $component;
2506 }
fbcc39ad 2507
364d7324 2508 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2509 my $config = $class->config->{ $suffix } || {};
8f6cebb2 2510 # Stash catalyst_component_name in the config here, so that custom COMPONENT
d2598ac8 2511 # methods also pass it. local to avoid pointlessly shitting in config
2512 # for the debug screen, as $component is already the key name.
8f6cebb2 2513 local $config->{catalyst_component_name} = $component;
fbcc39ad 2514
364d7324 2515 my $instance = eval { $component->COMPONENT( $class, $config ); };
fbcc39ad 2516
2517 if ( my $error = $@ ) {
fbcc39ad 2518 chomp $error;
fbcc39ad 2519 Catalyst::Exception->throw(
364d7324 2520 message => qq/Couldn't instantiate component "$component", "$error"/
2521 );
fbcc39ad 2522 }
2523
7490de2a 2524 unless (blessed $instance) {
2525 my $metaclass = Moose::Util::find_meta($component);
2526 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2527 my $component_method_from = $method_meta->associated_metaclass->name;
637fa644 2528 my $value = defined($instance) ? $instance : 'undef';
7490de2a 2529 Catalyst::Exception->throw(
2530 message =>
637fa644 2531 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
7490de2a 2532 );
2533 }
364d7324 2534 return $instance;
fbcc39ad 2535}
2536
b5ecfcf0 2537=head2 $c->setup_dispatcher
fbcc39ad 2538
ae1e6b59 2539Sets up dispatcher.
2540
fbcc39ad 2541=cut
2542
2543sub setup_dispatcher {
2544 my ( $class, $dispatcher ) = @_;
2545
2546 if ($dispatcher) {
2547 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2548 }
2549
cb69249e 2550 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2551 $dispatcher = 'Catalyst::Dispatcher::' . $env;
fbcc39ad 2552 }
2553
2554 unless ($dispatcher) {
cb0354c6 2555 $dispatcher = $class->dispatcher_class;
fbcc39ad 2556 }
2557
e63bdf38 2558 Class::MOP::load_class($dispatcher);
fbcc39ad 2559
2560 # dispatcher instance
2561 $class->dispatcher( $dispatcher->new );
2562}
2563
b5ecfcf0 2564=head2 $c->setup_engine
fbcc39ad 2565
ae1e6b59 2566Sets up engine.
2567
fbcc39ad 2568=cut
2569
1e5dad00 2570sub engine_class {
a8153308 2571 my ($class, $requested_engine) = @_;
2572
2573 if (!$class->engine_loader || $requested_engine) {
2574 $class->engine_loader(
2575 Catalyst::EngineLoader->new({
2576 application_name => $class,
2577 (defined $requested_engine
65420d46 2578 ? (catalyst_engine_class => $requested_engine) : ()),
a8153308 2579 }),
2580 );
2581 }
65420d46 2582
8ee06de7 2583 $class->engine_loader->catalyst_engine_class;
1e5dad00 2584}
2585
fbcc39ad 2586sub setup_engine {
a26a6adb 2587 my ($class, $requested_engine) = @_;
1085c936 2588
65420d46 2589 my $engine = do {
2590 my $loader = $class->engine_loader;
2591
2592 if (!$loader || $requested_engine) {
2593 $loader = Catalyst::EngineLoader->new({
2594 application_name => $class,
2595 (defined $requested_engine
2596 ? (requested_engine => $requested_engine) : ()),
2597 }),
2598
2599 $class->engine_loader($loader);
2600 }
2601
2602 $loader->catalyst_engine_class;
2603 };
1e5dad00 2604
2e1f92a3 2605 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2606 return if $class->loading_psgi_file;
2607
e63bdf38 2608 Class::MOP::load_class($engine);
0e7f5826 2609
532f0516 2610 if ($ENV{MOD_PERL}) {
1e5dad00 2611 my $apache = $class->engine_loader->auto;
ab4df9f8 2612
2613 my $meta = find_meta($class);
2614 my $was_immutable = $meta->is_immutable;
2615 my %immutable_options = $meta->immutable_options;
2616 $meta->make_mutable if $was_immutable;
2617
2618 $meta->add_method(handler => sub {
9fe15721 2619 my $r = shift;
1e5dad00 2620 my $psgi_app = $class->psgi_app;
2621 $apache->call_app($r, $psgi_app);
9fe15721 2622 });
ab4df9f8 2623
2624 $meta->make_immutable(%immutable_options) if $was_immutable;
532f0516 2625 }
2626
fbcc39ad 2627 $class->engine( $engine->new );
9fe15721 2628
fcffcb05 2629 return;
2630}
2631
8f076801 2632sub _finalized_psgi_app {
c8f4781e 2633 my ($app) = @_;
a0eec1fb 2634
2635 unless ($app->_psgi_app) {
8f076801 2636 my $psgi_app = $app->_setup_psgi_app;
a0eec1fb 2637 $app->_psgi_app($psgi_app);
2638 }
2639
2640 return $app->_psgi_app;
c8f4781e 2641}
2642
8f076801 2643sub _setup_psgi_app {
fcffcb05 2644 my ($app) = @_;
2645
1085c936 2646 for my $home (Path::Class::Dir->new($app->config->{home})) {
fcffcb05 2647 my $psgi_file = $home->file(
2648 Catalyst::Utils::appprefix($app) . '.psgi',
2649 );
2650
1085c936 2651 next unless -e $psgi_file;
2e1f92a3 2652
2653 # If $psgi_file calls ->setup_engine, it's doing so to load
2654 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2655 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2656 # anyway. So set a flag (ick) that tells setup_engine not to populate
2657 # $c->engine or do any other things we might regret.
2658
2659 $app->loading_psgi_file(1);
1085c936 2660 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2e1f92a3 2661 $app->loading_psgi_file(0);
1085c936 2662
2663 return $psgi_app
2664 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2665
1085c936 2666 warn <<"EOW";
2667Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2668
2669Its content has been ignored. Please consult the Catalyst::Upgrading
2670documentation on how to upgrade from Catalyst::Engine::PSGI.
2671EOW
fcffcb05 2672 }
2673
f05b654b 2674 return $app->apply_default_middlewares($app->psgi_app);
8f076801 2675}
2676
1316cc64 2677=head2 $c->apply_default_middlewares
2678
2679Adds the following L<Plack> middlewares to your application, since they are
2680useful and commonly needed:
2681
2682L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2683of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2684or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2685(if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2686applied since this middleware is smart enough to conditionally apply itself).
2687
2688Additionally if we detect we are using Nginx, we add a bit of custom middleware
2689to solve some problems with the way that server handles $ENV{PATH_INFO} and
2690$ENV{SCRIPT_NAME}
2691
2692=cut
2693
f05b654b 2694
2695sub apply_default_middlewares {
c72bc6eb 2696 my ($app, $psgi_app) = @_;
8f076801 2697
d89b863e 2698 $psgi_app = Plack::Middleware::Conditional->wrap(
c72bc6eb 2699 $psgi_app,
fcffcb05 2700 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2701 condition => sub {
2702 my ($env) = @_;
2703 return if $app->config->{ignore_frontend_proxy};
2704 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2705 || $app->config->{using_frontend_proxy};
2706 },
2707 );
d89b863e 2708
2709 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2710 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
d3670826 2711 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
d89b863e 2712
fb99321f 2713 # we're applying this unconditionally as the middleware itself already makes
2714 # sure it doesn't fuck things up if it's not running under one of the right
2715 # IIS versions
2716 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
a6fb59b7 2717
d89b863e 2718 return $psgi_app;
fcffcb05 2719}
2720
8f076801 2721=head2 $c->psgi_app
fcffcb05 2722
2723Returns a PSGI application code reference for the catalyst application
2724C<$c>. This is the bare application without any middlewares
8f076801 2725applied. C<${myapp}.psgi> is not taken into account.
2726
2727This is what you want to be using to retrieve the PSGI application code
2728reference of your Catalyst application for use in F<.psgi> files.
fcffcb05 2729
2730=cut
2731
8f076801 2732sub psgi_app {
fcffcb05 2733 my ($app) = @_;
2734 return $app->engine->build_psgi_app($app);
fbcc39ad 2735}
2736
b5ecfcf0 2737=head2 $c->setup_home
fbcc39ad 2738
ae1e6b59 2739Sets up the home directory.
2740
fbcc39ad 2741=cut
2742
2743sub setup_home {
2744 my ( $class, $home ) = @_;
2745
cb69249e 2746 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2747 $home = $env;
fbcc39ad 2748 }
2749
b6d4ee6e 2750 $home ||= Catalyst::Utils::home($class);
fbcc39ad 2751
2752 if ($home) {
e63bdf38 2753 #I remember recently being scolded for assigning config values like this
fbcc39ad 2754 $class->config->{home} ||= $home;
a738ab68 2755 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
fbcc39ad 2756 }
2757}
2758
b5ecfcf0 2759=head2 $c->setup_log
fbcc39ad 2760
0fa676a7 2761Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2762passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2763log to.
62a6df80 2764
0fa676a7 2765This method also installs a C<debug> method that returns a true value into the
2766catalyst subclass if the "debug" level is passed in the comma-delimited list,