Koha/REST/Plugin/Exceptions.pm

   1 package Koha::REST::Plugin::Exceptions;
   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 Scalar::Util qw( blessed );
  21 use Koha::Logger;
  22
  23 use Mojo::Base 'Mojolicious::Plugin';
  24
  25 =head1 NAME
  26
  27 Koha::REST::Plugin::Exceptions
  28
  29 =head1 API
  30
  31 =head2 Helper methods
  32
  33 =head3 unhandled_exception
  34
  35     try {
  36         ...
  37     }
  38     catch {
  39         if ( know_exception ) {
  40             handle_known_exception($_);
  41         }
  42
  43         $c->unhandled_exception($_);
  44     }
  45
  46 Provides a generic and reusable way to throw unhandled exceptions. This way we
  47 can centralize the behaviour control (e.g. production vs. development environmet)
  48
  49 =cut
  50
  51 sub register {
  52     my ( $self, $app ) = @_;
  53
  54     $app->helper(
  55         'unhandled_exception' => sub {
  56             my ( $c, $exception ) = @_;
  57
  58             my $req    = $c->req;
  59             my $method = $req->method;
  60             my $path   = $req->url->to_abs->path;
  61             my $type = "";
  62
  63             if ( blessed $exception ) {
  64                 $type = "(" . ref($exception) . ")";
  65             }
  66
  67             my $exception_string = "$exception";
  68             chomp($exception_string);
  69
  70             my $message = "$method $path: unhandled exception $type\<\<$exception_string\>\>";
  71
  72             my $logger = Koha::Logger->get({ interface => 'api' });
  73             $logger->error("$message");
  74
  75             $c->render(
  76                 status  => 500,
  77                 openapi => {
  78                     error =>
  79                       "Something went wrong, check Koha logs for details."
  80                 }
  81             );
  82           }
  83
  84     );
  85 }
  86
  87 1;