X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=4fe18e78bead702b460a4624e3fc21e01c917613;hp=319684d8b112c262746f80156a148396a47a31eb;hb=e80e8542290e1c62b3c6dbee4265691d7ad634c3;hpb=4395d7fc979aaf9f289ff805d26890aba738bf5c diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 319684d..4fe18e7 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -3,7 +3,6 @@ package Catalyst; use strict; use base 'Catalyst::Component'; use bytes; -use UNIVERSAL::require; use Catalyst::Exception; use Catalyst::Log; use Catalyst::Request; @@ -25,6 +24,8 @@ use attributes; use utf8; use Carp qw/croak/; +BEGIN { require 5.008001; } + __PACKAGE__->mk_accessors( qw/counter request response state action stack namespace stats/ ); @@ -61,7 +62,7 @@ __PACKAGE__->engine_class('Catalyst::Engine::CGI'); __PACKAGE__->request_class('Catalyst::Request'); __PACKAGE__->response_class('Catalyst::Response'); -our $VERSION = '5.67'; +our $VERSION = '5.6902'; sub import { my ( $class, @arguments ) = @_; @@ -87,11 +88,11 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS - # use the helper to start a new application + # use the helper to create 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 model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db script/myapp_create.pl view TT TT script/myapp_create.pl controller Search @@ -101,15 +102,16 @@ Catalyst - The Elegant MVC Web Application Framework # command line testing interface script/myapp_test.pl /yada - ### in MyApp.pm + ### in lib/MyApp.pm use Catalyst qw/-Debug/; # include plugins here as well + ### In libMyApp/Controller/Root.pm (autocreated) 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] } ); + $c->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 @@ -127,7 +129,7 @@ Catalyst - The Elegant MVC Web Application Framework # called for all actions, from the top-most controller downwards sub auto : Private { my ( $self, $c ) = @_; - if ( !$c->user ) { + if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication $c->res->redirect( '/login' ); # require login return 0; # abort request and go immediately to end() } @@ -156,21 +158,21 @@ Catalyst - The Elegant MVC Web Application Framework # called for /foo/bar/baz sub baz : Local { ... } - # first MyApp auto is called, then Foo auto, then this + # first Root 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]; + my $product = $c->req->captures->[0]; } See L for additional information. =head1 DESCRIPTION -The key concept of Catalyst is DRY (Don't Repeat Yourself). +Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L or L See L for more documentation. @@ -201,7 +203,9 @@ The following flags are supported: =head2 -Debug -Enables debug output. +Enables debug output. You can also force this setting from the system +environment with CATALYST_DEBUG or _DEBUG. The environment settings +override the app, with _DEBUG having highest priority. =head2 -Engine @@ -244,16 +248,16 @@ corresponding to the controller of the current action. For example: Returns the current L object. See L. -=head2 PROCESSING AND RESPONSE TO THE CURRENT REQUEST +=head2 REQUEST FLOW HANDLING =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, +Forwards processing to another action, by it's private name. 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 @@ -284,12 +288,48 @@ sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } =head2 $c->detach( $class, $method, [, \@arguments ] ) -The same as C, but doesn't return. +The same as C, but doesn't return to the previous action when +processing is finished. =cut sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +=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]; + croak('stash takes a hash or hashref') unless ref $stash; + foreach my $key ( keys %$stash ) { + $c->{stash}->{$key} = $stash->{$key}; + } + } + return $c->{stash}; +} + =head2 $c->error =head2 $c->error($error, ...) @@ -319,6 +359,11 @@ sub error { return $c->{error} || []; } + +=head2 $c->state + +Contains the return value of the last executed action. + =head2 $c->clear_errors Clear errors. You probably don't want to clear the errors unless you are @@ -335,45 +380,8 @@ sub clear_errors { $c->error(0); } -=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 { @@ -459,42 +467,6 @@ sub _filter_component { =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 $c->_filter_component( $comp, @_ ) if defined($comp); - - $comp = $c->_comp_search($name); - return $c->_filter_component( $comp, @_ ) if defined($comp); - } - - return sort keys %{ $c->components }; -} - =head2 $c->controller($name) Gets a L instance by name. @@ -513,17 +485,6 @@ sub controller { return $c->component( $c->action->class ); } -=head2 $c->controllers - -Returns the available names which can be passed to $c->controller - -=cut - -sub controllers { - my ( $c ) = @_; - return $c->_comp_names(qw/Controller C/); -} - =head2 $c->model($name) Gets a L instance by name. @@ -531,7 +492,7 @@ Gets a L instance by name. $c->model('Foo')->do_stuff; If the name is omitted, it will look for a config setting 'default_model', -or check if there is only one model, and forward to it if that's the case. +or check if there is only one view, and return it if that's the case. =cut @@ -546,17 +507,18 @@ sub model { } -=head2 $c->models +=head2 $c->controllers -Returns the available names which can be passed to $c->model +Returns the available names which can be passed to $c->controller =cut -sub models { +sub controllers { my ( $c ) = @_; - return $c->_comp_names(qw/Model M/); + return $c->_comp_names(qw/Controller C/); } + =head2 $c->view($name) Gets a L instance by name. @@ -578,6 +540,18 @@ sub view { return $c->_filter_component( $c->_comp_singular(qw/View V/) ); } +=head2 $c->models + +Returns the available names which can be passed to $c->model + +=cut + +sub models { + my ( $c ) = @_; + return $c->_comp_names(qw/Model M/); +} + + =head2 $c->views Returns the available names which can be passed to $c->view @@ -589,7 +563,45 @@ sub views { return $c->_comp_names(qw/View V/); } -=head2 Class data and helper classes +=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 $c->_filter_component( $comp, @_ ) if defined($comp); + + $comp = $c->_comp_search($name); + return $c->_filter_component( $comp, @_ ) if defined($comp); + } + + return sort keys %{ $c->components }; +} + + + +=head2 CLASS DATA AND HELPER CLASSES =head2 $c->config @@ -603,6 +615,7 @@ applications home directory. --- db: dsn:SQLite:foo.db + =cut sub config { @@ -614,24 +627,6 @@ sub config { $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 @@ -649,8 +644,29 @@ And later: Your log class should implement the methods described in the L man page. + +=head2 $c->debug + +Overload to enable debug messages (same as -Debug option). + +Note that this is a static method, not an accessor and should be overloaded +by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1). + =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 UTILITY METHODS =head2 $c->path_to(@path) @@ -716,6 +732,9 @@ Catalyst> line. sub setup { my ( $class, @arguments ) = @_; + $class->log->warn("Running setup twice is not a good idea.") + if ( $class->setup_finished ); + unless ( $class->isa('Catalyst') ) { Catalyst::Exception->throw( @@ -783,7 +802,7 @@ EOF } if (@plugins) { - my $t = Text::SimpleTable->new(76); + my $t = Text::SimpleTable->new(74); $t->row($_) for @plugins; $class->log->debug( "Loaded plugins:\n" . $t->draw ); } @@ -815,7 +834,7 @@ EOF $class->setup_components; if ( $class->debug ) { - my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] ); + my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] ); for my $comp ( sort keys %{ $class->components } ) { my $type = ref $class->components->{$comp} ? 'instance' : 'class'; $t->row( $comp, $type ); @@ -855,10 +874,10 @@ sub uri_for { my $basepath = $base->path; $basepath =~ s/\/$//; $basepath .= '/'; - my $namespace = $c->namespace; + my $namespace = $c->namespace || ''; # massage namespace, empty if absolute path - $namespace =~ s/^\///; + $namespace =~ s/^\/// if $namespace; $namespace .= '/' if $namespace; $path ||= ''; $namespace = '' if $path =~ /^\//; @@ -872,7 +891,7 @@ sub uri_for { if( $isa_ref and $isa_ref ne 'ARRAY' ) { croak( "Non-array reference ($isa_ref) passed to uri_for()" ); } - utf8::encode( $_ ) for $isa_ref ? @$value : $value; + utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value; }; # join args with '/', or a blank string @@ -919,7 +938,6 @@ sub welcome_message { text-align: left; background-color: #ccc; border: 1px solid #aaa; - -moz-border-radius: 10px; } p, h1, h2 { margin-left: 20px; @@ -949,7 +967,6 @@ sub welcome_message { margin: 10px; background-color: #fff; border: 1px solid #aaa; - -moz-border-radius: 10px; } h1 { font-size: 0.9em; @@ -1073,7 +1090,10 @@ that will be dumped on the error page in debug mode. sub dump_these { my $c = shift; - [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],; + [ Request => $c->req ], + [ Response => $c->res ], + [ Stash => $c->stash ], + [ Config => $c->config ]; } =head2 $c->engine_class @@ -1265,7 +1285,7 @@ sub finalize { # Allow engine to handle finalize flow (for POE) if ( $c->engine->can('finalize') ) { - $c->engine->finalize( $c ); + $c->engine->finalize($c); } else { @@ -1428,7 +1448,7 @@ sub handle_request { $elapsed = sprintf '%f', $elapsed; my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); - my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] ); + my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] ); $stats->traverse( sub { @@ -1480,7 +1500,7 @@ sub prepare { parameters => {}, query_parameters => {}, secure => 0, - snippets => [], + captures => [], uploads => {} } ), @@ -1506,9 +1526,8 @@ sub prepare { 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('**********************************'); + my $time = localtime time; + $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***"); $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); } @@ -1529,7 +1548,7 @@ sub prepare { } my $method = $c->req->method || ''; - my $path = $c->req->path || ''; + my $path = $c->req->path || '/'; my $address = $c->req->address || ''; $c->log->debug(qq/"$method" request for "$path" from "$address"/) @@ -1542,7 +1561,7 @@ sub prepare { =head2 $c->prepare_action -Prepares action. +Prepares action. See L. =cut @@ -1566,7 +1585,7 @@ sub prepare_body { $c->prepare_uploads; if ( $c->debug && keys %{ $c->req->body_parameters } ) { - my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); + my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] ); for my $key ( sort keys %{ $c->req->body_parameters } ) { my $param = $c->req->body_parameters->{$key}; my $value = defined($param) ? $param : ''; @@ -1581,6 +1600,8 @@ sub prepare_body { Prepares a chunk of data before sending it to L. +See L. + =cut sub prepare_body_chunk { @@ -1658,7 +1679,7 @@ sub prepare_query_parameters { $c->engine->prepare_query_parameters( $c, @_ ); if ( $c->debug && keys %{ $c->request->query_parameters } ) { - my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); + my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] ); for my $key ( sort keys %{ $c->req->query_parameters } ) { my $param = $c->req->query_parameters->{$key}; my $value = defined($param) ? $param : ''; @@ -1698,8 +1719,8 @@ sub prepare_uploads { if ( $c->debug && keys %{ $c->request->uploads } ) { my $t = Text::SimpleTable->new( - [ 12, 'Key' ], - [ 28, 'Filename' ], + [ 12, 'Parameter' ], + [ 26, 'Filename' ], [ 18, 'Type' ], [ 9, 'Size' ] ); @@ -1854,11 +1875,8 @@ sub setup_dispatcher { $dispatcher = $class->dispatcher_class; } - $dispatcher->require; - - if ($@) { - Catalyst::Exception->throw( - message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ ); + unless (Class::Inspector->loaded($dispatcher)) { + require Class::Inspector->filename($dispatcher); } # dispatcher instance @@ -1949,12 +1967,8 @@ sub setup_engine { $engine = $class->engine_class; } - $engine->require; - - if ($@) { - Catalyst::Exception->throw( message => -qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ - ); + unless (Class::Inspector->loaded($engine)) { + require Class::Inspector->filename($engine); } # check for old engines that are no longer compatible @@ -2082,12 +2096,8 @@ the plugin name does not begin with C. my ( $proto, $plugin, $instant ) = @_; my $class = ref $proto || $proto; - $plugin->require; - - if ( my $error = $@ ) { - my $type = $instant ? "instant " : ''; - Catalyst::Exception->throw( - message => qq/Couldn't load ${type}plugin "$plugin", $error/ ); + unless (Class::Inspector->loaded($plugin)) { + require Class::Inspector->filename($plugin); } $proto->_plugins->{$plugin} = 1;