Bugzilla.pm 6.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# -*- 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>
16
#                 Max Kanat-Alexander <mkanat@bugzilla.org>
17
#                 Mads Bondo Dydensborg <mbd@dbc.dk>
18 19 20 21 22 23

package Bugzilla::WebService::Bugzilla;

use strict;
use base qw(Bugzilla::WebService);
use Bugzilla::Constants;
24
use Bugzilla::Util qw(datetime_from);
25

26
use DateTime;
27

28 29 30 31 32 33
# Basic info that is needed before logins
use constant LOGIN_EXEMPT => {
    timezone => 1,
    version => 1,
};

34 35 36 37 38 39 40
use constant READ_ONLY => qw(
    extensions
    timezone
    time
    version
);

41
sub version {
42 43
    my $self = shift;
    return { version => $self->type('string', BUGZILLA_VERSION) };
44 45
}

46
sub extensions {
47
    my $self = shift;
48 49 50 51 52 53

    my %retval;
    foreach my $extension (@{ Bugzilla->extensions }) {
        my $version = $extension->VERSION || 0;
        my $name    = $extension->NAME;
        $retval{$name}->{version} = $self->type('string', $version);
54
    }
55
    return { extensions => \%retval };
56 57
}

58
sub timezone {
59
    my $self = shift;
60 61
    # All Webservices return times in UTC; Use UTC here for backwards compat.
    return { timezone => $self->type('string', "+0000") };
62 63
}

64 65
sub time {
    my ($self) = @_;
66 67
    # All Webservices return times in UTC; Use UTC here for backwards compat.
    # Hardcode values where appropriate
68 69 70
    my $dbh = Bugzilla->dbh;

    my $db_time = $dbh->selectrow_array('SELECT LOCALTIMESTAMP(0)');
71
    $db_time = datetime_from($db_time, 'UTC');
72 73 74 75
    my $now_utc = DateTime->now();

    return {
        db_time       => $self->type('dateTime', $db_time),
76
        web_time      => $self->type('dateTime', $now_utc),
77
        web_time_utc  => $self->type('dateTime', $now_utc),
78 79 80
        tz_name       => $self->type('string', 'UTC'),
        tz_offset     => $self->type('string', '+0000'),
        tz_short_name => $self->type('string', 'UTC'),
81 82 83
    };
}

84
1;
85 86 87 88 89 90 91 92 93 94 95 96 97

__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

98 99
See L<Bugzilla::WebService> for a description of how parameters are passed,
and what B<STABLE>, B<UNSTABLE>, and B<EXPERIMENTAL> mean.
100

101
=head2 version
102 103

B<STABLE>
104 105 106 107

=over

=item B<Description>
108

109
Returns the current version of Bugzilla.
110

111 112 113 114 115 116 117 118 119 120
=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
121

122
=head2 extensions
123 124

B<EXPERIMENTAL>
125 126 127 128 129

=over

=item B<Description>

130
Gets information about the extensions that are currently installed and enabled
131 132 133 134 135 136
in this Bugzilla.

=item B<Params> (none)

=item B<Returns>

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
A hash with a single item, C<extensions>. This points to a hash. I<That> hash
contains the names of extensions as keys, and the values are a hash.
That hash contains a single key C<version>, which is the version of the
extension, or C<0> if the extension hasn't defined a version.

The return value looks something like this:

 extensions => {
     Example => {
         version => '3.6',
     },
     BmpConvert => {
         version => '1.0',
     },
 }
152

153 154 155 156 157 158
=item B<History>

=over

=item Added in Bugzilla B<3.2>.

159 160 161 162
=item As of Bugzilla B<3.6>, the names of extensions are canonical names
that the extensions define themselves. Before 3.6, the names of the
extensions depended on the directory they were in on the Bugzilla server.

163 164
=back

165 166
=back

167
=head2 timezone
168

169 170
B<DEPRECATED> This method may be removed in a future version of Bugzilla.
Use L</time> instead.
171 172 173 174 175

=over

=item B<Description>

176
Returns the timezone that Bugzilla expects dates and times in.
177 178 179 180 181

=item B<Params> (none)

=item B<Returns>

182
A hash with a single item, C<timezone>, that is the timezone offset as a
183 184
string in (+/-)XXXX (RFC 2822) format.

185 186 187 188 189 190 191 192 193
=item B<History>

=over

=item As of Bugzilla B<3.6>, the timezone returned is always C<+0000>
(the UTC timezone).

=back

194
=back
195

196

197
=head2 time
198

199
B<STABLE>
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217

=over

=item B<Description>

Gets information about what time the Bugzilla server thinks it is, and
what timezone it's running in.

=item B<Params> (none)

=item B<Returns>

A struct with the following items:

=over

=item C<db_time>

218 219
C<dateTime> The current time in UTC, according to the Bugzilla 
I<database server>.
220 221 222 223 224 225 226 227

Note that Bugzilla assumes that the database and the webserver are running
in the same time zone. However, if the web server and the database server
aren't synchronized for some reason, I<this> is the time that you should
rely on for doing searches and other input to the WebService.

=item C<web_time>

228 229
C<dateTime> This is the current time in UTC, according to Bugzilla's 
I<web server>.
230 231 232 233 234 235 236 237

This might be different by a second from C<db_time> since this comes from
a different source. If it's any more different than a second, then there is
likely some problem with this Bugzilla instance. In this case you should
rely on the C<db_time>, not the C<web_time>.

=item C<web_time_utc>

238 239
Identical to C<web_time>. (Exists only for backwards-compatibility with
versions of Bugzilla before 3.6.)
240 241 242

=item C<tz_name>

243 244
C<string> The literal string C<UTC>. (Exists only for backwards-compatibility
with versions of Bugzilla before 3.6.) 
245 246 247

=item C<tz_short_name>

248 249
C<string> The literal string C<UTC>. (Exists only for backwards-compatibility
with versions of Bugzilla before 3.6.)
250 251 252

=item C<tz_offset>

253 254
C<string> The literal string C<+0000>. (Exists only for backwards-compatibility
with versions of Bugzilla before 3.6.)
255 256 257 258 259 260 261 262 263

=back

=item B<History>

=over

=item Added in Bugzilla B<3.4>.

264 265 266 267
=item As of Bugzilla B<3.6>, this method returns all data as though the server
were in the UTC timezone, instead of returning information in the server's
local timezone.

268 269 270
=back

=back