Bug 21206: (QA follow-up) Rebase problem and leftover mocked GetItem
[koha.git] / C4 / Output.pm
index a5f0dab..71f82e8 100644 (file)
@@ -33,11 +33,9 @@ use URI::Escape;
 use C4::Context;
 use C4::Templates;
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
 
 BEGIN {
-    # set the version for version checking
-    $VERSION = 3.07.00.049;
     require Exporter;
 
  @ISA    = qw(Exporter);
@@ -52,6 +50,7 @@ BEGIN {
     );
     push @EXPORT, qw(
         &output_html_with_http_headers &output_ajax_with_http_headers &output_with_http_headers
+        &output_and_exit_if_error &output_and_exit
     );
 
 }
@@ -63,7 +62,6 @@ C4::Output - Functions for managing output, is slowly being deprecated
 =head1 FUNCTIONS
 
 =over 2
-=cut
 
 =item pagination_bar
 
@@ -85,10 +83,11 @@ This function returns HTML, without any language dependency.
 =cut
 
 sub pagination_bar {
-       my $base_url = (@_ ? shift : $ENV{SCRIPT_NAME} . $ENV{QUERY_STRING}) or return;
+    my $base_url = (@_ ? shift : return);
     my $nb_pages       = (@_) ? shift : 1;
     my $current_page   = (@_) ? shift : undef; # delay default until later
     my $startfrom_name = (@_) ? shift : 'page';
+    my $additional_parameters = shift || {};
 
     # how many pages to show before and after the current page?
     my $pages_around = 2;
@@ -105,6 +104,10 @@ sub pagination_bar {
        $base_url =~ s/$delim$//;               # remove trailing delim
 
     my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&' : '?' ) . $startfrom_name . '=';
+    my $url_suffix;
+    while ( my ( $k, $v ) = each %$additional_parameters ) {
+        $url_suffix .= '&' . $k . '=' . $v;
+    }
     my $pagination_bar = '';
 
     # navigation bar useful only if more than one page to display !
@@ -116,7 +119,9 @@ sub pagination_bar {
                 "\n" . ' '
               . '<a href="'
               . $url
-              . '1" rel="start">'
+              . '1'
+              . $url_suffix
+              . '"rel="start">'
               . '&lt;&lt;' . '</a>';
         }
         else {
@@ -133,6 +138,7 @@ sub pagination_bar {
               . '<a href="'
               . $url
               . $previous
+              . $url_suffix
               . '" rel="prev">' . '&lt;' . '</a>';
         }
         else {
@@ -171,7 +177,9 @@ sub pagination_bar {
                         "\n" . '&nbsp;'
                       . '<a href="'
                       . $url
-                      . $page_number . '">'
+                      . $page_number
+                      . $url_suffix
+                      . '">'
                       . $page_number . '</a>';
                 }
                 $last_displayed_page = $page_number;
@@ -186,6 +194,7 @@ sub pagination_bar {
               . '&nbsp;<a href="'
               . $url
               . $next
+              . $url_suffix
               . '" rel="next">' . '&gt;' . '</a>';
         }
         else {
@@ -199,6 +208,7 @@ sub pagination_bar {
               . '&nbsp;<a href="'
               . $url
               . $nb_pages
+              . $url_suffix
               . '" rel="last">'
               . '&gt;&gt;' . '</a>';
         }
@@ -252,11 +262,12 @@ sub output_with_http_headers {
     my $cache_policy = 'no-cache';
     $cache_policy .= ', no-store, max-age=0' if $extra_options->{force_no_caching};
     my $options = {
-        type    => $content_type_map{$content_type},
-        status  => $status,
-        charset => 'UTF-8',
-        Pragma          => 'no-cache',
-        'Cache-Control' => $cache_policy,
+        type              => $content_type_map{$content_type},
+        status            => $status,
+        charset           => 'UTF-8',
+        Pragma            => 'no-cache',
+        'Cache-Control'   => $cache_policy,
+        'X-Frame-Options' => 'SAMEORIGIN',
     };
     $options->{expires} = 'now' if $extra_options->{force_no_caching};
 
@@ -295,15 +306,66 @@ sub is_ajax {
     return ( $x_req and $x_req =~ /XMLHttpRequest/i ) ? 1 : 0;
 }
 
+=item output_and_exit_if_error
+
+    output_and_exit_if_error( $query, $cookie, $template, $params );
+
+To executed at the beginning of scripts to stop the script at this point if
+some errors are found.
+
+Tests for module 'members':
+* patron is not defined (we are looking for a patron that does no longer exist/never existed)
+* The logged in user cannot see patron's infos (feature 'cannot_see_patron_infos')
+
+Others will be added here depending on the needs (for instance biblio does not exist will be useful).
+
+=cut
+
+sub output_and_exit_if_error {
+    my ( $query, $cookie, $template, $params ) = @_;
+    my $error;
+    if ( $params and exists $params->{module} ) {
+        if ( $params->{module} eq 'members' ) {
+            my $logged_in_user = $params->{logged_in_user};
+            my $current_patron = $params->{current_patron};
+            if ( not $current_patron ) {
+                $error = 'unknown_patron';
+            }
+            elsif( not $logged_in_user->can_see_patron_infos( $current_patron ) ) {
+                $error = 'cannot_see_patron_infos';
+            }
+        }
+    }
+
+    output_and_exit( $query, $cookie, $template, $error ) if $error;
+    return;
+}
+
+=item output_and_exit
+
+    output_and_exit( $query, $cookie, $template, $error );
+
+    $error is a blocking error like biblionumber not found or so.
+    We should output the error and exit.
+
+=cut
+
+sub output_and_exit {
+    my ( $query, $cookie, $template, $error ) = @_;
+    $template->param( blocking_error => $error );
+    output_html_with_http_headers ( $query, $cookie, $template->output );
+    exit;
+}
+
 sub parametrized_url {
     my $url = shift || ''; # ie page.pl?ln={LANG}
     my $vars = shift || {}; # ie { LANG => en }
     my $ret = $url;
     while ( my ($key,$val) = each %$vars) {
-        my $val_url = URI::Escape::uri_escape_utf8($val);
+        my $val_url = URI::Escape::uri_escape_utf8( $val // q{} );
         $ret =~ s/\{$key\}/$val_url/g;
     }
-    $ret =~ s/\{[^\{]*\}//g; # remove not defined vars
+    $ret =~ s/\{[^\{]*\}//g; # remove remaining vars
     return $ret;
 }