# 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. package Bugzilla::WebService::Bugzilla; use strict; use base qw(Bugzilla::WebService); use Bugzilla::Constants; use Bugzilla::Util qw(datetime_from); use Bugzilla::WebService::Util qw(filter_wants); use DateTime; # Basic info that is needed before logins use constant LOGIN_EXEMPT => { parameters => 1, timezone => 1, version => 1, }; use constant READ_ONLY => qw( extensions parameters timezone time version ); # Logged-out users do not need to know more than that. use constant PARAMETERS_LOGGED_OUT => qw( maintainer requirelogin ); # These parameters are guessable from the web UI when the user # is logged in. So it's safe to access them. use constant PARAMETERS_LOGGED_IN => qw( allowemailchange attachment_base commentonchange_resolution commentonduplicate cookiepath defaultopsys defaultplatform defaultpriority defaultseverity duplicate_or_move_bug_status emailregexpdesc emailsuffix letsubmitterchoosemilestone letsubmitterchoosepriority mailfrom maintainer maxattachmentsize maxlocalattachment musthavemilestoneonaccept noresolveonopenblockers password_complexity rememberlogin requirelogin search_allow_no_criteria urlbase use_see_also useclassification useqacontact usestatuswhiteboard usetargetmilestone ); sub version { my $self = shift; return { version => $self->type('string', BUGZILLA_VERSION) }; } sub extensions { my $self = shift; my %retval; foreach my $extension (@{ Bugzilla->extensions }) { my $version = $extension->VERSION || 0; my $name = $extension->NAME; $retval{$name}->{version} = $self->type('string', $version); } return { extensions => \%retval }; } sub timezone { my $self = shift; # All Webservices return times in UTC; Use UTC here for backwards compat. return { timezone => $self->type('string', "+0000") }; } sub time { my ($self) = @_; # All Webservices return times in UTC; Use UTC here for backwards compat. # Hardcode values where appropriate my $dbh = Bugzilla->dbh; my $db_time = $dbh->selectrow_array('SELECT LOCALTIMESTAMP(0)'); $db_time = datetime_from($db_time, 'UTC'); my $now_utc = DateTime->now(); return { db_time => $self->type('dateTime', $db_time), web_time => $self->type('dateTime', $now_utc), web_time_utc => $self->type('dateTime', $now_utc), tz_name => $self->type('string', 'UTC'), tz_offset => $self->type('string', '+0000'), tz_short_name => $self->type('string', 'UTC'), }; } sub parameters { my ($self, $args) = @_; my $user = Bugzilla->login(); my $params = Bugzilla->params; $args ||= {}; my @params_list = $user->in_group('tweakparams') ? keys(%$params) : $user->id ? PARAMETERS_LOGGED_IN : PARAMETERS_LOGGED_OUT; my %parameters; foreach my $param (@params_list) { next unless filter_wants($args, $param); $parameters{$param} = $self->type('string', $params->{$param}); } return { parameters => \%parameters }; } 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 for a description of how parameters are passed, and what B, B, and B mean. =head2 version B =over =item B Returns the current version of Bugzilla. =item B (none) =item B A hash with a single item, C, that is the version as a string. =item B (none) =back =head2 extensions B =over =item B Gets information about the extensions that are currently installed and enabled in this Bugzilla. =item B (none) =item B A hash with a single item, C. This points to a hash. I hash contains the names of extensions as keys, and the values are a hash. That hash contains a single key C, 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', }, } =item B =over =item Added in Bugzilla B<3.2>. =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. =back =back =head2 timezone B This method may be removed in a future version of Bugzilla. Use L instead. =over =item B Returns the timezone that Bugzilla expects dates and times in. =item B (none) =item B A hash with a single item, C, that is the timezone offset as a string in (+/-)XXXX (RFC 2822) format. =item B =over =item As of Bugzilla B<3.6>, the timezone returned is always C<+0000> (the UTC timezone). =back =back =head2 time B =over =item B Gets information about what time the Bugzilla server thinks it is, and what timezone it's running in. =item B (none) =item B A struct with the following items: =over =item C C The current time in UTC, according to the Bugzilla I. 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 is the time that you should rely on for doing searches and other input to the WebService. =item C C This is the current time in UTC, according to Bugzilla's I. This might be different by a second from C 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, not the C. =item C Identical to C. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.) =item C C The literal string C. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.) =item C C The literal string C. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.) =item C C The literal string C<+0000>. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.) =back =item B =over =item Added in Bugzilla B<3.4>. =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. =back =back =head2 parameters B =over =item B Returns parameter values currently used in this Bugzilla. =item B (none) =item B A hash with a single item C which contains a hash with the name of the parameters as keys and their value as values. All values are returned as strings. The list of parameters returned by this method depends on the user credentials: A logged-out user can only access the C and C parameters. A logged-in user can access the following parameters (listed alphabetically): C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C. A user in the tweakparams group can access all existing parameters. New parameters can appear or obsolete parameters can disappear depending on the version of Bugzilla and on extensions being installed. The list of parameters returned by this method is not stable and will never be stable. =item B =over =item Added in Bugzilla B<4.4>. =back =back