4 extends 'Catalyst::Component';
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
13 use Catalyst::Controller;
14 use Devel::InnerPackage ();
16 use Module::Pluggable::Object ();
17 use Text::SimpleTable ();
18 use Path::Class::Dir ();
19 use Path::Class::File ();
20 use Time::HiRes qw/gettimeofday tv_interval/;
24 use Scalar::Util qw/weaken/;
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
29 use Carp qw/croak carp shortmess/;
31 BEGIN { require 5.008001; }
33 has stack => (is => 'ro', default => sub { [] });
34 has stash => (is => 'rw', default => sub { {} });
35 has state => (is => 'rw', default => 0);
36 has stats => (is => 'rw');
37 has action => (is => 'rw');
38 has counter => (is => 'rw', default => sub { {} });
39 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
40 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
41 has namespace => (is => 'rw');
43 sub depth { scalar @{ shift->stack || [] }; }
44 sub comp { shift->component(@_) }
47 # carp "the use of req() is deprecated in favour of request()";
48 my $self = shift; return $self->request(@_);
51 # carp "the use of res() is deprecated in favour of response()";
52 my $self = shift; return $self->response(@_);
55 # For backwards compatibility
56 sub finalize_output { shift->finalize_body(@_) };
61 our $RECURSION = 1000;
62 our $DETACH = "catalyst_detach\n";
63 our $GO = "catalyst_go\n";
65 #I imagine that very few of these really need to be class variables. if any.
66 #maybe we should just make them attributes with a default?
67 __PACKAGE__->mk_classdata($_)
68 for qw/components arguments dispatcher engine log dispatcher_class
69 engine_class context_class request_class response_class stats_class
72 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
73 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
74 __PACKAGE__->request_class('Catalyst::Request');
75 __PACKAGE__->response_class('Catalyst::Response');
76 __PACKAGE__->stats_class('Catalyst::Stats');
78 # Remember to update this in Catalyst::Runtime as well!
80 our $VERSION = '5.8000_05';
83 my ( $class, @arguments ) = @_;
85 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
87 return unless $class eq 'Catalyst';
89 my $caller = caller();
90 return if $caller eq 'main';
91 my $meta = Moose::Meta::Class->initialize($caller);
92 #Moose->import({ into => $caller }); #do we want to do this?
94 unless ( $caller->isa('Catalyst') ) {
95 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
96 $meta->superclasses(@superclasses);
98 unless( $meta->has_method('meta') ){
99 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
102 $caller->arguments( [@arguments] );
108 Catalyst - The Elegant MVC Web Application Framework
112 See the L<Catalyst::Manual> distribution for comprehensive
113 documentation and tutorials.
115 # Install Catalyst::Devel for helpers and other development tools
116 # use the helper to create a new application
119 # add models, views, controllers
120 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
121 script/myapp_create.pl view MyTemplate TT
122 script/myapp_create.pl controller Search
124 # built in testserver -- use -r to restart automatically on changes
125 # --help to see all available options
126 script/myapp_server.pl
128 # command line testing interface
129 script/myapp_test.pl /yada
132 use Catalyst qw/-Debug/; # include plugins here as well
134 ### In lib/MyApp/Controller/Root.pm (autocreated)
135 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
136 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
137 $c->stash->{template} = 'foo.tt'; # set the template
138 # lookup something from db -- stash vars are passed to TT
140 $c->model('Database::Foo')->search( { country => $args[0] } );
141 if ( $c->req->params->{bar} ) { # access GET or POST parameters
142 $c->forward( 'bar' ); # process another action
143 # do something else after forward returns
147 # The foo.tt TT template can use the stash data from the database
148 [% WHILE (item = data.next) %]
152 # called for /bar/of/soap, /bar/of/soap/10, etc.
153 sub bar : Path('/bar/of/soap') { ... }
155 # called for all actions, from the top-most controller downwards
157 my ( $self, $c ) = @_;
158 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
159 $c->res->redirect( '/login' ); # require login
160 return 0; # abort request and go immediately to end()
162 return 1; # success; carry on to next action
165 # called after all actions are finished
167 my ( $self, $c ) = @_;
168 if ( scalar @{ $c->error } ) { ... } # handle errors
169 return if $c->res->body; # already have a response
170 $c->forward( 'MyApp::View::TT' ); # render template
173 ### in MyApp/Controller/Foo.pm
174 # called for /foo/bar
175 sub bar : Local { ... }
177 # called for /blargle
178 sub blargle : Global { ... }
180 # an index action matches /foo, but not /foo/1, etc.
181 sub index : Private { ... }
183 ### in MyApp/Controller/Foo/Bar.pm
184 # called for /foo/bar/baz
185 sub baz : Local { ... }
187 # first Root auto is called, then Foo auto, then this
188 sub auto : Private { ... }
190 # powerful regular expression paths are also possible
191 sub details : Regex('^product/(\w+)/details$') {
192 my ( $self, $c ) = @_;
193 # extract the (\w+) from the URI
194 my $product = $c->req->captures->[0];
197 See L<Catalyst::Manual::Intro> for additional information.
201 Catalyst is a modern framework for making web applications without the
202 pain usually associated with this process. This document is a reference
203 to the main Catalyst application. If you are a new user, we suggest you
204 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
206 See L<Catalyst::Manual> for more documentation.
208 Catalyst plugins can be loaded by naming them as arguments to the "use
209 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
210 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
213 use Catalyst qw/My::Module/;
215 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
216 fully qualify the name by using a unary plus:
220 +Fully::Qualified::Plugin::Name
223 Special flags like C<-Debug> and C<-Engine> can also be specified as
224 arguments when Catalyst is loaded:
226 use Catalyst qw/-Debug My::Module/;
228 The position of plugins and flags in the chain is important, because
229 they are loaded in the order in which they appear.
231 The following flags are supported:
235 Enables debug output. You can also force this setting from the system
236 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
237 settings override the application, with <MYAPP>_DEBUG having the highest
242 Forces Catalyst to use a specific engine. Omit the
243 C<Catalyst::Engine::> prefix of the engine name, i.e.:
245 use Catalyst qw/-Engine=CGI/;
249 Forces Catalyst to use a specific home directory, e.g.:
251 use Catalyst qw[-Home=/usr/mst];
253 This can also be done in the shell environment by setting either the
254 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
255 is replaced with the uppercased name of your application, any "::" in
256 the name will be replaced with underscores, e.g. MyApp::Web should use
257 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
261 use Catalyst '-Log=warn,fatal,error';
263 Specifies a comma-delimited list of log levels.
267 Enables statistics collection and reporting. You can also force this setting
268 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
269 environment settings override the application, with <MYAPP>_STATS having the
274 use Catalyst qw/-Stats=1/
278 =head2 INFORMATION ABOUT THE CURRENT REQUEST
282 Returns a L<Catalyst::Action> object for the current action, which
283 stringifies to the action name. See L<Catalyst::Action>.
287 Returns the namespace of the current action, i.e., the URI prefix
288 corresponding to the controller of the current action. For example:
290 # in Controller::Foo::Bar
291 $c->namespace; # returns 'foo/bar';
297 Returns the current L<Catalyst::Request> object, giving access to
298 information about the current client request (including parameters,
299 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
301 =head2 REQUEST FLOW HANDLING
303 =head2 $c->forward( $action [, \@arguments ] )
305 =head2 $c->forward( $class, $method, [, \@arguments ] )
307 Forwards processing to another action, by its private name. If you give a
308 class name but no method, C<process()> is called. You may also optionally
309 pass arguments in an arrayref. The action will receive the arguments in
310 C<@_> and C<< $c->req->args >>. Upon returning from the function,
311 C<< $c->req->args >> will be restored to the previous values.
313 Any data C<return>ed from the action forwarded to, will be returned by the
316 my $foodata = $c->forward('/foo');
317 $c->forward('index');
318 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
319 $c->forward('MyApp::View::TT');
321 Note that forward implies an C<<eval { }>> around the call (actually
322 C<execute> does), thus de-fatalizing all 'dies' within the called
323 action. If you want C<die> to propagate you need to do something like:
326 die $c->error if $c->error;
328 Or make sure to always return true values from your actions and write
331 $c->forward('foo') || return;
335 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
337 =head2 $c->detach( $action [, \@arguments ] )
339 =head2 $c->detach( $class, $method, [, \@arguments ] )
343 The same as C<forward>, but doesn't return to the previous action when
344 processing is finished.
346 When called with no arguments it escapes the processing chain entirely.
350 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
352 =head2 $c->visit( $action [, \@arguments ] )
354 =head2 $c->visit( $class, $method, [, \@arguments ] )
356 Almost the same as C<forward>, but does a full dispatch, instead of just
357 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
358 C<auto> and the method you go to are called, just like a new request.
360 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
361 This means, for example, that $c->action methods such as C<name>, C<class> and
362 C<reverse> return information for the visited action when they are invoked
363 within the visited action. This is different from the behavior of C<forward>
364 which continues to use the $c->action object from the caller action even when
365 invoked from the callee.
367 C<$c-E<gt>stash> is kept unchanged.
369 In effect, C<visit> allows you to "wrap" another action, just as it
370 would have been called by dispatching from a URL, while the analogous
371 C<go> allows you to transfer control to another action as if it had
372 been reached directly from a URL.
376 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
378 =head2 $c->go( $action [, \@arguments ] )
380 =head2 $c->go( $class, $method, [, \@arguments ] )
382 Almost the same as C<detach>, but does a full dispatch like C<visit>,
383 instead of just calling the new C<$action> /
384 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
385 method you visit are called, just like a new request.
387 C<$c-E<gt>stash> is kept unchanged.
391 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
397 Returns the current L<Catalyst::Response> object, see there for details.
401 Returns a hashref to the stash, which may be used to store data and pass
402 it between components during a request. You can also set hash keys by
403 passing arguments. The stash is automatically sent to the view. The
404 stash is cleared at the end of a request; it cannot be used for
405 persistent storage (for this you must use a session; see
406 L<Catalyst::Plugin::Session> for a complete system integrated with
409 $c->stash->{foo} = $bar;
410 $c->stash( { moose => 'majestic', qux => 0 } );
411 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
413 # stash is automatically passed to the view for use in a template
414 $c->forward( 'MyApp::View::TT' );
418 around stash => sub {
421 my $stash = $orig->($c);
423 my $new_stash = @_ > 1 ? {@_} : $_[0];
424 croak('stash takes a hash or hashref') unless ref $new_stash;
425 foreach my $key ( keys %$new_stash ) {
426 $stash->{$key} = $new_stash->{$key};
436 =head2 $c->error($error, ...)
438 =head2 $c->error($arrayref)
440 Returns an arrayref containing error messages. If Catalyst encounters an
441 error while processing a request, it stores the error in $c->error. This
442 method should only be used to store fatal error messages.
444 my @error = @{ $c->error };
448 $c->error('Something bad happened');
455 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
456 croak @$error unless ref $c;
457 push @{ $c->{error} }, @$error;
459 elsif ( defined $_[0] ) { $c->{error} = undef }
460 return $c->{error} || [];
466 Contains the return value of the last executed action.
468 =head2 $c->clear_errors
470 Clear errors. You probably don't want to clear the errors unless you are
471 implementing a custom error screen.
473 This is equivalent to running
484 # search components given a name and some prefixes
485 sub _comp_search_prefixes {
486 my ( $c, $name, @prefixes ) = @_;
487 my $appclass = ref $c || $c;
488 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
490 # map the original component name to the sub part that we will search against
491 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
492 grep { /$filter/ } keys %{ $c->components };
494 # undef for a name will return all
495 return keys %eligible if !defined $name;
497 my $query = ref $name ? $name : qr/^$name$/i;
498 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
500 return map { $c->components->{ $_ } } @result if @result;
502 # if we were given a regexp to search against, we're done.
507 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
509 # no results? try against full names
511 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
514 # don't warn if we didn't find any results, it just might not exist
516 my $msg = "Used regexp fallback for \$c->model('${name}'), which found '" .
517 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
518 "component resolution is unreliable and unsafe.";
519 my $short = $result[0];
520 $short =~ s/.*?Model:://;
521 my $shortmess = Carp::shortmess('');
522 if ($shortmess =~ m#Catalyst/Plugin#) {
523 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
525 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
526 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
527 "component's config";
529 $msg .= " You probably meant \$c->model('$short') instead of \$c->model{'${name}'}, " .
530 "but if you really wanted to search, pass in a regexp as the argument " .
531 "like so: \$c->model(qr/${name}/)";
533 $c->log->warn( "${msg}$shortmess" );
539 # Find possible names for a prefix
541 my ( $c, @prefixes ) = @_;
542 my $appclass = ref $c || $c;
544 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
546 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
550 # Filter a component before returning by calling ACCEPT_CONTEXT if available
551 sub _filter_component {
552 my ( $c, $comp, @args ) = @_;
554 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
555 return $comp->ACCEPT_CONTEXT( $c, @args );
561 =head2 COMPONENT ACCESSORS
563 =head2 $c->controller($name)
565 Gets a L<Catalyst::Controller> instance by name.
567 $c->controller('Foo')->do_stuff;
569 If the name is omitted, will return the controller for the dispatched
572 If you want to search for controllers, pass in a regexp as the argument.
574 # find all controllers that start with Foo
575 my @foo_controllers = $c->controller(qr{^Foo});
581 my ( $c, $name, @args ) = @_;
584 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
585 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
586 return $c->_filter_component( $result[ 0 ], @args );
589 return $c->component( $c->action->class );
592 =head2 $c->model($name)
594 Gets a L<Catalyst::Model> instance by name.
596 $c->model('Foo')->do_stuff;
598 Any extra arguments are directly passed to ACCEPT_CONTEXT.
600 If the name is omitted, it will look for
601 - a model object in $c->stash->{current_model_instance}, then
602 - a model name in $c->stash->{current_model}, then
603 - a config setting 'default_model', or
604 - check if there is only one model, and return it if that's the case.
606 If you want to search for models, pass in a regexp as the argument.
608 # find all models that start with Foo
609 my @foo_models = $c->model(qr{^Foo});
614 my ( $c, $name, @args ) = @_;
617 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
618 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
619 return $c->_filter_component( $result[ 0 ], @args );
623 return $c->stash->{current_model_instance}
624 if $c->stash->{current_model_instance};
625 return $c->model( $c->stash->{current_model} )
626 if $c->stash->{current_model};
628 return $c->model( $c->config->{default_model} )
629 if $c->config->{default_model};
631 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
634 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
635 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
636 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
637 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
638 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
641 return $c->_filter_component( $comp );
645 =head2 $c->view($name)
647 Gets a L<Catalyst::View> instance by name.
649 $c->view('Foo')->do_stuff;
651 Any extra arguments are directly passed to ACCEPT_CONTEXT.
653 If the name is omitted, it will look for
654 - a view object in $c->stash->{current_view_instance}, then
655 - a view name in $c->stash->{current_view}, then
656 - a config setting 'default_view', or
657 - check if there is only one view, and return it if that's the case.
659 If you want to search for views, pass in a regexp as the argument.
661 # find all views that start with Foo
662 my @foo_views = $c->view(qr{^Foo});
667 my ( $c, $name, @args ) = @_;
670 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
671 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
672 return $c->_filter_component( $result[ 0 ], @args );
676 return $c->stash->{current_view_instance}
677 if $c->stash->{current_view_instance};
678 return $c->view( $c->stash->{current_view} )
679 if $c->stash->{current_view};
681 return $c->view( $c->config->{default_view} )
682 if $c->config->{default_view};
684 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
687 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
688 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
689 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
690 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
691 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
694 return $c->_filter_component( $comp );
697 =head2 $c->controllers
699 Returns the available names which can be passed to $c->controller
705 return $c->_comp_names(qw/Controller C/);
710 Returns the available names which can be passed to $c->model
716 return $c->_comp_names(qw/Model M/);
722 Returns the available names which can be passed to $c->view
728 return $c->_comp_names(qw/View V/);
731 =head2 $c->comp($name)
733 =head2 $c->component($name)
735 Gets a component object by name. This method is not recommended,
736 unless you want to get a specific component by full
737 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
738 should be used instead.
740 If C<$name> is a regexp, a list of components matched against the full
741 component name will be returned.
746 my ( $c, $name, @args ) = @_;
749 my $comps = $c->components;
752 # is it the exact name?
753 return $c->_filter_component( $comps->{ $name }, @args )
754 if exists $comps->{ $name };
756 # perhaps we just omitted "MyApp"?
757 my $composed = ( ref $c || $c ) . "::${name}";
758 return $c->_filter_component( $comps->{ $composed }, @args )
759 if exists $comps->{ $composed };
761 # search all of the models, views and controllers
762 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
763 return $c->_filter_component( $comp, @args ) if $comp;
766 # This is here so $c->comp( '::M::' ) works
767 my $query = ref $name ? $name : qr{$name}i;
769 my @result = grep { m{$query} } keys %{ $c->components };
770 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
773 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
774 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
775 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
776 return $c->_filter_component( $result[ 0 ], @args );
779 # I would expect to return an empty list here, but that breaks back-compat
783 return sort keys %{ $c->components };
786 =head2 CLASS DATA AND HELPER CLASSES
790 Returns or takes a hashref containing the application's configuration.
792 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
794 You can also use a C<YAML>, C<XML> or C<Config::General> config file
795 like myapp.yml in your applications home directory. See
796 L<Catalyst::Plugin::ConfigLoader>.
799 db: dsn:SQLite:foo.db
804 around config => sub {
808 $c->log->warn("Setting config after setup has been run is not a good idea.")
809 if ( @_ and $c->setup_finished );
816 Returns the logging object instance. Unless it is already set, Catalyst
817 sets this up with a L<Catalyst::Log> object. To use your own log class,
818 set the logger with the C<< __PACKAGE__->log >> method prior to calling
819 C<< __PACKAGE__->setup >>.
821 __PACKAGE__->log( MyLogger->new );
826 $c->log->info( 'Now logging with my own logger!' );
828 Your log class should implement the methods described in
834 Overload to enable debug messages (same as -Debug option).
836 Note that this is a static method, not an accessor and should be overloaded
837 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
843 =head2 $c->dispatcher
845 Returns the dispatcher instance. Stringifies to class name. See
846 L<Catalyst::Dispatcher>.
850 Returns the engine instance. Stringifies to the class name. See
854 =head2 UTILITY METHODS
856 =head2 $c->path_to(@path)
858 Merges C<@path> with C<< $c->config->{home} >> and returns a
859 L<Path::Class::Dir> object.
863 $c->path_to( 'db', 'sqlite.db' );
868 my ( $c, @path ) = @_;
869 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
870 if ( -d $path ) { return $path }
871 else { return Path::Class::File->new( $c->config->{home}, @path ) }
874 =head2 $c->plugin( $name, $class, @args )
876 Helper method for plugins. It creates a classdata accessor/mutator and
877 loads and instantiates the given class.
879 MyApp->plugin( 'prototype', 'HTML::Prototype' );
881 $c->prototype->define_javascript_functions;
883 B<Note:> This method of adding plugins is deprecated. The ability
884 to add plugins like this B<will be removed> in a Catalyst 5.9.
885 Please do not use this functionality in new code.
890 my ( $class, $name, $plugin, @args ) = @_;
892 # See block comment in t/unit_core_plugin.t
893 $class->log->debug(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.9/);
895 $class->_register_plugin( $plugin, 1 );
897 eval { $plugin->import };
898 $class->mk_classdata($name);
900 eval { $obj = $plugin->new(@args) };
903 Catalyst::Exception->throw( message =>
904 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
908 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
914 Initializes the dispatcher and engine, loads any plugins, and loads the
915 model, view, and controller components. You may also specify an array
916 of plugins to load here, if you choose to not load them in the C<use
920 MyApp->setup( qw/-Debug/ );
925 my ( $class, @arguments ) = @_;
926 $class->log->warn("Running setup twice is not a good idea.")
927 if ( $class->setup_finished );
929 unless ( $class->isa('Catalyst') ) {
931 Catalyst::Exception->throw(
932 message => qq/'$class' does not inherit from Catalyst/ );
935 if ( $class->arguments ) {
936 @arguments = ( @arguments, @{ $class->arguments } );
942 foreach (@arguments) {
946 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
948 elsif (/^-(\w+)=?(.*)$/) {
949 $flags->{ lc $1 } = $2;
952 push @{ $flags->{plugins} }, $_;
956 $class->setup_home( delete $flags->{home} );
958 $class->setup_log( delete $flags->{log} );
959 $class->setup_plugins( delete $flags->{plugins} );
960 $class->setup_dispatcher( delete $flags->{dispatcher} );
961 $class->setup_engine( delete $flags->{engine} );
962 $class->setup_stats( delete $flags->{stats} );
964 for my $flag ( sort keys %{$flags} ) {
966 if ( my $code = $class->can( 'setup_' . $flag ) ) {
967 &$code( $class, delete $flags->{$flag} );
970 $class->log->warn(qq/Unknown flag "$flag"/);
974 eval { require Catalyst::Devel; };
975 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
976 $class->log->warn(<<"EOF");
977 You are running an old script!
979 Please update by running (this will overwrite existing files):
980 catalyst.pl -force -scripts $class
982 or (this will not overwrite existing files):
983 catalyst.pl -scripts $class
988 if ( $class->debug ) {
989 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
992 my $column_width = Catalyst::Utils::term_width() - 6;
993 my $t = Text::SimpleTable->new($column_width);
994 $t->row($_) for @plugins;
995 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
998 my $dispatcher = $class->dispatcher;
999 my $engine = $class->engine;
1000 my $home = $class->config->{home};
1002 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1003 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1007 ? $class->log->debug(qq/Found home "$home"/)
1008 : $class->log->debug(qq/Home "$home" doesn't exist/)
1009 : $class->log->debug(q/Couldn't find home/);
1012 # Call plugins setup, this is stupid and evil.
1014 no warnings qw/redefine/;
1015 local *setup = sub { };
1019 # Initialize our data structure
1020 $class->components( {} );
1022 $class->setup_components;
1024 if ( $class->debug ) {
1025 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1026 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1027 for my $comp ( sort keys %{ $class->components } ) {
1028 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1029 $t->row( $comp, $type );
1031 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1032 if ( keys %{ $class->components } );
1035 # Add our self to components, since we are also a component
1036 if( $class->isa('Catalyst::Controller') ){
1037 $class->components->{$class} = $class;
1040 $class->setup_actions;
1042 if ( $class->debug ) {
1043 my $name = $class->config->{name} || 'Application';
1044 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1046 $class->log->_flush() if $class->log->can('_flush');
1048 # Make sure that the application class becomes immutable at this point,
1049 # which ensures that it gets an inlined constructor. This means that it
1050 # works even if the user has added a plugin which contains a new method.
1051 # Note however that we have to do the work on scope end, so that method
1052 # modifiers work correctly in MyApp (as you have to call setup _before_
1053 # applying modifiers).
1054 Scope::Upper::reap(sub {
1055 my $meta = Class::MOP::get_metaclass_by_name($class);
1056 $meta->make_immutable unless $meta->is_immutable;
1057 }, Scope::Upper::SCOPE(1));
1059 $class->setup_finalize;
1063 =head2 $app->setup_finalize
1065 A hook to attach modifiers to.
1066 Using C< after setup => sub{}; > doesn't work, because of quirky things done for plugin setup.
1067 Also better than C< setup_finished(); >, as that is a getter method.
1069 sub setup_finalize {
1073 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1075 $app->next::method(@_);
1082 sub setup_finalize {
1084 $class->setup_finished(1);
1087 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1089 =head2 $c->uri_for( $path, @args?, \%query_values? )
1095 A Catalyst::Action object representing the Catalyst action you want to
1096 create a URI for. To get one for an action in the current controller,
1097 use C<< $c->action('someactionname') >>. To get one from different
1098 controller, fetch the controller using C<< $c->controller() >>, then
1099 call C<action_for> on it.
1101 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1102 using C<< $c->req->captures >>.
1104 # For the current action
1105 $c->uri_for($c->action, $c->req->captures);
1107 # For the Foo action in the Bar controller
1108 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1115 my ( $c, $path, @args ) = @_;
1117 if ( Scalar::Util::blessed($path) ) { # action object
1118 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1121 $path = $c->dispatcher->uri_for_action($path, $captures);
1122 return undef unless defined($path);
1123 $path = '/' if $path eq '';
1126 undef($path) if (defined $path && $path eq '');
1129 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1131 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1132 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1134 unshift(@args, $path);
1136 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1137 my $namespace = $c->namespace;
1138 if (defined $path) { # cheesy hack to handle path '../foo'
1139 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1141 unshift(@args, $namespace || '');
1144 # join args with '/', or a blank string
1145 my $args = join('/', grep { defined($_) } @args);
1146 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1148 my $base = $c->req->base;
1149 my $class = ref($base);
1150 $base =~ s{(?<!/)$}{/};
1154 if (my @keys = keys %$params) {
1155 # somewhat lifted from URI::_query's query_form
1156 $query = '?'.join('&', map {
1157 my $val = $params->{$_};
1158 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1161 $val = '' unless defined $val;
1164 utf8::encode( $_ ) if utf8::is_utf8($_);
1165 # using the URI::Escape pattern here so utf8 chars survive
1166 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1168 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1172 my $res = bless(\"${base}${args}${query}", $class);
1176 =head2 $c->welcome_message
1178 Returns the Catalyst welcome HTML page.
1182 sub welcome_message {
1184 my $name = $c->config->{name};
1185 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1186 my $prefix = Catalyst::Utils::appprefix( ref $c );
1187 $c->response->content_type('text/html; charset=utf-8');
1189 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1190 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1191 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1193 <meta http-equiv="Content-Language" content="en" />
1194 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1195 <title>$name on Catalyst $VERSION</title>
1196 <style type="text/css">
1199 background-color: #eee;
1206 margin-bottom: 10px;
1208 background-color: #ccc;
1209 border: 1px solid #aaa;
1214 font-family: verdana, tahoma, sans-serif;
1217 font-family: verdana, tahoma, sans-serif;
1220 text-decoration: none;
1222 border-bottom: 1px dotted #bbb;
1224 :link:hover, :visited:hover {
1237 background-color: #fff;
1238 border: 1px solid #aaa;
1242 font-weight: normal;
1264 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1269 <img src="$logo" alt="Catalyst Logo" />
1271 <p>Welcome to the world of Catalyst.
1272 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1273 framework will make web development something you had
1274 never expected it to be: Fun, rewarding, and quick.</p>
1275 <h2>What to do now?</h2>
1276 <p>That really depends on what <b>you</b> want to do.
1277 We do, however, provide you with a few starting points.</p>
1278 <p>If you want to jump right into web development with Catalyst
1279 you might want to start with a tutorial.</p>
1280 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1282 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1284 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1285 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1287 <h2>What to do next?</h2>
1288 <p>Next it's time to write an actual application. Use the
1289 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1290 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1291 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1292 they can save you a lot of work.</p>
1293 <pre><code>script/${prefix}_create.pl -help</code></pre>
1294 <p>Also, be sure to check out the vast and growing
1295 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1296 you are likely to find what you need there.
1300 <p>Catalyst has a very active community. Here are the main places to
1301 get in touch with us.</p>
1304 <a href="http://dev.catalyst.perl.org">Wiki</a>
1307 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1310 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1313 <h2>In conclusion</h2>
1314 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1315 as we enjoyed making it. Please contact us if you have ideas
1316 for improvement or other feedback.</p>
1324 =head1 INTERNAL METHODS
1326 These methods are not meant to be used by end users.
1328 =head2 $c->components
1330 Returns a hash of components.
1332 =head2 $c->context_class
1334 Returns or sets the context class.
1338 Returns a hashref containing coderefs and execution counts (needed for
1339 deep recursion detection).
1343 Returns the number of actions on the current internal execution stack.
1347 Dispatches a request to actions.
1351 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1353 =head2 $c->dispatcher_class
1355 Returns or sets the dispatcher class.
1357 =head2 $c->dump_these
1359 Returns a list of 2-element array references (name, structure) pairs
1360 that will be dumped on the error page in debug mode.
1366 [ Request => $c->req ],
1367 [ Response => $c->res ],
1368 [ Stash => $c->stash ],
1369 [ Config => $c->config ];
1372 =head2 $c->engine_class
1374 Returns or sets the engine class.
1376 =head2 $c->execute( $class, $coderef )
1378 Execute a coderef in given class and catch exceptions. Errors are available
1384 my ( $c, $class, $code ) = @_;
1385 $class = $c->component($class) || $class;
1388 if ( $c->depth >= $RECURSION ) {
1389 my $action = $code->reverse();
1390 $action = "/$action" unless $action =~ /->/;
1391 my $error = qq/Deep recursion detected calling "${action}"/;
1392 $c->log->error($error);
1398 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1400 push( @{ $c->stack }, $code );
1402 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1404 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1406 my $last = pop( @{ $c->stack } );
1408 if ( my $error = $@ ) {
1409 if ( !ref($error) and $error eq $DETACH ) {
1410 die $DETACH if($c->depth > 1);
1412 elsif ( !ref($error) and $error eq $GO ) {
1413 die $GO if($c->depth > 0);
1416 unless ( ref $error ) {
1417 no warnings 'uninitialized';
1419 my $class = $last->class;
1420 my $name = $last->name;
1421 $error = qq/Caught exception in $class->$name "$error"/;
1430 sub _stats_start_execute {
1431 my ( $c, $code ) = @_;
1433 return if ( ( $code->name =~ /^_.*/ )
1434 && ( !$c->config->{show_internal_actions} ) );
1436 my $action_name = $code->reverse();
1437 $c->counter->{$action_name}++;
1439 my $action = $action_name;
1440 $action = "/$action" unless $action =~ /->/;
1442 # determine if the call was the result of a forward
1443 # this is done by walking up the call stack and looking for a calling
1444 # sub of Catalyst::forward before the eval
1446 for my $index ( 2 .. 11 ) {
1448 if ( ( caller($index) )[0] eq 'Catalyst'
1449 && ( caller($index) )[3] eq '(eval)' );
1451 if ( ( caller($index) )[3] =~ /forward$/ ) {
1452 $callsub = ( caller($index) )[3];
1453 $action = "-> $action";
1458 my $uid = $action_name . $c->counter->{$action_name};
1460 # is this a root-level call or a forwarded call?
1461 if ( $callsub =~ /forward$/ ) {
1463 # forward, locate the caller
1464 if ( my $parent = $c->stack->[-1] ) {
1467 parent => "$parent" . $c->counter->{"$parent"},
1473 # forward with no caller may come from a plugin
1492 sub _stats_finish_execute {
1493 my ( $c, $info ) = @_;
1494 $c->stats->profile( end => $info );
1497 =head2 $c->_localize_fields( sub { }, \%keys );
1501 #Why does this exist? This is no longer safe and WILL NOT WORK.
1502 # it doesnt seem to be used anywhere. can we remove it?
1503 sub _localize_fields {
1504 my ( $c, $localized, $code ) = ( @_ );
1506 my $request = delete $localized->{request} || {};
1507 my $response = delete $localized->{response} || {};
1509 local @{ $c }{ keys %$localized } = values %$localized;
1510 local @{ $c->request }{ keys %$request } = values %$request;
1511 local @{ $c->response }{ keys %$response } = values %$response;
1518 Finalizes the request.
1525 for my $error ( @{ $c->error } ) {
1526 $c->log->error($error);
1529 # Allow engine to handle finalize flow (for POE)
1530 my $engine = $c->engine;
1531 if ( my $code = $engine->can('finalize') ) {
1536 $c->finalize_uploads;
1539 if ( $#{ $c->error } >= 0 ) {
1543 $c->finalize_headers;
1546 if ( $c->request->method eq 'HEAD' ) {
1547 $c->response->body('');
1553 if ($c->use_stats) {
1554 my $elapsed = sprintf '%f', $c->stats->elapsed;
1555 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1557 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1560 return $c->response->status;
1563 =head2 $c->finalize_body
1569 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1571 =head2 $c->finalize_cookies
1577 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1579 =head2 $c->finalize_error
1585 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1587 =head2 $c->finalize_headers
1593 sub finalize_headers {
1596 my $response = $c->response; #accessor calls can add up?
1598 # Check if we already finalized headers
1599 return if $response->finalized_headers;
1602 if ( my $location = $response->redirect ) {
1603 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1604 $response->header( Location => $location );
1606 if ( !$response->has_body ) {
1607 # Add a default body if none is already present
1609 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1615 if ( $response->body && !$response->content_length ) {
1617 # get the length from a filehandle
1618 if ( blessed( $response->body ) && $response->body->can('read') )
1620 my $stat = stat $response->body;
1621 if ( $stat && $stat->size > 0 ) {
1622 $response->content_length( $stat->size );
1625 $c->log->warn('Serving filehandle without a content-length');
1629 # everything should be bytes at this point, but just in case
1630 $response->content_length( bytes::length( $response->body ) );
1635 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1636 $response->headers->remove_header("Content-Length");
1637 $response->body('');
1640 $c->finalize_cookies;
1642 $c->engine->finalize_headers( $c, @_ );
1645 $response->finalized_headers(1);
1648 =head2 $c->finalize_output
1650 An alias for finalize_body.
1652 =head2 $c->finalize_read
1654 Finalizes the input after reading is complete.
1658 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1660 =head2 $c->finalize_uploads
1662 Finalizes uploads. Cleans up any temporary files.
1666 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1668 =head2 $c->get_action( $action, $namespace )
1670 Gets an action in a given namespace.
1674 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1676 =head2 $c->get_actions( $action, $namespace )
1678 Gets all actions of a given name in a namespace and all parent
1683 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1685 =head2 $c->handle_request( $class, @arguments )
1687 Called to handle each HTTP request.
1691 sub handle_request {
1692 my ( $class, @arguments ) = @_;
1694 # Always expect worst case!
1697 if ($class->debug) {
1698 my $secs = time - $START || 1;
1699 my $av = sprintf '%.3f', $COUNT / $secs;
1700 my $time = localtime time;
1701 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1704 my $c = $class->prepare(@arguments);
1706 $status = $c->finalize;
1709 if ( my $error = $@ ) {
1711 $class->log->error(qq/Caught exception in engine "$error"/);
1716 if(my $coderef = $class->log->can('_flush')){
1717 $class->log->$coderef();
1722 =head2 $c->prepare( @arguments )
1724 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1730 my ( $class, @arguments ) = @_;
1733 # After the app/ctxt split, this should become an attribute based on something passed
1734 # into the application.
1735 $class->context_class( ref $class || $class ) unless $class->context_class;
1737 my $c = $class->context_class->new({});
1739 # For on-demand data
1740 $c->request->_context($c);
1741 $c->response->_context($c);
1743 #surely this is not the most efficient way to do things...
1744 $c->stats($class->stats_class->new)->enable($c->use_stats);
1746 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1749 #XXX reuse coderef from can
1750 # Allow engine to direct the prepare flow (for POE)
1751 if ( $c->engine->can('prepare') ) {
1752 $c->engine->prepare( $c, @arguments );
1755 $c->prepare_request(@arguments);
1756 $c->prepare_connection;
1757 $c->prepare_query_parameters;
1758 $c->prepare_headers;
1759 $c->prepare_cookies;
1762 # Prepare the body for reading, either by prepare_body
1763 # or the user, if they are using $c->read
1766 # Parse the body unless the user wants it on-demand
1767 unless ( $c->config->{parse_on_demand} ) {
1772 my $method = $c->req->method || '';
1773 my $path = $c->req->path;
1774 $path = '/' unless length $path;
1775 my $address = $c->req->address || '';
1777 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1785 =head2 $c->prepare_action
1787 Prepares action. See L<Catalyst::Dispatcher>.
1791 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1793 =head2 $c->prepare_body
1795 Prepares message body.
1802 return if $c->request->_has_body;
1804 # Initialize on-demand data
1805 $c->engine->prepare_body( $c, @_ );
1806 $c->prepare_parameters;
1807 $c->prepare_uploads;
1811 'Body Parameters are', $c->request->body_parameters
1816 =head2 $c->prepare_body_chunk( $chunk )
1818 Prepares a chunk of data before sending it to L<HTTP::Body>.
1820 See L<Catalyst::Engine>.
1824 sub prepare_body_chunk {
1826 $c->engine->prepare_body_chunk( $c, @_ );
1829 =head2 $c->prepare_body_parameters
1831 Prepares body parameters.
1835 sub prepare_body_parameters {
1837 $c->engine->prepare_body_parameters( $c, @_ );
1840 =head2 $c->prepare_connection
1842 Prepares connection.
1846 sub prepare_connection {
1848 $c->engine->prepare_connection( $c, @_ );
1851 =head2 $c->prepare_cookies
1857 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1859 =head2 $c->prepare_headers
1865 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1867 =head2 $c->prepare_parameters
1869 Prepares parameters.
1873 sub prepare_parameters {
1875 $c->prepare_body_parameters;
1876 $c->engine->prepare_parameters( $c, @_ );
1879 =head2 $c->prepare_path
1881 Prepares path and base.
1885 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1887 =head2 $c->prepare_query_parameters
1889 Prepares query parameters.
1893 sub prepare_query_parameters {
1896 $c->engine->prepare_query_parameters( $c, @_ );
1900 'Query Parameters are', $c->request->query_parameters
1905 =head2 $c->log_parameters($name, $parameters)
1907 Logs a hash reference of key value pairs, with a caption above the table.
1911 [debug] Query Parameters are:
1912 .-------------------------------------+--------------------------------------.
1913 | Parameter | Value |
1914 +-------------------------------------+--------------------------------------+
1916 | searchtype | modules |
1917 '-------------------------------------+--------------------------------------'
1919 If there are query parameters you don't want to display in this output, such
1920 as passwords or other sensitive input, you can configure your application to
1921 redact those parameters:
1923 C<< MyApp->config->{Debug}->{redact_parameters} = [ 'password' ] >>
1925 In that case, the output will look like:
1927 [debug] Query Parameters are:
1928 .-------------------------------------+--------------------------------------.
1929 | Parameter | Value |
1930 +-------------------------------------+--------------------------------------+
1931 | password | (redacted by config) |
1932 | username | some_user |
1933 '-------------------------------------+--------------------------------------'
1937 sub log_parameters {
1938 my ( $c, $name, $parameters ) = @_;
1940 my $skip = $c->config->{Debug}->{redact_parameters};
1942 ( not defined $skip or ref $skip eq 'ARRAY' )
1943 && keys %{ $parameters }
1945 my $t = Text::SimpleTable->new(
1946 [ 35, 'Parameter' ], [ 36, 'Value' ] );
1947 my %skip_params = map { $_ => $_ } @{ $skip || [] };
1948 for my $key ( sort keys %$parameters ) {
1949 my $param = $parameters->{$key};
1950 my $value = defined($param) ? $param : '';
1951 $value = '(redacted by config)' if exists $skip_params{$key};
1954 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1956 $c->log->debug( "$name:\n" . $t->draw );
1960 =head2 $c->prepare_read
1962 Prepares the input for reading.
1966 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1968 =head2 $c->prepare_request
1970 Prepares the engine request.
1974 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1976 =head2 $c->prepare_uploads
1982 sub prepare_uploads {
1985 $c->engine->prepare_uploads( $c, @_ );
1987 if ( $c->debug && keys %{ $c->request->uploads } ) {
1988 my $t = Text::SimpleTable->new(
1989 [ 12, 'Parameter' ],
1994 for my $key ( sort keys %{ $c->request->uploads } ) {
1995 my $upload = $c->request->uploads->{$key};
1996 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1997 $t->row( $key, $u->filename, $u->type, $u->size );
2000 $c->log->debug( "File Uploads are:\n" . $t->draw );
2004 =head2 $c->prepare_write
2006 Prepares the output for writing.
2010 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2012 =head2 $c->request_class
2014 Returns or sets the request class.
2016 =head2 $c->response_class
2018 Returns or sets the response class.
2020 =head2 $c->read( [$maxlength] )
2022 Reads a chunk of data from the request body. This method is designed to
2023 be used in a while loop, reading C<$maxlength> bytes on every call.
2024 C<$maxlength> defaults to the size of the request if not specified.
2026 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
2029 Warning: If you use read(), Catalyst will not process the body,
2030 so you will not be able to access POST parameters or file uploads via
2031 $c->request. You must handle all body parsing yourself.
2035 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2043 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2045 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2047 Sets an action in a given namespace.
2051 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2053 =head2 $c->setup_actions($component)
2055 Sets up actions for a component.
2059 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2061 =head2 $c->setup_components
2063 Sets up components. Specify a C<setup_components> config option to pass
2064 additional options directly to L<Module::Pluggable>. To add additional
2065 search paths, specify a key named C<search_extra> as an array
2066 reference. Items in the array beginning with C<::> will have the
2067 application class name prepended to them.
2069 All components found will also have any
2070 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2071 Note, that modules which are B<not> an I<inner package> of the main
2072 file namespace loaded will not be instantiated as components.
2076 sub setup_components {
2079 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2080 my $config = $class->config->{ setup_components };
2081 my $extra = delete $config->{ search_extra } || [];
2083 push @paths, @$extra;
2085 my $locator = Module::Pluggable::Object->new(
2086 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2090 my @comps = sort { length $a <=> length $b } $locator->plugins;
2091 my %comps = map { $_ => 1 } @comps;
2093 for my $component ( @comps ) {
2095 # We pass ignore_loaded here so that overlay files for (e.g.)
2096 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2097 # we know M::P::O found a file on disk so this is safe
2099 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2100 #Class::MOP::load_class($component);
2102 my $module = $class->setup_component( $component );
2104 $component => $module,
2106 $_ => $class->setup_component( $_ )
2108 not exists $comps{$_}
2109 } Devel::InnerPackage::list_packages( $component )
2112 for my $key ( keys %modules ) {
2113 $class->components->{ $key } = $modules{ $key };
2118 =head2 $c->setup_component
2122 sub setup_component {
2123 my( $class, $component ) = @_;
2125 unless ( $component->can( 'COMPONENT' ) ) {
2129 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2130 my $config = $class->config->{ $suffix } || {};
2132 my $instance = eval { $component->COMPONENT( $class, $config ); };
2134 if ( my $error = $@ ) {
2136 Catalyst::Exception->throw(
2137 message => qq/Couldn't instantiate component "$component", "$error"/
2141 Catalyst::Exception->throw(
2143 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2144 ) unless blessed($instance);
2149 =head2 $c->setup_dispatcher
2155 sub setup_dispatcher {
2156 my ( $class, $dispatcher ) = @_;
2159 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2162 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2163 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2166 unless ($dispatcher) {
2167 $dispatcher = $class->dispatcher_class;
2170 Class::MOP::load_class($dispatcher);
2172 # dispatcher instance
2173 $class->dispatcher( $dispatcher->new );
2176 =head2 $c->setup_engine
2183 my ( $class, $engine ) = @_;
2186 $engine = 'Catalyst::Engine::' . $engine;
2189 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2190 $engine = 'Catalyst::Engine::' . $env;
2193 if ( $ENV{MOD_PERL} ) {
2194 my $meta = Class::MOP::get_metaclass_by_name($class);
2196 # create the apache method
2197 $meta->add_method('apache' => sub { shift->engine->apache });
2199 my ( $software, $version ) =
2200 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2203 $version =~ s/(\.[^.]+)\./$1/g;
2205 if ( $software eq 'mod_perl' ) {
2209 if ( $version >= 1.99922 ) {
2210 $engine = 'Catalyst::Engine::Apache2::MP20';
2213 elsif ( $version >= 1.9901 ) {
2214 $engine = 'Catalyst::Engine::Apache2::MP19';
2217 elsif ( $version >= 1.24 ) {
2218 $engine = 'Catalyst::Engine::Apache::MP13';
2222 Catalyst::Exception->throw( message =>
2223 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2228 # install the correct mod_perl handler
2229 if ( $version >= 1.9901 ) {
2230 *handler = sub : method {
2231 shift->handle_request(@_);
2235 *handler = sub ($$) { shift->handle_request(@_) };
2240 elsif ( $software eq 'Zeus-Perl' ) {
2241 $engine = 'Catalyst::Engine::Zeus';
2245 Catalyst::Exception->throw(
2246 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2251 $engine = $class->engine_class;
2254 Class::MOP::load_class($engine);
2256 # check for old engines that are no longer compatible
2258 if ( $engine->isa('Catalyst::Engine::Apache')
2259 && !Catalyst::Engine::Apache->VERSION )
2264 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2265 && Catalyst::Engine::Server->VERSION le '0.02' )
2270 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2271 && $engine->VERSION eq '0.01' )
2276 elsif ($engine->isa('Catalyst::Engine::Zeus')
2277 && $engine->VERSION eq '0.01' )
2283 Catalyst::Exception->throw( message =>
2284 qq/Engine "$engine" is not supported by this version of Catalyst/
2289 $class->engine( $engine->new );
2292 =head2 $c->setup_home
2294 Sets up the home directory.
2299 my ( $class, $home ) = @_;
2301 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2305 $home ||= Catalyst::Utils::home($class);
2308 #I remember recently being scolded for assigning config values like this
2309 $class->config->{home} ||= $home;
2310 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2314 =head2 $c->setup_log
2316 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2317 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2320 This method also installs a C<debug> method that returns a true value into the
2321 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2322 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2324 Note that if the log has already been setup, by either a previous call to
2325 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2326 that this method won't actually set up the log object.
2331 my ( $class, $levels ) = @_;
2334 $levels =~ s/^\s+//;
2335 $levels =~ s/\s+$//;
2336 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels || '';
2338 unless ( $class->log ) {
2339 $class->log( Catalyst::Log->new(keys %levels) );
2342 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2343 if ( defined($env_debug) or $levels{debug} ) {
2344 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2345 $class->log->debug('Debug messages enabled');
2349 =head2 $c->setup_plugins
2355 =head2 $c->setup_stats
2357 Sets up timing statistics class.
2362 my ( $class, $stats ) = @_;
2364 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2366 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2367 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2368 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2369 $class->log->debug('Statistics enabled');
2374 =head2 $c->registered_plugins
2376 Returns a sorted list of the plugins which have either been stated in the
2377 import list or which have been added via C<< MyApp->plugin(@args); >>.
2379 If passed a given plugin name, it will report a boolean value indicating
2380 whether or not that plugin is loaded. A fully qualified name is required if
2381 the plugin name does not begin with C<Catalyst::Plugin::>.
2383 if ($c->registered_plugins('Some::Plugin')) {
2391 sub registered_plugins {
2393 return sort keys %{ $proto->_plugins } unless @_;
2395 return 1 if exists $proto->_plugins->{$plugin};
2396 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2399 sub _register_plugin {
2400 my ( $proto, $plugin, $instant ) = @_;
2401 my $class = ref $proto || $proto;
2403 # no ignore_loaded here, the plugin may already have been
2404 # defined in memory and we don't want to error on "no file" if so
2406 Class::MOP::load_class( $plugin );
2408 $proto->_plugins->{$plugin} = 1;
2411 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2412 my @superclasses = ($plugin, $meta->superclasses );
2413 $meta->superclasses(@superclasses);
2415 unshift @{"$class\::ISA"}, $plugin;
2422 my ( $class, $plugins ) = @_;
2424 $class->_plugins( {} ) unless $class->_plugins;
2426 for my $plugin ( reverse @$plugins ) {
2428 unless ( $plugin =~ s/\A\+// ) {
2429 $plugin = "Catalyst::Plugin::$plugin";
2432 $class->_register_plugin($plugin);
2439 Returns an arrayref of the internal execution stack (actions that are
2440 currently executing).
2442 =head2 $c->stats_class
2444 Returns or sets the stats (timing statistics) class.
2446 =head2 $c->use_stats
2448 Returns 1 when stats collection is enabled. Stats collection is enabled
2449 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2450 environment variable is set.
2452 Note that this is a static method, not an accessor and should be overloaded
2453 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2460 =head2 $c->write( $data )
2462 Writes $data to the output stream. When using this method directly, you
2463 will need to manually set the C<Content-Length> header to the length of
2464 your output data, if known.
2471 # Finalize headers if someone manually writes output
2472 $c->finalize_headers;
2474 return $c->engine->write( $c, @_ );
2479 Returns the Catalyst version number. Mostly useful for "powered by"
2480 messages in template systems.
2484 sub version { return $Catalyst::VERSION }
2486 =head1 INTERNAL ACTIONS
2488 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2489 C<_ACTION>, and C<_END>. These are by default not shown in the private
2490 action table, but you can make them visible with a config parameter.
2492 MyApp->config->{show_internal_actions} = 1;
2494 =head1 CASE SENSITIVITY
2496 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2497 mapped to C</foo/bar>. You can activate case sensitivity with a config
2500 MyApp->config->{case_sensitive} = 1;
2502 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2504 =head1 ON-DEMAND PARSER
2506 The request body is usually parsed at the beginning of a request,
2507 but if you want to handle input yourself, you can enable on-demand
2508 parsing with a config parameter.
2510 MyApp->config->{parse_on_demand} = 1;
2512 =head1 PROXY SUPPORT
2514 Many production servers operate using the common double-server approach,
2515 with a lightweight frontend web server passing requests to a larger
2516 backend server. An application running on the backend server must deal
2517 with two problems: the remote user always appears to be C<127.0.0.1> and
2518 the server's hostname will appear to be C<localhost> regardless of the
2519 virtual host that the user connected through.
2521 Catalyst will automatically detect this situation when you are running
2522 the frontend and backend servers on the same machine. The following
2523 changes are made to the request.
2525 $c->req->address is set to the user's real IP address, as read from
2526 the HTTP X-Forwarded-For header.
2528 The host value for $c->req->base and $c->req->uri is set to the real
2529 host, as read from the HTTP X-Forwarded-Host header.
2531 Obviously, your web server must support these headers for this to work.
2533 In a more complex server farm environment where you may have your
2534 frontend proxy server(s) on different machines, you will need to set a
2535 configuration option to tell Catalyst to read the proxied data from the
2538 MyApp->config->{using_frontend_proxy} = 1;
2540 If you do not wish to use the proxy support at all, you may set:
2542 MyApp->config->{ignore_frontend_proxy} = 1;
2544 =head1 THREAD SAFETY
2546 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2547 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2548 believe the Catalyst core to be thread-safe.
2550 If you plan to operate in a threaded environment, remember that all other
2551 modules you are using must also be thread-safe. Some modules, most notably
2552 L<DBD::SQLite>, are not thread-safe.
2558 Join #catalyst on irc.perl.org.
2562 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2563 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2567 http://catalyst.perl.org
2571 http://dev.catalyst.perl.org
2575 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2577 =head2 L<Catalyst::Manual> - The Catalyst Manual
2579 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2581 =head2 L<Catalyst::Engine> - Core engine
2583 =head2 L<Catalyst::Log> - Log class.
2585 =head2 L<Catalyst::Request> - Request object
2587 =head2 L<Catalyst::Response> - Response object
2589 =head2 L<Catalyst::Test> - The test suite.
2591 =head1 PROJECT FOUNDER
2593 sri: Sebastian Riedel <sri@cpan.org>
2599 acme: Leon Brocard <leon@astray.com>
2607 andyg: Andy Grundman <andy@hybridized.org>
2609 audreyt: Audrey Tang
2611 bricas: Brian Cassidy <bricas@cpan.org>
2613 Byron Young <Byron.Young@riverbed.com>
2615 Caelum: Rafael Kitover <rkitover@io.com>
2617 chansen: Christian Hansen
2619 chicks: Christopher Hicks
2623 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2627 esskar: Sascha Kiefer
2629 fireartist: Carl Franks <cfranks@cpan.org>
2631 gabb: Danijel Milicevic
2637 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2639 jcamacho: Juan Camacho
2641 jhannah: Jay Hannah <jay@jays.net>
2647 jon: Jon Schutz <jjschutz@cpan.org>
2649 marcus: Marcus Ramberg <mramberg@cpan.org>
2651 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2653 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2657 naughton: David Naughton
2659 ningu: David Kamholz <dkamholz@cpan.org>
2661 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2663 numa: Dan Sully <daniel@cpan.org>
2667 omega: Andreas Marienborg
2669 Oleg Kostyuk <cub.uanic@gmail.com>
2671 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2673 rafl: Florian Ragwitz <rafl@debian.org>
2677 the_jester: Jesse Sheidlower
2679 t0m: Tomas Doran <bobtfish@bobtfish.net>
2683 willert: Sebastian Willert <willert@cpan.org>
2687 This library is free software, you can redistribute it and/or modify it under
2688 the same terms as Perl itself.
2694 __PACKAGE__->meta->make_immutable;