3 # Copyright 2006 (C) LibLime
4 # Joshua Ferraro <jmf@liblime.com>
5 # Portions Copyright 2009 Chris Cormack and the Koha Dev Team
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
27 use List::MoreUtils qw( any );
30 use Koha::Cache::Memory::Lite;
32 our (@ISA, @EXPORT_OK);
38 getTranslatedLanguages
42 push @EXPORT_OK, qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages getLanguages get_bidi regex_lang_subtags language_get_description accept_language getlanguage get_rfc4646_from_iso639);
47 C4::Languages - Perl Module containing language list functions for Koha
59 =head2 getFrameworkLanguages
61 Returns a reference to an array of hashes:
63 my $languages = getFrameworkLanguages();
64 for my $language(@$languages) {
65 print "$language->{language_code}\n"; # language code in iso 639-2
66 print "$language->{language_name}\n"; # language name in native script
67 print "$language->{language_locale_name}\n"; # language name in current locale
72 sub getFrameworkLanguages {
73 # get a hash with all language codes, names, and locale names
74 my $all_languages = getAllLanguages();
77 # find the available directory names
78 my $dir=C4::Context->config('intranetdir')."/installer/data/";
80 opendir ($dir_h,$dir);
81 my @listdir= grep { !/^\.|CVS/ && -d "$dir/$_"} readdir($dir_h);
84 # pull out all data for the dir names that exist
85 for my $dirname (@listdir) {
86 for my $language_set (@$all_languages) {
88 if ($dirname eq $language_set->{language_code}) {
90 'language_code'=>$dirname,
91 'language_description'=>$language_set->{language_description},
92 'native_descrition'=>$language_set->{language_native_description} }
99 =head2 getTranslatedLanguages
101 Returns a reference to an array of hashes:
103 my $languages = getTranslatedLanguages();
104 print "Available translated languages:\n";
105 for my $language(@$trlanguages) {
106 print "$language->{language_code}\n"; # language code in iso 639-2
107 print "$language->{language_name}\n"; # language name in native script
108 print "$language->{language_locale_name}\n"; # language name in current locale
113 sub getTranslatedLanguages {
114 my ($interface, $theme, $current_language, $which) = @_;
116 my @enabled_languages =
117 ( $interface && $interface eq 'intranet' )
118 ? split ",", C4::Context->preference('language')
119 : split ",", C4::Context->preference('OPACLanguages');
121 my $cache = Koha::Caches->get_instance;
122 my $cache_key = "languages_${interface}_${theme}";
123 if ($interface && $interface eq 'opac' ) {
124 my $htdocs = C4::Context->config('opachtdocs');
125 my $cached = $cache->get_from_cache($cache_key);
127 @languages = @{$cached};
129 @languages = _get_opac_language_dirs( $htdocs, $theme );
130 $cache->set_in_cache($cache_key, \@languages );
133 elsif ($interface && $interface eq 'intranet' ) {
134 my $htdocs = C4::Context->config('intrahtdocs');
135 my $cached = $cache->get_from_cache($cache_key);
137 @languages = @{$cached};
139 @languages = _get_intranet_language_dirs( $htdocs, $theme );
140 $cache->set_in_cache($cache_key, \@languages );
144 my $htdocs = C4::Context->config('intrahtdocs');
145 push @languages, _get_intranet_language_dirs( $htdocs );
147 $htdocs = C4::Context->config('opachtdocs');
148 push @languages, _get_opac_language_dirs( $htdocs );
151 $seen{$_}++ for @languages;
152 @languages = keys %seen;
154 return _build_languages_arrayref(\@languages,$current_language,\@enabled_languages);
157 =head2 getAllLanguages
159 Returns a reference to an array of hashes:
161 my $alllanguages = getAllLanguages();
162 print "Available translated languages:\n";
163 for my $language(@$alllanguages) {
164 print "$language->{language_code}\n";
165 print "$language->{language_name}\n";
166 print "$language->{language_locale_name}\n";
169 This routine is a wrapper for getLanguages().
173 sub getAllLanguages {
174 return getLanguages(shift);
179 my $lang_arrayref = getLanguages([$lang[, $isFiltered]]);
181 Returns a reference to an array of hashes of languages.
183 - If no parameter is passed to the function, it returns english languages names
184 - If a $lang parameter conforming to RFC4646 syntax is passed, the function returns languages names translated in $lang
185 If a language name is not translated in $lang in database, the function returns english language name
186 - If $isFiltered is set to true, only the detail of the languages selected in system preferences AdvanceSearchLanguages is returned.
192 my $isFiltered = shift;
195 my $dbh=C4::Context->dbh;
196 my $default_language = 'en';
197 my $current_language = $default_language;
198 my $language_list = $isFiltered ? C4::Context->preference("AdvancedSearchLanguages") : undef;
200 $current_language = regex_lang_subtags($lang)->{'language'};
202 my $sth = $dbh->prepare('SELECT * FROM language_subtag_registry WHERE type=\'language\' ORDER BY description');
204 while (my $language_subtag_registry = $sth->fetchrow_hashref) {
206 # check if language name is stored in current language
207 my $sth4= $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag =? AND lang = ?");
208 $sth4->execute($language_subtag_registry->{subtag},$current_language);
209 while (my $language_desc = $sth4->fetchrow_hashref) {
210 $desc=$language_desc->{description};
212 my $sth2= $dbh->prepare("SELECT * FROM language_descriptions LEFT JOIN language_rfc4646_to_iso639 on language_rfc4646_to_iso639.rfc4646_subtag = language_descriptions.subtag WHERE type='language' AND subtag =? AND language_descriptions.lang = ?");
214 $sth2->execute($language_subtag_registry->{subtag},$current_language);
217 $sth2->execute($language_subtag_registry->{subtag},$default_language);
219 my $sth3 = $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag=? AND lang=?");
220 # add the correct description info
221 while (my $language_descriptions = $sth2->fetchrow_hashref) {
222 $sth3->execute($language_subtag_registry->{subtag},$language_subtag_registry->{subtag});
223 my $native_description;
224 while (my $description = $sth3->fetchrow_hashref) {
225 $native_description = $description->{description};
228 # fill in the ISO6329 code
229 $language_subtag_registry->{iso639_2_code} = $language_descriptions->{iso639_2_code};
230 # fill in the native description of the language, as well as the current language's translation of that if it exists
231 if ($native_description) {
232 $language_subtag_registry->{language_description} = $native_description;
233 $language_subtag_registry->{language_description}.=" ($language_descriptions->{description})" if $language_descriptions->{description};
236 $language_subtag_registry->{language_description} = $language_descriptions->{description};
239 # Do not push unless valid iso639-2 code
240 if ( $language_subtag_registry->{ iso639_2_code } and ( !$language_list || index ( $language_list, $language_subtag_registry->{ iso639_2_code } ) >= 0) ) {
241 push @languages_loop, $language_subtag_registry;
244 return \@languages_loop;
247 sub _get_opac_language_dirs {
248 my ( $htdocs, $theme ) = @_;
251 if ( $theme and -d "$htdocs/$theme" ) {
252 (@languages) = _get_language_dirs($htdocs,$theme);
255 for my $theme ( _get_themes('opac') ) {
256 push @languages, _get_language_dirs($htdocs,$theme);
263 sub _get_intranet_language_dirs {
264 my ( $htdocs, $theme ) = @_;
267 if ( $theme and -d "$htdocs/$theme" ) {
268 @languages = _get_language_dirs($htdocs,$theme);
271 foreach my $theme ( _get_themes('intranet') ) {
272 push @languages, _get_language_dirs($htdocs,$theme);
280 Internal function, returns an array of all available themes.
282 (@themes) = &_get_themes('opac');
283 (@themes) = &_get_themes('intranet');
288 my $interface = shift;
291 if ( $interface && $interface eq 'intranet' ) {
292 $htdocs = C4::Context->config('intrahtdocs');
295 $htdocs = C4::Context->config('opachtdocs');
298 opendir $dir_h, "$htdocs";
299 my @dirlist = readdir $dir_h;
300 foreach my $directory (@dirlist) {
301 # if there's an en dir, it's a valid theme
302 -d "$htdocs/$directory/en" and push @themes, $directory;
308 =head2 _get_language_dirs
310 Internal function, returns an array of directory names, excluding non-language directories
314 sub _get_language_dirs {
315 my ($htdocs,$theme) = @_;
320 opendir $dir_h, "$htdocs/$theme";
321 for my $lang_string ( readdir $dir_h ) {
322 next if $lang_string =~/^\./;
323 next if $lang_string eq 'all';
324 next if $lang_string =~/png$/;
325 next if $lang_string =~/js$/;
326 next if $lang_string =~/css$/;
327 next if $lang_string =~/CVS$/;
328 next if $lang_string =~/\.txt$/i; #Don't read the readme.txt !
329 next if $lang_string =~/img|images|famfam|js|less|lib|sound|pdf/;
330 push @lang_strings, $lang_string;
333 return (@lang_strings);
336 =head2 _build_languages_arrayref
338 Internal function for building the ref to array of hashes
340 FIXME: this could be rewritten and simplified using map
344 sub _build_languages_arrayref {
345 my ($translated_languages,$current_language,$enabled_languages) = @_;
346 $current_language //= '';
347 my @translated_languages = @$translated_languages;
348 my @languages_loop; # the final reference to an array of hashrefs
349 my @enabled_languages = @$enabled_languages;
350 # how many languages are enabled, if one, take note, some contexts won't need to display it
352 my $track_language_groups;
353 my $current_language_regex = regex_lang_subtags($current_language);
354 # Loop through the translated languages
355 for my $translated_language (@translated_languages) {
356 # separate the language string into its subtag types
357 my $language_subtags_hashref = regex_lang_subtags($translated_language);
359 # is this language string 'enabled'?
360 for my $enabled_language (@enabled_languages) {
361 #warn "Checking out if $translated_language eq $enabled_language";
362 $language_subtags_hashref->{'enabled'} = 1 if $translated_language eq $enabled_language;
365 # group this language, key by langtag
366 $language_subtags_hashref->{'sublanguage_current'} = 1 if $translated_language eq $current_language;
367 $language_subtags_hashref->{'rfc4646_subtag'} = $translated_language;
368 $language_subtags_hashref->{'native_description'} = language_get_description($language_subtags_hashref->{language},$language_subtags_hashref->{language},'language');
369 $language_subtags_hashref->{'script_description'} = language_get_description($language_subtags_hashref->{script},$language_subtags_hashref->{'language'},'script');
370 $language_subtags_hashref->{'region_description'} = language_get_description($language_subtags_hashref->{region},$language_subtags_hashref->{'language'},'region');
371 $language_subtags_hashref->{'variant_description'} = language_get_description($language_subtags_hashref->{variant},$language_subtags_hashref->{'language'},'variant');
372 $track_language_groups->{$language_subtags_hashref->{'language'}}++;
373 push ( @{ $language_groups->{$language_subtags_hashref->{language}} }, $language_subtags_hashref );
375 # $key is a language subtag like 'en'
377 my %idx = map { $enabled_languages->[$_] => $_ } reverse 0 .. @$enabled_languages-1;
378 my @ordered_keys = sort {
379 my $aa = $language_groups->{$a}->[0]->{rfc4646_subtag};
380 my $bb = $language_groups->{$b}->[0]->{rfc4646_subtag};
381 ( exists $idx{$aa} and exists $idx{$bb} and ( $idx{$aa} cmp $idx{$bb} ) )
382 || ( exists $idx{$aa} and exists $idx{$bb} )
384 } keys %$language_groups;
386 for my $key ( @ordered_keys ) {
387 my $value = $language_groups->{$key};
388 # is this language group enabled? are any of the languages within it enabled?
390 for my $enabled_language (@enabled_languages) {
391 my $regex_enabled_language = regex_lang_subtags($enabled_language);
392 $enabled = 1 if $key eq ($regex_enabled_language->{language} // '');
394 push @languages_loop, {
395 # this is only use if there is one
396 rfc4646_subtag => @$value[0]->{rfc4646_subtag},
397 native_description => language_get_description($key,$key,'language'),
399 sublanguages_loop => $value,
400 plural => $track_language_groups->{$key} >1 ? 1 : 0,
401 current => ($current_language_regex->{language} // '') eq $key ? 1 : 0,
402 group_enabled => $enabled,
405 return \@languages_loop;
408 sub language_get_description {
409 my ($script,$lang,$type) = @_;
410 my $dbh = C4::Context->dbh;
412 my $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
413 #warn "QUERY: SELECT description FROM language_descriptions WHERE subtag=$script AND lang=$lang AND type=$type";
414 $sth->execute($script,$lang,$type);
415 while (my $descriptions = $sth->fetchrow_hashref) {
416 $desc = $descriptions->{'description'};
419 $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
420 $sth->execute($script,'en',$type);
421 while (my $descriptions = $sth->fetchrow_hashref) {
422 $desc = $descriptions->{'description'};
427 =head2 regex_lang_subtags
429 This internal sub takes a string composed according to RFC 4646 as
430 an input and returns a reference to a hash containing keys and values
431 for ( language, script, region, variant, extension, privateuse )
435 sub regex_lang_subtags {
438 # Regex for recognizing RFC 4646 well-formed tags
439 # http://www.rfc-editor.org/rfc/rfc4646.txt
441 # regexes based on : http://unicode.org/cldr/data/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
442 # The structure requires no forward references, so it reverses the order.
443 # The uppercase comments are fragments copied from RFC 4646
445 # Note: the tool requires that any real "=" or "#" or ";" in the regex be escaped.
447 my $alpha = qr/[a-zA-Z]/ ; # ALPHA
448 my $digit = qr/[0-9]/ ; # DIGIT
449 my $alphanum = qr/[a-zA-Z0-9]/ ; # ALPHA / DIGIT
450 my $x = qr/[xX]/ ; # private use singleton
451 my $singleton = qr/[a-w y-z A-W Y-Z]/ ; # other singleton
452 my $s = qr/[-]/ ; # separator -- lenient parsers will use [-_]
454 # Now do the components. The structure is slightly different to allow for capturing the right components.
455 # The notation (?:....) is a non-capturing version of (...): so the "?:" can be deleted if someone doesn't care about capturing.
457 my $extlang = qr{(?: $s $alpha{3} )}x ; # *3("-" 3ALPHA)
458 my $language = qr{(?: $alpha{2,3} | $alpha{4,8} )}x ;
459 #my $language = qr{(?: $alpha{2,3}$extlang{0,3} | $alpha{4,8} )}x ; # (2*3ALPHA [ extlang ]) / 4ALPHA / 5*8ALPHA
461 my $script = qr{(?: $alpha{4} )}x ; # 4ALPHA
463 my $region = qr{(?: $alpha{2} | $digit{3} )}x ; # 2ALPHA / 3DIGIT
465 my $variantSub = qr{(?: $digit$alphanum{3} | $alphanum{5,8} )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
466 my $variant = qr{(?: $variantSub (?: $s$variantSub )* )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
468 my $extensionSub = qr{(?: $singleton (?: $s$alphanum{2,8} )+ )}x ; # singleton 1*("-" (2*8alphanum))
469 my $extension = qr{(?: $extensionSub (?: $s$extensionSub )* )}x ; # singleton 1*("-" (2*8alphanum))
471 my $privateuse = qr{(?: $x (?: $s$alphanum{1,8} )+ )}x ; # ("x"/"X") 1*("-" (1*8alphanum))
473 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
474 # Since these are limited, this is safe even later changes to the registry --
475 # the only oddity is that it might change the type of the tag, and thus
476 # the results from the capturing groups.
477 # http://www.iana.org/assignments/language-subtag-registry
478 # Note that these have to be compared case insensitively, requiring (?i) below.
480 my $grandfathered = qr{(?: (?i)
482 | i $s (?: ami | bnn | default | enochian | hak | klingon | lux | mingo | navajo | pwn | tao | tay | tsu )
483 | sgn $s (?: BE $s fr | BE $s nl | CH $s de)
486 # For well-formedness, we don't need the ones that would otherwise pass, so they are commented out here
490 # | en $s (?: boont | GB $s oed | scouse )
491 # | no $s (?: bok | nyn)
492 # | zh $s (?: cmn | cmn $s Hans | cmn $s Hant | gan | guoyu | hakka | min | min $s nan | wuu | xiang | yue)
494 # Here is the final breakdown, with capturing groups for each of these components
495 # The language, variants, extensions, grandfathered, and private-use may have interior '-'
497 #my $root = qr{(?: ($language) (?: $s ($script) )? 40% (?: $s ($region) )? 40% (?: $s ($variant) )? 10% (?: $s ($extension) )? 5% (?: $s ($privateuse) )? 5% ) 90% | ($grandfathered) 5% | ($privateuse) 5% };
499 $string =~ qr{^ (?:($language)) (?:$s($script))? (?:$s($region))? (?:$s($variant))? (?:$s($extension))? (?:$s($privateuse))? $}xi; # |($grandfathered) | ($privateuse) $}xi;
501 'rfc4646_subtag' => $string,
512 # Script Direction Resources:
513 # http://www.w3.org/International/questions/qa-scripts
515 my ($language_script)= @_;
516 my $dbh = C4::Context->dbh;
518 my $sth = $dbh->prepare('SELECT bidi FROM language_script_bidi WHERE rfc4646_subtag=?');
519 $sth->execute($language_script);
520 while (my $result = $sth->fetchrow_hashref) {
521 $bidi = $result->{'bidi'};
526 sub accept_language {
527 # referenced http://search.cpan.org/src/CGILMORE/I18N-AcceptLanguage-1.04/lib/I18N/AcceptLanguage.pm
528 my ($clientPreferences,$supportedLanguages) = @_;
530 if ($clientPreferences) {
531 # There should be no whitespace anways, but a cleanliness/sanity check
532 $clientPreferences =~ s/\s//g;
533 # Prepare the list of client-acceptable languages
534 foreach my $tag (split(/,/, $clientPreferences)) {
535 my ($language, $quality) = split(/\;/, $tag);
536 $quality =~ s/^q=//i if $quality;
537 $quality = 1 unless $quality;
538 next if $quality <= 0;
539 # We want to force the wildcard to be last
540 $quality = 0 if ($language eq '*');
541 # Pushing lowercase language here saves processing later
542 push(@languages, { quality => $quality,
543 language => $language,
544 lclanguage => lc($language) });
547 carp "accept_language(x,y) called with no clientPreferences (x).";
549 # Prepare the list of server-supported languages
550 my %supportedLanguages = ();
551 my %secondaryLanguages = ();
552 foreach my $language (@$supportedLanguages) {
553 # warn "Language supported: " . $language->{language};
554 my $subtag = $language->{rfc4646_subtag};
555 $supportedLanguages{lc($subtag)} = $subtag;
556 if ( $subtag =~ /^([^-]+)-?/ ) {
557 $secondaryLanguages{lc($1)} = $subtag;
561 # Reverse sort the list, making best quality at the front of the array
562 @languages = sort { $b->{quality} <=> $a->{quality} } @languages;
563 my $secondaryMatch = '';
564 foreach my $tag (@languages) {
565 if (exists($supportedLanguages{$tag->{lclanguage}})) {
566 # Client en-us eq server en-us
567 return $supportedLanguages{$tag->{language}} if exists($supportedLanguages{$tag->{language}});
568 return $supportedLanguages{$tag->{lclanguage}};
569 } elsif (exists($secondaryLanguages{$tag->{lclanguage}})) {
570 # Client en eq server en-us
571 return $secondaryLanguages{$tag->{language}} if exists($secondaryLanguages{$tag->{language}});
572 return $supportedLanguages{$tag->{lclanguage}};
573 } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
574 # Client en-gb eq server en-us
575 $secondaryMatch = $secondaryLanguages{$1};
576 } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
577 # FIXME: We just checked the exact same conditional!
578 # Client en-us eq server en
579 $secondaryMatch = $supportedLanguages{$1};
580 } elsif ($tag->{lclanguage} eq '*') {
581 # * matches every language not already specified.
582 # It doesn't care which we pick, so let's pick the default,
583 # if available, then the first in the array.
584 #return $acceptor->defaultLanguage() if $acceptor->defaultLanguage();
585 return $supportedLanguages->[0];
588 # No primary matches. Secondary? (ie, en-us requested and en supported)
589 return $secondaryMatch if $secondaryMatch;
590 return; # else, we got nothing.
595 Select a language based on the URL parameter 'language', a cookie,
596 syspref available languages & browser
603 my $memory_cache = Koha::Cache::Memory::Lite->get_instance();
604 my $cache_key = "getlanguage";
605 unless ( $cgi and $cgi->param('language') ) {
606 my $cached = $memory_cache->get_from_cache($cache_key);
607 return $cached if $cached;
611 my $interface = C4::Context->interface;
612 my $theme = C4::Context->preference( ( $interface eq 'opac' ) ? 'opacthemes' : 'template' );
615 my $preference_to_check =
616 $interface eq 'intranet' ? 'language' : 'OPACLanguages';
617 # Get the available/valid languages list
619 my $preference_value = C4::Context->preference($preference_to_check);
620 if ($preference_value) {
621 @languages = split /,/, $preference_value;
624 # Chose language from the URL
625 my $cgi_param_language = $cgi->param( 'language' );
626 if ( defined $cgi_param_language && any { $_ eq $cgi_param_language } @languages) {
627 $language = $cgi_param_language;
631 if (not $language and my $cgi_cookie_language = $cgi->cookie('KohaOpacLanguage') ) {
632 ( $language = $cgi_cookie_language ) =~ s/[^a-zA-Z_-]*//; # sanitize cookie
635 # HTTP_ACCEPT_LANGUAGE
636 if ( !$language && $ENV{HTTP_ACCEPT_LANGUAGE} ) {
637 $language = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE},
638 getTranslatedLanguages( $interface, $theme ) );
641 # Ignore a lang not selected in sysprefs
642 if ( $language && not any { $_ eq $language } @languages ) {
646 # Pick the first selected syspref language
647 $language = shift @languages unless $language;
649 # Fall back to English if necessary
652 $memory_cache->set_in_cache( $cache_key, $language );
656 =head2 get_rfc4646_from_iso639
658 Select a language rfc4646 code given an iso639 code
662 sub get_rfc4646_from_iso639 {
664 my $iso_code = shift;
665 my $rfc_subtag = Koha::Database->new()->schema->resultset('LanguageRfc4646ToIso639')->find({iso639_2_code=>$iso_code});
667 return $rfc_subtag->rfc4646_subtag;