lib/Catalyst.pm

   1 package Catalyst;
   2
   3 use Moose;
   4 use Moose::Meta::Class ();
   5 extends 'Catalyst::Component';
   6 use Moose::Util qw/find_meta/;
   7 use B::Hooks::EndOfScope ();
   8 use Catalyst::Exception;
   9 use Catalyst::Exception::Detach;
  10 use Catalyst::Exception::Go;
  11 use Catalyst::Log;
  12 use Catalyst::Request;
  13 use Catalyst::Request::Upload;
  14 use Catalyst::Response;
  15 use Catalyst::Utils;
  16 use Catalyst::Controller;
  17 use Data::OptList;
  18 use Devel::InnerPackage ();
  19 use File::stat;
  20 use Module::Pluggable::Object ();
  21 use Text::SimpleTable ();
  22 use Path::Class::Dir ();
  23 use Path::Class::File ();
  24 use URI ();
  25 use URI::http;
  26 use URI::https;
  27 use Tree::Simple qw/use_weak_refs/;
  28 use Tree::Simple::Visitor::FindByUID;
  29 use Class::C3::Adopt::NEXT;
  30 use List::MoreUtils qw/uniq/;
  31 use attributes;
  32 use utf8;
  33 use Carp qw/croak carp shortmess/;
  34
  35 BEGIN { require 5.008004; }
  36
  37 has stack => (is => 'ro', default => sub { [] });
  38 has stash => (is => 'rw', default => sub { {} });
  39 has state => (is => 'rw', default => 0);
  40 has stats => (is => 'rw');
  41 has action => (is => 'rw');
  42 has counter => (is => 'rw', default => sub { {} });
  43 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
  44 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
  45 has namespace => (is => 'rw');
  46
  47 sub depth { scalar @{ shift->stack || [] }; }
  48 sub comp { shift->component(@_) }
  49
  50 sub req {
  51     my $self = shift; return $self->request(@_);
  52 }
  53 sub res {
  54     my $self = shift; return $self->response(@_);
  55 }
  56
  57 # For backwards compatibility
  58 sub finalize_output { shift->finalize_body(@_) };
  59
  60 # For statistics
  61 our $COUNT     = 1;
  62 our $START     = time;
  63 our $RECURSION = 1000;
  64 our $DETACH    = Catalyst::Exception::Detach->new;
  65 our $GO        = Catalyst::Exception::Go->new;
  66
  67 #I imagine that very few of these really need to be class variables. if any.
  68 #maybe we should just make them attributes with a default?
  69 __PACKAGE__->mk_classdata($_)
  70   for qw/container components arguments dispatcher engine log dispatcher_class
  71   engine_class context_class request_class response_class stats_class
  72   setup_finished/;
  73
  74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
  75 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
  76 __PACKAGE__->request_class('Catalyst::Request');
  77 __PACKAGE__->response_class('Catalyst::Response');
  78 __PACKAGE__->stats_class('Catalyst::Stats');
  79
  80 # Remember to update this in Catalyst::Runtime as well!
  81
  82 our $VERSION = '5.80032';
  83
  84 sub import {
  85     my ( $class, @arguments ) = @_;
  86
  87     # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
  88     # callers @ISA.
  89     return unless $class eq 'Catalyst';
  90
  91     my $caller = caller();
  92     return if $caller eq 'main';
  93
  94     my $meta = Moose::Meta::Class->initialize($caller);
  95     unless ( $caller->isa('Catalyst') ) {
  96         my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
  97         $meta->superclasses(@superclasses);
  98     }
  99     # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
 100     $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
 101
 102     unless( $meta->has_method('meta') ){
 103         if ($Moose::VERSION >= 1.15) {
 104             $meta->_add_meta_method('meta');
 105         }
 106         else {
 107             $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
 108         }
 109     }
 110
 111     $caller->arguments( [@arguments] );
 112     $caller->setup_home;
 113 }
 114
 115 sub _application { $_[0] }
 116
 117 =head1 NAME
 118
 119 Catalyst - The Elegant MVC Web Application Framework
 120
 121 =head1 SYNOPSIS
 122
 123 See the L<Catalyst::Manual> distribution for comprehensive
 124 documentation and tutorials.
 125
 126     # Install Catalyst::Devel for helpers and other development tools
 127     # use the helper to create a new application
 128     catalyst.pl MyApp
 129
 130     # add models, views, controllers
 131     script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
 132     script/myapp_create.pl view MyTemplate TT
 133     script/myapp_create.pl controller Search
 134
 135     # built in testserver -- use -r to restart automatically on changes
 136     # --help to see all available options
 137     script/myapp_server.pl
 138
 139     # command line testing interface
 140     script/myapp_test.pl /yada
 141
 142     ### in lib/MyApp.pm
 143     use Catalyst qw/-Debug/; # include plugins here as well
 144
 145     ### In lib/MyApp/Controller/Root.pm (autocreated)
 146     sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
 147         my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
 148         $c->stash->{template} = 'foo.tt'; # set the template
 149         # lookup something from db -- stash vars are passed to TT
 150         $c->stash->{data} =
 151           $c->model('Database::Foo')->search( { country => $args[0] } );
 152         if ( $c->req->params->{bar} ) { # access GET or POST parameters
 153             $c->forward( 'bar' ); # process another action
 154             # do something else after forward returns
 155         }
 156     }
 157
 158     # The foo.tt TT template can use the stash data from the database
 159     [% WHILE (item = data.next) %]
 160         [% item.foo %]
 161     [% END %]
 162
 163     # called for /bar/of/soap, /bar/of/soap/10, etc.
 164     sub bar : Path('/bar/of/soap') { ... }
 165
 166     # called for all actions, from the top-most controller downwards
 167     sub auto : Private {
 168         my ( $self, $c ) = @_;
 169         if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
 170             $c->res->redirect( '/login' ); # require login
 171             return 0; # abort request and go immediately to end()
 172         }
 173         return 1; # success; carry on to next action
 174     }
 175
 176     # called after all actions are finished
 177     sub end : Private {
 178         my ( $self, $c ) = @_;
 179         if ( scalar @{ $c->error } ) { ... } # handle errors
 180         return if $c->res->body; # already have a response
 181         $c->forward( 'MyApp::View::TT' ); # render template
 182     }
 183
 184     ### in MyApp/Controller/Foo.pm
 185     # called for /foo/bar
 186     sub bar : Local { ... }
 187
 188     # called for /blargle
 189     sub blargle : Global { ... }
 190
 191     # an index action matches /foo, but not /foo/1, etc.
 192     sub index : Private { ... }
 193
 194     ### in MyApp/Controller/Foo/Bar.pm
 195     # called for /foo/bar/baz
 196     sub baz : Local { ... }
 197
 198     # first Root auto is called, then Foo auto, then this
 199     sub auto : Private { ... }
 200
 201     # powerful regular expression paths are also possible
 202     sub details : Regex('^product/(\w+)/details$') {
 203         my ( $self, $c ) = @_;
 204         # extract the (\w+) from the URI
 205         my $product = $c->req->captures->[0];
 206     }
 207
 208 See L<Catalyst::Manual::Intro> for additional information.
 209
 210 =head1 DESCRIPTION
 211
 212 Catalyst is a modern framework for making web applications without the
 213 pain usually associated with this process. This document is a reference
 214 to the main Catalyst application. If you are a new user, we suggest you
 215 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
 216
 217 See L<Catalyst::Manual> for more documentation.
 218
 219 Catalyst plugins can be loaded by naming them as arguments to the "use
 220 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
 221 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
 222 C<My::Module>.
 223
 224     use Catalyst qw/My::Module/;
 225
 226 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
 227 fully qualify the name by using a unary plus:
 228
 229     use Catalyst qw/
 230         My::Module
 231         +Fully::Qualified::Plugin::Name
 232     /;
 233
 234 Special flags like C<-Debug> and C<-Engine> can also be specified as
 235 arguments when Catalyst is loaded:
 236
 237     use Catalyst qw/-Debug My::Module/;
 238
 239 The position of plugins and flags in the chain is important, because
 240 they are loaded in the order in which they appear.
 241
 242 The following flags are supported:
 243
 244 =head2 -Debug
 245
 246 Enables debug output. You can also force this setting from the system
 247 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
 248 settings override the application, with <MYAPP>_DEBUG having the highest
 249 priority.
 250
 251 This sets the log level to 'debug' and enables full debug output on the
 252 error screen. If you only want the latter, see L<< $c->debug >>.
 253
 254 =head2 -Engine
 255
 256 Forces Catalyst to use a specific engine. Omit the
 257 C<Catalyst::Engine::> prefix of the engine name, i.e.:
 258
 259     use Catalyst qw/-Engine=CGI/;
 260
 261 =head2 -Home
 262
 263 Forces Catalyst to use a specific home directory, e.g.:
 264
 265     use Catalyst qw[-Home=/usr/mst];
 266
 267 This can also be done in the shell environment by setting either the
 268 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
 269 is replaced with the uppercased name of your application, any "::" in
 270 the name will be replaced with underscores, e.g. MyApp::Web should use
 271 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
 272
 273 If none of these are set, Catalyst will attempt to automatically detect the
 274 home directory. If you are working in a development envirnoment, Catalyst
 275 will try and find the directory containing either Makefile.PL, Build.PL or
 276 dist.ini. If the application has been installed into the system (i.e.
 277 you have done C<make install>), then Catalyst will use the path to your
 278 application module, without the .pm extension (ie, /foo/MyApp if your
 279 application was installed at /foo/MyApp.pm)
 280
 281 =head2 -Log
 282
 283     use Catalyst '-Log=warn,fatal,error';
 284
 285 Specifies a comma-delimited list of log levels.
 286
 287 =head2 -Stats
 288
 289 Enables statistics collection and reporting.
 290
 291    use Catalyst qw/-Stats=1/;
 292
 293 You can also force this setting from the system environment with CATALYST_STATS
 294 or <MYAPP>_STATS. The environment settings override the application, with
 295 <MYAPP>_STATS having the highest priority.
 296
 297 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
 298
 299 =head1 METHODS
 300
 301 =head2 INFORMATION ABOUT THE CURRENT REQUEST
 302
 303 =head2 $c->action
 304
 305 Returns a L<Catalyst::Action> object for the current action, which
 306 stringifies to the action name. See L<Catalyst::Action>.
 307
 308 =head2 $c->namespace
 309
 310 Returns the namespace of the current action, i.e., the URI prefix
 311 corresponding to the controller of the current action. For example:
 312
 313     # in Controller::Foo::Bar
 314     $c->namespace; # returns 'foo/bar';
 315
 316 =head2 $c->request
 317
 318 =head2 $c->req
 319
 320 Returns the current L<Catalyst::Request> object, giving access to
 321 information about the current client request (including parameters,
 322 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
 323
 324 =head2 REQUEST FLOW HANDLING
 325
 326 =head2 $c->forward( $action [, \@arguments ] )
 327
 328 =head2 $c->forward( $class, $method, [, \@arguments ] )
 329
 330 Forwards processing to another action, by its private name. If you give a
 331 class name but no method, C<process()> is called. You may also optionally
 332 pass arguments in an arrayref. The action will receive the arguments in
 333 C<@_> and C<< $c->req->args >>. Upon returning from the function,
 334 C<< $c->req->args >> will be restored to the previous values.
 335
 336 Any data C<return>ed from the action forwarded to, will be returned by the
 337 call to forward.
 338
 339     my $foodata = $c->forward('/foo');
 340     $c->forward('index');
 341     $c->forward(qw/Model::DBIC::Foo do_stuff/);
 342     $c->forward('View::TT');
 343
 344 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
 345 an C<< eval { } >> around the call (actually
 346 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
 347 all 'dies' within the called action. If you want C<die> to propagate you
 348 need to do something like:
 349
 350     $c->forward('foo');
 351     die join "\n", @{ $c->error } if @{ $c->error };
 352
 353 Or make sure to always return true values from your actions and write
 354 your code like this:
 355
 356     $c->forward('foo') || return;
 357
 358 Another note is that C<< $c->forward >> always returns a scalar because it
 359 actually returns $c->state which operates in a scalar context.
 360 Thus, something like:
 361
 362     return @array;
 363
 364 in an action that is forwarded to is going to return a scalar,
 365 i.e. how many items are in that array, which is probably not what you want.
 366 If you need to return an array then return a reference to it,
 367 or stash it like so:
 368
 369     $c->stash->{array} = \@array;
 370
 371 and access it from the stash.
 372
 373 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
 374
 375 =cut
 376
 377 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
 378
 379 =head2 $c->detach( $action [, \@arguments ] )
 380
 381 =head2 $c->detach( $class, $method, [, \@arguments ] )
 382
 383 =head2 $c->detach()
 384
 385 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
 386 doesn't return to the previous action when processing is finished.
 387
 388 When called with no arguments it escapes the processing chain entirely.
 389
 390 =cut
 391
 392 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
 393
 394 =head2 $c->visit( $action [, \@captures, \@arguments ] )
 395
 396 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
 397
 398 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
 399 but does a full dispatch, instead of just calling the new C<$action> /
 400 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
 401 you go to are called, just like a new request.
 402
 403 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
 404 This means, for example, that C<< $c->action >> methods such as
 405 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
 406 L<reverse|Catalyst::Action/reverse> return information for the visited action
 407 when they are invoked within the visited action.  This is different from the
 408 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
 409 continues to use the $c->action object from the caller action even when
 410 invoked from the callee.
 411
 412 C<< $c->stash >> is kept unchanged.
 413
 414 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
 415 allows you to "wrap" another action, just as it would have been called by
 416 dispatching from a URL, while the analogous
 417 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
 418 transfer control to another action as if it had been reached directly from a URL.
 419
 420 =cut
 421
 422 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
 423
 424 =head2 $c->go( $action [, \@captures, \@arguments ] )
 425
 426 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
 427
 428 The relationship between C<go> and
 429 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
 430 the relationship between
 431 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
 432 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
 433 C<< $c->go >> will perform a full dispatch on the specified action or method,
 434 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
 435 C<go> escapes the processing of the current request chain on completion, and
 436 does not return to its caller.
 437
 438 @arguments are arguments to the final destination of $action. @captures are
 439 arguments to the intermediate steps, if any, on the way to the final sub of
 440 $action.
 441
 442 =cut
 443
 444 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
 445
 446 =head2 $c->response
 447
 448 =head2 $c->res
 449
 450 Returns the current L<Catalyst::Response> object, see there for details.
 451
 452 =head2 $c->stash
 453
 454 Returns a hashref to the stash, which may be used to store data and pass
 455 it between components during a request. You can also set hash keys by
 456 passing arguments. The stash is automatically sent to the view. The
 457 stash is cleared at the end of a request; it cannot be used for
 458 persistent storage (for this you must use a session; see
 459 L<Catalyst::Plugin::Session> for a complete system integrated with
 460 Catalyst).
 461
 462     $c->stash->{foo} = $bar;
 463     $c->stash( { moose => 'majestic', qux => 0 } );
 464     $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
 465
 466     # stash is automatically passed to the view for use in a template
 467     $c->forward( 'MyApp::View::TT' );
 468
 469 =cut
 470
 471 around stash => sub {
 472     my $orig = shift;
 473     my $c = shift;
 474     my $stash = $orig->($c);
 475     if (@_) {
 476         my $new_stash = @_ > 1 ? {@_} : $_[0];
 477         croak('stash takes a hash or hashref') unless ref $new_stash;
 478         foreach my $key ( keys %$new_stash ) {
 479           $stash->{$key} = $new_stash->{$key};
 480         }
 481     }
 482
 483     return $stash;
 484 };
 485
 486
 487 =head2 $c->error
 488
 489 =head2 $c->error($error, ...)
 490
 491 =head2 $c->error($arrayref)
 492
 493 Returns an arrayref containing error messages.  If Catalyst encounters an
 494 error while processing a request, it stores the error in $c->error.  This
 495 method should only be used to store fatal error messages.
 496
 497     my @error = @{ $c->error };
 498
 499 Add a new error.
 500
 501     $c->error('Something bad happened');
 502
 503 =cut
 504
 505 sub error {
 506     my $c = shift;
 507     if ( $_[0] ) {
 508         my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
 509         croak @$error unless ref $c;
 510         push @{ $c->{error} }, @$error;
 511     }
 512     elsif ( defined $_[0] ) { $c->{error} = undef }
 513     return $c->{error} || [];
 514 }
 515
 516
 517 =head2 $c->state
 518
 519 Contains the return value of the last executed action.
 520 Note that << $c->state >> operates in a scalar context which means that all
 521 values it returns are scalar.
 522
 523 =head2 $c->clear_errors
 524
 525 Clear errors.  You probably don't want to clear the errors unless you are
 526 implementing a custom error screen.
 527
 528 This is equivalent to running
 529
 530     $c->error(0);
 531
 532 =cut
 533
 534 sub clear_errors {
 535     my $c = shift;
 536     $c->error(0);
 537 }
 538
 539 =head2 COMPONENT ACCESSORS
 540
 541 =head2 $c->controller($name)
 542
 543 Gets a L<Catalyst::Controller> instance by name.
 544
 545     $c->controller('Foo')->do_stuff;
 546
 547 If the name is omitted, will return the controller for the dispatched
 548 action.
 549
 550 If you want to search for controllers, pass in a regexp as the argument.
 551
 552     # find all controllers that start with Foo
 553     my @foo_controllers = $c->controller(qr{^Foo});
 554
 555
 556 =cut
 557
 558 sub controller {
 559     my ( $c, $name, @args ) = @_;
 560     my $container = $c->container->get_sub_container('controller');
 561
 562     if( $name ) {
 563         # Direct component hash lookup to avoid costly regexps
 564         return $container->get_component( $name, $c, @args )
 565             if $container->has_service($name) && !ref $name;
 566
 567         return $container->get_component_regexp( $name, $c, @args );
 568     }
 569
 570     return $c->component( $c->action->class );
 571 }
 572
 573 =head2 $c->model($name)
 574
 575 Gets a L<Catalyst::Model> instance by name.
 576
 577     $c->model('Foo')->do_stuff;
 578
 579 Any extra arguments are directly passed to ACCEPT_CONTEXT.
 580
 581 If the name is omitted, it will look for
 582  - a model object in $c->stash->{current_model_instance}, then
 583  - a model name in $c->stash->{current_model}, then
 584  - a config setting 'default_model', or
 585  - check if there is only one model, and return it if that's the case.
 586
 587 If you want to search for models, pass in a regexp as the argument.
 588
 589     # find all models that start with Foo
 590     my @foo_models = $c->model(qr{^Foo});
 591
 592 =cut
 593
 594 sub model {
 595     my ( $c, $name, @args ) = @_;
 596     my $appclass = ref($c) || $c;
 597     my $container = $c->container->get_sub_container('model');
 598
 599     if( $name ) {
 600         # Direct component hash lookup to avoid costly regexps
 601         return $container->get_component( $name, $c, @args )
 602             if $container->has_service($name) && !ref $name;
 603
 604         return $container->get_component_regexp( $name, $c, @args );
 605     }
 606
 607     if (ref $c) {
 608         return $c->stash->{current_model_instance}
 609           if $c->stash->{current_model_instance};
 610         return $c->model( $c->stash->{current_model} )
 611           if $c->stash->{current_model};
 612     }
 613     return $c->model( $appclass->config->{default_model} )
 614       if $appclass->config->{default_model};
 615
 616 # FIXME: will this still be mantained?
 617     my( $comp, $rest ) = $container->get_service_list;
 618
 619     if( $rest ) {
 620         $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
 621         $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
 622         $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
 623         $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
 624         $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
 625     }
 626
 627     return $container->get_component( $comp, $c, @args );
 628 }
 629
 630
 631 =head2 $c->view($name)
 632
 633 Gets a L<Catalyst::View> instance by name.
 634
 635     $c->view('Foo')->do_stuff;
 636
 637 Any extra arguments are directly passed to ACCEPT_CONTEXT.
 638
 639 If the name is omitted, it will look for
 640  - a view object in $c->stash->{current_view_instance}, then
 641  - a view name in $c->stash->{current_view}, then
 642  - a config setting 'default_view', or
 643  - check if there is only one view, and return it if that's the case.
 644
 645 If you want to search for views, pass in a regexp as the argument.
 646
 647     # find all views that start with Foo
 648     my @foo_views = $c->view(qr{^Foo});
 649
 650 =cut
 651
 652 sub view {
 653     my ( $c, $name, @args ) = @_;
 654     my $appclass = ref($c) || $c;
 655     my $container = $c->container->get_sub_container('view');
 656
 657     if( $name ) {
 658         # Direct component hash lookup to avoid costly regexps
 659         return $container->get_component( $name, $c, @args )
 660             if !ref $name && $container->has_service($name);
 661
 662         $c->log->warn( "Attempted to use view '$name', but does not exist" );
 663
 664         return $container->get_component_regexp( $name, $c, @args );
 665     }
 666
 667     if (ref $c) {
 668         return $c->stash->{current_view_instance}
 669           if $c->stash->{current_view_instance};
 670         return $c->view( $c->stash->{current_view} )
 671           if $c->stash->{current_view};
 672     }
 673     return $c->view( $appclass->config->{default_view} )
 674       if $appclass->config->{default_view};
 675
 676     my( $comp, $rest ) = $container->get_service_list;
 677
 678     if( $rest ) {
 679         $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
 680         $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
 681         $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
 682         $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
 683         $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
 684     }
 685
 686     return $container->get_component( $comp, $c, @args );
 687 }
 688
 689 =head2 $c->controllers
 690
 691 Returns the available names which can be passed to $c->controller
 692
 693 =cut
 694
 695 sub controllers {
 696     my ( $c ) = @_;
 697     return $c->container->get_sub_container('controller')->get_service_list;
 698 }
 699
 700 =head2 $c->models
 701
 702 Returns the available names which can be passed to $c->model
 703
 704 =cut
 705
 706 sub models {
 707     my ( $c ) = @_;
 708     return $c->container->get_sub_container('model')->get_service_list;
 709 }
 710
 711
 712 =head2 $c->views
 713
 714 Returns the available names which can be passed to $c->view
 715
 716 =cut
 717
 718 sub views {
 719     my ( $c ) = @_;
 720     return $c->container->get_sub_container('view')->get_service_list;
 721 }
 722
 723 =head2 $c->comp($name)
 724
 725 =head2 $c->component($name)
 726
 727 Gets a component object by name. This method is not recommended,
 728 unless you want to get a specific component by full
 729 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
 730 should be used instead.
 731
 732 If C<$name> is a regexp, a list of components matched against the full
 733 component name will be returned.
 734
 735 =cut
 736
 737 sub component {
 738     my ( $c, $component, @args ) = @_;
 739
 740     if ( $component ) {
 741         # FIXME: I probably shouldn't be doing this
 742         return $c->components->{$component}
 743             if exists $c->components->{$component};
 744
 745         my ($type, $name) = _get_component_type_name($component);
 746
 747         if ($type && $c->container->has_sub_container($type)) {
 748             my $container = $c->container->get_sub_container($type);
 749
 750             if( !ref $component && $container->has_service($name) ) {
 751                 return $container->get_component( $name, $c, @args );
 752             }
 753
 754             return $container->get_component_regexp( $name, $c, @args );
 755         }
 756
 757         if (ref $component) {
 758             for my $subcontainer_name (qw/model view controller/) {
 759                 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
 760                 my @components   = $subcontainer->get_service_list;
 761                 my @result       = grep { m{$component} } @components;
 762
 763                 return map { $subcontainer->get_component( $_, $c, @args ) } @result;
 764             }
 765         }
 766
 767         $c->log->warn("Looking for '$component', but nothing was found.");
 768
 769         # I would expect to return an empty list here, but that breaks back-compat
 770     }
 771
 772     # fallback
 773     return sort keys %{ $c->components };
 774 }
 775
 776 =head2 CLASS DATA AND HELPER CLASSES
 777
 778 =head2 $c->config
 779
 780 Returns or takes a hashref containing the application's configuration.
 781
 782     __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
 783
 784 You can also use a C<YAML>, C<XML> or L<Config::General> config file
 785 like C<myapp.conf> in your applications home directory. See
 786 L<Catalyst::Plugin::ConfigLoader>.
 787
 788 =head3 Cascading configuration
 789
 790 The config method is present on all Catalyst components, and configuration
 791 will be merged when an application is started. Configuration loaded with
 792 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
 793 followed by configuration in your top level C<MyApp> class. These two
 794 configurations are merged, and then configuration data whose hash key matches a
 795 component name is merged with configuration for that component.
 796
 797 The configuration for a component is then passed to the C<new> method when a
 798 component is constructed.
 799
 800 For example:
 801
 802     MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
 803     MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
 804
 805 will mean that C<MyApp::Model::Foo> receives the following data when
 806 constructed:
 807
 808     MyApp::Model::Foo->new({
 809         bar => 'baz',
 810         quux => 'frob',
 811         overrides => 'me',
 812     });
 813
 814 It's common practice to use a Moose attribute
 815 on the receiving component to access the config value.
 816
 817     package MyApp::Model::Foo;
 818
 819     use Moose;
 820
 821     # this attr will receive 'baz' at construction time
 822     has 'bar' => (
 823         is  => 'rw',
 824         isa => 'Str',
 825     );
 826
 827 You can then get the value 'baz' by calling $c->model('Foo')->bar
 828 (or $self->bar inside code in the model).
 829
 830 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
 831 as a way of reading config within your code, as this B<will not> give you the
 832 correctly merged config back. You B<MUST> take the config values supplied to
 833 the constructor and use those instead.
 834
 835 =cut
 836
 837 around config => sub {
 838     my $orig = shift;
 839     my $c = shift;
 840
 841     croak('Setting config after setup has been run is not allowed.')
 842         if ( @_ and $c->setup_finished );
 843
 844     $c->$orig(@_);
 845 };
 846
 847 =head2 $c->log
 848
 849 Returns the logging object instance. Unless it is already set, Catalyst
 850 sets this up with a L<Catalyst::Log> object. To use your own log class,
 851 set the logger with the C<< __PACKAGE__->log >> method prior to calling
 852 C<< __PACKAGE__->setup >>.
 853
 854  __PACKAGE__->log( MyLogger->new );
 855  __PACKAGE__->setup;
 856
 857 And later:
 858
 859     $c->log->info( 'Now logging with my own logger!' );
 860
 861 Your log class should implement the methods described in
 862 L<Catalyst::Log>.
 863
 864
 865 =head2 $c->debug
 866
 867 Returns 1 if debug mode is enabled, 0 otherwise.
 868
 869 You can enable debug mode in several ways:
 870
 871 =over
 872
 873 =item By calling myapp_server.pl with the -d flag
 874
 875 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
 876
 877 =item The -Debug option in your MyApp.pm
 878
 879 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
 880
 881 =back
 882
 883 The first three also set the log level to 'debug'.
 884
 885 Calling C<< $c->debug(1) >> has no effect.
 886
 887 =cut
 888
 889 sub debug { 0 }
 890
 891 =head2 $c->dispatcher
 892
 893 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
 894
 895 =head2 $c->engine
 896
 897 Returns the engine instance. See L<Catalyst::Engine>.
 898
 899
 900 =head2 UTILITY METHODS
 901
 902 =head2 $c->path_to(@path)
 903
 904 Merges C<@path> with C<< $c->config->{home} >> and returns a
 905 L<Path::Class::Dir> object. Note you can usually use this object as
 906 a filename, but sometimes you will have to explicitly stringify it
 907 yourself by calling the C<< ->stringify >> method.
 908
 909 For example:
 910
 911     $c->path_to( 'db', 'sqlite.db' );
 912
 913 =cut
 914
 915 sub path_to {
 916     my ( $c, @path ) = @_;
 917     my $path = Path::Class::Dir->new( $c->config->{home}, @path );
 918     if ( -d $path ) { return $path }
 919     else { return Path::Class::File->new( $c->config->{home}, @path ) }
 920 }
 921
 922 =head2 $c->plugin( $name, $class, @args )
 923
 924 Helper method for plugins. It creates a class data accessor/mutator and
 925 loads and instantiates the given class.
 926
 927     MyApp->plugin( 'prototype', 'HTML::Prototype' );
 928
 929     $c->prototype->define_javascript_functions;
 930
 931 B<Note:> This method of adding plugins is deprecated. The ability
 932 to add plugins like this B<will be removed> in a Catalyst 5.81.
 933 Please do not use this functionality in new code.
 934
 935 =cut
 936
 937 sub plugin {
 938     my ( $class, $name, $plugin, @args ) = @_;
 939
 940     # See block comment in t/unit_core_plugin.t
 941     $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
 942
 943     $class->_register_plugin( $plugin, 1 );
 944
 945     eval { $plugin->import };
 946     $class->mk_classdata($name);
 947     my $obj;
 948     eval { $obj = $plugin->new(@args) };
 949
 950     if ($@) {
 951         Catalyst::Exception->throw( message =>
 952               qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
 953     }
 954
 955     $class->$name($obj);
 956     $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
 957       if $class->debug;
 958 }
 959
 960 =head2 MyApp->setup
 961
 962 Initializes the dispatcher and engine, loads any plugins, and loads the
 963 model, view, and controller components. You may also specify an array
 964 of plugins to load here, if you choose to not load them in the C<use
 965 Catalyst> line.
 966
 967     MyApp->setup;
 968     MyApp->setup( qw/-Debug/ );
 969
 970 =cut
 971
 972 sub setup {
 973     my ( $class, @arguments ) = @_;
 974     croak('Running setup more than once')
 975         if ( $class->setup_finished );
 976
 977     unless ( $class->isa('Catalyst') ) {
 978
 979         Catalyst::Exception->throw(
 980             message => qq/'$class' does not inherit from Catalyst/ );
 981     }
 982
 983     if ( $class->arguments ) {
 984         @arguments = ( @arguments, @{ $class->arguments } );
 985     }
 986
 987     # Process options
 988     my $flags = {};
 989
 990     foreach (@arguments) {
 991
 992         if (/^-Debug$/) {
 993             $flags->{log} =
 994               ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
 995         }
 996         elsif (/^-(\w+)=?(.*)$/) {
 997             $flags->{ lc $1 } = $2;
 998         }
 999         else {
1000             push @{ $flags->{plugins} }, $_;
1001         }
1002     }
1003
1004     $class->setup_config();
1005     $class->setup_home( delete $flags->{home} );
1006
1007     $class->setup_log( delete $flags->{log} );
1008     $class->setup_plugins( delete $flags->{plugins} );
1009     $class->setup_dispatcher( delete $flags->{dispatcher} );
1010     $class->setup_engine( delete $flags->{engine} );
1011     $class->setup_stats( delete $flags->{stats} );
1012
1013     for my $flag ( sort keys %{$flags} ) {
1014
1015         if ( my $code = $class->can( 'setup_' . $flag ) ) {
1016             &$code( $class, delete $flags->{$flag} );
1017         }
1018         else {
1019             $class->log->warn(qq/Unknown flag "$flag"/);
1020         }
1021     }
1022
1023     eval { require Catalyst::Devel; };
1024     if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1025         $class->log->warn(<<"EOF");
1026 You are running an old script!
1027
1028   Please update by running (this will overwrite existing files):
1029     catalyst.pl -force -scripts $class
1030
1031   or (this will not overwrite existing files):
1032     catalyst.pl -scripts $class
1033
1034 EOF
1035     }
1036
1037     if ( $class->debug ) {
1038         my @plugins = map { "$_  " . ( $_->VERSION || '' ) } $class->registered_plugins;
1039
1040         if (@plugins) {
1041             my $column_width = Catalyst::Utils::term_width() - 6;
1042             my $t = Text::SimpleTable->new($column_width);
1043             $t->row($_) for @plugins;
1044             $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1045         }
1046
1047         my $dispatcher = $class->dispatcher;
1048         my $engine     = $class->engine;
1049         my $home       = $class->config->{home};
1050
1051         $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1052         $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1053
1054         $home
1055           ? ( -d $home )
1056           ? $class->log->debug(qq/Found home "$home"/)
1057           : $class->log->debug(qq/Home "$home" doesn't exist/)
1058           : $class->log->debug(q/Couldn't find home/);
1059     }
1060
1061     # Call plugins setup, this is stupid and evil.
1062     # Also screws C3 badly on 5.10, hack to avoid.
1063     {
1064         no warnings qw/redefine/;
1065         local *setup = sub { };
1066         $class->setup unless $Catalyst::__AM_RESTARTING;
1067     }
1068
1069     # Initialize our data structure
1070     $class->components( {} );
1071
1072     $class->setup_components;
1073
1074     if ( $class->debug ) {
1075         my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1076         my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1077         for my $comp ( sort keys %{ $class->components } ) {
1078             my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1079             $t->row( $comp, $type );
1080         }
1081         $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1082           if ( keys %{ $class->components } );
1083     }
1084
1085     # Add our self to components, since we are also a component
1086     if( $class->isa('Catalyst::Controller') ){
1087       $class->components->{$class} = $class;
1088     }
1089
1090     $class->setup_actions;
1091
1092     if ( $class->debug ) {
1093         my $name = $class->config->{name} || 'Application';
1094         $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1095     }
1096
1097     # Make sure that the application class becomes immutable at this point,
1098     B::Hooks::EndOfScope::on_scope_end {
1099         return if $@;
1100         my $meta = Class::MOP::get_metaclass_by_name($class);
1101         if (
1102             $meta->is_immutable
1103             && ! { $meta->immutable_options }->{replace_constructor}
1104             && (
1105                    $class->isa('Class::Accessor::Fast')
1106                 || $class->isa('Class::Accessor')
1107             )
1108         ) {
1109             warn "You made your application class ($class) immutable, "
1110                 . "but did not inline the\nconstructor. "
1111                 . "This will break catalyst, as your app \@ISA "
1112                 . "Class::Accessor(::Fast)?\nPlease pass "
1113                 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1114         }
1115         $meta->make_immutable(
1116             replace_constructor => 1,
1117         ) unless $meta->is_immutable;
1118     };
1119
1120     if ($class->config->{case_sensitive}) {
1121         $class->log->warn($class . "->config->{case_sensitive} is set.");
1122         $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1123     }
1124
1125     $class->setup_finalize;
1126     # Should be the last thing we do so that user things hooking
1127     # setup_finalize can log..
1128     $class->log->_flush() if $class->log->can('_flush');
1129     return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1130 }
1131
1132 =head2 $app->setup_finalize
1133
1134 A hook to attach modifiers to. This method does not do anything except set the
1135 C<setup_finished> accessor.
1136
1137 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1138
1139 Example:
1140
1141     after setup_finalize => sub {
1142         my $app = shift;
1143
1144         ## do stuff here..
1145     };
1146
1147 =cut
1148
1149 sub setup_finalize {
1150     my ($class) = @_;
1151     $class->setup_finished(1);
1152 }
1153
1154 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1155
1156 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1157
1158 Constructs an absolute L<URI> object based on the application root, the
1159 provided path, and the additional arguments and query parameters provided.
1160 When used as a string, provides a textual URI.  If you need more flexibility
1161 than this (i.e. the option to provide relative URIs etc.) see
1162 L<Catalyst::Plugin::SmartURI>.
1163
1164 If no arguments are provided, the URI for the current action is returned.
1165 To return the current action and also provide @args, use
1166 C<< $c->uri_for( $c->action, @args ) >>.
1167
1168 If the first argument is a string, it is taken as a public URI path relative
1169 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1170 relative to the application root (if it does). It is then merged with
1171 C<< $c->request->base >>; any C<@args> are appended as additional path
1172 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1173
1174 If the first argument is a L<Catalyst::Action> it represents an action which
1175 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1176 optional C<\@captures> argument (an arrayref) allows passing the captured
1177 variables that are needed to fill in the paths of Chained and Regex actions;
1178 once the path is resolved, C<uri_for> continues as though a path was
1179 provided, appending any arguments or parameters and creating an absolute
1180 URI.
1181
1182 The captures for the current request can be found in
1183 C<< $c->request->captures >>, and actions can be resolved using
1184 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1185 path, use C<< $c->uri_for_action >> instead.
1186
1187   # Equivalent to $c->req->uri
1188   $c->uri_for($c->action, $c->req->captures,
1189       @{ $c->req->args }, $c->req->params);
1190
1191   # For the Foo action in the Bar controller
1192   $c->uri_for($c->controller('Bar')->action_for('Foo'));
1193
1194   # Path to a static resource
1195   $c->uri_for('/static/images/logo.png');
1196
1197 =cut
1198
1199 sub uri_for {
1200     my ( $c, $path, @args ) = @_;
1201
1202     if (blessed($path) && $path->isa('Catalyst::Controller')) {
1203         $path = $path->path_prefix;
1204         $path =~ s{/+\z}{};
1205         $path .= '/';
1206     }
1207
1208     undef($path) if (defined $path && $path eq '');
1209
1210     my $params =
1211       ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1212
1213     carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1214     foreach my $arg (@args) {
1215         utf8::encode($arg) if utf8::is_utf8($arg);
1216         $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1217     }
1218
1219     if ( blessed($path) ) { # action object
1220         s|/|%2F|g for @args;
1221         my $captures = [ map { s|/|%2F|g; $_; }
1222                         ( scalar @args && ref $args[0] eq 'ARRAY'
1223                          ? @{ shift(@args) }
1224                          : ()) ];
1225
1226         foreach my $capture (@$captures) {
1227             utf8::encode($capture) if utf8::is_utf8($capture);
1228             $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1229         }
1230
1231         my $action = $path;
1232         $path = $c->dispatcher->uri_for_action($action, $captures);
1233         if (not defined $path) {
1234             $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1235                 if $c->debug;
1236             return undef;
1237         }
1238         $path = '/' if $path eq '';
1239     }
1240
1241     unshift(@args, $path);
1242
1243     unless (defined $path && $path =~ s!^/!!) { # in-place strip
1244         my $namespace = $c->namespace;
1245         if (defined $path) { # cheesy hack to handle path '../foo'
1246            $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1247         }
1248         unshift(@args, $namespace || '');
1249     }
1250
1251     # join args with '/', or a blank string
1252     my $args = join('/', grep { defined($_) } @args);
1253     $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1254     $args =~ s!^/+!!;
1255     my $base = $c->req->base;
1256     my $class = ref($base);
1257     $base =~ s{(?<!/)$}{/};
1258
1259     my $query = '';
1260
1261     if (my @keys = keys %$params) {
1262       # somewhat lifted from URI::_query's query_form
1263       $query = '?'.join('&', map {
1264           my $val = $params->{$_};
1265           s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1266           s/ /+/g;
1267           my $key = $_;
1268           $val = '' unless defined $val;
1269           (map {
1270               my $param = "$_";
1271               utf8::encode( $param ) if utf8::is_utf8($param);
1272               # using the URI::Escape pattern here so utf8 chars survive
1273               $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1274               $param =~ s/ /+/g;
1275               "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1276       } @keys);
1277     }
1278
1279     my $res = bless(\"${base}${args}${query}", $class);
1280     $res;
1281 }
1282
1283 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1284
1285 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1286
1287 =over
1288
1289 =item $path
1290
1291 A private path to the Catalyst action you want to create a URI for.
1292
1293 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1294 >> and passing the resulting C<$action> and the remaining arguments to C<<
1295 $c->uri_for >>.
1296
1297 You can also pass in a Catalyst::Action object, in which case it is passed to
1298 C<< $c->uri_for >>.
1299
1300 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
1301
1302 For example, if the action looks like:
1303
1304  package MyApp::Controller::Users;
1305
1306  sub lst : Path('the-list') {}
1307
1308 You can use:
1309
1310  $c->uri_for_action('/users/lst')
1311
1312 and it will create the URI /users/the-list.
1313
1314 =back
1315
1316 =cut
1317
1318 sub uri_for_action {
1319     my ( $c, $path, @args ) = @_;
1320     my $action = blessed($path)
1321       ? $path
1322       : $c->dispatcher->get_action_by_path($path);
1323     unless (defined $action) {
1324       croak "Can't find action for path '$path'";
1325     }
1326     return $c->uri_for( $action, @args );
1327 }
1328
1329 =head2 $c->welcome_message
1330
1331 Returns the Catalyst welcome HTML page.
1332
1333 =cut
1334
1335 sub welcome_message {
1336     my $c      = shift;
1337     my $name   = $c->config->{name};
1338     my $logo   = $c->uri_for('/static/images/catalyst_logo.png');
1339     my $prefix = Catalyst::Utils::appprefix( ref $c );
1340     $c->response->content_type('text/html; charset=utf-8');
1341     return <<"EOF";
1342 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1343     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1344 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1345     <head>
1346     <meta http-equiv="Content-Language" content="en" />
1347     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1348         <title>$name on Catalyst $VERSION</title>
1349         <style type="text/css">
1350             body {
1351                 color: #000;
1352                 background-color: #eee;
1353             }
1354             div#content {
1355                 width: 640px;
1356                 margin-left: auto;
1357                 margin-right: auto;
1358                 margin-top: 10px;
1359                 margin-bottom: 10px;
1360                 text-align: left;
1361                 background-color: #ccc;
1362                 border: 1px solid #aaa;
1363             }
1364             p, h1, h2 {
1365                 margin-left: 20px;
1366                 margin-right: 20px;
1367                 font-family: verdana, tahoma, sans-serif;
1368             }
1369             a {
1370                 font-family: verdana, tahoma, sans-serif;
1371             }
1372             :link, :visited {
1373                     text-decoration: none;
1374                     color: #b00;
1375                     border-bottom: 1px dotted #bbb;
1376             }
1377             :link:hover, :visited:hover {
1378                     color: #555;
1379             }
1380             div#topbar {
1381                 margin: 0px;
1382             }
1383             pre {
1384                 margin: 10px;
1385                 padding: 8px;
1386             }
1387             div#answers {
1388                 padding: 8px;
1389                 margin: 10px;
1390                 background-color: #fff;
1391                 border: 1px solid #aaa;
1392             }
1393             h1 {
1394                 font-size: 0.9em;
1395                 font-weight: normal;
1396                 text-align: center;
1397             }
1398             h2 {
1399                 font-size: 1.0em;
1400             }
1401             p {
1402                 font-size: 0.9em;
1403             }
1404             p img {
1405                 float: right;
1406                 margin-left: 10px;
1407             }
1408             span#appname {
1409                 font-weight: bold;
1410                 font-size: 1.6em;
1411             }
1412         </style>
1413     </head>
1414     <body>
1415         <div id="content">
1416             <div id="topbar">
1417                 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1418                     $VERSION</h1>
1419              </div>
1420              <div id="answers">
1421                  <p>
1422                  <img src="$logo" alt="Catalyst Logo" />
1423                  </p>
1424                  <p>Welcome to the  world of Catalyst.
1425                     This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1426                     framework will make web development something you had
1427                     never expected it to be: Fun, rewarding, and quick.</p>
1428                  <h2>What to do now?</h2>
1429                  <p>That really depends  on what <b>you</b> want to do.
1430                     We do, however, provide you with a few starting points.</p>
1431                  <p>If you want to jump right into web development with Catalyst
1432                     you might want to start with a tutorial.</p>
1433 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1434 </pre>
1435 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1436 <pre>
1437 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1438 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1439 </code></pre>
1440                  <h2>What to do next?</h2>
1441                  <p>Next it's time to write an actual application. Use the
1442                     helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&amp;mode=all">controllers</a>,
1443                     <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&amp;mode=all">models</a>, and
1444                     <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&amp;mode=all">views</a>;
1445                     they can save you a lot of work.</p>
1446                     <pre><code>script/${prefix}_create.pl --help</code></pre>
1447                     <p>Also, be sure to check out the vast and growing
1448                     collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1449                     you are likely to find what you need there.
1450                     </p>
1451
1452                  <h2>Need help?</h2>
1453                  <p>Catalyst has a very active community. Here are the main places to
1454                     get in touch with us.</p>
1455                  <ul>
1456                      <li>
1457                          <a href="http://dev.catalyst.perl.org">Wiki</a>
1458                      </li>
1459                      <li>
1460                          <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1461                      </li>
1462                      <li>
1463                          <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1464                      </li>
1465                  </ul>
1466                  <h2>In conclusion</h2>
1467                  <p>The Catalyst team hopes you will enjoy using Catalyst as much
1468                     as we enjoyed making it. Please contact us if you have ideas
1469                     for improvement or other feedback.</p>
1470              </div>
1471          </div>
1472     </body>
1473 </html>
1474 EOF
1475 }
1476
1477 =head1 INTERNAL METHODS
1478
1479 These methods are not meant to be used by end users.
1480
1481 =head2 $c->components
1482
1483 Returns a hash of components.
1484
1485 =cut
1486
1487 around components => sub {
1488     my $orig  = shift;
1489     my $class = shift;
1490     my $comps = shift;
1491
1492     return $class->$orig if ( !$comps );
1493
1494 # FIXME: should this ugly kludge exist?
1495     $class->setup_config unless defined $class->container;
1496
1497 # FIXME: should there be a warning here, not to use this accessor to create the components?
1498     my $components = {};
1499
1500     my $containers;
1501     $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1502
1503     for my $component ( keys %$comps ) {
1504         $components->{ $component } = $comps->{$component};
1505
1506         my ($type, $name) = _get_component_type_name($component);
1507
1508 # FIXME: shouldn't the service name be $name?
1509         $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1510     }
1511
1512     return $class->$orig($components);
1513 };
1514
1515 =head2 $c->context_class
1516
1517 Returns or sets the context class.
1518
1519 =head2 $c->counter
1520
1521 Returns a hashref containing coderefs and execution counts (needed for
1522 deep recursion detection).
1523
1524 =head2 $c->depth
1525
1526 Returns the number of actions on the current internal execution stack.
1527
1528 =head2 $c->dispatch
1529
1530 Dispatches a request to actions.
1531
1532 =cut
1533
1534 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1535
1536 =head2 $c->dispatcher_class
1537
1538 Returns or sets the dispatcher class.
1539
1540 =head2 $c->dump_these
1541
1542 Returns a list of 2-element array references (name, structure) pairs
1543 that will be dumped on the error page in debug mode.
1544
1545 =cut
1546
1547 sub dump_these {
1548     my $c = shift;
1549     [ Request => $c->req ],
1550     [ Response => $c->res ],
1551     [ Stash => $c->stash ],
1552     [ Config => $c->config ];
1553 }
1554
1555 =head2 $c->engine_class
1556
1557 Returns or sets the engine class.
1558
1559 =head2 $c->execute( $class, $coderef )
1560
1561 Execute a coderef in given class and catch exceptions. Errors are available
1562 via $c->error.
1563
1564 =cut
1565
1566 sub execute {
1567     my ( $c, $class, $code ) = @_;
1568     $class = $c->component($class) || $class;
1569     $c->state(0);
1570
1571     if ( $c->depth >= $RECURSION ) {
1572         my $action = $code->reverse();
1573         $action = "/$action" unless $action =~ /->/;
1574         my $error = qq/Deep recursion detected calling "${action}"/;
1575         $c->log->error($error);
1576         $c->error($error);
1577         $c->state(0);
1578         return $c->state;
1579     }
1580
1581     my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1582
1583     push( @{ $c->stack }, $code );
1584
1585     no warnings 'recursion';
1586     # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1587     #      I have no idea how, ergo $ret (which appears to fix the issue)
1588     eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1589
1590     $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1591
1592     my $last = pop( @{ $c->stack } );
1593
1594     if ( my $error = $@ ) {
1595         if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1596             $error->rethrow if $c->depth > 1;
1597         }
1598         elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1599             $error->rethrow if $c->depth > 0;
1600         }
1601         else {
1602             unless ( ref $error ) {
1603                 no warnings 'uninitialized';
1604                 chomp $error;
1605                 my $class = $last->class;
1606                 my $name  = $last->name;
1607                 $error = qq/Caught exception in $class->$name "$error"/;
1608             }
1609             $c->error($error);
1610         }
1611         $c->state(0);
1612     }
1613     return $c->state;
1614 }
1615
1616 sub _stats_start_execute {
1617     my ( $c, $code ) = @_;
1618     my $appclass = ref($c) || $c;
1619     return if ( ( $code->name =~ /^_.*/ )
1620         && ( !$appclass->config->{show_internal_actions} ) );
1621
1622     my $action_name = $code->reverse();
1623     $c->counter->{$action_name}++;
1624
1625     my $action = $action_name;
1626     $action = "/$action" unless $action =~ /->/;
1627
1628     # determine if the call was the result of a forward
1629     # this is done by walking up the call stack and looking for a calling
1630     # sub of Catalyst::forward before the eval
1631     my $callsub = q{};
1632     for my $index ( 2 .. 11 ) {
1633         last
1634         if ( ( caller($index) )[0] eq 'Catalyst'
1635             && ( caller($index) )[3] eq '(eval)' );
1636
1637         if ( ( caller($index) )[3] =~ /forward$/ ) {
1638             $callsub = ( caller($index) )[3];
1639             $action  = "-> $action";
1640             last;
1641         }
1642     }
1643
1644     my $uid = $action_name . $c->counter->{$action_name};
1645
1646     # is this a root-level call or a forwarded call?
1647     if ( $callsub =~ /forward$/ ) {
1648         my $parent = $c->stack->[-1];
1649
1650         # forward, locate the caller
1651         if ( defined $parent && exists $c->counter->{"$parent"} ) {
1652             $c->stats->profile(
1653                 begin  => $action,
1654                 parent => "$parent" . $c->counter->{"$parent"},
1655                 uid    => $uid,
1656             );
1657         }
1658         else {
1659
1660             # forward with no caller may come from a plugin
1661             $c->stats->profile(
1662                 begin => $action,
1663                 uid   => $uid,
1664             );
1665         }
1666     }
1667     else {
1668
1669         # root-level call
1670         $c->stats->profile(
1671             begin => $action,
1672             uid   => $uid,
1673         );
1674     }
1675     return $action;
1676
1677 }
1678
1679 sub _stats_finish_execute {
1680     my ( $c, $info ) = @_;
1681     $c->stats->profile( end => $info );
1682 }
1683
1684 =head2 $c->finalize
1685
1686 Finalizes the request.
1687
1688 =cut
1689
1690 sub finalize {
1691     my $c = shift;
1692
1693     for my $error ( @{ $c->error } ) {
1694         $c->log->error($error);
1695     }
1696
1697     # Allow engine to handle finalize flow (for POE)
1698     my $engine = $c->engine;
1699     if ( my $code = $engine->can('finalize') ) {
1700         $engine->$code($c);
1701     }
1702     else {
1703
1704         $c->finalize_uploads;
1705
1706         # Error
1707         if ( $#{ $c->error } >= 0 ) {
1708             $c->finalize_error;
1709         }
1710
1711         $c->finalize_headers;
1712
1713         # HEAD request
1714         if ( $c->request->method eq 'HEAD' ) {
1715             $c->response->body('');
1716         }
1717
1718         $c->finalize_body;
1719     }
1720
1721     $c->log_response;
1722
1723     if ($c->use_stats) {
1724         my $elapsed = sprintf '%f', $c->stats->elapsed;
1725         my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1726         $c->log->info(
1727             "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1728     }
1729
1730     return $c->response->status;
1731 }
1732
1733 =head2 $c->finalize_body
1734
1735 Finalizes body.
1736
1737 =cut
1738
1739 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1740
1741 =head2 $c->finalize_cookies
1742
1743 Finalizes cookies.
1744
1745 =cut
1746
1747 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1748
1749 =head2 $c->finalize_error
1750
1751 Finalizes error.
1752
1753 =cut
1754
1755 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1756
1757 =head2 $c->finalize_headers
1758
1759 Finalizes headers.
1760
1761 =cut
1762
1763 sub finalize_headers {
1764     my $c = shift;
1765
1766     my $response = $c->response; #accessor calls can add up?
1767
1768     # Check if we already finalized headers
1769     return if $response->finalized_headers;
1770
1771     # Handle redirects
1772     if ( my $location = $response->redirect ) {
1773         $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1774         $response->header( Location => $location );
1775
1776         if ( !$response->has_body ) {
1777             # Add a default body if none is already present
1778             $response->body(
1779                 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1780             );
1781         }
1782     }
1783
1784     # Content-Length
1785     if ( defined $response->body && length $response->body && !$response->content_length ) {
1786
1787         # get the length from a filehandle
1788         if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1789         {
1790             my $stat = stat $response->body;
1791             if ( $stat && $stat->size > 0 ) {
1792                 $response->content_length( $stat->size );
1793             }
1794             else {
1795                 $c->log->warn('Serving filehandle without a content-length');
1796             }
1797         }
1798         else {
1799             # everything should be bytes at this point, but just in case
1800             $response->content_length( length( $response->body ) );
1801         }
1802     }
1803
1804     # Errors
1805     if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1806         $response->headers->remove_header("Content-Length");
1807         $response->body('');
1808     }
1809
1810     $c->finalize_cookies;
1811
1812     $c->engine->finalize_headers( $c, @_ );
1813
1814     # Done
1815     $response->finalized_headers(1);
1816 }
1817
1818 =head2 $c->finalize_output
1819
1820 An alias for finalize_body.
1821
1822 =head2 $c->finalize_read
1823
1824 Finalizes the input after reading is complete.
1825
1826 =cut
1827
1828 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1829
1830 =head2 $c->finalize_uploads
1831
1832 Finalizes uploads. Cleans up any temporary files.
1833
1834 =cut
1835
1836 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1837
1838 =head2 $c->get_action( $action, $namespace )
1839
1840 Gets an action in a given namespace.
1841
1842 =cut
1843
1844 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1845
1846 =head2 $c->get_actions( $action, $namespace )
1847
1848 Gets all actions of a given name in a namespace and all parent
1849 namespaces.
1850
1851 =cut
1852
1853 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1854
1855 =head2 $app->handle_request( @arguments )
1856
1857 Called to handle each HTTP request.
1858
1859 =cut
1860
1861 sub handle_request {
1862     my ( $class, @arguments ) = @_;
1863
1864     # Always expect worst case!
1865     my $status = -1;
1866     eval {
1867         if ($class->debug) {
1868             my $secs = time - $START || 1;
1869             my $av = sprintf '%.3f', $COUNT / $secs;
1870             my $time = localtime time;
1871             $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1872         }
1873
1874         my $c = $class->prepare(@arguments);
1875         $c->dispatch;
1876         $status = $c->finalize;
1877     };
1878
1879     if ( my $error = $@ ) {
1880         chomp $error;
1881         $class->log->error(qq/Caught exception in engine "$error"/);
1882     }
1883
1884     $COUNT++;
1885
1886     if(my $coderef = $class->log->can('_flush')){
1887         $class->log->$coderef();
1888     }
1889     return $status;
1890 }
1891
1892 =head2 $c->prepare( @arguments )
1893
1894 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1895 etc.).
1896
1897 =cut
1898
1899 sub prepare {
1900     my ( $class, @arguments ) = @_;
1901
1902     # XXX
1903     # After the app/ctxt split, this should become an attribute based on something passed
1904     # into the application.
1905     $class->context_class( ref $class || $class ) unless $class->context_class;
1906
1907     my $c = $class->context_class->new({});
1908
1909     # For on-demand data
1910     $c->request->_context($c);
1911     $c->response->_context($c);
1912
1913     #surely this is not the most efficient way to do things...
1914     $c->stats($class->stats_class->new)->enable($c->use_stats);
1915     if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1916         $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1917     }
1918
1919     #XXX reuse coderef from can
1920     # Allow engine to direct the prepare flow (for POE)
1921     if ( $c->engine->can('prepare') ) {
1922         $c->engine->prepare( $c, @arguments );
1923     }
1924     else {
1925         $c->prepare_request(@arguments);
1926         $c->prepare_connection;
1927         $c->prepare_query_parameters;
1928         $c->prepare_headers;
1929         $c->prepare_cookies;
1930         $c->prepare_path;
1931
1932         # Prepare the body for reading, either by prepare_body
1933         # or the user, if they are using $c->read
1934         $c->prepare_read;
1935
1936         # Parse the body unless the user wants it on-demand
1937         unless ( ref($c)->config->{parse_on_demand} ) {
1938             $c->prepare_body;
1939         }
1940     }
1941
1942     my $method  = $c->req->method  || '';
1943     my $path    = $c->req->path;
1944     $path       = '/' unless length $path;
1945     my $address = $c->req->address || '';
1946
1947     $c->log_request;
1948
1949     $c->prepare_action;
1950
1951     return $c;
1952 }
1953
1954 =head2 $c->prepare_action
1955
1956 Prepares action. See L<Catalyst::Dispatcher>.
1957
1958 =cut
1959
1960 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1961
1962 =head2 $c->prepare_body
1963
1964 Prepares message body.
1965
1966 =cut
1967
1968 sub prepare_body {
1969     my $c = shift;
1970
1971     return if $c->request->_has_body;
1972
1973     # Initialize on-demand data
1974     $c->engine->prepare_body( $c, @_ );
1975     $c->prepare_parameters;
1976     $c->prepare_uploads;
1977 }
1978
1979 =head2 $c->prepare_body_chunk( $chunk )
1980
1981 Prepares a chunk of data before sending it to L<HTTP::Body>.
1982
1983 See L<Catalyst::Engine>.
1984
1985 =cut
1986
1987 sub prepare_body_chunk {
1988     my $c = shift;
1989     $c->engine->prepare_body_chunk( $c, @_ );
1990 }
1991
1992 =head2 $c->prepare_body_parameters
1993
1994 Prepares body parameters.
1995
1996 =cut
1997
1998 sub prepare_body_parameters {
1999     my $c = shift;
2000     $c->engine->prepare_body_parameters( $c, @_ );
2001 }
2002
2003 =head2 $c->prepare_connection
2004
2005 Prepares connection.
2006
2007 =cut
2008
2009 sub prepare_connection {
2010     my $c = shift;
2011     $c->engine->prepare_connection( $c, @_ );
2012 }
2013
2014 =head2 $c->prepare_cookies
2015
2016 Prepares cookies.
2017
2018 =cut
2019
2020 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2021
2022 =head2 $c->prepare_headers
2023
2024 Prepares headers.
2025
2026 =cut
2027
2028 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2029
2030 =head2 $c->prepare_parameters
2031
2032 Prepares parameters.
2033
2034 =cut
2035
2036 sub prepare_parameters {
2037     my $c = shift;
2038     $c->prepare_body_parameters;
2039     $c->engine->prepare_parameters( $c, @_ );
2040 }
2041
2042 =head2 $c->prepare_path
2043
2044 Prepares path and base.
2045
2046 =cut
2047
2048 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2049
2050 =head2 $c->prepare_query_parameters
2051
2052 Prepares query parameters.
2053
2054 =cut
2055
2056 sub prepare_query_parameters {
2057     my $c = shift;
2058
2059     $c->engine->prepare_query_parameters( $c, @_ );
2060 }
2061
2062 =head2 $c->log_request
2063
2064 Writes information about the request to the debug logs.  This includes:
2065
2066 =over 4
2067
2068 =item * Request method, path, and remote IP address
2069
2070 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2071
2072 =item * Request parameters
2073
2074 =item * File uploads
2075
2076 =back
2077
2078 =cut
2079
2080 sub log_request {
2081     my $c = shift;
2082
2083     return unless $c->debug;
2084
2085     my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2086     my $request = $dump->[1];
2087
2088     my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2089     $method ||= '';
2090     $path = '/' unless length $path;
2091     $address ||= '';
2092     $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2093
2094     $c->log_request_headers($request->headers);
2095
2096     if ( my $keywords = $request->query_keywords ) {
2097         $c->log->debug("Query keywords are: $keywords");
2098     }
2099
2100     $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2101
2102     $c->log_request_uploads($request);
2103 }
2104
2105 =head2 $c->log_response
2106
2107 Writes information about the response to the debug logs by calling
2108 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2109
2110 =cut
2111
2112 sub log_response {
2113     my $c = shift;
2114
2115     return unless $c->debug;
2116
2117     my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2118     my $response = $dump->[1];
2119
2120     $c->log_response_status_line($response);
2121     $c->log_response_headers($response->headers);
2122 }
2123
2124 =head2 $c->log_response_status_line($response)
2125
2126 Writes one line of information about the response to the debug logs.  This includes:
2127
2128 =over 4
2129
2130 =item * Response status code
2131
2132 =item * Content-Type header (if present)
2133
2134 =item * Content-Length header (if present)
2135
2136 =back
2137
2138 =cut
2139
2140 sub log_response_status_line {
2141     my ($c, $response) = @_;
2142
2143     $c->log->debug(
2144         sprintf(
2145             'Response Code: %s; Content-Type: %s; Content-Length: %s',
2146             $response->status                            || 'unknown',
2147             $response->headers->header('Content-Type')   || 'unknown',
2148             $response->headers->header('Content-Length') || 'unknown'
2149         )
2150     );
2151 }
2152
2153 =head2 $c->log_response_headers($headers);
2154
2155 Hook method which can be wrapped by plugins to log the responseheaders.
2156 No-op in the default implementation.
2157
2158 =cut
2159
2160 sub log_response_headers {}
2161
2162 =head2 $c->log_request_parameters( query => {}, body => {} )
2163
2164 Logs request parameters to debug logs
2165
2166 =cut
2167
2168 sub log_request_parameters {
2169     my $c          = shift;
2170     my %all_params = @_;
2171
2172     return unless $c->debug;
2173
2174     my $column_width = Catalyst::Utils::term_width() - 44;
2175     foreach my $type (qw(query body)) {
2176         my $params = $all_params{$type};
2177         next if ! keys %$params;
2178         my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2179         for my $key ( sort keys %$params ) {
2180             my $param = $params->{$key};
2181             my $value = defined($param) ? $param : '';
2182             $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2183         }
2184         $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2185     }
2186 }
2187
2188 =head2 $c->log_request_uploads
2189
2190 Logs file uploads included in the request to the debug logs.
2191 The parameter name, filename, file type, and file size are all included in
2192 the debug logs.
2193
2194 =cut
2195
2196 sub log_request_uploads {
2197     my $c = shift;
2198     my $request = shift;
2199     return unless $c->debug;
2200     my $uploads = $request->uploads;
2201     if ( keys %$uploads ) {
2202         my $t = Text::SimpleTable->new(
2203             [ 12, 'Parameter' ],
2204             [ 26, 'Filename' ],
2205             [ 18, 'Type' ],
2206             [ 9,  'Size' ]
2207         );
2208         for my $key ( sort keys %$uploads ) {
2209             my $upload = $uploads->{$key};
2210             for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2211                 $t->row( $key, $u->filename, $u->type, $u->size );
2212             }
2213         }
2214         $c->log->debug( "File Uploads are:\n" . $t->draw );
2215     }
2216 }
2217
2218 =head2 $c->log_request_headers($headers);
2219
2220 Hook method which can be wrapped by plugins to log the request headers.
2221 No-op in the default implementation.
2222
2223 =cut
2224
2225 sub log_request_headers {}
2226
2227 =head2 $c->log_headers($type => $headers)
2228
2229 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2230
2231 =cut
2232
2233 sub log_headers {
2234     my $c       = shift;
2235     my $type    = shift;
2236     my $headers = shift;    # an HTTP::Headers instance
2237
2238     return unless $c->debug;
2239
2240     my $column_width = Catalyst::Utils::term_width() - 28;
2241     my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2242     $headers->scan(
2243         sub {
2244             my ( $name, $value ) = @_;
2245             $t->row( $name, $value );
2246         }
2247     );
2248     $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2249 }
2250
2251
2252 =head2 $c->prepare_read
2253
2254 Prepares the input for reading.
2255
2256 =cut
2257
2258 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2259
2260 =head2 $c->prepare_request
2261
2262 Prepares the engine request.
2263
2264 =cut
2265
2266 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2267
2268 =head2 $c->prepare_uploads
2269
2270 Prepares uploads.
2271
2272 =cut
2273
2274 sub prepare_uploads {
2275     my $c = shift;
2276
2277     $c->engine->prepare_uploads( $c, @_ );
2278 }
2279
2280 =head2 $c->prepare_write
2281
2282 Prepares the output for writing.
2283
2284 =cut
2285
2286 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2287
2288 =head2 $c->request_class
2289
2290 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2291
2292 =head2 $c->response_class
2293
2294 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2295
2296 =head2 $c->read( [$maxlength] )
2297
2298 Reads a chunk of data from the request body. This method is designed to
2299 be used in a while loop, reading C<$maxlength> bytes on every call.
2300 C<$maxlength> defaults to the size of the request if not specified.
2301
2302 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2303 directly.
2304
2305 Warning: If you use read(), Catalyst will not process the body,
2306 so you will not be able to access POST parameters or file uploads via
2307 $c->request.  You must handle all body parsing yourself.
2308
2309 =cut
2310
2311 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2312
2313 =head2 $c->run
2314
2315 Starts the engine.
2316
2317 =cut
2318
2319 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2320
2321 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2322
2323 Sets an action in a given namespace.
2324
2325 =cut
2326
2327 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2328
2329 =head2 $c->setup_actions($component)
2330
2331 Sets up actions for a component.
2332
2333 =cut
2334
2335 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2336
2337 =head2 $c->setup_config
2338
2339 =cut
2340
2341 sub setup_config {
2342     my $class = shift;
2343
2344     my %args = %{ $class->config || {} };
2345
2346     my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2347     unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2348
2349     my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2350
2351     my $container = $container_class->new( %args, name => "$class" );
2352     $class->container($container);
2353
2354     my $config = $container->resolve(service => 'config');
2355     $class->config($config);
2356     $class->finalize_config; # back-compat
2357 }
2358
2359 =head2 $c->finalize_config
2360
2361 =cut
2362
2363 sub finalize_config { }
2364
2365 =head2 $c->setup_components
2366
2367 This method is called internally to set up the application's components.
2368
2369 It finds modules by calling the L<locate_components> method, expands them to
2370 package names with the L<expand_component_module> method, and then installs
2371 each component into the application.
2372
2373 The C<setup_components> config option is passed to both of the above methods.
2374
2375 Installation of each component is performed by the L<setup_component> method,
2376 below.
2377
2378 =cut
2379
2380 sub setup_components {
2381     my $class = shift;
2382
2383     my $config  = $class->config->{ setup_components };
2384
2385     my @comps = $class->locate_components($config);
2386     my %comps = map { $_ => 1 } @comps;
2387
2388     my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2389     $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2390         qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2391     ) if $deprecatedcatalyst_component_names;
2392
2393     for my $component ( @comps ) {
2394
2395         # We pass ignore_loaded here so that overlay files for (e.g.)
2396         # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2397         # we know M::P::O found a file on disk so this is safe
2398
2399         Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2400     }
2401
2402     my $containers;
2403     $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2404
2405     for my $component (@comps) {
2406         my $instance = $class->components->{ $component } = $class->setup_component($component);
2407         if ( my ($type, $name) = _get_component_type_name($component) ) {
2408             $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2409         }
2410         my @expanded_components = $instance->can('expand_modules')
2411             ? $instance->expand_modules( $component, $config )
2412             : $class->expand_component_module( $component, $config );
2413         for my $component (@expanded_components) {
2414             next if $comps{$component};
2415
2416             $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2417             $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2418                 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2419             ) if $deprecatedcatalyst_component_names;
2420
2421             if (my ($type, $name) = _get_component_type_name($component)) {
2422                 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2423             }
2424
2425             $class->components->{ $component } = $class->setup_component($component);
2426         }
2427     }
2428 }
2429
2430 sub _get_component_type_name {
2431     my $component = shift;
2432     my @parts     = split /::/, $component;
2433
2434     while (my $type = shift @parts) {
2435         return ('controller', join '::', @parts)
2436             if $type =~ /^(c|controller)$/i;
2437
2438         return ('model', join '::', @parts)
2439             if $type =~ /^(m|model)$/i;
2440
2441         return ('view', join '::', @parts)
2442             if $type =~ /^(v|view)$/i;
2443     }
2444 }
2445
2446 =head2 $c->locate_components( $setup_component_config )
2447
2448 This method is meant to provide a list of component modules that should be
2449 setup for the application.  By default, it will use L<Module::Pluggable>.
2450
2451 Specify a C<setup_components> config option to pass additional options directly
2452 to L<Module::Pluggable>. To add additional search paths, specify a key named
2453 C<search_extra> as an array reference. Items in the array beginning with C<::>
2454 will have the application class name prepended to them.
2455
2456 =cut
2457
2458 sub locate_components {
2459     my $class  = shift;
2460     my $config = shift;
2461
2462     my @paths   = qw( ::Controller ::C ::Model ::M ::View ::V );
2463     my $extra   = delete $config->{ search_extra } || [];
2464
2465     push @paths, @$extra;
2466
2467     my $locator = Module::Pluggable::Object->new(
2468         search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2469         %$config
2470     );
2471
2472     # XXX think about ditching this sort entirely
2473     my @comps = sort { length $a <=> length $b } $locator->plugins;
2474
2475     return @comps;
2476 }
2477
2478 =head2 $c->expand_component_module( $component, $setup_component_config )
2479
2480 Components found by C<locate_components> will be passed to this method, which
2481 is expected to return a list of component (package) names to be set up.
2482
2483 =cut
2484
2485 sub expand_component_module {
2486     my ($class, $module) = @_;
2487     return Devel::InnerPackage::list_packages( $module );
2488 }
2489
2490 =head2 $c->setup_component
2491
2492 =cut
2493
2494 sub setup_component {
2495     my( $class, $component ) = @_;
2496
2497     unless ( $component->can( 'COMPONENT' ) ) {
2498         return $component;
2499     }
2500
2501     my $suffix = Catalyst::Utils::class2classsuffix( $component );
2502     my $config = $class->config->{ $suffix } || {};
2503     # Stash catalyst_component_name in the config here, so that custom COMPONENT
2504     # methods also pass it. local to avoid pointlessly shitting in config
2505     # for the debug screen, as $component is already the key name.
2506     local $config->{catalyst_component_name} = $component;
2507
2508     my $instance = eval { $component->COMPONENT( $class, $config ); };
2509
2510     if ( my $error = $@ ) {
2511         chomp $error;
2512         Catalyst::Exception->throw(
2513             message => qq/Couldn't instantiate component "$component", "$error"/
2514         );
2515     }
2516     elsif (!blessed $instance) {
2517         my $metaclass = Moose::Util::find_meta($component);
2518         my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2519         my $component_method_from = $method_meta->associated_metaclass->name;
2520         my $value = defined($instance) ? $instance : 'undef';
2521         Catalyst::Exception->throw(
2522             message =>
2523             qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2524         );
2525     }
2526
2527     return $instance;
2528 }
2529
2530 =head2 $c->setup_dispatcher
2531
2532 Sets up dispatcher.
2533
2534 =cut
2535
2536 sub setup_dispatcher {
2537     my ( $class, $dispatcher ) = @_;
2538
2539     if ($dispatcher) {
2540         $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2541     }
2542
2543     if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2544         $dispatcher = 'Catalyst::Dispatcher::' . $env;
2545     }
2546
2547     unless ($dispatcher) {
2548         $dispatcher = $class->dispatcher_class;
2549     }
2550
2551     Class::MOP::load_class($dispatcher);
2552
2553     # dispatcher instance
2554     $class->dispatcher( $dispatcher->new );
2555 }
2556
2557 =head2 $c->setup_engine
2558
2559 Sets up engine.
2560
2561 =cut
2562
2563 sub setup_engine {
2564     my ( $class, $engine ) = @_;
2565
2566     if ($engine) {
2567         $engine = 'Catalyst::Engine::' . $engine;
2568     }
2569
2570     if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2571         $engine = 'Catalyst::Engine::' . $env;
2572     }
2573
2574     if ( $ENV{MOD_PERL} ) {
2575         my $meta = Class::MOP::get_metaclass_by_name($class);
2576
2577         # create the apache method
2578         $meta->add_method('apache' => sub { shift->engine->apache });
2579
2580         my ( $software, $version ) =
2581           $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2582
2583         $version =~ s/_//g;
2584         $version =~ s/(\.[^.]+)\./$1/g;
2585
2586         if ( $software eq 'mod_perl' ) {
2587
2588             if ( !$engine ) {
2589
2590                 if ( $version >= 1.99922 ) {
2591                     $engine = 'Catalyst::Engine::Apache2::MP20';
2592                 }
2593
2594                 elsif ( $version >= 1.9901 ) {
2595                     $engine = 'Catalyst::Engine::Apache2::MP19';
2596                 }
2597
2598                 elsif ( $version >= 1.24 ) {
2599                     $engine = 'Catalyst::Engine::Apache::MP13';
2600                 }
2601
2602                 else {
2603                     Catalyst::Exception->throw( message =>
2604                           qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2605                 }
2606
2607             }
2608
2609             # install the correct mod_perl handler
2610             if ( $version >= 1.9901 ) {
2611                 *handler = sub  : method {
2612                     shift->handle_request(@_);
2613                 };
2614             }
2615             else {
2616                 *handler = sub ($$) { shift->handle_request(@_) };
2617             }
2618
2619         }
2620
2621         elsif ( $software eq 'Zeus-Perl' ) {
2622             $engine = 'Catalyst::Engine::Zeus';
2623         }
2624
2625         else {
2626             Catalyst::Exception->throw(
2627                 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2628         }
2629     }
2630
2631     unless ($engine) {
2632         $engine = $class->engine_class;
2633     }
2634
2635     Class::MOP::load_class($engine);
2636
2637     # check for old engines that are no longer compatible
2638     my $old_engine;
2639     if ( $engine->isa('Catalyst::Engine::Apache')
2640         && !Catalyst::Engine::Apache->VERSION )
2641     {
2642         $old_engine = 1;
2643     }
2644
2645     elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2646         && Catalyst::Engine::Server->VERSION le '0.02' )
2647     {
2648         $old_engine = 1;
2649     }
2650
2651     elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2652         && $engine->VERSION eq '0.01' )
2653     {
2654         $old_engine = 1;
2655     }
2656
2657     elsif ($engine->isa('Catalyst::Engine::Zeus')
2658         && $engine->VERSION eq '0.01' )
2659     {
2660         $old_engine = 1;
2661     }
2662
2663     if ($old_engine) {
2664         Catalyst::Exception->throw( message =>
2665               qq/Engine "$engine" is not supported by this version of Catalyst/
2666         );
2667     }
2668
2669     # engine instance
2670     $class->engine( $engine->new );
2671 }
2672
2673 =head2 $c->setup_home
2674
2675 Sets up the home directory.
2676
2677 =cut
2678
2679 sub setup_home {
2680     my ( $class, $home ) = @_;
2681
2682     if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2683         $home = $env;
2684     }
2685
2686     $home ||= Catalyst::Utils::home($class);
2687
2688     if ($home) {
2689         #I remember recently being scolded for assigning config values like this
2690         $class->config->{home} ||= $home;
2691         $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2692     }
2693 }
2694
2695 =head2 $c->setup_log
2696
2697 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2698 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2699 log to.
2700
2701 This method also installs a C<debug> method that returns a true value into the
2702 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2703 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2704
2705 Note that if the log has already been setup, by either a previous call to
2706 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2707 that this method won't actually set up the log object.
2708
2709 =cut
2710
2711 sub setup_log {
2712     my ( $class, $levels ) = @_;
2713
2714     $levels ||= '';
2715     $levels =~ s/^\s+//;
2716     $levels =~ s/\s+$//;
2717     my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2718
2719     my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2720     if ( defined $env_debug ) {
2721         $levels{debug} = 1 if $env_debug; # Ugly!
2722         delete($levels{debug}) unless $env_debug;
2723     }
2724
2725     unless ( $class->log ) {
2726         $class->log( Catalyst::Log->new(keys %levels) );
2727     }
2728
2729     if ( $levels{debug} ) {
2730         Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2731         $class->log->debug('Debug messages enabled');
2732     }
2733 }
2734
2735 =head2 $c->setup_plugins
2736
2737 Sets up plugins.
2738
2739 =cut
2740
2741 =head2 $c->setup_stats
2742
2743 Sets up timing statistics class.
2744
2745 =cut
2746
2747 sub setup_stats {
2748     my ( $class, $stats ) = @_;
2749
2750     Catalyst::Utils::ensure_class_loaded($class->stats_class);
2751
2752     my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2753     if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2754         Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2755         $class->log->debug('Statistics enabled');
2756     }
2757 }
2758
2759
2760 =head2 $c->registered_plugins
2761
2762 Returns a sorted list of the plugins which have either been stated in the
2763 import list or which have been added via C<< MyApp->plugin(@args); >>.
2764
2765 If passed a given plugin name, it will report a boolean value indicating
2766 whether or not that plugin is loaded.  A fully qualified name is required if
2767 the plugin name does not begin with C<Catalyst::Plugin::>.
2768
2769  if ($c->registered_plugins('Some::Plugin')) {
2770      ...
2771  }
2772
2773 =cut
2774
2775 {
2776
2777     sub registered_plugins {
2778         my $proto = shift;
2779         return sort keys %{ $proto->_plugins } unless @_;
2780         my $plugin = shift;
2781         return 1 if exists $proto->_plugins->{$plugin};
2782         return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2783     }
2784
2785     sub _register_plugin {
2786         my ( $proto, $plugin, $instant ) = @_;
2787         my $class = ref $proto || $proto;
2788
2789         Class::MOP::load_class( $plugin );
2790         $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2791             if $plugin->isa( 'Catalyst::Component' );
2792         $proto->_plugins->{$plugin} = 1;
2793         unless ($instant) {
2794             my $meta = Class::MOP::get_metaclass_by_name($class);
2795             $meta->superclasses($plugin, $meta->superclasses);
2796         }
2797         return $class;
2798     }
2799
2800     sub setup_plugins {
2801         my ( $class, $plugins ) = @_;
2802
2803         $class->_plugins( {} ) unless $class->_plugins;
2804         $plugins = Data::OptList::mkopt($plugins || []);
2805
2806         my @plugins = map {
2807             [ Catalyst::Utils::resolve_namespace(
2808                   $class . '::Plugin',
2809                   'Catalyst::Plugin', $_->[0]
2810               ),
2811               $_->[1],
2812             ]
2813          } @{ $plugins };
2814
2815         for my $plugin ( reverse @plugins ) {
2816             Class::MOP::load_class($plugin->[0], $plugin->[1]);
2817             my $meta = find_meta($plugin->[0]);
2818             next if $meta && $meta->isa('Moose::Meta::Role');
2819
2820             $class->_register_plugin($plugin->[0]);
2821         }
2822
2823         my @roles =
2824             map  { $_->[0]->name, $_->[1] }
2825             grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2826             map  { [find_meta($_->[0]), $_->[1]] }
2827             @plugins;
2828
2829         Moose::Util::apply_all_roles(
2830             $class => @roles
2831         ) if @roles;
2832     }
2833 }
2834
2835 =head2 $c->stack
2836
2837 Returns an arrayref of the internal execution stack (actions that are
2838 currently executing).
2839
2840 =head2 $c->stats
2841
2842 Returns the current timing statistics object. By default Catalyst uses
2843 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2844 L<< stats_class|/"$c->stats_class" >>.
2845
2846 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2847 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2848 profile explicitly, although MyApp.pm still won't profile nor output anything
2849 by itself.
2850
2851 =head2 $c->stats_class
2852
2853 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2854
2855 =head2 $c->use_stats
2856
2857 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2858
2859 Note that this is a static method, not an accessor and should be overridden
2860 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2861
2862 =cut
2863
2864 sub use_stats { 0 }
2865
2866
2867 =head2 $c->write( $data )
2868
2869 Writes $data to the output stream. When using this method directly, you
2870 will need to manually set the C<Content-Length> header to the length of
2871 your output data, if known.
2872
2873 =cut
2874
2875 sub write {
2876     my $c = shift;
2877
2878     # Finalize headers if someone manually writes output
2879     $c->finalize_headers;
2880
2881     return $c->engine->write( $c, @_ );
2882 }
2883
2884 =head2 version
2885
2886 Returns the Catalyst version number. Mostly useful for "powered by"
2887 messages in template systems.
2888
2889 =cut
2890
2891 sub version { return $Catalyst::VERSION }
2892
2893 =head1 CONFIGURATION
2894
2895 There are a number of 'base' config variables which can be set:
2896
2897 =over
2898
2899 =item *
2900
2901 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2902
2903 =item *
2904
2905 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2906
2907 =item *
2908
2909 C<home> - The application home directory. In an uninstalled application,
2910 this is the top level application directory. In an installed application,
2911 this will be the directory containing C<< MyApp.pm >>.
2912
2913 =item *
2914
2915 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2916
2917 =item *
2918
2919 C<name> - The name of the application in debug messages and the debug and
2920 welcome screens
2921
2922 =item *
2923
2924 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2925 until it is accessed. This allows you to (for example) check authentication (and reject
2926 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2927
2928 =item *
2929
2930 C<root> - The root directory for templates. Usually this is just a
2931 subdirectory of the home directory, but you can set it to change the
2932 templates to a different directory.
2933
2934 =item *
2935
2936 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2937 namespaces from which components will be loaded (and constructed and stored in
2938 C<< $c->components >>).
2939
2940 =item *
2941
2942 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2943 to be shown in hit debug tables in the test server.
2944
2945 =item *
2946
2947 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2948 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2949 for more information.
2950
2951 =item *
2952
2953 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2954
2955 =back
2956
2957 =head1 INTERNAL ACTIONS
2958
2959 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2960 C<_ACTION>, and C<_END>. These are by default not shown in the private
2961 action table, but you can make them visible with a config parameter.
2962
2963     MyApp->config(show_internal_actions => 1);
2964
2965 =head1 ON-DEMAND PARSER
2966
2967 The request body is usually parsed at the beginning of a request,
2968 but if you want to handle input yourself, you can enable on-demand
2969 parsing with a config parameter.
2970
2971     MyApp->config(parse_on_demand => 1);
2972
2973 =head1 PROXY SUPPORT
2974
2975 Many production servers operate using the common double-server approach,
2976 with a lightweight frontend web server passing requests to a larger
2977 backend server. An application running on the backend server must deal
2978 with two problems: the remote user always appears to be C<127.0.0.1> and
2979 the server's hostname will appear to be C<localhost> regardless of the
2980 virtual host that the user connected through.
2981
2982 Catalyst will automatically detect this situation when you are running
2983 the frontend and backend servers on the same machine. The following
2984 changes are made to the request.
2985
2986     $c->req->address is set to the user's real IP address, as read from
2987     the HTTP X-Forwarded-For header.
2988
2989     The host value for $c->req->base and $c->req->uri is set to the real
2990     host, as read from the HTTP X-Forwarded-Host header.
2991
2992 Additionally, you may be running your backend application on an insecure
2993 connection (port 80) while your frontend proxy is running under SSL.  If there
2994 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2995 tell Catalyst what port the frontend listens on.  This will allow all URIs to
2996 be created properly.
2997
2998 In the case of passing in:
2999
3000     X-Forwarded-Port: 443
3001
3002 All calls to C<uri_for> will result in an https link, as is expected.
3003
3004 Obviously, your web server must support these headers for this to work.
3005
3006 In a more complex server farm environment where you may have your
3007 frontend proxy server(s) on different machines, you will need to set a
3008 configuration option to tell Catalyst to read the proxied data from the
3009 headers.
3010
3011     MyApp->config(using_frontend_proxy => 1);
3012
3013 If you do not wish to use the proxy support at all, you may set:
3014
3015     MyApp->config(ignore_frontend_proxy => 1);
3016
3017 =head1 THREAD SAFETY
3018
3019 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3020 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3021 believe the Catalyst core to be thread-safe.
3022
3023 If you plan to operate in a threaded environment, remember that all other
3024 modules you are using must also be thread-safe. Some modules, most notably
3025 L<DBD::SQLite>, are not thread-safe.
3026
3027 =head1 SUPPORT
3028
3029 IRC:
3030
3031     Join #catalyst on irc.perl.org.
3032
3033 Mailing Lists:
3034
3035     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3036     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3037
3038 Web:
3039
3040     http://catalyst.perl.org
3041
3042 Wiki:
3043
3044     http://dev.catalyst.perl.org
3045
3046 =head1 SEE ALSO
3047
3048 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3049
3050 =head2 L<Catalyst::Manual> - The Catalyst Manual
3051
3052 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3053
3054 =head2 L<Catalyst::Engine> - Core engine
3055
3056 =head2 L<Catalyst::Log> - Log class.
3057
3058 =head2 L<Catalyst::Request> - Request object
3059
3060 =head2 L<Catalyst::Response> - Response object
3061
3062 =head2 L<Catalyst::Test> - The test suite.
3063
3064 =head1 PROJECT FOUNDER
3065
3066 sri: Sebastian Riedel <sri@cpan.org>
3067
3068 =head1 CONTRIBUTORS
3069
3070 abw: Andy Wardley
3071
3072 acme: Leon Brocard <leon@astray.com>
3073
3074 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3075
3076 Andrew Bramble
3077
3078 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3079
3080 Andrew Ruthven
3081
3082 André Walker
3083
3084 andyg: Andy Grundman <andy@hybridized.org>
3085
3086 audreyt: Audrey Tang
3087
3088 bricas: Brian Cassidy <bricas@cpan.org>
3089
3090 Caelum: Rafael Kitover <rkitover@io.com>
3091
3092 chansen: Christian Hansen
3093
3094 chicks: Christopher Hicks
3095
3096 Chisel Wright C<pause@herlpacker.co.uk>
3097
3098 Danijel Milicevic C<me@danijel.de>
3099
3100 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3101
3102 David Naughton, C<naughton@umn.edu>
3103
3104 David E. Wheeler
3105
3106 dhoss: Devin Austin <dhoss@cpan.org>
3107
3108 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3109
3110 Drew Taylor
3111
3112 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3113
3114 esskar: Sascha Kiefer
3115
3116 fireartist: Carl Franks <cfranks@cpan.org>
3117
3118 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3119
3120 gabb: Danijel Milicevic
3121
3122 Gary Ashton Jones
3123
3124 Gavin Henry C<ghenry@perl.me.uk>
3125
3126 Geoff Richards
3127
3128 groditi: Guillermo Roditi <groditi@gmail.com>
3129
3130 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3131
3132 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3133
3134 jcamacho: Juan Camacho
3135
3136 jester: Jesse Sheidlower C<jester@panix.com>
3137
3138 jhannah: Jay Hannah <jay@jays.net>
3139
3140 Jody Belka
3141
3142 Johan Lindstrom
3143
3144 jon: Jon Schutz <jjschutz@cpan.org>
3145
3146 Jonathan Rockway C<< <jrockway@cpan.org> >>
3147
3148 Kieren Diment C<kd@totaldatasolution.com>
3149
3150 konobi: Scott McWhirter <konobi@cpan.org>
3151
3152 marcus: Marcus Ramberg <mramberg@cpan.org>
3153
3154 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3155
3156 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3157
3158 mugwump: Sam Vilain
3159
3160 naughton: David Naughton
3161
3162 ningu: David Kamholz <dkamholz@cpan.org>
3163
3164 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3165
3166 numa: Dan Sully <daniel@cpan.org>
3167
3168 obra: Jesse Vincent
3169
3170 Octavian Rasnita
3171
3172 omega: Andreas Marienborg
3173
3174 Oleg Kostyuk <cub.uanic@gmail.com>
3175
3176 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3177
3178 rafl: Florian Ragwitz <rafl@debian.org>
3179
3180 random: Roland Lammel <lammel@cpan.org>
3181
3182 Robert Sedlacek C<< <rs@474.at> >>
3183
3184 SpiceMan: Marcel Montes
3185
3186 sky: Arthur Bergman
3187
3188 szbalint: Balint Szilakszi <szbalint@cpan.org>
3189
3190 t0m: Tomas Doran <bobtfish@bobtfish.net>
3191
3192 Ulf Edvinsson
3193
3194 Viljo Marrandi C<vilts@yahoo.com>
3195
3196 Will Hawes C<info@whawes.co.uk>
3197
3198 willert: Sebastian Willert <willert@cpan.org>
3199
3200 wreis: Wallace Reis <wallace@reis.org.br>
3201
3202 Yuval Kogman, C<nothingmuch@woobling.org>
3203
3204 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3205
3206 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3207
3208 =head1 COPYRIGHT
3209
3210 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3211
3212 =head1 LICENSE
3213
3214 This library is free software. You can redistribute it and/or modify it under
3215 the same terms as Perl itself.
3216
3217 =cut
3218
3219 no Moose;
3220
3221 __PACKAGE__->meta->make_immutable;
3222
3223 1;