3 # Copyright 2006 (C) LibLime
4 # Joshua Ferraro <jmf@liblime.com>
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 with
18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
19 # Suite 330, Boston, MA 02111-1307 USA
23 #use warnings; #FIXME: turn off warnings before release
26 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
33 &getFrameworkLanguages
34 &getTranslatedLanguages
37 @EXPORT_OK = qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages get_bidi regex_lang_subtags language_get_description accept_language);
43 C4::Languages - Perl Module containing language list functions for Koha
53 =head2 getFrameworkLanguages
55 Returns a reference to an array of hashes:
57 my $languages = getFrameworkLanguages();
58 for my $language(@$languages) {
59 print "$language->{language_code}\n"; # language code in iso 639-2
60 print "$language->{language_name}\n"; # language name in native script
61 print "$language->{language_locale_name}\n"; # language name in current locale
66 sub getFrameworkLanguages {
67 # get a hash with all language codes, names, and locale names
68 my $all_languages = getAllLanguages();
71 # find the available directory names
72 my $dir=C4::Context->config('intranetdir')."/installer/data/";
74 my @listdir= grep { !/^\.|CVS/ && -d "$dir/$_"} readdir(MYDIR);
77 # pull out all data for the dir names that exist
78 for my $dirname (@listdir) {
79 for my $language_set (@$all_languages) {
81 if ($dirname eq $language_set->{language_code}) {
83 'language_code'=>$dirname,
84 'language_description'=>$language_set->{language_description},
85 'native_descrition'=>$language_set->{language_native_description} }
92 =head2 getTranslatedLanguages
94 Returns a reference to an array of hashes:
96 my $languages = getTranslatedLanguages();
97 print "Available translated languages:\n";
98 for my $language(@$trlanguages) {
99 print "$language->{language_code}\n"; # language code in iso 639-2
100 print "$language->{language_name}\n"; # language name in native script
101 print "$language->{language_locale_name}\n"; # language name in current locale
106 sub getTranslatedLanguages {
107 my ($interface, $theme, $current_language, $which) = @_;
109 my $all_languages = getAllLanguages();
112 my @enabled_languages;
114 if ($interface && $interface eq 'opac' ) {
115 @enabled_languages = split ",", C4::Context->preference('opaclanguages');
116 $htdocs = C4::Context->config('opachtdocs');
117 if ( $theme and -d "$htdocs/$theme" ) {
118 (@languages) = _get_language_dirs($htdocs,$theme);
119 return _build_languages_arrayref($all_languages,\@languages,$current_language,\@enabled_languages);
122 for my $theme ( _get_themes('opac') ) {
123 push @languages, _get_language_dirs($htdocs,$theme);
125 return _build_languages_arrayref($all_languages,\@languages,$current_language,\@enabled_languages);
128 elsif ($interface && $interface eq 'intranet' ) {
129 @enabled_languages = split ",", C4::Context->preference('language');
130 $htdocs = C4::Context->config('intrahtdocs');
131 if ( $theme and -d "$htdocs/$theme" ) {
132 @languages = _get_language_dirs($htdocs,$theme);
133 return _build_languages_arrayref($all_languages,\@languages,$current_language,\@enabled_languages);
136 foreach my $theme ( _get_themes('intranet') ) {
137 push @languages, _get_language_dirs($htdocs,$theme);
139 return _build_languages_arrayref($all_languages,\@languages,$current_language,\@enabled_languages);
143 @enabled_languages = split ",", C4::Context->preference('opaclanguages');
144 my $htdocs = C4::Context->config('intrahtdocs');
145 foreach my $theme ( _get_themes('intranet') ) {
146 push @languages, _get_language_dirs($htdocs,$theme);
148 $htdocs = C4::Context->config('opachtdocs');
149 foreach my $theme ( _get_themes('opac') ) {
150 push @languages, _get_language_dirs($htdocs,$theme);
153 $seen{$_}++ for @languages;
154 @languages = keys %seen;
155 return _build_languages_arrayref($all_languages,\@languages,$current_language,\@enabled_languages);
159 =head2 getAllLanguages
161 Returns a reference to an array of hashes:
163 my $alllanguages = getAllLanguages();
164 print "Available translated languages:\n";
165 for my $language(@$alllanguages) {
166 print "$language->{language_code}\n";
167 print "$language->{language_name}\n";
168 print "$language->{language_locale_name}\n";
173 sub getAllLanguages {
175 my $dbh=C4::Context->dbh;
176 my $current_language = shift || 'en';
177 my $sth = $dbh->prepare('SELECT * FROM language_subtag_registry WHERE type=\'language\'');
179 while (my $language_subtag_registry = $sth->fetchrow_hashref) {
181 # pull out all the script descriptions for each language
182 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 = ?");
183 $sth2->execute($language_subtag_registry->{subtag},$current_language);
185 my $sth3 = $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag=? AND lang=?");
187 # add the correct description info
188 while (my $language_descriptions = $sth2->fetchrow_hashref) {
189 $sth3->execute($language_subtag_registry->{subtag},$language_subtag_registry->{subtag});
190 my $native_description;
191 while (my $description = $sth3->fetchrow_hashref) {
192 $native_description = $description->{description};
195 # fill in the ISO6329 code
196 $language_subtag_registry->{iso639_2_code} = $language_descriptions->{iso639_2_code};
197 # fill in the native description of the language, as well as the current language's translation of that if it exists
198 if ($native_description) {
199 $language_subtag_registry->{language_description} = $native_description;
200 $language_subtag_registry->{language_description}.=" ($language_descriptions->{description})" if $language_descriptions->{description};
203 $language_subtag_registry->{language_description} = $language_descriptions->{description};
206 push @languages_loop, $language_subtag_registry;
208 return \@languages_loop;
213 Internal function, returns an array of all available themes.
215 (@themes) = &_get_themes('opac');
216 (@themes) = &_get_themes('intranet');
221 my $interface = shift;
224 if ( $interface eq 'intranet' ) {
225 $htdocs = C4::Context->config('intrahtdocs');
228 $htdocs = C4::Context->config('opachtdocs');
230 opendir D, "$htdocs";
231 my @dirlist = readdir D;
232 foreach my $directory (@dirlist) {
233 # if there's an en dir, it's a valid theme
234 -d "$htdocs/$directory/en" and push @themes, $directory;
239 =head2 _get_language_dirs
241 Internal function, returns an array of directory names, excluding non-language directories
245 sub _get_language_dirs {
246 my ($htdocs,$theme) = @_;
248 opendir D, "$htdocs/$theme";
249 for my $lang_string ( readdir D ) {
250 next if $lang_string =~/^\./;
251 next if $lang_string eq 'all';
252 next if $lang_string =~/png$/;
253 next if $lang_string =~/css$/;
254 next if $lang_string =~/CVS$/;
255 next if $lang_string =~/\.txt$/i; #Don't read the readme.txt !
256 next if $lang_string =~/img|images|famfam/;
257 push @lang_strings, $lang_string;
259 return (@lang_strings);
262 =head2 _build_languages_arrayref
264 Internal function for building the ref to array of hashes
266 FIXME: this could be rewritten and simplified using map
270 sub _build_languages_arrayref {
271 my ($all_languages,$translated_languages,$current_language,$enabled_languages) = @_;
272 my @translated_languages = @$translated_languages;
273 my @languages_loop; # the final reference to an array of hashrefs
274 my @enabled_languages = @$enabled_languages;
275 # how many languages are enabled, if one, take note, some contexts won't need to display it
276 my $one_language_enabled = 1 unless @enabled_languages > 1;
277 my %seen_languages; # the language tags we've seen
280 my $track_language_groups;
281 my $current_language_regex = regex_lang_subtags($current_language);
282 # Loop through the translated languages
283 for my $translated_language (@translated_languages) {
284 # separate the language string into its subtag types
285 my $language_subtags_hashref = regex_lang_subtags($translated_language);
287 # is this language string 'enabled'?
288 for my $enabled_language (@enabled_languages) {
289 #warn "Checking out if $translated_language eq $enabled_language";
290 $language_subtags_hashref->{'enabled'} = 1 if $translated_language eq $enabled_language;
293 # group this language, key by langtag
294 $language_subtags_hashref->{'sublanguage_current'} = 1 if $translated_language eq $current_language;
295 $language_subtags_hashref->{'rfc4646_subtag'} = $translated_language;
296 $language_subtags_hashref->{'native_description'} = language_get_description($language_subtags_hashref->{language},$language_subtags_hashref->{language},'language');
297 $language_subtags_hashref->{'script_description'} = language_get_description($language_subtags_hashref->{script},$language_subtags_hashref->{'language'},'script');
298 $language_subtags_hashref->{'region_description'} = language_get_description($language_subtags_hashref->{region},$language_subtags_hashref->{'language'},'region');
299 $language_subtags_hashref->{'variant_description'} = language_get_description($language_subtags_hashref->{variant},$language_subtags_hashref->{'language'},'variant');
300 $track_language_groups->{$language_subtags_hashref->{'language'}}++;
301 push ( @{ $language_groups->{$language_subtags_hashref->{language}} }, $language_subtags_hashref );
303 # $key is a language subtag like 'en'
304 while( my ($key, $value) = each %$language_groups) {
306 # is this language group enabled? are any of the languages within it enabled?
308 for my $enabled_language (@enabled_languages) {
309 my $regex_enabled_language = regex_lang_subtags($enabled_language);
310 $enabled = 1 if $key eq $regex_enabled_language->{language};
312 push @languages_loop, {
313 # this is only use if there is one
314 rfc4646_subtag => @$value[0]->{rfc4646_subtag},
315 native_description => language_get_description($key,$key,'language'),
317 sublanguages_loop => $value,
318 plural => $track_language_groups->{$key} >1 ? 1 : 0,
319 current => $current_language_regex->{language} eq $key ? 1 : 0,
320 group_enabled => $enabled,
321 one_language_enabled => $one_language_enabled,
324 return \@languages_loop;
327 sub language_get_description {
328 my ($script,$lang,$type) = @_;
329 my $dbh = C4::Context->dbh;
331 my $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
332 #warn "QUERY: SELECT description FROM language_descriptions WHERE subtag=$script AND lang=$lang AND type=$type";
333 $sth->execute($script,$lang,$type);
334 while (my $descriptions = $sth->fetchrow_hashref) {
335 $desc = $descriptions->{'description'};
338 $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
339 $sth->execute($script,'en',$type);
340 while (my $descriptions = $sth->fetchrow_hashref) {
341 $desc = $descriptions->{'description'};
346 =head2 regex_lang_subtags
348 This internal sub takes a string composed according to RFC 4646 as
349 an input and returns a reference to a hash containing keys and values
350 for ( language, script, region, variant, extension, privateuse )
354 sub regex_lang_subtags {
357 # Regex for recognizing RFC 4646 well-formed tags
358 # http://www.rfc-editor.org/rfc/rfc4646.txt
360 # regexes based on : http://unicode.org/cldr/data/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
361 # The structure requires no forward references, so it reverses the order.
362 # The uppercase comments are fragments copied from RFC 4646
364 # Note: the tool requires that any real "=" or "#" or ";" in the regex be escaped.
366 my $alpha = qr/[a-zA-Z]/ ; # ALPHA
367 my $digit = qr/[0-9]/ ; # DIGIT
368 my $alphanum = qr/[a-zA-Z0-9]/ ; # ALPHA / DIGIT
369 my $x = qr/[xX]/ ; # private use singleton
370 my $singleton = qr/[a-w y-z A-W Y-Z]/ ; # other singleton
371 my $s = qr/[-]/ ; # separator -- lenient parsers will use [-_]
373 # Now do the components. The structure is slightly different to allow for capturing the right components.
374 # The notation (?:....) is a non-capturing version of (...): so the "?:" can be deleted if someone doesn't care about capturing.
376 my $extlang = qr{(?: $s $alpha{3} )}x ; # *3("-" 3ALPHA)
377 my $language = qr{(?: $alpha{2,3} | $alpha{4,8} )}x ;
378 #my $language = qr{(?: $alpha{2,3}$extlang{0,3} | $alpha{4,8} )}x ; # (2*3ALPHA [ extlang ]) / 4ALPHA / 5*8ALPHA
380 my $script = qr{(?: $alpha{4} )}x ; # 4ALPHA
382 my $region = qr{(?: $alpha{2} | $digit{3} )}x ; # 2ALPHA / 3DIGIT
384 my $variantSub = qr{(?: $digit$alphanum{3} | $alphanum{5,8} )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
385 my $variant = qr{(?: $variantSub (?: $s$variantSub )* )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
387 my $extensionSub = qr{(?: $singleton (?: $s$alphanum{2,8} )+ )}x ; # singleton 1*("-" (2*8alphanum))
388 my $extension = qr{(?: $extensionSub (?: $s$extensionSub )* )}x ; # singleton 1*("-" (2*8alphanum))
390 my $privateuse = qr{(?: $x (?: $s$alphanum{1,8} )+ )}x ; # ("x"/"X") 1*("-" (1*8alphanum))
392 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
393 # Since these are limited, this is safe even later changes to the registry --
394 # the only oddity is that it might change the type of the tag, and thus
395 # the results from the capturing groups.
396 # http://www.iana.org/assignments/language-subtag-registry
397 # Note that these have to be compared case insensitively, requiring (?i) below.
399 my $grandfathered = qr{(?: (?i)
401 | i $s (?: ami | bnn | default | enochian | hak | klingon | lux | mingo | navajo | pwn | tao | tay | tsu )
402 | sgn $s (?: BE $s fr | BE $s nl | CH $s de)
405 # For well-formedness, we don't need the ones that would otherwise pass, so they are commented out here
409 # | en $s (?: boont | GB $s oed | scouse )
410 # | no $s (?: bok | nyn)
411 # | zh $s (?: cmn | cmn $s Hans | cmn $s Hant | gan | guoyu | hakka | min | min $s nan | wuu | xiang | yue)
413 # Here is the final breakdown, with capturing groups for each of these components
414 # The language, variants, extensions, grandfathered, and private-use may have interior '-'
416 #my $root = qr{(?: ($language) (?: $s ($script) )? 40% (?: $s ($region) )? 40% (?: $s ($variant) )? 10% (?: $s ($extension) )? 5% (?: $s ($privateuse) )? 5% ) 90% | ($grandfathered) 5% | ($privateuse) 5% };
418 $string =~ qr{^ (?:($language)) (?:$s($script))? (?:$s($region))? (?:$s($variant))? (?:$s($extension))? (?:$s($privateuse))? $}xi; # |($grandfathered) | ($privateuse) $}xi;
420 'rfc4646_subtag' => $string,
431 # Script Direction Resources:
432 # http://www.w3.org/International/questions/qa-scripts
434 my ($language_script)= @_;
435 my $dbh = C4::Context->dbh;
437 my $sth = $dbh->prepare('SELECT bidi FROM language_script_bidi WHERE rfc4646_subtag=?');
438 $sth->execute($language_script);
439 while (my $result = $sth->fetchrow_hashref) {
440 $bidi = $result->{'bidi'};
445 sub accept_language {
446 # referenced http://search.cpan.org/src/CGILMORE/I18N-AcceptLanguage-1.04/lib/I18N/AcceptLanguage.pm
447 # FIXME: since this is only used in Output.pm as of Jan 8 2008, maybe it should be IN Output.pm
448 my ($clientPreferences,$supportedLanguages) = @_;
450 if ($clientPreferences) {
451 # There should be no whitespace anways, but a cleanliness/sanity check
452 $clientPreferences =~ s/\s//g;
454 # Prepare the list of client-acceptable languages
455 foreach my $tag (split(/,/, $clientPreferences)) {
456 my ($language, $quality) = split(/\;/, $tag);
457 $quality =~ s/^q=//i if $quality;
458 $quality = 1 unless $quality;
459 next if $quality <= 0;
460 # We want to force the wildcard to be last
461 $quality = 0 if ($language eq '*');
462 # Pushing lowercase language here saves processing later
463 push(@languages, { quality => $quality,
464 language => $language,
465 lclanguage => lc($language) });
468 carp "accept_language(x,y) called with no clientPreferences (x).";
470 # Prepare the list of server-supported languages
471 my %supportedLanguages = ();
472 my %secondaryLanguages = ();
473 foreach my $language (@$supportedLanguages) {
474 # warn "Language supported: " . $language->{language_code};
475 $supportedLanguages{lc($language->{language_code})} = $language->{language_code};
476 if ($language->{language_code} =~ /^([^-]+)-?/) {
477 $secondaryLanguages{lc($1)} = $language->{language_code};
481 # Reverse sort the list, making best quality at the front of the array
482 @languages = sort { $b->{quality} <=> $a->{quality} } @languages;
483 my $secondaryMatch = '';
484 foreach my $tag (@languages) {
485 if (exists($supportedLanguages{$tag->{lclanguage}})) {
486 # Client en-us eq server en-us
487 return $supportedLanguages{$tag->{language}} if exists($supportedLanguages{$tag->{language}});
488 return $supportedLanguages{$tag->{lclanguage}};
489 } elsif (exists($secondaryLanguages{$tag->{lclanguage}})) {
490 # Client en eq server en-us
491 return $secondaryLanguages{$tag->{language}} if exists($secondaryLanguages{$tag->{language}});
492 return $supportedLanguages{$tag->{lclanguage}};
493 } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
494 # Client en-gb eq server en-us
495 $secondaryMatch = $secondaryLanguages{$1};
496 } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
497 # FIXME: We just checked the exact same conditional!
498 # Client en-us eq server en
499 $secondaryMatch = $supportedLanguages{$1};
500 } elsif ($tag->{lclanguage} eq '*') {
501 # * matches every language not already specified.
502 # It doesn't care which we pick, so let's pick the default,
503 # if available, then the first in the array.
504 #return $acceptor->defaultLanguage() if $acceptor->defaultLanguage();
505 return $supportedLanguages->[0];
508 # No primary matches. Secondary? (ie, en-us requested and en supported)
509 return $secondaryMatch if $secondaryMatch;
510 return undef; # else, we got nothing.