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 namespace::clean -except => 'meta';
   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 HTML::Entities;
  27 use Tree::Simple qw/use_weak_refs/;
  28 use Tree::Simple::Visitor::FindByUID;
  29 use Class::C3::Adopt::NEXT;
  30 use List::MoreUtils qw/uniq/;
  31 use attributes;
  32 use String::RewritePrefix;
  33 use Catalyst::EngineLoader;
  34 use utf8;
  35 use Carp qw/croak carp shortmess/;
  36 use Try::Tiny;
  37 use Safe::Isa;
  38 use Moose::Util 'find_meta';
  39 use Plack::Middleware::Conditional;
  40 use Plack::Middleware::ReverseProxy;
  41 use Plack::Middleware::IIS6ScriptNameFix;
  42 use Plack::Middleware::IIS7KeepAliveFix;
  43 use Plack::Middleware::LighttpdScriptNameFix;
  44 use Plack::Middleware::ContentLength;
  45 use Plack::Middleware::Head;
  46 use Plack::Middleware::HTTPExceptions;
  47 use Plack::Middleware::FixMissingBodyInRedirect;
  48 use Plack::Middleware::MethodOverride;
  49 use Plack::Middleware::RemoveRedundantBody;
  50 use Catalyst::Middleware::Stash;
  51 use Plack::Util;
  52 use Class::Load 'load_class';
  53 use Encode 2.21 'decode_utf8', 'encode_utf8';
  54 use Scalar::Util;
  55
  56 BEGIN { require 5.008003; }
  57
  58 has stack => (is => 'ro', default => sub { [] });
  59 has state => (is => 'rw', default => 0);
  60 has stats => (is => 'rw');
  61 has action => (is => 'rw');
  62 has counter => (is => 'rw', default => sub { {} });
  63 has request => (
  64     is => 'rw',
  65     default => sub {
  66         my $self = shift;
  67         my $class = ref $self;
  68         my $composed_request_class = $class->composed_request_class;
  69         return $composed_request_class->new( $self->_build_request_constructor_args);
  70     },
  71     lazy => 1,
  72 );
  73 sub _build_request_constructor_args {
  74     my $self = shift;
  75     my %p = ( _log => $self->log );
  76     $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
  77     $p{data_handlers} = {$self->registered_data_handlers};
  78     $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
  79       if $self->config->{use_hash_multivalue_in_request};
  80     \%p;
  81 }
  82
  83 sub composed_request_class {
  84   my $class = shift;
  85   return $class->_composed_request_class if $class->_composed_request_class;
  86
  87   my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
  88
  89   # For each trait listed, figure out what the namespace is.  First we try the $trait
  90   # as it is in the config.  Then try $MyApp::TraitFor::Request:$trait. Last we try
  91   # Catalyst::TraitFor::Request::$trait.  If none load, throw error.
  92
  93   my $trait_ns = 'TraitFor::Request';
  94   my @normalized_traits = map {
  95     Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
  96   } @traits;
  97
  98   if ($class->debug && scalar(@normalized_traits)) {
  99       my $column_width = Catalyst::Utils::term_width() - 6;
 100       my $t = Text::SimpleTable->new($column_width);
 101       $t->row($_) for @normalized_traits;
 102       $class->log->debug( "Composed Request Class Traits:\n" . $t->draw . "\n" );
 103   }
 104
 105   return $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
 106 }
 107
 108 has response => (
 109     is => 'rw',
 110     default => sub {
 111         my $self = shift;
 112         my $class = ref $self;
 113         my $composed_response_class = $class->composed_response_class;
 114         return $composed_response_class->new( $self->_build_response_constructor_args);
 115     },
 116     lazy => 1,
 117 );
 118 sub _build_response_constructor_args {
 119     return +{
 120       _log => $_[0]->log,
 121       encoding => $_[0]->encoding,
 122     };
 123 }
 124
 125 sub composed_response_class {
 126   my $class = shift;
 127   return $class->_composed_response_class if $class->_composed_response_class;
 128
 129   my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
 130
 131   my $trait_ns = 'TraitFor::Response';
 132   my @normalized_traits = map {
 133     Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
 134   } @traits;
 135
 136   if ($class->debug && scalar(@normalized_traits)) {
 137       my $column_width = Catalyst::Utils::term_width() - 6;
 138       my $t = Text::SimpleTable->new($column_width);
 139       $t->row($_) for @normalized_traits;
 140       $class->log->debug( "Composed Response Class Traits:\n" . $t->draw . "\n" );
 141   }
 142
 143   return $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
 144 }
 145
 146 has namespace => (is => 'rw');
 147
 148 sub depth { scalar @{ shift->stack || [] }; }
 149 sub comp { shift->component(@_) }
 150
 151 sub req {
 152     my $self = shift; return $self->request(@_);
 153 }
 154 sub res {
 155     my $self = shift; return $self->response(@_);
 156 }
 157
 158 # For backwards compatibility
 159 sub finalize_output { shift->finalize_body(@_) };
 160
 161 # For statistics
 162 our $COUNT     = 1;
 163 our $START     = time;
 164 our $RECURSION = 1000;
 165 our $DETACH    = Catalyst::Exception::Detach->new;
 166 our $GO        = Catalyst::Exception::Go->new;
 167
 168 #I imagine that very few of these really
 169 #need to be class variables. if any.
 170 #maybe we should just make them attributes with a default?
 171 __PACKAGE__->mk_classdata($_)
 172   for qw/components arguments dispatcher engine log dispatcher_class
 173   engine_loader context_class request_class response_class stats_class
 174   setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
 175   _data_handlers _encoding _encode_check finalized_default_middleware
 176   request_class_traits response_class_traits stats_class_traits
 177   _composed_request_class _composed_response_class _composed_stats_class/;
 178
 179 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
 180 __PACKAGE__->request_class('Catalyst::Request');
 181 __PACKAGE__->response_class('Catalyst::Response');
 182 __PACKAGE__->stats_class('Catalyst::Stats');
 183
 184 sub composed_stats_class {
 185   my $class = shift;
 186   return $class->_composed_stats_class if $class->_composed_stats_class;
 187
 188   my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
 189
 190   my $trait_ns = 'TraitFor::Stats';
 191   my @normalized_traits = map {
 192     Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
 193   } @traits;
 194
 195   if ($class->debug && scalar(@normalized_traits)) {
 196       my $column_width = Catalyst::Utils::term_width() - 6;
 197       my $t = Text::SimpleTable->new($column_width);
 198       $t->row($_) for @normalized_traits;
 199       $class->log->debug( "Composed Stats Class Traits:\n" . $t->draw . "\n" );
 200   }
 201
 202   return $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
 203 }
 204
 205 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
 206
 207 # Remember to update this in Catalyst::Runtime as well!
 208 our $VERSION = '5.90114';
 209 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
 210
 211 sub import {
 212     my ( $class, @arguments ) = @_;
 213
 214     # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
 215     # callers @ISA.
 216     return unless $class eq 'Catalyst';
 217
 218     my $caller = caller();
 219     return if $caller eq 'main';
 220
 221     my $meta = Moose::Meta::Class->initialize($caller);
 222     unless ( $caller->isa('Catalyst') ) {
 223         my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
 224         $meta->superclasses(@superclasses);
 225     }
 226     # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
 227     $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
 228
 229     unless( $meta->has_method('meta') ){
 230         if ($Moose::VERSION >= 1.15) {
 231             $meta->_add_meta_method('meta');
 232         }
 233         else {
 234             $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
 235         }
 236     }
 237
 238     $caller->arguments( [@arguments] );
 239     $caller->setup_home;
 240 }
 241
 242 sub _application { $_[0] }
 243
 244 =encoding UTF-8
 245
 246 =head1 NAME
 247
 248 Catalyst - The Elegant MVC Web Application Framework
 249
 250 =for html
 251 <a href="https://badge.fury.io/pl/Catalyst-Runtime"><img src="https://badge.fury.io/pl/Catalyst-Runtime.svg" alt="CPAN version" height="18"></a>
 252 <a href="https://travis-ci.org/perl-catalyst/catalyst-runtime/"><img src="https://api.travis-ci.org/perl-catalyst/catalyst-runtime.png" alt="Catalyst></a>
 253 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
 254
 255 =head1 SYNOPSIS
 256
 257 See the L<Catalyst::Manual> distribution for comprehensive
 258 documentation and tutorials.
 259
 260     # Install Catalyst::Devel for helpers and other development tools
 261     # use the helper to create a new application
 262     catalyst.pl MyApp
 263
 264     # add models, views, controllers
 265     script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
 266     script/myapp_create.pl view MyTemplate TT
 267     script/myapp_create.pl controller Search
 268
 269     # built in testserver -- use -r to restart automatically on changes
 270     # --help to see all available options
 271     script/myapp_server.pl
 272
 273     # command line testing interface
 274     script/myapp_test.pl /yada
 275
 276     ### in lib/MyApp.pm
 277     use Catalyst qw/-Debug/; # include plugins here as well
 278
 279     ### In lib/MyApp/Controller/Root.pm (autocreated)
 280     sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
 281         my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
 282         $c->stash->{template} = 'foo.tt'; # set the template
 283         # lookup something from db -- stash vars are passed to TT
 284         $c->stash->{data} =
 285           $c->model('Database::Foo')->search( { country => $args[0] } );
 286         if ( $c->req->params->{bar} ) { # access GET or POST parameters
 287             $c->forward( 'bar' ); # process another action
 288             # do something else after forward returns
 289         }
 290     }
 291
 292     # The foo.tt TT template can use the stash data from the database
 293     [% WHILE (item = data.next) %]
 294         [% item.foo %]
 295     [% END %]
 296
 297     # called for /bar/of/soap, /bar/of/soap/10, etc.
 298     sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
 299
 300     # called after all actions are finished
 301     sub end : Action {
 302         my ( $self, $c ) = @_;
 303         if ( scalar @{ $c->error } ) { ... } # handle errors
 304         return if $c->res->body; # already have a response
 305         $c->forward( 'MyApp::View::TT' ); # render template
 306     }
 307
 308 See L<Catalyst::Manual::Intro> for additional information.
 309
 310 =head1 DESCRIPTION
 311
 312 Catalyst is a modern framework for making web applications without the
 313 pain usually associated with this process. This document is a reference
 314 to the main Catalyst application. If you are a new user, we suggest you
 315 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
 316
 317 See L<Catalyst::Manual> for more documentation.
 318
 319 Catalyst plugins can be loaded by naming them as arguments to the "use
 320 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
 321 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
 322 C<My::Module>.
 323
 324     use Catalyst qw/My::Module/;
 325
 326 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
 327 fully qualify the name by using a unary plus:
 328
 329     use Catalyst qw/
 330         My::Module
 331         +Fully::Qualified::Plugin::Name
 332     /;
 333
 334 Special flags like C<-Debug> can also be specified as
 335 arguments when Catalyst is loaded:
 336
 337     use Catalyst qw/-Debug My::Module/;
 338
 339 The position of plugins and flags in the chain is important, because
 340 they are loaded in the order in which they appear.
 341
 342 The following flags are supported:
 343
 344 =head2 -Debug
 345
 346 Enables debug output. You can also force this setting from the system
 347 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
 348 settings override the application, with <MYAPP>_DEBUG having the highest
 349 priority.
 350
 351 This sets the log level to 'debug' and enables full debug output on the
 352 error screen. If you only want the latter, see L<< $c->debug >>.
 353
 354 =head2 -Home
 355
 356 Forces Catalyst to use a specific home directory, e.g.:
 357
 358     use Catalyst qw[-Home=/usr/mst];
 359
 360 This can also be done in the shell environment by setting either the
 361 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
 362 is replaced with the uppercased name of your application, any "::" in
 363 the name will be replaced with underscores, e.g. MyApp::Web should use
 364 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
 365
 366 If none of these are set, Catalyst will attempt to automatically detect the
 367 home directory. If you are working in a development environment, Catalyst
 368 will try and find the directory containing either Makefile.PL, Build.PL,
 369 dist.ini, or cpanfile. If the application has been installed into the system
 370 (i.e. you have done C<make install>), then Catalyst will use the path to your
 371 application module, without the .pm extension (e.g., /foo/MyApp if your
 372 application was installed at /foo/MyApp.pm)
 373
 374 =head2 -Log
 375
 376     use Catalyst '-Log=warn,fatal,error';
 377
 378 Specifies a comma-delimited list of log levels.
 379
 380 =head2 -Stats
 381
 382 Enables statistics collection and reporting.
 383
 384    use Catalyst qw/-Stats=1/;
 385
 386 You can also force this setting from the system environment with CATALYST_STATS
 387 or <MYAPP>_STATS. The environment settings override the application, with
 388 <MYAPP>_STATS having the highest priority.
 389
 390 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
 391
 392 =head1 METHODS
 393
 394 =head2 INFORMATION ABOUT THE CURRENT REQUEST
 395
 396 =head2 $c->action
 397
 398 Returns a L<Catalyst::Action> object for the current action, which
 399 stringifies to the action name. See L<Catalyst::Action>.
 400
 401 =head2 $c->namespace
 402
 403 Returns the namespace of the current action, i.e., the URI prefix
 404 corresponding to the controller of the current action. For example:
 405
 406     # in Controller::Foo::Bar
 407     $c->namespace; # returns 'foo/bar';
 408
 409 =head2 $c->request
 410
 411 =head2 $c->req
 412
 413 Returns the current L<Catalyst::Request> object, giving access to
 414 information about the current client request (including parameters,
 415 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
 416
 417 =head2 REQUEST FLOW HANDLING
 418
 419 =head2 $c->forward( $action [, \@arguments ] )
 420
 421 =head2 $c->forward( $class, $method, [, \@arguments ] )
 422
 423 This is one way of calling another action (method) in the same or
 424 a different controller. You can also use C<< $self->my_method($c, @args) >>
 425 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
 426 in a different controller.
 427 The main difference is that 'forward' uses some of the Catalyst request
 428 cycle overhead, including debugging, which may be useful to you. On the
 429 other hand, there are some complications to using 'forward', restrictions
 430 on values returned from 'forward', and it may not handle errors as you prefer.
 431 Whether you use 'forward' or not is up to you; it is not considered superior to
 432 the other ways to call a method.
 433
 434 'forward' calls  another action, by its private name. If you give a
 435 class name but no method, C<process()> is called. You may also optionally
 436 pass arguments in an arrayref. The action will receive the arguments in
 437 C<@_> and C<< $c->req->args >>. Upon returning from the function,
 438 C<< $c->req->args >> will be restored to the previous values.
 439
 440 Any data C<return>ed from the action forwarded to, will be returned by the
 441 call to forward.
 442
 443     my $foodata = $c->forward('/foo');
 444     $c->forward('index');
 445     $c->forward(qw/Model::DBIC::Foo do_stuff/);
 446     $c->forward('View::TT');
 447
 448 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
 449 an C<< eval { } >> around the call (actually
 450 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
 451 exceptions thrown by the called action non-fatal and pushing them onto
 452 $c->error instead. If you want C<die> to propagate you need to do something
 453 like:
 454
 455     $c->forward('foo');
 456     die join "\n", @{ $c->error } if @{ $c->error };
 457
 458 Or make sure to always return true values from your actions and write
 459 your code like this:
 460
 461     $c->forward('foo') || return;
 462
 463 Another note is that C<< $c->forward >> always returns a scalar because it
 464 actually returns $c->state which operates in a scalar context.
 465 Thus, something like:
 466
 467     return @array;
 468
 469 in an action that is forwarded to is going to return a scalar,
 470 i.e. how many items are in that array, which is probably not what you want.
 471 If you need to return an array then return a reference to it,
 472 or stash it like so:
 473
 474     $c->stash->{array} = \@array;
 475
 476 and access it from the stash.
 477
 478 Keep in mind that the C<end> method used is that of the caller action. So a C<< $c->detach >> inside a forwarded action would run the C<end> method from the original action requested.
 479
 480 =cut
 481
 482 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
 483
 484 =head2 $c->detach( $action [, \@arguments ] )
 485
 486 =head2 $c->detach( $class, $method, [, \@arguments ] )
 487
 488 =head2 $c->detach()
 489
 490 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
 491 doesn't return to the previous action when processing is finished.
 492
 493 When called with no arguments it escapes the processing chain entirely.
 494
 495 =cut
 496
 497 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
 498
 499 =head2 $c->visit( $action [, \@arguments ] )
 500
 501 =head2 $c->visit( $action [, \@captures, \@arguments ] )
 502
 503 =head2 $c->visit( $class, $method, [, \@arguments ] )
 504
 505 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
 506
 507 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
 508 but does a full dispatch, instead of just calling the new C<$action> /
 509 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
 510 you go to are called, just like a new request.
 511
 512 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
 513 This means, for example, that C<< $c->action >> methods such as
 514 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
 515 L<reverse|Catalyst::Action/reverse> return information for the visited action
 516 when they are invoked within the visited action.  This is different from the
 517 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
 518 continues to use the $c->action object from the caller action even when
 519 invoked from the called action.
 520
 521 C<< $c->stash >> is kept unchanged.
 522
 523 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
 524 allows you to "wrap" another action, just as it would have been called by
 525 dispatching from a URL, while the analogous
 526 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
 527 transfer control to another action as if it had been reached directly from a URL.
 528
 529 =cut
 530
 531 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
 532
 533 =head2 $c->go( $action [, \@arguments ] )
 534
 535 =head2 $c->go( $action [, \@captures, \@arguments ] )
 536
 537 =head2 $c->go( $class, $method, [, \@arguments ] )
 538
 539 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
 540
 541 The relationship between C<go> and
 542 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
 543 the relationship between
 544 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
 545 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
 546 C<< $c->go >> will perform a full dispatch on the specified action or method,
 547 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
 548 C<go> escapes the processing of the current request chain on completion, and
 549 does not return to its caller.
 550
 551 @arguments are arguments to the final destination of $action. @captures are
 552 arguments to the intermediate steps, if any, on the way to the final sub of
 553 $action.
 554
 555 =cut
 556
 557 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
 558
 559 =head2 $c->response
 560
 561 =head2 $c->res
 562
 563 Returns the current L<Catalyst::Response> object, see there for details.
 564
 565 =head2 $c->stash
 566
 567 Returns a hashref to the stash, which may be used to store data and pass
 568 it between components during a request. You can also set hash keys by
 569 passing arguments. The stash is automatically sent to the view. The
 570 stash is cleared at the end of a request; it cannot be used for
 571 persistent storage (for this you must use a session; see
 572 L<Catalyst::Plugin::Session> for a complete system integrated with
 573 Catalyst).
 574
 575     $c->stash->{foo} = $bar;
 576     $c->stash( { moose => 'majestic', qux => 0 } );
 577     $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
 578
 579     # stash is automatically passed to the view for use in a template
 580     $c->forward( 'MyApp::View::TT' );
 581
 582 The stash hash is currently stored in the PSGI C<$env> and is managed by
 583 L<Catalyst::Middleware::Stash>.  Since it's part of the C<$env> items in
 584 the stash can be accessed in sub applications mounted under your main
 585 L<Catalyst> application.  For example if you delegate the response of an
 586 action to another L<Catalyst> application, that sub application will have
 587 access to all the stash keys of the main one, and if can of course add
 588 more keys of its own.  However those new keys will not 'bubble' back up
 589 to the main application.
 590
 591 For more information the best thing to do is to review the test case:
 592 t/middleware-stash.t in the distribution /t directory.
 593
 594 =cut
 595
 596 sub stash {
 597   my $c = shift;
 598   $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
 599   return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
 600 }
 601
 602 =head2 $c->error
 603
 604 =head2 $c->error($error, ...)
 605
 606 =head2 $c->error($arrayref)
 607
 608 Returns an arrayref containing error messages.  If Catalyst encounters an
 609 error while processing a request, it stores the error in $c->error.  This
 610 method should only be used to store fatal error messages.
 611
 612     my @error = @{ $c->error };
 613
 614 Add a new error.
 615
 616     $c->error('Something bad happened');
 617
 618 Calling this will always return an arrayref (if there are no errors it
 619 will be an empty arrayref.
 620
 621 =cut
 622
 623 sub error {
 624     my $c = shift;
 625     if ( $_[0] ) {
 626         my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
 627         croak @$error unless ref $c;
 628         push @{ $c->{error} }, @$error;
 629     }
 630     elsif ( defined $_[0] ) { $c->{error} = undef }
 631     return $c->{error} || [];
 632 }
 633
 634 =head2 $c->state
 635
 636 Contains the return value of the last executed action.
 637 Note that << $c->state >> operates in a scalar context which means that all
 638 values it returns are scalar.
 639
 640 Please note that if an action throws an exception, the value of state
 641 should no longer be considered the return if the last action.  It is generally
 642 going to be 0, which indicates an error state.  Examine $c->error for error
 643 details.
 644
 645 =head2 $c->clear_errors
 646
 647 Clear errors.  You probably don't want to clear the errors unless you are
 648 implementing a custom error screen.
 649
 650 This is equivalent to running
 651
 652     $c->error(0);
 653
 654 =cut
 655
 656 sub clear_errors {
 657     my $c = shift;
 658     $c->error(0);
 659 }
 660
 661 =head2 $c->has_errors
 662
 663 Returns true if you have errors
 664
 665 =cut
 666
 667 sub has_errors { scalar(@{shift->error}) ? 1:0 }
 668
 669 =head2 $c->last_error
 670
 671 Returns the most recent error in the stack (the one most recently added...)
 672 or nothing if there are no errors.  This does not modify the contents of the
 673 error stack.
 674
 675 =cut
 676
 677 sub last_error {
 678   my (@errs) = @{shift->error};
 679   return scalar(@errs) ? $errs[-1]: undef;
 680 }
 681
 682 =head2 shift_errors
 683
 684 shifts the most recently added error off the error stack and returns it.  Returns
 685 nothing if there are no more errors.
 686
 687 =cut
 688
 689 sub shift_errors {
 690     my ($self) = @_;
 691     my @errors = @{$self->error};
 692     my $err = shift(@errors);
 693     $self->{error} = \@errors;
 694     return $err;
 695 }
 696
 697 =head2 pop_errors
 698
 699 pops the most recently added error off the error stack and returns it.  Returns
 700 nothing if there are no more errors.
 701
 702 =cut
 703
 704 sub pop_errors {
 705     my ($self) = @_;
 706     my @errors = @{$self->error};
 707     my $err = pop(@errors);
 708     $self->{error} = \@errors;
 709     return $err;
 710 }
 711
 712 sub _comp_search_prefixes {
 713     my $c = shift;
 714     return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
 715 }
 716
 717 # search components given a name and some prefixes
 718 sub _comp_names_search_prefixes {
 719     my ( $c, $name, @prefixes ) = @_;
 720     my $appclass = ref $c || $c;
 721     my $filter   = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
 722     $filter = qr/$filter/; # Compile regex now rather than once per loop
 723
 724     # map the original component name to the sub part that we will search against
 725     my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
 726         grep { /$filter/ } keys %{ $c->components };
 727
 728     # undef for a name will return all
 729     return keys %eligible if !defined $name;
 730
 731     my $query  = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
 732     my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
 733
 734     return @result if @result;
 735
 736     # if we were given a regexp to search against, we're done.
 737     return if $name->$_isa('Regexp');
 738
 739     # skip regexp fallback if configured
 740     return
 741         if $appclass->config->{disable_component_resolution_regex_fallback};
 742
 743     # regexp fallback
 744     $query  = qr/$name/i;
 745     @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
 746
 747     # no results? try against full names
 748     if( !@result ) {
 749         @result = grep { m{$query} } keys %eligible;
 750     }
 751
 752     # don't warn if we didn't find any results, it just might not exist
 753     if( @result ) {
 754         # Disgusting hack to work out correct method name
 755         my $warn_for = lc $prefixes[0];
 756         my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
 757            (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
 758            "component resolution is unreliable and unsafe.";
 759         my $short = $result[0];
 760         # remove the component namespace prefix
 761         $short =~ s/.*?(Model|Controller|View):://;
 762         my $shortmess = Carp::shortmess('');
 763         if ($shortmess =~ m#Catalyst/Plugin#) {
 764            $msg .= " You probably need to set '$short' instead of '${name}' in this " .
 765               "plugin's config";
 766         } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
 767            $msg .= " You probably need to set '$short' instead of '${name}' in this " .
 768               "component's config";
 769         } else {
 770            $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
 771               "but if you really wanted to search, pass in a regexp as the argument " .
 772               "like so: \$c->${warn_for}(qr/${name}/)";
 773         }
 774         $c->log->warn( "${msg}$shortmess" );
 775     }
 776
 777     return @result;
 778 }
 779
 780 # Find possible names for a prefix
 781 sub _comp_names {
 782     my ( $c, @prefixes ) = @_;
 783     my $appclass = ref $c || $c;
 784
 785     my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
 786
 787     my @names = map { s{$filter}{}; $_; }
 788         $c->_comp_names_search_prefixes( undef, @prefixes );
 789
 790     return @names;
 791 }
 792
 793 # Filter a component before returning by calling ACCEPT_CONTEXT if available
 794
 795 sub _filter_component {
 796     my ( $c, $comp, @args ) = @_;
 797
 798     if(ref $comp eq 'CODE') {
 799       $comp = $comp->();
 800     }
 801
 802     if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
 803       return $comp->ACCEPT_CONTEXT( $c, @args );
 804     }
 805
 806     $c->log->warn("You called component '${\$comp->catalyst_component_name}' with arguments [@args], but this component does not ACCEPT_CONTEXT, so args are ignored.") if scalar(@args) && $c->debug;
 807
 808     return $comp;
 809 }
 810
 811 =head2 COMPONENT ACCESSORS
 812
 813 =head2 $c->controller($name)
 814
 815 Gets a L<Catalyst::Controller> instance by name.
 816
 817     $c->controller('Foo')->do_stuff;
 818
 819 If the name is omitted, will return the controller for the dispatched
 820 action.
 821
 822 If you want to search for controllers, pass in a regexp as the argument.
 823
 824     # find all controllers that start with Foo
 825     my @foo_controllers = $c->controller(qr{^Foo});
 826
 827
 828 =cut
 829
 830 sub controller {
 831     my ( $c, $name, @args ) = @_;
 832
 833     my $appclass = ref($c) || $c;
 834     if( $name ) {
 835         unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
 836             my $comps = $c->components;
 837             my $check = $appclass."::Controller::".$name;
 838             return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
 839             foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
 840                 next unless $path =~ /.*::Controller/;
 841                 $check = $path."::".$name;
 842                 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
 843             }
 844         }
 845         my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
 846         return map { $c->_filter_component( $_, @args ) } @result if ref $name;
 847         return $c->_filter_component( $result[ 0 ], @args );
 848     }
 849
 850     return $c->component( $c->action->class );
 851 }
 852
 853 =head2 $c->model($name)
 854
 855 Gets a L<Catalyst::Model> instance by name.
 856
 857     $c->model('Foo')->do_stuff;
 858
 859 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
 860 defines ACCEPT_CONTEXT.  If it does not, the args are discarded.
 861
 862 If the name is omitted, it will look for
 863  - a model object in $c->stash->{current_model_instance}, then
 864  - a model name in $c->stash->{current_model}, then
 865  - a config setting 'default_model', or
 866  - check if there is only one model, and return it if that's the case.
 867
 868 If you want to search for models, pass in a regexp as the argument.
 869
 870     # find all models that start with Foo
 871     my @foo_models = $c->model(qr{^Foo});
 872
 873 =cut
 874
 875 sub model {
 876     my ( $c, $name, @args ) = @_;
 877     my $appclass = ref($c) || $c;
 878     if( $name ) {
 879         unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
 880             my $comps = $c->components;
 881             my $check = $appclass."::Model::".$name;
 882             return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
 883             foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
 884                 next unless $path =~ /.*::Model/;
 885                 $check = $path."::".$name;
 886                 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
 887             }
 888         }
 889         my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
 890         return map { $c->_filter_component( $_, @args ) } @result if ref $name;
 891         return $c->_filter_component( $result[ 0 ], @args );
 892     }
 893
 894     if (ref $c) {
 895         return $c->stash->{current_model_instance}
 896           if $c->stash->{current_model_instance};
 897         return $c->model( $c->stash->{current_model} )
 898           if $c->stash->{current_model};
 899     }
 900     return $c->model( $appclass->config->{default_model} )
 901       if $appclass->config->{default_model};
 902
 903     my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
 904
 905     if( $rest ) {
 906         $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
 907         $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
 908         $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
 909         $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
 910         $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
 911     }
 912
 913     return $c->_filter_component( $comp );
 914 }
 915
 916
 917 =head2 $c->view($name)
 918
 919 Gets a L<Catalyst::View> instance by name.
 920
 921     $c->view('Foo')->do_stuff;
 922
 923 Any extra arguments are directly passed to ACCEPT_CONTEXT.
 924
 925 If the name is omitted, it will look for
 926  - a view object in $c->stash->{current_view_instance}, then
 927  - a view name in $c->stash->{current_view}, then
 928  - a config setting 'default_view', or
 929  - check if there is only one view, and return it if that's the case.
 930
 931 If you want to search for views, pass in a regexp as the argument.
 932
 933     # find all views that start with Foo
 934     my @foo_views = $c->view(qr{^Foo});
 935
 936 =cut
 937
 938 sub view {
 939     my ( $c, $name, @args ) = @_;
 940
 941     my $appclass = ref($c) || $c;
 942     if( $name ) {
 943         unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
 944             my $comps = $c->components;
 945             my $check = $appclass."::View::".$name;
 946             if( exists $comps->{$check} ) {
 947                 return $c->_filter_component( $comps->{$check}, @args );
 948             }
 949             else {
 950                 $c->log->warn( "Attempted to use view '$check', but does not exist" );
 951             }
 952             foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
 953                 next unless $path =~ /.*::View/;
 954                 $check = $path."::".$name;
 955                 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
 956             }
 957         }
 958         my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
 959         return map { $c->_filter_component( $_, @args ) } @result if ref $name;
 960         return $c->_filter_component( $result[ 0 ], @args );
 961     }
 962
 963     if (ref $c) {
 964         return $c->stash->{current_view_instance}
 965           if $c->stash->{current_view_instance};
 966         return $c->view( $c->stash->{current_view} )
 967           if $c->stash->{current_view};
 968     }
 969     return $c->view( $appclass->config->{default_view} )
 970       if $appclass->config->{default_view};
 971
 972     my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
 973
 974     if( $rest ) {
 975         $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
 976         $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
 977         $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
 978         $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
 979         $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
 980     }
 981
 982     return $c->_filter_component( $comp );
 983 }
 984
 985 =head2 $c->controllers
 986
 987 Returns the available names which can be passed to $c->controller
 988
 989 =cut
 990
 991 sub controllers {
 992     my ( $c ) = @_;
 993     return $c->_comp_names(qw/Controller C/);
 994 }
 995
 996 =head2 $c->models
 997
 998 Returns the available names which can be passed to $c->model
 999
1000 =cut
1001
1002 sub models {
1003     my ( $c ) = @_;
1004     return $c->_comp_names(qw/Model M/);
1005 }
1006
1007
1008 =head2 $c->views
1009
1010 Returns the available names which can be passed to $c->view
1011
1012 =cut
1013
1014 sub views {
1015     my ( $c ) = @_;
1016     return $c->_comp_names(qw/View V/);
1017 }
1018
1019 =head2 $c->comp($name)
1020
1021 =head2 $c->component($name)
1022
1023 Gets a component object by name. This method is not recommended,
1024 unless you want to get a specific component by full
1025 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
1026 should be used instead.
1027
1028 If C<$name> is a regexp, a list of components matched against the full
1029 component name will be returned.
1030
1031 If Catalyst can't find a component by name, it will fallback to regex
1032 matching by default. To disable this behaviour set
1033 disable_component_resolution_regex_fallback to a true value.
1034
1035     __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
1036
1037 =cut
1038
1039 sub component {
1040     my ( $c, $name, @args ) = @_;
1041
1042     if( $name ) {
1043         my $comps = $c->components;
1044
1045         if( !ref $name ) {
1046             # is it the exact name?
1047             return $c->_filter_component( $comps->{ $name }, @args )
1048                        if exists $comps->{ $name };
1049
1050             # perhaps we just omitted "MyApp"?
1051             my $composed = ( ref $c || $c ) . "::${name}";
1052             return $c->_filter_component( $comps->{ $composed }, @args )
1053                        if exists $comps->{ $composed };
1054
1055             # search all of the models, views and controllers
1056             my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1057             return $c->_filter_component( $comp, @args ) if $comp;
1058         }
1059
1060         return
1061             if $c->config->{disable_component_resolution_regex_fallback};
1062
1063         # This is here so $c->comp( '::M::' ) works
1064         my $query = ref $name ? $name : qr{$name}i;
1065
1066         my @result = grep { m{$query} } keys %{ $c->components };
1067         return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1068
1069         if( $result[ 0 ] ) {
1070             $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1071             $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1072             $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1073             return $c->_filter_component( $result[ 0 ], @args );
1074         }
1075
1076         # I would expect to return an empty list here, but that breaks back-compat
1077     }
1078
1079     # fallback
1080     return sort keys %{ $c->components };
1081 }
1082
1083 =head2 CLASS DATA AND HELPER CLASSES
1084
1085 =head2 $c->config
1086
1087 Returns or takes a hashref containing the application's configuration.
1088
1089     __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1090
1091 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1092 like C<myapp.conf> in your applications home directory. See
1093 L<Catalyst::Plugin::ConfigLoader>.
1094
1095 =head3 Cascading configuration
1096
1097 The config method is present on all Catalyst components, and configuration
1098 will be merged when an application is started. Configuration loaded with
1099 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1100 followed by configuration in your top level C<MyApp> class. These two
1101 configurations are merged, and then configuration data whose hash key matches a
1102 component name is merged with configuration for that component.
1103
1104 The configuration for a component is then passed to the C<new> method when a
1105 component is constructed.
1106
1107 For example:
1108
1109     MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1110     MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1111
1112 will mean that C<MyApp::Model::Foo> receives the following data when
1113 constructed:
1114
1115     MyApp::Model::Foo->new({
1116         bar => 'baz',
1117         quux => 'frob',
1118         overrides => 'me',
1119     });
1120
1121 It's common practice to use a Moose attribute
1122 on the receiving component to access the config value.
1123
1124     package MyApp::Model::Foo;
1125
1126     use Moose;
1127
1128     # this attr will receive 'baz' at construction time
1129     has 'bar' => (
1130         is  => 'rw',
1131         isa => 'Str',
1132     );
1133
1134 You can then get the value 'baz' by calling $c->model('Foo')->bar
1135 (or $self->bar inside code in the model).
1136
1137 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1138 as a way of reading config within your code, as this B<will not> give you the
1139 correctly merged config back. You B<MUST> take the config values supplied to
1140 the constructor and use those instead.
1141
1142 =cut
1143
1144 around config => sub {
1145     my $orig = shift;
1146     my $c = shift;
1147
1148     croak('Setting config after setup has been run is not allowed.')
1149         if ( @_ and $c->setup_finished );
1150
1151     $c->$orig(@_);
1152 };
1153
1154 =head2 $c->log
1155
1156 Returns the logging object instance. Unless it is already set, Catalyst
1157 sets this up with a L<Catalyst::Log> object. To use your own log class,
1158 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1159 C<< __PACKAGE__->setup >>.
1160
1161  __PACKAGE__->log( MyLogger->new );
1162  __PACKAGE__->setup;
1163
1164 And later:
1165
1166     $c->log->info( 'Now logging with my own logger!' );
1167
1168 Your log class should implement the methods described in
1169 L<Catalyst::Log>.
1170
1171 =head2 has_encoding
1172
1173 Returned True if there's a valid encoding
1174
1175 =head2 clear_encoding
1176
1177 Clears the encoding for the current context
1178
1179 =head2 encoding
1180
1181 Sets or gets the application encoding.  Setting encoding takes either an
1182 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1183
1184 You would expect to get the encoding object back if you attempt to set it.  If
1185 there is a failure you will get undef returned and an error message in the log.
1186
1187 =cut
1188
1189 sub has_encoding { shift->encoding ? 1:0 }
1190
1191 sub clear_encoding {
1192     my $c = shift;
1193     if(blessed $c) {
1194         $c->encoding(undef);
1195     } else {
1196         $c->log->error("You can't clear encoding on the application");
1197     }
1198 }
1199
1200 sub encoding {
1201     my $c = shift;
1202     my $encoding;
1203
1204     if ( scalar @_ ) {
1205
1206         # Don't let one change this once we are too far into the response
1207         if(blessed $c && $c->res->finalized_headers) {
1208           Carp::croak("You may not change the encoding once the headers are finalized");
1209           return;
1210         }
1211
1212         # Let it be set to undef
1213         if (my $wanted = shift)  {
1214             $encoding = Encode::find_encoding($wanted)
1215               or Carp::croak( qq/Unknown encoding '$wanted'/ );
1216             binmode(STDERR, ':encoding(' . $encoding->name . ')');
1217         }
1218         else {
1219             binmode(STDERR);
1220         }
1221
1222         $encoding = ref $c
1223                   ? $c->{encoding} = $encoding
1224                   : $c->_encoding($encoding);
1225     } else {
1226       $encoding = ref $c && exists $c->{encoding}
1227                 ? $c->{encoding}
1228                 : $c->_encoding;
1229     }
1230
1231     return $encoding;
1232 }
1233
1234 =head2 $c->debug
1235
1236 Returns 1 if debug mode is enabled, 0 otherwise.
1237
1238 You can enable debug mode in several ways:
1239
1240 =over
1241
1242 =item By calling myapp_server.pl with the -d flag
1243
1244 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1245
1246 =item The -Debug option in your MyApp.pm
1247
1248 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1249
1250 =back
1251
1252 The first three also set the log level to 'debug'.
1253
1254 Calling C<< $c->debug(1) >> has no effect.
1255
1256 =cut
1257
1258 sub debug { 0 }
1259
1260 =head2 $c->dispatcher
1261
1262 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1263
1264 =head2 $c->engine
1265
1266 Returns the engine instance. See L<Catalyst::Engine>.
1267
1268
1269 =head2 UTILITY METHODS
1270
1271 =head2 $c->path_to(@path)
1272
1273 Merges C<@path> with C<< $c->config->{home} >> and returns a
1274 L<Path::Class::Dir> object. Note you can usually use this object as
1275 a filename, but sometimes you will have to explicitly stringify it
1276 yourself by calling the C<< ->stringify >> method.
1277
1278 For example:
1279
1280     $c->path_to( 'db', 'sqlite.db' );
1281
1282 =cut
1283
1284 sub path_to {
1285     my ( $c, @path ) = @_;
1286     my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1287     if ( -d $path ) { return $path }
1288     else { return Path::Class::File->new( $c->config->{home}, @path ) }
1289 }
1290
1291 sub plugin {
1292     my ( $class, $name, $plugin, @args ) = @_;
1293
1294     # See block comment in t/unit_core_plugin.t
1295     $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1296
1297     $class->_register_plugin( $plugin, 1 );
1298
1299     eval { $plugin->import };
1300     $class->mk_classdata($name);
1301     my $obj;
1302     eval { $obj = $plugin->new(@args) };
1303
1304     if ($@) {
1305         Catalyst::Exception->throw( message =>
1306               qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1307     }
1308
1309     $class->$name($obj);
1310     $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1311       if $class->debug;
1312 }
1313
1314 =head2 MyApp->setup
1315
1316 Initializes the dispatcher and engine, loads any plugins, and loads the
1317 model, view, and controller components. You may also specify an array
1318 of plugins to load here, if you choose to not load them in the C<use
1319 Catalyst> line.
1320
1321     MyApp->setup;
1322     MyApp->setup( qw/-Debug/ );
1323
1324 B<Note:> You B<should not> wrap this method with method modifiers
1325 or bad things will happen - wrap the C<setup_finalize> method instead.
1326
1327 B<Note:> You can create a custom setup stage that will execute when the
1328 application is starting.  Use this to customize setup.
1329
1330     MyApp->setup(-Custom=value);
1331
1332     sub setup_custom {
1333       my ($class, $value) = @_;
1334     }
1335
1336 Can be handy if you want to hook into the setup phase.
1337
1338 =cut
1339
1340 sub setup {
1341     my ( $class, @arguments ) = @_;
1342     croak('Running setup more than once')
1343         if ( $class->setup_finished );
1344
1345     unless ( $class->isa('Catalyst') ) {
1346
1347         Catalyst::Exception->throw(
1348             message => qq/'$class' does not inherit from Catalyst/ );
1349     }
1350
1351     if ( $class->arguments ) {
1352         @arguments = ( @arguments, @{ $class->arguments } );
1353     }
1354
1355     # Process options
1356     my $flags = {};
1357
1358     foreach (@arguments) {
1359
1360         if (/^-Debug$/) {
1361             $flags->{log} =
1362               ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1363         }
1364         elsif (/^-(\w+)=?(.*)$/) {
1365             $flags->{ lc $1 } = $2;
1366         }
1367         else {
1368             push @{ $flags->{plugins} }, $_;
1369         }
1370     }
1371
1372     $class->setup_home( delete $flags->{home} );
1373
1374     $class->setup_log( delete $flags->{log} );
1375     $class->setup_plugins( delete $flags->{plugins} );
1376
1377     $class->setup_data_handlers();
1378     $class->setup_dispatcher( delete $flags->{dispatcher} );
1379     if (my $engine = delete $flags->{engine}) {
1380         $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1381     }
1382     $class->setup_engine();
1383     $class->setup_stats( delete $flags->{stats} );
1384
1385     for my $flag ( sort keys %{$flags} ) {
1386
1387         if ( my $code = $class->can( 'setup_' . $flag ) ) {
1388             &$code( $class, delete $flags->{$flag} );
1389         }
1390         else {
1391             $class->log->warn(qq/Unknown flag "$flag"/);
1392         }
1393     }
1394
1395     eval { require Catalyst::Devel; };
1396     if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1397         $class->log->warn(<<"EOF");
1398 You are running an old script!
1399
1400   Please update by running (this will overwrite existing files):
1401     catalyst.pl -force -scripts $class
1402
1403   or (this will not overwrite existing files):
1404     catalyst.pl -scripts $class
1405
1406 EOF
1407     }
1408
1409     # Call plugins setup, this is stupid and evil.
1410     # Also screws C3 badly on 5.10, hack to avoid.
1411     {
1412         no warnings qw/redefine/;
1413         local *setup = sub { };
1414         $class->setup unless $Catalyst::__AM_RESTARTING;
1415     }
1416
1417     # If you are expecting configuration info as part of your setup, it needs
1418     # to get called here and below, since we need the above line to support
1419     # ConfigLoader based configs.
1420
1421     $class->setup_encoding();
1422     $class->setup_middleware();
1423
1424     # Initialize our data structure
1425     $class->components( {} );
1426
1427     $class->setup_components;
1428
1429     if ( $class->debug ) {
1430         my @plugins = map { "$_  " . ( $_->VERSION || '' ) } $class->registered_plugins;
1431
1432         if (@plugins) {
1433             my $column_width = Catalyst::Utils::term_width() - 6;
1434             my $t = Text::SimpleTable->new($column_width);
1435             $t->row($_) for @plugins;
1436             $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1437         }
1438
1439         my @middleware = map {
1440           ref $_ eq 'CODE' ?
1441             "Inline Coderef" :
1442               (ref($_) .'  '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1443                 || '')  } $class->registered_middlewares;
1444
1445         if (@middleware) {
1446             my $column_width = Catalyst::Utils::term_width() - 6;
1447             my $t = Text::SimpleTable->new($column_width);
1448             $t->row($_) for @middleware;
1449             $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1450         }
1451
1452         my %dh = $class->registered_data_handlers;
1453         if (my @data_handlers = keys %dh) {
1454             my $column_width = Catalyst::Utils::term_width() - 6;
1455             my $t = Text::SimpleTable->new($column_width);
1456             $t->row($_) for @data_handlers;
1457             $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1458         }
1459
1460         my $dispatcher = $class->dispatcher;
1461         my $engine     = $class->engine;
1462         my $home       = $class->config->{home};
1463
1464         $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1465         $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1466
1467         $home
1468           ? ( -d $home )
1469           ? $class->log->debug(qq/Found home "$home"/)
1470           : $class->log->debug(qq/Home "$home" doesn't exist/)
1471           : $class->log->debug(q/Couldn't find home/);
1472
1473         my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1474
1475         my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1476         for my $comp ( sort keys %{ $class->components } ) {
1477             my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1478             $t->row( $comp, $type );
1479         }
1480         $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1481           if ( keys %{ $class->components } );
1482     }
1483
1484     # Add our self to components, since we are also a component
1485     if( $class->isa('Catalyst::Controller') ){
1486       $class->components->{$class} = $class;
1487     }
1488
1489     $class->setup_actions;
1490
1491     if ( $class->debug ) {
1492         my $name = $class->config->{name} || 'Application';
1493         $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1494     }
1495
1496     if ($class->config->{case_sensitive}) {
1497         $class->log->warn($class . "->config->{case_sensitive} is set.");
1498         $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1499     }
1500
1501     # call these so we pre setup the composed classes
1502     $class->composed_request_class;
1503     $class->composed_response_class;
1504     $class->composed_stats_class;
1505
1506     $class->setup_finalize;
1507
1508     # Flush the log for good measure (in case something turned off 'autoflush' early)
1509     $class->log->_flush() if $class->log->can('_flush');
1510
1511     return $class || 1; # Just in case someone named their Application 0...
1512 }
1513
1514 =head2 $app->setup_finalize
1515
1516 A hook to attach modifiers to. This method does not do anything except set the
1517 C<setup_finished> accessor.
1518
1519 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1520
1521 Example:
1522
1523     after setup_finalize => sub {
1524         my $app = shift;
1525
1526         ## do stuff here..
1527     };
1528
1529 =cut
1530
1531 sub setup_finalize {
1532     my ($class) = @_;
1533     $class->setup_finished(1);
1534 }
1535
1536 =head2 $c->uri_for( $path?, @args?, \%query_values?, \$fragment? )
1537
1538 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1539
1540 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
1541
1542 Constructs an absolute L<URI> object based on the application root, the
1543 provided path, and the additional arguments and query parameters provided.
1544 When used as a string, provides a textual URI.  If you need more flexibility
1545 than this (i.e. the option to provide relative URIs etc.) see
1546 L<Catalyst::Plugin::SmartURI>.
1547
1548 If no arguments are provided, the URI for the current action is returned.
1549 To return the current action and also provide @args, use
1550 C<< $c->uri_for( $c->action, @args ) >>.
1551
1552 If the first argument is a string, it is taken as a public URI path relative
1553 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1554 relative to the application root (if it does). It is then merged with
1555 C<< $c->request->base >>; any C<@args> are appended as additional path
1556 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1557
1558 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1559 allow you to declare something like:
1560
1561     $c->uri_for('/foo/bar#baz')
1562
1563 Where 'baz' is a URI fragment.  We consider this first argument string to be
1564 'expert' mode where you are expected to create a valid URL and we for the most
1565 part just pass it through without a lot of internal effort to escape and encode.
1566
1567 If the first argument is a L<Catalyst::Action> it represents an action which
1568 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1569 optional C<\@captures> argument (an arrayref) allows passing the captured
1570 variables that are needed to fill in the paths of Chained and Regex actions;
1571 once the path is resolved, C<uri_for> continues as though a path was
1572 provided, appending any arguments or parameters and creating an absolute
1573 URI.
1574
1575 The captures for the current request can be found in
1576 C<< $c->request->captures >>, and actions can be resolved using
1577 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1578 path, use C<< $c->uri_for_action >> instead.
1579
1580   # Equivalent to $c->req->uri
1581   $c->uri_for($c->action, $c->req->captures,
1582       @{ $c->req->args }, $c->req->params);
1583
1584   # For the Foo action in the Bar controller
1585   $c->uri_for($c->controller('Bar')->action_for('Foo'));
1586
1587   # Path to a static resource
1588   $c->uri_for('/static/images/logo.png');
1589
1590 In general the scheme of the generated URI object will follow the incoming request
1591 however if your targeted action or action chain has the Scheme attribute it will
1592 use that instead.
1593
1594 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1595 type constraints, we will require that your proposed URL verify on those declared
1596 constraints.
1597
1598 =cut
1599
1600 sub uri_for {
1601     my ( $c, $path, @args ) = @_;
1602
1603     if ( $path->$_isa('Catalyst::Controller') ) {
1604         $path = $path->path_prefix;
1605         $path =~ s{/+\z}{};
1606         $path .= '/';
1607     }
1608
1609     my $fragment =  ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
1610
1611     unless(blessed $path) {
1612       if (defined($path) and $path =~ s/#(.+)$//)  {
1613         if(defined($1) and $fragment) {
1614           carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1615         }
1616         if(defined($1)) {
1617           $fragment = $1;
1618         }
1619       }
1620     }
1621
1622     my $params =
1623       ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1624
1625     undef($path) if (defined $path && $path eq '');
1626
1627     carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1628
1629     my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1630     if ( $path->$_isa('Catalyst::Action') ) { # action object
1631         s|/|%2F|g for @args;
1632         my $captures = [ map { s|/|%2F|g; $_; }
1633                         ( scalar @args && ref $args[0] eq 'ARRAY'
1634                          ? @{ shift(@args) }
1635                          : ()) ];
1636
1637         my $action = $path;
1638         my $expanded_action = $c->dispatcher->expand_action( $action );
1639         my $num_captures = $expanded_action->number_of_captures;
1640
1641         # ->uri_for( $action, \@captures_and_args, \%query_values? )
1642         if( !@args && $action->number_of_args ) {
1643           unshift @args, splice @$captures, $num_captures;
1644         }
1645
1646         if($num_captures) {
1647           unless($expanded_action->match_captures_constraints($c, $captures)) {
1648             carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1649             return;
1650           }
1651         }
1652
1653         $path = $c->dispatcher->uri_for_action($action, $captures);
1654         if (not defined $path) {
1655             $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1656                 if $c->debug;
1657             return undef;
1658         }
1659         $path = '/' if $path eq '';
1660
1661         # At this point @encoded_args is the remaining Args (all captures removed).
1662         if($expanded_action->has_args_constraints) {
1663           unless($expanded_action->match_args($c,\@args)) {
1664              carp "args [@args] do not match the type constraints in action '$expanded_action'";
1665              return;
1666           }
1667         }
1668     }
1669
1670     unshift(@args, $path);
1671
1672     unless (defined $path && $path =~ s!^/!!) { # in-place strip
1673         my $namespace = $c->namespace;
1674         if (defined $path) { # cheesy hack to handle path '../foo'
1675            $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1676         }
1677         unshift(@args, $namespace || '');
1678     }
1679
1680     # join args with '/', or a blank string
1681     my $args = join('/', grep { defined($_) } @args);
1682     $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1683     $args =~ s!^/+!!;
1684
1685     my ($base, $class) = ('/', 'URI::_generic');
1686     if(blessed($c)) {
1687       $base = $c->req->base;
1688       if($target_action) {
1689         $target_action = $c->dispatcher->expand_action($target_action);
1690         if(my $s = $target_action->scheme) {
1691           $s = lc($s);
1692           $class = "URI::$s";
1693           $base->scheme($s);
1694         } else {
1695           $class = ref($base);
1696         }
1697       } else {
1698         $class = ref($base);
1699       }
1700
1701       $base =~ s{(?<!/)$}{/};
1702     }
1703
1704     my $query = '';
1705     if (my @keys = keys %$params) {
1706       # somewhat lifted from URI::_query's query_form
1707       $query = '?'.join('&', map {
1708           my $val = $params->{$_};
1709           #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1710           s/ /+/g;
1711           my $key = $_;
1712           $val = '' unless defined $val;
1713           (map {
1714               my $param = "$_";
1715               $param = encode_utf8($param);
1716               # using the URI::Escape pattern here so utf8 chars survive
1717               $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1718               $param =~ s/ /+/g;
1719
1720               $key = encode_utf8($key);
1721               # using the URI::Escape pattern here so utf8 chars survive
1722               $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1723               $key =~ s/ /+/g;
1724
1725               "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1726       } @keys);
1727     }
1728
1729     $base = encode_utf8 $base;
1730     $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1731     $args = encode_utf8 $args;
1732     $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1733
1734     if(defined $fragment) {
1735       if(blessed $path) {
1736         $fragment = encode_utf8(${$fragment});
1737         $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1738         $fragment =~ s/ /+/g;
1739       }
1740       $query .= "#$fragment";
1741     }
1742
1743     my $res = bless(\"${base}${args}${query}", $class);
1744     $res;
1745 }
1746
1747 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1748
1749 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1750
1751 =over
1752
1753 =item $path
1754
1755 A private path to the Catalyst action you want to create a URI for.
1756
1757 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1758 >> and passing the resulting C<$action> and the remaining arguments to C<<
1759 $c->uri_for >>.
1760
1761 You can also pass in a Catalyst::Action object, in which case it is passed to
1762 C<< $c->uri_for >>.
1763
1764 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.
1765
1766 For example, if the action looks like:
1767
1768  package MyApp::Controller::Users;
1769
1770  sub lst : Path('the-list') {}
1771
1772 You can use:
1773
1774  $c->uri_for_action('/users/lst')
1775
1776 and it will create the URI /users/the-list.
1777
1778 =item \@captures_and_args?
1779
1780 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1781 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1782 to interpolate all the parameters in the URI.
1783
1784 =item @args?
1785
1786 Optional list of extra arguments - can be supplied in the
1787 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1788 code.
1789
1790 Your action can have zero, a fixed or a variable number of args (e.g.
1791 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1792
1793 =item \%query_values?
1794
1795 Optional array reference of query parameters to append. E.g.
1796
1797   { foo => 'bar' }
1798
1799 will generate
1800
1801   /rest/of/your/uri?foo=bar
1802
1803 =back
1804
1805 =cut
1806
1807 sub uri_for_action {
1808     my ( $c, $path, @args ) = @_;
1809     my $action = blessed($path)
1810       ? $path
1811       : $c->dispatcher->get_action_by_path($path);
1812     unless (defined $action) {
1813       croak "Can't find action for path '$path'";
1814     }
1815     return $c->uri_for( $action, @args );
1816 }
1817
1818 =head2 $c->welcome_message
1819
1820 Returns the Catalyst welcome HTML page.
1821
1822 =cut
1823
1824 sub welcome_message {
1825     my $c      = shift;
1826     my $name   = $c->config->{name};
1827     my $logo   = $c->uri_for('/static/images/catalyst_logo.png');
1828     my $prefix = Catalyst::Utils::appprefix( ref $c );
1829     $c->response->content_type('text/html; charset=utf-8');
1830     return <<"EOF";
1831 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1832     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1833 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1834     <head>
1835     <meta http-equiv="Content-Language" content="en" />
1836     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1837         <title>$name on Catalyst $VERSION</title>
1838         <style type="text/css">
1839             body {
1840                 color: #000;
1841                 background-color: #eee;
1842             }
1843             div#content {
1844                 width: 640px;
1845                 margin-left: auto;
1846                 margin-right: auto;
1847                 margin-top: 10px;
1848                 margin-bottom: 10px;
1849                 text-align: left;
1850                 background-color: #ccc;
1851                 border: 1px solid #aaa;
1852             }
1853             p, h1, h2 {
1854                 margin-left: 20px;
1855                 margin-right: 20px;
1856                 font-family: verdana, tahoma, sans-serif;
1857             }
1858             a {
1859                 font-family: verdana, tahoma, sans-serif;
1860             }
1861             :link, :visited {
1862                     text-decoration: none;
1863                     color: #b00;
1864                     border-bottom: 1px dotted #bbb;
1865             }
1866             :link:hover, :visited:hover {
1867                     color: #555;
1868             }
1869             div#topbar {
1870                 margin: 0px;
1871             }
1872             pre {
1873                 margin: 10px;
1874                 padding: 8px;
1875             }
1876             div#answers {
1877                 padding: 8px;
1878                 margin: 10px;
1879                 background-color: #fff;
1880                 border: 1px solid #aaa;
1881             }
1882             h1 {
1883                 font-size: 0.9em;
1884                 font-weight: normal;
1885                 text-align: center;
1886             }
1887             h2 {
1888                 font-size: 1.0em;
1889             }
1890             p {
1891                 font-size: 0.9em;
1892             }
1893             p img {
1894                 float: right;
1895                 margin-left: 10px;
1896             }
1897             span#appname {
1898                 font-weight: bold;
1899                 font-size: 1.6em;
1900             }
1901         </style>
1902     </head>
1903     <body>
1904         <div id="content">
1905             <div id="topbar">
1906                 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1907                     $VERSION</h1>
1908              </div>
1909              <div id="answers">
1910                  <p>
1911                  <img src="$logo" alt="Catalyst Logo" />
1912                  </p>
1913                  <p>Welcome to the  world of Catalyst.
1914                     This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1915                     framework will make web development something you had
1916                     never expected it to be: Fun, rewarding, and quick.</p>
1917                  <h2>What to do now?</h2>
1918                  <p>That really depends  on what <b>you</b> want to do.
1919                     We do, however, provide you with a few starting points.</p>
1920                  <p>If you want to jump right into web development with Catalyst
1921                     you might want to start with a tutorial.</p>
1922 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1923 </pre>
1924 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1925 <pre>
1926 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1927 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1928 </code></pre>
1929                  <h2>What to do next?</h2>
1930                  <p>Next it's time to write an actual application. Use the
1931                     helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1932                     <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1933                     <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1934                     they can save you a lot of work.</p>
1935                     <pre><code>script/${prefix}_create.pl --help</code></pre>
1936                     <p>Also, be sure to check out the vast and growing
1937                     collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1938                     you are likely to find what you need there.
1939                     </p>
1940
1941                  <h2>Need help?</h2>
1942                  <p>Catalyst has a very active community. Here are the main places to
1943                     get in touch with us.</p>
1944                  <ul>
1945                      <li>
1946                          <a href="http://dev.catalyst.perl.org">Wiki</a>
1947                      </li>
1948                      <li>
1949                          <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1950                      </li>
1951                      <li>
1952                          <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1953                      </li>
1954                  </ul>
1955                  <h2>In conclusion</h2>
1956                  <p>The Catalyst team hopes you will enjoy using Catalyst as much
1957                     as we enjoyed making it. Please contact us if you have ideas
1958                     for improvement or other feedback.</p>
1959              </div>
1960          </div>
1961     </body>
1962 </html>
1963 EOF
1964 }
1965
1966 =head2 run_options
1967
1968 Contains a hash of options passed from the application script, including
1969 the original ARGV the script received, the processed values from that
1970 ARGV and any extra arguments to the script which were not processed.
1971
1972 This can be used to add custom options to your application's scripts
1973 and setup your application differently depending on the values of these
1974 options.
1975
1976 =head1 INTERNAL METHODS
1977
1978 These methods are not meant to be used by end users.
1979
1980 =head2 $c->components
1981
1982 Returns a hash of components.
1983
1984 =head2 $c->context_class
1985
1986 Returns or sets the context class.
1987
1988 =head2 $c->counter
1989
1990 Returns a hashref containing coderefs and execution counts (needed for
1991 deep recursion detection).
1992
1993 =head2 $c->depth
1994
1995 Returns the number of actions on the current internal execution stack.
1996
1997 =head2 $c->dispatch
1998
1999 Dispatches a request to actions.
2000
2001 =cut
2002
2003 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
2004
2005 =head2 $c->dispatcher_class
2006
2007 Returns or sets the dispatcher class.
2008
2009 =head2 $c->dump_these
2010
2011 Returns a list of 2-element array references (name, structure) pairs
2012 that will be dumped on the error page in debug mode.
2013
2014 =cut
2015
2016 sub dump_these {
2017     my $c = shift;
2018     [ Request => $c->req ],
2019     [ Response => $c->res ],
2020     [ Stash => $c->stash ],
2021     [ Config => $c->config ];
2022 }
2023
2024 =head2 $c->engine_class
2025
2026 Returns or sets the engine class.
2027
2028 =head2 $c->execute( $class, $coderef )
2029
2030 Execute a coderef in given class and catch exceptions. Errors are available
2031 via $c->error.
2032
2033 =cut
2034
2035 sub execute {
2036     my ( $c, $class, $code ) = @_;
2037     $class = $c->component($class) || $class;
2038     #$c->state(0);
2039
2040     if ( $c->depth >= $RECURSION ) {
2041         my $action = $code->reverse();
2042         $action = "/$action" unless $action =~ /->/;
2043         my $error = qq/Deep recursion detected calling "${action}"/;
2044         $c->log->error($error);
2045         $c->error($error);
2046         $c->state(0);
2047         return $c->state;
2048     }
2049
2050     my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2051
2052     push( @{ $c->stack }, $code );
2053
2054     no warnings 'recursion';
2055     # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2056     #      I have no idea how, ergo $ret (which appears to fix the issue)
2057     eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2058
2059     $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2060
2061     my $last = pop( @{ $c->stack } );
2062
2063     if ( my $error = $@ ) {
2064         #rethow if this can be handled by middleware
2065         if ( $c->_handle_http_exception($error) ) {
2066             foreach my $err (@{$c->error}) {
2067                 $c->log->error($err);
2068             }
2069             $c->clear_errors;
2070             $c->log->_flush if $c->log->can('_flush');
2071
2072             $error->can('rethrow') ? $error->rethrow : croak $error;
2073         }
2074         if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2075             $error->rethrow if $c->depth > 1;
2076         }
2077         elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2078             $error->rethrow if $c->depth > 0;
2079         }
2080         else {
2081             unless ( ref $error ) {
2082                 no warnings 'uninitialized';
2083                 chomp $error;
2084                 my $class = $last->class;
2085                 my $name  = $last->name;
2086                 $error = qq/Caught exception in $class->$name "$error"/;
2087             }
2088             $c->error($error);
2089         }
2090         #$c->state(0);
2091     }
2092     return $c->state;
2093 }
2094
2095 sub _stats_start_execute {
2096     my ( $c, $code ) = @_;
2097     my $appclass = ref($c) || $c;
2098     return if ( ( $code->name =~ /^_.*/ )
2099         && ( !$appclass->config->{show_internal_actions} ) );
2100
2101     my $action_name = $code->reverse();
2102     $c->counter->{$action_name}++;
2103
2104     my $action = $action_name;
2105     $action = "/$action" unless $action =~ /->/;
2106
2107     # determine if the call was the result of a forward
2108     # this is done by walking up the call stack and looking for a calling
2109     # sub of Catalyst::forward before the eval
2110     my $callsub = q{};
2111     for my $index ( 2 .. 11 ) {
2112         last
2113         if ( ( caller($index) )[0] eq 'Catalyst'
2114             && ( caller($index) )[3] eq '(eval)' );
2115
2116         if ( ( caller($index) )[3] =~ /forward$/ ) {
2117             $callsub = ( caller($index) )[3];
2118             $action  = "-> $action";
2119             last;
2120         }
2121     }
2122
2123     my $uid = $action_name . $c->counter->{$action_name};
2124
2125     # is this a root-level call or a forwarded call?
2126     if ( $callsub =~ /forward$/ ) {
2127         my $parent = $c->stack->[-1];
2128
2129         # forward, locate the caller
2130         if ( defined $parent && exists $c->counter->{"$parent"} ) {
2131             $c->stats->profile(
2132                 begin  => $action,
2133                 parent => "$parent" . $c->counter->{"$parent"},
2134                 uid    => $uid,
2135             );
2136         }
2137         else {
2138
2139             # forward with no caller may come from a plugin
2140             $c->stats->profile(
2141                 begin => $action,
2142                 uid   => $uid,
2143             );
2144         }
2145     }
2146     else {
2147
2148         # root-level call
2149         $c->stats->profile(
2150             begin => $action,
2151             uid   => $uid,
2152         );
2153     }
2154     return $action;
2155
2156 }
2157
2158 sub _stats_finish_execute {
2159     my ( $c, $info ) = @_;
2160     $c->stats->profile( end => $info );
2161 }
2162
2163 =head2 $c->finalize
2164
2165 Finalizes the request.
2166
2167 =cut
2168
2169 sub finalize {
2170     my $c = shift;
2171
2172     for my $error ( @{ $c->error } ) {
2173         $c->log->error($error);
2174     }
2175
2176     # Support skipping finalize for psgix.io style 'jailbreak'.  Used to support
2177     # stuff like cometd and websockets
2178
2179     if($c->request->_has_io_fh) {
2180       $c->log_response;
2181       return;
2182     }
2183
2184     # Allow engine to handle finalize flow (for POE)
2185     my $engine = $c->engine;
2186     if ( my $code = $engine->can('finalize') ) {
2187         $engine->$code($c);
2188     }
2189     else {
2190
2191         $c->finalize_uploads;
2192
2193         # Error
2194         if ( $#{ $c->error } >= 0 ) {
2195             $c->finalize_error;
2196         }
2197
2198         $c->finalize_encoding;
2199         $c->finalize_headers unless $c->response->finalized_headers;
2200         $c->finalize_body;
2201     }
2202
2203     $c->log_response;
2204
2205     if ($c->use_stats) {
2206         my $elapsed = $c->stats->elapsed;
2207         my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2208         $c->log->info(
2209             "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2210     }
2211
2212     return $c->response->status;
2213 }
2214
2215 =head2 $c->finalize_body
2216
2217 Finalizes body.
2218
2219 =cut
2220
2221 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2222
2223 =head2 $c->finalize_cookies
2224
2225 Finalizes cookies.
2226
2227 =cut
2228
2229 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2230
2231 =head2 $c->finalize_error
2232
2233 Finalizes error.  If there is only one error in L</error> and it is an object that
2234 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2235 up the ladder.  Otherwise we return the debugging error page (in debug mode) or we
2236 return the default error page (production mode).
2237
2238 =cut
2239
2240 sub finalize_error {
2241     my $c = shift;
2242     if($#{$c->error} > 0) {
2243         $c->engine->finalize_error( $c, @_ );
2244     } else {
2245         my ($error) = @{$c->error};
2246         if ( $c->_handle_http_exception($error) ) {
2247             # In the case where the error 'knows what it wants', becauses its PSGI
2248             # aware, just rethow and let middleware catch it
2249             $error->can('rethrow') ? $error->rethrow : croak $error;
2250         } else {
2251             $c->engine->finalize_error( $c, @_ )
2252         }
2253     }
2254 }
2255
2256 =head2 $c->finalize_headers
2257
2258 Finalizes headers.
2259
2260 =cut
2261
2262 sub finalize_headers {
2263     my $c = shift;
2264
2265     my $response = $c->response; #accessor calls can add up?
2266
2267     # Check if we already finalized headers
2268     return if $response->finalized_headers;
2269
2270     # Handle redirects
2271     if ( my $location = $response->redirect ) {
2272         $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2273         $response->header( Location => $location );
2274     }
2275
2276     # Remove incorrectly added body and content related meta data when returning
2277     # an information response, or a response the is required to not include a body
2278
2279     $c->finalize_cookies;
2280
2281     # This currently is a NOOP but I don't want to remove it since I guess people
2282     # might have Response subclasses that use it for something... (JNAP)
2283     $c->response->finalize_headers();
2284
2285     # Done
2286     $response->finalized_headers(1);
2287 }
2288
2289 =head2 $c->finalize_encoding
2290
2291 Make sure your body is encoded properly IF you set an encoding.  By
2292 default the encoding is UTF-8 but you can disable it by explicitly setting the
2293 encoding configuration value to undef.
2294
2295 We can only encode when the body is a scalar.  Methods for encoding via the
2296 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2297 are available).
2298
2299 See L</ENCODING>.
2300
2301 =cut
2302
2303 sub finalize_encoding {
2304     my $c = shift;
2305     my $res = $c->res || return;
2306
2307     # Warn if the set charset is different from the one you put into encoding.  We need
2308     # to do this early since encodable_response is false for this condition and we need
2309     # to match the debug output for backcompat (there's a test for this...) -JNAP
2310     if(
2311       $res->content_type_charset and $c->encoding and
2312       (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2313     ) {
2314         my $ct = lc($res->content_type_charset);
2315         $c->log->debug("Catalyst encoding config is set to encode in '" .
2316             $c->encoding->mime_name .
2317             "', content type is '$ct', not encoding ");
2318     }
2319
2320     if(
2321       ($res->encodable_response) and
2322       (defined($res->body)) and
2323       (ref(\$res->body) eq 'SCALAR')
2324     ) {
2325         # if you are finding yourself here and your body is already encoded correctly
2326         # and you want to turn this off, use $c->clear_encoding to prevent encoding
2327         # at this step, or set encoding to undef in the config to do so for the whole
2328         # application.  See the ENCODING documentaiton for better notes.
2329         $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2330
2331         # Set the charset if necessary.  This might be a bit bonkers since encodable response
2332         # is false when the set charset is not the same as the encoding mimetype (maybe
2333         # confusing action at a distance here..
2334         # Don't try to set the charset if one already exists or if headers are already finalized
2335         $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2336           unless($c->res->content_type_charset ||
2337                 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2338     }
2339 }
2340
2341 =head2 $c->finalize_output
2342
2343 An alias for finalize_body.
2344
2345 =head2 $c->finalize_read
2346
2347 Finalizes the input after reading is complete.
2348
2349 =cut
2350
2351 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2352
2353 =head2 $c->finalize_uploads
2354
2355 Finalizes uploads. Cleans up any temporary files.
2356
2357 =cut
2358
2359 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2360
2361 =head2 $c->get_action( $action, $namespace )
2362
2363 Gets an action in a given namespace.
2364
2365 =cut
2366
2367 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2368
2369 =head2 $c->get_actions( $action, $namespace )
2370
2371 Gets all actions of a given name in a namespace and all parent
2372 namespaces.
2373
2374 =cut
2375
2376 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2377
2378 =head2 $app->handle_request( @arguments )
2379
2380 Called to handle each HTTP request.
2381
2382 =cut
2383
2384 sub handle_request {
2385     my ( $class, @arguments ) = @_;
2386
2387     # Always expect worst case!
2388     my $status = -1;
2389     try {
2390         if ($class->debug) {
2391             my $secs = time - $START || 1;
2392             my $av = sprintf '%.3f', $COUNT / $secs;
2393             my $time = localtime time;
2394             $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2395         }
2396
2397         my $c = $class->prepare(@arguments);
2398         $c->dispatch;
2399         $status = $c->finalize;
2400     } catch {
2401         #rethow if this can be handled by middleware
2402         if ( $class->_handle_http_exception($_) ) {
2403             $_->can('rethrow') ? $_->rethrow : croak $_;
2404         }
2405         chomp(my $error = $_);
2406         $class->log->error(qq/Caught exception in engine "$error"/);
2407     };
2408
2409     $COUNT++;
2410
2411     if(my $coderef = $class->log->can('_flush')){
2412         $class->log->$coderef();
2413     }
2414     return $status;
2415 }
2416
2417 =head2 $class->prepare( @arguments )
2418
2419 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2420 etc.).
2421
2422 =cut
2423
2424 has _uploadtmp => (
2425     is => 'ro',
2426     predicate => '_has_uploadtmp',
2427 );
2428
2429 sub prepare {
2430     my ( $class, @arguments ) = @_;
2431
2432     # XXX
2433     # After the app/ctxt split, this should become an attribute based on something passed
2434     # into the application.
2435     $class->context_class( ref $class || $class ) unless $class->context_class;
2436
2437     my $uploadtmp = $class->config->{uploadtmp};
2438     my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2439
2440     $c->response->_context($c);
2441     $c->stats($class->stats_class->new)->enable($c->use_stats);
2442
2443     if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2444         $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2445     }
2446
2447     try {
2448         # Allow engine to direct the prepare flow (for POE)
2449         if ( my $prepare = $c->engine->can('prepare') ) {
2450             $c->engine->$prepare( $c, @arguments );
2451         }
2452         else {
2453             $c->prepare_request(@arguments);
2454             $c->prepare_connection;
2455             $c->prepare_query_parameters;
2456             $c->prepare_headers; # Just hooks, no longer needed - they just
2457             $c->prepare_cookies; # cause the lazy attribute on req to build
2458             $c->prepare_path;
2459
2460             # Prepare the body for reading, either by prepare_body
2461             # or the user, if they are using $c->read
2462             $c->prepare_read;
2463
2464             # Parse the body unless the user wants it on-demand
2465             unless ( ref($c)->config->{parse_on_demand} ) {
2466                 $c->prepare_body;
2467             }
2468         }
2469         $c->prepare_action;
2470     }
2471     # VERY ugly and probably shouldn't rely on ->finalize actually working
2472     catch {
2473         # failed prepare is always due to an invalid request, right?
2474         # Note we call finalize and then die here, which escapes
2475         # finalize being called in the enclosing block..
2476         # It in fact couldn't be called, as we don't return $c..
2477         # This is a mess - but I'm unsure you can fix this without
2478         # breaking compat for people doing crazy things (we should set
2479         # the 400 and just return the ctx here IMO, letting finalize get called
2480         # above...
2481         if ( $c->_handle_http_exception($_) ) {
2482             foreach my $err (@{$c->error}) {
2483                 $c->log->error($err);
2484             }
2485             $c->clear_errors;
2486             $c->log->_flush if $c->log->can('_flush');
2487             $_->can('rethrow') ? $_->rethrow : croak $_;
2488         } else {
2489             $c->response->status(400);
2490             $c->response->content_type('text/plain');
2491             $c->response->body('Bad Request');
2492             $c->finalize;
2493             die $_;
2494         }
2495     };
2496
2497     $c->log_request;
2498     $c->{stash} = $c->stash;
2499     Scalar::Util::weaken($c->{stash});
2500
2501     return $c;
2502 }
2503
2504 =head2 $c->prepare_action
2505
2506 Prepares action. See L<Catalyst::Dispatcher>.
2507
2508 =cut
2509
2510 sub prepare_action {
2511     my $c = shift;
2512     my $ret = $c->dispatcher->prepare_action( $c, @_);
2513
2514     if($c->encoding) {
2515         foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2516           $_ = $c->_handle_param_unicode_decoding($_);
2517         }
2518     }
2519
2520     return $ret;
2521 }
2522
2523
2524 =head2 $c->prepare_body
2525
2526 Prepares message body.
2527
2528 =cut
2529
2530 sub prepare_body {
2531     my $c = shift;
2532
2533     return if $c->request->_has_body;
2534
2535     # Initialize on-demand data
2536     $c->engine->prepare_body( $c, @_ );
2537     $c->prepare_parameters;
2538     $c->prepare_uploads;
2539 }
2540
2541 =head2 $c->prepare_body_chunk( $chunk )
2542
2543 Prepares a chunk of data before sending it to L<HTTP::Body>.
2544
2545 See L<Catalyst::Engine>.
2546
2547 =cut
2548
2549 sub prepare_body_chunk {
2550     my $c = shift;
2551     $c->engine->prepare_body_chunk( $c, @_ );
2552 }
2553
2554 =head2 $c->prepare_body_parameters
2555
2556 Prepares body parameters.
2557
2558 =cut
2559
2560 sub prepare_body_parameters {
2561     my $c = shift;
2562     $c->request->prepare_body_parameters( $c, @_ );
2563 }
2564
2565 =head2 $c->prepare_connection
2566
2567 Prepares connection.
2568
2569 =cut
2570
2571 sub prepare_connection {
2572     my $c = shift;
2573     $c->request->prepare_connection($c);
2574 }
2575
2576 =head2 $c->prepare_cookies
2577
2578 Prepares cookies by ensuring that the attribute on the request
2579 object has been built.
2580
2581 =cut
2582
2583 sub prepare_cookies { my $c = shift; $c->request->cookies }
2584
2585 =head2 $c->prepare_headers
2586
2587 Prepares request headers by ensuring that the attribute on the request
2588 object has been built.
2589
2590 =cut
2591
2592 sub prepare_headers { my $c = shift; $c->request->headers }
2593
2594 =head2 $c->prepare_parameters
2595
2596 Prepares parameters.
2597
2598 =cut
2599
2600 sub prepare_parameters {
2601     my $c = shift;
2602     $c->prepare_body_parameters;
2603     $c->engine->prepare_parameters( $c, @_ );
2604 }
2605
2606 =head2 $c->prepare_path
2607
2608 Prepares path and base.
2609
2610 =cut
2611
2612 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2613
2614 =head2 $c->prepare_query_parameters
2615
2616 Prepares query parameters.
2617
2618 =cut
2619
2620 sub prepare_query_parameters {
2621     my $c = shift;
2622
2623     $c->engine->prepare_query_parameters( $c, @_ );
2624 }
2625
2626 =head2 $c->log_request
2627
2628 Writes information about the request to the debug logs.  This includes:
2629
2630 =over 4
2631
2632 =item * Request method, path, and remote IP address
2633
2634 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2635
2636 =item * Request parameters
2637
2638 =item * File uploads
2639
2640 =back
2641
2642 =cut
2643
2644 sub log_request {
2645     my $c = shift;
2646
2647     return unless $c->debug;
2648
2649     my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2650     my $request = $dump->[1];
2651
2652     my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2653     $method ||= '';
2654     $path = '/' unless length $path;
2655     $address ||= '';
2656
2657     $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2658     $path = decode_utf8($path);
2659
2660     $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2661
2662     $c->log_request_headers($request->headers);
2663
2664     if ( my $keywords = $request->query_keywords ) {
2665         $c->log->debug("Query keywords are: $keywords");
2666     }
2667
2668     $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2669
2670     $c->log_request_uploads($request);
2671 }
2672
2673 =head2 $c->log_response
2674
2675 Writes information about the response to the debug logs by calling
2676 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2677
2678 =cut
2679
2680 sub log_response {
2681     my $c = shift;
2682
2683     return unless $c->debug;
2684
2685     my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2686     my $response = $dump->[1];
2687
2688     $c->log_response_status_line($response);
2689     $c->log_response_headers($response->headers);
2690 }
2691
2692 =head2 $c->log_response_status_line($response)
2693
2694 Writes one line of information about the response to the debug logs.  This includes:
2695
2696 =over 4
2697
2698 =item * Response status code
2699
2700 =item * Content-Type header (if present)
2701
2702 =item * Content-Length header (if present)
2703
2704 =back
2705
2706 =cut
2707
2708 sub log_response_status_line {
2709     my ($c, $response) = @_;
2710
2711     $c->log->debug(
2712         sprintf(
2713             'Response Code: %s; Content-Type: %s; Content-Length: %s',
2714             $response->status                            || 'unknown',
2715             $response->headers->header('Content-Type')   || 'unknown',
2716             $response->headers->header('Content-Length') || 'unknown'
2717         )
2718     );
2719 }
2720
2721 =head2 $c->log_response_headers($headers);
2722
2723 Hook method which can be wrapped by plugins to log the response headers.
2724 No-op in the default implementation.
2725
2726 =cut
2727
2728 sub log_response_headers {}
2729
2730 =head2 $c->log_request_parameters( query => {}, body => {} )
2731
2732 Logs request parameters to debug logs
2733
2734 =cut
2735
2736 sub log_request_parameters {
2737     my $c          = shift;
2738     my %all_params = @_;
2739
2740     return unless $c->debug;
2741
2742     my $column_width = Catalyst::Utils::term_width() - 44;
2743     foreach my $type (qw(query body)) {
2744         my $params = $all_params{$type};
2745         next if ! keys %$params;
2746         my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2747         for my $key ( sort keys %$params ) {
2748             my $param = $params->{$key};
2749             my $value = defined($param) ? $param : '';
2750             $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2751         }
2752         $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2753     }
2754 }
2755
2756 =head2 $c->log_request_uploads
2757
2758 Logs file uploads included in the request to the debug logs.
2759 The parameter name, filename, file type, and file size are all included in
2760 the debug logs.
2761
2762 =cut
2763
2764 sub log_request_uploads {
2765     my $c = shift;
2766     my $request = shift;
2767     return unless $c->debug;
2768     my $uploads = $request->uploads;
2769     if ( keys %$uploads ) {
2770         my $t = Text::SimpleTable->new(
2771             [ 12, 'Parameter' ],
2772             [ 26, 'Filename' ],
2773             [ 18, 'Type' ],
2774             [ 9,  'Size' ]
2775         );
2776         for my $key ( sort keys %$uploads ) {
2777             my $upload = $uploads->{$key};
2778             for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2779                 $t->row( $key, $u->filename, $u->type, $u->size );
2780             }
2781         }
2782         $c->log->debug( "File Uploads are:\n" . $t->draw );
2783     }
2784 }
2785
2786 =head2 $c->log_request_headers($headers);
2787
2788 Hook method which can be wrapped by plugins to log the request headers.
2789 No-op in the default implementation.
2790
2791 =cut
2792
2793 sub log_request_headers {}
2794
2795 =head2 $c->log_headers($type => $headers)
2796
2797 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2798
2799 =cut
2800
2801 sub log_headers {
2802     my $c       = shift;
2803     my $type    = shift;
2804     my $headers = shift;    # an HTTP::Headers instance
2805
2806     return unless $c->debug;
2807
2808     my $column_width = Catalyst::Utils::term_width() - 28;
2809     my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2810     $headers->scan(
2811         sub {
2812             my ( $name, $value ) = @_;
2813             $t->row( $name, $value );
2814         }
2815     );
2816     $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2817 }
2818
2819
2820 =head2 $c->prepare_read
2821
2822 Prepares the input for reading.
2823
2824 =cut
2825
2826 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2827
2828 =head2 $c->prepare_request
2829
2830 Prepares the engine request.
2831
2832 =cut
2833
2834 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2835
2836 =head2 $c->prepare_uploads
2837
2838 Prepares uploads.
2839
2840 =cut
2841
2842 sub prepare_uploads {
2843     my $c = shift;
2844     $c->engine->prepare_uploads( $c, @_ );
2845 }
2846
2847 =head2 $c->prepare_write
2848
2849 Prepares the output for writing.
2850
2851 =cut
2852
2853 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2854
2855 =head2 $c->request_class
2856
2857 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2858
2859 =head2 $app->request_class_traits
2860
2861 An arrayref of L<Moose::Role>s which are applied to the request class.  You can
2862 name the full namespace of the role, or a namespace suffix, which will then
2863 be tried against the following standard namespace prefixes.
2864
2865     $MyApp::TraitFor::Request::$trait_suffix
2866     Catalyst::TraitFor::Request::$trait_suffix
2867
2868 So for example if you set:
2869
2870     MyApp->request_class_traits(['Foo']);
2871
2872 We try each possible role in turn (and throw an error if none load)
2873
2874     Foo
2875     MyApp::TraitFor::Request::Foo
2876     Catalyst::TraitFor::Request::Foo
2877
2878 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2879 compatibility with L<CatalystX::RoleApplicator> which previously provided
2880 these features in a stand alone package.
2881
2882 =head2 $app->composed_request_class
2883
2884 This is the request class which has been composed with any request_class_traits.
2885
2886 =head2 $c->response_class
2887
2888 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2889
2890 =head2 $app->response_class_traits
2891
2892 An arrayref of L<Moose::Role>s which are applied to the response class.  You can
2893 name the full namespace of the role, or a namespace suffix, which will then
2894 be tried against the following standard namespace prefixes.
2895
2896     $MyApp::TraitFor::Response::$trait_suffix
2897     Catalyst::TraitFor::Response::$trait_suffix
2898
2899 So for example if you set:
2900
2901     MyApp->response_class_traits(['Foo']);
2902
2903 We try each possible role in turn (and throw an error if none load)
2904
2905     Foo
2906     MyApp::TraitFor::Response::Foo
2907     Catalyst::TraitFor::Responset::Foo
2908
2909 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2910 compatibility with L<CatalystX::RoleApplicator> which previously provided
2911 these features in a stand alone package.
2912
2913
2914 =head2 $app->composed_response_class
2915
2916 This is the request class which has been composed with any response_class_traits.
2917
2918 =head2 $c->read( [$maxlength] )
2919
2920 Reads a chunk of data from the request body. This method is designed to
2921 be used in a while loop, reading C<$maxlength> bytes on every call.
2922 C<$maxlength> defaults to the size of the request if not specified.
2923
2924 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2925 directly.
2926
2927 Warning: If you use read(), Catalyst will not process the body,
2928 so you will not be able to access POST parameters or file uploads via
2929 $c->request.  You must handle all body parsing yourself.
2930
2931 =cut
2932
2933 sub read { my $c = shift; return $c->request->read( @_ ) }
2934
2935 =head2 $c->run
2936
2937 Starts the engine.
2938
2939 =cut
2940
2941 sub run {
2942   my $app = shift;
2943   $app->_make_immutable_if_needed;
2944   $app->engine_loader->needs_psgi_engine_compat_hack ?
2945     $app->engine->run($app, @_) :
2946       $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2947 }
2948
2949 sub _make_immutable_if_needed {
2950     my $class = shift;
2951     my $meta = find_meta($class);
2952     my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2953     if (
2954         $meta->is_immutable
2955         && ! { $meta->immutable_options }->{replace_constructor}
2956         && $isa_ca
2957     ) {
2958         warn("You made your application class ($class) immutable, "
2959             . "but did not inline the\nconstructor. "
2960             . "This will break catalyst, as your app \@ISA "
2961             . "Class::Accessor(::Fast)?\nPlease pass "
2962             . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2963     }
2964     unless ($meta->is_immutable) {
2965         # XXX - FIXME warning here as you should make your app immutable yourself.
2966         $meta->make_immutable(
2967             replace_constructor => 1,
2968         );
2969     }
2970 }
2971
2972 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2973
2974 Sets an action in a given namespace.
2975
2976 =cut
2977
2978 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2979
2980 =head2 $c->setup_actions($component)
2981
2982 Sets up actions for a component.
2983
2984 =cut
2985
2986 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2987
2988 =head2 $c->setup_components
2989
2990 This method is called internally to set up the application's components.
2991
2992 It finds modules by calling the L<locate_components> method, expands them to
2993 package names with the L<expand_component_module> method, and then installs
2994 each component into the application.
2995
2996 The C<setup_components> config option is passed to both of the above methods.
2997
2998 Installation of each component is performed by the L<setup_component> method,
2999 below.
3000
3001 =cut
3002
3003 sub setup_components {
3004     my $class = shift;
3005
3006     my $config  = $class->config->{ setup_components };
3007
3008     my @comps = $class->locate_components($config);
3009     my %comps = map { $_ => 1 } @comps;
3010
3011     my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3012     $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3013         qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3014     ) if $deprecatedcatalyst_component_names;
3015
3016     for my $component ( @comps ) {
3017
3018         # We pass ignore_loaded here so that overlay files for (e.g.)
3019         # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3020         # we know M::P::O found a file on disk so this is safe
3021
3022         Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3023     }
3024
3025     for my $component (@comps) {
3026         my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3027     }
3028
3029     # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3030     # of named components in the configuration that are not actually existing (not a
3031     # real file).
3032
3033     my @injected = $class->setup_injected_components;
3034
3035     # All components are registered, now we need to 'init' them.
3036     foreach my $component_name (@comps, @injected) {
3037       $class->components->{$component_name} = $class->components->{$component_name}->() if
3038         (ref($class->components->{$component_name}) || '') eq 'CODE';
3039     }
3040 }
3041
3042 =head2 $app->setup_injected_components
3043
3044 Called by setup_compoents to setup components that are injected.
3045
3046 =cut
3047
3048 sub setup_injected_components {
3049     my ($class) = @_;
3050     my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3051
3052     foreach my $injected_comp_name(@injected_components) {
3053         $class->setup_injected_component(
3054           $injected_comp_name,
3055           $class->config->{inject_components}->{$injected_comp_name});
3056     }
3057
3058     return map { $class ."::" . $_ }
3059       @injected_components;
3060 }
3061
3062 =head2 $app->setup_injected_component( $injected_component_name, $config )
3063
3064 Setup a given injected component.
3065
3066 =cut
3067
3068 sub setup_injected_component {
3069     my ($class, $injected_comp_name, $config) = @_;
3070     if(my $component_class = $config->{from_component}) {
3071         my @roles = @{$config->{roles} ||[]};
3072         Catalyst::Utils::inject_component(
3073           into => $class,
3074           component => $component_class,
3075           (scalar(@roles) ? (traits => \@roles) : ()),
3076           as => $injected_comp_name);
3077     }
3078 }
3079
3080 =head2 $app->inject_component($MyApp_Component_name => \%args);
3081
3082 Add a component that is injected at setup:
3083
3084     MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3085
3086 Must be called before ->setup.  Expects a component name for your
3087 current application and \%args where
3088
3089 =over 4
3090
3091 =item from_component
3092
3093 The target component being injected into your application
3094
3095 =item roles
3096
3097 An arrayref of L<Moose::Role>s that are applied to your component.
3098
3099 =back
3100
3101 Example
3102
3103     MyApp->inject_component(
3104       'Model::Foo' => {
3105         from_component => 'Common::Model::Foo',
3106         roles => ['Role1', 'Role2'],
3107       });
3108
3109 =head2 $app->inject_components
3110
3111 Inject a list of components:
3112
3113     MyApp->inject_components(
3114       'Model::FooOne' => {
3115         from_component => 'Common::Model::Foo',
3116         roles => ['Role1', 'Role2'],
3117       },
3118       'Model::FooTwo' => {
3119         from_component => 'Common::Model::Foo',
3120         roles => ['Role1', 'Role2'],
3121       });
3122
3123 =cut
3124
3125 sub inject_component {
3126   my ($app, $name, $args) = @_;
3127   die "Component $name exists" if
3128     $app->config->{inject_components}->{$name};
3129   $app->config->{inject_components}->{$name} = $args;
3130 }
3131
3132 sub inject_components {
3133   my $app = shift;
3134   while(@_) {
3135     $app->inject_component(shift, shift);
3136   }
3137 }
3138
3139 =head2 $c->locate_components( $setup_component_config )
3140
3141 This method is meant to provide a list of component modules that should be
3142 setup for the application.  By default, it will use L<Module::Pluggable>.
3143
3144 Specify a C<setup_components> config option to pass additional options directly
3145 to L<Module::Pluggable>. To add additional search paths, specify a key named
3146 C<search_extra> as an array reference. Items in the array beginning with C<::>
3147 will have the application class name prepended to them.
3148
3149 =cut
3150
3151 sub locate_components {
3152     my $class  = shift;
3153     my $config = shift;
3154
3155     my @paths   = qw( ::M ::Model ::V ::View ::C ::Controller );
3156     my $extra   = $config->{ search_extra } || [];
3157
3158     unshift @paths, @$extra;
3159
3160     my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3161       search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3162       %$config
3163     )->plugins } @paths;
3164
3165     return @comps;
3166 }
3167
3168 =head2 $c->expand_component_module( $component, $setup_component_config )
3169
3170 Components found by C<locate_components> will be passed to this method, which
3171 is expected to return a list of component (package) names to be set up.
3172
3173 =cut
3174
3175 sub expand_component_module {
3176     my ($class, $module) = @_;
3177     return Devel::InnerPackage::list_packages( $module );
3178 }
3179
3180 =head2 $app->delayed_setup_component
3181
3182 Returns a coderef that points to a setup_component instance.  Used
3183 internally for when you want to delay setup until the first time
3184 the component is called.
3185
3186 =cut
3187
3188 sub delayed_setup_component {
3189   my($class, $component, @more) = @_;
3190   return sub {
3191     return my $instance = $class->setup_component($component, @more);
3192   };
3193 }
3194
3195 =head2 $c->setup_component
3196
3197 =cut
3198
3199 sub setup_component {
3200     my( $class, $component ) = @_;
3201
3202     unless ( $component->can( 'COMPONENT' ) ) {
3203         return $component;
3204     }
3205
3206     my $config = $class->config_for($component);
3207     # Stash catalyst_component_name in the config here, so that custom COMPONENT
3208     # methods also pass it. local to avoid pointlessly shitting in config
3209     # for the debug screen, as $component is already the key name.
3210     local $config->{catalyst_component_name} = $component;
3211
3212     my $instance = eval {
3213       $component->COMPONENT( $class, $config );
3214     } || do {
3215       my $error = $@;
3216       chomp $error;
3217       Catalyst::Exception->throw(
3218         message => qq/Couldn't instantiate component "$component", "$error"/
3219       );
3220     };
3221
3222     unless (blessed $instance) {
3223         my $metaclass = Moose::Util::find_meta($component);
3224         my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3225         my $component_method_from = $method_meta->associated_metaclass->name;
3226         my $value = defined($instance) ? $instance : 'undef';
3227         Catalyst::Exception->throw(
3228             message =>
3229             qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3230         );
3231     }
3232
3233     my @expanded_components = $instance->can('expand_modules')
3234       ? $instance->expand_modules( $component, $config )
3235       : $class->expand_component_module( $component, $config );
3236     for my $component (@expanded_components) {
3237       next if $class->components->{ $component };
3238       $class->components->{ $component } = $class->setup_component($component);
3239     }
3240
3241     return $instance;
3242 }
3243
3244 =head2 $app->config_for( $component_name )
3245
3246 Return the application level configuration (which is not yet merged with any
3247 local component configuration, via $component_class->config) for the named
3248 component or component object. Example:
3249
3250     MyApp->config(
3251       'Model::Foo' => { a => 1, b => 2},
3252     );
3253
3254     my $config = MyApp->config_for('MyApp::Model::Foo');
3255
3256 In this case $config is the hashref C< {a=>1, b=>2} >.
3257
3258 This is also handy for looking up configuration for a plugin, to make sure you follow
3259 existing L<Catalyst> standards for where a plugin should put its configuration.
3260
3261 =cut
3262
3263 sub config_for {
3264     my ($class, $component_name) = @_;
3265     my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3266     my $config = $class->config->{ $component_suffix } || {};
3267
3268     return $config;
3269 }
3270
3271 =head2 $c->setup_dispatcher
3272
3273 Sets up dispatcher.
3274
3275 =cut
3276
3277 sub setup_dispatcher {
3278     my ( $class, $dispatcher ) = @_;
3279
3280     if ($dispatcher) {
3281         $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3282     }
3283
3284     if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3285         $dispatcher = 'Catalyst::Dispatcher::' . $env;
3286     }
3287
3288     unless ($dispatcher) {
3289         $dispatcher = $class->dispatcher_class;
3290     }
3291
3292     load_class($dispatcher);
3293
3294     # dispatcher instance
3295     $class->dispatcher( $dispatcher->new );
3296 }
3297
3298 =head2 $c->setup_engine
3299
3300 Sets up engine.
3301
3302 =cut
3303
3304 sub engine_class {
3305     my ($class, $requested_engine) = @_;
3306
3307     if (!$class->engine_loader || $requested_engine) {
3308         $class->engine_loader(
3309             Catalyst::EngineLoader->new({
3310                 application_name => $class,
3311                 (defined $requested_engine
3312                      ? (catalyst_engine_class => $requested_engine) : ()),
3313             }),
3314         );
3315     }
3316
3317     $class->engine_loader->catalyst_engine_class;
3318 }
3319
3320 sub setup_engine {
3321     my ($class, $requested_engine) = @_;
3322
3323     my $engine = do {
3324         my $loader = $class->engine_loader;
3325
3326         if (!$loader || $requested_engine) {
3327             $loader = Catalyst::EngineLoader->new({
3328                 application_name => $class,
3329                 (defined $requested_engine
3330                      ? (requested_engine => $requested_engine) : ()),
3331             }),
3332
3333             $class->engine_loader($loader);
3334         }
3335
3336         $loader->catalyst_engine_class;
3337     };
3338
3339     # Don't really setup_engine -- see _setup_psgi_app for explanation.
3340     return if $class->loading_psgi_file;
3341
3342     load_class($engine);
3343
3344     if ($ENV{MOD_PERL}) {
3345         my $apache = $class->engine_loader->auto;
3346
3347         my $meta = find_meta($class);
3348         my $was_immutable = $meta->is_immutable;
3349         my %immutable_options = $meta->immutable_options;
3350         $meta->make_mutable if $was_immutable;
3351
3352         $meta->add_method(handler => sub {
3353             my $r = shift;
3354             my $psgi_app = $class->_finalized_psgi_app;
3355             $apache->call_app($r, $psgi_app);
3356         });
3357
3358         $meta->make_immutable(%immutable_options) if $was_immutable;
3359     }
3360
3361     $class->engine( $engine->new );
3362
3363     return;
3364 }
3365
3366 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3367 ## build in server support (back compat support for pre psgi port behavior).
3368 ## This is so that we don't build a new psgi app for each request when using
3369 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3370
3371 sub _finalized_psgi_app {
3372     my ($app) = @_;
3373
3374     unless ($app->_psgi_app) {
3375         my $psgi_app = $app->_setup_psgi_app;
3376         $app->_psgi_app($psgi_app);
3377     }
3378
3379     return $app->_psgi_app;
3380 }
3381
3382 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3383 ## home directory and load that and return it (just assume it is doing the
3384 ## right thing :) ).  If that does not exist, call $app->psgi_app, wrap that
3385 ## in default_middleware and return it ( this is for backward compatibility
3386 ## with pre psgi port behavior ).
3387
3388 sub _setup_psgi_app {
3389     my ($app) = @_;
3390
3391     for my $home (Path::Class::Dir->new($app->config->{home})) {
3392         my $psgi_file = $home->file(
3393             Catalyst::Utils::appprefix($app) . '.psgi',
3394         );
3395
3396         next unless -e $psgi_file;
3397
3398         # If $psgi_file calls ->setup_engine, it's doing so to load
3399         # Catalyst::Engine::PSGI. But if it does that, we're only going to
3400         # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3401         # anyway. So set a flag (ick) that tells setup_engine not to populate
3402         # $c->engine or do any other things we might regret.
3403
3404         $app->loading_psgi_file(1);
3405         my $psgi_app = Plack::Util::load_psgi($psgi_file);
3406         $app->loading_psgi_file(0);
3407
3408         return $psgi_app
3409             unless $app->engine_loader->needs_psgi_engine_compat_hack;
3410
3411         warn <<"EOW";
3412 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3413
3414 Its content has been ignored. Please consult the Catalyst::Upgrading
3415 documentation on how to upgrade from Catalyst::Engine::PSGI.
3416 EOW
3417     }
3418
3419     return $app->apply_default_middlewares($app->psgi_app);
3420 }
3421
3422 =head2 $c->apply_default_middlewares
3423
3424 Adds the following L<Plack> middlewares to your application, since they are
3425 useful and commonly needed:
3426
3427 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3428 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3429 is smart enough to conditionally apply itself).
3430
3431 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3432 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'.  This is usually
3433 an indication that your server is running behind a proxy frontend.  However in
3434 2014 this is often not the case.  We preserve this code for backwards compatibility
3435 however I B<highly> recommend that if you are running the server behind a front
3436 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3437 setting to true for your environment configurations that run behind a proxy.  This
3438 way if you change your front end proxy address someday your code would inexplicably
3439 stop working as expected.
3440
3441 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3442 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3443 $ENV{SCRIPT_NAME}.
3444
3445 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3446 adding via C<registered_middleware> rather than this method.
3447
3448 If you are using Lighttpd or IIS6 you may wish to apply these middlewares.  In
3449 general this is no longer a common case but we have this here for backward
3450 compatibility.
3451
3452 =cut
3453
3454
3455 sub apply_default_middlewares {
3456     my ($app, $psgi_app) = @_;
3457
3458     # Don't add this conditional IF we are explicitly saying we want the
3459     # frontend proxy support.  We don't need it here since if that is the
3460     # case it will be always loaded in the default_middleware.
3461
3462     unless($app->config->{using_frontend_proxy}) {
3463       $psgi_app = Plack::Middleware::Conditional->wrap(
3464           $psgi_app,
3465           builder   => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3466           condition => sub {
3467               my ($env) = @_;
3468               return if $app->config->{ignore_frontend_proxy};
3469               return $env->{REMOTE_ADDR} eq '127.0.0.1';
3470           },
3471       );
3472     }
3473
3474     # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3475     # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3476     $psgi_app = Plack::Middleware::Conditional->wrap(
3477         $psgi_app,
3478         builder   => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3479         condition => sub {
3480             my ($env) = @_;
3481             return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3482             return unless $1 < 4.23;
3483             1;
3484         },
3485     );
3486
3487     # we're applying this unconditionally as the middleware itself already makes
3488     # sure it doesn't fuck things up if it's not running under one of the right
3489     # IIS versions
3490     $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3491
3492     # And another IIS issue, this time with IIS7.
3493     $psgi_app = Plack::Middleware::Conditional->wrap(
3494         $psgi_app,
3495         builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3496         condition => sub {
3497             my ($env) = @_;
3498             return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3499         },
3500     );
3501
3502     return $psgi_app;
3503 }
3504
3505 =head2 App->psgi_app
3506
3507 =head2 App->to_app
3508
3509 Returns a PSGI application code reference for the catalyst application
3510 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3511 method called.  We do however apply C<registered_middleware> since those are
3512 integral to how L<Catalyst> functions.  Also, unlike starting your application
3513 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3514 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3515 scripts in your $HOME directory.
3516
3517 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3518 port was done for v5.90000.  These are middlewares that are added to achieve
3519 backward compatibility with older applications.  If you start your application
3520 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3521 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3522 automatically.  This was done so that pre and post PSGI port applications would
3523 work the same way.
3524
3525 This is what you want to be using to retrieve the PSGI application code
3526 reference of your Catalyst application for use in a custom F<.psgi> or in your
3527 own created server modules.
3528
3529 =cut
3530
3531 *to_app = \&psgi_app;
3532
3533 sub psgi_app {
3534     my ($app) = @_;
3535     my $psgi = $app->engine->build_psgi_app($app);
3536     return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3537 }
3538
3539 =head2 $c->setup_home
3540
3541 Sets up the home directory.
3542
3543 =cut
3544
3545 sub setup_home {
3546     my ( $class, $home ) = @_;
3547
3548     if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3549         $home = $env;
3550     }
3551
3552     $home ||= Catalyst::Utils::home($class);
3553
3554     if ($home) {
3555         #I remember recently being scolded for assigning config values like this
3556         $class->config->{home} ||= $home;
3557         $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3558     }
3559 }
3560
3561 =head2 $c->setup_encoding
3562
3563 Sets up the input/output encoding. See L<ENCODING>
3564
3565 =cut
3566
3567 sub setup_encoding {
3568     my $c = shift;
3569     if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3570         # Ok, so the user has explicitly said "I don't want encoding..."
3571         return;
3572     } else {
3573       my $enc = defined($c->config->{encoding}) ?
3574         delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3575       $c->encoding($enc);
3576     }
3577 }
3578
3579 =head2 handle_unicode_encoding_exception
3580
3581 Hook to let you customize how encoding errors are handled. By default
3582 we just throw an exception and the default error page will pick it up.
3583 Receives a hashref of debug information. Example of call (from the
3584 Catalyst internals):
3585
3586   my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3587         param_value => $value,
3588         error_msg => $_,
3589         encoding_step => 'params',
3590    });
3591
3592 The calling code expects to receive a decoded string or an exception.
3593
3594 You can override this for custom handling of unicode errors. By
3595 default we just die. If you want a custom response here, one approach
3596 is to throw an HTTP style exception, instead of returning a decoded
3597 string or throwing a generic exception.
3598
3599     sub handle_unicode_encoding_exception {
3600       my ($c, $params) = @_;
3601       HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3602     }
3603
3604 Alternatively you can 'catch' the error, stash it and write handling code later
3605 in your application:
3606
3607     sub handle_unicode_encoding_exception {
3608       my ($c, $params) = @_;
3609       $c->stash(BAD_UNICODE_DATA=>$params);
3610       # return a dummy string.
3611       return 1;
3612     }
3613
3614 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3615 the request setup is still ongoing, which means the state of C<$c> and
3616 related context parts like the request and response may not be setup
3617 up correctly (since we haven't finished the setup yet). If you throw
3618 an exception the setup is aborted.
3619
3620 =cut
3621
3622 sub handle_unicode_encoding_exception {
3623     my ( $self, $exception_ctx ) = @_;
3624     die $exception_ctx->{error_msg};
3625 }
3626
3627 # Some unicode helpers cargo culted from the old plugin.  These could likely
3628 # be neater.
3629
3630 sub _handle_unicode_decoding {
3631     my ( $self, $value ) = @_;
3632
3633     return unless defined $value;
3634
3635     ## I think this mess is to support the old nested
3636     if ( ref $value eq 'ARRAY' ) {
3637         foreach ( @$value ) {
3638             $_ = $self->_handle_unicode_decoding($_);
3639         }
3640         return $value;
3641     }
3642     elsif ( ref $value eq 'HASH' ) {
3643         foreach (keys %$value) {
3644             my $encoded_key = $self->_handle_param_unicode_decoding($_);
3645             $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3646
3647             # If the key was encoded we now have two (the original and current so
3648             # delete the original.
3649             delete $value->{$_} if $_ ne $encoded_key;
3650         }
3651         return $value;
3652     }
3653     else {
3654         return $self->_handle_param_unicode_decoding($value);
3655     }
3656 }
3657
3658 sub _handle_param_unicode_decoding {
3659     my ( $self, $value, $check ) = @_;
3660     return unless defined $value; # not in love with just ignoring undefs - jnap
3661     return $value if blessed($value); #don't decode when the value is an object.
3662
3663     my $enc = $self->encoding;
3664
3665     return $value unless $enc; # don't decode if no encoding is specified
3666
3667     $check ||= $self->_encode_check;
3668     return try {
3669       $enc->decode( $value, $check);
3670     }
3671     catch {
3672         return $self->handle_unicode_encoding_exception({
3673             param_value => $value,
3674             error_msg => $_,
3675             encoding_step => 'params',
3676         });
3677     };
3678 }
3679
3680 =head2 $c->setup_log
3681
3682 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3683 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3684 log to.
3685
3686 This method also installs a C<debug> method that returns a true value into the
3687 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3688 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3689
3690 Note that if the log has already been setup, by either a previous call to
3691 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3692 that this method won't actually set up the log object.
3693
3694 =cut
3695
3696 sub setup_log {
3697     my ( $class, $levels ) = @_;
3698
3699     $levels ||= '';
3700     $levels =~ s/^\s+//;
3701     $levels =~ s/\s+$//;
3702     my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3703
3704     my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3705     if ( defined $env_debug ) {
3706         $levels{debug} = 1 if $env_debug; # Ugly!
3707         delete($levels{debug}) unless $env_debug;
3708     }
3709
3710     unless ( $class->log ) {
3711         $class->log( Catalyst::Log->new(keys %levels) );
3712     }
3713
3714     if ( $levels{debug} ) {
3715         Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3716         $class->log->debug('Debug messages enabled');
3717     }
3718 }
3719
3720 =head2 $c->setup_plugins
3721
3722 Sets up plugins.
3723
3724 =cut
3725
3726 =head2 $c->setup_stats
3727
3728 Sets up timing statistics class.
3729
3730 =cut
3731
3732 sub setup_stats {
3733     my ( $class, $stats ) = @_;
3734
3735     Catalyst::Utils::ensure_class_loaded($class->stats_class);
3736
3737     my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3738     if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3739         Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3740         $class->log->debug('Statistics enabled');
3741     }
3742 }
3743
3744
3745 =head2 $c->registered_plugins
3746
3747 Returns a sorted list of the plugins which have either been stated in the
3748 import list.
3749
3750 If passed a given plugin name, it will report a boolean value indicating
3751 whether or not that plugin is loaded.  A fully qualified name is required if
3752 the plugin name does not begin with C<Catalyst::Plugin::>.
3753
3754  if ($c->registered_plugins('Some::Plugin')) {
3755      ...
3756  }
3757
3758 =cut
3759
3760 {
3761
3762     sub registered_plugins {
3763         my $proto = shift;
3764         return sort keys %{ $proto->_plugins } unless @_;
3765         my $plugin = shift;
3766         return 1 if exists $proto->_plugins->{$plugin};
3767         return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3768     }
3769
3770     sub _register_plugin {
3771         my ( $proto, $plugin, $instant ) = @_;
3772         my $class = ref $proto || $proto;
3773
3774         load_class( $plugin );
3775         $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3776             if $plugin->isa( 'Catalyst::Component' );
3777         my $plugin_meta = Moose::Meta::Class->create($plugin);
3778         if (!$plugin_meta->has_method('new')
3779             && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3780             $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3781         }
3782         if (!$instant && !$proto->_plugins->{$plugin}) {
3783             my $meta = Class::MOP::get_metaclass_by_name($class);
3784             $meta->superclasses($plugin, $meta->superclasses);
3785         }
3786         $proto->_plugins->{$plugin} = 1;
3787         return $class;
3788     }
3789
3790     sub _default_plugins { return qw() }
3791
3792     sub setup_plugins {
3793         my ( $class, $plugins ) = @_;
3794
3795         $class->_plugins( {} ) unless $class->_plugins;
3796         $plugins = [ grep {
3797             m/Unicode::Encoding/ ? do {
3798                 $class->log->warn(
3799                     'Unicode::Encoding plugin is auto-applied,'
3800                     . ' please remove this from your appclass'
3801                     . ' and make sure to define "encoding" config'
3802                 );
3803                 unless (exists $class->config->{'encoding'}) {
3804                   $class->config->{'encoding'} = 'UTF-8';
3805                 }
3806                 () }
3807                 : $_
3808         } @$plugins ];
3809         push @$plugins, $class->_default_plugins;
3810         $plugins = Data::OptList::mkopt($plugins || []);
3811
3812         my @plugins = map {
3813             [ Catalyst::Utils::resolve_namespace(
3814                   $class . '::Plugin',
3815                   'Catalyst::Plugin', $_->[0]
3816               ),
3817               $_->[1],
3818             ]
3819          } @{ $plugins };
3820
3821         for my $plugin ( reverse @plugins ) {
3822             load_class($plugin->[0], $plugin->[1]);
3823             my $meta = find_meta($plugin->[0]);
3824             next if $meta && $meta->isa('Moose::Meta::Role');
3825
3826             $class->_register_plugin($plugin->[0]);
3827         }
3828
3829         my @roles =
3830             map  { $_->[0]->name, $_->[1] }
3831             grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3832             map  { [find_meta($_->[0]), $_->[1]] }
3833             @plugins;
3834
3835         Moose::Util::apply_all_roles(
3836             $class => @roles
3837         ) if @roles;
3838     }
3839 }
3840
3841 =head2 default_middleware
3842
3843 Returns a list of instantiated PSGI middleware objects which is the default
3844 middleware that is active for this application (taking any configuration
3845 options into account, excluding your custom added middleware via the C<psgi_middleware>
3846 configuration option).  You can override this method if you wish to change
3847 the default middleware (although do so at risk since some middleware is vital
3848 to application function.)
3849
3850 The current default middleware list is:
3851
3852       Catalyst::Middleware::Stash
3853       Plack::Middleware::HTTPExceptions
3854       Plack::Middleware::RemoveRedundantBody
3855       Plack::Middleware::FixMissingBodyInRedirect
3856       Plack::Middleware::ContentLength
3857       Plack::Middleware::MethodOverride
3858       Plack::Middleware::Head
3859
3860 If the configuration setting C<using_frontend_proxy> is true we add:
3861
3862       Plack::Middleware::ReverseProxy
3863
3864 If the configuration setting C<using_frontend_proxy_path> is true we add:
3865
3866       Plack::Middleware::ReverseProxyPath
3867
3868 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3869 L<Catalyst> distribution so if you want to use this option you should add it to
3870 your project distribution file.
3871
3872 These middlewares will be added at L</setup_middleware> during the
3873 L</setup> phase of application startup.
3874
3875 =cut
3876
3877 sub default_middleware {
3878     my $class = shift;
3879     my @mw = (
3880       Catalyst::Middleware::Stash->new,
3881       Plack::Middleware::HTTPExceptions->new,
3882       Plack::Middleware::RemoveRedundantBody->new,
3883       Plack::Middleware::FixMissingBodyInRedirect->new,
3884       Plack::Middleware::ContentLength->new,
3885       Plack::Middleware::MethodOverride->new,
3886       Plack::Middleware::Head->new);
3887
3888     if($class->config->{using_frontend_proxy}) {
3889         push @mw, Plack::Middleware::ReverseProxy->new;
3890     }
3891
3892     if($class->config->{using_frontend_proxy_path}) {
3893         if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3894             push @mw, Plack::Middleware::ReverseProxyPath->new;
3895         } else {
3896           $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3897         }
3898     }
3899
3900     return @mw;
3901 }
3902
3903 =head2 registered_middlewares
3904
3905 Read only accessor that returns an array of all the middleware in the order
3906 that they were added (which is the REVERSE of the order they will be applied).
3907
3908 The values returned will be either instances of L<Plack::Middleware> or of a
3909 compatible interface, or a coderef, which is assumed to be inlined middleware
3910
3911 =head2 setup_middleware (?@middleware)
3912
3913 Read configuration information stored in configuration key C<psgi_middleware> or
3914 from passed @args.
3915
3916 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3917 to use it to enable L<Plack::Middleware>
3918
3919 This method is automatically called during 'setup' of your application, so
3920 you really don't need to invoke it.  However you may do so if you find the idea
3921 of loading middleware via configuration weird :).  For example:
3922
3923     package MyApp;
3924
3925     use Catalyst;
3926
3927     __PACKAGE__->setup_middleware('Head');
3928     __PACKAGE__->setup;
3929
3930 When we read middleware definitions from configuration, we reverse the list
3931 which sounds odd but is likely how you expect it to work if you have prior
3932 experience with L<Plack::Builder> or if you previously used the plugin
3933 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3934
3935 So basically your middleware handles an incoming request from the first
3936 registered middleware, down and handles the response from the last middleware
3937 up.
3938
3939 =cut
3940
3941 sub registered_middlewares {
3942     my $class = shift;
3943     if(my $middleware = $class->_psgi_middleware) {
3944         my @mw = ($class->default_middleware, @$middleware);
3945
3946         if($class->config->{using_frontend_proxy}) {
3947           push @mw, Plack::Middleware::ReverseProxy->new;
3948         }
3949
3950         return @mw;
3951     } else {
3952         die "You cannot call ->registered_middlewares until middleware has been setup";
3953     }
3954 }
3955
3956 sub setup_middleware {
3957     my $class = shift;
3958     my @middleware_definitions;
3959
3960     # If someone calls this method you can add middleware with args.  However if its
3961     # called without an arg we need to setup the configuration middleware.
3962     if(@_) {
3963       @middleware_definitions = reverse(@_);
3964     } else {
3965       @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3966         unless $class->finalized_default_middleware;
3967       $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3968     }
3969
3970     my @middleware = ();
3971     while(my $next = shift(@middleware_definitions)) {
3972         if(ref $next) {
3973             if(Scalar::Util::blessed $next && $next->can('wrap')) {
3974                 push @middleware, $next;
3975             } elsif(ref $next eq 'CODE') {
3976                 push @middleware, $next;
3977             } elsif(ref $next eq 'HASH') {
3978                 my $namespace = shift @middleware_definitions;
3979                 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3980                 push @middleware, $mw;
3981             } else {
3982               die "I can't handle middleware definition ${\ref $next}";
3983             }
3984         } else {
3985           my $mw = $class->Catalyst::Utils::build_middleware($next);
3986           push @middleware, $mw;
3987         }
3988     }
3989
3990     my @existing = @{$class->_psgi_middleware || []};
3991     $class->_psgi_middleware([@middleware,@existing,]);
3992 }
3993
3994 =head2 registered_data_handlers
3995
3996 A read only copy of registered Data Handlers returned as a Hash, where each key
3997 is a content type and each value is a subref that attempts to decode that content
3998 type.
3999
4000 =head2 setup_data_handlers (?@data_handler)
4001
4002 Read configuration information stored in configuration key C<data_handlers> or
4003 from passed @args.
4004
4005 See under L</CONFIGURATION> information regarding C<data_handlers>.
4006
4007 This method is automatically called during 'setup' of your application, so
4008 you really don't need to invoke it.
4009
4010 =head2 default_data_handlers
4011
4012 Default Data Handlers that come bundled with L<Catalyst>.  Currently there are
4013 only two default data handlers, for 'application/json' and an alternative to
4014 'application/x-www-form-urlencoded' which supposed nested form parameters via
4015 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4016
4017 The 'application/json' data handler is used to parse incoming JSON into a Perl
4018 data structure.  It used either L<JSON::MaybeXS> or L<JSON>, depending on which
4019 is installed.  This allows you to fail back to L<JSON:PP>, which is a Pure Perl
4020 JSON decoder, and has the smallest dependency impact.
4021
4022 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4023 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
4024 order to get the best performance.  You should add either to your dependency
4025 list (Makefile.PL, dist.ini, cpanfile, etc.)
4026
4027 =cut
4028
4029 sub registered_data_handlers {
4030     my $class = shift;
4031     if(my $data_handlers = $class->_data_handlers) {
4032         return %$data_handlers;
4033     } else {
4034         $class->setup_data_handlers;
4035         return $class->registered_data_handlers;
4036     }
4037 }
4038
4039 sub setup_data_handlers {
4040     my ($class, %data_handler_callbacks) = @_;
4041     %data_handler_callbacks = (
4042       %{$class->default_data_handlers},
4043       %{$class->config->{'data_handlers'}||+{}},
4044       %data_handler_callbacks);
4045
4046     $class->_data_handlers(\%data_handler_callbacks);
4047 }
4048
4049 sub default_data_handlers {
4050     my ($class) = @_;
4051     return +{
4052       'application/x-www-form-urlencoded' => sub {
4053           my ($fh, $req) = @_;
4054           my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4055           Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4056             ->can('build_cgi_struct')->($params);
4057       },
4058       'application/json' => sub {
4059           my ($fh, $req) = @_;
4060           my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
4061           my $slurped;
4062           return eval {
4063             local $/;
4064             $slurped = $fh->getline;
4065             $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
4066           } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4067         },
4068     };
4069 }
4070
4071 sub _handle_http_exception {
4072     my ( $self, $error ) = @_;
4073     if (
4074            !$self->config->{always_catch_http_exceptions}
4075         && blessed $error
4076         && (
4077             $error->can('as_psgi')
4078             || (   $error->can('code')
4079                 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4080         )
4081       )
4082     {
4083         return 1;
4084     }
4085 }
4086
4087 =head2 $c->stack
4088
4089 Returns an arrayref of the internal execution stack (actions that are
4090 currently executing).
4091
4092 =head2 $c->stats
4093
4094 Returns the current timing statistics object. By default Catalyst uses
4095 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4096 L<< stats_class|/"$c->stats_class" >>.
4097
4098 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4099 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4100 profile explicitly, although MyApp.pm still won't profile nor output anything
4101 by itself.
4102
4103 =head2 $c->stats_class
4104
4105 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4106
4107 =head2 $app->stats_class_traits
4108
4109 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4110
4111 =head2 $app->composed_stats_class
4112
4113 this is the stats_class composed with any 'stats_class_traits'.  You can
4114 name the full namespace of the role, or a namespace suffix, which will then
4115 be tried against the following standard namespace prefixes.
4116
4117     $MyApp::TraitFor::Stats::$trait_suffix
4118     Catalyst::TraitFor::Stats::$trait_suffix
4119
4120 So for example if you set:
4121
4122     MyApp->stats_class_traits(['Foo']);
4123
4124 We try each possible role in turn (and throw an error if none load)
4125
4126     Foo
4127     MyApp::TraitFor::Stats::Foo
4128     Catalyst::TraitFor::Stats::Foo
4129
4130 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4131 compatibility with L<CatalystX::RoleApplicator> which previously provided
4132 these features in a stand alone package.
4133
4134 =head2 $c->use_stats
4135
4136 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4137
4138 Note that this is a static method, not an accessor and should be overridden
4139 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4140
4141 =cut
4142
4143 sub use_stats { 0 }
4144
4145
4146 =head2 $c->write( $data )
4147
4148 Writes $data to the output stream. When using this method directly, you
4149 will need to manually set the C<Content-Length> header to the length of
4150 your output data, if known.
4151
4152 =cut
4153
4154 sub write {
4155     my $c = shift;
4156
4157     # Finalize headers if someone manually writes output (for compat)
4158     $c->finalize_headers;
4159
4160     return $c->response->write( @_ );
4161 }
4162
4163 =head2 version
4164
4165 Returns the Catalyst version number. Mostly useful for "powered by"
4166 messages in template systems.
4167
4168 =cut
4169
4170 sub version { return $Catalyst::VERSION }
4171
4172 =head1 CONFIGURATION
4173
4174 There are a number of 'base' config variables which can be set:
4175
4176 =over
4177
4178 =item *
4179
4180 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4181 rethrows errors conforming to the interface described by
4182 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4183 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4184
4185 =item *
4186
4187 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4188
4189 =item *
4190
4191 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4192
4193 =item *
4194
4195 C<disable_component_resolution_regex_fallback> - Turns
4196 off the deprecated component resolution functionality so
4197 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4198 are called then regex search will not be attempted on string values and
4199 instead C<undef> will be returned.
4200
4201 =item *
4202
4203 C<home> - The application home directory. In an uninstalled application,
4204 this is the top level application directory. In an installed application,
4205 this will be the directory containing C<< MyApp.pm >>.
4206
4207 =item *
4208
4209 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4210
4211 =item *
4212
4213 C<name> - The name of the application in debug messages and the debug and
4214 welcome screens
4215
4216 =item *
4217
4218 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4219 until it is accessed. This allows you to (for example) check authentication (and reject
4220 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4221
4222 =item *
4223
4224 C<root> - The root directory for templates. Usually this is just a
4225 subdirectory of the home directory, but you can set it to change the
4226 templates to a different directory.
4227
4228 =item *
4229
4230 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4231 namespaces from which components will be loaded (and constructed and stored in
4232 C<< $c->components >>).
4233
4234 =item *
4235
4236 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4237 to be shown in hit debug tables in the test server.
4238
4239 =item *
4240
4241 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4242 variable should be used for determining the request path.
4243
4244 Most web server environments pass the requested path to the application using environment variables,
4245 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4246 exposed as C<< $c->request->base >>) and the request path below that base.
4247
4248 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4249 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4250
4251 =over
4252
4253 =item use_request_uri_for_path => 0
4254
4255 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4256 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4257 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4258 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4259
4260 However this method has the major disadvantage that it is impossible to correctly decode some elements
4261 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4262 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4263 can't distinguish / vs %2F in paths (in addition to other encoded values).
4264
4265 =item use_request_uri_for_path => 1
4266
4267 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4268 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4269 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4270
4271 Given that this method of path resolution is provably more correct, it is recommended that you use
4272 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4273 aware of the implications of not being able to handle encoded URI paths correctly.
4274
4275 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4276 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4277 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4278 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4279 C<< $c->request->base >> will be incorrect.
4280
4281 =back
4282
4283 =item *
4284
4285 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4286
4287 =item *
4288
4289 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4290 installed, otherwise log an error).  This is useful if your application is not running on the
4291 'root' (or /) of your host server.  B<NOTE> if you use this feature you should add the required
4292 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4293 This has been done since not all people need this feature and we wish to restrict the growth of
4294 L<Catalyst> dependencies.
4295
4296 =item *
4297
4298 C<encoding> - See L</ENCODING>
4299
4300 This now defaults to 'UTF-8'.  You my turn it off by setting this configuration
4301 value to undef.
4302
4303 =item *
4304
4305 C<abort_chain_on_error_fix>
4306
4307 Defaults to true.
4308
4309 When there is an error in an action chain, the default behavior is to
4310 abort the processing of the remaining actions to avoid running them
4311 when the application is in an unexpected state.
4312
4313 Before version 5.90070, the default used to be false. To keep the old
4314 behaviour, you can explicitely set the value to false. E.g.
4315
4316     __PACKAGE__->config(abort_chain_on_error_fix => 0);
4317
4318 If this setting is set to false, then the remaining actions are
4319 performed and the error is caught at the end of the chain.
4320
4321
4322 =item *
4323
4324 C<use_hash_multivalue_in_request>
4325
4326 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4327 and C<parameters> return a hashref where values might be scalar or an arrayref
4328 depending on the incoming data.  In many cases this can be undesirable as it
4329 leads one to writing defensive code like the following:
4330
4331     my ($val) = ref($c->req->parameters->{a}) ?
4332       @{$c->req->parameters->{a}} :
4333         $c->req->parameters->{a};
4334
4335 Setting this configuration item to true will make L<Catalyst> populate the
4336 attributes underlying these methods with an instance of L<Hash::MultiValue>
4337 which is used by L<Plack::Request> and others to solve this very issue.  You
4338 may prefer this behavior to the default, if so enable this option (be warned
4339 if you enable it in a legacy application we are not sure if it is completely
4340 backwardly compatible).
4341
4342 =item *
4343
4344 C<skip_complex_post_part_handling>
4345
4346 When creating body parameters from a POST, if we run into a multipart POST
4347 that does not contain uploads, but instead contains inlined complex data
4348 (very uncommon) we cannot reliably convert that into field => value pairs.  So
4349 instead we create an instance of L<Catalyst::Request::PartData>.  If this causes
4350 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4351 to true (default is false).
4352
4353 =item *
4354
4355 C<skip_body_param_unicode_decoding>
4356
4357 Generally we decode incoming POST params based on your declared encoding (the
4358 default for this is to decode UTF-8).  If this is causing you trouble and you
4359 do not wish to turn all encoding support off (with the C<encoding> configuration
4360 parameter) you may disable this step atomically by setting this configuration
4361 parameter to true.
4362
4363 =item *
4364
4365 C<do_not_decode_query>
4366
4367 If true, then do not try to character decode any wide characters in your
4368 request URL query or keywords.  Most readings of the relevant specifications
4369 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4370 will use, however if you are creating a lot of URLs manually or have external
4371 evil clients, this might cause you trouble.  If you find the changes introduced
4372 in Catalyst version 5.90080+ break some of your query code, you may disable
4373 the UTF-8 decoding globally using this configuration.
4374
4375 This setting takes precedence over C<default_query_encoding>
4376
4377 =item *
4378
4379 C<do_not_check_query_encoding>
4380
4381 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4382 request but would not raise an exception when the decoding failed due to
4383 incorrect unicode.  It now does, but if this change is giving you trouble
4384 you may disable it by setting this configuration to true.
4385
4386 =item *
4387
4388 C<default_query_encoding>
4389
4390 By default we decode query and keywords in your request URL using UTF-8, which
4391 is our reading of the relevant specifications.  This setting allows one to
4392 specify a fixed value for how to decode your query.  You might need this if
4393 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4394
4395 =item *
4396
4397 C<use_chained_args_0_special_case>
4398
4399 In older versions of Catalyst, when more than one action matched the same path
4400 AND all those matching actions declared Args(0), we'd break the tie by choosing
4401 the first action defined.  We now normalized how Args(0) works so that it
4402 follows the same rule as Args(N), which is to say when we need to break a tie
4403 we choose the LAST action defined.  If this breaks your code and you don't
4404 have time to update to follow the new normalized approach, you may set this
4405 value to true and it will globally revert to the original chaining behavior.
4406
4407 =item *
4408
4409 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4410
4411 =item *
4412
4413 C<data_handlers> - See L<DATA HANDLERS>.
4414
4415 =item *
4416
4417 C<stats_class_traits>
4418
4419 An arrayref of L<Moose::Role>s that get composed into your stats class.
4420
4421 =item *
4422
4423 C<request_class_traits>
4424
4425 An arrayref of L<Moose::Role>s that get composed into your request class.
4426
4427 =item *
4428
4429 C<response_class_traits>
4430
4431 An arrayref of L<Moose::Role>s that get composed into your response class.
4432
4433 =item *
4434
4435 C<inject_components>
4436
4437 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4438 For example:
4439
4440     MyApp->config({
4441       inject_components => {
4442         'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4443         'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4444         'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4445       },
4446       'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4447       'Model::Zoo' => { a => 2 },
4448       'Model::Foo' => { a => 100 },
4449     });
4450
4451 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4452 However for cases when you which to use an existing component and you don't need any
4453 customization (where for when you can apply a role to customize it) you may inject those
4454 components into your application.  Please note any configuration should be done 'in the
4455 normal way', with a key under configuration named after the component affix, as in the
4456 above example.
4457
4458 Using this type of injection allows you to construct significant amounts of your application
4459 with only configuration!.  This may or may not lead to increased code understanding.
4460
4461 Please not you may also call the ->inject_components application method as well, although
4462 you must do so BEFORE setup.
4463
4464 =back
4465
4466 =head1 EXCEPTIONS
4467
4468 Generally when you throw an exception inside an Action (or somewhere in
4469 your stack, such as in a model that an Action is calling) that exception
4470 is caught by Catalyst and unless you either catch it yourself (via eval
4471 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4472 will eventually reach L</finalize_errors> and return either the debugging
4473 error stack page, or the default error page.  However, if your exception
4474 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4475 instead rethrow it so that it can be handled by that middleware (which
4476 is part of the default middleware).  For example this would allow
4477
4478     use HTTP::Throwable::Factory 'http_throw';
4479
4480     sub throws_exception :Local {
4481       my ($self, $c) = @_;
4482
4483       http_throw(SeeOther => { location =>
4484         $c->uri_for($self->action_for('redirect')) });
4485
4486     }
4487
4488 =head1 INTERNAL ACTIONS
4489
4490 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4491 C<_ACTION>, and C<_END>. These are by default not shown in the private
4492 action table, but you can make them visible with a config parameter.
4493
4494     MyApp->config(show_internal_actions => 1);
4495
4496 =head1 ON-DEMAND PARSER
4497
4498 The request body is usually parsed at the beginning of a request,
4499 but if you want to handle input yourself, you can enable on-demand
4500 parsing with a config parameter.
4501
4502     MyApp->config(parse_on_demand => 1);
4503
4504 =head1 PROXY SUPPORT
4505
4506 Many production servers operate using the common double-server approach,
4507 with a lightweight frontend web server passing requests to a larger
4508 backend server. An application running on the backend server must deal
4509 with two problems: the remote user always appears to be C<127.0.0.1> and
4510 the server's hostname will appear to be C<localhost> regardless of the
4511 virtual host that the user connected through.
4512
4513 Catalyst will automatically detect this situation when you are running
4514 the frontend and backend servers on the same machine. The following
4515 changes are made to the request.
4516
4517     $c->req->address is set to the user's real IP address, as read from
4518     the HTTP X-Forwarded-For header.
4519
4520     The host value for $c->req->base and $c->req->uri is set to the real
4521     host, as read from the HTTP X-Forwarded-Host header.
4522
4523 Additionally, you may be running your backend application on an insecure
4524 connection (port 80) while your frontend proxy is running under SSL.  If there
4525 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4526 tell Catalyst what port the frontend listens on.  This will allow all URIs to
4527 be created properly.
4528
4529 In the case of passing in:
4530
4531     X-Forwarded-Port: 443
4532
4533 All calls to C<uri_for> will result in an https link, as is expected.
4534
4535 Obviously, your web server must support these headers for this to work.
4536
4537 In a more complex server farm environment where you may have your
4538 frontend proxy server(s) on different machines, you will need to set a
4539 configuration option to tell Catalyst to read the proxied data from the
4540 headers.
4541
4542     MyApp->config(using_frontend_proxy => 1);
4543
4544 If you do not wish to use the proxy support at all, you may set:
4545
4546     MyApp->config(ignore_frontend_proxy => 0);
4547
4548 =head2 Note about psgi files
4549
4550 Note that if you supply your own .psgi file, calling
4551 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4552
4553 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4554 in your psgi, for example:
4555
4556     builder {
4557         enable "Plack::Middleware::ReverseProxy";
4558         MyApp->psgi_app
4559     };
4560
4561 This will unconditionally add the ReverseProxy support, or you need to call
4562 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4563 apply the support depending upon your config).
4564
4565 See L<Catalyst::PSGI> for more information.
4566
4567 =head1 THREAD SAFETY
4568
4569 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4570 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4571 believe the Catalyst core to be thread-safe.
4572
4573 If you plan to operate in a threaded environment, remember that all other
4574 modules you are using must also be thread-safe. Some modules, most notably
4575 L<DBD::SQLite>, are not thread-safe.
4576
4577 =head1 DATA HANDLERS
4578
4579 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4580 form parameters and URL search query fields.  However it has become common
4581 for various alternative content types to be PUT or POSTed to your controllers
4582 and actions.  People working on RESTful APIs, or using AJAX often use JSON,
4583 XML and other content types when communicating with an application server.  In
4584 order to better support this use case, L<Catalyst> defines a global configuration
4585 option, C<data_handlers>, which lets you associate a content type with a coderef
4586 that parses that content type into something Perl can readily access.
4587
4588     package MyApp::Web;
4589
4590     use Catalyst;
4591     use JSON::Maybe;
4592
4593     __PACKAGE__->config(
4594       data_handlers => {
4595         'application/json' => sub { local $/; decode_json $_->getline },
4596       },
4597       ## Any other configuration.
4598     );
4599
4600     __PACKAGE__->setup;
4601
4602 By default L<Catalyst> comes with a generic JSON data handler similar to the
4603 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4604 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4605 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4606 or dist.ini, cpanfile, etc.)
4607
4608 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4609 (matched against the incoming request type using a regexp such as to be case
4610 insensitive) and whose values are coderefs that receive a localized version of
4611 C<$_> which is a filehandle object pointing to received body.
4612
4613 This feature is considered an early access release and we reserve the right
4614 to alter the interface in order to provide a performant and secure solution to
4615 alternative request body content.  Your reports welcomed!
4616
4617 =head1 PSGI MIDDLEWARE
4618
4619 You can define middleware, defined as L<Plack::Middleware> or a compatible
4620 interface in configuration.  Your middleware definitions are in the form of an
4621 arrayref under the configuration key C<psgi_middleware>.  Here's an example
4622 with details to follow:
4623
4624     package MyApp::Web;
4625
4626     use Catalyst;
4627     use Plack::Middleware::StackTrace;
4628
4629     my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4630
4631     __PACKAGE__->config(
4632       'psgi_middleware', [
4633         'Debug',
4634         '+MyApp::Custom',
4635         $stacktrace_middleware,
4636         'Session' => {store => 'File'},
4637         sub {
4638           my $app = shift;
4639           return sub {
4640             my $env = shift;
4641             $env->{myapp.customkey} = 'helloworld';
4642             $app->($env);
4643           },
4644         },
4645       ],
4646     );
4647
4648     __PACKAGE__->setup;
4649
4650 So the general form is:
4651
4652     __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4653
4654 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4655 the order listed (to make it function similarly to L<Plack::Builder>:
4656
4657 Alternatively, you may also define middleware by calling the L</setup_middleware>
4658 package method:
4659
4660     package MyApp::Web;
4661
4662     use Catalyst;
4663
4664     __PACKAGE__->setup_middleware( \@middleware_definitions);
4665     __PACKAGE__->setup;
4666
4667 In the case where you do both (use 'setup_middleware' and configuration) the
4668 package call to setup_middleware will be applied earlier (in other words its
4669 middleware will wrap closer to the application).  Keep this in mind since in
4670 some cases the order of middleware is important.
4671
4672 The two approaches are not exclusive.
4673
4674 =over 4
4675
4676 =item Middleware Object
4677
4678 An already initialized object that conforms to the L<Plack::Middleware>
4679 specification:
4680
4681     my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4682
4683     __PACKAGE__->config(
4684       'psgi_middleware', [
4685         $stacktrace_middleware,
4686       ]);
4687
4688
4689 =item coderef
4690
4691 A coderef that is an inlined middleware:
4692
4693     __PACKAGE__->config(
4694       'psgi_middleware', [
4695         sub {
4696           my $app = shift;
4697           return sub {
4698             my $env = shift;
4699             if($env->{PATH_INFO} =~m/forced/) {
4700               Plack::App::File
4701                 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4702                 ->call($env);
4703             } else {
4704               return $app->($env);
4705             }
4706          },
4707       },
4708     ]);
4709
4710
4711
4712 =item a scalar
4713
4714 We assume the scalar refers to a namespace after normalizing it using the
4715 following rules:
4716
4717 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4718 is assumed to be 'as is', and we just install and use the middleware.
4719
4720 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4721 (the package name of your Catalyst application subclass), we also assume then
4722 that it is a full namespace, and use it.
4723
4724 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4725 resolve it first by looking for it under your application namespace (for example
4726 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4727 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4728 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4729 previous we'd try "Plack::Middleware::MyMiddleware").  We look under your application
4730 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4731 you find that a good idea.
4732
4733 Examples:
4734
4735     package MyApp::Web;
4736
4737     __PACKAGE__->config(
4738       'psgi_middleware', [
4739         'Debug',  ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4740         'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4741         '+MyApp::Custom',  ## MyApp::Custom->wrap
4742       ],
4743     );
4744
4745 =item a scalar followed by a hashref
4746
4747 Just like the previous, except the following C<HashRef> is used as arguments
4748 to initialize the middleware object.
4749
4750     __PACKAGE__->config(
4751       'psgi_middleware', [
4752          'Session' => {store => 'File'},
4753     ]);
4754
4755 =back
4756
4757 Please see L<PSGI> for more on middleware.
4758
4759 =head1 ENCODING
4760
4761 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4762 and set to encode all body responses to UTF8 when possible and applicable.
4763 Following is documentation on this process.  If you are using an older
4764 version of L<Catalyst> you should review documentation for that version since
4765 a lot has changed.
4766
4767 By default encoding is now 'UTF-8'.  You may turn it off by setting
4768 the encoding configuration to undef.
4769
4770     MyApp->config(encoding => undef);
4771
4772 This is recommended for temporary backwards compatibility only.
4773
4774 To turn it off for a single request use the L<clear_encoding>
4775 method to turn off encoding for this request.  This can be useful
4776 when you are setting the body to be an arbitrary block of bytes,
4777 especially if that block happens to be a block of UTF8 text.
4778
4779 Encoding is automatically applied when the content-type is set to
4780 a type that can be encoded.  Currently we encode when the content type
4781 matches the following regular expression:
4782
4783     $content_type =~ /^text|xml$|javascript$/
4784
4785 Encoding is set on the application, but it is copied to the context object
4786 so that you can override it on a request basis.
4787
4788 Be default we don't automatically encode 'application/json' since the most
4789 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4790 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4791 encoding issues.
4792
4793 If you are producing JSON response in an unconventional manner (such
4794 as via a template or manual strings) you should perform the UTF8 encoding
4795 manually as well such as to conform to the JSON specification.
4796
4797 NOTE: We also examine the value of $c->response->content_encoding.  If
4798 you set this (like for example 'gzip', and manually gzipping the body)
4799 we assume that you have done all the necessary encoding yourself, since
4800 we cannot encode the gzipped contents.  If you use a plugin like
4801 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4802 to have this function correctly  with the new UTF8 encoding code, or you
4803 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4804 a front end proxy.
4805
4806 =head2 Methods
4807
4808 =over 4
4809
4810 =item encoding
4811
4812 Returns an instance of an C<Encode> encoding
4813
4814     print $c->encoding->name
4815
4816 =item handle_unicode_encoding_exception ($exception_context)
4817
4818 Method called when decoding process for a request fails.
4819
4820 An C<$exception_context> hashref is provided to allow you to override the
4821 behaviour of your application when given data with incorrect encodings.
4822
4823 The default method throws exceptions in the case of invalid request parameters
4824 (resulting in a 500 error), but ignores errors in upload filenames.
4825
4826 The keys passed in the C<$exception_context> hash are:
4827
4828 =over
4829
4830 =item param_value
4831
4832 The value which was not able to be decoded.
4833
4834 =item error_msg
4835
4836 The exception received from L<Encode>.
4837
4838 =item encoding_step
4839
4840 What type of data was being decoded. Valid values are (currently)
4841 C<params> - for request parameters / arguments / captures
4842 and C<uploads> - for request upload filenames.
4843
4844 =back
4845
4846 =back
4847
4848 =head1 SUPPORT
4849
4850 IRC:
4851
4852     Join #catalyst on irc.perl.org.
4853
4854 Mailing Lists:
4855
4856     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4857     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4858
4859 Web:
4860
4861     http://catalyst.perl.org
4862
4863 Wiki:
4864
4865     http://dev.catalyst.perl.org
4866
4867 =head1 SEE ALSO
4868
4869 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4870
4871 =head2 L<Catalyst::Manual> - The Catalyst Manual
4872
4873 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4874
4875 =head2 L<Catalyst::Engine> - Core engine
4876
4877 =head2 L<Catalyst::Log> - Log class.
4878
4879 =head2 L<Catalyst::Request> - Request object
4880
4881 =head2 L<Catalyst::Response> - Response object
4882
4883 =head2 L<Catalyst::Test> - The test suite.
4884
4885 =head1 PROJECT FOUNDER
4886
4887 sri: Sebastian Riedel <sri@cpan.org>
4888
4889 =head1 CONTRIBUTORS
4890
4891 abw: Andy Wardley
4892
4893 acme: Leon Brocard <leon@astray.com>
4894
4895 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4896
4897 andrewalker: André Walker <andre@cpan.org>
4898
4899 Andrew Bramble
4900
4901 Andrew Ford <A.Ford@ford-mason.co.uk>
4902
4903 Andrew Ruthven
4904
4905 andyg: Andy Grundman <andy@hybridized.org>
4906
4907 audreyt: Audrey Tang
4908
4909 bricas: Brian Cassidy <bricas@cpan.org>
4910
4911 Caelum: Rafael Kitover <rkitover@io.com>
4912
4913 chansen: Christian Hansen
4914
4915 Chase Venters C<chase.venters@gmail.com>
4916
4917 chicks: Christopher Hicks
4918
4919 Chisel Wright C<pause@herlpacker.co.uk>
4920
4921 Danijel Milicevic C<me@danijel.de>
4922
4923 davewood: David Schmidt <davewood@cpan.org>
4924
4925 David Kamholz <dkamholz@cpan.org>
4926
4927 David Naughton, C<naughton@umn.edu>
4928
4929 David E. Wheeler
4930
4931 dhoss: Devin Austin <dhoss@cpan.org>
4932
4933 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4934
4935 Drew Taylor
4936
4937 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4938
4939 esskar: Sascha Kiefer
4940
4941 fireartist: Carl Franks <cfranks@cpan.org>
4942
4943 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4944
4945 gabb: Danijel Milicevic
4946
4947 Gary Ashton Jones
4948
4949 Gavin Henry C<ghenry@perl.me.uk>
4950
4951 Geoff Richards
4952
4953 groditi: Guillermo Roditi <groditi@gmail.com>
4954
4955 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4956
4957 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4958
4959 jcamacho: Juan Camacho
4960
4961 jester: Jesse Sheidlower C<jester@panix.com>
4962
4963 jhannah: Jay Hannah <jay@jays.net>
4964
4965 Jody Belka
4966
4967 Johan Lindstrom
4968
4969 jon: Jon Schutz <jjschutz@cpan.org>
4970
4971 Jonathan Rockway C<< <jrockway@cpan.org> >>
4972
4973 Kieren Diment C<kd@totaldatasolution.com>
4974
4975 konobi: Scott McWhirter <konobi@cpan.org>
4976
4977 marcus: Marcus Ramberg <mramberg@cpan.org>
4978
4979 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4980
4981 mgrimes: Mark Grimes <mgrimes@cpan.org>
4982
4983 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4984
4985 mugwump: Sam Vilain
4986
4987 naughton: David Naughton
4988
4989 ningu: David Kamholz <dkamholz@cpan.org>
4990
4991 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4992
4993 numa: Dan Sully <daniel@cpan.org>
4994
4995 obra: Jesse Vincent
4996
4997 Octavian Rasnita
4998
4999 omega: Andreas Marienborg
5000
5001 Oleg Kostyuk <cub.uanic@gmail.com>
5002
5003 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
5004
5005 rafl: Florian Ragwitz <rafl@debian.org>
5006
5007 random: Roland Lammel <lammel@cpan.org>
5008
5009 Robert Sedlacek C<< <rs@474.at> >>
5010
5011 SpiceMan: Marcel Montes
5012
5013 sky: Arthur Bergman
5014
5015 szbalint: Balint Szilakszi <szbalint@cpan.org>
5016
5017 t0m: Tomas Doran <bobtfish@bobtfish.net>
5018
5019 Ulf Edvinsson
5020
5021 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5022
5023 Viljo Marrandi C<vilts@yahoo.com>
5024
5025 Will Hawes C<info@whawes.co.uk>
5026
5027 willert: Sebastian Willert <willert@cpan.org>
5028
5029 wreis: Wallace Reis <wreis@cpan.org>
5030
5031 Yuval Kogman, C<nothingmuch@woobling.org>
5032
5033 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
5034
5035 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5036
5037 Upasana <me@upasana.me>
5038
5039 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5040
5041 =head1 COPYRIGHT
5042
5043 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5044
5045 =head1 LICENSE
5046
5047 This library is free software. You can redistribute it and/or modify it under
5048 the same terms as Perl itself.
5049
5050 =cut
5051
5052 no Moose;
5053
5054 __PACKAGE__->meta->make_immutable;
5055
5056 1;