1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
package Dancer2::Plugin::Ajax;
# ABSTRACT: a plugin for adding Ajax route handlers
$Dancer2::Plugin::Ajax::VERSION = '0.400000';
use strict;
use warnings;
use Dancer2::Core::Types 'Str';
use Dancer2::Plugin;
has content_type => (
is => 'ro',
isa => Str,
from_config => sub { 'text/xml' },
);
plugin_keywords 'ajax';
sub ajax {
my ( $plugin, $pattern, @rest ) = @_;
my @default_methods = ( 'get', 'post' );
# If the given pattern is an ArrayRef, we override the default methods
if( ref($pattern) eq "ARRAY" ) {
@default_methods = @$pattern;
$pattern = shift(@rest);
}
my $code;
for my $e (@rest) { $code = $e if ( ref($e) eq 'CODE' ) }
my $ajax_route = sub {
# # must be an XMLHttpRequest
if ( not $plugin->app->request->is_ajax ) {
$plugin->app->pass;
}
# Default response content type is either what's defined in the
# plugin setting or text/xml
$plugin->app->response->header('Content-Type')
or $plugin->app->response->content_type( $plugin->content_type );
# disable layout
my $layout = $plugin->app->config->{'layout'};
$plugin->app->config->{'layout'} = undef;
my $response = $code->(@_);
$plugin->app->config->{'layout'} = $layout;
return $response;
};
foreach my $method ( @default_methods ) {
$plugin->app->add_route(
method => $method,
regexp => $pattern,
code => $ajax_route,
);
}
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Plugin::Ajax - a plugin for adding Ajax route handlers
=head1 VERSION
version 0.400000
=head1 SYNOPSIS
package MyWebApp;
use Dancer2;
use Dancer2::Plugin::Ajax;
# For GET / POST
ajax '/check_for_update' => sub {
my $self = shift;
# ... some Ajax code
};
# For all valid HTTP methods
ajax ['get', 'post', ... ] => '/check_for_more' => sub {
my $self = shift;
# ... some Ajax code
};
dance;
=head1 DESCRIPTION
The C<ajax> keyword which is exported by this plugin allows you to define a route
handler optimized for Ajax queries.
The route handler code will be compiled to behave like the following:
=over 4
=item *
Pass if the request header X-Requested-With doesn't equal XMLHttpRequest
=item *
Disable the layout
=item *
The action built matches POST / GET requests by default. This can be extended by passing it an ArrayRef of allowed HTTP methods.
=back
The route handler gets the Dancer C<$self> object passed in, just like any other Dancer2 route handler.
You can use this to inspect the request data.
ajax '/check_for_update' => sub {
my $self = shift;
my $method = $self->app->request->method;
# ...
}
=head1 CONFIGURATION
By default the plugin will use a content-type of 'text/xml', but this can be overridden
with the plugin setting C<content_type>.
Here is an example to use JSON:
plugins:
Ajax:
content_type: 'application/json'
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
