X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=a43be27c281070a2242b58d6d242f70b042309ec;hp=2aa4003fe8f2d6656fdfbb25fc054f17dde61471;hb=f7b672efdb91a057a449b353d157bb74761a2d94;hpb=c571e72ba408ecf1af0010563f19b460b2a2a8f9 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 2aa4003..a43be27 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,197 +1,1764 @@ package Catalyst; use strict; -use base 'Catalyst::Base'; +use base 'Catalyst::Component'; +use bytes; use UNIVERSAL::require; +use Catalyst::Exception; use Catalyst::Log; +use Catalyst::Request; +use Catalyst::Request::Upload; +use Catalyst::Response; use Catalyst::Utils; -use Text::ASCIITable; +use Catalyst::Controller; +use File::stat; +use NEXT; +use Text::SimpleTable; use Path::Class; -our $CATALYST_SCRIPT_GEN = 4; +use Time::HiRes qw/gettimeofday tv_interval/; +use URI; +use Scalar::Util qw/weaken blessed/; +use Tree::Simple qw/use_weak_refs/; +use Tree::Simple::Visitor::FindByUID; +use attributes; -__PACKAGE__->mk_classdata($_) for qw/dispatcher engine log/; +__PACKAGE__->mk_accessors( + qw/counter request response state action stack namespace/ +); -our $VERSION = '5.23'; -our @ISA; +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } + +# Laziness++ +*comp = \&component; +*req = \&request; +*res = \&response; + +# For backwards compatibility +*finalize_output = \&finalize_body; + +# For statistics +our $COUNT = 1; +our $START = time; +our $RECURSION = 1000; +our $DETACH = "catalyst_detach\n"; + +require Module::Pluggable::Fast; + +# Helper script generation +our $CATALYST_SCRIPT_GEN = 27; + +__PACKAGE__->mk_classdata($_) + for qw/components arguments dispatcher engine log dispatcher_class + engine_class context_class request_class response_class setup_finished/; + +__PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); +__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->request_class('Catalyst::Request'); +__PACKAGE__->response_class('Catalyst::Response'); + +our $VERSION = '5.66'; + +sub import { + my ( $class, @arguments ) = @_; + + # We have to limit $class to Catalyst to avoid pushing Catalyst upon every + # callers @ISA. + return unless $class eq 'Catalyst'; + + my $caller = caller(0); + + unless ( $caller->isa('Catalyst') ) { + no strict 'refs'; + push @{"$caller\::ISA"}, $class, 'Catalyst::Controller'; + } + + $caller->arguments( [@arguments] ); + $caller->setup_home; +} =head1 NAME -Catalyst - The Elegant MVC Web Application Framework +Catalyst - The Elegant MVC Web Application Framework + +=head1 SYNOPSIS + + # use the helper to start a new application + catalyst.pl MyApp + + # add models, views, controllers + script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db + script/myapp_create.pl view TT TT + script/myapp_create.pl controller Search + + # built in testserver -- use -r to restart automatically on changes + script/myapp_server.pl + + # command line testing interface + script/myapp_test.pl /yada + + ### in MyApp.pm + use Catalyst qw/-Debug/; # include plugins here as well + + sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc. + my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2 + $c->stash->{template} = 'foo.tt'; # set the template + # lookup something from db -- stash vars are passed to TT + $c->stash->{data} = + MyApp::Model::Database::Foo->search( { country => $args[0] } ); + if ( $c->req->params->{bar} ) { # access GET or POST parameters + $c->forward( 'bar' ); # process another action + # do something else after forward returns + } + } + + # The foo.tt TT template can use the stash data from the database + [% WHILE (item = data.next) %] + [% item.foo %] + [% END %] + + # called for /bar/of/soap, /bar/of/soap/10, etc. + sub bar : Path('/bar/of/soap') { ... } + + # called for all actions, from the top-most controller downwards + sub auto : Private { + my ( $self, $c ) = @_; + if ( !$c->user ) { + $c->res->redirect( '/login' ); # require login + return 0; # abort request and go immediately to end() + } + return 1; # success; carry on to next action + } + + # called after all actions are finished + sub end : Private { + my ( $self, $c ) = @_; + if ( scalar @{ $c->error } ) { ... } # handle errors + return if $c->res->body; # already have a response + $c->forward( 'MyApp::View::TT' ); # render template + } + + ### in MyApp/Controller/Foo.pm + # called for /foo/bar + sub bar : Local { ... } + + # called for /blargle + sub blargle : Global { ... } + + # an index action matches /foo, but not /foo/1, etc. + sub index : Private { ... } + + ### in MyApp/Controller/Foo/Bar.pm + # called for /foo/bar/baz + sub baz : Local { ... } + + # first MyApp auto is called, then Foo auto, then this + sub auto : Private { ... } + + # powerful regular expression paths are also possible + sub details : Regex('^product/(\w+)/details$') { + my ( $self, $c ) = @_; + # extract the (\w+) from the URI + my $product = $c->req->snippets->[0]; + } + +See L for additional information. + +=head1 DESCRIPTION + +The key concept of Catalyst is DRY (Don't Repeat Yourself). + +See L for more documentation. + +Catalyst plugins can be loaded by naming them as arguments to the "use +Catalyst" statement. Omit the C prefix from the +plugin name, i.e., C becomes +C. + + use Catalyst qw/My::Module/; + +If your plugin starts with a name other than C, you can +fully qualify the name by using a unary plus: + + use Catalyst qw/ + My::Module + +Fully::Qualified::Plugin::Name + /; + +Special flags like C<-Debug> and C<-Engine> can also be specified as +arguments when Catalyst is loaded: + + use Catalyst qw/-Debug My::Module/; + +The position of plugins and flags in the chain is important, because +they are loaded in exactly the order in which they appear. + +The following flags are supported: + +=head2 -Debug + +Enables debug output. + +=head2 -Engine + +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: + + use Catalyst qw/-Engine=CGI/; + +=head2 -Home + +Forces Catalyst to use a specific home directory, e.g.: + + use Catalyst qw[-Home=/usr/sri]; + +=head2 -Log + +Specifies log level. + +=head1 METHODS + +=head2 INFORMATION ABOUT THE CURRENT REQUEST + +=head2 $c->action + +Returns a L object for the current action, which +stringifies to the action name. See L. + +=head2 $c->namespace + +Returns the namespace of the current action, i.e., the uri prefix +corresponding to the controller of the current action. For example: + + # in Controller::Foo::Bar + $c->namespace; # returns 'foo/bar'; + +=head2 $c->request + +=head2 $c->req + +Returns the current L object. See +L. + +=head2 PROCESSING AND RESPONSE TO THE CURRENT REQUEST + +=head2 $c->forward( $action [, \@arguments ] ) + +=head2 $c->forward( $class, $method, [, \@arguments ] ) + +Forwards processing to a private action. If you give a class name but no +method, C is called. You may also optionally pass arguments +in an arrayref. The action will receive the arguments in C<@_> and +C<$c-Ereq-Eargs>. Upon returning from the function, +C<$c-Ereq-Eargs> will be restored to the previous values. + +Any data Ced from the action forwarded to, will be returned by the +call to forward. + + my $foodata = $c->forward('/foo'); + $c->forward('index'); + $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); + $c->forward('MyApp::View::TT'); + +=cut + +sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } + +=head2 $c->detach( $action [, \@arguments ] ) + +=head2 $c->detach( $class, $method, [, \@arguments ] ) + +The same as C, but doesn't return. + +=cut + +sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } + +=head2 $c->error + +=head2 $c->error($error, ...) + +=head2 $c->error($arrayref) + +Returns an arrayref containing error messages. If Catalyst encounters an +error while processing a request, it stores the error in $c->error. This +method should not be used to store non-fatal error messages. + + my @error = @{ $c->error }; + +Add a new error. + + $c->error('Something bad happened'); + +Clear errors. You probably don't want to clear the errors unless you are +implementing a custom error screen. + + $c->error(0); + +=cut + +sub error { + my $c = shift; + if ( $_[0] ) { + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + push @{ $c->{error} }, @$error; + } + elsif ( defined $_[0] ) { $c->{error} = undef } + return $c->{error} || []; +} + +=head2 $c->response + +=head2 $c->res + +Returns the current L object. + +=head2 $c->stash + +Returns a hashref to the stash, which may be used to store data and pass +it between components during a request. You can also set hash keys by +passing arguments. The stash is automatically sent to the view. The +stash is cleared at the end of a request; it cannot be used for +persistent storage. + + $c->stash->{foo} = $bar; + $c->stash( { moose => 'majestic', qux => 0 } ); + $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref + + # stash is automatically passed to the view for use in a template + $c->forward( 'MyApp::V::TT' ); + +=cut + +sub stash { + my $c = shift; + if (@_) { + my $stash = @_ > 1 ? {@_} : $_[0]; + while ( my ( $key, $val ) = each %$stash ) { + $c->{stash}->{$key} = $val; + } + } + return $c->{stash}; +} + +=head2 $c->state + +Contains the return value of the last executed action. + +=cut + +# search via regex +sub _comp_search { + my ($c, @names) = @_; + + foreach my $name (@names) { + foreach my $component ( keys %{ $c->components } ) { + my $comp = $c->components->{$component} if $component =~ /$name/i; + if ($comp) { + if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) { + return $comp->ACCEPT_CONTEXT($c); + } + else { return $comp } + } + } + } + + return undef; +} + +# try explicit component names +sub _comp_explicit { + my ($c, @names) = @_; + + foreach my $try (@names) { + if ( exists $c->components->{$try} ) { + my $comp = $c->components->{$try}; + if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) { + return $comp->ACCEPT_CONTEXT($c); + } + else { return $comp } + } + } + + return undef; +} + +# like component, but try just these prefixes before regex searching, +# and do not try to return "sort keys %{ $c->components }" +sub _comp_prefixes { + my ($c, $name, @prefixes) = @_; + + my $appclass = ref $c || $c; + + my @names = map { "${appclass}::${_}::${name}" } @prefixes; + + my $comp = $c->_comp_explicit(@names); + return $comp if defined($comp); + $comp = $c->_comp_search($name); + return $comp; +} + +=head2 COMPONENT ACCESSORS + +=head2 $c->comp($name) + +=head2 $c->component($name) + +Gets a component object by name. This method is no longer recommended, +unless you want to get a specific component by full +class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview> +should be used instead. + +=cut + +sub component { + my $c = shift; + + if (@_) { + + my $name = shift; + + my $appclass = ref $c || $c; + + my @names = ( + $name, "${appclass}::${name}", + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ + ); + + my $comp = $c->_comp_explicit(@names); + return $comp if defined($comp); + + $comp = $c->_comp_search($name); + return $comp if defined($comp); + } + + return sort keys %{ $c->components }; +} + +=head2 $c->controller($name) + +Gets a L instance by name. + + $c->controller('Foo')->do_stuff; + +=cut + +sub controller { + my ( $c, $name ) = @_; + return $c->_comp_prefixes($name, qw/Controller C/); +} + +=head2 $c->model($name) + +Gets a L instance by name. + + $c->model('Foo')->do_stuff; + +=cut + +sub model { + my ( $c, $name ) = @_; + return $c->_comp_prefixes($name, qw/Model M/); +} + +=head2 $c->view($name) + +Gets a L instance by name. + + $c->view('Foo')->do_stuff; + +=cut + +sub view { + my ( $c, $name ) = @_; + return $c->_comp_prefixes($name, qw/View V/); +} + +=head2 Class data and helper classes + +=head2 $c->config + +Returns or takes a hashref containing the application's configuration. + + __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } ); + +You can also use a L config file like myapp.yml in your +applications home directory. + + --- + db: dsn:SQLite:foo.db + +=cut + +sub config { + my $c = shift; + + $c->log->warn("Setting config after setup has been run is not a good idea.") + if ( @_ and $c->setup_finished ); + + $c->NEXT::config(@_); +} + +=head2 $c->debug + +Overload to enable debug messages (same as -Debug option). + +=cut + +sub debug { 0 } + +=head2 $c->dispatcher + +Returns the dispatcher instance. Stringifies to class name. See +L. + +=head2 $c->engine + +Returns the engine instance. Stringifies to the class name. See +L. + +=head2 $c->log + +Returns the logging object instance. Unless it is already set, Catalyst sets +this up with a L object. To use your own log class, set the +logger with the C<< __PACKAGE__->log >> method prior to calling +C<< __PACKAGE__->setup >>. + + __PACKAGE__->log( MyLogger->new ); + __PACKAGE__->setup; + +And later: + + $c->log->info( 'Now logging with my own logger!' ); + +Your log class should implement the methods described in the +L man page. + +=cut + +=head2 UTILITY METHODS + +=head2 $c->path_to(@path) + +Merges C<@path> with C<$c-Econfig-E{home}> and returns a +L object. + +For example: + + $c->path_to( 'db', 'sqlite.db' ); + +=cut + +sub path_to { + my ( $c, @path ) = @_; + my $path = dir( $c->config->{home}, @path ); + if ( -d $path ) { return $path } + else { return file( $c->config->{home}, @path ) } +} + +=head2 $c->plugin( $name, $class, @args ) + +Helper method for plugins. It creates a classdata accessor/mutator and +loads and instantiates the given class. + + MyApp->plugin( 'prototype', 'HTML::Prototype' ); + + $c->prototype->define_javascript_functions; + +=cut + +sub plugin { + my ( $class, $name, $plugin, @args ) = @_; + $class->_register_plugin( $plugin, 1 ); + + eval { $plugin->import }; + $class->mk_classdata($name); + my $obj; + eval { $obj = $plugin->new(@args) }; + + if ($@) { + Catalyst::Exception->throw( message => + qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); + } + + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; +} + +=head2 MyApp->setup + +Initializes the dispatcher and engine, loads any plugins, and loads the +model, view, and controller components. You may also specify an array +of plugins to load here, if you choose to not load them in the C line. + + MyApp->setup; + MyApp->setup( qw/-Debug/ ); + +=cut + +sub setup { + my ( $class, @arguments ) = @_; + + unless ( $class->isa('Catalyst') ) { + + Catalyst::Exception->throw( + message => qq/'$class' does not inherit from Catalyst/ ); + } + + if ( $class->arguments ) { + @arguments = ( @arguments, @{ $class->arguments } ); + } + + # Process options + my $flags = {}; + + foreach (@arguments) { + + if (/^-Debug$/) { + $flags->{log} = + ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; + } + elsif (/^-(\w+)=?(.*)$/) { + $flags->{ lc $1 } = $2; + } + else { + push @{ $flags->{plugins} }, $_; + } + } + + $class->setup_home( delete $flags->{home} ); + + $class->setup_log( delete $flags->{log} ); + $class->setup_plugins( delete $flags->{plugins} ); + $class->setup_dispatcher( delete $flags->{dispatcher} ); + $class->setup_engine( delete $flags->{engine} ); + + for my $flag ( sort keys %{$flags} ) { + + if ( my $code = $class->can( 'setup_' . $flag ) ) { + &$code( $class, delete $flags->{$flag} ); + } + else { + $class->log->warn(qq/Unknown flag "$flag"/); + } + } + + $class->log->warn( + <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) ); +You are running an old script! + + Please update by running (this will overwrite existing files): + catalyst.pl -force -scripts $class + + or (this will not overwrite existing files): + catalyst.pl -scripts $class +EOF + + if ( $class->debug ) { + + my @plugins = (); + + { + no strict 'refs'; + @plugins = + map { $_ . ' ' . ( $_->VERSION || '' ) } + grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; + } + + if (@plugins) { + my $t = Text::SimpleTable->new(76); + $t->row($_) for @plugins; + $class->log->debug( "Loaded plugins:\n" . $t->draw ); + } + + my $dispatcher = $class->dispatcher; + my $engine = $class->engine; + my $home = $class->config->{home}; + + $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); + $class->log->debug(qq/Loaded engine "$engine"/); + + $home + ? ( -d $home ) + ? $class->log->debug(qq/Found home "$home"/) + : $class->log->debug(qq/Home "$home" doesn't exist/) + : $class->log->debug(q/Couldn't find home/); + } + + # Call plugins setup + { + no warnings qw/redefine/; + local *setup = sub { }; + $class->setup; + } + + # Initialize our data structure + $class->components( {} ); + + $class->setup_components; + + if ( $class->debug ) { + my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] ); + for my $comp ( sort keys %{ $class->components } ) { + my $type = ref $class->components->{$comp} ? 'instance' : 'class'; + $t->row( $comp, $type ); + } + $class->log->debug( "Loaded components:\n" . $t->draw ) + if ( keys %{ $class->components } ); + } + + # Add our self to components, since we are also a component + $class->components->{$class} = $class; + + $class->setup_actions; + + if ( $class->debug ) { + my $name = $class->config->{name} || 'Application'; + $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); + } + $class->log->_flush() if $class->log->can('_flush'); + + $class->setup_finished(1); +} + +=head2 $c->uri_for( $path, [ @args ] ) + +Merges path with C<$c-Erequest-Ebase> for absolute uri's and +with C<$c-Enamespace> for relative uri's, then returns a +normalized L object. If any args are passed, they are added at the +end of the path. If the last argument to uri_for is a hash reference, +it is assumed to contain GET parameter key/value pairs, which will be +appended to the URI in standard fashion. + +=cut + +sub uri_for { + my ( $c, $path, @args ) = @_; + my $base = $c->request->base->clone; + my $basepath = $base->path; + $basepath =~ s/\/$//; + $basepath .= '/'; + my $namespace = $c->namespace; + + # massage namespace, empty if absolute path + $namespace =~ s/^\///; + $namespace .= '/' if $namespace; + $path ||= ''; + $namespace = '' if $path =~ /^\//; + $path =~ s/^\///; + + my $params = + ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} ); + + # join args with '/', or a blank string + my $args = ( scalar @args ? '/' . join( '/', @args ) : '' ); + $args =~ s/^\/// unless $path; + my $res = + URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base ) + ->canonical; + $res->query_form(%$params); + $res; +} + +=head2 $c->welcome_message + +Returns the Catalyst welcome HTML page. + +=cut + +sub welcome_message { + my $c = shift; + my $name = $c->config->{name}; + my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $prefix = Catalyst::Utils::appprefix( ref $c ); + $c->response->content_type('text/html; charset=utf-8'); + return <<"EOF"; + + + + + + $name on Catalyst $VERSION + + + +
+
+

$name on Catalyst + $VERSION

+
+
+

+ Catalyst Logo +

+

Welcome to the wonderful world of Catalyst. + This MVC + framework will make web development something you had + never expected it to be: Fun, rewarding, and quick.

+

What to do now?

+

That really depends on what you want to do. + We do, however, provide you with a few starting points.

+

If you want to jump right into web development with Catalyst + you might want to check out the documentation.

+ 
perldoc Catalyst::Manual::Intro
+perldoc Catalyst::Manual::Tutorial
+perldoc Catalyst::Manual
+

What to do next?

+

Next it's time to write an actual application. Use the + helper scripts to generate controllers, + models, and + views; + they can save you a lot of work.

+ 
script/${prefix}_create.pl -help
+

Also, be sure to check out the vast and growing + collection of plugins for Catalyst on CPAN; + you are likely to find what you need there. +

+ +

Need help?

+

Catalyst has a very active community. Here are the main places to + get in touch with us.

+ +

In conclusion

+

The Catalyst team hopes you will enjoy using Catalyst as much + as we enjoyed making it. Please contact us if you have ideas + for improvement or other feedback.

+
+
+ + +EOF +} + +=head1 INTERNAL METHODS + +These methods are not meant to be used by end users. + +=head2 $c->components + +Returns a hash of components. + +=head2 $c->context_class + +Returns or sets the context class. + +=head2 $c->counter + +Returns a hashref containing coderefs and execution counts (needed for +deep recursion detection). + +=head2 $c->depth + +Returns the number of actions on the current internal execution stack. + +=head2 $c->dispatch + +Dispatches a request to actions. + +=cut + +sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) } + +=head2 $c->dispatcher_class + +Returns or sets the dispatcher class. + +=head2 $c->dump_these + +Returns a list of 2-element array references (name, structure) pairs +that will be dumped on the error page in debug mode. + +=cut + +sub dump_these { + my $c = shift; + [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],; +} + +=head2 $c->engine_class + +Returns or sets the engine class. + +=head2 $c->execute( $class, $coderef ) + +Execute a coderef in given class and catch exceptions. Errors are available +via $c->error. + +=cut + +sub execute { + my ( $c, $class, $code ) = @_; + $class = $c->component($class) || $class; + $c->state(0); + + if ($c->depth >= $RECURSION) { + my $action = "$code"; + $action = "/$action" unless $action =~ /\-\>/; + my $error = qq/Deep recursion detected calling "$action"/; + $c->log->error($error); + $c->error($error); + $c->state(0); + return $c->state; + } + + + if ( $c->debug ) { + my $action = "$code"; + $action = "/$action" unless $action =~ /\-\>/; + $c->counter->{"$code"}++; + + # determine if the call was the result of a forward + # this is done by walking up the call stack and looking for a calling + # sub of Catalyst::forward before the eval + my $callsub = q{}; + for my $index ( 1 .. 10 ) { + last + if ( ( caller($index) )[0] eq 'Catalyst' + && ( caller($index) )[3] eq '(eval)' ); + + if ( ( caller($index) )[3] =~ /forward$/ ) { + $callsub = ( caller($index) )[3]; + $action = "-> $action"; + last; + } + } + + my $node = Tree::Simple->new( + { + action => $action, + elapsed => undef, # to be filled in later + } + ); + $node->setUID( "$code" . $c->counter->{"$code"} ); + + unless ( ( $code->name =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ) + { + + # is this a root-level call or a forwarded call? + if ( $callsub =~ /forward$/ ) { + + # forward, locate the caller + if ( my $parent = $c->stack->[-1] ) { + my $visitor = Tree::Simple::Visitor::FindByUID->new; + $visitor->searchForUID( + "$parent" . $c->counter->{"$parent"} ); + $c->{stats}->accept($visitor); + if ( my $result = $visitor->getResult ) { + $result->addChild($node); + } + } + else { + + # forward with no caller may come from a plugin + $c->{stats}->addChild($node); + } + } + else { + + # root-level call + $c->{stats}->addChild($node); + } + } + } + + push( @{ $c->stack }, $code ); + my $elapsed = 0; + my $start = 0; + $start = [gettimeofday] if $c->debug; + eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }; + $elapsed = tv_interval($start) if $c->debug; + + if ( $c->debug ) { + unless ( ( $code->name =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ) + { + + # FindByUID uses an internal die, so we save the existing error + my $error = $@; + + # locate the node in the tree and update the elapsed time + my $visitor = Tree::Simple::Visitor::FindByUID->new; + $visitor->searchForUID( "$code" . $c->counter->{"$code"} ); + $c->{stats}->accept($visitor); + if ( my $result = $visitor->getResult ) { + my $value = $result->getNodeValue; + $value->{elapsed} = sprintf( '%fs', $elapsed ); + $result->setNodeValue($value); + } + + # restore error + $@ = $error || undef; + } + } + my $last = ${ $c->stack }[-1]; + pop( @{ $c->stack } ); + + if ( my $error = $@ ) { + if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 } + else { + unless ( ref $error ) { + chomp $error; + my $class = $last->class; + my $name = $last->name; + $error = qq/Caught exception in $class->$name "$error"/; + } + $c->error($error); + $c->state(0); + } + } + return $c->state; +} + +=head2 $c->finalize + +Finalizes the request. + +=cut + +sub finalize { + my $c = shift; + + for my $error ( @{ $c->error } ) { + $c->log->error($error); + } + + $c->finalize_uploads; + + # Error + if ( $#{ $c->error } >= 0 ) { + $c->finalize_error; + } + + $c->finalize_headers; + + # HEAD request + if ( $c->request->method eq 'HEAD' ) { + $c->response->body(''); + } + + $c->finalize_body; + + return $c->response->status; +} + +=head2 $c->finalize_body + +Finalizes body. + +=cut + +sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) } + +=head2 $c->finalize_cookies + +Finalizes cookies. + +=cut + +sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) } + +=head2 $c->finalize_error + +Finalizes error. + +=cut + +sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) } + +=head2 $c->finalize_headers + +Finalizes headers. + +=cut + +sub finalize_headers { + my $c = shift; + + # Check if we already finalized headers + return if $c->response->{_finalized_headers}; + + # Handle redirects + if ( my $location = $c->response->redirect ) { + $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; + $c->response->header( Location => $location ); + } + + # Content-Length + if ( $c->response->body && !$c->response->content_length ) { + + # get the length from a filehandle + if ( blessed($c->response->body) && $c->response->body->can('read') ) { + if ( my $stat = stat $c->response->body ) { + $c->response->content_length( $stat->size ); + } + else { + $c->log->warn('Serving filehandle without a content-length'); + } + } + else { + $c->response->content_length( bytes::length( $c->response->body ) ); + } + } + + # Errors + if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) { + $c->response->headers->remove_header("Content-Length"); + $c->response->body(''); + } + + $c->finalize_cookies; + + $c->engine->finalize_headers( $c, @_ ); + + # Done + $c->response->{_finalized_headers} = 1; +} + +=head2 $c->finalize_output + +An alias for finalize_body. + +=head2 $c->finalize_read + +Finalizes the input after reading is complete. + +=cut + +sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) } + +=head2 $c->finalize_uploads + +Finalizes uploads. Cleans up any temporary files. + +=cut + +sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) } + +=head2 $c->get_action( $action, $namespace ) + +Gets an action in a given namespace. + +=cut + +sub get_action { my $c = shift; $c->dispatcher->get_action(@_) } + +=head2 $c->get_actions( $action, $namespace ) + +Gets all actions of a given name in a namespace and all parent +namespaces. + +=cut + +sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) } + +=head2 $c->handle_request( $class, @arguments ) + +Called to handle each HTTP request. + +=cut + +sub handle_request { + my ( $class, @arguments ) = @_; + + # Always expect worst case! + my $status = -1; + eval { + my $stats = ( $class->debug ) ? Tree::Simple->new: q{}; + + my $handler = sub { + my $c = $class->prepare(@arguments); + $c->{stats} = $stats; + $c->dispatch; + return $c->finalize; + }; + + if ( $class->debug ) { + my $start = [gettimeofday]; + $status = &$handler; + my $elapsed = tv_interval $start; + $elapsed = sprintf '%f', $elapsed; + my $av = sprintf '%.3f', + ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); + my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] ); + + $stats->traverse( + sub { + my $action = shift; + my $stat = $action->getNodeValue; + $t->row( ( q{ } x $action->getDepth ) . $stat->{action}, + $stat->{elapsed} || '??' ); + } + ); + + $class->log->info( + "Request took ${elapsed}s ($av/s)\n" . $t->draw ); + } + else { $status = &$handler } + + }; + + if ( my $error = $@ ) { + chomp $error; + $class->log->error(qq/Caught exception in engine "$error"/); + } + + $COUNT++; + $class->log->_flush() if $class->log->can('_flush'); + return $status; +} + +=head2 $c->prepare( @arguments ) + +Creates a Catalyst context from an engine-specific request (Apache, CGI, +etc.). + +=cut + +sub prepare { + my ( $class, @arguments ) = @_; + + $class->context_class( ref $class || $class ) unless $class->context_class; + my $c = $class->context_class->new( + { + counter => {}, + stack => [], + request => $class->request_class->new( + { + arguments => [], + body_parameters => {}, + cookies => {}, + headers => HTTP::Headers->new, + parameters => {}, + query_parameters => {}, + secure => 0, + snippets => [], + uploads => {} + } + ), + response => $class->response_class->new( + { + body => '', + cookies => {}, + headers => HTTP::Headers->new(), + status => 200 + } + ), + stash => {}, + state => 0 + } + ); + + # For on-demand data + $c->request->{_context} = $c; + $c->response->{_context} = $c; + weaken( $c->request->{_context} ); + weaken( $c->response->{_context} ); + + if ( $c->debug ) { + my $secs = time - $START || 1; + my $av = sprintf '%.3f', $COUNT / $secs; + $c->log->debug('**********************************'); + $c->log->debug("* Request $COUNT ($av/s) [$$]"); + $c->log->debug('**********************************'); + $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); + } + + $c->prepare_request(@arguments); + $c->prepare_connection; + $c->prepare_query_parameters; + $c->prepare_headers; + $c->prepare_cookies; + $c->prepare_path; + + # On-demand parsing + $c->prepare_body unless $c->config->{parse_on_demand}; + + my $method = $c->req->method || ''; + my $path = $c->req->path || ''; + my $address = $c->req->address || ''; + + $c->log->debug(qq/"$method" request for "$path" from "$address"/) + if $c->debug; + + $c->prepare_action; + + return $c; +} + +=head2 $c->prepare_action + +Prepares action. + +=cut + +sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) } + +=head2 $c->prepare_body + +Prepares message body. + +=cut + +sub prepare_body { + my $c = shift; + + # Do we run for the first time? + return if defined $c->request->{_body}; + + # Initialize on-demand data + $c->engine->prepare_body( $c, @_ ); + $c->prepare_parameters; + $c->prepare_uploads; + + if ( $c->debug && keys %{ $c->req->body_parameters } ) { + my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); + for my $key ( sort keys %{ $c->req->body_parameters } ) { + my $param = $c->req->body_parameters->{$key}; + my $value = defined($param) ? $param : ''; + $t->row( $key, + ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); + } + $c->log->debug( "Body Parameters are:\n" . $t->draw ); + } +} -=head1 SYNOPSIS +=head2 $c->prepare_body_chunk( $chunk ) - # use the helper to start a new application - catalyst.pl MyApp - cd MyApp +Prepares a chunk of data before sending it to L. - # add models, views, controllers - script/create.pl model Something - script/create.pl view Stuff - script/create.pl controller Yada +=cut + +sub prepare_body_chunk { + my $c = shift; + $c->engine->prepare_body_chunk( $c, @_ ); +} - # built in testserver - script/server.pl +=head2 $c->prepare_body_parameters - # command line interface - script/test.pl /yada +Prepares body parameters. +=cut - use Catalyst; +sub prepare_body_parameters { + my $c = shift; + $c->engine->prepare_body_parameters( $c, @_ ); +} - use Catalyst qw/My::Module My::OtherModule/; +=head2 $c->prepare_connection - use Catalyst '-Debug'; +Prepares connection. - use Catalyst qw/-Debug -Engine=CGI/; +=cut - sub default : Private { $_[1]->res->output('Hello') } ); +sub prepare_connection { + my $c = shift; + $c->engine->prepare_connection( $c, @_ ); +} - sub index : Path('/index.html') { - my ( $self, $c ) = @_; - $c->res->output('Hello'); - $c->forward('foo'); +=head2 $c->prepare_cookies + +Prepares cookies. + +=cut + +sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) } + +=head2 $c->prepare_headers + +Prepares headers. + +=cut + +sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) } + +=head2 $c->prepare_parameters + +Prepares parameters. + +=cut + +sub prepare_parameters { + my $c = shift; + $c->prepare_body_parameters; + $c->engine->prepare_parameters( $c, @_ ); +} + +=head2 $c->prepare_path + +Prepares path and base. + +=cut + +sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) } + +=head2 $c->prepare_query_parameters + +Prepares query parameters. + +=cut + +sub prepare_query_parameters { + my $c = shift; + + $c->engine->prepare_query_parameters( $c, @_ ); + + if ( $c->debug && keys %{ $c->request->query_parameters } ) { + my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); + for my $key ( sort keys %{ $c->req->query_parameters } ) { + my $param = $c->req->query_parameters->{$key}; + my $value = defined($param) ? $param : ''; + $t->row( $key, + ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); + } + $c->log->debug( "Query Parameters are:\n" . $t->draw ); } +} - sub product : Regex('^product[_]*(\d*).html$') { - my ( $self, $c ) = @_; - $c->stash->{template} = 'product.tt'; - $c->stash->{product} = $c->req->snippets->[0]; +=head2 $c->prepare_read + +Prepares the input for reading. + +=cut + +sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) } + +=head2 $c->prepare_request + +Prepares the engine request. + +=cut + +sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) } + +=head2 $c->prepare_uploads + +Prepares uploads. + +=cut + +sub prepare_uploads { + my $c = shift; + + $c->engine->prepare_uploads( $c, @_ ); + + if ( $c->debug && keys %{ $c->request->uploads } ) { + my $t = Text::SimpleTable->new( + [ 12, 'Key' ], + [ 28, 'Filename' ], + [ 18, 'Type' ], + [ 9, 'Size' ] + ); + for my $key ( sort keys %{ $c->request->uploads } ) { + my $upload = $c->request->uploads->{$key}; + for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) { + $t->row( $key, $u->filename, $u->type, $u->size ); + } + } + $c->log->debug( "File Uploads are:\n" . $t->draw ); } +} -See also L +=head2 $c->prepare_write -=head1 DESCRIPTION +Prepares the output for writing. -Catalyst is based upon L, which you should consider for smaller -projects. +=cut -The key concept of Catalyst is DRY (Don't Repeat Yourself). +sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) } -See L for more documentation. +=head2 $c->request_class -Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. -Omit the C prefix from the plugin name, -so C becomes C. +Returns or sets the request class. - use Catalyst 'My::Module'; +=head2 $c->response_class -Special flags like -Debug and -Engine can also be specifed as arguments when -Catalyst is loaded: +Returns or sets the response class. - use Catalyst qw/-Debug My::Module/; +=head2 $c->read( [$maxlength] ) -The position of plugins and flags in the chain is important, because they are -loaded in exactly the order that they appear. +Reads a chunk of data from the request body. This method is designed to +be used in a while loop, reading C<$maxlength> bytes on every call. +C<$maxlength> defaults to the size of the request if not specified. -The following flags are supported: +You have to set Cconfig-E{parse_on_demand}> to use this +directly. + +=cut + +sub read { my $c = shift; return $c->engine->read( $c, @_ ) } -=over 4 +=head2 $c->run -=item -Debug +Starts the engine. -enables debug output, i.e.: +=cut - use Catalyst '-Debug'; +sub run { my $c = shift; return $c->engine->run( $c, @_ ) } -this is equivalent to: +=head2 $c->set_action( $action, $code, $namespace, $attrs ) - use Catalyst; - sub debug { 1 } +Sets an action in a given namespace. -=item -Engine +=cut -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) } - use Catalyst '-Engine=CGI'; +=head2 $c->setup_actions($component) -=back +Sets up actions for a component. -=head1 METHODS +=cut -=over 4 +sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) } -=item debug +=head2 $c->setup_components -Overload to enable debug messages. +Sets up components. =cut -sub debug { 0 } +sub setup_components { + my $class = shift; + + my $callback = sub { + my ( $component, $context ) = @_; + + unless ( $component->can('COMPONENT') ) { + return $component; + } -=item config + my $suffix = Catalyst::Utils::class2classsuffix($component); + my $config = $class->config->{$suffix} || {}; -Returns a hashref containing your applications settings. + my $instance; + + eval { $instance = $component->COMPONENT( $context, $config ); }; + + if ( my $error = $@ ) { + + chomp $error; + + Catalyst::Exception->throw( message => + qq/Couldn't instantiate component "$component", "$error"/ ); + } + + Catalyst::Exception->throw( message => +qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/ + ) + unless ref $instance; + return $instance; + }; + + eval "package $class;\n" . q!Module::Pluggable::Fast->import( + name => '_catalyst_components', + search => [ + "$class\::Controller", "$class\::C", + "$class\::Model", "$class\::M", + "$class\::View", "$class\::V" + ], + callback => $callback + ); + !; + + if ( my $error = $@ ) { + + chomp $error; + + Catalyst::Exception->throw( + message => qq/Couldn't load components "$error"/ ); + } + + for my $component ( $class->_catalyst_components($class) ) { + $class->components->{ ref $component || $component } = $component; + } +} + +=head2 $c->setup_dispatcher + +Sets up dispatcher. =cut -sub import { - my ( $self, @options ) = @_; - my $caller = caller(0); +sub setup_dispatcher { + my ( $class, $dispatcher ) = @_; - # Prepare inheritance - unless ( $caller->isa($self) ) { - no strict 'refs'; - push @{"$caller\::ISA"}, $self; + if ($dispatcher) { + $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher; } - if ( $caller->engine ) { - return; # Catalyst is already initialized + if ( $ENV{CATALYST_DISPATCHER} ) { + $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER}; } - unless ( $caller->log ) { - $caller->log( Catalyst::Log->new ); + if ( $ENV{ uc($class) . '_DISPATCHER' } ) { + $dispatcher = + 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' }; } - # Debug? - if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) { - no strict 'refs'; - *{"$caller\::debug"} = sub { 1 }; - $caller->log->debug('Debug messages enabled'); + unless ($dispatcher) { + $dispatcher = $class->dispatcher_class; } - my $engine = 'Catalyst::Engine::CGI'; - my $dispatcher = 'Catalyst::Dispatcher'; + $dispatcher->require; - if ( $ENV{MOD_PERL} ) { + if ($@) { + Catalyst::Exception->throw( + message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ ); + } - my ( $software, $version ) = $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/; + # dispatcher instance + $class->dispatcher( $dispatcher->new ); +} - $version =~ s/_//g; - $version =~ s/(\.[^.]+)\./$1/g; +=head2 $c->setup_engine - if ( $software eq 'mod_perl') { +Sets up engine. - if ( $version >= 1.99922 ) { +=cut - $engine = 'Catalyst::Engine::Apache::MP20'; +sub setup_engine { + my ( $class, $engine ) = @_; - if ( Apache2::Request->require ) { - $engine = 'Catalyst::Engine::Apache::MP20::Apreq'; - } - } + if ($engine) { + $engine = 'Catalyst::Engine::' . $engine; + } + + if ( $ENV{CATALYST_ENGINE} ) { + $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE}; + } + + if ( $ENV{ uc($class) . '_ENGINE' } ) { + $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' }; + } + + if ( $ENV{MOD_PERL} ) { - elsif ( $version >= 1.9901 ) { + # create the apache method + { + no strict 'refs'; + *{"$class\::apache"} = sub { shift->engine->apache }; + } + + my ( $software, $version ) = + $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/; + + $version =~ s/_//g; + $version =~ s/(\.[^.]+)\./$1/g; - $engine = 'Catalyst::Engine::Apache::MP19'; + if ( $software eq 'mod_perl' ) { - if ( Apache::Request->require ) { - $engine = 'Catalyst::Engine::Apache::MP19::Apreq'; + if ( !$engine ) { + + if ( $version >= 1.99922 ) { + $engine = 'Catalyst::Engine::Apache2::MP20'; } - } - elsif ( $version >= 1.24 ) { + elsif ( $version >= 1.9901 ) { + $engine = 'Catalyst::Engine::Apache2::MP19'; + } - $engine = 'Catalyst::Engine::Apache::MP13'; + elsif ( $version >= 1.24 ) { + $engine = 'Catalyst::Engine::Apache::MP13'; + } - if ( Apache::Request->require ) { - $engine = 'Catalyst::Engine::Apache::MP13::Apreq'; + else { + Catalyst::Exception->throw( message => + qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); } + } + # install the correct mod_perl handler + if ( $version >= 1.9901 ) { + *handler = sub : method { + shift->handle_request(@_); + }; + } else { - die( qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); + *handler = sub ($$) { shift->handle_request(@_) }; } + } elsif ( $software eq 'Zeus-Perl' ) { @@ -199,181 +1766,278 @@ sub import { } else { - die( qq/Unsupported mod_perl: $ENV{MOD_PERL}/ ); + Catalyst::Exception->throw( + message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ ); } } - $caller->log->info( "You are running an old helper script! " - . "Please update your scripts by regenerating the " - . "application and copying over the new scripts." ) - if ( $ENV{CATALYST_SCRIPT_GEN} - && ( $ENV{CATALYST_SCRIPT_GEN} < $CATALYST_SCRIPT_GEN ) ); + unless ($engine) { + $engine = $class->engine_class; + } - # Process options - my @plugins; - foreach (@options) { + $engine->require; - if (/^\-Debug$/) { - next if $caller->debug; - no strict 'refs'; - *{"$caller\::debug"} = sub { 1 }; - $caller->log->debug('Debug messages enabled'); - } + if ($@) { + Catalyst::Exception->throw( message => +qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ + ); + } - elsif (/^-Dispatcher=(.*)$/) { - $dispatcher = "Catalyst::Dispatcher::$1"; - } + # check for old engines that are no longer compatible + my $old_engine; + if ( $engine->isa('Catalyst::Engine::Apache') + && !Catalyst::Engine::Apache->VERSION ) + { + $old_engine = 1; + } - elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" } - elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) } + elsif ( $engine->isa('Catalyst::Engine::Server::Base') + && Catalyst::Engine::Server->VERSION le '0.02' ) + { + $old_engine = 1; + } - else { - my $plugin = "Catalyst::Plugin::$_"; + elsif ($engine->isa('Catalyst::Engine::HTTP::POE') + && $engine->VERSION eq '0.01' ) + { + $old_engine = 1; + } - $plugin->require; + elsif ($engine->isa('Catalyst::Engine::Zeus') + && $engine->VERSION eq '0.01' ) + { + $old_engine = 1; + } - if ($@) { die qq/Couldn't load plugin "$plugin", "$@"/ } - else { - push @plugins, $plugin; - no strict 'refs'; - push @{"$caller\::ISA"}, $plugin; - } - } + if ($old_engine) { + Catalyst::Exception->throw( message => + qq/Engine "$engine" is not supported by this version of Catalyst/ + ); + } + + # engine instance + $class->engine( $engine->new ); +} + +=head2 $c->setup_home + +Sets up the home directory. + +=cut + +sub setup_home { + my ( $class, $home ) = @_; + if ( $ENV{CATALYST_HOME} ) { + $home = $ENV{CATALYST_HOME}; } - # Plugin table - my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for @plugins; - $caller->log->debug( 'Loaded plugins', $t->draw ) - if ( @plugins && $caller->debug ); + if ( $ENV{ uc($class) . '_HOME' } ) { + $home = $ENV{ uc($class) . '_HOME' }; + } - # Dispatcher - $dispatcher = "Catalyst::Dispatcher::$ENV{CATALYST_DISPATCHER}" - if $ENV{CATALYST_DISPATCHER}; - my $appdis = $ENV{ uc($caller) . '_DISPATCHER' }; - $dispatcher = "Catalyst::Dispatcher::$appdis" if $appdis; + unless ($home) { + $home = Catalyst::Utils::home($class); + } - $dispatcher->require; - die qq/Couldn't load dispatcher "$dispatcher", "$@"/ if $@; - { - no strict 'refs'; - push @{"$caller\::ISA"}, $dispatcher; + if ($home) { + $class->config->{home} ||= $home; + $class->config->{root} ||= dir($home)->subdir('root'); } - $caller->dispatcher($dispatcher); - $caller->log->debug(qq/Loaded dispatcher "$dispatcher"/) if $caller->debug; +} - # Engine - $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" - if $ENV{CATALYST_ENGINE}; - my $appeng = $ENV{ uc($caller) . '_ENGINE' }; - $engine = "Catalyst::Engine::$appeng" if $appeng; +=head2 $c->setup_log - $engine->require; - die qq/Couldn't load engine "$engine", "$@"/ if $@; +Sets up log. + +=cut + +sub setup_log { + my ( $class, $debug ) = @_; + + unless ( $class->log ) { + $class->log( Catalyst::Log->new ); + } + my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG'; + + if ( + ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) ) + ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} ) + : $debug + ) { no strict 'refs'; - push @{"$caller\::ISA"}, $engine; + *{"$class\::debug"} = sub { 1 }; + $class->log->debug('Debug messages enabled'); } +} - $caller->engine($engine); - $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug; +=head2 $c->setup_plugins - # Find home - my $home = Catalyst::Utils::home($caller); +Sets up plugins. - if ( my $h = $ENV{CATALYST_HOME} ) { +=cut - $home = $h if -d $h; +=head2 $c->registered_plugins - unless ( -e _ ) { - $caller->log->warn(qq/CATALYST_HOME does not exist "$h"/); - } +Returns a sorted list of the plugins which have either been stated in the +import list or which have been added via C<< MyApp->plugin(@args); >>. - unless ( -e _ && -d _ ) { - $caller->log->warn(qq/CATALYST_HOME is not a directory "$h"/); - } +If passed a given plugin name, it will report a boolean value indicating +whether or not that plugin is loaded. A fully qualified name is required if +the plugin name does not begin with C. + + if ($c->registered_plugins('Some::Plugin')) { + ... + } + +=cut + +{ + + sub registered_plugins { + my $proto = shift; + return sort keys %{$proto->_plugins} unless @_; + my $plugin = shift; + return 1 if exists $proto->_plugins->{$plugin}; + return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"}; } - if ( my $h = $ENV{ uc($caller) . '_HOME' } ) { + sub _register_plugin { + my ( $proto, $plugin, $instant ) = @_; + my $class = ref $proto || $proto; - $home = $h if -d $h; + $plugin->require; - unless ( -e _ ) { - my $e = uc($caller) . '_HOME'; - $caller->log->warn(qq/$e does not exist "$h"/) + if ( my $error = $@ ) { + my $type = $instant ? "instant " : ''; + Catalyst::Exception->throw( + message => qq/Couldn't load ${type}plugin "$plugin", $error/ ); } - unless ( -e _ && -d _ ) { - my $e = uc($caller) . '_HOME'; - $caller->log->warn(qq/$e is not a directory "$h"/); + $proto->_plugins->{$plugin} = 1; + unless ($instant) { + no strict 'refs'; + unshift @{"$class\::ISA"}, $plugin; } - } - - if ( -d $home ) { - $home = dir($home)->absolute; + return $class; } - if ( $caller->debug ) { - $home - ? ( -d $home ) - ? $caller->log->debug(qq/Found home "$home"/) - : $caller->log->debug(qq/Home "$home" doesn't exist/) - : $caller->log->debug(q/Couldn't find home/); + sub setup_plugins { + my ( $class, $plugins ) = @_; + + $class->_plugins( {} ) unless $class->_plugins; + $plugins ||= []; + for my $plugin ( reverse @$plugins ) { + + unless ( $plugin =~ s/\A\+// ) { + $plugin = "Catalyst::Plugin::$plugin"; + } + + $class->_register_plugin($plugin); + } } - $caller->config->{home} = $home || ''; - $caller->config->{root} = defined $home ? dir($home)->subdir('root') : ''; } -=item $c->engine +=head2 $c->stack -Contains the engine class. +Returns an arrayref of the internal execution stack (actions that are currently +executing). -=item $c->log +=head2 $c->write( $data ) -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: +Writes $data to the output stream. When using this method directly, you +will need to manually set the C header to the length of +your output data, if known. - $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); +=cut -Your log class should implement the methods described in the C -man page. +sub write { + my $c = shift; -=item $c->plugin( $name, $class, @args ) + # Finalize headers if someone manually writes output + $c->finalize_headers; -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. + return $c->engine->write( $c, @_ ); +} - MyApp->plugin( 'prototype', 'HTML::Prototype' ); +=head2 version - $c->prototype->define_javascript_functions; +Returns the Catalyst version number. Mostly useful for "powered by" +messages in template systems. =cut -sub plugin { - my ( $class, $name, $plugin, @args ) = @_; - $plugin->require; - my $error = $UNIVERSAL::require::ERROR; - die qq/Couldn't load instant plugin "$plugin", "$error"/ if $error; - eval { $plugin->import }; - $class->mk_classdata($name); - my $obj; - eval { $obj = $plugin->new(@args) }; - die qq/Couldn't instantiate instant plugin "$plugin", "$@"/ if $@; - $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; -} +sub version { return $Catalyst::VERSION } + +=head1 INTERNAL ACTIONS + +Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>, +C<_ACTION>, and C<_END>. These are by default not shown in the private +action table, but you can make them visible with a config parameter. + + MyApp->config->{show_internal_actions} = 1; + +=head1 CASE SENSITIVITY + +By default Catalyst is not case sensitive, so C is +mapped to C. You can activate case sensitivity with a config +parameter. + + MyApp->config->{case_sensitive} = 1; + +This causes C to map to C. + +=head1 ON-DEMAND PARSER + +The request body is usually parsed at the beginning of a request, +but if you want to handle input yourself or speed things up a bit, +you can enable on-demand parsing with a config parameter. + + MyApp->config->{parse_on_demand} = 1; + +=head1 PROXY SUPPORT + +Many production servers operate using the common double-server approach, +with a lightweight frontend web server passing requests to a larger +backend server. An application running on the backend server must deal +with two problems: the remote user always appears to be C<127.0.0.1> and +the server's hostname will appear to be C regardless of the +virtual host that the user connected through. + +Catalyst will automatically detect this situation when you are running +the frontend and backend servers on the same machine. The following +changes are made to the request. + + $c->req->address is set to the user's real IP address, as read from + the HTTP X-Forwarded-For header. + + The host value for $c->req->base and $c->req->uri is set to the real + host, as read from the HTTP X-Forwarded-Host header. + +Obviously, your web server must support these headers for this to work. + +In a more complex server farm environment where you may have your +frontend proxy server(s) on different machines, you will need to set a +configuration option to tell Catalyst to read the proxied data from the +headers. + + MyApp->config->{using_frontend_proxy} = 1; + +If you do not wish to use the proxy support at all, you may set: + + MyApp->config->{ignore_frontend_proxy} = 1; -=back +=head1 THREAD SAFETY -=head1 LIMITATIONS +Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt, +and the standalone forking HTTP server on Windows. We believe the Catalyst +core to be thread-safe. -mod_perl2 support is considered experimental and may contain bugs. +If you plan to operate in a threaded environment, remember that all other +modules you are using must also be thread-safe. Some modules, most notably +L, are not thread-safe. =head1 SUPPORT @@ -381,7 +2045,7 @@ IRC: Join #catalyst on irc.perl.org. -Mailing-Lists: +Mailing Lists: http://lists.rawmode.org/mailman/listinfo/catalyst http://lists.rawmode.org/mailman/listinfo/catalyst-dev @@ -390,40 +2054,104 @@ Web: http://catalyst.perl.org +Wiki: + + http://dev.catalyst.perl.org + =head1 SEE ALSO -=over 4 +=head2 L - All you need to start with Catalyst -=item L - The Catalyst Manual +=head2 L - The Catalyst Manual -=item L - Core Engine +=head2 L, L - Base classes for components -=item L - The Log Class. +=head2 L - Core engine -=item L - The Request Object +=head2 L - Log class. -=item L - The Response Object +=head2 L - Request object -=item L - The test suite. +=head2 L - Response object -=back +=head2 L - The test suite. -=head1 AUTHOR +=head1 CREDITS -Sebastian Riedel, C +Andy Grundman + +Andy Wardley + +Andreas Marienborg -=head1 THANK YOU +Andrew Bramble -Andy Grundman, Andrew Ford, Andrew Ruthven, Autrijus Tang, Christian Hansen, -Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton, -Gary Ashton Jones, Geoff Richards, Jesse Sheidlower, Jody Belka, -Johan Lindstrom, Juan Camacho, Leon Brocard, Marcus Ramberg, -Tatsuhiko Miyagawa and all the others who've helped. +Andrew Ford + +Andrew Ruthven + +Arthur Bergman + +Autrijus Tang + +Brian Cassidy + +Carl Franks + +Christian Hansen + +Christopher Hicks + +Dan Sully + +Danijel Milicevic + +David Kamholz + +David Naughton + +Drew Taylor + +Gary Ashton Jones + +Geoff Richards + +Jesse Sheidlower + +Jesse Vincent + +Jody Belka + +Johan Lindstrom + +Juan Camacho + +Leon Brocard + +Marcus Ramberg + +Matt S Trout + +Robert Sedlacek + +Sam Vilain + +Sascha Kiefer + +Tatsuhiko Miyagawa + +Ulf Edvinsson + +Yuval Kogman + +=head1 AUTHOR + +Sebastian Riedel, C =head1 LICENSE -This library is free software . You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software, you can redistribute it and/or modify it under +the same terms as Perl itself. =cut