--- loncom/localize/lonlocal.pm 2009/05/04 21:44:00 1.58 +++ loncom/localize/lonlocal.pm 2019/02/24 01:38:14 1.67 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Localization routines # -# $Id: lonlocal.pm,v 1.58 2009/05/04 21:44:00 lueken Exp $ +# $Id: lonlocal.pm,v 1.67 2019/02/24 01:38:14 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -38,7 +38,7 @@ Apache::lonlocal - provides localization lonlocal provides localization services for LON-CAPA programmers based on Locale::Maketext. See -C +C for more information on Maketext. =head1 OVERVIEWX @@ -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' @@ -153,7 +153,7 @@ ignore the rest of the line. This is a relatively easy task, and any help is appreciated. Maketext can do a whole lot more, see -C +C but for most purposes, we do not have to mess with that. =cut @@ -171,7 +171,7 @@ use DateTime::Locale; require Exporter; our @ISA = qw (Exporter); -our @EXPORT = qw(mt mtn ns mt_user); +our @EXPORT = qw(mt mtn ns mt_user js_escape html_escape); my %mtcache=(); @@ -262,9 +262,9 @@ sub preferred_languages { push(@languages,@browser); } - foreach my $domtype ($Apache::lonnet::env{'user.domain'},$Apache::lonnet::env{'request.role.domain'}, - $Apache::lonnet::perlvar{'lonDefDomain'}) { - if ($domtype ne '') { + 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'}); @@ -295,13 +295,12 @@ sub get_genlanguages { sub current_encoding { my $default='UTF-8'; -# UTF-8 character encoding needed for the whole LON-CAPA system -# (interface language and homework problem content) -# See Bugzilla 5702 vs. 2189 and 4067 -# 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'); return ($enc eq 'char_encoding'?$default:$enc); @@ -326,7 +325,7 @@ sub current_locale { sub texthash { my %hash=@_; - foreach (keys %hash) { + foreach (keys(%hash)) { $hash{$_}=&mt($hash{$_}); } return %hash; @@ -335,12 +334,17 @@ 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=&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=¤t_language(); @@ -378,7 +382,8 @@ sub gettimezone { if ($uroledomdefs{'timezone_def'} ne '') { $timezone = $uroledomdefs{'timezone_def'}; } - } elsif ($Apache::lonnet::env{'user.domain'} ne '') { + } 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 '') { @@ -393,10 +398,8 @@ sub gettimezone { return 'local'; } -our $timezone_local; - sub locallocaltime { - my ($thistime,$timezone,$datetime) = @_; + my ($thistime,$timezone) = @_; if (!defined($thistime) || $thistime eq '') { return &mt('Never'); @@ -410,69 +413,16 @@ sub locallocaltime { return &mt('Never'); } - my $dt; - my $convert_time; + my $dt = DateTime->from_epoch(epoch => $thistime) + ->set_time_zone(gettimezone($timezone)); - #### START # Speed up if this function is called often #### - - # Is a $datetime parameter set? - if(defined($datetime)) { - # Check for an instance of a DateTime object - if(!(defined $$datetime)) { - # No object, create one - $$datetime = DateTime->from_epoch(epoch => $thistime) - ->set_time_zone(&gettimezone($timezone)); - $dt = $$datetime; - } else { - # If the return-value is "local", we have to convert it for DateTime - - # Converts the "local"-String only once - if(!defined($timezone_local)) - { - $timezone_local = DateTime::TimeZone->new( name => gettimezone('local'))->name(); - } - - my $timezone_now; - - if(gettimezone($timezone) == 'local') - { - $timezone_now = $timezone_local; - } else { - $timezone_now = gettimezone($timezone); - } - - # Has the timezone changed? - if($timezone_now eq $$datetime->time_zone_short_name() || - $timezone_now eq $$datetime->time_zone_long_name()) - { - # There is already an object (dereference) - $dt = $$datetime; - - # We need this as temporary value - $convert_time = DateTime->from_epoch( epoch => $thistime ); - #->set_time_zone('floating'); - - # Preventing a set_time_zone call (time consuming) - # Using old instance of DateTime with timezone - $dt->set( year => $convert_time->year(), - month => $convert_time->month(), - day => $convert_time->day(), - hour => $convert_time->hour(), - minute => $convert_time->minute(), - second => $convert_time->second() ); - } else { - # The timezone has changed since last time - $$datetime = DateTime->from_epoch(epoch => $thistime) - ->set_time_zone(&gettimezone($timezone)); - $dt = $$datetime; - } - } - } else { - # There is no $datetime parameter - $dt = DateTime->from_epoch(epoch => $thistime) - ->set_time_zone(&gettimezone($timezone)); - } - #### END # Speed up if this function is called often #### + # 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 ((¤t_language=~/^en/) || (!$lh)) { @@ -546,9 +496,11 @@ sub getdatelocale { return $locale_obj; } -=pod +=pod -=item * normalize_string +=over + +=item * normalize_string() Normalize string (reduce fragility in the lexicon files) @@ -571,7 +523,7 @@ sub normalize_string { =pod -=item * ns +=item * ns() alias for normalize_string; recommend using it only in the lexicon @@ -583,7 +535,7 @@ sub ns { =pod -=item * mtn +=item * mtn() mtn: call the mt function and the normalization function easily. Returns original non-normalized string if there was no translation @@ -612,7 +564,7 @@ sub transstatic { =pod -=item * mt_escape +=item * mt_escape() mt_escape takes a string reference and escape the [] in there so mt will leave them as is and not try to expand them @@ -625,6 +577,119 @@ 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