From 12fbb6148ac66b04a316c75cea94668224113466 Mon Sep 17 00:00:00 2001 From: Julian Maurice Date: Wed, 26 Feb 2014 13:20:37 +0100 Subject: [PATCH] [PASSED QA] Bug 11848: Move language detection function in C4::Languages and store interface (intranet, opac) in context to not have to pass it as parameter. Signed-off-by: Bernardo Gonzalez Kriegel No koha-qa errors Signed-off-by: Katrin Fischer Comments on last patch. --- C4/Auth.pm | 7 +++-- C4/Context.pm | 11 ++++++++ C4/Languages.pm | 59 +++++++++++++++++++++++++++++++++++++++--- C4/Templates.pm | 51 ++---------------------------------- catalogue/search.pl | 4 ++- opac/opac-search.pl | 4 ++- t/{Templates.t => Languages.t} | 9 ++++--- 7 files changed, 85 insertions(+), 60 deletions(-) rename t/{Templates.t => Languages.t} (79%) diff --git a/C4/Auth.pm b/C4/Auth.pm index 44edf67..40071ed 100644 --- a/C4/Auth.pm +++ b/C4/Auth.pm @@ -27,6 +27,7 @@ use CGI::Session; require Exporter; use C4::Context; use C4::Templates; # to get the template +use C4::Languages; use C4::Branch; # GetBranches use C4::VirtualShelves; use Koha::AuthUtils qw(hash_password); @@ -139,6 +140,8 @@ sub get_template_and_user { my $in = shift; my ( $user, $cookie, $sessionID, $flags ); + C4::Context->interface($in->{type}); + my $template = C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, @@ -470,9 +473,9 @@ sub get_template_and_user { # Check if we were asked using parameters to force a specific language if ( defined $in->{'query'}->param('language') ) { - # Extract the language, let C4::Templates::getlanguage choose + # Extract the language, let C4::Languages::getlanguage choose # what to do - my $language = C4::Templates::getlanguage($in->{'query'},$in->{'type'}); + my $language = C4::Languages::getlanguage($in->{'query'}); my $languagecookie = C4::Templates::getlanguagecookie($in->{'query'},$language); if ( ref $cookie eq 'ARRAY' ) { push @{ $cookie }, $languagecookie; diff --git a/C4/Context.pm b/C4/Context.pm index 71a0f8c..1bc70b2 100644 --- a/C4/Context.pm +++ b/C4/Context.pm @@ -1261,6 +1261,17 @@ sub IsSuperLibrarian { return ($userenv->{flags}//0) % 2; } +sub interface { + my ($class, $interface) = @_; + + if (defined $interface) { + $interface ||= 'opac'; + $context->{interface} = $interface; + } + + return $context->{interface}; +} + 1; __END__ diff --git a/C4/Languages.pm b/C4/Languages.pm index 6e258cb..930db2b 100644 --- a/C4/Languages.pm +++ b/C4/Languages.pm @@ -19,9 +19,12 @@ package C4::Languages; # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -use strict; -#use warnings; FIXME - Bug 2505 +use strict; +use warnings; + use Carp; +use CGI; +use List::MoreUtils qw( any ); use C4::Context; use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG); @@ -46,7 +49,7 @@ BEGIN { &getLanguages &getAllLanguages ); - @EXPORT_OK = qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages getLanguages get_bidi regex_lang_subtags language_get_description accept_language); + @EXPORT_OK = qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages getLanguages get_bidi regex_lang_subtags language_get_description accept_language getlanguage); $DEBUG = 0; } @@ -552,6 +555,56 @@ sub accept_language { return $secondaryMatch if $secondaryMatch; return undef; # else, we got nothing. } + +=head2 getlanguage + + Select a language based on the URL parameter 'language', a cookie, + syspref available languages & browser + +=cut + +sub getlanguage { + my ($cgi) = @_; + + $cgi //= new CGI; + my $interface = C4::Context->interface; + my $language; + + my $preference_to_check = + $interface eq 'intranet' ? 'language' : 'opaclanguages'; + # Get the available/valid languages list + my @languages = split /,/, C4::Context->preference($preference_to_check); + + # Chose language from the URL + $language = $cgi->param( 'language' ); + if ( defined $language && any { $_ eq $language } @languages) { + return $language; + } + + # cookie + if ($language = $cgi->cookie('KohaOpacLanguage') ) { + $language =~ s/[^a-zA-Z_-]*//; # sanitize cookie + } + + # HTTP_ACCEPT_LANGUAGE + if ( !$language && $ENV{HTTP_ACCEPT_LANGUAGE} ) { + $language = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE}, + getTranslatedLanguages( $interface, 'prog' ) ); + } + + # Ignore a lang not selected in sysprefs + if ( $language && any { $_ eq $language } @languages ) { + return $language; + } + + # Pick the first selected syspref language + $language = shift @languages; + return $language if $language; + + # Fall back to English if necessary + return 'en'; +} + 1; __END__ diff --git a/C4/Templates.pm b/C4/Templates.pm index 0b49862..8d13a49 100644 --- a/C4/Templates.pm +++ b/C4/Templates.pm @@ -285,7 +285,7 @@ sub themelanguage { ($query) or warn "no query in themelanguage"; # Select a language based on cookie, syspref available languages & browser - my $lang = getlanguage($query, $interface); + my $lang = C4::Languages::getlanguage($query); # Select theme my $is_intranet = $interface eq 'intranet'; @@ -307,6 +307,7 @@ sub themelanguage { sub setlanguagecookie { my ( $query, $language, $uri ) = @_; + my $cookie = $query->cookie( -name => 'KohaOpacLanguage', -value => $language, @@ -339,52 +340,4 @@ sub getlanguagecookie { 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; diff --git a/catalogue/search.pl b/catalogue/search.pl index b3419be..7c8a2a0 100755 --- a/catalogue/search.pl +++ b/catalogue/search.pl @@ -160,7 +160,6 @@ use CGI qw('-no_undef_params'); my $cgi = new CGI; my ($template,$borrowernumber,$cookie); -my $lang = C4::Templates::getlanguage($cgi, 'intranet'); # decide which template to use my $template_name; my $template_type; @@ -181,6 +180,9 @@ else { flagsrequired => { catalogue => 1 }, } ); + +my $lang = C4::Languages::getlanguage($cgi); + if (C4::Context->preference("marcflavour") eq "UNIMARC" ) { $template->param('UNIMARC' => 1); } diff --git a/opac/opac-search.pl b/opac/opac-search.pl index e2236c2..fac3880 100755 --- a/opac/opac-search.pl +++ b/opac/opac-search.pl @@ -90,7 +90,6 @@ BEGIN { } my ($template,$borrowernumber,$cookie); -my $lang = C4::Templates::getlanguage($cgi, 'opac'); # decide which template to use my $template_name; my $template_type = 'basic'; @@ -120,6 +119,9 @@ else { authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ), } ); + +my $lang = C4::Languages::getlanguage($cgi); + if ($template_name eq 'opac-results.tmpl') { $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults')); } diff --git a/t/Templates.t b/t/Languages.t similarity index 79% rename from t/Templates.t rename to t/Languages.t index 9343b38..9cafbd7 100644 --- a/t/Templates.t +++ b/t/Languages.t @@ -1,6 +1,7 @@ #!/usr/bin/perl # Copyright 2013 Equinox Software, Inc. +# Copyright 2014 BibLibre # # This file is part of Koha. # @@ -22,7 +23,7 @@ use Test::MockModule; use CGI; BEGIN { - use_ok('C4::Templates'); + use_ok('C4::Languages'); } my @languages = (); # stores the list of active languages @@ -41,11 +42,11 @@ $module_context->mock( }, ); -delete $ENV{TTTP_ACCEPT_LANGUAGE}; +delete $ENV{HTTP_ACCEPT_LANGUAGE}; my $query = CGI->new(); @languages = ('de-DE', 'fr-FR'); -is(C4::Templates::getlanguage($query, 'opac'), 'de-DE', 'default to first language specified in syspref (bug 10560)'); +is(C4::Languages::getlanguage($query), 'de-DE', 'default to first language specified in syspref (bug 10560)'); @languages = (); -is(C4::Templates::getlanguage($query, 'opac'), 'en', 'default to English if no language specified in syspref (bug 10560)'); +is(C4::Languages::getlanguage($query), 'en', 'default to English if no language specified in syspref (bug 10560)'); -- 1.8.3.2