7 use List::MoreUtils qw/any/;
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 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
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.
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
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 my $template = Template->new(
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,
71 ) or die Template->error();
73 TEMPLATE => $template,
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";
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';
99 $vars->{themelang} = '/opac-tmpl';
101 $vars->{lang} = $self->lang;
102 $vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang;
104 ( $self->{interface} ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' );
105 $vars->{theme} = $self->theme;
106 $vars->{opaccolorstylesheet} =
107 C4::Context->preference('opaccolorstylesheet');
108 $vars->{opaclayoutstylesheet} =
109 C4::Context->preference('opaclayoutstylesheet');
111 # add variables set via param to $vars for processing
112 # and clean any utf8 mess
113 for my $k ( keys %{ $self->{VARS} } ) {
114 $vars->{$k} = $self->{VARS}->{$k};
115 if (ref($vars->{$k}) eq 'ARRAY'){
116 utf8_arrayref($vars->{$k});
118 elsif (ref($vars->{$k}) eq 'HASH'){
119 utf8_hashref($vars->{$k});
122 utf8::encode($vars->{$k}) if utf8::is_utf8($vars->{$k});
126 # binmode( STDOUT, ":utf8" );
127 $template->process( $self->filename, $vars, \$data )
128 || die "Template process failed: ", $template->error();
133 my $arrayref = shift;
134 foreach my $element (@$arrayref){
135 if (ref($element) eq 'ARRAY'){
136 utf8_arrayref($element);
139 if (ref($element) eq 'HASH'){
140 utf8_hashref($element);
143 utf8::encode($element) if utf8::is_utf8($element);
149 for my $key (keys %{$hashref}){
150 if (ref($hashref->{$key}) eq 'ARRAY'){
151 utf8_arrayref($hashref->{$key});
154 if (ref($hashref->{$key}) eq 'HASH'){
155 utf8_hashref($hashref->{$key});
158 utf8::encode($hashref->{$key}) if utf8::is_utf8($hashref->{$key});
162 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
168 if ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
169 elsif ( ref($val) eq 'HASH' && !scalar %$val ) { $val = undef; }
171 $self->{VARS}->{$key} = $val;
173 warn "Problem = a value of $val has been passed to param without key";
181 C4::Templates - Functions for managing templates
187 # FIXME: this is a quick fix to stop rc1 installing broken
188 # Still trying to figure out the correct fix.
189 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
191 #---------------------------------------------------------------------------------------------------------
194 sub _get_template_file {
195 my ($tmplbase, $interface, $query) = @_;
197 my $is_intranet = $interface eq 'intranet';
198 my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs');
199 my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query);
200 my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
202 return ($htdocs, $theme, $lang, $filename);
207 my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
208 ($query) or warn "no query in gettemplate";
209 my $path = C4::Context->preference('intranet_includes') || 'includes';
210 my ($htdocs, $theme, $lang, $filename)
211 = _get_template_file($tmplbase, $interface, $query);
212 $filename = $tmplbase if ( $is_plugin );
213 my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
215 # NOTE: Commenting these out rather than deleting them so that those who need
216 # to know how we previously shimmed these directories will be able to understand.
217 # my $is_intranet = $interface eq 'intranet';
219 # ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
222 # themelang => $themelang,
223 # interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
228 # Bidirectionality, must be sent even if is the only language
229 my $current_lang = regex_lang_subtags($lang);
231 $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
236 my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
237 my $num_languages_enabled = 0;
238 foreach my $lang (@$languages_loop) {
239 foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
240 $num_languages_enabled++ if $sublang->{enabled};
243 my $one_language_enabled = ($num_languages_enabled <= 1) ? 1 : 0; # deal with zero enabled langs as well
245 languages_loop => $languages_loop,
246 one_language_enabled => $one_language_enabled,
247 ) unless $one_language_enabled;
253 #---------------------------------------------------------------------------------------------------------
255 # FIXME - Rewritten to remove hardcoded theme with minimal changes, need to be rethinked
257 my ($htdocs, $tmpl, $interface, $query) = @_;
258 ($query) or warn "no query in themelanguage";
260 # Select a language based on cookie, syspref available languages & browser
261 my $lang = C4::Languages::getlanguage($query);
264 my @themes = ( C4::Context->preference( ($interface eq 'intranet') ? 'template' : 'opacthemes' ) );
265 my $fallback = C4::Context->preference( ($interface eq 'intranet') ? 'template' : 'OPACFallback' );
266 push @themes, $fallback;
268 # Try to find first theme for the selected theme/lang, then for fallback/lang
269 for my $theme (@themes) {
270 if ( -e "$htdocs/$theme/$lang/modules/$tmpl" ) {
271 return ($theme, $lang, \@themes);
274 # Otherwise return theme/'en', last resort fallback/'en'
275 for my $theme (@themes) {
276 if ( -e "$htdocs/$theme/en/modules/$tmpl" ) {
277 return ($theme, 'en', \@themes);
283 sub setlanguagecookie {
284 my ( $query, $language, $uri ) = @_;
286 my $cookie = $query->cookie(
287 -name => 'KohaOpacLanguage',
292 print $query->redirect(
298 =head2 getlanguagecookie
300 my $cookie = getlanguagecookie($query,$language);
302 Returns a cookie object containing the calculated language to be used.
306 sub getlanguagecookie {
307 my ( $query, $language ) = @_;
308 my $cookie = $query->cookie(
309 -name => 'KohaOpacLanguage',
320 my $columns = GetColumnDefs( $cgi )
322 It is passed a CGI object and returns a hash of hashes containing
323 the column names and descriptions for each table defined in the
324 columns.def file corresponding to the CGI object.
334 my $htdocs = C4::Context->config('intrahtdocs');
335 my $columns_file = 'columns.def';
337 # Get theme and language to build the path to columns.def
338 my ($theme, $lang, $availablethemes) =
339 themelanguage($htdocs, 'about.tt', 'intranet', $query);
340 # Build columns.def path
341 my $path = "$htdocs/$theme/$lang/$columns_file";
343 if ( ! open ( $fh, q{<}, $path ) ) {
344 carp "Error opening $path. Check your templates.";
347 # Loop through the columns.def file
348 while ( my $input = <$fh> ){
350 if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
351 my ( $table, $column ) = split( '\.', $1);
352 my $description = $2;
353 # Initialize the table array if needed.
354 @{$columns->{ $table }} = () if ! defined $columns->{ $table };
355 # Push field and description
356 push @{$columns->{ $table }},
357 { field => $column, description => $description };