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.7007';
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 See the L<Catalyst::Manual> distribution for comprehensive
91 documentation and tutorials.
93 # Install Catalyst::Devel for helpers and other development tools
94 # use the helper to create a new application
97 # add models, views, controllers
98 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
99 script/myapp_create.pl view MyTemplate TT
100 script/myapp_create.pl controller Search
102 # built in testserver -- use -r to restart automatically on changes
103 # --help to see all available options
104 script/myapp_server.pl
106 # command line testing interface
107 script/myapp_test.pl /yada
110 use Catalyst qw/-Debug/; # include plugins here as well
112 ### In lib/MyApp/Controller/Root.pm (autocreated)
113 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
114 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
115 $c->stash->{template} = 'foo.tt'; # set the template
116 # lookup something from db -- stash vars are passed to TT
118 $c->model('Database::Foo')->search( { country => $args[0] } );
119 if ( $c->req->params->{bar} ) { # access GET or POST parameters
120 $c->forward( 'bar' ); # process another action
121 # do something else after forward returns
125 # The foo.tt TT template can use the stash data from the database
126 [% WHILE (item = data.next) %]
130 # called for /bar/of/soap, /bar/of/soap/10, etc.
131 sub bar : Path('/bar/of/soap') { ... }
133 # called for all actions, from the top-most controller downwards
135 my ( $self, $c ) = @_;
136 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
137 $c->res->redirect( '/login' ); # require login
138 return 0; # abort request and go immediately to end()
140 return 1; # success; carry on to next action
143 # called after all actions are finished
145 my ( $self, $c ) = @_;
146 if ( scalar @{ $c->error } ) { ... } # handle errors
147 return if $c->res->body; # already have a response
148 $c->forward( 'MyApp::View::TT' ); # render template
151 ### in MyApp/Controller/Foo.pm
152 # called for /foo/bar
153 sub bar : Local { ... }
155 # called for /blargle
156 sub blargle : Global { ... }
158 # an index action matches /foo, but not /foo/1, etc.
159 sub index : Private { ... }
161 ### in MyApp/Controller/Foo/Bar.pm
162 # called for /foo/bar/baz
163 sub baz : Local { ... }
165 # first Root auto is called, then Foo auto, then this
166 sub auto : Private { ... }
168 # powerful regular expression paths are also possible
169 sub details : Regex('^product/(\w+)/details$') {
170 my ( $self, $c ) = @_;
171 # extract the (\w+) from the URI
172 my $product = $c->req->captures->[0];
175 See L<Catalyst::Manual::Intro> for additional information.
179 Catalyst is a modern framework for making web applications without the
180 pain usually associated with this process. This document is a reference
181 to the main Catalyst application. If you are a new user, we suggest you
182 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
184 See L<Catalyst::Manual> for more documentation.
186 Catalyst plugins can be loaded by naming them as arguments to the "use
187 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
188 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
191 use Catalyst qw/My::Module/;
193 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
194 fully qualify the name by using a unary plus:
198 +Fully::Qualified::Plugin::Name
201 Special flags like C<-Debug> and C<-Engine> can also be specified as
202 arguments when Catalyst is loaded:
204 use Catalyst qw/-Debug My::Module/;
206 The position of plugins and flags in the chain is important, because
207 they are loaded in the order in which they appear.
209 The following flags are supported:
213 Enables debug output. You can also force this setting from the system
214 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
215 settings override the application, with <MYAPP>_DEBUG having the highest
220 Forces Catalyst to use a specific engine. Omit the
221 C<Catalyst::Engine::> prefix of the engine name, i.e.:
223 use Catalyst qw/-Engine=CGI/;
227 Forces Catalyst to use a specific home directory, e.g.:
229 use Catalyst qw[-Home=/usr/mst];
231 This can also be done in the shell environment by setting either the
232 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
233 is replaced with the uppercased name of your application, any "::" in
234 the name will be replaced with underscores, e.g. MyApp::Web should use
235 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
243 =head2 INFORMATION ABOUT THE CURRENT REQUEST
247 Returns a L<Catalyst::Action> object for the current action, which
248 stringifies to the action name. See L<Catalyst::Action>.
252 Returns the namespace of the current action, i.e., the URI prefix
253 corresponding to the controller of the current action. For example:
255 # in Controller::Foo::Bar
256 $c->namespace; # returns 'foo/bar';
262 Returns the current L<Catalyst::Request> object, giving access to
263 information about the current client request (including parameters,
264 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
266 =head2 REQUEST FLOW HANDLING
268 =head2 $c->forward( $action [, \@arguments ] )
270 =head2 $c->forward( $class, $method, [, \@arguments ] )
272 Forwards processing to another action, by its private name. If you give a
273 class name but no method, C<process()> is called. You may also optionally
274 pass arguments in an arrayref. The action will receive the arguments in
275 C<@_> and C<< $c->req->args >>. Upon returning from the function,
276 C<< $c->req->args >> will be restored to the previous values.
278 Any data C<return>ed from the action forwarded to, will be returned by the
281 my $foodata = $c->forward('/foo');
282 $c->forward('index');
283 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
284 $c->forward('MyApp::View::TT');
286 Note that forward implies an C<<eval { }>> around the call (actually
287 C<execute> does), thus de-fatalizing all 'dies' within the called
288 action. If you want C<die> to propagate you need to do something like:
291 die $c->error if $c->error;
293 Or make sure to always return true values from your actions and write
296 $c->forward('foo') || return;
300 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
302 =head2 $c->detach( $action [, \@arguments ] )
304 =head2 $c->detach( $class, $method, [, \@arguments ] )
308 The same as C<forward>, but doesn't return to the previous action when
309 processing is finished.
311 When called with no arguments it escapes the processing chain entirely.
315 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
321 Returns the current L<Catalyst::Response> object, see there for details.
325 Returns a hashref to the stash, which may be used to store data and pass
326 it between components during a request. You can also set hash keys by
327 passing arguments. The stash is automatically sent to the view. The
328 stash is cleared at the end of a request; it cannot be used for
329 persistent storage (for this you must use a session; see
330 L<Catalyst::Plugin::Session> for a complete system integrated with
333 $c->stash->{foo} = $bar;
334 $c->stash( { moose => 'majestic', qux => 0 } );
335 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
337 # stash is automatically passed to the view for use in a template
338 $c->forward( 'MyApp::View::TT' );
345 my $stash = @_ > 1 ? {@_} : $_[0];
346 croak('stash takes a hash or hashref') unless ref $stash;
347 foreach my $key ( keys %$stash ) {
348 $c->{stash}->{$key} = $stash->{$key};
356 =head2 $c->error($error, ...)
358 =head2 $c->error($arrayref)
360 Returns an arrayref containing error messages. If Catalyst encounters an
361 error while processing a request, it stores the error in $c->error. This
362 method should only be used to store fatal error messages.
364 my @error = @{ $c->error };
368 $c->error('Something bad happened');
375 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
376 croak @$error unless ref $c;
377 push @{ $c->{error} }, @$error;
379 elsif ( defined $_[0] ) { $c->{error} = undef }
380 return $c->{error} || [];
386 Contains the return value of the last executed action.
388 =head2 $c->clear_errors
390 Clear errors. You probably don't want to clear the errors unless you are
391 implementing a custom error screen.
393 This is equivalent to running
407 my ( $c, @names ) = @_;
409 foreach my $name (@names) {
410 foreach my $component ( keys %{ $c->components } ) {
411 return $c->components->{$component} if $component =~ /$name/i;
418 # try explicit component names
420 my ( $c, @names ) = @_;
422 foreach my $try (@names) {
423 return $c->components->{$try} if ( exists $c->components->{$try} );
429 # like component, but try just these prefixes before regex searching,
430 # and do not try to return "sort keys %{ $c->components }"
432 my ( $c, $name, @prefixes ) = @_;
434 my $appclass = ref $c || $c;
436 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
438 my $comp = $c->_comp_explicit(@names);
439 return $comp if defined($comp);
440 $comp = $c->_comp_search($name);
444 # Find possible names for a prefix
447 my ( $c, @prefixes ) = @_;
449 my $appclass = ref $c || $c;
451 my @pre = map { "${appclass}::${_}::" } @prefixes;
455 COMPONENT: foreach my $comp ($c->component) {
456 foreach my $p (@pre) {
457 if ($comp =~ s/^$p//) {
467 # Return a component if only one matches.
469 my ( $c, @prefixes ) = @_;
471 my $appclass = ref $c || $c;
473 my ( $comp, $rest ) =
474 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
475 return $comp unless $rest;
478 # Filter a component before returning by calling ACCEPT_CONTEXT if available
479 sub _filter_component {
480 my ( $c, $comp, @args ) = @_;
481 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
482 return $comp->ACCEPT_CONTEXT( $c, @args );
484 else { return $comp }
487 =head2 COMPONENT ACCESSORS
489 =head2 $c->controller($name)
491 Gets a L<Catalyst::Controller> instance by name.
493 $c->controller('Foo')->do_stuff;
495 If the name is omitted, will return the controller for the dispatched
501 my ( $c, $name, @args ) = @_;
502 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
505 return $c->component( $c->action->class );
508 =head2 $c->model($name)
510 Gets a L<Catalyst::Model> instance by name.
512 $c->model('Foo')->do_stuff;
514 If the name is omitted, it will look for
515 - a model object in $c->stash{current_model_instance}, then
516 - a model name in $c->stash->{current_model}, then
517 - a config setting 'default_model', or
518 - check if there is only one model, and return it if that's the case.
523 my ( $c, $name, @args ) = @_;
524 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
528 return $c->stash->{current_model_instance}
529 if $c->stash->{current_model_instance};
530 return $c->model( $c->stash->{current_model} )
531 if $c->stash->{current_model};
532 return $c->model( $c->config->{default_model} )
533 if $c->config->{default_model};
535 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
539 =head2 $c->controllers
541 Returns the available names which can be passed to $c->controller
547 return $c->_comp_names(qw/Controller C/);
551 =head2 $c->view($name)
553 Gets a L<Catalyst::View> instance by name.
555 $c->view('Foo')->do_stuff;
557 If the name is omitted, it will look for
558 - a view object in $c->stash{current_view_instance}, then
559 - a view name in $c->stash->{current_view}, then
560 - a config setting 'default_view', or
561 - check if there is only one view, and return it if that's the case.
566 my ( $c, $name, @args ) = @_;
567 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
571 return $c->stash->{current_view_instance}
572 if $c->stash->{current_view_instance};
573 return $c->view( $c->stash->{current_view} )
574 if $c->stash->{current_view};
575 return $c->view( $c->config->{default_view} )
576 if $c->config->{default_view};
578 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
583 Returns the available names which can be passed to $c->model
589 return $c->_comp_names(qw/Model M/);
595 Returns the available names which can be passed to $c->view
601 return $c->_comp_names(qw/View V/);
604 =head2 $c->comp($name)
606 =head2 $c->component($name)
608 Gets a component object by name. This method is not recommended,
609 unless you want to get a specific component by full
610 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
611 should be used instead.
622 my $appclass = ref $c || $c;
625 $name, "${appclass}::${name}",
626 map { "${appclass}::${_}::${name}" }
627 qw/Model M Controller C View V/
630 my $comp = $c->_comp_explicit(@names);
631 return $c->_filter_component( $comp, @_ ) if defined($comp);
633 $comp = $c->_comp_search($name);
634 return $c->_filter_component( $comp, @_ ) if defined($comp);
637 return sort keys %{ $c->components };
642 =head2 CLASS DATA AND HELPER CLASSES
646 Returns or takes a hashref containing the application's configuration.
648 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
650 You can also use a C<YAML>, C<XML> or C<Config::General> config file
651 like myapp.yml in your applications home directory. See
652 L<Catalyst::Plugin::ConfigLoader>.
655 db: dsn:SQLite:foo.db
663 $c->log->warn("Setting config after setup has been run is not a good idea.")
664 if ( @_ and $c->setup_finished );
666 $c->NEXT::config(@_);
671 Returns the logging object instance. Unless it is already set, Catalyst
672 sets this up with a L<Catalyst::Log> object. To use your own log class,
673 set the logger with the C<< __PACKAGE__->log >> method prior to calling
674 C<< __PACKAGE__->setup >>.
676 __PACKAGE__->log( MyLogger->new );
681 $c->log->info( 'Now logging with my own logger!' );
683 Your log class should implement the methods described in
689 Overload to enable debug messages (same as -Debug option).
691 Note that this is a static method, not an accessor and should be overloaded
692 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
698 =head2 $c->dispatcher
700 Returns the dispatcher instance. Stringifies to class name. See
701 L<Catalyst::Dispatcher>.
705 Returns the engine instance. Stringifies to the class name. See
709 =head2 UTILITY METHODS
711 =head2 $c->path_to(@path)
713 Merges C<@path> with C<< $c->config->{home} >> and returns a
714 L<Path::Class::Dir> object.
718 $c->path_to( 'db', 'sqlite.db' );
723 my ( $c, @path ) = @_;
724 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
725 if ( -d $path ) { return $path }
726 else { return Path::Class::File->new( $c->config->{home}, @path ) }
729 =head2 $c->plugin( $name, $class, @args )
731 Helper method for plugins. It creates a classdata accessor/mutator and
732 loads and instantiates the given class.
734 MyApp->plugin( 'prototype', 'HTML::Prototype' );
736 $c->prototype->define_javascript_functions;
741 my ( $class, $name, $plugin, @args ) = @_;
742 $class->_register_plugin( $plugin, 1 );
744 eval { $plugin->import };
745 $class->mk_classdata($name);
747 eval { $obj = $plugin->new(@args) };
750 Catalyst::Exception->throw( message =>
751 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
755 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
761 Initializes the dispatcher and engine, loads any plugins, and loads the
762 model, view, and controller components. You may also specify an array
763 of plugins to load here, if you choose to not load them in the C<use
767 MyApp->setup( qw/-Debug/ );
772 my ( $class, @arguments ) = @_;
774 $class->log->warn("Running setup twice is not a good idea.")
775 if ( $class->setup_finished );
777 unless ( $class->isa('Catalyst') ) {
779 Catalyst::Exception->throw(
780 message => qq/'$class' does not inherit from Catalyst/ );
783 if ( $class->arguments ) {
784 @arguments = ( @arguments, @{ $class->arguments } );
790 foreach (@arguments) {
794 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
796 elsif (/^-(\w+)=?(.*)$/) {
797 $flags->{ lc $1 } = $2;
800 push @{ $flags->{plugins} }, $_;
804 $class->setup_home( delete $flags->{home} );
806 $class->setup_log( delete $flags->{log} );
807 $class->setup_plugins( delete $flags->{plugins} );
808 $class->setup_dispatcher( delete $flags->{dispatcher} );
809 $class->setup_engine( delete $flags->{engine} );
811 for my $flag ( sort keys %{$flags} ) {
813 if ( my $code = $class->can( 'setup_' . $flag ) ) {
814 &$code( $class, delete $flags->{$flag} );
817 $class->log->warn(qq/Unknown flag "$flag"/);
821 eval { require Catalyst::Devel; };
822 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
823 $class->log->warn(<<"EOF");
824 You are running an old script!
826 Please update by running (this will overwrite existing files):
827 catalyst.pl -force -scripts $class
829 or (this will not overwrite existing files):
830 catalyst.pl -scripts $class
835 if ( $class->debug ) {
836 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
839 my $t = Text::SimpleTable->new(74);
840 $t->row($_) for @plugins;
841 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
844 my $dispatcher = $class->dispatcher;
845 my $engine = $class->engine;
846 my $home = $class->config->{home};
848 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
849 $class->log->debug(qq/Loaded engine "$engine"/);
853 ? $class->log->debug(qq/Found home "$home"/)
854 : $class->log->debug(qq/Home "$home" doesn't exist/)
855 : $class->log->debug(q/Couldn't find home/);
860 no warnings qw/redefine/;
861 local *setup = sub { };
865 # Initialize our data structure
866 $class->components( {} );
868 $class->setup_components;
870 if ( $class->debug ) {
871 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
872 for my $comp ( sort keys %{ $class->components } ) {
873 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
874 $t->row( $comp, $type );
876 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
877 if ( keys %{ $class->components } );
880 # Add our self to components, since we are also a component
881 $class->components->{$class} = $class;
883 $class->setup_actions;
885 if ( $class->debug ) {
886 my $name = $class->config->{name} || 'Application';
887 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
889 $class->log->_flush() if $class->log->can('_flush');
891 $class->setup_finished(1);
894 =head2 $c->uri_for( $path, @args?, \%query_values? )
896 Merges path with C<< $c->request->base >> for absolute URIs and with
897 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
898 object. If any args are passed, they are added at the end of the path.
899 If the last argument to C<uri_for> is a hash reference, it is assumed to
900 contain GET parameter key/value pairs, which will be appended to the URI
903 Instead of C<$path>, you can also optionally pass a C<$action> object
904 which will be resolved to a path using
905 C<< $c->dispatcher->uri_for_action >>; if the first element of
906 C<@args> is an arrayref it is treated as a list of captures to be passed
907 to C<uri_for_action>.
912 my ( $c, $path, @args ) = @_;
913 my $base = $c->request->base->clone;
914 my $basepath = $base->path;
915 $basepath =~ s/\/$//;
917 my $namespace = $c->namespace || '';
919 if ( Scalar::Util::blessed($path) ) { # action object
920 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
923 $path = $c->dispatcher->uri_for_action($path, $captures);
924 return undef unless defined($path);
925 $path = '/' if $path eq '';
928 # massage namespace, empty if absolute path
929 $namespace =~ s/^\/// if $namespace;
930 $namespace .= '/' if $namespace;
932 $namespace = '' if $path =~ /^\//;
937 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
939 for my $value ( values %$params ) {
940 next unless defined $value;
941 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
947 # join args with '/', or a blank string
948 my $args = ( scalar @args ? '/' . join( '/', map {s/\?/%3F/g; $_} @args ) : '' );
949 $args =~ s/^\/// unless $path;
951 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
953 $res->query_form(%$params);
957 =head2 $c->welcome_message
959 Returns the Catalyst welcome HTML page.
963 sub welcome_message {
965 my $name = $c->config->{name};
966 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
967 my $prefix = Catalyst::Utils::appprefix( ref $c );
968 $c->response->content_type('text/html; charset=utf-8');
970 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
971 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
972 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
974 <meta http-equiv="Content-Language" content="en" />
975 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
976 <title>$name on Catalyst $VERSION</title>
977 <style type="text/css">
980 background-color: #eee;
989 background-color: #ccc;
990 border: 1px solid #aaa;
995 font-family: verdana, tahoma, sans-serif;
998 font-family: verdana, tahoma, sans-serif;
1001 text-decoration: none;
1003 border-bottom: 1px dotted #bbb;
1005 :link:hover, :visited:hover {
1018 background-color: #fff;
1019 border: 1px solid #aaa;
1023 font-weight: normal;
1045 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1050 <img src="$logo" alt="Catalyst Logo" />
1052 <p>Welcome to the world of Catalyst.
1053 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1054 framework will make web development something you had
1055 never expected it to be: Fun, rewarding, and quick.</p>
1056 <h2>What to do now?</h2>
1057 <p>That really depends on what <b>you</b> want to do.
1058 We do, however, provide you with a few starting points.</p>
1059 <p>If you want to jump right into web development with Catalyst
1060 you might want want to start with a tutorial.</p>
1061 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1063 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1065 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1066 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1068 <h2>What to do next?</h2>
1069 <p>Next it's time to write an actual application. Use the
1070 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1071 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1072 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1073 they can save you a lot of work.</p>
1074 <pre><code>script/${prefix}_create.pl -help</code></pre>
1075 <p>Also, be sure to check out the vast and growing
1076 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1077 you are likely to find what you need there.
1081 <p>Catalyst has a very active community. Here are the main places to
1082 get in touch with us.</p>
1085 <a href="http://dev.catalyst.perl.org">Wiki</a>
1088 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1091 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1094 <h2>In conclusion</h2>
1095 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1096 as we enjoyed making it. Please contact us if you have ideas
1097 for improvement or other feedback.</p>
1105 =head1 INTERNAL METHODS
1107 These methods are not meant to be used by end users.
1109 =head2 $c->components
1111 Returns a hash of components.
1113 =head2 $c->context_class
1115 Returns or sets the context class.
1119 Returns a hashref containing coderefs and execution counts (needed for
1120 deep recursion detection).
1124 Returns the number of actions on the current internal execution stack.
1128 Dispatches a request to actions.
1132 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1134 =head2 $c->dispatcher_class
1136 Returns or sets the dispatcher class.
1138 =head2 $c->dump_these
1140 Returns a list of 2-element array references (name, structure) pairs
1141 that will be dumped on the error page in debug mode.
1147 [ Request => $c->req ],
1148 [ Response => $c->res ],
1149 [ Stash => $c->stash ],
1150 [ Config => $c->config ];
1153 =head2 $c->engine_class
1155 Returns or sets the engine class.
1157 =head2 $c->execute( $class, $coderef )
1159 Execute a coderef in given class and catch exceptions. Errors are available
1165 my ( $c, $class, $code ) = @_;
1166 $class = $c->component($class) || $class;
1169 if ( $c->depth >= $RECURSION ) {
1170 my $action = "$code";
1171 $action = "/$action" unless $action =~ /->/;
1172 my $error = qq/Deep recursion detected calling "$action"/;
1173 $c->log->error($error);
1179 my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
1181 push( @{ $c->stack }, $code );
1183 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1185 $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
1187 my $last = pop( @{ $c->stack } );
1189 if ( my $error = $@ ) {
1190 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1192 unless ( ref $error ) {
1193 no warnings 'uninitialized';
1195 my $class = $last->class;
1196 my $name = $last->name;
1197 $error = qq/Caught exception in $class->$name "$error"/;
1206 sub _stats_start_execute {
1207 my ( $c, $code ) = @_;
1209 return if ( ( $code->name =~ /^_.*/ )
1210 && ( !$c->config->{show_internal_actions} ) );
1212 $c->counter->{"$code"}++;
1214 my $action = "$code";
1215 $action = "/$action" unless $action =~ /->/;
1217 # determine if the call was the result of a forward
1218 # this is done by walking up the call stack and looking for a calling
1219 # sub of Catalyst::forward before the eval
1221 for my $index ( 2 .. 11 ) {
1223 if ( ( caller($index) )[0] eq 'Catalyst'
1224 && ( caller($index) )[3] eq '(eval)' );
1226 if ( ( caller($index) )[3] =~ /forward$/ ) {
1227 $callsub = ( caller($index) )[3];
1228 $action = "-> $action";
1233 my $node = Tree::Simple->new(
1236 elapsed => undef, # to be filled in later
1240 $node->setUID( "$code" . $c->counter->{"$code"} );
1242 # is this a root-level call or a forwarded call?
1243 if ( $callsub =~ /forward$/ ) {
1245 # forward, locate the caller
1246 if ( my $parent = $c->stack->[-1] ) {
1247 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1248 $visitor->searchForUID(
1249 "$parent" . $c->counter->{"$parent"} );
1250 $c->stats->accept($visitor);
1251 if ( my $result = $visitor->getResult ) {
1252 $result->addChild($node);
1257 # forward with no caller may come from a plugin
1258 $c->stats->addChild($node);
1264 $c->stats->addChild($node);
1268 start => [gettimeofday],
1273 sub _stats_finish_execute {
1274 my ( $c, $info ) = @_;
1275 my $elapsed = tv_interval $info->{start};
1276 my $value = $info->{node}->getNodeValue;
1277 $value->{elapsed} = sprintf( '%fs', $elapsed );
1280 =head2 $c->_localize_fields( sub { }, \%keys );
1284 sub _localize_fields {
1285 my ( $c, $localized, $code ) = ( @_ );
1287 my $request = delete $localized->{request} || {};
1288 my $response = delete $localized->{response} || {};
1290 local @{ $c }{ keys %$localized } = values %$localized;
1291 local @{ $c->request }{ keys %$request } = values %$request;
1292 local @{ $c->response }{ keys %$response } = values %$response;
1299 Finalizes the request.
1306 for my $error ( @{ $c->error } ) {
1307 $c->log->error($error);
1310 # Allow engine to handle finalize flow (for POE)
1311 if ( $c->engine->can('finalize') ) {
1312 $c->engine->finalize($c);
1316 $c->finalize_uploads;
1319 if ( $#{ $c->error } >= 0 ) {
1323 $c->finalize_headers;
1326 if ( $c->request->method eq 'HEAD' ) {
1327 $c->response->body('');
1334 my $elapsed = sprintf '%f', tv_interval($c->stats->getNodeValue);
1335 my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1337 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1338 $c->stats->traverse(
1341 my $stat = $action->getNodeValue;
1342 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1343 $stat->{elapsed} || '??' );
1348 "Request took ${elapsed}s ($av/s)\n" . $t->draw . "\n" );
1351 return $c->response->status;
1354 =head2 $c->finalize_body
1360 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1362 =head2 $c->finalize_cookies
1368 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1370 =head2 $c->finalize_error
1376 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1378 =head2 $c->finalize_headers
1384 sub finalize_headers {
1387 # Check if we already finalized headers
1388 return if $c->response->{_finalized_headers};
1391 if ( my $location = $c->response->redirect ) {
1392 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1393 $c->response->header( Location => $location );
1395 if ( !$c->response->body ) {
1396 # Add a default body if none is already present
1398 "<p>This item has moved <a href=\"$location\">here</a>.</p>"
1404 if ( $c->response->body && !$c->response->content_length ) {
1406 # get the length from a filehandle
1407 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1409 if ( my $stat = stat $c->response->body ) {
1410 $c->response->content_length( $stat->size );
1413 $c->log->warn('Serving filehandle without a content-length');
1417 $c->response->content_length( bytes::length( $c->response->body ) );
1422 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1423 $c->response->headers->remove_header("Content-Length");
1424 $c->response->body('');
1427 $c->finalize_cookies;
1429 $c->engine->finalize_headers( $c, @_ );
1432 $c->response->{_finalized_headers} = 1;
1435 =head2 $c->finalize_output
1437 An alias for finalize_body.
1439 =head2 $c->finalize_read
1441 Finalizes the input after reading is complete.
1445 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1447 =head2 $c->finalize_uploads
1449 Finalizes uploads. Cleans up any temporary files.
1453 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1455 =head2 $c->get_action( $action, $namespace )
1457 Gets an action in a given namespace.
1461 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1463 =head2 $c->get_actions( $action, $namespace )
1465 Gets all actions of a given name in a namespace and all parent
1470 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1472 =head2 $c->handle_request( $class, @arguments )
1474 Called to handle each HTTP request.
1478 sub handle_request {
1479 my ( $class, @arguments ) = @_;
1481 # Always expect worst case!
1484 if ($class->debug) {
1485 my $secs = time - $START || 1;
1486 my $av = sprintf '%.3f', $COUNT / $secs;
1487 my $time = localtime time;
1488 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1491 my $c = $class->prepare(@arguments);
1493 $status = $c->finalize;
1496 if ( my $error = $@ ) {
1498 $class->log->error(qq/Caught exception in engine "$error"/);
1502 $class->log->_flush() if $class->log->can('_flush');
1506 =head2 $c->prepare( @arguments )
1508 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1514 my ( $class, @arguments ) = @_;
1516 $class->context_class( ref $class || $class ) unless $class->context_class;
1517 my $c = $class->context_class->new(
1521 request => $class->request_class->new(
1524 body_parameters => {},
1526 headers => HTTP::Headers->new,
1528 query_parameters => {},
1534 response => $class->response_class->new(
1538 headers => HTTP::Headers->new(),
1548 $c->stats(Tree::Simple->new([gettimeofday]));
1549 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1552 # For on-demand data
1553 $c->request->{_context} = $c;
1554 $c->response->{_context} = $c;
1555 weaken( $c->request->{_context} );
1556 weaken( $c->response->{_context} );
1558 # Allow engine to direct the prepare flow (for POE)
1559 if ( $c->engine->can('prepare') ) {
1560 $c->engine->prepare( $c, @arguments );
1563 $c->prepare_request(@arguments);
1564 $c->prepare_connection;
1565 $c->prepare_query_parameters;
1566 $c->prepare_headers;
1567 $c->prepare_cookies;
1571 $c->prepare_body unless $c->config->{parse_on_demand};
1574 my $method = $c->req->method || '';
1575 my $path = $c->req->path || '/';
1576 my $address = $c->req->address || '';
1578 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1586 =head2 $c->prepare_action
1588 Prepares action. See L<Catalyst::Dispatcher>.
1592 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1594 =head2 $c->prepare_body
1596 Prepares message body.
1603 # Do we run for the first time?
1604 return if defined $c->request->{_body};
1606 # Initialize on-demand data
1607 $c->engine->prepare_body( $c, @_ );
1608 $c->prepare_parameters;
1609 $c->prepare_uploads;
1611 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1612 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1613 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1614 my $param = $c->req->body_parameters->{$key};
1615 my $value = defined($param) ? $param : '';
1617 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1619 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1623 =head2 $c->prepare_body_chunk( $chunk )
1625 Prepares a chunk of data before sending it to L<HTTP::Body>.
1627 See L<Catalyst::Engine>.
1631 sub prepare_body_chunk {
1633 $c->engine->prepare_body_chunk( $c, @_ );
1636 =head2 $c->prepare_body_parameters
1638 Prepares body parameters.
1642 sub prepare_body_parameters {
1644 $c->engine->prepare_body_parameters( $c, @_ );
1647 =head2 $c->prepare_connection
1649 Prepares connection.
1653 sub prepare_connection {
1655 $c->engine->prepare_connection( $c, @_ );
1658 =head2 $c->prepare_cookies
1664 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1666 =head2 $c->prepare_headers
1672 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1674 =head2 $c->prepare_parameters
1676 Prepares parameters.
1680 sub prepare_parameters {
1682 $c->prepare_body_parameters;
1683 $c->engine->prepare_parameters( $c, @_ );
1686 =head2 $c->prepare_path
1688 Prepares path and base.
1692 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1694 =head2 $c->prepare_query_parameters
1696 Prepares query parameters.
1700 sub prepare_query_parameters {
1703 $c->engine->prepare_query_parameters( $c, @_ );
1705 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1706 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1707 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1708 my $param = $c->req->query_parameters->{$key};
1709 my $value = defined($param) ? $param : '';
1711 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1713 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1717 =head2 $c->prepare_read
1719 Prepares the input for reading.
1723 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1725 =head2 $c->prepare_request
1727 Prepares the engine request.
1731 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1733 =head2 $c->prepare_uploads
1739 sub prepare_uploads {
1742 $c->engine->prepare_uploads( $c, @_ );
1744 if ( $c->debug && keys %{ $c->request->uploads } ) {
1745 my $t = Text::SimpleTable->new(
1746 [ 12, 'Parameter' ],
1751 for my $key ( sort keys %{ $c->request->uploads } ) {
1752 my $upload = $c->request->uploads->{$key};
1753 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1754 $t->row( $key, $u->filename, $u->type, $u->size );
1757 $c->log->debug( "File Uploads are:\n" . $t->draw );
1761 =head2 $c->prepare_write
1763 Prepares the output for writing.
1767 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1769 =head2 $c->request_class
1771 Returns or sets the request class.
1773 =head2 $c->response_class
1775 Returns or sets the response class.
1777 =head2 $c->read( [$maxlength] )
1779 Reads a chunk of data from the request body. This method is designed to
1780 be used in a while loop, reading C<$maxlength> bytes on every call.
1781 C<$maxlength> defaults to the size of the request if not specified.
1783 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1788 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1796 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1798 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1800 Sets an action in a given namespace.
1804 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1806 =head2 $c->setup_actions($component)
1808 Sets up actions for a component.
1812 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1814 =head2 $c->setup_components
1816 Sets up components. Specify a C<setup_components> config option to pass
1817 additional options directly to L<Module::Pluggable>. To add additional
1818 search paths, specify a key named C<search_extra> as an array
1819 reference. Items in the array beginning with C<::> will have the
1820 application class name prepended to them.
1824 sub setup_components {
1827 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1828 my $config = $class->config->{ setup_components };
1829 my $extra = delete $config->{ search_extra } || [];
1831 push @paths, @$extra;
1833 my $locator = Module::Pluggable::Object->new(
1834 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1838 for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
1839 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1841 my $module = $class->setup_component( $component );
1843 $component => $module,
1845 $_ => $class->setup_component( $_ )
1846 } Devel::InnerPackage::list_packages( $component )
1849 for my $key ( keys %modules ) {
1850 $class->components->{ $key } = $modules{ $key };
1855 =head2 $c->setup_component
1859 sub setup_component {
1860 my( $class, $component ) = @_;
1862 unless ( $component->can( 'COMPONENT' ) ) {
1866 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1867 my $config = $class->config->{ $suffix } || {};
1869 my $instance = eval { $component->COMPONENT( $class, $config ); };
1871 if ( my $error = $@ ) {
1873 Catalyst::Exception->throw(
1874 message => qq/Couldn't instantiate component "$component", "$error"/
1878 Catalyst::Exception->throw(
1880 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1881 ) unless eval { $instance->can( 'can' ) };
1886 =head2 $c->setup_dispatcher
1892 sub setup_dispatcher {
1893 my ( $class, $dispatcher ) = @_;
1896 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1899 if ( $ENV{CATALYST_DISPATCHER} ) {
1900 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1903 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1905 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1908 unless ($dispatcher) {
1909 $dispatcher = $class->dispatcher_class;
1912 unless (Class::Inspector->loaded($dispatcher)) {
1913 require Class::Inspector->filename($dispatcher);
1916 # dispatcher instance
1917 $class->dispatcher( $dispatcher->new );
1920 =head2 $c->setup_engine
1927 my ( $class, $engine ) = @_;
1930 $engine = 'Catalyst::Engine::' . $engine;
1933 if ( $ENV{CATALYST_ENGINE} ) {
1934 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1937 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1938 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1941 if ( $ENV{MOD_PERL} ) {
1943 # create the apache method
1946 *{"$class\::apache"} = sub { shift->engine->apache };
1949 my ( $software, $version ) =
1950 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1953 $version =~ s/(\.[^.]+)\./$1/g;
1955 if ( $software eq 'mod_perl' ) {
1959 if ( $version >= 1.99922 ) {
1960 $engine = 'Catalyst::Engine::Apache2::MP20';
1963 elsif ( $version >= 1.9901 ) {
1964 $engine = 'Catalyst::Engine::Apache2::MP19';
1967 elsif ( $version >= 1.24 ) {
1968 $engine = 'Catalyst::Engine::Apache::MP13';
1972 Catalyst::Exception->throw( message =>
1973 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1978 # install the correct mod_perl handler
1979 if ( $version >= 1.9901 ) {
1980 *handler = sub : method {
1981 shift->handle_request(@_);
1985 *handler = sub ($$) { shift->handle_request(@_) };
1990 elsif ( $software eq 'Zeus-Perl' ) {
1991 $engine = 'Catalyst::Engine::Zeus';
1995 Catalyst::Exception->throw(
1996 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2001 $engine = $class->engine_class;
2004 unless (Class::Inspector->loaded($engine)) {
2005 require Class::Inspector->filename($engine);
2008 # check for old engines that are no longer compatible
2010 if ( $engine->isa('Catalyst::Engine::Apache')
2011 && !Catalyst::Engine::Apache->VERSION )
2016 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2017 && Catalyst::Engine::Server->VERSION le '0.02' )
2022 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2023 && $engine->VERSION eq '0.01' )
2028 elsif ($engine->isa('Catalyst::Engine::Zeus')
2029 && $engine->VERSION eq '0.01' )
2035 Catalyst::Exception->throw( message =>
2036 qq/Engine "$engine" is not supported by this version of Catalyst/
2041 $class->engine( $engine->new );
2044 =head2 $c->setup_home
2046 Sets up the home directory.
2051 my ( $class, $home ) = @_;
2053 if ( $ENV{CATALYST_HOME} ) {
2054 $home = $ENV{CATALYST_HOME};
2057 if ( $ENV{ uc($class) . '_HOME' } ) {
2059 $home = $ENV{ uc($class) . '_HOME' };
2063 $home = Catalyst::Utils::home($class);
2067 $class->config->{home} ||= $home;
2068 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2072 =head2 $c->setup_log
2079 my ( $class, $debug ) = @_;
2081 unless ( $class->log ) {
2082 $class->log( Catalyst::Log->new );
2085 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2088 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2089 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2094 *{"$class\::debug"} = sub { 1 };
2095 $class->log->debug('Debug messages enabled');
2099 =head2 $c->setup_plugins
2105 =head2 $c->registered_plugins
2107 Returns a sorted list of the plugins which have either been stated in the
2108 import list or which have been added via C<< MyApp->plugin(@args); >>.
2110 If passed a given plugin name, it will report a boolean value indicating
2111 whether or not that plugin is loaded. A fully qualified name is required if
2112 the plugin name does not begin with C<Catalyst::Plugin::>.
2114 if ($c->registered_plugins('Some::Plugin')) {
2122 sub registered_plugins {
2124 return sort keys %{ $proto->_plugins } unless @_;
2126 return 1 if exists $proto->_plugins->{$plugin};
2127 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2130 sub _register_plugin {
2131 my ( $proto, $plugin, $instant ) = @_;
2132 my $class = ref $proto || $proto;
2134 unless (Class::Inspector->loaded($plugin)) {
2135 require Class::Inspector->filename($plugin);
2138 $proto->_plugins->{$plugin} = 1;
2141 unshift @{"$class\::ISA"}, $plugin;
2147 my ( $class, $plugins ) = @_;
2149 $class->_plugins( {} ) unless $class->_plugins;
2151 for my $plugin ( reverse @$plugins ) {
2153 unless ( $plugin =~ s/\A\+// ) {
2154 $plugin = "Catalyst::Plugin::$plugin";
2157 $class->_register_plugin($plugin);
2164 Returns an arrayref of the internal execution stack (actions that are
2165 currently executing).
2167 =head2 $c->write( $data )
2169 Writes $data to the output stream. When using this method directly, you
2170 will need to manually set the C<Content-Length> header to the length of
2171 your output data, if known.
2178 # Finalize headers if someone manually writes output
2179 $c->finalize_headers;
2181 return $c->engine->write( $c, @_ );
2186 Returns the Catalyst version number. Mostly useful for "powered by"
2187 messages in template systems.
2191 sub version { return $Catalyst::VERSION }
2193 =head1 INTERNAL ACTIONS
2195 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2196 C<_ACTION>, and C<_END>. These are by default not shown in the private
2197 action table, but you can make them visible with a config parameter.
2199 MyApp->config->{show_internal_actions} = 1;
2201 =head1 CASE SENSITIVITY
2203 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2204 mapped to C</foo/bar>. You can activate case sensitivity with a config
2207 MyApp->config->{case_sensitive} = 1;
2209 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2211 =head1 ON-DEMAND PARSER
2213 The request body is usually parsed at the beginning of a request,
2214 but if you want to handle input yourself or speed things up a bit,
2215 you can enable on-demand parsing with a config parameter.
2217 MyApp->config->{parse_on_demand} = 1;
2219 =head1 PROXY SUPPORT
2221 Many production servers operate using the common double-server approach,
2222 with a lightweight frontend web server passing requests to a larger
2223 backend server. An application running on the backend server must deal
2224 with two problems: the remote user always appears to be C<127.0.0.1> and
2225 the server's hostname will appear to be C<localhost> regardless of the
2226 virtual host that the user connected through.
2228 Catalyst will automatically detect this situation when you are running
2229 the frontend and backend servers on the same machine. The following
2230 changes are made to the request.
2232 $c->req->address is set to the user's real IP address, as read from
2233 the HTTP X-Forwarded-For header.
2235 The host value for $c->req->base and $c->req->uri is set to the real
2236 host, as read from the HTTP X-Forwarded-Host header.
2238 Obviously, your web server must support these headers for this to work.
2240 In a more complex server farm environment where you may have your
2241 frontend proxy server(s) on different machines, you will need to set a
2242 configuration option to tell Catalyst to read the proxied data from the
2245 MyApp->config->{using_frontend_proxy} = 1;
2247 If you do not wish to use the proxy support at all, you may set:
2249 MyApp->config->{ignore_frontend_proxy} = 1;
2251 =head1 THREAD SAFETY
2253 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2254 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2255 believe the Catalyst core to be thread-safe.
2257 If you plan to operate in a threaded environment, remember that all other
2258 modules you are using must also be thread-safe. Some modules, most notably
2259 L<DBD::SQLite>, are not thread-safe.
2265 Join #catalyst on irc.perl.org.
2269 http://lists.rawmode.org/mailman/listinfo/catalyst
2270 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2274 http://catalyst.perl.org
2278 http://dev.catalyst.perl.org
2282 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2284 =head2 L<Catalyst::Manual> - The Catalyst Manual
2286 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2288 =head2 L<Catalyst::Engine> - Core engine
2290 =head2 L<Catalyst::Log> - Log class.
2292 =head2 L<Catalyst::Request> - Request object
2294 =head2 L<Catalyst::Response> - Response object
2296 =head2 L<Catalyst::Test> - The test suite.
2368 Sebastian Riedel, C<sri@oook.de>
2372 This library is free software, you can redistribute it and/or modify it under
2373 the same terms as Perl itself.