Apply patch from RT#48623 to fix headers in Engine::HTTP
[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
73664287 1167=head2 $c->uri_for( $path, @args?, \%query_values? )
fbcc39ad 1168
ee8963de 1169=head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
9df7c5d9 1170
ee8963de 1171Constructs an absolute L<URI> object based on the application root, the
1172provided path, and the additional arguments and query parameters provided.
1173When used as a string, provides a textual URI.
1174
1175If the first argument is a string, it is taken as a public URI path relative
1176to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1177relative to the application root (if it does). It is then merged with
1178C<< $c->request->base >>; any C<@args> are appended as additional path
1179components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1180
1181If the first argument is a L<Catalyst::Action> it represents an action which
1182will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1183optional C<\@captures> argument (an arrayref) allows passing the captured
1184variables that are needed to fill in the paths of Chained and Regex actions;
1185once the path is resolved, C<uri_for> continues as though a path was
1186provided, appending any arguments or parameters and creating an absolute
1187URI.
1188
1189The captures for the current request can be found in
1190C<< $c->request->captures >>, and actions can be resolved using
1191C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1192path, use C<< $c->uri_for_action >> instead.
1193
1194 # Equivalent to $c->req->uri
1195 $c->uri_for($c->action, $c->req->captures,
1196 @{ $c->req->args }, $c->req->params);
62a6df80 1197
9df7c5d9 1198 # For the Foo action in the Bar controller
ee8963de 1199 $c->uri_for($c->controller('Bar')->action_for('Foo'));
9df7c5d9 1200
ee8963de 1201 # Path to a static resource
1202 $c->uri_for('/static/images/logo.png');
d5e3d528 1203
4cf1dd00 1204=cut
1205
fbcc39ad 1206sub uri_for {
00e6a2b7 1207 my ( $c, $path, @args ) = @_;
00e6a2b7 1208
7069eab5 1209 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1210 $path = $path->path_prefix;
1211 $path =~ s{/+\z}{};
1212 $path .= '/';
1213 }
1214
7e95ba12 1215 if ( blessed($path) ) { # action object
ea0e58d9 1216 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1217 ? shift(@args)
1218 : [] );
aa7e913e 1219 my $action = $path;
1220 $path = $c->dispatcher->uri_for_action($action, $captures);
1221 if (not defined $path) {
1222 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1223 if $c->debug;
1224 return undef;
1225 }
81e75875 1226 $path = '/' if $path eq '';
ea0e58d9 1227 }
1228
51674a63 1229 undef($path) if (defined $path && $path eq '');
00e6a2b7 1230
97b58e17 1231 my $params =
1232 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
8327e2e2 1233
cbb93105 1234 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
f9155483 1235 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
51674a63 1236
1237 unshift(@args, $path);
1238
1239 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1240 my $namespace = $c->namespace;
1241 if (defined $path) { # cheesy hack to handle path '../foo'
1242 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
6601f2ad 1243 }
51674a63 1244 unshift(@args, $namespace || '');
1245 }
62a6df80 1246
189e2a51 1247 # join args with '/', or a blank string
51674a63 1248 my $args = join('/', grep { defined($_) } @args);
1249 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
7a2295bc 1250 $args =~ s!^/+!!;
51674a63 1251 my $base = $c->req->base;
1252 my $class = ref($base);
1253 $base =~ s{(?<!/)$}{/};
1254
1255 my $query = '';
1256
1257 if (my @keys = keys %$params) {
1258 # somewhat lifted from URI::_query's query_form
1259 $query = '?'.join('&', map {
2f381252 1260 my $val = $params->{$_};
51674a63 1261 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1262 s/ /+/g;
1263 my $key = $_;
51674a63 1264 $val = '' unless defined $val;
1265 (map {
1f851263 1266 my $param = "$_";
1267 utf8::encode( $param ) if utf8::is_utf8($param);
51674a63 1268 # using the URI::Escape pattern here so utf8 chars survive
1f851263 1269 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1270 $param =~ s/ /+/g;
1271 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
51674a63 1272 } @keys);
1273 }
1274
1275 my $res = bless(\"${base}${args}${query}", $class);
d3e7a648 1276 $res;
fbcc39ad 1277}
1278
833b385e 1279=head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1280
1281=head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1282
1283=over
1284
1285=item $path
1286
1287A private path to the Catalyst action you want to create a URI for.
1288
1289This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1290>> and passing the resulting C<$action> and the remaining arguments to C<<
1291$c->uri_for >>.
1292
1293You can also pass in a Catalyst::Action object, in which case it is passed to
1294C<< $c->uri_for >>.
1295
1296=back
1297
1298=cut
1299
1300sub uri_for_action {
1301 my ( $c, $path, @args ) = @_;
62a6df80 1302 my $action = blessed($path)
1303 ? $path
833b385e 1304 : $c->dispatcher->get_action_by_path($path);
4ac0b9cb 1305 unless (defined $action) {
1306 croak "Can't find action for path '$path'";
1307 }
833b385e 1308 return $c->uri_for( $action, @args );
1309}
1310
b5ecfcf0 1311=head2 $c->welcome_message
ab2374d3 1312
1313Returns the Catalyst welcome HTML page.
1314
1315=cut
1316
1317sub welcome_message {
bf1f2c60 1318 my $c = shift;
1319 my $name = $c->config->{name};
1320 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1321 my $prefix = Catalyst::Utils::appprefix( ref $c );
80cdbbff 1322 $c->response->content_type('text/html; charset=utf-8');
ab2374d3 1323 return <<"EOF";
80cdbbff 1324<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1325 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1326<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
ab2374d3 1327 <head>
85d9fce6 1328 <meta http-equiv="Content-Language" content="en" />
1329 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
ab2374d3 1330 <title>$name on Catalyst $VERSION</title>
1331 <style type="text/css">
1332 body {
ab2374d3 1333 color: #000;
1334 background-color: #eee;
1335 }
1336 div#content {
1337 width: 640px;
80cdbbff 1338 margin-left: auto;
1339 margin-right: auto;
ab2374d3 1340 margin-top: 10px;
1341 margin-bottom: 10px;
1342 text-align: left;
1343 background-color: #ccc;
1344 border: 1px solid #aaa;
ab2374d3 1345 }
d84c4dab 1346 p, h1, h2 {
ab2374d3 1347 margin-left: 20px;
1348 margin-right: 20px;
16215972 1349 font-family: verdana, tahoma, sans-serif;
ab2374d3 1350 }
d84c4dab 1351 a {
1352 font-family: verdana, tahoma, sans-serif;
1353 }
d114e033 1354 :link, :visited {
1355 text-decoration: none;
1356 color: #b00;
1357 border-bottom: 1px dotted #bbb;
1358 }
1359 :link:hover, :visited:hover {
d114e033 1360 color: #555;
1361 }
ab2374d3 1362 div#topbar {
1363 margin: 0px;
1364 }
3e82a295 1365 pre {
3e82a295 1366 margin: 10px;
1367 padding: 8px;
1368 }
ab2374d3 1369 div#answers {
1370 padding: 8px;
1371 margin: 10px;
d114e033 1372 background-color: #fff;
ab2374d3 1373 border: 1px solid #aaa;
ab2374d3 1374 }
1375 h1 {
33108eaf 1376 font-size: 0.9em;
1377 font-weight: normal;
ab2374d3 1378 text-align: center;
1379 }
1380 h2 {
1381 font-size: 1.0em;
1382 }
1383 p {
1384 font-size: 0.9em;
1385 }
ae7c5252 1386 p img {
1387 float: right;
1388 margin-left: 10px;
1389 }
9619f23c 1390 span#appname {
1391 font-weight: bold;
33108eaf 1392 font-size: 1.6em;
ab2374d3 1393 }
1394 </style>
1395 </head>
1396 <body>
1397 <div id="content">
1398 <div id="topbar">
9619f23c 1399 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
d84c4dab 1400 $VERSION</h1>
ab2374d3 1401 </div>
1402 <div id="answers">
ae7c5252 1403 <p>
80cdbbff 1404 <img src="$logo" alt="Catalyst Logo" />
ae7c5252 1405 </p>
596aaffe 1406 <p>Welcome to the world of Catalyst.
f92fd545 1407 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1408 framework will make web development something you had
60dd6e1d 1409 never expected it to be: Fun, rewarding, and quick.</p>
ab2374d3 1410 <h2>What to do now?</h2>
4b8cb778 1411 <p>That really depends on what <b>you</b> want to do.
ab2374d3 1412 We do, however, provide you with a few starting points.</p>
1413 <p>If you want to jump right into web development with Catalyst
2f381252 1414 you might want to start with a tutorial.</p>
b607f8a0 1415<pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
596aaffe 1416</pre>
1417<p>Afterwards you can go on to check out a more complete look at our features.</p>
1418<pre>
b607f8a0 1419<code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1420<!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1421</code></pre>
ab2374d3 1422 <h2>What to do next?</h2>
f5681c92 1423 <p>Next it's time to write an actual application. Use the
80cdbbff 1424 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&amp;mode=all">controllers</a>,
60dd6e1d 1425 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&amp;mode=all">models</a>, and
1426 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&amp;mode=all">views</a>;
bf1f2c60 1427 they can save you a lot of work.</p>
1428 <pre><code>script/${prefix}_create.pl -help</code></pre>
1429 <p>Also, be sure to check out the vast and growing
802bf2cb 1430 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
bf1f2c60 1431 you are likely to find what you need there.
f5681c92 1432 </p>
1433
82245cc4 1434 <h2>Need help?</h2>
f5681c92 1435 <p>Catalyst has a very active community. Here are the main places to
1436 get in touch with us.</p>
16215972 1437 <ul>
1438 <li>
2b9a7d76 1439 <a href="http://dev.catalyst.perl.org">Wiki</a>
16215972 1440 </li>
1441 <li>
6d4c3368 1442 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
16215972 1443 </li>
1444 <li>
4eaf7c88 1445 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
16215972 1446 </li>
1447 </ul>
ab2374d3 1448 <h2>In conclusion</h2>
62a6df80 1449 <p>The Catalyst team hopes you will enjoy using Catalyst as much
f5681c92 1450 as we enjoyed making it. Please contact us if you have ideas
1451 for improvement or other feedback.</p>
ab2374d3 1452 </div>
1453 </div>
1454 </body>
1455</html>
1456EOF
1457}
1458
fbcc39ad 1459=head1 INTERNAL METHODS
1460
ae1e6b59 1461These methods are not meant to be used by end users.
1462
b5ecfcf0 1463=head2 $c->components
fbcc39ad 1464
e7f1cf73 1465Returns a hash of components.
fbcc39ad 1466
b5ecfcf0 1467=head2 $c->context_class
1f9cb7c1 1468
e7f1cf73 1469Returns or sets the context class.
1f9cb7c1 1470
b5ecfcf0 1471=head2 $c->counter
fbcc39ad 1472
ae1e6b59 1473Returns a hashref containing coderefs and execution counts (needed for
1474deep recursion detection).
fbcc39ad 1475
b5ecfcf0 1476=head2 $c->depth
fbcc39ad 1477
e7f1cf73 1478Returns the number of actions on the current internal execution stack.
fbcc39ad 1479
b5ecfcf0 1480=head2 $c->dispatch
fbcc39ad 1481
e7f1cf73 1482Dispatches a request to actions.
fbcc39ad 1483
1484=cut
1485
1486sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1487
b5ecfcf0 1488=head2 $c->dispatcher_class
1f9cb7c1 1489
e7f1cf73 1490Returns or sets the dispatcher class.
1f9cb7c1 1491
b5ecfcf0 1492=head2 $c->dump_these
7f92deef 1493
ae1e6b59 1494Returns a list of 2-element array references (name, structure) pairs
1495that will be dumped on the error page in debug mode.
7f92deef 1496
1497=cut
1498
1499sub dump_these {
1500 my $c = shift;
62a6df80 1501 [ Request => $c->req ],
1502 [ Response => $c->res ],
052a2d89 1503 [ Stash => $c->stash ],
1504 [ Config => $c->config ];
7f92deef 1505}
1506
b5ecfcf0 1507=head2 $c->engine_class
1f9cb7c1 1508
e7f1cf73 1509Returns or sets the engine class.
1f9cb7c1 1510
b5ecfcf0 1511=head2 $c->execute( $class, $coderef )
fbcc39ad 1512
0ef52a96 1513Execute a coderef in given class and catch exceptions. Errors are available
1514via $c->error.
fbcc39ad 1515
1516=cut
1517
1518sub execute {
1519 my ( $c, $class, $code ) = @_;
858828dd 1520 $class = $c->component($class) || $class;
fbcc39ad 1521 $c->state(0);
a0eca838 1522
197bd788 1523 if ( $c->depth >= $RECURSION ) {
f3414019 1524 my $action = $code->reverse();
91d08727 1525 $action = "/$action" unless $action =~ /->/;
f3414019 1526 my $error = qq/Deep recursion detected calling "${action}"/;
1627551a 1527 $c->log->error($error);
1528 $c->error($error);
1529 $c->state(0);
1530 return $c->state;
1531 }
1532
dc5f035e 1533 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
22247e54 1534
8767c5a3 1535 push( @{ $c->stack }, $code );
62a6df80 1536
6f3df815 1537 no warnings 'recursion';
f3414019 1538 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
22247e54 1539
dc5f035e 1540 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
62a6df80 1541
a6724a82 1542 my $last = pop( @{ $c->stack } );
fbcc39ad 1543
1544 if ( my $error = $@ ) {
79f5d571 1545 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
f87b7c21 1546 $error->rethrow if $c->depth > 1;
2f381252 1547 }
79f5d571 1548 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
f87b7c21 1549 $error->rethrow if $c->depth > 0;
55424863 1550 }
fbcc39ad 1551 else {
1552 unless ( ref $error ) {
91d08727 1553 no warnings 'uninitialized';
fbcc39ad 1554 chomp $error;
f59def82 1555 my $class = $last->class;
1556 my $name = $last->name;
1557 $error = qq/Caught exception in $class->$name "$error"/;
fbcc39ad 1558 }
fbcc39ad 1559 $c->error($error);
1560 $c->state(0);
1561 }
1562 }
1563 return $c->state;
1564}
1565
7a7d7af5 1566sub _stats_start_execute {
1567 my ( $c, $code ) = @_;
1568
a6724a82 1569 return if ( ( $code->name =~ /^_.*/ )
1570 && ( !$c->config->{show_internal_actions} ) );
7a7d7af5 1571
f3414019 1572 my $action_name = $code->reverse();
1573 $c->counter->{$action_name}++;
7a7d7af5 1574
f3414019 1575 my $action = $action_name;
a6724a82 1576 $action = "/$action" unless $action =~ /->/;
1577
7a7d7af5 1578 # determine if the call was the result of a forward
1579 # this is done by walking up the call stack and looking for a calling
1580 # sub of Catalyst::forward before the eval
1581 my $callsub = q{};
1582 for my $index ( 2 .. 11 ) {
1583 last
1584 if ( ( caller($index) )[0] eq 'Catalyst'
1585 && ( caller($index) )[3] eq '(eval)' );
1586
1587 if ( ( caller($index) )[3] =~ /forward$/ ) {
1588 $callsub = ( caller($index) )[3];
1589 $action = "-> $action";
1590 last;
1591 }
1592 }
1593
f3414019 1594 my $uid = $action_name . $c->counter->{$action_name};
74efc144 1595
a6724a82 1596 # is this a root-level call or a forwarded call?
1597 if ( $callsub =~ /forward$/ ) {
1598
1599 # forward, locate the caller
1600 if ( my $parent = $c->stack->[-1] ) {
69d8f33c 1601 $c->stats->profile(
62a6df80 1602 begin => $action,
69d8f33c 1603 parent => "$parent" . $c->counter->{"$parent"},
1604 uid => $uid,
1605 );
7a7d7af5 1606 }
1607 else {
1608
a6724a82 1609 # forward with no caller may come from a plugin
69d8f33c 1610 $c->stats->profile(
1611 begin => $action,
1612 uid => $uid,
1613 );
7a7d7af5 1614 }
1615 }
a6724a82 1616 else {
62a6df80 1617
a6724a82 1618 # root-level call
69d8f33c 1619 $c->stats->profile(
1620 begin => $action,
1621 uid => $uid,
1622 );
a6724a82 1623 }
dc5f035e 1624 return $action;
7a7d7af5 1625
7a7d7af5 1626}
1627
1628sub _stats_finish_execute {
1629 my ( $c, $info ) = @_;
69d8f33c 1630 $c->stats->profile( end => $info );
7a7d7af5 1631}
1632
b5ecfcf0 1633=head2 $c->finalize
fbcc39ad 1634
e7f1cf73 1635Finalizes the request.
fbcc39ad 1636
1637=cut
1638
1639sub finalize {
1640 my $c = shift;
1641
369c09bc 1642 for my $error ( @{ $c->error } ) {
1643 $c->log->error($error);
1644 }
1645
5050d7a7 1646 # Allow engine to handle finalize flow (for POE)
e63bdf38 1647 my $engine = $c->engine;
1648 if ( my $code = $engine->can('finalize') ) {
1649 $engine->$code($c);
fbcc39ad 1650 }
5050d7a7 1651 else {
fbcc39ad 1652
5050d7a7 1653 $c->finalize_uploads;
fbcc39ad 1654
5050d7a7 1655 # Error
1656 if ( $#{ $c->error } >= 0 ) {
1657 $c->finalize_error;
1658 }
1659
1660 $c->finalize_headers;
fbcc39ad 1661
5050d7a7 1662 # HEAD request
1663 if ( $c->request->method eq 'HEAD' ) {
1664 $c->response->body('');
1665 }
1666
1667 $c->finalize_body;
1668 }
62a6df80 1669
1670 if ($c->use_stats) {
596677b6 1671 my $elapsed = sprintf '%f', $c->stats->elapsed;
12bf12c0 1672 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
908e3d9e 1673 $c->log->info(
62a6df80 1674 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
908e3d9e 1675 }
fbcc39ad 1676
1677 return $c->response->status;
1678}
1679
b5ecfcf0 1680=head2 $c->finalize_body
fbcc39ad 1681
e7f1cf73 1682Finalizes body.
fbcc39ad 1683
1684=cut
1685
1686sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1687
b5ecfcf0 1688=head2 $c->finalize_cookies
fbcc39ad 1689
e7f1cf73 1690Finalizes cookies.
fbcc39ad 1691
1692=cut
1693
147821ea 1694sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
fbcc39ad 1695
b5ecfcf0 1696=head2 $c->finalize_error
fbcc39ad 1697
e7f1cf73 1698Finalizes error.
fbcc39ad 1699
1700=cut
1701
1702sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1703
b5ecfcf0 1704=head2 $c->finalize_headers
fbcc39ad 1705
e7f1cf73 1706Finalizes headers.
fbcc39ad 1707
1708=cut
1709
1710sub finalize_headers {
1711 my $c = shift;
1712
e63bdf38 1713 my $response = $c->response; #accessor calls can add up?
1714
fbcc39ad 1715 # Check if we already finalized headers
6680c772 1716 return if $response->finalized_headers;
fbcc39ad 1717
1718 # Handle redirects
e63bdf38 1719 if ( my $location = $response->redirect ) {
fbcc39ad 1720 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
e63bdf38 1721 $response->header( Location => $location );
a7caa492 1722
02570318 1723 if ( !$response->has_body ) {
39655cdc 1724 # Add a default body if none is already present
e63bdf38 1725 $response->body(
e422816e 1726 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
39655cdc 1727 );
1728 }
fbcc39ad 1729 }
1730
1731 # Content-Length
e63bdf38 1732 if ( $response->body && !$response->content_length ) {
775878ac 1733
8f62c91a 1734 # get the length from a filehandle
e63bdf38 1735 if ( blessed( $response->body ) && $response->body->can('read') )
197bd788 1736 {
e63bdf38 1737 my $stat = stat $response->body;
3b6a1db1 1738 if ( $stat && $stat->size > 0 ) {
e63bdf38 1739 $response->content_length( $stat->size );
8f62c91a 1740 }
1741 else {
775878ac 1742 $c->log->warn('Serving filehandle without a content-length');
8f62c91a 1743 }
1744 }
1745 else {
b5d7a61f 1746 # everything should be bytes at this point, but just in case
e63bdf38 1747 $response->content_length( bytes::length( $response->body ) );
8f62c91a 1748 }
fbcc39ad 1749 }
1750
1751 # Errors
e63bdf38 1752 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1753 $response->headers->remove_header("Content-Length");
1754 $response->body('');
fbcc39ad 1755 }
1756
1757 $c->finalize_cookies;
1758
1759 $c->engine->finalize_headers( $c, @_ );
1760
1761 # Done
6680c772 1762 $response->finalized_headers(1);
fbcc39ad 1763}
1764
b5ecfcf0 1765=head2 $c->finalize_output
fbcc39ad 1766
1767An alias for finalize_body.
1768
b5ecfcf0 1769=head2 $c->finalize_read
fbcc39ad 1770
e7f1cf73 1771Finalizes the input after reading is complete.
fbcc39ad 1772
1773=cut
1774
1775sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1776
b5ecfcf0 1777=head2 $c->finalize_uploads
fbcc39ad 1778
ae1e6b59 1779Finalizes uploads. Cleans up any temporary files.
fbcc39ad 1780
1781=cut
1782
1783sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1784
b5ecfcf0 1785=head2 $c->get_action( $action, $namespace )
fbcc39ad 1786
e7f1cf73 1787Gets an action in a given namespace.
fbcc39ad 1788
1789=cut
1790
684d10ed 1791sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
fbcc39ad 1792
b5ecfcf0 1793=head2 $c->get_actions( $action, $namespace )
a9dc674c 1794
ae1e6b59 1795Gets all actions of a given name in a namespace and all parent
1796namespaces.
a9dc674c 1797
1798=cut
1799
1800sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1801
f7b672ef 1802=head2 $c->handle_request( $class, @arguments )
fbcc39ad 1803
e7f1cf73 1804Called to handle each HTTP request.
fbcc39ad 1805
1806=cut
1807
1808sub handle_request {
1809 my ( $class, @arguments ) = @_;
1810
1811 # Always expect worst case!
1812 my $status = -1;
1813 eval {
dea1884f 1814 if ($class->debug) {
908e3d9e 1815 my $secs = time - $START || 1;
1816 my $av = sprintf '%.3f', $COUNT / $secs;
1817 my $time = localtime time;
1818 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
dea1884f 1819 }
908e3d9e 1820
1821 my $c = $class->prepare(@arguments);
1822 $c->dispatch;
62a6df80 1823 $status = $c->finalize;
fbcc39ad 1824 };
1825
1826 if ( my $error = $@ ) {
1827 chomp $error;
1828 $class->log->error(qq/Caught exception in engine "$error"/);
1829 }
1830
1831 $COUNT++;
62a6df80 1832
6680c772 1833 if(my $coderef = $class->log->can('_flush')){
1834 $class->log->$coderef();
1835 }
fbcc39ad 1836 return $status;
1837}
1838
b5ecfcf0 1839=head2 $c->prepare( @arguments )
fbcc39ad 1840
ae1e6b59 1841Creates a Catalyst context from an engine-specific request (Apache, CGI,
1842etc.).
fbcc39ad 1843
1844=cut
1845
1846sub prepare {
1847 my ( $class, @arguments ) = @_;
1848
6680c772 1849 # XXX
1850 # After the app/ctxt split, this should become an attribute based on something passed
1851 # into the application.
3cec521a 1852 $class->context_class( ref $class || $class ) unless $class->context_class;
62a6df80 1853
6680c772 1854 my $c = $class->context_class->new({});
1855
1856 # For on-demand data
1857 $c->request->_context($c);
1858 $c->response->_context($c);
fbcc39ad 1859
b6d4ee6e 1860 #surely this is not the most efficient way to do things...
dc5f035e 1861 $c->stats($class->stats_class->new)->enable($c->use_stats);
908e3d9e 1862 if ( $c->debug ) {
62a6df80 1863 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
908e3d9e 1864 }
1865
e63bdf38 1866 #XXX reuse coderef from can
5050d7a7 1867 # Allow engine to direct the prepare flow (for POE)
1868 if ( $c->engine->can('prepare') ) {
1869 $c->engine->prepare( $c, @arguments );
1870 }
1871 else {
1872 $c->prepare_request(@arguments);
1873 $c->prepare_connection;
1874 $c->prepare_query_parameters;
1875 $c->prepare_headers;
1876 $c->prepare_cookies;
1877 $c->prepare_path;
1878
878b821c 1879 # Prepare the body for reading, either by prepare_body
1880 # or the user, if they are using $c->read
1881 $c->prepare_read;
62a6df80 1882
878b821c 1883 # Parse the body unless the user wants it on-demand
1884 unless ( $c->config->{parse_on_demand} ) {
1885 $c->prepare_body;
1886 }
5050d7a7 1887 }
fbcc39ad 1888
fbcc39ad 1889 my $method = $c->req->method || '';
2f381252 1890 my $path = $c->req->path;
1891 $path = '/' unless length $path;
fbcc39ad 1892 my $address = $c->req->address || '';
1893
e3a13771 1894 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
fbcc39ad 1895 if $c->debug;
1896
e3a13771 1897 $c->prepare_action;
1898
fbcc39ad 1899 return $c;
1900}
1901
b5ecfcf0 1902=head2 $c->prepare_action
fbcc39ad 1903
b4b01a8a 1904Prepares action. See L<Catalyst::Dispatcher>.
fbcc39ad 1905
1906=cut
1907
1908sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1909
b5ecfcf0 1910=head2 $c->prepare_body
fbcc39ad 1911
e7f1cf73 1912Prepares message body.
fbcc39ad 1913
1914=cut
1915
1916sub prepare_body {
1917 my $c = shift;
1918
0f56bbcf 1919 return if $c->request->_has_body;
fbcc39ad 1920
1921 # Initialize on-demand data
1922 $c->engine->prepare_body( $c, @_ );
1923 $c->prepare_parameters;
1924 $c->prepare_uploads;
1925
0584323b 1926 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1927 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1928 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1929 my $param = $c->req->body_parameters->{$key};
1930 my $value = defined($param) ? $param : '';
1931 $t->row( $key,
1932 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1933 }
1934 $c->log->debug( "Body Parameters are:\n" . $t->draw );
fbcc39ad 1935 }
1936}
1937
b5ecfcf0 1938=head2 $c->prepare_body_chunk( $chunk )
4bd82c41 1939
e7f1cf73 1940Prepares a chunk of data before sending it to L<HTTP::Body>.
4bd82c41 1941
b4b01a8a 1942See L<Catalyst::Engine>.
1943
4bd82c41 1944=cut
1945
4f5ebacd 1946sub prepare_body_chunk {
1947 my $c = shift;
4bd82c41 1948 $c->engine->prepare_body_chunk( $c, @_ );
1949}
1950
b5ecfcf0 1951=head2 $c->prepare_body_parameters
fbcc39ad 1952
e7f1cf73 1953Prepares body parameters.
fbcc39ad 1954
1955=cut
1956
1957sub prepare_body_parameters {
1958 my $c = shift;
1959 $c->engine->prepare_body_parameters( $c, @_ );
1960}
1961
b5ecfcf0 1962=head2 $c->prepare_connection
fbcc39ad 1963
e7f1cf73 1964Prepares connection.
fbcc39ad 1965
1966=cut
1967
1968sub prepare_connection {
1969 my $c = shift;
1970 $c->engine->prepare_connection( $c, @_ );
1971}
1972
b5ecfcf0 1973=head2 $c->prepare_cookies
fbcc39ad 1974
e7f1cf73 1975Prepares cookies.
fbcc39ad 1976
1977=cut
1978
1979sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1980
b5ecfcf0 1981=head2 $c->prepare_headers
fbcc39ad 1982
e7f1cf73 1983Prepares headers.
fbcc39ad 1984
1985=cut
1986
1987sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1988
b5ecfcf0 1989=head2 $c->prepare_parameters
fbcc39ad 1990
e7f1cf73 1991Prepares parameters.
fbcc39ad 1992
1993=cut
1994
1995sub prepare_parameters {
1996 my $c = shift;
1997 $c->prepare_body_parameters;
1998 $c->engine->prepare_parameters( $c, @_ );
1999}
2000
b5ecfcf0 2001=head2 $c->prepare_path
fbcc39ad 2002
e7f1cf73 2003Prepares path and base.
fbcc39ad 2004
2005=cut
2006
2007sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2008
b5ecfcf0 2009=head2 $c->prepare_query_parameters
fbcc39ad 2010
e7f1cf73 2011Prepares query parameters.
fbcc39ad 2012
2013=cut
2014
2015sub prepare_query_parameters {
2016 my $c = shift;
2017
2018 $c->engine->prepare_query_parameters( $c, @_ );
2019
0584323b 2020 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2021 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2022 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2023 my $param = $c->req->query_parameters->{$key};
fbcc39ad 2024 my $value = defined($param) ? $param : '';
8c113188 2025 $t->row( $key,
fbcc39ad 2026 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2027 }
0584323b 2028 $c->log->debug( "Query Parameters are:\n" . $t->draw );
fbcc39ad 2029 }
2030}
2031
b5ecfcf0 2032=head2 $c->prepare_read
fbcc39ad 2033
e7f1cf73 2034Prepares the input for reading.
fbcc39ad 2035
2036=cut
2037
2038sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2039
b5ecfcf0 2040=head2 $c->prepare_request
fbcc39ad 2041
e7f1cf73 2042Prepares the engine request.
fbcc39ad 2043
2044=cut
2045
2046sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2047
b5ecfcf0 2048=head2 $c->prepare_uploads
fbcc39ad 2049
e7f1cf73 2050Prepares uploads.
fbcc39ad 2051
2052=cut
2053
2054sub prepare_uploads {
2055 my $c = shift;
2056
2057 $c->engine->prepare_uploads( $c, @_ );
2058
2059 if ( $c->debug && keys %{ $c->request->uploads } ) {
8c113188 2060 my $t = Text::SimpleTable->new(
34d28dfd 2061 [ 12, 'Parameter' ],
2062 [ 26, 'Filename' ],
8c113188 2063 [ 18, 'Type' ],
2064 [ 9, 'Size' ]
2065 );
fbcc39ad 2066 for my $key ( sort keys %{ $c->request->uploads } ) {
2067 my $upload = $c->request->uploads->{$key};
2068 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
8c113188 2069 $t->row( $key, $u->filename, $u->type, $u->size );
fbcc39ad 2070 }
2071 }
2072 $c->log->debug( "File Uploads are:\n" . $t->draw );
2073 }
2074}
2075
b5ecfcf0 2076=head2 $c->prepare_write
fbcc39ad 2077
e7f1cf73 2078Prepares the output for writing.
fbcc39ad 2079
2080=cut
2081
2082sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2083
b5ecfcf0 2084=head2 $c->request_class
1f9cb7c1 2085
e7f1cf73 2086Returns or sets the request class.
1f9cb7c1 2087
b5ecfcf0 2088=head2 $c->response_class
1f9cb7c1 2089
e7f1cf73 2090Returns or sets the response class.
1f9cb7c1 2091
b5ecfcf0 2092=head2 $c->read( [$maxlength] )
fbcc39ad 2093
ae1e6b59 2094Reads a chunk of data from the request body. This method is designed to
2095be used in a while loop, reading C<$maxlength> bytes on every call.
2096C<$maxlength> defaults to the size of the request if not specified.
fbcc39ad 2097
4600a5a1 2098You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
ae1e6b59 2099directly.
fbcc39ad 2100
878b821c 2101Warning: If you use read(), Catalyst will not process the body,
2102so you will not be able to access POST parameters or file uploads via
2103$c->request. You must handle all body parsing yourself.
2104
fbcc39ad 2105=cut
2106
2107sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2108
b5ecfcf0 2109=head2 $c->run
fbcc39ad 2110
2111Starts the engine.
2112
2113=cut
2114
2115sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2116
b5ecfcf0 2117=head2 $c->set_action( $action, $code, $namespace, $attrs )
fbcc39ad 2118
e7f1cf73 2119Sets an action in a given namespace.
fbcc39ad 2120
2121=cut
2122
2123sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2124
b5ecfcf0 2125=head2 $c->setup_actions($component)
fbcc39ad 2126
e7f1cf73 2127Sets up actions for a component.
fbcc39ad 2128
2129=cut
2130
2131sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2132
b5ecfcf0 2133=head2 $c->setup_components
fbcc39ad 2134
86418559 2135Sets up components. Specify a C<setup_components> config option to pass
2136additional options directly to L<Module::Pluggable>. To add additional
2137search paths, specify a key named C<search_extra> as an array
2138reference. Items in the array beginning with C<::> will have the
18de900e 2139application class name prepended to them.
fbcc39ad 2140
62a6df80 2141All components found will also have any
18a9655c 2142L<inner packages|Devel::InnerPackage> loaded and set up as components.
2f381252 2143Note, that modules which are B<not> an I<inner package> of the main
2144file namespace loaded will not be instantiated as components.
2145
fbcc39ad 2146=cut
2147
2148sub setup_components {
2149 my $class = shift;
2150
18de900e 2151 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2152 my $config = $class->config->{ setup_components };
2153 my $extra = delete $config->{ search_extra } || [];
62a6df80 2154
18de900e 2155 push @paths, @$extra;
62a6df80 2156
364d7324 2157 my $locator = Module::Pluggable::Object->new(
18de900e 2158 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2159 %$config
364d7324 2160 );
b94b200c 2161
2162 my @comps = sort { length $a <=> length $b } $locator->plugins;
2163 my %comps = map { $_ => 1 } @comps;
73e1183e 2164
2165 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2166 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2167 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
19a24dbb 2168 ) if $deprecated_component_names;
73e1183e 2169
b94b200c 2170 for my $component ( @comps ) {
dd91afb5 2171
2172 # We pass ignore_loaded here so that overlay files for (e.g.)
2173 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2174 # we know M::P::O found a file on disk so this is safe
2175
f5a4863c 2176 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2177 #Class::MOP::load_class($component);
364d7324 2178
2179 my $module = $class->setup_component( $component );
2180 my %modules = (
2181 $component => $module,
2182 map {
2183 $_ => $class->setup_component( $_ )
62a6df80 2184 } grep {
b94b200c 2185 not exists $comps{$_}
364d7324 2186 } Devel::InnerPackage::list_packages( $component )
2187 );
62a6df80 2188
364d7324 2189 for my $key ( keys %modules ) {
2190 $class->components->{ $key } = $modules{ $key };
fbcc39ad 2191 }
364d7324 2192 }
2193}
fbcc39ad 2194
364d7324 2195=head2 $c->setup_component
fbcc39ad 2196
364d7324 2197=cut
fbcc39ad 2198
2f5cb070 2199sub _controller_init_base_classes {
84848664 2200 my ($app_class, $component) = @_;
2f5cb070 2201 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
c98492ae 2202 Moose::Meta::Class->initialize( $class )
2f5cb070 2203 unless find_meta($class);
2204 }
2205}
2206
364d7324 2207sub setup_component {
2208 my( $class, $component ) = @_;
fbcc39ad 2209
364d7324 2210 unless ( $component->can( 'COMPONENT' ) ) {
2211 return $component;
2212 }
fbcc39ad 2213
2f5cb070 2214 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2215 # nearest to Catalyst::Controller first, no matter what order stuff happens
2216 # to be loaded. There are TODO tests in Moose for this, see
2217 # f2391d17574eff81d911b97be15ea51080500003
2218 if ($component->isa('Catalyst::Controller')) {
2219 $class->_controller_init_base_classes($component);
2220 }
62a6df80 2221
364d7324 2222 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2223 my $config = $class->config->{ $suffix } || {};
d2598ac8 2224 # Stash _component_name in the config here, so that custom COMPONENT
2225 # methods also pass it. local to avoid pointlessly shitting in config
2226 # for the debug screen, as $component is already the key name.
2227 local $config->{_component_name} = $component;
2228
364d7324 2229 my $instance = eval { $component->COMPONENT( $class, $config ); };
fbcc39ad 2230
2231 if ( my $error = $@ ) {
fbcc39ad 2232 chomp $error;
fbcc39ad 2233 Catalyst::Exception->throw(
364d7324 2234 message => qq/Couldn't instantiate component "$component", "$error"/
2235 );
fbcc39ad 2236 }
2237
7490de2a 2238 unless (blessed $instance) {
2239 my $metaclass = Moose::Util::find_meta($component);
2240 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2241 my $component_method_from = $method_meta->associated_metaclass->name;
637fa644 2242 my $value = defined($instance) ? $instance : 'undef';
7490de2a 2243 Catalyst::Exception->throw(
2244 message =>
637fa644 2245 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
7490de2a 2246 );
2247 }
364d7324 2248 return $instance;
fbcc39ad 2249}
2250
b5ecfcf0 2251=head2 $c->setup_dispatcher
fbcc39ad 2252
ae1e6b59 2253Sets up dispatcher.
2254
fbcc39ad 2255=cut
2256
2257sub setup_dispatcher {
2258 my ( $class, $dispatcher ) = @_;
2259
2260 if ($dispatcher) {
2261 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2262 }
2263
cb69249e 2264 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2265 $dispatcher = 'Catalyst::Dispatcher::' . $env;
fbcc39ad 2266 }
2267
2268 unless ($dispatcher) {
cb0354c6 2269 $dispatcher = $class->dispatcher_class;
fbcc39ad 2270 }
2271
e63bdf38 2272 Class::MOP::load_class($dispatcher);
fbcc39ad 2273
2274 # dispatcher instance
2275 $class->dispatcher( $dispatcher->new );
2276}
2277
b5ecfcf0 2278=head2 $c->setup_engine
fbcc39ad 2279
ae1e6b59 2280Sets up engine.
2281
fbcc39ad 2282=cut
2283
2284sub setup_engine {
2285 my ( $class, $engine ) = @_;
2286
2287 if ($engine) {
2288 $engine = 'Catalyst::Engine::' . $engine;
2289 }
2290
cb69249e 2291 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2292 $engine = 'Catalyst::Engine::' . $env;
fbcc39ad 2293 }
2294
9b0a3e0f 2295 if ( $ENV{MOD_PERL} ) {
e106a59f 2296 my $meta = Class::MOP::get_metaclass_by_name($class);
62a6df80 2297
fbcc39ad 2298 # create the apache method
74c89dea 2299 $meta->add_method('apache' => sub { shift->engine->apache });
fbcc39ad 2300
2301 my ( $software, $version ) =
2302 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2303
2304 $version =~ s/_//g;
2305 $version =~ s/(\.[^.]+)\./$1/g;
2306
2307 if ( $software eq 'mod_perl' ) {
2308
9b0a3e0f 2309 if ( !$engine ) {
22247e54 2310
9b0a3e0f 2311 if ( $version >= 1.99922 ) {
2312 $engine = 'Catalyst::Engine::Apache2::MP20';
2313 }
22247e54 2314
9b0a3e0f 2315 elsif ( $version >= 1.9901 ) {
2316 $engine = 'Catalyst::Engine::Apache2::MP19';
2317 }
22247e54 2318
9b0a3e0f 2319 elsif ( $version >= 1.24 ) {
2320 $engine = 'Catalyst::Engine::Apache::MP13';
2321 }
22247e54 2322
9b0a3e0f 2323 else {
2324 Catalyst::Exception->throw( message =>
2325 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2326 }
fbcc39ad 2327
fbcc39ad 2328 }
2329
2330 # install the correct mod_perl handler
2331 if ( $version >= 1.9901 ) {
2332 *handler = sub : method {
2333 shift->handle_request(@_);
2334 };
2335 }
2336 else {
2337 *handler = sub ($$) { shift->handle_request(@_) };
2338 }
2339
2340 }
2341
2342 elsif ( $software eq 'Zeus-Perl' ) {
2343 $engine = 'Catalyst::Engine::Zeus';
2344 }
2345
2346 else {
2347 Catalyst::Exception->throw(
2348 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2349 }
2350 }
2351
2352 unless ($engine) {
cb0354c6 2353 $engine = $class->engine_class;
fbcc39ad 2354 }
2355
e63bdf38 2356 Class::MOP::load_class($engine);
0e7f5826 2357
d54484bf 2358 # check for old engines that are no longer compatible
2359 my $old_engine;
0e7f5826 2360 if ( $engine->isa('Catalyst::Engine::Apache')
2361 && !Catalyst::Engine::Apache->VERSION )
d54484bf 2362 {
2363 $old_engine = 1;
2364 }
0e7f5826 2365
d54484bf 2366 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
0e7f5826 2367 && Catalyst::Engine::Server->VERSION le '0.02' )
d54484bf 2368 {
2369 $old_engine = 1;
2370 }
0e7f5826 2371
2372 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2373 && $engine->VERSION eq '0.01' )
d54484bf 2374 {
2375 $old_engine = 1;
2376 }
0e7f5826 2377
2378 elsif ($engine->isa('Catalyst::Engine::Zeus')
2379 && $engine->VERSION eq '0.01' )
d54484bf 2380 {
2381 $old_engine = 1;
2382 }
fbcc39ad 2383
d54484bf 2384 if ($old_engine) {
2385 Catalyst::Exception->throw( message =>
0e7f5826 2386 qq/Engine "$engine" is not supported by this version of Catalyst/
d54484bf 2387 );
2388 }
0e7f5826 2389
fbcc39ad 2390 # engine instance
2391 $class->engine( $engine->new );
2392}
2393
b5ecfcf0 2394=head2 $c->setup_home
fbcc39ad 2395
ae1e6b59 2396Sets up the home directory.
2397
fbcc39ad 2398=cut
2399
2400sub setup_home {
2401 my ( $class, $home ) = @_;
2402
cb69249e 2403 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2404 $home = $env;
fbcc39ad 2405 }
2406
b6d4ee6e 2407 $home ||= Catalyst::Utils::home($class);
fbcc39ad 2408
2409 if ($home) {
e63bdf38 2410 #I remember recently being scolded for assigning config values like this
fbcc39ad 2411 $class->config->{home} ||= $home;
a738ab68 2412 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
fbcc39ad 2413 }
2414}
2415
b5ecfcf0 2416=head2 $c->setup_log
fbcc39ad 2417
0fa676a7 2418Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2419passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2420log to.
62a6df80 2421
0fa676a7 2422This method also installs a C<debug> method that returns a true value into the
2423catalyst subclass if the "debug" level is passed in the comma-delimited list,
2424or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2425
2426Note that if the log has already been setup, by either a previous call to
2427C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
5baa3bbc 2428that this method won't actually set up the log object.
ae1e6b59 2429
fbcc39ad 2430=cut
2431
2432sub setup_log {
0fa676a7 2433 my ( $class, $levels ) = @_;
fbcc39ad 2434
5baa3bbc 2435 $levels ||= '';
2436 $levels =~ s/^\s+//;
2437 $levels =~ s/\s+$//;
abf65c2a 2438 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2439
2440 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2441 if ( defined $env_debug ) {
2442 $levels{debug} = 1 if $env_debug; # Ugly!
2443 delete($levels{debug}) unless $env_debug;
2444 }
2445
fbcc39ad 2446 unless ( $class->log ) {
0fa676a7 2447 $class->log( Catalyst::Log->new(keys %levels) );
fbcc39ad 2448 }
af3ff00e 2449
abf65c2a 2450 if ( $levels{debug} ) {
e106a59f 2451 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
fbcc39ad 2452 $class->log->debug('Debug messages enabled');
2453 }
2454}
2455
b5ecfcf0 2456=head2 $c->setup_plugins
fbcc39ad 2457
ae1e6b59 2458Sets up plugins.
2459
fbcc39ad 2460=cut
2461
dc5f035e 2462=head2 $c->setup_stats
2463
2464Sets up timing statistics class.
2465
2466=cut
2467
2468sub setup_stats {
2469 my ( $class, $stats ) = @_;
2470
2471 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2472
2473 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2474 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
e106a59f 2475 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
b01f0c69 2476 $class->log->debug('Statistics enabled');
dc5f035e 2477 }
2478}
2479
2480
62a6df80 2481=head2 $c->registered_plugins
836e1134 2482
2483Returns a sorted list of the plugins which have either been stated in the
2484import list or which have been added via C<< MyApp->plugin(@args); >>.
2485
2486If passed a given plugin name, it will report a boolean value indicating
2487whether or not that plugin is loaded. A fully qualified name is required if
2488the plugin name does not begin with C<Catalyst::Plugin::>.
2489
2490 if ($c->registered_plugins('Some::Plugin')) {
2491 ...
2492 }
2493
2494=cut
fbcc39ad 2495
836e1134 2496{
97b58e17 2497
2498 sub registered_plugins {
836e1134 2499 my $proto = shift;
197bd788 2500 return sort keys %{ $proto->_plugins } unless @_;
836e1134 2501 my $plugin = shift;
d0d4d785 2502 return 1 if exists $proto->_plugins->{$plugin};
2503 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
836e1134 2504 }
fbcc39ad 2505
836e1134 2506 sub _register_plugin {
2507 my ( $proto, $plugin, $instant ) = @_;
2508 my $class = ref $proto || $proto;
fbcc39ad 2509
b6d4ee6e 2510 Class::MOP::load_class( $plugin );
fbcc39ad 2511
197bd788 2512 $proto->_plugins->{$plugin} = 1;
836e1134 2513 unless ($instant) {
fbcc39ad 2514 no strict 'refs';
e106a59f 2515 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
74c89dea 2516 my @superclasses = ($plugin, $meta->superclasses );
2517 $meta->superclasses(@superclasses);
5fb67d52 2518 } else {
2519 unshift @{"$class\::ISA"}, $plugin;
2520 }
fbcc39ad 2521 }
836e1134 2522 return $class;
2523 }
2524
2525 sub setup_plugins {
2526 my ( $class, $plugins ) = @_;
2527
d0d4d785 2528 $class->_plugins( {} ) unless $class->_plugins;
836e1134 2529 $plugins ||= [];
196932de 2530
5d8129e9 2531 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
b0ad47c1 2532
e5210a95 2533 for my $plugin ( reverse @plugins ) {
2938f7a0 2534 Class::MOP::load_class($plugin);
e5210a95 2535 my $meta = find_meta($plugin);
2536 next if $meta && $meta->isa('Moose::Meta::Role');
836e1134 2537
2538 $class->_register_plugin($plugin);
2539 }
e5210a95 2540
2541 my @roles =
2542 map { $_->name }
2543 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2544 map { find_meta($_) }
2545 @plugins;
b0ad47c1 2546
e5210a95 2547 Moose::Util::apply_all_roles(
2548 $class => @roles
2549 ) if @roles;
fbcc39ad 2550 }
2551}
2552
b5ecfcf0 2553=head2 $c->stack
8767c5a3 2554
86418559 2555Returns an arrayref of the internal execution stack (actions that are
2556currently executing).
8767c5a3 2557
dc5f035e 2558=head2 $c->stats_class
2559
2560Returns or sets the stats (timing statistics) class.
2561
2562=head2 $c->use_stats
2563
2564Returns 1 when stats collection is enabled. Stats collection is enabled
2565when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2566environment variable is set.
2567
8eae92ad 2568Note that this is a static method, not an accessor and should be overridden
2569by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
dc5f035e 2570
2571=cut
2572
2573sub use_stats { 0 }
2574
2575
b5ecfcf0 2576=head2 $c->write( $data )
fbcc39ad 2577
ae1e6b59 2578Writes $data to the output stream. When using this method directly, you
2579will need to manually set the C<Content-Length> header to the length of
2580your output data, if known.
fbcc39ad 2581
2582=cut
2583
4f5ebacd 2584sub write {
2585 my $c = shift;
2586
2587 # Finalize headers if someone manually writes output
2588 $c->finalize_headers;
2589
2590 return $c->engine->write( $c, @_ );
2591}
fbcc39ad 2592
b5ecfcf0 2593=head2 version
bf88a181 2594
ae1e6b59 2595Returns the Catalyst version number. Mostly useful for "powered by"
2596messages in template systems.
bf88a181 2597
2598=cut
2599
2600sub version { return $Catalyst::VERSION }
2601
b0bb11ec 2602=head1 INTERNAL ACTIONS
2603
ae1e6b59 2604Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2605C<_ACTION>, and C<_END>. These are by default not shown in the private
3e705254 2606action table, but you can make them visible with a config parameter.
b0bb11ec 2607
4600a5a1 2608 MyApp->config(show_internal_actions => 1);
b0bb11ec 2609
d2ee9760 2610=head1 CASE SENSITIVITY
2611
3e705254 2612By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
ae1e6b59 2613mapped to C</foo/bar>. You can activate case sensitivity with a config
3e705254 2614parameter.
d2ee9760 2615
4600a5a1 2616 MyApp->config(case_sensitive => 1);
d2ee9760 2617
3e705254 2618This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
fbcc39ad 2619
2620=head1 ON-DEMAND PARSER
2621
2622The request body is usually parsed at the beginning of a request,
878b821c 2623but if you want to handle input yourself, you can enable on-demand
2624parsing with a config parameter.
fbcc39ad 2625
4600a5a1 2626 MyApp->config(parse_on_demand => 1);
62a6df80 2627
fbcc39ad 2628=head1 PROXY SUPPORT
2629
ae1e6b59 2630Many production servers operate using the common double-server approach,
2631with a lightweight frontend web server passing requests to a larger
2632backend server. An application running on the backend server must deal
2633with two problems: the remote user always appears to be C<127.0.0.1> and
2634the server's hostname will appear to be C<localhost> regardless of the
2635virtual host that the user connected through.
fbcc39ad 2636
ae1e6b59 2637Catalyst will automatically detect this situation when you are running
2638the frontend and backend servers on the same machine. The following
2639changes are made to the request.
fbcc39ad 2640
62a6df80 2641 $c->req->address is set to the user's real IP address, as read from
ae1e6b59 2642 the HTTP X-Forwarded-For header.
62a6df80 2643
ae1e6b59 2644 The host value for $c->req->base and $c->req->uri is set to the real
2645 host, as read from the HTTP X-Forwarded-Host header.
fbcc39ad 2646
3e705254 2647Obviously, your web server must support these headers for this to work.
fbcc39ad 2648
ae1e6b59 2649In a more complex server farm environment where you may have your
2650frontend proxy server(s) on different machines, you will need to set a
2651configuration option to tell Catalyst to read the proxied data from the
2652headers.
fbcc39ad 2653
4600a5a1 2654 MyApp->config(using_frontend_proxy => 1);
62a6df80 2655
fbcc39ad 2656If you do not wish to use the proxy support at all, you may set:
d1a31ac6 2657
4600a5a1 2658 MyApp->config(ignore_frontend_proxy => 1);
fbcc39ad 2659
2660=head1 THREAD SAFETY
2661
86418559 2662Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2663C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2664believe the Catalyst core to be thread-safe.
fbcc39ad 2665
2666If you plan to operate in a threaded environment, remember that all other
3e705254 2667modules you are using must also be thread-safe. Some modules, most notably
2668L<DBD::SQLite>, are not thread-safe.
d1a31ac6 2669
3cb1db8c 2670=head1 SUPPORT
2671
2672IRC:
2673
4eaf7c88 2674 Join #catalyst on irc.perl.org.
3cb1db8c 2675
3e705254 2676Mailing Lists:
3cb1db8c 2677
6d4c3368 2678 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2679 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
1985c30b 2680
432d507d 2681Web:
2682
2683 http://catalyst.perl.org
2684
0ef52a96 2685Wiki:
2686
2687 http://dev.catalyst.perl.org
2688
fc7ec1d9 2689=head1 SEE ALSO
2690
829a28ca 2691=head2 L<Task::Catalyst> - All you need to start with Catalyst
2692
b5ecfcf0 2693=head2 L<Catalyst::Manual> - The Catalyst Manual
e7f1cf73 2694
af58f1a4 2695=head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
61b1e958 2696
b5ecfcf0 2697=head2 L<Catalyst::Engine> - Core engine
61b1e958 2698
b5ecfcf0 2699=head2 L<Catalyst::Log> - Log class.
61b1e958 2700
b5ecfcf0 2701=head2 L<Catalyst::Request> - Request object
61b1e958 2702
b5ecfcf0 2703=head2 L<Catalyst::Response> - Response object
61b1e958 2704
b5ecfcf0 2705=head2 L<Catalyst::Test> - The test suite.
fc7ec1d9 2706
2f381252 2707=head1 PROJECT FOUNDER
2708
2709sri: Sebastian Riedel <sri@cpan.org>
fc7ec1d9 2710
2f381252 2711=head1 CONTRIBUTORS
15f0b5b7 2712
2f381252 2713abw: Andy Wardley
fbcc39ad 2714
2f381252 2715acme: Leon Brocard <leon@astray.com>
33108eaf 2716
f4a57de4 2717Andrew Bramble
2718
15f0b5b7 2719Andrew Ford
2720
2721Andrew Ruthven
2722
2f381252 2723andyg: Andy Grundman <andy@hybridized.org>
fbcc39ad 2724
2f381252 2725audreyt: Audrey Tang
15f0b5b7 2726
2f381252 2727bricas: Brian Cassidy <bricas@cpan.org>
0cf56dbc 2728
e31b525c 2729Caelum: Rafael Kitover <rkitover@io.com>
2730
2f381252 2731chansen: Christian Hansen
6aaa1c60 2732
2f381252 2733chicks: Christopher Hicks
15f0b5b7 2734
0fa676a7 2735David E. Wheeler
2736
2f381252 2737dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
15f0b5b7 2738
2f381252 2739Drew Taylor
15f0b5b7 2740
8026359e 2741dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2742
2f381252 2743esskar: Sascha Kiefer
0ef52a96 2744
2f381252 2745fireartist: Carl Franks <cfranks@cpan.org>
15f0b5b7 2746
2f381252 2747gabb: Danijel Milicevic
61bef238 2748
15f0b5b7 2749Gary Ashton Jones
2750
2751Geoff Richards
2752
1fe85999 2753hobbs: Andrew Rodland <andrew@cleverdomain.org>
2754
e4cc83b2 2755ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2756
2f381252 2757jcamacho: Juan Camacho