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 ( C4
::Context
->preference("yuipath") eq "local"
105 ?
( $self->interface eq 'intranet' ?
$vars->{themelang
} . "/lib/yui" : "/opac-tmpl/lib/yui" )
106 : C4
::Context
->preference("yuipath") );
108 ( $self->{interface
} ne 'intranet' ?
'/opac-tmpl' : '/intranet-tmpl' );
109 $vars->{theme
} = $self->theme;
110 $vars->{opaccolorstylesheet
} =
111 C4
::Context
->preference('opaccolorstylesheet');
112 $vars->{opaclayoutstylesheet
} =
113 C4
::Context
->preference('opaclayoutstylesheet');
115 # add variables set via param to $vars for processing
116 # and clean any utf8 mess
117 for my $k ( keys %{ $self->{VARS
} } ) {
118 $vars->{$k} = $self->{VARS
}->{$k};
119 if (ref($vars->{$k}) eq 'ARRAY'){
120 utf8_arrayref
($vars->{$k});
122 elsif (ref($vars->{$k}) eq 'HASH'){
123 utf8_hashref
($vars->{$k});
126 utf8
::encode
($vars->{$k}) if utf8
::is_utf8
($vars->{$k});
130 # binmode( STDOUT, ":utf8" );
131 $template->process( $self->filename, $vars, \
$data )
132 || die "Template process failed: ", $template->error();
137 my $arrayref = shift;
138 foreach my $element (@
$arrayref){
139 if (ref($element) eq 'ARRAY'){
140 utf8_arrayref
($element);
143 if (ref($element) eq 'HASH'){
144 utf8_hashref
($element);
147 utf8
::encode
($element) if utf8
::is_utf8
($element);
153 for my $key (keys %{$hashref}){
154 if (ref($hashref->{$key}) eq 'ARRAY'){
155 utf8_arrayref
($hashref->{$key});
158 if (ref($hashref->{$key}) eq 'HASH'){
159 utf8_hashref
($hashref->{$key});
162 utf8
::encode
($hashref->{$key}) if utf8
::is_utf8
($hashref->{$key});
166 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
172 if ( ref($val) eq 'ARRAY' && !scalar @
$val ) { $val = undef; }
173 elsif ( ref($val) eq 'HASH' && !scalar %$val ) { $val = undef; }
175 $self->{VARS
}->{$key} = $val;
177 warn "Problem = a value of $val has been passed to param without key";
185 C4::Templates - Functions for managing templates
191 # FIXME: this is a quick fix to stop rc1 installing broken
192 # Still trying to figure out the correct fix.
193 my $path = C4
::Context
->config('intrahtdocs') . "/prog/en/includes/";
195 #---------------------------------------------------------------------------------------------------------
198 sub _get_template_file
{
199 my ($tmplbase, $interface, $query) = @_;
201 my $is_intranet = $interface eq 'intranet';
202 my $htdocs = C4
::Context
->config($is_intranet ?
'intrahtdocs' : 'opachtdocs');
203 my ($theme, $lang, $availablethemes) = themelanguage
($htdocs, $tmplbase, $interface, $query);
205 # if the template doesn't exist, load the English one as a last resort
206 my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
207 unless (-f
$filename) {
209 $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
211 return ($htdocs, $theme, $lang, $filename);
216 my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
217 ($query) or warn "no query in gettemplate";
218 my $path = C4
::Context
->preference('intranet_includes') || 'includes';
219 my ($htdocs, $theme, $lang, $filename)
220 = _get_template_file
($tmplbase, $interface, $query);
221 $filename = $tmplbase if ( $is_plugin );
222 my $template = C4
::Templates
->new($interface, $filename, $tmplbase, $query);
224 # Bidirectionality, must be sent even if is the only language
225 my $current_lang = regex_lang_subtags
($lang);
227 $bidi = get_bidi
($current_lang->{script
}) if $current_lang->{script
};
232 my $languages_loop = getTranslatedLanguages
($interface,$theme,$lang);
233 my $num_languages_enabled = 0;
234 foreach my $lang (@
$languages_loop) {
235 foreach my $sublang (@
{ $lang->{'sublanguages_loop'} }) {
236 $num_languages_enabled++ if $sublang->{enabled
};
239 my $one_language_enabled = ($num_languages_enabled <= 1) ?
1 : 0; # deal with zero enabled langs as well
241 languages_loop
=> $languages_loop,
242 one_language_enabled
=> $one_language_enabled,
243 ) unless $one_language_enabled;
249 #---------------------------------------------------------------------------------------------------------
252 my ($htdocs, $tmpl, $interface, $query) = @_;
253 ($query) or warn "no query in themelanguage";
255 # Select a language based on cookie, syspref available languages & browser
256 my $lang = C4
::Languages
::getlanguage
($query);
259 my $is_intranet = $interface eq 'intranet';
260 my @themes = split(" ", C4
::Context
->preference(
261 $is_intranet ?
"template" : "opacthemes" ));
262 push @themes, 'prog';
264 # Try to find first theme for the selected language
265 for my $theme (@themes) {
266 if ( -e
"$htdocs/$theme/$lang/modules/$tmpl" ) {
267 return ($theme, $lang, \
@themes)
270 # Otherwise, return prog theme in English 'en'
271 return ('prog', 'en', \
@themes);
275 sub setlanguagecookie
{
276 my ( $query, $language, $uri ) = @_;
278 my $cookie = $query->cookie(
279 -name
=> 'KohaOpacLanguage',
284 print $query->redirect(
290 =head2 getlanguagecookie
292 my $cookie = getlanguagecookie($query,$language);
294 Returns a cookie object containing the calculated language to be used.
298 sub getlanguagecookie
{
299 my ( $query, $language ) = @_;
300 my $cookie = $query->cookie(
301 -name
=> 'KohaOpacLanguage',
312 my $columns = GetColumnDefs( $cgi )
314 It is passed a CGI object and returns a hash of hashes containing
315 the column names and descriptions for each table defined in the
316 columns.def file corresponding to the CGI object.
326 my $htdocs = C4
::Context
->config('intrahtdocs');
327 my $columns_file = 'columns.def';
329 # Get theme and language to build the path to columns.def
330 my ($theme, $lang, $availablethemes) =
331 themelanguage
($htdocs, 'about.tt', 'intranet', $query);
332 # Build columns.def path
333 my $path = "$htdocs/$theme/$lang/$columns_file";
335 if ( ! open ( $fh, q{<}, $path ) ) {
336 carp
"Error opening $path. Check your templates.";
339 # Loop through the columns.def file
340 while ( my $input = <$fh> ){
342 if ( $input =~ m
|<field name
="(.*)">(.*)</field
>| ) {
343 my ( $table, $column ) = split( '\.', $1);
344 my $description = $2;
345 # Initialize the table array if needed.
346 @
{$columns->{ $table }} = () if ! defined $columns->{ $table };
347 # Push field and description
348 push @
{$columns->{ $table }},
349 { field
=> $column, description
=> $description };