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;
10 use Catalyst::Exception::Detach;
11 use Catalyst::Exception::Go;
13 use Catalyst::Request;
14 use Catalyst::Request::Upload;
15 use Catalyst::Response;
17 use Catalyst::Controller;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
32 use Carp qw/croak carp shortmess/;
34 BEGIN { require 5.008001; }
36 has stack => (is => 'ro', default => sub { [] });
37 has stash => (is => 'rw', default => sub { {} });
38 has state => (is => 'rw', default => 0);
39 has stats => (is => 'rw');
40 has action => (is => 'rw');
41 has counter => (is => 'rw', default => sub { {} });
42 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
43 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
44 has namespace => (is => 'rw');
46 sub depth { scalar @{ shift->stack || [] }; }
47 sub comp { shift->component(@_) }
50 my $self = shift; return $self->request(@_);
53 my $self = shift; return $self->response(@_);
56 # For backwards compatibility
57 sub finalize_output { shift->finalize_body(@_) };
62 our $RECURSION = 1000;
63 our $DETACH = Catalyst::Exception::Detach->new;
64 our $GO = Catalyst::Exception::Go->new;
66 #I imagine that very few of these really need to be class variables. if any.
67 #maybe we should just make them attributes with a default?
68 __PACKAGE__->mk_classdata($_)
69 for qw/components arguments dispatcher engine log dispatcher_class
70 engine_class context_class request_class response_class stats_class
73 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
74 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
75 __PACKAGE__->request_class('Catalyst::Request');
76 __PACKAGE__->response_class('Catalyst::Response');
77 __PACKAGE__->stats_class('Catalyst::Stats');
79 # Remember to update this in Catalyst::Runtime as well!
81 our $VERSION = '5.80007';
84 my $dev_version = $VERSION =~ /_\d{2}$/;
85 *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
88 $VERSION = eval $VERSION;
91 my ( $class, @arguments ) = @_;
93 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
95 return unless $class eq 'Catalyst';
97 my $caller = caller();
98 return if $caller eq 'main';
100 # Kill Adopt::NEXT warnings if we're a non-RC version
101 unless (_IS_DEVELOPMENT_VERSION()) {
102 Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
105 my $meta = Moose::Meta::Class->initialize($caller);
106 unless ( $caller->isa('Catalyst') ) {
107 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
108 $meta->superclasses(@superclasses);
110 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
111 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
113 unless( $meta->has_method('meta') ){
114 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
117 $caller->arguments( [@arguments] );
121 sub _application { $_[0] }
125 Catalyst - The Elegant MVC Web Application Framework
129 See the L<Catalyst::Manual> distribution for comprehensive
130 documentation and tutorials.
132 # Install Catalyst::Devel for helpers and other development tools
133 # use the helper to create a new application
136 # add models, views, controllers
137 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
138 script/myapp_create.pl view MyTemplate TT
139 script/myapp_create.pl controller Search
141 # built in testserver -- use -r to restart automatically on changes
142 # --help to see all available options
143 script/myapp_server.pl
145 # command line testing interface
146 script/myapp_test.pl /yada
149 use Catalyst qw/-Debug/; # include plugins here as well
151 ### In lib/MyApp/Controller/Root.pm (autocreated)
152 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
153 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
154 $c->stash->{template} = 'foo.tt'; # set the template
155 # lookup something from db -- stash vars are passed to TT
157 $c->model('Database::Foo')->search( { country => $args[0] } );
158 if ( $c->req->params->{bar} ) { # access GET or POST parameters
159 $c->forward( 'bar' ); # process another action
160 # do something else after forward returns
164 # The foo.tt TT template can use the stash data from the database
165 [% WHILE (item = data.next) %]
169 # called for /bar/of/soap, /bar/of/soap/10, etc.
170 sub bar : Path('/bar/of/soap') { ... }
172 # called for all actions, from the top-most controller downwards
174 my ( $self, $c ) = @_;
175 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
176 $c->res->redirect( '/login' ); # require login
177 return 0; # abort request and go immediately to end()
179 return 1; # success; carry on to next action
182 # called after all actions are finished
184 my ( $self, $c ) = @_;
185 if ( scalar @{ $c->error } ) { ... } # handle errors
186 return if $c->res->body; # already have a response
187 $c->forward( 'MyApp::View::TT' ); # render template
190 ### in MyApp/Controller/Foo.pm
191 # called for /foo/bar
192 sub bar : Local { ... }
194 # called for /blargle
195 sub blargle : Global { ... }
197 # an index action matches /foo, but not /foo/1, etc.
198 sub index : Private { ... }
200 ### in MyApp/Controller/Foo/Bar.pm
201 # called for /foo/bar/baz
202 sub baz : Local { ... }
204 # first Root auto is called, then Foo auto, then this
205 sub auto : Private { ... }
207 # powerful regular expression paths are also possible
208 sub details : Regex('^product/(\w+)/details$') {
209 my ( $self, $c ) = @_;
210 # extract the (\w+) from the URI
211 my $product = $c->req->captures->[0];
214 See L<Catalyst::Manual::Intro> for additional information.
218 Catalyst is a modern framework for making web applications without the
219 pain usually associated with this process. This document is a reference
220 to the main Catalyst application. If you are a new user, we suggest you
221 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
223 See L<Catalyst::Manual> for more documentation.
225 Catalyst plugins can be loaded by naming them as arguments to the "use
226 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
227 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
230 use Catalyst qw/My::Module/;
232 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
233 fully qualify the name by using a unary plus:
237 +Fully::Qualified::Plugin::Name
240 Special flags like C<-Debug> and C<-Engine> can also be specified as
241 arguments when Catalyst is loaded:
243 use Catalyst qw/-Debug My::Module/;
245 The position of plugins and flags in the chain is important, because
246 they are loaded in the order in which they appear.
248 The following flags are supported:
252 Enables debug output. You can also force this setting from the system
253 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
254 settings override the application, with <MYAPP>_DEBUG having the highest
259 Forces Catalyst to use a specific engine. Omit the
260 C<Catalyst::Engine::> prefix of the engine name, i.e.:
262 use Catalyst qw/-Engine=CGI/;
266 Forces Catalyst to use a specific home directory, e.g.:
268 use Catalyst qw[-Home=/usr/mst];
270 This can also be done in the shell environment by setting either the
271 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
272 is replaced with the uppercased name of your application, any "::" in
273 the name will be replaced with underscores, e.g. MyApp::Web should use
274 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
278 use Catalyst '-Log=warn,fatal,error';
280 Specifies a comma-delimited list of log levels.
284 Enables statistics collection and reporting. You can also force this setting
285 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
286 environment settings override the application, with <MYAPP>_STATS having the
291 use Catalyst qw/-Stats=1/
295 =head2 INFORMATION ABOUT THE CURRENT REQUEST
299 Returns a L<Catalyst::Action> object for the current action, which
300 stringifies to the action name. See L<Catalyst::Action>.
304 Returns the namespace of the current action, i.e., the URI prefix
305 corresponding to the controller of the current action. For example:
307 # in Controller::Foo::Bar
308 $c->namespace; # returns 'foo/bar';
314 Returns the current L<Catalyst::Request> object, giving access to
315 information about the current client request (including parameters,
316 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
318 =head2 REQUEST FLOW HANDLING
320 =head2 $c->forward( $action [, \@arguments ] )
322 =head2 $c->forward( $class, $method, [, \@arguments ] )
324 Forwards processing to another action, by its private name. If you give a
325 class name but no method, C<process()> is called. You may also optionally
326 pass arguments in an arrayref. The action will receive the arguments in
327 C<@_> and C<< $c->req->args >>. Upon returning from the function,
328 C<< $c->req->args >> will be restored to the previous values.
330 Any data C<return>ed from the action forwarded to, will be returned by the
333 my $foodata = $c->forward('/foo');
334 $c->forward('index');
335 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
336 $c->forward('MyApp::View::TT');
338 Note that forward implies an C<<eval { }>> around the call (actually
339 C<execute> does), thus de-fatalizing all 'dies' within the called
340 action. If you want C<die> to propagate you need to do something like:
343 die $c->error if $c->error;
345 Or make sure to always return true values from your actions and write
348 $c->forward('foo') || return;
352 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
354 =head2 $c->detach( $action [, \@arguments ] )
356 =head2 $c->detach( $class, $method, [, \@arguments ] )
360 The same as C<forward>, but doesn't return to the previous action when
361 processing is finished.
363 When called with no arguments it escapes the processing chain entirely.
367 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
369 =head2 $c->visit( $action [, \@captures, \@arguments ] )
371 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
373 Almost the same as C<forward>, but does a full dispatch, instead of just
374 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
375 C<auto> and the method you go to are called, just like a new request.
377 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
378 This means, for example, that $c->action methods such as C<name>, C<class> and
379 C<reverse> return information for the visited action when they are invoked
380 within the visited action. This is different from the behavior of C<forward>
381 which continues to use the $c->action object from the caller action even when
382 invoked from the callee.
384 C<$c-E<gt>stash> is kept unchanged.
386 In effect, C<visit> allows you to "wrap" another action, just as it
387 would have been called by dispatching from a URL, while the analogous
388 C<go> allows you to transfer control to another action as if it had
389 been reached directly from a URL.
393 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
395 =head2 $c->go( $action [, \@captures, \@arguments ] )
397 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
399 Almost the same as C<detach>, but does a full dispatch like C<visit>,
400 instead of just calling the new C<$action> /
401 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
402 method you visit are called, just like a new request.
404 C<$c-E<gt>stash> is kept unchanged.
408 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
414 Returns the current L<Catalyst::Response> object, see there for details.
418 Returns a hashref to the stash, which may be used to store data and pass
419 it between components during a request. You can also set hash keys by
420 passing arguments. The stash is automatically sent to the view. The
421 stash is cleared at the end of a request; it cannot be used for
422 persistent storage (for this you must use a session; see
423 L<Catalyst::Plugin::Session> for a complete system integrated with
426 $c->stash->{foo} = $bar;
427 $c->stash( { moose => 'majestic', qux => 0 } );
428 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
430 # stash is automatically passed to the view for use in a template
431 $c->forward( 'MyApp::View::TT' );
435 around stash => sub {
438 my $stash = $orig->($c);
440 my $new_stash = @_ > 1 ? {@_} : $_[0];
441 croak('stash takes a hash or hashref') unless ref $new_stash;
442 foreach my $key ( keys %$new_stash ) {
443 $stash->{$key} = $new_stash->{$key};
453 =head2 $c->error($error, ...)
455 =head2 $c->error($arrayref)
457 Returns an arrayref containing error messages. If Catalyst encounters an
458 error while processing a request, it stores the error in $c->error. This
459 method should only be used to store fatal error messages.
461 my @error = @{ $c->error };
465 $c->error('Something bad happened');
472 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
473 croak @$error unless ref $c;
474 push @{ $c->{error} }, @$error;
476 elsif ( defined $_[0] ) { $c->{error} = undef }
477 return $c->{error} || [];
483 Contains the return value of the last executed action.
485 =head2 $c->clear_errors
487 Clear errors. You probably don't want to clear the errors unless you are
488 implementing a custom error screen.
490 This is equivalent to running
501 sub _comp_search_prefixes {
503 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
506 # search components given a name and some prefixes
507 sub _comp_names_search_prefixes {
508 my ( $c, $name, @prefixes ) = @_;
509 my $appclass = ref $c || $c;
510 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
511 $filter = qr/$filter/; # Compile regex now rather than once per loop
513 # map the original component name to the sub part that we will search against
514 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
515 grep { /$filter/ } keys %{ $c->components };
517 # undef for a name will return all
518 return keys %eligible if !defined $name;
520 my $query = ref $name ? $name : qr/^$name$/i;
521 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
523 return @result if @result;
525 # if we were given a regexp to search against, we're done.
530 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
532 # no results? try against full names
534 @result = grep { m{$query} } keys %eligible;
537 # don't warn if we didn't find any results, it just might not exist
539 # Disgusting hack to work out correct method name
540 my $warn_for = lc $prefixes[0];
541 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
542 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
543 "component resolution is unreliable and unsafe.";
544 my $short = $result[0];
545 $short =~ s/.*?Model:://;
546 my $shortmess = Carp::shortmess('');
547 if ($shortmess =~ m#Catalyst/Plugin#) {
548 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
550 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
551 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
552 "component's config";
554 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
555 "but if you really wanted to search, pass in a regexp as the argument " .
556 "like so: \$c->${warn_for}(qr/${name}/)";
558 $c->log->warn( "${msg}$shortmess" );
564 # Find possible names for a prefix
566 my ( $c, @prefixes ) = @_;
567 my $appclass = ref $c || $c;
569 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
571 my @names = map { s{$filter}{}; $_; }
572 $c->_comp_names_search_prefixes( undef, @prefixes );
577 # Filter a component before returning by calling ACCEPT_CONTEXT if available
578 sub _filter_component {
579 my ( $c, $comp, @args ) = @_;
581 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
582 return $comp->ACCEPT_CONTEXT( $c, @args );
588 =head2 COMPONENT ACCESSORS
590 =head2 $c->controller($name)
592 Gets a L<Catalyst::Controller> instance by name.
594 $c->controller('Foo')->do_stuff;
596 If the name is omitted, will return the controller for the dispatched
599 If you want to search for controllers, pass in a regexp as the argument.
601 # find all controllers that start with Foo
602 my @foo_controllers = $c->controller(qr{^Foo});
608 my ( $c, $name, @args ) = @_;
611 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
612 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
613 return $c->_filter_component( $result[ 0 ], @args );
616 return $c->component( $c->action->class );
619 =head2 $c->model($name)
621 Gets a L<Catalyst::Model> instance by name.
623 $c->model('Foo')->do_stuff;
625 Any extra arguments are directly passed to ACCEPT_CONTEXT.
627 If the name is omitted, it will look for
628 - a model object in $c->stash->{current_model_instance}, then
629 - a model name in $c->stash->{current_model}, then
630 - a config setting 'default_model', or
631 - check if there is only one model, and return it if that's the case.
633 If you want to search for models, pass in a regexp as the argument.
635 # find all models that start with Foo
636 my @foo_models = $c->model(qr{^Foo});
641 my ( $c, $name, @args ) = @_;
644 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
645 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
646 return $c->_filter_component( $result[ 0 ], @args );
650 return $c->stash->{current_model_instance}
651 if $c->stash->{current_model_instance};
652 return $c->model( $c->stash->{current_model} )
653 if $c->stash->{current_model};
655 return $c->model( $c->config->{default_model} )
656 if $c->config->{default_model};
658 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
661 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
662 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
663 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
664 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
665 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
668 return $c->_filter_component( $comp );
672 =head2 $c->view($name)
674 Gets a L<Catalyst::View> instance by name.
676 $c->view('Foo')->do_stuff;
678 Any extra arguments are directly passed to ACCEPT_CONTEXT.
680 If the name is omitted, it will look for
681 - a view object in $c->stash->{current_view_instance}, then
682 - a view name in $c->stash->{current_view}, then
683 - a config setting 'default_view', or
684 - check if there is only one view, and return it if that's the case.
686 If you want to search for views, pass in a regexp as the argument.
688 # find all views that start with Foo
689 my @foo_views = $c->view(qr{^Foo});
694 my ( $c, $name, @args ) = @_;
697 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
698 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
699 return $c->_filter_component( $result[ 0 ], @args );
703 return $c->stash->{current_view_instance}
704 if $c->stash->{current_view_instance};
705 return $c->view( $c->stash->{current_view} )
706 if $c->stash->{current_view};
708 return $c->view( $c->config->{default_view} )
709 if $c->config->{default_view};
711 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
714 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
715 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
716 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
717 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
718 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
721 return $c->_filter_component( $comp );
724 =head2 $c->controllers
726 Returns the available names which can be passed to $c->controller
732 return $c->_comp_names(qw/Controller C/);
737 Returns the available names which can be passed to $c->model
743 return $c->_comp_names(qw/Model M/);
749 Returns the available names which can be passed to $c->view
755 return $c->_comp_names(qw/View V/);
758 =head2 $c->comp($name)
760 =head2 $c->component($name)
762 Gets a component object by name. This method is not recommended,
763 unless you want to get a specific component by full
764 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
765 should be used instead.
767 If C<$name> is a regexp, a list of components matched against the full
768 component name will be returned.
773 my ( $c, $name, @args ) = @_;
776 my $comps = $c->components;
779 # is it the exact name?
780 return $c->_filter_component( $comps->{ $name }, @args )
781 if exists $comps->{ $name };
783 # perhaps we just omitted "MyApp"?
784 my $composed = ( ref $c || $c ) . "::${name}";
785 return $c->_filter_component( $comps->{ $composed }, @args )
786 if exists $comps->{ $composed };
788 # search all of the models, views and controllers
789 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
790 return $c->_filter_component( $comp, @args ) if $comp;
793 # This is here so $c->comp( '::M::' ) works
794 my $query = ref $name ? $name : qr{$name}i;
796 my @result = grep { m{$query} } keys %{ $c->components };
797 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
800 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
801 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
802 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
803 return $c->_filter_component( $result[ 0 ], @args );
806 # I would expect to return an empty list here, but that breaks back-compat
810 return sort keys %{ $c->components };
813 =head2 CLASS DATA AND HELPER CLASSES
817 Returns or takes a hashref containing the application's configuration.
819 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
821 You can also use a C<YAML>, C<XML> or C<Config::General> config file
822 like myapp.conf in your applications home directory. See
823 L<Catalyst::Plugin::ConfigLoader>.
825 =head3 Cascading configuration.
827 The config method is present on all Catalyst components, and configuration
828 will be merged when an application is started. Configuration loaded with
829 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
830 followed by configuration in your top level C<MyApp> class. These two
831 configurations are merged, and then configuration data whose hash key matches a
832 component name is merged with configuration for that component.
834 The configuration for a component is then passed to the C<new> method when a
835 component is constructed.
839 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
840 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
842 will mean that C<MyApp::Model::Foo> receives the following data when
845 MyApp::Model::Foo->new({
853 around config => sub {
857 croak('Setting config after setup has been run is not allowed.')
858 if ( @_ and $c->setup_finished );
865 Returns the logging object instance. Unless it is already set, Catalyst
866 sets this up with a L<Catalyst::Log> object. To use your own log class,
867 set the logger with the C<< __PACKAGE__->log >> method prior to calling
868 C<< __PACKAGE__->setup >>.
870 __PACKAGE__->log( MyLogger->new );
875 $c->log->info( 'Now logging with my own logger!' );
877 Your log class should implement the methods described in
883 Returns 1 if debug mode is enabled, 0 otherwise.
885 You can enable debug mode in several ways:
889 =item By calling myapp_server.pl with the -d flag
891 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
893 =item The -Debug option in your MyApp.pm
895 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
899 Calling C<< $c->debug(1) >> has no effect.
905 =head2 $c->dispatcher
907 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
911 Returns the engine instance. See L<Catalyst::Engine>.
914 =head2 UTILITY METHODS
916 =head2 $c->path_to(@path)
918 Merges C<@path> with C<< $c->config->{home} >> and returns a
919 L<Path::Class::Dir> object. Note you can usually use this object as
920 a filename, but sometimes you will have to explicitly stringify it
921 yourself by calling the C<<->stringify>> method.
925 $c->path_to( 'db', 'sqlite.db' );
930 my ( $c, @path ) = @_;
931 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
932 if ( -d $path ) { return $path }
933 else { return Path::Class::File->new( $c->config->{home}, @path ) }
936 =head2 $c->plugin( $name, $class, @args )
938 Helper method for plugins. It creates a class data accessor/mutator and
939 loads and instantiates the given class.
941 MyApp->plugin( 'prototype', 'HTML::Prototype' );
943 $c->prototype->define_javascript_functions;
945 B<Note:> This method of adding plugins is deprecated. The ability
946 to add plugins like this B<will be removed> in a Catalyst 5.81.
947 Please do not use this functionality in new code.
952 my ( $class, $name, $plugin, @args ) = @_;
954 # See block comment in t/unit_core_plugin.t
955 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
957 $class->_register_plugin( $plugin, 1 );
959 eval { $plugin->import };
960 $class->mk_classdata($name);
962 eval { $obj = $plugin->new(@args) };
965 Catalyst::Exception->throw( message =>
966 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
970 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
976 Initializes the dispatcher and engine, loads any plugins, and loads the
977 model, view, and controller components. You may also specify an array
978 of plugins to load here, if you choose to not load them in the C<use
982 MyApp->setup( qw/-Debug/ );
987 my ( $class, @arguments ) = @_;
988 croak('Running setup more than once')
989 if ( $class->setup_finished );
991 unless ( $class->isa('Catalyst') ) {
993 Catalyst::Exception->throw(
994 message => qq/'$class' does not inherit from Catalyst/ );
997 if ( $class->arguments ) {
998 @arguments = ( @arguments, @{ $class->arguments } );
1004 foreach (@arguments) {
1008 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1010 elsif (/^-(\w+)=?(.*)$/) {
1011 $flags->{ lc $1 } = $2;
1014 push @{ $flags->{plugins} }, $_;
1018 $class->setup_home( delete $flags->{home} );
1020 $class->setup_log( delete $flags->{log} );
1021 $class->setup_plugins( delete $flags->{plugins} );
1022 $class->setup_dispatcher( delete $flags->{dispatcher} );
1023 $class->setup_engine( delete $flags->{engine} );
1024 $class->setup_stats( delete $flags->{stats} );
1026 for my $flag ( sort keys %{$flags} ) {
1028 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1029 &$code( $class, delete $flags->{$flag} );
1032 $class->log->warn(qq/Unknown flag "$flag"/);
1036 eval { require Catalyst::Devel; };
1037 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1038 $class->log->warn(<<"EOF");
1039 You are running an old script!
1041 Please update by running (this will overwrite existing files):
1042 catalyst.pl -force -scripts $class
1044 or (this will not overwrite existing files):
1045 catalyst.pl -scripts $class
1050 if ( $class->debug ) {
1051 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1054 my $column_width = Catalyst::Utils::term_width() - 6;
1055 my $t = Text::SimpleTable->new($column_width);
1056 $t->row($_) for @plugins;
1057 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1060 my $dispatcher = $class->dispatcher;
1061 my $engine = $class->engine;
1062 my $home = $class->config->{home};
1064 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1065 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1069 ? $class->log->debug(qq/Found home "$home"/)
1070 : $class->log->debug(qq/Home "$home" doesn't exist/)
1071 : $class->log->debug(q/Couldn't find home/);
1074 # Call plugins setup, this is stupid and evil.
1075 # Also screws C3 badly on 5.10, hack to avoid.
1077 no warnings qw/redefine/;
1078 local *setup = sub { };
1079 $class->setup unless $Catalyst::__AM_RESTARTING;
1082 # Initialize our data structure
1083 $class->components( {} );
1085 $class->setup_components;
1087 if ( $class->debug ) {
1088 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1089 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1090 for my $comp ( sort keys %{ $class->components } ) {
1091 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1092 $t->row( $comp, $type );
1094 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1095 if ( keys %{ $class->components } );
1098 # Add our self to components, since we are also a component
1099 if( $class->isa('Catalyst::Controller') ){
1100 $class->components->{$class} = $class;
1103 $class->setup_actions;
1105 if ( $class->debug ) {
1106 my $name = $class->config->{name} || 'Application';
1107 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1109 $class->log->_flush() if $class->log->can('_flush');
1111 # Make sure that the application class becomes immutable at this point,
1112 # which ensures that it gets an inlined constructor. This means that it
1113 # works even if the user has added a plugin which contains a new method.
1114 # Note however that we have to do the work on scope end, so that method
1115 # modifiers work correctly in MyApp (as you have to call setup _before_
1116 # applying modifiers).
1117 B::Hooks::EndOfScope::on_scope_end {
1119 my $meta = Class::MOP::get_metaclass_by_name($class);
1120 if ( $meta->is_immutable && ! { $meta->immutable_options }->{inline_constructor} ) {
1121 warn "You made your application class ($class) immutable, "
1122 . "but did not inline the constructor.\n"
1123 . "This will break catalyst, please pass "
1124 . "(replace_constructor => 1) when making your class immutable.\n";
1126 $meta->make_immutable(replace_constructor => 1) unless $meta->is_immutable;
1129 $class->setup_finalize;
1133 =head2 $app->setup_finalize
1135 A hook to attach modifiers to.
1136 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1137 Also better than C< setup_finished(); >, as that is a getter method.
1139 sub setup_finalize {
1143 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1145 $app->next::method(@_);
1152 sub setup_finalize {
1154 $class->setup_finished(1);
1157 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1159 =head2 $c->uri_for( $path, @args?, \%query_values? )
1165 A Catalyst::Action object representing the Catalyst action you want to
1166 create a URI for. To get one for an action in the current controller,
1167 use C<< $c->action('someactionname') >>. To get one from different
1168 controller, fetch the controller using C<< $c->controller() >>, then
1169 call C<action_for> on it.
1171 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1172 using C<< $c->req->captures >>.
1174 # For the current action
1175 $c->uri_for($c->action, $c->req->captures);
1177 # For the Foo action in the Bar controller
1178 $c->uri_for($c->controller('Bar')->action_for('Foo'), $c->req->captures);
1185 my ( $c, $path, @args ) = @_;
1187 if ( blessed($path) ) { # action object
1188 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1192 $path = $c->dispatcher->uri_for_action($action, $captures);
1193 if (not defined $path) {
1194 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1198 $path = '/' if $path eq '';
1201 undef($path) if (defined $path && $path eq '');
1204 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1206 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1207 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1209 unshift(@args, $path);
1211 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1212 my $namespace = $c->namespace;
1213 if (defined $path) { # cheesy hack to handle path '../foo'
1214 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1216 unshift(@args, $namespace || '');
1219 # join args with '/', or a blank string
1220 my $args = join('/', grep { defined($_) } @args);
1221 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1223 my $base = $c->req->base;
1224 my $class = ref($base);
1225 $base =~ s{(?<!/)$}{/};
1229 if (my @keys = keys %$params) {
1230 # somewhat lifted from URI::_query's query_form
1231 $query = '?'.join('&', map {
1232 my $val = $params->{$_};
1233 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1236 $val = '' unless defined $val;
1239 utf8::encode( $param ) if utf8::is_utf8($param);
1240 # using the URI::Escape pattern here so utf8 chars survive
1241 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1243 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1247 my $res = bless(\"${base}${args}${query}", $class);
1251 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1253 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1259 A private path to the Catalyst action you want to create a URI for.
1261 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1262 >> and passing the resulting C<$action> and the remaining arguments to C<<
1265 You can also pass in a Catalyst::Action object, in which case it is passed to
1272 sub uri_for_action {
1273 my ( $c, $path, @args ) = @_;
1274 my $action = blessed($path)
1276 : $c->dispatcher->get_action_by_path($path);
1277 unless (defined $action) {
1278 croak "Can't find action for path '$path'";
1280 return $c->uri_for( $action, @args );
1283 =head2 $c->welcome_message
1285 Returns the Catalyst welcome HTML page.
1289 sub welcome_message {
1291 my $name = $c->config->{name};
1292 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1293 my $prefix = Catalyst::Utils::appprefix( ref $c );
1294 $c->response->content_type('text/html; charset=utf-8');
1296 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1297 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1298 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1300 <meta http-equiv="Content-Language" content="en" />
1301 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1302 <title>$name on Catalyst $VERSION</title>
1303 <style type="text/css">
1306 background-color: #eee;
1313 margin-bottom: 10px;
1315 background-color: #ccc;
1316 border: 1px solid #aaa;
1321 font-family: verdana, tahoma, sans-serif;
1324 font-family: verdana, tahoma, sans-serif;
1327 text-decoration: none;
1329 border-bottom: 1px dotted #bbb;
1331 :link:hover, :visited:hover {
1344 background-color: #fff;
1345 border: 1px solid #aaa;
1349 font-weight: normal;
1371 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1376 <img src="$logo" alt="Catalyst Logo" />
1378 <p>Welcome to the world of Catalyst.
1379 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1380 framework will make web development something you had
1381 never expected it to be: Fun, rewarding, and quick.</p>
1382 <h2>What to do now?</h2>
1383 <p>That really depends on what <b>you</b> want to do.
1384 We do, however, provide you with a few starting points.</p>
1385 <p>If you want to jump right into web development with Catalyst
1386 you might want to start with a tutorial.</p>
1387 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1389 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1391 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1392 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1394 <h2>What to do next?</h2>
1395 <p>Next it's time to write an actual application. Use the
1396 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1397 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1398 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1399 they can save you a lot of work.</p>
1400 <pre><code>script/${prefix}_create.pl -help</code></pre>
1401 <p>Also, be sure to check out the vast and growing
1402 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1403 you are likely to find what you need there.
1407 <p>Catalyst has a very active community. Here are the main places to
1408 get in touch with us.</p>
1411 <a href="http://dev.catalyst.perl.org">Wiki</a>
1414 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1417 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1420 <h2>In conclusion</h2>
1421 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1422 as we enjoyed making it. Please contact us if you have ideas
1423 for improvement or other feedback.</p>
1431 =head1 INTERNAL METHODS
1433 These methods are not meant to be used by end users.
1435 =head2 $c->components
1437 Returns a hash of components.
1439 =head2 $c->context_class
1441 Returns or sets the context class.
1445 Returns a hashref containing coderefs and execution counts (needed for
1446 deep recursion detection).
1450 Returns the number of actions on the current internal execution stack.
1454 Dispatches a request to actions.
1458 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1460 =head2 $c->dispatcher_class
1462 Returns or sets the dispatcher class.
1464 =head2 $c->dump_these
1466 Returns a list of 2-element array references (name, structure) pairs
1467 that will be dumped on the error page in debug mode.
1473 [ Request => $c->req ],
1474 [ Response => $c->res ],
1475 [ Stash => $c->stash ],
1476 [ Config => $c->config ];
1479 =head2 $c->engine_class
1481 Returns or sets the engine class.
1483 =head2 $c->execute( $class, $coderef )
1485 Execute a coderef in given class and catch exceptions. Errors are available
1491 my ( $c, $class, $code ) = @_;
1492 $class = $c->component($class) || $class;
1495 if ( $c->depth >= $RECURSION ) {
1496 my $action = $code->reverse();
1497 $action = "/$action" unless $action =~ /->/;
1498 my $error = qq/Deep recursion detected calling "${action}"/;
1499 $c->log->error($error);
1505 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1507 push( @{ $c->stack }, $code );
1509 no warnings 'recursion';
1510 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1512 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1514 my $last = pop( @{ $c->stack } );
1516 if ( my $error = $@ ) {
1517 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1518 $error->rethrow if $c->depth > 1;
1520 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1521 $error->rethrow if $c->depth > 0;
1524 unless ( ref $error ) {
1525 no warnings 'uninitialized';
1527 my $class = $last->class;
1528 my $name = $last->name;
1529 $error = qq/Caught exception in $class->$name "$error"/;
1538 sub _stats_start_execute {
1539 my ( $c, $code ) = @_;
1541 return if ( ( $code->name =~ /^_.*/ )
1542 && ( !$c->config->{show_internal_actions} ) );
1544 my $action_name = $code->reverse();
1545 $c->counter->{$action_name}++;
1547 my $action = $action_name;
1548 $action = "/$action" unless $action =~ /->/;
1550 # determine if the call was the result of a forward
1551 # this is done by walking up the call stack and looking for a calling
1552 # sub of Catalyst::forward before the eval
1554 for my $index ( 2 .. 11 ) {
1556 if ( ( caller($index) )[0] eq 'Catalyst'
1557 && ( caller($index) )[3] eq '(eval)' );
1559 if ( ( caller($index) )[3] =~ /forward$/ ) {
1560 $callsub = ( caller($index) )[3];
1561 $action = "-> $action";
1566 my $uid = $action_name . $c->counter->{$action_name};
1568 # is this a root-level call or a forwarded call?
1569 if ( $callsub =~ /forward$/ ) {
1571 # forward, locate the caller
1572 if ( my $parent = $c->stack->[-1] ) {
1575 parent => "$parent" . $c->counter->{"$parent"},
1581 # forward with no caller may come from a plugin
1600 sub _stats_finish_execute {
1601 my ( $c, $info ) = @_;
1602 $c->stats->profile( end => $info );
1605 =head2 $c->_localize_fields( sub { }, \%keys );
1609 #Why does this exist? This is no longer safe and WILL NOT WORK.
1610 # it doesnt seem to be used anywhere. can we remove it?
1611 sub _localize_fields {
1612 my ( $c, $localized, $code ) = ( @_ );
1614 my $request = delete $localized->{request} || {};
1615 my $response = delete $localized->{response} || {};
1617 local @{ $c }{ keys %$localized } = values %$localized;
1618 local @{ $c->request }{ keys %$request } = values %$request;
1619 local @{ $c->response }{ keys %$response } = values %$response;
1626 Finalizes the request.
1633 for my $error ( @{ $c->error } ) {
1634 $c->log->error($error);
1637 # Allow engine to handle finalize flow (for POE)
1638 my $engine = $c->engine;
1639 if ( my $code = $engine->can('finalize') ) {
1644 $c->finalize_uploads;
1647 if ( $#{ $c->error } >= 0 ) {
1651 $c->finalize_headers;
1654 if ( $c->request->method eq 'HEAD' ) {
1655 $c->response->body('');
1661 if ($c->use_stats) {
1662 my $elapsed = sprintf '%f', $c->stats->elapsed;
1663 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1665 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1668 return $c->response->status;
1671 =head2 $c->finalize_body
1677 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1679 =head2 $c->finalize_cookies
1685 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1687 =head2 $c->finalize_error
1693 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1695 =head2 $c->finalize_headers
1701 sub finalize_headers {
1704 my $response = $c->response; #accessor calls can add up?
1706 # Check if we already finalized headers
1707 return if $response->finalized_headers;
1710 if ( my $location = $response->redirect ) {
1711 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1712 $response->header( Location => $location );
1714 if ( !$response->has_body ) {
1715 # Add a default body if none is already present
1717 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1723 if ( $response->body && !$response->content_length ) {
1725 # get the length from a filehandle
1726 if ( blessed( $response->body ) && $response->body->can('read') )
1728 my $stat = stat $response->body;
1729 if ( $stat && $stat->size > 0 ) {
1730 $response->content_length( $stat->size );
1733 $c->log->warn('Serving filehandle without a content-length');
1737 # everything should be bytes at this point, but just in case
1738 $response->content_length( bytes::length( $response->body ) );
1743 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1744 $response->headers->remove_header("Content-Length");
1745 $response->body('');
1748 $c->finalize_cookies;
1750 $c->engine->finalize_headers( $c, @_ );
1753 $response->finalized_headers(1);
1756 =head2 $c->finalize_output
1758 An alias for finalize_body.
1760 =head2 $c->finalize_read
1762 Finalizes the input after reading is complete.
1766 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1768 =head2 $c->finalize_uploads
1770 Finalizes uploads. Cleans up any temporary files.
1774 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1776 =head2 $c->get_action( $action, $namespace )
1778 Gets an action in a given namespace.
1782 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1784 =head2 $c->get_actions( $action, $namespace )
1786 Gets all actions of a given name in a namespace and all parent
1791 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1793 =head2 $c->handle_request( $class, @arguments )
1795 Called to handle each HTTP request.
1799 sub handle_request {
1800 my ( $class, @arguments ) = @_;
1802 # Always expect worst case!
1805 if ($class->debug) {
1806 my $secs = time - $START || 1;
1807 my $av = sprintf '%.3f', $COUNT / $secs;
1808 my $time = localtime time;
1809 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1812 my $c = $class->prepare(@arguments);
1814 $status = $c->finalize;
1817 if ( my $error = $@ ) {
1819 $class->log->error(qq/Caught exception in engine "$error"/);
1824 if(my $coderef = $class->log->can('_flush')){
1825 $class->log->$coderef();
1830 =head2 $c->prepare( @arguments )
1832 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1838 my ( $class, @arguments ) = @_;
1841 # After the app/ctxt split, this should become an attribute based on something passed
1842 # into the application.
1843 $class->context_class( ref $class || $class ) unless $class->context_class;
1845 my $c = $class->context_class->new({});
1847 # For on-demand data
1848 $c->request->_context($c);
1849 $c->response->_context($c);
1851 #surely this is not the most efficient way to do things...
1852 $c->stats($class->stats_class->new)->enable($c->use_stats);
1854 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1857 #XXX reuse coderef from can
1858 # Allow engine to direct the prepare flow (for POE)
1859 if ( $c->engine->can('prepare') ) {
1860 $c->engine->prepare( $c, @arguments );
1863 $c->prepare_request(@arguments);
1864 $c->prepare_connection;
1865 $c->prepare_query_parameters;
1866 $c->prepare_headers;
1867 $c->prepare_cookies;
1870 # Prepare the body for reading, either by prepare_body
1871 # or the user, if they are using $c->read
1874 # Parse the body unless the user wants it on-demand
1875 unless ( $c->config->{parse_on_demand} ) {
1880 my $method = $c->req->method || '';
1881 my $path = $c->req->path;
1882 $path = '/' unless length $path;
1883 my $address = $c->req->address || '';
1885 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1893 =head2 $c->prepare_action
1895 Prepares action. See L<Catalyst::Dispatcher>.
1899 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1901 =head2 $c->prepare_body
1903 Prepares message body.
1910 return if $c->request->_has_body;
1912 # Initialize on-demand data
1913 $c->engine->prepare_body( $c, @_ );
1914 $c->prepare_parameters;
1915 $c->prepare_uploads;
1917 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1918 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1919 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1920 my $param = $c->req->body_parameters->{$key};
1921 my $value = defined($param) ? $param : '';
1923 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1925 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1929 =head2 $c->prepare_body_chunk( $chunk )
1931 Prepares a chunk of data before sending it to L<HTTP::Body>.
1933 See L<Catalyst::Engine>.
1937 sub prepare_body_chunk {
1939 $c->engine->prepare_body_chunk( $c, @_ );
1942 =head2 $c->prepare_body_parameters
1944 Prepares body parameters.
1948 sub prepare_body_parameters {
1950 $c->engine->prepare_body_parameters( $c, @_ );
1953 =head2 $c->prepare_connection
1955 Prepares connection.
1959 sub prepare_connection {
1961 $c->engine->prepare_connection( $c, @_ );
1964 =head2 $c->prepare_cookies
1970 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1972 =head2 $c->prepare_headers
1978 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1980 =head2 $c->prepare_parameters
1982 Prepares parameters.
1986 sub prepare_parameters {
1988 $c->prepare_body_parameters;
1989 $c->engine->prepare_parameters( $c, @_ );
1992 =head2 $c->prepare_path
1994 Prepares path and base.
1998 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2000 =head2 $c->prepare_query_parameters
2002 Prepares query parameters.
2006 sub prepare_query_parameters {
2009 $c->engine->prepare_query_parameters( $c, @_ );
2011 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2012 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2013 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2014 my $param = $c->req->query_parameters->{$key};
2015 my $value = defined($param) ? $param : '';
2017 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2019 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2023 =head2 $c->prepare_read
2025 Prepares the input for reading.
2029 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2031 =head2 $c->prepare_request
2033 Prepares the engine request.
2037 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2039 =head2 $c->prepare_uploads
2045 sub prepare_uploads {
2048 $c->engine->prepare_uploads( $c, @_ );
2050 if ( $c->debug && keys %{ $c->request->uploads } ) {
2051 my $t = Text::SimpleTable->new(
2052 [ 12, 'Parameter' ],
2057 for my $key ( sort keys %{ $c->request->uploads } ) {
2058 my $upload = $c->request->uploads->{$key};
2059 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2060 $t->row( $key, $u->filename, $u->type, $u->size );
2063 $c->log->debug( "File Uploads are:\n" . $t->draw );
2067 =head2 $c->prepare_write
2069 Prepares the output for writing.
2073 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2075 =head2 $c->request_class
2077 Returns or sets the request class.
2079 =head2 $c->response_class
2081 Returns or sets the response class.
2083 =head2 $c->read( [$maxlength] )
2085 Reads a chunk of data from the request body. This method is designed to
2086 be used in a while loop, reading C<$maxlength> bytes on every call.
2087 C<$maxlength> defaults to the size of the request if not specified.
2089 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2092 Warning: If you use read(), Catalyst will not process the body,
2093 so you will not be able to access POST parameters or file uploads via
2094 $c->request. You must handle all body parsing yourself.
2098 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2106 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2108 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2110 Sets an action in a given namespace.
2114 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2116 =head2 $c->setup_actions($component)
2118 Sets up actions for a component.
2122 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2124 =head2 $c->setup_components
2126 Sets up components. Specify a C<setup_components> config option to pass
2127 additional options directly to L<Module::Pluggable>. To add additional
2128 search paths, specify a key named C<search_extra> as an array
2129 reference. Items in the array beginning with C<::> will have the
2130 application class name prepended to them.
2132 All components found will also have any
2133 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2134 Note, that modules which are B<not> an I<inner package> of the main
2135 file namespace loaded will not be instantiated as components.
2139 sub setup_components {
2142 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2143 my $config = $class->config->{ setup_components };
2144 my $extra = delete $config->{ search_extra } || [];
2146 push @paths, @$extra;
2148 my $locator = Module::Pluggable::Object->new(
2149 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2153 my @comps = sort { length $a <=> length $b } $locator->plugins;
2154 my %comps = map { $_ => 1 } @comps;
2156 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2157 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2158 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2159 ) if $deprecated_component_names;
2161 for my $component ( @comps ) {
2163 # We pass ignore_loaded here so that overlay files for (e.g.)
2164 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2165 # we know M::P::O found a file on disk so this is safe
2167 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2168 #Class::MOP::load_class($component);
2170 my $module = $class->setup_component( $component );
2172 $component => $module,
2174 $_ => $class->setup_component( $_ )
2176 not exists $comps{$_}
2177 } Devel::InnerPackage::list_packages( $component )
2180 for my $key ( keys %modules ) {
2181 $class->components->{ $key } = $modules{ $key };
2186 =head2 $c->setup_component
2190 sub _controller_init_base_classes {
2191 my ($app_class, $component) = @_;
2192 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2193 Moose::Meta::Class->initialize( $class )
2194 unless find_meta($class);
2198 sub setup_component {
2199 my( $class, $component ) = @_;
2201 unless ( $component->can( 'COMPONENT' ) ) {
2205 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2206 # nearest to Catalyst::Controller first, no matter what order stuff happens
2207 # to be loaded. There are TODO tests in Moose for this, see
2208 # f2391d17574eff81d911b97be15ea51080500003
2209 if ($component->isa('Catalyst::Controller')) {
2210 $class->_controller_init_base_classes($component);
2213 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2214 my $config = $class->config->{ $suffix } || {};
2216 my $instance = eval { $component->COMPONENT( $class, $config ); };
2218 if ( my $error = $@ ) {
2220 Catalyst::Exception->throw(
2221 message => qq/Couldn't instantiate component "$component", "$error"/
2225 unless (blessed $instance) {
2226 my $metaclass = Moose::Util::find_meta($component);
2227 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2228 my $component_method_from = $method_meta->associated_metaclass->name;
2229 my $value = defined($instance) ? $instance : 'undef';
2230 Catalyst::Exception->throw(
2232 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2238 =head2 $c->setup_dispatcher
2244 sub setup_dispatcher {
2245 my ( $class, $dispatcher ) = @_;
2248 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2251 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2252 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2255 unless ($dispatcher) {
2256 $dispatcher = $class->dispatcher_class;
2259 Class::MOP::load_class($dispatcher);
2261 # dispatcher instance
2262 $class->dispatcher( $dispatcher->new );
2265 =head2 $c->setup_engine
2272 my ( $class, $engine ) = @_;
2275 $engine = 'Catalyst::Engine::' . $engine;
2278 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2279 $engine = 'Catalyst::Engine::' . $env;
2282 if ( $ENV{MOD_PERL} ) {
2283 my $meta = Class::MOP::get_metaclass_by_name($class);
2285 # create the apache method
2286 $meta->add_method('apache' => sub { shift->engine->apache });
2288 my ( $software, $version ) =
2289 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2292 $version =~ s/(\.[^.]+)\./$1/g;
2294 if ( $software eq 'mod_perl' ) {
2298 if ( $version >= 1.99922 ) {
2299 $engine = 'Catalyst::Engine::Apache2::MP20';
2302 elsif ( $version >= 1.9901 ) {
2303 $engine = 'Catalyst::Engine::Apache2::MP19';
2306 elsif ( $version >= 1.24 ) {
2307 $engine = 'Catalyst::Engine::Apache::MP13';
2311 Catalyst::Exception->throw( message =>
2312 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2317 # install the correct mod_perl handler
2318 if ( $version >= 1.9901 ) {
2319 *handler = sub : method {
2320 shift->handle_request(@_);
2324 *handler = sub ($$) { shift->handle_request(@_) };
2329 elsif ( $software eq 'Zeus-Perl' ) {
2330 $engine = 'Catalyst::Engine::Zeus';
2334 Catalyst::Exception->throw(
2335 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2340 $engine = $class->engine_class;
2343 Class::MOP::load_class($engine);
2345 # check for old engines that are no longer compatible
2347 if ( $engine->isa('Catalyst::Engine::Apache')
2348 && !Catalyst::Engine::Apache->VERSION )
2353 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2354 && Catalyst::Engine::Server->VERSION le '0.02' )
2359 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2360 && $engine->VERSION eq '0.01' )
2365 elsif ($engine->isa('Catalyst::Engine::Zeus')
2366 && $engine->VERSION eq '0.01' )
2372 Catalyst::Exception->throw( message =>
2373 qq/Engine "$engine" is not supported by this version of Catalyst/
2378 $class->engine( $engine->new );
2381 =head2 $c->setup_home
2383 Sets up the home directory.
2388 my ( $class, $home ) = @_;
2390 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2394 $home ||= Catalyst::Utils::home($class);
2397 #I remember recently being scolded for assigning config values like this
2398 $class->config->{home} ||= $home;
2399 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2403 =head2 $c->setup_log
2405 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2406 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2409 This method also installs a C<debug> method that returns a true value into the
2410 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2411 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2413 Note that if the log has already been setup, by either a previous call to
2414 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2415 that this method won't actually set up the log object.
2420 my ( $class, $levels ) = @_;
2423 $levels =~ s/^\s+//;
2424 $levels =~ s/\s+$//;
2425 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2427 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2428 if ( defined $env_debug ) {
2429 $levels{debug} = 1 if $env_debug; # Ugly!
2430 delete($levels{debug}) unless $env_debug;
2433 unless ( $class->log ) {
2434 $class->log( Catalyst::Log->new(keys %levels) );
2437 if ( $levels{debug} ) {
2438 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2439 $class->log->debug('Debug messages enabled');
2443 =head2 $c->setup_plugins
2449 =head2 $c->setup_stats
2451 Sets up timing statistics class.
2456 my ( $class, $stats ) = @_;
2458 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2460 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2461 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2462 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2463 $class->log->debug('Statistics enabled');
2468 =head2 $c->registered_plugins
2470 Returns a sorted list of the plugins which have either been stated in the
2471 import list or which have been added via C<< MyApp->plugin(@args); >>.
2473 If passed a given plugin name, it will report a boolean value indicating
2474 whether or not that plugin is loaded. A fully qualified name is required if
2475 the plugin name does not begin with C<Catalyst::Plugin::>.
2477 if ($c->registered_plugins('Some::Plugin')) {
2485 sub registered_plugins {
2487 return sort keys %{ $proto->_plugins } unless @_;
2489 return 1 if exists $proto->_plugins->{$plugin};
2490 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2493 sub _register_plugin {
2494 my ( $proto, $plugin, $instant ) = @_;
2495 my $class = ref $proto || $proto;
2497 Class::MOP::load_class( $plugin );
2499 $proto->_plugins->{$plugin} = 1;
2502 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2503 my @superclasses = ($plugin, $meta->superclasses );
2504 $meta->superclasses(@superclasses);
2506 unshift @{"$class\::ISA"}, $plugin;
2513 my ( $class, $plugins ) = @_;
2515 $class->_plugins( {} ) unless $class->_plugins;
2518 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2520 for my $plugin ( reverse @plugins ) {
2521 Class::MOP::load_class($plugin);
2522 my $meta = find_meta($plugin);
2523 next if $meta && $meta->isa('Moose::Meta::Role');
2525 $class->_register_plugin($plugin);
2530 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2531 map { find_meta($_) }
2534 Moose::Util::apply_all_roles(
2542 Returns an arrayref of the internal execution stack (actions that are
2543 currently executing).
2545 =head2 $c->stats_class
2547 Returns or sets the stats (timing statistics) class.
2549 =head2 $c->use_stats
2551 Returns 1 when stats collection is enabled. Stats collection is enabled
2552 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2553 environment variable is set.
2555 Note that this is a static method, not an accessor and should be overridden
2556 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2563 =head2 $c->write( $data )
2565 Writes $data to the output stream. When using this method directly, you
2566 will need to manually set the C<Content-Length> header to the length of
2567 your output data, if known.
2574 # Finalize headers if someone manually writes output
2575 $c->finalize_headers;
2577 return $c->engine->write( $c, @_ );
2582 Returns the Catalyst version number. Mostly useful for "powered by"
2583 messages in template systems.
2587 sub version { return $Catalyst::VERSION }
2589 =head1 INTERNAL ACTIONS
2591 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2592 C<_ACTION>, and C<_END>. These are by default not shown in the private
2593 action table, but you can make them visible with a config parameter.
2595 MyApp->config->{show_internal_actions} = 1;
2597 =head1 CASE SENSITIVITY
2599 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2600 mapped to C</foo/bar>. You can activate case sensitivity with a config
2603 MyApp->config->{case_sensitive} = 1;
2605 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2607 =head1 ON-DEMAND PARSER
2609 The request body is usually parsed at the beginning of a request,
2610 but if you want to handle input yourself, you can enable on-demand
2611 parsing with a config parameter.
2613 MyApp->config->{parse_on_demand} = 1;
2615 =head1 PROXY SUPPORT
2617 Many production servers operate using the common double-server approach,
2618 with a lightweight frontend web server passing requests to a larger
2619 backend server. An application running on the backend server must deal
2620 with two problems: the remote user always appears to be C<127.0.0.1> and
2621 the server's hostname will appear to be C<localhost> regardless of the
2622 virtual host that the user connected through.
2624 Catalyst will automatically detect this situation when you are running
2625 the frontend and backend servers on the same machine. The following
2626 changes are made to the request.
2628 $c->req->address is set to the user's real IP address, as read from
2629 the HTTP X-Forwarded-For header.
2631 The host value for $c->req->base and $c->req->uri is set to the real
2632 host, as read from the HTTP X-Forwarded-Host header.
2634 Obviously, your web server must support these headers for this to work.
2636 In a more complex server farm environment where you may have your
2637 frontend proxy server(s) on different machines, you will need to set a
2638 configuration option to tell Catalyst to read the proxied data from the
2641 MyApp->config->{using_frontend_proxy} = 1;
2643 If you do not wish to use the proxy support at all, you may set:
2645 MyApp->config->{ignore_frontend_proxy} = 1;
2647 =head1 THREAD SAFETY
2649 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2650 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2651 believe the Catalyst core to be thread-safe.
2653 If you plan to operate in a threaded environment, remember that all other
2654 modules you are using must also be thread-safe. Some modules, most notably
2655 L<DBD::SQLite>, are not thread-safe.
2661 Join #catalyst on irc.perl.org.
2665 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2666 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2670 http://catalyst.perl.org
2674 http://dev.catalyst.perl.org
2678 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2680 =head2 L<Catalyst::Manual> - The Catalyst Manual
2682 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2684 =head2 L<Catalyst::Engine> - Core engine
2686 =head2 L<Catalyst::Log> - Log class.
2688 =head2 L<Catalyst::Request> - Request object
2690 =head2 L<Catalyst::Response> - Response object
2692 =head2 L<Catalyst::Test> - The test suite.
2694 =head1 PROJECT FOUNDER
2696 sri: Sebastian Riedel <sri@cpan.org>
2702 acme: Leon Brocard <leon@astray.com>
2710 andyg: Andy Grundman <andy@hybridized.org>
2712 audreyt: Audrey Tang
2714 bricas: Brian Cassidy <bricas@cpan.org>
2716 Caelum: Rafael Kitover <rkitover@io.com>
2718 chansen: Christian Hansen
2720 chicks: Christopher Hicks
2724 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2728 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2730 esskar: Sascha Kiefer
2732 fireartist: Carl Franks <cfranks@cpan.org>
2734 gabb: Danijel Milicevic
2740 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2742 jcamacho: Juan Camacho
2744 jhannah: Jay Hannah <jay@jays.net>
2750 jon: Jon Schutz <jjschutz@cpan.org>
2752 marcus: Marcus Ramberg <mramberg@cpan.org>
2754 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2756 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2760 naughton: David Naughton
2762 ningu: David Kamholz <dkamholz@cpan.org>
2764 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2766 numa: Dan Sully <daniel@cpan.org>
2770 omega: Andreas Marienborg
2772 Oleg Kostyuk <cub.uanic@gmail.com>
2774 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2776 rafl: Florian Ragwitz <rafl@debian.org>
2778 random: Roland Lammel <lammel@cpan.org>
2782 the_jester: Jesse Sheidlower
2784 t0m: Tomas Doran <bobtfish@bobtfish.net>
2788 willert: Sebastian Willert <willert@cpan.org>
2792 This library is free software. You can redistribute it and/or modify it under
2793 the same terms as Perl itself.
2799 __PACKAGE__->meta->make_immutable;