lib/Catalyst.pm

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