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/;
24 use Scalar::Util qw/weaken blessed/;
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
29 use Carp qw/croak carp/;
31 BEGIN { require 5.008001; }
33 __PACKAGE__->mk_accessors(
34 qw/counter request response state action stack namespace stats/
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 stats_class
58 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
59 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
60 __PACKAGE__->request_class('Catalyst::Request');
61 __PACKAGE__->response_class('Catalyst::Response');
62 __PACKAGE__->stats_class('Catalyst::Stats');
64 # Remember to update this in Catalyst::Runtime as well!
66 our $VERSION = '5.7014';
69 my ( $class, @arguments ) = @_;
71 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
73 return unless $class eq 'Catalyst';
75 my $caller = caller(0);
77 unless ( $caller->isa('Catalyst') ) {
79 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
82 $caller->arguments( [@arguments] );
88 Catalyst - The Elegant MVC Web Application Framework
92 See the L<Catalyst::Manual> distribution for comprehensive
93 documentation and tutorials.
95 # Install Catalyst::Devel for helpers and other development tools
96 # use the helper to create a new application
99 # add models, views, controllers
100 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
101 script/myapp_create.pl view MyTemplate TT
102 script/myapp_create.pl controller Search
104 # built in testserver -- use -r to restart automatically on changes
105 # --help to see all available options
106 script/myapp_server.pl
108 # command line testing interface
109 script/myapp_test.pl /yada
112 use Catalyst qw/-Debug/; # include plugins here as well
114 ### In lib/MyApp/Controller/Root.pm (autocreated)
115 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
116 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
117 $c->stash->{template} = 'foo.tt'; # set the template
118 # lookup something from db -- stash vars are passed to TT
120 $c->model('Database::Foo')->search( { country => $args[0] } );
121 if ( $c->req->params->{bar} ) { # access GET or POST parameters
122 $c->forward( 'bar' ); # process another action
123 # do something else after forward returns
127 # The foo.tt TT template can use the stash data from the database
128 [% WHILE (item = data.next) %]
132 # called for /bar/of/soap, /bar/of/soap/10, etc.
133 sub bar : Path('/bar/of/soap') { ... }
135 # called for all actions, from the top-most controller downwards
137 my ( $self, $c ) = @_;
138 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
139 $c->res->redirect( '/login' ); # require login
140 return 0; # abort request and go immediately to end()
142 return 1; # success; carry on to next action
145 # called after all actions are finished
147 my ( $self, $c ) = @_;
148 if ( scalar @{ $c->error } ) { ... } # handle errors
149 return if $c->res->body; # already have a response
150 $c->forward( 'MyApp::View::TT' ); # render template
153 ### in MyApp/Controller/Foo.pm
154 # called for /foo/bar
155 sub bar : Local { ... }
157 # called for /blargle
158 sub blargle : Global { ... }
160 # an index action matches /foo, but not /foo/1, etc.
161 sub index : Private { ... }
163 ### in MyApp/Controller/Foo/Bar.pm
164 # called for /foo/bar/baz
165 sub baz : Local { ... }
167 # first Root auto is called, then Foo auto, then this
168 sub auto : Private { ... }
170 # powerful regular expression paths are also possible
171 sub details : Regex('^product/(\w+)/details$') {
172 my ( $self, $c ) = @_;
173 # extract the (\w+) from the URI
174 my $product = $c->req->captures->[0];
177 See L<Catalyst::Manual::Intro> for additional information.
181 Catalyst is a modern framework for making web applications without the
182 pain usually associated with this process. This document is a reference
183 to the main Catalyst application. If you are a new user, we suggest you
184 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
186 See L<Catalyst::Manual> for more documentation.
188 Catalyst plugins can be loaded by naming them as arguments to the "use
189 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
190 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
193 use Catalyst qw/My::Module/;
195 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
196 fully qualify the name by using a unary plus:
200 +Fully::Qualified::Plugin::Name
203 Special flags like C<-Debug> and C<-Engine> can also be specified as
204 arguments when Catalyst is loaded:
206 use Catalyst qw/-Debug My::Module/;
208 The position of plugins and flags in the chain is important, because
209 they are loaded in the order in which they appear.
211 The following flags are supported:
215 Enables debug output. You can also force this setting from the system
216 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
217 settings override the application, with <MYAPP>_DEBUG having the highest
222 Forces Catalyst to use a specific engine. Omit the
223 C<Catalyst::Engine::> prefix of the engine name, i.e.:
225 use Catalyst qw/-Engine=CGI/;
229 Forces Catalyst to use a specific home directory, e.g.:
231 use Catalyst qw[-Home=/usr/mst];
233 This can also be done in the shell environment by setting either the
234 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
235 is replaced with the uppercased name of your application, any "::" in
236 the name will be replaced with underscores, e.g. MyApp::Web should use
237 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
245 Enables statistics collection and reporting. You can also force this setting
246 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
247 environment settings override the application, with <MYAPP>_STATS having the
252 use Catalyst qw/-Stats=1/
256 =head2 INFORMATION ABOUT THE CURRENT REQUEST
260 Returns a L<Catalyst::Action> object for the current action, which
261 stringifies to the action name. See L<Catalyst::Action>.
265 Returns the namespace of the current action, i.e., the URI prefix
266 corresponding to the controller of the current action. For example:
268 # in Controller::Foo::Bar
269 $c->namespace; # returns 'foo/bar';
275 Returns the current L<Catalyst::Request> object, giving access to
276 information about the current client request (including parameters,
277 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
279 =head2 REQUEST FLOW HANDLING
281 =head2 $c->forward( $action [, \@arguments ] )
283 =head2 $c->forward( $class, $method, [, \@arguments ] )
285 Forwards processing to another action, by its private name. If you give a
286 class name but no method, C<process()> is called. You may also optionally
287 pass arguments in an arrayref. The action will receive the arguments in
288 C<@_> and C<< $c->req->args >>. Upon returning from the function,
289 C<< $c->req->args >> will be restored to the previous values.
291 Any data C<return>ed from the action forwarded to, will be returned by the
294 my $foodata = $c->forward('/foo');
295 $c->forward('index');
296 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
297 $c->forward('MyApp::View::TT');
299 Note that forward implies an C<<eval { }>> around the call (actually
300 C<execute> does), thus de-fatalizing all 'dies' within the called
301 action. If you want C<die> to propagate you need to do something like:
304 die $c->error if $c->error;
306 Or make sure to always return true values from your actions and write
309 $c->forward('foo') || return;
313 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
315 =head2 $c->detach( $action [, \@arguments ] )
317 =head2 $c->detach( $class, $method, [, \@arguments ] )
321 The same as C<forward>, but doesn't return to the previous action when
322 processing is finished.
324 When called with no arguments it escapes the processing chain entirely.
328 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
334 Returns the current L<Catalyst::Response> object, see there for details.
338 Returns a hashref to the stash, which may be used to store data and pass
339 it between components during a request. You can also set hash keys by
340 passing arguments. The stash is automatically sent to the view. The
341 stash is cleared at the end of a request; it cannot be used for
342 persistent storage (for this you must use a session; see
343 L<Catalyst::Plugin::Session> for a complete system integrated with
346 $c->stash->{foo} = $bar;
347 $c->stash( { moose => 'majestic', qux => 0 } );
348 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
350 # stash is automatically passed to the view for use in a template
351 $c->forward( 'MyApp::View::TT' );
358 my $stash = @_ > 1 ? {@_} : $_[0];
359 croak('stash takes a hash or hashref') unless ref $stash;
360 foreach my $key ( keys %$stash ) {
361 $c->{stash}->{$key} = $stash->{$key};
369 =head2 $c->error($error, ...)
371 =head2 $c->error($arrayref)
373 Returns an arrayref containing error messages. If Catalyst encounters an
374 error while processing a request, it stores the error in $c->error. This
375 method should only be used to store fatal error messages.
377 my @error = @{ $c->error };
381 $c->error('Something bad happened');
388 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
389 croak @$error unless ref $c;
390 push @{ $c->{error} }, @$error;
392 elsif ( defined $_[0] ) { $c->{error} = undef }
393 return $c->{error} || [];
399 Contains the return value of the last executed action.
401 =head2 $c->clear_errors
403 Clear errors. You probably don't want to clear the errors unless you are
404 implementing a custom error screen.
406 This is equivalent to running
417 # search components given a name and some prefixes
418 sub _comp_search_prefixes {
419 my ( $c, $name, @prefixes ) = @_;
420 my $appclass = ref $c || $c;
421 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
423 # map the original component name to the sub part that we will search against
424 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
425 grep { /$filter/ } keys %{ $c->components };
427 # undef for a name will return all
428 return keys %eligible if !defined $name;
430 my $query = ref $name ? $name : qr/^$name$/i;
431 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
433 return map { $c->components->{ $_ } } @result if @result;
435 # if we were given a regexp to search against, we're done.
440 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
442 # don't warn if we didn't find any results, it just might not exist
444 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' );
445 $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' );
451 # Find possible names for a prefix
453 my ( $c, @prefixes ) = @_;
454 my $appclass = ref $c || $c;
456 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
458 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
462 # Filter a component before returning by calling ACCEPT_CONTEXT if available
463 sub _filter_component {
464 my ( $c, $comp, @args ) = @_;
466 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
467 return $comp->ACCEPT_CONTEXT( $c, @args );
473 =head2 COMPONENT ACCESSORS
475 =head2 $c->controller($name)
477 Gets a L<Catalyst::Controller> instance by name.
479 $c->controller('Foo')->do_stuff;
481 If the name is omitted, will return the controller for the dispatched
484 If you want to search for controllers, pass in a regexp as the argument.
486 # find all controllers that start with Foo
487 my @foo_controllers = $c->controller(qr{^Foo});
493 my ( $c, $name, @args ) = @_;
496 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
497 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
498 return $c->_filter_component( $result[ 0 ], @args );
501 return $c->component( $c->action->class );
504 =head2 $c->model($name)
506 Gets a L<Catalyst::Model> instance by name.
508 $c->model('Foo')->do_stuff;
510 Any extra arguments are directly passed to ACCEPT_CONTEXT.
512 If the name is omitted, it will look for
513 - a model object in $c->stash{current_model_instance}, then
514 - a model name in $c->stash->{current_model}, then
515 - a config setting 'default_model', or
516 - check if there is only one model, and return it if that's the case.
518 If you want to search for models, pass in a regexp as the argument.
520 # find all models that start with Foo
521 my @foo_models = $c->model(qr{^Foo});
526 my ( $c, $name, @args ) = @_;
529 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
530 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
531 return $c->_filter_component( $result[ 0 ], @args );
535 return $c->stash->{current_model_instance}
536 if $c->stash->{current_model_instance};
537 return $c->model( $c->stash->{current_model} )
538 if $c->stash->{current_model};
540 return $c->model( $c->config->{default_model} )
541 if $c->config->{default_model};
543 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
546 $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' );
547 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
548 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
549 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
550 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
553 return $c->_filter_component( $comp );
557 =head2 $c->view($name)
559 Gets a L<Catalyst::View> instance by name.
561 $c->view('Foo')->do_stuff;
563 Any extra arguments are directly passed to ACCEPT_CONTEXT.
565 If the name is omitted, it will look for
566 - a view object in $c->stash{current_view_instance}, then
567 - a view name in $c->stash->{current_view}, then
568 - a config setting 'default_view', or
569 - check if there is only one view, and return it if that's the case.
571 If you want to search for views, pass in a regexp as the argument.
573 # find all views that start with Foo
574 my @foo_views = $c->view(qr{^Foo});
579 my ( $c, $name, @args ) = @_;
582 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
583 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
584 return $c->_filter_component( $result[ 0 ], @args );
588 return $c->stash->{current_view_instance}
589 if $c->stash->{current_view_instance};
590 return $c->view( $c->stash->{current_view} )
591 if $c->stash->{current_view};
593 return $c->view( $c->config->{default_view} )
594 if $c->config->{default_view};
596 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
599 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
600 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
601 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
602 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
603 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
606 return $c->_filter_component( $comp );
609 =head2 $c->controllers
611 Returns the available names which can be passed to $c->controller
617 return $c->_comp_names(qw/Controller C/);
622 Returns the available names which can be passed to $c->model
628 return $c->_comp_names(qw/Model M/);
634 Returns the available names which can be passed to $c->view
640 return $c->_comp_names(qw/View V/);
643 =head2 $c->comp($name)
645 =head2 $c->component($name)
647 Gets a component object by name. This method is not recommended,
648 unless you want to get a specific component by full
649 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
650 should be used instead.
652 If C<$name> is a regexp, a list of components matched against the full
653 component name will be returned.
658 my ( $c, $name, @args ) = @_;
661 my $comps = $c->components;
664 # is it the exact name?
665 return $comps->{ $name } if exists $comps->{ $name };
667 # perhaps we just omitted "MyApp"?
668 my $composed = ( ref $c || $c ) . "::${name}";
669 return $comps->{ $composed } if exists $comps->{ $composed };
671 # search all of the models, views and controllers
672 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
673 return $c->_filter_component( $comp, @args ) if $comp;
676 # This is here so $c->comp( '::M::' ) works
677 my $query = ref $name ? $name : qr{$name}i;
679 my @result = grep { m{$query} } keys %{ $c->components };
680 return @result if ref $name;
683 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
684 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
688 # I would expect to return an empty list here, but that breaks back-compat
692 return sort keys %{ $c->components };
695 =head2 CLASS DATA AND HELPER CLASSES
699 Returns or takes a hashref containing the application's configuration.
701 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
703 You can also use a C<YAML>, C<XML> or C<Config::General> config file
704 like myapp.yml in your applications home directory. See
705 L<Catalyst::Plugin::ConfigLoader>.
708 db: dsn:SQLite:foo.db
716 $c->log->warn("Setting config after setup has been run is not a good idea.")
717 if ( @_ and $c->setup_finished );
719 $c->NEXT::config(@_);
724 Returns the logging object instance. Unless it is already set, Catalyst
725 sets this up with a L<Catalyst::Log> object. To use your own log class,
726 set the logger with the C<< __PACKAGE__->log >> method prior to calling
727 C<< __PACKAGE__->setup >>.
729 __PACKAGE__->log( MyLogger->new );
734 $c->log->info( 'Now logging with my own logger!' );
736 Your log class should implement the methods described in
742 Overload to enable debug messages (same as -Debug option).
744 Note that this is a static method, not an accessor and should be overloaded
745 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
751 =head2 $c->dispatcher
753 Returns the dispatcher instance. Stringifies to class name. See
754 L<Catalyst::Dispatcher>.
758 Returns the engine instance. Stringifies to the class name. See
762 =head2 UTILITY METHODS
764 =head2 $c->path_to(@path)
766 Merges C<@path> with C<< $c->config->{home} >> and returns a
767 L<Path::Class::Dir> object.
771 $c->path_to( 'db', 'sqlite.db' );
776 my ( $c, @path ) = @_;
777 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
778 if ( -d $path ) { return $path }
779 else { return Path::Class::File->new( $c->config->{home}, @path ) }
782 =head2 $c->plugin( $name, $class, @args )
784 Helper method for plugins. It creates a classdata accessor/mutator and
785 loads and instantiates the given class.
787 MyApp->plugin( 'prototype', 'HTML::Prototype' );
789 $c->prototype->define_javascript_functions;
794 my ( $class, $name, $plugin, @args ) = @_;
795 $class->_register_plugin( $plugin, 1 );
797 eval { $plugin->import };
798 $class->mk_classdata($name);
800 eval { $obj = $plugin->new(@args) };
803 Catalyst::Exception->throw( message =>
804 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
808 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
814 Initializes the dispatcher and engine, loads any plugins, and loads the
815 model, view, and controller components. You may also specify an array
816 of plugins to load here, if you choose to not load them in the C<use
820 MyApp->setup( qw/-Debug/ );
825 my ( $class, @arguments ) = @_;
827 $class->log->warn("Running setup twice is not a good idea.")
828 if ( $class->setup_finished );
830 unless ( $class->isa('Catalyst') ) {
832 Catalyst::Exception->throw(
833 message => qq/'$class' does not inherit from Catalyst/ );
836 if ( $class->arguments ) {
837 @arguments = ( @arguments, @{ $class->arguments } );
843 foreach (@arguments) {
847 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
849 elsif (/^-(\w+)=?(.*)$/) {
850 $flags->{ lc $1 } = $2;
853 push @{ $flags->{plugins} }, $_;
857 $class->setup_home( delete $flags->{home} );
859 $class->setup_log( delete $flags->{log} );
860 $class->setup_plugins( delete $flags->{plugins} );
861 $class->setup_dispatcher( delete $flags->{dispatcher} );
862 $class->setup_engine( delete $flags->{engine} );
863 $class->setup_stats( delete $flags->{stats} );
865 for my $flag ( sort keys %{$flags} ) {
867 if ( my $code = $class->can( 'setup_' . $flag ) ) {
868 &$code( $class, delete $flags->{$flag} );
871 $class->log->warn(qq/Unknown flag "$flag"/);
875 eval { require Catalyst::Devel; };
876 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
877 $class->log->warn(<<"EOF");
878 You are running an old script!
880 Please update by running (this will overwrite existing files):
881 catalyst.pl -force -scripts $class
883 or (this will not overwrite existing files):
884 catalyst.pl -scripts $class
889 if ( $class->debug ) {
890 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
893 my $t = Text::SimpleTable->new(74);
894 $t->row($_) for @plugins;
895 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
898 my $dispatcher = $class->dispatcher;
899 my $engine = $class->engine;
900 my $home = $class->config->{home};
902 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
903 $class->log->debug(qq/Loaded engine "$engine"/);
907 ? $class->log->debug(qq/Found home "$home"/)
908 : $class->log->debug(qq/Home "$home" doesn't exist/)
909 : $class->log->debug(q/Couldn't find home/);
914 no warnings qw/redefine/;
915 local *setup = sub { };
919 # Initialize our data structure
920 $class->components( {} );
922 $class->setup_components;
924 if ( $class->debug ) {
925 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
926 for my $comp ( sort keys %{ $class->components } ) {
927 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
928 $t->row( $comp, $type );
930 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
931 if ( keys %{ $class->components } );
934 # Add our self to components, since we are also a component
935 $class->components->{$class} = $class;
937 $class->setup_actions;
939 if ( $class->debug ) {
940 my $name = $class->config->{name} || 'Application';
941 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
943 $class->log->_flush() if $class->log->can('_flush');
945 $class->setup_finished(1);
948 =head2 $c->uri_for( $path, @args?, \%query_values? )
950 Merges path with C<< $c->request->base >> for absolute URIs and with
951 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
952 object. If any args are passed, they are added at the end of the path.
953 If the last argument to C<uri_for> is a hash reference, it is assumed to
954 contain GET parameter key/value pairs, which will be appended to the URI
957 Note that uri_for is destructive to the passed hashref. Subsequent calls
958 with the same hashref may have unintended results.
960 Instead of C<$path>, you can also optionally pass a C<$action> object
961 which will be resolved to a path using
962 C<< $c->dispatcher->uri_for_action >>; if the first element of
963 C<@args> is an arrayref it is treated as a list of captures to be passed
964 to C<uri_for_action>.
969 my ( $c, $path, @args ) = @_;
971 if ( Scalar::Util::blessed($path) ) { # action object
972 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
975 $path = $c->dispatcher->uri_for_action($path, $captures);
976 return undef unless defined($path);
977 $path = '/' if $path eq '';
980 undef($path) if (defined $path && $path eq '');
983 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
985 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
986 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
988 unshift(@args, $path);
990 unless (defined $path && $path =~ s!^/!!) { # in-place strip
991 my $namespace = $c->namespace;
992 if (defined $path) { # cheesy hack to handle path '../foo'
993 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
995 unshift(@args, $namespace || '');
998 # join args with '/', or a blank string
999 my $args = join('/', grep { defined($_) } @args);
1000 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1002 my $base = $c->req->base;
1003 my $class = ref($base);
1004 $base =~ s{(?<!/)$}{/};
1008 if (my @keys = keys %$params) {
1009 # somewhat lifted from URI::_query's query_form
1010 $query = '?'.join('&', map {
1011 my $val = $params->{$_};
1012 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1015 $val = '' unless defined $val;
1018 utf8::encode( $_ ) if utf8::is_utf8($_);
1019 # using the URI::Escape pattern here so utf8 chars survive
1020 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1022 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1026 my $res = bless(\"${base}${args}${query}", $class);
1030 =head2 $c->welcome_message
1032 Returns the Catalyst welcome HTML page.
1036 sub welcome_message {
1038 my $name = $c->config->{name};
1039 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1040 my $prefix = Catalyst::Utils::appprefix( ref $c );
1041 $c->response->content_type('text/html; charset=utf-8');
1043 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1044 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1045 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1047 <meta http-equiv="Content-Language" content="en" />
1048 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1049 <title>$name on Catalyst $VERSION</title>
1050 <style type="text/css">
1053 background-color: #eee;
1060 margin-bottom: 10px;
1062 background-color: #ccc;
1063 border: 1px solid #aaa;
1068 font-family: verdana, tahoma, sans-serif;
1071 font-family: verdana, tahoma, sans-serif;
1074 text-decoration: none;
1076 border-bottom: 1px dotted #bbb;
1078 :link:hover, :visited:hover {
1091 background-color: #fff;
1092 border: 1px solid #aaa;
1096 font-weight: normal;
1118 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1123 <img src="$logo" alt="Catalyst Logo" />
1125 <p>Welcome to the world of Catalyst.
1126 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1127 framework will make web development something you had
1128 never expected it to be: Fun, rewarding, and quick.</p>
1129 <h2>What to do now?</h2>
1130 <p>That really depends on what <b>you</b> want to do.
1131 We do, however, provide you with a few starting points.</p>
1132 <p>If you want to jump right into web development with Catalyst
1133 you might want to start with a tutorial.</p>
1134 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1136 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1138 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1139 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1141 <h2>What to do next?</h2>
1142 <p>Next it's time to write an actual application. Use the
1143 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1144 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1145 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1146 they can save you a lot of work.</p>
1147 <pre><code>script/${prefix}_create.pl -help</code></pre>
1148 <p>Also, be sure to check out the vast and growing
1149 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1150 you are likely to find what you need there.
1154 <p>Catalyst has a very active community. Here are the main places to
1155 get in touch with us.</p>
1158 <a href="http://dev.catalyst.perl.org">Wiki</a>
1161 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1164 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1167 <h2>In conclusion</h2>
1168 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1169 as we enjoyed making it. Please contact us if you have ideas
1170 for improvement or other feedback.</p>
1178 =head1 INTERNAL METHODS
1180 These methods are not meant to be used by end users.
1182 =head2 $c->components
1184 Returns a hash of components.
1186 =head2 $c->context_class
1188 Returns or sets the context class.
1192 Returns a hashref containing coderefs and execution counts (needed for
1193 deep recursion detection).
1197 Returns the number of actions on the current internal execution stack.
1201 Dispatches a request to actions.
1205 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1207 =head2 $c->dispatcher_class
1209 Returns or sets the dispatcher class.
1211 =head2 $c->dump_these
1213 Returns a list of 2-element array references (name, structure) pairs
1214 that will be dumped on the error page in debug mode.
1220 [ Request => $c->req ],
1221 [ Response => $c->res ],
1222 [ Stash => $c->stash ],
1223 [ Config => $c->config ];
1226 =head2 $c->engine_class
1228 Returns or sets the engine class.
1230 =head2 $c->execute( $class, $coderef )
1232 Execute a coderef in given class and catch exceptions. Errors are available
1238 my ( $c, $class, $code ) = @_;
1239 $class = $c->component($class) || $class;
1242 if ( $c->depth >= $RECURSION ) {
1243 my $action = "$code";
1244 $action = "/$action" unless $action =~ /->/;
1245 my $error = qq/Deep recursion detected calling "$action"/;
1246 $c->log->error($error);
1252 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1254 push( @{ $c->stack }, $code );
1256 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1258 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1260 my $last = pop( @{ $c->stack } );
1262 if ( my $error = $@ ) {
1263 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1265 unless ( ref $error ) {
1266 no warnings 'uninitialized';
1268 my $class = $last->class;
1269 my $name = $last->name;
1270 $error = qq/Caught exception in $class->$name "$error"/;
1279 sub _stats_start_execute {
1280 my ( $c, $code ) = @_;
1282 return if ( ( $code->name =~ /^_.*/ )
1283 && ( !$c->config->{show_internal_actions} ) );
1285 $c->counter->{"$code"}++;
1287 my $action = "$code";
1288 $action = "/$action" unless $action =~ /->/;
1290 # determine if the call was the result of a forward
1291 # this is done by walking up the call stack and looking for a calling
1292 # sub of Catalyst::forward before the eval
1294 for my $index ( 2 .. 11 ) {
1296 if ( ( caller($index) )[0] eq 'Catalyst'
1297 && ( caller($index) )[3] eq '(eval)' );
1299 if ( ( caller($index) )[3] =~ /forward$/ ) {
1300 $callsub = ( caller($index) )[3];
1301 $action = "-> $action";
1306 my $uid = "$code" . $c->counter->{"$code"};
1308 # is this a root-level call or a forwarded call?
1309 if ( $callsub =~ /forward$/ ) {
1311 # forward, locate the caller
1312 if ( my $parent = $c->stack->[-1] ) {
1315 parent => "$parent" . $c->counter->{"$parent"},
1321 # forward with no caller may come from a plugin
1340 sub _stats_finish_execute {
1341 my ( $c, $info ) = @_;
1342 $c->stats->profile( end => $info );
1345 =head2 $c->_localize_fields( sub { }, \%keys );
1349 sub _localize_fields {
1350 my ( $c, $localized, $code ) = ( @_ );
1352 my $request = delete $localized->{request} || {};
1353 my $response = delete $localized->{response} || {};
1355 local @{ $c }{ keys %$localized } = values %$localized;
1356 local @{ $c->request }{ keys %$request } = values %$request;
1357 local @{ $c->response }{ keys %$response } = values %$response;
1364 Finalizes the request.
1371 for my $error ( @{ $c->error } ) {
1372 $c->log->error($error);
1375 # Allow engine to handle finalize flow (for POE)
1376 if ( $c->engine->can('finalize') ) {
1377 $c->engine->finalize($c);
1381 $c->finalize_uploads;
1384 if ( $#{ $c->error } >= 0 ) {
1388 $c->finalize_headers;
1391 if ( $c->request->method eq 'HEAD' ) {
1392 $c->response->body('');
1398 if ($c->use_stats) {
1399 my $elapsed = sprintf '%f', $c->stats->elapsed;
1400 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1402 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1405 return $c->response->status;
1408 =head2 $c->finalize_body
1414 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1416 =head2 $c->finalize_cookies
1422 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1424 =head2 $c->finalize_error
1430 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1432 =head2 $c->finalize_headers
1438 sub finalize_headers {
1441 # Check if we already finalized headers
1442 return if $c->response->{_finalized_headers};
1445 if ( my $location = $c->response->redirect ) {
1446 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1447 $c->response->header( Location => $location );
1449 if ( !$c->response->body ) {
1450 # Add a default body if none is already present
1452 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1458 if ( $c->response->body && !$c->response->content_length ) {
1460 # get the length from a filehandle
1461 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1463 my $stat = stat $c->response->body;
1464 if ( $stat && $stat->size > 0 ) {
1465 $c->response->content_length( $stat->size );
1468 $c->log->warn('Serving filehandle without a content-length');
1472 # everything should be bytes at this point, but just in case
1473 $c->response->content_length( bytes::length( $c->response->body ) );
1478 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1479 $c->response->headers->remove_header("Content-Length");
1480 $c->response->body('');
1483 $c->finalize_cookies;
1485 $c->engine->finalize_headers( $c, @_ );
1488 $c->response->{_finalized_headers} = 1;
1491 =head2 $c->finalize_output
1493 An alias for finalize_body.
1495 =head2 $c->finalize_read
1497 Finalizes the input after reading is complete.
1501 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1503 =head2 $c->finalize_uploads
1505 Finalizes uploads. Cleans up any temporary files.
1509 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1511 =head2 $c->get_action( $action, $namespace )
1513 Gets an action in a given namespace.
1517 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1519 =head2 $c->get_actions( $action, $namespace )
1521 Gets all actions of a given name in a namespace and all parent
1526 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1528 =head2 $c->handle_request( $class, @arguments )
1530 Called to handle each HTTP request.
1534 sub handle_request {
1535 my ( $class, @arguments ) = @_;
1537 # Always expect worst case!
1540 if ($class->debug) {
1541 my $secs = time - $START || 1;
1542 my $av = sprintf '%.3f', $COUNT / $secs;
1543 my $time = localtime time;
1544 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1547 my $c = $class->prepare(@arguments);
1549 $status = $c->finalize;
1552 if ( my $error = $@ ) {
1554 $class->log->error(qq/Caught exception in engine "$error"/);
1558 $class->log->_flush() if $class->log->can('_flush');
1562 =head2 $c->prepare( @arguments )
1564 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1570 my ( $class, @arguments ) = @_;
1572 $class->context_class( ref $class || $class ) unless $class->context_class;
1573 my $c = $class->context_class->new(
1577 request => $class->request_class->new(
1580 body_parameters => {},
1582 headers => HTTP::Headers->new,
1584 query_parameters => {},
1590 response => $class->response_class->new(
1594 headers => HTTP::Headers->new(),
1603 $c->stats($class->stats_class->new)->enable($c->use_stats);
1605 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1608 # For on-demand data
1609 $c->request->{_context} = $c;
1610 $c->response->{_context} = $c;
1611 weaken( $c->request->{_context} );
1612 weaken( $c->response->{_context} );
1614 # Allow engine to direct the prepare flow (for POE)
1615 if ( $c->engine->can('prepare') ) {
1616 $c->engine->prepare( $c, @arguments );
1619 $c->prepare_request(@arguments);
1620 $c->prepare_connection;
1621 $c->prepare_query_parameters;
1622 $c->prepare_headers;
1623 $c->prepare_cookies;
1626 # Prepare the body for reading, either by prepare_body
1627 # or the user, if they are using $c->read
1630 # Parse the body unless the user wants it on-demand
1631 unless ( $c->config->{parse_on_demand} ) {
1636 my $method = $c->req->method || '';
1637 my $path = $c->req->path;
1638 $path = '/' unless length $path;
1639 my $address = $c->req->address || '';
1641 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1649 =head2 $c->prepare_action
1651 Prepares action. See L<Catalyst::Dispatcher>.
1655 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1657 =head2 $c->prepare_body
1659 Prepares message body.
1666 # Do we run for the first time?
1667 return if defined $c->request->{_body};
1669 # Initialize on-demand data
1670 $c->engine->prepare_body( $c, @_ );
1671 $c->prepare_parameters;
1672 $c->prepare_uploads;
1674 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1675 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1676 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1677 my $param = $c->req->body_parameters->{$key};
1678 my $value = defined($param) ? $param : '';
1680 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1682 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1686 =head2 $c->prepare_body_chunk( $chunk )
1688 Prepares a chunk of data before sending it to L<HTTP::Body>.
1690 See L<Catalyst::Engine>.
1694 sub prepare_body_chunk {
1696 $c->engine->prepare_body_chunk( $c, @_ );
1699 =head2 $c->prepare_body_parameters
1701 Prepares body parameters.
1705 sub prepare_body_parameters {
1707 $c->engine->prepare_body_parameters( $c, @_ );
1710 =head2 $c->prepare_connection
1712 Prepares connection.
1716 sub prepare_connection {
1718 $c->engine->prepare_connection( $c, @_ );
1721 =head2 $c->prepare_cookies
1727 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1729 =head2 $c->prepare_headers
1735 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1737 =head2 $c->prepare_parameters
1739 Prepares parameters.
1743 sub prepare_parameters {
1745 $c->prepare_body_parameters;
1746 $c->engine->prepare_parameters( $c, @_ );
1749 =head2 $c->prepare_path
1751 Prepares path and base.
1755 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1757 =head2 $c->prepare_query_parameters
1759 Prepares query parameters.
1763 sub prepare_query_parameters {
1766 $c->engine->prepare_query_parameters( $c, @_ );
1768 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1769 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1770 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1771 my $param = $c->req->query_parameters->{$key};
1772 my $value = defined($param) ? $param : '';
1774 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1776 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1780 =head2 $c->prepare_read
1782 Prepares the input for reading.
1786 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1788 =head2 $c->prepare_request
1790 Prepares the engine request.
1794 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1796 =head2 $c->prepare_uploads
1802 sub prepare_uploads {
1805 $c->engine->prepare_uploads( $c, @_ );
1807 if ( $c->debug && keys %{ $c->request->uploads } ) {
1808 my $t = Text::SimpleTable->new(
1809 [ 12, 'Parameter' ],
1814 for my $key ( sort keys %{ $c->request->uploads } ) {
1815 my $upload = $c->request->uploads->{$key};
1816 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1817 $t->row( $key, $u->filename, $u->type, $u->size );
1820 $c->log->debug( "File Uploads are:\n" . $t->draw );
1824 =head2 $c->prepare_write
1826 Prepares the output for writing.
1830 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1832 =head2 $c->request_class
1834 Returns or sets the request class.
1836 =head2 $c->response_class
1838 Returns or sets the response class.
1840 =head2 $c->read( [$maxlength] )
1842 Reads a chunk of data from the request body. This method is designed to
1843 be used in a while loop, reading C<$maxlength> bytes on every call.
1844 C<$maxlength> defaults to the size of the request if not specified.
1846 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1849 Warning: If you use read(), Catalyst will not process the body,
1850 so you will not be able to access POST parameters or file uploads via
1851 $c->request. You must handle all body parsing yourself.
1855 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1863 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1865 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1867 Sets an action in a given namespace.
1871 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1873 =head2 $c->setup_actions($component)
1875 Sets up actions for a component.
1879 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1881 =head2 $c->setup_components
1883 Sets up components. Specify a C<setup_components> config option to pass
1884 additional options directly to L<Module::Pluggable>. To add additional
1885 search paths, specify a key named C<search_extra> as an array
1886 reference. Items in the array beginning with C<::> will have the
1887 application class name prepended to them.
1891 sub setup_components {
1894 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1895 my $config = $class->config->{ setup_components };
1896 my $extra = delete $config->{ search_extra } || [];
1898 push @paths, @$extra;
1900 my $locator = Module::Pluggable::Object->new(
1901 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1905 my @comps = sort { length $a <=> length $b } $locator->plugins;
1906 my %comps = map { $_ => 1 } @comps;
1908 for my $component ( @comps ) {
1910 # We pass ignore_loaded here so that overlay files for (e.g.)
1911 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1912 # we know M::P::O found a file on disk so this is safe
1914 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1916 my $module = $class->setup_component( $component );
1918 $component => $module,
1920 $_ => $class->setup_component( $_ )
1922 not exists $comps{$_}
1923 } Devel::InnerPackage::list_packages( $component )
1926 for my $key ( keys %modules ) {
1927 $class->components->{ $key } = $modules{ $key };
1932 =head2 $c->setup_component
1936 sub setup_component {
1937 my( $class, $component ) = @_;
1939 unless ( $component->can( 'COMPONENT' ) ) {
1943 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1944 my $config = $class->config->{ $suffix } || {};
1946 my $instance = eval { $component->COMPONENT( $class, $config ); };
1948 if ( my $error = $@ ) {
1950 Catalyst::Exception->throw(
1951 message => qq/Couldn't instantiate component "$component", "$error"/
1955 Catalyst::Exception->throw(
1957 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1958 ) unless eval { $instance->can( 'can' ) };
1963 =head2 $c->setup_dispatcher
1969 sub setup_dispatcher {
1970 my ( $class, $dispatcher ) = @_;
1973 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1976 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1977 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1980 unless ($dispatcher) {
1981 $dispatcher = $class->dispatcher_class;
1984 unless (Class::Inspector->loaded($dispatcher)) {
1985 require Class::Inspector->filename($dispatcher);
1988 # dispatcher instance
1989 $class->dispatcher( $dispatcher->new );
1992 =head2 $c->setup_engine
1999 my ( $class, $engine ) = @_;
2002 $engine = 'Catalyst::Engine::' . $engine;
2005 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2006 $engine = 'Catalyst::Engine::' . $env;
2009 if ( $ENV{MOD_PERL} ) {
2011 # create the apache method
2014 *{"$class\::apache"} = sub { shift->engine->apache };
2017 my ( $software, $version ) =
2018 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2021 $version =~ s/(\.[^.]+)\./$1/g;
2023 if ( $software eq 'mod_perl' ) {
2027 if ( $version >= 1.99922 ) {
2028 $engine = 'Catalyst::Engine::Apache2::MP20';
2031 elsif ( $version >= 1.9901 ) {
2032 $engine = 'Catalyst::Engine::Apache2::MP19';
2035 elsif ( $version >= 1.24 ) {
2036 $engine = 'Catalyst::Engine::Apache::MP13';
2040 Catalyst::Exception->throw( message =>
2041 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2046 # install the correct mod_perl handler
2047 if ( $version >= 1.9901 ) {
2048 *handler = sub : method {
2049 shift->handle_request(@_);
2053 *handler = sub ($$) { shift->handle_request(@_) };
2058 elsif ( $software eq 'Zeus-Perl' ) {
2059 $engine = 'Catalyst::Engine::Zeus';
2063 Catalyst::Exception->throw(
2064 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2069 $engine = $class->engine_class;
2072 unless (Class::Inspector->loaded($engine)) {
2073 require Class::Inspector->filename($engine);
2076 # check for old engines that are no longer compatible
2078 if ( $engine->isa('Catalyst::Engine::Apache')
2079 && !Catalyst::Engine::Apache->VERSION )
2084 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2085 && Catalyst::Engine::Server->VERSION le '0.02' )
2090 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2091 && $engine->VERSION eq '0.01' )
2096 elsif ($engine->isa('Catalyst::Engine::Zeus')
2097 && $engine->VERSION eq '0.01' )
2103 Catalyst::Exception->throw( message =>
2104 qq/Engine "$engine" is not supported by this version of Catalyst/
2109 $class->engine( $engine->new );
2112 =head2 $c->setup_home
2114 Sets up the home directory.
2119 my ( $class, $home ) = @_;
2121 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2126 $home = Catalyst::Utils::home($class);
2130 $class->config->{home} ||= $home;
2131 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2135 =head2 $c->setup_log
2142 my ( $class, $debug ) = @_;
2144 unless ( $class->log ) {
2145 $class->log( Catalyst::Log->new );
2148 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2149 if ( defined($env_debug) ? $env_debug : $debug ) {
2151 *{"$class\::debug"} = sub { 1 };
2152 $class->log->debug('Debug messages enabled');
2156 =head2 $c->setup_plugins
2162 =head2 $c->setup_stats
2164 Sets up timing statistics class.
2169 my ( $class, $stats ) = @_;
2171 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2173 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2174 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2176 *{"$class\::use_stats"} = sub { 1 };
2177 $class->log->debug('Statistics enabled');
2182 =head2 $c->registered_plugins
2184 Returns a sorted list of the plugins which have either been stated in the
2185 import list or which have been added via C<< MyApp->plugin(@args); >>.
2187 If passed a given plugin name, it will report a boolean value indicating
2188 whether or not that plugin is loaded. A fully qualified name is required if
2189 the plugin name does not begin with C<Catalyst::Plugin::>.
2191 if ($c->registered_plugins('Some::Plugin')) {
2199 sub registered_plugins {
2201 return sort keys %{ $proto->_plugins } unless @_;
2203 return 1 if exists $proto->_plugins->{$plugin};
2204 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2207 sub _register_plugin {
2208 my ( $proto, $plugin, $instant ) = @_;
2209 my $class = ref $proto || $proto;
2211 # no ignore_loaded here, the plugin may already have been
2212 # defined in memory and we don't want to error on "no file" if so
2214 Catalyst::Utils::ensure_class_loaded( $plugin );
2216 $proto->_plugins->{$plugin} = 1;
2219 unshift @{"$class\::ISA"}, $plugin;
2225 my ( $class, $plugins ) = @_;
2227 $class->_plugins( {} ) unless $class->_plugins;
2229 for my $plugin ( reverse @$plugins ) {
2231 unless ( $plugin =~ s/\A\+// ) {
2232 $plugin = "Catalyst::Plugin::$plugin";
2235 $class->_register_plugin($plugin);
2242 Returns an arrayref of the internal execution stack (actions that are
2243 currently executing).
2245 =head2 $c->stats_class
2247 Returns or sets the stats (timing statistics) class.
2249 =head2 $c->use_stats
2251 Returns 1 when stats collection is enabled. Stats collection is enabled
2252 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2253 environment variable is set.
2255 Note that this is a static method, not an accessor and should be overloaded
2256 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2263 =head2 $c->write( $data )
2265 Writes $data to the output stream. When using this method directly, you
2266 will need to manually set the C<Content-Length> header to the length of
2267 your output data, if known.
2274 # Finalize headers if someone manually writes output
2275 $c->finalize_headers;
2277 return $c->engine->write( $c, @_ );
2282 Returns the Catalyst version number. Mostly useful for "powered by"
2283 messages in template systems.
2287 sub version { return $Catalyst::VERSION }
2289 =head1 INTERNAL ACTIONS
2291 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2292 C<_ACTION>, and C<_END>. These are by default not shown in the private
2293 action table, but you can make them visible with a config parameter.
2295 MyApp->config->{show_internal_actions} = 1;
2297 =head1 CASE SENSITIVITY
2299 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2300 mapped to C</foo/bar>. You can activate case sensitivity with a config
2303 MyApp->config->{case_sensitive} = 1;
2305 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2307 =head1 ON-DEMAND PARSER
2309 The request body is usually parsed at the beginning of a request,
2310 but if you want to handle input yourself, you can enable on-demand
2311 parsing with a config parameter.
2313 MyApp->config->{parse_on_demand} = 1;
2315 =head1 PROXY SUPPORT
2317 Many production servers operate using the common double-server approach,
2318 with a lightweight frontend web server passing requests to a larger
2319 backend server. An application running on the backend server must deal
2320 with two problems: the remote user always appears to be C<127.0.0.1> and
2321 the server's hostname will appear to be C<localhost> regardless of the
2322 virtual host that the user connected through.
2324 Catalyst will automatically detect this situation when you are running
2325 the frontend and backend servers on the same machine. The following
2326 changes are made to the request.
2328 $c->req->address is set to the user's real IP address, as read from
2329 the HTTP X-Forwarded-For header.
2331 The host value for $c->req->base and $c->req->uri is set to the real
2332 host, as read from the HTTP X-Forwarded-Host header.
2334 Obviously, your web server must support these headers for this to work.
2336 In a more complex server farm environment where you may have your
2337 frontend proxy server(s) on different machines, you will need to set a
2338 configuration option to tell Catalyst to read the proxied data from the
2341 MyApp->config->{using_frontend_proxy} = 1;
2343 If you do not wish to use the proxy support at all, you may set:
2345 MyApp->config->{ignore_frontend_proxy} = 1;
2347 =head1 THREAD SAFETY
2349 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2350 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2351 believe the Catalyst core to be thread-safe.
2353 If you plan to operate in a threaded environment, remember that all other
2354 modules you are using must also be thread-safe. Some modules, most notably
2355 L<DBD::SQLite>, are not thread-safe.
2361 Join #catalyst on irc.perl.org.
2365 http://lists.rawmode.org/mailman/listinfo/catalyst
2366 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2370 http://catalyst.perl.org
2374 http://dev.catalyst.perl.org
2378 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2380 =head2 L<Catalyst::Manual> - The Catalyst Manual
2382 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2384 =head2 L<Catalyst::Engine> - Core engine
2386 =head2 L<Catalyst::Log> - Log class.
2388 =head2 L<Catalyst::Request> - Request object
2390 =head2 L<Catalyst::Response> - Response object
2392 =head2 L<Catalyst::Test> - The test suite.
2466 Sebastian Riedel, C<sri@oook.de>
2470 This library is free software, you can redistribute it and/or modify it under
2471 the same terms as Perl itself.