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 Koha::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, ":utf8" );
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);
166 my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
168 return ($htdocs, $theme, $lang, $filename);
171 =head2 badtemplatecheck
173 badtemplatecheck( $template_path );
175 The sub will throw an exception if the template path is not allowed.
177 Note: At this moment the sub is actually a helper routine for
182 sub badtemplatecheck {
183 my ( $template ) = @_;
184 Koha::Exceptions::NoPermission->throw( 'bad template path' )
185 unless $template =~ m/^[a-zA-Z0-9_\-\/]+\.(tt|pref)$/;
189 my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
190 ($query) or warn "no query in gettemplate";
191 my ($htdocs, $theme, $lang, $filename)
192 = _get_template_file($tmplbase, $interface, $query);
193 $filename = $tmplbase if ( $is_plugin );
194 badtemplatecheck( $filename ); # single trip for bad templates
195 my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
197 # NOTE: Commenting these out rather than deleting them so that those who need
198 # to know how we previously shimmed these directories will be able to understand.
199 # my $is_intranet = $interface eq 'intranet';
201 # ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
204 # themelang => $themelang,
205 # interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
210 # Bidirectionality, must be sent even if is the only language
211 my $current_lang = regex_lang_subtags($lang);
213 $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
218 my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
219 my $num_languages_enabled = 0;
220 foreach my $lang (@$languages_loop) {
221 foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
222 $num_languages_enabled++ if $sublang->{enabled};
225 my $one_language_enabled = ($num_languages_enabled <= 1) ? 1 : 0; # deal with zero enabled langs as well
227 languages_loop => $languages_loop,
228 one_language_enabled => $one_language_enabled,
229 ) unless $one_language_enabled;
237 my ($theme,$lang,\@themes) = themelanguage($htdocs,$tmpl,$interface,query);
239 This function returns the theme and language to be used for rendering the UI.
240 It also returns the list of themes that should be applied as a fallback. This is
241 used for the theme overlay feature (i.e. if a file doesn't exist on the requested
242 theme, fallback to the configured fallback).
244 Important: this function is used on the webinstaller too, so always consider
245 the use case where the DB is not populated already when rewriting/fixing.
250 my ($htdocs, $tmpl, $interface, $query) = @_;
251 ($query) or warn "no query in themelanguage";
253 # Select a language based on cookie, syspref available languages & browser
254 my $lang = C4::Languages::getlanguage($query);
258 my $theme_syspref = ($interface eq 'intranet') ? 'template' : 'opacthemes';
259 my $fallback_syspref = ($interface eq 'intranet') ? 'template' : 'OPACFallback';
260 # Yeah, hardcoded, last resort if the DB is not populated
261 my $hardcoded_theme = ($interface eq 'intranet') ? 'prog' : 'bootstrap';
263 # Configured theme is the first one
264 push @themes, C4::Context->preference( $theme_syspref )
265 if C4::Context->preference( $theme_syspref );
266 # Configured fallback next
267 push @themes, C4::Context->preference( $fallback_syspref )
268 if C4::Context->preference( $fallback_syspref );
269 # The hardcoded fallback theme is the last one
270 push @themes, $hardcoded_theme;
272 # Try to find first theme for the selected theme/lang, then for fallback/lang
273 my $where = $tmpl =~ /xsl$/ ? 'xslt' : 'modules';
274 for my $theme (@themes) {
275 if ( -e "$htdocs/$theme/$lang/$where/$tmpl" ) {
276 return ( $theme, $lang, [ uniq(@themes) ] );
279 # Otherwise return theme/'en', last resort fallback/'en'
280 for my $theme (@themes) {
281 if ( -e "$htdocs/$theme/en/$where/$tmpl" ) {
282 return ( $theme, 'en', [ uniq(@themes) ] );
285 # tmpl is a full path, so this is a template for a plugin
286 if ( $tmpl =~ /^\// && -e $tmpl ) {
287 return ( $themes[0], $lang, [ uniq(@themes) ] );
292 sub setlanguagecookie {
293 my ( $query, $language, $uri ) = @_;
295 my $cookie = getlanguagecookie( $query, $language );
297 # We do not want to set getlanguage in cache, some additional checks are
298 # done in C4::Languages::getlanguage
299 Koha::Cache::Memory::Lite->get_instance()->clear_from_cache( 'getlanguage' );
301 print $query->redirect(
307 =head2 getlanguagecookie
309 my $cookie = getlanguagecookie($query,$language);
311 Returns a cookie object containing the calculated language to be used.
315 sub getlanguagecookie {
316 my ( $query, $language ) = @_;
317 my $cookie = $query->cookie(
318 -name => 'KohaOpacLanguage',
329 my $columns = GetColumnDefs( $cgi )
331 It is passed a CGI object and returns a hash of hashes containing
332 the column names and descriptions for each table defined in the
333 columns.def file corresponding to the CGI object.
343 my $htdocs = C4::Context->config('intrahtdocs');
344 my $columns_file = 'columns.def';
346 # Get theme and language to build the path to columns.def
347 my ($theme, $lang, $availablethemes) =
348 themelanguage($htdocs, 'about.tt', 'intranet', $query);
349 # Build columns.def path
350 my $path = "$htdocs/$theme/$lang/$columns_file";
352 if ( ! open ( $fh, q{<:encoding(utf-8)}, $path ) ) {
353 carp "Error opening $path. Check your templates.";
356 # Loop through the columns.def file
357 while ( my $input = <$fh> ){
359 if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
360 my ( $table, $column ) = split( '\.', $1);
361 my $description = $2;
362 # Initialize the table array if needed.
363 @{$columns->{ $table }} = () if ! defined $columns->{ $table };
364 # Push field and description
365 push @{$columns->{ $table }},
366 { field => $column, description => $description };