1 package Catalyst::ActionRole::HTTPMethods;
5 requires 'match', 'match_captures', 'list_extra_info';
7 around ['match','match_captures'], sub {
8 my ($orig, $self, $ctx, @args) = @_;
9 my $expected = $self->_normalize_expected_http_method($ctx->req);
10 return $self->_has_expected_http_method($expected) ?
11 $self->$orig($ctx, @args) :
15 sub _normalize_expected_http_method {
16 my ($self, $req) = @_;
17 return $req->header('X-HTTP-Method') ||
18 $req->header('X-HTTP-Method-Override') ||
19 $req->header('X-METHOD-OVERRIDE') ||
23 sub _has_expected_http_method {
24 my ($self, $expected) = @_;
25 return 1 unless scalar(my @allowed = $self->allowed_http_methods);
26 return scalar(grep { lc($_) eq lc($expected) } @allowed) ?
30 sub allowed_http_methods { @{shift->attributes->{Method}||[]} }
32 around 'list_extra_info', sub {
33 my ($orig, $self, @args) = @_;
35 %{ $self->$orig(@args) },
36 +{ HTTP_METHODS => [sort $self->allowed_http_methods] }
44 Catalyst::ActionRole::HTTPMethods - Match on HTTP Methods
48 package MyApp::Web::Controller::MyController;
51 use MooseX::MethodAttributes;
53 extends 'Catalyst::Controller';
55 sub user_base : Chained('/') CaptureArg(0) { ... }
57 sub get_user : Chained('user_base') Args(1) GET { ... }
58 sub post_user : Chained('user_base') Args(1) POST { ... }
59 sub put_user : Chained('user_base') Args(1) PUT { ... }
60 sub delete_user : Chained('user_base') Args(1) DELETE { ... }
61 sub head_user : Chained('user_base') Args(1) HEAD { ... }
62 sub option_user : Chained('user_base') Args(1) OPTION { ... }
63 sub option_user : Chained('user_base') Args(1) PATCH { ... }
66 sub post_and_put : Chained('user_base') POST PUT Args(1) { ... }
67 sub method_attr : Chained('user_base') Method('DELETE') Args(0) { ... }
69 __PACKAGE__->meta->make_immutable;
73 This is an action role that lets your L<Catalyst::Action> match on standard
74 HTTP methods, such as GET, POST, etc.
76 Since most web browsers have limited support for rich HTTP Method vocabularies
77 we also support setting the expected match method via the follow non standard
78 but widely used http extensions. Our support for these should not be taken as
79 an endorsement of the technique. Rt is merely a reflection of our desire to
80 work well with existing systems and common client side tools.
84 =item X-HTTP-Method (Microsoft)
86 =item X-HTTP-Method-Override (Google/GData)
88 =item X-METHOD-OVERRIDE (IBM)
92 Please note the insanity of overriding a GET request with a DELETE override...
93 Rational practices suggest that using POST with overrides to emulate PUT and
94 DELETE can be an acceptable way to deal with client limitations and security
95 rules on your proxy server. I recommend going no further.
99 This role requires the following methods in the consuming class.
103 =head2 match_captures
105 Returns 1 if the action matches the existing request and zero if not.
109 This role defines the following methods
113 =head2 match_captures
115 Around method modifier that return 1 if the request method matches one of the
116 allowed methods (see L</http_methods>) and zero otherwise.
118 =head2 allowed_http_methods
120 An array of strings that are the allowed http methods for matching this action
121 normalized as noted above (using X-Method* overrides).
123 =head2 list_extra_info
125 Adds a key => [@values] "HTTP_METHODS" whose value is an ArrayRef of sorted
126 allowed methods to the ->list_extra_info HashRef. This is used primarily for
129 =head2 _has_expected_http_method ($expected)
131 Private method which returns 1 if C<$expected> matches one of the allowed
132 in L</http_methods> and zero otherwise.
136 Catalyst Contributors, see Catalyst.pm
140 This library is free software. You can redistribute it and/or modify it under
141 the same terms as Perl itself.