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.8000_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->visit( $action [, \@arguments ] )
351 =head2 $c->visit( $class, $method, [, \@arguments ] )
353 Almost the same as C<forward>, 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 are called, just like a new request.
357 C<$c-E<gt>stash> is kept unchanged.
359 In effect, C<visit> allows you to "wrap" another action, just as it
360 would have been called by dispatching from a URL, while the analogous
361 C<go> allows you to transfer control to another action as if it had
362 been reached directly from a URL.
366 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
368 =head2 $c->go( $action [, \@arguments ] )
370 =head2 $c->go( $class, $method, [, \@arguments ] )
372 Almost the same as C<detach>, but does a full dispatch like C<visit>,
373 instead of just calling the new C<$action> /
374 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
375 method you visit are called, just like a new request.
377 C<$c-E<gt>stash> is kept unchanged.
381 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
387 Returns the current L<Catalyst::Response> object, see there for details.
391 Returns a hashref to the stash, which may be used to store data and pass
392 it between components during a request. You can also set hash keys by
393 passing arguments. The stash is automatically sent to the view. The
394 stash is cleared at the end of a request; it cannot be used for
395 persistent storage (for this you must use a session; see
396 L<Catalyst::Plugin::Session> for a complete system integrated with
399 $c->stash->{foo} = $bar;
400 $c->stash( { moose => 'majestic', qux => 0 } );
401 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
403 # stash is automatically passed to the view for use in a template
404 $c->forward( 'MyApp::View::TT' );
408 around stash => sub {
411 my $stash = $orig->($c);
413 my $new_stash = @_ > 1 ? {@_} : $_[0];
414 croak('stash takes a hash or hashref') unless ref $new_stash;
415 foreach my $key ( keys %$new_stash ) {
416 $stash->{$key} = $new_stash->{$key};
426 =head2 $c->error($error, ...)
428 =head2 $c->error($arrayref)
430 Returns an arrayref containing error messages. If Catalyst encounters an
431 error while processing a request, it stores the error in $c->error. This
432 method should only be used to store fatal error messages.
434 my @error = @{ $c->error };
438 $c->error('Something bad happened');
445 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
446 croak @$error unless ref $c;
447 push @{ $c->{error} }, @$error;
449 elsif ( defined $_[0] ) { $c->{error} = undef }
450 return $c->{error} || [];
456 Contains the return value of the last executed action.
458 =head2 $c->clear_errors
460 Clear errors. You probably don't want to clear the errors unless you are
461 implementing a custom error screen.
463 This is equivalent to running
474 # search components given a name and some prefixes
475 sub _comp_search_prefixes {
476 my ( $c, $name, @prefixes ) = @_;
477 my $appclass = ref $c || $c;
478 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
480 # map the original component name to the sub part that we will search against
481 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
482 grep { /$filter/ } keys %{ $c->components };
484 # undef for a name will return all
485 return keys %eligible if !defined $name;
487 my $query = ref $name ? $name : qr/^$name$/i;
488 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
490 return map { $c->components->{ $_ } } @result if @result;
492 # if we were given a regexp to search against, we're done.
497 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
499 # no results? try against full names
501 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
504 # don't warn if we didn't find any results, it just might not exist
506 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
507 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' );
508 $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' );
514 # Find possible names for a prefix
516 my ( $c, @prefixes ) = @_;
517 my $appclass = ref $c || $c;
519 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
521 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
525 # Filter a component before returning by calling ACCEPT_CONTEXT if available
526 sub _filter_component {
527 my ( $c, $comp, @args ) = @_;
529 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
530 return $comp->ACCEPT_CONTEXT( $c, @args );
536 =head2 COMPONENT ACCESSORS
538 =head2 $c->controller($name)
540 Gets a L<Catalyst::Controller> instance by name.
542 $c->controller('Foo')->do_stuff;
544 If the name is omitted, will return the controller for the dispatched
547 If you want to search for controllers, pass in a regexp as the argument.
549 # find all controllers that start with Foo
550 my @foo_controllers = $c->controller(qr{^Foo});
556 my ( $c, $name, @args ) = @_;
559 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
560 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
561 return $c->_filter_component( $result[ 0 ], @args );
564 return $c->component( $c->action->class );
567 =head2 $c->model($name)
569 Gets a L<Catalyst::Model> instance by name.
571 $c->model('Foo')->do_stuff;
573 Any extra arguments are directly passed to ACCEPT_CONTEXT.
575 If the name is omitted, it will look for
576 - a model object in $c->stash->{current_model_instance}, then
577 - a model name in $c->stash->{current_model}, then
578 - a config setting 'default_model', or
579 - check if there is only one model, and return it if that's the case.
581 If you want to search for models, pass in a regexp as the argument.
583 # find all models that start with Foo
584 my @foo_models = $c->model(qr{^Foo});
589 my ( $c, $name, @args ) = @_;
592 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
593 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
594 return $c->_filter_component( $result[ 0 ], @args );
598 return $c->stash->{current_model_instance}
599 if $c->stash->{current_model_instance};
600 return $c->model( $c->stash->{current_model} )
601 if $c->stash->{current_model};
603 return $c->model( $c->config->{default_model} )
604 if $c->config->{default_model};
606 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
609 $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' );
610 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
611 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
612 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
613 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
616 return $c->_filter_component( $comp );
620 =head2 $c->view($name)
622 Gets a L<Catalyst::View> instance by name.
624 $c->view('Foo')->do_stuff;
626 Any extra arguments are directly passed to ACCEPT_CONTEXT.
628 If the name is omitted, it will look for
629 - a view object in $c->stash->{current_view_instance}, then
630 - a view name in $c->stash->{current_view}, then
631 - a config setting 'default_view', or
632 - check if there is only one view, and return it if that's the case.
634 If you want to search for views, pass in a regexp as the argument.
636 # find all views that start with Foo
637 my @foo_views = $c->view(qr{^Foo});
642 my ( $c, $name, @args ) = @_;
645 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
646 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
647 return $c->_filter_component( $result[ 0 ], @args );
651 return $c->stash->{current_view_instance}
652 if $c->stash->{current_view_instance};
653 return $c->view( $c->stash->{current_view} )
654 if $c->stash->{current_view};
656 return $c->view( $c->config->{default_view} )
657 if $c->config->{default_view};
659 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
662 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
663 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
664 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
665 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
666 $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' );
669 return $c->_filter_component( $comp );
672 =head2 $c->controllers
674 Returns the available names which can be passed to $c->controller
680 return $c->_comp_names(qw/Controller C/);
685 Returns the available names which can be passed to $c->model
691 return $c->_comp_names(qw/Model M/);
697 Returns the available names which can be passed to $c->view
703 return $c->_comp_names(qw/View V/);
706 =head2 $c->comp($name)
708 =head2 $c->component($name)
710 Gets a component object by name. This method is not recommended,
711 unless you want to get a specific component by full
712 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
713 should be used instead.
715 If C<$name> is a regexp, a list of components matched against the full
716 component name will be returned.
721 my ( $c, $name, @args ) = @_;
724 my $comps = $c->components;
727 # is it the exact name?
728 return $c->_filter_component( $comps->{ $name }, @args )
729 if exists $comps->{ $name };
731 # perhaps we just omitted "MyApp"?
732 my $composed = ( ref $c || $c ) . "::${name}";
733 return $c->_filter_component( $comps->{ $composed }, @args )
734 if exists $comps->{ $composed };
736 # search all of the models, views and controllers
737 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
738 return $c->_filter_component( $comp, @args ) if $comp;
741 # This is here so $c->comp( '::M::' ) works
742 my $query = ref $name ? $name : qr{$name}i;
744 my @result = grep { m{$query} } keys %{ $c->components };
745 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
748 $c->log->warn( qq(Found results for "${name}" using regexp fallback.) );
749 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
750 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
751 return $c->_filter_component( $result[ 0 ], @args );
754 # I would expect to return an empty list here, but that breaks back-compat
758 return sort keys %{ $c->components };
761 =head2 CLASS DATA AND HELPER CLASSES
765 Returns or takes a hashref containing the application's configuration.
767 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
769 You can also use a C<YAML>, C<XML> or C<Config::General> config file
770 like myapp.yml in your applications home directory. See
771 L<Catalyst::Plugin::ConfigLoader>.
774 db: dsn:SQLite:foo.db
779 around config => sub {
783 $c->log->warn("Setting config after setup has been run is not a good idea.")
784 if ( @_ and $c->setup_finished );
791 Returns the logging object instance. Unless it is already set, Catalyst
792 sets this up with a L<Catalyst::Log> object. To use your own log class,
793 set the logger with the C<< __PACKAGE__->log >> method prior to calling
794 C<< __PACKAGE__->setup >>.
796 __PACKAGE__->log( MyLogger->new );
801 $c->log->info( 'Now logging with my own logger!' );
803 Your log class should implement the methods described in
809 Overload to enable debug messages (same as -Debug option).
811 Note that this is a static method, not an accessor and should be overloaded
812 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
818 =head2 $c->dispatcher
820 Returns the dispatcher instance. Stringifies to class name. See
821 L<Catalyst::Dispatcher>.
825 Returns the engine instance. Stringifies to the class name. See
829 =head2 UTILITY METHODS
831 =head2 $c->path_to(@path)
833 Merges C<@path> with C<< $c->config->{home} >> and returns a
834 L<Path::Class::Dir> object.
838 $c->path_to( 'db', 'sqlite.db' );
843 my ( $c, @path ) = @_;
844 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
845 if ( -d $path ) { return $path }
846 else { return Path::Class::File->new( $c->config->{home}, @path ) }
849 =head2 $c->plugin( $name, $class, @args )
851 Helper method for plugins. It creates a classdata accessor/mutator and
852 loads and instantiates the given class.
854 MyApp->plugin( 'prototype', 'HTML::Prototype' );
856 $c->prototype->define_javascript_functions;
861 my ( $class, $name, $plugin, @args ) = @_;
862 $class->_register_plugin( $plugin, 1 );
864 eval { $plugin->import };
865 $class->mk_classdata($name);
867 eval { $obj = $plugin->new(@args) };
870 Catalyst::Exception->throw( message =>
871 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
875 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
881 Initializes the dispatcher and engine, loads any plugins, and loads the
882 model, view, and controller components. You may also specify an array
883 of plugins to load here, if you choose to not load them in the C<use
887 MyApp->setup( qw/-Debug/ );
892 my ( $class, @arguments ) = @_;
893 $class->log->warn("Running setup twice is not a good idea.")
894 if ( $class->setup_finished );
896 unless ( $class->isa('Catalyst') ) {
898 Catalyst::Exception->throw(
899 message => qq/'$class' does not inherit from Catalyst/ );
902 if ( $class->arguments ) {
903 @arguments = ( @arguments, @{ $class->arguments } );
909 foreach (@arguments) {
913 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
915 elsif (/^-(\w+)=?(.*)$/) {
916 $flags->{ lc $1 } = $2;
919 push @{ $flags->{plugins} }, $_;
923 $class->setup_home( delete $flags->{home} );
925 $class->setup_log( delete $flags->{log} );
926 $class->setup_plugins( delete $flags->{plugins} );
927 $class->setup_dispatcher( delete $flags->{dispatcher} );
928 $class->setup_engine( delete $flags->{engine} );
929 $class->setup_stats( delete $flags->{stats} );
931 for my $flag ( sort keys %{$flags} ) {
933 if ( my $code = $class->can( 'setup_' . $flag ) ) {
934 &$code( $class, delete $flags->{$flag} );
937 $class->log->warn(qq/Unknown flag "$flag"/);
941 eval { require Catalyst::Devel; };
942 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
943 $class->log->warn(<<"EOF");
944 You are running an old script!
946 Please update by running (this will overwrite existing files):
947 catalyst.pl -force -scripts $class
949 or (this will not overwrite existing files):
950 catalyst.pl -scripts $class
955 if ( $class->debug ) {
956 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
959 my $t = Text::SimpleTable->new(74);
960 $t->row($_) for @plugins;
961 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
964 my $dispatcher = $class->dispatcher;
965 my $engine = $class->engine;
966 my $home = $class->config->{home};
968 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
969 $class->log->debug(qq/Loaded engine "$engine"/);
973 ? $class->log->debug(qq/Found home "$home"/)
974 : $class->log->debug(qq/Home "$home" doesn't exist/)
975 : $class->log->debug(q/Couldn't find home/);
980 no warnings qw/redefine/;
981 local *setup = sub { };
985 # Initialize our data structure
986 $class->components( {} );
988 $class->setup_components;
990 if ( $class->debug ) {
991 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
992 for my $comp ( sort keys %{ $class->components } ) {
993 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
994 $t->row( $comp, $type );
996 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
997 if ( keys %{ $class->components } );
1000 # Add our self to components, since we are also a component
1001 if( $class->isa('Catalyst::Controller') ){
1002 $class->components->{$class} = $class;
1005 $class->setup_actions;
1007 if ( $class->debug ) {
1008 my $name = $class->config->{name} || 'Application';
1009 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1011 $class->log->_flush() if $class->log->can('_flush');
1013 $class->setup_finished(1);
1016 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1018 =head2 $c->uri_for( $path, @args?, \%query_values? )
1024 A Catalyst::Action object representing the Catalyst action you want to
1025 create a URI for. To get one for an action in the current controller,
1026 use C<< $c->action('someactionname') >>. To get one from different
1027 controller, fetch the controller using C<< $c->controller() >>, then
1028 call C<action_for> on it.
1030 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1031 using C<< $c->req->captures >>.
1033 # For the current action
1034 $c->uri_for($c->action, $c->req->captures);
1036 # For the Foo action in the Bar controller
1037 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1044 my ( $c, $path, @args ) = @_;
1046 if ( Scalar::Util::blessed($path) ) { # action object
1047 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1050 $path = $c->dispatcher->uri_for_action($path, $captures);
1051 return undef unless defined($path);
1052 $path = '/' if $path eq '';
1055 undef($path) if (defined $path && $path eq '');
1058 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1060 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1061 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1063 unshift(@args, $path);
1065 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1066 my $namespace = $c->namespace;
1067 if (defined $path) { # cheesy hack to handle path '../foo'
1068 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1070 unshift(@args, $namespace || '');
1073 # join args with '/', or a blank string
1074 my $args = join('/', grep { defined($_) } @args);
1075 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1077 my $base = $c->req->base;
1078 my $class = ref($base);
1079 $base =~ s{(?<!/)$}{/};
1083 if (my @keys = keys %$params) {
1084 # somewhat lifted from URI::_query's query_form
1085 $query = '?'.join('&', map {
1086 my $val = $params->{$_};
1087 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1090 $val = '' unless defined $val;
1093 utf8::encode( $_ ) if utf8::is_utf8($_);
1094 # using the URI::Escape pattern here so utf8 chars survive
1095 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1097 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1101 my $res = bless(\"${base}${args}${query}", $class);
1105 =head2 $c->welcome_message
1107 Returns the Catalyst welcome HTML page.
1111 sub welcome_message {
1113 my $name = $c->config->{name};
1114 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1115 my $prefix = Catalyst::Utils::appprefix( ref $c );
1116 $c->response->content_type('text/html; charset=utf-8');
1118 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1119 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1120 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1122 <meta http-equiv="Content-Language" content="en" />
1123 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1124 <title>$name on Catalyst $VERSION</title>
1125 <style type="text/css">
1128 background-color: #eee;
1135 margin-bottom: 10px;
1137 background-color: #ccc;
1138 border: 1px solid #aaa;
1143 font-family: verdana, tahoma, sans-serif;
1146 font-family: verdana, tahoma, sans-serif;
1149 text-decoration: none;
1151 border-bottom: 1px dotted #bbb;
1153 :link:hover, :visited:hover {
1166 background-color: #fff;
1167 border: 1px solid #aaa;
1171 font-weight: normal;
1193 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1198 <img src="$logo" alt="Catalyst Logo" />
1200 <p>Welcome to the world of Catalyst.
1201 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1202 framework will make web development something you had
1203 never expected it to be: Fun, rewarding, and quick.</p>
1204 <h2>What to do now?</h2>
1205 <p>That really depends on what <b>you</b> want to do.
1206 We do, however, provide you with a few starting points.</p>
1207 <p>If you want to jump right into web development with Catalyst
1208 you might want to start with a tutorial.</p>
1209 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1211 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1213 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1214 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1216 <h2>What to do next?</h2>
1217 <p>Next it's time to write an actual application. Use the
1218 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1219 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1220 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1221 they can save you a lot of work.</p>
1222 <pre><code>script/${prefix}_create.pl -help</code></pre>
1223 <p>Also, be sure to check out the vast and growing
1224 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1225 you are likely to find what you need there.
1229 <p>Catalyst has a very active community. Here are the main places to
1230 get in touch with us.</p>
1233 <a href="http://dev.catalyst.perl.org">Wiki</a>
1236 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1239 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1242 <h2>In conclusion</h2>
1243 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1244 as we enjoyed making it. Please contact us if you have ideas
1245 for improvement or other feedback.</p>
1253 =head1 INTERNAL METHODS
1255 These methods are not meant to be used by end users.
1257 =head2 $c->components
1259 Returns a hash of components.
1261 =head2 $c->context_class
1263 Returns or sets the context class.
1267 Returns a hashref containing coderefs and execution counts (needed for
1268 deep recursion detection).
1272 Returns the number of actions on the current internal execution stack.
1276 Dispatches a request to actions.
1280 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1282 =head2 $c->dispatcher_class
1284 Returns or sets the dispatcher class.
1286 =head2 $c->dump_these
1288 Returns a list of 2-element array references (name, structure) pairs
1289 that will be dumped on the error page in debug mode.
1295 [ Request => $c->req ],
1296 [ Response => $c->res ],
1297 [ Stash => $c->stash ],
1298 [ Config => $c->config ];
1301 =head2 $c->engine_class
1303 Returns or sets the engine class.
1305 =head2 $c->execute( $class, $coderef )
1307 Execute a coderef in given class and catch exceptions. Errors are available
1313 my ( $c, $class, $code ) = @_;
1314 $class = $c->component($class) || $class;
1317 if ( $c->depth >= $RECURSION ) {
1318 my $action = $code->reverse();
1319 $action = "/$action" unless $action =~ /->/;
1320 my $error = qq/Deep recursion detected calling "${action}"/;
1321 $c->log->error($error);
1327 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1329 push( @{ $c->stack }, $code );
1331 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1333 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1335 my $last = pop( @{ $c->stack } );
1337 if ( my $error = $@ ) {
1338 if ( !ref($error) and $error eq $DETACH ) {
1339 die $DETACH if($c->depth > 1);
1341 elsif ( !ref($error) and $error eq $GO ) {
1342 die $GO if($c->depth > 0);
1345 unless ( ref $error ) {
1346 no warnings 'uninitialized';
1348 my $class = $last->class;
1349 my $name = $last->name;
1350 $error = qq/Caught exception in $class->$name "$error"/;
1359 sub _stats_start_execute {
1360 my ( $c, $code ) = @_;
1362 return if ( ( $code->name =~ /^_.*/ )
1363 && ( !$c->config->{show_internal_actions} ) );
1365 my $action_name = $code->reverse();
1366 $c->counter->{$action_name}++;
1368 my $action = $action_name;
1369 $action = "/$action" unless $action =~ /->/;
1371 # determine if the call was the result of a forward
1372 # this is done by walking up the call stack and looking for a calling
1373 # sub of Catalyst::forward before the eval
1375 for my $index ( 2 .. 11 ) {
1377 if ( ( caller($index) )[0] eq 'Catalyst'
1378 && ( caller($index) )[3] eq '(eval)' );
1380 if ( ( caller($index) )[3] =~ /forward$/ ) {
1381 $callsub = ( caller($index) )[3];
1382 $action = "-> $action";
1387 my $uid = $action_name . $c->counter->{$action_name};
1389 # is this a root-level call or a forwarded call?
1390 if ( $callsub =~ /forward$/ ) {
1392 # forward, locate the caller
1393 if ( my $parent = $c->stack->[-1] ) {
1396 parent => "$parent" . $c->counter->{"$parent"},
1402 # forward with no caller may come from a plugin
1421 sub _stats_finish_execute {
1422 my ( $c, $info ) = @_;
1423 $c->stats->profile( end => $info );
1426 =head2 $c->_localize_fields( sub { }, \%keys );
1430 #Why does this exist? This is no longer safe and WILL NOT WORK.
1431 # it doesnt seem to be used anywhere. can we remove it?
1432 sub _localize_fields {
1433 my ( $c, $localized, $code ) = ( @_ );
1435 my $request = delete $localized->{request} || {};
1436 my $response = delete $localized->{response} || {};
1438 local @{ $c }{ keys %$localized } = values %$localized;
1439 local @{ $c->request }{ keys %$request } = values %$request;
1440 local @{ $c->response }{ keys %$response } = values %$response;
1447 Finalizes the request.
1454 for my $error ( @{ $c->error } ) {
1455 $c->log->error($error);
1458 # Allow engine to handle finalize flow (for POE)
1459 my $engine = $c->engine;
1460 if ( my $code = $engine->can('finalize') ) {
1465 $c->finalize_uploads;
1468 if ( $#{ $c->error } >= 0 ) {
1472 $c->finalize_headers;
1475 if ( $c->request->method eq 'HEAD' ) {
1476 $c->response->body('');
1482 if ($c->use_stats) {
1483 my $elapsed = sprintf '%f', $c->stats->elapsed;
1484 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1486 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1489 return $c->response->status;
1492 =head2 $c->finalize_body
1498 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1500 =head2 $c->finalize_cookies
1506 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1508 =head2 $c->finalize_error
1514 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1516 =head2 $c->finalize_headers
1522 sub finalize_headers {
1525 my $response = $c->response; #accessor calls can add up?
1527 # Check if we already finalized headers
1528 return if $response->finalized_headers;
1531 if ( my $location = $response->redirect ) {
1532 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1533 $response->header( Location => $location );
1535 #Moose TODO: we should probably be using a predicate method here ?
1536 if ( !$response->body ) {
1537 # Add a default body if none is already present
1539 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1545 if ( $response->body && !$response->content_length ) {
1547 # get the length from a filehandle
1548 if ( blessed( $response->body ) && $response->body->can('read') )
1550 my $stat = stat $response->body;
1551 if ( $stat && $stat->size > 0 ) {
1552 $response->content_length( $stat->size );
1555 $c->log->warn('Serving filehandle without a content-length');
1559 # everything should be bytes at this point, but just in case
1560 $response->content_length( bytes::length( $response->body ) );
1565 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1566 $response->headers->remove_header("Content-Length");
1567 $response->body('');
1570 $c->finalize_cookies;
1572 $c->engine->finalize_headers( $c, @_ );
1575 $response->finalized_headers(1);
1578 =head2 $c->finalize_output
1580 An alias for finalize_body.
1582 =head2 $c->finalize_read
1584 Finalizes the input after reading is complete.
1588 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1590 =head2 $c->finalize_uploads
1592 Finalizes uploads. Cleans up any temporary files.
1596 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1598 =head2 $c->get_action( $action, $namespace )
1600 Gets an action in a given namespace.
1604 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1606 =head2 $c->get_actions( $action, $namespace )
1608 Gets all actions of a given name in a namespace and all parent
1613 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1615 =head2 $c->handle_request( $class, @arguments )
1617 Called to handle each HTTP request.
1621 sub handle_request {
1622 my ( $class, @arguments ) = @_;
1624 # Always expect worst case!
1627 if ($class->debug) {
1628 my $secs = time - $START || 1;
1629 my $av = sprintf '%.3f', $COUNT / $secs;
1630 my $time = localtime time;
1631 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1634 my $c = $class->prepare(@arguments);
1636 $status = $c->finalize;
1639 if ( my $error = $@ ) {
1641 $class->log->error(qq/Caught exception in engine "$error"/);
1646 if(my $coderef = $class->log->can('_flush')){
1647 $class->log->$coderef();
1652 =head2 $c->prepare( @arguments )
1654 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1660 my ( $class, @arguments ) = @_;
1663 # After the app/ctxt split, this should become an attribute based on something passed
1664 # into the application.
1665 $class->context_class( ref $class || $class ) unless $class->context_class;
1667 my $c = $class->context_class->new({});
1669 # For on-demand data
1670 $c->request->_context($c);
1671 $c->response->_context($c);
1673 #surely this is not the most efficient way to do things...
1674 $c->stats($class->stats_class->new)->enable($c->use_stats);
1676 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1679 #XXX reuse coderef from can
1680 # Allow engine to direct the prepare flow (for POE)
1681 if ( $c->engine->can('prepare') ) {
1682 $c->engine->prepare( $c, @arguments );
1685 $c->prepare_request(@arguments);
1686 $c->prepare_connection;
1687 $c->prepare_query_parameters;
1688 $c->prepare_headers;
1689 $c->prepare_cookies;
1692 # Prepare the body for reading, either by prepare_body
1693 # or the user, if they are using $c->read
1696 # Parse the body unless the user wants it on-demand
1697 unless ( $c->config->{parse_on_demand} ) {
1702 my $method = $c->req->method || '';
1703 my $path = $c->req->path;
1704 $path = '/' unless length $path;
1705 my $address = $c->req->address || '';
1707 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1715 =head2 $c->prepare_action
1717 Prepares action. See L<Catalyst::Dispatcher>.
1721 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1723 =head2 $c->prepare_body
1725 Prepares message body.
1732 #Moose TODO: what is _body ??
1733 # Do we run for the first time?
1734 return if defined $c->request->{_body};
1736 # Initialize on-demand data
1737 $c->engine->prepare_body( $c, @_ );
1738 $c->prepare_parameters;
1739 $c->prepare_uploads;
1741 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1742 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1743 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1744 my $param = $c->req->body_parameters->{$key};
1745 my $value = defined($param) ? $param : '';
1747 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1749 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1753 =head2 $c->prepare_body_chunk( $chunk )
1755 Prepares a chunk of data before sending it to L<HTTP::Body>.
1757 See L<Catalyst::Engine>.
1761 sub prepare_body_chunk {
1763 $c->engine->prepare_body_chunk( $c, @_ );
1766 =head2 $c->prepare_body_parameters
1768 Prepares body parameters.
1772 sub prepare_body_parameters {
1774 $c->engine->prepare_body_parameters( $c, @_ );
1777 =head2 $c->prepare_connection
1779 Prepares connection.
1783 sub prepare_connection {
1785 $c->engine->prepare_connection( $c, @_ );
1788 =head2 $c->prepare_cookies
1794 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1796 =head2 $c->prepare_headers
1802 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1804 =head2 $c->prepare_parameters
1806 Prepares parameters.
1810 sub prepare_parameters {
1812 $c->prepare_body_parameters;
1813 $c->engine->prepare_parameters( $c, @_ );
1816 =head2 $c->prepare_path
1818 Prepares path and base.
1822 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1824 =head2 $c->prepare_query_parameters
1826 Prepares query parameters.
1830 sub prepare_query_parameters {
1833 $c->engine->prepare_query_parameters( $c, @_ );
1835 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1836 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1837 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1838 my $param = $c->req->query_parameters->{$key};
1839 my $value = defined($param) ? $param : '';
1841 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1843 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1847 =head2 $c->prepare_read
1849 Prepares the input for reading.
1853 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1855 =head2 $c->prepare_request
1857 Prepares the engine request.
1861 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1863 =head2 $c->prepare_uploads
1869 sub prepare_uploads {
1872 $c->engine->prepare_uploads( $c, @_ );
1874 if ( $c->debug && keys %{ $c->request->uploads } ) {
1875 my $t = Text::SimpleTable->new(
1876 [ 12, 'Parameter' ],
1881 for my $key ( sort keys %{ $c->request->uploads } ) {
1882 my $upload = $c->request->uploads->{$key};
1883 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1884 $t->row( $key, $u->filename, $u->type, $u->size );
1887 $c->log->debug( "File Uploads are:\n" . $t->draw );
1891 =head2 $c->prepare_write
1893 Prepares the output for writing.
1897 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1899 =head2 $c->request_class
1901 Returns or sets the request class.
1903 =head2 $c->response_class
1905 Returns or sets the response class.
1907 =head2 $c->read( [$maxlength] )
1909 Reads a chunk of data from the request body. This method is designed to
1910 be used in a while loop, reading C<$maxlength> bytes on every call.
1911 C<$maxlength> defaults to the size of the request if not specified.
1913 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1916 Warning: If you use read(), Catalyst will not process the body,
1917 so you will not be able to access POST parameters or file uploads via
1918 $c->request. You must handle all body parsing yourself.
1922 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1930 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1932 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1934 Sets an action in a given namespace.
1938 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1940 =head2 $c->setup_actions($component)
1942 Sets up actions for a component.
1946 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1948 =head2 $c->setup_components
1950 Sets up components. Specify a C<setup_components> config option to pass
1951 additional options directly to L<Module::Pluggable>. To add additional
1952 search paths, specify a key named C<search_extra> as an array
1953 reference. Items in the array beginning with C<::> will have the
1954 application class name prepended to them.
1956 All components found will also have any
1957 L<Devel::InnerPackage|inner packages> loaded and set up as components.
1958 Note, that modules which are B<not> an I<inner package> of the main
1959 file namespace loaded will not be instantiated as components.
1963 sub setup_components {
1966 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1967 my $config = $class->config->{ setup_components };
1968 my $extra = delete $config->{ search_extra } || [];
1970 push @paths, @$extra;
1972 my $locator = Module::Pluggable::Object->new(
1973 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1977 my @comps = sort { length $a <=> length $b } $locator->plugins;
1978 my %comps = map { $_ => 1 } @comps;
1980 for my $component ( @comps ) {
1982 # We pass ignore_loaded here so that overlay files for (e.g.)
1983 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
1984 # we know M::P::O found a file on disk so this is safe
1986 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1987 #Class::MOP::load_class($component);
1989 my $module = $class->setup_component( $component );
1991 $component => $module,
1993 $_ => $class->setup_component( $_ )
1995 not exists $comps{$_}
1996 } Devel::InnerPackage::list_packages( $component )
1999 for my $key ( keys %modules ) {
2000 $class->components->{ $key } = $modules{ $key };
2005 =head2 $c->setup_component
2009 sub setup_component {
2010 my( $class, $component ) = @_;
2012 unless ( $component->can( 'COMPONENT' ) ) {
2016 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2017 my $config = $class->config->{ $suffix } || {};
2019 my $instance = eval { $component->COMPONENT( $class, $config ); };
2021 if ( my $error = $@ ) {
2023 Catalyst::Exception->throw(
2024 message => qq/Couldn't instantiate component "$component", "$error"/
2028 Catalyst::Exception->throw(
2030 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2031 ) unless blessed($instance);
2036 =head2 $c->setup_dispatcher
2042 sub setup_dispatcher {
2043 my ( $class, $dispatcher ) = @_;
2046 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2049 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2050 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2053 unless ($dispatcher) {
2054 $dispatcher = $class->dispatcher_class;
2057 Class::MOP::load_class($dispatcher);
2059 # dispatcher instance
2060 $class->dispatcher( $dispatcher->new );
2063 =head2 $c->setup_engine
2070 my ( $class, $engine ) = @_;
2073 $engine = 'Catalyst::Engine::' . $engine;
2076 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2077 $engine = 'Catalyst::Engine::' . $env;
2080 if ( $ENV{MOD_PERL} ) {
2082 # create the apache method
2083 $class->meta->add_method('apache' => sub { shift->engine->apache });
2085 my ( $software, $version ) =
2086 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2089 $version =~ s/(\.[^.]+)\./$1/g;
2091 if ( $software eq 'mod_perl' ) {
2095 if ( $version >= 1.99922 ) {
2096 $engine = 'Catalyst::Engine::Apache2::MP20';
2099 elsif ( $version >= 1.9901 ) {
2100 $engine = 'Catalyst::Engine::Apache2::MP19';
2103 elsif ( $version >= 1.24 ) {
2104 $engine = 'Catalyst::Engine::Apache::MP13';
2108 Catalyst::Exception->throw( message =>
2109 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2114 # install the correct mod_perl handler
2115 if ( $version >= 1.9901 ) {
2116 *handler = sub : method {
2117 shift->handle_request(@_);
2121 *handler = sub ($$) { shift->handle_request(@_) };
2126 elsif ( $software eq 'Zeus-Perl' ) {
2127 $engine = 'Catalyst::Engine::Zeus';
2131 Catalyst::Exception->throw(
2132 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2137 $engine = $class->engine_class;
2140 Class::MOP::load_class($engine);
2142 # check for old engines that are no longer compatible
2144 if ( $engine->isa('Catalyst::Engine::Apache')
2145 && !Catalyst::Engine::Apache->VERSION )
2150 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2151 && Catalyst::Engine::Server->VERSION le '0.02' )
2156 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2157 && $engine->VERSION eq '0.01' )
2162 elsif ($engine->isa('Catalyst::Engine::Zeus')
2163 && $engine->VERSION eq '0.01' )
2169 Catalyst::Exception->throw( message =>
2170 qq/Engine "$engine" is not supported by this version of Catalyst/
2175 $class->engine( $engine->new );
2178 =head2 $c->setup_home
2180 Sets up the home directory.
2185 my ( $class, $home ) = @_;
2187 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2191 $home ||= Catalyst::Utils::home($class);
2194 #I remember recently being scolded for assigning config values like this
2195 $class->config->{home} ||= $home;
2196 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2200 =head2 $c->setup_log
2207 my ( $class, $debug ) = @_;
2209 unless ( $class->log ) {
2210 $class->log( Catalyst::Log->new );
2213 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2214 if ( defined($env_debug) ? $env_debug : $debug ) {
2215 $class->meta->add_method('debug' => sub { 1 });
2216 $class->log->debug('Debug messages enabled');
2220 =head2 $c->setup_plugins
2226 =head2 $c->setup_stats
2228 Sets up timing statistics class.
2233 my ( $class, $stats ) = @_;
2235 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2237 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2238 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2239 $class->meta->add_method('use_stats' => sub { 1 });
2240 $class->log->debug('Statistics enabled');
2245 =head2 $c->registered_plugins
2247 Returns a sorted list of the plugins which have either been stated in the
2248 import list or which have been added via C<< MyApp->plugin(@args); >>.
2250 If passed a given plugin name, it will report a boolean value indicating
2251 whether or not that plugin is loaded. A fully qualified name is required if
2252 the plugin name does not begin with C<Catalyst::Plugin::>.
2254 if ($c->registered_plugins('Some::Plugin')) {
2262 sub registered_plugins {
2264 return sort keys %{ $proto->_plugins } unless @_;
2266 return 1 if exists $proto->_plugins->{$plugin};
2267 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2270 sub _register_plugin {
2271 my ( $proto, $plugin, $instant ) = @_;
2272 my $class = ref $proto || $proto;
2274 # no ignore_loaded here, the plugin may already have been
2275 # defined in memory and we don't want to error on "no file" if so
2277 Class::MOP::load_class( $plugin );
2279 $proto->_plugins->{$plugin} = 1;
2282 if( $class->can('meta') ){
2283 my @superclasses = ($plugin, $class->meta->superclasses );
2284 $class->meta->superclasses(@superclasses);
2286 unshift @{"$class\::ISA"}, $plugin;
2293 my ( $class, $plugins ) = @_;
2295 $class->_plugins( {} ) unless $class->_plugins;
2297 for my $plugin ( reverse @$plugins ) {
2299 unless ( $plugin =~ s/\A\+// ) {
2300 $plugin = "Catalyst::Plugin::$plugin";
2303 $class->_register_plugin($plugin);
2310 Returns an arrayref of the internal execution stack (actions that are
2311 currently executing).
2313 =head2 $c->stats_class
2315 Returns or sets the stats (timing statistics) class.
2317 =head2 $c->use_stats
2319 Returns 1 when stats collection is enabled. Stats collection is enabled
2320 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2321 environment variable is set.
2323 Note that this is a static method, not an accessor and should be overloaded
2324 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2331 =head2 $c->write( $data )
2333 Writes $data to the output stream. When using this method directly, you
2334 will need to manually set the C<Content-Length> header to the length of
2335 your output data, if known.
2342 # Finalize headers if someone manually writes output
2343 $c->finalize_headers;
2345 return $c->engine->write( $c, @_ );
2350 Returns the Catalyst version number. Mostly useful for "powered by"
2351 messages in template systems.
2355 sub version { return $Catalyst::VERSION }
2357 =head1 INTERNAL ACTIONS
2359 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2360 C<_ACTION>, and C<_END>. These are by default not shown in the private
2361 action table, but you can make them visible with a config parameter.
2363 MyApp->config->{show_internal_actions} = 1;
2365 =head1 CASE SENSITIVITY
2367 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2368 mapped to C</foo/bar>. You can activate case sensitivity with a config
2371 MyApp->config->{case_sensitive} = 1;
2373 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2375 =head1 ON-DEMAND PARSER
2377 The request body is usually parsed at the beginning of a request,
2378 but if you want to handle input yourself, you can enable on-demand
2379 parsing with a config parameter.
2381 MyApp->config->{parse_on_demand} = 1;
2383 =head1 PROXY SUPPORT
2385 Many production servers operate using the common double-server approach,
2386 with a lightweight frontend web server passing requests to a larger
2387 backend server. An application running on the backend server must deal
2388 with two problems: the remote user always appears to be C<127.0.0.1> and
2389 the server's hostname will appear to be C<localhost> regardless of the
2390 virtual host that the user connected through.
2392 Catalyst will automatically detect this situation when you are running
2393 the frontend and backend servers on the same machine. The following
2394 changes are made to the request.
2396 $c->req->address is set to the user's real IP address, as read from
2397 the HTTP X-Forwarded-For header.
2399 The host value for $c->req->base and $c->req->uri is set to the real
2400 host, as read from the HTTP X-Forwarded-Host header.
2402 Obviously, your web server must support these headers for this to work.
2404 In a more complex server farm environment where you may have your
2405 frontend proxy server(s) on different machines, you will need to set a
2406 configuration option to tell Catalyst to read the proxied data from the
2409 MyApp->config->{using_frontend_proxy} = 1;
2411 If you do not wish to use the proxy support at all, you may set:
2413 MyApp->config->{ignore_frontend_proxy} = 1;
2415 =head1 THREAD SAFETY
2417 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2418 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2419 believe the Catalyst core to be thread-safe.
2421 If you plan to operate in a threaded environment, remember that all other
2422 modules you are using must also be thread-safe. Some modules, most notably
2423 L<DBD::SQLite>, are not thread-safe.
2429 Join #catalyst on irc.perl.org.
2433 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2434 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2438 http://catalyst.perl.org
2442 http://dev.catalyst.perl.org
2446 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2448 =head2 L<Catalyst::Manual> - The Catalyst Manual
2450 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2452 =head2 L<Catalyst::Engine> - Core engine
2454 =head2 L<Catalyst::Log> - Log class.
2456 =head2 L<Catalyst::Request> - Request object
2458 =head2 L<Catalyst::Response> - Response object
2460 =head2 L<Catalyst::Test> - The test suite.
2462 =head1 PROJECT FOUNDER
2464 sri: Sebastian Riedel <sri@cpan.org>
2470 acme: Leon Brocard <leon@astray.com>
2478 andyg: Andy Grundman <andy@hybridized.org>
2480 audreyt: Audrey Tang
2482 bricas: Brian Cassidy <bricas@cpan.org>
2484 Caelum: Rafael Kitover <rkitover@io.com>
2486 chansen: Christian Hansen
2488 chicks: Christopher Hicks
2490 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2494 esskar: Sascha Kiefer
2496 fireartist: Carl Franks <cfranks@cpan.org>
2498 gabb: Danijel Milicevic
2504 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2506 jcamacho: Juan Camacho
2512 jon: Jon Schutz <jjschutz@cpan.org>
2514 marcus: Marcus Ramberg <mramberg@cpan.org>
2516 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2518 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2522 naughton: David Naughton
2524 ningu: David Kamholz <dkamholz@cpan.org>
2526 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2528 numa: Dan Sully <daniel@cpan.org>
2532 omega: Andreas Marienborg
2534 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2536 rafl: Florian Ragwitz <rafl@debian.org>
2540 the_jester: Jesse Sheidlower
2544 willert: Sebastian Willert <willert@cpan.org>
2548 This library is free software, you can redistribute it and/or modify it under
2549 the same terms as Perl itself.
2555 __PACKAGE__->meta->make_immutable;