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";
52 our $GO = "catalyst_go\n";
54 __PACKAGE__->mk_classdata($_)
55 for qw/components arguments dispatcher engine log dispatcher_class
56 engine_class context_class request_class response_class stats_class
59 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
60 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
61 __PACKAGE__->request_class('Catalyst::Request');
62 __PACKAGE__->response_class('Catalyst::Response');
63 __PACKAGE__->stats_class('Catalyst::Stats');
65 # Remember to update this in Catalyst::Runtime as well!
67 our $VERSION = '5.7099_01';
70 my ( $class, @arguments ) = @_;
72 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
74 return unless $class eq 'Catalyst';
76 my $caller = caller(0);
78 unless ( $caller->isa('Catalyst') ) {
80 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
83 $caller->arguments( [@arguments] );
89 Catalyst - The Elegant MVC Web Application Framework
93 See the L<Catalyst::Manual> distribution for comprehensive
94 documentation and tutorials.
96 # Install Catalyst::Devel for helpers and other development tools
97 # use the helper to create a new application
100 # add models, views, controllers
101 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
102 script/myapp_create.pl view MyTemplate TT
103 script/myapp_create.pl controller Search
105 # built in testserver -- use -r to restart automatically on changes
106 # --help to see all available options
107 script/myapp_server.pl
109 # command line testing interface
110 script/myapp_test.pl /yada
113 use Catalyst qw/-Debug/; # include plugins here as well
115 ### In lib/MyApp/Controller/Root.pm (autocreated)
116 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
117 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
118 $c->stash->{template} = 'foo.tt'; # set the template
119 # lookup something from db -- stash vars are passed to TT
121 $c->model('Database::Foo')->search( { country => $args[0] } );
122 if ( $c->req->params->{bar} ) { # access GET or POST parameters
123 $c->forward( 'bar' ); # process another action
124 # do something else after forward returns
128 # The foo.tt TT template can use the stash data from the database
129 [% WHILE (item = data.next) %]
133 # called for /bar/of/soap, /bar/of/soap/10, etc.
134 sub bar : Path('/bar/of/soap') { ... }
136 # called for all actions, from the top-most controller downwards
138 my ( $self, $c ) = @_;
139 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
140 $c->res->redirect( '/login' ); # require login
141 return 0; # abort request and go immediately to end()
143 return 1; # success; carry on to next action
146 # called after all actions are finished
148 my ( $self, $c ) = @_;
149 if ( scalar @{ $c->error } ) { ... } # handle errors
150 return if $c->res->body; # already have a response
151 $c->forward( 'MyApp::View::TT' ); # render template
154 ### in MyApp/Controller/Foo.pm
155 # called for /foo/bar
156 sub bar : Local { ... }
158 # called for /blargle
159 sub blargle : Global { ... }
161 # an index action matches /foo, but not /foo/1, etc.
162 sub index : Private { ... }
164 ### in MyApp/Controller/Foo/Bar.pm
165 # called for /foo/bar/baz
166 sub baz : Local { ... }
168 # first Root auto is called, then Foo auto, then this
169 sub auto : Private { ... }
171 # powerful regular expression paths are also possible
172 sub details : Regex('^product/(\w+)/details$') {
173 my ( $self, $c ) = @_;
174 # extract the (\w+) from the URI
175 my $product = $c->req->captures->[0];
178 See L<Catalyst::Manual::Intro> for additional information.
182 Catalyst is a modern framework for making web applications without the
183 pain usually associated with this process. This document is a reference
184 to the main Catalyst application. If you are a new user, we suggest you
185 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
187 See L<Catalyst::Manual> for more documentation.
189 Catalyst plugins can be loaded by naming them as arguments to the "use
190 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
191 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
194 use Catalyst qw/My::Module/;
196 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
197 fully qualify the name by using a unary plus:
201 +Fully::Qualified::Plugin::Name
204 Special flags like C<-Debug> and C<-Engine> can also be specified as
205 arguments when Catalyst is loaded:
207 use Catalyst qw/-Debug My::Module/;
209 The position of plugins and flags in the chain is important, because
210 they are loaded in the order in which they appear.
212 The following flags are supported:
216 Enables debug output. You can also force this setting from the system
217 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
218 settings override the application, with <MYAPP>_DEBUG having the highest
223 Forces Catalyst to use a specific engine. Omit the
224 C<Catalyst::Engine::> prefix of the engine name, i.e.:
226 use Catalyst qw/-Engine=CGI/;
230 Forces Catalyst to use a specific home directory, e.g.:
232 use Catalyst qw[-Home=/usr/mst];
234 This can also be done in the shell environment by setting either the
235 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
236 is replaced with the uppercased name of your application, any "::" in
237 the name will be replaced with underscores, e.g. MyApp::Web should use
238 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
246 Enables statistics collection and reporting. You can also force this setting
247 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
248 environment settings override the application, with <MYAPP>_STATS having the
253 use Catalyst qw/-Stats=1/
257 =head2 INFORMATION ABOUT THE CURRENT REQUEST
261 Returns a L<Catalyst::Action> object for the current action, which
262 stringifies to the action name. See L<Catalyst::Action>.
266 Returns the namespace of the current action, i.e., the URI prefix
267 corresponding to the controller of the current action. For example:
269 # in Controller::Foo::Bar
270 $c->namespace; # returns 'foo/bar';
276 Returns the current L<Catalyst::Request> object, giving access to
277 information about the current client request (including parameters,
278 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
280 =head2 REQUEST FLOW HANDLING
282 =head2 $c->forward( $action [, \@arguments ] )
284 =head2 $c->forward( $class, $method, [, \@arguments ] )
286 Forwards processing to another action, by its private name. If you give a
287 class name but no method, C<process()> is called. You may also optionally
288 pass arguments in an arrayref. The action will receive the arguments in
289 C<@_> and C<< $c->req->args >>. Upon returning from the function,
290 C<< $c->req->args >> will be restored to the previous values.
292 Any data C<return>ed from the action forwarded to, will be returned by the
295 my $foodata = $c->forward('/foo');
296 $c->forward('index');
297 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
298 $c->forward('MyApp::View::TT');
300 Note that forward implies an C<<eval { }>> around the call (actually
301 C<execute> does), thus de-fatalizing all 'dies' within the called
302 action. If you want C<die> to propagate you need to do something like:
305 die $c->error if $c->error;
307 Or make sure to always return true values from your actions and write
310 $c->forward('foo') || return;
314 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
316 =head2 $c->detach( $action [, \@arguments ] )
318 =head2 $c->detach( $class, $method, [, \@arguments ] )
322 The same as C<forward>, but doesn't return to the previous action when
323 processing is finished.
325 When called with no arguments it escapes the processing chain entirely.
329 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
331 =head2 $c->go( $action [, \@arguments ] )
333 =head2 $c->go( $class, $method, [, \@arguments ] )
335 Almost the same as C<detach>, but does a full dispatch, instead of just
336 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
337 C<auto> and the method you go to is called, just like a new request.
339 C<$c-E<gt>stash> is kept unchanged.
343 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
349 Returns the current L<Catalyst::Response> object, see there for details.
353 Returns a hashref to the stash, which may be used to store data and pass
354 it between components during a request. You can also set hash keys by
355 passing arguments. The stash is automatically sent to the view. The
356 stash is cleared at the end of a request; it cannot be used for
357 persistent storage (for this you must use a session; see
358 L<Catalyst::Plugin::Session> for a complete system integrated with
361 $c->stash->{foo} = $bar;
362 $c->stash( { moose => 'majestic', qux => 0 } );
363 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
365 # stash is automatically passed to the view for use in a template
366 $c->forward( 'MyApp::View::TT' );
373 my $stash = @_ > 1 ? {@_} : $_[0];
374 croak('stash takes a hash or hashref') unless ref $stash;
375 foreach my $key ( keys %$stash ) {
376 $c->{stash}->{$key} = $stash->{$key};
384 =head2 $c->error($error, ...)
386 =head2 $c->error($arrayref)
388 Returns an arrayref containing error messages. If Catalyst encounters an
389 error while processing a request, it stores the error in $c->error. This
390 method should only be used to store fatal error messages.
392 my @error = @{ $c->error };
396 $c->error('Something bad happened');
403 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
404 croak @$error unless ref $c;
405 push @{ $c->{error} }, @$error;
407 elsif ( defined $_[0] ) { $c->{error} = undef }
408 return $c->{error} || [];
414 Contains the return value of the last executed action.
416 =head2 $c->clear_errors
418 Clear errors. You probably don't want to clear the errors unless you are
419 implementing a custom error screen.
421 This is equivalent to running
432 # search components given a name and some prefixes
433 sub _comp_search_prefixes {
434 my ( $c, $name, @prefixes ) = @_;
435 my $appclass = ref $c || $c;
436 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
438 # map the original component name to the sub part that we will search against
439 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
440 grep { /$filter/ } keys %{ $c->components };
442 # undef for a name will return all
443 return keys %eligible if !defined $name;
445 my $query = ref $name ? $name : qr/^$name$/i;
446 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
448 return map { $c->components->{ $_ } } @result if @result;
450 # if we were given a regexp to search against, we're done.
455 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
457 # don't warn if we didn't find any results, it just might not exist
459 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' );
460 $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' );
466 # Find possible names for a prefix
468 my ( $c, @prefixes ) = @_;
469 my $appclass = ref $c || $c;
471 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
473 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
477 # Filter a component before returning by calling ACCEPT_CONTEXT if available
478 sub _filter_component {
479 my ( $c, $comp, @args ) = @_;
481 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
482 return $comp->ACCEPT_CONTEXT( $c, @args );
488 =head2 COMPONENT ACCESSORS
490 =head2 $c->controller($name)
492 Gets a L<Catalyst::Controller> instance by name.
494 $c->controller('Foo')->do_stuff;
496 If the name is omitted, will return the controller for the dispatched
499 If you want to search for controllers, pass in a regexp as the argument.
501 # find all controllers that start with Foo
502 my @foo_controllers = $c->controller(qr{^Foo});
508 my ( $c, $name, @args ) = @_;
511 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
512 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
513 return $c->_filter_component( $result[ 0 ], @args );
516 return $c->component( $c->action->class );
519 =head2 $c->model($name)
521 Gets a L<Catalyst::Model> instance by name.
523 $c->model('Foo')->do_stuff;
525 Any extra arguments are directly passed to ACCEPT_CONTEXT.
527 If the name is omitted, it will look for
528 - a model object in $c->stash{current_model_instance}, then
529 - a model name in $c->stash->{current_model}, then
530 - a config setting 'default_model', or
531 - check if there is only one model, and return it if that's the case.
533 If you want to search for models, pass in a regexp as the argument.
535 # find all models that start with Foo
536 my @foo_models = $c->model(qr{^Foo});
541 my ( $c, $name, @args ) = @_;
544 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
545 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
546 return $c->_filter_component( $result[ 0 ], @args );
550 return $c->stash->{current_model_instance}
551 if $c->stash->{current_model_instance};
552 return $c->model( $c->stash->{current_model} )
553 if $c->stash->{current_model};
555 return $c->model( $c->config->{default_model} )
556 if $c->config->{default_model};
558 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
561 $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' );
562 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
563 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
564 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
565 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
568 return $c->_filter_component( $comp );
572 =head2 $c->view($name)
574 Gets a L<Catalyst::View> instance by name.
576 $c->view('Foo')->do_stuff;
578 Any extra arguments are directly passed to ACCEPT_CONTEXT.
580 If the name is omitted, it will look for
581 - a view object in $c->stash{current_view_instance}, then
582 - a view name in $c->stash->{current_view}, then
583 - a config setting 'default_view', or
584 - check if there is only one view, and return it if that's the case.
586 If you want to search for views, pass in a regexp as the argument.
588 # find all views that start with Foo
589 my @foo_views = $c->view(qr{^Foo});
594 my ( $c, $name, @args ) = @_;
597 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
598 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
599 return $c->_filter_component( $result[ 0 ], @args );
603 return $c->stash->{current_view_instance}
604 if $c->stash->{current_view_instance};
605 return $c->view( $c->stash->{current_view} )
606 if $c->stash->{current_view};
608 return $c->view( $c->config->{default_view} )
609 if $c->config->{default_view};
611 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
614 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
615 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
616 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
617 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
618 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
621 return $c->_filter_component( $comp );
624 =head2 $c->controllers
626 Returns the available names which can be passed to $c->controller
632 return $c->_comp_names(qw/Controller C/);
637 Returns the available names which can be passed to $c->model
643 return $c->_comp_names(qw/Model M/);
649 Returns the available names which can be passed to $c->view
655 return $c->_comp_names(qw/View V/);
658 =head2 $c->comp($name)
660 =head2 $c->component($name)
662 Gets a component object by name. This method is not recommended,
663 unless you want to get a specific component by full
664 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
665 should be used instead.
667 If C<$name> is a regexp, a list of components matched against the full
668 component name will be returned.
673 my ( $c, $name, @args ) = @_;
676 my $comps = $c->components;
679 # is it the exact name?
680 return $comps->{ $name } if exists $comps->{ $name };
682 # perhaps we just omitted "MyApp"?
683 my $composed = ( ref $c || $c ) . "::${name}";
684 return $comps->{ $composed } if exists $comps->{ $composed };
686 # search all of the models, views and controllers
687 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
688 return $c->_filter_component( $comp, @args ) if $comp;
691 # This is here so $c->comp( '::M::' ) works
692 my $query = ref $name ? $name : qr{$name}i;
694 my @result = grep { m{$query} } keys %{ $c->components };
695 return @result if ref $name;
698 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
699 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
703 # I would expect to return an empty list here, but that breaks back-compat
707 return sort keys %{ $c->components };
710 =head2 CLASS DATA AND HELPER CLASSES
714 Returns or takes a hashref containing the application's configuration.
716 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
718 You can also use a C<YAML>, C<XML> or C<Config::General> config file
719 like myapp.yml in your applications home directory. See
720 L<Catalyst::Plugin::ConfigLoader>.
723 db: dsn:SQLite:foo.db
731 $c->log->warn("Setting config after setup has been run is not a good idea.")
732 if ( @_ and $c->setup_finished );
734 $c->NEXT::config(@_);
739 Returns the logging object instance. Unless it is already set, Catalyst
740 sets this up with a L<Catalyst::Log> object. To use your own log class,
741 set the logger with the C<< __PACKAGE__->log >> method prior to calling
742 C<< __PACKAGE__->setup >>.
744 __PACKAGE__->log( MyLogger->new );
749 $c->log->info( 'Now logging with my own logger!' );
751 Your log class should implement the methods described in
757 Overload to enable debug messages (same as -Debug option).
759 Note that this is a static method, not an accessor and should be overloaded
760 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
766 =head2 $c->dispatcher
768 Returns the dispatcher instance. Stringifies to class name. See
769 L<Catalyst::Dispatcher>.
773 Returns the engine instance. Stringifies to the class name. See
777 =head2 UTILITY METHODS
779 =head2 $c->path_to(@path)
781 Merges C<@path> with C<< $c->config->{home} >> and returns a
782 L<Path::Class::Dir> object.
786 $c->path_to( 'db', 'sqlite.db' );
791 my ( $c, @path ) = @_;
792 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
793 if ( -d $path ) { return $path }
794 else { return Path::Class::File->new( $c->config->{home}, @path ) }
797 =head2 $c->plugin( $name, $class, @args )
799 Helper method for plugins. It creates a classdata accessor/mutator and
800 loads and instantiates the given class.
802 MyApp->plugin( 'prototype', 'HTML::Prototype' );
804 $c->prototype->define_javascript_functions;
809 my ( $class, $name, $plugin, @args ) = @_;
810 $class->_register_plugin( $plugin, 1 );
812 eval { $plugin->import };
813 $class->mk_classdata($name);
815 eval { $obj = $plugin->new(@args) };
818 Catalyst::Exception->throw( message =>
819 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
823 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
829 Initializes the dispatcher and engine, loads any plugins, and loads the
830 model, view, and controller components. You may also specify an array
831 of plugins to load here, if you choose to not load them in the C<use
835 MyApp->setup( qw/-Debug/ );
840 my ( $class, @arguments ) = @_;
842 $class->log->warn("Running setup twice is not a good idea.")
843 if ( $class->setup_finished );
845 unless ( $class->isa('Catalyst') ) {
847 Catalyst::Exception->throw(
848 message => qq/'$class' does not inherit from Catalyst/ );
851 if ( $class->arguments ) {
852 @arguments = ( @arguments, @{ $class->arguments } );
858 foreach (@arguments) {
862 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
864 elsif (/^-(\w+)=?(.*)$/) {
865 $flags->{ lc $1 } = $2;
868 push @{ $flags->{plugins} }, $_;
872 $class->setup_home( delete $flags->{home} );
874 $class->setup_log( delete $flags->{log} );
875 $class->setup_plugins( delete $flags->{plugins} );
876 $class->setup_dispatcher( delete $flags->{dispatcher} );
877 $class->setup_engine( delete $flags->{engine} );
878 $class->setup_stats( delete $flags->{stats} );
880 for my $flag ( sort keys %{$flags} ) {
882 if ( my $code = $class->can( 'setup_' . $flag ) ) {
883 &$code( $class, delete $flags->{$flag} );
886 $class->log->warn(qq/Unknown flag "$flag"/);
890 eval { require Catalyst::Devel; };
891 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
892 $class->log->warn(<<"EOF");
893 You are running an old script!
895 Please update by running (this will overwrite existing files):
896 catalyst.pl -force -scripts $class
898 or (this will not overwrite existing files):
899 catalyst.pl -scripts $class
904 if ( $class->debug ) {
905 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
908 my $t = Text::SimpleTable->new(74);
909 $t->row($_) for @plugins;
910 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
913 my $dispatcher = $class->dispatcher;
914 my $engine = $class->engine;
915 my $home = $class->config->{home};
917 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
918 $class->log->debug(qq/Loaded engine "$engine"/);
922 ? $class->log->debug(qq/Found home "$home"/)
923 : $class->log->debug(qq/Home "$home" doesn't exist/)
924 : $class->log->debug(q/Couldn't find home/);
929 no warnings qw/redefine/;
930 local *setup = sub { };
934 # Initialize our data structure
935 $class->components( {} );
937 $class->setup_components;
939 if ( $class->debug ) {
940 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
941 for my $comp ( sort keys %{ $class->components } ) {
942 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
943 $t->row( $comp, $type );
945 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
946 if ( keys %{ $class->components } );
949 # Add our self to components, since we are also a component
950 $class->components->{$class} = $class;
952 $class->setup_actions;
954 if ( $class->debug ) {
955 my $name = $class->config->{name} || 'Application';
956 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
958 $class->log->_flush() if $class->log->can('_flush');
960 $class->setup_finished(1);
963 =head2 $c->uri_for( $path, @args?, \%query_values? )
965 Merges path with C<< $c->request->base >> for absolute URIs and with
966 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
967 object. If any args are passed, they are added at the end of the path.
968 If the last argument to C<uri_for> is a hash reference, it is assumed to
969 contain GET parameter key/value pairs, which will be appended to the URI
972 Note that uri_for is destructive to the passed hashref. Subsequent calls
973 with the same hashref may have unintended results.
975 Instead of C<$path>, you can also optionally pass a C<$action> object
976 which will be resolved to a path using
977 C<< $c->dispatcher->uri_for_action >>; if the first element of
978 C<@args> is an arrayref it is treated as a list of captures to be passed
979 to C<uri_for_action>.
984 my ( $c, $path, @args ) = @_;
986 if ( Scalar::Util::blessed($path) ) { # action object
987 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
990 $path = $c->dispatcher->uri_for_action($path, $captures);
991 return undef unless defined($path);
992 $path = '/' if $path eq '';
995 undef($path) if (defined $path && $path eq '');
998 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1000 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1001 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1003 unshift(@args, $path);
1005 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1006 my $namespace = $c->namespace;
1007 if (defined $path) { # cheesy hack to handle path '../foo'
1008 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1010 unshift(@args, $namespace || '');
1013 # join args with '/', or a blank string
1014 my $args = join('/', grep { defined($_) } @args);
1015 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1017 my $base = $c->req->base;
1018 my $class = ref($base);
1019 $base =~ s{(?<!/)$}{/};
1023 if (my @keys = keys %$params) {
1024 # somewhat lifted from URI::_query's query_form
1025 $query = '?'.join('&', map {
1026 my $val = $params->{$_};
1027 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1030 $val = '' unless defined $val;
1033 utf8::encode( $_ ) if utf8::is_utf8($_);
1034 # using the URI::Escape pattern here so utf8 chars survive
1035 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1037 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1041 my $res = bless(\"${base}${args}${query}", $class);
1045 =head2 $c->welcome_message
1047 Returns the Catalyst welcome HTML page.
1051 sub welcome_message {
1053 my $name = $c->config->{name};
1054 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1055 my $prefix = Catalyst::Utils::appprefix( ref $c );
1056 $c->response->content_type('text/html; charset=utf-8');
1058 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1059 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1060 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1062 <meta http-equiv="Content-Language" content="en" />
1063 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1064 <title>$name on Catalyst $VERSION</title>
1065 <style type="text/css">
1068 background-color: #eee;
1075 margin-bottom: 10px;
1077 background-color: #ccc;
1078 border: 1px solid #aaa;
1083 font-family: verdana, tahoma, sans-serif;
1086 font-family: verdana, tahoma, sans-serif;
1089 text-decoration: none;
1091 border-bottom: 1px dotted #bbb;
1093 :link:hover, :visited:hover {
1106 background-color: #fff;
1107 border: 1px solid #aaa;
1111 font-weight: normal;
1133 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1138 <img src="$logo" alt="Catalyst Logo" />
1140 <p>Welcome to the world of Catalyst.
1141 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1142 framework will make web development something you had
1143 never expected it to be: Fun, rewarding, and quick.</p>
1144 <h2>What to do now?</h2>
1145 <p>That really depends on what <b>you</b> want to do.
1146 We do, however, provide you with a few starting points.</p>
1147 <p>If you want to jump right into web development with Catalyst
1148 you might want to start with a tutorial.</p>
1149 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1151 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1153 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1154 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1156 <h2>What to do next?</h2>
1157 <p>Next it's time to write an actual application. Use the
1158 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1159 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1160 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1161 they can save you a lot of work.</p>
1162 <pre><code>script/${prefix}_create.pl -help</code></pre>
1163 <p>Also, be sure to check out the vast and growing
1164 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1165 you are likely to find what you need there.
1169 <p>Catalyst has a very active community. Here are the main places to
1170 get in touch with us.</p>
1173 <a href="http://dev.catalyst.perl.org">Wiki</a>
1176 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1179 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1182 <h2>In conclusion</h2>
1183 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1184 as we enjoyed making it. Please contact us if you have ideas
1185 for improvement or other feedback.</p>
1193 =head1 INTERNAL METHODS
1195 These methods are not meant to be used by end users.
1197 =head2 $c->components
1199 Returns a hash of components.
1201 =head2 $c->context_class
1203 Returns or sets the context class.
1207 Returns a hashref containing coderefs and execution counts (needed for
1208 deep recursion detection).
1212 Returns the number of actions on the current internal execution stack.
1216 Dispatches a request to actions.
1220 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1222 =head2 $c->dispatcher_class
1224 Returns or sets the dispatcher class.
1226 =head2 $c->dump_these
1228 Returns a list of 2-element array references (name, structure) pairs
1229 that will be dumped on the error page in debug mode.
1235 [ Request => $c->req ],
1236 [ Response => $c->res ],
1237 [ Stash => $c->stash ],
1238 [ Config => $c->config ];
1241 =head2 $c->engine_class
1243 Returns or sets the engine class.
1245 =head2 $c->execute( $class, $coderef )
1247 Execute a coderef in given class and catch exceptions. Errors are available
1253 my ( $c, $class, $code ) = @_;
1254 $class = $c->component($class) || $class;
1257 if ( $c->depth >= $RECURSION ) {
1258 my $action = "$code";
1259 $action = "/$action" unless $action =~ /->/;
1260 my $error = qq/Deep recursion detected calling "$action"/;
1261 $c->log->error($error);
1267 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1269 push( @{ $c->stack }, $code );
1271 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1273 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1275 my $last = pop( @{ $c->stack } );
1277 if ( my $error = $@ ) {
1278 if ( !ref($error) and $error eq $DETACH ) {
1279 die $DETACH if($c->depth > 1);
1281 elsif ( !ref($error) and $error eq $GO ) {
1282 die $GO if($c->depth > 0);
1285 unless ( ref $error ) {
1286 no warnings 'uninitialized';
1288 my $class = $last->class;
1289 my $name = $last->name;
1290 $error = qq/Caught exception in $class->$name "$error"/;
1299 sub _stats_start_execute {
1300 my ( $c, $code ) = @_;
1302 return if ( ( $code->name =~ /^_.*/ )
1303 && ( !$c->config->{show_internal_actions} ) );
1305 $c->counter->{"$code"}++;
1307 my $action = "$code";
1308 $action = "/$action" unless $action =~ /->/;
1310 # determine if the call was the result of a forward
1311 # this is done by walking up the call stack and looking for a calling
1312 # sub of Catalyst::forward before the eval
1314 for my $index ( 2 .. 11 ) {
1316 if ( ( caller($index) )[0] eq 'Catalyst'
1317 && ( caller($index) )[3] eq '(eval)' );
1319 if ( ( caller($index) )[3] =~ /forward$/ ) {
1320 $callsub = ( caller($index) )[3];
1321 $action = "-> $action";
1326 my $uid = "$code" . $c->counter->{"$code"};
1328 # is this a root-level call or a forwarded call?
1329 if ( $callsub =~ /forward$/ ) {
1331 # forward, locate the caller
1332 if ( my $parent = $c->stack->[-1] ) {
1335 parent => "$parent" . $c->counter->{"$parent"},
1341 # forward with no caller may come from a plugin
1360 sub _stats_finish_execute {
1361 my ( $c, $info ) = @_;
1362 $c->stats->profile( end => $info );
1365 =head2 $c->_localize_fields( sub { }, \%keys );
1369 sub _localize_fields {
1370 my ( $c, $localized, $code ) = ( @_ );
1372 my $request = delete $localized->{request} || {};
1373 my $response = delete $localized->{response} || {};
1375 local @{ $c }{ keys %$localized } = values %$localized;
1376 local @{ $c->request }{ keys %$request } = values %$request;
1377 local @{ $c->response }{ keys %$response } = values %$response;
1384 Finalizes the request.
1391 for my $error ( @{ $c->error } ) {
1392 $c->log->error($error);
1395 # Allow engine to handle finalize flow (for POE)
1396 if ( $c->engine->can('finalize') ) {
1397 $c->engine->finalize($c);
1401 $c->finalize_uploads;
1404 if ( $#{ $c->error } >= 0 ) {
1408 $c->finalize_headers;
1411 if ( $c->request->method eq 'HEAD' ) {
1412 $c->response->body('');
1418 if ($c->use_stats) {
1419 my $elapsed = sprintf '%f', $c->stats->elapsed;
1420 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1422 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1425 return $c->response->status;
1428 =head2 $c->finalize_body
1434 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1436 =head2 $c->finalize_cookies
1442 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1444 =head2 $c->finalize_error
1450 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1452 =head2 $c->finalize_headers
1458 sub finalize_headers {
1461 # Check if we already finalized headers
1462 return if $c->response->{_finalized_headers};
1465 if ( my $location = $c->response->redirect ) {
1466 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1467 $c->response->header( Location => $location );
1469 if ( !$c->response->body ) {
1470 # Add a default body if none is already present
1472 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1478 if ( $c->response->body && !$c->response->content_length ) {
1480 # get the length from a filehandle
1481 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1483 my $stat = stat $c->response->body;
1484 if ( $stat && $stat->size > 0 ) {
1485 $c->response->content_length( $stat->size );
1488 $c->log->warn('Serving filehandle without a content-length');
1492 # everything should be bytes at this point, but just in case
1493 $c->response->content_length( bytes::length( $c->response->body ) );
1498 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1499 $c->response->headers->remove_header("Content-Length");
1500 $c->response->body('');
1503 $c->finalize_cookies;
1505 $c->engine->finalize_headers( $c, @_ );
1508 $c->response->{_finalized_headers} = 1;
1511 =head2 $c->finalize_output
1513 An alias for finalize_body.
1515 =head2 $c->finalize_read
1517 Finalizes the input after reading is complete.
1521 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1523 =head2 $c->finalize_uploads
1525 Finalizes uploads. Cleans up any temporary files.
1529 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1531 =head2 $c->get_action( $action, $namespace )
1533 Gets an action in a given namespace.
1537 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1539 =head2 $c->get_actions( $action, $namespace )
1541 Gets all actions of a given name in a namespace and all parent
1546 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1548 =head2 $c->handle_request( $class, @arguments )
1550 Called to handle each HTTP request.
1554 sub handle_request {
1555 my ( $class, @arguments ) = @_;
1557 # Always expect worst case!
1560 if ($class->debug) {
1561 my $secs = time - $START || 1;
1562 my $av = sprintf '%.3f', $COUNT / $secs;
1563 my $time = localtime time;
1564 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1567 my $c = $class->prepare(@arguments);
1569 $status = $c->finalize;
1572 if ( my $error = $@ ) {
1574 $class->log->error(qq/Caught exception in engine "$error"/);
1578 $class->log->_flush() if $class->log->can('_flush');
1582 =head2 $c->prepare( @arguments )
1584 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1590 my ( $class, @arguments ) = @_;
1592 $class->context_class( ref $class || $class ) unless $class->context_class;
1593 my $c = $class->context_class->new(
1597 request => $class->request_class->new(
1600 body_parameters => {},
1602 headers => HTTP::Headers->new,
1604 query_parameters => {},
1610 response => $class->response_class->new(
1614 headers => HTTP::Headers->new(),
1623 $c->stats($class->stats_class->new)->enable($c->use_stats);
1625 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1628 # For on-demand data
1629 $c->request->{_context} = $c;
1630 $c->response->{_context} = $c;
1631 weaken( $c->request->{_context} );
1632 weaken( $c->response->{_context} );
1634 # Allow engine to direct the prepare flow (for POE)
1635 if ( $c->engine->can('prepare') ) {
1636 $c->engine->prepare( $c, @arguments );
1639 $c->prepare_request(@arguments);
1640 $c->prepare_connection;
1641 $c->prepare_query_parameters;
1642 $c->prepare_headers;
1643 $c->prepare_cookies;
1646 # Prepare the body for reading, either by prepare_body
1647 # or the user, if they are using $c->read
1650 # Parse the body unless the user wants it on-demand
1651 unless ( $c->config->{parse_on_demand} ) {
1656 my $method = $c->req->method || '';
1657 my $path = $c->req->path;
1658 $path = '/' unless length $path;
1659 my $address = $c->req->address || '';
1661 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1669 =head2 $c->prepare_action
1671 Prepares action. See L<Catalyst::Dispatcher>.
1675 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1677 =head2 $c->prepare_body
1679 Prepares message body.
1686 # Do we run for the first time?
1687 return if defined $c->request->{_body};
1689 # Initialize on-demand data
1690 $c->engine->prepare_body( $c, @_ );
1691 $c->prepare_parameters;
1692 $c->prepare_uploads;
1694 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1695 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1696 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1697 my $param = $c->req->body_parameters->{$key};
1698 my $value = defined($param) ? $param : '';
1700 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1702 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1706 =head2 $c->prepare_body_chunk( $chunk )
1708 Prepares a chunk of data before sending it to L<HTTP::Body>.
1710 See L<Catalyst::Engine>.
1714 sub prepare_body_chunk {
1716 $c->engine->prepare_body_chunk( $c, @_ );
1719 =head2 $c->prepare_body_parameters
1721 Prepares body parameters.
1725 sub prepare_body_parameters {
1727 $c->engine->prepare_body_parameters( $c, @_ );
1730 =head2 $c->prepare_connection
1732 Prepares connection.
1736 sub prepare_connection {
1738 $c->engine->prepare_connection( $c, @_ );
1741 =head2 $c->prepare_cookies
1747 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1749 =head2 $c->prepare_headers
1755 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1757 =head2 $c->prepare_parameters
1759 Prepares parameters.
1763 sub prepare_parameters {
1765 $c->prepare_body_parameters;
1766 $c->engine->prepare_parameters( $c, @_ );
1769 =head2 $c->prepare_path
1771 Prepares path and base.
1775 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1777 =head2 $c->prepare_query_parameters
1779 Prepares query parameters.
1783 sub prepare_query_parameters {
1786 $c->engine->prepare_query_parameters( $c, @_ );
1788 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1789 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1790 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1791 my $param = $c->req->query_parameters->{$key};
1792 my $value = defined($param) ? $param : '';
1794 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1796 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1800 =head2 $c->prepare_read
1802 Prepares the input for reading.
1806 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1808 =head2 $c->prepare_request
1810 Prepares the engine request.
1814 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1816 =head2 $c->prepare_uploads
1822 sub prepare_uploads {
1825 $c->engine->prepare_uploads( $c, @_ );
1827 if ( $c->debug && keys %{ $c->request->uploads } ) {
1828 my $t = Text::SimpleTable->new(
1829 [ 12, 'Parameter' ],
1834 for my $key ( sort keys %{ $c->request->uploads } ) {
1835 my $upload = $c->request->uploads->{$key};
1836 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1837 $t->row( $key, $u->filename, $u->type, $u->size );
1840 $c->log->debug( "File Uploads are:\n" . $t->draw );
1844 =head2 $c->prepare_write
1846 Prepares the output for writing.
1850 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1852 =head2 $c->request_class
1854 Returns or sets the request class.
1856 =head2 $c->response_class
1858 Returns or sets the response class.
1860 =head2 $c->read( [$maxlength] )
1862 Reads a chunk of data from the request body. This method is designed to
1863 be used in a while loop, reading C<$maxlength> bytes on every call.
1864 C<$maxlength> defaults to the size of the request if not specified.
1866 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1869 Warning: If you use read(), Catalyst will not process the body,
1870 so you will not be able to access POST parameters or file uploads via
1871 $c->request. You must handle all body parsing yourself.
1875 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1883 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1885 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1887 Sets an action in a given namespace.
1891 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1893 =head2 $c->setup_actions($component)
1895 Sets up actions for a component.
1899 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1901 =head2 $c->setup_components
1903 Sets up components. Specify a C<setup_components> config option to pass
1904 additional options directly to L<Module::Pluggable>. To add additional
1905 search paths, specify a key named C<search_extra> as an array
1906 reference. Items in the array beginning with C<::> will have the
1907 application class name prepended to them.
1911 sub setup_components {
1914 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1915 my $config = $class->config->{ setup_components };
1916 my $extra = delete $config->{ search_extra } || [];
1918 push @paths, @$extra;
1920 my $locator = Module::Pluggable::Object->new(
1921 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1925 my @comps = sort { length $a <=> length $b } $locator->plugins;
1926 my %comps = map { $_ => 1 } @comps;
1928 for my $component ( @comps ) {
1930 # We pass ignore_loaded here so that overlay files for (e.g.)
1931 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1932 # we know M::P::O found a file on disk so this is safe
1934 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1936 my $module = $class->setup_component( $component );
1938 $component => $module,
1940 $_ => $class->setup_component( $_ )
1942 not exists $comps{$_}
1943 } Devel::InnerPackage::list_packages( $component )
1946 for my $key ( keys %modules ) {
1947 $class->components->{ $key } = $modules{ $key };
1952 =head2 $c->setup_component
1956 sub setup_component {
1957 my( $class, $component ) = @_;
1959 unless ( $component->can( 'COMPONENT' ) ) {
1963 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1964 my $config = $class->config->{ $suffix } || {};
1966 my $instance = eval { $component->COMPONENT( $class, $config ); };
1968 if ( my $error = $@ ) {
1970 Catalyst::Exception->throw(
1971 message => qq/Couldn't instantiate component "$component", "$error"/
1975 Catalyst::Exception->throw(
1977 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1978 ) unless eval { $instance->can( 'can' ) };
1983 =head2 $c->setup_dispatcher
1989 sub setup_dispatcher {
1990 my ( $class, $dispatcher ) = @_;
1993 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1996 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1997 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2000 unless ($dispatcher) {
2001 $dispatcher = $class->dispatcher_class;
2004 unless (Class::Inspector->loaded($dispatcher)) {
2005 require Class::Inspector->filename($dispatcher);
2008 # dispatcher instance
2009 $class->dispatcher( $dispatcher->new );
2012 =head2 $c->setup_engine
2019 my ( $class, $engine ) = @_;
2022 $engine = 'Catalyst::Engine::' . $engine;
2025 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2026 $engine = 'Catalyst::Engine::' . $env;
2029 if ( $ENV{MOD_PERL} ) {
2031 # create the apache method
2034 *{"$class\::apache"} = sub { shift->engine->apache };
2037 my ( $software, $version ) =
2038 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2041 $version =~ s/(\.[^.]+)\./$1/g;
2043 if ( $software eq 'mod_perl' ) {
2047 if ( $version >= 1.99922 ) {
2048 $engine = 'Catalyst::Engine::Apache2::MP20';
2051 elsif ( $version >= 1.9901 ) {
2052 $engine = 'Catalyst::Engine::Apache2::MP19';
2055 elsif ( $version >= 1.24 ) {
2056 $engine = 'Catalyst::Engine::Apache::MP13';
2060 Catalyst::Exception->throw( message =>
2061 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2066 # install the correct mod_perl handler
2067 if ( $version >= 1.9901 ) {
2068 *handler = sub : method {
2069 shift->handle_request(@_);
2073 *handler = sub ($$) { shift->handle_request(@_) };
2078 elsif ( $software eq 'Zeus-Perl' ) {
2079 $engine = 'Catalyst::Engine::Zeus';
2083 Catalyst::Exception->throw(
2084 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2089 $engine = $class->engine_class;
2092 unless (Class::Inspector->loaded($engine)) {
2093 require Class::Inspector->filename($engine);
2096 # check for old engines that are no longer compatible
2098 if ( $engine->isa('Catalyst::Engine::Apache')
2099 && !Catalyst::Engine::Apache->VERSION )
2104 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2105 && Catalyst::Engine::Server->VERSION le '0.02' )
2110 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2111 && $engine->VERSION eq '0.01' )
2116 elsif ($engine->isa('Catalyst::Engine::Zeus')
2117 && $engine->VERSION eq '0.01' )
2123 Catalyst::Exception->throw( message =>
2124 qq/Engine "$engine" is not supported by this version of Catalyst/
2129 $class->engine( $engine->new );
2132 =head2 $c->setup_home
2134 Sets up the home directory.
2139 my ( $class, $home ) = @_;
2141 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2146 $home = Catalyst::Utils::home($class);
2150 $class->config->{home} ||= $home;
2151 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2155 =head2 $c->setup_log
2162 my ( $class, $debug ) = @_;
2164 unless ( $class->log ) {
2165 $class->log( Catalyst::Log->new );
2168 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2169 if ( defined($env_debug) ? $env_debug : $debug ) {
2171 *{"$class\::debug"} = sub { 1 };
2172 $class->log->debug('Debug messages enabled');
2176 =head2 $c->setup_plugins
2182 =head2 $c->setup_stats
2184 Sets up timing statistics class.
2189 my ( $class, $stats ) = @_;
2191 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2193 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2194 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2196 *{"$class\::use_stats"} = sub { 1 };
2197 $class->log->debug('Statistics enabled');
2202 =head2 $c->registered_plugins
2204 Returns a sorted list of the plugins which have either been stated in the
2205 import list or which have been added via C<< MyApp->plugin(@args); >>.
2207 If passed a given plugin name, it will report a boolean value indicating
2208 whether or not that plugin is loaded. A fully qualified name is required if
2209 the plugin name does not begin with C<Catalyst::Plugin::>.
2211 if ($c->registered_plugins('Some::Plugin')) {
2219 sub registered_plugins {
2221 return sort keys %{ $proto->_plugins } unless @_;
2223 return 1 if exists $proto->_plugins->{$plugin};
2224 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2227 sub _register_plugin {
2228 my ( $proto, $plugin, $instant ) = @_;
2229 my $class = ref $proto || $proto;
2231 # no ignore_loaded here, the plugin may already have been
2232 # defined in memory and we don't want to error on "no file" if so
2234 Catalyst::Utils::ensure_class_loaded( $plugin );
2236 $proto->_plugins->{$plugin} = 1;
2239 unshift @{"$class\::ISA"}, $plugin;
2245 my ( $class, $plugins ) = @_;
2247 $class->_plugins( {} ) unless $class->_plugins;
2249 for my $plugin ( reverse @$plugins ) {
2251 unless ( $plugin =~ s/\A\+// ) {
2252 $plugin = "Catalyst::Plugin::$plugin";
2255 $class->_register_plugin($plugin);
2262 Returns an arrayref of the internal execution stack (actions that are
2263 currently executing).
2265 =head2 $c->stats_class
2267 Returns or sets the stats (timing statistics) class.
2269 =head2 $c->use_stats
2271 Returns 1 when stats collection is enabled. Stats collection is enabled
2272 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2273 environment variable is set.
2275 Note that this is a static method, not an accessor and should be overloaded
2276 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2283 =head2 $c->write( $data )
2285 Writes $data to the output stream. When using this method directly, you
2286 will need to manually set the C<Content-Length> header to the length of
2287 your output data, if known.
2294 # Finalize headers if someone manually writes output
2295 $c->finalize_headers;
2297 return $c->engine->write( $c, @_ );
2302 Returns the Catalyst version number. Mostly useful for "powered by"
2303 messages in template systems.
2307 sub version { return $Catalyst::VERSION }
2309 =head1 INTERNAL ACTIONS
2311 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2312 C<_ACTION>, and C<_END>. These are by default not shown in the private
2313 action table, but you can make them visible with a config parameter.
2315 MyApp->config->{show_internal_actions} = 1;
2317 =head1 CASE SENSITIVITY
2319 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2320 mapped to C</foo/bar>. You can activate case sensitivity with a config
2323 MyApp->config->{case_sensitive} = 1;
2325 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2327 =head1 ON-DEMAND PARSER
2329 The request body is usually parsed at the beginning of a request,
2330 but if you want to handle input yourself, you can enable on-demand
2331 parsing with a config parameter.
2333 MyApp->config->{parse_on_demand} = 1;
2335 =head1 PROXY SUPPORT
2337 Many production servers operate using the common double-server approach,
2338 with a lightweight frontend web server passing requests to a larger
2339 backend server. An application running on the backend server must deal
2340 with two problems: the remote user always appears to be C<127.0.0.1> and
2341 the server's hostname will appear to be C<localhost> regardless of the
2342 virtual host that the user connected through.
2344 Catalyst will automatically detect this situation when you are running
2345 the frontend and backend servers on the same machine. The following
2346 changes are made to the request.
2348 $c->req->address is set to the user's real IP address, as read from
2349 the HTTP X-Forwarded-For header.
2351 The host value for $c->req->base and $c->req->uri is set to the real
2352 host, as read from the HTTP X-Forwarded-Host header.
2354 Obviously, your web server must support these headers for this to work.
2356 In a more complex server farm environment where you may have your
2357 frontend proxy server(s) on different machines, you will need to set a
2358 configuration option to tell Catalyst to read the proxied data from the
2361 MyApp->config->{using_frontend_proxy} = 1;
2363 If you do not wish to use the proxy support at all, you may set:
2365 MyApp->config->{ignore_frontend_proxy} = 1;
2367 =head1 THREAD SAFETY
2369 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2370 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2371 believe the Catalyst core to be thread-safe.
2373 If you plan to operate in a threaded environment, remember that all other
2374 modules you are using must also be thread-safe. Some modules, most notably
2375 L<DBD::SQLite>, are not thread-safe.
2381 Join #catalyst on irc.perl.org.
2385 http://lists.rawmode.org/mailman/listinfo/catalyst
2386 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2390 http://catalyst.perl.org
2394 http://dev.catalyst.perl.org
2398 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2400 =head2 L<Catalyst::Manual> - The Catalyst Manual
2402 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2404 =head2 L<Catalyst::Engine> - Core engine
2406 =head2 L<Catalyst::Log> - Log class.
2408 =head2 L<Catalyst::Request> - Request object
2410 =head2 L<Catalyst::Response> - Response object
2412 =head2 L<Catalyst::Test> - The test suite.
2486 Sebastian Riedel, C<sri@oook.de>
2490 This library is free software, you can redistribute it and/or modify it under
2491 the same terms as Perl itself.