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});
567 sub controller { shift->_lookup_mvc('controller', @_) }
569 =head2 $c->model($name)
571 Gets a L<Catalyst::Model> instance by name.
573 $c->model('Foo')->do_stuff;
575 Any extra arguments are directly passed to ACCEPT_CONTEXT.
577 If the name is omitted, it will look for
578 - a model object in $c->stash->{current_model_instance}, then
579 - a model name in $c->stash->{current_model}, then
580 - a config setting 'default_model', or
581 - check if there is only one model, and return it if that's the case.
583 If you want to search for models, pass in a regexp as the argument.
585 # find all models that start with Foo
586 my @foo_models = $c->model(qr{^Foo});
590 sub model { shift->_lookup_mvc('model', @_) }
592 =head2 $c->view($name)
594 Gets a L<Catalyst::View> instance by name.
596 $c->view('Foo')->do_stuff;
598 Any extra arguments are directly passed to ACCEPT_CONTEXT.
600 If the name is omitted, it will look for
601 - a view object in $c->stash->{current_view_instance}, then
602 - a view name in $c->stash->{current_view}, then
603 - a config setting 'default_view', or
604 - check if there is only one view, and return it if that's the case.
606 If you want to search for views, pass in a regexp as the argument.
608 # find all views that start with Foo
609 my @foo_views = $c->view(qr{^Foo});
613 sub view { shift->_lookup_mvc('view', @_) }
616 my ( $c, $type, $name, @args ) = @_;
618 if (ref $c && !$name) {
619 my $current_instance = $c->stash->{"current_${type}_instance"};
620 return $current_instance
621 if $current_instance && $type ne 'controller';
623 $name = $type eq 'controller'
624 ? Catalyst::Utils::class2classshortsuffix($c->action->class)
625 : $c->stash->{"current_${type}"}
629 return $c->container->get_component_from_sub_container($type, $name, $c, @args);
632 =head2 $c->controllers
634 Returns the available names which can be passed to $c->controller
640 return $c->container->get_sub_container('controller')->get_service_list;
645 Returns the available names which can be passed to $c->model
651 return $c->container->get_sub_container('model')->get_service_list;
657 Returns the available names which can be passed to $c->view
663 return $c->container->get_sub_container('view')->get_service_list;
666 =head2 $c->comp($name)
668 =head2 $c->component($name)
670 Gets a component object by name. This method is not recommended,
671 unless you want to get a specific component by full
672 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
673 should be used instead.
675 If C<$name> is a regexp, a list of components matched against the full
676 component name will be returned.
681 my ( $c, $component, @args ) = @_;
683 unless ($component) {
684 $c->log->warn('Calling $c->component with no args is deprecated and ');
685 $c->log->warn('will be removed in a future release.');
686 $c->log->warn('Use $c->component_list instead.');
687 return $c->component_list;
690 my @result = $c->container->find_component( $component, $c, @args );
692 # list context for regexp searches
693 return @result if ref $component;
695 # only one component (if it's found) for string searches
696 return shift @result if @result;
698 if (ref $c eq $component) {
699 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
700 $c->log->warn('deprecated, and will be removed in a future release.');
704 $c->log->warn("Looking for '$component', but nothing was found.");
706 # I would expect to return an empty list here, but that breaks back-compat
707 $c->log->warn('Component not found, returning the list of existing');
708 $c->log->warn('components. This behavior is deprecated and will be');
709 $c->log->warn('removed in a future release. Use $c->component_list');
710 $c->log->warn('instead.');
712 return $c->component_list;
715 =head2 $c->component_list
717 Returns the sorted list of the component names of the application.
721 sub component_list { sort keys %{ shift->components } }
723 =head2 CLASS DATA AND HELPER CLASSES
727 Returns or takes a hashref containing the application's configuration.
729 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
731 You can also use a C<YAML>, C<XML> or L<Config::General> config file
732 like C<myapp.conf> in your applications home directory. See
733 L<Catalyst::Plugin::ConfigLoader>.
735 =head3 Cascading configuration
737 The config method is present on all Catalyst components, and configuration
738 will be merged when an application is started. Configuration loaded with
739 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
740 followed by configuration in your top level C<MyApp> class. These two
741 configurations are merged, and then configuration data whose hash key matches a
742 component name is merged with configuration for that component.
744 The configuration for a component is then passed to the C<new> method when a
745 component is constructed.
749 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
750 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
752 will mean that C<MyApp::Model::Foo> receives the following data when
755 MyApp::Model::Foo->new({
761 It's common practice to use a Moose attribute
762 on the receiving component to access the config value.
764 package MyApp::Model::Foo;
768 # this attr will receive 'baz' at construction time
774 You can then get the value 'baz' by calling $c->model('Foo')->bar
775 (or $self->bar inside code in the model).
777 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
778 as a way of reading config within your code, as this B<will not> give you the
779 correctly merged config back. You B<MUST> take the config values supplied to
780 the constructor and use those instead.
784 around config => sub {
788 croak('Setting config after setup has been run is not allowed.')
789 if ( @_ and $c->setup_finished );
796 Returns the logging object instance. Unless it is already set, Catalyst
797 sets this up with a L<Catalyst::Log> object. To use your own log class,
798 set the logger with the C<< __PACKAGE__->log >> method prior to calling
799 C<< __PACKAGE__->setup >>.
801 __PACKAGE__->log( MyLogger->new );
806 $c->log->info( 'Now logging with my own logger!' );
808 Your log class should implement the methods described in
814 Returns 1 if debug mode is enabled, 0 otherwise.
816 You can enable debug mode in several ways:
820 =item By calling myapp_server.pl with the -d flag
822 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
824 =item The -Debug option in your MyApp.pm
826 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
830 The first three also set the log level to 'debug'.
832 Calling C<< $c->debug(1) >> has no effect.
838 =head2 $c->dispatcher
840 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
844 Returns the engine instance. See L<Catalyst::Engine>.
847 =head2 UTILITY METHODS
849 =head2 $c->path_to(@path)
851 Merges C<@path> with C<< $c->config->{home} >> and returns a
852 L<Path::Class::Dir> object. Note you can usually use this object as
853 a filename, but sometimes you will have to explicitly stringify it
854 yourself by calling the C<< ->stringify >> method.
858 $c->path_to( 'db', 'sqlite.db' );
863 my ( $c, @path ) = @_;
864 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
865 if ( -d $path ) { return $path }
866 else { return Path::Class::File->new( $c->config->{home}, @path ) }
869 =head2 $c->plugin( $name, $class, @args )
871 Helper method for plugins. It creates a class data accessor/mutator and
872 loads and instantiates the given class.
874 MyApp->plugin( 'prototype', 'HTML::Prototype' );
876 $c->prototype->define_javascript_functions;
878 B<Note:> This method of adding plugins is deprecated. The ability
879 to add plugins like this B<will be removed> in a Catalyst 5.81.
880 Please do not use this functionality in new code.
885 my ( $class, $name, $plugin, @args ) = @_;
887 # See block comment in t/aggregate/unit_core_plugin.t
888 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
890 $class->_register_plugin( $plugin, 1 );
892 eval { $plugin->import };
893 $class->mk_classdata($name);
895 eval { $obj = $plugin->new(@args) };
898 Catalyst::Exception->throw( message =>
899 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
903 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
909 Initializes the dispatcher and engine, loads any plugins, and loads the
910 model, view, and controller components. You may also specify an array
911 of plugins to load here, if you choose to not load them in the C<use
915 MyApp->setup( qw/-Debug/ );
920 my ( $class, @arguments ) = @_;
921 croak('Running setup more than once')
922 if ( $class->setup_finished );
924 unless ( $class->isa('Catalyst') ) {
926 Catalyst::Exception->throw(
927 message => qq/'$class' does not inherit from Catalyst/ );
930 if ( $class->arguments ) {
931 @arguments = ( @arguments, @{ $class->arguments } );
937 foreach (@arguments) {
941 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
943 elsif (/^-(\w+)=?(.*)$/) {
944 $flags->{ lc $1 } = $2;
947 push @{ $flags->{plugins} }, $_;
951 $class->setup_config();
952 $class->setup_home( delete $flags->{home} );
954 $class->setup_log( delete $flags->{log} );
955 $class->setup_plugins( delete $flags->{plugins} );
956 $class->setup_dispatcher( delete $flags->{dispatcher} );
957 $class->setup_engine( delete $flags->{engine} );
958 $class->setup_stats( delete $flags->{stats} );
960 for my $flag ( sort keys %{$flags} ) {
962 if ( my $code = $class->can( 'setup_' . $flag ) ) {
963 &$code( $class, delete $flags->{$flag} );
966 $class->log->warn(qq/Unknown flag "$flag"/);
970 eval { require Catalyst::Devel; };
971 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
972 $class->log->warn(<<"EOF");
973 You are running an old script!
975 Please update by running (this will overwrite existing files):
976 catalyst.pl -force -scripts $class
978 or (this will not overwrite existing files):
979 catalyst.pl -scripts $class
984 if ( $class->debug ) {
985 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
988 my $column_width = Catalyst::Utils::term_width() - 6;
989 my $t = Text::SimpleTable->new($column_width);
990 $t->row($_) for @plugins;
991 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
994 my $dispatcher = $class->dispatcher;
995 my $engine = $class->engine;
996 my $home = $class->config->{home};
998 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
999 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1003 ? $class->log->debug(qq/Found home "$home"/)
1004 : $class->log->debug(qq/Home "$home" doesn't exist/)
1005 : $class->log->debug(q/Couldn't find home/);
1008 # Call plugins setup, this is stupid and evil.
1009 # Also screws C3 badly on 5.10, hack to avoid.
1011 no warnings qw/redefine/;
1012 local *setup = sub { };
1013 $class->setup unless $Catalyst::__AM_RESTARTING;
1016 $class->setup_components;
1020 my %comps = $class->container->get_all_components
1022 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1023 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1024 $t->row( $_ => ref($comps{$_}) ? 'instance' : 'class' ) for keys %comps;
1026 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1029 $class->setup_actions;
1031 if ( $class->debug ) {
1032 my $name = $class->config->{name} || 'Application';
1033 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1036 # Make sure that the application class becomes immutable at this point,
1037 B::Hooks::EndOfScope::on_scope_end {
1039 my $meta = Class::MOP::get_metaclass_by_name($class);
1042 && ! { $meta->immutable_options }->{replace_constructor}
1044 $class->isa('Class::Accessor::Fast')
1045 || $class->isa('Class::Accessor')
1048 warn "You made your application class ($class) immutable, "
1049 . "but did not inline the\nconstructor. "
1050 . "This will break catalyst, as your app \@ISA "
1051 . "Class::Accessor(::Fast)?\nPlease pass "
1052 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1054 $meta->make_immutable(
1055 replace_constructor => 1,
1056 ) unless $meta->is_immutable;
1059 if ($class->config->{case_sensitive}) {
1060 $class->log->warn($class . "->config->{case_sensitive} is set.");
1061 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1064 $class->setup_finalize;
1065 # Should be the last thing we do so that user things hooking
1066 # setup_finalize can log..
1067 $class->log->_flush() if $class->log->can('_flush');
1068 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1071 =head2 $app->setup_finalize
1073 A hook to attach modifiers to. This method does not do anything except set the
1074 C<setup_finished> accessor.
1076 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1080 after setup_finalize => sub {
1088 sub setup_finalize {
1090 $class->setup_finished(1);
1093 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1095 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1097 Constructs an absolute L<URI> object based on the application root, the
1098 provided path, and the additional arguments and query parameters provided.
1099 When used as a string, provides a textual URI. If you need more flexibility
1100 than this (i.e. the option to provide relative URIs etc.) see
1101 L<Catalyst::Plugin::SmartURI>.
1103 If no arguments are provided, the URI for the current action is returned.
1104 To return the current action and also provide @args, use
1105 C<< $c->uri_for( $c->action, @args ) >>.
1107 If the first argument is a string, it is taken as a public URI path relative
1108 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1109 relative to the application root (if it does). It is then merged with
1110 C<< $c->request->base >>; any C<@args> are appended as additional path
1111 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1113 If the first argument is a L<Catalyst::Action> it represents an action which
1114 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1115 optional C<\@captures> argument (an arrayref) allows passing the captured
1116 variables that are needed to fill in the paths of Chained and Regex actions;
1117 once the path is resolved, C<uri_for> continues as though a path was
1118 provided, appending any arguments or parameters and creating an absolute
1121 The captures for the current request can be found in
1122 C<< $c->request->captures >>, and actions can be resolved using
1123 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1124 path, use C<< $c->uri_for_action >> instead.
1126 # Equivalent to $c->req->uri
1127 $c->uri_for($c->action, $c->req->captures,
1128 @{ $c->req->args }, $c->req->params);
1130 # For the Foo action in the Bar controller
1131 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1133 # Path to a static resource
1134 $c->uri_for('/static/images/logo.png');
1139 my ( $c, $path, @args ) = @_;
1141 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1142 $path = $path->path_prefix;
1147 undef($path) if (defined $path && $path eq '');
1150 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1152 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1153 foreach my $arg (@args) {
1154 utf8::encode($arg) if utf8::is_utf8($arg);
1155 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1158 if ( blessed($path) ) { # action object
1159 s|/|%2F|g for @args;
1160 my $captures = [ map { s|/|%2F|g; $_; }
1161 ( scalar @args && ref $args[0] eq 'ARRAY'
1165 foreach my $capture (@$captures) {
1166 utf8::encode($capture) if utf8::is_utf8($capture);
1167 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1171 $path = $c->dispatcher->uri_for_action($action, $captures);
1172 if (not defined $path) {
1173 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1177 $path = '/' if $path eq '';
1180 unshift(@args, $path);
1182 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1183 my $namespace = $c->namespace;
1184 if (defined $path) { # cheesy hack to handle path '../foo'
1185 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1187 unshift(@args, $namespace || '');
1190 # join args with '/', or a blank string
1191 my $args = join('/', grep { defined($_) } @args);
1192 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1194 my $base = $c->req->base;
1195 my $class = ref($base);
1196 $base =~ s{(?<!/)$}{/};
1200 if (my @keys = keys %$params) {
1201 # somewhat lifted from URI::_query's query_form
1202 $query = '?'.join('&', map {
1203 my $val = $params->{$_};
1204 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1207 $val = '' unless defined $val;
1210 utf8::encode( $param ) if utf8::is_utf8($param);
1211 # using the URI::Escape pattern here so utf8 chars survive
1212 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1214 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1218 my $res = bless(\"${base}${args}${query}", $class);
1222 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1224 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1230 A private path to the Catalyst action you want to create a URI for.
1232 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1233 >> and passing the resulting C<$action> and the remaining arguments to C<<
1236 You can also pass in a Catalyst::Action object, in which case it is passed to
1239 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.
1241 For example, if the action looks like:
1243 package MyApp::Controller::Users;
1245 sub lst : Path('the-list') {}
1249 $c->uri_for_action('/users/lst')
1251 and it will create the URI /users/the-list.
1257 sub uri_for_action {
1258 my ( $c, $path, @args ) = @_;
1259 my $action = blessed($path)
1261 : $c->dispatcher->get_action_by_path($path);
1262 unless (defined $action) {
1263 croak "Can't find action for path '$path'";
1265 return $c->uri_for( $action, @args );
1268 =head2 $c->welcome_message
1270 Returns the Catalyst welcome HTML page.
1274 sub welcome_message {
1276 my $name = $c->config->{name};
1277 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1278 my $prefix = Catalyst::Utils::appprefix( ref $c );
1279 $c->response->content_type('text/html; charset=utf-8');
1281 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1282 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1283 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1285 <meta http-equiv="Content-Language" content="en" />
1286 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1287 <title>$name on Catalyst $VERSION</title>
1288 <style type="text/css">
1291 background-color: #eee;
1298 margin-bottom: 10px;
1300 background-color: #ccc;
1301 border: 1px solid #aaa;
1306 font-family: verdana, tahoma, sans-serif;
1309 font-family: verdana, tahoma, sans-serif;
1312 text-decoration: none;
1314 border-bottom: 1px dotted #bbb;
1316 :link:hover, :visited:hover {
1329 background-color: #fff;
1330 border: 1px solid #aaa;
1334 font-weight: normal;
1356 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1361 <img src="$logo" alt="Catalyst Logo" />
1363 <p>Welcome to the world of Catalyst.
1364 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1365 framework will make web development something you had
1366 never expected it to be: Fun, rewarding, and quick.</p>
1367 <h2>What to do now?</h2>
1368 <p>That really depends on what <b>you</b> want to do.
1369 We do, however, provide you with a few starting points.</p>
1370 <p>If you want to jump right into web development with Catalyst
1371 you might want to start with a tutorial.</p>
1372 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1374 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1376 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1377 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1379 <h2>What to do next?</h2>
1380 <p>Next it's time to write an actual application. Use the
1381 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1382 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1383 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1384 they can save you a lot of work.</p>
1385 <pre><code>script/${prefix}_create.pl --help</code></pre>
1386 <p>Also, be sure to check out the vast and growing
1387 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1388 you are likely to find what you need there.
1392 <p>Catalyst has a very active community. Here are the main places to
1393 get in touch with us.</p>
1396 <a href="http://dev.catalyst.perl.org">Wiki</a>
1399 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1402 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1405 <h2>In conclusion</h2>
1406 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1407 as we enjoyed making it. Please contact us if you have ideas
1408 for improvement or other feedback.</p>
1416 =head1 INTERNAL METHODS
1418 These methods are not meant to be used by end users.
1420 =head2 $c->components
1422 Returns a hash of components.
1427 my ( $class, $comps ) = @_;
1429 # people create components calling this sub directly, before setup
1430 $class->setup_config unless $class->container;
1432 my $container = $class->container;
1435 $container->add_component( $_ ) for keys %$comps;
1438 return $container->get_all_components();
1441 =head2 $c->context_class
1443 Returns or sets the context class.
1447 Returns a hashref containing coderefs and execution counts (needed for
1448 deep recursion detection).
1452 Returns the number of actions on the current internal execution stack.
1456 Dispatches a request to actions.
1460 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1462 =head2 $c->dispatcher_class
1464 Returns or sets the dispatcher class.
1466 =head2 $c->dump_these
1468 Returns a list of 2-element array references (name, structure) pairs
1469 that will be dumped on the error page in debug mode.
1475 [ Request => $c->req ],
1476 [ Response => $c->res ],
1477 [ Stash => $c->stash ],
1478 [ Config => $c->config ];
1481 =head2 $c->engine_class
1483 Returns or sets the engine class.
1485 =head2 $c->execute( $class, $coderef )
1487 Execute a coderef in given class and catch exceptions. Errors are available
1493 my ( $c, $class, $code ) = @_;
1494 $class = $c->component($class) || $class;
1497 if ( $c->depth >= $RECURSION ) {
1498 my $action = $code->reverse();
1499 $action = "/$action" unless $action =~ /->/;
1500 my $error = qq/Deep recursion detected calling "${action}"/;
1501 $c->log->error($error);
1507 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1509 push( @{ $c->stack }, $code );
1511 no warnings 'recursion';
1512 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1513 # I have no idea how, ergo $ret (which appears to fix the issue)
1514 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1516 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1518 my $last = pop( @{ $c->stack } );
1520 if ( my $error = $@ ) {
1521 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1522 $error->rethrow if $c->depth > 1;
1524 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1525 $error->rethrow if $c->depth > 0;
1528 unless ( ref $error ) {
1529 no warnings 'uninitialized';
1531 my $class = $last->class;
1532 my $name = $last->name;
1533 $error = qq/Caught exception in $class->$name "$error"/;
1542 sub _stats_start_execute {
1543 my ( $c, $code ) = @_;
1544 my $appclass = ref($c) || $c;
1545 return if ( ( $code->name =~ /^_.*/ )
1546 && ( !$appclass->config->{show_internal_actions} ) );
1548 my $action_name = $code->reverse();
1549 $c->counter->{$action_name}++;
1551 my $action = $action_name;
1552 $action = "/$action" unless $action =~ /->/;
1554 # determine if the call was the result of a forward
1555 # this is done by walking up the call stack and looking for a calling
1556 # sub of Catalyst::forward before the eval
1558 for my $index ( 2 .. 11 ) {
1560 if ( ( caller($index) )[0] eq 'Catalyst'
1561 && ( caller($index) )[3] eq '(eval)' );
1563 if ( ( caller($index) )[3] =~ /forward$/ ) {
1564 $callsub = ( caller($index) )[3];
1565 $action = "-> $action";
1570 my $uid = $action_name . $c->counter->{$action_name};
1572 # is this a root-level call or a forwarded call?
1573 if ( $callsub =~ /forward$/ ) {
1574 my $parent = $c->stack->[-1];
1576 # forward, locate the caller
1577 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1580 parent => "$parent" . $c->counter->{"$parent"},
1586 # forward with no caller may come from a plugin
1605 sub _stats_finish_execute {
1606 my ( $c, $info ) = @_;
1607 $c->stats->profile( end => $info );
1612 Finalizes the request.
1619 for my $error ( @{ $c->error } ) {
1620 $c->log->error($error);
1623 # Allow engine to handle finalize flow (for POE)
1624 my $engine = $c->engine;
1625 if ( my $code = $engine->can('finalize') ) {
1630 $c->finalize_uploads;
1633 if ( $#{ $c->error } >= 0 ) {
1637 $c->finalize_headers;
1640 if ( $c->request->method eq 'HEAD' ) {
1641 $c->response->body('');
1651 if ($c->use_stats) {
1652 my $elapsed = sprintf '%f', $c->stats->elapsed;
1653 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1655 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1658 return $c->response->status;
1661 =head2 $c->finalize_body
1667 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1669 =head2 $c->finalize_cookies
1675 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1677 =head2 $c->finalize_error
1683 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1685 =head2 $c->finalize_headers
1691 sub finalize_headers {
1694 my $response = $c->response; #accessor calls can add up?
1696 # Check if we already finalized headers
1697 return if $response->finalized_headers;
1700 if ( my $location = $response->redirect ) {
1701 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1702 $response->header( Location => $location );
1704 if ( !$response->has_body ) {
1705 # Add a default body if none is already present
1707 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1713 if ( defined $response->body && length $response->body && !$response->content_length ) {
1715 # get the length from a filehandle
1716 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1718 my $stat = stat $response->body;
1719 if ( $stat && $stat->size > 0 ) {
1720 $response->content_length( $stat->size );
1723 $c->log->warn('Serving filehandle without a content-length');
1727 # everything should be bytes at this point, but just in case
1728 $response->content_length( length( $response->body ) );
1733 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1734 $response->headers->remove_header("Content-Length");
1735 $response->body('');
1738 $c->finalize_cookies;
1740 $c->engine->finalize_headers( $c, @_ );
1743 $response->finalized_headers(1);
1746 =head2 $c->finalize_output
1748 An alias for finalize_body.
1750 =head2 $c->finalize_read
1752 Finalizes the input after reading is complete.
1756 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1758 =head2 $c->finalize_uploads
1760 Finalizes uploads. Cleans up any temporary files.
1764 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1766 =head2 $c->finalize_ioc
1768 Flushes all services with Request lifecycle.
1772 sub finalize_ioc { shift->container->flush_request_services() }
1774 =head2 $c->get_action( $action, $namespace )
1776 Gets an action in a given namespace.
1780 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1782 =head2 $c->get_actions( $action, $namespace )
1784 Gets all actions of a given name in a namespace and all parent
1789 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1791 =head2 $app->handle_request( @arguments )
1793 Called to handle each HTTP request.
1797 sub handle_request {
1798 my ( $class, @arguments ) = @_;
1800 # Always expect worst case!
1803 if ($class->debug) {
1804 my $secs = time - $START || 1;
1805 my $av = sprintf '%.3f', $COUNT / $secs;
1806 my $time = localtime time;
1807 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1810 my $c = $class->prepare(@arguments);
1812 $status = $c->finalize;
1815 if ( my $error = $@ ) {
1817 $class->log->error(qq/Caught exception in engine "$error"/);
1822 if(my $coderef = $class->log->can('_flush')){
1823 $class->log->$coderef();
1828 =head2 $c->prepare( @arguments )
1830 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1836 my ( $class, @arguments ) = @_;
1839 # After the app/ctxt split, this should become an attribute based on something passed
1840 # into the application.
1841 $class->context_class( ref $class || $class ) unless $class->context_class;
1843 my $c = $class->context_class->new({});
1845 # For on-demand data
1846 $c->request->_context($c);
1847 $c->response->_context($c);
1849 #surely this is not the most efficient way to do things...
1850 $c->stats($class->stats_class->new)->enable($c->use_stats);
1851 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1852 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1855 #XXX reuse coderef from can
1856 # Allow engine to direct the prepare flow (for POE)
1857 if ( $c->engine->can('prepare') ) {
1858 $c->engine->prepare( $c, @arguments );
1861 $c->prepare_request(@arguments);
1862 $c->prepare_connection;
1863 $c->prepare_query_parameters;
1864 $c->prepare_headers;
1865 $c->prepare_cookies;
1868 # Prepare the body for reading, either by prepare_body
1869 # or the user, if they are using $c->read
1872 # Parse the body unless the user wants it on-demand
1873 unless ( ref($c)->config->{parse_on_demand} ) {
1878 my $method = $c->req->method || '';
1879 my $path = $c->req->path;
1880 $path = '/' unless length $path;
1881 my $address = $c->req->address || '';
1890 =head2 $c->prepare_action
1892 Prepares action. See L<Catalyst::Dispatcher>.
1896 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1898 =head2 $c->prepare_body
1900 Prepares message body.
1907 return if $c->request->_has_body;
1909 # Initialize on-demand data
1910 $c->engine->prepare_body( $c, @_ );
1911 $c->prepare_parameters;
1912 $c->prepare_uploads;
1915 =head2 $c->prepare_body_chunk( $chunk )
1917 Prepares a chunk of data before sending it to L<HTTP::Body>.
1919 See L<Catalyst::Engine>.
1923 sub prepare_body_chunk {
1925 $c->engine->prepare_body_chunk( $c, @_ );
1928 =head2 $c->prepare_body_parameters
1930 Prepares body parameters.
1934 sub prepare_body_parameters {
1936 $c->engine->prepare_body_parameters( $c, @_ );
1939 =head2 $c->prepare_connection
1941 Prepares connection.
1945 sub prepare_connection {
1947 $c->engine->prepare_connection( $c, @_ );
1950 =head2 $c->prepare_cookies
1956 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1958 =head2 $c->prepare_headers
1964 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1966 =head2 $c->prepare_parameters
1968 Prepares parameters.
1972 sub prepare_parameters {
1974 $c->prepare_body_parameters;
1975 $c->engine->prepare_parameters( $c, @_ );
1978 =head2 $c->prepare_path
1980 Prepares path and base.
1984 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1986 =head2 $c->prepare_query_parameters
1988 Prepares query parameters.
1992 sub prepare_query_parameters {
1995 $c->engine->prepare_query_parameters( $c, @_ );
1998 =head2 $c->log_request
2000 Writes information about the request to the debug logs. This includes:
2004 =item * Request method, path, and remote IP address
2006 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2008 =item * Request parameters
2010 =item * File uploads
2019 return unless $c->debug;
2021 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2022 my $request = $dump->[1];
2024 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2026 $path = '/' unless length $path;
2028 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2030 $c->log_request_headers($request->headers);
2032 if ( my $keywords = $request->query_keywords ) {
2033 $c->log->debug("Query keywords are: $keywords");
2036 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2038 $c->log_request_uploads($request);
2041 =head2 $c->log_response
2043 Writes information about the response to the debug logs by calling
2044 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2051 return unless $c->debug;
2053 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2054 my $response = $dump->[1];
2056 $c->log_response_status_line($response);
2057 $c->log_response_headers($response->headers);
2060 =head2 $c->log_response_status_line($response)
2062 Writes one line of information about the response to the debug logs. This includes:
2066 =item * Response status code
2068 =item * Content-Type header (if present)
2070 =item * Content-Length header (if present)
2076 sub log_response_status_line {
2077 my ($c, $response) = @_;
2081 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2082 $response->status || 'unknown',
2083 $response->headers->header('Content-Type') || 'unknown',
2084 $response->headers->header('Content-Length') || 'unknown'
2089 =head2 $c->log_response_headers($headers);
2091 Hook method which can be wrapped by plugins to log the responseheaders.
2092 No-op in the default implementation.
2096 sub log_response_headers {}
2098 =head2 $c->log_request_parameters( query => {}, body => {} )
2100 Logs request parameters to debug logs
2104 sub log_request_parameters {
2106 my %all_params = @_;
2108 return unless $c->debug;
2110 my $column_width = Catalyst::Utils::term_width() - 44;
2111 foreach my $type (qw(query body)) {
2112 my $params = $all_params{$type};
2113 next if ! keys %$params;
2114 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2115 for my $key ( sort keys %$params ) {
2116 my $param = $params->{$key};
2117 my $value = defined($param) ? $param : '';
2118 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2120 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2124 =head2 $c->log_request_uploads
2126 Logs file uploads included in the request to the debug logs.
2127 The parameter name, filename, file type, and file size are all included in
2132 sub log_request_uploads {
2134 my $request = shift;
2135 return unless $c->debug;
2136 my $uploads = $request->uploads;
2137 if ( keys %$uploads ) {
2138 my $t = Text::SimpleTable->new(
2139 [ 12, 'Parameter' ],
2144 for my $key ( sort keys %$uploads ) {
2145 my $upload = $uploads->{$key};
2146 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2147 $t->row( $key, $u->filename, $u->type, $u->size );
2150 $c->log->debug( "File Uploads are:\n" . $t->draw );
2154 =head2 $c->log_request_headers($headers);
2156 Hook method which can be wrapped by plugins to log the request headers.
2157 No-op in the default implementation.
2161 sub log_request_headers {}
2163 =head2 $c->log_headers($type => $headers)
2165 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2172 my $headers = shift; # an HTTP::Headers instance
2174 return unless $c->debug;
2176 my $column_width = Catalyst::Utils::term_width() - 28;
2177 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2180 my ( $name, $value ) = @_;
2181 $t->row( $name, $value );
2184 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2188 =head2 $c->prepare_read
2190 Prepares the input for reading.
2194 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2196 =head2 $c->prepare_request
2198 Prepares the engine request.
2202 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2204 =head2 $c->prepare_uploads
2210 sub prepare_uploads {
2213 $c->engine->prepare_uploads( $c, @_ );
2216 =head2 $c->prepare_write
2218 Prepares the output for writing.
2222 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2224 =head2 $c->request_class
2226 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2228 =head2 $c->response_class
2230 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2232 =head2 $c->read( [$maxlength] )
2234 Reads a chunk of data from the request body. This method is designed to
2235 be used in a while loop, reading C<$maxlength> bytes on every call.
2236 C<$maxlength> defaults to the size of the request if not specified.
2238 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2241 Warning: If you use read(), Catalyst will not process the body,
2242 so you will not be able to access POST parameters or file uploads via
2243 $c->request. You must handle all body parsing yourself.
2247 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2255 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2257 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2259 Sets an action in a given namespace.
2263 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2265 =head2 $c->setup_actions($component)
2267 Sets up actions for a component.
2271 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2273 =head2 $c->setup_config
2280 my %args = %{ $class->config || {} };
2282 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2283 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2285 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2287 my $container = $container_class->new( %args, application_name => "$class", name => "$class" );
2288 $class->container($container);
2290 my $config = $container->resolve( service => 'config' );
2291 $class->config($config);
2292 $class->finalize_config; # back-compat
2295 =head2 $c->finalize_config
2299 sub finalize_config { }
2301 =head2 $c->setup_components
2303 This method is called internally to set up the application's components.
2305 It finds modules by calling the L<locate_components> method, expands them to
2306 package names with the $container->expand_component_module method, and then
2307 installs each component into the application.
2309 The C<setup_components> config option is passed to both of the above methods.
2313 sub setup_components {
2314 shift->container->setup_components();
2317 =head2 locate_components
2321 # FIXME - removed locate_components
2322 # don't people mess with this method directly?
2323 # what to do with that?
2325 sub locate_components {
2328 $class->log->warn('The locate_components method has been deprecated.');
2329 $class->log->warn('Please read Catalyst::IOC::Container documentation to');
2330 $class->log->warn('update your application.');
2332 # XXX think about ditching this sort entirely
2333 return sort { length $a <=> length $b }
2334 @{ $class->container->resolve( service => 'locate_components' ) };
2338 =head2 $c->setup_dispatcher
2344 sub setup_dispatcher {
2345 my ( $class, $dispatcher ) = @_;
2348 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2351 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2352 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2355 unless ($dispatcher) {
2356 $dispatcher = $class->dispatcher_class;
2359 Class::MOP::load_class($dispatcher);
2361 # dispatcher instance
2362 $class->dispatcher( $dispatcher->new );
2365 =head2 $c->setup_engine
2372 my ( $class, $engine ) = @_;
2375 $engine = 'Catalyst::Engine::' . $engine;
2378 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2379 $engine = 'Catalyst::Engine::' . $env;
2382 if ( $ENV{MOD_PERL} ) {
2383 my $meta = Class::MOP::get_metaclass_by_name($class);
2385 # create the apache method
2386 $meta->add_method('apache' => sub { shift->engine->apache });
2388 my ( $software, $version ) =
2389 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2392 $version =~ s/(\.[^.]+)\./$1/g;
2394 if ( $software eq 'mod_perl' ) {
2398 if ( $version >= 1.99922 ) {
2399 $engine = 'Catalyst::Engine::Apache2::MP20';
2402 elsif ( $version >= 1.9901 ) {
2403 $engine = 'Catalyst::Engine::Apache2::MP19';
2406 elsif ( $version >= 1.24 ) {
2407 $engine = 'Catalyst::Engine::Apache::MP13';
2411 Catalyst::Exception->throw( message =>
2412 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2417 # install the correct mod_perl handler
2418 if ( $version >= 1.9901 ) {
2419 *handler = sub : method {
2420 shift->handle_request(@_);
2424 *handler = sub ($$) { shift->handle_request(@_) };
2429 elsif ( $software eq 'Zeus-Perl' ) {
2430 $engine = 'Catalyst::Engine::Zeus';
2434 Catalyst::Exception->throw(
2435 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2440 $engine = $class->engine_class;
2443 Class::MOP::load_class($engine);
2445 # check for old engines that are no longer compatible
2447 if ( $engine->isa('Catalyst::Engine::Apache')
2448 && !Catalyst::Engine::Apache->VERSION )
2453 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2454 && Catalyst::Engine::Server->VERSION le '0.02' )
2459 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2460 && $engine->VERSION eq '0.01' )
2465 elsif ($engine->isa('Catalyst::Engine::Zeus')
2466 && $engine->VERSION eq '0.01' )
2472 Catalyst::Exception->throw( message =>
2473 qq/Engine "$engine" is not supported by this version of Catalyst/
2478 $class->engine( $engine->new );
2481 =head2 $c->setup_home
2483 Sets up the home directory.
2488 my ( $class, $home ) = @_;
2490 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2494 $home ||= Catalyst::Utils::home($class);
2497 #I remember recently being scolded for assigning config values like this
2498 $class->config->{home} ||= $home;
2499 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2503 =head2 $c->setup_log
2505 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2506 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2509 This method also installs a C<debug> method that returns a true value into the
2510 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2511 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2513 Note that if the log has already been setup, by either a previous call to
2514 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2515 that this method won't actually set up the log object.
2520 my ( $class, $levels ) = @_;
2523 $levels =~ s/^\s+//;
2524 $levels =~ s/\s+$//;
2525 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2527 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2528 if ( defined $env_debug ) {
2529 $levels{debug} = 1 if $env_debug; # Ugly!
2530 delete($levels{debug}) unless $env_debug;
2533 unless ( $class->log ) {
2534 $class->log( Catalyst::Log->new(keys %levels) );
2537 if ( $levels{debug} ) {
2538 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2539 $class->log->debug('Debug messages enabled');
2543 =head2 $c->setup_plugins
2549 =head2 $c->setup_stats
2551 Sets up timing statistics class.
2556 my ( $class, $stats ) = @_;
2558 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2560 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2561 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2562 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2563 $class->log->debug('Statistics enabled');
2568 =head2 $c->registered_plugins
2570 Returns a sorted list of the plugins which have either been stated in the
2571 import list or which have been added via C<< MyApp->plugin(@args); >>.
2573 If passed a given plugin name, it will report a boolean value indicating
2574 whether or not that plugin is loaded. A fully qualified name is required if
2575 the plugin name does not begin with C<Catalyst::Plugin::>.
2577 if ($c->registered_plugins('Some::Plugin')) {
2585 sub registered_plugins {
2587 return sort keys %{ $proto->_plugins } unless @_;
2589 return 1 if exists $proto->_plugins->{$plugin};
2590 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2593 sub _register_plugin {
2594 my ( $proto, $plugin, $instant ) = @_;
2595 my $class = ref $proto || $proto;
2597 Class::MOP::load_class( $plugin );
2598 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2599 if $plugin->isa( 'Catalyst::Component' );
2600 $proto->_plugins->{$plugin} = 1;
2602 my $meta = Class::MOP::get_metaclass_by_name($class);
2603 $meta->superclasses($plugin, $meta->superclasses);
2609 my ( $class, $plugins ) = @_;
2611 $class->_plugins( {} ) unless $class->_plugins;
2612 $plugins = Data::OptList::mkopt($plugins || []);
2615 [ Catalyst::Utils::resolve_namespace(
2616 $class . '::Plugin',
2617 'Catalyst::Plugin', $_->[0]
2623 for my $plugin ( reverse @plugins ) {
2624 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2625 my $meta = find_meta($plugin->[0]);
2626 next if $meta && $meta->isa('Moose::Meta::Role');
2628 $class->_register_plugin($plugin->[0]);
2632 map { $_->[0]->name, $_->[1] }
2633 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2634 map { [find_meta($_->[0]), $_->[1]] }
2637 Moose::Util::apply_all_roles(
2645 Returns an arrayref of the internal execution stack (actions that are
2646 currently executing).
2650 Returns the current timing statistics object. By default Catalyst uses
2651 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2652 L<< stats_class|/"$c->stats_class" >>.
2654 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2655 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2656 profile explicitly, although MyApp.pm still won't profile nor output anything
2659 =head2 $c->stats_class
2661 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2663 =head2 $c->use_stats
2665 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2667 Note that this is a static method, not an accessor and should be overridden
2668 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2675 =head2 $c->write( $data )
2677 Writes $data to the output stream. When using this method directly, you
2678 will need to manually set the C<Content-Length> header to the length of
2679 your output data, if known.
2686 # Finalize headers if someone manually writes output
2687 $c->finalize_headers;
2689 return $c->engine->write( $c, @_ );
2694 Returns the Catalyst version number. Mostly useful for "powered by"
2695 messages in template systems.
2699 sub version { return $Catalyst::VERSION }
2701 =head1 CONFIGURATION
2703 There are a number of 'base' config variables which can be set:
2709 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2713 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2717 C<home> - The application home directory. In an uninstalled application,
2718 this is the top level application directory. In an installed application,
2719 this will be the directory containing C<< MyApp.pm >>.
2723 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2727 C<name> - The name of the application in debug messages and the debug and
2732 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2733 until it is accessed. This allows you to (for example) check authentication (and reject
2734 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2738 C<root> - The root directory for templates. Usually this is just a
2739 subdirectory of the home directory, but you can set it to change the
2740 templates to a different directory.
2744 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2745 to be shown in hit debug tables in the test server.
2749 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2750 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2751 for more information.
2755 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2759 =head1 INTERNAL ACTIONS
2761 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2762 C<_ACTION>, and C<_END>. These are by default not shown in the private
2763 action table, but you can make them visible with a config parameter.
2765 MyApp->config(show_internal_actions => 1);
2767 =head1 ON-DEMAND PARSER
2769 The request body is usually parsed at the beginning of a request,
2770 but if you want to handle input yourself, you can enable on-demand
2771 parsing with a config parameter.
2773 MyApp->config(parse_on_demand => 1);
2775 =head1 PROXY SUPPORT
2777 Many production servers operate using the common double-server approach,
2778 with a lightweight frontend web server passing requests to a larger
2779 backend server. An application running on the backend server must deal
2780 with two problems: the remote user always appears to be C<127.0.0.1> and
2781 the server's hostname will appear to be C<localhost> regardless of the
2782 virtual host that the user connected through.
2784 Catalyst will automatically detect this situation when you are running
2785 the frontend and backend servers on the same machine. The following
2786 changes are made to the request.
2788 $c->req->address is set to the user's real IP address, as read from
2789 the HTTP X-Forwarded-For header.
2791 The host value for $c->req->base and $c->req->uri is set to the real
2792 host, as read from the HTTP X-Forwarded-Host header.
2794 Additionally, you may be running your backend application on an insecure
2795 connection (port 80) while your frontend proxy is running under SSL. If there
2796 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2797 tell Catalyst what port the frontend listens on. This will allow all URIs to
2798 be created properly.
2800 In the case of passing in:
2802 X-Forwarded-Port: 443
2804 All calls to C<uri_for> will result in an https link, as is expected.
2806 Obviously, your web server must support these headers for this to work.
2808 In a more complex server farm environment where you may have your
2809 frontend proxy server(s) on different machines, you will need to set a
2810 configuration option to tell Catalyst to read the proxied data from the
2813 MyApp->config(using_frontend_proxy => 1);
2815 If you do not wish to use the proxy support at all, you may set:
2817 MyApp->config(ignore_frontend_proxy => 1);
2819 =head1 THREAD SAFETY
2821 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2822 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2823 believe the Catalyst core to be thread-safe.
2825 If you plan to operate in a threaded environment, remember that all other
2826 modules you are using must also be thread-safe. Some modules, most notably
2827 L<DBD::SQLite>, are not thread-safe.
2833 Join #catalyst on irc.perl.org.
2837 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2838 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2842 http://catalyst.perl.org
2846 http://dev.catalyst.perl.org
2850 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2852 =head2 L<Catalyst::Manual> - The Catalyst Manual
2854 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2856 =head2 L<Catalyst::Engine> - Core engine
2858 =head2 L<Catalyst::Log> - Log class.
2860 =head2 L<Catalyst::Request> - Request object
2862 =head2 L<Catalyst::Response> - Response object
2864 =head2 L<Catalyst::Test> - The test suite.
2866 =head1 PROJECT FOUNDER
2868 sri: Sebastian Riedel <sri@cpan.org>
2874 acme: Leon Brocard <leon@astray.com>
2876 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2880 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2886 andyg: Andy Grundman <andy@hybridized.org>
2888 audreyt: Audrey Tang
2890 bricas: Brian Cassidy <bricas@cpan.org>
2892 Caelum: Rafael Kitover <rkitover@io.com>
2894 chansen: Christian Hansen
2896 chicks: Christopher Hicks
2898 Chisel Wright C<pause@herlpacker.co.uk>
2900 Danijel Milicevic C<me@danijel.de>
2902 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2904 David Naughton, C<naughton@umn.edu>
2908 dhoss: Devin Austin <dhoss@cpan.org>
2910 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2914 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2916 esskar: Sascha Kiefer
2918 fireartist: Carl Franks <cfranks@cpan.org>
2920 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2922 gabb: Danijel Milicevic
2926 Gavin Henry C<ghenry@perl.me.uk>
2930 groditi: Guillermo Roditi <groditi@gmail.com>
2932 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2934 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2936 jcamacho: Juan Camacho
2938 jester: Jesse Sheidlower C<jester@panix.com>
2940 jhannah: Jay Hannah <jay@jays.net>
2946 jon: Jon Schutz <jjschutz@cpan.org>
2948 Jonathan Rockway C<< <jrockway@cpan.org> >>
2950 Kieren Diment C<kd@totaldatasolution.com>
2952 konobi: Scott McWhirter <konobi@cpan.org>
2954 marcus: Marcus Ramberg <mramberg@cpan.org>
2956 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2958 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2962 naughton: David Naughton
2964 ningu: David Kamholz <dkamholz@cpan.org>
2966 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2968 numa: Dan Sully <daniel@cpan.org>
2974 omega: Andreas Marienborg
2976 Oleg Kostyuk <cub.uanic@gmail.com>
2978 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2980 rafl: Florian Ragwitz <rafl@debian.org>
2982 random: Roland Lammel <lammel@cpan.org>
2984 Robert Sedlacek C<< <rs@474.at> >>
2986 SpiceMan: Marcel Montes
2990 szbalint: Balint Szilakszi <szbalint@cpan.org>
2992 t0m: Tomas Doran <bobtfish@bobtfish.net>
2996 Viljo Marrandi C<vilts@yahoo.com>
2998 Will Hawes C<info@whawes.co.uk>
3000 willert: Sebastian Willert <willert@cpan.org>
3002 wreis: Wallace Reis <wallace@reis.org.br>
3004 Yuval Kogman, C<nothingmuch@woobling.org>
3006 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3008 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3012 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3016 This library is free software. You can redistribute it and/or modify it under
3017 the same terms as Perl itself.
3023 __PACKAGE__->meta->make_immutable;