# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Mojo::Base 'Mojolicious::Plugin';
+use JSON;
+
=head1 NAME
Koha::REST::Plugin::Objects
=head2 Helper methods
+=cut
+
+sub register {
+ my ( $self, $app ) = @_;
+
+=head3 objects.find
+
+ my $patrons_rs = Koha::Patrons->new;
+ my $patrons = $c->objects->find( $patrons_rs, $id );
+
+Performs a database search using given Koha::Objects object and the $id.
+
+Returns I<undef> if no object is found Returns the I<API representation> of
+the requested object. It passes through any embeds if specified.
+
+=cut
+
+ $app->helper(
+ 'objects.find' => sub {
+ my ( $c, $result_set, $id ) = @_;
+
+ my $attributes = {};
+
+ # Look for embeds
+ my $embed = $c->stash('koha.embed');
+ # Generate prefetches for embedded stuff
+ $c->dbic_merge_prefetch(
+ {
+ attributes => $attributes,
+ result_set => $result_set
+ }
+ );
+
+ my $object = $result_set->find( $id, $attributes );
+
+ return unless $object;
+
+ return $object->to_api({ embed => $embed });
+ }
+ );
+
=head3 objects.search
my $patrons_rs = Koha::Patrons->new;
Returns an arrayref of the hashrefs representing the resulting objects
for API rendering.
-=cut
+Warning: this helper adds pagination headers to the calling controller, and thus
+shouldn't be called twice in it.
-sub register {
- my ( $self, $app ) = @_;
+=cut
$app->helper(
'objects.search' => sub {
my $attributes = {};
# Extract reserved params
- my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($args);
+ my ( $filtered_params, $reserved_params, $path_params ) = $c->extract_reserved_params($args);
+ # Privileged reques?
+ my $is_public = $c->stash('is_public');
# Look for embeds
my $embed = $c->stash('koha.embed');
}
);
- # Merge pagination into query attributes
- $c->dbic_merge_pagination(
+ # If no pagination parameters are passed, default
+ $reserved_params->{_per_page} //= C4::Context->preference('RESTdefaultPageSize');
+ $reserved_params->{_page} //= 1;
+
+ unless ( $reserved_params->{_per_page} == -1 ) {
+ # Merge pagination into query attributes
+ $c->dbic_merge_pagination(
+ {
+ filter => $attributes,
+ params => $reserved_params
+ }
+ );
+ }
+
+ # Generate prefetches for embedded stuff
+ $c->dbic_merge_prefetch(
{
- filter => $attributes,
- params => $reserved_params
+ attributes => $attributes,
+ result_set => $result_set
}
);
$filtered_params = $c->build_query_params( $filtered_params, $reserved_params );
}
+ if ( defined $reserved_params->{q}
+ || defined $reserved_params->{query}
+ || defined $reserved_params->{'x-koha-query'} )
+ {
+ $filtered_params //= {};
+
+ my @query_params_array;
+
+ # query in request body, JSON::Validator already decoded it
+ push @query_params_array, $reserved_params->{query}
+ if defined $reserved_params->{query};
+
+ my $json = JSON->new;
+
+ if ( ref($reserved_params->{q}) eq 'ARRAY' ) {
+ # q is defined as multi => JSON::Validator generates an array
+ foreach my $q ( @{ $reserved_params->{q} } ) {
+ push @query_params_array, $json->decode($q)
+ if $q; # skip if exists but is empty
+ }
+ }
+ else {
+ # objects.search called outside OpenAPI context
+ # might be a hashref
+ push @query_params_array, $json->decode($reserved_params->{q})
+ if $reserved_params->{q};
+ }
+
+ push @query_params_array,
+ $json->decode( $reserved_params->{'x-koha-query'} )
+ if defined $reserved_params->{'x-koha-query'};
+
+ my $query_params;
+
+ if ( scalar(@query_params_array) > 1 ) {
+ $query_params = { '-and' => \@query_params_array };
+ }
+ else {
+ $query_params = $query_params_array[0];
+ }
+
+ $filtered_params = $c->merge_q_params( $filtered_params, $query_params, $result_set );
+ }
+
+ # request sequence id (i.e. 'draw' Datatables parameter)
+ $c->res->headers->add( 'x-koha-request-id' => $reserved_params->{'x-koha-request-id'} )
+ if $reserved_params->{'x-koha-request-id'};
+
+ # If search_limited exists, use it
+ $result_set = $result_set->search_limited,
+ if $result_set->can('search_limited');
+
# Perform search
my $objects = $result_set->search( $filtered_params, $attributes );
+ my $total = $result_set->search->count;
- if ($objects->is_paged) {
- $c->add_pagination_headers({
- total => $objects->pager->total_entries,
- params => $args,
- });
- }
+ $c->add_pagination_headers(
+ {
+ total => ($objects->is_paged ? $objects->pager->total_entries : $objects->count),
+ base_total => $total,
+ params => $args,
+ }
+ );
- return $objects->to_api({ embed => $embed });
+ return $objects->to_api({ embed => $embed, public => $is_public });
}
);
}
projects / srvgit / blobdiff