Koha/REST/Plugin/Query.pm

   1 package Koha::REST::Plugin::Query;
   2
   3 # This file is part of Koha.
   4 #
   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
   8 # version.
   9 #
  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.
  13 #
  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.
  17
  18 use Modern::Perl;
  19
  20 use Mojo::Base 'Mojolicious::Plugin';
  21
  22 =head1 NAME
  23
  24 Koha::REST::Plugin::Query
  25
  26 =head1 API
  27
  28 =head2 Mojolicious::Plugin methods
  29
  30 =head3 register
  31
  32 =cut
  33
  34 sub register {
  35     my ( $self, $app ) = @_;
  36
  37 =head2 Helper methods
  38
  39 =head3 extract_reserved_params
  40
  41     my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($params);
  42
  43 Generates the DBIC query from the query parameters.
  44
  45 =cut
  46
  47     $app->helper(
  48         'extract_reserved_params' => sub {
  49             my ( $c, $params ) = @_;
  50
  51             my $reserved_params;
  52             my $filtered_params;
  53
  54             my $reserved_words = _reserved_words();
  55
  56             foreach my $param ( keys %{$params} ) {
  57                 if ( grep { $param eq $_ } @{$reserved_words} ) {
  58                     $reserved_params->{$param} = $params->{$param};
  59                 }
  60                 else {
  61                     $filtered_params->{$param} = $params->{$param};
  62                 }
  63             }
  64
  65             return ( $filtered_params, $reserved_params );
  66         }
  67     );
  68
  69 =head3 dbic_merge_sorting
  70
  71     $attributes = $c->dbic_merge_sorting({ attributes => $attributes, params => $params });
  72
  73 Generates the DBIC order_by attributes based on I<$params>, and merges into I<$attributes>.
  74
  75 =cut
  76
  77     $app->helper(
  78         'dbic_merge_sorting' => sub {
  79             my ( $c, $args ) = @_;
  80             my $attributes = $args->{attributes};
  81
  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;
  86             }
  87
  88             return $attributes;
  89         }
  90     );
  91 }
  92
  93 =head2 Internal methods
  94
  95 =head3 _reserved_words
  96
  97     my $reserved_words = _reserved_words();
  98
  99 =cut
 100
 101 sub _reserved_words {
 102
 103     my @reserved_words = qw( _match _order_by _page _per_page );
 104     return \@reserved_words;
 105 }
 106
 107 =head3 _build_order_atom
 108
 109     my $order_atom = _build_order_atom( $string );
 110
 111 Parses I<$string> and outputs data valid for using in SQL::Abstract order_by attribute
 112 according to the following rules:
 113
 114      string -> I<string>
 115     +string -> I<{ -asc => string }>
 116     -string -> I<{ -desc => string }>
 117
 118 =cut
 119
 120 sub _build_order_atom {
 121     my $string = shift;
 122
 123     if ( $string =~ m/^\+/ or
 124          $string =~ m/^\s/ ) {
 125         # asc order operator present
 126         $string =~ s/^(\+|\s)//;
 127         return { -asc => $string };
 128     }
 129     elsif ( $string =~ m/^\-/ ) {
 130         # desc order operator present
 131         $string =~ s/^\-//;
 132         return { -desc => $string };
 133     }
 134     else {
 135         # no order operator present
 136         return $string;
 137     }
 138 }
 139
 140 1;