4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
19 use Text::SimpleTable ();
20 use Path::Class::Dir ();
21 use Path::Class::File ();
25 use Tree::Simple qw/use_weak_refs/;
26 use Tree::Simple::Visitor::FindByUID;
27 use Class::C3::Adopt::NEXT;
28 use List::MoreUtils qw/uniq/;
31 use Carp qw/croak carp shortmess/;
33 BEGIN { require 5.008004; }
35 has stack => (is => 'ro', default => sub { [] });
36 has stash => (is => 'rw', default => sub { {} });
37 has state => (is => 'rw', default => 0);
38 has stats => (is => 'rw');
39 has action => (is => 'rw');
40 has counter => (is => 'rw', default => sub { {} });
41 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
42 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
43 has namespace => (is => 'rw');
45 sub depth { scalar @{ shift->stack || [] }; }
46 sub comp { shift->component(@_) }
49 my $self = shift; return $self->request(@_);
52 my $self = shift; return $self->response(@_);
55 # For backwards compatibility
56 sub finalize_output { shift->finalize_body(@_) };
61 our $RECURSION = 1000;
62 our $DETACH = Catalyst::Exception::Detach->new;
63 our $GO = Catalyst::Exception::Go->new;
65 #I imagine that very few of these really need to be class variables. if any.
66 #maybe we should just make them attributes with a default?
67 __PACKAGE__->mk_classdata($_)
68 for qw/container arguments dispatcher engine log dispatcher_class
69 engine_class context_class request_class response_class stats_class
72 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
73 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
74 __PACKAGE__->request_class('Catalyst::Request');
75 __PACKAGE__->response_class('Catalyst::Response');
76 __PACKAGE__->stats_class('Catalyst::Stats');
78 # Remember to update this in Catalyst::Runtime as well!
80 our $VERSION = '5.80033';
83 my ( $class, @arguments ) = @_;
85 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
87 return unless $class eq 'Catalyst';
89 my $caller = caller();
90 return if $caller eq 'main';
92 my $meta = Moose::Meta::Class->initialize($caller);
94 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
95 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
96 $meta->superclasses(@superclasses); # XXX - Remove!
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 if ($Moose::VERSION >= 1.15) {
104 $meta->_add_meta_method('meta');
107 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
111 $caller->arguments( [@arguments] );
115 sub MODIFY_CODE_ATTRIBUTES {
116 Catalyst::Exception->throw(
117 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
118 "That has been deprecated and removed. You should create a " .
119 "controller class called Root.pm, and move relevant code to that class."
124 sub _application { $_[0] }
128 Catalyst - The Elegant MVC Web Application Framework
132 See the L<Catalyst::Manual> distribution for comprehensive
133 documentation and tutorials.
135 # Install Catalyst::Devel for helpers and other development tools
136 # use the helper to create a new application
139 # add models, views, controllers
140 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
141 script/myapp_create.pl view MyTemplate TT
142 script/myapp_create.pl controller Search
144 # built in testserver -- use -r to restart automatically on changes
145 # --help to see all available options
146 script/myapp_server.pl
148 # command line testing interface
149 script/myapp_test.pl /yada
152 use Catalyst qw/-Debug/; # include plugins here as well
154 ### In lib/MyApp/Controller/Root.pm (autocreated)
155 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
156 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
157 $c->stash->{template} = 'foo.tt'; # set the template
158 # lookup something from db -- stash vars are passed to TT
160 $c->model('Database::Foo')->search( { country => $args[0] } );
161 if ( $c->req->params->{bar} ) { # access GET or POST parameters
162 $c->forward( 'bar' ); # process another action
163 # do something else after forward returns
167 # The foo.tt TT template can use the stash data from the database
168 [% WHILE (item = data.next) %]
172 # called for /bar/of/soap, /bar/of/soap/10, etc.
173 sub bar : Path('/bar/of/soap') { ... }
175 # called for all actions, from the top-most controller downwards
177 my ( $self, $c ) = @_;
178 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
179 $c->res->redirect( '/login' ); # require login
180 return 0; # abort request and go immediately to end()
182 return 1; # success; carry on to next action
185 # called after all actions are finished
187 my ( $self, $c ) = @_;
188 if ( scalar @{ $c->error } ) { ... } # handle errors
189 return if $c->res->body; # already have a response
190 $c->forward( 'MyApp::View::TT' ); # render template
193 ### in MyApp/Controller/Foo.pm
194 # called for /foo/bar
195 sub bar : Local { ... }
197 # called for /blargle
198 sub blargle : Global { ... }
200 # an index action matches /foo, but not /foo/1, etc.
201 sub index : Private { ... }
203 ### in MyApp/Controller/Foo/Bar.pm
204 # called for /foo/bar/baz
205 sub baz : Local { ... }
207 # first Root auto is called, then Foo auto, then this
208 sub auto : Private { ... }
210 # powerful regular expression paths are also possible
211 sub details : Regex('^product/(\w+)/details$') {
212 my ( $self, $c ) = @_;
213 # extract the (\w+) from the URI
214 my $product = $c->req->captures->[0];
217 See L<Catalyst::Manual::Intro> for additional information.
221 Catalyst is a modern framework for making web applications without the
222 pain usually associated with this process. This document is a reference
223 to the main Catalyst application. If you are a new user, we suggest you
224 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
226 See L<Catalyst::Manual> for more documentation.
228 Catalyst plugins can be loaded by naming them as arguments to the "use
229 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
230 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
233 use Catalyst qw/My::Module/;
235 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
236 fully qualify the name by using a unary plus:
240 +Fully::Qualified::Plugin::Name
243 Special flags like C<-Debug> and C<-Engine> can also be specified as
244 arguments when Catalyst is loaded:
246 use Catalyst qw/-Debug My::Module/;
248 The position of plugins and flags in the chain is important, because
249 they are loaded in the order in which they appear.
251 The following flags are supported:
255 Enables debug output. You can also force this setting from the system
256 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
257 settings override the application, with <MYAPP>_DEBUG having the highest
260 This sets the log level to 'debug' and enables full debug output on the
261 error screen. If you only want the latter, see L<< $c->debug >>.
265 Forces Catalyst to use a specific engine. Omit the
266 C<Catalyst::Engine::> prefix of the engine name, i.e.:
268 use Catalyst qw/-Engine=CGI/;
272 Forces Catalyst to use a specific home directory, e.g.:
274 use Catalyst qw[-Home=/usr/mst];
276 This can also be done in the shell environment by setting either the
277 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
278 is replaced with the uppercased name of your application, any "::" in
279 the name will be replaced with underscores, e.g. MyApp::Web should use
280 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
282 If none of these are set, Catalyst will attempt to automatically detect the
283 home directory. If you are working in a development envirnoment, Catalyst
284 will try and find the directory containing either Makefile.PL, Build.PL or
285 dist.ini. If the application has been installed into the system (i.e.
286 you have done C<make install>), then Catalyst will use the path to your
287 application module, without the .pm extension (ie, /foo/MyApp if your
288 application was installed at /foo/MyApp.pm)
292 use Catalyst '-Log=warn,fatal,error';
294 Specifies a comma-delimited list of log levels.
298 Enables statistics collection and reporting.
300 use Catalyst qw/-Stats=1/;
302 You can also force this setting from the system environment with CATALYST_STATS
303 or <MYAPP>_STATS. The environment settings override the application, with
304 <MYAPP>_STATS having the highest priority.
306 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
310 =head2 INFORMATION ABOUT THE CURRENT REQUEST
314 Returns a L<Catalyst::Action> object for the current action, which
315 stringifies to the action name. See L<Catalyst::Action>.
319 Returns the namespace of the current action, i.e., the URI prefix
320 corresponding to the controller of the current action. For example:
322 # in Controller::Foo::Bar
323 $c->namespace; # returns 'foo/bar';
329 Returns the current L<Catalyst::Request> object, giving access to
330 information about the current client request (including parameters,
331 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
333 =head2 REQUEST FLOW HANDLING
335 =head2 $c->forward( $action [, \@arguments ] )
337 =head2 $c->forward( $class, $method, [, \@arguments ] )
339 Forwards processing to another action, by its private name. If you give a
340 class name but no method, C<process()> is called. You may also optionally
341 pass arguments in an arrayref. The action will receive the arguments in
342 C<@_> and C<< $c->req->args >>. Upon returning from the function,
343 C<< $c->req->args >> will be restored to the previous values.
345 Any data C<return>ed from the action forwarded to, will be returned by the
348 my $foodata = $c->forward('/foo');
349 $c->forward('index');
350 $c->forward(qw/Model::DBIC::Foo do_stuff/);
351 $c->forward('View::TT');
353 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
354 an C<< eval { } >> around the call (actually
355 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
356 all 'dies' within the called action. If you want C<die> to propagate you
357 need to do something like:
360 die join "\n", @{ $c->error } if @{ $c->error };
362 Or make sure to always return true values from your actions and write
365 $c->forward('foo') || return;
367 Another note is that C<< $c->forward >> always returns a scalar because it
368 actually returns $c->state which operates in a scalar context.
369 Thus, something like:
373 in an action that is forwarded to is going to return a scalar,
374 i.e. how many items are in that array, which is probably not what you want.
375 If you need to return an array then return a reference to it,
378 $c->stash->{array} = \@array;
380 and access it from the stash.
382 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
386 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
388 =head2 $c->detach( $action [, \@arguments ] )
390 =head2 $c->detach( $class, $method, [, \@arguments ] )
394 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
395 doesn't return to the previous action when processing is finished.
397 When called with no arguments it escapes the processing chain entirely.
401 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
403 =head2 $c->visit( $action [, \@captures, \@arguments ] )
405 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
407 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
408 but does a full dispatch, instead of just calling the new C<$action> /
409 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
410 you go to are called, just like a new request.
412 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
413 This means, for example, that C<< $c->action >> methods such as
414 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
415 L<reverse|Catalyst::Action/reverse> return information for the visited action
416 when they are invoked within the visited action. This is different from the
417 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
418 continues to use the $c->action object from the caller action even when
419 invoked from the callee.
421 C<< $c->stash >> is kept unchanged.
423 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
424 allows you to "wrap" another action, just as it would have been called by
425 dispatching from a URL, while the analogous
426 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
427 transfer control to another action as if it had been reached directly from a URL.
431 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
433 =head2 $c->go( $action [, \@captures, \@arguments ] )
435 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
437 The relationship between C<go> and
438 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
439 the relationship between
440 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
441 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
442 C<< $c->go >> will perform a full dispatch on the specified action or method,
443 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
444 C<go> escapes the processing of the current request chain on completion, and
445 does not return to its caller.
447 @arguments are arguments to the final destination of $action. @captures are
448 arguments to the intermediate steps, if any, on the way to the final sub of
453 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
459 Returns the current L<Catalyst::Response> object, see there for details.
463 Returns a hashref to the stash, which may be used to store data and pass
464 it between components during a request. You can also set hash keys by
465 passing arguments. The stash is automatically sent to the view. The
466 stash is cleared at the end of a request; it cannot be used for
467 persistent storage (for this you must use a session; see
468 L<Catalyst::Plugin::Session> for a complete system integrated with
471 $c->stash->{foo} = $bar;
472 $c->stash( { moose => 'majestic', qux => 0 } );
473 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
475 # stash is automatically passed to the view for use in a template
476 $c->forward( 'MyApp::View::TT' );
480 around stash => sub {
483 my $stash = $orig->($c);
485 my $new_stash = @_ > 1 ? {@_} : $_[0];
486 croak('stash takes a hash or hashref') unless ref $new_stash;
487 foreach my $key ( keys %$new_stash ) {
488 $stash->{$key} = $new_stash->{$key};
498 =head2 $c->error($error, ...)
500 =head2 $c->error($arrayref)
502 Returns an arrayref containing error messages. If Catalyst encounters an
503 error while processing a request, it stores the error in $c->error. This
504 method should only be used to store fatal error messages.
506 my @error = @{ $c->error };
510 $c->error('Something bad happened');
517 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
518 croak @$error unless ref $c;
519 push @{ $c->{error} }, @$error;
521 elsif ( defined $_[0] ) { $c->{error} = undef }
522 return $c->{error} || [];
528 Contains the return value of the last executed action.
529 Note that << $c->state >> operates in a scalar context which means that all
530 values it returns are scalar.
532 =head2 $c->clear_errors
534 Clear errors. You probably don't want to clear the errors unless you are
535 implementing a custom error screen.
537 This is equivalent to running
548 =head2 COMPONENT ACCESSORS
550 =head2 $c->controller($name)
552 Gets a L<Catalyst::Controller> instance by name.
554 $c->controller('Foo')->do_stuff;
556 If the name is omitted, will return the controller for the dispatched
559 If you want to search for controllers, pass in a regexp as the argument.
561 # find all controllers that start with Foo
562 my @foo_controllers = $c->controller(qr{^Foo});
568 my ( $c, $name, @args ) = @_;
570 $name ||= Catalyst::Utils::class2classshortsuffix( $c->action->class );
572 return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
575 =head2 $c->model($name)
577 Gets a L<Catalyst::Model> instance by name.
579 $c->model('Foo')->do_stuff;
581 Any extra arguments are directly passed to ACCEPT_CONTEXT.
583 If the name is omitted, it will look for
584 - a model object in $c->stash->{current_model_instance}, then
585 - a model name in $c->stash->{current_model}, then
586 - a config setting 'default_model', or
587 - check if there is only one model, and return it if that's the case.
589 If you want to search for models, pass in a regexp as the argument.
591 # find all models that start with Foo
592 my @foo_models = $c->model(qr{^Foo});
597 my ( $c, $name, @args ) = @_;
599 if (ref $c && !$name) {
600 return $current_instance
601 if my $current_instance = $c->stash->{current_model_instance};
603 $name = $c->stash->{current_model};
606 return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
610 =head2 $c->view($name)
612 Gets a L<Catalyst::View> instance by name.
614 $c->view('Foo')->do_stuff;
616 Any extra arguments are directly passed to ACCEPT_CONTEXT.
618 If the name is omitted, it will look for
619 - a view object in $c->stash->{current_view_instance}, then
620 - a view name in $c->stash->{current_view}, then
621 - a config setting 'default_view', or
622 - check if there is only one view, and return it if that's the case.
624 If you want to search for views, pass in a regexp as the argument.
626 # find all views that start with Foo
627 my @foo_views = $c->view(qr{^Foo});
632 my ( $c, $name, @args ) = @_;
634 if (ref $c && !$name) {
635 return $current_instance
636 if my $current_instance = $c->stash->{current_view_instance};
638 $name = $c->stash->{current_view};
641 return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
644 =head2 $c->controllers
646 Returns the available names which can be passed to $c->controller
652 return $c->container->get_sub_container('controller')->get_service_list;
657 Returns the available names which can be passed to $c->model
663 return $c->container->get_sub_container('model')->get_service_list;
669 Returns the available names which can be passed to $c->view
675 return $c->container->get_sub_container('view')->get_service_list;
678 =head2 $c->comp($name)
680 =head2 $c->component($name)
682 Gets a component object by name. This method is not recommended,
683 unless you want to get a specific component by full
684 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
685 should be used instead.
687 If C<$name> is a regexp, a list of components matched against the full
688 component name will be returned.
693 my ( $c, $component, @args ) = @_;
695 unless ($component) {
696 $c->log->warn('Calling $c->component with no args is deprecated and ');
697 $c->log->warn('will be removed in a future release.');
698 $c->log->warn('Use $c->component_list instead.');
699 return $c->component_list;
702 my @result = $c->container->find_component( $component, $c, @args );
704 # list context for regexp searches
705 return @result if ref $component;
707 # only one component (if it's found) for string searches
708 return shift @result if @result;
710 if (ref $c eq $component) {
711 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
712 $c->log->warn('deprecated, and will be removed in a future release.');
716 $c->log->warn("Looking for '$component', but nothing was found.");
718 # I would expect to return an empty list here, but that breaks back-compat
719 $c->log->warn('Component not found, returning the list of existing');
720 $c->log->warn('components. This behavior is deprecated and will be');
721 $c->log->warn('removed in a future release. Use $c->component_list');
722 $c->log->warn('instead.');
724 return $c->component_list;
727 =head2 $c->component_list
729 Returns the sorted list of the component names of the application.
733 sub component_list { sort keys %{ shift->components } }
735 =head2 CLASS DATA AND HELPER CLASSES
739 Returns or takes a hashref containing the application's configuration.
741 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
743 You can also use a C<YAML>, C<XML> or L<Config::General> config file
744 like C<myapp.conf> in your applications home directory. See
745 L<Catalyst::Plugin::ConfigLoader>.
747 =head3 Cascading configuration
749 The config method is present on all Catalyst components, and configuration
750 will be merged when an application is started. Configuration loaded with
751 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
752 followed by configuration in your top level C<MyApp> class. These two
753 configurations are merged, and then configuration data whose hash key matches a
754 component name is merged with configuration for that component.
756 The configuration for a component is then passed to the C<new> method when a
757 component is constructed.
761 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
762 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
764 will mean that C<MyApp::Model::Foo> receives the following data when
767 MyApp::Model::Foo->new({
773 It's common practice to use a Moose attribute
774 on the receiving component to access the config value.
776 package MyApp::Model::Foo;
780 # this attr will receive 'baz' at construction time
786 You can then get the value 'baz' by calling $c->model('Foo')->bar
787 (or $self->bar inside code in the model).
789 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
790 as a way of reading config within your code, as this B<will not> give you the
791 correctly merged config back. You B<MUST> take the config values supplied to
792 the constructor and use those instead.
796 around config => sub {
800 croak('Setting config after setup has been run is not allowed.')
801 if ( @_ and $c->setup_finished );
808 Returns the logging object instance. Unless it is already set, Catalyst
809 sets this up with a L<Catalyst::Log> object. To use your own log class,
810 set the logger with the C<< __PACKAGE__->log >> method prior to calling
811 C<< __PACKAGE__->setup >>.
813 __PACKAGE__->log( MyLogger->new );
818 $c->log->info( 'Now logging with my own logger!' );
820 Your log class should implement the methods described in
826 Returns 1 if debug mode is enabled, 0 otherwise.
828 You can enable debug mode in several ways:
832 =item By calling myapp_server.pl with the -d flag
834 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
836 =item The -Debug option in your MyApp.pm
838 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
842 The first three also set the log level to 'debug'.
844 Calling C<< $c->debug(1) >> has no effect.
850 =head2 $c->dispatcher
852 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
856 Returns the engine instance. See L<Catalyst::Engine>.
859 =head2 UTILITY METHODS
861 =head2 $c->path_to(@path)
863 Merges C<@path> with C<< $c->config->{home} >> and returns a
864 L<Path::Class::Dir> object. Note you can usually use this object as
865 a filename, but sometimes you will have to explicitly stringify it
866 yourself by calling the C<< ->stringify >> method.
870 $c->path_to( 'db', 'sqlite.db' );
875 my ( $c, @path ) = @_;
876 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
877 if ( -d $path ) { return $path }
878 else { return Path::Class::File->new( $c->config->{home}, @path ) }
881 =head2 $c->plugin( $name, $class, @args )
883 Helper method for plugins. It creates a class data accessor/mutator and
884 loads and instantiates the given class.
886 MyApp->plugin( 'prototype', 'HTML::Prototype' );
888 $c->prototype->define_javascript_functions;
890 B<Note:> This method of adding plugins is deprecated. The ability
891 to add plugins like this B<will be removed> in a Catalyst 5.81.
892 Please do not use this functionality in new code.
897 my ( $class, $name, $plugin, @args ) = @_;
899 # See block comment in t/aggregate/unit_core_plugin.t
900 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
902 $class->_register_plugin( $plugin, 1 );
904 eval { $plugin->import };
905 $class->mk_classdata($name);
907 eval { $obj = $plugin->new(@args) };
910 Catalyst::Exception->throw( message =>
911 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
915 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
921 Initializes the dispatcher and engine, loads any plugins, and loads the
922 model, view, and controller components. You may also specify an array
923 of plugins to load here, if you choose to not load them in the C<use
927 MyApp->setup( qw/-Debug/ );
932 my ( $class, @arguments ) = @_;
933 croak('Running setup more than once')
934 if ( $class->setup_finished );
936 unless ( $class->isa('Catalyst') ) {
938 Catalyst::Exception->throw(
939 message => qq/'$class' does not inherit from Catalyst/ );
942 if ( $class->arguments ) {
943 @arguments = ( @arguments, @{ $class->arguments } );
949 foreach (@arguments) {
953 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
955 elsif (/^-(\w+)=?(.*)$/) {
956 $flags->{ lc $1 } = $2;
959 push @{ $flags->{plugins} }, $_;
963 $class->setup_config();
964 $class->setup_home( delete $flags->{home} );
966 $class->setup_log( delete $flags->{log} );
967 $class->setup_plugins( delete $flags->{plugins} );
968 $class->setup_dispatcher( delete $flags->{dispatcher} );
969 $class->setup_engine( delete $flags->{engine} );
970 $class->setup_stats( delete $flags->{stats} );
972 for my $flag ( sort keys %{$flags} ) {
974 if ( my $code = $class->can( 'setup_' . $flag ) ) {
975 &$code( $class, delete $flags->{$flag} );
978 $class->log->warn(qq/Unknown flag "$flag"/);
982 eval { require Catalyst::Devel; };
983 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
984 $class->log->warn(<<"EOF");
985 You are running an old script!
987 Please update by running (this will overwrite existing files):
988 catalyst.pl -force -scripts $class
990 or (this will not overwrite existing files):
991 catalyst.pl -scripts $class
996 if ( $class->debug ) {
997 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1000 my $column_width = Catalyst::Utils::term_width() - 6;
1001 my $t = Text::SimpleTable->new($column_width);
1002 $t->row($_) for @plugins;
1003 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1006 my $dispatcher = $class->dispatcher;
1007 my $engine = $class->engine;
1008 my $home = $class->config->{home};
1010 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1011 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1015 ? $class->log->debug(qq/Found home "$home"/)
1016 : $class->log->debug(qq/Home "$home" doesn't exist/)
1017 : $class->log->debug(q/Couldn't find home/);
1020 # Call plugins setup, this is stupid and evil.
1021 # Also screws C3 badly on 5.10, hack to avoid.
1023 no warnings qw/redefine/;
1024 local *setup = sub { };
1025 $class->setup unless $Catalyst::__AM_RESTARTING;
1028 $class->setup_components;
1032 my @comps_types = $class->container->get_components_types
1034 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1035 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1036 $t->row( @$_ ) for @comps_types;
1038 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1041 $class->setup_actions;
1043 if ( $class->debug ) {
1044 my $name = $class->config->{name} || 'Application';
1045 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1048 # Make sure that the application class becomes immutable at this point,
1049 B::Hooks::EndOfScope::on_scope_end {
1051 my $meta = Class::MOP::get_metaclass_by_name($class);
1054 && ! { $meta->immutable_options }->{replace_constructor}
1056 $class->isa('Class::Accessor::Fast')
1057 || $class->isa('Class::Accessor')
1060 warn "You made your application class ($class) immutable, "
1061 . "but did not inline the\nconstructor. "
1062 . "This will break catalyst, as your app \@ISA "
1063 . "Class::Accessor(::Fast)?\nPlease pass "
1064 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1066 $meta->make_immutable(
1067 replace_constructor => 1,
1068 ) unless $meta->is_immutable;
1071 if ($class->config->{case_sensitive}) {
1072 $class->log->warn($class . "->config->{case_sensitive} is set.");
1073 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1076 $class->setup_finalize;
1077 # Should be the last thing we do so that user things hooking
1078 # setup_finalize can log..
1079 $class->log->_flush() if $class->log->can('_flush');
1080 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1083 =head2 $app->setup_finalize
1085 A hook to attach modifiers to. This method does not do anything except set the
1086 C<setup_finished> accessor.
1088 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1092 after setup_finalize => sub {
1100 sub setup_finalize {
1102 $class->setup_finished(1);
1105 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1107 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1109 Constructs an absolute L<URI> object based on the application root, the
1110 provided path, and the additional arguments and query parameters provided.
1111 When used as a string, provides a textual URI. If you need more flexibility
1112 than this (i.e. the option to provide relative URIs etc.) see
1113 L<Catalyst::Plugin::SmartURI>.
1115 If no arguments are provided, the URI for the current action is returned.
1116 To return the current action and also provide @args, use
1117 C<< $c->uri_for( $c->action, @args ) >>.
1119 If the first argument is a string, it is taken as a public URI path relative
1120 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1121 relative to the application root (if it does). It is then merged with
1122 C<< $c->request->base >>; any C<@args> are appended as additional path
1123 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1125 If the first argument is a L<Catalyst::Action> it represents an action which
1126 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1127 optional C<\@captures> argument (an arrayref) allows passing the captured
1128 variables that are needed to fill in the paths of Chained and Regex actions;
1129 once the path is resolved, C<uri_for> continues as though a path was
1130 provided, appending any arguments or parameters and creating an absolute
1133 The captures for the current request can be found in
1134 C<< $c->request->captures >>, and actions can be resolved using
1135 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1136 path, use C<< $c->uri_for_action >> instead.
1138 # Equivalent to $c->req->uri
1139 $c->uri_for($c->action, $c->req->captures,
1140 @{ $c->req->args }, $c->req->params);
1142 # For the Foo action in the Bar controller
1143 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1145 # Path to a static resource
1146 $c->uri_for('/static/images/logo.png');
1151 my ( $c, $path, @args ) = @_;
1153 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1154 $path = $path->path_prefix;
1159 undef($path) if (defined $path && $path eq '');
1162 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1164 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1165 foreach my $arg (@args) {
1166 utf8::encode($arg) if utf8::is_utf8($arg);
1167 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1170 if ( blessed($path) ) { # action object
1171 s|/|%2F|g for @args;
1172 my $captures = [ map { s|/|%2F|g; $_; }
1173 ( scalar @args && ref $args[0] eq 'ARRAY'
1177 foreach my $capture (@$captures) {
1178 utf8::encode($capture) if utf8::is_utf8($capture);
1179 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1183 $path = $c->dispatcher->uri_for_action($action, $captures);
1184 if (not defined $path) {
1185 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1189 $path = '/' if $path eq '';
1192 unshift(@args, $path);
1194 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1195 my $namespace = $c->namespace;
1196 if (defined $path) { # cheesy hack to handle path '../foo'
1197 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1199 unshift(@args, $namespace || '');
1202 # join args with '/', or a blank string
1203 my $args = join('/', grep { defined($_) } @args);
1204 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1206 my $base = $c->req->base;
1207 my $class = ref($base);
1208 $base =~ s{(?<!/)$}{/};
1212 if (my @keys = keys %$params) {
1213 # somewhat lifted from URI::_query's query_form
1214 $query = '?'.join('&', map {
1215 my $val = $params->{$_};
1216 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1219 $val = '' unless defined $val;
1222 utf8::encode( $param ) if utf8::is_utf8($param);
1223 # using the URI::Escape pattern here so utf8 chars survive
1224 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1226 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1230 my $res = bless(\"${base}${args}${query}", $class);
1234 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1236 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1242 A private path to the Catalyst action you want to create a URI for.
1244 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1245 >> and passing the resulting C<$action> and the remaining arguments to C<<
1248 You can also pass in a Catalyst::Action object, in which case it is passed to
1251 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
1253 For example, if the action looks like:
1255 package MyApp::Controller::Users;
1257 sub lst : Path('the-list') {}
1261 $c->uri_for_action('/users/lst')
1263 and it will create the URI /users/the-list.
1269 sub uri_for_action {
1270 my ( $c, $path, @args ) = @_;
1271 my $action = blessed($path)
1273 : $c->dispatcher->get_action_by_path($path);
1274 unless (defined $action) {
1275 croak "Can't find action for path '$path'";
1277 return $c->uri_for( $action, @args );
1280 =head2 $c->welcome_message
1282 Returns the Catalyst welcome HTML page.
1286 sub welcome_message {
1288 my $name = $c->config->{name};
1289 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1290 my $prefix = Catalyst::Utils::appprefix( ref $c );
1291 $c->response->content_type('text/html; charset=utf-8');
1293 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1294 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1295 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1297 <meta http-equiv="Content-Language" content="en" />
1298 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1299 <title>$name on Catalyst $VERSION</title>
1300 <style type="text/css">
1303 background-color: #eee;
1310 margin-bottom: 10px;
1312 background-color: #ccc;
1313 border: 1px solid #aaa;
1318 font-family: verdana, tahoma, sans-serif;
1321 font-family: verdana, tahoma, sans-serif;
1324 text-decoration: none;
1326 border-bottom: 1px dotted #bbb;
1328 :link:hover, :visited:hover {
1341 background-color: #fff;
1342 border: 1px solid #aaa;
1346 font-weight: normal;
1368 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1373 <img src="$logo" alt="Catalyst Logo" />
1375 <p>Welcome to the world of Catalyst.
1376 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1377 framework will make web development something you had
1378 never expected it to be: Fun, rewarding, and quick.</p>
1379 <h2>What to do now?</h2>
1380 <p>That really depends on what <b>you</b> want to do.
1381 We do, however, provide you with a few starting points.</p>
1382 <p>If you want to jump right into web development with Catalyst
1383 you might want to start with a tutorial.</p>
1384 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1386 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1388 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1389 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1391 <h2>What to do next?</h2>
1392 <p>Next it's time to write an actual application. Use the
1393 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1394 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1395 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1396 they can save you a lot of work.</p>
1397 <pre><code>script/${prefix}_create.pl --help</code></pre>
1398 <p>Also, be sure to check out the vast and growing
1399 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1400 you are likely to find what you need there.
1404 <p>Catalyst has a very active community. Here are the main places to
1405 get in touch with us.</p>
1408 <a href="http://dev.catalyst.perl.org">Wiki</a>
1411 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1414 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1417 <h2>In conclusion</h2>
1418 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1419 as we enjoyed making it. Please contact us if you have ideas
1420 for improvement or other feedback.</p>
1428 =head1 INTERNAL METHODS
1430 These methods are not meant to be used by end users.
1432 =head2 $c->components
1434 Returns a hash of components.
1439 my ( $class, $comps ) = @_;
1441 # people create components calling this sub directly, before setup
1442 $class->setup_config unless $class->container;
1444 my $container = $class->container;
1447 $container->add_component(
1452 return $container->get_all_components();
1455 =head2 $c->context_class
1457 Returns or sets the context class.
1461 Returns a hashref containing coderefs and execution counts (needed for
1462 deep recursion detection).
1466 Returns the number of actions on the current internal execution stack.
1470 Dispatches a request to actions.
1474 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1476 =head2 $c->dispatcher_class
1478 Returns or sets the dispatcher class.
1480 =head2 $c->dump_these
1482 Returns a list of 2-element array references (name, structure) pairs
1483 that will be dumped on the error page in debug mode.
1489 [ Request => $c->req ],
1490 [ Response => $c->res ],
1491 [ Stash => $c->stash ],
1492 [ Config => $c->config ];
1495 =head2 $c->engine_class
1497 Returns or sets the engine class.
1499 =head2 $c->execute( $class, $coderef )
1501 Execute a coderef in given class and catch exceptions. Errors are available
1507 my ( $c, $class, $code ) = @_;
1508 $class = $c->component($class) || $class;
1511 if ( $c->depth >= $RECURSION ) {
1512 my $action = $code->reverse();
1513 $action = "/$action" unless $action =~ /->/;
1514 my $error = qq/Deep recursion detected calling "${action}"/;
1515 $c->log->error($error);
1521 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1523 push( @{ $c->stack }, $code );
1525 no warnings 'recursion';
1526 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1527 # I have no idea how, ergo $ret (which appears to fix the issue)
1528 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1530 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1532 my $last = pop( @{ $c->stack } );
1534 if ( my $error = $@ ) {
1535 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1536 $error->rethrow if $c->depth > 1;
1538 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1539 $error->rethrow if $c->depth > 0;
1542 unless ( ref $error ) {
1543 no warnings 'uninitialized';
1545 my $class = $last->class;
1546 my $name = $last->name;
1547 $error = qq/Caught exception in $class->$name "$error"/;
1556 sub _stats_start_execute {
1557 my ( $c, $code ) = @_;
1558 my $appclass = ref($c) || $c;
1559 return if ( ( $code->name =~ /^_.*/ )
1560 && ( !$appclass->config->{show_internal_actions} ) );
1562 my $action_name = $code->reverse();
1563 $c->counter->{$action_name}++;
1565 my $action = $action_name;
1566 $action = "/$action" unless $action =~ /->/;
1568 # determine if the call was the result of a forward
1569 # this is done by walking up the call stack and looking for a calling
1570 # sub of Catalyst::forward before the eval
1572 for my $index ( 2 .. 11 ) {
1574 if ( ( caller($index) )[0] eq 'Catalyst'
1575 && ( caller($index) )[3] eq '(eval)' );
1577 if ( ( caller($index) )[3] =~ /forward$/ ) {
1578 $callsub = ( caller($index) )[3];
1579 $action = "-> $action";
1584 my $uid = $action_name . $c->counter->{$action_name};
1586 # is this a root-level call or a forwarded call?
1587 if ( $callsub =~ /forward$/ ) {
1588 my $parent = $c->stack->[-1];
1590 # forward, locate the caller
1591 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1594 parent => "$parent" . $c->counter->{"$parent"},
1600 # forward with no caller may come from a plugin
1619 sub _stats_finish_execute {
1620 my ( $c, $info ) = @_;
1621 $c->stats->profile( end => $info );
1626 Finalizes the request.
1633 for my $error ( @{ $c->error } ) {
1634 $c->log->error($error);
1637 # Allow engine to handle finalize flow (for POE)
1638 my $engine = $c->engine;
1639 if ( my $code = $engine->can('finalize') ) {
1644 $c->finalize_uploads;
1647 if ( $#{ $c->error } >= 0 ) {
1651 $c->finalize_headers;
1654 if ( $c->request->method eq 'HEAD' ) {
1655 $c->response->body('');
1663 if ($c->use_stats) {
1664 my $elapsed = sprintf '%f', $c->stats->elapsed;
1665 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1667 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1670 return $c->response->status;
1673 =head2 $c->finalize_body
1679 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1681 =head2 $c->finalize_cookies
1687 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1689 =head2 $c->finalize_error
1695 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1697 =head2 $c->finalize_headers
1703 sub finalize_headers {
1706 my $response = $c->response; #accessor calls can add up?
1708 # Check if we already finalized headers
1709 return if $response->finalized_headers;
1712 if ( my $location = $response->redirect ) {
1713 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1714 $response->header( Location => $location );
1716 if ( !$response->has_body ) {
1717 # Add a default body if none is already present
1719 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1725 if ( defined $response->body && length $response->body && !$response->content_length ) {
1727 # get the length from a filehandle
1728 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1730 my $stat = stat $response->body;
1731 if ( $stat && $stat->size > 0 ) {
1732 $response->content_length( $stat->size );
1735 $c->log->warn('Serving filehandle without a content-length');
1739 # everything should be bytes at this point, but just in case
1740 $response->content_length( length( $response->body ) );
1745 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1746 $response->headers->remove_header("Content-Length");
1747 $response->body('');
1750 $c->finalize_cookies;
1752 $c->engine->finalize_headers( $c, @_ );
1755 $response->finalized_headers(1);
1758 =head2 $c->finalize_output
1760 An alias for finalize_body.
1762 =head2 $c->finalize_read
1764 Finalizes the input after reading is complete.
1768 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1770 =head2 $c->finalize_uploads
1772 Finalizes uploads. Cleans up any temporary files.
1776 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1778 =head2 $c->get_action( $action, $namespace )
1780 Gets an action in a given namespace.
1784 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1786 =head2 $c->get_actions( $action, $namespace )
1788 Gets all actions of a given name in a namespace and all parent
1793 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1795 =head2 $app->handle_request( @arguments )
1797 Called to handle each HTTP request.
1801 sub handle_request {
1802 my ( $class, @arguments ) = @_;
1804 # Always expect worst case!
1807 if ($class->debug) {
1808 my $secs = time - $START || 1;
1809 my $av = sprintf '%.3f', $COUNT / $secs;
1810 my $time = localtime time;
1811 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1814 my $c = $class->prepare(@arguments);
1816 $status = $c->finalize;
1819 if ( my $error = $@ ) {
1821 $class->log->error(qq/Caught exception in engine "$error"/);
1826 if(my $coderef = $class->log->can('_flush')){
1827 $class->log->$coderef();
1832 =head2 $c->prepare( @arguments )
1834 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1840 my ( $class, @arguments ) = @_;
1843 # After the app/ctxt split, this should become an attribute based on something passed
1844 # into the application.
1845 $class->context_class( ref $class || $class ) unless $class->context_class;
1847 my $c = $class->context_class->new({});
1849 # For on-demand data
1850 $c->request->_context($c);
1851 $c->response->_context($c);
1853 #surely this is not the most efficient way to do things...
1854 $c->stats($class->stats_class->new)->enable($c->use_stats);
1855 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1856 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1859 #XXX reuse coderef from can
1860 # Allow engine to direct the prepare flow (for POE)
1861 if ( $c->engine->can('prepare') ) {
1862 $c->engine->prepare( $c, @arguments );
1865 $c->prepare_request(@arguments);
1866 $c->prepare_connection;
1867 $c->prepare_query_parameters;
1868 $c->prepare_headers;
1869 $c->prepare_cookies;
1872 # Prepare the body for reading, either by prepare_body
1873 # or the user, if they are using $c->read
1876 # Parse the body unless the user wants it on-demand
1877 unless ( ref($c)->config->{parse_on_demand} ) {
1882 my $method = $c->req->method || '';
1883 my $path = $c->req->path;
1884 $path = '/' unless length $path;
1885 my $address = $c->req->address || '';
1894 =head2 $c->prepare_action
1896 Prepares action. See L<Catalyst::Dispatcher>.
1900 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1902 =head2 $c->prepare_body
1904 Prepares message body.
1911 return if $c->request->_has_body;
1913 # Initialize on-demand data
1914 $c->engine->prepare_body( $c, @_ );
1915 $c->prepare_parameters;
1916 $c->prepare_uploads;
1919 =head2 $c->prepare_body_chunk( $chunk )
1921 Prepares a chunk of data before sending it to L<HTTP::Body>.
1923 See L<Catalyst::Engine>.
1927 sub prepare_body_chunk {
1929 $c->engine->prepare_body_chunk( $c, @_ );
1932 =head2 $c->prepare_body_parameters
1934 Prepares body parameters.
1938 sub prepare_body_parameters {
1940 $c->engine->prepare_body_parameters( $c, @_ );
1943 =head2 $c->prepare_connection
1945 Prepares connection.
1949 sub prepare_connection {
1951 $c->engine->prepare_connection( $c, @_ );
1954 =head2 $c->prepare_cookies
1960 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1962 =head2 $c->prepare_headers
1968 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1970 =head2 $c->prepare_parameters
1972 Prepares parameters.
1976 sub prepare_parameters {
1978 $c->prepare_body_parameters;
1979 $c->engine->prepare_parameters( $c, @_ );
1982 =head2 $c->prepare_path
1984 Prepares path and base.
1988 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1990 =head2 $c->prepare_query_parameters
1992 Prepares query parameters.
1996 sub prepare_query_parameters {
1999 $c->engine->prepare_query_parameters( $c, @_ );
2002 =head2 $c->log_request
2004 Writes information about the request to the debug logs. This includes:
2008 =item * Request method, path, and remote IP address
2010 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2012 =item * Request parameters
2014 =item * File uploads
2023 return unless $c->debug;
2025 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2026 my $request = $dump->[1];
2028 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2030 $path = '/' unless length $path;
2032 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2034 $c->log_request_headers($request->headers);
2036 if ( my $keywords = $request->query_keywords ) {
2037 $c->log->debug("Query keywords are: $keywords");
2040 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2042 $c->log_request_uploads($request);
2045 =head2 $c->log_response
2047 Writes information about the response to the debug logs by calling
2048 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2055 return unless $c->debug;
2057 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2058 my $response = $dump->[1];
2060 $c->log_response_status_line($response);
2061 $c->log_response_headers($response->headers);
2064 =head2 $c->log_response_status_line($response)
2066 Writes one line of information about the response to the debug logs. This includes:
2070 =item * Response status code
2072 =item * Content-Type header (if present)
2074 =item * Content-Length header (if present)
2080 sub log_response_status_line {
2081 my ($c, $response) = @_;
2085 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2086 $response->status || 'unknown',
2087 $response->headers->header('Content-Type') || 'unknown',
2088 $response->headers->header('Content-Length') || 'unknown'
2093 =head2 $c->log_response_headers($headers);
2095 Hook method which can be wrapped by plugins to log the responseheaders.
2096 No-op in the default implementation.
2100 sub log_response_headers {}
2102 =head2 $c->log_request_parameters( query => {}, body => {} )
2104 Logs request parameters to debug logs
2108 sub log_request_parameters {
2110 my %all_params = @_;
2112 return unless $c->debug;
2114 my $column_width = Catalyst::Utils::term_width() - 44;
2115 foreach my $type (qw(query body)) {
2116 my $params = $all_params{$type};
2117 next if ! keys %$params;
2118 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2119 for my $key ( sort keys %$params ) {
2120 my $param = $params->{$key};
2121 my $value = defined($param) ? $param : '';
2122 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2124 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2128 =head2 $c->log_request_uploads
2130 Logs file uploads included in the request to the debug logs.
2131 The parameter name, filename, file type, and file size are all included in
2136 sub log_request_uploads {
2138 my $request = shift;
2139 return unless $c->debug;
2140 my $uploads = $request->uploads;
2141 if ( keys %$uploads ) {
2142 my $t = Text::SimpleTable->new(
2143 [ 12, 'Parameter' ],
2148 for my $key ( sort keys %$uploads ) {
2149 my $upload = $uploads->{$key};
2150 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2151 $t->row( $key, $u->filename, $u->type, $u->size );
2154 $c->log->debug( "File Uploads are:\n" . $t->draw );
2158 =head2 $c->log_request_headers($headers);
2160 Hook method which can be wrapped by plugins to log the request headers.
2161 No-op in the default implementation.
2165 sub log_request_headers {}
2167 =head2 $c->log_headers($type => $headers)
2169 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2176 my $headers = shift; # an HTTP::Headers instance
2178 return unless $c->debug;
2180 my $column_width = Catalyst::Utils::term_width() - 28;
2181 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2184 my ( $name, $value ) = @_;
2185 $t->row( $name, $value );
2188 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2192 =head2 $c->prepare_read
2194 Prepares the input for reading.
2198 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2200 =head2 $c->prepare_request
2202 Prepares the engine request.
2206 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2208 =head2 $c->prepare_uploads
2214 sub prepare_uploads {
2217 $c->engine->prepare_uploads( $c, @_ );
2220 =head2 $c->prepare_write
2222 Prepares the output for writing.
2226 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2228 =head2 $c->request_class
2230 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2232 =head2 $c->response_class
2234 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2236 =head2 $c->read( [$maxlength] )
2238 Reads a chunk of data from the request body. This method is designed to
2239 be used in a while loop, reading C<$maxlength> bytes on every call.
2240 C<$maxlength> defaults to the size of the request if not specified.
2242 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2245 Warning: If you use read(), Catalyst will not process the body,
2246 so you will not be able to access POST parameters or file uploads via
2247 $c->request. You must handle all body parsing yourself.
2251 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2259 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2261 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2263 Sets an action in a given namespace.
2267 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2269 =head2 $c->setup_actions($component)
2271 Sets up actions for a component.
2275 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2277 =head2 $c->setup_config
2284 my %args = %{ $class->config || {} };
2286 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2287 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2289 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2291 my $container = $container_class->new( %args, name => "$class" );
2292 $class->container($container);
2294 my $config = $container->resolve(service => 'config');
2295 $class->config($config);
2296 $class->finalize_config; # back-compat
2299 =head2 $c->finalize_config
2303 sub finalize_config { }
2305 =head2 $c->setup_components
2307 This method is called internally to set up the application's components.
2309 It finds modules by calling the L<locate_components> method, expands them to
2310 package names with the $container->expand_component_module method, and then
2311 installs each component into the application.
2313 The C<setup_components> config option is passed to both of the above methods.
2317 sub setup_components {
2319 # FIXME - I believe I shouldn't be handing $class over
2320 # Just don't know how to solve this.
2321 return $class->container->setup_components( $class );
2324 # FIXME - removed locate_components
2325 # don't people mess with this method directly?
2326 # what to do with that?
2328 =head2 $c->setup_dispatcher
2334 sub setup_dispatcher {
2335 my ( $class, $dispatcher ) = @_;
2338 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2341 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2342 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2345 unless ($dispatcher) {
2346 $dispatcher = $class->dispatcher_class;
2349 Class::MOP::load_class($dispatcher);
2351 # dispatcher instance
2352 $class->dispatcher( $dispatcher->new );
2355 =head2 $c->setup_engine
2362 my ( $class, $engine ) = @_;
2365 $engine = 'Catalyst::Engine::' . $engine;
2368 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2369 $engine = 'Catalyst::Engine::' . $env;
2372 if ( $ENV{MOD_PERL} ) {
2373 my $meta = Class::MOP::get_metaclass_by_name($class);
2375 # create the apache method
2376 $meta->add_method('apache' => sub { shift->engine->apache });
2378 my ( $software, $version ) =
2379 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2382 $version =~ s/(\.[^.]+)\./$1/g;
2384 if ( $software eq 'mod_perl' ) {
2388 if ( $version >= 1.99922 ) {
2389 $engine = 'Catalyst::Engine::Apache2::MP20';
2392 elsif ( $version >= 1.9901 ) {
2393 $engine = 'Catalyst::Engine::Apache2::MP19';
2396 elsif ( $version >= 1.24 ) {
2397 $engine = 'Catalyst::Engine::Apache::MP13';
2401 Catalyst::Exception->throw( message =>
2402 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2407 # install the correct mod_perl handler
2408 if ( $version >= 1.9901 ) {
2409 *handler = sub : method {
2410 shift->handle_request(@_);
2414 *handler = sub ($$) { shift->handle_request(@_) };
2419 elsif ( $software eq 'Zeus-Perl' ) {
2420 $engine = 'Catalyst::Engine::Zeus';
2424 Catalyst::Exception->throw(
2425 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2430 $engine = $class->engine_class;
2433 Class::MOP::load_class($engine);
2435 # check for old engines that are no longer compatible
2437 if ( $engine->isa('Catalyst::Engine::Apache')
2438 && !Catalyst::Engine::Apache->VERSION )
2443 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2444 && Catalyst::Engine::Server->VERSION le '0.02' )
2449 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2450 && $engine->VERSION eq '0.01' )
2455 elsif ($engine->isa('Catalyst::Engine::Zeus')
2456 && $engine->VERSION eq '0.01' )
2462 Catalyst::Exception->throw( message =>
2463 qq/Engine "$engine" is not supported by this version of Catalyst/
2468 $class->engine( $engine->new );
2471 =head2 $c->setup_home
2473 Sets up the home directory.
2478 my ( $class, $home ) = @_;
2480 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2484 $home ||= Catalyst::Utils::home($class);
2487 #I remember recently being scolded for assigning config values like this
2488 $class->config->{home} ||= $home;
2489 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2493 =head2 $c->setup_log
2495 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2496 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2499 This method also installs a C<debug> method that returns a true value into the
2500 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2501 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2503 Note that if the log has already been setup, by either a previous call to
2504 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2505 that this method won't actually set up the log object.
2510 my ( $class, $levels ) = @_;
2513 $levels =~ s/^\s+//;
2514 $levels =~ s/\s+$//;
2515 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2517 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2518 if ( defined $env_debug ) {
2519 $levels{debug} = 1 if $env_debug; # Ugly!
2520 delete($levels{debug}) unless $env_debug;
2523 unless ( $class->log ) {
2524 $class->log( Catalyst::Log->new(keys %levels) );
2527 if ( $levels{debug} ) {
2528 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2529 $class->log->debug('Debug messages enabled');
2533 =head2 $c->setup_plugins
2539 =head2 $c->setup_stats
2541 Sets up timing statistics class.
2546 my ( $class, $stats ) = @_;
2548 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2550 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2551 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2552 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2553 $class->log->debug('Statistics enabled');
2558 =head2 $c->registered_plugins
2560 Returns a sorted list of the plugins which have either been stated in the
2561 import list or which have been added via C<< MyApp->plugin(@args); >>.
2563 If passed a given plugin name, it will report a boolean value indicating
2564 whether or not that plugin is loaded. A fully qualified name is required if
2565 the plugin name does not begin with C<Catalyst::Plugin::>.
2567 if ($c->registered_plugins('Some::Plugin')) {
2575 sub registered_plugins {
2577 return sort keys %{ $proto->_plugins } unless @_;
2579 return 1 if exists $proto->_plugins->{$plugin};
2580 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2583 sub _register_plugin {
2584 my ( $proto, $plugin, $instant ) = @_;
2585 my $class = ref $proto || $proto;
2587 Class::MOP::load_class( $plugin );
2588 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2589 if $plugin->isa( 'Catalyst::Component' );
2590 $proto->_plugins->{$plugin} = 1;
2592 my $meta = Class::MOP::get_metaclass_by_name($class);
2593 $meta->superclasses($plugin, $meta->superclasses);
2599 my ( $class, $plugins ) = @_;
2601 $class->_plugins( {} ) unless $class->_plugins;
2602 $plugins = Data::OptList::mkopt($plugins || []);
2605 [ Catalyst::Utils::resolve_namespace(
2606 $class . '::Plugin',
2607 'Catalyst::Plugin', $_->[0]
2613 for my $plugin ( reverse @plugins ) {
2614 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2615 my $meta = find_meta($plugin->[0]);
2616 next if $meta && $meta->isa('Moose::Meta::Role');
2618 $class->_register_plugin($plugin->[0]);
2622 map { $_->[0]->name, $_->[1] }
2623 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2624 map { [find_meta($_->[0]), $_->[1]] }
2627 Moose::Util::apply_all_roles(
2635 Returns an arrayref of the internal execution stack (actions that are
2636 currently executing).
2640 Returns the current timing statistics object. By default Catalyst uses
2641 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2642 L<< stats_class|/"$c->stats_class" >>.
2644 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2645 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2646 profile explicitly, although MyApp.pm still won't profile nor output anything
2649 =head2 $c->stats_class
2651 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2653 =head2 $c->use_stats
2655 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2657 Note that this is a static method, not an accessor and should be overridden
2658 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2665 =head2 $c->write( $data )
2667 Writes $data to the output stream. When using this method directly, you
2668 will need to manually set the C<Content-Length> header to the length of
2669 your output data, if known.
2676 # Finalize headers if someone manually writes output
2677 $c->finalize_headers;
2679 return $c->engine->write( $c, @_ );
2684 Returns the Catalyst version number. Mostly useful for "powered by"
2685 messages in template systems.
2689 sub version { return $Catalyst::VERSION }
2691 =head1 CONFIGURATION
2693 There are a number of 'base' config variables which can be set:
2699 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2703 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2707 C<home> - The application home directory. In an uninstalled application,
2708 this is the top level application directory. In an installed application,
2709 this will be the directory containing C<< MyApp.pm >>.
2713 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2717 C<name> - The name of the application in debug messages and the debug and
2722 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2723 until it is accessed. This allows you to (for example) check authentication (and reject
2724 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2728 C<root> - The root directory for templates. Usually this is just a
2729 subdirectory of the home directory, but you can set it to change the
2730 templates to a different directory.
2734 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2735 to be shown in hit debug tables in the test server.
2739 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2740 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2741 for more information.
2745 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2749 =head1 INTERNAL ACTIONS
2751 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2752 C<_ACTION>, and C<_END>. These are by default not shown in the private
2753 action table, but you can make them visible with a config parameter.
2755 MyApp->config(show_internal_actions => 1);
2757 =head1 ON-DEMAND PARSER
2759 The request body is usually parsed at the beginning of a request,
2760 but if you want to handle input yourself, you can enable on-demand
2761 parsing with a config parameter.
2763 MyApp->config(parse_on_demand => 1);
2765 =head1 PROXY SUPPORT
2767 Many production servers operate using the common double-server approach,
2768 with a lightweight frontend web server passing requests to a larger
2769 backend server. An application running on the backend server must deal
2770 with two problems: the remote user always appears to be C<127.0.0.1> and
2771 the server's hostname will appear to be C<localhost> regardless of the
2772 virtual host that the user connected through.
2774 Catalyst will automatically detect this situation when you are running
2775 the frontend and backend servers on the same machine. The following
2776 changes are made to the request.
2778 $c->req->address is set to the user's real IP address, as read from
2779 the HTTP X-Forwarded-For header.
2781 The host value for $c->req->base and $c->req->uri is set to the real
2782 host, as read from the HTTP X-Forwarded-Host header.
2784 Additionally, you may be running your backend application on an insecure
2785 connection (port 80) while your frontend proxy is running under SSL. If there
2786 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2787 tell Catalyst what port the frontend listens on. This will allow all URIs to
2788 be created properly.
2790 In the case of passing in:
2792 X-Forwarded-Port: 443
2794 All calls to C<uri_for> will result in an https link, as is expected.
2796 Obviously, your web server must support these headers for this to work.
2798 In a more complex server farm environment where you may have your
2799 frontend proxy server(s) on different machines, you will need to set a
2800 configuration option to tell Catalyst to read the proxied data from the
2803 MyApp->config(using_frontend_proxy => 1);
2805 If you do not wish to use the proxy support at all, you may set:
2807 MyApp->config(ignore_frontend_proxy => 1);
2809 =head1 THREAD SAFETY
2811 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2812 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2813 believe the Catalyst core to be thread-safe.
2815 If you plan to operate in a threaded environment, remember that all other
2816 modules you are using must also be thread-safe. Some modules, most notably
2817 L<DBD::SQLite>, are not thread-safe.
2823 Join #catalyst on irc.perl.org.
2827 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2828 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2832 http://catalyst.perl.org
2836 http://dev.catalyst.perl.org
2840 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2842 =head2 L<Catalyst::Manual> - The Catalyst Manual
2844 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2846 =head2 L<Catalyst::Engine> - Core engine
2848 =head2 L<Catalyst::Log> - Log class.
2850 =head2 L<Catalyst::Request> - Request object
2852 =head2 L<Catalyst::Response> - Response object
2854 =head2 L<Catalyst::Test> - The test suite.
2856 =head1 PROJECT FOUNDER
2858 sri: Sebastian Riedel <sri@cpan.org>
2864 acme: Leon Brocard <leon@astray.com>
2866 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2870 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2876 andyg: Andy Grundman <andy@hybridized.org>
2878 audreyt: Audrey Tang
2880 bricas: Brian Cassidy <bricas@cpan.org>
2882 Caelum: Rafael Kitover <rkitover@io.com>
2884 chansen: Christian Hansen
2886 chicks: Christopher Hicks
2888 Chisel Wright C<pause@herlpacker.co.uk>
2890 Danijel Milicevic C<me@danijel.de>
2892 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2894 David Naughton, C<naughton@umn.edu>
2898 dhoss: Devin Austin <dhoss@cpan.org>
2900 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2904 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2906 esskar: Sascha Kiefer
2908 fireartist: Carl Franks <cfranks@cpan.org>
2910 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2912 gabb: Danijel Milicevic
2916 Gavin Henry C<ghenry@perl.me.uk>
2920 groditi: Guillermo Roditi <groditi@gmail.com>
2922 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2924 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2926 jcamacho: Juan Camacho
2928 jester: Jesse Sheidlower C<jester@panix.com>
2930 jhannah: Jay Hannah <jay@jays.net>
2936 jon: Jon Schutz <jjschutz@cpan.org>
2938 Jonathan Rockway C<< <jrockway@cpan.org> >>
2940 Kieren Diment C<kd@totaldatasolution.com>
2942 konobi: Scott McWhirter <konobi@cpan.org>
2944 marcus: Marcus Ramberg <mramberg@cpan.org>
2946 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2948 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2952 naughton: David Naughton
2954 ningu: David Kamholz <dkamholz@cpan.org>
2956 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2958 numa: Dan Sully <daniel@cpan.org>
2964 omega: Andreas Marienborg
2966 Oleg Kostyuk <cub.uanic@gmail.com>
2968 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2970 rafl: Florian Ragwitz <rafl@debian.org>
2972 random: Roland Lammel <lammel@cpan.org>
2974 Robert Sedlacek C<< <rs@474.at> >>
2976 SpiceMan: Marcel Montes
2980 szbalint: Balint Szilakszi <szbalint@cpan.org>
2982 t0m: Tomas Doran <bobtfish@bobtfish.net>
2986 Viljo Marrandi C<vilts@yahoo.com>
2988 Will Hawes C<info@whawes.co.uk>
2990 willert: Sebastian Willert <willert@cpan.org>
2992 wreis: Wallace Reis <wallace@reis.org.br>
2994 Yuval Kogman, C<nothingmuch@woobling.org>
2996 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
2998 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3002 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3006 This library is free software. You can redistribute it and/or modify it under
3007 the same terms as Perl itself.
3013 __PACKAGE__->meta->make_immutable;