package Catalyst;
use Moose;
+use Moose::Meta::Class ();
extends 'Catalyst::Component';
use Moose::Util qw/find_meta/;
-use bytes;
use B::Hooks::EndOfScope ();
use Catalyst::Exception;
use Catalyst::Log;
-use Catalyst::Request;
-use Catalyst::Request::Upload;
-use Catalyst::Response;
use Catalyst::Utils;
use Catalyst::Controller;
+use Catalyst::Context;
use Devel::InnerPackage ();
-use File::stat;
use Module::Pluggable::Object ();
use Text::SimpleTable ();
use Path::Class::Dir ();
use Path::Class::File ();
-use URI ();
-use URI::http;
-use URI::https;
-use Tree::Simple qw/use_weak_refs/;
use Tree::Simple::Visitor::FindByUID;
use Class::C3::Adopt::NEXT;
use attributes;
use utf8;
use Carp qw/croak carp shortmess/;
-BEGIN { require 5.008001; }
+BEGIN { require 5.008004; }
-has stack => (is => 'ro', default => sub { [] });
-has stash => (is => 'rw', default => sub { {} });
-has state => (is => 'rw', default => 0);
-has stats => (is => 'rw');
-has action => (is => 'rw');
-has counter => (is => 'rw', default => sub { {} });
-has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
-has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
-has namespace => (is => 'rw');
-
-sub depth { scalar @{ shift->stack || [] }; }
sub comp { shift->component(@_) }
-sub req {
- my $self = shift; return $self->request(@_);
-}
-sub res {
- my $self = shift; return $self->response(@_);
-}
-
-# For backwards compatibility
-sub finalize_output { shift->finalize_body(@_) };
-
-# For statistics
-our $COUNT = 1;
-our $START = time;
-our $RECURSION = 1000;
-our $DETACH = "catalyst_detach\n";
-our $GO = "catalyst_go\n";
-
#I imagine that very few of these really need to be class variables. if any.
#maybe we should just make them attributes with a default?
__PACKAGE__->mk_classdata($_)
engine_class context_class request_class response_class stats_class
setup_finished/;
+__PACKAGE__->context_class('Catalyst::Context');
__PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
__PACKAGE__->engine_class('Catalyst::Engine::CGI');
__PACKAGE__->request_class('Catalyst::Request');
# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.80003';
+our $VERSION = '5.80013';
{
my $dev_version = $VERSION =~ /_\d{2}$/;
$VERSION = eval $VERSION;
+our $COUNT = 1;
+our $START = time;
+
sub import {
my ( $class, @arguments ) = @_;
}
my $meta = Moose::Meta::Class->initialize($caller);
- #Moose->import({ into => $caller }); #do we want to do this?
-
unless ( $caller->isa('Catalyst') ) {
my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
$meta->superclasses(@superclasses);
}
+ # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
+ $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
+
unless( $meta->has_method('meta') ){
$meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
}
$caller->setup_home;
}
+sub _application { $_[0] }
+
=head1 NAME
Catalyst - The Elegant MVC Web Application Framework
=head1 METHODS
-=head2 INFORMATION ABOUT THE CURRENT REQUEST
-
-=head2 $c->action
-
-Returns a L<Catalyst::Action> object for the current action, which
-stringifies to the action name. See L<Catalyst::Action>.
-
-=head2 $c->namespace
-
-Returns the namespace of the current action, i.e., the URI prefix
-corresponding to the controller of the current action. For example:
-
- # in Controller::Foo::Bar
- $c->namespace; # returns 'foo/bar';
-
-=head2 $c->request
-
-=head2 $c->req
-
-Returns the current L<Catalyst::Request> object, giving access to
-information about the current client request (including parameters,
-cookies, HTTP headers, etc.). See L<Catalyst::Request>.
-
-=head2 REQUEST FLOW HANDLING
-
-=head2 $c->forward( $action [, \@arguments ] )
-
-=head2 $c->forward( $class, $method, [, \@arguments ] )
-
-Forwards processing to another action, by its private name. If you give a
-class name but no method, C<process()> is called. You may also optionally
-pass arguments in an arrayref. The action will receive the arguments in
-C<@_> and C<< $c->req->args >>. Upon returning from the function,
-C<< $c->req->args >> will be restored to the previous values.
-
-Any data C<return>ed from the action forwarded to, will be returned by the
-call to forward.
-
- my $foodata = $c->forward('/foo');
- $c->forward('index');
- $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
- $c->forward('MyApp::View::TT');
-
-Note that forward implies an C<<eval { }>> around the call (actually
-C<execute> does), thus de-fatalizing all 'dies' within the called
-action. If you want C<die> to propagate you need to do something like:
-
- $c->forward('foo');
- die $c->error if $c->error;
-
-Or make sure to always return true values from your actions and write
-your code like this:
-
- $c->forward('foo') || return;
-
-=cut
-
-sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
-
-=head2 $c->detach( $action [, \@arguments ] )
-
-=head2 $c->detach( $class, $method, [, \@arguments ] )
-
-=head2 $c->detach()
-
-The same as C<forward>, but doesn't return to the previous action when
-processing is finished.
-
-When called with no arguments it escapes the processing chain entirely.
-
-=cut
-
-sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
-
-=head2 $c->visit( $action [, \@captures, \@arguments ] )
-
-=head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
-
-Almost the same as C<forward>, but does a full dispatch, instead of just
-calling the new C<$action> / C<$class-E<gt>$method>. This means that C<begin>,
-C<auto> and the method you go to are called, just like a new request.
-
-In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
-This means, for example, that $c->action methods such as C<name>, C<class> and
-C<reverse> return information for the visited action when they are invoked
-within the visited action. This is different from the behavior of C<forward>
-which continues to use the $c->action object from the caller action even when
-invoked from the callee.
-
-C<$c-E<gt>stash> is kept unchanged.
-
-In effect, C<visit> allows you to "wrap" another action, just as it
-would have been called by dispatching from a URL, while the analogous
-C<go> allows you to transfer control to another action as if it had
-been reached directly from a URL.
-
-=cut
-
-sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
-
-=head2 $c->go( $action [, \@captures, \@arguments ] )
-
-=head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
-
-Almost the same as C<detach>, but does a full dispatch like C<visit>,
-instead of just calling the new C<$action> /
-C<$class-E<gt>$method>. This means that C<begin>, C<auto> and the
-method you visit are called, just like a new request.
-
-C<$c-E<gt>stash> is kept unchanged.
-
-=cut
-
-sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
-
-=head2 $c->response
-
-=head2 $c->res
-
-Returns the current L<Catalyst::Response> object, see there for details.
-
-=head2 $c->stash
-
-Returns a hashref to the stash, which may be used to store data and pass
-it between components during a request. You can also set hash keys by
-passing arguments. The stash is automatically sent to the view. The
-stash is cleared at the end of a request; it cannot be used for
-persistent storage (for this you must use a session; see
-L<Catalyst::Plugin::Session> for a complete system integrated with
-Catalyst).
-
- $c->stash->{foo} = $bar;
- $c->stash( { moose => 'majestic', qux => 0 } );
- $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
-
- # stash is automatically passed to the view for use in a template
- $c->forward( 'MyApp::View::TT' );
-
-=cut
-
-around stash => sub {
- my $orig = shift;
- my $c = shift;
- my $stash = $orig->($c);
- if (@_) {
- my $new_stash = @_ > 1 ? {@_} : $_[0];
- croak('stash takes a hash or hashref') unless ref $new_stash;
- foreach my $key ( keys %$new_stash ) {
- $stash->{$key} = $new_stash->{$key};
- }
- }
-
- return $stash;
-};
-
-
-=head2 $c->error
-
-=head2 $c->error($error, ...)
-
-=head2 $c->error($arrayref)
-
-Returns an arrayref containing error messages. If Catalyst encounters an
-error while processing a request, it stores the error in $c->error. This
-method should only be used to store fatal error messages.
-
- my @error = @{ $c->error };
-
-Add a new error.
-
- $c->error('Something bad happened');
-
-=cut
-
-sub error {
- my $c = shift;
- if ( $_[0] ) {
- my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
- croak @$error unless ref $c;
- push @{ $c->{error} }, @$error;
- }
- elsif ( defined $_[0] ) { $c->{error} = undef }
- return $c->{error} || [];
-}
-
-
-=head2 $c->state
-
-Contains the return value of the last executed action.
-
-=head2 $c->clear_errors
-
-Clear errors. You probably don't want to clear the errors unless you are
-implementing a custom error screen.
-
-This is equivalent to running
-
- $c->error(0);
-
=cut
-sub clear_errors {
+sub _comp_search_prefixes {
my $c = shift;
- $c->error(0);
+ return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
}
# search components given a name and some prefixes
-sub _comp_search_prefixes {
+sub _comp_names_search_prefixes {
my ( $c, $name, @prefixes ) = @_;
my $appclass = ref $c || $c;
my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
my $query = ref $name ? $name : qr/^$name$/i;
my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
- return map { $c->components->{ $_ } } @result if @result;
+ return @result if @result;
# if we were given a regexp to search against, we're done.
return if ref $name;
+ # skip regexp fallback if configured
+ return
+ if $appclass->config->{disable_component_resolution_regex_fallback};
+
# regexp fallback
$query = qr/$name/i;
- @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
+ @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
# no results? try against full names
if( !@result ) {
- @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible;
+ @result = grep { m{$query} } keys %eligible;
}
# don't warn if we didn't find any results, it just might not exist
(join '", "', @result) . "'. Relying on regexp fallback behavior for " .
"component resolution is unreliable and unsafe.";
my $short = $result[0];
- $short =~ s/.*?Model:://;
+ # remove the component namespace prefix
+ $short =~ s/.*?(Model|Controller|View):://;
my $shortmess = Carp::shortmess('');
if ($shortmess =~ m#Catalyst/Plugin#) {
$msg .= " You probably need to set '$short' instead of '${name}' in this " .
$msg .= " You probably need to set '$short' instead of '${name}' in this " .
"component's config";
} else {
- $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " .
+ $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
"but if you really wanted to search, pass in a regexp as the argument " .
"like so: \$c->${warn_for}(qr/${name}/)";
}
my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
- my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes );
+ my @names = map { s{$filter}{}; $_; }
+ $c->_comp_names_search_prefixes( undef, @prefixes );
+
return @names;
}
=head2 COMPONENT ACCESSORS
-=head2 $c->controller($name)
-
-Gets a L<Catalyst::Controller> instance by name.
-
- $c->controller('Foo')->do_stuff;
-
-If the name is omitted, will return the controller for the dispatched
-action.
-
-If you want to search for controllers, pass in a regexp as the argument.
-
- # find all controllers that start with Foo
- my @foo_controllers = $c->controller(qr{^Foo});
-
-
-=cut
-
-sub controller {
- my ( $c, $name, @args ) = @_;
-
- if( $name ) {
- my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
- return map { $c->_filter_component( $_, @args ) } @result if ref $name;
- return $c->_filter_component( $result[ 0 ], @args );
- }
-
- return $c->component( $c->action->class );
-}
-
-=head2 $c->model($name)
-
-Gets a L<Catalyst::Model> instance by name.
-
- $c->model('Foo')->do_stuff;
-
-Any extra arguments are directly passed to ACCEPT_CONTEXT.
-
-If the name is omitted, it will look for
- - a model object in $c->stash->{current_model_instance}, then
- - a model name in $c->stash->{current_model}, then
- - a config setting 'default_model', or
- - check if there is only one model, and return it if that's the case.
-
-If you want to search for models, pass in a regexp as the argument.
-
- # find all models that start with Foo
- my @foo_models = $c->model(qr{^Foo});
-
-=cut
-
-sub model {
- my ( $c, $name, @args ) = @_;
-
- if( $name ) {
- my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
- return map { $c->_filter_component( $_, @args ) } @result if ref $name;
- return $c->_filter_component( $result[ 0 ], @args );
- }
-
- if (ref $c) {
- return $c->stash->{current_model_instance}
- if $c->stash->{current_model_instance};
- return $c->model( $c->stash->{current_model} )
- if $c->stash->{current_model};
- }
- return $c->model( $c->config->{default_model} )
- if $c->config->{default_model};
-
- my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
-
- if( $rest ) {
- $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
- $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' );
- $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
- $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
- $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
- }
-
- return $c->_filter_component( $comp );
-}
-
-
-=head2 $c->view($name)
-
-Gets a L<Catalyst::View> instance by name.
-
- $c->view('Foo')->do_stuff;
-
-Any extra arguments are directly passed to ACCEPT_CONTEXT.
-
-If the name is omitted, it will look for
- - a view object in $c->stash->{current_view_instance}, then
- - a view name in $c->stash->{current_view}, then
- - a config setting 'default_view', or
- - check if there is only one view, and return it if that's the case.
-
-If you want to search for views, pass in a regexp as the argument.
-
- # find all views that start with Foo
- my @foo_views = $c->view(qr{^Foo});
-
-=cut
-
-sub view {
- my ( $c, $name, @args ) = @_;
-
- if( $name ) {
- my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
- return map { $c->_filter_component( $_, @args ) } @result if ref $name;
- return $c->_filter_component( $result[ 0 ], @args );
- }
-
- if (ref $c) {
- return $c->stash->{current_view_instance}
- if $c->stash->{current_view_instance};
- return $c->view( $c->stash->{current_view} )
- if $c->stash->{current_view};
- }
- return $c->view( $c->config->{default_view} )
- if $c->config->{default_view};
-
- my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
-
- if( $rest ) {
- $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
- $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' );
- $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
- $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
- $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
- }
-
- return $c->_filter_component( $comp );
-}
-
=head2 $c->controllers
Returns the available names which can be passed to $c->controller
If C<$name> is a regexp, a list of components matched against the full
component name will be returned.
+If Catalyst can't find a component by name, it will fallback to regex
+matching by default. To disable this behaviour set
+disable_component_resolution_regex_fallback to a true value.
+
+ __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
+
=cut
sub component {
__PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
-You can also use a C<YAML>, C<XML> or C<Config::General> config file
-like myapp.conf in your applications home directory. See
+You can also use a C<YAML>, C<XML> or L<Config::General> config file
+like C<myapp.conf> in your applications home directory. See
L<Catalyst::Plugin::ConfigLoader>.
-=head3 Cascading configuration.
+=head3 Cascading configuration
The config method is present on all Catalyst components, and configuration
will be merged when an application is started. Configuration loaded with
=head2 $c->path_to(@path)
Merges C<@path> with C<< $c->config->{home} >> and returns a
-L<Path::Class::Dir> object.
+L<Path::Class::Dir> object. Note you can usually use this object as
+a filename, but sometimes you will have to explicitly stringify it
+yourself by calling the C<< ->stringify >> method.
For example:
my $name = $class->config->{name} || 'Application';
$class->log->info("$name powered by Catalyst $Catalyst::VERSION");
}
- $class->log->_flush() if $class->log->can('_flush');
# Make sure that the application class becomes immutable at this point,
- # which ensures that it gets an inlined constructor. This means that it
- # works even if the user has added a plugin which contains a new method.
- # Note however that we have to do the work on scope end, so that method
- # modifiers work correctly in MyApp (as you have to call setup _before_
- # applying modifiers).
B::Hooks::EndOfScope::on_scope_end {
+ return if $@;
my $meta = Class::MOP::get_metaclass_by_name($class);
- if ( $meta->is_immutable && ! { $meta->immutable_options }->{inline_constructor} ) {
+ if (
+ $meta->is_immutable
+ && ! { $meta->immutable_options }->{replace_constructor}
+ && (
+ $class->isa('Class::Accessor::Fast')
+ || $class->isa('Class::Accessor')
+ )
+ ) {
warn "You made your application class ($class) immutable, "
- . "but did not inline the constructor.\n"
- . "This will break catalyst, please pass "
- . "(replace_constructor => 1) when making your class immutable.\n";
+ . "but did not inline the\nconstructor. "
+ . "This will break catalyst, as your app \@ISA "
+ . "Class::Accessor(::Fast)?\nPlease pass "
+ . "(replace_constructor => 1)\nwhen making your class immutable.\n";
}
- $meta->make_immutable(replace_constructor => 1) unless $meta->is_immutable;
+ $meta->make_immutable(
+ replace_constructor => 1,
+ ) unless $meta->is_immutable;
};
$class->setup_finalize;
+ # Should be the last thing we do so that user things hooking
+ # setup_finalize can log..
+ $class->log->_flush() if $class->log->can('_flush');
+ return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
}
$class->setup_finished(1);
}
-=head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
-
-=head2 $c->uri_for( $path, @args?, \%query_values? )
-
-=over
-
-=item $action
-
-A Catalyst::Action object representing the Catalyst action you want to
-create a URI for. To get one for an action in the current controller,
-use C<< $c->action('someactionname') >>. To get one from different
-controller, fetch the controller using C<< $c->controller() >>, then
-call C<action_for> on it.
-
-You can maintain the arguments captured by an action (e.g.: Regex, Chained)
-using C<< $c->req->captures >>.
-
- # For the current action
- $c->uri_for($c->action, $c->req->captures);
-
- # For the Foo action in the Bar controller
- $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures);
-
-=back
-
-=cut
-
-sub uri_for {
- my ( $c, $path, @args ) = @_;
-
- if ( blessed($path) ) { # action object
- my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
- ? shift(@args)
- : [] );
- my $action = $path;
- $path = $c->dispatcher->uri_for_action($action, $captures);
- if (not defined $path) {
- $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
- if $c->debug;
- return undef;
- }
- $path = '/' if $path eq '';
- }
-
- undef($path) if (defined $path && $path eq '');
-
- my $params =
- ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
-
- carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
- s/([^A-Za-z0-9\-_.!~*'()])/$URI::Escape::escapes{$1}/go for @args;
-
- unshift(@args, $path);
-
- unless (defined $path && $path =~ s!^/!!) { # in-place strip
- my $namespace = $c->namespace;
- if (defined $path) { # cheesy hack to handle path '../foo'
- $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
- }
- unshift(@args, $namespace || '');
- }
-
- # join args with '/', or a blank string
- my $args = join('/', grep { defined($_) } @args);
- $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
- $args =~ s!^/+!!;
- my $base = $c->req->base;
- my $class = ref($base);
- $base =~ s{(?<!/)$}{/};
-
- my $query = '';
-
- if (my @keys = keys %$params) {
- # somewhat lifted from URI::_query's query_form
- $query = '?'.join('&', map {
- my $val = $params->{$_};
- s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
- s/ /+/g;
- my $key = $_;
- $val = '' unless defined $val;
- (map {
- $_ = "$_";
- utf8::encode( $_ ) if utf8::is_utf8($_);
- # using the URI::Escape pattern here so utf8 chars survive
- s/([^A-Za-z0-9\-_.!~*'()])/$URI::Escape::escapes{$1}/go;
- s/ /+/g;
- "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
- } @keys);
- }
-
- my $res = bless(\"${base}${args}${query}", $class);
- $res;
-}
-
-=head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
-
-=head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
-
-=over
-
-=item $path
-
-A private path to the Catalyst action you want to create a URI for.
-
-This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
->> and passing the resulting C<$action> and the remaining arguments to C<<
-$c->uri_for >>.
-
-You can also pass in a Catalyst::Action object, in which case it is passed to
-C<< $c->uri_for >>.
-
-=back
-
-=cut
-
-sub uri_for_action {
- my ( $c, $path, @args ) = @_;
- my $action = blessed($path)
- ? $path
- : $c->dispatcher->get_action_by_path($path);
- unless (defined $action) {
- croak "Can't find action for path '$path'";
- }
- return $c->uri_for( $action, @args );
-}
-
=head2 $c->welcome_message
Returns the Catalyst welcome HTML page.
Returns or sets the context class.
-=head2 $c->counter
+=head2 $c->dispatcher_class
-Returns a hashref containing coderefs and execution counts (needed for
-deep recursion detection).
+Returns or sets the dispatcher class.
-=head2 $c->depth
+=head2 $c->engine_class
-Returns the number of actions on the current internal execution stack.
+Returns or sets the engine class.
-=head2 $c->dispatch
+=head2 $c->handle_request( $class, @arguments )
-Dispatches a request to actions.
+Called to handle each HTTP request.
=cut
-sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
-
-=head2 $c->dispatcher_class
+sub handle_request {
+ my ( $class, @arguments ) = @_;
-Returns or sets the dispatcher class.
+ # Always expect worst case!
+ my $status = -1;
+ eval {
+ if ($class->debug) {
+ my $secs = time - $START || 1;
+ my $av = sprintf '%.3f', $COUNT / $secs;
+ my $time = localtime time;
+ $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
+ }
-=head2 $c->dump_these
+ my $c = $class->prepare(@arguments);
+ $c->dispatch;
+ $status = $c->finalize;
+ };
-Returns a list of 2-element array references (name, structure) pairs
-that will be dumped on the error page in debug mode.
+ if ( my $error = $@ ) {
+ chomp $error;
+ $class->log->error(qq/Caught exception in engine "$error"/);
+ }
-=cut
+ $COUNT++;
-sub dump_these {
- my $c = shift;
- [ Request => $c->req ],
- [ Response => $c->res ],
- [ Stash => $c->stash ],
- [ Config => $c->config ];
+ if(my $coderef = $class->log->can('_flush')){
+ $class->log->$coderef();
+ }
+ return $status;
}
-=head2 $c->engine_class
-
-Returns or sets the engine class.
-
-=head2 $c->execute( $class, $coderef )
+=head2 $c->prepare( @arguments )
-Execute a coderef in given class and catch exceptions. Errors are available
-via $c->error.
+Creates a Catalyst context from an engine-specific request (Apache, CGI,
+etc.).
=cut
-sub execute {
- my ( $c, $class, $code ) = @_;
- $class = $c->component($class) || $class;
- $c->state(0);
-
- if ( $c->depth >= $RECURSION ) {
- my $action = $code->reverse();
- $action = "/$action" unless $action =~ /->/;
- my $error = qq/Deep recursion detected calling "${action}"/;
- $c->log->error($error);
- $c->error($error);
- $c->state(0);
- return $c->state;
- }
-
- my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
-
- push( @{ $c->stack }, $code );
-
- no warnings 'recursion';
- eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
-
- $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
-
- my $last = pop( @{ $c->stack } );
-
- if ( my $error = $@ ) {
- if ( !ref($error) and $error eq $DETACH ) {
- die $DETACH if($c->depth > 1);
- }
- elsif ( !ref($error) and $error eq $GO ) {
- die $GO if($c->depth > 0);
- }
- else {
- unless ( ref $error ) {
- no warnings 'uninitialized';
- chomp $error;
- my $class = $last->class;
- my $name = $last->name;
- $error = qq/Caught exception in $class->$name "$error"/;
- }
- $c->error($error);
- $c->state(0);
- }
- }
- return $c->state;
-}
-
-sub _stats_start_execute {
- my ( $c, $code ) = @_;
-
- return if ( ( $code->name =~ /^_.*/ )
- && ( !$c->config->{show_internal_actions} ) );
-
- my $action_name = $code->reverse();
- $c->counter->{$action_name}++;
-
- my $action = $action_name;
- $action = "/$action" unless $action =~ /->/;
-
- # determine if the call was the result of a forward
- # this is done by walking up the call stack and looking for a calling
- # sub of Catalyst::forward before the eval
- my $callsub = q{};
- for my $index ( 2 .. 11 ) {
- last
- if ( ( caller($index) )[0] eq 'Catalyst'
- && ( caller($index) )[3] eq '(eval)' );
-
- if ( ( caller($index) )[3] =~ /forward$/ ) {
- $callsub = ( caller($index) )[3];
- $action = "-> $action";
- last;
- }
- }
-
- my $uid = $action_name . $c->counter->{$action_name};
-
- # is this a root-level call or a forwarded call?
- if ( $callsub =~ /forward$/ ) {
-
- # forward, locate the caller
- if ( my $parent = $c->stack->[-1] ) {
- $c->stats->profile(
- begin => $action,
- parent => "$parent" . $c->counter->{"$parent"},
- uid => $uid,
- );
- }
- else {
-
- # forward with no caller may come from a plugin
- $c->stats->profile(
- begin => $action,
- uid => $uid,
- );
- }
- }
- else {
-
- # root-level call
- $c->stats->profile(
- begin => $action,
- uid => $uid,
- );
- }
- return $action;
-
-}
-
-sub _stats_finish_execute {
- my ( $c, $info ) = @_;
- $c->stats->profile( end => $info );
-}
-
-=head2 $c->_localize_fields( sub { }, \%keys );
-
-=cut
-
-#Why does this exist? This is no longer safe and WILL NOT WORK.
-# it doesnt seem to be used anywhere. can we remove it?
-sub _localize_fields {
- my ( $c, $localized, $code ) = ( @_ );
-
- my $request = delete $localized->{request} || {};
- my $response = delete $localized->{response} || {};
-
- local @{ $c }{ keys %$localized } = values %$localized;
- local @{ $c->request }{ keys %$request } = values %$request;
- local @{ $c->response }{ keys %$response } = values %$response;
-
- $code->();
-}
-
-=head2 $c->finalize
-
-Finalizes the request.
-
-=cut
-
-sub finalize {
- my $c = shift;
-
- for my $error ( @{ $c->error } ) {
- $c->log->error($error);
- }
-
- # Allow engine to handle finalize flow (for POE)
- my $engine = $c->engine;
- if ( my $code = $engine->can('finalize') ) {
- $engine->$code($c);
- }
- else {
-
- $c->finalize_uploads;
-
- # Error
- if ( $#{ $c->error } >= 0 ) {
- $c->finalize_error;
- }
-
- $c->finalize_headers;
-
- # HEAD request
- if ( $c->request->method eq 'HEAD' ) {
- $c->response->body('');
- }
-
- $c->finalize_body;
- }
-
- if ($c->use_stats) {
- my $elapsed = sprintf '%f', $c->stats->elapsed;
- my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
- $c->log->info(
- "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
- }
-
- return $c->response->status;
-}
-
-=head2 $c->finalize_body
-
-Finalizes body.
-
-=cut
-
-sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
-
-=head2 $c->finalize_cookies
-
-Finalizes cookies.
-
-=cut
-
-sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
-
-=head2 $c->finalize_error
-
-Finalizes error.
-
-=cut
-
-sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
-
-=head2 $c->finalize_headers
-
-Finalizes headers.
-
-=cut
-
-sub finalize_headers {
- my $c = shift;
-
- my $response = $c->response; #accessor calls can add up?
-
- # Check if we already finalized headers
- return if $response->finalized_headers;
-
- # Handle redirects
- if ( my $location = $response->redirect ) {
- $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
- $response->header( Location => $location );
-
- if ( !$response->has_body ) {
- # Add a default body if none is already present
- $response->body(
- qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
- );
- }
- }
-
- # Content-Length
- if ( $response->body && !$response->content_length ) {
-
- # get the length from a filehandle
- if ( blessed( $response->body ) && $response->body->can('read') )
- {
- my $stat = stat $response->body;
- if ( $stat && $stat->size > 0 ) {
- $response->content_length( $stat->size );
- }
- else {
- $c->log->warn('Serving filehandle without a content-length');
- }
- }
- else {
- # everything should be bytes at this point, but just in case
- $response->content_length( bytes::length( $response->body ) );
- }
- }
-
- # Errors
- if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
- $response->headers->remove_header("Content-Length");
- $response->body('');
- }
-
- $c->finalize_cookies;
-
- $c->engine->finalize_headers( $c, @_ );
-
- # Done
- $response->finalized_headers(1);
-}
-
-=head2 $c->finalize_output
-
-An alias for finalize_body.
-
-=head2 $c->finalize_read
-
-Finalizes the input after reading is complete.
-
-=cut
-
-sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
-
-=head2 $c->finalize_uploads
-
-Finalizes uploads. Cleans up any temporary files.
-
-=cut
-
-sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
-
-=head2 $c->get_action( $action, $namespace )
-
-Gets an action in a given namespace.
-
-=cut
-
-sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
-
-=head2 $c->get_actions( $action, $namespace )
-
-Gets all actions of a given name in a namespace and all parent
-namespaces.
-
-=cut
-
-sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
-
-=head2 $c->handle_request( $class, @arguments )
-
-Called to handle each HTTP request.
-
-=cut
-
-sub handle_request {
- my ( $class, @arguments ) = @_;
-
- # Always expect worst case!
- my $status = -1;
- eval {
- if ($class->debug) {
- my $secs = time - $START || 1;
- my $av = sprintf '%.3f', $COUNT / $secs;
- my $time = localtime time;
- $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
- }
-
- my $c = $class->prepare(@arguments);
- $c->dispatch;
- $status = $c->finalize;
- };
-
- if ( my $error = $@ ) {
- chomp $error;
- $class->log->error(qq/Caught exception in engine "$error"/);
- }
-
- $COUNT++;
-
- if(my $coderef = $class->log->can('_flush')){
- $class->log->$coderef();
- }
- return $status;
-}
-
-=head2 $c->prepare( @arguments )
-
-Creates a Catalyst context from an engine-specific request (Apache, CGI,
-etc.).
-
-=cut
-
-sub prepare {
- my ( $class, @arguments ) = @_;
+sub prepare {
+ my ( $class, @arguments ) = @_;
# XXX
# After the app/ctxt split, this should become an attribute based on something passed
# into the application.
$class->context_class( ref $class || $class ) unless $class->context_class;
- my $c = $class->context_class->new({});
+ my $app = $class->new({});
+ my $c = $class->context_class->new( application => $app );
# For on-demand data
$c->request->_context($c);
$c->prepare_read;
# Parse the body unless the user wants it on-demand
- unless ( $c->config->{parse_on_demand} ) {
+ unless ( $app->config->{parse_on_demand} ) {
$c->prepare_body;
}
}
return $c;
}
-=head2 $c->prepare_action
-
-Prepares action. See L<Catalyst::Dispatcher>.
-
-=cut
-
-sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
-
-=head2 $c->prepare_body
-
-Prepares message body.
-
-=cut
-
-sub prepare_body {
- my $c = shift;
-
- return if $c->request->_has_body;
-
- # Initialize on-demand data
- $c->engine->prepare_body( $c, @_ );
- $c->prepare_parameters;
- $c->prepare_uploads;
-
- if ( $c->debug && keys %{ $c->req->body_parameters } ) {
- my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
- for my $key ( sort keys %{ $c->req->body_parameters } ) {
- my $param = $c->req->body_parameters->{$key};
- my $value = defined($param) ? $param : '';
- $t->row( $key,
- ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
- }
- $c->log->debug( "Body Parameters are:\n" . $t->draw );
- }
-}
-
-=head2 $c->prepare_body_chunk( $chunk )
-
-Prepares a chunk of data before sending it to L<HTTP::Body>.
+=head2 $c->request_class
-See L<Catalyst::Engine>.
+Returns or sets the request class.
-=cut
+=head2 $c->response_class
-sub prepare_body_chunk {
- my $c = shift;
- $c->engine->prepare_body_chunk( $c, @_ );
-}
+Returns or sets the response class.
-=head2 $c->prepare_body_parameters
+=head2 $c->run
-Prepares body parameters.
+Starts the engine.
=cut
-sub prepare_body_parameters {
- my $c = shift;
- $c->engine->prepare_body_parameters( $c, @_ );
-}
+sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
-=head2 $c->prepare_connection
+=head2 $c->set_action( $action, $code, $namespace, $attrs )
-Prepares connection.
+Sets an action in a given namespace.
=cut
-sub prepare_connection {
- my $c = shift;
- $c->engine->prepare_connection( $c, @_ );
-}
+sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
-=head2 $c->prepare_cookies
+=head2 $c->setup_actions($component)
-Prepares cookies.
+Sets up actions for a component.
=cut
-sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
-
-=head2 $c->prepare_headers
+sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
-Prepares headers.
+=head2 $c->setup_components
-=cut
+This method is called internally to set up the application's components.
-sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
+It finds modules by calling the L<locate_components> method, expands them to
+package names with the L<expand_component_module> method, and then installs
+each component into the application.
-=head2 $c->prepare_parameters
+The C<setup_components> config option is passed to both of the above methods.
-Prepares parameters.
+Installation of each component is performed by the L<setup_component> method,
+below.
=cut
-sub prepare_parameters {
- my $c = shift;
- $c->prepare_body_parameters;
- $c->engine->prepare_parameters( $c, @_ );
-}
-
-=head2 $c->prepare_path
-
-Prepares path and base.
-
-=cut
+sub setup_components {
+ my $class = shift;
-sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
+ my $config = $class->config->{ setup_components };
-=head2 $c->prepare_query_parameters
+ my @comps = sort { length $a <=> length $b }
+ $class->locate_components($config);
+ my %comps = map { $_ => 1 } @comps;
-Prepares query parameters.
+ my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
+ $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
+ qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
+ ) if $deprecatedcatalyst_component_names;
-=cut
+ for my $component ( @comps ) {
-sub prepare_query_parameters {
- my $c = shift;
+ # We pass ignore_loaded here so that overlay files for (e.g.)
+ # Model::DBI::Schema sub-classes are loaded - if it's in @comps
+ # we know M::P::O found a file on disk so this is safe
- $c->engine->prepare_query_parameters( $c, @_ );
+ Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
- if ( $c->debug && keys %{ $c->request->query_parameters } ) {
- my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
- for my $key ( sort keys %{ $c->req->query_parameters } ) {
- my $param = $c->req->query_parameters->{$key};
- my $value = defined($param) ? $param : '';
- $t->row( $key,
- ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
- }
- $c->log->debug( "Query Parameters are:\n" . $t->draw );
+ # Needs to be done as soon as the component is loaded, as loading a sub-component
+ # (next time round the loop) can cause us to get the wrong metaclass..
+ $class->_controller_init_base_classes($component);
}
-}
-
-=head2 $c->prepare_read
-
-Prepares the input for reading.
-
-=cut
-
-sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
-=head2 $c->prepare_request
-
-Prepares the engine request.
-
-=cut
-
-sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
-
-=head2 $c->prepare_uploads
-
-Prepares uploads.
-
-=cut
-
-sub prepare_uploads {
- my $c = shift;
-
- $c->engine->prepare_uploads( $c, @_ );
-
- if ( $c->debug && keys %{ $c->request->uploads } ) {
- my $t = Text::SimpleTable->new(
- [ 12, 'Parameter' ],
- [ 26, 'Filename' ],
- [ 18, 'Type' ],
- [ 9, 'Size' ]
- );
- for my $key ( sort keys %{ $c->request->uploads } ) {
- my $upload = $c->request->uploads->{$key};
- for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
- $t->row( $key, $u->filename, $u->type, $u->size );
- }
+ for my $component (@comps) {
+ $class->components->{ $component } = $class->setup_component($component);
+ for my $component ($class->expand_component_module( $component, $config )) {
+ next if $comps{$component};
+ $class->_controller_init_base_classes($component); # Also cover inner packages
+ $class->components->{ $component } = $class->setup_component($component);
}
- $c->log->debug( "File Uploads are:\n" . $t->draw );
}
}
-=head2 $c->prepare_write
-
-Prepares the output for writing.
-
-=cut
-
-sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
-
-=head2 $c->request_class
-
-Returns or sets the request class.
+=head2 $c->locate_components( $setup_component_config )
-=head2 $c->response_class
-
-Returns or sets the response class.
+This method is meant to provide a list of component modules that should be
+setup for the application. By default, it will use L<Module::Pluggable>.
-=head2 $c->read( [$maxlength] )
-
-Reads a chunk of data from the request body. This method is designed to
-be used in a while loop, reading C<$maxlength> bytes on every call.
-C<$maxlength> defaults to the size of the request if not specified.
-
-You have to set C<< MyApp->config->{parse_on_demand} >> to use this
-directly.
-
-Warning: If you use read(), Catalyst will not process the body,
-so you will not be able to access POST parameters or file uploads via
-$c->request. You must handle all body parsing yourself.
-
-=cut
-
-sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
-
-=head2 $c->run
-
-Starts the engine.
-
-=cut
-
-sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
-
-=head2 $c->set_action( $action, $code, $namespace, $attrs )
-
-Sets an action in a given namespace.
+Specify a C<setup_components> config option to pass additional options directly
+to L<Module::Pluggable>. To add additional search paths, specify a key named
+C<search_extra> as an array reference. Items in the array beginning with C<::>
+will have the application class name prepended to them.
=cut
-sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
-
-=head2 $c->setup_actions($component)
-
-Sets up actions for a component.
-
-=cut
-
-sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
-
-=head2 $c->setup_components
-
-Sets up components. Specify a C<setup_components> config option to pass
-additional options directly to L<Module::Pluggable>. To add additional
-search paths, specify a key named C<search_extra> as an array
-reference. Items in the array beginning with C<::> will have the
-application class name prepended to them.
-
-All components found will also have any
-L<Devel::InnerPackage|inner packages> loaded and set up as components.
-Note, that modules which are B<not> an I<inner package> of the main
-file namespace loaded will not be instantiated as components.
-
-=cut
-
-sub setup_components {
- my $class = shift;
+sub locate_components {
+ my $class = shift;
+ my $config = shift;
my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
- my $config = $class->config->{ setup_components };
my $extra = delete $config->{ search_extra } || [];
push @paths, @$extra;
%$config
);
- my @comps = sort { length $a <=> length $b } $locator->plugins;
- my %comps = map { $_ => 1 } @comps;
+ my @comps = $locator->plugins;
- my $deprecated_component_names = grep { /::[CMV]::/ } @comps;
- $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
- qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
- ) if $deprecated_component_names;
+ return @comps;
+}
- for my $component ( @comps ) {
+=head2 $c->expand_component_module( $component, $setup_component_config )
- # We pass ignore_loaded here so that overlay files for (e.g.)
- # Model::DBI::Schema sub-classes are loaded - if it's in @comps
- # we know M::P::O found a file on disk so this is safe
+Components found by C<locate_components> will be passed to this method, which
+is expected to return a list of component (package) names to be set up.
- Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
- #Class::MOP::load_class($component);
-
- my $module = $class->setup_component( $component );
- my %modules = (
- $component => $module,
- map {
- $_ => $class->setup_component( $_ )
- } grep {
- not exists $comps{$_}
- } Devel::InnerPackage::list_packages( $component )
- );
+=cut
- for my $key ( keys %modules ) {
- $class->components->{ $key } = $modules{ $key };
- }
- }
+sub expand_component_module {
+ my ($class, $module) = @_;
+ return Devel::InnerPackage::list_packages( $module );
}
=head2 $c->setup_component
=cut
+# FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
+# nearest to Catalyst::Controller first, no matter what order stuff happens
+# to be loaded. There are TODO tests in Moose for this, see
+# f2391d17574eff81d911b97be15ea51080500003
sub _controller_init_base_classes {
my ($app_class, $component) = @_;
+ return unless $component->isa('Catalyst::Controller');
foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
- Moose->init_meta( for_class => $class )
+ Moose::Meta::Class->initialize( $class )
unless find_meta($class);
}
}
return $component;
}
- # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
- # nearest to Catalyst::Controller first, no matter what order stuff happens
- # to be loaded. There are TODO tests in Moose for this, see
- # f2391d17574eff81d911b97be15ea51080500003
- if ($component->isa('Catalyst::Controller')) {
- $class->_controller_init_base_classes($component);
- }
-
my $suffix = Catalyst::Utils::class2classsuffix( $component );
my $config = $class->config->{ $suffix } || {};
+ # Stash catalyst_component_name in the config here, so that custom COMPONENT
+ # methods also pass it. local to avoid pointlessly shitting in config
+ # for the debug screen, as $component is already the key name.
+ local $config->{catalyst_component_name} = $component;
my $instance = eval { $component->COMPONENT( $class, $config ); };
my ( $proto, $plugin, $instant ) = @_;
my $class = ref $proto || $proto;
- # no ignore_loaded here, the plugin may already have been
- # defined in memory and we don't want to error on "no file" if so
-
Class::MOP::load_class( $plugin );
$proto->_plugins->{$plugin} = 1;
$class->_plugins( {} ) unless $class->_plugins;
$plugins ||= [];
- for my $plugin ( reverse @$plugins ) {
- unless ( $plugin =~ s/\A\+// ) {
- $plugin = "Catalyst::Plugin::$plugin";
- }
+ my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
+
+ for my $plugin ( reverse @plugins ) {
+ Class::MOP::load_class($plugin);
+ my $meta = find_meta($plugin);
+ next if $meta && $meta->isa('Moose::Meta::Role');
$class->_register_plugin($plugin);
}
- }
-}
-=head2 $c->stack
+ my @roles =
+ map { $_->name }
+ grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
+ map { find_meta($_) }
+ @plugins;
-Returns an arrayref of the internal execution stack (actions that are
-currently executing).
+ Moose::Util::apply_all_roles(
+ $class => @roles
+ ) if @roles;
+ }
+}
=head2 $c->stats_class
sub use_stats { 0 }
+=head2 version
-=head2 $c->write( $data )
-
-Writes $data to the output stream. When using this method directly, you
-will need to manually set the C<Content-Length> header to the length of
-your output data, if known.
+Returns the Catalyst version number. Mostly useful for "powered by"
+messages in template systems.
=cut
-sub write {
- my $c = shift;
+sub version { return $Catalyst::VERSION }
- # Finalize headers if someone manually writes output
- $c->finalize_headers;
+=head1 CONFIGURATION
- return $c->engine->write( $c, @_ );
-}
+There are a number of 'base' config variables which can be set:
-=head2 version
+=over
-Returns the Catalyst version number. Mostly useful for "powered by"
-messages in template systems.
+=item *
-=cut
+C<default_model> - The default model picked if you say C<< $c->model >>. See L</$c->model($name)>.
-sub version { return $Catalyst::VERSION }
+=item *
-=head1 INTERNAL ACTIONS
+C<default_view> - The default view to be rendered or returned when C<< $c->view >>. See L</$c->view($name)>.
+is called.
-Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
-C<_ACTION>, and C<_END>. These are by default not shown in the private
-action table, but you can make them visible with a config parameter.
+=item *
+
+C<disable_component_resolution_regex_fallback> - Turns
+off the deprecated component resolution functionality so
+that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
+are called then regex search will not be attempted on string values and
+instead C<undef> will be returned.
+
+=item *
+
+C<home> - The application home directory. In an uninstalled application,
+this is the top level application directory. In an installed application,
+this will be the directory containing C<< MyApp.pm >>.
+
+=item *
+
+C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
+
+=item *
+
+C<name> - The name of the application in debug messages and the debug and
+welcome screens
+
+=item *
- MyApp->config->{show_internal_actions} = 1;
+C<parse_on_demand> - The request body (for example file uploads) will not be parsed
+until it is accessed. This allows you to (for example) check authentication (and reject
+the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
-=head1 CASE SENSITIVITY
+=item *
-By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
-mapped to C</foo/bar>. You can activate case sensitivity with a config
-parameter.
+C<root> - The root directory for templates. Usually this is just a
+subdirectory of the home directory, but you can set it to change the
+templates to a different directory.
- MyApp->config->{case_sensitive} = 1;
+=item *
+
+C<search_extra> - Array reference passed to Module::Pluggable to for additional
+namespaces from which components will be loaded (and constructed and stored in
+C<< $c->components >>).
+
+=item *
+
+C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
+to be shown in hit debug tables in the test server.
+
+=item *
+
+C<using_frontend_proxy> - See L</PROXY SUPPORT>.
+
+=back
+
+=head1 INTERNAL ACTIONS
+
+Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
+C<_ACTION>, and C<_END>. These are by default not shown in the private
+action table, but you can make them visible with a config parameter.
-This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
+ MyApp->config(show_internal_actions => 1);
=head1 ON-DEMAND PARSER
but if you want to handle input yourself, you can enable on-demand
parsing with a config parameter.
- MyApp->config->{parse_on_demand} = 1;
+ MyApp->config(parse_on_demand => 1);
=head1 PROXY SUPPORT
The host value for $c->req->base and $c->req->uri is set to the real
host, as read from the HTTP X-Forwarded-Host header.
+Additionally, you may be running your backend application on an insecure
+connection (port 80) while your frontend proxy is running under SSL. If there
+is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
+tell Catalyst what port the frontend listens on. This will allow all URIs to
+be created properly.
+
+In the case of passing in:
+
+ X-Forwarded-Port: 443
+
+All calls to C<uri_for> will result in an https link, as is expected.
+
Obviously, your web server must support these headers for this to work.
In a more complex server farm environment where you may have your
configuration option to tell Catalyst to read the proxied data from the
headers.
- MyApp->config->{using_frontend_proxy} = 1;
+ MyApp->config(using_frontend_proxy => 1);
If you do not wish to use the proxy support at all, you may set:
- MyApp->config->{ignore_frontend_proxy} = 1;
+ MyApp->config(ignore_frontend_proxy => 1);
=head1 THREAD SAFETY
=head2 L<Catalyst::Manual> - The Catalyst Manual
-=head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
+=head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
=head2 L<Catalyst::Engine> - Core engine
acme: Leon Brocard <leon@astray.com>
+abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
+
Andrew Bramble
-Andrew Ford
+Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
Andrew Ruthven
chicks: Christopher Hicks
+Chisel Wright C<pause@herlpacker.co.uk>
+
+Danijel Milicevic C<me@danijel.de>
+
+David Kamholz E<lt>dkamholz@cpan.orgE<gt>
+
+David Naughton, C<naughton@umn.edu>
+
David E. Wheeler
dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
Drew Taylor
+dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
+
esskar: Sascha Kiefer
fireartist: Carl Franks <cfranks@cpan.org>
+frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+
gabb: Danijel Milicevic
Gary Ashton Jones
+Gavin Henry C<ghenry@perl.me.uk>
+
Geoff Richards
+groditi: Guillermo Roditi <groditi@gmail.com>
+
+hobbs: Andrew Rodland <andrew@cleverdomain.org>
+
ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
jcamacho: Juan Camacho
+jester: Jesse Sheidlower C<jester@panix.com>
+
jhannah: Jay Hannah <jay@jays.net>
Jody Belka
jon: Jon Schutz <jjschutz@cpan.org>
+Jonathan Rockway C<< <jrockway@cpan.org> >>
+
+Kieren Diment C<kd@totaldatasolution.com>
+
+konobi: Scott McWhirter <konobi@cpan.org>
+
marcus: Marcus Ramberg <mramberg@cpan.org>
miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
random: Roland Lammel <lammel@cpan.org>
-sky: Arthur Bergman
+Robert Sedlacek C<< <rs@474.at> >>
-the_jester: Jesse Sheidlower
+sky: Arthur Bergman
t0m: Tomas Doran <bobtfish@bobtfish.net>
Ulf Edvinsson
+Viljo Marrandi C<vilts@yahoo.com>
+
+Will Hawes C<info@whawes.co.uk>
+
willert: Sebastian Willert <willert@cpan.org>
+Yuval Kogman, C<nothingmuch@woobling.org>
+
=head1 LICENSE
-This library is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
projects / catagits/Catalyst-Runtime.git / blobdiff