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;
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.70_01';
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 # use the helper to create a new application
93 # add models, views, controllers
94 script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
95 script/myapp_create.pl view TT TT
96 script/myapp_create.pl controller Search
98 # built in testserver -- use -r to restart automatically on changes
99 script/myapp_server.pl
101 # command line testing interface
102 script/myapp_test.pl /yada
105 use Catalyst qw/-Debug/; # include plugins here as well
107 ### In lib/MyApp/Controller/Root.pm (autocreated)
108 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
109 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
110 $c->stash->{template} = 'foo.tt'; # set the template
111 # lookup something from db -- stash vars are passed to TT
113 $c->model('Database::Foo')->search( { country => $args[0] } );
114 if ( $c->req->params->{bar} ) { # access GET or POST parameters
115 $c->forward( 'bar' ); # process another action
116 # do something else after forward returns
120 # The foo.tt TT template can use the stash data from the database
121 [% WHILE (item = data.next) %]
125 # called for /bar/of/soap, /bar/of/soap/10, etc.
126 sub bar : Path('/bar/of/soap') { ... }
128 # called for all actions, from the top-most controller downwards
130 my ( $self, $c ) = @_;
131 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
132 $c->res->redirect( '/login' ); # require login
133 return 0; # abort request and go immediately to end()
135 return 1; # success; carry on to next action
138 # called after all actions are finished
140 my ( $self, $c ) = @_;
141 if ( scalar @{ $c->error } ) { ... } # handle errors
142 return if $c->res->body; # already have a response
143 $c->forward( 'MyApp::View::TT' ); # render template
146 ### in MyApp/Controller/Foo.pm
147 # called for /foo/bar
148 sub bar : Local { ... }
150 # called for /blargle
151 sub blargle : Global { ... }
153 # an index action matches /foo, but not /foo/1, etc.
154 sub index : Private { ... }
156 ### in MyApp/Controller/Foo/Bar.pm
157 # called for /foo/bar/baz
158 sub baz : Local { ... }
160 # first Root auto is called, then Foo auto, then this
161 sub auto : Private { ... }
163 # powerful regular expression paths are also possible
164 sub details : Regex('^product/(\w+)/details$') {
165 my ( $self, $c ) = @_;
166 # extract the (\w+) from the URI
167 my $product = $c->req->captures->[0];
170 See L<Catalyst::Manual::Intro> for additional information.
174 Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>
176 See L<Catalyst::Manual> for more documentation.
178 Catalyst plugins can be loaded by naming them as arguments to the "use
179 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
180 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
183 use Catalyst qw/My::Module/;
185 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
186 fully qualify the name by using a unary plus:
190 +Fully::Qualified::Plugin::Name
193 Special flags like C<-Debug> and C<-Engine> can also be specified as
194 arguments when Catalyst is loaded:
196 use Catalyst qw/-Debug My::Module/;
198 The position of plugins and flags in the chain is important, because
199 they are loaded in exactly the order in which they appear.
201 The following flags are supported:
205 Enables debug output. You can also force this setting from the system
206 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment settings
207 override the app, with <MYAPP>_DEBUG having highest priority.
211 Forces Catalyst to use a specific engine. Omit the
212 C<Catalyst::Engine::> prefix of the engine name, i.e.:
214 use Catalyst qw/-Engine=CGI/;
218 Forces Catalyst to use a specific home directory, e.g.:
220 use Catalyst qw[-Home=/usr/sri];
228 =head2 INFORMATION ABOUT THE CURRENT REQUEST
232 Returns a L<Catalyst::Action> object for the current action, which
233 stringifies to the action name. See L<Catalyst::Action>.
237 Returns the namespace of the current action, i.e., the uri prefix
238 corresponding to the controller of the current action. For example:
240 # in Controller::Foo::Bar
241 $c->namespace; # returns 'foo/bar';
247 Returns the current L<Catalyst::Request> object. See
248 L<Catalyst::Request>.
250 =head2 REQUEST FLOW HANDLING
252 =head2 $c->forward( $action [, \@arguments ] )
254 =head2 $c->forward( $class, $method, [, \@arguments ] )
256 Forwards processing to another action, by it's private name. If you give a
257 class name but no method, C<process()> is called. You may also optionally
258 pass arguments in an arrayref. The action will receive the arguments in
259 C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
260 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
262 Any data C<return>ed from the action forwarded to, will be returned by the
265 my $foodata = $c->forward('/foo');
266 $c->forward('index');
267 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
268 $c->forward('MyApp::View::TT');
270 Note that forward implies an C<<eval { }>> around the call (well, actually
271 C<execute> does), thus de-fatalizing all 'dies' within the called action. If
272 you want C<die> to propagate you need to do something like:
275 die $c->error if $c->error;
277 Or make sure to always return true values from your actions and write your code
280 $c->forward('foo') || return;
284 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
286 =head2 $c->detach( $action [, \@arguments ] )
288 =head2 $c->detach( $class, $method, [, \@arguments ] )
290 The same as C<forward>, but doesn't return to the previous action when
291 processing is finished.
295 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
301 Returns the current L<Catalyst::Response> object.
305 Returns a hashref to the stash, which may be used to store data and pass
306 it between components during a request. You can also set hash keys by
307 passing arguments. The stash is automatically sent to the view. The
308 stash is cleared at the end of a request; it cannot be used for
311 $c->stash->{foo} = $bar;
312 $c->stash( { moose => 'majestic', qux => 0 } );
313 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
315 # stash is automatically passed to the view for use in a template
316 $c->forward( 'MyApp::V::TT' );
323 my $stash = @_ > 1 ? {@_} : $_[0];
324 croak('stash takes a hash or hashref') unless ref $stash;
325 foreach my $key ( keys %$stash ) {
326 $c->{stash}->{$key} = $stash->{$key};
334 =head2 $c->error($error, ...)
336 =head2 $c->error($arrayref)
338 Returns an arrayref containing error messages. If Catalyst encounters an
339 error while processing a request, it stores the error in $c->error. This
340 method should not be used to store non-fatal error messages.
342 my @error = @{ $c->error };
346 $c->error('Something bad happened');
353 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
354 croak @$error unless ref $c;
355 push @{ $c->{error} }, @$error;
357 elsif ( defined $_[0] ) { $c->{error} = undef }
358 return $c->{error} || [];
364 Contains the return value of the last executed action.
366 =head2 $c->clear_errors
368 Clear errors. You probably don't want to clear the errors unless you are
369 implementing a custom error screen.
371 This is equivalent to running
387 my ( $c, @names ) = @_;
389 foreach my $name (@names) {
390 foreach my $component ( keys %{ $c->components } ) {
391 return $c->components->{$component} if $component =~ /$name/i;
398 # try explicit component names
400 my ( $c, @names ) = @_;
402 foreach my $try (@names) {
403 return $c->components->{$try} if ( exists $c->components->{$try} );
409 # like component, but try just these prefixes before regex searching,
410 # and do not try to return "sort keys %{ $c->components }"
412 my ( $c, $name, @prefixes ) = @_;
414 my $appclass = ref $c || $c;
416 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
418 my $comp = $c->_comp_explicit(@names);
419 return $comp if defined($comp);
420 $comp = $c->_comp_search($name);
424 # Find possible names for a prefix
427 my ( $c, @prefixes ) = @_;
429 my $appclass = ref $c || $c;
431 my @pre = map { "${appclass}::${_}::" } @prefixes;
435 COMPONENT: foreach my $comp ($c->component) {
436 foreach my $p (@pre) {
437 if ($comp =~ s/^$p//) {
447 # Return a component if only one matches.
449 my ( $c, @prefixes ) = @_;
451 my $appclass = ref $c || $c;
453 my ( $comp, $rest ) =
454 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
455 return $comp unless $rest;
458 # Filter a component before returning by calling ACCEPT_CONTEXT if available
459 sub _filter_component {
460 my ( $c, $comp, @args ) = @_;
461 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
462 return $comp->ACCEPT_CONTEXT( $c, @args );
464 else { return $comp }
467 =head2 COMPONENT ACCESSORS
469 =head2 $c->controller($name)
471 Gets a L<Catalyst::Controller> instance by name.
473 $c->controller('Foo')->do_stuff;
475 If name is omitted, will return the controller for the dispatched action.
480 my ( $c, $name, @args ) = @_;
481 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
484 return $c->component( $c->action->class );
487 =head2 $c->model($name)
489 Gets a L<Catalyst::Model> instance by name.
491 $c->model('Foo')->do_stuff;
493 If the name is omitted, it will look for a config setting 'default_model',
494 or check if there is only one view, and return it if that's the case.
499 my ( $c, $name, @args ) = @_;
500 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
503 return $c->component( $c->config->{default_model} )
504 if $c->config->{default_model};
505 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
509 =head2 $c->controllers
511 Returns the available names which can be passed to $c->controller
517 return $c->_comp_names(qw/Controller C/);
521 =head2 $c->view($name)
523 Gets a L<Catalyst::View> instance by name.
525 $c->view('Foo')->do_stuff;
527 If the name is omitted, it will look for a config setting 'default_view',
528 or check if there is only one view, and forward to it if that's the case.
533 my ( $c, $name, @args ) = @_;
534 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
537 return $c->component( $c->config->{default_view} )
538 if $c->config->{default_view};
539 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
544 Returns the available names which can be passed to $c->model
550 return $c->_comp_names(qw/Model M/);
556 Returns the available names which can be passed to $c->view
562 return $c->_comp_names(qw/View V/);
565 =head2 $c->comp($name)
567 =head2 $c->component($name)
569 Gets a component object by name. This method is no longer recommended,
570 unless you want to get a specific component by full
571 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
572 should be used instead.
583 my $appclass = ref $c || $c;
586 $name, "${appclass}::${name}",
587 map { "${appclass}::${_}::${name}" }
588 qw/Model M Controller C View V/
591 my $comp = $c->_comp_explicit(@names);
592 return $c->_filter_component( $comp, @_ ) if defined($comp);
594 $comp = $c->_comp_search($name);
595 return $c->_filter_component( $comp, @_ ) if defined($comp);
598 return sort keys %{ $c->components };
603 =head2 CLASS DATA AND HELPER CLASSES
607 Returns or takes a hashref containing the application's configuration.
609 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
611 You can also use a L<YAML> config file like myapp.yml in your
612 applications home directory.
615 db: dsn:SQLite:foo.db
623 $c->log->warn("Setting config after setup has been run is not a good idea.")
624 if ( @_ and $c->setup_finished );
626 $c->NEXT::config(@_);
631 Returns the logging object instance. Unless it is already set, Catalyst sets
632 this up with a L<Catalyst::Log> object. To use your own log class, set the
633 logger with the C<< __PACKAGE__->log >> method prior to calling
634 C<< __PACKAGE__->setup >>.
636 __PACKAGE__->log( MyLogger->new );
641 $c->log->info( 'Now logging with my own logger!' );
643 Your log class should implement the methods described in the
644 L<Catalyst::Log> man page.
649 Overload to enable debug messages (same as -Debug option).
651 Note that this is a static method, not an accessor and should be overloaded
652 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
658 =head2 $c->dispatcher
660 Returns the dispatcher instance. Stringifies to class name. See
661 L<Catalyst::Dispatcher>.
665 Returns the engine instance. Stringifies to the class name. See
669 =head2 UTILITY METHODS
671 =head2 $c->path_to(@path)
673 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
674 L<Path::Class> object.
678 $c->path_to( 'db', 'sqlite.db' );
683 my ( $c, @path ) = @_;
684 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
685 if ( -d $path ) { return $path }
686 else { return Path::Class::File->new( $c->config->{home}, @path ) }
689 =head2 $c->plugin( $name, $class, @args )
691 Helper method for plugins. It creates a classdata accessor/mutator and
692 loads and instantiates the given class.
694 MyApp->plugin( 'prototype', 'HTML::Prototype' );
696 $c->prototype->define_javascript_functions;
701 my ( $class, $name, $plugin, @args ) = @_;
702 $class->_register_plugin( $plugin, 1 );
704 eval { $plugin->import };
705 $class->mk_classdata($name);
707 eval { $obj = $plugin->new(@args) };
710 Catalyst::Exception->throw( message =>
711 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
715 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
721 Initializes the dispatcher and engine, loads any plugins, and loads the
722 model, view, and controller components. You may also specify an array
723 of plugins to load here, if you choose to not load them in the C<use
727 MyApp->setup( qw/-Debug/ );
732 my ( $class, @arguments ) = @_;
734 $class->log->warn("Running setup twice is not a good idea.")
735 if ( $class->setup_finished );
737 unless ( $class->isa('Catalyst') ) {
739 Catalyst::Exception->throw(
740 message => qq/'$class' does not inherit from Catalyst/ );
743 if ( $class->arguments ) {
744 @arguments = ( @arguments, @{ $class->arguments } );
750 foreach (@arguments) {
754 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
756 elsif (/^-(\w+)=?(.*)$/) {
757 $flags->{ lc $1 } = $2;
760 push @{ $flags->{plugins} }, $_;
764 $class->setup_home( delete $flags->{home} );
766 $class->setup_log( delete $flags->{log} );
767 $class->setup_plugins( delete $flags->{plugins} );
768 $class->setup_dispatcher( delete $flags->{dispatcher} );
769 $class->setup_engine( delete $flags->{engine} );
771 for my $flag ( sort keys %{$flags} ) {
773 if ( my $code = $class->can( 'setup_' . $flag ) ) {
774 &$code( $class, delete $flags->{$flag} );
777 $class->log->warn(qq/Unknown flag "$flag"/);
781 eval { require Catalyst::Devel; };
782 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
783 $class->log->warn(<<"EOF");
784 You are running an old script!
786 Please update by running (this will overwrite existing files):
787 catalyst.pl -force -scripts $class
789 or (this will not overwrite existing files):
790 catalyst.pl -scripts $class
794 if ( $class->debug ) {
801 map { $_ . ' ' . ( $_->VERSION || '' ) }
802 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
806 my $t = Text::SimpleTable->new(74);
807 $t->row($_) for @plugins;
808 $class->log->debug( "Loaded plugins:\n" . $t->draw );
811 my $dispatcher = $class->dispatcher;
812 my $engine = $class->engine;
813 my $home = $class->config->{home};
815 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
816 $class->log->debug(qq/Loaded engine "$engine"/);
820 ? $class->log->debug(qq/Found home "$home"/)
821 : $class->log->debug(qq/Home "$home" doesn't exist/)
822 : $class->log->debug(q/Couldn't find home/);
827 no warnings qw/redefine/;
828 local *setup = sub { };
832 # Initialize our data structure
833 $class->components( {} );
835 $class->setup_components;
837 if ( $class->debug ) {
838 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
839 for my $comp ( sort keys %{ $class->components } ) {
840 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
841 $t->row( $comp, $type );
843 $class->log->debug( "Loaded components:\n" . $t->draw )
844 if ( keys %{ $class->components } );
847 # Add our self to components, since we are also a component
848 $class->components->{$class} = $class;
850 $class->setup_actions;
852 if ( $class->debug ) {
853 my $name = $class->config->{name} || 'Application';
854 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
856 $class->log->_flush() if $class->log->can('_flush');
858 $class->setup_finished(1);
861 =head2 $c->uri_for( $path, @args?, \%query_values? )
863 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
864 with C<$c-E<gt>namespace> for relative uri's, then returns a
865 normalized L<URI> object. If any args are passed, they are added at the
866 end of the path. If the last argument to uri_for is a hash reference,
867 it is assumed to contain GET parameter key/value pairs, which will be
868 appended to the URI in standard fashion.
870 Instead of $path, you can also optionally pass a $action object which will
871 be resolved to a path using $c->dispatcher->uri_for_action; if the first
872 element of @args is an arrayref it is treated as a list of captures to be
873 passed to uri_for_action.
878 my ( $c, $path, @args ) = @_;
879 my $base = $c->request->base->clone;
880 my $basepath = $base->path;
881 $basepath =~ s/\/$//;
883 my $namespace = $c->namespace || '';
885 if ( Scalar::Util::blessed($path) ) { # action object
886 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
889 $path = $c->dispatcher->uri_for_action($path, $captures);
890 return undef unless defined($path);
893 # massage namespace, empty if absolute path
894 $namespace =~ s/^\/// if $namespace;
895 $namespace .= '/' if $namespace;
897 $namespace = '' if $path =~ /^\//;
901 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
903 for my $value ( values %$params ) {
\r
904 my $isa_ref = ref $value;
\r
905 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
\r
906 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
\r
908 utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
\r
911 # join args with '/', or a blank string
912 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
913 $args =~ s/^\/// unless $path;
915 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
917 $res->query_form(%$params);
921 =head2 $c->welcome_message
923 Returns the Catalyst welcome HTML page.
927 sub welcome_message {
929 my $name = $c->config->{name};
930 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
931 my $prefix = Catalyst::Utils::appprefix( ref $c );
932 $c->response->content_type('text/html; charset=utf-8');
934 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
935 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
936 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
938 <meta http-equiv="Content-Language" content="en" />
939 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
940 <title>$name on Catalyst $VERSION</title>
941 <style type="text/css">
944 background-color: #eee;
953 background-color: #ccc;
954 border: 1px solid #aaa;
959 font-family: verdana, tahoma, sans-serif;
962 font-family: verdana, tahoma, sans-serif;
965 text-decoration: none;
967 border-bottom: 1px dotted #bbb;
969 :link:hover, :visited:hover {
982 background-color: #fff;
983 border: 1px solid #aaa;
1009 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1014 <img src="$logo" alt="Catalyst Logo" />
1016 <p>Welcome to the wonderful world of Catalyst.
1017 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1018 framework will make web development something you had
1019 never expected it to be: Fun, rewarding, and quick.</p>
1020 <h2>What to do now?</h2>
1021 <p>That really depends on what <b>you</b> want to do.
1022 We do, however, provide you with a few starting points.</p>
1023 <p>If you want to jump right into web development with Catalyst
1024 you might want to check out the documentation.</p>
1025 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1026 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1027 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1028 <h2>What to do next?</h2>
1029 <p>Next it's time to write an actual application. Use the
1030 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1031 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1032 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1033 they can save you a lot of work.</p>
1034 <pre><code>script/${prefix}_create.pl -help</code></pre>
1035 <p>Also, be sure to check out the vast and growing
1036 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1037 you are likely to find what you need there.
1041 <p>Catalyst has a very active community. Here are the main places to
1042 get in touch with us.</p>
1045 <a href="http://dev.catalyst.perl.org">Wiki</a>
1048 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1051 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1054 <h2>In conclusion</h2>
1055 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1056 as we enjoyed making it. Please contact us if you have ideas
1057 for improvement or other feedback.</p>
1065 =head1 INTERNAL METHODS
1067 These methods are not meant to be used by end users.
1069 =head2 $c->components
1071 Returns a hash of components.
1073 =head2 $c->context_class
1075 Returns or sets the context class.
1079 Returns a hashref containing coderefs and execution counts (needed for
1080 deep recursion detection).
1084 Returns the number of actions on the current internal execution stack.
1088 Dispatches a request to actions.
1092 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1094 =head2 $c->dispatcher_class
1096 Returns or sets the dispatcher class.
1098 =head2 $c->dump_these
1100 Returns a list of 2-element array references (name, structure) pairs
1101 that will be dumped on the error page in debug mode.
1107 [ Request => $c->req ],
1108 [ Response => $c->res ],
1109 [ Stash => $c->stash ],
1110 [ Config => $c->config ];
1113 =head2 $c->engine_class
1115 Returns or sets the engine class.
1117 =head2 $c->execute( $class, $coderef )
1119 Execute a coderef in given class and catch exceptions. Errors are available
1125 my ( $c, $class, $code ) = @_;
1126 $class = $c->component($class) || $class;
1129 if ( $c->depth >= $RECURSION ) {
1130 my $action = "$code";
1131 $action = "/$action" unless $action =~ /\-\>/;
1132 my $error = qq/Deep recursion detected calling "$action"/;
1133 $c->log->error($error);
1139 my $stats_info = $c->_stats_start_execute( $code );
1141 push( @{ $c->stack }, $code );
1143 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1145 $c->_stats_finish_execute( $stats_info );
1147 my $last = ${ $c->stack }[-1];
1148 pop( @{ $c->stack } );
1150 if ( my $error = $@ ) {
1151 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1153 unless ( ref $error ) {
1155 my $class = $last->class;
1156 my $name = $last->name;
1157 $error = qq/Caught exception in $class->$name "$error"/;
1166 sub _stats_start_execute {
1167 my ( $c, $code ) = @_;
1169 return unless $c->debug;
1171 my $action = "$code";
1173 $action = "/$action" unless $action =~ /\-\>/;
1174 $c->counter->{"$code"}++;
1176 # determine if the call was the result of a forward
1177 # this is done by walking up the call stack and looking for a calling
1178 # sub of Catalyst::forward before the eval
1180 for my $index ( 2 .. 11 ) {
1182 if ( ( caller($index) )[0] eq 'Catalyst'
1183 && ( caller($index) )[3] eq '(eval)' );
1185 if ( ( caller($index) )[3] =~ /forward$/ ) {
1186 $callsub = ( caller($index) )[3];
1187 $action = "-> $action";
1192 my $node = Tree::Simple->new(
1195 elapsed => undef, # to be filled in later
1199 $node->setUID( "$code" . $c->counter->{"$code"} );
1201 unless ( ( $code->name =~ /^_.*/ )
1202 && ( !$c->config->{show_internal_actions} ) )
1204 # is this a root-level call or a forwarded call?
1205 if ( $callsub =~ /forward$/ ) {
1207 # forward, locate the caller
1208 if ( my $parent = $c->stack->[-1] ) {
1209 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1210 $visitor->searchForUID(
1211 "$parent" . $c->counter->{"$parent"} );
1212 $c->stats->accept($visitor);
1213 if ( my $result = $visitor->getResult ) {
1214 $result->addChild($node);
1219 # forward with no caller may come from a plugin
1220 $c->stats->addChild($node);
1226 $c->stats->addChild($node);
1230 my $start = [gettimeofday];
1231 my $elapsed = tv_interval($start);
1235 elapsed => $elapsed,
1241 sub _stats_finish_execute {
1242 my ( $c, $info ) = @_;
1244 return unless $c->debug;
1246 my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
1248 unless ( ( $code->name =~ /^_.*/ )
1249 && ( !$c->config->{show_internal_actions} ) )
1252 # FindByUID uses an internal die, so we save the existing error
1255 # locate the node in the tree and update the elapsed time
1256 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1257 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1258 $c->stats->accept($visitor);
1259 if ( my $result = $visitor->getResult ) {
1260 my $value = $result->getNodeValue;
1261 $value->{elapsed} = sprintf( '%fs', $elapsed );
1262 $result->setNodeValue($value);
1266 $@ = $error || undef;
1270 =head2 $c->_localize_fields( sub { }, \%keys );
1274 sub _localize_fields {
1275 my ( $c, $localized, $code ) = ( @_ );
1277 my $request = delete $localized->{request} || {};
1278 my $response = delete $localized->{response} || {};
1280 local @{ $c }{ keys %$localized } = values %$localized;
1281 local @{ $c->request }{ keys %$request } = values %$request;
1282 local @{ $c->response }{ keys %$response } = values %$response;
1289 Finalizes the request.
1296 for my $error ( @{ $c->error } ) {
1297 $c->log->error($error);
1300 # Allow engine to handle finalize flow (for POE)
1301 if ( $c->engine->can('finalize') ) {
1302 $c->engine->finalize($c);
1306 $c->finalize_uploads;
1309 if ( $#{ $c->error } >= 0 ) {
1313 $c->finalize_headers;
1316 if ( $c->request->method eq 'HEAD' ) {
1317 $c->response->body('');
1323 return $c->response->status;
1326 =head2 $c->finalize_body
1332 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1334 =head2 $c->finalize_cookies
1340 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1342 =head2 $c->finalize_error
1348 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1350 =head2 $c->finalize_headers
1356 sub finalize_headers {
1359 # Check if we already finalized headers
1360 return if $c->response->{_finalized_headers};
1363 if ( my $location = $c->response->redirect ) {
1364 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1365 $c->response->header( Location => $location );
1369 if ( $c->response->body && !$c->response->content_length ) {
1371 # get the length from a filehandle
1372 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1374 if ( my $stat = stat $c->response->body ) {
1375 $c->response->content_length( $stat->size );
1378 $c->log->warn('Serving filehandle without a content-length');
1382 $c->response->content_length( bytes::length( $c->response->body ) );
1387 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1388 $c->response->headers->remove_header("Content-Length");
1389 $c->response->body('');
1392 $c->finalize_cookies;
1394 $c->engine->finalize_headers( $c, @_ );
1397 $c->response->{_finalized_headers} = 1;
1400 =head2 $c->finalize_output
1402 An alias for finalize_body.
1404 =head2 $c->finalize_read
1406 Finalizes the input after reading is complete.
1410 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1412 =head2 $c->finalize_uploads
1414 Finalizes uploads. Cleans up any temporary files.
1418 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1420 =head2 $c->get_action( $action, $namespace )
1422 Gets an action in a given namespace.
1426 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1428 =head2 $c->get_actions( $action, $namespace )
1430 Gets all actions of a given name in a namespace and all parent
1435 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1437 =head2 $c->handle_request( $class, @arguments )
1439 Called to handle each HTTP request.
1443 sub handle_request {
1444 my ( $class, @arguments ) = @_;
1446 # Always expect worst case!
1449 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1452 my $c = $class->prepare(@arguments);
1455 return $c->finalize;
1458 if ( $class->debug ) {
1459 my $start = [gettimeofday];
1460 $status = &$handler;
1461 my $elapsed = tv_interval $start;
1462 $elapsed = sprintf '%f', $elapsed;
1463 my $av = sprintf '%.3f',
1464 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1465 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1470 my $stat = $action->getNodeValue;
1471 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1472 $stat->{elapsed} || '??' );
1477 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1479 else { $status = &$handler }
1483 if ( my $error = $@ ) {
1485 $class->log->error(qq/Caught exception in engine "$error"/);
1489 $class->log->_flush() if $class->log->can('_flush');
1493 =head2 $c->prepare( @arguments )
1495 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1501 my ( $class, @arguments ) = @_;
1503 $class->context_class( ref $class || $class ) unless $class->context_class;
1504 my $c = $class->context_class->new(
1508 request => $class->request_class->new(
1511 body_parameters => {},
1513 headers => HTTP::Headers->new,
1515 query_parameters => {},
1521 response => $class->response_class->new(
1525 headers => HTTP::Headers->new(),
1534 # For on-demand data
1535 $c->request->{_context} = $c;
1536 $c->response->{_context} = $c;
1537 weaken( $c->request->{_context} );
1538 weaken( $c->response->{_context} );
1541 my $secs = time - $START || 1;
1542 my $av = sprintf '%.3f', $COUNT / $secs;
1543 my $time = localtime time;
1544 $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1545 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1548 # Allow engine to direct the prepare flow (for POE)
1549 if ( $c->engine->can('prepare') ) {
1550 $c->engine->prepare( $c, @arguments );
1553 $c->prepare_request(@arguments);
1554 $c->prepare_connection;
1555 $c->prepare_query_parameters;
1556 $c->prepare_headers;
1557 $c->prepare_cookies;
1561 $c->prepare_body unless $c->config->{parse_on_demand};
1564 my $method = $c->req->method || '';
1565 my $path = $c->req->path || '/';
1566 my $address = $c->req->address || '';
1568 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1576 =head2 $c->prepare_action
1578 Prepares action. See L<Catalyst::Dispatcher>.
1582 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1584 =head2 $c->prepare_body
1586 Prepares message body.
1593 # Do we run for the first time?
1594 return if defined $c->request->{_body};
1596 # Initialize on-demand data
1597 $c->engine->prepare_body( $c, @_ );
1598 $c->prepare_parameters;
1599 $c->prepare_uploads;
1601 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1602 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1603 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1604 my $param = $c->req->body_parameters->{$key};
1605 my $value = defined($param) ? $param : '';
1607 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1609 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1613 =head2 $c->prepare_body_chunk( $chunk )
1615 Prepares a chunk of data before sending it to L<HTTP::Body>.
1617 See L<Catalyst::Engine>.
1621 sub prepare_body_chunk {
1623 $c->engine->prepare_body_chunk( $c, @_ );
1626 =head2 $c->prepare_body_parameters
1628 Prepares body parameters.
1632 sub prepare_body_parameters {
1634 $c->engine->prepare_body_parameters( $c, @_ );
1637 =head2 $c->prepare_connection
1639 Prepares connection.
1643 sub prepare_connection {
1645 $c->engine->prepare_connection( $c, @_ );
1648 =head2 $c->prepare_cookies
1654 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1656 =head2 $c->prepare_headers
1662 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1664 =head2 $c->prepare_parameters
1666 Prepares parameters.
1670 sub prepare_parameters {
1672 $c->prepare_body_parameters;
1673 $c->engine->prepare_parameters( $c, @_ );
1676 =head2 $c->prepare_path
1678 Prepares path and base.
1682 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1684 =head2 $c->prepare_query_parameters
1686 Prepares query parameters.
1690 sub prepare_query_parameters {
1693 $c->engine->prepare_query_parameters( $c, @_ );
1695 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1696 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1697 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1698 my $param = $c->req->query_parameters->{$key};
1699 my $value = defined($param) ? $param : '';
1701 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1703 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1707 =head2 $c->prepare_read
1709 Prepares the input for reading.
1713 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1715 =head2 $c->prepare_request
1717 Prepares the engine request.
1721 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1723 =head2 $c->prepare_uploads
1729 sub prepare_uploads {
1732 $c->engine->prepare_uploads( $c, @_ );
1734 if ( $c->debug && keys %{ $c->request->uploads } ) {
1735 my $t = Text::SimpleTable->new(
1736 [ 12, 'Parameter' ],
1741 for my $key ( sort keys %{ $c->request->uploads } ) {
1742 my $upload = $c->request->uploads->{$key};
1743 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1744 $t->row( $key, $u->filename, $u->type, $u->size );
1747 $c->log->debug( "File Uploads are:\n" . $t->draw );
1751 =head2 $c->prepare_write
1753 Prepares the output for writing.
1757 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1759 =head2 $c->request_class
1761 Returns or sets the request class.
1763 =head2 $c->response_class
1765 Returns or sets the response class.
1767 =head2 $c->read( [$maxlength] )
1769 Reads a chunk of data from the request body. This method is designed to
1770 be used in a while loop, reading C<$maxlength> bytes on every call.
1771 C<$maxlength> defaults to the size of the request if not specified.
1773 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1778 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1786 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1788 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1790 Sets an action in a given namespace.
1794 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1796 =head2 $c->setup_actions($component)
1798 Sets up actions for a component.
1802 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1804 =head2 $c->setup_components
1806 Sets up components. Specify a C<setup_components> config option to pass additional options
1807 directly to L<Module::Pluggable>. To add additional search paths, specify a key named
1808 C<search_extra> as an array reference. Items in the array beginning with C<::> will have the
1809 application class name prepended to them.
1813 sub setup_components {
1816 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1817 my $config = $class->config->{ setup_components };
1818 my $extra = delete $config->{ search_extra } || [];
1820 push @paths, @$extra;
1822 my $locator = Module::Pluggable::Object->new(
1823 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1827 for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
1828 Catalyst::Utils::ensure_class_loaded( $component );
1830 my $module = $class->setup_component( $component );
1832 $component => $module,
1834 $_ => $class->setup_component( $_ )
1835 } Devel::InnerPackage::list_packages( $component )
1838 for my $key ( keys %modules ) {
1839 $class->components->{ $key } = $modules{ $key };
1844 =head2 $c->setup_component
1848 sub setup_component {
1849 my( $class, $component ) = @_;
1851 unless ( $component->can( 'COMPONENT' ) ) {
1855 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1856 my $config = $class->config->{ $suffix } || {};
1858 my $instance = eval { $component->COMPONENT( $class, $config ); };
1860 if ( my $error = $@ ) {
1862 Catalyst::Exception->throw(
1863 message => qq/Couldn't instantiate component "$component", "$error"/
1867 Catalyst::Exception->throw(
1869 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1870 ) unless eval { $instance->can( 'can' ) };
1875 =head2 $c->setup_dispatcher
1881 sub setup_dispatcher {
1882 my ( $class, $dispatcher ) = @_;
1885 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1888 if ( $ENV{CATALYST_DISPATCHER} ) {
1889 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1892 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1894 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1897 unless ($dispatcher) {
1898 $dispatcher = $class->dispatcher_class;
1901 unless (Class::Inspector->loaded($dispatcher)) {
1902 require Class::Inspector->filename($dispatcher);
1905 # dispatcher instance
1906 $class->dispatcher( $dispatcher->new );
1909 =head2 $c->setup_engine
1916 my ( $class, $engine ) = @_;
1919 $engine = 'Catalyst::Engine::' . $engine;
1922 if ( $ENV{CATALYST_ENGINE} ) {
1923 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1926 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1927 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1930 if ( $ENV{MOD_PERL} ) {
1932 # create the apache method
1935 *{"$class\::apache"} = sub { shift->engine->apache };
1938 my ( $software, $version ) =
1939 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1942 $version =~ s/(\.[^.]+)\./$1/g;
1944 if ( $software eq 'mod_perl' ) {
1948 if ( $version >= 1.99922 ) {
1949 $engine = 'Catalyst::Engine::Apache2::MP20';
1952 elsif ( $version >= 1.9901 ) {
1953 $engine = 'Catalyst::Engine::Apache2::MP19';
1956 elsif ( $version >= 1.24 ) {
1957 $engine = 'Catalyst::Engine::Apache::MP13';
1961 Catalyst::Exception->throw( message =>
1962 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1967 # install the correct mod_perl handler
1968 if ( $version >= 1.9901 ) {
1969 *handler = sub : method {
1970 shift->handle_request(@_);
1974 *handler = sub ($$) { shift->handle_request(@_) };
1979 elsif ( $software eq 'Zeus-Perl' ) {
1980 $engine = 'Catalyst::Engine::Zeus';
1984 Catalyst::Exception->throw(
1985 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1990 $engine = $class->engine_class;
1993 unless (Class::Inspector->loaded($engine)) {
1994 require Class::Inspector->filename($engine);
1997 # check for old engines that are no longer compatible
1999 if ( $engine->isa('Catalyst::Engine::Apache')
2000 && !Catalyst::Engine::Apache->VERSION )
2005 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2006 && Catalyst::Engine::Server->VERSION le '0.02' )
2011 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2012 && $engine->VERSION eq '0.01' )
2017 elsif ($engine->isa('Catalyst::Engine::Zeus')
2018 && $engine->VERSION eq '0.01' )
2024 Catalyst::Exception->throw( message =>
2025 qq/Engine "$engine" is not supported by this version of Catalyst/
2030 $class->engine( $engine->new );
2033 =head2 $c->setup_home
2035 Sets up the home directory.
2040 my ( $class, $home ) = @_;
2042 if ( $ENV{CATALYST_HOME} ) {
2043 $home = $ENV{CATALYST_HOME};
2046 if ( $ENV{ uc($class) . '_HOME' } ) {
2047 $home = $ENV{ uc($class) . '_HOME' };
2051 $home = Catalyst::Utils::home($class);
2055 $class->config->{home} ||= $home;
2056 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2060 =head2 $c->setup_log
2067 my ( $class, $debug ) = @_;
2069 unless ( $class->log ) {
2070 $class->log( Catalyst::Log->new );
2073 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2076 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2077 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2082 *{"$class\::debug"} = sub { 1 };
2083 $class->log->debug('Debug messages enabled');
2087 =head2 $c->setup_plugins
2093 =head2 $c->registered_plugins
2095 Returns a sorted list of the plugins which have either been stated in the
2096 import list or which have been added via C<< MyApp->plugin(@args); >>.
2098 If passed a given plugin name, it will report a boolean value indicating
2099 whether or not that plugin is loaded. A fully qualified name is required if
2100 the plugin name does not begin with C<Catalyst::Plugin::>.
2102 if ($c->registered_plugins('Some::Plugin')) {
2110 sub registered_plugins {
2112 return sort keys %{ $proto->_plugins } unless @_;
2114 return 1 if exists $proto->_plugins->{$plugin};
2115 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2118 sub _register_plugin {
2119 my ( $proto, $plugin, $instant ) = @_;
2120 my $class = ref $proto || $proto;
2122 unless (Class::Inspector->loaded($plugin)) {
2123 require Class::Inspector->filename($plugin);
2126 $proto->_plugins->{$plugin} = 1;
2129 unshift @{"$class\::ISA"}, $plugin;
2135 my ( $class, $plugins ) = @_;
2137 $class->_plugins( {} ) unless $class->_plugins;
2139 for my $plugin ( reverse @$plugins ) {
2141 unless ( $plugin =~ s/\A\+// ) {
2142 $plugin = "Catalyst::Plugin::$plugin";
2145 $class->_register_plugin($plugin);
2152 Returns an arrayref of the internal execution stack (actions that are currently
2155 =head2 $c->write( $data )
2157 Writes $data to the output stream. When using this method directly, you
2158 will need to manually set the C<Content-Length> header to the length of
2159 your output data, if known.
2166 # Finalize headers if someone manually writes output
2167 $c->finalize_headers;
2169 return $c->engine->write( $c, @_ );
2174 Returns the Catalyst version number. Mostly useful for "powered by"
2175 messages in template systems.
2179 sub version { return $Catalyst::VERSION }
2181 =head1 INTERNAL ACTIONS
2183 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2184 C<_ACTION>, and C<_END>. These are by default not shown in the private
2185 action table, but you can make them visible with a config parameter.
2187 MyApp->config->{show_internal_actions} = 1;
2189 =head1 CASE SENSITIVITY
2191 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2192 mapped to C</foo/bar>. You can activate case sensitivity with a config
2195 MyApp->config->{case_sensitive} = 1;
2197 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2199 =head1 ON-DEMAND PARSER
2201 The request body is usually parsed at the beginning of a request,
2202 but if you want to handle input yourself or speed things up a bit,
2203 you can enable on-demand parsing with a config parameter.
2205 MyApp->config->{parse_on_demand} = 1;
2207 =head1 PROXY SUPPORT
2209 Many production servers operate using the common double-server approach,
2210 with a lightweight frontend web server passing requests to a larger
2211 backend server. An application running on the backend server must deal
2212 with two problems: the remote user always appears to be C<127.0.0.1> and
2213 the server's hostname will appear to be C<localhost> regardless of the
2214 virtual host that the user connected through.
2216 Catalyst will automatically detect this situation when you are running
2217 the frontend and backend servers on the same machine. The following
2218 changes are made to the request.
2220 $c->req->address is set to the user's real IP address, as read from
2221 the HTTP X-Forwarded-For header.
2223 The host value for $c->req->base and $c->req->uri is set to the real
2224 host, as read from the HTTP X-Forwarded-Host header.
2226 Obviously, your web server must support these headers for this to work.
2228 In a more complex server farm environment where you may have your
2229 frontend proxy server(s) on different machines, you will need to set a
2230 configuration option to tell Catalyst to read the proxied data from the
2233 MyApp->config->{using_frontend_proxy} = 1;
2235 If you do not wish to use the proxy support at all, you may set:
2237 MyApp->config->{ignore_frontend_proxy} = 1;
2239 =head1 THREAD SAFETY
2241 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2242 and the standalone forking HTTP server on Windows. We believe the Catalyst
2243 core to be thread-safe.
2245 If you plan to operate in a threaded environment, remember that all other
2246 modules you are using must also be thread-safe. Some modules, most notably
2247 L<DBD::SQLite>, are not thread-safe.
2253 Join #catalyst on irc.perl.org.
2257 http://lists.rawmode.org/mailman/listinfo/catalyst
2258 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2262 http://catalyst.perl.org
2266 http://dev.catalyst.perl.org
2270 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2272 =head2 L<Catalyst::Manual> - The Catalyst Manual
2274 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2276 =head2 L<Catalyst::Engine> - Core engine
2278 =head2 L<Catalyst::Log> - Log class.
2280 =head2 L<Catalyst::Request> - Request object
2282 =head2 L<Catalyst::Response> - Response object
2284 =head2 L<Catalyst::Test> - The test suite.
2356 Sebastian Riedel, C<sri@oook.de>
2360 This library is free software, you can redistribute it and/or modify it under
2361 the same terms as Perl itself.