4 extends 'Catalyst::Component';
5 use Moose::Util qw/find_meta/;
8 use Catalyst::Exception;
10 use Catalyst::Request;
11 use Catalyst::Request::Upload;
12 use Catalyst::Response;
14 use Catalyst::Controller;
15 use Devel::InnerPackage ();
17 use Module::Pluggable::Object ();
18 use Text::SimpleTable ();
19 use Path::Class::Dir ();
20 use Path::Class::File ();
24 use Tree::Simple qw/use_weak_refs/;
25 use Tree::Simple::Visitor::FindByUID;
26 use Class::C3::Adopt::NEXT;
29 use Carp qw/croak carp shortmess/;
31 BEGIN { require 5.008001; }
33 has stack => (is => 'ro', default => sub { [] });
34 has stash => (is => 'rw', default => sub { {} });
35 has state => (is => 'rw', default => 0);
36 has stats => (is => 'rw');
37 has action => (is => 'rw');
38 has counter => (is => 'rw', default => sub { {} });
39 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
40 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
41 has namespace => (is => 'rw');
43 sub depth { scalar @{ shift->stack || [] }; }
44 sub comp { shift->component(@_) }
47 my $self = shift; return $self->request(@_);
50 my $self = shift; return $self->response(@_);
53 # For backwards compatibility
54 sub finalize_output { shift->finalize_body(@_) };
59 our $RECURSION = 1000;
60 our $DETACH = "catalyst_detach\n";
61 our $GO = "catalyst_go\n";
63 #I imagine that very few of these really need to be class variables. if any.
64 #maybe we should just make them attributes with a default?
65 __PACKAGE__->mk_classdata($_)
66 for qw/components arguments dispatcher engine log dispatcher_class
67 engine_class context_class request_class response_class stats_class
70 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
71 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
72 __PACKAGE__->request_class('Catalyst::Request');
73 __PACKAGE__->response_class('Catalyst::Response');
74 __PACKAGE__->stats_class('Catalyst::Stats');
76 # Remember to update this in Catalyst::Runtime as well!
78 our $VERSION = '5.80001';
81 my $dev_version = $VERSION =~ /_\d{2}$/;
82 *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
85 $VERSION = eval $VERSION;
88 my ( $class, @arguments ) = @_;
90 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
92 return unless $class eq 'Catalyst';
94 my $caller = caller();
95 return if $caller eq 'main';
97 # Kill Adopt::NEXT warnings if we're a non-RC version
98 unless (_IS_DEVELOPMENT_VERSION()) {
99 Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
102 my $meta = Moose::Meta::Class->initialize($caller);
103 #Moose->import({ into => $caller }); #do we want to do this?
105 unless ( $caller->isa('Catalyst') ) {
106 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
107 $meta->superclasses(@superclasses);
109 unless( $meta->has_method('meta') ){
110 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
113 $caller->arguments( [@arguments] );
119 Catalyst - The Elegant MVC Web Application Framework
123 See the L<Catalyst::Manual> distribution for comprehensive
124 documentation and tutorials.
126 # Install Catalyst::Devel for helpers and other development tools
127 # use the helper to create a new application
130 # add models, views, controllers
131 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
132 script/myapp_create.pl view MyTemplate TT
133 script/myapp_create.pl controller Search
135 # built in testserver -- use -r to restart automatically on changes
136 # --help to see all available options
137 script/myapp_server.pl
139 # command line testing interface
140 script/myapp_test.pl /yada
143 use Catalyst qw/-Debug/; # include plugins here as well
145 ### In lib/MyApp/Controller/Root.pm (autocreated)
146 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
147 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
148 $c->stash->{template} = 'foo.tt'; # set the template
149 # lookup something from db -- stash vars are passed to TT
151 $c->model('Database::Foo')->search( { country => $args[0] } );
152 if ( $c->req->params->{bar} ) { # access GET or POST parameters
153 $c->forward( 'bar' ); # process another action
154 # do something else after forward returns
158 # The foo.tt TT template can use the stash data from the database
159 [% WHILE (item = data.next) %]
163 # called for /bar/of/soap, /bar/of/soap/10, etc.
164 sub bar : Path('/bar/of/soap') { ... }
166 # called for all actions, from the top-most controller downwards
168 my ( $self, $c ) = @_;
169 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
170 $c->res->redirect( '/login' ); # require login
171 return 0; # abort request and go immediately to end()
173 return 1; # success; carry on to next action
176 # called after all actions are finished
178 my ( $self, $c ) = @_;
179 if ( scalar @{ $c->error } ) { ... } # handle errors
180 return if $c->res->body; # already have a response
181 $c->forward( 'MyApp::View::TT' ); # render template
184 ### in MyApp/Controller/Foo.pm
185 # called for /foo/bar
186 sub bar : Local { ... }
188 # called for /blargle
189 sub blargle : Global { ... }
191 # an index action matches /foo, but not /foo/1, etc.
192 sub index : Private { ... }
194 ### in MyApp/Controller/Foo/Bar.pm
195 # called for /foo/bar/baz
196 sub baz : Local { ... }
198 # first Root auto is called, then Foo auto, then this
199 sub auto : Private { ... }
201 # powerful regular expression paths are also possible
202 sub details : Regex('^product/(\w+)/details$') {
203 my ( $self, $c ) = @_;
204 # extract the (\w+) from the URI
205 my $product = $c->req->captures->[0];
208 See L<Catalyst::Manual::Intro> for additional information.
212 Catalyst is a modern framework for making web applications without the
213 pain usually associated with this process. This document is a reference
214 to the main Catalyst application. If you are a new user, we suggest you
215 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
217 See L<Catalyst::Manual> for more documentation.
219 Catalyst plugins can be loaded by naming them as arguments to the "use
220 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
221 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
224 use Catalyst qw/My::Module/;
226 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
227 fully qualify the name by using a unary plus:
231 +Fully::Qualified::Plugin::Name
234 Special flags like C<-Debug> and C<-Engine> can also be specified as
235 arguments when Catalyst is loaded:
237 use Catalyst qw/-Debug My::Module/;
239 The position of plugins and flags in the chain is important, because
240 they are loaded in the order in which they appear.
242 The following flags are supported:
246 Enables debug output. You can also force this setting from the system
247 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
248 settings override the application, with <MYAPP>_DEBUG having the highest
253 Forces Catalyst to use a specific engine. Omit the
254 C<Catalyst::Engine::> prefix of the engine name, i.e.:
256 use Catalyst qw/-Engine=CGI/;
260 Forces Catalyst to use a specific home directory, e.g.:
262 use Catalyst qw[-Home=/usr/mst];
264 This can also be done in the shell environment by setting either the
265 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
266 is replaced with the uppercased name of your application, any "::" in
267 the name will be replaced with underscores, e.g. MyApp::Web should use
268 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
272 use Catalyst '-Log=warn,fatal,error';
274 Specifies a comma-delimited list of log levels.
278 Enables statistics collection and reporting. You can also force this setting
279 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
280 environment settings override the application, with <MYAPP>_STATS having the
285 use Catalyst qw/-Stats=1/
289 =head2 INFORMATION ABOUT THE CURRENT REQUEST
293 Returns a L<Catalyst::Action> object for the current action, which
294 stringifies to the action name. See L<Catalyst::Action>.
298 Returns the namespace of the current action, i.e., the URI prefix
299 corresponding to the controller of the current action. For example:
301 # in Controller::Foo::Bar
302 $c->namespace; # returns 'foo/bar';
308 Returns the current L<Catalyst::Request> object, giving access to
309 information about the current client request (including parameters,
310 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
312 =head2 REQUEST FLOW HANDLING
314 =head2 $c->forward( $action [, \@arguments ] )
316 =head2 $c->forward( $class, $method, [, \@arguments ] )
318 Forwards processing to another action, by its private name. If you give a
319 class name but no method, C<process()> is called. You may also optionally
320 pass arguments in an arrayref. The action will receive the arguments in
321 C<@_> and C<< $c->req->args >>. Upon returning from the function,
322 C<< $c->req->args >> will be restored to the previous values.
324 Any data C<return>ed from the action forwarded to, will be returned by the
327 my $foodata = $c->forward('/foo');
328 $c->forward('index');
329 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
330 $c->forward('MyApp::View::TT');
332 Note that forward implies an C<<eval { }>> around the call (actually
333 C<execute> does), thus de-fatalizing all 'dies' within the called
334 action. If you want C<die> to propagate you need to do something like:
337 die $c->error if $c->error;
339 Or make sure to always return true values from your actions and write
342 $c->forward('foo') || return;
346 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
348 =head2 $c->detach( $action [, \@arguments ] )
350 =head2 $c->detach( $class, $method, [, \@arguments ] )
354 The same as C<forward>, but doesn't return to the previous action when
355 processing is finished.
357 When called with no arguments it escapes the processing chain entirely.
361 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
363 =head2 $c->visit( $action [, \@captures, \@arguments ] )
365 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
367 Almost the same as C<forward>, but does a full dispatch, instead of just
368 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
369 C<auto> and the method you go to are called, just like a new request.
371 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
372 This means, for example, that $c->action methods such as C<name>, C<class> and
373 C<reverse> return information for the visited action when they are invoked
374 within the visited action. This is different from the behavior of C<forward>
375 which continues to use the $c->action object from the caller action even when
376 invoked from the callee.
378 C<$c-E<gt>stash> is kept unchanged.
380 In effect, C<visit> allows you to "wrap" another action, just as it
381 would have been called by dispatching from a URL, while the analogous
382 C<go> allows you to transfer control to another action as if it had
383 been reached directly from a URL.
387 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
389 =head2 $c->go( $action [, \@captures, \@arguments ] )
391 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
393 Almost the same as C<detach>, but does a full dispatch like C<visit>,
394 instead of just calling the new C<$action> /
395 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
396 method you visit are called, just like a new request.
398 C<$c-E<gt>stash> is kept unchanged.
402 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
408 Returns the current L<Catalyst::Response> object, see there for details.
412 Returns a hashref to the stash, which may be used to store data and pass
413 it between components during a request. You can also set hash keys by
414 passing arguments. The stash is automatically sent to the view. The
415 stash is cleared at the end of a request; it cannot be used for
416 persistent storage (for this you must use a session; see
417 L<Catalyst::Plugin::Session> for a complete system integrated with
420 $c->stash->{foo} = $bar;
421 $c->stash( { moose => 'majestic', qux => 0 } );
422 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
424 # stash is automatically passed to the view for use in a template
425 $c->forward( 'MyApp::View::TT' );
429 around stash => sub {
432 my $stash = $orig->($c);
434 my $new_stash = @_ > 1 ? {@_} : $_[0];
435 croak('stash takes a hash or hashref') unless ref $new_stash;
436 foreach my $key ( keys %$new_stash ) {
437 $stash->{$key} = $new_stash->{$key};
447 =head2 $c->error($error, ...)
449 =head2 $c->error($arrayref)
451 Returns an arrayref containing error messages. If Catalyst encounters an
452 error while processing a request, it stores the error in $c->error. This
453 method should only be used to store fatal error messages.
455 my @error = @{ $c->error };
459 $c->error('Something bad happened');
466 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
467 croak @$error unless ref $c;
468 push @{ $c->{error} }, @$error;
470 elsif ( defined $_[0] ) { $c->{error} = undef }
471 return $c->{error} || [];
477 Contains the return value of the last executed action.
479 =head2 $c->clear_errors
481 Clear errors. You probably don't want to clear the errors unless you are
482 implementing a custom error screen.
484 This is equivalent to running
495 # search components given a name and some prefixes
496 sub _comp_search_prefixes {
497 my ( $c, $name, @prefixes ) = @_;
498 my $appclass = ref $c || $c;
499 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
500 $filter = qr/$filter/; # Compile regex now rather than once per loop
502 # map the original component name to the sub part that we will search against
503 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
504 grep { /$filter/ } keys %{ $c->components };
506 # undef for a name will return all
507 return keys %eligible if !defined $name;
509 my $query = ref $name ? $name : qr/^$name$/i;
510 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
512 return map { $c->components->{ $_ } } @result if @result;
514 # if we were given a regexp to search against, we're done.
519 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
521 # no results? try against full names
523 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
526 # don't warn if we didn't find any results, it just might not exist
528 # Disgusting hack to work out correct method name
529 my $warn_for = lc $prefixes[0];
530 my $msg = "Used regexp fallback for \$c->{$warn_for}('${name}'), which found '" .
531 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
532 "component resolution is unreliable and unsafe.";
533 my $short = $result[0];
534 $short =~ s/.*?Model:://;
535 my $shortmess = Carp::shortmess('');
536 if ($shortmess =~ m#Catalyst/Plugin#) {
537 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
539 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
540 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
541 "component's config";
543 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
544 "but if you really wanted to search, pass in a regexp as the argument " .
545 "like so: \$c->${warn_for}(qr/${name}/)";
547 $c->log->warn( "${msg}$shortmess" );
553 # Find possible names for a prefix
555 my ( $c, @prefixes ) = @_;
556 my $appclass = ref $c || $c;
558 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
560 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
564 # Filter a component before returning by calling ACCEPT_CONTEXT if available
565 sub _filter_component {
566 my ( $c, $comp, @args ) = @_;
568 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
569 return $comp->ACCEPT_CONTEXT( $c, @args );
575 =head2 COMPONENT ACCESSORS
577 =head2 $c->controller($name)
579 Gets a L<Catalyst::Controller> instance by name.
581 $c->controller('Foo')->do_stuff;
583 If the name is omitted, will return the controller for the dispatched
586 If you want to search for controllers, pass in a regexp as the argument.
588 # find all controllers that start with Foo
589 my @foo_controllers = $c->controller(qr{^Foo});
595 my ( $c, $name, @args ) = @_;
598 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
599 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
600 return $c->_filter_component( $result[ 0 ], @args );
603 return $c->component( $c->action->class );
606 =head2 $c->model($name)
608 Gets a L<Catalyst::Model> instance by name.
610 $c->model('Foo')->do_stuff;
612 Any extra arguments are directly passed to ACCEPT_CONTEXT.
614 If the name is omitted, it will look for
615 - a model object in $c->stash->{current_model_instance}, then
616 - a model name in $c->stash->{current_model}, then
617 - a config setting 'default_model', or
618 - check if there is only one model, and return it if that's the case.
620 If you want to search for models, pass in a regexp as the argument.
622 # find all models that start with Foo
623 my @foo_models = $c->model(qr{^Foo});
628 my ( $c, $name, @args ) = @_;
631 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
632 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
633 return $c->_filter_component( $result[ 0 ], @args );
637 return $c->stash->{current_model_instance}
638 if $c->stash->{current_model_instance};
639 return $c->model( $c->stash->{current_model} )
640 if $c->stash->{current_model};
642 return $c->model( $c->config->{default_model} )
643 if $c->config->{default_model};
645 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
648 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
649 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
650 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
651 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
652 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
655 return $c->_filter_component( $comp );
659 =head2 $c->view($name)
661 Gets a L<Catalyst::View> instance by name.
663 $c->view('Foo')->do_stuff;
665 Any extra arguments are directly passed to ACCEPT_CONTEXT.
667 If the name is omitted, it will look for
668 - a view object in $c->stash->{current_view_instance}, then
669 - a view name in $c->stash->{current_view}, then
670 - a config setting 'default_view', or
671 - check if there is only one view, and return it if that's the case.
673 If you want to search for views, pass in a regexp as the argument.
675 # find all views that start with Foo
676 my @foo_views = $c->view(qr{^Foo});
681 my ( $c, $name, @args ) = @_;
684 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
685 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
686 return $c->_filter_component( $result[ 0 ], @args );
690 return $c->stash->{current_view_instance}
691 if $c->stash->{current_view_instance};
692 return $c->view( $c->stash->{current_view} )
693 if $c->stash->{current_view};
695 return $c->view( $c->config->{default_view} )
696 if $c->config->{default_view};
698 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
701 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
702 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
703 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
704 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
705 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
708 return $c->_filter_component( $comp );
711 =head2 $c->controllers
713 Returns the available names which can be passed to $c->controller
719 return $c->_comp_names(qw/Controller C/);
724 Returns the available names which can be passed to $c->model
730 return $c->_comp_names(qw/Model M/);
736 Returns the available names which can be passed to $c->view
742 return $c->_comp_names(qw/View V/);
745 =head2 $c->comp($name)
747 =head2 $c->component($name)
749 Gets a component object by name. This method is not recommended,
750 unless you want to get a specific component by full
751 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
752 should be used instead.
754 If C<$name> is a regexp, a list of components matched against the full
755 component name will be returned.
760 my ( $c, $name, @args ) = @_;
763 my $comps = $c->components;
766 # is it the exact name?
767 return $c->_filter_component( $comps->{ $name }, @args )
768 if exists $comps->{ $name };
770 # perhaps we just omitted "MyApp"?
771 my $composed = ( ref $c || $c ) . "::${name}";
772 return $c->_filter_component( $comps->{ $composed }, @args )
773 if exists $comps->{ $composed };
775 # search all of the models, views and controllers
776 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
777 return $c->_filter_component( $comp, @args ) if $comp;
780 # This is here so $c->comp( '::M::' ) works
781 my $query = ref $name ? $name : qr{$name}i;
783 my @result = grep { m{$query} } keys %{ $c->components };
784 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
787 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
788 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
789 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
790 return $c->_filter_component( $result[ 0 ], @args );
793 # I would expect to return an empty list here, but that breaks back-compat
797 return sort keys %{ $c->components };
800 =head2 CLASS DATA AND HELPER CLASSES
804 Returns or takes a hashref containing the application's configuration.
806 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
808 You can also use a C<YAML>, C<XML> or C<Config::General> config file
809 like myapp.conf in your applications home directory. See
810 L<Catalyst::Plugin::ConfigLoader>.
812 =head3 Cascading configuration.
814 The config method is present on all Catalyst components, and configuration
815 will be merged when an application is started. Configuration loaded with
816 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
817 followed by configuration in your top level C<MyApp> class. These two
818 configurations are merged, and then configuration data whos hash key matches a
819 component name is merged with configuration for that component.
821 The configuration for a component is then passed to the C<new> method when a
822 component is constructed.
826 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
827 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
829 will mean that C<MyApp::Model::Foo> receives the following data when
832 MyApp::Model::Foo->new({
840 around config => sub {
844 croak('Setting config after setup has been run is not allowed.')
845 if ( @_ and $c->setup_finished );
852 Returns the logging object instance. Unless it is already set, Catalyst
853 sets this up with a L<Catalyst::Log> object. To use your own log class,
854 set the logger with the C<< __PACKAGE__->log >> method prior to calling
855 C<< __PACKAGE__->setup >>.
857 __PACKAGE__->log( MyLogger->new );
862 $c->log->info( 'Now logging with my own logger!' );
864 Your log class should implement the methods described in
870 Returns 1 if debug mode is enabled, 0 otherwise.
872 You can enable debug mode in several ways:
876 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
878 =item The -Debug option in your MyApp.pm
880 =item By declaring "sub debug { 1 }" in your MyApp.pm.
884 Calling $c->debug(1) has no effect.
890 =head2 $c->dispatcher
892 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
896 Returns the engine instance. See L<Catalyst::Engine>.
899 =head2 UTILITY METHODS
901 =head2 $c->path_to(@path)
903 Merges C<@path> with C<< $c->config->{home} >> and returns a
904 L<Path::Class::Dir> object.
908 $c->path_to( 'db', 'sqlite.db' );
913 my ( $c, @path ) = @_;
914 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
915 if ( -d $path ) { return $path }
916 else { return Path::Class::File->new( $c->config->{home}, @path ) }
919 =head2 $c->plugin( $name, $class, @args )
921 Helper method for plugins. It creates a class data accessor/mutator and
922 loads and instantiates the given class.
924 MyApp->plugin( 'prototype', 'HTML::Prototype' );
926 $c->prototype->define_javascript_functions;
928 B<Note:> This method of adding plugins is deprecated. The ability
929 to add plugins like this B<will be removed> in a Catalyst 5.81.
930 Please do not use this functionality in new code.
935 my ( $class, $name, $plugin, @args ) = @_;
937 # See block comment in t/unit_core_plugin.t
938 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
940 $class->_register_plugin( $plugin, 1 );
942 eval { $plugin->import };
943 $class->mk_classdata($name);
945 eval { $obj = $plugin->new(@args) };
948 Catalyst::Exception->throw( message =>
949 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
953 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
959 Initializes the dispatcher and engine, loads any plugins, and loads the
960 model, view, and controller components. You may also specify an array
961 of plugins to load here, if you choose to not load them in the C<use
965 MyApp->setup( qw/-Debug/ );
970 my ( $class, @arguments ) = @_;
971 croak('Running setup more than once')
972 if ( $class->setup_finished );
974 unless ( $class->isa('Catalyst') ) {
976 Catalyst::Exception->throw(
977 message => qq/'$class' does not inherit from Catalyst/ );
980 if ( $class->arguments ) {
981 @arguments = ( @arguments, @{ $class->arguments } );
987 foreach (@arguments) {
991 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
993 elsif (/^-(\w+)=?(.*)$/) {
994 $flags->{ lc $1 } = $2;
997 push @{ $flags->{plugins} }, $_;
1001 $class->setup_home( delete $flags->{home} );
1003 $class->setup_log( delete $flags->{log} );
1004 $class->setup_plugins( delete $flags->{plugins} );
1005 $class->setup_dispatcher( delete $flags->{dispatcher} );
1006 $class->setup_engine( delete $flags->{engine} );
1007 $class->setup_stats( delete $flags->{stats} );
1009 for my $flag ( sort keys %{$flags} ) {
1011 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1012 &$code( $class, delete $flags->{$flag} );
1015 $class->log->warn(qq/Unknown flag "$flag"/);
1019 eval { require Catalyst::Devel; };
1020 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1021 $class->log->warn(<<"EOF");
1022 You are running an old script!
1024 Please update by running (this will overwrite existing files):
1025 catalyst.pl -force -scripts $class
1027 or (this will not overwrite existing files):
1028 catalyst.pl -scripts $class
1033 if ( $class->debug ) {
1034 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1037 my $column_width = Catalyst::Utils::term_width() - 6;
1038 my $t = Text::SimpleTable->new($column_width);
1039 $t->row($_) for @plugins;
1040 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1043 my $dispatcher = $class->dispatcher;
1044 my $engine = $class->engine;
1045 my $home = $class->config->{home};
1047 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1048 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1052 ? $class->log->debug(qq/Found home "$home"/)
1053 : $class->log->debug(qq/Home "$home" doesn't exist/)
1054 : $class->log->debug(q/Couldn't find home/);
1057 # Call plugins setup, this is stupid and evil.
1059 no warnings qw/redefine/;
1060 local *setup = sub { };
1064 # Initialize our data structure
1065 $class->components( {} );
1067 $class->setup_components;
1069 if ( $class->debug ) {
1070 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1071 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1072 for my $comp ( sort keys %{ $class->components } ) {
1073 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1074 $t->row( $comp, $type );
1076 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1077 if ( keys %{ $class->components } );
1080 # Add our self to components, since we are also a component
1081 if( $class->isa('Catalyst::Controller') ){
1082 $class->components->{$class} = $class;
1085 $class->setup_actions;
1087 if ( $class->debug ) {
1088 my $name = $class->config->{name} || 'Application';
1089 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1091 $class->log->_flush() if $class->log->can('_flush');
1093 # Make sure that the application class becomes immutable at this point,
1094 # which ensures that it gets an inlined constructor. This means that it
1095 # works even if the user has added a plugin which contains a new method.
1096 # Note however that we have to do the work on scope end, so that method
1097 # modifiers work correctly in MyApp (as you have to call setup _before_
1098 # applying modifiers).
1099 Scope::Upper::reap(sub {
1100 my $meta = Class::MOP::get_metaclass_by_name($class);
1101 $meta->make_immutable unless $meta->is_immutable;
1102 }, Scope::Upper::SCOPE(1));
1104 $class->setup_finalize;
1108 =head2 $app->setup_finalize
1110 A hook to attach modifiers to.
1111 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1112 Also better than C< setup_finished(); >, as that is a getter method.
1114 sub setup_finalize {
1118 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1120 $app->next::method(@_);
1127 sub setup_finalize {
1129 $class->setup_finished(1);
1132 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1134 =head2 $c->uri_for( $path, @args?, \%query_values? )
1140 A Catalyst::Action object representing the Catalyst action you want to
1141 create a URI for. To get one for an action in the current controller,
1142 use C<< $c->action('someactionname') >>. To get one from different
1143 controller, fetch the controller using C<< $c->controller() >>, then
1144 call C<action_for> on it.
1146 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1147 using C<< $c->req->captures >>.
1149 # For the current action
1150 $c->uri_for($c->action, $c->req->captures);
1152 # For the Foo action in the Bar controller
1153 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1160 my ( $c, $path, @args ) = @_;
1162 if ( blessed($path) ) { # action object
1163 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1167 $path = $c->dispatcher->uri_for_action($action, $captures);
1168 if (not defined $path) {
1169 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1173 $path = '/' if $path eq '';
1176 undef($path) if (defined $path && $path eq '');
1179 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1181 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1182 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1184 unshift(@args, $path);
1186 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1187 my $namespace = $c->namespace;
1188 if (defined $path) { # cheesy hack to handle path '../foo'
1189 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1191 unshift(@args, $namespace || '');
1194 # join args with '/', or a blank string
1195 my $args = join('/', grep { defined($_) } @args);
1196 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1198 my $base = $c->req->base;
1199 my $class = ref($base);
1200 $base =~ s{(?<!/)$}{/};
1204 if (my @keys = keys %$params) {
1205 # somewhat lifted from URI::_query's query_form
1206 $query = '?'.join('&', map {
1207 my $val = $params->{$_};
1208 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1211 $val = '' unless defined $val;
1214 utf8::encode( $_ ) if utf8::is_utf8($_);
1215 # using the URI::Escape pattern here so utf8 chars survive
1216 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1218 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1222 my $res = bless(\"${base}${args}${query}", $class);
1226 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1228 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1234 A private path to the Catalyst action you want to create a URI for.
1236 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1237 >> and passing the resulting C<$action> and the remaining arguments to C<<
1240 You can also pass in a Catalyst::Action object, in which case it is passed to
1247 sub uri_for_action {
1248 my ( $c, $path, @args ) = @_;
1249 my $action = blessed($path)
1251 : $c->dispatcher->get_action_by_path($path);
1252 unless (defined $action) {
1253 croak "Can't find action for path '$path'";
1255 return $c->uri_for( $action, @args );
1258 =head2 $c->welcome_message
1260 Returns the Catalyst welcome HTML page.
1264 sub welcome_message {
1266 my $name = $c->config->{name};
1267 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1268 my $prefix = Catalyst::Utils::appprefix( ref $c );
1269 $c->response->content_type('text/html; charset=utf-8');
1271 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1272 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1273 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1275 <meta http-equiv="Content-Language" content="en" />
1276 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1277 <title>$name on Catalyst $VERSION</title>
1278 <style type="text/css">
1281 background-color: #eee;
1288 margin-bottom: 10px;
1290 background-color: #ccc;
1291 border: 1px solid #aaa;
1296 font-family: verdana, tahoma, sans-serif;
1299 font-family: verdana, tahoma, sans-serif;
1302 text-decoration: none;
1304 border-bottom: 1px dotted #bbb;
1306 :link:hover, :visited:hover {
1319 background-color: #fff;
1320 border: 1px solid #aaa;
1324 font-weight: normal;
1346 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1351 <img src="$logo" alt="Catalyst Logo" />
1353 <p>Welcome to the world of Catalyst.
1354 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1355 framework will make web development something you had
1356 never expected it to be: Fun, rewarding, and quick.</p>
1357 <h2>What to do now?</h2>
1358 <p>That really depends on what <b>you</b> want to do.
1359 We do, however, provide you with a few starting points.</p>
1360 <p>If you want to jump right into web development with Catalyst
1361 you might want to start with a tutorial.</p>
1362 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1364 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1366 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1367 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1369 <h2>What to do next?</h2>
1370 <p>Next it's time to write an actual application. Use the
1371 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1372 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1373 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1374 they can save you a lot of work.</p>
1375 <pre><code>script/${prefix}_create.pl -help</code></pre>
1376 <p>Also, be sure to check out the vast and growing
1377 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1378 you are likely to find what you need there.
1382 <p>Catalyst has a very active community. Here are the main places to
1383 get in touch with us.</p>
1386 <a href="http://dev.catalyst.perl.org">Wiki</a>
1389 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1392 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1395 <h2>In conclusion</h2>
1396 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1397 as we enjoyed making it. Please contact us if you have ideas
1398 for improvement or other feedback.</p>
1406 =head1 INTERNAL METHODS
1408 These methods are not meant to be used by end users.
1410 =head2 $c->components
1412 Returns a hash of components.
1414 =head2 $c->context_class
1416 Returns or sets the context class.
1420 Returns a hashref containing coderefs and execution counts (needed for
1421 deep recursion detection).
1425 Returns the number of actions on the current internal execution stack.
1429 Dispatches a request to actions.
1433 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1435 =head2 $c->dispatcher_class
1437 Returns or sets the dispatcher class.
1439 =head2 $c->dump_these
1441 Returns a list of 2-element array references (name, structure) pairs
1442 that will be dumped on the error page in debug mode.
1448 [ Request => $c->req ],
1449 [ Response => $c->res ],
1450 [ Stash => $c->stash ],
1451 [ Config => $c->config ];
1454 =head2 $c->engine_class
1456 Returns or sets the engine class.
1458 =head2 $c->execute( $class, $coderef )
1460 Execute a coderef in given class and catch exceptions. Errors are available
1466 my ( $c, $class, $code ) = @_;
1467 $class = $c->component($class) || $class;
1470 if ( $c->depth >= $RECURSION ) {
1471 my $action = $code->reverse();
1472 $action = "/$action" unless $action =~ /->/;
1473 my $error = qq/Deep recursion detected calling "${action}"/;
1474 $c->log->error($error);
1480 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1482 push( @{ $c->stack }, $code );
1484 no warnings 'recursion';
1485 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1487 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1489 my $last = pop( @{ $c->stack } );
1491 if ( my $error = $@ ) {
1492 if ( !ref($error) and $error eq $DETACH ) {
1493 die $DETACH if($c->depth > 1);
1495 elsif ( !ref($error) and $error eq $GO ) {
1496 die $GO if($c->depth > 0);
1499 unless ( ref $error ) {
1500 no warnings 'uninitialized';
1502 my $class = $last->class;
1503 my $name = $last->name;
1504 $error = qq/Caught exception in $class->$name "$error"/;
1513 sub _stats_start_execute {
1514 my ( $c, $code ) = @_;
1516 return if ( ( $code->name =~ /^_.*/ )
1517 && ( !$c->config->{show_internal_actions} ) );
1519 my $action_name = $code->reverse();
1520 $c->counter->{$action_name}++;
1522 my $action = $action_name;
1523 $action = "/$action" unless $action =~ /->/;
1525 # determine if the call was the result of a forward
1526 # this is done by walking up the call stack and looking for a calling
1527 # sub of Catalyst::forward before the eval
1529 for my $index ( 2 .. 11 ) {
1531 if ( ( caller($index) )[0] eq 'Catalyst'
1532 && ( caller($index) )[3] eq '(eval)' );
1534 if ( ( caller($index) )[3] =~ /forward$/ ) {
1535 $callsub = ( caller($index) )[3];
1536 $action = "-> $action";
1541 my $uid = $action_name . $c->counter->{$action_name};
1543 # is this a root-level call or a forwarded call?
1544 if ( $callsub =~ /forward$/ ) {
1546 # forward, locate the caller
1547 if ( my $parent = $c->stack->[-1] ) {
1550 parent => "$parent" . $c->counter->{"$parent"},
1556 # forward with no caller may come from a plugin
1575 sub _stats_finish_execute {
1576 my ( $c, $info ) = @_;
1577 $c->stats->profile( end => $info );
1580 =head2 $c->_localize_fields( sub { }, \%keys );
1584 #Why does this exist? This is no longer safe and WILL NOT WORK.
1585 # it doesnt seem to be used anywhere. can we remove it?
1586 sub _localize_fields {
1587 my ( $c, $localized, $code ) = ( @_ );
1589 my $request = delete $localized->{request} || {};
1590 my $response = delete $localized->{response} || {};
1592 local @{ $c }{ keys %$localized } = values %$localized;
1593 local @{ $c->request }{ keys %$request } = values %$request;
1594 local @{ $c->response }{ keys %$response } = values %$response;
1601 Finalizes the request.
1608 for my $error ( @{ $c->error } ) {
1609 $c->log->error($error);
1612 # Allow engine to handle finalize flow (for POE)
1613 my $engine = $c->engine;
1614 if ( my $code = $engine->can('finalize') ) {
1619 $c->finalize_uploads;
1622 if ( $#{ $c->error } >= 0 ) {
1626 $c->finalize_headers;
1629 if ( $c->request->method eq 'HEAD' ) {
1630 $c->response->body('');
1636 if ($c->use_stats) {
1637 my $elapsed = sprintf '%f', $c->stats->elapsed;
1638 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1640 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1643 return $c->response->status;
1646 =head2 $c->finalize_body
1652 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1654 =head2 $c->finalize_cookies
1660 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1662 =head2 $c->finalize_error
1668 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1670 =head2 $c->finalize_headers
1676 sub finalize_headers {
1679 my $response = $c->response; #accessor calls can add up?
1681 # Check if we already finalized headers
1682 return if $response->finalized_headers;
1685 if ( my $location = $response->redirect ) {
1686 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1687 $response->header( Location => $location );
1689 if ( !$response->has_body ) {
1690 # Add a default body if none is already present
1692 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1698 if ( $response->body && !$response->content_length ) {
1700 # get the length from a filehandle
1701 if ( blessed( $response->body ) && $response->body->can('read') )
1703 my $stat = stat $response->body;
1704 if ( $stat && $stat->size > 0 ) {
1705 $response->content_length( $stat->size );
1708 $c->log->warn('Serving filehandle without a content-length');
1712 # everything should be bytes at this point, but just in case
1713 $response->content_length( bytes::length( $response->body ) );
1718 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1719 $response->headers->remove_header("Content-Length");
1720 $response->body('');
1723 $c->finalize_cookies;
1725 $c->engine->finalize_headers( $c, @_ );
1728 $response->finalized_headers(1);
1731 =head2 $c->finalize_output
1733 An alias for finalize_body.
1735 =head2 $c->finalize_read
1737 Finalizes the input after reading is complete.
1741 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1743 =head2 $c->finalize_uploads
1745 Finalizes uploads. Cleans up any temporary files.
1749 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1751 =head2 $c->get_action( $action, $namespace )
1753 Gets an action in a given namespace.
1757 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1759 =head2 $c->get_actions( $action, $namespace )
1761 Gets all actions of a given name in a namespace and all parent
1766 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1768 =head2 $c->handle_request( $class, @arguments )
1770 Called to handle each HTTP request.
1774 sub handle_request {
1775 my ( $class, @arguments ) = @_;
1777 # Always expect worst case!
1780 if ($class->debug) {
1781 my $secs = time - $START || 1;
1782 my $av = sprintf '%.3f', $COUNT / $secs;
1783 my $time = localtime time;
1784 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1787 my $c = $class->prepare(@arguments);
1789 $status = $c->finalize;
1792 if ( my $error = $@ ) {
1794 $class->log->error(qq/Caught exception in engine "$error"/);
1799 if(my $coderef = $class->log->can('_flush')){
1800 $class->log->$coderef();
1805 =head2 $c->prepare( @arguments )
1807 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1813 my ( $class, @arguments ) = @_;
1816 # After the app/ctxt split, this should become an attribute based on something passed
1817 # into the application.
1818 $class->context_class( ref $class || $class ) unless $class->context_class;
1820 my $c = $class->context_class->new({});
1822 # For on-demand data
1823 $c->request->_context($c);
1824 $c->response->_context($c);
1826 #surely this is not the most efficient way to do things...
1827 $c->stats($class->stats_class->new)->enable($c->use_stats);
1829 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1832 #XXX reuse coderef from can
1833 # Allow engine to direct the prepare flow (for POE)
1834 if ( $c->engine->can('prepare') ) {
1835 $c->engine->prepare( $c, @arguments );
1838 $c->prepare_request(@arguments);
1839 $c->prepare_connection;
1840 $c->prepare_query_parameters;
1841 $c->prepare_headers;
1842 $c->prepare_cookies;
1845 # Prepare the body for reading, either by prepare_body
1846 # or the user, if they are using $c->read
1849 # Parse the body unless the user wants it on-demand
1850 unless ( $c->config->{parse_on_demand} ) {
1855 my $method = $c->req->method || '';
1856 my $path = $c->req->path;
1857 $path = '/' unless length $path;
1858 my $address = $c->req->address || '';
1860 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1868 =head2 $c->prepare_action
1870 Prepares action. See L<Catalyst::Dispatcher>.
1874 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1876 =head2 $c->prepare_body
1878 Prepares message body.
1885 return if $c->request->_has_body;
1887 # Initialize on-demand data
1888 $c->engine->prepare_body( $c, @_ );
1889 $c->prepare_parameters;
1890 $c->prepare_uploads;
1892 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1893 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1894 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1895 my $param = $c->req->body_parameters->{$key};
1896 my $value = defined($param) ? $param : '';
1898 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1900 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1904 =head2 $c->prepare_body_chunk( $chunk )
1906 Prepares a chunk of data before sending it to L<HTTP::Body>.
1908 See L<Catalyst::Engine>.
1912 sub prepare_body_chunk {
1914 $c->engine->prepare_body_chunk( $c, @_ );
1917 =head2 $c->prepare_body_parameters
1919 Prepares body parameters.
1923 sub prepare_body_parameters {
1925 $c->engine->prepare_body_parameters( $c, @_ );
1928 =head2 $c->prepare_connection
1930 Prepares connection.
1934 sub prepare_connection {
1936 $c->engine->prepare_connection( $c, @_ );
1939 =head2 $c->prepare_cookies
1945 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1947 =head2 $c->prepare_headers
1953 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1955 =head2 $c->prepare_parameters
1957 Prepares parameters.
1961 sub prepare_parameters {
1963 $c->prepare_body_parameters;
1964 $c->engine->prepare_parameters( $c, @_ );
1967 =head2 $c->prepare_path
1969 Prepares path and base.
1973 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1975 =head2 $c->prepare_query_parameters
1977 Prepares query parameters.
1981 sub prepare_query_parameters {
1984 $c->engine->prepare_query_parameters( $c, @_ );
1986 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1987 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1988 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1989 my $param = $c->req->query_parameters->{$key};
1990 my $value = defined($param) ? $param : '';
1992 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1994 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1998 =head2 $c->prepare_read
2000 Prepares the input for reading.
2004 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2006 =head2 $c->prepare_request
2008 Prepares the engine request.
2012 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2014 =head2 $c->prepare_uploads
2020 sub prepare_uploads {
2023 $c->engine->prepare_uploads( $c, @_ );
2025 if ( $c->debug && keys %{ $c->request->uploads } ) {
2026 my $t = Text::SimpleTable->new(
2027 [ 12, 'Parameter' ],
2032 for my $key ( sort keys %{ $c->request->uploads } ) {
2033 my $upload = $c->request->uploads->{$key};
2034 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2035 $t->row( $key, $u->filename, $u->type, $u->size );
2038 $c->log->debug( "File Uploads are:\n" . $t->draw );
2042 =head2 $c->prepare_write
2044 Prepares the output for writing.
2048 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2050 =head2 $c->request_class
2052 Returns or sets the request class.
2054 =head2 $c->response_class
2056 Returns or sets the response class.
2058 =head2 $c->read( [$maxlength] )
2060 Reads a chunk of data from the request body. This method is designed to
2061 be used in a while loop, reading C<$maxlength> bytes on every call.
2062 C<$maxlength> defaults to the size of the request if not specified.
2064 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2067 Warning: If you use read(), Catalyst will not process the body,
2068 so you will not be able to access POST parameters or file uploads via
2069 $c->request. You must handle all body parsing yourself.
2073 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2081 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2083 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2085 Sets an action in a given namespace.
2089 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2091 =head2 $c->setup_actions($component)
2093 Sets up actions for a component.
2097 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2099 =head2 $c->setup_components
2101 Sets up components. Specify a C<setup_components> config option to pass
2102 additional options directly to L<Module::Pluggable>. To add additional
2103 search paths, specify a key named C<search_extra> as an array
2104 reference. Items in the array beginning with C<::> will have the
2105 application class name prepended to them.
2107 All components found will also have any
2108 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2109 Note, that modules which are B<not> an I<inner package> of the main
2110 file namespace loaded will not be instantiated as components.
2114 sub setup_components {
2117 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2118 my $config = $class->config->{ setup_components };
2119 my $extra = delete $config->{ search_extra } || [];
2121 push @paths, @$extra;
2123 my $locator = Module::Pluggable::Object->new(
2124 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2128 my @comps = sort { length $a <=> length $b } $locator->plugins;
2129 my %comps = map { $_ => 1 } @comps;
2131 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2132 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2133 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2134 ) if $deprecated_component_names;
2136 for my $component ( @comps ) {
2138 # We pass ignore_loaded here so that overlay files for (e.g.)
2139 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2140 # we know M::P::O found a file on disk so this is safe
2142 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2143 #Class::MOP::load_class($component);
2145 my $module = $class->setup_component( $component );
2147 $component => $module,
2149 $_ => $class->setup_component( $_ )
2151 not exists $comps{$_}
2152 } Devel::InnerPackage::list_packages( $component )
2155 for my $key ( keys %modules ) {
2156 $class->components->{ $key } = $modules{ $key };
2161 =head2 $c->setup_component
2165 sub _controller_init_base_classes {
2166 my ($class, $component) = @_;
2167 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2168 Moose->init_meta( for_class => $class )
2169 unless find_meta($class);
2173 sub setup_component {
2174 my( $class, $component ) = @_;
2176 unless ( $component->can( 'COMPONENT' ) ) {
2180 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2181 # nearest to Catalyst::Controller first, no matter what order stuff happens
2182 # to be loaded. There are TODO tests in Moose for this, see
2183 # f2391d17574eff81d911b97be15ea51080500003
2184 if ($component->isa('Catalyst::Controller')) {
2185 $class->_controller_init_base_classes($component);
2188 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2189 my $config = $class->config->{ $suffix } || {};
2191 my $instance = eval { $component->COMPONENT( $class, $config ); };
2193 if ( my $error = $@ ) {
2195 Catalyst::Exception->throw(
2196 message => qq/Couldn't instantiate component "$component", "$error"/
2200 unless (blessed $instance) {
2201 my $metaclass = Moose::Util::find_meta($component);
2202 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2203 my $component_method_from = $method_meta->associated_metaclass->name;
2204 my $value = defined($instance) ? $instance : 'undef';
2205 Catalyst::Exception->throw(
2207 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2213 =head2 $c->setup_dispatcher
2219 sub setup_dispatcher {
2220 my ( $class, $dispatcher ) = @_;
2223 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2226 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2227 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2230 unless ($dispatcher) {
2231 $dispatcher = $class->dispatcher_class;
2234 Class::MOP::load_class($dispatcher);
2236 # dispatcher instance
2237 $class->dispatcher( $dispatcher->new );
2240 =head2 $c->setup_engine
2247 my ( $class, $engine ) = @_;
2250 $engine = 'Catalyst::Engine::' . $engine;
2253 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2254 $engine = 'Catalyst::Engine::' . $env;
2257 if ( $ENV{MOD_PERL} ) {
2258 my $meta = Class::MOP::get_metaclass_by_name($class);
2260 # create the apache method
2261 $meta->add_method('apache' => sub { shift->engine->apache });
2263 my ( $software, $version ) =
2264 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2267 $version =~ s/(\.[^.]+)\./$1/g;
2269 if ( $software eq 'mod_perl' ) {
2273 if ( $version >= 1.99922 ) {
2274 $engine = 'Catalyst::Engine::Apache2::MP20';
2277 elsif ( $version >= 1.9901 ) {
2278 $engine = 'Catalyst::Engine::Apache2::MP19';
2281 elsif ( $version >= 1.24 ) {
2282 $engine = 'Catalyst::Engine::Apache::MP13';
2286 Catalyst::Exception->throw( message =>
2287 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2292 # install the correct mod_perl handler
2293 if ( $version >= 1.9901 ) {
2294 *handler = sub : method {
2295 shift->handle_request(@_);
2299 *handler = sub ($$) { shift->handle_request(@_) };
2304 elsif ( $software eq 'Zeus-Perl' ) {
2305 $engine = 'Catalyst::Engine::Zeus';
2309 Catalyst::Exception->throw(
2310 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2315 $engine = $class->engine_class;
2318 Class::MOP::load_class($engine);
2320 # check for old engines that are no longer compatible
2322 if ( $engine->isa('Catalyst::Engine::Apache')
2323 && !Catalyst::Engine::Apache->VERSION )
2328 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2329 && Catalyst::Engine::Server->VERSION le '0.02' )
2334 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2335 && $engine->VERSION eq '0.01' )
2340 elsif ($engine->isa('Catalyst::Engine::Zeus')
2341 && $engine->VERSION eq '0.01' )
2347 Catalyst::Exception->throw( message =>
2348 qq/Engine "$engine" is not supported by this version of Catalyst/
2353 $class->engine( $engine->new );
2356 =head2 $c->setup_home
2358 Sets up the home directory.
2363 my ( $class, $home ) = @_;
2365 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2369 $home ||= Catalyst::Utils::home($class);
2372 #I remember recently being scolded for assigning config values like this
2373 $class->config->{home} ||= $home;
2374 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2378 =head2 $c->setup_log
2380 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2381 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2384 This method also installs a C<debug> method that returns a true value into the
2385 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2386 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2388 Note that if the log has already been setup, by either a previous call to
2389 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2390 that this method won't actually set up the log object.
2395 my ( $class, $levels ) = @_;
2398 $levels =~ s/^\s+//;
2399 $levels =~ s/\s+$//;
2400 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels || '';
2402 unless ( $class->log ) {
2403 $class->log( Catalyst::Log->new(keys %levels) );
2406 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2407 if ( defined($env_debug) or $levels{debug} ) {
2408 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2409 $class->log->debug('Debug messages enabled');
2413 =head2 $c->setup_plugins
2419 =head2 $c->setup_stats
2421 Sets up timing statistics class.
2426 my ( $class, $stats ) = @_;
2428 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2430 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2431 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2432 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2433 $class->log->debug('Statistics enabled');
2438 =head2 $c->registered_plugins
2440 Returns a sorted list of the plugins which have either been stated in the
2441 import list or which have been added via C<< MyApp->plugin(@args); >>.
2443 If passed a given plugin name, it will report a boolean value indicating
2444 whether or not that plugin is loaded. A fully qualified name is required if
2445 the plugin name does not begin with C<Catalyst::Plugin::>.
2447 if ($c->registered_plugins('Some::Plugin')) {
2455 sub registered_plugins {
2457 return sort keys %{ $proto->_plugins } unless @_;
2459 return 1 if exists $proto->_plugins->{$plugin};
2460 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2463 sub _register_plugin {
2464 my ( $proto, $plugin, $instant ) = @_;
2465 my $class = ref $proto || $proto;
2467 # no ignore_loaded here, the plugin may already have been
2468 # defined in memory and we don't want to error on "no file" if so
2470 Class::MOP::load_class( $plugin );
2472 $proto->_plugins->{$plugin} = 1;
2475 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2476 my @superclasses = ($plugin, $meta->superclasses );
2477 $meta->superclasses(@superclasses);
2479 unshift @{"$class\::ISA"}, $plugin;
2486 my ( $class, $plugins ) = @_;
2488 $class->_plugins( {} ) unless $class->_plugins;
2490 for my $plugin ( reverse @$plugins ) {
2492 unless ( $plugin =~ s/\A\+// ) {
2493 $plugin = "Catalyst::Plugin::$plugin";
2496 $class->_register_plugin($plugin);
2503 Returns an arrayref of the internal execution stack (actions that are
2504 currently executing).
2506 =head2 $c->stats_class
2508 Returns or sets the stats (timing statistics) class.
2510 =head2 $c->use_stats
2512 Returns 1 when stats collection is enabled. Stats collection is enabled
2513 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2514 environment variable is set.
2516 Note that this is a static method, not an accessor and should be overloaded
2517 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2524 =head2 $c->write( $data )
2526 Writes $data to the output stream. When using this method directly, you
2527 will need to manually set the C<Content-Length> header to the length of
2528 your output data, if known.
2535 # Finalize headers if someone manually writes output
2536 $c->finalize_headers;
2538 return $c->engine->write( $c, @_ );
2543 Returns the Catalyst version number. Mostly useful for "powered by"
2544 messages in template systems.
2548 sub version { return $Catalyst::VERSION }
2550 =head1 INTERNAL ACTIONS
2552 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2553 C<_ACTION>, and C<_END>. These are by default not shown in the private
2554 action table, but you can make them visible with a config parameter.
2556 MyApp->config->{show_internal_actions} = 1;
2558 =head1 CASE SENSITIVITY
2560 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2561 mapped to C</foo/bar>. You can activate case sensitivity with a config
2564 MyApp->config->{case_sensitive} = 1;
2566 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2568 =head1 ON-DEMAND PARSER
2570 The request body is usually parsed at the beginning of a request,
2571 but if you want to handle input yourself, you can enable on-demand
2572 parsing with a config parameter.
2574 MyApp->config->{parse_on_demand} = 1;
2576 =head1 PROXY SUPPORT
2578 Many production servers operate using the common double-server approach,
2579 with a lightweight frontend web server passing requests to a larger
2580 backend server. An application running on the backend server must deal
2581 with two problems: the remote user always appears to be C<127.0.0.1> and
2582 the server's hostname will appear to be C<localhost> regardless of the
2583 virtual host that the user connected through.
2585 Catalyst will automatically detect this situation when you are running
2586 the frontend and backend servers on the same machine. The following
2587 changes are made to the request.
2589 $c->req->address is set to the user's real IP address, as read from
2590 the HTTP X-Forwarded-For header.
2592 The host value for $c->req->base and $c->req->uri is set to the real
2593 host, as read from the HTTP X-Forwarded-Host header.
2595 Obviously, your web server must support these headers for this to work.
2597 In a more complex server farm environment where you may have your
2598 frontend proxy server(s) on different machines, you will need to set a
2599 configuration option to tell Catalyst to read the proxied data from the
2602 MyApp->config->{using_frontend_proxy} = 1;
2604 If you do not wish to use the proxy support at all, you may set:
2606 MyApp->config->{ignore_frontend_proxy} = 1;
2608 =head1 THREAD SAFETY
2610 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2611 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2612 believe the Catalyst core to be thread-safe.
2614 If you plan to operate in a threaded environment, remember that all other
2615 modules you are using must also be thread-safe. Some modules, most notably
2616 L<DBD::SQLite>, are not thread-safe.
2622 Join #catalyst on irc.perl.org.
2626 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2627 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2631 http://catalyst.perl.org
2635 http://dev.catalyst.perl.org
2639 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2641 =head2 L<Catalyst::Manual> - The Catalyst Manual
2643 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2645 =head2 L<Catalyst::Engine> - Core engine
2647 =head2 L<Catalyst::Log> - Log class.
2649 =head2 L<Catalyst::Request> - Request object
2651 =head2 L<Catalyst::Response> - Response object
2653 =head2 L<Catalyst::Test> - The test suite.
2655 =head1 PROJECT FOUNDER
2657 sri: Sebastian Riedel <sri@cpan.org>
2663 acme: Leon Brocard <leon@astray.com>
2671 andyg: Andy Grundman <andy@hybridized.org>
2673 audreyt: Audrey Tang
2675 bricas: Brian Cassidy <bricas@cpan.org>
2677 Caelum: Rafael Kitover <rkitover@io.com>
2679 chansen: Christian Hansen
2681 chicks: Christopher Hicks
2685 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2689 esskar: Sascha Kiefer
2691 fireartist: Carl Franks <cfranks@cpan.org>
2693 gabb: Danijel Milicevic
2699 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2701 jcamacho: Juan Camacho
2703 jhannah: Jay Hannah <jay@jays.net>
2709 jon: Jon Schutz <jjschutz@cpan.org>
2711 marcus: Marcus Ramberg <mramberg@cpan.org>
2713 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2715 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2719 naughton: David Naughton
2721 ningu: David Kamholz <dkamholz@cpan.org>
2723 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2725 numa: Dan Sully <daniel@cpan.org>
2729 omega: Andreas Marienborg
2731 Oleg Kostyuk <cub.uanic@gmail.com>
2733 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2735 rafl: Florian Ragwitz <rafl@debian.org>
2739 the_jester: Jesse Sheidlower
2741 t0m: Tomas Doran <bobtfish@bobtfish.net>
2745 willert: Sebastian Willert <willert@cpan.org>
2749 This library is free software, you can redistribute it and/or modify it under
2750 the same terms as Perl itself.
2756 __PACKAGE__->meta->make_immutable;