4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
19 use Text::SimpleTable ();
20 use Path::Class::Dir ();
21 use Path::Class::File ();
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
27 use Class::C3::Adopt::NEXT;
28 use List::MoreUtils qw/uniq/;
30 use String::RewritePrefix;
31 use Catalyst::EngineLoader;
33 use Carp qw/croak carp shortmess/;
36 use Plack::Middleware::Conditional;
37 use Plack::Middleware::ReverseProxy;
38 use Plack::Middleware::IIS6ScriptNameFix;
39 use Plack::Middleware::IIS7KeepAliveFix;
40 use Plack::Middleware::LighttpdScriptNameFix;
42 BEGIN { require 5.008003; }
44 has stack => (is => 'ro', default => sub { [] });
45 has stash => (is => 'rw', default => sub { {} });
46 has state => (is => 'rw', default => 0);
47 has stats => (is => 'rw');
48 has action => (is => 'rw');
49 has counter => (is => 'rw', default => sub { {} });
54 $self->request_class->new($self->_build_request_constructor_args);
58 sub _build_request_constructor_args {
60 my %p = ( _log => $self->log );
61 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
69 $self->response_class->new($self->_build_response_constructor_args);
73 sub _build_response_constructor_args {
75 { _log => $self->log };
78 has namespace => (is => 'rw');
80 sub depth { scalar @{ shift->stack || [] }; }
81 sub comp { shift->component(@_) }
84 my $self = shift; return $self->request(@_);
87 my $self = shift; return $self->response(@_);
90 # For backwards compatibility
91 sub finalize_output { shift->finalize_body(@_) };
96 our $RECURSION = 1000;
97 our $DETACH = Catalyst::Exception::Detach->new;
98 our $GO = Catalyst::Exception::Go->new;
100 #I imagine that very few of these really need to be class variables. if any.
101 #maybe we should just make them attributes with a default?
102 __PACKAGE__->mk_classdata($_)
103 for qw/container arguments dispatcher engine log dispatcher_class
104 engine_loader context_class request_class response_class stats_class
105 setup_finished _psgi_app loading_psgi_file run_options/;
107 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
108 __PACKAGE__->request_class('Catalyst::Request');
109 __PACKAGE__->response_class('Catalyst::Response');
110 __PACKAGE__->stats_class('Catalyst::Stats');
112 # Remember to update this in Catalyst::Runtime as well!
114 our $VERSION = '5.90017';
117 my ( $class, @arguments ) = @_;
119 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
121 return unless $class eq 'Catalyst';
123 my $caller = caller();
124 return if $caller eq 'main';
126 my $meta = Moose::Meta::Class->initialize($caller);
128 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
129 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
130 $meta->superclasses(@superclasses); # XXX - Remove!
133 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
134 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
136 unless( $meta->has_method('meta') ){
137 if ($Moose::VERSION >= 1.15) {
138 $meta->_add_meta_method('meta');
141 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
145 $caller->arguments( [@arguments] );
149 # we call setup_home on import AND on ->setup
150 # is there a reason for it?
151 # anyway there is no point for setup_home without setup_config() so...
152 $caller->setup_config;
156 sub MODIFY_CODE_ATTRIBUTES {
157 Catalyst::Exception->throw(
158 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
159 "That has been deprecated and removed. You should create a " .
160 "controller class called Root.pm, and move relevant code to that class."
165 sub _application { $_[0] }
171 Catalyst - The Elegant MVC Web Application Framework
175 See the L<Catalyst::Manual> distribution for comprehensive
176 documentation and tutorials.
178 # Install Catalyst::Devel for helpers and other development tools
179 # use the helper to create a new application
182 # add models, views, controllers
183 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
184 script/myapp_create.pl view MyTemplate TT
185 script/myapp_create.pl controller Search
187 # built in testserver -- use -r to restart automatically on changes
188 # --help to see all available options
189 script/myapp_server.pl
191 # command line testing interface
192 script/myapp_test.pl /yada
195 use Catalyst qw/-Debug/; # include plugins here as well
197 ### In lib/MyApp/Controller/Root.pm (autocreated)
198 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
199 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
200 $c->stash->{template} = 'foo.tt'; # set the template
201 # lookup something from db -- stash vars are passed to TT
203 $c->model('Database::Foo')->search( { country => $args[0] } );
204 if ( $c->req->params->{bar} ) { # access GET or POST parameters
205 $c->forward( 'bar' ); # process another action
206 # do something else after forward returns
210 # The foo.tt TT template can use the stash data from the database
211 [% WHILE (item = data.next) %]
215 # called for /bar/of/soap, /bar/of/soap/10, etc.
216 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
218 # called after all actions are finished
220 my ( $self, $c ) = @_;
221 if ( scalar @{ $c->error } ) { ... } # handle errors
222 return if $c->res->body; # already have a response
223 $c->forward( 'MyApp::View::TT' ); # render template
226 See L<Catalyst::Manual::Intro> for additional information.
230 Catalyst is a modern framework for making web applications without the
231 pain usually associated with this process. This document is a reference
232 to the main Catalyst application. If you are a new user, we suggest you
233 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
235 See L<Catalyst::Manual> for more documentation.
237 Catalyst plugins can be loaded by naming them as arguments to the "use
238 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
239 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
242 use Catalyst qw/My::Module/;
244 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
245 fully qualify the name by using a unary plus:
249 +Fully::Qualified::Plugin::Name
252 Special flags like C<-Debug> can also be specified as
253 arguments when Catalyst is loaded:
255 use Catalyst qw/-Debug My::Module/;
257 The position of plugins and flags in the chain is important, because
258 they are loaded in the order in which they appear.
260 The following flags are supported:
264 Enables debug output. You can also force this setting from the system
265 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
266 settings override the application, with <MYAPP>_DEBUG having the highest
269 This sets the log level to 'debug' and enables full debug output on the
270 error screen. If you only want the latter, see L<< $c->debug >>.
274 Forces Catalyst to use a specific home directory, e.g.:
276 use Catalyst qw[-Home=/usr/mst];
278 This can also be done in the shell environment by setting either the
279 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
280 is replaced with the uppercased name of your application, any "::" in
281 the name will be replaced with underscores, e.g. MyApp::Web should use
282 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
284 If none of these are set, Catalyst will attempt to automatically detect the
285 home directory. If you are working in a development environment, Catalyst
286 will try and find the directory containing either Makefile.PL, Build.PL or
287 dist.ini. If the application has been installed into the system (i.e.
288 you have done C<make install>), then Catalyst will use the path to your
289 application module, without the .pm extension (e.g., /foo/MyApp if your
290 application was installed at /foo/MyApp.pm)
294 use Catalyst '-Log=warn,fatal,error';
296 Specifies a comma-delimited list of log levels.
300 Enables statistics collection and reporting.
302 use Catalyst qw/-Stats=1/;
304 You can also force this setting from the system environment with CATALYST_STATS
305 or <MYAPP>_STATS. The environment settings override the application, with
306 <MYAPP>_STATS having the highest priority.
308 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
312 =head2 INFORMATION ABOUT THE CURRENT REQUEST
316 Returns a L<Catalyst::Action> object for the current action, which
317 stringifies to the action name. See L<Catalyst::Action>.
321 Returns the namespace of the current action, i.e., the URI prefix
322 corresponding to the controller of the current action. For example:
324 # in Controller::Foo::Bar
325 $c->namespace; # returns 'foo/bar';
331 Returns the current L<Catalyst::Request> object, giving access to
332 information about the current client request (including parameters,
333 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
335 =head2 REQUEST FLOW HANDLING
337 =head2 $c->forward( $action [, \@arguments ] )
339 =head2 $c->forward( $class, $method, [, \@arguments ] )
341 Forwards processing to another action, by its private name. If you give a
342 class name but no method, C<process()> is called. You may also optionally
343 pass arguments in an arrayref. The action will receive the arguments in
344 C<@_> and C<< $c->req->args >>. Upon returning from the function,
345 C<< $c->req->args >> will be restored to the previous values.
347 Any data C<return>ed from the action forwarded to, will be returned by the
350 my $foodata = $c->forward('/foo');
351 $c->forward('index');
352 $c->forward(qw/Model::DBIC::Foo do_stuff/);
353 $c->forward('View::TT');
355 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
356 an C<< eval { } >> around the call (actually
357 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
358 exceptions thrown by the called action non-fatal and pushing them onto
359 $c->error instead. If you want C<die> to propagate you need to do something
363 die join "\n", @{ $c->error } if @{ $c->error };
365 Or make sure to always return true values from your actions and write
368 $c->forward('foo') || return;
370 Another note is that C<< $c->forward >> always returns a scalar because it
371 actually returns $c->state which operates in a scalar context.
372 Thus, something like:
376 in an action that is forwarded to is going to return a scalar,
377 i.e. how many items are in that array, which is probably not what you want.
378 If you need to return an array then return a reference to it,
381 $c->stash->{array} = \@array;
383 and access it from the stash.
385 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
389 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
391 =head2 $c->detach( $action [, \@arguments ] )
393 =head2 $c->detach( $class, $method, [, \@arguments ] )
397 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
398 doesn't return to the previous action when processing is finished.
400 When called with no arguments it escapes the processing chain entirely.
404 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
406 =head2 $c->visit( $action [, \@arguments ] )
408 =head2 $c->visit( $action [, \@captures, \@arguments ] )
410 =head2 $c->visit( $class, $method, [, \@arguments ] )
412 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
414 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
415 but does a full dispatch, instead of just calling the new C<$action> /
416 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
417 you go to are called, just like a new request.
419 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
420 This means, for example, that C<< $c->action >> methods such as
421 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
422 L<reverse|Catalyst::Action/reverse> return information for the visited action
423 when they are invoked within the visited action. This is different from the
424 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
425 continues to use the $c->action object from the caller action even when
426 invoked from the called action.
428 C<< $c->stash >> is kept unchanged.
430 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
431 allows you to "wrap" another action, just as it would have been called by
432 dispatching from a URL, while the analogous
433 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
434 transfer control to another action as if it had been reached directly from a URL.
438 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
440 =head2 $c->go( $action [, \@arguments ] )
442 =head2 $c->go( $action [, \@captures, \@arguments ] )
444 =head2 $c->go( $class, $method, [, \@arguments ] )
446 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
448 The relationship between C<go> and
449 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
450 the relationship between
451 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
452 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
453 C<< $c->go >> will perform a full dispatch on the specified action or method,
454 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
455 C<go> escapes the processing of the current request chain on completion, and
456 does not return to its caller.
458 @arguments are arguments to the final destination of $action. @captures are
459 arguments to the intermediate steps, if any, on the way to the final sub of
464 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
470 Returns the current L<Catalyst::Response> object, see there for details.
474 Returns a hashref to the stash, which may be used to store data and pass
475 it between components during a request. You can also set hash keys by
476 passing arguments. The stash is automatically sent to the view. The
477 stash is cleared at the end of a request; it cannot be used for
478 persistent storage (for this you must use a session; see
479 L<Catalyst::Plugin::Session> for a complete system integrated with
482 $c->stash->{foo} = $bar;
483 $c->stash( { moose => 'majestic', qux => 0 } );
484 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
486 # stash is automatically passed to the view for use in a template
487 $c->forward( 'MyApp::View::TT' );
491 around stash => sub {
494 my $stash = $orig->($c);
496 my $new_stash = @_ > 1 ? {@_} : $_[0];
497 croak('stash takes a hash or hashref') unless ref $new_stash;
498 foreach my $key ( keys %$new_stash ) {
499 $stash->{$key} = $new_stash->{$key};
509 =head2 $c->error($error, ...)
511 =head2 $c->error($arrayref)
513 Returns an arrayref containing error messages. If Catalyst encounters an
514 error while processing a request, it stores the error in $c->error. This
515 method should only be used to store fatal error messages.
517 my @error = @{ $c->error };
521 $c->error('Something bad happened');
528 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
529 croak @$error unless ref $c;
530 push @{ $c->{error} }, @$error;
532 elsif ( defined $_[0] ) { $c->{error} = undef }
533 return $c->{error} || [];
539 Contains the return value of the last executed action.
540 Note that << $c->state >> operates in a scalar context which means that all
541 values it returns are scalar.
543 =head2 $c->clear_errors
545 Clear errors. You probably don't want to clear the errors unless you are
546 implementing a custom error screen.
548 This is equivalent to running
559 =head2 COMPONENT ACCESSORS
561 =head2 $c->controller($name)
563 Gets a L<Catalyst::Controller> instance by name.
565 $c->controller('Foo')->do_stuff;
567 If the name is omitted, will return the controller for the dispatched
570 If you want to search for controllers, pass in a regexp as the argument.
572 # find all controllers that start with Foo
573 my @foo_controllers = $c->controller(qr{^Foo});
578 sub controller { shift->_lookup_mvc('controller', @_) }
580 =head2 $c->model($name)
582 Gets a L<Catalyst::Model> instance by name.
584 $c->model('Foo')->do_stuff;
586 Any extra arguments are directly passed to ACCEPT_CONTEXT.
588 If the name is omitted, it will look for
589 - a model object in $c->stash->{current_model_instance}, then
590 - a model name in $c->stash->{current_model}, then
591 - a config setting 'default_model', or
592 - check if there is only one model, and return it if that's the case.
594 If you want to search for models, pass in a regexp as the argument.
596 # find all models that start with Foo
597 my @foo_models = $c->model(qr{^Foo});
601 sub model { shift->_lookup_mvc('model', @_) }
603 =head2 $c->view($name)
605 Gets a L<Catalyst::View> instance by name.
607 $c->view('Foo')->do_stuff;
609 Any extra arguments are directly passed to ACCEPT_CONTEXT.
611 If the name is omitted, it will look for
612 - a view object in $c->stash->{current_view_instance}, then
613 - a view name in $c->stash->{current_view}, then
614 - a config setting 'default_view', or
615 - check if there is only one view, and return it if that's the case.
617 If you want to search for views, pass in a regexp as the argument.
619 # find all views that start with Foo
620 my @foo_views = $c->view(qr{^Foo});
624 sub view { shift->_lookup_mvc('view', @_) }
627 my ( $c, $type, $name, @args ) = @_;
629 if (ref $c && !$name) {
630 my $current_instance = $c->stash->{"current_${type}_instance"};
631 return $current_instance
632 if $current_instance && $type ne 'controller';
634 $name = $type eq 'controller'
635 ? Catalyst::Utils::class2classshortsuffix($c->action->class)
636 : $c->stash->{"current_${type}"}
640 return $c->container->get_component_from_sub_container($type, $name, $c, @args);
643 =head2 $c->controllers
645 Returns the available names which can be passed to $c->controller
651 return $c->container->get_sub_container('controller')->get_service_list;
656 Returns the available names which can be passed to $c->model
662 return $c->container->get_sub_container('model')->get_service_list;
668 Returns the available names which can be passed to $c->view
674 return $c->container->get_sub_container('view')->get_service_list;
677 =head2 $c->comp($name)
679 =head2 $c->component($name)
681 Gets a component object by name. This method is not recommended,
682 unless you want to get a specific component by full
683 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
684 should be used instead.
686 If C<$name> is a regexp, a list of components matched against the full
687 component name will be returned.
692 my ( $c, $component, @args ) = @_;
694 unless ($component) {
695 $c->log->warn('Calling $c->component with no args is deprecated and ');
696 $c->log->warn('will be removed in a future release.');
697 $c->log->warn('Use $c->component_list instead.');
698 return $c->component_list;
701 my @result = $c->container->find_component( $component, $c, @args );
703 # list context for regexp searches
704 return @result if ref $component;
706 # only one component (if it's found) for string searches
707 return shift @result if @result;
709 if (ref $c eq $component) {
710 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
711 $c->log->warn('deprecated, and will be removed in a future release.');
715 $c->log->warn("Looking for '$component', but nothing was found.");
717 # I would expect to return an empty list here, but that breaks back-compat
718 $c->log->warn('Component not found, returning the list of existing');
719 $c->log->warn('components. This behavior is deprecated and will be');
720 $c->log->warn('removed in a future release. Use $c->component_list');
721 $c->log->warn('instead.');
723 return $c->component_list;
726 =head2 $c->component_list
728 Returns the sorted list of the component names of the application.
732 sub component_list { sort keys %{ shift->components } }
734 =head2 CLASS DATA AND HELPER CLASSES
738 Returns or takes a hashref containing the application's configuration.
740 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
742 You can also use a C<YAML>, C<XML> or L<Config::General> config file
743 like C<myapp.conf> in your applications home directory. See
744 L<Catalyst::Plugin::ConfigLoader>.
746 =head3 Cascading configuration
748 The config method is present on all Catalyst components, and configuration
749 will be merged when an application is started. Configuration loaded with
750 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
751 followed by configuration in your top level C<MyApp> class. These two
752 configurations are merged, and then configuration data whose hash key matches a
753 component name is merged with configuration for that component.
755 The configuration for a component is then passed to the C<new> method when a
756 component is constructed.
760 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
761 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
763 will mean that C<MyApp::Model::Foo> receives the following data when
766 MyApp::Model::Foo->new({
772 It's common practice to use a Moose attribute
773 on the receiving component to access the config value.
775 package MyApp::Model::Foo;
779 # this attr will receive 'baz' at construction time
785 You can then get the value 'baz' by calling $c->model('Foo')->bar
786 (or $self->bar inside code in the model).
788 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
789 as a way of reading config within your code, as this B<will not> give you the
790 correctly merged config back. You B<MUST> take the config values supplied to
791 the constructor and use those instead.
795 around config => sub {
799 croak('Setting config after setup has been run is not allowed.')
800 if ( @_ and $c->setup_finished );
807 Returns the logging object instance. Unless it is already set, Catalyst
808 sets this up with a L<Catalyst::Log> object. To use your own log class,
809 set the logger with the C<< __PACKAGE__->log >> method prior to calling
810 C<< __PACKAGE__->setup >>.
812 __PACKAGE__->log( MyLogger->new );
817 $c->log->info( 'Now logging with my own logger!' );
819 Your log class should implement the methods described in
825 Returns 1 if debug mode is enabled, 0 otherwise.
827 You can enable debug mode in several ways:
831 =item By calling myapp_server.pl with the -d flag
833 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
835 =item The -Debug option in your MyApp.pm
837 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
841 The first three also set the log level to 'debug'.
843 Calling C<< $c->debug(1) >> has no effect.
849 =head2 $c->dispatcher
851 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
855 Returns the engine instance. See L<Catalyst::Engine>.
858 =head2 UTILITY METHODS
860 =head2 $c->path_to(@path)
862 Merges C<@path> with C<< $c->config->{home} >> and returns a
863 L<Path::Class::Dir> object. Note you can usually use this object as
864 a filename, but sometimes you will have to explicitly stringify it
865 yourself by calling the C<< ->stringify >> method.
869 $c->path_to( 'db', 'sqlite.db' );
874 my ( $c, @path ) = @_;
875 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
876 if ( -d $path ) { return $path }
877 else { return Path::Class::File->new( $c->config->{home}, @path ) }
881 my ( $class, $name, $plugin, @args ) = @_;
883 # See block comment in t/aggregate/unit_core_plugin.t
884 # See block comment in t/unit_core_plugin.t
885 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
887 $class->_register_plugin( $plugin, 1 );
889 eval { $plugin->import };
890 $class->mk_classdata($name);
892 eval { $obj = $plugin->new(@args) };
895 Catalyst::Exception->throw( message =>
896 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
900 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
906 Initializes the dispatcher and engine, loads any plugins, and loads the
907 model, view, and controller components. You may also specify an array
908 of plugins to load here, if you choose to not load them in the C<use
912 MyApp->setup( qw/-Debug/ );
914 B<Note:> You B<should not> wrap this method with method modifiers
915 or bad things will happen - wrap the C<setup_finalize> method instead.
920 my ( $class, @arguments ) = @_;
921 croak('Running setup more than once')
922 if ( $class->setup_finished );
924 unless ( $class->isa('Catalyst') ) {
926 Catalyst::Exception->throw(
927 message => qq/'$class' does not inherit from Catalyst/ );
930 if ( $class->arguments ) {
931 @arguments = ( @arguments, @{ $class->arguments } );
937 foreach (@arguments) {
941 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
943 elsif (/^-(\w+)=?(.*)$/) {
944 $flags->{ lc $1 } = $2;
947 push @{ $flags->{plugins} }, $_;
951 $class->setup_config();
952 $class->setup_home( delete $flags->{home} );
954 $class->setup_log( delete $flags->{log} );
955 $class->setup_plugins( delete $flags->{plugins} );
956 $class->setup_dispatcher( delete $flags->{dispatcher} );
957 if (my $engine = delete $flags->{engine}) {
958 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
960 $class->setup_engine();
961 $class->setup_stats( delete $flags->{stats} );
963 for my $flag ( sort keys %{$flags} ) {
965 if ( my $code = $class->can( 'setup_' . $flag ) ) {
966 &$code( $class, delete $flags->{$flag} );
969 $class->log->warn(qq/Unknown flag "$flag"/);
973 eval { require Catalyst::Devel; };
974 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
975 $class->log->warn(<<"EOF");
976 You are running an old script!
978 Please update by running (this will overwrite existing files):
979 catalyst.pl -force -scripts $class
981 or (this will not overwrite existing files):
982 catalyst.pl -scripts $class
987 if ( $class->debug ) {
988 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
991 my $column_width = Catalyst::Utils::term_width() - 6;
992 my $t = Text::SimpleTable->new($column_width);
993 $t->row($_) for @plugins;
994 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
997 my $dispatcher = $class->dispatcher;
998 my $engine = $class->engine;
999 my $home = $class->config->{home};
1001 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1002 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1006 ? $class->log->debug(qq/Found home "$home"/)
1007 : $class->log->debug(qq/Home "$home" doesn't exist/)
1008 : $class->log->debug(q/Couldn't find home/);
1011 # Call plugins setup, this is stupid and evil.
1012 # Also screws C3 badly on 5.10, hack to avoid.
1014 no warnings qw/redefine/;
1015 local *setup = sub { };
1016 $class->setup unless $Catalyst::__AM_RESTARTING;
1019 $class->setup_components;
1023 my $comps = $class->container->get_all_component_services($class)
1025 my $column_width = Catalyst::Utils::term_width() - 16 - 9;
1026 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 16, 'Lifecycle' ] );
1029 # I don't really know what we're going to show here
1030 while (my ($class, $info) = each %$comps) {
1031 my $lifecycle = $info->{backcompat_service}
1032 ? $info->{backcompat_service}->lifecycle
1033 : $info->{service}->lifecycle
1035 $t->row( $class, $lifecycle );
1038 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1041 $class->setup_actions;
1043 if ( $class->debug ) {
1044 my $name = $class->config->{name} || 'Application';
1045 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1048 if ($class->config->{case_sensitive}) {
1049 $class->log->warn($class . "->config->{case_sensitive} is set.");
1050 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1053 $class->setup_finalize;
1054 # Should be the last thing we do so that user things hooking
1055 # setup_finalize can log..
1056 $class->log->_flush() if $class->log->can('_flush');
1057 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1060 =head2 $app->setup_finalize
1062 A hook to attach modifiers to. This method does not do anything except set the
1063 C<setup_finished> accessor.
1065 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1069 after setup_finalize => sub {
1077 sub setup_finalize {
1079 $class->setup_finished(1);
1082 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1084 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1086 Constructs an absolute L<URI> object based on the application root, the
1087 provided path, and the additional arguments and query parameters provided.
1088 When used as a string, provides a textual URI. If you need more flexibility
1089 than this (i.e. the option to provide relative URIs etc.) see
1090 L<Catalyst::Plugin::SmartURI>.
1092 If no arguments are provided, the URI for the current action is returned.
1093 To return the current action and also provide @args, use
1094 C<< $c->uri_for( $c->action, @args ) >>.
1096 If the first argument is a string, it is taken as a public URI path relative
1097 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1098 relative to the application root (if it does). It is then merged with
1099 C<< $c->request->base >>; any C<@args> are appended as additional path
1100 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1102 If the first argument is a L<Catalyst::Action> it represents an action which
1103 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1104 optional C<\@captures> argument (an arrayref) allows passing the captured
1105 variables that are needed to fill in the paths of Chained and Regex actions;
1106 once the path is resolved, C<uri_for> continues as though a path was
1107 provided, appending any arguments or parameters and creating an absolute
1110 The captures for the current request can be found in
1111 C<< $c->request->captures >>, and actions can be resolved using
1112 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1113 path, use C<< $c->uri_for_action >> instead.
1115 # Equivalent to $c->req->uri
1116 $c->uri_for($c->action, $c->req->captures,
1117 @{ $c->req->args }, $c->req->params);
1119 # For the Foo action in the Bar controller
1120 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1122 # Path to a static resource
1123 $c->uri_for('/static/images/logo.png');
1128 my ( $c, $path, @args ) = @_;
1130 if ( $path->$_isa('Catalyst::Controller') ) {
1131 $path = $path->path_prefix;
1136 undef($path) if (defined $path && $path eq '');
1139 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1141 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1142 foreach my $arg (@args) {
1143 utf8::encode($arg) if utf8::is_utf8($arg);
1144 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1147 if ( $path->$_isa('Catalyst::Action') ) { # action object
1148 s|/|%2F|g for @args;
1149 my $captures = [ map { s|/|%2F|g; $_; }
1150 ( scalar @args && ref $args[0] eq 'ARRAY'
1154 foreach my $capture (@$captures) {
1155 utf8::encode($capture) if utf8::is_utf8($capture);
1156 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1160 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1161 if( !@args && $action->number_of_args ) {
1162 my $expanded_action = $c->dispatcher->expand_action( $action );
1164 my $num_captures = $expanded_action->number_of_captures;
1165 unshift @args, splice @$captures, $num_captures;
1168 $path = $c->dispatcher->uri_for_action($action, $captures);
1169 if (not defined $path) {
1170 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1174 $path = '/' if $path eq '';
1177 unshift(@args, $path);
1179 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1180 my $namespace = $c->namespace;
1181 if (defined $path) { # cheesy hack to handle path '../foo'
1182 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1184 unshift(@args, $namespace || '');
1187 # join args with '/', or a blank string
1188 my $args = join('/', grep { defined($_) } @args);
1189 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1191 my $base = $c->req->base;
1192 my $class = ref($base);
1193 $base =~ s{(?<!/)$}{/};
1197 if (my @keys = keys %$params) {
1198 # somewhat lifted from URI::_query's query_form
1199 $query = '?'.join('&', map {
1200 my $val = $params->{$_};
1201 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1204 $val = '' unless defined $val;
1207 utf8::encode( $param ) if utf8::is_utf8($param);
1208 # using the URI::Escape pattern here so utf8 chars survive
1209 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1211 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1215 my $res = bless(\"${base}${args}${query}", $class);
1219 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1221 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1227 A private path to the Catalyst action you want to create a URI for.
1229 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1230 >> and passing the resulting C<$action> and the remaining arguments to C<<
1233 You can also pass in a Catalyst::Action object, in which case it is passed to
1236 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
1238 For example, if the action looks like:
1240 package MyApp::Controller::Users;
1242 sub lst : Path('the-list') {}
1246 $c->uri_for_action('/users/lst')
1248 and it will create the URI /users/the-list.
1250 =item \@captures_and_args?
1252 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1253 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1254 to interpolate all the parameters in the URI.
1258 Optional list of extra arguments - can be supplied in the
1259 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1262 Your action can have zero, a fixed or a variable number of args (e.g.
1263 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1265 =item \%query_values?
1267 Optional array reference of query parameters to append. E.g.
1273 /rest/of/your/uri?foo=bar
1279 sub uri_for_action {
1280 my ( $c, $path, @args ) = @_;
1281 my $action = blessed($path)
1283 : $c->dispatcher->get_action_by_path($path);
1284 unless (defined $action) {
1285 croak "Can't find action for path '$path'";
1287 return $c->uri_for( $action, @args );
1290 =head2 $c->welcome_message
1292 Returns the Catalyst welcome HTML page.
1296 sub welcome_message {
1298 my $name = $c->config->{name};
1299 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1300 my $prefix = Catalyst::Utils::appprefix( ref $c );
1301 $c->response->content_type('text/html; charset=utf-8');
1303 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1304 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1305 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1307 <meta http-equiv="Content-Language" content="en" />
1308 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1309 <title>$name on Catalyst $VERSION</title>
1310 <style type="text/css">
1313 background-color: #eee;
1320 margin-bottom: 10px;
1322 background-color: #ccc;
1323 border: 1px solid #aaa;
1328 font-family: verdana, tahoma, sans-serif;
1331 font-family: verdana, tahoma, sans-serif;
1334 text-decoration: none;
1336 border-bottom: 1px dotted #bbb;
1338 :link:hover, :visited:hover {
1351 background-color: #fff;
1352 border: 1px solid #aaa;
1356 font-weight: normal;
1378 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1383 <img src="$logo" alt="Catalyst Logo" />
1385 <p>Welcome to the world of Catalyst.
1386 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1387 framework will make web development something you had
1388 never expected it to be: Fun, rewarding, and quick.</p>
1389 <h2>What to do now?</h2>
1390 <p>That really depends on what <b>you</b> want to do.
1391 We do, however, provide you with a few starting points.</p>
1392 <p>If you want to jump right into web development with Catalyst
1393 you might want to start with a tutorial.</p>
1394 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1396 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1398 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1399 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1401 <h2>What to do next?</h2>
1402 <p>Next it's time to write an actual application. Use the
1403 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1404 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1405 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1406 they can save you a lot of work.</p>
1407 <pre><code>script/${prefix}_create.pl --help</code></pre>
1408 <p>Also, be sure to check out the vast and growing
1409 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1410 you are likely to find what you need there.
1414 <p>Catalyst has a very active community. Here are the main places to
1415 get in touch with us.</p>
1418 <a href="http://dev.catalyst.perl.org">Wiki</a>
1421 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1424 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1427 <h2>In conclusion</h2>
1428 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1429 as we enjoyed making it. Please contact us if you have ideas
1430 for improvement or other feedback.</p>
1440 Contains a hash of options passed from the application script, including
1441 the original ARGV the script received, the processed values from that
1442 ARGV and any extra arguments to the script which were not processed.
1444 This can be used to add custom options to your application's scripts
1445 and setup your application differently depending on the values of these
1448 =head1 INTERNAL METHODS
1450 These methods are not meant to be used by end users.
1452 =head2 $c->components
1454 Returns a hash of components.
1459 my ( $class, $comps ) = @_;
1462 # this is very wrong
1463 # people create components calling this sub directly, before setup
1464 # also, $class->log doesn't work before setup_log
1465 $class->setup_config unless $class->container;
1467 my $container = $class->container;
1470 $class->log->warn(q{You are adding components using Catalyst's components method.});
1471 $class->log->warn(q{This behaviour is deprecated, please read});
1472 $class->log->warn(q{Catalyst::IOC::Container's documentation for better ways to do that.});
1473 $container->add_component( $_ ) for keys %$comps;
1477 ref($class) ? $container->get_all_components($class)
1478 : $container->get_all_singleton_lifecycle_components
1482 =head2 $c->context_class
1484 Returns or sets the context class.
1488 Returns a hashref containing coderefs and execution counts (needed for
1489 deep recursion detection).
1493 Returns the number of actions on the current internal execution stack.
1497 Dispatches a request to actions.
1501 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1503 =head2 $c->dispatcher_class
1505 Returns or sets the dispatcher class.
1507 =head2 $c->dump_these
1509 Returns a list of 2-element array references (name, structure) pairs
1510 that will be dumped on the error page in debug mode.
1516 [ Request => $c->req ],
1517 [ Response => $c->res ],
1518 [ Stash => $c->stash ],
1519 [ Config => $c->config ];
1522 =head2 $c->engine_class
1524 Returns or sets the engine class.
1526 =head2 $c->execute( $class, $coderef )
1528 Execute a coderef in given class and catch exceptions. Errors are available
1534 my ( $c, $class, $code ) = @_;
1535 $class = $c->component($class) || $class;
1538 if ( $c->depth >= $RECURSION ) {
1539 my $action = $code->reverse();
1540 $action = "/$action" unless $action =~ /->/;
1541 my $error = qq/Deep recursion detected calling "${action}"/;
1542 $c->log->error($error);
1548 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1550 push( @{ $c->stack }, $code );
1552 no warnings 'recursion';
1553 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1554 # I have no idea how, ergo $ret (which appears to fix the issue)
1555 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1557 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1559 my $last = pop( @{ $c->stack } );
1561 if ( my $error = $@ ) {
1562 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1563 $error->rethrow if $c->depth > 1;
1565 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1566 $error->rethrow if $c->depth > 0;
1569 unless ( ref $error ) {
1570 no warnings 'uninitialized';
1572 my $class = $last->class;
1573 my $name = $last->name;
1574 $error = qq/Caught exception in $class->$name "$error"/;
1583 sub _stats_start_execute {
1584 my ( $c, $code ) = @_;
1585 my $appclass = ref($c) || $c;
1586 return if ( ( $code->name =~ /^_.*/ )
1587 && ( !$appclass->config->{show_internal_actions} ) );
1589 my $action_name = $code->reverse();
1590 $c->counter->{$action_name}++;
1592 my $action = $action_name;
1593 $action = "/$action" unless $action =~ /->/;
1595 # determine if the call was the result of a forward
1596 # this is done by walking up the call stack and looking for a calling
1597 # sub of Catalyst::forward before the eval
1599 for my $index ( 2 .. 11 ) {
1601 if ( ( caller($index) )[0] eq 'Catalyst'
1602 && ( caller($index) )[3] eq '(eval)' );
1604 if ( ( caller($index) )[3] =~ /forward$/ ) {
1605 $callsub = ( caller($index) )[3];
1606 $action = "-> $action";
1611 my $uid = $action_name . $c->counter->{$action_name};
1613 # is this a root-level call or a forwarded call?
1614 if ( $callsub =~ /forward$/ ) {
1615 my $parent = $c->stack->[-1];
1617 # forward, locate the caller
1618 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1621 parent => "$parent" . $c->counter->{"$parent"},
1627 # forward with no caller may come from a plugin
1646 sub _stats_finish_execute {
1647 my ( $c, $info ) = @_;
1648 $c->stats->profile( end => $info );
1653 Finalizes the request.
1660 for my $error ( @{ $c->error } ) {
1661 $c->log->error($error);
1664 # Allow engine to handle finalize flow (for POE)
1665 my $engine = $c->engine;
1666 if ( my $code = $engine->can('finalize') ) {
1671 $c->finalize_uploads;
1674 if ( $#{ $c->error } >= 0 ) {
1678 $c->finalize_headers unless $c->response->finalized_headers;
1681 if ( $c->request->method eq 'HEAD' ) {
1682 $c->response->body('');
1690 if ($c->use_stats) {
1691 my $elapsed = sprintf '%f', $c->stats->elapsed;
1692 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1694 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1697 return $c->response->status;
1700 =head2 $c->finalize_body
1706 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1708 =head2 $c->finalize_cookies
1714 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1716 =head2 $c->finalize_error
1722 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1724 =head2 $c->finalize_headers
1730 sub finalize_headers {
1733 my $response = $c->response; #accessor calls can add up?
1735 # Check if we already finalized headers
1736 return if $response->finalized_headers;
1739 if ( my $location = $response->redirect ) {
1740 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1741 $response->header( Location => $location );
1743 if ( !$response->has_body ) {
1744 # Add a default body if none is already present
1745 $response->body(<<"EOF");
1746 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1747 <html xmlns="http://www.w3.org/1999/xhtml">
1749 <title>Moved</title>
1752 <p>This item has moved <a href="$location">here</a>.</p>
1756 $response->content_type('text/html; charset=utf-8');
1761 if ( defined $response->body && length $response->body && !$response->content_length ) {
1763 # get the length from a filehandle
1764 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1766 my $size = -s $response->body;
1768 $response->content_length( $size );
1771 $c->log->warn('Serving filehandle without a content-length');
1775 # everything should be bytes at this point, but just in case
1776 $response->content_length( length( $response->body ) );
1781 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1782 $response->headers->remove_header("Content-Length");
1783 $response->body('');
1786 $c->finalize_cookies;
1788 $c->response->finalize_headers();
1791 $response->finalized_headers(1);
1794 =head2 $c->finalize_output
1796 An alias for finalize_body.
1798 =head2 $c->finalize_read
1800 Finalizes the input after reading is complete.
1804 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1806 =head2 $c->finalize_uploads
1808 Finalizes uploads. Cleans up any temporary files.
1812 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1814 =head2 $c->get_action( $action, $namespace )
1816 Gets an action in a given namespace.
1820 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1822 =head2 $c->get_actions( $action, $namespace )
1824 Gets all actions of a given name in a namespace and all parent
1829 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1831 =head2 $app->handle_request( @arguments )
1833 Called to handle each HTTP request.
1837 sub handle_request {
1838 my ( $class, @arguments ) = @_;
1840 # Always expect worst case!
1843 if ($class->debug) {
1844 my $secs = time - $START || 1;
1845 my $av = sprintf '%.3f', $COUNT / $secs;
1846 my $time = localtime time;
1847 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1850 my $c = $class->prepare(@arguments);
1852 $status = $c->finalize;
1855 chomp(my $error = $_);
1856 $class->log->error(qq/Caught exception in engine "$error"/);
1861 if(my $coderef = $class->log->can('_flush')){
1862 $class->log->$coderef();
1867 =head2 $class->prepare( @arguments )
1869 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1876 predicate => '_has_uploadtmp',
1880 my ( $class, @arguments ) = @_;
1883 # After the app/ctxt split, this should become an attribute based on something passed
1884 # into the application.
1885 $class->context_class( ref $class || $class ) unless $class->context_class;
1887 my $uploadtmp = $class->config->{uploadtmp};
1888 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
1890 $c->response->_context($c);
1892 #surely this is not the most efficient way to do things...
1893 $c->stats($class->stats_class->new)->enable($c->use_stats);
1894 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1895 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1899 # Allow engine to direct the prepare flow (for POE)
1900 if ( my $prepare = $c->engine->can('prepare') ) {
1901 $c->engine->$prepare( $c, @arguments );
1904 $c->prepare_request(@arguments);
1905 $c->prepare_connection;
1906 $c->prepare_query_parameters;
1907 $c->prepare_headers; # Just hooks, no longer needed - they just
1908 $c->prepare_cookies; # cause the lazy attribute on req to build
1911 # Prepare the body for reading, either by prepare_body
1912 # or the user, if they are using $c->read
1915 # Parse the body unless the user wants it on-demand
1916 unless ( ref($c)->config->{parse_on_demand} ) {
1922 # VERY ugly and probably shouldn't rely on ->finalize actually working
1924 # failed prepare is always due to an invalid request, right?
1925 $c->response->status(400);
1926 $c->response->content_type('text/plain');
1927 $c->response->body('Bad Request');
1928 # Note we call finalize and then die here, which escapes
1929 # finalize being called in the enclosing block..
1930 # It in fact couldn't be called, as we don't return $c..
1931 # This is a mess - but I'm unsure you can fix this without
1932 # breaking compat for people doing crazy things (we should set
1933 # the 400 and just return the ctx here IMO, letting finalize get called
1944 =head2 $c->prepare_action
1946 Prepares action. See L<Catalyst::Dispatcher>.
1950 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1952 =head2 $c->prepare_body
1954 Prepares message body.
1961 return if $c->request->_has_body;
1963 # Initialize on-demand data
1964 $c->engine->prepare_body( $c, @_ );
1965 $c->prepare_parameters;
1966 $c->prepare_uploads;
1969 =head2 $c->prepare_body_chunk( $chunk )
1971 Prepares a chunk of data before sending it to L<HTTP::Body>.
1973 See L<Catalyst::Engine>.
1977 sub prepare_body_chunk {
1979 $c->engine->prepare_body_chunk( $c, @_ );
1982 =head2 $c->prepare_body_parameters
1984 Prepares body parameters.
1988 sub prepare_body_parameters {
1990 $c->engine->prepare_body_parameters( $c, @_ );
1993 =head2 $c->prepare_connection
1995 Prepares connection.
1999 sub prepare_connection {
2001 # XXX - This is called on the engine (not the request) to maintain
2002 # Engine::PSGI back compat.
2003 $c->engine->prepare_connection($c);
2006 =head2 $c->prepare_cookies
2008 Prepares cookies by ensuring that the attribute on the request
2009 object has been built.
2013 sub prepare_cookies { my $c = shift; $c->request->cookies }
2015 =head2 $c->prepare_headers
2017 Prepares request headers by ensuring that the attribute on the request
2018 object has been built.
2022 sub prepare_headers { my $c = shift; $c->request->headers }
2024 =head2 $c->prepare_parameters
2026 Prepares parameters.
2030 sub prepare_parameters {
2032 $c->prepare_body_parameters;
2033 $c->engine->prepare_parameters( $c, @_ );
2036 =head2 $c->prepare_path
2038 Prepares path and base.
2042 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2044 =head2 $c->prepare_query_parameters
2046 Prepares query parameters.
2050 sub prepare_query_parameters {
2053 $c->engine->prepare_query_parameters( $c, @_ );
2056 =head2 $c->log_request
2058 Writes information about the request to the debug logs. This includes:
2062 =item * Request method, path, and remote IP address
2064 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2066 =item * Request parameters
2068 =item * File uploads
2077 return unless $c->debug;
2079 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2080 my $request = $dump->[1];
2082 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2084 $path = '/' unless length $path;
2086 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2088 $c->log_request_headers($request->headers);
2090 if ( my $keywords = $request->query_keywords ) {
2091 $c->log->debug("Query keywords are: $keywords");
2094 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2096 $c->log_request_uploads($request);
2099 =head2 $c->log_response
2101 Writes information about the response to the debug logs by calling
2102 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2109 return unless $c->debug;
2111 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2112 my $response = $dump->[1];
2114 $c->log_response_status_line($response);
2115 $c->log_response_headers($response->headers);
2118 =head2 $c->log_response_status_line($response)
2120 Writes one line of information about the response to the debug logs. This includes:
2124 =item * Response status code
2126 =item * Content-Type header (if present)
2128 =item * Content-Length header (if present)
2134 sub log_response_status_line {
2135 my ($c, $response) = @_;
2139 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2140 $response->status || 'unknown',
2141 $response->headers->header('Content-Type') || 'unknown',
2142 $response->headers->header('Content-Length') || 'unknown'
2147 =head2 $c->log_response_headers($headers);
2149 Hook method which can be wrapped by plugins to log the response headers.
2150 No-op in the default implementation.
2154 sub log_response_headers {}
2156 =head2 $c->log_request_parameters( query => {}, body => {} )
2158 Logs request parameters to debug logs
2162 sub log_request_parameters {
2164 my %all_params = @_;
2166 return unless $c->debug;
2168 my $column_width = Catalyst::Utils::term_width() - 44;
2169 foreach my $type (qw(query body)) {
2170 my $params = $all_params{$type};
2171 next if ! keys %$params;
2172 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2173 for my $key ( sort keys %$params ) {
2174 my $param = $params->{$key};
2175 my $value = defined($param) ? $param : '';
2176 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2178 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2182 =head2 $c->log_request_uploads
2184 Logs file uploads included in the request to the debug logs.
2185 The parameter name, filename, file type, and file size are all included in
2190 sub log_request_uploads {
2192 my $request = shift;
2193 return unless $c->debug;
2194 my $uploads = $request->uploads;
2195 if ( keys %$uploads ) {
2196 my $t = Text::SimpleTable->new(
2197 [ 12, 'Parameter' ],
2202 for my $key ( sort keys %$uploads ) {
2203 my $upload = $uploads->{$key};
2204 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2205 $t->row( $key, $u->filename, $u->type, $u->size );
2208 $c->log->debug( "File Uploads are:\n" . $t->draw );
2212 =head2 $c->log_request_headers($headers);
2214 Hook method which can be wrapped by plugins to log the request headers.
2215 No-op in the default implementation.
2219 sub log_request_headers {}
2221 =head2 $c->log_headers($type => $headers)
2223 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2230 my $headers = shift; # an HTTP::Headers instance
2232 return unless $c->debug;
2234 my $column_width = Catalyst::Utils::term_width() - 28;
2235 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2238 my ( $name, $value ) = @_;
2239 $t->row( $name, $value );
2242 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2246 =head2 $c->prepare_read
2248 Prepares the input for reading.
2252 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2254 =head2 $c->prepare_request
2256 Prepares the engine request.
2260 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2262 =head2 $c->prepare_uploads
2268 sub prepare_uploads {
2271 $c->engine->prepare_uploads( $c, @_ );
2274 =head2 $c->prepare_write
2276 Prepares the output for writing.
2280 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2282 =head2 $c->request_class
2284 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2286 =head2 $c->response_class
2288 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2290 =head2 $c->read( [$maxlength] )
2292 Reads a chunk of data from the request body. This method is designed to
2293 be used in a while loop, reading C<$maxlength> bytes on every call.
2294 C<$maxlength> defaults to the size of the request if not specified.
2296 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2299 Warning: If you use read(), Catalyst will not process the body,
2300 so you will not be able to access POST parameters or file uploads via
2301 $c->request. You must handle all body parsing yourself.
2305 sub read { my $c = shift; return $c->request->read( @_ ) }
2315 $app->_make_immutable_if_needed;
2316 $app->engine_loader->needs_psgi_engine_compat_hack ?
2317 $app->engine->run($app, @_) :
2318 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2321 sub _make_immutable_if_needed {
2323 my $meta = Class::MOP::get_metaclass_by_name($class);
2324 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2327 && ! { $meta->immutable_options }->{replace_constructor}
2330 warn("You made your application class ($class) immutable, "
2331 . "but did not inline the\nconstructor. "
2332 . "This will break catalyst, as your app \@ISA "
2333 . "Class::Accessor(::Fast)?\nPlease pass "
2334 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2336 unless ($meta->is_immutable) {
2337 # XXX - FIXME warning here as you should make your app immutable yourself.
2338 $meta->make_immutable(
2339 replace_constructor => 1,
2344 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2346 Sets an action in a given namespace.
2350 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2352 =head2 $c->setup_actions($component)
2354 Sets up actions for a component.
2358 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2360 =head2 $c->setup_config
2367 my %args = %{ $class->config || {} };
2369 my $container_class;
2371 if ( exists $args{container_class} ) {
2372 $container_class = delete $args{container_class};
2373 Class::MOP::load_class($container_class);
2376 $container_class = Class::MOP::load_first_existing_class("${class}::Container", 'Catalyst::IOC::Container');
2379 my $container = $container_class->new( %args, name => $class );
2380 $class->container($container);
2382 my $config = $container->resolve( service => 'config' );
2383 $class->config($config);
2384 $class->finalize_config; # back-compat
2387 =head2 $c->finalize_config
2391 sub finalize_config { }
2393 =head2 $c->setup_components
2395 This method is called internally to set up the application's components.
2397 It finds modules by calling the L<locate_components> method, expands them to
2398 package names with the $container->expand_component_module method, and then
2399 installs each component into the application.
2401 The C<setup_components> config option is passed to both of the above methods.
2405 sub setup_components { shift->container->setup_components }
2407 =head2 locate_components
2411 sub locate_components {
2414 $class->log->warn('The locate_components method has been deprecated.');
2415 $class->log->warn('Please read Catalyst::IOC::Container documentation to');
2416 $class->log->warn('update your application.');
2418 # XXX think about ditching this sort entirely
2419 return sort { length $a <=> length $b }
2420 @{ $class->container->resolve( service => 'locate_components' ) };
2423 =head2 $c->setup_dispatcher
2429 sub setup_dispatcher {
2430 my ( $class, $dispatcher ) = @_;
2433 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2436 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2437 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2440 unless ($dispatcher) {
2441 $dispatcher = $class->dispatcher_class;
2444 Class::MOP::load_class($dispatcher);
2446 # dispatcher instance
2447 $class->dispatcher( $dispatcher->new );
2450 =head2 $c->setup_engine
2457 my ($class, $requested_engine) = @_;
2459 if (!$class->engine_loader || $requested_engine) {
2460 $class->engine_loader(
2461 Catalyst::EngineLoader->new({
2462 application_name => $class,
2463 (defined $requested_engine
2464 ? (catalyst_engine_class => $requested_engine) : ()),
2469 $class->engine_loader->catalyst_engine_class;
2473 my ($class, $requested_engine) = @_;
2476 my $loader = $class->engine_loader;
2478 if (!$loader || $requested_engine) {
2479 $loader = Catalyst::EngineLoader->new({
2480 application_name => $class,
2481 (defined $requested_engine
2482 ? (requested_engine => $requested_engine) : ()),
2485 $class->engine_loader($loader);
2488 $loader->catalyst_engine_class;
2491 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2492 return if $class->loading_psgi_file;
2494 Class::MOP::load_class($engine);
2496 if ($ENV{MOD_PERL}) {
2497 my $apache = $class->engine_loader->auto;
2499 my $meta = find_meta($class);
2500 my $was_immutable = $meta->is_immutable;
2501 my %immutable_options = $meta->immutable_options;
2502 $meta->make_mutable if $was_immutable;
2504 $meta->add_method(handler => sub {
2506 my $psgi_app = $class->_finalized_psgi_app;
2507 $apache->call_app($r, $psgi_app);
2510 $meta->make_immutable(%immutable_options) if $was_immutable;
2513 $class->engine( $engine->new );
2518 sub _finalized_psgi_app {
2521 unless ($app->_psgi_app) {
2522 my $psgi_app = $app->_setup_psgi_app;
2523 $app->_psgi_app($psgi_app);
2526 return $app->_psgi_app;
2529 sub _setup_psgi_app {
2532 for my $home (Path::Class::Dir->new($app->config->{home})) {
2533 my $psgi_file = $home->file(
2534 Catalyst::Utils::appprefix($app) . '.psgi',
2537 next unless -e $psgi_file;
2539 # If $psgi_file calls ->setup_engine, it's doing so to load
2540 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2541 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2542 # anyway. So set a flag (ick) that tells setup_engine not to populate
2543 # $c->engine or do any other things we might regret.
2545 $app->loading_psgi_file(1);
2546 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2547 $app->loading_psgi_file(0);
2550 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2553 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2555 Its content has been ignored. Please consult the Catalyst::Upgrading
2556 documentation on how to upgrade from Catalyst::Engine::PSGI.
2560 return $app->apply_default_middlewares($app->psgi_app);
2563 =head2 $c->apply_default_middlewares
2565 Adds the following L<Plack> middlewares to your application, since they are
2566 useful and commonly needed:
2568 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2569 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2570 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2571 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2572 applied since this middleware is smart enough to conditionally apply itself).
2574 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2575 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2581 sub apply_default_middlewares {
2582 my ($app, $psgi_app) = @_;
2584 $psgi_app = Plack::Middleware::Conditional->wrap(
2586 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2589 return if $app->config->{ignore_frontend_proxy};
2590 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2591 || $app->config->{using_frontend_proxy};
2595 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2596 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2597 $psgi_app = Plack::Middleware::Conditional->wrap(
2599 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2602 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2603 return unless $1 < 4.23;
2608 # we're applying this unconditionally as the middleware itself already makes
2609 # sure it doesn't fuck things up if it's not running under one of the right
2611 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2613 # And another IIS issue, this time with IIS7.
2614 $psgi_app = Plack::Middleware::Conditional->wrap(
2616 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2619 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2628 Returns a PSGI application code reference for the catalyst application
2629 C<$c>. This is the bare application without any middlewares
2630 applied. C<${myapp}.psgi> is not taken into account.
2632 This is what you want to be using to retrieve the PSGI application code
2633 reference of your Catalyst application for use in F<.psgi> files.
2639 return $app->engine->build_psgi_app($app);
2642 =head2 $c->setup_home
2644 Sets up the home directory.
2649 my ( $class, $home_flag ) = @_;
2651 my $home = $class->container->resolve(
2654 home_flag => $home_flag
2659 #I remember recently being scolded for assigning config values like this
2660 $class->config->{home} ||= $home;
2661 $class->config->{root} ||= $class->container->resolve(service => 'root_dir');
2665 =head2 $c->setup_log
2667 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2668 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2671 This method also installs a C<debug> method that returns a true value into the
2672 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2673 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2675 Note that if the log has already been setup, by either a previous call to
2676 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2677 that this method won't actually set up the log object.
2682 my ( $class, $levels ) = @_;
2685 $levels =~ s/^\s+//;
2686 $levels =~ s/\s+$//;
2687 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2689 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2690 if ( defined $env_debug ) {
2691 $levels{debug} = 1 if $env_debug; # Ugly!
2692 delete($levels{debug}) unless $env_debug;
2695 unless ( $class->log ) {
2696 $class->log( Catalyst::Log->new(keys %levels) );
2699 if ( $levels{debug} ) {
2700 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2701 $class->log->debug('Debug messages enabled');
2705 =head2 $c->setup_plugins
2711 =head2 $c->setup_stats
2713 Sets up timing statistics class.
2718 my ( $class, $stats ) = @_;
2720 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2722 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2723 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2724 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2725 $class->log->debug('Statistics enabled');
2730 =head2 $c->registered_plugins
2732 Returns a sorted list of the plugins which have either been stated in the
2735 If passed a given plugin name, it will report a boolean value indicating
2736 whether or not that plugin is loaded. A fully qualified name is required if
2737 the plugin name does not begin with C<Catalyst::Plugin::>.
2739 if ($c->registered_plugins('Some::Plugin')) {
2747 sub registered_plugins {
2749 return sort keys %{ $proto->_plugins } unless @_;
2751 return 1 if exists $proto->_plugins->{$plugin};
2752 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2755 sub _register_plugin {
2756 my ( $proto, $plugin, $instant ) = @_;
2757 my $class = ref $proto || $proto;
2759 Class::MOP::load_class( $plugin );
2760 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2761 if $plugin->isa( 'Catalyst::Component' );
2762 my $plugin_meta = Moose::Meta::Class->create($plugin);
2763 if (!$plugin_meta->has_method('new')
2764 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
2765 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
2767 if (!$instant && !$proto->_plugins->{$plugin}) {
2768 my $meta = Class::MOP::get_metaclass_by_name($class);
2769 $meta->superclasses($plugin, $meta->superclasses);
2771 $proto->_plugins->{$plugin} = 1;
2776 my ( $class, $plugins ) = @_;
2778 $class->_plugins( {} ) unless $class->_plugins;
2779 $plugins = Data::OptList::mkopt($plugins || []);
2782 [ Catalyst::Utils::resolve_namespace(
2783 $class . '::Plugin',
2784 'Catalyst::Plugin', $_->[0]
2790 for my $plugin ( reverse @plugins ) {
2791 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2792 my $meta = find_meta($plugin->[0]);
2793 next if $meta && $meta->isa('Moose::Meta::Role');
2795 $class->_register_plugin($plugin->[0]);
2799 map { $_->[0]->name, $_->[1] }
2800 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2801 map { [find_meta($_->[0]), $_->[1]] }
2804 Moose::Util::apply_all_roles(
2812 Returns an arrayref of the internal execution stack (actions that are
2813 currently executing).
2817 Returns the current timing statistics object. By default Catalyst uses
2818 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2819 L<< stats_class|/"$c->stats_class" >>.
2821 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2822 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2823 profile explicitly, although MyApp.pm still won't profile nor output anything
2826 =head2 $c->stats_class
2828 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2830 =head2 $c->use_stats
2832 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2834 Note that this is a static method, not an accessor and should be overridden
2835 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2842 =head2 $c->write( $data )
2844 Writes $data to the output stream. When using this method directly, you
2845 will need to manually set the C<Content-Length> header to the length of
2846 your output data, if known.
2853 # Finalize headers if someone manually writes output (for compat)
2854 $c->finalize_headers;
2856 return $c->response->write( @_ );
2861 Returns the Catalyst version number. Mostly useful for "powered by"
2862 messages in template systems.
2866 sub version { return $Catalyst::VERSION }
2868 =head1 CONFIGURATION
2870 There are a number of 'base' config variables which can be set:
2876 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2880 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2884 C<home> - The application home directory. In an uninstalled application,
2885 this is the top level application directory. In an installed application,
2886 this will be the directory containing C<< MyApp.pm >>.
2890 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2894 C<name> - The name of the application in debug messages and the debug and
2899 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2900 until it is accessed. This allows you to (for example) check authentication (and reject
2901 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
2905 C<root> - The root directory for templates. Usually this is just a
2906 subdirectory of the home directory, but you can set it to change the
2907 templates to a different directory.
2911 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2912 to be shown in hit debug tables in the test server.
2916 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
2917 variable should be used for determining the request path.
2919 Most web server environments pass the requested path to the application using environment variables,
2920 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
2921 exposed as C<< $c->request->base >>) and the request path below that base.
2923 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
2924 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
2928 =item use_request_uri_for_path => 0
2930 This is the default (and the) traditional method that Catalyst has used for determining the path information.
2931 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
2932 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
2933 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
2935 However this method has the major disadvantage that it is impossible to correctly decode some elements
2936 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
2937 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
2938 can't distinguish / vs %2F in paths (in addition to other encoded values).
2940 =item use_request_uri_for_path => 1
2942 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
2943 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
2944 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
2946 Given that this method of path resolution is provably more correct, it is recommended that you use
2947 this unless you have a specific need to deploy your application in a non-standard environment, and you are
2948 aware of the implications of not being able to handle encoded URI paths correctly.
2950 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
2951 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
2952 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
2953 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
2954 C<< $c->request->base >> will be incorrect.
2960 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2964 =head1 INTERNAL ACTIONS
2966 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2967 C<_ACTION>, and C<_END>. These are by default not shown in the private
2968 action table, but you can make them visible with a config parameter.
2970 MyApp->config(show_internal_actions => 1);
2972 =head1 ON-DEMAND PARSER
2974 The request body is usually parsed at the beginning of a request,
2975 but if you want to handle input yourself, you can enable on-demand
2976 parsing with a config parameter.
2978 MyApp->config(parse_on_demand => 1);
2980 =head1 PROXY SUPPORT
2982 Many production servers operate using the common double-server approach,
2983 with a lightweight frontend web server passing requests to a larger
2984 backend server. An application running on the backend server must deal
2985 with two problems: the remote user always appears to be C<127.0.0.1> and
2986 the server's hostname will appear to be C<localhost> regardless of the
2987 virtual host that the user connected through.
2989 Catalyst will automatically detect this situation when you are running
2990 the frontend and backend servers on the same machine. The following
2991 changes are made to the request.
2993 $c->req->address is set to the user's real IP address, as read from
2994 the HTTP X-Forwarded-For header.
2996 The host value for $c->req->base and $c->req->uri is set to the real
2997 host, as read from the HTTP X-Forwarded-Host header.
2999 Additionally, you may be running your backend application on an insecure
3000 connection (port 80) while your frontend proxy is running under SSL. If there
3001 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3002 tell Catalyst what port the frontend listens on. This will allow all URIs to
3003 be created properly.
3005 In the case of passing in:
3007 X-Forwarded-Port: 443
3009 All calls to C<uri_for> will result in an https link, as is expected.
3011 Obviously, your web server must support these headers for this to work.
3013 In a more complex server farm environment where you may have your
3014 frontend proxy server(s) on different machines, you will need to set a
3015 configuration option to tell Catalyst to read the proxied data from the
3018 MyApp->config(using_frontend_proxy => 1);
3020 If you do not wish to use the proxy support at all, you may set:
3022 MyApp->config(ignore_frontend_proxy => 0);
3024 =head2 Note about psgi files
3026 Note that if you supply your own .psgi file, calling
3027 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3029 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3030 in your psgi, for example:
3033 enable "Plack::Middleware::ReverseProxy";
3037 This will unconditionally add the ReverseProxy support, or you need to call
3038 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3039 apply the support depending upon your config).
3041 See L<Catalyst::PSGI> for more information.
3043 =head1 THREAD SAFETY
3045 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3046 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3047 believe the Catalyst core to be thread-safe.
3049 If you plan to operate in a threaded environment, remember that all other
3050 modules you are using must also be thread-safe. Some modules, most notably
3051 L<DBD::SQLite>, are not thread-safe.
3057 Join #catalyst on irc.perl.org.
3061 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3062 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3066 http://catalyst.perl.org
3070 http://dev.catalyst.perl.org
3074 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3076 =head2 L<Catalyst::Manual> - The Catalyst Manual
3078 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3080 =head2 L<Catalyst::Engine> - Core engine
3082 =head2 L<Catalyst::Log> - Log class.
3084 =head2 L<Catalyst::Request> - Request object
3086 =head2 L<Catalyst::Response> - Response object
3088 =head2 L<Catalyst::Test> - The test suite.
3090 =head1 PROJECT FOUNDER
3092 sri: Sebastian Riedel <sri@cpan.org>
3098 acme: Leon Brocard <leon@astray.com>
3100 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3104 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3110 andyg: Andy Grundman <andy@hybridized.org>
3112 audreyt: Audrey Tang
3114 bricas: Brian Cassidy <bricas@cpan.org>
3116 Caelum: Rafael Kitover <rkitover@io.com>
3118 chansen: Christian Hansen
3120 chicks: Christopher Hicks
3122 Chisel Wright C<pause@herlpacker.co.uk>
3124 Danijel Milicevic C<me@danijel.de>
3126 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3128 David Naughton, C<naughton@umn.edu>
3132 dhoss: Devin Austin <dhoss@cpan.org>
3134 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3138 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3140 esskar: Sascha Kiefer
3142 fireartist: Carl Franks <cfranks@cpan.org>
3144 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3146 gabb: Danijel Milicevic
3150 Gavin Henry C<ghenry@perl.me.uk>
3154 groditi: Guillermo Roditi <groditi@gmail.com>
3156 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3158 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3160 jcamacho: Juan Camacho
3162 jester: Jesse Sheidlower C<jester@panix.com>
3164 jhannah: Jay Hannah <jay@jays.net>
3170 jon: Jon Schutz <jjschutz@cpan.org>
3172 Jonathan Rockway C<< <jrockway@cpan.org> >>
3174 Kieren Diment C<kd@totaldatasolution.com>
3176 konobi: Scott McWhirter <konobi@cpan.org>
3178 marcus: Marcus Ramberg <mramberg@cpan.org>
3180 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3182 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3186 naughton: David Naughton
3188 ningu: David Kamholz <dkamholz@cpan.org>
3190 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3192 numa: Dan Sully <daniel@cpan.org>
3198 omega: Andreas Marienborg
3200 Oleg Kostyuk <cub.uanic@gmail.com>
3202 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3204 rafl: Florian Ragwitz <rafl@debian.org>
3206 random: Roland Lammel <lammel@cpan.org>
3208 Robert Sedlacek C<< <rs@474.at> >>
3210 SpiceMan: Marcel Montes
3214 szbalint: Balint Szilakszi <szbalint@cpan.org>
3216 t0m: Tomas Doran <bobtfish@bobtfish.net>
3220 Viljo Marrandi C<vilts@yahoo.com>
3222 Will Hawes C<info@whawes.co.uk>
3224 willert: Sebastian Willert <willert@cpan.org>
3226 wreis: Wallace Reis <wallace@reis.org.br>
3228 Yuval Kogman, C<nothingmuch@woobling.org>
3230 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3232 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3236 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3240 This library is free software. You can redistribute it and/or modify it under
3241 the same terms as Perl itself.
3247 __PACKAGE__->meta->make_immutable;