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
  30 use C4::Context;
  31 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
  32
  33 use HTML::Template::Pro;
  34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  35
  36 BEGIN {
  37     # set the version for version checking
  38     $VERSION = 3.03;
  39     require Exporter;
  40     @ISA    = qw(Exporter);
  41         @EXPORT_OK = qw(&output_ajax_with_http_headers &is_ajax); # More stuff should go here instead
  42         %EXPORT_TAGS = ( all =>[qw(&themelanguage &gettemplate setlanguagecookie pagination_bar
  43                                                                 &output_ajax_with_http_headers &output_html_with_http_headers)],
  44                                         ajax =>[qw(&output_ajax_with_http_headers is_ajax)],
  45                                         html =>[qw(&output_html_with_http_headers)]
  46                                 );
  47     push @EXPORT, qw(
  48         &themelanguage &gettemplate setlanguagecookie pagination_bar
  49     );
  50     push @EXPORT, qw(
  51         &output_html_with_http_headers
  52     );
  53 }
  54
  55 =head1 NAME
  56
  57 C4::Output - Functions for managing templates
  58
  59 =head1 FUNCTIONS
  60
  61 =over 2
  62
  63 =cut
  64
  65 #FIXME: this is a quick fix to stop rc1 installing broken
  66 #Still trying to figure out the correct fix.
  67 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
  68
  69 #---------------------------------------------------------------------------------------------------------
  70 # FIXME - POD
  71 sub gettemplate {
  72     my ( $tmplbase, $interface, $query ) = @_;
  73     ($query) or warn "no query in gettemplate";
  74     my $htdocs;
  75     if ( $interface ne "intranet" ) {
  76         $htdocs = C4::Context->config('opachtdocs');
  77     }
  78     else {
  79         $htdocs = C4::Context->config('intrahtdocs');
  80     }
  81     my $path = C4::Context->preference('intranet_includes') || 'includes';
  82     my ( $theme, $lang ) = themelanguage( $htdocs, $tmplbase, $interface, $query );
  83     my $opacstylesheet = C4::Context->preference('opacstylesheet');
  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     # But, if there's a cookie set, obey it
 141     $lang = $query->cookie('KohaOpacLanguage') if $query->cookie('KohaOpacLanguage');
 142     # Fall back to English
 143     my @languages;
 144     if ($interface eq 'intranet') {
 145         @languages = split ",", C4::Context->preference("language");
 146     } else {
 147         @languages = split ",", C4::Context->preference("opaclanguages");
 148     }
 149     $lang = accept_language( $http_accept_language,
 150               getTranslatedLanguages($interface,'prog') )
 151       if $http_accept_language;
 152
 153     if (grep(/^$lang$/, @languages)){
 154         @languages=($lang,@languages);
 155     } else {
 156         $lang = $languages[0];
 157     }
 158
 159     my $theme = 'prog'; # in the event of theme failure default to 'prog' -fbcit
 160     my $dbh = C4::Context->dbh;
 161     if ( $interface eq "intranet" ) {
 162         $theme = C4::Context->preference("template");
 163     }
 164     else {
 165       # we are in the opac here, what im trying to do is let the individual user
 166       # set the theme they want to use.
 167       # and perhaps the them as well.
 168         #my $lang = $query->cookie('KohaOpacLanguage');
 169         $theme = C4::Context->preference("opacthemes");
 170     }
 171
 172  # searches through the themes and languages. First template it find it returns.
 173  # Priority is for getting the theme right.
 174     THEME:
 175     foreach my $la (@languages) {
 176                         if ( -e "$htdocs/$theme/$la/modules/$tmpl") {
 177                 $lang  = $la;
 178                 last THEME;
 179             }
 180             last unless $la =~ /[-_]/;
 181     }
 182     return ( $theme, $lang );
 183 }
 184
 185 sub setlanguagecookie {
 186     my ( $query, $language, $uri ) = @_;
 187     my $cookie = $query->cookie(
 188         -name    => 'KohaOpacLanguage',
 189         -value   => $language,
 190         -expires => ''
 191     );
 192     print $query->redirect(
 193         -uri    => $uri,
 194         -cookie => $cookie
 195     );
 196 }
 197
 198 =item pagination_bar
 199
 200    pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
 201
 202 Build an HTML pagination bar based on the number of page to display, the
 203 current page and the url to give to each page link.
 204
 205 C<$base_url> is the URL for each page link. The
 206 C<$startfrom_name>=page_number is added at the end of the each URL.
 207
 208 C<$nb_pages> is the total number of pages available.
 209
 210 C<$current_page> is the current page number. This page number won't become a
 211 link.
 212
 213 This function returns HTML, without any language dependency.
 214
 215 =cut
 216
 217 sub pagination_bar {
 218         my $base_url = (@_ ? shift : $ENV{SCRIPT_NAME} . $ENV{QUERY_STRING}) or return undef;
 219     my $nb_pages       = (@_) ? shift : 1;
 220     my $current_page   = (@_) ? shift : undef;  # delay default until later
 221     my $startfrom_name = (@_) ? shift : 'page';
 222
 223     # how many pages to show before and after the current page?
 224     my $pages_around = 2;
 225
 226         my $delim = qr/\&(?:amp;)?|;/;          # "non memory" cluster: no backreference
 227         $base_url =~ s/$delim*\b$startfrom_name=(\d+)//g; # remove previous pagination var
 228     unless (defined $current_page and $current_page > 0 and $current_page <= $nb_pages) {
 229         $current_page = ($1) ? $1 : 1;  # pull current page from param in URL, else default to 1
 230                 # $debug and    # FIXME: use C4::Debug;
 231                 # warn "with QUERY_STRING:" .$ENV{QUERY_STRING}. "\ncurrent_page:$current_page\n1:$1  2:$2  3:$3";
 232     }
 233         $base_url =~ s/($delim)+/$1/g;  # compress duplicate delims
 234         $base_url =~ s/$delim;//g;              # remove empties
 235         $base_url =~ s/$delim$//;               # remove trailing delim
 236
 237     my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&amp;' : '?' ) . $startfrom_name . '=';
 238     my $pagination_bar = '';
 239
 240     # navigation bar useful only if more than one page to display !
 241     if ( $nb_pages > 1 ) {
 242
 243         # link to first page?
 244         if ( $current_page > 1 ) {
 245             $pagination_bar .=
 246                 "\n" . '&nbsp;'
 247               . '<a href="'
 248               . $url
 249               . '1" rel="start">'
 250               . '&lt;&lt;' . '</a>';
 251         }
 252         else {
 253             $pagination_bar .=
 254               "\n" . '&nbsp;<span class="inactive">&lt;&lt;</span>';
 255         }
 256
 257         # link on previous page ?
 258         if ( $current_page > 1 ) {
 259             my $previous = $current_page - 1;
 260
 261             $pagination_bar .=
 262                 "\n" . '&nbsp;'
 263               . '<a href="'
 264               . $url
 265               . $previous
 266               . '" rel="prev">' . '&lt;' . '</a>';
 267         }
 268         else {
 269             $pagination_bar .=
 270               "\n" . '&nbsp;<span class="inactive">&lt;</span>';
 271         }
 272
 273         my $min_to_display      = $current_page - $pages_around;
 274         my $max_to_display      = $current_page + $pages_around;
 275         my $last_displayed_page = undef;
 276
 277         for my $page_number ( 1 .. $nb_pages ) {
 278             if (
 279                    $page_number == 1
 280                 or $page_number == $nb_pages
 281                 or (    $page_number >= $min_to_display
 282                     and $page_number <= $max_to_display )
 283               )
 284             {
 285                 if ( defined $last_displayed_page
 286                     and $last_displayed_page != $page_number - 1 )
 287                 {
 288                     $pagination_bar .=
 289                       "\n" . '&nbsp;<span class="inactive">...</span>';
 290                 }
 291
 292                 if ( $page_number == $current_page ) {
 293                     $pagination_bar .=
 294                         "\n" . '&nbsp;'
 295                       . '<span class="currentPage">'
 296                       . $page_number
 297                       . '</span>';
 298                 }
 299                 else {
 300                     $pagination_bar .=
 301                         "\n" . '&nbsp;'
 302                       . '<a href="'
 303                       . $url
 304                       . $page_number . '">'
 305                       . $page_number . '</a>';
 306                 }
 307                 $last_displayed_page = $page_number;
 308             }
 309         }
 310
 311         # link on next page?
 312         if ( $current_page < $nb_pages ) {
 313             my $next = $current_page + 1;
 314
 315             $pagination_bar .= "\n"
 316               . '&nbsp;<a href="'
 317               . $url
 318               . $next
 319               . '" rel="next">' . '&gt;' . '</a>';
 320         }
 321         else {
 322             $pagination_bar .=
 323               "\n" . '&nbsp;<span class="inactive">&gt;</span>';
 324         }
 325
 326         # link to last page?
 327         if ( $current_page != $nb_pages ) {
 328             $pagination_bar .= "\n"
 329               . '&nbsp;<a href="'
 330               . $url
 331               . $nb_pages
 332               . '" rel="last">'
 333               . '&gt;&gt;' . '</a>';
 334         }
 335         else {
 336             $pagination_bar .=
 337               "\n" . '&nbsp;<span class="inactive">&gt;&gt;</span>';
 338         }
 339     }
 340
 341     return $pagination_bar;
 342 }
 343
 344 =item output_html_with_http_headers
 345
 346    &output_html_with_http_headers($query, $cookie, $html[, $content_type])
 347
 348 Outputs the HTML page $html with the appropriate HTTP headers,
 349 with the authentication cookie $cookie and a Content-Type that
 350 corresponds to the HTML page $html.
 351
 352 If the optional C<$content_type> parameter is called, set the
 353 response's Content-Type to that value instead of "text/html".
 354
 355 =cut
 356
 357 sub output_html_with_http_headers ($$$;$) {
 358     my $query = shift;
 359     my $cookie = shift;
 360     my $html = shift;
 361     my $content_type = @_ ? shift : "text/html";
 362     $content_type = "text/html" unless $content_type =~ m!/!; # very basic sanity check
 363     print $query->header(
 364         -type    => $content_type,
 365         -charset => 'UTF-8',
 366         -cookie  => $cookie,
 367         -Pragma => 'no-cache',
 368         -'Cache-Control' => 'no-cache',
 369     ), $html;
 370 }
 371
 372 sub output_ajax_with_http_headers ($$) {
 373     my ($query, $js) = @_;
 374     print $query->header(
 375         -type    => 'text/javascript',
 376         -charset => 'UTF-8',
 377         -Pragma  => 'no-cache',
 378         -'Cache-Control' => 'no-cache',
 379                 -expires =>'-1d',
 380     ), $js;
 381 }
 382
 383 sub is_ajax () {
 384         my $x_req = $ENV{HTTP_X_REQUESTED_WITH};
 385         return ($x_req and $x_req =~ /XMLHttpRequest/i) ? 1 : 0;
 386 }
 387
 388 END { }    # module clean-up code here (global destructor)
 389
 390 1;
 391 __END__
 392
 393 =back
 394
 395 =head1 AUTHOR
 396
 397 Koha Developement team <info@koha.org>
 398
 399 =cut