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 under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 use List::MoreUtils qw( any );
29 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
32 if (C4::Context->ismemcached) {
33 require Memoize::Memcached;
34 import Memoize::Memcached qw(memoize_memcached);
36 memoize_memcached('getTranslatedLanguages', memcached => C4::Context->memcached);
37 memoize_memcached('getFrameworkLanguages' , memcached => C4::Context->memcached);
38 memoize_memcached('getAllLanguages', memcached => C4::Context->memcached);
43 $VERSION = 3.07.00.049;
47 &getFrameworkLanguages
48 &getTranslatedLanguages
52 @EXPORT_OK = qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages getLanguages get_bidi regex_lang_subtags language_get_description accept_language getlanguage);
58 C4::Languages - Perl Module containing language list functions for Koha
70 =head2 getFrameworkLanguages
72 Returns a reference to an array of hashes:
74 my $languages = getFrameworkLanguages();
75 for my $language(@$languages) {
76 print "$language->{language_code}\n"; # language code in iso 639-2
77 print "$language->{language_name}\n"; # language name in native script
78 print "$language->{language_locale_name}\n"; # language name in current locale
83 sub getFrameworkLanguages {
84 # get a hash with all language codes, names, and locale names
85 my $all_languages = getAllLanguages();
88 # find the available directory names
89 my $dir=C4::Context->config('intranetdir')."/installer/data/";
91 my @listdir= grep { !/^\.|CVS/ && -d "$dir/$_"} readdir(MYDIR);
94 # pull out all data for the dir names that exist
95 for my $dirname (@listdir) {
96 for my $language_set (@$all_languages) {
98 if ($dirname eq $language_set->{language_code}) {
100 'language_code'=>$dirname,
101 'language_description'=>$language_set->{language_description},
102 'native_descrition'=>$language_set->{language_native_description} }
109 =head2 getTranslatedLanguages
111 Returns a reference to an array of hashes:
113 my $languages = getTranslatedLanguages();
114 print "Available translated languages:\n";
115 for my $language(@$trlanguages) {
116 print "$language->{language_code}\n"; # language code in iso 639-2
117 print "$language->{language_name}\n"; # language name in native script
118 print "$language->{language_locale_name}\n"; # language name in current locale
123 sub getTranslatedLanguages {
124 my ($interface, $theme, $current_language, $which) = @_;
127 my @enabled_languages;
129 if ($interface && $interface eq 'opac' ) {
130 @enabled_languages = split ",", C4::Context->preference('opaclanguages');
131 $htdocs = C4::Context->config('opachtdocs');
132 if ( $theme and -d "$htdocs/$theme" ) {
133 (@languages) = _get_language_dirs($htdocs,$theme);
136 for my $theme ( _get_themes('opac') ) {
137 push @languages, _get_language_dirs($htdocs,$theme);
141 elsif ($interface && $interface eq 'intranet' ) {
142 @enabled_languages = split ",", C4::Context->preference('language');
143 $htdocs = C4::Context->config('intrahtdocs');
144 if ( $theme and -d "$htdocs/$theme" ) {
145 @languages = _get_language_dirs($htdocs,$theme);
148 foreach my $theme ( _get_themes('intranet') ) {
149 push @languages, _get_language_dirs($htdocs,$theme);
154 @enabled_languages = split ",", C4::Context->preference('opaclanguages');
155 my $htdocs = C4::Context->config('intrahtdocs');
156 foreach my $theme ( _get_themes('intranet') ) {
157 push @languages, _get_language_dirs($htdocs,$theme);
159 $htdocs = C4::Context->config('opachtdocs');
160 foreach my $theme ( _get_themes('opac') ) {
161 push @languages, _get_language_dirs($htdocs,$theme);
164 $seen{$_}++ for @languages;
165 @languages = keys %seen;
167 return _build_languages_arrayref(\@languages,$current_language,\@enabled_languages);
170 =head2 getAllLanguages
172 Returns a reference to an array of hashes:
174 my $alllanguages = getAllLanguages();
175 print "Available translated languages:\n";
176 for my $language(@$alllanguages) {
177 print "$language->{language_code}\n";
178 print "$language->{language_name}\n";
179 print "$language->{language_locale_name}\n";
182 This routine is a wrapper for getLanguages().
186 sub getAllLanguages {
187 return getLanguages(shift);
192 my $lang_arrayref = getLanguages([$lang[, $isFiltered]]);
194 Returns a reference to an array of hashes of languages.
196 - If no parameter is passed to the function, it returns english languages names
197 - If a $lang parameter conforming to RFC4646 syntax is passed, the function returns languages names translated in $lang
198 If a language name is not translated in $lang in database, the function returns english language name
199 - If $isFiltered is set to true, only the detail of the languages selected in system preferences AdvanceSearchLanguages is returned.
205 my $isFiltered = shift;
208 my $dbh=C4::Context->dbh;
209 my $default_language = 'en';
210 my $current_language = $default_language;
211 my $language_list = $isFiltered ? C4::Context->preference("AdvancedSearchLanguages") : undef;
213 $current_language = regex_lang_subtags($lang)->{'language'};
215 my $sth = $dbh->prepare('SELECT * FROM language_subtag_registry WHERE type=\'language\'');
217 while (my $language_subtag_registry = $sth->fetchrow_hashref) {
219 # check if language name is stored in current language
220 my $sth4= $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag =? AND lang = ?");
221 $sth4->execute($language_subtag_registry->{subtag},$current_language);
222 while (my $language_desc = $sth4->fetchrow_hashref) {
223 $desc=$language_desc->{description};
225 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 = ?");
227 $sth2->execute($language_subtag_registry->{subtag},$current_language);
230 $sth2->execute($language_subtag_registry->{subtag},$default_language);
232 my $sth3 = $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag=? AND lang=?");
233 # add the correct description info
234 while (my $language_descriptions = $sth2->fetchrow_hashref) {
235 $sth3->execute($language_subtag_registry->{subtag},$language_subtag_registry->{subtag});
236 my $native_description;
237 while (my $description = $sth3->fetchrow_hashref) {
238 $native_description = $description->{description};
241 # fill in the ISO6329 code
242 $language_subtag_registry->{iso639_2_code} = $language_descriptions->{iso639_2_code};
243 # fill in the native description of the language, as well as the current language's translation of that if it exists
244 if ($native_description) {
245 $language_subtag_registry->{language_description} = $native_description;
246 $language_subtag_registry->{language_description}.=" ($language_descriptions->{description})" if $language_descriptions->{description};
249 $language_subtag_registry->{language_description} = $language_descriptions->{description};
252 if ( !$language_list || index ( $language_list, $language_subtag_registry->{ iso639_2_code } ) >= 0) {
253 push @languages_loop, $language_subtag_registry;
256 return \@languages_loop;
261 Internal function, returns an array of all available themes.
263 (@themes) = &_get_themes('opac');
264 (@themes) = &_get_themes('intranet');
269 my $interface = shift;
272 if ( $interface eq 'intranet' ) {
273 $htdocs = C4::Context->config('intrahtdocs');
276 $htdocs = C4::Context->config('opachtdocs');
278 opendir D, "$htdocs";
279 my @dirlist = readdir D;
280 foreach my $directory (@dirlist) {
281 # if there's an en dir, it's a valid theme
282 -d "$htdocs/$directory/en" and push @themes, $directory;
287 =head2 _get_language_dirs
289 Internal function, returns an array of directory names, excluding non-language directories
293 sub _get_language_dirs {
294 my ($htdocs,$theme) = @_;
296 opendir D, "$htdocs/$theme";
297 for my $lang_string ( readdir D ) {
298 next if $lang_string =~/^\./;
299 next if $lang_string eq 'all';
300 next if $lang_string =~/png$/;
301 next if $lang_string =~/js$/;
302 next if $lang_string =~/css$/;
303 next if $lang_string =~/CVS$/;
304 next if $lang_string =~/\.txt$/i; #Don't read the readme.txt !
305 next if $lang_string =~/img|images|famfam|js|less|lib|sound|pdf/;
306 push @lang_strings, $lang_string;
308 return (@lang_strings);
311 =head2 _build_languages_arrayref
313 Internal function for building the ref to array of hashes
315 FIXME: this could be rewritten and simplified using map
319 sub _build_languages_arrayref {
320 my ($translated_languages,$current_language,$enabled_languages) = @_;
321 my @translated_languages = @$translated_languages;
322 my @languages_loop; # the final reference to an array of hashrefs
323 my @enabled_languages = @$enabled_languages;
324 # how many languages are enabled, if one, take note, some contexts won't need to display it
325 my %seen_languages; # the language tags we've seen
328 my $track_language_groups;
329 my $current_language_regex = regex_lang_subtags($current_language);
330 # Loop through the translated languages
331 for my $translated_language (@translated_languages) {
332 # separate the language string into its subtag types
333 my $language_subtags_hashref = regex_lang_subtags($translated_language);
335 # is this language string 'enabled'?
336 for my $enabled_language (@enabled_languages) {
337 #warn "Checking out if $translated_language eq $enabled_language";
338 $language_subtags_hashref->{'enabled'} = 1 if $translated_language eq $enabled_language;
341 # group this language, key by langtag
342 $language_subtags_hashref->{'sublanguage_current'} = 1 if $translated_language eq $current_language;
343 $language_subtags_hashref->{'rfc4646_subtag'} = $translated_language;
344 $language_subtags_hashref->{'native_description'} = language_get_description($language_subtags_hashref->{language},$language_subtags_hashref->{language},'language');
345 $language_subtags_hashref->{'script_description'} = language_get_description($language_subtags_hashref->{script},$language_subtags_hashref->{'language'},'script');
346 $language_subtags_hashref->{'region_description'} = language_get_description($language_subtags_hashref->{region},$language_subtags_hashref->{'language'},'region');
347 $language_subtags_hashref->{'variant_description'} = language_get_description($language_subtags_hashref->{variant},$language_subtags_hashref->{'language'},'variant');
348 $track_language_groups->{$language_subtags_hashref->{'language'}}++;
349 push ( @{ $language_groups->{$language_subtags_hashref->{language}} }, $language_subtags_hashref );
351 # $key is a language subtag like 'en'
352 while( my ($key, $value) = each %$language_groups) {
354 # is this language group enabled? are any of the languages within it enabled?
356 for my $enabled_language (@enabled_languages) {
357 my $regex_enabled_language = regex_lang_subtags($enabled_language);
358 $enabled = 1 if $key eq $regex_enabled_language->{language};
360 push @languages_loop, {
361 # this is only use if there is one
362 rfc4646_subtag => @$value[0]->{rfc4646_subtag},
363 native_description => language_get_description($key,$key,'language'),
365 sublanguages_loop => $value,
366 plural => $track_language_groups->{$key} >1 ? 1 : 0,
367 current => $current_language_regex->{language} eq $key ? 1 : 0,
368 group_enabled => $enabled,
371 return \@languages_loop;
374 sub language_get_description {
375 my ($script,$lang,$type) = @_;
376 my $dbh = C4::Context->dbh;
378 my $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
379 #warn "QUERY: SELECT description FROM language_descriptions WHERE subtag=$script AND lang=$lang AND type=$type";
380 $sth->execute($script,$lang,$type);
381 while (my $descriptions = $sth->fetchrow_hashref) {
382 $desc = $descriptions->{'description'};
385 $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
386 $sth->execute($script,'en',$type);
387 while (my $descriptions = $sth->fetchrow_hashref) {
388 $desc = $descriptions->{'description'};
393 =head2 regex_lang_subtags
395 This internal sub takes a string composed according to RFC 4646 as
396 an input and returns a reference to a hash containing keys and values
397 for ( language, script, region, variant, extension, privateuse )
401 sub regex_lang_subtags {
404 # Regex for recognizing RFC 4646 well-formed tags
405 # http://www.rfc-editor.org/rfc/rfc4646.txt
407 # regexes based on : http://unicode.org/cldr/data/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
408 # The structure requires no forward references, so it reverses the order.
409 # The uppercase comments are fragments copied from RFC 4646
411 # Note: the tool requires that any real "=" or "#" or ";" in the regex be escaped.
413 my $alpha = qr/[a-zA-Z]/ ; # ALPHA
414 my $digit = qr/[0-9]/ ; # DIGIT
415 my $alphanum = qr/[a-zA-Z0-9]/ ; # ALPHA / DIGIT
416 my $x = qr/[xX]/ ; # private use singleton
417 my $singleton = qr/[a-w y-z A-W Y-Z]/ ; # other singleton
418 my $s = qr/[-]/ ; # separator -- lenient parsers will use [-_]
420 # Now do the components. The structure is slightly different to allow for capturing the right components.
421 # The notation (?:....) is a non-capturing version of (...): so the "?:" can be deleted if someone doesn't care about capturing.
423 my $extlang = qr{(?: $s $alpha{3} )}x ; # *3("-" 3ALPHA)
424 my $language = qr{(?: $alpha{2,3} | $alpha{4,8} )}x ;
425 #my $language = qr{(?: $alpha{2,3}$extlang{0,3} | $alpha{4,8} )}x ; # (2*3ALPHA [ extlang ]) / 4ALPHA / 5*8ALPHA
427 my $script = qr{(?: $alpha{4} )}x ; # 4ALPHA
429 my $region = qr{(?: $alpha{2} | $digit{3} )}x ; # 2ALPHA / 3DIGIT
431 my $variantSub = qr{(?: $digit$alphanum{3} | $alphanum{5,8} )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
432 my $variant = qr{(?: $variantSub (?: $s$variantSub )* )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
434 my $extensionSub = qr{(?: $singleton (?: $s$alphanum{2,8} )+ )}x ; # singleton 1*("-" (2*8alphanum))
435 my $extension = qr{(?: $extensionSub (?: $s$extensionSub )* )}x ; # singleton 1*("-" (2*8alphanum))
437 my $privateuse = qr{(?: $x (?: $s$alphanum{1,8} )+ )}x ; # ("x"/"X") 1*("-" (1*8alphanum))
439 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
440 # Since these are limited, this is safe even later changes to the registry --
441 # the only oddity is that it might change the type of the tag, and thus
442 # the results from the capturing groups.
443 # http://www.iana.org/assignments/language-subtag-registry
444 # Note that these have to be compared case insensitively, requiring (?i) below.
446 my $grandfathered = qr{(?: (?i)
448 | i $s (?: ami | bnn | default | enochian | hak | klingon | lux | mingo | navajo | pwn | tao | tay | tsu )
449 | sgn $s (?: BE $s fr | BE $s nl | CH $s de)
452 # For well-formedness, we don't need the ones that would otherwise pass, so they are commented out here
456 # | en $s (?: boont | GB $s oed | scouse )
457 # | no $s (?: bok | nyn)
458 # | zh $s (?: cmn | cmn $s Hans | cmn $s Hant | gan | guoyu | hakka | min | min $s nan | wuu | xiang | yue)
460 # Here is the final breakdown, with capturing groups for each of these components
461 # The language, variants, extensions, grandfathered, and private-use may have interior '-'
463 #my $root = qr{(?: ($language) (?: $s ($script) )? 40% (?: $s ($region) )? 40% (?: $s ($variant) )? 10% (?: $s ($extension) )? 5% (?: $s ($privateuse) )? 5% ) 90% | ($grandfathered) 5% | ($privateuse) 5% };
465 $string =~ qr{^ (?:($language)) (?:$s($script))? (?:$s($region))? (?:$s($variant))? (?:$s($extension))? (?:$s($privateuse))? $}xi; # |($grandfathered) | ($privateuse) $}xi;
467 'rfc4646_subtag' => $string,
478 # Script Direction Resources:
479 # http://www.w3.org/International/questions/qa-scripts
481 my ($language_script)= @_;
482 my $dbh = C4::Context->dbh;
484 my $sth = $dbh->prepare('SELECT bidi FROM language_script_bidi WHERE rfc4646_subtag=?');
485 $sth->execute($language_script);
486 while (my $result = $sth->fetchrow_hashref) {
487 $bidi = $result->{'bidi'};
492 sub accept_language {
493 # referenced http://search.cpan.org/src/CGILMORE/I18N-AcceptLanguage-1.04/lib/I18N/AcceptLanguage.pm
494 my ($clientPreferences,$supportedLanguages) = @_;
496 if ($clientPreferences) {
497 # There should be no whitespace anways, but a cleanliness/sanity check
498 $clientPreferences =~ s/\s//g;
499 # Prepare the list of client-acceptable languages
500 foreach my $tag (split(/,/, $clientPreferences)) {
501 my ($language, $quality) = split(/\;/, $tag);
502 $quality =~ s/^q=//i if $quality;
503 $quality = 1 unless $quality;
504 next if $quality <= 0;
505 # We want to force the wildcard to be last
506 $quality = 0 if ($language eq '*');
507 # Pushing lowercase language here saves processing later
508 push(@languages, { quality => $quality,
509 language => $language,
510 lclanguage => lc($language) });
513 carp "accept_language(x,y) called with no clientPreferences (x).";
515 # Prepare the list of server-supported languages
516 my %supportedLanguages = ();
517 my %secondaryLanguages = ();
518 foreach my $language (@$supportedLanguages) {
519 # warn "Language supported: " . $language->{language};
520 my $subtag = $language->{rfc4646_subtag};
521 $supportedLanguages{lc($subtag)} = $subtag;
522 if ( $subtag =~ /^([^-]+)-?/ ) {
523 $secondaryLanguages{lc($1)} = $subtag;
527 # Reverse sort the list, making best quality at the front of the array
528 @languages = sort { $b->{quality} <=> $a->{quality} } @languages;
529 my $secondaryMatch = '';
530 foreach my $tag (@languages) {
531 if (exists($supportedLanguages{$tag->{lclanguage}})) {
532 # Client en-us eq server en-us
533 return $supportedLanguages{$tag->{language}} if exists($supportedLanguages{$tag->{language}});
534 return $supportedLanguages{$tag->{lclanguage}};
535 } elsif (exists($secondaryLanguages{$tag->{lclanguage}})) {
536 # Client en eq server en-us
537 return $secondaryLanguages{$tag->{language}} if exists($secondaryLanguages{$tag->{language}});
538 return $supportedLanguages{$tag->{lclanguage}};
539 } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
540 # Client en-gb eq server en-us
541 $secondaryMatch = $secondaryLanguages{$1};
542 } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
543 # FIXME: We just checked the exact same conditional!
544 # Client en-us eq server en
545 $secondaryMatch = $supportedLanguages{$1};
546 } elsif ($tag->{lclanguage} eq '*') {
547 # * matches every language not already specified.
548 # It doesn't care which we pick, so let's pick the default,
549 # if available, then the first in the array.
550 #return $acceptor->defaultLanguage() if $acceptor->defaultLanguage();
551 return $supportedLanguages->[0];
554 # No primary matches. Secondary? (ie, en-us requested and en supported)
555 return $secondaryMatch if $secondaryMatch;
556 return undef; # else, we got nothing.
561 Select a language based on the URL parameter 'language', a cookie,
562 syspref available languages & browser
570 my $interface = C4::Context->interface;
573 my $preference_to_check =
574 $interface eq 'intranet' ? 'language' : 'opaclanguages';
575 # Get the available/valid languages list
576 my @languages = split /,/, C4::Context->preference($preference_to_check);
578 # Chose language from the URL
579 $language = $cgi->param( 'language' );
580 if ( defined $language && any { $_ eq $language } @languages) {
585 if ($language = $cgi->cookie('KohaOpacLanguage') ) {
586 $language =~ s/[^a-zA-Z_-]*//; # sanitize cookie
589 # HTTP_ACCEPT_LANGUAGE
590 if ( !$language && $ENV{HTTP_ACCEPT_LANGUAGE} ) {
591 $language = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE},
592 getTranslatedLanguages( $interface, 'prog' ) );
595 # Ignore a lang not selected in sysprefs
596 if ( $language && any { $_ eq $language } @languages ) {
600 # Pick the first selected syspref language
601 $language = shift @languages;
602 return $language if $language;
604 # Fall back to English if necessary