5 extends 'Catalyst::Component';
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
13 use Catalyst::Controller;
14 use Devel::InnerPackage ();
16 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', default => sub { [] });
34 has stash => (is => 'rw', default => sub { {} });
35 has state => (is => 'rw', default => 0);
36 has stats => (is => 'rw');
37 has action => (is => 'rw');
38 has counter => (is => 'rw', default => sub { {} });
39 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
40 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
41 has namespace => (is => 'rw');
45 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
47 sub depth { scalar @{ shift->stack || [] }; }
48 sub comp { shift->component(@_) }
51 # carp "the use of req() is deprecated in favour of request()";
52 my $self = shift; return $self->request(@_);
55 # carp "the use of res() is deprecated in favour of response()";
56 my $self = shift; return $self->response(@_);
59 # For backwards compatibility
60 sub finalize_output { shift->finalize_body(@_) };
65 our $RECURSION = 1000;
66 our $DETACH = "catalyst_detach\n";
68 #I imagine that very few of these really need to be class variables. if any.
69 #maybe we should just make them attributes with a default?
70 __PACKAGE__->mk_classdata($_)
71 for qw/components arguments dispatcher engine log dispatcher_class
72 engine_class context_class request_class response_class stats_class
75 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
76 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
77 __PACKAGE__->request_class('Catalyst::Request');
78 __PACKAGE__->response_class('Catalyst::Response');
79 __PACKAGE__->stats_class('Catalyst::Stats');
81 # Remember to update this in Catalyst::Runtime as well!
83 our $VERSION = '5.7013';
86 my ( $class, @arguments ) = @_;
88 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
90 return unless $class eq 'Catalyst';
92 my $caller = caller(0);
94 #why does called have to ISA Catalyst and ISA Controller ?
95 #Convert test suite to not use the behavior where Myapp ISA Controller
96 # after that is done we can eliminate that little mess.
97 unless ( $caller->isa('Catalyst') ) {
99 if( $caller->can('meta') ){
100 my @superclasses = ($caller->meta->superclasses, $class, 'Catalyst::Controller');
101 #my @superclasses = ($caller->meta->superclasses, $class);
102 $caller->meta->superclasses(@superclasses);
104 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
105 #push @{"$caller\::ISA"}, $class;
109 $caller->arguments( [@arguments] );
115 Catalyst - The Elegant MVC Web Application Framework
119 See the L<Catalyst::Manual> distribution for comprehensive
120 documentation and tutorials.
122 # Install Catalyst::Devel for helpers and other development tools
123 # use the helper to create a new application
126 # add models, views, controllers
127 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
128 script/myapp_create.pl view MyTemplate TT
129 script/myapp_create.pl controller Search
131 # built in testserver -- use -r to restart automatically on changes
132 # --help to see all available options
133 script/myapp_server.pl
135 # command line testing interface
136 script/myapp_test.pl /yada
139 use Catalyst qw/-Debug/; # include plugins here as well
141 ### In lib/MyApp/Controller/Root.pm (autocreated)
142 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
143 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
144 $c->stash->{template} = 'foo.tt'; # set the template
145 # lookup something from db -- stash vars are passed to TT
147 $c->model('Database::Foo')->search( { country => $args[0] } );
148 if ( $c->req->params->{bar} ) { # access GET or POST parameters
149 $c->forward( 'bar' ); # process another action
150 # do something else after forward returns
154 # The foo.tt TT template can use the stash data from the database
155 [% WHILE (item = data.next) %]
159 # called for /bar/of/soap, /bar/of/soap/10, etc.
160 sub bar : Path('/bar/of/soap') { ... }
162 # called for all actions, from the top-most controller downwards
164 my ( $self, $c ) = @_;
165 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
166 $c->res->redirect( '/login' ); # require login
167 return 0; # abort request and go immediately to end()
169 return 1; # success; carry on to next action
172 # called after all actions are finished
174 my ( $self, $c ) = @_;
175 if ( scalar @{ $c->error } ) { ... } # handle errors
176 return if $c->res->body; # already have a response
177 $c->forward( 'MyApp::View::TT' ); # render template
180 ### in MyApp/Controller/Foo.pm
181 # called for /foo/bar
182 sub bar : Local { ... }
184 # called for /blargle
185 sub blargle : Global { ... }
187 # an index action matches /foo, but not /foo/1, etc.
188 sub index : Private { ... }
190 ### in MyApp/Controller/Foo/Bar.pm
191 # called for /foo/bar/baz
192 sub baz : Local { ... }
194 # first Root auto is called, then Foo auto, then this
195 sub auto : Private { ... }
197 # powerful regular expression paths are also possible
198 sub details : Regex('^product/(\w+)/details$') {
199 my ( $self, $c ) = @_;
200 # extract the (\w+) from the URI
201 my $product = $c->req->captures->[0];
204 See L<Catalyst::Manual::Intro> for additional information.
208 Catalyst is a modern framework for making web applications without the
209 pain usually associated with this process. This document is a reference
210 to the main Catalyst application. If you are a new user, we suggest you
211 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
213 See L<Catalyst::Manual> for more documentation.
215 Catalyst plugins can be loaded by naming them as arguments to the "use
216 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
217 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
220 use Catalyst qw/My::Module/;
222 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
223 fully qualify the name by using a unary plus:
227 +Fully::Qualified::Plugin::Name
230 Special flags like C<-Debug> and C<-Engine> can also be specified as
231 arguments when Catalyst is loaded:
233 use Catalyst qw/-Debug My::Module/;
235 The position of plugins and flags in the chain is important, because
236 they are loaded in the order in which they appear.
238 The following flags are supported:
242 Enables debug output. You can also force this setting from the system
243 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
244 settings override the application, with <MYAPP>_DEBUG having the highest
249 Forces Catalyst to use a specific engine. Omit the
250 C<Catalyst::Engine::> prefix of the engine name, i.e.:
252 use Catalyst qw/-Engine=CGI/;
256 Forces Catalyst to use a specific home directory, e.g.:
258 use Catalyst qw[-Home=/usr/mst];
260 This can also be done in the shell environment by setting either the
261 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
262 is replaced with the uppercased name of your application, any "::" in
263 the name will be replaced with underscores, e.g. MyApp::Web should use
264 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
272 Enables statistics collection and reporting. You can also force this setting
273 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
274 environment settings override the application, with <MYAPP>_STATS having the
279 use Catalyst qw/-Stats=1/
283 =head2 INFORMATION ABOUT THE CURRENT REQUEST
287 Returns a L<Catalyst::Action> object for the current action, which
288 stringifies to the action name. See L<Catalyst::Action>.
292 Returns the namespace of the current action, i.e., the URI prefix
293 corresponding to the controller of the current action. For example:
295 # in Controller::Foo::Bar
296 $c->namespace; # returns 'foo/bar';
302 Returns the current L<Catalyst::Request> object, giving access to
303 information about the current client request (including parameters,
304 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
306 =head2 REQUEST FLOW HANDLING
308 =head2 $c->forward( $action [, \@arguments ] )
310 =head2 $c->forward( $class, $method, [, \@arguments ] )
312 Forwards processing to another action, by its private name. If you give a
313 class name but no method, C<process()> is called. You may also optionally
314 pass arguments in an arrayref. The action will receive the arguments in
315 C<@_> and C<< $c->req->args >>. Upon returning from the function,
316 C<< $c->req->args >> will be restored to the previous values.
318 Any data C<return>ed from the action forwarded to, will be returned by the
321 my $foodata = $c->forward('/foo');
322 $c->forward('index');
323 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
324 $c->forward('MyApp::View::TT');
326 Note that forward implies an C<<eval { }>> around the call (actually
327 C<execute> does), thus de-fatalizing all 'dies' within the called
328 action. If you want C<die> to propagate you need to do something like:
331 die $c->error if $c->error;
333 Or make sure to always return true values from your actions and write
336 $c->forward('foo') || return;
340 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
342 =head2 $c->detach( $action [, \@arguments ] )
344 =head2 $c->detach( $class, $method, [, \@arguments ] )
348 The same as C<forward>, but doesn't return to the previous action when
349 processing is finished.
351 When called with no arguments it escapes the processing chain entirely.
355 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
361 Returns the current L<Catalyst::Response> object, see there for details.
365 Returns a hashref to the stash, which may be used to store data and pass
366 it between components during a request. You can also set hash keys by
367 passing arguments. The stash is automatically sent to the view. The
368 stash is cleared at the end of a request; it cannot be used for
369 persistent storage (for this you must use a session; see
370 L<Catalyst::Plugin::Session> for a complete system integrated with
373 $c->stash->{foo} = $bar;
374 $c->stash( { moose => 'majestic', qux => 0 } );
375 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
377 # stash is automatically passed to the view for use in a template
378 $c->forward( 'MyApp::View::TT' );
385 my $stash = @_ > 1 ? {@_} : $_[0];
386 croak('stash takes a hash or hashref') unless ref $stash;
387 foreach my $key ( keys %$stash ) {
388 #shouldn't we hold this in a var and save ourselves the subcall?
389 $c->next::method->{$key} = $stash->{$key};
393 return $c->next::method;
399 =head2 $c->error($error, ...)
401 =head2 $c->error($arrayref)
403 Returns an arrayref containing error messages. If Catalyst encounters an
404 error while processing a request, it stores the error in $c->error. This
405 method should only be used to store fatal error messages.
407 my @error = @{ $c->error };
411 $c->error('Something bad happened');
418 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
419 croak @$error unless ref $c;
420 push @{ $c->{error} }, @$error;
422 elsif ( defined $_[0] ) { $c->{error} = undef }
423 return $c->{error} || [];
429 Contains the return value of the last executed action.
431 =head2 $c->clear_errors
433 Clear errors. You probably don't want to clear the errors unless you are
434 implementing a custom error screen.
436 This is equivalent to running
450 my ( $c, @names ) = @_;
452 foreach my $name (@names) {
453 foreach my $component ( keys %{ $c->components } ) {
454 return $c->components->{$component} if $component =~ /$name/i;
461 # try explicit component names
463 my ( $c, @names ) = @_;
465 foreach my $try (@names) {
466 return $c->components->{$try} if ( exists $c->components->{$try} );
472 # like component, but try just these prefixes before regex searching,
473 # and do not try to return "sort keys %{ $c->components }"
475 my ( $c, $name, @prefixes ) = @_;
477 my $appclass = ref $c || $c;
479 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
481 my $comp = $c->_comp_explicit(@names);
482 return $comp if defined($comp);
483 $comp = $c->_comp_search($name);
487 # Find possible names for a prefix
490 my ( $c, @prefixes ) = @_;
492 my $appclass = ref $c || $c;
494 my @pre = map { "${appclass}::${_}::" } @prefixes;
498 COMPONENT: foreach my $comp ($c->component) {
499 foreach my $p (@pre) {
500 if ($comp =~ s/^$p//) {
510 # Return a component if only one matches.
512 my ( $c, @prefixes ) = @_;
514 my $appclass = ref $c || $c;
516 my ( $comp, $rest ) =
517 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
518 return $comp unless $rest;
521 # Filter a component before returning by calling ACCEPT_CONTEXT if available
522 sub _filter_component {
523 my ( $c, $comp, @args ) = @_;
524 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
525 return $comp->ACCEPT_CONTEXT( $c, @args );
527 else { return $comp }
530 =head2 COMPONENT ACCESSORS
532 =head2 $c->controller($name)
534 Gets a L<Catalyst::Controller> instance by name.
536 $c->controller('Foo')->do_stuff;
538 If the name is omitted, will return the controller for the dispatched
544 my ( $c, $name, @args ) = @_;
545 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
548 return $c->component( $c->action->class );
551 =head2 $c->model($name)
553 Gets a L<Catalyst::Model> instance by name.
555 $c->model('Foo')->do_stuff;
557 Any extra arguments are directly passed to ACCEPT_CONTEXT.
559 If the name is omitted, it will look for
560 - a model object in $c->stash{current_model_instance}, then
561 - a model name in $c->stash->{current_model}, then
562 - a config setting 'default_model', or
563 - check if there is only one model, and return it if that's the case.
568 my ( $c, $name, @args ) = @_;
569 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
573 return $c->stash->{current_model_instance}
574 if $c->stash->{current_model_instance};
575 return $c->model( $c->stash->{current_model} )
576 if $c->stash->{current_model};
578 return $c->model( $c->config->{default_model} )
579 if $c->config->{default_model};
580 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
584 =head2 $c->controllers
586 Returns the available names which can be passed to $c->controller
592 return $c->_comp_names(qw/Controller C/);
596 =head2 $c->view($name)
598 Gets a L<Catalyst::View> instance by name.
600 $c->view('Foo')->do_stuff;
602 Any extra arguments are directly passed to ACCEPT_CONTEXT.
604 If the name is omitted, it will look for
605 - a view object in $c->stash{current_view_instance}, then
606 - a view name in $c->stash->{current_view}, then
607 - a config setting 'default_view', or
608 - check if there is only one view, and return it if that's the case.
613 my ( $c, $name, @args ) = @_;
614 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
618 return $c->stash->{current_view_instance}
619 if $c->stash->{current_view_instance};
620 return $c->view( $c->stash->{current_view} )
621 if $c->stash->{current_view};
623 return $c->view( $c->config->{default_view} )
624 if $c->config->{default_view};
625 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
630 Returns the available names which can be passed to $c->model
636 return $c->_comp_names(qw/Model M/);
642 Returns the available names which can be passed to $c->view
648 return $c->_comp_names(qw/View V/);
651 =head2 $c->comp($name)
653 =head2 $c->component($name)
655 Gets a component object by name. This method is not recommended,
656 unless you want to get a specific component by full
657 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
658 should be used instead.
669 my $appclass = ref $c || $c;
672 $name, "${appclass}::${name}",
673 map { "${appclass}::${_}::${name}" }
674 qw/Model M Controller C View V/
677 my $comp = $c->_comp_explicit(@names);
678 return $c->_filter_component( $comp, @_ ) if defined($comp);
680 $comp = $c->_comp_search($name);
681 return $c->_filter_component( $comp, @_ ) if defined($comp);
684 return sort keys %{ $c->components };
689 =head2 CLASS DATA AND HELPER CLASSES
693 Returns or takes a hashref containing the application's configuration.
695 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
697 You can also use a C<YAML>, C<XML> or C<Config::General> config file
698 like myapp.yml in your applications home directory. See
699 L<Catalyst::Plugin::ConfigLoader>.
702 db: dsn:SQLite:foo.db
710 $c->log->warn("Setting config after setup has been run is not a good idea.")
711 if ( @_ and $c->setup_finished );
713 $c->next::method(@_);
718 Returns the logging object instance. Unless it is already set, Catalyst
719 sets this up with a L<Catalyst::Log> object. To use your own log class,
720 set the logger with the C<< __PACKAGE__->log >> method prior to calling
721 C<< __PACKAGE__->setup >>.
723 __PACKAGE__->log( MyLogger->new );
728 $c->log->info( 'Now logging with my own logger!' );
730 Your log class should implement the methods described in
736 Overload to enable debug messages (same as -Debug option).
738 Note that this is a static method, not an accessor and should be overloaded
739 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
745 =head2 $c->dispatcher
747 Returns the dispatcher instance. Stringifies to class name. See
748 L<Catalyst::Dispatcher>.
752 Returns the engine instance. Stringifies to the class name. See
756 =head2 UTILITY METHODS
758 =head2 $c->path_to(@path)
760 Merges C<@path> with C<< $c->config->{home} >> and returns a
761 L<Path::Class::Dir> object.
765 $c->path_to( 'db', 'sqlite.db' );
770 my ( $c, @path ) = @_;
771 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
772 if ( -d $path ) { return $path }
773 else { return Path::Class::File->new( $c->config->{home}, @path ) }
776 =head2 $c->plugin( $name, $class, @args )
778 Helper method for plugins. It creates a classdata accessor/mutator and
779 loads and instantiates the given class.
781 MyApp->plugin( 'prototype', 'HTML::Prototype' );
783 $c->prototype->define_javascript_functions;
788 my ( $class, $name, $plugin, @args ) = @_;
789 $class->_register_plugin( $plugin, 1 );
791 eval { $plugin->import };
792 $class->mk_classdata($name);
794 eval { $obj = $plugin->new(@args) };
797 Catalyst::Exception->throw( message =>
798 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
802 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
808 Initializes the dispatcher and engine, loads any plugins, and loads the
809 model, view, and controller components. You may also specify an array
810 of plugins to load here, if you choose to not load them in the C<use
814 MyApp->setup( qw/-Debug/ );
819 my ( $class, @arguments ) = @_;
821 $class->log->warn("Running setup twice is not a good idea.")
822 if ( $class->setup_finished );
824 unless ( $class->isa('Catalyst') ) {
826 Catalyst::Exception->throw(
827 message => qq/'$class' does not inherit from Catalyst/ );
830 if ( $class->arguments ) {
831 @arguments = ( @arguments, @{ $class->arguments } );
837 foreach (@arguments) {
841 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
843 elsif (/^-(\w+)=?(.*)$/) {
844 $flags->{ lc $1 } = $2;
847 push @{ $flags->{plugins} }, $_;
851 $class->setup_home( delete $flags->{home} );
853 $class->setup_log( delete $flags->{log} );
854 $class->setup_plugins( delete $flags->{plugins} );
855 $class->setup_dispatcher( delete $flags->{dispatcher} );
856 $class->setup_engine( delete $flags->{engine} );
857 $class->setup_stats( delete $flags->{stats} );
859 for my $flag ( sort keys %{$flags} ) {
861 if ( my $code = $class->can( 'setup_' . $flag ) ) {
862 &$code( $class, delete $flags->{$flag} );
865 $class->log->warn(qq/Unknown flag "$flag"/);
869 eval { require Catalyst::Devel; };
870 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
871 $class->log->warn(<<"EOF");
872 You are running an old script!
874 Please update by running (this will overwrite existing files):
875 catalyst.pl -force -scripts $class
877 or (this will not overwrite existing files):
878 catalyst.pl -scripts $class
883 if ( $class->debug ) {
884 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
887 my $t = Text::SimpleTable->new(74);
888 $t->row($_) for @plugins;
889 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
892 my $dispatcher = $class->dispatcher;
893 my $engine = $class->engine;
894 my $home = $class->config->{home};
896 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
897 $class->log->debug(qq/Loaded engine "$engine"/);
901 ? $class->log->debug(qq/Found home "$home"/)
902 : $class->log->debug(qq/Home "$home" doesn't exist/)
903 : $class->log->debug(q/Couldn't find home/);
908 no warnings qw/redefine/;
909 local *setup = sub { };
913 # Initialize our data structure
914 $class->components( {} );
916 $class->setup_components;
918 if ( $class->debug ) {
919 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
920 for my $comp ( sort keys %{ $class->components } ) {
921 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
922 $t->row( $comp, $type );
924 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
925 if ( keys %{ $class->components } );
928 # Add our self to components, since we are also a component
929 $class->components->{$class} = $class;
931 $class->setup_actions;
933 if ( $class->debug ) {
934 my $name = $class->config->{name} || 'Application';
935 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
937 $class->log->_flush() if $class->log->can('_flush');
939 $class->setup_finished(1);
942 =head2 $c->uri_for( $path, @args?, \%query_values? )
944 Merges path with C<< $c->request->base >> for absolute URIs and with
945 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
946 object. If any args are passed, they are added at the end of the path.
947 If the last argument to C<uri_for> is a hash reference, it is assumed to
948 contain GET parameter key/value pairs, which will be appended to the URI
951 Note that uri_for is destructive to the passed hashref. Subsequent calls
952 with the same hashref may have unintended results.
954 Instead of C<$path>, you can also optionally pass a C<$action> object
955 which will be resolved to a path using
956 C<< $c->dispatcher->uri_for_action >>; if the first element of
957 C<@args> is an arrayref it is treated as a list of captures to be passed
958 to C<uri_for_action>.
963 my ( $c, $path, @args ) = @_;
965 if ( Scalar::Util::blessed($path) ) { # action object
966 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
969 $path = $c->dispatcher->uri_for_action($path, $captures);
970 return undef unless defined($path);
971 $path = '/' if $path eq '';
974 undef($path) if (defined $path && $path eq '');
977 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
979 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
980 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
982 unshift(@args, $path);
984 unless (defined $path && $path =~ s!^/!!) { # in-place strip
985 my $namespace = $c->namespace;
986 if (defined $path) { # cheesy hack to handle path '../foo'
987 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
989 unshift(@args, $namespace || '');
992 # join args with '/', or a blank string
993 my $args = join('/', grep { defined($_) } @args);
994 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
996 my $base = $c->req->base;
997 my $class = ref($base);
998 $base =~ s{(?<!/)$}{/};
1002 if (my @keys = keys %$params) {
1003 # somewhat lifted from URI::_query's query_form
1004 $query = '?'.join('&', map {
1005 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1008 my $val = $params->{$_};
1009 $val = '' unless defined $val;
1012 utf8::encode( $_ ) if utf8::is_utf8($_);
1013 # using the URI::Escape pattern here so utf8 chars survive
1014 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1016 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1020 my $res = bless(\"${base}${args}${query}", $class);
1024 =head2 $c->welcome_message
1026 Returns the Catalyst welcome HTML page.
1030 sub welcome_message {
1032 my $name = $c->config->{name};
1033 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1034 my $prefix = Catalyst::Utils::appprefix( ref $c );
1035 $c->response->content_type('text/html; charset=utf-8');
1037 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1038 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1039 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1041 <meta http-equiv="Content-Language" content="en" />
1042 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1043 <title>$name on Catalyst $VERSION</title>
1044 <style type="text/css">
1047 background-color: #eee;
1054 margin-bottom: 10px;
1056 background-color: #ccc;
1057 border: 1px solid #aaa;
1062 font-family: verdana, tahoma, sans-serif;
1065 font-family: verdana, tahoma, sans-serif;
1068 text-decoration: none;
1070 border-bottom: 1px dotted #bbb;
1072 :link:hover, :visited:hover {
1085 background-color: #fff;
1086 border: 1px solid #aaa;
1090 font-weight: normal;
1112 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1117 <img src="$logo" alt="Catalyst Logo" />
1119 <p>Welcome to the world of Catalyst.
1120 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1121 framework will make web development something you had
1122 never expected it to be: Fun, rewarding, and quick.</p>
1123 <h2>What to do now?</h2>
1124 <p>That really depends on what <b>you</b> want to do.
1125 We do, however, provide you with a few starting points.</p>
1126 <p>If you want to jump right into web development with Catalyst
1127 you might want want to start with a tutorial.</p>
1128 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1130 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1132 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1133 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1135 <h2>What to do next?</h2>
1136 <p>Next it's time to write an actual application. Use the
1137 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1138 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1139 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1140 they can save you a lot of work.</p>
1141 <pre><code>script/${prefix}_create.pl -help</code></pre>
1142 <p>Also, be sure to check out the vast and growing
1143 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1144 you are likely to find what you need there.
1148 <p>Catalyst has a very active community. Here are the main places to
1149 get in touch with us.</p>
1152 <a href="http://dev.catalyst.perl.org">Wiki</a>
1155 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1158 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1161 <h2>In conclusion</h2>
1162 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1163 as we enjoyed making it. Please contact us if you have ideas
1164 for improvement or other feedback.</p>
1172 =head1 INTERNAL METHODS
1174 These methods are not meant to be used by end users.
1176 =head2 $c->components
1178 Returns a hash of components.
1180 =head2 $c->context_class
1182 Returns or sets the context class.
1186 Returns a hashref containing coderefs and execution counts (needed for
1187 deep recursion detection).
1191 Returns the number of actions on the current internal execution stack.
1195 Dispatches a request to actions.
1199 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1201 =head2 $c->dispatcher_class
1203 Returns or sets the dispatcher class.
1205 =head2 $c->dump_these
1207 Returns a list of 2-element array references (name, structure) pairs
1208 that will be dumped on the error page in debug mode.
1214 [ Request => $c->req ],
1215 [ Response => $c->res ],
1216 [ Stash => $c->stash ],
1217 [ Config => $c->config ];
1220 =head2 $c->engine_class
1222 Returns or sets the engine class.
1224 =head2 $c->execute( $class, $coderef )
1226 Execute a coderef in given class and catch exceptions. Errors are available
1232 my ( $c, $class, $code ) = @_;
1233 $class = $c->component($class) || $class;
1236 if ( $c->depth >= $RECURSION ) {
1237 my $action = $code->reverse();
1238 $action = "/$action" unless $action =~ /->/;
1239 my $error = qq/Deep recursion detected calling "${action}"/;
1240 $c->log->error($error);
1246 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1248 push( @{ $c->stack }, $code );
1250 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1252 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1254 my $last = pop( @{ $c->stack } );
1256 if ( my $error = $@ ) {
1257 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1259 unless ( ref $error ) {
1260 no warnings 'uninitialized';
1262 my $class = $last->class;
1263 my $name = $last->name;
1264 $error = qq/Caught exception in $class->$name "$error"/;
1273 sub _stats_start_execute {
1274 my ( $c, $code ) = @_;
1276 return if ( ( $code->name =~ /^_.*/ )
1277 && ( !$c->config->{show_internal_actions} ) );
1279 my $action_name = $code->reverse();
1280 $c->counter->{$action_name}++;
1282 my $action = $action_name;
1283 $action = "/$action" unless $action =~ /->/;
1285 # determine if the call was the result of a forward
1286 # this is done by walking up the call stack and looking for a calling
1287 # sub of Catalyst::forward before the eval
1289 for my $index ( 2 .. 11 ) {
1291 if ( ( caller($index) )[0] eq 'Catalyst'
1292 && ( caller($index) )[3] eq '(eval)' );
1294 if ( ( caller($index) )[3] =~ /forward$/ ) {
1295 $callsub = ( caller($index) )[3];
1296 $action = "-> $action";
1301 my $uid = $action_name . $c->counter->{$action_name};
1303 # is this a root-level call or a forwarded call?
1304 if ( $callsub =~ /forward$/ ) {
1306 # forward, locate the caller
1307 if ( my $parent = $c->stack->[-1] ) {
1310 parent => "$parent" . $c->counter->{"$parent"},
1316 # forward with no caller may come from a plugin
1335 sub _stats_finish_execute {
1336 my ( $c, $info ) = @_;
1337 $c->stats->profile( end => $info );
1340 =head2 $c->_localize_fields( sub { }, \%keys );
1344 #Why does this exist? This is no longer safe and WILL NOT WORK.
1345 # it doesnt seem to be used anywhere. can we remove it?
1346 sub _localize_fields {
1347 my ( $c, $localized, $code ) = ( @_ );
1349 my $request = delete $localized->{request} || {};
1350 my $response = delete $localized->{response} || {};
1352 local @{ $c }{ keys %$localized } = values %$localized;
1353 local @{ $c->request }{ keys %$request } = values %$request;
1354 local @{ $c->response }{ keys %$response } = values %$response;
1361 Finalizes the request.
1368 for my $error ( @{ $c->error } ) {
1369 $c->log->error($error);
1372 # Allow engine to handle finalize flow (for POE)
1373 my $engine = $c->engine;
1374 if ( my $code = $engine->can('finalize') ) {
1379 $c->finalize_uploads;
1382 if ( $#{ $c->error } >= 0 ) {
1386 $c->finalize_headers;
1389 if ( $c->request->method eq 'HEAD' ) {
1390 $c->response->body('');
1396 if ($c->use_stats) {
1397 my $elapsed = sprintf '%f', $c->stats->elapsed;
1398 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1400 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1403 return $c->response->status;
1406 =head2 $c->finalize_body
1412 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1414 =head2 $c->finalize_cookies
1420 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1422 =head2 $c->finalize_error
1428 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1430 =head2 $c->finalize_headers
1436 sub finalize_headers {
1439 my $response = $c->response; #accessor calls can add up?
1441 # Check if we already finalized headers
1442 return if $response->finalized_headers;
1445 if ( my $location = $response->redirect ) {
1446 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1447 $response->header( Location => $location );
1449 #Moose TODO: we should probably be using a predicate method here ?
1450 if ( !$response->body ) {
1451 # Add a default body if none is already present
1453 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1459 if ( $response->body && !$response->content_length ) {
1461 # get the length from a filehandle
1462 if ( blessed( $response->body ) && $response->body->can('read') )
1464 my $stat = stat $response->body;
1465 if ( $stat && $stat->size > 0 ) {
1466 $response->content_length( $stat->size );
1469 $c->log->warn('Serving filehandle without a content-length');
1473 # everything should be bytes at this point, but just in case
1474 $response->content_length( bytes::length( $response->body ) );
1479 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1480 $response->headers->remove_header("Content-Length");
1481 $response->body('');
1484 $c->finalize_cookies;
1486 $c->engine->finalize_headers( $c, @_ );
1489 $response->finalized_headers(1);
1492 =head2 $c->finalize_output
1494 An alias for finalize_body.
1496 =head2 $c->finalize_read
1498 Finalizes the input after reading is complete.
1502 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1504 =head2 $c->finalize_uploads
1506 Finalizes uploads. Cleans up any temporary files.
1510 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1512 =head2 $c->get_action( $action, $namespace )
1514 Gets an action in a given namespace.
1518 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1520 =head2 $c->get_actions( $action, $namespace )
1522 Gets all actions of a given name in a namespace and all parent
1527 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1529 =head2 $c->handle_request( $class, @arguments )
1531 Called to handle each HTTP request.
1535 sub handle_request {
1536 my ( $class, @arguments ) = @_;
1538 # Always expect worst case!
1541 if ($class->debug) {
1542 my $secs = time - $START || 1;
1543 my $av = sprintf '%.3f', $COUNT / $secs;
1544 my $time = localtime time;
1545 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1548 my $c = $class->prepare(@arguments);
1550 $status = $c->finalize;
1553 if ( my $error = $@ ) {
1555 $class->log->error(qq/Caught exception in engine "$error"/);
1560 if(my $coderef = $class->log->can('_flush')){
1561 $class->log->$coderef();
1566 =head2 $c->prepare( @arguments )
1568 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1574 my ( $class, @arguments ) = @_;
1577 # After the app/ctxt split, this should become an attribute based on something passed
1578 # into the application.
1579 $class->context_class( ref $class || $class ) unless $class->context_class;
1581 my $c = $class->context_class->new({});
1583 # For on-demand data
1584 $c->request->_context($c);
1585 $c->response->_context($c);
1587 #surely this is not the most efficient way to do things...
1588 $c->stats($class->stats_class->new)->enable($c->use_stats);
1590 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1593 #XXX reuse coderef from can
1594 # Allow engine to direct the prepare flow (for POE)
1595 if ( $c->engine->can('prepare') ) {
1596 $c->engine->prepare( $c, @arguments );
1599 $c->prepare_request(@arguments);
1600 $c->prepare_connection;
1601 $c->prepare_query_parameters;
1602 $c->prepare_headers;
1603 $c->prepare_cookies;
1606 # Prepare the body for reading, either by prepare_body
1607 # or the user, if they are using $c->read
1610 # Parse the body unless the user wants it on-demand
1611 unless ( $c->config->{parse_on_demand} ) {
1616 my $method = $c->req->method || '';
1617 my $path = $c->req->path || '/';
1618 my $address = $c->req->address || '';
1620 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1628 =head2 $c->prepare_action
1630 Prepares action. See L<Catalyst::Dispatcher>.
1634 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1636 =head2 $c->prepare_body
1638 Prepares message body.
1645 #Moose TODO: what is _body ??
1646 # Do we run for the first time?
1647 return if defined $c->request->{_body};
1649 # Initialize on-demand data
1650 $c->engine->prepare_body( $c, @_ );
1651 $c->prepare_parameters;
1652 $c->prepare_uploads;
1654 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1655 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1656 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1657 my $param = $c->req->body_parameters->{$key};
1658 my $value = defined($param) ? $param : '';
1660 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1662 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1666 =head2 $c->prepare_body_chunk( $chunk )
1668 Prepares a chunk of data before sending it to L<HTTP::Body>.
1670 See L<Catalyst::Engine>.
1674 sub prepare_body_chunk {
1676 $c->engine->prepare_body_chunk( $c, @_ );
1679 =head2 $c->prepare_body_parameters
1681 Prepares body parameters.
1685 sub prepare_body_parameters {
1687 $c->engine->prepare_body_parameters( $c, @_ );
1690 =head2 $c->prepare_connection
1692 Prepares connection.
1696 sub prepare_connection {
1698 $c->engine->prepare_connection( $c, @_ );
1701 =head2 $c->prepare_cookies
1707 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1709 =head2 $c->prepare_headers
1715 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1717 =head2 $c->prepare_parameters
1719 Prepares parameters.
1723 sub prepare_parameters {
1725 $c->prepare_body_parameters;
1726 $c->engine->prepare_parameters( $c, @_ );
1729 =head2 $c->prepare_path
1731 Prepares path and base.
1735 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1737 =head2 $c->prepare_query_parameters
1739 Prepares query parameters.
1743 sub prepare_query_parameters {
1746 $c->engine->prepare_query_parameters( $c, @_ );
1748 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1749 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1750 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1751 my $param = $c->req->query_parameters->{$key};
1752 my $value = defined($param) ? $param : '';
1754 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1756 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1760 =head2 $c->prepare_read
1762 Prepares the input for reading.
1766 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1768 =head2 $c->prepare_request
1770 Prepares the engine request.
1774 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1776 =head2 $c->prepare_uploads
1782 sub prepare_uploads {
1785 $c->engine->prepare_uploads( $c, @_ );
1787 if ( $c->debug && keys %{ $c->request->uploads } ) {
1788 my $t = Text::SimpleTable->new(
1789 [ 12, 'Parameter' ],
1794 for my $key ( sort keys %{ $c->request->uploads } ) {
1795 my $upload = $c->request->uploads->{$key};
1796 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1797 $t->row( $key, $u->filename, $u->type, $u->size );
1800 $c->log->debug( "File Uploads are:\n" . $t->draw );
1804 =head2 $c->prepare_write
1806 Prepares the output for writing.
1810 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1812 =head2 $c->request_class
1814 Returns or sets the request class.
1816 =head2 $c->response_class
1818 Returns or sets the response class.
1820 =head2 $c->read( [$maxlength] )
1822 Reads a chunk of data from the request body. This method is designed to
1823 be used in a while loop, reading C<$maxlength> bytes on every call.
1824 C<$maxlength> defaults to the size of the request if not specified.
1826 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1829 Warning: If you use read(), Catalyst will not process the body,
1830 so you will not be able to access POST parameters or file uploads via
1831 $c->request. You must handle all body parsing yourself.
1835 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1843 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1845 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1847 Sets an action in a given namespace.
1851 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1853 =head2 $c->setup_actions($component)
1855 Sets up actions for a component.
1859 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1861 =head2 $c->setup_components
1863 Sets up components. Specify a C<setup_components> config option to pass
1864 additional options directly to L<Module::Pluggable>. To add additional
1865 search paths, specify a key named C<search_extra> as an array
1866 reference. Items in the array beginning with C<::> will have the
1867 application class name prepended to them.
1871 sub setup_components {
1874 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1875 my $config = $class->config->{ setup_components };
1876 my $extra = delete $config->{ search_extra } || [];
1878 push @paths, @$extra;
1880 my $locator = Module::Pluggable::Object->new(
1881 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1885 my @comps = sort { length $a <=> length $b } $locator->plugins;
1886 my %comps = map { $_ => 1 } @comps;
1888 for my $component ( @comps ) {
1890 # We pass ignore_loaded here so that overlay files for (e.g.)
1891 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1892 # we know M::P::O found a file on disk so this is safe
1894 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1895 #Class::MOP::load_class($component);
1897 my $module = $class->setup_component( $component );
1899 $component => $module,
1901 $_ => $class->setup_component( $_ )
1903 not exists $comps{$_}
1904 } Devel::InnerPackage::list_packages( $component )
1907 for my $key ( keys %modules ) {
1908 $class->components->{ $key } = $modules{ $key };
1913 =head2 $c->setup_component
1917 sub setup_component {
1918 my( $class, $component ) = @_;
1920 unless ( $component->can( 'COMPONENT' ) ) {
1924 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1925 my $config = $class->config->{ $suffix } || {};
1927 my $instance = eval { $component->COMPONENT( $class, $config ); };
1929 if ( my $error = $@ ) {
1931 Catalyst::Exception->throw(
1932 message => qq/Couldn't instantiate component "$component", "$error"/
1936 Catalyst::Exception->throw(
1938 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1939 ) unless eval { $instance->can( 'can' ) };
1944 =head2 $c->setup_dispatcher
1950 sub setup_dispatcher {
1951 my ( $class, $dispatcher ) = @_;
1954 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1957 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1958 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1961 unless ($dispatcher) {
1962 $dispatcher = $class->dispatcher_class;
1965 Class::MOP::load_class($dispatcher);
1967 # dispatcher instance
1968 $class->dispatcher( $dispatcher->new );
1971 =head2 $c->setup_engine
1978 my ( $class, $engine ) = @_;
1981 $engine = 'Catalyst::Engine::' . $engine;
1984 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
1985 $engine = 'Catalyst::Engine::' . $env;
1988 if ( $ENV{MOD_PERL} ) {
1990 # create the apache method
1993 *{"$class\::apache"} = sub { shift->engine->apache };
1996 my ( $software, $version ) =
1997 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2000 $version =~ s/(\.[^.]+)\./$1/g;
2002 if ( $software eq 'mod_perl' ) {
2006 if ( $version >= 1.99922 ) {
2007 $engine = 'Catalyst::Engine::Apache2::MP20';
2010 elsif ( $version >= 1.9901 ) {
2011 $engine = 'Catalyst::Engine::Apache2::MP19';
2014 elsif ( $version >= 1.24 ) {
2015 $engine = 'Catalyst::Engine::Apache::MP13';
2019 Catalyst::Exception->throw( message =>
2020 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2025 # install the correct mod_perl handler
2026 if ( $version >= 1.9901 ) {
2027 *handler = sub : method {
2028 shift->handle_request(@_);
2032 *handler = sub ($$) { shift->handle_request(@_) };
2037 elsif ( $software eq 'Zeus-Perl' ) {
2038 $engine = 'Catalyst::Engine::Zeus';
2042 Catalyst::Exception->throw(
2043 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2048 $engine = $class->engine_class;
2051 Class::MOP::load_class($engine);
2052 #unless (Class::Inspector->loaded($engine)) {
2053 # require Class::Inspector->filename($engine);
2056 # check for old engines that are no longer compatible
2058 if ( $engine->isa('Catalyst::Engine::Apache')
2059 && !Catalyst::Engine::Apache->VERSION )
2064 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2065 && Catalyst::Engine::Server->VERSION le '0.02' )
2070 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2071 && $engine->VERSION eq '0.01' )
2076 elsif ($engine->isa('Catalyst::Engine::Zeus')
2077 && $engine->VERSION eq '0.01' )
2083 Catalyst::Exception->throw( message =>
2084 qq/Engine "$engine" is not supported by this version of Catalyst/
2089 $class->engine( $engine->new );
2092 =head2 $c->setup_home
2094 Sets up the home directory.
2099 my ( $class, $home ) = @_;
2101 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2105 $home ||= Catalyst::Utils::home($class);
2108 #I remember recently being scolded for assigning config values like this
2109 $class->config->{home} ||= $home;
2110 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2114 =head2 $c->setup_log
2121 my ( $class, $debug ) = @_;
2123 unless ( $class->log ) {
2124 $class->log( Catalyst::Log->new );
2127 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2128 if ( defined($env_debug) ? $env_debug : $debug ) {
2130 #Moose todo: dying to be made a bool attribute
2131 *{"$class\::debug"} = sub { 1 };
2132 $class->log->debug('Debug messages enabled');
2136 =head2 $c->setup_plugins
2142 =head2 $c->setup_stats
2144 Sets up timing statistics class.
2149 my ( $class, $stats ) = @_;
2151 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2153 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2154 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2156 #Moose todo: dying to be made a bool attribute
2157 *{"$class\::use_stats"} = sub { 1 };
2158 $class->log->debug('Statistics enabled');
2163 =head2 $c->registered_plugins
2165 Returns a sorted list of the plugins which have either been stated in the
2166 import list or which have been added via C<< MyApp->plugin(@args); >>.
2168 If passed a given plugin name, it will report a boolean value indicating
2169 whether or not that plugin is loaded. A fully qualified name is required if
2170 the plugin name does not begin with C<Catalyst::Plugin::>.
2172 if ($c->registered_plugins('Some::Plugin')) {
2180 sub registered_plugins {
2182 return sort keys %{ $proto->_plugins } unless @_;
2184 return 1 if exists $proto->_plugins->{$plugin};
2185 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2188 sub _register_plugin {
2189 my ( $proto, $plugin, $instant ) = @_;
2190 my $class = ref $proto || $proto;
2192 # no ignore_loaded here, the plugin may already have been
2193 # defined in memory and we don't want to error on "no file" if so
2195 Class::MOP::load_class( $plugin );
2197 $proto->_plugins->{$plugin} = 1;
2200 if( $class->can('meta') ){
2201 my @superclasses = ($plugin, $class->meta->superclasses );
2202 $class->meta->superclasses(@superclasses);
2204 unshift @{"$class\::ISA"}, $plugin;
2211 my ( $class, $plugins ) = @_;
2213 $class->_plugins( {} ) unless $class->_plugins;
2215 for my $plugin ( reverse @$plugins ) {
2217 unless ( $plugin =~ s/\A\+// ) {
2218 $plugin = "Catalyst::Plugin::$plugin";
2221 $class->_register_plugin($plugin);
2228 Returns an arrayref of the internal execution stack (actions that are
2229 currently executing).
2231 =head2 $c->stats_class
2233 Returns or sets the stats (timing statistics) class.
2235 =head2 $c->use_stats
2237 Returns 1 when stats collection is enabled. Stats collection is enabled
2238 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2239 environment variable is set.
2241 Note that this is a static method, not an accessor and should be overloaded
2242 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2249 =head2 $c->write( $data )
2251 Writes $data to the output stream. When using this method directly, you
2252 will need to manually set the C<Content-Length> header to the length of
2253 your output data, if known.
2260 # Finalize headers if someone manually writes output
2261 $c->finalize_headers;
2263 return $c->engine->write( $c, @_ );
2268 Returns the Catalyst version number. Mostly useful for "powered by"
2269 messages in template systems.
2273 sub version { return $Catalyst::VERSION }
2275 =head1 INTERNAL ACTIONS
2277 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2278 C<_ACTION>, and C<_END>. These are by default not shown in the private
2279 action table, but you can make them visible with a config parameter.
2281 MyApp->config->{show_internal_actions} = 1;
2283 =head1 CASE SENSITIVITY
2285 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2286 mapped to C</foo/bar>. You can activate case sensitivity with a config
2289 MyApp->config->{case_sensitive} = 1;
2291 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2293 =head1 ON-DEMAND PARSER
2295 The request body is usually parsed at the beginning of a request,
2296 but if you want to handle input yourself, you can enable on-demand
2297 parsing with a config parameter.
2299 MyApp->config->{parse_on_demand} = 1;
2301 =head1 PROXY SUPPORT
2303 Many production servers operate using the common double-server approach,
2304 with a lightweight frontend web server passing requests to a larger
2305 backend server. An application running on the backend server must deal
2306 with two problems: the remote user always appears to be C<127.0.0.1> and
2307 the server's hostname will appear to be C<localhost> regardless of the
2308 virtual host that the user connected through.
2310 Catalyst will automatically detect this situation when you are running
2311 the frontend and backend servers on the same machine. The following
2312 changes are made to the request.
2314 $c->req->address is set to the user's real IP address, as read from
2315 the HTTP X-Forwarded-For header.
2317 The host value for $c->req->base and $c->req->uri is set to the real
2318 host, as read from the HTTP X-Forwarded-Host header.
2320 Obviously, your web server must support these headers for this to work.
2322 In a more complex server farm environment where you may have your
2323 frontend proxy server(s) on different machines, you will need to set a
2324 configuration option to tell Catalyst to read the proxied data from the
2327 MyApp->config->{using_frontend_proxy} = 1;
2329 If you do not wish to use the proxy support at all, you may set:
2331 MyApp->config->{ignore_frontend_proxy} = 1;
2333 =head1 THREAD SAFETY
2335 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2336 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2337 believe the Catalyst core to be thread-safe.
2339 If you plan to operate in a threaded environment, remember that all other
2340 modules you are using must also be thread-safe. Some modules, most notably
2341 L<DBD::SQLite>, are not thread-safe.
2347 Join #catalyst on irc.perl.org.
2351 http://lists.rawmode.org/mailman/listinfo/catalyst
2352 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2356 http://catalyst.perl.org
2360 http://dev.catalyst.perl.org
2364 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2366 =head2 L<Catalyst::Manual> - The Catalyst Manual
2368 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2370 =head2 L<Catalyst::Engine> - Core engine
2372 =head2 L<Catalyst::Log> - Log class.
2374 =head2 L<Catalyst::Request> - Request object
2376 =head2 L<Catalyst::Response> - Response object
2378 =head2 L<Catalyst::Test> - The test suite.
2452 Sebastian Riedel, C<sri@oook.de>
2456 This library is free software, you can redistribute it and/or modify it under
2457 the same terms as Perl itself.