Return to lonlocal.pm CVS log

Up to [LON-CAPA] / loncom / localize

Bug 5638.
 - Sanity checking of $thistime passed to locallocaltime(), before calling DateTime->from_epoch() to prevent ISE.

    1: # The LearningOnline Network with CAPA
    2: # Localization routines
    3: #
    4: # $Id: lonlocal.pm,v 1.47 2008/07/02 21:31:32 raeburn Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: ######################################################################
   29: ######################################################################
   30: 
   31: =pod
   32: 
   33: =head1 NAME
   34: 
   35: Apache::lonlocal - provides localization services
   36: 
   37: =head1 SYNOPSIS
   38: 
   39: lonlocal provides localization services for LON-CAPA programmers based
   40: on Locale::Maketext. See
   41: C<http://search.cpan.org/dist/Locale-Maketext/lib/Locale/Maketext.pod>
   42: for more information on Maketext.
   43: 
   44: =head1 OVERVIEWX<internationalization>
   45: 
   46: As of LON-CAPA 1.1, we've started to localize LON-CAPA using the
   47: Locale::Maketext module. Internationalization is the bulk of the work
   48: right now (pre-1.1); localizing can be done anytime, and involves 
   49: little or no programming.
   50: 
   51: The internationalization process involves putting a wrapper around
   52: on-screen user messages and menus and turning them into keys,
   53: which the MaketextX<Maketext> library translates into the desired
   54: language output using a look-up table ("lexicon").X<lexicon>
   55: 
   56: As keys we are currently using the plain English messages, and
   57: Maketext is configured to replace the message by its own key if no
   58: translation is found. This makes it easy to phase in the
   59: internationalization without disturbing the screen output.
   60: 
   61: Internationalization is somewhat tedious and effectively impossible
   62: for a non-fluent speaker to perform, but is fairly easy to create
   63: translations, requiring no programming skill. As a result, this is one
   64: area where you can really help LON-CAPA out, even if you aren't a
   65: programmer, and we'd really appreciate it.
   66: 
   67: =head1 How To Localize Handlers For Programmers
   68: 
   69: Into the "use" section of a module, we need to insert
   70: 
   71:  use Apache::lonlocal;
   72: 
   73: Note that there are B<no parentheses>, we B<want> to pollute our
   74: namespace. 
   75: 
   76: Inside might be something like this
   77: 
   78:  sub message {
   79:      my $status=shift;
   80:      my $message='Status unknown';
   81:      if ($status eq 'WON') {
   82:         $message='You have won.';
   83:      } elsif ($status eq 'LOST') {
   84:         $message='You are a total looser.';
   85:      }
   86:      return $message;
   87:  }
   88:  ...
   89:  $r->print('<h3>Gamble your Homework Points</h3>');
   90:  ...
   91:  $r->print(<<ENDMSG);
   92:  <font size="1">Rules:</font>
   93:  <font size="0">No purchase necessary. Illegal where not allowed.</font>
   94:  ENDMSG
   95: 
   96: We have to now wrap the subroutine &mt()X<mt> ("maketext") around our 
   97: messages, but not around markup, etc. We also want minimal disturbance. 
   98: The first two examples are easy:
   99: 
  100:  sub message {
  101:      my $status=shift;
  102:      my $message='Status unknown';
  103:      if ($status eq 'WON') {
  104:         $message='You have won.';
  105:      } elsif ($status eq 'LOST') {
  106:         $message='You are a total looser.';
  107:      }
  108:      return &mt($message);
  109:  }
  110:  ...
  111:  $r->print('<h3>'.&mt('Gamble your Homework Points').'</h3>');
  112: 
  113: The last one is a bummer, since you cannot call subroutines inside of 
  114: (<<MARKER). I have written a little subroutine to generate a translated 
  115: hash for that purpose:
  116: 
  117:  my %lt=&Apache::lonlocal::texthash('header' => 'Rules', 'disclaimer' => 
  118:  'No purchase necessary. Illegal where not allowed.');
  119:  $r->print(<<ENDMSG);
  120:  <font size="1">$lt{'header'}:</font>
  121:  <font size="0">$lt{'disclaimer'}</font>
  122:  ENDMSG
  123: 
  124: As a programmer, your job is done here. If everything worked, you 
  125: should see no changes on the screen.
  126: 
  127: =head1 How To Localize LON-CAPA for Translators
  128: 
  129: As a translator, you need to provide the lexicon for the keys, which in 
  130: this case is the plain text message. The lexicons sit in 
  131: loncom/localize/localize, with the language code as filename, for 
  132: example de.pm for the German translation. The file then simply looks 
  133: like this:
  134: 
  135:     'You have won.'
  136:  => 'Sie haben gewonnen.',
  137: 
  138:     'You are a total looser.'
  139:  => 'Sie sind der totale Verlierer.',
  140: 
  141:     'Rules'
  142:  => 'Regeln',
  143: 
  144:     'No purchase necessary. Illegal where not allowed.'
  145:  => 'Es ist erlaubt, einfach zu verlieren, und das ist Ihre Schuld.'
  146: 
  147: 
  148: Comments may be added with the # symbol, which outside of a string
  149: (the things with the apostrophe surrounding them, which are the 
  150: keys and translations) will cause the translation routines to
  151: ignore the rest of the line.
  152: 
  153: This is a relatively easy task, and any help is appreciated.
  154: 
  155: Maketext can do a whole lot more, see
  156: C<http://search.cpan.org/dist/Locale-Maketext/lib/Locale/Maketext.pod>
  157: but for most purposes, we do not have to mess with that.
  158: 
  159: =cut
  160: 
  161: package Apache::lonlocal;
  162: 
  163: use strict;
  164: use Apache::localize;
  165: use locale;
  166: use POSIX qw(locale_h strftime);
  167: use DateTime();
  168: use DateTime::TimeZone;
  169: 
  170: require Exporter;
  171: 
  172: our @ISA = qw (Exporter);
  173: our @EXPORT = qw(mt mtn ns);
  174: 
  175: # ========================================================= The language handle
  176: 
  177: use vars qw($lh);
  178: 
  179: # ===================================================== The "MakeText" function
  180: 
  181: sub mt (@) {
  182: #    open(LOG,'>>/home/www/loncapa/loncom/localize/localize/newphrases.txt');
  183: #    print LOG (@_[0]."\n");
  184: #    close(LOG);
  185:     if ($lh) {
  186:         if ($_[0] eq '') {
  187:             if (wantarray) {
  188:                 return @_;
  189:             } else {
  190:                 return $_[0];
  191:             }
  192:         } else {
  193:             return $lh->maketext(@_);
  194:         }
  195:     } else {
  196: 	if (wantarray) {
  197: 	    return @_;
  198: 	} else {
  199: 	    return $_[0];
  200: 	}
  201:     }
  202: }
  203: 
  204: # ============================================================== What language?
  205: 
  206: sub current_language {
  207:     if ($lh) {
  208: 	my $lang=$lh->maketext('language_code');
  209: 	return ($lang eq 'language_code'?'en':$lang);
  210:     }
  211:     return 'en';
  212: }
  213: 
  214: # ============================================================== What encoding?
  215: 
  216: sub current_encoding {
  217:     my $default='UTF-8';
  218:     if ($Apache::lonnet::env{'browser.os'} eq 'win' && 
  219: 	$Apache::lonnet::env{'browser.type'} eq 'explorer') {
  220:         $default='ISO-8859-1';
  221:     }
  222:     if ($lh) {
  223: 	my $enc=$lh->maketext('char_encoding');
  224: 	return ($enc eq 'char_encoding'?$default:$enc);
  225:     } else {
  226: 	return $default;
  227:     }
  228: }
  229: 
  230: # =============================================================== Which locale?
  231: # Refer to locale -a
  232: #
  233: sub current_locale {
  234:     if ($lh) {
  235: 	my $enc=$lh->maketext('lang_locale');
  236: 	return ($enc eq 'lang_locale'?'':$enc);
  237:     } else {
  238: 	return undef;
  239:     }
  240: }
  241: 
  242: # ============================================================== Translate hash
  243: 
  244: sub texthash {
  245:     my %hash=@_;
  246:     foreach (keys %hash) {
  247: 	$hash{$_}=&mt($hash{$_});
  248:     }
  249:     return %hash;
  250: }
  251: 
  252: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
  253: 
  254: sub get_language_handle {
  255:     my $r=shift;
  256:     if ($r) {
  257: 	my $headers=$r->headers_in;
  258: 	$ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'};
  259:     }
  260:     my @languages=&Apache::loncommon::preferred_languages;
  261:     $ENV{'HTTP_ACCEPT_LANGUAGE'}='';
  262:     $lh=Apache::localize->get_handle(@languages);
  263:     if ($r) {
  264: 	$r->content_languages([&current_language()]);
  265:     }
  266: ###    setlocale(LC_ALL,&current_locale);
  267: }
  268: 
  269: # ========================================================== Localize localtime
  270: sub gettimezone {
  271:     my $timezone; 
  272:     if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'}) {
  273:         $timezone = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'};    
  274:     } elsif ($Apache::lonnet::env{'request.course.id'} ne '') {
  275:         my $cdom = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.domain'};
  276:         if ($cdom ne '') {
  277:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
  278:             if ($domdefaults{'timezone_def'} ne '') {
  279:                 $timezone = $domdefaults{'timezone_def'};
  280:             }
  281:         }
  282:     }
  283:     if ($timezone ne '') {
  284:         if (DateTime::TimeZone->is_valid_name($timezone)) {
  285:             return $timezone;
  286:         }
  287:     }
  288:     return 'local';
  289: }
  290: 
  291: sub locallocaltime {
  292:     my $thistime=shift;
  293:     if (!defined($thistime) || $thistime eq '') {
  294: 	return &mt('Never');
  295:     }
  296:     if (($thistime < 0) || ($thistime eq 'NaN')) {
  297:         &Apache::lonnet::logthis("Unexpected time (negative or NaN) '$thistime' passed to lonlocal::locallocaltime");  
  298:         return &mt('Never');
  299:     }
  300:     if ($thistime !~ /^\d+$/) {
  301:         &Apache::lonnet::logthis("Unexpected non-numeric time '$thistime' passed to lonlocal::locallocaltime");
  302:         return &mt('Never');
  303:     }
  304: 
  305:     my $dt = DateTime->from_epoch(epoch => $thistime)
  306:                      ->set_time_zone(&gettimezone());
  307:     if ((&current_language=~/^en/) || (!$lh)) {
  308: 
  309: 	return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
  310:     } else {
  311: 	my $format=$lh->maketext('date_locale');
  312: 	if ($format eq 'date_locale') {
  313: 	    return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
  314: 	}
  315: 	my $time_zone  = $dt->time_zone_short_name();
  316: 	my $seconds    = $dt->second();
  317: 	my $minutes    = $dt->minute();
  318: 	my $twentyfour = $dt->hour();
  319: 	my $day        = $dt->day_of_month();
  320: 	my $mon        = $dt->month()-1;
  321: 	my $year       = $dt->year();
  322: 	my $wday       = $dt->wday();
  323:         if ($wday==7) { $wday=0; }
  324: 	my $month  =(split(/\,/,$lh->maketext('date_months')))[$mon];
  325: 	my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
  326: 	if ($seconds<10) {
  327: 	    $seconds='0'.$seconds;
  328: 	}
  329: 	if ($minutes<10) {
  330: 	    $minutes='0'.$minutes;
  331: 	}
  332: 	my $twelve=$twentyfour;
  333: 	my $ampm;
  334: 	if ($twelve>12) {
  335: 	    $twelve-=12;
  336: 	    $ampm=$lh->maketext('date_pm');
  337: 	} else {
  338: 	    $ampm=$lh->maketext('date_am');
  339: 	}
  340: 	foreach ('seconds','minutes','twentyfour','twelve','day','year',
  341: 		 'month','weekday','ampm') {
  342: 	    $format=~s/\$$_/eval('$'.$_)/gse;
  343: 	}
  344: 	return $format." ($time_zone)";
  345:     }
  346: }
  347: 
  348: # ==================== Normalize string (reduce fragility in the lexicon files)
  349: 
  350: # This normalizes a string to reduce fragility in the lexicon files of
  351: # huge messages (such as are used by the helper), and allow useful
  352: # formatting: reduce all consecutive whitespace to a single space,
  353: # and remove all HTML
  354: sub normalize_string {
  355:     my $s = shift;
  356:     $s =~ s/\s+/ /g;
  357:     $s =~ s/<[^>]+>//g;
  358:     # Pop off beginning or ending spaces, which aren't good
  359:     $s =~ s/^\s+//;
  360:     $s =~ s/\s+$//;
  361:     return $s;
  362: }
  363: 
  364: # alias for normalize_string; recommend using it only in the lexicon
  365: sub ns {
  366:     return normalize_string(@_);
  367: }
  368: 
  369: # mtn: call the mt function and the normalization function easily.
  370: # Returns original non-normalized string if there was no translation
  371: sub mtn (@) {
  372:     my @args = @_; # don't want to modify caller's string; if we
  373: 		   # didn't care about that we could set $_[0]
  374: 		   # directly
  375:     $args[0] = normalize_string($args[0]);
  376:     my $translation = &mt(@args);
  377:     if ($translation ne $args[0]) {
  378: 	return $translation;
  379:     } else {
  380: 	return $_[0];
  381:     }
  382: }
  383: 
  384: # ---------------------------------------------------- Replace MT{...} in files
  385: 
  386: sub transstatic {
  387:     my $strptr=shift;
  388:     $$strptr=~s/MT\{([^\}]*)\}/&mt($1)/gse;
  389: }
  390: 
  391: =pod 
  392: 
  393: =item * mt_escape
  394: 
  395: mt_escape takes a string reference and escape the [] in there so mt
  396: will leave them as is and not try to expand them
  397: 
  398: =cut
  399: 
  400: sub mt_escape {
  401:     my ($str_ref) = @_;
  402:     $$str_ref =~s/~/~~/g;
  403:     $$str_ref =~s/([\[\]])/~$1/g;
  404: }
  405: 
  406: 1;
  407: 
  408: __END__