X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=8480fca3450b072bbcd3c819277b1c21f2f3af49;hp=0f70e5e082bc588d76e60d85cc1b07839aca3aee;hb=3fb903fd7b2a932d4a124dbb3c364275b665858d;hpb=46d0346ddafe8e167c679cddef9834946598e689 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 0f70e5e..8480fca 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,6 +1,11 @@ package Catalyst; +# we don't need really need this, but if we load it before MRO::Compat gets +# loaded (via Moose and Class::MOP), we can avoid some nasty warnings +use Class::C3; + use Moose; +use Class::MOP::Object (); extends 'Catalyst::Component'; use bytes; use Catalyst::Exception; @@ -39,8 +44,6 @@ has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, re has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1); has namespace => (is => 'rw'); -attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); - sub depth { scalar @{ shift->stack || [] }; } sub comp { shift->component(@_) } @@ -61,6 +64,7 @@ our $COUNT = 1; our $START = time; our $RECURSION = 1000; our $DETACH = "catalyst_detach\n"; +our $GO = "catalyst_go\n"; #I imagine that very few of these really need to be class variables. if any. #maybe we should just make them attributes with a default? @@ -77,7 +81,7 @@ __PACKAGE__->stats_class('Catalyst::Stats'); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.7013'; +our $VERSION = '5.8000_04'; sub import { my ( $class, @arguments ) = @_; @@ -117,7 +121,7 @@ documentation and tutorials. catalyst.pl MyApp # add models, views, controllers - script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db + script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db script/myapp_create.pl view MyTemplate TT script/myapp_create.pl controller Search @@ -347,6 +351,40 @@ When called with no arguments it escapes the processing chain entirely. sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +=head2 $c->visit( $action [, \@arguments ] ) + +=head2 $c->visit( $class, $method, [, \@arguments ] ) + +Almost the same as C, but does a full dispatch, instead of just +calling the new C<$action> / C<$class-E$method>. This means that C, +C and the method you go to are called, just like a new request. + +C<$c-Estash> is kept unchanged. + +In effect, C allows you to "wrap" another action, just as it +would have been called by dispatching from a URL, while the analogous +C allows you to transfer control to another action as if it had +been reached directly from a URL. + +=cut + +sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) } + +=head2 $c->go( $action [, \@arguments ] ) + +=head2 $c->go( $class, $method, [, \@arguments ] ) + +Almost the same as C, but does a full dispatch like C, +instead of just calling the new C<$action> / +C<$class-E$method>. This means that C, C and the +method you visit are called, just like a new request. + +C<$c-Estash> is kept unchanged. + +=cut + +sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) } + =head2 $c->response =head2 $c->res @@ -438,87 +476,66 @@ sub clear_errors { $c->error(0); } +# search components given a name and some prefixes +sub _comp_search_prefixes { + my ( $c, $name, @prefixes ) = @_; + my $appclass = ref $c || $c; + my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::'; -# search via regex -sub _comp_search { - my ( $c, @names ) = @_; + # map the original component name to the sub part that we will search against + my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; } + grep { /$filter/ } keys %{ $c->components }; - foreach my $name (@names) { - foreach my $component ( keys %{ $c->components } ) { - return $c->components->{$component} if $component =~ /$name/i; - } - } + # undef for a name will return all + return keys %eligible if !defined $name; - return undef; -} + my $query = ref $name ? $name : qr/^$name$/i; + my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible; -# try explicit component names -sub _comp_explicit { - my ( $c, @names ) = @_; + return map { $c->components->{ $_ } } @result if @result; - foreach my $try (@names) { - return $c->components->{$try} if ( exists $c->components->{$try} ); - } + # if we were given a regexp to search against, we're done. + return if ref $name; - 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 ) = @_; + # regexp fallback + $query = qr/$name/i; + @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible; - my $appclass = ref $c || $c; + # no results? try against full names + if( !@result ) { + @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible; + } - my @names = map { "${appclass}::${_}::${name}" } @prefixes; + # don't warn if we didn't find any results, it just might not exist + if( @result ) { + $c->log->warn( qq(Found results for "${name}" using regexp fallback.) ); + $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' ); + $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' ); + } - my $comp = $c->_comp_explicit(@names); - return $comp if defined($comp); - $comp = $c->_comp_search($name); - return $comp; + return @result; } # Find possible names for a prefix - sub _comp_names { my ( $c, @prefixes ) = @_; - my $appclass = ref $c || $c; - my @pre = map { "${appclass}::${_}::" } @prefixes; - - my @names; - - COMPONENT: foreach my $comp ($c->component) { - foreach my $p (@pre) { - if ($comp =~ s/^$p//) { - push(@names, $comp); - next COMPONENT; - } - } - } + my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::'; + my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes ); return @names; } -# Return a component if only one matches. -sub _comp_singular { - my ( $c, @prefixes ) = @_; - - my $appclass = ref $c || $c; - - my ( $comp, $rest ) = - map { $c->_comp_search("^${appclass}::${_}::") } @prefixes; - return $comp unless $rest; -} - # Filter a component before returning by calling ACCEPT_CONTEXT if available sub _filter_component { my ( $c, $comp, @args ) = @_; + if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) { return $comp->ACCEPT_CONTEXT( $c, @args ); } - else { return $comp } + + return $comp; } =head2 COMPONENT ACCESSORS @@ -532,13 +549,23 @@ Gets a L instance by name. If the name is omitted, will return the controller for the dispatched action. +If you want to search for controllers, pass in a regexp as the argument. + + # find all controllers that start with Foo + my @foo_controllers = $c->controller(qr{^Foo}); + + =cut sub controller { my ( $c, $name, @args ) = @_; - return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ), - @args ) - if ($name); + + if( $name ) { + my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ ); + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + return $c->_filter_component( $result[ 0 ], @args ); + } + return $c->component( $c->action->class ); } @@ -551,18 +578,27 @@ Gets a L instance by name. 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 object in $c->stash->{current_model_instance}, then - a model name in $c->stash->{current_model}, then - a config setting 'default_model', or - check if there is only one model, and return it if that's the case. +If you want to search for models, pass in a regexp as the argument. + + # find all models that start with Foo + my @foo_models = $c->model(qr{^Foo}); + =cut sub model { my ( $c, $name, @args ) = @_; - return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ), - @args ) - if $name; + + if( $name ) { + my @result = $c->_comp_search_prefixes( $name, qw/Model M/ ); + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + return $c->_filter_component( $result[ 0 ], @args ); + } + if (ref $c) { return $c->stash->{current_model_instance} if $c->stash->{current_model_instance}; @@ -571,19 +607,18 @@ sub model { } return $c->model( $c->config->{default_model} ) if $c->config->{default_model}; - return $c->_filter_component( $c->_comp_singular(qw/Model M/) ); - -} -=head2 $c->controllers - -Returns the available names which can be passed to $c->controller + my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/); -=cut + if( $rest ) { + $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' ); + $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' ); + $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' ); + $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' ); + $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' ); + } -sub controllers { - my ( $c ) = @_; - return $c->_comp_names(qw/Controller C/); + return $c->_filter_component( $comp ); } @@ -596,18 +631,27 @@ Gets a L instance by name. 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 object in $c->stash->{current_view_instance}, then - a view name in $c->stash->{current_view}, then - a config setting 'default_view', or - check if there is only one view, and return it if that's the case. +If you want to search for views, pass in a regexp as the argument. + + # find all views that start with Foo + my @foo_views = $c->view(qr{^Foo}); + =cut sub view { my ( $c, $name, @args ) = @_; - return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ), - @args ) - if $name; + + if( $name ) { + my @result = $c->_comp_search_prefixes( $name, qw/View V/ ); + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + return $c->_filter_component( $result[ 0 ], @args ); + } + if (ref $c) { return $c->stash->{current_view_instance} if $c->stash->{current_view_instance}; @@ -616,7 +660,29 @@ sub view { } return $c->view( $c->config->{default_view} ) if $c->config->{default_view}; - return $c->_filter_component( $c->_comp_singular(qw/View V/) ); + + my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/); + + if( $rest ) { + $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' ); + $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' ); + $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' ); + $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' ); + $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' ); + } + + return $c->_filter_component( $comp ); +} + +=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->models @@ -651,35 +717,52 @@ unless you want to get a specific component by full class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >> should be used instead. +If C<$name> is a regexp, a list of components matched against the full +component name will be returned. + =cut sub component { - my $c = shift; + my ( $c, $name, @args ) = @_; - if (@_) { + if( $name ) { + my $comps = $c->components; - my $name = shift; + if( !ref $name ) { + # is it the exact name? + return $c->_filter_component( $comps->{ $name }, @args ) + if exists $comps->{ $name }; - my $appclass = ref $c || $c; + # perhaps we just omitted "MyApp"? + my $composed = ( ref $c || $c ) . "::${name}"; + return $c->_filter_component( $comps->{ $composed }, @args ) + if exists $comps->{ $composed }; - my @names = ( - $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } - qw/Model M Controller C View V/ - ); + # search all of the models, views and controllers + my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ ); + return $c->_filter_component( $comp, @args ) if $comp; + } - my $comp = $c->_comp_explicit(@names); - return $c->_filter_component( $comp, @_ ) if defined($comp); + # This is here so $c->comp( '::M::' ) works + my $query = ref $name ? $name : qr{$name}i; - $comp = $c->_comp_search($name); - return $c->_filter_component( $comp, @_ ) if defined($comp); + my @result = grep { m{$query} } keys %{ $c->components }; + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + + if( $result[ 0 ] ) { + $c->log->warn( qq(Found results for "${name}" using regexp fallback.) ); + $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' ); + $c->log->warn( 'is unreliable and unsafe. You have been warned' ); + return $c->_filter_component( $result[ 0 ], @args ); + } + + # I would expect to return an empty list here, but that breaks back-compat } + # fallback return sort keys %{ $c->components }; } - - =head2 CLASS DATA AND HELPER CLASSES =head2 $c->config @@ -935,23 +1018,30 @@ EOF $class->setup_finished(1); } +=head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? ) + =head2 $c->uri_for( $path, @args?, \%query_values? ) -Merges path with C<< $c->request->base >> for absolute URIs and with -C<< $c->namespace >> for relative URIs, 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 C is a hash reference, it is assumed to -contain GET parameter key/value pairs, which will be appended to the URI -in standard fashion. +=over + +=item $action + +A Catalyst::Action object representing the Catalyst action you want to +create a URI for. To get one for an action in the current controller, +use C<< $c->action('someactionname') >>. To get one from different +controller, fetch the controller using C<< $c->controller() >>, then +call C on it. -Note that uri_for is destructive to the passed hashref. Subsequent calls -with the same hashref may have unintended results. +You can maintain the arguments captured by an action (e.g.: Regex, Chained) +using C<< $c->req->captures >>. -Instead of C<$path>, you can also optionally pass a C<$action> object -which will be resolved to a path using -C<< $c->dispatcher->uri_for_action >>; if the first element of -C<@args> is an arrayref it is treated as a list of captures to be passed -to C. + # For the current action + $c->uri_for($c->action, $c->req->captures); + + # For the Foo action in the Bar controller + $c->uri_for($c->controller->('Bar')->action_for('Foo'), $c->req->captures); + +=back =cut @@ -988,7 +1078,7 @@ sub uri_for { # join args with '/', or a blank string my $args = join('/', grep { defined($_) } @args); $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE - $args =~ s!^/!!; + $args =~ s!^/+!!; my $base = $c->req->base; my $class = ref($base); $base =~ s{(?{$_}; s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; s/ /+/g; my $key = $_; - my $val = $params->{$_}; $val = '' unless defined $val; (map { $_ = "$_"; @@ -1120,7 +1210,7 @@ sub welcome_message {

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 want to start with a tutorial.

+ you might want to start with a tutorial.

perldoc Catalyst::Manual::Tutorial
 

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

@@ -1148,7 +1238,7 @@ sub welcome_message { Wiki
  • - Mailing-List + Mailing-List
  • IRC channel #catalyst on irc.perl.org @@ -1250,7 +1340,12 @@ sub execute { my $last = pop( @{ $c->stack } ); if ( my $error = $@ ) { - if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 } + if ( !ref($error) and $error eq $DETACH ) { + die $DETACH if($c->depth > 1); + } + elsif ( !ref($error) and $error eq $GO ) { + die $GO if($c->depth > 0); + } else { unless ( ref $error ) { no warnings 'uninitialized'; @@ -1442,8 +1537,7 @@ sub finalize_headers { $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; $response->header( Location => $location ); - #Moose TODO: we should probably be using a predicate method here ? - if ( !$response->body ) { + if ( !$response->has_body ) { # Add a default body if none is already present $response->body( qq{

    This item has moved here.

    } @@ -1610,7 +1704,8 @@ sub prepare { } my $method = $c->req->method || ''; - my $path = $c->req->path || '/'; + my $path = $c->req->path; + $path = '/' unless length $path; my $address = $c->req->address || ''; $c->log->debug(qq/"$method" request for "$path" from "$address"/) @@ -1862,6 +1957,11 @@ search paths, specify a key named C as an array reference. Items in the array beginning with C<::> will have the application class name prepended to them. +All components found will also have any +L loaded and set up as components. +Note, that modules which are B an I of the main +file namespace loaded will not be instantiated as components. + =cut sub setup_components { @@ -1982,9 +2082,10 @@ sub setup_engine { } if ( $ENV{MOD_PERL} ) { - + my $meta = $class->Class::MOP::Object::meta(); + # create the apache method - $class->meta->add_method('apache' => sub { shift->engine->apache }); + $meta->add_method('apache' => sub { shift->engine->apache }); my ( $software, $version ) = $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/; @@ -2042,9 +2143,6 @@ sub setup_engine { } Class::MOP::load_class($engine); - #unless (Class::Inspector->loaded($engine)) { - # require Class::Inspector->filename($engine); - #} # check for old engines that are no longer compatible my $old_engine; @@ -2119,7 +2217,7 @@ sub setup_log { my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' ); if ( defined($env_debug) ? $env_debug : $debug ) { - $class->meta->add_method('debug' => sub { 1 }); + $class->Class::MOP::Object::meta()->add_method('debug' => sub { 1 }); $class->log->debug('Debug messages enabled'); } } @@ -2143,7 +2241,7 @@ sub setup_stats { my $env = Catalyst::Utils::env_value( $class, 'STATS' ); if ( defined($env) ? $env : ($stats || $class->debug ) ) { - $class->meta->add_method('use_stats' => sub { 1 }); + $class->Class::MOP::Object::meta()->add_method('use_stats' => sub { 1 }); $class->log->debug('Statistics enabled'); } } @@ -2186,9 +2284,9 @@ the plugin name does not begin with C. $proto->_plugins->{$plugin} = 1; unless ($instant) { no strict 'refs'; - if( $class->can('meta') ){ - my @superclasses = ($plugin, $class->meta->superclasses ); - $class->meta->superclasses(@superclasses); + if ( my $meta = $class->Class::MOP::Object::meta() ) { + my @superclasses = ($plugin, $meta->superclasses ); + $meta->superclasses(@superclasses); } else { unshift @{"$class\::ISA"}, $plugin; } @@ -2337,8 +2435,8 @@ IRC: Mailing Lists: - http://lists.rawmode.org/mailman/listinfo/catalyst - http://lists.rawmode.org/mailman/listinfo/catalyst-dev + http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst + http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev Web: @@ -2366,13 +2464,15 @@ Wiki: =head2 L - The test suite. -=head1 CREDITS +=head1 PROJECT FOUNDER + +sri: Sebastian Riedel -Andy Grundman +=head1 CONTRIBUTORS -Andy Wardley +abw: Andy Wardley -Andreas Marienborg +acme: Leon Brocard Andrew Bramble @@ -2380,65 +2480,73 @@ Andrew Ford Andrew Ruthven -Arthur Bergman +andyg: Andy Grundman -Autrijus Tang +audreyt: Audrey Tang -Brian Cassidy +bricas: Brian Cassidy -Carl Franks +Caelum: Rafael Kitover -Christian Hansen +chansen: Christian Hansen -Christopher Hicks +chicks: Christopher Hicks -Dan Sully +dkubb: Dan Kubb -Danijel Milicevic +Drew Taylor -David Kamholz +esskar: Sascha Kiefer -David Naughton +fireartist: Carl Franks -Drew Taylor +gabb: Danijel Milicevic Gary Ashton Jones Geoff Richards -Jesse Sheidlower +ilmari: Dagfinn Ilmari Mannsåker -Jesse Vincent +jcamacho: Juan Camacho Jody Belka Johan Lindstrom -Juan Camacho +jon: Jon Schutz -Leon Brocard +marcus: Marcus Ramberg -Marcus Ramberg +miyagawa: Tatsuhiko Miyagawa -Matt S Trout +mst: Matt S. Trout -Robert Sedlacek +mugwump: Sam Vilain -Sam Vilain +naughton: David Naughton -Sascha Kiefer +ningu: David Kamholz -Sebastian Willert +nothingmuch: Yuval Kogman -Tatsuhiko Miyagawa +numa: Dan Sully -Ulf Edvinsson +obra: Jesse Vincent + +omega: Andreas Marienborg + +phaylon: Robert Sedlacek -Yuval Kogman +rafl: Florian Ragwitz -=head1 AUTHOR +sky: Arthur Bergman + +the_jester: Jesse Sheidlower + +Ulf Edvinsson -Sebastian Riedel, C +willert: Sebastian Willert =head1 LICENSE