use strict;
use base 'Catalyst::Base';
use UNIVERSAL::require;
+use Catalyst::Exception;
use Catalyst::Log;
+use Catalyst::Utils;
use Text::ASCIITable;
+use Path::Class;
+our $CATALYST_SCRIPT_GEN = 4;
-__PACKAGE__->mk_classdata($_) for qw/engine log/;
+__PACKAGE__->mk_classdata($_) for qw/dispatcher engine log/;
-our $VERSION = '5.00';
+our $VERSION = '5.24';
our @ISA;
=head1 NAME
cd MyApp
# add models, views, controllers
- script/create.pl model Something
- script/create.pl view Stuff
- script/create.pl controller Yada
+ script/myapp_create.pl model Something
+ script/myapp_create.pl view Stuff
+ script/myapp_create.pl controller Yada
# built in testserver
- script/server.pl
+ script/myapp_server.pl
# command line interface
- script/test.pl /yada
+ script/myapp_test.pl /yada
use Catalyst;
sub index : Path('/index.html') {
my ( $self, $c ) = @_;
$c->res->output('Hello');
- $c->forward('_foo');
+ $c->forward('foo');
}
- sub product : Regex('/^product[_]*(\d*).html$/') {
+ sub product : Regex('^product[_]*(\d*).html$') {
my ( $self, $c ) = @_;
$c->stash->{template} = 'product.tt';
$c->stash->{product} = $c->req->snippets->[0];
=head1 DESCRIPTION
-Catalyst is based upon L<Maypole>, which you should consider for smaller
-projects.
-
The key concept of Catalyst is DRY (Don't Repeat Yourself).
See L<Catalyst::Manual> for more documentation.
=cut
sub import {
- my ( $self, @options ) = @_;
+ my ( $class, @arguments ) = @_;
+
my $caller = caller(0);
+
+ if ( $caller eq 'main' ) {
+ return;
+ }
- unless ( $caller->isa($self) ) {
+ # Prepare inheritance
+ unless ( $caller->isa($class) ) {
no strict 'refs';
- push @{"$caller\::ISA"}, $self;
+ push @{"$caller\::ISA"}, $class;
}
-
+
if ( $caller->engine ) {
- return; # Catalyst is allready initialized
+ $caller->log->warn( qq/Attempt to re-initialize "$caller"/ );
+ return;
}
- unless ( $caller->log ) {
- $caller->log( Catalyst::Log->new );
- }
+ # Process options
+ my $flags = { };
- if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) {
- no strict 'refs';
- *{"$caller\::debug"} = sub { 1 };
- $caller->log->debug('Debug messages enabled');
- }
+ foreach (@arguments) {
- my $engine = 'Catalyst::Engine::CGI';
+ if ( /^-Debug$/ ) {
+ $flags->{log} = 1
+ }
+ elsif (/^-(\w+)=?(.*)$/) {
+ $flags->{ lc $1 } = $2;
+ }
+ else {
+ push @{ $flags->{plugins} }, $_;
+ }
+ }
- if ( $ENV{MOD_PERL} ) {
+ $caller->setup_log ( delete $flags->{log} );
+ $caller->setup_plugins ( delete $flags->{plugins} );
+ $caller->setup_dispatcher ( delete $flags->{dispatcher} );
+ $caller->setup_engine ( delete $flags->{engine} );
+ $caller->setup_home ( delete $flags->{home} );
- require mod_perl;
+ for my $flag ( sort keys %{ $flags } ) {
- if ( $mod_perl::VERSION >= 1.99 ) {
- $engine = 'Catalyst::Engine::Apache::MP2';
+ if ( my $code = $caller->can( 'setup_' . $flag ) ) {
+ &$code( $caller, delete $flags->{$flag} );
}
else {
- $engine = 'Catalyst::Engine::Apache::MP1';
+ $caller->log->warn(qq/Unknown flag "$flag"/);
}
}
- my @plugins;
- foreach (@options) {
- if (/^\-Debug$/) {
- next if $caller->debug;
+ $caller->log->warn( "You are running an old helper script! "
+ . "Please update your scripts by regenerating the "
+ . "application and copying over the new scripts." )
+ if ( $ENV{CATALYST_SCRIPT_GEN}
+ && ( $ENV{CATALYST_SCRIPT_GEN} < $CATALYST_SCRIPT_GEN ) );
+
+
+ if ( $caller->debug ) {
+
+ my @plugins = ();
+
+ {
no strict 'refs';
- *{"$caller\::debug"} = sub { 1 };
- $caller->log->debug('Debug messages enabled');
+ @plugins = grep { /^Catalyst::Plugin/ } @{"$caller\::ISA"};
}
- elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
- elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
- else {
- my $plugin = "Catalyst::Plugin::$_";
-
- $plugin->require;
- if ($@) {
- $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/);
- }
- else {
- push @plugins, $plugin;
- no strict 'refs';
- push @{"$caller\::ISA"}, $plugin;
- }
+ 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;
+ $caller->log->debug( 'Loaded plugins', $t->draw );
}
- }
- my $t = Text::ASCIITable->new;
- $t->setCols('Class');
- $t->setColWidth( 'Class', 75, 1 );
- $t->addRow($_) for @plugins;
- $caller->log->debug( 'Loaded plugins', $t->draw )
- if ( @plugins && $caller->debug );
- # Engine
- $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}"
- if $ENV{CATALYST_ENGINE};
+ my $dispatcher = $caller->dispatcher;
+ my $engine = $caller->engine;
+ my $home = $caller->config->{home};
- $engine->require;
- die qq/Couldn't load engine "$engine", "$@"/ if $@;
- {
- no strict 'refs';
- push @{"$caller\::ISA"}, $engine;
+ $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/);
+ $caller->log->debug(qq/Loaded engine "$engine"/);
+
+ $home
+ ? ( -d $home )
+ ? $caller->log->debug(qq/Found home "$home"/)
+ : $caller->log->debug(qq/Home "$home" doesn't exist/)
+ : $caller->log->debug(q/Couldn't find home/);
}
- $caller->engine($engine);
- $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
}
=item $c->engine
Your log class should implement the methods described in the C<Catalyst::Log>
man page.
+=item $c->plugin( $name, $class, @args )
+
+Instant plugins for Catalyst.
+Classdata accessor/mutator will be created, class loaded and instantiated.
+
+ MyApp->plugin( 'prototype', 'HTML::Prototype' );
+
+ $c->prototype->define_javascript_functions;
+
+=cut
+
+sub plugin {
+ my ( $class, $name, $plugin, @args ) = @_;
+ $plugin->require;
+
+ if ( my $error = $UNIVERSAL::require::ERROR ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't load instant plugin "$plugin", "$error"/
+ );
+ }
+
+ eval { $plugin->import };
+ $class->mk_classdata($name);
+ my $obj;
+ eval { $obj = $plugin->new(@args) };
+
+ if ( $@ ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't instantiate instant plugin "$plugin", "$@"/
+ );
+ }
+
+ $class->$name($obj);
+ $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
+ if $class->debug;
+}
+
+=item $c->setup_dispatcher
+
+=cut
+
+sub setup_dispatcher {
+ my ( $class, $dispatcher ) = @_;
+
+ if ( $dispatcher ) {
+ $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
+ }
+
+ if ( $ENV{CATALYST_DISPATCHER} ) {
+ $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
+ }
+
+ if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
+ $dispatcher = 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
+ }
+
+ unless ( $dispatcher ) {
+ $dispatcher = 'Catalyst::Dispatcher';
+ }
+
+ $dispatcher->require;
+
+ if ( $@ ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't load dispatcher "$dispatcher", "$@"/
+ );
+ }
+
+ {
+ no strict 'refs';
+ push @{"$class\::ISA"}, $dispatcher;
+ }
+
+ $class->dispatcher($dispatcher);
+}
+
+=item $c->setup_engine
+
+=cut
+
+sub setup_engine {
+ my ( $class, $engine ) = @_;
+
+ if ( $engine ) {
+ $engine = 'Catalyst::Engine::' . $engine;
+ }
+
+ if ( $ENV{CATALYST_ENGINE} ) {
+ $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
+ }
+
+ if ( $ENV{ uc($class) . '_ENGINE' } ) {
+ $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
+ }
+
+ if ( ! $engine && $ENV{MOD_PERL} ) {
+
+ my ( $software, $version ) = $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
+
+ $version =~ s/_//g;
+ $version =~ s/(\.[^.]+)\./$1/g;
+
+ if ( $software eq 'mod_perl') {
+
+ if ( $version >= 1.99922 ) {
+
+ $engine = 'Catalyst::Engine::Apache::MP20';
+
+ if ( Apache2::Request->require ) {
+ $engine = 'Catalyst::Engine::Apache::MP20::Apreq';
+ }
+ }
+
+ elsif ( $version >= 1.9901 ) {
+
+ $engine = 'Catalyst::Engine::Apache::MP19';
+
+ if ( Apache::Request->require ) {
+ $engine = 'Catalyst::Engine::Apache::MP19::Apreq';
+ }
+ }
+
+ elsif ( $version >= 1.24 ) {
+
+ $engine = 'Catalyst::Engine::Apache::MP13';
+
+ if ( Apache::Request->require ) {
+ $engine = 'Catalyst::Engine::Apache::MP13::Apreq';
+ }
+ }
+
+ else {
+ Catalyst::Exception->throw(
+ message => qq/Unsupported mod_perl version: $ENV{MOD_PERL}/
+ );
+ }
+ }
+
+ elsif ( $software eq 'Zeus-Perl' ) {
+ $engine = 'Catalyst::Engine::Zeus';
+ }
+
+ else {
+ Catalyst::Exception->throw(
+ message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/
+ );
+ }
+ }
+
+ unless ( $engine ) {
+ $engine = 'Catalyst::Engine::CGI';
+ }
+
+ $engine->require;
+
+ if ( $@ ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't load engine "$engine", "$@"/
+ );
+ }
+
+ {
+ no strict 'refs';
+ push @{"$class\::ISA"}, $engine;
+ }
+
+ $class->engine($engine);
+}
+
+=item $c->setup_home
+
+=cut
+
+sub setup_home {
+ my ( $class, $home ) = @_;
+
+ if ( $ENV{CATALYST_HOME} ) {
+ $home = $ENV{CATALYST_HOME};
+ }
+
+ if ( $ENV{ uc($class) . '_HOME' } ) {
+ $home = $ENV{ uc($class) . '_HOME' };
+ }
+
+ unless ( $home ) {
+ $home = Catalyst::Utils::home($class);
+ }
+
+ if ( $home ) {
+ $class->config->{home} = $home;
+ $class->config->{root} = dir($home)->subdir('root');
+ }
+}
+
+=item $c->setup_log
+
+=cut
+
+sub setup_log {
+ my ( $class, $debug ) = @_;
+
+ unless ( $class->log ) {
+ $class->log( Catalyst::Log->new );
+ }
+
+ if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
+ no strict 'refs';
+ *{"$class\::debug"} = sub { 1 };
+ $class->log->debug('Debug messages enabled');
+ }
+}
+
+=item $c->setup_plugins
+
+=cut
+
+sub setup_plugins {
+ my ( $class, $plugins ) = @_;
+
+ for my $plugin ( @$plugins ) {
+
+ $plugin = "Catalyst::Plugin::$plugin";
+
+ $plugin->require;
+
+ if ( $@ ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't load plugin "$plugin", "$@"/
+ );
+ }
+
+ {
+ no strict 'refs';
+ push @{"$class\::ISA"}, $plugin;
+ }
+ }
+}
=back
+=head1 LIMITATIONS
+
+mod_perl2 support is considered experimental and may contain bugs.
+
=head1 SUPPORT
IRC:
http://lists.rawmode.org/mailman/listinfo/catalyst
http://lists.rawmode.org/mailman/listinfo/catalyst-dev
+Web:
+
+ http://catalyst.perl.org
+
=head1 SEE ALSO
-L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
-L<Catalyst::Response>, L<Catalyst::Engine>
+=over 4
+
+=item L<Catalyst::Manual> - The Catalyst Manual
+
+=item L<Catalyst::Engine> - Core Engine
+
+=item L<Catalyst::Log> - The Log Class.
+
+=item L<Catalyst::Request> - The Request Object
+
+=item L<Catalyst::Response> - The Response Object
+
+=item L<Catalyst::Test> - The test suite.
+
+=back
=head1 AUTHOR
=head1 THANK YOU
-Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks,
-Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones,
-Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa
-and all the others who've helped.
+Andy Grundman, Andrew Ford, Andrew Ruthven, Autrijus Tang, Christian Hansen,
+Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton,
+Gary Ashton Jones, Geoff Richards, Jesse Sheidlower, Jody Belka,
+Johan Lindstrom, Juan Camacho, Leon Brocard, Marcus Ramberg,
+Tatsuhiko Miyagawa and all the others who've helped.
=head1 LICENSE