4 extends 'Catalyst::Component';
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
13 use Catalyst::Controller;
14 use Devel::InnerPackage ();
16 use Module::Pluggable::Object ();
17 use Text::SimpleTable ();
18 use Path::Class::Dir ();
19 use Path::Class::File ();
23 use Tree::Simple qw/use_weak_refs/;
24 use Tree::Simple::Visitor::FindByUID;
25 use Class::C3::Adopt::NEXT;
28 use Carp qw/croak carp shortmess/;
30 BEGIN { require 5.008001; }
32 has stack => (is => 'ro', 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_06';
82 my $dev_version = $VERSION =~ /_\d{2}$/;
83 *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
86 $VERSION = eval $VERSION;
89 my ( $class, @arguments ) = @_;
91 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
93 return unless $class eq 'Catalyst';
95 my $caller = caller();
96 return if $caller eq 'main';
98 # Kill Adopt::NEXT warnings if we're a non-RC version
99 unless (_IS_DEVELOPMENT_VERSION()) {
100 Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
103 my $meta = Moose::Meta::Class->initialize($caller);
104 #Moose->import({ into => $caller }); #do we want to do this?
106 unless ( $caller->isa('Catalyst') ) {
107 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
108 $meta->superclasses(@superclasses);
110 unless( $meta->has_method('meta') ){
111 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
114 $caller->arguments( [@arguments] );
120 Catalyst - The Elegant MVC Web Application Framework
124 See the L<Catalyst::Manual> distribution for comprehensive
125 documentation and tutorials.
127 # Install Catalyst::Devel for helpers and other development tools
128 # use the helper to create a new application
131 # add models, views, controllers
132 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
133 script/myapp_create.pl view MyTemplate TT
134 script/myapp_create.pl controller Search
136 # built in testserver -- use -r to restart automatically on changes
137 # --help to see all available options
138 script/myapp_server.pl
140 # command line testing interface
141 script/myapp_test.pl /yada
144 use Catalyst qw/-Debug/; # include plugins here as well
146 ### In lib/MyApp/Controller/Root.pm (autocreated)
147 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
148 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
149 $c->stash->{template} = 'foo.tt'; # set the template
150 # lookup something from db -- stash vars are passed to TT
152 $c->model('Database::Foo')->search( { country => $args[0] } );
153 if ( $c->req->params->{bar} ) { # access GET or POST parameters
154 $c->forward( 'bar' ); # process another action
155 # do something else after forward returns
159 # The foo.tt TT template can use the stash data from the database
160 [% WHILE (item = data.next) %]
164 # called for /bar/of/soap, /bar/of/soap/10, etc.
165 sub bar : Path('/bar/of/soap') { ... }
167 # called for all actions, from the top-most controller downwards
169 my ( $self, $c ) = @_;
170 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
171 $c->res->redirect( '/login' ); # require login
172 return 0; # abort request and go immediately to end()
174 return 1; # success; carry on to next action
177 # called after all actions are finished
179 my ( $self, $c ) = @_;
180 if ( scalar @{ $c->error } ) { ... } # handle errors
181 return if $c->res->body; # already have a response
182 $c->forward( 'MyApp::View::TT' ); # render template
185 ### in MyApp/Controller/Foo.pm
186 # called for /foo/bar
187 sub bar : Local { ... }
189 # called for /blargle
190 sub blargle : Global { ... }
192 # an index action matches /foo, but not /foo/1, etc.
193 sub index : Private { ... }
195 ### in MyApp/Controller/Foo/Bar.pm
196 # called for /foo/bar/baz
197 sub baz : Local { ... }
199 # first Root auto is called, then Foo auto, then this
200 sub auto : Private { ... }
202 # powerful regular expression paths are also possible
203 sub details : Regex('^product/(\w+)/details$') {
204 my ( $self, $c ) = @_;
205 # extract the (\w+) from the URI
206 my $product = $c->req->captures->[0];
209 See L<Catalyst::Manual::Intro> for additional information.
213 Catalyst is a modern framework for making web applications without the
214 pain usually associated with this process. This document is a reference
215 to the main Catalyst application. If you are a new user, we suggest you
216 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
218 See L<Catalyst::Manual> for more documentation.
220 Catalyst plugins can be loaded by naming them as arguments to the "use
221 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
222 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
225 use Catalyst qw/My::Module/;
227 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
228 fully qualify the name by using a unary plus:
232 +Fully::Qualified::Plugin::Name
235 Special flags like C<-Debug> and C<-Engine> can also be specified as
236 arguments when Catalyst is loaded:
238 use Catalyst qw/-Debug My::Module/;
240 The position of plugins and flags in the chain is important, because
241 they are loaded in the order in which they appear.
243 The following flags are supported:
247 Enables debug output. You can also force this setting from the system
248 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
249 settings override the application, with <MYAPP>_DEBUG having the highest
254 Forces Catalyst to use a specific engine. Omit the
255 C<Catalyst::Engine::> prefix of the engine name, i.e.:
257 use Catalyst qw/-Engine=CGI/;
261 Forces Catalyst to use a specific home directory, e.g.:
263 use Catalyst qw[-Home=/usr/mst];
265 This can also be done in the shell environment by setting either the
266 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
267 is replaced with the uppercased name of your application, any "::" in
268 the name will be replaced with underscores, e.g. MyApp::Web should use
269 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
273 use Catalyst '-Log=warn,fatal,error';
275 Specifies a comma-delimited list of log levels.
279 Enables statistics collection and reporting. You can also force this setting
280 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
281 environment settings override the application, with <MYAPP>_STATS having the
286 use Catalyst qw/-Stats=1/
290 =head2 INFORMATION ABOUT THE CURRENT REQUEST
294 Returns a L<Catalyst::Action> object for the current action, which
295 stringifies to the action name. See L<Catalyst::Action>.
299 Returns the namespace of the current action, i.e., the URI prefix
300 corresponding to the controller of the current action. For example:
302 # in Controller::Foo::Bar
303 $c->namespace; # returns 'foo/bar';
309 Returns the current L<Catalyst::Request> object, giving access to
310 information about the current client request (including parameters,
311 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
313 =head2 REQUEST FLOW HANDLING
315 =head2 $c->forward( $action [, \@arguments ] )
317 =head2 $c->forward( $class, $method, [, \@arguments ] )
319 Forwards processing to another action, by its private name. If you give a
320 class name but no method, C<process()> is called. You may also optionally
321 pass arguments in an arrayref. The action will receive the arguments in
322 C<@_> and C<< $c->req->args >>. Upon returning from the function,
323 C<< $c->req->args >> will be restored to the previous values.
325 Any data C<return>ed from the action forwarded to, will be returned by the
328 my $foodata = $c->forward('/foo');
329 $c->forward('index');
330 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
331 $c->forward('MyApp::View::TT');
333 Note that forward implies an C<<eval { }>> around the call (actually
334 C<execute> does), thus de-fatalizing all 'dies' within the called
335 action. If you want C<die> to propagate you need to do something like:
338 die $c->error if $c->error;
340 Or make sure to always return true values from your actions and write
343 $c->forward('foo') || return;
347 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
349 =head2 $c->detach( $action [, \@arguments ] )
351 =head2 $c->detach( $class, $method, [, \@arguments ] )
355 The same as C<forward>, but doesn't return to the previous action when
356 processing is finished.
358 When called with no arguments it escapes the processing chain entirely.
362 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
364 =head2 $c->visit( $action [, \@arguments ] )
366 =head2 $c->visit( $class, $method, [, \@arguments ] )
368 Almost the same as C<forward>, but does a full dispatch, instead of just
369 calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
370 C<auto> and the method you go to are called, just like a new request.
372 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
373 This means, for example, that $c->action methods such as C<name>, C<class> and
374 C<reverse> return information for the visited action when they are invoked
375 within the visited action. This is different from the behavior of C<forward>
376 which continues to use the $c->action object from the caller action even when
377 invoked from the callee.
379 C<$c-E<gt>stash> is kept unchanged.
381 In effect, C<visit> allows you to "wrap" another action, just as it
382 would have been called by dispatching from a URL, while the analogous
383 C<go> allows you to transfer control to another action as if it had
384 been reached directly from a URL.
388 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
390 =head2 $c->go( $action [, \@arguments ] )
392 =head2 $c->go( $class, $method, [, \@arguments ] )
394 Almost the same as C<detach>, but does a full dispatch like C<visit>,
395 instead of just calling the new C<$action> /
396 C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
397 method you visit are called, just like a new request.
399 C<$c-E<gt>stash> is kept unchanged.
403 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
409 Returns the current L<Catalyst::Response> object, see there for details.
413 Returns a hashref to the stash, which may be used to store data and pass
414 it between components during a request. You can also set hash keys by
415 passing arguments. The stash is automatically sent to the view. The
416 stash is cleared at the end of a request; it cannot be used for
417 persistent storage (for this you must use a session; see
418 L<Catalyst::Plugin::Session> for a complete system integrated with
421 $c->stash->{foo} = $bar;
422 $c->stash( { moose => 'majestic', qux => 0 } );
423 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
425 # stash is automatically passed to the view for use in a template
426 $c->forward( 'MyApp::View::TT' );
430 around stash => sub {
433 my $stash = $orig->($c);
435 my $new_stash = @_ > 1 ? {@_} : $_[0];
436 croak('stash takes a hash or hashref') unless ref $new_stash;
437 foreach my $key ( keys %$new_stash ) {
438 $stash->{$key} = $new_stash->{$key};
448 =head2 $c->error($error, ...)
450 =head2 $c->error($arrayref)
452 Returns an arrayref containing error messages. If Catalyst encounters an
453 error while processing a request, it stores the error in $c->error. This
454 method should only be used to store fatal error messages.
456 my @error = @{ $c->error };
460 $c->error('Something bad happened');
467 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
468 croak @$error unless ref $c;
469 push @{ $c->{error} }, @$error;
471 elsif ( defined $_[0] ) { $c->{error} = undef }
472 return $c->{error} || [];
478 Contains the return value of the last executed action.
480 =head2 $c->clear_errors
482 Clear errors. You probably don't want to clear the errors unless you are
483 implementing a custom error screen.
485 This is equivalent to running
496 # search components given a name and some prefixes
497 sub _comp_search_prefixes {
498 my ( $c, $name, @prefixes ) = @_;
499 my $appclass = ref $c || $c;
500 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
501 $filter = qr/$filter/; # Compile regex now rather than once per loop
503 # map the original component name to the sub part that we will search against
504 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
505 grep { /$filter/ } keys %{ $c->components };
507 # undef for a name will return all
508 return keys %eligible if !defined $name;
510 my $query = ref $name ? $name : qr/^$name$/i;
511 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
513 return map { $c->components->{ $_ } } @result if @result;
515 # if we were given a regexp to search against, we're done.
520 @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
522 # no results? try against full names
524 @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
527 # don't warn if we didn't find any results, it just might not exist
529 # Disgusting hack to work out correct method name
530 my $warn_for = lc $prefixes[0];
531 my $msg = "Used regexp fallback for \$c->{$warn_for}('${name}'), which found '" .
532 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
533 "component resolution is unreliable and unsafe.";
534 my $short = $result[0];
535 $short =~ s/.*?Model:://;
536 my $shortmess = Carp::shortmess('');
537 if ($shortmess =~ m#Catalyst/Plugin#) {
538 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
540 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
541 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
542 "component's config";
544 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
545 "but if you really wanted to search, pass in a regexp as the argument " .
546 "like so: \$c->${warn_for}(qr/${name}/)";
548 $c->log->warn( "${msg}$shortmess" );
554 # Find possible names for a prefix
556 my ( $c, @prefixes ) = @_;
557 my $appclass = ref $c || $c;
559 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
561 my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
565 # Filter a component before returning by calling ACCEPT_CONTEXT if available
566 sub _filter_component {
567 my ( $c, $comp, @args ) = @_;
569 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
570 return $comp->ACCEPT_CONTEXT( $c, @args );
576 =head2 COMPONENT ACCESSORS
578 =head2 $c->controller($name)
580 Gets a L<Catalyst::Controller> instance by name.
582 $c->controller('Foo')->do_stuff;
584 If the name is omitted, will return the controller for the dispatched
587 If you want to search for controllers, pass in a regexp as the argument.
589 # find all controllers that start with Foo
590 my @foo_controllers = $c->controller(qr{^Foo});
596 my ( $c, $name, @args ) = @_;
599 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
600 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
601 return $c->_filter_component( $result[ 0 ], @args );
604 return $c->component( $c->action->class );
607 =head2 $c->model($name)
609 Gets a L<Catalyst::Model> instance by name.
611 $c->model('Foo')->do_stuff;
613 Any extra arguments are directly passed to ACCEPT_CONTEXT.
615 If the name is omitted, it will look for
616 - a model object in $c->stash->{current_model_instance}, then
617 - a model name in $c->stash->{current_model}, then
618 - a config setting 'default_model', or
619 - check if there is only one model, and return it if that's the case.
621 If you want to search for models, pass in a regexp as the argument.
623 # find all models that start with Foo
624 my @foo_models = $c->model(qr{^Foo});
629 my ( $c, $name, @args ) = @_;
632 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
633 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
634 return $c->_filter_component( $result[ 0 ], @args );
638 return $c->stash->{current_model_instance}
639 if $c->stash->{current_model_instance};
640 return $c->model( $c->stash->{current_model} )
641 if $c->stash->{current_model};
643 return $c->model( $c->config->{default_model} )
644 if $c->config->{default_model};
646 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
649 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
650 $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
651 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
652 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
653 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
656 return $c->_filter_component( $comp );
660 =head2 $c->view($name)
662 Gets a L<Catalyst::View> instance by name.
664 $c->view('Foo')->do_stuff;
666 Any extra arguments are directly passed to ACCEPT_CONTEXT.
668 If the name is omitted, it will look for
669 - a view object in $c->stash->{current_view_instance}, then
670 - a view name in $c->stash->{current_view}, then
671 - a config setting 'default_view', or
672 - check if there is only one view, and return it if that's the case.
674 If you want to search for views, pass in a regexp as the argument.
676 # find all views that start with Foo
677 my @foo_views = $c->view(qr{^Foo});
682 my ( $c, $name, @args ) = @_;
685 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
686 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
687 return $c->_filter_component( $result[ 0 ], @args );
691 return $c->stash->{current_view_instance}
692 if $c->stash->{current_view_instance};
693 return $c->view( $c->stash->{current_view} )
694 if $c->stash->{current_view};
696 return $c->view( $c->config->{default_view} )
697 if $c->config->{default_view};
699 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
702 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
703 $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
704 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
705 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
706 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
709 return $c->_filter_component( $comp );
712 =head2 $c->controllers
714 Returns the available names which can be passed to $c->controller
720 return $c->_comp_names(qw/Controller C/);
725 Returns the available names which can be passed to $c->model
731 return $c->_comp_names(qw/Model M/);
737 Returns the available names which can be passed to $c->view
743 return $c->_comp_names(qw/View V/);
746 =head2 $c->comp($name)
748 =head2 $c->component($name)
750 Gets a component object by name. This method is not recommended,
751 unless you want to get a specific component by full
752 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
753 should be used instead.
755 If C<$name> is a regexp, a list of components matched against the full
756 component name will be returned.
761 my ( $c, $name, @args ) = @_;
764 my $comps = $c->components;
767 # is it the exact name?
768 return $c->_filter_component( $comps->{ $name }, @args )
769 if exists $comps->{ $name };
771 # perhaps we just omitted "MyApp"?
772 my $composed = ( ref $c || $c ) . "::${name}";
773 return $c->_filter_component( $comps->{ $composed }, @args )
774 if exists $comps->{ $composed };
776 # search all of the models, views and controllers
777 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
778 return $c->_filter_component( $comp, @args ) if $comp;
781 # This is here so $c->comp( '::M::' ) works
782 my $query = ref $name ? $name : qr{$name}i;
784 my @result = grep { m{$query} } keys %{ $c->components };
785 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
788 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
789 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
790 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
791 return $c->_filter_component( $result[ 0 ], @args );
794 # I would expect to return an empty list here, but that breaks back-compat
798 return sort keys %{ $c->components };
801 =head2 CLASS DATA AND HELPER CLASSES
805 Returns or takes a hashref containing the application's configuration.
807 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
809 You can also use a C<YAML>, C<XML> or C<Config::General> config file
810 like myapp.yml in your applications home directory. See
811 L<Catalyst::Plugin::ConfigLoader>.
814 db: dsn:SQLite:foo.db
819 around config => sub {
823 croak('Setting config after setup has been run is not allowed.')
824 if ( @_ and $c->setup_finished );
831 Returns the logging object instance. Unless it is already set, Catalyst
832 sets this up with a L<Catalyst::Log> object. To use your own log class,
833 set the logger with the C<< __PACKAGE__->log >> method prior to calling
834 C<< __PACKAGE__->setup >>.
836 __PACKAGE__->log( MyLogger->new );
841 $c->log->info( 'Now logging with my own logger!' );
843 Your log class should implement the methods described in
849 Overload to enable debug messages (same as -Debug option).
851 Note that this is a static method, not an accessor and should be overloaded
852 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
858 =head2 $c->dispatcher
860 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
864 Returns the engine instance. See L<Catalyst::Engine>.
867 =head2 UTILITY METHODS
869 =head2 $c->path_to(@path)
871 Merges C<@path> with C<< $c->config->{home} >> and returns a
872 L<Path::Class::Dir> object.
876 $c->path_to( 'db', 'sqlite.db' );
881 my ( $c, @path ) = @_;
882 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
883 if ( -d $path ) { return $path }
884 else { return Path::Class::File->new( $c->config->{home}, @path ) }
887 =head2 $c->plugin( $name, $class, @args )
889 Helper method for plugins. It creates a class data accessor/mutator and
890 loads and instantiates the given class.
892 MyApp->plugin( 'prototype', 'HTML::Prototype' );
894 $c->prototype->define_javascript_functions;
896 B<Note:> This method of adding plugins is deprecated. The ability
897 to add plugins like this B<will be removed> in a Catalyst 5.9.
898 Please do not use this functionality in new code.
903 my ( $class, $name, $plugin, @args ) = @_;
905 # See block comment in t/unit_core_plugin.t
906 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.9/);
908 $class->_register_plugin( $plugin, 1 );
910 eval { $plugin->import };
911 $class->mk_classdata($name);
913 eval { $obj = $plugin->new(@args) };
916 Catalyst::Exception->throw( message =>
917 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
921 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
927 Initializes the dispatcher and engine, loads any plugins, and loads the
928 model, view, and controller components. You may also specify an array
929 of plugins to load here, if you choose to not load them in the C<use
933 MyApp->setup( qw/-Debug/ );
938 my ( $class, @arguments ) = @_;
939 croak('Running setup more than once')
940 if ( $class->setup_finished );
942 unless ( $class->isa('Catalyst') ) {
944 Catalyst::Exception->throw(
945 message => qq/'$class' does not inherit from Catalyst/ );
948 if ( $class->arguments ) {
949 @arguments = ( @arguments, @{ $class->arguments } );
955 foreach (@arguments) {
959 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
961 elsif (/^-(\w+)=?(.*)$/) {
962 $flags->{ lc $1 } = $2;
965 push @{ $flags->{plugins} }, $_;
969 $class->setup_home( delete $flags->{home} );
971 $class->setup_log( delete $flags->{log} );
972 $class->setup_plugins( delete $flags->{plugins} );
973 $class->setup_dispatcher( delete $flags->{dispatcher} );
974 $class->setup_engine( delete $flags->{engine} );
975 $class->setup_stats( delete $flags->{stats} );
977 for my $flag ( sort keys %{$flags} ) {
979 if ( my $code = $class->can( 'setup_' . $flag ) ) {
980 &$code( $class, delete $flags->{$flag} );
983 $class->log->warn(qq/Unknown flag "$flag"/);
987 eval { require Catalyst::Devel; };
988 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
989 $class->log->warn(<<"EOF");
990 You are running an old script!
992 Please update by running (this will overwrite existing files):
993 catalyst.pl -force -scripts $class
995 or (this will not overwrite existing files):
996 catalyst.pl -scripts $class
1001 if ( $class->debug ) {
1002 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1005 my $column_width = Catalyst::Utils::term_width() - 6;
1006 my $t = Text::SimpleTable->new($column_width);
1007 $t->row($_) for @plugins;
1008 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1011 my $dispatcher = $class->dispatcher;
1012 my $engine = $class->engine;
1013 my $home = $class->config->{home};
1015 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1016 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1020 ? $class->log->debug(qq/Found home "$home"/)
1021 : $class->log->debug(qq/Home "$home" doesn't exist/)
1022 : $class->log->debug(q/Couldn't find home/);
1025 # Call plugins setup, this is stupid and evil.
1027 no warnings qw/redefine/;
1028 local *setup = sub { };
1032 # Initialize our data structure
1033 $class->components( {} );
1035 $class->setup_components;
1037 if ( $class->debug ) {
1038 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1039 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1040 for my $comp ( sort keys %{ $class->components } ) {
1041 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1042 $t->row( $comp, $type );
1044 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1045 if ( keys %{ $class->components } );
1048 # Add our self to components, since we are also a component
1049 if( $class->isa('Catalyst::Controller') ){
1050 $class->components->{$class} = $class;
1053 $class->setup_actions;
1055 if ( $class->debug ) {
1056 my $name = $class->config->{name} || 'Application';
1057 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1059 $class->log->_flush() if $class->log->can('_flush');
1061 # Make sure that the application class becomes immutable at this point,
1062 # which ensures that it gets an inlined constructor. This means that it
1063 # works even if the user has added a plugin which contains a new method.
1064 # Note however that we have to do the work on scope end, so that method
1065 # modifiers work correctly in MyApp (as you have to call setup _before_
1066 # applying modifiers).
1067 Scope::Upper::reap(sub {
1068 my $meta = Class::MOP::get_metaclass_by_name($class);
1069 $meta->make_immutable unless $meta->is_immutable;
1070 }, Scope::Upper::SCOPE(1));
1072 $class->setup_finalize;
1076 =head2 $app->setup_finalize
1078 A hook to attach modifiers to.
1079 Using C< after setup => sub{}; > doesn't work, because of quirky things done for plugin setup.
1080 Also better than C< setup_finished(); >, as that is a getter method.
1082 sub setup_finalize {
1086 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1088 $app->next::method(@_);
1095 sub setup_finalize {
1097 $class->setup_finished(1);
1100 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1102 =head2 $c->uri_for( $path, @args?, \%query_values? )
1108 A Catalyst::Action object representing the Catalyst action you want to
1109 create a URI for. To get one for an action in the current controller,
1110 use C<< $c->action('someactionname') >>. To get one from different
1111 controller, fetch the controller using C<< $c->controller() >>, then
1112 call C<action_for> on it.
1114 You can maintain the arguments captured by an action (e.g.: Regex, Chained)
1115 using C<< $c->req->captures >>.
1117 # For the current action
1118 $c->uri_for($c->action, $c->req->captures);
1120 # For the Foo action in the Bar controller
1121 $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
1128 my ( $c, $path, @args ) = @_;
1130 if ( blessed($path) ) { # action object
1131 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1134 $path = $c->dispatcher->uri_for_action($path, $captures);
1135 return undef unless defined($path);
1136 $path = '/' if $path eq '';
1139 undef($path) if (defined $path && $path eq '');
1142 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1144 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1145 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1147 unshift(@args, $path);
1149 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1150 my $namespace = $c->namespace;
1151 if (defined $path) { # cheesy hack to handle path '../foo'
1152 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1154 unshift(@args, $namespace || '');
1157 # join args with '/', or a blank string
1158 my $args = join('/', grep { defined($_) } @args);
1159 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1161 my $base = $c->req->base;
1162 my $class = ref($base);
1163 $base =~ s{(?<!/)$}{/};
1167 if (my @keys = keys %$params) {
1168 # somewhat lifted from URI::_query's query_form
1169 $query = '?'.join('&', map {
1170 my $val = $params->{$_};
1171 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1174 $val = '' unless defined $val;
1177 utf8::encode( $_ ) if utf8::is_utf8($_);
1178 # using the URI::Escape pattern here so utf8 chars survive
1179 s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1181 "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1185 my $res = bless(\"${base}${args}${query}", $class);
1189 =head2 $c->welcome_message
1191 Returns the Catalyst welcome HTML page.
1195 sub welcome_message {
1197 my $name = $c->config->{name};
1198 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1199 my $prefix = Catalyst::Utils::appprefix( ref $c );
1200 $c->response->content_type('text/html; charset=utf-8');
1202 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1203 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1204 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1206 <meta http-equiv="Content-Language" content="en" />
1207 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1208 <title>$name on Catalyst $VERSION</title>
1209 <style type="text/css">
1212 background-color: #eee;
1219 margin-bottom: 10px;
1221 background-color: #ccc;
1222 border: 1px solid #aaa;
1227 font-family: verdana, tahoma, sans-serif;
1230 font-family: verdana, tahoma, sans-serif;
1233 text-decoration: none;
1235 border-bottom: 1px dotted #bbb;
1237 :link:hover, :visited:hover {
1250 background-color: #fff;
1251 border: 1px solid #aaa;
1255 font-weight: normal;
1277 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1282 <img src="$logo" alt="Catalyst Logo" />
1284 <p>Welcome to the world of Catalyst.
1285 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1286 framework will make web development something you had
1287 never expected it to be: Fun, rewarding, and quick.</p>
1288 <h2>What to do now?</h2>
1289 <p>That really depends on what <b>you</b> want to do.
1290 We do, however, provide you with a few starting points.</p>
1291 <p>If you want to jump right into web development with Catalyst
1292 you might want to start with a tutorial.</p>
1293 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1295 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1297 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1298 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1300 <h2>What to do next?</h2>
1301 <p>Next it's time to write an actual application. Use the
1302 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1303 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1304 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1305 they can save you a lot of work.</p>
1306 <pre><code>script/${prefix}_create.pl -help</code></pre>
1307 <p>Also, be sure to check out the vast and growing
1308 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1309 you are likely to find what you need there.
1313 <p>Catalyst has a very active community. Here are the main places to
1314 get in touch with us.</p>
1317 <a href="http://dev.catalyst.perl.org">Wiki</a>
1320 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1323 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1326 <h2>In conclusion</h2>
1327 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1328 as we enjoyed making it. Please contact us if you have ideas
1329 for improvement or other feedback.</p>
1337 =head1 INTERNAL METHODS
1339 These methods are not meant to be used by end users.
1341 =head2 $c->components
1343 Returns a hash of components.
1345 =head2 $c->context_class
1347 Returns or sets the context class.
1351 Returns a hashref containing coderefs and execution counts (needed for
1352 deep recursion detection).
1356 Returns the number of actions on the current internal execution stack.
1360 Dispatches a request to actions.
1364 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1366 =head2 $c->dispatcher_class
1368 Returns or sets the dispatcher class.
1370 =head2 $c->dump_these
1372 Returns a list of 2-element array references (name, structure) pairs
1373 that will be dumped on the error page in debug mode.
1379 [ Request => $c->req ],
1380 [ Response => $c->res ],
1381 [ Stash => $c->stash ],
1382 [ Config => $c->config ];
1385 =head2 $c->engine_class
1387 Returns or sets the engine class.
1389 =head2 $c->execute( $class, $coderef )
1391 Execute a coderef in given class and catch exceptions. Errors are available
1397 my ( $c, $class, $code ) = @_;
1398 $class = $c->component($class) || $class;
1401 if ( $c->depth >= $RECURSION ) {
1402 my $action = $code->reverse();
1403 $action = "/$action" unless $action =~ /->/;
1404 my $error = qq/Deep recursion detected calling "${action}"/;
1405 $c->log->error($error);
1411 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1413 push( @{ $c->stack }, $code );
1415 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1417 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1419 my $last = pop( @{ $c->stack } );
1421 if ( my $error = $@ ) {
1422 if ( !ref($error) and $error eq $DETACH ) {
1423 die $DETACH if($c->depth > 1);
1425 elsif ( !ref($error) and $error eq $GO ) {
1426 die $GO if($c->depth > 0);
1429 unless ( ref $error ) {
1430 no warnings 'uninitialized';
1432 my $class = $last->class;
1433 my $name = $last->name;
1434 $error = qq/Caught exception in $class->$name "$error"/;
1443 sub _stats_start_execute {
1444 my ( $c, $code ) = @_;
1446 return if ( ( $code->name =~ /^_.*/ )
1447 && ( !$c->config->{show_internal_actions} ) );
1449 my $action_name = $code->reverse();
1450 $c->counter->{$action_name}++;
1452 my $action = $action_name;
1453 $action = "/$action" unless $action =~ /->/;
1455 # determine if the call was the result of a forward
1456 # this is done by walking up the call stack and looking for a calling
1457 # sub of Catalyst::forward before the eval
1459 for my $index ( 2 .. 11 ) {
1461 if ( ( caller($index) )[0] eq 'Catalyst'
1462 && ( caller($index) )[3] eq '(eval)' );
1464 if ( ( caller($index) )[3] =~ /forward$/ ) {
1465 $callsub = ( caller($index) )[3];
1466 $action = "-> $action";
1471 my $uid = $action_name . $c->counter->{$action_name};
1473 # is this a root-level call or a forwarded call?
1474 if ( $callsub =~ /forward$/ ) {
1476 # forward, locate the caller
1477 if ( my $parent = $c->stack->[-1] ) {
1480 parent => "$parent" . $c->counter->{"$parent"},
1486 # forward with no caller may come from a plugin
1505 sub _stats_finish_execute {
1506 my ( $c, $info ) = @_;
1507 $c->stats->profile( end => $info );
1510 =head2 $c->_localize_fields( sub { }, \%keys );
1514 #Why does this exist? This is no longer safe and WILL NOT WORK.
1515 # it doesnt seem to be used anywhere. can we remove it?
1516 sub _localize_fields {
1517 my ( $c, $localized, $code ) = ( @_ );
1519 my $request = delete $localized->{request} || {};
1520 my $response = delete $localized->{response} || {};
1522 local @{ $c }{ keys %$localized } = values %$localized;
1523 local @{ $c->request }{ keys %$request } = values %$request;
1524 local @{ $c->response }{ keys %$response } = values %$response;
1531 Finalizes the request.
1538 for my $error ( @{ $c->error } ) {
1539 $c->log->error($error);
1542 # Allow engine to handle finalize flow (for POE)
1543 my $engine = $c->engine;
1544 if ( my $code = $engine->can('finalize') ) {
1549 $c->finalize_uploads;
1552 if ( $#{ $c->error } >= 0 ) {
1556 $c->finalize_headers;
1559 if ( $c->request->method eq 'HEAD' ) {
1560 $c->response->body('');
1566 if ($c->use_stats) {
1567 my $elapsed = sprintf '%f', $c->stats->elapsed;
1568 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1570 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1573 return $c->response->status;
1576 =head2 $c->finalize_body
1582 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1584 =head2 $c->finalize_cookies
1590 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1592 =head2 $c->finalize_error
1598 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1600 =head2 $c->finalize_headers
1606 sub finalize_headers {
1609 my $response = $c->response; #accessor calls can add up?
1611 # Check if we already finalized headers
1612 return if $response->finalized_headers;
1615 if ( my $location = $response->redirect ) {
1616 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1617 $response->header( Location => $location );
1619 if ( !$response->has_body ) {
1620 # Add a default body if none is already present
1622 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1628 if ( $response->body && !$response->content_length ) {
1630 # get the length from a filehandle
1631 if ( blessed( $response->body ) && $response->body->can('read') )
1633 my $stat = stat $response->body;
1634 if ( $stat && $stat->size > 0 ) {
1635 $response->content_length( $stat->size );
1638 $c->log->warn('Serving filehandle without a content-length');
1642 # everything should be bytes at this point, but just in case
1643 $response->content_length( bytes::length( $response->body ) );
1648 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1649 $response->headers->remove_header("Content-Length");
1650 $response->body('');
1653 $c->finalize_cookies;
1655 $c->engine->finalize_headers( $c, @_ );
1658 $response->finalized_headers(1);
1661 =head2 $c->finalize_output
1663 An alias for finalize_body.
1665 =head2 $c->finalize_read
1667 Finalizes the input after reading is complete.
1671 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1673 =head2 $c->finalize_uploads
1675 Finalizes uploads. Cleans up any temporary files.
1679 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1681 =head2 $c->get_action( $action, $namespace )
1683 Gets an action in a given namespace.
1687 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1689 =head2 $c->get_actions( $action, $namespace )
1691 Gets all actions of a given name in a namespace and all parent
1696 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1698 =head2 $c->handle_request( $class, @arguments )
1700 Called to handle each HTTP request.
1704 sub handle_request {
1705 my ( $class, @arguments ) = @_;
1707 # Always expect worst case!
1710 if ($class->debug) {
1711 my $secs = time - $START || 1;
1712 my $av = sprintf '%.3f', $COUNT / $secs;
1713 my $time = localtime time;
1714 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1717 my $c = $class->prepare(@arguments);
1719 $status = $c->finalize;
1722 if ( my $error = $@ ) {
1724 $class->log->error(qq/Caught exception in engine "$error"/);
1729 if(my $coderef = $class->log->can('_flush')){
1730 $class->log->$coderef();
1735 =head2 $c->prepare( @arguments )
1737 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1743 my ( $class, @arguments ) = @_;
1746 # After the app/ctxt split, this should become an attribute based on something passed
1747 # into the application.
1748 $class->context_class( ref $class || $class ) unless $class->context_class;
1750 my $c = $class->context_class->new({});
1752 # For on-demand data
1753 $c->request->_context($c);
1754 $c->response->_context($c);
1756 #surely this is not the most efficient way to do things...
1757 $c->stats($class->stats_class->new)->enable($c->use_stats);
1759 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1762 #XXX reuse coderef from can
1763 # Allow engine to direct the prepare flow (for POE)
1764 if ( $c->engine->can('prepare') ) {
1765 $c->engine->prepare( $c, @arguments );
1768 $c->prepare_request(@arguments);
1769 $c->prepare_connection;
1770 $c->prepare_query_parameters;
1771 $c->prepare_headers;
1772 $c->prepare_cookies;
1775 # Prepare the body for reading, either by prepare_body
1776 # or the user, if they are using $c->read
1779 # Parse the body unless the user wants it on-demand
1780 unless ( $c->config->{parse_on_demand} ) {
1785 my $method = $c->req->method || '';
1786 my $path = $c->req->path;
1787 $path = '/' unless length $path;
1788 my $address = $c->req->address || '';
1790 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1798 =head2 $c->prepare_action
1800 Prepares action. See L<Catalyst::Dispatcher>.
1804 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1806 =head2 $c->prepare_body
1808 Prepares message body.
1815 return if $c->request->_has_body;
1817 # Initialize on-demand data
1818 $c->engine->prepare_body( $c, @_ );
1819 $c->prepare_parameters;
1820 $c->prepare_uploads;
1822 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1823 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1824 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1825 my $param = $c->req->body_parameters->{$key};
1826 my $value = defined($param) ? $param : '';
1828 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1830 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1834 =head2 $c->prepare_body_chunk( $chunk )
1836 Prepares a chunk of data before sending it to L<HTTP::Body>.
1838 See L<Catalyst::Engine>.
1842 sub prepare_body_chunk {
1844 $c->engine->prepare_body_chunk( $c, @_ );
1847 =head2 $c->prepare_body_parameters
1849 Prepares body parameters.
1853 sub prepare_body_parameters {
1855 $c->engine->prepare_body_parameters( $c, @_ );
1858 =head2 $c->prepare_connection
1860 Prepares connection.
1864 sub prepare_connection {
1866 $c->engine->prepare_connection( $c, @_ );
1869 =head2 $c->prepare_cookies
1875 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1877 =head2 $c->prepare_headers
1883 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1885 =head2 $c->prepare_parameters
1887 Prepares parameters.
1891 sub prepare_parameters {
1893 $c->prepare_body_parameters;
1894 $c->engine->prepare_parameters( $c, @_ );
1897 =head2 $c->prepare_path
1899 Prepares path and base.
1903 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1905 =head2 $c->prepare_query_parameters
1907 Prepares query parameters.
1911 sub prepare_query_parameters {
1914 $c->engine->prepare_query_parameters( $c, @_ );
1916 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1917 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1918 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1919 my $param = $c->req->query_parameters->{$key};
1920 my $value = defined($param) ? $param : '';
1922 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1924 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1928 =head2 $c->prepare_read
1930 Prepares the input for reading.
1934 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1936 =head2 $c->prepare_request
1938 Prepares the engine request.
1942 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1944 =head2 $c->prepare_uploads
1950 sub prepare_uploads {
1953 $c->engine->prepare_uploads( $c, @_ );
1955 if ( $c->debug && keys %{ $c->request->uploads } ) {
1956 my $t = Text::SimpleTable->new(
1957 [ 12, 'Parameter' ],
1962 for my $key ( sort keys %{ $c->request->uploads } ) {
1963 my $upload = $c->request->uploads->{$key};
1964 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1965 $t->row( $key, $u->filename, $u->type, $u->size );
1968 $c->log->debug( "File Uploads are:\n" . $t->draw );
1972 =head2 $c->prepare_write
1974 Prepares the output for writing.
1978 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1980 =head2 $c->request_class
1982 Returns or sets the request class.
1984 =head2 $c->response_class
1986 Returns or sets the response class.
1988 =head2 $c->read( [$maxlength] )
1990 Reads a chunk of data from the request body. This method is designed to
1991 be used in a while loop, reading C<$maxlength> bytes on every call.
1992 C<$maxlength> defaults to the size of the request if not specified.
1994 You have to set C<< MyApp->config->{parse_on_demand} >> to use this
1997 Warning: If you use read(), Catalyst will not process the body,
1998 so you will not be able to access POST parameters or file uploads via
1999 $c->request. You must handle all body parsing yourself.
2003 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2011 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2013 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2015 Sets an action in a given namespace.
2019 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2021 =head2 $c->setup_actions($component)
2023 Sets up actions for a component.
2027 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2029 =head2 $c->setup_components
2031 Sets up components. Specify a C<setup_components> config option to pass
2032 additional options directly to L<Module::Pluggable>. To add additional
2033 search paths, specify a key named C<search_extra> as an array
2034 reference. Items in the array beginning with C<::> will have the
2035 application class name prepended to them.
2037 All components found will also have any
2038 L<Devel::InnerPackage|inner packages> loaded and set up as components.
2039 Note, that modules which are B<not> an I<inner package> of the main
2040 file namespace loaded will not be instantiated as components.
2044 sub setup_components {
2047 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2048 my $config = $class->config->{ setup_components };
2049 my $extra = delete $config->{ search_extra } || [];
2051 push @paths, @$extra;
2053 my $locator = Module::Pluggable::Object->new(
2054 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2058 my @comps = sort { length $a <=> length $b } $locator->plugins;
2059 my %comps = map { $_ => 1 } @comps;
2061 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2062 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2063 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2064 ) if $deprecated_component_names;
2066 for my $component ( @comps ) {
2068 # We pass ignore_loaded here so that overlay files for (e.g.)
2069 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2070 # we know M::P::O found a file on disk so this is safe
2072 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2073 #Class::MOP::load_class($component);
2075 my $module = $class->setup_component( $component );
2077 $component => $module,
2079 $_ => $class->setup_component( $_ )
2081 not exists $comps{$_}
2082 } Devel::InnerPackage::list_packages( $component )
2085 for my $key ( keys %modules ) {
2086 $class->components->{ $key } = $modules{ $key };
2091 =head2 $c->setup_component
2095 sub setup_component {
2096 my( $class, $component ) = @_;
2098 unless ( $component->can( 'COMPONENT' ) ) {
2102 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2103 my $config = $class->config->{ $suffix } || {};
2105 my $instance = eval { $component->COMPONENT( $class, $config ); };
2107 if ( my $error = $@ ) {
2109 Catalyst::Exception->throw(
2110 message => qq/Couldn't instantiate component "$component", "$error"/
2114 Catalyst::Exception->throw(
2116 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
2117 ) unless blessed($instance);
2122 =head2 $c->setup_dispatcher
2128 sub setup_dispatcher {
2129 my ( $class, $dispatcher ) = @_;
2132 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2135 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2136 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2139 unless ($dispatcher) {
2140 $dispatcher = $class->dispatcher_class;
2143 Class::MOP::load_class($dispatcher);
2145 # dispatcher instance
2146 $class->dispatcher( $dispatcher->new );
2149 =head2 $c->setup_engine
2156 my ( $class, $engine ) = @_;
2159 $engine = 'Catalyst::Engine::' . $engine;
2162 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2163 $engine = 'Catalyst::Engine::' . $env;
2166 if ( $ENV{MOD_PERL} ) {
2167 my $meta = Class::MOP::get_metaclass_by_name($class);
2169 # create the apache method
2170 $meta->add_method('apache' => sub { shift->engine->apache });
2172 my ( $software, $version ) =
2173 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2176 $version =~ s/(\.[^.]+)\./$1/g;
2178 if ( $software eq 'mod_perl' ) {
2182 if ( $version >= 1.99922 ) {
2183 $engine = 'Catalyst::Engine::Apache2::MP20';
2186 elsif ( $version >= 1.9901 ) {
2187 $engine = 'Catalyst::Engine::Apache2::MP19';
2190 elsif ( $version >= 1.24 ) {
2191 $engine = 'Catalyst::Engine::Apache::MP13';
2195 Catalyst::Exception->throw( message =>
2196 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2201 # install the correct mod_perl handler
2202 if ( $version >= 1.9901 ) {
2203 *handler = sub : method {
2204 shift->handle_request(@_);
2208 *handler = sub ($$) { shift->handle_request(@_) };
2213 elsif ( $software eq 'Zeus-Perl' ) {
2214 $engine = 'Catalyst::Engine::Zeus';
2218 Catalyst::Exception->throw(
2219 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2224 $engine = $class->engine_class;
2227 Class::MOP::load_class($engine);
2229 # check for old engines that are no longer compatible
2231 if ( $engine->isa('Catalyst::Engine::Apache')
2232 && !Catalyst::Engine::Apache->VERSION )
2237 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2238 && Catalyst::Engine::Server->VERSION le '0.02' )
2243 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2244 && $engine->VERSION eq '0.01' )
2249 elsif ($engine->isa('Catalyst::Engine::Zeus')
2250 && $engine->VERSION eq '0.01' )
2256 Catalyst::Exception->throw( message =>
2257 qq/Engine "$engine" is not supported by this version of Catalyst/
2262 $class->engine( $engine->new );
2265 =head2 $c->setup_home
2267 Sets up the home directory.
2272 my ( $class, $home ) = @_;
2274 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2278 $home ||= Catalyst::Utils::home($class);
2281 #I remember recently being scolded for assigning config values like this
2282 $class->config->{home} ||= $home;
2283 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2287 =head2 $c->setup_log
2289 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2290 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2293 This method also installs a C<debug> method that returns a true value into the
2294 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2295 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2297 Note that if the log has already been setup, by either a previous call to
2298 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2299 that this method won't actually set up the log object.
2304 my ( $class, $levels ) = @_;
2307 $levels =~ s/^\s+//;
2308 $levels =~ s/\s+$//;
2309 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels || '';
2311 unless ( $class->log ) {
2312 $class->log( Catalyst::Log->new(keys %levels) );
2315 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2316 if ( defined($env_debug) or $levels{debug} ) {
2317 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2318 $class->log->debug('Debug messages enabled');
2322 =head2 $c->setup_plugins
2328 =head2 $c->setup_stats
2330 Sets up timing statistics class.
2335 my ( $class, $stats ) = @_;
2337 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2339 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2340 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2341 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2342 $class->log->debug('Statistics enabled');
2347 =head2 $c->registered_plugins
2349 Returns a sorted list of the plugins which have either been stated in the
2350 import list or which have been added via C<< MyApp->plugin(@args); >>.
2352 If passed a given plugin name, it will report a boolean value indicating
2353 whether or not that plugin is loaded. A fully qualified name is required if
2354 the plugin name does not begin with C<Catalyst::Plugin::>.
2356 if ($c->registered_plugins('Some::Plugin')) {
2364 sub registered_plugins {
2366 return sort keys %{ $proto->_plugins } unless @_;
2368 return 1 if exists $proto->_plugins->{$plugin};
2369 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2372 sub _register_plugin {
2373 my ( $proto, $plugin, $instant ) = @_;
2374 my $class = ref $proto || $proto;
2376 # no ignore_loaded here, the plugin may already have been
2377 # defined in memory and we don't want to error on "no file" if so
2379 Class::MOP::load_class( $plugin );
2381 $proto->_plugins->{$plugin} = 1;
2384 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2385 my @superclasses = ($plugin, $meta->superclasses );
2386 $meta->superclasses(@superclasses);
2388 unshift @{"$class\::ISA"}, $plugin;
2395 my ( $class, $plugins ) = @_;
2397 $class->_plugins( {} ) unless $class->_plugins;
2399 for my $plugin ( reverse @$plugins ) {
2401 unless ( $plugin =~ s/\A\+// ) {
2402 $plugin = "Catalyst::Plugin::$plugin";
2405 $class->_register_plugin($plugin);
2412 Returns an arrayref of the internal execution stack (actions that are
2413 currently executing).
2415 =head2 $c->stats_class
2417 Returns or sets the stats (timing statistics) class.
2419 =head2 $c->use_stats
2421 Returns 1 when stats collection is enabled. Stats collection is enabled
2422 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2423 environment variable is set.
2425 Note that this is a static method, not an accessor and should be overloaded
2426 by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
2433 =head2 $c->write( $data )
2435 Writes $data to the output stream. When using this method directly, you
2436 will need to manually set the C<Content-Length> header to the length of
2437 your output data, if known.
2444 # Finalize headers if someone manually writes output
2445 $c->finalize_headers;
2447 return $c->engine->write( $c, @_ );
2452 Returns the Catalyst version number. Mostly useful for "powered by"
2453 messages in template systems.
2457 sub version { return $Catalyst::VERSION }
2459 =head1 INTERNAL ACTIONS
2461 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2462 C<_ACTION>, and C<_END>. These are by default not shown in the private
2463 action table, but you can make them visible with a config parameter.
2465 MyApp->config->{show_internal_actions} = 1;
2467 =head1 CASE SENSITIVITY
2469 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2470 mapped to C</foo/bar>. You can activate case sensitivity with a config
2473 MyApp->config->{case_sensitive} = 1;
2475 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2477 =head1 ON-DEMAND PARSER
2479 The request body is usually parsed at the beginning of a request,
2480 but if you want to handle input yourself, you can enable on-demand
2481 parsing with a config parameter.
2483 MyApp->config->{parse_on_demand} = 1;
2485 =head1 PROXY SUPPORT
2487 Many production servers operate using the common double-server approach,
2488 with a lightweight frontend web server passing requests to a larger
2489 backend server. An application running on the backend server must deal
2490 with two problems: the remote user always appears to be C<127.0.0.1> and
2491 the server's hostname will appear to be C<localhost> regardless of the
2492 virtual host that the user connected through.
2494 Catalyst will automatically detect this situation when you are running
2495 the frontend and backend servers on the same machine. The following
2496 changes are made to the request.
2498 $c->req->address is set to the user's real IP address, as read from
2499 the HTTP X-Forwarded-For header.
2501 The host value for $c->req->base and $c->req->uri is set to the real
2502 host, as read from the HTTP X-Forwarded-Host header.
2504 Obviously, your web server must support these headers for this to work.
2506 In a more complex server farm environment where you may have your
2507 frontend proxy server(s) on different machines, you will need to set a
2508 configuration option to tell Catalyst to read the proxied data from the
2511 MyApp->config->{using_frontend_proxy} = 1;
2513 If you do not wish to use the proxy support at all, you may set:
2515 MyApp->config->{ignore_frontend_proxy} = 1;
2517 =head1 THREAD SAFETY
2519 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2520 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2521 believe the Catalyst core to be thread-safe.
2523 If you plan to operate in a threaded environment, remember that all other
2524 modules you are using must also be thread-safe. Some modules, most notably
2525 L<DBD::SQLite>, are not thread-safe.
2531 Join #catalyst on irc.perl.org.
2535 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2536 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2540 http://catalyst.perl.org
2544 http://dev.catalyst.perl.org
2548 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2550 =head2 L<Catalyst::Manual> - The Catalyst Manual
2552 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2554 =head2 L<Catalyst::Engine> - Core engine
2556 =head2 L<Catalyst::Log> - Log class.
2558 =head2 L<Catalyst::Request> - Request object
2560 =head2 L<Catalyst::Response> - Response object
2562 =head2 L<Catalyst::Test> - The test suite.
2564 =head1 PROJECT FOUNDER
2566 sri: Sebastian Riedel <sri@cpan.org>
2572 acme: Leon Brocard <leon@astray.com>
2580 andyg: Andy Grundman <andy@hybridized.org>
2582 audreyt: Audrey Tang
2584 bricas: Brian Cassidy <bricas@cpan.org>
2586 Caelum: Rafael Kitover <rkitover@io.com>
2588 chansen: Christian Hansen
2590 chicks: Christopher Hicks
2594 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2598 esskar: Sascha Kiefer
2600 fireartist: Carl Franks <cfranks@cpan.org>
2602 gabb: Danijel Milicevic
2608 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2610 jcamacho: Juan Camacho
2612 jhannah: Jay Hannah <jay@jays.net>
2618 jon: Jon Schutz <jjschutz@cpan.org>
2620 marcus: Marcus Ramberg <mramberg@cpan.org>
2622 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2624 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2628 naughton: David Naughton
2630 ningu: David Kamholz <dkamholz@cpan.org>
2632 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2634 numa: Dan Sully <daniel@cpan.org>
2638 omega: Andreas Marienborg
2640 Oleg Kostyuk <cub.uanic@gmail.com>
2642 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2644 rafl: Florian Ragwitz <rafl@debian.org>
2648 the_jester: Jesse Sheidlower
2650 t0m: Tomas Doran <bobtfish@bobtfish.net>
2654 willert: Sebastian Willert <willert@cpan.org>
2658 This library is free software, you can redistribute it and/or modify it under
2659 the same terms as Perl itself.
2665 __PACKAGE__->meta->make_immutable;