bug 8215: (followup) make sure C4::CourseReserves doesn't export anything
[koha.git] / 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->{opacsmallimage} = C4::Context->preference('opacsmallimage');
113     $vars->{opaclayoutstylesheet} =
114         C4::Context->preference('opaclayoutstylesheet');
115
116     # add variables set via param to $vars for processing
117     # and clean any utf8 mess
118     for my $k ( keys %{ $self->{VARS} } ) {
119         $vars->{$k} = $self->{VARS}->{$k};
120         if (ref($vars->{$k}) eq 'ARRAY'){
121             utf8_arrayref($vars->{$k});
122         }
123         elsif (ref($vars->{$k}) eq 'HASH'){
124             utf8_hashref($vars->{$k});
125         }
126         else {
127             utf8::encode($vars->{$k}) if utf8::is_utf8($vars->{$k});
128         }
129     }
130     my $data;
131 #    binmode( STDOUT, ":utf8" );
132     $template->process( $self->filename, $vars, \$data )
133       || die "Template process failed: ", $template->error();
134     return $data;
135 }
136
137 sub utf8_arrayref {
138     my $arrayref = shift;
139     foreach my $element (@$arrayref){
140         if (ref($element) eq 'ARRAY'){
141             utf8_arrayref($element);
142             next;
143         }
144         if (ref($element) eq 'HASH'){
145             utf8_hashref($element);
146             next;
147         }
148         utf8::encode($element) if utf8::is_utf8($element);
149     }        
150 }         
151
152 sub utf8_hashref {
153     my $hashref = shift;
154     for my $key (keys %{$hashref}){
155         if (ref($hashref->{$key}) eq 'ARRAY'){
156             utf8_arrayref($hashref->{$key});
157             next;
158         }
159         if (ref($hashref->{$key}) eq 'HASH'){
160             utf8_hashref($hashref->{$key});
161             next;
162         }
163         utf8::encode($hashref->{$key}) if utf8::is_utf8($hashref->{$key});
164     }
165 }
166         
167         
168 # FIXME - this is a horrible hack to cache
169 # the current known-good language, temporarily
170 # put in place to resolve bug 4403.  It is
171 # used only by C4::XSLT::XSLTParse4Display;
172 # the language is set via the usual call
173 # to themelanguage.
174 my $_current_language = 'en';
175
176 sub _current_language {
177     return $_current_language;
178 }
179
180
181 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
182 sub param {
183     my $self = shift;
184     while (@_) {
185         my $key = shift;
186         my $val = shift;
187         if    ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
188         elsif ( ref($val) eq 'HASH'  && !scalar %$val ) { $val = undef; }
189         if ( $key ) {
190             $self->{VARS}->{$key} = $val;
191         } else {
192             warn "Problem = a value of $val has been passed to param without key";
193         }
194     }
195 }
196
197
198 =head1 NAME
199
200 C4::Templates - Functions for managing templates
201
202 =head1 FUNCTIONS
203
204 =cut
205
206 # FIXME: this is a quick fix to stop rc1 installing broken
207 # Still trying to figure out the correct fix.
208 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
209
210 #---------------------------------------------------------------------------------------------------------
211 # FIXME - POD
212
213 sub _get_template_file {
214     my ($tmplbase, $interface, $query) = @_;
215
216     my $is_intranet = $interface eq 'intranet';
217     my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs');
218     my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query);
219
220     # if the template doesn't exist, load the English one as a last resort
221     my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
222     unless (-f $filename) {
223         $lang = 'en';
224         $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
225     }
226     return ($htdocs, $theme, $lang, $filename);
227 }
228
229
230 sub gettemplate {
231     my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
232     ($query) or warn "no query in gettemplate";
233     my $path = C4::Context->preference('intranet_includes') || 'includes';
234     $tmplbase =~ s/\.tmpl$/.tt/;
235     my ($htdocs, $theme, $lang, $filename)
236        =  _get_template_file($tmplbase, $interface, $query);
237     $filename = $tmplbase if ( $is_plugin );
238     my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
239
240 # NOTE: Commenting these out rather than deleting them so that those who need
241 # to know how we previously shimmed these directories will be able to understand.
242 #    my $is_intranet = $interface eq 'intranet';
243 #    my $themelang =
244 #        ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
245 #        "/$theme/$lang";
246 #    $template->param(
247 #        themelang => $themelang,
248 #        yuipath   => C4::Context->preference("yuipath") eq "local"
249 #                     ? "$themelang/lib/yui"
250 #                     : C4::Context->preference("yuipath"),
251 #        interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
252 #        theme     => $theme,
253 #        lang      => $lang
254 #    );
255
256     # Bidirectionality
257     my $current_lang = regex_lang_subtags($lang);
258     my $bidi;
259     $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
260     # Languages
261     my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
262     my $num_languages_enabled = 0;
263     foreach my $lang (@$languages_loop) {
264         foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
265             $num_languages_enabled++ if $sublang->{enabled};
266          }
267     }
268     $template->param(
269             languages_loop       => $languages_loop,
270             bidi                 => $bidi,
271             one_language_enabled => ($num_languages_enabled <= 1) ? 1 : 0, # deal with zero enabled langs as well
272     ) unless @$languages_loop<2;
273
274     return $template;
275 }
276
277
278 #---------------------------------------------------------------------------------------------------------
279 # FIXME - POD
280 sub themelanguage {
281     my ($htdocs, $tmpl, $interface, $query) = @_;
282     ($query) or warn "no query in themelanguage";
283
284     # Select a language based on cookie, syspref available languages & browser
285     my $lang = getlanguage($query, $interface);
286
287     # Select theme
288     my $is_intranet = $interface eq 'intranet';
289     my @themes = split(" ", C4::Context->preference(
290         $is_intranet ? "template" : "opacthemes" ));
291     push @themes, 'prog';
292
293     # Try to find first theme for the selected language
294     for my $theme (@themes) {
295         if ( -e "$htdocs/$theme/$lang/modules/$tmpl" ) {
296             $_current_language = $lang;
297             return ($theme, $lang, \@themes)
298         }
299     }
300     # Otherwise, return prog theme in English 'en'
301     return ('prog', 'en', \@themes);
302 }
303
304
305 sub setlanguagecookie {
306     my ( $query, $language, $uri ) = @_;
307     my $cookie = $query->cookie(
308         -name    => 'KohaOpacLanguage',
309         -value   => $language,
310         -HttpOnly => 1,
311         -expires => '+3y'
312     );
313     print $query->redirect(
314         -uri    => $uri,
315         -cookie => $cookie
316     );
317 }
318
319
320 sub getlanguage {
321     my ($query, $interface) = @_;
322
323     # Select a language based on cookie, syspref available languages & browser
324     my $preference_to_check =
325       $interface eq 'intranet' ? 'language' : 'opaclanguages';
326     my @languages = split /,/, C4::Context->preference($preference_to_check);
327
328     my $lang;
329
330     #¬†cookie
331     if ( $query->cookie('KohaOpacLanguage') ) {
332         $lang = $query->cookie('KohaOpacLanguage');
333         $lang =~ s/[^a-zA-Z_-]*//; # sanitize cookie
334     }
335
336     #¬†HTTP_ACCEPT_LANGUAGE
337     if ( !$lang && $ENV{HTTP_ACCEPT_LANGUAGE} ) {
338         $lang = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE},
339             getTranslatedLanguages( $interface, 'prog' ) );
340     }
341
342     # Ignore a lang not selected in sysprefs
343     if ( $lang && any { $_ eq $lang } @languages ) {
344         return $lang;
345     }
346
347     # Fall back to English if necessary
348     return 'en';
349 }
350
351 1;