Commit | Line | Data |
6b239949 |
1 | package Catalyst::DispatchType::Path; |
2 | |
3c0186f2 |
3 | use Moose; |
3c0186f2 |
4 | extends 'Catalyst::DispatchType'; |
5 | |
e8b9f2a9 |
6 | use Text::SimpleTable; |
39fc2ce1 |
7 | use Catalyst::Utils; |
e8b9f2a9 |
8 | use URI; |
3c0186f2 |
9 | |
36dbb986 |
10 | has _paths => ( |
11 | is => 'rw', |
12 | isa => 'HashRef', |
13 | required => 1, |
14 | default => sub { +{} }, |
15 | ); |
16 | |
0fc2d522 |
17 | no Moose; |
18 | |
2633d7dc |
19 | =head1 NAME |
20 | |
21 | Catalyst::DispatchType::Path - Path DispatchType |
22 | |
23 | =head1 SYNOPSIS |
24 | |
26dc649a |
25 | See L<Catalyst::DispatchType>. |
2633d7dc |
26 | |
27 | =head1 DESCRIPTION |
28 | |
26dc649a |
29 | Dispatch type managing full path matching behaviour. For more information on |
30 | dispatch types, see: |
31 | |
32 | =over 4 |
33 | |
b9b89145 |
34 | =item * L<Catalyst::Manual::Intro> for how they affect application authors |
26dc649a |
35 | |
36 | =item * L<Catalyst::DispatchType> for implementation information. |
37 | |
38 | =back |
39 | |
2633d7dc |
40 | =head1 METHODS |
41 | |
b5ecfcf0 |
42 | =head2 $self->list($c) |
a9cbd748 |
43 | |
4ab87e27 |
44 | Debug output for Path dispatch points |
45 | |
a9cbd748 |
46 | =cut |
47 | |
48 | sub list { |
49 | my ( $self, $c ) = @_; |
39fc2ce1 |
50 | my $column_width = Catalyst::Utils::term_width() - 35 - 9; |
51 | my $paths = Text::SimpleTable->new( |
52 | [ 35, 'Path' ], [ $column_width, 'Private' ] |
53 | ); |
36dbb986 |
54 | foreach my $path ( sort keys %{ $self->_paths } ) { |
c5b74a51 |
55 | my $display_path = $path eq '/' ? $path : "/$path"; |
36dbb986 |
56 | foreach my $action ( @{ $self->_paths->{$path} } ) { |
e8b9f2a9 |
57 | $paths->row( $display_path, "/$action" ); |
0bd5f8a2 |
58 | } |
a9cbd748 |
59 | } |
e8b9f2a9 |
60 | $c->log->debug( "Loaded Path actions:\n" . $paths->draw . "\n" ) |
36dbb986 |
61 | if ( keys %{ $self->_paths } ); |
a9cbd748 |
62 | } |
63 | |
b5ecfcf0 |
64 | =head2 $self->match( $c, $path ) |
2633d7dc |
65 | |
b2b90ec2 |
66 | For each action registered to this exact path, offers the action a chance to |
67 | match the path (in the order in which they were registered). Succeeds on the |
68 | first action that matches, if any; if not, returns 0. |
4ab87e27 |
69 | |
2633d7dc |
70 | =cut |
71 | |
72 | sub match { |
73 | my ( $self, $c, $path ) = @_; |
6b239949 |
74 | |
2f381252 |
75 | $path = '/' if !defined $path || !length $path; |
0bd5f8a2 |
76 | |
36dbb986 |
77 | foreach my $action ( @{ $self->_paths->{$path} || [] } ) { |
0bd5f8a2 |
78 | next unless $action->match($c); |
6b239949 |
79 | $c->req->action($path); |
80 | $c->req->match($path); |
81 | $c->action($action); |
11bd4e3e |
82 | $c->namespace( $action->namespace ); |
6b239949 |
83 | return 1; |
84 | } |
85 | |
86 | return 0; |
87 | } |
88 | |
b5ecfcf0 |
89 | =head2 $self->register( $c, $action ) |
2633d7dc |
90 | |
b2b90ec2 |
91 | Calls register_path for every Path attribute for the given $action. |
4ab87e27 |
92 | |
2633d7dc |
93 | =cut |
94 | |
95 | sub register { |
6b239949 |
96 | my ( $self, $c, $action ) = @_; |
22f3a8dd |
97 | |
27708fc5 |
98 | my @register = @{ $action->attributes->{Path} || [] }; |
6b239949 |
99 | |
694d15f1 |
100 | $self->register_path( $c, $_, $action ) for @register; |
5b707014 |
101 | |
694d15f1 |
102 | return 1 if @register; |
103 | return 0; |
081def36 |
104 | } |
105 | |
b5ecfcf0 |
106 | =head2 $self->register_path($c, $path, $action) |
081def36 |
107 | |
b2b90ec2 |
108 | Registers an action at a given path. |
4ab87e27 |
109 | |
081def36 |
110 | =cut |
111 | |
112 | sub register_path { |
694d15f1 |
113 | my ( $self, $c, $path, $action ) = @_; |
081def36 |
114 | $path =~ s!^/!!; |
0ba80bce |
115 | $path = '/' unless length $path; |
595f3872 |
116 | $path = URI->new($path)->canonical; |
27708fc5 |
117 | |
36dbb986 |
118 | unshift( @{ $self->_paths->{$path} ||= [] }, $action); |
0bd5f8a2 |
119 | |
120 | return 1; |
6b239949 |
121 | } |
122 | |
ea0e58d9 |
123 | =head2 $self->uri_for_action($action, $captures) |
124 | |
125 | get a URI part for an action; always returns undef is $captures is set |
126 | since Path actions don't have captures |
127 | |
128 | =cut |
129 | |
130 | sub uri_for_action { |
131 | my ( $self, $action, $captures ) = @_; |
132 | |
133 | return undef if @$captures; |
134 | |
135 | if (my $paths = $action->attributes->{Path}) { |
136 | my $path = $paths->[0]; |
137 | $path = '/' unless length($path); |
138 | $path = "/${path}" unless ($path =~ m/^\//); |
139 | $path = URI->new($path)->canonical; |
140 | return $path; |
141 | } else { |
142 | return undef; |
143 | } |
144 | } |
145 | |
2f381252 |
146 | =head1 AUTHORS |
2633d7dc |
147 | |
2f381252 |
148 | Catalyst Contributors, see Catalyst.pm |
2633d7dc |
149 | |
150 | =head1 COPYRIGHT |
151 | |
152 | This program is free software, you can redistribute it and/or modify it under |
153 | the same terms as Perl itself. |
154 | |
155 | =cut |
156 | |
e5ecd5bc |
157 | __PACKAGE__->meta->make_immutable; |
158 | |
6b239949 |
159 | 1; |