X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FApplication.pm;h=a0e49bc5fbacf33164441c4ed5c08e769dbe8ec9;hb=7f1d3cd72f5b45850f7faa380704bbb633c58f77;hp=c2d58dc8bae21fc74a9f81cda564ec850251cfb9;hpb=5c199c0e9cd05a00bfc04d9688982979a41f3ee8;p=maypole.git diff --git a/lib/Maypole/Application.pm b/lib/Maypole/Application.pm index c2d58dc..a0e49bc 100644 --- a/lib/Maypole/Application.pm +++ b/lib/Maypole/Application.pm @@ -2,29 +2,144 @@ package Maypole::Application; use strict; use warnings; +use UNIVERSAL::require; +use Maypole; +use Maypole::Config; -if ( $ENV{MOD_PERL} ) { - require Apache::MVC; - our @ISA = qw(Apache::MVC); -} -else { - require CGI::Maypole; - our @ISA = qw(CGI::Maypole); +our @ISA; +our $VERSION = '2.11'; + +sub import { + my ( $class, @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: $@"; + # inheritance may already be set up in a multi-app mod_perl environment + push @ISA, $frontend unless __PACKAGE__->isa( $frontend ); + + 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"}, @plugin_modules, $class; + $caller->config(Maypole::Config->new); + $caller->config->masonx({}) if $masonx; + $caller->setup() if $autosetup; + $caller->init() if $autosetup && $autoinit; } 1; =head1 NAME -Maypole::Application - all in wonder front-end +Maypole::Application - Universal Maypole Frontend =head1 SYNOPSIS - use base 'Maypole::Application'; + 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 -The all in wonder front-end. +This is a universal frontend for mod_perl1, mod_perl2, HTML::Mason and CGI. + +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. You must ensure that the +required model config parameters are set in Cconfig>. See +L 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), 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. + +=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 @@ -34,3 +149,5 @@ Idea by Marcus Ramberg, C =head1 LICENSE You may distribute this code under the same terms as Perl itself. + +=cut