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