X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=6c72b8b20840e6067633d126a649b6df93f222c6;hb=5d9a6d472d46896c9f878011e34485de7508c326;hp=5593d624e4c4c0f0f192829744fea67f5bfa71a6;hpb=ceb7ed54f76d83d6822a8bb6c4b2f4d8cdceea5f;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 5593d62..6c72b8b 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,15 +1,19 @@ 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.24'; our @ISA; =head1 NAME @@ -23,15 +27,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; @@ -60,9 +64,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. @@ -124,124 +125,96 @@ Returns a hashref containing your applications settings. =cut sub import { - my ( $self, @options ) = @_; + my ( $class, @arguments ) = @_; + my $caller = caller(0); + + if ( $caller eq 'main' ) { + return; + } # Prepare inheritance - unless ( $caller->isa($self) ) { + unless ( $caller->isa($class) ) { no strict 'refs'; - push @{"$caller\::ISA"}, $self; + push @{"$caller\::ISA"}, $class; } - + if ( $caller->engine ) { - return; # Catalyst is already initialized + $caller->log->warn( qq/Attempt to re-initialize "$caller"/ ); + return; } - unless ( $caller->log ) { - $caller->log( Catalyst::Log->new ); - } + # Process options + my $flags = { }; - # Debug? - 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'; - my $dispatcher = 'Catalyst::Dispatcher'; + if ( /^-Debug$/ ) { + $flags->{log} = ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; + } + elsif (/^-(\w+)=?(.*)$/) { + $flags->{ lc $1 } = $2; + } + else { + push @{ $flags->{plugins} }, $_; + } + } - # Detect mod_perl - 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 ( $ENV{MOD_PERL_API_VERSION} == 2 ) { - $engine = 'Catalyst::Engine::Apache::MP20'; - } - elsif ( $mod_perl::VERSION >= 1.99 ) { - $engine = 'Catalyst::Engine::Apache::MP19'; + if ( my $code = $caller->can( 'setup_' . $flag ) ) { + &$code( $caller, delete $flags->{$flag} ); } else { - $engine = 'Catalyst::Engine::Apache::MP13'; + $caller->log->warn(qq/Unknown flag "$flag"/); } } - $caller->log->info( "You are running an old helper script! " + $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::Helper::CATALYST_SCRIPT_GEN ) - ); - - # Process options - my @plugins; - foreach (@options) { + && ( $ENV{CATALYST_SCRIPT_GEN} < $CATALYST_SCRIPT_GEN ) ); - 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::$_"; + if ( $caller->debug ) { - $plugin->require; + my @plugins = (); - if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ } - else { - push @plugins, $plugin; - no strict 'refs'; - push @{"$caller\::ISA"}, $plugin; - } + { + no strict 'refs'; + @plugins = grep { /^Catalyst::Plugin/ } @{"$caller\::ISA"}; } - } + 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:\n" . $t->draw ); + } - # 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; + my $dispatcher = $caller->dispatcher; + my $engine = $caller->engine; + my $home = $caller->config->{home}; - # Dispatcher - $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}" - if $ENV{CATALYST_DISPATCHER}; + $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/); + $caller->log->debug(qq/Loaded engine "$engine"/); - $dispatcher->require; - die qq/Couldn't load dispatcher "$dispatcher", "$@"/ if $@; - { - no strict 'refs'; - push @{"$caller\::ISA"}, $dispatcher; + $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->dispatcher($dispatcher); - $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/) if $caller->debug; - } =item $c->engine @@ -259,15 +232,89 @@ 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; + + 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 $class->setup + +Setup. + + MyApp->setup; + +=cut + +sub setup { + my $class = shift; + + # Call plugins setup + $class->NEXT::setup; + + # Initialize our data structure + $class->components( {} ); + + $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 }; + $class->log->debug( "Loaded components:\n" . $t->draw ) + if ( @{ $t->{tbl_rows} } ); + } + + # Add our self to components, since we are also a component + $class->components->{$class} = $class; + + $class->setup_actions; + + if ( $class->debug ) { + my $name = $class->config->{name} || 'Application'; + $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); + } +} =back =head1 LIMITATIONS -FCGI and mod_perl2 support are considered experimental and may contain bugs. - -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 @@ -280,6 +327,10 @@ 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 =over 4 @@ -304,9 +355,10 @@ Sebastian Riedel, C =head1 THANK YOU -Andy Grundman, Andrew Ford, Andrew Ruthven, Christian Hansen, +Andy Grundman, Andrew Ford, Andrew Ruthven, Autrijus Tang, Christian Hansen, Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton, -Gary Ashton Jones, Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, +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