--- loncom/localize/lonlocal.pm 2003/12/22 23:34:49 1.29 +++ loncom/localize/lonlocal.pm 2009/01/05 16:55:04 1.50.2.2 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Localization routines # -# $Id: lonlocal.pm,v 1.29 2003/12/22 23:34:49 www Exp $ +# $Id: lonlocal.pm,v 1.50.2.2 2009/01/05 16:55:04 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -161,16 +161,17 @@ but for most purposes, we do not have to package Apache::lonlocal; use strict; -use Apache::Constants qw(:common); use Apache::localize; -use Apache::File; use locale; -use POSIX qw(locale_h); +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); # ========================================================= The language handle @@ -179,13 +180,46 @@ use vars qw($lh); # ===================================================== The "MakeText" function sub mt (@) { -# my $fh=Apache::File->new('>>/home/www/loncapa/loncom/localize/localize/newphrases.txt'); -# print $fh @_[0]."\n"; -# $fh->close(); +# open(LOG,'>>/home/www/loncapa/loncom/localize/localize/newphrases.txt'); +# print LOG (@_[0]."\n"); +# close(LOG); if ($lh) { - return $lh->maketext(@_); + if ($_[0] eq '') { + if (wantarray) { + return @_; + } else { + return $_[0]; + } + } else { + return $lh->maketext(@_); + } } else { - return @_; + if (wantarray) { + return @_; + } else { + return $_[0]; + } + } +} + +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]; + } } } @@ -199,14 +233,69 @@ 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); + } + + foreach my $domtype ($Apache::lonnet::env{'user.domain'},$Apache::lonnet::env{'request.role.domain'}, + $Apache::lonnet::perlvar{'lonDefDomain'}) { + if ($domtype ne '') { + 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'; + } if ($lh) { my $enc=$lh->maketext('char_encoding'); - return ($enc eq 'char_encoding'?'':$enc); + return ($enc eq 'char_encoding'?$default:$enc); } else { - return undef; + return $default; } } @@ -236,32 +325,96 @@ sub texthash { sub get_language_handle { my $r=shift; - my $headers=$r->headers_in; - $ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'}; - my @languages=&Apache::loncommon::preferred_languages; + if ($r) { + my $headers=$r->headers_in; + $ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'}; + } + my @languages=&preferred_languages(); $ENV{'HTTP_ACCEPT_LANGUAGE'}=''; - &Apache::lonnet::logthis($r->uri.' '.join(' ',@languages)); $lh=Apache::localize->get_handle(@languages); - if (&Apache::lonnet::mod_perl_version == 1) { + if ($r) { $r->content_languages([¤t_language()]); } ### setlocale(LC_ALL,¤t_locale); } # ========================================================== Localize localtime +sub gettimezone { + 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 '') { + 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($timezone)); if ((¤t_language=~/^en/) || (!$lh)) { - return ''.localtime($thistime); + + return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)"); } else { my $format=$lh->maketext('date_locale'); if ($format eq 'date_locale') { - return ''.localtime($thistime); + return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)"); } - my ($seconds,$minutes,$twentyfour,$day,$mon,$year,$wday,$yday,$isdst)= - localtime($thistime); - my $month=(split(/\,/,$lh->maketext('date_months')))[$mon]; + my $time_zone = $dt->time_zone_short_name(); + my $seconds = $dt->second(); + my $minutes = $dt->minute(); + my $twentyfour = $dt->hour(); + my $day = $dt->day_of_month(); + my $mon = $dt->month()-1; + my $year = $dt->year(); + my $wday = $dt->wday(); + if ($wday==7) { $wday=0; } + my $month =(split(/\,/,$lh->maketext('date_months')))[$mon]; my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday]; if ($seconds<10) { $seconds='0'.$seconds; @@ -269,7 +422,6 @@ sub locallocaltime { if ($minutes<10) { $minutes='0'.$minutes; } - $year+=1900; my $twelve=$twentyfour; my $ampm; if ($twelve>12) { @@ -278,15 +430,46 @@ sub locallocaltime { } else { $ampm=$lh->maketext('date_am'); } - foreach - ('seconds','minutes','twentyfour','twelve','day','year', - 'month','weekday','ampm') { + foreach ('seconds','minutes','twentyfour','twelve','day','year', + 'month','weekday','ampm') { $format=~s/\$$_/eval('$'.$_)/gse; } - return $format; + return $format." ($time_zone)"; + } +} + +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; } + # ==================== Normalize string (reduce fragility in the lexicon files) # This normalizes a string to reduce fragility in the lexicon files of @@ -330,22 +513,19 @@ sub transstatic { $$strptr=~s/MT\{([^\}]*)\}/&mt($1)/gse; } -# ----------------------------------------------- Handler Routine /adm/localize -sub handler { - my $r=shift; - &Apache::lonlocal::get_language_handle($r); - &Apache::loncommon::content_type($r,'text/html'); - $r->send_http_header; - return OK if $r->header_only; - - my $uri=$r->uri; - $uri=~s/^\/adm\/localize//; - my $fn=$Apache::lonnet::perlvar{'lonDocRoot'}.$uri; - - my $file=&Apache::lonnet::getfile($fn); - &transstatic(\$file); - $r->print($file); - return OK; +=pod + +=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 + +=cut + +sub mt_escape { + my ($str_ref) = @_; + $$str_ref =~s/~/~~/g; + $$str_ref =~s/([\[\]])/~$1/g; } 1;