1 package Koha::REST::Plugin::Query;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 3 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along
15 # with Koha; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 use Mojo::Base 'Mojolicious::Plugin';
24 Koha::REST::Plugin::Query
28 =head2 Mojolicious::Plugin methods
35 my ( $self, $app ) = @_;
39 =head3 extract_reserved_params
41 my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($params);
43 Generates the DBIC query from the query parameters.
48 'extract_reserved_params' => sub {
49 my ( $c, $params ) = @_;
54 my $reserved_words = _reserved_words();
56 foreach my $param ( keys %{$params} ) {
57 if ( grep { $param eq $_ } @{$reserved_words} ) {
58 $reserved_params->{$param} = $params->{$param};
61 $filtered_params->{$param} = $params->{$param};
65 return ( $filtered_params, $reserved_params );
69 =head3 dbic_merge_sorting
71 $attributes = $c->dbic_merge_sorting({ attributes => $attributes, params => $params });
73 Generates the DBIC order_by attributes based on I<$params>, and merges into I<$attributes>.
78 'dbic_merge_sorting' => sub {
79 my ( $c, $args ) = @_;
80 my $attributes = $args->{attributes};
82 if ( defined $args->{params}->{_order_by} ) {
83 my @order_by = map { _build_order_atom($_) }
84 @{ $args->{params}->{_order_by} };
85 $attributes->{order_by} = \@order_by;
92 =head3 _build_query_params_from_api
94 my $params = _build_query_params_from_api( $filtered_params, $reserved_params );
96 Builds the params for searching on DBIC based on the selected matching algorithm.
97 Valid options are I<contains>, I<starts_with>, I<ends_with> and I<exact>. Default is
98 I<contains>. If other value is passed, a Koha::Exceptions::WrongParameter exception
104 'build_query_params' => sub {
106 my ( $c, $filtered_params, $reserved_params ) = @_;
109 my $match = $reserved_params->{_match} // 'contains';
111 foreach my $param ( keys %{$filtered_params} ) {
112 if ( $match eq 'contains' ) {
114 { like => '%' . $filtered_params->{$param} . '%' };
116 elsif ( $match eq 'starts_with' ) {
117 $params->{$param} = { like => $filtered_params->{$param} . '%' };
119 elsif ( $match eq 'ends_with' ) {
120 $params->{$param} = { like => '%' . $filtered_params->{$param} };
122 elsif ( $match eq 'exact' ) {
123 $params->{$param} = $filtered_params->{$param};
126 # We should never reach here, because the OpenAPI plugin should
127 # prevent invalid params to be passed
128 Koha::Exceptions::WrongParameter->throw(
129 "Invalid value for _match param ($match)");
138 =head2 Internal methods
140 =head3 _reserved_words
142 my $reserved_words = _reserved_words();
146 sub _reserved_words {
148 my @reserved_words = qw( _match _order_by _page _per_page );
149 return \@reserved_words;
152 =head3 _build_order_atom
154 my $order_atom = _build_order_atom( $string );
156 Parses I<$string> and outputs data valid for using in SQL::Abstract order_by attribute
157 according to the following rules:
160 +string -> I<{ -asc => string }>
161 -string -> I<{ -desc => string }>
165 sub _build_order_atom {
168 if ( $string =~ m/^\+/ or
169 $string =~ m/^\s/ ) {
170 # asc order operator present
171 $string =~ s/^(\+|\s)//;
172 return { -asc => $string };
174 elsif ( $string =~ m/^\-/ ) {
175 # desc order operator present
177 return { -desc => $string };
180 # no order operator present