9fc441eae5d6da0741fa2c47d0f8eb448a6f77c1
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
1 package Catalyst::Dispatcher;
2
3 use strict;
4 use base 'Class::Data::Inheritable';
5 use Catalyst::Exception;
6 use Catalyst::Utils;
7 use Text::ASCIITable;
8 use Tree::Simple;
9 use Tree::Simple::Visitor::FindByPath;
10
11 __PACKAGE__->mk_classdata($_) for qw/actions tree/;
12
13 =head1 NAME
14
15 Catalyst::Dispatcher - The Catalyst Dispatcher
16
17 =head1 SYNOPSIS
18
19 See L<Catalyst>.
20
21 =head1 DESCRIPTION
22
23 =head1 METHODS
24
25 =over 4
26
27 =item $c->detach( $command [, \@arguments ] )
28
29 Like C<forward> but doesn't return.
30
31 =cut
32
33 sub detach {
34     my ( $c, $command, @args ) = @_;
35     $c->forward( $command, @args ) if $command;
36     die $Catalyst::Engine::DETACH;
37 }
38
39 =item $c->dispatch
40
41 Dispatch request to actions.
42
43 =cut
44
45 sub dispatch {
46     my $c         = shift;
47     my $action    = $c->req->action;
48     my $namespace = '';
49     $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
50       if $action eq 'default';
51
52     unless ($namespace) {
53         if ( my $result = $c->get_action($action) ) {
54             $namespace = Catalyst::Utils::class2prefix( $result->[0]->[0]->[0],
55                 $c->config->{case_sensitive} );
56         }
57     }
58
59     my $default = $action eq 'default' ? $namespace : undef;
60     my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
61     $namespace ||= '/';
62
63     if ( @{$results} ) {
64
65         # Execute last begin
66         $c->state(1);
67         if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
68             $c->execute( @{ $begin->[0] } );
69             return if scalar @{ $c->error };
70         }
71
72         # Execute the auto chain
73         my $autorun = 0;
74         for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
75             $autorun++;
76             $c->execute( @{ $auto->[0] } );
77             return if scalar @{ $c->error };
78             last unless $c->state;
79         }
80
81         # Execute the action or last default
82         my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
83         if ( ( my $action = $c->req->action ) && $mkay ) {
84             if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] )
85             {
86                 $c->execute( @{ $result->[0] } );
87             }
88         }
89
90         # Execute last end
91         if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
92             $c->execute( @{ $end->[0] } );
93             return if scalar @{ $c->error };
94         }
95     }
96
97     else {
98         my $path  = $c->req->path;
99         my $error = $path
100           ? qq/Unknown resource "$path"/
101           : "No default action defined";
102         $c->log->error($error) if $c->debug;
103         $c->error($error);
104     }
105 }
106
107 =item $c->forward( $command [, \@arguments ] )
108
109 Forward processing to a private action or a method from a class.
110 If you define a class without method it will default to process().
111 also takes an optional arrayref containing arguments to be passed
112 to the new function. $c->req->args will be reset upon returning 
113 from the function.
114
115     $c->forward('/foo');
116     $c->forward('index');
117     $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
118     $c->forward('MyApp::View::TT');
119
120 =cut
121
122 sub forward {
123     my $c       = shift;
124     my $command = shift;
125
126     unless ($command) {
127         $c->log->debug('Nothing to forward to') if $c->debug;
128         return 0;
129     }
130
131     # Relative forwards from detach
132     my $caller = ( caller(0) )[0]->isa('Catalyst::Dispatcher')
133       && ( ( caller(1) )[3] =~ /::detach$/ ) ? caller(1) : caller(0);
134
135     my $namespace = '/';
136     my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
137
138     if ( $command =~ /^\// ) {
139         $command =~ /^\/(.*)\/(\w+)$/;
140         $namespace = $1 || '/';
141         $command   = $2 || $command;
142         $command =~ s/^\///;
143     }
144
145     else {
146         $namespace =
147           Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
148           || '/';
149     }
150
151     my $results = $c->get_action( $command, $namespace );
152
153     unless ( @{$results} ) {
154
155         unless ( defined( $c->components->{$command} ) ) {
156             my $error =
157 qq/Couldn't forward to command "$command". Invalid action or component./;
158             $c->error($error);
159             $c->log->debug($error) if $c->debug;
160             return 0;
161         }
162
163         my $class  = $command;
164         my $method = shift || 'process';
165
166         if ( my $code = $c->components->{$class}->can($method) ) {
167             $c->actions->{reverse}->{"$code"} = "$class->$method";
168             $results = [ [ [ $class, $code ] ] ];
169         }
170
171         else {
172             my $error =
173               qq/Couldn't forward to "$class". Does not implement "$method"/;
174             $c->error($error);
175             $c->log->debug($error)
176               if $c->debug;
177             return 0;
178         }
179
180     }
181
182     local $c->request->{arguments} = [ @{$arguments} ];
183
184     for my $result ( @{$results} ) {
185         $c->execute( @{ $result->[0] } );
186         return if scalar @{ $c->error };
187         last unless $c->state;
188     }
189
190     return $c->state;
191 }
192
193 =item $c->get_action( $action, $namespace, $inherit )
194
195 Get an action in a given namespace.
196
197 =cut
198
199 sub get_action {
200     my ( $c, $action, $namespace, $inherit ) = @_;
201     return [] unless $action;
202     $namespace ||= '';
203     $inherit   ||= 0;
204
205     if ($namespace) {
206         $namespace = '' if $namespace eq '/';
207         my $parent = $c->tree;
208         my @results;
209
210         if ($inherit) {
211             my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
212             push @results, [$result] if $result;
213             my $visitor = Tree::Simple::Visitor::FindByPath->new;
214
215             for my $part ( split '/', $namespace ) {
216                 $visitor->setSearchPath($part);
217                 $parent->accept($visitor);
218                 my $child = $visitor->getResult;
219                 my $uid   = $child->getUID if $child;
220                 my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
221                 push @results, [$match] if $match;
222                 $parent = $child if $child;
223             }
224
225         }
226
227         else {
228
229             if ($namespace) {
230                 my $visitor = Tree::Simple::Visitor::FindByPath->new;
231                 $visitor->setSearchPath( split '/', $namespace );
232                 $parent->accept($visitor);
233                 my $child = $visitor->getResult;
234                 my $uid   = $child->getUID if $child;
235                 my $match = $c->actions->{private}->{$uid}->{$action}
236                   if $uid;
237                 push @results, [$match] if $match;
238             }
239
240             else {
241                 my $result =
242                   $c->actions->{private}->{ $parent->getUID }->{$action};
243                 push @results, [$result] if $result;
244             }
245
246         }
247         return \@results;
248     }
249
250     elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
251     elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
252
253     else {
254
255         for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
256             my $name  = $c->actions->{compiled}->[$i]->[0];
257             my $regex = $c->actions->{compiled}->[$i]->[1];
258
259             if ( my @snippets = ( $action =~ $regex ) ) {
260                 return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
261             }
262
263         }
264     }
265     return [];
266 }
267
268 =item $c->set_action( $action, $code, $namespace, $attrs )
269
270 Set an action in a given namespace.
271
272 =cut
273
274 sub set_action {
275     my ( $c, $method, $code, $namespace, $attrs ) = @_;
276
277     my $prefix =
278       Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
279       || '';
280     my %flags;
281
282     for my $attr ( @{$attrs} ) {
283         if    ( $attr =~ /^(Local|Relative)$/ )    { $flags{local}++ }
284         elsif ( $attr =~ /^(Global|Absolute)$/ )   { $flags{global}++ }
285         elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { $flags{path} = $1 }
286         elsif ( $attr =~ /^Private$/i )            { $flags{private}++ }
287         elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
288             $flags{regex} = $2;
289         }
290     }
291
292     if ( $flags{private} && ( keys %flags > 1 ) ) {
293         $c->log->debug( 'Bad action definition "'
294               . join( ' ', @{$attrs} )
295               . qq/" for "$namespace->$method"/ )
296           if $c->debug;
297         return;
298     }
299     return unless keys %flags;
300
301     my $parent  = $c->tree;
302     my $visitor = Tree::Simple::Visitor::FindByPath->new;
303
304     for my $part ( split '/', $prefix ) {
305         $visitor->setSearchPath($part);
306         $parent->accept($visitor);
307         my $child = $visitor->getResult;
308
309         unless ($child) {
310             $child = $parent->addChild( Tree::Simple->new($part) );
311             $visitor->setSearchPath($part);
312             $parent->accept($visitor);
313             $child = $visitor->getResult;
314         }
315
316         $parent = $child;
317     }
318
319     my $uid = $parent->getUID;
320     $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
321     my $forward = $prefix ? "$prefix/$method" : $method;
322
323     if ( $flags{path} ) {
324         $flags{path} =~ s/^\w+//;
325         $flags{path} =~ s/\w+$//;
326         if ( $flags{path} =~ /^\s*'(.*)'\s*$/ ) { $flags{path} = $1 }
327         if ( $flags{path} =~ /^\s*"(.*)"\s*$/ ) { $flags{path} = $1 }
328     }
329
330     if ( $flags{regex} ) {
331         $flags{regex} =~ s/^\w+//;
332         $flags{regex} =~ s/\w+$//;
333         if ( $flags{regex} =~ /^\s*'(.*)'\s*$/ ) { $flags{regex} = $1 }
334         if ( $flags{regex} =~ /^\s*"(.*)"\s*$/ ) { $flags{regex} = $1 }
335     }
336
337     my $reverse = $prefix ? "$prefix/$method" : $method;
338
339     if ( $flags{local} || $flags{global} || $flags{path} ) {
340         my $path     = $flags{path} || $method;
341         my $absolute = 0;
342
343         if ( $path =~ /^\/(.+)/ ) {
344             $path     = $1;
345             $absolute = 1;
346         }
347
348         $absolute = 1 if $flags{global};
349         my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
350         $c->actions->{plain}->{$name} = [ $namespace, $code ];
351     }
352
353     if ( my $regex = $flags{regex} ) {
354         push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
355         $c->actions->{regex}->{$regex} = [ $namespace, $code ];
356     }
357
358     $c->actions->{reverse}->{"$code"} = $reverse;
359 }
360
361 =item $class->setup_actions($component)
362
363 Setup actions for a component.
364
365 =cut
366
367 sub setup_actions {
368     my $self = shift;
369
370     # These are the core structures
371     $self->actions(
372         {
373             plain    => {},
374             private  => {},
375             regex    => {},
376             compiled => [],
377             reverse  => {}
378         }
379     );
380
381     # We use a tree
382     $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
383
384     for my $comp ( keys %{ $self->components } ) {
385
386         # We only setup components that inherit from Catalyst::Base
387         next unless $comp->isa('Catalyst::Base');
388
389         for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
390             my ( $code, $attrs ) = @{$action};
391             my $name = '';
392             no strict 'refs';
393             my @cache = ( $comp, @{"$comp\::ISA"} );
394             my %namespaces;
395
396             while ( my $namespace = shift @cache ) {
397                 $namespaces{$namespace}++;
398                 for my $isa ( @{"$comp\::ISA"} ) {
399                     next if $namespaces{$isa};
400                     push @cache, $isa;
401                     $namespaces{$isa}++;
402                 }
403             }
404
405             for my $namespace ( keys %namespaces ) {
406
407                 for my $sym ( values %{ $namespace . '::' } ) {
408
409                     if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
410
411                         $name = *{$sym}{NAME};
412                         $self->set_action( $name, $code, $comp, $attrs );
413                         last;
414                     }
415
416                 }
417
418             }
419
420         }
421
422     }
423
424     return unless $self->debug;
425
426     my $actions  = $self->actions;
427     my $privates = Text::ASCIITable->new;
428     $privates->setCols( 'Private', 'Class' );
429     $privates->setColWidth( 'Private', 36, 1 );
430     $privates->setColWidth( 'Class',   37, 1 );
431
432     my $walker = sub {
433         my ( $walker, $parent, $prefix ) = @_;
434         $prefix .= $parent->getNodeValue || '';
435         $prefix .= '/' unless $prefix =~ /\/$/;
436         my $uid = $parent->getUID;
437
438         for my $action ( keys %{ $actions->{private}->{$uid} } ) {
439             my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
440             $privates->addRow( "$prefix$action", $class );
441         }
442
443         $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
444     };
445
446     $walker->( $walker, $self->tree, '' );
447     $self->log->debug( "Loaded private actions:\n" . $privates->draw )
448       if ( @{ $privates->{tbl_rows} } );
449
450     my $publics = Text::ASCIITable->new;
451     $publics->setCols( 'Public', 'Private' );
452     $publics->setColWidth( 'Public',  36, 1 );
453     $publics->setColWidth( 'Private', 37, 1 );
454
455     for my $plain ( sort keys %{ $actions->{plain} } ) {
456         my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
457         my $reverse = $self->actions->{reverse}->{$code};
458         $reverse = $reverse ? "/$reverse" : $code;
459         $publics->addRow( "/$plain", $reverse );
460     }
461
462     $self->log->debug( "Loaded public actions:\n" . $publics->draw )
463       if ( @{ $publics->{tbl_rows} } );
464
465     my $regexes = Text::ASCIITable->new;
466     $regexes->setCols( 'Regex', 'Private' );
467     $regexes->setColWidth( 'Regex',   36, 1 );
468     $regexes->setColWidth( 'Private', 37, 1 );
469
470     for my $regex ( sort keys %{ $actions->{regex} } ) {
471         my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
472         my $reverse = $self->actions->{reverse}->{$code};
473         $reverse = $reverse ? "/$reverse" : $code;
474         $regexes->addRow( $regex, $reverse );
475     }
476
477     $self->log->debug( "Loaded regex actions:\n" . $regexes->draw )
478       if ( @{ $regexes->{tbl_rows} } );
479 }
480
481 =back
482
483 =head1 AUTHOR
484
485 Sebastian Riedel, C<sri@cpan.org>
486
487 =head1 COPYRIGHT
488
489 This program is free software, you can redistribute it and/or modify it under
490 the same terms as Perl itself.
491
492 =cut
493
494 1;