X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=53e06a987495eeb475945025282a5e6a2a8e5b54;hb=3d754f5852a61d0f5ba6321385d2ddb5bbb27ae5;hp=2b2890724311bb71fd730bd58e391011f349854f;hpb=1f90ca597beb428f6b9d9be207b097701fe36e59;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 2b28907..53e06a9 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -27,6 +27,7 @@ use URI::https; use Tree::Simple qw/use_weak_refs/; use Tree::Simple::Visitor::FindByUID; use Class::C3::Adopt::NEXT; +use List::Util qw/first/; use List::MoreUtils qw/uniq/; use attributes; use utf8; @@ -66,7 +67,7 @@ our $GO = Catalyst::Exception::Go->new; #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? -__PACKAGE__->mk_classdata($_) +__PACKAGE__->mk_classdata($_) # XXX FIXME - components remove from here for qw/container components arguments dispatcher engine log dispatcher_class engine_class context_class request_class response_class stats_class setup_finished/; @@ -92,10 +93,12 @@ sub import { return if $caller eq 'main'; my $meta = Moose::Meta::Class->initialize($caller); - unless ( $caller->isa('Catalyst') ) { - my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller'); - $meta->superclasses(@superclasses); - } + + unless ( $caller->isa('Catalyst') ) { # XXX - Remove! + my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller'); # XXX - Remove! + $meta->superclasses(@superclasses); # XXX - Remove! + } # XXX - Remove! + # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses); @@ -557,17 +560,19 @@ If you want to search for controllers, pass in a regexp as the argument. sub controller { my ( $c, $name, @args ) = @_; - my $container = $c->container->get_sub_container('controller'); - unshift @args, $c; - if( $name ) { - return $container->get_component($name, \@args) - if $container->has_service($name) && !ref $name; +# FIXME: should this be a Catalyst::Utils method? + if (!$name) { + my $class = $c->action->class; + + my $prefix = length Catalyst::Utils::class2classprefix($class); - return $container->get_component_regexp( $c, $name, \@args ); + # MyApp::Controller::Foo becomes Foo + # the + 2 is because of the :: + $name = substr $class, $prefix + 2; } - return $c->component( $c->action->class ); + return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args); } =head2 $c->model($name) @@ -593,39 +598,16 @@ If you want to search for models, pass in a regexp as the argument. sub model { my ( $c, $name, @args ) = @_; - my $appclass = ref($c) || $c; - my $container = $c->container->get_sub_container('model'); - unshift @args, $c; - - if( $name ) { - # Direct component hash lookup to avoid costly regexps - return $container->get_component($name, \@args) - if ( !ref $name && $container->has_service($name)); - return $container->get_component_regexp( $c, $name, \@args ); - } - - if (ref $c) { + if (ref $c && !$name) { return $c->stash->{current_model_instance} - if $c->stash->{current_model_instance}; - return $c->model( $c->stash->{current_model} ) - if $c->stash->{current_model}; - } - return $c->model( $appclass->config->{default_model} ) - if $appclass->config->{default_model}; - -# FIXME: will this still be mantained? - my( $comp, $rest ) = $container->get_service_list; + if $c->stash->{current_model_instance}; - if( $rest ) { - $c->log->warn( Carp::shortmess('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.81, the "random" behavior will not work at all.' ); + $name = $c->stash->{current_model} + if $c->stash->{current_model}; } - return $container->get_component( $comp, \@args ); + return $c->container->get_component_from_sub_container( 'model', $name, $c, @args); } @@ -652,43 +634,16 @@ If you want to search for views, pass in a regexp as the argument. sub view { my ( $c, $name, @args ) = @_; - my $appclass = ref($c) || $c; - my $container = $c->container->get_sub_container('view'); - unshift @args, $c; - if( $name ) { - if ( !ref $name ) { # Direct component hash lookup to avoid costly regexps - if ( $container->has_service($name) ) { - return $container->get_component($name, \@args); - } - else { - $c->log->warn( "Attempted to use view '$name', but does not exist" ); - } - } - - return $container->get_component_regexp( $c, $name, \@args ); - } - - if (ref $c) { + if (ref $c && !$name) { return $c->stash->{current_view_instance} - if $c->stash->{current_view_instance}; - return $c->view( $c->stash->{current_view} ) - if $c->stash->{current_view}; - } - return $c->view( $appclass->config->{default_view} ) - if $appclass->config->{default_view}; + if $c->stash->{current_view_instance}; - my( $comp, $rest ) = $container->get_service_list; - - 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.81, the "random" behavior will not work at all.' ); + $name = $c->stash->{current_view} + if $c->stash->{current_view}; } - return $container->get_component( $comp, \@args ); + return $c->container->get_component_from_sub_container( 'view', $name, $c, @args); } =head2 $c->controllers @@ -725,6 +680,28 @@ sub views { return $c->container->get_sub_container('view')->get_service_list; } +sub _find_component { + my ($c, $component, @args) = @_; + my @result; + + my $query = ref $component + ? $component + : qr{^$component$} + ; + + for my $subcontainer_name (qw/model view controller/) { + my $subcontainer = $c->container->get_sub_container($subcontainer_name); + my @components = $subcontainer->get_service_list; + @result = grep { m{$component} } @components; + + return map { $subcontainer->get_component( $_, $c, @args ) } @result + if @result; + } + + # it expects an empty list on failed searches + return @result; +} + =head2 $c->comp($name) =head2 $c->component($name) @@ -737,58 +714,40 @@ should be used instead. If C<$name> is a regexp, a list of components matched against the full component name will be returned. -If Catalyst can't find a component by name, it will fallback to regex -matching by default. To disable this behaviour set -disable_component_resolution_regex_fallback to a true value. - - __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 ); - =cut sub component { my ( $c, $component, @args ) = @_; - unshift @args, $c; - if ( $component ) { - my ($type, $name) = _get_component_type_name($component); + return sort keys %{ $c->components } + unless $component; - if ($type && $c->container->has_sub_container($type)) { - my $container = $c->container->get_sub_container($type); + my ($type, $name) = _get_component_type_name($component); - if( !ref $component && $container->has_service($name) ) { - return $container->get_component( $name, \@args ); - } + return $c->container->get_component_from_sub_container( + $type, $name, $c, @args + ) if $type; - return $container->get_component_regexp( $c, $name, \@args ); - } + my @result = $c->_find_component( $component, @args ); - return - if $c->config->{disable_component_resolution_regex_fallback} && !ref $component; + # list context for regexp searches + return @result if ref $component; - # This is here so $c->comp( '::M::' ) works - my $query = ref $component ? $component : qr{$component}i; + # only one component (if it's found) for string searches + return shift @result if @result; - for my $subcontainer_name (qw/model view controller/) { - my $subcontainer = $c->container->get_sub_container($subcontainer_name); - my @components = $subcontainer->get_service_list; - my @result = grep { m{$query} } @components; + # FIXME: I probably shouldn't be doing this + # I'm keeping it temporarily for things like $c->comp('MyApp') + #return $c->components->{$component} + # if exists $c->components->{$component} and !@args; - if (@result) { - return map { $subcontainer->get_component( $_, \@args ) } @result - if ref $component; + $c->log->warn("Looking for '$component', but nothing was found."); - $c->log->warn( Carp::shortmess(qq(Found results for "${component}" 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' ); + # I would expect to return an empty list here, but that breaks back-compat + $c->log->warn("Component not found, returning the list of existing"); + $c->log->warn("components. This behavior is going to be deprecated"); + $c->log->warn("in future releases."); - return $subcontainer->get_component( $result[0], \@args ); - } - } - - # I would expect to return an empty list here, but that breaks back-compat - } - - # fallback return sort keys %{ $c->components }; } @@ -956,7 +915,7 @@ Please do not use this functionality in new code. sub plugin { my ( $class, $name, $plugin, @args ) = @_; - # See block comment in t/unit_core_plugin.t + # See block comment in t/aggregate/unit_core_plugin.t $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/); $class->_register_plugin( $plugin, 1 ); @@ -1086,11 +1045,11 @@ EOF } # Initialize our data structure - $class->components( {} ); + $class->components( {} ); # XXX - Remove! $class->setup_components; - if ( $class->debug ) { + if ( $class->debug ) { # XXX - Fixme to be a method on the container? (Or at least get a) data structure back from the container!! my $column_width = Catalyst::Utils::term_width() - 8 - 9; my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] ); for my $comp ( sort keys %{ $class->components } ) { @@ -1503,6 +1462,10 @@ Returns a hash of components. =cut +# FIXME - We deal with ->components({'Foo' => 'Bar'}) +# however we DO NOT deal with ->components->{Foo} = 'Bar' +# We should return a locked hash back to the user? So that if they try the latter, they +# get breakage, rather than their addition being silently ignored? around components => sub { my $orig = shift; my $class = shift; @@ -1524,8 +1487,7 @@ around components => sub { my ($type, $name) = _get_component_type_name($component); -# FIXME: shouldn't the service name be $name? - $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } )); + $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } )); } return $class->$orig($components); @@ -2362,7 +2324,7 @@ sub setup_config { my %args = %{ $class->config || {} }; - my @container_classes = ( "${class}::Container", 'Catalyst::Container'); + my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container'); unshift @container_classes, delete $args{container_class} if exists $args{container_class}; my $container_class = Class::MOP::load_first_existing_class(@container_classes); @@ -2375,7 +2337,7 @@ sub setup_config { $class->finalize_config; # back-compat } -=head $c->finalize_config +=head2 $c->finalize_config =cut @@ -2400,6 +2362,7 @@ sub setup_components { my $class = shift; my $config = $class->config->{ setup_components }; + my $search_extra = $config->{ search_extra }; my @comps = $class->locate_components($config); my %comps = map { $_ => 1 } @comps; @@ -2423,8 +2386,8 @@ sub setup_components { for my $component (@comps) { my $instance = $class->components->{ $component } = $class->setup_component($component); - if ( my ($type, $name) = _get_component_type_name($component) ) { - $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $instance } )); + if ( my ($type, $name) = _get_component_type_name($component, $search_extra) ) { + $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } )); } my @expanded_components = $instance->can('expand_modules') ? $instance->expand_modules( $component, $config ) @@ -2437,18 +2400,32 @@ sub setup_components { qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n} ) if $deprecatedcatalyst_component_names; - if (my ($type, $name) = _get_component_type_name($component)) { - $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } )); + if (my ($type, $name) = _get_component_type_name($component, $search_extra)) { + $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } )); } + # FIXME - Remove this!! $class->components->{ $component } = $class->setup_component($component); } } + + $containers->{model}->make_single_default; + $containers->{view}->make_single_default; } +# FIXME: should this sub exist? +# should it be moved to Catalyst::Utils, +# or replaced by something already existing there? sub _get_component_type_name { - my $component = shift; - my @parts = split /::/, $component; + my ( $component, $search_extra) = @_; + $search_extra ||= []; + my @search_extra = map { s/^:://; lc $_ } @$search_extra; + + my @parts = split /::/, $component; + + if (scalar @parts == 1) { + return (undef, $component); + } while (my $type = shift @parts) { return ('controller', join '::', @parts) @@ -2459,9 +2436,20 @@ sub _get_component_type_name { return ('view', join '::', @parts) if $type =~ /^(v|view)$/i; + + return (_get_component_type($component), join '::', @parts) + if @search_extra and ( grep { lc $type eq $_ } @search_extra ); } } +sub _get_component_type { + my ( $instance ) = @_; + + return 'controller' if $instance->isa('Catalyst::Controller'); + return 'model' if $instance->isa('Catalyst::Model'); + return 'view' if $instance->isa('Catalyst::View'); +} + =head2 $c->locate_components( $setup_component_config ) This method is meant to provide a list of component modules that should be @@ -2510,6 +2498,7 @@ sub expand_component_module { =cut +## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?! sub setup_component { my( $class, $component ) = @_; @@ -2925,14 +2914,6 @@ C - The default view to be rendered or returned when C<< $c->view =item * -C - Turns -off the deprecated component resolution functionality so -that if any of the component methods (e.g. C<< $c->controller('Foo') >>) -are called then regex search will not be attempted on string values and -instead C will be returned. - -=item * - C - The application home directory. In an uninstalled application, this is the top level application directory. In an installed application, this will be the directory containing C<< MyApp.pm >>. @@ -3106,6 +3087,8 @@ Andrew Ford EA.Ford@ford-mason.co.ukE Andrew Ruthven +André Walker + andyg: Andy Grundman audreyt: Audrey Tang