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 B::Hooks::EndOfScope::on_scope_end {
1114 my $meta = Class::MOP::get_metaclass_by_name($class);
1117 && ! { $meta->immutable_options }->{replace_constructor}
1119 $class->isa('Class::Accessor::Fast')
1120 || $class->isa('Class::Accessor')
1123 warn "You made your application class ($class) immutable, "
1124 . "but did not inline the\nconstructor. "
1125 . "This will break catalyst, as your app \@ISA "
1126 . "Class::Accessor(::Fast)?\nPlease pass "
1127 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1129 $meta->make_immutable(replace_constructor => 1)
1130 unless $meta->is_immutable;
1133 $class->setup_finalize;
1137 =head2 $app->setup_finalize
1139 A hook to attach modifiers to.
1140 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1141 Also better than C< setup_finished(); >, as that is a getter method.
1143 sub setup_finalize {
1147 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1149 $app->next::method(@_);
1156 sub setup_finalize {
1158 $class->setup_finished(1);
1161 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1163 =head2 $c->uri_for( $path, @args?, \%query_values? )
1169 A Catalyst::Action object representing the Catalyst action you want to
1170 create a URI for. To get one for an action in the current controller,
1171 use C<< $c->action('someactionname') >>. To get one from different
1172 controller, fetch the controller using C<< $c->controller() >>, then
1173 call C<action_for> on it.
1175 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1176 using C<< $c->req->captures >>.
1178 # For the current action
1179 $c->uri_for($c->action, $c->req->captures);
1181 # For the Foo action in the Bar controller
1182 $c->uri_for($c->controller('Bar')->action_for('Foo'), $c->req->captures);
1189 my ( $c, $path, @args ) = @_;
1191 if ( blessed($path) ) { # action object
1192 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1196 $path = $c->dispatcher->uri_for_action($action, $captures);
1197 if (not defined $path) {
1198 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1202 $path = '/' if $path eq '';
1205 undef($path) if (defined $path && $path eq '');
1208 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1210 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1211 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1213 unshift(@args, $path);
1215 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1216 my $namespace = $c->namespace;
1217 if (defined $path) { # cheesy hack to handle path '../foo'
1218 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1220 unshift(@args, $namespace || '');
1223 # join args with '/', or a blank string
1224 my $args = join('/', grep { defined($_) } @args);
1225 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1227 my $base = $c->req->base;
1228 my $class = ref($base);
1229 $base =~ s{(?<!/)$}{/};
1233 if (my @keys = keys %$params) {
1234 # somewhat lifted from URI::_query's query_form
1235 $query = '?'.join('&', map {
1236 my $val = $params->{$_};
1237 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1240 $val = '' unless defined $val;
1243 utf8::encode( $param ) if utf8::is_utf8($param);
1244 # using the URI::Escape pattern here so utf8 chars survive
1245 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1247 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1251 my $res = bless(\"${base}${args}${query}", $class);
1255 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1257 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1263 A private path to the Catalyst action you want to create a URI for.
1265 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1266 >> and passing the resulting C<$action> and the remaining arguments to C<<
1269 You can also pass in a Catalyst::Action object, in which case it is passed to
1276 sub uri_for_action {
1277 my ( $c, $path, @args ) = @_;
1278 my $action = blessed($path)
1280 : $c->dispatcher->get_action_by_path($path);
1281 unless (defined $action) {
1282 croak "Can't find action for path '$path'";
1284 return $c->uri_for( $action, @args );
1287 =head2 $c->welcome_message
1289 Returns the Catalyst welcome HTML page.
1293 sub welcome_message {
1295 my $name = $c->config->{name};
1296 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1297 my $prefix = Catalyst::Utils::appprefix( ref $c );
1298 $c->response->content_type('text/html; charset=utf-8');
1300 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1301 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1302 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1304 <meta http-equiv="Content-Language" content="en" />
1305 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1306 <title>$name on Catalyst $VERSION</title>
1307 <style type="text/css">
1310 background-color: #eee;
1317 margin-bottom: 10px;
1319 background-color: #ccc;
1320 border: 1px solid #aaa;
1325 font-family: verdana, tahoma, sans-serif;
1328 font-family: verdana, tahoma, sans-serif;
1331 text-decoration: none;
1333 border-bottom: 1px dotted #bbb;
1335 :link:hover, :visited:hover {
1348 background-color: #fff;
1349 border: 1px solid #aaa;
1353 font-weight: normal;
1375 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1380 <img src="$logo" alt="Catalyst Logo" />
1382 <p>Welcome to the world of Catalyst.
1383 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1384 framework will make web development something you had
1385 never expected it to be: Fun, rewarding, and quick.</p>
1386 <h2>What to do now?</h2>
1387 <p>That really depends on what <b>you</b> want to do.
1388 We do, however, provide you with a few starting points.</p>
1389 <p>If you want to jump right into web development with Catalyst
1390 you might want to start with a tutorial.</p>
1391 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1393 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1395 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1396 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1398 <h2>What to do next?</h2>
1399 <p>Next it's time to write an actual application. Use the
1400 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1401 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1402 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1403 they can save you a lot of work.</p>
1404 <pre><code>script/${prefix}_create.pl -help</code></pre>
1405 <p>Also, be sure to check out the vast and growing
1406 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1407 you are likely to find what you need there.
1411 <p>Catalyst has a very active community. Here are the main places to
1412 get in touch with us.</p>
1415 <a href="http://dev.catalyst.perl.org">Wiki</a>
1418 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1421 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1424 <h2>In conclusion</h2>
1425 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1426 as we enjoyed making it. Please contact us if you have ideas
1427 for improvement or other feedback.</p>
1435 =head1 INTERNAL METHODS
1437 These methods are not meant to be used by end users.
1439 =head2 $c->components
1441 Returns a hash of components.
1443 =head2 $c->context_class
1445 Returns or sets the context class.
1449 Returns a hashref containing coderefs and execution counts (needed for
1450 deep recursion detection).
1454 Returns the number of actions on the current internal execution stack.
1458 Dispatches a request to actions.
1462 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1464 =head2 $c->dispatcher_class
1466 Returns or sets the dispatcher class.
1468 =head2 $c->dump_these
1470 Returns a list of 2-element array references (name, structure) pairs
1471 that will be dumped on the error page in debug mode.
1477 [ Request => $c->req ],
1478 [ Response => $c->res ],
1479 [ Stash => $c->stash ],
1480 [ Config => $c->config ];
1483 =head2 $c->engine_class
1485 Returns or sets the engine class.
1487 =head2 $c->execute( $class, $coderef )
1489 Execute a coderef in given class and catch exceptions. Errors are available
1495 my ( $c, $class, $code ) = @_;
1496 $class = $c->component($class) || $class;
1499 if ( $c->depth >= $RECURSION ) {
1500 my $action = $code->reverse();
1501 $action = "/$action" unless $action =~ /->/;
1502 my $error = qq/Deep recursion detected calling "${action}"/;
1503 $c->log->error($error);
1509 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1511 push( @{ $c->stack }, $code );
1513 no warnings 'recursion';
1514 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1516 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1518 my $last = pop( @{ $c->stack } );
1520 if ( my $error = $@ ) {
1521 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1522 $error->rethrow if $c->depth > 1;
1524 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1525 $error->rethrow if $c->depth > 0;
1528 unless ( ref $error ) {
1529 no warnings 'uninitialized';
1531 my $class = $last->class;
1532 my $name = $last->name;
1533 $error = qq/Caught exception in $class->$name "$error"/;
1542 sub _stats_start_execute {
1543 my ( $c, $code ) = @_;
1545 return if ( ( $code->name =~ /^_.*/ )
1546 && ( !$c->config->{show_internal_actions} ) );
1548 my $action_name = $code->reverse();
1549 $c->counter->{$action_name}++;
1551 my $action = $action_name;
1552 $action = "/$action" unless $action =~ /->/;
1554 # determine if the call was the result of a forward
1555 # this is done by walking up the call stack and looking for a calling
1556 # sub of Catalyst::forward before the eval
1558 for my $index ( 2 .. 11 ) {
1560 if ( ( caller($index) )[0] eq 'Catalyst'
1561 && ( caller($index) )[3] eq '(eval)' );
1563 if ( ( caller($index) )[3] =~ /forward$/ ) {
1564 $callsub = ( caller($index) )[3];
1565 $action = "-> $action";
1570 my $uid = $action_name . $c->counter->{$action_name};
1572 # is this a root-level call or a forwarded call?
1573 if ( $callsub =~ /forward$/ ) {
1575 # forward, locate the caller
1576 if ( my $parent = $c->stack->[-1] ) {
1579 parent => "$parent" . $c->counter->{"$parent"},
1585 # forward with no caller may come from a plugin
1604 sub _stats_finish_execute {
1605 my ( $c, $info ) = @_;
1606 $c->stats->profile( end => $info );
1609 =head2 $c->_localize_fields( sub { }, \%keys );
1613 #Why does this exist? This is no longer safe and WILL NOT WORK.
1614 # it doesnt seem to be used anywhere. can we remove it?
1615 sub _localize_fields {
1616 my ( $c, $localized, $code ) = ( @_ );
1618 my $request = delete $localized->{request} || {};
1619 my $response = delete $localized->{response} || {};
1621 local @{ $c }{ keys %$localized } = values %$localized;
1622 local @{ $c->request }{ keys %$request } = values %$request;
1623 local @{ $c->response }{ keys %$response } = values %$response;
1630 Finalizes the request.
1637 for my $error ( @{ $c->error } ) {
1638 $c->log->error($error);
1641 # Allow engine to handle finalize flow (for POE)
1642 my $engine = $c->engine;
1643 if ( my $code = $engine->can('finalize') ) {
1648 $c->finalize_uploads;
1651 if ( $#{ $c->error } >= 0 ) {
1655 $c->finalize_headers;
1658 if ( $c->request->method eq 'HEAD' ) {
1659 $c->response->body('');
1667 if ($c->use_stats) {
1668 my $elapsed = sprintf '%f', $c->stats->elapsed;
1669 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1671 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1674 return $c->response->status;
1677 =head2 $c->finalize_body
1683 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1685 =head2 $c->finalize_cookies
1691 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1693 =head2 $c->finalize_error
1699 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1701 =head2 $c->finalize_headers
1707 sub finalize_headers {
1710 my $response = $c->response; #accessor calls can add up?
1712 # Check if we already finalized headers
1713 return if $response->finalized_headers;
1716 if ( my $location = $response->redirect ) {
1717 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1718 $response->header( Location => $location );
1720 if ( !$response->has_body ) {
1721 # Add a default body if none is already present
1723 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1729 if ( $response->body && !$response->content_length ) {
1731 # get the length from a filehandle
1732 if ( blessed( $response->body ) && $response->body->can('read') )
1734 my $stat = stat $response->body;
1735 if ( $stat && $stat->size > 0 ) {
1736 $response->content_length( $stat->size );
1739 $c->log->warn('Serving filehandle without a content-length');
1743 # everything should be bytes at this point, but just in case
1744 $response->content_length( bytes::length( $response->body ) );
1749 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1750 $response->headers->remove_header("Content-Length");
1751 $response->body('');
1754 $c->finalize_cookies;
1756 $c->engine->finalize_headers( $c, @_ );
1759 $response->finalized_headers(1);
1762 =head2 $c->finalize_output
1764 An alias for finalize_body.
1766 =head2 $c->finalize_read
1768 Finalizes the input after reading is complete.
1772 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1774 =head2 $c->finalize_uploads
1776 Finalizes uploads. Cleans up any temporary files.
1780 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1782 =head2 $c->get_action( $action, $namespace )
1784 Gets an action in a given namespace.
1788 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1790 =head2 $c->get_actions( $action, $namespace )
1792 Gets all actions of a given name in a namespace and all parent
1797 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1799 =head2 $c->handle_request( $class, @arguments )
1801 Called to handle each HTTP request.
1805 sub handle_request {
1806 my ( $class, @arguments ) = @_;
1808 # Always expect worst case!
1811 if ($class->debug) {
1812 my $secs = time - $START || 1;
1813 my $av = sprintf '%.3f', $COUNT / $secs;
1814 my $time = localtime time;
1815 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1818 my $c = $class->prepare(@arguments);
1820 $status = $c->finalize;
1823 if ( my $error = $@ ) {
1825 $class->log->error(qq/Caught exception in engine "$error"/);
1830 if(my $coderef = $class->log->can('_flush')){
1831 $class->log->$coderef();
1836 =head2 $c->prepare( @arguments )
1838 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1844 my ( $class, @arguments ) = @_;
1847 # After the app/ctxt split, this should become an attribute based on something passed
1848 # into the application.
1849 $class->context_class( ref $class || $class ) unless $class->context_class;
1851 my $c = $class->context_class->new({});
1853 # For on-demand data
1854 $c->request->_context($c);
1855 $c->response->_context($c);
1857 #surely this is not the most efficient way to do things...
1858 $c->stats($class->stats_class->new)->enable($c->use_stats);
1860 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1863 #XXX reuse coderef from can
1864 # Allow engine to direct the prepare flow (for POE)
1865 if ( $c->engine->can('prepare') ) {
1866 $c->engine->prepare( $c, @arguments );
1869 $c->prepare_request(@arguments);
1870 $c->prepare_connection;
1871 $c->prepare_query_parameters;
1872 $c->prepare_headers;
1873 $c->prepare_cookies;
1876 # Prepare the body for reading, either by prepare_body
1877 # or the user, if they are using $c->read
1880 # Parse the body unless the user wants it on-demand
1881 unless ( $c->config->{parse_on_demand} ) {
1886 my $method = $c->req->method || '';
1887 my $path = $c->req->path;
1888 $path = '/' unless length $path;
1889 my $address = $c->req->address || '';
1898 =head2 $c->prepare_action
1900 Prepares action. See L<Catalyst::Dispatcher>.
1904 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1906 =head2 $c->prepare_body
1908 Prepares message body.
1915 return if $c->request->_has_body;
1917 # Initialize on-demand data
1918 $c->engine->prepare_body( $c, @_ );
1919 $c->prepare_parameters;
1920 $c->prepare_uploads;
1923 =head2 $c->prepare_body_chunk( $chunk )
1925 Prepares a chunk of data before sending it to L<HTTP::Body>.
1927 See L<Catalyst::Engine>.
1931 sub prepare_body_chunk {
1933 $c->engine->prepare_body_chunk( $c, @_ );
1936 =head2 $c->prepare_body_parameters
1938 Prepares body parameters.
1942 sub prepare_body_parameters {
1944 $c->engine->prepare_body_parameters( $c, @_ );
1947 =head2 $c->prepare_connection
1949 Prepares connection.
1953 sub prepare_connection {
1955 $c->engine->prepare_connection( $c, @_ );
1958 =head2 $c->prepare_cookies
1964 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1966 =head2 $c->prepare_headers
1972 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1974 =head2 $c->prepare_parameters
1976 Prepares parameters.
1980 sub prepare_parameters {
1982 $c->prepare_body_parameters;
1983 $c->engine->prepare_parameters( $c, @_ );
1986 =head2 $c->prepare_path
1988 Prepares path and base.
1992 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1994 =head2 $c->prepare_query_parameters
1996 Prepares query parameters.
2000 sub prepare_query_parameters {
2003 $c->engine->prepare_query_parameters( $c, @_ );
2006 =head2 $c->apply_parameter_debug_filters($params)
2010 sub _apply_parameter_debug_filters {
2015 # take a copy since we don't want to modify the original
2016 my $filtered_params = {%$params};
2020 my $filter_param_config = $c->config->{Debug}->{param_filters};
2021 if ( ref($filter_param_config) eq 'HASH' ) {
2023 # filters broken out by parameter type (i.e. body, query, all)
2024 my $type_filters = $filter_param_config->{$type} || [];
2025 $type_filters = [$type_filters] if ref $type_filters ne 'ARRAY';
2027 my $all_filters = $filter_param_config->{'all'} || [];
2028 $all_filters = [$all_filters] if ref $all_filters ne 'ARRAY';
2030 @filters = $c->_normalize_debug_filters( [ @$type_filters, @$all_filters ] );
2031 } elsif ($filter_param_config) {
2032 @filters = $c->_normalize_debug_filters($filter_param_config);
2035 # allow callback to modify each parameter
2036 foreach my $k ( keys %$filtered_params ) {
2038 # apply filters to each param
2039 foreach my $f (@filters) {
2041 # take a copy of the key to avoid the callback inadvertantly
2045 my $returned = $f->( $copy_key => $filtered_params->{$k} );
2047 if ( defined $returned ) {
2049 # if no value is returned, we assume the filter chose not to modify anything
2050 # otherwise, the returned value is the logged value
2051 $filtered_params->{$k} = $returned;
2053 last; # skip the rest of the filters since this one matched
2057 return $filtered_params;
2060 # turn debug filters into a list of CodeRef's
2061 sub _normalize_debug_filters {
2064 my @filters = ref( $_[0] ) eq 'ARRAY' ? @{ $_[0] } : grep { defined $_ } @_;
2066 my @normalized = map { _make_filter_callback($_) } @filters;
2071 sub _make_filter_callback {
2074 my $filter_str = '[FILTERED]';
2075 if ( ref($filter) eq 'Regexp' ) {
2076 return sub { return $_[0] =~ $filter ? $filter_str : undef };
2077 } elsif ( ref($filter) eq 'CODE' ) {
2080 return sub { return $_[0] eq $filter ? $filter_str : undef };
2084 =head2 $c->log_request
2086 Writes information about the request to the debug logs. This includes:
2090 =item * Request method, path, and remote IP address
2092 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2094 =item * Request parameters (see L</log_request_parameters>)
2096 =item * File uploads
2105 return unless $c->debug;
2107 my ( $method, $path, $address ) = ( $c->req->method, $c->req->path, $c->req->address );
2109 $path = '/' unless length $path;
2111 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2113 if ( my $keywords = $c->req->query_keywords ) {
2114 $c->log->debug("Query keywords are: $keywords");
2117 $c->log_request_parameters( query => $c->req->query_parameters, body => $c->req->body_parameters );
2119 $c->log_request_uploads;
2122 =head2 $c->log_response
2124 Writes information about the response to the debug logs. This includes:
2128 =item * Response status code
2130 =item * Response headers (see L</log_headers>)
2134 This logging is not enabled by default. To enable it, you must set a flag in your Catalyst config:
2136 __PACKAGE__->config( Debug => { log_response => 1 } );
2143 return unless $c->debug && $c->config->{Debug}->{log_response};
2145 $c->log->debug('Response Status: ' . $c->response->status);
2146 $c->log_headers('response', $c->response->headers);
2149 =head2 $c->log_request_parameters( query => {}, body => {} )
2151 Logs request parameters to debug logs
2153 If you have sensitive data that you do not want written to the Catalyst
2154 debug logs, you can set options in your config to filter those values out.
2155 There are a few different ways you can set these up depending on what
2156 exactly you need to filter.
2158 =head3 Filtering parameters by name
2160 The most basic means of filtering is to add an entry into your config
2161 as shown below. You can have a simple scalar to just filter a
2162 single parameter or an ARRAY ref to filter out multiple params.
2164 # filters a single param
2165 __PACKAGE__->config( Debug => { param_filters => 'param_name' } );
2167 # filters multiple params
2168 __PACKAGE__->config( Debug => { param_filters => [qw(param1 param2)] } );
2170 When the debug logs are generated for a given request, any parameters
2171 (query or body) that exactly match the specified value(s) will have
2172 their values replaced with '[FILTERED]'. For instance:
2174 [debug] Query Parameters are:
2175 .-------------------------------------+--------------------------------------.
2176 | Parameter | Value |
2177 +-------------------------------------+--------------------------------------+
2178 | password | [FILTERED] |
2179 .-------------------------------------+--------------------------------------.
2181 =head3 Filtering parameters by regular expression
2183 If you have a set of parameters you need to filter, you can specify a
2184 regular expression that will be used to match against parameter names.
2186 # filters parameters starting with "private."
2187 __PACKAGE__->config( Debug => { param_filters => qr/^private\./ } );
2189 # filters parameters named "param1" or starting with "private." or "secret."
2190 __PACKAGE__->config( Debug => { param_filters => [ 'param1', qr/^private\./, qr/^secret\./ ] } );
2192 Notice on the second example, the arrayref contains a string as well
2193 as two regular expressions. This should DWIM and filter parameters that
2194 match any of the filters specified.
2196 =head3 Filtering parameters by callback
2198 If you want even more flexible filtering, you can specify an anonymous
2199 subroutine. The subroutine is given the parameter name and value and
2200 is expected to return the new value that will be shown in the debug log.
2201 An C<undef> return value indicates that no change should be made to
2204 # transform any "password" param to "********"
2205 __PACKAGE__->config(
2207 param_filters => sub { my ( $k, $v ) = @_; return unless $k eq 'password'; return '*' x 8; }
2211 # combine several param filtering methods
2212 __PACKAGE__->config(
2215 'simple_param_name',
2217 sub { my ( $k, $v ) = @_; return unless $k eq 'password'; return '*' x 8; },
2222 An example of the debug log for a request with
2223 C<password=secret&some_other_param=some_other_value> would be:
2225 [debug] Body Parameters are:
2226 .-------------------------------------+--------------------------------------.
2227 | Parameter | Value |
2228 +-------------------------------------+--------------------------------------+
2229 | some_other_param | some_other_value |
2230 | password | ******** |
2231 .-------------------------------------+--------------------------------------.
2233 =head3 Filtering by parameter location
2235 If you have different filters that depend on whether a param was passed
2236 as a query or body param (or as either), you can specify a hashref with
2237 different sets of filters:
2239 # filters all body parameters
2240 __PACKAGE__->config( Debug => { param_filters => { body => qr// } } );
2242 # filters query parameters starting with 'private'.
2243 __PACKAGE__->config( Debug => { param_filters => { query => qr/^private\./ } } );
2245 # filters all parameters (query or body) through the specified callback
2246 __PACKAGE__->config(
2249 all => sub { return unless $_[0] eq 'fizzbuzz'; return 'FIZZBUZZ FILTER' }
2254 Of course, you can use any of the above filtering methods with these
2255 "location-specific" filters:
2257 # body parameter filters
2258 __PACKAGE__->config(
2264 sub { return 'XXX' if shift eq 'other_param' }
2270 # query parameter filters
2271 __PACKAGE__->config(
2277 sub { return 'XXX' if shift eq 'other_param' }
2283 # query parameter filters
2284 __PACKAGE__->config( Debug => { param_filters => { all => [qw(foo bar)] } } );
2288 sub log_request_parameters {
2290 my %all_params = @_;
2292 my $column_width = Catalyst::Utils::term_width() - 44;
2293 foreach my $type (qw(query body)) {
2294 my $filtered_params = $c->_apply_parameter_debug_filters( $type, $all_params{$type} || {} );
2295 next unless keys %$filtered_params;
2296 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2297 for my $key ( sort keys %$filtered_params ) {
2298 my $param = $filtered_params->{$key};
2299 my $value = defined($param) ? $param : '';
2300 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2302 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2306 =head2 $c->log_request_uploads
2308 Logs file uploads included in the request to the debug logs.
2309 The parameter name, filename, file type, and file size are all included in
2314 sub log_request_uploads {
2316 my $uploads = $c->req->uploads;
2317 if ( keys %$uploads ) {
2318 my $t = Text::SimpleTable->new(
2319 [ 12, 'Parameter' ],
2324 for my $key ( sort keys %$uploads ) {
2325 my $upload = $uploads->{$key};
2326 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2327 $t->row( $key, $u->filename, $u->type, $u->size );
2330 $c->log->debug( "File Uploads are:\n" . $t->draw );
2334 =head2 $c->log_headers($type => $headers)
2336 Writes HTTP::Headers to debug logs, applying filters as configured.
2338 Similarly to how L</log_request_parameters> is configured, you can
2339 configure Catalyst to filter response header values to avoid writing
2340 sensitive data to your logs (e.g. cookie values, etc.). The configuration
2341 works in virtually the same way as the examples in
2342 L</log_request_parameters>. Here are a few specific examples:
2344 # filters all "Set-Cookie" headers from response logging
2345 __PACKAGE__->config(Debug => { response_header_filters => 'Set-Cookie' } );
2347 # filters only the value of the cookie (and leaves the name, path, expiration)
2348 __PACKAGE__->config(
2350 response_header_filters => sub {
2352 return unless $n eq 'Set-Cookie';
2364 my $headers = shift; # an HTTP::Headers instance
2366 my $filtered = $c->_apply_header_debug_filters( $type, $headers );
2368 my $t = Text::SimpleTable->new( [ 35, 'Header Name' ], [ 40, 'Value' ] );
2371 my ( $name, $value ) = @_;
2372 $t->row( $name, $value );
2375 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2378 # Applies debug filters to $headers and returns a new HTTP::Headers object which has (potentially) filtered values.
2379 sub _apply_header_debug_filters {
2382 my $headers = shift;
2384 my @header_filters = $c->_normalize_debug_filters( $c->config->{Debug}->{ $type . '_header_filters' } );
2385 my $filtered_headers = HTTP::Headers->new();
2386 foreach my $name ( $headers->header_field_names ) {
2387 my @values = $headers->header($name);
2389 # headers can be multi-valued
2390 foreach my $value (@values) {
2391 foreach my $f (@header_filters) {
2392 my $new_value = $f->( $name, $value );
2394 # if a defined value is returned, we use that
2395 if ( defined $new_value ) {
2396 $value = $new_value;
2397 last; # skip the rest of the filters
2400 $filtered_headers->push_header( $name, $value );
2403 return $filtered_headers;
2406 =head2 $c->prepare_read
2408 Prepares the input for reading.
2412 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2414 =head2 $c->prepare_request
2416 Prepares the engine request.
2420 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2422 =head2 $c->prepare_uploads
2428 sub prepare_uploads {
2431 $c->engine->prepare_uploads( $c, @_ );
2434 =head2 $c->prepare_write
2436 Prepares the output for writing.
2440 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2442 =head2 $c->request_class
2444 Returns or sets the request class.
2446 =head2 $c->response_class
2448 Returns or sets the response class.
2450 =head2 $c->read( [$maxlength] )
2452 Reads a chunk of data from the request body. This method is designed to
2453 be used in a while loop, reading C<$maxlength> bytes on every call.
2454 C<$maxlength> defaults to the size of the request if not specified.
2456 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2459 Warning: If you use read(), Catalyst will not process the body,
2460 so you will not be able to access POST parameters or file uploads via
2461 $c->request. You must handle all body parsing yourself.
2465 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2473 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2475 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2477 Sets an action in a given namespace.
2481 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2483 =head2 $c->setup_actions($component)
2485 Sets up actions for a component.
2489 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2491 =head2 $c->setup_components
2493 Sets up components. Specify a C<setup_components> config option to pass
2494 additional options directly to L<Module::Pluggable>. To add additional
2495 search paths, specify a key named C<search_extra> as an array
2496 reference. Items in the array beginning with C<::> will have the
2497 application class name prepended to them.
2499 All components found will also have any
2500 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2501 Note, that modules which are B<not> an I<inner package> of the main
2502 file namespace loaded will not be instantiated as components.
2506 sub setup_components {
2509 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2510 my $config = $class->config->{ setup_components };
2511 my $extra = delete $config->{ search_extra } || [];
2513 push @paths, @$extra;
2515 my $locator = Module::Pluggable::Object->new(
2516 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2520 my @comps = sort { length $a <=> length $b } $locator->plugins;
2521 my %comps = map { $_ => 1 } @comps;
2523 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2524 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2525 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2526 ) if $deprecated_component_names;
2528 for my $component ( @comps ) {
2530 # We pass ignore_loaded here so that overlay files for (e.g.)
2531 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2532 # we know M::P::O found a file on disk so this is safe
2534 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2535 #Class::MOP::load_class($component);
2537 my $module = $class->setup_component( $component );
2539 $component => $module,
2541 $_ => $class->setup_component( $_ )
2543 not exists $comps{$_}
2544 } Devel::InnerPackage::list_packages( $component )
2547 for my $key ( keys %modules ) {
2548 $class->components->{ $key } = $modules{ $key };
2553 =head2 $c->setup_component
2557 sub _controller_init_base_classes {
2558 my ($app_class, $component) = @_;
2559 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2560 Moose::Meta::Class->initialize( $class )
2561 unless find_meta($class);
2565 sub setup_component {
2566 my( $class, $component ) = @_;
2568 unless ( $component->can( 'COMPONENT' ) ) {
2572 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2573 # nearest to Catalyst::Controller first, no matter what order stuff happens
2574 # to be loaded. There are TODO tests in Moose for this, see
2575 # f2391d17574eff81d911b97be15ea51080500003
2576 if ($component->isa('Catalyst::Controller')) {
2577 $class->_controller_init_base_classes($component);
2580 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2581 my $config = $class->config->{ $suffix } || {};
2583 my $instance = eval { $component->COMPONENT( $class, $config ); };
2585 if ( my $error = $@ ) {
2587 Catalyst::Exception->throw(
2588 message => qq/Couldn't instantiate component "$component", "$error"/
2592 unless (blessed $instance) {
2593 my $metaclass = Moose::Util::find_meta($component);
2594 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2595 my $component_method_from = $method_meta->associated_metaclass->name;
2596 my $value = defined($instance) ? $instance : 'undef';
2597 Catalyst::Exception->throw(
2599 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2605 =head2 $c->setup_dispatcher
2611 sub setup_dispatcher {
2612 my ( $class, $dispatcher ) = @_;
2615 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2618 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2619 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2622 unless ($dispatcher) {
2623 $dispatcher = $class->dispatcher_class;
2626 Class::MOP::load_class($dispatcher);
2628 # dispatcher instance
2629 $class->dispatcher( $dispatcher->new );
2632 =head2 $c->setup_engine
2639 my ( $class, $engine ) = @_;
2642 $engine = 'Catalyst::Engine::' . $engine;
2645 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2646 $engine = 'Catalyst::Engine::' . $env;
2649 if ( $ENV{MOD_PERL} ) {
2650 my $meta = Class::MOP::get_metaclass_by_name($class);
2652 # create the apache method
2653 $meta->add_method('apache' => sub { shift->engine->apache });
2655 my ( $software, $version ) =
2656 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2659 $version =~ s/(\.[^.]+)\./$1/g;
2661 if ( $software eq 'mod_perl' ) {
2665 if ( $version >= 1.99922 ) {
2666 $engine = 'Catalyst::Engine::Apache2::MP20';
2669 elsif ( $version >= 1.9901 ) {
2670 $engine = 'Catalyst::Engine::Apache2::MP19';
2673 elsif ( $version >= 1.24 ) {
2674 $engine = 'Catalyst::Engine::Apache::MP13';
2678 Catalyst::Exception->throw( message =>
2679 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2684 # install the correct mod_perl handler
2685 if ( $version >= 1.9901 ) {
2686 *handler = sub : method {
2687 shift->handle_request(@_);
2691 *handler = sub ($$) { shift->handle_request(@_) };
2696 elsif ( $software eq 'Zeus-Perl' ) {
2697 $engine = 'Catalyst::Engine::Zeus';
2701 Catalyst::Exception->throw(
2702 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2707 $engine = $class->engine_class;
2710 Class::MOP::load_class($engine);
2712 # check for old engines that are no longer compatible
2714 if ( $engine->isa('Catalyst::Engine::Apache')
2715 && !Catalyst::Engine::Apache->VERSION )
2720 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2721 && Catalyst::Engine::Server->VERSION le '0.02' )
2726 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2727 && $engine->VERSION eq '0.01' )
2732 elsif ($engine->isa('Catalyst::Engine::Zeus')
2733 && $engine->VERSION eq '0.01' )
2739 Catalyst::Exception->throw( message =>
2740 qq/Engine "$engine" is not supported by this version of Catalyst/
2745 $class->engine( $engine->new );
2748 =head2 $c->setup_home
2750 Sets up the home directory.
2755 my ( $class, $home ) = @_;
2757 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2761 $home ||= Catalyst::Utils::home($class);
2764 #I remember recently being scolded for assigning config values like this
2765 $class->config->{home} ||= $home;
2766 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2770 =head2 $c->setup_log
2772 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2773 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2776 This method also installs a C<debug> method that returns a true value into the
2777 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2778 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2780 Note that if the log has already been setup, by either a previous call to
2781 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2782 that this method won't actually set up the log object.
2787 my ( $class, $levels ) = @_;
2790 $levels =~ s/^\s+//;
2791 $levels =~ s/\s+$//;
2792 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2794 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2795 if ( defined $env_debug ) {
2796 $levels{debug} = 1 if $env_debug; # Ugly!
2797 delete($levels{debug}) unless $env_debug;
2800 unless ( $class->log ) {
2801 $class->log( Catalyst::Log->new(keys %levels) );
2804 if ( $levels{debug} ) {
2805 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2806 $class->log->debug('Debug messages enabled');
2810 =head2 $c->setup_plugins
2816 =head2 $c->setup_stats
2818 Sets up timing statistics class.
2823 my ( $class, $stats ) = @_;
2825 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2827 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2828 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2829 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2830 $class->log->debug('Statistics enabled');
2835 =head2 $c->registered_plugins
2837 Returns a sorted list of the plugins which have either been stated in the
2838 import list or which have been added via C<< MyApp->plugin(@args); >>.
2840 If passed a given plugin name, it will report a boolean value indicating
2841 whether or not that plugin is loaded. A fully qualified name is required if
2842 the plugin name does not begin with C<Catalyst::Plugin::>.
2844 if ($c->registered_plugins('Some::Plugin')) {
2852 sub registered_plugins {
2854 return sort keys %{ $proto->_plugins } unless @_;
2856 return 1 if exists $proto->_plugins->{$plugin};
2857 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2860 sub _register_plugin {
2861 my ( $proto, $plugin, $instant ) = @_;
2862 my $class = ref $proto || $proto;
2864 Class::MOP::load_class( $plugin );
2866 $proto->_plugins->{$plugin} = 1;
2869 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2870 my @superclasses = ($plugin, $meta->superclasses );
2871 $meta->superclasses(@superclasses);
2873 unshift @{"$class\::ISA"}, $plugin;
2880 my ( $class, $plugins ) = @_;
2882 $class->_plugins( {} ) unless $class->_plugins;
2885 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2887 for my $plugin ( reverse @plugins ) {
2888 Class::MOP::load_class($plugin);
2889 my $meta = find_meta($plugin);
2890 next if $meta && $meta->isa('Moose::Meta::Role');
2892 $class->_register_plugin($plugin);
2897 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2898 map { find_meta($_) }
2901 Moose::Util::apply_all_roles(
2909 Returns an arrayref of the internal execution stack (actions that are
2910 currently executing).
2912 =head2 $c->stats_class
2914 Returns or sets the stats (timing statistics) class.
2916 =head2 $c->use_stats
2918 Returns 1 when stats collection is enabled. Stats collection is enabled
2919 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2920 environment variable is set.
2922 Note that this is a static method, not an accessor and should be overridden
2923 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2930 =head2 $c->write( $data )
2932 Writes $data to the output stream. When using this method directly, you
2933 will need to manually set the C<Content-Length> header to the length of
2934 your output data, if known.
2941 # Finalize headers if someone manually writes output
2942 $c->finalize_headers;
2944 return $c->engine->write( $c, @_ );
2949 Returns the Catalyst version number. Mostly useful for "powered by"
2950 messages in template systems.
2954 sub version { return $Catalyst::VERSION }
2956 =head1 INTERNAL ACTIONS
2958 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2959 C<_ACTION>, and C<_END>. These are by default not shown in the private
2960 action table, but you can make them visible with a config parameter.
2962 MyApp->config->{show_internal_actions} = 1;
2964 =head1 CASE SENSITIVITY
2966 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2967 mapped to C</foo/bar>. You can activate case sensitivity with a config
2970 MyApp->config->{case_sensitive} = 1;
2972 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2974 =head1 ON-DEMAND PARSER
2976 The request body is usually parsed at the beginning of a request,
2977 but if you want to handle input yourself, you can enable on-demand
2978 parsing with a config parameter.
2980 MyApp->config->{parse_on_demand} = 1;
2982 =head1 PROXY SUPPORT
2984 Many production servers operate using the common double-server approach,
2985 with a lightweight frontend web server passing requests to a larger
2986 backend server. An application running on the backend server must deal
2987 with two problems: the remote user always appears to be C<127.0.0.1> and
2988 the server's hostname will appear to be C<localhost> regardless of the
2989 virtual host that the user connected through.
2991 Catalyst will automatically detect this situation when you are running
2992 the frontend and backend servers on the same machine. The following
2993 changes are made to the request.
2995 $c->req->address is set to the user's real IP address, as read from
2996 the HTTP X-Forwarded-For header.
2998 The host value for $c->req->base and $c->req->uri is set to the real
2999 host, as read from the HTTP X-Forwarded-Host header.
3001 Obviously, your web server must support these headers for this to work.
3003 In a more complex server farm environment where you may have your
3004 frontend proxy server(s) on different machines, you will need to set a
3005 configuration option to tell Catalyst to read the proxied data from the
3008 MyApp->config->{using_frontend_proxy} = 1;
3010 If you do not wish to use the proxy support at all, you may set:
3012 MyApp->config->{ignore_frontend_proxy} = 1;
3014 =head1 THREAD SAFETY
3016 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3017 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3018 believe the Catalyst core to be thread-safe.
3020 If you plan to operate in a threaded environment, remember that all other
3021 modules you are using must also be thread-safe. Some modules, most notably
3022 L<DBD::SQLite>, are not thread-safe.
3028 Join #catalyst on irc.perl.org.
3032 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3033 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3037 http://catalyst.perl.org
3041 http://dev.catalyst.perl.org
3045 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3047 =head2 L<Catalyst::Manual> - The Catalyst Manual
3049 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
3051 =head2 L<Catalyst::Engine> - Core engine
3053 =head2 L<Catalyst::Log> - Log class.
3055 =head2 L<Catalyst::Request> - Request object
3057 =head2 L<Catalyst::Response> - Response object
3059 =head2 L<Catalyst::Test> - The test suite.
3061 =head1 PROJECT FOUNDER
3063 sri: Sebastian Riedel <sri@cpan.org>
3069 acme: Leon Brocard <leon@astray.com>
3077 andyg: Andy Grundman <andy@hybridized.org>
3079 audreyt: Audrey Tang
3081 bricas: Brian Cassidy <bricas@cpan.org>
3083 Caelum: Rafael Kitover <rkitover@io.com>
3085 chansen: Christian Hansen
3087 chicks: Christopher Hicks
3091 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3095 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3097 esskar: Sascha Kiefer
3099 fireartist: Carl Franks <cfranks@cpan.org>
3101 gabb: Danijel Milicevic
3107 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3109 jcamacho: Juan Camacho
3111 jhannah: Jay Hannah <jay@jays.net>
3117 jon: Jon Schutz <jjschutz@cpan.org>
3119 marcus: Marcus Ramberg <mramberg@cpan.org>
3121 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3123 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3127 naughton: David Naughton
3129 ningu: David Kamholz <dkamholz@cpan.org>
3131 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3133 numa: Dan Sully <daniel@cpan.org>
3137 omega: Andreas Marienborg
3139 Oleg Kostyuk <cub.uanic@gmail.com>
3141 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3143 rafl: Florian Ragwitz <rafl@debian.org>
3145 random: Roland Lammel <lammel@cpan.org>
3149 the_jester: Jesse Sheidlower
3151 t0m: Tomas Doran <bobtfish@bobtfish.net>
3155 willert: Sebastian Willert <willert@cpan.org>
3159 This library is free software. You can redistribute it and/or modify it under
3160 the same terms as Perl itself.
3166 __PACKAGE__->meta->make_immutable;