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 sub _comp_search_prefixes {
498 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
501 # search components given a name and some prefixes
502 sub _comp_names_search_prefixes {
503 my ( $c, $name, @prefixes ) = @_;
504 my $appclass = ref $c || $c;
505 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
506 $filter = qr/$filter/; # Compile regex now rather than once per loop
508 # map the original component name to the sub part that we will search against
509 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
510 grep { /$filter/ } keys %{ $c->components };
512 # undef for a name will return all
513 return keys %eligible if !defined $name;
515 my $query = ref $name ? $name : qr/^$name$/i;
516 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
518 return @result if @result;
520 # if we were given a regexp to search against, we're done.
525 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
527 # no results? try against full names
529 @result = grep { m{$query} } keys %eligible;
532 # don't warn if we didn't find any results, it just might not exist
534 # Disgusting hack to work out correct method name
535 my $warn_for = lc $prefixes[0];
536 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
537 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
538 "component resolution is unreliable and unsafe.";
539 my $short = $result[0];
540 $short =~ s/.*?Model:://;
541 my $shortmess = Carp::shortmess('');
542 if ($shortmess =~ m#Catalyst/Plugin#) {
543 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
545 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
546 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
547 "component's config";
549 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
550 "but if you really wanted to search, pass in a regexp as the argument " .
551 "like so: \$c->${warn_for}(qr/${name}/)";
553 $c->log->warn( "${msg}$shortmess" );
559 # Find possible names for a prefix
561 my ( $c, @prefixes ) = @_;
562 my $appclass = ref $c || $c;
564 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
566 my @names = map { s{$filter}{}; $_; }
567 $c->_comp_names_search_prefixes( undef, @prefixes );
572 # Filter a component before returning by calling ACCEPT_CONTEXT if available
573 sub _filter_component {
574 my ( $c, $comp, @args ) = @_;
576 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
577 return $comp->ACCEPT_CONTEXT( $c, @args );
583 =head2 COMPONENT ACCESSORS
585 =head2 $c->controller($name)
587 Gets a L<Catalyst::Controller> instance by name.
589 $c->controller('Foo')->do_stuff;
591 If the name is omitted, will return the controller for the dispatched
594 If you want to search for controllers, pass in a regexp as the argument.
596 # find all controllers that start with Foo
597 my @foo_controllers = $c->controller(qr{^Foo});
603 my ( $c, $name, @args ) = @_;
606 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
607 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
608 return $c->_filter_component( $result[ 0 ], @args );
611 return $c->component( $c->action->class );
614 =head2 $c->model($name)
616 Gets a L<Catalyst::Model> instance by name.
618 $c->model('Foo')->do_stuff;
620 Any extra arguments are directly passed to ACCEPT_CONTEXT.
622 If the name is omitted, it will look for
623 - a model object in $c->stash->{current_model_instance}, then
624 - a model name in $c->stash->{current_model}, then
625 - a config setting 'default_model', or
626 - check if there is only one model, and return it if that's the case.
628 If you want to search for models, pass in a regexp as the argument.
630 # find all models that start with Foo
631 my @foo_models = $c->model(qr{^Foo});
636 my ( $c, $name, @args ) = @_;
639 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
640 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
641 return $c->_filter_component( $result[ 0 ], @args );
645 return $c->stash->{current_model_instance}
646 if $c->stash->{current_model_instance};
647 return $c->model( $c->stash->{current_model} )
648 if $c->stash->{current_model};
650 return $c->model( $c->config->{default_model} )
651 if $c->config->{default_model};
653 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
656 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
657 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
658 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
659 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
660 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
663 return $c->_filter_component( $comp );
667 =head2 $c->view($name)
669 Gets a L<Catalyst::View> instance by name.
671 $c->view('Foo')->do_stuff;
673 Any extra arguments are directly passed to ACCEPT_CONTEXT.
675 If the name is omitted, it will look for
676 - a view object in $c->stash->{current_view_instance}, then
677 - a view name in $c->stash->{current_view}, then
678 - a config setting 'default_view', or
679 - check if there is only one view, and return it if that's the case.
681 If you want to search for views, pass in a regexp as the argument.
683 # find all views that start with Foo
684 my @foo_views = $c->view(qr{^Foo});
689 my ( $c, $name, @args ) = @_;
692 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
693 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
694 return $c->_filter_component( $result[ 0 ], @args );
698 return $c->stash->{current_view_instance}
699 if $c->stash->{current_view_instance};
700 return $c->view( $c->stash->{current_view} )
701 if $c->stash->{current_view};
703 return $c->view( $c->config->{default_view} )
704 if $c->config->{default_view};
706 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
709 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
710 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
711 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
712 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
713 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
716 return $c->_filter_component( $comp );
719 =head2 $c->controllers
721 Returns the available names which can be passed to $c->controller
727 return $c->_comp_names(qw/Controller C/);
732 Returns the available names which can be passed to $c->model
738 return $c->_comp_names(qw/Model M/);
744 Returns the available names which can be passed to $c->view
750 return $c->_comp_names(qw/View V/);
753 =head2 $c->comp($name)
755 =head2 $c->component($name)
757 Gets a component object by name. This method is not recommended,
758 unless you want to get a specific component by full
759 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
760 should be used instead.
762 If C<$name> is a regexp, a list of components matched against the full
763 component name will be returned.
768 my ( $c, $name, @args ) = @_;
771 my $comps = $c->components;
774 # is it the exact name?
775 return $c->_filter_component( $comps->{ $name }, @args )
776 if exists $comps->{ $name };
778 # perhaps we just omitted "MyApp"?
779 my $composed = ( ref $c || $c ) . "::${name}";
780 return $c->_filter_component( $comps->{ $composed }, @args )
781 if exists $comps->{ $composed };
783 # search all of the models, views and controllers
784 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
785 return $c->_filter_component( $comp, @args ) if $comp;
788 # This is here so $c->comp( '::M::' ) works
789 my $query = ref $name ? $name : qr{$name}i;
791 my @result = grep { m{$query} } keys %{ $c->components };
792 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
795 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
796 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
797 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
798 return $c->_filter_component( $result[ 0 ], @args );
801 # I would expect to return an empty list here, but that breaks back-compat
805 return sort keys %{ $c->components };
808 =head2 CLASS DATA AND HELPER CLASSES
812 Returns or takes a hashref containing the application's configuration.
814 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
816 You can also use a C<YAML>, C<XML> or C<Config::General> config file
817 like myapp.conf in your applications home directory. See
818 L<Catalyst::Plugin::ConfigLoader>.
820 =head3 Cascading configuration.
822 The config method is present on all Catalyst components, and configuration
823 will be merged when an application is started. Configuration loaded with
824 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
825 followed by configuration in your top level C<MyApp> class. These two
826 configurations are merged, and then configuration data whose hash key matches a
827 component name is merged with configuration for that component.
829 The configuration for a component is then passed to the C<new> method when a
830 component is constructed.
834 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
835 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
837 will mean that C<MyApp::Model::Foo> receives the following data when
840 MyApp::Model::Foo->new({
848 around config => sub {
852 croak('Setting config after setup has been run is not allowed.')
853 if ( @_ and $c->setup_finished );
860 Returns the logging object instance. Unless it is already set, Catalyst
861 sets this up with a L<Catalyst::Log> object. To use your own log class,
862 set the logger with the C<< __PACKAGE__->log >> method prior to calling
863 C<< __PACKAGE__->setup >>.
865 __PACKAGE__->log( MyLogger->new );
870 $c->log->info( 'Now logging with my own logger!' );
872 Your log class should implement the methods described in
878 Returns 1 if debug mode is enabled, 0 otherwise.
880 You can enable debug mode in several ways:
884 =item By calling myapp_server.pl with the -d flag
886 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
888 =item The -Debug option in your MyApp.pm
890 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
894 Calling C<< $c->debug(1) >> has no effect.
900 =head2 $c->dispatcher
902 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
906 Returns the engine instance. See L<Catalyst::Engine>.
909 =head2 UTILITY METHODS
911 =head2 $c->path_to(@path)
913 Merges C<@path> with C<< $c->config->{home} >> and returns a
914 L<Path::Class::Dir> object. Note you can usually use this object as
915 a filename, but sometimes you will have to explicitly stringify it
916 yourself by calling the C<<->stringify>> method.
920 $c->path_to( 'db', 'sqlite.db' );
925 my ( $c, @path ) = @_;
926 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
927 if ( -d $path ) { return $path }
928 else { return Path::Class::File->new( $c->config->{home}, @path ) }
931 =head2 $c->plugin( $name, $class, @args )
933 Helper method for plugins. It creates a class data accessor/mutator and
934 loads and instantiates the given class.
936 MyApp->plugin( 'prototype', 'HTML::Prototype' );
938 $c->prototype->define_javascript_functions;
940 B<Note:> This method of adding plugins is deprecated. The ability
941 to add plugins like this B<will be removed> in a Catalyst 5.81.
942 Please do not use this functionality in new code.
947 my ( $class, $name, $plugin, @args ) = @_;
949 # See block comment in t/unit_core_plugin.t
950 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
952 $class->_register_plugin( $plugin, 1 );
954 eval { $plugin->import };
955 $class->mk_classdata($name);
957 eval { $obj = $plugin->new(@args) };
960 Catalyst::Exception->throw( message =>
961 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
965 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
971 Initializes the dispatcher and engine, loads any plugins, and loads the
972 model, view, and controller components. You may also specify an array
973 of plugins to load here, if you choose to not load them in the C<use
977 MyApp->setup( qw/-Debug/ );
982 my ( $class, @arguments ) = @_;
983 croak('Running setup more than once')
984 if ( $class->setup_finished );
986 unless ( $class->isa('Catalyst') ) {
988 Catalyst::Exception->throw(
989 message => qq/'$class' does not inherit from Catalyst/ );
992 if ( $class->arguments ) {
993 @arguments = ( @arguments, @{ $class->arguments } );
999 foreach (@arguments) {
1003 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1005 elsif (/^-(\w+)=?(.*)$/) {
1006 $flags->{ lc $1 } = $2;
1009 push @{ $flags->{plugins} }, $_;
1013 $class->setup_home( delete $flags->{home} );
1015 $class->setup_log( delete $flags->{log} );
1016 $class->setup_plugins( delete $flags->{plugins} );
1017 $class->setup_dispatcher( delete $flags->{dispatcher} );
1018 $class->setup_engine( delete $flags->{engine} );
1019 $class->setup_stats( delete $flags->{stats} );
1021 for my $flag ( sort keys %{$flags} ) {
1023 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1024 &$code( $class, delete $flags->{$flag} );
1027 $class->log->warn(qq/Unknown flag "$flag"/);
1031 eval { require Catalyst::Devel; };
1032 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1033 $class->log->warn(<<"EOF");
1034 You are running an old script!
1036 Please update by running (this will overwrite existing files):
1037 catalyst.pl -force -scripts $class
1039 or (this will not overwrite existing files):
1040 catalyst.pl -scripts $class
1045 if ( $class->debug ) {
1046 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1049 my $column_width = Catalyst::Utils::term_width() - 6;
1050 my $t = Text::SimpleTable->new($column_width);
1051 $t->row($_) for @plugins;
1052 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1055 my $dispatcher = $class->dispatcher;
1056 my $engine = $class->engine;
1057 my $home = $class->config->{home};
1059 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1060 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1064 ? $class->log->debug(qq/Found home "$home"/)
1065 : $class->log->debug(qq/Home "$home" doesn't exist/)
1066 : $class->log->debug(q/Couldn't find home/);
1069 # Call plugins setup, this is stupid and evil.
1070 # Also screws C3 badly on 5.10, hack to avoid.
1072 no warnings qw/redefine/;
1073 local *setup = sub { };
1074 $class->setup unless $Catalyst::__AM_RESTARTING;
1077 # Initialize our data structure
1078 $class->components( {} );
1080 $class->setup_components;
1082 if ( $class->debug ) {
1083 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1084 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1085 for my $comp ( sort keys %{ $class->components } ) {
1086 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1087 $t->row( $comp, $type );
1089 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1090 if ( keys %{ $class->components } );
1093 # Add our self to components, since we are also a component
1094 if( $class->isa('Catalyst::Controller') ){
1095 $class->components->{$class} = $class;
1098 $class->setup_actions;
1100 if ( $class->debug ) {
1101 my $name = $class->config->{name} || 'Application';
1102 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1104 $class->log->_flush() if $class->log->can('_flush');
1106 # Make sure that the application class becomes immutable at this point,
1107 # which ensures that it gets an inlined constructor. This means that it
1108 # works even if the user has added a plugin which contains a new method.
1109 # Note however that we have to do the work on scope end, so that method
1110 # modifiers work correctly in MyApp (as you have to call setup _before_
1111 # applying modifiers).
1112 B::Hooks::EndOfScope::on_scope_end {
1114 my $meta = Class::MOP::get_metaclass_by_name($class);
1115 if ( $meta->is_immutable && ! { $meta->immutable_options }->{inline_constructor} ) {
1116 warn "You made your application class ($class) immutable, "
1117 . "but did not inline the constructor.\n"
1118 . "This will break catalyst, please pass "
1119 . "(replace_constructor => 1) when making your class immutable.\n";
1121 $meta->make_immutable(replace_constructor => 1) unless $meta->is_immutable;
1124 $class->setup_finalize;
1128 =head2 $app->setup_finalize
1130 A hook to attach modifiers to.
1131 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1132 Also better than C< setup_finished(); >, as that is a getter method.
1134 sub setup_finalize {
1138 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1140 $app->next::method(@_);
1147 sub setup_finalize {
1149 $class->setup_finished(1);
1152 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1154 =head2 $c->uri_for( $path, @args?, \%query_values? )
1160 A Catalyst::Action object representing the Catalyst action you want to
1161 create a URI for. To get one for an action in the current controller,
1162 use C<< $c->action('someactionname') >>. To get one from different
1163 controller, fetch the controller using C<< $c->controller() >>, then
1164 call C<action_for> on it.
1166 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1167 using C<< $c->req->captures >>.
1169 # For the current action
1170 $c->uri_for($c->action, $c->req->captures);
1172 # For the Foo action in the Bar controller
1173 $c->uri_for($c->controller('Bar')->action_for('Foo'), $c->req->captures);
1180 my ( $c, $path, @args ) = @_;
1182 if ( blessed($path) ) { # action object
1183 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1187 $path = $c->dispatcher->uri_for_action($action, $captures);
1188 if (not defined $path) {
1189 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1193 $path = '/' if $path eq '';
1196 undef($path) if (defined $path && $path eq '');
1199 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1201 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1202 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1204 unshift(@args, $path);
1206 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1207 my $namespace = $c->namespace;
1208 if (defined $path) { # cheesy hack to handle path '../foo'
1209 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1211 unshift(@args, $namespace || '');
1214 # join args with '/', or a blank string
1215 my $args = join('/', grep { defined($_) } @args);
1216 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1218 my $base = $c->req->base;
1219 my $class = ref($base);
1220 $base =~ s{(?<!/)$}{/};
1224 if (my @keys = keys %$params) {
1225 # somewhat lifted from URI::_query's query_form
1226 $query = '?'.join('&', map {
1227 my $val = $params->{$_};
1228 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1231 $val = '' unless defined $val;
1234 utf8::encode( $_ ) if utf8::is_utf8($_);
1235 # using the URI::Escape pattern here so utf8 chars survive
1236 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1238 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1242 my $res = bless(\"${base}${args}${query}", $class);
1246 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1248 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1254 A private path to the Catalyst action you want to create a URI for.
1256 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1257 >> and passing the resulting C<$action> and the remaining arguments to C<<
1260 You can also pass in a Catalyst::Action object, in which case it is passed to
1267 sub uri_for_action {
1268 my ( $c, $path, @args ) = @_;
1269 my $action = blessed($path)
1271 : $c->dispatcher->get_action_by_path($path);
1272 unless (defined $action) {
1273 croak "Can't find action for path '$path'";
1275 return $c->uri_for( $action, @args );
1278 =head2 $c->welcome_message
1280 Returns the Catalyst welcome HTML page.
1284 sub welcome_message {
1286 my $name = $c->config->{name};
1287 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1288 my $prefix = Catalyst::Utils::appprefix( ref $c );
1289 $c->response->content_type('text/html; charset=utf-8');
1291 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1292 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1293 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1295 <meta http-equiv="Content-Language" content="en" />
1296 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1297 <title>$name on Catalyst $VERSION</title>
1298 <style type="text/css">
1301 background-color: #eee;
1308 margin-bottom: 10px;
1310 background-color: #ccc;
1311 border: 1px solid #aaa;
1316 font-family: verdana, tahoma, sans-serif;
1319 font-family: verdana, tahoma, sans-serif;
1322 text-decoration: none;
1324 border-bottom: 1px dotted #bbb;
1326 :link:hover, :visited:hover {
1339 background-color: #fff;
1340 border: 1px solid #aaa;
1344 font-weight: normal;
1366 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1371 <img src="$logo" alt="Catalyst Logo" />
1373 <p>Welcome to the world of Catalyst.
1374 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1375 framework will make web development something you had
1376 never expected it to be: Fun, rewarding, and quick.</p>
1377 <h2>What to do now?</h2>
1378 <p>That really depends on what <b>you</b> want to do.
1379 We do, however, provide you with a few starting points.</p>
1380 <p>If you want to jump right into web development with Catalyst
1381 you might want to start with a tutorial.</p>
1382 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1384 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1386 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1387 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1389 <h2>What to do next?</h2>
1390 <p>Next it's time to write an actual application. Use the
1391 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1392 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1393 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1394 they can save you a lot of work.</p>
1395 <pre><code>script/${prefix}_create.pl -help</code></pre>
1396 <p>Also, be sure to check out the vast and growing
1397 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1398 you are likely to find what you need there.
1402 <p>Catalyst has a very active community. Here are the main places to
1403 get in touch with us.</p>
1406 <a href="http://dev.catalyst.perl.org">Wiki</a>
1409 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1412 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1415 <h2>In conclusion</h2>
1416 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1417 as we enjoyed making it. Please contact us if you have ideas
1418 for improvement or other feedback.</p>
1426 =head1 INTERNAL METHODS
1428 These methods are not meant to be used by end users.
1430 =head2 $c->components
1432 Returns a hash of components.
1434 =head2 $c->context_class
1436 Returns or sets the context class.
1440 Returns a hashref containing coderefs and execution counts (needed for
1441 deep recursion detection).
1445 Returns the number of actions on the current internal execution stack.
1449 Dispatches a request to actions.
1453 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1455 =head2 $c->dispatcher_class
1457 Returns or sets the dispatcher class.
1459 =head2 $c->dump_these
1461 Returns a list of 2-element array references (name, structure) pairs
1462 that will be dumped on the error page in debug mode.
1468 [ Request => $c->req ],
1469 [ Response => $c->res ],
1470 [ Stash => $c->stash ],
1471 [ Config => $c->config ];
1474 =head2 $c->engine_class
1476 Returns or sets the engine class.
1478 =head2 $c->execute( $class, $coderef )
1480 Execute a coderef in given class and catch exceptions. Errors are available
1486 my ( $c, $class, $code ) = @_;
1487 $class = $c->component($class) || $class;
1490 if ( $c->depth >= $RECURSION ) {
1491 my $action = $code->reverse();
1492 $action = "/$action" unless $action =~ /->/;
1493 my $error = qq/Deep recursion detected calling "${action}"/;
1494 $c->log->error($error);
1500 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1502 push( @{ $c->stack }, $code );
1504 no warnings 'recursion';
1505 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1507 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1509 my $last = pop( @{ $c->stack } );
1511 if ( my $error = $@ ) {
1512 if ( !ref($error) and $error eq $DETACH ) {
1513 die $DETACH if($c->depth > 1);
1515 elsif ( !ref($error) and $error eq $GO ) {
1516 die $GO if($c->depth > 0);
1519 unless ( ref $error ) {
1520 no warnings 'uninitialized';
1522 my $class = $last->class;
1523 my $name = $last->name;
1524 $error = qq/Caught exception in $class->$name "$error"/;
1533 sub _stats_start_execute {
1534 my ( $c, $code ) = @_;
1536 return if ( ( $code->name =~ /^_.*/ )
1537 && ( !$c->config->{show_internal_actions} ) );
1539 my $action_name = $code->reverse();
1540 $c->counter->{$action_name}++;
1542 my $action = $action_name;
1543 $action = "/$action" unless $action =~ /->/;
1545 # determine if the call was the result of a forward
1546 # this is done by walking up the call stack and looking for a calling
1547 # sub of Catalyst::forward before the eval
1549 for my $index ( 2 .. 11 ) {
1551 if ( ( caller($index) )[0] eq 'Catalyst'
1552 && ( caller($index) )[3] eq '(eval)' );
1554 if ( ( caller($index) )[3] =~ /forward$/ ) {
1555 $callsub = ( caller($index) )[3];
1556 $action = "-> $action";
1561 my $uid = $action_name . $c->counter->{$action_name};
1563 # is this a root-level call or a forwarded call?
1564 if ( $callsub =~ /forward$/ ) {
1566 # forward, locate the caller
1567 if ( my $parent = $c->stack->[-1] ) {
1570 parent => "$parent" . $c->counter->{"$parent"},
1576 # forward with no caller may come from a plugin
1595 sub _stats_finish_execute {
1596 my ( $c, $info ) = @_;
1597 $c->stats->profile( end => $info );
1600 =head2 $c->_localize_fields( sub { }, \%keys );
1604 #Why does this exist? This is no longer safe and WILL NOT WORK.
1605 # it doesnt seem to be used anywhere. can we remove it?
1606 sub _localize_fields {
1607 my ( $c, $localized, $code ) = ( @_ );
1609 my $request = delete $localized->{request} || {};
1610 my $response = delete $localized->{response} || {};
1612 local @{ $c }{ keys %$localized } = values %$localized;
1613 local @{ $c->request }{ keys %$request } = values %$request;
1614 local @{ $c->response }{ keys %$response } = values %$response;
1621 Finalizes the request.
1628 for my $error ( @{ $c->error } ) {
1629 $c->log->error($error);
1632 # Allow engine to handle finalize flow (for POE)
1633 my $engine = $c->engine;
1634 if ( my $code = $engine->can('finalize') ) {
1639 $c->finalize_uploads;
1642 if ( $#{ $c->error } >= 0 ) {
1646 $c->finalize_headers;
1649 if ( $c->request->method eq 'HEAD' ) {
1650 $c->response->body('');
1656 if ($c->use_stats) {
1657 my $elapsed = sprintf '%f', $c->stats->elapsed;
1658 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1660 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1663 return $c->response->status;
1666 =head2 $c->finalize_body
1672 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1674 =head2 $c->finalize_cookies
1680 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1682 =head2 $c->finalize_error
1688 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1690 =head2 $c->finalize_headers
1696 sub finalize_headers {
1699 my $response = $c->response; #accessor calls can add up?
1701 # Check if we already finalized headers
1702 return if $response->finalized_headers;
1705 if ( my $location = $response->redirect ) {
1706 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1707 $response->header( Location => $location );
1709 if ( !$response->has_body ) {
1710 # Add a default body if none is already present
1712 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1718 if ( $response->body && !$response->content_length ) {
1720 # get the length from a filehandle
1721 if ( blessed( $response->body ) && $response->body->can('read') )
1723 my $stat = stat $response->body;
1724 if ( $stat && $stat->size > 0 ) {
1725 $response->content_length( $stat->size );
1728 $c->log->warn('Serving filehandle without a content-length');
1732 # everything should be bytes at this point, but just in case
1733 $response->content_length( bytes::length( $response->body ) );
1738 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1739 $response->headers->remove_header("Content-Length");
1740 $response->body('');
1743 $c->finalize_cookies;
1745 $c->engine->finalize_headers( $c, @_ );
1748 $response->finalized_headers(1);
1751 =head2 $c->finalize_output
1753 An alias for finalize_body.
1755 =head2 $c->finalize_read
1757 Finalizes the input after reading is complete.
1761 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1763 =head2 $c->finalize_uploads
1765 Finalizes uploads. Cleans up any temporary files.
1769 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1771 =head2 $c->get_action( $action, $namespace )
1773 Gets an action in a given namespace.
1777 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1779 =head2 $c->get_actions( $action, $namespace )
1781 Gets all actions of a given name in a namespace and all parent
1786 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1788 =head2 $c->handle_request( $class, @arguments )
1790 Called to handle each HTTP request.
1794 sub handle_request {
1795 my ( $class, @arguments ) = @_;
1797 # Always expect worst case!
1800 if ($class->debug) {
1801 my $secs = time - $START || 1;
1802 my $av = sprintf '%.3f', $COUNT / $secs;
1803 my $time = localtime time;
1804 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1807 my $c = $class->prepare(@arguments);
1809 $status = $c->finalize;
1812 if ( my $error = $@ ) {
1814 $class->log->error(qq/Caught exception in engine "$error"/);
1819 if(my $coderef = $class->log->can('_flush')){
1820 $class->log->$coderef();
1825 =head2 $c->prepare( @arguments )
1827 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1833 my ( $class, @arguments ) = @_;
1836 # After the app/ctxt split, this should become an attribute based on something passed
1837 # into the application.
1838 $class->context_class( ref $class || $class ) unless $class->context_class;
1840 my $c = $class->context_class->new({});
1842 # For on-demand data
1843 $c->request->_context($c);
1844 $c->response->_context($c);
1846 #surely this is not the most efficient way to do things...
1847 $c->stats($class->stats_class->new)->enable($c->use_stats);
1849 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1852 #XXX reuse coderef from can
1853 # Allow engine to direct the prepare flow (for POE)
1854 if ( $c->engine->can('prepare') ) {
1855 $c->engine->prepare( $c, @arguments );
1858 $c->prepare_request(@arguments);
1859 $c->prepare_connection;
1860 $c->prepare_query_parameters;
1861 $c->prepare_headers;
1862 $c->prepare_cookies;
1865 # Prepare the body for reading, either by prepare_body
1866 # or the user, if they are using $c->read
1869 # Parse the body unless the user wants it on-demand
1870 unless ( $c->config->{parse_on_demand} ) {
1875 my $method = $c->req->method || '';
1876 my $path = $c->req->path;
1877 $path = '/' unless length $path;
1878 my $address = $c->req->address || '';
1880 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1888 =head2 $c->prepare_action
1890 Prepares action. See L<Catalyst::Dispatcher>.
1894 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1896 =head2 $c->prepare_body
1898 Prepares message body.
1905 return if $c->request->_has_body;
1907 # Initialize on-demand data
1908 $c->engine->prepare_body( $c, @_ );
1909 $c->prepare_parameters;
1910 $c->prepare_uploads;
1912 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1913 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1914 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1915 my $param = $c->req->body_parameters->{$key};
1916 my $value = defined($param) ? $param : '';
1918 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1920 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1924 =head2 $c->prepare_body_chunk( $chunk )
1926 Prepares a chunk of data before sending it to L<HTTP::Body>.
1928 See L<Catalyst::Engine>.
1932 sub prepare_body_chunk {
1934 $c->engine->prepare_body_chunk( $c, @_ );
1937 =head2 $c->prepare_body_parameters
1939 Prepares body parameters.
1943 sub prepare_body_parameters {
1945 $c->engine->prepare_body_parameters( $c, @_ );
1948 =head2 $c->prepare_connection
1950 Prepares connection.
1954 sub prepare_connection {
1956 $c->engine->prepare_connection( $c, @_ );
1959 =head2 $c->prepare_cookies
1965 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1967 =head2 $c->prepare_headers
1973 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1975 =head2 $c->prepare_parameters
1977 Prepares parameters.
1981 sub prepare_parameters {
1983 $c->prepare_body_parameters;
1984 $c->engine->prepare_parameters( $c, @_ );
1987 =head2 $c->prepare_path
1989 Prepares path and base.
1993 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1995 =head2 $c->prepare_query_parameters
1997 Prepares query parameters.
2001 sub prepare_query_parameters {
2004 $c->engine->prepare_query_parameters( $c, @_ );
2006 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2007 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2008 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2009 my $param = $c->req->query_parameters->{$key};
2010 my $value = defined($param) ? $param : '';
2012 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2014 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2018 =head2 $c->prepare_read
2020 Prepares the input for reading.
2024 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2026 =head2 $c->prepare_request
2028 Prepares the engine request.
2032 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2034 =head2 $c->prepare_uploads
2040 sub prepare_uploads {
2043 $c->engine->prepare_uploads( $c, @_ );
2045 if ( $c->debug && keys %{ $c->request->uploads } ) {
2046 my $t = Text::SimpleTable->new(
2047 [ 12, 'Parameter' ],
2052 for my $key ( sort keys %{ $c->request->uploads } ) {
2053 my $upload = $c->request->uploads->{$key};
2054 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2055 $t->row( $key, $u->filename, $u->type, $u->size );
2058 $c->log->debug( "File Uploads are:\n" . $t->draw );
2062 =head2 $c->prepare_write
2064 Prepares the output for writing.
2068 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2070 =head2 $c->request_class
2072 Returns or sets the request class.
2074 =head2 $c->response_class
2076 Returns or sets the response class.
2078 =head2 $c->read( [$maxlength] )
2080 Reads a chunk of data from the request body. This method is designed to
2081 be used in a while loop, reading C<$maxlength> bytes on every call.
2082 C<$maxlength> defaults to the size of the request if not specified.
2084 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2087 Warning: If you use read(), Catalyst will not process the body,
2088 so you will not be able to access POST parameters or file uploads via
2089 $c->request. You must handle all body parsing yourself.
2093 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2101 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2103 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2105 Sets an action in a given namespace.
2109 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2111 =head2 $c->setup_actions($component)
2113 Sets up actions for a component.
2117 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2119 =head2 $c->setup_components
2121 Sets up components. Specify a C<setup_components> config option to pass
2122 additional options directly to L<Module::Pluggable>. To add additional
2123 search paths, specify a key named C<search_extra> as an array
2124 reference. Items in the array beginning with C<::> will have the
2125 application class name prepended to them.
2127 All components found will also have any
2128 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2129 Note, that modules which are B<not> an I<inner package> of the main
2130 file namespace loaded will not be instantiated as components.
2134 sub setup_components {
2137 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2138 my $config = $class->config->{ setup_components };
2139 my $extra = delete $config->{ search_extra } || [];
2141 push @paths, @$extra;
2143 my $locator = Module::Pluggable::Object->new(
2144 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2148 my @comps = sort { length $a <=> length $b } $locator->plugins;
2149 my %comps = map { $_ => 1 } @comps;
2151 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2152 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2153 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2154 ) if $deprecated_component_names;
2156 for my $component ( @comps ) {
2158 # We pass ignore_loaded here so that overlay files for (e.g.)
2159 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2160 # we know M::P::O found a file on disk so this is safe
2162 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2163 #Class::MOP::load_class($component);
2165 my $module = $class->setup_component( $component );
2167 $component => $module,
2169 $_ => $class->setup_component( $_ )
2171 not exists $comps{$_}
2172 } Devel::InnerPackage::list_packages( $component )
2175 for my $key ( keys %modules ) {
2176 $class->components->{ $key } = $modules{ $key };
2181 =head2 $c->setup_component
2185 sub _controller_init_base_classes {
2186 my ($app_class, $component) = @_;
2187 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2188 Moose::Meta::Class->initialize( $class )
2189 unless find_meta($class);
2193 sub setup_component {
2194 my( $class, $component ) = @_;
2196 unless ( $component->can( 'COMPONENT' ) ) {
2200 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2201 # nearest to Catalyst::Controller first, no matter what order stuff happens
2202 # to be loaded. There are TODO tests in Moose for this, see
2203 # f2391d17574eff81d911b97be15ea51080500003
2204 if ($component->isa('Catalyst::Controller')) {
2205 $class->_controller_init_base_classes($component);
2208 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2209 my $config = $class->config->{ $suffix } || {};
2211 my $instance = eval { $component->COMPONENT( $class, $config ); };
2213 if ( my $error = $@ ) {
2215 Catalyst::Exception->throw(
2216 message => qq/Couldn't instantiate component "$component", "$error"/
2220 unless (blessed $instance) {
2221 my $metaclass = Moose::Util::find_meta($component);
2222 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2223 my $component_method_from = $method_meta->associated_metaclass->name;
2224 my $value = defined($instance) ? $instance : 'undef';
2225 Catalyst::Exception->throw(
2227 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2233 =head2 $c->setup_dispatcher
2239 sub setup_dispatcher {
2240 my ( $class, $dispatcher ) = @_;
2243 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2246 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2247 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2250 unless ($dispatcher) {
2251 $dispatcher = $class->dispatcher_class;
2254 Class::MOP::load_class($dispatcher);
2256 # dispatcher instance
2257 $class->dispatcher( $dispatcher->new );
2260 =head2 $c->setup_engine
2267 my ( $class, $engine ) = @_;
2270 $engine = 'Catalyst::Engine::' . $engine;
2273 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2274 $engine = 'Catalyst::Engine::' . $env;
2277 if ( $ENV{MOD_PERL} ) {
2278 my $meta = Class::MOP::get_metaclass_by_name($class);
2280 # create the apache method
2281 $meta->add_method('apache' => sub { shift->engine->apache });
2283 my ( $software, $version ) =
2284 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2287 $version =~ s/(\.[^.]+)\./$1/g;
2289 if ( $software eq 'mod_perl' ) {
2293 if ( $version >= 1.99922 ) {
2294 $engine = 'Catalyst::Engine::Apache2::MP20';
2297 elsif ( $version >= 1.9901 ) {
2298 $engine = 'Catalyst::Engine::Apache2::MP19';
2301 elsif ( $version >= 1.24 ) {
2302 $engine = 'Catalyst::Engine::Apache::MP13';
2306 Catalyst::Exception->throw( message =>
2307 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2312 # install the correct mod_perl handler
2313 if ( $version >= 1.9901 ) {
2314 *handler = sub : method {
2315 shift->handle_request(@_);
2319 *handler = sub ($$) { shift->handle_request(@_) };
2324 elsif ( $software eq 'Zeus-Perl' ) {
2325 $engine = 'Catalyst::Engine::Zeus';
2329 Catalyst::Exception->throw(
2330 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2335 $engine = $class->engine_class;
2338 Class::MOP::load_class($engine);
2340 # check for old engines that are no longer compatible
2342 if ( $engine->isa('Catalyst::Engine::Apache')
2343 && !Catalyst::Engine::Apache->VERSION )
2348 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2349 && Catalyst::Engine::Server->VERSION le '0.02' )
2354 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2355 && $engine->VERSION eq '0.01' )
2360 elsif ($engine->isa('Catalyst::Engine::Zeus')
2361 && $engine->VERSION eq '0.01' )
2367 Catalyst::Exception->throw( message =>
2368 qq/Engine "$engine" is not supported by this version of Catalyst/
2373 $class->engine( $engine->new );
2376 =head2 $c->setup_home
2378 Sets up the home directory.
2383 my ( $class, $home ) = @_;
2385 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2389 $home ||= Catalyst::Utils::home($class);
2392 #I remember recently being scolded for assigning config values like this
2393 $class->config->{home} ||= $home;
2394 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2398 =head2 $c->setup_log
2400 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2401 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2404 This method also installs a C<debug> method that returns a true value into the
2405 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2406 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2408 Note that if the log has already been setup, by either a previous call to
2409 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2410 that this method won't actually set up the log object.
2415 my ( $class, $levels ) = @_;
2418 $levels =~ s/^\s+//;
2419 $levels =~ s/\s+$//;
2420 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2422 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2423 if ( defined $env_debug ) {
2424 $levels{debug} = 1 if $env_debug; # Ugly!
2425 delete($levels{debug}) unless $env_debug;
2428 unless ( $class->log ) {
2429 $class->log( Catalyst::Log->new(keys %levels) );
2432 if ( $levels{debug} ) {
2433 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2434 $class->log->debug('Debug messages enabled');
2438 =head2 $c->setup_plugins
2444 =head2 $c->setup_stats
2446 Sets up timing statistics class.
2451 my ( $class, $stats ) = @_;
2453 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2455 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2456 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2457 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2458 $class->log->debug('Statistics enabled');
2463 =head2 $c->registered_plugins
2465 Returns a sorted list of the plugins which have either been stated in the
2466 import list or which have been added via C<< MyApp->plugin(@args); >>.
2468 If passed a given plugin name, it will report a boolean value indicating
2469 whether or not that plugin is loaded. A fully qualified name is required if
2470 the plugin name does not begin with C<Catalyst::Plugin::>.
2472 if ($c->registered_plugins('Some::Plugin')) {
2480 sub registered_plugins {
2482 return sort keys %{ $proto->_plugins } unless @_;
2484 return 1 if exists $proto->_plugins->{$plugin};
2485 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2488 sub _register_plugin {
2489 my ( $proto, $plugin, $instant ) = @_;
2490 my $class = ref $proto || $proto;
2492 Class::MOP::load_class( $plugin );
2494 $proto->_plugins->{$plugin} = 1;
2497 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2498 my @superclasses = ($plugin, $meta->superclasses );
2499 $meta->superclasses(@superclasses);
2501 unshift @{"$class\::ISA"}, $plugin;
2508 my ( $class, $plugins ) = @_;
2510 $class->_plugins( {} ) unless $class->_plugins;
2513 my @plugins = map { s/\A\+// ? $_ : "Catalyst::Plugin::$_" } @$plugins;
2515 for my $plugin ( reverse @plugins ) {
2516 Class::MOP::load_class($plugin);
2517 my $meta = find_meta($plugin);
2518 next if $meta && $meta->isa('Moose::Meta::Role');
2520 $class->_register_plugin($plugin);
2525 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2526 map { find_meta($_) }
2529 Moose::Util::apply_all_roles(
2537 Returns an arrayref of the internal execution stack (actions that are
2538 currently executing).
2540 =head2 $c->stats_class
2542 Returns or sets the stats (timing statistics) class.
2544 =head2 $c->use_stats
2546 Returns 1 when stats collection is enabled. Stats collection is enabled
2547 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2548 environment variable is set.
2550 Note that this is a static method, not an accessor and should be overridden
2551 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2558 =head2 $c->write( $data )
2560 Writes $data to the output stream. When using this method directly, you
2561 will need to manually set the C<Content-Length> header to the length of
2562 your output data, if known.
2569 # Finalize headers if someone manually writes output
2570 $c->finalize_headers;
2572 return $c->engine->write( $c, @_ );
2577 Returns the Catalyst version number. Mostly useful for "powered by"
2578 messages in template systems.
2582 sub version { return $Catalyst::VERSION }
2584 =head1 INTERNAL ACTIONS
2586 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2587 C<_ACTION>, and C<_END>. These are by default not shown in the private
2588 action table, but you can make them visible with a config parameter.
2590 MyApp->config->{show_internal_actions} = 1;
2592 =head1 CASE SENSITIVITY
2594 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2595 mapped to C</foo/bar>. You can activate case sensitivity with a config
2598 MyApp->config->{case_sensitive} = 1;
2600 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2602 =head1 ON-DEMAND PARSER
2604 The request body is usually parsed at the beginning of a request,
2605 but if you want to handle input yourself, you can enable on-demand
2606 parsing with a config parameter.
2608 MyApp->config->{parse_on_demand} = 1;
2610 =head1 PROXY SUPPORT
2612 Many production servers operate using the common double-server approach,
2613 with a lightweight frontend web server passing requests to a larger
2614 backend server. An application running on the backend server must deal
2615 with two problems: the remote user always appears to be C<127.0.0.1> and
2616 the server's hostname will appear to be C<localhost> regardless of the
2617 virtual host that the user connected through.
2619 Catalyst will automatically detect this situation when you are running
2620 the frontend and backend servers on the same machine. The following
2621 changes are made to the request.
2623 $c->req->address is set to the user's real IP address, as read from
2624 the HTTP X-Forwarded-For header.
2626 The host value for $c->req->base and $c->req->uri is set to the real
2627 host, as read from the HTTP X-Forwarded-Host header.
2629 Obviously, your web server must support these headers for this to work.
2631 In a more complex server farm environment where you may have your
2632 frontend proxy server(s) on different machines, you will need to set a
2633 configuration option to tell Catalyst to read the proxied data from the
2636 MyApp->config->{using_frontend_proxy} = 1;
2638 If you do not wish to use the proxy support at all, you may set:
2640 MyApp->config->{ignore_frontend_proxy} = 1;
2642 =head1 THREAD SAFETY
2644 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2645 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2646 believe the Catalyst core to be thread-safe.
2648 If you plan to operate in a threaded environment, remember that all other
2649 modules you are using must also be thread-safe. Some modules, most notably
2650 L<DBD::SQLite>, are not thread-safe.
2656 Join #catalyst on irc.perl.org.
2660 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2661 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2665 http://catalyst.perl.org
2669 http://dev.catalyst.perl.org
2673 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2675 =head2 L<Catalyst::Manual> - The Catalyst Manual
2677 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2679 =head2 L<Catalyst::Engine> - Core engine
2681 =head2 L<Catalyst::Log> - Log class.
2683 =head2 L<Catalyst::Request> - Request object
2685 =head2 L<Catalyst::Response> - Response object
2687 =head2 L<Catalyst::Test> - The test suite.
2689 =head1 PROJECT FOUNDER
2691 sri: Sebastian Riedel <sri@cpan.org>
2697 acme: Leon Brocard <leon@astray.com>
2705 andyg: Andy Grundman <andy@hybridized.org>
2707 audreyt: Audrey Tang
2709 bricas: Brian Cassidy <bricas@cpan.org>
2711 Caelum: Rafael Kitover <rkitover@io.com>
2713 chansen: Christian Hansen
2715 chicks: Christopher Hicks
2719 dhoss: Devin Austin <dhoss@cpan.org>
2721 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2725 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2727 esskar: Sascha Kiefer
2729 fireartist: Carl Franks <cfranks@cpan.org>
2731 gabb: Danijel Milicevic
2737 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2739 jcamacho: Juan Camacho
2741 jhannah: Jay Hannah <jay@jays.net>
2747 jon: Jon Schutz <jjschutz@cpan.org>
2749 marcus: Marcus Ramberg <mramberg@cpan.org>
2751 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2753 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2757 naughton: David Naughton
2759 ningu: David Kamholz <dkamholz@cpan.org>
2761 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2763 numa: Dan Sully <daniel@cpan.org>
2767 omega: Andreas Marienborg
2769 Oleg Kostyuk <cub.uanic@gmail.com>
2771 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2773 rafl: Florian Ragwitz <rafl@debian.org>
2775 random: Roland Lammel <lammel@cpan.org>
2779 the_jester: Jesse Sheidlower
2781 t0m: Tomas Doran <bobtfish@bobtfish.net>
2785 willert: Sebastian Willert <willert@cpan.org>
2789 This library is free software. You can redistribute it and/or modify it under
2790 the same terms as Perl itself.
2796 __PACKAGE__->meta->make_immutable;