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();
93 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 #Moose->import({ into => $caller }); #do we want to do this?
97 unless ( $caller->isa('Catalyst') ) {
98 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
99 $meta->superclasses(@superclasses);
101 unless( $meta->has_method('meta') ){
102 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
105 $caller->arguments( [@arguments] );
111 Catalyst - The Elegant MVC Web Application Framework
115 See the L<Catalyst::Manual> distribution for comprehensive
116 documentation and tutorials.
118 # Install Catalyst::Devel for helpers and other development tools
119 # use the helper to create a new application
122 # add models, views, controllers
123 script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
124 script/myapp_create.pl view MyTemplate TT
125 script/myapp_create.pl controller Search
127 # built in testserver -- use -r to restart automatically on changes
128 # --help to see all available options
129 script/myapp_server.pl
131 # command line testing interface
132 script/myapp_test.pl /yada
135 use Catalyst qw/-Debug/; # include plugins here as well
137 ### In lib/MyApp/Controller/Root.pm (autocreated)
138 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
139 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
140 $c->stash->{template} = 'foo.tt'; # set the template
141 # lookup something from db -- stash vars are passed to TT
143 $c->model('Database::Foo')->search( { country => $args[0] } );
144 if ( $c->req->params->{bar} ) { # access GET or POST parameters
145 $c->forward( 'bar' ); # process another action
146 # do something else after forward returns
150 # The foo.tt TT template can use the stash data from the database
151 [% WHILE (item = data.next) %]
155 # called for /bar/of/soap, /bar/of/soap/10, etc.
156 sub bar : Path('/bar/of/soap') { ... }
158 # called for all actions, from the top-most controller downwards
160 my ( $self, $c ) = @_;
161 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
162 $c->res->redirect( '/login' ); # require login
163 return 0; # abort request and go immediately to end()
165 return 1; # success; carry on to next action
168 # called after all actions are finished
170 my ( $self, $c ) = @_;
171 if ( scalar @{ $c->error } ) { ... } # handle errors
172 return if $c->res->body; # already have a response
173 $c->forward( 'MyApp::View::TT' ); # render template
176 ### in MyApp/Controller/Foo.pm
177 # called for /foo/bar
178 sub bar : Local { ... }
180 # called for /blargle
181 sub blargle : Global { ... }
183 # an index action matches /foo, but not /foo/1, etc.
184 sub index : Private { ... }
186 ### in MyApp/Controller/Foo/Bar.pm
187 # called for /foo/bar/baz
188 sub baz : Local { ... }
190 # first Root auto is called, then Foo auto, then this
191 sub auto : Private { ... }
193 # powerful regular expression paths are also possible
194 sub details : Regex('^product/(\w+)/details$') {
195 my ( $self, $c ) = @_;
196 # extract the (\w+) from the URI
197 my $product = $c->req->captures->[0];
200 See L<Catalyst::Manual::Intro> for additional information.
204 Catalyst is a modern framework for making web applications without the
205 pain usually associated with this process. This document is a reference
206 to the main Catalyst application. If you are a new user, we suggest you
207 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
209 See L<Catalyst::Manual> for more documentation.
211 Catalyst plugins can be loaded by naming them as arguments to the "use
212 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
213 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
216 use Catalyst qw/My::Module/;
218 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
219 fully qualify the name by using a unary plus:
223 +Fully::Qualified::Plugin::Name
226 Special flags like C<-Debug> and C<-Engine> can also be specified as
227 arguments when Catalyst is loaded:
229 use Catalyst qw/-Debug My::Module/;
231 The position of plugins and flags in the chain is important, because
232 they are loaded in the order in which they appear.
234 The following flags are supported:
238 Enables debug output. You can also force this setting from the system
239 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
240 settings override the application, with <MYAPP>_DEBUG having the highest
245 Forces Catalyst to use a specific engine. Omit the
246 C<Catalyst::Engine::> prefix of the engine name, i.e.:
248 use Catalyst qw/-Engine=CGI/;
252 Forces Catalyst to use a specific home directory, e.g.:
254 use Catalyst qw[-Home=/usr/mst];
256 This can also be done in the shell environment by setting either the
257 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
258 is replaced with the uppercased name of your application, any "::" in
259 the name will be replaced with underscores, e.g. MyApp::Web should use
260 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
268 Enables statistics collection and reporting. You can also force this setting
269 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
270 environment settings override the application, with <MYAPP>_STATS having the
275 use Catalyst qw/-Stats=1/
279 =head2 INFORMATION ABOUT THE CURRENT REQUEST
283 Returns a L<Catalyst::Action> object for the current action, which
284 stringifies to the action name. See L<Catalyst::Action>.
288 Returns the namespace of the current action, i.e., the URI prefix
289 corresponding to the controller of the current action. For example:
291 # in Controller::Foo::Bar
292 $c->namespace; # returns 'foo/bar';
298 Returns the current L<Catalyst::Request> object, giving access to
299 information about the current client request (including parameters,
300 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
302 =head2 REQUEST FLOW HANDLING
304 =head2 $c->forward( $action [, \@arguments ] )
306 =head2 $c->forward( $class, $method, [, \@arguments ] )
308 Forwards processing to another action, by its private name. If you give a
309 class name but no method, C<process()> is called. You may also optionally
310 pass arguments in an arrayref. The action will receive the arguments in
311 C<@_> and C<< $c->req->args >>. Upon returning from the function,
312 C<< $c->req->args >> will be restored to the previous values.
314 Any data C<return>ed from the action forwarded to, will be returned by the
317 my $foodata = $c->forward('/foo');
318 $c->forward('index');
319 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
320 $c->forward('MyApp::View::TT');
322 Note that forward implies an C<<eval { }>> around the call (actually
323 C<execute> does), thus de-fatalizing all 'dies' within the called
324 action. If you want C<die> to propagate you need to do something like:
327 die $c->error if $c->error;
329 Or make sure to always return true values from your actions and write
332 $c->forward('foo') || return;
336 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
338 =head2 $c->detach( $action [, \@arguments ] )
340 =head2 $c->detach( $class, $method, [, \@arguments ] )
344 The same as C<forward>, but doesn't return to the previous action when
345 processing is finished.
347 When called with no arguments it escapes the processing chain entirely.
351 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
357 Returns the current L<Catalyst::Response> object, see there for details.
361 Returns a hashref to the stash, which may be used to store data and pass
362 it between components during a request. You can also set hash keys by
363 passing arguments. The stash is automatically sent to the view. The
364 stash is cleared at the end of a request; it cannot be used for
365 persistent storage (for this you must use a session; see
366 L<Catalyst::Plugin::Session> for a complete system integrated with
369 $c->stash->{foo} = $bar;
370 $c->stash( { moose => 'majestic', qux => 0 } );
371 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
373 # stash is automatically passed to the view for use in a template
374 $c->forward( 'MyApp::View::TT' );
381 my $stash = @_ > 1 ? {@_} : $_[0];
382 croak('stash takes a hash or hashref') unless ref $stash;
383 foreach my $key ( keys %$stash ) {
384 #shouldn't we hold this in a var and save ourselves the subcall?
385 $c->next::method->{$key} = $stash->{$key};
389 return $c->next::method;
395 =head2 $c->error($error, ...)
397 =head2 $c->error($arrayref)
399 Returns an arrayref containing error messages. If Catalyst encounters an
400 error while processing a request, it stores the error in $c->error. This
401 method should only be used to store fatal error messages.
403 my @error = @{ $c->error };
407 $c->error('Something bad happened');
414 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
415 croak @$error unless ref $c;
416 push @{ $c->{error} }, @$error;
418 elsif ( defined $_[0] ) { $c->{error} = undef }
419 return $c->{error} || [];
425 Contains the return value of the last executed action.
427 =head2 $c->clear_errors
429 Clear errors. You probably don't want to clear the errors unless you are
430 implementing a custom error screen.
432 This is equivalent to running
446 my ( $c, @names ) = @_;
448 foreach my $name (@names) {
449 foreach my $component ( keys %{ $c->components } ) {
450 return $c->components->{$component} if $component =~ /$name/i;
457 # try explicit component names
459 my ( $c, @names ) = @_;
461 foreach my $try (@names) {
462 return $c->components->{$try} if ( exists $c->components->{$try} );
468 # like component, but try just these prefixes before regex searching,
469 # and do not try to return "sort keys %{ $c->components }"
471 my ( $c, $name, @prefixes ) = @_;
473 my $appclass = ref $c || $c;
475 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
477 my $comp = $c->_comp_explicit(@names);
478 return $comp if defined($comp);
479 $comp = $c->_comp_search($name);
483 # Find possible names for a prefix
486 my ( $c, @prefixes ) = @_;
488 my $appclass = ref $c || $c;
490 my @pre = map { "${appclass}::${_}::" } @prefixes;
494 COMPONENT: foreach my $comp ($c->component) {
495 foreach my $p (@pre) {
496 if ($comp =~ s/^$p//) {
506 # Return a component if only one matches.
508 my ( $c, @prefixes ) = @_;
510 my $appclass = ref $c || $c;
512 my ( $comp, $rest ) =
513 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
514 return $comp unless $rest;
517 # Filter a component before returning by calling ACCEPT_CONTEXT if available
518 sub _filter_component {
519 my ( $c, $comp, @args ) = @_;
520 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
521 return $comp->ACCEPT_CONTEXT( $c, @args );
523 else { return $comp }
526 =head2 COMPONENT ACCESSORS
528 =head2 $c->controller($name)
530 Gets a L<Catalyst::Controller> instance by name.
532 $c->controller('Foo')->do_stuff;
534 If the name is omitted, will return the controller for the dispatched
540 my ( $c, $name, @args ) = @_;
541 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
544 return $c->component( $c->action->class );
547 =head2 $c->model($name)
549 Gets a L<Catalyst::Model> instance by name.
551 $c->model('Foo')->do_stuff;
553 Any extra arguments are directly passed to ACCEPT_CONTEXT.
555 If the name is omitted, it will look for
556 - a model object in $c->stash{current_model_instance}, then
557 - a model name in $c->stash->{current_model}, then
558 - a config setting 'default_model', or
559 - check if there is only one model, and return it if that's the case.
564 my ( $c, $name, @args ) = @_;
565 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
569 return $c->stash->{current_model_instance}
570 if $c->stash->{current_model_instance};
571 return $c->model( $c->stash->{current_model} )
572 if $c->stash->{current_model};
574 return $c->model( $c->config->{default_model} )
575 if $c->config->{default_model};
576 return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
580 =head2 $c->controllers
582 Returns the available names which can be passed to $c->controller
588 return $c->_comp_names(qw/Controller C/);
592 =head2 $c->view($name)
594 Gets a L<Catalyst::View> instance by name.
596 $c->view('Foo')->do_stuff;
598 Any extra arguments are directly passed to ACCEPT_CONTEXT.
600 If the name is omitted, it will look for
601 - a view object in $c->stash{current_view_instance}, then
602 - a view name in $c->stash->{current_view}, then
603 - a config setting 'default_view', or
604 - check if there is only one view, and return it if that's the case.
609 my ( $c, $name, @args ) = @_;
610 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
614 return $c->stash->{current_view_instance}
615 if $c->stash->{current_view_instance};
616 return $c->view( $c->stash->{current_view} )
617 if $c->stash->{current_view};
619 return $c->view( $c->config->{default_view} )
620 if $c->config->{default_view};
621 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
626 Returns the available names which can be passed to $c->model
632 return $c->_comp_names(qw/Model M/);
638 Returns the available names which can be passed to $c->view
644 return $c->_comp_names(qw/View V/);
647 =head2 $c->comp($name)
649 =head2 $c->component($name)
651 Gets a component object by name. This method is not recommended,
652 unless you want to get a specific component by full
653 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
654 should be used instead.
665 my $appclass = ref $c || $c;
668 $name, "${appclass}::${name}",
669 map { "${appclass}::${_}::${name}" }
670 qw/Model M Controller C View V/
673 my $comp = $c->_comp_explicit(@names);
674 return $c->_filter_component( $comp, @_ ) if defined($comp);
676 $comp = $c->_comp_search($name);
677 return $c->_filter_component( $comp, @_ ) if defined($comp);
680 return sort keys %{ $c->components };
685 =head2 CLASS DATA AND HELPER CLASSES
689 Returns or takes a hashref containing the application's configuration.
691 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
693 You can also use a C<YAML>, C<XML> or C<Config::General> config file
694 like myapp.yml in your applications home directory. See
695 L<Catalyst::Plugin::ConfigLoader>.
698 db: dsn:SQLite:foo.db
706 $c->log->warn("Setting config after setup has been run is not a good idea.")
707 if ( @_ and $c->setup_finished );
709 $c->next::method(@_);
714 Returns the logging object instance. Unless it is already set, Catalyst
715 sets this up with a L<Catalyst::Log> object. To use your own log class,
716 set the logger with the C<< __PACKAGE__->log >> method prior to calling
717 C<< __PACKAGE__->setup >>.
719 __PACKAGE__->log( MyLogger->new );
724 $c->log->info( 'Now logging with my own logger!' );
726 Your log class should implement the methods described in
732 Overload to enable debug messages (same as -Debug option).
734 Note that this is a static method, not an accessor and should be overloaded
735 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
741 =head2 $c->dispatcher
743 Returns the dispatcher instance. Stringifies to class name. See
744 L<Catalyst::Dispatcher>.
748 Returns the engine instance. Stringifies to the class name. See
752 =head2 UTILITY METHODS
754 =head2 $c->path_to(@path)
756 Merges C<@path> with C<< $c->config->{home} >> and returns a
757 L<Path::Class::Dir> object.
761 $c->path_to( 'db', 'sqlite.db' );
766 my ( $c, @path ) = @_;
767 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
768 if ( -d $path ) { return $path }
769 else { return Path::Class::File->new( $c->config->{home}, @path ) }
772 =head2 $c->plugin( $name, $class, @args )
774 Helper method for plugins. It creates a classdata accessor/mutator and
775 loads and instantiates the given class.
777 MyApp->plugin( 'prototype', 'HTML::Prototype' );
779 $c->prototype->define_javascript_functions;
784 my ( $class, $name, $plugin, @args ) = @_;
785 $class->_register_plugin( $plugin, 1 );
787 eval { $plugin->import };
788 $class->mk_classdata($name);
790 eval { $obj = $plugin->new(@args) };
793 Catalyst::Exception->throw( message =>
794 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
798 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
804 Initializes the dispatcher and engine, loads any plugins, and loads the
805 model, view, and controller components. You may also specify an array
806 of plugins to load here, if you choose to not load them in the C<use
810 MyApp->setup( qw/-Debug/ );
815 my ( $class, @arguments ) = @_;
817 $class->log->warn("Running setup twice is not a good idea.")
818 if ( $class->setup_finished );
820 unless ( $class->isa('Catalyst') ) {
822 Catalyst::Exception->throw(
823 message => qq/'$class' does not inherit from Catalyst/ );
826 if ( $class->arguments ) {
827 @arguments = ( @arguments, @{ $class->arguments } );
833 foreach (@arguments) {
837 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
839 elsif (/^-(\w+)=?(.*)$/) {
840 $flags->{ lc $1 } = $2;
843 push @{ $flags->{plugins} }, $_;
847 $class->setup_home( delete $flags->{home} );
849 $class->setup_log( delete $flags->{log} );
850 $class->setup_plugins( delete $flags->{plugins} );
851 $class->setup_dispatcher( delete $flags->{dispatcher} );
852 $class->setup_engine( delete $flags->{engine} );
853 $class->setup_stats( delete $flags->{stats} );
855 for my $flag ( sort keys %{$flags} ) {
857 if ( my $code = $class->can( 'setup_' . $flag ) ) {
858 &$code( $class, delete $flags->{$flag} );
861 $class->log->warn(qq/Unknown flag "$flag"/);
865 eval { require Catalyst::Devel; };
866 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
867 $class->log->warn(<<"EOF");
868 You are running an old script!
870 Please update by running (this will overwrite existing files):
871 catalyst.pl -force -scripts $class
873 or (this will not overwrite existing files):
874 catalyst.pl -scripts $class
879 if ( $class->debug ) {
880 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
883 my $t = Text::SimpleTable->new(74);
884 $t->row($_) for @plugins;
885 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
888 my $dispatcher = $class->dispatcher;
889 my $engine = $class->engine;
890 my $home = $class->config->{home};
892 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
893 $class->log->debug(qq/Loaded engine "$engine"/);
897 ? $class->log->debug(qq/Found home "$home"/)
898 : $class->log->debug(qq/Home "$home" doesn't exist/)
899 : $class->log->debug(q/Couldn't find home/);
904 no warnings qw/redefine/;
905 local *setup = sub { };
909 # Initialize our data structure
910 $class->components( {} );
912 $class->setup_components;
914 if ( $class->debug ) {
915 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
916 for my $comp ( sort keys %{ $class->components } ) {
917 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
918 $t->row( $comp, $type );
920 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
921 if ( keys %{ $class->components } );
924 # Add our self to components, since we are also a component
925 $class->components->{$class} = $class->setup_component($class);
927 $class->setup_actions;
929 if ( $class->debug ) {
930 my $name = $class->config->{name} || 'Application';
931 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
933 $class->log->_flush() if $class->log->can('_flush');
935 $class->setup_finished(1);
938 =head2 $c->uri_for( $path, @args?, \%query_values? )
940 Merges path with C<< $c->request->base >> for absolute URIs and with
941 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
942 object. If any args are passed, they are added at the end of the path.
943 If the last argument to C<uri_for> is a hash reference, it is assumed to
944 contain GET parameter key/value pairs, which will be appended to the URI
947 Note that uri_for is destructive to the passed hashref. Subsequent calls
948 with the same hashref may have unintended results.
950 Instead of C<$path>, you can also optionally pass a C<$action> object
951 which will be resolved to a path using
952 C<< $c->dispatcher->uri_for_action >>; if the first element of
953 C<@args> is an arrayref it is treated as a list of captures to be passed
954 to C<uri_for_action>.
959 my ( $c, $path, @args ) = @_;
961 if ( Scalar::Util::blessed($path) ) { # action object
962 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
965 $path = $c->dispatcher->uri_for_action($path, $captures);
966 return undef unless defined($path);
967 $path = '/' if $path eq '';
970 undef($path) if (defined $path && $path eq '');
973 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
975 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
976 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
978 unshift(@args, $path);
980 unless (defined $path && $path =~ s!^/!!) { # in-place strip
981 my $namespace = $c->namespace;
982 if (defined $path) { # cheesy hack to handle path '../foo'
983 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
985 unshift(@args, $namespace || '');
988 # join args with '/', or a blank string
989 my $args = join('/', grep { defined($_) } @args);
990 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
992 my $base = $c->req->base;
993 my $class = ref($base);
994 $base =~ s{(?<!/)$}{/};
998 if (my @keys = keys %$params) {
999 # somewhat lifted from URI::_query's query_form
1000 $query = '?'.join('&', map {
1001 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1004 my $val = $params->{$_};
1005 $val = '' unless defined $val;
1008 utf8::encode( $_ ) if utf8::is_utf8($_);
1009 # using the URI::Escape pattern here so utf8 chars survive
1010 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1012 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1016 my $res = bless(\"${base}${args}${query}", $class);
1020 =head2 $c->welcome_message
1022 Returns the Catalyst welcome HTML page.
1026 sub welcome_message {
1028 my $name = $c->config->{name};
1029 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1030 my $prefix = Catalyst::Utils::appprefix( ref $c );
1031 $c->response->content_type('text/html; charset=utf-8');
1033 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1034 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1035 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1037 <meta http-equiv="Content-Language" content="en" />
1038 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1039 <title>$name on Catalyst $VERSION</title>
1040 <style type="text/css">
1043 background-color: #eee;
1050 margin-bottom: 10px;
1052 background-color: #ccc;
1053 border: 1px solid #aaa;
1058 font-family: verdana, tahoma, sans-serif;
1061 font-family: verdana, tahoma, sans-serif;
1064 text-decoration: none;
1066 border-bottom: 1px dotted #bbb;
1068 :link:hover, :visited:hover {
1081 background-color: #fff;
1082 border: 1px solid #aaa;
1086 font-weight: normal;
1108 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1113 <img src="$logo" alt="Catalyst Logo" />
1115 <p>Welcome to the world of Catalyst.
1116 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1117 framework will make web development something you had
1118 never expected it to be: Fun, rewarding, and quick.</p>
1119 <h2>What to do now?</h2>
1120 <p>That really depends on what <b>you</b> want to do.
1121 We do, however, provide you with a few starting points.</p>
1122 <p>If you want to jump right into web development with Catalyst
1123 you might want want to start with a tutorial.</p>
1124 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1126 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1128 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1129 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1131 <h2>What to do next?</h2>
1132 <p>Next it's time to write an actual application. Use the
1133 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1134 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1135 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1136 they can save you a lot of work.</p>
1137 <pre><code>script/${prefix}_create.pl -help</code></pre>
1138 <p>Also, be sure to check out the vast and growing
1139 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1140 you are likely to find what you need there.
1144 <p>Catalyst has a very active community. Here are the main places to
1145 get in touch with us.</p>
1148 <a href="http://dev.catalyst.perl.org">Wiki</a>
1151 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1154 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1157 <h2>In conclusion</h2>
1158 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1159 as we enjoyed making it. Please contact us if you have ideas
1160 for improvement or other feedback.</p>
1168 =head1 INTERNAL METHODS
1170 These methods are not meant to be used by end users.
1172 =head2 $c->components
1174 Returns a hash of components.
1176 =head2 $c->context_class
1178 Returns or sets the context class.
1182 Returns a hashref containing coderefs and execution counts (needed for
1183 deep recursion detection).
1187 Returns the number of actions on the current internal execution stack.
1191 Dispatches a request to actions.
1195 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1197 =head2 $c->dispatcher_class
1199 Returns or sets the dispatcher class.
1201 =head2 $c->dump_these
1203 Returns a list of 2-element array references (name, structure) pairs
1204 that will be dumped on the error page in debug mode.
1210 [ Request => $c->req ],
1211 [ Response => $c->res ],
1212 [ Stash => $c->stash ],
1213 [ Config => $c->config ];
1216 =head2 $c->engine_class
1218 Returns or sets the engine class.
1220 =head2 $c->execute( $class, $coderef )
1222 Execute a coderef in given class and catch exceptions. Errors are available
1228 my ( $c, $class, $code ) = @_;
1229 $class = $c->component($class) || $class;
1232 if ( $c->depth >= $RECURSION ) {
1233 my $action = $code->reverse();
1234 $action = "/$action" unless $action =~ /->/;
1235 my $error = qq/Deep recursion detected calling "${action}"/;
1236 $c->log->error($error);
1242 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1244 push( @{ $c->stack }, $code );
1246 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1248 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1250 my $last = pop( @{ $c->stack } );
1252 if ( my $error = $@ ) {
1253 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1255 unless ( ref $error ) {
1256 no warnings 'uninitialized';
1258 my $class = $last->class;
1259 my $name = $last->name;
1260 $error = qq/Caught exception in $class->$name "$error"/;
1269 sub _stats_start_execute {
1270 my ( $c, $code ) = @_;
1272 return if ( ( $code->name =~ /^_.*/ )
1273 && ( !$c->config->{show_internal_actions} ) );
1275 my $action_name = $code->reverse();
1276 $c->counter->{$action_name}++;
1278 my $action = $action_name;
1279 $action = "/$action" unless $action =~ /->/;
1281 # determine if the call was the result of a forward
1282 # this is done by walking up the call stack and looking for a calling
1283 # sub of Catalyst::forward before the eval
1285 for my $index ( 2 .. 11 ) {
1287 if ( ( caller($index) )[0] eq 'Catalyst'
1288 && ( caller($index) )[3] eq '(eval)' );
1290 if ( ( caller($index) )[3] =~ /forward$/ ) {
1291 $callsub = ( caller($index) )[3];
1292 $action = "-> $action";
1297 my $uid = $action_name . $c->counter->{$action_name};
1299 # is this a root-level call or a forwarded call?
1300 if ( $callsub =~ /forward$/ ) {
1302 # forward, locate the caller
1303 if ( my $parent = $c->stack->[-1] ) {
1306 parent => "$parent" . $c->counter->{"$parent"},
1312 # forward with no caller may come from a plugin
1331 sub _stats_finish_execute {
1332 my ( $c, $info ) = @_;
1333 $c->stats->profile( end => $info );
1336 =head2 $c->_localize_fields( sub { }, \%keys );
1340 #Why does this exist? This is no longer safe and WILL NOT WORK.
1341 # it doesnt seem to be used anywhere. can we remove it?
1342 sub _localize_fields {
1343 my ( $c, $localized, $code ) = ( @_ );
1345 my $request = delete $localized->{request} || {};
1346 my $response = delete $localized->{response} || {};
1348 local @{ $c }{ keys %$localized } = values %$localized;
1349 local @{ $c->request }{ keys %$request } = values %$request;
1350 local @{ $c->response }{ keys %$response } = values %$response;
1357 Finalizes the request.
1364 for my $error ( @{ $c->error } ) {
1365 $c->log->error($error);
1368 # Allow engine to handle finalize flow (for POE)
1369 my $engine = $c->engine;
1370 if ( my $code = $engine->can('finalize') ) {
1375 $c->finalize_uploads;
1378 if ( $#{ $c->error } >= 0 ) {
1382 $c->finalize_headers;
1385 if ( $c->request->method eq 'HEAD' ) {
1386 $c->response->body('');
1392 if ($c->use_stats) {
1393 my $elapsed = sprintf '%f', $c->stats->elapsed;
1394 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1396 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1399 return $c->response->status;
1402 =head2 $c->finalize_body
1408 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1410 =head2 $c->finalize_cookies
1416 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1418 =head2 $c->finalize_error
1424 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1426 =head2 $c->finalize_headers
1432 sub finalize_headers {
1435 my $response = $c->response; #accessor calls can add up?
1437 # Check if we already finalized headers
1438 return if $response->finalized_headers;
1441 if ( my $location = $response->redirect ) {
1442 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1443 $response->header( Location => $location );
1445 #Moose TODO: we should probably be using a predicate method here ?
1446 if ( !$response->body ) {
1447 # Add a default body if none is already present
1449 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1455 if ( $response->body && !$response->content_length ) {
1457 # get the length from a filehandle
1458 if ( blessed( $response->body ) && $response->body->can('read') )
1460 my $stat = stat $response->body;
1461 if ( $stat && $stat->size > 0 ) {
1462 $response->content_length( $stat->size );
1465 $c->log->warn('Serving filehandle without a content-length');
1469 # everything should be bytes at this point, but just in case
1470 $response->content_length( bytes::length( $response->body ) );
1475 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1476 $response->headers->remove_header("Content-Length");
1477 $response->body('');
1480 $c->finalize_cookies;
1482 $c->engine->finalize_headers( $c, @_ );
1485 $response->finalized_headers(1);
1488 =head2 $c->finalize_output
1490 An alias for finalize_body.
1492 =head2 $c->finalize_read
1494 Finalizes the input after reading is complete.
1498 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1500 =head2 $c->finalize_uploads
1502 Finalizes uploads. Cleans up any temporary files.
1506 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1508 =head2 $c->get_action( $action, $namespace )
1510 Gets an action in a given namespace.
1514 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1516 =head2 $c->get_actions( $action, $namespace )
1518 Gets all actions of a given name in a namespace and all parent
1523 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1525 =head2 $c->handle_request( $class, @arguments )
1527 Called to handle each HTTP request.
1531 sub handle_request {
1532 my ( $class, @arguments ) = @_;
1534 # Always expect worst case!
1537 if ($class->debug) {
1538 my $secs = time - $START || 1;
1539 my $av = sprintf '%.3f', $COUNT / $secs;
1540 my $time = localtime time;
1541 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1544 my $c = $class->prepare(@arguments);
1546 $status = $c->finalize;
1549 if ( my $error = $@ ) {
1551 $class->log->error(qq/Caught exception in engine "$error"/);
1556 if(my $coderef = $class->log->can('_flush')){
1557 $class->log->$coderef();
1562 =head2 $c->prepare( @arguments )
1564 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1570 my ( $class, @arguments ) = @_;
1573 # After the app/ctxt split, this should become an attribute based on something passed
1574 # into the application.
1575 $class->context_class( ref $class || $class ) unless $class->context_class;
1577 my $c = $class->context_class->new({});
1579 # For on-demand data
1580 $c->request->_context($c);
1581 $c->response->_context($c);
1583 #surely this is not the most efficient way to do things...
1584 $c->stats($class->stats_class->new)->enable($c->use_stats);
1586 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1589 #XXX reuse coderef from can
1590 # Allow engine to direct the prepare flow (for POE)
1591 if ( $c->engine->can('prepare') ) {
1592 $c->engine->prepare( $c, @arguments );
1595 $c->prepare_request(@arguments);
1596 $c->prepare_connection;
1597 $c->prepare_query_parameters;
1598 $c->prepare_headers;
1599 $c->prepare_cookies;
1602 # Prepare the body for reading, either by prepare_body
1603 # or the user, if they are using $c->read
1606 # Parse the body unless the user wants it on-demand
1607 unless ( $c->config->{parse_on_demand} ) {
1612 my $method = $c->req->method || '';
1613 my $path = $c->req->path || '/';
1614 my $address = $c->req->address || '';
1616 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1624 =head2 $c->prepare_action
1626 Prepares action. See L<Catalyst::Dispatcher>.
1630 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1632 =head2 $c->prepare_body
1634 Prepares message body.
1641 #Moose TODO: what is _body ??
1642 # Do we run for the first time?
1643 return if defined $c->request->{_body};
1645 # Initialize on-demand data
1646 $c->engine->prepare_body( $c, @_ );
1647 $c->prepare_parameters;
1648 $c->prepare_uploads;
1650 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1651 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1652 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1653 my $param = $c->req->body_parameters->{$key};
1654 my $value = defined($param) ? $param : '';
1656 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1658 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1662 =head2 $c->prepare_body_chunk( $chunk )
1664 Prepares a chunk of data before sending it to L<HTTP::Body>.
1666 See L<Catalyst::Engine>.
1670 sub prepare_body_chunk {
1672 $c->engine->prepare_body_chunk( $c, @_ );
1675 =head2 $c->prepare_body_parameters
1677 Prepares body parameters.
1681 sub prepare_body_parameters {
1683 $c->engine->prepare_body_parameters( $c, @_ );
1686 =head2 $c->prepare_connection
1688 Prepares connection.
1692 sub prepare_connection {
1694 $c->engine->prepare_connection( $c, @_ );
1697 =head2 $c->prepare_cookies
1703 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1705 =head2 $c->prepare_headers
1711 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1713 =head2 $c->prepare_parameters
1715 Prepares parameters.
1719 sub prepare_parameters {
1721 $c->prepare_body_parameters;
1722 $c->engine->prepare_parameters( $c, @_ );
1725 =head2 $c->prepare_path
1727 Prepares path and base.
1731 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1733 =head2 $c->prepare_query_parameters
1735 Prepares query parameters.
1739 sub prepare_query_parameters {
1742 $c->engine->prepare_query_parameters( $c, @_ );
1744 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1745 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1746 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1747 my $param = $c->req->query_parameters->{$key};
1748 my $value = defined($param) ? $param : '';
1750 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1752 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1756 =head2 $c->prepare_read
1758 Prepares the input for reading.
1762 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1764 =head2 $c->prepare_request
1766 Prepares the engine request.
1770 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1772 =head2 $c->prepare_uploads
1778 sub prepare_uploads {
1781 $c->engine->prepare_uploads( $c, @_ );
1783 if ( $c->debug && keys %{ $c->request->uploads } ) {
1784 my $t = Text::SimpleTable->new(
1785 [ 12, 'Parameter' ],
1790 for my $key ( sort keys %{ $c->request->uploads } ) {
1791 my $upload = $c->request->uploads->{$key};
1792 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1793 $t->row( $key, $u->filename, $u->type, $u->size );
1796 $c->log->debug( "File Uploads are:\n" . $t->draw );
1800 =head2 $c->prepare_write
1802 Prepares the output for writing.
1806 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1808 =head2 $c->request_class
1810 Returns or sets the request class.
1812 =head2 $c->response_class
1814 Returns or sets the response class.
1816 =head2 $c->read( [$maxlength] )
1818 Reads a chunk of data from the request body. This method is designed to
1819 be used in a while loop, reading C<$maxlength> bytes on every call.
1820 C<$maxlength> defaults to the size of the request if not specified.
1822 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1825 Warning: If you use read(), Catalyst will not process the body,
1826 so you will not be able to access POST parameters or file uploads via
1827 $c->request. You must handle all body parsing yourself.
1831 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1839 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1841 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1843 Sets an action in a given namespace.
1847 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1849 =head2 $c->setup_actions($component)
1851 Sets up actions for a component.
1855 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1857 =head2 $c->setup_components
1859 Sets up components. Specify a C<setup_components> config option to pass
1860 additional options directly to L<Module::Pluggable>. To add additional
1861 search paths, specify a key named C<search_extra> as an array
1862 reference. Items in the array beginning with C<::> will have the
1863 application class name prepended to them.
1867 sub setup_components {
1870 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1871 my $config = $class->config->{ setup_components };
1872 my $extra = delete $config->{ search_extra } || [];
1874 push @paths, @$extra;
1876 my $locator = Module::Pluggable::Object->new(
1877 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1881 my @comps = sort { length $a <=> length $b } $locator->plugins;
1882 my %comps = map { $_ => 1 } @comps;
1884 for my $component ( @comps ) {
1886 # We pass ignore_loaded here so that overlay files for (e.g.)
1887 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1888 # we know M::P::O found a file on disk so this is safe
1890 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1891 #Class::MOP::load_class($component);
1893 my $module = $class->setup_component( $component );
1895 $component => $module,
1897 $_ => $class->setup_component( $_ )
1899 not exists $comps{$_}
1900 } Devel::InnerPackage::list_packages( $component )
1903 for my $key ( keys %modules ) {
1904 $class->components->{ $key } = $modules{ $key };
1909 =head2 $c->setup_component
1913 sub setup_component {
1914 my( $class, $component ) = @_;
1916 unless ( $component->can( 'COMPONENT' ) ) {
1920 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1921 my $config = $class->config->{ $suffix } || {};
1923 my $instance = eval { $component->COMPONENT( $class, $config ); };
1925 if ( my $error = $@ ) {
1927 Catalyst::Exception->throw(
1928 message => qq/Couldn't instantiate component "$component", "$error"/
1932 Catalyst::Exception->throw(
1934 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1935 ) unless blessed($instance);
1940 =head2 $c->setup_dispatcher
1946 sub setup_dispatcher {
1947 my ( $class, $dispatcher ) = @_;
1950 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1953 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
1954 $dispatcher = 'Catalyst::Dispatcher::' . $env;
1957 unless ($dispatcher) {
1958 $dispatcher = $class->dispatcher_class;
1961 Class::MOP::load_class($dispatcher);
1963 # dispatcher instance
1964 $class->dispatcher( $dispatcher->new );
1967 =head2 $c->setup_engine
1974 my ( $class, $engine ) = @_;
1977 $engine = 'Catalyst::Engine::' . $engine;
1980 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
1981 $engine = 'Catalyst::Engine::' . $env;
1984 if ( $ENV{MOD_PERL} ) {
1986 # create the apache method
1987 $class->meta->add_method('apache' => sub { shift->engine->apache });
1989 my ( $software, $version ) =
1990 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1993 $version =~ s/(\.[^.]+)\./$1/g;
1995 if ( $software eq 'mod_perl' ) {
1999 if ( $version >= 1.99922 ) {
2000 $engine = 'Catalyst::Engine::Apache2::MP20';
2003 elsif ( $version >= 1.9901 ) {
2004 $engine = 'Catalyst::Engine::Apache2::MP19';
2007 elsif ( $version >= 1.24 ) {
2008 $engine = 'Catalyst::Engine::Apache::MP13';
2012 Catalyst::Exception->throw( message =>
2013 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2018 # install the correct mod_perl handler
2019 if ( $version >= 1.9901 ) {
2020 *handler = sub : method {
2021 shift->handle_request(@_);
2025 *handler = sub ($$) { shift->handle_request(@_) };
2030 elsif ( $software eq 'Zeus-Perl' ) {
2031 $engine = 'Catalyst::Engine::Zeus';
2035 Catalyst::Exception->throw(
2036 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2041 $engine = $class->engine_class;
2044 Class::MOP::load_class($engine);
2045 #unless (Class::Inspector->loaded($engine)) {
2046 # require Class::Inspector->filename($engine);
2049 # check for old engines that are no longer compatible
2051 if ( $engine->isa('Catalyst::Engine::Apache')
2052 && !Catalyst::Engine::Apache->VERSION )
2057 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2058 && Catalyst::Engine::Server->VERSION le '0.02' )
2063 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2064 && $engine->VERSION eq '0.01' )
2069 elsif ($engine->isa('Catalyst::Engine::Zeus')
2070 && $engine->VERSION eq '0.01' )
2076 Catalyst::Exception->throw( message =>
2077 qq/Engine "$engine" is not supported by this version of Catalyst/
2082 $class->engine( $engine->new );
2085 =head2 $c->setup_home
2087 Sets up the home directory.
2092 my ( $class, $home ) = @_;
2094 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2098 $home ||= Catalyst::Utils::home($class);
2101 #I remember recently being scolded for assigning config values like this
2102 $class->config->{home} ||= $home;
2103 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2107 =head2 $c->setup_log
2114 my ( $class, $debug ) = @_;
2116 unless ( $class->log ) {
2117 $class->log( Catalyst::Log->new );
2120 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2121 if ( defined($env_debug) ? $env_debug : $debug ) {
2122 $class->meta->add_method('debug' => sub { 1 });
2123 $class->log->debug('Debug messages enabled');
2127 =head2 $c->setup_plugins
2133 =head2 $c->setup_stats
2135 Sets up timing statistics class.
2140 my ( $class, $stats ) = @_;
2142 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2144 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2145 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2146 $class->meta->add_method('use_stats' => sub { 1 });
2147 $class->log->debug('Statistics enabled');
2152 =head2 $c->registered_plugins
2154 Returns a sorted list of the plugins which have either been stated in the
2155 import list or which have been added via C<< MyApp->plugin(@args); >>.
2157 If passed a given plugin name, it will report a boolean value indicating
2158 whether or not that plugin is loaded. A fully qualified name is required if
2159 the plugin name does not begin with C<Catalyst::Plugin::>.
2161 if ($c->registered_plugins('Some::Plugin')) {
2169 sub registered_plugins {
2171 return sort keys %{ $proto->_plugins } unless @_;
2173 return 1 if exists $proto->_plugins->{$plugin};
2174 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2177 sub _register_plugin {
2178 my ( $proto, $plugin, $instant ) = @_;
2179 my $class = ref $proto || $proto;
2181 # no ignore_loaded here, the plugin may already have been
2182 # defined in memory and we don't want to error on "no file" if so
2184 Class::MOP::load_class( $plugin );
2186 $proto->_plugins->{$plugin} = 1;
2189 if( $class->can('meta') ){
2190 my @superclasses = ($plugin, $class->meta->superclasses );
2191 $class->meta->superclasses(@superclasses);
2193 unshift @{"$class\::ISA"}, $plugin;
2200 my ( $class, $plugins ) = @_;
2202 $class->_plugins( {} ) unless $class->_plugins;
2204 for my $plugin ( reverse @$plugins ) {
2206 unless ( $plugin =~ s/\A\+// ) {
2207 $plugin = "Catalyst::Plugin::$plugin";
2210 $class->_register_plugin($plugin);
2217 Returns an arrayref of the internal execution stack (actions that are
2218 currently executing).
2220 =head2 $c->stats_class
2222 Returns or sets the stats (timing statistics) class.
2224 =head2 $c->use_stats
2226 Returns 1 when stats collection is enabled. Stats collection is enabled
2227 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2228 environment variable is set.
2230 Note that this is a static method, not an accessor and should be overloaded
2231 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2238 =head2 $c->write( $data )
2240 Writes $data to the output stream. When using this method directly, you
2241 will need to manually set the C<Content-Length> header to the length of
2242 your output data, if known.
2249 # Finalize headers if someone manually writes output
2250 $c->finalize_headers;
2252 return $c->engine->write( $c, @_ );
2257 Returns the Catalyst version number. Mostly useful for "powered by"
2258 messages in template systems.
2262 sub version { return $Catalyst::VERSION }
2264 =head1 INTERNAL ACTIONS
2266 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2267 C<_ACTION>, and C<_END>. These are by default not shown in the private
2268 action table, but you can make them visible with a config parameter.
2270 MyApp->config->{show_internal_actions} = 1;
2272 =head1 CASE SENSITIVITY
2274 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2275 mapped to C</foo/bar>. You can activate case sensitivity with a config
2278 MyApp->config->{case_sensitive} = 1;
2280 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2282 =head1 ON-DEMAND PARSER
2284 The request body is usually parsed at the beginning of a request,
2285 but if you want to handle input yourself, you can enable on-demand
2286 parsing with a config parameter.
2288 MyApp->config->{parse_on_demand} = 1;
2290 =head1 PROXY SUPPORT
2292 Many production servers operate using the common double-server approach,
2293 with a lightweight frontend web server passing requests to a larger
2294 backend server. An application running on the backend server must deal
2295 with two problems: the remote user always appears to be C<127.0.0.1> and
2296 the server's hostname will appear to be C<localhost> regardless of the
2297 virtual host that the user connected through.
2299 Catalyst will automatically detect this situation when you are running
2300 the frontend and backend servers on the same machine. The following
2301 changes are made to the request.
2303 $c->req->address is set to the user's real IP address, as read from
2304 the HTTP X-Forwarded-For header.
2306 The host value for $c->req->base and $c->req->uri is set to the real
2307 host, as read from the HTTP X-Forwarded-Host header.
2309 Obviously, your web server must support these headers for this to work.
2311 In a more complex server farm environment where you may have your
2312 frontend proxy server(s) on different machines, you will need to set a
2313 configuration option to tell Catalyst to read the proxied data from the
2316 MyApp->config->{using_frontend_proxy} = 1;
2318 If you do not wish to use the proxy support at all, you may set:
2320 MyApp->config->{ignore_frontend_proxy} = 1;
2322 =head1 THREAD SAFETY
2324 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2325 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2326 believe the Catalyst core to be thread-safe.
2328 If you plan to operate in a threaded environment, remember that all other
2329 modules you are using must also be thread-safe. Some modules, most notably
2330 L<DBD::SQLite>, are not thread-safe.
2336 Join #catalyst on irc.perl.org.
2340 http://lists.rawmode.org/mailman/listinfo/catalyst
2341 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2345 http://catalyst.perl.org
2349 http://dev.catalyst.perl.org
2353 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2355 =head2 L<Catalyst::Manual> - The Catalyst Manual
2357 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2359 =head2 L<Catalyst::Engine> - Core engine
2361 =head2 L<Catalyst::Log> - Log class.
2363 =head2 L<Catalyst::Request> - Request object
2365 =head2 L<Catalyst::Response> - Response object
2367 =head2 L<Catalyst::Test> - The test suite.
2441 Sebastian Riedel, C<sri@oook.de>
2445 This library is free software, you can redistribute it and/or modify it under
2446 the same terms as Perl itself.