3 # we don't need really need this, but if we load it before MRO::Compat gets
4 # loaded (via Moose and Class::MOP), we can avoid some nasty warnings
8 extends 'Catalyst::Component';
10 use Catalyst::Exception;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
17 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
23 use Time::HiRes qw/gettimeofday tv_interval/;
27 use Scalar::Util qw/weaken blessed/;
28 use Tree::Simple qw/use_weak_refs/;
29 use Tree::Simple::Visitor::FindByUID;
32 use Carp qw/croak carp/;
34 BEGIN { require 5.008001; }
36 has stack => (is => 'rw', default => sub { [] });
37 has stash => (is => 'rw', default => sub { {} });
38 has state => (is => 'rw', default => 0);
39 has stats => (is => 'rw');
40 has action => (is => 'rw');
41 has counter => (is => 'rw', default => sub { {} });
42 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
43 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
44 has namespace => (is => 'rw');
46 sub depth { scalar @{ shift->stack || [] }; }
47 sub comp { shift->component(@_) }
50 # carp "the use of req() is deprecated in favour of request()";
51 my $self = shift; return $self->request(@_);
54 # carp "the use of res() is deprecated in favour of response()";
55 my $self = shift; return $self->response(@_);
58 # For backwards compatibility
59 sub finalize_output { shift->finalize_body(@_) };
64 our $RECURSION = 1000;
65 our $DETACH = "catalyst_detach\n";
66 our $GO = "catalyst_go\n";
68 #I imagine that very few of these really need to be class variables. if any.
69 #maybe we should just make them attributes with a default?
70 __PACKAGE__->mk_classdata($_)
71 for qw/components arguments dispatcher engine log dispatcher_class
72 engine_class context_class request_class response_class stats_class
75 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
76 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
77 __PACKAGE__->request_class('Catalyst::Request');
78 __PACKAGE__->response_class('Catalyst::Response');
79 __PACKAGE__->stats_class('Catalyst::Stats');
81 # Remember to update this in Catalyst::Runtime as well!
83 our $VERSION = '5.8000_04';
86 my ( $class, @arguments ) = @_;
88 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
90 return unless $class eq 'Catalyst';
92 my $caller = caller();
93 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 #Moose->import({ into => $caller }); #do we want to do this?
97 unless ( $caller->isa('Catalyst') ) {
98 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
99 $meta->superclasses(@superclasses);
101 unless( $meta->has_method('meta') ){
102 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
105 $caller->arguments( [@arguments] );
111 Catalyst - The Elegant MVC Web Application Framework
115 See the L<Catalyst::Manual> distribution for comprehensive
116 documentation and tutorials.
118 # Install Catalyst::Devel for helpers and other development tools
119 # use the helper to create a new application
122 # add models, views, controllers
123 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
124 script/myapp_create.pl view MyTemplate TT
125 script/myapp_create.pl controller Search
127 # built in testserver -- use -r to restart automatically on changes
128 # --help to see all available options
129 script/myapp_server.pl
131 # command line testing interface
132 script/myapp_test.pl /yada
135 use Catalyst qw/-Debug/; # include plugins here as well
137 ### In lib/MyApp/Controller/Root.pm (autocreated)
138 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
139 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
140 $c->stash->{template} = 'foo.tt'; # set the template
141 # lookup something from db -- stash vars are passed to TT
143 $c->model('Database::Foo')->search( { country => $args[0] } );
144 if ( $c->req->params->{bar} ) { # access GET or POST parameters
145 $c->forward( 'bar' ); # process another action
146 # do something else after forward returns
150 # The foo.tt TT template can use the stash data from the database
151 [% WHILE (item = data.next) %]
155 # called for /bar/of/soap, /bar/of/soap/10, etc.
156 sub bar : Path('/bar/of/soap') { ... }
158 # called for all actions, from the top-most controller downwards
160 my ( $self, $c ) = @_;
161 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
162 $c->res->redirect( '/login' ); # require login
163 return 0; # abort request and go immediately to end()
165 return 1; # success; carry on to next action
168 # called after all actions are finished
170 my ( $self, $c ) = @_;
171 if ( scalar @{ $c->error } ) { ... } # handle errors
172 return if $c->res->body; # already have a response
173 $c->forward( 'MyApp::View::TT' ); # render template
176 ### in MyApp/Controller/Foo.pm
177 # called for /foo/bar
178 sub bar : Local { ... }
180 # called for /blargle
181 sub blargle : Global { ... }
183 # an index action matches /foo, but not /foo/1, etc.
184 sub index : Private { ... }
186 ### in MyApp/Controller/Foo/Bar.pm
187 # called for /foo/bar/baz
188 sub baz : Local { ... }
190 # first Root auto is called, then Foo auto, then this
191 sub auto : Private { ... }
193 # powerful regular expression paths are also possible
194 sub details : Regex('^product/(\w+)/details$') {
195 my ( $self, $c ) = @_;
196 # extract the (\w+) from the URI
197 my $product = $c->req->captures->[0];
200 See L<Catalyst::Manual::Intro> for additional information.
204 Catalyst is a modern framework for making web applications without the
205 pain usually associated with this process. This document is a reference
206 to the main Catalyst application. If you are a new user, we suggest you
207 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
209 See L<Catalyst::Manual> for more documentation.
211 Catalyst plugins can be loaded by naming them as arguments to the "use
212 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
213 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
216 use Catalyst qw/My::Module/;
218 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
219 fully qualify the name by using a unary plus:
223 +Fully::Qualified::Plugin::Name
226 Special flags like C<-Debug> and C<-Engine> can also be specified as
227 arguments when Catalyst is loaded:
229 use Catalyst qw/-Debug My::Module/;
231 The position of plugins and flags in the chain is important, because
232 they are loaded in the order in which they appear.
234 The following flags are supported:
238 Enables debug output. You can also force this setting from the system
239 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
240 settings override the application, with <MYAPP>_DEBUG having the highest
245 Forces Catalyst to use a specific engine. Omit the
246 C<Catalyst::Engine::> prefix of the engine name, i.e.:
248 use Catalyst qw/-Engine=CGI/;
252 Forces Catalyst to use a specific home directory, e.g.:
254 use Catalyst qw[-Home=/usr/mst];
256 This can also be done in the shell environment by setting either the
257 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
258 is replaced with the uppercased name of your application, any "::" in
259 the name will be replaced with underscores, e.g. MyApp::Web should use
260 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
268 Enables statistics collection and reporting. You can also force this setting
269 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
270 environment settings override the application, with <MYAPP>_STATS having the
275 use Catalyst qw/-Stats=1/
279 =head2 INFORMATION ABOUT THE CURRENT REQUEST
283 Returns a L<Catalyst::Action> object for the current action, which
284 stringifies to the action name. See L<Catalyst::Action>.
288 Returns the namespace of the current action, i.e., the URI prefix
289 corresponding to the controller of the current action. For example:
291 # in Controller::Foo::Bar
292 $c->namespace; # returns 'foo/bar';
298 Returns the current L<Catalyst::Request> object, giving access to
299 information about the current client request (including parameters,
300 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
302 =head2 REQUEST FLOW HANDLING
304 =head2 $c->forward( $action [, \@arguments ] )
306 =head2 $c->forward( $class, $method, [, \@arguments ] )
308 Forwards processing to another action, by its private name. If you give a
309 class name but no method, C<process()> is called. You may also optionally
310 pass arguments in an arrayref. The action will receive the arguments in
311 C<@_> and C<< $c->req->args >>. Upon returning from the function,
312 C<< $c->req->args >> will be restored to the previous values.
314 Any data C<return>ed from the action forwarded to, will be returned by the
317 my $foodata = $c->forward('/foo');
318 $c->forward('index');
319 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
320 $c->forward('MyApp::View::TT');
322 Note that forward implies an C<<eval { }>> around the call (actually
323 C<execute> does), thus de-fatalizing all 'dies' within the called
324 action. If you want C<die> to propagate you need to do something like:
327 die $c->error if $c->error;
329 Or make sure to always return true values from your actions and write
332 $c->forward('foo') || return;
336 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
338 =head2 $c->detach( $action [, \@arguments ] )
340 =head2 $c->detach( $class, $method, [, \@arguments ] )
344 The same as C<forward>, but doesn't return to the previous action when
345 processing is finished.
347 When called with no arguments it escapes the processing chain entirely.
351 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
353 =head2 $c->visit( $action [, \@arguments ] )
355 =head2 $c->visit( $class, $method, [, \@arguments ] )
357 Almost the same as C<forward>, but does a full dispatch, instead of just
358 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
359 C<auto> and the method you go to are called, just like a new request.
361 C<$c-E<gt>stash> is kept unchanged.
363 In effect, C<visit> allows you to "wrap" another action, just as it
364 would have been called by dispatching from a URL, while the analogous
365 C<go> allows you to transfer control to another action as if it had
366 been reached directly from a URL.
370 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
372 =head2 $c->go( $action [, \@arguments ] )
374 =head2 $c->go( $class, $method, [, \@arguments ] )
376 Almost the same as C<detach>, but does a full dispatch like C<visit>,
377 instead of just calling the new C<$action> /
378 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
379 method you visit are called, just like a new request.
381 C<$c-E<gt>stash> is kept unchanged.
385 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
391 Returns the current L<Catalyst::Response> object, see there for details.
395 Returns a hashref to the stash, which may be used to store data and pass
396 it between components during a request. You can also set hash keys by
397 passing arguments. The stash is automatically sent to the view. The
398 stash is cleared at the end of a request; it cannot be used for
399 persistent storage (for this you must use a session; see
400 L<Catalyst::Plugin::Session> for a complete system integrated with
403 $c->stash->{foo} = $bar;
404 $c->stash( { moose => 'majestic', qux => 0 } );
405 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
407 # stash is automatically passed to the view for use in a template
408 $c->forward( 'MyApp::View::TT' );
412 around stash => sub {
415 my $stash = $orig->($c);
417 my $new_stash = @_ > 1 ? {@_} : $_[0];
418 croak('stash takes a hash or hashref') unless ref $new_stash;
419 foreach my $key ( keys %$new_stash ) {
420 $stash->{$key} = $new_stash->{$key};
430 =head2 $c->error($error, ...)
432 =head2 $c->error($arrayref)
434 Returns an arrayref containing error messages. If Catalyst encounters an
435 error while processing a request, it stores the error in $c->error. This
436 method should only be used to store fatal error messages.
438 my @error = @{ $c->error };
442 $c->error('Something bad happened');
449 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
450 croak @$error unless ref $c;
451 push @{ $c->{error} }, @$error;
453 elsif ( defined $_[0] ) { $c->{error} = undef }
454 return $c->{error} || [];
460 Contains the return value of the last executed action.
462 =head2 $c->clear_errors
464 Clear errors. You probably don't want to clear the errors unless you are
465 implementing a custom error screen.
467 This is equivalent to running
478 # search components given a name and some prefixes
479 sub _comp_search_prefixes {
480 my ( $c, $name, @prefixes ) = @_;
481 my $appclass = ref $c || $c;
482 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
484 # map the original component name to the sub part that we will search against
485 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
486 grep { /$filter/ } keys %{ $c->components };
488 # undef for a name will return all
489 return keys %eligible if !defined $name;
491 my $query = ref $name ? $name : qr/^$name$/i;
492 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
494 return map { $c->components->{ $_ } } @result if @result;
496 # if we were given a regexp to search against, we're done.
501 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
503 # no results? try against full names
505 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
508 # don't warn if we didn't find any results, it just might not exist
510 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
511 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' );
512 $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' );
518 # Find possible names for a prefix
520 my ( $c, @prefixes ) = @_;
521 my $appclass = ref $c || $c;
523 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
525 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
529 # Filter a component before returning by calling ACCEPT_CONTEXT if available
530 sub _filter_component {
531 my ( $c, $comp, @args ) = @_;
533 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
534 return $comp->ACCEPT_CONTEXT( $c, @args );
540 =head2 COMPONENT ACCESSORS
542 =head2 $c->controller($name)
544 Gets a L<Catalyst::Controller> instance by name.
546 $c->controller('Foo')->do_stuff;
548 If the name is omitted, will return the controller for the dispatched
551 If you want to search for controllers, pass in a regexp as the argument.
553 # find all controllers that start with Foo
554 my @foo_controllers = $c->controller(qr{^Foo});
560 my ( $c, $name, @args ) = @_;
563 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
564 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
565 return $c->_filter_component( $result[ 0 ], @args );
568 return $c->component( $c->action->class );
571 =head2 $c->model($name)
573 Gets a L<Catalyst::Model> instance by name.
575 $c->model('Foo')->do_stuff;
577 Any extra arguments are directly passed to ACCEPT_CONTEXT.
579 If the name is omitted, it will look for
580 - a model object in $c->stash->{current_model_instance}, then
581 - a model name in $c->stash->{current_model}, then
582 - a config setting 'default_model', or
583 - check if there is only one model, and return it if that's the case.
585 If you want to search for models, pass in a regexp as the argument.
587 # find all models that start with Foo
588 my @foo_models = $c->model(qr{^Foo});
593 my ( $c, $name, @args ) = @_;
596 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
597 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
598 return $c->_filter_component( $result[ 0 ], @args );
602 return $c->stash->{current_model_instance}
603 if $c->stash->{current_model_instance};
604 return $c->model( $c->stash->{current_model} )
605 if $c->stash->{current_model};
607 return $c->model( $c->config->{default_model} )
608 if $c->config->{default_model};
610 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
613 $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' );
614 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
615 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
616 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
617 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
620 return $c->_filter_component( $comp );
624 =head2 $c->view($name)
626 Gets a L<Catalyst::View> instance by name.
628 $c->view('Foo')->do_stuff;
630 Any extra arguments are directly passed to ACCEPT_CONTEXT.
632 If the name is omitted, it will look for
633 - a view object in $c->stash->{current_view_instance}, then
634 - a view name in $c->stash->{current_view}, then
635 - a config setting 'default_view', or
636 - check if there is only one view, and return it if that's the case.
638 If you want to search for views, pass in a regexp as the argument.
640 # find all views that start with Foo
641 my @foo_views = $c->view(qr{^Foo});
646 my ( $c, $name, @args ) = @_;
649 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
650 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
651 return $c->_filter_component( $result[ 0 ], @args );
655 return $c->stash->{current_view_instance}
656 if $c->stash->{current_view_instance};
657 return $c->view( $c->stash->{current_view} )
658 if $c->stash->{current_view};
660 return $c->view( $c->config->{default_view} )
661 if $c->config->{default_view};
663 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
666 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
667 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
668 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
669 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
670 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
673 return $c->_filter_component( $comp );
676 =head2 $c->controllers
678 Returns the available names which can be passed to $c->controller
684 return $c->_comp_names(qw/Controller C/);
689 Returns the available names which can be passed to $c->model
695 return $c->_comp_names(qw/Model M/);
701 Returns the available names which can be passed to $c->view
707 return $c->_comp_names(qw/View V/);
710 =head2 $c->comp($name)
712 =head2 $c->component($name)
714 Gets a component object by name. This method is not recommended,
715 unless you want to get a specific component by full
716 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
717 should be used instead.
719 If C<$name> is a regexp, a list of components matched against the full
720 component name will be returned.
725 my ( $c, $name, @args ) = @_;
728 my $comps = $c->components;
731 # is it the exact name?
732 return $c->_filter_component( $comps->{ $name }, @args )
733 if exists $comps->{ $name };
735 # perhaps we just omitted "MyApp"?
736 my $composed = ( ref $c || $c ) . "::${name}";
737 return $c->_filter_component( $comps->{ $composed }, @args )
738 if exists $comps->{ $composed };
740 # search all of the models, views and controllers
741 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
742 return $c->_filter_component( $comp, @args ) if $comp;
745 # This is here so $c->comp( '::M::' ) works
746 my $query = ref $name ? $name : qr{$name}i;
748 my @result = grep { m{$query} } keys %{ $c->components };
749 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
752 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
753 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
754 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
755 return $c->_filter_component( $result[ 0 ], @args );
758 # I would expect to return an empty list here, but that breaks back-compat
762 return sort keys %{ $c->components };
765 =head2 CLASS DATA AND HELPER CLASSES
769 Returns or takes a hashref containing the application's configuration.
771 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
773 You can also use a C<YAML>, C<XML> or C<Config::General> config file
774 like myapp.yml in your applications home directory. See
775 L<Catalyst::Plugin::ConfigLoader>.
778 db: dsn:SQLite:foo.db
783 around config => sub {
787 $c->log->warn("Setting config after setup has been run is not a good idea.")
788 if ( @_ and $c->setup_finished );
795 Returns the logging object instance. Unless it is already set, Catalyst
796 sets this up with a L<Catalyst::Log> object. To use your own log class,
797 set the logger with the C<< __PACKAGE__->log >> method prior to calling
798 C<< __PACKAGE__->setup >>.
800 __PACKAGE__->log( MyLogger->new );
805 $c->log->info( 'Now logging with my own logger!' );
807 Your log class should implement the methods described in
813 Overload to enable debug messages (same as -Debug option).
815 Note that this is a static method, not an accessor and should be overloaded
816 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
822 =head2 $c->dispatcher
824 Returns the dispatcher instance. Stringifies to class name. See
825 L<Catalyst::Dispatcher>.
829 Returns the engine instance. Stringifies to the class name. See
833 =head2 UTILITY METHODS
835 =head2 $c->path_to(@path)
837 Merges C<@path> with C<< $c->config->{home} >> and returns a
838 L<Path::Class::Dir> object.
842 $c->path_to( 'db', 'sqlite.db' );
847 my ( $c, @path ) = @_;
848 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
849 if ( -d $path ) { return $path }
850 else { return Path::Class::File->new( $c->config->{home}, @path ) }
853 =head2 $c->plugin( $name, $class, @args )
855 Helper method for plugins. It creates a classdata accessor/mutator and
856 loads and instantiates the given class.
858 MyApp->plugin( 'prototype', 'HTML::Prototype' );
860 $c->prototype->define_javascript_functions;
865 my ( $class, $name, $plugin, @args ) = @_;
866 $class->_register_plugin( $plugin, 1 );
868 eval { $plugin->import };
869 $class->mk_classdata($name);
871 eval { $obj = $plugin->new(@args) };
874 Catalyst::Exception->throw( message =>
875 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
879 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
885 Initializes the dispatcher and engine, loads any plugins, and loads the
886 model, view, and controller components. You may also specify an array
887 of plugins to load here, if you choose to not load them in the C<use
891 MyApp->setup( qw/-Debug/ );
896 my ( $class, @arguments ) = @_;
897 $class->log->warn("Running setup twice is not a good idea.")
898 if ( $class->setup_finished );
900 unless ( $class->isa('Catalyst') ) {
902 Catalyst::Exception->throw(
903 message => qq/'$class' does not inherit from Catalyst/ );
906 if ( $class->arguments ) {
907 @arguments = ( @arguments, @{ $class->arguments } );
913 foreach (@arguments) {
917 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
919 elsif (/^-(\w+)=?(.*)$/) {
920 $flags->{ lc $1 } = $2;
923 push @{ $flags->{plugins} }, $_;
927 $class->setup_home( delete $flags->{home} );
929 $class->setup_log( delete $flags->{log} );
930 $class->setup_plugins( delete $flags->{plugins} );
931 $class->setup_dispatcher( delete $flags->{dispatcher} );
932 $class->setup_engine( delete $flags->{engine} );
933 $class->setup_stats( delete $flags->{stats} );
935 for my $flag ( sort keys %{$flags} ) {
937 if ( my $code = $class->can( 'setup_' . $flag ) ) {
938 &$code( $class, delete $flags->{$flag} );
941 $class->log->warn(qq/Unknown flag "$flag"/);
945 eval { require Catalyst::Devel; };
946 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
947 $class->log->warn(<<"EOF");
948 You are running an old script!
950 Please update by running (this will overwrite existing files):
951 catalyst.pl -force -scripts $class
953 or (this will not overwrite existing files):
954 catalyst.pl -scripts $class
959 if ( $class->debug ) {
960 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
963 my $t = Text::SimpleTable->new(74);
964 $t->row($_) for @plugins;
965 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
968 my $dispatcher = $class->dispatcher;
969 my $engine = $class->engine;
970 my $home = $class->config->{home};
972 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
973 $class->log->debug(qq/Loaded engine "$engine"/);
977 ? $class->log->debug(qq/Found home "$home"/)
978 : $class->log->debug(qq/Home "$home" doesn't exist/)
979 : $class->log->debug(q/Couldn't find home/);
984 no warnings qw/redefine/;
985 local *setup = sub { };
989 # Initialize our data structure
990 $class->components( {} );
992 $class->setup_components;
994 if ( $class->debug ) {
995 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
996 for my $comp ( sort keys %{ $class->components } ) {
997 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
998 $t->row( $comp, $type );
1000 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1001 if ( keys %{ $class->components } );
1004 # Add our self to components, since we are also a component
1005 if( $class->isa('Catalyst::Controller') ){
1006 $class->components->{$class} = $class;
1009 $class->setup_actions;
1011 if ( $class->debug ) {
1012 my $name = $class->config->{name} || 'Application';
1013 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1015 $class->log->_flush() if $class->log->can('_flush');
1017 $class->setup_finished(1);
1020 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1022 =head2 $c->uri_for( $path, @args?, \%query_values? )
1028 A Catalyst::Action object representing the Catalyst action you want to
1029 create a URI for. To get one for an action in the current controller,
1030 use C<< $c->action('someactionname') >>. To get one from different
1031 controller, fetch the controller using C<< $c->controller() >>, then
1032 call C<action_for> on it.
1034 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1035 using C<< $c->req->captures >>.
1037 # For the current action
1038 $c->uri_for($c->action, $c->req->captures);
1040 # For the Foo action in the Bar controller
1041 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1048 my ( $c, $path, @args ) = @_;
1050 if ( Scalar::Util::blessed($path) ) { # action object
1051 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1054 $path = $c->dispatcher->uri_for_action($path, $captures);
1055 return undef unless defined($path);
1056 $path = '/' if $path eq '';
1059 undef($path) if (defined $path && $path eq '');
1062 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1064 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1065 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1067 unshift(@args, $path);
1069 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1070 my $namespace = $c->namespace;
1071 if (defined $path) { # cheesy hack to handle path '../foo'
1072 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1074 unshift(@args, $namespace || '');
1077 # join args with '/', or a blank string
1078 my $args = join('/', grep { defined($_) } @args);
1079 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1081 my $base = $c->req->base;
1082 my $class = ref($base);
1083 $base =~ s{(?<!/)$}{/};
1087 if (my @keys = keys %$params) {
1088 # somewhat lifted from URI::_query's query_form
1089 $query = '?'.join('&', map {
1090 my $val = $params->{$_};
1091 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1094 $val = '' unless defined $val;
1097 utf8::encode( $_ ) if utf8::is_utf8($_);
1098 # using the URI::Escape pattern here so utf8 chars survive
1099 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1101 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1105 my $res = bless(\"${base}${args}${query}", $class);
1109 =head2 $c->welcome_message
1111 Returns the Catalyst welcome HTML page.
1115 sub welcome_message {
1117 my $name = $c->config->{name};
1118 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1119 my $prefix = Catalyst::Utils::appprefix( ref $c );
1120 $c->response->content_type('text/html; charset=utf-8');
1122 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1123 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1124 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1126 <meta http-equiv="Content-Language" content="en" />
1127 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1128 <title>$name on Catalyst $VERSION</title>
1129 <style type="text/css">
1132 background-color: #eee;
1139 margin-bottom: 10px;
1141 background-color: #ccc;
1142 border: 1px solid #aaa;
1147 font-family: verdana, tahoma, sans-serif;
1150 font-family: verdana, tahoma, sans-serif;
1153 text-decoration: none;
1155 border-bottom: 1px dotted #bbb;
1157 :link:hover, :visited:hover {
1170 background-color: #fff;
1171 border: 1px solid #aaa;
1175 font-weight: normal;
1197 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1202 <img src="$logo" alt="Catalyst Logo" />
1204 <p>Welcome to the world of Catalyst.
1205 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1206 framework will make web development something you had
1207 never expected it to be: Fun, rewarding, and quick.</p>
1208 <h2>What to do now?</h2>
1209 <p>That really depends on what <b>you</b> want to do.
1210 We do, however, provide you with a few starting points.</p>
1211 <p>If you want to jump right into web development with Catalyst
1212 you might want to start with a tutorial.</p>
1213 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1215 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1217 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1218 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1220 <h2>What to do next?</h2>
1221 <p>Next it's time to write an actual application. Use the
1222 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1223 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1224 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1225 they can save you a lot of work.</p>
1226 <pre><code>script/${prefix}_create.pl -help</code></pre>
1227 <p>Also, be sure to check out the vast and growing
1228 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1229 you are likely to find what you need there.
1233 <p>Catalyst has a very active community. Here are the main places to
1234 get in touch with us.</p>
1237 <a href="http://dev.catalyst.perl.org">Wiki</a>
1240 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1243 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1246 <h2>In conclusion</h2>
1247 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1248 as we enjoyed making it. Please contact us if you have ideas
1249 for improvement or other feedback.</p>
1257 =head1 INTERNAL METHODS
1259 These methods are not meant to be used by end users.
1261 =head2 $c->components
1263 Returns a hash of components.
1265 =head2 $c->context_class
1267 Returns or sets the context class.
1271 Returns a hashref containing coderefs and execution counts (needed for
1272 deep recursion detection).
1276 Returns the number of actions on the current internal execution stack.
1280 Dispatches a request to actions.
1284 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1286 =head2 $c->dispatcher_class
1288 Returns or sets the dispatcher class.
1290 =head2 $c->dump_these
1292 Returns a list of 2-element array references (name, structure) pairs
1293 that will be dumped on the error page in debug mode.
1299 [ Request => $c->req ],
1300 [ Response => $c->res ],
1301 [ Stash => $c->stash ],
1302 [ Config => $c->config ];
1305 =head2 $c->engine_class
1307 Returns or sets the engine class.
1309 =head2 $c->execute( $class, $coderef )
1311 Execute a coderef in given class and catch exceptions. Errors are available
1317 my ( $c, $class, $code ) = @_;
1318 $class = $c->component($class) || $class;
1321 if ( $c->depth >= $RECURSION ) {
1322 my $action = $code->reverse();
1323 $action = "/$action" unless $action =~ /->/;
1324 my $error = qq/Deep recursion detected calling "${action}"/;
1325 $c->log->error($error);
1331 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1333 push( @{ $c->stack }, $code );
1335 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1337 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1339 my $last = pop( @{ $c->stack } );
1341 if ( my $error = $@ ) {
1342 if ( !ref($error) and $error eq $DETACH ) {
1343 die $DETACH if($c->depth > 1);
1345 elsif ( !ref($error) and $error eq $GO ) {
1346 die $GO if($c->depth > 0);
1349 unless ( ref $error ) {
1350 no warnings 'uninitialized';
1352 my $class = $last->class;
1353 my $name = $last->name;
1354 $error = qq/Caught exception in $class->$name "$error"/;
1363 sub _stats_start_execute {
1364 my ( $c, $code ) = @_;
1366 return if ( ( $code->name =~ /^_.*/ )
1367 && ( !$c->config->{show_internal_actions} ) );
1369 my $action_name = $code->reverse();
1370 $c->counter->{$action_name}++;
1372 my $action = $action_name;
1373 $action = "/$action" unless $action =~ /->/;
1375 # determine if the call was the result of a forward
1376 # this is done by walking up the call stack and looking for a calling
1377 # sub of Catalyst::forward before the eval
1379 for my $index ( 2 .. 11 ) {
1381 if ( ( caller($index) )[0] eq 'Catalyst'
1382 && ( caller($index) )[3] eq '(eval)' );
1384 if ( ( caller($index) )[3] =~ /forward$/ ) {
1385 $callsub = ( caller($index) )[3];
1386 $action = "-> $action";
1391 my $uid = $action_name . $c->counter->{$action_name};
1393 # is this a root-level call or a forwarded call?
1394 if ( $callsub =~ /forward$/ ) {
1396 # forward, locate the caller
1397 if ( my $parent = $c->stack->[-1] ) {
1400 parent => "$parent" . $c->counter->{"$parent"},
1406 # forward with no caller may come from a plugin
1425 sub _stats_finish_execute {
1426 my ( $c, $info ) = @_;
1427 $c->stats->profile( end => $info );
1430 =head2 $c->_localize_fields( sub { }, \%keys );
1434 #Why does this exist? This is no longer safe and WILL NOT WORK.
1435 # it doesnt seem to be used anywhere. can we remove it?
1436 sub _localize_fields {
1437 my ( $c, $localized, $code ) = ( @_ );
1439 my $request = delete $localized->{request} || {};
1440 my $response = delete $localized->{response} || {};
1442 local @{ $c }{ keys %$localized } = values %$localized;
1443 local @{ $c->request }{ keys %$request } = values %$request;
1444 local @{ $c->response }{ keys %$response } = values %$response;
1451 Finalizes the request.
1458 for my $error ( @{ $c->error } ) {
1459 $c->log->error($error);
1462 # Allow engine to handle finalize flow (for POE)
1463 my $engine = $c->engine;
1464 if ( my $code = $engine->can('finalize') ) {
1469 $c->finalize_uploads;
1472 if ( $#{ $c->error } >= 0 ) {
1476 $c->finalize_headers;
1479 if ( $c->request->method eq 'HEAD' ) {
1480 $c->response->body('');
1486 if ($c->use_stats) {
1487 my $elapsed = sprintf '%f', $c->stats->elapsed;
1488 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1490 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1493 return $c->response->status;
1496 =head2 $c->finalize_body
1502 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1504 =head2 $c->finalize_cookies
1510 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1512 =head2 $c->finalize_error
1518 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1520 =head2 $c->finalize_headers
1526 sub finalize_headers {
1529 my $response = $c->response; #accessor calls can add up?
1531 # Check if we already finalized headers
1532 return if $response->finalized_headers;
1535 if ( my $location = $response->redirect ) {
1536 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1537 $response->header( Location => $location );
1539 #Moose TODO: we should probably be using a predicate method here ?
1540 if ( !$response->body ) {
1541 # Add a default body if none is already present
1543 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1549 if ( $response->body && !$response->content_length ) {
1551 # get the length from a filehandle
1552 if ( blessed( $response->body ) && $response->body->can('read') )
1554 my $stat = stat $response->body;
1555 if ( $stat && $stat->size > 0 ) {
1556 $response->content_length( $stat->size );
1559 $c->log->warn('Serving filehandle without a content-length');
1563 # everything should be bytes at this point, but just in case
1564 $response->content_length( bytes::length( $response->body ) );
1569 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1570 $response->headers->remove_header("Content-Length");
1571 $response->body('');
1574 $c->finalize_cookies;
1576 $c->engine->finalize_headers( $c, @_ );
1579 $response->finalized_headers(1);
1582 =head2 $c->finalize_output
1584 An alias for finalize_body.
1586 =head2 $c->finalize_read
1588 Finalizes the input after reading is complete.
1592 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1594 =head2 $c->finalize_uploads
1596 Finalizes uploads. Cleans up any temporary files.
1600 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1602 =head2 $c->get_action( $action, $namespace )
1604 Gets an action in a given namespace.
1608 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1610 =head2 $c->get_actions( $action, $namespace )
1612 Gets all actions of a given name in a namespace and all parent
1617 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1619 =head2 $c->handle_request( $class, @arguments )
1621 Called to handle each HTTP request.
1625 sub handle_request {
1626 my ( $class, @arguments ) = @_;
1628 # Always expect worst case!
1631 if ($class->debug) {
1632 my $secs = time - $START || 1;
1633 my $av = sprintf '%.3f', $COUNT / $secs;
1634 my $time = localtime time;
1635 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1638 my $c = $class->prepare(@arguments);
1640 $status = $c->finalize;
1643 if ( my $error = $@ ) {
1645 $class->log->error(qq/Caught exception in engine "$error"/);
1650 if(my $coderef = $class->log->can('_flush')){
1651 $class->log->$coderef();
1656 =head2 $c->prepare( @arguments )
1658 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1664 my ( $class, @arguments ) = @_;
1667 # After the app/ctxt split, this should become an attribute based on something passed
1668 # into the application.
1669 $class->context_class( ref $class || $class ) unless $class->context_class;
1671 my $c = $class->context_class->new({});
1673 # For on-demand data
1674 $c->request->_context($c);
1675 $c->response->_context($c);
1677 #surely this is not the most efficient way to do things...
1678 $c->stats($class->stats_class->new)->enable($c->use_stats);
1680 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1683 #XXX reuse coderef from can
1684 # Allow engine to direct the prepare flow (for POE)
1685 if ( $c->engine->can('prepare') ) {
1686 $c->engine->prepare( $c, @arguments );
1689 $c->prepare_request(@arguments);
1690 $c->prepare_connection;
1691 $c->prepare_query_parameters;
1692 $c->prepare_headers;
1693 $c->prepare_cookies;
1696 # Prepare the body for reading, either by prepare_body
1697 # or the user, if they are using $c->read
1700 # Parse the body unless the user wants it on-demand
1701 unless ( $c->config->{parse_on_demand} ) {
1706 my $method = $c->req->method || '';
1707 my $path = $c->req->path;
1708 $path = '/' unless length $path;
1709 my $address = $c->req->address || '';
1711 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1719 =head2 $c->prepare_action
1721 Prepares action. See L<Catalyst::Dispatcher>.
1725 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1727 =head2 $c->prepare_body
1729 Prepares message body.
1736 #Moose TODO: what is _body ??
1737 # Do we run for the first time?
1738 return if defined $c->request->{_body};
1740 # Initialize on-demand data
1741 $c->engine->prepare_body( $c, @_ );
1742 $c->prepare_parameters;
1743 $c->prepare_uploads;
1745 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1746 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1747 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1748 my $param = $c->req->body_parameters->{$key};
1749 my $value = defined($param) ? $param : '';
1751 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1753 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1757 =head2 $c->prepare_body_chunk( $chunk )
1759 Prepares a chunk of data before sending it to L<HTTP::Body>.
1761 See L<Catalyst::Engine>.
1765 sub prepare_body_chunk {
1767 $c->engine->prepare_body_chunk( $c, @_ );
1770 =head2 $c->prepare_body_parameters
1772 Prepares body parameters.
1776 sub prepare_body_parameters {
1778 $c->engine->prepare_body_parameters( $c, @_ );
1781 =head2 $c->prepare_connection
1783 Prepares connection.
1787 sub prepare_connection {
1789 $c->engine->prepare_connection( $c, @_ );
1792 =head2 $c->prepare_cookies
1798 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1800 =head2 $c->prepare_headers
1806 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1808 =head2 $c->prepare_parameters
1810 Prepares parameters.
1814 sub prepare_parameters {
1816 $c->prepare_body_parameters;
1817 $c->engine->prepare_parameters( $c, @_ );
1820 =head2 $c->prepare_path
1822 Prepares path and base.
1826 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1828 =head2 $c->prepare_query_parameters
1830 Prepares query parameters.
1834 sub prepare_query_parameters {
1837 $c->engine->prepare_query_parameters( $c, @_ );
1839 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1840 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1841 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1842 my $param = $c->req->query_parameters->{$key};
1843 my $value = defined($param) ? $param : '';
1845 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1847 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1851 =head2 $c->prepare_read
1853 Prepares the input for reading.
1857 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1859 =head2 $c->prepare_request
1861 Prepares the engine request.
1865 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1867 =head2 $c->prepare_uploads
1873 sub prepare_uploads {
1876 $c->engine->prepare_uploads( $c, @_ );
1878 if ( $c->debug && keys %{ $c->request->uploads } ) {
1879 my $t = Text::SimpleTable->new(
1880 [ 12, 'Parameter' ],
1885 for my $key ( sort keys %{ $c->request->uploads } ) {
1886 my $upload = $c->request->uploads->{$key};
1887 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1888 $t->row( $key, $u->filename, $u->type, $u->size );
1891 $c->log->debug( "File Uploads are:\n" . $t->draw );
1895 =head2 $c->prepare_write
1897 Prepares the output for writing.
1901 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1903 =head2 $c->request_class
1905 Returns or sets the request class.
1907 =head2 $c->response_class
1909 Returns or sets the response class.
1911 =head2 $c->read( [$maxlength] )
1913 Reads a chunk of data from the request body. This method is designed to
1914 be used in a while loop, reading C<$maxlength> bytes on every call.
1915 C<$maxlength> defaults to the size of the request if not specified.
1917 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1920 Warning: If you use read(), Catalyst will not process the body,
1921 so you will not be able to access POST parameters or file uploads via
1922 $c->request. You must handle all body parsing yourself.
1926 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1934 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1936 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1938 Sets an action in a given namespace.
1942 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1944 =head2 $c->setup_actions($component)
1946 Sets up actions for a component.
1950 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1952 =head2 $c->setup_components
1954 Sets up components. Specify a C<setup_components> config option to pass
1955 additional options directly to L<Module::Pluggable>. To add additional
1956 search paths, specify a key named C<search_extra> as an array
1957 reference. Items in the array beginning with C<::> will have the
1958 application class name prepended to them.
1960 All components found will also have any
1961 L<Devel::InnerPackage|inner packages> loaded and set up as components.
1962 Note, that modules which are B<not> an I<inner package> of the main
1963 file namespace loaded will not be instantiated as components.
1967 sub setup_components {
1970 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1971 my $config = $class->config->{ setup_components };
1972 my $extra = delete $config->{ search_extra } || [];
1974 push @paths, @$extra;
1976 my $locator = Module::Pluggable::Object->new(
1977 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1981 my @comps = sort { length $a <=> length $b } $locator->plugins;
1982 my %comps = map { $_ => 1 } @comps;
1984 for my $component ( @comps ) {
1986 # We pass ignore_loaded here so that overlay files for (e.g.)
1987 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1988 # we know M::P::O found a file on disk so this is safe
1990 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1991 #Class::MOP::load_class($component);
1993 my $module = $class->setup_component( $component );
1995 $component => $module,
1997 $_ => $class->setup_component( $_ )
1999 not exists $comps{$_}
2000 } Devel::InnerPackage::list_packages( $component )
2003 for my $key ( keys %modules ) {
2004 $class->components->{ $key } = $modules{ $key };
2009 =head2 $c->setup_component
2013 sub setup_component {
2014 my( $class, $component ) = @_;
2016 unless ( $component->can( 'COMPONENT' ) ) {
2020 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2021 my $config = $class->config->{ $suffix } || {};
2023 my $instance = eval { $component->COMPONENT( $class, $config ); };
2025 if ( my $error = $@ ) {
2027 Catalyst::Exception->throw(
2028 message => qq/Couldn't instantiate component "$component", "$error"/
2032 Catalyst::Exception->throw(
2034 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2035 ) unless blessed($instance);
2040 =head2 $c->setup_dispatcher
2046 sub setup_dispatcher {
2047 my ( $class, $dispatcher ) = @_;
2050 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2053 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2054 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2057 unless ($dispatcher) {
2058 $dispatcher = $class->dispatcher_class;
2061 Class::MOP::load_class($dispatcher);
2063 # dispatcher instance
2064 $class->dispatcher( $dispatcher->new );
2067 =head2 $c->setup_engine
2074 my ( $class, $engine ) = @_;
2077 $engine = 'Catalyst::Engine::' . $engine;
2080 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2081 $engine = 'Catalyst::Engine::' . $env;
2084 if ( $ENV{MOD_PERL} ) {
2086 # create the apache method
2087 $class->meta->add_method('apache' => sub { shift->engine->apache });
2089 my ( $software, $version ) =
2090 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2093 $version =~ s/(\.[^.]+)\./$1/g;
2095 if ( $software eq 'mod_perl' ) {
2099 if ( $version >= 1.99922 ) {
2100 $engine = 'Catalyst::Engine::Apache2::MP20';
2103 elsif ( $version >= 1.9901 ) {
2104 $engine = 'Catalyst::Engine::Apache2::MP19';
2107 elsif ( $version >= 1.24 ) {
2108 $engine = 'Catalyst::Engine::Apache::MP13';
2112 Catalyst::Exception->throw( message =>
2113 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2118 # install the correct mod_perl handler
2119 if ( $version >= 1.9901 ) {
2120 *handler = sub : method {
2121 shift->handle_request(@_);
2125 *handler = sub ($$) { shift->handle_request(@_) };
2130 elsif ( $software eq 'Zeus-Perl' ) {
2131 $engine = 'Catalyst::Engine::Zeus';
2135 Catalyst::Exception->throw(
2136 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2141 $engine = $class->engine_class;
2144 Class::MOP::load_class($engine);
2146 # check for old engines that are no longer compatible
2148 if ( $engine->isa('Catalyst::Engine::Apache')
2149 && !Catalyst::Engine::Apache->VERSION )
2154 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2155 && Catalyst::Engine::Server->VERSION le '0.02' )
2160 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2161 && $engine->VERSION eq '0.01' )
2166 elsif ($engine->isa('Catalyst::Engine::Zeus')
2167 && $engine->VERSION eq '0.01' )
2173 Catalyst::Exception->throw( message =>
2174 qq/Engine "$engine" is not supported by this version of Catalyst/
2179 $class->engine( $engine->new );
2182 =head2 $c->setup_home
2184 Sets up the home directory.
2189 my ( $class, $home ) = @_;
2191 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2195 $home ||= Catalyst::Utils::home($class);
2198 #I remember recently being scolded for assigning config values like this
2199 $class->config->{home} ||= $home;
2200 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2204 =head2 $c->setup_log
2211 my ( $class, $debug ) = @_;
2213 unless ( $class->log ) {
2214 $class->log( Catalyst::Log->new );
2217 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2218 if ( defined($env_debug) ? $env_debug : $debug ) {
2219 $class->meta->add_method('debug' => sub { 1 });
2220 $class->log->debug('Debug messages enabled');
2224 =head2 $c->setup_plugins
2230 =head2 $c->setup_stats
2232 Sets up timing statistics class.
2237 my ( $class, $stats ) = @_;
2239 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2241 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2242 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2243 $class->meta->add_method('use_stats' => sub { 1 });
2244 $class->log->debug('Statistics enabled');
2249 =head2 $c->registered_plugins
2251 Returns a sorted list of the plugins which have either been stated in the
2252 import list or which have been added via C<< MyApp->plugin(@args); >>.
2254 If passed a given plugin name, it will report a boolean value indicating
2255 whether or not that plugin is loaded. A fully qualified name is required if
2256 the plugin name does not begin with C<Catalyst::Plugin::>.
2258 if ($c->registered_plugins('Some::Plugin')) {
2266 sub registered_plugins {
2268 return sort keys %{ $proto->_plugins } unless @_;
2270 return 1 if exists $proto->_plugins->{$plugin};
2271 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2274 sub _register_plugin {
2275 my ( $proto, $plugin, $instant ) = @_;
2276 my $class = ref $proto || $proto;
2278 # no ignore_loaded here, the plugin may already have been
2279 # defined in memory and we don't want to error on "no file" if so
2281 Class::MOP::load_class( $plugin );
2283 $proto->_plugins->{$plugin} = 1;
2286 if( $class->can('meta') ){
2287 my @superclasses = ($plugin, $class->meta->superclasses );
2288 $class->meta->superclasses(@superclasses);
2290 unshift @{"$class\::ISA"}, $plugin;
2297 my ( $class, $plugins ) = @_;
2299 $class->_plugins( {} ) unless $class->_plugins;
2301 for my $plugin ( reverse @$plugins ) {
2303 unless ( $plugin =~ s/\A\+// ) {
2304 $plugin = "Catalyst::Plugin::$plugin";
2307 $class->_register_plugin($plugin);
2314 Returns an arrayref of the internal execution stack (actions that are
2315 currently executing).
2317 =head2 $c->stats_class
2319 Returns or sets the stats (timing statistics) class.
2321 =head2 $c->use_stats
2323 Returns 1 when stats collection is enabled. Stats collection is enabled
2324 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2325 environment variable is set.
2327 Note that this is a static method, not an accessor and should be overloaded
2328 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2335 =head2 $c->write( $data )
2337 Writes $data to the output stream. When using this method directly, you
2338 will need to manually set the C<Content-Length> header to the length of
2339 your output data, if known.
2346 # Finalize headers if someone manually writes output
2347 $c->finalize_headers;
2349 return $c->engine->write( $c, @_ );
2354 Returns the Catalyst version number. Mostly useful for "powered by"
2355 messages in template systems.
2359 sub version { return $Catalyst::VERSION }
2361 =head1 INTERNAL ACTIONS
2363 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2364 C<_ACTION>, and C<_END>. These are by default not shown in the private
2365 action table, but you can make them visible with a config parameter.
2367 MyApp->config->{show_internal_actions} = 1;
2369 =head1 CASE SENSITIVITY
2371 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2372 mapped to C</foo/bar>. You can activate case sensitivity with a config
2375 MyApp->config->{case_sensitive} = 1;
2377 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2379 =head1 ON-DEMAND PARSER
2381 The request body is usually parsed at the beginning of a request,
2382 but if you want to handle input yourself, you can enable on-demand
2383 parsing with a config parameter.
2385 MyApp->config->{parse_on_demand} = 1;
2387 =head1 PROXY SUPPORT
2389 Many production servers operate using the common double-server approach,
2390 with a lightweight frontend web server passing requests to a larger
2391 backend server. An application running on the backend server must deal
2392 with two problems: the remote user always appears to be C<127.0.0.1> and
2393 the server's hostname will appear to be C<localhost> regardless of the
2394 virtual host that the user connected through.
2396 Catalyst will automatically detect this situation when you are running
2397 the frontend and backend servers on the same machine. The following
2398 changes are made to the request.
2400 $c->req->address is set to the user's real IP address, as read from
2401 the HTTP X-Forwarded-For header.
2403 The host value for $c->req->base and $c->req->uri is set to the real
2404 host, as read from the HTTP X-Forwarded-Host header.
2406 Obviously, your web server must support these headers for this to work.
2408 In a more complex server farm environment where you may have your
2409 frontend proxy server(s) on different machines, you will need to set a
2410 configuration option to tell Catalyst to read the proxied data from the
2413 MyApp->config->{using_frontend_proxy} = 1;
2415 If you do not wish to use the proxy support at all, you may set:
2417 MyApp->config->{ignore_frontend_proxy} = 1;
2419 =head1 THREAD SAFETY
2421 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2422 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2423 believe the Catalyst core to be thread-safe.
2425 If you plan to operate in a threaded environment, remember that all other
2426 modules you are using must also be thread-safe. Some modules, most notably
2427 L<DBD::SQLite>, are not thread-safe.
2433 Join #catalyst on irc.perl.org.
2437 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2438 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2442 http://catalyst.perl.org
2446 http://dev.catalyst.perl.org
2450 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2452 =head2 L<Catalyst::Manual> - The Catalyst Manual
2454 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2456 =head2 L<Catalyst::Engine> - Core engine
2458 =head2 L<Catalyst::Log> - Log class.
2460 =head2 L<Catalyst::Request> - Request object
2462 =head2 L<Catalyst::Response> - Response object
2464 =head2 L<Catalyst::Test> - The test suite.
2466 =head1 PROJECT FOUNDER
2468 sri: Sebastian Riedel <sri@cpan.org>
2474 acme: Leon Brocard <leon@astray.com>
2482 andyg: Andy Grundman <andy@hybridized.org>
2484 audreyt: Audrey Tang
2486 bricas: Brian Cassidy <bricas@cpan.org>
2488 Caelum: Rafael Kitover <rkitover@io.com>
2490 chansen: Christian Hansen
2492 chicks: Christopher Hicks
2494 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2498 esskar: Sascha Kiefer
2500 fireartist: Carl Franks <cfranks@cpan.org>
2502 gabb: Danijel Milicevic
2508 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2510 jcamacho: Juan Camacho
2516 jon: Jon Schutz <jjschutz@cpan.org>
2518 marcus: Marcus Ramberg <mramberg@cpan.org>
2520 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2522 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2526 naughton: David Naughton
2528 ningu: David Kamholz <dkamholz@cpan.org>
2530 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2532 numa: Dan Sully <daniel@cpan.org>
2536 omega: Andreas Marienborg
2538 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2540 rafl: Florian Ragwitz <rafl@debian.org>
2544 the_jester: Jesse Sheidlower
2548 willert: Sebastian Willert <willert@cpan.org>
2552 This library is free software, you can redistribute it and/or modify it under
2553 the same terms as Perl itself.
2559 __PACKAGE__->meta->make_immutable;