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.7012';
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 Instead of C<$path>, you can also optionally pass a C<$action> object
924 which will be resolved to a path using
925 C<< $c->dispatcher->uri_for_action >>; if the first element of
926 C<@args> is an arrayref it is treated as a list of captures to be passed
927 to C<uri_for_action>.
932 my ( $c, $path, @args ) = @_;
934 if ( Scalar::Util::blessed($path) ) { # action object
935 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
938 $path = $c->dispatcher->uri_for_action($path, $captures);
939 return undef unless defined($path);
940 $path = '/' if $path eq '';
943 undef($path) if (defined $path && $path eq '');
946 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
948 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
949 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
951 unshift(@args, $path);
953 unless (defined $path && $path =~ s!^/!!) { # in-place strip
954 my $namespace = $c->namespace;
955 if (defined $path) { # cheesy hack to handle path '../foo'
956 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
958 unshift(@args, $namespace || '');
961 # join args with '/', or a blank string
962 my $args = join('/', grep { defined($_) } @args);
963 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
965 my $base = $c->req->base;
966 my $class = ref($base);
967 $base =~ s{(?<!/)$}{/};
971 if (my @keys = keys %$params) {
972 # somewhat lifted from URI::_query's query_form
973 $query = '?'.join('&', map {
974 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
977 my $val = $params->{$_};
978 $val = '' unless defined $val;
982 # using the URI::Escape pattern here so utf8 chars survive
983 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
985 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
989 my $res = bless(\"${base}${args}${query}", $class);
993 =head2 $c->welcome_message
995 Returns the Catalyst welcome HTML page.
999 sub welcome_message {
1001 my $name = $c->config->{name};
1002 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1003 my $prefix = Catalyst::Utils::appprefix( ref $c );
1004 $c->response->content_type('text/html; charset=utf-8');
1006 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1007 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1008 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1010 <meta http-equiv="Content-Language" content="en" />
1011 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1012 <title>$name on Catalyst $VERSION</title>
1013 <style type="text/css">
1016 background-color: #eee;
1023 margin-bottom: 10px;
1025 background-color: #ccc;
1026 border: 1px solid #aaa;
1031 font-family: verdana, tahoma, sans-serif;
1034 font-family: verdana, tahoma, sans-serif;
1037 text-decoration: none;
1039 border-bottom: 1px dotted #bbb;
1041 :link:hover, :visited:hover {
1054 background-color: #fff;
1055 border: 1px solid #aaa;
1059 font-weight: normal;
1081 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1086 <img src="$logo" alt="Catalyst Logo" />
1088 <p>Welcome to the world of Catalyst.
1089 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1090 framework will make web development something you had
1091 never expected it to be: Fun, rewarding, and quick.</p>
1092 <h2>What to do now?</h2>
1093 <p>That really depends on what <b>you</b> want to do.
1094 We do, however, provide you with a few starting points.</p>
1095 <p>If you want to jump right into web development with Catalyst
1096 you might want want to start with a tutorial.</p>
1097 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1099 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1101 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1102 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1104 <h2>What to do next?</h2>
1105 <p>Next it's time to write an actual application. Use the
1106 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1107 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1108 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1109 they can save you a lot of work.</p>
1110 <pre><code>script/${prefix}_create.pl -help</code></pre>
1111 <p>Also, be sure to check out the vast and growing
1112 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1113 you are likely to find what you need there.
1117 <p>Catalyst has a very active community. Here are the main places to
1118 get in touch with us.</p>
1121 <a href="http://dev.catalyst.perl.org">Wiki</a>
1124 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1127 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1130 <h2>In conclusion</h2>
1131 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1132 as we enjoyed making it. Please contact us if you have ideas
1133 for improvement or other feedback.</p>
1141 =head1 INTERNAL METHODS
1143 These methods are not meant to be used by end users.
1145 =head2 $c->components
1147 Returns a hash of components.
1149 =head2 $c->context_class
1151 Returns or sets the context class.
1155 Returns a hashref containing coderefs and execution counts (needed for
1156 deep recursion detection).
1160 Returns the number of actions on the current internal execution stack.
1164 Dispatches a request to actions.
1168 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1170 =head2 $c->dispatcher_class
1172 Returns or sets the dispatcher class.
1174 =head2 $c->dump_these
1176 Returns a list of 2-element array references (name, structure) pairs
1177 that will be dumped on the error page in debug mode.
1183 [ Request => $c->req ],
1184 [ Response => $c->res ],
1185 [ Stash => $c->stash ],
1186 [ Config => $c->config ];
1189 =head2 $c->engine_class
1191 Returns or sets the engine class.
1193 =head2 $c->execute( $class, $coderef )
1195 Execute a coderef in given class and catch exceptions. Errors are available
1201 my ( $c, $class, $code ) = @_;
1202 $class = $c->component($class) || $class;
1205 if ( $c->depth >= $RECURSION ) {
1206 my $action = "$code";
1207 $action = "/$action" unless $action =~ /->/;
1208 my $error = qq/Deep recursion detected calling "$action"/;
1209 $c->log->error($error);
1215 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1217 push( @{ $c->stack }, $code );
1219 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1221 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1223 my $last = pop( @{ $c->stack } );
1225 if ( my $error = $@ ) {
1226 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1228 unless ( ref $error ) {
1229 no warnings 'uninitialized';
1231 my $class = $last->class;
1232 my $name = $last->name;
1233 $error = qq/Caught exception in $class->$name "$error"/;
1242 sub _stats_start_execute {
1243 my ( $c, $code ) = @_;
1245 return if ( ( $code->name =~ /^_.*/ )
1246 && ( !$c->config->{show_internal_actions} ) );
1248 $c->counter->{"$code"}++;
1250 my $action = "$code";
1251 $action = "/$action" unless $action =~ /->/;
1253 # determine if the call was the result of a forward
1254 # this is done by walking up the call stack and looking for a calling
1255 # sub of Catalyst::forward before the eval
1257 for my $index ( 2 .. 11 ) {
1259 if ( ( caller($index) )[0] eq 'Catalyst'
1260 && ( caller($index) )[3] eq '(eval)' );
1262 if ( ( caller($index) )[3] =~ /forward$/ ) {
1263 $callsub = ( caller($index) )[3];
1264 $action = "-> $action";
1269 my $uid = "$code" . $c->counter->{"$code"};
1271 # is this a root-level call or a forwarded call?
1272 if ( $callsub =~ /forward$/ ) {
1274 # forward, locate the caller
1275 if ( my $parent = $c->stack->[-1] ) {
1278 parent => "$parent" . $c->counter->{"$parent"},
1284 # forward with no caller may come from a plugin
1303 sub _stats_finish_execute {
1304 my ( $c, $info ) = @_;
1305 $c->stats->profile( end => $info );
1308 =head2 $c->_localize_fields( sub { }, \%keys );
1312 sub _localize_fields {
1313 my ( $c, $localized, $code ) = ( @_ );
1315 my $request = delete $localized->{request} || {};
1316 my $response = delete $localized->{response} || {};
1318 local @{ $c }{ keys %$localized } = values %$localized;
1319 local @{ $c->request }{ keys %$request } = values %$request;
1320 local @{ $c->response }{ keys %$response } = values %$response;
1327 Finalizes the request.
1334 for my $error ( @{ $c->error } ) {
1335 $c->log->error($error);
1338 # Allow engine to handle finalize flow (for POE)
1339 if ( $c->engine->can('finalize') ) {
1340 $c->engine->finalize($c);
1344 $c->finalize_uploads;
1347 if ( $#{ $c->error } >= 0 ) {
1351 $c->finalize_headers;
1354 if ( $c->request->method eq 'HEAD' ) {
1355 $c->response->body('');
1361 if ($c->use_stats) {
1362 my $elapsed = sprintf '%f', $c->stats->elapsed;
1363 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1365 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1368 return $c->response->status;
1371 =head2 $c->finalize_body
1377 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1379 =head2 $c->finalize_cookies
1385 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1387 =head2 $c->finalize_error
1393 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1395 =head2 $c->finalize_headers
1401 sub finalize_headers {
1404 # Check if we already finalized headers
1405 return if $c->response->{_finalized_headers};
1408 if ( my $location = $c->response->redirect ) {
1409 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1410 $c->response->header( Location => $location );
1412 if ( !$c->response->body ) {
1413 # Add a default body if none is already present
1415 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1421 if ( $c->response->body && !$c->response->content_length ) {
1423 # get the length from a filehandle
1424 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1426 my $stat = stat $c->response->body;
1427 if ( $stat && $stat->size > 0 ) {
1428 $c->response->content_length( $stat->size );
1431 $c->log->warn('Serving filehandle without a content-length');
1435 $c->response->content_length( bytes::length( $c->response->body ) );
1440 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1441 $c->response->headers->remove_header("Content-Length");
1442 $c->response->body('');
1445 $c->finalize_cookies;
1447 $c->engine->finalize_headers( $c, @_ );
1450 $c->response->{_finalized_headers} = 1;
1453 =head2 $c->finalize_output
1455 An alias for finalize_body.
1457 =head2 $c->finalize_read
1459 Finalizes the input after reading is complete.
1463 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1465 =head2 $c->finalize_uploads
1467 Finalizes uploads. Cleans up any temporary files.
1471 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1473 =head2 $c->get_action( $action, $namespace )
1475 Gets an action in a given namespace.
1479 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1481 =head2 $c->get_actions( $action, $namespace )
1483 Gets all actions of a given name in a namespace and all parent
1488 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1490 =head2 $c->handle_request( $class, @arguments )
1492 Called to handle each HTTP request.
1496 sub handle_request {
1497 my ( $class, @arguments ) = @_;
1499 # Always expect worst case!
1502 if ($class->debug) {
1503 my $secs = time - $START || 1;
1504 my $av = sprintf '%.3f', $COUNT / $secs;
1505 my $time = localtime time;
1506 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1509 my $c = $class->prepare(@arguments);
1511 $status = $c->finalize;
1514 if ( my $error = $@ ) {
1516 $class->log->error(qq/Caught exception in engine "$error"/);
1520 $class->log->_flush() if $class->log->can('_flush');
1524 =head2 $c->prepare( @arguments )
1526 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1532 my ( $class, @arguments ) = @_;
1534 $class->context_class( ref $class || $class ) unless $class->context_class;
1535 my $c = $class->context_class->new(
1539 request => $class->request_class->new(
1542 body_parameters => {},
1544 headers => HTTP::Headers->new,
1546 query_parameters => {},
1552 response => $class->response_class->new(
1556 headers => HTTP::Headers->new(),
1565 $c->stats($class->stats_class->new)->enable($c->use_stats);
1567 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1570 # For on-demand data
1571 $c->request->{_context} = $c;
1572 $c->response->{_context} = $c;
1573 weaken( $c->request->{_context} );
1574 weaken( $c->response->{_context} );
1576 # Allow engine to direct the prepare flow (for POE)
1577 if ( $c->engine->can('prepare') ) {
1578 $c->engine->prepare( $c, @arguments );
1581 $c->prepare_request(@arguments);
1582 $c->prepare_connection;
1583 $c->prepare_query_parameters;
1584 $c->prepare_headers;
1585 $c->prepare_cookies;
1588 # Prepare the body for reading, either by prepare_body
1589 # or the user, if they are using $c->read
1592 # Parse the body unless the user wants it on-demand
1593 unless ( $c->config->{parse_on_demand} ) {
1598 my $method = $c->req->method || '';
1599 my $path = $c->req->path || '/';
1600 my $address = $c->req->address || '';
1602 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1610 =head2 $c->prepare_action
1612 Prepares action. See L<Catalyst::Dispatcher>.
1616 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1618 =head2 $c->prepare_body
1620 Prepares message body.
1627 # Do we run for the first time?
1628 return if defined $c->request->{_body};
1630 # Initialize on-demand data
1631 $c->engine->prepare_body( $c, @_ );
1632 $c->prepare_parameters;
1633 $c->prepare_uploads;
1635 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1636 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1637 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1638 my $param = $c->req->body_parameters->{$key};
1639 my $value = defined($param) ? $param : '';
1641 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1643 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1647 =head2 $c->prepare_body_chunk( $chunk )
1649 Prepares a chunk of data before sending it to L<HTTP::Body>.
1651 See L<Catalyst::Engine>.
1655 sub prepare_body_chunk {
1657 $c->engine->prepare_body_chunk( $c, @_ );
1660 =head2 $c->prepare_body_parameters
1662 Prepares body parameters.
1666 sub prepare_body_parameters {
1668 $c->engine->prepare_body_parameters( $c, @_ );
1671 =head2 $c->prepare_connection
1673 Prepares connection.
1677 sub prepare_connection {
1679 $c->engine->prepare_connection( $c, @_ );
1682 =head2 $c->prepare_cookies
1688 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1690 =head2 $c->prepare_headers
1696 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1698 =head2 $c->prepare_parameters
1700 Prepares parameters.
1704 sub prepare_parameters {
1706 $c->prepare_body_parameters;
1707 $c->engine->prepare_parameters( $c, @_ );
1710 =head2 $c->prepare_path
1712 Prepares path and base.
1716 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1718 =head2 $c->prepare_query_parameters
1720 Prepares query parameters.
1724 sub prepare_query_parameters {
1727 $c->engine->prepare_query_parameters( $c, @_ );
1729 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1730 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1731 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1732 my $param = $c->req->query_parameters->{$key};
1733 my $value = defined($param) ? $param : '';
1735 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1737 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1741 =head2 $c->prepare_read
1743 Prepares the input for reading.
1747 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1749 =head2 $c->prepare_request
1751 Prepares the engine request.
1755 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1757 =head2 $c->prepare_uploads
1763 sub prepare_uploads {
1766 $c->engine->prepare_uploads( $c, @_ );
1768 if ( $c->debug && keys %{ $c->request->uploads } ) {
1769 my $t = Text::SimpleTable->new(
1770 [ 12, 'Parameter' ],
1775 for my $key ( sort keys %{ $c->request->uploads } ) {
1776 my $upload = $c->request->uploads->{$key};
1777 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1778 $t->row( $key, $u->filename, $u->type, $u->size );
1781 $c->log->debug( "File Uploads are:\n" . $t->draw );
1785 =head2 $c->prepare_write
1787 Prepares the output for writing.
1791 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1793 =head2 $c->request_class
1795 Returns or sets the request class.
1797 =head2 $c->response_class
1799 Returns or sets the response class.
1801 =head2 $c->read( [$maxlength] )
1803 Reads a chunk of data from the request body. This method is designed to
1804 be used in a while loop, reading C<$maxlength> bytes on every call.
1805 C<$maxlength> defaults to the size of the request if not specified.
1807 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1810 Warning: If you use read(), Catalyst will not process the body,
1811 so you will not be able to access POST parameters or file uploads via
1812 $c->request. You must handle all body parsing yourself.
1816 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1824 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1826 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1828 Sets an action in a given namespace.
1832 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1834 =head2 $c->setup_actions($component)
1836 Sets up actions for a component.
1840 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1842 =head2 $c->setup_components
1844 Sets up components. Specify a C<setup_components> config option to pass
1845 additional options directly to L<Module::Pluggable>. To add additional
1846 search paths, specify a key named C<search_extra> as an array
1847 reference. Items in the array beginning with C<::> will have the
1848 application class name prepended to them.
1852 sub setup_components {
1855 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1856 my $config = $class->config->{ setup_components };
1857 my $extra = delete $config->{ search_extra } || [];
1859 push @paths, @$extra;
1861 my $locator = Module::Pluggable::Object->new(
1862 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1866 my @comps = sort { length $a <=> length $b } $locator->plugins;
1867 my %comps = map { $_ => 1 } @comps;
1869 for my $component ( @comps ) {
1871 # We pass ignore_loaded here so that overlay files for (e.g.)
1872 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1873 # we know M::P::O found a file on disk so this is safe
1875 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1877 my $module = $class->setup_component( $component );
1879 $component => $module,
1881 $_ => $class->setup_component( $_ )
1883 not exists $comps{$_}
1884 } Devel::InnerPackage::list_packages( $component )
1887 for my $key ( keys %modules ) {
1888 $class->components->{ $key } = $modules{ $key };
1893 =head2 $c->setup_component
1897 sub setup_component {
1898 my( $class, $component ) = @_;
1900 unless ( $component->can( 'COMPONENT' ) ) {
1904 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1905 my $config = $class->config->{ $suffix } || {};
1907 my $instance = eval { $component->COMPONENT( $class, $config ); };
1909 if ( my $error = $@ ) {
1911 Catalyst::Exception->throw(
1912 message => qq/Couldn't instantiate component "$component", "$error"/
1916 Catalyst::Exception->throw(
1918 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1919 ) unless eval { $instance->can( 'can' ) };
1924 =head2 $c->setup_dispatcher
1930 sub setup_dispatcher {
1931 my ( $class, $dispatcher ) = @_;
1934 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1937 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1938 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1941 unless ($dispatcher) {
1942 $dispatcher = $class->dispatcher_class;
1945 unless (Class::Inspector->loaded($dispatcher)) {
1946 require Class::Inspector->filename($dispatcher);
1949 # dispatcher instance
1950 $class->dispatcher( $dispatcher->new );
1953 =head2 $c->setup_engine
1960 my ( $class, $engine ) = @_;
1963 $engine = 'Catalyst::Engine::' . $engine;
1966 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
1967 $engine = 'Catalyst::Engine::' . $env;
1970 if ( $ENV{MOD_PERL} ) {
1972 # create the apache method
1975 *{"$class\::apache"} = sub { shift->engine->apache };
1978 my ( $software, $version ) =
1979 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1982 $version =~ s/(\.[^.]+)\./$1/g;
1984 if ( $software eq 'mod_perl' ) {
1988 if ( $version >= 1.99922 ) {
1989 $engine = 'Catalyst::Engine::Apache2::MP20';
1992 elsif ( $version >= 1.9901 ) {
1993 $engine = 'Catalyst::Engine::Apache2::MP19';
1996 elsif ( $version >= 1.24 ) {
1997 $engine = 'Catalyst::Engine::Apache::MP13';
2001 Catalyst::Exception->throw( message =>
2002 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2007 # install the correct mod_perl handler
2008 if ( $version >= 1.9901 ) {
2009 *handler = sub : method {
2010 shift->handle_request(@_);
2014 *handler = sub ($$) { shift->handle_request(@_) };
2019 elsif ( $software eq 'Zeus-Perl' ) {
2020 $engine = 'Catalyst::Engine::Zeus';
2024 Catalyst::Exception->throw(
2025 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2030 $engine = $class->engine_class;
2033 unless (Class::Inspector->loaded($engine)) {
2034 require Class::Inspector->filename($engine);
2037 # check for old engines that are no longer compatible
2039 if ( $engine->isa('Catalyst::Engine::Apache')
2040 && !Catalyst::Engine::Apache->VERSION )
2045 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2046 && Catalyst::Engine::Server->VERSION le '0.02' )
2051 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2052 && $engine->VERSION eq '0.01' )
2057 elsif ($engine->isa('Catalyst::Engine::Zeus')
2058 && $engine->VERSION eq '0.01' )
2064 Catalyst::Exception->throw( message =>
2065 qq/Engine "$engine" is not supported by this version of Catalyst/
2070 $class->engine( $engine->new );
2073 =head2 $c->setup_home
2075 Sets up the home directory.
2080 my ( $class, $home ) = @_;
2082 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2087 $home = Catalyst::Utils::home($class);
2091 $class->config->{home} ||= $home;
2092 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2096 =head2 $c->setup_log
2103 my ( $class, $debug ) = @_;
2105 unless ( $class->log ) {
2106 $class->log( Catalyst::Log->new );
2109 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2110 if ( defined($env_debug) ? $env_debug : $debug ) {
2112 *{"$class\::debug"} = sub { 1 };
2113 $class->log->debug('Debug messages enabled');
2117 =head2 $c->setup_plugins
2123 =head2 $c->setup_stats
2125 Sets up timing statistics class.
2130 my ( $class, $stats ) = @_;
2132 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2134 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2135 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2137 *{"$class\::use_stats"} = sub { 1 };
2138 $class->log->debug('Statistics enabled');
2143 =head2 $c->registered_plugins
2145 Returns a sorted list of the plugins which have either been stated in the
2146 import list or which have been added via C<< MyApp->plugin(@args); >>.
2148 If passed a given plugin name, it will report a boolean value indicating
2149 whether or not that plugin is loaded. A fully qualified name is required if
2150 the plugin name does not begin with C<Catalyst::Plugin::>.
2152 if ($c->registered_plugins('Some::Plugin')) {
2160 sub registered_plugins {
2162 return sort keys %{ $proto->_plugins } unless @_;
2164 return 1 if exists $proto->_plugins->{$plugin};
2165 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2168 sub _register_plugin {
2169 my ( $proto, $plugin, $instant ) = @_;
2170 my $class = ref $proto || $proto;
2172 # no ignore_loaded here, the plugin may already have been
2173 # defined in memory and we don't want to error on "no file" if so
2175 Catalyst::Utils::ensure_class_loaded( $plugin );
2177 $proto->_plugins->{$plugin} = 1;
2180 unshift @{"$class\::ISA"}, $plugin;
2186 my ( $class, $plugins ) = @_;
2188 $class->_plugins( {} ) unless $class->_plugins;
2190 for my $plugin ( reverse @$plugins ) {
2192 unless ( $plugin =~ s/\A\+// ) {
2193 $plugin = "Catalyst::Plugin::$plugin";
2196 $class->_register_plugin($plugin);
2203 Returns an arrayref of the internal execution stack (actions that are
2204 currently executing).
2206 =head2 $c->stats_class
2208 Returns or sets the stats (timing statistics) class.
2210 =head2 $c->use_stats
2212 Returns 1 when stats collection is enabled. Stats collection is enabled
2213 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2214 environment variable is set.
2216 Note that this is a static method, not an accessor and should be overloaded
2217 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2224 =head2 $c->write( $data )
2226 Writes $data to the output stream. When using this method directly, you
2227 will need to manually set the C<Content-Length> header to the length of
2228 your output data, if known.
2235 # Finalize headers if someone manually writes output
2236 $c->finalize_headers;
2238 return $c->engine->write( $c, @_ );
2243 Returns the Catalyst version number. Mostly useful for "powered by"
2244 messages in template systems.
2248 sub version { return $Catalyst::VERSION }
2250 =head1 INTERNAL ACTIONS
2252 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2253 C<_ACTION>, and C<_END>. These are by default not shown in the private
2254 action table, but you can make them visible with a config parameter.
2256 MyApp->config->{show_internal_actions} = 1;
2258 =head1 CASE SENSITIVITY
2260 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2261 mapped to C</foo/bar>. You can activate case sensitivity with a config
2264 MyApp->config->{case_sensitive} = 1;
2266 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2268 =head1 ON-DEMAND PARSER
2270 The request body is usually parsed at the beginning of a request,
2271 but if you want to handle input yourself, you can enable on-demand
2272 parsing with a config parameter.
2274 MyApp->config->{parse_on_demand} = 1;
2276 =head1 PROXY SUPPORT
2278 Many production servers operate using the common double-server approach,
2279 with a lightweight frontend web server passing requests to a larger
2280 backend server. An application running on the backend server must deal
2281 with two problems: the remote user always appears to be C<127.0.0.1> and
2282 the server's hostname will appear to be C<localhost> regardless of the
2283 virtual host that the user connected through.
2285 Catalyst will automatically detect this situation when you are running
2286 the frontend and backend servers on the same machine. The following
2287 changes are made to the request.
2289 $c->req->address is set to the user's real IP address, as read from
2290 the HTTP X-Forwarded-For header.
2292 The host value for $c->req->base and $c->req->uri is set to the real
2293 host, as read from the HTTP X-Forwarded-Host header.
2295 Obviously, your web server must support these headers for this to work.
2297 In a more complex server farm environment where you may have your
2298 frontend proxy server(s) on different machines, you will need to set a
2299 configuration option to tell Catalyst to read the proxied data from the
2302 MyApp->config->{using_frontend_proxy} = 1;
2304 If you do not wish to use the proxy support at all, you may set:
2306 MyApp->config->{ignore_frontend_proxy} = 1;
2308 =head1 THREAD SAFETY
2310 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2311 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2312 believe the Catalyst core to be thread-safe.
2314 If you plan to operate in a threaded environment, remember that all other
2315 modules you are using must also be thread-safe. Some modules, most notably
2316 L<DBD::SQLite>, are not thread-safe.
2322 Join #catalyst on irc.perl.org.
2326 http://lists.rawmode.org/mailman/listinfo/catalyst
2327 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2331 http://catalyst.perl.org
2335 http://dev.catalyst.perl.org
2339 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2341 =head2 L<Catalyst::Manual> - The Catalyst Manual
2343 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2345 =head2 L<Catalyst::Engine> - Core engine
2347 =head2 L<Catalyst::Log> - Log class.
2349 =head2 L<Catalyst::Request> - Request object
2351 =head2 L<Catalyst::Response> - Response object
2353 =head2 L<Catalyst::Test> - The test suite.
2427 Sebastian Riedel, C<sri@oook.de>
2431 This library is free software, you can redistribute it and/or modify it under
2432 the same terms as Perl itself.