22d4b4a1bd
Patch by Max Kanat-Alexander <mkanat@bugzilla.org> r=dkl, a=mkanat git-svn-id: svn://10.0.0.236/trunk@256768 18797224-902f-48f8-a5cc-f745e15eee43
223 lines
7.3 KiB
Perl
223 lines
7.3 KiB
Perl
# -*- Mode: perl; indent-tabs-mode: nil -*-
|
|
#
|
|
# The contents of this file are subject to the Mozilla Public
|
|
# License Version 1.1 (the "License"); you may not use this file
|
|
# except in compliance with the License. You may obtain a copy of
|
|
# the License at http://www.mozilla.org/MPL/
|
|
#
|
|
# Software distributed under the License is distributed on an "AS
|
|
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
# implied. See the License for the specific language governing
|
|
# rights and limitations under the License.
|
|
#
|
|
# The Original Code is the Bugzilla Bug Tracking System.
|
|
#
|
|
# Contributor(s): Marc Schumann <wurblzap@gmail.com>
|
|
# Max Kanat-Alexander <mkanat@bugzilla.org>
|
|
|
|
package Bugzilla::WebService::Server::XMLRPC;
|
|
|
|
use strict;
|
|
use XMLRPC::Transport::HTTP;
|
|
use Bugzilla::WebService::Server;
|
|
our @ISA = qw(XMLRPC::Transport::HTTP::CGI Bugzilla::WebService::Server);
|
|
|
|
use Bugzilla::WebService::Constants;
|
|
|
|
sub initialize {
|
|
my $self = shift;
|
|
my %retval = $self->SUPER::initialize(@_);
|
|
$retval{'serializer'} = Bugzilla::XMLRPC::Serializer->new;
|
|
$retval{'deserializer'} = Bugzilla::XMLRPC::Deserializer->new;
|
|
$retval{'dispatch_with'} = WS_DISPATCH;
|
|
return %retval;
|
|
}
|
|
|
|
sub make_response {
|
|
my $self = shift;
|
|
|
|
$self->SUPER::make_response(@_);
|
|
|
|
# XMLRPC::Transport::HTTP::CGI doesn't know about Bugzilla carrying around
|
|
# its cookies in Bugzilla::CGI, so we need to copy them over.
|
|
foreach (@{Bugzilla->cgi->{'Bugzilla_cookie_list'}}) {
|
|
$self->response->headers->push_header('Set-Cookie', $_);
|
|
}
|
|
}
|
|
|
|
sub datetime_format {
|
|
my ($self, $date_string) = @_;
|
|
|
|
my $time = str2time($date_string);
|
|
my ($sec, $min, $hour, $mday, $mon, $year) = localtime $time;
|
|
# This format string was stolen from SOAP::Utils->format_datetime,
|
|
# which doesn't work but which has almost the right format string.
|
|
my $iso_datetime = sprintf('%d%02d%02dT%02d:%02d:%02d',
|
|
$year + 1900, $mon + 1, $mday, $hour, $min, $sec);
|
|
return $iso_datetime;
|
|
}
|
|
|
|
sub handle_login {
|
|
my ($self, $classes, $action, $uri, $method) = @_;
|
|
my $class = $classes->{$uri};
|
|
my $full_method = $uri . "." . $method;
|
|
$self->SUPER::handle_login($class, $method, $full_method);
|
|
return;
|
|
}
|
|
|
|
1;
|
|
|
|
# This exists to validate input parameters (which XMLRPC::Lite doesn't do)
|
|
# and also, in some cases, to more-usefully decode them.
|
|
package Bugzilla::XMLRPC::Deserializer;
|
|
use strict;
|
|
# We can't use "use base" because XMLRPC::Serializer doesn't return
|
|
# a true value.
|
|
eval { require XMLRPC::Lite; };
|
|
our @ISA = qw(XMLRPC::Deserializer);
|
|
|
|
use Bugzilla::Error;
|
|
|
|
# Some method arguments need to be converted in some way, when they are input.
|
|
sub decode_value {
|
|
my $self = shift;
|
|
my ($type) = @{ $_[0] };
|
|
my $value = $self->SUPER::decode_value(@_);
|
|
|
|
# We only validate/convert certain types here.
|
|
return $value if $type !~ /^(?:int|i4|boolean|double|dateTime\.iso8601)$/;
|
|
|
|
# Though the XML-RPC standard doesn't allow an empty <int>,
|
|
# <double>,or <dateTime.iso8601>, we do, and we just say
|
|
# "that's undef".
|
|
if (grep($type eq $_, qw(int double dateTime))) {
|
|
return undef if $value eq '';
|
|
}
|
|
|
|
my $validator = $self->_validation_subs->{$type};
|
|
if (!$validator->($value)) {
|
|
ThrowUserError('xmlrpc_invalid_value',
|
|
{ type => $type, value => $value });
|
|
}
|
|
|
|
# We convert dateTimes to a DB-friendly date format.
|
|
if ($type eq 'dateTime.iso8601') {
|
|
# We leave off the $ from the end of this regex to allow for possible
|
|
# extensions to the XML-RPC date standard.
|
|
$value =~ /^(\d{4})(\d{2})(\d{2})T(\d{2}):(\d{2}):(\d{2})/;
|
|
$value = "$1-$2-$3 $4:$5:$6";
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
sub _validation_subs {
|
|
my $self = shift;
|
|
return $self->{_validation_subs} if $self->{_validation_subs};
|
|
# The only place that XMLRPC::Lite stores any sort of validation
|
|
# regex is in XMLRPC::Serializer. We want to re-use those regexes here.
|
|
my $lookup = Bugzilla::XMLRPC::Serializer->new->typelookup;
|
|
|
|
# $lookup is a hash whose values are arrayrefs, and whose keys are the
|
|
# names of types. The second item of each arrayref is a subroutine
|
|
# that will do our validation for us.
|
|
my %validators = map { $_ => $lookup->{$_}->[1] } (keys %$lookup);
|
|
# Add a boolean validator
|
|
$validators{'boolean'} = sub {$_[0] =~ /^[01]$/};
|
|
# Some types have multiple names, or have a different name in
|
|
# XMLRPC::Serializer than their standard XML-RPC name.
|
|
$validators{'dateTime.iso8601'} = $validators{'dateTime'};
|
|
$validators{'i4'} = $validators{'int'};
|
|
|
|
$self->{_validation_subs} = \%validators;
|
|
return \%validators;
|
|
}
|
|
|
|
1;
|
|
|
|
# This package exists to fix a UTF-8 bug in SOAP::Lite.
|
|
# See http://rt.cpan.org/Public/Bug/Display.html?id=32952.
|
|
package Bugzilla::XMLRPC::Serializer;
|
|
use strict;
|
|
# We can't use "use base" because XMLRPC::Serializer doesn't return
|
|
# a true value.
|
|
eval { require XMLRPC::Lite; };
|
|
our @ISA = qw(XMLRPC::Serializer);
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
my $self = $class->SUPER::new(@_);
|
|
# This fixes UTF-8.
|
|
$self->{'_typelookup'}->{'base64'} =
|
|
[10, sub { !utf8::is_utf8($_[0]) && $_[0] =~ /[^\x09\x0a\x0d\x20-\x7f]/},
|
|
'as_base64'];
|
|
# This makes arrays work right even though we're a subclass.
|
|
# (See http://rt.cpan.org//Ticket/Display.html?id=34514)
|
|
$self->{'_encodingStyle'} = '';
|
|
return $self;
|
|
}
|
|
|
|
sub as_string {
|
|
my $self = shift;
|
|
my ($value) = @_;
|
|
# Something weird happens with XML::Parser when we have upper-ASCII
|
|
# characters encoded as UTF-8, and this fixes it.
|
|
utf8::encode($value) if utf8::is_utf8($value)
|
|
&& $value =~ /^[\x00-\xff]+$/;
|
|
return $self->SUPER::as_string($value);
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
Bugzilla::WebService::Server::XMLRPC - The XML-RPC Interface to Bugzilla
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This documentation describes things about the Bugzilla WebService that
|
|
are specific to XML-RPC. For a general overview of the Bugzilla WebServices,
|
|
see L<Bugzilla::WebService>.
|
|
|
|
=head1 XML-RPC
|
|
|
|
The XML-RPC standard is described here: L<http://www.xmlrpc.com/spec>
|
|
|
|
=head1 CONNECTING
|
|
|
|
The endpoint for the XML-RPC interface is the C<xmlrpc.cgi> script in
|
|
your Bugzilla installation. For example, if your Bugzilla is at
|
|
C<bugzilla.yourdomain.com>, then your XML-RPC client would access the
|
|
API via: C<http://bugzilla.yourdomain.com/xmlrpc.cgi>
|
|
|
|
=head1 PARAMETERS
|
|
|
|
C<dateTime> fields are the standard C<dateTime.iso8601> XML-RPC field. They
|
|
should be in C<YYYY-MM-DDTHH:MM:SS> format (where C<T> is a literal T).
|
|
|
|
All other fields are standard XML-RPC types.
|
|
|
|
=head2 How XML-RPC WebService Methods Take Parameters
|
|
|
|
All functions take a single argument, a C<< <struct> >> that contains all parameters.
|
|
The names of the parameters listed in the API docs for each function are the
|
|
C<< <name> >> element for the struct C<< <member> >>s.
|
|
|
|
=head1 EXTENSIONS TO THE XML-RPC STANDARD
|
|
|
|
=head2 Undefined Values
|
|
|
|
Normally, XML-RPC does not allow empty values for C<int>, C<double>, or
|
|
C<dateTime.iso8601> fields. Bugzilla does--it treats empty values as
|
|
C<undef> (called C<NULL> or C<None> in some programming languages).
|
|
|
|
Bugzilla also accepts a type called C<< <nil> >>, which is always considered
|
|
to be C<undef>, no matter what it contains.
|
|
|
|
=begin private
|
|
|
|
nil is implemented by XMLRPC::Lite, in XMLRPC::Deserializer::decode_value.
|
|
|
|
=end private |