X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=12040b23654b7e8c798e8125bee52e9311b3b9ec;hp=14fbe142b24924a23c192479fd7aeaa49997d921;hb=0ca510f0aa1cabe138d81897d38111d7b772449c;hpb=8f5a2bd91034f630162e41661d559095e4ec7a01 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 14fbe14..12040b2 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -14,37 +14,36 @@ use Catalyst::Utils; use Text::SimpleTable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; +use Class::Load qw(load_class try_load_class); +use Encode 2.21 'decode_utf8'; + +use namespace::clean -except => 'meta'; # Refactoring note: # do these belong as package vars or should we build these via a builder method? # See Catalyst-Plugin-Server for them being added to, which should be much less ugly. # Preload these action types -our @PRELOAD = qw/Index Path Regex/; +our @PRELOAD = qw/Index Path/; # Postload these action types our @POSTLOAD = qw/Default/; # Note - see back-compat methods at end of file. -has _tree => (is => 'rw'); -has _dispatch_types => (is => 'rw', default => sub { [] }, required => 1, lazy => 1); +has _tree => (is => 'rw', builder => '_build__tree'); +has dispatch_types => (is => 'rw', default => sub { [] }, required => 1, lazy => 1); has _registered_dispatch_types => (is => 'rw', default => sub { {} }, required => 1, lazy => 1); has _method_action_class => (is => 'rw', default => 'Catalyst::Action'); has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} }); has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} }); -has preload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@PRELOAD] }); -has postload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@POSTLOAD] }); - -# Wrap accessors so you can assign a list and it will capture a list ref. -around qw/preload_dispatch_types postload_dispatch_types/ => sub { - my $orig = shift; - my $self = shift; - return $self->$orig([@_]) if (scalar @_ && ref $_[0] ne 'ARRAY'); - return $self->$orig(@_); -}; - -no Moose; +my %dispatch_types = ( pre => \@PRELOAD, post => \@POSTLOAD ); +foreach my $type (keys %dispatch_types) { + has $type . "load_dispatch_types" => ( + is => 'rw', required => 1, lazy => 1, default => sub { $dispatch_types{$type} }, + traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute'], # List assignment is CAF style + ); +} =head1 NAME @@ -61,19 +60,19 @@ application based on the attributes you set. =head1 METHODS -=head2 new +=head2 new Construct a new dispatcher. =cut -sub BUILD { - my ($self, $params) = @_; +sub _build__tree { + my ($self) = @_; my $container = Catalyst::ActionContainer->new( { part => '/', actions => {} } ); - $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); + return Tree::Simple->new($container, Tree::Simple->ROOT); } =head2 $self->preload_dispatch_types @@ -110,6 +109,9 @@ sub dispatch { } else { my $path = $c->req->path; + $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; + $path = decode_utf8($path); + my $error = $path ? qq/Unknown resource "$path"/ : "No default action defined"; @@ -119,7 +121,8 @@ sub dispatch { } # $self->_command2action( $c, $command [, \@arguments ] ) -# Search for an action, from the command and returns C<($action, $args)> on +# $self->_command2action( $c, $command [, \@captures, \@arguments ] ) +# Search for an action, from the command and returns C<($action, $args, $captures)> on # success. Returns C<(0)> on error. sub _command2action { @@ -130,7 +133,11 @@ sub _command2action { return 0; } - my @args; + my (@args, @captures); + + if ( ref( $extra_params[-2] ) eq 'ARRAY' ) { + @captures = @{ splice @extra_params, -2, 1 }; + } if ( ref( $extra_params[-1] ) eq 'ARRAY' ) { @args = @{ pop @extra_params } @@ -151,14 +158,14 @@ sub _command2action { $action = $self->_invoke_as_path( $c, "$command", \@args ); } - # go to a component ( "MyApp::*::Foo" or $c->component("...") + # go to a component ( "View::Foo" or $c->component("...") # - a path or an object) unless ($action) { my $method = @extra_params ? $extra_params[0] : "process"; $action = $self->_invoke_as_component( $c, $command, $method ); } - return $action, \@args; + return $action, \@args, \@captures; } =head2 $self->visit( $c, $command [, \@arguments ] ) @@ -176,7 +183,7 @@ sub _do_visit { my $self = shift; my $opname = shift; my ( $c, $command ) = @_; - my ( $action, $args ) = $self->_command2action(@_); + my ( $action, $args, $captures ) = $self->_command2action(@_); my $error = qq/Couldn't $opname("$command"): /; if (!$action) { @@ -185,7 +192,7 @@ sub _do_visit { } elsif (!defined $action->namespace) { $error .= qq/Action has no namespace: cannot $opname() to a plain / - .qq/method or component, must be a :Action or some sort./ + .qq/method or component, must be an :Action of some sort./ } elsif (!$action->class->can('_DISPATCH')) { $error .= qq/Action cannot _DISPATCH. / @@ -204,6 +211,7 @@ sub _do_visit { $action = $self->expand_action($action); local $c->request->{arguments} = $args; + local $c->request->{captures} = $captures; local $c->{namespace} = $action->{'namespace'}; local $c->{action} = $action; @@ -219,7 +227,7 @@ Documented in L sub go { my $self = shift; $self->_do_visit('go', @_); - die $Catalyst::GO; + Catalyst::Exception::Go->throw; } =head2 $self->forward( $c, $command [, \@arguments ] ) @@ -230,6 +238,7 @@ Documented in L sub forward { my $self = shift; + no warnings 'recursion'; $self->_do_forward(forward => @_); } @@ -237,7 +246,7 @@ sub _do_forward { my $self = shift; my $opname = shift; my ( $c, $command ) = @_; - my ( $action, $args ) = $self->_command2action(@_); + my ( $action, $args, $captures ) = $self->_command2action(@_); if (!$action) { my $error .= qq/Couldn't $opname to command "$command": / @@ -247,9 +256,9 @@ sub _do_forward { return 0; } - no warnings 'recursion'; local $c->request->{arguments} = $args; + no warnings 'recursion'; $action->dispatch( $c ); return $c->state; @@ -264,7 +273,7 @@ Documented in L sub detach { my ( $self, $c, $command, @args ) = @_; $self->_do_forward(detach => $c, $command, @args ) if $command; - die $Catalyst::DETACH; + Catalyst::Exception::Detach->throw; } sub _action_rel2abs { @@ -301,35 +310,44 @@ sub _invoke_as_path { } } -sub _find_component_class { +sub _find_component { my ( $self, $c, $component ) = @_; - return ref($component) - || ref( $c->component($component) ) - || $c->component($component); + # fugly, why doesn't ->component('MyApp') work? + return $c if ($component eq blessed($c)); + + return blessed($component) + ? $component + : $c->component($component); } sub _invoke_as_component { - my ( $self, $c, $component, $method ) = @_; + my ( $self, $c, $component_or_class, $method ) = @_; - my $class = $self->_find_component_class( $c, $component ) || return 0; + my $component = $self->_find_component($c, $component_or_class); + my $component_class = blessed $component || return 0; - if ( my $code = $class->can($method) ) { + if (my $code = $component_class->can('action_for')) { + my $possible_action = $component->$code($method); + return $possible_action if $possible_action; + } + + if ( my $code = $component_class->can($method) ) { return $self->_method_action_class->new( { name => $method, code => $code, - reverse => "$class->$method", - class => $class, + reverse => "$component_class->$method", + class => $component_class, namespace => Catalyst::Utils::class2prefix( - $class, $c->config->{case_sensitive} + $component_class, ref($c)->config->{case_sensitive} ), } ); } else { my $error = - qq/Couldn't forward to "$class". Does not implement "$method"/; + qq/Couldn't forward to "$component_class". Does not implement "$method"/; $c->error($error); $c->log->debug($error) if $c->debug; @@ -354,14 +372,12 @@ sub prepare_action { DESCEND: while (@path) { $path = join '/', @path; - $path =~ s#^/##; - - $path = '' if $path eq '/'; # Root action + $path =~ s#^/+##; # Check out dispatch types to see if any will handle the path at # this level - foreach my $type ( @{ $self->_dispatch_types } ) { + foreach my $type ( @{ $self->dispatch_types } ) { last DESCEND if $type->match( $c, $path ); } @@ -373,10 +389,14 @@ sub prepare_action { s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]}; - $c->log->debug( 'Path is "' . $req->match . '"' ) - if ( $c->debug && defined $req->match && length $req->match ); + if($c->debug && defined $req->match && length $req->match) { + my $match = $req->match; + $match =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; + $match = decode_utf8($match); + $c->log->debug( 'Path is "' . $match . '"' ) + } - $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) + $c->log->debug( 'Arguments are "' . join( '/', map { decode_utf8 $_ } @args ) . '"' ) if ( $c->debug && @args ); } @@ -395,9 +415,9 @@ sub get_action { return $self->_action_hash->{"${namespace}/${name}"}; } -=head2 $self->get_action_by_path( $path ); +=head2 $self->get_action_by_path( $path ); -Returns the named action by its full path. +Returns the named action by its full private path. =cut @@ -443,9 +463,6 @@ sub get_containers { } return reverse grep { defined } @containers, $self->_container_hash->{''}; - - #return (split '/', $namespace); # isnt this more clear? - my @parts = split '/', $namespace; } =head2 $self->uri_for_action($action, \@captures) @@ -462,7 +479,7 @@ cannot determine an appropriate URI, this method will return undef. sub uri_for_action { my ( $self, $action, $captures) = @_; $captures ||= []; - foreach my $dispatch_type ( @{ $self->_dispatch_types } ) { + foreach my $dispatch_type ( @{ $self->dispatch_types } ) { my $uri = $dispatch_type->uri_for_action( $action, $captures ); return( $uri eq '' ? '/' : $uri ) if defined($uri); @@ -481,7 +498,7 @@ single action. sub expand_action { my ($self, $action) = @_; - foreach my $dispatch_type (@{ $self->_dispatch_types }) { + foreach my $dispatch_type (@{ $self->dispatch_types }) { my $expanded = $dispatch_type->expand_action($action); return $expanded if $expanded; } @@ -502,22 +519,43 @@ sub register { my $registered = $self->_registered_dispatch_types; - #my $priv = 0; #seems to be unused foreach my $key ( keys %{ $action->attributes } ) { next if $key eq 'Private'; my $class = "Catalyst::DispatchType::$key"; unless ( $registered->{$class} ) { # FIXME - Some error checking and re-throwing needed here, as # we eat exceptions loading dispatch types. - eval { Class::MOP::load_class($class) }; - push( @{ $self->_dispatch_types }, $class->new ) unless $@; + # see also try_load_class + eval { load_class($class) }; + my $load_failed = $@; + $self->_check_deprecated_dispatch_type( $key, $load_failed ); + push( @{ $self->dispatch_types }, $class->new ) unless $load_failed; $registered->{$class} = 1; } } + my @dtypes = @{ $self->dispatch_types }; + my @normal_dtypes; + my @low_precedence_dtypes; + + for my $type ( @dtypes ) { + if ($type->_is_low_precedence) { + push @low_precedence_dtypes, $type; + } else { + push @normal_dtypes, $type; + } + } + # Pass the action to our dispatch types so they can register it if reqd. - foreach my $type ( @{ $self->_dispatch_types } ) { - $type->register( $c, $action ); + my $was_registered = 0; + foreach my $type ( @normal_dtypes ) { + $was_registered = 1 if $type->register( $c, $action ); + } + + if (not $was_registered) { + foreach my $type ( @low_precedence_dtypes ) { + $type->register( $c, $action ); + } } my $namespace = $action->namespace; @@ -562,8 +600,9 @@ sub _find_or_create_namespace_node { =head2 $self->setup_actions( $class, $context ) -Loads all of the preload dispatch types, registers their actions and then -loads all of the postload dispatch types, and does dispatcher initialization. +Loads all of the pre-load dispatch types, registers their actions and then +loads all of the post-load dispatch types, and iterates over the tree of +actions, displaying the debug information if appropriate. =cut @@ -581,10 +620,18 @@ sub setup_actions { $self->_load_dispatch_types( @{ $self->postload_dispatch_types } ); return unless $c->debug; + $self->_display_action_tables($c); +} + +sub _display_action_tables { + my ($self, $c) = @_; - my $column_width = Catalyst::Utils::term_width() - 20 - 36 - 12; + my $avail_width = Catalyst::Utils::term_width() - 12; + my $col1_width = ($avail_width * .25) < 20 ? 20 : int($avail_width * .25); + my $col2_width = ($avail_width * .50) < 36 ? 36 : int($avail_width * .50); + my $col3_width = $avail_width - $col1_width - $col2_width; my $privates = Text::SimpleTable->new( - [ 20, 'Private' ], [ 36, 'Class' ], [ $column_width, 'Method' ] + [ $col1_width, 'Private' ], [ $col2_width, 'Class' ], [ $col3_width, 'Method' ] ); my $has_private = 0; @@ -611,23 +658,21 @@ sub setup_actions { if $has_private; # List all public actions - $_->list($c) for @{ $self->_dispatch_types }; + $_->list($c) for @{ $self->dispatch_types }; } sub _load_dispatch_types { my ( $self, @types ) = @_; my @loaded; - # Preload action types for my $type (@types) { - my $class = - ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}"; + # first param is undef because we cannot get the appclass + my $class = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $type); - eval { Class::MOP::load_class($class) }; - Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) - if $@; - push @{ $self->_dispatch_types }, $class->new; + my ($success, $error) = try_load_class($class); + Catalyst::Exception->throw( message => $error ) if not $success; + push @{ $self->dispatch_types }, $class->new; push @loaded, $class; } @@ -635,6 +680,48 @@ sub _load_dispatch_types { return @loaded; } +=head2 $self->dispatch_type( $type ) + +Get the DispatchType object of the relevant type, i.e. passing C<$type> of +C would return a L object (assuming +of course it's being used.) + +=cut + +sub dispatch_type { + my ($self, $name) = @_; + + # first param is undef because we cannot get the appclass + $name = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $name); + + for (@{ $self->dispatch_types }) { + return $_ if ref($_) eq $name; + } + return undef; +} + +sub _check_deprecated_dispatch_type { + my ($self, $key, $load_failed) = @_; + + return unless $key =~ /^(Local)?Regexp?/; + + # TODO: Should these throw an exception rather than just warning? + if ($load_failed) { + warn( "Attempt to use deprecated $key dispatch type.\n" + . " Use Chained methods or install the standalone\n" + . " Catalyst::DispatchType::Regex if necessary.\n" ); + } elsif ( !defined $Catalyst::DispatchType::Regex::VERSION + || $Catalyst::DispatchType::Regex::VERSION le '5.90020' ) { + # We loaded the old core version of the Regex module this will break + warn( "The $key DispatchType has been removed from Catalyst core.\n" + . " An old version of the core Catalyst::DispatchType::Regex\n" + . " has been loaded and will likely fail. Please remove\n" + . " $INC{'Catalyst/DispatchType/Regex.pm'}\n" + . " and use Chained methods or install the standalone\n" + . " Catalyst::DispatchType::Regex if necessary.\n" ); + } +} + use Moose; # 5.70 backwards compatibility hacks. @@ -642,19 +729,34 @@ use Moose; # Various plugins (e.g. Plugin::Server and Plugin::Authorization::ACL) # need the methods here which *should* be private.. -# However we can't really take them away until there is a sane API for -# building actions and configuring / introspecting the dispatcher. -# In 5.90, we should build that infrastructure, port the plugins which -# use it, and then take the crap below away. +# You should be able to use get_actions or get_containers appropriately +# instead of relying on these methods which expose implementation details +# of the dispatcher.. +# +# IRC backlog included below, please come ask if this doesn't work for you. +# +# <@t0m> 5.80, the state of. There are things in the dispatcher which have +# been deprecated, that we yell at anyone for using, which there isn't +# a good alternative for yet.. +# <@mst> er, get_actions/get_containers provides that doesn't it? +# <@mst> DispatchTypes are loaded on demand anyway +# <@t0m> I'm thinking of things like _tree which is aliased to 'tree' with +# warnings otherwise shit breaks.. We're issuing warnings about the +# correct set of things which you shouldn't be calling.. +# <@mst> right +# <@mst> basically, I don't see there's a need for a replacement for anything +# <@mst> it was never a good idea to call ->tree +# <@mst> nothingmuch was the only one who did AFAIK +# <@mst> and he admitted it was a hack ;) + # See also t/lib/TestApp/Plugin/AddDispatchTypes.pm # Alias _method_name to method_name, add a before modifier to warn.. -foreach my $public_method_name (qw/ - tree - dispatch_types - registered_dispatch_types - method_action_class - action_hash +foreach my $public_method_name (qw/ + tree + registered_dispatch_types + method_action_class + action_hash container_hash /) { my $private_method_name = '_' . $public_method_name; @@ -664,17 +766,18 @@ foreach my $public_method_name (qw/ my %package_hash; # Only warn once per method, per package. These are infrequent enough that # I haven't provided a way to disable them, patches welcome. $meta->add_before_method_modifier($public_method_name, sub { - my $class = blessed(shift); - $package_hash{$class}++ || do { - warn("Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n" - . "this will be removed in Catalyst 5.9X"); + my $class = caller(2); + chomp($class); + $package_hash{$class}++ || do { + warn("Class $class is calling the deprecated method\n" + . " Catalyst::Dispatcher::$public_method_name,\n" + . " this will be removed in Catalyst 5.9\n"); }; }); } } # End 5.70 backwards compatibility hacks. -no Moose; __PACKAGE__->meta->make_immutable; =head2 meta @@ -687,7 +790,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut