4 extends '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 has stack => (is => 'rw');
34 has stash => (is => 'rw');
35 has state => (is => 'rw');
36 has stats => (is => 'rw');
37 has action => (is => 'rw');
38 has counter => (is => 'rw');
39 has request => (is => 'rw');
40 has response => (is => 'rw');
41 has namespace => (is => 'rw');
44 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
46 sub depth { scalar @{ shift->stack || [] }; }
53 # For backwards compatibility
54 *finalize_output = \&finalize_body;
59 our $RECURSION = 1000;
60 our $DETACH = "catalyst_detach\n";
62 #I imagine that very few of these really need to be class variables. if any.
63 #maybe we should just make them attributes with a default?
64 __PACKAGE__->mk_classdata($_)
65 for qw/components arguments dispatcher engine log dispatcher_class
66 engine_class context_class request_class response_class stats_class
69 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
70 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
71 __PACKAGE__->request_class('Catalyst::Request');
72 __PACKAGE__->response_class('Catalyst::Response');
73 __PACKAGE__->stats_class('Catalyst::Stats');
75 # Remember to update this in Catalyst::Runtime as well!
77 our $VERSION = '5.7013';
80 my ( $class, @arguments ) = @_;
82 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
84 return unless $class eq 'Catalyst';
86 my $caller = caller(0);
88 #why does called have to ISA Catalyst and ISA Controller ?
89 #Convert test suite to not use the behavior where Myapp ISA Controller
90 # after that is done we can eliminate that little mess.
91 unless ( $caller->isa('Catalyst') ) {
93 if( $caller->can('meta') ){
94 my @superclasses = ($caller->meta->superclasses, $class, 'Catalyst::Controller');
95 #my @superclasses = ($caller->meta->superclasses, $class);
96 $caller->meta->superclasses(@superclasses);
98 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
99 #push @{"$caller\::ISA"}, $class;
103 $caller->arguments( [@arguments] );
109 Catalyst - The Elegant MVC Web Application Framework
113 See the L<Catalyst::Manual> distribution for comprehensive
114 documentation and tutorials.
116 # Install Catalyst::Devel for helpers and other development tools
117 # use the helper to create a new application
120 # add models, views, controllers
121 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
122 script/myapp_create.pl view MyTemplate TT
123 script/myapp_create.pl controller Search
125 # built in testserver -- use -r to restart automatically on changes
126 # --help to see all available options
127 script/myapp_server.pl
129 # command line testing interface
130 script/myapp_test.pl /yada
133 use Catalyst qw/-Debug/; # include plugins here as well
135 ### In lib/MyApp/Controller/Root.pm (autocreated)
136 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
137 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
138 $c->stash->{template} = 'foo.tt'; # set the template
139 # lookup something from db -- stash vars are passed to TT
141 $c->model('Database::Foo')->search( { country => $args[0] } );
142 if ( $c->req->params->{bar} ) { # access GET or POST parameters
143 $c->forward( 'bar' ); # process another action
144 # do something else after forward returns
148 # The foo.tt TT template can use the stash data from the database
149 [% WHILE (item = data.next) %]
153 # called for /bar/of/soap, /bar/of/soap/10, etc.
154 sub bar : Path('/bar/of/soap') { ... }
156 # called for all actions, from the top-most controller downwards
158 my ( $self, $c ) = @_;
159 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
160 $c->res->redirect( '/login' ); # require login
161 return 0; # abort request and go immediately to end()
163 return 1; # success; carry on to next action
166 # called after all actions are finished
168 my ( $self, $c ) = @_;
169 if ( scalar @{ $c->error } ) { ... } # handle errors
170 return if $c->res->body; # already have a response
171 $c->forward( 'MyApp::View::TT' ); # render template
174 ### in MyApp/Controller/Foo.pm
175 # called for /foo/bar
176 sub bar : Local { ... }
178 # called for /blargle
179 sub blargle : Global { ... }
181 # an index action matches /foo, but not /foo/1, etc.
182 sub index : Private { ... }
184 ### in MyApp/Controller/Foo/Bar.pm
185 # called for /foo/bar/baz
186 sub baz : Local { ... }
188 # first Root auto is called, then Foo auto, then this
189 sub auto : Private { ... }
191 # powerful regular expression paths are also possible
192 sub details : Regex('^product/(\w+)/details$') {
193 my ( $self, $c ) = @_;
194 # extract the (\w+) from the URI
195 my $product = $c->req->captures->[0];
198 See L<Catalyst::Manual::Intro> for additional information.
202 Catalyst is a modern framework for making web applications without the
203 pain usually associated with this process. This document is a reference
204 to the main Catalyst application. If you are a new user, we suggest you
205 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
207 See L<Catalyst::Manual> for more documentation.
209 Catalyst plugins can be loaded by naming them as arguments to the "use
210 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
211 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
214 use Catalyst qw/My::Module/;
216 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
217 fully qualify the name by using a unary plus:
221 +Fully::Qualified::Plugin::Name
224 Special flags like C<-Debug> and C<-Engine> can also be specified as
225 arguments when Catalyst is loaded:
227 use Catalyst qw/-Debug My::Module/;
229 The position of plugins and flags in the chain is important, because
230 they are loaded in the order in which they appear.
232 The following flags are supported:
236 Enables debug output. You can also force this setting from the system
237 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
238 settings override the application, with <MYAPP>_DEBUG having the highest
243 Forces Catalyst to use a specific engine. Omit the
244 C<Catalyst::Engine::> prefix of the engine name, i.e.:
246 use Catalyst qw/-Engine=CGI/;
250 Forces Catalyst to use a specific home directory, e.g.:
252 use Catalyst qw[-Home=/usr/mst];
254 This can also be done in the shell environment by setting either the
255 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
256 is replaced with the uppercased name of your application, any "::" in
257 the name will be replaced with underscores, e.g. MyApp::Web should use
258 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
266 Enables statistics collection and reporting. You can also force this setting
267 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
268 environment settings override the application, with <MYAPP>_STATS having the
273 use Catalyst qw/-Stats=1/
277 =head2 INFORMATION ABOUT THE CURRENT REQUEST
281 Returns a L<Catalyst::Action> object for the current action, which
282 stringifies to the action name. See L<Catalyst::Action>.
286 Returns the namespace of the current action, i.e., the URI prefix
287 corresponding to the controller of the current action. For example:
289 # in Controller::Foo::Bar
290 $c->namespace; # returns 'foo/bar';
296 Returns the current L<Catalyst::Request> object, giving access to
297 information about the current client request (including parameters,
298 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
300 =head2 REQUEST FLOW HANDLING
302 =head2 $c->forward( $action [, \@arguments ] )
304 =head2 $c->forward( $class, $method, [, \@arguments ] )
306 Forwards processing to another action, by its private name. If you give a
307 class name but no method, C<process()> is called. You may also optionally
308 pass arguments in an arrayref. The action will receive the arguments in
309 C<@_> and C<< $c->req->args >>. Upon returning from the function,
310 C<< $c->req->args >> will be restored to the previous values.
312 Any data C<return>ed from the action forwarded to, will be returned by the
315 my $foodata = $c->forward('/foo');
316 $c->forward('index');
317 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
318 $c->forward('MyApp::View::TT');
320 Note that forward implies an C<<eval { }>> around the call (actually
321 C<execute> does), thus de-fatalizing all 'dies' within the called
322 action. If you want C<die> to propagate you need to do something like:
325 die $c->error if $c->error;
327 Or make sure to always return true values from your actions and write
330 $c->forward('foo') || return;
334 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
336 =head2 $c->detach( $action [, \@arguments ] )
338 =head2 $c->detach( $class, $method, [, \@arguments ] )
342 The same as C<forward>, but doesn't return to the previous action when
343 processing is finished.
345 When called with no arguments it escapes the processing chain entirely.
349 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
355 Returns the current L<Catalyst::Response> object, see there for details.
359 Returns a hashref to the stash, which may be used to store data and pass
360 it between components during a request. You can also set hash keys by
361 passing arguments. The stash is automatically sent to the view. The
362 stash is cleared at the end of a request; it cannot be used for
363 persistent storage (for this you must use a session; see
364 L<Catalyst::Plugin::Session> for a complete system integrated with
367 $c->stash->{foo} = $bar;
368 $c->stash( { moose => 'majestic', qux => 0 } );
369 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
371 # stash is automatically passed to the view for use in a template
372 $c->forward( 'MyApp::View::TT' );
376 around stash => sub {
380 my $stash = @_ > 1 ? {@_} : $_[0];
381 croak('stash takes a hash or hashref') unless ref $stash;
382 foreach my $key ( keys %$stash ) {
383 $c->$orig()->{$key} = $stash->{$key};
391 =head2 $c->error($error, ...)
393 =head2 $c->error($arrayref)
395 Returns an arrayref containing error messages. If Catalyst encounters an
396 error while processing a request, it stores the error in $c->error. This
397 method should only be used to store fatal error messages.
399 my @error = @{ $c->error };
403 $c->error('Something bad happened');
410 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
411 croak @$error unless ref $c;
412 push @{ $c->{error} }, @$error;
414 elsif ( defined $_[0] ) { $c->{error} = undef }
415 return $c->{error} || [];
421 Contains the return value of the last executed action.
423 =head2 $c->clear_errors
425 Clear errors. You probably don't want to clear the errors unless you are
426 implementing a custom error screen.
428 This is equivalent to running
442 my ( $c, @names ) = @_;
444 foreach my $name (@names) {
445 foreach my $component ( keys %{ $c->components } ) {
446 return $c->components->{$component} if $component =~ /$name/i;
453 # try explicit component names
455 my ( $c, @names ) = @_;
457 foreach my $try (@names) {
458 return $c->components->{$try} if ( exists $c->components->{$try} );
464 # like component, but try just these prefixes before regex searching,
465 # and do not try to return "sort keys %{ $c->components }"
467 my ( $c, $name, @prefixes ) = @_;
469 my $appclass = ref $c || $c;
471 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
473 my $comp = $c->_comp_explicit(@names);
474 return $comp if defined($comp);
475 $comp = $c->_comp_search($name);
479 # Find possible names for a prefix
482 my ( $c, @prefixes ) = @_;
484 my $appclass = ref $c || $c;
486 my @pre = map { "${appclass}::${_}::" } @prefixes;
490 COMPONENT: foreach my $comp ($c->component) {
491 foreach my $p (@pre) {
492 if ($comp =~ s/^$p//) {
502 # Return a component if only one matches.
504 my ( $c, @prefixes ) = @_;
506 my $appclass = ref $c || $c;
508 my ( $comp, $rest ) =
509 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
510 return $comp unless $rest;
513 # Filter a component before returning by calling ACCEPT_CONTEXT if available
514 sub _filter_component {
515 my ( $c, $comp, @args ) = @_;
516 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
517 return $comp->ACCEPT_CONTEXT( $c, @args );
519 else { return $comp }
522 =head2 COMPONENT ACCESSORS
524 =head2 $c->controller($name)
526 Gets a L<Catalyst::Controller> instance by name.
528 $c->controller('Foo')->do_stuff;
530 If the name is omitted, will return the controller for the dispatched
536 my ( $c, $name, @args ) = @_;
537 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
540 return $c->component( $c->action->class );
543 =head2 $c->model($name)
545 Gets a L<Catalyst::Model> instance by name.
547 $c->model('Foo')->do_stuff;
549 Any extra arguments are directly passed to ACCEPT_CONTEXT.
551 If the name is omitted, it will look for
552 - a model object in $c->stash{current_model_instance}, then
553 - a model name in $c->stash->{current_model}, then
554 - a config setting 'default_model', or
555 - check if there is only one model, and return it if that's the case.
560 my ( $c, $name, @args ) = @_;
561 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
565 return $c->stash->{current_model_instance}
566 if $c->stash->{current_model_instance};
567 return $c->model( $c->stash->{current_model} )
568 if $c->stash->{current_model};
570 return $c->model( $c->config->{default_model} )
571 if $c->config->{default_model};
572 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
576 =head2 $c->controllers
578 Returns the available names which can be passed to $c->controller
584 return $c->_comp_names(qw/Controller C/);
588 =head2 $c->view($name)
590 Gets a L<Catalyst::View> instance by name.
592 $c->view('Foo')->do_stuff;
594 Any extra arguments are directly passed to ACCEPT_CONTEXT.
596 If the name is omitted, it will look for
597 - a view object in $c->stash{current_view_instance}, then
598 - a view name in $c->stash->{current_view}, then
599 - a config setting 'default_view', or
600 - check if there is only one view, and return it if that's the case.
605 my ( $c, $name, @args ) = @_;
606 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
610 return $c->stash->{current_view_instance}
611 if $c->stash->{current_view_instance};
612 return $c->view( $c->stash->{current_view} )
613 if $c->stash->{current_view};
615 return $c->view( $c->config->{default_view} )
616 if $c->config->{default_view};
617 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
622 Returns the available names which can be passed to $c->model
628 return $c->_comp_names(qw/Model M/);
634 Returns the available names which can be passed to $c->view
640 return $c->_comp_names(qw/View V/);
643 =head2 $c->comp($name)
645 =head2 $c->component($name)
647 Gets a component object by name. This method is not recommended,
648 unless you want to get a specific component by full
649 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
650 should be used instead.
661 my $appclass = ref $c || $c;
664 $name, "${appclass}::${name}",
665 map { "${appclass}::${_}::${name}" }
666 qw/Model M Controller C View V/
669 my $comp = $c->_comp_explicit(@names);
670 return $c->_filter_component( $comp, @_ ) if defined($comp);
672 $comp = $c->_comp_search($name);
673 return $c->_filter_component( $comp, @_ ) if defined($comp);
676 return sort keys %{ $c->components };
681 =head2 CLASS DATA AND HELPER CLASSES
685 Returns or takes a hashref containing the application's configuration.
687 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
689 You can also use a C<YAML>, C<XML> or C<Config::General> config file
690 like myapp.yml in your applications home directory. See
691 L<Catalyst::Plugin::ConfigLoader>.
694 db: dsn:SQLite:foo.db
699 around config => sub {
703 $c->log->warn("Setting config after setup has been run is not a good idea.")
704 if ( @_ and $c->setup_finished );
711 Returns the logging object instance. Unless it is already set, Catalyst
712 sets this up with a L<Catalyst::Log> object. To use your own log class,
713 set the logger with the C<< __PACKAGE__->log >> method prior to calling
714 C<< __PACKAGE__->setup >>.
716 __PACKAGE__->log( MyLogger->new );
721 $c->log->info( 'Now logging with my own logger!' );
723 Your log class should implement the methods described in
729 Overload to enable debug messages (same as -Debug option).
731 Note that this is a static method, not an accessor and should be overloaded
732 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
738 =head2 $c->dispatcher
740 Returns the dispatcher instance. Stringifies to class name. See
741 L<Catalyst::Dispatcher>.
745 Returns the engine instance. Stringifies to the class name. See
749 =head2 UTILITY METHODS
751 =head2 $c->path_to(@path)
753 Merges C<@path> with C<< $c->config->{home} >> and returns a
754 L<Path::Class::Dir> object.
758 $c->path_to( 'db', 'sqlite.db' );
763 my ( $c, @path ) = @_;
764 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
765 if ( -d $path ) { return $path }
766 else { return Path::Class::File->new( $c->config->{home}, @path ) }
769 =head2 $c->plugin( $name, $class, @args )
771 Helper method for plugins. It creates a classdata accessor/mutator and
772 loads and instantiates the given class.
774 MyApp->plugin( 'prototype', 'HTML::Prototype' );
776 $c->prototype->define_javascript_functions;
781 my ( $class, $name, $plugin, @args ) = @_;
782 $class->_register_plugin( $plugin, 1 );
784 eval { $plugin->import };
785 $class->mk_classdata($name);
787 eval { $obj = $plugin->new(@args) };
790 Catalyst::Exception->throw( message =>
791 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
795 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
801 Initializes the dispatcher and engine, loads any plugins, and loads the
802 model, view, and controller components. You may also specify an array
803 of plugins to load here, if you choose to not load them in the C<use
807 MyApp->setup( qw/-Debug/ );
812 my ( $class, @arguments ) = @_;
814 $class->log->warn("Running setup twice is not a good idea.")
815 if ( $class->setup_finished );
817 unless ( $class->isa('Catalyst') ) {
819 Catalyst::Exception->throw(
820 message => qq/'$class' does not inherit from Catalyst/ );
823 if ( $class->arguments ) {
824 @arguments = ( @arguments, @{ $class->arguments } );
830 foreach (@arguments) {
834 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
836 elsif (/^-(\w+)=?(.*)$/) {
837 $flags->{ lc $1 } = $2;
840 push @{ $flags->{plugins} }, $_;
844 $class->setup_home( delete $flags->{home} );
846 $class->setup_log( delete $flags->{log} );
847 $class->setup_plugins( delete $flags->{plugins} );
848 $class->setup_dispatcher( delete $flags->{dispatcher} );
849 $class->setup_engine( delete $flags->{engine} );
850 $class->setup_stats( delete $flags->{stats} );
852 for my $flag ( sort keys %{$flags} ) {
854 if ( my $code = $class->can( 'setup_' . $flag ) ) {
855 &$code( $class, delete $flags->{$flag} );
858 $class->log->warn(qq/Unknown flag "$flag"/);
862 eval { require Catalyst::Devel; };
863 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
864 $class->log->warn(<<"EOF");
865 You are running an old script!
867 Please update by running (this will overwrite existing files):
868 catalyst.pl -force -scripts $class
870 or (this will not overwrite existing files):
871 catalyst.pl -scripts $class
876 if ( $class->debug ) {
877 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
880 my $t = Text::SimpleTable->new(74);
881 $t->row($_) for @plugins;
882 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
885 my $dispatcher = $class->dispatcher;
886 my $engine = $class->engine;
887 my $home = $class->config->{home};
889 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
890 $class->log->debug(qq/Loaded engine "$engine"/);
894 ? $class->log->debug(qq/Found home "$home"/)
895 : $class->log->debug(qq/Home "$home" doesn't exist/)
896 : $class->log->debug(q/Couldn't find home/);
901 no warnings qw/redefine/;
902 local *setup = sub { };
906 # Initialize our data structure
907 $class->components( {} );
909 $class->setup_components;
911 if ( $class->debug ) {
912 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
913 for my $comp ( sort keys %{ $class->components } ) {
914 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
915 $t->row( $comp, $type );
917 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
918 if ( keys %{ $class->components } );
921 # Add our self to components, since we are also a component
922 $class->components->{$class} = $class;
924 $class->setup_actions;
926 if ( $class->debug ) {
927 my $name = $class->config->{name} || 'Application';
928 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
930 $class->log->_flush() if $class->log->can('_flush');
932 $class->setup_finished(1);
935 =head2 $c->uri_for( $path, @args?, \%query_values? )
937 Merges path with C<< $c->request->base >> for absolute URIs and with
938 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
939 object. If any args are passed, they are added at the end of the path.
940 If the last argument to C<uri_for> is a hash reference, it is assumed to
941 contain GET parameter key/value pairs, which will be appended to the URI
944 Note that uri_for is destructive to the passed hashref. Subsequent calls
945 with the same hashref may have unintended results.
947 Instead of C<$path>, you can also optionally pass a C<$action> object
948 which will be resolved to a path using
949 C<< $c->dispatcher->uri_for_action >>; if the first element of
950 C<@args> is an arrayref it is treated as a list of captures to be passed
951 to C<uri_for_action>.
956 my ( $c, $path, @args ) = @_;
958 if ( Scalar::Util::blessed($path) ) { # action object
959 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
962 $path = $c->dispatcher->uri_for_action($path, $captures);
963 return undef unless defined($path);
964 $path = '/' if $path eq '';
967 undef($path) if (defined $path && $path eq '');
970 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
972 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
973 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
975 unshift(@args, $path);
977 unless (defined $path && $path =~ s!^/!!) { # in-place strip
978 my $namespace = $c->namespace;
979 if (defined $path) { # cheesy hack to handle path '../foo'
980 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
982 unshift(@args, $namespace || '');
985 # join args with '/', or a blank string
986 my $args = join('/', grep { defined($_) } @args);
987 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
989 my $base = $c->req->base;
990 my $class = ref($base);
991 $base =~ s{(?<!/)$}{/};
995 if (my @keys = keys %$params) {
996 # somewhat lifted from URI::_query's query_form
997 $query = '?'.join('&', map {
998 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1001 my $val = $params->{$_};
1002 $val = '' unless defined $val;
1005 utf8::encode( $_ ) if utf8::is_utf8($_);
1006 # using the URI::Escape pattern here so utf8 chars survive
1007 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1009 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1013 my $res = bless(\"${base}${args}${query}", $class);
1017 =head2 $c->welcome_message
1019 Returns the Catalyst welcome HTML page.
1023 sub welcome_message {
1025 my $name = $c->config->{name};
1026 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1027 my $prefix = Catalyst::Utils::appprefix( ref $c );
1028 $c->response->content_type('text/html; charset=utf-8');
1030 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1031 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1032 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1034 <meta http-equiv="Content-Language" content="en" />
1035 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1036 <title>$name on Catalyst $VERSION</title>
1037 <style type="text/css">
1040 background-color: #eee;
1047 margin-bottom: 10px;
1049 background-color: #ccc;
1050 border: 1px solid #aaa;
1055 font-family: verdana, tahoma, sans-serif;
1058 font-family: verdana, tahoma, sans-serif;
1061 text-decoration: none;
1063 border-bottom: 1px dotted #bbb;
1065 :link:hover, :visited:hover {
1078 background-color: #fff;
1079 border: 1px solid #aaa;
1083 font-weight: normal;
1105 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1110 <img src="$logo" alt="Catalyst Logo" />
1112 <p>Welcome to the world of Catalyst.
1113 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1114 framework will make web development something you had
1115 never expected it to be: Fun, rewarding, and quick.</p>
1116 <h2>What to do now?</h2>
1117 <p>That really depends on what <b>you</b> want to do.
1118 We do, however, provide you with a few starting points.</p>
1119 <p>If you want to jump right into web development with Catalyst
1120 you might want want to start with a tutorial.</p>
1121 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1123 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1125 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1126 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1128 <h2>What to do next?</h2>
1129 <p>Next it's time to write an actual application. Use the
1130 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1131 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1132 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1133 they can save you a lot of work.</p>
1134 <pre><code>script/${prefix}_create.pl -help</code></pre>
1135 <p>Also, be sure to check out the vast and growing
1136 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1137 you are likely to find what you need there.
1141 <p>Catalyst has a very active community. Here are the main places to
1142 get in touch with us.</p>
1145 <a href="http://dev.catalyst.perl.org">Wiki</a>
1148 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1151 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1154 <h2>In conclusion</h2>
1155 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1156 as we enjoyed making it. Please contact us if you have ideas
1157 for improvement or other feedback.</p>
1165 =head1 INTERNAL METHODS
1167 These methods are not meant to be used by end users.
1169 =head2 $c->components
1171 Returns a hash of components.
1173 =head2 $c->context_class
1175 Returns or sets the context class.
1179 Returns a hashref containing coderefs and execution counts (needed for
1180 deep recursion detection).
1184 Returns the number of actions on the current internal execution stack.
1188 Dispatches a request to actions.
1192 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1194 =head2 $c->dispatcher_class
1196 Returns or sets the dispatcher class.
1198 =head2 $c->dump_these
1200 Returns a list of 2-element array references (name, structure) pairs
1201 that will be dumped on the error page in debug mode.
1207 [ Request => $c->req ],
1208 [ Response => $c->res ],
1209 [ Stash => $c->stash ],
1210 [ Config => $c->config ];
1213 =head2 $c->engine_class
1215 Returns or sets the engine class.
1217 =head2 $c->execute( $class, $coderef )
1219 Execute a coderef in given class and catch exceptions. Errors are available
1225 my ( $c, $class, $code ) = @_;
1226 $class = $c->component($class) || $class;
1229 if ( $c->depth >= $RECURSION ) {
1230 my $action = "$code";
1231 $action = "/$action" unless $action =~ /->/;
1232 my $error = qq/Deep recursion detected calling "$action"/;
1233 $c->log->error($error);
1239 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1241 push( @{ $c->stack }, $code );
1243 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1245 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1247 my $last = pop( @{ $c->stack } );
1249 if ( my $error = $@ ) {
1250 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1252 unless ( ref $error ) {
1253 no warnings 'uninitialized';
1255 my $class = $last->class;
1256 my $name = $last->name;
1257 $error = qq/Caught exception in $class->$name "$error"/;
1266 sub _stats_start_execute {
1267 my ( $c, $code ) = @_;
1269 return if ( ( $code->name =~ /^_.*/ )
1270 && ( !$c->config->{show_internal_actions} ) );
1272 $c->counter->{"$code"}++;
1274 my $action = "$code";
1275 $action = "/$action" unless $action =~ /->/;
1277 # determine if the call was the result of a forward
1278 # this is done by walking up the call stack and looking for a calling
1279 # sub of Catalyst::forward before the eval
1281 for my $index ( 2 .. 11 ) {
1283 if ( ( caller($index) )[0] eq 'Catalyst'
1284 && ( caller($index) )[3] eq '(eval)' );
1286 if ( ( caller($index) )[3] =~ /forward$/ ) {
1287 $callsub = ( caller($index) )[3];
1288 $action = "-> $action";
1293 my $uid = "$code" . $c->counter->{"$code"};
1295 # is this a root-level call or a forwarded call?
1296 if ( $callsub =~ /forward$/ ) {
1298 # forward, locate the caller
1299 if ( my $parent = $c->stack->[-1] ) {
1302 parent => "$parent" . $c->counter->{"$parent"},
1308 # forward with no caller may come from a plugin
1327 sub _stats_finish_execute {
1328 my ( $c, $info ) = @_;
1329 $c->stats->profile( end => $info );
1332 =head2 $c->_localize_fields( sub { }, \%keys );
1336 #Why does this exist? This is no longer safe and WILL NOT WORK.
1337 # it doesnt seem to be used anywhere. can we remove it?
1338 sub _localize_fields {
1339 my ( $c, $localized, $code ) = ( @_ );
1341 my $request = delete $localized->{request} || {};
1342 my $response = delete $localized->{response} || {};
1344 local @{ $c }{ keys %$localized } = values %$localized;
1345 local @{ $c->request }{ keys %$request } = values %$request;
1346 local @{ $c->response }{ keys %$response } = values %$response;
1353 Finalizes the request.
1360 for my $error ( @{ $c->error } ) {
1361 $c->log->error($error);
1364 # Allow engine to handle finalize flow (for POE)
1365 my $engine = $c->engine;
1366 if ( my $code = $engine->can('finalize') ) {
1371 $c->finalize_uploads;
1374 if ( $#{ $c->error } >= 0 ) {
1378 $c->finalize_headers;
1381 if ( $c->request->method eq 'HEAD' ) {
1382 $c->response->body('');
1388 if ($c->use_stats) {
1389 my $elapsed = sprintf '%f', $c->stats->elapsed;
1390 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1392 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1395 return $c->response->status;
1398 =head2 $c->finalize_body
1404 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1406 =head2 $c->finalize_cookies
1412 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1414 =head2 $c->finalize_error
1420 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1422 =head2 $c->finalize_headers
1428 sub finalize_headers {
1431 my $response = $c->response; #accessor calls can add up?
1433 # Moose TODO: Maybe this should be an attribute too?
1434 # Check if we already finalized headers
1435 return if $response->{_finalized_headers};
1438 if ( my $location = $response->redirect ) {
1439 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1440 $response->header( Location => $location );
1442 #Moose TODO: we should probably be using a predicate method here ?
1443 if ( !$response->body ) {
1444 # Add a default body if none is already present
1446 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1452 if ( $response->body && !$response->content_length ) {
1454 # get the length from a filehandle
1455 if ( blessed( $response->body ) && $response->body->can('read') )
1457 my $stat = stat $response->body;
1458 if ( $stat && $stat->size > 0 ) {
1459 $response->content_length( $stat->size );
1462 $c->log->warn('Serving filehandle without a content-length');
1466 # everything should be bytes at this point, but just in case
1467 $response->content_length( bytes::length( $response->body ) );
1472 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1473 $response->headers->remove_header("Content-Length");
1474 $response->body('');
1477 $c->finalize_cookies;
1479 $c->engine->finalize_headers( $c, @_ );
1482 $response->{_finalized_headers} = 1;
1485 =head2 $c->finalize_output
1487 An alias for finalize_body.
1489 =head2 $c->finalize_read
1491 Finalizes the input after reading is complete.
1495 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1497 =head2 $c->finalize_uploads
1499 Finalizes uploads. Cleans up any temporary files.
1503 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1505 =head2 $c->get_action( $action, $namespace )
1507 Gets an action in a given namespace.
1511 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1513 =head2 $c->get_actions( $action, $namespace )
1515 Gets all actions of a given name in a namespace and all parent
1520 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1522 =head2 $c->handle_request( $class, @arguments )
1524 Called to handle each HTTP request.
1528 sub handle_request {
1529 my ( $class, @arguments ) = @_;
1531 # Always expect worst case!
1534 if ($class->debug) {
1535 my $secs = time - $START || 1;
1536 my $av = sprintf '%.3f', $COUNT / $secs;
1537 my $time = localtime time;
1538 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1541 my $c = $class->prepare(@arguments);
1543 $status = $c->finalize;
1546 if ( my $error = $@ ) {
1548 $class->log->error(qq/Caught exception in engine "$error"/);
1552 #todo: reuse coderef from can
1553 $class->log->_flush() if $class->log->can('_flush');
1557 =head2 $c->prepare( @arguments )
1559 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1565 my ( $class, @arguments ) = @_;
1567 #moose todo: context_class as attr with default
1568 $class->context_class( ref $class || $class ) unless $class->context_class;
1569 #Moose TODO: if we make empty containers the defaults then that can be
1570 #handled by the context class itself instead of having this here
1571 my $c = $class->context_class->new(
1575 request => $class->request_class->new(
1578 body_parameters => {},
1580 headers => HTTP::Headers->new,
1582 query_parameters => {},
1588 response => $class->response_class->new(
1592 headers => HTTP::Headers->new(),
1601 #surely this is not the most efficient way to do things...
1602 $c->stats($class->stats_class->new)->enable($c->use_stats);
1604 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1607 # For on-demand data
1608 $c->request->_context($c);
1609 $c->response->_context($c);
1611 #XXX reuse coderef from can
1612 # Allow engine to direct the prepare flow (for POE)
1613 if ( $c->engine->can('prepare') ) {
1614 $c->engine->prepare( $c, @arguments );
1617 $c->prepare_request(@arguments);
1618 $c->prepare_connection;
1619 $c->prepare_query_parameters;
1620 $c->prepare_headers;
1621 $c->prepare_cookies;
1624 # Prepare the body for reading, either by prepare_body
1625 # or the user, if they are using $c->read
1628 # Parse the body unless the user wants it on-demand
1629 unless ( $c->config->{parse_on_demand} ) {
1634 my $method = $c->req->method || '';
1635 my $path = $c->req->path || '/';
1636 my $address = $c->req->address || '';
1638 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1646 =head2 $c->prepare_action
1648 Prepares action. See L<Catalyst::Dispatcher>.
1652 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1654 =head2 $c->prepare_body
1656 Prepares message body.
1663 #Moose TODO: what is _body ??
1664 # Do we run for the first time?
1665 return if defined $c->request->{_body};
1667 # Initialize on-demand data
1668 $c->engine->prepare_body( $c, @_ );
1669 $c->prepare_parameters;
1670 $c->prepare_uploads;
1672 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1673 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1674 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1675 my $param = $c->req->body_parameters->{$key};
1676 my $value = defined($param) ? $param : '';
1678 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1680 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1684 =head2 $c->prepare_body_chunk( $chunk )
1686 Prepares a chunk of data before sending it to L<HTTP::Body>.
1688 See L<Catalyst::Engine>.
1692 sub prepare_body_chunk {
1694 $c->engine->prepare_body_chunk( $c, @_ );
1697 =head2 $c->prepare_body_parameters
1699 Prepares body parameters.
1703 sub prepare_body_parameters {
1705 $c->engine->prepare_body_parameters( $c, @_ );
1708 =head2 $c->prepare_connection
1710 Prepares connection.
1714 sub prepare_connection {
1716 $c->engine->prepare_connection( $c, @_ );
1719 =head2 $c->prepare_cookies
1725 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1727 =head2 $c->prepare_headers
1733 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1735 =head2 $c->prepare_parameters
1737 Prepares parameters.
1741 sub prepare_parameters {
1743 $c->prepare_body_parameters;
1744 $c->engine->prepare_parameters( $c, @_ );
1747 =head2 $c->prepare_path
1749 Prepares path and base.
1753 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1755 =head2 $c->prepare_query_parameters
1757 Prepares query parameters.
1761 sub prepare_query_parameters {
1764 $c->engine->prepare_query_parameters( $c, @_ );
1766 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1767 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1768 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1769 my $param = $c->req->query_parameters->{$key};
1770 my $value = defined($param) ? $param : '';
1772 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1774 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1778 =head2 $c->prepare_read
1780 Prepares the input for reading.
1784 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1786 =head2 $c->prepare_request
1788 Prepares the engine request.
1792 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1794 =head2 $c->prepare_uploads
1800 sub prepare_uploads {
1803 $c->engine->prepare_uploads( $c, @_ );
1805 if ( $c->debug && keys %{ $c->request->uploads } ) {
1806 my $t = Text::SimpleTable->new(
1807 [ 12, 'Parameter' ],
1812 for my $key ( sort keys %{ $c->request->uploads } ) {
1813 my $upload = $c->request->uploads->{$key};
1814 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1815 $t->row( $key, $u->filename, $u->type, $u->size );
1818 $c->log->debug( "File Uploads are:\n" . $t->draw );
1822 =head2 $c->prepare_write
1824 Prepares the output for writing.
1828 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1830 =head2 $c->request_class
1832 Returns or sets the request class.
1834 =head2 $c->response_class
1836 Returns or sets the response class.
1838 =head2 $c->read( [$maxlength] )
1840 Reads a chunk of data from the request body. This method is designed to
1841 be used in a while loop, reading C<$maxlength> bytes on every call.
1842 C<$maxlength> defaults to the size of the request if not specified.
1844 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1847 Warning: If you use read(), Catalyst will not process the body,
1848 so you will not be able to access POST parameters or file uploads via
1849 $c->request. You must handle all body parsing yourself.
1853 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1861 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1863 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1865 Sets an action in a given namespace.
1869 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1871 =head2 $c->setup_actions($component)
1873 Sets up actions for a component.
1877 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1879 =head2 $c->setup_components
1881 Sets up components. Specify a C<setup_components> config option to pass
1882 additional options directly to L<Module::Pluggable>. To add additional
1883 search paths, specify a key named C<search_extra> as an array
1884 reference. Items in the array beginning with C<::> will have the
1885 application class name prepended to them.
1889 sub setup_components {
1892 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1893 my $config = $class->config->{ setup_components };
1894 my $extra = delete $config->{ search_extra } || [];
1896 push @paths, @$extra;
1898 my $locator = Module::Pluggable::Object->new(
1899 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1903 my @comps = sort { length $a <=> length $b } $locator->plugins;
1904 my %comps = map { $_ => 1 } @comps;
1906 for my $component ( @comps ) {
1908 # We pass ignore_loaded here so that overlay files for (e.g.)
1909 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1910 # we know M::P::O found a file on disk so this is safe
1912 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1913 #Class::MOP::load_class($component);
1915 my $module = $class->setup_component( $component );
1917 $component => $module,
1919 $_ => $class->setup_component( $_ )
1921 not exists $comps{$_}
1922 } Devel::InnerPackage::list_packages( $component )
1925 for my $key ( keys %modules ) {
1926 $class->components->{ $key } = $modules{ $key };
1931 =head2 $c->setup_component
1935 sub setup_component {
1936 my( $class, $component ) = @_;
1938 unless ( $component->can( 'COMPONENT' ) ) {
1942 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1943 my $config = $class->config->{ $suffix } || {};
1945 my $instance = eval { $component->COMPONENT( $class, $config ); };
1947 if ( my $error = $@ ) {
1949 Catalyst::Exception->throw(
1950 message => qq/Couldn't instantiate component "$component", "$error"/
1954 Catalyst::Exception->throw(
1956 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1957 ) unless eval { $instance->can( 'can' ) };
1962 =head2 $c->setup_dispatcher
1968 sub setup_dispatcher {
1969 my ( $class, $dispatcher ) = @_;
1972 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1975 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1976 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1979 unless ($dispatcher) {
1980 $dispatcher = $class->dispatcher_class;
1983 Class::MOP::load_class($dispatcher);
1985 # dispatcher instance
1986 $class->dispatcher( $dispatcher->new );
1989 =head2 $c->setup_engine
1996 my ( $class, $engine ) = @_;
1999 $engine = 'Catalyst::Engine::' . $engine;
2002 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2003 $engine = 'Catalyst::Engine::' . $env;
2006 if ( $ENV{MOD_PERL} ) {
2008 # create the apache method
2011 *{"$class\::apache"} = sub { shift->engine->apache };
2014 my ( $software, $version ) =
2015 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2018 $version =~ s/(\.[^.]+)\./$1/g;
2020 if ( $software eq 'mod_perl' ) {
2024 if ( $version >= 1.99922 ) {
2025 $engine = 'Catalyst::Engine::Apache2::MP20';
2028 elsif ( $version >= 1.9901 ) {
2029 $engine = 'Catalyst::Engine::Apache2::MP19';
2032 elsif ( $version >= 1.24 ) {
2033 $engine = 'Catalyst::Engine::Apache::MP13';
2037 Catalyst::Exception->throw( message =>
2038 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2043 # install the correct mod_perl handler
2044 if ( $version >= 1.9901 ) {
2045 *handler = sub : method {
2046 shift->handle_request(@_);
2050 *handler = sub ($$) { shift->handle_request(@_) };
2055 elsif ( $software eq 'Zeus-Perl' ) {
2056 $engine = 'Catalyst::Engine::Zeus';
2060 Catalyst::Exception->throw(
2061 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2066 $engine = $class->engine_class;
2069 Class::MOP::load_class($engine);
2070 #unless (Class::Inspector->loaded($engine)) {
2071 # require Class::Inspector->filename($engine);
2074 # check for old engines that are no longer compatible
2076 if ( $engine->isa('Catalyst::Engine::Apache')
2077 && !Catalyst::Engine::Apache->VERSION )
2082 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2083 && Catalyst::Engine::Server->VERSION le '0.02' )
2088 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2089 && $engine->VERSION eq '0.01' )
2094 elsif ($engine->isa('Catalyst::Engine::Zeus')
2095 && $engine->VERSION eq '0.01' )
2101 Catalyst::Exception->throw( message =>
2102 qq/Engine "$engine" is not supported by this version of Catalyst/
2107 $class->engine( $engine->new );
2110 =head2 $c->setup_home
2112 Sets up the home directory.
2117 my ( $class, $home ) = @_;
2119 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2123 $home ||= Catalyst::Utils::home($class);
2126 #I remember recently being scolded for assigning config values like this
2127 $class->config->{home} ||= $home;
2128 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2132 =head2 $c->setup_log
2139 my ( $class, $debug ) = @_;
2141 unless ( $class->log ) {
2142 $class->log( Catalyst::Log->new );
2145 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2146 if ( defined($env_debug) ? $env_debug : $debug ) {
2148 #Moose todo: dying to be made a bool attribute
2149 *{"$class\::debug"} = sub { 1 };
2150 $class->log->debug('Debug messages enabled');
2154 =head2 $c->setup_plugins
2160 =head2 $c->setup_stats
2162 Sets up timing statistics class.
2167 my ( $class, $stats ) = @_;
2169 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2171 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2172 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2174 #Moose todo: dying to be made a bool attribute
2175 *{"$class\::use_stats"} = sub { 1 };
2176 $class->log->debug('Statistics enabled');
2181 =head2 $c->registered_plugins
2183 Returns a sorted list of the plugins which have either been stated in the
2184 import list or which have been added via C<< MyApp->plugin(@args); >>.
2186 If passed a given plugin name, it will report a boolean value indicating
2187 whether or not that plugin is loaded. A fully qualified name is required if
2188 the plugin name does not begin with C<Catalyst::Plugin::>.
2190 if ($c->registered_plugins('Some::Plugin')) {
2198 sub registered_plugins {
2200 return sort keys %{ $proto->_plugins } unless @_;
2202 return 1 if exists $proto->_plugins->{$plugin};
2203 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2206 sub _register_plugin {
2207 my ( $proto, $plugin, $instant ) = @_;
2208 my $class = ref $proto || $proto;
2210 # no ignore_loaded here, the plugin may already have been
2211 # defined in memory and we don't want to error on "no file" if so
2213 Class::MOP::load_class( $plugin );
2215 $proto->_plugins->{$plugin} = 1;
2218 if( $class->can('meta') ){
2219 my @superclasses = ($plugin, $class->meta->superclasses );
2220 $class->meta->superclasses(@superclasses);
2222 unshift @{"$class\::ISA"}, $plugin;
2229 my ( $class, $plugins ) = @_;
2231 $class->_plugins( {} ) unless $class->_plugins;
2233 for my $plugin ( reverse @$plugins ) {
2235 unless ( $plugin =~ s/\A\+// ) {
2236 $plugin = "Catalyst::Plugin::$plugin";
2239 $class->_register_plugin($plugin);
2246 Returns an arrayref of the internal execution stack (actions that are
2247 currently executing).
2249 =head2 $c->stats_class
2251 Returns or sets the stats (timing statistics) class.
2253 =head2 $c->use_stats
2255 Returns 1 when stats collection is enabled. Stats collection is enabled
2256 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2257 environment variable is set.
2259 Note that this is a static method, not an accessor and should be overloaded
2260 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2267 =head2 $c->write( $data )
2269 Writes $data to the output stream. When using this method directly, you
2270 will need to manually set the C<Content-Length> header to the length of
2271 your output data, if known.
2278 # Finalize headers if someone manually writes output
2279 $c->finalize_headers;
2281 return $c->engine->write( $c, @_ );
2286 Returns the Catalyst version number. Mostly useful for "powered by"
2287 messages in template systems.
2291 sub version { return $Catalyst::VERSION }
2293 =head1 INTERNAL ACTIONS
2295 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2296 C<_ACTION>, and C<_END>. These are by default not shown in the private
2297 action table, but you can make them visible with a config parameter.
2299 MyApp->config->{show_internal_actions} = 1;
2301 =head1 CASE SENSITIVITY
2303 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2304 mapped to C</foo/bar>. You can activate case sensitivity with a config
2307 MyApp->config->{case_sensitive} = 1;
2309 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2311 =head1 ON-DEMAND PARSER
2313 The request body is usually parsed at the beginning of a request,
2314 but if you want to handle input yourself, you can enable on-demand
2315 parsing with a config parameter.
2317 MyApp->config->{parse_on_demand} = 1;
2319 =head1 PROXY SUPPORT
2321 Many production servers operate using the common double-server approach,
2322 with a lightweight frontend web server passing requests to a larger
2323 backend server. An application running on the backend server must deal
2324 with two problems: the remote user always appears to be C<127.0.0.1> and
2325 the server's hostname will appear to be C<localhost> regardless of the
2326 virtual host that the user connected through.
2328 Catalyst will automatically detect this situation when you are running
2329 the frontend and backend servers on the same machine. The following
2330 changes are made to the request.
2332 $c->req->address is set to the user's real IP address, as read from
2333 the HTTP X-Forwarded-For header.
2335 The host value for $c->req->base and $c->req->uri is set to the real
2336 host, as read from the HTTP X-Forwarded-Host header.
2338 Obviously, your web server must support these headers for this to work.
2340 In a more complex server farm environment where you may have your
2341 frontend proxy server(s) on different machines, you will need to set a
2342 configuration option to tell Catalyst to read the proxied data from the
2345 MyApp->config->{using_frontend_proxy} = 1;
2347 If you do not wish to use the proxy support at all, you may set:
2349 MyApp->config->{ignore_frontend_proxy} = 1;
2351 =head1 THREAD SAFETY
2353 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2354 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2355 believe the Catalyst core to be thread-safe.
2357 If you plan to operate in a threaded environment, remember that all other
2358 modules you are using must also be thread-safe. Some modules, most notably
2359 L<DBD::SQLite>, are not thread-safe.
2365 Join #catalyst on irc.perl.org.
2369 http://lists.rawmode.org/mailman/listinfo/catalyst
2370 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2374 http://catalyst.perl.org
2378 http://dev.catalyst.perl.org
2382 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2384 =head2 L<Catalyst::Manual> - The Catalyst Manual
2386 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2388 =head2 L<Catalyst::Engine> - Core engine
2390 =head2 L<Catalyst::Log> - Log class.
2392 =head2 L<Catalyst::Request> - Request object
2394 =head2 L<Catalyst::Response> - Response object
2396 =head2 L<Catalyst::Test> - The test suite.
2470 Sebastian Riedel, C<sri@oook.de>
2474 This library is free software, you can redistribute it and/or modify it under
2475 the same terms as Perl itself.