C4/Templates.pm

   1 package C4::Templates;
   2
   3 use strict;
   4 use warnings;
   5 use Carp;
   6 use CGI;
   7 use List::MoreUtils qw/any/;
   8
   9 # Copyright 2009 Chris Cormack and The Koha Dev Team
  10 #
  11 # This file is part of Koha.
  12 #
  13 # Koha is free software; you can redistribute it and/or modify it under the
  14 # terms of the GNU General Public License as published by the Free Software
  15 # Foundation; either version 2 of the License, or (at your option) any later
  16 # version.
  17 #
  18 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  19 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  21 #
  22 # You should have received a copy of the GNU General Public License along with
  23 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  24 # Suite 330, Boston, MA  02111-1307 USA
  25
  26 =head1 NAME
  27
  28     Koha::Templates - Object for manipulating templates for use with Koha
  29
  30 =cut
  31
  32 use base qw(Class::Accessor);
  33 use Template;
  34 use Template::Constants qw( :debug );
  35 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
  36
  37 use C4::Context;
  38
  39 __PACKAGE__->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars));
  40
  41
  42
  43 sub new {
  44     my $class     = shift;
  45     my $interface = shift;
  46     my $filename  = shift;
  47     my $tmplbase  = shift;
  48     my $query     = @_? shift: undef;
  49     my $htdocs;
  50     if ( $interface ne "intranet" ) {
  51         $htdocs = C4::Context->config('opachtdocs');
  52     }
  53     else {
  54         $htdocs = C4::Context->config('intrahtdocs');
  55     }
  56     my ($theme, $lang, $activethemes)= themelanguage( $htdocs, $tmplbase, $interface, $query);
  57     my @includes;
  58     foreach (@$activethemes) {
  59         push @includes, "$htdocs/$_/$lang/includes";
  60         push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
  61     }
  62     my $template = Template->new(
  63         {   EVAL_PERL    => 1,
  64             ABSOLUTE     => 1,
  65             PLUGIN_BASE => 'Koha::Template::Plugin',
  66             COMPILE_EXT => C4::Context->config('template_cache_dir')?'.ttc':'',
  67             COMPILE_DIR => C4::Context->config('template_cache_dir')?C4::Context->config('template_cache_dir'):'',,
  68             INCLUDE_PATH => \@includes,
  69             FILTERS => {},
  70         }
  71     ) or die Template->error();
  72     my $self = {
  73         TEMPLATE => $template,
  74         VARS     => {},
  75     };
  76     bless $self, $class;
  77     $self->theme($theme);
  78     $self->lang($lang);
  79     $self->activethemes($activethemes);
  80     $self->preferredtheme($activethemes->[0]);
  81     $self->filename($filename);
  82     $self->htdocs($htdocs);
  83     $self->interface($interface);
  84     $self->{VARS}->{"test"} = "value";
  85     return $self;
  86
  87 }
  88
  89 sub output {
  90     my $self = shift;
  91     my $vars = shift;
  92
  93 #    my $file = $self->htdocs . '/' . $self->theme .'/'.$self->lang.'/'.$self->filename;
  94     my $template = $self->{TEMPLATE};
  95     if ( $self->interface eq 'intranet' ) {
  96         $vars->{themelang} = '/intranet-tmpl';
  97     }
  98     else {
  99         $vars->{themelang} = '/opac-tmpl';
 100     }
 101     $vars->{lang} = $self->lang;
 102     $vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang;
 103     $vars->{yuipath} =
 104       ( C4::Context->preference("yuipath") eq "local"
 105         ? ( $self->interface eq 'intranet' ? $vars->{themelang} . "/lib/yui" : "/opac-tmpl/lib/yui" )
 106         : C4::Context->preference("yuipath") );
 107     $vars->{interface} =
 108       ( $self->{interface} ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' );
 109     $vars->{theme} = $self->theme;
 110     $vars->{opaccolorstylesheet} =
 111         C4::Context->preference('opaccolorstylesheet');
 112     $vars->{opaclayoutstylesheet} =
 113         C4::Context->preference('opaclayoutstylesheet');
 114
 115     # add variables set via param to $vars for processing
 116     # and clean any utf8 mess
 117     for my $k ( keys %{ $self->{VARS} } ) {
 118         $vars->{$k} = $self->{VARS}->{$k};
 119         if (ref($vars->{$k}) eq 'ARRAY'){
 120             utf8_arrayref($vars->{$k});
 121         }
 122         elsif (ref($vars->{$k}) eq 'HASH'){
 123             utf8_hashref($vars->{$k});
 124         }
 125         else {
 126             utf8::encode($vars->{$k}) if utf8::is_utf8($vars->{$k});
 127         }
 128     }
 129     my $data;
 130 #    binmode( STDOUT, ":utf8" );
 131     $template->process( $self->filename, $vars, \$data )
 132       || die "Template process failed: ", $template->error();
 133     return $data;
 134 }
 135
 136 sub utf8_arrayref {
 137     my $arrayref = shift;
 138     foreach my $element (@$arrayref){
 139         if (ref($element) eq 'ARRAY'){
 140             utf8_arrayref($element);
 141             next;
 142         }
 143         if (ref($element) eq 'HASH'){
 144             utf8_hashref($element);
 145             next;
 146         }
 147         utf8::encode($element) if utf8::is_utf8($element);
 148     }
 149 }
 150
 151 sub utf8_hashref {
 152     my $hashref = shift;
 153     for my $key (keys %{$hashref}){
 154         if (ref($hashref->{$key}) eq 'ARRAY'){
 155             utf8_arrayref($hashref->{$key});
 156             next;
 157         }
 158         if (ref($hashref->{$key}) eq 'HASH'){
 159             utf8_hashref($hashref->{$key});
 160             next;
 161         }
 162         utf8::encode($hashref->{$key}) if utf8::is_utf8($hashref->{$key});
 163     }
 164 }
 165
 166 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
 167 sub param {
 168     my $self = shift;
 169     while (@_) {
 170         my $key = shift;
 171         my $val = shift;
 172         if    ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
 173         elsif ( ref($val) eq 'HASH'  && !scalar %$val ) { $val = undef; }
 174         if ( $key ) {
 175             $self->{VARS}->{$key} = $val;
 176         } else {
 177             warn "Problem = a value of $val has been passed to param without key";
 178         }
 179     }
 180 }
 181
 182
 183 =head1 NAME
 184
 185 C4::Templates - Functions for managing templates
 186
 187 =head1 FUNCTIONS
 188
 189 =cut
 190
 191 # FIXME: this is a quick fix to stop rc1 installing broken
 192 # Still trying to figure out the correct fix.
 193 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
 194
 195 #---------------------------------------------------------------------------------------------------------
 196 # FIXME - POD
 197
 198 sub _get_template_file {
 199     my ($tmplbase, $interface, $query) = @_;
 200
 201     my $is_intranet = $interface eq 'intranet';
 202     my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs');
 203     my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query);
 204
 205     # if the template doesn't exist, load the English one as a last resort
 206     my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
 207     unless (-f $filename) {
 208         $lang = 'en';
 209         $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
 210     }
 211     return ($htdocs, $theme, $lang, $filename);
 212 }
 213
 214
 215 sub gettemplate {
 216     my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
 217     ($query) or warn "no query in gettemplate";
 218     my $path = C4::Context->preference('intranet_includes') || 'includes';
 219     my ($htdocs, $theme, $lang, $filename)
 220        =  _get_template_file($tmplbase, $interface, $query);
 221     $filename = $tmplbase if ( $is_plugin );
 222     my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
 223
 224     # Bidirectionality, must be sent even if is the only language
 225     my $current_lang = regex_lang_subtags($lang);
 226     my $bidi;
 227     $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
 228     $template->param(
 229             bidi                 => $bidi,
 230     );
 231     # Languages
 232     my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
 233     my $num_languages_enabled = 0;
 234     foreach my $lang (@$languages_loop) {
 235         foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
 236             $num_languages_enabled++ if $sublang->{enabled};
 237          }
 238     }
 239     my $one_language_enabled = ($num_languages_enabled <= 1) ? 1 : 0; # deal with zero enabled langs as well
 240     $template->param(
 241             languages_loop       => $languages_loop,
 242             one_language_enabled => $one_language_enabled,
 243     ) unless $one_language_enabled;
 244
 245     return $template;
 246 }
 247
 248
 249 #---------------------------------------------------------------------------------------------------------
 250 # FIXME - POD
 251 sub themelanguage {
 252     my ($htdocs, $tmpl, $interface, $query) = @_;
 253     ($query) or warn "no query in themelanguage";
 254
 255     # Select a language based on cookie, syspref available languages & browser
 256     my $lang = C4::Languages::getlanguage($query);
 257
 258     # Select theme
 259     my $is_intranet = $interface eq 'intranet';
 260     my @themes = split(" ", C4::Context->preference(
 261         $is_intranet ? "template" : "opacthemes" ));
 262     push @themes, 'prog';
 263
 264     # Try to find first theme for the selected language
 265     for my $theme (@themes) {
 266         if ( -e "$htdocs/$theme/$lang/modules/$tmpl" ) {
 267             return ($theme, $lang, \@themes)
 268         }
 269     }
 270     # Otherwise, return prog theme in English 'en'
 271     return ('prog', 'en', \@themes);
 272 }
 273
 274
 275 sub setlanguagecookie {
 276     my ( $query, $language, $uri ) = @_;
 277
 278     my $cookie = $query->cookie(
 279         -name    => 'KohaOpacLanguage',
 280         -value   => $language,
 281         -HttpOnly => 1,
 282         -expires => '+3y'
 283     );
 284     print $query->redirect(
 285         -uri    => $uri,
 286         -cookie => $cookie
 287     );
 288 }
 289
 290 =head2 getlanguagecookie
 291
 292     my $cookie = getlanguagecookie($query,$language);
 293
 294 Returns a cookie object containing the calculated language to be used.
 295
 296 =cut
 297
 298 sub getlanguagecookie {
 299     my ( $query, $language ) = @_;
 300     my $cookie = $query->cookie(
 301         -name    => 'KohaOpacLanguage',
 302         -value   => $language,
 303         -HttpOnly => 1,
 304         -expires => '+3y'
 305     );
 306
 307     return $cookie;
 308 }
 309
 310 =head2 GetColumnDefs
 311
 312     my $columns = GetColumnDefs( $cgi )
 313
 314 It is passed a CGI object and returns a hash of hashes containing
 315 the column names and descriptions for each table defined in the
 316 columns.def file corresponding to the CGI object.
 317
 318 =cut
 319
 320 sub GetColumnDefs {
 321
 322     my $query = shift;
 323
 324     my $columns = {};
 325
 326     my $htdocs = C4::Context->config('intrahtdocs');
 327     my $columns_file = 'columns.def';
 328
 329     # Get theme and language to build the path to columns.def
 330     my ($theme, $lang, $availablethemes) =
 331         themelanguage($htdocs, 'about.tt', 'intranet', $query);
 332     # Build columns.def path
 333     my $path = "$htdocs/$theme/$lang/$columns_file";
 334     my $fh;
 335     if ( ! open ( $fh, q{<}, $path ) )  {
 336         carp "Error opening $path. Check your templates.";
 337         return;
 338     }
 339     # Loop through the columns.def file
 340     while ( my $input = <$fh> ){
 341         chomp $input;
 342         if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
 343             my ( $table, $column ) =  split( '\.', $1);
 344             my $description        = $2;
 345             # Initialize the table array if needed.
 346             @{$columns->{ $table }} = () if ! defined $columns->{ $table };
 347             # Push field and description
 348             push @{$columns->{ $table }},
 349                 { field => $column, description => $description };
 350         }
 351     }
 352     close $fh;
 353
 354     return $columns;
 355 }
 356
 357 1;