bug 8215: (followup) make sure C4::CourseReserves doesn't export anything
[koha.git] / C4 / Languages.pm
1 package C4::Languages;
2
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.
7 #
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
11 # version.
12 #
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.
16 #
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.
20
21
22 use strict; 
23 #use warnings; FIXME - Bug 2505
24 use Carp;
25 use C4::Context;
26 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
27
28 eval {
29     if (C4::Context->ismemcached) {
30         require Memoize::Memcached;
31         import Memoize::Memcached qw(memoize_memcached);
32
33         memoize_memcached('getTranslatedLanguages', memcached => C4::Context->memcached);
34         memoize_memcached('getFrameworkLanguages' , memcached => C4::Context->memcached);
35         memoize_memcached('getAllLanguages',        memcached => C4::Context->memcached);
36     }
37 };
38
39 BEGIN {
40     $VERSION = 3.07.00.049;
41     require Exporter;
42     @ISA    = qw(Exporter);
43     @EXPORT = qw(
44         &getFrameworkLanguages
45         &getTranslatedLanguages
46         &getAllLanguages
47     );
48     @EXPORT_OK = qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages get_bidi regex_lang_subtags language_get_description accept_language);
49     $DEBUG = 0;
50 }
51
52 =head1 NAME
53
54 C4::Languages - Perl Module containing language list functions for Koha 
55
56 =head1 SYNOPSIS
57
58 use C4::Languages;
59
60 =head1 DESCRIPTION
61
62 =cut
63
64 =head1 FUNCTIONS
65
66 =head2 getFrameworkLanguages
67
68 Returns a reference to an array of hashes:
69
70  my $languages = getFrameworkLanguages();
71  for my $language(@$languages) {
72     print "$language->{language_code}\n"; # language code in iso 639-2
73     print "$language->{language_name}\n"; # language name in native script
74     print "$language->{language_locale_name}\n"; # language name in current locale
75  }
76
77 =cut
78
79 sub getFrameworkLanguages {
80     # get a hash with all language codes, names, and locale names
81     my $all_languages = getAllLanguages();
82     my @languages;
83     
84     # find the available directory names
85     my $dir=C4::Context->config('intranetdir')."/installer/data/";
86     opendir (MYDIR,$dir);
87     my @listdir= grep { !/^\.|CVS/ && -d "$dir/$_"} readdir(MYDIR);    
88     closedir MYDIR;
89
90     # pull out all data for the dir names that exist
91     for my $dirname (@listdir) {
92         for my $language_set (@$all_languages) {
93
94             if ($dirname eq $language_set->{language_code}) {
95                 push @languages, {
96                     'language_code'=>$dirname, 
97                     'language_description'=>$language_set->{language_description}, 
98                     'native_descrition'=>$language_set->{language_native_description} }
99             }
100         }
101     }
102     return \@languages;
103 }
104
105 =head2 getTranslatedLanguages
106
107 Returns a reference to an array of hashes:
108
109  my $languages = getTranslatedLanguages();
110  print "Available translated languages:\n";
111  for my $language(@$trlanguages) {
112     print "$language->{language_code}\n"; # language code in iso 639-2
113     print "$language->{language_name}\n"; # language name in native script
114     print "$language->{language_locale_name}\n"; # language name in current locale
115  }
116
117 =cut
118
119 sub getTranslatedLanguages {
120     my ($interface, $theme, $current_language, $which) = @_;
121     my $htdocs;
122     my @languages;
123     my @enabled_languages;
124  
125     if ($interface && $interface eq 'opac' ) {
126         @enabled_languages = split ",", C4::Context->preference('opaclanguages');
127         $htdocs = C4::Context->config('opachtdocs');
128         if ( $theme and -d "$htdocs/$theme" ) {
129             (@languages) = _get_language_dirs($htdocs,$theme);
130         }
131         else {
132             for my $theme ( _get_themes('opac') ) {
133                 push @languages, _get_language_dirs($htdocs,$theme);
134             }
135         }
136     }
137     elsif ($interface && $interface eq 'intranet' ) {
138         @enabled_languages = split ",", C4::Context->preference('language');
139         $htdocs = C4::Context->config('intrahtdocs');
140         if ( $theme and -d "$htdocs/$theme" ) {
141             @languages = _get_language_dirs($htdocs,$theme);
142         }
143         else {
144             foreach my $theme ( _get_themes('intranet') ) {
145                 push @languages, _get_language_dirs($htdocs,$theme);
146             }
147         }
148     }
149     else {
150         @enabled_languages = split ",", C4::Context->preference('opaclanguages');
151         my $htdocs = C4::Context->config('intrahtdocs');
152         foreach my $theme ( _get_themes('intranet') ) {
153             push @languages, _get_language_dirs($htdocs,$theme);
154         }
155         $htdocs = C4::Context->config('opachtdocs');
156         foreach my $theme ( _get_themes('opac') ) {
157             push @languages, _get_language_dirs($htdocs,$theme);
158         }
159         my %seen;
160         $seen{$_}++ for @languages;
161         @languages = keys %seen;
162     }
163     return _build_languages_arrayref(\@languages,$current_language,\@enabled_languages);
164 }
165
166 =head2 getAllLanguages
167
168 Returns a reference to an array of hashes:
169
170  my $alllanguages = getAllLanguages();
171  print "Available translated languages:\n";
172  for my $language(@$alllanguages) {
173     print "$language->{language_code}\n";
174     print "$language->{language_name}\n";
175     print "$language->{language_locale_name}\n";
176  }
177
178 =cut
179
180 sub getAllLanguages {
181     my $lang = shift;
182 # if no parameter is passed to the function, it returns english languages names
183 # if a $lang parameter conforming to RFC4646 syntax is passed, the function returns languages names translated in $lang
184 # if a language name is not translated in $lang in database, the function returns english language name
185     my @languages_loop;
186     my $dbh=C4::Context->dbh;
187     my $default_language = 'en';
188     my $current_language = $default_language;
189     if ($lang) {
190         $current_language = regex_lang_subtags($lang)->{'language'};
191     }
192     my $sth = $dbh->prepare('SELECT * FROM language_subtag_registry WHERE type=\'language\'');
193     $sth->execute();
194     while (my $language_subtag_registry = $sth->fetchrow_hashref) {
195         my $desc;
196         # check if language name is stored in current language
197         my $sth4= $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag =? AND lang = ?");
198         $sth4->execute($language_subtag_registry->{subtag},$current_language);
199         while (my $language_desc = $sth4->fetchrow_hashref) {
200              $desc=$language_desc->{description};
201         }
202         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 = ?");
203         if ($desc) {
204             $sth2->execute($language_subtag_registry->{subtag},$current_language);
205         }
206         else {
207             $sth2->execute($language_subtag_registry->{subtag},$default_language);
208         }
209         my $sth3 = $dbh->prepare("SELECT description FROM language_descriptions WHERE type='language' AND subtag=? AND lang=?");
210         # add the correct description info
211         while (my $language_descriptions = $sth2->fetchrow_hashref) {
212             $sth3->execute($language_subtag_registry->{subtag},$language_subtag_registry->{subtag});
213             my $native_description;
214             while (my $description = $sth3->fetchrow_hashref) {
215                 $native_description = $description->{description};
216             }
217
218             # fill in the ISO6329 code
219             $language_subtag_registry->{iso639_2_code} = $language_descriptions->{iso639_2_code};
220             # fill in the native description of the language, as well as the current language's translation of that if it exists
221             if ($native_description) {
222                 $language_subtag_registry->{language_description} = $native_description;
223                 $language_subtag_registry->{language_description}.=" ($language_descriptions->{description})" if $language_descriptions->{description};
224             }
225             else {
226                 $language_subtag_registry->{language_description} = $language_descriptions->{description};
227             }
228         }
229         push @languages_loop, $language_subtag_registry;
230     }
231     return \@languages_loop;
232 }
233
234 =head2 _get_themes
235
236 Internal function, returns an array of all available themes.
237
238   (@themes) = &_get_themes('opac');
239   (@themes) = &_get_themes('intranet');
240
241 =cut
242
243 sub _get_themes {
244     my $interface = shift;
245     my $htdocs;
246     my @themes;
247     if ( $interface eq 'intranet' ) {
248         $htdocs = C4::Context->config('intrahtdocs');
249     }
250     else {
251         $htdocs = C4::Context->config('opachtdocs');
252     }
253     opendir D, "$htdocs";
254     my @dirlist = readdir D;
255     foreach my $directory (@dirlist) {
256         # if there's an en dir, it's a valid theme
257         -d "$htdocs/$directory/en" and push @themes, $directory;
258     }
259     return @themes;
260 }
261
262 =head2 _get_language_dirs
263
264 Internal function, returns an array of directory names, excluding non-language directories
265
266 =cut
267
268 sub _get_language_dirs {
269     my ($htdocs,$theme) = @_;
270     my @lang_strings;
271     opendir D, "$htdocs/$theme";
272     for my $lang_string ( readdir D ) {
273         next if $lang_string =~/^\./;
274         next if $lang_string eq 'all';
275         next if $lang_string =~/png$/;
276         next if $lang_string =~/css$/;
277         next if $lang_string =~/CVS$/;
278         next if $lang_string =~/\.txt$/i;     #Don't read the readme.txt !
279         next if $lang_string =~/img|images|famfam|sound|pdf/;
280         push @lang_strings, $lang_string;
281     }
282         return (@lang_strings);
283 }
284
285 =head2 _build_languages_arrayref 
286
287 Internal function for building the ref to array of hashes
288
289 FIXME: this could be rewritten and simplified using map
290
291 =cut
292
293 sub _build_languages_arrayref {
294         my ($translated_languages,$current_language,$enabled_languages) = @_;
295         my @translated_languages = @$translated_languages;
296         my @languages_loop; # the final reference to an array of hashrefs
297         my @enabled_languages = @$enabled_languages;
298         # how many languages are enabled, if one, take note, some contexts won't need to display it
299         my %seen_languages; # the language tags we've seen
300         my %found_languages;
301         my $language_groups;
302         my $track_language_groups;
303         my $current_language_regex = regex_lang_subtags($current_language);
304         # Loop through the translated languages
305         for my $translated_language (@translated_languages) {
306             # separate the language string into its subtag types
307             my $language_subtags_hashref = regex_lang_subtags($translated_language);
308
309             # is this language string 'enabled'?
310             for my $enabled_language (@enabled_languages) {
311                 #warn "Checking out if $translated_language eq $enabled_language";
312                 $language_subtags_hashref->{'enabled'} = 1 if $translated_language eq $enabled_language;
313             }
314             
315             # group this language, key by langtag
316             $language_subtags_hashref->{'sublanguage_current'} = 1 if $translated_language eq $current_language;
317             $language_subtags_hashref->{'rfc4646_subtag'} = $translated_language;
318             $language_subtags_hashref->{'native_description'} = language_get_description($language_subtags_hashref->{language},$language_subtags_hashref->{language},'language');
319             $language_subtags_hashref->{'script_description'} = language_get_description($language_subtags_hashref->{script},$language_subtags_hashref->{'language'},'script');
320             $language_subtags_hashref->{'region_description'} = language_get_description($language_subtags_hashref->{region},$language_subtags_hashref->{'language'},'region');
321             $language_subtags_hashref->{'variant_description'} = language_get_description($language_subtags_hashref->{variant},$language_subtags_hashref->{'language'},'variant');
322             $track_language_groups->{$language_subtags_hashref->{'language'}}++;
323             push ( @{ $language_groups->{$language_subtags_hashref->{language}} }, $language_subtags_hashref );
324         }
325         # $key is a language subtag like 'en'
326         while( my ($key, $value) = each %$language_groups) {
327
328             # is this language group enabled? are any of the languages within it enabled?
329             my $enabled;
330             for my $enabled_language (@enabled_languages) {
331                 my $regex_enabled_language = regex_lang_subtags($enabled_language);
332                 $enabled = 1 if $key eq $regex_enabled_language->{language};
333             }
334             push @languages_loop,  {
335                             # this is only use if there is one
336                             rfc4646_subtag => @$value[0]->{rfc4646_subtag},
337                             native_description => language_get_description($key,$key,'language'),
338                             language => $key,
339                             sublanguages_loop => $value,
340                             plural => $track_language_groups->{$key} >1 ? 1 : 0,
341                             current => $current_language_regex->{language} eq $key ? 1 : 0,
342                             group_enabled => $enabled,
343                            };
344         }
345         return \@languages_loop;
346 }
347
348 sub language_get_description {
349     my ($script,$lang,$type) = @_;
350     my $dbh = C4::Context->dbh;
351     my $desc;
352     my $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
353     #warn "QUERY: SELECT description FROM language_descriptions WHERE subtag=$script AND lang=$lang AND type=$type";
354     $sth->execute($script,$lang,$type);
355     while (my $descriptions = $sth->fetchrow_hashref) {
356         $desc = $descriptions->{'description'};
357     }
358     unless ($desc) {
359         $sth = $dbh->prepare("SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?");
360         $sth->execute($script,'en',$type);
361         while (my $descriptions = $sth->fetchrow_hashref) {
362             $desc = $descriptions->{'description'};
363         }
364     }
365     return $desc;
366 }
367 =head2 regex_lang_subtags
368
369 This internal sub takes a string composed according to RFC 4646 as
370 an input and returns a reference to a hash containing keys and values
371 for ( language, script, region, variant, extension, privateuse )
372
373 =cut
374
375 sub regex_lang_subtags {
376     my $string = shift;
377
378     # Regex for recognizing RFC 4646 well-formed tags
379     # http://www.rfc-editor.org/rfc/rfc4646.txt
380
381     # regexes based on : http://unicode.org/cldr/data/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
382     # The structure requires no forward references, so it reverses the order.
383     # The uppercase comments are fragments copied from RFC 4646
384     #
385     # Note: the tool requires that any real "=" or "#" or ";" in the regex be escaped.
386
387     my $alpha   = qr/[a-zA-Z]/ ;    # ALPHA
388     my $digit   = qr/[0-9]/ ;   # DIGIT
389     my $alphanum    = qr/[a-zA-Z0-9]/ ; # ALPHA / DIGIT
390     my $x   = qr/[xX]/ ;    # private use singleton
391     my $singleton = qr/[a-w y-z A-W Y-Z]/ ; # other singleton
392     my $s   = qr/[-]/ ; # separator -- lenient parsers will use [-_]
393
394     # Now do the components. The structure is slightly different to allow for capturing the right components.
395     # The notation (?:....) is a non-capturing version of (...): so the "?:" can be deleted if someone doesn't care about capturing.
396
397     my $extlang = qr{(?: $s $alpha{3} )}x ; # *3("-" 3ALPHA)
398     my $language    = qr{(?: $alpha{2,3} | $alpha{4,8} )}x ;
399     #my $language   = qr{(?: $alpha{2,3}$extlang{0,3} | $alpha{4,8} )}x ;   # (2*3ALPHA [ extlang ]) / 4ALPHA / 5*8ALPHA
400
401     my $script  = qr{(?: $alpha{4} )}x ;    # 4ALPHA 
402
403     my $region  = qr{(?: $alpha{2} | $digit{3} )}x ;     # 2ALPHA / 3DIGIT
404
405     my $variantSub  = qr{(?: $digit$alphanum{3} | $alphanum{5,8} )}x ;  # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
406     my $variant = qr{(?: $variantSub (?: $s$variantSub )* )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
407
408     my $extensionSub    = qr{(?: $singleton (?: $s$alphanum{2,8} )+ )}x ;   # singleton 1*("-" (2*8alphanum))
409     my $extension   = qr{(?: $extensionSub (?: $s$extensionSub )* )}x ; # singleton 1*("-" (2*8alphanum))
410
411     my $privateuse  = qr{(?: $x (?: $s$alphanum{1,8} )+ )}x ;   # ("x"/"X") 1*("-" (1*8alphanum))
412
413     # Define certain grandfathered codes, since otherwise the regex is pretty useless.
414     # Since these are limited, this is safe even later changes to the registry --
415     # the only oddity is that it might change the type of the tag, and thus
416     # the results from the capturing groups.
417     # http://www.iana.org/assignments/language-subtag-registry
418     # Note that these have to be compared case insensitively, requiring (?i) below.
419
420     my $grandfathered   = qr{(?: (?i)
421         en $s GB $s oed
422     |   i $s (?: ami | bnn | default | enochian | hak | klingon | lux | mingo | navajo | pwn | tao | tay | tsu )
423     |   sgn $s (?: BE $s fr | BE $s nl | CH $s de)
424 )}x;
425
426     # For well-formedness, we don't need the ones that would otherwise pass, so they are commented out here
427
428     #   |   art $s lojban
429     #   |   cel $s gaulish
430     #   |   en $s (?: boont | GB $s oed | scouse )
431     #   |   no $s (?: bok | nyn)
432     #   |   zh $s (?: cmn | cmn $s Hans | cmn $s Hant | gan | guoyu | hakka | min | min $s nan | wuu | xiang | yue)
433
434     # Here is the final breakdown, with capturing groups for each of these components
435     # The language, variants, extensions, grandfathered, and private-use may have interior '-'
436
437     #my $root = qr{(?: ($language) (?: $s ($script) )? 40% (?: $s ($region) )? 40% (?: $s ($variant) )? 10% (?: $s ($extension) )? 5% (?: $s ($privateuse) )? 5% ) 90% | ($grandfathered) 5% | ($privateuse) 5% };
438
439     $string =~  qr{^ (?:($language)) (?:$s($script))? (?:$s($region))?  (?:$s($variant))?  (?:$s($extension))?  (?:$s($privateuse))? $}xi;  # |($grandfathered) | ($privateuse) $}xi;
440     my %subtag = (
441         'rfc4646_subtag' => $string,
442         'language' => $1,
443         'script' => $2,
444         'region' => $3,
445         'variant' => $4,
446         'extension' => $5,
447         'privateuse' => $6,
448     );
449     return \%subtag;
450 }
451
452 # Script Direction Resources:
453 # http://www.w3.org/International/questions/qa-scripts
454 sub get_bidi {
455     my ($language_script)= @_;
456     my $dbh = C4::Context->dbh;
457     my $bidi;
458     my $sth = $dbh->prepare('SELECT bidi FROM language_script_bidi WHERE rfc4646_subtag=?');
459     $sth->execute($language_script);
460     while (my $result = $sth->fetchrow_hashref) {
461         $bidi = $result->{'bidi'};
462     }
463     return $bidi;
464 };
465
466 sub accept_language {
467     # referenced http://search.cpan.org/src/CGILMORE/I18N-AcceptLanguage-1.04/lib/I18N/AcceptLanguage.pm
468     my ($clientPreferences,$supportedLanguages) = @_;
469     my @languages = ();
470     if ($clientPreferences) {
471         # There should be no whitespace anways, but a cleanliness/sanity check
472         $clientPreferences =~ s/\s//g;
473         # Prepare the list of client-acceptable languages
474         foreach my $tag (split(/,/, $clientPreferences)) {
475             my ($language, $quality) = split(/\;/, $tag);
476             $quality =~ s/^q=//i if $quality;
477             $quality = 1 unless $quality;
478             next if $quality <= 0;
479             # We want to force the wildcard to be last
480             $quality = 0 if ($language eq '*');
481             # Pushing lowercase language here saves processing later
482             push(@languages, { quality => $quality,
483                language => $language,
484                lclanguage => lc($language) });
485         }
486     } else {
487         carp "accept_language(x,y) called with no clientPreferences (x).";
488     }
489     # Prepare the list of server-supported languages
490     my %supportedLanguages = ();
491     my %secondaryLanguages = ();
492     foreach my $language (@$supportedLanguages) {
493         # warn "Language supported: " . $language->{language};
494         my $subtag = $language->{rfc4646_subtag};
495         $supportedLanguages{lc($subtag)} = $subtag;
496         if ( $subtag =~ /^([^-]+)-?/ ) {
497             $secondaryLanguages{lc($1)} = $subtag;
498         }
499     }
500
501     # Reverse sort the list, making best quality at the front of the array
502     @languages = sort { $b->{quality} <=> $a->{quality} } @languages;
503     my $secondaryMatch = '';
504     foreach my $tag (@languages) {
505         if (exists($supportedLanguages{$tag->{lclanguage}})) {
506             # Client en-us eq server en-us
507             return $supportedLanguages{$tag->{language}} if exists($supportedLanguages{$tag->{language}});
508             return $supportedLanguages{$tag->{lclanguage}};
509         } elsif (exists($secondaryLanguages{$tag->{lclanguage}})) {
510             # Client en eq server en-us
511             return $secondaryLanguages{$tag->{language}} if exists($secondaryLanguages{$tag->{language}});
512             return $supportedLanguages{$tag->{lclanguage}};
513         } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
514             # Client en-gb eq server en-us
515             $secondaryMatch = $secondaryLanguages{$1};
516         } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
517             # FIXME: We just checked the exact same conditional!
518             # Client en-us eq server en
519             $secondaryMatch = $supportedLanguages{$1};
520         } elsif ($tag->{lclanguage} eq '*') {
521         # * matches every language not already specified.
522         # It doesn't care which we pick, so let's pick the default,
523         # if available, then the first in the array.
524         #return $acceptor->defaultLanguage() if $acceptor->defaultLanguage();
525         return $supportedLanguages->[0];
526         }
527     }
528     # No primary matches. Secondary? (ie, en-us requested and en supported)
529     return $secondaryMatch if $secondaryMatch;
530     return undef;   # else, we got nothing.
531 }
532 1;
533
534 __END__
535
536 =head1 AUTHOR
537
538 Joshua Ferraro
539
540 =cut