summaryrefslogtreecommitdiffstats
path: root/xt/lib/QA/RPC/JSONRPC.pm
blob: ce312286996697570ced4484c15ce60e7fd8320a (plain)
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
166
167
168
169
170
171
172
173
174
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

# -*- Mode: perl; indent-tabs-mode: nil -*-

package QA::RPC::JSONRPC;

use 5.14.0;
use strict;
use warnings;

use FindBin qw($RealBin);
use lib "$RealBin/../../../lib", "$RealBin/../../../../local/lib/perl5";

use QA::RPC;
BEGIN {
    our @ISA = qw(QA::RPC);

    if (eval { require JSON::RPC::Client }) {
        push(@ISA, 'JSON::RPC::Client');
    }
    else {
        require JSON::RPC::Legacy::Client;
        push(@ISA, 'JSON::RPC::Legacy::Client');
    }
}

use URI::Escape;

use constant DATETIME_REGEX => qr/^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ$/;
sub TYPE {
    my ($self) = @_;
    return $self->bz_get_mode ? 'JSON-RPC GET' : 'JSON-RPC';
}

#################################
# Consistency with XMLRPC::Lite #
#################################

sub ua {
    my $self = shift;
    if ($self->{ua} and not $self->{ua}->isa('QA::RPC::UserAgent')) {
        bless $self->{ua}, 'QA::RPC::UserAgent';
    }
    return $self->SUPER::ua(@_);
}
sub transport { $_[0]->ua }

sub bz_get_mode {
    my ($self, $value) = @_;
    $self->{bz_get_mode} = $value if @_ > 1;
    return $self->{bz_get_mode};
}

sub _bz_callback {
    my ($self, $value) = @_;
    $self->{bz_callback} = $value if @_ > 1;
    return $self->{bz_callback};
}

sub call {
    my $self = shift;
    my ($method, $args) = @_;
    my %params = ( method => $method );
    $params{params} = $args ? [$args] : [];

    my $config = $self->bz_config;
    my $url = $config->{browser_url} . "/"
              . $config->{bugzilla_installation} . "/jsonrpc.cgi";
    my $result;
    if ($self->bz_get_mode) {
        my $method_escaped = uri_escape($method);
        $url .= "?method=$method_escaped";
        if (my $cred = $self->_bz_credentials) {
            $args->{Bugzilla_login} = $cred->{user}
                if !exists $args->{Bugzilla_login};
            $args->{Bugzilla_password} = $cred->{pass}
                if !exists $args->{Bugzilla_password};
        }
        if ($args) {
            my $params_json = $self->json->encode($args);
            my $params_escaped = uri_escape($params_json);
            $url .= "&params=$params_escaped";
        }
        if ($self->version eq '1.1') {
            $url .= "&version=1.1";
        }
        my $callback = delete $args->{callback};
        if (defined $callback) {
            $self->_bz_callback($callback);
            $url .= "&callback=" . uri_escape($callback);
        }
        $result = $self->SUPER::call($url);
    }
    else {
        $result = $self->SUPER::call($url, \%params);
    }

    if ($result) {
        bless $result, 'QA::RPC::JSONRPC::ReturnObject';
    }
    return $result;
}

sub _get {
    my $self = shift;
    my $result = $self->SUPER::_get(@_);
    # Simple JSONP support for tests. We just remove the callback from
    # the return value.
    my $callback = $self->_bz_callback;
    if (defined $callback and $result->is_success) {
        my $content = $result->content;
        $content =~ s/^(?:\/\*\*\/)?\Q$callback(\E(.*)\)$/$1/s;
        $result->content($content);
        # We don't need this anymore, and we don't want it to affect
        # future calls.
        delete $self->{bz_callback};
    }
    return $result;
}

1;

package QA::RPC::JSONRPC::ReturnObject;
use strict;

BEGIN {
    if (eval { require JSON::RPC::Client }) {
        our @ISA = qw(JSON::RPC::ReturnObject);
    }
    else {
        require JSON::RPC::Legacy::Client;
        our @ISA = qw(JSON::RPC::Legacy::ReturnObject);
    }
}

#################################
# Consistency with XMLRPC::Lite #
#################################

sub faultstring { $_[0]->{content}->{error}->{message} }
sub faultcode   { $_[0]->{content}->{error}->{code}    }
sub fault { $_[0]->is_error }

1;

package QA::RPC::UserAgent;
use strict;
use base qw(LWP::UserAgent);

########################################
# Consistency with XMLRPC::Lite's ->ua #
########################################

sub send_request {
    my $self = shift;
    my $response = $self->SUPER::send_request(@_);
    $self->http_response($response);
    # JSON::RPC::Client can't handle 500 responses, even though
    # they're required by the JSON-RPC spec.
    $response->code(200);
    return $response;
}

# Copied directly from SOAP::Lite::Transport::HTTP.
sub http_response {
    my $self = shift;
    if (@_) { $self->{'_http_response'} = shift; return $self }
    return $self->{'_http_response'};
}