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