tidied up inheritance in Mp::App - bugs 12923 & 14120

[maypole.git] / lib / Maypole / Application.pm

diff --git a/lib/Maypole/Application.pm b/lib/Maypole/Application.pm
index 4e8b624bf180303ada4ef2c7c2938c2473344f79..60542f987eefed9e5a4b058fc0cbe22026a7867c 100644 (file)
--- a/lib/Maypole/Application.pm
+++ b/lib/Maypole/Application.pm
@@ -2,46 +2,143 @@ package Maypole::Application;
 
 use strict;
 use warnings;
+use UNIVERSAL::require;
+use Maypole;
+use Maypole::Config;
 
-our @ISA;
+our $VERSION = '2.11';
 
 sub import {
-    my ( $self, @plugins ) = @_;
-    return unless $plugins[0];
+    shift; # not interested in this - we manipulate the caller's @ISA directly
+    my @plugins = @_;
     my $caller = caller(0);
+    
+    my $frontend = 'Apache::MVC' if $ENV{MOD_PERL};
+    
+    my $masonx;
+    if ( grep { /^MasonX$/ } @plugins )
+    {
+        $masonx++;
+        @plugins = grep { ! /^MasonX$/ } @plugins;
+        $frontend = 'MasonX::Maypole';
+    }
+    
+    $frontend ||= 'CGI::Maypole';
+    
+    $frontend->require or die "Loading $frontend frontend failed: $@";
+
+    my $autosetup=0;
+    my $autoinit=0;
+    my @plugin_modules;
+    {
+        foreach (@plugins) {
+            if    (/^\-Setup$/) { $autosetup++; }
+            elsif (/^\-Init$/)  { $autoinit++ }
+            elsif (/^\-Debug(\d*)$/) {
+                my $d = $1 || 1;
+                no strict 'refs';
+                *{"$caller\::debug"} = sub { $d };
+                warn "Debugging (level $d) enabled for $caller";
+            }
+            elsif (/^-.*$/) { warn "Unknown flag: $_" }
+            else {
+                my $plugin = "Maypole::Plugin::$_";
+                if ($plugin->require) {
+                    push @plugin_modules, "Maypole::Plugin::$_";
+                    warn "Loaded plugin: $plugin for $caller"
+                        if $caller->can('debug') && $caller->debug;
+                } else {
+                    die qq(Loading plugin "$plugin" for $caller failed: )
+                        . $UNIVERSAL::require::ERROR;
+                }
+            }
+        }
+    }
     no strict 'refs';
-    push @{"${caller}::ISA"}, $self;
-    "Maypole::$_"->require && unshift @ISA, "Maypole::$_" foreach (@plugins);
-}
-
-if ( $ENV{MOD_PERL} ) {
-    require Apache::MVC;
-    push @ISA, qw(Apache::MVC);
-}
-else {
-    require CGI::Maypole;
-    push @ISA, qw(CGI::Maypole);
+    push @{"${caller}::ISA"}, @plugin_modules, $frontend;
+    $caller->config(Maypole::Config->new);
+    $caller->config->masonx({}) if $masonx;
+    $caller->setup() if $autosetup;
+    $caller->init() if $autosetup && $autoinit;
 }
 
 1;
 
 =head1 NAME
 
-Maypole::Application - Maypole Universal Frontend
+Maypole::Application - Universal Maypole Frontend
 
 =head1 SYNOPSIS
 
     use Maypole::Application;
 
+    use Maypole::Application qw(Config::YAML);
+
+    use Maypole::Application qw(-Debug Config::YAML -Setup);
+
+    use Maypole::Application qw(Config::YAML Loader -Setup -Debug);
+
+    use Maypole::Application qw(-Debug2 MasonX AutoUntaint);
+
 =head1 DESCRIPTION
 
-This is a universal frontend for mod_perl1, mod_perl2 and CGI.
+This is a universal frontend for mod_perl1, mod_perl2, HTML::Mason and CGI.
 
-You can omit the Maypole:: prefix from plugins.
-So Maypole::Config::YAML becomes Config::YAML.
+You can omit the Maypole::Plugin:: prefix from plugins.
+So Maypole::Plugin::Config::YAML becomes Config::YAML.
 
     use Maypole::Application qw(Config::YAML);
 
+You can also set special flags like -Setup, -Debug and -Init.
+
+    use Maypole::Application qw(-Debug Config::YAML -Setup);
+
+The position of plugins and flags in the chain is important,
+because they are loaded/executed in the same order they appear.
+
+=head2 -Setup
+
+    use Maypole::Application qw(-Setup);
+
+is equivalent to
+
+    use Maypole::Application;
+    MyApp->setup;
+
+Note that no options are passed to C<setup()>. You must ensure that the
+required model config parameters are set in C<MyApp-E<gt>config>. See
+L<Maypole::Config> for more information.
+
+=head2 -Init
+
+    use Maypole::Application qw(-Setup -Init);
+    
+is equivalent to
+
+    use Maypole::Application;
+    MyApp->setup;
+    MyApp->init;
+    
+Note that the C<-Setup> flag is required for the C<-Init> flag to work.
+
+In persistent environments (e.g. C<mod_perl>), it is useful to call C<init> 
+once in the parent server, rather than at the beginning of the first request
+to each child server, in order to share the view code loaded during C<init>. 
+Note that you must supply all the config data to your app before calling 
+C<setup> and C<init>, probably by using one of the C<Maypole::Plugin::Config::*> 
+plugins.
+
+=head2 -Debug
+
+    use Maypole::Application qw(-Debug);
+
+is equivalent to
+
+    use Maypole::Application;
+    sub debug { 1 }
+
+You can specify a higher debug level by saying C<-Debug2> etc. 
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@oook.de>
@@ -50,3 +147,5 @@ Idea by Marcus Ramberg, C<marcus@thefeed.no>
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
+
+=cut