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