Koha/REST/V1/ArticleRequests.pm

   1 package Koha::REST::V1::ArticleRequests;
   2
   3 # This file is part of Koha.
   4 #
   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.
   9 #
  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.
  14 #
  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>.
  17
  18 use Modern::Perl;
  19
  20 use Mojo::Base 'Mojolicious::Controller';
  21
  22 use Koha::Database;
  23 use Koha::ArticleRequests;
  24
  25 use Scalar::Util qw( blessed );
  26 use Try::Tiny qw( catch try );
  27
  28 =head1 NAME
  29
  30 Koha::REST::V1::ArticleRequests
  31
  32 =head1 API
  33
  34 =head2 Methods
  35
  36 =head3 cancel
  37
  38 Controller function that handles cancelling a Koha::ArticleRequest object
  39
  40 =cut
  41
  42 sub cancel {
  43     my $c = shift->openapi->valid_input or return;
  44
  45     my $article_request = Koha::ArticleRequests->find( $c->validation->param('article_request_id') );
  46
  47     unless ( $article_request ) {
  48         return $c->render(
  49             status  => 404,
  50             openapi => { error => "Article request not found" }
  51         );
  52     }
  53
  54     my $reason = $c->validation->param('cancellation_reason');
  55     my $notes = $c->validation->param('notes');
  56
  57     return try {
  58
  59         $article_request->cancel($reason, $notes);
  60         return $c->render(
  61             status  => 204,
  62             openapi => q{}
  63         );
  64     } catch {
  65         $c->unhandled_exception($_);
  66     };
  67 }
  68
  69 =head3 patron_cancel (public route)
  70
  71 Controller function that handles cancelling a patron's Koha::ArticleRequest object
  72
  73 =cut
  74
  75 sub patron_cancel {
  76     my $c = shift->openapi->valid_input or return;
  77
  78     my $patron = Koha::Patrons->find( $c->validation->param('patron_id') );
  79
  80     unless ( $patron ) {
  81         return $c->render(
  82             status  => 404,
  83             openapi => { error => "Patron not found" }
  84         );
  85     }
  86
  87     # patron_id has been validated by the allow-owner check, so the following call to related
  88     # article requests covers the case of article requests not belonging to the patron
  89     my $article_request = $patron->article_requests->find( $c->validation->param('article_request_id') );
  90
  91     unless ( $article_request ) {
  92         return $c->render(
  93             status  => 404,
  94             openapi => { error => "Article request not found" }
  95         );
  96     }
  97
  98     my $reason = $c->validation->param('cancellation_reason');
  99     my $notes = $c->validation->param('notes');
 100
 101     return try {
 102
 103         $article_request->cancel( $reason, $notes );
 104         return $c->render(
 105             status  => 204,
 106             openapi => q{}
 107         );
 108     }
 109     catch {
 110         $c->unhandled_exception($_);
 111     };
 112 }
 113
 114 1;