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