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 bytes;
   8 use B::Hooks::EndOfScope ();
   9 use Catalyst::Context;
  10 use Catalyst::Exception;
  11 use Catalyst::Exception::Detach;
  12 use Catalyst::Exception::Go;
  13 use Catalyst::Log;
  14 use Catalyst::Request;
  15 use Catalyst::Request::Upload;
  16 use Catalyst::Response;
  17 use Catalyst::Utils;
  18 use Catalyst::Controller;
  19 use Devel::InnerPackage ();
  20 use File::stat;
  21 use Module::Pluggable::Object ();
  22 use Text::SimpleTable ();
  23 use Path::Class::Dir ();
  24 use Path::Class::File ();
  25 use URI ();
  26 use URI::http;
  27 use URI::https;
  28 use Tree::Simple qw/use_weak_refs/;
  29 use Tree::Simple::Visitor::FindByUID;
  30 use Class::C3::Adopt::NEXT;
  31 use List::MoreUtils qw/uniq/;
  32 use attributes;
  33 use utf8;
  34 use Carp qw/croak carp shortmess/;
  35
  36 BEGIN { require 5.008004; }
  37
  38 has 'context' => (
  39     isa       => 'Catalyst::Context',
  40     is        => 'rw',
  41     handles   => [
  42         qw/ action counter namespace request response stack stash state stats /,
  43     ],
  44 );
  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.80013';
  82
  83 {
  84     my $dev_version = $VERSION =~ /_\d{2}$/;
  85     *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
  86 }
  87
  88 $VERSION = eval $VERSION;
  89
  90 sub import {
  91     my ( $class, @arguments ) = @_;
  92
  93     # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
  94     # callers @ISA.
  95     return unless $class eq 'Catalyst';
  96
  97     my $caller = caller();
  98     return if $caller eq 'main';
  99
 100     # Kill Adopt::NEXT warnings if we're a non-RC version
 101     unless (_IS_DEVELOPMENT_VERSION()) {
 102         Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
 103     }
 104
 105     my $meta = Moose::Meta::Class->initialize($caller);
 106     unless ( $caller->isa('Catalyst') ) {
 107         my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
 108         $meta->superclasses(@superclasses);
 109     }
 110     # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
 111     $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
 112
 113     unless( $meta->has_method('meta') ){
 114         $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
 115     }
 116
 117     $caller->arguments( [@arguments] );
 118     $caller->setup_home;
 119 }
 120
 121 sub _application { $_[0] }
 122
 123 =head1 NAME
 124
 125 Catalyst - The Elegant MVC Web Application Framework
 126
 127 =head1 SYNOPSIS
 128
 129 See the L<Catalyst::Manual> distribution for comprehensive
 130 documentation and tutorials.
 131
 132     # Install Catalyst::Devel for helpers and other development tools
 133     # use the helper to create a new application
 134     catalyst.pl MyApp
 135
 136     # add models, views, controllers
 137     script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
 138     script/myapp_create.pl view MyTemplate TT
 139     script/myapp_create.pl controller Search
 140
 141     # built in testserver -- use -r to restart automatically on changes
 142     # --help to see all available options
 143     script/myapp_server.pl
 144
 145     # command line testing interface
 146     script/myapp_test.pl /yada
 147
 148     ### in lib/MyApp.pm
 149     use Catalyst qw/-Debug/; # include plugins here as well
 150
 151     ### In lib/MyApp/Controller/Root.pm (autocreated)
 152     sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
 153         my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
 154         $c->stash->{template} = 'foo.tt'; # set the template
 155         # lookup something from db -- stash vars are passed to TT
 156         $c->stash->{data} =
 157           $c->model('Database::Foo')->search( { country => $args[0] } );
 158         if ( $c->req->params->{bar} ) { # access GET or POST parameters
 159             $c->forward( 'bar' ); # process another action
 160             # do something else after forward returns
 161         }
 162     }
 163
 164     # The foo.tt TT template can use the stash data from the database
 165     [% WHILE (item = data.next) %]
 166         [% item.foo %]
 167     [% END %]
 168
 169     # called for /bar/of/soap, /bar/of/soap/10, etc.
 170     sub bar : Path('/bar/of/soap') { ... }
 171
 172     # called for all actions, from the top-most controller downwards
 173     sub auto : Private {
 174         my ( $self, $c ) = @_;
 175         if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
 176             $c->res->redirect( '/login' ); # require login
 177             return 0; # abort request and go immediately to end()
 178         }
 179         return 1; # success; carry on to next action
 180     }
 181
 182     # called after all actions are finished
 183     sub end : Private {
 184         my ( $self, $c ) = @_;
 185         if ( scalar @{ $c->error } ) { ... } # handle errors
 186         return if $c->res->body; # already have a response
 187         $c->forward( 'MyApp::View::TT' ); # render template
 188     }
 189
 190     ### in MyApp/Controller/Foo.pm
 191     # called for /foo/bar
 192     sub bar : Local { ... }
 193
 194     # called for /blargle
 195     sub blargle : Global { ... }
 196
 197     # an index action matches /foo, but not /foo/1, etc.
 198     sub index : Private { ... }
 199
 200     ### in MyApp/Controller/Foo/Bar.pm
 201     # called for /foo/bar/baz
 202     sub baz : Local { ... }
 203
 204     # first Root auto is called, then Foo auto, then this
 205     sub auto : Private { ... }
 206
 207     # powerful regular expression paths are also possible
 208     sub details : Regex('^product/(\w+)/details$') {
 209         my ( $self, $c ) = @_;
 210         # extract the (\w+) from the URI
 211         my $product = $c->req->captures->[0];
 212     }
 213
 214 See L<Catalyst::Manual::Intro> for additional information.
 215
 216 =head1 DESCRIPTION
 217
 218 Catalyst is a modern framework for making web applications without the
 219 pain usually associated with this process. This document is a reference
 220 to the main Catalyst application. If you are a new user, we suggest you
 221 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
 222
 223 See L<Catalyst::Manual> for more documentation.
 224
 225 Catalyst plugins can be loaded by naming them as arguments to the "use
 226 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
 227 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
 228 C<My::Module>.
 229
 230     use Catalyst qw/My::Module/;
 231
 232 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
 233 fully qualify the name by using a unary plus:
 234
 235     use Catalyst qw/
 236         My::Module
 237         +Fully::Qualified::Plugin::Name
 238     /;
 239
 240 Special flags like C<-Debug> and C<-Engine> can also be specified as
 241 arguments when Catalyst is loaded:
 242
 243     use Catalyst qw/-Debug My::Module/;
 244
 245 The position of plugins and flags in the chain is important, because
 246 they are loaded in the order in which they appear.
 247
 248 The following flags are supported:
 249
 250 =head2 -Debug
 251
 252 Enables debug output. You can also force this setting from the system
 253 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
 254 settings override the application, with <MYAPP>_DEBUG having the highest
 255 priority.
 256
 257 =head2 -Engine
 258
 259 Forces Catalyst to use a specific engine. Omit the
 260 C<Catalyst::Engine::> prefix of the engine name, i.e.:
 261
 262     use Catalyst qw/-Engine=CGI/;
 263
 264 =head2 -Home
 265
 266 Forces Catalyst to use a specific home directory, e.g.:
 267
 268     use Catalyst qw[-Home=/usr/mst];
 269
 270 This can also be done in the shell environment by setting either the
 271 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
 272 is replaced with the uppercased name of your application, any "::" in
 273 the name will be replaced with underscores, e.g. MyApp::Web should use
 274 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
 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/MyApp::Model::DBIC::Foo do_stuff/);
 336     $c->forward('MyApp::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 $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 Calling C<< $c->debug(1) >> has no effect.
 938
 939 =cut
 940
 941 sub debug { 0 }
 942
 943 =head2 $c->dispatcher
 944
 945 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
 946
 947 =head2 $c->engine
 948
 949 Returns the engine instance. See L<Catalyst::Engine>.
 950
 951
 952 =head2 UTILITY METHODS
 953
 954 =head2 $c->path_to(@path)
 955
 956 Merges C<@path> with C<< $c->config->{home} >> and returns a
 957 L<Path::Class::Dir> object. Note you can usually use this object as
 958 a filename, but sometimes you will have to explicitly stringify it
 959 yourself by calling the C<< ->stringify >> method.
 960
 961 For example:
 962
 963     $c->path_to( 'db', 'sqlite.db' );
 964
 965 =cut
 966
 967 sub path_to {
 968     my ( $c, @path ) = @_;
 969     my $path = Path::Class::Dir->new( $c->config->{home}, @path );
 970     if ( -d $path ) { return $path }
 971     else { return Path::Class::File->new( $c->config->{home}, @path ) }
 972 }
 973
 974 =head2 $c->plugin( $name, $class, @args )
 975
 976 Helper method for plugins. It creates a class data accessor/mutator and
 977 loads and instantiates the given class.
 978
 979     MyApp->plugin( 'prototype', 'HTML::Prototype' );
 980
 981     $c->prototype->define_javascript_functions;
 982
 983 B<Note:> This method of adding plugins is deprecated. The ability
 984 to add plugins like this B<will be removed> in a Catalyst 5.81.
 985 Please do not use this functionality in new code.
 986
 987 =cut
 988
 989 sub plugin {
 990     my ( $class, $name, $plugin, @args ) = @_;
 991
 992     # See block comment in t/unit_core_plugin.t
 993     $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
 994
 995     $class->_register_plugin( $plugin, 1 );
 996
 997     eval { $plugin->import };
 998     $class->mk_classdata($name);
 999     my $obj;
1000     eval { $obj = $plugin->new(@args) };
1001
1002     if ($@) {
1003         Catalyst::Exception->throw( message =>
1004               qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1005     }
1006
1007     $class->$name($obj);
1008     $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1009       if $class->debug;
1010 }
1011
1012 =head2 MyApp->setup
1013
1014 Initializes the dispatcher and engine, loads any plugins, and loads the
1015 model, view, and controller components. You may also specify an array
1016 of plugins to load here, if you choose to not load them in the C<use
1017 Catalyst> line.
1018
1019     MyApp->setup;
1020     MyApp->setup( qw/-Debug/ );
1021
1022 =cut
1023
1024 sub setup {
1025     my ( $class, @arguments ) = @_;
1026     croak('Running setup more than once')
1027         if ( $class->setup_finished );
1028
1029     unless ( $class->isa('Catalyst') ) {
1030
1031         Catalyst::Exception->throw(
1032             message => qq/'$class' does not inherit from Catalyst/ );
1033     }
1034
1035     if ( $class->arguments ) {
1036         @arguments = ( @arguments, @{ $class->arguments } );
1037     }
1038
1039     # Process options
1040     my $flags = {};
1041
1042     foreach (@arguments) {
1043
1044         if (/^-Debug$/) {
1045             $flags->{log} =
1046               ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1047         }
1048         elsif (/^-(\w+)=?(.*)$/) {
1049             $flags->{ lc $1 } = $2;
1050         }
1051         else {
1052             push @{ $flags->{plugins} }, $_;
1053         }
1054     }
1055
1056     $class->setup_home( delete $flags->{home} );
1057
1058     $class->setup_log( delete $flags->{log} );
1059     $class->setup_plugins( delete $flags->{plugins} );
1060     $class->setup_dispatcher( delete $flags->{dispatcher} );
1061     $class->setup_engine( delete $flags->{engine} );
1062     $class->setup_stats( delete $flags->{stats} );
1063
1064     for my $flag ( sort keys %{$flags} ) {
1065
1066         if ( my $code = $class->can( 'setup_' . $flag ) ) {
1067             &$code( $class, delete $flags->{$flag} );
1068         }
1069         else {
1070             $class->log->warn(qq/Unknown flag "$flag"/);
1071         }
1072     }
1073
1074     eval { require Catalyst::Devel; };
1075     if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1076         $class->log->warn(<<"EOF");
1077 You are running an old script!
1078
1079   Please update by running (this will overwrite existing files):
1080     catalyst.pl -force -scripts $class
1081
1082   or (this will not overwrite existing files):
1083     catalyst.pl -scripts $class
1084
1085 EOF
1086     }
1087
1088     if ( $class->debug ) {
1089         my @plugins = map { "$_  " . ( $_->VERSION || '' ) } $class->registered_plugins;
1090
1091         if (@plugins) {
1092             my $column_width = Catalyst::Utils::term_width() - 6;
1093             my $t = Text::SimpleTable->new($column_width);
1094             $t->row($_) for @plugins;
1095             $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1096         }
1097
1098         my $dispatcher = $class->dispatcher;
1099         my $engine     = $class->engine;
1100         my $home       = $class->config->{home};
1101
1102         $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1103         $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1104
1105         $home
1106           ? ( -d $home )
1107           ? $class->log->debug(qq/Found home "$home"/)
1108           : $class->log->debug(qq/Home "$home" doesn't exist/)
1109           : $class->log->debug(q/Couldn't find home/);
1110     }
1111
1112     # Call plugins setup, this is stupid and evil.
1113     # Also screws C3 badly on 5.10, hack to avoid.
1114     {
1115         no warnings qw/redefine/;
1116         local *setup = sub { };
1117         $class->setup unless $Catalyst::__AM_RESTARTING;
1118     }
1119
1120     # Initialize our data structure
1121     $class->components( {} );
1122
1123     $class->setup_components;
1124
1125     if ( $class->debug ) {
1126         my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1127         my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1128         for my $comp ( sort keys %{ $class->components } ) {
1129             my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1130             $t->row( $comp, $type );
1131         }
1132         $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1133           if ( keys %{ $class->components } );
1134     }
1135
1136     # Add our self to components, since we are also a component
1137     if( $class->isa('Catalyst::Controller') ){
1138       $class->components->{$class} = $class;
1139     }
1140
1141     $class->setup_actions;
1142
1143     if ( $class->debug ) {
1144         my $name = $class->config->{name} || 'Application';
1145         $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1146     }
1147     $class->log->_flush() if $class->log->can('_flush');
1148
1149     # Make sure that the application class becomes immutable at this point,
1150     B::Hooks::EndOfScope::on_scope_end {
1151         return if $@;
1152         my $meta = Class::MOP::get_metaclass_by_name($class);
1153         if (
1154             $meta->is_immutable
1155             && ! { $meta->immutable_options }->{replace_constructor}
1156             && (
1157                    $class->isa('Class::Accessor::Fast')
1158                 || $class->isa('Class::Accessor')
1159             )
1160         ) {
1161             warn "You made your application class ($class) immutable, "
1162                 . "but did not inline the\nconstructor. "
1163                 . "This will break catalyst, as your app \@ISA "
1164                 . "Class::Accessor(::Fast)?\nPlease pass "
1165                 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1166         }
1167         $meta->make_immutable(
1168             replace_constructor => 1,
1169         ) unless $meta->is_immutable;
1170     };
1171
1172     $class->setup_finalize;
1173 }
1174
1175
1176 =head2 $app->setup_finalize
1177
1178 A hook to attach modifiers to.
1179 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1180 Also better than C< setup_finished(); >, as that is a getter method.
1181
1182     sub setup_finalize {
1183
1184         my $app = shift;
1185
1186         ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1187
1188         $app->next::method(@_);
1189
1190
1191     }
1192
1193 =cut
1194
1195 sub setup_finalize {
1196     my ($class) = @_;
1197     $class->setup_finished(1);
1198 }
1199
1200 =head2 $c->uri_for( $path, @args?, \%query_values? )
1201
1202 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1203
1204 Constructs an absolute L<URI> object based on the application root, the
1205 provided path, and the additional arguments and query parameters provided.
1206 When used as a string, provides a textual URI.
1207
1208 If the first argument is a string, it is taken as a public URI path relative
1209 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1210 relative to the application root (if it does). It is then merged with
1211 C<< $c->request->base >>; any C<@args> are appended as additional path
1212 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1213
1214 If the first argument is a L<Catalyst::Action> it represents an action which
1215 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1216 optional C<\@captures> argument (an arrayref) allows passing the captured
1217 variables that are needed to fill in the paths of Chained and Regex actions;
1218 once the path is resolved, C<uri_for> continues as though a path was
1219 provided, appending any arguments or parameters and creating an absolute
1220 URI.
1221
1222 The captures for the current request can be found in
1223 C<< $c->request->captures >>, and actions can be resolved using
1224 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1225 path, use C<< $c->uri_for_action >> instead.
1226
1227   # Equivalent to $c->req->uri
1228   $c->uri_for($c->action, $c->req->captures,
1229       @{ $c->req->args }, $c->req->params);
1230
1231   # For the Foo action in the Bar controller
1232   $c->uri_for($c->controller('Bar')->action_for('Foo'));
1233
1234   # Path to a static resource
1235   $c->uri_for('/static/images/logo.png');
1236
1237 =cut
1238
1239 sub uri_for {
1240     my ( $c, $path, @args ) = @_;
1241
1242     if (blessed($path) && $path->isa('Catalyst::Controller')) {
1243         $path = $path->path_prefix;
1244         $path =~ s{/+\z}{};
1245         $path .= '/';
1246     }
1247
1248     if ( blessed($path) ) { # action object
1249         my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1250                          ? shift(@args)
1251                          : [] );
1252         my $action = $path;
1253         $path = $c->dispatcher->uri_for_action($action, $captures);
1254         if (not defined $path) {
1255             $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1256                 if $c->debug;
1257             return undef;
1258         }
1259         $path = '/' if $path eq '';
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     s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1269
1270     unshift(@args, $path);
1271
1272     unless (defined $path && $path =~ s!^/!!) { # in-place strip
1273         my $namespace = $c->namespace;
1274         if (defined $path) { # cheesy hack to handle path '../foo'
1275            $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1276         }
1277         unshift(@args, $namespace || '');
1278     }
1279
1280     # join args with '/', or a blank string
1281     my $args = join('/', grep { defined($_) } @args);
1282     $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1283     $args =~ s!^/+!!;
1284     my $base = $c->req->base;
1285     my $class = ref($base);
1286     $base =~ s{(?<!/)$}{/};
1287
1288     my $query = '';
1289
1290     if (my @keys = keys %$params) {
1291       # somewhat lifted from URI::_query's query_form
1292       $query = '?'.join('&', map {
1293           my $val = $params->{$_};
1294           s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1295           s/ /+/g;
1296           my $key = $_;
1297           $val = '' unless defined $val;
1298           (map {
1299               my $param = "$_";
1300               utf8::encode( $param ) if utf8::is_utf8($param);
1301               # using the URI::Escape pattern here so utf8 chars survive
1302               $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1303               $param =~ s/ /+/g;
1304               "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1305       } @keys);
1306     }
1307
1308     my $res = bless(\"${base}${args}${query}", $class);
1309     $res;
1310 }
1311
1312 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1313
1314 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1315
1316 =over
1317
1318 =item $path
1319
1320 A private path to the Catalyst action you want to create a URI for.
1321
1322 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1323 >> and passing the resulting C<$action> and the remaining arguments to C<<
1324 $c->uri_for >>.
1325
1326 You can also pass in a Catalyst::Action object, in which case it is passed to
1327 C<< $c->uri_for >>.
1328
1329 =back
1330
1331 =cut
1332
1333 sub uri_for_action {
1334     my ( $c, $path, @args ) = @_;
1335     my $action = blessed($path)
1336       ? $path
1337       : $c->dispatcher->get_action_by_path($path);
1338     unless (defined $action) {
1339       croak "Can't find action for path '$path'";
1340     }
1341     return $c->uri_for( $action, @args );
1342 }
1343
1344 =head2 $c->welcome_message
1345
1346 Returns the Catalyst welcome HTML page.
1347
1348 =cut
1349
1350 sub welcome_message {
1351     my $c      = shift;
1352     my $name   = $c->config->{name};
1353     my $logo   = $c->uri_for('/static/images/catalyst_logo.png');
1354     my $prefix = Catalyst::Utils::appprefix( ref $c );
1355     $c->response->content_type('text/html; charset=utf-8');
1356     return <<"EOF";
1357 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1358     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1359 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1360     <head>
1361     <meta http-equiv="Content-Language" content="en" />
1362     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1363         <title>$name on Catalyst $VERSION</title>
1364         <style type="text/css">
1365             body {
1366                 color: #000;
1367                 background-color: #eee;
1368             }
1369             div#content {
1370                 width: 640px;
1371                 margin-left: auto;
1372                 margin-right: auto;
1373                 margin-top: 10px;
1374                 margin-bottom: 10px;
1375                 text-align: left;
1376                 background-color: #ccc;
1377                 border: 1px solid #aaa;
1378             }
1379             p, h1, h2 {
1380                 margin-left: 20px;
1381                 margin-right: 20px;
1382                 font-family: verdana, tahoma, sans-serif;
1383             }
1384             a {
1385                 font-family: verdana, tahoma, sans-serif;
1386             }
1387             :link, :visited {
1388                     text-decoration: none;
1389                     color: #b00;
1390                     border-bottom: 1px dotted #bbb;
1391             }
1392             :link:hover, :visited:hover {
1393                     color: #555;
1394             }
1395             div#topbar {
1396                 margin: 0px;
1397             }
1398             pre {
1399                 margin: 10px;
1400                 padding: 8px;
1401             }
1402             div#answers {
1403                 padding: 8px;
1404                 margin: 10px;
1405                 background-color: #fff;
1406                 border: 1px solid #aaa;
1407             }
1408             h1 {
1409                 font-size: 0.9em;
1410                 font-weight: normal;
1411                 text-align: center;
1412             }
1413             h2 {
1414                 font-size: 1.0em;
1415             }
1416             p {
1417                 font-size: 0.9em;
1418             }
1419             p img {
1420                 float: right;
1421                 margin-left: 10px;
1422             }
1423             span#appname {
1424                 font-weight: bold;
1425                 font-size: 1.6em;
1426             }
1427         </style>
1428     </head>
1429     <body>
1430         <div id="content">
1431             <div id="topbar">
1432                 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1433                     $VERSION</h1>
1434              </div>
1435              <div id="answers">
1436                  <p>
1437                  <img src="$logo" alt="Catalyst Logo" />
1438                  </p>
1439                  <p>Welcome to the  world of Catalyst.
1440                     This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1441                     framework will make web development something you had
1442                     never expected it to be: Fun, rewarding, and quick.</p>
1443                  <h2>What to do now?</h2>
1444                  <p>That really depends  on what <b>you</b> want to do.
1445                     We do, however, provide you with a few starting points.</p>
1446                  <p>If you want to jump right into web development with Catalyst
1447                     you might want to start with a tutorial.</p>
1448 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1449 </pre>
1450 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1451 <pre>
1452 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1453 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1454 </code></pre>
1455                  <h2>What to do next?</h2>
1456                  <p>Next it's time to write an actual application. Use the
1457                     helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&amp;mode=all">controllers</a>,
1458                     <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&amp;mode=all">models</a>, and
1459                     <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&amp;mode=all">views</a>;
1460                     they can save you a lot of work.</p>
1461                     <pre><code>script/${prefix}_create.pl -help</code></pre>
1462                     <p>Also, be sure to check out the vast and growing
1463                     collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1464                     you are likely to find what you need there.
1465                     </p>
1466
1467                  <h2>Need help?</h2>
1468                  <p>Catalyst has a very active community. Here are the main places to
1469                     get in touch with us.</p>
1470                  <ul>
1471                      <li>
1472                          <a href="http://dev.catalyst.perl.org">Wiki</a>
1473                      </li>
1474                      <li>
1475                          <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1476                      </li>
1477                      <li>
1478                          <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1479                      </li>
1480                  </ul>
1481                  <h2>In conclusion</h2>
1482                  <p>The Catalyst team hopes you will enjoy using Catalyst as much
1483                     as we enjoyed making it. Please contact us if you have ideas
1484                     for improvement or other feedback.</p>
1485              </div>
1486          </div>
1487     </body>
1488 </html>
1489 EOF
1490 }
1491
1492 =head1 INTERNAL METHODS
1493
1494 These methods are not meant to be used by end users.
1495
1496 =head2 $c->components
1497
1498 Returns a hash of components.
1499
1500 =head2 $c->context_class
1501
1502 Returns or sets the context class.
1503
1504 =head2 $c->counter
1505
1506 Returns a hashref containing coderefs and execution counts (needed for
1507 deep recursion detection).
1508
1509 =head2 $c->depth
1510
1511 Returns the number of actions on the current internal execution stack.
1512
1513 =head2 $c->dispatch
1514
1515 Dispatches a request to actions.
1516
1517 =cut
1518
1519 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1520
1521 =head2 $c->dispatcher_class
1522
1523 Returns or sets the dispatcher class.
1524
1525 =head2 $c->dump_these
1526
1527 Returns a list of 2-element array references (name, structure) pairs
1528 that will be dumped on the error page in debug mode.
1529
1530 =cut
1531
1532 sub dump_these {
1533     my $c = shift;
1534     [ Request => $c->req ],
1535     [ Response => $c->res ],
1536     [ Stash => $c->stash ],
1537     [ Config => $c->config ];
1538 }
1539
1540 =head2 $c->engine_class
1541
1542 Returns or sets the engine class.
1543
1544 =head2 $c->execute( $class, $coderef )
1545
1546 Execute a coderef in given class and catch exceptions. Errors are available
1547 via $c->error.
1548
1549 =cut
1550
1551 sub execute {
1552     my ( $c, $class, $code ) = @_;
1553     $class = $c->component($class) || $class;
1554     $c->state(0);
1555
1556     if ( $c->depth >= $RECURSION ) {
1557         my $action = $code->reverse();
1558         $action = "/$action" unless $action =~ /->/;
1559         my $error = qq/Deep recursion detected calling "${action}"/;
1560         $c->log->error($error);
1561         $c->error($error);
1562         $c->state(0);
1563         return $c->state;
1564     }
1565
1566     my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1567
1568     push( @{ $c->stack }, $code );
1569
1570     no warnings 'recursion';
1571     eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1572
1573     $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1574
1575     my $last = pop( @{ $c->stack } );
1576
1577     if ( my $error = $@ ) {
1578         if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1579             $error->rethrow if $c->depth > 1;
1580         }
1581         elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1582             $error->rethrow if $c->depth > 0;
1583         }
1584         else {
1585             unless ( ref $error ) {
1586                 no warnings 'uninitialized';
1587                 chomp $error;
1588                 my $class = $last->class;
1589                 my $name  = $last->name;
1590                 $error = qq/Caught exception in $class->$name "$error"/;
1591             }
1592             $c->error($error);
1593             $c->state(0);
1594         }
1595     }
1596     return $c->state;
1597 }
1598
1599 sub _stats_start_execute {
1600     my ( $c, $code ) = @_;
1601     my $appclass = ref($c) || $c;
1602     return if ( ( $code->name =~ /^_.*/ )
1603         && ( !$appclass->config->{show_internal_actions} ) );
1604
1605     my $action_name = $code->reverse();
1606     $c->counter->{$action_name}++;
1607
1608     my $action = $action_name;
1609     $action = "/$action" unless $action =~ /->/;
1610
1611     # determine if the call was the result of a forward
1612     # this is done by walking up the call stack and looking for a calling
1613     # sub of Catalyst::forward before the eval
1614     my $callsub = q{};
1615     for my $index ( 2 .. 11 ) {
1616         last
1617         if ( ( caller($index) )[0] eq 'Catalyst'
1618             && ( caller($index) )[3] eq '(eval)' );
1619
1620         if ( ( caller($index) )[3] =~ /forward$/ ) {
1621             $callsub = ( caller($index) )[3];
1622             $action  = "-> $action";
1623             last;
1624         }
1625     }
1626
1627     my $uid = $action_name . $c->counter->{$action_name};
1628
1629     # is this a root-level call or a forwarded call?
1630     if ( $callsub =~ /forward$/ ) {
1631         my $parent = $c->stack->[-1];
1632
1633         # forward, locate the caller
1634         if ( exists $c->counter->{"$parent"} ) {
1635             $c->stats->profile(
1636                 begin  => $action,
1637                 parent => "$parent" . $c->counter->{"$parent"},
1638                 uid    => $uid,
1639             );
1640         }
1641         else {
1642
1643             # forward with no caller may come from a plugin
1644             $c->stats->profile(
1645                 begin => $action,
1646                 uid   => $uid,
1647             );
1648         }
1649     }
1650     else {
1651
1652         # root-level call
1653         $c->stats->profile(
1654             begin => $action,
1655             uid   => $uid,
1656         );
1657     }
1658     return $action;
1659
1660 }
1661
1662 sub _stats_finish_execute {
1663     my ( $c, $info ) = @_;
1664     $c->stats->profile( end => $info );
1665 }
1666
1667 =head2 $c->finalize
1668
1669 Finalizes the request.
1670
1671 =cut
1672
1673 sub finalize {
1674     my $c = shift;
1675
1676     for my $error ( @{ $c->error } ) {
1677         $c->log->error($error);
1678     }
1679
1680     # Allow engine to handle finalize flow (for POE)
1681     my $engine = $c->engine;
1682     if ( my $code = $engine->can('finalize') ) {
1683         $engine->$code($c);
1684     }
1685     else {
1686
1687         $c->finalize_uploads;
1688
1689         # Error
1690         if ( $#{ $c->error } >= 0 ) {
1691             $c->finalize_error;
1692         }
1693
1694         $c->finalize_headers;
1695
1696         # HEAD request
1697         if ( $c->request->method eq 'HEAD' ) {
1698             $c->response->body('');
1699         }
1700
1701         $c->finalize_body;
1702     }
1703
1704     if ($c->use_stats) {
1705         my $elapsed = sprintf '%f', $c->stats->elapsed;
1706         my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1707         $c->log->info(
1708             "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1709     }
1710
1711     return $c->response->status;
1712 }
1713
1714 =head2 $c->finalize_body
1715
1716 Finalizes body.
1717
1718 =cut
1719
1720 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1721
1722 =head2 $c->finalize_cookies
1723
1724 Finalizes cookies.
1725
1726 =cut
1727
1728 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1729
1730 =head2 $c->finalize_error
1731
1732 Finalizes error.
1733
1734 =cut
1735
1736 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1737
1738 =head2 $c->finalize_headers
1739
1740 Finalizes headers.
1741
1742 =cut
1743
1744 sub finalize_headers {
1745     my $c = shift;
1746
1747     my $response = $c->response; #accessor calls can add up?
1748
1749     # Check if we already finalized headers
1750     return if $response->finalized_headers;
1751
1752     # Handle redirects
1753     if ( my $location = $response->redirect ) {
1754         $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1755         $response->header( Location => $location );
1756
1757         if ( !$response->has_body ) {
1758             # Add a default body if none is already present
1759             $response->body(
1760                 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1761             );
1762         }
1763     }
1764
1765     # Content-Length
1766     if ( $response->body && !$response->content_length ) {
1767
1768         # get the length from a filehandle
1769         if ( blessed( $response->body ) && $response->body->can('read') )
1770         {
1771             my $stat = stat $response->body;
1772             if ( $stat && $stat->size > 0 ) {
1773                 $response->content_length( $stat->size );
1774             }
1775             else {
1776                 $c->log->warn('Serving filehandle without a content-length');
1777             }
1778         }
1779         else {
1780             # everything should be bytes at this point, but just in case
1781             $response->content_length( bytes::length( $response->body ) );
1782         }
1783     }
1784
1785     # Errors
1786     if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1787         $response->headers->remove_header("Content-Length");
1788         $response->body('');
1789     }
1790
1791     $c->finalize_cookies;
1792
1793     $c->engine->finalize_headers( $c, @_ );
1794
1795     # Done
1796     $response->finalized_headers(1);
1797 }
1798
1799 =head2 $c->finalize_output
1800
1801 An alias for finalize_body.
1802
1803 =head2 $c->finalize_read
1804
1805 Finalizes the input after reading is complete.
1806
1807 =cut
1808
1809 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1810
1811 =head2 $c->finalize_uploads
1812
1813 Finalizes uploads. Cleans up any temporary files.
1814
1815 =cut
1816
1817 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1818
1819 =head2 $c->get_action( $action, $namespace )
1820
1821 Gets an action in a given namespace.
1822
1823 =cut
1824
1825 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1826
1827 =head2 $c->get_actions( $action, $namespace )
1828
1829 Gets all actions of a given name in a namespace and all parent
1830 namespaces.
1831
1832 =cut
1833
1834 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1835
1836 =head2 $c->handle_request( $class, @arguments )
1837
1838 Called to handle each HTTP request.
1839
1840 =cut
1841
1842 sub handle_request {
1843     my ( $class, @arguments ) = @_;
1844
1845     # Always expect worst case!
1846     my $status = -1;
1847     eval {
1848         if ($class->debug) {
1849             my $secs = time - $START || 1;
1850             my $av = sprintf '%.3f', $COUNT / $secs;
1851             my $time = localtime time;
1852             $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1853         }
1854
1855         my $c = $class->prepare(@arguments);
1856         $c->dispatch;
1857         $status = $c->finalize;
1858     };
1859
1860     if ( my $error = $@ ) {
1861         chomp $error;
1862         $class->log->error(qq/Caught exception in engine "$error"/);
1863     }
1864
1865     $COUNT++;
1866
1867     if(my $coderef = $class->log->can('_flush')){
1868         $class->log->$coderef();
1869     }
1870     return $status;
1871 }
1872
1873 =head2 $c->prepare( @arguments )
1874
1875 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1876 etc.).
1877
1878 =cut
1879
1880 sub prepare {
1881     my ( $class, @arguments ) = @_;
1882
1883     # XXX
1884     # After the app/ctxt split, this should become an attribute based on something passed
1885     # into the application.
1886     $class->context_class( ref $class || $class ) unless $class->context_class;
1887
1888     my $context = Catalyst::Context->new();
1889     my $c = $class->context_class->new({ context => $context });
1890
1891     # For on-demand data
1892     $c->request->_context($c);
1893     $c->response->_context($c);
1894
1895     #surely this is not the most efficient way to do things...
1896     $c->stats($class->stats_class->new)->enable($c->use_stats);
1897     if ( $c->debug ) {
1898         $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1899     }
1900
1901     #XXX reuse coderef from can
1902     # Allow engine to direct the prepare flow (for POE)
1903     if ( $c->engine->can('prepare') ) {
1904         $c->engine->prepare( $c, @arguments );
1905     }
1906     else {
1907         $c->prepare_request(@arguments);
1908         $c->prepare_connection;
1909         $c->prepare_query_parameters;
1910         $c->prepare_headers;
1911         $c->prepare_cookies;
1912         $c->prepare_path;
1913
1914         # Prepare the body for reading, either by prepare_body
1915         # or the user, if they are using $c->read
1916         $c->prepare_read;
1917
1918         # Parse the body unless the user wants it on-demand
1919         unless ( ref($c)->config->{parse_on_demand} ) {
1920             $c->prepare_body;
1921         }
1922     }
1923
1924     my $method  = $c->req->method  || '';
1925     my $path    = $c->req->path;
1926     $path       = '/' unless length $path;
1927     my $address = $c->req->address || '';
1928
1929     $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1930       if $c->debug;
1931
1932     $c->prepare_action;
1933
1934     return $c;
1935 }
1936
1937 =head2 $c->prepare_action
1938
1939 Prepares action. See L<Catalyst::Dispatcher>.
1940
1941 =cut
1942
1943 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1944
1945 =head2 $c->prepare_body
1946
1947 Prepares message body.
1948
1949 =cut
1950
1951 sub prepare_body {
1952     my $c = shift;
1953
1954     return if $c->request->_has_body;
1955
1956     # Initialize on-demand data
1957     $c->engine->prepare_body( $c, @_ );
1958     $c->prepare_parameters;
1959     $c->prepare_uploads;
1960
1961     if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1962         my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1963         for my $key ( sort keys %{ $c->req->body_parameters } ) {
1964             my $param = $c->req->body_parameters->{$key};
1965             my $value = defined($param) ? $param : '';
1966             $t->row( $key,
1967                 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1968         }
1969         $c->log->debug( "Body Parameters are:\n" . $t->draw );
1970     }
1971 }
1972
1973 =head2 $c->prepare_body_chunk( $chunk )
1974
1975 Prepares a chunk of data before sending it to L<HTTP::Body>.
1976
1977 See L<Catalyst::Engine>.
1978
1979 =cut
1980
1981 sub prepare_body_chunk {
1982     my $c = shift;
1983     $c->engine->prepare_body_chunk( $c, @_ );
1984 }
1985
1986 =head2 $c->prepare_body_parameters
1987
1988 Prepares body parameters.
1989
1990 =cut
1991
1992 sub prepare_body_parameters {
1993     my $c = shift;
1994     $c->engine->prepare_body_parameters( $c, @_ );
1995 }
1996
1997 =head2 $c->prepare_connection
1998
1999 Prepares connection.
2000
2001 =cut
2002
2003 sub prepare_connection {
2004     my $c = shift;
2005     $c->engine->prepare_connection( $c, @_ );
2006 }
2007
2008 =head2 $c->prepare_cookies
2009
2010 Prepares cookies.
2011
2012 =cut
2013
2014 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2015
2016 =head2 $c->prepare_headers
2017
2018 Prepares headers.
2019
2020 =cut
2021
2022 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2023
2024 =head2 $c->prepare_parameters
2025
2026 Prepares parameters.
2027
2028 =cut
2029
2030 sub prepare_parameters {
2031     my $c = shift;
2032     $c->prepare_body_parameters;
2033     $c->engine->prepare_parameters( $c, @_ );
2034 }
2035
2036 =head2 $c->prepare_path
2037
2038 Prepares path and base.
2039
2040 =cut
2041
2042 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2043
2044 =head2 $c->prepare_query_parameters
2045
2046 Prepares query parameters.
2047
2048 =cut
2049
2050 sub prepare_query_parameters {
2051     my $c = shift;
2052
2053     $c->engine->prepare_query_parameters( $c, @_ );
2054
2055     if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2056         my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2057         for my $key ( sort keys %{ $c->req->query_parameters } ) {
2058             my $param = $c->req->query_parameters->{$key};
2059             my $value = defined($param) ? $param : '';
2060             $t->row( $key,
2061                 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2062         }
2063         $c->log->debug( "Query Parameters are:\n" . $t->draw );
2064     }
2065 }
2066
2067 =head2 $c->prepare_read
2068
2069 Prepares the input for reading.
2070
2071 =cut
2072
2073 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2074
2075 =head2 $c->prepare_request
2076
2077 Prepares the engine request.
2078
2079 =cut
2080
2081 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2082
2083 =head2 $c->prepare_uploads
2084
2085 Prepares uploads.
2086
2087 =cut
2088
2089 sub prepare_uploads {
2090     my $c = shift;
2091
2092     $c->engine->prepare_uploads( $c, @_ );
2093
2094     if ( $c->debug && keys %{ $c->request->uploads } ) {
2095         my $t = Text::SimpleTable->new(
2096             [ 12, 'Parameter' ],
2097             [ 26, 'Filename' ],
2098             [ 18, 'Type' ],
2099             [ 9,  'Size' ]
2100         );
2101         for my $key ( sort keys %{ $c->request->uploads } ) {
2102             my $upload = $c->request->uploads->{$key};
2103             for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2104                 $t->row( $key, $u->filename, $u->type, $u->size );
2105             }
2106         }
2107         $c->log->debug( "File Uploads are:\n" . $t->draw );
2108     }
2109 }
2110
2111 =head2 $c->prepare_write
2112
2113 Prepares the output for writing.
2114
2115 =cut
2116
2117 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2118
2119 =head2 $c->request_class
2120
2121 Returns or sets the request class.
2122
2123 =head2 $c->response_class
2124
2125 Returns or sets the response class.
2126
2127 =head2 $c->read( [$maxlength] )
2128
2129 Reads a chunk of data from the request body. This method is designed to
2130 be used in a while loop, reading C<$maxlength> bytes on every call.
2131 C<$maxlength> defaults to the size of the request if not specified.
2132
2133 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2134 directly.
2135
2136 Warning: If you use read(), Catalyst will not process the body,
2137 so you will not be able to access POST parameters or file uploads via
2138 $c->request.  You must handle all body parsing yourself.
2139
2140 =cut
2141
2142 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2143
2144 =head2 $c->run
2145
2146 Starts the engine.
2147
2148 =cut
2149
2150 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2151
2152 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2153
2154 Sets an action in a given namespace.
2155
2156 =cut
2157
2158 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2159
2160 =head2 $c->setup_actions($component)
2161
2162 Sets up actions for a component.
2163
2164 =cut
2165
2166 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2167
2168 =head2 $c->setup_components
2169
2170 This method is called internally to set up the application's components.
2171
2172 It finds modules by calling the L<locate_components> method, expands them to
2173 package names with the L<expand_component_module> method, and then installs
2174 each component into the application.
2175
2176 The C<setup_components> config option is passed to both of the above methods.
2177
2178 Installation of each component is performed by the L<setup_component> method,
2179 below.
2180
2181 =cut
2182
2183 sub setup_components {
2184     my $class = shift;
2185
2186     my $config  = $class->config->{ setup_components };
2187
2188     my @comps = sort { length $a <=> length $b }
2189                 $class->locate_components($config);
2190     my %comps = map { $_ => 1 } @comps;
2191
2192     my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2193     $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2194         qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2195     ) if $deprecatedcatalyst_component_names;
2196
2197     for my $component ( @comps ) {
2198
2199         # We pass ignore_loaded here so that overlay files for (e.g.)
2200         # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2201         # we know M::P::O found a file on disk so this is safe
2202
2203         Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2204
2205         # Needs to be done as soon as the component is loaded, as loading a sub-component
2206         # (next time round the loop) can cause us to get the wrong metaclass..
2207         $class->_controller_init_base_classes($component);
2208     }
2209
2210     for my $component (@comps) {
2211         $class->components->{ $component } = $class->setup_component($component);
2212         for my $component ($class->expand_component_module( $component, $config )) {
2213             next if $comps{$component};
2214             $class->_controller_init_base_classes($component); # Also cover inner packages
2215             $class->components->{ $component } = $class->setup_component($component);
2216         }
2217     }
2218 }
2219
2220 =head2 $c->locate_components( $setup_component_config )
2221
2222 This method is meant to provide a list of component modules that should be
2223 setup for the application.  By default, it will use L<Module::Pluggable>.
2224
2225 Specify a C<setup_components> config option to pass additional options directly
2226 to L<Module::Pluggable>. To add additional search paths, specify a key named
2227 C<search_extra> as an array reference. Items in the array beginning with C<::>
2228 will have the application class name prepended to them.
2229
2230 =cut
2231
2232 sub locate_components {
2233     my $class  = shift;
2234     my $config = shift;
2235
2236     my @paths   = qw( ::Controller ::C ::Model ::M ::View ::V );
2237     my $extra   = delete $config->{ search_extra } || [];
2238
2239     push @paths, @$extra;
2240
2241     my $locator = Module::Pluggable::Object->new(
2242         search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2243         %$config
2244     );
2245
2246     my @comps = $locator->plugins;
2247
2248     return @comps;
2249 }
2250
2251 =head2 $c->expand_component_module( $component, $setup_component_config )
2252
2253 Components found by C<locate_components> will be passed to this method, which
2254 is expected to return a list of component (package) names to be set up.
2255
2256 =cut
2257
2258 sub expand_component_module {
2259     my ($class, $module) = @_;
2260     return Devel::InnerPackage::list_packages( $module );
2261 }
2262
2263 =head2 $c->setup_component
2264
2265 =cut
2266
2267 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2268 #         nearest to Catalyst::Controller first, no matter what order stuff happens
2269 #         to be loaded. There are TODO tests in Moose for this, see
2270 #         f2391d17574eff81d911b97be15ea51080500003
2271 sub _controller_init_base_classes {
2272     my ($app_class, $component) = @_;
2273     return unless $component->isa('Catalyst::Controller');
2274     foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2275         Moose::Meta::Class->initialize( $class )
2276             unless find_meta($class);
2277     }
2278 }
2279
2280 sub setup_component {
2281     my( $class, $component ) = @_;
2282
2283     unless ( $component->can( 'COMPONENT' ) ) {
2284         return $component;
2285     }
2286
2287     my $suffix = Catalyst::Utils::class2classsuffix( $component );
2288     my $config = $class->config->{ $suffix } || {};
2289     # Stash catalyst_component_name in the config here, so that custom COMPONENT
2290     # methods also pass it. local to avoid pointlessly shitting in config
2291     # for the debug screen, as $component is already the key name.
2292     local $config->{catalyst_component_name} = $component;
2293
2294     my $instance = eval { $component->COMPONENT( $class, $config ); };
2295
2296     if ( my $error = $@ ) {
2297         chomp $error;
2298         Catalyst::Exception->throw(
2299             message => qq/Couldn't instantiate component "$component", "$error"/
2300         );
2301     }
2302
2303     unless (blessed $instance) {
2304         my $metaclass = Moose::Util::find_meta($component);
2305         my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2306         my $component_method_from = $method_meta->associated_metaclass->name;
2307         my $value = defined($instance) ? $instance : 'undef';
2308         Catalyst::Exception->throw(
2309             message =>
2310             qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2311         );
2312     }
2313     return $instance;
2314 }
2315
2316 =head2 $c->setup_dispatcher
2317
2318 Sets up dispatcher.
2319
2320 =cut
2321
2322 sub setup_dispatcher {
2323     my ( $class, $dispatcher ) = @_;
2324
2325     if ($dispatcher) {
2326         $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2327     }
2328
2329     if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2330         $dispatcher = 'Catalyst::Dispatcher::' . $env;
2331     }
2332
2333     unless ($dispatcher) {
2334         $dispatcher = $class->dispatcher_class;
2335     }
2336
2337     Class::MOP::load_class($dispatcher);
2338
2339     # dispatcher instance
2340     $class->dispatcher( $dispatcher->new );
2341 }
2342
2343 =head2 $c->setup_engine
2344
2345 Sets up engine.
2346
2347 =cut
2348
2349 sub setup_engine {
2350     my ( $class, $engine ) = @_;
2351
2352     if ($engine) {
2353         $engine = 'Catalyst::Engine::' . $engine;
2354     }
2355
2356     if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2357         $engine = 'Catalyst::Engine::' . $env;
2358     }
2359
2360     if ( $ENV{MOD_PERL} ) {
2361         my $meta = Class::MOP::get_metaclass_by_name($class);
2362
2363         # create the apache method
2364         $meta->add_method('apache' => sub { shift->engine->apache });
2365
2366         my ( $software, $version ) =
2367           $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2368
2369         $version =~ s/_//g;
2370         $version =~ s/(\.[^.]+)\./$1/g;
2371
2372         if ( $software eq 'mod_perl' ) {
2373
2374             if ( !$engine ) {
2375
2376                 if ( $version >= 1.99922 ) {
2377                     $engine = 'Catalyst::Engine::Apache2::MP20';
2378                 }
2379
2380                 elsif ( $version >= 1.9901 ) {
2381                     $engine = 'Catalyst::Engine::Apache2::MP19';
2382                 }
2383
2384                 elsif ( $version >= 1.24 ) {
2385                     $engine = 'Catalyst::Engine::Apache::MP13';
2386                 }
2387
2388                 else {
2389                     Catalyst::Exception->throw( message =>
2390                           qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2391                 }
2392
2393             }
2394
2395             # install the correct mod_perl handler
2396             if ( $version >= 1.9901 ) {
2397                 *handler = sub  : method {
2398                     shift->handle_request(@_);
2399                 };
2400             }
2401             else {
2402                 *handler = sub ($$) { shift->handle_request(@_) };
2403             }
2404
2405         }
2406
2407         elsif ( $software eq 'Zeus-Perl' ) {
2408             $engine = 'Catalyst::Engine::Zeus';
2409         }
2410
2411         else {
2412             Catalyst::Exception->throw(
2413                 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2414         }
2415     }
2416
2417     unless ($engine) {
2418         $engine = $class->engine_class;
2419     }
2420
2421     Class::MOP::load_class($engine);
2422
2423     # check for old engines that are no longer compatible
2424     my $old_engine;
2425     if ( $engine->isa('Catalyst::Engine::Apache')
2426         && !Catalyst::Engine::Apache->VERSION )
2427     {
2428         $old_engine = 1;
2429     }
2430
2431     elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2432         && Catalyst::Engine::Server->VERSION le '0.02' )
2433     {
2434         $old_engine = 1;
2435     }
2436
2437     elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2438         && $engine->VERSION eq '0.01' )
2439     {
2440         $old_engine = 1;
2441     }
2442
2443     elsif ($engine->isa('Catalyst::Engine::Zeus')
2444         && $engine->VERSION eq '0.01' )
2445     {
2446         $old_engine = 1;
2447     }
2448
2449     if ($old_engine) {
2450         Catalyst::Exception->throw( message =>
2451               qq/Engine "$engine" is not supported by this version of Catalyst/
2452         );
2453     }
2454
2455     # engine instance
2456     $class->engine( $engine->new );
2457 }
2458
2459 =head2 $c->setup_home
2460
2461 Sets up the home directory.
2462
2463 =cut
2464
2465 sub setup_home {
2466     my ( $class, $home ) = @_;
2467
2468     if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2469         $home = $env;
2470     }
2471
2472     $home ||= Catalyst::Utils::home($class);
2473
2474     if ($home) {
2475         #I remember recently being scolded for assigning config values like this
2476         $class->config->{home} ||= $home;
2477         $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2478     }
2479 }
2480
2481 =head2 $c->setup_log
2482
2483 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2484 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2485 log to.
2486
2487 This method also installs a C<debug> method that returns a true value into the
2488 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2489 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2490
2491 Note that if the log has already been setup, by either a previous call to
2492 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2493 that this method won't actually set up the log object.
2494
2495 =cut
2496
2497 sub setup_log {
2498     my ( $class, $levels ) = @_;
2499
2500     $levels ||= '';
2501     $levels =~ s/^\s+//;
2502     $levels =~ s/\s+$//;
2503     my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2504
2505     my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2506     if ( defined $env_debug ) {
2507         $levels{debug} = 1 if $env_debug; # Ugly!
2508         delete($levels{debug}) unless $env_debug;
2509     }
2510
2511     unless ( $class->log ) {
2512         $class->log( Catalyst::Log->new(keys %levels) );
2513     }
2514
2515     if ( $levels{debug} ) {
2516         Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2517         $class->log->debug('Debug messages enabled');
2518     }
2519 }
2520
2521 =head2 $c->setup_plugins
2522
2523 Sets up plugins.
2524
2525 =cut
2526
2527 =head2 $c->setup_stats
2528
2529 Sets up timing statistics class.
2530
2531 =cut
2532
2533 sub setup_stats {
2534     my ( $class, $stats ) = @_;
2535
2536     Catalyst::Utils::ensure_class_loaded($class->stats_class);
2537
2538     my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2539     if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2540         Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2541         $class->log->debug('Statistics enabled');
2542     }
2543 }
2544
2545
2546 =head2 $c->registered_plugins
2547
2548 Returns a sorted list of the plugins which have either been stated in the
2549 import list or which have been added via C<< MyApp->plugin(@args); >>.
2550
2551 If passed a given plugin name, it will report a boolean value indicating
2552 whether or not that plugin is loaded.  A fully qualified name is required if
2553 the plugin name does not begin with C<Catalyst::Plugin::>.
2554
2555  if ($c->registered_plugins('Some::Plugin')) {
2556      ...
2557  }
2558
2559 =cut
2560
2561 {
2562
2563     sub registered_plugins {
2564         my $proto = shift;
2565         return sort keys %{ $proto->_plugins } unless @_;
2566         my $plugin = shift;
2567         return 1 if exists $proto->_plugins->{$plugin};
2568         return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2569     }
2570
2571     sub _register_plugin {
2572         my ( $proto, $plugin, $instant ) = @_;
2573         my $class = ref $proto || $proto;
2574
2575         Class::MOP::load_class( $plugin );
2576
2577         $proto->_plugins->{$plugin} = 1;
2578         unless ($instant) {
2579             no strict 'refs';
2580             if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2581               my @superclasses = ($plugin, $meta->superclasses );
2582               $meta->superclasses(@superclasses);
2583             } else {
2584               unshift @{"$class\::ISA"}, $plugin;
2585             }
2586         }
2587         return $class;
2588     }
2589
2590     sub setup_plugins {
2591         my ( $class, $plugins ) = @_;
2592
2593         $class->_plugins( {} ) unless $class->_plugins;
2594         $plugins ||= [];
2595
2596         my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2597
2598         for my $plugin ( reverse @plugins ) {
2599             Class::MOP::load_class($plugin);
2600             my $meta = find_meta($plugin);
2601             next if $meta && $meta->isa('Moose::Meta::Role');
2602
2603             $class->_register_plugin($plugin);
2604         }
2605
2606         my @roles =
2607             map { $_->name }
2608             grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2609             map { find_meta($_) }
2610             @plugins;
2611
2612         Moose::Util::apply_all_roles(
2613             $class => @roles
2614         ) if @roles;
2615     }
2616 }
2617
2618 =head2 $c->stack
2619
2620 Returns an arrayref of the internal execution stack (actions that are
2621 currently executing).
2622
2623 =head2 $c->stats_class
2624
2625 Returns or sets the stats (timing statistics) class.
2626
2627 =head2 $c->use_stats
2628
2629 Returns 1 when stats collection is enabled.  Stats collection is enabled
2630 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2631 environment variable is set.
2632
2633 Note that this is a static method, not an accessor and should be overridden
2634 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2635
2636 =cut
2637
2638 sub use_stats { 0 }
2639
2640
2641 =head2 $c->write( $data )
2642
2643 Writes $data to the output stream. When using this method directly, you
2644 will need to manually set the C<Content-Length> header to the length of
2645 your output data, if known.
2646
2647 =cut
2648
2649 sub write {
2650     my $c = shift;
2651
2652     # Finalize headers if someone manually writes output
2653     $c->finalize_headers;
2654
2655     return $c->engine->write( $c, @_ );
2656 }
2657
2658 =head2 version
2659
2660 Returns the Catalyst version number. Mostly useful for "powered by"
2661 messages in template systems.
2662
2663 =cut
2664
2665 sub version { return $Catalyst::VERSION }
2666
2667 =head1 CONFIGURATION
2668
2669 There are a number of 'base' config variables which can be set:
2670
2671 =over
2672
2673 =item *
2674
2675 C<case_sensitive> - Makes private paths case sensitive. See L</CASE SENSITIVITY>.
2676
2677 =item *
2678
2679 C<default_model> - The default model picked if you say C<< $c->model >>. See L</$c->model($name)>.
2680
2681 =item *
2682
2683 C<default_view> - The default view to be rendered or returned when C<< $c->view >>. See L</$c->view($name)>.
2684 is called.
2685
2686 =item *
2687
2688 C<disable_component_resolution_regex_fallback> - Turns
2689 off the deprecated component resolution functionality so
2690 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2691 are called then regex search will not be attempted on string values and
2692 instead C<undef> will be returned.
2693
2694 =item *
2695
2696 C<home> - The application home directory. In an uninstalled application,
2697 this is the top level application directory. In an installed application,
2698 this will be the directory containing C<< MyApp.pm >>.
2699
2700 =item *
2701
2702 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2703
2704 =item *
2705
2706 C<name> - The name of the application in debug messages and the debug and
2707 welcome screens
2708
2709 =item *
2710
2711 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2712 until it is accessed. This allows you to (for example) check authentication (and reject
2713 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2714
2715 =item *
2716
2717 C<root> - The root directory for templates. Usually this is just a
2718 subdirectory of the home directory, but you can set it to change the
2719 templates to a different directory.
2720
2721 =item *
2722
2723 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2724 namespaces from which components will be loaded (and constructed and stored in
2725 C<< $c->components >>).
2726
2727 =item *
2728
2729 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2730 to be shown in hit debug tables in the test server.
2731
2732 =item *
2733
2734 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2735
2736 =back
2737
2738 =head1 INTERNAL ACTIONS
2739
2740 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2741 C<_ACTION>, and C<_END>. These are by default not shown in the private
2742 action table, but you can make them visible with a config parameter.
2743
2744     MyApp->config(show_internal_actions => 1);
2745
2746 =head1 CASE SENSITIVITY
2747
2748 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2749 mapped to C</foo/bar>. You can activate case sensitivity with a config
2750 parameter.
2751
2752     MyApp->config(case_sensitive => 1);
2753
2754 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2755
2756 =head1 ON-DEMAND PARSER
2757
2758 The request body is usually parsed at the beginning of a request,
2759 but if you want to handle input yourself, you can enable on-demand
2760 parsing with a config parameter.
2761
2762     MyApp->config(parse_on_demand => 1);
2763
2764 =head1 PROXY SUPPORT
2765
2766 Many production servers operate using the common double-server approach,
2767 with a lightweight frontend web server passing requests to a larger
2768 backend server. An application running on the backend server must deal
2769 with two problems: the remote user always appears to be C<127.0.0.1> and
2770 the server's hostname will appear to be C<localhost> regardless of the
2771 virtual host that the user connected through.
2772
2773 Catalyst will automatically detect this situation when you are running
2774 the frontend and backend servers on the same machine. The following
2775 changes are made to the request.
2776
2777     $c->req->address is set to the user's real IP address, as read from
2778     the HTTP X-Forwarded-For header.
2779
2780     The host value for $c->req->base and $c->req->uri is set to the real
2781     host, as read from the HTTP X-Forwarded-Host header.
2782
2783 Additionally, you may be running your backend application on an insecure
2784 connection (port 80) while your frontend proxy is running under SSL.  If there
2785 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2786 tell Catalyst what port the frontend listens on.  This will allow all URIs to
2787 be created properly.
2788
2789 In the case of passing in:
2790
2791     X-Forwarded-Port: 443
2792
2793 All calls to C<uri_for> will result in an https link, as is expected.
2794
2795 Obviously, your web server must support these headers for this to work.
2796
2797 In a more complex server farm environment where you may have your
2798 frontend proxy server(s) on different machines, you will need to set a
2799 configuration option to tell Catalyst to read the proxied data from the
2800 headers.
2801
2802     MyApp->config(using_frontend_proxy => 1);
2803
2804 If you do not wish to use the proxy support at all, you may set:
2805
2806     MyApp->config(ignore_frontend_proxy => 1);
2807
2808 =head1 THREAD SAFETY
2809
2810 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2811 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2812 believe the Catalyst core to be thread-safe.
2813
2814 If you plan to operate in a threaded environment, remember that all other
2815 modules you are using must also be thread-safe. Some modules, most notably
2816 L<DBD::SQLite>, are not thread-safe.
2817
2818 =head1 SUPPORT
2819
2820 IRC:
2821
2822     Join #catalyst on irc.perl.org.
2823
2824 Mailing Lists:
2825
2826     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2827     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2828
2829 Web:
2830
2831     http://catalyst.perl.org
2832
2833 Wiki:
2834
2835     http://dev.catalyst.perl.org
2836
2837 =head1 SEE ALSO
2838
2839 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2840
2841 =head2 L<Catalyst::Manual> - The Catalyst Manual
2842
2843 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2844
2845 =head2 L<Catalyst::Engine> - Core engine
2846
2847 =head2 L<Catalyst::Log> - Log class.
2848
2849 =head2 L<Catalyst::Request> - Request object
2850
2851 =head2 L<Catalyst::Response> - Response object
2852
2853 =head2 L<Catalyst::Test> - The test suite.
2854
2855 =head1 PROJECT FOUNDER
2856
2857 sri: Sebastian Riedel <sri@cpan.org>
2858
2859 =head1 CONTRIBUTORS
2860
2861 abw: Andy Wardley
2862
2863 acme: Leon Brocard <leon@astray.com>
2864
2865 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2866
2867 Andrew Bramble
2868
2869 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2870
2871 Andrew Ruthven
2872
2873 andyg: Andy Grundman <andy@hybridized.org>
2874
2875 audreyt: Audrey Tang
2876
2877 bricas: Brian Cassidy <bricas@cpan.org>
2878
2879 Caelum: Rafael Kitover <rkitover@io.com>
2880
2881 chansen: Christian Hansen
2882
2883 chicks: Christopher Hicks
2884
2885 Chisel Wright C<pause@herlpacker.co.uk>
2886
2887 Danijel Milicevic C<me@danijel.de>
2888
2889 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2890
2891 David Naughton, C<naughton@umn.edu>
2892
2893 David E. Wheeler
2894
2895 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2896
2897 Drew Taylor
2898
2899 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2900
2901 esskar: Sascha Kiefer
2902
2903 fireartist: Carl Franks <cfranks@cpan.org>
2904
2905 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2906
2907 gabb: Danijel Milicevic
2908
2909 Gary Ashton Jones
2910
2911 Gavin Henry C<ghenry@perl.me.uk>
2912
2913 Geoff Richards
2914
2915 groditi: Guillermo Roditi <groditi@gmail.com>
2916
2917 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2918
2919 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2920
2921 jcamacho: Juan Camacho
2922
2923 jester: Jesse Sheidlower C<jester@panix.com>
2924
2925 jhannah: Jay Hannah <jay@jays.net>
2926
2927 Jody Belka
2928
2929 Johan Lindstrom
2930
2931 jon: Jon Schutz <jjschutz@cpan.org>
2932
2933 Jonathan Rockway C<< <jrockway@cpan.org> >>
2934
2935 Kieren Diment C<kd@totaldatasolution.com>
2936
2937 konobi: Scott McWhirter <konobi@cpan.org>
2938
2939 marcus: Marcus Ramberg <mramberg@cpan.org>
2940
2941 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2942
2943 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2944
2945 mugwump: Sam Vilain
2946
2947 naughton: David Naughton
2948
2949 ningu: David Kamholz <dkamholz@cpan.org>
2950
2951 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2952
2953 numa: Dan Sully <daniel@cpan.org>
2954
2955 obra: Jesse Vincent
2956
2957 omega: Andreas Marienborg
2958
2959 Oleg Kostyuk <cub.uanic@gmail.com>
2960
2961 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2962
2963 rafl: Florian Ragwitz <rafl@debian.org>
2964
2965 random: Roland Lammel <lammel@cpan.org>
2966
2967 Robert Sedlacek C<< <rs@474.at> >>
2968
2969 sky: Arthur Bergman
2970
2971 t0m: Tomas Doran <bobtfish@bobtfish.net>
2972
2973 Ulf Edvinsson
2974
2975 Viljo Marrandi C<vilts@yahoo.com>
2976
2977 Will Hawes C<info@whawes.co.uk>
2978
2979 willert: Sebastian Willert <willert@cpan.org>
2980
2981 Yuval Kogman, C<nothingmuch@woobling.org>
2982
2983 =head1 LICENSE
2984
2985 This library is free software. You can redistribute it and/or modify it under
2986 the same terms as Perl itself.
2987
2988 =cut
2989
2990 no Moose;
2991
2992 __PACKAGE__->meta->make_immutable;
2993
2994 1;