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 ( Scalar::Util::blessed($c) && 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>.
1014 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1015 using C<< $c->req->captures >>.
1017 # For the current action
1018 $c->uri_for($c->action, $c->req->captures);
1020 # For the Foo action in the Bar controller
1021 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1026 my ( $c, $path, @args ) = @_;
1028 if ( Scalar::Util::blessed($path) ) { # action object
1029 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1032 $path = $c->dispatcher->uri_for_action($path, $captures);
1033 return undef unless defined($path);
1034 $path = '/' if $path eq '';
1037 undef($path) if (defined $path && $path eq '');
1040 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1042 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1043 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1045 unshift(@args, $path);
1047 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1048 my $namespace = $c->namespace;
1049 if (defined $path) { # cheesy hack to handle path '../foo'
1050 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1052 unshift(@args, $namespace || '');
1055 # join args with '/', or a blank string
1056 my $args = join('/', grep { defined($_) } @args);
1057 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1059 my $base = $c->req->base;
1060 my $class = ref($base);
1061 $base =~ s{(?<!/)$}{/};
1065 if (my @keys = keys %$params) {
1066 # somewhat lifted from URI::_query's query_form
1067 $query = '?'.join('&', map {
1068 my $val = $params->{$_};
1069 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1072 $val = '' unless defined $val;
1075 utf8::encode( $_ ) if utf8::is_utf8($_);
1076 # using the URI::Escape pattern here so utf8 chars survive
1077 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1079 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1083 my $res = bless(\"${base}${args}${query}", $class);
1087 =head2 $c->welcome_message
1089 Returns the Catalyst welcome HTML page.
1093 sub welcome_message {
1095 my $name = $c->config->{name};
1096 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1097 my $prefix = Catalyst::Utils::appprefix( ref $c );
1098 $c->response->content_type('text/html; charset=utf-8');
1100 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1101 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1102 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1104 <meta http-equiv="Content-Language" content="en" />
1105 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1106 <title>$name on Catalyst $VERSION</title>
1107 <style type="text/css">
1110 background-color: #eee;
1117 margin-bottom: 10px;
1119 background-color: #ccc;
1120 border: 1px solid #aaa;
1125 font-family: verdana, tahoma, sans-serif;
1128 font-family: verdana, tahoma, sans-serif;
1131 text-decoration: none;
1133 border-bottom: 1px dotted #bbb;
1135 :link:hover, :visited:hover {
1148 background-color: #fff;
1149 border: 1px solid #aaa;
1153 font-weight: normal;
1175 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1180 <img src="$logo" alt="Catalyst Logo" />
1182 <p>Welcome to the world of Catalyst.
1183 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1184 framework will make web development something you had
1185 never expected it to be: Fun, rewarding, and quick.</p>
1186 <h2>What to do now?</h2>
1187 <p>That really depends on what <b>you</b> want to do.
1188 We do, however, provide you with a few starting points.</p>
1189 <p>If you want to jump right into web development with Catalyst
1190 you might want to start with a tutorial.</p>
1191 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1193 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1195 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1196 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1198 <h2>What to do next?</h2>
1199 <p>Next it's time to write an actual application. Use the
1200 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1201 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1202 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1203 they can save you a lot of work.</p>
1204 <pre><code>script/${prefix}_create.pl -help</code></pre>
1205 <p>Also, be sure to check out the vast and growing
1206 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1207 you are likely to find what you need there.
1211 <p>Catalyst has a very active community. Here are the main places to
1212 get in touch with us.</p>
1215 <a href="http://dev.catalyst.perl.org">Wiki</a>
1218 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1221 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1224 <h2>In conclusion</h2>
1225 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1226 as we enjoyed making it. Please contact us if you have ideas
1227 for improvement or other feedback.</p>
1235 =head1 INTERNAL METHODS
1237 These methods are not meant to be used by end users.
1239 =head2 $c->components
1241 Returns a hash of components.
1243 =head2 $c->context_class
1245 Returns or sets the context class.
1249 Returns a hashref containing coderefs and execution counts (needed for
1250 deep recursion detection).
1254 Returns the number of actions on the current internal execution stack.
1258 Dispatches a request to actions.
1262 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1264 =head2 $c->dispatcher_class
1266 Returns or sets the dispatcher class.
1268 =head2 $c->dump_these
1270 Returns a list of 2-element array references (name, structure) pairs
1271 that will be dumped on the error page in debug mode.
1277 [ Request => $c->req ],
1278 [ Response => $c->res ],
1279 [ Stash => $c->stash ],
1280 [ Config => $c->config ];
1283 =head2 $c->engine_class
1285 Returns or sets the engine class.
1287 =head2 $c->execute( $class, $coderef )
1289 Execute a coderef in given class and catch exceptions. Errors are available
1295 my ( $c, $class, $code ) = @_;
1296 $class = $c->component($class) || $class;
1299 if ( $c->depth >= $RECURSION ) {
1300 my $action = $code->reverse();
1301 $action = "/$action" unless $action =~ /->/;
1302 my $error = qq/Deep recursion detected calling "${action}"/;
1303 $c->log->error($error);
1309 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1311 push( @{ $c->stack }, $code );
1313 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1315 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1317 my $last = pop( @{ $c->stack } );
1319 if ( my $error = $@ ) {
1320 if ( !ref($error) and $error eq $DETACH ) {
1321 die $DETACH if($c->depth > 1);
1323 elsif ( !ref($error) and $error eq $GO ) {
1324 die $GO if($c->depth > 0);
1327 unless ( ref $error ) {
1328 no warnings 'uninitialized';
1330 my $class = $last->class;
1331 my $name = $last->name;
1332 $error = qq/Caught exception in $class->$name "$error"/;
1341 sub _stats_start_execute {
1342 my ( $c, $code ) = @_;
1344 return if ( ( $code->name =~ /^_.*/ )
1345 && ( !$c->config->{show_internal_actions} ) );
1347 my $action_name = $code->reverse();
1348 $c->counter->{$action_name}++;
1350 my $action = $action_name;
1351 $action = "/$action" unless $action =~ /->/;
1353 # determine if the call was the result of a forward
1354 # this is done by walking up the call stack and looking for a calling
1355 # sub of Catalyst::forward before the eval
1357 for my $index ( 2 .. 11 ) {
1359 if ( ( caller($index) )[0] eq 'Catalyst'
1360 && ( caller($index) )[3] eq '(eval)' );
1362 if ( ( caller($index) )[3] =~ /forward$/ ) {
1363 $callsub = ( caller($index) )[3];
1364 $action = "-> $action";
1369 my $uid = $action_name . $c->counter->{$action_name};
1371 # is this a root-level call or a forwarded call?
1372 if ( $callsub =~ /forward$/ ) {
1374 # forward, locate the caller
1375 if ( my $parent = $c->stack->[-1] ) {
1378 parent => "$parent" . $c->counter->{"$parent"},
1384 # forward with no caller may come from a plugin
1403 sub _stats_finish_execute {
1404 my ( $c, $info ) = @_;
1405 $c->stats->profile( end => $info );
1408 =head2 $c->_localize_fields( sub { }, \%keys );
1412 #Why does this exist? This is no longer safe and WILL NOT WORK.
1413 # it doesnt seem to be used anywhere. can we remove it?
1414 sub _localize_fields {
1415 my ( $c, $localized, $code ) = ( @_ );
1417 my $request = delete $localized->{request} || {};
1418 my $response = delete $localized->{response} || {};
1420 local @{ $c }{ keys %$localized } = values %$localized;
1421 local @{ $c->request }{ keys %$request } = values %$request;
1422 local @{ $c->response }{ keys %$response } = values %$response;
1429 Finalizes the request.
1436 for my $error ( @{ $c->error } ) {
1437 $c->log->error($error);
1440 # Allow engine to handle finalize flow (for POE)
1441 my $engine = $c->engine;
1442 if ( my $code = $engine->can('finalize') ) {
1447 $c->finalize_uploads;
1450 if ( $#{ $c->error } >= 0 ) {
1454 $c->finalize_headers;
1457 if ( $c->request->method eq 'HEAD' ) {
1458 $c->response->body('');
1464 if ($c->use_stats) {
1465 my $elapsed = sprintf '%f', $c->stats->elapsed;
1466 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1468 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1471 return $c->response->status;
1474 =head2 $c->finalize_body
1480 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1482 =head2 $c->finalize_cookies
1488 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1490 =head2 $c->finalize_error
1496 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1498 =head2 $c->finalize_headers
1504 sub finalize_headers {
1507 my $response = $c->response; #accessor calls can add up?
1509 # Check if we already finalized headers
1510 return if $response->finalized_headers;
1513 if ( my $location = $response->redirect ) {
1514 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1515 $response->header( Location => $location );
1517 #Moose TODO: we should probably be using a predicate method here ?
1518 if ( !$response->body ) {
1519 # Add a default body if none is already present
1521 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1527 if ( $response->body && !$response->content_length ) {
1529 # get the length from a filehandle
1530 if ( blessed( $response->body ) && $response->body->can('read') )
1532 my $stat = stat $response->body;
1533 if ( $stat && $stat->size > 0 ) {
1534 $response->content_length( $stat->size );
1537 $c->log->warn('Serving filehandle without a content-length');
1541 # everything should be bytes at this point, but just in case
1542 $response->content_length( bytes::length( $response->body ) );
1547 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1548 $response->headers->remove_header("Content-Length");
1549 $response->body('');
1552 $c->finalize_cookies;
1554 $c->engine->finalize_headers( $c, @_ );
1557 $response->finalized_headers(1);
1560 =head2 $c->finalize_output
1562 An alias for finalize_body.
1564 =head2 $c->finalize_read
1566 Finalizes the input after reading is complete.
1570 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1572 =head2 $c->finalize_uploads
1574 Finalizes uploads. Cleans up any temporary files.
1578 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1580 =head2 $c->get_action( $action, $namespace )
1582 Gets an action in a given namespace.
1586 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1588 =head2 $c->get_actions( $action, $namespace )
1590 Gets all actions of a given name in a namespace and all parent
1595 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1597 =head2 $c->handle_request( $class, @arguments )
1599 Called to handle each HTTP request.
1603 sub handle_request {
1604 my ( $class, @arguments ) = @_;
1606 # Always expect worst case!
1609 if ($class->debug) {
1610 my $secs = time - $START || 1;
1611 my $av = sprintf '%.3f', $COUNT / $secs;
1612 my $time = localtime time;
1613 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1616 my $c = $class->prepare(@arguments);
1618 $status = $c->finalize;
1621 if ( my $error = $@ ) {
1623 $class->log->error(qq/Caught exception in engine "$error"/);
1628 if(my $coderef = $class->log->can('_flush')){
1629 $class->log->$coderef();
1634 =head2 $c->prepare( @arguments )
1636 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1642 my ( $class, @arguments ) = @_;
1645 # After the app/ctxt split, this should become an attribute based on something passed
1646 # into the application.
1647 $class->context_class( ref $class || $class ) unless $class->context_class;
1649 my $c = $class->context_class->new({});
1651 # For on-demand data
1652 $c->request->_context($c);
1653 $c->response->_context($c);
1655 #surely this is not the most efficient way to do things...
1656 $c->stats($class->stats_class->new)->enable($c->use_stats);
1658 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1661 #XXX reuse coderef from can
1662 # Allow engine to direct the prepare flow (for POE)
1663 if ( $c->engine->can('prepare') ) {
1664 $c->engine->prepare( $c, @arguments );
1667 $c->prepare_request(@arguments);
1668 $c->prepare_connection;
1669 $c->prepare_query_parameters;
1670 $c->prepare_headers;
1671 $c->prepare_cookies;
1674 # Prepare the body for reading, either by prepare_body
1675 # or the user, if they are using $c->read
1678 # Parse the body unless the user wants it on-demand
1679 unless ( $c->config->{parse_on_demand} ) {
1684 my $method = $c->req->method || '';
1685 my $path = $c->req->path;
1686 $path = '/' unless length $path;
1687 my $address = $c->req->address || '';
1689 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1697 =head2 $c->prepare_action
1699 Prepares action. See L<Catalyst::Dispatcher>.
1703 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1705 =head2 $c->prepare_body
1707 Prepares message body.
1714 #Moose TODO: what is _body ??
1715 # Do we run for the first time?
1716 return if defined $c->request->{_body};
1718 # Initialize on-demand data
1719 $c->engine->prepare_body( $c, @_ );
1720 $c->prepare_parameters;
1721 $c->prepare_uploads;
1723 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1724 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1725 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1726 my $param = $c->req->body_parameters->{$key};
1727 my $value = defined($param) ? $param : '';
1729 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1731 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1735 =head2 $c->prepare_body_chunk( $chunk )
1737 Prepares a chunk of data before sending it to L<HTTP::Body>.
1739 See L<Catalyst::Engine>.
1743 sub prepare_body_chunk {
1745 $c->engine->prepare_body_chunk( $c, @_ );
1748 =head2 $c->prepare_body_parameters
1750 Prepares body parameters.
1754 sub prepare_body_parameters {
1756 $c->engine->prepare_body_parameters( $c, @_ );
1759 =head2 $c->prepare_connection
1761 Prepares connection.
1765 sub prepare_connection {
1767 $c->engine->prepare_connection( $c, @_ );
1770 =head2 $c->prepare_cookies
1776 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1778 =head2 $c->prepare_headers
1784 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1786 =head2 $c->prepare_parameters
1788 Prepares parameters.
1792 sub prepare_parameters {
1794 $c->prepare_body_parameters;
1795 $c->engine->prepare_parameters( $c, @_ );
1798 =head2 $c->prepare_path
1800 Prepares path and base.
1804 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1806 =head2 $c->prepare_query_parameters
1808 Prepares query parameters.
1812 sub prepare_query_parameters {
1815 $c->engine->prepare_query_parameters( $c, @_ );
1817 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1818 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1819 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1820 my $param = $c->req->query_parameters->{$key};
1821 my $value = defined($param) ? $param : '';
1823 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1825 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1829 =head2 $c->prepare_read
1831 Prepares the input for reading.
1835 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1837 =head2 $c->prepare_request
1839 Prepares the engine request.
1843 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1845 =head2 $c->prepare_uploads
1851 sub prepare_uploads {
1854 $c->engine->prepare_uploads( $c, @_ );
1856 if ( $c->debug && keys %{ $c->request->uploads } ) {
1857 my $t = Text::SimpleTable->new(
1858 [ 12, 'Parameter' ],
1863 for my $key ( sort keys %{ $c->request->uploads } ) {
1864 my $upload = $c->request->uploads->{$key};
1865 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1866 $t->row( $key, $u->filename, $u->type, $u->size );
1869 $c->log->debug( "File Uploads are:\n" . $t->draw );
1873 =head2 $c->prepare_write
1875 Prepares the output for writing.
1879 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1881 =head2 $c->request_class
1883 Returns or sets the request class.
1885 =head2 $c->response_class
1887 Returns or sets the response class.
1889 =head2 $c->read( [$maxlength] )
1891 Reads a chunk of data from the request body. This method is designed to
1892 be used in a while loop, reading C<$maxlength> bytes on every call.
1893 C<$maxlength> defaults to the size of the request if not specified.
1895 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1898 Warning: If you use read(), Catalyst will not process the body,
1899 so you will not be able to access POST parameters or file uploads via
1900 $c->request. You must handle all body parsing yourself.
1904 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1912 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1914 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1916 Sets an action in a given namespace.
1920 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1922 =head2 $c->setup_actions($component)
1924 Sets up actions for a component.
1928 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1930 =head2 $c->setup_components
1932 Sets up components. Specify a C<setup_components> config option to pass
1933 additional options directly to L<Module::Pluggable>. To add additional
1934 search paths, specify a key named C<search_extra> as an array
1935 reference. Items in the array beginning with C<::> will have the
1936 application class name prepended to them.
1938 All components found will also have any
1939 L<Devel::InnerPackage|inner packages> loaded and set up as components.
1940 Note, that modules which are B<not> an I<inner package> of the main
1941 file namespace loaded will not be instantiated as components.
1945 sub setup_components {
1948 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1949 my $config = $class->config->{ setup_components };
1950 my $extra = delete $config->{ search_extra } || [];
1952 push @paths, @$extra;
1954 my $locator = Module::Pluggable::Object->new(
1955 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1959 my @comps = sort { length $a <=> length $b } $locator->plugins;
1960 my %comps = map { $_ => 1 } @comps;
1962 for my $component ( @comps ) {
1964 # We pass ignore_loaded here so that overlay files for (e.g.)
1965 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1966 # we know M::P::O found a file on disk so this is safe
1968 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1969 #Class::MOP::load_class($component);
1971 my $module = $class->setup_component( $component );
1973 $component => $module,
1975 $_ => $class->setup_component( $_ )
1977 not exists $comps{$_}
1978 } Devel::InnerPackage::list_packages( $component )
1981 for my $key ( keys %modules ) {
1982 $class->components->{ $key } = $modules{ $key };
1987 =head2 $c->setup_component
1991 sub setup_component {
1992 my( $class, $component ) = @_;
1994 unless ( $component->can( 'COMPONENT' ) ) {
1998 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1999 my $config = $class->config->{ $suffix } || {};
2001 my $instance = eval { $component->COMPONENT( $class, $config ); };
2003 if ( my $error = $@ ) {
2005 Catalyst::Exception->throw(
2006 message => qq/Couldn't instantiate component "$component", "$error"/
2010 Catalyst::Exception->throw(
2012 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2013 ) unless blessed($instance);
2018 =head2 $c->setup_dispatcher
2024 sub setup_dispatcher {
2025 my ( $class, $dispatcher ) = @_;
2028 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2031 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2032 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2035 unless ($dispatcher) {
2036 $dispatcher = $class->dispatcher_class;
2039 Class::MOP::load_class($dispatcher);
2041 # dispatcher instance
2042 $class->dispatcher( $dispatcher->new );
2045 =head2 $c->setup_engine
2052 my ( $class, $engine ) = @_;
2055 $engine = 'Catalyst::Engine::' . $engine;
2058 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2059 $engine = 'Catalyst::Engine::' . $env;
2062 if ( $ENV{MOD_PERL} ) {
2064 # create the apache method
2065 $class->meta->add_method('apache' => sub { shift->engine->apache });
2067 my ( $software, $version ) =
2068 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2071 $version =~ s/(\.[^.]+)\./$1/g;
2073 if ( $software eq 'mod_perl' ) {
2077 if ( $version >= 1.99922 ) {
2078 $engine = 'Catalyst::Engine::Apache2::MP20';
2081 elsif ( $version >= 1.9901 ) {
2082 $engine = 'Catalyst::Engine::Apache2::MP19';
2085 elsif ( $version >= 1.24 ) {
2086 $engine = 'Catalyst::Engine::Apache::MP13';
2090 Catalyst::Exception->throw( message =>
2091 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2096 # install the correct mod_perl handler
2097 if ( $version >= 1.9901 ) {
2098 *handler = sub : method {
2099 shift->handle_request(@_);
2103 *handler = sub ($$) { shift->handle_request(@_) };
2108 elsif ( $software eq 'Zeus-Perl' ) {
2109 $engine = 'Catalyst::Engine::Zeus';
2113 Catalyst::Exception->throw(
2114 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2119 $engine = $class->engine_class;
2122 Class::MOP::load_class($engine);
2123 #unless (Class::Inspector->loaded($engine)) {
2124 # require Class::Inspector->filename($engine);
2127 # check for old engines that are no longer compatible
2129 if ( $engine->isa('Catalyst::Engine::Apache')
2130 && !Catalyst::Engine::Apache->VERSION )
2135 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2136 && Catalyst::Engine::Server->VERSION le '0.02' )
2141 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2142 && $engine->VERSION eq '0.01' )
2147 elsif ($engine->isa('Catalyst::Engine::Zeus')
2148 && $engine->VERSION eq '0.01' )
2154 Catalyst::Exception->throw( message =>
2155 qq/Engine "$engine" is not supported by this version of Catalyst/
2160 $class->engine( $engine->new );
2163 =head2 $c->setup_home
2165 Sets up the home directory.
2170 my ( $class, $home ) = @_;
2172 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2176 $home ||= Catalyst::Utils::home($class);
2179 #I remember recently being scolded for assigning config values like this
2180 $class->config->{home} ||= $home;
2181 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2185 =head2 $c->setup_log
2192 my ( $class, $debug ) = @_;
2194 unless ( $class->log ) {
2195 $class->log( Catalyst::Log->new );
2198 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2199 if ( defined($env_debug) ? $env_debug : $debug ) {
2200 $class->meta->add_method('debug' => sub { 1 });
2201 $class->log->debug('Debug messages enabled');
2205 =head2 $c->setup_plugins
2211 =head2 $c->setup_stats
2213 Sets up timing statistics class.
2218 my ( $class, $stats ) = @_;
2220 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2222 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2223 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2224 $class->meta->add_method('use_stats' => sub { 1 });
2225 $class->log->debug('Statistics enabled');
2230 =head2 $c->registered_plugins
2232 Returns a sorted list of the plugins which have either been stated in the
2233 import list or which have been added via C<< MyApp->plugin(@args); >>.
2235 If passed a given plugin name, it will report a boolean value indicating
2236 whether or not that plugin is loaded. A fully qualified name is required if
2237 the plugin name does not begin with C<Catalyst::Plugin::>.
2239 if ($c->registered_plugins('Some::Plugin')) {
2247 sub registered_plugins {
2249 return sort keys %{ $proto->_plugins } unless @_;
2251 return 1 if exists $proto->_plugins->{$plugin};
2252 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2255 sub _register_plugin {
2256 my ( $proto, $plugin, $instant ) = @_;
2257 my $class = ref $proto || $proto;
2259 # no ignore_loaded here, the plugin may already have been
2260 # defined in memory and we don't want to error on "no file" if so
2262 Class::MOP::load_class( $plugin );
2264 $proto->_plugins->{$plugin} = 1;
2267 if( $class->can('meta') ){
2268 my @superclasses = ($plugin, $class->meta->superclasses );
2269 $class->meta->superclasses(@superclasses);
2271 unshift @{"$class\::ISA"}, $plugin;
2278 my ( $class, $plugins ) = @_;
2280 $class->_plugins( {} ) unless $class->_plugins;
2282 for my $plugin ( reverse @$plugins ) {
2284 unless ( $plugin =~ s/\A\+// ) {
2285 $plugin = "Catalyst::Plugin::$plugin";
2288 $class->_register_plugin($plugin);
2295 Returns an arrayref of the internal execution stack (actions that are
2296 currently executing).
2298 =head2 $c->stats_class
2300 Returns or sets the stats (timing statistics) class.
2302 =head2 $c->use_stats
2304 Returns 1 when stats collection is enabled. Stats collection is enabled
2305 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2306 environment variable is set.
2308 Note that this is a static method, not an accessor and should be overloaded
2309 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2316 =head2 $c->write( $data )
2318 Writes $data to the output stream. When using this method directly, you
2319 will need to manually set the C<Content-Length> header to the length of
2320 your output data, if known.
2327 # Finalize headers if someone manually writes output
2328 $c->finalize_headers;
2330 return $c->engine->write( $c, @_ );
2335 Returns the Catalyst version number. Mostly useful for "powered by"
2336 messages in template systems.
2340 sub version { return $Catalyst::VERSION }
2342 =head1 INTERNAL ACTIONS
2344 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2345 C<_ACTION>, and C<_END>. These are by default not shown in the private
2346 action table, but you can make them visible with a config parameter.
2348 MyApp->config->{show_internal_actions} = 1;
2350 =head1 CASE SENSITIVITY
2352 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2353 mapped to C</foo/bar>. You can activate case sensitivity with a config
2356 MyApp->config->{case_sensitive} = 1;
2358 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2360 =head1 ON-DEMAND PARSER
2362 The request body is usually parsed at the beginning of a request,
2363 but if you want to handle input yourself, you can enable on-demand
2364 parsing with a config parameter.
2366 MyApp->config->{parse_on_demand} = 1;
2368 =head1 PROXY SUPPORT
2370 Many production servers operate using the common double-server approach,
2371 with a lightweight frontend web server passing requests to a larger
2372 backend server. An application running on the backend server must deal
2373 with two problems: the remote user always appears to be C<127.0.0.1> and
2374 the server's hostname will appear to be C<localhost> regardless of the
2375 virtual host that the user connected through.
2377 Catalyst will automatically detect this situation when you are running
2378 the frontend and backend servers on the same machine. The following
2379 changes are made to the request.
2381 $c->req->address is set to the user's real IP address, as read from
2382 the HTTP X-Forwarded-For header.
2384 The host value for $c->req->base and $c->req->uri is set to the real
2385 host, as read from the HTTP X-Forwarded-Host header.
2387 Obviously, your web server must support these headers for this to work.
2389 In a more complex server farm environment where you may have your
2390 frontend proxy server(s) on different machines, you will need to set a
2391 configuration option to tell Catalyst to read the proxied data from the
2394 MyApp->config->{using_frontend_proxy} = 1;
2396 If you do not wish to use the proxy support at all, you may set:
2398 MyApp->config->{ignore_frontend_proxy} = 1;
2400 =head1 THREAD SAFETY
2402 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2403 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2404 believe the Catalyst core to be thread-safe.
2406 If you plan to operate in a threaded environment, remember that all other
2407 modules you are using must also be thread-safe. Some modules, most notably
2408 L<DBD::SQLite>, are not thread-safe.
2414 Join #catalyst on irc.perl.org.
2418 http://lists.rawmode.org/mailman/listinfo/catalyst
2419 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2423 http://catalyst.perl.org
2427 http://dev.catalyst.perl.org
2431 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2433 =head2 L<Catalyst::Manual> - The Catalyst Manual
2435 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2437 =head2 L<Catalyst::Engine> - Core engine
2439 =head2 L<Catalyst::Log> - Log class.
2441 =head2 L<Catalyst::Request> - Request object
2443 =head2 L<Catalyst::Response> - Response object
2445 =head2 L<Catalyst::Test> - The test suite.
2447 =head1 PROJECT FOUNDER
2449 sri: Sebastian Riedel <sri@cpan.org>
2455 acme: Leon Brocard <leon@astray.com>
2463 andyg: Andy Grundman <andy@hybridized.org>
2465 audreyt: Audrey Tang
2467 bricas: Brian Cassidy <bricas@cpan.org>
2469 chansen: Christian Hansen
2471 chicks: Christopher Hicks
2473 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2477 esskar: Sascha Kiefer
2479 fireartist: Carl Franks <cfranks@cpan.org>
2481 gabb: Danijel Milicevic
2487 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2489 jcamacho: Juan Camacho
2495 jon: Jon Schutz <jjschutz@cpan.org>
2497 marcus: Marcus Ramberg <mramberg@cpan.org>
2499 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2501 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2505 naughton: David Naughton
2507 ningu: David Kamholz <dkamholz@cpan.org>
2509 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2511 numa: Dan Sully <daniel@cpan.org>
2515 omega: Andreas Marienborg
2517 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2519 rafl: Florian Ragwitz <rafl@debian.org>
2523 the_jester: Jesse Sheidlower
2527 willert: Sebastian Willert <willert@cpan.org>
2531 This library is free software, you can redistribute it and/or modify it under
2532 the same terms as Perl itself.
2538 __PACKAGE__->meta->make_immutable;