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.80002';
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 whose 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 By calling myapp_server.pl with the -d flag
878 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
880 =item The -Debug option in your MyApp.pm
882 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
886 Calling C<< $c->debug(1) >> has no effect.
892 =head2 $c->dispatcher
894 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
898 Returns the engine instance. See L<Catalyst::Engine>.
901 =head2 UTILITY METHODS
903 =head2 $c->path_to(@path)
905 Merges C<@path> with C<< $c->config->{home} >> and returns a
906 L<Path::Class::Dir> object.
910 $c->path_to( 'db', 'sqlite.db' );
915 my ( $c, @path ) = @_;
916 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
917 if ( -d $path ) { return $path }
918 else { return Path::Class::File->new( $c->config->{home}, @path ) }
921 =head2 $c->plugin( $name, $class, @args )
923 Helper method for plugins. It creates a class data accessor/mutator and
924 loads and instantiates the given class.
926 MyApp->plugin( 'prototype', 'HTML::Prototype' );
928 $c->prototype->define_javascript_functions;
930 B<Note:> This method of adding plugins is deprecated. The ability
931 to add plugins like this B<will be removed> in a Catalyst 5.81.
932 Please do not use this functionality in new code.
937 my ( $class, $name, $plugin, @args ) = @_;
939 # See block comment in t/unit_core_plugin.t
940 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
942 $class->_register_plugin( $plugin, 1 );
944 eval { $plugin->import };
945 $class->mk_classdata($name);
947 eval { $obj = $plugin->new(@args) };
950 Catalyst::Exception->throw( message =>
951 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
955 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
961 Initializes the dispatcher and engine, loads any plugins, and loads the
962 model, view, and controller components. You may also specify an array
963 of plugins to load here, if you choose to not load them in the C<use
967 MyApp->setup( qw/-Debug/ );
972 my ( $class, @arguments ) = @_;
973 croak('Running setup more than once')
974 if ( $class->setup_finished );
976 unless ( $class->isa('Catalyst') ) {
978 Catalyst::Exception->throw(
979 message => qq/'$class' does not inherit from Catalyst/ );
982 if ( $class->arguments ) {
983 @arguments = ( @arguments, @{ $class->arguments } );
989 foreach (@arguments) {
993 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
995 elsif (/^-(\w+)=?(.*)$/) {
996 $flags->{ lc $1 } = $2;
999 push @{ $flags->{plugins} }, $_;
1003 $class->setup_home( delete $flags->{home} );
1005 $class->setup_log( delete $flags->{log} );
1006 $class->setup_plugins( delete $flags->{plugins} );
1007 $class->setup_dispatcher( delete $flags->{dispatcher} );
1008 $class->setup_engine( delete $flags->{engine} );
1009 $class->setup_stats( delete $flags->{stats} );
1011 for my $flag ( sort keys %{$flags} ) {
1013 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1014 &$code( $class, delete $flags->{$flag} );
1017 $class->log->warn(qq/Unknown flag "$flag"/);
1021 eval { require Catalyst::Devel; };
1022 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1023 $class->log->warn(<<"EOF");
1024 You are running an old script!
1026 Please update by running (this will overwrite existing files):
1027 catalyst.pl -force -scripts $class
1029 or (this will not overwrite existing files):
1030 catalyst.pl -scripts $class
1035 if ( $class->debug ) {
1036 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1039 my $column_width = Catalyst::Utils::term_width() - 6;
1040 my $t = Text::SimpleTable->new($column_width);
1041 $t->row($_) for @plugins;
1042 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1045 my $dispatcher = $class->dispatcher;
1046 my $engine = $class->engine;
1047 my $home = $class->config->{home};
1049 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1050 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1054 ? $class->log->debug(qq/Found home "$home"/)
1055 : $class->log->debug(qq/Home "$home" doesn't exist/)
1056 : $class->log->debug(q/Couldn't find home/);
1059 # Call plugins setup, this is stupid and evil.
1060 # Also screws C3 badly on 5.10, hack to avoid.
1062 no warnings qw/redefine/;
1063 local *setup = sub { };
1064 $class->setup unless $Catalyst::__AM_RESTARTING;
1067 # Initialize our data structure
1068 $class->components( {} );
1070 $class->setup_components;
1072 if ( $class->debug ) {
1073 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1074 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1075 for my $comp ( sort keys %{ $class->components } ) {
1076 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1077 $t->row( $comp, $type );
1079 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1080 if ( keys %{ $class->components } );
1083 # Add our self to components, since we are also a component
1084 if( $class->isa('Catalyst::Controller') ){
1085 $class->components->{$class} = $class;
1088 $class->setup_actions;
1090 if ( $class->debug ) {
1091 my $name = $class->config->{name} || 'Application';
1092 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1094 $class->log->_flush() if $class->log->can('_flush');
1096 # Make sure that the application class becomes immutable at this point,
1097 # which ensures that it gets an inlined constructor. This means that it
1098 # works even if the user has added a plugin which contains a new method.
1099 # Note however that we have to do the work on scope end, so that method
1100 # modifiers work correctly in MyApp (as you have to call setup _before_
1101 # applying modifiers).
1102 Scope::Upper::reap(sub {
1103 my $meta = Class::MOP::get_metaclass_by_name($class);
1104 $meta->make_immutable(replace_constructor => 1) unless $meta->is_immutable;
1105 }, Scope::Upper::SCOPE(1));
1107 $class->setup_finalize;
1111 =head2 $app->setup_finalize
1113 A hook to attach modifiers to.
1114 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1115 Also better than C< setup_finished(); >, as that is a getter method.
1117 sub setup_finalize {
1121 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1123 $app->next::method(@_);
1130 sub setup_finalize {
1132 $class->setup_finished(1);
1135 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1137 =head2 $c->uri_for( $path, @args?, \%query_values? )
1143 A Catalyst::Action object representing the Catalyst action you want to
1144 create a URI for. To get one for an action in the current controller,
1145 use C<< $c->action('someactionname') >>. To get one from different
1146 controller, fetch the controller using C<< $c->controller() >>, then
1147 call C<action_for> on it.
1149 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1150 using C<< $c->req->captures >>.
1152 # For the current action
1153 $c->uri_for($c->action, $c->req->captures);
1155 # For the Foo action in the Bar controller
1156 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1163 my ( $c, $path, @args ) = @_;
1165 if ( blessed($path) ) { # action object
1166 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1170 $path = $c->dispatcher->uri_for_action($action, $captures);
1171 if (not defined $path) {
1172 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1176 $path = '/' if $path eq '';
1179 undef($path) if (defined $path && $path eq '');
1182 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1184 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1185 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1187 unshift(@args, $path);
1189 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1190 my $namespace = $c->namespace;
1191 if (defined $path) { # cheesy hack to handle path '../foo'
1192 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1194 unshift(@args, $namespace || '');
1197 # join args with '/', or a blank string
1198 my $args = join('/', grep { defined($_) } @args);
1199 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1201 my $base = $c->req->base;
1202 my $class = ref($base);
1203 $base =~ s{(?<!/)$}{/};
1207 if (my @keys = keys %$params) {
1208 # somewhat lifted from URI::_query's query_form
1209 $query = '?'.join('&', map {
1210 my $val = $params->{$_};
1211 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1214 $val = '' unless defined $val;
1217 utf8::encode( $_ ) if utf8::is_utf8($_);
1218 # using the URI::Escape pattern here so utf8 chars survive
1219 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1221 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1225 my $res = bless(\"${base}${args}${query}", $class);
1229 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1231 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1237 A private path to the Catalyst action you want to create a URI for.
1239 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1240 >> and passing the resulting C<$action> and the remaining arguments to C<<
1243 You can also pass in a Catalyst::Action object, in which case it is passed to
1250 sub uri_for_action {
1251 my ( $c, $path, @args ) = @_;
1252 my $action = blessed($path)
1254 : $c->dispatcher->get_action_by_path($path);
1255 unless (defined $action) {
1256 croak "Can't find action for path '$path'";
1258 return $c->uri_for( $action, @args );
1261 =head2 $c->welcome_message
1263 Returns the Catalyst welcome HTML page.
1267 sub welcome_message {
1269 my $name = $c->config->{name};
1270 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1271 my $prefix = Catalyst::Utils::appprefix( ref $c );
1272 $c->response->content_type('text/html; charset=utf-8');
1274 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1275 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1276 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1278 <meta http-equiv="Content-Language" content="en" />
1279 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1280 <title>$name on Catalyst $VERSION</title>
1281 <style type="text/css">
1284 background-color: #eee;
1291 margin-bottom: 10px;
1293 background-color: #ccc;
1294 border: 1px solid #aaa;
1299 font-family: verdana, tahoma, sans-serif;
1302 font-family: verdana, tahoma, sans-serif;
1305 text-decoration: none;
1307 border-bottom: 1px dotted #bbb;
1309 :link:hover, :visited:hover {
1322 background-color: #fff;
1323 border: 1px solid #aaa;
1327 font-weight: normal;
1349 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1354 <img src="$logo" alt="Catalyst Logo" />
1356 <p>Welcome to the world of Catalyst.
1357 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1358 framework will make web development something you had
1359 never expected it to be: Fun, rewarding, and quick.</p>
1360 <h2>What to do now?</h2>
1361 <p>That really depends on what <b>you</b> want to do.
1362 We do, however, provide you with a few starting points.</p>
1363 <p>If you want to jump right into web development with Catalyst
1364 you might want to start with a tutorial.</p>
1365 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1367 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1369 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1370 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1372 <h2>What to do next?</h2>
1373 <p>Next it's time to write an actual application. Use the
1374 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1375 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1376 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1377 they can save you a lot of work.</p>
1378 <pre><code>script/${prefix}_create.pl -help</code></pre>
1379 <p>Also, be sure to check out the vast and growing
1380 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1381 you are likely to find what you need there.
1385 <p>Catalyst has a very active community. Here are the main places to
1386 get in touch with us.</p>
1389 <a href="http://dev.catalyst.perl.org">Wiki</a>
1392 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1395 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1398 <h2>In conclusion</h2>
1399 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1400 as we enjoyed making it. Please contact us if you have ideas
1401 for improvement or other feedback.</p>
1409 =head1 INTERNAL METHODS
1411 These methods are not meant to be used by end users.
1413 =head2 $c->components
1415 Returns a hash of components.
1417 =head2 $c->context_class
1419 Returns or sets the context class.
1423 Returns a hashref containing coderefs and execution counts (needed for
1424 deep recursion detection).
1428 Returns the number of actions on the current internal execution stack.
1432 Dispatches a request to actions.
1436 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1438 =head2 $c->dispatcher_class
1440 Returns or sets the dispatcher class.
1442 =head2 $c->dump_these
1444 Returns a list of 2-element array references (name, structure) pairs
1445 that will be dumped on the error page in debug mode.
1451 [ Request => $c->req ],
1452 [ Response => $c->res ],
1453 [ Stash => $c->stash ],
1454 [ Config => $c->config ];
1457 =head2 $c->engine_class
1459 Returns or sets the engine class.
1461 =head2 $c->execute( $class, $coderef )
1463 Execute a coderef in given class and catch exceptions. Errors are available
1469 my ( $c, $class, $code ) = @_;
1470 $class = $c->component($class) || $class;
1473 if ( $c->depth >= $RECURSION ) {
1474 my $action = $code->reverse();
1475 $action = "/$action" unless $action =~ /->/;
1476 my $error = qq/Deep recursion detected calling "${action}"/;
1477 $c->log->error($error);
1483 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1485 push( @{ $c->stack }, $code );
1487 no warnings 'recursion';
1488 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1490 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1492 my $last = pop( @{ $c->stack } );
1494 if ( my $error = $@ ) {
1495 if ( !ref($error) and $error eq $DETACH ) {
1496 die $DETACH if($c->depth > 1);
1498 elsif ( !ref($error) and $error eq $GO ) {
1499 die $GO if($c->depth > 0);
1502 unless ( ref $error ) {
1503 no warnings 'uninitialized';
1505 my $class = $last->class;
1506 my $name = $last->name;
1507 $error = qq/Caught exception in $class->$name "$error"/;
1516 sub _stats_start_execute {
1517 my ( $c, $code ) = @_;
1519 return if ( ( $code->name =~ /^_.*/ )
1520 && ( !$c->config->{show_internal_actions} ) );
1522 my $action_name = $code->reverse();
1523 $c->counter->{$action_name}++;
1525 my $action = $action_name;
1526 $action = "/$action" unless $action =~ /->/;
1528 # determine if the call was the result of a forward
1529 # this is done by walking up the call stack and looking for a calling
1530 # sub of Catalyst::forward before the eval
1532 for my $index ( 2 .. 11 ) {
1534 if ( ( caller($index) )[0] eq 'Catalyst'
1535 && ( caller($index) )[3] eq '(eval)' );
1537 if ( ( caller($index) )[3] =~ /forward$/ ) {
1538 $callsub = ( caller($index) )[3];
1539 $action = "-> $action";
1544 my $uid = $action_name . $c->counter->{$action_name};
1546 # is this a root-level call or a forwarded call?
1547 if ( $callsub =~ /forward$/ ) {
1549 # forward, locate the caller
1550 if ( my $parent = $c->stack->[-1] ) {
1553 parent => "$parent" . $c->counter->{"$parent"},
1559 # forward with no caller may come from a plugin
1578 sub _stats_finish_execute {
1579 my ( $c, $info ) = @_;
1580 $c->stats->profile( end => $info );
1583 =head2 $c->_localize_fields( sub { }, \%keys );
1587 #Why does this exist? This is no longer safe and WILL NOT WORK.
1588 # it doesnt seem to be used anywhere. can we remove it?
1589 sub _localize_fields {
1590 my ( $c, $localized, $code ) = ( @_ );
1592 my $request = delete $localized->{request} || {};
1593 my $response = delete $localized->{response} || {};
1595 local @{ $c }{ keys %$localized } = values %$localized;
1596 local @{ $c->request }{ keys %$request } = values %$request;
1597 local @{ $c->response }{ keys %$response } = values %$response;
1604 Finalizes the request.
1611 for my $error ( @{ $c->error } ) {
1612 $c->log->error($error);
1615 # Allow engine to handle finalize flow (for POE)
1616 my $engine = $c->engine;
1617 if ( my $code = $engine->can('finalize') ) {
1622 $c->finalize_uploads;
1625 if ( $#{ $c->error } >= 0 ) {
1629 $c->finalize_headers;
1632 if ( $c->request->method eq 'HEAD' ) {
1633 $c->response->body('');
1639 if ($c->use_stats) {
1640 my $elapsed = sprintf '%f', $c->stats->elapsed;
1641 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1643 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1646 return $c->response->status;
1649 =head2 $c->finalize_body
1655 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1657 =head2 $c->finalize_cookies
1663 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1665 =head2 $c->finalize_error
1671 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1673 =head2 $c->finalize_headers
1679 sub finalize_headers {
1682 my $response = $c->response; #accessor calls can add up?
1684 # Check if we already finalized headers
1685 return if $response->finalized_headers;
1688 if ( my $location = $response->redirect ) {
1689 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1690 $response->header( Location => $location );
1692 if ( !$response->has_body ) {
1693 # Add a default body if none is already present
1695 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1701 if ( $response->body && !$response->content_length ) {
1703 # get the length from a filehandle
1704 if ( blessed( $response->body ) && $response->body->can('read') )
1706 my $stat = stat $response->body;
1707 if ( $stat && $stat->size > 0 ) {
1708 $response->content_length( $stat->size );
1711 $c->log->warn('Serving filehandle without a content-length');
1715 # everything should be bytes at this point, but just in case
1716 $response->content_length( bytes::length( $response->body ) );
1721 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1722 $response->headers->remove_header("Content-Length");
1723 $response->body('');
1726 $c->finalize_cookies;
1728 $c->engine->finalize_headers( $c, @_ );
1731 $response->finalized_headers(1);
1734 =head2 $c->finalize_output
1736 An alias for finalize_body.
1738 =head2 $c->finalize_read
1740 Finalizes the input after reading is complete.
1744 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1746 =head2 $c->finalize_uploads
1748 Finalizes uploads. Cleans up any temporary files.
1752 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1754 =head2 $c->get_action( $action, $namespace )
1756 Gets an action in a given namespace.
1760 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1762 =head2 $c->get_actions( $action, $namespace )
1764 Gets all actions of a given name in a namespace and all parent
1769 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1771 =head2 $c->handle_request( $class, @arguments )
1773 Called to handle each HTTP request.
1777 sub handle_request {
1778 my ( $class, @arguments ) = @_;
1780 # Always expect worst case!
1783 if ($class->debug) {
1784 my $secs = time - $START || 1;
1785 my $av = sprintf '%.3f', $COUNT / $secs;
1786 my $time = localtime time;
1787 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1790 my $c = $class->prepare(@arguments);
1792 $status = $c->finalize;
1795 if ( my $error = $@ ) {
1797 $class->log->error(qq/Caught exception in engine "$error"/);
1802 if(my $coderef = $class->log->can('_flush')){
1803 $class->log->$coderef();
1808 =head2 $c->prepare( @arguments )
1810 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1816 my ( $class, @arguments ) = @_;
1819 # After the app/ctxt split, this should become an attribute based on something passed
1820 # into the application.
1821 $class->context_class( ref $class || $class ) unless $class->context_class;
1823 my $c = $class->context_class->new({});
1825 # For on-demand data
1826 $c->request->_context($c);
1827 $c->response->_context($c);
1829 #surely this is not the most efficient way to do things...
1830 $c->stats($class->stats_class->new)->enable($c->use_stats);
1832 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1835 #XXX reuse coderef from can
1836 # Allow engine to direct the prepare flow (for POE)
1837 if ( $c->engine->can('prepare') ) {
1838 $c->engine->prepare( $c, @arguments );
1841 $c->prepare_request(@arguments);
1842 $c->prepare_connection;
1843 $c->prepare_query_parameters;
1844 $c->prepare_headers;
1845 $c->prepare_cookies;
1848 # Prepare the body for reading, either by prepare_body
1849 # or the user, if they are using $c->read
1852 # Parse the body unless the user wants it on-demand
1853 unless ( $c->config->{parse_on_demand} ) {
1858 my $method = $c->req->method || '';
1859 my $path = $c->req->path;
1860 $path = '/' unless length $path;
1861 my $address = $c->req->address || '';
1863 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1871 =head2 $c->prepare_action
1873 Prepares action. See L<Catalyst::Dispatcher>.
1877 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1879 =head2 $c->prepare_body
1881 Prepares message body.
1888 return if $c->request->_has_body;
1890 # Initialize on-demand data
1891 $c->engine->prepare_body( $c, @_ );
1892 $c->prepare_parameters;
1893 $c->prepare_uploads;
1895 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1896 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1897 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1898 my $param = $c->req->body_parameters->{$key};
1899 my $value = defined($param) ? $param : '';
1901 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1903 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1907 =head2 $c->prepare_body_chunk( $chunk )
1909 Prepares a chunk of data before sending it to L<HTTP::Body>.
1911 See L<Catalyst::Engine>.
1915 sub prepare_body_chunk {
1917 $c->engine->prepare_body_chunk( $c, @_ );
1920 =head2 $c->prepare_body_parameters
1922 Prepares body parameters.
1926 sub prepare_body_parameters {
1928 $c->engine->prepare_body_parameters( $c, @_ );
1931 =head2 $c->prepare_connection
1933 Prepares connection.
1937 sub prepare_connection {
1939 $c->engine->prepare_connection( $c, @_ );
1942 =head2 $c->prepare_cookies
1948 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1950 =head2 $c->prepare_headers
1956 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1958 =head2 $c->prepare_parameters
1960 Prepares parameters.
1964 sub prepare_parameters {
1966 $c->prepare_body_parameters;
1967 $c->engine->prepare_parameters( $c, @_ );
1970 =head2 $c->prepare_path
1972 Prepares path and base.
1976 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1978 =head2 $c->prepare_query_parameters
1980 Prepares query parameters.
1984 sub prepare_query_parameters {
1987 $c->engine->prepare_query_parameters( $c, @_ );
1989 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1990 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1991 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1992 my $param = $c->req->query_parameters->{$key};
1993 my $value = defined($param) ? $param : '';
1995 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1997 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2001 =head2 $c->prepare_read
2003 Prepares the input for reading.
2007 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2009 =head2 $c->prepare_request
2011 Prepares the engine request.
2015 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2017 =head2 $c->prepare_uploads
2023 sub prepare_uploads {
2026 $c->engine->prepare_uploads( $c, @_ );
2028 if ( $c->debug && keys %{ $c->request->uploads } ) {
2029 my $t = Text::SimpleTable->new(
2030 [ 12, 'Parameter' ],
2035 for my $key ( sort keys %{ $c->request->uploads } ) {
2036 my $upload = $c->request->uploads->{$key};
2037 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2038 $t->row( $key, $u->filename, $u->type, $u->size );
2041 $c->log->debug( "File Uploads are:\n" . $t->draw );
2045 =head2 $c->prepare_write
2047 Prepares the output for writing.
2051 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2053 =head2 $c->request_class
2055 Returns or sets the request class.
2057 =head2 $c->response_class
2059 Returns or sets the response class.
2061 =head2 $c->read( [$maxlength] )
2063 Reads a chunk of data from the request body. This method is designed to
2064 be used in a while loop, reading C<$maxlength> bytes on every call.
2065 C<$maxlength> defaults to the size of the request if not specified.
2067 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2070 Warning: If you use read(), Catalyst will not process the body,
2071 so you will not be able to access POST parameters or file uploads via
2072 $c->request. You must handle all body parsing yourself.
2076 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2084 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2086 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2088 Sets an action in a given namespace.
2092 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2094 =head2 $c->setup_actions($component)
2096 Sets up actions for a component.
2100 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2102 =head2 $c->setup_components
2104 Sets up components. Specify a C<setup_components> config option to pass
2105 additional options directly to L<Module::Pluggable>. To add additional
2106 search paths, specify a key named C<search_extra> as an array
2107 reference. Items in the array beginning with C<::> will have the
2108 application class name prepended to them.
2110 All components found will also have any
2111 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2112 Note, that modules which are B<not> an I<inner package> of the main
2113 file namespace loaded will not be instantiated as components.
2117 sub setup_components {
2120 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2121 my $config = $class->config->{ setup_components };
2122 my $extra = delete $config->{ search_extra } || [];
2124 push @paths, @$extra;
2126 my $locator = Module::Pluggable::Object->new(
2127 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2131 my @comps = sort { length $a <=> length $b } $locator->plugins;
2132 my %comps = map { $_ => 1 } @comps;
2134 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2135 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2136 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2137 ) if $deprecated_component_names;
2139 for my $component ( @comps ) {
2141 # We pass ignore_loaded here so that overlay files for (e.g.)
2142 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2143 # we know M::P::O found a file on disk so this is safe
2145 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2146 #Class::MOP::load_class($component);
2148 my $module = $class->setup_component( $component );
2150 $component => $module,
2152 $_ => $class->setup_component( $_ )
2154 not exists $comps{$_}
2155 } Devel::InnerPackage::list_packages( $component )
2158 for my $key ( keys %modules ) {
2159 $class->components->{ $key } = $modules{ $key };
2164 =head2 $c->setup_component
2168 sub _controller_init_base_classes {
2169 my ($app_class, $component) = @_;
2170 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2171 next unless $class =~ /^$app_class/;
2172 Moose->init_meta( for_class => $class )
2173 unless find_meta($class);
2177 sub setup_component {
2178 my( $class, $component ) = @_;
2180 unless ( $component->can( 'COMPONENT' ) ) {
2184 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2185 # nearest to Catalyst::Controller first, no matter what order stuff happens
2186 # to be loaded. There are TODO tests in Moose for this, see
2187 # f2391d17574eff81d911b97be15ea51080500003
2188 if ($component->isa('Catalyst::Controller')) {
2189 $class->_controller_init_base_classes($component);
2192 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2193 my $config = $class->config->{ $suffix } || {};
2195 my $instance = eval { $component->COMPONENT( $class, $config ); };
2197 if ( my $error = $@ ) {
2199 Catalyst::Exception->throw(
2200 message => qq/Couldn't instantiate component "$component", "$error"/
2204 unless (blessed $instance) {
2205 my $metaclass = Moose::Util::find_meta($component);
2206 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2207 my $component_method_from = $method_meta->associated_metaclass->name;
2208 my $value = defined($instance) ? $instance : 'undef';
2209 Catalyst::Exception->throw(
2211 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2217 =head2 $c->setup_dispatcher
2223 sub setup_dispatcher {
2224 my ( $class, $dispatcher ) = @_;
2227 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2230 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2231 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2234 unless ($dispatcher) {
2235 $dispatcher = $class->dispatcher_class;
2238 Class::MOP::load_class($dispatcher);
2240 # dispatcher instance
2241 $class->dispatcher( $dispatcher->new );
2244 =head2 $c->setup_engine
2251 my ( $class, $engine ) = @_;
2254 $engine = 'Catalyst::Engine::' . $engine;
2257 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2258 $engine = 'Catalyst::Engine::' . $env;
2261 if ( $ENV{MOD_PERL} ) {
2262 my $meta = Class::MOP::get_metaclass_by_name($class);
2264 # create the apache method
2265 $meta->add_method('apache' => sub { shift->engine->apache });
2267 my ( $software, $version ) =
2268 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2271 $version =~ s/(\.[^.]+)\./$1/g;
2273 if ( $software eq 'mod_perl' ) {
2277 if ( $version >= 1.99922 ) {
2278 $engine = 'Catalyst::Engine::Apache2::MP20';
2281 elsif ( $version >= 1.9901 ) {
2282 $engine = 'Catalyst::Engine::Apache2::MP19';
2285 elsif ( $version >= 1.24 ) {
2286 $engine = 'Catalyst::Engine::Apache::MP13';
2290 Catalyst::Exception->throw( message =>
2291 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2296 # install the correct mod_perl handler
2297 if ( $version >= 1.9901 ) {
2298 *handler = sub : method {
2299 shift->handle_request(@_);
2303 *handler = sub ($$) { shift->handle_request(@_) };
2308 elsif ( $software eq 'Zeus-Perl' ) {
2309 $engine = 'Catalyst::Engine::Zeus';
2313 Catalyst::Exception->throw(
2314 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2319 $engine = $class->engine_class;
2322 Class::MOP::load_class($engine);
2324 # check for old engines that are no longer compatible
2326 if ( $engine->isa('Catalyst::Engine::Apache')
2327 && !Catalyst::Engine::Apache->VERSION )
2332 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2333 && Catalyst::Engine::Server->VERSION le '0.02' )
2338 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2339 && $engine->VERSION eq '0.01' )
2344 elsif ($engine->isa('Catalyst::Engine::Zeus')
2345 && $engine->VERSION eq '0.01' )
2351 Catalyst::Exception->throw( message =>
2352 qq/Engine "$engine" is not supported by this version of Catalyst/
2357 $class->engine( $engine->new );
2360 =head2 $c->setup_home
2362 Sets up the home directory.
2367 my ( $class, $home ) = @_;
2369 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2373 $home ||= Catalyst::Utils::home($class);
2376 #I remember recently being scolded for assigning config values like this
2377 $class->config->{home} ||= $home;
2378 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2382 =head2 $c->setup_log
2384 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2385 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2388 This method also installs a C<debug> method that returns a true value into the
2389 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2390 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2392 Note that if the log has already been setup, by either a previous call to
2393 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2394 that this method won't actually set up the log object.
2399 my ( $class, $levels ) = @_;
2402 $levels =~ s/^\s+//;
2403 $levels =~ s/\s+$//;
2404 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2406 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2407 if ( defined $env_debug ) {
2408 $levels{debug} = 1 if $env_debug; # Ugly!
2409 delete($levels{debug}) unless $env_debug;
2412 unless ( $class->log ) {
2413 $class->log( Catalyst::Log->new(keys %levels) );
2416 if ( $levels{debug} ) {
2417 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2418 $class->log->debug('Debug messages enabled');
2422 =head2 $c->setup_plugins
2428 =head2 $c->setup_stats
2430 Sets up timing statistics class.
2435 my ( $class, $stats ) = @_;
2437 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2439 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2440 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2441 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2442 $class->log->debug('Statistics enabled');
2447 =head2 $c->registered_plugins
2449 Returns a sorted list of the plugins which have either been stated in the
2450 import list or which have been added via C<< MyApp->plugin(@args); >>.
2452 If passed a given plugin name, it will report a boolean value indicating
2453 whether or not that plugin is loaded. A fully qualified name is required if
2454 the plugin name does not begin with C<Catalyst::Plugin::>.
2456 if ($c->registered_plugins('Some::Plugin')) {
2464 sub registered_plugins {
2466 return sort keys %{ $proto->_plugins } unless @_;
2468 return 1 if exists $proto->_plugins->{$plugin};
2469 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2472 sub _register_plugin {
2473 my ( $proto, $plugin, $instant ) = @_;
2474 my $class = ref $proto || $proto;
2476 # no ignore_loaded here, the plugin may already have been
2477 # defined in memory and we don't want to error on "no file" if so
2479 Class::MOP::load_class( $plugin );
2481 $proto->_plugins->{$plugin} = 1;
2484 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2485 my @superclasses = ($plugin, $meta->superclasses );
2486 $meta->superclasses(@superclasses);
2488 unshift @{"$class\::ISA"}, $plugin;
2495 my ( $class, $plugins ) = @_;
2497 $class->_plugins( {} ) unless $class->_plugins;
2499 for my $plugin ( reverse @$plugins ) {
2501 unless ( $plugin =~ s/\A\+// ) {
2502 $plugin = "Catalyst::Plugin::$plugin";
2505 $class->_register_plugin($plugin);
2512 Returns an arrayref of the internal execution stack (actions that are
2513 currently executing).
2515 =head2 $c->stats_class
2517 Returns or sets the stats (timing statistics) class.
2519 =head2 $c->use_stats
2521 Returns 1 when stats collection is enabled. Stats collection is enabled
2522 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2523 environment variable is set.
2525 Note that this is a static method, not an accessor and should be overridden
2526 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2533 =head2 $c->write( $data )
2535 Writes $data to the output stream. When using this method directly, you
2536 will need to manually set the C<Content-Length> header to the length of
2537 your output data, if known.
2544 # Finalize headers if someone manually writes output
2545 $c->finalize_headers;
2547 return $c->engine->write( $c, @_ );
2552 Returns the Catalyst version number. Mostly useful for "powered by"
2553 messages in template systems.
2557 sub version { return $Catalyst::VERSION }
2559 =head1 INTERNAL ACTIONS
2561 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2562 C<_ACTION>, and C<_END>. These are by default not shown in the private
2563 action table, but you can make them visible with a config parameter.
2565 MyApp->config->{show_internal_actions} = 1;
2567 =head1 CASE SENSITIVITY
2569 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2570 mapped to C</foo/bar>. You can activate case sensitivity with a config
2573 MyApp->config->{case_sensitive} = 1;
2575 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2577 =head1 ON-DEMAND PARSER
2579 The request body is usually parsed at the beginning of a request,
2580 but if you want to handle input yourself, you can enable on-demand
2581 parsing with a config parameter.
2583 MyApp->config->{parse_on_demand} = 1;
2585 =head1 PROXY SUPPORT
2587 Many production servers operate using the common double-server approach,
2588 with a lightweight frontend web server passing requests to a larger
2589 backend server. An application running on the backend server must deal
2590 with two problems: the remote user always appears to be C<127.0.0.1> and
2591 the server's hostname will appear to be C<localhost> regardless of the
2592 virtual host that the user connected through.
2594 Catalyst will automatically detect this situation when you are running
2595 the frontend and backend servers on the same machine. The following
2596 changes are made to the request.
2598 $c->req->address is set to the user's real IP address, as read from
2599 the HTTP X-Forwarded-For header.
2601 The host value for $c->req->base and $c->req->uri is set to the real
2602 host, as read from the HTTP X-Forwarded-Host header.
2604 Obviously, your web server must support these headers for this to work.
2606 In a more complex server farm environment where you may have your
2607 frontend proxy server(s) on different machines, you will need to set a
2608 configuration option to tell Catalyst to read the proxied data from the
2611 MyApp->config->{using_frontend_proxy} = 1;
2613 If you do not wish to use the proxy support at all, you may set:
2615 MyApp->config->{ignore_frontend_proxy} = 1;
2617 =head1 THREAD SAFETY
2619 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2620 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2621 believe the Catalyst core to be thread-safe.
2623 If you plan to operate in a threaded environment, remember that all other
2624 modules you are using must also be thread-safe. Some modules, most notably
2625 L<DBD::SQLite>, are not thread-safe.
2631 Join #catalyst on irc.perl.org.
2635 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2636 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2640 http://catalyst.perl.org
2644 http://dev.catalyst.perl.org
2648 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2650 =head2 L<Catalyst::Manual> - The Catalyst Manual
2652 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2654 =head2 L<Catalyst::Engine> - Core engine
2656 =head2 L<Catalyst::Log> - Log class.
2658 =head2 L<Catalyst::Request> - Request object
2660 =head2 L<Catalyst::Response> - Response object
2662 =head2 L<Catalyst::Test> - The test suite.
2664 =head1 PROJECT FOUNDER
2666 sri: Sebastian Riedel <sri@cpan.org>
2672 acme: Leon Brocard <leon@astray.com>
2680 andyg: Andy Grundman <andy@hybridized.org>
2682 audreyt: Audrey Tang
2684 bricas: Brian Cassidy <bricas@cpan.org>
2686 Caelum: Rafael Kitover <rkitover@io.com>
2688 chansen: Christian Hansen
2690 chicks: Christopher Hicks
2694 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2698 esskar: Sascha Kiefer
2700 fireartist: Carl Franks <cfranks@cpan.org>
2702 gabb: Danijel Milicevic
2708 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2710 jcamacho: Juan Camacho
2712 jhannah: Jay Hannah <jay@jays.net>
2718 jon: Jon Schutz <jjschutz@cpan.org>
2720 marcus: Marcus Ramberg <mramberg@cpan.org>
2722 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2724 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2728 naughton: David Naughton
2730 ningu: David Kamholz <dkamholz@cpan.org>
2732 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2734 numa: Dan Sully <daniel@cpan.org>
2738 omega: Andreas Marienborg
2740 Oleg Kostyuk <cub.uanic@gmail.com>
2742 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2744 rafl: Florian Ragwitz <rafl@debian.org>
2748 the_jester: Jesse Sheidlower
2750 t0m: Tomas Doran <bobtfish@bobtfish.net>
2754 willert: Sebastian Willert <willert@cpan.org>
2758 This library is free software, you can redistribute it and/or modify it under
2759 the same terms as Perl itself.
2765 __PACKAGE__->meta->make_immutable;