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_03';
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=static 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 = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
457 # no results? try against full names
459 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
462 # don't warn if we didn't find any results, it just might not exist
464 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
465 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' );
466 $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' );
472 # Find possible names for a prefix
474 my ( $c, @prefixes ) = @_;
475 my $appclass = ref $c || $c;
477 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
479 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
483 # Filter a component before returning by calling ACCEPT_CONTEXT if available
484 sub _filter_component {
485 my ( $c, $comp, @args ) = @_;
487 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
488 return $comp->ACCEPT_CONTEXT( $c, @args );
494 =head2 COMPONENT ACCESSORS
496 =head2 $c->controller($name)
498 Gets a L<Catalyst::Controller> instance by name.
500 $c->controller('Foo')->do_stuff;
502 If the name is omitted, will return the controller for the dispatched
505 If you want to search for controllers, pass in a regexp as the argument.
507 # find all controllers that start with Foo
508 my @foo_controllers = $c->controller(qr{^Foo});
514 my ( $c, $name, @args ) = @_;
517 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
518 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
519 return $c->_filter_component( $result[ 0 ], @args );
522 return $c->component( $c->action->class );
525 =head2 $c->model($name)
527 Gets a L<Catalyst::Model> instance by name.
529 $c->model('Foo')->do_stuff;
531 Any extra arguments are directly passed to ACCEPT_CONTEXT.
533 If the name is omitted, it will look for
534 - a model object in $c->stash->{current_model_instance}, then
535 - a model name in $c->stash->{current_model}, then
536 - a config setting 'default_model', or
537 - check if there is only one model, and return it if that's the case.
539 If you want to search for models, pass in a regexp as the argument.
541 # find all models that start with Foo
542 my @foo_models = $c->model(qr{^Foo});
547 my ( $c, $name, @args ) = @_;
550 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
551 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
552 return $c->_filter_component( $result[ 0 ], @args );
556 return $c->stash->{current_model_instance}
557 if $c->stash->{current_model_instance};
558 return $c->model( $c->stash->{current_model} )
559 if $c->stash->{current_model};
561 return $c->model( $c->config->{default_model} )
562 if $c->config->{default_model};
564 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
567 $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' );
568 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
569 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
570 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
571 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
574 return $c->_filter_component( $comp );
578 =head2 $c->view($name)
580 Gets a L<Catalyst::View> instance by name.
582 $c->view('Foo')->do_stuff;
584 Any extra arguments are directly passed to ACCEPT_CONTEXT.
586 If the name is omitted, it will look for
587 - a view object in $c->stash->{current_view_instance}, then
588 - a view name in $c->stash->{current_view}, then
589 - a config setting 'default_view', or
590 - check if there is only one view, and return it if that's the case.
592 If you want to search for views, pass in a regexp as the argument.
594 # find all views that start with Foo
595 my @foo_views = $c->view(qr{^Foo});
600 my ( $c, $name, @args ) = @_;
603 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
604 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
605 return $c->_filter_component( $result[ 0 ], @args );
609 return $c->stash->{current_view_instance}
610 if $c->stash->{current_view_instance};
611 return $c->view( $c->stash->{current_view} )
612 if $c->stash->{current_view};
614 return $c->view( $c->config->{default_view} )
615 if $c->config->{default_view};
617 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
620 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
621 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
622 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
623 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
624 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
627 return $c->_filter_component( $comp );
630 =head2 $c->controllers
632 Returns the available names which can be passed to $c->controller
638 return $c->_comp_names(qw/Controller C/);
643 Returns the available names which can be passed to $c->model
649 return $c->_comp_names(qw/Model M/);
655 Returns the available names which can be passed to $c->view
661 return $c->_comp_names(qw/View V/);
664 =head2 $c->comp($name)
666 =head2 $c->component($name)
668 Gets a component object by name. This method is not recommended,
669 unless you want to get a specific component by full
670 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
671 should be used instead.
673 If C<$name> is a regexp, a list of components matched against the full
674 component name will be returned.
679 my ( $c, $name, @args ) = @_;
682 my $comps = $c->components;
685 # is it the exact name?
686 return $c->_filter_component( $comps->{ $name }, @args )
687 if exists $comps->{ $name };
689 # perhaps we just omitted "MyApp"?
690 my $composed = ( ref $c || $c ) . "::${name}";
691 return $c->_filter_component( $comps->{ $composed }, @args )
692 if exists $comps->{ $composed };
694 # search all of the models, views and controllers
695 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
696 return $c->_filter_component( $comp, @args ) if $comp;
699 # This is here so $c->comp( '::M::' ) works
700 my $query = ref $name ? $name : qr{$name}i;
702 my @result = grep { m{$query} } keys %{ $c->components };
703 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
706 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
707 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
708 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
709 return $c->_filter_component( $result[ 0 ], @args );
712 # I would expect to return an empty list here, but that breaks back-compat
716 return sort keys %{ $c->components };
719 =head2 CLASS DATA AND HELPER CLASSES
723 Returns or takes a hashref containing the application's configuration.
725 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
727 You can also use a C<YAML>, C<XML> or C<Config::General> config file
728 like myapp.yml in your applications home directory. See
729 L<Catalyst::Plugin::ConfigLoader>.
732 db: dsn:SQLite:foo.db
740 $c->log->warn("Setting config after setup has been run is not a good idea.")
741 if ( @_ and $c->setup_finished );
743 $c->NEXT::config(@_);
748 Returns the logging object instance. Unless it is already set, Catalyst
749 sets this up with a L<Catalyst::Log> object. To use your own log class,
750 set the logger with the C<< __PACKAGE__->log >> method prior to calling
751 C<< __PACKAGE__->setup >>.
753 __PACKAGE__->log( MyLogger->new );
758 $c->log->info( 'Now logging with my own logger!' );
760 Your log class should implement the methods described in
766 Overload to enable debug messages (same as -Debug option).
768 Note that this is a static method, not an accessor and should be overloaded
769 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
775 =head2 $c->dispatcher
777 Returns the dispatcher instance. Stringifies to class name. See
778 L<Catalyst::Dispatcher>.
782 Returns the engine instance. Stringifies to the class name. See
786 =head2 UTILITY METHODS
788 =head2 $c->path_to(@path)
790 Merges C<@path> with C<< $c->config->{home} >> and returns a
791 L<Path::Class::Dir> object.
795 $c->path_to( 'db', 'sqlite.db' );
800 my ( $c, @path ) = @_;
801 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
802 if ( -d $path ) { return $path }
803 else { return Path::Class::File->new( $c->config->{home}, @path ) }
806 =head2 $c->plugin( $name, $class, @args )
808 Helper method for plugins. It creates a classdata accessor/mutator and
809 loads and instantiates the given class.
811 MyApp->plugin( 'prototype', 'HTML::Prototype' );
813 $c->prototype->define_javascript_functions;
818 my ( $class, $name, $plugin, @args ) = @_;
819 $class->_register_plugin( $plugin, 1 );
821 eval { $plugin->import };
822 $class->mk_classdata($name);
824 eval { $obj = $plugin->new(@args) };
827 Catalyst::Exception->throw( message =>
828 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
832 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
838 Initializes the dispatcher and engine, loads any plugins, and loads the
839 model, view, and controller components. You may also specify an array
840 of plugins to load here, if you choose to not load them in the C<use
844 MyApp->setup( qw/-Debug/ );
849 my ( $class, @arguments ) = @_;
851 $class->log->warn("Running setup twice is not a good idea.")
852 if ( $class->setup_finished );
854 unless ( $class->isa('Catalyst') ) {
856 Catalyst::Exception->throw(
857 message => qq/'$class' does not inherit from Catalyst/ );
860 if ( $class->arguments ) {
861 @arguments = ( @arguments, @{ $class->arguments } );
867 foreach (@arguments) {
871 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
873 elsif (/^-(\w+)=?(.*)$/) {
874 $flags->{ lc $1 } = $2;
877 push @{ $flags->{plugins} }, $_;
881 $class->setup_home( delete $flags->{home} );
883 $class->setup_log( delete $flags->{log} );
884 $class->setup_plugins( delete $flags->{plugins} );
885 $class->setup_dispatcher( delete $flags->{dispatcher} );
886 $class->setup_engine( delete $flags->{engine} );
887 $class->setup_stats( delete $flags->{stats} );
889 for my $flag ( sort keys %{$flags} ) {
891 if ( my $code = $class->can( 'setup_' . $flag ) ) {
892 &$code( $class, delete $flags->{$flag} );
895 $class->log->warn(qq/Unknown flag "$flag"/);
899 eval { require Catalyst::Devel; };
900 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
901 $class->log->warn(<<"EOF");
902 You are running an old script!
904 Please update by running (this will overwrite existing files):
905 catalyst.pl -force -scripts $class
907 or (this will not overwrite existing files):
908 catalyst.pl -scripts $class
913 if ( $class->debug ) {
914 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
917 my $t = Text::SimpleTable->new(74);
918 $t->row($_) for @plugins;
919 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
922 my $dispatcher = $class->dispatcher;
923 my $engine = $class->engine;
924 my $home = $class->config->{home};
926 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
927 $class->log->debug(qq/Loaded engine "$engine"/);
931 ? $class->log->debug(qq/Found home "$home"/)
932 : $class->log->debug(qq/Home "$home" doesn't exist/)
933 : $class->log->debug(q/Couldn't find home/);
938 no warnings qw/redefine/;
939 local *setup = sub { };
943 # Initialize our data structure
944 $class->components( {} );
946 $class->setup_components;
948 if ( $class->debug ) {
949 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
950 for my $comp ( sort keys %{ $class->components } ) {
951 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
952 $t->row( $comp, $type );
954 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
955 if ( keys %{ $class->components } );
958 # Add our self to components, since we are also a component
959 $class->components->{$class} = $class;
961 $class->setup_actions;
963 if ( $class->debug ) {
964 my $name = $class->config->{name} || 'Application';
965 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
967 $class->log->_flush() if $class->log->can('_flush');
969 $class->setup_finished(1);
972 =head2 $c->uri_for( $path, @args?, \%query_values? )
974 Merges path with C<< $c->request->base >> for absolute URIs and with
975 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
976 object. If any args are passed, they are added at the end of the path.
977 If the last argument to C<uri_for> is a hash reference, it is assumed to
978 contain GET parameter key/value pairs, which will be appended to the URI
981 Note that uri_for is destructive to the passed hashref. Subsequent calls
982 with the same hashref may have unintended results.
984 Instead of C<$path>, you can also optionally pass a C<$action> object
985 which will be resolved to a path using
986 C<< $c->dispatcher->uri_for_action >>; if the first element of
987 C<@args> is an arrayref it is treated as a list of captures to be passed
988 to C<uri_for_action>.
993 my ( $c, $path, @args ) = @_;
995 if ( Scalar::Util::blessed($path) ) { # action object
996 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
999 $path = $c->dispatcher->uri_for_action($path, $captures);
1000 return undef unless defined($path);
1001 $path = '/' if $path eq '';
1004 undef($path) if (defined $path && $path eq '');
1007 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1009 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1010 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1012 unshift(@args, $path);
1014 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1015 my $namespace = $c->namespace;
1016 if (defined $path) { # cheesy hack to handle path '../foo'
1017 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1019 unshift(@args, $namespace || '');
1022 # join args with '/', or a blank string
1023 my $args = join('/', grep { defined($_) } @args);
1024 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1026 my $base = $c->req->base;
1027 my $class = ref($base);
1028 $base =~ s{(?<!/)$}{/};
1032 if (my @keys = keys %$params) {
1033 # somewhat lifted from URI::_query's query_form
1034 $query = '?'.join('&', map {
1035 my $val = $params->{$_};
1036 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1039 $val = '' unless defined $val;
1042 utf8::encode( $_ ) if utf8::is_utf8($_);
1043 # using the URI::Escape pattern here so utf8 chars survive
1044 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1046 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1050 my $res = bless(\"${base}${args}${query}", $class);
1054 =head2 $c->welcome_message
1056 Returns the Catalyst welcome HTML page.
1060 sub welcome_message {
1062 my $name = $c->config->{name};
1063 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1064 my $prefix = Catalyst::Utils::appprefix( ref $c );
1065 $c->response->content_type('text/html; charset=utf-8');
1067 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1068 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1069 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1071 <meta http-equiv="Content-Language" content="en" />
1072 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1073 <title>$name on Catalyst $VERSION</title>
1074 <style type="text/css">
1077 background-color: #eee;
1084 margin-bottom: 10px;
1086 background-color: #ccc;
1087 border: 1px solid #aaa;
1092 font-family: verdana, tahoma, sans-serif;
1095 font-family: verdana, tahoma, sans-serif;
1098 text-decoration: none;
1100 border-bottom: 1px dotted #bbb;
1102 :link:hover, :visited:hover {
1115 background-color: #fff;
1116 border: 1px solid #aaa;
1120 font-weight: normal;
1142 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1147 <img src="$logo" alt="Catalyst Logo" />
1149 <p>Welcome to the world of Catalyst.
1150 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1151 framework will make web development something you had
1152 never expected it to be: Fun, rewarding, and quick.</p>
1153 <h2>What to do now?</h2>
1154 <p>That really depends on what <b>you</b> want to do.
1155 We do, however, provide you with a few starting points.</p>
1156 <p>If you want to jump right into web development with Catalyst
1157 you might want to start with a tutorial.</p>
1158 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1160 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1162 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1163 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1165 <h2>What to do next?</h2>
1166 <p>Next it's time to write an actual application. Use the
1167 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1168 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1169 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1170 they can save you a lot of work.</p>
1171 <pre><code>script/${prefix}_create.pl -help</code></pre>
1172 <p>Also, be sure to check out the vast and growing
1173 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1174 you are likely to find what you need there.
1178 <p>Catalyst has a very active community. Here are the main places to
1179 get in touch with us.</p>
1182 <a href="http://dev.catalyst.perl.org">Wiki</a>
1185 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1188 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1191 <h2>In conclusion</h2>
1192 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1193 as we enjoyed making it. Please contact us if you have ideas
1194 for improvement or other feedback.</p>
1202 =head1 INTERNAL METHODS
1204 These methods are not meant to be used by end users.
1206 =head2 $c->components
1208 Returns a hash of components.
1210 =head2 $c->context_class
1212 Returns or sets the context class.
1216 Returns a hashref containing coderefs and execution counts (needed for
1217 deep recursion detection).
1221 Returns the number of actions on the current internal execution stack.
1225 Dispatches a request to actions.
1229 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1231 =head2 $c->dispatcher_class
1233 Returns or sets the dispatcher class.
1235 =head2 $c->dump_these
1237 Returns a list of 2-element array references (name, structure) pairs
1238 that will be dumped on the error page in debug mode.
1244 [ Request => $c->req ],
1245 [ Response => $c->res ],
1246 [ Stash => $c->stash ],
1247 [ Config => $c->config ];
1250 =head2 $c->engine_class
1252 Returns or sets the engine class.
1254 =head2 $c->execute( $class, $coderef )
1256 Execute a coderef in given class and catch exceptions. Errors are available
1262 my ( $c, $class, $code ) = @_;
1263 $class = $c->component($class) || $class;
1266 if ( $c->depth >= $RECURSION ) {
1267 my $action = "$code";
1268 $action = "/$action" unless $action =~ /->/;
1269 my $error = qq/Deep recursion detected calling "$action"/;
1270 $c->log->error($error);
1276 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1278 push( @{ $c->stack }, $code );
1280 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1282 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1284 my $last = pop( @{ $c->stack } );
1286 if ( my $error = $@ ) {
1287 if ( !ref($error) and $error eq $DETACH ) {
1288 die $DETACH if($c->depth > 1);
1290 elsif ( !ref($error) and $error eq $GO ) {
1291 die $GO if($c->depth > 0);
1294 unless ( ref $error ) {
1295 no warnings 'uninitialized';
1297 my $class = $last->class;
1298 my $name = $last->name;
1299 $error = qq/Caught exception in $class->$name "$error"/;
1308 sub _stats_start_execute {
1309 my ( $c, $code ) = @_;
1311 return if ( ( $code->name =~ /^_.*/ )
1312 && ( !$c->config->{show_internal_actions} ) );
1314 $c->counter->{"$code"}++;
1316 my $action = "$code";
1317 $action = "/$action" unless $action =~ /->/;
1319 # determine if the call was the result of a forward
1320 # this is done by walking up the call stack and looking for a calling
1321 # sub of Catalyst::forward before the eval
1323 for my $index ( 2 .. 11 ) {
1325 if ( ( caller($index) )[0] eq 'Catalyst'
1326 && ( caller($index) )[3] eq '(eval)' );
1328 if ( ( caller($index) )[3] =~ /forward$/ ) {
1329 $callsub = ( caller($index) )[3];
1330 $action = "-> $action";
1335 my $uid = "$code" . $c->counter->{"$code"};
1337 # is this a root-level call or a forwarded call?
1338 if ( $callsub =~ /forward$/ ) {
1340 # forward, locate the caller
1341 if ( my $parent = $c->stack->[-1] ) {
1344 parent => "$parent" . $c->counter->{"$parent"},
1350 # forward with no caller may come from a plugin
1369 sub _stats_finish_execute {
1370 my ( $c, $info ) = @_;
1371 $c->stats->profile( end => $info );
1374 =head2 $c->_localize_fields( sub { }, \%keys );
1378 sub _localize_fields {
1379 my ( $c, $localized, $code ) = ( @_ );
1381 my $request = delete $localized->{request} || {};
1382 my $response = delete $localized->{response} || {};
1384 local @{ $c }{ keys %$localized } = values %$localized;
1385 local @{ $c->request }{ keys %$request } = values %$request;
1386 local @{ $c->response }{ keys %$response } = values %$response;
1393 Finalizes the request.
1400 for my $error ( @{ $c->error } ) {
1401 $c->log->error($error);
1404 # Allow engine to handle finalize flow (for POE)
1405 if ( $c->engine->can('finalize') ) {
1406 $c->engine->finalize($c);
1410 $c->finalize_uploads;
1413 if ( $#{ $c->error } >= 0 ) {
1417 $c->finalize_headers;
1420 if ( $c->request->method eq 'HEAD' ) {
1421 $c->response->body('');
1427 if ($c->use_stats) {
1428 my $elapsed = sprintf '%f', $c->stats->elapsed;
1429 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1431 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1434 return $c->response->status;
1437 =head2 $c->finalize_body
1443 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1445 =head2 $c->finalize_cookies
1451 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1453 =head2 $c->finalize_error
1459 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1461 =head2 $c->finalize_headers
1467 sub finalize_headers {
1470 # Check if we already finalized headers
1471 return if $c->response->{_finalized_headers};
1474 if ( my $location = $c->response->redirect ) {
1475 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1476 $c->response->header( Location => $location );
1478 if ( !$c->response->body ) {
1479 # Add a default body if none is already present
1481 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1487 if ( $c->response->body && !$c->response->content_length ) {
1489 # get the length from a filehandle
1490 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1492 my $stat = stat $c->response->body;
1493 if ( $stat && $stat->size > 0 ) {
1494 $c->response->content_length( $stat->size );
1497 $c->log->warn('Serving filehandle without a content-length');
1501 # everything should be bytes at this point, but just in case
1502 $c->response->content_length( bytes::length( $c->response->body ) );
1507 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1508 $c->response->headers->remove_header("Content-Length");
1509 $c->response->body('');
1512 $c->finalize_cookies;
1514 $c->engine->finalize_headers( $c, @_ );
1517 $c->response->{_finalized_headers} = 1;
1520 =head2 $c->finalize_output
1522 An alias for finalize_body.
1524 =head2 $c->finalize_read
1526 Finalizes the input after reading is complete.
1530 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1532 =head2 $c->finalize_uploads
1534 Finalizes uploads. Cleans up any temporary files.
1538 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1540 =head2 $c->get_action( $action, $namespace )
1542 Gets an action in a given namespace.
1546 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1548 =head2 $c->get_actions( $action, $namespace )
1550 Gets all actions of a given name in a namespace and all parent
1555 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1557 =head2 $c->handle_request( $class, @arguments )
1559 Called to handle each HTTP request.
1563 sub handle_request {
1564 my ( $class, @arguments ) = @_;
1566 # Always expect worst case!
1569 if ($class->debug) {
1570 my $secs = time - $START || 1;
1571 my $av = sprintf '%.3f', $COUNT / $secs;
1572 my $time = localtime time;
1573 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1576 my $c = $class->prepare(@arguments);
1578 $status = $c->finalize;
1581 if ( my $error = $@ ) {
1583 $class->log->error(qq/Caught exception in engine "$error"/);
1587 $class->log->_flush() if $class->log->can('_flush');
1591 =head2 $c->prepare( @arguments )
1593 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1599 my ( $class, @arguments ) = @_;
1601 $class->context_class( ref $class || $class ) unless $class->context_class;
1602 my $c = $class->context_class->new(
1606 request => $class->request_class->new(
1609 body_parameters => {},
1611 headers => HTTP::Headers->new,
1613 query_parameters => {},
1619 response => $class->response_class->new(
1623 headers => HTTP::Headers->new(),
1632 $c->stats($class->stats_class->new)->enable($c->use_stats);
1634 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1637 # For on-demand data
1638 $c->request->{_context} = $c;
1639 $c->response->{_context} = $c;
1640 weaken( $c->request->{_context} );
1641 weaken( $c->response->{_context} );
1643 # Allow engine to direct the prepare flow (for POE)
1644 if ( $c->engine->can('prepare') ) {
1645 $c->engine->prepare( $c, @arguments );
1648 $c->prepare_request(@arguments);
1649 $c->prepare_connection;
1650 $c->prepare_query_parameters;
1651 $c->prepare_headers;
1652 $c->prepare_cookies;
1655 # Prepare the body for reading, either by prepare_body
1656 # or the user, if they are using $c->read
1659 # Parse the body unless the user wants it on-demand
1660 unless ( $c->config->{parse_on_demand} ) {
1665 my $method = $c->req->method || '';
1666 my $path = $c->req->path;
1667 $path = '/' unless length $path;
1668 my $address = $c->req->address || '';
1670 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1678 =head2 $c->prepare_action
1680 Prepares action. See L<Catalyst::Dispatcher>.
1684 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1686 =head2 $c->prepare_body
1688 Prepares message body.
1695 # Do we run for the first time?
1696 return if defined $c->request->{_body};
1698 # Initialize on-demand data
1699 $c->engine->prepare_body( $c, @_ );
1700 $c->prepare_parameters;
1701 $c->prepare_uploads;
1703 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1704 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1705 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1706 my $param = $c->req->body_parameters->{$key};
1707 my $value = defined($param) ? $param : '';
1709 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1711 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1715 =head2 $c->prepare_body_chunk( $chunk )
1717 Prepares a chunk of data before sending it to L<HTTP::Body>.
1719 See L<Catalyst::Engine>.
1723 sub prepare_body_chunk {
1725 $c->engine->prepare_body_chunk( $c, @_ );
1728 =head2 $c->prepare_body_parameters
1730 Prepares body parameters.
1734 sub prepare_body_parameters {
1736 $c->engine->prepare_body_parameters( $c, @_ );
1739 =head2 $c->prepare_connection
1741 Prepares connection.
1745 sub prepare_connection {
1747 $c->engine->prepare_connection( $c, @_ );
1750 =head2 $c->prepare_cookies
1756 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1758 =head2 $c->prepare_headers
1764 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1766 =head2 $c->prepare_parameters
1768 Prepares parameters.
1772 sub prepare_parameters {
1774 $c->prepare_body_parameters;
1775 $c->engine->prepare_parameters( $c, @_ );
1778 =head2 $c->prepare_path
1780 Prepares path and base.
1784 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1786 =head2 $c->prepare_query_parameters
1788 Prepares query parameters.
1792 sub prepare_query_parameters {
1795 $c->engine->prepare_query_parameters( $c, @_ );
1797 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1798 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1799 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1800 my $param = $c->req->query_parameters->{$key};
1801 my $value = defined($param) ? $param : '';
1803 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1805 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1809 =head2 $c->prepare_read
1811 Prepares the input for reading.
1815 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1817 =head2 $c->prepare_request
1819 Prepares the engine request.
1823 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1825 =head2 $c->prepare_uploads
1831 sub prepare_uploads {
1834 $c->engine->prepare_uploads( $c, @_ );
1836 if ( $c->debug && keys %{ $c->request->uploads } ) {
1837 my $t = Text::SimpleTable->new(
1838 [ 12, 'Parameter' ],
1843 for my $key ( sort keys %{ $c->request->uploads } ) {
1844 my $upload = $c->request->uploads->{$key};
1845 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1846 $t->row( $key, $u->filename, $u->type, $u->size );
1849 $c->log->debug( "File Uploads are:\n" . $t->draw );
1853 =head2 $c->prepare_write
1855 Prepares the output for writing.
1859 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1861 =head2 $c->request_class
1863 Returns or sets the request class.
1865 =head2 $c->response_class
1867 Returns or sets the response class.
1869 =head2 $c->read( [$maxlength] )
1871 Reads a chunk of data from the request body. This method is designed to
1872 be used in a while loop, reading C<$maxlength> bytes on every call.
1873 C<$maxlength> defaults to the size of the request if not specified.
1875 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1878 Warning: If you use read(), Catalyst will not process the body,
1879 so you will not be able to access POST parameters or file uploads via
1880 $c->request. You must handle all body parsing yourself.
1884 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1892 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1894 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1896 Sets an action in a given namespace.
1900 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1902 =head2 $c->setup_actions($component)
1904 Sets up actions for a component.
1908 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1910 =head2 $c->setup_components
1912 Sets up components. Specify a C<setup_components> config option to pass
1913 additional options directly to L<Module::Pluggable>. To add additional
1914 search paths, specify a key named C<search_extra> as an array
1915 reference. Items in the array beginning with C<::> will have the
1916 application class name prepended to them.
1918 All components found will also have any
1919 L<Devel::InnerPackage|inner packages> loaded and set up as components.
1920 Note, that modules which are B<not> an I<inner package> of the main
1921 file namespace loaded will not be instantiated as components.
1925 sub setup_components {
1928 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1929 my $config = $class->config->{ setup_components };
1930 my $extra = delete $config->{ search_extra } || [];
1932 push @paths, @$extra;
1934 my $locator = Module::Pluggable::Object->new(
1935 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1939 my @comps = sort { length $a <=> length $b } $locator->plugins;
1940 my %comps = map { $_ => 1 } @comps;
1942 for my $component ( @comps ) {
1944 # We pass ignore_loaded here so that overlay files for (e.g.)
1945 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1946 # we know M::P::O found a file on disk so this is safe
1948 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1950 my $module = $class->setup_component( $component );
1952 $component => $module,
1954 $_ => $class->setup_component( $_ )
1956 not exists $comps{$_}
1957 } Devel::InnerPackage::list_packages( $component )
1960 for my $key ( keys %modules ) {
1961 $class->components->{ $key } = $modules{ $key };
1966 =head2 $c->setup_component
1970 sub setup_component {
1971 my( $class, $component ) = @_;
1973 unless ( $component->can( 'COMPONENT' ) ) {
1977 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1978 my $config = $class->config->{ $suffix } || {};
1980 my $instance = eval { $component->COMPONENT( $class, $config ); };
1982 if ( my $error = $@ ) {
1984 Catalyst::Exception->throw(
1985 message => qq/Couldn't instantiate component "$component", "$error"/
1989 Catalyst::Exception->throw(
1991 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1992 ) unless eval { $instance->can( 'can' ) };
1997 =head2 $c->setup_dispatcher
2003 sub setup_dispatcher {
2004 my ( $class, $dispatcher ) = @_;
2007 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2010 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2011 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2014 unless ($dispatcher) {
2015 $dispatcher = $class->dispatcher_class;
2018 unless (Class::Inspector->loaded($dispatcher)) {
2019 require Class::Inspector->filename($dispatcher);
2022 # dispatcher instance
2023 $class->dispatcher( $dispatcher->new );
2026 =head2 $c->setup_engine
2033 my ( $class, $engine ) = @_;
2036 $engine = 'Catalyst::Engine::' . $engine;
2039 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2040 $engine = 'Catalyst::Engine::' . $env;
2043 if ( $ENV{MOD_PERL} ) {
2045 # create the apache method
2048 *{"$class\::apache"} = sub { shift->engine->apache };
2051 my ( $software, $version ) =
2052 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2055 $version =~ s/(\.[^.]+)\./$1/g;
2057 if ( $software eq 'mod_perl' ) {
2061 if ( $version >= 1.99922 ) {
2062 $engine = 'Catalyst::Engine::Apache2::MP20';
2065 elsif ( $version >= 1.9901 ) {
2066 $engine = 'Catalyst::Engine::Apache2::MP19';
2069 elsif ( $version >= 1.24 ) {
2070 $engine = 'Catalyst::Engine::Apache::MP13';
2074 Catalyst::Exception->throw( message =>
2075 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2080 # install the correct mod_perl handler
2081 if ( $version >= 1.9901 ) {
2082 *handler = sub : method {
2083 shift->handle_request(@_);
2087 *handler = sub ($$) { shift->handle_request(@_) };
2092 elsif ( $software eq 'Zeus-Perl' ) {
2093 $engine = 'Catalyst::Engine::Zeus';
2097 Catalyst::Exception->throw(
2098 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2103 $engine = $class->engine_class;
2106 unless (Class::Inspector->loaded($engine)) {
2107 require Class::Inspector->filename($engine);
2110 # check for old engines that are no longer compatible
2112 if ( $engine->isa('Catalyst::Engine::Apache')
2113 && !Catalyst::Engine::Apache->VERSION )
2118 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2119 && Catalyst::Engine::Server->VERSION le '0.02' )
2124 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2125 && $engine->VERSION eq '0.01' )
2130 elsif ($engine->isa('Catalyst::Engine::Zeus')
2131 && $engine->VERSION eq '0.01' )
2137 Catalyst::Exception->throw( message =>
2138 qq/Engine "$engine" is not supported by this version of Catalyst/
2143 $class->engine( $engine->new );
2146 =head2 $c->setup_home
2148 Sets up the home directory.
2153 my ( $class, $home ) = @_;
2155 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2160 $home = Catalyst::Utils::home($class);
2164 $class->config->{home} ||= $home;
2165 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2169 =head2 $c->setup_log
2176 my ( $class, $debug ) = @_;
2178 unless ( $class->log ) {
2179 $class->log( Catalyst::Log->new );
2182 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2183 if ( defined($env_debug) ? $env_debug : $debug ) {
2185 *{"$class\::debug"} = sub { 1 };
2186 $class->log->debug('Debug messages enabled');
2190 =head2 $c->setup_plugins
2196 =head2 $c->setup_stats
2198 Sets up timing statistics class.
2203 my ( $class, $stats ) = @_;
2205 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2207 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2208 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2210 *{"$class\::use_stats"} = sub { 1 };
2211 $class->log->debug('Statistics enabled');
2216 =head2 $c->registered_plugins
2218 Returns a sorted list of the plugins which have either been stated in the
2219 import list or which have been added via C<< MyApp->plugin(@args); >>.
2221 If passed a given plugin name, it will report a boolean value indicating
2222 whether or not that plugin is loaded. A fully qualified name is required if
2223 the plugin name does not begin with C<Catalyst::Plugin::>.
2225 if ($c->registered_plugins('Some::Plugin')) {
2233 sub registered_plugins {
2235 return sort keys %{ $proto->_plugins } unless @_;
2237 return 1 if exists $proto->_plugins->{$plugin};
2238 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2241 sub _register_plugin {
2242 my ( $proto, $plugin, $instant ) = @_;
2243 my $class = ref $proto || $proto;
2245 # no ignore_loaded here, the plugin may already have been
2246 # defined in memory and we don't want to error on "no file" if so
2248 Catalyst::Utils::ensure_class_loaded( $plugin );
2250 $proto->_plugins->{$plugin} = 1;
2253 unshift @{"$class\::ISA"}, $plugin;
2259 my ( $class, $plugins ) = @_;
2261 $class->_plugins( {} ) unless $class->_plugins;
2263 for my $plugin ( reverse @$plugins ) {
2265 unless ( $plugin =~ s/\A\+// ) {
2266 $plugin = "Catalyst::Plugin::$plugin";
2269 $class->_register_plugin($plugin);
2276 Returns an arrayref of the internal execution stack (actions that are
2277 currently executing).
2279 =head2 $c->stats_class
2281 Returns or sets the stats (timing statistics) class.
2283 =head2 $c->use_stats
2285 Returns 1 when stats collection is enabled. Stats collection is enabled
2286 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2287 environment variable is set.
2289 Note that this is a static method, not an accessor and should be overloaded
2290 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2297 =head2 $c->write( $data )
2299 Writes $data to the output stream. When using this method directly, you
2300 will need to manually set the C<Content-Length> header to the length of
2301 your output data, if known.
2308 # Finalize headers if someone manually writes output
2309 $c->finalize_headers;
2311 return $c->engine->write( $c, @_ );
2316 Returns the Catalyst version number. Mostly useful for "powered by"
2317 messages in template systems.
2321 sub version { return $Catalyst::VERSION }
2323 =head1 INTERNAL ACTIONS
2325 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2326 C<_ACTION>, and C<_END>. These are by default not shown in the private
2327 action table, but you can make them visible with a config parameter.
2329 MyApp->config->{show_internal_actions} = 1;
2331 =head1 CASE SENSITIVITY
2333 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2334 mapped to C</foo/bar>. You can activate case sensitivity with a config
2337 MyApp->config->{case_sensitive} = 1;
2339 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2341 =head1 ON-DEMAND PARSER
2343 The request body is usually parsed at the beginning of a request,
2344 but if you want to handle input yourself, you can enable on-demand
2345 parsing with a config parameter.
2347 MyApp->config->{parse_on_demand} = 1;
2349 =head1 PROXY SUPPORT
2351 Many production servers operate using the common double-server approach,
2352 with a lightweight frontend web server passing requests to a larger
2353 backend server. An application running on the backend server must deal
2354 with two problems: the remote user always appears to be C<127.0.0.1> and
2355 the server's hostname will appear to be C<localhost> regardless of the
2356 virtual host that the user connected through.
2358 Catalyst will automatically detect this situation when you are running
2359 the frontend and backend servers on the same machine. The following
2360 changes are made to the request.
2362 $c->req->address is set to the user's real IP address, as read from
2363 the HTTP X-Forwarded-For header.
2365 The host value for $c->req->base and $c->req->uri is set to the real
2366 host, as read from the HTTP X-Forwarded-Host header.
2368 Obviously, your web server must support these headers for this to work.
2370 In a more complex server farm environment where you may have your
2371 frontend proxy server(s) on different machines, you will need to set a
2372 configuration option to tell Catalyst to read the proxied data from the
2375 MyApp->config->{using_frontend_proxy} = 1;
2377 If you do not wish to use the proxy support at all, you may set:
2379 MyApp->config->{ignore_frontend_proxy} = 1;
2381 =head1 THREAD SAFETY
2383 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2384 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2385 believe the Catalyst core to be thread-safe.
2387 If you plan to operate in a threaded environment, remember that all other
2388 modules you are using must also be thread-safe. Some modules, most notably
2389 L<DBD::SQLite>, are not thread-safe.
2395 Join #catalyst on irc.perl.org.
2399 http://lists.rawmode.org/mailman/listinfo/catalyst
2400 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2404 http://catalyst.perl.org
2408 http://dev.catalyst.perl.org
2412 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2414 =head2 L<Catalyst::Manual> - The Catalyst Manual
2416 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2418 =head2 L<Catalyst::Engine> - Core engine
2420 =head2 L<Catalyst::Log> - Log class.
2422 =head2 L<Catalyst::Request> - Request object
2424 =head2 L<Catalyst::Response> - Response object
2426 =head2 L<Catalyst::Test> - The test suite.
2428 =head1 PROJECT FOUNDER
2430 sri: Sebastian Riedel <sri@cpan.org>
2436 acme: Leon Brocard <leon@astray.com>
2444 andyg: Andy Grundman <andy@hybridized.org>
2446 audreyt: Audrey Tang
2448 bricas: Brian Cassidy <bricas@cpan.org>
2450 chansen: Christian Hansen
2452 chicks: Christopher Hicks
2454 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2458 esskar: Sascha Kiefer
2460 fireartist: Carl Franks <cfranks@cpan.org>
2462 gabb: Danijel Milicevic
2468 jcamacho: Juan Camacho
2474 jon: Jon Schutz <jjschutz@cpan.org>
2476 marcus: Marcus Ramberg <mramberg@cpan.org>
2478 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2480 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2484 naughton: David Naughton
2486 ningu: David Kamholz <dkamholz@cpan.org>
2488 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2490 numa: Dan Sully <daniel@cpan.org>
2494 omega: Andreas Marienborg
2496 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2500 the_jester: Jesse Sheidlower
2504 willert: Sebastian Willert <willert@cpan.org>
2508 This library is free software, you can redistribute it and/or modify it under
2509 the same terms as Perl itself.