use Catalyst::Response;
use Catalyst::Utils;
use NEXT;
-use Text::ASCIITable;
+use Text::SimpleTable;
use Path::Class;
use Time::HiRes qw/gettimeofday tv_interval/;
use URI;
use Scalar::Util qw/weaken/;
+use attributes;
__PACKAGE__->mk_accessors(
- qw/counter depth request response state action namespace/
+ qw/counter request response state action stack namespace/
);
+attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
+
+sub depth { scalar @{ shift->stack || [] }; }
+
# Laziness++
*comp = \&component;
*req = \&request;
require Module::Pluggable::Fast;
# Helper script generation
-our $CATALYST_SCRIPT_GEN = 9;
+our $CATALYST_SCRIPT_GEN = 10;
__PACKAGE__->mk_classdata($_)
- for qw/components arguments dispatcher engine log/;
+ for qw/components arguments dispatcher engine log dispatcher_class
+ engine_class context_class request_class response_class/;
+
+__PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
+__PACKAGE__->engine_class('Catalyst::Engine::CGI');
+__PACKAGE__->request_class('Catalyst::Request');
+__PACKAGE__->response_class('Catalyst::Response');
-our $VERSION = '5.49_02';
+our $VERSION = '5.49_04';
sub import {
my ( $class, @arguments ) = @_;
Returns a hashref containing your applications settings.
+=cut
+
+=item $c->controller($name)
+
+Get a L<Catalyst::Controller> instance by name.
+
+ $c->controller('Foo')->do_stuff;
+
+=cut
+
+sub controller {
+ my ( $c, $name ) = @_;
+ my $controller = $c->comp("Controller::$name");
+ return $controller if $controller;
+ return $c->comp("C::$name");
+}
+
=item debug
Overload to enable debug messages.
sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
+=item $c->model($name)
+
+Get a L<Catalyst::Model> instance by name.
+
+ $c->model('Foo')->do_stuff;
+
+=cut
+
+sub model {
+ my ( $c, $name ) = @_;
+ my $model = $c->comp("Model::$name");
+ return $model if $model;
+ return $c->comp("M::$name");
+}
+
=item $c->namespace
Accessor to the namespace of the current action
}
if (@plugins) {
- my $t = Text::ASCIITable->new;
- $t->setOptions( 'hide_HeadRow', 1 );
- $t->setOptions( 'hide_HeadLine', 1 );
- $t->setCols('Class');
- $t->setColWidth( 'Class', 75, 1 );
- $t->addRow($_) for @plugins;
+ my $t = Text::SimpleTable->new(76);
+ $t->row($_) for @plugins;
$class->log->debug( "Loaded plugins:\n" . $t->draw );
}
$class->setup_components;
if ( $class->debug ) {
- my $t = Text::ASCIITable->new;
- $t->setOptions( 'hide_HeadRow', 1 );
- $t->setOptions( 'hide_HeadLine', 1 );
- $t->setCols('Class');
- $t->setColWidth( 'Class', 75, 1 );
- $t->addRow($_) for sort keys %{ $class->components };
+ my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
+ for my $comp ( sort keys %{ $class->components } ) {
+ my $type = ref $class->components->{$comp} ? 'instance' : 'class';
+ $t->row( $comp, $type );
+ }
$class->log->debug( "Loaded components:\n" . $t->draw )
- if ( @{ $t->{tbl_rows} } );
+ if ( keys %{ $class->components } );
}
# Add our self to components, since we are also a component
# massage match, empty if absolute path
$match =~ s/^\///;
$match .= '/' if $match;
+ $path ||= '';
$match = '' if $path =~ /^\//;
$path =~ s/^\///;
return $c->{stash};
}
+=item $c->view($name)
+
+Get a L<Catalyst::View> instance by name.
+
+ $c->view('Foo')->do_stuff;
+
+=cut
+
+sub view {
+ my ( $c, $name ) = @_;
+ my $view = $c->comp("View::$name");
+ return $view if $view;
+ return $c->comp("V::$name");
+}
+
=item $c->welcome_message
Returns the Catalyst welcome HTML page.
my $name = $c->config->{name};
my $logo = $c->uri_for('/static/images/catalyst_logo.png');
my $prefix = Catalyst::Utils::appprefix( ref $c );
+ $c->response->content_type('text/html; charset=utf-8');
return <<"EOF";
-<html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
+ <meta http-equiv="Content-Language" content="en" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>$name on Catalyst $VERSION</title>
<style type="text/css">
body {
- text-align: center;
- padding-left: 50%;
color: #000;
background-color: #eee;
}
div#content {
width: 640px;
- margin-left: -320px;
+ margin-left: auto;
+ margin-right: auto;
margin-top: 10px;
margin-bottom: 10px;
text-align: left;
float: right;
margin-left: 10px;
}
- b#appname {
+ span#appname {
+ font-weight: bold;
font-size: 1.6em;
}
</style>
<body>
<div id="content">
<div id="topbar">
- <h1><b id="appname">$name</b> on <a href="http://catalyst.perl.org">Catalyst</a>
+ <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
$VERSION</h1>
</div>
<div id="answers">
<p>
- <img src="$logo"/>
+ <img src="$logo" alt="Catalyst Logo" />
</p>
<p>Welcome to the wonderful world of Catalyst.
This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
<h2>What to do next?</h2>
<p>Next it's time to write an actual application. Use the
- helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
- <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
- <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
+ helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
+ <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
+ <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
they can save you a lot of work.</p>
<pre><code>script/${prefix}_create.pl -help</code></pre>
<p>Also, be sure to check out the vast and growing
- collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
+ collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
you are likely to find what you need there.
</p>
Contains the components.
+=item $c->context_class($class)
+
+Contains the context class.
+
=item $c->counter
Returns a hashref containing coderefs and execution counts.
sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
+=item $c->dispatcher_class($class)
+
+Contains the dispatcher class.
+
+=item dump_these
+
+Returns a list of 2-element array references (name, structure) pairs that will
+be dumped on the error page in debug mode.
+
+=cut
+
+sub dump_these {
+ my $c = shift;
+ [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
+}
+
+=item $c->engine_class($class)
+
+Contains the engine class.
+
=item $c->execute($class, $coderef)
Execute a coderef in given class and catch exceptions.
my ( $c, $class, $code ) = @_;
$class = $c->components->{$class} || $class;
$c->state(0);
- my $callsub = ( caller(1) )[3];
+
+ my $callsub =
+ ( caller(0) )[0]->isa('Catalyst::Action')
+ ? ( caller(2) )[3]
+ : ( caller(1) )[3];
my $action = '';
if ( $c->debug ) {
$action = "-> $action" if $callsub =~ /forward$/;
}
- $c->{depth}++;
+ push( @{ $c->stack }, $code );
eval {
if ( $c->debug )
{
my ( $elapsed, @state ) =
$c->benchmark( $code, $class, $c, @{ $c->req->args } );
- push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
+ unless ( ( $code->name =~ /^_.*/ )
+ && ( !$c->config->{show_internal_actions} ) )
+ {
+ push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
+ }
$c->state(@state);
}
else {
$c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 );
}
};
- $c->{depth}--;
+ pop( @{ $c->stack } );
if ( my $error = $@ ) {
- if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
+ if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
else {
unless ( ref $error ) {
chomp $error;
$error = qq/Caught exception "$error"/;
}
-
- $c->log->error($error);
$c->error($error);
$c->state(0);
}
sub finalize {
my $c = shift;
+ for my $error ( @{ $c->error } ) {
+ $c->log->error($error);
+ }
+
$c->finalize_uploads;
# Error
sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
-=item $c->get_action( $action, $namespace, $inherit )
+=item $c->get_action( $action, $namespace )
Get an action in a given namespace.
=cut
-sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
+sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
+
+=item $c->get_actions( $action, $namespace )
+
+Get all actions of a given name in a namespace and all base namespaces.
+
+=cut
+
+sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
=item handle_request( $class, @arguments )
$elapsed = sprintf '%f', $elapsed;
my $av = sprintf '%.3f',
( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
- my $t = Text::ASCIITable->new;
- $t->setCols( 'Action', 'Time' );
- $t->setColWidth( 'Action', 64, 1 );
- $t->setColWidth( 'Time', 9, 1 );
+ my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
- for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
+ for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
$class->log->info(
"Request took ${elapsed}s ($av/s)\n" . $t->draw );
}
sub prepare {
my ( $class, @arguments ) = @_;
- my $c = bless {
- counter => {},
- depth => 0,
- request => Catalyst::Request->new(
- {
- arguments => [],
- body_parameters => {},
- cookies => {},
- headers => HTTP::Headers->new,
- parameters => {},
- query_parameters => {},
- secure => 0,
- snippets => [],
- uploads => {}
- }
- ),
- response => Catalyst::Response->new(
- {
- body => '',
- cookies => {},
- headers => HTTP::Headers->new(),
- status => 200
- }
- ),
- stash => {},
- state => 0
- }, $class;
+ $class->context_class( ref $class || $class ) unless $class->context_class;
+ my $c = $class->context_class->new(
+ {
+ counter => {},
+ stack => [],
+ request => $class->request_class->new(
+ {
+ arguments => [],
+ body_parameters => {},
+ cookies => {},
+ headers => HTTP::Headers->new,
+ parameters => {},
+ query_parameters => {},
+ secure => 0,
+ snippets => [],
+ uploads => {}
+ }
+ ),
+ response => $class->response_class->new(
+ {
+ body => '',
+ cookies => {},
+ headers => HTTP::Headers->new(),
+ status => 200
+ }
+ ),
+ stash => {},
+ state => 0
+ }
+ );
# For on-demand data
$c->request->{_context} = $c;
$c->prepare_uploads;
if ( $c->debug && keys %{ $c->req->body_parameters } ) {
- my $t = Text::ASCIITable->new;
- $t->setCols( 'Key', 'Value' );
- $t->setColWidth( 'Key', 37, 1 );
- $t->setColWidth( 'Value', 36, 1 );
- $t->alignCol( 'Value', 'right' );
+ my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
for my $key ( sort keys %{ $c->req->body_parameters } ) {
my $param = $c->req->body_parameters->{$key};
my $value = defined($param) ? $param : '';
- $t->addRow( $key,
+ $t->row( $key,
ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
}
$c->log->debug( "Body Parameters are:\n" . $t->draw );
$c->engine->prepare_query_parameters( $c, @_ );
if ( $c->debug && keys %{ $c->request->query_parameters } ) {
- my $t = Text::ASCIITable->new;
- $t->setCols( 'Key', 'Value' );
- $t->setColWidth( 'Key', 37, 1 );
- $t->setColWidth( 'Value', 36, 1 );
- $t->alignCol( 'Value', 'right' );
+ my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
for my $key ( sort keys %{ $c->req->query_parameters } ) {
my $param = $c->req->query_parameters->{$key};
my $value = defined($param) ? $param : '';
- $t->addRow( $key,
+ $t->row( $key,
ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
}
$c->log->debug( "Query Parameters are:\n" . $t->draw );
$c->engine->prepare_uploads( $c, @_ );
if ( $c->debug && keys %{ $c->request->uploads } ) {
- my $t = Text::ASCIITable->new;
- $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
- $t->setColWidth( 'Key', 12, 1 );
- $t->setColWidth( 'Filename', 28, 1 );
- $t->setColWidth( 'Type', 18, 1 );
- $t->setColWidth( 'Size', 9, 1 );
- $t->alignCol( 'Size', 'left' );
+ my $t = Text::SimpleTable->new(
+ [ 12, 'Key' ],
+ [ 28, '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->addRow( $key, $u->filename, $u->type, $u->size );
+ $t->row( $key, $u->filename, $u->type, $u->size );
}
}
$c->log->debug( "File Uploads are:\n" . $t->draw );
sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
+=item $c->request_class($class)
+
+Contains the request class.
+
+=item $c->response_class($class)
+
+Contains the response class.
+
=item $c->read( [$maxlength] )
Read a chunk of data from the request body. This method is designed to be
my $callback = sub {
my ( $component, $context ) = @_;
- unless ( $component->isa('Catalyst::Base') ) {
+ unless ( $component->isa('Catalyst::Component') ) {
return $component;
}
- my $suffix = Catalyst::Utils::class2classsuffix($component);
+ my $suffix = Catalyst::Utils::class2classsuffix($class);
my $config = $class->config->{$suffix} || {};
my $instance;
}
unless ($dispatcher) {
- $dispatcher = 'Catalyst::Dispatcher';
+ $dispatcher = $class->dispatcher_class;
}
$dispatcher->require;
}
unless ($engine) {
- $engine = 'Catalyst::Engine::CGI';
+ $engine = $class->engine_class;
}
$engine->require;
);
}
+ # check for old engines that are no longer compatible
+ my $old_engine;
+ if ( $engine->isa('Catalyst::Engine::Apache')
+ && !Catalyst::Engine::Apache->VERSION )
+ {
+ $old_engine = 1;
+ }
+
+ elsif ( $engine->isa('Catalyst::Engine::Server::Base')
+ && Catalyst::Engine::Server->VERSION le '0.02' )
+ {
+ $old_engine = 1;
+ }
+
+ elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
+ && $engine->VERSION eq '0.01' )
+ {
+ $old_engine = 1;
+ }
+
+ elsif ($engine->isa('Catalyst::Engine::Zeus')
+ && $engine->VERSION eq '0.01' )
+ {
+ $old_engine = 1;
+ }
+
+ if ($old_engine) {
+ Catalyst::Exception->throw( message =>
+ qq/Engine "$engine" is not supported by this version of Catalyst/
+ );
+ }
+
# engine instance
$class->engine( $engine->new );
}
$class->log( Catalyst::Log->new );
}
- if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
+ my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
+
+ if (
+ ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
+ ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
+ : $debug
+ )
+ {
no strict 'refs';
*{"$class\::debug"} = sub { 1 };
$class->log->debug('Debug messages enabled');
}
}
+=item $c->stack
+
+Contains the stack.
+
=item $c->write( $data )
Writes $data to the output stream. When using this method directly, you will
=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 deactivate this with a config parameter.
+
+ MyApp->config->{show_internal_actions} = 1;
+
=head1 CASE SENSITIVITY
By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
Autrijus Tang
+Brian Cassidy
+
Christian Hansen
Christopher Hicks
Robert Sedlacek
+Sam Vilain
+
+Sascha Kiefer
+
Tatsuhiko Miyagawa
Ulf Edvinsson