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 under the
  12 # terms of the GNU General Public License as published by the Free Software
  13 # Foundation; either version 2 of the License, or (at your option) any later
  14 # version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  18 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License along
  21 # with Koha; if not, write to the Free Software Foundation, Inc.,
  22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  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::Dates qw(format_date);
  35 use C4::Budgets qw(GetCurrency);
  36 use C4::Templates;
  37
  38 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  39
  40 BEGIN {
  41     # set the version for version checking
  42     $VERSION = 3.07.00.049;
  43     require Exporter;
  44
  45  @ISA    = qw(Exporter);
  46     @EXPORT_OK = qw(&is_ajax ajax_fail); # More stuff should go here instead
  47     %EXPORT_TAGS = ( all =>[qw(setlanguagecookie pagination_bar parametrized_url
  48                                 &output_with_http_headers &output_ajax_with_http_headers &output_html_with_http_headers)],
  49                     ajax =>[qw(&output_with_http_headers &output_ajax_with_http_headers is_ajax)],
  50                     html =>[qw(&output_with_http_headers &output_html_with_http_headers)]
  51                 );
  52     push @EXPORT, qw(
  53         setlanguagecookie getlanguagecookie pagination_bar parametrized_url
  54     );
  55     push @EXPORT, qw(
  56         &output_html_with_http_headers &output_ajax_with_http_headers &output_with_http_headers
  57     );
  58
  59 }
  60
  61 =head1 NAME
  62
  63 C4::Output - Functions for managing output, is slowly being deprecated
  64
  65 =head1 FUNCTIONS
  66
  67 =over 2
  68 =cut
  69
  70 =item pagination_bar
  71
  72    pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
  73
  74 Build an HTML pagination bar based on the number of page to display, the
  75 current page and the url to give to each page link.
  76
  77 C<$base_url> is the URL for each page link. The
  78 C<$startfrom_name>=page_number is added at the end of the each URL.
  79
  80 C<$nb_pages> is the total number of pages available.
  81
  82 C<$current_page> is the current page number. This page number won't become a
  83 link.
  84
  85 This function returns HTML, without any language dependency.
  86
  87 =cut
  88
  89 sub pagination_bar {
  90         my $base_url = (@_ ? shift : $ENV{SCRIPT_NAME} . $ENV{QUERY_STRING}) or return;
  91     my $nb_pages       = (@_) ? shift : 1;
  92     my $current_page   = (@_) ? shift : undef;  # delay default until later
  93     my $startfrom_name = (@_) ? shift : 'page';
  94
  95     # how many pages to show before and after the current page?
  96     my $pages_around = 2;
  97
  98         my $delim = qr/\&(?:amp;)?|;/;          # "non memory" cluster: no backreference
  99         $base_url =~ s/$delim*\b$startfrom_name=(\d+)//g; # remove previous pagination var
 100     unless (defined $current_page and $current_page > 0 and $current_page <= $nb_pages) {
 101         $current_page = ($1) ? $1 : 1;  # pull current page from param in URL, else default to 1
 102                 # $debug and    # FIXME: use C4::Debug;
 103                 # warn "with QUERY_STRING:" .$ENV{QUERY_STRING}. "\ncurrent_page:$current_page\n1:$1  2:$2  3:$3";
 104     }
 105         $base_url =~ s/($delim)+/$1/g;  # compress duplicate delims
 106         $base_url =~ s/$delim;//g;              # remove empties
 107         $base_url =~ s/$delim$//;               # remove trailing delim
 108
 109     my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&amp;' : '?' ) . $startfrom_name . '=';
 110     my $pagination_bar = '';
 111
 112     # navigation bar useful only if more than one page to display !
 113     if ( $nb_pages > 1 ) {
 114
 115         # link to first page?
 116         if ( $current_page > 1 ) {
 117             $pagination_bar .=
 118                 "\n" . '&nbsp;'
 119               . '<a href="'
 120               . $url
 121               . '1" rel="start">'
 122               . '&lt;&lt;' . '</a>';
 123         }
 124         else {
 125             $pagination_bar .=
 126               "\n" . '&nbsp;<span class="inactive">&lt;&lt;</span>';
 127         }
 128
 129         # link on previous page ?
 130         if ( $current_page > 1 ) {
 131             my $previous = $current_page - 1;
 132
 133             $pagination_bar .=
 134                 "\n" . '&nbsp;'
 135               . '<a href="'
 136               . $url
 137               . $previous
 138               . '" rel="prev">' . '&lt;' . '</a>';
 139         }
 140         else {
 141             $pagination_bar .=
 142               "\n" . '&nbsp;<span class="inactive">&lt;</span>';
 143         }
 144
 145         my $min_to_display      = $current_page - $pages_around;
 146         my $max_to_display      = $current_page + $pages_around;
 147         my $last_displayed_page = undef;
 148
 149         for my $page_number ( 1 .. $nb_pages ) {
 150             if (
 151                    $page_number == 1
 152                 or $page_number == $nb_pages
 153                 or (    $page_number >= $min_to_display
 154                     and $page_number <= $max_to_display )
 155               )
 156             {
 157                 if ( defined $last_displayed_page
 158                     and $last_displayed_page != $page_number - 1 )
 159                 {
 160                     $pagination_bar .=
 161                       "\n" . '&nbsp;<span class="inactive">...</span>';
 162                 }
 163
 164                 if ( $page_number == $current_page ) {
 165                     $pagination_bar .=
 166                         "\n" . '&nbsp;'
 167                       . '<span class="currentPage">'
 168                       . $page_number
 169                       . '</span>';
 170                 }
 171                 else {
 172                     $pagination_bar .=
 173                         "\n" . '&nbsp;'
 174                       . '<a href="'
 175                       . $url
 176                       . $page_number . '">'
 177                       . $page_number . '</a>';
 178                 }
 179                 $last_displayed_page = $page_number;
 180             }
 181         }
 182
 183         # link on next page?
 184         if ( $current_page < $nb_pages ) {
 185             my $next = $current_page + 1;
 186
 187             $pagination_bar .= "\n"
 188               . '&nbsp;<a href="'
 189               . $url
 190               . $next
 191               . '" rel="next">' . '&gt;' . '</a>';
 192         }
 193         else {
 194             $pagination_bar .=
 195               "\n" . '&nbsp;<span class="inactive">&gt;</span>';
 196         }
 197
 198         # link to last page?
 199         if ( $current_page != $nb_pages ) {
 200             $pagination_bar .= "\n"
 201               . '&nbsp;<a href="'
 202               . $url
 203               . $nb_pages
 204               . '" rel="last">'
 205               . '&gt;&gt;' . '</a>';
 206         }
 207         else {
 208             $pagination_bar .=
 209               "\n" . '&nbsp;<span class="inactive">&gt;&gt;</span>';
 210         }
 211     }
 212
 213     return $pagination_bar;
 214 }
 215
 216 =item output_with_http_headers
 217
 218    &output_with_http_headers($query, $cookie, $data, $content_type[, $status[, $extra_options]])
 219
 220 Outputs $data with the appropriate HTTP headers,
 221 the authentication cookie $cookie and a Content-Type specified in
 222 $content_type.
 223
 224 If applicable, $cookie can be undef, and it will not be sent.
 225
 226 $content_type is one of the following: 'html', 'js', 'json', 'xml', 'rss', or 'atom'.
 227
 228 $status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.
 229
 230 $extra_options is hashref.  If the key 'force_no_caching' is present and has
 231 a true value, the HTTP headers include directives to force there to be no
 232 caching whatsoever.
 233
 234 =cut
 235
 236 sub output_with_http_headers {
 237     my ( $query, $cookie, $data, $content_type, $status, $extra_options ) = @_;
 238     $status ||= '200 OK';
 239
 240     $extra_options //= {};
 241
 242     my %content_type_map = (
 243         'html' => 'text/html',
 244         'js'   => 'text/javascript',
 245         'json' => 'application/json',
 246         'xml'  => 'text/xml',
 247         # NOTE: not using application/atom+xml or application/rss+xml because of
 248         # Internet Explorer 6; see bug 2078.
 249         'rss'  => 'text/xml',
 250         'atom' => 'text/xml'
 251     );
 252
 253     die "Unknown content type '$content_type'" if ( !defined( $content_type_map{$content_type} ) );
 254     my $cache_policy = 'no-cache';
 255     $cache_policy .= ', no-store, max-age=0' if $extra_options->{force_no_caching};
 256     my $options = {
 257         type    => $content_type_map{$content_type},
 258         status  => $status,
 259         charset => 'UTF-8',
 260         Pragma          => 'no-cache',
 261         'Cache-Control' => $cache_policy,
 262     };
 263     $options->{expires} = 'now' if $extra_options->{force_no_caching};
 264
 265     $options->{cookie} = $cookie if $cookie;
 266     if ($content_type eq 'html') {  # guaranteed to be one of the content_type_map keys, else we'd have died
 267         $options->{'Content-Style-Type' } = 'text/css';
 268         $options->{'Content-Script-Type'} = 'text/javascript';
 269     }
 270
 271 # We can't encode here, that will double encode our templates, and xslt
 272 # We need to fix the encoding as it comes out of the database, or when we pass the variables to templates
 273
 274     $data =~ s/\&amp\;amp\; /\&amp\; /g;
 275     print $query->header($options), $data;
 276 }
 277
 278 sub output_html_with_http_headers {
 279     my ( $query, $cookie, $data, $status, $extra_options ) = @_;
 280     output_with_http_headers( $query, $cookie, $data, 'html', $status, $extra_options );
 281 }
 282
 283
 284 sub output_ajax_with_http_headers {
 285     my ( $query, $js ) = @_;
 286     print $query->header(
 287         -type            => 'text/javascript',
 288         -charset         => 'UTF-8',
 289         -Pragma          => 'no-cache',
 290         -'Cache-Control' => 'no-cache',
 291         -expires         => '-1d',
 292     ), $js;
 293 }
 294
 295 sub is_ajax {
 296     my $x_req = $ENV{HTTP_X_REQUESTED_WITH};
 297     return ( $x_req and $x_req =~ /XMLHttpRequest/i ) ? 1 : 0;
 298 }
 299
 300 sub parametrized_url {
 301     my $url = shift || ''; # ie page.pl?ln={LANG}
 302     my $vars = shift || {}; # ie { LANG => en }
 303     my $ret = $url;
 304     while ( my ($key,$val) = each %$vars) {
 305         my $val_url = URI::Escape::uri_escape_utf8($val);
 306         $ret =~ s/\{$key\}/$val_url/g;
 307     }
 308     $ret =~ s/\{[^\{]*\}//g; # remove not defined vars
 309     return $ret;
 310 }
 311
 312 END { }    # module clean-up code here (global destructor)
 313
 314 1;
 315 __END__
 316
 317 =back
 318
 319 =head1 AUTHOR
 320
 321 Koha Development Team <http://koha-community.org/>
 322
 323 =cut