package Catalyst;
use strict;
-use base 'Catalyst::Base';
+use base qw[ Catalyst::Base Catalyst::Setup ];
use UNIVERSAL::require;
+use Catalyst::Exception;
use Catalyst::Log;
-use Catalyst::Helper;
+use Catalyst::Utils;
+use NEXT;
use Text::ASCIITable;
+use Path::Class;
+our $CATALYST_SCRIPT_GEN = 4;
-__PACKAGE__->mk_classdata($_) for qw/dispatcher engine log/;
+__PACKAGE__->mk_classdata($_) for qw/arguments dispatcher engine log/;
-our $VERSION = '5.00';
+our $VERSION = '5.31';
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 ) = @_;
+
+ # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
+ # callers @ISA.
+ return unless $class eq 'Catalyst';
+
my $caller = caller(0);
- # Prepare inheritance
- unless ( $caller->isa($self) ) {
+ unless ( $caller->isa('Catalyst') ) {
no strict 'refs';
- push @{"$caller\::ISA"}, $self;
+ push @{"$caller\::ISA"}, $class;
}
- if ( $caller->engine ) {
- return; # Catalyst is already initialized
- }
+ $caller->arguments( [ @arguments ] );
+ $caller->setup_home;
+}
- unless ( $caller->log ) {
- $caller->log( Catalyst::Log->new );
- }
+=item $c->engine
- # Debug?
- if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) {
- no strict 'refs';
- *{"$caller\::debug"} = sub { 1 };
- $caller->log->debug('Debug messages enabled');
- }
+Contains the engine class.
- my $engine = 'Catalyst::Engine::CGI';
- my $dispatcher = 'Catalyst::Dispatcher';
+=item $c->log
- # Detect mod_perl
- if ( $ENV{MOD_PERL} ) {
+Contains the logging object. Unless it is already set Catalyst sets this up with a
+C<Catalyst::Log> object. To use your own log class:
- require mod_perl;
+ $c->log( MyLogger->new );
+ $c->log->info("now logging with my own logger!");
- if ( $mod_perl::VERSION >= 1.99 ) {
- $engine = 'Catalyst::Engine::Apache::MP19';
- }
- else {
- $engine = 'Catalyst::Engine::Apache::MP13';
- }
- }
+Your log class should implement the methods described in the C<Catalyst::Log>
+man page.
- $caller->log->info("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::Helper::CATALYST_SCRIPT_GEN )) ;
- # Process options
- my @plugins;
- foreach (@options) {
-
- if (/^\-Debug$/) {
- next if $caller->debug;
- no strict 'refs';
- *{"$caller\::debug"} = sub { 1 };
- $caller->log->debug('Debug messages enabled');
- }
-
- elsif (/^-Dispatcher=(.*)$/) {
- $dispatcher = "Catalyst::Dispatcher::$1";
- }
-
- elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
- elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
-
- else {
- my $plugin = "Catalyst::Plugin::$_";
-
- $plugin->require;
-
- if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ }
- else {
- push @plugins, $plugin;
- no strict 'refs';
- push @{"$caller\::ISA"}, $plugin;
- }
- }
+=item $c->plugin( $name, $class, @args )
- }
+Instant plugins for Catalyst.
+Classdata accessor/mutator will be created, class loaded and instantiated.
- # Plugin table
- my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } );
- $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};
-
- $engine->require;
- die qq/Couldn't load engine "$engine", "$@"/ if $@;
- {
- no strict 'refs';
- push @{"$caller\::ISA"}, $engine;
- }
- $caller->engine($engine);
- $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
+ MyApp->plugin( 'prototype', 'HTML::Prototype' );
- # Dispatcher
- $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}"
- if $ENV{CATALYST_DISPATCHER};
+ $c->prototype->define_javascript_functions;
- $dispatcher->require;
- die qq/Couldn't load dispatcher "$dispatcher", "$@"/ if $@;
- {
- no strict 'refs';
- push @{"$caller\::ISA"}, $dispatcher;
- }
- $caller->dispatcher($dispatcher);
- $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/) if $caller->debug;
+=cut
-}
+sub plugin {
+ my ( $class, $name, $plugin, @args ) = @_;
+ $plugin->require;
-=item $c->engine
+ if ( my $error = $UNIVERSAL::require::ERROR ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't load instant plugin "$plugin", "$error"/
+ );
+ }
-Contains the engine class.
+ eval { $plugin->import };
+ $class->mk_classdata($name);
+ my $obj;
+ eval { $obj = $plugin->new(@args) };
-=item $c->log
+ if ( $@ ) {
+ Catalyst::Exception->throw(
+ message => qq/Couldn't instantiate instant plugin "$plugin", "$@"/
+ );
+ }
-Contains the logging object. Unless it is already set Catalyst sets this up with a
-C<Catalyst::Log> object. To use your own log class:
+ $class->$name($obj);
+ $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
+ if $class->debug;
+}
- $c->log( MyLogger->new );
- $c->log->info("now logging with my own logger!");
+=back
-Your log class should implement the methods described in the C<Catalyst::Log>
-man page.
+=head1 CASE SENSITIVITY
+By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
+C</foo/bar>.
-=back
+But you can activate case sensitivity with a config parameter.
-=head1 LIMITATIONS
+ MyApp->config->{case_sensitive} = 1;
-FCGI and mod_perl2 support are considered experimental and may contain bugs.
+=head1 LIMITATIONS
-You may encounter problems accessing the built in test server on public ip
-addresses on the internet, thats because of a bug in HTTP::Daemon.
+mod_perl2 support is considered experimental and may contain bugs.
=head1 SUPPORT
http://lists.rawmode.org/mailman/listinfo/catalyst
http://lists.rawmode.org/mailman/listinfo/catalyst-dev
+Web:
+
+ http://catalyst.perl.org
+
=head1 SEE ALSO
=over 4
=back
-=head1 AUTHOR
+=head1 CREDITS
-Sebastian Riedel, C<sri@oook.de>
+Andy Grundman
+
+Andrew Ford
+
+Andrew Ruthven
+
+Autrijus Tang
+
+Christian Hansen
+
+Christopher Hicks
+
+Dan Sully
+
+Danijel Milicevic
-=head1 THANK YOU
+David Naughton
-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.
+Gary Ashton Jones
+
+Geoff Richards
+
+Jesse Sheidlower
+
+Jody Belka
+
+Johan Lindstrom
+
+Juan Camacho
+
+Leon Brocard
+
+Marcus Ramberg
+
+Matt S Trout
+
+Robert Sedlacek
+
+Sebastian Riedel
+
+Tatsuhiko Miyagawa
+
+Ulf Edvinsson
+
+=head1 AUTHOR
+
+Sebastian Riedel, C<sri@oook.de>
=head1 LICENSE