X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=cc40dc1f20a8c60309803472644c8b48cb945f5e;hb=15e9b5ddb1d1368677b9dfd59ec5625d9b3459e1;hp=8c4a5d89ea4227d5a31bf72309d3f2645b63a44d;hpb=61a9002d77ce79bc038b3ec6212e275015801594;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 8c4a5d8..cc40dc1 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -17,7 +17,9 @@ use overload '""' => sub { return ref shift }, fallback => 1; __PACKAGE__->mk_accessors( qw/tree dispatch_types registered_dispatch_types - method_action_class action_container_class/ + method_action_class action_container_class + preload_dispatch_types postload_dispatch_types + / ); # Preload these action types @@ -36,10 +38,53 @@ See L. =head1 DESCRIPTION +This is the class that maps public urls to actions in your Catalyst +application based on the attributes you set. + =head1 METHODS +=head2 new + +Construct a new dispatcher. + +=cut + +sub new { + my $self = shift; + my $class = ref($self) || $self; + + my $obj = $class->SUPER::new(@_); + + # set the default pre- and and postloads + $obj->preload_dispatch_types( \@PRELOAD ); + $obj->postload_dispatch_types( \@POSTLOAD ); + return $obj; +} + +=head2 $self->preload_dispatch_types + +An arrayref of pre-loaded dispatchtype classes + +Entries are considered to be available as C +To use a custom class outside the regular C namespace, prefix +it with a C<+>, like so: + + +My::Dispatch::Type + +=head2 $self->postload_dispatch_types + +An arrayref of post-loaded dispatchtype classes + +Entries are considered to be available as C +To use a custom class outside the regular C namespace, prefix +it with a C<+>, like so: + + +My::Dispatch::Type + =head2 $self->detach( $c, $command [, \@arguments ] ) +Documented in L + =cut sub detach { @@ -50,6 +95,10 @@ sub detach { =head2 $self->dispatch($c) +Delegate the dispatch to the action that matched the url, or return a +message about unknown resource + + =cut sub dispatch { @@ -70,6 +119,8 @@ sub dispatch { =head2 $self->forward( $c, $command [, \@arguments ] ) +Documented in L + =cut sub forward { @@ -170,6 +221,8 @@ qq/Couldn't forward to command "$command". Invalid action or component./; =head2 $self->prepare_action($c) +Find an dispatch type that matches $c->req->path, and set args from it. + =cut sub prepare_action { @@ -194,7 +247,9 @@ sub prepare_action { } # If not, move the last part path to args - unshift @args, pop @path; + my $arg = pop(@path); + $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; + unshift @args, $arg; } $c->log->debug( 'Path is "' . $c->req->match . '"' ) @@ -206,6 +261,8 @@ sub prepare_action { =head2 $self->get_action( $action, $namespace ) +returns a named action from a given namespace. + =cut sub get_action { @@ -240,6 +297,8 @@ sub get_actions { =head2 $self->get_containers( $namespace ) +Return all the action containers for a given namespace, inclusive + =cut sub get_containers { @@ -282,6 +341,10 @@ sub get_containers { =head2 $self->register( $c, $action ) +Make sure all required dispatch types for this action are loaded, then +pass the action to our dispatch types so they can register it if required. +Also, set up the tree with the action containers. + =cut sub register { @@ -309,8 +372,17 @@ sub register { return unless $reg + $priv; my $namespace = $action->namespace; - my $parent = $self->tree; - my $visitor = Tree::Simple::Visitor::FindByPath->new; + my $node = $self->find_or_create_namespace_node( $namespace ); + + # Set the method value + $node->getNodeValue->actions->{ $action->name } = $action; +} + +sub find_or_create_namespace_node { + my ( $self, $namespace, $parent, $visitor ) = @_; + + $parent ||= $self->tree; + $visitor ||= Tree::Simple::Visitor::FindByPath->new; if ($namespace) { for my $part ( split '/', $namespace ) { @@ -336,11 +408,11 @@ sub register { } } - # Set the method value - $parent->getNodeValue->actions->{ $action->name } = $action; + return $parent; } -=head2 $self->setup_actions( $class, $component ) +=head2 $self->setup_actions( $class, $context ) + =cut @@ -352,17 +424,11 @@ sub setup_actions { $self->method_action_class('Catalyst::Action'); $self->action_container_class('Catalyst::ActionContainer'); - # Preload action types - for my $type (@PRELOAD) { - my $class = "Catalyst::DispatchType::$type"; - eval "require $class"; - Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) - if $@; - push @{ $self->dispatch_types }, $class->new; - $self->registered_dispatch_types->{$class} = 1; - } + my @classes = + $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } ); + @{ $self->registered_dispatch_types }{@classes} = (1) x @classes; - # We use a tree + # Create the root node of the tree my $container = Catalyst::ActionContainer->new( { part => '/', actions => {} } ); $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); @@ -371,14 +437,7 @@ sub setup_actions { $comp->register_actions($c) if $comp->can('register_actions'); } - # Postload action types - for my $type (@POSTLOAD) { - my $class = "Catalyst::DispatchType::$type"; - eval "require $class"; - Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) - if $@; - push @{ $self->dispatch_types }, $class->new; - } + $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } ); return unless $c->debug; @@ -415,6 +474,26 @@ sub setup_actions { $_->list($c) for @{ $self->dispatch_types }; } +sub do_load_dispatch_types { + my ( $self, @types ) = @_; + + my @loaded; + + # Preload action types + for my $type (@types) { + my $class = + ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}"; + eval "require $class"; + Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) + if $@; + push @{ $self->dispatch_types }, $class->new; + + push @loaded, $class; + } + + return @loaded; +} + =head1 AUTHOR Sebastian Riedel, C