Koha-community/Koha
15
7
Fork 0
Code Issues Releases Wiki Activity

Bug 28948: Remove FIXME

Browse source 
This patch reproduces what we did for `to_api_mapping`: make it always
present on Koha::Object classes. This has the side-effect of... making
things more secure!

Before this patch, if undefined, all attributes were returned.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
This commit is contained in:
Tomás Cohen Arazi 2021-10-07 14:51:51 -03:00 committed by Jonathan Druart
parent 31e9ccfe70
commit e0de8364b7
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
Koha/Object.pm
View file

@ -554,12 +554,9 @@ sub to_api {
my $json_object = $self->TO_JSON; my $json_object = $self->TO_JSON;
# Remove forbidden attributes if required # Remove forbidden attributes if required
# FIXME: We should eventually require public_read_list in all objects and drop the conditional here. if ( $params->{public} ) {
if ( $params->{public}
and $self->can('public_read_list') )
{
for my $field ( keys %{$json_object} ) { for my $field ( keys %{$json_object} ) {
delete $json_object->{$field} unless any { $_ eq $field } @{$self->public_read_list}; delete $json_object->{$field} unless any { $_ eq $field } @{ $self->public_read_list };
} }
} }
@ -649,6 +646,24 @@ sub to_api_mapping {
return {}; return {};
} }
=head3 public_read_list
my @public_read_list = @{$object->public_read_list};
Generic method that returns the list of database columns that are allowed to
be passed to render objects on the public API.
Note: this only returns an empty I<arrayref>. Each class should have its
own implementation.
=cut
sub public_read_list
{
return [];
}
=head3 from_api_mapping =head3 from_api_mapping
my $mapping = $object->from_api_mapping; my $mapping = $object->from_api_mapping;