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