c212b9328e
This was tricky to catch. In current implementation, Bug 6755 introduced in C4/Templates.pm as condition to send the array of hashrefs of languages that (@$languages_loop<2), but with one language group that condition is false, there is only one element in that array. This patch changes that condition to have more than one language selected, grouped or not. Also send $bidi value always, that was only sent if there is more than one group language. To test: 1. Translate to en-GB and en-NZ, or simply do mkdirs on intranet-tmpl/prog and opac-tmpl/bootstrap 2. Go to Administration > System preferences > I18N enable those languages on staff/opac 3. Check that language chooser is nowhere to be found 4. Apply the patch 5. Reload staff/opac, now you can see language chooser NOTE: I made little changes on staff, but can't replicate bootstrap colors for selected/unselected language. Someone need to touch css files to make it happen. But that is current behavior. Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Jonathan Druart <jonathan.druart@biblibre.com> Good catch! Signed-off-by: Galen Charlton <gmc@esilibrary.com>
390 lines
12 KiB
Perl
390 lines
12 KiB
Perl
package C4::Templates;
|
||
|
||
use strict;
|
||
use warnings;
|
||
use Carp;
|
||
use CGI;
|
||
use List::MoreUtils qw/any/;
|
||
|
||
# Copyright 2009 Chris Cormack and The Koha Dev Team
|
||
#
|
||
# This file is part of Koha.
|
||
#
|
||
# Koha is free software; you can redistribute it and/or modify it under the
|
||
# terms of the GNU General Public License as published by the Free Software
|
||
# Foundation; either version 2 of the License, or (at your option) any later
|
||
# version.
|
||
#
|
||
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
|
||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
||
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||
#
|
||
# You should have received a copy of the GNU General Public License along with
|
||
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
|
||
# Suite 330, Boston, MA 02111-1307 USA
|
||
|
||
=head1 NAME
|
||
|
||
Koha::Templates - Object for manipulating templates for use with Koha
|
||
|
||
=cut
|
||
|
||
use base qw(Class::Accessor);
|
||
use Template;
|
||
use Template::Constants qw( :debug );
|
||
use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
|
||
|
||
use C4::Context;
|
||
|
||
__PACKAGE__->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars));
|
||
|
||
|
||
|
||
sub new {
|
||
my $class = shift;
|
||
my $interface = shift;
|
||
my $filename = shift;
|
||
my $tmplbase = shift;
|
||
my $query = @_? shift: undef;
|
||
my $htdocs;
|
||
if ( $interface ne "intranet" ) {
|
||
$htdocs = C4::Context->config('opachtdocs');
|
||
}
|
||
else {
|
||
$htdocs = C4::Context->config('intrahtdocs');
|
||
}
|
||
my ($theme, $lang, $activethemes)= themelanguage( $htdocs, $tmplbase, $interface, $query);
|
||
my @includes;
|
||
foreach (@$activethemes) {
|
||
push @includes, "$htdocs/$_/$lang/includes";
|
||
push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
|
||
}
|
||
my $template = Template->new(
|
||
{ EVAL_PERL => 1,
|
||
ABSOLUTE => 1,
|
||
PLUGIN_BASE => 'Koha::Template::Plugin',
|
||
COMPILE_EXT => C4::Context->config('template_cache_dir')?'.ttc':'',
|
||
COMPILE_DIR => C4::Context->config('template_cache_dir')?C4::Context->config('template_cache_dir'):'',,
|
||
INCLUDE_PATH => \@includes,
|
||
FILTERS => {},
|
||
}
|
||
) or die Template->error();
|
||
my $self = {
|
||
TEMPLATE => $template,
|
||
VARS => {},
|
||
};
|
||
bless $self, $class;
|
||
$self->theme($theme);
|
||
$self->lang($lang);
|
||
$self->activethemes($activethemes);
|
||
$self->preferredtheme($activethemes->[0]);
|
||
$self->filename($filename);
|
||
$self->htdocs($htdocs);
|
||
$self->interface($interface);
|
||
$self->{VARS}->{"test"} = "value";
|
||
return $self;
|
||
|
||
}
|
||
|
||
sub output {
|
||
my $self = shift;
|
||
my $vars = shift;
|
||
|
||
# my $file = $self->htdocs . '/' . $self->theme .'/'.$self->lang.'/'.$self->filename;
|
||
my $template = $self->{TEMPLATE};
|
||
if ( $self->interface eq 'intranet' ) {
|
||
$vars->{themelang} = '/intranet-tmpl';
|
||
}
|
||
else {
|
||
$vars->{themelang} = '/opac-tmpl';
|
||
}
|
||
$vars->{lang} = $self->lang;
|
||
$vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang;
|
||
$vars->{yuipath} =
|
||
( C4::Context->preference("yuipath") eq "local"
|
||
? ( $self->interface eq 'intranet' ? $vars->{themelang} . "/lib/yui" : "/opac-tmpl/lib/yui" )
|
||
: C4::Context->preference("yuipath") );
|
||
$vars->{interface} =
|
||
( $self->{interface} ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' );
|
||
$vars->{theme} = $self->theme;
|
||
$vars->{opaccolorstylesheet} =
|
||
C4::Context->preference('opaccolorstylesheet');
|
||
$vars->{opacsmallimage} = C4::Context->preference('opacsmallimage');
|
||
$vars->{opaclayoutstylesheet} =
|
||
C4::Context->preference('opaclayoutstylesheet');
|
||
|
||
# add variables set via param to $vars for processing
|
||
# and clean any utf8 mess
|
||
for my $k ( keys %{ $self->{VARS} } ) {
|
||
$vars->{$k} = $self->{VARS}->{$k};
|
||
if (ref($vars->{$k}) eq 'ARRAY'){
|
||
utf8_arrayref($vars->{$k});
|
||
}
|
||
elsif (ref($vars->{$k}) eq 'HASH'){
|
||
utf8_hashref($vars->{$k});
|
||
}
|
||
else {
|
||
utf8::encode($vars->{$k}) if utf8::is_utf8($vars->{$k});
|
||
}
|
||
}
|
||
my $data;
|
||
# binmode( STDOUT, ":utf8" );
|
||
$template->process( $self->filename, $vars, \$data )
|
||
|| die "Template process failed: ", $template->error();
|
||
return $data;
|
||
}
|
||
|
||
sub utf8_arrayref {
|
||
my $arrayref = shift;
|
||
foreach my $element (@$arrayref){
|
||
if (ref($element) eq 'ARRAY'){
|
||
utf8_arrayref($element);
|
||
next;
|
||
}
|
||
if (ref($element) eq 'HASH'){
|
||
utf8_hashref($element);
|
||
next;
|
||
}
|
||
utf8::encode($element) if utf8::is_utf8($element);
|
||
}
|
||
}
|
||
|
||
sub utf8_hashref {
|
||
my $hashref = shift;
|
||
for my $key (keys %{$hashref}){
|
||
if (ref($hashref->{$key}) eq 'ARRAY'){
|
||
utf8_arrayref($hashref->{$key});
|
||
next;
|
||
}
|
||
if (ref($hashref->{$key}) eq 'HASH'){
|
||
utf8_hashref($hashref->{$key});
|
||
next;
|
||
}
|
||
utf8::encode($hashref->{$key}) if utf8::is_utf8($hashref->{$key});
|
||
}
|
||
}
|
||
|
||
|
||
# FIXME - this is a horrible hack to cache
|
||
# the current known-good language, temporarily
|
||
# put in place to resolve bug 4403. It is
|
||
# used only by C4::XSLT::XSLTParse4Display;
|
||
# the language is set via the usual call
|
||
# to themelanguage.
|
||
my $_current_language = 'en';
|
||
|
||
sub _current_language {
|
||
return $_current_language;
|
||
}
|
||
|
||
|
||
# wrapper method to allow easier transition from HTML template pro to Template Toolkit
|
||
sub param {
|
||
my $self = shift;
|
||
while (@_) {
|
||
my $key = shift;
|
||
my $val = shift;
|
||
if ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
|
||
elsif ( ref($val) eq 'HASH' && !scalar %$val ) { $val = undef; }
|
||
if ( $key ) {
|
||
$self->{VARS}->{$key} = $val;
|
||
} else {
|
||
warn "Problem = a value of $val has been passed to param without key";
|
||
}
|
||
}
|
||
}
|
||
|
||
|
||
=head1 NAME
|
||
|
||
C4::Templates - Functions for managing templates
|
||
|
||
=head1 FUNCTIONS
|
||
|
||
=cut
|
||
|
||
# FIXME: this is a quick fix to stop rc1 installing broken
|
||
# Still trying to figure out the correct fix.
|
||
my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
|
||
|
||
#---------------------------------------------------------------------------------------------------------
|
||
# FIXME - POD
|
||
|
||
sub _get_template_file {
|
||
my ($tmplbase, $interface, $query) = @_;
|
||
|
||
my $is_intranet = $interface eq 'intranet';
|
||
my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs');
|
||
my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query);
|
||
|
||
# if the template doesn't exist, load the English one as a last resort
|
||
my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
|
||
unless (-f $filename) {
|
||
$lang = 'en';
|
||
$filename = "$htdocs/$theme/$lang/modules/$tmplbase";
|
||
}
|
||
return ($htdocs, $theme, $lang, $filename);
|
||
}
|
||
|
||
|
||
sub gettemplate {
|
||
my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
|
||
($query) or warn "no query in gettemplate";
|
||
my $path = C4::Context->preference('intranet_includes') || 'includes';
|
||
$tmplbase =~ s/\.tmpl$/.tt/;
|
||
my ($htdocs, $theme, $lang, $filename)
|
||
= _get_template_file($tmplbase, $interface, $query);
|
||
$filename = $tmplbase if ( $is_plugin );
|
||
my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
|
||
|
||
# NOTE: Commenting these out rather than deleting them so that those who need
|
||
# to know how we previously shimmed these directories will be able to understand.
|
||
# my $is_intranet = $interface eq 'intranet';
|
||
# my $themelang =
|
||
# ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
|
||
# "/$theme/$lang";
|
||
# $template->param(
|
||
# themelang => $themelang,
|
||
# yuipath => C4::Context->preference("yuipath") eq "local"
|
||
# ? "$themelang/lib/yui"
|
||
# : C4::Context->preference("yuipath"),
|
||
# interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl',
|
||
# theme => $theme,
|
||
# lang => $lang
|
||
# );
|
||
|
||
# Bidirectionality, must be sent even if is the only language
|
||
my $current_lang = regex_lang_subtags($lang);
|
||
my $bidi;
|
||
$bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
|
||
$template->param(
|
||
bidi => $bidi,
|
||
);
|
||
# Languages
|
||
my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
|
||
my $num_languages_enabled = 0;
|
||
foreach my $lang (@$languages_loop) {
|
||
foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
|
||
$num_languages_enabled++ if $sublang->{enabled};
|
||
}
|
||
}
|
||
my $one_language_enabled = ($num_languages_enabled <= 1) ? 1 : 0; # deal with zero enabled langs as well
|
||
$template->param(
|
||
languages_loop => $languages_loop,
|
||
one_language_enabled => $one_language_enabled,
|
||
) unless $one_language_enabled;
|
||
|
||
return $template;
|
||
}
|
||
|
||
|
||
#---------------------------------------------------------------------------------------------------------
|
||
# FIXME - POD
|
||
sub themelanguage {
|
||
my ($htdocs, $tmpl, $interface, $query) = @_;
|
||
($query) or warn "no query in themelanguage";
|
||
|
||
# Select a language based on cookie, syspref available languages & browser
|
||
my $lang = getlanguage($query, $interface);
|
||
|
||
# Select theme
|
||
my $is_intranet = $interface eq 'intranet';
|
||
my @themes = split(" ", C4::Context->preference(
|
||
$is_intranet ? "template" : "opacthemes" ));
|
||
push @themes, 'prog';
|
||
|
||
# Try to find first theme for the selected language
|
||
for my $theme (@themes) {
|
||
if ( -e "$htdocs/$theme/$lang/modules/$tmpl" ) {
|
||
$_current_language = $lang;
|
||
return ($theme, $lang, \@themes)
|
||
}
|
||
}
|
||
# Otherwise, return prog theme in English 'en'
|
||
return ('prog', 'en', \@themes);
|
||
}
|
||
|
||
|
||
sub setlanguagecookie {
|
||
my ( $query, $language, $uri ) = @_;
|
||
my $cookie = $query->cookie(
|
||
-name => 'KohaOpacLanguage',
|
||
-value => $language,
|
||
-HttpOnly => 1,
|
||
-expires => '+3y'
|
||
);
|
||
print $query->redirect(
|
||
-uri => $uri,
|
||
-cookie => $cookie
|
||
);
|
||
}
|
||
|
||
=head2 getlanguagecookie
|
||
|
||
my $cookie = getlanguagecookie($query,$language);
|
||
|
||
Returns a cookie object containing the calculated language to be used.
|
||
|
||
=cut
|
||
|
||
sub getlanguagecookie {
|
||
my ( $query, $language ) = @_;
|
||
my $cookie = $query->cookie(
|
||
-name => 'KohaOpacLanguage',
|
||
-value => $language,
|
||
-HttpOnly => 1,
|
||
-expires => '+3y'
|
||
);
|
||
|
||
return $cookie;
|
||
}
|
||
|
||
=head2 getlanguage
|
||
|
||
Select a language based on the URL parameter 'language', a cookie,
|
||
syspref available languages & browser
|
||
|
||
=cut
|
||
|
||
sub getlanguage {
|
||
my ($query, $interface) = @_;
|
||
|
||
my $preference_to_check =
|
||
$interface eq 'intranet' ? 'language' : 'opaclanguages';
|
||
# Get the available/valid languages list
|
||
my @languages = split /,/, C4::Context->preference($preference_to_check);
|
||
|
||
my $lang;
|
||
|
||
# Chose language from the URL
|
||
$lang = $query->param( 'language' );
|
||
if ( defined $lang && any { $_ eq $lang } @languages) {
|
||
return $lang;
|
||
}
|
||
|
||
# cookie
|
||
if ($query and $query->cookie('KohaOpacLanguage') ) {
|
||
$lang = $query->cookie('KohaOpacLanguage');
|
||
$lang =~ s/[^a-zA-Z_-]*//; # sanitize cookie
|
||
}
|
||
|
||
# HTTP_ACCEPT_LANGUAGE
|
||
if ( !$lang && $ENV{HTTP_ACCEPT_LANGUAGE} ) {
|
||
$lang = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE},
|
||
getTranslatedLanguages( $interface, 'prog' ) );
|
||
}
|
||
|
||
# Ignore a lang not selected in sysprefs
|
||
if ( $lang && any { $_ eq $lang } @languages ) {
|
||
return $lang;
|
||
}
|
||
|
||
# Pick the first selected syspref language
|
||
$lang = shift @languages;
|
||
return $lang if $lang;
|
||
|
||
# Fall back to English if necessary
|
||
return 'en';
|
||
}
|
||
|
||
1;
|