From 0ee4621e7828a205189368aa9b8a515574d9c030 Mon Sep 17 00:00:00 2001 From: "wurblzap%gmail.com" <> Date: Sun, 20 Aug 2006 00:20:23 +0000 Subject: Bug 224577: Bugzilla could use a web services interface. Patch by Marc Schumann ; r=mkanat; a=myk --- Bugzilla/WebService/Bug.pm | 36 ++++++++++++++++++++++++++ Bugzilla/WebService/Bugzilla.pm | 27 ++++++++++++++++++++ Bugzilla/WebService/Constants.pm | 32 +++++++++++++++++++++++ Bugzilla/WebService/Product.pm | 36 ++++++++++++++++++++++++++ Bugzilla/WebService/User.pm | 55 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 186 insertions(+) create mode 100755 Bugzilla/WebService/Bug.pm create mode 100755 Bugzilla/WebService/Bugzilla.pm create mode 100755 Bugzilla/WebService/Constants.pm create mode 100755 Bugzilla/WebService/Product.pm create mode 100755 Bugzilla/WebService/User.pm (limited to 'Bugzilla/WebService') diff --git a/Bugzilla/WebService/Bug.pm b/Bugzilla/WebService/Bug.pm new file mode 100755 index 000000000..6698fdc97 --- /dev/null +++ b/Bugzilla/WebService/Bug.pm @@ -0,0 +1,36 @@ +# -*- 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 + +package Bugzilla::WebService::Bug; + +use strict; +use base qw(Bugzilla::WebService); + +use Bugzilla::WebService::Constants; +use Bugzilla::Util qw(detaint_natural); +use Bugzilla::Bug; + +sub get_bug { + my $self = shift; + my ($bug_id) = @_; + + Bugzilla->login; + + ValidateBugID($bug_id); + return new Bugzilla::Bug($bug_id); +} + +1; diff --git a/Bugzilla/WebService/Bugzilla.pm b/Bugzilla/WebService/Bugzilla.pm new file mode 100755 index 000000000..0caf5fab2 --- /dev/null +++ b/Bugzilla/WebService/Bugzilla.pm @@ -0,0 +1,27 @@ +# -*- 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 + +package Bugzilla::WebService::Bugzilla; + +use strict; +use base qw(Bugzilla::WebService); +use Bugzilla::Constants; + +sub get_version { + return BUGZILLA_VERSION; +} + +1; diff --git a/Bugzilla/WebService/Constants.pm b/Bugzilla/WebService/Constants.pm new file mode 100755 index 000000000..2e9457add --- /dev/null +++ b/Bugzilla/WebService/Constants.pm @@ -0,0 +1,32 @@ +# -*- 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 + +package Bugzilla::WebService::Constants; + +use strict; +use base qw(Exporter); + +@Bugzilla::WebService::Constants::EXPORT = qw( + ERROR_AUTH_NODATA + ERROR_UNIMPLEMENTED + ERROR_GENERAL +); + +use constant ERROR_AUTH_NODATA => 410; +use constant ERROR_UNIMPLEMENTED => 910; +use constant ERROR_GENERAL => 999; + +1; diff --git a/Bugzilla/WebService/Product.pm b/Bugzilla/WebService/Product.pm new file mode 100755 index 000000000..b56abb588 --- /dev/null +++ b/Bugzilla/WebService/Product.pm @@ -0,0 +1,36 @@ +# -*- 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 + +package Bugzilla::WebService::Product; + +use strict; +use base qw(Bugzilla::WebService); +use Bugzilla::Product; + +sub get_product { + my $self = shift; + my ($product_name) = @_; + + Bugzilla->login; + + # Bugzilla::Product doesn't do permissions checks, so we can't do the call + # to Bugzilla::Product::new until a permissions check happens here. + $self->fail_unimplemented(); + + return new Bugzilla::Product({'name' => $product_name}); +} + +1; diff --git a/Bugzilla/WebService/User.pm b/Bugzilla/WebService/User.pm new file mode 100755 index 000000000..813b2fc2a --- /dev/null +++ b/Bugzilla/WebService/User.pm @@ -0,0 +1,55 @@ +# -*- 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 + +package Bugzilla::WebService::User; + +use strict; +use base qw(Bugzilla::WebService); +use Bugzilla; +use Bugzilla::Constants; + +sub login { + my $self = shift; + my ($login, $password, $remember) = @_; + + # Convert $remember from a boolean 0/1 value to a CGI-compatible one. + if (defined($remember)) { + $remember = $remember? 'on': ''; + } + else { + # Use Bugzilla's default if $remember is not supplied. + $remember = + Bugzilla->params->{'rememberlogin'} eq 'defaulton'? 'on': ''; + } + + # Make sure the CGI user info class works if necessary. + my $cgi = Bugzilla->cgi; + $cgi->param('Bugzilla_login', $login); + $cgi->param('Bugzilla_password', $password); + $cgi->param('Bugzilla_remember', $remember); + + Bugzilla->login; + return Bugzilla->user->id; +} + +sub logout { + my $self = shift; + + Bugzilla->login(LOGIN_OPTIONAL); + Bugzilla->logout; +} + +1; -- cgit v1.2.3-24-g4f1b