4 use base 'Catalyst::Base';
5 use UNIVERSAL::require;
9 our $CATALYST_SCRIPT_GEN = 3;
11 __PACKAGE__->mk_classdata($_) for qw/dispatcher engine log/;
13 our $VERSION = '5.11';
18 Catalyst - The Elegant MVC Web Application Framework
22 # use the helper to start a new application
26 # add models, views, controllers
27 script/create.pl model Something
28 script/create.pl view Stuff
29 script/create.pl controller Yada
34 # command line interface
40 use Catalyst qw/My::Module My::OtherModule/;
42 use Catalyst '-Debug';
44 use Catalyst qw/-Debug -Engine=CGI/;
46 sub default : Private { $_[1]->res->output('Hello') } );
48 sub index : Path('/index.html') {
49 my ( $self, $c ) = @_;
50 $c->res->output('Hello');
54 sub product : Regex('^product[_]*(\d*).html$') {
55 my ( $self, $c ) = @_;
56 $c->stash->{template} = 'product.tt';
57 $c->stash->{product} = $c->req->snippets->[0];
60 See also L<Catalyst::Manual::Intro>
64 Catalyst is based upon L<Maypole>, which you should consider for smaller
67 The key concept of Catalyst is DRY (Don't Repeat Yourself).
69 See L<Catalyst::Manual> for more documentation.
71 Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
72 Omit the C<Catalyst::Plugin::> prefix from the plugin name,
73 so C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
75 use Catalyst 'My::Module';
77 Special flags like -Debug and -Engine can also be specifed as arguments when
80 use Catalyst qw/-Debug My::Module/;
82 The position of plugins and flags in the chain is important, because they are
83 loaded in exactly the order that they appear.
85 The following flags are supported:
91 enables debug output, i.e.:
93 use Catalyst '-Debug';
95 this is equivalent to:
102 Force Catalyst to use a specific engine.
103 Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.:
105 use Catalyst '-Engine=CGI';
115 Overload to enable debug messages.
123 Returns a hashref containing your applications settings.
128 my ( $self, @options ) = @_;
129 my $caller = caller(0);
131 # Prepare inheritance
132 unless ( $caller->isa($self) ) {
134 push @{"$caller\::ISA"}, $self;
137 if ( $caller->engine ) {
138 return; # Catalyst is already initialized
141 unless ( $caller->log ) {
142 $caller->log( Catalyst::Log->new );
146 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) {
148 *{"$caller\::debug"} = sub { 1 };
149 $caller->log->debug('Debug messages enabled');
152 my $engine = 'Catalyst::Engine::CGI';
153 my $dispatcher = 'Catalyst::Dispatcher';
156 if ( $ENV{MOD_PERL} ) {
160 if ( $ENV{MOD_PERL_API_VERSION} == 2 ) {
161 $engine = 'Catalyst::Engine::Apache::MP20';
163 elsif ( $mod_perl::VERSION >= 1.99 ) {
164 $engine = 'Catalyst::Engine::Apache::MP19';
167 $engine = 'Catalyst::Engine::Apache::MP13';
171 $caller->log->info( "You are running an old helper script! "
172 . "Please update your scripts by regenerating the "
173 . "application and copying over the new scripts." )
174 if ( $ENV{CATALYST_SCRIPT_GEN}
175 && ( $ENV{CATALYST_SCRIPT_GEN} < $CATALYST_SCRIPT_GEN ) );
182 next if $caller->debug;
184 *{"$caller\::debug"} = sub { 1 };
185 $caller->log->debug('Debug messages enabled');
188 elsif (/^-Dispatcher=(.*)$/) {
189 $dispatcher = "Catalyst::Dispatcher::$1";
192 elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
193 elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
196 my $plugin = "Catalyst::Plugin::$_";
200 if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ }
202 push @plugins, $plugin;
204 push @{"$caller\::ISA"}, $plugin;
211 my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } );
212 $t->setCols('Class');
213 $t->setColWidth( 'Class', 75, 1 );
214 $t->addRow($_) for @plugins;
215 $caller->log->debug( 'Loaded plugins', $t->draw )
216 if ( @plugins && $caller->debug );
219 $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}"
220 if $ENV{CATALYST_DISPATCHER};
222 $dispatcher->require;
223 die qq/Couldn't load dispatcher "$dispatcher", "$@"/ if $@;
226 push @{"$caller\::ISA"}, $dispatcher;
228 $caller->dispatcher($dispatcher);
229 $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/) if $caller->debug;
232 $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}"
233 if $ENV{CATALYST_ENGINE};
236 die qq/Couldn't load engine "$engine", "$@"/ if $@;
239 push @{"$caller\::ISA"}, $engine;
241 $caller->engine($engine);
242 $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
246 $name =~ s/\:\:/\//g;
247 my $path = $INC{"$name.pm"};
248 my $home = file($path)->absolute->dir;
251 my $subdir = dir($home)->subdir($append);
252 for ( split '/', $name ) { $home = dir($home)->parent }
253 if ( $home =~ /blib$/ ) { $home = dir($home)->parent }
254 elsif ( !-f file( $home, 'Makefile.PL' ) ) { $home = $subdir }
256 if ( $caller->debug ) {
259 ? $caller->log->debug(qq/Found home "$home"/)
260 : $caller->log->debug(qq/Home "$home" doesn't exist/)
261 : $caller->log->debug(q/Couldn't find home/);
263 $caller->config->{home} = $home;
264 $caller->config->{root} = dir($home)->subdir('root');
269 Contains the engine class.
273 Contains the logging object. Unless it is already set Catalyst sets this up with a
274 C<Catalyst::Log> object. To use your own log class:
276 $c->log( MyLogger->new );
277 $c->log->info("now logging with my own logger!");
279 Your log class should implement the methods described in the C<Catalyst::Log>
282 =item $c->plugin( $name, $class, @args )
284 Instant plugins for Catalyst.
285 Classdata accessor/mutator will be created, class loaded and instantiated.
287 MyApp->plugin( 'prototype', 'HTML::Prototype' );
289 $c->prototype->define_javascript_functions;
294 my ( $class, $name, $plugin, @args ) = @_;
296 my $error = $UNIVERSAL::require::ERROR;
297 die qq/Couldn't load instant plugin "$plugin", "$error"/ if $error;
298 eval { $plugin->import };
299 $class->mk_classdata($name);
301 eval { $obj = $plugin->new(@args) };
302 die qq/Couldn't instantiate instant plugin "$plugin", "$@"/ if $@;
304 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
312 mod_perl2 support is considered experimental and may contain bugs.
318 Join #catalyst on irc.perl.org.
322 http://lists.rawmode.org/mailman/listinfo/catalyst
323 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
327 http://catalyst.perl.org
333 =item L<Catalyst::Manual> - The Catalyst Manual
335 =item L<Catalyst::Engine> - Core Engine
337 =item L<Catalyst::Log> - The Log Class.
339 =item L<Catalyst::Request> - The Request Object
341 =item L<Catalyst::Response> - The Response Object
343 =item L<Catalyst::Test> - The test suite.
349 Sebastian Riedel, C<sri@oook.de>
353 Andy Grundman, Andrew Ford, Andrew Ruthven, Autrijus Tang, Christian Hansen,
354 Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton,
355 Gary Ashton Jones, Jesse Sheidlower, Jody Belka, Johan Lindstrom, Leon Brocard,
356 Marcus Ramberg, Tatsuhiko Miyagawa and all the others who've helped.
360 This library is free software . You can redistribute it and/or modify it under
361 the same terms as perl itself.