X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=7310d71be1aecca3bd4e6597b633f84318176b73;hp=723138326ec0d4bfd3cbe7189881a8ac939146af;hb=9b0a3e0fc295d2d2b0af184f4ed1d05db41fc2c4;hpb=0fa3b8e1ed85c4250e81c5523faaaa3dc6625de8 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 7231383..7310d71 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -10,6 +10,7 @@ use Catalyst::Request; use Catalyst::Request::Upload; use Catalyst::Response; use Catalyst::Utils; +use File::stat; use NEXT; use Text::SimpleTable; use Path::Class; @@ -18,19 +19,6 @@ use URI; use Scalar::Util qw/weaken/; use attributes; -# For PAR -require Catalyst::Helper; -require Catalyst::PAR; -require Catalyst::Build; -require Catalyst::Test; - -require Catalyst::Engine::HTTP; -require Catalyst::Engine::CGI; - -require Catalyst::Controller; -require Catalyst::Model; -require Catalyst::View; - __PACKAGE__->mk_accessors( qw/counter request response state action stack namespace/ ); @@ -56,7 +44,7 @@ our $DETACH = "catalyst_detach\n"; require Module::Pluggable::Fast; # Helper script generation -our $CATALYST_SCRIPT_GEN = 17; +our $CATALYST_SCRIPT_GEN = 25; __PACKAGE__->mk_classdata($_) for qw/components arguments dispatcher engine log dispatcher_class @@ -67,7 +55,7 @@ __PACKAGE__->engine_class('Catalyst::Engine::CGI'); __PACKAGE__->request_class('Catalyst::Request'); __PACKAGE__->response_class('Catalyst::Response'); -our $VERSION = '5.57'; +our $VERSION = '5.62'; sub import { my ( $class, @arguments ) = @_; @@ -197,43 +185,37 @@ they are loaded in exactly the order in which they appear. The following flags are supported: -=over 4 - -=item -Debug +=head2 -Debug Enables debug output. -=item -Engine +=head2 -Engine Forces Catalyst to use a specific engine. Omit the C prefix of the engine name, i.e.: use Catalyst qw/-Engine=CGI/; -=item -Home +=head2 -Home Forces Catalyst to use a specific home directory, e.g.: use Catalyst qw[-Home=/usr/sri]; -=item -Log +=head2 -Log Specifies log level. -=back - =head1 METHODS =head2 Information about the current request -=over 4 - -=item $c->action +=head2 $c->action Returns a L object for the current action, which stringifies to the action name. See L. -=item $c->namespace +=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: @@ -241,22 +223,18 @@ corresponding to the controller of the current action. For example: # in Controller::Foo::Bar $c->namespace; # returns 'foo/bar'; -=item $c->request +=head2 $c->request -=item $c->req +=head2 $c->req Returns the current L object. See L. -=back - =head2 Processing and response to the current request -=over 4 - -=item $c->forward( $action [, \@arguments ] ) +=head2 $c->forward( $action [, \@arguments ] ) -=item $c->forward( $class, $method, [, \@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 @@ -273,9 +251,9 @@ C<$c-Ereq-Eargs> will be restored to the previous values. sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } -=item $c->detach( $action [, \@arguments ] ) +=head2 $c->detach( $action [, \@arguments ] ) -=item $c->detach( $class, $method, [, \@arguments ] ) +=head2 $c->detach( $class, $method, [, \@arguments ] ) The same as C, but doesn't return. @@ -283,13 +261,15 @@ The same as C, but doesn't return. sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } -=item $c->error +=head2 $c->error -=item $c->error($error, ...) +=head2 $c->error($error, ...) -=item $c->error($arrayref) +=head2 $c->error($arrayref) -Returns an arrayref containing error messages. +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 }; @@ -297,7 +277,8 @@ Add a new error. $c->error('Something bad happened'); -Clear errors. +Clear errors. You probably don't want to clear the errors unless you are +implementing a custom error screen. $c->error(0); @@ -313,13 +294,13 @@ sub error { return $c->{error} || []; } -=item $c->response +=head2 $c->response -=item $c->res +=head2 $c->res Returns the current L object. -=item $c->stash +=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 @@ -347,19 +328,15 @@ sub stash { return $c->{stash}; } -=item $c->state +=head2 $c->state Contains the return value of the last executed action. -=back - =head2 Component Accessors -=over 4 - -=item $c->comp($name) +=head2 $c->comp($name) -=item $c->component($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 @@ -401,7 +378,7 @@ sub component { return sort keys %{ $c->components }; } -=item $c->controller($name) +=head2 $c->controller($name) Gets a L instance by name. @@ -412,11 +389,11 @@ Gets a L instance by name. sub controller { my ( $c, $name ) = @_; my $controller = $c->comp("Controller::$name"); - return $controller if $controller; + return $controller if defined $controller; return $c->comp("C::$name"); } -=item $c->model($name) +=head2 $c->model($name) Gets a L instance by name. @@ -427,11 +404,11 @@ Gets a L instance by name. sub model { my ( $c, $name ) = @_; my $model = $c->comp("Model::$name"); - return $model if $model; + return $model if defined $model; return $c->comp("M::$name"); } -=item $c->view($name) +=head2 $c->view($name) Gets a L instance by name. @@ -442,23 +419,19 @@ Gets a L instance by name. sub view { my ( $c, $name ) = @_; my $view = $c->comp("View::$name"); - return $view if $view; + return $view if defined $view; return $c->comp("V::$name"); } -=back - =head2 Class data and helper classes -=over 4 - -=item $c->config +=head2 $c->config Returns or takes a hashref containing the application's configuration. __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' }); -=item $c->debug +=head2 $c->debug Overload to enable debug messages (same as -Debug option). @@ -466,17 +439,17 @@ Overload to enable debug messages (same as -Debug option). sub debug { 0 } -=item $c->dispatcher +=head2 $c->dispatcher Returns the dispatcher instance. Stringifies to class name. See L. -=item $c->engine +=head2 $c->engine Returns the engine instance. Stringifies to the class name. See L. -=item $c->log +=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: @@ -489,13 +462,9 @@ L man page. =cut -=back - =head2 Utility methods -=over 4 - -=item $c->path_to(@path) +=head2 $c->path_to(@path) Merges C<@path> with C<$c-Econfig-E{home}> and returns a L object. @@ -513,7 +482,7 @@ sub path_to { else { return file( $c->config->{home}, @path ) } } -=item $c->plugin( $name, $class, @args ) +=head2 $c->plugin( $name, $class, @args ) Helper method for plugins. It creates a classdata accessor/mutator and loads and instantiates the given class. @@ -548,7 +517,7 @@ sub plugin { if $class->debug; } -=item MyApp->setup +=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 @@ -610,8 +579,11 @@ sub setup { <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) ); You are running an old script! - Please update by running: - catalyst.pl -nonew -scripts $class + 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 ) { @@ -620,7 +592,9 @@ EOF { no strict 'refs'; - @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; + @plugins = + map { $_ . ' ' . ( $_->VERSION || '' ) } + grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; } if (@plugins) { @@ -677,7 +651,7 @@ EOF $class->log->_flush() if $class->log->can('_flush'); } -=item $c->uri_for( $path, [ @args ] ) +=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 @@ -703,11 +677,14 @@ sub uri_for { # join args with '/', or a blank string my $args = ( scalar @args ? '/' . join( '/', @args ) : '' ); - return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), - $base )->canonical; + $args =~ s/^\/// unless $path; + my $res = + URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base ) + ->canonical; + $res; } -=item $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. @@ -852,32 +829,28 @@ perldoc class; + my $name = $last->name; + $error = qq/Caught exception in $class->$name "$error"/; } $c->error($error); $c->state(0); @@ -969,7 +945,7 @@ sub execute { return $c->state; } -=item $c->finalize +=head2 $c->finalize Finalizes the request. @@ -1001,7 +977,7 @@ sub finalize { return $c->response->status; } -=item $c->finalize_body +=head2 $c->finalize_body Finalizes body. @@ -1009,7 +985,7 @@ Finalizes body. sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) } -=item $c->finalize_cookies +=head2 $c->finalize_cookies Finalizes cookies. @@ -1017,7 +993,7 @@ Finalizes cookies. sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) } -=item $c->finalize_error +=head2 $c->finalize_error Finalizes error. @@ -1025,7 +1001,7 @@ Finalizes error. sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) } -=item $c->finalize_headers +=head2 $c->finalize_headers Finalizes headers. @@ -1045,7 +1021,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 ( ref $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 @@ -1062,11 +1050,11 @@ 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 Finalizes the input after reading is complete. @@ -1074,7 +1062,7 @@ Finalizes the input after reading is complete. sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) } -=item $c->finalize_uploads +=head2 $c->finalize_uploads Finalizes uploads. Cleans up any temporary files. @@ -1082,7 +1070,7 @@ Finalizes uploads. Cleans up any temporary files. sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) } -=item $c->get_action( $action, $namespace ) +=head2 $c->get_action( $action, $namespace ) Gets an action in a given namespace. @@ -1090,7 +1078,7 @@ Gets an action in a given namespace. sub get_action { my $c = shift; $c->dispatcher->get_action(@_) } -=item $c->get_actions( $action, $namespace ) +=head2 $c->get_actions( $action, $namespace ) Gets all actions of a given name in a namespace and all parent namespaces. @@ -1099,7 +1087,7 @@ namespaces. sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) } -=item handle_request( $class, @arguments ) +=head2 handle_request( $class, @arguments ) Called to handle each HTTP request. @@ -1147,7 +1135,7 @@ sub handle_request { return $status; } -=item $c->prepare( @arguments ) +=head2 $c->prepare( @arguments ) Creates a Catalyst context from an engine-specific request (Apache, CGI, etc.). @@ -1225,7 +1213,7 @@ sub prepare { return $c; } -=item $c->prepare_action +=head2 $c->prepare_action Prepares action. @@ -1233,7 +1221,7 @@ Prepares action. sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) } -=item $c->prepare_body +=head2 $c->prepare_body Prepares message body. @@ -1262,7 +1250,7 @@ sub prepare_body { } } -=item $c->prepare_body_chunk( $chunk ) +=head2 $c->prepare_body_chunk( $chunk ) Prepares a chunk of data before sending it to L. @@ -1273,7 +1261,7 @@ sub prepare_body_chunk { $c->engine->prepare_body_chunk( $c, @_ ); } -=item $c->prepare_body_parameters +=head2 $c->prepare_body_parameters Prepares body parameters. @@ -1284,7 +1272,7 @@ sub prepare_body_parameters { $c->engine->prepare_body_parameters( $c, @_ ); } -=item $c->prepare_connection +=head2 $c->prepare_connection Prepares connection. @@ -1295,7 +1283,7 @@ sub prepare_connection { $c->engine->prepare_connection( $c, @_ ); } -=item $c->prepare_cookies +=head2 $c->prepare_cookies Prepares cookies. @@ -1303,7 +1291,7 @@ Prepares cookies. sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) } -=item $c->prepare_headers +=head2 $c->prepare_headers Prepares headers. @@ -1311,7 +1299,7 @@ Prepares headers. sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) } -=item $c->prepare_parameters +=head2 $c->prepare_parameters Prepares parameters. @@ -1323,7 +1311,7 @@ sub prepare_parameters { $c->engine->prepare_parameters( $c, @_ ); } -=item $c->prepare_path +=head2 $c->prepare_path Prepares path and base. @@ -1331,7 +1319,7 @@ Prepares path and base. sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) } -=item $c->prepare_query_parameters +=head2 $c->prepare_query_parameters Prepares query parameters. @@ -1354,7 +1342,7 @@ sub prepare_query_parameters { } } -=item $c->prepare_read +=head2 $c->prepare_read Prepares the input for reading. @@ -1362,7 +1350,7 @@ Prepares the input for reading. sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) } -=item $c->prepare_request +=head2 $c->prepare_request Prepares the engine request. @@ -1370,7 +1358,7 @@ Prepares the engine request. sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) } -=item $c->prepare_uploads +=head2 $c->prepare_uploads Prepares uploads. @@ -1398,7 +1386,7 @@ sub prepare_uploads { } } -=item $c->prepare_write +=head2 $c->prepare_write Prepares the output for writing. @@ -1406,15 +1394,15 @@ Prepares the output for writing. sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) } -=item $c->request_class +=head2 $c->request_class Returns or sets the request class. -=item $c->response_class +=head2 $c->response_class Returns or sets the response class. -=item $c->read( [$maxlength] ) +=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. @@ -1427,7 +1415,7 @@ directly. sub read { my $c = shift; return $c->engine->read( $c, @_ ) } -=item $c->run +=head2 $c->run Starts the engine. @@ -1435,7 +1423,7 @@ 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 ) Sets an action in a given namespace. @@ -1443,7 +1431,7 @@ Sets an action in a given namespace. sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) } -=item $c->setup_actions($component) +=head2 $c->setup_actions($component) Sets up actions for a component. @@ -1451,7 +1439,7 @@ Sets up actions for a component. sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) } -=item $c->setup_components +=head2 $c->setup_components Sets up components. @@ -1513,7 +1501,7 @@ qq/Couldn't instantiate component "$component", "new() didn't return a object"/ } } -=item $c->setup_dispatcher +=head2 $c->setup_dispatcher Sets up dispatcher. @@ -1550,7 +1538,7 @@ sub setup_dispatcher { $class->dispatcher( $dispatcher->new ); } -=item $c->setup_engine +=head2 $c->setup_engine Sets up engine. @@ -1571,7 +1559,7 @@ sub setup_engine { $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' }; } - if ( !$engine && $ENV{MOD_PERL} ) { + if ( $ENV{MOD_PERL} ) { # create the apache method { @@ -1587,21 +1575,25 @@ sub setup_engine { if ( $software eq 'mod_perl' ) { - if ( $version >= 1.99922 ) { - $engine = 'Catalyst::Engine::Apache2::MP20'; - } - - elsif ( $version >= 1.9901 ) { - $engine = 'Catalyst::Engine::Apache2::MP19'; - } - - elsif ( $version >= 1.24 ) { - $engine = 'Catalyst::Engine::Apache::MP13'; - } + if ( !$engine ) { + + if ( $version >= 1.99922 ) { + $engine = 'Catalyst::Engine::Apache2::MP20'; + } + + 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 @@ -1674,7 +1666,7 @@ qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ $class->engine( $engine->new ); } -=item $c->setup_home +=head2 $c->setup_home Sets up the home directory. @@ -1701,7 +1693,7 @@ sub setup_home { } } -=item $c->setup_log +=head2 $c->setup_log Sets up log. @@ -1728,7 +1720,7 @@ sub setup_log { } } -=item $c->setup_plugins +=head2 $c->setup_plugins Sets up plugins. @@ -1756,11 +1748,11 @@ sub setup_plugins { } } -=item $c->stack +=head2 $c->stack Returns the stack. -=item $c->write( $data ) +=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 @@ -1777,7 +1769,7 @@ sub write { return $c->engine->write( $c, @_ ); } -=item version +=head2 version Returns the Catalyst version number. Mostly useful for "powered by" messages in template systems. @@ -1786,8 +1778,6 @@ messages in template systems. sub version { return $Catalyst::VERSION } -=back - =head1 INTERNAL ACTIONS Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>, @@ -1877,23 +1867,21 @@ Wiki: =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, L - Base classes for components +=head2 L, L - Base classes for components -=item L - Core engine +=head2 L - Core engine -=item L - Log class. +=head2 L - Log class. -=item L - Request object +=head2 L - Request object -=item L - Response object +=head2 L - Response object -=item L - The test suite. - -=back +=head2 L - The test suite. =head1 CREDITS @@ -1927,6 +1915,8 @@ David Kamholz David Naughton +Drew Taylor + Gary Ashton Jones Geoff Richards