summaryrefslogtreecommitdiffstats
path: root/Bugzilla/WebService/Component.pm
blob: 1410a12f633d2d699bef12fee2899b0c3776dee6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# 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::Component;

use 5.14.0;
use strict;
use warnings;

use base qw(Bugzilla::WebService);

use Bugzilla::Component;
use Bugzilla::Constants;
use Bugzilla::Error;
use Bugzilla::WebService::Constants;
use Bugzilla::WebService::Util qw(translate params_to_objects validate);

use constant PUBLIC_METHODS => qw(
    create
    delete
    update
);

use constant CREATE_MAPPED_FIELDS => {
    default_assignee   => 'initialowner',
    default_qa_contact => 'initialqacontact',
    default_cc         => 'initial_cc',
    is_open            => 'isactive',
};

use constant MAPPED_FIELDS => {
    is_open => 'is_active',
};

use constant MAPPED_RETURNS => {
    initialowner     => 'default_assignee',
    initialqacontact => 'default_qa_contact',
    cc_list          => 'default_cc',
    isactive         => 'isopen',
};

sub create {
    my ($self, $params) = @_;

    my $user = Bugzilla->login(LOGIN_REQUIRED);

    $user->in_group('editcomponents')
        || scalar @{ $user->get_products_by_permission('editcomponents') }
        || ThrowUserError('auth_failure', { group  => 'editcomponents',
                                            action => 'edit',
                                            object => 'components' });

    my $product = $user->check_can_admin_product($params->{product});

    # Translate the fields
    my $values = translate($params, CREATE_MAPPED_FIELDS);
    $values->{product} = $product;

    # Create the component and return the newly created id.
    my $component = Bugzilla::Component->create($values);
    return { id => $self->type('int', $component->id) };
}

sub _component_params_to_objects {
    # We can't use Util's _param_to_objects since name is a hash
    my $params = shift;
    my $user   = Bugzilla->user;

    my @components = ();

    if (defined $params->{ids}) {
        push @components, @{ Bugzilla::Component->new_from_list($params->{ids}) };
    }

    if (defined $params->{names}) {
        # To get the component objects for product/component combination
        # first obtain the product object from the passed product name
        foreach my $name_hash (@{$params->{names}}) {
            my $product = $user->check_can_admin_product($name_hash->{product});
            push @components, @{ Bugzilla::Component->match({
                product_id => $product->id,
                name       => $name_hash->{component}
            })};
        }
    }

    my %seen_component_ids = ();

    my @accessible_components;
    foreach my $component (@components) {
        # Skip if we already included this component
        next if $seen_component_ids{$component->id}++;

        # Can the user see and admin this product?
        my $product = $component->product;
        $user->check_can_admin_product($product->name);

        push @accessible_components, $component;
    }

    return \@accessible_components;
}

sub update {
    my ($self, $params) = @_;
    my $dbh  = Bugzilla->dbh;
    my $user = Bugzilla->login(LOGIN_REQUIRED);

    $user->in_group('editcomponents')
        || scalar @{ $user->get_products_by_permission('editcomponents') }
        || ThrowUserError("auth_failure", { group  => "editcomponents",
                                            action => "edit",
                                            object => "components" });

    defined($params->{names}) || defined($params->{ids})
        || ThrowCodeError('params_required',
               { function => 'Component.update', params => ['ids', 'names'] });

    my $component_objects = _component_params_to_objects($params);

    # If the user tries to change component name for several
    # components of the same product then throw an error
    if ($params->{name}) {
        my %unique_product_comps;
        foreach my $comp (@$component_objects) {
            if($unique_product_comps{$comp->product_id}) {
                ThrowUserError("multiple_components_update_not_allowed");
            }
            else {
                $unique_product_comps{$comp->product_id} = 1;
            }
        }
    }

    my $values = translate($params, MAPPED_FIELDS);

    # We delete names and ids to keep only new values to set.
    delete $values->{names};
    delete $values->{ids};

    $dbh->bz_start_transaction();
    foreach my $component (@$component_objects) {
        $component->set_all($values);
    }

    my %changes;
    foreach my $component (@$component_objects) {
        my $returned_changes = $component->update();
        $changes{$component->id} = translate($returned_changes, MAPPED_RETURNS);
    }
    $dbh->bz_commit_transaction();

    my @result;
    foreach my $component (@$component_objects) {
        my %hash = (
            id      => $component->id,
            changes => {},
        );

        foreach my $field (keys %{ $changes{$component->id} }) {
            my $change = $changes{$component->id}->{$field};

            if ($field eq 'default_assignee'
                || $field eq 'default_qa_contact'
                || $field eq 'default_cc'
            ) {
                # We need to convert user ids to login names
                my @old_user_ids = split(/[,\s]+/, $change->[0]);
                my @new_user_ids = split(/[,\s]+/, $change->[1]);

                my @old_users = map { $_->login }
                    @{Bugzilla::User->new_from_list(\@old_user_ids)};
                my @new_users = map { $_->login }
                    @{Bugzilla::User->new_from_list(\@new_user_ids)};

                $hash{changes}{$field} = {
                    removed => $self->type('string', join(', ', @old_users)),
                    added   => $self->type('string', join(', ', @new_users)),
                };
            }
            else {
                $hash{changes}{$field} = {
                    removed => $self->type('string', $change->[0]),
                    added   => $self->type('string', $change->[1])
                };
            }
        }

        push(@result, \%hash);
    }

    return { components => \@result };
}

sub delete {
    my ($self, $params) = @_;
    my $dbh  = Bugzilla->dbh;
    my $user = Bugzilla->login(LOGIN_REQUIRED);

    $user->in_group('editcomponents')
        || scalar @{ $user->get_products_by_permission('editcomponents') }
        || ThrowUserError("auth_failure", { group  => "editcomponents",
                                            action => "edit",
                                            object => "components" });

    defined($params->{names}) || defined($params->{ids})
        || ThrowCodeError('params_required',
               { function => 'Component.delete', params => ['ids', 'names'] });

    my $component_objects = _component_params_to_objects($params);

    $dbh->bz_start_transaction();
    my %changes;
    foreach my $component (@$component_objects) {
        my $returned_changes = $component->remove_from_db();
    }
    $dbh->bz_commit_transaction();

    my @result;
    foreach my $component (@$component_objects) {
        push @result, { id => $component->id };
    }

    return { components => \@result };
}

1;

__END__

=head1 NAME

Bugzilla::Webservice::Component - The Component API

=head1 DESCRIPTION

This part of the Bugzilla API allows you to deal with the available product components.
You will be able to get information about them as well as manipulate them.

=head1 METHODS

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

=head1 Component Creation and Modification

=head2 create

B<EXPERIMENTAL>

=over

=item B<Description>

This allows you to create a new component in Bugzilla.

=item B<Params>

Some params must be set, or an error will be thrown. These params are
marked B<Required>.

=over

=item C<name>

B<Required> C<string> The name of the new component.

=item C<product>

B<Required> C<string> The name of the product that the component must be
added to. This product must already exist, and the user have the necessary
permissions to edit components for it.

=item C<description>

B<Required> C<string> The description of the new component.

=item C<default_assignee>

B<Required> C<string> The login name of the default assignee of the component.

=item C<default_cc>

C<array> An array of strings with each element representing one login name of the default CC list.

=item C<default_qa_contact>

C<string> The login name of the default QA contact for the component.

=item C<is_open>

C<boolean> 1 if you want to enable the component for bug creations. 0 otherwise. Default is 1.

=back

=item B<Returns>

A hash with one key: C<id>. This will represent the ID of the newly-added
component.

=item B<Errors>

=over

=item 304 (Authorization Failure)

You are not authorized to create a new component.

=item 1200 (Component already exists)

The name that you specified for the new component already exists in the
specified product.

=back

=item B<History>

=over

=item Added in Bugzilla B<5.0>.

=back

=back

=head2 update

=over

=item B<Description>

This allows you to update one or more components in Bugzilla.

=item B<REST>

PUT /rest/component/<component_id>

PUT /rest/component/<product_name>/<component_name>

The params to include in the PUT body as well as the returned data format,
are the same as below. The C<ids> and C<names> params will be overridden as
it is pulled from the URL path.

=item B<Params>

B<Note:> The following parameters specify which components you are updating.
You must set one or both of these parameters.

=over

=item C<ids>

C<array> of C<int>s. Numeric ids of the components that you wish to update.

=item C<names>

C<array> of C<hash>es. Names of the components that you wish to update. The
hash keys are C<product> and C<component>, representing the name of the product
and the component you wish to change.

=back

B<Note:> The following parameters specify the new values you want to set for
the components you are updating.

=over

=item C<name>

C<string> A new name for this component. If you try to set this while updating
more than one component for a product, an error will occur, as component names
must be unique per product.

=item C<description>

C<string> Update the long description for these components to this value.

=item C<default_assignee>

C<string> The login name of the default assignee of the component.

=item C<default_cc>

C<array> An array of strings with each element representing one login name of the default CC list.

=item C<default_qa_contact>

C<string> The login name of the default QA contact for the component.

=item C<is_open>

C<boolean> True if the component is currently allowing bugs to be entered
into it, False otherwise.

=back

=item B<Returns>

A C<hash> with a single field "components". This points to an array of hashes
with the following fields:

=over

=item C<id>

C<int> The id of the component that was updated.

=item C<changes>

C<hash> The changes that were actually done on this component. The keys are
the names of the fields that were changed, and the values are a hash
with two keys:

=over

=item C<added>

C<string> The value that this field was changed to.

=item C<removed>

C<string> The value that was previously set in this field.

=back

Note that booleans will be represented with the strings '1' and '0'.

Here's an example of what a return value might look like:

 {
   components => [
     {
       id => 123,
       changes => {
         name => {
           removed => 'FooName',
           added   => 'BarName'
         },
         default_assignee => {
           removed => 'foo@company.com',
           added   => 'bar@company.com',
         }
       }
     }
   ]
 }

=back

=item B<Errors>

=over

=item 51 (User does not exist)

One of the contact e-mail addresses is not a valid Bugzilla user.

=item 106 (Product access denied)

The product you are trying to modify does not exist or you don't have access to it.

=item 706 (Product admin denied)

You do not have the permission to change components for this product.

=item 105 (Component name too long)

The name specified for this component was longer than the maximum
allowed length.

=item 1200 (Component name already exists)

You specified the name of a component that already exists.
(Component names must be unique per product in Bugzilla.)

=item 1210 (Component blank name)

You must specify a non-blank name for this component.

=item 1211 (Component must have description)

You must specify a description for this component.

=item 1212 (Component name is not unique)

You have attempted to set more than one component in the same product with the
same name. Component names must be unique in each product.

=item 1213 (Component needs a default assignee)

A default assignee is required for this component.

=back

=item B<History>

=over

=item Added in Bugzilla B<5.0>.

=back

=back

=head2 delete

=over

=item B<Description>

This allows you to delete one or more components in Bugzilla.

=item B<REST>

DELETE /rest/component/<component_id>

DELETE /rest/component/<product_name>/<component_name>

The params to include in the PUT body as well as the returned data format,
are the same as below. The C<ids> and C<names> params will be overridden as
it is pulled from the URL path.

=item B<Params>

B<Note:> The following parameters specify which components you are deleting.
You must set one or both of these parameters.

=over

=item C<ids>

C<array> of C<int>s. Numeric ids of the components that you wish to delete.

=item C<names>

C<array> of C<hash>es. Names of the components that you wish to delete. The
hash keys are C<product> and C<component>, representing the name of the product
and the component you wish to delete.

=back

=item B<Returns>

A C<hash> with a single field "components". This points to an array of hashes
with the following field:

=over

=item C<id>

C<int> The id of the component that was deleted.

=back

=item B<Errors>

=over

=item 106 (Product access denied)

The product you are trying to modify does not exist or you don't have access to it.

=item 706 (Product admin denied)

You do not have the permission to delete components for this product.

=item 1202 (Component has bugs)

The component you are trying to delete currently has bugs assigned to it.
You must move these bugs before trying to delete the component.

=back

=item B<History>

=over

=item Added in Bugzilla B<5.0>

=back

=back