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