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 __PACKAGE__
->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars));
45 my $interface = shift;
48 my $query = @_?
shift: undef;
50 if ( $interface ne "intranet" ) {
51 $htdocs = C4
::Context
->config('opachtdocs');
54 $htdocs = C4
::Context
->config('intrahtdocs');
56 my ($theme, $lang, $activethemes)= themelanguage
( $htdocs, $tmplbase, $interface, $query);
58 foreach (@
$activethemes) {
59 push @includes, "$htdocs/$_/$lang/includes";
60 push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
62 # Do not use template cache if script is called from commandline
63 my $use_template_cache = C4
::Context
->config('template_cache_dir') && defined $ENV{GATEWAY_INTERFACE
};
64 my $template = Template
->new(
67 PLUGIN_BASE
=> 'Koha::Template::Plugin',
68 COMPILE_EXT
=> $use_template_cache ?
'.ttc' : '',
69 COMPILE_DIR
=> $use_template_cache ? C4
::Context
->config('template_cache_dir') : '',
70 INCLUDE_PATH
=> \
@includes,
74 ) or die Template
->error();
76 TEMPLATE
=> $template,
82 $self->activethemes($activethemes);
83 $self->preferredtheme($activethemes->[0]);
84 $self->filename($filename);
85 $self->htdocs($htdocs);
86 $self->interface($interface);
87 $self->{VARS
}->{"test"} = "value";
96 # my $file = $self->htdocs . '/' . $self->theme .'/'.$self->lang.'/'.$self->filename;
97 my $template = $self->{TEMPLATE
};
98 if ( $self->interface eq 'intranet' ) {
99 $vars->{themelang
} = '/intranet-tmpl';
102 $vars->{themelang
} = '/opac-tmpl';
104 $vars->{lang
} = $self->lang;
105 $vars->{themelang
} .= '/' . $self->preferredtheme . '/' . $self->lang;
107 ( $self->{interface
} ne 'intranet' ?
'/opac-tmpl' : '/intranet-tmpl' );
108 $vars->{theme
} = $self->theme;
109 $vars->{OpacAdditionalStylesheet
} =
110 C4
::Context
->preference('OpacAdditionalStylesheet');
111 $vars->{opaclayoutstylesheet
} =
112 C4
::Context
->preference('opaclayoutstylesheet');
114 # add variables set via param to $vars for processing
115 $vars = { %$vars, %{ $self->{VARS
} } };
118 binmode( STDOUT
, ":utf8" );
119 $template->process( $self->filename, $vars, \
$data )
120 || die "Template process failed: ", $template->error();
124 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
130 if ( ref($val) eq 'ARRAY' && !scalar @
$val ) { $val = undef; }
131 elsif ( ref($val) eq 'HASH' && !scalar %$val ) { $val = undef; }
133 $self->{VARS
}->{$key} = $val;
135 warn "Problem = a value of $val has been passed to param without key";
143 C4::Templates - Functions for managing templates
149 # FIXME: this is a quick fix to stop rc1 installing broken
150 # Still trying to figure out the correct fix.
151 my $path = C4
::Context
->config('intrahtdocs') . "/prog/en/includes/";
153 #---------------------------------------------------------------------------------------------------------
156 sub _get_template_file
{
157 my ($tmplbase, $interface, $query) = @_;
159 my $is_intranet = $interface eq 'intranet';
160 my $htdocs = C4
::Context
->config($is_intranet ?
'intrahtdocs' : 'opachtdocs');
161 my ($theme, $lang, $availablethemes) = themelanguage
($htdocs, $tmplbase, $interface, $query);
163 my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
165 return ($htdocs, $theme, $lang, $filename);
170 my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
171 ($query) or warn "no query in gettemplate";
172 my $path = C4
::Context
->preference('intranet_includes') || 'includes';
173 my ($htdocs, $theme, $lang, $filename)
174 = _get_template_file
($tmplbase, $interface, $query);
175 $filename = $tmplbase if ( $is_plugin );
176 my $template = C4
::Templates
->new($interface, $filename, $tmplbase, $query);
178 # NOTE: Commenting these out rather than deleting them so that those who need
179 # to know how we previously shimmed these directories will be able to understand.
180 # my $is_intranet = $interface eq 'intranet';
182 # ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
185 # themelang => $themelang,
186 # interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
191 # Bidirectionality, must be sent even if is the only language
192 my $current_lang = regex_lang_subtags
($lang);
194 $bidi = get_bidi
($current_lang->{script
}) if $current_lang->{script
};
199 my $languages_loop = getTranslatedLanguages
($interface,$theme,$lang);
200 my $num_languages_enabled = 0;
201 foreach my $lang (@
$languages_loop) {
202 foreach my $sublang (@
{ $lang->{'sublanguages_loop'} }) {
203 $num_languages_enabled++ if $sublang->{enabled
};
206 my $one_language_enabled = ($num_languages_enabled <= 1) ?
1 : 0; # deal with zero enabled langs as well
208 languages_loop
=> $languages_loop,
209 one_language_enabled
=> $one_language_enabled,
210 ) unless $one_language_enabled;
218 my ($theme,$lang,\@themes) = themelanguage($htdocs,$tmpl,$interface,query);
220 This function returns the theme and language to be used for rendering the UI.
221 It also returns the list of themes that should be applied as a fallback. This is
222 used for the theme overlay feature (i.e. if a file doesn't exist on the requested
223 theme, fallback to the configured fallback).
225 Important: this function is used on the webinstaller too, so always consider
226 the use case where the DB is not populated already when rewriting/fixing.
231 my ($htdocs, $tmpl, $interface, $query) = @_;
232 ($query) or warn "no query in themelanguage";
234 # Select a language based on cookie, syspref available languages & browser
235 my $lang = C4
::Languages
::getlanguage
($query);
239 my $theme_syspref = ($interface eq 'intranet') ?
'template' : 'opacthemes';
240 my $fallback_syspref = ($interface eq 'intranet') ?
'template' : 'OPACFallback';
241 # Yeah, hardcoded, last resort if the DB is not populated
242 my $hardcoded_theme = ($interface eq 'intranet') ?
'prog' : 'bootstrap';
244 # Configured theme is the first one
245 push @themes, C4
::Context
->preference( $theme_syspref )
246 if C4
::Context
->preference( $theme_syspref );
247 # Configured fallback next
248 push @themes, C4
::Context
->preference( $fallback_syspref )
249 if C4
::Context
->preference( $fallback_syspref );
250 # The hardcoded fallback theme is the last one
251 push @themes, $hardcoded_theme;
253 # Try to find first theme for the selected theme/lang, then for fallback/lang
254 my $where = $tmpl =~ /xsl$/ ?
'xslt' : 'modules';
255 for my $theme (@themes) {
256 if ( -e
"$htdocs/$theme/$lang/$where/$tmpl" ) {
257 return ( $theme, $lang, uniq
( \
@themes ) );
260 # Otherwise return theme/'en', last resort fallback/'en'
261 for my $theme (@themes) {
262 if ( -e
"$htdocs/$theme/en/$where/$tmpl" ) {
263 return ( $theme, 'en', uniq
( \
@themes ) );
266 # tmpl is a full path, so this is a template for a plugin
267 if ( $tmpl =~ /^\// && -e
$tmpl ) {
268 return ( $themes[0], $lang, uniq
( \
@themes ) );
273 sub setlanguagecookie
{
274 my ( $query, $language, $uri ) = @_;
276 my $cookie = $query->cookie(
277 -name
=> 'KohaOpacLanguage',
282 print $query->redirect(
288 =head2 getlanguagecookie
290 my $cookie = getlanguagecookie($query,$language);
292 Returns a cookie object containing the calculated language to be used.
296 sub getlanguagecookie
{
297 my ( $query, $language ) = @_;
298 my $cookie = $query->cookie(
299 -name
=> 'KohaOpacLanguage',
310 my $columns = GetColumnDefs( $cgi )
312 It is passed a CGI object and returns a hash of hashes containing
313 the column names and descriptions for each table defined in the
314 columns.def file corresponding to the CGI object.
324 my $htdocs = C4
::Context
->config('intrahtdocs');
325 my $columns_file = 'columns.def';
327 # Get theme and language to build the path to columns.def
328 my ($theme, $lang, $availablethemes) =
329 themelanguage
($htdocs, 'about.tt', 'intranet', $query);
330 # Build columns.def path
331 my $path = "$htdocs/$theme/$lang/$columns_file";
333 if ( ! open ( $fh, q{<:encoding(utf-8)}, $path ) ) {
334 carp
"Error opening $path. Check your templates.";
337 # Loop through the columns.def file
338 while ( my $input = <$fh> ){
340 if ( $input =~ m
|<field name
="(.*)">(.*)</field
>| ) {
341 my ( $table, $column ) = split( '\.', $1);
342 my $description = $2;
343 # Initialize the table array if needed.
344 @
{$columns->{ $table }} = () if ! defined $columns->{ $table };
345 # Push field and description
346 push @
{$columns->{ $table }},
347 { field
=> $column, description
=> $description };