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 blessed/;
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 C<$c-E<gt>stash> is kept unchanged.
362 In effect, C<visit> allows you to "wrap" another action, just as it
363 would have been called by dispatching from a URL, while the analogous
364 C<go> allows you to transfer control to another action as if it had
365 been reached directly from a URL.
369 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
371 =head2 $c->go( $action [, \@arguments ] )
373 =head2 $c->go( $class, $method, [, \@arguments ] )
375 Almost the same as C<detach>, but does a full dispatch like C<visit>,
376 instead of just calling the new C<$action> /
377 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
378 method you visit are called, just like a new request.
380 C<$c-E<gt>stash> is kept unchanged.
384 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
390 Returns the current L<Catalyst::Response> object, see there for details.
394 Returns a hashref to the stash, which may be used to store data and pass
395 it between components during a request. You can also set hash keys by
396 passing arguments. The stash is automatically sent to the view. The
397 stash is cleared at the end of a request; it cannot be used for
398 persistent storage (for this you must use a session; see
399 L<Catalyst::Plugin::Session> for a complete system integrated with
402 $c->stash->{foo} = $bar;
403 $c->stash( { moose => 'majestic', qux => 0 } );
404 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
406 # stash is automatically passed to the view for use in a template
407 $c->forward( 'MyApp::View::TT' );
411 around stash => sub {
414 my $stash = $orig->($c);
416 my $new_stash = @_ > 1 ? {@_} : $_[0];
417 croak('stash takes a hash or hashref') unless ref $new_stash;
418 foreach my $key ( keys %$new_stash ) {
419 $stash->{$key} = $new_stash->{$key};
429 =head2 $c->error($error, ...)
431 =head2 $c->error($arrayref)
433 Returns an arrayref containing error messages. If Catalyst encounters an
434 error while processing a request, it stores the error in $c->error. This
435 method should only be used to store fatal error messages.
437 my @error = @{ $c->error };
441 $c->error('Something bad happened');
448 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
449 croak @$error unless ref $c;
450 push @{ $c->{error} }, @$error;
452 elsif ( defined $_[0] ) { $c->{error} = undef }
453 return $c->{error} || [];
459 Contains the return value of the last executed action.
461 =head2 $c->clear_errors
463 Clear errors. You probably don't want to clear the errors unless you are
464 implementing a custom error screen.
466 This is equivalent to running
477 # search components given a name and some prefixes
478 sub _comp_search_prefixes {
479 my ( $c, $name, @prefixes ) = @_;
480 my $appclass = ref $c || $c;
481 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
483 # map the original component name to the sub part that we will search against
484 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
485 grep { /$filter/ } keys %{ $c->components };
487 # undef for a name will return all
488 return keys %eligible if !defined $name;
490 my $query = ref $name ? $name : qr/^$name$/i;
491 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
493 return map { $c->components->{ $_ } } @result if @result;
495 # if we were given a regexp to search against, we're done.
500 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
502 # no results? try against full names
504 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
507 # don't warn if we didn't find any results, it just might not exist
509 my $msg = "Used regexp fallback for \$c->model('${name}'), which found '" .
510 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
511 "component resolution is unreliable and unsafe.";
512 my $short = $result[0];
513 $short =~ s/.*?Model:://;
514 my $shortmess = Carp::shortmess('');
515 if ($shortmess =~ m#Catalyst/Plugin#) {
516 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
518 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
519 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
520 "component's config";
522 $msg .= " You probably meant \$c->model('$short') instead of \$c->model{'${name}'}, " .
523 "but if you really wanted to search, pass in a regexp as the argument " .
524 "like so: \$c->model(qr/${name}/)";
526 $c->log->warn( "${msg}$shortmess" );
532 # Find possible names for a prefix
534 my ( $c, @prefixes ) = @_;
535 my $appclass = ref $c || $c;
537 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
539 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
543 # Filter a component before returning by calling ACCEPT_CONTEXT if available
544 sub _filter_component {
545 my ( $c, $comp, @args ) = @_;
547 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
548 return $comp->ACCEPT_CONTEXT( $c, @args );
554 =head2 COMPONENT ACCESSORS
556 =head2 $c->controller($name)
558 Gets a L<Catalyst::Controller> instance by name.
560 $c->controller('Foo')->do_stuff;
562 If the name is omitted, will return the controller for the dispatched
565 If you want to search for controllers, pass in a regexp as the argument.
567 # find all controllers that start with Foo
568 my @foo_controllers = $c->controller(qr{^Foo});
574 my ( $c, $name, @args ) = @_;
577 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
578 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
579 return $c->_filter_component( $result[ 0 ], @args );
582 return $c->component( $c->action->class );
585 =head2 $c->model($name)
587 Gets a L<Catalyst::Model> instance by name.
589 $c->model('Foo')->do_stuff;
591 Any extra arguments are directly passed to ACCEPT_CONTEXT.
593 If the name is omitted, it will look for
594 - a model object in $c->stash->{current_model_instance}, then
595 - a model name in $c->stash->{current_model}, then
596 - a config setting 'default_model', or
597 - check if there is only one model, and return it if that's the case.
599 If you want to search for models, pass in a regexp as the argument.
601 # find all models that start with Foo
602 my @foo_models = $c->model(qr{^Foo});
607 my ( $c, $name, @args ) = @_;
610 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
611 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
612 return $c->_filter_component( $result[ 0 ], @args );
616 return $c->stash->{current_model_instance}
617 if $c->stash->{current_model_instance};
618 return $c->model( $c->stash->{current_model} )
619 if $c->stash->{current_model};
621 return $c->model( $c->config->{default_model} )
622 if $c->config->{default_model};
624 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
627 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
628 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
629 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
630 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
631 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
634 return $c->_filter_component( $comp );
638 =head2 $c->view($name)
640 Gets a L<Catalyst::View> instance by name.
642 $c->view('Foo')->do_stuff;
644 Any extra arguments are directly passed to ACCEPT_CONTEXT.
646 If the name is omitted, it will look for
647 - a view object in $c->stash->{current_view_instance}, then
648 - a view name in $c->stash->{current_view}, then
649 - a config setting 'default_view', or
650 - check if there is only one view, and return it if that's the case.
652 If you want to search for views, pass in a regexp as the argument.
654 # find all views that start with Foo
655 my @foo_views = $c->view(qr{^Foo});
660 my ( $c, $name, @args ) = @_;
663 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
664 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
665 return $c->_filter_component( $result[ 0 ], @args );
669 return $c->stash->{current_view_instance}
670 if $c->stash->{current_view_instance};
671 return $c->view( $c->stash->{current_view} )
672 if $c->stash->{current_view};
674 return $c->view( $c->config->{default_view} )
675 if $c->config->{default_view};
677 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
680 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
681 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
682 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
683 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
684 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
687 return $c->_filter_component( $comp );
690 =head2 $c->controllers
692 Returns the available names which can be passed to $c->controller
698 return $c->_comp_names(qw/Controller C/);
703 Returns the available names which can be passed to $c->model
709 return $c->_comp_names(qw/Model M/);
715 Returns the available names which can be passed to $c->view
721 return $c->_comp_names(qw/View V/);
724 =head2 $c->comp($name)
726 =head2 $c->component($name)
728 Gets a component object by name. This method is not recommended,
729 unless you want to get a specific component by full
730 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
731 should be used instead.
733 If C<$name> is a regexp, a list of components matched against the full
734 component name will be returned.
739 my ( $c, $name, @args ) = @_;
742 my $comps = $c->components;
745 # is it the exact name?
746 return $c->_filter_component( $comps->{ $name }, @args )
747 if exists $comps->{ $name };
749 # perhaps we just omitted "MyApp"?
750 my $composed = ( ref $c || $c ) . "::${name}";
751 return $c->_filter_component( $comps->{ $composed }, @args )
752 if exists $comps->{ $composed };
754 # search all of the models, views and controllers
755 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
756 return $c->_filter_component( $comp, @args ) if $comp;
759 # This is here so $c->comp( '::M::' ) works
760 my $query = ref $name ? $name : qr{$name}i;
762 my @result = grep { m{$query} } keys %{ $c->components };
763 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
766 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
767 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
768 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
769 return $c->_filter_component( $result[ 0 ], @args );
772 # I would expect to return an empty list here, but that breaks back-compat
776 return sort keys %{ $c->components };
779 =head2 CLASS DATA AND HELPER CLASSES
783 Returns or takes a hashref containing the application's configuration.
785 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
787 You can also use a C<YAML>, C<XML> or C<Config::General> config file
788 like myapp.yml in your applications home directory. See
789 L<Catalyst::Plugin::ConfigLoader>.
792 db: dsn:SQLite:foo.db
797 around config => sub {
801 $c->log->warn("Setting config after setup has been run is not a good idea.")
802 if ( @_ and $c->setup_finished );
809 Returns the logging object instance. Unless it is already set, Catalyst
810 sets this up with a L<Catalyst::Log> object. To use your own log class,
811 set the logger with the C<< __PACKAGE__->log >> method prior to calling
812 C<< __PACKAGE__->setup >>.
814 __PACKAGE__->log( MyLogger->new );
819 $c->log->info( 'Now logging with my own logger!' );
821 Your log class should implement the methods described in
827 Overload to enable debug messages (same as -Debug option).
829 Note that this is a static method, not an accessor and should be overloaded
830 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
836 =head2 $c->dispatcher
838 Returns the dispatcher instance. Stringifies to class name. See
839 L<Catalyst::Dispatcher>.
843 Returns the engine instance. Stringifies to the class name. See
847 =head2 UTILITY METHODS
849 =head2 $c->path_to(@path)
851 Merges C<@path> with C<< $c->config->{home} >> and returns a
852 L<Path::Class::Dir> object.
856 $c->path_to( 'db', 'sqlite.db' );
861 my ( $c, @path ) = @_;
862 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
863 if ( -d $path ) { return $path }
864 else { return Path::Class::File->new( $c->config->{home}, @path ) }
867 =head2 $c->plugin( $name, $class, @args )
869 Helper method for plugins. It creates a classdata accessor/mutator and
870 loads and instantiates the given class.
872 MyApp->plugin( 'prototype', 'HTML::Prototype' );
874 $c->prototype->define_javascript_functions;
876 B<Note:> This method of adding plugins is deprecated. The ability
877 to add plugins like this B<will be removed> in a Catalyst 5.9.
878 Please do not use this functionality in new code.
883 my ( $class, $name, $plugin, @args ) = @_;
885 # See block comment in t/unit_core_plugin.t
886 $class->log->debug(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.9/);
888 $class->_register_plugin( $plugin, 1 );
890 eval { $plugin->import };
891 $class->mk_classdata($name);
893 eval { $obj = $plugin->new(@args) };
896 Catalyst::Exception->throw( message =>
897 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
901 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
907 Initializes the dispatcher and engine, loads any plugins, and loads the
908 model, view, and controller components. You may also specify an array
909 of plugins to load here, if you choose to not load them in the C<use
913 MyApp->setup( qw/-Debug/ );
918 my ( $class, @arguments ) = @_;
919 $class->log->warn("Running setup twice is not a good idea.")
920 if ( $class->setup_finished );
922 unless ( $class->isa('Catalyst') ) {
924 Catalyst::Exception->throw(
925 message => qq/'$class' does not inherit from Catalyst/ );
928 if ( $class->arguments ) {
929 @arguments = ( @arguments, @{ $class->arguments } );
935 foreach (@arguments) {
939 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
941 elsif (/^-(\w+)=?(.*)$/) {
942 $flags->{ lc $1 } = $2;
945 push @{ $flags->{plugins} }, $_;
949 $class->setup_home( delete $flags->{home} );
951 $class->setup_log( delete $flags->{log} );
952 $class->setup_plugins( delete $flags->{plugins} );
953 $class->setup_dispatcher( delete $flags->{dispatcher} );
954 $class->setup_engine( delete $flags->{engine} );
955 $class->setup_stats( delete $flags->{stats} );
957 for my $flag ( sort keys %{$flags} ) {
959 if ( my $code = $class->can( 'setup_' . $flag ) ) {
960 &$code( $class, delete $flags->{$flag} );
963 $class->log->warn(qq/Unknown flag "$flag"/);
967 eval { require Catalyst::Devel; };
968 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
969 $class->log->warn(<<"EOF");
970 You are running an old script!
972 Please update by running (this will overwrite existing files):
973 catalyst.pl -force -scripts $class
975 or (this will not overwrite existing files):
976 catalyst.pl -scripts $class
981 if ( $class->debug ) {
982 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
985 my $t = Text::SimpleTable->new(74);
986 $t->row($_) for @plugins;
987 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
990 my $dispatcher = $class->dispatcher;
991 my $engine = $class->engine;
992 my $home = $class->config->{home};
994 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
995 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
999 ? $class->log->debug(qq/Found home "$home"/)
1000 : $class->log->debug(qq/Home "$home" doesn't exist/)
1001 : $class->log->debug(q/Couldn't find home/);
1004 # Call plugins setup, this is stupid and evil.
1006 no warnings qw/redefine/;
1007 local *setup = sub { };
1011 # Initialize our data structure
1012 $class->components( {} );
1014 $class->setup_components;
1016 if ( $class->debug ) {
1017 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
1018 for my $comp ( sort keys %{ $class->components } ) {
1019 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1020 $t->row( $comp, $type );
1022 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1023 if ( keys %{ $class->components } );
1026 # Add our self to components, since we are also a component
1027 if( $class->isa('Catalyst::Controller') ){
1028 $class->components->{$class} = $class;
1031 $class->setup_actions;
1033 if ( $class->debug ) {
1034 my $name = $class->config->{name} || 'Application';
1035 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1037 $class->log->_flush() if $class->log->can('_flush');
1039 # Make sure that the application class becomes immutable at this point,
1040 # which ensures that it gets an inlined constructor. This means that it
1041 # works even if the user has added a plugin which contains a new method.
1042 # Note however that we have to do the work on scope end, so that method
1043 # modifiers work correctly in MyApp (as you have to call setup _before_
1044 # applying modifiers).
1045 Scope::Upper::reap(sub {
1046 my $meta = Class::MOP::get_metaclass_by_name($class);
1047 $meta->make_immutable unless $meta->is_immutable;
1050 $class->setup_finished(1);
1053 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1055 =head2 $c->uri_for( $path, @args?, \%query_values? )
1061 A Catalyst::Action object representing the Catalyst action you want to
1062 create a URI for. To get one for an action in the current controller,
1063 use C<< $c->action('someactionname') >>. To get one from different
1064 controller, fetch the controller using C<< $c->controller() >>, then
1065 call C<action_for> on it.
1067 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1068 using C<< $c->req->captures >>.
1070 # For the current action
1071 $c->uri_for($c->action, $c->req->captures);
1073 # For the Foo action in the Bar controller
1074 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1081 my ( $c, $path, @args ) = @_;
1083 if ( Scalar::Util::blessed($path) ) { # action object
1084 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1087 $path = $c->dispatcher->uri_for_action($path, $captures);
1088 return undef unless defined($path);
1089 $path = '/' if $path eq '';
1092 undef($path) if (defined $path && $path eq '');
1095 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1097 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1098 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1100 unshift(@args, $path);
1102 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1103 my $namespace = $c->namespace;
1104 if (defined $path) { # cheesy hack to handle path '../foo'
1105 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1107 unshift(@args, $namespace || '');
1110 # join args with '/', or a blank string
1111 my $args = join('/', grep { defined($_) } @args);
1112 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1114 my $base = $c->req->base;
1115 my $class = ref($base);
1116 $base =~ s{(?<!/)$}{/};
1120 if (my @keys = keys %$params) {
1121 # somewhat lifted from URI::_query's query_form
1122 $query = '?'.join('&', map {
1123 my $val = $params->{$_};
1124 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1127 $val = '' unless defined $val;
1130 utf8::encode( $_ ) if utf8::is_utf8($_);
1131 # using the URI::Escape pattern here so utf8 chars survive
1132 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1134 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1138 my $res = bless(\"${base}${args}${query}", $class);
1142 =head2 $c->welcome_message
1144 Returns the Catalyst welcome HTML page.
1148 sub welcome_message {
1150 my $name = $c->config->{name};
1151 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1152 my $prefix = Catalyst::Utils::appprefix( ref $c );
1153 $c->response->content_type('text/html; charset=utf-8');
1155 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1156 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1157 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1159 <meta http-equiv="Content-Language" content="en" />
1160 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1161 <title>$name on Catalyst $VERSION</title>
1162 <style type="text/css">
1165 background-color: #eee;
1172 margin-bottom: 10px;
1174 background-color: #ccc;
1175 border: 1px solid #aaa;
1180 font-family: verdana, tahoma, sans-serif;
1183 font-family: verdana, tahoma, sans-serif;
1186 text-decoration: none;
1188 border-bottom: 1px dotted #bbb;
1190 :link:hover, :visited:hover {
1203 background-color: #fff;
1204 border: 1px solid #aaa;
1208 font-weight: normal;
1230 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1235 <img src="$logo" alt="Catalyst Logo" />
1237 <p>Welcome to the world of Catalyst.
1238 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1239 framework will make web development something you had
1240 never expected it to be: Fun, rewarding, and quick.</p>
1241 <h2>What to do now?</h2>
1242 <p>That really depends on what <b>you</b> want to do.
1243 We do, however, provide you with a few starting points.</p>
1244 <p>If you want to jump right into web development with Catalyst
1245 you might want to start with a tutorial.</p>
1246 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1248 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1250 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1251 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1253 <h2>What to do next?</h2>
1254 <p>Next it's time to write an actual application. Use the
1255 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1256 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1257 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1258 they can save you a lot of work.</p>
1259 <pre><code>script/${prefix}_create.pl -help</code></pre>
1260 <p>Also, be sure to check out the vast and growing
1261 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1262 you are likely to find what you need there.
1266 <p>Catalyst has a very active community. Here are the main places to
1267 get in touch with us.</p>
1270 <a href="http://dev.catalyst.perl.org">Wiki</a>
1273 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1276 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1279 <h2>In conclusion</h2>
1280 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1281 as we enjoyed making it. Please contact us if you have ideas
1282 for improvement or other feedback.</p>
1290 =head1 INTERNAL METHODS
1292 These methods are not meant to be used by end users.
1294 =head2 $c->components
1296 Returns a hash of components.
1298 =head2 $c->context_class
1300 Returns or sets the context class.
1304 Returns a hashref containing coderefs and execution counts (needed for
1305 deep recursion detection).
1309 Returns the number of actions on the current internal execution stack.
1313 Dispatches a request to actions.
1317 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1319 =head2 $c->dispatcher_class
1321 Returns or sets the dispatcher class.
1323 =head2 $c->dump_these
1325 Returns a list of 2-element array references (name, structure) pairs
1326 that will be dumped on the error page in debug mode.
1332 [ Request => $c->req ],
1333 [ Response => $c->res ],
1334 [ Stash => $c->stash ],
1335 [ Config => $c->config ];
1338 =head2 $c->engine_class
1340 Returns or sets the engine class.
1342 =head2 $c->execute( $class, $coderef )
1344 Execute a coderef in given class and catch exceptions. Errors are available
1350 my ( $c, $class, $code ) = @_;
1351 $class = $c->component($class) || $class;
1354 if ( $c->depth >= $RECURSION ) {
1355 my $action = $code->reverse();
1356 $action = "/$action" unless $action =~ /->/;
1357 my $error = qq/Deep recursion detected calling "${action}"/;
1358 $c->log->error($error);
1364 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1366 push( @{ $c->stack }, $code );
1368 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1370 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1372 my $last = pop( @{ $c->stack } );
1374 if ( my $error = $@ ) {
1375 if ( !ref($error) and $error eq $DETACH ) {
1376 die $DETACH if($c->depth > 1);
1378 elsif ( !ref($error) and $error eq $GO ) {
1379 die $GO if($c->depth > 0);
1382 unless ( ref $error ) {
1383 no warnings 'uninitialized';
1385 my $class = $last->class;
1386 my $name = $last->name;
1387 $error = qq/Caught exception in $class->$name "$error"/;
1396 sub _stats_start_execute {
1397 my ( $c, $code ) = @_;
1399 return if ( ( $code->name =~ /^_.*/ )
1400 && ( !$c->config->{show_internal_actions} ) );
1402 my $action_name = $code->reverse();
1403 $c->counter->{$action_name}++;
1405 my $action = $action_name;
1406 $action = "/$action" unless $action =~ /->/;
1408 # determine if the call was the result of a forward
1409 # this is done by walking up the call stack and looking for a calling
1410 # sub of Catalyst::forward before the eval
1412 for my $index ( 2 .. 11 ) {
1414 if ( ( caller($index) )[0] eq 'Catalyst'
1415 && ( caller($index) )[3] eq '(eval)' );
1417 if ( ( caller($index) )[3] =~ /forward$/ ) {
1418 $callsub = ( caller($index) )[3];
1419 $action = "-> $action";
1424 my $uid = $action_name . $c->counter->{$action_name};
1426 # is this a root-level call or a forwarded call?
1427 if ( $callsub =~ /forward$/ ) {
1429 # forward, locate the caller
1430 if ( my $parent = $c->stack->[-1] ) {
1433 parent => "$parent" . $c->counter->{"$parent"},
1439 # forward with no caller may come from a plugin
1458 sub _stats_finish_execute {
1459 my ( $c, $info ) = @_;
1460 $c->stats->profile( end => $info );
1463 =head2 $c->_localize_fields( sub { }, \%keys );
1467 #Why does this exist? This is no longer safe and WILL NOT WORK.
1468 # it doesnt seem to be used anywhere. can we remove it?
1469 sub _localize_fields {
1470 my ( $c, $localized, $code ) = ( @_ );
1472 my $request = delete $localized->{request} || {};
1473 my $response = delete $localized->{response} || {};
1475 local @{ $c }{ keys %$localized } = values %$localized;
1476 local @{ $c->request }{ keys %$request } = values %$request;
1477 local @{ $c->response }{ keys %$response } = values %$response;
1484 Finalizes the request.
1491 for my $error ( @{ $c->error } ) {
1492 $c->log->error($error);
1495 # Allow engine to handle finalize flow (for POE)
1496 my $engine = $c->engine;
1497 if ( my $code = $engine->can('finalize') ) {
1502 $c->finalize_uploads;
1505 if ( $#{ $c->error } >= 0 ) {
1509 $c->finalize_headers;
1512 if ( $c->request->method eq 'HEAD' ) {
1513 $c->response->body('');
1519 if ($c->use_stats) {
1520 my $elapsed = sprintf '%f', $c->stats->elapsed;
1521 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1523 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1526 return $c->response->status;
1529 =head2 $c->finalize_body
1535 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1537 =head2 $c->finalize_cookies
1543 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1545 =head2 $c->finalize_error
1551 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1553 =head2 $c->finalize_headers
1559 sub finalize_headers {
1562 my $response = $c->response; #accessor calls can add up?
1564 # Check if we already finalized headers
1565 return if $response->finalized_headers;
1568 if ( my $location = $response->redirect ) {
1569 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1570 $response->header( Location => $location );
1572 if ( !$response->has_body ) {
1573 # Add a default body if none is already present
1575 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1581 if ( $response->body && !$response->content_length ) {
1583 # get the length from a filehandle
1584 if ( blessed( $response->body ) && $response->body->can('read') )
1586 my $stat = stat $response->body;
1587 if ( $stat && $stat->size > 0 ) {
1588 $response->content_length( $stat->size );
1591 $c->log->warn('Serving filehandle without a content-length');
1595 # everything should be bytes at this point, but just in case
1596 $response->content_length( bytes::length( $response->body ) );
1601 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1602 $response->headers->remove_header("Content-Length");
1603 $response->body('');
1606 $c->finalize_cookies;
1608 $c->engine->finalize_headers( $c, @_ );
1611 $response->finalized_headers(1);
1614 =head2 $c->finalize_output
1616 An alias for finalize_body.
1618 =head2 $c->finalize_read
1620 Finalizes the input after reading is complete.
1624 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1626 =head2 $c->finalize_uploads
1628 Finalizes uploads. Cleans up any temporary files.
1632 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1634 =head2 $c->get_action( $action, $namespace )
1636 Gets an action in a given namespace.
1640 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1642 =head2 $c->get_actions( $action, $namespace )
1644 Gets all actions of a given name in a namespace and all parent
1649 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1651 =head2 $c->handle_request( $class, @arguments )
1653 Called to handle each HTTP request.
1657 sub handle_request {
1658 my ( $class, @arguments ) = @_;
1660 # Always expect worst case!
1663 if ($class->debug) {
1664 my $secs = time - $START || 1;
1665 my $av = sprintf '%.3f', $COUNT / $secs;
1666 my $time = localtime time;
1667 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1670 my $c = $class->prepare(@arguments);
1672 $status = $c->finalize;
1675 if ( my $error = $@ ) {
1677 $class->log->error(qq/Caught exception in engine "$error"/);
1682 if(my $coderef = $class->log->can('_flush')){
1683 $class->log->$coderef();
1688 =head2 $c->prepare( @arguments )
1690 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1696 my ( $class, @arguments ) = @_;
1699 # After the app/ctxt split, this should become an attribute based on something passed
1700 # into the application.
1701 $class->context_class( ref $class || $class ) unless $class->context_class;
1703 my $c = $class->context_class->new({});
1705 # For on-demand data
1706 $c->request->_context($c);
1707 $c->response->_context($c);
1709 #surely this is not the most efficient way to do things...
1710 $c->stats($class->stats_class->new)->enable($c->use_stats);
1712 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1715 #XXX reuse coderef from can
1716 # Allow engine to direct the prepare flow (for POE)
1717 if ( $c->engine->can('prepare') ) {
1718 $c->engine->prepare( $c, @arguments );
1721 $c->prepare_request(@arguments);
1722 $c->prepare_connection;
1723 $c->prepare_query_parameters;
1724 $c->prepare_headers;
1725 $c->prepare_cookies;
1728 # Prepare the body for reading, either by prepare_body
1729 # or the user, if they are using $c->read
1732 # Parse the body unless the user wants it on-demand
1733 unless ( $c->config->{parse_on_demand} ) {
1738 my $method = $c->req->method || '';
1739 my $path = $c->req->path;
1740 $path = '/' unless length $path;
1741 my $address = $c->req->address || '';
1743 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1751 =head2 $c->prepare_action
1753 Prepares action. See L<Catalyst::Dispatcher>.
1757 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1759 =head2 $c->prepare_body
1761 Prepares message body.
1768 return if $c->request->_has_body;
1770 # Initialize on-demand data
1771 $c->engine->prepare_body( $c, @_ );
1772 $c->prepare_parameters;
1773 $c->prepare_uploads;
1775 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1776 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1777 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1778 my $param = $c->req->body_parameters->{$key};
1779 my $value = defined($param) ? $param : '';
1781 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1783 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1787 =head2 $c->prepare_body_chunk( $chunk )
1789 Prepares a chunk of data before sending it to L<HTTP::Body>.
1791 See L<Catalyst::Engine>.
1795 sub prepare_body_chunk {
1797 $c->engine->prepare_body_chunk( $c, @_ );
1800 =head2 $c->prepare_body_parameters
1802 Prepares body parameters.
1806 sub prepare_body_parameters {
1808 $c->engine->prepare_body_parameters( $c, @_ );
1811 =head2 $c->prepare_connection
1813 Prepares connection.
1817 sub prepare_connection {
1819 $c->engine->prepare_connection( $c, @_ );
1822 =head2 $c->prepare_cookies
1828 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1830 =head2 $c->prepare_headers
1836 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1838 =head2 $c->prepare_parameters
1840 Prepares parameters.
1844 sub prepare_parameters {
1846 $c->prepare_body_parameters;
1847 $c->engine->prepare_parameters( $c, @_ );
1850 =head2 $c->prepare_path
1852 Prepares path and base.
1856 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1858 =head2 $c->prepare_query_parameters
1860 Prepares query parameters.
1864 sub prepare_query_parameters {
1867 $c->engine->prepare_query_parameters( $c, @_ );
1869 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1870 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1871 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1872 my $param = $c->req->query_parameters->{$key};
1873 my $value = defined($param) ? $param : '';
1875 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1877 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1881 =head2 $c->prepare_read
1883 Prepares the input for reading.
1887 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1889 =head2 $c->prepare_request
1891 Prepares the engine request.
1895 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1897 =head2 $c->prepare_uploads
1903 sub prepare_uploads {
1906 $c->engine->prepare_uploads( $c, @_ );
1908 if ( $c->debug && keys %{ $c->request->uploads } ) {
1909 my $t = Text::SimpleTable->new(
1910 [ 12, 'Parameter' ],
1915 for my $key ( sort keys %{ $c->request->uploads } ) {
1916 my $upload = $c->request->uploads->{$key};
1917 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1918 $t->row( $key, $u->filename, $u->type, $u->size );
1921 $c->log->debug( "File Uploads are:\n" . $t->draw );
1925 =head2 $c->prepare_write
1927 Prepares the output for writing.
1931 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1933 =head2 $c->request_class
1935 Returns or sets the request class.
1937 =head2 $c->response_class
1939 Returns or sets the response class.
1941 =head2 $c->read( [$maxlength] )
1943 Reads a chunk of data from the request body. This method is designed to
1944 be used in a while loop, reading C<$maxlength> bytes on every call.
1945 C<$maxlength> defaults to the size of the request if not specified.
1947 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1950 Warning: If you use read(), Catalyst will not process the body,
1951 so you will not be able to access POST parameters or file uploads via
1952 $c->request. You must handle all body parsing yourself.
1956 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1964 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1966 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1968 Sets an action in a given namespace.
1972 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1974 =head2 $c->setup_actions($component)
1976 Sets up actions for a component.
1980 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1982 =head2 $c->setup_components
1984 Sets up components. Specify a C<setup_components> config option to pass
1985 additional options directly to L<Module::Pluggable>. To add additional
1986 search paths, specify a key named C<search_extra> as an array
1987 reference. Items in the array beginning with C<::> will have the
1988 application class name prepended to them.
1990 All components found will also have any
1991 L<Devel::InnerPackage|inner packages> loaded and set up as components.
1992 Note, that modules which are B<not> an I<inner package> of the main
1993 file namespace loaded will not be instantiated as components.
1997 sub setup_components {
2000 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2001 my $config = $class->config->{ setup_components };
2002 my $extra = delete $config->{ search_extra } || [];
2004 push @paths, @$extra;
2006 my $locator = Module::Pluggable::Object->new(
2007 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2011 my @comps = sort { length $a <=> length $b } $locator->plugins;
2012 my %comps = map { $_ => 1 } @comps;
2014 for my $component ( @comps ) {
2016 # We pass ignore_loaded here so that overlay files for (e.g.)
2017 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2018 # we know M::P::O found a file on disk so this is safe
2020 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2021 #Class::MOP::load_class($component);
2023 my $module = $class->setup_component( $component );
2025 $component => $module,
2027 $_ => $class->setup_component( $_ )
2029 not exists $comps{$_}
2030 } Devel::InnerPackage::list_packages( $component )
2033 for my $key ( keys %modules ) {
2034 $class->components->{ $key } = $modules{ $key };
2039 =head2 $c->setup_component
2043 sub setup_component {
2044 my( $class, $component ) = @_;
2046 unless ( $component->can( 'COMPONENT' ) ) {
2050 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2051 my $config = $class->config->{ $suffix } || {};
2053 my $instance = eval { $component->COMPONENT( $class, $config ); };
2055 if ( my $error = $@ ) {
2057 Catalyst::Exception->throw(
2058 message => qq/Couldn't instantiate component "$component", "$error"/
2062 Catalyst::Exception->throw(
2064 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2065 ) unless blessed($instance);
2070 =head2 $c->setup_dispatcher
2076 sub setup_dispatcher {
2077 my ( $class, $dispatcher ) = @_;
2080 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2083 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2084 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2087 unless ($dispatcher) {
2088 $dispatcher = $class->dispatcher_class;
2091 Class::MOP::load_class($dispatcher);
2093 # dispatcher instance
2094 $class->dispatcher( $dispatcher->new );
2097 =head2 $c->setup_engine
2104 my ( $class, $engine ) = @_;
2107 $engine = 'Catalyst::Engine::' . $engine;
2110 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2111 $engine = 'Catalyst::Engine::' . $env;
2114 if ( $ENV{MOD_PERL} ) {
2115 my $meta = Class::MOP::get_metaclass_by_name($class);
2117 # create the apache method
2118 $meta->add_method('apache' => sub { shift->engine->apache });
2120 my ( $software, $version ) =
2121 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2124 $version =~ s/(\.[^.]+)\./$1/g;
2126 if ( $software eq 'mod_perl' ) {
2130 if ( $version >= 1.99922 ) {
2131 $engine = 'Catalyst::Engine::Apache2::MP20';
2134 elsif ( $version >= 1.9901 ) {
2135 $engine = 'Catalyst::Engine::Apache2::MP19';
2138 elsif ( $version >= 1.24 ) {
2139 $engine = 'Catalyst::Engine::Apache::MP13';
2143 Catalyst::Exception->throw( message =>
2144 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2149 # install the correct mod_perl handler
2150 if ( $version >= 1.9901 ) {
2151 *handler = sub : method {
2152 shift->handle_request(@_);
2156 *handler = sub ($$) { shift->handle_request(@_) };
2161 elsif ( $software eq 'Zeus-Perl' ) {
2162 $engine = 'Catalyst::Engine::Zeus';
2166 Catalyst::Exception->throw(
2167 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2172 $engine = $class->engine_class;
2175 Class::MOP::load_class($engine);
2177 # check for old engines that are no longer compatible
2179 if ( $engine->isa('Catalyst::Engine::Apache')
2180 && !Catalyst::Engine::Apache->VERSION )
2185 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2186 && Catalyst::Engine::Server->VERSION le '0.02' )
2191 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2192 && $engine->VERSION eq '0.01' )
2197 elsif ($engine->isa('Catalyst::Engine::Zeus')
2198 && $engine->VERSION eq '0.01' )
2204 Catalyst::Exception->throw( message =>
2205 qq/Engine "$engine" is not supported by this version of Catalyst/
2210 $class->engine( $engine->new );
2213 =head2 $c->setup_home
2215 Sets up the home directory.
2220 my ( $class, $home ) = @_;
2222 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2226 $home ||= Catalyst::Utils::home($class);
2229 #I remember recently being scolded for assigning config values like this
2230 $class->config->{home} ||= $home;
2231 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2235 =head2 $c->setup_log
2237 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2238 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2241 This method also installs a C<debug> method that returns a true value into the
2242 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2243 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2245 Note that if the log has already been setup, by either a previous call to
2246 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2247 that this method won't actually set up the log object.
2252 my ( $class, $levels ) = @_;
2255 $levels =~ s/^\s+//;
2256 $levels =~ s/\s+$//;
2257 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels || '';
2259 unless ( $class->log ) {
2260 $class->log( Catalyst::Log->new(keys %levels) );
2263 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2264 if ( defined($env_debug) or $levels{debug} ) {
2265 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2266 $class->log->debug('Debug messages enabled');
2270 =head2 $c->setup_plugins
2276 =head2 $c->setup_stats
2278 Sets up timing statistics class.
2283 my ( $class, $stats ) = @_;
2285 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2287 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2288 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2289 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2290 $class->log->debug('Statistics enabled');
2295 =head2 $c->registered_plugins
2297 Returns a sorted list of the plugins which have either been stated in the
2298 import list or which have been added via C<< MyApp->plugin(@args); >>.
2300 If passed a given plugin name, it will report a boolean value indicating
2301 whether or not that plugin is loaded. A fully qualified name is required if
2302 the plugin name does not begin with C<Catalyst::Plugin::>.
2304 if ($c->registered_plugins('Some::Plugin')) {
2312 sub registered_plugins {
2314 return sort keys %{ $proto->_plugins } unless @_;
2316 return 1 if exists $proto->_plugins->{$plugin};
2317 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2320 sub _register_plugin {
2321 my ( $proto, $plugin, $instant ) = @_;
2322 my $class = ref $proto || $proto;
2324 # no ignore_loaded here, the plugin may already have been
2325 # defined in memory and we don't want to error on "no file" if so
2327 Class::MOP::load_class( $plugin );
2329 $proto->_plugins->{$plugin} = 1;
2332 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2333 my @superclasses = ($plugin, $meta->superclasses );
2334 $meta->superclasses(@superclasses);
2336 unshift @{"$class\::ISA"}, $plugin;
2343 my ( $class, $plugins ) = @_;
2345 $class->_plugins( {} ) unless $class->_plugins;
2347 for my $plugin ( reverse @$plugins ) {
2349 unless ( $plugin =~ s/\A\+// ) {
2350 $plugin = "Catalyst::Plugin::$plugin";
2353 $class->_register_plugin($plugin);
2360 Returns an arrayref of the internal execution stack (actions that are
2361 currently executing).
2363 =head2 $c->stats_class
2365 Returns or sets the stats (timing statistics) class.
2367 =head2 $c->use_stats
2369 Returns 1 when stats collection is enabled. Stats collection is enabled
2370 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2371 environment variable is set.
2373 Note that this is a static method, not an accessor and should be overloaded
2374 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2381 =head2 $c->write( $data )
2383 Writes $data to the output stream. When using this method directly, you
2384 will need to manually set the C<Content-Length> header to the length of
2385 your output data, if known.
2392 # Finalize headers if someone manually writes output
2393 $c->finalize_headers;
2395 return $c->engine->write( $c, @_ );
2400 Returns the Catalyst version number. Mostly useful for "powered by"
2401 messages in template systems.
2405 sub version { return $Catalyst::VERSION }
2407 =head1 INTERNAL ACTIONS
2409 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2410 C<_ACTION>, and C<_END>. These are by default not shown in the private
2411 action table, but you can make them visible with a config parameter.
2413 MyApp->config->{show_internal_actions} = 1;
2415 =head1 CASE SENSITIVITY
2417 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2418 mapped to C</foo/bar>. You can activate case sensitivity with a config
2421 MyApp->config->{case_sensitive} = 1;
2423 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2425 =head1 ON-DEMAND PARSER
2427 The request body is usually parsed at the beginning of a request,
2428 but if you want to handle input yourself, you can enable on-demand
2429 parsing with a config parameter.
2431 MyApp->config->{parse_on_demand} = 1;
2433 =head1 PROXY SUPPORT
2435 Many production servers operate using the common double-server approach,
2436 with a lightweight frontend web server passing requests to a larger
2437 backend server. An application running on the backend server must deal
2438 with two problems: the remote user always appears to be C<127.0.0.1> and
2439 the server's hostname will appear to be C<localhost> regardless of the
2440 virtual host that the user connected through.
2442 Catalyst will automatically detect this situation when you are running
2443 the frontend and backend servers on the same machine. The following
2444 changes are made to the request.
2446 $c->req->address is set to the user's real IP address, as read from
2447 the HTTP X-Forwarded-For header.
2449 The host value for $c->req->base and $c->req->uri is set to the real
2450 host, as read from the HTTP X-Forwarded-Host header.
2452 Obviously, your web server must support these headers for this to work.
2454 In a more complex server farm environment where you may have your
2455 frontend proxy server(s) on different machines, you will need to set a
2456 configuration option to tell Catalyst to read the proxied data from the
2459 MyApp->config->{using_frontend_proxy} = 1;
2461 If you do not wish to use the proxy support at all, you may set:
2463 MyApp->config->{ignore_frontend_proxy} = 1;
2465 =head1 THREAD SAFETY
2467 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2468 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2469 believe the Catalyst core to be thread-safe.
2471 If you plan to operate in a threaded environment, remember that all other
2472 modules you are using must also be thread-safe. Some modules, most notably
2473 L<DBD::SQLite>, are not thread-safe.
2479 Join #catalyst on irc.perl.org.
2483 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2484 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2488 http://catalyst.perl.org
2492 http://dev.catalyst.perl.org
2496 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2498 =head2 L<Catalyst::Manual> - The Catalyst Manual
2500 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2502 =head2 L<Catalyst::Engine> - Core engine
2504 =head2 L<Catalyst::Log> - Log class.
2506 =head2 L<Catalyst::Request> - Request object
2508 =head2 L<Catalyst::Response> - Response object
2510 =head2 L<Catalyst::Test> - The test suite.
2512 =head1 PROJECT FOUNDER
2514 sri: Sebastian Riedel <sri@cpan.org>
2520 acme: Leon Brocard <leon@astray.com>
2528 andyg: Andy Grundman <andy@hybridized.org>
2530 audreyt: Audrey Tang
2532 bricas: Brian Cassidy <bricas@cpan.org>
2534 Caelum: Rafael Kitover <rkitover@io.com>
2536 chansen: Christian Hansen
2538 chicks: Christopher Hicks
2542 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2546 esskar: Sascha Kiefer
2548 fireartist: Carl Franks <cfranks@cpan.org>
2550 gabb: Danijel Milicevic
2556 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2558 jcamacho: Juan Camacho
2560 jhannah: Jay Hannah <jay@jays.net>
2566 jon: Jon Schutz <jjschutz@cpan.org>
2568 marcus: Marcus Ramberg <mramberg@cpan.org>
2570 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2572 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2576 naughton: David Naughton
2578 ningu: David Kamholz <dkamholz@cpan.org>
2580 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2582 numa: Dan Sully <daniel@cpan.org>
2586 omega: Andreas Marienborg
2588 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2590 rafl: Florian Ragwitz <rafl@debian.org>
2594 the_jester: Jesse Sheidlower
2596 t0m: Tomas Doran <bobtfish@bobtfish.net>
2600 willert: Sebastian Willert <willert@cpan.org>
2604 This library is free software, you can redistribute it and/or modify it under
2605 the same terms as Perl itself.
2611 __PACKAGE__->meta->make_immutable;