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