4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
8 use B::Hooks::EndOfScope ();
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.80005';
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. Note you can usually use this object as
908 a filename, but sometimes you will have to explicitly stringify it
909 yourself by calling the C<<->stringify>> method.
913 $c->path_to( 'db', 'sqlite.db' );
918 my ( $c, @path ) = @_;
919 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
920 if ( -d $path ) { return $path }
921 else { return Path::Class::File->new( $c->config->{home}, @path ) }
924 =head2 $c->plugin( $name, $class, @args )
926 Helper method for plugins. It creates a class data accessor/mutator and
927 loads and instantiates the given class.
929 MyApp->plugin( 'prototype', 'HTML::Prototype' );
931 $c->prototype->define_javascript_functions;
933 B<Note:> This method of adding plugins is deprecated. The ability
934 to add plugins like this B<will be removed> in a Catalyst 5.81.
935 Please do not use this functionality in new code.
940 my ( $class, $name, $plugin, @args ) = @_;
942 # See block comment in t/unit_core_plugin.t
943 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
945 $class->_register_plugin( $plugin, 1 );
947 eval { $plugin->import };
948 $class->mk_classdata($name);
950 eval { $obj = $plugin->new(@args) };
953 Catalyst::Exception->throw( message =>
954 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
958 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
964 Initializes the dispatcher and engine, loads any plugins, and loads the
965 model, view, and controller components. You may also specify an array
966 of plugins to load here, if you choose to not load them in the C<use
970 MyApp->setup( qw/-Debug/ );
975 my ( $class, @arguments ) = @_;
976 croak('Running setup more than once')
977 if ( $class->setup_finished );
979 unless ( $class->isa('Catalyst') ) {
981 Catalyst::Exception->throw(
982 message => qq/'$class' does not inherit from Catalyst/ );
985 if ( $class->arguments ) {
986 @arguments = ( @arguments, @{ $class->arguments } );
992 foreach (@arguments) {
996 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
998 elsif (/^-(\w+)=?(.*)$/) {
999 $flags->{ lc $1 } = $2;
1002 push @{ $flags->{plugins} }, $_;
1006 $class->setup_home( delete $flags->{home} );
1008 $class->setup_log( delete $flags->{log} );
1009 $class->setup_plugins( delete $flags->{plugins} );
1010 $class->setup_dispatcher( delete $flags->{dispatcher} );
1011 $class->setup_engine( delete $flags->{engine} );
1012 $class->setup_stats( delete $flags->{stats} );
1014 for my $flag ( sort keys %{$flags} ) {
1016 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1017 &$code( $class, delete $flags->{$flag} );
1020 $class->log->warn(qq/Unknown flag "$flag"/);
1024 eval { require Catalyst::Devel; };
1025 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1026 $class->log->warn(<<"EOF");
1027 You are running an old script!
1029 Please update by running (this will overwrite existing files):
1030 catalyst.pl -force -scripts $class
1032 or (this will not overwrite existing files):
1033 catalyst.pl -scripts $class
1038 if ( $class->debug ) {
1039 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1042 my $column_width = Catalyst::Utils::term_width() - 6;
1043 my $t = Text::SimpleTable->new($column_width);
1044 $t->row($_) for @plugins;
1045 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1048 my $dispatcher = $class->dispatcher;
1049 my $engine = $class->engine;
1050 my $home = $class->config->{home};
1052 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1053 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1057 ? $class->log->debug(qq/Found home "$home"/)
1058 : $class->log->debug(qq/Home "$home" doesn't exist/)
1059 : $class->log->debug(q/Couldn't find home/);
1062 # Call plugins setup, this is stupid and evil.
1063 # Also screws C3 badly on 5.10, hack to avoid.
1065 no warnings qw/redefine/;
1066 local *setup = sub { };
1067 $class->setup unless $Catalyst::__AM_RESTARTING;
1070 # Initialize our data structure
1071 $class->components( {} );
1073 $class->setup_components;
1075 if ( $class->debug ) {
1076 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1077 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1078 for my $comp ( sort keys %{ $class->components } ) {
1079 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1080 $t->row( $comp, $type );
1082 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1083 if ( keys %{ $class->components } );
1086 # Add our self to components, since we are also a component
1087 if( $class->isa('Catalyst::Controller') ){
1088 $class->components->{$class} = $class;
1091 $class->setup_actions;
1093 if ( $class->debug ) {
1094 my $name = $class->config->{name} || 'Application';
1095 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1097 $class->log->_flush() if $class->log->can('_flush');
1099 # Make sure that the application class becomes immutable at this point,
1100 # which ensures that it gets an inlined constructor. This means that it
1101 # works even if the user has added a plugin which contains a new method.
1102 # Note however that we have to do the work on scope end, so that method
1103 # modifiers work correctly in MyApp (as you have to call setup _before_
1104 # applying modifiers).
1105 B::Hooks::EndOfScope::on_scope_end {
1107 my $meta = Class::MOP::get_metaclass_by_name($class);
1108 if ( $meta->is_immutable && ! { $meta->immutable_options }->{inline_constructor} ) {
1109 warn "You made your application class ($class) immutable, "
1110 . "but did not inline the constructor.\n"
1111 . "This will break catalyst, please pass "
1112 . "(replace_constructor => 1) when making your class immutable.\n";
1114 $meta->make_immutable(replace_constructor => 1) unless $meta->is_immutable;
1117 $class->setup_finalize;
1121 =head2 $app->setup_finalize
1123 A hook to attach modifiers to.
1124 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1125 Also better than C< setup_finished(); >, as that is a getter method.
1127 sub setup_finalize {
1131 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1133 $app->next::method(@_);
1140 sub setup_finalize {
1142 $class->setup_finished(1);
1145 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1147 =head2 $c->uri_for( $path, @args?, \%query_values? )
1153 A Catalyst::Action object representing the Catalyst action you want to
1154 create a URI for. To get one for an action in the current controller,
1155 use C<< $c->action('someactionname') >>. To get one from different
1156 controller, fetch the controller using C<< $c->controller() >>, then
1157 call C<action_for> on it.
1159 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1160 using C<< $c->req->captures >>.
1162 # For the current action
1163 $c->uri_for($c->action, $c->req->captures);
1165 # For the Foo action in the Bar controller
1166 $c->uri_for($c->controller('Bar')->action_for('Foo'), $c->req->captures);
1173 my ( $c, $path, @args ) = @_;
1175 if ( blessed($path) ) { # action object
1176 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1180 $path = $c->dispatcher->uri_for_action($action, $captures);
1181 if (not defined $path) {
1182 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1186 $path = '/' if $path eq '';
1189 undef($path) if (defined $path && $path eq '');
1192 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1194 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1195 s/([^A-Za-z0-9\-_.!~*'()])/$URI::Escape::escapes{$1}/go for @args;
1197 unshift(@args, $path);
1199 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1200 my $namespace = $c->namespace;
1201 if (defined $path) { # cheesy hack to handle path '../foo'
1202 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1204 unshift(@args, $namespace || '');
1207 # join args with '/', or a blank string
1208 my $args = join('/', grep { defined($_) } @args);
1209 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1211 my $base = $c->req->base;
1212 my $class = ref($base);
1213 $base =~ s{(?<!/)$}{/};
1217 if (my @keys = keys %$params) {
1218 # somewhat lifted from URI::_query's query_form
1219 $query = '?'.join('&', map {
1220 my $val = $params->{$_};
1221 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1224 $val = '' unless defined $val;
1227 utf8::encode( $_ ) if utf8::is_utf8($_);
1228 # using the URI::Escape pattern here so utf8 chars survive
1229 s/([^A-Za-z0-9\-_.!~*'()])/$URI::Escape::escapes{$1}/go;
1231 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1235 my $res = bless(\"${base}${args}${query}", $class);
1239 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1241 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1247 A private path to the Catalyst action you want to create a URI for.
1249 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1250 >> and passing the resulting C<$action> and the remaining arguments to C<<
1253 You can also pass in a Catalyst::Action object, in which case it is passed to
1260 sub uri_for_action {
1261 my ( $c, $path, @args ) = @_;
1262 my $action = blessed($path)
1264 : $c->dispatcher->get_action_by_path($path);
1265 unless (defined $action) {
1266 croak "Can't find action for path '$path'";
1268 return $c->uri_for( $action, @args );
1271 =head2 $c->welcome_message
1273 Returns the Catalyst welcome HTML page.
1277 sub welcome_message {
1279 my $name = $c->config->{name};
1280 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1281 my $prefix = Catalyst::Utils::appprefix( ref $c );
1282 $c->response->content_type('text/html; charset=utf-8');
1284 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1285 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1286 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1288 <meta http-equiv="Content-Language" content="en" />
1289 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1290 <title>$name on Catalyst $VERSION</title>
1291 <style type="text/css">
1294 background-color: #eee;
1301 margin-bottom: 10px;
1303 background-color: #ccc;
1304 border: 1px solid #aaa;
1309 font-family: verdana, tahoma, sans-serif;
1312 font-family: verdana, tahoma, sans-serif;
1315 text-decoration: none;
1317 border-bottom: 1px dotted #bbb;
1319 :link:hover, :visited:hover {
1332 background-color: #fff;
1333 border: 1px solid #aaa;
1337 font-weight: normal;
1359 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1364 <img src="$logo" alt="Catalyst Logo" />
1366 <p>Welcome to the world of Catalyst.
1367 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1368 framework will make web development something you had
1369 never expected it to be: Fun, rewarding, and quick.</p>
1370 <h2>What to do now?</h2>
1371 <p>That really depends on what <b>you</b> want to do.
1372 We do, however, provide you with a few starting points.</p>
1373 <p>If you want to jump right into web development with Catalyst
1374 you might want to start with a tutorial.</p>
1375 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1377 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1379 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1380 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1382 <h2>What to do next?</h2>
1383 <p>Next it's time to write an actual application. Use the
1384 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1385 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1386 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1387 they can save you a lot of work.</p>
1388 <pre><code>script/${prefix}_create.pl -help</code></pre>
1389 <p>Also, be sure to check out the vast and growing
1390 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1391 you are likely to find what you need there.
1395 <p>Catalyst has a very active community. Here are the main places to
1396 get in touch with us.</p>
1399 <a href="http://dev.catalyst.perl.org">Wiki</a>
1402 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1405 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1408 <h2>In conclusion</h2>
1409 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1410 as we enjoyed making it. Please contact us if you have ideas
1411 for improvement or other feedback.</p>
1419 =head1 INTERNAL METHODS
1421 These methods are not meant to be used by end users.
1423 =head2 $c->components
1425 Returns a hash of components.
1427 =head2 $c->context_class
1429 Returns or sets the context class.
1433 Returns a hashref containing coderefs and execution counts (needed for
1434 deep recursion detection).
1438 Returns the number of actions on the current internal execution stack.
1442 Dispatches a request to actions.
1446 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1448 =head2 $c->dispatcher_class
1450 Returns or sets the dispatcher class.
1452 =head2 $c->dump_these
1454 Returns a list of 2-element array references (name, structure) pairs
1455 that will be dumped on the error page in debug mode.
1461 [ Request => $c->req ],
1462 [ Response => $c->res ],
1463 [ Stash => $c->stash ],
1464 [ Config => $c->config ];
1467 =head2 $c->engine_class
1469 Returns or sets the engine class.
1471 =head2 $c->execute( $class, $coderef )
1473 Execute a coderef in given class and catch exceptions. Errors are available
1479 my ( $c, $class, $code ) = @_;
1480 $class = $c->component($class) || $class;
1483 if ( $c->depth >= $RECURSION ) {
1484 my $action = $code->reverse();
1485 $action = "/$action" unless $action =~ /->/;
1486 my $error = qq/Deep recursion detected calling "${action}"/;
1487 $c->log->error($error);
1493 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1495 push( @{ $c->stack }, $code );
1497 no warnings 'recursion';
1498 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1500 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1502 my $last = pop( @{ $c->stack } );
1504 if ( my $error = $@ ) {
1505 if ( !ref($error) and $error eq $DETACH ) {
1506 die $DETACH if($c->depth > 1);
1508 elsif ( !ref($error) and $error eq $GO ) {
1509 die $GO if($c->depth > 0);
1512 unless ( ref $error ) {
1513 no warnings 'uninitialized';
1515 my $class = $last->class;
1516 my $name = $last->name;
1517 $error = qq/Caught exception in $class->$name "$error"/;
1526 sub _stats_start_execute {
1527 my ( $c, $code ) = @_;
1529 return if ( ( $code->name =~ /^_.*/ )
1530 && ( !$c->config->{show_internal_actions} ) );
1532 my $action_name = $code->reverse();
1533 $c->counter->{$action_name}++;
1535 my $action = $action_name;
1536 $action = "/$action" unless $action =~ /->/;
1538 # determine if the call was the result of a forward
1539 # this is done by walking up the call stack and looking for a calling
1540 # sub of Catalyst::forward before the eval
1542 for my $index ( 2 .. 11 ) {
1544 if ( ( caller($index) )[0] eq 'Catalyst'
1545 && ( caller($index) )[3] eq '(eval)' );
1547 if ( ( caller($index) )[3] =~ /forward$/ ) {
1548 $callsub = ( caller($index) )[3];
1549 $action = "-> $action";
1554 my $uid = $action_name . $c->counter->{$action_name};
1556 # is this a root-level call or a forwarded call?
1557 if ( $callsub =~ /forward$/ ) {
1559 # forward, locate the caller
1560 if ( my $parent = $c->stack->[-1] ) {
1563 parent => "$parent" . $c->counter->{"$parent"},
1569 # forward with no caller may come from a plugin
1588 sub _stats_finish_execute {
1589 my ( $c, $info ) = @_;
1590 $c->stats->profile( end => $info );
1593 =head2 $c->_localize_fields( sub { }, \%keys );
1597 #Why does this exist? This is no longer safe and WILL NOT WORK.
1598 # it doesnt seem to be used anywhere. can we remove it?
1599 sub _localize_fields {
1600 my ( $c, $localized, $code ) = ( @_ );
1602 my $request = delete $localized->{request} || {};
1603 my $response = delete $localized->{response} || {};
1605 local @{ $c }{ keys %$localized } = values %$localized;
1606 local @{ $c->request }{ keys %$request } = values %$request;
1607 local @{ $c->response }{ keys %$response } = values %$response;
1614 Finalizes the request.
1621 for my $error ( @{ $c->error } ) {
1622 $c->log->error($error);
1625 # Allow engine to handle finalize flow (for POE)
1626 my $engine = $c->engine;
1627 if ( my $code = $engine->can('finalize') ) {
1632 $c->finalize_uploads;
1635 if ( $#{ $c->error } >= 0 ) {
1639 $c->finalize_headers;
1642 if ( $c->request->method eq 'HEAD' ) {
1643 $c->response->body('');
1649 if ($c->use_stats) {
1650 my $elapsed = sprintf '%f', $c->stats->elapsed;
1651 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1653 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1656 return $c->response->status;
1659 =head2 $c->finalize_body
1665 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1667 =head2 $c->finalize_cookies
1673 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1675 =head2 $c->finalize_error
1681 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1683 =head2 $c->finalize_headers
1689 sub finalize_headers {
1692 my $response = $c->response; #accessor calls can add up?
1694 # Check if we already finalized headers
1695 return if $response->finalized_headers;
1698 if ( my $location = $response->redirect ) {
1699 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1700 $response->header( Location => $location );
1702 if ( !$response->has_body ) {
1703 # Add a default body if none is already present
1705 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1711 if ( $response->body && !$response->content_length ) {
1713 # get the length from a filehandle
1714 if ( blessed( $response->body ) && $response->body->can('read') )
1716 my $stat = stat $response->body;
1717 if ( $stat && $stat->size > 0 ) {
1718 $response->content_length( $stat->size );
1721 $c->log->warn('Serving filehandle without a content-length');
1725 # everything should be bytes at this point, but just in case
1726 $response->content_length( bytes::length( $response->body ) );
1731 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1732 $response->headers->remove_header("Content-Length");
1733 $response->body('');
1736 $c->finalize_cookies;
1738 $c->engine->finalize_headers( $c, @_ );
1741 $response->finalized_headers(1);
1744 =head2 $c->finalize_output
1746 An alias for finalize_body.
1748 =head2 $c->finalize_read
1750 Finalizes the input after reading is complete.
1754 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1756 =head2 $c->finalize_uploads
1758 Finalizes uploads. Cleans up any temporary files.
1762 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1764 =head2 $c->get_action( $action, $namespace )
1766 Gets an action in a given namespace.
1770 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1772 =head2 $c->get_actions( $action, $namespace )
1774 Gets all actions of a given name in a namespace and all parent
1779 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1781 =head2 $c->handle_request( $class, @arguments )
1783 Called to handle each HTTP request.
1787 sub handle_request {
1788 my ( $class, @arguments ) = @_;
1790 # Always expect worst case!
1793 if ($class->debug) {
1794 my $secs = time - $START || 1;
1795 my $av = sprintf '%.3f', $COUNT / $secs;
1796 my $time = localtime time;
1797 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1800 my $c = $class->prepare(@arguments);
1802 $status = $c->finalize;
1805 if ( my $error = $@ ) {
1807 $class->log->error(qq/Caught exception in engine "$error"/);
1812 if(my $coderef = $class->log->can('_flush')){
1813 $class->log->$coderef();
1818 =head2 $c->prepare( @arguments )
1820 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1826 my ( $class, @arguments ) = @_;
1829 # After the app/ctxt split, this should become an attribute based on something passed
1830 # into the application.
1831 $class->context_class( ref $class || $class ) unless $class->context_class;
1833 my $c = $class->context_class->new({});
1835 # For on-demand data
1836 $c->request->_context($c);
1837 $c->response->_context($c);
1839 #surely this is not the most efficient way to do things...
1840 $c->stats($class->stats_class->new)->enable($c->use_stats);
1842 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1845 #XXX reuse coderef from can
1846 # Allow engine to direct the prepare flow (for POE)
1847 if ( $c->engine->can('prepare') ) {
1848 $c->engine->prepare( $c, @arguments );
1851 $c->prepare_request(@arguments);
1852 $c->prepare_connection;
1853 $c->prepare_query_parameters;
1854 $c->prepare_headers;
1855 $c->prepare_cookies;
1858 # Prepare the body for reading, either by prepare_body
1859 # or the user, if they are using $c->read
1862 # Parse the body unless the user wants it on-demand
1863 unless ( $c->config->{parse_on_demand} ) {
1868 my $method = $c->req->method || '';
1869 my $path = $c->req->path;
1870 $path = '/' unless length $path;
1871 my $address = $c->req->address || '';
1873 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1881 =head2 $c->prepare_action
1883 Prepares action. See L<Catalyst::Dispatcher>.
1887 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1889 =head2 $c->prepare_body
1891 Prepares message body.
1898 return if $c->request->_has_body;
1900 # Initialize on-demand data
1901 $c->engine->prepare_body( $c, @_ );
1902 $c->prepare_parameters;
1903 $c->prepare_uploads;
1905 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1906 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1907 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1908 my $param = $c->req->body_parameters->{$key};
1909 my $value = defined($param) ? $param : '';
1911 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1913 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1917 =head2 $c->prepare_body_chunk( $chunk )
1919 Prepares a chunk of data before sending it to L<HTTP::Body>.
1921 See L<Catalyst::Engine>.
1925 sub prepare_body_chunk {
1927 $c->engine->prepare_body_chunk( $c, @_ );
1930 =head2 $c->prepare_body_parameters
1932 Prepares body parameters.
1936 sub prepare_body_parameters {
1938 $c->engine->prepare_body_parameters( $c, @_ );
1941 =head2 $c->prepare_connection
1943 Prepares connection.
1947 sub prepare_connection {
1949 $c->engine->prepare_connection( $c, @_ );
1952 =head2 $c->prepare_cookies
1958 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1960 =head2 $c->prepare_headers
1966 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1968 =head2 $c->prepare_parameters
1970 Prepares parameters.
1974 sub prepare_parameters {
1976 $c->prepare_body_parameters;
1977 $c->engine->prepare_parameters( $c, @_ );
1980 =head2 $c->prepare_path
1982 Prepares path and base.
1986 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1988 =head2 $c->prepare_query_parameters
1990 Prepares query parameters.
1994 sub prepare_query_parameters {
1997 $c->engine->prepare_query_parameters( $c, @_ );
1999 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2000 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2001 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2002 my $param = $c->req->query_parameters->{$key};
2003 my $value = defined($param) ? $param : '';
2005 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2007 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2011 =head2 $c->prepare_read
2013 Prepares the input for reading.
2017 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2019 =head2 $c->prepare_request
2021 Prepares the engine request.
2025 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2027 =head2 $c->prepare_uploads
2033 sub prepare_uploads {
2036 $c->engine->prepare_uploads( $c, @_ );
2038 if ( $c->debug && keys %{ $c->request->uploads } ) {
2039 my $t = Text::SimpleTable->new(
2040 [ 12, 'Parameter' ],
2045 for my $key ( sort keys %{ $c->request->uploads } ) {
2046 my $upload = $c->request->uploads->{$key};
2047 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2048 $t->row( $key, $u->filename, $u->type, $u->size );
2051 $c->log->debug( "File Uploads are:\n" . $t->draw );
2055 =head2 $c->prepare_write
2057 Prepares the output for writing.
2061 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2063 =head2 $c->request_class
2065 Returns or sets the request class.
2067 =head2 $c->response_class
2069 Returns or sets the response class.
2071 =head2 $c->read( [$maxlength] )
2073 Reads a chunk of data from the request body. This method is designed to
2074 be used in a while loop, reading C<$maxlength> bytes on every call.
2075 C<$maxlength> defaults to the size of the request if not specified.
2077 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2080 Warning: If you use read(), Catalyst will not process the body,
2081 so you will not be able to access POST parameters or file uploads via
2082 $c->request. You must handle all body parsing yourself.
2086 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2094 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2096 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2098 Sets an action in a given namespace.
2102 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2104 =head2 $c->setup_actions($component)
2106 Sets up actions for a component.
2110 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2112 =head2 $c->setup_components
2114 Sets up components. Specify a C<setup_components> config option to pass
2115 additional options directly to L<Module::Pluggable>. To add additional
2116 search paths, specify a key named C<search_extra> as an array
2117 reference. Items in the array beginning with C<::> will have the
2118 application class name prepended to them.
2120 All components found will also have any
2121 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2122 Note, that modules which are B<not> an I<inner package> of the main
2123 file namespace loaded will not be instantiated as components.
2127 sub setup_components {
2130 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2131 my $config = $class->config->{ setup_components };
2132 my $extra = delete $config->{ search_extra } || [];
2134 push @paths, @$extra;
2136 my $locator = Module::Pluggable::Object->new(
2137 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2141 my @comps = sort { length $a <=> length $b } $locator->plugins;
2142 my %comps = map { $_ => 1 } @comps;
2144 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2145 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2146 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2147 ) if $deprecated_component_names;
2149 for my $component ( @comps ) {
2151 # We pass ignore_loaded here so that overlay files for (e.g.)
2152 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2153 # we know M::P::O found a file on disk so this is safe
2155 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2156 #Class::MOP::load_class($component);
2158 my $module = $class->setup_component( $component );
2160 $component => $module,
2162 $_ => $class->setup_component( $_ )
2164 not exists $comps{$_}
2165 } Devel::InnerPackage::list_packages( $component )
2168 for my $key ( keys %modules ) {
2169 $class->components->{ $key } = $modules{ $key };
2174 =head2 $c->setup_component
2178 sub _controller_init_base_classes {
2179 my ($app_class, $component) = @_;
2180 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2181 Moose::Meta::Class->initialize( $class )
2182 unless find_meta($class);
2186 sub setup_component {
2187 my( $class, $component ) = @_;
2189 unless ( $component->can( 'COMPONENT' ) ) {
2193 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2194 # nearest to Catalyst::Controller first, no matter what order stuff happens
2195 # to be loaded. There are TODO tests in Moose for this, see
2196 # f2391d17574eff81d911b97be15ea51080500003
2197 if ($component->isa('Catalyst::Controller')) {
2198 $class->_controller_init_base_classes($component);
2201 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2202 my $config = $class->config->{ $suffix } || {};
2204 my $instance = eval { $component->COMPONENT( $class, $config ); };
2206 if ( my $error = $@ ) {
2208 Catalyst::Exception->throw(
2209 message => qq/Couldn't instantiate component "$component", "$error"/
2213 unless (blessed $instance) {
2214 my $metaclass = Moose::Util::find_meta($component);
2215 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2216 my $component_method_from = $method_meta->associated_metaclass->name;
2217 my $value = defined($instance) ? $instance : 'undef';
2218 Catalyst::Exception->throw(
2220 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2226 =head2 $c->setup_dispatcher
2232 sub setup_dispatcher {
2233 my ( $class, $dispatcher ) = @_;
2236 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2239 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2240 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2243 unless ($dispatcher) {
2244 $dispatcher = $class->dispatcher_class;
2247 Class::MOP::load_class($dispatcher);
2249 # dispatcher instance
2250 $class->dispatcher( $dispatcher->new );
2253 =head2 $c->setup_engine
2260 my ( $class, $engine ) = @_;
2263 $engine = 'Catalyst::Engine::' . $engine;
2266 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2267 $engine = 'Catalyst::Engine::' . $env;
2270 if ( $ENV{MOD_PERL} ) {
2271 my $meta = Class::MOP::get_metaclass_by_name($class);
2273 # create the apache method
2274 $meta->add_method('apache' => sub { shift->engine->apache });
2276 my ( $software, $version ) =
2277 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2280 $version =~ s/(\.[^.]+)\./$1/g;
2282 if ( $software eq 'mod_perl' ) {
2286 if ( $version >= 1.99922 ) {
2287 $engine = 'Catalyst::Engine::Apache2::MP20';
2290 elsif ( $version >= 1.9901 ) {
2291 $engine = 'Catalyst::Engine::Apache2::MP19';
2294 elsif ( $version >= 1.24 ) {
2295 $engine = 'Catalyst::Engine::Apache::MP13';
2299 Catalyst::Exception->throw( message =>
2300 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2305 # install the correct mod_perl handler
2306 if ( $version >= 1.9901 ) {
2307 *handler = sub : method {
2308 shift->handle_request(@_);
2312 *handler = sub ($$) { shift->handle_request(@_) };
2317 elsif ( $software eq 'Zeus-Perl' ) {
2318 $engine = 'Catalyst::Engine::Zeus';
2322 Catalyst::Exception->throw(
2323 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2328 $engine = $class->engine_class;
2331 Class::MOP::load_class($engine);
2333 # check for old engines that are no longer compatible
2335 if ( $engine->isa('Catalyst::Engine::Apache')
2336 && !Catalyst::Engine::Apache->VERSION )
2341 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2342 && Catalyst::Engine::Server->VERSION le '0.02' )
2347 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2348 && $engine->VERSION eq '0.01' )
2353 elsif ($engine->isa('Catalyst::Engine::Zeus')
2354 && $engine->VERSION eq '0.01' )
2360 Catalyst::Exception->throw( message =>
2361 qq/Engine "$engine" is not supported by this version of Catalyst/
2366 $class->engine( $engine->new );
2369 =head2 $c->setup_home
2371 Sets up the home directory.
2376 my ( $class, $home ) = @_;
2378 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2382 $home ||= Catalyst::Utils::home($class);
2385 #I remember recently being scolded for assigning config values like this
2386 $class->config->{home} ||= $home;
2387 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2391 =head2 $c->setup_log
2393 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2394 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2397 This method also installs a C<debug> method that returns a true value into the
2398 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2399 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2401 Note that if the log has already been setup, by either a previous call to
2402 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2403 that this method won't actually set up the log object.
2408 my ( $class, $levels ) = @_;
2411 $levels =~ s/^\s+//;
2412 $levels =~ s/\s+$//;
2413 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2415 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2416 if ( defined $env_debug ) {
2417 $levels{debug} = 1 if $env_debug; # Ugly!
2418 delete($levels{debug}) unless $env_debug;
2421 unless ( $class->log ) {
2422 $class->log( Catalyst::Log->new(keys %levels) );
2425 if ( $levels{debug} ) {
2426 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2427 $class->log->debug('Debug messages enabled');
2431 =head2 $c->setup_plugins
2437 =head2 $c->setup_stats
2439 Sets up timing statistics class.
2444 my ( $class, $stats ) = @_;
2446 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2448 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2449 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2450 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2451 $class->log->debug('Statistics enabled');
2456 =head2 $c->registered_plugins
2458 Returns a sorted list of the plugins which have either been stated in the
2459 import list or which have been added via C<< MyApp->plugin(@args); >>.
2461 If passed a given plugin name, it will report a boolean value indicating
2462 whether or not that plugin is loaded. A fully qualified name is required if
2463 the plugin name does not begin with C<Catalyst::Plugin::>.
2465 if ($c->registered_plugins('Some::Plugin')) {
2473 sub registered_plugins {
2475 return sort keys %{ $proto->_plugins } unless @_;
2477 return 1 if exists $proto->_plugins->{$plugin};
2478 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2481 sub _register_plugin {
2482 my ( $proto, $plugin, $instant ) = @_;
2483 my $class = ref $proto || $proto;
2485 Class::MOP::load_class( $plugin );
2487 $proto->_plugins->{$plugin} = 1;
2490 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2491 my @superclasses = ($plugin, $meta->superclasses );
2492 $meta->superclasses(@superclasses);
2494 unshift @{"$class\::ISA"}, $plugin;
2501 my ( $class, $plugins ) = @_;
2503 $class->_plugins( {} ) unless $class->_plugins;
2506 my @plugins = map { s/\A\+// ? $_ : "Catalyst::Plugin::$_" } @$plugins;
2508 for my $plugin ( reverse @plugins ) {
2509 Class::MOP::load_class($plugin);
2510 my $meta = find_meta($plugin);
2511 next if $meta && $meta->isa('Moose::Meta::Role');
2513 $class->_register_plugin($plugin);
2518 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2519 map { find_meta($_) }
2522 Moose::Util::apply_all_roles(
2530 Returns an arrayref of the internal execution stack (actions that are
2531 currently executing).
2533 =head2 $c->stats_class
2535 Returns or sets the stats (timing statistics) class.
2537 =head2 $c->use_stats
2539 Returns 1 when stats collection is enabled. Stats collection is enabled
2540 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2541 environment variable is set.
2543 Note that this is a static method, not an accessor and should be overridden
2544 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2551 =head2 $c->write( $data )
2553 Writes $data to the output stream. When using this method directly, you
2554 will need to manually set the C<Content-Length> header to the length of
2555 your output data, if known.
2562 # Finalize headers if someone manually writes output
2563 $c->finalize_headers;
2565 return $c->engine->write( $c, @_ );
2570 Returns the Catalyst version number. Mostly useful for "powered by"
2571 messages in template systems.
2575 sub version { return $Catalyst::VERSION }
2577 =head1 INTERNAL ACTIONS
2579 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2580 C<_ACTION>, and C<_END>. These are by default not shown in the private
2581 action table, but you can make them visible with a config parameter.
2583 MyApp->config->{show_internal_actions} = 1;
2585 =head1 CASE SENSITIVITY
2587 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2588 mapped to C</foo/bar>. You can activate case sensitivity with a config
2591 MyApp->config->{case_sensitive} = 1;
2593 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2595 =head1 ON-DEMAND PARSER
2597 The request body is usually parsed at the beginning of a request,
2598 but if you want to handle input yourself, you can enable on-demand
2599 parsing with a config parameter.
2601 MyApp->config->{parse_on_demand} = 1;
2603 =head1 PROXY SUPPORT
2605 Many production servers operate using the common double-server approach,
2606 with a lightweight frontend web server passing requests to a larger
2607 backend server. An application running on the backend server must deal
2608 with two problems: the remote user always appears to be C<127.0.0.1> and
2609 the server's hostname will appear to be C<localhost> regardless of the
2610 virtual host that the user connected through.
2612 Catalyst will automatically detect this situation when you are running
2613 the frontend and backend servers on the same machine. The following
2614 changes are made to the request.
2616 $c->req->address is set to the user's real IP address, as read from
2617 the HTTP X-Forwarded-For header.
2619 The host value for $c->req->base and $c->req->uri is set to the real
2620 host, as read from the HTTP X-Forwarded-Host header.
2622 Obviously, your web server must support these headers for this to work.
2624 In a more complex server farm environment where you may have your
2625 frontend proxy server(s) on different machines, you will need to set a
2626 configuration option to tell Catalyst to read the proxied data from the
2629 MyApp->config->{using_frontend_proxy} = 1;
2631 If you do not wish to use the proxy support at all, you may set:
2633 MyApp->config->{ignore_frontend_proxy} = 1;
2635 =head1 THREAD SAFETY
2637 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2638 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2639 believe the Catalyst core to be thread-safe.
2641 If you plan to operate in a threaded environment, remember that all other
2642 modules you are using must also be thread-safe. Some modules, most notably
2643 L<DBD::SQLite>, are not thread-safe.
2649 Join #catalyst on irc.perl.org.
2653 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2654 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2658 http://catalyst.perl.org
2662 http://dev.catalyst.perl.org
2666 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2668 =head2 L<Catalyst::Manual> - The Catalyst Manual
2670 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2672 =head2 L<Catalyst::Engine> - Core engine
2674 =head2 L<Catalyst::Log> - Log class.
2676 =head2 L<Catalyst::Request> - Request object
2678 =head2 L<Catalyst::Response> - Response object
2680 =head2 L<Catalyst::Test> - The test suite.
2682 =head1 PROJECT FOUNDER
2684 sri: Sebastian Riedel <sri@cpan.org>
2690 acme: Leon Brocard <leon@astray.com>
2698 andyg: Andy Grundman <andy@hybridized.org>
2700 audreyt: Audrey Tang
2702 bricas: Brian Cassidy <bricas@cpan.org>
2704 Caelum: Rafael Kitover <rkitover@io.com>
2706 chansen: Christian Hansen
2708 chicks: Christopher Hicks
2712 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2716 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2718 esskar: Sascha Kiefer
2720 fireartist: Carl Franks <cfranks@cpan.org>
2722 gabb: Danijel Milicevic
2728 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2730 jcamacho: Juan Camacho
2732 jhannah: Jay Hannah <jay@jays.net>
2738 jon: Jon Schutz <jjschutz@cpan.org>
2740 marcus: Marcus Ramberg <mramberg@cpan.org>
2742 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2744 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2748 naughton: David Naughton
2750 ningu: David Kamholz <dkamholz@cpan.org>
2752 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2754 numa: Dan Sully <daniel@cpan.org>
2758 omega: Andreas Marienborg
2760 Oleg Kostyuk <cub.uanic@gmail.com>
2762 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2764 rafl: Florian Ragwitz <rafl@debian.org>
2766 random: Roland Lammel <lammel@cpan.org>
2770 the_jester: Jesse Sheidlower
2772 t0m: Tomas Doran <bobtfish@bobtfish.net>
2776 willert: Sebastian Willert <willert@cpan.org>
2780 This library is free software, you can redistribute it and/or modify it under
2781 the same terms as Perl itself.
2787 __PACKAGE__->meta->make_immutable;