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 with
  21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  22 # Suite 330, Boston, MA  02111-1307 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;
  30
  31 use C4::Context;
  32 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
  33
  34 use HTML::Template::Pro;
  35 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  36
  37 BEGIN {
  38     # set the version for version checking
  39     $VERSION = 3.03;
  40     require Exporter;
  41     @ISA    = qw(Exporter);
  42         @EXPORT_OK = qw(&is_ajax ajax_fail); # More stuff should go here instead
  43         %EXPORT_TAGS = ( all =>[qw(&themelanguage &gettemplate setlanguagecookie pagination_bar
  44                                                                 &output_with_http_headers &output_html_with_http_headers)],
  45                                         ajax =>[qw(&output_with_http_headers is_ajax)],
  46                                         html =>[qw(&output_with_http_headers &output_html_with_http_headers)]
  47                                 );
  48     push @EXPORT, qw(
  49         &themelanguage &gettemplate setlanguagecookie pagination_bar
  50     );
  51     push @EXPORT, qw(
  52         &output_html_with_http_headers &output_with_http_headers
  53     );
  54 }
  55
  56 =head1 NAME
  57
  58 C4::Output - Functions for managing templates
  59
  60 =head1 FUNCTIONS
  61
  62 =over 2
  63
  64 =cut
  65
  66 #FIXME: this is a quick fix to stop rc1 installing broken
  67 #Still trying to figure out the correct fix.
  68 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
  69
  70 #---------------------------------------------------------------------------------------------------------
  71 # FIXME - POD
  72 sub gettemplate {
  73     my ( $tmplbase, $interface, $query ) = @_;
  74     ($query) or warn "no query in gettemplate";
  75     my $htdocs;
  76     if ( $interface ne "intranet" ) {
  77         $htdocs = C4::Context->config('opachtdocs');
  78     }
  79     else {
  80         $htdocs = C4::Context->config('intrahtdocs');
  81     }
  82     my $path = C4::Context->preference('intranet_includes') || 'includes';
  83     my ( $theme, $lang ) = themelanguage( $htdocs, $tmplbase, $interface, $query );
  84
  85     # if the template doesn't exist, load the English one as a last resort
  86     my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
  87     unless (-f $filename) {
  88         $lang = 'en';
  89         $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
  90     }
  91     my $template       = HTML::Template::Pro->new(
  92         filename          => $filename,
  93         die_on_bad_params => 1,
  94         global_vars       => 1,
  95         case_sensitive    => 1,
  96         loop_context_vars => 1, # enable: __first__, __last__, __inner__, __odd__, __counter__
  97         path              => ["$htdocs/$theme/$lang/$path"]
  98     );
  99     my $themelang=( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' )
 100           . "/$theme/$lang";
 101     $template->param(
 102         themelang => $themelang,
 103         yuipath   => (C4::Context->preference("yuipath") eq "local"?"$themelang/lib/yui":C4::Context->preference("yuipath")),
 104         interface => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' ),
 105         theme     => $theme,
 106         lang      => $lang
 107     );
 108
 109     # Bidirectionality
 110     my $current_lang = regex_lang_subtags($lang);
 111     my $bidi;
 112     $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
 113     # Languages
 114     my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
 115     my $num_languages_enabled = 0;
 116     foreach my $lang (@$languages_loop) {
 117         foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
 118             $num_languages_enabled++ if $sublang->{enabled};
 119          }
 120     }
 121     $template->param(
 122             languages_loop       => $languages_loop,
 123             bidi                 => $bidi,
 124             one_language_enabled => ($num_languages_enabled <= 1) ? 1 : 0, # deal with zero enabled langs as well
 125     ) unless @$languages_loop<2;
 126
 127     return $template;
 128 }
 129
 130 #---------------------------------------------------------------------------------------------------------
 131 # FIXME - POD
 132 sub themelanguage {
 133     my ( $htdocs, $tmpl, $interface, $query ) = @_;
 134     ($query) or warn "no query in themelanguage";
 135
 136     # Set some defaults for language and theme
 137     # First, check the user's preferences
 138     my $lang;
 139     my $http_accept_language = $ENV{ HTTP_ACCEPT_LANGUAGE };
 140     $lang = accept_language( $http_accept_language,
 141               getTranslatedLanguages($interface,'prog') )
 142       if $http_accept_language;
 143     # But, if there's a cookie set, obey it
 144     $lang = $query->cookie('KohaOpacLanguage') if $query->cookie('KohaOpacLanguage');
 145     # Fall back to English
 146     my @languages;
 147     if ($interface eq 'intranet') {
 148         @languages = split ",", C4::Context->preference("language");
 149     } else {
 150         @languages = split ",", C4::Context->preference("opaclanguages");
 151     }
 152     if ($lang){
 153         @languages=($lang,@languages);
 154     } else {
 155         $lang = $languages[0];
 156     }
 157     my $theme = 'prog'; # in the event of theme failure default to 'prog' -fbcit
 158     my $dbh = C4::Context->dbh;
 159     my @themes;
 160     if ( $interface eq "intranet" ) {
 161         @themes    = split " ", C4::Context->preference("template");
 162     }
 163     else {
 164       # we are in the opac here, what im trying to do is let the individual user
 165       # set the theme they want to use.
 166       # and perhaps the them as well.
 167         #my $lang = $query->cookie('KohaOpacLanguage');
 168         @themes = split " ", C4::Context->preference("opacthemes");
 169     }
 170
 171  # searches through the themes and languages. First template it find it returns.
 172  # Priority is for getting the theme right.
 173     THEME:
 174     foreach my $th (@themes) {
 175         foreach my $la (@languages) {
 176             #for ( my $pass = 1 ; $pass <= 2 ; $pass += 1 ) {
 177                 # warn "$htdocs/$th/$la/modules/$interface-"."tmpl";
 178                 #$la =~ s/([-_])/ $1 eq '-'? '_': '-' /eg if $pass == 2;
 179                                 if ( -e "$htdocs/$th/$la/modules/$tmpl") {
 180                 #".($interface eq 'intranet'?"modules":"")."/$tmpl" ) {
 181                     $theme = $th;
 182                     $lang  = $la;
 183                     last THEME;
 184                 }
 185                 last unless $la =~ /[-_]/;
 186             #}
 187         }
 188     }
 189     return ( $theme, $lang );
 190 }
 191
 192 sub setlanguagecookie {
 193     my ( $query, $language, $uri ) = @_;
 194     my $cookie = $query->cookie(
 195         -name    => 'KohaOpacLanguage',
 196         -value   => $language,
 197         -expires => ''
 198     );
 199     print $query->redirect(
 200         -uri    => $uri,
 201         -cookie => $cookie
 202     );
 203 }
 204
 205 =item pagination_bar
 206
 207    pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
 208
 209 Build an HTML pagination bar based on the number of page to display, the
 210 current page and the url to give to each page link.
 211
 212 C<$base_url> is the URL for each page link. The
 213 C<$startfrom_name>=page_number is added at the end of the each URL.
 214
 215 C<$nb_pages> is the total number of pages available.
 216
 217 C<$current_page> is the current page number. This page number won't become a
 218 link.
 219
 220 This function returns HTML, without any language dependency.
 221
 222 =cut
 223
 224 sub pagination_bar {
 225         my $base_url = (@_ ? shift : $ENV{SCRIPT_NAME} . $ENV{QUERY_STRING}) or return undef;
 226     my $nb_pages       = (@_) ? shift : 1;
 227     my $current_page   = (@_) ? shift : undef;  # delay default until later
 228     my $startfrom_name = (@_) ? shift : 'page';
 229
 230     # how many pages to show before and after the current page?
 231     my $pages_around = 2;
 232
 233         my $delim = qr/\&(?:amp;)?|;/;          # "non memory" cluster: no backreference
 234         $base_url =~ s/$delim*\b$startfrom_name=(\d+)//g; # remove previous pagination var
 235     unless (defined $current_page and $current_page > 0 and $current_page <= $nb_pages) {
 236         $current_page = ($1) ? $1 : 1;  # pull current page from param in URL, else default to 1
 237                 # $debug and    # FIXME: use C4::Debug;
 238                 # warn "with QUERY_STRING:" .$ENV{QUERY_STRING}. "\ncurrent_page:$current_page\n1:$1  2:$2  3:$3";
 239     }
 240         $base_url =~ s/($delim)+/$1/g;  # compress duplicate delims
 241         $base_url =~ s/$delim;//g;              # remove empties
 242         $base_url =~ s/$delim$//;               # remove trailing delim
 243
 244     my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&amp;' : '?' ) . $startfrom_name . '=';
 245     my $pagination_bar = '';
 246
 247     # navigation bar useful only if more than one page to display !
 248     if ( $nb_pages > 1 ) {
 249
 250         # link to first page?
 251         if ( $current_page > 1 ) {
 252             $pagination_bar .=
 253                 "\n" . '&nbsp;'
 254               . '<a href="'
 255               . $url
 256               . '1" rel="start">'
 257               . '&lt;&lt;' . '</a>';
 258         }
 259         else {
 260             $pagination_bar .=
 261               "\n" . '&nbsp;<span class="inactive">&lt;&lt;</span>';
 262         }
 263
 264         # link on previous page ?
 265         if ( $current_page > 1 ) {
 266             my $previous = $current_page - 1;
 267
 268             $pagination_bar .=
 269                 "\n" . '&nbsp;'
 270               . '<a href="'
 271               . $url
 272               . $previous
 273               . '" rel="prev">' . '&lt;' . '</a>';
 274         }
 275         else {
 276             $pagination_bar .=
 277               "\n" . '&nbsp;<span class="inactive">&lt;</span>';
 278         }
 279
 280         my $min_to_display      = $current_page - $pages_around;
 281         my $max_to_display      = $current_page + $pages_around;
 282         my $last_displayed_page = undef;
 283
 284         for my $page_number ( 1 .. $nb_pages ) {
 285             if (
 286                    $page_number == 1
 287                 or $page_number == $nb_pages
 288                 or (    $page_number >= $min_to_display
 289                     and $page_number <= $max_to_display )
 290               )
 291             {
 292                 if ( defined $last_displayed_page
 293                     and $last_displayed_page != $page_number - 1 )
 294                 {
 295                     $pagination_bar .=
 296                       "\n" . '&nbsp;<span class="inactive">...</span>';
 297                 }
 298
 299                 if ( $page_number == $current_page ) {
 300                     $pagination_bar .=
 301                         "\n" . '&nbsp;'
 302                       . '<span class="currentPage">'
 303                       . $page_number
 304                       . '</span>';
 305                 }
 306                 else {
 307                     $pagination_bar .=
 308                         "\n" . '&nbsp;'
 309                       . '<a href="'
 310                       . $url
 311                       . $page_number . '">'
 312                       . $page_number . '</a>';
 313                 }
 314                 $last_displayed_page = $page_number;
 315             }
 316         }
 317
 318         # link on next page?
 319         if ( $current_page < $nb_pages ) {
 320             my $next = $current_page + 1;
 321
 322             $pagination_bar .= "\n"
 323               . '&nbsp;<a href="'
 324               . $url
 325               . $next
 326               . '" rel="next">' . '&gt;' . '</a>';
 327         }
 328         else {
 329             $pagination_bar .=
 330               "\n" . '&nbsp;<span class="inactive">&gt;</span>';
 331         }
 332
 333         # link to last page?
 334         if ( $current_page != $nb_pages ) {
 335             $pagination_bar .= "\n"
 336               . '&nbsp;<a href="'
 337               . $url
 338               . $nb_pages
 339               . '" rel="last">'
 340               . '&gt;&gt;' . '</a>';
 341         }
 342         else {
 343             $pagination_bar .=
 344               "\n" . '&nbsp;<span class="inactive">&gt;&gt;</span>';
 345         }
 346     }
 347
 348     return $pagination_bar;
 349 }
 350
 351 =item output_with_http_headers
 352
 353    &output_with_http_headers($query, $cookie, $data, $content_type[, $status])
 354
 355 Outputs $data with the appropriate HTTP headers,
 356 the authentication cookie $cookie and a Content-Type specified in
 357 $content_type.
 358
 359 If applicable, $cookie can be undef, and it will not be sent.
 360
 361 $content_type is one of the following: 'html', 'js', 'json', 'xml', 'rss', or 'atom'.
 362
 363 $status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.
 364
 365 =cut
 366
 367 sub output_with_http_headers($$$$;$) {
 368     my ( $query, $cookie, $data, $content_type, $status ) = @_;
 369     $status ||= '200 OK';
 370
 371     my %content_type_map = (
 372         'html' => 'text/html',
 373         'js'   => 'text/javascript',
 374         'json' => 'application/json',
 375         'xml'  => 'text/xml',
 376         # NOTE: not using application/atom+xml or application/rss+xml because of
 377         # Internet Explorer 6; see bug 2078.
 378         'rss'  => 'text/xml',
 379         'atom' => 'text/xml'
 380     );
 381
 382     die "Unknown content type '$content_type'" if ( !defined( $content_type_map{$content_type} ) );
 383     my $options = {
 384         type    => $content_type_map{$content_type},
 385         status  => $status,
 386         charset => 'UTF-8',
 387         Pragma          => 'no-cache',
 388         'Cache-Control' => 'no-cache',
 389     };
 390     $options->{cookie} = $cookie if $cookie;
 391     if ($content_type eq 'html') {  # guaranteed to be one of the content_type_map keys, else we'd have died
 392         $options->{'Content-Style-Type' } = 'text/css';
 393         $options->{'Content-Script-Type'} = 'text/javascript';
 394     }
 395     print $query->header($options), $data;
 396 }
 397
 398 sub output_html_with_http_headers ($$$) {
 399     my ( $query, $cookie, $data ) = @_;
 400     output_with_http_headers( $query, $cookie, $data, 'html' );
 401 }
 402
 403 sub is_ajax () {
 404     my $x_req = $ENV{HTTP_X_REQUESTED_WITH};
 405     return ( $x_req and $x_req =~ /XMLHttpRequest/i ) ? 1 : 0;
 406 }
 407
 408 END { }    # module clean-up code here (global destructor)
 409
 410 1;
 411 __END__
 412
 413 =back
 414
 415 =head1 AUTHOR
 416
 417 Koha Developement team <info@koha.org>
 418
 419 =cut