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 ();
16 use Text::SimpleTable ();
17 use Path::Class::Dir ();
18 use Path::Class::File ();
19 use Time::HiRes qw/gettimeofday tv_interval/;
23 use Scalar::Util qw/weaken blessed/;
24 use Tree::Simple qw/use_weak_refs/;
25 use Tree::Simple::Visitor::FindByUID;
28 use Carp qw/croak carp/;
30 BEGIN { require 5.008001; }
32 has stack => (is => 'rw');
33 has stash => (is => 'rw');
34 has state => (is => 'rw');
35 has stats => (is => 'rw');
36 has action => (is => 'rw');
37 has counter => (is => 'rw');
38 has request => (is => 'rw');
39 has response => (is => 'rw');
40 has namespace => (is => 'rw');
43 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
45 sub depth { scalar @{ shift->stack || [] }; }
52 # For backwards compatibility
53 *finalize_output = \&finalize_body;
58 our $RECURSION = 1000;
59 our $DETACH = "catalyst_detach\n";
61 #I imagine that very few of these really need to be class variables. if any.
62 #maybe we should just make them attributes with a default?
63 __PACKAGE__->mk_classdata($_)
64 for qw/components arguments dispatcher engine log dispatcher_class
65 engine_class context_class request_class response_class stats_class
68 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
69 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
70 __PACKAGE__->request_class('Catalyst::Request');
71 __PACKAGE__->response_class('Catalyst::Response');
72 __PACKAGE__->stats_class('Catalyst::Stats');
74 # Remember to update this in Catalyst::Runtime as well!
76 our $VERSION = '5.7013';
79 my ( $class, @arguments ) = @_;
81 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
83 return unless $class eq 'Catalyst';
85 my $caller = caller(0);
87 #why does called have to ISA Catalyst and ISA Controller ?
88 #Convert test suite to not use the behavior where Myapp ISA Controller
89 # after that is done we can eliminate that little mess.
90 unless ( $caller->isa('Catalyst') ) {
92 if( $caller->can('meta') ){
93 my @superclasses = ($caller->meta->superclasses, $class, 'Catalyst::Controller');
94 #my @superclasses = ($caller->meta->superclasses, $class);
95 $caller->meta->superclasses(@superclasses);
97 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
98 #push @{"$caller\::ISA"}, $class;
102 $caller->arguments( [@arguments] );
108 Catalyst - The Elegant MVC Web Application Framework
112 See the L<Catalyst::Manual> distribution for comprehensive
113 documentation and tutorials.
115 # Install Catalyst::Devel for helpers and other development tools
116 # use the helper to create a new application
119 # add models, views, controllers
120 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
121 script/myapp_create.pl view MyTemplate TT
122 script/myapp_create.pl controller Search
124 # built in testserver -- use -r to restart automatically on changes
125 # --help to see all available options
126 script/myapp_server.pl
128 # command line testing interface
129 script/myapp_test.pl /yada
132 use Catalyst qw/-Debug/; # include plugins here as well
134 ### In lib/MyApp/Controller/Root.pm (autocreated)
135 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
136 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
137 $c->stash->{template} = 'foo.tt'; # set the template
138 # lookup something from db -- stash vars are passed to TT
140 $c->model('Database::Foo')->search( { country => $args[0] } );
141 if ( $c->req->params->{bar} ) { # access GET or POST parameters
142 $c->forward( 'bar' ); # process another action
143 # do something else after forward returns
147 # The foo.tt TT template can use the stash data from the database
148 [% WHILE (item = data.next) %]
152 # called for /bar/of/soap, /bar/of/soap/10, etc.
153 sub bar : Path('/bar/of/soap') { ... }
155 # called for all actions, from the top-most controller downwards
157 my ( $self, $c ) = @_;
158 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
159 $c->res->redirect( '/login' ); # require login
160 return 0; # abort request and go immediately to end()
162 return 1; # success; carry on to next action
165 # called after all actions are finished
167 my ( $self, $c ) = @_;
168 if ( scalar @{ $c->error } ) { ... } # handle errors
169 return if $c->res->body; # already have a response
170 $c->forward( 'MyApp::View::TT' ); # render template
173 ### in MyApp/Controller/Foo.pm
174 # called for /foo/bar
175 sub bar : Local { ... }
177 # called for /blargle
178 sub blargle : Global { ... }
180 # an index action matches /foo, but not /foo/1, etc.
181 sub index : Private { ... }
183 ### in MyApp/Controller/Foo/Bar.pm
184 # called for /foo/bar/baz
185 sub baz : Local { ... }
187 # first Root auto is called, then Foo auto, then this
188 sub auto : Private { ... }
190 # powerful regular expression paths are also possible
191 sub details : Regex('^product/(\w+)/details$') {
192 my ( $self, $c ) = @_;
193 # extract the (\w+) from the URI
194 my $product = $c->req->captures->[0];
197 See L<Catalyst::Manual::Intro> for additional information.
201 Catalyst is a modern framework for making web applications without the
202 pain usually associated with this process. This document is a reference
203 to the main Catalyst application. If you are a new user, we suggest you
204 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
206 See L<Catalyst::Manual> for more documentation.
208 Catalyst plugins can be loaded by naming them as arguments to the "use
209 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
210 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
213 use Catalyst qw/My::Module/;
215 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
216 fully qualify the name by using a unary plus:
220 +Fully::Qualified::Plugin::Name
223 Special flags like C<-Debug> and C<-Engine> can also be specified as
224 arguments when Catalyst is loaded:
226 use Catalyst qw/-Debug My::Module/;
228 The position of plugins and flags in the chain is important, because
229 they are loaded in the order in which they appear.
231 The following flags are supported:
235 Enables debug output. You can also force this setting from the system
236 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
237 settings override the application, with <MYAPP>_DEBUG having the highest
242 Forces Catalyst to use a specific engine. Omit the
243 C<Catalyst::Engine::> prefix of the engine name, i.e.:
245 use Catalyst qw/-Engine=CGI/;
249 Forces Catalyst to use a specific home directory, e.g.:
251 use Catalyst qw[-Home=/usr/mst];
253 This can also be done in the shell environment by setting either the
254 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
255 is replaced with the uppercased name of your application, any "::" in
256 the name will be replaced with underscores, e.g. MyApp::Web should use
257 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
265 Enables statistics collection and reporting. You can also force this setting
266 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
267 environment settings override the application, with <MYAPP>_STATS having the
272 use Catalyst qw/-Stats=1/
276 =head2 INFORMATION ABOUT THE CURRENT REQUEST
280 Returns a L<Catalyst::Action> object for the current action, which
281 stringifies to the action name. See L<Catalyst::Action>.
285 Returns the namespace of the current action, i.e., the URI prefix
286 corresponding to the controller of the current action. For example:
288 # in Controller::Foo::Bar
289 $c->namespace; # returns 'foo/bar';
295 Returns the current L<Catalyst::Request> object, giving access to
296 information about the current client request (including parameters,
297 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
299 =head2 REQUEST FLOW HANDLING
301 =head2 $c->forward( $action [, \@arguments ] )
303 =head2 $c->forward( $class, $method, [, \@arguments ] )
305 Forwards processing to another action, by its private name. If you give a
306 class name but no method, C<process()> is called. You may also optionally
307 pass arguments in an arrayref. The action will receive the arguments in
308 C<@_> and C<< $c->req->args >>. Upon returning from the function,
309 C<< $c->req->args >> will be restored to the previous values.
311 Any data C<return>ed from the action forwarded to, will be returned by the
314 my $foodata = $c->forward('/foo');
315 $c->forward('index');
316 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
317 $c->forward('MyApp::View::TT');
319 Note that forward implies an C<<eval { }>> around the call (actually
320 C<execute> does), thus de-fatalizing all 'dies' within the called
321 action. If you want C<die> to propagate you need to do something like:
324 die $c->error if $c->error;
326 Or make sure to always return true values from your actions and write
329 $c->forward('foo') || return;
333 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
335 =head2 $c->detach( $action [, \@arguments ] )
337 =head2 $c->detach( $class, $method, [, \@arguments ] )
341 The same as C<forward>, but doesn't return to the previous action when
342 processing is finished.
344 When called with no arguments it escapes the processing chain entirely.
348 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
354 Returns the current L<Catalyst::Response> object, see there for details.
358 Returns a hashref to the stash, which may be used to store data and pass
359 it between components during a request. You can also set hash keys by
360 passing arguments. The stash is automatically sent to the view. The
361 stash is cleared at the end of a request; it cannot be used for
362 persistent storage (for this you must use a session; see
363 L<Catalyst::Plugin::Session> for a complete system integrated with
366 $c->stash->{foo} = $bar;
367 $c->stash( { moose => 'majestic', qux => 0 } );
368 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
370 # stash is automatically passed to the view for use in a template
371 $c->forward( 'MyApp::View::TT' );
375 around stash => sub {
379 my $stash = @_ > 1 ? {@_} : $_[0];
380 croak('stash takes a hash or hashref') unless ref $stash;
381 foreach my $key ( keys %$stash ) {
382 $c->$orig()->{$key} = $stash->{$key};
390 =head2 $c->error($error, ...)
392 =head2 $c->error($arrayref)
394 Returns an arrayref containing error messages. If Catalyst encounters an
395 error while processing a request, it stores the error in $c->error. This
396 method should only be used to store fatal error messages.
398 my @error = @{ $c->error };
402 $c->error('Something bad happened');
409 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
410 croak @$error unless ref $c;
411 push @{ $c->{error} }, @$error;
413 elsif ( defined $_[0] ) { $c->{error} = undef }
414 return $c->{error} || [];
420 Contains the return value of the last executed action.
422 =head2 $c->clear_errors
424 Clear errors. You probably don't want to clear the errors unless you are
425 implementing a custom error screen.
427 This is equivalent to running
441 my ( $c, @names ) = @_;
443 foreach my $name (@names) {
444 foreach my $component ( keys %{ $c->components } ) {
445 return $c->components->{$component} if $component =~ /$name/i;
452 # try explicit component names
454 my ( $c, @names ) = @_;
456 foreach my $try (@names) {
457 return $c->components->{$try} if ( exists $c->components->{$try} );
463 # like component, but try just these prefixes before regex searching,
464 # and do not try to return "sort keys %{ $c->components }"
466 my ( $c, $name, @prefixes ) = @_;
468 my $appclass = ref $c || $c;
470 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
472 my $comp = $c->_comp_explicit(@names);
473 return $comp if defined($comp);
474 $comp = $c->_comp_search($name);
478 # Find possible names for a prefix
481 my ( $c, @prefixes ) = @_;
483 my $appclass = ref $c || $c;
485 my @pre = map { "${appclass}::${_}::" } @prefixes;
489 COMPONENT: foreach my $comp ($c->component) {
490 foreach my $p (@pre) {
491 if ($comp =~ s/^$p//) {
501 # Return a component if only one matches.
503 my ( $c, @prefixes ) = @_;
505 my $appclass = ref $c || $c;
507 my ( $comp, $rest ) =
508 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
509 return $comp unless $rest;
512 # Filter a component before returning by calling ACCEPT_CONTEXT if available
513 sub _filter_component {
514 my ( $c, $comp, @args ) = @_;
515 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
516 return $comp->ACCEPT_CONTEXT( $c, @args );
518 else { return $comp }
521 =head2 COMPONENT ACCESSORS
523 =head2 $c->controller($name)
525 Gets a L<Catalyst::Controller> instance by name.
527 $c->controller('Foo')->do_stuff;
529 If the name is omitted, will return the controller for the dispatched
535 my ( $c, $name, @args ) = @_;
536 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
539 return $c->component( $c->action->class );
542 =head2 $c->model($name)
544 Gets a L<Catalyst::Model> instance by name.
546 $c->model('Foo')->do_stuff;
548 Any extra arguments are directly passed to ACCEPT_CONTEXT.
550 If the name is omitted, it will look for
551 - a model object in $c->stash{current_model_instance}, then
552 - a model name in $c->stash->{current_model}, then
553 - a config setting 'default_model', or
554 - check if there is only one model, and return it if that's the case.
559 my ( $c, $name, @args ) = @_;
560 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
564 return $c->stash->{current_model_instance}
565 if $c->stash->{current_model_instance};
566 return $c->model( $c->stash->{current_model} )
567 if $c->stash->{current_model};
569 return $c->model( $c->config->{default_model} )
570 if $c->config->{default_model};
571 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
575 =head2 $c->controllers
577 Returns the available names which can be passed to $c->controller
583 return $c->_comp_names(qw/Controller C/);
587 =head2 $c->view($name)
589 Gets a L<Catalyst::View> instance by name.
591 $c->view('Foo')->do_stuff;
593 Any extra arguments are directly passed to ACCEPT_CONTEXT.
595 If the name is omitted, it will look for
596 - a view object in $c->stash{current_view_instance}, then
597 - a view name in $c->stash->{current_view}, then
598 - a config setting 'default_view', or
599 - check if there is only one view, and return it if that's the case.
604 my ( $c, $name, @args ) = @_;
605 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
609 return $c->stash->{current_view_instance}
610 if $c->stash->{current_view_instance};
611 return $c->view( $c->stash->{current_view} )
612 if $c->stash->{current_view};
614 return $c->view( $c->config->{default_view} )
615 if $c->config->{default_view};
616 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
621 Returns the available names which can be passed to $c->model
627 return $c->_comp_names(qw/Model M/);
633 Returns the available names which can be passed to $c->view
639 return $c->_comp_names(qw/View V/);
642 =head2 $c->comp($name)
644 =head2 $c->component($name)
646 Gets a component object by name. This method is not recommended,
647 unless you want to get a specific component by full
648 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
649 should be used instead.
660 my $appclass = ref $c || $c;
663 $name, "${appclass}::${name}",
664 map { "${appclass}::${_}::${name}" }
665 qw/Model M Controller C View V/
668 my $comp = $c->_comp_explicit(@names);
669 return $c->_filter_component( $comp, @_ ) if defined($comp);
671 $comp = $c->_comp_search($name);
672 return $c->_filter_component( $comp, @_ ) if defined($comp);
675 return sort keys %{ $c->components };
680 =head2 CLASS DATA AND HELPER CLASSES
684 Returns or takes a hashref containing the application's configuration.
686 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
688 You can also use a C<YAML>, C<XML> or C<Config::General> config file
689 like myapp.yml in your applications home directory. See
690 L<Catalyst::Plugin::ConfigLoader>.
693 db: dsn:SQLite:foo.db
698 around config => sub {
702 $c->log->warn("Setting config after setup has been run is not a good idea.")
703 if ( @_ and $c->setup_finished );
710 Returns the logging object instance. Unless it is already set, Catalyst
711 sets this up with a L<Catalyst::Log> object. To use your own log class,
712 set the logger with the C<< __PACKAGE__->log >> method prior to calling
713 C<< __PACKAGE__->setup >>.
715 __PACKAGE__->log( MyLogger->new );
720 $c->log->info( 'Now logging with my own logger!' );
722 Your log class should implement the methods described in
728 Overload to enable debug messages (same as -Debug option).
730 Note that this is a static method, not an accessor and should be overloaded
731 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
737 =head2 $c->dispatcher
739 Returns the dispatcher instance. Stringifies to class name. See
740 L<Catalyst::Dispatcher>.
744 Returns the engine instance. Stringifies to the class name. See
748 =head2 UTILITY METHODS
750 =head2 $c->path_to(@path)
752 Merges C<@path> with C<< $c->config->{home} >> and returns a
753 L<Path::Class::Dir> object.
757 $c->path_to( 'db', 'sqlite.db' );
762 my ( $c, @path ) = @_;
763 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
764 if ( -d $path ) { return $path }
765 else { return Path::Class::File->new( $c->config->{home}, @path ) }
768 =head2 $c->plugin( $name, $class, @args )
770 Helper method for plugins. It creates a classdata accessor/mutator and
771 loads and instantiates the given class.
773 MyApp->plugin( 'prototype', 'HTML::Prototype' );
775 $c->prototype->define_javascript_functions;
780 my ( $class, $name, $plugin, @args ) = @_;
781 $class->_register_plugin( $plugin, 1 );
783 eval { $plugin->import };
784 $class->mk_classdata($name);
786 eval { $obj = $plugin->new(@args) };
789 Catalyst::Exception->throw( message =>
790 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
794 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
800 Initializes the dispatcher and engine, loads any plugins, and loads the
801 model, view, and controller components. You may also specify an array
802 of plugins to load here, if you choose to not load them in the C<use
806 MyApp->setup( qw/-Debug/ );
811 my ( $class, @arguments ) = @_;
813 $class->log->warn("Running setup twice is not a good idea.")
814 if ( $class->setup_finished );
816 unless ( $class->isa('Catalyst') ) {
818 Catalyst::Exception->throw(
819 message => qq/'$class' does not inherit from Catalyst/ );
822 if ( $class->arguments ) {
823 @arguments = ( @arguments, @{ $class->arguments } );
829 foreach (@arguments) {
833 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
835 elsif (/^-(\w+)=?(.*)$/) {
836 $flags->{ lc $1 } = $2;
839 push @{ $flags->{plugins} }, $_;
843 $class->setup_home( delete $flags->{home} );
845 $class->setup_log( delete $flags->{log} );
846 $class->setup_plugins( delete $flags->{plugins} );
847 $class->setup_dispatcher( delete $flags->{dispatcher} );
848 $class->setup_engine( delete $flags->{engine} );
849 $class->setup_stats( delete $flags->{stats} );
851 for my $flag ( sort keys %{$flags} ) {
853 if ( my $code = $class->can( 'setup_' . $flag ) ) {
854 &$code( $class, delete $flags->{$flag} );
857 $class->log->warn(qq/Unknown flag "$flag"/);
861 eval { require Catalyst::Devel; };
862 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
863 $class->log->warn(<<"EOF");
864 You are running an old script!
866 Please update by running (this will overwrite existing files):
867 catalyst.pl -force -scripts $class
869 or (this will not overwrite existing files):
870 catalyst.pl -scripts $class
875 if ( $class->debug ) {
876 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
879 my $t = Text::SimpleTable->new(74);
880 $t->row($_) for @plugins;
881 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
884 my $dispatcher = $class->dispatcher;
885 my $engine = $class->engine;
886 my $home = $class->config->{home};
888 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
889 $class->log->debug(qq/Loaded engine "$engine"/);
893 ? $class->log->debug(qq/Found home "$home"/)
894 : $class->log->debug(qq/Home "$home" doesn't exist/)
895 : $class->log->debug(q/Couldn't find home/);
900 no warnings qw/redefine/;
901 local *setup = sub { };
905 # Initialize our data structure
906 $class->components( {} );
908 $class->setup_components;
910 if ( $class->debug ) {
911 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
912 for my $comp ( sort keys %{ $class->components } ) {
913 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
914 $t->row( $comp, $type );
916 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
917 if ( keys %{ $class->components } );
920 # Add our self to components, since we are also a component
921 $class->components->{$class} = $class;
923 $class->setup_actions;
925 if ( $class->debug ) {
926 my $name = $class->config->{name} || 'Application';
927 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
929 $class->log->_flush() if $class->log->can('_flush');
931 $class->setup_finished(1);
934 =head2 $c->uri_for( $path, @args?, \%query_values? )
936 Merges path with C<< $c->request->base >> for absolute URIs and with
937 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
938 object. If any args are passed, they are added at the end of the path.
939 If the last argument to C<uri_for> is a hash reference, it is assumed to
940 contain GET parameter key/value pairs, which will be appended to the URI
943 Note that uri_for is destructive to the passed hashref. Subsequent calls
944 with the same hashref may have unintended results.
946 Instead of C<$path>, you can also optionally pass a C<$action> object
947 which will be resolved to a path using
948 C<< $c->dispatcher->uri_for_action >>; if the first element of
949 C<@args> is an arrayref it is treated as a list of captures to be passed
950 to C<uri_for_action>.
955 my ( $c, $path, @args ) = @_;
957 if ( Scalar::Util::blessed($path) ) { # action object
958 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
961 $path = $c->dispatcher->uri_for_action($path, $captures);
962 return undef unless defined($path);
963 $path = '/' if $path eq '';
966 undef($path) if (defined $path && $path eq '');
969 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
971 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
972 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
974 unshift(@args, $path);
976 unless (defined $path && $path =~ s!^/!!) { # in-place strip
977 my $namespace = $c->namespace;
978 if (defined $path) { # cheesy hack to handle path '../foo'
979 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
981 unshift(@args, $namespace || '');
984 # join args with '/', or a blank string
985 my $args = join('/', grep { defined($_) } @args);
986 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
988 my $base = $c->req->base;
989 my $class = ref($base);
990 $base =~ s{(?<!/)$}{/};
994 if (my @keys = keys %$params) {
995 # somewhat lifted from URI::_query's query_form
996 $query = '?'.join('&', map {
997 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1000 my $val = $params->{$_};
1001 $val = '' unless defined $val;
1004 utf8::encode( $_ ) if utf8::is_utf8($_);
1005 # using the URI::Escape pattern here so utf8 chars survive
1006 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1008 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1012 my $res = bless(\"${base}${args}${query}", $class);
1016 =head2 $c->welcome_message
1018 Returns the Catalyst welcome HTML page.
1022 sub welcome_message {
1024 my $name = $c->config->{name};
1025 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1026 my $prefix = Catalyst::Utils::appprefix( ref $c );
1027 $c->response->content_type('text/html; charset=utf-8');
1029 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1030 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1031 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1033 <meta http-equiv="Content-Language" content="en" />
1034 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1035 <title>$name on Catalyst $VERSION</title>
1036 <style type="text/css">
1039 background-color: #eee;
1046 margin-bottom: 10px;
1048 background-color: #ccc;
1049 border: 1px solid #aaa;
1054 font-family: verdana, tahoma, sans-serif;
1057 font-family: verdana, tahoma, sans-serif;
1060 text-decoration: none;
1062 border-bottom: 1px dotted #bbb;
1064 :link:hover, :visited:hover {
1077 background-color: #fff;
1078 border: 1px solid #aaa;
1082 font-weight: normal;
1104 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1109 <img src="$logo" alt="Catalyst Logo" />
1111 <p>Welcome to the world of Catalyst.
1112 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1113 framework will make web development something you had
1114 never expected it to be: Fun, rewarding, and quick.</p>
1115 <h2>What to do now?</h2>
1116 <p>That really depends on what <b>you</b> want to do.
1117 We do, however, provide you with a few starting points.</p>
1118 <p>If you want to jump right into web development with Catalyst
1119 you might want want to start with a tutorial.</p>
1120 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1122 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1124 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1125 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1127 <h2>What to do next?</h2>
1128 <p>Next it's time to write an actual application. Use the
1129 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1130 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1131 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1132 they can save you a lot of work.</p>
1133 <pre><code>script/${prefix}_create.pl -help</code></pre>
1134 <p>Also, be sure to check out the vast and growing
1135 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1136 you are likely to find what you need there.
1140 <p>Catalyst has a very active community. Here are the main places to
1141 get in touch with us.</p>
1144 <a href="http://dev.catalyst.perl.org">Wiki</a>
1147 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1150 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1153 <h2>In conclusion</h2>
1154 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1155 as we enjoyed making it. Please contact us if you have ideas
1156 for improvement or other feedback.</p>
1164 =head1 INTERNAL METHODS
1166 These methods are not meant to be used by end users.
1168 =head2 $c->components
1170 Returns a hash of components.
1172 =head2 $c->context_class
1174 Returns or sets the context class.
1178 Returns a hashref containing coderefs and execution counts (needed for
1179 deep recursion detection).
1183 Returns the number of actions on the current internal execution stack.
1187 Dispatches a request to actions.
1191 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1193 =head2 $c->dispatcher_class
1195 Returns or sets the dispatcher class.
1197 =head2 $c->dump_these
1199 Returns a list of 2-element array references (name, structure) pairs
1200 that will be dumped on the error page in debug mode.
1206 [ Request => $c->req ],
1207 [ Response => $c->res ],
1208 [ Stash => $c->stash ],
1209 [ Config => $c->config ];
1212 =head2 $c->engine_class
1214 Returns or sets the engine class.
1216 =head2 $c->execute( $class, $coderef )
1218 Execute a coderef in given class and catch exceptions. Errors are available
1224 my ( $c, $class, $code ) = @_;
1225 $class = $c->component($class) || $class;
1228 if ( $c->depth >= $RECURSION ) {
1229 my $action = "$code";
1230 $action = "/$action" unless $action =~ /->/;
1231 my $error = qq/Deep recursion detected calling "$action"/;
1232 $c->log->error($error);
1238 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1240 push( @{ $c->stack }, $code );
1242 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1244 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1246 my $last = pop( @{ $c->stack } );
1248 if ( my $error = $@ ) {
1249 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1251 unless ( ref $error ) {
1252 no warnings 'uninitialized';
1254 my $class = $last->class;
1255 my $name = $last->name;
1256 $error = qq/Caught exception in $class->$name "$error"/;
1265 sub _stats_start_execute {
1266 my ( $c, $code ) = @_;
1268 return if ( ( $code->name =~ /^_.*/ )
1269 && ( !$c->config->{show_internal_actions} ) );
1271 $c->counter->{"$code"}++;
1273 my $action = "$code";
1274 $action = "/$action" unless $action =~ /->/;
1276 # determine if the call was the result of a forward
1277 # this is done by walking up the call stack and looking for a calling
1278 # sub of Catalyst::forward before the eval
1280 for my $index ( 2 .. 11 ) {
1282 if ( ( caller($index) )[0] eq 'Catalyst'
1283 && ( caller($index) )[3] eq '(eval)' );
1285 if ( ( caller($index) )[3] =~ /forward$/ ) {
1286 $callsub = ( caller($index) )[3];
1287 $action = "-> $action";
1292 my $uid = "$code" . $c->counter->{"$code"};
1294 # is this a root-level call or a forwarded call?
1295 if ( $callsub =~ /forward$/ ) {
1297 # forward, locate the caller
1298 if ( my $parent = $c->stack->[-1] ) {
1301 parent => "$parent" . $c->counter->{"$parent"},
1307 # forward with no caller may come from a plugin
1326 sub _stats_finish_execute {
1327 my ( $c, $info ) = @_;
1328 $c->stats->profile( end => $info );
1331 =head2 $c->_localize_fields( sub { }, \%keys );
1335 #Why does this exist? This is no longer safe and WILL NOT WORK.
1336 # it doesnt seem to be used anywhere. can we remove it?
1337 sub _localize_fields {
1338 my ( $c, $localized, $code ) = ( @_ );
1340 my $request = delete $localized->{request} || {};
1341 my $response = delete $localized->{response} || {};
1343 local @{ $c }{ keys %$localized } = values %$localized;
1344 local @{ $c->request }{ keys %$request } = values %$request;
1345 local @{ $c->response }{ keys %$response } = values %$response;
1352 Finalizes the request.
1359 for my $error ( @{ $c->error } ) {
1360 $c->log->error($error);
1363 # Allow engine to handle finalize flow (for POE)
1364 my $engine = $c->engine;
1365 if ( my $code = $engine->can('finalize') ) {
1370 $c->finalize_uploads;
1373 if ( $#{ $c->error } >= 0 ) {
1377 $c->finalize_headers;
1380 if ( $c->request->method eq 'HEAD' ) {
1381 $c->response->body('');
1387 if ($c->use_stats) {
1388 my $elapsed = sprintf '%f', $c->stats->elapsed;
1389 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1391 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1394 return $c->response->status;
1397 =head2 $c->finalize_body
1403 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1405 =head2 $c->finalize_cookies
1411 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1413 =head2 $c->finalize_error
1419 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1421 =head2 $c->finalize_headers
1427 sub finalize_headers {
1430 my $response = $c->response; #accessor calls can add up?
1432 # Moose TODO: Maybe this should be an attribute too?
1433 # Check if we already finalized headers
1434 return if $response->{_finalized_headers};
1437 if ( my $location = $response->redirect ) {
1438 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1439 $response->header( Location => $location );
1441 #Moose TODO: we should probably be using a predicate method here ?
1442 if ( !$response->body ) {
1443 # Add a default body if none is already present
1445 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1451 if ( $response->body && !$response->content_length ) {
1453 # get the length from a filehandle
1454 if ( blessed( $response->body ) && $response->body->can('read') )
1456 my $stat = stat $response->body;
1457 if ( $stat && $stat->size > 0 ) {
1458 $response->content_length( $stat->size );
1461 $c->log->warn('Serving filehandle without a content-length');
1465 # everything should be bytes at this point, but just in case
1466 $response->content_length( bytes::length( $response->body ) );
1471 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1472 $response->headers->remove_header("Content-Length");
1473 $response->body('');
1476 $c->finalize_cookies;
1478 $c->engine->finalize_headers( $c, @_ );
1481 $response->{_finalized_headers} = 1;
1484 =head2 $c->finalize_output
1486 An alias for finalize_body.
1488 =head2 $c->finalize_read
1490 Finalizes the input after reading is complete.
1494 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1496 =head2 $c->finalize_uploads
1498 Finalizes uploads. Cleans up any temporary files.
1502 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1504 =head2 $c->get_action( $action, $namespace )
1506 Gets an action in a given namespace.
1510 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1512 =head2 $c->get_actions( $action, $namespace )
1514 Gets all actions of a given name in a namespace and all parent
1519 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1521 =head2 $c->handle_request( $class, @arguments )
1523 Called to handle each HTTP request.
1527 sub handle_request {
1528 my ( $class, @arguments ) = @_;
1530 # Always expect worst case!
1533 if ($class->debug) {
1534 my $secs = time - $START || 1;
1535 my $av = sprintf '%.3f', $COUNT / $secs;
1536 my $time = localtime time;
1537 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1540 my $c = $class->prepare(@arguments);
1542 $status = $c->finalize;
1545 if ( my $error = $@ ) {
1547 $class->log->error(qq/Caught exception in engine "$error"/);
1551 #todo: reuse coderef from can
1552 $class->log->_flush() if $class->log->can('_flush');
1556 =head2 $c->prepare( @arguments )
1558 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1564 my ( $class, @arguments ) = @_;
1566 #moose todo: context_class as attr with default
1567 $class->context_class( ref $class || $class ) unless $class->context_class;
1568 #Moose TODO: if we make empty containers the defaults then that can be
1569 #handled by the context class itself instead of having this here
1570 my $c = $class->context_class->new(
1574 request => $class->request_class->new(
1577 body_parameters => {},
1579 headers => HTTP::Headers->new,
1581 query_parameters => {},
1587 response => $class->response_class->new(
1591 headers => HTTP::Headers->new(),
1600 #surely this is not the most efficient way to do things...
1601 $c->stats($class->stats_class->new)->enable($c->use_stats);
1603 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1606 # For on-demand data
1607 $c->request->_context($c);
1608 $c->response->_context($c);
1610 #XXX reuse coderef from can
1611 # Allow engine to direct the prepare flow (for POE)
1612 if ( $c->engine->can('prepare') ) {
1613 $c->engine->prepare( $c, @arguments );
1616 $c->prepare_request(@arguments);
1617 $c->prepare_connection;
1618 $c->prepare_query_parameters;
1619 $c->prepare_headers;
1620 $c->prepare_cookies;
1623 # Prepare the body for reading, either by prepare_body
1624 # or the user, if they are using $c->read
1627 # Parse the body unless the user wants it on-demand
1628 unless ( $c->config->{parse_on_demand} ) {
1633 my $method = $c->req->method || '';
1634 my $path = $c->req->path || '/';
1635 my $address = $c->req->address || '';
1637 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1645 =head2 $c->prepare_action
1647 Prepares action. See L<Catalyst::Dispatcher>.
1651 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1653 =head2 $c->prepare_body
1655 Prepares message body.
1662 #Moose TODO: what is _body ??
1663 # Do we run for the first time?
1664 return if defined $c->request->{_body};
1666 # Initialize on-demand data
1667 $c->engine->prepare_body( $c, @_ );
1668 $c->prepare_parameters;
1669 $c->prepare_uploads;
1671 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1672 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1673 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1674 my $param = $c->req->body_parameters->{$key};
1675 my $value = defined($param) ? $param : '';
1677 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1679 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1683 =head2 $c->prepare_body_chunk( $chunk )
1685 Prepares a chunk of data before sending it to L<HTTP::Body>.
1687 See L<Catalyst::Engine>.
1691 sub prepare_body_chunk {
1693 $c->engine->prepare_body_chunk( $c, @_ );
1696 =head2 $c->prepare_body_parameters
1698 Prepares body parameters.
1702 sub prepare_body_parameters {
1704 $c->engine->prepare_body_parameters( $c, @_ );
1707 =head2 $c->prepare_connection
1709 Prepares connection.
1713 sub prepare_connection {
1715 $c->engine->prepare_connection( $c, @_ );
1718 =head2 $c->prepare_cookies
1724 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1726 =head2 $c->prepare_headers
1732 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1734 =head2 $c->prepare_parameters
1736 Prepares parameters.
1740 sub prepare_parameters {
1742 $c->prepare_body_parameters;
1743 $c->engine->prepare_parameters( $c, @_ );
1746 =head2 $c->prepare_path
1748 Prepares path and base.
1752 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1754 =head2 $c->prepare_query_parameters
1756 Prepares query parameters.
1760 sub prepare_query_parameters {
1763 $c->engine->prepare_query_parameters( $c, @_ );
1765 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1766 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1767 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1768 my $param = $c->req->query_parameters->{$key};
1769 my $value = defined($param) ? $param : '';
1771 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1773 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1777 =head2 $c->prepare_read
1779 Prepares the input for reading.
1783 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1785 =head2 $c->prepare_request
1787 Prepares the engine request.
1791 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1793 =head2 $c->prepare_uploads
1799 sub prepare_uploads {
1802 $c->engine->prepare_uploads( $c, @_ );
1804 if ( $c->debug && keys %{ $c->request->uploads } ) {
1805 my $t = Text::SimpleTable->new(
1806 [ 12, 'Parameter' ],
1811 for my $key ( sort keys %{ $c->request->uploads } ) {
1812 my $upload = $c->request->uploads->{$key};
1813 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1814 $t->row( $key, $u->filename, $u->type, $u->size );
1817 $c->log->debug( "File Uploads are:\n" . $t->draw );
1821 =head2 $c->prepare_write
1823 Prepares the output for writing.
1827 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1829 =head2 $c->request_class
1831 Returns or sets the request class.
1833 =head2 $c->response_class
1835 Returns or sets the response class.
1837 =head2 $c->read( [$maxlength] )
1839 Reads a chunk of data from the request body. This method is designed to
1840 be used in a while loop, reading C<$maxlength> bytes on every call.
1841 C<$maxlength> defaults to the size of the request if not specified.
1843 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1846 Warning: If you use read(), Catalyst will not process the body,
1847 so you will not be able to access POST parameters or file uploads via
1848 $c->request. You must handle all body parsing yourself.
1852 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1860 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1862 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1864 Sets an action in a given namespace.
1868 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1870 =head2 $c->setup_actions($component)
1872 Sets up actions for a component.
1876 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1878 =head2 $c->setup_components
1880 Sets up components. Specify a C<setup_components> config option to pass
1881 additional options directly to L<Module::Pluggable>. To add additional
1882 search paths, specify a key named C<search_extra> as an array
1883 reference. Items in the array beginning with C<::> will have the
1884 application class name prepended to them.
1888 sub setup_components {
1891 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1892 my $config = $class->config->{ setup_components };
1893 my $extra = delete $config->{ search_extra } || [];
1895 push @paths, @$extra;
1897 my $locator = Module::Pluggable::Object->new(
1898 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1902 my @comps = sort { length $a <=> length $b } $locator->plugins;
1903 my %comps = map { $_ => 1 } @comps;
1905 for my $component ( @comps ) {
1907 # We pass ignore_loaded here so that overlay files for (e.g.)
1908 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1909 # we know M::P::O found a file on disk so this is safe
1911 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1912 #Class::MOP::load_class($component);
1914 my $module = $class->setup_component( $component );
1916 $component => $module,
1918 $_ => $class->setup_component( $_ )
1920 not exists $comps{$_}
1921 } Devel::InnerPackage::list_packages( $component )
1924 for my $key ( keys %modules ) {
1925 $class->components->{ $key } = $modules{ $key };
1930 =head2 $c->setup_component
1934 sub setup_component {
1935 my( $class, $component ) = @_;
1937 unless ( $component->can( 'COMPONENT' ) ) {
1941 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1942 my $config = $class->config->{ $suffix } || {};
1944 my $instance = eval { $component->COMPONENT( $class, $config ); };
1946 if ( my $error = $@ ) {
1948 Catalyst::Exception->throw(
1949 message => qq/Couldn't instantiate component "$component", "$error"/
1953 Catalyst::Exception->throw(
1955 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1956 ) unless eval { $instance->can( 'can' ) };
1961 =head2 $c->setup_dispatcher
1967 sub setup_dispatcher {
1968 my ( $class, $dispatcher ) = @_;
1971 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1974 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1975 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1978 unless ($dispatcher) {
1979 $dispatcher = $class->dispatcher_class;
1982 Class::MOP::load_class($dispatcher);
1984 # dispatcher instance
1985 $class->dispatcher( $dispatcher->new );
1988 =head2 $c->setup_engine
1995 my ( $class, $engine ) = @_;
1998 $engine = 'Catalyst::Engine::' . $engine;
2001 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2002 $engine = 'Catalyst::Engine::' . $env;
2005 if ( $ENV{MOD_PERL} ) {
2007 # create the apache method
2010 *{"$class\::apache"} = sub { shift->engine->apache };
2013 my ( $software, $version ) =
2014 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2017 $version =~ s/(\.[^.]+)\./$1/g;
2019 if ( $software eq 'mod_perl' ) {
2023 if ( $version >= 1.99922 ) {
2024 $engine = 'Catalyst::Engine::Apache2::MP20';
2027 elsif ( $version >= 1.9901 ) {
2028 $engine = 'Catalyst::Engine::Apache2::MP19';
2031 elsif ( $version >= 1.24 ) {
2032 $engine = 'Catalyst::Engine::Apache::MP13';
2036 Catalyst::Exception->throw( message =>
2037 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2042 # install the correct mod_perl handler
2043 if ( $version >= 1.9901 ) {
2044 *handler = sub : method {
2045 shift->handle_request(@_);
2049 *handler = sub ($$) { shift->handle_request(@_) };
2054 elsif ( $software eq 'Zeus-Perl' ) {
2055 $engine = 'Catalyst::Engine::Zeus';
2059 Catalyst::Exception->throw(
2060 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2065 $engine = $class->engine_class;
2068 Class::MOP::load_class($engine);
2069 #unless (Class::Inspector->loaded($engine)) {
2070 # require Class::Inspector->filename($engine);
2073 # check for old engines that are no longer compatible
2075 if ( $engine->isa('Catalyst::Engine::Apache')
2076 && !Catalyst::Engine::Apache->VERSION )
2081 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2082 && Catalyst::Engine::Server->VERSION le '0.02' )
2087 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2088 && $engine->VERSION eq '0.01' )
2093 elsif ($engine->isa('Catalyst::Engine::Zeus')
2094 && $engine->VERSION eq '0.01' )
2100 Catalyst::Exception->throw( message =>
2101 qq/Engine "$engine" is not supported by this version of Catalyst/
2106 $class->engine( $engine->new );
2109 =head2 $c->setup_home
2111 Sets up the home directory.
2116 my ( $class, $home ) = @_;
2118 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2122 $home ||= Catalyst::Utils::home($class);
2125 #I remember recently being scolded for assigning config values like this
2126 $class->config->{home} ||= $home;
2127 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2131 =head2 $c->setup_log
2138 my ( $class, $debug ) = @_;
2140 unless ( $class->log ) {
2141 $class->log( Catalyst::Log->new );
2144 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2145 if ( defined($env_debug) ? $env_debug : $debug ) {
2147 #Moose todo: dying to be made a bool attribute
2148 *{"$class\::debug"} = sub { 1 };
2149 $class->log->debug('Debug messages enabled');
2153 =head2 $c->setup_plugins
2159 =head2 $c->setup_stats
2161 Sets up timing statistics class.
2166 my ( $class, $stats ) = @_;
2168 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2170 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2171 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2173 #Moose todo: dying to be made a bool attribute
2174 *{"$class\::use_stats"} = sub { 1 };
2175 $class->log->debug('Statistics enabled');
2180 =head2 $c->registered_plugins
2182 Returns a sorted list of the plugins which have either been stated in the
2183 import list or which have been added via C<< MyApp->plugin(@args); >>.
2185 If passed a given plugin name, it will report a boolean value indicating
2186 whether or not that plugin is loaded. A fully qualified name is required if
2187 the plugin name does not begin with C<Catalyst::Plugin::>.
2189 if ($c->registered_plugins('Some::Plugin')) {
2197 sub registered_plugins {
2199 return sort keys %{ $proto->_plugins } unless @_;
2201 return 1 if exists $proto->_plugins->{$plugin};
2202 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2205 sub _register_plugin {
2206 my ( $proto, $plugin, $instant ) = @_;
2207 my $class = ref $proto || $proto;
2209 # no ignore_loaded here, the plugin may already have been
2210 # defined in memory and we don't want to error on "no file" if so
2212 Class::MOP::load_class( $plugin );
2214 $proto->_plugins->{$plugin} = 1;
2217 if( $class->can('meta') ){
2218 my @superclasses = ($plugin, $class->meta->superclasses );
2219 $class->meta->superclasses(@superclasses);
2221 unshift @{"$class\::ISA"}, $plugin;
2228 my ( $class, $plugins ) = @_;
2230 $class->_plugins( {} ) unless $class->_plugins;
2232 for my $plugin ( reverse @$plugins ) {
2234 unless ( $plugin =~ s/\A\+// ) {
2235 $plugin = "Catalyst::Plugin::$plugin";
2238 $class->_register_plugin($plugin);
2245 Returns an arrayref of the internal execution stack (actions that are
2246 currently executing).
2248 =head2 $c->stats_class
2250 Returns or sets the stats (timing statistics) class.
2252 =head2 $c->use_stats
2254 Returns 1 when stats collection is enabled. Stats collection is enabled
2255 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2256 environment variable is set.
2258 Note that this is a static method, not an accessor and should be overloaded
2259 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2266 =head2 $c->write( $data )
2268 Writes $data to the output stream. When using this method directly, you
2269 will need to manually set the C<Content-Length> header to the length of
2270 your output data, if known.
2277 # Finalize headers if someone manually writes output
2278 $c->finalize_headers;
2280 return $c->engine->write( $c, @_ );
2285 Returns the Catalyst version number. Mostly useful for "powered by"
2286 messages in template systems.
2290 sub version { return $Catalyst::VERSION }
2292 =head1 INTERNAL ACTIONS
2294 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2295 C<_ACTION>, and C<_END>. These are by default not shown in the private
2296 action table, but you can make them visible with a config parameter.
2298 MyApp->config->{show_internal_actions} = 1;
2300 =head1 CASE SENSITIVITY
2302 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2303 mapped to C</foo/bar>. You can activate case sensitivity with a config
2306 MyApp->config->{case_sensitive} = 1;
2308 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2310 =head1 ON-DEMAND PARSER
2312 The request body is usually parsed at the beginning of a request,
2313 but if you want to handle input yourself, you can enable on-demand
2314 parsing with a config parameter.
2316 MyApp->config->{parse_on_demand} = 1;
2318 =head1 PROXY SUPPORT
2320 Many production servers operate using the common double-server approach,
2321 with a lightweight frontend web server passing requests to a larger
2322 backend server. An application running on the backend server must deal
2323 with two problems: the remote user always appears to be C<127.0.0.1> and
2324 the server's hostname will appear to be C<localhost> regardless of the
2325 virtual host that the user connected through.
2327 Catalyst will automatically detect this situation when you are running
2328 the frontend and backend servers on the same machine. The following
2329 changes are made to the request.
2331 $c->req->address is set to the user's real IP address, as read from
2332 the HTTP X-Forwarded-For header.
2334 The host value for $c->req->base and $c->req->uri is set to the real
2335 host, as read from the HTTP X-Forwarded-Host header.
2337 Obviously, your web server must support these headers for this to work.
2339 In a more complex server farm environment where you may have your
2340 frontend proxy server(s) on different machines, you will need to set a
2341 configuration option to tell Catalyst to read the proxied data from the
2344 MyApp->config->{using_frontend_proxy} = 1;
2346 If you do not wish to use the proxy support at all, you may set:
2348 MyApp->config->{ignore_frontend_proxy} = 1;
2350 =head1 THREAD SAFETY
2352 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2353 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2354 believe the Catalyst core to be thread-safe.
2356 If you plan to operate in a threaded environment, remember that all other
2357 modules you are using must also be thread-safe. Some modules, most notably
2358 L<DBD::SQLite>, are not thread-safe.
2364 Join #catalyst on irc.perl.org.
2368 http://lists.rawmode.org/mailman/listinfo/catalyst
2369 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2373 http://catalyst.perl.org
2377 http://dev.catalyst.perl.org
2381 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2383 =head2 L<Catalyst::Manual> - The Catalyst Manual
2385 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2387 =head2 L<Catalyst::Engine> - Core engine
2389 =head2 L<Catalyst::Log> - Log class.
2391 =head2 L<Catalyst::Request> - Request object
2393 =head2 L<Catalyst::Response> - Response object
2395 =head2 L<Catalyst::Test> - The test suite.
2469 Sebastian Riedel, C<sri@oook.de>
2473 This library is free software, you can redistribute it and/or modify it under
2474 the same terms as Perl itself.