4 use base 'Catalyst::Component';
6 use Catalyst::Exception;
9 use Catalyst::Request::Upload;
10 use Catalyst::Response;
12 use Catalyst::Controller;
13 use Devel::InnerPackage ();
15 use Module::Pluggable::Object ();
17 use Text::SimpleTable ();
18 use Path::Class::Dir ();
19 use Path::Class::File ();
20 use Time::HiRes qw/gettimeofday tv_interval/;
24 use Scalar::Util qw/weaken blessed/;
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
29 use Carp qw/croak carp/;
31 BEGIN { require 5.008001; }
33 __PACKAGE__->mk_accessors(
34 qw/counter request response state action stack namespace stats/
37 sub depth { scalar @{ shift->stack || [] }; }
44 # For backwards compatibility
45 *finalize_output = \&finalize_body;
50 our $RECURSION = 1000;
51 our $DETACH = "catalyst_detach\n";
53 __PACKAGE__->mk_classdata($_)
54 for qw/components arguments dispatcher engine log dispatcher_class
55 engine_class context_class request_class response_class stats_class
58 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
59 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
60 __PACKAGE__->request_class('Catalyst::Request');
61 __PACKAGE__->response_class('Catalyst::Response');
62 __PACKAGE__->stats_class('Catalyst::Stats');
64 # Remember to update this in Catalyst::Runtime as well!
66 our $VERSION = '5.7014';
69 my ( $class, @arguments ) = @_;
71 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
73 return unless $class eq 'Catalyst';
75 my $caller = caller(0);
77 unless ( $caller->isa('Catalyst') ) {
79 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
82 $caller->arguments( [@arguments] );
88 Catalyst - The Elegant MVC Web Application Framework
92 See the L<Catalyst::Manual> distribution for comprehensive
93 documentation and tutorials.
95 # Install Catalyst::Devel for helpers and other development tools
96 # use the helper to create a new application
99 # add models, views, controllers
100 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
101 script/myapp_create.pl view MyTemplate TT
102 script/myapp_create.pl controller Search
104 # built in testserver -- use -r to restart automatically on changes
105 # --help to see all available options
106 script/myapp_server.pl
108 # command line testing interface
109 script/myapp_test.pl /yada
112 use Catalyst qw/-Debug/; # include plugins here as well
114 ### In lib/MyApp/Controller/Root.pm (autocreated)
115 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
116 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
117 $c->stash->{template} = 'foo.tt'; # set the template
118 # lookup something from db -- stash vars are passed to TT
120 $c->model('Database::Foo')->search( { country => $args[0] } );
121 if ( $c->req->params->{bar} ) { # access GET or POST parameters
122 $c->forward( 'bar' ); # process another action
123 # do something else after forward returns
127 # The foo.tt TT template can use the stash data from the database
128 [% WHILE (item = data.next) %]
132 # called for /bar/of/soap, /bar/of/soap/10, etc.
133 sub bar : Path('/bar/of/soap') { ... }
135 # called for all actions, from the top-most controller downwards
137 my ( $self, $c ) = @_;
138 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
139 $c->res->redirect( '/login' ); # require login
140 return 0; # abort request and go immediately to end()
142 return 1; # success; carry on to next action
145 # called after all actions are finished
147 my ( $self, $c ) = @_;
148 if ( scalar @{ $c->error } ) { ... } # handle errors
149 return if $c->res->body; # already have a response
150 $c->forward( 'MyApp::View::TT' ); # render template
153 ### in MyApp/Controller/Foo.pm
154 # called for /foo/bar
155 sub bar : Local { ... }
157 # called for /blargle
158 sub blargle : Global { ... }
160 # an index action matches /foo, but not /foo/1, etc.
161 sub index : Private { ... }
163 ### in MyApp/Controller/Foo/Bar.pm
164 # called for /foo/bar/baz
165 sub baz : Local { ... }
167 # first Root auto is called, then Foo auto, then this
168 sub auto : Private { ... }
170 # powerful regular expression paths are also possible
171 sub details : Regex('^product/(\w+)/details$') {
172 my ( $self, $c ) = @_;
173 # extract the (\w+) from the URI
174 my $product = $c->req->captures->[0];
177 See L<Catalyst::Manual::Intro> for additional information.
181 Catalyst is a modern framework for making web applications without the
182 pain usually associated with this process. This document is a reference
183 to the main Catalyst application. If you are a new user, we suggest you
184 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
186 See L<Catalyst::Manual> for more documentation.
188 Catalyst plugins can be loaded by naming them as arguments to the "use
189 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
190 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
193 use Catalyst qw/My::Module/;
195 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
196 fully qualify the name by using a unary plus:
200 +Fully::Qualified::Plugin::Name
203 Special flags like C<-Debug> and C<-Engine> can also be specified as
204 arguments when Catalyst is loaded:
206 use Catalyst qw/-Debug My::Module/;
208 The position of plugins and flags in the chain is important, because
209 they are loaded in the order in which they appear.
211 The following flags are supported:
215 Enables debug output. You can also force this setting from the system
216 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
217 settings override the application, with <MYAPP>_DEBUG having the highest
222 Forces Catalyst to use a specific engine. Omit the
223 C<Catalyst::Engine::> prefix of the engine name, i.e.:
225 use Catalyst qw/-Engine=CGI/;
229 Forces Catalyst to use a specific home directory, e.g.:
231 use Catalyst qw[-Home=/usr/mst];
233 This can also be done in the shell environment by setting either the
234 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
235 is replaced with the uppercased name of your application, any "::" in
236 the name will be replaced with underscores, e.g. MyApp::Web should use
237 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
245 Enables statistics collection and reporting. You can also force this setting
246 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
247 environment settings override the application, with <MYAPP>_STATS having the
252 use Catalyst qw/-Stats=1/
256 =head2 INFORMATION ABOUT THE CURRENT REQUEST
260 Returns a L<Catalyst::Action> object for the current action, which
261 stringifies to the action name. See L<Catalyst::Action>.
265 Returns the namespace of the current action, i.e., the URI prefix
266 corresponding to the controller of the current action. For example:
268 # in Controller::Foo::Bar
269 $c->namespace; # returns 'foo/bar';
275 Returns the current L<Catalyst::Request> object, giving access to
276 information about the current client request (including parameters,
277 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
279 =head2 REQUEST FLOW HANDLING
281 =head2 $c->forward( $action [, \@arguments ] )
283 =head2 $c->forward( $class, $method, [, \@arguments ] )
285 Forwards processing to another action, by its private name. If you give a
286 class name but no method, C<process()> is called. You may also optionally
287 pass arguments in an arrayref. The action will receive the arguments in
288 C<@_> and C<< $c->req->args >>. Upon returning from the function,
289 C<< $c->req->args >> will be restored to the previous values.
291 Any data C<return>ed from the action forwarded to, will be returned by the
294 my $foodata = $c->forward('/foo');
295 $c->forward('index');
296 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
297 $c->forward('MyApp::View::TT');
299 Note that forward implies an C<<eval { }>> around the call (actually
300 C<execute> does), thus de-fatalizing all 'dies' within the called
301 action. If you want C<die> to propagate you need to do something like:
304 die $c->error if $c->error;
306 Or make sure to always return true values from your actions and write
309 $c->forward('foo') || return;
313 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
315 =head2 $c->detach( $action [, \@arguments ] )
317 =head2 $c->detach( $class, $method, [, \@arguments ] )
321 The same as C<forward>, but doesn't return to the previous action when
322 processing is finished.
324 When called with no arguments it escapes the processing chain entirely.
328 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
334 Returns the current L<Catalyst::Response> object, see there for details.
338 Returns a hashref to the stash, which may be used to store data and pass
339 it between components during a request. You can also set hash keys by
340 passing arguments. The stash is automatically sent to the view. The
341 stash is cleared at the end of a request; it cannot be used for
342 persistent storage (for this you must use a session; see
343 L<Catalyst::Plugin::Session> for a complete system integrated with
346 $c->stash->{foo} = $bar;
347 $c->stash( { moose => 'majestic', qux => 0 } );
348 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
350 # stash is automatically passed to the view for use in a template
351 $c->forward( 'MyApp::View::TT' );
358 my $stash = @_ > 1 ? {@_} : $_[0];
359 croak('stash takes a hash or hashref') unless ref $stash;
360 foreach my $key ( keys %$stash ) {
361 $c->{stash}->{$key} = $stash->{$key};
369 =head2 $c->error($error, ...)
371 =head2 $c->error($arrayref)
373 Returns an arrayref containing error messages. If Catalyst encounters an
374 error while processing a request, it stores the error in $c->error. This
375 method should only be used to store fatal error messages.
377 my @error = @{ $c->error };
381 $c->error('Something bad happened');
388 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
389 croak @$error unless ref $c;
390 push @{ $c->{error} }, @$error;
392 elsif ( defined $_[0] ) { $c->{error} = undef }
393 return $c->{error} || [];
399 Contains the return value of the last executed action.
401 =head2 $c->clear_errors
403 Clear errors. You probably don't want to clear the errors unless you are
404 implementing a custom error screen.
406 This is equivalent to running
420 my ( $c, @names ) = @_;
422 foreach my $name (@names) {
423 foreach my $component ( keys %{ $c->components } ) {
424 return $c->components->{$component} if $component =~ /$name/i;
431 # try explicit component names
433 my ( $c, @names ) = @_;
435 foreach my $try (@names) {
436 return $c->components->{$try} if ( exists $c->components->{$try} );
442 # like component, but try just these prefixes before regex searching,
443 # and do not try to return "sort keys %{ $c->components }"
445 my ( $c, $name, @prefixes ) = @_;
447 my $appclass = ref $c || $c;
449 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
451 my $comp = $c->_comp_explicit(@names);
452 return $comp if defined($comp);
453 $comp = $c->_comp_search($name);
457 # Find possible names for a prefix
460 my ( $c, @prefixes ) = @_;
462 my $appclass = ref $c || $c;
464 my @pre = map { "${appclass}::${_}::" } @prefixes;
468 COMPONENT: foreach my $comp ($c->component) {
469 foreach my $p (@pre) {
470 if ($comp =~ s/^$p//) {
480 # Return a component if only one matches.
482 my ( $c, @prefixes ) = @_;
484 my $appclass = ref $c || $c;
486 my ( $comp, $rest ) =
487 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
488 return $comp unless $rest;
491 # Filter a component before returning by calling ACCEPT_CONTEXT if available
492 sub _filter_component {
493 my ( $c, $comp, @args ) = @_;
494 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
495 return $comp->ACCEPT_CONTEXT( $c, @args );
497 else { return $comp }
500 =head2 COMPONENT ACCESSORS
502 =head2 $c->controller($name)
504 Gets a L<Catalyst::Controller> instance by name.
506 $c->controller('Foo')->do_stuff;
508 If the name is omitted, will return the controller for the dispatched
514 my ( $c, $name, @args ) = @_;
515 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
518 return $c->component( $c->action->class );
521 =head2 $c->model($name)
523 Gets a L<Catalyst::Model> instance by name.
525 $c->model('Foo')->do_stuff;
527 Any extra arguments are directly passed to ACCEPT_CONTEXT.
529 If the name is omitted, it will look for
530 - a model object in $c->stash{current_model_instance}, then
531 - a model name in $c->stash->{current_model}, then
532 - a config setting 'default_model', or
533 - check if there is only one model, and return it if that's the case.
538 my ( $c, $name, @args ) = @_;
539 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
543 return $c->stash->{current_model_instance}
544 if $c->stash->{current_model_instance};
545 return $c->model( $c->stash->{current_model} )
546 if $c->stash->{current_model};
548 return $c->model( $c->config->{default_model} )
549 if $c->config->{default_model};
550 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
554 =head2 $c->controllers
556 Returns the available names which can be passed to $c->controller
562 return $c->_comp_names(qw/Controller C/);
566 =head2 $c->view($name)
568 Gets a L<Catalyst::View> instance by name.
570 $c->view('Foo')->do_stuff;
572 Any extra arguments are directly passed to ACCEPT_CONTEXT.
574 If the name is omitted, it will look for
575 - a view object in $c->stash{current_view_instance}, then
576 - a view name in $c->stash->{current_view}, then
577 - a config setting 'default_view', or
578 - check if there is only one view, and return it if that's the case.
583 my ( $c, $name, @args ) = @_;
584 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
588 return $c->stash->{current_view_instance}
589 if $c->stash->{current_view_instance};
590 return $c->view( $c->stash->{current_view} )
591 if $c->stash->{current_view};
593 return $c->view( $c->config->{default_view} )
594 if $c->config->{default_view};
595 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
600 Returns the available names which can be passed to $c->model
606 return $c->_comp_names(qw/Model M/);
612 Returns the available names which can be passed to $c->view
618 return $c->_comp_names(qw/View V/);
621 =head2 $c->comp($name)
623 =head2 $c->component($name)
625 Gets a component object by name. This method is not recommended,
626 unless you want to get a specific component by full
627 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
628 should be used instead.
639 my $appclass = ref $c || $c;
642 $name, "${appclass}::${name}",
643 map { "${appclass}::${_}::${name}" }
644 qw/Model M Controller C View V/
647 my $comp = $c->_comp_explicit(@names);
648 return $c->_filter_component( $comp, @_ ) if defined($comp);
650 $comp = $c->_comp_search($name);
651 return $c->_filter_component( $comp, @_ ) if defined($comp);
654 return sort keys %{ $c->components };
659 =head2 CLASS DATA AND HELPER CLASSES
663 Returns or takes a hashref containing the application's configuration.
665 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
667 You can also use a C<YAML>, C<XML> or C<Config::General> config file
668 like myapp.yml in your applications home directory. See
669 L<Catalyst::Plugin::ConfigLoader>.
672 db: dsn:SQLite:foo.db
680 $c->log->warn("Setting config after setup has been run is not a good idea.")
681 if ( @_ and $c->setup_finished );
683 $c->NEXT::config(@_);
688 Returns the logging object instance. Unless it is already set, Catalyst
689 sets this up with a L<Catalyst::Log> object. To use your own log class,
690 set the logger with the C<< __PACKAGE__->log >> method prior to calling
691 C<< __PACKAGE__->setup >>.
693 __PACKAGE__->log( MyLogger->new );
698 $c->log->info( 'Now logging with my own logger!' );
700 Your log class should implement the methods described in
706 Overload to enable debug messages (same as -Debug option).
708 Note that this is a static method, not an accessor and should be overloaded
709 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
715 =head2 $c->dispatcher
717 Returns the dispatcher instance. Stringifies to class name. See
718 L<Catalyst::Dispatcher>.
722 Returns the engine instance. Stringifies to the class name. See
726 =head2 UTILITY METHODS
728 =head2 $c->path_to(@path)
730 Merges C<@path> with C<< $c->config->{home} >> and returns a
731 L<Path::Class::Dir> object.
735 $c->path_to( 'db', 'sqlite.db' );
740 my ( $c, @path ) = @_;
741 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
742 if ( -d $path ) { return $path }
743 else { return Path::Class::File->new( $c->config->{home}, @path ) }
746 =head2 $c->plugin( $name, $class, @args )
748 Helper method for plugins. It creates a classdata accessor/mutator and
749 loads and instantiates the given class.
751 MyApp->plugin( 'prototype', 'HTML::Prototype' );
753 $c->prototype->define_javascript_functions;
758 my ( $class, $name, $plugin, @args ) = @_;
759 $class->_register_plugin( $plugin, 1 );
761 eval { $plugin->import };
762 $class->mk_classdata($name);
764 eval { $obj = $plugin->new(@args) };
767 Catalyst::Exception->throw( message =>
768 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
772 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
778 Initializes the dispatcher and engine, loads any plugins, and loads the
779 model, view, and controller components. You may also specify an array
780 of plugins to load here, if you choose to not load them in the C<use
784 MyApp->setup( qw/-Debug/ );
789 my ( $class, @arguments ) = @_;
791 $class->log->warn("Running setup twice is not a good idea.")
792 if ( $class->setup_finished );
794 unless ( $class->isa('Catalyst') ) {
796 Catalyst::Exception->throw(
797 message => qq/'$class' does not inherit from Catalyst/ );
800 if ( $class->arguments ) {
801 @arguments = ( @arguments, @{ $class->arguments } );
807 foreach (@arguments) {
811 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
813 elsif (/^-(\w+)=?(.*)$/) {
814 $flags->{ lc $1 } = $2;
817 push @{ $flags->{plugins} }, $_;
821 $class->setup_home( delete $flags->{home} );
823 $class->setup_log( delete $flags->{log} );
824 $class->setup_plugins( delete $flags->{plugins} );
825 $class->setup_dispatcher( delete $flags->{dispatcher} );
826 $class->setup_engine( delete $flags->{engine} );
827 $class->setup_stats( delete $flags->{stats} );
829 for my $flag ( sort keys %{$flags} ) {
831 if ( my $code = $class->can( 'setup_' . $flag ) ) {
832 &$code( $class, delete $flags->{$flag} );
835 $class->log->warn(qq/Unknown flag "$flag"/);
839 eval { require Catalyst::Devel; };
840 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
841 $class->log->warn(<<"EOF");
842 You are running an old script!
844 Please update by running (this will overwrite existing files):
845 catalyst.pl -force -scripts $class
847 or (this will not overwrite existing files):
848 catalyst.pl -scripts $class
853 if ( $class->debug ) {
854 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
857 my $t = Text::SimpleTable->new(74);
858 $t->row($_) for @plugins;
859 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
862 my $dispatcher = $class->dispatcher;
863 my $engine = $class->engine;
864 my $home = $class->config->{home};
866 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
867 $class->log->debug(qq/Loaded engine "$engine"/);
871 ? $class->log->debug(qq/Found home "$home"/)
872 : $class->log->debug(qq/Home "$home" doesn't exist/)
873 : $class->log->debug(q/Couldn't find home/);
878 no warnings qw/redefine/;
879 local *setup = sub { };
883 # Initialize our data structure
884 $class->components( {} );
886 $class->setup_components;
888 if ( $class->debug ) {
889 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
890 for my $comp ( sort keys %{ $class->components } ) {
891 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
892 $t->row( $comp, $type );
894 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
895 if ( keys %{ $class->components } );
898 # Add our self to components, since we are also a component
899 $class->components->{$class} = $class;
901 $class->setup_actions;
903 if ( $class->debug ) {
904 my $name = $class->config->{name} || 'Application';
905 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
907 $class->log->_flush() if $class->log->can('_flush');
909 $class->setup_finished(1);
912 =head2 $c->uri_for( $path, @args?, \%query_values? )
914 Merges path with C<< $c->request->base >> for absolute URIs and with
915 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
916 object. If any args are passed, they are added at the end of the path.
917 If the last argument to C<uri_for> is a hash reference, it is assumed to
918 contain GET parameter key/value pairs, which will be appended to the URI
921 Note that uri_for is destructive to the passed hashref. Subsequent calls
922 with the same hashref may have unintended results.
924 Instead of C<$path>, you can also optionally pass a C<$action> object
925 which will be resolved to a path using
926 C<< $c->dispatcher->uri_for_action >>; if the first element of
927 C<@args> is an arrayref it is treated as a list of captures to be passed
928 to C<uri_for_action>.
933 my ( $c, $path, @args ) = @_;
935 if ( Scalar::Util::blessed($path) ) { # action object
936 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
939 $path = $c->dispatcher->uri_for_action($path, $captures);
940 return undef unless defined($path);
941 $path = '/' if $path eq '';
944 undef($path) if (defined $path && $path eq '');
947 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
949 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
950 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
952 unshift(@args, $path);
954 unless (defined $path && $path =~ s!^/!!) { # in-place strip
955 my $namespace = $c->namespace;
956 if (defined $path) { # cheesy hack to handle path '../foo'
957 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
959 unshift(@args, $namespace || '');
962 # join args with '/', or a blank string
963 my $args = join('/', grep { defined($_) } @args);
964 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
966 my $base = $c->req->base;
967 my $class = ref($base);
968 $base =~ s{(?<!/)$}{/};
972 if (my @keys = keys %$params) {
973 # somewhat lifted from URI::_query's query_form
974 $query = '?'.join('&', map {
975 my $val = $params->{$_};
976 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
979 $val = '' unless defined $val;
982 utf8::encode( $_ ) if utf8::is_utf8($_);
983 # using the URI::Escape pattern here so utf8 chars survive
984 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
986 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
990 my $res = bless(\"${base}${args}${query}", $class);
994 =head2 $c->welcome_message
996 Returns the Catalyst welcome HTML page.
1000 sub welcome_message {
1002 my $name = $c->config->{name};
1003 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1004 my $prefix = Catalyst::Utils::appprefix( ref $c );
1005 $c->response->content_type('text/html; charset=utf-8');
1007 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1008 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1009 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1011 <meta http-equiv="Content-Language" content="en" />
1012 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1013 <title>$name on Catalyst $VERSION</title>
1014 <style type="text/css">
1017 background-color: #eee;
1024 margin-bottom: 10px;
1026 background-color: #ccc;
1027 border: 1px solid #aaa;
1032 font-family: verdana, tahoma, sans-serif;
1035 font-family: verdana, tahoma, sans-serif;
1038 text-decoration: none;
1040 border-bottom: 1px dotted #bbb;
1042 :link:hover, :visited:hover {
1055 background-color: #fff;
1056 border: 1px solid #aaa;
1060 font-weight: normal;
1082 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1087 <img src="$logo" alt="Catalyst Logo" />
1089 <p>Welcome to the world of Catalyst.
1090 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1091 framework will make web development something you had
1092 never expected it to be: Fun, rewarding, and quick.</p>
1093 <h2>What to do now?</h2>
1094 <p>That really depends on what <b>you</b> want to do.
1095 We do, however, provide you with a few starting points.</p>
1096 <p>If you want to jump right into web development with Catalyst
1097 you might want to start with a tutorial.</p>
1098 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1100 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1102 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1103 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1105 <h2>What to do next?</h2>
1106 <p>Next it's time to write an actual application. Use the
1107 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1108 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1109 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1110 they can save you a lot of work.</p>
1111 <pre><code>script/${prefix}_create.pl -help</code></pre>
1112 <p>Also, be sure to check out the vast and growing
1113 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1114 you are likely to find what you need there.
1118 <p>Catalyst has a very active community. Here are the main places to
1119 get in touch with us.</p>
1122 <a href="http://dev.catalyst.perl.org">Wiki</a>
1125 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1128 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1131 <h2>In conclusion</h2>
1132 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1133 as we enjoyed making it. Please contact us if you have ideas
1134 for improvement or other feedback.</p>
1142 =head1 INTERNAL METHODS
1144 These methods are not meant to be used by end users.
1146 =head2 $c->components
1148 Returns a hash of components.
1150 =head2 $c->context_class
1152 Returns or sets the context class.
1156 Returns a hashref containing coderefs and execution counts (needed for
1157 deep recursion detection).
1161 Returns the number of actions on the current internal execution stack.
1165 Dispatches a request to actions.
1169 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1171 =head2 $c->dispatcher_class
1173 Returns or sets the dispatcher class.
1175 =head2 $c->dump_these
1177 Returns a list of 2-element array references (name, structure) pairs
1178 that will be dumped on the error page in debug mode.
1184 [ Request => $c->req ],
1185 [ Response => $c->res ],
1186 [ Stash => $c->stash ],
1187 [ Config => $c->config ];
1190 =head2 $c->engine_class
1192 Returns or sets the engine class.
1194 =head2 $c->execute( $class, $coderef )
1196 Execute a coderef in given class and catch exceptions. Errors are available
1202 my ( $c, $class, $code ) = @_;
1203 $class = $c->component($class) || $class;
1206 if ( $c->depth >= $RECURSION ) {
1207 my $action = "$code";
1208 $action = "/$action" unless $action =~ /->/;
1209 my $error = qq/Deep recursion detected calling "$action"/;
1210 $c->log->error($error);
1216 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1218 push( @{ $c->stack }, $code );
1220 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1222 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1224 my $last = pop( @{ $c->stack } );
1226 if ( my $error = $@ ) {
1227 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1229 unless ( ref $error ) {
1230 no warnings 'uninitialized';
1232 my $class = $last->class;
1233 my $name = $last->name;
1234 $error = qq/Caught exception in $class->$name "$error"/;
1243 sub _stats_start_execute {
1244 my ( $c, $code ) = @_;
1246 return if ( ( $code->name =~ /^_.*/ )
1247 && ( !$c->config->{show_internal_actions} ) );
1249 $c->counter->{"$code"}++;
1251 my $action = "$code";
1252 $action = "/$action" unless $action =~ /->/;
1254 # determine if the call was the result of a forward
1255 # this is done by walking up the call stack and looking for a calling
1256 # sub of Catalyst::forward before the eval
1258 for my $index ( 2 .. 11 ) {
1260 if ( ( caller($index) )[0] eq 'Catalyst'
1261 && ( caller($index) )[3] eq '(eval)' );
1263 if ( ( caller($index) )[3] =~ /forward$/ ) {
1264 $callsub = ( caller($index) )[3];
1265 $action = "-> $action";
1270 my $uid = "$code" . $c->counter->{"$code"};
1272 # is this a root-level call or a forwarded call?
1273 if ( $callsub =~ /forward$/ ) {
1275 # forward, locate the caller
1276 if ( my $parent = $c->stack->[-1] ) {
1279 parent => "$parent" . $c->counter->{"$parent"},
1285 # forward with no caller may come from a plugin
1304 sub _stats_finish_execute {
1305 my ( $c, $info ) = @_;
1306 $c->stats->profile( end => $info );
1309 =head2 $c->_localize_fields( sub { }, \%keys );
1313 sub _localize_fields {
1314 my ( $c, $localized, $code ) = ( @_ );
1316 my $request = delete $localized->{request} || {};
1317 my $response = delete $localized->{response} || {};
1319 local @{ $c }{ keys %$localized } = values %$localized;
1320 local @{ $c->request }{ keys %$request } = values %$request;
1321 local @{ $c->response }{ keys %$response } = values %$response;
1328 Finalizes the request.
1335 for my $error ( @{ $c->error } ) {
1336 $c->log->error($error);
1339 # Allow engine to handle finalize flow (for POE)
1340 if ( $c->engine->can('finalize') ) {
1341 $c->engine->finalize($c);
1345 $c->finalize_uploads;
1348 if ( $#{ $c->error } >= 0 ) {
1352 $c->finalize_headers;
1355 if ( $c->request->method eq 'HEAD' ) {
1356 $c->response->body('');
1362 if ($c->use_stats) {
1363 my $elapsed = sprintf '%f', $c->stats->elapsed;
1364 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1366 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1369 return $c->response->status;
1372 =head2 $c->finalize_body
1378 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1380 =head2 $c->finalize_cookies
1386 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1388 =head2 $c->finalize_error
1394 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1396 =head2 $c->finalize_headers
1402 sub finalize_headers {
1405 # Check if we already finalized headers
1406 return if $c->response->{_finalized_headers};
1409 if ( my $location = $c->response->redirect ) {
1410 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1411 $c->response->header( Location => $location );
1413 if ( !$c->response->body ) {
1414 # Add a default body if none is already present
1416 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1422 if ( $c->response->body && !$c->response->content_length ) {
1424 # get the length from a filehandle
1425 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1427 my $stat = stat $c->response->body;
1428 if ( $stat && $stat->size > 0 ) {
1429 $c->response->content_length( $stat->size );
1432 $c->log->warn('Serving filehandle without a content-length');
1436 # everything should be bytes at this point, but just in case
1437 $c->response->content_length( bytes::length( $c->response->body ) );
1442 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1443 $c->response->headers->remove_header("Content-Length");
1444 $c->response->body('');
1447 $c->finalize_cookies;
1449 $c->engine->finalize_headers( $c, @_ );
1452 $c->response->{_finalized_headers} = 1;
1455 =head2 $c->finalize_output
1457 An alias for finalize_body.
1459 =head2 $c->finalize_read
1461 Finalizes the input after reading is complete.
1465 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1467 =head2 $c->finalize_uploads
1469 Finalizes uploads. Cleans up any temporary files.
1473 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1475 =head2 $c->get_action( $action, $namespace )
1477 Gets an action in a given namespace.
1481 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1483 =head2 $c->get_actions( $action, $namespace )
1485 Gets all actions of a given name in a namespace and all parent
1490 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1492 =head2 $c->handle_request( $class, @arguments )
1494 Called to handle each HTTP request.
1498 sub handle_request {
1499 my ( $class, @arguments ) = @_;
1501 # Always expect worst case!
1504 if ($class->debug) {
1505 my $secs = time - $START || 1;
1506 my $av = sprintf '%.3f', $COUNT / $secs;
1507 my $time = localtime time;
1508 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1511 my $c = $class->prepare(@arguments);
1513 $status = $c->finalize;
1516 if ( my $error = $@ ) {
1518 $class->log->error(qq/Caught exception in engine "$error"/);
1522 $class->log->_flush() if $class->log->can('_flush');
1526 =head2 $c->prepare( @arguments )
1528 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1534 my ( $class, @arguments ) = @_;
1536 $class->context_class( ref $class || $class ) unless $class->context_class;
1537 my $c = $class->context_class->new(
1541 request => $class->request_class->new(
1544 body_parameters => {},
1546 headers => HTTP::Headers->new,
1548 query_parameters => {},
1554 response => $class->response_class->new(
1558 headers => HTTP::Headers->new(),
1567 $c->stats($class->stats_class->new)->enable($c->use_stats);
1569 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1572 # For on-demand data
1573 $c->request->{_context} = $c;
1574 $c->response->{_context} = $c;
1575 weaken( $c->request->{_context} );
1576 weaken( $c->response->{_context} );
1578 # Allow engine to direct the prepare flow (for POE)
1579 if ( $c->engine->can('prepare') ) {
1580 $c->engine->prepare( $c, @arguments );
1583 $c->prepare_request(@arguments);
1584 $c->prepare_connection;
1585 $c->prepare_query_parameters;
1586 $c->prepare_headers;
1587 $c->prepare_cookies;
1590 # Prepare the body for reading, either by prepare_body
1591 # or the user, if they are using $c->read
1594 # Parse the body unless the user wants it on-demand
1595 unless ( $c->config->{parse_on_demand} ) {
1600 my $method = $c->req->method || '';
1601 my $path = $c->req->path;
1602 $path = '/' unless length $path;
1603 my $address = $c->req->address || '';
1605 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1613 =head2 $c->prepare_action
1615 Prepares action. See L<Catalyst::Dispatcher>.
1619 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1621 =head2 $c->prepare_body
1623 Prepares message body.
1630 # Do we run for the first time?
1631 return if defined $c->request->{_body};
1633 # Initialize on-demand data
1634 $c->engine->prepare_body( $c, @_ );
1635 $c->prepare_parameters;
1636 $c->prepare_uploads;
1638 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1639 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1640 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1641 my $param = $c->req->body_parameters->{$key};
1642 my $value = defined($param) ? $param : '';
1644 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1646 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1650 =head2 $c->prepare_body_chunk( $chunk )
1652 Prepares a chunk of data before sending it to L<HTTP::Body>.
1654 See L<Catalyst::Engine>.
1658 sub prepare_body_chunk {
1660 $c->engine->prepare_body_chunk( $c, @_ );
1663 =head2 $c->prepare_body_parameters
1665 Prepares body parameters.
1669 sub prepare_body_parameters {
1671 $c->engine->prepare_body_parameters( $c, @_ );
1674 =head2 $c->prepare_connection
1676 Prepares connection.
1680 sub prepare_connection {
1682 $c->engine->prepare_connection( $c, @_ );
1685 =head2 $c->prepare_cookies
1691 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1693 =head2 $c->prepare_headers
1699 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1701 =head2 $c->prepare_parameters
1703 Prepares parameters.
1707 sub prepare_parameters {
1709 $c->prepare_body_parameters;
1710 $c->engine->prepare_parameters( $c, @_ );
1713 =head2 $c->prepare_path
1715 Prepares path and base.
1719 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1721 =head2 $c->prepare_query_parameters
1723 Prepares query parameters.
1727 sub prepare_query_parameters {
1730 $c->engine->prepare_query_parameters( $c, @_ );
1732 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1733 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1734 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1735 my $param = $c->req->query_parameters->{$key};
1736 my $value = defined($param) ? $param : '';
1738 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1740 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1744 =head2 $c->prepare_read
1746 Prepares the input for reading.
1750 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1752 =head2 $c->prepare_request
1754 Prepares the engine request.
1758 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1760 =head2 $c->prepare_uploads
1766 sub prepare_uploads {
1769 $c->engine->prepare_uploads( $c, @_ );
1771 if ( $c->debug && keys %{ $c->request->uploads } ) {
1772 my $t = Text::SimpleTable->new(
1773 [ 12, 'Parameter' ],
1778 for my $key ( sort keys %{ $c->request->uploads } ) {
1779 my $upload = $c->request->uploads->{$key};
1780 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1781 $t->row( $key, $u->filename, $u->type, $u->size );
1784 $c->log->debug( "File Uploads are:\n" . $t->draw );
1788 =head2 $c->prepare_write
1790 Prepares the output for writing.
1794 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1796 =head2 $c->request_class
1798 Returns or sets the request class.
1800 =head2 $c->response_class
1802 Returns or sets the response class.
1804 =head2 $c->read( [$maxlength] )
1806 Reads a chunk of data from the request body. This method is designed to
1807 be used in a while loop, reading C<$maxlength> bytes on every call.
1808 C<$maxlength> defaults to the size of the request if not specified.
1810 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1813 Warning: If you use read(), Catalyst will not process the body,
1814 so you will not be able to access POST parameters or file uploads via
1815 $c->request. You must handle all body parsing yourself.
1819 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1827 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1829 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1831 Sets an action in a given namespace.
1835 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1837 =head2 $c->setup_actions($component)
1839 Sets up actions for a component.
1843 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1845 =head2 $c->setup_components
1847 Sets up components. Specify a C<setup_components> config option to pass
1848 additional options directly to L<Module::Pluggable>. To add additional
1849 search paths, specify a key named C<search_extra> as an array
1850 reference. Items in the array beginning with C<::> will have the
1851 application class name prepended to them.
1855 sub setup_components {
1858 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1859 my $config = $class->config->{ setup_components };
1860 my $extra = delete $config->{ search_extra } || [];
1862 push @paths, @$extra;
1864 my $locator = Module::Pluggable::Object->new(
1865 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1869 my @comps = sort { length $a <=> length $b } $locator->plugins;
1870 my %comps = map { $_ => 1 } @comps;
1872 for my $component ( @comps ) {
1874 # We pass ignore_loaded here so that overlay files for (e.g.)
1875 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1876 # we know M::P::O found a file on disk so this is safe
1878 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1880 my $module = $class->setup_component( $component );
1882 $component => $module,
1884 $_ => $class->setup_component( $_ )
1886 not exists $comps{$_}
1887 } Devel::InnerPackage::list_packages( $component )
1890 for my $key ( keys %modules ) {
1891 $class->components->{ $key } = $modules{ $key };
1896 =head2 $c->setup_component
1900 sub setup_component {
1901 my( $class, $component ) = @_;
1903 unless ( $component->can( 'COMPONENT' ) ) {
1907 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1908 my $config = $class->config->{ $suffix } || {};
1910 my $instance = eval { $component->COMPONENT( $class, $config ); };
1912 if ( my $error = $@ ) {
1914 Catalyst::Exception->throw(
1915 message => qq/Couldn't instantiate component "$component", "$error"/
1919 Catalyst::Exception->throw(
1921 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1922 ) unless eval { $instance->can( 'can' ) };
1927 =head2 $c->setup_dispatcher
1933 sub setup_dispatcher {
1934 my ( $class, $dispatcher ) = @_;
1937 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1940 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1941 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1944 unless ($dispatcher) {
1945 $dispatcher = $class->dispatcher_class;
1948 unless (Class::Inspector->loaded($dispatcher)) {
1949 require Class::Inspector->filename($dispatcher);
1952 # dispatcher instance
1953 $class->dispatcher( $dispatcher->new );
1956 =head2 $c->setup_engine
1963 my ( $class, $engine ) = @_;
1966 $engine = 'Catalyst::Engine::' . $engine;
1969 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
1970 $engine = 'Catalyst::Engine::' . $env;
1973 if ( $ENV{MOD_PERL} ) {
1975 # create the apache method
1978 *{"$class\::apache"} = sub { shift->engine->apache };
1981 my ( $software, $version ) =
1982 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1985 $version =~ s/(\.[^.]+)\./$1/g;
1987 if ( $software eq 'mod_perl' ) {
1991 if ( $version >= 1.99922 ) {
1992 $engine = 'Catalyst::Engine::Apache2::MP20';
1995 elsif ( $version >= 1.9901 ) {
1996 $engine = 'Catalyst::Engine::Apache2::MP19';
1999 elsif ( $version >= 1.24 ) {
2000 $engine = 'Catalyst::Engine::Apache::MP13';
2004 Catalyst::Exception->throw( message =>
2005 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2010 # install the correct mod_perl handler
2011 if ( $version >= 1.9901 ) {
2012 *handler = sub : method {
2013 shift->handle_request(@_);
2017 *handler = sub ($$) { shift->handle_request(@_) };
2022 elsif ( $software eq 'Zeus-Perl' ) {
2023 $engine = 'Catalyst::Engine::Zeus';
2027 Catalyst::Exception->throw(
2028 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2033 $engine = $class->engine_class;
2036 unless (Class::Inspector->loaded($engine)) {
2037 require Class::Inspector->filename($engine);
2040 # check for old engines that are no longer compatible
2042 if ( $engine->isa('Catalyst::Engine::Apache')
2043 && !Catalyst::Engine::Apache->VERSION )
2048 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2049 && Catalyst::Engine::Server->VERSION le '0.02' )
2054 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2055 && $engine->VERSION eq '0.01' )
2060 elsif ($engine->isa('Catalyst::Engine::Zeus')
2061 && $engine->VERSION eq '0.01' )
2067 Catalyst::Exception->throw( message =>
2068 qq/Engine "$engine" is not supported by this version of Catalyst/
2073 $class->engine( $engine->new );
2076 =head2 $c->setup_home
2078 Sets up the home directory.
2083 my ( $class, $home ) = @_;
2085 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2090 $home = Catalyst::Utils::home($class);
2094 $class->config->{home} ||= $home;
2095 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2099 =head2 $c->setup_log
2106 my ( $class, $debug ) = @_;
2108 unless ( $class->log ) {
2109 $class->log( Catalyst::Log->new );
2112 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2113 if ( defined($env_debug) ? $env_debug : $debug ) {
2115 *{"$class\::debug"} = sub { 1 };
2116 $class->log->debug('Debug messages enabled');
2120 =head2 $c->setup_plugins
2126 =head2 $c->setup_stats
2128 Sets up timing statistics class.
2133 my ( $class, $stats ) = @_;
2135 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2137 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2138 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2140 *{"$class\::use_stats"} = sub { 1 };
2141 $class->log->debug('Statistics enabled');
2146 =head2 $c->registered_plugins
2148 Returns a sorted list of the plugins which have either been stated in the
2149 import list or which have been added via C<< MyApp->plugin(@args); >>.
2151 If passed a given plugin name, it will report a boolean value indicating
2152 whether or not that plugin is loaded. A fully qualified name is required if
2153 the plugin name does not begin with C<Catalyst::Plugin::>.
2155 if ($c->registered_plugins('Some::Plugin')) {
2163 sub registered_plugins {
2165 return sort keys %{ $proto->_plugins } unless @_;
2167 return 1 if exists $proto->_plugins->{$plugin};
2168 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2171 sub _register_plugin {
2172 my ( $proto, $plugin, $instant ) = @_;
2173 my $class = ref $proto || $proto;
2175 # no ignore_loaded here, the plugin may already have been
2176 # defined in memory and we don't want to error on "no file" if so
2178 Catalyst::Utils::ensure_class_loaded( $plugin );
2180 $proto->_plugins->{$plugin} = 1;
2183 unshift @{"$class\::ISA"}, $plugin;
2189 my ( $class, $plugins ) = @_;
2191 $class->_plugins( {} ) unless $class->_plugins;
2193 for my $plugin ( reverse @$plugins ) {
2195 unless ( $plugin =~ s/\A\+// ) {
2196 $plugin = "Catalyst::Plugin::$plugin";
2199 $class->_register_plugin($plugin);
2206 Returns an arrayref of the internal execution stack (actions that are
2207 currently executing).
2209 =head2 $c->stats_class
2211 Returns or sets the stats (timing statistics) class.
2213 =head2 $c->use_stats
2215 Returns 1 when stats collection is enabled. Stats collection is enabled
2216 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2217 environment variable is set.
2219 Note that this is a static method, not an accessor and should be overloaded
2220 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2227 =head2 $c->write( $data )
2229 Writes $data to the output stream. When using this method directly, you
2230 will need to manually set the C<Content-Length> header to the length of
2231 your output data, if known.
2238 # Finalize headers if someone manually writes output
2239 $c->finalize_headers;
2241 return $c->engine->write( $c, @_ );
2246 Returns the Catalyst version number. Mostly useful for "powered by"
2247 messages in template systems.
2251 sub version { return $Catalyst::VERSION }
2253 =head1 INTERNAL ACTIONS
2255 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2256 C<_ACTION>, and C<_END>. These are by default not shown in the private
2257 action table, but you can make them visible with a config parameter.
2259 MyApp->config->{show_internal_actions} = 1;
2261 =head1 CASE SENSITIVITY
2263 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2264 mapped to C</foo/bar>. You can activate case sensitivity with a config
2267 MyApp->config->{case_sensitive} = 1;
2269 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2271 =head1 ON-DEMAND PARSER
2273 The request body is usually parsed at the beginning of a request,
2274 but if you want to handle input yourself, you can enable on-demand
2275 parsing with a config parameter.
2277 MyApp->config->{parse_on_demand} = 1;
2279 =head1 PROXY SUPPORT
2281 Many production servers operate using the common double-server approach,
2282 with a lightweight frontend web server passing requests to a larger
2283 backend server. An application running on the backend server must deal
2284 with two problems: the remote user always appears to be C<127.0.0.1> and
2285 the server's hostname will appear to be C<localhost> regardless of the
2286 virtual host that the user connected through.
2288 Catalyst will automatically detect this situation when you are running
2289 the frontend and backend servers on the same machine. The following
2290 changes are made to the request.
2292 $c->req->address is set to the user's real IP address, as read from
2293 the HTTP X-Forwarded-For header.
2295 The host value for $c->req->base and $c->req->uri is set to the real
2296 host, as read from the HTTP X-Forwarded-Host header.
2298 Obviously, your web server must support these headers for this to work.
2300 In a more complex server farm environment where you may have your
2301 frontend proxy server(s) on different machines, you will need to set a
2302 configuration option to tell Catalyst to read the proxied data from the
2305 MyApp->config->{using_frontend_proxy} = 1;
2307 If you do not wish to use the proxy support at all, you may set:
2309 MyApp->config->{ignore_frontend_proxy} = 1;
2311 =head1 THREAD SAFETY
2313 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2314 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2315 believe the Catalyst core to be thread-safe.
2317 If you plan to operate in a threaded environment, remember that all other
2318 modules you are using must also be thread-safe. Some modules, most notably
2319 L<DBD::SQLite>, are not thread-safe.
2325 Join #catalyst on irc.perl.org.
2329 http://lists.rawmode.org/mailman/listinfo/catalyst
2330 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2334 http://catalyst.perl.org
2338 http://dev.catalyst.perl.org
2342 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2344 =head2 L<Catalyst::Manual> - The Catalyst Manual
2346 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2348 =head2 L<Catalyst::Engine> - Core engine
2350 =head2 L<Catalyst::Log> - Log class.
2352 =head2 L<Catalyst::Request> - Request object
2354 =head2 L<Catalyst::Response> - Response object
2356 =head2 L<Catalyst::Test> - The test suite.
2430 Sebastian Riedel, C<sri@oook.de>
2434 This library is free software, you can redistribute it and/or modify it under
2435 the same terms as Perl itself.