4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
8 use B::Hooks::EndOfScope ();
9 use Catalyst::Exception;
10 use Catalyst::Exception::Detach;
11 use Catalyst::Exception::Go;
13 use Catalyst::Request;
14 use Catalyst::Request::Upload;
15 use Catalyst::Response;
17 use Catalyst::Controller;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
33 use Carp qw/croak carp shortmess/;
35 BEGIN { require 5.008001; }
37 has stack => (is => 'ro', default => sub { [] });
38 has stash => (is => 'rw', default => sub { {} });
39 has state => (is => 'rw', default => 0);
40 has stats => (is => 'rw');
41 has action => (is => 'rw');
42 has counter => (is => 'rw', default => sub { {} });
43 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
44 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
45 has namespace => (is => 'rw');
47 sub depth { scalar @{ shift->stack || [] }; }
48 sub comp { shift->component(@_) }
51 my $self = shift; return $self->request(@_);
54 my $self = shift; return $self->response(@_);
57 # For backwards compatibility
58 sub finalize_output { shift->finalize_body(@_) };
63 our $RECURSION = 1000;
64 our $DETACH = Catalyst::Exception::Detach->new;
65 our $GO = Catalyst::Exception::Go->new;
67 #I imagine that very few of these really need to be class variables. if any.
68 #maybe we should just make them attributes with a default?
69 __PACKAGE__->mk_classdata($_)
70 for qw/components arguments dispatcher engine log dispatcher_class
71 engine_class context_class request_class response_class stats_class
74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
75 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
76 __PACKAGE__->request_class('Catalyst::Request');
77 __PACKAGE__->response_class('Catalyst::Response');
78 __PACKAGE__->stats_class('Catalyst::Stats');
80 # Remember to update this in Catalyst::Runtime as well!
82 our $VERSION = '5.80007';
85 my $dev_version = $VERSION =~ /_\d{2}$/;
86 *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
89 $VERSION = eval $VERSION;
92 my ( $class, @arguments ) = @_;
94 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
96 return unless $class eq 'Catalyst';
98 my $caller = caller();
99 return if $caller eq 'main';
101 # Kill Adopt::NEXT warnings if we're a non-RC version
102 unless (_IS_DEVELOPMENT_VERSION()) {
103 Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
106 my $meta = Moose::Meta::Class->initialize($caller);
107 unless ( $caller->isa('Catalyst') ) {
108 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
109 $meta->superclasses(@superclasses);
111 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
112 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
114 unless( $meta->has_method('meta') ){
115 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
118 $caller->arguments( [@arguments] );
122 sub _application { $_[0] }
126 Catalyst - The Elegant MVC Web Application Framework
130 See the L<Catalyst::Manual> distribution for comprehensive
131 documentation and tutorials.
133 # Install Catalyst::Devel for helpers and other development tools
134 # use the helper to create a new application
137 # add models, views, controllers
138 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
139 script/myapp_create.pl view MyTemplate TT
140 script/myapp_create.pl controller Search
142 # built in testserver -- use -r to restart automatically on changes
143 # --help to see all available options
144 script/myapp_server.pl
146 # command line testing interface
147 script/myapp_test.pl /yada
150 use Catalyst qw/-Debug/; # include plugins here as well
152 ### In lib/MyApp/Controller/Root.pm (autocreated)
153 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
154 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
155 $c->stash->{template} = 'foo.tt'; # set the template
156 # lookup something from db -- stash vars are passed to TT
158 $c->model('Database::Foo')->search( { country => $args[0] } );
159 if ( $c->req->params->{bar} ) { # access GET or POST parameters
160 $c->forward( 'bar' ); # process another action
161 # do something else after forward returns
165 # The foo.tt TT template can use the stash data from the database
166 [% WHILE (item = data.next) %]
170 # called for /bar/of/soap, /bar/of/soap/10, etc.
171 sub bar : Path('/bar/of/soap') { ... }
173 # called for all actions, from the top-most controller downwards
175 my ( $self, $c ) = @_;
176 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
177 $c->res->redirect( '/login' ); # require login
178 return 0; # abort request and go immediately to end()
180 return 1; # success; carry on to next action
183 # called after all actions are finished
185 my ( $self, $c ) = @_;
186 if ( scalar @{ $c->error } ) { ... } # handle errors
187 return if $c->res->body; # already have a response
188 $c->forward( 'MyApp::View::TT' ); # render template
191 ### in MyApp/Controller/Foo.pm
192 # called for /foo/bar
193 sub bar : Local { ... }
195 # called for /blargle
196 sub blargle : Global { ... }
198 # an index action matches /foo, but not /foo/1, etc.
199 sub index : Private { ... }
201 ### in MyApp/Controller/Foo/Bar.pm
202 # called for /foo/bar/baz
203 sub baz : Local { ... }
205 # first Root auto is called, then Foo auto, then this
206 sub auto : Private { ... }
208 # powerful regular expression paths are also possible
209 sub details : Regex('^product/(\w+)/details$') {
210 my ( $self, $c ) = @_;
211 # extract the (\w+) from the URI
212 my $product = $c->req->captures->[0];
215 See L<Catalyst::Manual::Intro> for additional information.
219 Catalyst is a modern framework for making web applications without the
220 pain usually associated with this process. This document is a reference
221 to the main Catalyst application. If you are a new user, we suggest you
222 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
224 See L<Catalyst::Manual> for more documentation.
226 Catalyst plugins can be loaded by naming them as arguments to the "use
227 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
228 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
231 use Catalyst qw/My::Module/;
233 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
234 fully qualify the name by using a unary plus:
238 +Fully::Qualified::Plugin::Name
241 Special flags like C<-Debug> and C<-Engine> can also be specified as
242 arguments when Catalyst is loaded:
244 use Catalyst qw/-Debug My::Module/;
246 The position of plugins and flags in the chain is important, because
247 they are loaded in the order in which they appear.
249 The following flags are supported:
253 Enables debug output. You can also force this setting from the system
254 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
255 settings override the application, with <MYAPP>_DEBUG having the highest
260 Forces Catalyst to use a specific engine. Omit the
261 C<Catalyst::Engine::> prefix of the engine name, i.e.:
263 use Catalyst qw/-Engine=CGI/;
267 Forces Catalyst to use a specific home directory, e.g.:
269 use Catalyst qw[-Home=/usr/mst];
271 This can also be done in the shell environment by setting either the
272 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
273 is replaced with the uppercased name of your application, any "::" in
274 the name will be replaced with underscores, e.g. MyApp::Web should use
275 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
279 use Catalyst '-Log=warn,fatal,error';
281 Specifies a comma-delimited list of log levels.
285 Enables statistics collection and reporting. You can also force this setting
286 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
287 environment settings override the application, with <MYAPP>_STATS having the
292 use Catalyst qw/-Stats=1/
296 =head2 INFORMATION ABOUT THE CURRENT REQUEST
300 Returns a L<Catalyst::Action> object for the current action, which
301 stringifies to the action name. See L<Catalyst::Action>.
305 Returns the namespace of the current action, i.e., the URI prefix
306 corresponding to the controller of the current action. For example:
308 # in Controller::Foo::Bar
309 $c->namespace; # returns 'foo/bar';
315 Returns the current L<Catalyst::Request> object, giving access to
316 information about the current client request (including parameters,
317 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
319 =head2 REQUEST FLOW HANDLING
321 =head2 $c->forward( $action [, \@arguments ] )
323 =head2 $c->forward( $class, $method, [, \@arguments ] )
325 Forwards processing to another action, by its private name. If you give a
326 class name but no method, C<process()> is called. You may also optionally
327 pass arguments in an arrayref. The action will receive the arguments in
328 C<@_> and C<< $c->req->args >>. Upon returning from the function,
329 C<< $c->req->args >> will be restored to the previous values.
331 Any data C<return>ed from the action forwarded to, will be returned by the
334 my $foodata = $c->forward('/foo');
335 $c->forward('index');
336 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
337 $c->forward('MyApp::View::TT');
339 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
340 an C<< eval { } >> around the call (actually
341 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
342 all 'dies' within the called action. If you want C<die> to propagate you
343 need to do something like:
346 die $c->error if $c->error;
348 Or make sure to always return true values from your actions and write
351 $c->forward('foo') || return;
355 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
357 =head2 $c->detach( $action [, \@arguments ] )
359 =head2 $c->detach( $class, $method, [, \@arguments ] )
363 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
364 doesn't return to the previous action when processing is finished.
366 When called with no arguments it escapes the processing chain entirely.
370 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
372 =head2 $c->visit( $action [, \@captures, \@arguments ] )
374 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
376 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
377 but does a full dispatch, instead of just calling the new C<$action> /
378 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
379 you go to are called, just like a new request.
381 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
382 This means, for example, that C<< $c->action >> methods such as
383 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
384 L<reverse|Catalyst::Action/reverse> return information for the visited action
385 when they are invoked within the visited action. This is different from the
386 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
387 continues to use the $c->action object from the caller action even when
388 invoked from the callee.
390 C<< $c->stash >> is kept unchanged.
392 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
393 allows you to "wrap" another action, just as it would have been called by
394 dispatching from a URL, while the analogous
395 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
396 transfer control to another action as if it had been reached directly from a URL.
400 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
402 =head2 $c->go( $action [, \@captures, \@arguments ] )
404 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
406 Almost the same as L<< detach|/"$c->detach( $action [, \@arguments ] )" >>, but does a full dispatch like L</visit>,
407 instead of just calling the new C<$action> /
408 C<< $class->$method >>. This means that C<begin>, C<auto> and the
409 method you visit are called, just like a new request.
411 C<< $c->stash >> is kept unchanged.
415 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
421 Returns the current L<Catalyst::Response> object, see there for details.
425 Returns a hashref to the stash, which may be used to store data and pass
426 it between components during a request. You can also set hash keys by
427 passing arguments. The stash is automatically sent to the view. The
428 stash is cleared at the end of a request; it cannot be used for
429 persistent storage (for this you must use a session; see
430 L<Catalyst::Plugin::Session> for a complete system integrated with
433 $c->stash->{foo} = $bar;
434 $c->stash( { moose => 'majestic', qux => 0 } );
435 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
437 # stash is automatically passed to the view for use in a template
438 $c->forward( 'MyApp::View::TT' );
442 around stash => sub {
445 my $stash = $orig->($c);
447 my $new_stash = @_ > 1 ? {@_} : $_[0];
448 croak('stash takes a hash or hashref') unless ref $new_stash;
449 foreach my $key ( keys %$new_stash ) {
450 $stash->{$key} = $new_stash->{$key};
460 =head2 $c->error($error, ...)
462 =head2 $c->error($arrayref)
464 Returns an arrayref containing error messages. If Catalyst encounters an
465 error while processing a request, it stores the error in $c->error. This
466 method should only be used to store fatal error messages.
468 my @error = @{ $c->error };
472 $c->error('Something bad happened');
479 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
480 croak @$error unless ref $c;
481 push @{ $c->{error} }, @$error;
483 elsif ( defined $_[0] ) { $c->{error} = undef }
484 return $c->{error} || [];
490 Contains the return value of the last executed action.
492 =head2 $c->clear_errors
494 Clear errors. You probably don't want to clear the errors unless you are
495 implementing a custom error screen.
497 This is equivalent to running
508 sub _comp_search_prefixes {
510 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
513 # search components given a name and some prefixes
514 sub _comp_names_search_prefixes {
515 my ( $c, $name, @prefixes ) = @_;
516 my $appclass = ref $c || $c;
517 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
518 $filter = qr/$filter/; # Compile regex now rather than once per loop
520 # map the original component name to the sub part that we will search against
521 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
522 grep { /$filter/ } keys %{ $c->components };
524 # undef for a name will return all
525 return keys %eligible if !defined $name;
527 my $query = ref $name ? $name : qr/^$name$/i;
528 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
530 return @result if @result;
532 # if we were given a regexp to search against, we're done.
537 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
539 # no results? try against full names
541 @result = grep { m{$query} } keys %eligible;
544 # don't warn if we didn't find any results, it just might not exist
546 # Disgusting hack to work out correct method name
547 my $warn_for = lc $prefixes[0];
548 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
549 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
550 "component resolution is unreliable and unsafe.";
551 my $short = $result[0];
552 $short =~ s/.*?Model:://;
553 my $shortmess = Carp::shortmess('');
554 if ($shortmess =~ m#Catalyst/Plugin#) {
555 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
557 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
558 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
559 "component's config";
561 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
562 "but if you really wanted to search, pass in a regexp as the argument " .
563 "like so: \$c->${warn_for}(qr/${name}/)";
565 $c->log->warn( "${msg}$shortmess" );
571 # Find possible names for a prefix
573 my ( $c, @prefixes ) = @_;
574 my $appclass = ref $c || $c;
576 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
578 my @names = map { s{$filter}{}; $_; }
579 $c->_comp_names_search_prefixes( undef, @prefixes );
584 # Filter a component before returning by calling ACCEPT_CONTEXT if available
585 sub _filter_component {
586 my ( $c, $comp, @args ) = @_;
588 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
589 return $comp->ACCEPT_CONTEXT( $c, @args );
595 =head2 COMPONENT ACCESSORS
597 =head2 $c->controller($name)
599 Gets a L<Catalyst::Controller> instance by name.
601 $c->controller('Foo')->do_stuff;
603 If the name is omitted, will return the controller for the dispatched
606 If you want to search for controllers, pass in a regexp as the argument.
608 # find all controllers that start with Foo
609 my @foo_controllers = $c->controller(qr{^Foo});
615 my ( $c, $name, @args ) = @_;
618 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
619 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
620 return $c->_filter_component( $result[ 0 ], @args );
623 return $c->component( $c->action->class );
626 =head2 $c->model($name)
628 Gets a L<Catalyst::Model> instance by name.
630 $c->model('Foo')->do_stuff;
632 Any extra arguments are directly passed to ACCEPT_CONTEXT.
634 If the name is omitted, it will look for
635 - a model object in $c->stash->{current_model_instance}, then
636 - a model name in $c->stash->{current_model}, then
637 - a config setting 'default_model', or
638 - check if there is only one model, and return it if that's the case.
640 If you want to search for models, pass in a regexp as the argument.
642 # find all models that start with Foo
643 my @foo_models = $c->model(qr{^Foo});
648 my ( $c, $name, @args ) = @_;
651 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
652 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
653 return $c->_filter_component( $result[ 0 ], @args );
657 return $c->stash->{current_model_instance}
658 if $c->stash->{current_model_instance};
659 return $c->model( $c->stash->{current_model} )
660 if $c->stash->{current_model};
662 return $c->model( $c->config->{default_model} )
663 if $c->config->{default_model};
665 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
668 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
669 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
670 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
671 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
672 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
675 return $c->_filter_component( $comp );
679 =head2 $c->view($name)
681 Gets a L<Catalyst::View> instance by name.
683 $c->view('Foo')->do_stuff;
685 Any extra arguments are directly passed to ACCEPT_CONTEXT.
687 If the name is omitted, it will look for
688 - a view object in $c->stash->{current_view_instance}, then
689 - a view name in $c->stash->{current_view}, then
690 - a config setting 'default_view', or
691 - check if there is only one view, and return it if that's the case.
693 If you want to search for views, pass in a regexp as the argument.
695 # find all views that start with Foo
696 my @foo_views = $c->view(qr{^Foo});
701 my ( $c, $name, @args ) = @_;
704 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
705 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
706 return $c->_filter_component( $result[ 0 ], @args );
710 return $c->stash->{current_view_instance}
711 if $c->stash->{current_view_instance};
712 return $c->view( $c->stash->{current_view} )
713 if $c->stash->{current_view};
715 return $c->view( $c->config->{default_view} )
716 if $c->config->{default_view};
718 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
721 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
722 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
723 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
724 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
725 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
728 return $c->_filter_component( $comp );
731 =head2 $c->controllers
733 Returns the available names which can be passed to $c->controller
739 return $c->_comp_names(qw/Controller C/);
744 Returns the available names which can be passed to $c->model
750 return $c->_comp_names(qw/Model M/);
756 Returns the available names which can be passed to $c->view
762 return $c->_comp_names(qw/View V/);
765 =head2 $c->comp($name)
767 =head2 $c->component($name)
769 Gets a component object by name. This method is not recommended,
770 unless you want to get a specific component by full
771 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
772 should be used instead.
774 If C<$name> is a regexp, a list of components matched against the full
775 component name will be returned.
780 my ( $c, $name, @args ) = @_;
783 my $comps = $c->components;
786 # is it the exact name?
787 return $c->_filter_component( $comps->{ $name }, @args )
788 if exists $comps->{ $name };
790 # perhaps we just omitted "MyApp"?
791 my $composed = ( ref $c || $c ) . "::${name}";
792 return $c->_filter_component( $comps->{ $composed }, @args )
793 if exists $comps->{ $composed };
795 # search all of the models, views and controllers
796 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
797 return $c->_filter_component( $comp, @args ) if $comp;
800 # This is here so $c->comp( '::M::' ) works
801 my $query = ref $name ? $name : qr{$name}i;
803 my @result = grep { m{$query} } keys %{ $c->components };
804 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
807 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
808 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
809 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
810 return $c->_filter_component( $result[ 0 ], @args );
813 # I would expect to return an empty list here, but that breaks back-compat
817 return sort keys %{ $c->components };
820 =head2 CLASS DATA AND HELPER CLASSES
824 Returns or takes a hashref containing the application's configuration.
826 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
828 You can also use a C<YAML>, C<XML> or L<Config::General> config file
829 like C<myapp.conf> in your applications home directory. See
830 L<Catalyst::Plugin::ConfigLoader>.
832 =head3 Cascading configuration
834 The config method is present on all Catalyst components, and configuration
835 will be merged when an application is started. Configuration loaded with
836 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
837 followed by configuration in your top level C<MyApp> class. These two
838 configurations are merged, and then configuration data whose hash key matches a
839 component name is merged with configuration for that component.
841 The configuration for a component is then passed to the C<new> method when a
842 component is constructed.
846 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
847 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
849 will mean that C<MyApp::Model::Foo> receives the following data when
852 MyApp::Model::Foo->new({
860 around config => sub {
864 croak('Setting config after setup has been run is not allowed.')
865 if ( @_ and $c->setup_finished );
872 Returns the logging object instance. Unless it is already set, Catalyst
873 sets this up with a L<Catalyst::Log> object. To use your own log class,
874 set the logger with the C<< __PACKAGE__->log >> method prior to calling
875 C<< __PACKAGE__->setup >>.
877 __PACKAGE__->log( MyLogger->new );
882 $c->log->info( 'Now logging with my own logger!' );
884 Your log class should implement the methods described in
890 Returns 1 if debug mode is enabled, 0 otherwise.
892 You can enable debug mode in several ways:
896 =item By calling myapp_server.pl with the -d flag
898 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
900 =item The -Debug option in your MyApp.pm
902 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
906 Calling C<< $c->debug(1) >> has no effect.
912 =head2 $c->dispatcher
914 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
918 Returns the engine instance. See L<Catalyst::Engine>.
921 =head2 UTILITY METHODS
923 =head2 $c->path_to(@path)
925 Merges C<@path> with C<< $c->config->{home} >> and returns a
926 L<Path::Class::Dir> object. Note you can usually use this object as
927 a filename, but sometimes you will have to explicitly stringify it
928 yourself by calling the C<< ->stringify >> method.
932 $c->path_to( 'db', 'sqlite.db' );
937 my ( $c, @path ) = @_;
938 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
939 if ( -d $path ) { return $path }
940 else { return Path::Class::File->new( $c->config->{home}, @path ) }
943 =head2 $c->plugin( $name, $class, @args )
945 Helper method for plugins. It creates a class data accessor/mutator and
946 loads and instantiates the given class.
948 MyApp->plugin( 'prototype', 'HTML::Prototype' );
950 $c->prototype->define_javascript_functions;
952 B<Note:> This method of adding plugins is deprecated. The ability
953 to add plugins like this B<will be removed> in a Catalyst 5.81.
954 Please do not use this functionality in new code.
959 my ( $class, $name, $plugin, @args ) = @_;
961 # See block comment in t/unit_core_plugin.t
962 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
964 $class->_register_plugin( $plugin, 1 );
966 eval { $plugin->import };
967 $class->mk_classdata($name);
969 eval { $obj = $plugin->new(@args) };
972 Catalyst::Exception->throw( message =>
973 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
977 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
983 Initializes the dispatcher and engine, loads any plugins, and loads the
984 model, view, and controller components. You may also specify an array
985 of plugins to load here, if you choose to not load them in the C<use
989 MyApp->setup( qw/-Debug/ );
994 my ( $class, @arguments ) = @_;
995 croak('Running setup more than once')
996 if ( $class->setup_finished );
998 unless ( $class->isa('Catalyst') ) {
1000 Catalyst::Exception->throw(
1001 message => qq/'$class' does not inherit from Catalyst/ );
1004 if ( $class->arguments ) {
1005 @arguments = ( @arguments, @{ $class->arguments } );
1011 foreach (@arguments) {
1015 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1017 elsif (/^-(\w+)=?(.*)$/) {
1018 $flags->{ lc $1 } = $2;
1021 push @{ $flags->{plugins} }, $_;
1025 $class->setup_home( delete $flags->{home} );
1027 $class->setup_log( delete $flags->{log} );
1028 $class->setup_plugins( delete $flags->{plugins} );
1029 $class->setup_dispatcher( delete $flags->{dispatcher} );
1030 $class->setup_engine( delete $flags->{engine} );
1031 $class->setup_stats( delete $flags->{stats} );
1033 for my $flag ( sort keys %{$flags} ) {
1035 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1036 &$code( $class, delete $flags->{$flag} );
1039 $class->log->warn(qq/Unknown flag "$flag"/);
1043 eval { require Catalyst::Devel; };
1044 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1045 $class->log->warn(<<"EOF");
1046 You are running an old script!
1048 Please update by running (this will overwrite existing files):
1049 catalyst.pl -force -scripts $class
1051 or (this will not overwrite existing files):
1052 catalyst.pl -scripts $class
1057 if ( $class->debug ) {
1058 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1061 my $column_width = Catalyst::Utils::term_width() - 6;
1062 my $t = Text::SimpleTable->new($column_width);
1063 $t->row($_) for @plugins;
1064 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1067 my $dispatcher = $class->dispatcher;
1068 my $engine = $class->engine;
1069 my $home = $class->config->{home};
1071 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1072 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1076 ? $class->log->debug(qq/Found home "$home"/)
1077 : $class->log->debug(qq/Home "$home" doesn't exist/)
1078 : $class->log->debug(q/Couldn't find home/);
1081 # Call plugins setup, this is stupid and evil.
1082 # Also screws C3 badly on 5.10, hack to avoid.
1084 no warnings qw/redefine/;
1085 local *setup = sub { };
1086 $class->setup unless $Catalyst::__AM_RESTARTING;
1089 # Initialize our data structure
1090 $class->components( {} );
1092 $class->setup_components;
1094 if ( $class->debug ) {
1095 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1096 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1097 for my $comp ( sort keys %{ $class->components } ) {
1098 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1099 $t->row( $comp, $type );
1101 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1102 if ( keys %{ $class->components } );
1105 # Add our self to components, since we are also a component
1106 if( $class->isa('Catalyst::Controller') ){
1107 $class->components->{$class} = $class;
1110 $class->setup_actions;
1112 if ( $class->debug ) {
1113 my $name = $class->config->{name} || 'Application';
1114 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1116 $class->log->_flush() if $class->log->can('_flush');
1118 # Make sure that the application class becomes immutable at this point,
1119 B::Hooks::EndOfScope::on_scope_end {
1121 my $meta = Class::MOP::get_metaclass_by_name($class);
1124 && ! { $meta->immutable_options }->{replace_constructor}
1126 $class->isa('Class::Accessor::Fast')
1127 || $class->isa('Class::Accessor')
1130 warn "You made your application class ($class) immutable, "
1131 . "but did not inline the\nconstructor. "
1132 . "This will break catalyst, as your app \@ISA "
1133 . "Class::Accessor(::Fast)?\nPlease pass "
1134 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1136 $meta->make_immutable(replace_constructor => 1)
1137 unless $meta->is_immutable;
1140 $class->setup_finalize;
1144 =head2 $app->setup_finalize
1146 A hook to attach modifiers to.
1147 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1148 Also better than C< setup_finished(); >, as that is a getter method.
1150 sub setup_finalize {
1154 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1156 $app->next::method(@_);
1163 sub setup_finalize {
1165 $class->setup_finished(1);
1168 =head2 $c->uri_for( $path, @args?, \%query_values? )
1170 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1172 Constructs an absolute L<URI> object based on the application root, the
1173 provided path, and the additional arguments and query parameters provided.
1174 When used as a string, provides a textual URI.
1176 If the first argument is a string, it is taken as a public URI path relative
1177 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1178 relative to the application root (if it does). It is then merged with
1179 C<< $c->request->base >>; any C<@args> are appended as additional path
1180 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1182 If the first argument is a L<Catalyst::Action> it represents an action which
1183 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1184 optional C<\@captures> argument (an arrayref) allows passing the captured
1185 variables that are needed to fill in the paths of Chained and Regex actions;
1186 once the path is resolved, C<uri_for> continues as though a path was
1187 provided, appending any arguments or parameters and creating an absolute
1190 The captures for the current request can be found in
1191 C<< $c->request->captures >>, and actions can be resolved using
1192 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1193 path, use C<< $c->uri_for_action >> instead.
1195 # Equivalent to $c->req->uri
1196 $c->uri_for($c->action, $c->req->captures,
1197 @{ $c->req->args }, $c->req->params);
1199 # For the Foo action in the Bar controller
1200 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1202 # Path to a static resource
1203 $c->uri_for('/static/images/logo.png');
1208 my ( $c, $path, @args ) = @_;
1210 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1211 $path = $path->path_prefix;
1216 if ( blessed($path) ) { # action object
1217 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1221 $path = $c->dispatcher->uri_for_action($action, $captures);
1222 if (not defined $path) {
1223 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1227 $path = '/' if $path eq '';
1230 undef($path) if (defined $path && $path eq '');
1233 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1235 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1236 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1238 unshift(@args, $path);
1240 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1241 my $namespace = $c->namespace;
1242 if (defined $path) { # cheesy hack to handle path '../foo'
1243 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1245 unshift(@args, $namespace || '');
1248 # join args with '/', or a blank string
1249 my $args = join('/', grep { defined($_) } @args);
1250 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1252 my $base = $c->req->base;
1253 my $class = ref($base);
1254 $base =~ s{(?<!/)$}{/};
1258 if (my @keys = keys %$params) {
1259 # somewhat lifted from URI::_query's query_form
1260 $query = '?'.join('&', map {
1261 my $val = $params->{$_};
1262 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1265 $val = '' unless defined $val;
1268 utf8::encode( $param ) if utf8::is_utf8($param);
1269 # using the URI::Escape pattern here so utf8 chars survive
1270 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1272 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1276 my $res = bless(\"${base}${args}${query}", $class);
1280 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1282 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1288 A private path to the Catalyst action you want to create a URI for.
1290 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1291 >> and passing the resulting C<$action> and the remaining arguments to C<<
1294 You can also pass in a Catalyst::Action object, in which case it is passed to
1301 sub uri_for_action {
1302 my ( $c, $path, @args ) = @_;
1303 my $action = blessed($path)
1305 : $c->dispatcher->get_action_by_path($path);
1306 unless (defined $action) {
1307 croak "Can't find action for path '$path'";
1309 return $c->uri_for( $action, @args );
1312 =head2 $c->welcome_message
1314 Returns the Catalyst welcome HTML page.
1318 sub welcome_message {
1320 my $name = $c->config->{name};
1321 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1322 my $prefix = Catalyst::Utils::appprefix( ref $c );
1323 $c->response->content_type('text/html; charset=utf-8');
1325 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1326 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1327 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1329 <meta http-equiv="Content-Language" content="en" />
1330 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1331 <title>$name on Catalyst $VERSION</title>
1332 <style type="text/css">
1335 background-color: #eee;
1342 margin-bottom: 10px;
1344 background-color: #ccc;
1345 border: 1px solid #aaa;
1350 font-family: verdana, tahoma, sans-serif;
1353 font-family: verdana, tahoma, sans-serif;
1356 text-decoration: none;
1358 border-bottom: 1px dotted #bbb;
1360 :link:hover, :visited:hover {
1373 background-color: #fff;
1374 border: 1px solid #aaa;
1378 font-weight: normal;
1400 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1405 <img src="$logo" alt="Catalyst Logo" />
1407 <p>Welcome to the world of Catalyst.
1408 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1409 framework will make web development something you had
1410 never expected it to be: Fun, rewarding, and quick.</p>
1411 <h2>What to do now?</h2>
1412 <p>That really depends on what <b>you</b> want to do.
1413 We do, however, provide you with a few starting points.</p>
1414 <p>If you want to jump right into web development with Catalyst
1415 you might want to start with a tutorial.</p>
1416 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1418 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1420 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1421 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1423 <h2>What to do next?</h2>
1424 <p>Next it's time to write an actual application. Use the
1425 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1426 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1427 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1428 they can save you a lot of work.</p>
1429 <pre><code>script/${prefix}_create.pl -help</code></pre>
1430 <p>Also, be sure to check out the vast and growing
1431 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1432 you are likely to find what you need there.
1436 <p>Catalyst has a very active community. Here are the main places to
1437 get in touch with us.</p>
1440 <a href="http://dev.catalyst.perl.org">Wiki</a>
1443 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1446 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1449 <h2>In conclusion</h2>
1450 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1451 as we enjoyed making it. Please contact us if you have ideas
1452 for improvement or other feedback.</p>
1460 =head1 INTERNAL METHODS
1462 These methods are not meant to be used by end users.
1464 =head2 $c->components
1466 Returns a hash of components.
1468 =head2 $c->context_class
1470 Returns or sets the context class.
1474 Returns a hashref containing coderefs and execution counts (needed for
1475 deep recursion detection).
1479 Returns the number of actions on the current internal execution stack.
1483 Dispatches a request to actions.
1487 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1489 =head2 $c->dispatcher_class
1491 Returns or sets the dispatcher class.
1493 =head2 $c->dump_these
1495 Returns a list of 2-element array references (name, structure) pairs
1496 that will be dumped on the error page in debug mode.
1502 [ Request => $c->req ],
1503 [ Response => $c->res ],
1504 [ Stash => $c->stash ],
1505 [ Config => $c->config ];
1508 =head2 $c->engine_class
1510 Returns or sets the engine class.
1512 =head2 $c->execute( $class, $coderef )
1514 Execute a coderef in given class and catch exceptions. Errors are available
1520 my ( $c, $class, $code ) = @_;
1521 $class = $c->component($class) || $class;
1524 if ( $c->depth >= $RECURSION ) {
1525 my $action = $code->reverse();
1526 $action = "/$action" unless $action =~ /->/;
1527 my $error = qq/Deep recursion detected calling "${action}"/;
1528 $c->log->error($error);
1534 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1536 push( @{ $c->stack }, $code );
1538 no warnings 'recursion';
1539 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1541 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1543 my $last = pop( @{ $c->stack } );
1545 if ( my $error = $@ ) {
1546 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1547 $error->rethrow if $c->depth > 1;
1549 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1550 $error->rethrow if $c->depth > 0;
1553 unless ( ref $error ) {
1554 no warnings 'uninitialized';
1556 my $class = $last->class;
1557 my $name = $last->name;
1558 $error = qq/Caught exception in $class->$name "$error"/;
1567 sub _stats_start_execute {
1568 my ( $c, $code ) = @_;
1570 return if ( ( $code->name =~ /^_.*/ )
1571 && ( !$c->config->{show_internal_actions} ) );
1573 my $action_name = $code->reverse();
1574 $c->counter->{$action_name}++;
1576 my $action = $action_name;
1577 $action = "/$action" unless $action =~ /->/;
1579 # determine if the call was the result of a forward
1580 # this is done by walking up the call stack and looking for a calling
1581 # sub of Catalyst::forward before the eval
1583 for my $index ( 2 .. 11 ) {
1585 if ( ( caller($index) )[0] eq 'Catalyst'
1586 && ( caller($index) )[3] eq '(eval)' );
1588 if ( ( caller($index) )[3] =~ /forward$/ ) {
1589 $callsub = ( caller($index) )[3];
1590 $action = "-> $action";
1595 my $uid = $action_name . $c->counter->{$action_name};
1597 # is this a root-level call or a forwarded call?
1598 if ( $callsub =~ /forward$/ ) {
1600 # forward, locate the caller
1601 if ( my $parent = $c->stack->[-1] ) {
1604 parent => "$parent" . $c->counter->{"$parent"},
1610 # forward with no caller may come from a plugin
1629 sub _stats_finish_execute {
1630 my ( $c, $info ) = @_;
1631 $c->stats->profile( end => $info );
1636 Finalizes the request.
1643 for my $error ( @{ $c->error } ) {
1644 $c->log->error($error);
1647 # Allow engine to handle finalize flow (for POE)
1648 my $engine = $c->engine;
1649 if ( my $code = $engine->can('finalize') ) {
1654 $c->finalize_uploads;
1657 if ( $#{ $c->error } >= 0 ) {
1661 $c->finalize_headers;
1664 if ( $c->request->method eq 'HEAD' ) {
1665 $c->response->body('');
1671 if ($c->use_stats) {
1672 my $elapsed = sprintf '%f', $c->stats->elapsed;
1673 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1675 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1678 return $c->response->status;
1681 =head2 $c->finalize_body
1687 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1689 =head2 $c->finalize_cookies
1695 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1697 =head2 $c->finalize_error
1703 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1705 =head2 $c->finalize_headers
1711 sub finalize_headers {
1714 my $response = $c->response; #accessor calls can add up?
1716 # Check if we already finalized headers
1717 return if $response->finalized_headers;
1720 if ( my $location = $response->redirect ) {
1721 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1722 $response->header( Location => $location );
1724 if ( !$response->has_body ) {
1725 # Add a default body if none is already present
1727 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1733 if ( $response->body && !$response->content_length ) {
1735 # get the length from a filehandle
1736 if ( blessed( $response->body ) && $response->body->can('read') )
1738 my $stat = stat $response->body;
1739 if ( $stat && $stat->size > 0 ) {
1740 $response->content_length( $stat->size );
1743 $c->log->warn('Serving filehandle without a content-length');
1747 # everything should be bytes at this point, but just in case
1748 $response->content_length( bytes::length( $response->body ) );
1753 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1754 $response->headers->remove_header("Content-Length");
1755 $response->body('');
1758 $c->finalize_cookies;
1760 $c->engine->finalize_headers( $c, @_ );
1763 $response->finalized_headers(1);
1766 =head2 $c->finalize_output
1768 An alias for finalize_body.
1770 =head2 $c->finalize_read
1772 Finalizes the input after reading is complete.
1776 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1778 =head2 $c->finalize_uploads
1780 Finalizes uploads. Cleans up any temporary files.
1784 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1786 =head2 $c->get_action( $action, $namespace )
1788 Gets an action in a given namespace.
1792 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1794 =head2 $c->get_actions( $action, $namespace )
1796 Gets all actions of a given name in a namespace and all parent
1801 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1803 =head2 $c->handle_request( $class, @arguments )
1805 Called to handle each HTTP request.
1809 sub handle_request {
1810 my ( $class, @arguments ) = @_;
1812 # Always expect worst case!
1815 if ($class->debug) {
1816 my $secs = time - $START || 1;
1817 my $av = sprintf '%.3f', $COUNT / $secs;
1818 my $time = localtime time;
1819 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1822 my $c = $class->prepare(@arguments);
1824 $status = $c->finalize;
1827 if ( my $error = $@ ) {
1829 $class->log->error(qq/Caught exception in engine "$error"/);
1834 if(my $coderef = $class->log->can('_flush')){
1835 $class->log->$coderef();
1840 =head2 $c->prepare( @arguments )
1842 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1848 my ( $class, @arguments ) = @_;
1851 # After the app/ctxt split, this should become an attribute based on something passed
1852 # into the application.
1853 $class->context_class( ref $class || $class ) unless $class->context_class;
1855 my $c = $class->context_class->new({});
1857 # For on-demand data
1858 $c->request->_context($c);
1859 $c->response->_context($c);
1861 #surely this is not the most efficient way to do things...
1862 $c->stats($class->stats_class->new)->enable($c->use_stats);
1864 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1867 #XXX reuse coderef from can
1868 # Allow engine to direct the prepare flow (for POE)
1869 if ( $c->engine->can('prepare') ) {
1870 $c->engine->prepare( $c, @arguments );
1873 $c->prepare_request(@arguments);
1874 $c->prepare_connection;
1875 $c->prepare_query_parameters;
1876 $c->prepare_headers;
1877 $c->prepare_cookies;
1880 # Prepare the body for reading, either by prepare_body
1881 # or the user, if they are using $c->read
1884 # Parse the body unless the user wants it on-demand
1885 unless ( $c->config->{parse_on_demand} ) {
1890 my $method = $c->req->method || '';
1891 my $path = $c->req->path;
1892 $path = '/' unless length $path;
1893 my $address = $c->req->address || '';
1895 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1903 =head2 $c->prepare_action
1905 Prepares action. See L<Catalyst::Dispatcher>.
1909 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1911 =head2 $c->prepare_body
1913 Prepares message body.
1920 return if $c->request->_has_body;
1922 # Initialize on-demand data
1923 $c->engine->prepare_body( $c, @_ );
1924 $c->prepare_parameters;
1925 $c->prepare_uploads;
1927 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1928 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1929 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1930 my $param = $c->req->body_parameters->{$key};
1931 my $value = defined($param) ? $param : '';
1933 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1935 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1939 =head2 $c->prepare_body_chunk( $chunk )
1941 Prepares a chunk of data before sending it to L<HTTP::Body>.
1943 See L<Catalyst::Engine>.
1947 sub prepare_body_chunk {
1949 $c->engine->prepare_body_chunk( $c, @_ );
1952 =head2 $c->prepare_body_parameters
1954 Prepares body parameters.
1958 sub prepare_body_parameters {
1960 $c->engine->prepare_body_parameters( $c, @_ );
1963 =head2 $c->prepare_connection
1965 Prepares connection.
1969 sub prepare_connection {
1971 $c->engine->prepare_connection( $c, @_ );
1974 =head2 $c->prepare_cookies
1980 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1982 =head2 $c->prepare_headers
1988 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1990 =head2 $c->prepare_parameters
1992 Prepares parameters.
1996 sub prepare_parameters {
1998 $c->prepare_body_parameters;
1999 $c->engine->prepare_parameters( $c, @_ );
2002 =head2 $c->prepare_path
2004 Prepares path and base.
2008 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2010 =head2 $c->prepare_query_parameters
2012 Prepares query parameters.
2016 sub prepare_query_parameters {
2019 $c->engine->prepare_query_parameters( $c, @_ );
2021 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2022 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2023 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2024 my $param = $c->req->query_parameters->{$key};
2025 my $value = defined($param) ? $param : '';
2027 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2029 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2033 =head2 $c->prepare_read
2035 Prepares the input for reading.
2039 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2041 =head2 $c->prepare_request
2043 Prepares the engine request.
2047 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2049 =head2 $c->prepare_uploads
2055 sub prepare_uploads {
2058 $c->engine->prepare_uploads( $c, @_ );
2060 if ( $c->debug && keys %{ $c->request->uploads } ) {
2061 my $t = Text::SimpleTable->new(
2062 [ 12, 'Parameter' ],
2067 for my $key ( sort keys %{ $c->request->uploads } ) {
2068 my $upload = $c->request->uploads->{$key};
2069 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2070 $t->row( $key, $u->filename, $u->type, $u->size );
2073 $c->log->debug( "File Uploads are:\n" . $t->draw );
2077 =head2 $c->prepare_write
2079 Prepares the output for writing.
2083 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2085 =head2 $c->request_class
2087 Returns or sets the request class.
2089 =head2 $c->response_class
2091 Returns or sets the response class.
2093 =head2 $c->read( [$maxlength] )
2095 Reads a chunk of data from the request body. This method is designed to
2096 be used in a while loop, reading C<$maxlength> bytes on every call.
2097 C<$maxlength> defaults to the size of the request if not specified.
2099 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2102 Warning: If you use read(), Catalyst will not process the body,
2103 so you will not be able to access POST parameters or file uploads via
2104 $c->request. You must handle all body parsing yourself.
2108 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2116 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2118 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2120 Sets an action in a given namespace.
2124 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2126 =head2 $c->setup_actions($component)
2128 Sets up actions for a component.
2132 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2134 =head2 $c->setup_components
2136 This method is called internally to set up the application's components.
2138 It finds modules by calling the L<locate_components> method, expands them to
2139 package names with the L<expand_component_module> method, and then installs
2140 each component into the application.
2142 The C<setup_components> config option is passed to both of the above methods.
2144 Installation of each component is performed by the L<setup_component> method,
2149 sub setup_components {
2152 my $config = $class->config->{ setup_components };
2154 my @comps = sort { length $a <=> length $b }
2155 $class->locate_components($config);
2157 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2158 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2159 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2160 ) if $deprecatedcatalyst_component_names;
2162 for my $component ( @comps ) {
2164 # We pass ignore_loaded here so that overlay files for (e.g.)
2165 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2166 # we know M::P::O found a file on disk so this is safe
2168 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2170 # Needs to be done as soon as the component is loaded, as loading a sub-component
2171 # (next time round the loop) can cause us to get the wrong metaclass..
2172 $class->_controller_init_base_classes($component);
2175 for my $component (uniq map { $class->expand_component_module( $_, $config ) } @comps ) {
2176 $class->_controller_init_base_classes($component); # Also cover inner packages
2177 $class->components->{ $component } = $class->setup_component($component);
2181 =head2 $c->locate_components( $setup_component_config )
2183 This method is meant to provide a list of component modules that should be
2184 setup for the application. By default, it will use L<Module::Pluggable>.
2186 Specify a C<setup_components> config option to pass additional options directly
2187 to L<Module::Pluggable>. To add additional search paths, specify a key named
2188 C<search_extra> as an array reference. Items in the array beginning with C<::>
2189 will have the application class name prepended to them.
2193 sub locate_components {
2197 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2198 my $extra = delete $config->{ search_extra } || [];
2200 push @paths, @$extra;
2202 my $locator = Module::Pluggable::Object->new(
2203 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2207 my @comps = $locator->plugins;
2212 =head2 $c->expand_component_module( $component, $setup_component_config )
2214 Components found by C<locate_components> will be passed to this method, which
2215 is expected to return a list of component (package) names to be set up.
2217 By default, this method will return the component itself as well as any inner
2218 packages found by L<Devel::InnerPackage>.
2222 sub expand_component_module {
2223 my ($class, $module) = @_;
2224 my @inner = Devel::InnerPackage::list_packages( $module );
2225 return ($module, @inner);
2228 =head2 $c->setup_component
2232 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2233 # nearest to Catalyst::Controller first, no matter what order stuff happens
2234 # to be loaded. There are TODO tests in Moose for this, see
2235 # f2391d17574eff81d911b97be15ea51080500003
2236 sub _controller_init_base_classes {
2237 my ($app_class, $component) = @_;
2238 return unless $component->isa('Catalyst::Controller');
2239 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2240 Moose::Meta::Class->initialize( $class )
2241 unless find_meta($class);
2245 sub setup_component {
2246 my( $class, $component ) = @_;
2248 unless ( $component->can( 'COMPONENT' ) ) {
2252 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2253 my $config = $class->config->{ $suffix } || {};
2254 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2255 # methods also pass it. local to avoid pointlessly shitting in config
2256 # for the debug screen, as $component is already the key name.
2257 local $config->{catalyst_component_name} = $component;
2259 my $instance = eval { $component->COMPONENT( $class, $config ); };
2261 if ( my $error = $@ ) {
2263 Catalyst::Exception->throw(
2264 message => qq/Couldn't instantiate component "$component", "$error"/
2268 unless (blessed $instance) {
2269 my $metaclass = Moose::Util::find_meta($component);
2270 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2271 my $component_method_from = $method_meta->associated_metaclass->name;
2272 my $value = defined($instance) ? $instance : 'undef';
2273 Catalyst::Exception->throw(
2275 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2281 =head2 $c->setup_dispatcher
2287 sub setup_dispatcher {
2288 my ( $class, $dispatcher ) = @_;
2291 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2294 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2295 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2298 unless ($dispatcher) {
2299 $dispatcher = $class->dispatcher_class;
2302 Class::MOP::load_class($dispatcher);
2304 # dispatcher instance
2305 $class->dispatcher( $dispatcher->new );
2308 =head2 $c->setup_engine
2315 my ( $class, $engine ) = @_;
2318 $engine = 'Catalyst::Engine::' . $engine;
2321 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2322 $engine = 'Catalyst::Engine::' . $env;
2325 if ( $ENV{MOD_PERL} ) {
2326 my $meta = Class::MOP::get_metaclass_by_name($class);
2328 # create the apache method
2329 $meta->add_method('apache' => sub { shift->engine->apache });
2331 my ( $software, $version ) =
2332 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2335 $version =~ s/(\.[^.]+)\./$1/g;
2337 if ( $software eq 'mod_perl' ) {
2341 if ( $version >= 1.99922 ) {
2342 $engine = 'Catalyst::Engine::Apache2::MP20';
2345 elsif ( $version >= 1.9901 ) {
2346 $engine = 'Catalyst::Engine::Apache2::MP19';
2349 elsif ( $version >= 1.24 ) {
2350 $engine = 'Catalyst::Engine::Apache::MP13';
2354 Catalyst::Exception->throw( message =>
2355 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2360 # install the correct mod_perl handler
2361 if ( $version >= 1.9901 ) {
2362 *handler = sub : method {
2363 shift->handle_request(@_);
2367 *handler = sub ($$) { shift->handle_request(@_) };
2372 elsif ( $software eq 'Zeus-Perl' ) {
2373 $engine = 'Catalyst::Engine::Zeus';
2377 Catalyst::Exception->throw(
2378 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2383 $engine = $class->engine_class;
2386 Class::MOP::load_class($engine);
2388 # check for old engines that are no longer compatible
2390 if ( $engine->isa('Catalyst::Engine::Apache')
2391 && !Catalyst::Engine::Apache->VERSION )
2396 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2397 && Catalyst::Engine::Server->VERSION le '0.02' )
2402 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2403 && $engine->VERSION eq '0.01' )
2408 elsif ($engine->isa('Catalyst::Engine::Zeus')
2409 && $engine->VERSION eq '0.01' )
2415 Catalyst::Exception->throw( message =>
2416 qq/Engine "$engine" is not supported by this version of Catalyst/
2421 $class->engine( $engine->new );
2424 =head2 $c->setup_home
2426 Sets up the home directory.
2431 my ( $class, $home ) = @_;
2433 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2437 $home ||= Catalyst::Utils::home($class);
2440 #I remember recently being scolded for assigning config values like this
2441 $class->config->{home} ||= $home;
2442 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2446 =head2 $c->setup_log
2448 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2449 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2452 This method also installs a C<debug> method that returns a true value into the
2453 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2454 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2456 Note that if the log has already been setup, by either a previous call to
2457 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2458 that this method won't actually set up the log object.
2463 my ( $class, $levels ) = @_;
2466 $levels =~ s/^\s+//;
2467 $levels =~ s/\s+$//;
2468 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2470 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2471 if ( defined $env_debug ) {
2472 $levels{debug} = 1 if $env_debug; # Ugly!
2473 delete($levels{debug}) unless $env_debug;
2476 unless ( $class->log ) {
2477 $class->log( Catalyst::Log->new(keys %levels) );
2480 if ( $levels{debug} ) {
2481 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2482 $class->log->debug('Debug messages enabled');
2486 =head2 $c->setup_plugins
2492 =head2 $c->setup_stats
2494 Sets up timing statistics class.
2499 my ( $class, $stats ) = @_;
2501 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2503 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2504 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2505 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2506 $class->log->debug('Statistics enabled');
2511 =head2 $c->registered_plugins
2513 Returns a sorted list of the plugins which have either been stated in the
2514 import list or which have been added via C<< MyApp->plugin(@args); >>.
2516 If passed a given plugin name, it will report a boolean value indicating
2517 whether or not that plugin is loaded. A fully qualified name is required if
2518 the plugin name does not begin with C<Catalyst::Plugin::>.
2520 if ($c->registered_plugins('Some::Plugin')) {
2528 sub registered_plugins {
2530 return sort keys %{ $proto->_plugins } unless @_;
2532 return 1 if exists $proto->_plugins->{$plugin};
2533 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2536 sub _register_plugin {
2537 my ( $proto, $plugin, $instant ) = @_;
2538 my $class = ref $proto || $proto;
2540 Class::MOP::load_class( $plugin );
2542 $proto->_plugins->{$plugin} = 1;
2545 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2546 my @superclasses = ($plugin, $meta->superclasses );
2547 $meta->superclasses(@superclasses);
2549 unshift @{"$class\::ISA"}, $plugin;
2556 my ( $class, $plugins ) = @_;
2558 $class->_plugins( {} ) unless $class->_plugins;
2561 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2563 for my $plugin ( reverse @plugins ) {
2564 Class::MOP::load_class($plugin);
2565 my $meta = find_meta($plugin);
2566 next if $meta && $meta->isa('Moose::Meta::Role');
2568 $class->_register_plugin($plugin);
2573 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2574 map { find_meta($_) }
2577 Moose::Util::apply_all_roles(
2585 Returns an arrayref of the internal execution stack (actions that are
2586 currently executing).
2588 =head2 $c->stats_class
2590 Returns or sets the stats (timing statistics) class.
2592 =head2 $c->use_stats
2594 Returns 1 when stats collection is enabled. Stats collection is enabled
2595 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2596 environment variable is set.
2598 Note that this is a static method, not an accessor and should be overridden
2599 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2606 =head2 $c->write( $data )
2608 Writes $data to the output stream. When using this method directly, you
2609 will need to manually set the C<Content-Length> header to the length of
2610 your output data, if known.
2617 # Finalize headers if someone manually writes output
2618 $c->finalize_headers;
2620 return $c->engine->write( $c, @_ );
2625 Returns the Catalyst version number. Mostly useful for "powered by"
2626 messages in template systems.
2630 sub version { return $Catalyst::VERSION }
2632 =head1 INTERNAL ACTIONS
2634 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2635 C<_ACTION>, and C<_END>. These are by default not shown in the private
2636 action table, but you can make them visible with a config parameter.
2638 MyApp->config(show_internal_actions => 1);
2640 =head1 CASE SENSITIVITY
2642 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2643 mapped to C</foo/bar>. You can activate case sensitivity with a config
2646 MyApp->config(case_sensitive => 1);
2648 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2650 =head1 ON-DEMAND PARSER
2652 The request body is usually parsed at the beginning of a request,
2653 but if you want to handle input yourself, you can enable on-demand
2654 parsing with a config parameter.
2656 MyApp->config(parse_on_demand => 1);
2658 =head1 PROXY SUPPORT
2660 Many production servers operate using the common double-server approach,
2661 with a lightweight frontend web server passing requests to a larger
2662 backend server. An application running on the backend server must deal
2663 with two problems: the remote user always appears to be C<127.0.0.1> and
2664 the server's hostname will appear to be C<localhost> regardless of the
2665 virtual host that the user connected through.
2667 Catalyst will automatically detect this situation when you are running
2668 the frontend and backend servers on the same machine. The following
2669 changes are made to the request.
2671 $c->req->address is set to the user's real IP address, as read from
2672 the HTTP X-Forwarded-For header.
2674 The host value for $c->req->base and $c->req->uri is set to the real
2675 host, as read from the HTTP X-Forwarded-Host header.
2677 Additionally, you may be running your backend application on an insecure
2678 connection (port 80) while your frontend proxy is running under SSL. If there
2679 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2680 tell Catalyst what port the frontend listens on. This will allow all URIs to
2681 be created properly.
2683 In the case of passing in:
2685 X-Forwarded-Port: 443
2687 All calls to C<uri_for> will result in an https link, as is expected.
2689 Obviously, your web server must support these headers for this to work.
2691 In a more complex server farm environment where you may have your
2692 frontend proxy server(s) on different machines, you will need to set a
2693 configuration option to tell Catalyst to read the proxied data from the
2696 MyApp->config(using_frontend_proxy => 1);
2698 If you do not wish to use the proxy support at all, you may set:
2700 MyApp->config(ignore_frontend_proxy => 1);
2702 =head1 THREAD SAFETY
2704 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2705 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2706 believe the Catalyst core to be thread-safe.
2708 If you plan to operate in a threaded environment, remember that all other
2709 modules you are using must also be thread-safe. Some modules, most notably
2710 L<DBD::SQLite>, are not thread-safe.
2716 Join #catalyst on irc.perl.org.
2720 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2721 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2725 http://catalyst.perl.org
2729 http://dev.catalyst.perl.org
2733 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2735 =head2 L<Catalyst::Manual> - The Catalyst Manual
2737 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2739 =head2 L<Catalyst::Engine> - Core engine
2741 =head2 L<Catalyst::Log> - Log class.
2743 =head2 L<Catalyst::Request> - Request object
2745 =head2 L<Catalyst::Response> - Response object
2747 =head2 L<Catalyst::Test> - The test suite.
2749 =head1 PROJECT FOUNDER
2751 sri: Sebastian Riedel <sri@cpan.org>
2757 acme: Leon Brocard <leon@astray.com>
2765 andyg: Andy Grundman <andy@hybridized.org>
2767 audreyt: Audrey Tang
2769 bricas: Brian Cassidy <bricas@cpan.org>
2771 Caelum: Rafael Kitover <rkitover@io.com>
2773 chansen: Christian Hansen
2775 chicks: Christopher Hicks
2779 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2783 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2785 esskar: Sascha Kiefer
2787 fireartist: Carl Franks <cfranks@cpan.org>
2789 gabb: Danijel Milicevic
2795 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2797 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2799 jcamacho: Juan Camacho
2801 jester: Jesse Sheidlower
2803 jhannah: Jay Hannah <jay@jays.net>
2809 jon: Jon Schutz <jjschutz@cpan.org>
2811 konobi: Scott McWhirter <konobi@cpan.org>
2813 marcus: Marcus Ramberg <mramberg@cpan.org>
2815 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2817 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2821 naughton: David Naughton
2823 ningu: David Kamholz <dkamholz@cpan.org>
2825 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2827 numa: Dan Sully <daniel@cpan.org>
2831 omega: Andreas Marienborg
2833 Oleg Kostyuk <cub.uanic@gmail.com>
2835 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2837 rafl: Florian Ragwitz <rafl@debian.org>
2839 random: Roland Lammel <lammel@cpan.org>
2843 t0m: Tomas Doran <bobtfish@bobtfish.net>
2847 willert: Sebastian Willert <willert@cpan.org>
2851 This library is free software. You can redistribute it and/or modify it under
2852 the same terms as Perl itself.
2858 __PACKAGE__->meta->make_immutable;