4 use base 'Catalyst::Component';
6 use Catalyst::Exception;
9 use Catalyst::Request::Upload;
10 use Catalyst::Response;
12 use Catalyst::Controller;
13 use Devel::InnerPackage ();
15 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/;
22 use Scalar::Util qw/weaken blessed/;
23 use Tree::Simple qw/use_weak_refs/;
24 use Tree::Simple::Visitor::FindByUID;
29 BEGIN { require 5.008001; }
31 __PACKAGE__->mk_accessors(
32 qw/counter request response state action stack namespace stats/
35 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
37 sub depth { scalar @{ shift->stack || [] }; }
44 # For backwards compatibility
45 *finalize_output = \&finalize_body;
50 our $RECURSION = 1000;
51 our $DETACH = "catalyst_detach\n";
53 __PACKAGE__->mk_classdata($_)
54 for qw/components arguments dispatcher engine log dispatcher_class
55 engine_class context_class request_class response_class setup_finished/;
57 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
58 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
59 __PACKAGE__->request_class('Catalyst::Request');
60 __PACKAGE__->response_class('Catalyst::Response');
62 # Remember to update this in Catalyst::Runtime as well!
64 our $VERSION = '5.7003';
67 my ( $class, @arguments ) = @_;
69 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
71 return unless $class eq 'Catalyst';
73 my $caller = caller(0);
75 unless ( $caller->isa('Catalyst') ) {
77 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
80 $caller->arguments( [@arguments] );
86 Catalyst - The Elegant MVC Web Application Framework
90 # Install Catalyst::Devel for helpers and other development tools
91 # use the helper to create a new application
94 # add models, views, controllers
95 script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
96 script/myapp_create.pl view TT TT
97 script/myapp_create.pl controller Search
99 # built in testserver -- use -r to restart automatically on changes
100 script/myapp_server.pl
102 # command line testing interface
103 script/myapp_test.pl /yada
106 use Catalyst qw/-Debug/; # include plugins here as well
108 ### In lib/MyApp/Controller/Root.pm (autocreated)
109 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
110 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
111 $c->stash->{template} = 'foo.tt'; # set the template
112 # lookup something from db -- stash vars are passed to TT
114 $c->model('Database::Foo')->search( { country => $args[0] } );
115 if ( $c->req->params->{bar} ) { # access GET or POST parameters
116 $c->forward( 'bar' ); # process another action
117 # do something else after forward returns
121 # The foo.tt TT template can use the stash data from the database
122 [% WHILE (item = data.next) %]
126 # called for /bar/of/soap, /bar/of/soap/10, etc.
127 sub bar : Path('/bar/of/soap') { ... }
129 # called for all actions, from the top-most controller downwards
131 my ( $self, $c ) = @_;
132 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
133 $c->res->redirect( '/login' ); # require login
134 return 0; # abort request and go immediately to end()
136 return 1; # success; carry on to next action
139 # called after all actions are finished
141 my ( $self, $c ) = @_;
142 if ( scalar @{ $c->error } ) { ... } # handle errors
143 return if $c->res->body; # already have a response
144 $c->forward( 'MyApp::View::TT' ); # render template
147 ### in MyApp/Controller/Foo.pm
148 # called for /foo/bar
149 sub bar : Local { ... }
151 # called for /blargle
152 sub blargle : Global { ... }
154 # an index action matches /foo, but not /foo/1, etc.
155 sub index : Private { ... }
157 ### in MyApp/Controller/Foo/Bar.pm
158 # called for /foo/bar/baz
159 sub baz : Local { ... }
161 # first Root auto is called, then Foo auto, then this
162 sub auto : Private { ... }
164 # powerful regular expression paths are also possible
165 sub details : Regex('^product/(\w+)/details$') {
166 my ( $self, $c ) = @_;
167 # extract the (\w+) from the URI
168 my $product = $c->req->captures->[0];
171 See L<Catalyst::Manual::Intro> for additional information.
175 Catalyst is a modern framework for making web applications without the
176 pain usually associated with this process. This document is a reference
177 to the main Catalyst application. If you are a new user, we suggest you
178 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
180 See L<Catalyst::Manual> for more documentation.
182 Catalyst plugins can be loaded by naming them as arguments to the "use
183 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
184 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
187 use Catalyst qw/My::Module/;
189 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
190 fully qualify the name by using a unary plus:
194 +Fully::Qualified::Plugin::Name
197 Special flags like C<-Debug> and C<-Engine> can also be specified as
198 arguments when Catalyst is loaded:
200 use Catalyst qw/-Debug My::Module/;
202 The position of plugins and flags in the chain is important, because
203 they are loaded in the order in which they appear.
205 The following flags are supported:
209 Enables debug output. You can also force this setting from the system
210 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
211 settings override the application, with <MYAPP>_DEBUG having the highest
216 Forces Catalyst to use a specific engine. Omit the
217 C<Catalyst::Engine::> prefix of the engine name, i.e.:
219 use Catalyst qw/-Engine=CGI/;
223 Forces Catalyst to use a specific home directory, e.g.:
225 use Catalyst qw[-Home=/usr/mst];
233 =head2 INFORMATION ABOUT THE CURRENT REQUEST
237 Returns a L<Catalyst::Action> object for the current action, which
238 stringifies to the action name. See L<Catalyst::Action>.
242 Returns the namespace of the current action, i.e., the URI prefix
243 corresponding to the controller of the current action. For example:
245 # in Controller::Foo::Bar
246 $c->namespace; # returns 'foo/bar';
252 Returns the current L<Catalyst::Request> object, giving access to
253 information about the current client request (including parameters,
254 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
256 =head2 REQUEST FLOW HANDLING
258 =head2 $c->forward( $action [, \@arguments ] )
260 =head2 $c->forward( $class, $method, [, \@arguments ] )
262 Forwards processing to another action, by its private name. If you give a
263 class name but no method, C<process()> is called. You may also optionally
264 pass arguments in an arrayref. The action will receive the arguments in
265 C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
266 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
268 Any data C<return>ed from the action forwarded to, will be returned by the
271 my $foodata = $c->forward('/foo');
272 $c->forward('index');
273 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
274 $c->forward('MyApp::View::TT');
276 Note that forward implies an C<<eval { }>> around the call (actually
277 C<execute> does), thus de-fatalizing all 'dies' within the called
278 action. If you want C<die> to propagate you need to do something like:
281 die $c->error if $c->error;
283 Or make sure to always return true values from your actions and write
286 $c->forward('foo') || return;
290 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
292 =head2 $c->detach( $action [, \@arguments ] )
294 =head2 $c->detach( $class, $method, [, \@arguments ] )
298 The same as C<forward>, but doesn't return to the previous action when
299 processing is finished.
301 When called with no arguments it escapes the processing chain entirely.
305 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
311 Returns the current L<Catalyst::Response> object, q.v.
315 Returns a hashref to the stash, which may be used to store data and pass
316 it between components during a request. You can also set hash keys by
317 passing arguments. The stash is automatically sent to the view. The
318 stash is cleared at the end of a request; it cannot be used for
319 persistent storage (for this you must use a session; see
320 L<Catalyst::Plugin::Session> for a complete system integrated with
323 $c->stash->{foo} = $bar;
324 $c->stash( { moose => 'majestic', qux => 0 } );
325 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
327 # stash is automatically passed to the view for use in a template
328 $c->forward( 'MyApp::V::TT' );
335 my $stash = @_ > 1 ? {@_} : $_[0];
336 croak('stash takes a hash or hashref') unless ref $stash;
337 foreach my $key ( keys %$stash ) {
338 $c->{stash}->{$key} = $stash->{$key};
346 =head2 $c->error($error, ...)
348 =head2 $c->error($arrayref)
350 Returns an arrayref containing error messages. If Catalyst encounters an
351 error while processing a request, it stores the error in $c->error. This
352 method should not be used to store non-fatal error messages.
354 my @error = @{ $c->error };
358 $c->error('Something bad happened');
365 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
366 croak @$error unless ref $c;
367 push @{ $c->{error} }, @$error;
369 elsif ( defined $_[0] ) { $c->{error} = undef }
370 return $c->{error} || [];
376 Contains the return value of the last executed action.
378 =head2 $c->clear_errors
380 Clear errors. You probably don't want to clear the errors unless you are
381 implementing a custom error screen.
383 This is equivalent to running
397 my ( $c, @names ) = @_;
399 foreach my $name (@names) {
400 foreach my $component ( keys %{ $c->components } ) {
401 return $c->components->{$component} if $component =~ /$name/i;
408 # try explicit component names
410 my ( $c, @names ) = @_;
412 foreach my $try (@names) {
413 return $c->components->{$try} if ( exists $c->components->{$try} );
419 # like component, but try just these prefixes before regex searching,
420 # and do not try to return "sort keys %{ $c->components }"
422 my ( $c, $name, @prefixes ) = @_;
424 my $appclass = ref $c || $c;
426 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
428 my $comp = $c->_comp_explicit(@names);
429 return $comp if defined($comp);
430 $comp = $c->_comp_search($name);
434 # Find possible names for a prefix
437 my ( $c, @prefixes ) = @_;
439 my $appclass = ref $c || $c;
441 my @pre = map { "${appclass}::${_}::" } @prefixes;
445 COMPONENT: foreach my $comp ($c->component) {
446 foreach my $p (@pre) {
447 if ($comp =~ s/^$p//) {
457 # Return a component if only one matches.
459 my ( $c, @prefixes ) = @_;
461 my $appclass = ref $c || $c;
463 my ( $comp, $rest ) =
464 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
465 return $comp unless $rest;
468 # Filter a component before returning by calling ACCEPT_CONTEXT if available
469 sub _filter_component {
470 my ( $c, $comp, @args ) = @_;
471 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
472 return $comp->ACCEPT_CONTEXT( $c, @args );
474 else { return $comp }
477 =head2 COMPONENT ACCESSORS
479 =head2 $c->controller($name)
481 Gets a L<Catalyst::Controller> instance by name.
483 $c->controller('Foo')->do_stuff;
485 If the name is omitted, will return the controller for the dispatched
491 my ( $c, $name, @args ) = @_;
492 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
495 return $c->component( $c->action->class );
498 =head2 $c->model($name)
500 Gets a L<Catalyst::Model> instance by name.
502 $c->model('Foo')->do_stuff;
504 If the name is omitted, it will look for
505 - a model object in $c->stash{current_model_instance}, then
506 - a model name in $c->stash->{current_model}, then
507 - a config setting 'default_model', or
508 - check if there is only one model, and return it if that's the case.
513 my ( $c, $name, @args ) = @_;
514 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
518 return $c->stash->{current_model_instance}
519 if $c->stash->{current_model_instance};
520 return $c->model( $c->stash->{current_model} )
521 if $c->stash->{current_model};
522 return $c->model( $c->config->{default_model} )
523 if $c->config->{default_model};
525 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
529 =head2 $c->controllers
531 Returns the available names which can be passed to $c->controller
537 return $c->_comp_names(qw/Controller C/);
541 =head2 $c->view($name)
543 Gets a L<Catalyst::View> instance by name.
545 $c->view('Foo')->do_stuff;
547 If the name is omitted, it will look for
548 - a view object in $c->stash{current_view_instance}, then
549 - a view name in $c->stash->{current_view}, then
550 - a config setting 'default_view', or
551 - check if there is only one view, and return it if that's the case.
556 my ( $c, $name, @args ) = @_;
557 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
561 return $c->stash->{current_view_instance}
562 if $c->stash->{current_view_instance};
563 return $c->view( $c->stash->{current_view} )
564 if $c->stash->{current_view};
565 return $c->view( $c->config->{default_view} )
566 if $c->config->{default_view};
568 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
573 Returns the available names which can be passed to $c->model
579 return $c->_comp_names(qw/Model M/);
585 Returns the available names which can be passed to $c->view
591 return $c->_comp_names(qw/View V/);
594 =head2 $c->comp($name)
596 =head2 $c->component($name)
598 Gets a component object by name. This method is no longer recommended,
599 unless you want to get a specific component by full
600 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
601 should be used instead.
612 my $appclass = ref $c || $c;
615 $name, "${appclass}::${name}",
616 map { "${appclass}::${_}::${name}" }
617 qw/Model M Controller C View V/
620 my $comp = $c->_comp_explicit(@names);
621 return $c->_filter_component( $comp, @_ ) if defined($comp);
623 $comp = $c->_comp_search($name);
624 return $c->_filter_component( $comp, @_ ) if defined($comp);
627 return sort keys %{ $c->components };
632 =head2 CLASS DATA AND HELPER CLASSES
636 Returns or takes a hashref containing the application's configuration.
638 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
640 You can also use a L<YAML> config file like myapp.yml in your
641 applications home directory.
644 db: dsn:SQLite:foo.db
652 $c->log->warn("Setting config after setup has been run is not a good idea.")
653 if ( @_ and $c->setup_finished );
655 $c->NEXT::config(@_);
660 Returns the logging object instance. Unless it is already set, Catalyst
661 sets this up with a L<Catalyst::Log> object. To use your own log class,
662 set the logger with the C<< __PACKAGE__->log >> method prior to calling
663 C<< __PACKAGE__->setup >>.
665 __PACKAGE__->log( MyLogger->new );
670 $c->log->info( 'Now logging with my own logger!' );
672 Your log class should implement the methods described in
678 Overload to enable debug messages (same as -Debug option).
680 Note that this is a static method, not an accessor and should be overloaded
681 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
687 =head2 $c->dispatcher
689 Returns the dispatcher instance. Stringifies to class name. See
690 L<Catalyst::Dispatcher>.
694 Returns the engine instance. Stringifies to the class name. See
698 =head2 UTILITY METHODS
700 =head2 $c->path_to(@path)
702 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
703 L<Path::Class> object.
707 $c->path_to( 'db', 'sqlite.db' );
712 my ( $c, @path ) = @_;
713 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
714 if ( -d $path ) { return $path }
715 else { return Path::Class::File->new( $c->config->{home}, @path ) }
718 =head2 $c->plugin( $name, $class, @args )
720 Helper method for plugins. It creates a classdata accessor/mutator and
721 loads and instantiates the given class.
723 MyApp->plugin( 'prototype', 'HTML::Prototype' );
725 $c->prototype->define_javascript_functions;
730 my ( $class, $name, $plugin, @args ) = @_;
731 $class->_register_plugin( $plugin, 1 );
733 eval { $plugin->import };
734 $class->mk_classdata($name);
736 eval { $obj = $plugin->new(@args) };
739 Catalyst::Exception->throw( message =>
740 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
744 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
750 Initializes the dispatcher and engine, loads any plugins, and loads the
751 model, view, and controller components. You may also specify an array
752 of plugins to load here, if you choose to not load them in the C<use
756 MyApp->setup( qw/-Debug/ );
761 my ( $class, @arguments ) = @_;
763 $class->log->warn("Running setup twice is not a good idea.")
764 if ( $class->setup_finished );
766 unless ( $class->isa('Catalyst') ) {
768 Catalyst::Exception->throw(
769 message => qq/'$class' does not inherit from Catalyst/ );
772 if ( $class->arguments ) {
773 @arguments = ( @arguments, @{ $class->arguments } );
779 foreach (@arguments) {
783 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
785 elsif (/^-(\w+)=?(.*)$/) {
786 $flags->{ lc $1 } = $2;
789 push @{ $flags->{plugins} }, $_;
793 $class->setup_home( delete $flags->{home} );
795 $class->setup_log( delete $flags->{log} );
796 $class->setup_plugins( delete $flags->{plugins} );
797 $class->setup_dispatcher( delete $flags->{dispatcher} );
798 $class->setup_engine( delete $flags->{engine} );
800 for my $flag ( sort keys %{$flags} ) {
802 if ( my $code = $class->can( 'setup_' . $flag ) ) {
803 &$code( $class, delete $flags->{$flag} );
806 $class->log->warn(qq/Unknown flag "$flag"/);
810 eval { require Catalyst::Devel; };
811 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
812 $class->log->warn(<<"EOF");
813 You are running an old script!
815 Please update by running (this will overwrite existing files):
816 catalyst.pl -force -scripts $class
818 or (this will not overwrite existing files):
819 catalyst.pl -scripts $class
824 if ( $class->debug ) {
825 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
828 my $t = Text::SimpleTable->new(74);
829 $t->row($_) for @plugins;
830 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
833 my $dispatcher = $class->dispatcher;
834 my $engine = $class->engine;
835 my $home = $class->config->{home};
837 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
838 $class->log->debug(qq/Loaded engine "$engine"/);
842 ? $class->log->debug(qq/Found home "$home"/)
843 : $class->log->debug(qq/Home "$home" doesn't exist/)
844 : $class->log->debug(q/Couldn't find home/);
849 no warnings qw/redefine/;
850 local *setup = sub { };
854 # Initialize our data structure
855 $class->components( {} );
857 $class->setup_components;
859 if ( $class->debug ) {
860 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
861 for my $comp ( sort keys %{ $class->components } ) {
862 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
863 $t->row( $comp, $type );
865 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
866 if ( keys %{ $class->components } );
869 # Add our self to components, since we are also a component
870 $class->components->{$class} = $class;
872 $class->setup_actions;
874 if ( $class->debug ) {
875 my $name = $class->config->{name} || 'Application';
876 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
878 $class->log->_flush() if $class->log->can('_flush');
880 $class->setup_finished(1);
883 =head2 $c->uri_for( $path, @args?, \%query_values? )
885 Merges path with C<< $c->request->base >> for absolute URIs and with
886 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
887 object. If any args are passed, they are added at the end of the path.
888 If the last argument to C<uri_for> is a hash reference, it is assumed to
889 contain GET parameter key/value pairs, which will be appended to the URI
892 Instead of C<$path>, you can also optionally pass a C<$action> object
893 which will be resolved to a path using
894 C<< $c->dispatcher->uri_for_action >>; if the first element of
895 C<@args> is an arrayref it is treated as a list of captures to be passed
896 to C<uri_for_action>.
901 my ( $c, $path, @args ) = @_;
902 my $base = $c->request->base->clone;
903 my $basepath = $base->path;
904 $basepath =~ s/\/$//;
906 my $namespace = $c->namespace || '';
908 if ( Scalar::Util::blessed($path) ) { # action object
909 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
912 $path = $c->dispatcher->uri_for_action($path, $captures);
913 return undef unless defined($path);
914 $path = '/' if $path eq '';
917 # massage namespace, empty if absolute path
918 $namespace =~ s/^\/// if $namespace;
919 $namespace .= '/' if $namespace;
921 $namespace = '' if $path =~ /^\//;
925 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
927 for my $value ( values %$params ) {
928 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
934 # join args with '/', or a blank string
935 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
936 $args =~ s/^\/// unless $path;
938 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
940 $res->query_form(%$params);
944 =head2 $c->welcome_message
946 Returns the Catalyst welcome HTML page.
950 sub welcome_message {
952 my $name = $c->config->{name};
953 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
954 my $prefix = Catalyst::Utils::appprefix( ref $c );
955 $c->response->content_type('text/html; charset=utf-8');
957 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
958 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
959 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
961 <meta http-equiv="Content-Language" content="en" />
962 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
963 <title>$name on Catalyst $VERSION</title>
964 <style type="text/css">
967 background-color: #eee;
976 background-color: #ccc;
977 border: 1px solid #aaa;
982 font-family: verdana, tahoma, sans-serif;
985 font-family: verdana, tahoma, sans-serif;
988 text-decoration: none;
990 border-bottom: 1px dotted #bbb;
992 :link:hover, :visited:hover {
1005 background-color: #fff;
1006 border: 1px solid #aaa;
1010 font-weight: normal;
1032 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1037 <img src="$logo" alt="Catalyst Logo" />
1039 <p>Welcome to the wonderful world of Catalyst.
1040 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1041 framework will make web development something you had
1042 never expected it to be: Fun, rewarding, and quick.</p>
1043 <h2>What to do now?</h2>
1044 <p>That really depends on what <b>you</b> want to do.
1045 We do, however, provide you with a few starting points.</p>
1046 <p>If you want to jump right into web development with Catalyst
1047 you might want to check out the documentation.</p>
1048 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1049 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1050 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1051 <h2>What to do next?</h2>
1052 <p>Next it's time to write an actual application. Use the
1053 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1054 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1055 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1056 they can save you a lot of work.</p>
1057 <pre><code>script/${prefix}_create.pl -help</code></pre>
1058 <p>Also, be sure to check out the vast and growing
1059 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1060 you are likely to find what you need there.
1064 <p>Catalyst has a very active community. Here are the main places to
1065 get in touch with us.</p>
1068 <a href="http://dev.catalyst.perl.org">Wiki</a>
1071 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1074 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1077 <h2>In conclusion</h2>
1078 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1079 as we enjoyed making it. Please contact us if you have ideas
1080 for improvement or other feedback.</p>
1088 =head1 INTERNAL METHODS
1090 These methods are not meant to be used by end users.
1092 =head2 $c->components
1094 Returns a hash of components.
1096 =head2 $c->context_class
1098 Returns or sets the context class.
1102 Returns a hashref containing coderefs and execution counts (needed for
1103 deep recursion detection).
1107 Returns the number of actions on the current internal execution stack.
1111 Dispatches a request to actions.
1115 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1117 =head2 $c->dispatcher_class
1119 Returns or sets the dispatcher class.
1121 =head2 $c->dump_these
1123 Returns a list of 2-element array references (name, structure) pairs
1124 that will be dumped on the error page in debug mode.
1130 [ Request => $c->req ],
1131 [ Response => $c->res ],
1132 [ Stash => $c->stash ],
1133 [ Config => $c->config ];
1136 =head2 $c->engine_class
1138 Returns or sets the engine class.
1140 =head2 $c->execute( $class, $coderef )
1142 Execute a coderef in given class and catch exceptions. Errors are available
1148 my ( $c, $class, $code ) = @_;
1149 $class = $c->component($class) || $class;
1152 if ( $c->depth >= $RECURSION ) {
1153 my $action = "$code";
1154 $action = "/$action" unless $action =~ /->/;
1155 my $error = qq/Deep recursion detected calling "$action"/;
1156 $c->log->error($error);
1162 my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
1164 push( @{ $c->stack }, $code );
1166 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1168 $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
1170 my $last = pop( @{ $c->stack } );
1172 if ( my $error = $@ ) {
1173 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1175 unless ( ref $error ) {
1176 no warnings 'uninitialized';
1178 my $class = $last->class;
1179 my $name = $last->name;
1180 $error = qq/Caught exception in $class->$name "$error"/;
1189 sub _stats_start_execute {
1190 my ( $c, $code ) = @_;
1192 return if ( ( $code->name =~ /^_.*/ )
1193 && ( !$c->config->{show_internal_actions} ) );
1195 $c->counter->{"$code"}++;
1197 my $action = "$code";
1198 $action = "/$action" unless $action =~ /->/;
1200 # determine if the call was the result of a forward
1201 # this is done by walking up the call stack and looking for a calling
1202 # sub of Catalyst::forward before the eval
1204 for my $index ( 2 .. 11 ) {
1206 if ( ( caller($index) )[0] eq 'Catalyst'
1207 && ( caller($index) )[3] eq '(eval)' );
1209 if ( ( caller($index) )[3] =~ /forward$/ ) {
1210 $callsub = ( caller($index) )[3];
1211 $action = "-> $action";
1216 my $node = Tree::Simple->new(
1219 elapsed => undef, # to be filled in later
1223 $node->setUID( "$code" . $c->counter->{"$code"} );
1225 # is this a root-level call or a forwarded call?
1226 if ( $callsub =~ /forward$/ ) {
1228 # forward, locate the caller
1229 if ( my $parent = $c->stack->[-1] ) {
1230 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1231 $visitor->searchForUID(
1232 "$parent" . $c->counter->{"$parent"} );
1233 $c->stats->accept($visitor);
1234 if ( my $result = $visitor->getResult ) {
1235 $result->addChild($node);
1240 # forward with no caller may come from a plugin
1241 $c->stats->addChild($node);
1247 $c->stats->addChild($node);
1251 start => [gettimeofday],
1256 sub _stats_finish_execute {
1257 my ( $c, $info ) = @_;
1258 my $elapsed = tv_interval $info->{start};
1259 my $value = $info->{node}->getNodeValue;
1260 $value->{elapsed} = sprintf( '%fs', $elapsed );
1263 =head2 $c->_localize_fields( sub { }, \%keys );
1267 sub _localize_fields {
1268 my ( $c, $localized, $code ) = ( @_ );
1270 my $request = delete $localized->{request} || {};
1271 my $response = delete $localized->{response} || {};
1273 local @{ $c }{ keys %$localized } = values %$localized;
1274 local @{ $c->request }{ keys %$request } = values %$request;
1275 local @{ $c->response }{ keys %$response } = values %$response;
1282 Finalizes the request.
1289 for my $error ( @{ $c->error } ) {
1290 $c->log->error($error);
1293 # Allow engine to handle finalize flow (for POE)
1294 if ( $c->engine->can('finalize') ) {
1295 $c->engine->finalize($c);
1299 $c->finalize_uploads;
1302 if ( $#{ $c->error } >= 0 ) {
1306 $c->finalize_headers;
1309 if ( $c->request->method eq 'HEAD' ) {
1310 $c->response->body('');
1317 my $elapsed = sprintf '%f', tv_interval($c->stats->getNodeValue);
1318 my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1320 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1321 $c->stats->traverse(
1324 my $stat = $action->getNodeValue;
1325 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1326 $stat->{elapsed} || '??' );
1331 "Request took ${elapsed}s ($av/s)\n" . $t->draw . "\n" );
1334 return $c->response->status;
1337 =head2 $c->finalize_body
1343 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1345 =head2 $c->finalize_cookies
1351 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1353 =head2 $c->finalize_error
1359 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1361 =head2 $c->finalize_headers
1367 sub finalize_headers {
1370 # Check if we already finalized headers
1371 return if $c->response->{_finalized_headers};
1374 if ( my $location = $c->response->redirect ) {
1375 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1376 $c->response->header( Location => $location );
1380 if ( $c->response->body && !$c->response->content_length ) {
1382 # get the length from a filehandle
1383 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1385 if ( my $stat = stat $c->response->body ) {
1386 $c->response->content_length( $stat->size );
1389 $c->log->warn('Serving filehandle without a content-length');
1393 $c->response->content_length( bytes::length( $c->response->body ) );
1398 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1399 $c->response->headers->remove_header("Content-Length");
1400 $c->response->body('');
1403 $c->finalize_cookies;
1405 $c->engine->finalize_headers( $c, @_ );
1408 $c->response->{_finalized_headers} = 1;
1411 =head2 $c->finalize_output
1413 An alias for finalize_body.
1415 =head2 $c->finalize_read
1417 Finalizes the input after reading is complete.
1421 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1423 =head2 $c->finalize_uploads
1425 Finalizes uploads. Cleans up any temporary files.
1429 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1431 =head2 $c->get_action( $action, $namespace )
1433 Gets an action in a given namespace.
1437 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1439 =head2 $c->get_actions( $action, $namespace )
1441 Gets all actions of a given name in a namespace and all parent
1446 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1448 =head2 $c->handle_request( $class, @arguments )
1450 Called to handle each HTTP request.
1454 sub handle_request {
1455 my ( $class, @arguments ) = @_;
1457 # Always expect worst case!
1460 if ($class->debug) {
1461 my $secs = time - $START || 1;
1462 my $av = sprintf '%.3f', $COUNT / $secs;
1463 my $time = localtime time;
1464 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1467 my $c = $class->prepare(@arguments);
1469 $status = $c->finalize;
1472 if ( my $error = $@ ) {
1474 $class->log->error(qq/Caught exception in engine "$error"/);
1478 $class->log->_flush() if $class->log->can('_flush');
1482 =head2 $c->prepare( @arguments )
1484 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1490 my ( $class, @arguments ) = @_;
1492 $class->context_class( ref $class || $class ) unless $class->context_class;
1493 my $c = $class->context_class->new(
1497 request => $class->request_class->new(
1500 body_parameters => {},
1502 headers => HTTP::Headers->new,
1504 query_parameters => {},
1510 response => $class->response_class->new(
1514 headers => HTTP::Headers->new(),
1524 $c->stats(Tree::Simple->new([gettimeofday]));
1525 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1528 # For on-demand data
1529 $c->request->{_context} = $c;
1530 $c->response->{_context} = $c;
1531 weaken( $c->request->{_context} );
1532 weaken( $c->response->{_context} );
1534 # Allow engine to direct the prepare flow (for POE)
1535 if ( $c->engine->can('prepare') ) {
1536 $c->engine->prepare( $c, @arguments );
1539 $c->prepare_request(@arguments);
1540 $c->prepare_connection;
1541 $c->prepare_query_parameters;
1542 $c->prepare_headers;
1543 $c->prepare_cookies;
1547 $c->prepare_body unless $c->config->{parse_on_demand};
1550 my $method = $c->req->method || '';
1551 my $path = $c->req->path || '/';
1552 my $address = $c->req->address || '';
1554 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1562 =head2 $c->prepare_action
1564 Prepares action. See L<Catalyst::Dispatcher>.
1568 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1570 =head2 $c->prepare_body
1572 Prepares message body.
1579 # Do we run for the first time?
1580 return if defined $c->request->{_body};
1582 # Initialize on-demand data
1583 $c->engine->prepare_body( $c, @_ );
1584 $c->prepare_parameters;
1585 $c->prepare_uploads;
1587 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1588 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1589 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1590 my $param = $c->req->body_parameters->{$key};
1591 my $value = defined($param) ? $param : '';
1593 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1595 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1599 =head2 $c->prepare_body_chunk( $chunk )
1601 Prepares a chunk of data before sending it to L<HTTP::Body>.
1603 See L<Catalyst::Engine>.
1607 sub prepare_body_chunk {
1609 $c->engine->prepare_body_chunk( $c, @_ );
1612 =head2 $c->prepare_body_parameters
1614 Prepares body parameters.
1618 sub prepare_body_parameters {
1620 $c->engine->prepare_body_parameters( $c, @_ );
1623 =head2 $c->prepare_connection
1625 Prepares connection.
1629 sub prepare_connection {
1631 $c->engine->prepare_connection( $c, @_ );
1634 =head2 $c->prepare_cookies
1640 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1642 =head2 $c->prepare_headers
1648 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1650 =head2 $c->prepare_parameters
1652 Prepares parameters.
1656 sub prepare_parameters {
1658 $c->prepare_body_parameters;
1659 $c->engine->prepare_parameters( $c, @_ );
1662 =head2 $c->prepare_path
1664 Prepares path and base.
1668 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1670 =head2 $c->prepare_query_parameters
1672 Prepares query parameters.
1676 sub prepare_query_parameters {
1679 $c->engine->prepare_query_parameters( $c, @_ );
1681 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1682 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1683 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1684 my $param = $c->req->query_parameters->{$key};
1685 my $value = defined($param) ? $param : '';
1687 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1689 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1693 =head2 $c->prepare_read
1695 Prepares the input for reading.
1699 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1701 =head2 $c->prepare_request
1703 Prepares the engine request.
1707 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1709 =head2 $c->prepare_uploads
1715 sub prepare_uploads {
1718 $c->engine->prepare_uploads( $c, @_ );
1720 if ( $c->debug && keys %{ $c->request->uploads } ) {
1721 my $t = Text::SimpleTable->new(
1722 [ 12, 'Parameter' ],
1727 for my $key ( sort keys %{ $c->request->uploads } ) {
1728 my $upload = $c->request->uploads->{$key};
1729 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1730 $t->row( $key, $u->filename, $u->type, $u->size );
1733 $c->log->debug( "File Uploads are:\n" . $t->draw );
1737 =head2 $c->prepare_write
1739 Prepares the output for writing.
1743 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1745 =head2 $c->request_class
1747 Returns or sets the request class.
1749 =head2 $c->response_class
1751 Returns or sets the response class.
1753 =head2 $c->read( [$maxlength] )
1755 Reads a chunk of data from the request body. This method is designed to
1756 be used in a while loop, reading C<$maxlength> bytes on every call.
1757 C<$maxlength> defaults to the size of the request if not specified.
1759 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1764 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1772 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1774 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1776 Sets an action in a given namespace.
1780 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1782 =head2 $c->setup_actions($component)
1784 Sets up actions for a component.
1788 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1790 =head2 $c->setup_components
1792 Sets up components. Specify a C<setup_components> config option to pass
1793 additional options directly to L<Module::Pluggable>. To add additional
1794 search paths, specify a key named C<search_extra> as an array
1795 reference. Items in the array beginning with C<::> will have the
1796 application class name prepended to them.
1800 sub setup_components {
1803 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1804 my $config = $class->config->{ setup_components };
1805 my $extra = delete $config->{ search_extra } || [];
1807 push @paths, @$extra;
1809 my $locator = Module::Pluggable::Object->new(
1810 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1814 for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
1815 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1817 my $module = $class->setup_component( $component );
1819 $component => $module,
1821 $_ => $class->setup_component( $_ )
1822 } Devel::InnerPackage::list_packages( $component )
1825 for my $key ( keys %modules ) {
1826 $class->components->{ $key } = $modules{ $key };
1831 =head2 $c->setup_component
1835 sub setup_component {
1836 my( $class, $component ) = @_;
1838 unless ( $component->can( 'COMPONENT' ) ) {
1842 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1843 my $config = $class->config->{ $suffix } || {};
1845 my $instance = eval { $component->COMPONENT( $class, $config ); };
1847 if ( my $error = $@ ) {
1849 Catalyst::Exception->throw(
1850 message => qq/Couldn't instantiate component "$component", "$error"/
1854 Catalyst::Exception->throw(
1856 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1857 ) unless eval { $instance->can( 'can' ) };
1862 =head2 $c->setup_dispatcher
1868 sub setup_dispatcher {
1869 my ( $class, $dispatcher ) = @_;
1872 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1875 if ( $ENV{CATALYST_DISPATCHER} ) {
1876 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1879 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1881 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1884 unless ($dispatcher) {
1885 $dispatcher = $class->dispatcher_class;
1888 unless (Class::Inspector->loaded($dispatcher)) {
1889 require Class::Inspector->filename($dispatcher);
1892 # dispatcher instance
1893 $class->dispatcher( $dispatcher->new );
1896 =head2 $c->setup_engine
1903 my ( $class, $engine ) = @_;
1906 $engine = 'Catalyst::Engine::' . $engine;
1909 if ( $ENV{CATALYST_ENGINE} ) {
1910 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1913 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1914 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1917 if ( $ENV{MOD_PERL} ) {
1919 # create the apache method
1922 *{"$class\::apache"} = sub { shift->engine->apache };
1925 my ( $software, $version ) =
1926 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1929 $version =~ s/(\.[^.]+)\./$1/g;
1931 if ( $software eq 'mod_perl' ) {
1935 if ( $version >= 1.99922 ) {
1936 $engine = 'Catalyst::Engine::Apache2::MP20';
1939 elsif ( $version >= 1.9901 ) {
1940 $engine = 'Catalyst::Engine::Apache2::MP19';
1943 elsif ( $version >= 1.24 ) {
1944 $engine = 'Catalyst::Engine::Apache::MP13';
1948 Catalyst::Exception->throw( message =>
1949 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1954 # install the correct mod_perl handler
1955 if ( $version >= 1.9901 ) {
1956 *handler = sub : method {
1957 shift->handle_request(@_);
1961 *handler = sub ($$) { shift->handle_request(@_) };
1966 elsif ( $software eq 'Zeus-Perl' ) {
1967 $engine = 'Catalyst::Engine::Zeus';
1971 Catalyst::Exception->throw(
1972 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1977 $engine = $class->engine_class;
1980 unless (Class::Inspector->loaded($engine)) {
1981 require Class::Inspector->filename($engine);
1984 # check for old engines that are no longer compatible
1986 if ( $engine->isa('Catalyst::Engine::Apache')
1987 && !Catalyst::Engine::Apache->VERSION )
1992 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1993 && Catalyst::Engine::Server->VERSION le '0.02' )
1998 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1999 && $engine->VERSION eq '0.01' )
2004 elsif ($engine->isa('Catalyst::Engine::Zeus')
2005 && $engine->VERSION eq '0.01' )
2011 Catalyst::Exception->throw( message =>
2012 qq/Engine "$engine" is not supported by this version of Catalyst/
2017 $class->engine( $engine->new );
2020 =head2 $c->setup_home
2022 Sets up the home directory.
2027 my ( $class, $home ) = @_;
2029 if ( $ENV{CATALYST_HOME} ) {
2030 $home = $ENV{CATALYST_HOME};
2033 if ( $ENV{ uc($class) . '_HOME' } ) {
2034 $home = $ENV{ uc($class) . '_HOME' };
2038 $home = Catalyst::Utils::home($class);
2042 $class->config->{home} ||= $home;
2043 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2047 =head2 $c->setup_log
2054 my ( $class, $debug ) = @_;
2056 unless ( $class->log ) {
2057 $class->log( Catalyst::Log->new );
2060 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2063 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2064 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2069 *{"$class\::debug"} = sub { 1 };
2070 $class->log->debug('Debug messages enabled');
2074 =head2 $c->setup_plugins
2080 =head2 $c->registered_plugins
2082 Returns a sorted list of the plugins which have either been stated in the
2083 import list or which have been added via C<< MyApp->plugin(@args); >>.
2085 If passed a given plugin name, it will report a boolean value indicating
2086 whether or not that plugin is loaded. A fully qualified name is required if
2087 the plugin name does not begin with C<Catalyst::Plugin::>.
2089 if ($c->registered_plugins('Some::Plugin')) {
2097 sub registered_plugins {
2099 return sort keys %{ $proto->_plugins } unless @_;
2101 return 1 if exists $proto->_plugins->{$plugin};
2102 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2105 sub _register_plugin {
2106 my ( $proto, $plugin, $instant ) = @_;
2107 my $class = ref $proto || $proto;
2109 unless (Class::Inspector->loaded($plugin)) {
2110 require Class::Inspector->filename($plugin);
2113 $proto->_plugins->{$plugin} = 1;
2116 unshift @{"$class\::ISA"}, $plugin;
2122 my ( $class, $plugins ) = @_;
2124 $class->_plugins( {} ) unless $class->_plugins;
2126 for my $plugin ( reverse @$plugins ) {
2128 unless ( $plugin =~ s/\A\+// ) {
2129 $plugin = "Catalyst::Plugin::$plugin";
2132 $class->_register_plugin($plugin);
2139 Returns an arrayref of the internal execution stack (actions that are
2140 currently executing).
2142 =head2 $c->write( $data )
2144 Writes $data to the output stream. When using this method directly, you
2145 will need to manually set the C<Content-Length> header to the length of
2146 your output data, if known.
2153 # Finalize headers if someone manually writes output
2154 $c->finalize_headers;
2156 return $c->engine->write( $c, @_ );
2161 Returns the Catalyst version number. Mostly useful for "powered by"
2162 messages in template systems.
2166 sub version { return $Catalyst::VERSION }
2168 =head1 INTERNAL ACTIONS
2170 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2171 C<_ACTION>, and C<_END>. These are by default not shown in the private
2172 action table, but you can make them visible with a config parameter.
2174 MyApp->config->{show_internal_actions} = 1;
2176 =head1 CASE SENSITIVITY
2178 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2179 mapped to C</foo/bar>. You can activate case sensitivity with a config
2182 MyApp->config->{case_sensitive} = 1;
2184 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2186 =head1 ON-DEMAND PARSER
2188 The request body is usually parsed at the beginning of a request,
2189 but if you want to handle input yourself or speed things up a bit,
2190 you can enable on-demand parsing with a config parameter.
2192 MyApp->config->{parse_on_demand} = 1;
2194 =head1 PROXY SUPPORT
2196 Many production servers operate using the common double-server approach,
2197 with a lightweight frontend web server passing requests to a larger
2198 backend server. An application running on the backend server must deal
2199 with two problems: the remote user always appears to be C<127.0.0.1> and
2200 the server's hostname will appear to be C<localhost> regardless of the
2201 virtual host that the user connected through.
2203 Catalyst will automatically detect this situation when you are running
2204 the frontend and backend servers on the same machine. The following
2205 changes are made to the request.
2207 $c->req->address is set to the user's real IP address, as read from
2208 the HTTP X-Forwarded-For header.
2210 The host value for $c->req->base and $c->req->uri is set to the real
2211 host, as read from the HTTP X-Forwarded-Host header.
2213 Obviously, your web server must support these headers for this to work.
2215 In a more complex server farm environment where you may have your
2216 frontend proxy server(s) on different machines, you will need to set a
2217 configuration option to tell Catalyst to read the proxied data from the
2220 MyApp->config->{using_frontend_proxy} = 1;
2222 If you do not wish to use the proxy support at all, you may set:
2224 MyApp->config->{ignore_frontend_proxy} = 1;
2226 =head1 THREAD SAFETY
2228 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2229 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2230 believe the Catalyst core to be thread-safe.
2232 If you plan to operate in a threaded environment, remember that all other
2233 modules you are using must also be thread-safe. Some modules, most notably
2234 L<DBD::SQLite>, are not thread-safe.
2240 Join #catalyst on irc.perl.org.
2244 http://lists.rawmode.org/mailman/listinfo/catalyst
2245 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2249 http://catalyst.perl.org
2253 http://dev.catalyst.perl.org
2257 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2259 =head2 L<Catalyst::Manual> - The Catalyst Manual
2261 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2263 =head2 L<Catalyst::Engine> - Core engine
2265 =head2 L<Catalyst::Log> - Log class.
2267 =head2 L<Catalyst::Request> - Request object
2269 =head2 L<Catalyst::Response> - Response object
2271 =head2 L<Catalyst::Test> - The test suite.
2343 Sebastian Riedel, C<sri@oook.de>
2347 This library is free software, you can redistribute it and/or modify it under
2348 the same terms as Perl itself.