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.7006';
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 next unless defined $value;
929 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
935 # join args with '/', or a blank string
936 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
937 $args =~ s/^\/// unless $path;
939 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
941 $res->query_form(%$params);
945 =head2 $c->welcome_message
947 Returns the Catalyst welcome HTML page.
951 sub welcome_message {
953 my $name = $c->config->{name};
954 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
955 my $prefix = Catalyst::Utils::appprefix( ref $c );
956 $c->response->content_type('text/html; charset=utf-8');
958 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
959 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
960 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
962 <meta http-equiv="Content-Language" content="en" />
963 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
964 <title>$name on Catalyst $VERSION</title>
965 <style type="text/css">
968 background-color: #eee;
977 background-color: #ccc;
978 border: 1px solid #aaa;
983 font-family: verdana, tahoma, sans-serif;
986 font-family: verdana, tahoma, sans-serif;
989 text-decoration: none;
991 border-bottom: 1px dotted #bbb;
993 :link:hover, :visited:hover {
1006 background-color: #fff;
1007 border: 1px solid #aaa;
1011 font-weight: normal;
1033 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1038 <img src="$logo" alt="Catalyst Logo" />
1040 <p>Welcome to the wonderful world of Catalyst.
1041 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1042 framework will make web development something you had
1043 never expected it to be: Fun, rewarding, and quick.</p>
1044 <h2>What to do now?</h2>
1045 <p>That really depends on what <b>you</b> want to do.
1046 We do, however, provide you with a few starting points.</p>
1047 <p>If you want to jump right into web development with Catalyst
1048 you might want to check out the documentation.</p>
1049 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1050 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1051 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1052 <h2>What to do next?</h2>
1053 <p>Next it's time to write an actual application. Use the
1054 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1055 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1056 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1057 they can save you a lot of work.</p>
1058 <pre><code>script/${prefix}_create.pl -help</code></pre>
1059 <p>Also, be sure to check out the vast and growing
1060 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1061 you are likely to find what you need there.
1065 <p>Catalyst has a very active community. Here are the main places to
1066 get in touch with us.</p>
1069 <a href="http://dev.catalyst.perl.org">Wiki</a>
1072 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1075 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1078 <h2>In conclusion</h2>
1079 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1080 as we enjoyed making it. Please contact us if you have ideas
1081 for improvement or other feedback.</p>
1089 =head1 INTERNAL METHODS
1091 These methods are not meant to be used by end users.
1093 =head2 $c->components
1095 Returns a hash of components.
1097 =head2 $c->context_class
1099 Returns or sets the context class.
1103 Returns a hashref containing coderefs and execution counts (needed for
1104 deep recursion detection).
1108 Returns the number of actions on the current internal execution stack.
1112 Dispatches a request to actions.
1116 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1118 =head2 $c->dispatcher_class
1120 Returns or sets the dispatcher class.
1122 =head2 $c->dump_these
1124 Returns a list of 2-element array references (name, structure) pairs
1125 that will be dumped on the error page in debug mode.
1131 [ Request => $c->req ],
1132 [ Response => $c->res ],
1133 [ Stash => $c->stash ],
1134 [ Config => $c->config ];
1137 =head2 $c->engine_class
1139 Returns or sets the engine class.
1141 =head2 $c->execute( $class, $coderef )
1143 Execute a coderef in given class and catch exceptions. Errors are available
1149 my ( $c, $class, $code ) = @_;
1150 $class = $c->component($class) || $class;
1153 if ( $c->depth >= $RECURSION ) {
1154 my $action = "$code";
1155 $action = "/$action" unless $action =~ /->/;
1156 my $error = qq/Deep recursion detected calling "$action"/;
1157 $c->log->error($error);
1163 my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
1165 push( @{ $c->stack }, $code );
1167 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1169 $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
1171 my $last = pop( @{ $c->stack } );
1173 if ( my $error = $@ ) {
1174 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1176 unless ( ref $error ) {
1177 no warnings 'uninitialized';
1179 my $class = $last->class;
1180 my $name = $last->name;
1181 $error = qq/Caught exception in $class->$name "$error"/;
1190 sub _stats_start_execute {
1191 my ( $c, $code ) = @_;
1193 return if ( ( $code->name =~ /^_.*/ )
1194 && ( !$c->config->{show_internal_actions} ) );
1196 $c->counter->{"$code"}++;
1198 my $action = "$code";
1199 $action = "/$action" unless $action =~ /->/;
1201 # determine if the call was the result of a forward
1202 # this is done by walking up the call stack and looking for a calling
1203 # sub of Catalyst::forward before the eval
1205 for my $index ( 2 .. 11 ) {
1207 if ( ( caller($index) )[0] eq 'Catalyst'
1208 && ( caller($index) )[3] eq '(eval)' );
1210 if ( ( caller($index) )[3] =~ /forward$/ ) {
1211 $callsub = ( caller($index) )[3];
1212 $action = "-> $action";
1217 my $node = Tree::Simple->new(
1220 elapsed => undef, # to be filled in later
1224 $node->setUID( "$code" . $c->counter->{"$code"} );
1226 # is this a root-level call or a forwarded call?
1227 if ( $callsub =~ /forward$/ ) {
1229 # forward, locate the caller
1230 if ( my $parent = $c->stack->[-1] ) {
1231 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1232 $visitor->searchForUID(
1233 "$parent" . $c->counter->{"$parent"} );
1234 $c->stats->accept($visitor);
1235 if ( my $result = $visitor->getResult ) {
1236 $result->addChild($node);
1241 # forward with no caller may come from a plugin
1242 $c->stats->addChild($node);
1248 $c->stats->addChild($node);
1252 start => [gettimeofday],
1257 sub _stats_finish_execute {
1258 my ( $c, $info ) = @_;
1259 my $elapsed = tv_interval $info->{start};
1260 my $value = $info->{node}->getNodeValue;
1261 $value->{elapsed} = sprintf( '%fs', $elapsed );
1264 =head2 $c->_localize_fields( sub { }, \%keys );
1268 sub _localize_fields {
1269 my ( $c, $localized, $code ) = ( @_ );
1271 my $request = delete $localized->{request} || {};
1272 my $response = delete $localized->{response} || {};
1274 local @{ $c }{ keys %$localized } = values %$localized;
1275 local @{ $c->request }{ keys %$request } = values %$request;
1276 local @{ $c->response }{ keys %$response } = values %$response;
1283 Finalizes the request.
1290 for my $error ( @{ $c->error } ) {
1291 $c->log->error($error);
1294 # Allow engine to handle finalize flow (for POE)
1295 if ( $c->engine->can('finalize') ) {
1296 $c->engine->finalize($c);
1300 $c->finalize_uploads;
1303 if ( $#{ $c->error } >= 0 ) {
1307 $c->finalize_headers;
1310 if ( $c->request->method eq 'HEAD' ) {
1311 $c->response->body('');
1318 my $elapsed = sprintf '%f', tv_interval($c->stats->getNodeValue);
1319 my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1321 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1322 $c->stats->traverse(
1325 my $stat = $action->getNodeValue;
1326 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1327 $stat->{elapsed} || '??' );
1332 "Request took ${elapsed}s ($av/s)\n" . $t->draw . "\n" );
1335 return $c->response->status;
1338 =head2 $c->finalize_body
1344 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1346 =head2 $c->finalize_cookies
1352 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1354 =head2 $c->finalize_error
1360 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1362 =head2 $c->finalize_headers
1368 sub finalize_headers {
1371 # Check if we already finalized headers
1372 return if $c->response->{_finalized_headers};
1375 if ( my $location = $c->response->redirect ) {
1376 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1377 $c->response->header( Location => $location );
1381 if ( $c->response->body && !$c->response->content_length ) {
1383 # get the length from a filehandle
1384 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1386 if ( my $stat = stat $c->response->body ) {
1387 $c->response->content_length( $stat->size );
1390 $c->log->warn('Serving filehandle without a content-length');
1394 $c->response->content_length( bytes::length( $c->response->body ) );
1399 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1400 $c->response->headers->remove_header("Content-Length");
1401 $c->response->body('');
1404 $c->finalize_cookies;
1406 $c->engine->finalize_headers( $c, @_ );
1409 $c->response->{_finalized_headers} = 1;
1412 =head2 $c->finalize_output
1414 An alias for finalize_body.
1416 =head2 $c->finalize_read
1418 Finalizes the input after reading is complete.
1422 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1424 =head2 $c->finalize_uploads
1426 Finalizes uploads. Cleans up any temporary files.
1430 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1432 =head2 $c->get_action( $action, $namespace )
1434 Gets an action in a given namespace.
1438 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1440 =head2 $c->get_actions( $action, $namespace )
1442 Gets all actions of a given name in a namespace and all parent
1447 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1449 =head2 $c->handle_request( $class, @arguments )
1451 Called to handle each HTTP request.
1455 sub handle_request {
1456 my ( $class, @arguments ) = @_;
1458 # Always expect worst case!
1461 if ($class->debug) {
1462 my $secs = time - $START || 1;
1463 my $av = sprintf '%.3f', $COUNT / $secs;
1464 my $time = localtime time;
1465 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1468 my $c = $class->prepare(@arguments);
1470 $status = $c->finalize;
1473 if ( my $error = $@ ) {
1475 $class->log->error(qq/Caught exception in engine "$error"/);
1479 $class->log->_flush() if $class->log->can('_flush');
1483 =head2 $c->prepare( @arguments )
1485 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1491 my ( $class, @arguments ) = @_;
1493 $class->context_class( ref $class || $class ) unless $class->context_class;
1494 my $c = $class->context_class->new(
1498 request => $class->request_class->new(
1501 body_parameters => {},
1503 headers => HTTP::Headers->new,
1505 query_parameters => {},
1511 response => $class->response_class->new(
1515 headers => HTTP::Headers->new(),
1525 $c->stats(Tree::Simple->new([gettimeofday]));
1526 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1529 # For on-demand data
1530 $c->request->{_context} = $c;
1531 $c->response->{_context} = $c;
1532 weaken( $c->request->{_context} );
1533 weaken( $c->response->{_context} );
1535 # Allow engine to direct the prepare flow (for POE)
1536 if ( $c->engine->can('prepare') ) {
1537 $c->engine->prepare( $c, @arguments );
1540 $c->prepare_request(@arguments);
1541 $c->prepare_connection;
1542 $c->prepare_query_parameters;
1543 $c->prepare_headers;
1544 $c->prepare_cookies;
1548 $c->prepare_body unless $c->config->{parse_on_demand};
1551 my $method = $c->req->method || '';
1552 my $path = $c->req->path || '/';
1553 my $address = $c->req->address || '';
1555 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1563 =head2 $c->prepare_action
1565 Prepares action. See L<Catalyst::Dispatcher>.
1569 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1571 =head2 $c->prepare_body
1573 Prepares message body.
1580 # Do we run for the first time?
1581 return if defined $c->request->{_body};
1583 # Initialize on-demand data
1584 $c->engine->prepare_body( $c, @_ );
1585 $c->prepare_parameters;
1586 $c->prepare_uploads;
1588 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1589 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1590 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1591 my $param = $c->req->body_parameters->{$key};
1592 my $value = defined($param) ? $param : '';
1594 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1596 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1600 =head2 $c->prepare_body_chunk( $chunk )
1602 Prepares a chunk of data before sending it to L<HTTP::Body>.
1604 See L<Catalyst::Engine>.
1608 sub prepare_body_chunk {
1610 $c->engine->prepare_body_chunk( $c, @_ );
1613 =head2 $c->prepare_body_parameters
1615 Prepares body parameters.
1619 sub prepare_body_parameters {
1621 $c->engine->prepare_body_parameters( $c, @_ );
1624 =head2 $c->prepare_connection
1626 Prepares connection.
1630 sub prepare_connection {
1632 $c->engine->prepare_connection( $c, @_ );
1635 =head2 $c->prepare_cookies
1641 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1643 =head2 $c->prepare_headers
1649 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1651 =head2 $c->prepare_parameters
1653 Prepares parameters.
1657 sub prepare_parameters {
1659 $c->prepare_body_parameters;
1660 $c->engine->prepare_parameters( $c, @_ );
1663 =head2 $c->prepare_path
1665 Prepares path and base.
1669 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1671 =head2 $c->prepare_query_parameters
1673 Prepares query parameters.
1677 sub prepare_query_parameters {
1680 $c->engine->prepare_query_parameters( $c, @_ );
1682 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1683 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1684 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1685 my $param = $c->req->query_parameters->{$key};
1686 my $value = defined($param) ? $param : '';
1688 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1690 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1694 =head2 $c->prepare_read
1696 Prepares the input for reading.
1700 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1702 =head2 $c->prepare_request
1704 Prepares the engine request.
1708 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1710 =head2 $c->prepare_uploads
1716 sub prepare_uploads {
1719 $c->engine->prepare_uploads( $c, @_ );
1721 if ( $c->debug && keys %{ $c->request->uploads } ) {
1722 my $t = Text::SimpleTable->new(
1723 [ 12, 'Parameter' ],
1728 for my $key ( sort keys %{ $c->request->uploads } ) {
1729 my $upload = $c->request->uploads->{$key};
1730 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1731 $t->row( $key, $u->filename, $u->type, $u->size );
1734 $c->log->debug( "File Uploads are:\n" . $t->draw );
1738 =head2 $c->prepare_write
1740 Prepares the output for writing.
1744 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1746 =head2 $c->request_class
1748 Returns or sets the request class.
1750 =head2 $c->response_class
1752 Returns or sets the response class.
1754 =head2 $c->read( [$maxlength] )
1756 Reads a chunk of data from the request body. This method is designed to
1757 be used in a while loop, reading C<$maxlength> bytes on every call.
1758 C<$maxlength> defaults to the size of the request if not specified.
1760 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1765 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1773 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1775 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1777 Sets an action in a given namespace.
1781 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1783 =head2 $c->setup_actions($component)
1785 Sets up actions for a component.
1789 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1791 =head2 $c->setup_components
1793 Sets up components. Specify a C<setup_components> config option to pass
1794 additional options directly to L<Module::Pluggable>. To add additional
1795 search paths, specify a key named C<search_extra> as an array
1796 reference. Items in the array beginning with C<::> will have the
1797 application class name prepended to them.
1801 sub setup_components {
1804 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1805 my $config = $class->config->{ setup_components };
1806 my $extra = delete $config->{ search_extra } || [];
1808 push @paths, @$extra;
1810 my $locator = Module::Pluggable::Object->new(
1811 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1815 for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
1816 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1818 my $module = $class->setup_component( $component );
1820 $component => $module,
1822 $_ => $class->setup_component( $_ )
1823 } Devel::InnerPackage::list_packages( $component )
1826 for my $key ( keys %modules ) {
1827 $class->components->{ $key } = $modules{ $key };
1832 =head2 $c->setup_component
1836 sub setup_component {
1837 my( $class, $component ) = @_;
1839 unless ( $component->can( 'COMPONENT' ) ) {
1843 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1844 my $config = $class->config->{ $suffix } || {};
1846 my $instance = eval { $component->COMPONENT( $class, $config ); };
1848 if ( my $error = $@ ) {
1850 Catalyst::Exception->throw(
1851 message => qq/Couldn't instantiate component "$component", "$error"/
1855 Catalyst::Exception->throw(
1857 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1858 ) unless eval { $instance->can( 'can' ) };
1863 =head2 $c->setup_dispatcher
1869 sub setup_dispatcher {
1870 my ( $class, $dispatcher ) = @_;
1873 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1876 if ( $ENV{CATALYST_DISPATCHER} ) {
1877 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1880 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1882 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1885 unless ($dispatcher) {
1886 $dispatcher = $class->dispatcher_class;
1889 unless (Class::Inspector->loaded($dispatcher)) {
1890 require Class::Inspector->filename($dispatcher);
1893 # dispatcher instance
1894 $class->dispatcher( $dispatcher->new );
1897 =head2 $c->setup_engine
1904 my ( $class, $engine ) = @_;
1907 $engine = 'Catalyst::Engine::' . $engine;
1910 if ( $ENV{CATALYST_ENGINE} ) {
1911 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1914 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1915 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1918 if ( $ENV{MOD_PERL} ) {
1920 # create the apache method
1923 *{"$class\::apache"} = sub { shift->engine->apache };
1926 my ( $software, $version ) =
1927 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1930 $version =~ s/(\.[^.]+)\./$1/g;
1932 if ( $software eq 'mod_perl' ) {
1936 if ( $version >= 1.99922 ) {
1937 $engine = 'Catalyst::Engine::Apache2::MP20';
1940 elsif ( $version >= 1.9901 ) {
1941 $engine = 'Catalyst::Engine::Apache2::MP19';
1944 elsif ( $version >= 1.24 ) {
1945 $engine = 'Catalyst::Engine::Apache::MP13';
1949 Catalyst::Exception->throw( message =>
1950 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1955 # install the correct mod_perl handler
1956 if ( $version >= 1.9901 ) {
1957 *handler = sub : method {
1958 shift->handle_request(@_);
1962 *handler = sub ($$) { shift->handle_request(@_) };
1967 elsif ( $software eq 'Zeus-Perl' ) {
1968 $engine = 'Catalyst::Engine::Zeus';
1972 Catalyst::Exception->throw(
1973 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1978 $engine = $class->engine_class;
1981 unless (Class::Inspector->loaded($engine)) {
1982 require Class::Inspector->filename($engine);
1985 # check for old engines that are no longer compatible
1987 if ( $engine->isa('Catalyst::Engine::Apache')
1988 && !Catalyst::Engine::Apache->VERSION )
1993 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1994 && Catalyst::Engine::Server->VERSION le '0.02' )
1999 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2000 && $engine->VERSION eq '0.01' )
2005 elsif ($engine->isa('Catalyst::Engine::Zeus')
2006 && $engine->VERSION eq '0.01' )
2012 Catalyst::Exception->throw( message =>
2013 qq/Engine "$engine" is not supported by this version of Catalyst/
2018 $class->engine( $engine->new );
2021 =head2 $c->setup_home
2023 Sets up the home directory.
2028 my ( $class, $home ) = @_;
2030 if ( $ENV{CATALYST_HOME} ) {
2031 $home = $ENV{CATALYST_HOME};
2034 if ( $ENV{ uc($class) . '_HOME' } ) {
2035 $home = $ENV{ uc($class) . '_HOME' };
2039 $home = Catalyst::Utils::home($class);
2043 $class->config->{home} ||= $home;
2044 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2048 =head2 $c->setup_log
2055 my ( $class, $debug ) = @_;
2057 unless ( $class->log ) {
2058 $class->log( Catalyst::Log->new );
2061 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2064 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2065 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2070 *{"$class\::debug"} = sub { 1 };
2071 $class->log->debug('Debug messages enabled');
2075 =head2 $c->setup_plugins
2081 =head2 $c->registered_plugins
2083 Returns a sorted list of the plugins which have either been stated in the
2084 import list or which have been added via C<< MyApp->plugin(@args); >>.
2086 If passed a given plugin name, it will report a boolean value indicating
2087 whether or not that plugin is loaded. A fully qualified name is required if
2088 the plugin name does not begin with C<Catalyst::Plugin::>.
2090 if ($c->registered_plugins('Some::Plugin')) {
2098 sub registered_plugins {
2100 return sort keys %{ $proto->_plugins } unless @_;
2102 return 1 if exists $proto->_plugins->{$plugin};
2103 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2106 sub _register_plugin {
2107 my ( $proto, $plugin, $instant ) = @_;
2108 my $class = ref $proto || $proto;
2110 unless (Class::Inspector->loaded($plugin)) {
2111 require Class::Inspector->filename($plugin);
2114 $proto->_plugins->{$plugin} = 1;
2117 unshift @{"$class\::ISA"}, $plugin;
2123 my ( $class, $plugins ) = @_;
2125 $class->_plugins( {} ) unless $class->_plugins;
2127 for my $plugin ( reverse @$plugins ) {
2129 unless ( $plugin =~ s/\A\+// ) {
2130 $plugin = "Catalyst::Plugin::$plugin";
2133 $class->_register_plugin($plugin);
2140 Returns an arrayref of the internal execution stack (actions that are
2141 currently executing).
2143 =head2 $c->write( $data )
2145 Writes $data to the output stream. When using this method directly, you
2146 will need to manually set the C<Content-Length> header to the length of
2147 your output data, if known.
2154 # Finalize headers if someone manually writes output
2155 $c->finalize_headers;
2157 return $c->engine->write( $c, @_ );
2162 Returns the Catalyst version number. Mostly useful for "powered by"
2163 messages in template systems.
2167 sub version { return $Catalyst::VERSION }
2169 =head1 INTERNAL ACTIONS
2171 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2172 C<_ACTION>, and C<_END>. These are by default not shown in the private
2173 action table, but you can make them visible with a config parameter.
2175 MyApp->config->{show_internal_actions} = 1;
2177 =head1 CASE SENSITIVITY
2179 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2180 mapped to C</foo/bar>. You can activate case sensitivity with a config
2183 MyApp->config->{case_sensitive} = 1;
2185 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2187 =head1 ON-DEMAND PARSER
2189 The request body is usually parsed at the beginning of a request,
2190 but if you want to handle input yourself or speed things up a bit,
2191 you can enable on-demand parsing with a config parameter.
2193 MyApp->config->{parse_on_demand} = 1;
2195 =head1 PROXY SUPPORT
2197 Many production servers operate using the common double-server approach,
2198 with a lightweight frontend web server passing requests to a larger
2199 backend server. An application running on the backend server must deal
2200 with two problems: the remote user always appears to be C<127.0.0.1> and
2201 the server's hostname will appear to be C<localhost> regardless of the
2202 virtual host that the user connected through.
2204 Catalyst will automatically detect this situation when you are running
2205 the frontend and backend servers on the same machine. The following
2206 changes are made to the request.
2208 $c->req->address is set to the user's real IP address, as read from
2209 the HTTP X-Forwarded-For header.
2211 The host value for $c->req->base and $c->req->uri is set to the real
2212 host, as read from the HTTP X-Forwarded-Host header.
2214 Obviously, your web server must support these headers for this to work.
2216 In a more complex server farm environment where you may have your
2217 frontend proxy server(s) on different machines, you will need to set a
2218 configuration option to tell Catalyst to read the proxied data from the
2221 MyApp->config->{using_frontend_proxy} = 1;
2223 If you do not wish to use the proxy support at all, you may set:
2225 MyApp->config->{ignore_frontend_proxy} = 1;
2227 =head1 THREAD SAFETY
2229 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2230 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2231 believe the Catalyst core to be thread-safe.
2233 If you plan to operate in a threaded environment, remember that all other
2234 modules you are using must also be thread-safe. Some modules, most notably
2235 L<DBD::SQLite>, are not thread-safe.
2241 Join #catalyst on irc.perl.org.
2245 http://lists.rawmode.org/mailman/listinfo/catalyst
2246 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2250 http://catalyst.perl.org
2254 http://dev.catalyst.perl.org
2258 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2260 =head2 L<Catalyst::Manual> - The Catalyst Manual
2262 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2264 =head2 L<Catalyst::Engine> - Core engine
2266 =head2 L<Catalyst::Log> - Log class.
2268 =head2 L<Catalyst::Request> - Request object
2270 =head2 L<Catalyst::Response> - Response object
2272 =head2 L<Catalyst::Test> - The test suite.
2344 Sebastian Riedel, C<sri@oook.de>
2348 This library is free software, you can redistribute it and/or modify it under
2349 the same terms as Perl itself.