X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=de2f188f2b930138b1abcfff7157d7b762f35781;hp=dd0d1ed8e827f5710399feba9e917364c396d33c;hb=cccc8f68ace5d11c3fdcbfc4e353225b3b574255;hpb=596aaffea2f27d13f0725b72a5b9f79a826d285b diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index dd0d1ed..de2f188 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -19,12 +19,14 @@ use Path::Class::Dir (); use Path::Class::File (); use Time::HiRes qw/gettimeofday tv_interval/; use URI (); +use URI::http; +use URI::https; use Scalar::Util qw/weaken blessed/; use Tree::Simple qw/use_weak_refs/; use Tree::Simple::Visitor::FindByUID; use attributes; use utf8; -use Carp qw/croak/; +use Carp qw/croak carp/; BEGIN { require 5.008001; } @@ -61,7 +63,7 @@ __PACKAGE__->response_class('Catalyst::Response'); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.7006'; +our $VERSION = '5.7008'; sub import { my ( $class, @arguments ) = @_; @@ -87,16 +89,20 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS +See the L distribution for comprehensive +documentation and tutorials. + # Install Catalyst::Devel for helpers and other development tools # use the helper to create a new application catalyst.pl MyApp # add models, views, controllers - script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db - script/myapp_create.pl view TT TT + script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db + script/myapp_create.pl view MyTemplate TT script/myapp_create.pl controller Search # built in testserver -- use -r to restart automatically on changes + # --help to see all available options script/myapp_server.pl # command line testing interface @@ -224,6 +230,12 @@ Forces Catalyst to use a specific home directory, e.g.: use Catalyst qw[-Home=/usr/mst]; +This can also be done in the shell environment by setting either the +C environment variable or C; where C +is replaced with the uppercased name of your application, any "::" in +the name will be replaced with underscores, e.g. MyApp::Web should use +MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used. + =head2 -Log Specifies log level. @@ -262,8 +274,8 @@ cookies, HTTP headers, etc.). See L. Forwards processing to another action, by its 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. +C<@_> and C<< $c->req->args >>. Upon returning from the function, +C<< $c->req->args >> will be restored to the previous values. Any data Ced from the action forwarded to, will be returned by the call to forward. @@ -308,7 +320,7 @@ sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } =head2 $c->res -Returns the current L object, q.v. +Returns the current L object, see there for details. =head2 $c->stash @@ -325,7 +337,7 @@ Catalyst). $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' ); + $c->forward( 'MyApp::View::TT' ); =cut @@ -349,7 +361,7 @@ sub stash { 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. +method should only be used to store fatal error messages. my @error = @{ $c->error }; @@ -501,6 +513,8 @@ Gets a L instance by name. $c->model('Foo')->do_stuff; +Any extra arguments are directly passed to ACCEPT_CONTEXT. + If the name is omitted, it will look for - a model object in $c->stash{current_model_instance}, then - a model name in $c->stash->{current_model}, then @@ -519,10 +533,10 @@ sub model { if $c->stash->{current_model_instance}; return $c->model( $c->stash->{current_model} ) if $c->stash->{current_model}; - return $c->model( $c->config->{default_model} ) - if $c->config->{default_model}; } - return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args ); + return $c->model( $c->config->{default_model} ) + if $c->config->{default_model}; + return $c->_filter_component( $c->_comp_singular(qw/Model M/) ); } @@ -544,6 +558,8 @@ Gets a L instance by name. $c->view('Foo')->do_stuff; +Any extra arguments are directly passed to ACCEPT_CONTEXT. + If the name is omitted, it will look for - a view object in $c->stash{current_view_instance}, then - a view name in $c->stash->{current_view}, then @@ -562,9 +578,9 @@ sub view { if $c->stash->{current_view_instance}; return $c->view( $c->stash->{current_view} ) if $c->stash->{current_view}; - return $c->view( $c->config->{default_view} ) - if $c->config->{default_view}; } + return $c->view( $c->config->{default_view} ) + if $c->config->{default_view}; return $c->_filter_component( $c->_comp_singular(qw/View V/) ); } @@ -595,9 +611,9 @@ sub views { =head2 $c->component($name) -Gets a component object by name. This method is no longer recommended, +Gets a component object by name. This method is not recommended, unless you want to get a specific component by full -class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview> +class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >> should be used instead. =cut @@ -637,8 +653,9 @@ 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. +You can also use a C, C or C config file +like myapp.yml in your applications home directory. See +L. --- db: dsn:SQLite:foo.db @@ -699,8 +716,8 @@ L. =head2 $c->path_to(@path) -Merges C<@path> with C<$c-Econfig-E{home}> and returns a -L object. +Merges C<@path> with C<< $c->config->{home} >> and returns a +L object. For example: @@ -899,11 +916,6 @@ to C. sub uri_for { my ( $c, $path, @args ) = @_; - my $base = $c->request->base->clone; - my $basepath = $base->path; - $basepath =~ s/\/$//; - $basepath .= '/'; - my $namespace = $c->namespace || ''; if ( Scalar::Util::blessed($path) ) { # action object my $captures = ( scalar @args && ref $args[0] eq 'ARRAY' @@ -914,32 +926,53 @@ sub uri_for { $path = '/' if $path eq ''; } - # massage namespace, empty if absolute path - $namespace =~ s/^\/// if $namespace; - $namespace .= '/' if $namespace; - $path ||= ''; - $namespace = '' if $path =~ /^\//; - $path =~ s/^\///; - $path =~ s/\?/%3F/g; + undef($path) if (defined $path && $path eq ''); my $params = ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} ); - for my $value ( values %$params ) { - next unless defined $value; - for ( ref $value eq 'ARRAY' ? @$value : $value ) { - $_ = "$_"; - utf8::encode( $_ ); + carp "uri_for called with undef argument" if grep { ! defined $_ } @args; + s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args; + + unshift(@args, $path); + + unless (defined $path && $path =~ s!^/!!) { # in-place strip + my $namespace = $c->namespace; + if (defined $path) { # cheesy hack to handle path '../foo' + $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{}; } - }; + unshift(@args, $namespace || ''); + } # join args with '/', or a blank string - my $args = ( scalar @args ? '/' . join( '/', map {s/\?/%3F/g; $_} @args ) : '' ); - $args =~ s/^\/// unless $path; - my $res = - URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base ) - ->canonical; - $res->query_form(%$params); + my $args = join('/', grep { defined($_) } @args); + $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE + $args =~ s!^/!!; + my $base = $c->req->base; + my $class = ref($base); + $base =~ s{(?{$_}; + $val = '' unless defined $val; + (map { + $_ = "$_"; + utf8::encode( $_ ); + # using the URI::Escape pattern here so utf8 chars survive + s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go; + s/ /+/g; + "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val )); + } @keys); + } + + my $res = bless(\"${base}${args}${query}", $class); $res; } @@ -1047,13 +1080,13 @@ sub welcome_message { We do, however, provide you with a few starting points.

If you want to jump right into web development with Catalyst you might want want to start with a tutorial.

-
perldoc Catalyst::Manual::Tutorial
+
perldoc Catalyst::Manual::Tutorial
 

Afterwards you can go on to check out a more complete look at our features.

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

What to do next?

Next it's time to write an actual application. Use the helper scripts to generate controllers, @@ -1321,7 +1354,7 @@ sub finalize { if ($c->debug) { my $elapsed = sprintf '%f', tv_interval($c->stats->getNodeValue); - my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); + my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed; my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] ); $c->stats->traverse( @@ -1380,6 +1413,13 @@ sub finalize_headers { if ( my $location = $c->response->redirect ) { $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; $c->response->header( Location => $location ); + + if ( !$c->response->body ) { + # Add a default body if none is already present + $c->response->body( + qq{

This item has moved here.

} + ); + } } # Content-Length @@ -1388,7 +1428,8 @@ sub finalize_headers { # get the length from a filehandle if ( blessed( $c->response->body ) && $c->response->body->can('read') ) { - if ( my $stat = stat $c->response->body ) { + my $stat = stat $c->response->body; + if ( $stat && $stat->size > 0 ) { $c->response->content_length( $stat->size ); } else { @@ -1762,7 +1803,7 @@ 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 +You have to set C<< MyApp->config->{parse_on_demand} >> to use this directly. =cut @@ -1816,8 +1857,11 @@ sub setup_components { search_path => [ map { s/^(?=::)/$class/; $_; } @paths ], %$config ); + + my @comps = sort { length $a <=> length $b } $locator->plugins; + my %comps = map { $_ => 1 } @comps; - for my $component ( sort { length $a <=> length $b } $locator->plugins ) { + for my $component ( @comps ) { Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } ); my $module = $class->setup_component( $component ); @@ -1825,6 +1869,8 @@ sub setup_components { $component => $module, map { $_ => $class->setup_component( $_ ) + } grep { + not exists $comps{$_} } Devel::InnerPackage::list_packages( $component ) ); @@ -1878,13 +1924,8 @@ sub setup_dispatcher { $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher; } - if ( $ENV{CATALYST_DISPATCHER} ) { - $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER}; - } - - if ( $ENV{ uc($class) . '_DISPATCHER' } ) { - $dispatcher = - 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' }; + if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) { + $dispatcher = 'Catalyst::Dispatcher::' . $env; } unless ($dispatcher) { @@ -1912,12 +1953,8 @@ sub setup_engine { $engine = 'Catalyst::Engine::' . $engine; } - if ( $ENV{CATALYST_ENGINE} ) { - $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE}; - } - - if ( $ENV{ uc($class) . '_ENGINE' } ) { - $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' }; + if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) { + $engine = 'Catalyst::Engine::' . $env; } if ( $ENV{MOD_PERL} ) { @@ -2032,12 +2069,8 @@ Sets up the home directory. sub setup_home { my ( $class, $home ) = @_; - if ( $ENV{CATALYST_HOME} ) { - $home = $ENV{CATALYST_HOME}; - } - - if ( $ENV{ uc($class) . '_HOME' } ) { - $home = $ENV{ uc($class) . '_HOME' }; + if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) { + $home = $env; } unless ($home) { @@ -2063,14 +2096,8 @@ sub setup_log { $class->log( Catalyst::Log->new ); } - my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG'; - - if ( - ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) ) - ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} ) - : $debug - ) - { + my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' ); + if ( defined($env_debug) ? $env_debug : $debug ) { no strict 'refs'; *{"$class\::debug"} = sub { 1 }; $class->log->debug('Debug messages enabled'); @@ -2112,9 +2139,7 @@ the plugin name does not begin with C. my ( $proto, $plugin, $instant ) = @_; my $class = ref $proto || $proto; - unless (Class::Inspector->loaded($plugin)) { - require Class::Inspector->filename($plugin); - } + Catalyst::Utils::ensure_class_loaded( $plugin, { ignore_loaded => 1 } ); $proto->_plugins->{$plugin} = 1; unless ($instant) {