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