Attachment 295913 Details for Bug 427893 – WebService function User.get()

[patch] WebService function User.get()

patch.diff (text/plain), 6.88 KB, created by Noura El hawary on 2008-02-26 14:13:27 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Noura El hawary

Created: 2008-02-26 14:13:27 UTC

Size: 6.88 KB

patch

obsolete

>Index: Bugzilla/WebService/User.pm
>===================================================================
>RCS file: /cvs/qa/rh_bugzilla_3/Bugzilla/WebService/User.pm,v
>retrieving revision 1.1.1.1
>diff -u -r1.1.1.1 User.pm
>--- Bugzilla/WebService/User.pm	19 Nov 2007 22:11:21 -0000	1.1.1.1
>+++ Bugzilla/WebService/User.pm	26 Feb 2008 14:10:54 -0000
>@@ -15,6 +15,7 @@
> # Contributor(s): Marc Schumann <wurblzap@gmail.com>
> #                 Max Kanat-Alexander <mkanat@bugzilla.org>
> #                 Mads Bondo Dydensborg <mbd@dbc.dk>
>+#                 Noura Elhawary <nelhawar@redhat.com>
> 
> package Bugzilla::WebService::User;
> 
>@@ -113,6 +114,72 @@
>     return { id => type('int')->value($user->id) };
> }
> 
>+
>+# function to return user information by passing either user ids or 
>+# login names or both together:
>+# $call = $rpc->call( 'User.get', { ids => [1,2,3], 
>+#         names => ['testusera@redhat.com', 'testuserb@redhat.com'] });
>+sub get {
>+    my ($self, $params) = @_;
>+
>+    my @user_objects;
>+    @user_objects = map { Bugzilla::User->check($_) } @{ $params->{names} }
>+                    if $params->{names};
>+    
>+    my @users;
>+
>+    # if user not logged return an error is the passed any
>+    # user ids, otherwise return real names and names for 
>+    # valid passed login names.
>+    if (!Bugzilla->user->id){
>+        if ($params->{ids}){
>+            ThrowUserError("user_info_access_denied");
>+        }
>+        @users = map {{ 
>+                     real_name => type('string')->value($_->name), 
>+                     name => type('string')->value($_->login),
>+                 }} @user_objects;
>+
>+        return { users => \@users };
>+    }
>+
>+    my $obj_by_ids;
>+    $obj_by_ids = Bugzilla::User->new_from_list($params->{ids}) if $params->{ids};
>+
>+    # store the current user objects by login into
>+    # a hash with the ids as the keys to use it later
>+    # for checking dupliated user objects.
>+    my %unique_users;
>+    map { $unique_users{$_->id} = $_ } @user_objects;
>+
>+    # obj_by_ids are only visible to the user if he can see 
>+    # the otheruser, for non visible otheruser throw an error
>+    foreach my $obj (@$obj_by_ids){
>+        if (Bugzilla->user->can_see_user($obj)){
>+            push (@user_objects, $obj) if !$unique_users{$obj->id};
>+        }
>+        else {
>+            ThrowUserError('auth_failure', {reason => "not_visible",
>+                                            action => "access",
>+                                            object => "user",
>+                                            userid => $obj->id});
>+        }
>+    }
>+
>+    @users =
>+        map {{
>+            id => type('int')->value($_->id),
>+            real_name => type('string')->value($_->name),
>+            name => type('string')->value($_->login),
>+            email => type('string')->value($_->email),
>+            can_login => type('boolean')->value($_->is_disabled),
>+            email_enabled => type('boolean')->value($_->email_disabled),
>+            disabled_text => type('string')->value($_->disabledtext),
>+        }} @user_objects;
>+
>+    return { users => \@users };
>+}
>+
> 1;
> 
> __END__
>@@ -304,3 +371,96 @@
> =back
> 
> =back
>+
>+=head2 List Accounts
>+
>+=over
>+
>+=item C<get> B<UNSTABLE>
>+
>+=over
>+
>+=item B<Description>
>+
>+Gets information about user accounts in Bugzilla.
>+
>+=item B<Params>
>+
>+=over
>+
>+=item C<ids> (array) B<Optional> - An array of integers, representing user ids.
>+Logged-out users cannot pass this parameter to this function. If they try,
>+they will get an error. Logged-in users will get an error if they specify the
>+id of a user they cannot see.
>+
>+=item C<names> (array) B<Optional> - An array of login names (strings).
>+
>+=back
>+
>+=item B<Returns> 
>+
>+A hash containing one item, C<users>, that is an array of
>+hashes. Each hash describes a user, and has the following items:
>+
>+=over
>+
>+=item id
>+
>+C<int> The id of the user.
>+
>+=item real_name
>+
>+C<string> The actual name of the user.
>+
>+=item email
>+
>+C<string> The email address of the user.
>+
>+=item name
>+
>+C<string> The login name of the user. Note that in some situations this is 
>+different than their email.
>+
>+=item can_login
>+
>+C<boolean> A boolean value to indicate if the user can login into bugzilla. 
>+
>+=item email_enabled
>+
>+C<boolean> A boolean value to indicate if bug-related mail will be sent
>+to the user or not.
>+
>+=item disabled_text
>+
>+C<string> A text field that holds the reason for disabling a user from logging
>+into bugzilla, if empty then the user account is enabled otherwise it is 
>+disabled/closed.
>+
>+B<Note>: If you are not logged in to Bugzilla when you call this function, you
>+will only be returned the C<name> and C<real_name> items.
>+
>+=back
>+
>+=item B<Errors>
>+
>+=over
>+
>+=item 51 (Bad Login Name)
>+
>+You passed an invalid login name in the "names" array.
>+
>+=item 304 (Authorization Required)
>+
>+Logged-in users are not authorized to see one of the users they wanted 
>+to get information about by user id.
>+
>+=item 305 (User Info Access Denied)
>+
>+Logged-out users cannot use the "ids" argument to this function to access
>+any user information.
>+
>+=back
>+
>+=back
>+
>+=back
>Index: Bugzilla/WebService/Constants.pm
>===================================================================
>RCS file: /cvs/qa/rh_bugzilla_3/Bugzilla/WebService/Constants.pm,v
>retrieving revision 1.5
>diff -u -r1.5 Constants.pm
>--- Bugzilla/WebService/Constants.pm	12 Feb 2008 19:45:14 -0000	1.5
>+++ Bugzilla/WebService/Constants.pm	26 Feb 2008 14:11:04 -0000
>@@ -86,6 +86,8 @@
>     account_disabled             => 301,
>     auth_invalid_email           => 302,
>     extern_id_conflict           => -303,
>+    auth_failure                 => 304,
>+    user_info_access_denied      => 305,
> 
>     # User errors are 500-600.
>     account_exists        => 500,
>Index: template/en/default/global/user-error.html.tmpl
>===================================================================
>RCS file: /cvs/qa/rh_bugzilla_3/template/en/default/global/user-error.html.tmpl,v
>retrieving revision 1.13
>diff -u -r1.13 user-error.html.tmpl
>--- template/en/default/global/user-error.html.tmpl	14 Feb 2008 03:17:47 -0000	1.13
>+++ template/en/default/global/user-error.html.tmpl	26 Feb 2008 14:11:14 -0000
>@@ -197,8 +197,9 @@
>       a sudo session
>     [% ELSIF object == "timetracking_summaries" %]
>       time-tracking summary reports
>-    [% ELSIF object == "user" %]
>-      the user you specified
>+    [% ELSIF object == "user" %]  
>+      the user [% IF userid %] with ID '[% userid FILTER html %]'[% END %]
>+      you specified
>     [% ELSIF object == "users" %]
>       users
>     [% ELSIF object == "versions" %]
>@@ -1605,6 +1606,11 @@
>     [% title = "Illegal User ID" %]
>     User ID '[% userid FILTER html %]' is not valid integer.
> 
>+  [% ELSIF error == "user_info_access_denied" %]
>+    [% title = "User Info Access Denied" %]
>+    Logged-out users cannot use the "ids" argument to this function
>+    to access any user information.
>+  
>   [% ELSE %]
> 
>     [%# Try to find hooked error messages %]

Actions: View | Diff

Attachments on bug 427893: 291690 | 291953 | 292108 | 295913 | 296196 | 296210 | 296303