mkanat%bugzilla.org 92c3d45dd6 Bug 396245: Allow the WebService to list the installed plugins and their versions
Patch By Max Kanat-Alexander <mkanat@bugzilla.org> r=ghendricks, a=mkanat


git-svn-id: svn://10.0.0.236/trunk@237898 18797224-902f-48f8-a5cc-f745e15eee43
2007-10-19 08:07:30 +00:00

125 lines
2.7 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>
# Mads Bondo Dydensborg <mbd@dbc.dk>
package Bugzilla::WebService::Bugzilla;
use strict;
use base qw(Bugzilla::WebService);
use Bugzilla::Constants;
use Bugzilla::Hook;
import SOAP::Data qw(type);
use Time::Zone;
sub version {
return { version => type('string')->value(BUGZILLA_VERSION) };
}
sub plugins {
my $plugins = Bugzilla::Hook::enabled_plugins();
foreach my $name (keys %$plugins) {
$plugins->{$name} = type('string')->value($plugins->{$name});
}
return { plugins => $plugins };
}
sub timezone {
my $offset = tz_offset();
$offset = (($offset / 60) / 60) * 100;
$offset = sprintf('%+05d', $offset);
return { timezone => type('string')->value($offset) };
}
1;
__END__
=head1 NAME
Bugzilla::WebService::Bugzilla - Global functions for the webservice interface.
=head1 DESCRIPTION
This provides functions that tell you about Bugzilla in general.
=head1 METHODS
See L<Bugzilla::WebService> for a description of what B<STABLE>, B<UNSTABLE>,
and B<EXPERIMENTAL> mean.
=over
=item C<version> B<EXPERIMENTAL>
=over
=item B<Description>
Returns the current version of Bugzilla.
=item B<Params> (none)
=item B<Returns>
A hash with a single item, C<version>, that is the version as a
string.
=item B<Errors> (none)
=back
=item C<plugins> B<EXPERIMENTAL>
=over
=item B<Description>
Gets information about the plugins that are currently installed and enabled
in this Bugzilla.
=item B<Params> (none)
=item B<Returns>
A hash with a single item, C<plugins>. This points to a hash. I<That> hash
contains the names of plugins as keys, and the versions of the plugin as
values.
=back
=item C<timezone> B<EXPERIMENTAL>
=over
=item B<Description>
Returns the timezone of the server Bugzilla is running on. This is
important because all dates/times that the webservice interface
returns will be in this timezone.
=item B<Params> (none)
=item B<Returns>
A hash with a single item, C<timezone>, that is the timezone as a
string in (+/-)XXXX (RFC 2822) format.
=back
=back