4 extends 'Catalyst::Component';
5 use Moose::Util qw/find_meta/;
6 use Moose::Util::MetaRole ();
9 use Catalyst::Exception;
11 use Catalyst::Request;
12 use Catalyst::Request::Upload;
13 use Catalyst::Response;
15 use Catalyst::Controller;
16 use Devel::InnerPackage ();
18 use Module::Pluggable::Object ();
19 use Text::SimpleTable ();
20 use Path::Class::Dir ();
21 use Path::Class::File ();
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
27 use Class::C3::Adopt::NEXT;
30 use Carp qw/croak carp shortmess/;
32 BEGIN { require 5.008001; }
34 has stack => (is => 'ro', default => sub { [] });
35 has stash => (is => 'rw', default => sub { {} });
36 has state => (is => 'rw', default => 0);
37 has stats => (is => 'rw');
38 has action => (is => 'rw');
39 has counter => (is => 'rw', default => sub { {} });
40 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
41 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
42 has namespace => (is => 'rw');
44 sub depth { scalar @{ shift->stack || [] }; }
45 sub comp { shift->component(@_) }
48 my $self = shift; return $self->request(@_);
51 my $self = shift; return $self->response(@_);
54 # For backwards compatibility
55 sub finalize_output { shift->finalize_body(@_) };
60 our $RECURSION = 1000;
61 our $DETACH = "catalyst_detach\n";
62 our $GO = "catalyst_go\n";
64 #I imagine that very few of these really need to be class variables. if any.
65 #maybe we should just make them attributes with a default?
66 __PACKAGE__->mk_classdata($_)
67 for qw/components arguments dispatcher engine log dispatcher_class
68 engine_class context_class request_class response_class stats_class
71 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
72 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
73 __PACKAGE__->request_class('Catalyst::Request');
74 __PACKAGE__->response_class('Catalyst::Response');
75 __PACKAGE__->stats_class('Catalyst::Stats');
77 # Remember to update this in Catalyst::Runtime as well!
79 our $VERSION = '5.80002';
82 my $dev_version = $VERSION =~ /_\d{2}$/;
83 *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
86 $VERSION = eval $VERSION;
89 my ( $class, @arguments ) = @_;
91 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
93 return unless $class eq 'Catalyst';
95 my $caller = caller();
96 return if $caller eq 'main';
98 # Kill Adopt::NEXT warnings if we're a non-RC version
99 unless (_IS_DEVELOPMENT_VERSION()) {
100 Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
103 my $meta = Moose::Meta::Class->initialize($caller);
104 #Moose->import({ into => $caller }); #do we want to do this?
106 unless ( $caller->isa('Catalyst') ) {
107 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
108 $meta->superclasses(@superclasses);
110 unless( $meta->has_method('meta') ){
111 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
114 $caller->arguments( [@arguments] );
120 Catalyst - The Elegant MVC Web Application Framework
124 See the L<Catalyst::Manual> distribution for comprehensive
125 documentation and tutorials.
127 # Install Catalyst::Devel for helpers and other development tools
128 # use the helper to create a new application
131 # add models, views, controllers
132 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
133 script/myapp_create.pl view MyTemplate TT
134 script/myapp_create.pl controller Search
136 # built in testserver -- use -r to restart automatically on changes
137 # --help to see all available options
138 script/myapp_server.pl
140 # command line testing interface
141 script/myapp_test.pl /yada
144 use Catalyst qw/-Debug/; # include plugins here as well
146 ### In lib/MyApp/Controller/Root.pm (autocreated)
147 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
148 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
149 $c->stash->{template} = 'foo.tt'; # set the template
150 # lookup something from db -- stash vars are passed to TT
152 $c->model('Database::Foo')->search( { country => $args[0] } );
153 if ( $c->req->params->{bar} ) { # access GET or POST parameters
154 $c->forward( 'bar' ); # process another action
155 # do something else after forward returns
159 # The foo.tt TT template can use the stash data from the database
160 [% WHILE (item = data.next) %]
164 # called for /bar/of/soap, /bar/of/soap/10, etc.
165 sub bar : Path('/bar/of/soap') { ... }
167 # called for all actions, from the top-most controller downwards
169 my ( $self, $c ) = @_;
170 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
171 $c->res->redirect( '/login' ); # require login
172 return 0; # abort request and go immediately to end()
174 return 1; # success; carry on to next action
177 # called after all actions are finished
179 my ( $self, $c ) = @_;
180 if ( scalar @{ $c->error } ) { ... } # handle errors
181 return if $c->res->body; # already have a response
182 $c->forward( 'MyApp::View::TT' ); # render template
185 ### in MyApp/Controller/Foo.pm
186 # called for /foo/bar
187 sub bar : Local { ... }
189 # called for /blargle
190 sub blargle : Global { ... }
192 # an index action matches /foo, but not /foo/1, etc.
193 sub index : Private { ... }
195 ### in MyApp/Controller/Foo/Bar.pm
196 # called for /foo/bar/baz
197 sub baz : Local { ... }
199 # first Root auto is called, then Foo auto, then this
200 sub auto : Private { ... }
202 # powerful regular expression paths are also possible
203 sub details : Regex('^product/(\w+)/details$') {
204 my ( $self, $c ) = @_;
205 # extract the (\w+) from the URI
206 my $product = $c->req->captures->[0];
209 See L<Catalyst::Manual::Intro> for additional information.
213 Catalyst is a modern framework for making web applications without the
214 pain usually associated with this process. This document is a reference
215 to the main Catalyst application. If you are a new user, we suggest you
216 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
218 See L<Catalyst::Manual> for more documentation.
220 Catalyst plugins can be loaded by naming them as arguments to the "use
221 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
222 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
225 use Catalyst qw/My::Module/;
227 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
228 fully qualify the name by using a unary plus:
232 +Fully::Qualified::Plugin::Name
235 Special flags like C<-Debug> and C<-Engine> can also be specified as
236 arguments when Catalyst is loaded:
238 use Catalyst qw/-Debug My::Module/;
240 The position of plugins and flags in the chain is important, because
241 they are loaded in the order in which they appear.
243 The following flags are supported:
247 Enables debug output. You can also force this setting from the system
248 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
249 settings override the application, with <MYAPP>_DEBUG having the highest
254 Forces Catalyst to use a specific engine. Omit the
255 C<Catalyst::Engine::> prefix of the engine name, i.e.:
257 use Catalyst qw/-Engine=CGI/;
261 Forces Catalyst to use a specific home directory, e.g.:
263 use Catalyst qw[-Home=/usr/mst];
265 This can also be done in the shell environment by setting either the
266 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
267 is replaced with the uppercased name of your application, any "::" in
268 the name will be replaced with underscores, e.g. MyApp::Web should use
269 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
273 use Catalyst '-Log=warn,fatal,error';
275 Specifies a comma-delimited list of log levels.
279 Enables statistics collection and reporting. You can also force this setting
280 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
281 environment settings override the application, with <MYAPP>_STATS having the
286 use Catalyst qw/-Stats=1/
290 =head2 INFORMATION ABOUT THE CURRENT REQUEST
294 Returns a L<Catalyst::Action> object for the current action, which
295 stringifies to the action name. See L<Catalyst::Action>.
299 Returns the namespace of the current action, i.e., the URI prefix
300 corresponding to the controller of the current action. For example:
302 # in Controller::Foo::Bar
303 $c->namespace; # returns 'foo/bar';
309 Returns the current L<Catalyst::Request> object, giving access to
310 information about the current client request (including parameters,
311 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
313 =head2 REQUEST FLOW HANDLING
315 =head2 $c->forward( $action [, \@arguments ] )
317 =head2 $c->forward( $class, $method, [, \@arguments ] )
319 Forwards processing to another action, by its private name. If you give a
320 class name but no method, C<process()> is called. You may also optionally
321 pass arguments in an arrayref. The action will receive the arguments in
322 C<@_> and C<< $c->req->args >>. Upon returning from the function,
323 C<< $c->req->args >> will be restored to the previous values.
325 Any data C<return>ed from the action forwarded to, will be returned by the
328 my $foodata = $c->forward('/foo');
329 $c->forward('index');
330 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
331 $c->forward('MyApp::View::TT');
333 Note that forward implies an C<<eval { }>> around the call (actually
334 C<execute> does), thus de-fatalizing all 'dies' within the called
335 action. If you want C<die> to propagate you need to do something like:
338 die $c->error if $c->error;
340 Or make sure to always return true values from your actions and write
343 $c->forward('foo') || return;
347 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
349 =head2 $c->detach( $action [, \@arguments ] )
351 =head2 $c->detach( $class, $method, [, \@arguments ] )
355 The same as C<forward>, but doesn't return to the previous action when
356 processing is finished.
358 When called with no arguments it escapes the processing chain entirely.
362 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
364 =head2 $c->visit( $action [, \@captures, \@arguments ] )
366 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
368 Almost the same as C<forward>, but does a full dispatch, instead of just
369 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
370 C<auto> and the method you go to are called, just like a new request.
372 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
373 This means, for example, that $c->action methods such as C<name>, C<class> and
374 C<reverse> return information for the visited action when they are invoked
375 within the visited action. This is different from the behavior of C<forward>
376 which continues to use the $c->action object from the caller action even when
377 invoked from the callee.
379 C<$c-E<gt>stash> is kept unchanged.
381 In effect, C<visit> allows you to "wrap" another action, just as it
382 would have been called by dispatching from a URL, while the analogous
383 C<go> allows you to transfer control to another action as if it had
384 been reached directly from a URL.
388 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
390 =head2 $c->go( $action [, \@captures, \@arguments ] )
392 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
394 Almost the same as C<detach>, but does a full dispatch like C<visit>,
395 instead of just calling the new C<$action> /
396 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
397 method you visit are called, just like a new request.
399 C<$c-E<gt>stash> is kept unchanged.
403 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
409 Returns the current L<Catalyst::Response> object, see there for details.
413 Returns a hashref to the stash, which may be used to store data and pass
414 it between components during a request. You can also set hash keys by
415 passing arguments. The stash is automatically sent to the view. The
416 stash is cleared at the end of a request; it cannot be used for
417 persistent storage (for this you must use a session; see
418 L<Catalyst::Plugin::Session> for a complete system integrated with
421 $c->stash->{foo} = $bar;
422 $c->stash( { moose => 'majestic', qux => 0 } );
423 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
425 # stash is automatically passed to the view for use in a template
426 $c->forward( 'MyApp::View::TT' );
430 around stash => sub {
433 my $stash = $orig->($c);
435 my $new_stash = @_ > 1 ? {@_} : $_[0];
436 croak('stash takes a hash or hashref') unless ref $new_stash;
437 foreach my $key ( keys %$new_stash ) {
438 $stash->{$key} = $new_stash->{$key};
448 =head2 $c->error($error, ...)
450 =head2 $c->error($arrayref)
452 Returns an arrayref containing error messages. If Catalyst encounters an
453 error while processing a request, it stores the error in $c->error. This
454 method should only be used to store fatal error messages.
456 my @error = @{ $c->error };
460 $c->error('Something bad happened');
467 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
468 croak @$error unless ref $c;
469 push @{ $c->{error} }, @$error;
471 elsif ( defined $_[0] ) { $c->{error} = undef }
472 return $c->{error} || [];
478 Contains the return value of the last executed action.
480 =head2 $c->clear_errors
482 Clear errors. You probably don't want to clear the errors unless you are
483 implementing a custom error screen.
485 This is equivalent to running
496 # search components given a name and some prefixes
497 sub _comp_search_prefixes {
498 my ( $c, $name, @prefixes ) = @_;
499 my $appclass = ref $c || $c;
500 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
501 $filter = qr/$filter/; # Compile regex now rather than once per loop
503 # map the original component name to the sub part that we will search against
504 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
505 grep { /$filter/ } keys %{ $c->components };
507 # undef for a name will return all
508 return keys %eligible if !defined $name;
510 my $query = ref $name ? $name : qr/^$name$/i;
511 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
513 return map { $c->components->{ $_ } } @result if @result;
515 # if we were given a regexp to search against, we're done.
520 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
522 # no results? try against full names
524 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
527 # don't warn if we didn't find any results, it just might not exist
529 # Disgusting hack to work out correct method name
530 my $warn_for = lc $prefixes[0];
531 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
532 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
533 "component resolution is unreliable and unsafe.";
534 my $short = $result[0];
535 $short =~ s/.*?Model:://;
536 my $shortmess = Carp::shortmess('');
537 if ($shortmess =~ m#Catalyst/Plugin#) {
538 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
540 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
541 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
542 "component's config";
544 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
545 "but if you really wanted to search, pass in a regexp as the argument " .
546 "like so: \$c->${warn_for}(qr/${name}/)";
548 $c->log->warn( "${msg}$shortmess" );
554 # Find possible names for a prefix
556 my ( $c, @prefixes ) = @_;
557 my $appclass = ref $c || $c;
559 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
561 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
565 # Filter a component before returning by calling ACCEPT_CONTEXT if available
566 sub _filter_component {
567 my ( $c, $comp, @args ) = @_;
569 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
570 return $comp->ACCEPT_CONTEXT( $c, @args );
576 =head2 COMPONENT ACCESSORS
578 =head2 $c->controller($name)
580 Gets a L<Catalyst::Controller> instance by name.
582 $c->controller('Foo')->do_stuff;
584 If the name is omitted, will return the controller for the dispatched
587 If you want to search for controllers, pass in a regexp as the argument.
589 # find all controllers that start with Foo
590 my @foo_controllers = $c->controller(qr{^Foo});
596 my ( $c, $name, @args ) = @_;
599 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
600 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
601 return $c->_filter_component( $result[ 0 ], @args );
604 return $c->component( $c->action->class );
607 =head2 $c->model($name)
609 Gets a L<Catalyst::Model> instance by name.
611 $c->model('Foo')->do_stuff;
613 Any extra arguments are directly passed to ACCEPT_CONTEXT.
615 If the name is omitted, it will look for
616 - a model object in $c->stash->{current_model_instance}, then
617 - a model name in $c->stash->{current_model}, then
618 - a config setting 'default_model', or
619 - check if there is only one model, and return it if that's the case.
621 If you want to search for models, pass in a regexp as the argument.
623 # find all models that start with Foo
624 my @foo_models = $c->model(qr{^Foo});
629 my ( $c, $name, @args ) = @_;
632 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
633 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
634 return $c->_filter_component( $result[ 0 ], @args );
638 return $c->stash->{current_model_instance}
639 if $c->stash->{current_model_instance};
640 return $c->model( $c->stash->{current_model} )
641 if $c->stash->{current_model};
643 return $c->model( $c->config->{default_model} )
644 if $c->config->{default_model};
646 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
649 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
650 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
651 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
652 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
653 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
656 return $c->_filter_component( $comp );
660 =head2 $c->view($name)
662 Gets a L<Catalyst::View> instance by name.
664 $c->view('Foo')->do_stuff;
666 Any extra arguments are directly passed to ACCEPT_CONTEXT.
668 If the name is omitted, it will look for
669 - a view object in $c->stash->{current_view_instance}, then
670 - a view name in $c->stash->{current_view}, then
671 - a config setting 'default_view', or
672 - check if there is only one view, and return it if that's the case.
674 If you want to search for views, pass in a regexp as the argument.
676 # find all views that start with Foo
677 my @foo_views = $c->view(qr{^Foo});
682 my ( $c, $name, @args ) = @_;
685 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
686 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
687 return $c->_filter_component( $result[ 0 ], @args );
691 return $c->stash->{current_view_instance}
692 if $c->stash->{current_view_instance};
693 return $c->view( $c->stash->{current_view} )
694 if $c->stash->{current_view};
696 return $c->view( $c->config->{default_view} )
697 if $c->config->{default_view};
699 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
702 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
703 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
704 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
705 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
706 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
709 return $c->_filter_component( $comp );
712 =head2 $c->controllers
714 Returns the available names which can be passed to $c->controller
720 return $c->_comp_names(qw/Controller C/);
725 Returns the available names which can be passed to $c->model
731 return $c->_comp_names(qw/Model M/);
737 Returns the available names which can be passed to $c->view
743 return $c->_comp_names(qw/View V/);
746 =head2 $c->comp($name)
748 =head2 $c->component($name)
750 Gets a component object by name. This method is not recommended,
751 unless you want to get a specific component by full
752 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
753 should be used instead.
755 If C<$name> is a regexp, a list of components matched against the full
756 component name will be returned.
761 my ( $c, $name, @args ) = @_;
764 my $comps = $c->components;
767 # is it the exact name?
768 return $c->_filter_component( $comps->{ $name }, @args )
769 if exists $comps->{ $name };
771 # perhaps we just omitted "MyApp"?
772 my $composed = ( ref $c || $c ) . "::${name}";
773 return $c->_filter_component( $comps->{ $composed }, @args )
774 if exists $comps->{ $composed };
776 # search all of the models, views and controllers
777 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
778 return $c->_filter_component( $comp, @args ) if $comp;
781 # This is here so $c->comp( '::M::' ) works
782 my $query = ref $name ? $name : qr{$name}i;
784 my @result = grep { m{$query} } keys %{ $c->components };
785 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
788 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
789 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
790 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
791 return $c->_filter_component( $result[ 0 ], @args );
794 # I would expect to return an empty list here, but that breaks back-compat
798 return sort keys %{ $c->components };
801 =head2 CLASS DATA AND HELPER CLASSES
805 Returns or takes a hashref containing the application's configuration.
807 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
809 You can also use a C<YAML>, C<XML> or C<Config::General> config file
810 like myapp.conf in your applications home directory. See
811 L<Catalyst::Plugin::ConfigLoader>.
813 =head3 Cascading configuration.
815 The config method is present on all Catalyst components, and configuration
816 will be merged when an application is started. Configuration loaded with
817 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
818 followed by configuration in your top level C<MyApp> class. These two
819 configurations are merged, and then configuration data whose hash key matches a
820 component name is merged with configuration for that component.
822 The configuration for a component is then passed to the C<new> method when a
823 component is constructed.
827 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
828 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
830 will mean that C<MyApp::Model::Foo> receives the following data when
833 MyApp::Model::Foo->new({
841 around config => sub {
845 croak('Setting config after setup has been run is not allowed.')
846 if ( @_ and $c->setup_finished );
853 Returns the logging object instance. Unless it is already set, Catalyst
854 sets this up with a L<Catalyst::Log> object. To use your own log class,
855 set the logger with the C<< __PACKAGE__->log >> method prior to calling
856 C<< __PACKAGE__->setup >>.
858 __PACKAGE__->log( MyLogger->new );
863 $c->log->info( 'Now logging with my own logger!' );
865 Your log class should implement the methods described in
871 Returns 1 if debug mode is enabled, 0 otherwise.
873 You can enable debug mode in several ways:
877 =item By calling myapp_server.pl with the -d flag
879 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
881 =item The -Debug option in your MyApp.pm
883 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
887 Calling C<< $c->debug(1) >> has no effect.
893 =head2 $c->dispatcher
895 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
899 Returns the engine instance. See L<Catalyst::Engine>.
902 =head2 UTILITY METHODS
904 =head2 $c->path_to(@path)
906 Merges C<@path> with C<< $c->config->{home} >> and returns a
907 L<Path::Class::Dir> object.
911 $c->path_to( 'db', 'sqlite.db' );
916 my ( $c, @path ) = @_;
917 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
918 if ( -d $path ) { return $path }
919 else { return Path::Class::File->new( $c->config->{home}, @path ) }
922 =head2 $c->plugin( $name, $class, @args )
924 Helper method for plugins. It creates a class data accessor/mutator and
925 loads and instantiates the given class.
927 MyApp->plugin( 'prototype', 'HTML::Prototype' );
929 $c->prototype->define_javascript_functions;
931 B<Note:> This method of adding plugins is deprecated. The ability
932 to add plugins like this B<will be removed> in a Catalyst 5.81.
933 Please do not use this functionality in new code.
938 my ( $class, $name, $plugin, @args ) = @_;
940 # See block comment in t/unit_core_plugin.t
941 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
943 $class->_register_plugin( $plugin, 1 );
945 eval { $plugin->import };
946 $class->mk_classdata($name);
948 eval { $obj = $plugin->new(@args) };
951 Catalyst::Exception->throw( message =>
952 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
956 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
962 Initializes the dispatcher and engine, loads any plugins, and loads the
963 model, view, and controller components. You may also specify an array
964 of plugins to load here, if you choose to not load them in the C<use
968 MyApp->setup( qw/-Debug/ );
973 my ( $class, @arguments ) = @_;
974 croak('Running setup more than once')
975 if ( $class->setup_finished );
977 unless ( $class->isa('Catalyst') ) {
979 Catalyst::Exception->throw(
980 message => qq/'$class' does not inherit from Catalyst/ );
983 if ( $class->arguments ) {
984 @arguments = ( @arguments, @{ $class->arguments } );
990 foreach (@arguments) {
994 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
996 elsif (/^-(\w+)=?(.*)$/) {
997 $flags->{ lc $1 } = $2;
1000 push @{ $flags->{plugins} }, $_;
1004 $class->setup_home( delete $flags->{home} );
1006 $class->setup_log( delete $flags->{log} );
1007 $class->setup_plugins( delete $flags->{plugins} );
1008 $class->setup_dispatcher( delete $flags->{dispatcher} );
1009 $class->setup_engine( delete $flags->{engine} );
1010 $class->setup_stats( delete $flags->{stats} );
1012 for my $flag ( sort keys %{$flags} ) {
1014 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1015 &$code( $class, delete $flags->{$flag} );
1018 $class->log->warn(qq/Unknown flag "$flag"/);
1022 eval { require Catalyst::Devel; };
1023 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1024 $class->log->warn(<<"EOF");
1025 You are running an old script!
1027 Please update by running (this will overwrite existing files):
1028 catalyst.pl -force -scripts $class
1030 or (this will not overwrite existing files):
1031 catalyst.pl -scripts $class
1036 if ( $class->debug ) {
1037 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1040 my $column_width = Catalyst::Utils::term_width() - 6;
1041 my $t = Text::SimpleTable->new($column_width);
1042 $t->row($_) for @plugins;
1043 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1046 my $dispatcher = $class->dispatcher;
1047 my $engine = $class->engine;
1048 my $home = $class->config->{home};
1050 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1051 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1055 ? $class->log->debug(qq/Found home "$home"/)
1056 : $class->log->debug(qq/Home "$home" doesn't exist/)
1057 : $class->log->debug(q/Couldn't find home/);
1060 # Call plugins setup, this is stupid and evil.
1061 # Also screws C3 badly on 5.10, hack to avoid.
1063 no warnings qw/redefine/;
1064 local *setup = sub { };
1065 $class->setup unless $Catalyst::__AM_RESTARTING;
1068 # Initialize our data structure
1069 $class->components( {} );
1071 $class->setup_components;
1073 if ( $class->debug ) {
1074 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1075 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1076 for my $comp ( sort keys %{ $class->components } ) {
1077 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1078 $t->row( $comp, $type );
1080 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1081 if ( keys %{ $class->components } );
1084 # Add our self to components, since we are also a component
1085 if( $class->isa('Catalyst::Controller') ){
1086 $class->components->{$class} = $class;
1089 $class->setup_actions;
1091 if ( $class->debug ) {
1092 my $name = $class->config->{name} || 'Application';
1093 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1095 $class->log->_flush() if $class->log->can('_flush');
1097 # Make sure that the application class becomes immutable at this point,
1098 # which ensures that it gets an inlined constructor. This means that it
1099 # works even if the user has added a plugin which contains a new method.
1100 # Note however that we have to do the work on scope end, so that method
1101 # modifiers work correctly in MyApp (as you have to call setup _before_
1102 # applying modifiers).
1103 Scope::Upper::reap(sub {
1104 my $meta = Class::MOP::get_metaclass_by_name($class);
1105 $meta->make_immutable(replace_constructor => 1) unless $meta->is_immutable;
1106 }, Scope::Upper::SCOPE(1));
1108 $class->setup_finalize;
1112 =head2 $app->setup_finalize
1114 A hook to attach modifiers to.
1115 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1116 Also better than C< setup_finished(); >, as that is a getter method.
1118 sub setup_finalize {
1122 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1124 $app->next::method(@_);
1131 sub setup_finalize {
1133 $class->setup_finished(1);
1136 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1138 =head2 $c->uri_for( $path, @args?, \%query_values? )
1144 A Catalyst::Action object representing the Catalyst action you want to
1145 create a URI for. To get one for an action in the current controller,
1146 use C<< $c->action('someactionname') >>. To get one from different
1147 controller, fetch the controller using C<< $c->controller() >>, then
1148 call C<action_for> on it.
1150 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1151 using C<< $c->req->captures >>.
1153 # For the current action
1154 $c->uri_for($c->action, $c->req->captures);
1156 # For the Foo action in the Bar controller
1157 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1164 my ( $c, $path, @args ) = @_;
1166 if ( blessed($path) ) { # action object
1167 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1171 $path = $c->dispatcher->uri_for_action($action, $captures);
1172 if (not defined $path) {
1173 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1177 $path = '/' if $path eq '';
1180 undef($path) if (defined $path && $path eq '');
1183 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1185 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1186 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1188 unshift(@args, $path);
1190 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1191 my $namespace = $c->namespace;
1192 if (defined $path) { # cheesy hack to handle path '../foo'
1193 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1195 unshift(@args, $namespace || '');
1198 # join args with '/', or a blank string
1199 my $args = join('/', grep { defined($_) } @args);
1200 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1202 my $base = $c->req->base;
1203 my $class = ref($base);
1204 $base =~ s{(?<!/)$}{/};
1208 if (my @keys = keys %$params) {
1209 # somewhat lifted from URI::_query's query_form
1210 $query = '?'.join('&', map {
1211 my $val = $params->{$_};
1212 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1215 $val = '' unless defined $val;
1218 utf8::encode( $_ ) if utf8::is_utf8($_);
1219 # using the URI::Escape pattern here so utf8 chars survive
1220 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1222 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1226 my $res = bless(\"${base}${args}${query}", $class);
1230 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1232 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1238 A private path to the Catalyst action you want to create a URI for.
1240 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1241 >> and passing the resulting C<$action> and the remaining arguments to C<<
1244 You can also pass in a Catalyst::Action object, in which case it is passed to
1251 sub uri_for_action {
1252 my ( $c, $path, @args ) = @_;
1253 my $action = blessed($path)
1255 : $c->dispatcher->get_action_by_path($path);
1256 unless (defined $action) {
1257 croak "Can't find action for path '$path'";
1259 return $c->uri_for( $action, @args );
1262 =head2 $c->welcome_message
1264 Returns the Catalyst welcome HTML page.
1268 sub welcome_message {
1270 my $name = $c->config->{name};
1271 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1272 my $prefix = Catalyst::Utils::appprefix( ref $c );
1273 $c->response->content_type('text/html; charset=utf-8');
1275 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1276 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1277 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1279 <meta http-equiv="Content-Language" content="en" />
1280 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1281 <title>$name on Catalyst $VERSION</title>
1282 <style type="text/css">
1285 background-color: #eee;
1292 margin-bottom: 10px;
1294 background-color: #ccc;
1295 border: 1px solid #aaa;
1300 font-family: verdana, tahoma, sans-serif;
1303 font-family: verdana, tahoma, sans-serif;
1306 text-decoration: none;
1308 border-bottom: 1px dotted #bbb;
1310 :link:hover, :visited:hover {
1323 background-color: #fff;
1324 border: 1px solid #aaa;
1328 font-weight: normal;
1350 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1355 <img src="$logo" alt="Catalyst Logo" />
1357 <p>Welcome to the world of Catalyst.
1358 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1359 framework will make web development something you had
1360 never expected it to be: Fun, rewarding, and quick.</p>
1361 <h2>What to do now?</h2>
1362 <p>That really depends on what <b>you</b> want to do.
1363 We do, however, provide you with a few starting points.</p>
1364 <p>If you want to jump right into web development with Catalyst
1365 you might want to start with a tutorial.</p>
1366 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1368 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1370 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1371 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1373 <h2>What to do next?</h2>
1374 <p>Next it's time to write an actual application. Use the
1375 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1376 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1377 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1378 they can save you a lot of work.</p>
1379 <pre><code>script/${prefix}_create.pl -help</code></pre>
1380 <p>Also, be sure to check out the vast and growing
1381 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1382 you are likely to find what you need there.
1386 <p>Catalyst has a very active community. Here are the main places to
1387 get in touch with us.</p>
1390 <a href="http://dev.catalyst.perl.org">Wiki</a>
1393 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1396 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1399 <h2>In conclusion</h2>
1400 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1401 as we enjoyed making it. Please contact us if you have ideas
1402 for improvement or other feedback.</p>
1410 =head1 INTERNAL METHODS
1412 These methods are not meant to be used by end users.
1414 =head2 $c->components
1416 Returns a hash of components.
1418 =head2 $c->context_class
1420 Returns or sets the context class.
1424 Returns a hashref containing coderefs and execution counts (needed for
1425 deep recursion detection).
1429 Returns the number of actions on the current internal execution stack.
1433 Dispatches a request to actions.
1437 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1439 =head2 $c->dispatcher_class
1441 Returns or sets the dispatcher class.
1443 =head2 $c->dump_these
1445 Returns a list of 2-element array references (name, structure) pairs
1446 that will be dumped on the error page in debug mode.
1452 [ Request => $c->req ],
1453 [ Response => $c->res ],
1454 [ Stash => $c->stash ],
1455 [ Config => $c->config ];
1458 =head2 $c->engine_class
1460 Returns or sets the engine class.
1462 =head2 $c->execute( $class, $coderef )
1464 Execute a coderef in given class and catch exceptions. Errors are available
1470 my ( $c, $class, $code ) = @_;
1471 $class = $c->component($class) || $class;
1474 if ( $c->depth >= $RECURSION ) {
1475 my $action = $code->reverse();
1476 $action = "/$action" unless $action =~ /->/;
1477 my $error = qq/Deep recursion detected calling "${action}"/;
1478 $c->log->error($error);
1484 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1486 push( @{ $c->stack }, $code );
1488 no warnings 'recursion';
1489 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1491 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1493 my $last = pop( @{ $c->stack } );
1495 if ( my $error = $@ ) {
1496 if ( !ref($error) and $error eq $DETACH ) {
1497 die $DETACH if($c->depth > 1);
1499 elsif ( !ref($error) and $error eq $GO ) {
1500 die $GO if($c->depth > 0);
1503 unless ( ref $error ) {
1504 no warnings 'uninitialized';
1506 my $class = $last->class;
1507 my $name = $last->name;
1508 $error = qq/Caught exception in $class->$name "$error"/;
1517 sub _stats_start_execute {
1518 my ( $c, $code ) = @_;
1520 return if ( ( $code->name =~ /^_.*/ )
1521 && ( !$c->config->{show_internal_actions} ) );
1523 my $action_name = $code->reverse();
1524 $c->counter->{$action_name}++;
1526 my $action = $action_name;
1527 $action = "/$action" unless $action =~ /->/;
1529 # determine if the call was the result of a forward
1530 # this is done by walking up the call stack and looking for a calling
1531 # sub of Catalyst::forward before the eval
1533 for my $index ( 2 .. 11 ) {
1535 if ( ( caller($index) )[0] eq 'Catalyst'
1536 && ( caller($index) )[3] eq '(eval)' );
1538 if ( ( caller($index) )[3] =~ /forward$/ ) {
1539 $callsub = ( caller($index) )[3];
1540 $action = "-> $action";
1545 my $uid = $action_name . $c->counter->{$action_name};
1547 # is this a root-level call or a forwarded call?
1548 if ( $callsub =~ /forward$/ ) {
1550 # forward, locate the caller
1551 if ( my $parent = $c->stack->[-1] ) {
1554 parent => "$parent" . $c->counter->{"$parent"},
1560 # forward with no caller may come from a plugin
1579 sub _stats_finish_execute {
1580 my ( $c, $info ) = @_;
1581 $c->stats->profile( end => $info );
1584 =head2 $c->_localize_fields( sub { }, \%keys );
1588 #Why does this exist? This is no longer safe and WILL NOT WORK.
1589 # it doesnt seem to be used anywhere. can we remove it?
1590 sub _localize_fields {
1591 my ( $c, $localized, $code ) = ( @_ );
1593 my $request = delete $localized->{request} || {};
1594 my $response = delete $localized->{response} || {};
1596 local @{ $c }{ keys %$localized } = values %$localized;
1597 local @{ $c->request }{ keys %$request } = values %$request;
1598 local @{ $c->response }{ keys %$response } = values %$response;
1605 Finalizes the request.
1612 for my $error ( @{ $c->error } ) {
1613 $c->log->error($error);
1616 # Allow engine to handle finalize flow (for POE)
1617 my $engine = $c->engine;
1618 if ( my $code = $engine->can('finalize') ) {
1623 $c->finalize_uploads;
1626 if ( $#{ $c->error } >= 0 ) {
1630 $c->finalize_headers;
1633 if ( $c->request->method eq 'HEAD' ) {
1634 $c->response->body('');
1640 if ($c->use_stats) {
1641 my $elapsed = sprintf '%f', $c->stats->elapsed;
1642 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1644 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1647 return $c->response->status;
1650 =head2 $c->finalize_body
1656 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1658 =head2 $c->finalize_cookies
1664 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1666 =head2 $c->finalize_error
1672 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1674 =head2 $c->finalize_headers
1680 sub finalize_headers {
1683 my $response = $c->response; #accessor calls can add up?
1685 # Check if we already finalized headers
1686 return if $response->finalized_headers;
1689 if ( my $location = $response->redirect ) {
1690 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1691 $response->header( Location => $location );
1693 if ( !$response->has_body ) {
1694 # Add a default body if none is already present
1696 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1702 if ( $response->body && !$response->content_length ) {
1704 # get the length from a filehandle
1705 if ( blessed( $response->body ) && $response->body->can('read') )
1707 my $stat = stat $response->body;
1708 if ( $stat && $stat->size > 0 ) {
1709 $response->content_length( $stat->size );
1712 $c->log->warn('Serving filehandle without a content-length');
1716 # everything should be bytes at this point, but just in case
1717 $response->content_length( bytes::length( $response->body ) );
1722 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1723 $response->headers->remove_header("Content-Length");
1724 $response->body('');
1727 $c->finalize_cookies;
1729 $c->engine->finalize_headers( $c, @_ );
1732 $response->finalized_headers(1);
1735 =head2 $c->finalize_output
1737 An alias for finalize_body.
1739 =head2 $c->finalize_read
1741 Finalizes the input after reading is complete.
1745 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1747 =head2 $c->finalize_uploads
1749 Finalizes uploads. Cleans up any temporary files.
1753 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1755 =head2 $c->get_action( $action, $namespace )
1757 Gets an action in a given namespace.
1761 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1763 =head2 $c->get_actions( $action, $namespace )
1765 Gets all actions of a given name in a namespace and all parent
1770 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1772 =head2 $c->handle_request( $class, @arguments )
1774 Called to handle each HTTP request.
1778 sub handle_request {
1779 my ( $class, @arguments ) = @_;
1781 # Always expect worst case!
1784 if ($class->debug) {
1785 my $secs = time - $START || 1;
1786 my $av = sprintf '%.3f', $COUNT / $secs;
1787 my $time = localtime time;
1788 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1791 my $c = $class->prepare(@arguments);
1793 $status = $c->finalize;
1796 if ( my $error = $@ ) {
1798 $class->log->error(qq/Caught exception in engine "$error"/);
1803 if(my $coderef = $class->log->can('_flush')){
1804 $class->log->$coderef();
1809 =head2 $c->prepare( @arguments )
1811 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1817 my ( $class, @arguments ) = @_;
1820 # After the app/ctxt split, this should become an attribute based on something passed
1821 # into the application.
1822 $class->context_class( ref $class || $class ) unless $class->context_class;
1824 my $c = $class->context_class->new({});
1826 # For on-demand data
1827 $c->request->_context($c);
1828 $c->response->_context($c);
1830 #surely this is not the most efficient way to do things...
1831 $c->stats($class->stats_class->new)->enable($c->use_stats);
1833 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1836 #XXX reuse coderef from can
1837 # Allow engine to direct the prepare flow (for POE)
1838 if ( $c->engine->can('prepare') ) {
1839 $c->engine->prepare( $c, @arguments );
1842 $c->prepare_request(@arguments);
1843 $c->prepare_connection;
1844 $c->prepare_query_parameters;
1845 $c->prepare_headers;
1846 $c->prepare_cookies;
1849 # Prepare the body for reading, either by prepare_body
1850 # or the user, if they are using $c->read
1853 # Parse the body unless the user wants it on-demand
1854 unless ( $c->config->{parse_on_demand} ) {
1859 my $method = $c->req->method || '';
1860 my $path = $c->req->path;
1861 $path = '/' unless length $path;
1862 my $address = $c->req->address || '';
1864 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1872 =head2 $c->prepare_action
1874 Prepares action. See L<Catalyst::Dispatcher>.
1878 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1880 =head2 $c->prepare_body
1882 Prepares message body.
1889 return if $c->request->_has_body;
1891 # Initialize on-demand data
1892 $c->engine->prepare_body( $c, @_ );
1893 $c->prepare_parameters;
1894 $c->prepare_uploads;
1896 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1897 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1898 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1899 my $param = $c->req->body_parameters->{$key};
1900 my $value = defined($param) ? $param : '';
1902 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1904 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1908 =head2 $c->prepare_body_chunk( $chunk )
1910 Prepares a chunk of data before sending it to L<HTTP::Body>.
1912 See L<Catalyst::Engine>.
1916 sub prepare_body_chunk {
1918 $c->engine->prepare_body_chunk( $c, @_ );
1921 =head2 $c->prepare_body_parameters
1923 Prepares body parameters.
1927 sub prepare_body_parameters {
1929 $c->engine->prepare_body_parameters( $c, @_ );
1932 =head2 $c->prepare_connection
1934 Prepares connection.
1938 sub prepare_connection {
1940 $c->engine->prepare_connection( $c, @_ );
1943 =head2 $c->prepare_cookies
1949 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1951 =head2 $c->prepare_headers
1957 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1959 =head2 $c->prepare_parameters
1961 Prepares parameters.
1965 sub prepare_parameters {
1967 $c->prepare_body_parameters;
1968 $c->engine->prepare_parameters( $c, @_ );
1971 =head2 $c->prepare_path
1973 Prepares path and base.
1977 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1979 =head2 $c->prepare_query_parameters
1981 Prepares query parameters.
1985 sub prepare_query_parameters {
1988 $c->engine->prepare_query_parameters( $c, @_ );
1990 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1991 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1992 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1993 my $param = $c->req->query_parameters->{$key};
1994 my $value = defined($param) ? $param : '';
1996 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1998 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2002 =head2 $c->prepare_read
2004 Prepares the input for reading.
2008 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2010 =head2 $c->prepare_request
2012 Prepares the engine request.
2016 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2018 =head2 $c->prepare_uploads
2024 sub prepare_uploads {
2027 $c->engine->prepare_uploads( $c, @_ );
2029 if ( $c->debug && keys %{ $c->request->uploads } ) {
2030 my $t = Text::SimpleTable->new(
2031 [ 12, 'Parameter' ],
2036 for my $key ( sort keys %{ $c->request->uploads } ) {
2037 my $upload = $c->request->uploads->{$key};
2038 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2039 $t->row( $key, $u->filename, $u->type, $u->size );
2042 $c->log->debug( "File Uploads are:\n" . $t->draw );
2046 =head2 $c->prepare_write
2048 Prepares the output for writing.
2052 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2054 =head2 $c->request_class
2056 Returns or sets the request class.
2058 =head2 $c->response_class
2060 Returns or sets the response class.
2062 =head2 $c->read( [$maxlength] )
2064 Reads a chunk of data from the request body. This method is designed to
2065 be used in a while loop, reading C<$maxlength> bytes on every call.
2066 C<$maxlength> defaults to the size of the request if not specified.
2068 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2071 Warning: If you use read(), Catalyst will not process the body,
2072 so you will not be able to access POST parameters or file uploads via
2073 $c->request. You must handle all body parsing yourself.
2077 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2085 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2087 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2089 Sets an action in a given namespace.
2093 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2095 =head2 $c->setup_actions($component)
2097 Sets up actions for a component.
2101 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2103 =head2 $c->setup_components
2105 Sets up components. Specify a C<setup_components> config option to pass
2106 additional options directly to L<Module::Pluggable>. To add additional
2107 search paths, specify a key named C<search_extra> as an array
2108 reference. Items in the array beginning with C<::> will have the
2109 application class name prepended to them.
2111 All components found will also have any
2112 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2113 Note, that modules which are B<not> an I<inner package> of the main
2114 file namespace loaded will not be instantiated as components.
2118 sub setup_components {
2121 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2122 my $config = $class->config->{ setup_components };
2123 my $extra = delete $config->{ search_extra } || [];
2125 push @paths, @$extra;
2127 my $locator = Module::Pluggable::Object->new(
2128 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2132 my @comps = sort { length $a <=> length $b } $locator->plugins;
2133 my %comps = map { $_ => 1 } @comps;
2135 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2136 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2137 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2138 ) if $deprecated_component_names;
2140 for my $component ( @comps ) {
2142 # We pass ignore_loaded here so that overlay files for (e.g.)
2143 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2144 # we know M::P::O found a file on disk so this is safe
2146 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2147 #Class::MOP::load_class($component);
2149 my $module = $class->setup_component( $component );
2151 $component => $module,
2153 $_ => $class->setup_component( $_ )
2155 not exists $comps{$_}
2156 } Devel::InnerPackage::list_packages( $component )
2159 for my $key ( keys %modules ) {
2160 $class->components->{ $key } = $modules{ $key };
2165 =head2 $c->setup_component
2169 sub _controller_init_base_classes {
2170 my ($app_class, $component) = @_;
2171 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2172 next unless $class =~ /^$app_class/;
2173 Moose->init_meta( for_class => $class )
2174 unless find_meta($class);
2178 sub setup_component {
2179 my( $class, $component ) = @_;
2181 unless ( $component->can( 'COMPONENT' ) ) {
2185 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2186 # nearest to Catalyst::Controller first, no matter what order stuff happens
2187 # to be loaded. There are TODO tests in Moose for this, see
2188 # f2391d17574eff81d911b97be15ea51080500003
2189 if ($component->isa('Catalyst::Controller')) {
2190 $class->_controller_init_base_classes($component);
2193 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2194 my $config = $class->config->{ $suffix } || {};
2196 my $instance = eval { $component->COMPONENT( $class, $config ); };
2198 if ( my $error = $@ ) {
2200 Catalyst::Exception->throw(
2201 message => qq/Couldn't instantiate component "$component", "$error"/
2205 unless (blessed $instance) {
2206 my $metaclass = Moose::Util::find_meta($component);
2207 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2208 my $component_method_from = $method_meta->associated_metaclass->name;
2209 my $value = defined($instance) ? $instance : 'undef';
2210 Catalyst::Exception->throw(
2212 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2218 =head2 $c->setup_dispatcher
2224 sub setup_dispatcher {
2225 my ( $class, $dispatcher ) = @_;
2228 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2231 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2232 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2235 unless ($dispatcher) {
2236 $dispatcher = $class->dispatcher_class;
2239 Class::MOP::load_class($dispatcher);
2241 # dispatcher instance
2242 $class->dispatcher( $dispatcher->new );
2245 =head2 $c->setup_engine
2252 my ( $class, $engine ) = @_;
2255 $engine = 'Catalyst::Engine::' . $engine;
2258 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2259 $engine = 'Catalyst::Engine::' . $env;
2262 if ( $ENV{MOD_PERL} ) {
2263 my $meta = Class::MOP::get_metaclass_by_name($class);
2265 # create the apache method
2266 $meta->add_method('apache' => sub { shift->engine->apache });
2268 my ( $software, $version ) =
2269 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2272 $version =~ s/(\.[^.]+)\./$1/g;
2274 if ( $software eq 'mod_perl' ) {
2278 if ( $version >= 1.99922 ) {
2279 $engine = 'Catalyst::Engine::Apache2::MP20';
2282 elsif ( $version >= 1.9901 ) {
2283 $engine = 'Catalyst::Engine::Apache2::MP19';
2286 elsif ( $version >= 1.24 ) {
2287 $engine = 'Catalyst::Engine::Apache::MP13';
2291 Catalyst::Exception->throw( message =>
2292 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2297 # install the correct mod_perl handler
2298 if ( $version >= 1.9901 ) {
2299 *handler = sub : method {
2300 shift->handle_request(@_);
2304 *handler = sub ($$) { shift->handle_request(@_) };
2309 elsif ( $software eq 'Zeus-Perl' ) {
2310 $engine = 'Catalyst::Engine::Zeus';
2314 Catalyst::Exception->throw(
2315 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2320 $engine = $class->engine_class;
2323 Class::MOP::load_class($engine);
2325 # check for old engines that are no longer compatible
2327 if ( $engine->isa('Catalyst::Engine::Apache')
2328 && !Catalyst::Engine::Apache->VERSION )
2333 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2334 && Catalyst::Engine::Server->VERSION le '0.02' )
2339 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2340 && $engine->VERSION eq '0.01' )
2345 elsif ($engine->isa('Catalyst::Engine::Zeus')
2346 && $engine->VERSION eq '0.01' )
2352 Catalyst::Exception->throw( message =>
2353 qq/Engine "$engine" is not supported by this version of Catalyst/
2358 $class->engine( $engine->new );
2361 =head2 $c->setup_home
2363 Sets up the home directory.
2368 my ( $class, $home ) = @_;
2370 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2374 $home ||= Catalyst::Utils::home($class);
2377 #I remember recently being scolded for assigning config values like this
2378 $class->config->{home} ||= $home;
2379 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2383 =head2 $c->setup_log
2385 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2386 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2389 This method also installs a C<debug> method that returns a true value into the
2390 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2391 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2393 Note that if the log has already been setup, by either a previous call to
2394 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2395 that this method won't actually set up the log object.
2400 my ( $class, $levels ) = @_;
2403 $levels =~ s/^\s+//;
2404 $levels =~ s/\s+$//;
2405 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2407 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2408 if ( defined $env_debug ) {
2409 $levels{debug} = 1 if $env_debug; # Ugly!
2410 delete($levels{debug}) unless $env_debug;
2413 unless ( $class->log ) {
2414 $class->log( Catalyst::Log->new(keys %levels) );
2417 if ( $levels{debug} ) {
2418 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2419 $class->log->debug('Debug messages enabled');
2423 =head2 $c->setup_plugins
2429 =head2 $c->setup_stats
2431 Sets up timing statistics class.
2436 my ( $class, $stats ) = @_;
2438 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2440 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2441 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2442 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2443 $class->log->debug('Statistics enabled');
2448 =head2 $c->registered_plugins
2450 Returns a sorted list of the plugins which have either been stated in the
2451 import list or which have been added via C<< MyApp->plugin(@args); >>.
2453 If passed a given plugin name, it will report a boolean value indicating
2454 whether or not that plugin is loaded. A fully qualified name is required if
2455 the plugin name does not begin with C<Catalyst::Plugin::>.
2457 if ($c->registered_plugins('Some::Plugin')) {
2465 sub registered_plugins {
2467 return sort keys %{ $proto->_plugins } unless @_;
2469 return 1 if exists $proto->_plugins->{$plugin};
2470 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2473 sub _register_plugin {
2474 my ( $proto, $plugin, $instant ) = @_;
2475 my $class = ref $proto || $proto;
2477 # no ignore_loaded here, the plugin may already have been
2478 # defined in memory and we don't want to error on "no file" if so
2480 Class::MOP::load_class( $plugin );
2482 $proto->_plugins->{$plugin} = 1;
2485 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2486 my @superclasses = ($plugin, $meta->superclasses );
2487 $meta->superclasses(@superclasses);
2489 unshift @{"$class\::ISA"}, $plugin;
2496 my ( $class, $plugins ) = @_;
2498 $class->_plugins( {} ) unless $class->_plugins;
2500 for my $plugin ( reverse @$plugins ) {
2502 unless ( $plugin =~ s/\A\+// ) {
2503 $plugin = "Catalyst::Plugin::$plugin";
2506 $class->_register_plugin($plugin);
2513 Returns an arrayref of the internal execution stack (actions that are
2514 currently executing).
2516 =head2 $c->stats_class
2518 Returns or sets the stats (timing statistics) class.
2520 =head2 $c->use_stats
2522 Returns 1 when stats collection is enabled. Stats collection is enabled
2523 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2524 environment variable is set.
2526 Note that this is a static method, not an accessor and should be overridden
2527 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2534 =head2 $c->write( $data )
2536 Writes $data to the output stream. When using this method directly, you
2537 will need to manually set the C<Content-Length> header to the length of
2538 your output data, if known.
2545 # Finalize headers if someone manually writes output
2546 $c->finalize_headers;
2548 return $c->engine->write( $c, @_ );
2553 Returns the Catalyst version number. Mostly useful for "powered by"
2554 messages in template systems.
2558 sub version { return $Catalyst::VERSION }
2560 =head1 INTERNAL ACTIONS
2562 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2563 C<_ACTION>, and C<_END>. These are by default not shown in the private
2564 action table, but you can make them visible with a config parameter.
2566 MyApp->config->{show_internal_actions} = 1;
2568 =head1 CASE SENSITIVITY
2570 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2571 mapped to C</foo/bar>. You can activate case sensitivity with a config
2574 MyApp->config->{case_sensitive} = 1;
2576 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2578 =head1 ON-DEMAND PARSER
2580 The request body is usually parsed at the beginning of a request,
2581 but if you want to handle input yourself, you can enable on-demand
2582 parsing with a config parameter.
2584 MyApp->config->{parse_on_demand} = 1;
2586 =head1 PROXY SUPPORT
2588 Many production servers operate using the common double-server approach,
2589 with a lightweight frontend web server passing requests to a larger
2590 backend server. An application running on the backend server must deal
2591 with two problems: the remote user always appears to be C<127.0.0.1> and
2592 the server's hostname will appear to be C<localhost> regardless of the
2593 virtual host that the user connected through.
2595 Catalyst will automatically detect this situation when you are running
2596 the frontend and backend servers on the same machine. The following
2597 changes are made to the request.
2599 $c->req->address is set to the user's real IP address, as read from
2600 the HTTP X-Forwarded-For header.
2602 The host value for $c->req->base and $c->req->uri is set to the real
2603 host, as read from the HTTP X-Forwarded-Host header.
2605 Obviously, your web server must support these headers for this to work.
2607 In a more complex server farm environment where you may have your
2608 frontend proxy server(s) on different machines, you will need to set a
2609 configuration option to tell Catalyst to read the proxied data from the
2612 MyApp->config->{using_frontend_proxy} = 1;
2614 If you do not wish to use the proxy support at all, you may set:
2616 MyApp->config->{ignore_frontend_proxy} = 1;
2618 =head1 THREAD SAFETY
2620 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2621 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2622 believe the Catalyst core to be thread-safe.
2624 If you plan to operate in a threaded environment, remember that all other
2625 modules you are using must also be thread-safe. Some modules, most notably
2626 L<DBD::SQLite>, are not thread-safe.
2632 Join #catalyst on irc.perl.org.
2636 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2637 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2641 http://catalyst.perl.org
2645 http://dev.catalyst.perl.org
2649 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2651 =head2 L<Catalyst::Manual> - The Catalyst Manual
2653 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2655 =head2 L<Catalyst::Engine> - Core engine
2657 =head2 L<Catalyst::Log> - Log class.
2659 =head2 L<Catalyst::Request> - Request object
2661 =head2 L<Catalyst::Response> - Response object
2663 =head2 L<Catalyst::Test> - The test suite.
2665 =head1 PROJECT FOUNDER
2667 sri: Sebastian Riedel <sri@cpan.org>
2673 acme: Leon Brocard <leon@astray.com>
2681 andyg: Andy Grundman <andy@hybridized.org>
2683 audreyt: Audrey Tang
2685 bricas: Brian Cassidy <bricas@cpan.org>
2687 Caelum: Rafael Kitover <rkitover@io.com>
2689 chansen: Christian Hansen
2691 chicks: Christopher Hicks
2695 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2699 esskar: Sascha Kiefer
2701 fireartist: Carl Franks <cfranks@cpan.org>
2703 gabb: Danijel Milicevic
2709 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2711 jcamacho: Juan Camacho
2713 jhannah: Jay Hannah <jay@jays.net>
2719 jon: Jon Schutz <jjschutz@cpan.org>
2721 marcus: Marcus Ramberg <mramberg@cpan.org>
2723 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2725 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2729 naughton: David Naughton
2731 ningu: David Kamholz <dkamholz@cpan.org>
2733 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2735 numa: Dan Sully <daniel@cpan.org>
2739 omega: Andreas Marienborg
2741 Oleg Kostyuk <cub.uanic@gmail.com>
2743 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2745 rafl: Florian Ragwitz <rafl@debian.org>
2749 the_jester: Jesse Sheidlower
2751 t0m: Tomas Doran <bobtfish@bobtfish.net>
2755 willert: Sebastian Willert <willert@cpan.org>
2759 This library is free software, you can redistribute it and/or modify it under
2760 the same terms as Perl itself.
2766 __PACKAGE__->meta->make_immutable;