X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=768ad238520c1d384ed1318124b0ba0fa893a539;hb=f45789b1af1b76c31c498f4b713ab48a5f28ba0c;hp=6dc0f1330b07c0c213ff6129d5050e227d8dcbff;hpb=750951569914c5b48ff82a021e5b7b28111d06cf;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 6dc0f13..768ad23 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -3,13 +3,16 @@ package Catalyst;
 use strict;
 use base 'Catalyst::Base';
 use UNIVERSAL::require;
+use Catalyst::Exception;
 use Catalyst::Log;
-use Catalyst::Helper;
+use Catalyst::Utils;
 use Text::ASCIITable;
+use Path::Class;
+our $CATALYST_SCRIPT_GEN = 4;
 
 __PACKAGE__->mk_classdata($_) for qw/dispatcher engine log/;
 
-our $VERSION = '5.03';
+our $VERSION = '5.24';
 our @ISA;
 
 =head1 NAME
@@ -23,15 +26,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 +63,6 @@ See also L<Catalyst::Manual::Intro>
 
 =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.
@@ -124,149 +124,356 @@ 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 )
-      );
+        && ( $ENV{CATALYST_SCRIPT_GEN} < $CATALYST_SCRIPT_GEN ) );
 
-    # Process options
-    my @plugins;
-    foreach (@options) {
 
-        if (/^\-Debug$/) {
-            next if $caller->debug;
+    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 (/^-Dispatcher=(.*)$/) {
-            $dispatcher = "Catalyst::Dispatcher::$1";
+        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 );
         }
 
-        elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
-        elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
+        my $dispatcher = $caller->dispatcher;
+        my $engine     = $caller->engine;
+        my $home       = $caller->config->{home};
 
-        else {
-            my $plugin = "Catalyst::Plugin::$_";
+        $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/);
+    }
+}
 
-            $plugin->require;
+=item $c->engine
 
-            if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ }
-            else {
-                push @plugins, $plugin;
-                no strict 'refs';
-                push @{"$caller\::ISA"}, $plugin;
-            }
-        }
+Contains the engine class.
+
+=item $c->log
+
+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:
+
+    $c->log( MyLogger->new );
+    $c->log->info("now logging with my own logger!");
+
+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;
     }
 
-    # 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 );
+    if ( $ENV{CATALYST_DISPATCHER} ) {
+        $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
+    }
 
-    # Dispatcher
-    $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}"
-      if $ENV{CATALYST_DISPATCHER};
+    if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
+        $dispatcher = 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
+    }
+
+    unless ( $dispatcher ) {
+        $dispatcher = 'Catalyst::Dispatcher';
+    }
 
     $dispatcher->require;
-    die qq/Couldn't load dispatcher "$dispatcher", "$@"/ if $@;
+
+    if ( $@ ) {
+        Catalyst::Exception->throw(
+            message => qq/Couldn't load dispatcher "$dispatcher", "$@"/
+        );
+    }
+
     {
         no strict 'refs';
-        push @{"$caller\::ISA"}, $dispatcher;
+        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}/
+            );
+        }
     }
-    $caller->dispatcher($dispatcher);
-    $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/) if $caller->debug;
 
-    # Engine
-    $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}"
-      if $ENV{CATALYST_ENGINE};
+    unless ( $engine ) {
+        $engine = 'Catalyst::Engine::CGI';
+    }
 
     $engine->require;
-    die qq/Couldn't load engine "$engine", "$@"/ if $@;
+
+    if ( $@ ) {
+        Catalyst::Exception->throw(
+            message => qq/Couldn't load engine "$engine", "$@"/
+        );
+    }
+
     {
         no strict 'refs';
-        push @{"$caller\::ISA"}, $engine;
+        push @{"$class\::ISA"}, $engine;
     }
-    $caller->engine($engine);
-    $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
+
+    $class->engine($engine);
 }
 
-=item $c->engine
+=item $c->setup_home
 
-Contains the engine class.
+=cut
 
-=item $c->log
+sub setup_home {
+    my ( $class, $home ) = @_;
 
-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:
+    if ( $ENV{CATALYST_HOME} ) {
+        $home = $ENV{CATALYST_HOME};
+    }
 
-    $c->log( MyLogger->new );
-    $c->log->info("now logging with my own logger!");
+    if ( $ENV{ uc($class) . '_HOME' } ) {
+        $home = $ENV{ uc($class) . '_HOME' };
+    }
 
-Your log class should implement the methods described in the C<Catalyst::Log>
-man page.
+    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
 
-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
 
@@ -309,7 +516,8 @@ Sebastian Riedel, C<sri@oook.de>
 
 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