X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=599a95d83bbb6d039f7243b30c970e90e640bd46;hp=5a9fe8a02560321c7e5a3166ecf5878dfa8f55d4;hb=ae4e40a7d5968d8086a86bff588a0989f167d5db;hpb=937fcdd8a54e8ad8ba7aec296e85905a057cc497 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 5a9fe8a..599a95d 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -4,10 +4,14 @@ use strict; use base 'Catalyst::Base'; use UNIVERSAL::require; 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 @@ -21,15 +25,15 @@ Catalyst - The Elegant MVC Web Application Framework 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; @@ -45,10 +49,10 @@ Catalyst - The Elegant MVC Web Application Framework 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]; @@ -58,9 +62,6 @@ See also L =head1 DESCRIPTION -Catalyst is based upon L, which you should consider for smaller -projects. - The key concept of Catalyst is DRY (Don't Repeat Yourself). See L for more documentation. @@ -125,71 +126,199 @@ sub import { my ( $self, @options ) = @_; my $caller = caller(0); + # Prepare inheritance unless ( $caller->isa($self) ) { no strict 'refs'; push @{"$caller\::ISA"}, $self; } if ( $caller->engine ) { - return; # Catalyst is allready initialized + return; # Catalyst is already initialized } unless ( $caller->log ) { $caller->log( Catalyst::Log->new ); } + # Debug? if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) { no strict 'refs'; *{"$caller\::debug"} = sub { 1 }; $caller->log->debug('Debug messages enabled'); } - # Options - my $engine = - $ENV{MOD_PERL} - ? 'Catalyst::Engine::Apache' - : 'Catalyst::Engine::CGI'; + my $engine = 'Catalyst::Engine::CGI'; + my $dispatcher = 'Catalyst::Dispatcher'; + + if ( $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 { + die( qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); + } + } + + elsif ( $software eq 'Zeus-Perl' ) { + $engine = 'Catalyst::Engine::Zeus'; + } + + else { + die( qq/Unsupported mod_perl: $ENV{MOD_PERL}/ ); + } + } + + $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_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 caller should be our application class - eval "package $caller; require $plugin"; - if ($@) { - $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/); - } + $plugin->require; + + if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ } else { - push @plugins, " $plugin"; + push @plugins, $plugin; no strict 'refs'; push @{"$caller\::ISA"}, $plugin; } } + } - $caller->log->debug( 'Loaded plugins', @plugins ) + + # 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 ); + # Dispatcher + $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}" + if $ENV{CATALYST_DISPATCHER}; + my $appdis = $ENV{ uc($caller) . '_DISPATCHER' }; + $dispatcher = "Catalyst::Dispatcher::$appdis" if $appdis; + + $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; + # Engine $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" if $ENV{CATALYST_ENGINE}; + my $appeng = $ENV{ uc($caller) . '_ENGINE' }; + $engine = "Catalyst::Engine::$appeng" if $appeng; $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; + + # Find home + my $home = Catalyst::Utils::home($caller); + + if ( my $h = $ENV{CATALYST_HOME} ) { + + $home = $h if -d $h; + + unless ( -e _ ) { + $caller->log->warn(qq/CATALYST_HOME does not exist "$h"/); + } + + unless ( -e _ && -d _ ) { + $caller->log->warn(qq/CATALYST_HOME is not a directory "$h"/); + } + } + + if ( my $h = $ENV{ uc($caller) . '_HOME' } ) { + + $home = $h if -d $h; + + unless ( -e _ ) { + my $e = uc($caller) . '_HOME'; + $caller->log->warn(qq/$e does not exist "$h"/) + } + + unless ( -e _ && -d _ ) { + my $e = uc($caller) . '_HOME'; + $caller->log->warn(qq/$e is not a directory "$h"/); + } + } + + if ( $caller->debug ) { + $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->config->{home} = $home || ''; + $caller->config->{root} = defined $home ? dir($home)->subdir('root') : ''; } =item $c->engine @@ -207,9 +336,38 @@ C object. To use your own log class: Your log class should implement the methods described in the C 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; + my $error = $UNIVERSAL::require::ERROR; + die qq/Couldn't load instant plugin "$plugin", "$error"/ if $error; + eval { $plugin->import }; + $class->mk_classdata($name); + my $obj; + eval { $obj = $plugin->new(@args) }; + die qq/Couldn't instantiate instant plugin "$plugin", "$@"/ if $@; + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; +} =back +=head1 LIMITATIONS + +mod_perl2 support is considered experimental and may contain bugs. + =head1 SUPPORT IRC: @@ -221,10 +379,27 @@ Mailing-Lists: http://lists.rawmode.org/mailman/listinfo/catalyst http://lists.rawmode.org/mailman/listinfo/catalyst-dev +Web: + + http://catalyst.perl.org + =head1 SEE ALSO -L, L, L, -L, L +=over 4 + +=item L - The Catalyst Manual + +=item L - Core Engine + +=item L - The Log Class. + +=item L - The Request Object + +=item L - The Response Object + +=item L - The test suite. + +=back =head1 AUTHOR @@ -232,10 +407,11 @@ Sebastian Riedel, C =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