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 setup_finished/;
59 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
60 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
61 __PACKAGE__->request_class('Catalyst::Request');
62 __PACKAGE__->response_class('Catalyst::Response');
64 # Remember to update this in Catalyst::Runtime as well!
66 our $VERSION = '5.7011';
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 =head2 INFORMATION ABOUT THE CURRENT REQUEST
249 Returns a L<Catalyst::Action> object for the current action, which
250 stringifies to the action name. See L<Catalyst::Action>.
254 Returns the namespace of the current action, i.e., the URI prefix
255 corresponding to the controller of the current action. For example:
257 # in Controller::Foo::Bar
258 $c->namespace; # returns 'foo/bar';
264 Returns the current L<Catalyst::Request> object, giving access to
265 information about the current client request (including parameters,
266 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
268 =head2 REQUEST FLOW HANDLING
270 =head2 $c->forward( $action [, \@arguments ] )
272 =head2 $c->forward( $class, $method, [, \@arguments ] )
274 Forwards processing to another action, by its private name. If you give a
275 class name but no method, C<process()> is called. You may also optionally
276 pass arguments in an arrayref. The action will receive the arguments in
277 C<@_> and C<< $c->req->args >>. Upon returning from the function,
278 C<< $c->req->args >> will be restored to the previous values.
280 Any data C<return>ed from the action forwarded to, will be returned by the
283 my $foodata = $c->forward('/foo');
284 $c->forward('index');
285 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
286 $c->forward('MyApp::View::TT');
288 Note that forward implies an C<<eval { }>> around the call (actually
289 C<execute> does), thus de-fatalizing all 'dies' within the called
290 action. If you want C<die> to propagate you need to do something like:
293 die $c->error if $c->error;
295 Or make sure to always return true values from your actions and write
298 $c->forward('foo') || return;
302 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
304 =head2 $c->detach( $action [, \@arguments ] )
306 =head2 $c->detach( $class, $method, [, \@arguments ] )
310 The same as C<forward>, but doesn't return to the previous action when
311 processing is finished.
313 When called with no arguments it escapes the processing chain entirely.
317 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
323 Returns the current L<Catalyst::Response> object, see there for details.
327 Returns a hashref to the stash, which may be used to store data and pass
328 it between components during a request. You can also set hash keys by
329 passing arguments. The stash is automatically sent to the view. The
330 stash is cleared at the end of a request; it cannot be used for
331 persistent storage (for this you must use a session; see
332 L<Catalyst::Plugin::Session> for a complete system integrated with
335 $c->stash->{foo} = $bar;
336 $c->stash( { moose => 'majestic', qux => 0 } );
337 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
339 # stash is automatically passed to the view for use in a template
340 $c->forward( 'MyApp::View::TT' );
347 my $stash = @_ > 1 ? {@_} : $_[0];
348 croak('stash takes a hash or hashref') unless ref $stash;
349 foreach my $key ( keys %$stash ) {
350 $c->{stash}->{$key} = $stash->{$key};
358 =head2 $c->error($error, ...)
360 =head2 $c->error($arrayref)
362 Returns an arrayref containing error messages. If Catalyst encounters an
363 error while processing a request, it stores the error in $c->error. This
364 method should only be used to store fatal error messages.
366 my @error = @{ $c->error };
370 $c->error('Something bad happened');
377 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
378 croak @$error unless ref $c;
379 push @{ $c->{error} }, @$error;
381 elsif ( defined $_[0] ) { $c->{error} = undef }
382 return $c->{error} || [];
388 Contains the return value of the last executed action.
390 =head2 $c->clear_errors
392 Clear errors. You probably don't want to clear the errors unless you are
393 implementing a custom error screen.
395 This is equivalent to running
409 my ( $c, @names ) = @_;
411 foreach my $name (@names) {
412 foreach my $component ( keys %{ $c->components } ) {
413 return $c->components->{$component} if $component =~ /$name/i;
420 # try explicit component names
422 my ( $c, @names ) = @_;
424 foreach my $try (@names) {
425 return $c->components->{$try} if ( exists $c->components->{$try} );
431 # like component, but try just these prefixes before regex searching,
432 # and do not try to return "sort keys %{ $c->components }"
434 my ( $c, $name, @prefixes ) = @_;
436 my $appclass = ref $c || $c;
438 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
440 my $comp = $c->_comp_explicit(@names);
441 return $comp if defined($comp);
442 $comp = $c->_comp_search($name);
446 # Find possible names for a prefix
449 my ( $c, @prefixes ) = @_;
451 my $appclass = ref $c || $c;
453 my @pre = map { "${appclass}::${_}::" } @prefixes;
457 COMPONENT: foreach my $comp ($c->component) {
458 foreach my $p (@pre) {
459 if ($comp =~ s/^$p//) {
469 # Return a component if only one matches.
471 my ( $c, @prefixes ) = @_;
473 my $appclass = ref $c || $c;
475 my ( $comp, $rest ) =
476 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
477 return $comp unless $rest;
480 # Filter a component before returning by calling ACCEPT_CONTEXT if available
481 sub _filter_component {
482 my ( $c, $comp, @args ) = @_;
483 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
484 return $comp->ACCEPT_CONTEXT( $c, @args );
486 else { return $comp }
489 =head2 COMPONENT ACCESSORS
491 =head2 $c->controller($name)
493 Gets a L<Catalyst::Controller> instance by name.
495 $c->controller('Foo')->do_stuff;
497 If the name is omitted, will return the controller for the dispatched
503 my ( $c, $name, @args ) = @_;
504 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
507 return $c->component( $c->action->class );
510 =head2 $c->model($name)
512 Gets a L<Catalyst::Model> instance by name.
514 $c->model('Foo')->do_stuff;
516 Any extra arguments are directly passed to ACCEPT_CONTEXT.
518 If the name is omitted, it will look for
519 - a model object in $c->stash{current_model_instance}, then
520 - a model name in $c->stash->{current_model}, then
521 - a config setting 'default_model', or
522 - check if there is only one model, and return it if that's the case.
527 my ( $c, $name, @args ) = @_;
528 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
532 return $c->stash->{current_model_instance}
533 if $c->stash->{current_model_instance};
534 return $c->model( $c->stash->{current_model} )
535 if $c->stash->{current_model};
537 return $c->model( $c->config->{default_model} )
538 if $c->config->{default_model};
539 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
543 =head2 $c->controllers
545 Returns the available names which can be passed to $c->controller
551 return $c->_comp_names(qw/Controller C/);
555 =head2 $c->view($name)
557 Gets a L<Catalyst::View> instance by name.
559 $c->view('Foo')->do_stuff;
561 Any extra arguments are directly passed to ACCEPT_CONTEXT.
563 If the name is omitted, it will look for
564 - a view object in $c->stash{current_view_instance}, then
565 - a view name in $c->stash->{current_view}, then
566 - a config setting 'default_view', or
567 - check if there is only one view, and return it if that's the case.
572 my ( $c, $name, @args ) = @_;
573 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
577 return $c->stash->{current_view_instance}
578 if $c->stash->{current_view_instance};
579 return $c->view( $c->stash->{current_view} )
580 if $c->stash->{current_view};
582 return $c->view( $c->config->{default_view} )
583 if $c->config->{default_view};
584 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
589 Returns the available names which can be passed to $c->model
595 return $c->_comp_names(qw/Model M/);
601 Returns the available names which can be passed to $c->view
607 return $c->_comp_names(qw/View V/);
610 =head2 $c->comp($name)
612 =head2 $c->component($name)
614 Gets a component object by name. This method is not recommended,
615 unless you want to get a specific component by full
616 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
617 should be used instead.
628 my $appclass = ref $c || $c;
631 $name, "${appclass}::${name}",
632 map { "${appclass}::${_}::${name}" }
633 qw/Model M Controller C View V/
636 my $comp = $c->_comp_explicit(@names);
637 return $c->_filter_component( $comp, @_ ) if defined($comp);
639 $comp = $c->_comp_search($name);
640 return $c->_filter_component( $comp, @_ ) if defined($comp);
643 return sort keys %{ $c->components };
648 =head2 CLASS DATA AND HELPER CLASSES
652 Returns or takes a hashref containing the application's configuration.
654 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
656 You can also use a C<YAML>, C<XML> or C<Config::General> config file
657 like myapp.yml in your applications home directory. See
658 L<Catalyst::Plugin::ConfigLoader>.
661 db: dsn:SQLite:foo.db
669 $c->log->warn("Setting config after setup has been run is not a good idea.")
670 if ( @_ and $c->setup_finished );
672 $c->NEXT::config(@_);
677 Returns the logging object instance. Unless it is already set, Catalyst
678 sets this up with a L<Catalyst::Log> object. To use your own log class,
679 set the logger with the C<< __PACKAGE__->log >> method prior to calling
680 C<< __PACKAGE__->setup >>.
682 __PACKAGE__->log( MyLogger->new );
687 $c->log->info( 'Now logging with my own logger!' );
689 Your log class should implement the methods described in
695 Overload to enable debug messages (same as -Debug option).
697 Note that this is a static method, not an accessor and should be overloaded
698 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
704 =head2 $c->dispatcher
706 Returns the dispatcher instance. Stringifies to class name. See
707 L<Catalyst::Dispatcher>.
711 Returns the engine instance. Stringifies to the class name. See
715 =head2 UTILITY METHODS
717 =head2 $c->path_to(@path)
719 Merges C<@path> with C<< $c->config->{home} >> and returns a
720 L<Path::Class::Dir> object.
724 $c->path_to( 'db', 'sqlite.db' );
729 my ( $c, @path ) = @_;
730 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
731 if ( -d $path ) { return $path }
732 else { return Path::Class::File->new( $c->config->{home}, @path ) }
735 =head2 $c->plugin( $name, $class, @args )
737 Helper method for plugins. It creates a classdata accessor/mutator and
738 loads and instantiates the given class.
740 MyApp->plugin( 'prototype', 'HTML::Prototype' );
742 $c->prototype->define_javascript_functions;
747 my ( $class, $name, $plugin, @args ) = @_;
748 $class->_register_plugin( $plugin, 1 );
750 eval { $plugin->import };
751 $class->mk_classdata($name);
753 eval { $obj = $plugin->new(@args) };
756 Catalyst::Exception->throw( message =>
757 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
761 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
767 Initializes the dispatcher and engine, loads any plugins, and loads the
768 model, view, and controller components. You may also specify an array
769 of plugins to load here, if you choose to not load them in the C<use
773 MyApp->setup( qw/-Debug/ );
778 my ( $class, @arguments ) = @_;
780 $class->log->warn("Running setup twice is not a good idea.")
781 if ( $class->setup_finished );
783 unless ( $class->isa('Catalyst') ) {
785 Catalyst::Exception->throw(
786 message => qq/'$class' does not inherit from Catalyst/ );
789 if ( $class->arguments ) {
790 @arguments = ( @arguments, @{ $class->arguments } );
796 foreach (@arguments) {
800 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
802 elsif (/^-(\w+)=?(.*)$/) {
803 $flags->{ lc $1 } = $2;
806 push @{ $flags->{plugins} }, $_;
810 $class->setup_home( delete $flags->{home} );
812 $class->setup_log( delete $flags->{log} );
813 $class->setup_plugins( delete $flags->{plugins} );
814 $class->setup_dispatcher( delete $flags->{dispatcher} );
815 $class->setup_engine( delete $flags->{engine} );
817 for my $flag ( sort keys %{$flags} ) {
819 if ( my $code = $class->can( 'setup_' . $flag ) ) {
820 &$code( $class, delete $flags->{$flag} );
823 $class->log->warn(qq/Unknown flag "$flag"/);
827 eval { require Catalyst::Devel; };
828 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
829 $class->log->warn(<<"EOF");
830 You are running an old script!
832 Please update by running (this will overwrite existing files):
833 catalyst.pl -force -scripts $class
835 or (this will not overwrite existing files):
836 catalyst.pl -scripts $class
841 if ( $class->debug ) {
842 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
845 my $t = Text::SimpleTable->new(74);
846 $t->row($_) for @plugins;
847 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
850 my $dispatcher = $class->dispatcher;
851 my $engine = $class->engine;
852 my $home = $class->config->{home};
854 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
855 $class->log->debug(qq/Loaded engine "$engine"/);
859 ? $class->log->debug(qq/Found home "$home"/)
860 : $class->log->debug(qq/Home "$home" doesn't exist/)
861 : $class->log->debug(q/Couldn't find home/);
866 no warnings qw/redefine/;
867 local *setup = sub { };
871 # Initialize our data structure
872 $class->components( {} );
874 $class->setup_components;
876 if ( $class->debug ) {
877 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
878 for my $comp ( sort keys %{ $class->components } ) {
879 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
880 $t->row( $comp, $type );
882 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
883 if ( keys %{ $class->components } );
886 # Add our self to components, since we are also a component
887 $class->components->{$class} = $class;
889 $class->setup_actions;
891 if ( $class->debug ) {
892 my $name = $class->config->{name} || 'Application';
893 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
895 $class->log->_flush() if $class->log->can('_flush');
897 $class->setup_finished(1);
900 =head2 $c->uri_for( $path, @args?, \%query_values? )
902 Merges path with C<< $c->request->base >> for absolute URIs and with
903 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
904 object. If any args are passed, they are added at the end of the path.
905 If the last argument to C<uri_for> is a hash reference, it is assumed to
906 contain GET parameter key/value pairs, which will be appended to the URI
909 Instead of C<$path>, you can also optionally pass a C<$action> object
910 which will be resolved to a path using
911 C<< $c->dispatcher->uri_for_action >>; if the first element of
912 C<@args> is an arrayref it is treated as a list of captures to be passed
913 to C<uri_for_action>.
918 my ( $c, $path, @args ) = @_;
920 if ( Scalar::Util::blessed($path) ) { # action object
921 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
924 $path = $c->dispatcher->uri_for_action($path, $captures);
925 return undef unless defined($path);
926 $path = '/' if $path eq '';
929 undef($path) if (defined $path && $path eq '');
932 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
934 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
935 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
937 unshift(@args, $path);
939 unless (defined $path && $path =~ s!^/!!) { # in-place strip
940 my $namespace = $c->namespace;
941 if (defined $path) { # cheesy hack to handle path '../foo'
942 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
944 unshift(@args, $namespace || '');
947 # join args with '/', or a blank string
948 my $args = join('/', grep { defined($_) } @args);
949 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
951 my $base = $c->req->base;
952 my $class = ref($base);
953 $base =~ s{(?<!/)$}{/};
957 if (my @keys = keys %$params) {
958 # somewhat lifted from URI::_query's query_form
959 $query = '?'.join('&', map {
960 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
963 my $val = $params->{$_};
964 $val = '' unless defined $val;
968 # using the URI::Escape pattern here so utf8 chars survive
969 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
971 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
975 my $res = bless(\"${base}${args}${query}", $class);
979 =head2 $c->welcome_message
981 Returns the Catalyst welcome HTML page.
985 sub welcome_message {
987 my $name = $c->config->{name};
988 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
989 my $prefix = Catalyst::Utils::appprefix( ref $c );
990 $c->response->content_type('text/html; charset=utf-8');
992 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
993 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
994 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
996 <meta http-equiv="Content-Language" content="en" />
997 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
998 <title>$name on Catalyst $VERSION</title>
999 <style type="text/css">
1002 background-color: #eee;
1009 margin-bottom: 10px;
1011 background-color: #ccc;
1012 border: 1px solid #aaa;
1017 font-family: verdana, tahoma, sans-serif;
1020 font-family: verdana, tahoma, sans-serif;
1023 text-decoration: none;
1025 border-bottom: 1px dotted #bbb;
1027 :link:hover, :visited:hover {
1040 background-color: #fff;
1041 border: 1px solid #aaa;
1045 font-weight: normal;
1067 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1072 <img src="$logo" alt="Catalyst Logo" />
1074 <p>Welcome to the world of Catalyst.
1075 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1076 framework will make web development something you had
1077 never expected it to be: Fun, rewarding, and quick.</p>
1078 <h2>What to do now?</h2>
1079 <p>That really depends on what <b>you</b> want to do.
1080 We do, however, provide you with a few starting points.</p>
1081 <p>If you want to jump right into web development with Catalyst
1082 you might want want to start with a tutorial.</p>
1083 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1085 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1087 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1088 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1090 <h2>What to do next?</h2>
1091 <p>Next it's time to write an actual application. Use the
1092 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1093 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1094 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1095 they can save you a lot of work.</p>
1096 <pre><code>script/${prefix}_create.pl -help</code></pre>
1097 <p>Also, be sure to check out the vast and growing
1098 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1099 you are likely to find what you need there.
1103 <p>Catalyst has a very active community. Here are the main places to
1104 get in touch with us.</p>
1107 <a href="http://dev.catalyst.perl.org">Wiki</a>
1110 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1113 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1116 <h2>In conclusion</h2>
1117 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1118 as we enjoyed making it. Please contact us if you have ideas
1119 for improvement or other feedback.</p>
1127 =head1 INTERNAL METHODS
1129 These methods are not meant to be used by end users.
1131 =head2 $c->components
1133 Returns a hash of components.
1135 =head2 $c->context_class
1137 Returns or sets the context class.
1141 Returns a hashref containing coderefs and execution counts (needed for
1142 deep recursion detection).
1146 Returns the number of actions on the current internal execution stack.
1150 Dispatches a request to actions.
1154 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1156 =head2 $c->dispatcher_class
1158 Returns or sets the dispatcher class.
1160 =head2 $c->dump_these
1162 Returns a list of 2-element array references (name, structure) pairs
1163 that will be dumped on the error page in debug mode.
1169 [ Request => $c->req ],
1170 [ Response => $c->res ],
1171 [ Stash => $c->stash ],
1172 [ Config => $c->config ];
1175 =head2 $c->engine_class
1177 Returns or sets the engine class.
1179 =head2 $c->execute( $class, $coderef )
1181 Execute a coderef in given class and catch exceptions. Errors are available
1187 my ( $c, $class, $code ) = @_;
1188 $class = $c->component($class) || $class;
1191 if ( $c->depth >= $RECURSION ) {
1192 my $action = "$code";
1193 $action = "/$action" unless $action =~ /->/;
1194 my $error = qq/Deep recursion detected calling "$action"/;
1195 $c->log->error($error);
1201 my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
1203 push( @{ $c->stack }, $code );
1205 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1207 $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
1209 my $last = pop( @{ $c->stack } );
1211 if ( my $error = $@ ) {
1212 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1214 unless ( ref $error ) {
1215 no warnings 'uninitialized';
1217 my $class = $last->class;
1218 my $name = $last->name;
1219 $error = qq/Caught exception in $class->$name "$error"/;
1228 sub _stats_start_execute {
1229 my ( $c, $code ) = @_;
1231 return if ( ( $code->name =~ /^_.*/ )
1232 && ( !$c->config->{show_internal_actions} ) );
1234 $c->counter->{"$code"}++;
1236 my $action = "$code";
1237 $action = "/$action" unless $action =~ /->/;
1239 # determine if the call was the result of a forward
1240 # this is done by walking up the call stack and looking for a calling
1241 # sub of Catalyst::forward before the eval
1243 for my $index ( 2 .. 11 ) {
1245 if ( ( caller($index) )[0] eq 'Catalyst'
1246 && ( caller($index) )[3] eq '(eval)' );
1248 if ( ( caller($index) )[3] =~ /forward$/ ) {
1249 $callsub = ( caller($index) )[3];
1250 $action = "-> $action";
1255 my $node = Tree::Simple->new(
1258 elapsed => undef, # to be filled in later
1262 $node->setUID( "$code" . $c->counter->{"$code"} );
1264 # is this a root-level call or a forwarded call?
1265 if ( $callsub =~ /forward$/ ) {
1267 # forward, locate the caller
1268 if ( my $parent = $c->stack->[-1] ) {
1269 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1270 $visitor->searchForUID(
1271 "$parent" . $c->counter->{"$parent"} );
1272 $c->stats->accept($visitor);
1273 if ( my $result = $visitor->getResult ) {
1274 $result->addChild($node);
1279 # forward with no caller may come from a plugin
1280 $c->stats->addChild($node);
1286 $c->stats->addChild($node);
1290 start => [gettimeofday],
1295 sub _stats_finish_execute {
1296 my ( $c, $info ) = @_;
1297 my $elapsed = tv_interval $info->{start};
1298 my $value = $info->{node}->getNodeValue;
1299 $value->{elapsed} = sprintf( '%fs', $elapsed );
1302 =head2 $c->_localize_fields( sub { }, \%keys );
1306 sub _localize_fields {
1307 my ( $c, $localized, $code ) = ( @_ );
1309 my $request = delete $localized->{request} || {};
1310 my $response = delete $localized->{response} || {};
1312 local @{ $c }{ keys %$localized } = values %$localized;
1313 local @{ $c->request }{ keys %$request } = values %$request;
1314 local @{ $c->response }{ keys %$response } = values %$response;
1321 Finalizes the request.
1328 for my $error ( @{ $c->error } ) {
1329 $c->log->error($error);
1332 # Allow engine to handle finalize flow (for POE)
1333 if ( $c->engine->can('finalize') ) {
1334 $c->engine->finalize($c);
1338 $c->finalize_uploads;
1341 if ( $#{ $c->error } >= 0 ) {
1345 $c->finalize_headers;
1348 if ( $c->request->method eq 'HEAD' ) {
1349 $c->response->body('');
1356 my $elapsed = sprintf '%f', tv_interval($c->stats->getNodeValue);
1357 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1359 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1360 $c->stats->traverse(
1363 my $stat = $action->getNodeValue;
1364 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1365 $stat->{elapsed} || '??' );
1370 "Request took ${elapsed}s ($av/s)\n" . $t->draw . "\n" );
1373 return $c->response->status;
1376 =head2 $c->finalize_body
1382 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1384 =head2 $c->finalize_cookies
1390 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1392 =head2 $c->finalize_error
1398 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1400 =head2 $c->finalize_headers
1406 sub finalize_headers {
1409 # Check if we already finalized headers
1410 return if $c->response->{_finalized_headers};
1413 if ( my $location = $c->response->redirect ) {
1414 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1415 $c->response->header( Location => $location );
1417 if ( !$c->response->body ) {
1418 # Add a default body if none is already present
1420 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1426 if ( $c->response->body && !$c->response->content_length ) {
1428 # get the length from a filehandle
1429 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1431 my $stat = stat $c->response->body;
1432 if ( $stat && $stat->size > 0 ) {
1433 $c->response->content_length( $stat->size );
1436 $c->log->warn('Serving filehandle without a content-length');
1440 $c->response->content_length( bytes::length( $c->response->body ) );
1445 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1446 $c->response->headers->remove_header("Content-Length");
1447 $c->response->body('');
1450 $c->finalize_cookies;
1452 $c->engine->finalize_headers( $c, @_ );
1455 $c->response->{_finalized_headers} = 1;
1458 =head2 $c->finalize_output
1460 An alias for finalize_body.
1462 =head2 $c->finalize_read
1464 Finalizes the input after reading is complete.
1468 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1470 =head2 $c->finalize_uploads
1472 Finalizes uploads. Cleans up any temporary files.
1476 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1478 =head2 $c->get_action( $action, $namespace )
1480 Gets an action in a given namespace.
1484 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1486 =head2 $c->get_actions( $action, $namespace )
1488 Gets all actions of a given name in a namespace and all parent
1493 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1495 =head2 $c->handle_request( $class, @arguments )
1497 Called to handle each HTTP request.
1501 sub handle_request {
1502 my ( $class, @arguments ) = @_;
1504 # Always expect worst case!
1507 if ($class->debug) {
1508 my $secs = time - $START || 1;
1509 my $av = sprintf '%.3f', $COUNT / $secs;
1510 my $time = localtime time;
1511 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1514 my $c = $class->prepare(@arguments);
1516 $status = $c->finalize;
1519 if ( my $error = $@ ) {
1521 $class->log->error(qq/Caught exception in engine "$error"/);
1525 $class->log->_flush() if $class->log->can('_flush');
1529 =head2 $c->prepare( @arguments )
1531 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1537 my ( $class, @arguments ) = @_;
1539 $class->context_class( ref $class || $class ) unless $class->context_class;
1540 my $c = $class->context_class->new(
1544 request => $class->request_class->new(
1547 body_parameters => {},
1549 headers => HTTP::Headers->new,
1551 query_parameters => {},
1557 response => $class->response_class->new(
1561 headers => HTTP::Headers->new(),
1571 $c->stats(Tree::Simple->new([gettimeofday]));
1572 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1575 # For on-demand data
1576 $c->request->{_context} = $c;
1577 $c->response->{_context} = $c;
1578 weaken( $c->request->{_context} );
1579 weaken( $c->response->{_context} );
1581 # Allow engine to direct the prepare flow (for POE)
1582 if ( $c->engine->can('prepare') ) {
1583 $c->engine->prepare( $c, @arguments );
1586 $c->prepare_request(@arguments);
1587 $c->prepare_connection;
1588 $c->prepare_query_parameters;
1589 $c->prepare_headers;
1590 $c->prepare_cookies;
1593 # Prepare the body for reading, either by prepare_body
1594 # or the user, if they are using $c->read
1597 # Parse the body unless the user wants it on-demand
1598 unless ( $c->config->{parse_on_demand} ) {
1603 my $method = $c->req->method || '';
1604 my $path = $c->req->path || '/';
1605 my $address = $c->req->address || '';
1607 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1615 =head2 $c->prepare_action
1617 Prepares action. See L<Catalyst::Dispatcher>.
1621 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1623 =head2 $c->prepare_body
1625 Prepares message body.
1632 # Do we run for the first time?
1633 return if defined $c->request->{_body};
1635 # Initialize on-demand data
1636 $c->engine->prepare_body( $c, @_ );
1637 $c->prepare_parameters;
1638 $c->prepare_uploads;
1640 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1641 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1642 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1643 my $param = $c->req->body_parameters->{$key};
1644 my $value = defined($param) ? $param : '';
1646 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1648 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1652 =head2 $c->prepare_body_chunk( $chunk )
1654 Prepares a chunk of data before sending it to L<HTTP::Body>.
1656 See L<Catalyst::Engine>.
1660 sub prepare_body_chunk {
1662 $c->engine->prepare_body_chunk( $c, @_ );
1665 =head2 $c->prepare_body_parameters
1667 Prepares body parameters.
1671 sub prepare_body_parameters {
1673 $c->engine->prepare_body_parameters( $c, @_ );
1676 =head2 $c->prepare_connection
1678 Prepares connection.
1682 sub prepare_connection {
1684 $c->engine->prepare_connection( $c, @_ );
1687 =head2 $c->prepare_cookies
1693 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1695 =head2 $c->prepare_headers
1701 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1703 =head2 $c->prepare_parameters
1705 Prepares parameters.
1709 sub prepare_parameters {
1711 $c->prepare_body_parameters;
1712 $c->engine->prepare_parameters( $c, @_ );
1715 =head2 $c->prepare_path
1717 Prepares path and base.
1721 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1723 =head2 $c->prepare_query_parameters
1725 Prepares query parameters.
1729 sub prepare_query_parameters {
1732 $c->engine->prepare_query_parameters( $c, @_ );
1734 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1735 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1736 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1737 my $param = $c->req->query_parameters->{$key};
1738 my $value = defined($param) ? $param : '';
1740 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1742 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1746 =head2 $c->prepare_read
1748 Prepares the input for reading.
1752 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1754 =head2 $c->prepare_request
1756 Prepares the engine request.
1760 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1762 =head2 $c->prepare_uploads
1768 sub prepare_uploads {
1771 $c->engine->prepare_uploads( $c, @_ );
1773 if ( $c->debug && keys %{ $c->request->uploads } ) {
1774 my $t = Text::SimpleTable->new(
1775 [ 12, 'Parameter' ],
1780 for my $key ( sort keys %{ $c->request->uploads } ) {
1781 my $upload = $c->request->uploads->{$key};
1782 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1783 $t->row( $key, $u->filename, $u->type, $u->size );
1786 $c->log->debug( "File Uploads are:\n" . $t->draw );
1790 =head2 $c->prepare_write
1792 Prepares the output for writing.
1796 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1798 =head2 $c->request_class
1800 Returns or sets the request class.
1802 =head2 $c->response_class
1804 Returns or sets the response class.
1806 =head2 $c->read( [$maxlength] )
1808 Reads a chunk of data from the request body. This method is designed to
1809 be used in a while loop, reading C<$maxlength> bytes on every call.
1810 C<$maxlength> defaults to the size of the request if not specified.
1812 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1815 Warning: If you use read(), Catalyst will not process the body,
1816 so you will not be able to access POST parameters or file uploads via
1817 $c->request. You must handle all body parsing yourself.
1821 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1829 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1831 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1833 Sets an action in a given namespace.
1837 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1839 =head2 $c->setup_actions($component)
1841 Sets up actions for a component.
1845 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1847 =head2 $c->setup_components
1849 Sets up components. Specify a C<setup_components> config option to pass
1850 additional options directly to L<Module::Pluggable>. To add additional
1851 search paths, specify a key named C<search_extra> as an array
1852 reference. Items in the array beginning with C<::> will have the
1853 application class name prepended to them.
1857 sub setup_components {
1860 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1861 my $config = $class->config->{ setup_components };
1862 my $extra = delete $config->{ search_extra } || [];
1864 push @paths, @$extra;
1866 my $locator = Module::Pluggable::Object->new(
1867 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1872 my @comps = sort { length $a <=> length $b } $locator->plugins;
1873 my %comps = map { $_ => 1 } @comps;
1875 for my $component ( @comps ) {
1877 # We pass ignore_loaded here so that overlay files for (e.g.)
1878 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1879 # we know M::P::O found a file on disk so this is safe
1881 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1883 my $module = $class->setup_component( $component );
1885 $component => $module,
1887 $_ => $class->setup_component( $_ )
1889 not exists $comps{$_}
1890 } Devel::InnerPackage::list_packages( $component )
1893 for my $key ( keys %modules ) {
1894 $class->components->{ $key } = $modules{ $key };
1899 =head2 $c->setup_component
1903 sub setup_component {
1904 my( $class, $component ) = @_;
1906 unless ( $component->can( 'COMPONENT' ) ) {
1910 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1911 my $config = $class->config->{ $suffix } || {};
1913 my $instance = eval { $component->COMPONENT( $class, $config ); };
1915 if ( my $error = $@ ) {
1917 Catalyst::Exception->throw(
1918 message => qq/Couldn't instantiate component "$component", "$error"/
1922 Catalyst::Exception->throw(
1924 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1925 ) unless eval { $instance->can( 'can' ) };
1930 =head2 $c->setup_dispatcher
1936 sub setup_dispatcher {
1937 my ( $class, $dispatcher ) = @_;
1940 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1943 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1944 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1947 unless ($dispatcher) {
1948 $dispatcher = $class->dispatcher_class;
1951 unless (Class::Inspector->loaded($dispatcher)) {
1952 require Class::Inspector->filename($dispatcher);
1955 # dispatcher instance
1956 $class->dispatcher( $dispatcher->new );
1959 =head2 $c->setup_engine
1966 my ( $class, $engine ) = @_;
1969 $engine = 'Catalyst::Engine::' . $engine;
1972 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
1973 $engine = 'Catalyst::Engine::' . $env;
1976 if ( $ENV{MOD_PERL} ) {
1978 # create the apache method
1981 *{"$class\::apache"} = sub { shift->engine->apache };
1984 my ( $software, $version ) =
1985 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1988 $version =~ s/(\.[^.]+)\./$1/g;
1990 if ( $software eq 'mod_perl' ) {
1994 if ( $version >= 1.99922 ) {
1995 $engine = 'Catalyst::Engine::Apache2::MP20';
1998 elsif ( $version >= 1.9901 ) {
1999 $engine = 'Catalyst::Engine::Apache2::MP19';
2002 elsif ( $version >= 1.24 ) {
2003 $engine = 'Catalyst::Engine::Apache::MP13';
2007 Catalyst::Exception->throw( message =>
2008 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2013 # install the correct mod_perl handler
2014 if ( $version >= 1.9901 ) {
2015 *handler = sub : method {
2016 shift->handle_request(@_);
2020 *handler = sub ($$) { shift->handle_request(@_) };
2025 elsif ( $software eq 'Zeus-Perl' ) {
2026 $engine = 'Catalyst::Engine::Zeus';
2030 Catalyst::Exception->throw(
2031 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2036 $engine = $class->engine_class;
2039 unless (Class::Inspector->loaded($engine)) {
2040 require Class::Inspector->filename($engine);
2043 # check for old engines that are no longer compatible
2045 if ( $engine->isa('Catalyst::Engine::Apache')
2046 && !Catalyst::Engine::Apache->VERSION )
2051 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2052 && Catalyst::Engine::Server->VERSION le '0.02' )
2057 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2058 && $engine->VERSION eq '0.01' )
2063 elsif ($engine->isa('Catalyst::Engine::Zeus')
2064 && $engine->VERSION eq '0.01' )
2070 Catalyst::Exception->throw( message =>
2071 qq/Engine "$engine" is not supported by this version of Catalyst/
2076 $class->engine( $engine->new );
2079 =head2 $c->setup_home
2081 Sets up the home directory.
2086 my ( $class, $home ) = @_;
2088 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2093 $home = Catalyst::Utils::home($class);
2097 $class->config->{home} ||= $home;
2098 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2102 =head2 $c->setup_log
2109 my ( $class, $debug ) = @_;
2111 unless ( $class->log ) {
2112 $class->log( Catalyst::Log->new );
2115 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2116 if ( defined($env_debug) ? $env_debug : $debug ) {
2118 *{"$class\::debug"} = sub { 1 };
2119 $class->log->debug('Debug messages enabled');
2123 =head2 $c->setup_plugins
2129 =head2 $c->registered_plugins
2131 Returns a sorted list of the plugins which have either been stated in the
2132 import list or which have been added via C<< MyApp->plugin(@args); >>.
2134 If passed a given plugin name, it will report a boolean value indicating
2135 whether or not that plugin is loaded. A fully qualified name is required if
2136 the plugin name does not begin with C<Catalyst::Plugin::>.
2138 if ($c->registered_plugins('Some::Plugin')) {
2146 sub registered_plugins {
2148 return sort keys %{ $proto->_plugins } unless @_;
2150 return 1 if exists $proto->_plugins->{$plugin};
2151 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2154 sub _register_plugin {
2155 my ( $proto, $plugin, $instant ) = @_;
2156 my $class = ref $proto || $proto;
2158 # no ignore_loaded here, the plugin may already have been
2159 # defined in memory and we don't want to error on "no file" if so
2161 Catalyst::Utils::ensure_class_loaded( $plugin );
2163 $proto->_plugins->{$plugin} = 1;
2166 unshift @{"$class\::ISA"}, $plugin;
2172 my ( $class, $plugins ) = @_;
2174 $class->_plugins( {} ) unless $class->_plugins;
2176 for my $plugin ( reverse @$plugins ) {
2178 unless ( $plugin =~ s/\A\+// ) {
2179 $plugin = "Catalyst::Plugin::$plugin";
2182 $class->_register_plugin($plugin);
2189 Returns an arrayref of the internal execution stack (actions that are
2190 currently executing).
2192 =head2 $c->write( $data )
2194 Writes $data to the output stream. When using this method directly, you
2195 will need to manually set the C<Content-Length> header to the length of
2196 your output data, if known.
2203 # Finalize headers if someone manually writes output
2204 $c->finalize_headers;
2206 return $c->engine->write( $c, @_ );
2211 Returns the Catalyst version number. Mostly useful for "powered by"
2212 messages in template systems.
2216 sub version { return $Catalyst::VERSION }
2218 =head1 INTERNAL ACTIONS
2220 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2221 C<_ACTION>, and C<_END>. These are by default not shown in the private
2222 action table, but you can make them visible with a config parameter.
2224 MyApp->config->{show_internal_actions} = 1;
2226 =head1 CASE SENSITIVITY
2228 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2229 mapped to C</foo/bar>. You can activate case sensitivity with a config
2232 MyApp->config->{case_sensitive} = 1;
2234 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2236 =head1 ON-DEMAND PARSER
2238 The request body is usually parsed at the beginning of a request,
2239 but if you want to handle input yourself, you can enable on-demand
2240 parsing with a config parameter.
2242 MyApp->config->{parse_on_demand} = 1;
2244 =head1 PROXY SUPPORT
2246 Many production servers operate using the common double-server approach,
2247 with a lightweight frontend web server passing requests to a larger
2248 backend server. An application running on the backend server must deal
2249 with two problems: the remote user always appears to be C<127.0.0.1> and
2250 the server's hostname will appear to be C<localhost> regardless of the
2251 virtual host that the user connected through.
2253 Catalyst will automatically detect this situation when you are running
2254 the frontend and backend servers on the same machine. The following
2255 changes are made to the request.
2257 $c->req->address is set to the user's real IP address, as read from
2258 the HTTP X-Forwarded-For header.
2260 The host value for $c->req->base and $c->req->uri is set to the real
2261 host, as read from the HTTP X-Forwarded-Host header.
2263 Obviously, your web server must support these headers for this to work.
2265 In a more complex server farm environment where you may have your
2266 frontend proxy server(s) on different machines, you will need to set a
2267 configuration option to tell Catalyst to read the proxied data from the
2270 MyApp->config->{using_frontend_proxy} = 1;
2272 If you do not wish to use the proxy support at all, you may set:
2274 MyApp->config->{ignore_frontend_proxy} = 1;
2276 =head1 THREAD SAFETY
2278 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2279 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2280 believe the Catalyst core to be thread-safe.
2282 If you plan to operate in a threaded environment, remember that all other
2283 modules you are using must also be thread-safe. Some modules, most notably
2284 L<DBD::SQLite>, are not thread-safe.
2290 Join #catalyst on irc.perl.org.
2294 http://lists.rawmode.org/mailman/listinfo/catalyst
2295 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2299 http://catalyst.perl.org
2303 http://dev.catalyst.perl.org
2307 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2309 =head2 L<Catalyst::Manual> - The Catalyst Manual
2311 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2313 =head2 L<Catalyst::Engine> - Core engine
2315 =head2 L<Catalyst::Log> - Log class.
2317 =head2 L<Catalyst::Request> - Request object
2319 =head2 L<Catalyst::Response> - Response object
2321 =head2 L<Catalyst::Test> - The test suite.
2393 Sebastian Riedel, C<sri@oook.de>
2397 This library is free software, you can redistribute it and/or modify it under
2398 the same terms as Perl itself.