Members.pm - BEGIN block VERSION and vars related to export.
[koha.git] / C4 / Languages.pm
index 9444c63..83cd6c1 100644 (file)
@@ -18,14 +18,24 @@ package C4::Languages;
 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 # Suite 330, Boston, MA  02111-1307 USA
 
-# $Id$
 
-use strict; use warnings; #FIXME: turn off warnings before release
-require Exporter;
+use strict; 
+use warnings;  #FIXME: turn off warnings before release
 use C4::Context;
-use vars qw($VERSION @ISA @EXPORT);
-
-$VERSION = do { my @v = '$Revision$' =~ /\d+/g; shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v ); };
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
+
+BEGIN {
+       $VERSION = 3.00;
+       require Exporter;
+       @ISA    = qw(Exporter);
+       @EXPORT = qw(
+               &getFrameworkLanguages
+               &getTranslatedLanguages
+               &getAllLanguages
+       );
+       @EXPORT_OK = qw(getFrameworkLanguages getTranslatedLanguages getAllLanguages get_bidi regex_lang_subtags language_get_description accept_language);
+       $DEBUG = 0;
+}
 
 =head1 NAME
 
@@ -39,17 +49,6 @@ use C4::Languages;
 
 =head1 FUNCTIONS
 
-=cut
-
-@ISA    = qw(Exporter);
-@EXPORT = qw(
-  &getFrameworkLanguages
-  &getTranslatedLanguages
-  &getAllLanguages
-  );
-
-my $DEBUG = 0;
-
 =head2 getFrameworkLanguages
 
 Returns a reference to an array of hashes:
@@ -69,7 +68,7 @@ sub getFrameworkLanguages {
     my @languages;
     
     # find the available directory names
-    my $dir=C4::Context->config('intranetdir')."/misc/sql-datas/";
+    my $dir=C4::Context->config('intranetdir')."/installer/data/";
     opendir (MYDIR,$dir);
     my @listdir= grep { !/^\.|CVS/ && -d "$dir/$_"} readdir(MYDIR);    
     closedir MYDIR;
@@ -77,11 +76,12 @@ sub getFrameworkLanguages {
     # pull out all data for the dir names that exist
     for my $dirname (@listdir) {
         for my $language_set (@$all_languages) {
-            my $language_name = $language_set->{language_name};
-            my $language_locale_name = $language_set->{language_locale_name};
 
             if ($dirname eq $language_set->{language_code}) {
-                push @languages, {'language_code'=>$dirname, 'language_name'=>$language_name, 'language_locale_name'=>$language_locale_name}
+                push @languages, {
+                                       'language_code'=>$dirname, 
+                                       'language_description'=>$language_set->{language_description}, 
+                                       'native_descrition'=>$language_set->{language_native_description} }
             }
         }
     }
@@ -109,30 +109,30 @@ sub getTranslatedLanguages {
     my @languages;
     my $lang;
     
-    if ( $interface eq 'opac' ) {
+    if ($interface && $interface eq 'opac' ) {
         $htdocs = C4::Context->config('opachtdocs');
         if ( $theme and -d "$htdocs/$theme" ) {
             (@languages) = _get_language_dirs($htdocs,$theme);
-            return _get_final_languages($all_languages,@languages);
+            return _build_languages_arrayref($all_languages,@languages);
         }
         else {
             for my $theme ( _get_themes('opac') ) {
                 push @languages, _get_language_dirs($htdocs,$theme);
             }
-            return _get_final_languages($all_languages,@languages);
+            return _build_languages_arrayref($all_languages,@languages);
         }
     }
-    elsif ( $interface eq 'intranet' ) {
+    elsif ($interface && $interface eq 'intranet' ) {
         $htdocs = C4::Context->config('intrahtdocs');
         if ( $theme and -d "$htdocs/$theme" ) {
             @languages = _get_language_dirs($htdocs,$theme);
-            return _get_final_languages($all_languages,@languages);
+            return _build_languages_arrayref($all_languages,@languages);
         }
         else {
             foreach my $theme ( _get_themes('opac') ) {
                 push @languages, _get_language_dirs($htdocs,$theme);
             }
-            return _get_final_languages($all_languages,@languages);
+            return _build_languages_arrayref($all_languages,@languages);
         }
     }
     else {
@@ -144,7 +144,7 @@ sub getTranslatedLanguages {
         foreach my $theme ( _get_themes('opac') ) {
             push @languages, _get_language_dirs($htdocs,$theme);
         }
-        return _get_final_languages($all_languages,@languages);
+        return _build_languages_arrayref($all_languages,@languages);
     }
 }
 
@@ -163,202 +163,36 @@ Returns a reference to an array of hashes:
 =cut
 
 sub getAllLanguages {
-    my $languages_loop = [
-        {
-            language_code          => "",
-            language_name => "No Limit",
-            language_locale_name   => "",
-            selected       => "selected",
-        },
-        {
-            language_code          => "ara",
-            language_name =>
-              "العربية",
-            language_locale_name => "Arabic",
-            ,
-        },
-        {
-            language_code          => "bul",
-            language_name =>
-              "Български",
-            language_locale_name => "Bulgarian",
-            ,
-        },
-        {
-            language_code          => "chi",
-            language_name => "中文",
-            language_locale_name   => "Chinese",
-            ,
-        },
-        {
-            language_code          => "scr",
-            language_name => "Hrvatski",
-            language_locale_name   => "Croatian",
-            ,
-        },
-        {
-            language_code          => "cze",
-            language_name => "čeština",
-            language_locale_name   => "Czech",
-            ,
-        },
-        {
-            language_code          => "dan",
-            language_name => "Dænsk",
-            language_locale_name   => "Danish",
-            ,
-        },
-        {
-            language_code          => "dut",
-            language_name => "nedərlɑns",
-            language_locale_name   => "Dutch",
-            ,
-        },
-        {
-            language_code          => "en",
-            language_name => "English",
-            language_locale_name   => "English",
-            ,
-        },
-        {
-            language_code          => "fr",
-            language_name => "Français",
-            language_locale_name   => "French",
-            ,
-        },
-        {
-            language_code          => "ger",
-            language_name => "Deutsch",
-            language_locale_name   => "German",
-            ,
-        },
-        {
-            language_code          => "gre",
-            language_name =>
-              "ελληνικά",
-            language_locale_name => "Greek, Modern [1453- ]",
-            ,
-        },
-        {
-            language_code          => "heb",
-            language_name => "עברית",
-            language_locale_name   => "Hebrew",
-            ,
-        },
-        {
-            language_code          => "hin",
-            language_name => "हिन्दी",
-            language_locale_name   => "Hindi",
-            ,
-        },
-        {
-            language_code          => "hun",
-            language_name => "Magyar",
-            language_locale_name   => "Hungarian",
-            ,
-        },
-        {
-            language_code          => "ind",
-            language_name => "",
-            language_locale_name   => "Indonesian",
-            ,
-        },
-        {
-            language_code          => "ita",
-            language_name => "Italiano",
-            language_locale_name   => "Italian",
-            ,
-        },
-        {
-            language_code          => "jpn",
-            language_name => "日本語",
-            language_locale_name   => "Japanese",
-            ,
-        },
-        {
-            language_code          => "kor",
-            language_name => "한국어",
-            language_locale_name   => "Korean",
-            ,
-        },
-        {
-            language_code          => "lat",
-            language_name => "Latina",
-            language_locale_name   => "Latin",
-            ,
-        },
-        {
-            language_code          => "nor",
-            language_name => "Norsk",
-            language_locale_name   => "Norwegian",
-            ,
-        },
-        {
-            language_code          => "per",
-            language_name => "فارسى",
-            language_locale_name   => "Persian",
-            ,
-        },
-        {
-            language_code          => "pol",
-            language_name => "Polski",
-            language_locale_name   => "Polish",
-            ,
-        },
-        {
-            language_code          => "por",
-            language_name => "Português",
-            language_locale_name   => "Portuguese",
-            ,
-        },
-        {
-            language_code          => "rum",
-            language_name => "Română",
-            language_locale_name   => "Romanian",
-            ,
-        },
-        {
-            language_code          => "rus",
-            language_name =>
-              "Русский",
-            language_locale_name => "Russian",
-            ,
-        },
-        {
-            language_code          => "spa",
-            language_name => "Español",
-            language_locale_name   => "Spanish",
-            ,
-        },
-        {
-            language_code          => "swe",
-            language_name => "Svenska",
-            language_locale_name   => "Swedish",
-            ,
-        },
-        {
-            language_code          => "tha",
-            language_name =>
-              "ภาษาไทย",
-            language_locale_name => "Thai",
-            ,
-        },
-        {
-            language_code          => "tur",
-            language_name => "Türkçe",
-            language_locale_name   => "Turkish",
-            ,
-        },
-        {
-            language_code          => "ukr",
-            language_name =>
-"Українська",
-            language_locale_name => "Ukrainian",
-            ,
-        },
-
-    ];
-    return $languages_loop;
+       my @languages_loop;
+       my $dbh=C4::Context->dbh;
+       my $current_language = 'en';
+       my $sth = $dbh->prepare('SELECT * FROM language_subtag_registry WHERE type=\'language\'');
+       $sth->execute();
+       while (my $language_subtag_registry = $sth->fetchrow_hashref) {
+
+               # pull out all the script descriptions for each language
+               my $sth2= $dbh->prepare('SELECT * FROM language_descriptions WHERE type=\'language\' AND subtag =?');
+               $sth2->execute($language_subtag_registry->{subtag});
+
+               # add the correct description info
+               while (my $language_descriptions = $sth2->fetchrow_hashref) {
+                       
+                       # Insert the language description using the current language script
+                       #if ( $language_subtag_registry->{subtag}
+                       if ( $current_language eq $language_descriptions->{lang} ) {
+                               $language_subtag_registry->{language_description} = $language_descriptions->{description};
+                               #warn "CUR:".$language_subtag_registry->{description};
+                       }
+
+                       # Insert the language name using the script     native to the language (FIXME: should really be based on script)
+                       if  ($language_subtag_registry->{subtag} eq $language_descriptions->{lang}) {
+                               $language_subtag_registry->{language_native_description} = $language_descriptions->{description};
+                               #warn "NAT: Desc:$language_descriptions->{description} SubtagDesc: $language_subtag_registry->{language_description}";
+                       }
+               }       
+               push @languages_loop, $language_subtag_registry;
+       }
+    return \@languages_loop;
 }
 
 =head2 _get_themes
@@ -405,15 +239,14 @@ sub _get_language_dirs {
         next if $language =~/png$/;
         next if $language =~/css$/;
         next if $language =~/CVS$/;
-        next if $language =~/itemtypeimg$/;
         next if $language =~/\.txt$/i;     #Don't read the readme.txt !
-        next if $language eq 'images';
+               next if $language =~/img|images/;
         push @languages, $language;
     }
         return (@languages);
 }
 
-=head2 _get_final_languages 
+=head2 _build_languages_arrayref 
 
 Internal function for building the ref to array of hashes
 
@@ -421,23 +254,211 @@ FIXME: this could be rewritten and simplified using map
 
 =cut
 
-sub _get_final_languages {
+sub _build_languages_arrayref {
         my ($all_languages,@languages) = @_;
         my @final_languages;
         my %seen_languages;
+               my %found_languages;
+               # Loop through the languages, pick the ones that are translated
         for my $language (@languages) {
+
+                       # separate the language string into its subtag types
+                       my $language_subtags_hashref = regex_lang_subtags($language);
             unless ($seen_languages{$language}) {
                 for my $language_code (@$all_languages) {
-                    if ($language eq $language_code->{'language_code'}) {
+                    if ($language_subtags_hashref->{language} eq $language_code->{'subtag'}) {
+                                               $language_code->{'language_lang'} = $language;
+                                               $language_code->{'language_code'} = $language_subtags_hashref->{'language'};
+                                               $language_code->{'script_code'} = $language_subtags_hashref->{'script'};
+                                               $language_code->{'region_code'} = $language_subtags_hashref->{'region'};
+                                               $language_code->{'variant_code'} = $language_subtags_hashref->{'variant'};
                         push @final_languages, $language_code;
+                                               $found_languages{$language}++;
                     }
                 }
                 $seen_languages{$language}++;
+
+                               # Handle languages not in our database with their code
+                               unless ($found_languages{$language}) {
+                                       my $language_code;
+                                       $language_code->{'language_lang'} = $language;
+                                       $language_code->{'language_code'} = $language;
+                                       push @final_languages, $language_code;
+                               }
             }
         }
         return \@final_languages;
 }
 
+sub language_get_description {
+       my ($script,$lang,$type) = @_;
+       my $dbh = C4::Context->dbh;
+       my $desc;
+       my $sth = $dbh->prepare('SELECT description FROM language_descriptions WHERE subtag=? AND lang=? AND type=?');
+       $sth->execute($script,$lang,$type);
+       while (my $descriptions = $sth->fetchrow_hashref) {
+               $desc = $descriptions->{'description'};
+       }
+       return $desc;
+}
+=head2 regex_lang_subtags
+
+This internal sub takes a string composed according to RFC 4646 as
+an input and returns a reference to a hash containing keys and values
+for ( language, script, region, variant, extension, privateuse )
+
+=cut
+
+sub regex_lang_subtags {
+    my $string = shift;
+
+    # Regex for recognizing RFC 4646 well-formed tags
+    # http://www.rfc-editor.org/rfc/rfc4646.txt
+
+    # regexes based on : http://unicode.org/cldr/data/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
+    # The structure requires no forward references, so it reverses the order.
+    # The uppercase comments are fragments copied from RFC 4646
+    #
+    # Note: the tool requires that any real "=" or "#" or ";" in the regex be escaped.
+
+    my $alpha   = qr/[a-zA-Z]/ ;    # ALPHA
+    my $digit   = qr/[0-9]/ ;   # DIGIT
+    my $alphanum    = qr/[a-zA-Z0-9]/ ; # ALPHA / DIGIT
+    my $x   = qr/[xX]/ ;    # private use singleton
+    my $singleton = qr/[a-w y-z A-W Y-Z]/ ; # other singleton
+    my $s   = qr/[-]/ ; # separator -- lenient parsers will use [-_]
+
+    # Now do the components. The structure is slightly different to allow for capturing the right components.
+    # The notation (?:....) is a non-capturing version of (...): so the "?:" can be deleted if someone doesn't care about capturing.
+
+    my $extlang = qr{(?: $s $alpha{3} )}x ; # *3("-" 3ALPHA)
+    my $language    = qr{(?: $alpha{2,3} | $alpha{4,8} )}x ;
+    #my $language   = qr{(?: $alpha{2,3}$extlang{0,3} | $alpha{4,8} )}x ;   # (2*3ALPHA [ extlang ]) / 4ALPHA / 5*8ALPHA
+
+    my $script  = qr{(?: $alpha{4} )}x ;    # 4ALPHA 
+
+    my $region  = qr{(?: $alpha{2} | $digit{3} )}x ;     # 2ALPHA / 3DIGIT
+
+    my $variantSub  = qr{(?: $digit$alphanum{3} | $alphanum{5,8} )}x ;  # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
+    my $variant = qr{(?: $variantSub (?: $s$variantSub )* )}x ; # *("-" variant), 5*8alphanum / (DIGIT 3alphanum)
+
+    my $extensionSub    = qr{(?: $singleton (?: $s$alphanum{2,8} )+ )}x ;   # singleton 1*("-" (2*8alphanum))
+    my $extension   = qr{(?: $extensionSub (?: $s$extensionSub )* )}x ; # singleton 1*("-" (2*8alphanum))
+
+    my $privateuse  = qr{(?: $x (?: $s$alphanum{1,8} )+ )}x ;   # ("x"/"X") 1*("-" (1*8alphanum))
+
+    # Define certain grandfathered codes, since otherwise the regex is pretty useless.
+    # Since these are limited, this is safe even later changes to the registry --
+    # the only oddity is that it might change the type of the tag, and thus
+    # the results from the capturing groups.
+    # http://www.iana.org/assignments/language-subtag-registry
+    # Note that these have to be compared case insensitively, requiring (?i) below.
+
+    my $grandfathered   = qr{(?: (?i)
+        en $s GB $s oed
+    |   i $s (?: ami | bnn | default | enochian | hak | klingon | lux | mingo | navajo | pwn | tao | tay | tsu )
+    |   sgn $s (?: BE $s fr | BE $s nl | CH $s de)
+)}x;
+
+    # For well-formedness, we don't need the ones that would otherwise pass, so they are commented out here
+
+    #   |   art $s lojban
+    #   |   cel $s gaulish
+    #   |   en $s (?: boont | GB $s oed | scouse )
+    #   |   no $s (?: bok | nyn)
+    #   |   zh $s (?: cmn | cmn $s Hans | cmn $s Hant | gan | guoyu | hakka | min | min $s nan | wuu | xiang | yue)
+
+    # Here is the final breakdown, with capturing groups for each of these components
+    # The language, variants, extensions, grandfathered, and private-use may have interior '-'
+
+    #my $root = qr{(?: ($language) (?: $s ($script) )? 40% (?: $s ($region) )? 40% (?: $s ($variant) )? 10% (?: $s ($extension) )? 5% (?: $s ($privateuse) )? 5% ) 90% | ($grandfathered) 5% | ($privateuse) 5% };
+
+       $string =~  qr{^ (?:($language)) (?:$s($script))? (?:$s($region))?  (?:$s($variant))?  (?:$s($extension))?  (?:$s($privateuse))? $}xi;  # |($grandfathered) | ($privateuse) $}xi;
+       my %subtag = (
+        'language' => $1,
+        'script' => $2,
+        'region' => $3,
+        'variant' => $4,
+        'extension' => $5,
+        'privateuse' => $6,
+    );
+    return \%subtag;
+}
+
+# Script Direction Resources:
+# http://www.w3.org/International/questions/qa-scripts
+sub get_bidi {
+       my ($language_script)= @_;
+       my $dbh = C4::Context->dbh;
+       my $bidi;
+       my $sth = $dbh->prepare('SELECT bidi FROM language_script_bidi WHERE rfc4646_subtag=?');
+       $sth->execute($language_script);
+       while (my $result = $sth->fetchrow_hashref) {
+               $bidi = $result->{'bidi'};
+       }
+       return $bidi;
+};
+
+sub accept_language {
+       # referenced http://search.cpan.org/src/CGILMORE/I18N-AcceptLanguage-1.04/lib/I18N/AcceptLanguage.pm
+       my      ($clientPreferences,$supportedLanguages) = @_;
+       # There should be no whitespace anways, but a cleanliness/sanity check
+       $clientPreferences =~ s/\s//g;
+  
+       # Prepare the list of client-acceptable languages
+       my @languages = ();
+       foreach my $tag (split(/,/, $clientPreferences)) {
+               my ($language, $quality) = split(/\;/, $tag);
+               $quality =~ s/^q=//i if $quality;
+               $quality = 1 unless $quality;
+               next if $quality <= 0;
+               # We want to force the wildcard to be last
+               $quality = 0 if ($language eq '*');
+               # Pushing lowercase language here saves processing later
+               push(@languages, { quality => $quality,
+                      language => $language,
+                      lclanguage => lc($language) });
+       }
+       # Prepare the list of server-supported languages
+       my %supportedLanguages = ();
+       my %secondaryLanguages = ();
+       foreach my $language (@$supportedLanguages) {
+               warn "SUP: ".$language->{language_code};
+               $supportedLanguages{lc($language->{language_code})} = $language->{language_code};
+               if ($language->{language_code} =~ /^([^-]+)-?/) {
+                       $secondaryLanguages{lc($1)} = $language->{language_code};
+               }
+       }
+
+       # Reverse sort the list, making best quality at the front of the array
+       @languages = sort { $b->{quality} <=> $a->{quality} } @languages;
+       my $secondaryMatch = '';
+       foreach my $tag (@languages) {
+               if (exists($supportedLanguages{$tag->{lclanguage}})) {
+                       # Client en-us eq server en-us
+                       return $supportedLanguages{$tag->{language}} if exists($supportedLanguages{$tag->{language}});
+                       return $supportedLanguages{$tag->{lclanguage}};
+               } elsif (exists($secondaryLanguages{$tag->{lclanguage}})) {
+                       # Client en eq server en-us
+                       return $secondaryLanguages{$tag->{language}} if exists($secondaryLanguages{$tag->{language}});
+                       return $supportedLanguages{$tag->{lclanguage}};
+               } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
+                       # Client en-gb eq server en-us
+                       $secondaryMatch = $secondaryLanguages{$1};
+               } elsif ($tag->{lclanguage} =~ /^([^-]+)-/ && exists($secondaryLanguages{$1}) && $secondaryMatch eq '') {
+                       # Client en-us eq server en
+                       $secondaryMatch = $supportedLanguages{$1};
+               } elsif ($tag->{lclanguage} eq '*') {
+               # * matches every language not already specified.
+               # It doesn't care which we pick, so let's pick the default,
+               # if available, then the first in the array.
+               #return $acceptor->defaultLanguage() if $acceptor->defaultLanguage();
+               return $supportedLanguages->[0];
+               }
+       }
+       # No primary matches. Secondary? (ie, en-us requested and en supported)
+       return $secondaryMatch if $secondaryMatch;
+}
 1;
 
 __END__