X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FApplication.pm;h=ae95bb7ee3447df5524c2925adbc7b193d4c0bdc;hb=5e09c784983b4a041e81d15e06456e0c16da5bf3;hp=e0c08fff70e6604f060c4d7f7b8b19ff1761eb0c;hpb=3d3d38f2f6639c90c98c72dc0167a82d52ce9ec4;p=maypole.git diff --git a/lib/Maypole/Application.pm b/lib/Maypole/Application.pm index e0c08ff..ae95bb7 100644 --- a/lib/Maypole/Application.pm +++ b/lib/Maypole/Application.pm @@ -2,70 +2,128 @@ 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 ) = @_; + shift; # not interested in this - we manipulate the caller's @ISA directly + my @plugins = @_; my $caller = caller(0); - no strict 'refs'; - push @{"${caller}::ISA"}, $self; - foreach (@plugins) { - if (/^\-Setup$/) { $caller->setup } - elsif (/^\-Debug$/) { - *{"$caller\::debug"} = sub { 1 }; - warn "Debugging enabled"; + + 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) + { + 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 { - - # The plugin caller should be our application class - eval "package $caller; require Maypole::Plugin::$_"; - if ($@) { warn qq(Loading plugin "Maypole::Plugin::$_" failed: $@) } - else { - warn "Loaded plugin: Maypole::Plugin::$_" if $caller->debug; - unshift @ISA, "Maypole::Plugin::$_"; + 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; } } } -} - -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'; + + no strict 'refs'; + 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. + +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. + +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. +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. -=head2 -Setup +=head1 FRONTEND + +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); @@ -74,7 +132,30 @@ is equivalent to use Maypole::Application; MyApp->setup; -=head2 -Debug +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. + +=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); @@ -83,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 @@ -91,3 +176,5 @@ Idea by Marcus Ramberg, C =head1 LICENSE You may distribute this code under the same terms as Perl itself. + +=cut