The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

ABELTJE / Dancer-Plugin-RPC-1.11 / lib / Dancer / RPCPlugin / DefaultRoute.pm 

            

              
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
155
156
157
158
159
—
160
161
162
163
164
165

              
package Dancer::RPCPlugin::DefaultRoute;
use Dancer ':syntax';
use Dancer::RPCPlugin::ErrorResponse;
use RPC::XML;
use RPC::XML::ParserFactory;
use Exporter 'import';
our @EXPORT = qw(setup_default_route);
my $parser = RPC::XML::ParserFactory->new();
=head1 NAME
Dancer::RPCPlugin::DefaultRoute - Catch bad-requests and send error-response
=head1 SYNOPSIS
    use Dancer::RPCPlugin::DefaultRoute;
    setup_default_route();
=head1 DESCRIPTION
Implements default endpoint to generate -32601 'method not found'
or 'path not found' error_response for non existing endpoints
=head2 setup_default_route
Installs a Dancer route-handler for C<< any qr{.+} >> which tries to return an
appropriate error response to the requestor.
=head3 Responses
All responeses will have B<status: 200 OK>
The B<content-type> (and B<body>) of the request determine the error-response:
=over
=item B<text/xml>
If the B<body> is valid XMLRPC, the response is an XMLRPC-fault:
    faultCode   => -32601
    faultString => "Method '%s' not found"
If the B<body> is I<not> valid XMLRPC, the response is an XMLRPC-fault:
    faultCode   => -32600
    faultString => "Invaild xml-rpc. Not configming to spec: $@"
=item B<application/json>
If the B<body> is valid JSONRPC (ie. is has a I<'jsonrpc': '2.0'> field/value),
the response is a JSONRPC-error:
    code => -32601
    message => "Method '%s' not found"
If the B<body> is I<not> valid JSONRPC, the response is a generic json struct:
    'error': {
        'code':  -32601,
        'message': "Method '$request->path' not found"
    }
=item B<other/content-type>
Any other content-type is outside the scope of the service. We can respond in
any way we like. For the moment it will be:
    status(404)
    content_type('text/plain')
    body => "Error! '$request->path' was not found for '$request->content_type'"
=back
=cut
sub setup_default_route {
    any qr{.+} => sub {
        my $content_type = request->content_type =~ m{(?<ct> [\w-]+ / [\w-]+ )}x
            ? $+{ct}
            : 'text/plain';
        my ($error_code, $error_message);
        if ( $content_type =~ m{^ (application|text) / xml $}x ) {
            content_type('text/xml'); # Always respond as XMLRPC
            my $request = eval { $parser->parse(request->body) };
            if ( my $error = $@ ) { # Invalid request
                $error_code = -32600;
                $error_message = "Invalid xml-rpc. Not conforming to spec: $error"
            }
            else {
                $error_code = -32601;
                $error_message = sprintf("Method '%s' not found", $request->name);
            }
            halt(
                RPC::XML::response->new(
                    RPC::XML::fault->new(
                        faultCode   => $error_code,
                        faultString => $error_message,
                    )
                )->as_string()
            );
        }
        elsif ( $content_type eq 'application/json' ) {
            content_type('application/json');
            my $request = request->body
                ? from_json(request->body, {allow_nonref => 1})
                : undef;
            if (    defined($request) and ref($request) eq 'HASH'
                and (exists $request->{jsonrpc} && $request->{jsonrpc} eq '2.0') )
            {
                $error_code = -32601;
                $error_message = sprintf("Method '%s' not found",  $request->{method});
                halt(
                    to_json(
                        {
                            jsonrpc => '2.0',
                            id      => $request->{id},
                            error   => {
                                code    => $error_code,
                                message => $error_message,
                            },
                        }
                    )
                );
            }
            else {
                halt(
                    to_json(
                        {
                            error => {
                                code    => -32601,
                                message => sprintf("Method '%s' not found", request->path)
                            }
                        }
                    )
                );
            }
        }
        status(404);
        content_type('text/plain');
        halt(
            sprintf(
                "Error! '%s' was not found for '%s'",
                request->path, request->content_type
            )
        );
    };
}
1;
=head1 COPYRIGHT
(c) MMXX - Abe Timmerman <abetim@cpan.org>
=cut