--- loncom/localize/lonlocal.pm	2005/11/15 19:07:58	1.37
+++ loncom/localize/lonlocal.pm	2009/05/04 21:44:00	1.58
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Localization routines
 #
-# $Id: lonlocal.pm,v 1.37 2005/11/15 19:07:58 albertel Exp $
+# $Id: lonlocal.pm,v 1.58 2009/05/04 21:44:00 lueken Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -161,19 +161,23 @@ but for most purposes, we do not have to
 package Apache::lonlocal;
 
 use strict;
-use Apache::Constants qw(:common);
 use Apache::localize;
 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);
+
+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,14 +241,67 @@ 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';
-    }
+# 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';
+#    }
     if ($lh) {
 	my $enc=$lh->maketext('char_encoding');
 	return ($enc eq 'char_encoding'?$default:$enc);
@@ -248,9 +340,10 @@ sub get_language_handle {
 	my $headers=$r->headers_in;
 	$ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'};
     }
-    my @languages=&Apache::loncommon::preferred_languages;
+    my @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 +352,146 @@ sub get_language_handle {
 
 # ========================================================== Localize localtime
 sub gettimezone {
-    return ' ('.$Apache::lonnet::env{'server.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 '') {
+        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';
 }
 
+our $timezone_local;
+
 sub locallocaltime {
-    my $thistime=shift;
+    my ($thistime,$timezone,$datetime) = @_;
+
+    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;
+   my $convert_time;
+
+   #### 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 ####
+
     if ((&current_language=~/^en/) || (!$lh)) {
-	return ''.localtime($thistime).&gettimezone();
+
+	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;
@@ -281,7 +499,6 @@ sub locallocaltime {
 	if ($minutes<10) {
 	    $minutes='0'.$minutes;
 	}
-	$year+=1900;
 	my $twelve=$twentyfour;
 	my $ampm;
 	if ($twelve>12) {
@@ -290,21 +507,58 @@ 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.&gettimezone();
+	return $format." ($time_zone)";
     }
 }
 
-# ==================== 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;
@@ -315,13 +569,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]
@@ -342,22 +610,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;