Moved all setup methods to Catalyst::Setup
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
index ebf88a3..6c72b8b 100644 (file)
@@ -1,16 +1,17 @@
 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::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.24';
 our @ISA;
@@ -124,221 +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 );
-    }
-
-    # Debug?
-    if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) {
-        no strict 'refs';
-        *{"$caller\::debug"} = sub { 1 };
-        $caller->log->debug('Debug messages enabled');
-    }
-
-    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';
+    # Process options
+    my $flags = { };
 
-                if ( Apache::Request->require ) {
-                    $engine = 'Catalyst::Engine::Apache::MP13::Apreq';
-                }
-            }
+    foreach (@arguments) {
 
-            else {
-                Catalyst::Exception->throw(
-                    message => qq/Unsupported mod_perl version: $ENV{MOD_PERL}/
-                );
-            }
+        if ( /^-Debug$/ ) {
+            $flags->{log} = ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
         }
-
-        elsif ( $software eq 'Zeus-Perl' ) {
-            $engine = 'Catalyst::Engine::Zeus';
+        elsif (/^-(\w+)=?(.*)$/) {
+            $flags->{ lc $1 } = $2;
         }
-
         else {
-            Catalyst::Exception->throw(
-                message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/
-            );
+            push @{ $flags->{plugins} }, $_;
         }
     }
 
-    $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) {
+    $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}       );
 
-        if (/^\-Debug$/) {
-            next if $caller->debug;
-            no strict 'refs';
-            *{"$caller\::debug"} = sub { 1 };
-            $caller->log->debug('Debug messages enabled');
-        }
+    for my $flag ( sort keys %{ $flags } ) {
 
-        elsif (/^-Dispatcher=(.*)$/) {
-            $dispatcher = "Catalyst::Dispatcher::$1";
+        if ( my $code = $caller->can( 'setup_' . $flag ) ) {
+            &$code( $caller, delete $flags->{$flag} );
         }
-
-        elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
-        elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
-
         else {
-            my $plugin = "Catalyst::Plugin::$_";
-
-            $plugin->require;
-
-            if ( $@ ) { 
-                Catalyst::Exception->throw(
-                    message => qq/Couldn't load plugin "$plugin", "$@"/
-                );
-            }
-            else {
-                push @plugins, $plugin;
-                no strict 'refs';
-                push @{"$caller\::ISA"}, $plugin;
-            }
+            $caller->log->warn(qq/Unknown flag "$flag"/);
         }
-
-    }
-
-    # 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;
-    
-    if ( $@ ) {
-        Catalyst::Exception->throw(
-            message => qq/Couldn't load dispatcher "$dispatcher", "$@"/
-        );
-    }
-
-    {
-        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;
-    
-    if ( $@ ) {
-        Catalyst::Exception->throw(
-            message => qq/Couldn't load engine "$engine", "$@"/
-        );
-    }
-
-    {
-        no strict 'refs';
-        push @{"$caller\::ISA"}, $engine;
     }
 
-    $caller->engine($engine);
-    $caller->log->debug(qq/Loaded engine "$engine"/) 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 ) );
 
-    # Find home
-    my $home = Catalyst::Utils::home($caller);
 
-    if ( my $h = $ENV{CATALYST_HOME} ) {
+    if ( $caller->debug ) {
 
-        $home = $h if -d $h;
+        my @plugins = ();
 
-        unless ( -e _ ) {
-            $caller->log->warn(qq/CATALYST_HOME does not exist "$h"/);
+        {
+            no strict 'refs';
+            @plugins = grep { /^Catalyst::Plugin/ } @{"$caller\::ISA"};
         }
 
-        unless ( -e _ && -d _ ) {
-            $caller->log->warn(qq/CATALYST_HOME is not a directory "$h"/);
+        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 );
         }
-    }
 
-    if ( my $h = $ENV{ uc($caller) . '_HOME' } ) {
+        my $dispatcher = $caller->dispatcher;
+        my $engine     = $caller->engine;
+        my $home       = $caller->config->{home};
 
-        $home = $h if -d $h;
+        $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/);
+        $caller->log->debug(qq/Loaded engine "$engine"/);
 
-        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
@@ -370,13 +246,13 @@ Classdata accessor/mutator will be created, class loaded and instantiated.
 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;
@@ -393,6 +269,47 @@ sub plugin {
       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