Koha/Util/Navigation.pm

   1 package Koha::Util::Navigation;
   2
   3 # Copyright Rijksmuseum 2018
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21 use C4::Context;
  22
  23 =head1 NAME
  24
  25 Koha::Util
  26
  27 =head1 SYNOPSIS
  28
  29     use Koha::Util::Navigation;
  30     my $cgi = CGI->new;
  31     my $referer = Koha::Util::Navigation::local_referer($cgi);
  32
  33 =head1 DESCRIPTION
  34
  35 Utility class
  36
  37 =head1 FUNCTIONS
  38
  39 =head2 local_referer
  40
  41     my $referer = Koha::Util::Navigation::local_referer( $cgi, { fallback => '/', remove_language => 1, staff => 1 });
  42
  43     If the referer is a local URI, return local path.
  44     Otherwise return fallback.
  45     Optional parameters fallback, remove_language and staff. If you do not
  46     pass staff, opac is assumed.
  47
  48 =cut
  49
  50 sub local_referer {
  51     my ( $cgi, $params ) = @_;
  52     my $referer = $cgi->referer;
  53     my $fallback = $params->{fallback} // '/';
  54     my $staff = $params->{staff}; # no staff means OPAC
  55     return $fallback if !$referer;
  56
  57     my $base = C4::Context->preference($staff ? 'staffClientBaseURL' : 'OPACBaseURL');
  58     my $rv;
  59
  60     # Try ..BaseURL first, otherwise use CGI::url
  61     if( $base ) {
  62         if( $referer =~ m|^\Q$base\E|i &&
  63             $referer =~ /\/cgi-bin\/koha\// )
  64         {
  65             $rv = substr( $referer, length($base) );
  66             $rv =~ s/^\///;
  67             $rv = '/'.$rv;
  68         }
  69     } else {
  70         my $cgibase = $cgi->url( -base => 1 );
  71         $cgibase =~ s/^https?://;
  72         if( $referer =~ /$cgibase(\/cgi-bin\/koha\/.*)$/ ) {
  73             $rv = $1;
  74         }
  75     }
  76     $rv =~ s/(?<=[?&])language=[\w-]+(&|$)// if $rv and $params->{remove_language};
  77     return $rv // $fallback;
  78 }
  79
  80 1;
  81
  82 =head1 AUTHOR
  83
  84     Marcel de Rooy, Rijksmuseum Amsterdam, The Netherlands
  85     Koha development team
  86
  87 =cut