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