Bug 8836 [Alt QA Followup] - Add confirmation dialog for deleting collections
[koha.git] / C4 / Templates.pm
blobd53d1a814da56eb57d998de1eb03baf0580fc1f2
1 package C4::Templates;
3 use strict;
4 use warnings;
5 use Carp;
6 use CGI;
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 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
16 # version.
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
26 =head1 NAME
28 Koha::Templates - Object for manipulating templates for use with Koha
30 =cut
32 use base qw(Class::Accessor);
33 use Template;
34 use Template::Constants qw( :debug );
35 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
37 use C4::Context;
39 __PACKAGE__->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars));
43 sub new {
44 my $class = shift;
45 my $interface = shift;
46 my $filename = shift;
47 my $tmplbase = shift;
48 my $query = @_? shift: undef;
49 my $htdocs;
50 if ( $interface ne "intranet" ) {
51 $htdocs = C4::Context->config('opachtdocs');
53 else {
54 $htdocs = C4::Context->config('intrahtdocs');
56 my ($theme, $lang, $activethemes)= themelanguage( $htdocs, $tmplbase, $interface, $query);
57 my @includes;
58 foreach (@$activethemes) {
59 push @includes, "$htdocs/$_/$lang/includes";
60 push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
62 my $template = Template->new(
63 { EVAL_PERL => 1,
64 ABSOLUTE => 1,
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,
69 FILTERS => {},
71 ) or die Template->error();
72 my $self = {
73 TEMPLATE => $template,
74 VARS => {},
76 bless $self, $class;
77 $self->theme($theme);
78 $self->lang($lang);
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";
85 return $self;
89 sub output {
90 my $self = shift;
91 my $vars = shift;
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';
98 else {
99 $vars->{themelang} = '/opac-tmpl';
101 $vars->{lang} = $self->lang;
102 $vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang;
103 $vars->{interface} =
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});
121 else {
122 utf8::encode($vars->{$k}) if utf8::is_utf8($vars->{$k});
125 my $data;
126 # binmode( STDOUT, ":utf8" );
127 $template->process( $self->filename, $vars, \$data )
128 || die "Template process failed: ", $template->error();
129 return $data;
132 sub utf8_arrayref {
133 my $arrayref = shift;
134 foreach my $element (@$arrayref){
135 if (ref($element) eq 'ARRAY'){
136 utf8_arrayref($element);
137 next;
139 if (ref($element) eq 'HASH'){
140 utf8_hashref($element);
141 next;
143 utf8::encode($element) if utf8::is_utf8($element);
147 sub utf8_hashref {
148 my $hashref = shift;
149 for my $key (keys %{$hashref}){
150 if (ref($hashref->{$key}) eq 'ARRAY'){
151 utf8_arrayref($hashref->{$key});
152 next;
154 if (ref($hashref->{$key}) eq 'HASH'){
155 utf8_hashref($hashref->{$key});
156 next;
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
163 sub param {
164 my $self = shift;
165 while (@_) {
166 my $key = shift;
167 my $val = shift;
168 if ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
169 elsif ( ref($val) eq 'HASH' && !scalar %$val ) { $val = undef; }
170 if ( $key ) {
171 $self->{VARS}->{$key} = $val;
172 } else {
173 warn "Problem = a value of $val has been passed to param without key";
179 =head1 NAME
181 C4::Templates - Functions for managing templates
183 =head1 FUNCTIONS
185 =cut
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 #---------------------------------------------------------------------------------------------------------
192 # FIXME - POD
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);
206 sub gettemplate {
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';
218 # my $themelang =
219 # ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
220 # "/$theme/$lang";
221 # $template->param(
222 # themelang => $themelang,
223 # interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
224 # theme => $theme,
225 # lang => $lang
226 # );
228 # Bidirectionality, must be sent even if is the only language
229 my $current_lang = regex_lang_subtags($lang);
230 my $bidi;
231 $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
232 $template->param(
233 bidi => $bidi,
235 # Languages
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
244 $template->param(
245 languages_loop => $languages_loop,
246 one_language_enabled => $one_language_enabled,
247 ) unless $one_language_enabled;
249 return $template;
253 =head2 themelanguage
255 my ($theme,$lang,\@themes) = themelanguage($htdocs,$tmpl,$interface,query);
257 This function returns the theme and language to be used for rendering the UI.
258 It also returns the list of themes that should be applied as a fallback. This is
259 used for the theme overlay feature (i.e. if a file doesn't exist on the requested
260 theme, fallback to the configured fallback).
262 Important: this function is used on the webinstaller too, so always consider
263 the use case where the DB is not populated already when rewriting/fixing.
265 =cut
267 sub themelanguage {
268 my ($htdocs, $tmpl, $interface, $query) = @_;
269 ($query) or warn "no query in themelanguage";
271 # Select a language based on cookie, syspref available languages & browser
272 my $lang = C4::Languages::getlanguage($query);
274 # Get theme
275 my @themes;
276 my $theme_syspref = ($interface eq 'intranet') ? 'template' : 'opacthemes';
277 my $fallback_syspref = ($interface eq 'intranet') ? 'template' : 'OPACFallback';
278 # Yeah, hardcoded, last resort if the DB is not populated
279 my $hardcoded_theme = ($interface eq 'intranet') ? 'prog' : 'bootstrap';
281 # Configured theme is the first one
282 push @themes, C4::Context->preference( $theme_syspref )
283 if C4::Context->preference( $theme_syspref );
284 # Configured fallback next
285 push @themes, C4::Context->preference( $fallback_syspref )
286 if C4::Context->preference( $fallback_syspref );
287 # The hardcoded fallback theme is the last one
288 push @themes, $hardcoded_theme;
290 # Try to find first theme for the selected theme/lang, then for fallback/lang
291 my $where = $tmpl =~ /xsl$/ ? 'xslt' : 'modules';
292 for my $theme (@themes) {
293 if ( -e "$htdocs/$theme/$lang/$where/$tmpl" ) {
294 return ( $theme, $lang, uniq( \@themes ) );
297 # Otherwise return theme/'en', last resort fallback/'en'
298 for my $theme (@themes) {
299 if ( -e "$htdocs/$theme/en/$where/$tmpl" ) {
300 return ( $theme, 'en', uniq( \@themes ) );
306 sub setlanguagecookie {
307 my ( $query, $language, $uri ) = @_;
309 my $cookie = $query->cookie(
310 -name => 'KohaOpacLanguage',
311 -value => $language,
312 -HttpOnly => 1,
313 -expires => '+3y'
315 print $query->redirect(
316 -uri => $uri,
317 -cookie => $cookie
321 =head2 getlanguagecookie
323 my $cookie = getlanguagecookie($query,$language);
325 Returns a cookie object containing the calculated language to be used.
327 =cut
329 sub getlanguagecookie {
330 my ( $query, $language ) = @_;
331 my $cookie = $query->cookie(
332 -name => 'KohaOpacLanguage',
333 -value => $language,
334 -HttpOnly => 1,
335 -expires => '+3y'
338 return $cookie;
341 =head2 GetColumnDefs
343 my $columns = GetColumnDefs( $cgi )
345 It is passed a CGI object and returns a hash of hashes containing
346 the column names and descriptions for each table defined in the
347 columns.def file corresponding to the CGI object.
349 =cut
351 sub GetColumnDefs {
353 my $query = shift;
355 my $columns = {};
357 my $htdocs = C4::Context->config('intrahtdocs');
358 my $columns_file = 'columns.def';
360 # Get theme and language to build the path to columns.def
361 my ($theme, $lang, $availablethemes) =
362 themelanguage($htdocs, 'about.tt', 'intranet', $query);
363 # Build columns.def path
364 my $path = "$htdocs/$theme/$lang/$columns_file";
365 my $fh;
366 if ( ! open ( $fh, q{<}, $path ) ) {
367 carp "Error opening $path. Check your templates.";
368 return;
370 # Loop through the columns.def file
371 while ( my $input = <$fh> ){
372 chomp $input;
373 if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
374 my ( $table, $column ) = split( '\.', $1);
375 my $description = $2;
376 # Initialize the table array if needed.
377 @{$columns->{ $table }} = () if ! defined $columns->{ $table };
378 # Push field and description
379 push @{$columns->{ $table }},
380 { field => $column, description => $description };
383 close $fh;
385 return $columns;