Return to lonlocal.pm CVS log

Up to [LON-CAPA] / loncom / localize

- Moving &preferred_languages() and &get_genlanguages() from loncommon.pm to lonlocal.pm, so they cn be available in cases where lonlocal.pm is used but loncommon.pm is not.

    1: # The LearningOnline Network with CAPA
    2: # Localization routines
    3: #
    4: # $Id: lonlocal.pm,v 1.52 2008/11/28 14:36:55 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: use DateTime::Locale;
  170: 
  171: require Exporter;
  172: 
  173: our @ISA = qw (Exporter);
  174: our @EXPORT = qw(mt mtn ns mt_user);
  175: 
  176: # ========================================================= The language handle
  177: 
  178: use vars qw($lh);
  179: 
  180: # ===================================================== The "MakeText" function
  181: 
  182: sub mt (@) {
  183: #    open(LOG,'>>/home/www/loncapa/loncom/localize/localize/newphrases.txt');
  184: #    print LOG (@_[0]."\n");
  185: #    close(LOG);
  186:     if ($lh) {
  187:         if ($_[0] eq '') {
  188:             if (wantarray) {
  189:                 return @_;
  190:             } else {
  191:                 return $_[0];
  192:             }
  193:         } else {
  194:             return $lh->maketext(@_);
  195:         }
  196:     } else {
  197: 	if (wantarray) {
  198: 	    return @_;
  199: 	} else {
  200: 	    return $_[0];
  201: 	}
  202:     }
  203: }
  204: 
  205: sub mt_user {
  206:     my ($user_lh,@what) = @_;
  207:     if ($user_lh) {
  208:         if ($what[0] eq '') {
  209:             if (wantarray) {
  210:                 return @what;
  211:             } else {
  212:                 return $what[0];
  213:             }
  214:         } else {
  215:             return $user_lh->maketext(@what);
  216:         }
  217:     } else {
  218:         if (wantarray) {
  219:             return @what;
  220:         } else {
  221:             return $what[0];
  222:         }
  223:     }
  224: }
  225: 
  226: # ============================================================== What language?
  227: 
  228: sub current_language {
  229:     if ($lh) {
  230: 	my $lang=$lh->maketext('language_code');
  231: 	return ($lang eq 'language_code'?'en':$lang);
  232:     }
  233:     return 'en';
  234: }
  235: 
  236: sub preferred_languages {
  237:     my @languages=();
  238:     if (($Apache::lonnet::env{'request.role.adv'}) && ($Apache::lonnet::env{'form.languages'})) {
  239:         @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$Apache::lonnet::env{'form.languages'}));
  240:     }
  241:     if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.languages'}) {
  242:         @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
  243:                  $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.languages'}));
  244:     }
  245: 
  246:     if ($Apache::lonnet::env{'environment.languages'}) {
  247:         @languages=(@languages,
  248:                     split(/\s*(\,|\;|\:)\s*/,$Apache::lonnet::env{'environment.languages'}));
  249:     }
  250:     my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
  251:     if ($browser) {
  252:         my @browser =
  253:             map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));
  254:         push(@languages,@browser);
  255:     }
  256: 
  257:     foreach my $domtype ($Apache::lonnet::env{'user.domain'},$Apache::lonnet::env{'request.role.domain'},
  258:                          $Apache::lonnet::perlvar{'lonDefDomain'}) {
  259:         if ($domtype ne '') {
  260:             my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);
  261:             if ($domdefs{'lang_def'} ne '') {
  262:                 push(@languages,$domdefs{'lang_def'});
  263:             }
  264:         }
  265:     }
  266:     return &get_genlanguages(@languages);
  267: }
  268: 
  269: sub get_genlanguages {
  270:     my (@languages) = @_;
  271: # turn "en-ca" into "en-ca,en"
  272:     my @genlanguages;
  273:     foreach my $lang (@languages) {
  274:         unless ($lang=~/\w/) { next; }
  275:         push(@genlanguages,$lang);
  276:         if ($lang=~/(\-|\_)/) {
  277:             push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
  278:         }
  279:     }
  280:     #uniqueify the languages list
  281:     my %count;
  282:     @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
  283:     return @genlanguages;
  284: }
  285: 
  286: # ============================================================== What encoding?
  287: 
  288: sub current_encoding {
  289:     my $default='UTF-8';
  290:     if ($Apache::lonnet::env{'browser.os'} eq 'win' && 
  291: 	$Apache::lonnet::env{'browser.type'} eq 'explorer') {
  292:         $default='ISO-8859-1';
  293:     }
  294:     if ($lh) {
  295: 	my $enc=$lh->maketext('char_encoding');
  296: 	return ($enc eq 'char_encoding'?$default:$enc);
  297:     } else {
  298: 	return $default;
  299:     }
  300: }
  301: 
  302: # =============================================================== Which locale?
  303: # Refer to locale -a
  304: #
  305: sub current_locale {
  306:     if ($lh) {
  307: 	my $enc=$lh->maketext('lang_locale');
  308: 	return ($enc eq 'lang_locale'?'':$enc);
  309:     } else {
  310: 	return undef;
  311:     }
  312: }
  313: 
  314: # ============================================================== Translate hash
  315: 
  316: sub texthash {
  317:     my %hash=@_;
  318:     foreach (keys %hash) {
  319: 	$hash{$_}=&mt($hash{$_});
  320:     }
  321:     return %hash;
  322: }
  323: 
  324: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
  325: 
  326: sub get_language_handle {
  327:     my $r=shift;
  328:     if ($r) {
  329: 	my $headers=$r->headers_in;
  330: 	$ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'};
  331:     }
  332:     my @languages=&preferred_languages();
  333:     $ENV{'HTTP_ACCEPT_LANGUAGE'}='';
  334:     $lh=Apache::localize->get_handle(@languages);
  335:     if ($r) {
  336: 	$r->content_languages([&current_language()]);
  337:     }
  338: ###    setlocale(LC_ALL,&current_locale);
  339: }
  340: 
  341: # ========================================================== Localize localtime
  342: sub gettimezone {
  343:     my $timezone; 
  344:     if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'}) {
  345:         $timezone = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'};    
  346:     } elsif ($Apache::lonnet::env{'request.course.id'} ne '') {
  347:         my $cdom = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.domain'};
  348:         if ($cdom ne '') {
  349:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
  350:             if ($domdefaults{'timezone_def'} ne '') {
  351:                 $timezone = $domdefaults{'timezone_def'};
  352:             }
  353:         }
  354:     } elsif ($Apache::lonnet::env{'request.role.domain'} ne '') {
  355:         my %uroledomdefs = 
  356:             &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'request.role.domain'});
  357:         if ($uroledomdefs{'timezone_def'} ne '') {
  358:             $timezone = $uroledomdefs{'timezone_def'};
  359:         }
  360:     } elsif ($Apache::lonnet::env{'user.domain'} ne '') {
  361:         my %udomdefaults = 
  362:             &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'user.domain'});
  363:         if ($udomdefaults{'timezone_def'} ne '') {
  364:             $timezone = $udomdefaults{'timezone_def'};
  365:         }
  366:     }
  367:     if ($timezone ne '') {
  368:         if (DateTime::TimeZone->is_valid_name($timezone)) {
  369:             return $timezone;
  370:         }
  371:     }
  372:     return 'local';
  373: }
  374: 
  375: sub locallocaltime {
  376:     my $thistime=shift;
  377:     if (!defined($thistime) || $thistime eq '') {
  378: 	return &mt('Never');
  379:     }
  380:     if (($thistime < 0) || ($thistime eq 'NaN')) {
  381:         &Apache::lonnet::logthis("Unexpected time (negative or NaN) '$thistime' passed to lonlocal::locallocaltime");  
  382:         return &mt('Never');
  383:     }
  384:     if ($thistime !~ /^\d+$/) {
  385:         &Apache::lonnet::logthis("Unexpected non-numeric time '$thistime' passed to lonlocal::locallocaltime");
  386:         return &mt('Never');
  387:     }
  388: 
  389:     my $dt = DateTime->from_epoch(epoch => $thistime)
  390:                      ->set_time_zone(&gettimezone());
  391:     if ((&current_language=~/^en/) || (!$lh)) {
  392: 
  393: 	return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
  394:     } else {
  395: 	my $format=$lh->maketext('date_locale');
  396: 	if ($format eq 'date_locale') {
  397: 	    return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
  398: 	}
  399: 	my $time_zone  = $dt->time_zone_short_name();
  400: 	my $seconds    = $dt->second();
  401: 	my $minutes    = $dt->minute();
  402: 	my $twentyfour = $dt->hour();
  403: 	my $day        = $dt->day_of_month();
  404: 	my $mon        = $dt->month()-1;
  405: 	my $year       = $dt->year();
  406: 	my $wday       = $dt->wday();
  407:         if ($wday==7) { $wday=0; }
  408: 	my $month  =(split(/\,/,$lh->maketext('date_months')))[$mon];
  409: 	my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
  410: 	if ($seconds<10) {
  411: 	    $seconds='0'.$seconds;
  412: 	}
  413: 	if ($minutes<10) {
  414: 	    $minutes='0'.$minutes;
  415: 	}
  416: 	my $twelve=$twentyfour;
  417: 	my $ampm;
  418: 	if ($twelve>12) {
  419: 	    $twelve-=12;
  420: 	    $ampm=$lh->maketext('date_pm');
  421: 	} else {
  422: 	    $ampm=$lh->maketext('date_am');
  423: 	}
  424: 	foreach ('seconds','minutes','twentyfour','twelve','day','year',
  425: 		 'month','weekday','ampm') {
  426: 	    $format=~s/\$$_/eval('$'.$_)/gse;
  427: 	}
  428: 	return $format." ($time_zone)";
  429:     }
  430: }
  431: 
  432: sub getdatelocale {
  433:     my ($datelocale,$locale_obj);
  434:     if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.datelocale'}) {
  435:         $datelocale = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.datelocale'};
  436:     } elsif ($Apache::lonnet::env{'request.course.id'} ne '') {
  437:         my $cdom = $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.domain'};
  438:         if ($cdom ne '') {
  439:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
  440:             if ($domdefaults{'datelocale_def'} ne '') {
  441:                 $datelocale = $domdefaults{'datelocale_def'};
  442:             }
  443:         }
  444:     } elsif ($Apache::lonnet::env{'user.domain'} ne '') {
  445:         my %udomdefaults = &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'user.domain'});
  446:         if ($udomdefaults{'datelocale_def'} ne '') {
  447:             $datelocale = $udomdefaults{'datelocale_def'};
  448:         }
  449:     }
  450:     if ($datelocale ne '') {
  451:         eval {
  452:             $locale_obj = DateTime::Locale->load($datelocale);
  453:         };
  454:         if (!$@) {
  455:             if ($locale_obj->id() eq $datelocale) {
  456:                 return $locale_obj;
  457:             }
  458:         }
  459:     }
  460:     return $locale_obj;
  461: }
  462: 
  463: =pod 
  464: 
  465: =item * normalize_string
  466: 
  467: Normalize string (reduce fragility in the lexicon files)
  468: 
  469: This normalizes a string to reduce fragility in the lexicon files of
  470: huge messages (such as are used by the helper), and allow useful
  471: formatting: reduce all consecutive whitespace to a single space,
  472: and remove all HTML
  473: 
  474: =cut
  475: 
  476: sub normalize_string {
  477:     my $s = shift;
  478:     $s =~ s/\s+/ /g;
  479:     $s =~ s/<[^>]+>//g;
  480:     # Pop off beginning or ending spaces, which aren't good
  481:     $s =~ s/^\s+//;
  482:     $s =~ s/\s+$//;
  483:     return $s;
  484: }
  485: 
  486: =pod 
  487: 
  488: =item * ns
  489: 
  490: alias for normalize_string; recommend using it only in the lexicon
  491: 
  492: =cut
  493: 
  494: sub ns {
  495:     return normalize_string(@_);
  496: }
  497: 
  498: =pod
  499: 
  500: =item * mtn
  501: 
  502: mtn: call the mt function and the normalization function easily.
  503: Returns original non-normalized string if there was no translation
  504: 
  505: =cut
  506: 
  507: sub mtn (@) {
  508:     my @args = @_; # don't want to modify caller's string; if we
  509: 		   # didn't care about that we could set $_[0]
  510: 		   # directly
  511:     $args[0] = normalize_string($args[0]);
  512:     my $translation = &mt(@args);
  513:     if ($translation ne $args[0]) {
  514: 	return $translation;
  515:     } else {
  516: 	return $_[0];
  517:     }
  518: }
  519: 
  520: # ---------------------------------------------------- Replace MT{...} in files
  521: 
  522: sub transstatic {
  523:     my $strptr=shift;
  524:     $$strptr=~s/MT\{([^\}]*)\}/&mt($1)/gse;
  525: }
  526: 
  527: =pod 
  528: 
  529: =item * mt_escape
  530: 
  531: mt_escape takes a string reference and escape the [] in there so mt
  532: will leave them as is and not try to expand them
  533: 
  534: =cut
  535: 
  536: sub mt_escape {
  537:     my ($str_ref) = @_;
  538:     $$str_ref =~s/~/~~/g;
  539:     $$str_ref =~s/([\[\]])/~$1/g;
  540: }
  541: 
  542: 1;
  543: 
  544: __END__