C4/Output.pm

   1 package C4::Output;
   2
   3 #package to deal with marking up output
   4 #You will need to edit parts of this pm
   5 #set the value of path to be where your html lives
   6
   7 # Copyright 2000-2002 Katipo Communications
   8 #
   9 # This file is part of Koha.
  10 #
  11 # Koha is free software; you can redistribute it and/or modify it
  12 # under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation; either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but
  17 # WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  23
  24
  25 # NOTE: I'm pretty sure this module is deprecated in favor of
  26 # templates.
  27
  28 use strict;
  29 #use warnings; FIXME - Bug 2505
  30
  31 use URI::Escape;
  32
  33 use C4::Context;
  34 use C4::Templates;
  35
  36 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  37
  38 BEGIN {
  39     require Exporter;
  40
  41  @ISA    = qw(Exporter);
  42     @EXPORT_OK = qw(&is_ajax ajax_fail); # More stuff should go here instead
  43     %EXPORT_TAGS = ( all =>[qw(setlanguagecookie pagination_bar parametrized_url
  44                                 &output_with_http_headers &output_ajax_with_http_headers &output_html_with_http_headers)],
  45                     ajax =>[qw(&output_with_http_headers &output_ajax_with_http_headers is_ajax)],
  46                     html =>[qw(&output_with_http_headers &output_html_with_http_headers)]
  47                 );
  48     push @EXPORT, qw(
  49         setlanguagecookie getlanguagecookie pagination_bar parametrized_url
  50     );
  51     push @EXPORT, qw(
  52         &output_html_with_http_headers &output_ajax_with_http_headers &output_with_http_headers
  53         &output_and_exit_if_error &output_and_exit
  54     );
  55
  56 }
  57
  58 =head1 NAME
  59
  60 C4::Output - Functions for managing output, is slowly being deprecated
  61
  62 =head1 FUNCTIONS
  63
  64 =over 2
  65
  66 =item pagination_bar
  67
  68    pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
  69
  70 Build an HTML pagination bar based on the number of page to display, the
  71 current page and the url to give to each page link.
  72
  73 C<$base_url> is the URL for each page link. The
  74 C<$startfrom_name>=page_number is added at the end of the each URL.
  75
  76 C<$nb_pages> is the total number of pages available.
  77
  78 C<$current_page> is the current page number. This page number won't become a
  79 link.
  80
  81 This function returns HTML, without any language dependency.
  82
  83 =cut
  84
  85 sub pagination_bar {
  86     my $base_url = (@_ ? shift : return);
  87     my $nb_pages       = (@_) ? shift : 1;
  88     my $current_page   = (@_) ? shift : undef;  # delay default until later
  89     my $startfrom_name = (@_) ? shift : 'page';
  90     my $additional_parameters = shift || {};
  91
  92     # how many pages to show before and after the current page?
  93     my $pages_around = 2;
  94
  95         my $delim = qr/\&(?:amp;)?|;/;          # "non memory" cluster: no backreference
  96         $base_url =~ s/$delim*\b$startfrom_name=(\d+)//g; # remove previous pagination var
  97     unless (defined $current_page and $current_page > 0 and $current_page <= $nb_pages) {
  98         $current_page = ($1) ? $1 : 1;  # pull current page from param in URL, else default to 1
  99                 # $debug and    # FIXME: use C4::Debug;
 100                 # warn "with QUERY_STRING:" .$ENV{QUERY_STRING}. "\ncurrent_page:$current_page\n1:$1  2:$2  3:$3";
 101     }
 102         $base_url =~ s/($delim)+/$1/g;  # compress duplicate delims
 103         $base_url =~ s/$delim;//g;              # remove empties
 104         $base_url =~ s/$delim$//;               # remove trailing delim
 105
 106     my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&amp;' : '?' ) . $startfrom_name . '=';
 107     my $url_suffix;
 108     while ( my ( $k, $v ) = each %$additional_parameters ) {
 109         $url_suffix .= '&amp;' . $k . '=' . $v;
 110     }
 111     my $pagination_bar = '';
 112
 113     # navigation bar useful only if more than one page to display !
 114     if ( $nb_pages > 1 ) {
 115
 116         # link to first page?
 117         if ( $current_page > 1 ) {
 118             $pagination_bar .=
 119                 "\n" . '&nbsp;'
 120               . '<a href="'
 121               . $url
 122               . '1'
 123               . $url_suffix
 124               . '"rel="start">'
 125               . '&lt;&lt;' . '</a>';
 126         }
 127         else {
 128             $pagination_bar .=
 129               "\n" . '&nbsp;<span class="inactive">&lt;&lt;</span>';
 130         }
 131
 132         # link on previous page ?
 133         if ( $current_page > 1 ) {
 134             my $previous = $current_page - 1;
 135
 136             $pagination_bar .=
 137                 "\n" . '&nbsp;'
 138               . '<a href="'
 139               . $url
 140               . $previous
 141               . $url_suffix
 142               . '" rel="prev">' . '&lt;' . '</a>';
 143         }
 144         else {
 145             $pagination_bar .=
 146               "\n" . '&nbsp;<span class="inactive">&lt;</span>';
 147         }
 148
 149         my $min_to_display      = $current_page - $pages_around;
 150         my $max_to_display      = $current_page + $pages_around;
 151         my $last_displayed_page = undef;
 152
 153         for my $page_number ( 1 .. $nb_pages ) {
 154             if (
 155                    $page_number == 1
 156                 or $page_number == $nb_pages
 157                 or (    $page_number >= $min_to_display
 158                     and $page_number <= $max_to_display )
 159               )
 160             {
 161                 if ( defined $last_displayed_page
 162                     and $last_displayed_page != $page_number - 1 )
 163                 {
 164                     $pagination_bar .=
 165                       "\n" . '&nbsp;<span class="inactive">...</span>';
 166                 }
 167
 168                 if ( $page_number == $current_page ) {
 169                     $pagination_bar .=
 170                         "\n" . '&nbsp;'
 171                       . '<span class="currentPage">'
 172                       . $page_number
 173                       . '</span>';
 174                 }
 175                 else {
 176                     $pagination_bar .=
 177                         "\n" . '&nbsp;'
 178                       . '<a href="'
 179                       . $url
 180                       . $page_number
 181                       . $url_suffix
 182                       . '">'
 183                       . $page_number . '</a>';
 184                 }
 185                 $last_displayed_page = $page_number;
 186             }
 187         }
 188
 189         # link on next page?
 190         if ( $current_page < $nb_pages ) {
 191             my $next = $current_page + 1;
 192
 193             $pagination_bar .= "\n"
 194               . '&nbsp;<a href="'
 195               . $url
 196               . $next
 197               . $url_suffix
 198               . '" rel="next">' . '&gt;' . '</a>';
 199         }
 200         else {
 201             $pagination_bar .=
 202               "\n" . '&nbsp;<span class="inactive">&gt;</span>';
 203         }
 204
 205         # link to last page?
 206         if ( $current_page != $nb_pages ) {
 207             $pagination_bar .= "\n"
 208               . '&nbsp;<a href="'
 209               . $url
 210               . $nb_pages
 211               . $url_suffix
 212               . '" rel="last">'
 213               . '&gt;&gt;' . '</a>';
 214         }
 215         else {
 216             $pagination_bar .=
 217               "\n" . '&nbsp;<span class="inactive">&gt;&gt;</span>';
 218         }
 219     }
 220
 221     return $pagination_bar;
 222 }
 223
 224 =item output_with_http_headers
 225
 226    &output_with_http_headers($query, $cookie, $data, $content_type[, $status[, $extra_options]])
 227
 228 Outputs $data with the appropriate HTTP headers,
 229 the authentication cookie $cookie and a Content-Type specified in
 230 $content_type.
 231
 232 If applicable, $cookie can be undef, and it will not be sent.
 233
 234 $content_type is one of the following: 'html', 'js', 'json', 'xml', 'rss', or 'atom'.
 235
 236 $status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.
 237
 238 $extra_options is hashref.  If the key 'force_no_caching' is present and has
 239 a true value, the HTTP headers include directives to force there to be no
 240 caching whatsoever.
 241
 242 =cut
 243
 244 sub output_with_http_headers {
 245     my ( $query, $cookie, $data, $content_type, $status, $extra_options ) = @_;
 246     $status ||= '200 OK';
 247
 248     $extra_options //= {};
 249
 250     my %content_type_map = (
 251         'html' => 'text/html',
 252         'js'   => 'text/javascript',
 253         'json' => 'application/json',
 254         'xml'  => 'text/xml',
 255         # NOTE: not using application/atom+xml or application/rss+xml because of
 256         # Internet Explorer 6; see bug 2078.
 257         'rss'  => 'text/xml',
 258         'atom' => 'text/xml'
 259     );
 260
 261     die "Unknown content type '$content_type'" if ( !defined( $content_type_map{$content_type} ) );
 262     my $cache_policy = 'no-cache';
 263     $cache_policy .= ', no-store, max-age=0' if $extra_options->{force_no_caching};
 264     my $options = {
 265         type              => $content_type_map{$content_type},
 266         status            => $status,
 267         charset           => 'UTF-8',
 268         Pragma            => 'no-cache',
 269         'Cache-Control'   => $cache_policy,
 270         'X-Frame-Options' => 'SAMEORIGIN',
 271     };
 272     $options->{expires} = 'now' if $extra_options->{force_no_caching};
 273
 274     $options->{cookie} = $cookie if $cookie;
 275     if ($content_type eq 'html') {  # guaranteed to be one of the content_type_map keys, else we'd have died
 276         $options->{'Content-Style-Type' } = 'text/css';
 277         $options->{'Content-Script-Type'} = 'text/javascript';
 278     }
 279
 280 # We can't encode here, that will double encode our templates, and xslt
 281 # We need to fix the encoding as it comes out of the database, or when we pass the variables to templates
 282
 283     $data =~ s/\&amp\;amp\; /\&amp\; /g;
 284     print $query->header($options), $data;
 285 }
 286
 287 sub output_html_with_http_headers {
 288     my ( $query, $cookie, $data, $status, $extra_options ) = @_;
 289     output_with_http_headers( $query, $cookie, $data, 'html', $status, $extra_options );
 290 }
 291
 292
 293 sub output_ajax_with_http_headers {
 294     my ( $query, $js ) = @_;
 295     print $query->header(
 296         -type            => 'text/javascript',
 297         -charset         => 'UTF-8',
 298         -Pragma          => 'no-cache',
 299         -'Cache-Control' => 'no-cache',
 300         -expires         => '-1d',
 301     ), $js;
 302 }
 303
 304 sub is_ajax {
 305     my $x_req = $ENV{HTTP_X_REQUESTED_WITH};
 306     return ( $x_req and $x_req =~ /XMLHttpRequest/i ) ? 1 : 0;
 307 }
 308
 309 =item output_and_exit_if_error
 310
 311     output_and_exit_if_error( $query, $cookie, $template, $params );
 312
 313 To executed at the beginning of scripts to stop the script at this point if
 314 some errors are found.
 315
 316 Tests for module 'members':
 317 * patron is not defined (we are looking for a patron that does no longer exist/never existed)
 318 * The logged in user cannot see patron's infos (feature 'cannot_see_patron_infos')
 319
 320 Others will be added here depending on the needs (for instance biblio does not exist will be useful).
 321
 322 =cut
 323
 324 sub output_and_exit_if_error {
 325     my ( $query, $cookie, $template, $params ) = @_;
 326     my $error;
 327     if ( $params and exists $params->{module} ) {
 328         if ( $params->{module} eq 'members' ) {
 329             my $logged_in_user = $params->{logged_in_user};
 330             my $current_patron = $params->{current_patron};
 331             if ( not $current_patron ) {
 332                 $error = 'unknown_patron';
 333             }
 334             elsif( not $logged_in_user->can_see_patron_infos( $current_patron ) ) {
 335                 $error = 'cannot_see_patron_infos';
 336             }
 337         }
 338     }
 339
 340     output_and_exit( $query, $cookie, $template, $error ) if $error;
 341     return;
 342 }
 343
 344 =item output_and_exit
 345
 346     output_and_exit( $query, $cookie, $template, $error );
 347
 348     $error is a blocking error like biblionumber not found or so.
 349     We should output the error and exit.
 350
 351 =cut
 352
 353 sub output_and_exit {
 354     my ( $query, $cookie, $template, $error ) = @_;
 355     $template->param( blocking_error => $error );
 356     output_html_with_http_headers ( $query, $cookie, $template->output );
 357     exit;
 358 }
 359
 360 sub parametrized_url {
 361     my $url = shift || ''; # ie page.pl?ln={LANG}
 362     my $vars = shift || {}; # ie { LANG => en }
 363     my $ret = $url;
 364     while ( my ($key,$val) = each %$vars) {
 365         my $val_url = URI::Escape::uri_escape_utf8( $val // q{} );
 366         $ret =~ s/\{$key\}/$val_url/g;
 367     }
 368     $ret =~ s/\{[^\{]*\}//g; # remove remaining vars
 369     return $ret;
 370 }
 371
 372 END { }    # module clean-up code here (global destructor)
 373
 374 1;
 375 __END__
 376
 377 =back
 378
 379 =head1 AUTHOR
 380
 381 Koha Development Team <http://koha-community.org/>
 382
 383 =cut