7 use List::MoreUtils qw/ any uniq /;
9 # Copyright 2009 Chris Cormack and The Koha Dev Team
11 # This file is part of Koha.
13 # Koha is free software; you can redistribute it and/or modify it
14 # under the terms of the GNU General Public License as published by
15 # the Free Software Foundation; either version 3 of the License, or
16 # (at your option) any later version.
18 # Koha is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 # GNU General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with Koha; if not, see <http://www.gnu.org/licenses>.
28 C4::Templates - Object for manipulating templates for use with Koha
32 use base qw(Class::Accessor);
34 use Template::Constants qw( :debug );
35 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
39 use Koha::Cache::Memory::Lite;
42 __PACKAGE__->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars));
48 my $interface = shift;
51 my $query = @_? shift: undef;
53 if ( $interface ne "intranet" ) {
54 $htdocs = C4::Context->config('opachtdocs');
57 $htdocs = C4::Context->config('intrahtdocs');
59 my ($theme, $lang, $activethemes)= themelanguage( $htdocs, $tmplbase, $interface, $query);
61 foreach (@$activethemes) {
62 push @includes, "$htdocs/$_/$lang/includes";
63 push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
65 # Do not use template cache if script is called from commandline
66 my $use_template_cache = C4::Context->config('template_cache_dir') && defined $ENV{GATEWAY_INTERFACE};
67 my $template = Template->new(
70 PLUGIN_BASE => 'Koha::Template::Plugin',
71 COMPILE_EXT => $use_template_cache ? '.ttc' : '',
72 COMPILE_DIR => $use_template_cache ? C4::Context->config('template_cache_dir') : '',
73 INCLUDE_PATH => \@includes,
77 ) or die Template->error();
79 TEMPLATE => $template,
85 $self->activethemes($activethemes);
86 $self->preferredtheme($activethemes->[0]);
87 $self->filename($filename);
88 $self->htdocs($htdocs);
89 $self->interface($interface);
90 $self->{VARS}->{"test"} = "value";
99 # my $file = $self->htdocs . '/' . $self->theme .'/'.$self->lang.'/'.$self->filename;
100 my $template = $self->{TEMPLATE};
101 if ( $self->interface eq 'intranet' ) {
102 $vars->{themelang} = '/intranet-tmpl';
105 $vars->{themelang} = '/opac-tmpl';
107 $vars->{lang} = $self->lang;
108 $vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang;
110 ( $self->{interface} ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' );
111 $vars->{theme} = $self->theme;
112 $vars->{OpacAdditionalStylesheet} =
113 C4::Context->preference('OpacAdditionalStylesheet');
114 $vars->{opaclayoutstylesheet} =
115 C4::Context->preference('opaclayoutstylesheet');
117 # add variables set via param to $vars for processing
118 $vars = { %$vars, %{ $self->{VARS} } };
121 binmode( STDOUT, ":encoding(UTF-8)" );
122 $template->process( $self->filename, $vars, \$data )
123 || die "Template process failed: ", $template->error();
127 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
133 if ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
134 elsif ( ref($val) eq 'HASH' && !scalar %$val ) { $val = undef; }
136 $self->{VARS}->{$key} = $val;
138 warn "Problem = a value of $val has been passed to param without key";
146 C4::Templates - Functions for managing templates
152 # FIXME: this is a quick fix to stop rc1 installing broken
153 # Still trying to figure out the correct fix.
154 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
156 #---------------------------------------------------------------------------------------------------------
159 sub _get_template_file {
160 my ($tmplbase, $interface, $query) = @_;
162 my $is_intranet = $interface eq 'intranet';
163 my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs');
164 my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query);
167 $tmplbase = "$htdocs/$theme/$lang/modules/$tmplbase" if $tmplbase !~ /^\//;
168 # do not prefix an absolute path
170 return ( $htdocs, $theme, $lang, $tmplbase );
173 =head2 badtemplatecheck
175 badtemplatecheck( $template_path );
177 The sub will throw an exception if the template path is not allowed.
179 Note: At this moment the sub is actually a helper routine for
184 sub badtemplatecheck {
185 my ( $template ) = @_;
186 if( !$template || $template !~ m/^[a-zA-Z0-9_\-\/]+\.(tt|pref)$/ ) {
187 # This also includes two dots
188 Koha::Exceptions::NoPermission->throw( 'bad template path' );
190 # Check allowed dirs - make sure we operate on a copy of the config
191 my $dirs = C4::Context->config("pluginsdir");
198 unshift @$dirs, C4::Context->config('opachtdocs'), C4::Context->config('intrahtdocs');
200 foreach my $dir ( @$dirs ) {
201 $dir .= '/' if $dir !~ m/\/$/;
202 $found++ if $template =~ m/^$dir/;
205 Koha::Exceptions::NoPermission->throw( 'bad template path' ) if !$found;
210 my ( $tmplbase, $interface, $query ) = @_;
211 ($query) or warn "no query in gettemplate";
212 my ($htdocs, $theme, $lang, $filename)
213 = _get_template_file($tmplbase, $interface, $query);
214 badtemplatecheck( $filename ); # single trip for bad templates
215 my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
217 # NOTE: Commenting these out rather than deleting them so that those who need
218 # to know how we previously shimmed these directories will be able to understand.
219 # my $is_intranet = $interface eq 'intranet';
221 # ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
224 # themelang => $themelang,
225 # interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
230 # Bidirectionality, must be sent even if is the only language
231 my $current_lang = regex_lang_subtags($lang);
233 $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
238 my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
239 my $num_languages_enabled = 0;
240 foreach my $lang (@$languages_loop) {
241 foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
242 $num_languages_enabled++ if $sublang->{enabled};
245 my $one_language_enabled = ($num_languages_enabled <= 1) ? 1 : 0; # deal with zero enabled langs as well
247 languages_loop => $languages_loop,
248 one_language_enabled => $one_language_enabled,
249 ) unless $one_language_enabled;
257 my ($theme,$lang,\@themes) = themelanguage($htdocs,$tmpl,$interface,query);
259 This function returns the theme and language to be used for rendering the UI.
260 It also returns the list of themes that should be applied as a fallback. This is
261 used for the theme overlay feature (i.e. if a file doesn't exist on the requested
262 theme, fallback to the configured fallback).
264 Important: this function is used on the webinstaller too, so always consider
265 the use case where the DB is not populated already when rewriting/fixing.
270 my ($htdocs, $tmpl, $interface, $query) = @_;
271 ($query) or warn "no query in themelanguage";
273 # Select a language based on cookie, syspref available languages & browser
274 my $lang = C4::Languages::getlanguage($query);
278 my $theme_syspref = ($interface eq 'intranet') ? 'template' : 'opacthemes';
279 my $fallback_syspref = ($interface eq 'intranet') ? 'template' : 'OPACFallback';
280 # Yeah, hardcoded, last resort if the DB is not populated
281 my $hardcoded_theme = ($interface eq 'intranet') ? 'prog' : 'bootstrap';
283 # Configured theme is the first one
284 push @themes, C4::Context->preference( $theme_syspref )
285 if C4::Context->preference( $theme_syspref );
286 # Configured fallback next
287 push @themes, C4::Context->preference( $fallback_syspref )
288 if C4::Context->preference( $fallback_syspref );
289 # The hardcoded fallback theme is the last one
290 push @themes, $hardcoded_theme;
292 # Try to find first theme for the selected theme/lang, then for fallback/lang
293 my $where = $tmpl =~ /xsl$/ ? 'xslt' : 'modules';
294 for my $theme (@themes) {
295 if ( -e "$htdocs/$theme/$lang/$where/$tmpl" ) {
296 return ( $theme, $lang, [ uniq(@themes) ] );
299 # Otherwise return theme/'en', last resort fallback/'en'
300 for my $theme (@themes) {
301 if ( -e "$htdocs/$theme/en/$where/$tmpl" ) {
302 return ( $theme, 'en', [ uniq(@themes) ] );
305 # tmpl is a full path, so this is a template for a plugin
306 if ( $tmpl =~ /^\// && -e $tmpl ) {
307 return ( $themes[0], $lang, [ uniq(@themes) ] );
312 sub setlanguagecookie {
313 my ( $query, $language, $uri ) = @_;
315 my $cookie = getlanguagecookie( $query, $language );
317 # We do not want to set getlanguage in cache, some additional checks are
318 # done in C4::Languages::getlanguage
319 Koha::Cache::Memory::Lite->get_instance()->clear_from_cache( 'getlanguage' );
321 print $query->redirect(
327 =head2 getlanguagecookie
329 my $cookie = getlanguagecookie($query,$language);
331 Returns a cookie object containing the calculated language to be used.
335 sub getlanguagecookie {
336 my ( $query, $language ) = @_;
337 my $cookie = $query->cookie(
338 -name => 'KohaOpacLanguage',
349 my $columns = GetColumnDefs( $cgi )
351 It is passed a CGI object and returns a hash of hashes containing
352 the column names and descriptions for each table defined in the
353 columns.def file corresponding to the CGI object.
363 my $htdocs = C4::Context->config('intrahtdocs');
364 my $columns_file = 'columns.def';
366 # Get theme and language to build the path to columns.def
367 my ($theme, $lang, $availablethemes) =
368 themelanguage($htdocs, 'about.tt', 'intranet', $query);
369 # Build columns.def path
370 my $path = "$htdocs/$theme/$lang/$columns_file";
372 if ( ! open ( $fh, q{<:encoding(utf-8)}, $path ) ) {
373 carp "Error opening $path. Check your templates.";
376 # Loop through the columns.def file
377 while ( my $input = <$fh> ){
379 if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
380 my ( $table, $column ) = split( '\.', $1);
381 my $description = $2;
382 # Initialize the table array if needed.
383 @{$columns->{ $table }} = () if ! defined $columns->{ $table };
384 # Push field and description
385 push @{$columns->{ $table }},
386 { field => $column, description => $description };