4 extends 'Catalyst::Component';
6 use Catalyst::Exception;
9 use Catalyst::Request::Upload;
10 use Catalyst::Response;
12 use Catalyst::Controller;
13 use Devel::InnerPackage ();
15 use Module::Pluggable::Object ();
16 use Text::SimpleTable ();
17 use Path::Class::Dir ();
18 use Path::Class::File ();
19 use Time::HiRes qw/gettimeofday tv_interval/;
23 use Scalar::Util qw/weaken blessed/;
24 use Tree::Simple qw/use_weak_refs/;
25 use Tree::Simple::Visitor::FindByUID;
28 use Carp qw/croak carp/;
30 BEGIN { require 5.008001; }
32 has stack => (is => 'rw', default => sub { [] });
33 has stash => (is => 'rw', default => sub { {} });
34 has state => (is => 'rw', default => 0);
35 has stats => (is => 'rw');
36 has action => (is => 'rw');
37 has counter => (is => 'rw', default => sub { {} });
38 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
39 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
40 has namespace => (is => 'rw');
42 sub depth { scalar @{ shift->stack || [] }; }
43 sub comp { shift->component(@_) }
46 # carp "the use of req() is deprecated in favour of request()";
47 my $self = shift; return $self->request(@_);
50 # carp "the use of res() is deprecated in favour of response()";
51 my $self = shift; return $self->response(@_);
54 # For backwards compatibility
55 sub finalize_output { shift->finalize_body(@_) };
60 our $RECURSION = 1000;
61 our $DETACH = "catalyst_detach\n";
62 our $GO = "catalyst_go\n";
64 #I imagine that very few of these really need to be class variables. if any.
65 #maybe we should just make them attributes with a default?
66 __PACKAGE__->mk_classdata($_)
67 for qw/components arguments dispatcher engine log dispatcher_class
68 engine_class context_class request_class response_class stats_class
71 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
72 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
73 __PACKAGE__->request_class('Catalyst::Request');
74 __PACKAGE__->response_class('Catalyst::Response');
75 __PACKAGE__->stats_class('Catalyst::Stats');
77 # Remember to update this in Catalyst::Runtime as well!
79 our $VERSION = '5.7099_03';
82 my ( $class, @arguments ) = @_;
84 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
86 return unless $class eq 'Catalyst';
88 my $caller = caller();
89 return if $caller eq 'main';
90 my $meta = Moose::Meta::Class->initialize($caller);
91 #Moose->import({ into => $caller }); #do we want to do this?
93 unless ( $caller->isa('Catalyst') ) {
94 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
95 $meta->superclasses(@superclasses);
97 unless( $meta->has_method('meta') ){
98 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
101 $caller->arguments( [@arguments] );
107 Catalyst - The Elegant MVC Web Application Framework
111 See the L<Catalyst::Manual> distribution for comprehensive
112 documentation and tutorials.
114 # Install Catalyst::Devel for helpers and other development tools
115 # use the helper to create a new application
118 # add models, views, controllers
119 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
120 script/myapp_create.pl view MyTemplate TT
121 script/myapp_create.pl controller Search
123 # built in testserver -- use -r to restart automatically on changes
124 # --help to see all available options
125 script/myapp_server.pl
127 # command line testing interface
128 script/myapp_test.pl /yada
131 use Catalyst qw/-Debug/; # include plugins here as well
133 ### In lib/MyApp/Controller/Root.pm (autocreated)
134 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
135 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
136 $c->stash->{template} = 'foo.tt'; # set the template
137 # lookup something from db -- stash vars are passed to TT
139 $c->model('Database::Foo')->search( { country => $args[0] } );
140 if ( $c->req->params->{bar} ) { # access GET or POST parameters
141 $c->forward( 'bar' ); # process another action
142 # do something else after forward returns
146 # The foo.tt TT template can use the stash data from the database
147 [% WHILE (item = data.next) %]
151 # called for /bar/of/soap, /bar/of/soap/10, etc.
152 sub bar : Path('/bar/of/soap') { ... }
154 # called for all actions, from the top-most controller downwards
156 my ( $self, $c ) = @_;
157 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
158 $c->res->redirect( '/login' ); # require login
159 return 0; # abort request and go immediately to end()
161 return 1; # success; carry on to next action
164 # called after all actions are finished
166 my ( $self, $c ) = @_;
167 if ( scalar @{ $c->error } ) { ... } # handle errors
168 return if $c->res->body; # already have a response
169 $c->forward( 'MyApp::View::TT' ); # render template
172 ### in MyApp/Controller/Foo.pm
173 # called for /foo/bar
174 sub bar : Local { ... }
176 # called for /blargle
177 sub blargle : Global { ... }
179 # an index action matches /foo, but not /foo/1, etc.
180 sub index : Private { ... }
182 ### in MyApp/Controller/Foo/Bar.pm
183 # called for /foo/bar/baz
184 sub baz : Local { ... }
186 # first Root auto is called, then Foo auto, then this
187 sub auto : Private { ... }
189 # powerful regular expression paths are also possible
190 sub details : Regex('^product/(\w+)/details$') {
191 my ( $self, $c ) = @_;
192 # extract the (\w+) from the URI
193 my $product = $c->req->captures->[0];
196 See L<Catalyst::Manual::Intro> for additional information.
200 Catalyst is a modern framework for making web applications without the
201 pain usually associated with this process. This document is a reference
202 to the main Catalyst application. If you are a new user, we suggest you
203 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
205 See L<Catalyst::Manual> for more documentation.
207 Catalyst plugins can be loaded by naming them as arguments to the "use
208 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
209 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
212 use Catalyst qw/My::Module/;
214 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
215 fully qualify the name by using a unary plus:
219 +Fully::Qualified::Plugin::Name
222 Special flags like C<-Debug> and C<-Engine> can also be specified as
223 arguments when Catalyst is loaded:
225 use Catalyst qw/-Debug My::Module/;
227 The position of plugins and flags in the chain is important, because
228 they are loaded in the order in which they appear.
230 The following flags are supported:
234 Enables debug output. You can also force this setting from the system
235 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
236 settings override the application, with <MYAPP>_DEBUG having the highest
241 Forces Catalyst to use a specific engine. Omit the
242 C<Catalyst::Engine::> prefix of the engine name, i.e.:
244 use Catalyst qw/-Engine=CGI/;
248 Forces Catalyst to use a specific home directory, e.g.:
250 use Catalyst qw[-Home=/usr/mst];
252 This can also be done in the shell environment by setting either the
253 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
254 is replaced with the uppercased name of your application, any "::" in
255 the name will be replaced with underscores, e.g. MyApp::Web should use
256 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
264 Enables statistics collection and reporting. You can also force this setting
265 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
266 environment settings override the application, with <MYAPP>_STATS having the
271 use Catalyst qw/-Stats=1/
275 =head2 INFORMATION ABOUT THE CURRENT REQUEST
279 Returns a L<Catalyst::Action> object for the current action, which
280 stringifies to the action name. See L<Catalyst::Action>.
284 Returns the namespace of the current action, i.e., the URI prefix
285 corresponding to the controller of the current action. For example:
287 # in Controller::Foo::Bar
288 $c->namespace; # returns 'foo/bar';
294 Returns the current L<Catalyst::Request> object, giving access to
295 information about the current client request (including parameters,
296 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
298 =head2 REQUEST FLOW HANDLING
300 =head2 $c->forward( $action [, \@arguments ] )
302 =head2 $c->forward( $class, $method, [, \@arguments ] )
304 Forwards processing to another action, by its private name. If you give a
305 class name but no method, C<process()> is called. You may also optionally
306 pass arguments in an arrayref. The action will receive the arguments in
307 C<@_> and C<< $c->req->args >>. Upon returning from the function,
308 C<< $c->req->args >> will be restored to the previous values.
310 Any data C<return>ed from the action forwarded to, will be returned by the
313 my $foodata = $c->forward('/foo');
314 $c->forward('index');
315 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
316 $c->forward('MyApp::View::TT');
318 Note that forward implies an C<<eval { }>> around the call (actually
319 C<execute> does), thus de-fatalizing all 'dies' within the called
320 action. If you want C<die> to propagate you need to do something like:
323 die $c->error if $c->error;
325 Or make sure to always return true values from your actions and write
328 $c->forward('foo') || return;
332 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
334 =head2 $c->detach( $action [, \@arguments ] )
336 =head2 $c->detach( $class, $method, [, \@arguments ] )
340 The same as C<forward>, but doesn't return to the previous action when
341 processing is finished.
343 When called with no arguments it escapes the processing chain entirely.
347 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
349 =head2 $c->go( $action [, \@arguments ] )
351 =head2 $c->go( $class, $method, [, \@arguments ] )
353 Almost the same as C<detach>, but does a full dispatch, instead of just
354 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
355 C<auto> and the method you go to is called, just like a new request.
357 C<$c-E<gt>stash> is kept unchanged.
361 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
367 Returns the current L<Catalyst::Response> object, see there for details.
371 Returns a hashref to the stash, which may be used to store data and pass
372 it between components during a request. You can also set hash keys by
373 passing arguments. The stash is automatically sent to the view. The
374 stash is cleared at the end of a request; it cannot be used for
375 persistent storage (for this you must use a session; see
376 L<Catalyst::Plugin::Session> for a complete system integrated with
379 $c->stash->{foo} = $bar;
380 $c->stash( { moose => 'majestic', qux => 0 } );
381 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
383 # stash is automatically passed to the view for use in a template
384 $c->forward( 'MyApp::View::TT' );
388 around stash => sub {
391 my $stash = $orig->($c);
393 my $new_stash = @_ > 1 ? {@_} : $_[0];
394 croak('stash takes a hash or hashref') unless ref $new_stash;
395 foreach my $key ( keys %$new_stash ) {
396 $stash->{$key} = $new_stash->{$key};
406 =head2 $c->error($error, ...)
408 =head2 $c->error($arrayref)
410 Returns an arrayref containing error messages. If Catalyst encounters an
411 error while processing a request, it stores the error in $c->error. This
412 method should only be used to store fatal error messages.
414 my @error = @{ $c->error };
418 $c->error('Something bad happened');
425 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
426 croak @$error unless ref $c;
427 push @{ $c->{error} }, @$error;
429 elsif ( defined $_[0] ) { $c->{error} = undef }
430 return $c->{error} || [];
436 Contains the return value of the last executed action.
438 =head2 $c->clear_errors
440 Clear errors. You probably don't want to clear the errors unless you are
441 implementing a custom error screen.
443 This is equivalent to running
454 # search components given a name and some prefixes
455 sub _comp_search_prefixes {
456 my ( $c, $name, @prefixes ) = @_;
457 my $appclass = ref $c || $c;
458 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
460 # map the original component name to the sub part that we will search against
461 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
462 grep { /$filter/ } keys %{ $c->components };
464 # undef for a name will return all
465 return keys %eligible if !defined $name;
467 my $query = ref $name ? $name : qr/^$name$/i;
468 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
470 return map { $c->components->{ $_ } } @result if @result;
472 # if we were given a regexp to search against, we're done.
477 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
479 # no results? try against full names
481 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
484 # don't warn if we didn't find any results, it just might not exist
486 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
487 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' );
488 $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' );
494 # Find possible names for a prefix
496 my ( $c, @prefixes ) = @_;
497 my $appclass = ref $c || $c;
499 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
501 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
505 # Filter a component before returning by calling ACCEPT_CONTEXT if available
506 sub _filter_component {
507 my ( $c, $comp, @args ) = @_;
509 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
510 return $comp->ACCEPT_CONTEXT( $c, @args );
516 =head2 COMPONENT ACCESSORS
518 =head2 $c->controller($name)
520 Gets a L<Catalyst::Controller> instance by name.
522 $c->controller('Foo')->do_stuff;
524 If the name is omitted, will return the controller for the dispatched
527 If you want to search for controllers, pass in a regexp as the argument.
529 # find all controllers that start with Foo
530 my @foo_controllers = $c->controller(qr{^Foo});
536 my ( $c, $name, @args ) = @_;
539 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
540 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
541 return $c->_filter_component( $result[ 0 ], @args );
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.
561 If you want to search for models, pass in a regexp as the argument.
563 # find all models that start with Foo
564 my @foo_models = $c->model(qr{^Foo});
569 my ( $c, $name, @args ) = @_;
572 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
573 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
574 return $c->_filter_component( $result[ 0 ], @args );
578 return $c->stash->{current_model_instance}
579 if $c->stash->{current_model_instance};
580 return $c->model( $c->stash->{current_model} )
581 if $c->stash->{current_model};
583 return $c->model( $c->config->{default_model} )
584 if $c->config->{default_model};
586 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
589 $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' );
590 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
591 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
592 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
593 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
596 return $c->_filter_component( $comp );
600 =head2 $c->view($name)
602 Gets a L<Catalyst::View> instance by name.
604 $c->view('Foo')->do_stuff;
606 Any extra arguments are directly passed to ACCEPT_CONTEXT.
608 If the name is omitted, it will look for
609 - a view object in $c->stash->{current_view_instance}, then
610 - a view name in $c->stash->{current_view}, then
611 - a config setting 'default_view', or
612 - check if there is only one view, and return it if that's the case.
614 If you want to search for views, pass in a regexp as the argument.
616 # find all views that start with Foo
617 my @foo_views = $c->view(qr{^Foo});
622 my ( $c, $name, @args ) = @_;
625 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
626 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
627 return $c->_filter_component( $result[ 0 ], @args );
631 return $c->stash->{current_view_instance}
632 if $c->stash->{current_view_instance};
633 return $c->view( $c->stash->{current_view} )
634 if $c->stash->{current_view};
636 return $c->view( $c->config->{default_view} )
637 if $c->config->{default_view};
639 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
642 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
643 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
644 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
645 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
646 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
649 return $c->_filter_component( $comp );
652 =head2 $c->controllers
654 Returns the available names which can be passed to $c->controller
660 return $c->_comp_names(qw/Controller C/);
665 Returns the available names which can be passed to $c->model
671 return $c->_comp_names(qw/Model M/);
677 Returns the available names which can be passed to $c->view
683 return $c->_comp_names(qw/View V/);
686 =head2 $c->comp($name)
688 =head2 $c->component($name)
690 Gets a component object by name. This method is not recommended,
691 unless you want to get a specific component by full
692 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
693 should be used instead.
695 If C<$name> is a regexp, a list of components matched against the full
696 component name will be returned.
701 my ( $c, $name, @args ) = @_;
704 my $comps = $c->components;
707 # is it the exact name?
708 return $c->_filter_component( $comps->{ $name }, @args )
709 if exists $comps->{ $name };
711 # perhaps we just omitted "MyApp"?
712 my $composed = ( ref $c || $c ) . "::${name}";
713 return $c->_filter_component( $comps->{ $composed }, @args )
714 if exists $comps->{ $composed };
716 # search all of the models, views and controllers
717 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
718 return $c->_filter_component( $comp, @args ) if $comp;
721 # This is here so $c->comp( '::M::' ) works
722 my $query = ref $name ? $name : qr{$name}i;
724 my @result = grep { m{$query} } keys %{ $c->components };
725 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
728 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
729 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
730 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
731 return $c->_filter_component( $result[ 0 ], @args );
734 # I would expect to return an empty list here, but that breaks back-compat
738 return sort keys %{ $c->components };
741 =head2 CLASS DATA AND HELPER CLASSES
745 Returns or takes a hashref containing the application's configuration.
747 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
749 You can also use a C<YAML>, C<XML> or C<Config::General> config file
750 like myapp.yml in your applications home directory. See
751 L<Catalyst::Plugin::ConfigLoader>.
754 db: dsn:SQLite:foo.db
759 around config => sub {
763 $c->log->warn("Setting config after setup has been run is not a good idea.")
764 if ( @_ and $c->setup_finished );
771 Returns the logging object instance. Unless it is already set, Catalyst
772 sets this up with a L<Catalyst::Log> object. To use your own log class,
773 set the logger with the C<< __PACKAGE__->log >> method prior to calling
774 C<< __PACKAGE__->setup >>.
776 __PACKAGE__->log( MyLogger->new );
781 $c->log->info( 'Now logging with my own logger!' );
783 Your log class should implement the methods described in
789 Overload to enable debug messages (same as -Debug option).
791 Note that this is a static method, not an accessor and should be overloaded
792 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
798 =head2 $c->dispatcher
800 Returns the dispatcher instance. Stringifies to class name. See
801 L<Catalyst::Dispatcher>.
805 Returns the engine instance. Stringifies to the class name. See
809 =head2 UTILITY METHODS
811 =head2 $c->path_to(@path)
813 Merges C<@path> with C<< $c->config->{home} >> and returns a
814 L<Path::Class::Dir> object.
818 $c->path_to( 'db', 'sqlite.db' );
823 my ( $c, @path ) = @_;
824 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
825 if ( -d $path ) { return $path }
826 else { return Path::Class::File->new( $c->config->{home}, @path ) }
829 =head2 $c->plugin( $name, $class, @args )
831 Helper method for plugins. It creates a classdata accessor/mutator and
832 loads and instantiates the given class.
834 MyApp->plugin( 'prototype', 'HTML::Prototype' );
836 $c->prototype->define_javascript_functions;
841 my ( $class, $name, $plugin, @args ) = @_;
842 $class->_register_plugin( $plugin, 1 );
844 eval { $plugin->import };
845 $class->mk_classdata($name);
847 eval { $obj = $plugin->new(@args) };
850 Catalyst::Exception->throw( message =>
851 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
855 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
861 Initializes the dispatcher and engine, loads any plugins, and loads the
862 model, view, and controller components. You may also specify an array
863 of plugins to load here, if you choose to not load them in the C<use
867 MyApp->setup( qw/-Debug/ );
872 my ( $class, @arguments ) = @_;
873 $class->log->warn("Running setup twice is not a good idea.")
874 if ( $class->setup_finished );
876 unless ( $class->isa('Catalyst') ) {
878 Catalyst::Exception->throw(
879 message => qq/'$class' does not inherit from Catalyst/ );
882 if ( $class->arguments ) {
883 @arguments = ( @arguments, @{ $class->arguments } );
889 foreach (@arguments) {
893 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
895 elsif (/^-(\w+)=?(.*)$/) {
896 $flags->{ lc $1 } = $2;
899 push @{ $flags->{plugins} }, $_;
903 $class->setup_home( delete $flags->{home} );
905 $class->setup_log( delete $flags->{log} );
906 $class->setup_plugins( delete $flags->{plugins} );
907 $class->setup_dispatcher( delete $flags->{dispatcher} );
908 $class->setup_engine( delete $flags->{engine} );
909 $class->setup_stats( delete $flags->{stats} );
911 for my $flag ( sort keys %{$flags} ) {
913 if ( my $code = $class->can( 'setup_' . $flag ) ) {
914 &$code( $class, delete $flags->{$flag} );
917 $class->log->warn(qq/Unknown flag "$flag"/);
921 eval { require Catalyst::Devel; };
922 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
923 $class->log->warn(<<"EOF");
924 You are running an old script!
926 Please update by running (this will overwrite existing files):
927 catalyst.pl -force -scripts $class
929 or (this will not overwrite existing files):
930 catalyst.pl -scripts $class
935 if ( $class->debug ) {
936 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
939 my $t = Text::SimpleTable->new(74);
940 $t->row($_) for @plugins;
941 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
944 my $dispatcher = $class->dispatcher;
945 my $engine = $class->engine;
946 my $home = $class->config->{home};
948 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
949 $class->log->debug(qq/Loaded engine "$engine"/);
953 ? $class->log->debug(qq/Found home "$home"/)
954 : $class->log->debug(qq/Home "$home" doesn't exist/)
955 : $class->log->debug(q/Couldn't find home/);
960 no warnings qw/redefine/;
961 local *setup = sub { };
965 # Initialize our data structure
966 $class->components( {} );
968 $class->setup_components;
970 if ( $class->debug ) {
971 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
972 for my $comp ( sort keys %{ $class->components } ) {
973 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
974 $t->row( $comp, $type );
976 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
977 if ( keys %{ $class->components } );
980 # Add our self to components, since we are also a component
981 if( $class->isa('Catalyst::Controller') ){
982 $class->components->{$class} = $class;
985 $class->setup_actions;
987 if ( $class->debug ) {
988 my $name = $class->config->{name} || 'Application';
989 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
991 $class->log->_flush() if $class->log->can('_flush');
993 $class->setup_finished(1);
996 =head2 $c->uri_for( $path, @args?, \%query_values? )
998 Merges path with C<< $c->request->base >> for absolute URIs and with
999 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
1000 object. If any args are passed, they are added at the end of the path.
1001 If the last argument to C<uri_for> is a hash reference, it is assumed to
1002 contain GET parameter key/value pairs, which will be appended to the URI
1003 in standard fashion.
1005 Note that uri_for is destructive to the passed hashref. Subsequent calls
1006 with the same hashref may have unintended results.
1008 Instead of C<$path>, you can also optionally pass a C<$action> object
1009 which will be resolved to a path using
1010 C<< $c->dispatcher->uri_for_action >>; if the first element of
1011 C<@args> is an arrayref it is treated as a list of captures to be passed
1012 to C<uri_for_action>.
1017 my ( $c, $path, @args ) = @_;
1019 if ( Scalar::Util::blessed($path) ) { # action object
1020 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1023 $path = $c->dispatcher->uri_for_action($path, $captures);
1024 return undef unless defined($path);
1025 $path = '/' if $path eq '';
1028 undef($path) if (defined $path && $path eq '');
1031 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1033 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1034 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1036 unshift(@args, $path);
1038 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1039 my $namespace = $c->namespace;
1040 if (defined $path) { # cheesy hack to handle path '../foo'
1041 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1043 unshift(@args, $namespace || '');
1046 # join args with '/', or a blank string
1047 my $args = join('/', grep { defined($_) } @args);
1048 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1050 my $base = $c->req->base;
1051 my $class = ref($base);
1052 $base =~ s{(?<!/)$}{/};
1056 if (my @keys = keys %$params) {
1057 # somewhat lifted from URI::_query's query_form
1058 $query = '?'.join('&', map {
1059 my $val = $params->{$_};
1060 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1063 $val = '' unless defined $val;
1066 utf8::encode( $_ ) if utf8::is_utf8($_);
1067 # using the URI::Escape pattern here so utf8 chars survive
1068 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1070 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1074 my $res = bless(\"${base}${args}${query}", $class);
1078 =head2 $c->welcome_message
1080 Returns the Catalyst welcome HTML page.
1084 sub welcome_message {
1086 my $name = $c->config->{name};
1087 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1088 my $prefix = Catalyst::Utils::appprefix( ref $c );
1089 $c->response->content_type('text/html; charset=utf-8');
1091 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1092 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1093 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1095 <meta http-equiv="Content-Language" content="en" />
1096 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1097 <title>$name on Catalyst $VERSION</title>
1098 <style type="text/css">
1101 background-color: #eee;
1108 margin-bottom: 10px;
1110 background-color: #ccc;
1111 border: 1px solid #aaa;
1116 font-family: verdana, tahoma, sans-serif;
1119 font-family: verdana, tahoma, sans-serif;
1122 text-decoration: none;
1124 border-bottom: 1px dotted #bbb;
1126 :link:hover, :visited:hover {
1139 background-color: #fff;
1140 border: 1px solid #aaa;
1144 font-weight: normal;
1166 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1171 <img src="$logo" alt="Catalyst Logo" />
1173 <p>Welcome to the world of Catalyst.
1174 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1175 framework will make web development something you had
1176 never expected it to be: Fun, rewarding, and quick.</p>
1177 <h2>What to do now?</h2>
1178 <p>That really depends on what <b>you</b> want to do.
1179 We do, however, provide you with a few starting points.</p>
1180 <p>If you want to jump right into web development with Catalyst
1181 you might want to start with a tutorial.</p>
1182 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1184 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1186 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1187 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1189 <h2>What to do next?</h2>
1190 <p>Next it's time to write an actual application. Use the
1191 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1192 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1193 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1194 they can save you a lot of work.</p>
1195 <pre><code>script/${prefix}_create.pl -help</code></pre>
1196 <p>Also, be sure to check out the vast and growing
1197 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1198 you are likely to find what you need there.
1202 <p>Catalyst has a very active community. Here are the main places to
1203 get in touch with us.</p>
1206 <a href="http://dev.catalyst.perl.org">Wiki</a>
1209 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1212 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1215 <h2>In conclusion</h2>
1216 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1217 as we enjoyed making it. Please contact us if you have ideas
1218 for improvement or other feedback.</p>
1226 =head1 INTERNAL METHODS
1228 These methods are not meant to be used by end users.
1230 =head2 $c->components
1232 Returns a hash of components.
1234 =head2 $c->context_class
1236 Returns or sets the context class.
1240 Returns a hashref containing coderefs and execution counts (needed for
1241 deep recursion detection).
1245 Returns the number of actions on the current internal execution stack.
1249 Dispatches a request to actions.
1253 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1255 =head2 $c->dispatcher_class
1257 Returns or sets the dispatcher class.
1259 =head2 $c->dump_these
1261 Returns a list of 2-element array references (name, structure) pairs
1262 that will be dumped on the error page in debug mode.
1268 [ Request => $c->req ],
1269 [ Response => $c->res ],
1270 [ Stash => $c->stash ],
1271 [ Config => $c->config ];
1274 =head2 $c->engine_class
1276 Returns or sets the engine class.
1278 =head2 $c->execute( $class, $coderef )
1280 Execute a coderef in given class and catch exceptions. Errors are available
1286 my ( $c, $class, $code ) = @_;
1287 $class = $c->component($class) || $class;
1290 if ( $c->depth >= $RECURSION ) {
1291 my $action = $code->reverse();
1292 $action = "/$action" unless $action =~ /->/;
1293 my $error = qq/Deep recursion detected calling "${action}"/;
1294 $c->log->error($error);
1300 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1302 push( @{ $c->stack }, $code );
1304 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1306 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1308 my $last = pop( @{ $c->stack } );
1310 if ( my $error = $@ ) {
1311 if ( !ref($error) and $error eq $DETACH ) {
1312 die $DETACH if($c->depth > 1);
1314 elsif ( !ref($error) and $error eq $GO ) {
1315 die $GO if($c->depth > 0);
1318 unless ( ref $error ) {
1319 no warnings 'uninitialized';
1321 my $class = $last->class;
1322 my $name = $last->name;
1323 $error = qq/Caught exception in $class->$name "$error"/;
1332 sub _stats_start_execute {
1333 my ( $c, $code ) = @_;
1335 return if ( ( $code->name =~ /^_.*/ )
1336 && ( !$c->config->{show_internal_actions} ) );
1338 my $action_name = $code->reverse();
1339 $c->counter->{$action_name}++;
1341 my $action = $action_name;
1342 $action = "/$action" unless $action =~ /->/;
1344 # determine if the call was the result of a forward
1345 # this is done by walking up the call stack and looking for a calling
1346 # sub of Catalyst::forward before the eval
1348 for my $index ( 2 .. 11 ) {
1350 if ( ( caller($index) )[0] eq 'Catalyst'
1351 && ( caller($index) )[3] eq '(eval)' );
1353 if ( ( caller($index) )[3] =~ /forward$/ ) {
1354 $callsub = ( caller($index) )[3];
1355 $action = "-> $action";
1360 my $uid = $action_name . $c->counter->{$action_name};
1362 # is this a root-level call or a forwarded call?
1363 if ( $callsub =~ /forward$/ ) {
1365 # forward, locate the caller
1366 if ( my $parent = $c->stack->[-1] ) {
1369 parent => "$parent" . $c->counter->{"$parent"},
1375 # forward with no caller may come from a plugin
1394 sub _stats_finish_execute {
1395 my ( $c, $info ) = @_;
1396 $c->stats->profile( end => $info );
1399 =head2 $c->_localize_fields( sub { }, \%keys );
1403 #Why does this exist? This is no longer safe and WILL NOT WORK.
1404 # it doesnt seem to be used anywhere. can we remove it?
1405 sub _localize_fields {
1406 my ( $c, $localized, $code ) = ( @_ );
1408 my $request = delete $localized->{request} || {};
1409 my $response = delete $localized->{response} || {};
1411 local @{ $c }{ keys %$localized } = values %$localized;
1412 local @{ $c->request }{ keys %$request } = values %$request;
1413 local @{ $c->response }{ keys %$response } = values %$response;
1420 Finalizes the request.
1427 for my $error ( @{ $c->error } ) {
1428 $c->log->error($error);
1431 # Allow engine to handle finalize flow (for POE)
1432 my $engine = $c->engine;
1433 if ( my $code = $engine->can('finalize') ) {
1438 $c->finalize_uploads;
1441 if ( $#{ $c->error } >= 0 ) {
1445 $c->finalize_headers;
1448 if ( $c->request->method eq 'HEAD' ) {
1449 $c->response->body('');
1455 if ($c->use_stats) {
1456 my $elapsed = sprintf '%f', $c->stats->elapsed;
1457 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1459 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1462 return $c->response->status;
1465 =head2 $c->finalize_body
1471 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1473 =head2 $c->finalize_cookies
1479 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1481 =head2 $c->finalize_error
1487 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1489 =head2 $c->finalize_headers
1495 sub finalize_headers {
1498 my $response = $c->response; #accessor calls can add up?
1500 # Check if we already finalized headers
1501 return if $response->finalized_headers;
1504 if ( my $location = $response->redirect ) {
1505 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1506 $response->header( Location => $location );
1508 #Moose TODO: we should probably be using a predicate method here ?
1509 if ( !$response->body ) {
1510 # Add a default body if none is already present
1512 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1518 if ( $response->body && !$response->content_length ) {
1520 # get the length from a filehandle
1521 if ( blessed( $response->body ) && $response->body->can('read') )
1523 my $stat = stat $response->body;
1524 if ( $stat && $stat->size > 0 ) {
1525 $response->content_length( $stat->size );
1528 $c->log->warn('Serving filehandle without a content-length');
1532 # everything should be bytes at this point, but just in case
1533 $response->content_length( bytes::length( $response->body ) );
1538 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1539 $response->headers->remove_header("Content-Length");
1540 $response->body('');
1543 $c->finalize_cookies;
1545 $c->engine->finalize_headers( $c, @_ );
1548 $response->finalized_headers(1);
1551 =head2 $c->finalize_output
1553 An alias for finalize_body.
1555 =head2 $c->finalize_read
1557 Finalizes the input after reading is complete.
1561 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1563 =head2 $c->finalize_uploads
1565 Finalizes uploads. Cleans up any temporary files.
1569 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1571 =head2 $c->get_action( $action, $namespace )
1573 Gets an action in a given namespace.
1577 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1579 =head2 $c->get_actions( $action, $namespace )
1581 Gets all actions of a given name in a namespace and all parent
1586 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1588 =head2 $c->handle_request( $class, @arguments )
1590 Called to handle each HTTP request.
1594 sub handle_request {
1595 my ( $class, @arguments ) = @_;
1597 # Always expect worst case!
1600 if ($class->debug) {
1601 my $secs = time - $START || 1;
1602 my $av = sprintf '%.3f', $COUNT / $secs;
1603 my $time = localtime time;
1604 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1607 my $c = $class->prepare(@arguments);
1609 $status = $c->finalize;
1612 if ( my $error = $@ ) {
1614 $class->log->error(qq/Caught exception in engine "$error"/);
1619 if(my $coderef = $class->log->can('_flush')){
1620 $class->log->$coderef();
1625 =head2 $c->prepare( @arguments )
1627 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1633 my ( $class, @arguments ) = @_;
1636 # After the app/ctxt split, this should become an attribute based on something passed
1637 # into the application.
1638 $class->context_class( ref $class || $class ) unless $class->context_class;
1640 my $c = $class->context_class->new({});
1642 # For on-demand data
1643 $c->request->_context($c);
1644 $c->response->_context($c);
1646 #surely this is not the most efficient way to do things...
1647 $c->stats($class->stats_class->new)->enable($c->use_stats);
1649 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1652 #XXX reuse coderef from can
1653 # Allow engine to direct the prepare flow (for POE)
1654 if ( $c->engine->can('prepare') ) {
1655 $c->engine->prepare( $c, @arguments );
1658 $c->prepare_request(@arguments);
1659 $c->prepare_connection;
1660 $c->prepare_query_parameters;
1661 $c->prepare_headers;
1662 $c->prepare_cookies;
1665 # Prepare the body for reading, either by prepare_body
1666 # or the user, if they are using $c->read
1669 # Parse the body unless the user wants it on-demand
1670 unless ( $c->config->{parse_on_demand} ) {
1675 my $method = $c->req->method || '';
1676 my $path = $c->req->path;
1677 $path = '/' unless length $path;
1678 my $address = $c->req->address || '';
1680 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1688 =head2 $c->prepare_action
1690 Prepares action. See L<Catalyst::Dispatcher>.
1694 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1696 =head2 $c->prepare_body
1698 Prepares message body.
1705 #Moose TODO: what is _body ??
1706 # Do we run for the first time?
1707 return if defined $c->request->{_body};
1709 # Initialize on-demand data
1710 $c->engine->prepare_body( $c, @_ );
1711 $c->prepare_parameters;
1712 $c->prepare_uploads;
1714 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1715 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1716 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1717 my $param = $c->req->body_parameters->{$key};
1718 my $value = defined($param) ? $param : '';
1720 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1722 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1726 =head2 $c->prepare_body_chunk( $chunk )
1728 Prepares a chunk of data before sending it to L<HTTP::Body>.
1730 See L<Catalyst::Engine>.
1734 sub prepare_body_chunk {
1736 $c->engine->prepare_body_chunk( $c, @_ );
1739 =head2 $c->prepare_body_parameters
1741 Prepares body parameters.
1745 sub prepare_body_parameters {
1747 $c->engine->prepare_body_parameters( $c, @_ );
1750 =head2 $c->prepare_connection
1752 Prepares connection.
1756 sub prepare_connection {
1758 $c->engine->prepare_connection( $c, @_ );
1761 =head2 $c->prepare_cookies
1767 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1769 =head2 $c->prepare_headers
1775 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1777 =head2 $c->prepare_parameters
1779 Prepares parameters.
1783 sub prepare_parameters {
1785 $c->prepare_body_parameters;
1786 $c->engine->prepare_parameters( $c, @_ );
1789 =head2 $c->prepare_path
1791 Prepares path and base.
1795 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1797 =head2 $c->prepare_query_parameters
1799 Prepares query parameters.
1803 sub prepare_query_parameters {
1806 $c->engine->prepare_query_parameters( $c, @_ );
1808 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1809 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1810 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1811 my $param = $c->req->query_parameters->{$key};
1812 my $value = defined($param) ? $param : '';
1814 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1816 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1820 =head2 $c->prepare_read
1822 Prepares the input for reading.
1826 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1828 =head2 $c->prepare_request
1830 Prepares the engine request.
1834 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1836 =head2 $c->prepare_uploads
1842 sub prepare_uploads {
1845 $c->engine->prepare_uploads( $c, @_ );
1847 if ( $c->debug && keys %{ $c->request->uploads } ) {
1848 my $t = Text::SimpleTable->new(
1849 [ 12, 'Parameter' ],
1854 for my $key ( sort keys %{ $c->request->uploads } ) {
1855 my $upload = $c->request->uploads->{$key};
1856 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1857 $t->row( $key, $u->filename, $u->type, $u->size );
1860 $c->log->debug( "File Uploads are:\n" . $t->draw );
1864 =head2 $c->prepare_write
1866 Prepares the output for writing.
1870 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1872 =head2 $c->request_class
1874 Returns or sets the request class.
1876 =head2 $c->response_class
1878 Returns or sets the response class.
1880 =head2 $c->read( [$maxlength] )
1882 Reads a chunk of data from the request body. This method is designed to
1883 be used in a while loop, reading C<$maxlength> bytes on every call.
1884 C<$maxlength> defaults to the size of the request if not specified.
1886 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1889 Warning: If you use read(), Catalyst will not process the body,
1890 so you will not be able to access POST parameters or file uploads via
1891 $c->request. You must handle all body parsing yourself.
1895 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1903 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1905 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1907 Sets an action in a given namespace.
1911 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1913 =head2 $c->setup_actions($component)
1915 Sets up actions for a component.
1919 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1921 =head2 $c->setup_components
1923 Sets up components. Specify a C<setup_components> config option to pass
1924 additional options directly to L<Module::Pluggable>. To add additional
1925 search paths, specify a key named C<search_extra> as an array
1926 reference. Items in the array beginning with C<::> will have the
1927 application class name prepended to them.
1929 All components found will also have any
1930 L<Devel::InnerPackage|inner packages> loaded and set up as components.
1931 Note, that modules which are B<not> an I<inner package> of the main
1932 file namespace loaded will not be instantiated as components.
1936 sub setup_components {
1939 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1940 my $config = $class->config->{ setup_components };
1941 my $extra = delete $config->{ search_extra } || [];
1943 push @paths, @$extra;
1945 my $locator = Module::Pluggable::Object->new(
1946 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1950 my @comps = sort { length $a <=> length $b } $locator->plugins;
1951 my %comps = map { $_ => 1 } @comps;
1953 for my $component ( @comps ) {
1955 # We pass ignore_loaded here so that overlay files for (e.g.)
1956 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1957 # we know M::P::O found a file on disk so this is safe
1959 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1960 #Class::MOP::load_class($component);
1962 my $module = $class->setup_component( $component );
1964 $component => $module,
1966 $_ => $class->setup_component( $_ )
1968 not exists $comps{$_}
1969 } Devel::InnerPackage::list_packages( $component )
1972 for my $key ( keys %modules ) {
1973 $class->components->{ $key } = $modules{ $key };
1978 =head2 $c->setup_component
1982 sub setup_component {
1983 my( $class, $component ) = @_;
1985 unless ( $component->can( 'COMPONENT' ) ) {
1989 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1990 my $config = $class->config->{ $suffix } || {};
1992 my $instance = eval { $component->COMPONENT( $class, $config ); };
1994 if ( my $error = $@ ) {
1996 Catalyst::Exception->throw(
1997 message => qq/Couldn't instantiate component "$component", "$error"/
2001 Catalyst::Exception->throw(
2003 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2004 ) unless blessed($instance);
2009 =head2 $c->setup_dispatcher
2015 sub setup_dispatcher {
2016 my ( $class, $dispatcher ) = @_;
2019 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2022 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2023 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2026 unless ($dispatcher) {
2027 $dispatcher = $class->dispatcher_class;
2030 Class::MOP::load_class($dispatcher);
2032 # dispatcher instance
2033 $class->dispatcher( $dispatcher->new );
2036 =head2 $c->setup_engine
2043 my ( $class, $engine ) = @_;
2046 $engine = 'Catalyst::Engine::' . $engine;
2049 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2050 $engine = 'Catalyst::Engine::' . $env;
2053 if ( $ENV{MOD_PERL} ) {
2055 # create the apache method
2056 $class->meta->add_method('apache' => sub { shift->engine->apache });
2058 my ( $software, $version ) =
2059 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2062 $version =~ s/(\.[^.]+)\./$1/g;
2064 if ( $software eq 'mod_perl' ) {
2068 if ( $version >= 1.99922 ) {
2069 $engine = 'Catalyst::Engine::Apache2::MP20';
2072 elsif ( $version >= 1.9901 ) {
2073 $engine = 'Catalyst::Engine::Apache2::MP19';
2076 elsif ( $version >= 1.24 ) {
2077 $engine = 'Catalyst::Engine::Apache::MP13';
2081 Catalyst::Exception->throw( message =>
2082 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2087 # install the correct mod_perl handler
2088 if ( $version >= 1.9901 ) {
2089 *handler = sub : method {
2090 shift->handle_request(@_);
2094 *handler = sub ($$) { shift->handle_request(@_) };
2099 elsif ( $software eq 'Zeus-Perl' ) {
2100 $engine = 'Catalyst::Engine::Zeus';
2104 Catalyst::Exception->throw(
2105 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2110 $engine = $class->engine_class;
2113 Class::MOP::load_class($engine);
2114 #unless (Class::Inspector->loaded($engine)) {
2115 # require Class::Inspector->filename($engine);
2118 # check for old engines that are no longer compatible
2120 if ( $engine->isa('Catalyst::Engine::Apache')
2121 && !Catalyst::Engine::Apache->VERSION )
2126 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2127 && Catalyst::Engine::Server->VERSION le '0.02' )
2132 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2133 && $engine->VERSION eq '0.01' )
2138 elsif ($engine->isa('Catalyst::Engine::Zeus')
2139 && $engine->VERSION eq '0.01' )
2145 Catalyst::Exception->throw( message =>
2146 qq/Engine "$engine" is not supported by this version of Catalyst/
2151 $class->engine( $engine->new );
2154 =head2 $c->setup_home
2156 Sets up the home directory.
2161 my ( $class, $home ) = @_;
2163 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2167 $home ||= Catalyst::Utils::home($class);
2170 #I remember recently being scolded for assigning config values like this
2171 $class->config->{home} ||= $home;
2172 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2176 =head2 $c->setup_log
2183 my ( $class, $debug ) = @_;
2185 unless ( $class->log ) {
2186 $class->log( Catalyst::Log->new );
2189 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2190 if ( defined($env_debug) ? $env_debug : $debug ) {
2191 $class->meta->add_method('debug' => sub { 1 });
2192 $class->log->debug('Debug messages enabled');
2196 =head2 $c->setup_plugins
2202 =head2 $c->setup_stats
2204 Sets up timing statistics class.
2209 my ( $class, $stats ) = @_;
2211 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2213 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2214 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2215 $class->meta->add_method('use_stats' => sub { 1 });
2216 $class->log->debug('Statistics enabled');
2221 =head2 $c->registered_plugins
2223 Returns a sorted list of the plugins which have either been stated in the
2224 import list or which have been added via C<< MyApp->plugin(@args); >>.
2226 If passed a given plugin name, it will report a boolean value indicating
2227 whether or not that plugin is loaded. A fully qualified name is required if
2228 the plugin name does not begin with C<Catalyst::Plugin::>.
2230 if ($c->registered_plugins('Some::Plugin')) {
2238 sub registered_plugins {
2240 return sort keys %{ $proto->_plugins } unless @_;
2242 return 1 if exists $proto->_plugins->{$plugin};
2243 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2246 sub _register_plugin {
2247 my ( $proto, $plugin, $instant ) = @_;
2248 my $class = ref $proto || $proto;
2250 # no ignore_loaded here, the plugin may already have been
2251 # defined in memory and we don't want to error on "no file" if so
2253 Class::MOP::load_class( $plugin );
2255 $proto->_plugins->{$plugin} = 1;
2258 if( $class->can('meta') ){
2259 my @superclasses = ($plugin, $class->meta->superclasses );
2260 $class->meta->superclasses(@superclasses);
2262 unshift @{"$class\::ISA"}, $plugin;
2269 my ( $class, $plugins ) = @_;
2271 $class->_plugins( {} ) unless $class->_plugins;
2273 for my $plugin ( reverse @$plugins ) {
2275 unless ( $plugin =~ s/\A\+// ) {
2276 $plugin = "Catalyst::Plugin::$plugin";
2279 $class->_register_plugin($plugin);
2286 Returns an arrayref of the internal execution stack (actions that are
2287 currently executing).
2289 =head2 $c->stats_class
2291 Returns or sets the stats (timing statistics) class.
2293 =head2 $c->use_stats
2295 Returns 1 when stats collection is enabled. Stats collection is enabled
2296 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2297 environment variable is set.
2299 Note that this is a static method, not an accessor and should be overloaded
2300 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2307 =head2 $c->write( $data )
2309 Writes $data to the output stream. When using this method directly, you
2310 will need to manually set the C<Content-Length> header to the length of
2311 your output data, if known.
2318 # Finalize headers if someone manually writes output
2319 $c->finalize_headers;
2321 return $c->engine->write( $c, @_ );
2326 Returns the Catalyst version number. Mostly useful for "powered by"
2327 messages in template systems.
2331 sub version { return $Catalyst::VERSION }
2333 =head1 INTERNAL ACTIONS
2335 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2336 C<_ACTION>, and C<_END>. These are by default not shown in the private
2337 action table, but you can make them visible with a config parameter.
2339 MyApp->config->{show_internal_actions} = 1;
2341 =head1 CASE SENSITIVITY
2343 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2344 mapped to C</foo/bar>. You can activate case sensitivity with a config
2347 MyApp->config->{case_sensitive} = 1;
2349 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2351 =head1 ON-DEMAND PARSER
2353 The request body is usually parsed at the beginning of a request,
2354 but if you want to handle input yourself, you can enable on-demand
2355 parsing with a config parameter.
2357 MyApp->config->{parse_on_demand} = 1;
2359 =head1 PROXY SUPPORT
2361 Many production servers operate using the common double-server approach,
2362 with a lightweight frontend web server passing requests to a larger
2363 backend server. An application running on the backend server must deal
2364 with two problems: the remote user always appears to be C<127.0.0.1> and
2365 the server's hostname will appear to be C<localhost> regardless of the
2366 virtual host that the user connected through.
2368 Catalyst will automatically detect this situation when you are running
2369 the frontend and backend servers on the same machine. The following
2370 changes are made to the request.
2372 $c->req->address is set to the user's real IP address, as read from
2373 the HTTP X-Forwarded-For header.
2375 The host value for $c->req->base and $c->req->uri is set to the real
2376 host, as read from the HTTP X-Forwarded-Host header.
2378 Obviously, your web server must support these headers for this to work.
2380 In a more complex server farm environment where you may have your
2381 frontend proxy server(s) on different machines, you will need to set a
2382 configuration option to tell Catalyst to read the proxied data from the
2385 MyApp->config->{using_frontend_proxy} = 1;
2387 If you do not wish to use the proxy support at all, you may set:
2389 MyApp->config->{ignore_frontend_proxy} = 1;
2391 =head1 THREAD SAFETY
2393 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2394 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2395 believe the Catalyst core to be thread-safe.
2397 If you plan to operate in a threaded environment, remember that all other
2398 modules you are using must also be thread-safe. Some modules, most notably
2399 L<DBD::SQLite>, are not thread-safe.
2405 Join #catalyst on irc.perl.org.
2409 http://lists.rawmode.org/mailman/listinfo/catalyst
2410 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2414 http://catalyst.perl.org
2418 http://dev.catalyst.perl.org
2422 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2424 =head2 L<Catalyst::Manual> - The Catalyst Manual
2426 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2428 =head2 L<Catalyst::Engine> - Core engine
2430 =head2 L<Catalyst::Log> - Log class.
2432 =head2 L<Catalyst::Request> - Request object
2434 =head2 L<Catalyst::Response> - Response object
2436 =head2 L<Catalyst::Test> - The test suite.
2438 =head1 PROJECT FOUNDER
2440 sri: Sebastian Riedel <sri@cpan.org>
2446 acme: Leon Brocard <leon@astray.com>
2454 andyg: Andy Grundman <andy@hybridized.org>
2456 audreyt: Audrey Tang
2458 bricas: Brian Cassidy <bricas@cpan.org>
2460 chansen: Christian Hansen
2462 chicks: Christopher Hicks
2464 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2468 esskar: Sascha Kiefer
2470 fireartist: Carl Franks <cfranks@cpan.org>
2472 gabb: Danijel Milicevic
2478 jcamacho: Juan Camacho
2484 jon: Jon Schutz <jjschutz@cpan.org>
2486 marcus: Marcus Ramberg <mramberg@cpan.org>
2488 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2490 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2494 naughton: David Naughton
2496 ningu: David Kamholz <dkamholz@cpan.org>
2498 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2500 numa: Dan Sully <daniel@cpan.org>
2504 omega: Andreas Marienborg
2506 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2510 the_jester: Jesse Sheidlower
2514 willert: Sebastian Willert <willert@cpan.org>
2518 This library is free software, you can redistribute it and/or modify it under
2519 the same terms as Perl itself.
2525 __PACKAGE__->meta->make_immutable;