diff options
| -rw-r--r-- | Bugzilla/WebService.pm | 7 | ||||
| -rw-r--r-- | Bugzilla/WebService/Product.pm | 36 | ||||
| -rw-r--r-- | Bugzilla/WebService/Util.pm | 17 |
3 files changed, 41 insertions, 19 deletions
diff --git a/Bugzilla/WebService.pm b/Bugzilla/WebService.pm index 67aa21374..5b2825375 100644 --- a/Bugzilla/WebService.pm +++ b/Bugzilla/WebService.pm @@ -275,6 +275,13 @@ the returned hashes. If you specify all the fields, then this function will return empty hashes. +Some RPC calls support specifying sub fields. If an RPC call states that +it support sub field restrictions, you can restrict what information is +returned within the first field. For example, if you call Products.get +with an include_fields of components.name, then only the component name +would be returned (and nothing else). You can include the main field, +and exclude a sub field. + Invalid field names are ignored. Specifying fields here overrides C<include_fields>, so if you specify a diff --git a/Bugzilla/WebService/Product.pm b/Bugzilla/WebService/Product.pm index fc48ecd88..755477acf 100644 --- a/Bugzilla/WebService/Product.pm +++ b/Bugzilla/WebService/Product.pm @@ -214,12 +214,12 @@ sub _product_to_hash { } if (filter_wants($params, 'versions')) { $field_data->{versions} = [map { - $self->_version_to_hash($_) + $self->_version_to_hash($_, $params) } @{$product->versions}]; } if (filter_wants($params, 'milestones')) { $field_data->{milestones} = [map { - $self->_milestone_to_hash($_) + $self->_milestone_to_hash($_, $params) } @{$product->milestones}]; } return filter($params, $field_data); @@ -243,23 +243,26 @@ sub _component_to_hash { 0, is_active => $self->type('boolean', $component->is_active), - flag_types => { + }; + + if (filter_wants($params, 'flag_types', 'components')) { + $field_data->{flag_types} = { bug => [map { - $self->_flag_type_to_hash($_, $params) + $self->_flag_type_to_hash($_) } @{$component->flag_types->{'bug'}}], attachment => [map { - $self->_flag_type_to_hash($_, $params) + $self->_flag_type_to_hash($_) } @{$component->flag_types->{'attachment'}}], - } - }; - return filter($params, $field_data, 'component'); + }; + } + return filter($params, $field_data, 'components'); } sub _flag_type_to_hash { - my ($self, $flag_type, $params) = @_; - my $field_data = { + my ($self, $flag_type) = @_; + return { id => $self->type('int', $flag_type->id), name => @@ -283,12 +286,11 @@ sub _flag_type_to_hash { request_group => $self->type('int', $flag_type->request_group_id), }; - return filter($params, $field_data, 'flag_type'); } sub _version_to_hash { - my ($self, $version) = @_; - return { + my ($self, $version, $params) = @_; + my $field_data = { id => $self->type('int', $version->id), name => @@ -298,11 +300,12 @@ sub _version_to_hash { is_active => $self->type('boolean', $version->is_active), }; + return filter($params, $field_data, 'versions'); } sub _milestone_to_hash { - my ($self, $milestone) = @_; - return { + my ($self, $milestone, $params) = @_; + my $field_data = { id => $self->type('int', $milestone->id), name => @@ -312,6 +315,7 @@ sub _milestone_to_hash { is_active => $self->type('boolean', $milestone->is_active), }; + return filter($params, $field_data, 'milestones'); } 1; @@ -419,6 +423,8 @@ In addition to the parameters below, this method also accepts the standard L<include_fields|Bugzilla::WebService/include_fields> and L<exclude_fields|Bugzilla::WebService/exclude_fields> arguments. +This RPC call supports sub field restrictions. + =over =item C<ids> diff --git a/Bugzilla/WebService/Util.pm b/Bugzilla/WebService/Util.pm index 9e20a1e06..d2a8de85c 100644 --- a/Bugzilla/WebService/Util.pm +++ b/Bugzilla/WebService/Util.pm @@ -43,11 +43,20 @@ sub filter_wants ($$;$) { $field = "${prefix}.${field}" if $prefix; - if (defined $params->{include_fields}) { - return 0 if !$include{$field}; + if (defined $params->{exclude_fields} && $exclude{$field}) { + return 0; } - if (defined $params->{exclude_fields}) { - return 0 if $exclude{$field}; + if (defined $params->{include_fields} && !$include{$field}) { + if ($prefix) { + # Include the field if the parent is include (and this one is not excluded) + return 0 if !$include{$prefix}; + } + else { + # We want to include this if one of the sub keys is included + my $key = $field . '.'; + my $len = length($key); + return 0 if ! grep { substr($_, 0, $len) eq $key } keys %include; + } } return 1; |