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=092a60d845a85cadd0832a382bfcf97afe53ae65;hb=f7b672efdb91a057a449b353d157bb74761a2d94;hpb=3e82a2958c20b96682e7879a1620740f9daae96d diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 092a60d..a43be27 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,7 +1,7 @@ package Catalyst; use strict; -use base 'Catalyst::Base'; +use base 'Catalyst::Component'; use bytes; use UNIVERSAL::require; use Catalyst::Exception; @@ -10,14 +10,25 @@ use Catalyst::Request; use Catalyst::Request::Upload; use Catalyst::Response; use Catalyst::Utils; +use Catalyst::Controller; +use File::stat; use NEXT; -use Text::ASCIITable; +use Text::SimpleTable; use Path::Class; use Time::HiRes qw/gettimeofday tv_interval/; use URI; -use Scalar::Util qw/weaken/; +use Scalar::Util qw/weaken blessed/; +use Tree::Simple qw/use_weak_refs/; +use Tree::Simple::Visitor::FindByUID; +use attributes; -__PACKAGE__->mk_accessors(qw/counter depth request response state/); +__PACKAGE__->mk_accessors( + qw/counter request response state action stack namespace/ +); + +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } # Laziness++ *comp = \&component; @@ -36,12 +47,18 @@ our $DETACH = "catalyst_detach\n"; require Module::Pluggable::Fast; # Helper script generation -our $CATALYST_SCRIPT_GEN = 8; +our $CATALYST_SCRIPT_GEN = 27; __PACKAGE__->mk_classdata($_) - for qw/components arguments dispatcher engine log/; + for qw/components arguments dispatcher engine log dispatcher_class + engine_class context_class request_class response_class setup_finished/; -our $VERSION = '5.49_01'; +__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 ) = @_; @@ -54,7 +71,7 @@ sub import { unless ( $caller->isa('Catalyst') ) { no strict 'refs'; - push @{"$caller\::ISA"}, $class; + push @{"$caller\::ISA"}, $class, 'Catalyst::Controller'; } $caller->arguments( [@arguments] ); @@ -69,43 +86,84 @@ Catalyst - The Elegant MVC Web Application Framework # use the helper to start a new application catalyst.pl MyApp - cd MyApp # add models, views, controllers - script/myapp_create.pl model Something - script/myapp_create.pl view Stuff - script/myapp_create.pl controller Yada + 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 + # built in testserver -- use -r to restart automatically on changes script/myapp_server.pl - # command line interface + # 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') { ... } - use Catalyst; - - use Catalyst qw/My::Module My::OtherModule/; - - use Catalyst '-Debug'; - - use Catalyst qw/-Debug -Engine=CGI/; - - sub default : Private { $_[1]->res->output('Hello') } ); - - sub index : Path('/index.html') { + # called for all actions, from the top-most controller downwards + sub auto : Private { my ( $self, $c ) = @_; - $c->res->output('Hello'); - $c->forward('foo'); + 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 } - sub product : Regex('^product[_]*(\d*).html$') { + ### 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 ) = @_; - $c->stash->{template} = 'product.tt'; - $c->stash->{product} = $c->req->snippets->[0]; + # extract the (\w+) from the URI + my $product = $c->req->snippets->[0]; } -See also L +See L for additional information. =head1 DESCRIPTION @@ -113,67 +171,244 @@ 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, -so C becomes C. +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 'My::Module'; + use Catalyst qw/ + My::Module + +Fully::Qualified::Plugin::Name + /; -Special flags like -Debug and -Engine can also be specified as arguments when -Catalyst is loaded: +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 that they appear. +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: -=over 4 +=head2 -Debug -=item -Debug +Enables debug output. -enables debug output, i.e.: +=head2 -Engine - use Catalyst '-Debug'; +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: -this is equivalent to: + use Catalyst qw/-Engine=CGI/; - use Catalyst; - sub debug { 1 } +=head2 -Home -=item -Dispatcher +Forces Catalyst to use a specific home directory, e.g.: -Force Catalyst to use a specific dispatcher. + use Catalyst qw[-Home=/usr/sri]; -=item -Engine +=head2 -Log -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +Specifies log level. - use Catalyst '-Engine=CGI'; +=head1 METHODS -=item -Home +=head2 INFORMATION ABOUT THE CURRENT REQUEST -Force Catalyst to use a specific home directory. +=head2 $c->action -=item -Log +Returns a L object for the current action, which +stringifies to the action name. See L. -Specify log level. +=head2 $c->namespace -=back +Returns the namespace of the current action, i.e., the uri prefix +corresponding to the controller of the current action. For example: -=head1 METHODS + # 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 } + } + } -=over 4 + 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) = @_; -=item $c->comp($name) + my $appclass = ref $c || $c; -=item $c->component($name) + my @names = map { "${appclass}::${_}::${name}" } @prefixes; + + my $comp = $c->_comp_explicit(@names); + return $comp if defined($comp); + $comp = $c->_comp_search($name); + return $comp; +} -Get a component object by name. +=head2 COMPONENT ACCESSORS - $c->comp('MyApp::Model::MyModel')->do_stuff; +=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 @@ -188,74 +423,180 @@ sub component { my @names = ( $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } qw/M V C/ + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ ); - foreach my $try (@names) { + my $comp = $c->_comp_explicit(@names); + return $comp if defined($comp); - if ( exists $c->components->{$try} ) { + $comp = $c->_comp_search($name); + return $comp if defined($comp); + } - return $c->components->{$try}; - } - } + return sort keys %{ $c->components }; +} - foreach my $component ( keys %{ $c->components } ) { +=head2 $c->controller($name) - return $c->components->{$component} if $component =~ /$name/i; - } +Gets a L instance by name. - } + $c->controller('Foo')->do_stuff; - return sort keys %{ $c->components }; +=cut + +sub controller { + my ( $c, $name ) = @_; + return $c->_comp_prefixes($name, qw/Controller C/); } -=item config +=head2 $c->model($name) + +Gets a L instance by name. -Returns a hashref containing your applications settings. + $c->model('Foo')->do_stuff; -=item debug +=cut + +sub model { + my ( $c, $name ) = @_; + return $c->_comp_prefixes($name, qw/Model M/); +} -Overload to enable debug messages. +=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 } -=item $c->detach( $command [, \@arguments ] ) +=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 >>. -Like C but doesn't return. + __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 -sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +=head2 UTILITY METHODS -=item $c->dispatcher +=head2 $c->path_to(@path) -Contains the dispatcher instance. -Stringifies to class. +Merges C<@path> with C<$c-Econfig-E{home}> and returns a +L object. -=item $c->forward( $command [, \@arguments ] ) +For example: -Forward processing to a private action or a method from a class. -If you define a class without method it will default to process(). -also takes an optional arrayref containing arguments to be passed -to the new function. $c->req->args will be reset upon returning -from the function. + $c->path_to( 'db', 'sqlite.db' ); - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +=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 forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +sub plugin { + my ( $class, $name, $plugin, @args ) = @_; + $class->_register_plugin( $plugin, 1 ); -=item $c->setup + 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; +} -Setup. +=head2 MyApp->setup - $c->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 @@ -289,11 +630,12 @@ sub setup { } } + $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} ); - $class->setup_home( delete $flags->{home} ); for my $flag ( sort keys %{$flags} ) { @@ -305,11 +647,16 @@ sub setup { } } - $class->log->warn( "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::CATALYST_SCRIPT_GEN ) ); + $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 ) { @@ -317,16 +664,14 @@ sub setup { { no strict 'refs'; - @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; + @plugins = + map { $_ . ' ' . ( $_->VERSION || '' ) } + grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; } if (@plugins) { - my $t = Text::ASCIITable->new; - $t->setOptions( 'hide_HeadRow', 1 ); - $t->setOptions( 'hide_HeadLine', 1 ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for @plugins; + my $t = Text::SimpleTable->new(76); + $t->row($_) for @plugins; $class->log->debug( "Loaded plugins:\n" . $t->draw ); } @@ -357,14 +702,13 @@ sub setup { $class->setup_components; if ( $class->debug ) { - my $t = Text::ASCIITable->new; - $t->setOptions( 'hide_HeadRow', 1 ); - $t->setOptions( 'hide_HeadLine', 1 ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for sort keys %{ $class->components }; + 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 ( @{ $t->{tbl_rows} } ); + if ( keys %{ $class->components } ); } # Add our self to components, since we are also a component @@ -377,168 +721,78 @@ sub setup { $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); } $class->log->_flush() if $class->log->can('_flush'); + + $class->setup_finished(1); } -=item $c->uri_for($path) +=head2 $c->uri_for( $path, [ @args ] ) -Merges path with $c->request->base for absolute uri's and with -$c->request->match for relative uri's, then returns a normalized -L object. +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 ) = @_; + my ( $c, $path, @args ) = @_; my $base = $c->request->base->clone; my $basepath = $base->path; $basepath =~ s/\/$//; $basepath .= '/'; - my $match = $c->request->match; - $match =~ s/^\///; - $match .= '/' if $match; - $match = '' if $path =~ /^\//; - $path =~ s/^\///; - return URI->new_abs( URI->new_abs( $path, "$basepath$match" ), $base ) - ->canonical; -} - -=item $c->error - -=item $c->error($error, ...) - -=item $c->error($arrayref) - -Returns an arrayref containing error messages. - - my @error = @{ $c->error }; - -Add a new error. - - $c->error('Something bad happened'); - -=cut - -sub error { - my $c = shift; - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - return $c->{error}; -} - -=item $c->engine - -Contains the engine instance. -Stringifies to the class. - -=item $c->log - -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: - - $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); - -Your log class should implement the methods described in the C -man page. - -=item $c->plugin( $name, $class, @args ) - -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. - - MyApp->plugin( 'prototype', 'HTML::Prototype' ); - - $c->prototype->define_javascript_functions; - -=cut - -sub plugin { - my ( $class, $name, $plugin, @args ) = @_; - $plugin->require; - - if ( my $error = $UNIVERSAL::require::ERROR ) { - Catalyst::Exception->throw( - message => qq/Couldn't load instant plugin "$plugin", "$error"/ ); - } - - eval { $plugin->import }; - $class->mk_classdata($name); - my $obj; - eval { $obj = $plugin->new(@args) }; + my $namespace = $c->namespace; - 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; -} - -=item $c->request - -=item $c->req - -Returns a C object. - - my $req = $c->req; - -=item $c->response - -=item $c->res - -Returns a C object. - - my $res = $c->res; - -=item $c->state - -Contains the return value of the last executed action. - -=item $c->stash - -Returns a hashref containing all your data. - - $c->stash->{foo} ||= 'yada'; - print $c->stash->{foo}; + # massage namespace, empty if absolute path + $namespace =~ s/^\///; + $namespace .= '/' if $namespace; + $path ||= ''; + $namespace = '' if $path =~ /^\//; + $path =~ s/^\///; -=cut + my $params = + ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} ); -sub stash { - my $c = shift; - if (@_) { - my $stash = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $c->{stash}->{$key} = $val; - } - } - return $c->{stash}; + # 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; } -=head1 $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. =cut sub welcome_message { - my $c = shift; - my $name = $c->config->{name}; + 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

+

$name on Catalyst + $VERSION

-

Welcome to the wonderfull world of Catalyst. - This MVC framework will make webdevelopment - something you had never expected it to be: - Fun, rewarding and quick.

+

+ 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 all depends really, on what you want to do. +

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 following links.

- -

If you would like some background information on the - MVC-pattern, theese links might be able to help you out.

+ 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.

-

You may also want to check the local installed - documentation.

- 
perldoc Catalyst::Manual
-perldoc Catalyst::Manual::Intro
-

What to do next?

-

Next you need to create an actuall application. Use the - helper scripts for what they are worth, they can save you - alot of work getting everything set up. Also, be sure to - check out the vast array of plugins for Catalyst. - They can handle everything from Authentication to Static - files, and a whole lot in between.

In conclusion

-

The Catalyst team hope you will enjoy Catalyst as much as we enjoyed making it, and that rest asure that any and all - feedback is welcomed

-

-- there is no cabal, 2005

+

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.

@@ -659,103 +910,179 @@ perldoc Catalyst::Manual::Intro EOF } -=back - =head1 INTERNAL METHODS -=over 4 +These methods are not meant to be used by end users. -=item $c->benchmark($coderef) +=head2 $c->components -Takes a coderef with arguments and returns elapsed time as float. +Returns a hash of components. - my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } ); - $c->log->info( sprintf "Processing took %f seconds", $elapsed ); +=head2 $c->context_class -=cut +Returns or sets the context class. -sub benchmark { - my $c = shift; - my $code = shift; - my $time = [gettimeofday]; - my @return = &$code(@_); - my $elapsed = tv_interval $time; - return wantarray ? ( $elapsed, @return ) : $elapsed; -} +=head2 $c->counter -=item $c->components +Returns a hashref containing coderefs and execution counts (needed for +deep recursion detection). -Contains the components. +=head2 $c->depth -=item $c->counter +Returns the number of actions on the current internal execution stack. -Returns a hashref containing coderefs and execution counts. -(Needed for deep recursion detection) +=head2 $c->dispatch -=item $c->depth +Dispatches a request to actions. -Returns the actual forward depth. +=cut + +sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) } -=item $c->dispatch +=head2 $c->dispatcher_class -Dispatch request to actions. +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 dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) } +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. -=item $c->execute($class, $coderef) +=head2 $c->execute( $class, $coderef ) -Execute a coderef in given class and catch exceptions. -Errors are available via $c->error. +Execute a coderef in given class and catch exceptions. Errors are available +via $c->error. =cut sub execute { my ( $c, $class, $code ) = @_; - $class = $c->components->{$class} || $class; + $class = $c->component($class) || $class; $c->state(0); - my $callsub = ( caller(1) )[3]; - my $action = ''; + 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 ) { - $action = "$code"; + my $action = "$code"; $action = "/$action" unless $action =~ /\-\>/; $c->counter->{"$code"}++; - if ( $c->counter->{"$code"} > $RECURSION ) { - my $error = qq/Deep recursion detected in "$action"/; - $c->log->error($error); - $c->error($error); - $c->state(0); - return $c->state; + # 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; + } } - $action = "-> $action" if $callsub =~ /forward$/; + 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); + } + } } - $c->{depth}++; - eval { - if ( $c->debug ) + + 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} ) ) { - my ( $elapsed, @state ) = - $c->benchmark( $code, $class, $c, @{ $c->req->args } ); - push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; - $c->state(@state); + + # 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; } - else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) } - }; - $c->{depth}--; + } + my $last = ${ $c->stack }[-1]; + pop( @{ $c->stack } ); if ( my $error = $@ ) { - - if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 } + if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 } else { unless ( ref $error ) { chomp $error; - $error = qq/Caught exception "$error"/; + my $class = $last->class; + my $name = $last->name; + $error = qq/Caught exception in $class->$name "$error"/; } - - $c->log->error($error); $c->error($error); $c->state(0); } @@ -763,15 +1090,19 @@ sub execute { return $c->state; } -=item $c->finalize +=head2 $c->finalize -Finalize request. +Finalizes the request. =cut sub finalize { my $c = shift; + for my $error ( @{ $c->error } ) { + $c->log->error($error); + } + $c->finalize_uploads; # Error @@ -791,33 +1122,33 @@ sub finalize { return $c->response->status; } -=item $c->finalize_body +=head2 $c->finalize_body -Finalize body. +Finalizes body. =cut sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) } -=item $c->finalize_cookies +=head2 $c->finalize_cookies -Finalize cookies. +Finalizes cookies. =cut sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) } -=item $c->finalize_error +=head2 $c->finalize_error -Finalize error. +Finalizes error. =cut sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) } -=item $c->finalize_headers +=head2 $c->finalize_headers -Finalize headers. +Finalizes headers. =cut @@ -835,7 +1166,19 @@ sub finalize_headers { # Content-Length if ( $c->response->body && !$c->response->content_length ) { - $c->response->content_length( bytes::length( $c->response->body ) ); + + # 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 @@ -852,37 +1195,46 @@ sub finalize_headers { $c->response->{_finalized_headers} = 1; } -=item $c->finalize_output +=head2 $c->finalize_output An alias for finalize_body. -=item $c->finalize_read +=head2 $c->finalize_read -Finalize the input after reading is complete. +Finalizes the input after reading is complete. =cut sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) } -=item $c->finalize_uploads +=head2 $c->finalize_uploads -Finalize uploads. Cleans up any temporary files. +Finalizes uploads. Cleans up any temporary files. =cut sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) } -=item $c->get_action( $action, $namespace, $inherit ) +=head2 $c->get_action( $action, $namespace ) -Get an action in a given namespace. +Gets an action in a given namespace. =cut -sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) } +sub get_action { my $c = shift; $c->dispatcher->get_action(@_) } -=item handle_request( $class, @arguments ) +=head2 $c->get_actions( $action, $namespace ) -Handles the request. +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 @@ -892,27 +1244,33 @@ sub handle_request { # Always expect worst case! my $status = -1; eval { - my @stats = (); + my $stats = ( $class->debug ) ? Tree::Simple->new: q{}; my $handler = sub { my $c = $class->prepare(@arguments); - $c->{stats} = \@stats; + $c->{stats} = $stats; $c->dispatch; return $c->finalize; }; if ( $class->debug ) { - my $elapsed; - ( $elapsed, $status ) = $class->benchmark($handler); + 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::ASCIITable->new; - $t->setCols( 'Action', 'Time' ); - $t->setColWidth( 'Action', 64, 1 ); - $t->setColWidth( 'Time', 9, 1 ); + 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} || '??' ); + } + ); - for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) } $class->log->info( "Request took ${elapsed}s ($av/s)\n" . $t->draw ); } @@ -930,43 +1288,46 @@ sub handle_request { return $status; } -=item $c->prepare(@arguments) +=head2 $c->prepare( @arguments ) -Turns the engine-specific request( Apache, CGI ... ) -into a Catalyst context . +Creates a Catalyst context from an engine-specific request (Apache, CGI, +etc.). =cut sub prepare { my ( $class, @arguments ) = @_; - my $c = bless { - counter => {}, - depth => 0, - request => Catalyst::Request->new( - { - arguments => [], - body_parameters => {}, - cookies => {}, - headers => HTTP::Headers->new, - parameters => {}, - query_parameters => {}, - secure => 0, - snippets => [], - uploads => {} - } - ), - response => Catalyst::Response->new( - { - body => '', - cookies => {}, - headers => HTTP::Headers->new(), - status => 200 - } - ), - stash => {}, - state => 0 - }, $class; + $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; @@ -993,28 +1354,29 @@ sub prepare { # On-demand parsing $c->prepare_body unless $c->config->{parse_on_demand}; - $c->prepare_action; 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/) + $c->log->debug(qq/"$method" request for "$path" from "$address"/) if $c->debug; + $c->prepare_action; + return $c; } -=item $c->prepare_action +=head2 $c->prepare_action -Prepare action. +Prepares action. =cut sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) } -=item $c->prepare_body +=head2 $c->prepare_body -Prepare message body. +Prepares message body. =cut @@ -1030,24 +1392,20 @@ sub prepare_body { $c->prepare_uploads; if ( $c->debug && keys %{ $c->req->body_parameters } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Value' ); - $t->setColWidth( 'Key', 37, 1 ); - $t->setColWidth( 'Value', 36, 1 ); - $t->alignCol( 'Value', 'right' ); + 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->addRow( $key, + $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); } $c->log->debug( "Body Parameters are:\n" . $t->draw ); } } -=item $c->prepare_body_chunk( $chunk ) +=head2 $c->prepare_body_chunk( $chunk ) -Prepare a chunk of data before sending it to HTTP::Body. +Prepares a chunk of data before sending it to L. =cut @@ -1056,9 +1414,9 @@ sub prepare_body_chunk { $c->engine->prepare_body_chunk( $c, @_ ); } -=item $c->prepare_body_parameters +=head2 $c->prepare_body_parameters -Prepare body parameters. +Prepares body parameters. =cut @@ -1067,9 +1425,9 @@ sub prepare_body_parameters { $c->engine->prepare_body_parameters( $c, @_ ); } -=item $c->prepare_connection +=head2 $c->prepare_connection -Prepare connection. +Prepares connection. =cut @@ -1078,25 +1436,25 @@ sub prepare_connection { $c->engine->prepare_connection( $c, @_ ); } -=item $c->prepare_cookies +=head2 $c->prepare_cookies -Prepare cookies. +Prepares cookies. =cut sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) } -=item $c->prepare_headers +=head2 $c->prepare_headers -Prepare headers. +Prepares headers. =cut sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) } -=item $c->prepare_parameters +=head2 $c->prepare_parameters -Prepare parameters. +Prepares parameters. =cut @@ -1106,17 +1464,17 @@ sub prepare_parameters { $c->engine->prepare_parameters( $c, @_ ); } -=item $c->prepare_path +=head2 $c->prepare_path -Prepare path and base. +Prepares path and base. =cut sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) } -=item $c->prepare_query_parameters +=head2 $c->prepare_query_parameters -Prepare query parameters. +Prepares query parameters. =cut @@ -1126,40 +1484,36 @@ sub prepare_query_parameters { $c->engine->prepare_query_parameters( $c, @_ ); if ( $c->debug && keys %{ $c->request->query_parameters } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Value' ); - $t->setColWidth( 'Key', 37, 1 ); - $t->setColWidth( 'Value', 36, 1 ); - $t->alignCol( 'Value', 'right' ); + 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->addRow( $key, + $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); } $c->log->debug( "Query Parameters are:\n" . $t->draw ); } } -=item $c->prepare_read +=head2 $c->prepare_read -Prepare the input for reading. +Prepares the input for reading. =cut sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) } -=item $c->prepare_request +=head2 $c->prepare_request -Prepare the engine request. +Prepares the engine request. =cut sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) } -=item $c->prepare_uploads +=head2 $c->prepare_uploads -Prepare uploads. +Prepares uploads. =cut @@ -1169,44 +1523,52 @@ sub prepare_uploads { $c->engine->prepare_uploads( $c, @_ ); if ( $c->debug && keys %{ $c->request->uploads } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Filename', 'Type', 'Size' ); - $t->setColWidth( 'Key', 12, 1 ); - $t->setColWidth( 'Filename', 28, 1 ); - $t->setColWidth( 'Type', 18, 1 ); - $t->setColWidth( 'Size', 9, 1 ); - $t->alignCol( 'Size', 'left' ); + 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->addRow( $key, $u->filename, $u->type, $u->size ); + $t->row( $key, $u->filename, $u->type, $u->size ); } } $c->log->debug( "File Uploads are:\n" . $t->draw ); } } -=item $c->prepare_write +=head2 $c->prepare_write -Prepare the output for writing. +Prepares the output for writing. =cut sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) } -=item $c->read( [$maxlength] ) +=head2 $c->request_class + +Returns or sets the request class. + +=head2 $c->response_class -Read a chunk of data from the request body. This method is designed to be -used in a while loop, reading $maxlength bytes on every call. $maxlength -defaults to the size of the request if not specified. +Returns or sets the response class. -You have to set MyApp->config->{parse_on_demand} to use this directly. +=head2 $c->read( [$maxlength] ) + +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. + +You have to set Cconfig-E{parse_on_demand}> to use this +directly. =cut sub read { my $c = shift; return $c->engine->read( $c, @_ ) } -=item $c->run +=head2 $c->run Starts the engine. @@ -1214,25 +1576,25 @@ Starts the engine. sub run { my $c = shift; return $c->engine->run( $c, @_ ) } -=item $c->set_action( $action, $code, $namespace, $attrs ) +=head2 $c->set_action( $action, $code, $namespace, $attrs ) -Set an action in a given namespace. +Sets an action in a given namespace. =cut sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) } -=item $c->setup_actions($component) +=head2 $c->setup_actions($component) -Setup actions for a component. +Sets up actions for a component. =cut sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) } -=item $c->setup_components +=head2 $c->setup_components -Setup components. +Sets up components. =cut @@ -1242,7 +1604,7 @@ sub setup_components { my $callback = sub { my ( $component, $context ) = @_; - unless ( $component->isa('Catalyst::Base') ) { + unless ( $component->can('COMPONENT') ) { return $component; } @@ -1251,7 +1613,7 @@ sub setup_components { my $instance; - eval { $instance = $component->new( $context, $config ); }; + eval { $instance = $component->COMPONENT( $context, $config ); }; if ( my $error = $@ ) { @@ -1262,14 +1624,13 @@ sub setup_components { } Catalyst::Exception->throw( message => -qq/Couldn't instantiate component "$component", "new() didn't return a object"/ +qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/ ) unless ref $instance; return $instance; }; - eval { - Module::Pluggable::Fast->import( + eval "package $class;\n" . q!Module::Pluggable::Fast->import( name => '_catalyst_components', search => [ "$class\::Controller", "$class\::C", @@ -1278,7 +1639,7 @@ qq/Couldn't instantiate component "$component", "new() didn't return a object"/ ], callback => $callback ); - }; + !; if ( my $error = $@ ) { @@ -1293,7 +1654,9 @@ qq/Couldn't instantiate component "$component", "new() didn't return a object"/ } } -=item $c->setup_dispatcher +=head2 $c->setup_dispatcher + +Sets up dispatcher. =cut @@ -1314,7 +1677,7 @@ sub setup_dispatcher { } unless ($dispatcher) { - $dispatcher = 'Catalyst::Dispatcher'; + $dispatcher = $class->dispatcher_class; } $dispatcher->require; @@ -1328,7 +1691,9 @@ sub setup_dispatcher { $class->dispatcher( $dispatcher->new ); } -=item $c->setup_engine +=head2 $c->setup_engine + +Sets up engine. =cut @@ -1347,7 +1712,7 @@ sub setup_engine { $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' }; } - if ( !$engine && $ENV{MOD_PERL} ) { + if ( $ENV{MOD_PERL} ) { # create the apache method { @@ -1363,21 +1728,25 @@ sub setup_engine { if ( $software eq 'mod_perl' ) { - if ( $version >= 1.99922 ) { - $engine = 'Catalyst::Engine::Apache2::MP20'; - } + if ( !$engine ) { - elsif ( $version >= 1.9901 ) { - $engine = 'Catalyst::Engine::Apache2::MP19'; - } + if ( $version >= 1.99922 ) { + $engine = 'Catalyst::Engine::Apache2::MP20'; + } - elsif ( $version >= 1.24 ) { - $engine = 'Catalyst::Engine::Apache::MP13'; - } + elsif ( $version >= 1.9901 ) { + $engine = 'Catalyst::Engine::Apache2::MP19'; + } + + elsif ( $version >= 1.24 ) { + $engine = 'Catalyst::Engine::Apache::MP13'; + } + + else { + Catalyst::Exception->throw( message => + qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); + } - else { - Catalyst::Exception->throw( message => - qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); } # install the correct mod_perl handler @@ -1403,7 +1772,7 @@ sub setup_engine { } unless ($engine) { - $engine = 'Catalyst::Engine::CGI'; + $engine = $class->engine_class; } $engine->require; @@ -1414,11 +1783,45 @@ qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ ); } + # 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->isa('Catalyst::Engine::Server::Base') + && Catalyst::Engine::Server->VERSION le '0.02' ) + { + $old_engine = 1; + } + + elsif ($engine->isa('Catalyst::Engine::HTTP::POE') + && $engine->VERSION eq '0.01' ) + { + $old_engine = 1; + } + + elsif ($engine->isa('Catalyst::Engine::Zeus') + && $engine->VERSION eq '0.01' ) + { + $old_engine = 1; + } + + if ($old_engine) { + Catalyst::Exception->throw( message => + qq/Engine "$engine" is not supported by this version of Catalyst/ + ); + } + # engine instance $class->engine( $engine->new ); } -=item $c->setup_home +=head2 $c->setup_home + +Sets up the home directory. =cut @@ -1443,7 +1846,9 @@ sub setup_home { } } -=item $c->setup_log +=head2 $c->setup_log + +Sets up log. =cut @@ -1454,44 +1859,97 @@ sub setup_log { $class->log( Catalyst::Log->new ); } - if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) { + 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'; *{"$class\::debug"} = sub { 1 }; $class->log->debug('Debug messages enabled'); } } -=item $c->setup_plugins +=head2 $c->setup_plugins + +Sets up plugins. =cut -sub setup_plugins { - my ( $class, $plugins ) = @_; +=head2 $c->registered_plugins + +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); >>. - $plugins ||= []; - for my $plugin ( reverse @$plugins ) { +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 - $plugin = "Catalyst::Plugin::$plugin"; +{ + + 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"}; + } + + sub _register_plugin { + my ( $proto, $plugin, $instant ) = @_; + my $class = ref $proto || $proto; $plugin->require; - if ($@) { + if ( my $error = $@ ) { + my $type = $instant ? "instant " : ''; Catalyst::Exception->throw( - message => qq/Couldn't load plugin "$plugin", "$@"/ ); + message => qq/Couldn't load ${type}plugin "$plugin", $error/ ); } - { + $proto->_plugins->{$plugin} = 1; + unless ($instant) { no strict 'refs'; unshift @{"$class\::ISA"}, $plugin; } + return $class; + } + + 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); + } } } -=item $c->write( $data ) +=head2 $c->stack + +Returns an arrayref of the internal execution stack (actions that are currently +executing). -Writes $data to the output stream. When using this method directly, you will -need to manually set the Content-Length header to the length of your output -data, if known. +=head2 $c->write( $data ) + +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. =cut @@ -1504,51 +1962,66 @@ sub write { return $c->engine->write( $c, @_ ); } -=back +=head2 version -=head1 CASE SENSITIVITY +Returns the Catalyst version number. Mostly useful for "powered by" +messages in template systems. + +=cut + +sub version { return $Catalyst::VERSION } + +=head1 INTERNAL ACTIONS -By default Catalyst is not case sensitive, so C becomes -C. +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. -But you can activate case sensitivity 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; -So C becomes C. +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 +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 '127.0.0.1' and the server's -hostname will appear to be 'localhost' regardless of the virtual host the -user connected through. +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 both -the frontend and backend servers on the same machine. The following changes -are made to the request. +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. + $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. + 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 2 headers for this to work. +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. +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; @@ -1559,12 +2032,12 @@ If you do not wish to use the proxy support at all, you may set: =head1 THREAD SAFETY 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 +and the standalone forking HTTP server on Windows. We believe the Catalyst core to be thread-safe. 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 -DBD::SQLite, are not thread-safe. +modules you are using must also be thread-safe. Some modules, most notably +L, are not thread-safe. =head1 SUPPORT @@ -1572,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 @@ -1581,23 +2054,27 @@ 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 CREDITS @@ -1605,6 +2082,10 @@ Andy Grundman Andy Wardley +Andreas Marienborg + +Andrew Bramble + Andrew Ford Andrew Ruthven @@ -1613,6 +2094,10 @@ Arthur Bergman Autrijus Tang +Brian Cassidy + +Carl Franks + Christian Hansen Christopher Hicks @@ -1621,8 +2106,12 @@ Dan Sully Danijel Milicevic +David Kamholz + David Naughton +Drew Taylor + Gary Ashton Jones Geoff Richards @@ -1645,6 +2134,10 @@ Matt S Trout Robert Sedlacek +Sam Vilain + +Sascha Kiefer + Tatsuhiko Miyagawa Ulf Edvinsson @@ -1657,8 +2150,8 @@ 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