--- loncom/localize/lonlocal.pm	2008/01/29 13:26:09	1.43
+++ loncom/localize/lonlocal.pm	2015/06/09 21:23:15	1.66
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Localization routines
 #
-# $Id: lonlocal.pm,v 1.43 2008/01/29 13:26:09 www Exp $
+# $Id: lonlocal.pm,v 1.66 2015/06/09 21:23:15 damieng Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -81,7 +81,7 @@ Inside might be something like this
      if ($status eq 'WON') {
         $message='You have won.';
      } elsif ($status eq 'LOST') {
-        $message='You are a total looser.';
+        $message='You are a total loser.';
      }
      return $message;
  }
@@ -103,7 +103,7 @@ The first two examples are easy:
      if ($status eq 'WON') {
         $message='You have won.';
      } elsif ($status eq 'LOST') {
-        $message='You are a total looser.';
+        $message='You are a total loser.';
      }
      return &mt($message);
  }
@@ -135,7 +135,7 @@ like this:
     'You have won.'
  => 'Sie haben gewonnen.',
 
-    'You are a total looser.'
+    'You are a total loser.'
  => 'Sie sind der totale Verlierer.',
 
     'Rules'
@@ -165,15 +165,19 @@ use Apache::localize;
 use locale;
 use POSIX qw(locale_h strftime);
 use DateTime();
+use DateTime::TimeZone;
+use DateTime::Locale;
 
 require Exporter;
 
 our @ISA = qw (Exporter);
-our @EXPORT = qw(mt mtn ns);
+our @EXPORT = qw(mt mtn ns mt_user js_escape html_escape);
+
+my %mtcache=();
 
 # ========================================================= The language handle
 
-use vars qw($lh);
+use vars qw($lh $current_language);
 
 # ===================================================== The "MakeText" function
 
@@ -182,7 +186,21 @@ sub mt (@) {
 #    print LOG (@_[0]."\n");
 #    close(LOG);
     if ($lh) {
-	return $lh->maketext(@_);
+        if ($_[0] eq '') {
+            if (wantarray) {
+                return @_;
+            } else {
+                return $_[0];
+            }
+        } else {
+            if ($#_>0) { return $lh->maketext(@_); }
+            if ($mtcache{$current_language.':'.$_[0]}) {
+               return $mtcache{$current_language.':'.$_[0]};
+            }
+            my $translation=$lh->maketext(@_);
+            $mtcache{$current_language.':'.$_[0]}=$translation;
+            return $translation; 
+        }
     } else {
 	if (wantarray) {
 	    return @_;
@@ -192,6 +210,27 @@ sub mt (@) {
     }
 }
 
+sub mt_user {
+    my ($user_lh,@what) = @_;
+    if ($user_lh) {
+        if ($what[0] eq '') {
+            if (wantarray) {
+                return @what;
+            } else {
+                return $what[0];
+            }
+        } else {
+            return $user_lh->maketext(@what);
+        }
+    } else {
+        if (wantarray) {
+            return @what;
+        } else {
+            return $what[0];
+        }
+    }
+}
+
 # ============================================================== What language?
 
 sub current_language {
@@ -202,13 +241,65 @@ sub current_language {
     return 'en';
 }
 
+sub preferred_languages {
+    my @languages=();
+    if (($Apache::lonnet::env{'request.role.adv'}) && ($Apache::lonnet::env{'form.languages'})) {
+        @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$Apache::lonnet::env{'form.languages'}));
+    }
+    if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.languages'}) {
+        @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
+                 $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.languages'}));
+    }
+
+    if ($Apache::lonnet::env{'environment.languages'}) {
+        @languages=(@languages,
+                    split(/\s*(\,|\;|\:)\s*/,$Apache::lonnet::env{'environment.languages'}));
+    }
+    my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
+    if ($browser) {
+        my @browser =
+            map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));
+        push(@languages,@browser);
+    }
+
+    my $defdom = &Apache::lonnet::default_login_domain();
+    foreach my $domtype ($Apache::lonnet::env{'user.domain'},$Apache::lonnet::env{'request.role.domain'},$defdom) {
+        if (($domtype ne '') && ($domtype ne 'public')) {
+            my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);
+            if ($domdefs{'lang_def'} ne '') {
+                push(@languages,$domdefs{'lang_def'});
+            }
+        }
+    }
+    return &get_genlanguages(@languages);
+}
+
+sub get_genlanguages {
+    my (@languages) = @_;
+# turn "en-ca" into "en-ca,en"
+    my @genlanguages;
+    foreach my $lang (@languages) {
+        unless ($lang=~/\w/) { next; }
+        push(@genlanguages,$lang);
+        if ($lang=~/(\-|\_)/) {
+            push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
+        }
+    }
+    #uniqueify the languages list
+    my %count;
+    @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
+    return @genlanguages;
+}
+
 # ============================================================== What encoding?
 
 sub current_encoding {
     my $default='UTF-8';
-    if ($Apache::lonnet::env{'browser.os'} eq 'win' && 
-	$Apache::lonnet::env{'browser.type'} eq 'explorer') {
-        $default='ISO-8859-1';
+    unless ($Apache::lonnet::env{'browser.unicode'}) {
+        if ($Apache::lonnet::env{'browser.os'} eq 'win' && 
+	    $Apache::lonnet::env{'browser.type'} eq 'explorer') {
+            $default='ISO-8859-1';
+        }
     }
     if ($lh) {
 	my $enc=$lh->maketext('char_encoding');
@@ -234,7 +325,7 @@ sub current_locale {
 
 sub texthash {
     my %hash=@_;
-    foreach (keys %hash) {
+    foreach (keys(%hash)) {
 	$hash{$_}=&mt($hash{$_});
     }
     return %hash;
@@ -243,14 +334,20 @@ sub texthash {
 # ========= Get a handle (do not invoke in vain, leave this to access handlers)
 
 sub get_language_handle {
-    my $r=shift;
+    my ($r,$chosen) = @_;
     if ($r) {
 	my $headers=$r->headers_in;
 	$ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'};
     }
-    my @languages=&Apache::loncommon::preferred_languages;
+    my @languages;
+    if ($chosen ne '') {
+        @languages=($chosen);
+    } else {
+        @languages=&preferred_languages();
+    }
     $ENV{'HTTP_ACCEPT_LANGUAGE'}='';
     $lh=Apache::localize->get_handle(@languages);
+    $current_language=&current_language();
     if ($r) {
 	$r->content_languages([&current_language()]);
     }
@@ -259,21 +356,74 @@ sub get_language_handle {
 
 # ========================================================== Localize localtime
 sub gettimezone {
-    my ($time) = @_;
-    if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'}) {
-	return $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'};
+    my ($timezone) = @_;
+    if ($timezone ne '') {
+        if (!DateTime::TimeZone->is_valid_name($timezone)) {
+            $timezone = 'local';
+        }
+        return $timezone;
+    }
+    my $cid = $Apache::lonnet::env{'request.course.id'};  
+    if ($cid ne '') {
+        if ($Apache::lonnet::env{'course.'.$cid.'.timezone'}) {
+            $timezone = $Apache::lonnet::env{'course.'.$cid.'.timezone'};    
+        } else {
+            my $cdom = $Apache::lonnet::env{'course.'.$cid.'.domain'};
+            if ($cdom ne '') {
+                my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
+                if ($domdefaults{'timezone_def'} ne '') {
+                    $timezone = $domdefaults{'timezone_def'};
+                }
+            }
+        }
+    } elsif ($Apache::lonnet::env{'request.role.domain'} ne '') {
+        my %uroledomdefs = 
+            &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'request.role.domain'});
+        if ($uroledomdefs{'timezone_def'} ne '') {
+            $timezone = $uroledomdefs{'timezone_def'};
+        }
+    } elsif (($Apache::lonnet::env{'user.domain'} ne '') && 
+             ($Apache::lonnet::env{'user.domain'} ne 'public')) {
+        my %udomdefaults = 
+            &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'user.domain'});
+        if ($udomdefaults{'timezone_def'} ne '') {
+            $timezone = $udomdefaults{'timezone_def'};
+        }
+    }
+    if ($timezone ne '') {
+        if (DateTime::TimeZone->is_valid_name($timezone)) {
+            return $timezone;
+        }
     }
     return 'local';
 }
 
 sub locallocaltime {
-    my $thistime=shift;
+    my ($thistime,$timezone) = @_;
+
     if (!defined($thistime) || $thistime eq '') {
 	return &mt('Never');
     }
+    if (($thistime < 0) || ($thistime eq 'NaN')) {
+        &Apache::lonnet::logthis("Unexpected time (negative or NaN) '$thistime' passed to lonlocal::locallocaltime");  
+        return &mt('Never');
+    }
+    if ($thistime !~ /^\d+$/) {
+        &Apache::lonnet::logthis("Unexpected non-numeric time '$thistime' passed to lonlocal::locallocaltime");
+        return &mt('Never');
+    }
 
     my $dt = DateTime->from_epoch(epoch => $thistime)
-                     ->set_time_zone(&gettimezone());
+                     ->set_time_zone(gettimezone($timezone));
+
+    # TimeZone tries to determine the 'local' timezone from $ENV{TZ} if this
+    # fails it searches through various system files. Under certain
+    # circumstances this is an extremly expensive operation.
+    # So after the first run we store the timezone in $ENV{TZ} to significantly
+    # speed up future lookups. 
+    $ENV{TZ} = $dt->time_zone()->name() 
+        if (! $ENV{TZ} && gettimezone($timezone) eq 'local');
+
     if ((&current_language=~/^en/) || (!$lh)) {
 
 	return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
@@ -315,12 +465,50 @@ sub locallocaltime {
     }
 }
 
-# ==================== Normalize string (reduce fragility in the lexicon files)
+sub getdatelocale {
+    my ($datelocale,$locale_obj);
+    if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.datelocale'}) {
+        $datelocale = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.datelocale'};
+    } elsif ($Apache::lonnet::env{'request.course.id'} ne '') {
+        my $cdom = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.domain'};
+        if ($cdom ne '') {
+            my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
+            if ($domdefaults{'datelocale_def'} ne '') {
+                $datelocale = $domdefaults{'datelocale_def'};
+            }
+        }
+    } elsif ($Apache::lonnet::env{'user.domain'} ne '') {
+        my %udomdefaults = &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'user.domain'});
+        if ($udomdefaults{'datelocale_def'} ne '') {
+            $datelocale = $udomdefaults{'datelocale_def'};
+        }
+    }
+    if ($datelocale ne '') {
+        eval {
+            $locale_obj = DateTime::Locale->load($datelocale);
+        };
+        if (!$@) {
+            if ($locale_obj->id() eq $datelocale) {
+                return $locale_obj;
+            }
+        }
+    }
+    return $locale_obj;
+}
+
+=pod 
+
+=item * normalize_string
+
+Normalize string (reduce fragility in the lexicon files)
+
+This normalizes a string to reduce fragility in the lexicon files of
+huge messages (such as are used by the helper), and allow useful
+formatting: reduce all consecutive whitespace to a single space,
+and remove all HTML
+
+=cut
 
-# This normalizes a string to reduce fragility in the lexicon files of
-# huge messages (such as are used by the helper), and allow useful
-# formatting: reduce all consecutive whitespace to a single space,
-# and remove all HTML
 sub normalize_string {
     my $s = shift;
     $s =~ s/\s+/ /g;
@@ -331,13 +519,27 @@ sub normalize_string {
     return $s;
 }
 
-# alias for normalize_string; recommend using it only in the lexicon
+=pod 
+
+=item * ns
+
+alias for normalize_string; recommend using it only in the lexicon
+
+=cut
+
 sub ns {
     return normalize_string(@_);
 }
 
-# mtn: call the mt function and the normalization function easily.
-# Returns original non-normalized string if there was no translation
+=pod
+
+=item * mtn
+
+mtn: call the mt function and the normalization function easily.
+Returns original non-normalized string if there was no translation
+
+=cut
+
 sub mtn (@) {
     my @args = @_; # don't want to modify caller's string; if we
 		   # didn't care about that we could set $_[0]
@@ -373,6 +575,117 @@ sub mt_escape {
     $$str_ref =~s/([\[\]])/~$1/g;
 }
 
+=pod 
+
+=item * js_escape
+
+js_escape takes a string, string reference or hash reference,
+and escapes the values so that they can be used within a <script> element.
+It replaces all instances of \ by \\, ' by \', " by \" and \n by \\n.
+It is typically used with localized strings, which might contain quotes.
+
+=cut
+
+sub js_escape {
+    my ($v) = @_;
+    my $ref = ref($v);
+    if ($ref eq 'SCALAR') {
+        $$v =~ s/\\/\\\\/g;
+        $$v =~ s/'/\\'/g;
+        $$v =~ s/"/\\"/g;
+        $$v =~ s/\n/\\n/g;
+    } elsif ($ref eq 'HASH') {
+        foreach my $key (keys %$v) {
+            $v->{$key} =~ s/\\/\\\\/g;
+            $v->{$key} =~ s/'/\\'/g;
+            $v->{$key} =~ s/"/\\"/g;
+            $v->{$key} =~ s/\n/\\n/g;
+        }
+    } else {
+        $v =~ s/\\/\\\\/g;
+        $v =~ s/'/\\'/g;
+        $v =~ s/"/\\"/g;
+        $v =~ s/\n/\\n/g;
+        return $v;
+    }
+}
+
+=pod 
+
+=item * html_escape
+
+js_escape takes a string, string reference or hash reference,
+and escapes the values so that they can be used as HTML.
+It encodes <, >, &, ' and ".
+
+=cut
+
+sub html_escape {
+    my ($v) = @_;
+    my $ref = ref($v);
+    if ($ref eq 'SCALAR') {
+        $$v =~ s/&/&amp;/g;
+        $$v =~ s/</&lt;/g;
+        $$v =~ s/>/&gt;/g;
+        $$v =~ s/'/&apos;/g;
+        $$v =~ s/"/&quot;/g;
+    } elsif ($ref eq 'HASH') {
+        foreach my $key (keys %$v) {
+            $v->{$key} =~ s/&/&amp;/g;
+            $v->{$key} =~ s/</&lt;/g;
+            $v->{$key} =~ s/>/&gt;/g;
+            $v->{$key} =~ s/'/&apos;/g;
+            $v->{$key} =~ s/"/&quot;/g;
+        }
+    } else {
+        $v =~ s/&/&amp;/g;
+        $v =~ s/</&lt;/g;
+        $v =~ s/>/&gt;/g;
+        $v =~ s/'/&apos;/g;
+        $v =~ s/"/&quot;/g;
+        return $v;
+    }
+    # NOTE: we could also turn \n into <br> if needed
+}
+
+=pod
+
+=item * choose_language
+
+choose_language prompts a user to enter a two letter language code via
+keyboard when running a script from the command line. Default is en.
+
+=cut
+
+sub choose_language {
+    my %languages = (
+                      ar => 'Arabic',
+                      de => 'German',
+                      en => 'English',
+                      es => 'Spanish',
+                      fa => 'Persian',
+                      fr => 'French',
+                      he => 'Hebrew',
+                      ja => 'Japanese',
+                      pt => 'Portuguese',
+                      ru => 'Russian',
+                      tr => 'Turkish',
+                      zh => 'Chinese (Simplified)'
+                   );
+    my @posslangs = sort(keys(%languages));
+    my $langlist = join('|',@posslangs);
+    my $lang = 'en';
+    print 'Language: English (en). Change? ['.$langlist.']? ';
+    my $langchoice = <STDIN>;
+    chomp($langchoice);
+    $langchoice =~ s/(^\s+|\s+$)//g;
+    $langchoice = lc($langchoice);
+    if (defined($languages{$langchoice})) {
+        $lang = $langchoice;
+    }
+    return $lang;
+}
+
 1;
 
 __END__