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 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
39 sub depth { scalar @{ shift->stack || [] }; }
46 # For backwards compatibility
47 *finalize_output = \&finalize_body;
52 our $RECURSION = 1000;
53 our $DETACH = "catalyst_detach\n";
55 __PACKAGE__->mk_classdata($_)
56 for qw/components arguments dispatcher engine log dispatcher_class
57 engine_class context_class request_class response_class stats_class
60 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
61 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
62 __PACKAGE__->request_class('Catalyst::Request');
63 __PACKAGE__->response_class('Catalyst::Response');
64 __PACKAGE__->stats_class('Catalyst::Stats');
66 # Remember to update this in Catalyst::Runtime as well!
68 our $VERSION = '5.7013';
71 my ( $class, @arguments ) = @_;
73 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
75 return unless $class eq 'Catalyst';
77 my $caller = caller(0);
79 unless ( $caller->isa('Catalyst') ) {
81 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
84 $caller->arguments( [@arguments] );
90 Catalyst - The Elegant MVC Web Application Framework
94 See the L<Catalyst::Manual> distribution for comprehensive
95 documentation and tutorials.
97 # Install Catalyst::Devel for helpers and other development tools
98 # use the helper to create a new application
101 # add models, views, controllers
102 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
103 script/myapp_create.pl view MyTemplate TT
104 script/myapp_create.pl controller Search
106 # built in testserver -- use -r to restart automatically on changes
107 # --help to see all available options
108 script/myapp_server.pl
110 # command line testing interface
111 script/myapp_test.pl /yada
114 use Catalyst qw/-Debug/; # include plugins here as well
116 ### In lib/MyApp/Controller/Root.pm (autocreated)
117 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
118 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
119 $c->stash->{template} = 'foo.tt'; # set the template
120 # lookup something from db -- stash vars are passed to TT
122 $c->model('Database::Foo')->search( { country => $args[0] } );
123 if ( $c->req->params->{bar} ) { # access GET or POST parameters
124 $c->forward( 'bar' ); # process another action
125 # do something else after forward returns
129 # The foo.tt TT template can use the stash data from the database
130 [% WHILE (item = data.next) %]
134 # called for /bar/of/soap, /bar/of/soap/10, etc.
135 sub bar : Path('/bar/of/soap') { ... }
137 # called for all actions, from the top-most controller downwards
139 my ( $self, $c ) = @_;
140 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
141 $c->res->redirect( '/login' ); # require login
142 return 0; # abort request and go immediately to end()
144 return 1; # success; carry on to next action
147 # called after all actions are finished
149 my ( $self, $c ) = @_;
150 if ( scalar @{ $c->error } ) { ... } # handle errors
151 return if $c->res->body; # already have a response
152 $c->forward( 'MyApp::View::TT' ); # render template
155 ### in MyApp/Controller/Foo.pm
156 # called for /foo/bar
157 sub bar : Local { ... }
159 # called for /blargle
160 sub blargle : Global { ... }
162 # an index action matches /foo, but not /foo/1, etc.
163 sub index : Private { ... }
165 ### in MyApp/Controller/Foo/Bar.pm
166 # called for /foo/bar/baz
167 sub baz : Local { ... }
169 # first Root auto is called, then Foo auto, then this
170 sub auto : Private { ... }
172 # powerful regular expression paths are also possible
173 sub details : Regex('^product/(\w+)/details$') {
174 my ( $self, $c ) = @_;
175 # extract the (\w+) from the URI
176 my $product = $c->req->captures->[0];
179 See L<Catalyst::Manual::Intro> for additional information.
183 Catalyst is a modern framework for making web applications without the
184 pain usually associated with this process. This document is a reference
185 to the main Catalyst application. If you are a new user, we suggest you
186 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
188 See L<Catalyst::Manual> for more documentation.
190 Catalyst plugins can be loaded by naming them as arguments to the "use
191 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
192 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
195 use Catalyst qw/My::Module/;
197 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
198 fully qualify the name by using a unary plus:
202 +Fully::Qualified::Plugin::Name
205 Special flags like C<-Debug> and C<-Engine> can also be specified as
206 arguments when Catalyst is loaded:
208 use Catalyst qw/-Debug My::Module/;
210 The position of plugins and flags in the chain is important, because
211 they are loaded in the order in which they appear.
213 The following flags are supported:
217 Enables debug output. You can also force this setting from the system
218 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
219 settings override the application, with <MYAPP>_DEBUG having the highest
224 Forces Catalyst to use a specific engine. Omit the
225 C<Catalyst::Engine::> prefix of the engine name, i.e.:
227 use Catalyst qw/-Engine=CGI/;
231 Forces Catalyst to use a specific home directory, e.g.:
233 use Catalyst qw[-Home=/usr/mst];
235 This can also be done in the shell environment by setting either the
236 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
237 is replaced with the uppercased name of your application, any "::" in
238 the name will be replaced with underscores, e.g. MyApp::Web should use
239 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
247 Enables statistics collection and reporting. You can also force this setting
248 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
249 environment settings override the application, with <MYAPP>_STATS having the
254 use Catalyst qw/-Stats=1/
258 =head2 INFORMATION ABOUT THE CURRENT REQUEST
262 Returns a L<Catalyst::Action> object for the current action, which
263 stringifies to the action name. See L<Catalyst::Action>.
267 Returns the namespace of the current action, i.e., the URI prefix
268 corresponding to the controller of the current action. For example:
270 # in Controller::Foo::Bar
271 $c->namespace; # returns 'foo/bar';
277 Returns the current L<Catalyst::Request> object, giving access to
278 information about the current client request (including parameters,
279 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
281 =head2 REQUEST FLOW HANDLING
283 =head2 $c->forward( $action [, \@arguments ] )
285 =head2 $c->forward( $class, $method, [, \@arguments ] )
287 Forwards processing to another action, by its private name. If you give a
288 class name but no method, C<process()> is called. You may also optionally
289 pass arguments in an arrayref. The action will receive the arguments in
290 C<@_> and C<< $c->req->args >>. Upon returning from the function,
291 C<< $c->req->args >> will be restored to the previous values.
293 Any data C<return>ed from the action forwarded to, will be returned by the
296 my $foodata = $c->forward('/foo');
297 $c->forward('index');
298 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
299 $c->forward('MyApp::View::TT');
301 Note that forward implies an C<<eval { }>> around the call (actually
302 C<execute> does), thus de-fatalizing all 'dies' within the called
303 action. If you want C<die> to propagate you need to do something like:
306 die $c->error if $c->error;
308 Or make sure to always return true values from your actions and write
311 $c->forward('foo') || return;
315 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
317 =head2 $c->detach( $action [, \@arguments ] )
319 =head2 $c->detach( $class, $method, [, \@arguments ] )
323 The same as C<forward>, but doesn't return to the previous action when
324 processing is finished.
326 When called with no arguments it escapes the processing chain entirely.
330 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
336 Returns the current L<Catalyst::Response> object, see there for details.
340 Returns a hashref to the stash, which may be used to store data and pass
341 it between components during a request. You can also set hash keys by
342 passing arguments. The stash is automatically sent to the view. The
343 stash is cleared at the end of a request; it cannot be used for
344 persistent storage (for this you must use a session; see
345 L<Catalyst::Plugin::Session> for a complete system integrated with
348 $c->stash->{foo} = $bar;
349 $c->stash( { moose => 'majestic', qux => 0 } );
350 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
352 # stash is automatically passed to the view for use in a template
353 $c->forward( 'MyApp::View::TT' );
360 my $stash = @_ > 1 ? {@_} : $_[0];
361 croak('stash takes a hash or hashref') unless ref $stash;
362 foreach my $key ( keys %$stash ) {
363 $c->{stash}->{$key} = $stash->{$key};
371 =head2 $c->error($error, ...)
373 =head2 $c->error($arrayref)
375 Returns an arrayref containing error messages. If Catalyst encounters an
376 error while processing a request, it stores the error in $c->error. This
377 method should only be used to store fatal error messages.
379 my @error = @{ $c->error };
383 $c->error('Something bad happened');
390 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
391 croak @$error unless ref $c;
392 push @{ $c->{error} }, @$error;
394 elsif ( defined $_[0] ) { $c->{error} = undef }
395 return $c->{error} || [];
401 Contains the return value of the last executed action.
403 =head2 $c->clear_errors
405 Clear errors. You probably don't want to clear the errors unless you are
406 implementing a custom error screen.
408 This is equivalent to running
422 my ( $c, @names ) = @_;
424 foreach my $name (@names) {
425 foreach my $component ( keys %{ $c->components } ) {
426 return $c->components->{$component} if $component =~ /$name/i;
433 # try explicit component names
435 my ( $c, @names ) = @_;
437 foreach my $try (@names) {
438 return $c->components->{$try} if ( exists $c->components->{$try} );
444 # like component, but try just these prefixes before regex searching,
445 # and do not try to return "sort keys %{ $c->components }"
447 my ( $c, $name, @prefixes ) = @_;
449 my $appclass = ref $c || $c;
451 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
453 my $comp = $c->_comp_explicit(@names);
454 return $comp if defined($comp);
455 $comp = $c->_comp_search($name);
459 # Find possible names for a prefix
462 my ( $c, @prefixes ) = @_;
464 my $appclass = ref $c || $c;
466 my @pre = map { "${appclass}::${_}::" } @prefixes;
470 COMPONENT: foreach my $comp ($c->component) {
471 foreach my $p (@pre) {
472 if ($comp =~ s/^$p//) {
482 # Return a component if only one matches.
484 my ( $c, @prefixes ) = @_;
486 my $appclass = ref $c || $c;
488 my ( $comp, $rest ) =
489 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
490 return $comp unless $rest;
493 # Filter a component before returning by calling ACCEPT_CONTEXT if available
494 sub _filter_component {
495 my ( $c, $comp, @args ) = @_;
496 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
497 return $comp->ACCEPT_CONTEXT( $c, @args );
499 else { return $comp }
502 =head2 COMPONENT ACCESSORS
504 =head2 $c->controller($name)
506 Gets a L<Catalyst::Controller> instance by name.
508 $c->controller('Foo')->do_stuff;
510 If the name is omitted, will return the controller for the dispatched
516 my ( $c, $name, @args ) = @_;
517 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
520 return $c->component( $c->action->class );
523 =head2 $c->model($name)
525 Gets a L<Catalyst::Model> instance by name.
527 $c->model('Foo')->do_stuff;
529 Any extra arguments are directly passed to ACCEPT_CONTEXT.
531 If the name is omitted, it will look for
532 - a model object in $c->stash{current_model_instance}, then
533 - a model name in $c->stash->{current_model}, then
534 - a config setting 'default_model', or
535 - check if there is only one model, and return it if that's the case.
540 my ( $c, $name, @args ) = @_;
541 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
545 return $c->stash->{current_model_instance}
546 if $c->stash->{current_model_instance};
547 return $c->model( $c->stash->{current_model} )
548 if $c->stash->{current_model};
550 return $c->model( $c->config->{default_model} )
551 if $c->config->{default_model};
552 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
556 =head2 $c->controllers
558 Returns the available names which can be passed to $c->controller
564 return $c->_comp_names(qw/Controller C/);
568 =head2 $c->view($name)
570 Gets a L<Catalyst::View> instance by name.
572 $c->view('Foo')->do_stuff;
574 Any extra arguments are directly passed to ACCEPT_CONTEXT.
576 If the name is omitted, it will look for
577 - a view object in $c->stash{current_view_instance}, then
578 - a view name in $c->stash->{current_view}, then
579 - a config setting 'default_view', or
580 - check if there is only one view, and return it if that's the case.
585 my ( $c, $name, @args ) = @_;
586 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
590 return $c->stash->{current_view_instance}
591 if $c->stash->{current_view_instance};
592 return $c->view( $c->stash->{current_view} )
593 if $c->stash->{current_view};
595 return $c->view( $c->config->{default_view} )
596 if $c->config->{default_view};
597 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
602 Returns the available names which can be passed to $c->model
608 return $c->_comp_names(qw/Model M/);
614 Returns the available names which can be passed to $c->view
620 return $c->_comp_names(qw/View V/);
623 =head2 $c->comp($name)
625 =head2 $c->component($name)
627 Gets a component object by name. This method is not recommended,
628 unless you want to get a specific component by full
629 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
630 should be used instead.
641 my $appclass = ref $c || $c;
644 $name, "${appclass}::${name}",
645 map { "${appclass}::${_}::${name}" }
646 qw/Model M Controller C View V/
649 my $comp = $c->_comp_explicit(@names);
650 return $c->_filter_component( $comp, @_ ) if defined($comp);
652 $comp = $c->_comp_search($name);
653 return $c->_filter_component( $comp, @_ ) if defined($comp);
656 return sort keys %{ $c->components };
661 =head2 CLASS DATA AND HELPER CLASSES
665 Returns or takes a hashref containing the application's configuration.
667 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
669 You can also use a C<YAML>, C<XML> or C<Config::General> config file
670 like myapp.yml in your applications home directory. See
671 L<Catalyst::Plugin::ConfigLoader>.
674 db: dsn:SQLite:foo.db
682 $c->log->warn("Setting config after setup has been run is not a good idea.")
683 if ( @_ and $c->setup_finished );
685 $c->NEXT::config(@_);
690 Returns the logging object instance. Unless it is already set, Catalyst
691 sets this up with a L<Catalyst::Log> object. To use your own log class,
692 set the logger with the C<< __PACKAGE__->log >> method prior to calling
693 C<< __PACKAGE__->setup >>.
695 __PACKAGE__->log( MyLogger->new );
700 $c->log->info( 'Now logging with my own logger!' );
702 Your log class should implement the methods described in
708 Overload to enable debug messages (same as -Debug option).
710 Note that this is a static method, not an accessor and should be overloaded
711 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
717 =head2 $c->dispatcher
719 Returns the dispatcher instance. Stringifies to class name. See
720 L<Catalyst::Dispatcher>.
724 Returns the engine instance. Stringifies to the class name. See
728 =head2 UTILITY METHODS
730 =head2 $c->path_to(@path)
732 Merges C<@path> with C<< $c->config->{home} >> and returns a
733 L<Path::Class::Dir> object.
737 $c->path_to( 'db', 'sqlite.db' );
742 my ( $c, @path ) = @_;
743 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
744 if ( -d $path ) { return $path }
745 else { return Path::Class::File->new( $c->config->{home}, @path ) }
748 =head2 $c->plugin( $name, $class, @args )
750 Helper method for plugins. It creates a classdata accessor/mutator and
751 loads and instantiates the given class.
753 MyApp->plugin( 'prototype', 'HTML::Prototype' );
755 $c->prototype->define_javascript_functions;
760 my ( $class, $name, $plugin, @args ) = @_;
761 $class->_register_plugin( $plugin, 1 );
763 eval { $plugin->import };
764 $class->mk_classdata($name);
766 eval { $obj = $plugin->new(@args) };
769 Catalyst::Exception->throw( message =>
770 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
774 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
780 Initializes the dispatcher and engine, loads any plugins, and loads the
781 model, view, and controller components. You may also specify an array
782 of plugins to load here, if you choose to not load them in the C<use
786 MyApp->setup( qw/-Debug/ );
791 my ( $class, @arguments ) = @_;
793 $class->log->warn("Running setup twice is not a good idea.")
794 if ( $class->setup_finished );
796 unless ( $class->isa('Catalyst') ) {
798 Catalyst::Exception->throw(
799 message => qq/'$class' does not inherit from Catalyst/ );
802 if ( $class->arguments ) {
803 @arguments = ( @arguments, @{ $class->arguments } );
809 foreach (@arguments) {
813 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
815 elsif (/^-(\w+)=?(.*)$/) {
816 $flags->{ lc $1 } = $2;
819 push @{ $flags->{plugins} }, $_;
823 $class->setup_home( delete $flags->{home} );
825 $class->setup_log( delete $flags->{log} );
826 $class->setup_plugins( delete $flags->{plugins} );
827 $class->setup_dispatcher( delete $flags->{dispatcher} );
828 $class->setup_engine( delete $flags->{engine} );
829 $class->setup_stats( delete $flags->{stats} );
831 for my $flag ( sort keys %{$flags} ) {
833 if ( my $code = $class->can( 'setup_' . $flag ) ) {
834 &$code( $class, delete $flags->{$flag} );
837 $class->log->warn(qq/Unknown flag "$flag"/);
841 eval { require Catalyst::Devel; };
842 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
843 $class->log->warn(<<"EOF");
844 You are running an old script!
846 Please update by running (this will overwrite existing files):
847 catalyst.pl -force -scripts $class
849 or (this will not overwrite existing files):
850 catalyst.pl -scripts $class
855 if ( $class->debug ) {
856 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
859 my $t = Text::SimpleTable->new(74);
860 $t->row($_) for @plugins;
861 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
864 my $dispatcher = $class->dispatcher;
865 my $engine = $class->engine;
866 my $home = $class->config->{home};
868 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
869 $class->log->debug(qq/Loaded engine "$engine"/);
873 ? $class->log->debug(qq/Found home "$home"/)
874 : $class->log->debug(qq/Home "$home" doesn't exist/)
875 : $class->log->debug(q/Couldn't find home/);
880 no warnings qw/redefine/;
881 local *setup = sub { };
885 # Initialize our data structure
886 $class->components( {} );
888 $class->setup_components;
890 if ( $class->debug ) {
891 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
892 for my $comp ( sort keys %{ $class->components } ) {
893 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
894 $t->row( $comp, $type );
896 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
897 if ( keys %{ $class->components } );
900 # Add our self to components, since we are also a component
901 $class->components->{$class} = $class;
903 $class->setup_actions;
905 if ( $class->debug ) {
906 my $name = $class->config->{name} || 'Application';
907 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
909 $class->log->_flush() if $class->log->can('_flush');
911 $class->setup_finished(1);
914 =head2 $c->uri_for( $path, @args?, \%query_values? )
916 Merges path with C<< $c->request->base >> for absolute URIs and with
917 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
918 object. If any args are passed, they are added at the end of the path.
919 If the last argument to C<uri_for> is a hash reference, it is assumed to
920 contain GET parameter key/value pairs, which will be appended to the URI
923 Note that uri_for is destructive to the passed hashref. Subsequent calls
924 with the same hashref may have unintended results.
926 Instead of C<$path>, you can also optionally pass a C<$action> object
927 which will be resolved to a path using
928 C<< $c->dispatcher->uri_for_action >>; if the first element of
929 C<@args> is an arrayref it is treated as a list of captures to be passed
930 to C<uri_for_action>.
935 my ( $c, $path, @args ) = @_;
937 if ( Scalar::Util::blessed($path) ) { # action object
938 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
941 $path = $c->dispatcher->uri_for_action($path, $captures);
942 return undef unless defined($path);
943 $path = '/' if $path eq '';
946 undef($path) if (defined $path && $path eq '');
949 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
951 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
952 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
954 unshift(@args, $path);
956 unless (defined $path && $path =~ s!^/!!) { # in-place strip
957 my $namespace = $c->namespace;
958 if (defined $path) { # cheesy hack to handle path '../foo'
959 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
961 unshift(@args, $namespace || '');
964 # join args with '/', or a blank string
965 my $args = join('/', grep { defined($_) } @args);
966 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
968 my $base = $c->req->base;
969 my $class = ref($base);
970 $base =~ s{(?<!/)$}{/};
974 if (my @keys = keys %$params) {
975 # somewhat lifted from URI::_query's query_form
976 $query = '?'.join('&', map {
977 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
980 my $val = $params->{$_};
981 $val = '' unless defined $val;
984 utf8::encode( $_ ) if utf8::is_utf8($_);
985 # using the URI::Escape pattern here so utf8 chars survive
986 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
988 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
992 my $res = bless(\"${base}${args}${query}", $class);
996 =head2 $c->welcome_message
998 Returns the Catalyst welcome HTML page.
1002 sub welcome_message {
1004 my $name = $c->config->{name};
1005 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1006 my $prefix = Catalyst::Utils::appprefix( ref $c );
1007 $c->response->content_type('text/html; charset=utf-8');
1009 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1010 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1011 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1013 <meta http-equiv="Content-Language" content="en" />
1014 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1015 <title>$name on Catalyst $VERSION</title>
1016 <style type="text/css">
1019 background-color: #eee;
1026 margin-bottom: 10px;
1028 background-color: #ccc;
1029 border: 1px solid #aaa;
1034 font-family: verdana, tahoma, sans-serif;
1037 font-family: verdana, tahoma, sans-serif;
1040 text-decoration: none;
1042 border-bottom: 1px dotted #bbb;
1044 :link:hover, :visited:hover {
1057 background-color: #fff;
1058 border: 1px solid #aaa;
1062 font-weight: normal;
1084 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1089 <img src="$logo" alt="Catalyst Logo" />
1091 <p>Welcome to the world of Catalyst.
1092 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1093 framework will make web development something you had
1094 never expected it to be: Fun, rewarding, and quick.</p>
1095 <h2>What to do now?</h2>
1096 <p>That really depends on what <b>you</b> want to do.
1097 We do, however, provide you with a few starting points.</p>
1098 <p>If you want to jump right into web development with Catalyst
1099 you might want want to start with a tutorial.</p>
1100 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1102 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1104 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1105 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1107 <h2>What to do next?</h2>
1108 <p>Next it's time to write an actual application. Use the
1109 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1110 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1111 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1112 they can save you a lot of work.</p>
1113 <pre><code>script/${prefix}_create.pl -help</code></pre>
1114 <p>Also, be sure to check out the vast and growing
1115 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1116 you are likely to find what you need there.
1120 <p>Catalyst has a very active community. Here are the main places to
1121 get in touch with us.</p>
1124 <a href="http://dev.catalyst.perl.org">Wiki</a>
1127 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1130 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1133 <h2>In conclusion</h2>
1134 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1135 as we enjoyed making it. Please contact us if you have ideas
1136 for improvement or other feedback.</p>
1144 =head1 INTERNAL METHODS
1146 These methods are not meant to be used by end users.
1148 =head2 $c->components
1150 Returns a hash of components.
1152 =head2 $c->context_class
1154 Returns or sets the context class.
1158 Returns a hashref containing coderefs and execution counts (needed for
1159 deep recursion detection).
1163 Returns the number of actions on the current internal execution stack.
1167 Dispatches a request to actions.
1171 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1173 =head2 $c->dispatcher_class
1175 Returns or sets the dispatcher class.
1177 =head2 $c->dump_these
1179 Returns a list of 2-element array references (name, structure) pairs
1180 that will be dumped on the error page in debug mode.
1186 [ Request => $c->req ],
1187 [ Response => $c->res ],
1188 [ Stash => $c->stash ],
1189 [ Config => $c->config ];
1192 =head2 $c->engine_class
1194 Returns or sets the engine class.
1196 =head2 $c->execute( $class, $coderef )
1198 Execute a coderef in given class and catch exceptions. Errors are available
1204 my ( $c, $class, $code ) = @_;
1205 $class = $c->component($class) || $class;
1208 if ( $c->depth >= $RECURSION ) {
1209 my $action = "$code";
1210 $action = "/$action" unless $action =~ /->/;
1211 my $error = qq/Deep recursion detected calling "$action"/;
1212 $c->log->error($error);
1218 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1220 push( @{ $c->stack }, $code );
1222 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1224 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1226 my $last = pop( @{ $c->stack } );
1228 if ( my $error = $@ ) {
1229 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1231 unless ( ref $error ) {
1232 no warnings 'uninitialized';
1234 my $class = $last->class;
1235 my $name = $last->name;
1236 $error = qq/Caught exception in $class->$name "$error"/;
1245 sub _stats_start_execute {
1246 my ( $c, $code ) = @_;
1248 return if ( ( $code->name =~ /^_.*/ )
1249 && ( !$c->config->{show_internal_actions} ) );
1251 $c->counter->{"$code"}++;
1253 my $action = "$code";
1254 $action = "/$action" unless $action =~ /->/;
1256 # determine if the call was the result of a forward
1257 # this is done by walking up the call stack and looking for a calling
1258 # sub of Catalyst::forward before the eval
1260 for my $index ( 2 .. 11 ) {
1262 if ( ( caller($index) )[0] eq 'Catalyst'
1263 && ( caller($index) )[3] eq '(eval)' );
1265 if ( ( caller($index) )[3] =~ /forward$/ ) {
1266 $callsub = ( caller($index) )[3];
1267 $action = "-> $action";
1272 my $uid = "$code" . $c->counter->{"$code"};
1274 # is this a root-level call or a forwarded call?
1275 if ( $callsub =~ /forward$/ ) {
1277 # forward, locate the caller
1278 if ( my $parent = $c->stack->[-1] ) {
1281 parent => "$parent" . $c->counter->{"$parent"},
1287 # forward with no caller may come from a plugin
1306 sub _stats_finish_execute {
1307 my ( $c, $info ) = @_;
1308 $c->stats->profile( end => $info );
1311 =head2 $c->_localize_fields( sub { }, \%keys );
1315 sub _localize_fields {
1316 my ( $c, $localized, $code ) = ( @_ );
1318 my $request = delete $localized->{request} || {};
1319 my $response = delete $localized->{response} || {};
1321 local @{ $c }{ keys %$localized } = values %$localized;
1322 local @{ $c->request }{ keys %$request } = values %$request;
1323 local @{ $c->response }{ keys %$response } = values %$response;
1330 Finalizes the request.
1337 for my $error ( @{ $c->error } ) {
1338 $c->log->error($error);
1341 # Allow engine to handle finalize flow (for POE)
1342 if ( $c->engine->can('finalize') ) {
1343 $c->engine->finalize($c);
1347 $c->finalize_uploads;
1350 if ( $#{ $c->error } >= 0 ) {
1354 $c->finalize_headers;
1357 if ( $c->request->method eq 'HEAD' ) {
1358 $c->response->body('');
1364 if ($c->use_stats) {
1365 my $elapsed = sprintf '%f', $c->stats->elapsed;
1366 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1368 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1371 return $c->response->status;
1374 =head2 $c->finalize_body
1380 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1382 =head2 $c->finalize_cookies
1388 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1390 =head2 $c->finalize_error
1396 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1398 =head2 $c->finalize_headers
1404 sub finalize_headers {
1407 # Check if we already finalized headers
1408 return if $c->response->{_finalized_headers};
1411 if ( my $location = $c->response->redirect ) {
1412 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1413 $c->response->header( Location => $location );
1415 if ( !$c->response->body ) {
1416 # Add a default body if none is already present
1418 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1424 if ( $c->response->body && !$c->response->content_length ) {
1426 # get the length from a filehandle
1427 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1429 my $stat = stat $c->response->body;
1430 if ( $stat && $stat->size > 0 ) {
1431 $c->response->content_length( $stat->size );
1434 $c->log->warn('Serving filehandle without a content-length');
1438 # everything should be bytes at this point, but just in case
1439 $c->response->content_length( bytes::length( $c->response->body ) );
1444 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1445 $c->response->headers->remove_header("Content-Length");
1446 $c->response->body('');
1449 $c->finalize_cookies;
1451 $c->engine->finalize_headers( $c, @_ );
1454 $c->response->{_finalized_headers} = 1;
1457 =head2 $c->finalize_output
1459 An alias for finalize_body.
1461 =head2 $c->finalize_read
1463 Finalizes the input after reading is complete.
1467 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1469 =head2 $c->finalize_uploads
1471 Finalizes uploads. Cleans up any temporary files.
1475 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1477 =head2 $c->get_action( $action, $namespace )
1479 Gets an action in a given namespace.
1483 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1485 =head2 $c->get_actions( $action, $namespace )
1487 Gets all actions of a given name in a namespace and all parent
1492 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1494 =head2 $c->handle_request( $class, @arguments )
1496 Called to handle each HTTP request.
1500 sub handle_request {
1501 my ( $class, @arguments ) = @_;
1503 # Always expect worst case!
1506 if ($class->debug) {
1507 my $secs = time - $START || 1;
1508 my $av = sprintf '%.3f', $COUNT / $secs;
1509 my $time = localtime time;
1510 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1513 my $c = $class->prepare(@arguments);
1515 $status = $c->finalize;
1518 if ( my $error = $@ ) {
1520 $class->log->error(qq/Caught exception in engine "$error"/);
1524 $class->log->_flush() if $class->log->can('_flush');
1528 =head2 $c->prepare( @arguments )
1530 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1536 my ( $class, @arguments ) = @_;
1538 $class->context_class( ref $class || $class ) unless $class->context_class;
1539 my $c = $class->context_class->new(
1543 request => $class->request_class->new(
1546 body_parameters => {},
1548 headers => HTTP::Headers->new,
1550 query_parameters => {},
1556 response => $class->response_class->new(
1560 headers => HTTP::Headers->new(),
1569 $c->stats($class->stats_class->new)->enable($c->use_stats);
1571 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1574 # For on-demand data
1575 $c->request->{_context} = $c;
1576 $c->response->{_context} = $c;
1577 weaken( $c->request->{_context} );
1578 weaken( $c->response->{_context} );
1580 # Allow engine to direct the prepare flow (for POE)
1581 if ( $c->engine->can('prepare') ) {
1582 $c->engine->prepare( $c, @arguments );
1585 $c->prepare_request(@arguments);
1586 $c->prepare_connection;
1587 $c->prepare_query_parameters;
1588 $c->prepare_headers;
1589 $c->prepare_cookies;
1592 # Prepare the body for reading, either by prepare_body
1593 # or the user, if they are using $c->read
1596 # Parse the body unless the user wants it on-demand
1597 unless ( $c->config->{parse_on_demand} ) {
1602 my $method = $c->req->method || '';
1603 my $path = $c->req->path || '/';
1604 my $address = $c->req->address || '';
1606 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1614 =head2 $c->prepare_action
1616 Prepares action. See L<Catalyst::Dispatcher>.
1620 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1622 =head2 $c->prepare_body
1624 Prepares message body.
1631 # Do we run for the first time?
1632 return if defined $c->request->{_body};
1634 # Initialize on-demand data
1635 $c->engine->prepare_body( $c, @_ );
1636 $c->prepare_parameters;
1637 $c->prepare_uploads;
1639 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1640 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1641 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1642 my $param = $c->req->body_parameters->{$key};
1643 my $value = defined($param) ? $param : '';
1645 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1647 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1651 =head2 $c->prepare_body_chunk( $chunk )
1653 Prepares a chunk of data before sending it to L<HTTP::Body>.
1655 See L<Catalyst::Engine>.
1659 sub prepare_body_chunk {
1661 $c->engine->prepare_body_chunk( $c, @_ );
1664 =head2 $c->prepare_body_parameters
1666 Prepares body parameters.
1670 sub prepare_body_parameters {
1672 $c->engine->prepare_body_parameters( $c, @_ );
1675 =head2 $c->prepare_connection
1677 Prepares connection.
1681 sub prepare_connection {
1683 $c->engine->prepare_connection( $c, @_ );
1686 =head2 $c->prepare_cookies
1692 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1694 =head2 $c->prepare_headers
1700 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1702 =head2 $c->prepare_parameters
1704 Prepares parameters.
1708 sub prepare_parameters {
1710 $c->prepare_body_parameters;
1711 $c->engine->prepare_parameters( $c, @_ );
1714 =head2 $c->prepare_path
1716 Prepares path and base.
1720 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1722 =head2 $c->prepare_query_parameters
1724 Prepares query parameters.
1728 sub prepare_query_parameters {
1731 $c->engine->prepare_query_parameters( $c, @_ );
1733 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1734 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1735 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1736 my $param = $c->req->query_parameters->{$key};
1737 my $value = defined($param) ? $param : '';
1739 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1741 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1745 =head2 $c->prepare_read
1747 Prepares the input for reading.
1751 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1753 =head2 $c->prepare_request
1755 Prepares the engine request.
1759 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1761 =head2 $c->prepare_uploads
1767 sub prepare_uploads {
1770 $c->engine->prepare_uploads( $c, @_ );
1772 if ( $c->debug && keys %{ $c->request->uploads } ) {
1773 my $t = Text::SimpleTable->new(
1774 [ 12, 'Parameter' ],
1779 for my $key ( sort keys %{ $c->request->uploads } ) {
1780 my $upload = $c->request->uploads->{$key};
1781 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1782 $t->row( $key, $u->filename, $u->type, $u->size );
1785 $c->log->debug( "File Uploads are:\n" . $t->draw );
1789 =head2 $c->prepare_write
1791 Prepares the output for writing.
1795 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1797 =head2 $c->request_class
1799 Returns or sets the request class.
1801 =head2 $c->response_class
1803 Returns or sets the response class.
1805 =head2 $c->read( [$maxlength] )
1807 Reads a chunk of data from the request body. This method is designed to
1808 be used in a while loop, reading C<$maxlength> bytes on every call.
1809 C<$maxlength> defaults to the size of the request if not specified.
1811 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1814 Warning: If you use read(), Catalyst will not process the body,
1815 so you will not be able to access POST parameters or file uploads via
1816 $c->request. You must handle all body parsing yourself.
1820 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1828 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1830 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1832 Sets an action in a given namespace.
1836 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1838 =head2 $c->setup_actions($component)
1840 Sets up actions for a component.
1844 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1846 =head2 $c->setup_components
1848 Sets up components. Specify a C<setup_components> config option to pass
1849 additional options directly to L<Module::Pluggable>. To add additional
1850 search paths, specify a key named C<search_extra> as an array
1851 reference. Items in the array beginning with C<::> will have the
1852 application class name prepended to them.
1856 sub setup_components {
1859 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1860 my $config = $class->config->{ setup_components };
1861 my $extra = delete $config->{ search_extra } || [];
1863 push @paths, @$extra;
1865 my $locator = Module::Pluggable::Object->new(
1866 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1870 my @comps = sort { length $a <=> length $b } $locator->plugins;
1871 my %comps = map { $_ => 1 } @comps;
1873 for my $component ( @comps ) {
1875 # We pass ignore_loaded here so that overlay files for (e.g.)
1876 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1877 # we know M::P::O found a file on disk so this is safe
1879 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1881 my $module = $class->setup_component( $component );
1883 $component => $module,
1885 $_ => $class->setup_component( $_ )
1887 not exists $comps{$_}
1888 } Devel::InnerPackage::list_packages( $component )
1891 for my $key ( keys %modules ) {
1892 $class->components->{ $key } = $modules{ $key };
1897 =head2 $c->setup_component
1901 sub setup_component {
1902 my( $class, $component ) = @_;
1904 unless ( $component->can( 'COMPONENT' ) ) {
1908 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1909 my $config = $class->config->{ $suffix } || {};
1911 my $instance = eval { $component->COMPONENT( $class, $config ); };
1913 if ( my $error = $@ ) {
1915 Catalyst::Exception->throw(
1916 message => qq/Couldn't instantiate component "$component", "$error"/
1920 Catalyst::Exception->throw(
1922 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1923 ) unless eval { $instance->can( 'can' ) };
1928 =head2 $c->setup_dispatcher
1934 sub setup_dispatcher {
1935 my ( $class, $dispatcher ) = @_;
1938 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1941 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1942 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1945 unless ($dispatcher) {
1946 $dispatcher = $class->dispatcher_class;
1949 unless (Class::Inspector->loaded($dispatcher)) {
1950 require Class::Inspector->filename($dispatcher);
1953 # dispatcher instance
1954 $class->dispatcher( $dispatcher->new );
1957 =head2 $c->setup_engine
1964 my ( $class, $engine ) = @_;
1967 $engine = 'Catalyst::Engine::' . $engine;
1970 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
1971 $engine = 'Catalyst::Engine::' . $env;
1974 if ( $ENV{MOD_PERL} ) {
1976 # create the apache method
1979 *{"$class\::apache"} = sub { shift->engine->apache };
1982 my ( $software, $version ) =
1983 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1986 $version =~ s/(\.[^.]+)\./$1/g;
1988 if ( $software eq 'mod_perl' ) {
1992 if ( $version >= 1.99922 ) {
1993 $engine = 'Catalyst::Engine::Apache2::MP20';
1996 elsif ( $version >= 1.9901 ) {
1997 $engine = 'Catalyst::Engine::Apache2::MP19';
2000 elsif ( $version >= 1.24 ) {
2001 $engine = 'Catalyst::Engine::Apache::MP13';
2005 Catalyst::Exception->throw( message =>
2006 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2011 # install the correct mod_perl handler
2012 if ( $version >= 1.9901 ) {
2013 *handler = sub : method {
2014 shift->handle_request(@_);
2018 *handler = sub ($$) { shift->handle_request(@_) };
2023 elsif ( $software eq 'Zeus-Perl' ) {
2024 $engine = 'Catalyst::Engine::Zeus';
2028 Catalyst::Exception->throw(
2029 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2034 $engine = $class->engine_class;
2037 unless (Class::Inspector->loaded($engine)) {
2038 require Class::Inspector->filename($engine);
2041 # check for old engines that are no longer compatible
2043 if ( $engine->isa('Catalyst::Engine::Apache')
2044 && !Catalyst::Engine::Apache->VERSION )
2049 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2050 && Catalyst::Engine::Server->VERSION le '0.02' )
2055 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2056 && $engine->VERSION eq '0.01' )
2061 elsif ($engine->isa('Catalyst::Engine::Zeus')
2062 && $engine->VERSION eq '0.01' )
2068 Catalyst::Exception->throw( message =>
2069 qq/Engine "$engine" is not supported by this version of Catalyst/
2074 $class->engine( $engine->new );
2077 =head2 $c->setup_home
2079 Sets up the home directory.
2084 my ( $class, $home ) = @_;
2086 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2091 $home = Catalyst::Utils::home($class);
2095 $class->config->{home} ||= $home;
2096 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2100 =head2 $c->setup_log
2107 my ( $class, $debug ) = @_;
2109 unless ( $class->log ) {
2110 $class->log( Catalyst::Log->new );
2113 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2114 if ( defined($env_debug) ? $env_debug : $debug ) {
2116 *{"$class\::debug"} = sub { 1 };
2117 $class->log->debug('Debug messages enabled');
2121 =head2 $c->setup_plugins
2127 =head2 $c->setup_stats
2129 Sets up timing statistics class.
2134 my ( $class, $stats ) = @_;
2136 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2138 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2139 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2141 *{"$class\::use_stats"} = sub { 1 };
2142 $class->log->debug('Statistics enabled');
2147 =head2 $c->registered_plugins
2149 Returns a sorted list of the plugins which have either been stated in the
2150 import list or which have been added via C<< MyApp->plugin(@args); >>.
2152 If passed a given plugin name, it will report a boolean value indicating
2153 whether or not that plugin is loaded. A fully qualified name is required if
2154 the plugin name does not begin with C<Catalyst::Plugin::>.
2156 if ($c->registered_plugins('Some::Plugin')) {
2164 sub registered_plugins {
2166 return sort keys %{ $proto->_plugins } unless @_;
2168 return 1 if exists $proto->_plugins->{$plugin};
2169 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2172 sub _register_plugin {
2173 my ( $proto, $plugin, $instant ) = @_;
2174 my $class = ref $proto || $proto;
2176 # no ignore_loaded here, the plugin may already have been
2177 # defined in memory and we don't want to error on "no file" if so
2179 Catalyst::Utils::ensure_class_loaded( $plugin );
2181 $proto->_plugins->{$plugin} = 1;
2184 unshift @{"$class\::ISA"}, $plugin;
2190 my ( $class, $plugins ) = @_;
2192 $class->_plugins( {} ) unless $class->_plugins;
2194 for my $plugin ( reverse @$plugins ) {
2196 unless ( $plugin =~ s/\A\+// ) {
2197 $plugin = "Catalyst::Plugin::$plugin";
2200 $class->_register_plugin($plugin);
2207 Returns an arrayref of the internal execution stack (actions that are
2208 currently executing).
2210 =head2 $c->stats_class
2212 Returns or sets the stats (timing statistics) class.
2214 =head2 $c->use_stats
2216 Returns 1 when stats collection is enabled. Stats collection is enabled
2217 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2218 environment variable is set.
2220 Note that this is a static method, not an accessor and should be overloaded
2221 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2228 =head2 $c->write( $data )
2230 Writes $data to the output stream. When using this method directly, you
2231 will need to manually set the C<Content-Length> header to the length of
2232 your output data, if known.
2239 # Finalize headers if someone manually writes output
2240 $c->finalize_headers;
2242 return $c->engine->write( $c, @_ );
2247 Returns the Catalyst version number. Mostly useful for "powered by"
2248 messages in template systems.
2252 sub version { return $Catalyst::VERSION }
2254 =head1 INTERNAL ACTIONS
2256 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2257 C<_ACTION>, and C<_END>. These are by default not shown in the private
2258 action table, but you can make them visible with a config parameter.
2260 MyApp->config->{show_internal_actions} = 1;
2262 =head1 CASE SENSITIVITY
2264 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2265 mapped to C</foo/bar>. You can activate case sensitivity with a config
2268 MyApp->config->{case_sensitive} = 1;
2270 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2272 =head1 ON-DEMAND PARSER
2274 The request body is usually parsed at the beginning of a request,
2275 but if you want to handle input yourself, you can enable on-demand
2276 parsing with a config parameter.
2278 MyApp->config->{parse_on_demand} = 1;
2280 =head1 PROXY SUPPORT
2282 Many production servers operate using the common double-server approach,
2283 with a lightweight frontend web server passing requests to a larger
2284 backend server. An application running on the backend server must deal
2285 with two problems: the remote user always appears to be C<127.0.0.1> and
2286 the server's hostname will appear to be C<localhost> regardless of the
2287 virtual host that the user connected through.
2289 Catalyst will automatically detect this situation when you are running
2290 the frontend and backend servers on the same machine. The following
2291 changes are made to the request.
2293 $c->req->address is set to the user's real IP address, as read from
2294 the HTTP X-Forwarded-For header.
2296 The host value for $c->req->base and $c->req->uri is set to the real
2297 host, as read from the HTTP X-Forwarded-Host header.
2299 Obviously, your web server must support these headers for this to work.
2301 In a more complex server farm environment where you may have your
2302 frontend proxy server(s) on different machines, you will need to set a
2303 configuration option to tell Catalyst to read the proxied data from the
2306 MyApp->config->{using_frontend_proxy} = 1;
2308 If you do not wish to use the proxy support at all, you may set:
2310 MyApp->config->{ignore_frontend_proxy} = 1;
2312 =head1 THREAD SAFETY
2314 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2315 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2316 believe the Catalyst core to be thread-safe.
2318 If you plan to operate in a threaded environment, remember that all other
2319 modules you are using must also be thread-safe. Some modules, most notably
2320 L<DBD::SQLite>, are not thread-safe.
2326 Join #catalyst on irc.perl.org.
2330 http://lists.rawmode.org/mailman/listinfo/catalyst
2331 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2335 http://catalyst.perl.org
2339 http://dev.catalyst.perl.org
2343 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2345 =head2 L<Catalyst::Manual> - The Catalyst Manual
2347 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2349 =head2 L<Catalyst::Engine> - Core engine
2351 =head2 L<Catalyst::Log> - Log class.
2353 =head2 L<Catalyst::Request> - Request object
2355 =head2 L<Catalyst::Response> - Response object
2357 =head2 L<Catalyst::Test> - The test suite.
2431 Sebastian Riedel, C<sri@oook.de>
2435 This library is free software, you can redistribute it and/or modify it under
2436 the same terms as Perl itself.