1 package Koha::REST::Plugin::Objects;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Mojo::Base 'Mojolicious::Plugin';
26 Koha::REST::Plugin::Objects
35 my ( $self, $app ) = @_;
39 my $patrons_rs = Koha::Patrons->new;
40 my $patrons = $c->objects->find( $patrons_rs, $id );
42 Performs a database search using given Koha::Objects object and the $id.
44 Returns I<undef> if no object is found Returns the I<API representation> of
45 the requested object. It passes through any embeds if specified.
50 'objects.find' => sub {
51 my ( $c, $result_set, $id ) = @_;
56 my $embed = $c->stash('koha.embed');
57 # Generate prefetches for embedded stuff
58 $c->dbic_merge_prefetch(
60 attributes => $attributes,
61 result_set => $result_set
65 my $object = $result_set->find( $id, $attributes );
67 return unless $object;
69 return $object->to_api({ embed => $embed });
75 my $patrons_rs = Koha::Patrons->new;
76 my $patrons = $c->objects->search( $patrons_rs );
78 Performs a database search using given Koha::Objects object and query parameters.
80 Returns an arrayref of the hashrefs representing the resulting objects
83 Warning: this helper adds pagination headers to the calling controller, and thus
84 shouldn't be called twice in it.
89 'objects.search' => sub {
90 my ( $c, $result_set ) = @_;
92 my $args = $c->validation->output;
95 # Extract reserved params
96 my ( $filtered_params, $reserved_params, $path_params ) = $c->extract_reserved_params($args);
98 my $is_public = $c->stash('is_public');
100 my $embed = $c->stash('koha.embed');
102 # Merge sorting into query attributes
103 $c->dbic_merge_sorting(
105 attributes => $attributes,
106 params => $reserved_params,
107 result_set => $result_set
111 # If no pagination parameters are passed, default
112 $reserved_params->{_per_page} //= C4::Context->preference('RESTdefaultPageSize');
113 $reserved_params->{_page} //= 1;
115 unless ( $reserved_params->{_per_page} == -1 ) {
116 # Merge pagination into query attributes
117 $c->dbic_merge_pagination(
119 filter => $attributes,
120 params => $reserved_params
125 # Generate prefetches for embedded stuff
126 $c->dbic_merge_prefetch(
128 attributes => $attributes,
129 result_set => $result_set
133 # Call the to_model function by reference, if defined
134 if ( defined $filtered_params ) {
136 # Apply the mapping function to the passed params
137 $filtered_params = $result_set->attributes_from_api($filtered_params);
138 $filtered_params = $c->build_query_params( $filtered_params, $reserved_params );
141 if ( defined $reserved_params->{q}
142 || defined $reserved_params->{query}
143 || defined $reserved_params->{'x-koha-query'} )
145 $filtered_params //= {};
147 my @query_params_array;
149 # query in request body, JSON::Validator already decoded it
150 push @query_params_array, $reserved_params->{query}
151 if defined $reserved_params->{query};
153 my $json = JSON->new;
155 if ( ref($reserved_params->{q}) eq 'ARRAY' ) {
156 # q is defined as multi => JSON::Validator generates an array
157 foreach my $q ( @{ $reserved_params->{q} } ) {
158 push @query_params_array, $json->decode($q)
159 if $q; # skip if exists but is empty
163 # objects.search called outside OpenAPI context
165 push @query_params_array, $json->decode($reserved_params->{q})
166 if $reserved_params->{q};
169 push @query_params_array,
170 $json->decode( $reserved_params->{'x-koha-query'} )
171 if defined $reserved_params->{'x-koha-query'};
175 if ( scalar(@query_params_array) > 1 ) {
176 $query_params = { '-and' => \@query_params_array };
179 $query_params = $query_params_array[0];
182 $filtered_params = $c->merge_q_params( $filtered_params, $query_params, $result_set );
185 # request sequence id (i.e. 'draw' Datatables parameter)
186 $c->res->headers->add( 'x-koha-request-id' => $reserved_params->{'x-koha-request-id'} )
187 if $reserved_params->{'x-koha-request-id'};
189 # If search_limited exists, use it
190 $result_set = $result_set->search_limited,
191 if $result_set->can('search_limited');
194 my $objects = $result_set->search( $filtered_params, $attributes );
195 my $total = $result_set->search->count;
197 $c->add_pagination_headers(
199 total => ($objects->is_paged ? $objects->pager->total_entries : $objects->count),
200 base_total => $total,
205 return $objects->to_api({ embed => $embed, public => $is_public });