4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
8 use B::Hooks::EndOfScope ();
9 use Catalyst::Exception;
10 use Catalyst::Exception::Detach;
11 use Catalyst::Exception::Go;
13 use Catalyst::Request;
14 use Catalyst::Request::Upload;
15 use Catalyst::Response;
17 use Catalyst::Controller;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
32 use Carp qw/croak carp shortmess/;
34 BEGIN { require 5.008001; }
36 has stack => (is => 'ro', default => sub { [] });
37 has stash => (is => 'rw', default => sub { {} });
38 has state => (is => 'rw', default => 0);
39 has stats => (is => 'rw');
40 has action => (is => 'rw');
41 has counter => (is => 'rw', default => sub { {} });
42 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
43 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
44 has namespace => (is => 'rw');
46 sub depth { scalar @{ shift->stack || [] }; }
47 sub comp { shift->component(@_) }
50 my $self = shift; return $self->request(@_);
53 my $self = shift; return $self->response(@_);
56 # For backwards compatibility
57 sub finalize_output { shift->finalize_body(@_) };
62 our $RECURSION = 1000;
63 our $DETACH = Catalyst::Exception::Detach->new;
64 our $GO = Catalyst::Exception::Go->new;
66 #I imagine that very few of these really need to be class variables. if any.
67 #maybe we should just make them attributes with a default?
68 __PACKAGE__->mk_classdata($_)
69 for qw/components arguments dispatcher engine log dispatcher_class
70 engine_class context_class request_class response_class stats_class
73 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
74 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
75 __PACKAGE__->request_class('Catalyst::Request');
76 __PACKAGE__->response_class('Catalyst::Response');
77 __PACKAGE__->stats_class('Catalyst::Stats');
79 # Remember to update this in Catalyst::Runtime as well!
81 our $VERSION = '5.80007';
84 my $dev_version = $VERSION =~ /_\d{2}$/;
85 *_IS_DEVELOPMENT_VERSION = sub () { $dev_version };
88 $VERSION = eval $VERSION;
91 my ( $class, @arguments ) = @_;
93 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
95 return unless $class eq 'Catalyst';
97 my $caller = caller();
98 return if $caller eq 'main';
100 # Kill Adopt::NEXT warnings if we're a non-RC version
101 unless (_IS_DEVELOPMENT_VERSION()) {
102 Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/);
105 my $meta = Moose::Meta::Class->initialize($caller);
106 unless ( $caller->isa('Catalyst') ) {
107 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
108 $meta->superclasses(@superclasses);
110 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
111 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
113 unless( $meta->has_method('meta') ){
114 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
117 $caller->arguments( [@arguments] );
121 sub _application { $_[0] }
125 Catalyst - The Elegant MVC Web Application Framework
129 See the L<Catalyst::Manual> distribution for comprehensive
130 documentation and tutorials.
132 # Install Catalyst::Devel for helpers and other development tools
133 # use the helper to create a new application
136 # add models, views, controllers
137 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
138 script/myapp_create.pl view MyTemplate TT
139 script/myapp_create.pl controller Search
141 # built in testserver -- use -r to restart automatically on changes
142 # --help to see all available options
143 script/myapp_server.pl
145 # command line testing interface
146 script/myapp_test.pl /yada
149 use Catalyst qw/-Debug/; # include plugins here as well
151 ### In lib/MyApp/Controller/Root.pm (autocreated)
152 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
153 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
154 $c->stash->{template} = 'foo.tt'; # set the template
155 # lookup something from db -- stash vars are passed to TT
157 $c->model('Database::Foo')->search( { country => $args[0] } );
158 if ( $c->req->params->{bar} ) { # access GET or POST parameters
159 $c->forward( 'bar' ); # process another action
160 # do something else after forward returns
164 # The foo.tt TT template can use the stash data from the database
165 [% WHILE (item = data.next) %]
169 # called for /bar/of/soap, /bar/of/soap/10, etc.
170 sub bar : Path('/bar/of/soap') { ... }
172 # called for all actions, from the top-most controller downwards
174 my ( $self, $c ) = @_;
175 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
176 $c->res->redirect( '/login' ); # require login
177 return 0; # abort request and go immediately to end()
179 return 1; # success; carry on to next action
182 # called after all actions are finished
184 my ( $self, $c ) = @_;
185 if ( scalar @{ $c->error } ) { ... } # handle errors
186 return if $c->res->body; # already have a response
187 $c->forward( 'MyApp::View::TT' ); # render template
190 ### in MyApp/Controller/Foo.pm
191 # called for /foo/bar
192 sub bar : Local { ... }
194 # called for /blargle
195 sub blargle : Global { ... }
197 # an index action matches /foo, but not /foo/1, etc.
198 sub index : Private { ... }
200 ### in MyApp/Controller/Foo/Bar.pm
201 # called for /foo/bar/baz
202 sub baz : Local { ... }
204 # first Root auto is called, then Foo auto, then this
205 sub auto : Private { ... }
207 # powerful regular expression paths are also possible
208 sub details : Regex('^product/(\w+)/details$') {
209 my ( $self, $c ) = @_;
210 # extract the (\w+) from the URI
211 my $product = $c->req->captures->[0];
214 See L<Catalyst::Manual::Intro> for additional information.
218 Catalyst is a modern framework for making web applications without the
219 pain usually associated with this process. This document is a reference
220 to the main Catalyst application. If you are a new user, we suggest you
221 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
223 See L<Catalyst::Manual> for more documentation.
225 Catalyst plugins can be loaded by naming them as arguments to the "use
226 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
227 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
230 use Catalyst qw/My::Module/;
232 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
233 fully qualify the name by using a unary plus:
237 +Fully::Qualified::Plugin::Name
240 Special flags like C<-Debug> and C<-Engine> can also be specified as
241 arguments when Catalyst is loaded:
243 use Catalyst qw/-Debug My::Module/;
245 The position of plugins and flags in the chain is important, because
246 they are loaded in the order in which they appear.
248 The following flags are supported:
252 Enables debug output. You can also force this setting from the system
253 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
254 settings override the application, with <MYAPP>_DEBUG having the highest
259 Forces Catalyst to use a specific engine. Omit the
260 C<Catalyst::Engine::> prefix of the engine name, i.e.:
262 use Catalyst qw/-Engine=CGI/;
266 Forces Catalyst to use a specific home directory, e.g.:
268 use Catalyst qw[-Home=/usr/mst];
270 This can also be done in the shell environment by setting either the
271 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
272 is replaced with the uppercased name of your application, any "::" in
273 the name will be replaced with underscores, e.g. MyApp::Web should use
274 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
278 use Catalyst '-Log=warn,fatal,error';
280 Specifies a comma-delimited list of log levels.
284 Enables statistics collection and reporting. You can also force this setting
285 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
286 environment settings override the application, with <MYAPP>_STATS having the
291 use Catalyst qw/-Stats=1/
295 =head2 INFORMATION ABOUT THE CURRENT REQUEST
299 Returns a L<Catalyst::Action> object for the current action, which
300 stringifies to the action name. See L<Catalyst::Action>.
304 Returns the namespace of the current action, i.e., the URI prefix
305 corresponding to the controller of the current action. For example:
307 # in Controller::Foo::Bar
308 $c->namespace; # returns 'foo/bar';
314 Returns the current L<Catalyst::Request> object, giving access to
315 information about the current client request (including parameters,
316 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
318 =head2 REQUEST FLOW HANDLING
320 =head2 $c->forward( $action [, \@arguments ] )
322 =head2 $c->forward( $class, $method, [, \@arguments ] )
324 Forwards processing to another action, by its private name. If you give a
325 class name but no method, C<process()> is called. You may also optionally
326 pass arguments in an arrayref. The action will receive the arguments in
327 C<@_> and C<< $c->req->args >>. Upon returning from the function,
328 C<< $c->req->args >> will be restored to the previous values.
330 Any data C<return>ed from the action forwarded to, will be returned by the
333 my $foodata = $c->forward('/foo');
334 $c->forward('index');
335 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
336 $c->forward('MyApp::View::TT');
338 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
339 an C<< eval { } >> around the call (actually
340 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
341 all 'dies' within the called action. If you want C<die> to propagate you
342 need to do something like:
345 die $c->error if $c->error;
347 Or make sure to always return true values from your actions and write
350 $c->forward('foo') || return;
354 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
356 =head2 $c->detach( $action [, \@arguments ] )
358 =head2 $c->detach( $class, $method, [, \@arguments ] )
362 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
363 doesn't return to the previous action when processing is finished.
365 When called with no arguments it escapes the processing chain entirely.
369 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
371 =head2 $c->visit( $action [, \@captures, \@arguments ] )
373 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
375 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
376 but does a full dispatch, instead of just calling the new C<$action> /
377 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
378 you go to are called, just like a new request.
380 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
381 This means, for example, that C<< $c->action >> methods such as
382 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
383 L<reverse|Catalyst::Action/reverse> return information for the visited action
384 when they are invoked within the visited action. This is different from the
385 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
386 continues to use the $c->action object from the caller action even when
387 invoked from the callee.
389 C<< $c->stash >> is kept unchanged.
391 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
392 allows you to "wrap" another action, just as it would have been called by
393 dispatching from a URL, while the analogous
394 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
395 transfer control to another action as if it had been reached directly from a URL.
399 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
401 =head2 $c->go( $action [, \@captures, \@arguments ] )
403 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
405 Almost the same as L<< detach|/"$c->detach( $action [, \@arguments ] )" >>, but does a full dispatch like L</visit>,
406 instead of just calling the new C<$action> /
407 C<< $class->$method >>. This means that C<begin>, C<auto> and the
408 method you visit are called, just like a new request.
410 C<< $c->stash >> is kept unchanged.
414 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
420 Returns the current L<Catalyst::Response> object, see there for details.
424 Returns a hashref to the stash, which may be used to store data and pass
425 it between components during a request. You can also set hash keys by
426 passing arguments. The stash is automatically sent to the view. The
427 stash is cleared at the end of a request; it cannot be used for
428 persistent storage (for this you must use a session; see
429 L<Catalyst::Plugin::Session> for a complete system integrated with
432 $c->stash->{foo} = $bar;
433 $c->stash( { moose => 'majestic', qux => 0 } );
434 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
436 # stash is automatically passed to the view for use in a template
437 $c->forward( 'MyApp::View::TT' );
441 around stash => sub {
444 my $stash = $orig->($c);
446 my $new_stash = @_ > 1 ? {@_} : $_[0];
447 croak('stash takes a hash or hashref') unless ref $new_stash;
448 foreach my $key ( keys %$new_stash ) {
449 $stash->{$key} = $new_stash->{$key};
459 =head2 $c->error($error, ...)
461 =head2 $c->error($arrayref)
463 Returns an arrayref containing error messages. If Catalyst encounters an
464 error while processing a request, it stores the error in $c->error. This
465 method should only be used to store fatal error messages.
467 my @error = @{ $c->error };
471 $c->error('Something bad happened');
478 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
479 croak @$error unless ref $c;
480 push @{ $c->{error} }, @$error;
482 elsif ( defined $_[0] ) { $c->{error} = undef }
483 return $c->{error} || [];
489 Contains the return value of the last executed action.
491 =head2 $c->clear_errors
493 Clear errors. You probably don't want to clear the errors unless you are
494 implementing a custom error screen.
496 This is equivalent to running
507 sub _comp_search_prefixes {
509 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
512 # search components given a name and some prefixes
513 sub _comp_names_search_prefixes {
514 my ( $c, $name, @prefixes ) = @_;
515 my $appclass = ref $c || $c;
516 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
517 $filter = qr/$filter/; # Compile regex now rather than once per loop
519 # map the original component name to the sub part that we will search against
520 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
521 grep { /$filter/ } keys %{ $c->components };
523 # undef for a name will return all
524 return keys %eligible if !defined $name;
526 my $query = ref $name ? $name : qr/^$name$/i;
527 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
529 return @result if @result;
531 # if we were given a regexp to search against, we're done.
536 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
538 # no results? try against full names
540 @result = grep { m{$query} } keys %eligible;
543 # don't warn if we didn't find any results, it just might not exist
545 # Disgusting hack to work out correct method name
546 my $warn_for = lc $prefixes[0];
547 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
548 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
549 "component resolution is unreliable and unsafe.";
550 my $short = $result[0];
551 $short =~ s/.*?Model:://;
552 my $shortmess = Carp::shortmess('');
553 if ($shortmess =~ m#Catalyst/Plugin#) {
554 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
556 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
557 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
558 "component's config";
560 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
561 "but if you really wanted to search, pass in a regexp as the argument " .
562 "like so: \$c->${warn_for}(qr/${name}/)";
564 $c->log->warn( "${msg}$shortmess" );
570 # Find possible names for a prefix
572 my ( $c, @prefixes ) = @_;
573 my $appclass = ref $c || $c;
575 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
577 my @names = map { s{$filter}{}; $_; }
578 $c->_comp_names_search_prefixes( undef, @prefixes );
583 # Filter a component before returning by calling ACCEPT_CONTEXT if available
584 sub _filter_component {
585 my ( $c, $comp, @args ) = @_;
587 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
588 return $comp->ACCEPT_CONTEXT( $c, @args );
594 =head2 COMPONENT ACCESSORS
596 =head2 $c->controller($name)
598 Gets a L<Catalyst::Controller> instance by name.
600 $c->controller('Foo')->do_stuff;
602 If the name is omitted, will return the controller for the dispatched
605 If you want to search for controllers, pass in a regexp as the argument.
607 # find all controllers that start with Foo
608 my @foo_controllers = $c->controller(qr{^Foo});
614 my ( $c, $name, @args ) = @_;
617 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
618 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
619 return $c->_filter_component( $result[ 0 ], @args );
622 return $c->component( $c->action->class );
625 =head2 $c->model($name)
627 Gets a L<Catalyst::Model> instance by name.
629 $c->model('Foo')->do_stuff;
631 Any extra arguments are directly passed to ACCEPT_CONTEXT.
633 If the name is omitted, it will look for
634 - a model object in $c->stash->{current_model_instance}, then
635 - a model name in $c->stash->{current_model}, then
636 - a config setting 'default_model', or
637 - check if there is only one model, and return it if that's the case.
639 If you want to search for models, pass in a regexp as the argument.
641 # find all models that start with Foo
642 my @foo_models = $c->model(qr{^Foo});
647 my ( $c, $name, @args ) = @_;
650 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
651 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
652 return $c->_filter_component( $result[ 0 ], @args );
656 return $c->stash->{current_model_instance}
657 if $c->stash->{current_model_instance};
658 return $c->model( $c->stash->{current_model} )
659 if $c->stash->{current_model};
661 return $c->model( $c->config->{default_model} )
662 if $c->config->{default_model};
664 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
667 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
668 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
669 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
670 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
671 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
674 return $c->_filter_component( $comp );
678 =head2 $c->view($name)
680 Gets a L<Catalyst::View> instance by name.
682 $c->view('Foo')->do_stuff;
684 Any extra arguments are directly passed to ACCEPT_CONTEXT.
686 If the name is omitted, it will look for
687 - a view object in $c->stash->{current_view_instance}, then
688 - a view name in $c->stash->{current_view}, then
689 - a config setting 'default_view', or
690 - check if there is only one view, and return it if that's the case.
692 If you want to search for views, pass in a regexp as the argument.
694 # find all views that start with Foo
695 my @foo_views = $c->view(qr{^Foo});
700 my ( $c, $name, @args ) = @_;
703 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
704 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
705 return $c->_filter_component( $result[ 0 ], @args );
709 return $c->stash->{current_view_instance}
710 if $c->stash->{current_view_instance};
711 return $c->view( $c->stash->{current_view} )
712 if $c->stash->{current_view};
714 return $c->view( $c->config->{default_view} )
715 if $c->config->{default_view};
717 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
720 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
721 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
722 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
723 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
724 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
727 return $c->_filter_component( $comp );
730 =head2 $c->controllers
732 Returns the available names which can be passed to $c->controller
738 return $c->_comp_names(qw/Controller C/);
743 Returns the available names which can be passed to $c->model
749 return $c->_comp_names(qw/Model M/);
755 Returns the available names which can be passed to $c->view
761 return $c->_comp_names(qw/View V/);
764 =head2 $c->comp($name)
766 =head2 $c->component($name)
768 Gets a component object by name. This method is not recommended,
769 unless you want to get a specific component by full
770 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
771 should be used instead.
773 If C<$name> is a regexp, a list of components matched against the full
774 component name will be returned.
779 my ( $c, $name, @args ) = @_;
782 my $comps = $c->components;
785 # is it the exact name?
786 return $c->_filter_component( $comps->{ $name }, @args )
787 if exists $comps->{ $name };
789 # perhaps we just omitted "MyApp"?
790 my $composed = ( ref $c || $c ) . "::${name}";
791 return $c->_filter_component( $comps->{ $composed }, @args )
792 if exists $comps->{ $composed };
794 # search all of the models, views and controllers
795 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
796 return $c->_filter_component( $comp, @args ) if $comp;
799 # This is here so $c->comp( '::M::' ) works
800 my $query = ref $name ? $name : qr{$name}i;
802 my @result = grep { m{$query} } keys %{ $c->components };
803 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
806 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
807 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
808 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
809 return $c->_filter_component( $result[ 0 ], @args );
812 # I would expect to return an empty list here, but that breaks back-compat
816 return sort keys %{ $c->components };
819 =head2 CLASS DATA AND HELPER CLASSES
823 Returns or takes a hashref containing the application's configuration.
825 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
827 You can also use a C<YAML>, C<XML> or L<Config::General> config file
828 like C<myapp.conf> in your applications home directory. See
829 L<Catalyst::Plugin::ConfigLoader>.
831 =head3 Cascading configuration
833 The config method is present on all Catalyst components, and configuration
834 will be merged when an application is started. Configuration loaded with
835 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
836 followed by configuration in your top level C<MyApp> class. These two
837 configurations are merged, and then configuration data whose hash key matches a
838 component name is merged with configuration for that component.
840 The configuration for a component is then passed to the C<new> method when a
841 component is constructed.
845 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
846 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
848 will mean that C<MyApp::Model::Foo> receives the following data when
851 MyApp::Model::Foo->new({
859 around config => sub {
863 croak('Setting config after setup has been run is not allowed.')
864 if ( @_ and $c->setup_finished );
871 Returns the logging object instance. Unless it is already set, Catalyst
872 sets this up with a L<Catalyst::Log> object. To use your own log class,
873 set the logger with the C<< __PACKAGE__->log >> method prior to calling
874 C<< __PACKAGE__->setup >>.
876 __PACKAGE__->log( MyLogger->new );
881 $c->log->info( 'Now logging with my own logger!' );
883 Your log class should implement the methods described in
889 Returns 1 if debug mode is enabled, 0 otherwise.
891 You can enable debug mode in several ways:
895 =item By calling myapp_server.pl with the -d flag
897 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
899 =item The -Debug option in your MyApp.pm
901 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
905 Calling C<< $c->debug(1) >> has no effect.
911 =head2 $c->dispatcher
913 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
917 Returns the engine instance. See L<Catalyst::Engine>.
920 =head2 UTILITY METHODS
922 =head2 $c->path_to(@path)
924 Merges C<@path> with C<< $c->config->{home} >> and returns a
925 L<Path::Class::Dir> object. Note you can usually use this object as
926 a filename, but sometimes you will have to explicitly stringify it
927 yourself by calling the C<< ->stringify >> method.
931 $c->path_to( 'db', 'sqlite.db' );
936 my ( $c, @path ) = @_;
937 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
938 if ( -d $path ) { return $path }
939 else { return Path::Class::File->new( $c->config->{home}, @path ) }
942 =head2 $c->plugin( $name, $class, @args )
944 Helper method for plugins. It creates a class data accessor/mutator and
945 loads and instantiates the given class.
947 MyApp->plugin( 'prototype', 'HTML::Prototype' );
949 $c->prototype->define_javascript_functions;
951 B<Note:> This method of adding plugins is deprecated. The ability
952 to add plugins like this B<will be removed> in a Catalyst 5.81.
953 Please do not use this functionality in new code.
958 my ( $class, $name, $plugin, @args ) = @_;
960 # See block comment in t/unit_core_plugin.t
961 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
963 $class->_register_plugin( $plugin, 1 );
965 eval { $plugin->import };
966 $class->mk_classdata($name);
968 eval { $obj = $plugin->new(@args) };
971 Catalyst::Exception->throw( message =>
972 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
976 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
982 Initializes the dispatcher and engine, loads any plugins, and loads the
983 model, view, and controller components. You may also specify an array
984 of plugins to load here, if you choose to not load them in the C<use
988 MyApp->setup( qw/-Debug/ );
993 my ( $class, @arguments ) = @_;
994 croak('Running setup more than once')
995 if ( $class->setup_finished );
997 unless ( $class->isa('Catalyst') ) {
999 Catalyst::Exception->throw(
1000 message => qq/'$class' does not inherit from Catalyst/ );
1003 if ( $class->arguments ) {
1004 @arguments = ( @arguments, @{ $class->arguments } );
1010 foreach (@arguments) {
1014 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1016 elsif (/^-(\w+)=?(.*)$/) {
1017 $flags->{ lc $1 } = $2;
1020 push @{ $flags->{plugins} }, $_;
1024 $class->setup_home( delete $flags->{home} );
1026 $class->setup_log( delete $flags->{log} );
1027 $class->setup_plugins( delete $flags->{plugins} );
1028 $class->setup_dispatcher( delete $flags->{dispatcher} );
1029 $class->setup_engine( delete $flags->{engine} );
1030 $class->setup_stats( delete $flags->{stats} );
1032 for my $flag ( sort keys %{$flags} ) {
1034 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1035 &$code( $class, delete $flags->{$flag} );
1038 $class->log->warn(qq/Unknown flag "$flag"/);
1042 eval { require Catalyst::Devel; };
1043 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1044 $class->log->warn(<<"EOF");
1045 You are running an old script!
1047 Please update by running (this will overwrite existing files):
1048 catalyst.pl -force -scripts $class
1050 or (this will not overwrite existing files):
1051 catalyst.pl -scripts $class
1056 if ( $class->debug ) {
1057 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1060 my $column_width = Catalyst::Utils::term_width() - 6;
1061 my $t = Text::SimpleTable->new($column_width);
1062 $t->row($_) for @plugins;
1063 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1066 my $dispatcher = $class->dispatcher;
1067 my $engine = $class->engine;
1068 my $home = $class->config->{home};
1070 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1071 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1075 ? $class->log->debug(qq/Found home "$home"/)
1076 : $class->log->debug(qq/Home "$home" doesn't exist/)
1077 : $class->log->debug(q/Couldn't find home/);
1080 # Call plugins setup, this is stupid and evil.
1081 # Also screws C3 badly on 5.10, hack to avoid.
1083 no warnings qw/redefine/;
1084 local *setup = sub { };
1085 $class->setup unless $Catalyst::__AM_RESTARTING;
1088 # Initialize our data structure
1089 $class->components( {} );
1091 $class->setup_components;
1093 if ( $class->debug ) {
1094 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1095 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1096 for my $comp ( sort keys %{ $class->components } ) {
1097 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1098 $t->row( $comp, $type );
1100 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1101 if ( keys %{ $class->components } );
1104 # Add our self to components, since we are also a component
1105 if( $class->isa('Catalyst::Controller') ){
1106 $class->components->{$class} = $class;
1109 $class->setup_actions;
1111 if ( $class->debug ) {
1112 my $name = $class->config->{name} || 'Application';
1113 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1115 $class->log->_flush() if $class->log->can('_flush');
1117 # Make sure that the application class becomes immutable at this point,
1118 B::Hooks::EndOfScope::on_scope_end {
1120 my $meta = Class::MOP::get_metaclass_by_name($class);
1123 && ! { $meta->immutable_options }->{replace_constructor}
1125 $class->isa('Class::Accessor::Fast')
1126 || $class->isa('Class::Accessor')
1129 warn "You made your application class ($class) immutable, "
1130 . "but did not inline the\nconstructor. "
1131 . "This will break catalyst, as your app \@ISA "
1132 . "Class::Accessor(::Fast)?\nPlease pass "
1133 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1135 $meta->make_immutable(replace_constructor => 1)
1136 unless $meta->is_immutable;
1139 $class->setup_finalize;
1143 =head2 $app->setup_finalize
1145 A hook to attach modifiers to.
1146 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1147 Also better than C< setup_finished(); >, as that is a getter method.
1149 sub setup_finalize {
1153 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1155 $app->next::method(@_);
1162 sub setup_finalize {
1164 $class->setup_finished(1);
1167 =head2 $c->uri_for( $path, @args?, \%query_values? )
1169 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1171 Constructs an absolute L<URI> object based on the application root, the
1172 provided path, and the additional arguments and query parameters provided.
1173 When used as a string, provides a textual URI.
1175 If the first argument is a string, it is taken as a public URI path relative
1176 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1177 relative to the application root (if it does). It is then merged with
1178 C<< $c->request->base >>; any C<@args> are appended as additional path
1179 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1181 If the first argument is a L<Catalyst::Action> it represents an action which
1182 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1183 optional C<\@captures> argument (an arrayref) allows passing the captured
1184 variables that are needed to fill in the paths of Chained and Regex actions;
1185 once the path is resolved, C<uri_for> continues as though a path was
1186 provided, appending any arguments or parameters and creating an absolute
1189 The captures for the current request can be found in
1190 C<< $c->request->captures >>, and actions can be resolved using
1191 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1192 path, use C<< $c->uri_for_action >> instead.
1194 # Equivalent to $c->req->uri
1195 $c->uri_for($c->action, $c->req->captures,
1196 @{ $c->req->args }, $c->req->params);
1198 # For the Foo action in the Bar controller
1199 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1201 # Path to a static resource
1202 $c->uri_for('/static/images/logo.png');
1207 my ( $c, $path, @args ) = @_;
1209 if ( blessed($path) ) { # action object
1210 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
1214 $path = $c->dispatcher->uri_for_action($action, $captures);
1215 if (not defined $path) {
1216 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1220 $path = '/' if $path eq '';
1223 undef($path) if (defined $path && $path eq '');
1226 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1228 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1229 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1231 unshift(@args, $path);
1233 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1234 my $namespace = $c->namespace;
1235 if (defined $path) { # cheesy hack to handle path '../foo'
1236 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1238 unshift(@args, $namespace || '');
1241 # join args with '/', or a blank string
1242 my $args = join('/', grep { defined($_) } @args);
1243 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1245 my $base = $c->req->base;
1246 my $class = ref($base);
1247 $base =~ s{(?<!/)$}{/};
1251 if (my @keys = keys %$params) {
1252 # somewhat lifted from URI::_query's query_form
1253 $query = '?'.join('&', map {
1254 my $val = $params->{$_};
1255 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1258 $val = '' unless defined $val;
1261 utf8::encode( $param ) if utf8::is_utf8($param);
1262 # using the URI::Escape pattern here so utf8 chars survive
1263 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1265 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1269 my $res = bless(\"${base}${args}${query}", $class);
1273 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1275 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1281 A private path to the Catalyst action you want to create a URI for.
1283 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1284 >> and passing the resulting C<$action> and the remaining arguments to C<<
1287 You can also pass in a Catalyst::Action object, in which case it is passed to
1294 sub uri_for_action {
1295 my ( $c, $path, @args ) = @_;
1296 my $action = blessed($path)
1298 : $c->dispatcher->get_action_by_path($path);
1299 unless (defined $action) {
1300 croak "Can't find action for path '$path'";
1302 return $c->uri_for( $action, @args );
1305 =head2 $c->welcome_message
1307 Returns the Catalyst welcome HTML page.
1311 sub welcome_message {
1313 my $name = $c->config->{name};
1314 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1315 my $prefix = Catalyst::Utils::appprefix( ref $c );
1316 $c->response->content_type('text/html; charset=utf-8');
1318 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1319 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1320 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1322 <meta http-equiv="Content-Language" content="en" />
1323 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1324 <title>$name on Catalyst $VERSION</title>
1325 <style type="text/css">
1328 background-color: #eee;
1335 margin-bottom: 10px;
1337 background-color: #ccc;
1338 border: 1px solid #aaa;
1343 font-family: verdana, tahoma, sans-serif;
1346 font-family: verdana, tahoma, sans-serif;
1349 text-decoration: none;
1351 border-bottom: 1px dotted #bbb;
1353 :link:hover, :visited:hover {
1366 background-color: #fff;
1367 border: 1px solid #aaa;
1371 font-weight: normal;
1393 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1398 <img src="$logo" alt="Catalyst Logo" />
1400 <p>Welcome to the world of Catalyst.
1401 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1402 framework will make web development something you had
1403 never expected it to be: Fun, rewarding, and quick.</p>
1404 <h2>What to do now?</h2>
1405 <p>That really depends on what <b>you</b> want to do.
1406 We do, however, provide you with a few starting points.</p>
1407 <p>If you want to jump right into web development with Catalyst
1408 you might want to start with a tutorial.</p>
1409 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1411 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1413 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1414 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1416 <h2>What to do next?</h2>
1417 <p>Next it's time to write an actual application. Use the
1418 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1419 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1420 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1421 they can save you a lot of work.</p>
1422 <pre><code>script/${prefix}_create.pl -help</code></pre>
1423 <p>Also, be sure to check out the vast and growing
1424 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1425 you are likely to find what you need there.
1429 <p>Catalyst has a very active community. Here are the main places to
1430 get in touch with us.</p>
1433 <a href="http://dev.catalyst.perl.org">Wiki</a>
1436 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1439 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1442 <h2>In conclusion</h2>
1443 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1444 as we enjoyed making it. Please contact us if you have ideas
1445 for improvement or other feedback.</p>
1453 =head1 INTERNAL METHODS
1455 These methods are not meant to be used by end users.
1457 =head2 $c->components
1459 Returns a hash of components.
1461 =head2 $c->context_class
1463 Returns or sets the context class.
1467 Returns a hashref containing coderefs and execution counts (needed for
1468 deep recursion detection).
1472 Returns the number of actions on the current internal execution stack.
1476 Dispatches a request to actions.
1480 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1482 =head2 $c->dispatcher_class
1484 Returns or sets the dispatcher class.
1486 =head2 $c->dump_these
1488 Returns a list of 2-element array references (name, structure) pairs
1489 that will be dumped on the error page in debug mode.
1495 [ Request => $c->req ],
1496 [ Response => $c->res ],
1497 [ Stash => $c->stash ],
1498 [ Config => $c->config ];
1501 =head2 $c->engine_class
1503 Returns or sets the engine class.
1505 =head2 $c->execute( $class, $coderef )
1507 Execute a coderef in given class and catch exceptions. Errors are available
1513 my ( $c, $class, $code ) = @_;
1514 $class = $c->component($class) || $class;
1517 if ( $c->depth >= $RECURSION ) {
1518 my $action = $code->reverse();
1519 $action = "/$action" unless $action =~ /->/;
1520 my $error = qq/Deep recursion detected calling "${action}"/;
1521 $c->log->error($error);
1527 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1529 push( @{ $c->stack }, $code );
1531 no warnings 'recursion';
1532 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1534 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1536 my $last = pop( @{ $c->stack } );
1538 if ( my $error = $@ ) {
1539 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1540 $error->rethrow if $c->depth > 1;
1542 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1543 $error->rethrow if $c->depth > 0;
1546 unless ( ref $error ) {
1547 no warnings 'uninitialized';
1549 my $class = $last->class;
1550 my $name = $last->name;
1551 $error = qq/Caught exception in $class->$name "$error"/;
1560 sub _stats_start_execute {
1561 my ( $c, $code ) = @_;
1563 return if ( ( $code->name =~ /^_.*/ )
1564 && ( !$c->config->{show_internal_actions} ) );
1566 my $action_name = $code->reverse();
1567 $c->counter->{$action_name}++;
1569 my $action = $action_name;
1570 $action = "/$action" unless $action =~ /->/;
1572 # determine if the call was the result of a forward
1573 # this is done by walking up the call stack and looking for a calling
1574 # sub of Catalyst::forward before the eval
1576 for my $index ( 2 .. 11 ) {
1578 if ( ( caller($index) )[0] eq 'Catalyst'
1579 && ( caller($index) )[3] eq '(eval)' );
1581 if ( ( caller($index) )[3] =~ /forward$/ ) {
1582 $callsub = ( caller($index) )[3];
1583 $action = "-> $action";
1588 my $uid = $action_name . $c->counter->{$action_name};
1590 # is this a root-level call or a forwarded call?
1591 if ( $callsub =~ /forward$/ ) {
1593 # forward, locate the caller
1594 if ( my $parent = $c->stack->[-1] ) {
1597 parent => "$parent" . $c->counter->{"$parent"},
1603 # forward with no caller may come from a plugin
1622 sub _stats_finish_execute {
1623 my ( $c, $info ) = @_;
1624 $c->stats->profile( end => $info );
1629 Finalizes the request.
1636 for my $error ( @{ $c->error } ) {
1637 $c->log->error($error);
1640 # Allow engine to handle finalize flow (for POE)
1641 my $engine = $c->engine;
1642 if ( my $code = $engine->can('finalize') ) {
1647 $c->finalize_uploads;
1650 if ( $#{ $c->error } >= 0 ) {
1654 $c->finalize_headers;
1657 if ( $c->request->method eq 'HEAD' ) {
1658 $c->response->body('');
1664 if ($c->use_stats) {
1665 my $elapsed = sprintf '%f', $c->stats->elapsed;
1666 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1668 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1671 return $c->response->status;
1674 =head2 $c->finalize_body
1680 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1682 =head2 $c->finalize_cookies
1688 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1690 =head2 $c->finalize_error
1696 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1698 =head2 $c->finalize_headers
1704 sub finalize_headers {
1707 my $response = $c->response; #accessor calls can add up?
1709 # Check if we already finalized headers
1710 return if $response->finalized_headers;
1713 if ( my $location = $response->redirect ) {
1714 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1715 $response->header( Location => $location );
1717 if ( !$response->has_body ) {
1718 # Add a default body if none is already present
1720 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1726 if ( $response->body && !$response->content_length ) {
1728 # get the length from a filehandle
1729 if ( blessed( $response->body ) && $response->body->can('read') )
1731 my $stat = stat $response->body;
1732 if ( $stat && $stat->size > 0 ) {
1733 $response->content_length( $stat->size );
1736 $c->log->warn('Serving filehandle without a content-length');
1740 # everything should be bytes at this point, but just in case
1741 $response->content_length( bytes::length( $response->body ) );
1746 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1747 $response->headers->remove_header("Content-Length");
1748 $response->body('');
1751 $c->finalize_cookies;
1753 $c->engine->finalize_headers( $c, @_ );
1756 $response->finalized_headers(1);
1759 =head2 $c->finalize_output
1761 An alias for finalize_body.
1763 =head2 $c->finalize_read
1765 Finalizes the input after reading is complete.
1769 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1771 =head2 $c->finalize_uploads
1773 Finalizes uploads. Cleans up any temporary files.
1777 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1779 =head2 $c->get_action( $action, $namespace )
1781 Gets an action in a given namespace.
1785 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1787 =head2 $c->get_actions( $action, $namespace )
1789 Gets all actions of a given name in a namespace and all parent
1794 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1796 =head2 $c->handle_request( $class, @arguments )
1798 Called to handle each HTTP request.
1802 sub handle_request {
1803 my ( $class, @arguments ) = @_;
1805 # Always expect worst case!
1808 if ($class->debug) {
1809 my $secs = time - $START || 1;
1810 my $av = sprintf '%.3f', $COUNT / $secs;
1811 my $time = localtime time;
1812 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1815 my $c = $class->prepare(@arguments);
1817 $status = $c->finalize;
1820 if ( my $error = $@ ) {
1822 $class->log->error(qq/Caught exception in engine "$error"/);
1827 if(my $coderef = $class->log->can('_flush')){
1828 $class->log->$coderef();
1833 =head2 $c->prepare( @arguments )
1835 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1841 my ( $class, @arguments ) = @_;
1844 # After the app/ctxt split, this should become an attribute based on something passed
1845 # into the application.
1846 $class->context_class( ref $class || $class ) unless $class->context_class;
1848 my $c = $class->context_class->new({});
1850 # For on-demand data
1851 $c->request->_context($c);
1852 $c->response->_context($c);
1854 #surely this is not the most efficient way to do things...
1855 $c->stats($class->stats_class->new)->enable($c->use_stats);
1857 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1860 #XXX reuse coderef from can
1861 # Allow engine to direct the prepare flow (for POE)
1862 if ( $c->engine->can('prepare') ) {
1863 $c->engine->prepare( $c, @arguments );
1866 $c->prepare_request(@arguments);
1867 $c->prepare_connection;
1868 $c->prepare_query_parameters;
1869 $c->prepare_headers;
1870 $c->prepare_cookies;
1873 # Prepare the body for reading, either by prepare_body
1874 # or the user, if they are using $c->read
1877 # Parse the body unless the user wants it on-demand
1878 unless ( $c->config->{parse_on_demand} ) {
1883 my $method = $c->req->method || '';
1884 my $path = $c->req->path;
1885 $path = '/' unless length $path;
1886 my $address = $c->req->address || '';
1888 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1896 =head2 $c->prepare_action
1898 Prepares action. See L<Catalyst::Dispatcher>.
1902 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1904 =head2 $c->prepare_body
1906 Prepares message body.
1913 return if $c->request->_has_body;
1915 # Initialize on-demand data
1916 $c->engine->prepare_body( $c, @_ );
1917 $c->prepare_parameters;
1918 $c->prepare_uploads;
1920 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1921 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1922 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1923 my $param = $c->req->body_parameters->{$key};
1924 my $value = defined($param) ? $param : '';
1926 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1928 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1932 =head2 $c->prepare_body_chunk( $chunk )
1934 Prepares a chunk of data before sending it to L<HTTP::Body>.
1936 See L<Catalyst::Engine>.
1940 sub prepare_body_chunk {
1942 $c->engine->prepare_body_chunk( $c, @_ );
1945 =head2 $c->prepare_body_parameters
1947 Prepares body parameters.
1951 sub prepare_body_parameters {
1953 $c->engine->prepare_body_parameters( $c, @_ );
1956 =head2 $c->prepare_connection
1958 Prepares connection.
1962 sub prepare_connection {
1964 $c->engine->prepare_connection( $c, @_ );
1967 =head2 $c->prepare_cookies
1973 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1975 =head2 $c->prepare_headers
1981 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1983 =head2 $c->prepare_parameters
1985 Prepares parameters.
1989 sub prepare_parameters {
1991 $c->prepare_body_parameters;
1992 $c->engine->prepare_parameters( $c, @_ );
1995 =head2 $c->prepare_path
1997 Prepares path and base.
2001 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2003 =head2 $c->prepare_query_parameters
2005 Prepares query parameters.
2009 sub prepare_query_parameters {
2012 $c->engine->prepare_query_parameters( $c, @_ );
2014 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2015 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2016 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2017 my $param = $c->req->query_parameters->{$key};
2018 my $value = defined($param) ? $param : '';
2020 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2022 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2026 =head2 $c->prepare_read
2028 Prepares the input for reading.
2032 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2034 =head2 $c->prepare_request
2036 Prepares the engine request.
2040 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2042 =head2 $c->prepare_uploads
2048 sub prepare_uploads {
2051 $c->engine->prepare_uploads( $c, @_ );
2053 if ( $c->debug && keys %{ $c->request->uploads } ) {
2054 my $t = Text::SimpleTable->new(
2055 [ 12, 'Parameter' ],
2060 for my $key ( sort keys %{ $c->request->uploads } ) {
2061 my $upload = $c->request->uploads->{$key};
2062 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2063 $t->row( $key, $u->filename, $u->type, $u->size );
2066 $c->log->debug( "File Uploads are:\n" . $t->draw );
2070 =head2 $c->prepare_write
2072 Prepares the output for writing.
2076 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2078 =head2 $c->request_class
2080 Returns or sets the request class.
2082 =head2 $c->response_class
2084 Returns or sets the response class.
2086 =head2 $c->read( [$maxlength] )
2088 Reads a chunk of data from the request body. This method is designed to
2089 be used in a while loop, reading C<$maxlength> bytes on every call.
2090 C<$maxlength> defaults to the size of the request if not specified.
2092 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2095 Warning: If you use read(), Catalyst will not process the body,
2096 so you will not be able to access POST parameters or file uploads via
2097 $c->request. You must handle all body parsing yourself.
2101 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2109 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2111 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2113 Sets an action in a given namespace.
2117 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2119 =head2 $c->setup_actions($component)
2121 Sets up actions for a component.
2125 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2127 =head2 $c->setup_components
2129 Sets up components. Specify a C<setup_components> config option to pass
2130 additional options directly to L<Module::Pluggable>. To add additional
2131 search paths, specify a key named C<search_extra> as an array
2132 reference. Items in the array beginning with C<::> will have the
2133 application class name prepended to them.
2135 All components found will also have any
2136 L<inner packages|Devel::InnerPackage> loaded and set up as components.
2137 Note, that modules which are B<not> an I<inner package> of the main
2138 file namespace loaded will not be instantiated as components.
2142 sub setup_components {
2145 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2146 my $config = $class->config->{ setup_components };
2147 my $extra = delete $config->{ search_extra } || [];
2149 push @paths, @$extra;
2151 my $locator = Module::Pluggable::Object->new(
2152 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2156 my @comps = sort { length $a <=> length $b } $locator->plugins;
2157 my %comps = map { $_ => 1 } @comps;
2159 my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
2160 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2161 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2162 ) if $deprecated_component_names;
2164 for my $component ( @comps ) {
2166 # We pass ignore_loaded here so that overlay files for (e.g.)
2167 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2168 # we know M::P::O found a file on disk so this is safe
2170 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2171 #Class::MOP::load_class($component);
2173 my $module = $class->setup_component( $component );
2175 $component => $module,
2177 $_ => $class->setup_component( $_ )
2179 not exists $comps{$_}
2180 } Devel::InnerPackage::list_packages( $component )
2183 for my $key ( keys %modules ) {
2184 $class->components->{ $key } = $modules{ $key };
2189 =head2 $c->setup_component
2193 sub _controller_init_base_classes {
2194 my ($app_class, $component) = @_;
2195 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2196 Moose::Meta::Class->initialize( $class )
2197 unless find_meta($class);
2201 sub setup_component {
2202 my( $class, $component ) = @_;
2204 unless ( $component->can( 'COMPONENT' ) ) {
2208 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2209 # nearest to Catalyst::Controller first, no matter what order stuff happens
2210 # to be loaded. There are TODO tests in Moose for this, see
2211 # f2391d17574eff81d911b97be15ea51080500003
2212 if ($component->isa('Catalyst::Controller')) {
2213 $class->_controller_init_base_classes($component);
2216 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2217 my $config = $class->config->{ $suffix } || {};
2218 # Stash _component_name in the config here, so that custom COMPONENT
2219 # methods also pass it. local to avoid pointlessly shitting in config
2220 # for the debug screen, as $component is already the key name.
2221 local $config->{_component_name} = $component;
2223 my $instance = eval { $component->COMPONENT( $class, $config ); };
2225 if ( my $error = $@ ) {
2227 Catalyst::Exception->throw(
2228 message => qq/Couldn't instantiate component "$component", "$error"/
2232 unless (blessed $instance) {
2233 my $metaclass = Moose::Util::find_meta($component);
2234 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2235 my $component_method_from = $method_meta->associated_metaclass->name;
2236 my $value = defined($instance) ? $instance : 'undef';
2237 Catalyst::Exception->throw(
2239 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2245 =head2 $c->setup_dispatcher
2251 sub setup_dispatcher {
2252 my ( $class, $dispatcher ) = @_;
2255 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2258 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2259 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2262 unless ($dispatcher) {
2263 $dispatcher = $class->dispatcher_class;
2266 Class::MOP::load_class($dispatcher);
2268 # dispatcher instance
2269 $class->dispatcher( $dispatcher->new );
2272 =head2 $c->setup_engine
2279 my ( $class, $engine ) = @_;
2282 $engine = 'Catalyst::Engine::' . $engine;
2285 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2286 $engine = 'Catalyst::Engine::' . $env;
2289 if ( $ENV{MOD_PERL} ) {
2290 my $meta = Class::MOP::get_metaclass_by_name($class);
2292 # create the apache method
2293 $meta->add_method('apache' => sub { shift->engine->apache });
2295 my ( $software, $version ) =
2296 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2299 $version =~ s/(\.[^.]+)\./$1/g;
2301 if ( $software eq 'mod_perl' ) {
2305 if ( $version >= 1.99922 ) {
2306 $engine = 'Catalyst::Engine::Apache2::MP20';
2309 elsif ( $version >= 1.9901 ) {
2310 $engine = 'Catalyst::Engine::Apache2::MP19';
2313 elsif ( $version >= 1.24 ) {
2314 $engine = 'Catalyst::Engine::Apache::MP13';
2318 Catalyst::Exception->throw( message =>
2319 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2324 # install the correct mod_perl handler
2325 if ( $version >= 1.9901 ) {
2326 *handler = sub : method {
2327 shift->handle_request(@_);
2331 *handler = sub ($$) { shift->handle_request(@_) };
2336 elsif ( $software eq 'Zeus-Perl' ) {
2337 $engine = 'Catalyst::Engine::Zeus';
2341 Catalyst::Exception->throw(
2342 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2347 $engine = $class->engine_class;
2350 Class::MOP::load_class($engine);
2352 # check for old engines that are no longer compatible
2354 if ( $engine->isa('Catalyst::Engine::Apache')
2355 && !Catalyst::Engine::Apache->VERSION )
2360 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2361 && Catalyst::Engine::Server->VERSION le '0.02' )
2366 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2367 && $engine->VERSION eq '0.01' )
2372 elsif ($engine->isa('Catalyst::Engine::Zeus')
2373 && $engine->VERSION eq '0.01' )
2379 Catalyst::Exception->throw( message =>
2380 qq/Engine "$engine" is not supported by this version of Catalyst/
2385 $class->engine( $engine->new );
2388 =head2 $c->setup_home
2390 Sets up the home directory.
2395 my ( $class, $home ) = @_;
2397 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2401 $home ||= Catalyst::Utils::home($class);
2404 #I remember recently being scolded for assigning config values like this
2405 $class->config->{home} ||= $home;
2406 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2410 =head2 $c->setup_log
2412 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2413 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2416 This method also installs a C<debug> method that returns a true value into the
2417 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2418 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2420 Note that if the log has already been setup, by either a previous call to
2421 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2422 that this method won't actually set up the log object.
2427 my ( $class, $levels ) = @_;
2430 $levels =~ s/^\s+//;
2431 $levels =~ s/\s+$//;
2432 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2434 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2435 if ( defined $env_debug ) {
2436 $levels{debug} = 1 if $env_debug; # Ugly!
2437 delete($levels{debug}) unless $env_debug;
2440 unless ( $class->log ) {
2441 $class->log( Catalyst::Log->new(keys %levels) );
2444 if ( $levels{debug} ) {
2445 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2446 $class->log->debug('Debug messages enabled');
2450 =head2 $c->setup_plugins
2456 =head2 $c->setup_stats
2458 Sets up timing statistics class.
2463 my ( $class, $stats ) = @_;
2465 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2467 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2468 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2469 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2470 $class->log->debug('Statistics enabled');
2475 =head2 $c->registered_plugins
2477 Returns a sorted list of the plugins which have either been stated in the
2478 import list or which have been added via C<< MyApp->plugin(@args); >>.
2480 If passed a given plugin name, it will report a boolean value indicating
2481 whether or not that plugin is loaded. A fully qualified name is required if
2482 the plugin name does not begin with C<Catalyst::Plugin::>.
2484 if ($c->registered_plugins('Some::Plugin')) {
2492 sub registered_plugins {
2494 return sort keys %{ $proto->_plugins } unless @_;
2496 return 1 if exists $proto->_plugins->{$plugin};
2497 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2500 sub _register_plugin {
2501 my ( $proto, $plugin, $instant ) = @_;
2502 my $class = ref $proto || $proto;
2504 Class::MOP::load_class( $plugin );
2506 $proto->_plugins->{$plugin} = 1;
2509 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2510 my @superclasses = ($plugin, $meta->superclasses );
2511 $meta->superclasses(@superclasses);
2513 unshift @{"$class\::ISA"}, $plugin;
2520 my ( $class, $plugins ) = @_;
2522 $class->_plugins( {} ) unless $class->_plugins;
2525 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2527 for my $plugin ( reverse @plugins ) {
2528 Class::MOP::load_class($plugin);
2529 my $meta = find_meta($plugin);
2530 next if $meta && $meta->isa('Moose::Meta::Role');
2532 $class->_register_plugin($plugin);
2537 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2538 map { find_meta($_) }
2541 Moose::Util::apply_all_roles(
2549 Returns an arrayref of the internal execution stack (actions that are
2550 currently executing).
2552 =head2 $c->stats_class
2554 Returns or sets the stats (timing statistics) class.
2556 =head2 $c->use_stats
2558 Returns 1 when stats collection is enabled. Stats collection is enabled
2559 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2560 environment variable is set.
2562 Note that this is a static method, not an accessor and should be overridden
2563 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2570 =head2 $c->write( $data )
2572 Writes $data to the output stream. When using this method directly, you
2573 will need to manually set the C<Content-Length> header to the length of
2574 your output data, if known.
2581 # Finalize headers if someone manually writes output
2582 $c->finalize_headers;
2584 return $c->engine->write( $c, @_ );
2589 Returns the Catalyst version number. Mostly useful for "powered by"
2590 messages in template systems.
2594 sub version { return $Catalyst::VERSION }
2596 =head1 INTERNAL ACTIONS
2598 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2599 C<_ACTION>, and C<_END>. These are by default not shown in the private
2600 action table, but you can make them visible with a config parameter.
2602 MyApp->config(show_internal_actions => 1);
2604 =head1 CASE SENSITIVITY
2606 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2607 mapped to C</foo/bar>. You can activate case sensitivity with a config
2610 MyApp->config(case_sensitive => 1);
2612 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2614 =head1 ON-DEMAND PARSER
2616 The request body is usually parsed at the beginning of a request,
2617 but if you want to handle input yourself, you can enable on-demand
2618 parsing with a config parameter.
2620 MyApp->config(parse_on_demand => 1);
2622 =head1 PROXY SUPPORT
2624 Many production servers operate using the common double-server approach,
2625 with a lightweight frontend web server passing requests to a larger
2626 backend server. An application running on the backend server must deal
2627 with two problems: the remote user always appears to be C<127.0.0.1> and
2628 the server's hostname will appear to be C<localhost> regardless of the
2629 virtual host that the user connected through.
2631 Catalyst will automatically detect this situation when you are running
2632 the frontend and backend servers on the same machine. The following
2633 changes are made to the request.
2635 $c->req->address is set to the user's real IP address, as read from
2636 the HTTP X-Forwarded-For header.
2638 The host value for $c->req->base and $c->req->uri is set to the real
2639 host, as read from the HTTP X-Forwarded-Host header.
2641 Obviously, your web server must support these headers for this to work.
2643 In a more complex server farm environment where you may have your
2644 frontend proxy server(s) on different machines, you will need to set a
2645 configuration option to tell Catalyst to read the proxied data from the
2648 MyApp->config(using_frontend_proxy => 1);
2650 If you do not wish to use the proxy support at all, you may set:
2652 MyApp->config(ignore_frontend_proxy => 1);
2654 =head1 THREAD SAFETY
2656 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2657 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2658 believe the Catalyst core to be thread-safe.
2660 If you plan to operate in a threaded environment, remember that all other
2661 modules you are using must also be thread-safe. Some modules, most notably
2662 L<DBD::SQLite>, are not thread-safe.
2668 Join #catalyst on irc.perl.org.
2672 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2673 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2677 http://catalyst.perl.org
2681 http://dev.catalyst.perl.org
2685 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2687 =head2 L<Catalyst::Manual> - The Catalyst Manual
2689 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2691 =head2 L<Catalyst::Engine> - Core engine
2693 =head2 L<Catalyst::Log> - Log class.
2695 =head2 L<Catalyst::Request> - Request object
2697 =head2 L<Catalyst::Response> - Response object
2699 =head2 L<Catalyst::Test> - The test suite.
2701 =head1 PROJECT FOUNDER
2703 sri: Sebastian Riedel <sri@cpan.org>
2709 acme: Leon Brocard <leon@astray.com>
2717 andyg: Andy Grundman <andy@hybridized.org>
2719 audreyt: Audrey Tang
2721 bricas: Brian Cassidy <bricas@cpan.org>
2723 Caelum: Rafael Kitover <rkitover@io.com>
2725 chansen: Christian Hansen
2727 chicks: Christopher Hicks
2731 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2735 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2737 esskar: Sascha Kiefer
2739 fireartist: Carl Franks <cfranks@cpan.org>
2741 gabb: Danijel Milicevic
2747 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2749 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2751 jcamacho: Juan Camacho
2753 jester: Jesse Sheidlower
2755 jhannah: Jay Hannah <jay@jays.net>
2761 jon: Jon Schutz <jjschutz@cpan.org>
2763 konobi: Scott McWhirter <konobi@cpan.org>
2765 marcus: Marcus Ramberg <mramberg@cpan.org>
2767 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2769 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2773 naughton: David Naughton
2775 ningu: David Kamholz <dkamholz@cpan.org>
2777 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2779 numa: Dan Sully <daniel@cpan.org>
2783 omega: Andreas Marienborg
2785 Oleg Kostyuk <cub.uanic@gmail.com>
2787 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2789 rafl: Florian Ragwitz <rafl@debian.org>
2791 random: Roland Lammel <lammel@cpan.org>
2795 t0m: Tomas Doran <bobtfish@bobtfish.net>
2799 willert: Sebastian Willert <willert@cpan.org>
2803 This library is free software. You can redistribute it and/or modify it under
2804 the same terms as Perl itself.
2810 __PACKAGE__->meta->make_immutable;