Annotation of loncom/localize/lonlocal.pm, revision 1.54

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>