X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FApplication.pm;h=ae95bb7ee3447df5524c2925adbc7b193d4c0bdc;hb=79aa8d27d124d06bf88b2fc0487ae97563b98936;hp=4f61f42742810235743822e7b795d8293393764e;hpb=3a9e643a6a5fa96ca69b56ced03db9569fd96e2e;p=maypole.git diff --git a/lib/Maypole/Application.pm b/lib/Maypole/Application.pm index 4f61f42..ae95bb7 100644 --- a/lib/Maypole/Application.pm +++ b/lib/Maypole/Application.pm @@ -2,54 +2,68 @@ package Maypole::Application; use strict; use warnings; + use UNIVERSAL::require; use Maypole; use Maypole::Config; -our @ISA; -our $VERSION = '2.09'; +our $VERSION = '2.11'; sub import { - my ( $class, @plugins ) = @_; + 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}; + + $frontend = 'Maypole::HTTPD::Frontend' if $ENV{MAYPOLE_HTTPD}; + + 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) { - foreach (@plugins) { - if (/^\-Setup$/) { $autosetup++; } - elsif (/^\-Debug$/) { - no strict 'refs'; - *{"$caller\::debug"} = sub { 1 }; - warn "Debugging enabled"; - } - elsif (/^-.*$/) { warn "Unknown flag: $_" } - else { - my $plugin = "Maypole::Plugin::$_"; - if ($plugin->require) { - push @plugin_modules, "Maypole::Plugin::$_"; - warn "Loaded plugin: $plugin" - if $caller->can('debug') && $caller->debug; - } else { - warn qq(Loading plugin "$plugin" failed: ) - . $UNIVERSAL::require::ERROR; - } + 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"}, @plugin_modules, $class; + push @{"${caller}::ISA"}, @plugin_modules, $frontend; $caller->config(Maypole::Config->new); + $caller->config->masonx({}) if $masonx; $caller->setup() if $autosetup; -} - -if ( $ENV{MOD_PERL} ) { - Apache::MVC->require or die "Loading Apache frontend failed: $@"; - push @ISA, 'Apache::MVC'; -} -else { - CGI::Maypole->require or die "Loading CGI frontend failed: $@"; - push @ISA, 'CGI::Maypole'; + $caller->init() if $autosetup && $autoinit; } 1; @@ -68,23 +82,48 @@ Maypole::Application - Universal Maypole Frontend 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. + +Automatically determines the appropriate frontend for your environment (unless +you want to use L, in which case include C in the +arguments). + +Loads plugins supplied in the C statement. -You can omit the Maypole::Plugin:: prefix from plugins. -So Maypole::Plugin::Config::YAML becomes Config::YAML. +Responds to flags supplied in the C statement. + +Initializes the application's configuration object. + +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 and -Debug. +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. +The position of plugins in the chain is important, because they are +loaded/executed in the same order they appear. + +=head1 FRONTEND -=head2 -Setup +Under mod_perl (1 or 2), selects L. + +Otherwise, selects L. + +If C is specified, sets L as the frontend. This +currently also requires a mod_perl environment. + +=head1 FLAGS + +=over + +=item -Setup use Maypole::Application qw(-Setup); @@ -97,7 +136,26 @@ Note that no options are passed to C. You must ensure that the required model config parameters are set in Cconfig>. See L for more information. -=head2 -Debug +=item -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), it is useful to call C +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. +Note that you must supply all the config data to your app before calling +C and C, probably by using one of the C +plugins. + +=item -Debug use Maypole::Application qw(-Debug); @@ -106,6 +164,10 @@ is equivalent to use Maypole::Application; sub debug { 1 } +You can specify a higher debug level by saying C<-Debug2> etc. + +=back + =head1 AUTHOR Sebastian Riedel, C